xref: /linux/drivers/gpu/drm/amd/display/dc/dc_dmub_srv.c (revision 569d7db70e5dcf13fbf072f10e9096577ac1e565)
1 /*
2  * Copyright 2019 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  * Authors: AMD
23  *
24  */
25 
26 #include "dm_services.h"
27 #include "dc.h"
28 #include "dc_dmub_srv.h"
29 #include "../dmub/dmub_srv.h"
30 #include "dm_helpers.h"
31 #include "dc_hw_types.h"
32 #include "core_types.h"
33 #include "../basics/conversion.h"
34 #include "cursor_reg_cache.h"
35 #include "resource.h"
36 #include "clk_mgr.h"
37 #include "dc_state_priv.h"
38 #include "dc_plane_priv.h"
39 
40 #define CTX dc_dmub_srv->ctx
41 #define DC_LOGGER CTX->logger
42 
43 static void dc_dmub_srv_construct(struct dc_dmub_srv *dc_srv, struct dc *dc,
44 				  struct dmub_srv *dmub)
45 {
46 	dc_srv->dmub = dmub;
47 	dc_srv->ctx = dc->ctx;
48 }
49 
50 struct dc_dmub_srv *dc_dmub_srv_create(struct dc *dc, struct dmub_srv *dmub)
51 {
52 	struct dc_dmub_srv *dc_srv =
53 		kzalloc(sizeof(struct dc_dmub_srv), GFP_KERNEL);
54 
55 	if (dc_srv == NULL) {
56 		BREAK_TO_DEBUGGER();
57 		return NULL;
58 	}
59 
60 	dc_dmub_srv_construct(dc_srv, dc, dmub);
61 
62 	return dc_srv;
63 }
64 
65 void dc_dmub_srv_destroy(struct dc_dmub_srv **dmub_srv)
66 {
67 	if (*dmub_srv) {
68 		kfree(*dmub_srv);
69 		*dmub_srv = NULL;
70 	}
71 }
72 
73 void dc_dmub_srv_wait_idle(struct dc_dmub_srv *dc_dmub_srv)
74 {
75 	struct dmub_srv *dmub = dc_dmub_srv->dmub;
76 	struct dc_context *dc_ctx = dc_dmub_srv->ctx;
77 	enum dmub_status status;
78 
79 	do {
80 		status = dmub_srv_wait_for_idle(dmub, 100000);
81 	} while (dc_dmub_srv->ctx->dc->debug.disable_timeout && status != DMUB_STATUS_OK);
82 
83 	if (status != DMUB_STATUS_OK) {
84 		DC_ERROR("Error waiting for DMUB idle: status=%d\n", status);
85 		dc_dmub_srv_log_diagnostic_data(dc_dmub_srv);
86 	}
87 }
88 
89 void dc_dmub_srv_clear_inbox0_ack(struct dc_dmub_srv *dc_dmub_srv)
90 {
91 	struct dmub_srv *dmub = dc_dmub_srv->dmub;
92 	struct dc_context *dc_ctx = dc_dmub_srv->ctx;
93 	enum dmub_status status = DMUB_STATUS_OK;
94 
95 	status = dmub_srv_clear_inbox0_ack(dmub);
96 	if (status != DMUB_STATUS_OK) {
97 		DC_ERROR("Error clearing INBOX0 ack: status=%d\n", status);
98 		dc_dmub_srv_log_diagnostic_data(dc_dmub_srv);
99 	}
100 }
101 
102 void dc_dmub_srv_wait_for_inbox0_ack(struct dc_dmub_srv *dc_dmub_srv)
103 {
104 	struct dmub_srv *dmub = dc_dmub_srv->dmub;
105 	struct dc_context *dc_ctx = dc_dmub_srv->ctx;
106 	enum dmub_status status = DMUB_STATUS_OK;
107 
108 	status = dmub_srv_wait_for_inbox0_ack(dmub, 100000);
109 	if (status != DMUB_STATUS_OK) {
110 		DC_ERROR("Error waiting for INBOX0 HW Lock Ack\n");
111 		dc_dmub_srv_log_diagnostic_data(dc_dmub_srv);
112 	}
113 }
114 
115 void dc_dmub_srv_send_inbox0_cmd(struct dc_dmub_srv *dc_dmub_srv,
116 				 union dmub_inbox0_data_register data)
117 {
118 	struct dmub_srv *dmub = dc_dmub_srv->dmub;
119 	struct dc_context *dc_ctx = dc_dmub_srv->ctx;
120 	enum dmub_status status = DMUB_STATUS_OK;
121 
122 	status = dmub_srv_send_inbox0_cmd(dmub, data);
123 	if (status != DMUB_STATUS_OK) {
124 		DC_ERROR("Error sending INBOX0 cmd\n");
125 		dc_dmub_srv_log_diagnostic_data(dc_dmub_srv);
126 	}
127 }
128 
129 bool dc_dmub_srv_cmd_list_queue_execute(struct dc_dmub_srv *dc_dmub_srv,
130 		unsigned int count,
131 		union dmub_rb_cmd *cmd_list)
132 {
133 	struct dc_context *dc_ctx;
134 	struct dmub_srv *dmub;
135 	enum dmub_status status;
136 	int i;
137 
138 	if (!dc_dmub_srv || !dc_dmub_srv->dmub)
139 		return false;
140 
141 	dc_ctx = dc_dmub_srv->ctx;
142 	dmub = dc_dmub_srv->dmub;
143 
144 	for (i = 0 ; i < count; i++) {
145 		// Queue command
146 		status = dmub_srv_cmd_queue(dmub, &cmd_list[i]);
147 
148 		if (status == DMUB_STATUS_QUEUE_FULL) {
149 			/* Execute and wait for queue to become empty again. */
150 			status = dmub_srv_cmd_execute(dmub);
151 			if (status == DMUB_STATUS_POWER_STATE_D3)
152 				return false;
153 
154 			do {
155 				status = dmub_srv_wait_for_idle(dmub, 100000);
156 			} while (dc_dmub_srv->ctx->dc->debug.disable_timeout && status != DMUB_STATUS_OK);
157 
158 			/* Requeue the command. */
159 			status = dmub_srv_cmd_queue(dmub, &cmd_list[i]);
160 		}
161 
162 		if (status != DMUB_STATUS_OK) {
163 			if (status != DMUB_STATUS_POWER_STATE_D3) {
164 				DC_ERROR("Error queueing DMUB command: status=%d\n", status);
165 				dc_dmub_srv_log_diagnostic_data(dc_dmub_srv);
166 			}
167 			return false;
168 		}
169 	}
170 
171 	status = dmub_srv_cmd_execute(dmub);
172 	if (status != DMUB_STATUS_OK) {
173 		if (status != DMUB_STATUS_POWER_STATE_D3) {
174 			DC_ERROR("Error starting DMUB execution: status=%d\n", status);
175 			dc_dmub_srv_log_diagnostic_data(dc_dmub_srv);
176 		}
177 		return false;
178 	}
179 
180 	return true;
181 }
182 
183 bool dc_dmub_srv_wait_for_idle(struct dc_dmub_srv *dc_dmub_srv,
184 		enum dm_dmub_wait_type wait_type,
185 		union dmub_rb_cmd *cmd_list)
186 {
187 	struct dmub_srv *dmub;
188 	enum dmub_status status;
189 
190 	if (!dc_dmub_srv || !dc_dmub_srv->dmub)
191 		return false;
192 
193 	dmub = dc_dmub_srv->dmub;
194 
195 	// Wait for DMUB to process command
196 	if (wait_type != DM_DMUB_WAIT_TYPE_NO_WAIT) {
197 		do {
198 			status = dmub_srv_wait_for_idle(dmub, 100000);
199 		} while (dc_dmub_srv->ctx->dc->debug.disable_timeout && status != DMUB_STATUS_OK);
200 
201 		if (status != DMUB_STATUS_OK) {
202 			DC_LOG_DEBUG("No reply for DMUB command: status=%d\n", status);
203 			if (!dmub->debug.timeout_occured) {
204 				dmub->debug.timeout_occured = true;
205 				dmub->debug.timeout_cmd = *cmd_list;
206 				dmub->debug.timestamp = dm_get_timestamp(dc_dmub_srv->ctx);
207 			}
208 			dc_dmub_srv_log_diagnostic_data(dc_dmub_srv);
209 			return false;
210 		}
211 
212 		// Copy data back from ring buffer into command
213 		if (wait_type == DM_DMUB_WAIT_TYPE_WAIT_WITH_REPLY)
214 			dmub_rb_get_return_data(&dmub->inbox1_rb, cmd_list);
215 	}
216 
217 	return true;
218 }
219 
220 bool dc_dmub_srv_cmd_run(struct dc_dmub_srv *dc_dmub_srv, union dmub_rb_cmd *cmd, enum dm_dmub_wait_type wait_type)
221 {
222 	return dc_dmub_srv_cmd_run_list(dc_dmub_srv, 1, cmd, wait_type);
223 }
224 
225 bool dc_dmub_srv_cmd_run_list(struct dc_dmub_srv *dc_dmub_srv, unsigned int count, union dmub_rb_cmd *cmd_list, enum dm_dmub_wait_type wait_type)
226 {
227 	struct dc_context *dc_ctx;
228 	struct dmub_srv *dmub;
229 	enum dmub_status status;
230 	int i;
231 
232 	if (!dc_dmub_srv || !dc_dmub_srv->dmub)
233 		return false;
234 
235 	dc_ctx = dc_dmub_srv->ctx;
236 	dmub = dc_dmub_srv->dmub;
237 
238 	for (i = 0 ; i < count; i++) {
239 		// Queue command
240 		status = dmub_srv_cmd_queue(dmub, &cmd_list[i]);
241 
242 		if (status == DMUB_STATUS_QUEUE_FULL) {
243 			/* Execute and wait for queue to become empty again. */
244 			status = dmub_srv_cmd_execute(dmub);
245 			if (status == DMUB_STATUS_POWER_STATE_D3)
246 				return false;
247 
248 			dmub_srv_wait_for_idle(dmub, 100000);
249 
250 			/* Requeue the command. */
251 			status = dmub_srv_cmd_queue(dmub, &cmd_list[i]);
252 		}
253 
254 		if (status != DMUB_STATUS_OK) {
255 			if (status != DMUB_STATUS_POWER_STATE_D3) {
256 				DC_ERROR("Error queueing DMUB command: status=%d\n", status);
257 				dc_dmub_srv_log_diagnostic_data(dc_dmub_srv);
258 			}
259 			return false;
260 		}
261 	}
262 
263 	status = dmub_srv_cmd_execute(dmub);
264 	if (status != DMUB_STATUS_OK) {
265 		if (status != DMUB_STATUS_POWER_STATE_D3) {
266 			DC_ERROR("Error starting DMUB execution: status=%d\n", status);
267 			dc_dmub_srv_log_diagnostic_data(dc_dmub_srv);
268 		}
269 		return false;
270 	}
271 
272 	// Wait for DMUB to process command
273 	if (wait_type != DM_DMUB_WAIT_TYPE_NO_WAIT) {
274 		if (dc_dmub_srv->ctx->dc->debug.disable_timeout) {
275 			do {
276 				status = dmub_srv_wait_for_idle(dmub, 100000);
277 			} while (status != DMUB_STATUS_OK);
278 		} else
279 			status = dmub_srv_wait_for_idle(dmub, 100000);
280 
281 		if (status != DMUB_STATUS_OK) {
282 			DC_LOG_DEBUG("No reply for DMUB command: status=%d\n", status);
283 			dc_dmub_srv_log_diagnostic_data(dc_dmub_srv);
284 			return false;
285 		}
286 
287 		// Copy data back from ring buffer into command
288 		if (wait_type == DM_DMUB_WAIT_TYPE_WAIT_WITH_REPLY)
289 			dmub_rb_get_return_data(&dmub->inbox1_rb, cmd_list);
290 	}
291 
292 	return true;
293 }
294 
295 bool dc_dmub_srv_optimized_init_done(struct dc_dmub_srv *dc_dmub_srv)
296 {
297 	struct dmub_srv *dmub;
298 	struct dc_context *dc_ctx;
299 	union dmub_fw_boot_status boot_status;
300 	enum dmub_status status;
301 
302 	if (!dc_dmub_srv || !dc_dmub_srv->dmub)
303 		return false;
304 
305 	dmub = dc_dmub_srv->dmub;
306 	dc_ctx = dc_dmub_srv->ctx;
307 
308 	status = dmub_srv_get_fw_boot_status(dmub, &boot_status);
309 	if (status != DMUB_STATUS_OK) {
310 		DC_ERROR("Error querying DMUB boot status: error=%d\n", status);
311 		return false;
312 	}
313 
314 	return boot_status.bits.optimized_init_done;
315 }
316 
317 bool dc_dmub_srv_notify_stream_mask(struct dc_dmub_srv *dc_dmub_srv,
318 				    unsigned int stream_mask)
319 {
320 	if (!dc_dmub_srv || !dc_dmub_srv->dmub)
321 		return false;
322 
323 	return dc_wake_and_execute_gpint(dc_dmub_srv->ctx, DMUB_GPINT__IDLE_OPT_NOTIFY_STREAM_MASK,
324 					 stream_mask, NULL, DM_DMUB_WAIT_TYPE_WAIT);
325 }
326 
327 bool dc_dmub_srv_is_restore_required(struct dc_dmub_srv *dc_dmub_srv)
328 {
329 	struct dmub_srv *dmub;
330 	struct dc_context *dc_ctx;
331 	union dmub_fw_boot_status boot_status;
332 	enum dmub_status status;
333 
334 	if (!dc_dmub_srv || !dc_dmub_srv->dmub)
335 		return false;
336 
337 	dmub = dc_dmub_srv->dmub;
338 	dc_ctx = dc_dmub_srv->ctx;
339 
340 	status = dmub_srv_get_fw_boot_status(dmub, &boot_status);
341 	if (status != DMUB_STATUS_OK) {
342 		DC_ERROR("Error querying DMUB boot status: error=%d\n", status);
343 		return false;
344 	}
345 
346 	return boot_status.bits.restore_required;
347 }
348 
349 bool dc_dmub_srv_get_dmub_outbox0_msg(const struct dc *dc, struct dmcub_trace_buf_entry *entry)
350 {
351 	struct dmub_srv *dmub = dc->ctx->dmub_srv->dmub;
352 	return dmub_srv_get_outbox0_msg(dmub, entry);
353 }
354 
355 void dc_dmub_trace_event_control(struct dc *dc, bool enable)
356 {
357 	dm_helpers_dmub_outbox_interrupt_control(dc->ctx, enable);
358 }
359 
360 void dc_dmub_srv_drr_update_cmd(struct dc *dc, uint32_t tg_inst, uint32_t vtotal_min, uint32_t vtotal_max)
361 {
362 	union dmub_rb_cmd cmd = { 0 };
363 
364 	cmd.drr_update.header.type = DMUB_CMD__FW_ASSISTED_MCLK_SWITCH;
365 	cmd.drr_update.header.sub_type = DMUB_CMD__FAMS_DRR_UPDATE;
366 	cmd.drr_update.dmub_optc_state_req.v_total_max = vtotal_max;
367 	cmd.drr_update.dmub_optc_state_req.v_total_min = vtotal_min;
368 	cmd.drr_update.dmub_optc_state_req.tg_inst = tg_inst;
369 
370 	cmd.drr_update.header.payload_bytes = sizeof(cmd.drr_update) - sizeof(cmd.drr_update.header);
371 
372 	// Send the command to the DMCUB.
373 	dc_wake_and_execute_dmub_cmd(dc->ctx, &cmd, DM_DMUB_WAIT_TYPE_WAIT);
374 }
375 
376 void dc_dmub_srv_set_drr_manual_trigger_cmd(struct dc *dc, uint32_t tg_inst)
377 {
378 	union dmub_rb_cmd cmd = { 0 };
379 
380 	cmd.drr_update.header.type = DMUB_CMD__FW_ASSISTED_MCLK_SWITCH;
381 	cmd.drr_update.header.sub_type = DMUB_CMD__FAMS_SET_MANUAL_TRIGGER;
382 	cmd.drr_update.dmub_optc_state_req.tg_inst = tg_inst;
383 
384 	cmd.drr_update.header.payload_bytes = sizeof(cmd.drr_update) - sizeof(cmd.drr_update.header);
385 
386 	// Send the command to the DMCUB.
387 	dc_wake_and_execute_dmub_cmd(dc->ctx, &cmd, DM_DMUB_WAIT_TYPE_WAIT);
388 }
389 
390 static uint8_t dc_dmub_srv_get_pipes_for_stream(struct dc *dc, struct dc_stream_state *stream)
391 {
392 	uint8_t pipes = 0;
393 	int i = 0;
394 
395 	for (i = 0; i < MAX_PIPES; i++) {
396 		struct pipe_ctx *pipe = &dc->current_state->res_ctx.pipe_ctx[i];
397 
398 		if (pipe->stream == stream && pipe->stream_res.tg)
399 			pipes = i;
400 	}
401 	return pipes;
402 }
403 
404 static void dc_dmub_srv_populate_fams_pipe_info(struct dc *dc, struct dc_state *context,
405 		struct pipe_ctx *head_pipe,
406 		struct dmub_cmd_fw_assisted_mclk_switch_pipe_data *fams_pipe_data)
407 {
408 	int j;
409 	int pipe_idx = 0;
410 
411 	fams_pipe_data->pipe_index[pipe_idx++] = head_pipe->plane_res.hubp->inst;
412 	for (j = 0; j < dc->res_pool->pipe_count; j++) {
413 		struct pipe_ctx *split_pipe = &context->res_ctx.pipe_ctx[j];
414 
415 		if (split_pipe->stream == head_pipe->stream && (split_pipe->top_pipe || split_pipe->prev_odm_pipe)) {
416 			fams_pipe_data->pipe_index[pipe_idx++] = split_pipe->plane_res.hubp->inst;
417 		}
418 	}
419 	fams_pipe_data->pipe_count = pipe_idx;
420 }
421 
422 bool dc_dmub_srv_p_state_delegate(struct dc *dc, bool should_manage_pstate, struct dc_state *context)
423 {
424 	union dmub_rb_cmd cmd = { 0 };
425 	struct dmub_cmd_fw_assisted_mclk_switch_config *config_data = &cmd.fw_assisted_mclk_switch.config_data;
426 	int i = 0, k = 0;
427 	int ramp_up_num_steps = 1; // TODO: Ramp is currently disabled. Reenable it.
428 	uint8_t visual_confirm_enabled;
429 	int pipe_idx = 0;
430 	struct dc_stream_status *stream_status = NULL;
431 
432 	if (dc == NULL)
433 		return false;
434 
435 	visual_confirm_enabled = dc->debug.visual_confirm == VISUAL_CONFIRM_FAMS;
436 
437 	// Format command.
438 	cmd.fw_assisted_mclk_switch.header.type = DMUB_CMD__FW_ASSISTED_MCLK_SWITCH;
439 	cmd.fw_assisted_mclk_switch.header.sub_type = DMUB_CMD__FAMS_SETUP_FW_CTRL;
440 	cmd.fw_assisted_mclk_switch.config_data.fams_enabled = should_manage_pstate;
441 	cmd.fw_assisted_mclk_switch.config_data.visual_confirm_enabled = visual_confirm_enabled;
442 
443 	if (should_manage_pstate) {
444 		for (i = 0, pipe_idx = 0; i < dc->res_pool->pipe_count; i++) {
445 			struct pipe_ctx *pipe = &context->res_ctx.pipe_ctx[i];
446 
447 			if (!pipe->stream)
448 				continue;
449 
450 			/* If FAMS is being used to support P-State and there is a stream
451 			 * that does not use FAMS, we are in an FPO + VActive scenario.
452 			 * Assign vactive stretch margin in this case.
453 			 */
454 			stream_status = dc_state_get_stream_status(context, pipe->stream);
455 			if (stream_status && !stream_status->fpo_in_use) {
456 				cmd.fw_assisted_mclk_switch.config_data.vactive_stretch_margin_us = dc->debug.fpo_vactive_margin_us;
457 				break;
458 			}
459 			pipe_idx++;
460 		}
461 	}
462 
463 	for (i = 0, k = 0; context && i < dc->res_pool->pipe_count; i++) {
464 		struct pipe_ctx *pipe = &context->res_ctx.pipe_ctx[i];
465 
466 		if (!resource_is_pipe_type(pipe, OTG_MASTER))
467 			continue;
468 
469 		stream_status = dc_state_get_stream_status(context, pipe->stream);
470 		if (stream_status && stream_status->fpo_in_use) {
471 			struct pipe_ctx *pipe = &context->res_ctx.pipe_ctx[i];
472 			uint8_t min_refresh_in_hz = (pipe->stream->timing.min_refresh_in_uhz + 999999) / 1000000;
473 
474 			config_data->pipe_data[k].pix_clk_100hz = pipe->stream->timing.pix_clk_100hz;
475 			config_data->pipe_data[k].min_refresh_in_hz = min_refresh_in_hz;
476 			config_data->pipe_data[k].max_ramp_step = ramp_up_num_steps;
477 			config_data->pipe_data[k].pipes = dc_dmub_srv_get_pipes_for_stream(dc, pipe->stream);
478 			dc_dmub_srv_populate_fams_pipe_info(dc, context, pipe, &config_data->pipe_data[k]);
479 			k++;
480 		}
481 	}
482 	cmd.fw_assisted_mclk_switch.header.payload_bytes =
483 		sizeof(cmd.fw_assisted_mclk_switch) - sizeof(cmd.fw_assisted_mclk_switch.header);
484 
485 	// Send the command to the DMCUB.
486 	dc_wake_and_execute_dmub_cmd(dc->ctx, &cmd, DM_DMUB_WAIT_TYPE_WAIT);
487 
488 	return true;
489 }
490 
491 void dc_dmub_srv_query_caps_cmd(struct dc_dmub_srv *dc_dmub_srv)
492 {
493 	union dmub_rb_cmd cmd = { 0 };
494 
495 	if (dc_dmub_srv->ctx->dc->debug.dmcub_emulation)
496 		return;
497 
498 	memset(&cmd, 0, sizeof(cmd));
499 
500 	/* Prepare fw command */
501 	cmd.query_feature_caps.header.type = DMUB_CMD__QUERY_FEATURE_CAPS;
502 	cmd.query_feature_caps.header.sub_type = 0;
503 	cmd.query_feature_caps.header.ret_status = 1;
504 	cmd.query_feature_caps.header.payload_bytes = sizeof(struct dmub_cmd_query_feature_caps_data);
505 
506 	/* If command was processed, copy feature caps to dmub srv */
507 	if (dc_wake_and_execute_dmub_cmd(dc_dmub_srv->ctx, &cmd, DM_DMUB_WAIT_TYPE_WAIT_WITH_REPLY) &&
508 	    cmd.query_feature_caps.header.ret_status == 0) {
509 		memcpy(&dc_dmub_srv->dmub->feature_caps,
510 		       &cmd.query_feature_caps.query_feature_caps_data,
511 		       sizeof(struct dmub_feature_caps));
512 	}
513 }
514 
515 void dc_dmub_srv_get_visual_confirm_color_cmd(struct dc *dc, struct pipe_ctx *pipe_ctx)
516 {
517 	union dmub_rb_cmd cmd = { 0 };
518 	unsigned int panel_inst = 0;
519 
520 	dc_get_edp_link_panel_inst(dc, pipe_ctx->stream->link, &panel_inst);
521 
522 	memset(&cmd, 0, sizeof(cmd));
523 
524 	// Prepare fw command
525 	cmd.visual_confirm_color.header.type = DMUB_CMD__GET_VISUAL_CONFIRM_COLOR;
526 	cmd.visual_confirm_color.header.sub_type = 0;
527 	cmd.visual_confirm_color.header.ret_status = 1;
528 	cmd.visual_confirm_color.header.payload_bytes = sizeof(struct dmub_cmd_visual_confirm_color_data);
529 	cmd.visual_confirm_color.visual_confirm_color_data.visual_confirm_color.panel_inst = panel_inst;
530 
531 	// If command was processed, copy feature caps to dmub srv
532 	if (dc_wake_and_execute_dmub_cmd(dc->ctx, &cmd, DM_DMUB_WAIT_TYPE_WAIT_WITH_REPLY) &&
533 		cmd.visual_confirm_color.header.ret_status == 0) {
534 		memcpy(&dc->ctx->dmub_srv->dmub->visual_confirm_color,
535 			&cmd.visual_confirm_color.visual_confirm_color_data,
536 			sizeof(struct dmub_visual_confirm_color));
537 	}
538 }
539 
540 /**
541  * populate_subvp_cmd_drr_info - Helper to populate DRR pipe info for the DMCUB subvp command
542  *
543  * @dc: [in] pointer to dc object
544  * @subvp_pipe: [in] pipe_ctx for the SubVP pipe
545  * @vblank_pipe: [in] pipe_ctx for the DRR pipe
546  * @pipe_data: [in] Pipe data which stores the VBLANK/DRR info
547  * @context: [in] DC state for access to phantom stream
548  *
549  * Populate the DMCUB SubVP command with DRR pipe info. All the information
550  * required for calculating the SubVP + DRR microschedule is populated here.
551  *
552  * High level algorithm:
553  * 1. Get timing for SubVP pipe, phantom pipe, and DRR pipe
554  * 2. Calculate the min and max vtotal which supports SubVP + DRR microschedule
555  * 3. Populate the drr_info with the min and max supported vtotal values
556  */
557 static void populate_subvp_cmd_drr_info(struct dc *dc,
558 		struct dc_state *context,
559 		struct pipe_ctx *subvp_pipe,
560 		struct pipe_ctx *vblank_pipe,
561 		struct dmub_cmd_fw_assisted_mclk_switch_pipe_data_v2 *pipe_data)
562 {
563 	struct dc_stream_state *phantom_stream = dc_state_get_paired_subvp_stream(context, subvp_pipe->stream);
564 	struct dc_crtc_timing *main_timing = &subvp_pipe->stream->timing;
565 	struct dc_crtc_timing *phantom_timing;
566 	struct dc_crtc_timing *drr_timing = &vblank_pipe->stream->timing;
567 	uint16_t drr_frame_us = 0;
568 	uint16_t min_drr_supported_us = 0;
569 	uint16_t max_drr_supported_us = 0;
570 	uint16_t max_drr_vblank_us = 0;
571 	uint16_t max_drr_mallregion_us = 0;
572 	uint16_t mall_region_us = 0;
573 	uint16_t prefetch_us = 0;
574 	uint16_t subvp_active_us = 0;
575 	uint16_t drr_active_us = 0;
576 	uint16_t min_vtotal_supported = 0;
577 	uint16_t max_vtotal_supported = 0;
578 
579 	if (!phantom_stream)
580 		return;
581 
582 	phantom_timing = &phantom_stream->timing;
583 
584 	pipe_data->pipe_config.vblank_data.drr_info.drr_in_use = true;
585 	pipe_data->pipe_config.vblank_data.drr_info.use_ramping = false; // for now don't use ramping
586 	pipe_data->pipe_config.vblank_data.drr_info.drr_window_size_ms = 4; // hardcode 4ms DRR window for now
587 
588 	drr_frame_us = div64_u64(((uint64_t)drr_timing->v_total * drr_timing->h_total * 1000000),
589 			(((uint64_t)drr_timing->pix_clk_100hz * 100)));
590 	// P-State allow width and FW delays already included phantom_timing->v_addressable
591 	mall_region_us = div64_u64(((uint64_t)phantom_timing->v_addressable * phantom_timing->h_total * 1000000),
592 			(((uint64_t)phantom_timing->pix_clk_100hz * 100)));
593 	min_drr_supported_us = drr_frame_us + mall_region_us + SUBVP_DRR_MARGIN_US;
594 	min_vtotal_supported = div64_u64(((uint64_t)drr_timing->pix_clk_100hz * 100 * min_drr_supported_us),
595 			(((uint64_t)drr_timing->h_total * 1000000)));
596 
597 	prefetch_us = div64_u64(((uint64_t)(phantom_timing->v_total - phantom_timing->v_front_porch) * phantom_timing->h_total * 1000000),
598 			(((uint64_t)phantom_timing->pix_clk_100hz * 100) + dc->caps.subvp_prefetch_end_to_mall_start_us));
599 	subvp_active_us = div64_u64(((uint64_t)main_timing->v_addressable * main_timing->h_total * 1000000),
600 			(((uint64_t)main_timing->pix_clk_100hz * 100)));
601 	drr_active_us = div64_u64(((uint64_t)drr_timing->v_addressable * drr_timing->h_total * 1000000),
602 			(((uint64_t)drr_timing->pix_clk_100hz * 100)));
603 	max_drr_vblank_us = div64_u64((subvp_active_us - prefetch_us -
604 			dc->caps.subvp_fw_processing_delay_us - drr_active_us), 2) + drr_active_us;
605 	max_drr_mallregion_us = subvp_active_us - prefetch_us - mall_region_us - dc->caps.subvp_fw_processing_delay_us;
606 	max_drr_supported_us = max_drr_vblank_us > max_drr_mallregion_us ? max_drr_vblank_us : max_drr_mallregion_us;
607 	max_vtotal_supported = div64_u64(((uint64_t)drr_timing->pix_clk_100hz * 100 * max_drr_supported_us),
608 			(((uint64_t)drr_timing->h_total * 1000000)));
609 
610 	/* When calculating the max vtotal supported for SubVP + DRR cases, add
611 	 * margin due to possible rounding errors (being off by 1 line in the
612 	 * FW calculation can incorrectly push the P-State switch to wait 1 frame
613 	 * longer).
614 	 */
615 	max_vtotal_supported = max_vtotal_supported - dc->caps.subvp_drr_max_vblank_margin_us;
616 
617 	pipe_data->pipe_config.vblank_data.drr_info.min_vtotal_supported = min_vtotal_supported;
618 	pipe_data->pipe_config.vblank_data.drr_info.max_vtotal_supported = max_vtotal_supported;
619 	pipe_data->pipe_config.vblank_data.drr_info.drr_vblank_start_margin = dc->caps.subvp_drr_vblank_start_margin_us;
620 }
621 
622 /**
623  * populate_subvp_cmd_vblank_pipe_info - Helper to populate VBLANK pipe info for the DMUB subvp command
624  *
625  * @dc: [in] current dc state
626  * @context: [in] new dc state
627  * @cmd: [in] DMUB cmd to be populated with SubVP info
628  * @vblank_pipe: [in] pipe_ctx for the VBLANK pipe
629  * @cmd_pipe_index: [in] index for the pipe array in DMCUB SubVP cmd
630  *
631  * Populate the DMCUB SubVP command with VBLANK pipe info. All the information
632  * required to calculate the microschedule for SubVP + VBLANK case is stored in
633  * the pipe_data (subvp_data and vblank_data).  Also check if the VBLANK pipe
634  * is a DRR display -- if it is make a call to populate drr_info.
635  */
636 static void populate_subvp_cmd_vblank_pipe_info(struct dc *dc,
637 		struct dc_state *context,
638 		union dmub_rb_cmd *cmd,
639 		struct pipe_ctx *vblank_pipe,
640 		uint8_t cmd_pipe_index)
641 {
642 	uint32_t i;
643 	struct pipe_ctx *pipe = NULL;
644 	struct dmub_cmd_fw_assisted_mclk_switch_pipe_data_v2 *pipe_data =
645 			&cmd->fw_assisted_mclk_switch_v2.config_data.pipe_data[cmd_pipe_index];
646 
647 	// Find the SubVP pipe
648 	for (i = 0; i < dc->res_pool->pipe_count; i++) {
649 		pipe = &context->res_ctx.pipe_ctx[i];
650 
651 		// We check for master pipe, but it shouldn't matter since we only need
652 		// the pipe for timing info (stream should be same for any pipe splits)
653 		if (!resource_is_pipe_type(pipe, OTG_MASTER) ||
654 				!resource_is_pipe_type(pipe, DPP_PIPE))
655 			continue;
656 
657 		// Find the SubVP pipe
658 		if (dc_state_get_pipe_subvp_type(context, pipe) == SUBVP_MAIN)
659 			break;
660 	}
661 
662 	pipe_data->mode = VBLANK;
663 	pipe_data->pipe_config.vblank_data.pix_clk_100hz = vblank_pipe->stream->timing.pix_clk_100hz;
664 	pipe_data->pipe_config.vblank_data.vblank_start = vblank_pipe->stream->timing.v_total -
665 							vblank_pipe->stream->timing.v_front_porch;
666 	pipe_data->pipe_config.vblank_data.vtotal = vblank_pipe->stream->timing.v_total;
667 	pipe_data->pipe_config.vblank_data.htotal = vblank_pipe->stream->timing.h_total;
668 	pipe_data->pipe_config.vblank_data.vblank_pipe_index = vblank_pipe->pipe_idx;
669 	pipe_data->pipe_config.vblank_data.vstartup_start = vblank_pipe->pipe_dlg_param.vstartup_start;
670 	pipe_data->pipe_config.vblank_data.vblank_end =
671 			vblank_pipe->stream->timing.v_total - vblank_pipe->stream->timing.v_front_porch - vblank_pipe->stream->timing.v_addressable;
672 
673 	if (vblank_pipe->stream->ignore_msa_timing_param &&
674 		(vblank_pipe->stream->allow_freesync || vblank_pipe->stream->vrr_active_variable || vblank_pipe->stream->vrr_active_fixed))
675 		populate_subvp_cmd_drr_info(dc, context, pipe, vblank_pipe, pipe_data);
676 }
677 
678 /**
679  * update_subvp_prefetch_end_to_mall_start - Helper for SubVP + SubVP case
680  *
681  * @dc: [in] current dc state
682  * @context: [in] new dc state
683  * @cmd: [in] DMUB cmd to be populated with SubVP info
684  * @subvp_pipes: [in] Array of SubVP pipes (should always be length 2)
685  *
686  * For SubVP + SubVP, we use a single vertical interrupt to start the
687  * microschedule for both SubVP pipes. In order for this to work correctly, the
688  * MALL REGION of both SubVP pipes must start at the same time. This function
689  * lengthens the prefetch end to mall start delay of the SubVP pipe that has
690  * the shorter prefetch so that both MALL REGION's will start at the same time.
691  */
692 static void update_subvp_prefetch_end_to_mall_start(struct dc *dc,
693 		struct dc_state *context,
694 		union dmub_rb_cmd *cmd,
695 		struct pipe_ctx *subvp_pipes[])
696 {
697 	uint32_t subvp0_prefetch_us = 0;
698 	uint32_t subvp1_prefetch_us = 0;
699 	uint32_t prefetch_delta_us = 0;
700 	struct dc_stream_state *phantom_stream0 = NULL;
701 	struct dc_stream_state *phantom_stream1 = NULL;
702 	struct dc_crtc_timing *phantom_timing0 = NULL;
703 	struct dc_crtc_timing *phantom_timing1 = NULL;
704 	struct dmub_cmd_fw_assisted_mclk_switch_pipe_data_v2 *pipe_data = NULL;
705 
706 	phantom_stream0 = dc_state_get_paired_subvp_stream(context, subvp_pipes[0]->stream);
707 	if (!phantom_stream0)
708 		return;
709 
710 	phantom_stream1 = dc_state_get_paired_subvp_stream(context, subvp_pipes[1]->stream);
711 	if (!phantom_stream1)
712 		return;
713 
714 	phantom_timing0 = &phantom_stream0->timing;
715 	phantom_timing1 = &phantom_stream1->timing;
716 
717 	subvp0_prefetch_us = div64_u64(((uint64_t)(phantom_timing0->v_total - phantom_timing0->v_front_porch) *
718 			(uint64_t)phantom_timing0->h_total * 1000000),
719 			(((uint64_t)phantom_timing0->pix_clk_100hz * 100) + dc->caps.subvp_prefetch_end_to_mall_start_us));
720 	subvp1_prefetch_us = div64_u64(((uint64_t)(phantom_timing1->v_total - phantom_timing1->v_front_porch) *
721 			(uint64_t)phantom_timing1->h_total * 1000000),
722 			(((uint64_t)phantom_timing1->pix_clk_100hz * 100) + dc->caps.subvp_prefetch_end_to_mall_start_us));
723 
724 	// Whichever SubVP PIPE has the smaller prefetch (including the prefetch end to mall start time)
725 	// should increase it's prefetch time to match the other
726 	if (subvp0_prefetch_us > subvp1_prefetch_us) {
727 		pipe_data = &cmd->fw_assisted_mclk_switch_v2.config_data.pipe_data[1];
728 		prefetch_delta_us = subvp0_prefetch_us - subvp1_prefetch_us;
729 		pipe_data->pipe_config.subvp_data.prefetch_to_mall_start_lines =
730 				div64_u64(((uint64_t)(dc->caps.subvp_prefetch_end_to_mall_start_us + prefetch_delta_us) *
731 					((uint64_t)phantom_timing1->pix_clk_100hz * 100) + ((uint64_t)phantom_timing1->h_total * 1000000 - 1)),
732 					((uint64_t)phantom_timing1->h_total * 1000000));
733 
734 	} else if (subvp1_prefetch_us >  subvp0_prefetch_us) {
735 		pipe_data = &cmd->fw_assisted_mclk_switch_v2.config_data.pipe_data[0];
736 		prefetch_delta_us = subvp1_prefetch_us - subvp0_prefetch_us;
737 		pipe_data->pipe_config.subvp_data.prefetch_to_mall_start_lines =
738 				div64_u64(((uint64_t)(dc->caps.subvp_prefetch_end_to_mall_start_us + prefetch_delta_us) *
739 					((uint64_t)phantom_timing0->pix_clk_100hz * 100) + ((uint64_t)phantom_timing0->h_total * 1000000 - 1)),
740 					((uint64_t)phantom_timing0->h_total * 1000000));
741 	}
742 }
743 
744 /**
745  * populate_subvp_cmd_pipe_info - Helper to populate the SubVP pipe info for the DMUB subvp command
746  *
747  * @dc: [in] current dc state
748  * @context: [in] new dc state
749  * @cmd: [in] DMUB cmd to be populated with SubVP info
750  * @subvp_pipe: [in] pipe_ctx for the SubVP pipe
751  * @cmd_pipe_index: [in] index for the pipe array in DMCUB SubVP cmd
752  *
753  * Populate the DMCUB SubVP command with SubVP pipe info. All the information
754  * required to calculate the microschedule for the SubVP pipe is stored in the
755  * pipe_data of the DMCUB SubVP command.
756  */
757 static void populate_subvp_cmd_pipe_info(struct dc *dc,
758 		struct dc_state *context,
759 		union dmub_rb_cmd *cmd,
760 		struct pipe_ctx *subvp_pipe,
761 		uint8_t cmd_pipe_index)
762 {
763 	uint32_t j;
764 	struct dmub_cmd_fw_assisted_mclk_switch_pipe_data_v2 *pipe_data =
765 			&cmd->fw_assisted_mclk_switch_v2.config_data.pipe_data[cmd_pipe_index];
766 	struct dc_stream_state *phantom_stream = dc_state_get_paired_subvp_stream(context, subvp_pipe->stream);
767 	struct dc_crtc_timing *main_timing = &subvp_pipe->stream->timing;
768 	struct dc_crtc_timing *phantom_timing;
769 	uint32_t out_num_stream, out_den_stream, out_num_plane, out_den_plane, out_num, out_den;
770 
771 	if (!phantom_stream)
772 		return;
773 
774 	phantom_timing = &phantom_stream->timing;
775 
776 	pipe_data->mode = SUBVP;
777 	pipe_data->pipe_config.subvp_data.pix_clk_100hz = subvp_pipe->stream->timing.pix_clk_100hz;
778 	pipe_data->pipe_config.subvp_data.htotal = subvp_pipe->stream->timing.h_total;
779 	pipe_data->pipe_config.subvp_data.vtotal = subvp_pipe->stream->timing.v_total;
780 	pipe_data->pipe_config.subvp_data.main_vblank_start =
781 			main_timing->v_total - main_timing->v_front_porch;
782 	pipe_data->pipe_config.subvp_data.main_vblank_end =
783 			main_timing->v_total - main_timing->v_front_porch - main_timing->v_addressable;
784 	pipe_data->pipe_config.subvp_data.mall_region_lines = phantom_timing->v_addressable;
785 	pipe_data->pipe_config.subvp_data.main_pipe_index = subvp_pipe->stream_res.tg->inst;
786 	pipe_data->pipe_config.subvp_data.is_drr = subvp_pipe->stream->ignore_msa_timing_param &&
787 		(subvp_pipe->stream->allow_freesync || subvp_pipe->stream->vrr_active_variable || subvp_pipe->stream->vrr_active_fixed);
788 
789 	/* Calculate the scaling factor from the src and dst height.
790 	 * e.g. If 3840x2160 being downscaled to 1920x1080, the scaling factor is 1/2.
791 	 * Reduce the fraction 1080/2160 = 1/2 for the "scaling factor"
792 	 *
793 	 * Make sure to combine stream and plane scaling together.
794 	 */
795 	reduce_fraction(subvp_pipe->stream->src.height, subvp_pipe->stream->dst.height,
796 			&out_num_stream, &out_den_stream);
797 	reduce_fraction(subvp_pipe->plane_state->src_rect.height, subvp_pipe->plane_state->dst_rect.height,
798 			&out_num_plane, &out_den_plane);
799 	reduce_fraction(out_num_stream * out_num_plane, out_den_stream * out_den_plane, &out_num, &out_den);
800 	pipe_data->pipe_config.subvp_data.scale_factor_numerator = out_num;
801 	pipe_data->pipe_config.subvp_data.scale_factor_denominator = out_den;
802 
803 	// Prefetch lines is equal to VACTIVE + BP + VSYNC
804 	pipe_data->pipe_config.subvp_data.prefetch_lines =
805 			phantom_timing->v_total - phantom_timing->v_front_porch;
806 
807 	// Round up
808 	pipe_data->pipe_config.subvp_data.prefetch_to_mall_start_lines =
809 			div64_u64(((uint64_t)dc->caps.subvp_prefetch_end_to_mall_start_us * ((uint64_t)phantom_timing->pix_clk_100hz * 100) +
810 					((uint64_t)phantom_timing->h_total * 1000000 - 1)), ((uint64_t)phantom_timing->h_total * 1000000));
811 	pipe_data->pipe_config.subvp_data.processing_delay_lines =
812 			div64_u64(((uint64_t)(dc->caps.subvp_fw_processing_delay_us) * ((uint64_t)phantom_timing->pix_clk_100hz * 100) +
813 					((uint64_t)phantom_timing->h_total * 1000000 - 1)), ((uint64_t)phantom_timing->h_total * 1000000));
814 
815 	if (subvp_pipe->bottom_pipe) {
816 		pipe_data->pipe_config.subvp_data.main_split_pipe_index = subvp_pipe->bottom_pipe->pipe_idx;
817 	} else if (subvp_pipe->next_odm_pipe) {
818 		pipe_data->pipe_config.subvp_data.main_split_pipe_index = subvp_pipe->next_odm_pipe->pipe_idx;
819 	} else {
820 		pipe_data->pipe_config.subvp_data.main_split_pipe_index = 0xF;
821 	}
822 
823 	// Find phantom pipe index based on phantom stream
824 	for (j = 0; j < dc->res_pool->pipe_count; j++) {
825 		struct pipe_ctx *phantom_pipe = &context->res_ctx.pipe_ctx[j];
826 
827 		if (resource_is_pipe_type(phantom_pipe, OTG_MASTER) &&
828 				phantom_pipe->stream == dc_state_get_paired_subvp_stream(context, subvp_pipe->stream)) {
829 			pipe_data->pipe_config.subvp_data.phantom_pipe_index = phantom_pipe->stream_res.tg->inst;
830 			if (phantom_pipe->bottom_pipe) {
831 				pipe_data->pipe_config.subvp_data.phantom_split_pipe_index = phantom_pipe->bottom_pipe->plane_res.hubp->inst;
832 			} else if (phantom_pipe->next_odm_pipe) {
833 				pipe_data->pipe_config.subvp_data.phantom_split_pipe_index = phantom_pipe->next_odm_pipe->plane_res.hubp->inst;
834 			} else {
835 				pipe_data->pipe_config.subvp_data.phantom_split_pipe_index = 0xF;
836 			}
837 			break;
838 		}
839 	}
840 }
841 
842 /**
843  * dc_dmub_setup_subvp_dmub_command - Populate the DMCUB SubVP command
844  *
845  * @dc: [in] current dc state
846  * @context: [in] new dc state
847  * @enable: [in] if true enables the pipes population
848  *
849  * This function loops through each pipe and populates the DMUB SubVP CMD info
850  * based on the pipe (e.g. SubVP, VBLANK).
851  */
852 void dc_dmub_setup_subvp_dmub_command(struct dc *dc,
853 		struct dc_state *context,
854 		bool enable)
855 {
856 	uint8_t cmd_pipe_index = 0;
857 	uint32_t i, pipe_idx;
858 	uint8_t subvp_count = 0;
859 	union dmub_rb_cmd cmd;
860 	struct pipe_ctx *subvp_pipes[2];
861 	uint32_t wm_val_refclk = 0;
862 	enum mall_stream_type pipe_mall_type;
863 
864 	memset(&cmd, 0, sizeof(cmd));
865 	// FW command for SUBVP
866 	cmd.fw_assisted_mclk_switch_v2.header.type = DMUB_CMD__FW_ASSISTED_MCLK_SWITCH;
867 	cmd.fw_assisted_mclk_switch_v2.header.sub_type = DMUB_CMD__HANDLE_SUBVP_CMD;
868 	cmd.fw_assisted_mclk_switch_v2.header.payload_bytes =
869 			sizeof(cmd.fw_assisted_mclk_switch_v2) - sizeof(cmd.fw_assisted_mclk_switch_v2.header);
870 
871 	for (i = 0; i < dc->res_pool->pipe_count; i++) {
872 		struct pipe_ctx *pipe = &context->res_ctx.pipe_ctx[i];
873 
874 		/* For SubVP pipe count, only count the top most (ODM / MPC) pipe
875 		 */
876 		if (resource_is_pipe_type(pipe, OTG_MASTER) &&
877 				resource_is_pipe_type(pipe, DPP_PIPE) &&
878 				dc_state_get_pipe_subvp_type(context, pipe) == SUBVP_MAIN)
879 			subvp_pipes[subvp_count++] = pipe;
880 	}
881 
882 	if (enable) {
883 		// For each pipe that is a "main" SUBVP pipe, fill in pipe data for DMUB SUBVP cmd
884 		for (i = 0, pipe_idx = 0; i < dc->res_pool->pipe_count; i++) {
885 			struct pipe_ctx *pipe = &context->res_ctx.pipe_ctx[i];
886 			pipe_mall_type = dc_state_get_pipe_subvp_type(context, pipe);
887 
888 			if (!pipe->stream)
889 				continue;
890 
891 			/* When populating subvp cmd info, only pass in the top most (ODM / MPC) pipe.
892 			 * Any ODM or MPC splits being used in SubVP will be handled internally in
893 			 * populate_subvp_cmd_pipe_info
894 			 */
895 			if (resource_is_pipe_type(pipe, OTG_MASTER) &&
896 					resource_is_pipe_type(pipe, DPP_PIPE) &&
897 					pipe_mall_type == SUBVP_MAIN) {
898 				populate_subvp_cmd_pipe_info(dc, context, &cmd, pipe, cmd_pipe_index++);
899 			} else if (resource_is_pipe_type(pipe, OTG_MASTER) &&
900 					resource_is_pipe_type(pipe, DPP_PIPE) &&
901 					pipe_mall_type == SUBVP_NONE) {
902 				// Don't need to check for ActiveDRAMClockChangeMargin < 0, not valid in cases where
903 				// we run through DML without calculating "natural" P-state support
904 				populate_subvp_cmd_vblank_pipe_info(dc, context, &cmd, pipe, cmd_pipe_index++);
905 
906 			}
907 			pipe_idx++;
908 		}
909 		if (subvp_count == 2) {
910 			update_subvp_prefetch_end_to_mall_start(dc, context, &cmd, subvp_pipes);
911 		}
912 		cmd.fw_assisted_mclk_switch_v2.config_data.pstate_allow_width_us = dc->caps.subvp_pstate_allow_width_us;
913 		cmd.fw_assisted_mclk_switch_v2.config_data.vertical_int_margin_us = dc->caps.subvp_vertical_int_margin_us;
914 
915 		// Store the original watermark value for this SubVP config so we can lower it when the
916 		// MCLK switch starts
917 		wm_val_refclk = context->bw_ctx.bw.dcn.watermarks.a.cstate_pstate.pstate_change_ns *
918 				(dc->res_pool->ref_clocks.dchub_ref_clock_inKhz / 1000) / 1000;
919 
920 		cmd.fw_assisted_mclk_switch_v2.config_data.watermark_a_cache = wm_val_refclk < 0xFFFF ? wm_val_refclk : 0xFFFF;
921 	}
922 
923 	dc_wake_and_execute_dmub_cmd(dc->ctx, &cmd, DM_DMUB_WAIT_TYPE_WAIT);
924 }
925 
926 bool dc_dmub_srv_get_diagnostic_data(struct dc_dmub_srv *dc_dmub_srv, struct dmub_diagnostic_data *diag_data)
927 {
928 	if (!dc_dmub_srv || !dc_dmub_srv->dmub || !diag_data)
929 		return false;
930 	return dmub_srv_get_diagnostic_data(dc_dmub_srv->dmub, diag_data);
931 }
932 
933 void dc_dmub_srv_log_diagnostic_data(struct dc_dmub_srv *dc_dmub_srv)
934 {
935 	struct dmub_diagnostic_data diag_data = {0};
936 	uint32_t i;
937 
938 	if (!dc_dmub_srv || !dc_dmub_srv->dmub) {
939 		DC_LOG_ERROR("%s: invalid parameters.", __func__);
940 		return;
941 	}
942 
943 	DC_LOG_ERROR("%s: DMCUB error - collecting diagnostic data\n", __func__);
944 
945 	if (!dc_dmub_srv_get_diagnostic_data(dc_dmub_srv, &diag_data)) {
946 		DC_LOG_ERROR("%s: dc_dmub_srv_get_diagnostic_data failed.", __func__);
947 		return;
948 	}
949 
950 	DC_LOG_DEBUG("DMCUB STATE:");
951 	DC_LOG_DEBUG("    dmcub_version      : %08x", diag_data.dmcub_version);
952 	DC_LOG_DEBUG("    scratch  [0]       : %08x", diag_data.scratch[0]);
953 	DC_LOG_DEBUG("    scratch  [1]       : %08x", diag_data.scratch[1]);
954 	DC_LOG_DEBUG("    scratch  [2]       : %08x", diag_data.scratch[2]);
955 	DC_LOG_DEBUG("    scratch  [3]       : %08x", diag_data.scratch[3]);
956 	DC_LOG_DEBUG("    scratch  [4]       : %08x", diag_data.scratch[4]);
957 	DC_LOG_DEBUG("    scratch  [5]       : %08x", diag_data.scratch[5]);
958 	DC_LOG_DEBUG("    scratch  [6]       : %08x", diag_data.scratch[6]);
959 	DC_LOG_DEBUG("    scratch  [7]       : %08x", diag_data.scratch[7]);
960 	DC_LOG_DEBUG("    scratch  [8]       : %08x", diag_data.scratch[8]);
961 	DC_LOG_DEBUG("    scratch  [9]       : %08x", diag_data.scratch[9]);
962 	DC_LOG_DEBUG("    scratch [10]       : %08x", diag_data.scratch[10]);
963 	DC_LOG_DEBUG("    scratch [11]       : %08x", diag_data.scratch[11]);
964 	DC_LOG_DEBUG("    scratch [12]       : %08x", diag_data.scratch[12]);
965 	DC_LOG_DEBUG("    scratch [13]       : %08x", diag_data.scratch[13]);
966 	DC_LOG_DEBUG("    scratch [14]       : %08x", diag_data.scratch[14]);
967 	DC_LOG_DEBUG("    scratch [15]       : %08x", diag_data.scratch[15]);
968 	for (i = 0; i < DMUB_PC_SNAPSHOT_COUNT; i++)
969 		DC_LOG_DEBUG("    pc[%d]             : %08x", i, diag_data.pc[i]);
970 	DC_LOG_DEBUG("    unk_fault_addr     : %08x", diag_data.undefined_address_fault_addr);
971 	DC_LOG_DEBUG("    inst_fault_addr    : %08x", diag_data.inst_fetch_fault_addr);
972 	DC_LOG_DEBUG("    data_fault_addr    : %08x", diag_data.data_write_fault_addr);
973 	DC_LOG_DEBUG("    inbox1_rptr        : %08x", diag_data.inbox1_rptr);
974 	DC_LOG_DEBUG("    inbox1_wptr        : %08x", diag_data.inbox1_wptr);
975 	DC_LOG_DEBUG("    inbox1_size        : %08x", diag_data.inbox1_size);
976 	DC_LOG_DEBUG("    inbox0_rptr        : %08x", diag_data.inbox0_rptr);
977 	DC_LOG_DEBUG("    inbox0_wptr        : %08x", diag_data.inbox0_wptr);
978 	DC_LOG_DEBUG("    inbox0_size        : %08x", diag_data.inbox0_size);
979 	DC_LOG_DEBUG("    is_enabled         : %d", diag_data.is_dmcub_enabled);
980 	DC_LOG_DEBUG("    is_soft_reset      : %d", diag_data.is_dmcub_soft_reset);
981 	DC_LOG_DEBUG("    is_secure_reset    : %d", diag_data.is_dmcub_secure_reset);
982 	DC_LOG_DEBUG("    is_traceport_en    : %d", diag_data.is_traceport_en);
983 	DC_LOG_DEBUG("    is_cw0_en          : %d", diag_data.is_cw0_enabled);
984 	DC_LOG_DEBUG("    is_cw6_en          : %d", diag_data.is_cw6_enabled);
985 }
986 
987 static bool dc_can_pipe_disable_cursor(struct pipe_ctx *pipe_ctx)
988 {
989 	struct pipe_ctx *test_pipe, *split_pipe;
990 	const struct scaler_data *scl_data = &pipe_ctx->plane_res.scl_data;
991 	struct rect r1 = scl_data->recout, r2, r2_half;
992 	int r1_r = r1.x + r1.width, r1_b = r1.y + r1.height, r2_r, r2_b;
993 	int cur_layer = pipe_ctx->plane_state->layer_index;
994 
995 	/**
996 	 * Disable the cursor if there's another pipe above this with a
997 	 * plane that contains this pipe's viewport to prevent double cursor
998 	 * and incorrect scaling artifacts.
999 	 */
1000 	for (test_pipe = pipe_ctx->top_pipe; test_pipe;
1001 	     test_pipe = test_pipe->top_pipe) {
1002 		// Skip invisible layer and pipe-split plane on same layer
1003 		if (!test_pipe->plane_state->visible || test_pipe->plane_state->layer_index == cur_layer)
1004 			continue;
1005 
1006 		r2 = test_pipe->plane_res.scl_data.recout;
1007 		r2_r = r2.x + r2.width;
1008 		r2_b = r2.y + r2.height;
1009 		split_pipe = test_pipe;
1010 
1011 		/**
1012 		 * There is another half plane on same layer because of
1013 		 * pipe-split, merge together per same height.
1014 		 */
1015 		for (split_pipe = pipe_ctx->top_pipe; split_pipe;
1016 		     split_pipe = split_pipe->top_pipe)
1017 			if (split_pipe->plane_state->layer_index == test_pipe->plane_state->layer_index) {
1018 				r2_half = split_pipe->plane_res.scl_data.recout;
1019 				r2.x = (r2_half.x < r2.x) ? r2_half.x : r2.x;
1020 				r2.width = r2.width + r2_half.width;
1021 				r2_r = r2.x + r2.width;
1022 				break;
1023 			}
1024 
1025 		if (r1.x >= r2.x && r1.y >= r2.y && r1_r <= r2_r && r1_b <= r2_b)
1026 			return true;
1027 	}
1028 
1029 	return false;
1030 }
1031 
1032 static bool dc_dmub_should_update_cursor_data(struct pipe_ctx *pipe_ctx)
1033 {
1034 	if (pipe_ctx->plane_state != NULL) {
1035 		if (pipe_ctx->plane_state->address.type == PLN_ADDR_TYPE_VIDEO_PROGRESSIVE)
1036 			return false;
1037 
1038 		if (dc_can_pipe_disable_cursor(pipe_ctx))
1039 			return false;
1040 	}
1041 
1042 	if ((pipe_ctx->stream->link->psr_settings.psr_version == DC_PSR_VERSION_SU_1 ||
1043 		pipe_ctx->stream->link->psr_settings.psr_version == DC_PSR_VERSION_1) &&
1044 		pipe_ctx->stream->ctx->dce_version >= DCN_VERSION_3_1)
1045 		return true;
1046 
1047 	if (pipe_ctx->stream->link->replay_settings.config.replay_supported)
1048 		return true;
1049 
1050 	return false;
1051 }
1052 
1053 static void dc_build_cursor_update_payload0(
1054 		struct pipe_ctx *pipe_ctx, uint8_t p_idx,
1055 		struct dmub_cmd_update_cursor_payload0 *payload)
1056 {
1057 	struct hubp *hubp = pipe_ctx->plane_res.hubp;
1058 	unsigned int panel_inst = 0;
1059 
1060 	if (!dc_get_edp_link_panel_inst(hubp->ctx->dc,
1061 		pipe_ctx->stream->link, &panel_inst))
1062 		return;
1063 
1064 	/* Payload: Cursor Rect is built from position & attribute
1065 	 * x & y are obtained from postion
1066 	 */
1067 	payload->cursor_rect.x = hubp->cur_rect.x;
1068 	payload->cursor_rect.y = hubp->cur_rect.y;
1069 	/* w & h are obtained from attribute */
1070 	payload->cursor_rect.width  = hubp->cur_rect.w;
1071 	payload->cursor_rect.height = hubp->cur_rect.h;
1072 
1073 	payload->enable      = hubp->pos.cur_ctl.bits.cur_enable;
1074 	payload->pipe_idx    = p_idx;
1075 	payload->cmd_version = DMUB_CMD_PSR_CONTROL_VERSION_1;
1076 	payload->panel_inst  = panel_inst;
1077 }
1078 
1079 static void dc_build_cursor_position_update_payload0(
1080 		struct dmub_cmd_update_cursor_payload0 *pl, const uint8_t p_idx,
1081 		const struct hubp *hubp, const struct dpp *dpp)
1082 {
1083 	/* Hubp */
1084 	pl->position_cfg.pHubp.cur_ctl.raw  = hubp->pos.cur_ctl.raw;
1085 	pl->position_cfg.pHubp.position.raw = hubp->pos.position.raw;
1086 	pl->position_cfg.pHubp.hot_spot.raw = hubp->pos.hot_spot.raw;
1087 	pl->position_cfg.pHubp.dst_offset.raw = hubp->pos.dst_offset.raw;
1088 
1089 	/* dpp */
1090 	pl->position_cfg.pDpp.cur0_ctl.raw = dpp->pos.cur0_ctl.raw;
1091 	pl->position_cfg.pipe_idx = p_idx;
1092 }
1093 
1094 static void dc_build_cursor_attribute_update_payload1(
1095 		struct dmub_cursor_attributes_cfg *pl_A, const uint8_t p_idx,
1096 		const struct hubp *hubp, const struct dpp *dpp)
1097 {
1098 	/* Hubp */
1099 	pl_A->aHubp.SURFACE_ADDR_HIGH = hubp->att.SURFACE_ADDR_HIGH;
1100 	pl_A->aHubp.SURFACE_ADDR = hubp->att.SURFACE_ADDR;
1101 	pl_A->aHubp.cur_ctl.raw  = hubp->att.cur_ctl.raw;
1102 	pl_A->aHubp.size.raw     = hubp->att.size.raw;
1103 	pl_A->aHubp.settings.raw = hubp->att.settings.raw;
1104 
1105 	/* dpp */
1106 	pl_A->aDpp.cur0_ctl.raw = dpp->att.cur0_ctl.raw;
1107 }
1108 
1109 /**
1110  * dc_send_update_cursor_info_to_dmu - Populate the DMCUB Cursor update info command
1111  *
1112  * @pCtx: [in] pipe context
1113  * @pipe_idx: [in] pipe index
1114  *
1115  * This function would store the cursor related information and pass it into
1116  * dmub
1117  */
1118 void dc_send_update_cursor_info_to_dmu(
1119 		struct pipe_ctx *pCtx, uint8_t pipe_idx)
1120 {
1121 	union dmub_rb_cmd cmd[2];
1122 	union dmub_cmd_update_cursor_info_data *update_cursor_info_0 =
1123 					&cmd[0].update_cursor_info.update_cursor_info_data;
1124 
1125 	memset(cmd, 0, sizeof(cmd));
1126 
1127 	if (!dc_dmub_should_update_cursor_data(pCtx))
1128 		return;
1129 	/*
1130 	 * Since we use multi_cmd_pending for dmub command, the 2nd command is
1131 	 * only assigned to store cursor attributes info.
1132 	 * 1st command can view as 2 parts, 1st is for PSR/Replay data, the other
1133 	 * is to store cursor position info.
1134 	 *
1135 	 * Command heaer type must be the same type if using  multi_cmd_pending.
1136 	 * Besides, while process 2nd command in DMU, the sub type is useless.
1137 	 * So it's meanless to pass the sub type header with different type.
1138 	 */
1139 
1140 	{
1141 		/* Build Payload#0 Header */
1142 		cmd[0].update_cursor_info.header.type = DMUB_CMD__UPDATE_CURSOR_INFO;
1143 		cmd[0].update_cursor_info.header.payload_bytes =
1144 				sizeof(cmd[0].update_cursor_info.update_cursor_info_data);
1145 		cmd[0].update_cursor_info.header.multi_cmd_pending = 1; //To combine multi dmu cmd, 1st cmd
1146 
1147 		/* Prepare Payload */
1148 		dc_build_cursor_update_payload0(pCtx, pipe_idx, &update_cursor_info_0->payload0);
1149 
1150 		dc_build_cursor_position_update_payload0(&update_cursor_info_0->payload0, pipe_idx,
1151 				pCtx->plane_res.hubp, pCtx->plane_res.dpp);
1152 		}
1153 	{
1154 		/* Build Payload#1 Header */
1155 		cmd[1].update_cursor_info.header.type = DMUB_CMD__UPDATE_CURSOR_INFO;
1156 		cmd[1].update_cursor_info.header.payload_bytes = sizeof(struct cursor_attributes_cfg);
1157 		cmd[1].update_cursor_info.header.multi_cmd_pending = 0; //Indicate it's the last command.
1158 
1159 		dc_build_cursor_attribute_update_payload1(
1160 				&cmd[1].update_cursor_info.update_cursor_info_data.payload1.attribute_cfg,
1161 				pipe_idx, pCtx->plane_res.hubp, pCtx->plane_res.dpp);
1162 
1163 		/* Combine 2nd cmds update_curosr_info to DMU */
1164 		dc_wake_and_execute_dmub_cmd_list(pCtx->stream->ctx, 2, cmd, DM_DMUB_WAIT_TYPE_WAIT);
1165 	}
1166 }
1167 
1168 bool dc_dmub_check_min_version(struct dmub_srv *srv)
1169 {
1170 	if (!srv->hw_funcs.is_psrsu_supported)
1171 		return true;
1172 	return srv->hw_funcs.is_psrsu_supported(srv);
1173 }
1174 
1175 void dc_dmub_srv_enable_dpia_trace(const struct dc *dc)
1176 {
1177 	struct dc_dmub_srv *dc_dmub_srv = dc->ctx->dmub_srv;
1178 
1179 	if (!dc_dmub_srv || !dc_dmub_srv->dmub) {
1180 		DC_LOG_ERROR("%s: invalid parameters.", __func__);
1181 		return;
1182 	}
1183 
1184 	if (!dc_wake_and_execute_gpint(dc->ctx, DMUB_GPINT__SET_TRACE_BUFFER_MASK_WORD1,
1185 				       0x0010, NULL, DM_DMUB_WAIT_TYPE_WAIT)) {
1186 		DC_LOG_ERROR("timeout updating trace buffer mask word\n");
1187 		return;
1188 	}
1189 
1190 	if (!dc_wake_and_execute_gpint(dc->ctx, DMUB_GPINT__UPDATE_TRACE_BUFFER_MASK,
1191 				       0x0000, NULL, DM_DMUB_WAIT_TYPE_WAIT)) {
1192 		DC_LOG_ERROR("timeout updating trace buffer mask word\n");
1193 		return;
1194 	}
1195 
1196 	DC_LOG_DEBUG("Enabled DPIA trace\n");
1197 }
1198 
1199 void dc_dmub_srv_subvp_save_surf_addr(const struct dc_dmub_srv *dc_dmub_srv, const struct dc_plane_address *addr, uint8_t subvp_index)
1200 {
1201 	dmub_srv_subvp_save_surf_addr(dc_dmub_srv->dmub, addr, subvp_index);
1202 }
1203 
1204 bool dc_dmub_srv_is_hw_pwr_up(struct dc_dmub_srv *dc_dmub_srv, bool wait)
1205 {
1206 	struct dc_context *dc_ctx;
1207 	enum dmub_status status;
1208 
1209 	if (!dc_dmub_srv || !dc_dmub_srv->dmub)
1210 		return true;
1211 
1212 	if (dc_dmub_srv->ctx->dc->debug.dmcub_emulation)
1213 		return true;
1214 
1215 	dc_ctx = dc_dmub_srv->ctx;
1216 
1217 	if (wait) {
1218 		if (dc_dmub_srv->ctx->dc->debug.disable_timeout) {
1219 			do {
1220 				status = dmub_srv_wait_for_hw_pwr_up(dc_dmub_srv->dmub, 500000);
1221 			} while (status != DMUB_STATUS_OK);
1222 		} else {
1223 			status = dmub_srv_wait_for_hw_pwr_up(dc_dmub_srv->dmub, 500000);
1224 			if (status != DMUB_STATUS_OK) {
1225 				DC_ERROR("Error querying DMUB hw power up status: error=%d\n", status);
1226 				return false;
1227 			}
1228 		}
1229 	} else
1230 		return dmub_srv_is_hw_pwr_up(dc_dmub_srv->dmub);
1231 
1232 	return true;
1233 }
1234 
1235 static int count_active_streams(const struct dc *dc)
1236 {
1237 	int i, count = 0;
1238 
1239 	for (i = 0; i < dc->current_state->stream_count; ++i) {
1240 		struct dc_stream_state *stream = dc->current_state->streams[i];
1241 
1242 		if (stream && !stream->dpms_off)
1243 			count += 1;
1244 	}
1245 
1246 	return count;
1247 }
1248 
1249 static void dc_dmub_srv_notify_idle(const struct dc *dc, bool allow_idle)
1250 {
1251 	volatile const struct dmub_shared_state_ips_fw *ips_fw;
1252 	struct dc_dmub_srv *dc_dmub_srv;
1253 	union dmub_rb_cmd cmd = {0};
1254 
1255 	if (dc->debug.dmcub_emulation)
1256 		return;
1257 
1258 	if (!dc->ctx->dmub_srv || !dc->ctx->dmub_srv->dmub)
1259 		return;
1260 
1261 	dc_dmub_srv = dc->ctx->dmub_srv;
1262 	ips_fw = &dc_dmub_srv->dmub->shared_state[DMUB_SHARED_SHARE_FEATURE__IPS_FW].data.ips_fw;
1263 
1264 	memset(&cmd, 0, sizeof(cmd));
1265 	cmd.idle_opt_notify_idle.header.type = DMUB_CMD__IDLE_OPT;
1266 	cmd.idle_opt_notify_idle.header.sub_type = DMUB_CMD__IDLE_OPT_DCN_NOTIFY_IDLE;
1267 	cmd.idle_opt_notify_idle.header.payload_bytes =
1268 		sizeof(cmd.idle_opt_notify_idle) -
1269 		sizeof(cmd.idle_opt_notify_idle.header);
1270 
1271 	cmd.idle_opt_notify_idle.cntl_data.driver_idle = allow_idle;
1272 
1273 	if (dc->work_arounds.skip_psr_ips_crtc_disable)
1274 		cmd.idle_opt_notify_idle.cntl_data.skip_otg_disable = true;
1275 
1276 	if (allow_idle) {
1277 		volatile struct dmub_shared_state_ips_driver *ips_driver =
1278 			&dc_dmub_srv->dmub->shared_state[DMUB_SHARED_SHARE_FEATURE__IPS_DRIVER].data.ips_driver;
1279 		union dmub_shared_state_ips_driver_signals new_signals;
1280 
1281 		DC_LOG_IPS(
1282 			"%s wait idle (ips1_commit=%d ips2_commit=%d)",
1283 			__func__,
1284 			ips_fw->signals.bits.ips1_commit,
1285 			ips_fw->signals.bits.ips2_commit);
1286 
1287 		dc_dmub_srv_wait_idle(dc->ctx->dmub_srv);
1288 
1289 		memset(&new_signals, 0, sizeof(new_signals));
1290 
1291 		if (dc->config.disable_ips == DMUB_IPS_ENABLE ||
1292 		    dc->config.disable_ips == DMUB_IPS_DISABLE_DYNAMIC) {
1293 			new_signals.bits.allow_pg = 1;
1294 			new_signals.bits.allow_ips1 = 1;
1295 			new_signals.bits.allow_ips2 = 1;
1296 			new_signals.bits.allow_z10 = 1;
1297 		} else if (dc->config.disable_ips == DMUB_IPS_DISABLE_IPS1) {
1298 			new_signals.bits.allow_ips1 = 1;
1299 		} else if (dc->config.disable_ips == DMUB_IPS_DISABLE_IPS2) {
1300 			new_signals.bits.allow_pg = 1;
1301 			new_signals.bits.allow_ips1 = 1;
1302 		} else if (dc->config.disable_ips == DMUB_IPS_DISABLE_IPS2_Z10) {
1303 			new_signals.bits.allow_pg = 1;
1304 			new_signals.bits.allow_ips1 = 1;
1305 			new_signals.bits.allow_ips2 = 1;
1306 		} else if (dc->config.disable_ips == DMUB_IPS_RCG_IN_ACTIVE_IPS2_IN_OFF) {
1307 			/* TODO: Move this logic out to hwseq */
1308 			if (count_active_streams(dc) == 0) {
1309 				/* IPS2 - Display off */
1310 				new_signals.bits.allow_pg = 1;
1311 				new_signals.bits.allow_ips1 = 1;
1312 				new_signals.bits.allow_ips2 = 1;
1313 				new_signals.bits.allow_z10 = 1;
1314 			} else {
1315 				/* RCG only */
1316 				new_signals.bits.allow_pg = 0;
1317 				new_signals.bits.allow_ips1 = 1;
1318 				new_signals.bits.allow_ips2 = 0;
1319 				new_signals.bits.allow_z10 = 0;
1320 			}
1321 		}
1322 
1323 		ips_driver->signals = new_signals;
1324 		dc_dmub_srv->driver_signals = ips_driver->signals;
1325 	}
1326 
1327 	DC_LOG_IPS(
1328 		"%s send allow_idle=%d (ips1_commit=%d ips2_commit=%d)",
1329 		__func__,
1330 		allow_idle,
1331 		ips_fw->signals.bits.ips1_commit,
1332 		ips_fw->signals.bits.ips2_commit);
1333 
1334 	/* NOTE: This does not use the "wake" interface since this is part of the wake path. */
1335 	/* We also do not perform a wait since DMCUB could enter idle after the notification. */
1336 	dm_execute_dmub_cmd(dc->ctx, &cmd, allow_idle ? DM_DMUB_WAIT_TYPE_NO_WAIT : DM_DMUB_WAIT_TYPE_WAIT);
1337 
1338 	/* Register access should stop at this point. */
1339 	if (allow_idle)
1340 		dc_dmub_srv->needs_idle_wake = true;
1341 }
1342 
1343 static void dc_dmub_srv_exit_low_power_state(const struct dc *dc)
1344 {
1345 	struct dc_dmub_srv *dc_dmub_srv;
1346 	uint32_t rcg_exit_count = 0, ips1_exit_count = 0, ips2_exit_count = 0;
1347 
1348 	if (dc->debug.dmcub_emulation)
1349 		return;
1350 
1351 	if (!dc->ctx->dmub_srv || !dc->ctx->dmub_srv->dmub)
1352 		return;
1353 
1354 	dc_dmub_srv = dc->ctx->dmub_srv;
1355 
1356 	if (dc->clk_mgr->funcs->exit_low_power_state) {
1357 		volatile const struct dmub_shared_state_ips_fw *ips_fw =
1358 			&dc_dmub_srv->dmub->shared_state[DMUB_SHARED_SHARE_FEATURE__IPS_FW].data.ips_fw;
1359 		volatile struct dmub_shared_state_ips_driver *ips_driver =
1360 			&dc_dmub_srv->dmub->shared_state[DMUB_SHARED_SHARE_FEATURE__IPS_DRIVER].data.ips_driver;
1361 		union dmub_shared_state_ips_driver_signals prev_driver_signals = ips_driver->signals;
1362 
1363 		rcg_exit_count = ips_fw->rcg_exit_count;
1364 		ips1_exit_count = ips_fw->ips1_exit_count;
1365 		ips2_exit_count = ips_fw->ips2_exit_count;
1366 
1367 		ips_driver->signals.all = 0;
1368 		dc_dmub_srv->driver_signals = ips_driver->signals;
1369 
1370 		DC_LOG_IPS(
1371 			"%s (allow ips1=%d ips2=%d) (commit ips1=%d ips2=%d) (count rcg=%d ips1=%d ips2=%d)",
1372 			__func__,
1373 			ips_driver->signals.bits.allow_ips1,
1374 			ips_driver->signals.bits.allow_ips2,
1375 			ips_fw->signals.bits.ips1_commit,
1376 			ips_fw->signals.bits.ips2_commit,
1377 			ips_fw->rcg_entry_count,
1378 			ips_fw->ips1_entry_count,
1379 			ips_fw->ips2_entry_count);
1380 
1381 		/* Note: register access has technically not resumed for DCN here, but we
1382 		 * need to be message PMFW through our standard register interface.
1383 		 */
1384 		dc_dmub_srv->needs_idle_wake = false;
1385 
1386 		if (prev_driver_signals.bits.allow_ips2 &&
1387 		    (!dc->debug.optimize_ips_handshake ||
1388 		     ips_fw->signals.bits.ips2_commit || !ips_fw->signals.bits.in_idle)) {
1389 			DC_LOG_IPS(
1390 				"wait IPS2 eval (ips1_commit=%d ips2_commit=%d)",
1391 				ips_fw->signals.bits.ips1_commit,
1392 				ips_fw->signals.bits.ips2_commit);
1393 
1394 			if (!dc->debug.optimize_ips_handshake || !ips_fw->signals.bits.ips2_commit)
1395 				udelay(dc->debug.ips2_eval_delay_us);
1396 
1397 			if (ips_fw->signals.bits.ips2_commit) {
1398 				DC_LOG_IPS(
1399 					"exit IPS2 #1 (ips1_commit=%d ips2_commit=%d)",
1400 					ips_fw->signals.bits.ips1_commit,
1401 					ips_fw->signals.bits.ips2_commit);
1402 
1403 				// Tell PMFW to exit low power state
1404 				dc->clk_mgr->funcs->exit_low_power_state(dc->clk_mgr);
1405 
1406 				DC_LOG_IPS(
1407 					"wait IPS2 entry delay (ips1_commit=%d ips2_commit=%d)",
1408 					ips_fw->signals.bits.ips1_commit,
1409 					ips_fw->signals.bits.ips2_commit);
1410 
1411 				// Wait for IPS2 entry upper bound
1412 				udelay(dc->debug.ips2_entry_delay_us);
1413 
1414 				DC_LOG_IPS(
1415 					"exit IPS2 #2 (ips1_commit=%d ips2_commit=%d)",
1416 					ips_fw->signals.bits.ips1_commit,
1417 					ips_fw->signals.bits.ips2_commit);
1418 
1419 				dc->clk_mgr->funcs->exit_low_power_state(dc->clk_mgr);
1420 
1421 				DC_LOG_IPS(
1422 					"wait IPS2 commit clear (ips1_commit=%d ips2_commit=%d)",
1423 					ips_fw->signals.bits.ips1_commit,
1424 					ips_fw->signals.bits.ips2_commit);
1425 
1426 				while (ips_fw->signals.bits.ips2_commit)
1427 					udelay(1);
1428 
1429 				DC_LOG_IPS(
1430 					"wait hw_pwr_up (ips1_commit=%d ips2_commit=%d)",
1431 					ips_fw->signals.bits.ips1_commit,
1432 					ips_fw->signals.bits.ips2_commit);
1433 
1434 				if (!dc_dmub_srv_is_hw_pwr_up(dc->ctx->dmub_srv, true))
1435 					ASSERT(0);
1436 
1437 				DC_LOG_IPS(
1438 					"resync inbox1 (ips1_commit=%d ips2_commit=%d)",
1439 					ips_fw->signals.bits.ips1_commit,
1440 					ips_fw->signals.bits.ips2_commit);
1441 
1442 				dmub_srv_sync_inbox1(dc->ctx->dmub_srv->dmub);
1443 			}
1444 		}
1445 
1446 		dc_dmub_srv_notify_idle(dc, false);
1447 		if (prev_driver_signals.bits.allow_ips1) {
1448 			DC_LOG_IPS(
1449 				"wait for IPS1 commit clear (ips1_commit=%d ips2_commit=%d)",
1450 				ips_fw->signals.bits.ips1_commit,
1451 				ips_fw->signals.bits.ips2_commit);
1452 
1453 			while (ips_fw->signals.bits.ips1_commit)
1454 				udelay(1);
1455 
1456 			DC_LOG_IPS(
1457 				"wait for IPS1 commit clear done (ips1_commit=%d ips2_commit=%d)",
1458 				ips_fw->signals.bits.ips1_commit,
1459 				ips_fw->signals.bits.ips2_commit);
1460 		}
1461 	}
1462 
1463 	if (!dc_dmub_srv_is_hw_pwr_up(dc->ctx->dmub_srv, true))
1464 		ASSERT(0);
1465 
1466 	DC_LOG_IPS("%s exit (count rcg=%d ips1=%d ips2=%d)",
1467 		__func__,
1468 		rcg_exit_count,
1469 		ips1_exit_count,
1470 		ips2_exit_count);
1471 }
1472 
1473 void dc_dmub_srv_set_power_state(struct dc_dmub_srv *dc_dmub_srv, enum dc_acpi_cm_power_state powerState)
1474 {
1475 	struct dmub_srv *dmub;
1476 
1477 	if (!dc_dmub_srv)
1478 		return;
1479 
1480 	dmub = dc_dmub_srv->dmub;
1481 
1482 	if (powerState == DC_ACPI_CM_POWER_STATE_D0)
1483 		dmub_srv_set_power_state(dmub, DMUB_POWER_STATE_D0);
1484 	else
1485 		dmub_srv_set_power_state(dmub, DMUB_POWER_STATE_D3);
1486 }
1487 
1488 bool dc_dmub_srv_should_detect(struct dc_dmub_srv *dc_dmub_srv)
1489 {
1490 	volatile const struct dmub_shared_state_ips_fw *ips_fw;
1491 	bool reallow_idle = false, should_detect = false;
1492 
1493 	if (!dc_dmub_srv || !dc_dmub_srv->dmub)
1494 		return false;
1495 
1496 	if (dc_dmub_srv->dmub->shared_state &&
1497 	    dc_dmub_srv->dmub->meta_info.feature_bits.bits.shared_state_link_detection) {
1498 		ips_fw = &dc_dmub_srv->dmub->shared_state[DMUB_SHARED_SHARE_FEATURE__IPS_FW].data.ips_fw;
1499 		return ips_fw->signals.bits.detection_required;
1500 	}
1501 
1502 	/* Detection may require reading scratch 0 - exit out of idle prior to the read. */
1503 	if (dc_dmub_srv->idle_allowed) {
1504 		dc_dmub_srv_apply_idle_power_optimizations(dc_dmub_srv->ctx->dc, false);
1505 		reallow_idle = true;
1506 	}
1507 
1508 	should_detect = dmub_srv_should_detect(dc_dmub_srv->dmub);
1509 
1510 	/* Re-enter idle if we're not about to immediately redetect links. */
1511 	if (!should_detect && reallow_idle && dc_dmub_srv->idle_exit_counter == 0 &&
1512 	    !dc_dmub_srv->ctx->dc->debug.disable_dmub_reallow_idle)
1513 		dc_dmub_srv_apply_idle_power_optimizations(dc_dmub_srv->ctx->dc, true);
1514 
1515 	return should_detect;
1516 }
1517 
1518 void dc_dmub_srv_apply_idle_power_optimizations(const struct dc *dc, bool allow_idle)
1519 {
1520 	struct dc_dmub_srv *dc_dmub_srv = dc->ctx->dmub_srv;
1521 
1522 	if (!dc_dmub_srv || !dc_dmub_srv->dmub)
1523 		return;
1524 
1525 	allow_idle &= (!dc->debug.ips_disallow_entry);
1526 
1527 	if (dc_dmub_srv->idle_allowed == allow_idle)
1528 		return;
1529 
1530 	DC_LOG_IPS("%s state change: old=%d new=%d", __func__, dc_dmub_srv->idle_allowed, allow_idle);
1531 
1532 	/*
1533 	 * Entering a low power state requires a driver notification.
1534 	 * Powering up the hardware requires notifying PMFW and DMCUB.
1535 	 * Clearing the driver idle allow requires a DMCUB command.
1536 	 * DMCUB commands requires the DMCUB to be powered up and restored.
1537 	 */
1538 
1539 	if (!allow_idle) {
1540 		dc_dmub_srv->idle_exit_counter += 1;
1541 
1542 		dc_dmub_srv_exit_low_power_state(dc);
1543 		/*
1544 		 * Idle is considered fully exited only after the sequence above
1545 		 * fully completes. If we have a race of two threads exiting
1546 		 * at the same time then it's safe to perform the sequence
1547 		 * twice as long as we're not re-entering.
1548 		 *
1549 		 * Infinite command submission is avoided by using the
1550 		 * dm_execute_dmub_cmd submission instead of the "wake" helpers.
1551 		 */
1552 		dc_dmub_srv->idle_allowed = false;
1553 
1554 		dc_dmub_srv->idle_exit_counter -= 1;
1555 		if (dc_dmub_srv->idle_exit_counter < 0) {
1556 			ASSERT(0);
1557 			dc_dmub_srv->idle_exit_counter = 0;
1558 		}
1559 	} else {
1560 		/* Consider idle as notified prior to the actual submission to
1561 		 * prevent multiple entries. */
1562 		dc_dmub_srv->idle_allowed = true;
1563 
1564 		dc_dmub_srv_notify_idle(dc, allow_idle);
1565 	}
1566 }
1567 
1568 bool dc_wake_and_execute_dmub_cmd(const struct dc_context *ctx, union dmub_rb_cmd *cmd,
1569 				  enum dm_dmub_wait_type wait_type)
1570 {
1571 	return dc_wake_and_execute_dmub_cmd_list(ctx, 1, cmd, wait_type);
1572 }
1573 
1574 bool dc_wake_and_execute_dmub_cmd_list(const struct dc_context *ctx, unsigned int count,
1575 				       union dmub_rb_cmd *cmd, enum dm_dmub_wait_type wait_type)
1576 {
1577 	struct dc_dmub_srv *dc_dmub_srv = ctx->dmub_srv;
1578 	bool result = false, reallow_idle = false;
1579 
1580 	if (!dc_dmub_srv || !dc_dmub_srv->dmub)
1581 		return false;
1582 
1583 	if (count == 0)
1584 		return true;
1585 
1586 	if (dc_dmub_srv->idle_allowed) {
1587 		dc_dmub_srv_apply_idle_power_optimizations(ctx->dc, false);
1588 		reallow_idle = true;
1589 	}
1590 
1591 	/*
1592 	 * These may have different implementations in DM, so ensure
1593 	 * that we guide it to the expected helper.
1594 	 */
1595 	if (count > 1)
1596 		result = dm_execute_dmub_cmd_list(ctx, count, cmd, wait_type);
1597 	else
1598 		result = dm_execute_dmub_cmd(ctx, cmd, wait_type);
1599 
1600 	if (result && reallow_idle && dc_dmub_srv->idle_exit_counter == 0 &&
1601 	    !ctx->dc->debug.disable_dmub_reallow_idle)
1602 		dc_dmub_srv_apply_idle_power_optimizations(ctx->dc, true);
1603 
1604 	return result;
1605 }
1606 
1607 static bool dc_dmub_execute_gpint(const struct dc_context *ctx, enum dmub_gpint_command command_code,
1608 				  uint16_t param, uint32_t *response, enum dm_dmub_wait_type wait_type)
1609 {
1610 	struct dc_dmub_srv *dc_dmub_srv = ctx->dmub_srv;
1611 	const uint32_t wait_us = wait_type == DM_DMUB_WAIT_TYPE_NO_WAIT ? 0 : 30;
1612 	enum dmub_status status;
1613 
1614 	if (response)
1615 		*response = 0;
1616 
1617 	if (!dc_dmub_srv || !dc_dmub_srv->dmub)
1618 		return false;
1619 
1620 	status = dmub_srv_send_gpint_command(dc_dmub_srv->dmub, command_code, param, wait_us);
1621 	if (status != DMUB_STATUS_OK) {
1622 		if (status == DMUB_STATUS_TIMEOUT && wait_type == DM_DMUB_WAIT_TYPE_NO_WAIT)
1623 			return true;
1624 
1625 		return false;
1626 	}
1627 
1628 	if (response && wait_type == DM_DMUB_WAIT_TYPE_WAIT_WITH_REPLY)
1629 		dmub_srv_get_gpint_response(dc_dmub_srv->dmub, response);
1630 
1631 	return true;
1632 }
1633 
1634 bool dc_wake_and_execute_gpint(const struct dc_context *ctx, enum dmub_gpint_command command_code,
1635 			       uint16_t param, uint32_t *response, enum dm_dmub_wait_type wait_type)
1636 {
1637 	struct dc_dmub_srv *dc_dmub_srv = ctx->dmub_srv;
1638 	bool result = false, reallow_idle = false;
1639 
1640 	if (!dc_dmub_srv || !dc_dmub_srv->dmub)
1641 		return false;
1642 
1643 	if (dc_dmub_srv->idle_allowed) {
1644 		dc_dmub_srv_apply_idle_power_optimizations(ctx->dc, false);
1645 		reallow_idle = true;
1646 	}
1647 
1648 	result = dc_dmub_execute_gpint(ctx, command_code, param, response, wait_type);
1649 
1650 	if (result && reallow_idle && dc_dmub_srv->idle_exit_counter == 0 &&
1651 	    !ctx->dc->debug.disable_dmub_reallow_idle)
1652 		dc_dmub_srv_apply_idle_power_optimizations(ctx->dc, true);
1653 
1654 	return result;
1655 }
1656 
1657 void dc_dmub_srv_fams2_update_config(struct dc *dc,
1658 		struct dc_state *context,
1659 		bool enable)
1660 {
1661 	uint8_t num_cmds = 1;
1662 	uint32_t i;
1663 	union dmub_rb_cmd cmd[MAX_STREAMS + 1];
1664 	struct dmub_rb_cmd_fams2 *global_cmd = &cmd[0].fams2_config;
1665 
1666 	memset(cmd, 0, sizeof(union dmub_rb_cmd) * (MAX_STREAMS + 1));
1667 	/* fill in generic command header */
1668 	global_cmd->header.type = DMUB_CMD__FW_ASSISTED_MCLK_SWITCH;
1669 	global_cmd->header.sub_type = DMUB_CMD__FAMS2_CONFIG;
1670 	global_cmd->header.payload_bytes = sizeof(struct dmub_rb_cmd_fams2) - sizeof(struct dmub_cmd_header);
1671 
1672 	/* send global configuration parameters */
1673 	global_cmd->config.global.max_allow_delay_us = 100 * 1000; //100ms
1674 	global_cmd->config.global.lock_wait_time_us = 5000; //5ms
1675 	global_cmd->config.global.recovery_timeout_us = 5000; //5ms
1676 	global_cmd->config.global.hwfq_flip_programming_delay_us = 100; //100us
1677 
1678 	/* copy static feature configuration */
1679 	global_cmd->config.global.features.all = dc->debug.fams2_config.all;
1680 
1681 	/* apply feature configuration based on current driver state */
1682 	global_cmd->config.global.features.bits.enable_visual_confirm = dc->debug.visual_confirm == VISUAL_CONFIRM_FAMS2;
1683 	global_cmd->config.global.features.bits.enable = enable;
1684 
1685 	/* construct per-stream configs */
1686 	if (enable) {
1687 		for (i = 0; i < context->bw_ctx.bw.dcn.fams2_stream_count; i++) {
1688 			struct dmub_rb_cmd_fams2 *stream_cmd = &cmd[i+1].fams2_config;
1689 
1690 			/* configure command header */
1691 			stream_cmd->header.type = DMUB_CMD__FW_ASSISTED_MCLK_SWITCH;
1692 			stream_cmd->header.sub_type = DMUB_CMD__FAMS2_CONFIG;
1693 			stream_cmd->header.payload_bytes = sizeof(struct dmub_rb_cmd_fams2) - sizeof(struct dmub_cmd_header);
1694 			stream_cmd->header.multi_cmd_pending = 1;
1695 			/* copy stream static state */
1696 			memcpy(&stream_cmd->config.stream,
1697 					&context->bw_ctx.bw.dcn.fams2_stream_params[i],
1698 					sizeof(struct dmub_fams2_stream_static_state));
1699 		}
1700 	}
1701 
1702 	if (enable && context->bw_ctx.bw.dcn.fams2_stream_count) {
1703 		/* set multi pending for global, and unset for last stream cmd */
1704 		global_cmd->config.global.num_streams = context->bw_ctx.bw.dcn.fams2_stream_count;
1705 		global_cmd->header.multi_cmd_pending = 1;
1706 		cmd[context->bw_ctx.bw.dcn.fams2_stream_count].fams2_config.header.multi_cmd_pending = 0;
1707 		num_cmds += context->bw_ctx.bw.dcn.fams2_stream_count;
1708 	}
1709 
1710 	dm_execute_dmub_cmd_list(dc->ctx, num_cmds, cmd, DM_DMUB_WAIT_TYPE_WAIT);
1711 }
1712 
1713 void dc_dmub_srv_fams2_drr_update(struct dc *dc,
1714 		uint32_t tg_inst,
1715 		uint32_t vtotal_min,
1716 		uint32_t vtotal_max,
1717 		uint32_t vtotal_mid,
1718 		uint32_t vtotal_mid_frame_num,
1719 		bool program_manual_trigger)
1720 {
1721 	union dmub_rb_cmd cmd = { 0 };
1722 
1723 	cmd.fams2_drr_update.header.type = DMUB_CMD__FW_ASSISTED_MCLK_SWITCH;
1724 	cmd.fams2_drr_update.header.sub_type = DMUB_CMD__FAMS2_DRR_UPDATE;
1725 	cmd.fams2_drr_update.dmub_optc_state_req.tg_inst = tg_inst;
1726 	cmd.fams2_drr_update.dmub_optc_state_req.v_total_max = vtotal_max;
1727 	cmd.fams2_drr_update.dmub_optc_state_req.v_total_min = vtotal_min;
1728 	cmd.fams2_drr_update.dmub_optc_state_req.v_total_mid = vtotal_mid;
1729 	cmd.fams2_drr_update.dmub_optc_state_req.v_total_mid_frame_num = vtotal_mid_frame_num;
1730 	cmd.fams2_drr_update.dmub_optc_state_req.program_manual_trigger = program_manual_trigger;
1731 
1732 	cmd.fams2_drr_update.header.payload_bytes = sizeof(cmd.fams2_drr_update) - sizeof(cmd.fams2_drr_update.header);
1733 
1734 	dm_execute_dmub_cmd(dc->ctx, &cmd, DM_DMUB_WAIT_TYPE_WAIT);
1735 }
1736 
1737 void dc_dmub_srv_fams2_passthrough_flip(
1738 		struct dc *dc,
1739 		struct dc_state *state,
1740 		struct dc_stream_state *stream,
1741 		struct dc_surface_update *srf_updates,
1742 		int surface_count)
1743 {
1744 	int plane_index;
1745 	union dmub_rb_cmd cmds[MAX_PLANES];
1746 	struct dc_plane_address *address;
1747 	struct dc_plane_state *plane_state;
1748 	int num_cmds = 0;
1749 	struct dc_stream_status *stream_status = dc_stream_get_status(stream);
1750 
1751 	if (surface_count <= 0 || stream_status == NULL)
1752 		return;
1753 
1754 	memset(cmds, 0, sizeof(union dmub_rb_cmd) * MAX_PLANES);
1755 
1756 	/* build command for each surface update */
1757 	for (plane_index = 0; plane_index < surface_count; plane_index++) {
1758 		plane_state = srf_updates[plane_index].surface;
1759 		address = &plane_state->address;
1760 
1761 		/* skip if there is no address update for plane */
1762 		if (!srf_updates[plane_index].flip_addr)
1763 			continue;
1764 
1765 		/* build command header */
1766 		cmds[num_cmds].fams2_flip.header.type = DMUB_CMD__FW_ASSISTED_MCLK_SWITCH;
1767 		cmds[num_cmds].fams2_flip.header.sub_type = DMUB_CMD__FAMS2_FLIP;
1768 		cmds[num_cmds].fams2_flip.header.payload_bytes = sizeof(struct dmub_rb_cmd_fams2_flip);
1769 
1770 		/* for chaining multiple commands, all but last command should set to 1 */
1771 		cmds[num_cmds].fams2_flip.header.multi_cmd_pending = 1;
1772 
1773 		/* set topology info */
1774 		cmds[num_cmds].fams2_flip.flip_info.pipe_mask = dc_plane_get_pipe_mask(state, plane_state);
1775 		if (stream_status)
1776 			cmds[num_cmds].fams2_flip.flip_info.otg_inst = stream_status->primary_otg_inst;
1777 
1778 		cmds[num_cmds].fams2_flip.flip_info.config.bits.is_immediate = plane_state->flip_immediate;
1779 
1780 		/* build address info for command */
1781 		switch (address->type) {
1782 		case PLN_ADDR_TYPE_GRAPHICS:
1783 			if (address->grph.addr.quad_part == 0) {
1784 				BREAK_TO_DEBUGGER();
1785 				break;
1786 			}
1787 
1788 			cmds[num_cmds].fams2_flip.flip_info.addr_info.meta_addr_lo =
1789 					address->grph.meta_addr.low_part;
1790 			cmds[num_cmds].fams2_flip.flip_info.addr_info.meta_addr_hi =
1791 					(uint16_t)address->grph.meta_addr.high_part;
1792 			cmds[num_cmds].fams2_flip.flip_info.addr_info.surf_addr_lo =
1793 					address->grph.addr.low_part;
1794 			cmds[num_cmds].fams2_flip.flip_info.addr_info.surf_addr_hi =
1795 					(uint16_t)address->grph.addr.high_part;
1796 			break;
1797 		case PLN_ADDR_TYPE_VIDEO_PROGRESSIVE:
1798 			if (address->video_progressive.luma_addr.quad_part == 0 ||
1799 				address->video_progressive.chroma_addr.quad_part == 0) {
1800 				BREAK_TO_DEBUGGER();
1801 				break;
1802 			}
1803 
1804 			cmds[num_cmds].fams2_flip.flip_info.addr_info.meta_addr_lo =
1805 					address->video_progressive.luma_meta_addr.low_part;
1806 			cmds[num_cmds].fams2_flip.flip_info.addr_info.meta_addr_hi =
1807 					(uint16_t)address->video_progressive.luma_meta_addr.high_part;
1808 			cmds[num_cmds].fams2_flip.flip_info.addr_info.meta_addr_c_lo =
1809 					address->video_progressive.chroma_meta_addr.low_part;
1810 			cmds[num_cmds].fams2_flip.flip_info.addr_info.meta_addr_c_hi =
1811 					(uint16_t)address->video_progressive.chroma_meta_addr.high_part;
1812 			cmds[num_cmds].fams2_flip.flip_info.addr_info.surf_addr_lo =
1813 					address->video_progressive.luma_addr.low_part;
1814 			cmds[num_cmds].fams2_flip.flip_info.addr_info.surf_addr_hi =
1815 					(uint16_t)address->video_progressive.luma_addr.high_part;
1816 			cmds[num_cmds].fams2_flip.flip_info.addr_info.surf_addr_c_lo =
1817 					address->video_progressive.chroma_addr.low_part;
1818 			cmds[num_cmds].fams2_flip.flip_info.addr_info.surf_addr_c_hi =
1819 					(uint16_t)address->video_progressive.chroma_addr.high_part;
1820 			break;
1821 		default:
1822 			// Should never be hit
1823 			BREAK_TO_DEBUGGER();
1824 			break;
1825 		}
1826 
1827 		num_cmds++;
1828 	}
1829 
1830 	if (num_cmds > 0)  {
1831 		cmds[num_cmds - 1].fams2_flip.header.multi_cmd_pending = 0;
1832 		dm_execute_dmub_cmd_list(dc->ctx, num_cmds, cmds, DM_DMUB_WAIT_TYPE_WAIT);
1833 	}
1834 }
1835