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