xref: /linux/drivers/gpu/drm/amd/display/dc/dc.h (revision 29c0f7c655f47bcbd575ff75e58480df6ec3c9da)
1 /*
2  * Copyright 2012-2026 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 #ifndef DC_INTERFACE_H_
27 #define DC_INTERFACE_H_
28 
29 #include "dc_types.h"
30 #include "dc_state.h"
31 #include "dc_plane.h"
32 #include "dc_probe.h"
33 #include "grph_object_defs.h"
34 #include "logger_types.h"
35 #include "hdcp_msg_types.h"
36 #include "gpio_types.h"
37 #include "link_service_types.h"
38 #include "grph_object_ctrl_defs.h"
39 #include <inc/hw/opp.h>
40 
41 #include "hwss/hw_sequencer.h"
42 #include "inc/compressor.h"
43 #include "inc/hw/dmcu.h"
44 #include "dml/display_mode_lib.h"
45 
46 #include "dml2_0/dml2_wrapper.h"
47 
48 #include "dmub/inc/dmub_cmd.h"
49 
50 #include "dml/dml1_frl_cap_chk.h"
51 
52 #include "sspl/dc_spl_types.h"
53 
54 struct abm_save_restore;
55 
56 /* forward declaration */
57 struct aux_payload;
58 struct set_config_cmd_payload;
59 struct dmub_notification;
60 struct dcn_hubbub_reg_state;
61 struct dcn_hubp_reg_state;
62 struct dcn_dpp_reg_state;
63 struct dcn_mpc_reg_state;
64 struct dcn_opp_reg_state;
65 struct dcn_dsc_reg_state;
66 struct dcn_optc_reg_state;
67 struct dcn_dccg_reg_state;
68 
69 #define DC_VER "3.2.390"
70 
71 /**
72  * MAX_SURFACES - representative of the upper bound of surfaces that can be piped to a single CRTC
73  */
74 #define MAX_SURFACES 4
75 /**
76  * MAX_PLANES - representative of the upper bound of planes that are supported by the HW
77  */
78 #define MAX_PLANES 6
79 #define MAX_STREAMS 6
80 #define MIN_VIEWPORT_SIZE 12
81 #define MAX_NUM_EDP 2
82 #define MAX_SUPPORTED_FORMATS 7
83 
84 #define MAX_HOST_ROUTERS_NUM 3
85 #define MAX_DPIA_PER_HOST_ROUTER 3
86 #define MAX_DPIA_NUM  (MAX_HOST_ROUTERS_NUM * MAX_DPIA_PER_HOST_ROUTER)
87 
88 #define NUM_FAST_FLIPS_TO_STEADY_STATE 20
89 
90 struct frl_cap_chk_intermediates_fixed31_32 {
91 	int      c_frl_sb;
92 	struct fixed31_32   overhead_sb;
93 	struct fixed31_32   overhead_rs;
94 	struct fixed31_32   overhead_map;
95 	struct fixed31_32   overhead_min;
96 	struct fixed31_32   overhead_max;
97 	struct fixed31_32   f_pixel_clock_max;
98 	struct fixed31_32   t_line;
99 	struct fixed31_32   r_bit_min;
100 	struct fixed31_32   r_frl_char_min;
101 	struct fixed31_32   c_frl_line;
102 	struct fixed31_32   ap;
103 	struct fixed31_32   r_ap;
104 	struct fixed31_32   avg_audio_packets_line;
105 	struct fixed31_32   margin;
106 	int      audio_packets_line;
107 	int      blank_audio_min;
108 };
109 
110 struct frl_cap_chk_params_fixed31_32 {
111 	int      lanes;
112 	struct fixed31_32   f_pixel_clock_nominal;   /* Pixel Clock rate (Hz)  */
113 	struct fixed31_32   r_bit_nominal;           /* FRL bitrate (bps) */
114 	int      audio_packet_type;
115 	struct fixed31_32   f_audio;                 /* Audio rate (Hz) */
116 	int      h_active;                /* Active pixels per line */
117 	int      h_blank;                 /* Blanking pixels per line */
118 	int      bpc;                     /* Bits per component */
119 	int      vic;                     /* Video Identification Code */
120 
121 	enum hdmi_frl_pixel_encoding    pixel_encoding;
122 
123 	bool     compressed;              /* set to true if DSC is enabled */
124 	bool     bypass_hc_target_calc;   /* debug only */
125 	bool     allow_all_bpp;           /* dsc_all_bpp */
126 
127 	/* DSC parameters */
128 	int      slices;
129 	int      slice_width;
130 	struct fixed31_32   bpp_target;
131 	int      layout;
132 	int      acat;    /* not supported */
133 
134 	/* outputs */
135 	struct frl_dml_borrow_params borrow_params;
136 	int      average_tribyte_rate;
137 };
138 
139 /* Display Core Interfaces */
140 struct dc_versions {
141 	const char *dc_ver;
142 	struct dmcu_version dmcu_version;
143 };
144 
145 enum dp_protocol_version {
146 	DP_VERSION_1_4 = 0,
147 	DP_VERSION_2_1,
148 	DP_VERSION_UNKNOWN,
149 };
150 
151 enum dc_plane_type {
152 	DC_PLANE_TYPE_INVALID,
153 	DC_PLANE_TYPE_DCE_RGB,
154 	DC_PLANE_TYPE_DCE_UNDERLAY,
155 	DC_PLANE_TYPE_DCN_UNIVERSAL,
156 };
157 
158 // Sizes defined as multiples of 64KB
159 enum det_size {
160 	DET_SIZE_DEFAULT = 0,
161 	DET_SIZE_192KB = 3,
162 	DET_SIZE_256KB = 4,
163 	DET_SIZE_320KB = 5,
164 	DET_SIZE_384KB = 6
165 };
166 
167 
168 struct dc_plane_cap {
169 	enum dc_plane_type type;
170 	uint32_t per_pixel_alpha : 1;
171 	struct {
172 		uint32_t argb8888 : 1;
173 		uint32_t nv12 : 1;
174 		uint32_t fp16 : 1;
175 		uint32_t p010 : 1;
176 		uint32_t ayuv : 1;
177 	} pixel_format_support;
178 	// max upscaling factor x1000
179 	// upscaling factors are always >= 1
180 	// for example, 1080p -> 8K is 4.0, or 4000 raw value
181 	struct {
182 		uint32_t argb8888;
183 		uint32_t nv12;
184 		uint32_t fp16;
185 	} max_upscale_factor;
186 	// max downscale factor x1000
187 	// downscale factors are always <= 1
188 	// for example, 8K -> 1080p is 0.25, or 250 raw value
189 	struct {
190 		uint32_t argb8888;
191 		uint32_t nv12;
192 		uint32_t fp16;
193 	} max_downscale_factor;
194 	// minimal width/height
195 	uint32_t min_width;
196 	uint32_t min_height;
197 };
198 
199 /**
200  * DOC: color-management-caps
201  *
202  * **Color management caps (DPP and MPC)**
203  *
204  * Modules/color calculates various color operations which are translated to
205  * abstracted HW. DCE 5-12 had almost no important changes, but starting with
206  * DCN1, every new generation comes with fairly major differences in color
207  * pipeline. Therefore, we abstract color pipe capabilities so modules/DM can
208  * decide mapping to HW block based on logical capabilities.
209  */
210 
211 /**
212  * struct rom_curve_caps - predefined transfer function caps for degamma and regamma
213  * @srgb: RGB color space transfer func
214  * @bt2020: BT.2020 transfer func
215  * @gamma2_2: standard gamma
216  * @pq: perceptual quantizer transfer function
217  * @hlg: hybrid log–gamma transfer function
218  */
219 struct rom_curve_caps {
220 	uint16_t srgb : 1;
221 	uint16_t bt2020 : 1;
222 	uint16_t gamma2_2 : 1;
223 	uint16_t pq : 1;
224 	uint16_t hlg : 1;
225 };
226 
227 /**
228  * struct dpp_color_caps - color pipeline capabilities for display pipe and
229  * plane blocks
230  *
231  * @dcn_arch: all DCE generations treated the same
232  * @input_lut_shared: shared with DGAM. Input LUT is different than most LUTs,
233  * just plain 256-entry lookup
234  * @icsc: input color space conversion
235  * @dgam_ram: programmable degamma LUT
236  * @post_csc: post color space conversion, before gamut remap
237  * @gamma_corr: degamma correction
238  * @hw_3d_lut: 3D LUT support. It implies a shaper LUT before. It may be shared
239  * with MPC by setting mpc:shared_3d_lut flag
240  * @ogam_ram: programmable out/blend gamma LUT
241  * @ocsc: output color space conversion
242  * @dgam_rom_for_yuv: pre-defined degamma LUT for YUV planes
243  * @dgam_rom_caps: pre-definied curve caps for degamma 1D LUT
244  * @ogam_rom_caps: pre-definied curve caps for regamma 1D LUT
245  *
246  * Note: hdr_mult and gamut remap (CTM) are always available in DPP (in that order)
247  */
248 struct dpp_color_caps {
249 	uint16_t dcn_arch : 1;
250 	uint16_t input_lut_shared : 1;
251 	uint16_t icsc : 1;
252 	uint16_t dgam_ram : 1;
253 	uint16_t post_csc : 1;
254 	uint16_t gamma_corr : 1;
255 	uint16_t hw_3d_lut : 1;
256 	uint16_t ogam_ram : 1;
257 	uint16_t ocsc : 1;
258 	uint16_t dgam_rom_for_yuv : 1;
259 	struct rom_curve_caps dgam_rom_caps;
260 	struct rom_curve_caps ogam_rom_caps;
261 };
262 
263 /* Below structure is to describe the HW support for mem layout, extend support
264 	range to match what OS could handle in the roadmap */
265 struct lut3d_caps {
266 	uint32_t dma_3d_lut : 1; /*< DMA mode support for 3D LUT */
267 	struct {
268 		uint32_t swizzle_3d_rgb : 1;
269 		uint32_t swizzle_3d_bgr : 1;
270 		uint32_t linear_1d : 1;
271 	} mem_layout_support;
272 	struct {
273 		uint32_t unorm_12msb : 1;
274 		uint32_t unorm_12lsb : 1;
275 		uint32_t float_fp1_5_10 : 1;
276 	} mem_format_support;
277 	struct {
278 		uint32_t order_rgba : 1;
279 		uint32_t order_bgra : 1;
280 	} mem_pixel_order_support;
281 	/*< size options are 9, 17, 33, 45, 65 */
282 	struct {
283 		uint32_t dim_9 : 1; /* 3D LUT support for 9x9x9 */
284 		uint32_t dim_17 : 1; /* 3D LUT support for 17x17x17 */
285 		uint32_t dim_33 : 1; /* 3D LUT support for 33x33x33 */
286 		uint32_t dim_45 : 1; /* 3D LUT support for 45x45x45 */
287 		uint32_t dim_65 : 1; /* 3D LUT support for 65x65x65 */
288 	} lut_dim_caps;
289 };
290 
291 /**
292  * struct mpc_color_caps - color pipeline capabilities for multiple pipe and
293  * plane combined blocks
294  *
295  * @gamut_remap: color transformation matrix
296  * @ogam_ram: programmable out gamma LUT
297  * @ocsc: output color space conversion matrix
298  * @num_3dluts: MPC 3D LUT; always assumes a preceding shaper LUT
299  * @num_rmcm_3dluts: number of RMCM 3D LUTS; always assumes a preceding shaper LUT
300  * @shared_3d_lut: shared 3D LUT flag. Can be either DPP or MPC, but single
301  * instance
302  * @ogam_rom_caps: pre-definied curve caps for regamma 1D LUT
303  * @mcm_3d_lut_caps: HW support cap for MCM LUT memory
304  * @rmcm_3d_lut_caps: HW support cap for RMCM LUT memory
305  * @preblend: whether color manager supports preblend with MPC
306  */
307 struct mpc_color_caps {
308 	uint16_t gamut_remap : 1;
309 	uint16_t ogam_ram : 1;
310 	uint16_t ocsc : 1;
311 	uint16_t num_3dluts : 3;
312 	uint16_t num_rmcm_3dluts : 3;
313 	uint16_t shared_3d_lut:1;
314 	struct rom_curve_caps ogam_rom_caps;
315 	struct lut3d_caps mcm_3d_lut_caps;
316 	struct lut3d_caps rmcm_3d_lut_caps;
317 	bool preblend;
318 	struct fixed31_32 max_gamut_remap_coeff;
319 };
320 
321 /**
322  * struct dc_color_caps - color pipes capabilities for DPP and MPC hw blocks
323  * @dpp: color pipes caps for DPP
324  * @mpc: color pipes caps for MPC
325  */
326 struct dc_color_caps {
327 	struct dpp_color_caps dpp;
328 	struct mpc_color_caps mpc;
329 };
330 
331 struct dc_dmub_caps {
332 	bool psr;
333 	bool mclk_sw;
334 	bool subvp_psr;
335 	bool gecc_enable;
336 	uint8_t fams_ver;
337 	bool aux_backlight_support;
338 };
339 
340 struct dc_scl_caps {
341 	bool sharpener_support;
342 };
343 
344 struct dc_check_config {
345 	/**
346 	 * max video plane width that can be safely assumed to be always
347 	 * supported by single DPP pipe.
348 	 */
349 	unsigned int max_optimizable_video_width;
350 	bool enable_legacy_fast_update;
351 
352 	bool deferred_transition_state;
353 	unsigned int transition_countdown_to_steady_state;
354 };
355 
356 struct dc_caps {
357 	uint32_t max_streams;
358 	uint32_t max_links;
359 	uint32_t max_audios;
360 	uint32_t max_slave_planes;
361 	uint32_t max_slave_yuv_planes;
362 	uint32_t max_slave_rgb_planes;
363 	uint32_t max_planes;
364 	uint32_t max_downscale_ratio;
365 	uint32_t i2c_speed_in_khz;
366 	uint32_t i2c_speed_in_khz_hdcp;
367 	uint32_t dmdata_alloc_size;
368 	unsigned int max_cursor_size;
369 	unsigned int max_buffered_cursor_size;
370 	unsigned int max_video_width;
371 	unsigned int min_horizontal_blanking_period;
372 	int linear_pitch_alignment;
373 	bool dcc_const_color;
374 	bool dynamic_audio;
375 	bool is_apu;
376 	bool dual_link_dvi;
377 	bool post_blend_color_processing;
378 	bool force_dp_tps4_for_cp2520;
379 	bool disable_dp_clk_share;
380 	bool psp_setup_panel_mode;
381 	bool extended_aux_timeout_support;
382 	bool dmcub_support;
383 	bool zstate_support;
384 	bool ips_support;
385 	bool ips_v2_support;
386 	uint32_t num_of_internal_disp;
387 	enum dp_protocol_version max_dp_protocol_version;
388 	bool hdmi_hpo;
389 	unsigned int mall_size_per_mem_channel;
390 	unsigned int mall_size_total;
391 	unsigned int cursor_cache_size;
392 	struct dc_plane_cap planes[MAX_PLANES];
393 	struct dc_color_caps color;
394 	struct dc_dmub_caps dmub_caps;
395 	bool dp_hpo;
396 	bool dp_hdmi21_pcon_support;
397 	bool edp_dsc_support;
398 	bool vbios_lttpr_aware;
399 	bool vbios_lttpr_enable;
400 	bool fused_io_supported;
401 	uint32_t max_otg_num;
402 	uint32_t max_cab_allocation_bytes;
403 	uint32_t cache_line_size;
404 	uint32_t cache_num_ways;
405 	uint16_t subvp_fw_processing_delay_us;
406 	uint8_t subvp_drr_max_vblank_margin_us;
407 	uint16_t subvp_prefetch_end_to_mall_start_us;
408 	uint8_t subvp_swath_height_margin_lines; // subvp start line must be aligned to 2 x swath height
409 	uint16_t subvp_pstate_allow_width_us;
410 	uint16_t subvp_vertical_int_margin_us;
411 	bool seamless_odm;
412 	uint32_t max_v_total;
413 	bool vtotal_limited_by_fp2;
414 	uint32_t max_disp_clock_khz_at_vmin;
415 	uint8_t subvp_drr_vblank_start_margin_us;
416 	bool cursor_not_scaled;
417 	bool dcmode_power_limits_present;
418 	bool sequential_ono;
419 	/* Conservative limit for DCC cases which require ODM4:1 to support*/
420 	uint32_t dcc_plane_width_limit;
421 	struct dc_scl_caps scl_caps;
422 	uint8_t num_of_host_routers;
423 	uint8_t num_of_dpias_per_host_router;
424 	/* limit of the ODM only, could be limited by other factors (like pipe count)*/
425 	uint8_t max_odm_combine_factor;
426 };
427 
428 struct dc_bug_wa {
429 	bool no_connect_phy_config;
430 	bool dedcn20_305_wa;
431 	bool skip_clock_update;
432 	bool lt_early_cr_pattern;
433 	struct {
434 		uint8_t uclk : 1;
435 		uint8_t fclk : 1;
436 		uint8_t dcfclk : 1;
437 		uint8_t dcfclk_ds: 1;
438 	} clock_update_disable_mask;
439 	bool skip_psr_ips_crtc_disable;
440 };
441 struct dc_dcc_surface_param {
442 	struct dc_size surface_size;
443 	enum surface_pixel_format format;
444 	unsigned int plane0_pitch;
445 	struct dc_size plane1_size;
446 	unsigned int plane1_pitch;
447 	union {
448 		enum swizzle_mode_values swizzle_mode;
449 		enum swizzle_mode_addr3_values swizzle_mode_addr3;
450 	};
451 	enum dc_scan_direction scan;
452 };
453 
454 struct dc_dcc_setting {
455 	unsigned int max_compressed_blk_size;
456 	unsigned int max_uncompressed_blk_size;
457 	bool independent_64b_blks;
458 	//These bitfields to be used starting with DCN 3.0
459 	struct {
460 		uint32_t dcc_256_64_64 : 1;//available in ASICs before DCN 3.0 (the worst compression case)
461 		uint32_t dcc_128_128_uncontrained : 1;  //available in ASICs before DCN 3.0
462 		uint32_t dcc_256_128_128 : 1;		//available starting with DCN 3.0
463 		uint32_t dcc_256_256_unconstrained : 1;  //available in ASICs before DCN 3.0 (the best compression case)
464 		uint32_t dcc_256_256 : 1;  //available in ASICs starting with DCN 4.0x (the best compression case)
465 		uint32_t dcc_256_128 : 1;  //available in ASICs starting with DCN 4.0x
466 		uint32_t dcc_256_64 : 1;   //available in ASICs starting with DCN 4.0x (the worst compression case)
467 	} dcc_controls;
468 };
469 
470 struct dc_surface_dcc_cap {
471 	union {
472 		struct {
473 			struct dc_dcc_setting rgb;
474 		} grph;
475 
476 		struct {
477 			struct dc_dcc_setting luma;
478 			struct dc_dcc_setting chroma;
479 		} video;
480 	};
481 
482 	bool capable;
483 	bool const_color_support;
484 };
485 
486 struct dc_static_screen_params {
487 	struct {
488 		bool force_trigger;
489 		bool cursor_update;
490 		bool surface_update;
491 		bool overlay_update;
492 	} triggers;
493 	unsigned int num_frames;
494 };
495 
496 
497 /* Surface update type is used by dc_update_surfaces_and_stream
498  * The update type is determined at the very beginning of the function based
499  * on parameters passed in and decides how much programming (or updating) is
500  * going to be done during the call.
501  *
502  * UPDATE_TYPE_FAST is used for really fast updates that do not require much
503  * logical calculations or hardware register programming. This update MUST be
504  * ISR safe on windows. Currently fast update will only be used to flip surface
505  * address.
506  *
507  * UPDATE_TYPE_MED is used for slower updates which require significant hw
508  * re-programming however do not affect bandwidth consumption or clock
509  * requirements. At present, this is the level at which front end updates
510  * that do not require us to run bw_calcs happen. These are in/out transfer func
511  * updates, viewport offset changes, recout size changes and pixel depth changes.
512  * This update can be done at ISR, but we want to minimize how often this happens.
513  *
514  * UPDATE_TYPE_FULL is slow. Really slow. This requires us to recalculate our
515  * bandwidth and clocks, possibly rearrange some pipes and reprogram anything front
516  * end related. Any time viewport dimensions, recout dimensions, scaling ratios or
517  * gamma need to be adjusted or pipe needs to be turned on (or disconnected) we do
518  * a full update. This cannot be done at ISR level and should be a rare event.
519  * Unless someone is stress testing mpo enter/exit, playing with colour or adjusting
520  * underscan we don't expect to see this call at all.
521  */
522 
523 enum dc_update_type {
524 	UPDATE_TYPE_FAST, /* super fast, safe to execute in isr */
525 	UPDATE_TYPE_MED,  /* ISR safe, most of programming needed, no bw/clk change*/
526 	UPDATE_TYPE_FULL, /* may need to shuffle resources */
527 };
528 
529 enum dc_lock_descriptor {
530 	LOCK_DESCRIPTOR_NONE = 0x0,
531 	LOCK_DESCRIPTOR_STREAM = 0x1,
532 	LOCK_DESCRIPTOR_LINK = 0x2,
533 	LOCK_DESCRIPTOR_GLOBAL = 0x4,
534 	LOCK_DESCRIPTOR_PROBE = 0x8,
535 };
536 
537 struct dc_update_descriptor {
538 	enum dc_update_type update_type;
539 	enum dc_lock_descriptor lock_descriptor;
540 };
541 
542 /* Forward declaration*/
543 struct dc;
544 struct dc_plane_state;
545 struct dc_state;
546 
547 struct dc_cap_funcs {
548 	bool (*get_dcc_compression_cap)(const struct dc *dc,
549 			const struct dc_dcc_surface_param *input,
550 			struct dc_surface_dcc_cap *output);
551 	bool (*get_subvp_en)(struct dc *dc, struct dc_state *context);
552 };
553 
554 struct link_training_settings;
555 
556 union allow_lttpr_non_transparent_mode {
557 	struct {
558 		bool DP1_4A : 1;
559 		bool DP2_0 : 1;
560 	} bits;
561 	unsigned char raw;
562 };
563 /* Structure to hold configuration flags set by dm at dc creation. */
564 struct dc_config {
565 	bool gpu_vm_support;
566 	bool disable_disp_pll_sharing;
567 	bool fbc_support;
568 	bool disable_fractional_pwm;
569 	bool allow_seamless_boot_optimization;
570 	bool seamless_boot_edp_requested;
571 	bool edp_not_connected;
572 	bool edp_no_power_sequencing;
573 	bool force_enum_edp;
574 	bool forced_clocks;
575 	union allow_lttpr_non_transparent_mode allow_lttpr_non_transparent_mode;
576 	bool multi_mon_pp_mclk_switch;
577 	bool disable_dmcu;
578 	bool allow_4to1MPC;
579 	bool enable_windowed_mpo_odm;
580 	bool forceHBR2CP2520; // Used for switching between test patterns TPS4 and CP2520
581 	uint32_t allow_edp_hotplug_detection;
582 	bool skip_riommu_prefetch_wa;
583 	bool clamp_min_dcfclk;
584 	uint64_t vblank_alignment_dto_params;
585 	uint8_t  vblank_alignment_max_frame_time_diff;
586 	bool is_asymmetric_memory;
587 	bool is_single_rank_dimm;
588 	bool is_vmin_only_asic;
589 	bool use_spl;
590 	bool prefer_easf;
591 	bool use_pipe_ctx_sync_logic;
592 	int smart_mux_version;
593 	bool ignore_dpref_ss;
594 	bool enable_mipi_converter_optimization;
595 	bool enable_frl;
596 	bool force_hdmi21_frl_enc_enable;
597 	bool use_default_clock_table;
598 	bool force_bios_enable_lttpr;
599 	uint8_t force_bios_fixed_vs;
600 	unsigned int sdpif_request_limit_words_per_umc;
601 	bool dc_mode_clk_limit_support;
602 	bool EnableMinDispClkODM;
603 	bool enable_auto_dpm_test_logs;
604 	unsigned int disable_ips;
605 	unsigned int disable_ips_rcg;
606 	unsigned int disable_ips_in_vpb;
607 	bool disable_ips_in_dpms_off;
608 	bool usb4_bw_alloc_support;
609 	bool allow_0_dtb_clk;
610 	bool use_assr_psp_message;
611 	bool support_edp0_on_dp1;
612 	unsigned int enable_fpo_flicker_detection;
613 	bool disable_hbr_audio_dp2;
614 	bool consolidated_dpia_dp_lt;
615 	bool set_pipe_unlock_order;
616 	bool enable_dpia_pre_training;
617 	bool unify_link_enc_assignment;
618 	bool enable_cursor_offload;
619 	bool dp_connector_no_native_i2c;
620 	bool frame_update_cmd_version2;
621 	struct spl_sharpness_range dcn_sharpness_range;
622 	struct spl_sharpness_range dcn_override_sharpness_range;
623 	bool no_native422_support;
624 };
625 
626 enum visual_confirm {
627 	VISUAL_CONFIRM_DISABLE = 0,
628 	VISUAL_CONFIRM_SURFACE = 1,
629 	VISUAL_CONFIRM_HDR = 2,
630 	VISUAL_CONFIRM_MPCTREE = 4,
631 	VISUAL_CONFIRM_PSR = 5,
632 	VISUAL_CONFIRM_SWAPCHAIN = 6,
633 	VISUAL_CONFIRM_FAMS = 7,
634 	VISUAL_CONFIRM_SWIZZLE = 9,
635 	VISUAL_CONFIRM_SMARTMUX_DGPU = 10,
636 	VISUAL_CONFIRM_REPLAY = 12,
637 	VISUAL_CONFIRM_SUBVP = 14,
638 	VISUAL_CONFIRM_ABM = 15,
639 	VISUAL_CONFIRM_MCLK_SWITCH = 16,
640 	VISUAL_CONFIRM_FAMS2 = 19,
641 	VISUAL_CONFIRM_HW_CURSOR = 20,
642 	VISUAL_CONFIRM_VABC = 21,
643 	VISUAL_CONFIRM_DCC = 22,
644 	VISUAL_CONFIRM_BOOSTED_REFRESH_RATE = 23,
645 	VISUAL_CONFIRM_EXPLICIT = 0x80000000,
646 };
647 
648 enum dc_psr_power_opts {
649 	psr_power_opt_invalid = 0x0,
650 	psr_power_opt_smu_opt_static_screen = 0x1,
651 	psr_power_opt_z10_static_screen = 0x10,
652 	psr_power_opt_ds_disable_allow = 0x100,
653 };
654 
655 enum dml_hostvm_override_opts {
656 	DML_HOSTVM_NO_OVERRIDE = 0x0,
657 	DML_HOSTVM_OVERRIDE_FALSE = 0x1,
658 	DML_HOSTVM_OVERRIDE_TRUE = 0x2,
659 };
660 
661 enum dc_replay_power_opts {
662 	replay_power_opt_invalid		= 0x0,
663 	replay_power_opt_smu_opt_static_screen	= 0x1,
664 	replay_power_opt_z10_static_screen	= 0x10,
665 };
666 
667 enum dcc_option {
668 	DCC_ENABLE = 0,
669 	DCC_DISABLE = 1,
670 	DCC_HALF_REQ_DISALBE = 2,
671 };
672 
673 enum in_game_fams_config {
674 	INGAME_FAMS_SINGLE_DISP_ENABLE, // enable in-game fams
675 	INGAME_FAMS_DISABLE, // disable in-game fams
676 	INGAME_FAMS_MULTI_DISP_ENABLE, //enable in-game fams for multi-display
677 	INGAME_FAMS_MULTI_DISP_CLAMPED_ONLY, //enable in-game fams for multi-display only for clamped RR strategies
678 };
679 
680 /**
681  * enum pipe_split_policy - Pipe split strategy supported by DCN
682  *
683  * This enum is used to define the pipe split policy supported by DCN. By
684  * default, DC favors MPC_SPLIT_DYNAMIC.
685  */
686 enum pipe_split_policy {
687 	/**
688 	 * @MPC_SPLIT_DYNAMIC: DC will automatically decide how to split the
689 	 * pipe in order to bring the best trade-off between performance and
690 	 * power consumption. This is the recommended option.
691 	 */
692 	MPC_SPLIT_DYNAMIC = 0,
693 
694 	/**
695 	 * @MPC_SPLIT_AVOID: Avoid pipe split, which means that DC will not
696 	 * try any sort of split optimization.
697 	 */
698 	MPC_SPLIT_AVOID = 1,
699 
700 	/**
701 	 * @MPC_SPLIT_AVOID_MULT_DISP: With this option, DC will only try to
702 	 * optimize the pipe utilization when using a single display; if the
703 	 * user connects to a second display, DC will avoid pipe split.
704 	 */
705 	MPC_SPLIT_AVOID_MULT_DISP = 2,
706 };
707 
708 enum wm_report_mode {
709 	WM_REPORT_DEFAULT = 0,
710 	WM_REPORT_OVERRIDE = 1,
711 };
712 enum dtm_pstate{
713 	dtm_level_p0 = 0,/*highest voltage*/
714 	dtm_level_p1,
715 	dtm_level_p2,
716 	dtm_level_p3,
717 	dtm_level_p4,/*when active_display_count = 0*/
718 };
719 
720 enum dcn_pwr_state {
721 	DCN_PWR_STATE_UNKNOWN = -1,
722 	DCN_PWR_STATE_MISSION_MODE = 0,
723 	DCN_PWR_STATE_LOW_POWER = 3,
724 };
725 
726 enum dcn_zstate_support_state {
727 	DCN_ZSTATE_SUPPORT_UNKNOWN,
728 	DCN_ZSTATE_SUPPORT_ALLOW,
729 	DCN_ZSTATE_SUPPORT_ALLOW_Z8_ONLY,
730 	DCN_ZSTATE_SUPPORT_ALLOW_Z8_Z10_ONLY,
731 	DCN_ZSTATE_SUPPORT_ALLOW_Z10_ONLY,
732 	DCN_ZSTATE_SUPPORT_DISALLOW,
733 };
734 
735 /*
736  * struct dc_clocks - DC pipe clocks
737  *
738  * For any clocks that may differ per pipe only the max is stored in this
739  * structure
740  */
741 struct dc_clocks {
742 	int dispclk_khz;
743 	int actual_dispclk_khz;
744 	int dppclk_khz;
745 	int actual_dppclk_khz;
746 	int disp_dpp_voltage_level_khz;
747 	int dcfclk_khz;
748 	int socclk_khz;
749 	int dcfclk_deep_sleep_khz;
750 	int fclk_khz;
751 	int phyclk_khz;
752 	int dramclk_khz;
753 	bool p_state_change_support;
754 	enum dcn_zstate_support_state zstate_support;
755 	bool dtbclk_en;
756 	int ref_dtbclk_khz;
757 	bool fclk_p_state_change_support;
758 	enum dcn_pwr_state pwr_state;
759 	/*
760 	 * Elements below are not compared for the purposes of
761 	 * optimization required
762 	 */
763 
764 	/*
765 	 * @cstate_allow
766 	 *
767 	 * DCN's DF C-state vote as last successfully acknowledged by PMFW.
768 	 * false = DCN does NOT permit DF C-state;
769 	 * true = DCN permits DF C-state;
770 	 */
771 	bool cstate_allow;
772 	bool prev_p_state_change_support;
773 	bool fclk_prev_p_state_change_support;
774 	int num_ways;
775 	int host_router_bw_kbps[MAX_HOST_ROUTERS_NUM];
776 
777 	/*
778 	 * @fw_based_mclk_switching
779 	 *
780 	 * DC has a mechanism that leverage the variable refresh rate to switch
781 	 * memory clock in cases that we have a large latency to achieve the
782 	 * memory clock change and a short vblank window. DC has some
783 	 * requirements to enable this feature, and this field describes if the
784 	 * system support or not such a feature.
785 	 */
786 	bool fw_based_mclk_switching;
787 	bool fw_based_mclk_switching_shut_down;
788 	int prev_num_ways;
789 	enum dtm_pstate dtm_level;
790 	int max_supported_dppclk_khz;
791 	int max_supported_dispclk_khz;
792 	int bw_dppclk_khz; /*a copy of dppclk_khz*/
793 	int bw_dispclk_khz;
794 	int idle_dramclk_khz;
795 	int idle_fclk_khz;
796 	int subvp_prefetch_dramclk_khz;
797 	int subvp_prefetch_fclk_khz;
798 
799 	/* Stutter efficiency is technically not clock values
800 	 * but stored here so the values are part of the update_clocks call similar to num_ways
801 	 * Efficiencies are stored as percentage (0-100)
802 	 */
803 	struct {
804 		uint8_t base_efficiency; //LP1
805 		uint8_t low_power_efficiency; //LP2
806 		uint8_t z8_stutter_efficiency;
807 		int z8_stutter_period;
808 	} stutter_efficiency;
809 };
810 
811 struct dc_bw_validation_profile {
812 	bool enable;
813 
814 	unsigned long long total_ticks;
815 	unsigned long long voltage_level_ticks;
816 	unsigned long long watermark_ticks;
817 	unsigned long long rq_dlg_ticks;
818 
819 	unsigned long long total_count;
820 	unsigned long long skip_fast_count;
821 	unsigned long long skip_pass_count;
822 	unsigned long long skip_fail_count;
823 };
824 
825 #define BW_VAL_TRACE_SETUP() \
826 		unsigned long long end_tick = 0; \
827 		unsigned long long voltage_level_tick = 0; \
828 		unsigned long long watermark_tick = 0; \
829 		unsigned long long start_tick = dc->debug.bw_val_profile.enable ? \
830 				dm_get_timestamp(dc->ctx) : 0
831 
832 #define BW_VAL_TRACE_COUNT() \
833 		if (dc->debug.bw_val_profile.enable) \
834 			dc->debug.bw_val_profile.total_count++
835 
836 #define BW_VAL_TRACE_SKIP(status) \
837 		if (dc->debug.bw_val_profile.enable) { \
838 			if (!voltage_level_tick) \
839 				voltage_level_tick = dm_get_timestamp(dc->ctx); \
840 			dc->debug.bw_val_profile.skip_ ## status ## _count++; \
841 		}
842 
843 #define BW_VAL_TRACE_END_VOLTAGE_LEVEL() \
844 		if (dc->debug.bw_val_profile.enable) \
845 			voltage_level_tick = dm_get_timestamp(dc->ctx)
846 
847 #define BW_VAL_TRACE_END_WATERMARKS() \
848 		if (dc->debug.bw_val_profile.enable) \
849 			watermark_tick = dm_get_timestamp(dc->ctx)
850 
851 #define BW_VAL_TRACE_FINISH() \
852 		if (dc->debug.bw_val_profile.enable) { \
853 			end_tick = dm_get_timestamp(dc->ctx); \
854 			dc->debug.bw_val_profile.total_ticks += end_tick - start_tick; \
855 			dc->debug.bw_val_profile.voltage_level_ticks += voltage_level_tick - start_tick; \
856 			if (watermark_tick) { \
857 				dc->debug.bw_val_profile.watermark_ticks += watermark_tick - voltage_level_tick; \
858 				dc->debug.bw_val_profile.rq_dlg_ticks += end_tick - watermark_tick; \
859 			} \
860 		}
861 
862 union mem_low_power_enable_options {
863 	struct {
864 		bool vga: 1;
865 		bool i2c: 1;
866 		bool dmcu: 1;
867 		bool dscl: 1;
868 		bool cm: 1;
869 		bool mpc: 1;
870 		bool optc: 1;
871 		bool vpg: 1;
872 		bool afmt: 1;
873 	} bits;
874 	uint32_t u32All;
875 };
876 
877 union root_clock_optimization_options {
878 	struct {
879 		bool dpp: 1;
880 		bool dsc: 1;
881 		bool hdmistream: 1;
882 		bool hdmichar: 1;
883 		bool dpstream: 1;
884 		bool symclk32_se: 1;
885 		bool symclk32_le: 1;
886 		bool symclk_fe: 1;
887 		bool physymclk: 1;
888 		bool dpiasymclk: 1;
889 		uint32_t reserved: 22;
890 	} bits;
891 	uint32_t u32All;
892 };
893 
894 union fine_grain_clock_gating_enable_options {
895 	struct {
896 		bool dccg_global_fgcg_rep : 1; /* Global fine grain clock gating of repeaters */
897 		bool dchub : 1;	   /* Display controller hub */
898 		bool dchubbub : 1;
899 		bool dpp : 1;	   /* Display pipes and planes */
900 		bool opp : 1;	   /* Output pixel processing */
901 		bool optc : 1;	   /* Output pipe timing combiner */
902 		bool dio : 1;	   /* Display output */
903 		bool dwb : 1;	   /* Display writeback */
904 		bool mmhubbub : 1; /* Multimedia hub */
905 		bool dmu : 1;	   /* Display core management unit */
906 		bool az : 1;	   /* Azalia */
907 		bool dchvm : 1;
908 		bool dsc : 1;	   /* Display stream compression */
909 
910 		uint32_t reserved : 19;
911 	} bits;
912 	uint32_t u32All;
913 };
914 
915 enum pg_hw_pipe_resources {
916 	PG_HUBP = 0,
917 	PG_DPP,
918 	PG_DSC,
919 	PG_MPCC,
920 	PG_OPP,
921 	PG_OPTC,
922 	PG_DPSTREAM,
923 	PG_HDMISTREAM,
924 	PG_PHYSYMCLK,
925 	PG_HW_PIPE_RESOURCES_NUM_ELEMENT
926 };
927 
928 enum pg_hw_resources {
929 	PG_DCCG = 0,
930 	PG_DCIO,
931 	PG_DIO,
932 	PG_DCHUBBUB,
933 	PG_DCHVM,
934 	PG_DWB,
935 	PG_HPO,
936 	PG_DCOH,
937 	PG_HW_RESOURCES_NUM_ELEMENT
938 };
939 
940 struct pg_block_update {
941 	bool pg_pipe_res_update[PG_HW_PIPE_RESOURCES_NUM_ELEMENT][MAX_PIPES];
942 	bool pg_res_update[PG_HW_RESOURCES_NUM_ELEMENT];
943 };
944 
945 union dpia_debug_options {
946 	struct {
947 		uint32_t disable_dpia:1; /* bit 0 */
948 		uint32_t force_non_lttpr:1; /* bit 1 */
949 		uint32_t extend_aux_rd_interval:1; /* bit 2 */
950 		uint32_t disable_mst_dsc_work_around:1; /* bit 3 */
951 		uint32_t enable_force_tbt3_work_around:1; /* bit 4 */
952 		uint32_t disable_usb4_pm_support:1; /* bit 5 */
953 		uint32_t enable_usb4_bw_zero_alloc_patch:1; /* bit 6 */
954 		uint32_t reserved:25;
955 	} bits;
956 	uint32_t raw;
957 };
958 
959 /* AUX wake work around options
960  * 0: enable/disable work around
961  * 1: use default timeout LINK_AUX_WAKE_TIMEOUT_MS
962  * 15-2: reserved
963  * 31-16: timeout in ms
964  */
965 union aux_wake_wa_options {
966 	struct {
967 		uint32_t enable_wa : 1;
968 		uint32_t use_default_timeout : 1;
969 		uint32_t rsvd: 14;
970 		uint32_t timeout_ms : 16;
971 	} bits;
972 	uint32_t raw;
973 };
974 
975 struct dc_debug_data {
976 	uint32_t ltFailCount;
977 	uint32_t i2cErrorCount;
978 	uint32_t auxErrorCount;
979 	struct pipe_topology_history topology_history;
980 };
981 
982 struct dc_phy_addr_space_config {
983 	struct {
984 		uint64_t start_addr;
985 		uint64_t end_addr;
986 		uint64_t fb_top;
987 		uint64_t fb_offset;
988 		uint64_t fb_base;
989 		uint64_t agp_top;
990 		uint64_t agp_bot;
991 		uint64_t agp_base;
992 	} system_aperture;
993 
994 	struct {
995 		uint64_t page_table_start_addr;
996 		uint64_t page_table_end_addr;
997 		uint64_t page_table_base_addr;
998 		bool base_addr_is_mc_addr;
999 	} gart_config;
1000 
1001 	bool valid;
1002 	bool is_hvm_enabled;
1003 	uint64_t page_table_default_page_addr;
1004 };
1005 
1006 struct dc_virtual_addr_space_config {
1007 	uint64_t	page_table_base_addr;
1008 	uint64_t	page_table_start_addr;
1009 	uint64_t	page_table_end_addr;
1010 	uint32_t	page_table_block_size_in_bytes;
1011 	uint8_t		page_table_depth; // 1 = 1 level, 2 = 2 level, etc.  0 = invalid
1012 };
1013 
1014 struct dc_bounding_box_overrides {
1015 	unsigned int sr_exit_time_ns;
1016 	unsigned int sr_enter_plus_exit_time_ns;
1017 	unsigned int sr_exit_z8_time_ns;
1018 	unsigned int sr_enter_plus_exit_z8_time_ns;
1019 	unsigned int urgent_latency_ns;
1020 	unsigned int percent_of_ideal_drambw;
1021 	unsigned int dram_clock_change_latency_ns;
1022 	unsigned int dummy_clock_change_latency_ns;
1023 	unsigned int fclk_clock_change_latency_ns;
1024 	/* This forces a hard min on the DCFCLK we use
1025 	 * for DML.  Unlike the debug option for forcing
1026 	 * DCFCLK, this override affects watermark calculations
1027 	 */
1028 	unsigned int min_dcfclk_mhz;
1029 };
1030 
1031 struct dc_qos_info {
1032 	uint32_t qos_bandwidth_lb_in_mbps;
1033 	uint32_t calculated_avg_bw_in_mbps;
1034 	uint32_t qos_max_latency_ub_in_ns;
1035 	uint32_t qos_avg_latency_ub_in_ns;
1036 	uint32_t dcn_bandwidth_ub_in_mbps;
1037 	uint32_t qos_max_bw_budget_in_mbps;
1038 };
1039 
1040 struct dc_state;
1041 struct resource_pool;
1042 struct dce_hwseq;
1043 struct link_service;
1044 
1045 /*
1046  * struct dc_debug_options - DC debug struct
1047  *
1048  * This struct provides a simple mechanism for developers to change some
1049  * configurations, enable/disable features, and activate extra debug options.
1050  * This can be very handy to narrow down whether some specific feature is
1051  * causing an issue or not.
1052  */
1053 struct dc_debug_options {
1054 	bool disable_dsc;
1055 	enum visual_confirm visual_confirm;
1056 	unsigned int visual_confirm_rect_height;
1057 
1058 	bool sanity_checks;
1059 	bool max_disp_clk;
1060 	bool surface_trace;
1061 	bool clock_trace;
1062 	bool validation_trace;
1063 	bool bandwidth_calcs_trace;
1064 	int max_downscale_src_width;
1065 
1066 	/* stutter efficiency related */
1067 	bool disable_stutter;
1068 	bool use_max_lb;
1069 	enum dcc_option disable_dcc;
1070 
1071 	/*
1072 	 * @pipe_split_policy: Define which pipe split policy is used by the
1073 	 * display core.
1074 	 */
1075 	enum pipe_split_policy pipe_split_policy;
1076 	bool force_single_disp_pipe_split;
1077 	bool voltage_align_fclk;
1078 	bool disable_min_fclk;
1079 
1080 	bool hdcp_lc_force_fw_enable;
1081 	bool hdcp_lc_enable_sw_fallback;
1082 
1083 	bool disable_dfs_bypass;
1084 	bool disable_dpp_power_gate;
1085 	bool disable_hubp_power_gate;
1086 	bool disable_dsc_power_gate;
1087 	bool disable_optc_power_gate;
1088 	bool disable_hpo_power_gate;
1089 	bool disable_io_clk_power_gate;
1090 	bool disable_mem_power_gate;
1091 	bool disable_dio_power_gate;
1092 	unsigned int dsc_min_slice_height_override;
1093 	unsigned int dsc_bpp_increment_div;
1094 	bool disable_pplib_wm_range;
1095 	enum wm_report_mode pplib_wm_report_mode;
1096 	unsigned int min_disp_clk_khz;
1097 	unsigned int min_dpp_clk_khz;
1098 	unsigned int min_dram_clk_khz;
1099 	unsigned int sr_exit_time_dpm0_ns;
1100 	unsigned int sr_enter_plus_exit_time_dpm0_ns;
1101 	unsigned int sr_exit_time_ns;
1102 	unsigned int sr_enter_plus_exit_time_ns;
1103 	unsigned int sr_exit_z8_time_ns;
1104 	unsigned int sr_enter_plus_exit_z8_time_ns;
1105 	unsigned int urgent_latency_ns;
1106 	uint32_t underflow_assert_delay_us;
1107 	unsigned int percent_of_ideal_drambw;
1108 	unsigned int dram_clock_change_latency_ns;
1109 	bool optimized_watermark;
1110 	int always_scale;
1111 	bool disable_pplib_clock_request;
1112 	bool disable_clock_gate;
1113 	bool disable_mem_low_power;
1114 	bool pstate_enabled;
1115 	bool disable_dmcu;
1116 	bool force_abm_enable;
1117 	bool disable_stereo_support;
1118 	bool vsr_support;
1119 	bool performance_trace;
1120 	bool az_endpoint_mute_only;
1121 	bool always_use_regamma;
1122 	bool recovery_enabled;
1123 	bool avoid_vbios_exec_table;
1124 	bool scl_reset_length10;
1125 	bool hdmi20_disable;
1126 	bool skip_detection_link_training;
1127 	uint32_t edid_read_retry_times;
1128 
1129 	uint8_t force_odm_combine; //bit vector based on otg inst
1130 	uint8_t seamless_boot_odm_combine;
1131 	uint8_t force_odm_combine_4to1; //bit vector based on otg inst
1132 
1133 	unsigned int minimum_z8_residency_time;
1134 	unsigned int minimum_z10_residency_time;
1135 	bool disable_z9_mpc;
1136 	unsigned int force_fclk_khz;
1137 	bool enable_tri_buf;
1138 	bool ips_disallow_entry;
1139 	bool disable_idle_power_optimizations;
1140 	unsigned int mall_size_override;
1141 	unsigned int mall_additional_timer_percent;
1142 	bool mall_error_as_fatal;
1143 	bool dmub_command_table; /* for testing only */
1144 	struct dc_bw_validation_profile bw_val_profile;
1145 	bool disable_fec;
1146 	bool disable_48mhz_pwrdwn;
1147 	/* This forces a hard min on the DCFCLK requested to SMU/PP
1148 	 * watermarks are not affected.
1149 	 */
1150 	unsigned int force_min_dcfclk_mhz;
1151 	int dwb_fi_phase;
1152 	bool disable_timing_sync;
1153 	bool cm_in_bypass;
1154 	int force_clock_mode;/*every mode change.*/
1155 
1156 	bool disable_dram_clock_change_vactive_support;
1157 	bool validate_dml_output;
1158 	bool enable_dmcub_surface_flip;
1159 	bool usbc_combo_phy_reset_wa;
1160 	bool force_fva;
1161 	int max_frl_rate;
1162 	unsigned int  force_frl_rate;
1163 	bool ignore_ffe;
1164 	unsigned int  select_ffe;
1165 	unsigned int  limit_ffe;
1166 	bool force_frl_always;
1167 	bool force_frl_dsc;
1168 	bool force_frl_max;
1169 	bool apply_vsdb_rcc_wa;
1170 	bool enable_hdmi_idcc;
1171 
1172 	bool enable_dram_clock_change_one_display_vactive;
1173 	/* TODO - remove once tested */
1174 	bool legacy_dp2_lt;
1175 	bool set_mst_en_for_sst;
1176 	bool disable_uhbr;
1177 	bool force_dp2_lt_fallback_method;
1178 	bool ignore_cable_id;
1179 	union mem_low_power_enable_options enable_mem_low_power;
1180 	union root_clock_optimization_options root_clock_optimization;
1181 	union fine_grain_clock_gating_enable_options enable_fine_grain_clock_gating;
1182 	bool hpo_optimization;
1183 	bool force_vblank_alignment;
1184 
1185 	/* Enable dmub aux for legacy ddc */
1186 	bool enable_dmub_aux_for_legacy_ddc;
1187 	bool disable_fams;
1188 	enum in_game_fams_config disable_fams_gaming;
1189 	/* FEC/PSR1 sequence enable delay in 100us */
1190 	uint8_t fec_enable_delay_in100us;
1191 	bool enable_driver_sequence_debug;
1192 	enum det_size crb_alloc_policy;
1193 	unsigned int crb_alloc_policy_min_disp_count;
1194 	bool disable_z10;
1195 	bool enable_z9_disable_interface;
1196 	bool psr_skip_crtc_disable;
1197 	uint32_t ips_skip_crtc_disable_mask;
1198 	union dpia_debug_options dpia_debug;
1199 	bool disable_fixed_vs_aux_timeout_wa;
1200 	uint32_t fixed_vs_aux_delay_config_wa;
1201 	bool force_disable_subvp;
1202 	bool force_subvp_mclk_switch;
1203 	bool allow_sw_cursor_fallback;
1204 	unsigned int force_subvp_num_ways;
1205 	unsigned int force_mall_ss_num_ways;
1206 	bool alloc_extra_way_for_cursor;
1207 	uint32_t subvp_extra_lines;
1208 	bool disable_force_pstate_allow_on_hw_release;
1209 	bool force_usr_allow;
1210 	/* uses value at boot and disables switch */
1211 	bool disable_dtb_ref_clk_switch;
1212 	bool extended_blank_optimization;
1213 	union aux_wake_wa_options aux_wake_wa;
1214 	uint32_t mst_start_top_delay;
1215 	uint8_t psr_power_use_phy_fsm;
1216 	enum dml_hostvm_override_opts dml_hostvm_override;
1217 	bool dml_disallow_alternate_prefetch_modes;
1218 	bool use_legacy_soc_bb_mechanism;
1219 	bool exit_idle_opt_for_cursor_updates;
1220 	bool using_dml2;
1221 	bool enable_single_display_2to1_odm_policy;
1222 	bool enable_double_buffered_dsc_pg_support;
1223 	bool enable_dp_dig_pixel_rate_div_policy;
1224 	bool using_dml21;
1225 	enum lttpr_mode lttpr_mode_override;
1226 	unsigned int dsc_delay_factor_wa_x1000;
1227 	unsigned int min_prefetch_in_strobe_ns;
1228 	bool disable_unbounded_requesting;
1229 	bool dig_fifo_off_in_blank;
1230 	bool override_dispclk_programming;
1231 	bool otg_crc_db;
1232 	bool disallow_dispclk_dppclk_ds;
1233 	bool disable_fpo_optimizations;
1234 	bool support_eDP1_5;
1235 	uint32_t fpo_vactive_margin_us;
1236 	bool disable_fpo_vactive;
1237 	bool disable_boot_optimizations;
1238 	bool override_odm_optimization;
1239 	bool minimize_dispclk_using_odm;
1240 	bool disable_subvp_high_refresh;
1241 	bool disable_dp_plus_plus_wa;
1242 	uint32_t fpo_vactive_min_active_margin_us;
1243 	uint32_t fpo_vactive_max_blank_us;
1244 	bool enable_hpo_pg_support;
1245 	bool disable_dc_mode_overwrite;
1246 	bool replay_skip_crtc_disabled;
1247 	bool ignore_pg;/*do nothing, let pmfw control it*/
1248 	bool psp_disabled_wa;
1249 	unsigned int ips2_eval_delay_us;
1250 	unsigned int ips2_entry_delay_us;
1251 	bool optimize_ips_handshake;
1252 	bool disable_dmub_reallow_idle;
1253 	bool disable_timeout;
1254 	bool disable_extblankadj;
1255 	bool enable_idle_reg_checks;
1256 	unsigned int static_screen_wait_frames;
1257 	uint32_t pwm_freq;
1258 	bool force_chroma_subsampling_1tap;
1259 	unsigned int dcc_meta_propagation_delay_us;
1260 	bool disable_422_left_edge_pixel;
1261 	bool dml21_force_pstate_method;
1262 	uint32_t dml21_force_pstate_method_values[MAX_PIPES];
1263 	uint32_t dml21_disable_pstate_method_mask;
1264 	union fw_assisted_mclk_switch_version fams_version;
1265 	union dmub_fams2_global_feature_config fams2_config;
1266 	unsigned int force_cositing;
1267 	unsigned int disable_spl;
1268 	unsigned int force_easf;
1269 	unsigned int force_sharpness;
1270 	unsigned int force_sharpness_level;
1271 	unsigned int force_lls;
1272 	bool notify_dpia_hr_bw;
1273 	bool enable_ips_visual_confirm;
1274 	unsigned int sharpen_policy;
1275 	unsigned int scale_to_sharpness_policy;
1276 	unsigned int enable_oled_edp_power_up_opt;
1277 	bool enable_hblank_borrow;
1278 	bool force_subvp_df_throttle;
1279 	uint32_t acpi_transition_bitmasks[MAX_PIPES];
1280 	bool enable_pg_cntl_debug_logs;
1281 	unsigned int auxless_alpm_lfps_setup_ns;
1282 	unsigned int auxless_alpm_lfps_period_ns;
1283 	unsigned int auxless_alpm_lfps_silence_ns;
1284 	unsigned int auxless_alpm_lfps_t1t2_us;
1285 	short auxless_alpm_lfps_t1t2_offset_us;
1286 	bool disable_stutter_for_wm_program;
1287 	bool enable_block_sequence_programming;
1288 	uint32_t custom_psp_footer_size;
1289 	bool disable_deferred_minimal_transitions;
1290 	unsigned int num_fast_flips_to_steady_state_override;
1291 	bool enable_dmu_recovery;
1292 	unsigned int force_vmin_threshold;
1293 	bool enable_otg_frame_sync_pwa;
1294 	unsigned int min_deep_sleep_dcfclk_khz;
1295 	unsigned int force_odm2to1_for_edp_pixclk_mhz;
1296 	bool enable_replay_esd_recovery;
1297 	uint8_t iommu_mismatch_temp_wka;
1298 	bool disable_dynamic_expansion_for_test_pattern;
1299 	uint32_t dml21_custom_derate_num_dpms;
1300 	uint32_t dml21_custom_derate_at_dpm[DML2_MAX_NUM_DPM_LVL];
1301 };
1302 
1303 
1304 /* Generic structure that can be used to query properties of DC. More fields
1305  * can be added as required.
1306  */
1307 struct dc_current_properties {
1308 	unsigned int cursor_size_limit;
1309 };
1310 
1311 enum frame_buffer_mode {
1312 	FRAME_BUFFER_MODE_LOCAL_ONLY = 0,
1313 	FRAME_BUFFER_MODE_ZFB_ONLY,
1314 	FRAME_BUFFER_MODE_MIXED_ZFB_AND_LOCAL,
1315 } ;
1316 
1317 struct dchub_init_data {
1318 	int64_t zfb_phys_addr_base;
1319 	int64_t zfb_mc_base_addr;
1320 	uint64_t zfb_size_in_byte;
1321 	enum frame_buffer_mode fb_mode;
1322 	bool dchub_initialzied;
1323 	bool dchub_info_valid;
1324 };
1325 
1326 struct dml2_soc_bb;
1327 
1328 struct dc_init_data {
1329 	struct hw_asic_id asic_id;
1330 	void *driver; /* ctx */
1331 	struct cgs_device *cgs_device;
1332 	struct dc_bounding_box_overrides bb_overrides;
1333 
1334 	int num_virtual_links;
1335 	/*
1336 	 * If 'vbios_override' not NULL, it will be called instead
1337 	 * of the real VBIOS. Intended use is Diagnostics on FPGA.
1338 	 */
1339 	struct dc_bios *vbios_override;
1340 	enum dce_environment dce_environment;
1341 
1342 	struct dmub_offload_funcs *dmub_if;
1343 
1344 	struct dc_config flags;
1345 	uint64_t log_mask;
1346 
1347 	struct dpcd_vendor_signature vendor_signature;
1348 	bool force_smu_not_present;
1349 	/*
1350 	 * IP offset for run time initializaion of register addresses
1351 	 *
1352 	 * DCN3.5+ will fail dc_create() if these fields are null for them. They are
1353 	 * applicable starting with DCN32/321 and are not used for ASICs upstreamed
1354 	 * before them.
1355 	 */
1356 	uint32_t *dcn_reg_offsets;
1357 	uint32_t *nbio_reg_offsets;
1358 	uint32_t *clk_reg_offsets;
1359 	void *bb_from_dmub;
1360 };
1361 
1362 struct dc_callback_init {
1363 	struct cp_psp cp_psp;
1364 };
1365 
1366 struct dc *dc_create(const struct dc_init_data *init_params);
1367 void dc_hardware_init(struct dc *dc);
1368 
1369 int dc_get_vmid_use_vector(struct dc *dc);
1370 void dc_setup_vm_context(struct dc *dc, struct dc_virtual_addr_space_config *va_config, int vmid);
1371 /* Returns the number of vmids supported */
1372 unsigned int dc_setup_system_context(struct dc *dc, struct dc_phy_addr_space_config *pa_config);
1373 void dc_init_callbacks(struct dc *dc,
1374 		const struct dc_callback_init *init_params);
1375 void dc_deinit_callbacks(struct dc *dc);
1376 void dc_destroy(struct dc **dc);
1377 
1378 /* Surface Interfaces */
1379 
1380 enum {
1381 	TRANSFER_FUNC_POINTS = 1025
1382 };
1383 
1384 struct dc_hdr_static_metadata {
1385 	/* display chromaticities and white point in units of 0.00001 */
1386 	unsigned int chromaticity_green_x;
1387 	unsigned int chromaticity_green_y;
1388 	unsigned int chromaticity_blue_x;
1389 	unsigned int chromaticity_blue_y;
1390 	unsigned int chromaticity_red_x;
1391 	unsigned int chromaticity_red_y;
1392 	unsigned int chromaticity_white_point_x;
1393 	unsigned int chromaticity_white_point_y;
1394 
1395 	uint32_t min_luminance;
1396 	uint32_t max_luminance;
1397 	uint32_t maximum_content_light_level;
1398 	uint32_t maximum_frame_average_light_level;
1399 };
1400 
1401 enum dc_transfer_func_type {
1402 	TF_TYPE_PREDEFINED,
1403 	TF_TYPE_DISTRIBUTED_POINTS,
1404 	TF_TYPE_BYPASS,
1405 	TF_TYPE_HWPWL
1406 };
1407 
1408 struct dc_transfer_func_distributed_points {
1409 	struct fixed31_32 red[TRANSFER_FUNC_POINTS];
1410 	struct fixed31_32 green[TRANSFER_FUNC_POINTS];
1411 	struct fixed31_32 blue[TRANSFER_FUNC_POINTS];
1412 
1413 	uint16_t end_exponent;
1414 	uint16_t x_point_at_y1_red;
1415 	uint16_t x_point_at_y1_green;
1416 	uint16_t x_point_at_y1_blue;
1417 };
1418 
1419 enum dc_transfer_func_predefined {
1420 	TRANSFER_FUNCTION_SRGB,
1421 	TRANSFER_FUNCTION_BT709,
1422 	TRANSFER_FUNCTION_PQ,
1423 	TRANSFER_FUNCTION_LINEAR,
1424 	TRANSFER_FUNCTION_UNITY,
1425 	TRANSFER_FUNCTION_HLG,
1426 	TRANSFER_FUNCTION_HLG12,
1427 	TRANSFER_FUNCTION_GAMMA22,
1428 	TRANSFER_FUNCTION_GAMMA24,
1429 	TRANSFER_FUNCTION_GAMMA26
1430 };
1431 
1432 
1433 struct dc_transfer_func {
1434 	struct kref refcount;
1435 	enum dc_transfer_func_type type;
1436 	enum dc_transfer_func_predefined tf;
1437 	/* FP16 1.0 reference level in nits, default is 80 nits, only for PQ*/
1438 	uint32_t sdr_ref_white_level;
1439 	union {
1440 		struct pwl_params pwl;
1441 		struct dc_transfer_func_distributed_points tf_pts;
1442 	};
1443 };
1444 
1445 
1446 union dc_3dlut_state {
1447 	struct {
1448 		uint32_t initialized:1;		/*if 3dlut is went through color module for initialization */
1449 		uint32_t rmu_idx_valid:1;	/*if mux settings are valid*/
1450 		uint32_t rmu_mux_num:3;		/*index of mux to use*/
1451 		uint32_t mpc_rmu0_mux:4;	/*select mpcc on mux, one of the following : mpcc0, mpcc1, mpcc2, mpcc3*/
1452 		uint32_t mpc_rmu1_mux:4;
1453 		uint32_t mpc_rmu2_mux:4;
1454 		uint32_t reserved:15;
1455 	} bits;
1456 	uint32_t raw;
1457 };
1458 
1459 
1460 #define MATRIX_9C__DIM_128_ALIGNED_LEN   16 // 9+8 :  9 * 8 +  7 * 8 = 72  + 56  = 128 % 128 = 0
1461 #define MATRIX_17C__DIM_128_ALIGNED_LEN  32 //17+15:  17 * 8 + 15 * 8 = 136 + 120 = 256 % 128 = 0
1462 #define MATRIX_33C__DIM_128_ALIGNED_LEN  64 //17+47:  17 * 8 + 47 * 8 = 136 + 376 = 512 % 128 = 0
1463 
1464 struct lut_rgb {
1465 	uint16_t b;
1466 	uint16_t g;
1467 	uint16_t r;
1468 	uint16_t padding;
1469 };
1470 
1471 //this structure maps directly to how the lut will read it from memory
1472 struct lut_mem_mapping {
1473 	union {
1474 		//NATIVE MODE 1, 2
1475 		//RGB layout          [b][g][r]      //red  is 128 byte aligned
1476 		//BGR layout          [r][g][b]      //blue is 128 byte aligned
1477 		struct lut_rgb rgb_17c[17][17][MATRIX_17C__DIM_128_ALIGNED_LEN];
1478 		struct lut_rgb rgb_33c[33][33][MATRIX_33C__DIM_128_ALIGNED_LEN];
1479 
1480 		//TRANSFORMED
1481 		uint16_t linear_rgb[(33*33*33*4/128+1)*128];
1482 	};
1483 	uint16_t size;
1484 };
1485 
1486 struct dc_rmcm_3dlut {
1487 	bool isInUse;
1488 	const struct dc_stream_state *stream;
1489 	uint8_t protection_bits;
1490 };
1491 
1492 struct dc_3dlut {
1493 	struct kref refcount;
1494 	struct tetrahedral_params lut_3d;
1495 	struct fixed31_32 hdr_multiplier;
1496 	union dc_3dlut_state state;
1497 };
1498 
1499 /* 3DLUT DMA (Fast Load) params */
1500 struct dc_3dlut_dma {
1501 	struct dc_plane_address addr;
1502 	enum dc_cm_lut_swizzle swizzle;
1503 	enum dc_cm_lut_pixel_format format;
1504 	uint16_t bias; /* FP1.5.10 */
1505 	uint16_t scale; /* FP1.5.10 */
1506 	enum dc_cm_lut_size size;
1507 };
1508 
1509 /* color manager */
1510 union dc_plane_cm_flags {
1511 	unsigned int all;
1512 	struct {
1513 		unsigned int shaper_enable    : 1;
1514 		unsigned int lut3d_enable     : 1;
1515 		unsigned int blend_enable     : 1;
1516 		/* whether legacy (lut3d_func) or DMA is valid */
1517 		unsigned int lut3d_dma_enable : 1;
1518 		/* RMCM lut to be used instead of MCM */
1519 		unsigned int rmcm_enable	 : 1;
1520 		unsigned int reserved: 27;
1521 	} bits;
1522 };
1523 
1524 struct dc_plane_cm {
1525 	struct kref refcount;
1526 	struct dc_transfer_func shaper_func;
1527 	union {
1528 		struct dc_3dlut lut3d_func;
1529 		struct dc_3dlut_dma lut3d_dma;
1530 	};
1531 	struct dc_transfer_func blend_func;
1532 	union dc_plane_cm_flags flags;
1533 };
1534 
1535 /*
1536  * This structure is filled in by dc_surface_get_status and contains
1537  * the last requested address and the currently active address so the called
1538  * can determine if there are any outstanding flips
1539  */
1540 struct dc_plane_status {
1541 	struct dc_plane_address requested_address;
1542 	struct dc_plane_address current_address;
1543 	bool is_flip_pending;
1544 	bool is_right_eye;
1545 	struct cm_hist cm_hist;
1546 };
1547 
1548 struct pipe_update_bits {
1549 	uint32_t addr_update:1;
1550 	uint32_t dcc_change:1;
1551 	uint32_t color_space_change:1;
1552 	uint32_t horizontal_mirror_change:1;
1553 	uint32_t per_pixel_alpha_change:1;
1554 	uint32_t global_alpha_change:1;
1555 	uint32_t hdr_mult:1;
1556 	uint32_t rotation_change:1;
1557 	uint32_t swizzle_change:1;
1558 	uint32_t scaling_change:1;
1559 	uint32_t position_change:1;
1560 	uint32_t in_transfer_func_change:1;
1561 	uint32_t input_csc_change:1;
1562 	uint32_t coeff_reduction_change:1;
1563 	uint32_t pixel_format_change:1;
1564 	uint32_t plane_size_change:1;
1565 	uint32_t gamut_remap_change:1;
1566 	uint32_t cursor_csc_color_matrix_change:1;
1567 	uint32_t new_plane:1;
1568 	uint32_t bpp_change:1;
1569 	uint32_t gamma_change:1;
1570 	uint32_t bandwidth_change:1;
1571 	uint32_t clock_change:1;
1572 	uint32_t stereo_format_change:1;
1573 	uint32_t lut_3d:1;
1574 	uint32_t tmz_changed:1;
1575 	uint32_t mcm_transfer_function_enable_change:1; /* disable or enable MCM transfer func */
1576 	uint32_t full_update:1;
1577 	uint32_t sdr_white_level_nits:1;
1578 	uint32_t cm_hist_change:1;
1579 	/* NOTE: When adding a new field, also update:
1580 	 *   - dc_pipe_update_bits_set_full()
1581 	 *   - dc_pipe_update_bits_is_any_set()
1582 	 */
1583 };
1584 
1585 static inline void dc_pipe_update_bits_clear(struct pipe_update_bits *flags)
1586 {
1587 	/* memset ensures padding bits are zeroed */
1588 	memset(flags, 0, sizeof(*flags));
1589 }
1590 
1591 static inline void dc_pipe_update_bits_set_full(struct pipe_update_bits *flags)
1592 {
1593 	dc_pipe_update_bits_clear(flags);
1594 	flags->addr_update = 1;
1595 	flags->dcc_change = 1;
1596 	flags->color_space_change = 1;
1597 	flags->horizontal_mirror_change = 1;
1598 	flags->per_pixel_alpha_change = 1;
1599 	flags->global_alpha_change = 1;
1600 	flags->hdr_mult = 1;
1601 	flags->rotation_change = 1;
1602 	flags->swizzle_change = 1;
1603 	flags->scaling_change = 1;
1604 	flags->position_change = 1;
1605 	flags->in_transfer_func_change = 1;
1606 	flags->input_csc_change = 1;
1607 	flags->coeff_reduction_change = 1;
1608 	flags->pixel_format_change = 1;
1609 	flags->plane_size_change = 1;
1610 	flags->gamut_remap_change = 1;
1611 	flags->cursor_csc_color_matrix_change = 1;
1612 	flags->new_plane = 1;
1613 	flags->bpp_change = 1;
1614 	flags->gamma_change = 1;
1615 	flags->bandwidth_change = 1;
1616 	flags->clock_change = 1;
1617 	flags->stereo_format_change = 1;
1618 	flags->lut_3d = 1;
1619 	flags->tmz_changed = 1;
1620 	flags->mcm_transfer_function_enable_change = 1;
1621 	flags->full_update = 1;
1622 	flags->sdr_white_level_nits = 1;
1623 	flags->cm_hist_change = 1;
1624 }
1625 
1626 static inline bool dc_pipe_update_bits_is_any_set(const struct pipe_update_bits *flags)
1627 {
1628 	return flags->addr_update ||
1629 		flags->dcc_change ||
1630 		flags->color_space_change ||
1631 		flags->horizontal_mirror_change ||
1632 		flags->per_pixel_alpha_change ||
1633 		flags->global_alpha_change ||
1634 		flags->hdr_mult ||
1635 		flags->rotation_change ||
1636 		flags->swizzle_change ||
1637 		flags->scaling_change ||
1638 		flags->position_change ||
1639 		flags->in_transfer_func_change ||
1640 		flags->input_csc_change ||
1641 		flags->coeff_reduction_change ||
1642 		flags->pixel_format_change ||
1643 		flags->plane_size_change ||
1644 		flags->gamut_remap_change ||
1645 		flags->cursor_csc_color_matrix_change ||
1646 		flags->new_plane ||
1647 		flags->bpp_change ||
1648 		flags->gamma_change ||
1649 		flags->bandwidth_change ||
1650 		flags->clock_change ||
1651 		flags->stereo_format_change ||
1652 		flags->lut_3d ||
1653 		flags->tmz_changed ||
1654 		flags->mcm_transfer_function_enable_change ||
1655 		flags->full_update ||
1656 		flags->sdr_white_level_nits ||
1657 		flags->cm_hist_change;
1658 }
1659 
1660 bool dc_check_address_only_update(struct pipe_update_bits update_bits);
1661 
1662 #define DC_REMOVE_PLANE_POINTERS 1
1663 
1664 struct dc_plane_state {
1665 	struct dc_plane_address address;
1666 	struct dc_plane_flip_time time;
1667 	bool triplebuffer_flips;
1668 	struct scaling_taps scaling_quality;
1669 	struct rect src_rect;
1670 	struct rect dst_rect;
1671 	struct rect clip_rect;
1672 
1673 	struct plane_size plane_size;
1674 	struct dc_tiling_info tiling_info;
1675 
1676 	struct dc_plane_dcc_param dcc;
1677 
1678 	struct dc_gamma gamma_correction;
1679 	struct dc_transfer_func in_transfer_func;
1680 	struct dc_bias_and_scale bias_and_scale;
1681 	struct dc_csc_transform input_csc_color_matrix;
1682 	struct fixed31_32 coeff_reduction_factor;
1683 	struct fixed31_32 hdr_mult;
1684 	struct colorspace_transform gamut_remap_matrix;
1685 
1686 	enum dc_color_space color_space;
1687 
1688 #ifndef TRIM_CM2
1689 	// TODO: No longer used, remove
1690 	struct dc_hdr_static_metadata hdr_static_ctx;
1691 
1692 	struct dc_3dlut lut3d_func;
1693 	struct dc_transfer_func in_shaper_func;
1694 	struct dc_transfer_func blend_tf;
1695 	enum dc_cm2_shaper_3dlut_setting mcm_shaper_3dlut_setting;
1696 	bool mcm_lut1d_enable;
1697 	struct dc_cm2_func_luts mcm_luts;
1698 #endif /* TRIM_CM2 */
1699 	bool lut_bank_a;
1700 	enum mpcc_movable_cm_location mcm_location;
1701 	struct dc_plane_cm cm;
1702 
1703 	struct dc_transfer_func *gamcor_tf;
1704 	enum surface_pixel_format format;
1705 	enum dc_rotation_angle rotation;
1706 	enum plane_stereo_format stereo_format;
1707 
1708 	bool is_tiling_rotated;
1709 	bool per_pixel_alpha;
1710 	bool pre_multiplied_alpha;
1711 	bool global_alpha;
1712 	int  global_alpha_value;
1713 	bool visible;
1714 	bool flip_immediate;
1715 	bool horizontal_mirror;
1716 	unsigned int layer_index;
1717 
1718 	struct pipe_update_bits update_bits;
1719 	bool flip_int_enabled;
1720 	bool skip_manual_trigger;
1721 
1722 	/* private to DC core */
1723 	struct dc_plane_status status;
1724 	struct dc_context *ctx;
1725 
1726 	/* HACK: Workaround for forcing full reprogramming under some conditions */
1727 	bool force_full_update;
1728 
1729 	bool is_phantom; // TODO: Change mall_stream_config into mall_plane_config instead
1730 
1731 	/* private to dc_surface.c */
1732 	enum dc_irq_source irq_source;
1733 	struct kref refcount;
1734 	struct tg_color visual_confirm_color;
1735 
1736 	bool is_statically_allocated;
1737 	enum chroma_cositing cositing;
1738 	struct dc_csc_transform cursor_csc_color_matrix;
1739 	bool adaptive_sharpness_en;
1740 	int adaptive_sharpness_policy;
1741 	unsigned int sharpness_level;
1742 	enum linear_light_scaling linear_light_scaling;
1743 	unsigned int sdr_white_level_nits;
1744 	struct cm_hist_control cm_hist_control;
1745 	struct spl_sharpness_range sharpness_range;
1746 	enum sharpness_range_source sharpness_source;
1747 };
1748 
1749 struct dc_plane_info {
1750 	struct plane_size plane_size;
1751 	struct dc_tiling_info tiling_info;
1752 	struct dc_plane_dcc_param dcc;
1753 	enum surface_pixel_format format;
1754 	enum dc_rotation_angle rotation;
1755 	enum plane_stereo_format stereo_format;
1756 	enum dc_color_space color_space;
1757 	bool horizontal_mirror;
1758 	bool visible;
1759 	bool per_pixel_alpha;
1760 	bool pre_multiplied_alpha;
1761 	bool global_alpha;
1762 	int  global_alpha_value;
1763 	bool input_csc_enabled;
1764 	unsigned int layer_index;
1765 	enum chroma_cositing cositing;
1766 };
1767 
1768 #include "dc_stream.h"
1769 
1770 struct dc_scratch_space {
1771 	/* used to temporarily backup plane states of a stream during
1772 	 * dc update. The reason is that plane states are overwritten
1773 	 * with surface updates in dc update. Once they are overwritten
1774 	 * current state is no longer valid. We want to temporarily
1775 	 * store current value in plane states so we can still recover
1776 	 * a valid current state during dc update.
1777 	 */
1778 	struct dc_plane_state plane_states[MAX_SURFACES];
1779 
1780 	struct dc_stream_state stream_state;
1781 };
1782 
1783 /*
1784  * A link contains one or more sinks and their connected status.
1785  * The currently active signal type (HDMI, DP-SST, DP-MST) is also reported.
1786  */
1787  struct dc_link {
1788 	struct dc_sink *remote_sinks[MAX_SINKS_PER_LINK];
1789 	unsigned int sink_count;
1790 	struct dc_sink *local_sink;
1791 	unsigned int link_index;
1792 	enum dc_connection_type type;
1793 	enum signal_type connector_signal;
1794 	enum dc_irq_source irq_source_hpd;
1795 	enum dc_irq_source irq_source_hpd_rx;/* aka DP Short Pulse  */
1796 	enum dc_irq_source irq_source_read_request;/* Read Request */
1797 
1798 	bool is_hpd_filter_disabled;
1799 	bool dp_ss_off;
1800 
1801 	/**
1802 	 * @link_state_valid:
1803 	 *
1804 	 * If there is no link and local sink, this variable should be set to
1805 	 * false. Otherwise, it should be set to true; usually, the function
1806 	 * core_link_enable_stream sets this field to true.
1807 	 */
1808 	bool link_state_valid;
1809 	bool aux_access_disabled;
1810 	bool sync_lt_in_progress;
1811 	bool skip_stream_reenable;
1812 	bool is_internal_display;
1813 	/** @todo Rename. Flag an endpoint as having a programmable mapping to a DIG encoder. */
1814 	bool is_dig_mapping_flexible;
1815 	bool hpd_status; /* HPD status of link without physical HPD pin. */
1816 	bool is_hpd_pending; /* Indicates a new received hpd */
1817 
1818 	/* USB4 DPIA links skip verifying link cap, instead performing the fallback method
1819 	 * for every link training. This is incompatible with DP LL compliance automation,
1820 	 * which expects the same link settings to be used every retry on a link loss.
1821 	 * This flag is used to skip the fallback when link loss occurs during automation.
1822 	 */
1823 	bool skip_fallback_on_link_loss;
1824 
1825 	bool edp_sink_present;
1826 
1827 	struct dp_trace dp_trace;
1828 	volatile bool is_link_locked;
1829 
1830 	/* caps is the same as reported_link_cap. link_traing use
1831 	 * reported_link_cap. Will clean up.  TODO
1832 	 */
1833 	struct dc_link_settings reported_link_cap;
1834 	struct dc_link_settings verified_link_cap;
1835 	struct dc_link_settings cur_link_settings;
1836 	struct dc_lane_settings cur_lane_setting[LANE_COUNT_DP_MAX];
1837 	struct dc_link_settings preferred_link_setting;
1838 	/* preferred_training_settings are override values that
1839 	 * come from DM. DM is responsible for the memory
1840 	 * management of the override pointers.
1841 	 */
1842 	struct dc_link_training_overrides preferred_training_settings;
1843 	struct dc_hdmi_frl_link_training_overrides preferred_hdmi_frl_settings;
1844 	struct dp_audio_test_data audio_test_data;
1845 
1846 	/* On ASICs with dp_connector_no_native_i2c cap set and no_ddc_pin cap
1847 	 * set by IFWI, link aux_hw_inst is used in aux layer functions instead
1848 	 * of ddc_pin to know which aux instance is associated with link.
1849 	 */
1850 	bool no_ddc_pin;
1851 	/** When set, forces all native I2C communication on this DP connector
1852 	 *  to use the I2C-over-AUX protocol instead of native I2C signaling.
1853 	 */
1854 	bool force_to_use_aux;
1855 	enum gpio_ddc_line aux_hw_inst;
1856 
1857 	enum gpio_ddc_line ddc_hw_inst;
1858 
1859 	uint8_t hpd_src;
1860 
1861 	uint8_t link_enc_hw_inst;
1862 	/* DIG link encoder ID. Used as index in link encoder resource pool.
1863 	 * For links with fixed mapping to DIG, this is not changed after dc_link
1864 	 * object creation.
1865 	 */
1866 	enum engine_id eng_id;
1867 	enum engine_id dpia_preferred_eng_id;
1868 
1869 	bool test_pattern_enabled;
1870 	/* Pending/Current test pattern are only used to perform and track
1871 	 * FIXED_VS retimer test pattern/lane adjustment override state.
1872 	 * Pending allows link HWSS to differentiate PHY vs non-PHY pattern,
1873 	 * to perform specific lane adjust overrides before setting certain
1874 	 * PHY test patterns. In cases when lane adjust and set test pattern
1875 	 * calls are not performed atomically (i.e. performing link training),
1876 	 * pending_test_pattern will be invalid or contain a non-PHY test pattern
1877 	 * and current_test_pattern will contain required context for any future
1878 	 * set pattern/set lane adjust to transition between override state(s).
1879 	 * */
1880 	enum dp_test_pattern current_test_pattern;
1881 	enum dp_test_pattern pending_test_pattern;
1882 
1883 	union compliance_test_state compliance_test_state;
1884 
1885 	void *priv;
1886 
1887 	struct ddc_service *ddc;
1888 
1889 	enum dp_panel_mode panel_mode;
1890 	bool aux_mode;
1891 
1892 	/* Private to DC core */
1893 
1894 	const struct dc *dc;
1895 
1896 	struct dc_context *ctx;
1897 
1898 	struct panel_cntl *panel_cntl;
1899 	struct link_encoder *link_enc;
1900 	struct hpo_frl_link_encoder *hpo_frl_link_enc;
1901 	struct dc_hdmi_frl_link_settings frl_reported_link_cap;
1902 	struct dc_hdmi_frl_link_settings frl_verified_link_cap;
1903 	struct dc_hdmi_frl_link_settings frl_link_settings;
1904 	struct dc_hdmi_frl_flags frl_flags;
1905 	union hdmi_idcc_cable_id hdmi_cable_id;
1906 	struct graphics_object_id link_id;
1907 
1908 	/* External encoder eg. NUTMEG or TRAVIS used on CIK APUs. */
1909 	struct graphics_object_id ext_enc_id;
1910 
1911 	/* Endpoint type distinguishes display endpoints which do not have entries
1912 	 * in the BIOS connector table from those that do. Helps when tracking link
1913 	 * encoder to display endpoint assignments.
1914 	 */
1915 	enum display_endpoint_type ep_type;
1916 	union ddi_channel_mapping ddi_channel_mapping;
1917 	struct connector_device_tag_info device_tag;
1918 	struct dpcd_caps dpcd_caps;
1919 	uint32_t dongle_max_pix_clk;
1920 	unsigned short chip_caps;
1921 	unsigned int dpcd_sink_count;
1922 	struct hdcp_caps hdcp_caps;
1923 	enum edp_revision edp_revision;
1924 	union dpcd_sink_ext_caps dpcd_sink_ext_caps;
1925 
1926 	struct psr_settings psr_settings;
1927 	struct replay_settings replay_settings;
1928 
1929 	/* Drive settings read from integrated info table */
1930 	struct dc_lane_settings bios_forced_drive_settings;
1931 
1932 	/* Vendor specific LTTPR workaround variables */
1933 	uint8_t vendor_specific_lttpr_link_rate_wa;
1934 	bool apply_vendor_specific_lttpr_link_rate_wa;
1935 
1936 	/* MST record stream using this link */
1937 	struct link_flags {
1938 		bool dp_keep_receiver_powered;
1939 		bool dp_skip_DID2;
1940 		bool dp_skip_reset_segment;
1941 		bool dp_skip_fs_144hz;
1942 		/* Some DP bridges don't work with RBR and must use HBR. */
1943 		bool dp_skip_rbr;
1944 		bool dp_mot_reset_segment;
1945 		/* Some USB4 docks do not handle turning off MST DSC once it has been enabled. */
1946 		bool dpia_mst_dsc_always_on;
1947 		/* Forced DPIA into TBT3 compatibility mode. */
1948 		bool dpia_forced_tbt3_mode;
1949 		bool dongle_mode_timing_override;
1950 		bool blank_stream_on_ocs_change;
1951 		bool read_dpcd204h_on_irq_hpd;
1952 		bool force_dp_ffe_preset;
1953 		bool skip_phy_ssc_reduction;
1954 	} wa_flags;
1955 	union dc_dp_ffe_preset forced_dp_ffe_preset;
1956 	struct link_mst_stream_allocation_table mst_stream_alloc_table;
1957 
1958 	struct dc_link_status link_status;
1959 	struct dprx_states dprx_states;
1960 
1961 	enum dc_link_fec_state fec_state;
1962 	bool is_dds;
1963 	bool is_display_mux_present;
1964 	bool link_powered_externally;	// Used to bypass hardware sequencing delays when panel is powered down forcibly
1965 
1966 	struct dc_panel_config panel_config;
1967 	enum dc_panel_type panel_type;
1968 	struct phy_state phy_state;
1969 	uint32_t phy_transition_bitmask;
1970 	// BW ALLOCATON USB4 ONLY
1971 	struct dc_dpia_bw_alloc dpia_bw_alloc_config;
1972 	bool skip_implict_edp_power_control;
1973 	enum backlight_control_type backlight_control_type;
1974 };
1975 
1976 struct dc {
1977 	struct dc_debug_options debug;
1978 	struct dc_versions versions;
1979 	struct dc_caps caps;
1980 	struct dc_check_config check_config;
1981 	struct dc_cap_funcs cap_funcs;
1982 	struct dc_config config;
1983 	struct dc_bounding_box_overrides bb_overrides;
1984 	struct dc_bug_wa work_arounds;
1985 	struct dc_context *ctx;
1986 	struct dc_phy_addr_space_config vm_pa_config;
1987 
1988 	uint8_t link_count;
1989 	struct dc_link *links[MAX_LINKS];
1990 	uint8_t lowest_dpia_link_index;
1991 	struct link_service *link_srv;
1992 
1993 	struct dc_state *current_state;
1994 	struct resource_pool *res_pool;
1995 
1996 	/**
1997 	 * @update_scratch_pool: Per-commit scratch buffers for dc_update_state.
1998 	 */
1999 	struct dc_update_scratch_space *update_scratch_pool[MAX_STREAMS + 1];
2000 	bool update_scratch_in_use[MAX_STREAMS + 1];
2001 
2002 	struct clk_mgr *clk_mgr;
2003 
2004 	/* Display Engine Clock levels */
2005 	struct dm_pp_clock_levels sclk_lvls;
2006 
2007 	/* Inputs into BW and WM calculations. */
2008 	struct bw_calcs_dceip *bw_dceip;
2009 	struct bw_calcs_vbios *bw_vbios;
2010 	struct dcn_soc_bounding_box *dcn_soc;
2011 	struct dcn_ip_params *dcn_ip;
2012 	struct display_mode_lib dml;
2013 
2014 	/* HW functions */
2015 	struct hw_sequencer_funcs hwss;
2016 	struct dce_hwseq *hwseq;
2017 
2018 	/* Require to optimize clocks and bandwidth for added/removed planes */
2019 	bool optimized_required;
2020 	bool idle_optimizations_allowed;
2021 	bool enable_c20_dtm_b0;
2022 
2023 	/* Require to maintain clocks and bandwidth for UEFI enabled HW */
2024 
2025 	/* For eDP to know the switching state of SmartMux */
2026 	bool is_switch_in_progress_orig;
2027 	bool is_switch_in_progress_dest;
2028 
2029 	/* FBC compressor */
2030 	struct compressor *fbc_compressor;
2031 
2032 	struct dc_debug_data debug_data;
2033 	struct dpcd_vendor_signature vendor_signature;
2034 
2035 	const char *build_id;
2036 	struct vm_helper *vm_helper;
2037 
2038 	uint32_t *dcn_reg_offsets;
2039 	uint32_t *nbio_reg_offsets;
2040 	uint32_t *clk_reg_offsets;
2041 
2042 	/* Scratch memory */
2043 	struct {
2044 		struct {
2045 			/*
2046 			 * For matching clock_limits table in driver with table
2047 			 * from PMFW.
2048 			 */
2049 			struct _vcs_dpi_voltage_scaling_st clock_limits[DC__VOLTAGE_STATES];
2050 		} update_bw_bounding_box;
2051 		struct dc_scratch_space current_state;
2052 		struct dc_scratch_space new_state;
2053 		struct dc_stream_state temp_stream; // Used so we don't need to allocate stream on the stack
2054 		struct dc_link temp_link;
2055 		bool pipes_to_unlock_first[MAX_PIPES]; /* Any of the pipes indicated here should be unlocked first */
2056 	} scratch;
2057 
2058 	struct dml2_configuration_options dml2_options;
2059 	struct dml2_configuration_options dml2_dc_power_options;
2060 	enum dc_acpi_cm_power_state power_state;
2061 	struct soc_and_ip_translator *soc_and_ip_translator;
2062 };
2063 
2064 struct dc_scaling_info {
2065 	struct rect src_rect;
2066 	struct rect dst_rect;
2067 	struct rect clip_rect;
2068 	struct scaling_taps scaling_quality;
2069 };
2070 
2071 struct dc_fast_update {
2072 	const struct dc_flip_addrs *flip_addr;
2073 	const struct dc_gamma *gamma;
2074 	const struct colorspace_transform *gamut_remap_matrix;
2075 	const struct dc_csc_transform *input_csc_color_matrix;
2076 	const struct fixed31_32 *coeff_reduction_factor;
2077 	struct dc_transfer_func *out_transfer_func;
2078 	struct dc_csc_transform *output_csc_transform;
2079 	const struct dc_csc_transform *cursor_csc_color_matrix;
2080 	struct cm_hist_control *cm_hist_control;
2081 	/* stream-level fast updates */
2082 	const struct colorspace_transform *gamut_remap;
2083 	const struct dc_cursor_attributes *cursor_attributes;
2084 	const struct dc_cursor_position *cursor_position;
2085 	const struct periodic_interrupt_config *periodic_interrupt;
2086 	const enum dc_dither_option *dither_option;
2087 	struct dc_info_packet *vrr_infopacket;
2088 	struct dc_info_packet *vsc_infopacket;
2089 	struct dc_info_packet *vsp_infopacket;
2090 	struct dc_info_packet *hfvsif_infopacket;
2091 	struct dc_info_packet *vtem_infopacket;
2092 	struct dc_info_packet *adaptive_sync_infopacket;
2093 	struct dc_info_packet *avi_infopacket;
2094 	struct dc_info_packet *hdr_static_metadata;
2095 };
2096 
2097 struct dc_surface_update {
2098 	struct dc_plane_state *surface;
2099 
2100 	/* isr safe update parameters.  null means no updates */
2101 	const struct dc_flip_addrs *flip_addr;
2102 	const struct dc_plane_info *plane_info;
2103 	const struct dc_scaling_info *scaling_info;
2104 	struct fixed31_32 hdr_mult;
2105 	/* following updates require alloc/sleep/spin that is not isr safe,
2106 	 * null means no updates
2107 	 */
2108 	const struct dc_gamma *gamma;
2109 	const struct dc_transfer_func *in_transfer_func;
2110 
2111 	const struct dc_csc_transform *input_csc_color_matrix;
2112 	const struct fixed31_32 *coeff_reduction_factor;
2113 	const struct colorspace_transform *gamut_remap_matrix;
2114 	const struct dc_plane_cm *cm;
2115 	const struct dc_csc_transform *cursor_csc_color_matrix;
2116 	unsigned int sdr_white_level_nits;
2117 	struct dc_bias_and_scale bias_and_scale;
2118 	struct cm_hist_control *cm_hist_control;
2119 };
2120 
2121 struct dc_state_update {
2122 	struct dc_stream_state   *stream;
2123 	struct dc_stream_update  *stream_update;
2124 	struct dc_surface_update *surface_updates;
2125 	int                       surface_count;
2126 	const struct dc_probe_updates *probe_updates;
2127 };
2128 
2129 /**
2130  * dc_check_state_update() - Classify an update without committing it.
2131  * @check_config: DC check configuration
2132  * @updates:      root update object to classify
2133  *
2134  * Return: descriptor indicating update type and required lock scope.
2135  */
2136 struct dc_update_descriptor dc_check_state_update(
2137 		const struct dc_check_config *check_config,
2138 		const struct dc_state_update *updates);
2139 
2140 /**
2141  * dc_update_state - Commit an absolute dc_state_update.
2142  * @dc:      DC structure
2143  * @updates: root update object carrying stream, plane, and probe updates
2144  *
2145  * Return: true on success, false on failure.
2146  */
2147 bool dc_update_state(struct dc *dc, const struct dc_state_update *updates);
2148 
2149 struct dc_update_scratch_space;
2150 
2151 /**
2152  * dc_update_state_init - Acquire and initialise a commit scratch buffer.
2153  * @dc:      DC structure
2154  * @updates: update descriptor; validated before the slot is acquired
2155  *
2156  * Return: a scratch slot on success, NULL if validation fails or the pool
2157  * is exhausted. The slot must be released via dc_update_state_cleanup() on
2158  * success, or automatically by dc_update_state_prepare() on failure.
2159  */
2160 struct dc_update_scratch_space *dc_update_state_init(
2161 		struct dc *dc,
2162 		const struct dc_state_update *updates
2163 );
2164 
2165 /**
2166  * dc_update_state_prepare - Prepare the commit under the global lock.
2167  * @scratch: commit scratch from dc_update_state_init()
2168  *
2169  * On failure the scratch slot is released and false is returned; the caller
2170  * must not call execute or cleanup.
2171  */
2172 bool dc_update_state_prepare(struct dc_update_scratch_space *scratch);
2173 
2174 /**
2175  * dc_update_state_execute - Program hardware; called without the global lock.
2176  * @scratch: commit scratch from dc_update_state_init()
2177  */
2178 void dc_update_state_execute(const struct dc_update_scratch_space *scratch);
2179 
2180 /**
2181  * dc_update_state_cleanup - Finalise the commit and release the scratch slot.
2182  * @scratch: commit scratch from dc_update_state_init()
2183  *
2184  * Must be called with the global lock held. Returns true if the caller must
2185  * loop back to prepare (SEAMLESS continuation).
2186  */
2187 bool dc_update_state_cleanup(struct dc_update_scratch_space *scratch);
2188 
2189 /**
2190  * struct dc_probe_latencies - min/max/avg memory latency in ns.
2191  * @max_latency_ns: maximum latency in nanoseconds
2192  * @avg_latency_ns: average latency in nanoseconds
2193  * @min_latency_ns: minimum latency in nanoseconds
2194  */
2195 struct dc_probe_latencies {
2196 	uint32_t max_latency_ns;
2197 	uint32_t avg_latency_ns;
2198 	uint32_t min_latency_ns;
2199 };
2200 
2201 /**
2202  * struct dc_probe_status - results for a probe.
2203  * @valid: true if a measurement was latched.
2204  * @type: type of the probe that produced this result.
2205  * @u.bandwidth_mbps:         peak BW in Mbps (DC_PROBE_PEAK_MEM_BW).
2206  * @u.latency:                min/max/avg memory latency in ns (DC_PROBE_MEM_LATENCY),
2207  *                            stored as struct dc_probe_latencies.
2208  * @u.urgent_assertion_count: number of urgent assertion events (DC_PROBE_URGENT_ASSERTION_COUNT).
2209  * @u.prefetch_data_size:     total prefetch data in bytes (DC_PROBE_PREFETCH_DATA_SIZE).
2210  */
2211 struct dc_probe_status {
2212 	bool                       valid;
2213 	enum dc_probe_type         type;
2214 	union {
2215 		uint32_t bandwidth_mbps;
2216 		struct dc_probe_latencies latency;
2217 		uint32_t urgent_assertion_count;
2218 		uint32_t prefetch_data_size;
2219 	} u;
2220 };
2221 
2222 /**
2223  * enum dc_get_status_type - Bitmask selecting which status classes to populate.
2224  * @DC_GET_STATUS_STREAM: populate stream_status fields in dc_state_status
2225  * @DC_GET_STATUS_PROBE:  populate probe_status fields in dc_state_status
2226  */
2227 enum dc_get_status_type {
2228 	DC_GET_STATUS_STREAM = (1u << 0),
2229 	DC_GET_STATUS_PROBE  = (1u << 1),
2230 };
2231 
2232 /**
2233  * struct dc_get_status_options - Input selector for dc_state_get_status.
2234  * @state:  source state to read status from
2235  * @types:  OR of dc_get_status_type values selecting classes to populate
2236  * @stream: optional stream filter for DC_GET_STATUS_STREAM. NULL means
2237  *          populate status for all streams in the state
2238  * @probe:  optional probe filter for DC_GET_STATUS_PROBE. NULL means
2239  *          populate status for all probes in the state
2240  */
2241 struct dc_get_status_options {
2242 	struct dc_state              *state;
2243 	uint32_t                      types;
2244 	const struct dc_stream_state *stream;
2245 	const struct dc_probe_state  *probe;
2246 };
2247 
2248 /**
2249  * struct dc_state_status - Output-only status object from dc_state_get_status.
2250  * @stream_count: number of valid entries in stream_status (DC_GET_STATUS_STREAM)
2251  * @stream_status: pointers to live per-stream status entries
2252  * @probe_count: number of valid entries in probe_status (DC_GET_STATUS_PROBE)
2253  * @probe_status: pointers to live per-probe status entries
2254  */
2255 struct dc_state_status {
2256 	int                     stream_count;
2257 	struct dc_stream_status *stream_status[MAX_STREAMS];
2258 	int                     probe_count;
2259 	struct dc_probe_status *probe_status[MAX_PROBES];
2260 };
2261 
2262 /**
2263  * dc_state_get_status - Unified status readback for dc_state.
2264  * @status:  output object populated according to options->types
2265  * @options: selects the source state, status classes to fill, and filters
2266  *
2267  * Return: DC_OK on success, DC_ERROR_UNEXPECTED if state is NULL.
2268  */
2269 enum dc_status dc_state_get_status(struct dc_state_status *status,
2270 		const struct dc_get_status_options *options);
2271 
2272 struct dc_underflow_debug_data {
2273 	struct dcn_hubbub_reg_state *hubbub_reg_state;
2274 	struct dcn_hubp_reg_state *hubp_reg_state[MAX_PIPES];
2275 	struct dcn_dpp_reg_state *dpp_reg_state[MAX_PIPES];
2276 	struct dcn_mpc_reg_state *mpc_reg_state[MAX_PIPES];
2277 	struct dcn_opp_reg_state *opp_reg_state[MAX_PIPES];
2278 	struct dcn_dsc_reg_state *dsc_reg_state[MAX_PIPES];
2279 	struct dcn_optc_reg_state *optc_reg_state[MAX_PIPES];
2280 	struct dcn_dccg_reg_state *dccg_reg_state[MAX_PIPES];
2281 };
2282 
2283 struct power_features {
2284 	bool ips;
2285 	bool rcg;
2286 	bool replay;
2287 	bool dds;
2288 	bool sprs;
2289 	bool psr;
2290 	bool fams;
2291 	bool mpo;
2292 	bool uclk_p_state;
2293 };
2294 
2295 /*
2296  * Create a new surface with default parameters;
2297  */
2298 void dc_gamma_retain(struct dc_gamma *dc_gamma);
2299 void dc_gamma_release(struct dc_gamma **dc_gamma);
2300 struct dc_gamma *dc_create_gamma(void);
2301 
2302 void dc_transfer_func_retain(struct dc_transfer_func *dc_tf);
2303 void dc_transfer_func_release(struct dc_transfer_func *dc_tf);
2304 struct dc_transfer_func *dc_create_transfer_func(void);
2305 
2306 struct dc_3dlut *dc_create_3dlut_func(void);
2307 void dc_3dlut_func_release(struct dc_3dlut *lut);
2308 void dc_3dlut_func_retain(struct dc_3dlut *lut);
2309 
2310 struct dc_plane_cm *dc_plane_cm_create(void);
2311 void dc_plane_cm_release(struct dc_plane_cm *cm);
2312 void dc_plane_cm_retain(struct dc_plane_cm *cm);
2313 
2314 void dc_post_update_surfaces_to_stream(
2315 		struct dc *dc);
2316 
2317 /*
2318  * dc_get_default_tiling_info() - Retrieve an ASIC-appropriate default tiling
2319  * description for (typically) linear surfaces.
2320  *
2321  * This is used by OS/DM paths that need a valid, fully-initialized tiling
2322  * description without hardcoding gfx-version specifics in the caller.
2323  */
2324 void dc_get_default_tiling_info(const struct dc *dc, struct dc_tiling_info *tiling_info);
2325 
2326 /**
2327  * struct dc_validation_stream - Per-stream surface/stream association for validation
2328  */
2329 struct dc_validation_stream {
2330 	/**
2331 	 * @stream: Stream state properties
2332 	 */
2333 	struct dc_stream_state *stream;
2334 
2335 	/**
2336 	 * @plane_states: Surface state
2337 	 */
2338 	struct dc_plane_state *plane_states[MAX_SURFACES];
2339 
2340 	/**
2341 	 * @plane_count: Total of active planes
2342 	 */
2343 	uint8_t plane_count;
2344 };
2345 
2346 /**
2347  * struct dc_validation_set - Root validation input grouping all streams for a commit
2348  */
2349 struct dc_validation_set {
2350 	/**
2351 	 * @streams: Per-stream entries (stream + its planes)
2352 	 */
2353 	struct dc_validation_stream streams[MAX_STREAMS];
2354 
2355 	/**
2356 	 * @stream_count: Number of active entries in @streams
2357 	 */
2358 	uint8_t stream_count;
2359 
2360 	/**
2361 	 * @probes: Global probe descriptors to validate alongside the streams
2362 	 */
2363 	struct dc_probe_state probes[MAX_PROBES];
2364 
2365 	/**
2366 	 * @probe_count: Number of active entries in @probes
2367 	 */
2368 	uint8_t probe_count;
2369 };
2370 
2371 bool dc_validate_boot_timing(const struct dc *dc,
2372 				const struct dc_sink *sink,
2373 				struct dc_crtc_timing *crtc_timing);
2374 
2375 enum dc_status dc_validate_plane(struct dc *dc, const struct dc_plane_state *plane_state);
2376 
2377 enum dc_status dc_validate_with_context(struct dc *dc,
2378 					const struct dc_validation_set *set,
2379 					struct dc_state *context,
2380 					enum dc_validate_mode validate_mode);
2381 
2382 bool dc_set_generic_gpio_for_stereo(bool enable,
2383 		struct gpio_service *gpio_service);
2384 
2385 enum dc_status dc_validate_global_state(
2386 		struct dc *dc,
2387 		struct dc_state *new_ctx,
2388 		enum dc_validate_mode validate_mode);
2389 
2390 bool dc_acquire_release_mpc_3dlut(
2391 		struct dc *dc, bool acquire,
2392 		struct dc_stream_state *stream,
2393 		struct dc_3dlut **lut,
2394 		struct dc_transfer_func **shaper);
2395 
2396 bool dc_resource_is_dsc_encoding_supported(const struct dc *dc);
2397 void get_audio_check(struct audio_info *aud_modes,
2398 	struct audio_check *aud_chk);
2399 
2400 bool fast_nonaddr_updates_exist(struct dc_fast_update *fast_update, int surface_count);
2401 void populate_fast_updates(struct dc_fast_update *fast_update,
2402 		struct dc_surface_update *srf_updates,
2403 		int surface_count,
2404 		struct dc_stream_update *stream_update);
2405 /*
2406  * Set up streams and links associated to drive sinks
2407  * The streams parameter is an absolute set of all active streams.
2408  *
2409  * After this call:
2410  *   Phy, Encoder, Timing Generator are programmed and enabled.
2411  *   New streams are enabled with blank stream; no memory read.
2412  */
2413 enum dc_status dc_commit_streams(struct dc *dc, struct dc_commit_streams_params *params);
2414 
2415 
2416 struct dc_plane_state *dc_get_surface_for_mpcc(struct dc *dc,
2417 		struct dc_stream_state *stream,
2418 		int mpcc_inst);
2419 
2420 
2421 uint32_t dc_get_opp_for_plane(struct dc *dc, struct dc_plane_state *plane);
2422 bool dc_set_fva_vrr_adjust(struct dc *dc,
2423 	struct dc_stream_state *stream,
2424 	struct fva_adj *fva_adj,
2425 	struct dc_crtc_timing_adjust *vrr_adj);
2426 
2427 int dc_get_hw_max_fva_factor(struct dc *dc,
2428 		struct dc_stream_state *stream,
2429 		unsigned int max_pixel_clock);
2430 
2431 void dc_set_vstartup_start(struct dc *dc,
2432 		struct dc_stream_state *stream);
2433 
2434 void dc_set_disable_128b_132b_stream_overhead(bool disable);
2435 
2436 /* The function returns minimum bandwidth required to drive a given timing
2437  * return - minimum required timing bandwidth in kbps.
2438  */
2439 uint32_t dc_bandwidth_in_kbps_from_timing(
2440 		const struct dc_crtc_timing *timing,
2441 		const enum dc_link_encoding_format link_encoding);
2442 
2443 /* Link Interfaces */
2444 /* Return an enumerated dc_link.
2445  * dc_link order is constant and determined at
2446  * boot time.  They cannot be created or destroyed.
2447  * Use dc_get_caps() to get number of links.
2448  */
2449 struct dc_link *dc_get_link_at_index(struct dc *dc, uint32_t link_index);
2450 
2451 /* Return instance id of the edp link. Inst 0 is primary edp link. */
2452 bool dc_get_edp_link_panel_inst(const struct dc *dc,
2453 		const struct dc_link *link,
2454 		unsigned int *inst_out);
2455 
2456 /* Return an array of link pointers to edp links. */
2457 void dc_get_edp_links(const struct dc *dc,
2458 		struct dc_link **edp_links,
2459 		unsigned int *edp_num);
2460 
2461 void dc_set_edp_power(const struct dc *dc, struct dc_link *edp_link,
2462 				 bool powerOn);
2463 
2464 /* The function initiates detection handshake over the given link. It first
2465  * determines if there are display connections over the link. If so it initiates
2466  * detection protocols supported by the connected receiver device. The function
2467  * contains protocol specific handshake sequences which are sometimes mandatory
2468  * to establish a proper connection between TX and RX. So it is always
2469  * recommended to call this function as the first link operation upon HPD event
2470  * or power up event. Upon completion, the function will update link structure
2471  * in place based on latest RX capabilities. The function may also cause dpms
2472  * to be reset to off for all currently enabled streams to the link. It is DM's
2473  * responsibility to serialize detection and DPMS updates.
2474  *
2475  * @reason - Indicate which event triggers this detection. dc may customize
2476  * detection flow depending on the triggering events.
2477  * return false - if detection is not fully completed. This could happen when
2478  * there is an unrecoverable error during detection or detection is partially
2479  * completed (detection has been delegated to dm mst manager ie.
2480  * link->connection_type == dc_connection_mst_branch when returning false).
2481  * return true - detection is completed, link has been fully updated with latest
2482  * detection result.
2483  */
2484 bool dc_link_detect(struct dc_link *link, enum dc_detect_reason reason);
2485 
2486 struct dc_sink_init_data;
2487 
2488 /* When link connection type is dc_connection_mst_branch, remote sink can be
2489  * added to the link. The interface creates a remote sink and associates it with
2490  * current link. The sink will be retained by link until remove remote sink is
2491  * called.
2492  *
2493  * @dc_link - link the remote sink will be added to.
2494  * @edid - byte array of EDID raw data.
2495  * @len - size of the edid in byte
2496  * @init_data -
2497  */
2498 struct dc_sink *dc_link_add_remote_sink(
2499 		struct dc_link *dc_link,
2500 		const uint8_t *edid,
2501 		unsigned int len,
2502 		struct dc_sink_init_data *init_data);
2503 
2504 /* Remove remote sink from a link with dc_connection_mst_branch connection type.
2505  * @link - link the sink should be removed from
2506  * @sink - sink to be removed.
2507  */
2508 void dc_link_remove_remote_sink(
2509 	struct dc_link *link,
2510 	struct dc_sink *sink);
2511 
2512 /* Enable HPD interrupt handler for a given link */
2513 void dc_link_enable_hpd(const struct dc_link *link);
2514 
2515 /* Disable HPD interrupt handler for a given link */
2516 void dc_link_disable_hpd(const struct dc_link *link);
2517 
2518 /* determine if there is a sink connected to the link
2519  *
2520  * @type - dc_connection_single if connected, dc_connection_none otherwise.
2521  * return - false if an unexpected error occurs, true otherwise.
2522  *
2523  * NOTE: This function doesn't detect downstream sink connections i.e
2524  * dc_connection_mst_branch, dc_connection_sst_branch. In this case, it will
2525  * return dc_connection_single if the branch device is connected despite of
2526  * downstream sink's connection status.
2527  */
2528 bool dc_link_detect_connection_type(struct dc_link *link,
2529 		enum dc_connection_type *type);
2530 
2531 /* query current hpd pin value
2532  * return - true HPD is asserted (HPD high), false otherwise (HPD low)
2533  *
2534  */
2535 bool dc_link_get_hpd_state(struct dc_link *link);
2536 
2537 /* Getter for cached link status from given link */
2538 const struct dc_link_status *dc_link_get_status(const struct dc_link *link);
2539 
2540 /* enable/disable hardware HPD filter.
2541  *
2542  * @link - The link the HPD pin is associated with.
2543  * @enable = true - enable hardware HPD filter. HPD event will only queued to irq
2544  * handler once after no HPD change has been detected within dc default HPD
2545  * filtering interval since last HPD event. i.e if display keeps toggling hpd
2546  * pulses within default HPD interval, no HPD event will be received until HPD
2547  * toggles have stopped. Then HPD event will be queued to irq handler once after
2548  * dc default HPD filtering interval since last HPD event.
2549  *
2550  * @enable = false - disable hardware HPD filter. HPD event will be queued
2551  * immediately to irq handler after no HPD change has been detected within
2552  * IRQ_HPD (aka HPD short pulse) interval (i.e 2ms).
2553  */
2554 void dc_link_enable_hpd_filter(struct dc_link *link, bool enable);
2555 
2556 /* submit i2c read/write payloads through ddc channel
2557  * @link_index - index to a link with ddc in i2c mode
2558  * @cmd - i2c command structure
2559  * return - true if success, false otherwise.
2560  */
2561 bool dc_submit_i2c(
2562 		struct dc *dc,
2563 		uint32_t link_index,
2564 		struct i2c_command *cmd);
2565 
2566 /* submit i2c read/write payloads through oem channel
2567  * @link_index - index to a link with ddc in i2c mode
2568  * @cmd - i2c command structure
2569  * return - true if success, false otherwise.
2570  */
2571 bool dc_submit_i2c_oem(
2572 		struct dc *dc,
2573 		struct i2c_command *cmd);
2574 
2575 enum aux_return_code_type;
2576 /* Attempt to transfer the given aux payload. This function does not perform
2577  * retries or handle error states. The reply is returned in the payload->reply
2578  * and the result through operation_result. Returns the number of bytes
2579  * transferred,or -1 on a failure.
2580  */
2581 int dc_link_aux_transfer_raw(struct ddc_service *ddc,
2582 		struct aux_payload *payload,
2583 		enum aux_return_code_type *operation_result);
2584 
2585 struct ddc_service *
2586 dc_get_oem_i2c_device(struct dc *dc);
2587 
2588 bool dc_is_oem_i2c_device_present(
2589 	struct dc *dc,
2590 	size_t slave_address
2591 );
2592 
2593 /* return true if the connected receiver supports the hdcp version */
2594 bool dc_link_is_hdcp14(struct dc_link *link, enum signal_type signal);
2595 bool dc_link_is_hdcp22(struct dc_link *link, enum signal_type signal);
2596 
2597 /* Notify DC about DP RX Interrupt (aka DP IRQ_HPD).
2598  *
2599  * TODO - When defer_handling is true the function will have a different purpose.
2600  * It no longer does complete hpd rx irq handling. We should create a separate
2601  * interface specifically for this case.
2602  *
2603  * Return:
2604  * true - Downstream port status changed. DM should call DC to do the
2605  * detection.
2606  * false - no change in Downstream port status. No further action required
2607  * from DM.
2608  */
2609 bool dc_link_handle_hpd_rx_irq(struct dc_link *dc_link,
2610 		union hpd_irq_data *hpd_irq_dpcd_data, bool *out_link_loss,
2611 		bool defer_handling, bool *has_left_work);
2612 /* handle DP specs define test automation sequence*/
2613 void dc_link_dp_handle_automated_test(struct dc_link *link);
2614 
2615 /* handle DP Link loss sequence and try to recover RX link loss with best
2616  * effort
2617  */
2618 void dc_link_dp_handle_link_loss(struct dc_link *link);
2619 
2620 /* Determine if hpd rx irq should be handled or ignored
2621  * return true - hpd rx irq should be handled.
2622  * return false - it is safe to ignore hpd rx irq event
2623  */
2624 bool dc_link_dp_allow_hpd_rx_irq(const struct dc_link *link);
2625 
2626 /* Determine if link loss is indicated with a given hpd_irq_dpcd_data.
2627  * @link - link the hpd irq data associated with
2628  * @hpd_irq_dpcd_data - input hpd irq data
2629  * return - true if hpd irq data indicates a link lost
2630  */
2631 bool dc_link_check_link_loss_status(struct dc_link *link,
2632 		union hpd_irq_data *hpd_irq_dpcd_data);
2633 
2634 /* Read hpd rx irq data from a given link
2635  * @link - link where the hpd irq data should be read from
2636  * @irq_data - output hpd irq data
2637  * return - DC_OK if hpd irq data is read successfully, otherwise hpd irq data
2638  * read has failed.
2639  */
2640 enum dc_status dc_link_dp_read_hpd_rx_irq_data(
2641 	struct dc_link *link,
2642 	union hpd_irq_data *irq_data);
2643 
2644 bool dc_link_frl_poll_status_flag(struct dc_link *link);
2645 bool dc_link_frl_margin_check_uncompressed_video(
2646 		const struct dc_link *link,
2647 		struct frl_cap_chk_params_fixed31_32 *params,
2648 		struct frl_cap_chk_intermediates_fixed31_32 *inter);
2649 
2650 /* The function clears recorded DP RX states in the link. DM should call this
2651  * function when it is resuming from S3 power state to previously connected links.
2652  *
2653  * TODO - in the future we should consider to expand link resume interface to
2654  * support clearing previous rx states. So we don't have to rely on dm to call
2655  * this interface explicitly.
2656  */
2657 void dc_link_clear_dprx_states(struct dc_link *link);
2658 
2659 /* Destruct the mst topology of the link and reset the allocated payload table
2660  *
2661  * NOTE: this should only be called if DM chooses not to call dc_link_detect but
2662  * still wants to reset MST topology on an unplug event */
2663 bool dc_link_reset_cur_dp_mst_topology(struct dc_link *link);
2664 
2665 /* The function calculates effective DP link bandwidth when a given link is
2666  * using the given link settings.
2667  *
2668  * return - total effective link bandwidth in kbps.
2669  */
2670 uint32_t dc_link_bandwidth_kbps(
2671 	const struct dc_link *link,
2672 	const struct dc_link_settings *link_setting);
2673 
2674 /* The function returns effective HDMI FRL bandwidth given link rate.
2675  * return - total effective link bandwidth in kbps.
2676  */
2677 uint32_t dc_link_frl_bandwidth_kbps(const struct dc_link *link,
2678 		enum hdmi_frl_link_rate link_rate);
2679 
2680 struct dp_audio_bandwidth_params {
2681 	const struct dc_crtc_timing *crtc_timing;
2682 	enum dp_link_encoding link_encoding;
2683 	uint32_t channel_count;
2684 	uint32_t sample_rate_hz;
2685 };
2686 
2687 /* The function calculates the minimum size of hblank (in bytes) needed to
2688  * support the specified channel count and sample rate combination, given the
2689  * link encoding and timing to be used. This calculation is not supported
2690  * for 8b/10b SST.
2691  *
2692  * return - min hblank size in bytes, 0 if 8b/10b SST.
2693  */
2694 uint32_t dc_link_required_hblank_size_bytes(
2695 	const struct dc_link *link,
2696 	struct dp_audio_bandwidth_params *audio_params);
2697 
2698 /* The function takes a snapshot of current link resource allocation state
2699  * @dc: pointer to dc of the dm calling this
2700  * @map: a dc link resource snapshot defined internally to dc.
2701  *
2702  * DM needs to capture a snapshot of current link resource allocation mapping
2703  * and store it in its persistent storage.
2704  *
2705  * Some of the link resource is using first come first serve policy.
2706  * The allocation mapping depends on original hotplug order. This information
2707  * is lost after driver is loaded next time. The snapshot is used in order to
2708  * restore link resource to its previous state so user will get consistent
2709  * link capability allocation across reboot.
2710  *
2711  */
2712 void dc_get_cur_link_res_map(const struct dc *dc, uint32_t *map);
2713 
2714 /* This function restores link resource allocation state from a snapshot
2715  * @dc: pointer to dc of the dm calling this
2716  * @map: a dc link resource snapshot defined internally to dc.
2717  *
2718  * DM needs to call this function after initial link detection on boot and
2719  * before first commit streams to restore link resource allocation state
2720  * from previous boot session.
2721  *
2722  * Some of the link resource is using first come first serve policy.
2723  * The allocation mapping depends on original hotplug order. This information
2724  * is lost after driver is loaded next time. The snapshot is used in order to
2725  * restore link resource to its previous state so user will get consistent
2726  * link capability allocation across reboot.
2727  *
2728  */
2729 void dc_restore_link_res_map(const struct dc *dc, uint32_t *map);
2730 
2731 void dc_link_wait_for_unlocked(struct dc_link *link);
2732 
2733 /* TODO: this is not meant to be exposed to DM. Should switch to stream update
2734  * interface i.e stream_update->dsc_config
2735  */
2736 bool dc_link_update_dsc_config(struct pipe_ctx *pipe_ctx);
2737 
2738 /* translate a raw link rate data to bandwidth in kbps */
2739 uint32_t dc_link_bw_kbps_from_raw_frl_link_rate_data(const struct dc *dc, uint8_t bw);
2740 
2741 /* determine the optimal bandwidth given link and required bw.
2742  * @link - current detected link
2743  * @req_bw - requested bandwidth in kbps
2744  * @link_settings - returned most optimal link settings that can fit the
2745  * requested bandwidth
2746  * return - false if link can't support requested bandwidth, true if link
2747  * settings is found.
2748  */
2749 bool dc_link_decide_edp_link_settings(struct dc_link *link,
2750 		struct dc_link_settings *link_settings,
2751 		uint32_t req_bw);
2752 
2753 /* return the max dp link settings can be driven by the link without considering
2754  * connected RX device and its capability
2755  */
2756 bool dc_link_dp_get_max_link_enc_cap(const struct dc_link *link,
2757 		struct dc_link_settings *max_link_enc_cap);
2758 
2759 /* determine when the link is driving MST mode, what DP link channel coding
2760  * format will be used. The decision will remain unchanged until next HPD event.
2761  *
2762  * @link -  a link with DP RX connection
2763  * return - if stream is committed to this link with MST signal type, type of
2764  * channel coding format dc will choose.
2765  */
2766 enum dp_link_encoding dc_link_dp_mst_decide_link_encoding_format(
2767 		const struct dc_link *link);
2768 
2769 /* get max dp link settings the link can enable with all things considered. (i.e
2770  * TX/RX/Cable capabilities and dp override policies.
2771  *
2772  * @link - a link with DP RX connection
2773  * return - max dp link settings the link can enable.
2774  *
2775  */
2776 const struct dc_link_settings *dc_link_get_link_cap(const struct dc_link *link);
2777 
2778 /* Get the highest encoding format that the link supports; highest meaning the
2779  * encoding format which supports the maximum bandwidth.
2780  *
2781  * @link - a link with DP RX connection
2782  * return - highest encoding format link supports.
2783  */
2784 enum dc_link_encoding_format dc_link_get_highest_encoding_format(const struct dc_link *link);
2785 
2786 /* get max frl link settings the link can enable with all things considered.
2787  * (i.e TX/RX capabilities and link verification result.
2788  *
2789  * @link - a link with FRL RX connection
2790  * return - max frl link settings the link can enable.
2791  *
2792  */
2793 struct dc_hdmi_frl_link_settings *dc_link_get_frl_link_cap(
2794 		struct dc_link *link);
2795 
2796 /* Check if a RX (ex. DP sink, MST hub, passive or active dongle) is connected
2797  * to a link with dp connector signal type.
2798  * @link - a link with dp connector signal type
2799  * return - true if connected, false otherwise
2800  */
2801 bool dc_link_is_dp_sink_present(struct dc_link *link);
2802 
2803 /* Force DP lane settings update to main-link video signal and notify the change
2804  * to DP RX via DPCD. This is a debug interface used for video signal integrity
2805  * tuning purpose. The interface assumes link has already been enabled with DP
2806  * signal.
2807  *
2808  * @lt_settings - a container structure with desired hw_lane_settings
2809  */
2810 void dc_link_set_drive_settings(struct dc *dc,
2811 				struct link_training_settings *lt_settings,
2812 				struct dc_link *link);
2813 
2814 /* Enable a test pattern in Link or PHY layer in an active link for compliance
2815  * test or debugging purpose. The test pattern will remain until next un-plug.
2816  *
2817  * @link - active link with DP signal output enabled.
2818  * @test_pattern - desired test pattern to output.
2819  * NOTE: set to DP_TEST_PATTERN_VIDEO_MODE to disable previous test pattern.
2820  * @test_pattern_color_space - for video test pattern choose a desired color
2821  * space.
2822  * @p_link_settings - For PHY pattern choose a desired link settings
2823  * @p_custom_pattern - some test pattern will require a custom input to
2824  * customize some pattern details. Otherwise keep it to NULL.
2825  * @cust_pattern_size - size of the custom pattern input.
2826  *
2827  */
2828 bool dc_link_dp_set_test_pattern(
2829 	struct dc_link *link,
2830 	enum dp_test_pattern test_pattern,
2831 	enum dp_test_pattern_color_space test_pattern_color_space,
2832 	const struct link_training_settings *p_link_settings,
2833 	const unsigned char *p_custom_pattern,
2834 	unsigned int cust_pattern_size);
2835 
2836 /* Force DP link settings to always use a specific value until reboot to a
2837  * specific link. If link has already been enabled, the interface will also
2838  * switch to desired link settings immediately. This is a debug interface to
2839  * generic dp issue trouble shooting.
2840  */
2841 void dc_link_set_preferred_link_settings(struct dc *dc,
2842 		struct dc_link_settings *link_setting,
2843 		struct dc_link *link);
2844 
2845 /* Force FRL link settings to always use a specific value until reboot to a
2846  * specific link. If link has already been enabled, the interface will also
2847  * switch to desired link settings immediately. This is a debug interface to
2848  * generic FRL issue trouble shooting.
2849  */
2850 void dc_link_set_preferred_frl_link_settings(struct dc *dc,
2851 		struct dc_hdmi_frl_link_settings *link_setting,
2852 		struct dc_hdmi_frl_link_training_overrides *lt_overrides,
2853 		struct dc_link *link);
2854 
2855 /* Force DP link to customize a specific link training behavior by overriding to
2856  * standard DP specs defined protocol. This is a debug interface to trouble shoot
2857  * display specific link training issues or apply some display specific
2858  * workaround in link training.
2859  *
2860  * @link_settings - if not NULL, force preferred link settings to the link.
2861  * @lt_override - a set of override pointers. If any pointer is none NULL, dc
2862  * will apply this particular override in future link training. If NULL is
2863  * passed in, dc resets previous overrides.
2864  * NOTE: DM must keep the memory from override pointers until DM resets preferred
2865  * training settings.
2866  */
2867 void dc_link_set_preferred_training_settings(struct dc *dc,
2868 		struct dc_link_settings *link_setting,
2869 		struct dc_link_training_overrides *lt_overrides,
2870 		struct dc_link *link,
2871 		bool skip_immediate_retrain);
2872 
2873 /* return - true if FEC is supported with connected DP RX, false otherwise */
2874 bool dc_link_is_fec_supported(const struct dc_link *link);
2875 
2876 /* query FEC enablement policy to determine if FEC will be enabled by dc during
2877  * link enablement.
2878  * return - true if FEC should be enabled, false otherwise.
2879  */
2880 bool dc_link_should_enable_fec(const struct dc_link *link);
2881 
2882 /* determine lttpr mode the current link should be enabled with a specific link
2883  * settings.
2884  */
2885 enum lttpr_mode dc_link_decide_lttpr_mode(struct dc_link *link,
2886 		struct dc_link_settings *link_setting);
2887 
2888 /* Force DP RX to update its power state.
2889  * NOTE: this interface doesn't update dp main-link. Calling this function will
2890  * cause DP TX main-link and DP RX power states out of sync. DM has to restore
2891  * RX power state back upon finish DM specific execution requiring DP RX in a
2892  * specific power state.
2893  * @on - true to set DP RX in D0 power state, false to set DP RX in D3 power
2894  * state.
2895  */
2896 void dc_link_dp_receiver_power_ctrl(struct dc_link *link, bool on);
2897 
2898 /* Force link to read base dp receiver caps from dpcd 000h - 00Fh and overwrite
2899  * current value read from extended receiver cap from 02200h - 0220Fh.
2900  * Some DP RX has problems of providing accurate DP receiver caps from extended
2901  * field, this interface is a workaround to revert link back to use base caps.
2902  */
2903 void dc_link_overwrite_extended_receiver_cap(
2904 		struct dc_link *link);
2905 
2906 void dc_link_edp_panel_backlight_power_on(struct dc_link *link,
2907 		bool wait_for_hpd);
2908 
2909 /* Set backlight level of an embedded panel (eDP, LVDS).
2910  * backlight_pwm_u16_16 is unsigned 32 bit with 16 bit integer
2911  * and 16 bit fractional, where 1.0 is max backlight value.
2912  */
2913 bool dc_link_set_backlight_level(const struct dc_link *dc_link,
2914 		struct set_backlight_level_params *backlight_level_params);
2915 
2916 /* Set/get nits-based backlight level of an embedded panel (eDP, LVDS). */
2917 bool dc_link_set_backlight_level_nits(struct dc_link *link,
2918 		bool isHDR,
2919 		uint32_t backlight_millinits,
2920 		uint32_t transition_time_in_ms);
2921 
2922 bool dc_link_get_backlight_level_nits(struct dc_link *link,
2923 		uint32_t *backlight_millinits,
2924 		uint32_t *backlight_millinits_peak);
2925 
2926 int dc_link_get_backlight_level(const struct dc_link *dc_link);
2927 
2928 int dc_link_get_target_backlight_pwm(const struct dc_link *link);
2929 
2930 bool dc_link_set_psr_allow_active(struct dc_link *dc_link, const bool *enable,
2931 		bool wait, bool force_static, const unsigned int *power_opts);
2932 
2933 bool dc_link_get_psr_state(const struct dc_link *dc_link, enum dc_psr_state *state);
2934 
2935 bool dc_link_setup_psr(struct dc_link *dc_link,
2936 		const struct dc_stream_state *stream, struct psr_config *psr_config,
2937 		struct psr_context *psr_context);
2938 
2939 /*
2940  * Communicate with DMUB to allow or disallow Panel Replay on the specified link:
2941  *
2942  * @link: pointer to the dc_link struct instance
2943  * @enable: enable(active) or disable(inactive) replay
2944  * @wait: state transition need to wait the active set completed.
2945  * @force_static: force disable(inactive) the replay
2946  * @power_opts: set power optimazation parameters to DMUB.
2947  *
2948  * return: allow Replay active will return true, else will return false.
2949  */
2950 bool dc_link_set_replay_allow_active(struct dc_link *dc_link, const bool *enable,
2951 		bool wait, bool force_static, const unsigned int *power_opts);
2952 
2953 bool dc_link_get_replay_state(const struct dc_link *dc_link, uint64_t *state);
2954 
2955 /*
2956  * Enable or disable Panel Replay on the specified link:
2957  *
2958  * @link: pointer to the dc_link struct instance
2959  * @enable: enable or disable Panel Replay
2960  *
2961  * return: true if successful, false otherwise
2962  */
2963 bool dc_link_set_pr_enable(struct dc_link *link, bool enable);
2964 
2965 /*
2966  * Update Panel Replay state parameters:
2967  *
2968  * @link: pointer to the dc_link struct instance
2969  * @update_state_data: pointer to state update data structure
2970  *
2971  * return: true if successful, false otherwise
2972  */
2973 bool dc_link_update_pr_state(struct dc_link *link,
2974 		struct dmub_cmd_pr_update_state_data *update_state_data);
2975 
2976 /*
2977  * Send general command to Panel Replay firmware:
2978  *
2979  * @link: pointer to the dc_link struct instance
2980  * @general_cmd_data: pointer to general command data structure
2981  *
2982  * return: true if successful, false otherwise
2983  */
2984 bool dc_link_set_pr_general_cmd(struct dc_link *link,
2985 		struct dmub_cmd_pr_general_cmd_data *general_cmd_data);
2986 
2987 /*
2988  * Measure Panel Replay residency for the given link.
2989  * mode: PR_RESIDENCY_MODE_PHY, PR_RESIDENCY_MODE_ALPM, or
2990  *       PR_RESIDENCY_MODE_ENABLEMENT_PERIOD
2991  */
2992 void dc_link_edp_replay_residency(const struct dc_link *link,
2993 		unsigned int *residency, bool is_start, enum pr_residency_mode mode);
2994 
2995 /*
2996  * Get Panel Replay state:
2997  *
2998  * @link: pointer to the dc_link struct instance
2999  * @state: pointer to store the Panel Replay state
3000  *
3001  * return: true if successful, false otherwise
3002  */
3003 bool dc_link_get_pr_state(const struct dc_link *link, uint64_t *state);
3004 
3005 /* On eDP links this function call will stall until T12 has elapsed.
3006  * If the panel is not in power off state, this function will return
3007  * immediately.
3008  */
3009 bool dc_link_wait_for_t12(struct dc_link *link);
3010 
3011 /* Determine if dp trace has been initialized to reflect upto date result *
3012  * return - true if trace is initialized and has valid data. False dp trace
3013  * doesn't have valid result.
3014  */
3015 bool dc_dp_trace_is_initialized(struct dc_link *link);
3016 
3017 /* Query a dp trace flag to indicate if the current dp trace data has been
3018  * logged before
3019  */
3020 bool dc_dp_trace_is_logged(struct dc_link *link,
3021 		bool in_detection);
3022 
3023 /* Set dp trace flag to indicate whether DM has already logged the current dp
3024  * trace data. DM can set is_logged to true upon logging and check
3025  * dc_dp_trace_is_logged before logging to avoid logging the same result twice.
3026  */
3027 void dc_dp_trace_set_is_logged_flag(struct dc_link *link,
3028 		bool in_detection,
3029 		bool is_logged);
3030 
3031 /* Obtain driver time stamp for last dp link training end. The time stamp is
3032  * formatted based on dm_get_timestamp DM function.
3033  * @in_detection - true to get link training end time stamp of last link
3034  * training in detection sequence. false to get link training end time stamp
3035  * of last link training in commit (dpms) sequence
3036  */
3037 unsigned long long dc_dp_trace_get_lt_end_timestamp(struct dc_link *link,
3038 		bool in_detection);
3039 
3040 /* Get how many link training attempts dc has done with latest sequence.
3041  * @in_detection - true to get link training count of last link
3042  * training in detection sequence. false to get link training count of last link
3043  * training in commit (dpms) sequence
3044  */
3045 const struct dp_trace_lt_counts *dc_dp_trace_get_lt_counts(struct dc_link *link,
3046 		bool in_detection);
3047 
3048 /* Get how many link loss has happened since last link training attempts */
3049 unsigned int dc_dp_trace_get_link_loss_count(struct dc_link *link);
3050 
3051 /*
3052  *  USB4 DPIA BW ALLOCATION PUBLIC FUNCTIONS
3053  */
3054 /*
3055  * Send a request from DP-Tx requesting to allocate BW remotely after
3056  * allocating it locally. This will get processed by CM and a CB function
3057  * will be called.
3058  *
3059  * @link: pointer to the dc_link struct instance
3060  * @req_bw: The requested bw in Kbyte to allocated
3061  *
3062  * return: none
3063  */
3064 void dc_link_set_usb4_req_bw_req(struct dc_link *link, int req_bw);
3065 
3066 /*
3067  * Handle the USB4 BW Allocation related functionality here:
3068  * Plug => Try to allocate max bw from timing parameters supported by the sink
3069  * Unplug => de-allocate bw
3070  *
3071  * @link: pointer to the dc_link struct instance
3072  * @peak_bw: Peak bw used by the link/sink
3073  *
3074  */
3075 void dc_link_dp_dpia_handle_usb4_bandwidth_allocation_for_link(
3076 		struct dc_link *link, int peak_bw);
3077 
3078 /*
3079  * Calculates the DP tunneling bandwidth required for the stream timing
3080  * and aggregates the stream bandwidth for the respective DP tunneling link
3081  *
3082  * return: dc_status
3083  */
3084 enum dc_status dc_link_validate_dp_tunneling_bandwidth(const struct dc *dc, const struct dc_state *new_ctx);
3085 
3086 /*
3087  * Get if ALPM is supported by the link
3088  */
3089 void dc_link_get_alpm_support(struct dc_link *link, bool *auxless_support,
3090 	bool *auxwake_support);
3091 
3092 /* Sink Interfaces - A sink corresponds to a display output device */
3093 
3094 struct dc_container_id {
3095 	// 128bit GUID in binary form
3096 	unsigned char  guid[16];
3097 	// 8 byte port ID -> ELD.PortID
3098 	unsigned int   portId[2];
3099 	// 128bit GUID in binary formufacturer name -> ELD.ManufacturerName
3100 	unsigned short manufacturerName;
3101 	// 2 byte product code -> ELD.ProductCode
3102 	unsigned short productCode;
3103 };
3104 
3105 
3106 struct dc_sink_dsc_caps {
3107 	// 'true' if these are virtual DPCD's DSC caps (immediately upstream of sink in MST topology),
3108 	// 'false' if they are sink's DSC caps
3109 	bool is_virtual_dpcd_dsc;
3110 	// 'true' if MST topology supports DSC passthrough for sink
3111 	// 'false' if MST topology does not support DSC passthrough
3112 	bool is_dsc_passthrough_supported;
3113 	struct dsc_dec_dpcd_caps dsc_dec_caps;
3114 };
3115 
3116 struct dc_sink_hblank_expansion_caps {
3117 	// 'true' if these are virtual DPCD's HBlank expansion caps (immediately upstream of sink in MST topology),
3118 	// 'false' if they are sink's HBlank expansion caps
3119 	bool is_virtual_dpcd_hblank_expansion;
3120 	struct hblank_expansion_dpcd_caps dpcd_caps;
3121 };
3122 
3123 struct dc_sink_fec_caps {
3124 	bool is_rx_fec_supported;
3125 	bool is_topology_fec_supported;
3126 };
3127 
3128 struct scdc_caps {
3129 	union hdmi_scdc_manufacturer_OUI_data manufacturer_OUI;
3130 	union hdmi_scdc_device_id_data device_id;
3131 };
3132 
3133 /*
3134  * The sink structure contains EDID and other display device properties
3135  */
3136 struct dc_sink {
3137 	enum signal_type sink_signal;
3138 	struct dc_edid dc_edid; /* raw edid */
3139 	struct dc_edid_caps edid_caps; /* parse display caps */
3140 	struct dc_container_id *dc_container_id;
3141 	uint32_t dongle_max_pix_clk;
3142 	void *priv;
3143 	struct stereo_3d_features features_3d[TIMING_3D_FORMAT_MAX];
3144 	bool converter_disable_audio;
3145 
3146 	struct mccs_caps mccs_caps;
3147 	struct scdc_caps scdc_caps;
3148 	struct dc_sink_dsc_caps dsc_caps;
3149 	struct dc_sink_fec_caps fec_caps;
3150 	struct dc_sink_hblank_expansion_caps hblank_expansion_caps;
3151 
3152 	bool is_vsc_sdp_colorimetry_supported;
3153 
3154 	/* private to DC core */
3155 	struct dc_link *link;
3156 	struct dc_context *ctx;
3157 
3158 	uint32_t sink_id;
3159 
3160 	/* private to dc_sink.c */
3161 	// refcount must be the last member in dc_sink, since we want the
3162 	// sink structure to be logically cloneable up to (but not including)
3163 	// refcount
3164 	struct kref refcount;
3165 };
3166 
3167 void dc_sink_retain(struct dc_sink *sink);
3168 void dc_sink_release(struct dc_sink *sink);
3169 
3170 struct dc_sink_init_data {
3171 	enum signal_type sink_signal;
3172 	struct dc_link *link;
3173 	uint32_t dongle_max_pix_clk;
3174 	bool converter_disable_audio;
3175 };
3176 
3177 struct dc_sink *dc_sink_create(const struct dc_sink_init_data *init_params);
3178 
3179 /* Newer interfaces  */
3180 struct dc_cursor {
3181 	struct dc_plane_address address;
3182 	struct dc_cursor_attributes attributes;
3183 };
3184 
3185 
3186 /* Interrupt interfaces */
3187 enum dc_irq_source dc_interrupt_to_irq_source(
3188 		struct dc *dc,
3189 		uint32_t src_id,
3190 		uint32_t ext_id);
3191 bool dc_interrupt_set(struct dc *dc, enum dc_irq_source src, bool enable);
3192 void dc_interrupt_ack(struct dc *dc, enum dc_irq_source src);
3193 bool dc_get_flip_pending_on_otg(struct dc *dc, int otg_inst);
3194 enum dc_irq_source dc_get_hpd_irq_source_at_index(
3195 		struct dc *dc, uint32_t link_index);
3196 
3197 void dc_notify_vsync_int_state(struct dc *dc, struct dc_stream_state *stream, bool enable);
3198 
3199 /* Power Interfaces */
3200 
3201 void dc_set_power_state(
3202 		struct dc *dc,
3203 		enum dc_acpi_cm_power_state power_state);
3204 void dc_resume(struct dc *dc);
3205 
3206 void dc_power_down_on_boot(struct dc *dc);
3207 
3208 void dc_disable_dangling_timing_generators(struct dc *dc);
3209 
3210 /*
3211  * HDCP Interfaces
3212  */
3213 enum hdcp_message_status dc_process_hdcp_msg(
3214 		enum signal_type signal,
3215 		struct dc_link *link,
3216 		struct hdcp_protection_message *message_info);
3217 bool dc_is_dmcu_initialized(struct dc *dc);
3218 
3219 enum dc_status dc_set_clock(struct dc *dc, enum dc_clock_type clock_type, uint32_t clk_khz, uint32_t stepping);
3220 void dc_get_clock(struct dc *dc, enum dc_clock_type clock_type, struct dc_clock_config *clock_cfg);
3221 
3222 bool dc_is_plane_eligible_for_idle_optimizations(struct dc *dc,
3223 		unsigned int pitch,
3224 		unsigned int height,
3225 		enum surface_pixel_format format,
3226 		struct dc_cursor_attributes *cursor_attr);
3227 
3228 #define dc_allow_idle_optimizations(dc, allow) dc_allow_idle_optimizations_internal(dc, allow, __func__)
3229 #define dc_exit_ips_for_hw_access(dc) dc_exit_ips_for_hw_access_internal(dc, __func__)
3230 
3231 void dc_allow_idle_optimizations_internal(struct dc *dc, bool allow, const char *caller_name);
3232 void dc_exit_ips_for_hw_access_internal(struct dc *dc, const char *caller_name);
3233 bool dc_dmub_is_ips_idle_state(struct dc *dc);
3234 
3235 /* set min and max memory clock to lowest and highest DPM level, respectively */
3236 void dc_unlock_memory_clock_frequency(struct dc *dc);
3237 
3238 /* set min memory clock to the min required for current mode, max to maxDPM */
3239 void dc_lock_memory_clock_frequency(struct dc *dc);
3240 
3241 /* set soft max for memclk, to be used for AC/DC switching clock limitations */
3242 void dc_enable_dcmode_clk_limit(struct dc *dc, bool enable);
3243 
3244 /* cleanup on driver unload */
3245 void dc_hardware_release(struct dc *dc);
3246 
3247 /* disables fw based mclk switch */
3248 void dc_mclk_switch_using_fw_based_vblank_stretch_shut_down(struct dc *dc);
3249 
3250 bool dc_set_psr_allow_active(struct dc *dc, bool enable);
3251 
3252 bool dc_set_replay_allow_active(struct dc *dc, bool active);
3253 
3254 bool dc_set_ips_disable(struct dc *dc, unsigned int disable_ips);
3255 
3256 void dc_z10_restore(const struct dc *dc);
3257 void dc_z10_save_init(struct dc *dc);
3258 
3259 bool dc_is_dmub_outbox_supported(struct dc *dc);
3260 bool dc_enable_dmub_notifications(struct dc *dc);
3261 
3262 bool dc_abm_save_restore(
3263 		struct dc *dc,
3264 		struct dc_stream_state *stream,
3265 		struct abm_save_restore *pData);
3266 
3267 void dc_enable_dmub_outbox(struct dc *dc);
3268 
3269 bool dc_process_dmub_aux_transfer_async(struct dc *dc,
3270 				uint32_t link_index,
3271 				struct aux_payload *payload);
3272 
3273 /*
3274  * smart power OLED Interfaces
3275  */
3276 bool dc_smart_power_oled_enable(const struct dc_link *link, bool enable, uint16_t peak_nits,
3277 	uint8_t debug_control, uint16_t fixed_CLL, uint32_t triggerline);
3278 bool dc_smart_power_oled_get_max_cll(const struct dc_link *link, unsigned int *pCurrent_MaxCLL);
3279 
3280 /* Get dc link index from dpia port index */
3281 uint8_t get_link_index_from_dpia_port_index(const struct dc *dc,
3282 				uint8_t dpia_port_index);
3283 
3284 bool dc_process_dmub_set_config_async(struct dc *dc,
3285 				uint32_t link_index,
3286 				struct set_config_cmd_payload *payload,
3287 				struct dmub_notification *notify);
3288 
3289 enum dc_status dc_process_dmub_set_mst_slots(const struct dc *dc,
3290 				uint32_t link_index,
3291 				uint8_t mst_alloc_slots,
3292 				uint8_t *mst_slots_in_use);
3293 
3294 void dc_process_dmub_dpia_set_tps_notification(const struct dc *dc, uint32_t link_index, uint8_t tps);
3295 
3296 void dc_process_dmub_dpia_hpd_int_enable(const struct dc *dc,
3297 				uint32_t hpd_int_enable);
3298 
3299 void dc_print_dmub_diagnostic_data(const struct dc *dc);
3300 
3301 void dc_query_current_properties(struct dc *dc, struct dc_current_properties *properties);
3302 
3303 struct dc_power_profile {
3304 	int power_level; /* Lower is better */
3305 };
3306 
3307 struct dc_power_profile dc_get_power_profile_for_dc_state(const struct dc_state *context);
3308 
3309 unsigned int dc_get_det_buffer_size_from_state(const struct dc_state *context);
3310 
3311 bool dc_get_host_router_index(const struct dc_link *link, unsigned int *host_router_index);
3312 
3313 void dc_log_preos_dmcub_info(const struct dc *dc);
3314 
3315 /* DSC Interfaces */
3316 #include "dc_dsc.h"
3317 
3318 void dc_get_visual_confirm_for_stream(
3319 	struct dc *dc,
3320 	struct dc_stream_state *stream_state,
3321 	struct tg_color *color);
3322 
3323 /* Disable acc mode Interfaces */
3324 void dc_disable_accelerated_mode(struct dc *dc);
3325 
3326 bool dc_is_timing_changed(struct dc_stream_state *cur_stream,
3327 		       struct dc_stream_state *new_stream);
3328 
3329 bool dc_is_cursor_limit_pending(struct dc *dc);
3330 bool dc_can_clear_cursor_limit(const struct dc *dc);
3331 
3332 /**
3333  * dc_get_underflow_debug_data_for_otg() - Retrieve underflow debug data.
3334  *
3335  * @dc: Pointer to the display core context.
3336  * @primary_otg_inst: Instance index of the primary OTG that underflowed.
3337  * @out_data: Pointer to a dc_underflow_debug_data struct to be filled with debug information.
3338  *
3339  * This function collects and logs underflow-related HW states when underflow happens,
3340  * including OTG underflow status, current read positions, frame count, and per-HUBP debug data.
3341  * The results are stored in the provided out_data structure for further analysis or logging.
3342  */
3343 void dc_get_underflow_debug_data_for_otg(struct dc *dc, unsigned int primary_otg_inst, struct dc_underflow_debug_data *out_data);
3344 
3345 void dc_get_power_feature_status(struct dc *dc, unsigned int primary_otg_inst, struct power_features *out_data);
3346 
3347 /*
3348  * Software state variables used to program register fields across the display pipeline
3349  */
3350 struct dc_register_software_state {
3351 	/* HUBP register programming variables for each pipe */
3352 	struct {
3353 		bool valid_plane_state;
3354 		bool valid_stream;
3355 		bool min_dc_gfx_version9;
3356 		uint32_t vtg_sel;                        /* DCHUBP_CNTL->HUBP_VTG_SEL from pipe_ctx->stream_res.tg->inst */
3357 		uint32_t hubp_clock_enable;              /* HUBP_CLK_CNTL->HUBP_CLOCK_ENABLE from power management */
3358 		uint32_t surface_pixel_format;           /* DCSURF_SURFACE_CONFIG->SURFACE_PIXEL_FORMAT from plane_state->format */
3359 		uint32_t rotation_angle;                 /* DCSURF_SURFACE_CONFIG->ROTATION_ANGLE from plane_state->rotation */
3360 		uint32_t h_mirror_en;                    /* DCSURF_SURFACE_CONFIG->H_MIRROR_EN from plane_state->horizontal_mirror */
3361 		uint32_t surface_dcc_en;                 /* DCSURF_SURFACE_CONTROL->PRIMARY_SURFACE_DCC_EN from dcc->enable */
3362 		uint32_t surface_size_width;             /* HUBP_SIZE->SURFACE_SIZE_WIDTH from plane_size.surface_size.width */
3363 		uint32_t surface_size_height;            /* HUBP_SIZE->SURFACE_SIZE_HEIGHT from plane_size.surface_size.height */
3364 		uint32_t pri_viewport_width;             /* DCSURF_PRI_VIEWPORT_DIMENSION->PRI_VIEWPORT_WIDTH from scaler_data.viewport.width */
3365 		uint32_t pri_viewport_height;            /* DCSURF_PRI_VIEWPORT_DIMENSION->PRI_VIEWPORT_HEIGHT from scaler_data.viewport.height */
3366 		uint32_t pri_viewport_x_start;           /* DCSURF_PRI_VIEWPORT_START->PRI_VIEWPORT_X_START from scaler_data.viewport.x */
3367 		uint32_t pri_viewport_y_start;           /* DCSURF_PRI_VIEWPORT_START->PRI_VIEWPORT_Y_START from scaler_data.viewport.y */
3368 		uint32_t cursor_enable;                  /* CURSOR_CONTROL->CURSOR_ENABLE from cursor_attributes.enable */
3369 		uint32_t cursor_width;                   /* CURSOR_SETTINGS->CURSOR_WIDTH from cursor_position.width */
3370 		uint32_t cursor_height;                  /* CURSOR_SETTINGS->CURSOR_HEIGHT from cursor_position.height */
3371 
3372 		/* Additional DCC configuration */
3373 		uint32_t surface_dcc_ind_64b_blk;        /* DCSURF_SURFACE_CONTROL->PRIMARY_SURFACE_DCC_IND_64B_BLK from dcc.independent_64b_blks */
3374 		uint32_t surface_dcc_ind_128b_blk;       /* DCSURF_SURFACE_CONTROL->PRIMARY_SURFACE_DCC_IND_128B_BLK from dcc.independent_128b_blks */
3375 
3376 		/* Surface pitch configuration */
3377 		uint32_t surface_pitch;                  /* DCSURF_SURFACE_PITCH->PITCH from plane_size.surface_pitch */
3378 		uint32_t meta_pitch;                     /* DCSURF_SURFACE_PITCH->META_PITCH from dcc.meta_pitch */
3379 		uint32_t chroma_pitch;                   /* DCSURF_SURFACE_PITCH_C->PITCH_C from plane_size.chroma_pitch */
3380 		uint32_t meta_pitch_c;                   /* DCSURF_SURFACE_PITCH_C->META_PITCH_C from dcc.meta_pitch_c */
3381 
3382 		/* Surface addresses */
3383 		uint32_t primary_surface_address_low;    /* DCSURF_PRIMARY_SURFACE_ADDRESS->PRIMARY_SURFACE_ADDRESS from address.grph.addr.low_part */
3384 		uint32_t primary_surface_address_high;   /* DCSURF_PRIMARY_SURFACE_ADDRESS_HIGH->PRIMARY_SURFACE_ADDRESS_HIGH from address.grph.addr.high_part */
3385 		uint32_t primary_meta_surface_address_low;  /* DCSURF_PRIMARY_META_SURFACE_ADDRESS->PRIMARY_META_SURFACE_ADDRESS from address.grph.meta_addr.low_part */
3386 		uint32_t primary_meta_surface_address_high; /* DCSURF_PRIMARY_META_SURFACE_ADDRESS_HIGH->PRIMARY_META_SURFACE_ADDRESS_HIGH from address.grph.meta_addr.high_part */
3387 
3388 		/* TMZ configuration */
3389 		uint32_t primary_surface_tmz;            /* DCSURF_SURFACE_CONTROL->PRIMARY_SURFACE_TMZ from address.tmz_surface */
3390 		uint32_t primary_meta_surface_tmz;       /* DCSURF_SURFACE_CONTROL->PRIMARY_META_SURFACE_TMZ from address.tmz_surface */
3391 
3392 		/* Tiling configuration */
3393 		uint32_t sw_mode;                        /* DCSURF_TILING_CONFIG->SW_MODE from tiling_info.gfx9.swizzle */
3394 		uint32_t num_pipes;                      /* DCSURF_ADDR_CONFIG->NUM_PIPES from tiling_info.gfx9.num_pipes */
3395 		uint32_t num_banks;                      /* DCSURF_ADDR_CONFIG->NUM_BANKS from tiling_info.gfx9.num_banks */
3396 		uint32_t pipe_interleave;                /* DCSURF_ADDR_CONFIG->PIPE_INTERLEAVE from tiling_info.gfx9.pipe_interleave */
3397 		uint32_t num_shader_engines;             /* DCSURF_ADDR_CONFIG->NUM_SE from tiling_info.gfx9.num_shader_engines */
3398 		uint32_t num_rb_per_se;                  /* DCSURF_ADDR_CONFIG->NUM_RB_PER_SE from tiling_info.gfx9.num_rb_per_se */
3399 		uint32_t num_pkrs;                       /* DCSURF_ADDR_CONFIG->NUM_PKRS from tiling_info.gfx9.num_pkrs */
3400 
3401 		/* DML Request Size Configuration - Luma */
3402 		uint32_t rq_chunk_size;                  /* DCHUBP_REQ_SIZE_CONFIG->CHUNK_SIZE from rq_regs.rq_regs_l.chunk_size */
3403 		uint32_t rq_min_chunk_size;              /* DCHUBP_REQ_SIZE_CONFIG->MIN_CHUNK_SIZE from rq_regs.rq_regs_l.min_chunk_size */
3404 		uint32_t rq_meta_chunk_size;             /* DCHUBP_REQ_SIZE_CONFIG->META_CHUNK_SIZE from rq_regs.rq_regs_l.meta_chunk_size */
3405 		uint32_t rq_min_meta_chunk_size;         /* DCHUBP_REQ_SIZE_CONFIG->MIN_META_CHUNK_SIZE from rq_regs.rq_regs_l.min_meta_chunk_size */
3406 		uint32_t rq_dpte_group_size;             /* DCHUBP_REQ_SIZE_CONFIG->DPTE_GROUP_SIZE from rq_regs.rq_regs_l.dpte_group_size */
3407 		uint32_t rq_mpte_group_size;             /* DCHUBP_REQ_SIZE_CONFIG->MPTE_GROUP_SIZE from rq_regs.rq_regs_l.mpte_group_size */
3408 		uint32_t rq_swath_height_l;              /* DCHUBP_REQ_SIZE_CONFIG->SWATH_HEIGHT_L from rq_regs.rq_regs_l.swath_height */
3409 		uint32_t rq_pte_row_height_l;            /* DCHUBP_REQ_SIZE_CONFIG->PTE_ROW_HEIGHT_L from rq_regs.rq_regs_l.pte_row_height */
3410 
3411 		/* DML Request Size Configuration - Chroma */
3412 		uint32_t rq_chunk_size_c;                /* DCHUBP_REQ_SIZE_CONFIG_C->CHUNK_SIZE_C from rq_regs.rq_regs_c.chunk_size */
3413 		uint32_t rq_min_chunk_size_c;            /* DCHUBP_REQ_SIZE_CONFIG_C->MIN_CHUNK_SIZE_C from rq_regs.rq_regs_c.min_chunk_size */
3414 		uint32_t rq_meta_chunk_size_c;           /* DCHUBP_REQ_SIZE_CONFIG_C->META_CHUNK_SIZE_C from rq_regs.rq_regs_c.meta_chunk_size */
3415 		uint32_t rq_min_meta_chunk_size_c;       /* DCHUBP_REQ_SIZE_CONFIG_C->MIN_META_CHUNK_SIZE_C from rq_regs.rq_regs_c.min_meta_chunk_size */
3416 		uint32_t rq_dpte_group_size_c;           /* DCHUBP_REQ_SIZE_CONFIG_C->DPTE_GROUP_SIZE_C from rq_regs.rq_regs_c.dpte_group_size */
3417 		uint32_t rq_mpte_group_size_c;           /* DCHUBP_REQ_SIZE_CONFIG_C->MPTE_GROUP_SIZE_C from rq_regs.rq_regs_c.mpte_group_size */
3418 		uint32_t rq_swath_height_c;              /* DCHUBP_REQ_SIZE_CONFIG_C->SWATH_HEIGHT_C from rq_regs.rq_regs_c.swath_height */
3419 		uint32_t rq_pte_row_height_c;            /* DCHUBP_REQ_SIZE_CONFIG_C->PTE_ROW_HEIGHT_C from rq_regs.rq_regs_c.pte_row_height */
3420 
3421 		/* DML Expansion Modes */
3422 		uint32_t drq_expansion_mode;             /* DCN_EXPANSION_MODE->DRQ_EXPANSION_MODE from rq_regs.drq_expansion_mode */
3423 		uint32_t prq_expansion_mode;             /* DCN_EXPANSION_MODE->PRQ_EXPANSION_MODE from rq_regs.prq_expansion_mode */
3424 		uint32_t mrq_expansion_mode;             /* DCN_EXPANSION_MODE->MRQ_EXPANSION_MODE from rq_regs.mrq_expansion_mode */
3425 		uint32_t crq_expansion_mode;             /* DCN_EXPANSION_MODE->CRQ_EXPANSION_MODE from rq_regs.crq_expansion_mode */
3426 
3427 		/* DML DLG parameters - nominal */
3428 		uint32_t dst_y_per_vm_vblank;            /* NOM_PARAMETERS_0->DST_Y_PER_VM_VBLANK from dlg_regs.dst_y_per_vm_vblank */
3429 		uint32_t dst_y_per_row_vblank;           /* NOM_PARAMETERS_0->DST_Y_PER_ROW_VBLANK from dlg_regs.dst_y_per_row_vblank */
3430 		uint32_t dst_y_per_vm_flip;              /* NOM_PARAMETERS_1->DST_Y_PER_VM_FLIP from dlg_regs.dst_y_per_vm_flip */
3431 		uint32_t dst_y_per_row_flip;             /* NOM_PARAMETERS_1->DST_Y_PER_ROW_FLIP from dlg_regs.dst_y_per_row_flip */
3432 
3433 		/* DML prefetch settings */
3434 		uint32_t dst_y_prefetch;                 /* PREFETCH_SETTINS->DST_Y_PREFETCH from dlg_regs.dst_y_prefetch */
3435 		uint32_t vratio_prefetch;                /* PREFETCH_SETTINS->VRATIO_PREFETCH from dlg_regs.vratio_prefetch */
3436 		uint32_t vratio_prefetch_c;              /* PREFETCH_SETTINS_C->VRATIO_PREFETCH_C from dlg_regs.vratio_prefetch_c */
3437 
3438 		/* TTU parameters */
3439 		uint32_t qos_level_low_wm;               /* TTU_CNTL1->QoSLevelLowWaterMark from ttu_regs.qos_level_low_wm */
3440 		uint32_t qos_level_high_wm;              /* TTU_CNTL1->QoSLevelHighWaterMark from ttu_regs.qos_level_high_wm */
3441 		uint32_t qos_level_flip;                 /* TTU_CNTL2->QoS_LEVEL_FLIP_L from ttu_regs.qos_level_flip */
3442 		uint32_t min_ttu_vblank;                 /* DCN_GLOBAL_TTU_CNTL->MIN_TTU_VBLANK from ttu_regs.min_ttu_vblank */
3443 	} hubp[MAX_PIPES];
3444 
3445 	/* HUBBUB register programming variables */
3446 	struct {
3447 		/* Individual DET buffer control per pipe - software state that programs DET registers */
3448 		uint32_t det0_size;                      /* DCHUBBUB_DET0_CTRL->DET0_SIZE from hubbub->funcs->program_det_size(hubbub, 0, det_buffer_size_kb) */
3449 		uint32_t det1_size;                      /* DCHUBBUB_DET1_CTRL->DET1_SIZE from hubbub->funcs->program_det_size(hubbub, 1, det_buffer_size_kb) */
3450 		uint32_t det2_size;                      /* DCHUBBUB_DET2_CTRL->DET2_SIZE from hubbub->funcs->program_det_size(hubbub, 2, det_buffer_size_kb) */
3451 		uint32_t det3_size;                      /* DCHUBBUB_DET3_CTRL->DET3_SIZE from hubbub->funcs->program_det_size(hubbub, 3, det_buffer_size_kb) */
3452 
3453 		/* Compression buffer control - software state that programs COMPBUF registers */
3454 		uint32_t compbuf_size;                   /* DCHUBBUB_COMPBUF_CTRL->COMPBUF_SIZE from hubbub->funcs->program_compbuf_size(hubbub, compbuf_size_kb, safe_to_increase) */
3455 		uint32_t compbuf_reserved_space_64b;     /* COMPBUF_RESERVED_SPACE->COMPBUF_RESERVED_SPACE_64B from hubbub2->pixel_chunk_size / 32 */
3456 		uint32_t compbuf_reserved_space_zs;      /* COMPBUF_RESERVED_SPACE->COMPBUF_RESERVED_SPACE_ZS from hubbub2->pixel_chunk_size / 128 */
3457 	} hubbub;
3458 
3459 	/* DPP register programming variables for each pipe (simplified for available fields) */
3460 	struct {
3461 		uint32_t dpp_clock_enable;               /* DPP_CONTROL->DPP_CLOCK_ENABLE from dppclk_enable */
3462 
3463 		/* Recout (Rectangle of Interest) configuration */
3464 		uint32_t recout_start_x;                 /* RECOUT_START->RECOUT_START_X from pipe_ctx->plane_res.scl_data.recout.x */
3465 		uint32_t recout_start_y;                 /* RECOUT_START->RECOUT_START_Y from pipe_ctx->plane_res.scl_data.recout.y */
3466 		uint32_t recout_width;                   /* RECOUT_SIZE->RECOUT_WIDTH from pipe_ctx->plane_res.scl_data.recout.width */
3467 		uint32_t recout_height;                  /* RECOUT_SIZE->RECOUT_HEIGHT from pipe_ctx->plane_res.scl_data.recout.height */
3468 
3469 		/* MPC (Multiple Pipe/Plane Combiner) size configuration */
3470 		uint32_t mpc_width;                      /* MPC_SIZE->MPC_WIDTH from pipe_ctx->plane_res.scl_data.h_active */
3471 		uint32_t mpc_height;                     /* MPC_SIZE->MPC_HEIGHT from pipe_ctx->plane_res.scl_data.v_active */
3472 
3473 		/* DSCL mode configuration */
3474 		uint32_t dscl_mode;                      /* SCL_MODE->DSCL_MODE from pipe_ctx->plane_res.scl_data.dscl_prog_data.dscl_mode */
3475 
3476 		/* Scaler ratios (simplified to integer parts) */
3477 		uint32_t horz_ratio_int;                 /* SCL_HORZ_FILTER_SCALE_RATIO->SCL_H_SCALE_RATIO integer part from ratios.horz */
3478 		uint32_t vert_ratio_int;                 /* SCL_VERT_FILTER_SCALE_RATIO->SCL_V_SCALE_RATIO integer part from ratios.vert */
3479 
3480 		/* Basic scaler taps */
3481 		uint32_t h_taps;                         /* SCL_TAP_CONTROL->SCL_H_NUM_TAPS from taps.h_taps */
3482 		uint32_t v_taps;                         /* SCL_TAP_CONTROL->SCL_V_NUM_TAPS from taps.v_taps */
3483 	} dpp[MAX_PIPES];
3484 
3485 	/* DCCG register programming variables */
3486 	struct {
3487 		/* Core Display Clock Control */
3488 		uint32_t dispclk_khz;                    /* DENTIST_DISPCLK_CNTL->DENTIST_DISPCLK_WDIVIDER from clk_mgr.dispclk_khz */
3489 		uint32_t dc_mem_global_pwr_req_dis;      /* DC_MEM_GLOBAL_PWR_REQ_CNTL->DC_MEM_GLOBAL_PWR_REQ_DIS from memory power management settings */
3490 
3491 		/* DPP Clock Control - 4 fields per pipe */
3492 		uint32_t dppclk_khz[MAX_PIPES];          /* DPPCLK_CTRL->DPPCLK_R_GATE_DISABLE from dpp_clocks[pipe] */
3493 		uint32_t dppclk_enable[MAX_PIPES];       /* DPPCLK_CTRL->DPPCLK0_EN,DPPCLK1_EN,DPPCLK2_EN,DPPCLK3_EN from dccg31_update_dpp_dto() */
3494 		uint32_t dppclk_dto_enable[MAX_PIPES];   /* DPPCLK_DTO_CTRL->DPPCLK_DTO_ENABLE from dccg->dpp_clock_gated[dpp_inst] state */
3495 		uint32_t dppclk_dto_phase[MAX_PIPES];    /* DPPCLK0_DTO_PARAM->DPPCLK0_DTO_PHASE from phase calculation req_dppclk/ref_dppclk */
3496 		uint32_t dppclk_dto_modulo[MAX_PIPES];   /* DPPCLK0_DTO_PARAM->DPPCLK0_DTO_MODULO from modulo = 0xff */
3497 
3498 		/* DSC Clock Control - 4 fields per DSC resource */
3499 		uint32_t dscclk_khz[MAX_PIPES]; /* DSCCLK_DTO_CTRL->DSCCLK_DTO_ENABLE from dsc_clocks */
3500 		uint32_t dscclk_dto_enable[MAX_PIPES]; /* DSCCLK_DTO_CTRL->DSCCLK0_DTO_ENABLE,DSCCLK1_DTO_ENABLE,DSCCLK2_DTO_ENABLE,DSCCLK3_DTO_ENABLE */
3501 		uint32_t dscclk_dto_phase[MAX_PIPES];  /* DSCCLK0_DTO_PARAM->DSCCLK0_DTO_PHASE from dccg31_enable_dscclk() */
3502 		uint32_t dscclk_dto_modulo[MAX_PIPES]; /* DSCCLK0_DTO_PARAM->DSCCLK0_DTO_MODULO from dccg31_enable_dscclk() */
3503 
3504 		/* Pixel Clock Control - per pipe */
3505 		uint32_t pixclk_khz[MAX_PIPES];          /* PIXCLK_RESYNC_CNTL->PIXCLK_RESYNC_ENABLE from stream.timing.pix_clk_100hz */
3506 		uint32_t otg_pixel_rate_div[MAX_PIPES];  /* OTG_PIXEL_RATE_DIV->OTG_PIXEL_RATE_DIV from OTG pixel rate divider control */
3507 		uint32_t dtbclk_dto_enable[MAX_PIPES];   /* OTG0_PIXEL_RATE_CNTL->DTBCLK_DTO_ENABLE from dccg31_set_dtbclk_dto() */
3508 		uint32_t pipe_dto_src_sel[MAX_PIPES];    /* OTG0_PIXEL_RATE_CNTL->PIPE_DTO_SRC_SEL from dccg31_set_dtbclk_dto() source selection */
3509 		uint32_t dtbclk_dto_div[MAX_PIPES];      /* OTG0_PIXEL_RATE_CNTL->DTBCLK_DTO_DIV from dtbdto_div calculation */
3510 		uint32_t otg_add_pixel[MAX_PIPES];       /* OTG0_PIXEL_RATE_CNTL->OTG_ADD_PIXEL from dccg31_otg_add_pixel() */
3511 		uint32_t otg_drop_pixel[MAX_PIPES];      /* OTG0_PIXEL_RATE_CNTL->OTG_DROP_PIXEL from dccg31_otg_drop_pixel() */
3512 
3513 		/* DTBCLK DTO Control - 4 DTOs */
3514 		uint32_t dtbclk_dto_modulo[4];           /* DTBCLK_DTO0_MODULO->DTBCLK_DTO0_MODULO from dccg31_set_dtbclk_dto() modulo calculation */
3515 		uint32_t dtbclk_dto_phase[4];            /* DTBCLK_DTO0_PHASE->DTBCLK_DTO0_PHASE from phase calculation pixclk_khz/ref_dtbclk_khz */
3516 		uint32_t dtbclk_dto_dbuf_en;             /* DTBCLK_DTO_DBUF_EN->DTBCLK DTO data buffer enable */
3517 
3518 		/* DP Stream Clock Control - 4 pipes */
3519 		uint32_t dpstreamclk_enable[MAX_PIPES];          /* DPSTREAMCLK_CNTL->DPSTREAMCLK_PIPE0_EN,DPSTREAMCLK_PIPE1_EN,DPSTREAMCLK_PIPE2_EN,DPSTREAMCLK_PIPE3_EN */
3520 		uint32_t dp_dto_modulo[4];               /* DP_DTO0_MODULO->DP_DTO0_MODULO from DP stream DTO programming */
3521 		uint32_t dp_dto_phase[4];                /* DP_DTO0_PHASE->DP_DTO0_PHASE from DP stream DTO programming */
3522 		uint32_t dp_dto_dbuf_en;                 /* DP_DTO_DBUF_EN->DP DTO data buffer enable */
3523 
3524 		/* PHY Symbol Clock Control - 5 PHYs (A,B,C,D,E) */
3525 		uint32_t phy_symclk_force_en[5];         /* PHYASYMCLK_CLOCK_CNTL->PHYASYMCLK_FORCE_EN from dccg31_set_physymclk() force_enable */
3526 		uint32_t phy_symclk_force_src_sel[5];    /* PHYASYMCLK_CLOCK_CNTL->PHYASYMCLK_FORCE_SRC_SEL from dccg31_set_physymclk() clk_src */
3527 		uint32_t phy_symclk_gate_disable[5];     /* DCCG_GATE_DISABLE_CNTL2->PHYASYMCLK_GATE_DISABLE from debug.root_clock_optimization.bits.physymclk */
3528 
3529 		/* SYMCLK32 SE Control - 4 instances */
3530 		uint32_t symclk32_se_src_sel[4];         /* SYMCLK32_SE_CNTL->SYMCLK32_SE0_SRC_SEL from dccg31_enable_symclk32_se() with get_phy_mux_symclk() mapping */
3531 		uint32_t symclk32_se_enable[4];          /* SYMCLK32_SE_CNTL->SYMCLK32_SE0_EN from dccg31_enable_symclk32_se() enable */
3532 		uint32_t symclk32_se_gate_disable[4];    /* DCCG_GATE_DISABLE_CNTL3->SYMCLK32_SE0_GATE_DISABLE from debug.root_clock_optimization.bits.symclk32_se */
3533 
3534 		/* SYMCLK32 LE Control - 2 instances */
3535 		uint32_t symclk32_le_src_sel[2];         /* SYMCLK32_LE_CNTL->SYMCLK32_LE0_SRC_SEL from dccg31_enable_symclk32_le() phyd32clk source */
3536 		uint32_t symclk32_le_enable[2];          /* SYMCLK32_LE_CNTL->SYMCLK32_LE0_EN from dccg31_enable_symclk32_le() enable */
3537 		uint32_t symclk32_le_gate_disable[2];    /* DCCG_GATE_DISABLE_CNTL3->SYMCLK32_LE0_GATE_DISABLE from debug.root_clock_optimization.bits.symclk32_le */
3538 
3539 		/* HDMI Clock Control */
3540 		uint32_t hdmicharclk_enable;             /* HDMICHARCLK0_CLOCK_CNTL->HDMICHARCLK0_EN from dccg31_enable_hdmicharclk() */
3541 		uint32_t hdmicharclk_src_sel;            /* HDMICHARCLK0_CLOCK_CNTL->HDMICHARCLK0_SRC_SEL from dccg31_enable_hdmicharclk() phypll_inst source */
3542 		uint32_t hdmistreamclk_src_sel;          /* HDMISTREAMCLK_CNTL->HDMISTREAMCLK0_SRC_SEL from dccg31_set_hdmistreamclk() src selection */
3543 		uint32_t hdmistreamclk_dto_force_dis;    /* HDMISTREAMCLK_CNTL->HDMISTREAMCLK0_DTO_FORCE_DIS from dccg31_set_hdmistreamclk() DTO force bypass */
3544 		uint32_t hdmistreamclk_dto_phase;        /* HDMISTREAMCLK0_DTO_PARAM->HDMISTREAMCLK0_DTO_PHASE from dccg31_disable_hdmistreamclk() */
3545 		uint32_t hdmistreamclk_dto_modulo;       /* HDMISTREAMCLK0_DTO_PARAM->HDMISTREAMCLK0_DTO_MODULO from dccg31_disable_hdmistreamclk() */
3546 
3547 		/* DPIA Clock Control */
3548 		uint32_t dpiaclk_540m_dto_modulo;        /* DPIACLK_540M_DTO_MODULO->DPIA 540MHz DTO modulo */
3549 		uint32_t dpiaclk_540m_dto_phase;         /* DPIACLK_540M_DTO_PHASE->DPIA 540MHz DTO phase */
3550 		uint32_t dpiaclk_810m_dto_modulo;        /* DPIACLK_810M_DTO_MODULO->DPIA 810MHz DTO modulo */
3551 		uint32_t dpiaclk_810m_dto_phase;         /* DPIACLK_810M_DTO_PHASE->DPIA 810MHz DTO phase */
3552 		uint32_t dpiaclk_dto_cntl;               /* DPIACLK_DTO_CNTL->DPIA clock DTO control */
3553 		uint32_t dpiasymclk_cntl;                /* DPIASYMCLK_CNTL->DPIA symbol clock control */
3554 
3555 		/* Clock Gating Control */
3556 		uint32_t dccg_gate_disable_cntl;         /* DCCG_GATE_DISABLE_CNTL->Clock gate disable control from dccg31_init() */
3557 		uint32_t dpstreamclk_gate_disable;       /* DCCG_GATE_DISABLE_CNTL3->DPSTREAMCLK_GATE_DISABLE from debug.root_clock_optimization.bits.dpstream */
3558 		uint32_t dpstreamclk_root_gate_disable;  /* DCCG_GATE_DISABLE_CNTL3->DPSTREAMCLK_ROOT_GATE_DISABLE from debug.root_clock_optimization.bits.dpstream */
3559 
3560 		/* VSync Control */
3561 		uint32_t vsync_cnt_ctrl;                 /* DCCG_VSYNC_CNT_CTRL->VSync counter control */
3562 		uint32_t vsync_cnt_int_ctrl;             /* DCCG_VSYNC_CNT_INT_CTRL->VSync counter interrupt control */
3563 		uint32_t vsync_otg_latch_value[6];       /* DCCG_VSYNC_OTG0_LATCH_VALUE->OTG0 VSync latch value (for OTG0-5) */
3564 
3565 		/* Time Base Control */
3566 		uint32_t microsecond_time_base_div;      /* MICROSECOND_TIME_BASE_DIV->Microsecond time base divider */
3567 		uint32_t millisecond_time_base_div;      /* MILLISECOND_TIME_BASE_DIV->Millisecond time base divider */
3568 	} dccg;
3569 
3570 	/* DSC essential configuration for underflow analysis */
3571 	struct {
3572 		/* DSC active state - critical for bandwidth analysis */
3573 		uint32_t dsc_clock_enable;               /* DSC enabled - affects bandwidth requirements */
3574 
3575 		/* DSC configuration affecting bandwidth and timing */
3576 		uint32_t dsc_num_slices_h;              /* Horizontal slice count - affects throughput */
3577 		uint32_t dsc_num_slices_v;              /* Vertical slice count - affects throughput */
3578 		uint32_t dsc_bits_per_pixel;            /* Compression ratio - affects bandwidth */
3579 
3580 		/* OPP integration - affects pipeline flow */
3581 		uint32_t dscrm_dsc_forward_enable;      /* DSC forwarding to OPP enabled */
3582 		uint32_t dscrm_dsc_opp_pipe_source;    /* Which OPP receives DSC output */
3583 	} dsc[MAX_PIPES];
3584 
3585 	/* MPC register programming variables */
3586 	struct {
3587 		/* MPCC blending tree and mode control */
3588 		uint32_t mpcc_mode[MAX_PIPES];           /* MPCC_CONTROL->MPCC_MODE from blend_cfg.blend_mode */
3589 		uint32_t mpcc_alpha_blend_mode[MAX_PIPES]; /* MPCC_CONTROL->MPCC_ALPHA_BLND_MODE from blend_cfg.alpha_mode */
3590 		uint32_t mpcc_alpha_multiplied_mode[MAX_PIPES]; /* MPCC_CONTROL->MPCC_ALPHA_MULTIPLIED_MODE from blend_cfg.pre_multiplied_alpha */
3591 		uint32_t mpcc_blnd_active_overlap_only[MAX_PIPES]; /* MPCC_CONTROL->MPCC_BLND_ACTIVE_OVERLAP_ONLY from blend_cfg.overlap_only */
3592 		uint32_t mpcc_global_alpha[MAX_PIPES];   /* MPCC_CONTROL->MPCC_GLOBAL_ALPHA from blend_cfg.global_alpha */
3593 		uint32_t mpcc_global_gain[MAX_PIPES];    /* MPCC_CONTROL->MPCC_GLOBAL_GAIN from blend_cfg.global_gain */
3594 		uint32_t mpcc_bg_bpc[MAX_PIPES];         /* MPCC_CONTROL->MPCC_BG_BPC from background color depth */
3595 		uint32_t mpcc_bot_gain_mode[MAX_PIPES];  /* MPCC_CONTROL->MPCC_BOT_GAIN_MODE from bottom layer gain control */
3596 
3597 		/* MPCC blending tree connections */
3598 		uint32_t mpcc_bot_sel[MAX_PIPES];        /* MPCC_BOT_SEL->MPCC_BOT_SEL from mpcc_state->bot_sel */
3599 		uint32_t mpcc_top_sel[MAX_PIPES];        /* MPCC_TOP_SEL->MPCC_TOP_SEL from mpcc_state->dpp_id */
3600 
3601 		/* MPCC output gamma control */
3602 		uint32_t mpcc_ogam_mode[MAX_PIPES];      /* MPCC_OGAM_CONTROL->MPCC_OGAM_MODE from output gamma mode */
3603 		uint32_t mpcc_ogam_select[MAX_PIPES];    /* MPCC_OGAM_CONTROL->MPCC_OGAM_SELECT from gamma LUT bank selection */
3604 		uint32_t mpcc_ogam_pwl_disable[MAX_PIPES]; /* MPCC_OGAM_CONTROL->MPCC_OGAM_PWL_DISABLE from PWL control */
3605 
3606 		/* MPCC pipe assignment and status */
3607 		uint32_t mpcc_opp_id[MAX_PIPES];         /* MPCC_OPP_ID->MPCC_OPP_ID from mpcc_state->opp_id */
3608 		uint32_t mpcc_idle[MAX_PIPES];           /* MPCC_STATUS->MPCC_IDLE from mpcc idle status */
3609 		uint32_t mpcc_busy[MAX_PIPES];           /* MPCC_STATUS->MPCC_BUSY from mpcc busy status */
3610 
3611 		/* MPC output processing */
3612 		uint32_t mpc_out_csc_mode;               /* MPC_OUT_CSC_COEF->MPC_OUT_CSC_MODE from output_csc */
3613 		uint32_t mpc_out_gamma_mode;             /* MPC_OUT_GAMMA_LUT->MPC_OUT_GAMMA_MODE from output_gamma */
3614 	} mpc;
3615 
3616 	/* OPP register programming variables for each pipe */
3617 	struct {
3618 		/* Display Pattern Generator (DPG) Control - 19 fields from DPG_CONTROL register */
3619 		uint32_t dpg_enable;                     /* DPG_CONTROL->DPG_EN from test_pattern parameter (enable/disable) */
3620 
3621 		/* Format Control (FMT) - 18 fields from FMT_CONTROL register */
3622 		uint32_t fmt_pixel_encoding;             /* FMT_CONTROL->FMT_PIXEL_ENCODING from clamping->pixel_encoding */
3623 		uint32_t fmt_subsampling_mode;           /* FMT_CONTROL->FMT_SUBSAMPLING_MODE from force_chroma_subsampling_1tap */
3624 		uint32_t fmt_cbcr_bit_reduction_bypass;  /* FMT_CONTROL->FMT_CBCR_BIT_REDUCTION_BYPASS from pixel_encoding bypass control */
3625 		uint32_t fmt_stereosync_override;        /* FMT_CONTROL->FMT_STEREOSYNC_OVERRIDE from stereo timing override */
3626 		uint32_t fmt_spatial_dither_frame_counter_max; /* FMT_CONTROL->FMT_SPATIAL_DITHER_FRAME_COUNTER_MAX from fmt_bit_depth->flags */
3627 		uint32_t fmt_spatial_dither_frame_counter_bit_swap; /* FMT_CONTROL->FMT_SPATIAL_DITHER_FRAME_COUNTER_BIT_SWAP from dither control */
3628 		uint32_t fmt_truncate_enable;            /* FMT_CONTROL->FMT_TRUNCATE_EN from fmt_bit_depth->flags.TRUNCATE_ENABLED */
3629 		uint32_t fmt_truncate_depth;             /* FMT_CONTROL->FMT_TRUNCATE_DEPTH from fmt_bit_depth->flags.TRUNCATE_DEPTH */
3630 		uint32_t fmt_truncate_mode;              /* FMT_CONTROL->FMT_TRUNCATE_MODE from fmt_bit_depth->flags.TRUNCATE_MODE */
3631 		uint32_t fmt_spatial_dither_enable;      /* FMT_CONTROL->FMT_SPATIAL_DITHER_EN from fmt_bit_depth->flags.SPATIAL_DITHER_ENABLED */
3632 		uint32_t fmt_spatial_dither_mode;        /* FMT_CONTROL->FMT_SPATIAL_DITHER_MODE from fmt_bit_depth->flags.SPATIAL_DITHER_MODE */
3633 		uint32_t fmt_spatial_dither_depth;       /* FMT_CONTROL->FMT_SPATIAL_DITHER_DEPTH from fmt_bit_depth->flags.SPATIAL_DITHER_DEPTH */
3634 		uint32_t fmt_temporal_dither_enable;     /* FMT_CONTROL->FMT_TEMPORAL_DITHER_EN from fmt_bit_depth->flags.TEMPORAL_DITHER_ENABLED */
3635 		uint32_t fmt_clamp_data_enable;          /* FMT_CONTROL->FMT_CLAMP_DATA_EN from clamping->clamping_range enable */
3636 		uint32_t fmt_clamp_color_format;         /* FMT_CONTROL->FMT_CLAMP_COLOR_FORMAT from clamping->color_format */
3637 		uint32_t fmt_dynamic_exp_enable;         /* FMT_CONTROL->FMT_DYNAMIC_EXP_EN from color_sp/color_dpth/signal */
3638 		uint32_t fmt_dynamic_exp_mode;           /* FMT_CONTROL->FMT_DYNAMIC_EXP_MODE from color space mode mapping */
3639 		uint32_t fmt_bit_depth_control;          /* Legacy field - kept for compatibility */
3640 
3641 		/* OPP Pipe Control - 1 field from OPP_PIPE_CONTROL register */
3642 		uint32_t opp_pipe_clock_enable;          /* OPP_PIPE_CONTROL->OPP_PIPE_CLOCK_EN from enable parameter (bool) */
3643 
3644 		/* OPP CRC Control - 3 fields from OPP_PIPE_CRC_CONTROL register */
3645 		uint32_t opp_crc_enable;                 /* OPP_PIPE_CRC_CONTROL->CRC_EN from CRC enable control */
3646 		uint32_t opp_crc_select_source;          /* OPP_PIPE_CRC_CONTROL->CRC_SELECT_SOURCE from CRC source selection */
3647 		uint32_t opp_crc_stereo_cont;            /* OPP_PIPE_CRC_CONTROL->CRC_STEREO_CONT from stereo continuous CRC */
3648 
3649 		/* Output Buffer (OPPBUF) Control - 6 fields from OPPBUF_CONTROL register */
3650 		uint32_t oppbuf_active_width;            /* OPPBUF_CONTROL->OPPBUF_ACTIVE_WIDTH from oppbuf_params->active_width */
3651 		uint32_t oppbuf_pixel_repetition;        /* OPPBUF_CONTROL->OPPBUF_PIXEL_REPETITION from oppbuf_params->pixel_repetition */
3652 		uint32_t oppbuf_display_segmentation;    /* OPPBUF_CONTROL->OPPBUF_DISPLAY_SEGMENTATION from oppbuf_params->mso_segmentation */
3653 		uint32_t oppbuf_overlap_pixel_num;       /* OPPBUF_CONTROL->OPPBUF_OVERLAP_PIXEL_NUM from oppbuf_params->mso_overlap_pixel_num */
3654 		uint32_t oppbuf_3d_vact_space1_size;     /* OPPBUF_CONTROL->OPPBUF_3D_VACT_SPACE1_SIZE from 3D timing space1_size */
3655 		uint32_t oppbuf_3d_vact_space2_size;     /* OPPBUF_CONTROL->OPPBUF_3D_VACT_SPACE2_SIZE from 3D timing space2_size */
3656 
3657 		/* DSC Forward Config - 3 fields from DSCRM_DSC_FORWARD_CONFIG register */
3658 		uint32_t dscrm_dsc_forward_enable;       /* DSCRM_DSC_FORWARD_CONFIG->DSCRM_DSC_FORWARD_EN from DSC forward enable control */
3659 		uint32_t dscrm_dsc_opp_pipe_source;      /* DSCRM_DSC_FORWARD_CONFIG->DSCRM_DSC_OPP_PIPE_SOURCE from opp_pipe parameter */
3660 		uint32_t dscrm_dsc_forward_enable_status; /* DSCRM_DSC_FORWARD_CONFIG->DSCRM_DSC_FORWARD_EN_STATUS from DSC forward status (read-only) */
3661 	} opp[MAX_PIPES];
3662 
3663 	/* OPTC register programming variables for each pipe */
3664 	struct {
3665 		uint32_t otg_master_inst;
3666 
3667 		/* OTG_CONTROL register - 5 fields for OTG control */
3668 		uint32_t otg_master_enable;              /* OTG_CONTROL->OTG_MASTER_EN from timing enable/disable control */
3669 		uint32_t otg_disable_point_cntl;         /* OTG_CONTROL->OTG_DISABLE_POINT_CNTL from disable timing control */
3670 		uint32_t otg_start_point_cntl;           /* OTG_CONTROL->OTG_START_POINT_CNTL from start timing control */
3671 		uint32_t otg_field_number_cntl;          /* OTG_CONTROL->OTG_FIELD_NUMBER_CNTL from interlace field control */
3672 		uint32_t otg_out_mux;                    /* OTG_CONTROL->OTG_OUT_MUX from output mux selection */
3673 
3674 		/* OTG Horizontal Timing - 7 fields */
3675 		uint32_t otg_h_total;                    /* OTG_H_TOTAL->OTG_H_TOTAL from dc_crtc_timing->h_total */
3676 		uint32_t otg_h_blank_start;              /* OTG_H_BLANK_START_END->OTG_H_BLANK_START from dc_crtc_timing->h_front_porch */
3677 		uint32_t otg_h_blank_end;                /* OTG_H_BLANK_START_END->OTG_H_BLANK_END from dc_crtc_timing->h_addressable_video_pixel_width */
3678 		uint32_t otg_h_sync_start;               /* OTG_H_SYNC_A->OTG_H_SYNC_A_START from dc_crtc_timing->h_sync_width */
3679 		uint32_t otg_h_sync_end;                 /* OTG_H_SYNC_A->OTG_H_SYNC_A_END from calculated sync end position */
3680 		uint32_t otg_h_sync_polarity;            /* OTG_H_SYNC_A_CNTL->OTG_H_SYNC_A_POL from dc_crtc_timing->flags.HSYNC_POSITIVE_POLARITY */
3681 		uint32_t otg_h_timing_div_mode;          /* OTG_H_TIMING_CNTL->OTG_H_TIMING_DIV_MODE from horizontal timing division mode */
3682 
3683 		/* OTG Vertical Timing - 7 fields */
3684 		uint32_t otg_v_total;                    /* OTG_V_TOTAL->OTG_V_TOTAL from dc_crtc_timing->v_total */
3685 		uint32_t otg_v_blank_start;              /* OTG_V_BLANK_START_END->OTG_V_BLANK_START from dc_crtc_timing->v_front_porch */
3686 		uint32_t otg_v_blank_end;                /* OTG_V_BLANK_START_END->OTG_V_BLANK_END from dc_crtc_timing->v_addressable_video_line_width */
3687 		uint32_t otg_v_sync_start;               /* OTG_V_SYNC_A->OTG_V_SYNC_A_START from dc_crtc_timing->v_sync_width */
3688 		uint32_t otg_v_sync_end;                 /* OTG_V_SYNC_A->OTG_V_SYNC_A_END from calculated sync end position */
3689 		uint32_t otg_v_sync_polarity;            /* OTG_V_SYNC_A_CNTL->OTG_V_SYNC_A_POL from dc_crtc_timing->flags.VSYNC_POSITIVE_POLARITY */
3690 		uint32_t otg_v_sync_mode;                /* OTG_V_SYNC_A_CNTL->OTG_V_SYNC_MODE from sync mode selection */
3691 
3692 		/* OTG DRR (Dynamic Refresh Rate) Control - 8 fields */
3693 		uint32_t otg_v_total_max;                /* OTG_V_TOTAL_MAX->OTG_V_TOTAL_MAX from drr_params->vertical_total_max */
3694 		uint32_t otg_v_total_min;                /* OTG_V_TOTAL_MIN->OTG_V_TOTAL_MIN from drr_params->vertical_total_min */
3695 		uint32_t otg_v_total_mid;                /* OTG_V_TOTAL_MID->OTG_V_TOTAL_MID from drr_params->vertical_total_mid */
3696 		uint32_t otg_v_total_max_sel;            /* OTG_V_TOTAL_CONTROL->OTG_V_TOTAL_MAX_SEL from DRR max selection enable */
3697 		uint32_t otg_v_total_min_sel;            /* OTG_V_TOTAL_CONTROL->OTG_V_TOTAL_MIN_SEL from DRR min selection enable */
3698 		uint32_t otg_vtotal_mid_replacing_max_en; /* OTG_V_TOTAL_CONTROL->OTG_VTOTAL_MID_REPLACING_MAX_EN from DRR mid-frame enable */
3699 		uint32_t otg_vtotal_mid_frame_num;       /* OTG_V_TOTAL_CONTROL->OTG_VTOTAL_MID_FRAME_NUM from drr_params->vertical_total_mid_frame_num */
3700 		uint32_t otg_set_v_total_min_mask;       /* OTG_V_TOTAL_CONTROL->OTG_SET_V_TOTAL_MIN_MASK from DRR trigger mask */
3701 		uint32_t otg_force_lock_on_event;        /* OTG_V_TOTAL_CONTROL->OTG_FORCE_LOCK_ON_EVENT from DRR force lock control */
3702 
3703 		/* OPTC Data Source and ODM - 6 fields */
3704 		uint32_t optc_seg0_src_sel;              /* OPTC_DATA_SOURCE_SELECT->OPTC_SEG0_SRC_SEL from opp_id[0] ODM segment 0 source */
3705 		uint32_t optc_seg1_src_sel;              /* OPTC_DATA_SOURCE_SELECT->OPTC_SEG1_SRC_SEL from opp_id[1] ODM segment 1 source */
3706 		uint32_t optc_seg2_src_sel;              /* OPTC_DATA_SOURCE_SELECT->OPTC_SEG2_SRC_SEL from opp_id[2] ODM segment 2 source */
3707 		uint32_t optc_seg3_src_sel;              /* OPTC_DATA_SOURCE_SELECT->OPTC_SEG3_SRC_SEL from opp_id[3] ODM segment 3 source */
3708 		uint32_t optc_num_of_input_segment;      /* OPTC_DATA_SOURCE_SELECT->OPTC_NUM_OF_INPUT_SEGMENT from opp_cnt-1 number of input segments */
3709 		uint32_t optc_mem_sel;                   /* OPTC_MEMORY_CONFIG->OPTC_MEM_SEL from memory_mask ODM memory selection */
3710 
3711 		/* OPTC Data Format and DSC - 4 fields */
3712 		uint32_t optc_data_format;               /* OPTC_DATA_FORMAT_CONTROL->OPTC_DATA_FORMAT from data format selection */
3713 		uint32_t optc_dsc_mode;                  /* OPTC_DATA_FORMAT_CONTROL->OPTC_DSC_MODE from dsc_mode parameter */
3714 		uint32_t optc_dsc_bytes_per_pixel;       /* OPTC_BYTES_PER_PIXEL->OPTC_DSC_BYTES_PER_PIXEL from dsc_bytes_per_pixel parameter */
3715 		uint32_t optc_segment_width;             /* OPTC_WIDTH_CONTROL->OPTC_SEGMENT_WIDTH from segment_width parameter */
3716 		uint32_t optc_dsc_slice_width;           /* OPTC_WIDTH_CONTROL->OPTC_DSC_SLICE_WIDTH from dsc_slice_width parameter */
3717 
3718 		/* OPTC Clock and Underflow Control - 4 fields */
3719 		uint32_t optc_input_pix_clk_en;          /* OPTC_INPUT_CLOCK_CONTROL->OPTC_INPUT_PIX_CLK_EN from pixel clock enable */
3720 		uint32_t optc_underflow_occurred_status; /* OPTC_INPUT_GLOBAL_CONTROL->OPTC_UNDERFLOW_OCCURRED_STATUS from underflow status (read-only) */
3721 		uint32_t optc_underflow_clear;           /* OPTC_INPUT_GLOBAL_CONTROL->OPTC_UNDERFLOW_CLEAR from underflow clear control */
3722 		uint32_t otg_clock_enable;               /* OTG_CLOCK_CONTROL->OTG_CLOCK_EN from OTG clock enable */
3723 		uint32_t otg_clock_gate_dis;             /* OTG_CLOCK_CONTROL->OTG_CLOCK_GATE_DIS from clock gate disable */
3724 
3725 		/* OTG Stereo and 3D Control - 6 fields */
3726 		uint32_t otg_stereo_enable;              /* OTG_STEREO_CONTROL->OTG_STEREO_EN from stereo enable control */
3727 		uint32_t otg_stereo_sync_output_line_num; /* OTG_STEREO_CONTROL->OTG_STEREO_SYNC_OUTPUT_LINE_NUM from timing->stereo_3d_format line num */
3728 		uint32_t otg_stereo_sync_output_polarity; /* OTG_STEREO_CONTROL->OTG_STEREO_SYNC_OUTPUT_POLARITY from stereo polarity control */
3729 		uint32_t otg_3d_structure_en;            /* OTG_3D_STRUCTURE_CONTROL->OTG_3D_STRUCTURE_EN from 3D structure enable */
3730 		uint32_t otg_3d_structure_v_update_mode; /* OTG_3D_STRUCTURE_CONTROL->OTG_3D_STRUCTURE_V_UPDATE_MODE from 3D vertical update mode */
3731 		uint32_t otg_3d_structure_stereo_sel_ovr; /* OTG_3D_STRUCTURE_CONTROL->OTG_3D_STRUCTURE_STEREO_SEL_OVR from 3D stereo selection override */
3732 		uint32_t otg_interlace_enable;           /* OTG_INTERLACE_CONTROL->OTG_INTERLACE_ENABLE from dc_crtc_timing->flags.INTERLACE */
3733 
3734 		/* OTG GSL (Global Sync Lock) Control - 5 fields */
3735 		uint32_t otg_gsl0_en;                    /* OTG_GSL_CONTROL->OTG_GSL0_EN from GSL group 0 enable */
3736 		uint32_t otg_gsl1_en;                    /* OTG_GSL_CONTROL->OTG_GSL1_EN from GSL group 1 enable */
3737 		uint32_t otg_gsl2_en;                    /* OTG_GSL_CONTROL->OTG_GSL2_EN from GSL group 2 enable */
3738 		uint32_t otg_gsl_master_en;              /* OTG_GSL_CONTROL->OTG_GSL_MASTER_EN from GSL master enable */
3739 		uint32_t otg_gsl_master_mode;            /* OTG_GSL_CONTROL->OTG_GSL_MASTER_MODE from gsl_params->gsl_master mode */
3740 
3741 		/* OTG DRR Advanced Control - 4 fields */
3742 		uint32_t otg_v_total_last_used_by_drr;   /* OTG_DRR_CONTROL->OTG_V_TOTAL_LAST_USED_BY_DRR from last used DRR V_TOTAL (read-only) */
3743 		uint32_t otg_drr_trigger_window_start_x; /* OTG_DRR_TRIGGER_WINDOW->OTG_DRR_TRIGGER_WINDOW_START_X from window_start parameter */
3744 		uint32_t otg_drr_trigger_window_end_x;   /* OTG_DRR_TRIGGER_WINDOW->OTG_DRR_TRIGGER_WINDOW_END_X from window_end parameter */
3745 		uint32_t otg_drr_v_total_change_limit;   /* OTG_DRR_V_TOTAL_CHANGE->OTG_DRR_V_TOTAL_CHANGE_LIMIT from limit parameter */
3746 
3747 		/* OTG DSC Position Control - 2 fields */
3748 		uint32_t otg_dsc_start_position_x;       /* OTG_DSC_START_POSITION->OTG_DSC_START_POSITION_X from DSC start X position */
3749 		uint32_t otg_dsc_start_position_line_num; /* OTG_DSC_START_POSITION->OTG_DSC_START_POSITION_LINE_NUM from DSC start line number */
3750 
3751 		/* OTG Double Buffer Control - 2 fields */
3752 		uint32_t otg_drr_timing_dbuf_update_mode; /* OTG_DOUBLE_BUFFER_CONTROL->OTG_DRR_TIMING_DBUF_UPDATE_MODE from DRR double buffer mode */
3753 		uint32_t otg_blank_data_double_buffer_en; /* OTG_DOUBLE_BUFFER_CONTROL->OTG_BLANK_DATA_DOUBLE_BUFFER_EN from blank data double buffer enable */
3754 
3755 		/* OTG Vertical Interrupts - 6 fields */
3756 		uint32_t otg_vertical_interrupt0_int_enable; /* OTG_VERTICAL_INTERRUPT0_CONTROL->OTG_VERTICAL_INTERRUPT0_INT_ENABLE from interrupt 0 enable */
3757 		uint32_t otg_vertical_interrupt0_line_start; /* OTG_VERTICAL_INTERRUPT0_POSITION->OTG_VERTICAL_INTERRUPT0_LINE_START from start_line parameter */
3758 		uint32_t otg_vertical_interrupt1_int_enable; /* OTG_VERTICAL_INTERRUPT1_CONTROL->OTG_VERTICAL_INTERRUPT1_INT_ENABLE from interrupt 1 enable */
3759 		uint32_t otg_vertical_interrupt1_line_start; /* OTG_VERTICAL_INTERRUPT1_POSITION->OTG_VERTICAL_INTERRUPT1_LINE_START from start_line parameter */
3760 		uint32_t otg_vertical_interrupt2_int_enable; /* OTG_VERTICAL_INTERRUPT2_CONTROL->OTG_VERTICAL_INTERRUPT2_INT_ENABLE from interrupt 2 enable */
3761 		uint32_t otg_vertical_interrupt2_line_start; /* OTG_VERTICAL_INTERRUPT2_POSITION->OTG_VERTICAL_INTERRUPT2_LINE_START from start_line parameter */
3762 
3763 		/* OTG Global Sync Parameters - 6 fields */
3764 		uint32_t otg_vready_offset;              /* OTG_VREADY_PARAM->OTG_VREADY_OFFSET from vready_offset parameter */
3765 		uint32_t otg_vstartup_start;             /* OTG_VSTARTUP_PARAM->OTG_VSTARTUP_START from vstartup_start parameter */
3766 		uint32_t otg_vupdate_offset;             /* OTG_VUPDATE_PARAM->OTG_VUPDATE_OFFSET from vupdate_offset parameter */
3767 		uint32_t otg_vupdate_width;              /* OTG_VUPDATE_PARAM->OTG_VUPDATE_WIDTH from vupdate_width parameter */
3768 		uint32_t master_update_lock_vupdate_keepout_start_offset; /* OTG_VUPDATE_KEEPOUT->MASTER_UPDATE_LOCK_VUPDATE_KEEPOUT_START_OFFSET from pstate_keepout start */
3769 		uint32_t master_update_lock_vupdate_keepout_end_offset;   /* OTG_VUPDATE_KEEPOUT->MASTER_UPDATE_LOCK_VUPDATE_KEEPOUT_END_OFFSET from pstate_keepout end */
3770 
3771 		/* OTG Manual Trigger Control - 11 fields */
3772 		uint32_t otg_triga_source_select;        /* OTG_TRIGA_CNTL->OTG_TRIGA_SOURCE_SELECT from trigger A source selection */
3773 		uint32_t otg_triga_source_pipe_select;   /* OTG_TRIGA_CNTL->OTG_TRIGA_SOURCE_PIPE_SELECT from trigger A pipe selection */
3774 		uint32_t otg_triga_rising_edge_detect_cntl; /* OTG_TRIGA_CNTL->OTG_TRIGA_RISING_EDGE_DETECT_CNTL from trigger A rising edge detect */
3775 		uint32_t otg_triga_falling_edge_detect_cntl; /* OTG_TRIGA_CNTL->OTG_TRIGA_FALLING_EDGE_DETECT_CNTL from trigger A falling edge detect */
3776 		uint32_t otg_triga_polarity_select;      /* OTG_TRIGA_CNTL->OTG_TRIGA_POLARITY_SELECT from trigger A polarity selection */
3777 		uint32_t otg_triga_frequency_select;     /* OTG_TRIGA_CNTL->OTG_TRIGA_FREQUENCY_SELECT from trigger A frequency selection */
3778 		uint32_t otg_triga_delay;                /* OTG_TRIGA_CNTL->OTG_TRIGA_DELAY from trigger A delay */
3779 		uint32_t otg_triga_clear;                /* OTG_TRIGA_CNTL->OTG_TRIGA_CLEAR from trigger A clear */
3780 		uint32_t otg_triga_manual_trig;          /* OTG_TRIGA_MANUAL_TRIG->OTG_TRIGA_MANUAL_TRIG from manual trigger A */
3781 		uint32_t otg_trigb_source_select;        /* OTG_TRIGB_CNTL->OTG_TRIGB_SOURCE_SELECT from trigger B source selection */
3782 		uint32_t otg_trigb_polarity_select;      /* OTG_TRIGB_CNTL->OTG_TRIGB_POLARITY_SELECT from trigger B polarity selection */
3783 		uint32_t otg_trigb_manual_trig;          /* OTG_TRIGB_MANUAL_TRIG->OTG_TRIGB_MANUAL_TRIG from manual trigger B */
3784 
3785 		/* OTG Static Screen and Update Control - 6 fields */
3786 		uint32_t otg_static_screen_event_mask;   /* OTG_STATIC_SCREEN_CONTROL->OTG_STATIC_SCREEN_EVENT_MASK from event_triggers parameter */
3787 		uint32_t otg_static_screen_frame_count;  /* OTG_STATIC_SCREEN_CONTROL->OTG_STATIC_SCREEN_FRAME_COUNT from num_frames parameter */
3788 		uint32_t master_update_lock;             /* OTG_MASTER_UPDATE_LOCK->MASTER_UPDATE_LOCK from update lock control */
3789 		uint32_t master_update_mode;             /* OTG_MASTER_UPDATE_MODE->MASTER_UPDATE_MODE from update mode selection */
3790 		uint32_t otg_force_count_now_mode;       /* OTG_FORCE_COUNT_NOW_CNTL->OTG_FORCE_COUNT_NOW_MODE from force count mode */
3791 		uint32_t otg_force_count_now_clear;      /* OTG_FORCE_COUNT_NOW_CNTL->OTG_FORCE_COUNT_NOW_CLEAR from force count clear */
3792 
3793 		/* VTG Control - 3 fields */
3794 		uint32_t vtg0_enable;                    /* CONTROL->VTG0_ENABLE from VTG enable control */
3795 		uint32_t vtg0_fp2;                       /* CONTROL->VTG0_FP2 from VTG front porch 2 */
3796 		uint32_t vtg0_vcount_init;               /* CONTROL->VTG0_VCOUNT_INIT from VTG vertical count init */
3797 
3798 		/* OTG Status (Read-Only) - 12 fields */
3799 		uint32_t otg_v_blank;                    /* OTG_STATUS->OTG_V_BLANK from vertical blank status (read-only) */
3800 		uint32_t otg_v_active_disp;              /* OTG_STATUS->OTG_V_ACTIVE_DISP from vertical active display (read-only) */
3801 		uint32_t otg_frame_count;                /* OTG_STATUS_FRAME_COUNT->OTG_FRAME_COUNT from frame count (read-only) */
3802 		uint32_t otg_horz_count;                 /* OTG_STATUS_POSITION->OTG_HORZ_COUNT from horizontal position (read-only) */
3803 		uint32_t otg_vert_count;                 /* OTG_STATUS_POSITION->OTG_VERT_COUNT from vertical position (read-only) */
3804 		uint32_t otg_horz_count_hv;              /* OTG_STATUS_HV_COUNT->OTG_HORZ_COUNT from horizontal count (read-only) */
3805 		uint32_t otg_vert_count_nom;             /* OTG_STATUS_HV_COUNT->OTG_VERT_COUNT_NOM from vertical count nominal (read-only) */
3806 		uint32_t otg_flip_pending;               /* OTG_PIPE_UPDATE_STATUS->OTG_FLIP_PENDING from flip pending status (read-only) */
3807 		uint32_t otg_dc_reg_update_pending;      /* OTG_PIPE_UPDATE_STATUS->OTG_DC_REG_UPDATE_PENDING from DC register update pending (read-only) */
3808 		uint32_t otg_cursor_update_pending;      /* OTG_PIPE_UPDATE_STATUS->OTG_CURSOR_UPDATE_PENDING from cursor update pending (read-only) */
3809 		uint32_t otg_vupdate_keepout_status;     /* OTG_PIPE_UPDATE_STATUS->OTG_VUPDATE_KEEPOUT_STATUS from VUPDATE keepout status (read-only) */
3810 	} optc[MAX_PIPES];
3811 
3812 	/* Metadata */
3813 	uint32_t active_pipe_count;
3814 	uint32_t active_stream_count;
3815 	bool state_valid;
3816 };
3817 
3818 /**
3819  * dc_capture_register_software_state() - Capture software state for register programming
3820  * @dc: DC context containing current display configuration
3821  * @state: Pointer to dc_register_software_state structure to populate
3822  *
3823  * Extracts all software state variables that are used to program hardware register
3824  * fields across the display driver pipeline. This provides a complete snapshot
3825  * of the software configuration that drives hardware register programming.
3826  *
3827  * The function traverses the DC context and extracts values from:
3828  * - Stream configurations (timing, format, DSC settings)
3829  * - Plane states (surface format, rotation, scaling, cursor)
3830  * - Pipe contexts (resource allocation, blending, viewport)
3831  * - Clock manager (display clocks, DPP clocks, pixel clocks)
3832  * - Resource context (DET buffer allocation, ODM configuration)
3833  *
3834  * This is essential for underflow debugging as it captures the exact software
3835  * state that determines how registers are programmed, allowing analysis of
3836  * whether underflow is caused by incorrect register programming or timing issues.
3837  *
3838  * Return: true if state was successfully captured, false on error
3839  */
3840 bool dc_capture_register_software_state(struct dc *dc, struct dc_register_software_state *state);
3841 
3842 /**
3843  * dc_get_qos_info() - Retrieve Quality of Service (QoS) information from display core
3844  * @dc: DC context containing current display configuration
3845  * @info: Pointer to dc_qos_info structure to populate with QoS metrics
3846  *
3847  * This function retrieves QoS metrics from the display core that can be used by
3848  * benchmark tools to analyze display system performance. The function may take
3849  * several milliseconds to execute due to hardware measurement requirements.
3850  *
3851  * QoS information includes:
3852  * - Bandwidth bounds (lower limits in Mbps)
3853  * - Latency bounds (upper limits in nanoseconds)
3854  * - Hardware-measured bandwidth metrics (peak/average in Mbps)
3855  * - Hardware-measured latency metrics (maximum/average in nanoseconds)
3856  *
3857  * The function will populate the provided dc_qos_info structure with current
3858  * QoS measurements. If hardware measurement functions are not available for
3859  * the current DCN version, the function returns false with zero'd info structure.
3860  *
3861  * Return: true if QoS information was successfully retrieved, false if measurement
3862  *         functions are unavailable or hardware measurements cannot be performed
3863  */
3864 bool dc_get_qos_info(struct dc *dc, struct dc_qos_info *info);
3865 
3866 /**
3867  * dc_override_memory_bandwidth_request - Override the DCN nominal memory
3868  *     bandwidth request sent to PMFW, independent of the current display mode.
3869  *     For debug use only.
3870  * @dc: DC instance
3871  * @bw_mbps: requested bandwidth in MB/s; 0 clears the override
3872  *
3873  * Return: capped bandwidth value actually applied (MB/s)
3874  */
3875 unsigned int dc_override_memory_bandwidth_request(
3876 		struct dc *dc,
3877 		unsigned int bw_mbps);
3878 
3879 #endif /* DC_INTERFACE_H_ */
3880