xref: /linux/drivers/gpu/drm/amd/display/dc/dc.h (revision 0a94608f0f7de9b1135ffea3546afe68eafef57f)
1 /*
2  * Copyright 2012-14 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 "grph_object_defs.h"
31 #include "logger_types.h"
32 #if defined(CONFIG_DRM_AMD_DC_HDCP)
33 #include "hdcp_types.h"
34 #endif
35 #include "gpio_types.h"
36 #include "link_service_types.h"
37 #include "grph_object_ctrl_defs.h"
38 #include <inc/hw/opp.h>
39 
40 #include "inc/hw_sequencer.h"
41 #include "inc/compressor.h"
42 #include "inc/hw/dmcu.h"
43 #include "dml/display_mode_lib.h"
44 
45 /* forward declaration */
46 struct aux_payload;
47 struct set_config_cmd_payload;
48 struct dmub_notification;
49 
50 #define DC_VER "3.2.194"
51 
52 #define MAX_SURFACES 3
53 #define MAX_PLANES 6
54 #define MAX_STREAMS 6
55 #define MAX_SINKS_PER_LINK 4
56 #define MIN_VIEWPORT_SIZE 12
57 #define MAX_NUM_EDP 2
58 
59 /*******************************************************************************
60  * Display Core Interfaces
61  ******************************************************************************/
62 struct dc_versions {
63 	const char *dc_ver;
64 	struct dmcu_version dmcu_version;
65 };
66 
67 enum dp_protocol_version {
68 	DP_VERSION_1_4,
69 };
70 
71 enum dc_plane_type {
72 	DC_PLANE_TYPE_INVALID,
73 	DC_PLANE_TYPE_DCE_RGB,
74 	DC_PLANE_TYPE_DCE_UNDERLAY,
75 	DC_PLANE_TYPE_DCN_UNIVERSAL,
76 };
77 
78 // Sizes defined as multiples of 64KB
79 enum det_size {
80 	DET_SIZE_DEFAULT = 0,
81 	DET_SIZE_192KB = 3,
82 	DET_SIZE_256KB = 4,
83 	DET_SIZE_320KB = 5,
84 	DET_SIZE_384KB = 6
85 };
86 
87 
88 struct dc_plane_cap {
89 	enum dc_plane_type type;
90 	uint32_t blends_with_above : 1;
91 	uint32_t blends_with_below : 1;
92 	uint32_t per_pixel_alpha : 1;
93 	struct {
94 		uint32_t argb8888 : 1;
95 		uint32_t nv12 : 1;
96 		uint32_t fp16 : 1;
97 		uint32_t p010 : 1;
98 		uint32_t ayuv : 1;
99 	} pixel_format_support;
100 	// max upscaling factor x1000
101 	// upscaling factors are always >= 1
102 	// for example, 1080p -> 8K is 4.0, or 4000 raw value
103 	struct {
104 		uint32_t argb8888;
105 		uint32_t nv12;
106 		uint32_t fp16;
107 	} max_upscale_factor;
108 	// max downscale factor x1000
109 	// downscale factors are always <= 1
110 	// for example, 8K -> 1080p is 0.25, or 250 raw value
111 	struct {
112 		uint32_t argb8888;
113 		uint32_t nv12;
114 		uint32_t fp16;
115 	} max_downscale_factor;
116 	// minimal width/height
117 	uint32_t min_width;
118 	uint32_t min_height;
119 };
120 
121 // Color management caps (DPP and MPC)
122 struct rom_curve_caps {
123 	uint16_t srgb : 1;
124 	uint16_t bt2020 : 1;
125 	uint16_t gamma2_2 : 1;
126 	uint16_t pq : 1;
127 	uint16_t hlg : 1;
128 };
129 
130 struct dpp_color_caps {
131 	uint16_t dcn_arch : 1; // all DCE generations treated the same
132 	// input lut is different than most LUTs, just plain 256-entry lookup
133 	uint16_t input_lut_shared : 1; // shared with DGAM
134 	uint16_t icsc : 1;
135 	uint16_t dgam_ram : 1;
136 	uint16_t post_csc : 1; // before gamut remap
137 	uint16_t gamma_corr : 1;
138 
139 	// hdr_mult and gamut remap always available in DPP (in that order)
140 	// 3d lut implies shaper LUT,
141 	// it may be shared with MPC - check MPC:shared_3d_lut flag
142 	uint16_t hw_3d_lut : 1;
143 	uint16_t ogam_ram : 1; // blnd gam
144 	uint16_t ocsc : 1;
145 	uint16_t dgam_rom_for_yuv : 1;
146 	struct rom_curve_caps dgam_rom_caps;
147 	struct rom_curve_caps ogam_rom_caps;
148 };
149 
150 struct mpc_color_caps {
151 	uint16_t gamut_remap : 1;
152 	uint16_t ogam_ram : 1;
153 	uint16_t ocsc : 1;
154 	uint16_t num_3dluts : 3; //3d lut always assumes a preceding shaper LUT
155 	uint16_t shared_3d_lut:1; //can be in either DPP or MPC, but single instance
156 
157 	struct rom_curve_caps ogam_rom_caps;
158 };
159 
160 struct dc_color_caps {
161 	struct dpp_color_caps dpp;
162 	struct mpc_color_caps mpc;
163 };
164 
165 struct dc_dmub_caps {
166 	bool psr;
167 	bool mclk_sw;
168 };
169 
170 struct dc_caps {
171 	uint32_t max_streams;
172 	uint32_t max_links;
173 	uint32_t max_audios;
174 	uint32_t max_slave_planes;
175 	uint32_t max_slave_yuv_planes;
176 	uint32_t max_slave_rgb_planes;
177 	uint32_t max_planes;
178 	uint32_t max_downscale_ratio;
179 	uint32_t i2c_speed_in_khz;
180 	uint32_t i2c_speed_in_khz_hdcp;
181 	uint32_t dmdata_alloc_size;
182 	unsigned int max_cursor_size;
183 	unsigned int max_video_width;
184 	unsigned int min_horizontal_blanking_period;
185 	int linear_pitch_alignment;
186 	bool dcc_const_color;
187 	bool dynamic_audio;
188 	bool is_apu;
189 	bool dual_link_dvi;
190 	bool post_blend_color_processing;
191 	bool force_dp_tps4_for_cp2520;
192 	bool disable_dp_clk_share;
193 	bool psp_setup_panel_mode;
194 	bool extended_aux_timeout_support;
195 	bool dmcub_support;
196 	bool zstate_support;
197 	uint32_t num_of_internal_disp;
198 	enum dp_protocol_version max_dp_protocol_version;
199 	unsigned int mall_size_per_mem_channel;
200 	unsigned int mall_size_total;
201 	unsigned int cursor_cache_size;
202 	struct dc_plane_cap planes[MAX_PLANES];
203 	struct dc_color_caps color;
204 	struct dc_dmub_caps dmub_caps;
205 	bool dp_hpo;
206 	bool dp_hdmi21_pcon_support;
207 	bool edp_dsc_support;
208 	bool vbios_lttpr_aware;
209 	bool vbios_lttpr_enable;
210 	uint32_t max_otg_num;
211 	uint32_t max_cab_allocation_bytes;
212 	uint32_t cache_line_size;
213 	uint32_t cache_num_ways;
214 	uint16_t subvp_fw_processing_delay_us;
215 	uint16_t subvp_prefetch_end_to_mall_start_us;
216 	uint16_t subvp_pstate_allow_width_us;
217 	uint16_t subvp_vertical_int_margin_us;
218 	bool seamless_odm;
219 };
220 
221 struct dc_bug_wa {
222 	bool no_connect_phy_config;
223 	bool dedcn20_305_wa;
224 	bool skip_clock_update;
225 	bool lt_early_cr_pattern;
226 };
227 
228 struct dc_dcc_surface_param {
229 	struct dc_size surface_size;
230 	enum surface_pixel_format format;
231 	enum swizzle_mode_values swizzle_mode;
232 	enum dc_scan_direction scan;
233 };
234 
235 struct dc_dcc_setting {
236 	unsigned int max_compressed_blk_size;
237 	unsigned int max_uncompressed_blk_size;
238 	bool independent_64b_blks;
239 	//These bitfields to be used starting with DCN
240 	struct {
241 		uint32_t dcc_256_64_64 : 1;//available in ASICs before DCN (the worst compression case)
242 		uint32_t dcc_128_128_uncontrained : 1;  //available in ASICs before DCN
243 		uint32_t dcc_256_128_128 : 1;		//available starting with DCN
244 		uint32_t dcc_256_256_unconstrained : 1;  //available in ASICs before DCN (the best compression case)
245 	} dcc_controls;
246 };
247 
248 struct dc_surface_dcc_cap {
249 	union {
250 		struct {
251 			struct dc_dcc_setting rgb;
252 		} grph;
253 
254 		struct {
255 			struct dc_dcc_setting luma;
256 			struct dc_dcc_setting chroma;
257 		} video;
258 	};
259 
260 	bool capable;
261 	bool const_color_support;
262 };
263 
264 struct dc_static_screen_params {
265 	struct {
266 		bool force_trigger;
267 		bool cursor_update;
268 		bool surface_update;
269 		bool overlay_update;
270 	} triggers;
271 	unsigned int num_frames;
272 };
273 
274 
275 /* Surface update type is used by dc_update_surfaces_and_stream
276  * The update type is determined at the very beginning of the function based
277  * on parameters passed in and decides how much programming (or updating) is
278  * going to be done during the call.
279  *
280  * UPDATE_TYPE_FAST is used for really fast updates that do not require much
281  * logical calculations or hardware register programming. This update MUST be
282  * ISR safe on windows. Currently fast update will only be used to flip surface
283  * address.
284  *
285  * UPDATE_TYPE_MED is used for slower updates which require significant hw
286  * re-programming however do not affect bandwidth consumption or clock
287  * requirements. At present, this is the level at which front end updates
288  * that do not require us to run bw_calcs happen. These are in/out transfer func
289  * updates, viewport offset changes, recout size changes and pixel depth changes.
290  * This update can be done at ISR, but we want to minimize how often this happens.
291  *
292  * UPDATE_TYPE_FULL is slow. Really slow. This requires us to recalculate our
293  * bandwidth and clocks, possibly rearrange some pipes and reprogram anything front
294  * end related. Any time viewport dimensions, recout dimensions, scaling ratios or
295  * gamma need to be adjusted or pipe needs to be turned on (or disconnected) we do
296  * a full update. This cannot be done at ISR level and should be a rare event.
297  * Unless someone is stress testing mpo enter/exit, playing with colour or adjusting
298  * underscan we don't expect to see this call at all.
299  */
300 
301 enum surface_update_type {
302 	UPDATE_TYPE_FAST, /* super fast, safe to execute in isr */
303 	UPDATE_TYPE_MED,  /* ISR safe, most of programming needed, no bw/clk change*/
304 	UPDATE_TYPE_FULL, /* may need to shuffle resources */
305 };
306 
307 /* Forward declaration*/
308 struct dc;
309 struct dc_plane_state;
310 struct dc_state;
311 
312 
313 struct dc_cap_funcs {
314 	bool (*get_dcc_compression_cap)(const struct dc *dc,
315 			const struct dc_dcc_surface_param *input,
316 			struct dc_surface_dcc_cap *output);
317 };
318 
319 struct link_training_settings;
320 
321 union allow_lttpr_non_transparent_mode {
322 	struct {
323 		bool DP1_4A : 1;
324 		bool DP2_0 : 1;
325 	} bits;
326 	unsigned char raw;
327 };
328 
329 /* Structure to hold configuration flags set by dm at dc creation. */
330 struct dc_config {
331 	bool gpu_vm_support;
332 	bool disable_disp_pll_sharing;
333 	bool fbc_support;
334 	bool disable_fractional_pwm;
335 	bool allow_seamless_boot_optimization;
336 	bool seamless_boot_edp_requested;
337 	bool edp_not_connected;
338 	bool edp_no_power_sequencing;
339 	bool force_enum_edp;
340 	bool forced_clocks;
341 	union allow_lttpr_non_transparent_mode allow_lttpr_non_transparent_mode;
342 	bool multi_mon_pp_mclk_switch;
343 	bool disable_dmcu;
344 	bool enable_4to1MPC;
345 	bool enable_windowed_mpo_odm;
346 	uint32_t allow_edp_hotplug_detection;
347 	bool clamp_min_dcfclk;
348 	uint64_t vblank_alignment_dto_params;
349 	uint8_t  vblank_alignment_max_frame_time_diff;
350 	bool is_asymmetric_memory;
351 	bool is_single_rank_dimm;
352 	bool use_pipe_ctx_sync_logic;
353 	bool ignore_dpref_ss;
354 	bool enable_mipi_converter_optimization;
355 };
356 
357 enum visual_confirm {
358 	VISUAL_CONFIRM_DISABLE = 0,
359 	VISUAL_CONFIRM_SURFACE = 1,
360 	VISUAL_CONFIRM_HDR = 2,
361 	VISUAL_CONFIRM_MPCTREE = 4,
362 	VISUAL_CONFIRM_PSR = 5,
363 	VISUAL_CONFIRM_SWAPCHAIN = 6,
364 	VISUAL_CONFIRM_FAMS = 7,
365 	VISUAL_CONFIRM_SWIZZLE = 9,
366 };
367 
368 enum dc_psr_power_opts {
369 	psr_power_opt_invalid = 0x0,
370 	psr_power_opt_smu_opt_static_screen = 0x1,
371 	psr_power_opt_z10_static_screen = 0x10,
372 	psr_power_opt_ds_disable_allow = 0x100,
373 };
374 
375 enum dml_hostvm_override_opts {
376 	DML_HOSTVM_NO_OVERRIDE = 0x0,
377 	DML_HOSTVM_OVERRIDE_FALSE = 0x1,
378 	DML_HOSTVM_OVERRIDE_TRUE = 0x2,
379 };
380 
381 enum dcc_option {
382 	DCC_ENABLE = 0,
383 	DCC_DISABLE = 1,
384 	DCC_HALF_REQ_DISALBE = 2,
385 };
386 
387 enum pipe_split_policy {
388 	MPC_SPLIT_DYNAMIC = 0,
389 	MPC_SPLIT_AVOID = 1,
390 	MPC_SPLIT_AVOID_MULT_DISP = 2,
391 };
392 
393 enum wm_report_mode {
394 	WM_REPORT_DEFAULT = 0,
395 	WM_REPORT_OVERRIDE = 1,
396 };
397 enum dtm_pstate{
398 	dtm_level_p0 = 0,/*highest voltage*/
399 	dtm_level_p1,
400 	dtm_level_p2,
401 	dtm_level_p3,
402 	dtm_level_p4,/*when active_display_count = 0*/
403 };
404 
405 enum dcn_pwr_state {
406 	DCN_PWR_STATE_UNKNOWN = -1,
407 	DCN_PWR_STATE_MISSION_MODE = 0,
408 	DCN_PWR_STATE_LOW_POWER = 3,
409 };
410 
411 enum dcn_zstate_support_state {
412 	DCN_ZSTATE_SUPPORT_UNKNOWN,
413 	DCN_ZSTATE_SUPPORT_ALLOW,
414 	DCN_ZSTATE_SUPPORT_ALLOW_Z10_ONLY,
415 	DCN_ZSTATE_SUPPORT_DISALLOW,
416 };
417 /*
418  * For any clocks that may differ per pipe
419  * only the max is stored in this structure
420  */
421 struct dc_clocks {
422 	int dispclk_khz;
423 	int actual_dispclk_khz;
424 	int dppclk_khz;
425 	int actual_dppclk_khz;
426 	int disp_dpp_voltage_level_khz;
427 	int dcfclk_khz;
428 	int socclk_khz;
429 	int dcfclk_deep_sleep_khz;
430 	int fclk_khz;
431 	int phyclk_khz;
432 	int dramclk_khz;
433 	bool p_state_change_support;
434 	enum dcn_zstate_support_state zstate_support;
435 	bool dtbclk_en;
436 	int ref_dtbclk_khz;
437 	bool fclk_p_state_change_support;
438 	enum dcn_pwr_state pwr_state;
439 	/*
440 	 * Elements below are not compared for the purposes of
441 	 * optimization required
442 	 */
443 	bool prev_p_state_change_support;
444 	bool fclk_prev_p_state_change_support;
445 	int num_ways;
446 	bool fw_based_mclk_switching;
447 	bool fw_based_mclk_switching_shut_down;
448 	int prev_num_ways;
449 	enum dtm_pstate dtm_level;
450 	int max_supported_dppclk_khz;
451 	int max_supported_dispclk_khz;
452 	int bw_dppclk_khz; /*a copy of dppclk_khz*/
453 	int bw_dispclk_khz;
454 };
455 
456 struct dc_bw_validation_profile {
457 	bool enable;
458 
459 	unsigned long long total_ticks;
460 	unsigned long long voltage_level_ticks;
461 	unsigned long long watermark_ticks;
462 	unsigned long long rq_dlg_ticks;
463 
464 	unsigned long long total_count;
465 	unsigned long long skip_fast_count;
466 	unsigned long long skip_pass_count;
467 	unsigned long long skip_fail_count;
468 };
469 
470 #define BW_VAL_TRACE_SETUP() \
471 		unsigned long long end_tick = 0; \
472 		unsigned long long voltage_level_tick = 0; \
473 		unsigned long long watermark_tick = 0; \
474 		unsigned long long start_tick = dc->debug.bw_val_profile.enable ? \
475 				dm_get_timestamp(dc->ctx) : 0
476 
477 #define BW_VAL_TRACE_COUNT() \
478 		if (dc->debug.bw_val_profile.enable) \
479 			dc->debug.bw_val_profile.total_count++
480 
481 #define BW_VAL_TRACE_SKIP(status) \
482 		if (dc->debug.bw_val_profile.enable) { \
483 			if (!voltage_level_tick) \
484 				voltage_level_tick = dm_get_timestamp(dc->ctx); \
485 			dc->debug.bw_val_profile.skip_ ## status ## _count++; \
486 		}
487 
488 #define BW_VAL_TRACE_END_VOLTAGE_LEVEL() \
489 		if (dc->debug.bw_val_profile.enable) \
490 			voltage_level_tick = dm_get_timestamp(dc->ctx)
491 
492 #define BW_VAL_TRACE_END_WATERMARKS() \
493 		if (dc->debug.bw_val_profile.enable) \
494 			watermark_tick = dm_get_timestamp(dc->ctx)
495 
496 #define BW_VAL_TRACE_FINISH() \
497 		if (dc->debug.bw_val_profile.enable) { \
498 			end_tick = dm_get_timestamp(dc->ctx); \
499 			dc->debug.bw_val_profile.total_ticks += end_tick - start_tick; \
500 			dc->debug.bw_val_profile.voltage_level_ticks += voltage_level_tick - start_tick; \
501 			if (watermark_tick) { \
502 				dc->debug.bw_val_profile.watermark_ticks += watermark_tick - voltage_level_tick; \
503 				dc->debug.bw_val_profile.rq_dlg_ticks += end_tick - watermark_tick; \
504 			} \
505 		}
506 
507 union mem_low_power_enable_options {
508 	struct {
509 		bool vga: 1;
510 		bool i2c: 1;
511 		bool dmcu: 1;
512 		bool dscl: 1;
513 		bool cm: 1;
514 		bool mpc: 1;
515 		bool optc: 1;
516 		bool vpg: 1;
517 		bool afmt: 1;
518 	} bits;
519 	uint32_t u32All;
520 };
521 
522 union root_clock_optimization_options {
523 	struct {
524 		bool dpp: 1;
525 		bool dsc: 1;
526 		bool hdmistream: 1;
527 		bool hdmichar: 1;
528 		bool dpstream: 1;
529 		bool symclk32_se: 1;
530 		bool symclk32_le: 1;
531 		bool symclk_fe: 1;
532 		bool physymclk: 1;
533 		bool dpiasymclk: 1;
534 		uint32_t reserved: 22;
535 	} bits;
536 	uint32_t u32All;
537 };
538 
539 union dpia_debug_options {
540 	struct {
541 		uint32_t disable_dpia:1; /* bit 0 */
542 		uint32_t force_non_lttpr:1; /* bit 1 */
543 		uint32_t extend_aux_rd_interval:1; /* bit 2 */
544 		uint32_t disable_mst_dsc_work_around:1; /* bit 3 */
545 		uint32_t enable_force_tbt3_work_around:1; /* bit 4 */
546 		uint32_t reserved:27;
547 	} bits;
548 	uint32_t raw;
549 };
550 
551 /* AUX wake work around options
552  * 0: enable/disable work around
553  * 1: use default timeout LINK_AUX_WAKE_TIMEOUT_MS
554  * 15-2: reserved
555  * 31-16: timeout in ms
556  */
557 union aux_wake_wa_options {
558 	struct {
559 		uint32_t enable_wa : 1;
560 		uint32_t use_default_timeout : 1;
561 		uint32_t rsvd: 14;
562 		uint32_t timeout_ms : 16;
563 	} bits;
564 	uint32_t raw;
565 };
566 
567 struct dc_debug_data {
568 	uint32_t ltFailCount;
569 	uint32_t i2cErrorCount;
570 	uint32_t auxErrorCount;
571 };
572 
573 struct dc_phy_addr_space_config {
574 	struct {
575 		uint64_t start_addr;
576 		uint64_t end_addr;
577 		uint64_t fb_top;
578 		uint64_t fb_offset;
579 		uint64_t fb_base;
580 		uint64_t agp_top;
581 		uint64_t agp_bot;
582 		uint64_t agp_base;
583 	} system_aperture;
584 
585 	struct {
586 		uint64_t page_table_start_addr;
587 		uint64_t page_table_end_addr;
588 		uint64_t page_table_base_addr;
589 		bool base_addr_is_mc_addr;
590 	} gart_config;
591 
592 	bool valid;
593 	bool is_hvm_enabled;
594 	uint64_t page_table_default_page_addr;
595 };
596 
597 struct dc_virtual_addr_space_config {
598 	uint64_t	page_table_base_addr;
599 	uint64_t	page_table_start_addr;
600 	uint64_t	page_table_end_addr;
601 	uint32_t	page_table_block_size_in_bytes;
602 	uint8_t		page_table_depth; // 1 = 1 level, 2 = 2 level, etc.  0 = invalid
603 };
604 
605 struct dc_bounding_box_overrides {
606 	int sr_exit_time_ns;
607 	int sr_enter_plus_exit_time_ns;
608 	int urgent_latency_ns;
609 	int percent_of_ideal_drambw;
610 	int dram_clock_change_latency_ns;
611 	int dummy_clock_change_latency_ns;
612 	/* This forces a hard min on the DCFCLK we use
613 	 * for DML.  Unlike the debug option for forcing
614 	 * DCFCLK, this override affects watermark calculations
615 	 */
616 	int min_dcfclk_mhz;
617 };
618 
619 struct dc_state;
620 struct resource_pool;
621 struct dce_hwseq;
622 
623 struct dc_debug_options {
624 	bool native422_support;
625 	bool disable_dsc;
626 	enum visual_confirm visual_confirm;
627 	int visual_confirm_rect_height;
628 
629 	bool sanity_checks;
630 	bool max_disp_clk;
631 	bool surface_trace;
632 	bool timing_trace;
633 	bool clock_trace;
634 	bool validation_trace;
635 	bool bandwidth_calcs_trace;
636 	int max_downscale_src_width;
637 
638 	/* stutter efficiency related */
639 	bool disable_stutter;
640 	bool use_max_lb;
641 	enum dcc_option disable_dcc;
642 	enum pipe_split_policy pipe_split_policy;
643 	bool force_single_disp_pipe_split;
644 	bool voltage_align_fclk;
645 	bool disable_min_fclk;
646 
647 	bool disable_dfs_bypass;
648 	bool disable_dpp_power_gate;
649 	bool disable_hubp_power_gate;
650 	bool disable_dsc_power_gate;
651 	int dsc_min_slice_height_override;
652 	int dsc_bpp_increment_div;
653 	bool disable_pplib_wm_range;
654 	enum wm_report_mode pplib_wm_report_mode;
655 	unsigned int min_disp_clk_khz;
656 	unsigned int min_dpp_clk_khz;
657 	unsigned int min_dram_clk_khz;
658 	int sr_exit_time_dpm0_ns;
659 	int sr_enter_plus_exit_time_dpm0_ns;
660 	int sr_exit_time_ns;
661 	int sr_enter_plus_exit_time_ns;
662 	int urgent_latency_ns;
663 	uint32_t underflow_assert_delay_us;
664 	int percent_of_ideal_drambw;
665 	int dram_clock_change_latency_ns;
666 	bool optimized_watermark;
667 	int always_scale;
668 	bool disable_pplib_clock_request;
669 	bool disable_clock_gate;
670 	bool disable_mem_low_power;
671 	bool pstate_enabled;
672 	bool disable_dmcu;
673 	bool disable_psr;
674 	bool force_abm_enable;
675 	bool disable_stereo_support;
676 	bool vsr_support;
677 	bool performance_trace;
678 	bool az_endpoint_mute_only;
679 	bool always_use_regamma;
680 	bool recovery_enabled;
681 	bool avoid_vbios_exec_table;
682 	bool scl_reset_length10;
683 	bool hdmi20_disable;
684 	bool skip_detection_link_training;
685 	uint32_t edid_read_retry_times;
686 	bool remove_disconnect_edp;
687 	unsigned int force_odm_combine; //bit vector based on otg inst
688 	unsigned int seamless_boot_odm_combine;
689 	unsigned int force_odm_combine_4to1; //bit vector based on otg inst
690 	bool disable_z9_mpc;
691 	unsigned int force_fclk_khz;
692 	bool enable_tri_buf;
693 	bool dmub_offload_enabled;
694 	bool dmcub_emulation;
695 	bool disable_idle_power_optimizations;
696 	unsigned int mall_size_override;
697 	unsigned int mall_additional_timer_percent;
698 	bool mall_error_as_fatal;
699 	bool dmub_command_table; /* for testing only */
700 	struct dc_bw_validation_profile bw_val_profile;
701 	bool disable_fec;
702 	bool disable_48mhz_pwrdwn;
703 	/* This forces a hard min on the DCFCLK requested to SMU/PP
704 	 * watermarks are not affected.
705 	 */
706 	unsigned int force_min_dcfclk_mhz;
707 	int dwb_fi_phase;
708 	bool disable_timing_sync;
709 	bool cm_in_bypass;
710 	int force_clock_mode;/*every mode change.*/
711 
712 	bool disable_dram_clock_change_vactive_support;
713 	bool validate_dml_output;
714 	bool enable_dmcub_surface_flip;
715 	bool usbc_combo_phy_reset_wa;
716 	bool disable_dsc_edp;
717 	unsigned int  force_dsc_edp_policy;
718 	bool enable_dram_clock_change_one_display_vactive;
719 	/* TODO - remove once tested */
720 	bool legacy_dp2_lt;
721 	bool set_mst_en_for_sst;
722 	bool disable_uhbr;
723 	bool force_dp2_lt_fallback_method;
724 	bool ignore_cable_id;
725 	union mem_low_power_enable_options enable_mem_low_power;
726 	union root_clock_optimization_options root_clock_optimization;
727 	bool hpo_optimization;
728 	bool force_vblank_alignment;
729 
730 	/* Enable dmub aux for legacy ddc */
731 	bool enable_dmub_aux_for_legacy_ddc;
732 	bool disable_fams;
733 	bool optimize_edp_link_rate; /* eDP ILR */
734 	/* FEC/PSR1 sequence enable delay in 100us */
735 	uint8_t fec_enable_delay_in100us;
736 	bool enable_driver_sequence_debug;
737 	enum det_size crb_alloc_policy;
738 	int crb_alloc_policy_min_disp_count;
739 	bool disable_z10;
740 	bool enable_z9_disable_interface;
741 	bool enable_sw_cntl_psr;
742 	union dpia_debug_options dpia_debug;
743 	bool disable_fixed_vs_aux_timeout_wa;
744 	bool force_disable_subvp;
745 	bool force_subvp_mclk_switch;
746 	bool force_usr_allow;
747 	/* uses value at boot and disables switch */
748 	bool disable_dtb_ref_clk_switch;
749 	uint32_t fixed_vs_aux_delay_config_wa;
750 	bool extended_blank_optimization;
751 	union aux_wake_wa_options aux_wake_wa;
752 	uint32_t mst_start_top_delay;
753 	uint8_t psr_power_use_phy_fsm;
754 	enum dml_hostvm_override_opts dml_hostvm_override;
755 	bool use_legacy_soc_bb_mechanism;
756 	bool exit_idle_opt_for_cursor_updates;
757 	bool enable_single_display_2to1_odm_policy;
758 	bool enable_dp_dig_pixel_rate_div_policy;
759 };
760 
761 struct gpu_info_soc_bounding_box_v1_0;
762 struct dc {
763 	struct dc_debug_options debug;
764 	struct dc_versions versions;
765 	struct dc_caps caps;
766 	struct dc_cap_funcs cap_funcs;
767 	struct dc_config config;
768 	struct dc_bounding_box_overrides bb_overrides;
769 	struct dc_bug_wa work_arounds;
770 	struct dc_context *ctx;
771 	struct dc_phy_addr_space_config vm_pa_config;
772 
773 	uint8_t link_count;
774 	struct dc_link *links[MAX_PIPES * 2];
775 
776 	struct dc_state *current_state;
777 	struct resource_pool *res_pool;
778 
779 	struct clk_mgr *clk_mgr;
780 
781 	/* Display Engine Clock levels */
782 	struct dm_pp_clock_levels sclk_lvls;
783 
784 	/* Inputs into BW and WM calculations. */
785 	struct bw_calcs_dceip *bw_dceip;
786 	struct bw_calcs_vbios *bw_vbios;
787 	struct dcn_soc_bounding_box *dcn_soc;
788 	struct dcn_ip_params *dcn_ip;
789 	struct display_mode_lib dml;
790 
791 	/* HW functions */
792 	struct hw_sequencer_funcs hwss;
793 	struct dce_hwseq *hwseq;
794 
795 	/* Require to optimize clocks and bandwidth for added/removed planes */
796 	bool optimized_required;
797 	bool wm_optimized_required;
798 	bool idle_optimizations_allowed;
799 	bool enable_c20_dtm_b0;
800 
801 	/* Require to maintain clocks and bandwidth for UEFI enabled HW */
802 
803 	/* FBC compressor */
804 	struct compressor *fbc_compressor;
805 
806 	struct dc_debug_data debug_data;
807 	struct dpcd_vendor_signature vendor_signature;
808 
809 	const char *build_id;
810 	struct vm_helper *vm_helper;
811 
812 	uint32_t *dcn_reg_offsets;
813 	uint32_t *nbio_reg_offsets;
814 };
815 
816 enum frame_buffer_mode {
817 	FRAME_BUFFER_MODE_LOCAL_ONLY = 0,
818 	FRAME_BUFFER_MODE_ZFB_ONLY,
819 	FRAME_BUFFER_MODE_MIXED_ZFB_AND_LOCAL,
820 } ;
821 
822 struct dchub_init_data {
823 	int64_t zfb_phys_addr_base;
824 	int64_t zfb_mc_base_addr;
825 	uint64_t zfb_size_in_byte;
826 	enum frame_buffer_mode fb_mode;
827 	bool dchub_initialzied;
828 	bool dchub_info_valid;
829 };
830 
831 struct dc_init_data {
832 	struct hw_asic_id asic_id;
833 	void *driver; /* ctx */
834 	struct cgs_device *cgs_device;
835 	struct dc_bounding_box_overrides bb_overrides;
836 
837 	int num_virtual_links;
838 	/*
839 	 * If 'vbios_override' not NULL, it will be called instead
840 	 * of the real VBIOS. Intended use is Diagnostics on FPGA.
841 	 */
842 	struct dc_bios *vbios_override;
843 	enum dce_environment dce_environment;
844 
845 	struct dmub_offload_funcs *dmub_if;
846 	struct dc_reg_helper_state *dmub_offload;
847 
848 	struct dc_config flags;
849 	uint64_t log_mask;
850 
851 	struct dpcd_vendor_signature vendor_signature;
852 	bool force_smu_not_present;
853 	/*
854 	 * IP offset for run time initializaion of register addresses
855 	 *
856 	 * DCN3.5+ will fail dc_create() if these fields are null for them. They are
857 	 * applicable starting with DCN32/321 and are not used for ASICs upstreamed
858 	 * before them.
859 	 */
860 	uint32_t *dcn_reg_offsets;
861 	uint32_t *nbio_reg_offsets;
862 };
863 
864 struct dc_callback_init {
865 #ifdef CONFIG_DRM_AMD_DC_HDCP
866 	struct cp_psp cp_psp;
867 #else
868 	uint8_t reserved;
869 #endif
870 };
871 
872 struct dc *dc_create(const struct dc_init_data *init_params);
873 void dc_hardware_init(struct dc *dc);
874 
875 int dc_get_vmid_use_vector(struct dc *dc);
876 void dc_setup_vm_context(struct dc *dc, struct dc_virtual_addr_space_config *va_config, int vmid);
877 /* Returns the number of vmids supported */
878 int dc_setup_system_context(struct dc *dc, struct dc_phy_addr_space_config *pa_config);
879 void dc_init_callbacks(struct dc *dc,
880 		const struct dc_callback_init *init_params);
881 void dc_deinit_callbacks(struct dc *dc);
882 void dc_destroy(struct dc **dc);
883 
884 /*******************************************************************************
885  * Surface Interfaces
886  ******************************************************************************/
887 
888 enum {
889 	TRANSFER_FUNC_POINTS = 1025
890 };
891 
892 struct dc_hdr_static_metadata {
893 	/* display chromaticities and white point in units of 0.00001 */
894 	unsigned int chromaticity_green_x;
895 	unsigned int chromaticity_green_y;
896 	unsigned int chromaticity_blue_x;
897 	unsigned int chromaticity_blue_y;
898 	unsigned int chromaticity_red_x;
899 	unsigned int chromaticity_red_y;
900 	unsigned int chromaticity_white_point_x;
901 	unsigned int chromaticity_white_point_y;
902 
903 	uint32_t min_luminance;
904 	uint32_t max_luminance;
905 	uint32_t maximum_content_light_level;
906 	uint32_t maximum_frame_average_light_level;
907 };
908 
909 enum dc_transfer_func_type {
910 	TF_TYPE_PREDEFINED,
911 	TF_TYPE_DISTRIBUTED_POINTS,
912 	TF_TYPE_BYPASS,
913 	TF_TYPE_HWPWL
914 };
915 
916 struct dc_transfer_func_distributed_points {
917 	struct fixed31_32 red[TRANSFER_FUNC_POINTS];
918 	struct fixed31_32 green[TRANSFER_FUNC_POINTS];
919 	struct fixed31_32 blue[TRANSFER_FUNC_POINTS];
920 
921 	uint16_t end_exponent;
922 	uint16_t x_point_at_y1_red;
923 	uint16_t x_point_at_y1_green;
924 	uint16_t x_point_at_y1_blue;
925 };
926 
927 enum dc_transfer_func_predefined {
928 	TRANSFER_FUNCTION_SRGB,
929 	TRANSFER_FUNCTION_BT709,
930 	TRANSFER_FUNCTION_PQ,
931 	TRANSFER_FUNCTION_LINEAR,
932 	TRANSFER_FUNCTION_UNITY,
933 	TRANSFER_FUNCTION_HLG,
934 	TRANSFER_FUNCTION_HLG12,
935 	TRANSFER_FUNCTION_GAMMA22,
936 	TRANSFER_FUNCTION_GAMMA24,
937 	TRANSFER_FUNCTION_GAMMA26
938 };
939 
940 
941 struct dc_transfer_func {
942 	struct kref refcount;
943 	enum dc_transfer_func_type type;
944 	enum dc_transfer_func_predefined tf;
945 	/* FP16 1.0 reference level in nits, default is 80 nits, only for PQ*/
946 	uint32_t sdr_ref_white_level;
947 	union {
948 		struct pwl_params pwl;
949 		struct dc_transfer_func_distributed_points tf_pts;
950 	};
951 };
952 
953 
954 union dc_3dlut_state {
955 	struct {
956 		uint32_t initialized:1;		/*if 3dlut is went through color module for initialization */
957 		uint32_t rmu_idx_valid:1;	/*if mux settings are valid*/
958 		uint32_t rmu_mux_num:3;		/*index of mux to use*/
959 		uint32_t mpc_rmu0_mux:4;	/*select mpcc on mux, one of the following : mpcc0, mpcc1, mpcc2, mpcc3*/
960 		uint32_t mpc_rmu1_mux:4;
961 		uint32_t mpc_rmu2_mux:4;
962 		uint32_t reserved:15;
963 	} bits;
964 	uint32_t raw;
965 };
966 
967 
968 struct dc_3dlut {
969 	struct kref refcount;
970 	struct tetrahedral_params lut_3d;
971 	struct fixed31_32 hdr_multiplier;
972 	union dc_3dlut_state state;
973 };
974 /*
975  * This structure is filled in by dc_surface_get_status and contains
976  * the last requested address and the currently active address so the called
977  * can determine if there are any outstanding flips
978  */
979 struct dc_plane_status {
980 	struct dc_plane_address requested_address;
981 	struct dc_plane_address current_address;
982 	bool is_flip_pending;
983 	bool is_right_eye;
984 };
985 
986 union surface_update_flags {
987 
988 	struct {
989 		uint32_t addr_update:1;
990 		/* Medium updates */
991 		uint32_t dcc_change:1;
992 		uint32_t color_space_change:1;
993 		uint32_t horizontal_mirror_change:1;
994 		uint32_t per_pixel_alpha_change:1;
995 		uint32_t global_alpha_change:1;
996 		uint32_t hdr_mult:1;
997 		uint32_t rotation_change:1;
998 		uint32_t swizzle_change:1;
999 		uint32_t scaling_change:1;
1000 		uint32_t position_change:1;
1001 		uint32_t in_transfer_func_change:1;
1002 		uint32_t input_csc_change:1;
1003 		uint32_t coeff_reduction_change:1;
1004 		uint32_t output_tf_change:1;
1005 		uint32_t pixel_format_change:1;
1006 		uint32_t plane_size_change:1;
1007 		uint32_t gamut_remap_change:1;
1008 
1009 		/* Full updates */
1010 		uint32_t new_plane:1;
1011 		uint32_t bpp_change:1;
1012 		uint32_t gamma_change:1;
1013 		uint32_t bandwidth_change:1;
1014 		uint32_t clock_change:1;
1015 		uint32_t stereo_format_change:1;
1016 		uint32_t lut_3d:1;
1017 		uint32_t full_update:1;
1018 	} bits;
1019 
1020 	uint32_t raw;
1021 };
1022 
1023 struct dc_plane_state {
1024 	struct dc_plane_address address;
1025 	struct dc_plane_flip_time time;
1026 	bool triplebuffer_flips;
1027 	struct scaling_taps scaling_quality;
1028 	struct rect src_rect;
1029 	struct rect dst_rect;
1030 	struct rect clip_rect;
1031 
1032 	struct plane_size plane_size;
1033 	union dc_tiling_info tiling_info;
1034 
1035 	struct dc_plane_dcc_param dcc;
1036 
1037 	struct dc_gamma *gamma_correction;
1038 	struct dc_transfer_func *in_transfer_func;
1039 	struct dc_bias_and_scale *bias_and_scale;
1040 	struct dc_csc_transform input_csc_color_matrix;
1041 	struct fixed31_32 coeff_reduction_factor;
1042 	struct fixed31_32 hdr_mult;
1043 	struct colorspace_transform gamut_remap_matrix;
1044 
1045 	// TODO: No longer used, remove
1046 	struct dc_hdr_static_metadata hdr_static_ctx;
1047 
1048 	enum dc_color_space color_space;
1049 
1050 	struct dc_3dlut *lut3d_func;
1051 	struct dc_transfer_func *in_shaper_func;
1052 	struct dc_transfer_func *blend_tf;
1053 
1054 	struct dc_transfer_func *gamcor_tf;
1055 	enum surface_pixel_format format;
1056 	enum dc_rotation_angle rotation;
1057 	enum plane_stereo_format stereo_format;
1058 
1059 	bool is_tiling_rotated;
1060 	bool per_pixel_alpha;
1061 	bool pre_multiplied_alpha;
1062 	bool global_alpha;
1063 	int  global_alpha_value;
1064 	bool visible;
1065 	bool flip_immediate;
1066 	bool horizontal_mirror;
1067 	int layer_index;
1068 
1069 	union surface_update_flags update_flags;
1070 	bool flip_int_enabled;
1071 	bool skip_manual_trigger;
1072 
1073 	/* private to DC core */
1074 	struct dc_plane_status status;
1075 	struct dc_context *ctx;
1076 
1077 	/* HACK: Workaround for forcing full reprogramming under some conditions */
1078 	bool force_full_update;
1079 
1080 	bool is_phantom; // TODO: Change mall_stream_config into mall_plane_config instead
1081 
1082 	/* private to dc_surface.c */
1083 	enum dc_irq_source irq_source;
1084 	struct kref refcount;
1085 };
1086 
1087 struct dc_plane_info {
1088 	struct plane_size plane_size;
1089 	union dc_tiling_info tiling_info;
1090 	struct dc_plane_dcc_param dcc;
1091 	enum surface_pixel_format format;
1092 	enum dc_rotation_angle rotation;
1093 	enum plane_stereo_format stereo_format;
1094 	enum dc_color_space color_space;
1095 	bool horizontal_mirror;
1096 	bool visible;
1097 	bool per_pixel_alpha;
1098 	bool pre_multiplied_alpha;
1099 	bool global_alpha;
1100 	int  global_alpha_value;
1101 	bool input_csc_enabled;
1102 	int layer_index;
1103 };
1104 
1105 struct dc_scaling_info {
1106 	struct rect src_rect;
1107 	struct rect dst_rect;
1108 	struct rect clip_rect;
1109 	struct scaling_taps scaling_quality;
1110 };
1111 
1112 struct dc_surface_update {
1113 	struct dc_plane_state *surface;
1114 
1115 	/* isr safe update parameters.  null means no updates */
1116 	const struct dc_flip_addrs *flip_addr;
1117 	const struct dc_plane_info *plane_info;
1118 	const struct dc_scaling_info *scaling_info;
1119 	struct fixed31_32 hdr_mult;
1120 	/* following updates require alloc/sleep/spin that is not isr safe,
1121 	 * null means no updates
1122 	 */
1123 	const struct dc_gamma *gamma;
1124 	const struct dc_transfer_func *in_transfer_func;
1125 
1126 	const struct dc_csc_transform *input_csc_color_matrix;
1127 	const struct fixed31_32 *coeff_reduction_factor;
1128 	const struct dc_transfer_func *func_shaper;
1129 	const struct dc_3dlut *lut3d_func;
1130 	const struct dc_transfer_func *blend_tf;
1131 	const struct colorspace_transform *gamut_remap_matrix;
1132 };
1133 
1134 /*
1135  * Create a new surface with default parameters;
1136  */
1137 struct dc_plane_state *dc_create_plane_state(struct dc *dc);
1138 const struct dc_plane_status *dc_plane_get_status(
1139 		const struct dc_plane_state *plane_state);
1140 
1141 void dc_plane_state_retain(struct dc_plane_state *plane_state);
1142 void dc_plane_state_release(struct dc_plane_state *plane_state);
1143 
1144 void dc_gamma_retain(struct dc_gamma *dc_gamma);
1145 void dc_gamma_release(struct dc_gamma **dc_gamma);
1146 struct dc_gamma *dc_create_gamma(void);
1147 
1148 void dc_transfer_func_retain(struct dc_transfer_func *dc_tf);
1149 void dc_transfer_func_release(struct dc_transfer_func *dc_tf);
1150 struct dc_transfer_func *dc_create_transfer_func(void);
1151 
1152 struct dc_3dlut *dc_create_3dlut_func(void);
1153 void dc_3dlut_func_release(struct dc_3dlut *lut);
1154 void dc_3dlut_func_retain(struct dc_3dlut *lut);
1155 
1156 void dc_post_update_surfaces_to_stream(
1157 		struct dc *dc);
1158 
1159 #include "dc_stream.h"
1160 
1161 /*
1162  * Structure to store surface/stream associations for validation
1163  */
1164 struct dc_validation_set {
1165 	struct dc_stream_state *stream;
1166 	struct dc_plane_state *plane_states[MAX_SURFACES];
1167 	uint8_t plane_count;
1168 };
1169 
1170 bool dc_validate_boot_timing(const struct dc *dc,
1171 				const struct dc_sink *sink,
1172 				struct dc_crtc_timing *crtc_timing);
1173 
1174 enum dc_status dc_validate_plane(struct dc *dc, const struct dc_plane_state *plane_state);
1175 
1176 void get_clock_requirements_for_state(struct dc_state *state, struct AsicStateEx *info);
1177 
1178 bool dc_set_generic_gpio_for_stereo(bool enable,
1179 		struct gpio_service *gpio_service);
1180 
1181 /*
1182  * fast_validate: we return after determining if we can support the new state,
1183  * but before we populate the programming info
1184  */
1185 enum dc_status dc_validate_global_state(
1186 		struct dc *dc,
1187 		struct dc_state *new_ctx,
1188 		bool fast_validate);
1189 
1190 
1191 void dc_resource_state_construct(
1192 		const struct dc *dc,
1193 		struct dc_state *dst_ctx);
1194 
1195 bool dc_acquire_release_mpc_3dlut(
1196 		struct dc *dc, bool acquire,
1197 		struct dc_stream_state *stream,
1198 		struct dc_3dlut **lut,
1199 		struct dc_transfer_func **shaper);
1200 
1201 void dc_resource_state_copy_construct(
1202 		const struct dc_state *src_ctx,
1203 		struct dc_state *dst_ctx);
1204 
1205 void dc_resource_state_copy_construct_current(
1206 		const struct dc *dc,
1207 		struct dc_state *dst_ctx);
1208 
1209 void dc_resource_state_destruct(struct dc_state *context);
1210 
1211 bool dc_resource_is_dsc_encoding_supported(const struct dc *dc);
1212 
1213 /*
1214  * TODO update to make it about validation sets
1215  * Set up streams and links associated to drive sinks
1216  * The streams parameter is an absolute set of all active streams.
1217  *
1218  * After this call:
1219  *   Phy, Encoder, Timing Generator are programmed and enabled.
1220  *   New streams are enabled with blank stream; no memory read.
1221  */
1222 bool dc_commit_state(struct dc *dc, struct dc_state *context);
1223 
1224 struct dc_state *dc_create_state(struct dc *dc);
1225 struct dc_state *dc_copy_state(struct dc_state *src_ctx);
1226 void dc_retain_state(struct dc_state *context);
1227 void dc_release_state(struct dc_state *context);
1228 
1229 /*******************************************************************************
1230  * Link Interfaces
1231  ******************************************************************************/
1232 
1233 struct dpcd_caps {
1234 	union dpcd_rev dpcd_rev;
1235 	union max_lane_count max_ln_count;
1236 	union max_down_spread max_down_spread;
1237 	union dprx_feature dprx_feature;
1238 
1239 	/* valid only for eDP v1.4 or higher*/
1240 	uint8_t edp_supported_link_rates_count;
1241 	enum dc_link_rate edp_supported_link_rates[8];
1242 
1243 	/* dongle type (DP converter, CV smart dongle) */
1244 	enum display_dongle_type dongle_type;
1245 	bool is_dongle_type_one;
1246 	/* branch device or sink device */
1247 	bool is_branch_dev;
1248 	/* Dongle's downstream count. */
1249 	union sink_count sink_count;
1250 	bool is_mst_capable;
1251 	/* If dongle_type == DISPLAY_DONGLE_DP_HDMI_CONVERTER,
1252 	indicates 'Frame Sequential-to-lllFrame Pack' conversion capability.*/
1253 	struct dc_dongle_caps dongle_caps;
1254 
1255 	uint32_t sink_dev_id;
1256 	int8_t sink_dev_id_str[6];
1257 	int8_t sink_hw_revision;
1258 	int8_t sink_fw_revision[2];
1259 
1260 	uint32_t branch_dev_id;
1261 	int8_t branch_dev_name[6];
1262 	int8_t branch_hw_revision;
1263 	int8_t branch_fw_revision[2];
1264 
1265 	bool allow_invalid_MSA_timing_param;
1266 	bool panel_mode_edp;
1267 	bool dpcd_display_control_capable;
1268 	bool ext_receiver_cap_field_present;
1269 	bool set_power_state_capable_edp;
1270 	bool dynamic_backlight_capable_edp;
1271 	union dpcd_fec_capability fec_cap;
1272 	struct dpcd_dsc_capabilities dsc_caps;
1273 	struct dc_lttpr_caps lttpr_caps;
1274 	struct dpcd_usb4_dp_tunneling_info usb4_dp_tun_info;
1275 
1276 	union dp_128b_132b_supported_link_rates dp_128b_132b_supported_link_rates;
1277 	union dp_main_line_channel_coding_cap channel_coding_cap;
1278 	union dp_sink_video_fallback_formats fallback_formats;
1279 	union dp_fec_capability1 fec_cap1;
1280 	union dp_cable_id cable_id;
1281 	uint8_t edp_rev;
1282 	union edp_alpm_caps alpm_caps;
1283 	struct edp_psr_info psr_info;
1284 };
1285 
1286 union dpcd_sink_ext_caps {
1287 	struct {
1288 		/* 0 - Sink supports backlight adjust via PWM during SDR/HDR mode
1289 		 * 1 - Sink supports backlight adjust via AUX during SDR/HDR mode.
1290 		 */
1291 		uint8_t sdr_aux_backlight_control : 1;
1292 		uint8_t hdr_aux_backlight_control : 1;
1293 		uint8_t reserved_1 : 2;
1294 		uint8_t oled : 1;
1295 		uint8_t reserved : 3;
1296 	} bits;
1297 	uint8_t raw;
1298 };
1299 
1300 #if defined(CONFIG_DRM_AMD_DC_HDCP)
1301 union hdcp_rx_caps {
1302 	struct {
1303 		uint8_t version;
1304 		uint8_t reserved;
1305 		struct {
1306 			uint8_t repeater	: 1;
1307 			uint8_t hdcp_capable	: 1;
1308 			uint8_t reserved	: 6;
1309 		} byte0;
1310 	} fields;
1311 	uint8_t raw[3];
1312 };
1313 
1314 union hdcp_bcaps {
1315 	struct {
1316 		uint8_t HDCP_CAPABLE:1;
1317 		uint8_t REPEATER:1;
1318 		uint8_t RESERVED:6;
1319 	} bits;
1320 	uint8_t raw;
1321 };
1322 
1323 struct hdcp_caps {
1324 	union hdcp_rx_caps rx_caps;
1325 	union hdcp_bcaps bcaps;
1326 };
1327 #endif
1328 
1329 #include "dc_link.h"
1330 
1331 uint32_t dc_get_opp_for_plane(struct dc *dc, struct dc_plane_state *plane);
1332 
1333 /*******************************************************************************
1334  * Sink Interfaces - A sink corresponds to a display output device
1335  ******************************************************************************/
1336 
1337 struct dc_container_id {
1338 	// 128bit GUID in binary form
1339 	unsigned char  guid[16];
1340 	// 8 byte port ID -> ELD.PortID
1341 	unsigned int   portId[2];
1342 	// 128bit GUID in binary formufacturer name -> ELD.ManufacturerName
1343 	unsigned short manufacturerName;
1344 	// 2 byte product code -> ELD.ProductCode
1345 	unsigned short productCode;
1346 };
1347 
1348 
1349 struct dc_sink_dsc_caps {
1350 	// 'true' if these are virtual DPCD's DSC caps (immediately upstream of sink in MST topology),
1351 	// 'false' if they are sink's DSC caps
1352 	bool is_virtual_dpcd_dsc;
1353 #if defined(CONFIG_DRM_AMD_DC_DCN)
1354 	// 'true' if MST topology supports DSC passthrough for sink
1355 	// 'false' if MST topology does not support DSC passthrough
1356 	bool is_dsc_passthrough_supported;
1357 #endif
1358 	struct dsc_dec_dpcd_caps dsc_dec_caps;
1359 };
1360 
1361 struct dc_sink_fec_caps {
1362 	bool is_rx_fec_supported;
1363 	bool is_topology_fec_supported;
1364 };
1365 
1366 /*
1367  * The sink structure contains EDID and other display device properties
1368  */
1369 struct dc_sink {
1370 	enum signal_type sink_signal;
1371 	struct dc_edid dc_edid; /* raw edid */
1372 	struct dc_edid_caps edid_caps; /* parse display caps */
1373 	struct dc_container_id *dc_container_id;
1374 	uint32_t dongle_max_pix_clk;
1375 	void *priv;
1376 	struct stereo_3d_features features_3d[TIMING_3D_FORMAT_MAX];
1377 	bool converter_disable_audio;
1378 
1379 	struct dc_sink_dsc_caps dsc_caps;
1380 	struct dc_sink_fec_caps fec_caps;
1381 
1382 	bool is_vsc_sdp_colorimetry_supported;
1383 
1384 	/* private to DC core */
1385 	struct dc_link *link;
1386 	struct dc_context *ctx;
1387 
1388 	uint32_t sink_id;
1389 
1390 	/* private to dc_sink.c */
1391 	// refcount must be the last member in dc_sink, since we want the
1392 	// sink structure to be logically cloneable up to (but not including)
1393 	// refcount
1394 	struct kref refcount;
1395 };
1396 
1397 void dc_sink_retain(struct dc_sink *sink);
1398 void dc_sink_release(struct dc_sink *sink);
1399 
1400 struct dc_sink_init_data {
1401 	enum signal_type sink_signal;
1402 	struct dc_link *link;
1403 	uint32_t dongle_max_pix_clk;
1404 	bool converter_disable_audio;
1405 };
1406 
1407 bool dc_extended_blank_supported(struct dc *dc);
1408 
1409 struct dc_sink *dc_sink_create(const struct dc_sink_init_data *init_params);
1410 
1411 /* Newer interfaces  */
1412 struct dc_cursor {
1413 	struct dc_plane_address address;
1414 	struct dc_cursor_attributes attributes;
1415 };
1416 
1417 
1418 /*******************************************************************************
1419  * Interrupt interfaces
1420  ******************************************************************************/
1421 enum dc_irq_source dc_interrupt_to_irq_source(
1422 		struct dc *dc,
1423 		uint32_t src_id,
1424 		uint32_t ext_id);
1425 bool dc_interrupt_set(struct dc *dc, enum dc_irq_source src, bool enable);
1426 void dc_interrupt_ack(struct dc *dc, enum dc_irq_source src);
1427 enum dc_irq_source dc_get_hpd_irq_source_at_index(
1428 		struct dc *dc, uint32_t link_index);
1429 
1430 void dc_notify_vsync_int_state(struct dc *dc, struct dc_stream_state *stream, bool enable);
1431 
1432 /*******************************************************************************
1433  * Power Interfaces
1434  ******************************************************************************/
1435 
1436 void dc_set_power_state(
1437 		struct dc *dc,
1438 		enum dc_acpi_cm_power_state power_state);
1439 void dc_resume(struct dc *dc);
1440 
1441 void dc_power_down_on_boot(struct dc *dc);
1442 
1443 #if defined(CONFIG_DRM_AMD_DC_HDCP)
1444 /*
1445  * HDCP Interfaces
1446  */
1447 enum hdcp_message_status dc_process_hdcp_msg(
1448 		enum signal_type signal,
1449 		struct dc_link *link,
1450 		struct hdcp_protection_message *message_info);
1451 #endif
1452 bool dc_is_dmcu_initialized(struct dc *dc);
1453 
1454 enum dc_status dc_set_clock(struct dc *dc, enum dc_clock_type clock_type, uint32_t clk_khz, uint32_t stepping);
1455 void dc_get_clock(struct dc *dc, enum dc_clock_type clock_type, struct dc_clock_config *clock_cfg);
1456 
1457 bool dc_is_plane_eligible_for_idle_optimizations(struct dc *dc, struct dc_plane_state *plane,
1458 				struct dc_cursor_attributes *cursor_attr);
1459 
1460 void dc_allow_idle_optimizations(struct dc *dc, bool allow);
1461 
1462 /* set min and max memory clock to lowest and highest DPM level, respectively */
1463 void dc_unlock_memory_clock_frequency(struct dc *dc);
1464 
1465 /* set min memory clock to the min required for current mode, max to maxDPM */
1466 void dc_lock_memory_clock_frequency(struct dc *dc);
1467 
1468 /* set soft max for memclk, to be used for AC/DC switching clock limitations */
1469 void dc_enable_dcmode_clk_limit(struct dc *dc, bool enable);
1470 
1471 /* cleanup on driver unload */
1472 void dc_hardware_release(struct dc *dc);
1473 
1474 /* disables fw based mclk switch */
1475 void dc_mclk_switch_using_fw_based_vblank_stretch_shut_down(struct dc *dc);
1476 
1477 bool dc_set_psr_allow_active(struct dc *dc, bool enable);
1478 void dc_z10_restore(const struct dc *dc);
1479 void dc_z10_save_init(struct dc *dc);
1480 
1481 bool dc_is_dmub_outbox_supported(struct dc *dc);
1482 bool dc_enable_dmub_notifications(struct dc *dc);
1483 
1484 void dc_enable_dmub_outbox(struct dc *dc);
1485 
1486 bool dc_process_dmub_aux_transfer_async(struct dc *dc,
1487 				uint32_t link_index,
1488 				struct aux_payload *payload);
1489 
1490 /* Get dc link index from dpia port index */
1491 uint8_t get_link_index_from_dpia_port_index(const struct dc *dc,
1492 				uint8_t dpia_port_index);
1493 
1494 bool dc_process_dmub_set_config_async(struct dc *dc,
1495 				uint32_t link_index,
1496 				struct set_config_cmd_payload *payload,
1497 				struct dmub_notification *notify);
1498 
1499 enum dc_status dc_process_dmub_set_mst_slots(const struct dc *dc,
1500 				uint32_t link_index,
1501 				uint8_t mst_alloc_slots,
1502 				uint8_t *mst_slots_in_use);
1503 
1504 /*******************************************************************************
1505  * DSC Interfaces
1506  ******************************************************************************/
1507 #include "dc_dsc.h"
1508 
1509 /*******************************************************************************
1510  * Disable acc mode Interfaces
1511  ******************************************************************************/
1512 void dc_disable_accelerated_mode(struct dc *dc);
1513 
1514 #endif /* DC_INTERFACE_H_ */
1515