Linux Audio

Check our new training course

Loading...
v5.9
  1/*
  2 * Copyright 2017 Advanced Micro Devices, Inc.
  3 *
  4 * Permission is hereby granted, free of charge, to any person obtaining a
  5 * copy of this software and associated documentation files (the "Software"),
  6 * to deal in the Software without restriction, including without limitation
  7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  8 * and/or sell copies of the Software, and to permit persons to whom the
  9 * Software is furnished to do so, subject to the following conditions:
 10 *
 11 * The above copyright notice and this permission notice shall be included in
 12 * all copies or substantial portions of the Software.
 13 *
 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 17 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
 18 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 20 * OTHER DEALINGS IN THE SOFTWARE.
 21 *
 22 */
 23/*
 24 * dc_helper.c
 25 *
 26 *  Created on: Aug 30, 2016
 27 *      Author: agrodzov
 28 */
 29
 30#include <linux/delay.h>
 
 31
 32#include "dm_services.h"
 33#include <stdarg.h>
 34
 35#include "dc.h"
 36#include "dc_dmub_srv.h"
 
 
 
 
 37
 38static inline void submit_dmub_read_modify_write(
 39	struct dc_reg_helper_state *offload,
 40	const struct dc_context *ctx)
 41{
 42	struct dmub_rb_cmd_read_modify_write *cmd_buf = &offload->cmd_data.read_modify_write;
 43	bool gather = false;
 44
 45	offload->should_burst_write =
 46			(offload->same_addr_count == (DMUB_READ_MODIFY_WRITE_SEQ__MAX - 1));
 47	cmd_buf->header.payload_bytes =
 48			sizeof(struct dmub_cmd_read_modify_write_sequence) * offload->reg_seq_count;
 49
 50	gather = ctx->dmub_srv->reg_helper_offload.gather_in_progress;
 51	ctx->dmub_srv->reg_helper_offload.gather_in_progress = false;
 52
 53	dc_dmub_srv_cmd_queue(ctx->dmub_srv, &offload->cmd_data);
 54
 55	ctx->dmub_srv->reg_helper_offload.gather_in_progress = gather;
 56
 57	memset(cmd_buf, 0, sizeof(*cmd_buf));
 58
 59	offload->reg_seq_count = 0;
 60	offload->same_addr_count = 0;
 61}
 62
 63static inline void submit_dmub_burst_write(
 64	struct dc_reg_helper_state *offload,
 65	const struct dc_context *ctx)
 66{
 67	struct dmub_rb_cmd_burst_write *cmd_buf = &offload->cmd_data.burst_write;
 68	bool gather = false;
 69
 70	cmd_buf->header.payload_bytes =
 71			sizeof(uint32_t) * offload->reg_seq_count;
 72
 73	gather = ctx->dmub_srv->reg_helper_offload.gather_in_progress;
 74	ctx->dmub_srv->reg_helper_offload.gather_in_progress = false;
 75
 76	dc_dmub_srv_cmd_queue(ctx->dmub_srv, &offload->cmd_data);
 77
 78	ctx->dmub_srv->reg_helper_offload.gather_in_progress = gather;
 79
 80	memset(cmd_buf, 0, sizeof(*cmd_buf));
 81
 82	offload->reg_seq_count = 0;
 83}
 84
 85static inline void submit_dmub_reg_wait(
 86		struct dc_reg_helper_state *offload,
 87		const struct dc_context *ctx)
 88{
 89	struct dmub_rb_cmd_reg_wait *cmd_buf = &offload->cmd_data.reg_wait;
 90	bool gather = false;
 91
 92	gather = ctx->dmub_srv->reg_helper_offload.gather_in_progress;
 93	ctx->dmub_srv->reg_helper_offload.gather_in_progress = false;
 94
 95	dc_dmub_srv_cmd_queue(ctx->dmub_srv, &offload->cmd_data);
 96
 97	memset(cmd_buf, 0, sizeof(*cmd_buf));
 98	offload->reg_seq_count = 0;
 99
100	ctx->dmub_srv->reg_helper_offload.gather_in_progress = gather;
101}
102
103struct dc_reg_value_masks {
104	uint32_t value;
105	uint32_t mask;
106};
107
108struct dc_reg_sequence {
109	uint32_t addr;
110	struct dc_reg_value_masks value_masks;
111};
112
113static inline void set_reg_field_value_masks(
114	struct dc_reg_value_masks *field_value_mask,
115	uint32_t value,
116	uint32_t mask,
117	uint8_t shift)
118{
119	ASSERT(mask != 0);
120
121	field_value_mask->value = (field_value_mask->value & ~mask) | (mask & (value << shift));
122	field_value_mask->mask = field_value_mask->mask | mask;
123}
124
125static void set_reg_field_values(struct dc_reg_value_masks *field_value_mask,
126		uint32_t addr, int n,
127		uint8_t shift1, uint32_t mask1, uint32_t field_value1,
128		va_list ap)
129{
130	uint32_t shift, mask, field_value;
131	int i = 1;
132
133	/* gather all bits value/mask getting updated in this register */
134	set_reg_field_value_masks(field_value_mask,
135			field_value1, mask1, shift1);
136
137	while (i < n) {
138		shift = va_arg(ap, uint32_t);
139		mask = va_arg(ap, uint32_t);
140		field_value = va_arg(ap, uint32_t);
141
142		set_reg_field_value_masks(field_value_mask,
143				field_value, mask, shift);
144		i++;
145	}
146}
147
148static void dmub_flush_buffer_execute(
149		struct dc_reg_helper_state *offload,
150		const struct dc_context *ctx)
151{
152	submit_dmub_read_modify_write(offload, ctx);
153	dc_dmub_srv_cmd_execute(ctx->dmub_srv);
154}
155
156static void dmub_flush_burst_write_buffer_execute(
157		struct dc_reg_helper_state *offload,
158		const struct dc_context *ctx)
159{
160	submit_dmub_burst_write(offload, ctx);
161	dc_dmub_srv_cmd_execute(ctx->dmub_srv);
162}
163
164static bool dmub_reg_value_burst_set_pack(const struct dc_context *ctx, uint32_t addr,
165		uint32_t reg_val)
166{
167	struct dc_reg_helper_state *offload = &ctx->dmub_srv->reg_helper_offload;
168	struct dmub_rb_cmd_burst_write *cmd_buf = &offload->cmd_data.burst_write;
169
170	/* flush command if buffer is full */
171	if (offload->reg_seq_count == DMUB_BURST_WRITE_VALUES__MAX)
172		dmub_flush_burst_write_buffer_execute(offload, ctx);
173
174	if (offload->cmd_data.cmd_common.header.type == DMUB_CMD__REG_SEQ_BURST_WRITE &&
175			addr != cmd_buf->addr) {
176		dmub_flush_burst_write_buffer_execute(offload, ctx);
177		return false;
178	}
179
180	cmd_buf->header.type = DMUB_CMD__REG_SEQ_BURST_WRITE;
181	cmd_buf->header.sub_type = 0;
182	cmd_buf->addr = addr;
183	cmd_buf->write_values[offload->reg_seq_count] = reg_val;
184	offload->reg_seq_count++;
185
186	return true;
187}
188
189static uint32_t dmub_reg_value_pack(const struct dc_context *ctx, uint32_t addr,
190		struct dc_reg_value_masks *field_value_mask)
191{
192	struct dc_reg_helper_state *offload = &ctx->dmub_srv->reg_helper_offload;
193	struct dmub_rb_cmd_read_modify_write *cmd_buf = &offload->cmd_data.read_modify_write;
194	struct dmub_cmd_read_modify_write_sequence *seq;
195
196	/* flush command if buffer is full */
197	if (offload->cmd_data.cmd_common.header.type != DMUB_CMD__REG_SEQ_BURST_WRITE &&
198			offload->reg_seq_count == DMUB_READ_MODIFY_WRITE_SEQ__MAX)
199		dmub_flush_buffer_execute(offload, ctx);
200
201	if (offload->should_burst_write) {
202		if (dmub_reg_value_burst_set_pack(ctx, addr, field_value_mask->value))
203			return field_value_mask->value;
204		else
205			offload->should_burst_write = false;
206	}
207
208	/* pack commands */
209	cmd_buf->header.type = DMUB_CMD__REG_SEQ_READ_MODIFY_WRITE;
210	cmd_buf->header.sub_type = 0;
211	seq = &cmd_buf->seq[offload->reg_seq_count];
212
213	if (offload->reg_seq_count) {
214		if (cmd_buf->seq[offload->reg_seq_count - 1].addr == addr)
215			offload->same_addr_count++;
216		else
217			offload->same_addr_count = 0;
218	}
219
220	seq->addr = addr;
221	seq->modify_mask = field_value_mask->mask;
222	seq->modify_value = field_value_mask->value;
223	offload->reg_seq_count++;
224
225	return field_value_mask->value;
226}
227
228static void dmub_reg_wait_done_pack(const struct dc_context *ctx, uint32_t addr,
229		uint32_t mask, uint32_t shift, uint32_t condition_value, uint32_t time_out_us)
230{
231	struct dc_reg_helper_state *offload = &ctx->dmub_srv->reg_helper_offload;
232	struct dmub_rb_cmd_reg_wait *cmd_buf = &offload->cmd_data.reg_wait;
233
234	cmd_buf->header.type = DMUB_CMD__REG_REG_WAIT;
235	cmd_buf->header.sub_type = 0;
236	cmd_buf->reg_wait.addr = addr;
237	cmd_buf->reg_wait.condition_field_value = mask & (condition_value << shift);
238	cmd_buf->reg_wait.mask = mask;
239	cmd_buf->reg_wait.time_out_us = time_out_us;
240}
241
242uint32_t generic_reg_update_ex(const struct dc_context *ctx,
243		uint32_t addr, int n,
244		uint8_t shift1, uint32_t mask1, uint32_t field_value1,
245		...)
246{
247	struct dc_reg_value_masks field_value_mask = {0};
248	uint32_t reg_val;
249	va_list ap;
250
251	va_start(ap, field_value1);
252
253	set_reg_field_values(&field_value_mask, addr, n, shift1, mask1,
254			field_value1, ap);
255
256	va_end(ap);
257
258	if (ctx->dmub_srv &&
259	    ctx->dmub_srv->reg_helper_offload.gather_in_progress)
260		return dmub_reg_value_pack(ctx, addr, &field_value_mask);
261		/* todo: return void so we can decouple code running in driver from register states */
262
263	/* mmio write directly */
264	reg_val = dm_read_reg(ctx, addr);
265	reg_val = (reg_val & ~field_value_mask.mask) | field_value_mask.value;
266	dm_write_reg(ctx, addr, reg_val);
267	return reg_val;
268}
269
270uint32_t generic_reg_set_ex(const struct dc_context *ctx,
271		uint32_t addr, uint32_t reg_val, int n,
272		uint8_t shift1, uint32_t mask1, uint32_t field_value1,
273		...)
274{
275	struct dc_reg_value_masks field_value_mask = {0};
276	va_list ap;
277
278	va_start(ap, field_value1);
279
280	set_reg_field_values(&field_value_mask, addr, n, shift1, mask1,
281			field_value1, ap);
282
283	va_end(ap);
284
285
286	/* mmio write directly */
287	reg_val = (reg_val & ~field_value_mask.mask) | field_value_mask.value;
288
289	if (ctx->dmub_srv &&
290	    ctx->dmub_srv->reg_helper_offload.gather_in_progress) {
291		return dmub_reg_value_burst_set_pack(ctx, addr, reg_val);
292		/* todo: return void so we can decouple code running in driver from register states */
293	}
294
295	dm_write_reg(ctx, addr, reg_val);
296	return reg_val;
297}
298
299uint32_t dm_read_reg_func(
300	const struct dc_context *ctx,
301	uint32_t address,
302	const char *func_name)
303{
304	uint32_t value;
305#ifdef DM_CHECK_ADDR_0
306	if (address == 0) {
307		DC_ERR("invalid register read; address = 0\n");
308		return 0;
309	}
310#endif
311
312	if (ctx->dmub_srv &&
313	    ctx->dmub_srv->reg_helper_offload.gather_in_progress &&
314	    !ctx->dmub_srv->reg_helper_offload.should_burst_write) {
315		ASSERT(false);
316		return 0;
317	}
318
319	value = cgs_read_register(ctx->cgs_device, address);
320	trace_amdgpu_dc_rreg(&ctx->perf_trace->read_count, address, value);
321
322	return value;
323}
324
325uint32_t generic_reg_get(const struct dc_context *ctx, uint32_t addr,
326		uint8_t shift, uint32_t mask, uint32_t *field_value)
327{
328	uint32_t reg_val = dm_read_reg(ctx, addr);
329	*field_value = get_reg_field_value_ex(reg_val, mask, shift);
330	return reg_val;
331}
332
333uint32_t generic_reg_get2(const struct dc_context *ctx, uint32_t addr,
334		uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
335		uint8_t shift2, uint32_t mask2, uint32_t *field_value2)
336{
337	uint32_t reg_val = dm_read_reg(ctx, addr);
338	*field_value1 = get_reg_field_value_ex(reg_val, mask1, shift1);
339	*field_value2 = get_reg_field_value_ex(reg_val, mask2, shift2);
340	return reg_val;
341}
342
343uint32_t generic_reg_get3(const struct dc_context *ctx, uint32_t addr,
344		uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
345		uint8_t shift2, uint32_t mask2, uint32_t *field_value2,
346		uint8_t shift3, uint32_t mask3, uint32_t *field_value3)
347{
348	uint32_t reg_val = dm_read_reg(ctx, addr);
349	*field_value1 = get_reg_field_value_ex(reg_val, mask1, shift1);
350	*field_value2 = get_reg_field_value_ex(reg_val, mask2, shift2);
351	*field_value3 = get_reg_field_value_ex(reg_val, mask3, shift3);
352	return reg_val;
353}
354
355uint32_t generic_reg_get4(const struct dc_context *ctx, uint32_t addr,
356		uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
357		uint8_t shift2, uint32_t mask2, uint32_t *field_value2,
358		uint8_t shift3, uint32_t mask3, uint32_t *field_value3,
359		uint8_t shift4, uint32_t mask4, uint32_t *field_value4)
360{
361	uint32_t reg_val = dm_read_reg(ctx, addr);
362	*field_value1 = get_reg_field_value_ex(reg_val, mask1, shift1);
363	*field_value2 = get_reg_field_value_ex(reg_val, mask2, shift2);
364	*field_value3 = get_reg_field_value_ex(reg_val, mask3, shift3);
365	*field_value4 = get_reg_field_value_ex(reg_val, mask4, shift4);
366	return reg_val;
367}
368
369uint32_t generic_reg_get5(const struct dc_context *ctx, uint32_t addr,
370		uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
371		uint8_t shift2, uint32_t mask2, uint32_t *field_value2,
372		uint8_t shift3, uint32_t mask3, uint32_t *field_value3,
373		uint8_t shift4, uint32_t mask4, uint32_t *field_value4,
374		uint8_t shift5, uint32_t mask5, uint32_t *field_value5)
375{
376	uint32_t reg_val = dm_read_reg(ctx, addr);
377	*field_value1 = get_reg_field_value_ex(reg_val, mask1, shift1);
378	*field_value2 = get_reg_field_value_ex(reg_val, mask2, shift2);
379	*field_value3 = get_reg_field_value_ex(reg_val, mask3, shift3);
380	*field_value4 = get_reg_field_value_ex(reg_val, mask4, shift4);
381	*field_value5 = get_reg_field_value_ex(reg_val, mask5, shift5);
382	return reg_val;
383}
384
385uint32_t generic_reg_get6(const struct dc_context *ctx, uint32_t addr,
386		uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
387		uint8_t shift2, uint32_t mask2, uint32_t *field_value2,
388		uint8_t shift3, uint32_t mask3, uint32_t *field_value3,
389		uint8_t shift4, uint32_t mask4, uint32_t *field_value4,
390		uint8_t shift5, uint32_t mask5, uint32_t *field_value5,
391		uint8_t shift6, uint32_t mask6, uint32_t *field_value6)
392{
393	uint32_t reg_val = dm_read_reg(ctx, addr);
394	*field_value1 = get_reg_field_value_ex(reg_val, mask1, shift1);
395	*field_value2 = get_reg_field_value_ex(reg_val, mask2, shift2);
396	*field_value3 = get_reg_field_value_ex(reg_val, mask3, shift3);
397	*field_value4 = get_reg_field_value_ex(reg_val, mask4, shift4);
398	*field_value5 = get_reg_field_value_ex(reg_val, mask5, shift5);
399	*field_value6 = get_reg_field_value_ex(reg_val, mask6, shift6);
400	return reg_val;
401}
402
403uint32_t generic_reg_get7(const struct dc_context *ctx, uint32_t addr,
404		uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
405		uint8_t shift2, uint32_t mask2, uint32_t *field_value2,
406		uint8_t shift3, uint32_t mask3, uint32_t *field_value3,
407		uint8_t shift4, uint32_t mask4, uint32_t *field_value4,
408		uint8_t shift5, uint32_t mask5, uint32_t *field_value5,
409		uint8_t shift6, uint32_t mask6, uint32_t *field_value6,
410		uint8_t shift7, uint32_t mask7, uint32_t *field_value7)
411{
412	uint32_t reg_val = dm_read_reg(ctx, addr);
413	*field_value1 = get_reg_field_value_ex(reg_val, mask1, shift1);
414	*field_value2 = get_reg_field_value_ex(reg_val, mask2, shift2);
415	*field_value3 = get_reg_field_value_ex(reg_val, mask3, shift3);
416	*field_value4 = get_reg_field_value_ex(reg_val, mask4, shift4);
417	*field_value5 = get_reg_field_value_ex(reg_val, mask5, shift5);
418	*field_value6 = get_reg_field_value_ex(reg_val, mask6, shift6);
419	*field_value7 = get_reg_field_value_ex(reg_val, mask7, shift7);
420	return reg_val;
421}
422
423uint32_t generic_reg_get8(const struct dc_context *ctx, uint32_t addr,
424		uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
425		uint8_t shift2, uint32_t mask2, uint32_t *field_value2,
426		uint8_t shift3, uint32_t mask3, uint32_t *field_value3,
427		uint8_t shift4, uint32_t mask4, uint32_t *field_value4,
428		uint8_t shift5, uint32_t mask5, uint32_t *field_value5,
429		uint8_t shift6, uint32_t mask6, uint32_t *field_value6,
430		uint8_t shift7, uint32_t mask7, uint32_t *field_value7,
431		uint8_t shift8, uint32_t mask8, uint32_t *field_value8)
432{
433	uint32_t reg_val = dm_read_reg(ctx, addr);
434	*field_value1 = get_reg_field_value_ex(reg_val, mask1, shift1);
435	*field_value2 = get_reg_field_value_ex(reg_val, mask2, shift2);
436	*field_value3 = get_reg_field_value_ex(reg_val, mask3, shift3);
437	*field_value4 = get_reg_field_value_ex(reg_val, mask4, shift4);
438	*field_value5 = get_reg_field_value_ex(reg_val, mask5, shift5);
439	*field_value6 = get_reg_field_value_ex(reg_val, mask6, shift6);
440	*field_value7 = get_reg_field_value_ex(reg_val, mask7, shift7);
441	*field_value8 = get_reg_field_value_ex(reg_val, mask8, shift8);
442	return reg_val;
443}
444/* note:  va version of this is pretty bad idea, since there is a output parameter pass by pointer
445 * compiler won't be able to check for size match and is prone to stack corruption type of bugs
446
447uint32_t generic_reg_get(const struct dc_context *ctx,
448		uint32_t addr, int n, ...)
449{
450	uint32_t shift, mask;
451	uint32_t *field_value;
452	uint32_t reg_val;
453	int i = 0;
454
455	reg_val = dm_read_reg(ctx, addr);
456
457	va_list ap;
458	va_start(ap, n);
459
460	while (i < n) {
461		shift = va_arg(ap, uint32_t);
462		mask = va_arg(ap, uint32_t);
463		field_value = va_arg(ap, uint32_t *);
464
465		*field_value = get_reg_field_value_ex(reg_val, mask, shift);
466		i++;
467	}
468
469	va_end(ap);
470
471	return reg_val;
472}
473*/
474
475void generic_reg_wait(const struct dc_context *ctx,
476	uint32_t addr, uint32_t shift, uint32_t mask, uint32_t condition_value,
477	unsigned int delay_between_poll_us, unsigned int time_out_num_tries,
478	const char *func_name, int line)
479{
480	uint32_t field_value;
481	uint32_t reg_val;
482	int i;
483
484	if (ctx->dmub_srv &&
485	    ctx->dmub_srv->reg_helper_offload.gather_in_progress) {
486		dmub_reg_wait_done_pack(ctx, addr, mask, shift, condition_value,
487				delay_between_poll_us * time_out_num_tries);
488		return;
489	}
490
491	/*
492	 * Something is terribly wrong if time out is > 3000ms.
493	 * 3000ms is the maximum time needed for SMU to pass values back.
494	 * This value comes from experiments.
495	 *
496	 */
497	ASSERT(delay_between_poll_us * time_out_num_tries <= 3000000);
498
499	for (i = 0; i <= time_out_num_tries; i++) {
500		if (i) {
501			if (delay_between_poll_us >= 1000)
502				msleep(delay_between_poll_us/1000);
503			else if (delay_between_poll_us > 0)
504				udelay(delay_between_poll_us);
505		}
506
507		reg_val = dm_read_reg(ctx, addr);
508
509		field_value = get_reg_field_value_ex(reg_val, mask, shift);
510
511		if (field_value == condition_value) {
512			if (i * delay_between_poll_us > 1000 &&
513					!IS_FPGA_MAXIMUS_DC(ctx->dce_environment))
514				DC_LOG_DC("REG_WAIT taking a while: %dms in %s line:%d\n",
515						delay_between_poll_us * i / 1000,
516						func_name, line);
517			return;
518		}
519	}
520
521	DC_LOG_WARNING("REG_WAIT timeout %dus * %d tries - %s line:%d\n",
522			delay_between_poll_us, time_out_num_tries,
523			func_name, line);
524
525	if (!IS_FPGA_MAXIMUS_DC(ctx->dce_environment))
526		BREAK_TO_DEBUGGER();
527}
528
529void generic_write_indirect_reg(const struct dc_context *ctx,
530		uint32_t addr_index, uint32_t addr_data,
531		uint32_t index, uint32_t data)
532{
533	dm_write_reg(ctx, addr_index, index);
534	dm_write_reg(ctx, addr_data, data);
535}
536
537uint32_t generic_read_indirect_reg(const struct dc_context *ctx,
538		uint32_t addr_index, uint32_t addr_data,
539		uint32_t index)
540{
541	uint32_t value = 0;
542
543	// when reg read, there should not be any offload.
544	if (ctx->dmub_srv &&
545	    ctx->dmub_srv->reg_helper_offload.gather_in_progress) {
546		ASSERT(false);
547	}
548
549	dm_write_reg(ctx, addr_index, index);
550	value = dm_read_reg(ctx, addr_data);
551
552	return value;
553}
554
555uint32_t generic_indirect_reg_get(const struct dc_context *ctx,
556		uint32_t addr_index, uint32_t addr_data,
557		uint32_t index, int n,
558		uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
559		...)
560{
561	uint32_t shift, mask, *field_value;
562	uint32_t value = 0;
563	int i = 1;
564
565	va_list ap;
566
567	va_start(ap, field_value1);
568
569	value = generic_read_indirect_reg(ctx, addr_index, addr_data, index);
570	*field_value1 = get_reg_field_value_ex(value, mask1, shift1);
571
572	while (i < n) {
573		shift = va_arg(ap, uint32_t);
574		mask = va_arg(ap, uint32_t);
575		field_value = va_arg(ap, uint32_t *);
576
577		*field_value = get_reg_field_value_ex(value, mask, shift);
578		i++;
579	}
580
581	va_end(ap);
582
583	return value;
584}
585
586uint32_t generic_indirect_reg_update_ex(const struct dc_context *ctx,
587		uint32_t addr_index, uint32_t addr_data,
588		uint32_t index, uint32_t reg_val, int n,
589		uint8_t shift1, uint32_t mask1, uint32_t field_value1,
590		...)
591{
592	uint32_t shift, mask, field_value;
593	int i = 1;
594
595	va_list ap;
596
597	va_start(ap, field_value1);
598
599	reg_val = set_reg_field_value_ex(reg_val, field_value1, mask1, shift1);
600
601	while (i < n) {
602		shift = va_arg(ap, uint32_t);
603		mask = va_arg(ap, uint32_t);
604		field_value = va_arg(ap, uint32_t);
605
606		reg_val = set_reg_field_value_ex(reg_val, field_value, mask, shift);
607		i++;
608	}
609
610	generic_write_indirect_reg(ctx, addr_index, addr_data, index, reg_val);
611	va_end(ap);
612
613	return reg_val;
614}
615
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
616void reg_sequence_start_gather(const struct dc_context *ctx)
617{
618	/* if reg sequence is supported and enabled, set flag to
619	 * indicate we want to have REG_SET, REG_UPDATE macro build
620	 * reg sequence command buffer rather than MMIO directly.
621	 */
622
623	if (ctx->dmub_srv && ctx->dc->debug.dmub_offload_enabled) {
624		struct dc_reg_helper_state *offload =
625			&ctx->dmub_srv->reg_helper_offload;
626
627		/* caller sequence mismatch.  need to debug caller.  offload will not work!!! */
628		ASSERT(!offload->gather_in_progress);
629
630		offload->gather_in_progress = true;
631	}
632}
633
634void reg_sequence_start_execute(const struct dc_context *ctx)
635{
636	struct dc_reg_helper_state *offload;
637
638	if (!ctx->dmub_srv)
639		return;
640
641	offload = &ctx->dmub_srv->reg_helper_offload;
642
643	if (offload && offload->gather_in_progress) {
644		offload->gather_in_progress = false;
645		offload->should_burst_write = false;
646		switch (offload->cmd_data.cmd_common.header.type) {
647		case DMUB_CMD__REG_SEQ_READ_MODIFY_WRITE:
648			submit_dmub_read_modify_write(offload, ctx);
649			break;
650		case DMUB_CMD__REG_REG_WAIT:
651			submit_dmub_reg_wait(offload, ctx);
652			break;
653		case DMUB_CMD__REG_SEQ_BURST_WRITE:
654			submit_dmub_burst_write(offload, ctx);
655			break;
656		default:
657			return;
658		}
659
660		dc_dmub_srv_cmd_execute(ctx->dmub_srv);
661	}
662}
663
664void reg_sequence_wait_done(const struct dc_context *ctx)
665{
666	/* callback to DM to poll for last submission done*/
667	struct dc_reg_helper_state *offload;
668
669	if (!ctx->dmub_srv)
670		return;
671
672	offload = &ctx->dmub_srv->reg_helper_offload;
673
674	if (offload &&
675	    ctx->dc->debug.dmub_offload_enabled &&
676	    !ctx->dc->debug.dmcub_emulation) {
677		dc_dmub_srv_wait_idle(ctx->dmub_srv);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
678	}
679}
v6.13.7
  1/*
  2 * Copyright 2017 Advanced Micro Devices, Inc.
  3 *
  4 * Permission is hereby granted, free of charge, to any person obtaining a
  5 * copy of this software and associated documentation files (the "Software"),
  6 * to deal in the Software without restriction, including without limitation
  7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  8 * and/or sell copies of the Software, and to permit persons to whom the
  9 * Software is furnished to do so, subject to the following conditions:
 10 *
 11 * The above copyright notice and this permission notice shall be included in
 12 * all copies or substantial portions of the Software.
 13 *
 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 17 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
 18 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 20 * OTHER DEALINGS IN THE SOFTWARE.
 21 *
 22 */
 23/*
 24 * dc_helper.c
 25 *
 26 *  Created on: Aug 30, 2016
 27 *      Author: agrodzov
 28 */
 29
 30#include <linux/delay.h>
 31#include <linux/stdarg.h>
 32
 33#include "dm_services.h"
 
 34
 35#include "dc.h"
 36#include "dc_dmub_srv.h"
 37#include "reg_helper.h"
 38
 39#define DC_LOGGER \
 40	ctx->logger
 41
 42static inline void submit_dmub_read_modify_write(
 43	struct dc_reg_helper_state *offload,
 44	const struct dc_context *ctx)
 45{
 46	struct dmub_rb_cmd_read_modify_write *cmd_buf = &offload->cmd_data.read_modify_write;
 
 47
 48	offload->should_burst_write =
 49			(offload->same_addr_count == (DMUB_READ_MODIFY_WRITE_SEQ__MAX - 1));
 50	cmd_buf->header.payload_bytes =
 51			sizeof(struct dmub_cmd_read_modify_write_sequence) * offload->reg_seq_count;
 52
 53	dc_wake_and_execute_dmub_cmd(ctx, &offload->cmd_data, DM_DMUB_WAIT_TYPE_NO_WAIT);
 
 
 
 
 
 54
 55	memset(cmd_buf, 0, sizeof(*cmd_buf));
 56
 57	offload->reg_seq_count = 0;
 58	offload->same_addr_count = 0;
 59}
 60
 61static inline void submit_dmub_burst_write(
 62	struct dc_reg_helper_state *offload,
 63	const struct dc_context *ctx)
 64{
 65	struct dmub_rb_cmd_burst_write *cmd_buf = &offload->cmd_data.burst_write;
 
 66
 67	cmd_buf->header.payload_bytes =
 68			sizeof(uint32_t) * offload->reg_seq_count;
 69
 70	dc_wake_and_execute_dmub_cmd(ctx, &offload->cmd_data, DM_DMUB_WAIT_TYPE_NO_WAIT);
 
 
 
 
 
 71
 72	memset(cmd_buf, 0, sizeof(*cmd_buf));
 73
 74	offload->reg_seq_count = 0;
 75}
 76
 77static inline void submit_dmub_reg_wait(
 78		struct dc_reg_helper_state *offload,
 79		const struct dc_context *ctx)
 80{
 81	struct dmub_rb_cmd_reg_wait *cmd_buf = &offload->cmd_data.reg_wait;
 
 
 
 
 82
 83	dc_wake_and_execute_dmub_cmd(ctx, &offload->cmd_data, DM_DMUB_WAIT_TYPE_NO_WAIT);
 84
 85	memset(cmd_buf, 0, sizeof(*cmd_buf));
 86	offload->reg_seq_count = 0;
 
 
 87}
 88
 89struct dc_reg_value_masks {
 90	uint32_t value;
 91	uint32_t mask;
 92};
 93
 
 
 
 
 
 94static inline void set_reg_field_value_masks(
 95	struct dc_reg_value_masks *field_value_mask,
 96	uint32_t value,
 97	uint32_t mask,
 98	uint8_t shift)
 99{
100	ASSERT(mask != 0);
101
102	field_value_mask->value = (field_value_mask->value & ~mask) | (mask & (value << shift));
103	field_value_mask->mask = field_value_mask->mask | mask;
104}
105
106static void set_reg_field_values(struct dc_reg_value_masks *field_value_mask,
107		uint32_t addr, int n,
108		uint8_t shift1, uint32_t mask1, uint32_t field_value1,
109		va_list ap)
110{
111	uint32_t shift, mask, field_value;
112	int i = 1;
113
114	/* gather all bits value/mask getting updated in this register */
115	set_reg_field_value_masks(field_value_mask,
116			field_value1, mask1, shift1);
117
118	while (i < n) {
119		shift = va_arg(ap, uint32_t);
120		mask = va_arg(ap, uint32_t);
121		field_value = va_arg(ap, uint32_t);
122
123		set_reg_field_value_masks(field_value_mask,
124				field_value, mask, shift);
125		i++;
126	}
127}
128
129static void dmub_flush_buffer_execute(
130		struct dc_reg_helper_state *offload,
131		const struct dc_context *ctx)
132{
133	submit_dmub_read_modify_write(offload, ctx);
 
134}
135
136static void dmub_flush_burst_write_buffer_execute(
137		struct dc_reg_helper_state *offload,
138		const struct dc_context *ctx)
139{
140	submit_dmub_burst_write(offload, ctx);
 
141}
142
143static bool dmub_reg_value_burst_set_pack(const struct dc_context *ctx, uint32_t addr,
144		uint32_t reg_val)
145{
146	struct dc_reg_helper_state *offload = &ctx->dmub_srv->reg_helper_offload;
147	struct dmub_rb_cmd_burst_write *cmd_buf = &offload->cmd_data.burst_write;
148
149	/* flush command if buffer is full */
150	if (offload->reg_seq_count == DMUB_BURST_WRITE_VALUES__MAX)
151		dmub_flush_burst_write_buffer_execute(offload, ctx);
152
153	if (offload->cmd_data.cmd_common.header.type == DMUB_CMD__REG_SEQ_BURST_WRITE &&
154			addr != cmd_buf->addr) {
155		dmub_flush_burst_write_buffer_execute(offload, ctx);
156		return false;
157	}
158
159	cmd_buf->header.type = DMUB_CMD__REG_SEQ_BURST_WRITE;
160	cmd_buf->header.sub_type = 0;
161	cmd_buf->addr = addr;
162	cmd_buf->write_values[offload->reg_seq_count] = reg_val;
163	offload->reg_seq_count++;
164
165	return true;
166}
167
168static uint32_t dmub_reg_value_pack(const struct dc_context *ctx, uint32_t addr,
169		struct dc_reg_value_masks *field_value_mask)
170{
171	struct dc_reg_helper_state *offload = &ctx->dmub_srv->reg_helper_offload;
172	struct dmub_rb_cmd_read_modify_write *cmd_buf = &offload->cmd_data.read_modify_write;
173	struct dmub_cmd_read_modify_write_sequence *seq;
174
175	/* flush command if buffer is full */
176	if (offload->cmd_data.cmd_common.header.type != DMUB_CMD__REG_SEQ_BURST_WRITE &&
177			offload->reg_seq_count == DMUB_READ_MODIFY_WRITE_SEQ__MAX)
178		dmub_flush_buffer_execute(offload, ctx);
179
180	if (offload->should_burst_write) {
181		if (dmub_reg_value_burst_set_pack(ctx, addr, field_value_mask->value))
182			return field_value_mask->value;
183		else
184			offload->should_burst_write = false;
185	}
186
187	/* pack commands */
188	cmd_buf->header.type = DMUB_CMD__REG_SEQ_READ_MODIFY_WRITE;
189	cmd_buf->header.sub_type = 0;
190	seq = &cmd_buf->seq[offload->reg_seq_count];
191
192	if (offload->reg_seq_count) {
193		if (cmd_buf->seq[offload->reg_seq_count - 1].addr == addr)
194			offload->same_addr_count++;
195		else
196			offload->same_addr_count = 0;
197	}
198
199	seq->addr = addr;
200	seq->modify_mask = field_value_mask->mask;
201	seq->modify_value = field_value_mask->value;
202	offload->reg_seq_count++;
203
204	return field_value_mask->value;
205}
206
207static void dmub_reg_wait_done_pack(const struct dc_context *ctx, uint32_t addr,
208		uint32_t mask, uint32_t shift, uint32_t condition_value, uint32_t time_out_us)
209{
210	struct dc_reg_helper_state *offload = &ctx->dmub_srv->reg_helper_offload;
211	struct dmub_rb_cmd_reg_wait *cmd_buf = &offload->cmd_data.reg_wait;
212
213	cmd_buf->header.type = DMUB_CMD__REG_REG_WAIT;
214	cmd_buf->header.sub_type = 0;
215	cmd_buf->reg_wait.addr = addr;
216	cmd_buf->reg_wait.condition_field_value = mask & (condition_value << shift);
217	cmd_buf->reg_wait.mask = mask;
218	cmd_buf->reg_wait.time_out_us = time_out_us;
219}
220
221uint32_t generic_reg_update_ex(const struct dc_context *ctx,
222		uint32_t addr, int n,
223		uint8_t shift1, uint32_t mask1, uint32_t field_value1,
224		...)
225{
226	struct dc_reg_value_masks field_value_mask = {0};
227	uint32_t reg_val;
228	va_list ap;
229
230	va_start(ap, field_value1);
231
232	set_reg_field_values(&field_value_mask, addr, n, shift1, mask1,
233			field_value1, ap);
234
235	va_end(ap);
236
237	if (ctx->dmub_srv &&
238	    ctx->dmub_srv->reg_helper_offload.gather_in_progress)
239		return dmub_reg_value_pack(ctx, addr, &field_value_mask);
240		/* todo: return void so we can decouple code running in driver from register states */
241
242	/* mmio write directly */
243	reg_val = dm_read_reg(ctx, addr);
244	reg_val = (reg_val & ~field_value_mask.mask) | field_value_mask.value;
245	dm_write_reg(ctx, addr, reg_val);
246	return reg_val;
247}
248
249uint32_t generic_reg_set_ex(const struct dc_context *ctx,
250		uint32_t addr, uint32_t reg_val, int n,
251		uint8_t shift1, uint32_t mask1, uint32_t field_value1,
252		...)
253{
254	struct dc_reg_value_masks field_value_mask = {0};
255	va_list ap;
256
257	va_start(ap, field_value1);
258
259	set_reg_field_values(&field_value_mask, addr, n, shift1, mask1,
260			field_value1, ap);
261
262	va_end(ap);
263
 
264	/* mmio write directly */
265	reg_val = (reg_val & ~field_value_mask.mask) | field_value_mask.value;
266
267	if (ctx->dmub_srv &&
268	    ctx->dmub_srv->reg_helper_offload.gather_in_progress) {
269		return dmub_reg_value_burst_set_pack(ctx, addr, reg_val);
270		/* todo: return void so we can decouple code running in driver from register states */
271	}
272
273	dm_write_reg(ctx, addr, reg_val);
274	return reg_val;
275}
276
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
277uint32_t generic_reg_get(const struct dc_context *ctx, uint32_t addr,
278		uint8_t shift, uint32_t mask, uint32_t *field_value)
279{
280	uint32_t reg_val = dm_read_reg(ctx, addr);
281	*field_value = get_reg_field_value_ex(reg_val, mask, shift);
282	return reg_val;
283}
284
285uint32_t generic_reg_get2(const struct dc_context *ctx, uint32_t addr,
286		uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
287		uint8_t shift2, uint32_t mask2, uint32_t *field_value2)
288{
289	uint32_t reg_val = dm_read_reg(ctx, addr);
290	*field_value1 = get_reg_field_value_ex(reg_val, mask1, shift1);
291	*field_value2 = get_reg_field_value_ex(reg_val, mask2, shift2);
292	return reg_val;
293}
294
295uint32_t generic_reg_get3(const struct dc_context *ctx, uint32_t addr,
296		uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
297		uint8_t shift2, uint32_t mask2, uint32_t *field_value2,
298		uint8_t shift3, uint32_t mask3, uint32_t *field_value3)
299{
300	uint32_t reg_val = dm_read_reg(ctx, addr);
301	*field_value1 = get_reg_field_value_ex(reg_val, mask1, shift1);
302	*field_value2 = get_reg_field_value_ex(reg_val, mask2, shift2);
303	*field_value3 = get_reg_field_value_ex(reg_val, mask3, shift3);
304	return reg_val;
305}
306
307uint32_t generic_reg_get4(const struct dc_context *ctx, uint32_t addr,
308		uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
309		uint8_t shift2, uint32_t mask2, uint32_t *field_value2,
310		uint8_t shift3, uint32_t mask3, uint32_t *field_value3,
311		uint8_t shift4, uint32_t mask4, uint32_t *field_value4)
312{
313	uint32_t reg_val = dm_read_reg(ctx, addr);
314	*field_value1 = get_reg_field_value_ex(reg_val, mask1, shift1);
315	*field_value2 = get_reg_field_value_ex(reg_val, mask2, shift2);
316	*field_value3 = get_reg_field_value_ex(reg_val, mask3, shift3);
317	*field_value4 = get_reg_field_value_ex(reg_val, mask4, shift4);
318	return reg_val;
319}
320
321uint32_t generic_reg_get5(const struct dc_context *ctx, uint32_t addr,
322		uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
323		uint8_t shift2, uint32_t mask2, uint32_t *field_value2,
324		uint8_t shift3, uint32_t mask3, uint32_t *field_value3,
325		uint8_t shift4, uint32_t mask4, uint32_t *field_value4,
326		uint8_t shift5, uint32_t mask5, uint32_t *field_value5)
327{
328	uint32_t reg_val = dm_read_reg(ctx, addr);
329	*field_value1 = get_reg_field_value_ex(reg_val, mask1, shift1);
330	*field_value2 = get_reg_field_value_ex(reg_val, mask2, shift2);
331	*field_value3 = get_reg_field_value_ex(reg_val, mask3, shift3);
332	*field_value4 = get_reg_field_value_ex(reg_val, mask4, shift4);
333	*field_value5 = get_reg_field_value_ex(reg_val, mask5, shift5);
334	return reg_val;
335}
336
337uint32_t generic_reg_get6(const struct dc_context *ctx, uint32_t addr,
338		uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
339		uint8_t shift2, uint32_t mask2, uint32_t *field_value2,
340		uint8_t shift3, uint32_t mask3, uint32_t *field_value3,
341		uint8_t shift4, uint32_t mask4, uint32_t *field_value4,
342		uint8_t shift5, uint32_t mask5, uint32_t *field_value5,
343		uint8_t shift6, uint32_t mask6, uint32_t *field_value6)
344{
345	uint32_t reg_val = dm_read_reg(ctx, addr);
346	*field_value1 = get_reg_field_value_ex(reg_val, mask1, shift1);
347	*field_value2 = get_reg_field_value_ex(reg_val, mask2, shift2);
348	*field_value3 = get_reg_field_value_ex(reg_val, mask3, shift3);
349	*field_value4 = get_reg_field_value_ex(reg_val, mask4, shift4);
350	*field_value5 = get_reg_field_value_ex(reg_val, mask5, shift5);
351	*field_value6 = get_reg_field_value_ex(reg_val, mask6, shift6);
352	return reg_val;
353}
354
355uint32_t generic_reg_get7(const struct dc_context *ctx, uint32_t addr,
356		uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
357		uint8_t shift2, uint32_t mask2, uint32_t *field_value2,
358		uint8_t shift3, uint32_t mask3, uint32_t *field_value3,
359		uint8_t shift4, uint32_t mask4, uint32_t *field_value4,
360		uint8_t shift5, uint32_t mask5, uint32_t *field_value5,
361		uint8_t shift6, uint32_t mask6, uint32_t *field_value6,
362		uint8_t shift7, uint32_t mask7, uint32_t *field_value7)
363{
364	uint32_t reg_val = dm_read_reg(ctx, addr);
365	*field_value1 = get_reg_field_value_ex(reg_val, mask1, shift1);
366	*field_value2 = get_reg_field_value_ex(reg_val, mask2, shift2);
367	*field_value3 = get_reg_field_value_ex(reg_val, mask3, shift3);
368	*field_value4 = get_reg_field_value_ex(reg_val, mask4, shift4);
369	*field_value5 = get_reg_field_value_ex(reg_val, mask5, shift5);
370	*field_value6 = get_reg_field_value_ex(reg_val, mask6, shift6);
371	*field_value7 = get_reg_field_value_ex(reg_val, mask7, shift7);
372	return reg_val;
373}
374
375uint32_t generic_reg_get8(const struct dc_context *ctx, uint32_t addr,
376		uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
377		uint8_t shift2, uint32_t mask2, uint32_t *field_value2,
378		uint8_t shift3, uint32_t mask3, uint32_t *field_value3,
379		uint8_t shift4, uint32_t mask4, uint32_t *field_value4,
380		uint8_t shift5, uint32_t mask5, uint32_t *field_value5,
381		uint8_t shift6, uint32_t mask6, uint32_t *field_value6,
382		uint8_t shift7, uint32_t mask7, uint32_t *field_value7,
383		uint8_t shift8, uint32_t mask8, uint32_t *field_value8)
384{
385	uint32_t reg_val = dm_read_reg(ctx, addr);
386	*field_value1 = get_reg_field_value_ex(reg_val, mask1, shift1);
387	*field_value2 = get_reg_field_value_ex(reg_val, mask2, shift2);
388	*field_value3 = get_reg_field_value_ex(reg_val, mask3, shift3);
389	*field_value4 = get_reg_field_value_ex(reg_val, mask4, shift4);
390	*field_value5 = get_reg_field_value_ex(reg_val, mask5, shift5);
391	*field_value6 = get_reg_field_value_ex(reg_val, mask6, shift6);
392	*field_value7 = get_reg_field_value_ex(reg_val, mask7, shift7);
393	*field_value8 = get_reg_field_value_ex(reg_val, mask8, shift8);
394	return reg_val;
395}
396/* note:  va version of this is pretty bad idea, since there is a output parameter pass by pointer
397 * compiler won't be able to check for size match and is prone to stack corruption type of bugs
398
399uint32_t generic_reg_get(const struct dc_context *ctx,
400		uint32_t addr, int n, ...)
401{
402	uint32_t shift, mask;
403	uint32_t *field_value;
404	uint32_t reg_val;
405	int i = 0;
406
407	reg_val = dm_read_reg(ctx, addr);
408
409	va_list ap;
410	va_start(ap, n);
411
412	while (i < n) {
413		shift = va_arg(ap, uint32_t);
414		mask = va_arg(ap, uint32_t);
415		field_value = va_arg(ap, uint32_t *);
416
417		*field_value = get_reg_field_value_ex(reg_val, mask, shift);
418		i++;
419	}
420
421	va_end(ap);
422
423	return reg_val;
424}
425*/
426
427void generic_reg_wait(const struct dc_context *ctx,
428	uint32_t addr, uint32_t shift, uint32_t mask, uint32_t condition_value,
429	unsigned int delay_between_poll_us, unsigned int time_out_num_tries,
430	const char *func_name, int line)
431{
432	uint32_t field_value;
433	uint32_t reg_val;
434	int i;
435
436	if (ctx->dmub_srv &&
437	    ctx->dmub_srv->reg_helper_offload.gather_in_progress) {
438		dmub_reg_wait_done_pack(ctx, addr, mask, shift, condition_value,
439				delay_between_poll_us * time_out_num_tries);
440		return;
441	}
442
443	/*
444	 * Something is terribly wrong if time out is > 3000ms.
445	 * 3000ms is the maximum time needed for SMU to pass values back.
446	 * This value comes from experiments.
447	 *
448	 */
449	ASSERT(delay_between_poll_us * time_out_num_tries <= 3000000);
450
451	for (i = 0; i <= time_out_num_tries; i++) {
452		if (i) {
453			if (delay_between_poll_us >= 1000)
454				msleep(delay_between_poll_us/1000);
455			else if (delay_between_poll_us > 0)
456				udelay(delay_between_poll_us);
457		}
458
459		reg_val = dm_read_reg(ctx, addr);
460
461		field_value = get_reg_field_value_ex(reg_val, mask, shift);
462
463		if (field_value == condition_value) {
464			if (i * delay_between_poll_us > 1000)
 
465				DC_LOG_DC("REG_WAIT taking a while: %dms in %s line:%d\n",
466						delay_between_poll_us * i / 1000,
467						func_name, line);
468			return;
469		}
470	}
471
472	DC_LOG_WARNING("REG_WAIT timeout %dus * %d tries - %s line:%d\n",
473			delay_between_poll_us, time_out_num_tries,
474			func_name, line);
475
476	BREAK_TO_DEBUGGER();
 
477}
478
479void generic_write_indirect_reg(const struct dc_context *ctx,
480		uint32_t addr_index, uint32_t addr_data,
481		uint32_t index, uint32_t data)
482{
483	dm_write_reg(ctx, addr_index, index);
484	dm_write_reg(ctx, addr_data, data);
485}
486
487uint32_t generic_read_indirect_reg(const struct dc_context *ctx,
488		uint32_t addr_index, uint32_t addr_data,
489		uint32_t index)
490{
491	uint32_t value = 0;
492
493	// when reg read, there should not be any offload.
494	if (ctx->dmub_srv &&
495	    ctx->dmub_srv->reg_helper_offload.gather_in_progress) {
496		ASSERT(false);
497	}
498
499	dm_write_reg(ctx, addr_index, index);
500	value = dm_read_reg(ctx, addr_data);
501
502	return value;
503}
504
505uint32_t generic_indirect_reg_get(const struct dc_context *ctx,
506		uint32_t addr_index, uint32_t addr_data,
507		uint32_t index, int n,
508		uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
509		...)
510{
511	uint32_t shift, mask, *field_value;
512	uint32_t value = 0;
513	int i = 1;
514
515	va_list ap;
516
517	va_start(ap, field_value1);
518
519	value = generic_read_indirect_reg(ctx, addr_index, addr_data, index);
520	*field_value1 = get_reg_field_value_ex(value, mask1, shift1);
521
522	while (i < n) {
523		shift = va_arg(ap, uint32_t);
524		mask = va_arg(ap, uint32_t);
525		field_value = va_arg(ap, uint32_t *);
526
527		*field_value = get_reg_field_value_ex(value, mask, shift);
528		i++;
529	}
530
531	va_end(ap);
532
533	return value;
534}
535
536uint32_t generic_indirect_reg_update_ex(const struct dc_context *ctx,
537		uint32_t addr_index, uint32_t addr_data,
538		uint32_t index, uint32_t reg_val, int n,
539		uint8_t shift1, uint32_t mask1, uint32_t field_value1,
540		...)
541{
542	uint32_t shift, mask, field_value;
543	int i = 1;
544
545	va_list ap;
546
547	va_start(ap, field_value1);
548
549	reg_val = set_reg_field_value_ex(reg_val, field_value1, mask1, shift1);
550
551	while (i < n) {
552		shift = va_arg(ap, uint32_t);
553		mask = va_arg(ap, uint32_t);
554		field_value = va_arg(ap, uint32_t);
555
556		reg_val = set_reg_field_value_ex(reg_val, field_value, mask, shift);
557		i++;
558	}
559
560	generic_write_indirect_reg(ctx, addr_index, addr_data, index, reg_val);
561	va_end(ap);
562
563	return reg_val;
564}
565
566
567uint32_t generic_indirect_reg_update_ex_sync(const struct dc_context *ctx,
568		uint32_t index, uint32_t reg_val, int n,
569		uint8_t shift1, uint32_t mask1, uint32_t field_value1,
570		...)
571{
572	uint32_t shift, mask, field_value;
573	int i = 1;
574
575	va_list ap;
576
577	va_start(ap, field_value1);
578
579	reg_val = set_reg_field_value_ex(reg_val, field_value1, mask1, shift1);
580
581	while (i < n) {
582		shift = va_arg(ap, uint32_t);
583		mask = va_arg(ap, uint32_t);
584		field_value = va_arg(ap, uint32_t);
585
586		reg_val = set_reg_field_value_ex(reg_val, field_value, mask, shift);
587		i++;
588	}
589
590	dm_write_index_reg(ctx, CGS_IND_REG__PCIE, index, reg_val);
591	va_end(ap);
592
593	return reg_val;
594}
595
596uint32_t generic_indirect_reg_get_sync(const struct dc_context *ctx,
597		uint32_t index, int n,
598		uint8_t shift1, uint32_t mask1, uint32_t *field_value1,
599		...)
600{
601	uint32_t shift, mask, *field_value;
602	uint32_t value = 0;
603	int i = 1;
604
605	va_list ap;
606
607	va_start(ap, field_value1);
608
609	value = dm_read_index_reg(ctx, CGS_IND_REG__PCIE, index);
610	*field_value1 = get_reg_field_value_ex(value, mask1, shift1);
611
612	while (i < n) {
613		shift = va_arg(ap, uint32_t);
614		mask = va_arg(ap, uint32_t);
615		field_value = va_arg(ap, uint32_t *);
616
617		*field_value = get_reg_field_value_ex(value, mask, shift);
618		i++;
619	}
620
621	va_end(ap);
622
623	return value;
624}
625
626void reg_sequence_start_gather(const struct dc_context *ctx)
627{
628	/* if reg sequence is supported and enabled, set flag to
629	 * indicate we want to have REG_SET, REG_UPDATE macro build
630	 * reg sequence command buffer rather than MMIO directly.
631	 */
632
633	if (ctx->dmub_srv && ctx->dc->debug.dmub_offload_enabled) {
634		struct dc_reg_helper_state *offload =
635			&ctx->dmub_srv->reg_helper_offload;
636
637		/* caller sequence mismatch.  need to debug caller.  offload will not work!!! */
638		ASSERT(!offload->gather_in_progress);
639
640		offload->gather_in_progress = true;
641	}
642}
643
644void reg_sequence_start_execute(const struct dc_context *ctx)
645{
646	struct dc_reg_helper_state *offload;
647
648	if (!ctx->dmub_srv)
649		return;
650
651	offload = &ctx->dmub_srv->reg_helper_offload;
652
653	if (offload && offload->gather_in_progress) {
654		offload->gather_in_progress = false;
655		offload->should_burst_write = false;
656		switch (offload->cmd_data.cmd_common.header.type) {
657		case DMUB_CMD__REG_SEQ_READ_MODIFY_WRITE:
658			submit_dmub_read_modify_write(offload, ctx);
659			break;
660		case DMUB_CMD__REG_REG_WAIT:
661			submit_dmub_reg_wait(offload, ctx);
662			break;
663		case DMUB_CMD__REG_SEQ_BURST_WRITE:
664			submit_dmub_burst_write(offload, ctx);
665			break;
666		default:
667			return;
668		}
 
 
669	}
670}
671
672void reg_sequence_wait_done(const struct dc_context *ctx)
673{
674	/* callback to DM to poll for last submission done*/
675	struct dc_reg_helper_state *offload;
676
677	if (!ctx->dmub_srv)
678		return;
679
680	offload = &ctx->dmub_srv->reg_helper_offload;
681
682	if (offload &&
683	    ctx->dc->debug.dmub_offload_enabled &&
684	    !ctx->dc->debug.dmcub_emulation) {
685		dc_dmub_srv_wait_idle(ctx->dmub_srv);
686	}
687}
688
689char *dce_version_to_string(const int version)
690{
691	switch (version) {
692	case DCE_VERSION_8_0:
693		return "DCE 8.0";
694	case DCE_VERSION_8_1:
695		return "DCE 8.1";
696	case DCE_VERSION_8_3:
697		return "DCE 8.3";
698	case DCE_VERSION_10_0:
699		return "DCE 10.0";
700	case DCE_VERSION_11_0:
701		return "DCE 11.0";
702	case DCE_VERSION_11_2:
703		return "DCE 11.2";
704	case DCE_VERSION_11_22:
705		return "DCE 11.22";
706	case DCE_VERSION_12_0:
707		return "DCE 12.0";
708	case DCE_VERSION_12_1:
709		return "DCE 12.1";
710	case DCN_VERSION_1_0:
711		return "DCN 1.0";
712	case DCN_VERSION_1_01:
713		return "DCN 1.0.1";
714	case DCN_VERSION_2_0:
715		return "DCN 2.0";
716	case DCN_VERSION_2_1:
717		return "DCN 2.1";
718	case DCN_VERSION_2_01:
719		return "DCN 2.0.1";
720	case DCN_VERSION_3_0:
721		return "DCN 3.0";
722	case DCN_VERSION_3_01:
723		return "DCN 3.0.1";
724	case DCN_VERSION_3_02:
725		return "DCN 3.0.2";
726	case DCN_VERSION_3_03:
727		return "DCN 3.0.3";
728	case DCN_VERSION_3_1:
729		return "DCN 3.1";
730	case DCN_VERSION_3_14:
731		return "DCN 3.1.4";
732	case DCN_VERSION_3_15:
733		return "DCN 3.1.5";
734	case DCN_VERSION_3_16:
735		return "DCN 3.1.6";
736	case DCN_VERSION_3_2:
737		return "DCN 3.2";
738	case DCN_VERSION_3_21:
739		return "DCN 3.2.1";
740	case DCN_VERSION_3_5:
741		return "DCN 3.5";
742	case DCN_VERSION_3_51:
743		return "DCN 3.5.1";
744	case DCN_VERSION_4_01:
745		return "DCN 4.0.1";
746	default:
747		return "Unknown";
748	}
749}