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