xref: /openbmc/linux/drivers/gpu/drm/amd/display/dc/dc.h (revision d6e0cbb1)
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 #include "gpio_types.h"
33 #include "link_service_types.h"
34 #include "grph_object_ctrl_defs.h"
35 #include <inc/hw/opp.h>
36 
37 #include "inc/hw_sequencer.h"
38 #include "inc/compressor.h"
39 #include "inc/hw/dmcu.h"
40 #include "dml/display_mode_lib.h"
41 
42 #define DC_VER "3.2.42"
43 
44 #define MAX_SURFACES 3
45 #define MAX_PLANES 6
46 #define MAX_STREAMS 6
47 #define MAX_SINKS_PER_LINK 4
48 
49 /*******************************************************************************
50  * Display Core Interfaces
51  ******************************************************************************/
52 struct dc_versions {
53 	const char *dc_ver;
54 	struct dmcu_version dmcu_version;
55 };
56 
57 enum dc_plane_type {
58 	DC_PLANE_TYPE_INVALID,
59 	DC_PLANE_TYPE_DCE_RGB,
60 	DC_PLANE_TYPE_DCE_UNDERLAY,
61 	DC_PLANE_TYPE_DCN_UNIVERSAL,
62 };
63 
64 struct dc_plane_cap {
65 	enum dc_plane_type type;
66 	uint32_t blends_with_above : 1;
67 	uint32_t blends_with_below : 1;
68 	uint32_t per_pixel_alpha : 1;
69 	struct {
70 		uint32_t argb8888 : 1;
71 		uint32_t nv12 : 1;
72 		uint32_t fp16 : 1;
73 		uint32_t p010 : 1;
74 		uint32_t ayuv : 1;
75 	} pixel_format_support;
76 	// max upscaling factor x1000
77 	// upscaling factors are always >= 1
78 	// for example, 1080p -> 8K is 4.0, or 4000 raw value
79 	struct {
80 		uint32_t argb8888;
81 		uint32_t nv12;
82 		uint32_t fp16;
83 	} max_upscale_factor;
84 	// max downscale factor x1000
85 	// downscale factors are always <= 1
86 	// for example, 8K -> 1080p is 0.25, or 250 raw value
87 	struct {
88 		uint32_t argb8888;
89 		uint32_t nv12;
90 		uint32_t fp16;
91 	} max_downscale_factor;
92 };
93 
94 struct dc_caps {
95 	uint32_t max_streams;
96 	uint32_t max_links;
97 	uint32_t max_audios;
98 	uint32_t max_slave_planes;
99 	uint32_t max_planes;
100 	uint32_t max_downscale_ratio;
101 	uint32_t i2c_speed_in_khz;
102 	uint32_t dmdata_alloc_size;
103 	unsigned int max_cursor_size;
104 	unsigned int max_video_width;
105 	int linear_pitch_alignment;
106 	bool dcc_const_color;
107 	bool dynamic_audio;
108 	bool is_apu;
109 	bool dual_link_dvi;
110 	bool post_blend_color_processing;
111 	bool force_dp_tps4_for_cp2520;
112 	bool disable_dp_clk_share;
113 	bool psp_setup_panel_mode;
114 #ifdef CONFIG_DRM_AMD_DC_DCN2_0
115 	bool hw_3d_lut;
116 #endif
117 	struct dc_plane_cap planes[MAX_PLANES];
118 };
119 
120 #if defined(CONFIG_DRM_AMD_DC_DCN2_0)
121 struct dc_bug_wa {
122 	bool no_connect_phy_config;
123 	bool dedcn20_305_wa;
124 	struct display_mode_lib alternate_dml;
125 };
126 #endif
127 
128 struct dc_dcc_surface_param {
129 	struct dc_size surface_size;
130 	enum surface_pixel_format format;
131 	enum swizzle_mode_values swizzle_mode;
132 	enum dc_scan_direction scan;
133 };
134 
135 struct dc_dcc_setting {
136 	unsigned int max_compressed_blk_size;
137 	unsigned int max_uncompressed_blk_size;
138 	bool independent_64b_blks;
139 };
140 
141 struct dc_surface_dcc_cap {
142 	union {
143 		struct {
144 			struct dc_dcc_setting rgb;
145 		} grph;
146 
147 		struct {
148 			struct dc_dcc_setting luma;
149 			struct dc_dcc_setting chroma;
150 		} video;
151 	};
152 
153 	bool capable;
154 	bool const_color_support;
155 };
156 
157 struct dc_static_screen_events {
158 	bool force_trigger;
159 	bool cursor_update;
160 	bool surface_update;
161 	bool overlay_update;
162 };
163 
164 
165 /* Surface update type is used by dc_update_surfaces_and_stream
166  * The update type is determined at the very beginning of the function based
167  * on parameters passed in and decides how much programming (or updating) is
168  * going to be done during the call.
169  *
170  * UPDATE_TYPE_FAST is used for really fast updates that do not require much
171  * logical calculations or hardware register programming. This update MUST be
172  * ISR safe on windows. Currently fast update will only be used to flip surface
173  * address.
174  *
175  * UPDATE_TYPE_MED is used for slower updates which require significant hw
176  * re-programming however do not affect bandwidth consumption or clock
177  * requirements. At present, this is the level at which front end updates
178  * that do not require us to run bw_calcs happen. These are in/out transfer func
179  * updates, viewport offset changes, recout size changes and pixel depth changes.
180  * This update can be done at ISR, but we want to minimize how often this happens.
181  *
182  * UPDATE_TYPE_FULL is slow. Really slow. This requires us to recalculate our
183  * bandwidth and clocks, possibly rearrange some pipes and reprogram anything front
184  * end related. Any time viewport dimensions, recout dimensions, scaling ratios or
185  * gamma need to be adjusted or pipe needs to be turned on (or disconnected) we do
186  * a full update. This cannot be done at ISR level and should be a rare event.
187  * Unless someone is stress testing mpo enter/exit, playing with colour or adjusting
188  * underscan we don't expect to see this call at all.
189  */
190 
191 enum surface_update_type {
192 	UPDATE_TYPE_FAST, /* super fast, safe to execute in isr */
193 	UPDATE_TYPE_MED,  /* ISR safe, most of programming needed, no bw/clk change*/
194 	UPDATE_TYPE_FULL, /* may need to shuffle resources */
195 };
196 
197 /* Forward declaration*/
198 struct dc;
199 struct dc_plane_state;
200 struct dc_state;
201 
202 
203 struct dc_cap_funcs {
204 	bool (*get_dcc_compression_cap)(const struct dc *dc,
205 			const struct dc_dcc_surface_param *input,
206 			struct dc_surface_dcc_cap *output);
207 };
208 
209 struct link_training_settings;
210 
211 
212 /* Structure to hold configuration flags set by dm at dc creation. */
213 struct dc_config {
214 	bool gpu_vm_support;
215 	bool disable_disp_pll_sharing;
216 	bool fbc_support;
217 	bool optimize_edp_link_rate;
218 	bool disable_fractional_pwm;
219 	bool allow_seamless_boot_optimization;
220 	bool power_down_display_on_boot;
221 	bool edp_not_connected;
222 	bool forced_clocks;
223 
224 };
225 
226 enum visual_confirm {
227 	VISUAL_CONFIRM_DISABLE = 0,
228 	VISUAL_CONFIRM_SURFACE = 1,
229 	VISUAL_CONFIRM_HDR = 2,
230 };
231 
232 enum dcc_option {
233 	DCC_ENABLE = 0,
234 	DCC_DISABLE = 1,
235 	DCC_HALF_REQ_DISALBE = 2,
236 };
237 
238 enum pipe_split_policy {
239 	MPC_SPLIT_DYNAMIC = 0,
240 	MPC_SPLIT_AVOID = 1,
241 	MPC_SPLIT_AVOID_MULT_DISP = 2,
242 };
243 
244 enum wm_report_mode {
245 	WM_REPORT_DEFAULT = 0,
246 	WM_REPORT_OVERRIDE = 1,
247 };
248 
249 /*
250  * For any clocks that may differ per pipe
251  * only the max is stored in this structure
252  */
253 struct dc_clocks {
254 	int dispclk_khz;
255 	int max_supported_dppclk_khz;
256 	int max_supported_dispclk_khz;
257 	int dppclk_khz;
258 	int bw_dppclk_khz; /*a copy of dppclk_khz*/
259 	int bw_dispclk_khz;
260 	int dcfclk_khz;
261 	int socclk_khz;
262 	int dcfclk_deep_sleep_khz;
263 	int fclk_khz;
264 	int phyclk_khz;
265 	int dramclk_khz;
266 	bool p_state_change_support;
267 
268 	/*
269 	 * Elements below are not compared for the purposes of
270 	 * optimization required
271 	 */
272 	bool prev_p_state_change_support;
273 };
274 
275 struct dc_bw_validation_profile {
276 	bool enable;
277 
278 	unsigned long long total_ticks;
279 	unsigned long long voltage_level_ticks;
280 	unsigned long long watermark_ticks;
281 	unsigned long long rq_dlg_ticks;
282 
283 	unsigned long long total_count;
284 	unsigned long long skip_fast_count;
285 	unsigned long long skip_pass_count;
286 	unsigned long long skip_fail_count;
287 };
288 
289 #define BW_VAL_TRACE_SETUP() \
290 		unsigned long long end_tick = 0; \
291 		unsigned long long voltage_level_tick = 0; \
292 		unsigned long long watermark_tick = 0; \
293 		unsigned long long start_tick = dc->debug.bw_val_profile.enable ? \
294 				dm_get_timestamp(dc->ctx) : 0
295 
296 #define BW_VAL_TRACE_COUNT() \
297 		if (dc->debug.bw_val_profile.enable) \
298 			dc->debug.bw_val_profile.total_count++
299 
300 #define BW_VAL_TRACE_SKIP(status) \
301 		if (dc->debug.bw_val_profile.enable) { \
302 			if (!voltage_level_tick) \
303 				voltage_level_tick = dm_get_timestamp(dc->ctx); \
304 			dc->debug.bw_val_profile.skip_ ## status ## _count++; \
305 		}
306 
307 #define BW_VAL_TRACE_END_VOLTAGE_LEVEL() \
308 		if (dc->debug.bw_val_profile.enable) \
309 			voltage_level_tick = dm_get_timestamp(dc->ctx)
310 
311 #define BW_VAL_TRACE_END_WATERMARKS() \
312 		if (dc->debug.bw_val_profile.enable) \
313 			watermark_tick = dm_get_timestamp(dc->ctx)
314 
315 #define BW_VAL_TRACE_FINISH() \
316 		if (dc->debug.bw_val_profile.enable) { \
317 			end_tick = dm_get_timestamp(dc->ctx); \
318 			dc->debug.bw_val_profile.total_ticks += end_tick - start_tick; \
319 			dc->debug.bw_val_profile.voltage_level_ticks += voltage_level_tick - start_tick; \
320 			if (watermark_tick) { \
321 				dc->debug.bw_val_profile.watermark_ticks += watermark_tick - voltage_level_tick; \
322 				dc->debug.bw_val_profile.rq_dlg_ticks += end_tick - watermark_tick; \
323 			} \
324 		}
325 
326 struct dc_debug_options {
327 	enum visual_confirm visual_confirm;
328 	bool sanity_checks;
329 	bool max_disp_clk;
330 	bool surface_trace;
331 	bool timing_trace;
332 	bool clock_trace;
333 	bool validation_trace;
334 	bool bandwidth_calcs_trace;
335 	int max_downscale_src_width;
336 
337 	/* stutter efficiency related */
338 	bool disable_stutter;
339 	bool use_max_lb;
340 	enum dcc_option disable_dcc;
341 	enum pipe_split_policy pipe_split_policy;
342 	bool force_single_disp_pipe_split;
343 	bool voltage_align_fclk;
344 
345 	bool disable_dfs_bypass;
346 	bool disable_dpp_power_gate;
347 	bool disable_hubp_power_gate;
348 #ifdef CONFIG_DRM_AMD_DC_DSC_SUPPORT
349 	bool disable_dsc_power_gate;
350 #endif
351 	bool disable_pplib_wm_range;
352 	enum wm_report_mode pplib_wm_report_mode;
353 	unsigned int min_disp_clk_khz;
354 	unsigned int min_dpp_clk_khz;
355 	int sr_exit_time_dpm0_ns;
356 	int sr_enter_plus_exit_time_dpm0_ns;
357 	int sr_exit_time_ns;
358 	int sr_enter_plus_exit_time_ns;
359 	int urgent_latency_ns;
360 	uint32_t underflow_assert_delay_us;
361 	int percent_of_ideal_drambw;
362 	int dram_clock_change_latency_ns;
363 	bool optimized_watermark;
364 	int always_scale;
365 	bool disable_pplib_clock_request;
366 	bool disable_clock_gate;
367 	bool disable_dmcu;
368 	bool disable_psr;
369 	bool force_abm_enable;
370 	bool disable_stereo_support;
371 	bool vsr_support;
372 	bool performance_trace;
373 	bool az_endpoint_mute_only;
374 	bool always_use_regamma;
375 	bool p010_mpo_support;
376 	bool recovery_enabled;
377 	bool avoid_vbios_exec_table;
378 	bool scl_reset_length10;
379 	bool hdmi20_disable;
380 	bool skip_detection_link_training;
381 	bool remove_disconnect_edp;
382 	unsigned int force_odm_combine; //bit vector based on otg inst
383 	unsigned int force_fclk_khz;
384 	bool disable_tri_buf;
385 	struct dc_bw_validation_profile bw_val_profile;
386 #ifdef CONFIG_DRM_AMD_DC_DSC_SUPPORT
387 	bool disable_fec;
388 #endif
389 	/* This forces a hard min on the DCFCLK requested to SMU/PP
390 	 * watermarks are not affected.
391 	 */
392 	unsigned int force_min_dcfclk_mhz;
393 	bool disable_timing_sync;
394 #if defined(CONFIG_DRM_AMD_DC_DCN2_0)
395 	bool cm_in_bypass;
396 #endif
397 	int force_clock_mode;/*every mode change.*/
398 };
399 
400 struct dc_debug_data {
401 	uint32_t ltFailCount;
402 	uint32_t i2cErrorCount;
403 	uint32_t auxErrorCount;
404 };
405 
406 #ifdef CONFIG_DRM_AMD_DC_DCN2_0
407 struct dc_phy_addr_space_config {
408 	struct {
409 		uint64_t start_addr;
410 		uint64_t end_addr;
411 		uint64_t fb_top;
412 		uint64_t fb_offset;
413 		uint64_t fb_base;
414 		uint64_t agp_top;
415 		uint64_t agp_bot;
416 		uint64_t agp_base;
417 	} system_aperture;
418 
419 	struct {
420 		uint64_t page_table_start_addr;
421 		uint64_t page_table_end_addr;
422 		uint64_t page_table_base_addr;
423 	} gart_config;
424 
425 	bool valid;
426 };
427 
428 struct dc_virtual_addr_space_config {
429 	uint64_t	page_table_base_addr;
430 	uint64_t	page_table_start_addr;
431 	uint64_t	page_table_end_addr;
432 	uint32_t	page_table_block_size_in_bytes;
433 	uint8_t		page_table_depth; // 1 = 1 level, 2 = 2 level, etc.  0 = invalid
434 };
435 #endif
436 
437 struct dc_bounding_box_overrides {
438 	int sr_exit_time_ns;
439 	int sr_enter_plus_exit_time_ns;
440 	int urgent_latency_ns;
441 	int percent_of_ideal_drambw;
442 	int dram_clock_change_latency_ns;
443 	/* This forces a hard min on the DCFCLK we use
444 	 * for DML.  Unlike the debug option for forcing
445 	 * DCFCLK, this override affects watermark calculations
446 	 */
447 	int min_dcfclk_mhz;
448 };
449 
450 struct dc_state;
451 struct resource_pool;
452 struct dce_hwseq;
453 struct gpu_info_soc_bounding_box_v1_0;
454 struct dc {
455 	struct dc_versions versions;
456 	struct dc_caps caps;
457 	struct dc_cap_funcs cap_funcs;
458 	struct dc_config config;
459 	struct dc_debug_options debug;
460 	struct dc_bounding_box_overrides bb_overrides;
461 #if defined(CONFIG_DRM_AMD_DC_DCN2_0)
462 	struct dc_bug_wa work_arounds;
463 #endif
464 	struct dc_context *ctx;
465 #ifdef CONFIG_DRM_AMD_DC_DCN2_0
466 	struct dc_phy_addr_space_config vm_pa_config;
467 #endif
468 
469 	uint8_t link_count;
470 	struct dc_link *links[MAX_PIPES * 2];
471 
472 	struct dc_state *current_state;
473 	struct resource_pool *res_pool;
474 
475 	struct clk_mgr *clk_mgr;
476 
477 	/* Display Engine Clock levels */
478 	struct dm_pp_clock_levels sclk_lvls;
479 
480 	/* Inputs into BW and WM calculations. */
481 	struct bw_calcs_dceip *bw_dceip;
482 	struct bw_calcs_vbios *bw_vbios;
483 #ifdef CONFIG_DRM_AMD_DC_DCN1_0
484 	struct dcn_soc_bounding_box *dcn_soc;
485 	struct dcn_ip_params *dcn_ip;
486 	struct display_mode_lib dml;
487 #endif
488 
489 	/* HW functions */
490 	struct hw_sequencer_funcs hwss;
491 	struct dce_hwseq *hwseq;
492 
493 	/* Require to optimize clocks and bandwidth for added/removed planes */
494 	bool optimized_required;
495 
496 	/* Require to maintain clocks and bandwidth for UEFI enabled HW */
497 	bool optimize_seamless_boot;
498 
499 	/* FBC compressor */
500 	struct compressor *fbc_compressor;
501 
502 	struct dc_debug_data debug_data;
503 
504 	const char *build_id;
505 #ifdef CONFIG_DRM_AMD_DC_DCN2_0
506 	struct vm_helper *vm_helper;
507 	const struct gpu_info_soc_bounding_box_v1_0 *soc_bounding_box;
508 #endif
509 };
510 
511 enum frame_buffer_mode {
512 	FRAME_BUFFER_MODE_LOCAL_ONLY = 0,
513 	FRAME_BUFFER_MODE_ZFB_ONLY,
514 	FRAME_BUFFER_MODE_MIXED_ZFB_AND_LOCAL,
515 } ;
516 
517 struct dchub_init_data {
518 	int64_t zfb_phys_addr_base;
519 	int64_t zfb_mc_base_addr;
520 	uint64_t zfb_size_in_byte;
521 	enum frame_buffer_mode fb_mode;
522 	bool dchub_initialzied;
523 	bool dchub_info_valid;
524 };
525 
526 struct dc_init_data {
527 	struct hw_asic_id asic_id;
528 	void *driver; /* ctx */
529 	struct cgs_device *cgs_device;
530 	struct dc_bounding_box_overrides bb_overrides;
531 
532 	int num_virtual_links;
533 	/*
534 	 * If 'vbios_override' not NULL, it will be called instead
535 	 * of the real VBIOS. Intended use is Diagnostics on FPGA.
536 	 */
537 	struct dc_bios *vbios_override;
538 	enum dce_environment dce_environment;
539 
540 	struct dc_config flags;
541 	uint32_t log_mask;
542 #ifdef CONFIG_DRM_AMD_DC_DCN2_0
543 	/**
544 	 * gpu_info FW provided soc bounding box struct or 0 if not
545 	 * available in FW
546 	 */
547 	const struct gpu_info_soc_bounding_box_v1_0 *soc_bounding_box;
548 #endif
549 };
550 
551 struct dc_callback_init {
552 	uint8_t reserved;
553 };
554 
555 struct dc *dc_create(const struct dc_init_data *init_params);
556 int dc_get_vmid_use_vector(struct dc *dc);
557 #ifdef CONFIG_DRM_AMD_DC_DCN2_0
558 void dc_setup_vm_context(struct dc *dc, struct dc_virtual_addr_space_config *va_config, int vmid);
559 /* Returns the number of vmids supported */
560 int dc_setup_system_context(struct dc *dc, struct dc_phy_addr_space_config *pa_config);
561 #endif
562 void dc_init_callbacks(struct dc *dc,
563 		const struct dc_callback_init *init_params);
564 void dc_destroy(struct dc **dc);
565 
566 /*******************************************************************************
567  * Surface Interfaces
568  ******************************************************************************/
569 
570 enum {
571 	TRANSFER_FUNC_POINTS = 1025
572 };
573 
574 struct dc_hdr_static_metadata {
575 	/* display chromaticities and white point in units of 0.00001 */
576 	unsigned int chromaticity_green_x;
577 	unsigned int chromaticity_green_y;
578 	unsigned int chromaticity_blue_x;
579 	unsigned int chromaticity_blue_y;
580 	unsigned int chromaticity_red_x;
581 	unsigned int chromaticity_red_y;
582 	unsigned int chromaticity_white_point_x;
583 	unsigned int chromaticity_white_point_y;
584 
585 	uint32_t min_luminance;
586 	uint32_t max_luminance;
587 	uint32_t maximum_content_light_level;
588 	uint32_t maximum_frame_average_light_level;
589 };
590 
591 enum dc_transfer_func_type {
592 	TF_TYPE_PREDEFINED,
593 	TF_TYPE_DISTRIBUTED_POINTS,
594 	TF_TYPE_BYPASS,
595 	TF_TYPE_HWPWL
596 };
597 
598 struct dc_transfer_func_distributed_points {
599 	struct fixed31_32 red[TRANSFER_FUNC_POINTS];
600 	struct fixed31_32 green[TRANSFER_FUNC_POINTS];
601 	struct fixed31_32 blue[TRANSFER_FUNC_POINTS];
602 
603 	uint16_t end_exponent;
604 	uint16_t x_point_at_y1_red;
605 	uint16_t x_point_at_y1_green;
606 	uint16_t x_point_at_y1_blue;
607 };
608 
609 enum dc_transfer_func_predefined {
610 	TRANSFER_FUNCTION_SRGB,
611 	TRANSFER_FUNCTION_BT709,
612 	TRANSFER_FUNCTION_PQ,
613 	TRANSFER_FUNCTION_LINEAR,
614 	TRANSFER_FUNCTION_UNITY,
615 	TRANSFER_FUNCTION_HLG,
616 	TRANSFER_FUNCTION_HLG12,
617 	TRANSFER_FUNCTION_GAMMA22
618 };
619 
620 struct dc_transfer_func {
621 	struct kref refcount;
622 	enum dc_transfer_func_type type;
623 	enum dc_transfer_func_predefined tf;
624 	/* FP16 1.0 reference level in nits, default is 80 nits, only for PQ*/
625 	uint32_t sdr_ref_white_level;
626 	struct dc_context *ctx;
627 	union {
628 		struct pwl_params pwl;
629 		struct dc_transfer_func_distributed_points tf_pts;
630 	};
631 };
632 
633 #if defined(CONFIG_DRM_AMD_DC_DCN2_0)
634 
635 union dc_3dlut_state {
636 	struct {
637 		uint32_t initialized:1;		/*if 3dlut is went through color module for initialization */
638 		uint32_t rmu_idx_valid:1;	/*if mux settings are valid*/
639 		uint32_t rmu_mux_num:3;		/*index of mux to use*/
640 		uint32_t mpc_rmu0_mux:4;	/*select mpcc on mux, one of the following : mpcc0, mpcc1, mpcc2, mpcc3*/
641 		uint32_t mpc_rmu1_mux:4;
642 		uint32_t mpc_rmu2_mux:4;
643 		uint32_t reserved:15;
644 	} bits;
645 	uint32_t raw;
646 };
647 
648 
649 struct dc_3dlut {
650 	struct kref refcount;
651 	struct tetrahedral_params lut_3d;
652 	uint32_t hdr_multiplier;
653 	bool initialized; /*remove after diag fix*/
654 	union dc_3dlut_state state;
655 	struct dc_context *ctx;
656 };
657 #endif
658 /*
659  * This structure is filled in by dc_surface_get_status and contains
660  * the last requested address and the currently active address so the called
661  * can determine if there are any outstanding flips
662  */
663 struct dc_plane_status {
664 	struct dc_plane_address requested_address;
665 	struct dc_plane_address current_address;
666 	bool is_flip_pending;
667 	bool is_right_eye;
668 };
669 
670 union surface_update_flags {
671 
672 	struct {
673 		uint32_t addr_update:1;
674 		/* Medium updates */
675 		uint32_t dcc_change:1;
676 		uint32_t color_space_change:1;
677 		uint32_t horizontal_mirror_change:1;
678 		uint32_t per_pixel_alpha_change:1;
679 		uint32_t global_alpha_change:1;
680 		uint32_t sdr_white_level:1;
681 		uint32_t rotation_change:1;
682 		uint32_t swizzle_change:1;
683 		uint32_t scaling_change:1;
684 		uint32_t position_change:1;
685 		uint32_t in_transfer_func_change:1;
686 		uint32_t input_csc_change:1;
687 		uint32_t coeff_reduction_change:1;
688 		uint32_t output_tf_change:1;
689 		uint32_t pixel_format_change:1;
690 		uint32_t plane_size_change:1;
691 
692 		/* Full updates */
693 		uint32_t new_plane:1;
694 		uint32_t bpp_change:1;
695 		uint32_t gamma_change:1;
696 		uint32_t bandwidth_change:1;
697 		uint32_t clock_change:1;
698 		uint32_t stereo_format_change:1;
699 		uint32_t full_update:1;
700 	} bits;
701 
702 	uint32_t raw;
703 };
704 
705 struct dc_plane_state {
706 	struct dc_plane_address address;
707 	struct dc_plane_flip_time time;
708 #if defined(CONFIG_DRM_AMD_DC_DCN2_0)
709 	bool triplebuffer_flips;
710 #endif
711 	struct scaling_taps scaling_quality;
712 	struct rect src_rect;
713 	struct rect dst_rect;
714 	struct rect clip_rect;
715 
716 	struct plane_size plane_size;
717 	union dc_tiling_info tiling_info;
718 
719 	struct dc_plane_dcc_param dcc;
720 
721 	struct dc_gamma *gamma_correction;
722 	struct dc_transfer_func *in_transfer_func;
723 	struct dc_bias_and_scale *bias_and_scale;
724 	struct dc_csc_transform input_csc_color_matrix;
725 	struct fixed31_32 coeff_reduction_factor;
726 	uint32_t sdr_white_level;
727 
728 	// TODO: No longer used, remove
729 	struct dc_hdr_static_metadata hdr_static_ctx;
730 
731 	enum dc_color_space color_space;
732 
733 #if defined(CONFIG_DRM_AMD_DC_DCN2_0)
734 	struct dc_3dlut *lut3d_func;
735 	struct dc_transfer_func *in_shaper_func;
736 	struct dc_transfer_func *blend_tf;
737 #endif
738 
739 	enum surface_pixel_format format;
740 	enum dc_rotation_angle rotation;
741 	enum plane_stereo_format stereo_format;
742 
743 	bool is_tiling_rotated;
744 	bool per_pixel_alpha;
745 	bool global_alpha;
746 	int  global_alpha_value;
747 	bool visible;
748 	bool flip_immediate;
749 	bool horizontal_mirror;
750 
751 	union surface_update_flags update_flags;
752 	/* private to DC core */
753 	struct dc_plane_status status;
754 	struct dc_context *ctx;
755 
756 	/* HACK: Workaround for forcing full reprogramming under some conditions */
757 	bool force_full_update;
758 
759 	/* private to dc_surface.c */
760 	enum dc_irq_source irq_source;
761 	struct kref refcount;
762 };
763 
764 struct dc_plane_info {
765 	struct plane_size plane_size;
766 	union dc_tiling_info tiling_info;
767 	struct dc_plane_dcc_param dcc;
768 	enum surface_pixel_format format;
769 	enum dc_rotation_angle rotation;
770 	enum plane_stereo_format stereo_format;
771 	enum dc_color_space color_space;
772 	unsigned int sdr_white_level;
773 	bool horizontal_mirror;
774 	bool visible;
775 	bool per_pixel_alpha;
776 	bool global_alpha;
777 	int  global_alpha_value;
778 	bool input_csc_enabled;
779 };
780 
781 struct dc_scaling_info {
782 	struct rect src_rect;
783 	struct rect dst_rect;
784 	struct rect clip_rect;
785 	struct scaling_taps scaling_quality;
786 };
787 
788 struct dc_surface_update {
789 	struct dc_plane_state *surface;
790 
791 	/* isr safe update parameters.  null means no updates */
792 	const struct dc_flip_addrs *flip_addr;
793 	const struct dc_plane_info *plane_info;
794 	const struct dc_scaling_info *scaling_info;
795 
796 	/* following updates require alloc/sleep/spin that is not isr safe,
797 	 * null means no updates
798 	 */
799 	const struct dc_gamma *gamma;
800 	const struct dc_transfer_func *in_transfer_func;
801 
802 	const struct dc_csc_transform *input_csc_color_matrix;
803 	const struct fixed31_32 *coeff_reduction_factor;
804 #if defined(CONFIG_DRM_AMD_DC_DCN2_0)
805 	const struct dc_transfer_func *func_shaper;
806 	const struct dc_3dlut *lut3d_func;
807 	const struct dc_transfer_func *blend_tf;
808 #endif
809 };
810 
811 /*
812  * Create a new surface with default parameters;
813  */
814 struct dc_plane_state *dc_create_plane_state(struct dc *dc);
815 const struct dc_plane_status *dc_plane_get_status(
816 		const struct dc_plane_state *plane_state);
817 
818 void dc_plane_state_retain(struct dc_plane_state *plane_state);
819 void dc_plane_state_release(struct dc_plane_state *plane_state);
820 
821 void dc_gamma_retain(struct dc_gamma *dc_gamma);
822 void dc_gamma_release(struct dc_gamma **dc_gamma);
823 struct dc_gamma *dc_create_gamma(void);
824 
825 void dc_transfer_func_retain(struct dc_transfer_func *dc_tf);
826 void dc_transfer_func_release(struct dc_transfer_func *dc_tf);
827 struct dc_transfer_func *dc_create_transfer_func(void);
828 
829 #if defined(CONFIG_DRM_AMD_DC_DCN2_0)
830 struct dc_3dlut *dc_create_3dlut_func(void);
831 void dc_3dlut_func_release(struct dc_3dlut *lut);
832 void dc_3dlut_func_retain(struct dc_3dlut *lut);
833 #endif
834 /*
835  * This structure holds a surface address.  There could be multiple addresses
836  * in cases such as Stereo 3D, Planar YUV, etc.  Other per-flip attributes such
837  * as frame durations and DCC format can also be set.
838  */
839 struct dc_flip_addrs {
840 	struct dc_plane_address address;
841 	unsigned int flip_timestamp_in_us;
842 	bool flip_immediate;
843 	/* TODO: add flip duration for FreeSync */
844 };
845 
846 bool dc_post_update_surfaces_to_stream(
847 		struct dc *dc);
848 
849 #include "dc_stream.h"
850 
851 /*
852  * Structure to store surface/stream associations for validation
853  */
854 struct dc_validation_set {
855 	struct dc_stream_state *stream;
856 	struct dc_plane_state *plane_states[MAX_SURFACES];
857 	uint8_t plane_count;
858 };
859 
860 bool dc_validate_seamless_boot_timing(const struct dc *dc,
861 				const struct dc_sink *sink,
862 				struct dc_crtc_timing *crtc_timing);
863 
864 enum dc_status dc_validate_plane(struct dc *dc, const struct dc_plane_state *plane_state);
865 
866 void get_clock_requirements_for_state(struct dc_state *state, struct AsicStateEx *info);
867 
868 bool dc_set_generic_gpio_for_stereo(bool enable,
869 		struct gpio_service *gpio_service);
870 
871 /*
872  * fast_validate: we return after determining if we can support the new state,
873  * but before we populate the programming info
874  */
875 enum dc_status dc_validate_global_state(
876 		struct dc *dc,
877 		struct dc_state *new_ctx,
878 		bool fast_validate);
879 
880 
881 void dc_resource_state_construct(
882 		const struct dc *dc,
883 		struct dc_state *dst_ctx);
884 
885 void dc_resource_state_copy_construct(
886 		const struct dc_state *src_ctx,
887 		struct dc_state *dst_ctx);
888 
889 void dc_resource_state_copy_construct_current(
890 		const struct dc *dc,
891 		struct dc_state *dst_ctx);
892 
893 void dc_resource_state_destruct(struct dc_state *context);
894 
895 /*
896  * TODO update to make it about validation sets
897  * Set up streams and links associated to drive sinks
898  * The streams parameter is an absolute set of all active streams.
899  *
900  * After this call:
901  *   Phy, Encoder, Timing Generator are programmed and enabled.
902  *   New streams are enabled with blank stream; no memory read.
903  */
904 bool dc_commit_state(struct dc *dc, struct dc_state *context);
905 
906 
907 struct dc_state *dc_create_state(struct dc *dc);
908 struct dc_state *dc_copy_state(struct dc_state *src_ctx);
909 void dc_retain_state(struct dc_state *context);
910 void dc_release_state(struct dc_state *context);
911 
912 /*******************************************************************************
913  * Link Interfaces
914  ******************************************************************************/
915 
916 struct dpcd_caps {
917 	union dpcd_rev dpcd_rev;
918 	union max_lane_count max_ln_count;
919 	union max_down_spread max_down_spread;
920 	union dprx_feature dprx_feature;
921 
922 	/* valid only for eDP v1.4 or higher*/
923 	uint8_t edp_supported_link_rates_count;
924 	enum dc_link_rate edp_supported_link_rates[8];
925 
926 	/* dongle type (DP converter, CV smart dongle) */
927 	enum display_dongle_type dongle_type;
928 	/* branch device or sink device */
929 	bool is_branch_dev;
930 	/* Dongle's downstream count. */
931 	union sink_count sink_count;
932 	/* If dongle_type == DISPLAY_DONGLE_DP_HDMI_CONVERTER,
933 	indicates 'Frame Sequential-to-lllFrame Pack' conversion capability.*/
934 	struct dc_dongle_caps dongle_caps;
935 
936 	uint32_t sink_dev_id;
937 	int8_t sink_dev_id_str[6];
938 	int8_t sink_hw_revision;
939 	int8_t sink_fw_revision[2];
940 
941 	uint32_t branch_dev_id;
942 	int8_t branch_dev_name[6];
943 	int8_t branch_hw_revision;
944 	int8_t branch_fw_revision[2];
945 
946 	bool allow_invalid_MSA_timing_param;
947 	bool panel_mode_edp;
948 	bool dpcd_display_control_capable;
949 	bool ext_receiver_cap_field_present;
950 #ifdef CONFIG_DRM_AMD_DC_DSC_SUPPORT
951 	union dpcd_fec_capability fec_cap;
952 	struct dpcd_dsc_capabilities dsc_caps;
953 #endif
954 };
955 
956 #include "dc_link.h"
957 
958 /*******************************************************************************
959  * Sink Interfaces - A sink corresponds to a display output device
960  ******************************************************************************/
961 
962 struct dc_container_id {
963 	// 128bit GUID in binary form
964 	unsigned char  guid[16];
965 	// 8 byte port ID -> ELD.PortID
966 	unsigned int   portId[2];
967 	// 128bit GUID in binary formufacturer name -> ELD.ManufacturerName
968 	unsigned short manufacturerName;
969 	// 2 byte product code -> ELD.ProductCode
970 	unsigned short productCode;
971 };
972 
973 
974 #ifdef CONFIG_DRM_AMD_DC_DSC_SUPPORT
975 struct dc_sink_dsc_caps {
976 	// 'true' if these are virtual DPCD's DSC caps (immediately upstream of sink in MST topology),
977 	// 'false' if they are sink's DSC caps
978 	bool is_virtual_dpcd_dsc;
979 	struct dsc_dec_dpcd_caps dsc_dec_caps;
980 };
981 #endif
982 
983 /*
984  * The sink structure contains EDID and other display device properties
985  */
986 struct dc_sink {
987 	enum signal_type sink_signal;
988 	struct dc_edid dc_edid; /* raw edid */
989 	struct dc_edid_caps edid_caps; /* parse display caps */
990 	struct dc_container_id *dc_container_id;
991 	uint32_t dongle_max_pix_clk;
992 	void *priv;
993 	struct stereo_3d_features features_3d[TIMING_3D_FORMAT_MAX];
994 	bool converter_disable_audio;
995 
996 #ifdef CONFIG_DRM_AMD_DC_DSC_SUPPORT
997 	struct dc_sink_dsc_caps sink_dsc_caps;
998 #endif
999 
1000 	/* private to DC core */
1001 	struct dc_link *link;
1002 	struct dc_context *ctx;
1003 
1004 	uint32_t sink_id;
1005 
1006 	/* private to dc_sink.c */
1007 	// refcount must be the last member in dc_sink, since we want the
1008 	// sink structure to be logically cloneable up to (but not including)
1009 	// refcount
1010 	struct kref refcount;
1011 };
1012 
1013 void dc_sink_retain(struct dc_sink *sink);
1014 void dc_sink_release(struct dc_sink *sink);
1015 
1016 struct dc_sink_init_data {
1017 	enum signal_type sink_signal;
1018 	struct dc_link *link;
1019 	uint32_t dongle_max_pix_clk;
1020 	bool converter_disable_audio;
1021 };
1022 
1023 struct dc_sink *dc_sink_create(const struct dc_sink_init_data *init_params);
1024 
1025 /* Newer interfaces  */
1026 struct dc_cursor {
1027 	struct dc_plane_address address;
1028 	struct dc_cursor_attributes attributes;
1029 };
1030 
1031 
1032 /*******************************************************************************
1033  * Interrupt interfaces
1034  ******************************************************************************/
1035 enum dc_irq_source dc_interrupt_to_irq_source(
1036 		struct dc *dc,
1037 		uint32_t src_id,
1038 		uint32_t ext_id);
1039 bool dc_interrupt_set(struct dc *dc, enum dc_irq_source src, bool enable);
1040 void dc_interrupt_ack(struct dc *dc, enum dc_irq_source src);
1041 enum dc_irq_source dc_get_hpd_irq_source_at_index(
1042 		struct dc *dc, uint32_t link_index);
1043 
1044 /*******************************************************************************
1045  * Power Interfaces
1046  ******************************************************************************/
1047 
1048 void dc_set_power_state(
1049 		struct dc *dc,
1050 		enum dc_acpi_cm_power_state power_state);
1051 void dc_resume(struct dc *dc);
1052 unsigned int dc_get_current_backlight_pwm(struct dc *dc);
1053 unsigned int dc_get_target_backlight_pwm(struct dc *dc);
1054 
1055 bool dc_is_dmcu_initialized(struct dc *dc);
1056 
1057 enum dc_status dc_set_clock(struct dc *dc, enum dc_clock_type clock_type, uint32_t clk_khz, uint32_t stepping);
1058 void dc_get_clock(struct dc *dc, enum dc_clock_type clock_type, struct dc_clock_config *clock_cfg);
1059 #if defined(CONFIG_DRM_AMD_DC_DSC_SUPPORT)
1060 /*******************************************************************************
1061  * DSC Interfaces
1062  ******************************************************************************/
1063 #include "dc_dsc.h"
1064 #endif
1065 #endif /* DC_INTERFACE_H_ */
1066