2 * Copyright 2012-14 Advanced Micro Devices, Inc.
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:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
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.
26 #ifndef DC_INTERFACE_H_
27 #define DC_INTERFACE_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"
35 #include "gpio_types.h"
36 #include "link_service_types.h"
37 #include "grph_object_ctrl_defs.h"
38 #include <inc/hw/opp.h>
40 #include "inc/hw_sequencer.h"
41 #include "inc/compressor.h"
42 #include "inc/hw/dmcu.h"
43 #include "dml/display_mode_lib.h"
45 #define DC_VER "3.2.122"
47 #define MAX_SURFACES 3
50 #define MAX_SINKS_PER_LINK 4
51 #define MIN_VIEWPORT_SIZE 12
53 /*******************************************************************************
54 * Display Core Interfaces
55 ******************************************************************************/
58 struct dmcu_version dmcu_version;
61 enum dp_protocol_version {
66 DC_PLANE_TYPE_INVALID,
67 DC_PLANE_TYPE_DCE_RGB,
68 DC_PLANE_TYPE_DCE_UNDERLAY,
69 DC_PLANE_TYPE_DCN_UNIVERSAL,
73 enum dc_plane_type type;
74 uint32_t blends_with_above : 1;
75 uint32_t blends_with_below : 1;
76 uint32_t per_pixel_alpha : 1;
78 uint32_t argb8888 : 1;
83 } pixel_format_support;
84 // max upscaling factor x1000
85 // upscaling factors are always >= 1
86 // for example, 1080p -> 8K is 4.0, or 4000 raw value
92 // max downscale factor x1000
93 // downscale factors are always <= 1
94 // for example, 8K -> 1080p is 0.25, or 250 raw value
99 } max_downscale_factor;
100 // minimal width/height
105 // Color management caps (DPP and MPC)
106 struct rom_curve_caps {
109 uint16_t gamma2_2 : 1;
114 struct dpp_color_caps {
115 uint16_t dcn_arch : 1; // all DCE generations treated the same
116 // input lut is different than most LUTs, just plain 256-entry lookup
117 uint16_t input_lut_shared : 1; // shared with DGAM
119 uint16_t dgam_ram : 1;
120 uint16_t post_csc : 1; // before gamut remap
121 uint16_t gamma_corr : 1;
123 // hdr_mult and gamut remap always available in DPP (in that order)
124 // 3d lut implies shaper LUT,
125 // it may be shared with MPC - check MPC:shared_3d_lut flag
126 uint16_t hw_3d_lut : 1;
127 uint16_t ogam_ram : 1; // blnd gam
129 uint16_t dgam_rom_for_yuv : 1;
130 struct rom_curve_caps dgam_rom_caps;
131 struct rom_curve_caps ogam_rom_caps;
134 struct mpc_color_caps {
135 uint16_t gamut_remap : 1;
136 uint16_t ogam_ram : 1;
138 uint16_t num_3dluts : 3; //3d lut always assumes a preceding shaper LUT
139 uint16_t shared_3d_lut:1; //can be in either DPP or MPC, but single instance
141 struct rom_curve_caps ogam_rom_caps;
144 struct dc_color_caps {
145 struct dpp_color_caps dpp;
146 struct mpc_color_caps mpc;
150 uint32_t max_streams;
153 uint32_t max_slave_planes;
155 uint32_t max_downscale_ratio;
156 uint32_t i2c_speed_in_khz;
157 uint32_t i2c_speed_in_khz_hdcp;
158 uint32_t dmdata_alloc_size;
159 unsigned int max_cursor_size;
160 unsigned int max_video_width;
161 unsigned int min_horizontal_blanking_period;
162 int linear_pitch_alignment;
163 bool dcc_const_color;
167 bool post_blend_color_processing;
168 bool force_dp_tps4_for_cp2520;
169 bool disable_dp_clk_share;
170 bool psp_setup_panel_mode;
171 bool extended_aux_timeout_support;
173 uint32_t num_of_internal_disp;
174 enum dp_protocol_version max_dp_protocol_version;
175 unsigned int mall_size_per_mem_channel;
176 unsigned int mall_size_total;
177 unsigned int cursor_cache_size;
178 struct dc_plane_cap planes[MAX_PLANES];
179 struct dc_color_caps color;
183 bool no_connect_phy_config;
185 bool skip_clock_update;
186 bool lt_early_cr_pattern;
189 struct dc_dcc_surface_param {
190 struct dc_size surface_size;
191 enum surface_pixel_format format;
192 enum swizzle_mode_values swizzle_mode;
193 enum dc_scan_direction scan;
196 struct dc_dcc_setting {
197 unsigned int max_compressed_blk_size;
198 unsigned int max_uncompressed_blk_size;
199 bool independent_64b_blks;
200 #if defined(CONFIG_DRM_AMD_DC_DCN)
201 //These bitfields to be used starting with DCN 3.0
203 uint32_t dcc_256_64_64 : 1;//available in ASICs before DCN 3.0 (the worst compression case)
204 uint32_t dcc_128_128_uncontrained : 1; //available in ASICs before DCN 3.0
205 uint32_t dcc_256_128_128 : 1; //available starting with DCN 3.0
206 uint32_t dcc_256_256_unconstrained : 1; //available in ASICs before DCN 3.0 (the best compression case)
211 struct dc_surface_dcc_cap {
214 struct dc_dcc_setting rgb;
218 struct dc_dcc_setting luma;
219 struct dc_dcc_setting chroma;
224 bool const_color_support;
227 struct dc_static_screen_params {
234 unsigned int num_frames;
238 /* Surface update type is used by dc_update_surfaces_and_stream
239 * The update type is determined at the very beginning of the function based
240 * on parameters passed in and decides how much programming (or updating) is
241 * going to be done during the call.
243 * UPDATE_TYPE_FAST is used for really fast updates that do not require much
244 * logical calculations or hardware register programming. This update MUST be
245 * ISR safe on windows. Currently fast update will only be used to flip surface
248 * UPDATE_TYPE_MED is used for slower updates which require significant hw
249 * re-programming however do not affect bandwidth consumption or clock
250 * requirements. At present, this is the level at which front end updates
251 * that do not require us to run bw_calcs happen. These are in/out transfer func
252 * updates, viewport offset changes, recout size changes and pixel depth changes.
253 * This update can be done at ISR, but we want to minimize how often this happens.
255 * UPDATE_TYPE_FULL is slow. Really slow. This requires us to recalculate our
256 * bandwidth and clocks, possibly rearrange some pipes and reprogram anything front
257 * end related. Any time viewport dimensions, recout dimensions, scaling ratios or
258 * gamma need to be adjusted or pipe needs to be turned on (or disconnected) we do
259 * a full update. This cannot be done at ISR level and should be a rare event.
260 * Unless someone is stress testing mpo enter/exit, playing with colour or adjusting
261 * underscan we don't expect to see this call at all.
264 enum surface_update_type {
265 UPDATE_TYPE_FAST, /* super fast, safe to execute in isr */
266 UPDATE_TYPE_MED, /* ISR safe, most of programming needed, no bw/clk change*/
267 UPDATE_TYPE_FULL, /* may need to shuffle resources */
270 /* Forward declaration*/
272 struct dc_plane_state;
276 struct dc_cap_funcs {
277 bool (*get_dcc_compression_cap)(const struct dc *dc,
278 const struct dc_dcc_surface_param *input,
279 struct dc_surface_dcc_cap *output);
282 struct link_training_settings;
285 /* Structure to hold configuration flags set by dm at dc creation. */
288 bool disable_disp_pll_sharing;
290 bool optimize_edp_link_rate;
291 bool disable_fractional_pwm;
292 bool allow_seamless_boot_optimization;
293 bool power_down_display_on_boot;
294 bool edp_not_connected;
297 bool allow_lttpr_non_transparent_mode;
298 bool multi_mon_pp_mclk_switch;
301 #if defined(CONFIG_DRM_AMD_DC_DCN)
302 bool clamp_min_dcfclk;
306 enum visual_confirm {
307 VISUAL_CONFIRM_DISABLE = 0,
308 VISUAL_CONFIRM_SURFACE = 1,
309 VISUAL_CONFIRM_HDR = 2,
310 VISUAL_CONFIRM_MPCTREE = 4,
311 VISUAL_CONFIRM_PSR = 5,
317 DCC_HALF_REQ_DISALBE = 2,
320 enum pipe_split_policy {
321 MPC_SPLIT_DYNAMIC = 0,
323 MPC_SPLIT_AVOID_MULT_DISP = 2,
326 enum wm_report_mode {
327 WM_REPORT_DEFAULT = 0,
328 WM_REPORT_OVERRIDE = 1,
331 dtm_level_p0 = 0,/*highest voltage*/
335 dtm_level_p4,/*when active_display_count = 0*/
339 DCN_PWR_STATE_UNKNOWN = -1,
340 DCN_PWR_STATE_MISSION_MODE = 0,
341 DCN_PWR_STATE_LOW_POWER = 3,
345 * For any clocks that may differ per pipe
346 * only the max is stored in this structure
350 int actual_dispclk_khz;
352 int actual_dppclk_khz;
353 int disp_dpp_voltage_level_khz;
356 int dcfclk_deep_sleep_khz;
360 bool p_state_change_support;
361 enum dcn_pwr_state pwr_state;
363 * Elements below are not compared for the purposes of
364 * optimization required
366 bool prev_p_state_change_support;
367 enum dtm_pstate dtm_level;
368 int max_supported_dppclk_khz;
369 int max_supported_dispclk_khz;
370 int bw_dppclk_khz; /*a copy of dppclk_khz*/
374 struct dc_bw_validation_profile {
377 unsigned long long total_ticks;
378 unsigned long long voltage_level_ticks;
379 unsigned long long watermark_ticks;
380 unsigned long long rq_dlg_ticks;
382 unsigned long long total_count;
383 unsigned long long skip_fast_count;
384 unsigned long long skip_pass_count;
385 unsigned long long skip_fail_count;
388 #define BW_VAL_TRACE_SETUP() \
389 unsigned long long end_tick = 0; \
390 unsigned long long voltage_level_tick = 0; \
391 unsigned long long watermark_tick = 0; \
392 unsigned long long start_tick = dc->debug.bw_val_profile.enable ? \
393 dm_get_timestamp(dc->ctx) : 0
395 #define BW_VAL_TRACE_COUNT() \
396 if (dc->debug.bw_val_profile.enable) \
397 dc->debug.bw_val_profile.total_count++
399 #define BW_VAL_TRACE_SKIP(status) \
400 if (dc->debug.bw_val_profile.enable) { \
401 if (!voltage_level_tick) \
402 voltage_level_tick = dm_get_timestamp(dc->ctx); \
403 dc->debug.bw_val_profile.skip_ ## status ## _count++; \
406 #define BW_VAL_TRACE_END_VOLTAGE_LEVEL() \
407 if (dc->debug.bw_val_profile.enable) \
408 voltage_level_tick = dm_get_timestamp(dc->ctx)
410 #define BW_VAL_TRACE_END_WATERMARKS() \
411 if (dc->debug.bw_val_profile.enable) \
412 watermark_tick = dm_get_timestamp(dc->ctx)
414 #define BW_VAL_TRACE_FINISH() \
415 if (dc->debug.bw_val_profile.enable) { \
416 end_tick = dm_get_timestamp(dc->ctx); \
417 dc->debug.bw_val_profile.total_ticks += end_tick - start_tick; \
418 dc->debug.bw_val_profile.voltage_level_ticks += voltage_level_tick - start_tick; \
419 if (watermark_tick) { \
420 dc->debug.bw_val_profile.watermark_ticks += watermark_tick - voltage_level_tick; \
421 dc->debug.bw_val_profile.rq_dlg_ticks += end_tick - watermark_tick; \
425 union mem_low_power_enable_options {
437 struct dc_debug_options {
438 enum visual_confirm visual_confirm;
444 bool validation_trace;
445 bool bandwidth_calcs_trace;
446 int max_downscale_src_width;
448 /* stutter efficiency related */
449 bool disable_stutter;
451 enum dcc_option disable_dcc;
452 enum pipe_split_policy pipe_split_policy;
453 bool force_single_disp_pipe_split;
454 bool voltage_align_fclk;
456 bool disable_dfs_bypass;
457 bool disable_dpp_power_gate;
458 bool disable_hubp_power_gate;
459 bool disable_dsc_power_gate;
460 int dsc_min_slice_height_override;
461 int dsc_bpp_increment_div;
462 bool native422_support;
463 bool disable_pplib_wm_range;
464 enum wm_report_mode pplib_wm_report_mode;
465 unsigned int min_disp_clk_khz;
466 unsigned int min_dpp_clk_khz;
467 int sr_exit_time_dpm0_ns;
468 int sr_enter_plus_exit_time_dpm0_ns;
470 int sr_enter_plus_exit_time_ns;
471 int urgent_latency_ns;
472 uint32_t underflow_assert_delay_us;
473 int percent_of_ideal_drambw;
474 int dram_clock_change_latency_ns;
475 bool optimized_watermark;
477 bool disable_pplib_clock_request;
478 bool disable_clock_gate;
479 bool disable_mem_low_power;
482 bool force_abm_enable;
483 bool disable_stereo_support;
485 bool performance_trace;
486 bool az_endpoint_mute_only;
487 bool always_use_regamma;
488 bool recovery_enabled;
489 bool avoid_vbios_exec_table;
490 bool scl_reset_length10;
492 bool skip_detection_link_training;
493 uint32_t edid_read_retry_times;
494 bool remove_disconnect_edp;
495 unsigned int force_odm_combine; //bit vector based on otg inst
496 #if defined(CONFIG_DRM_AMD_DC_DCN)
497 unsigned int force_odm_combine_4to1; //bit vector based on otg inst
499 unsigned int force_fclk_khz;
501 bool dmub_offload_enabled;
502 bool dmcub_emulation;
503 #if defined(CONFIG_DRM_AMD_DC_DCN)
504 bool disable_idle_power_optimizations;
505 unsigned int mall_size_override;
506 unsigned int mall_additional_timer_percent;
507 bool mall_error_as_fatal;
509 bool dmub_command_table; /* for testing only */
510 struct dc_bw_validation_profile bw_val_profile;
512 bool disable_48mhz_pwrdwn;
513 /* This forces a hard min on the DCFCLK requested to SMU/PP
514 * watermarks are not affected.
516 unsigned int force_min_dcfclk_mhz;
517 #if defined(CONFIG_DRM_AMD_DC_DCN)
520 bool disable_timing_sync;
522 int force_clock_mode;/*every mode change.*/
524 bool disable_dram_clock_change_vactive_support;
525 bool validate_dml_output;
526 bool enable_dmcub_surface_flip;
527 bool usbc_combo_phy_reset_wa;
529 bool enable_dram_clock_change_one_display_vactive;
530 union mem_low_power_enable_options enable_mem_low_power;
533 struct dc_debug_data {
534 uint32_t ltFailCount;
535 uint32_t i2cErrorCount;
536 uint32_t auxErrorCount;
539 struct dc_phy_addr_space_config {
552 uint64_t page_table_start_addr;
553 uint64_t page_table_end_addr;
554 uint64_t page_table_base_addr;
559 uint64_t page_table_default_page_addr;
562 struct dc_virtual_addr_space_config {
563 uint64_t page_table_base_addr;
564 uint64_t page_table_start_addr;
565 uint64_t page_table_end_addr;
566 uint32_t page_table_block_size_in_bytes;
567 uint8_t page_table_depth; // 1 = 1 level, 2 = 2 level, etc. 0 = invalid
570 struct dc_bounding_box_overrides {
572 int sr_enter_plus_exit_time_ns;
573 int urgent_latency_ns;
574 int percent_of_ideal_drambw;
575 int dram_clock_change_latency_ns;
576 int dummy_clock_change_latency_ns;
577 /* This forces a hard min on the DCFCLK we use
578 * for DML. Unlike the debug option for forcing
579 * DCFCLK, this override affects watermark calculations
585 struct resource_pool;
587 struct gpu_info_soc_bounding_box_v1_0;
589 struct dc_versions versions;
591 struct dc_cap_funcs cap_funcs;
592 struct dc_config config;
593 struct dc_debug_options debug;
594 struct dc_bounding_box_overrides bb_overrides;
595 struct dc_bug_wa work_arounds;
596 struct dc_context *ctx;
597 struct dc_phy_addr_space_config vm_pa_config;
600 struct dc_link *links[MAX_PIPES * 2];
602 struct dc_state *current_state;
603 struct resource_pool *res_pool;
605 struct clk_mgr *clk_mgr;
607 /* Display Engine Clock levels */
608 struct dm_pp_clock_levels sclk_lvls;
610 /* Inputs into BW and WM calculations. */
611 struct bw_calcs_dceip *bw_dceip;
612 struct bw_calcs_vbios *bw_vbios;
613 #ifdef CONFIG_DRM_AMD_DC_DCN
614 struct dcn_soc_bounding_box *dcn_soc;
615 struct dcn_ip_params *dcn_ip;
616 struct display_mode_lib dml;
620 struct hw_sequencer_funcs hwss;
621 struct dce_hwseq *hwseq;
623 /* Require to optimize clocks and bandwidth for added/removed planes */
624 bool optimized_required;
625 bool wm_optimized_required;
626 #if defined(CONFIG_DRM_AMD_DC_DCN)
627 bool idle_optimizations_allowed;
630 /* Require to maintain clocks and bandwidth for UEFI enabled HW */
631 int optimize_seamless_boot_streams;
634 struct compressor *fbc_compressor;
636 struct dc_debug_data debug_data;
637 struct dpcd_vendor_signature vendor_signature;
639 const char *build_id;
640 struct vm_helper *vm_helper;
643 enum frame_buffer_mode {
644 FRAME_BUFFER_MODE_LOCAL_ONLY = 0,
645 FRAME_BUFFER_MODE_ZFB_ONLY,
646 FRAME_BUFFER_MODE_MIXED_ZFB_AND_LOCAL,
649 struct dchub_init_data {
650 int64_t zfb_phys_addr_base;
651 int64_t zfb_mc_base_addr;
652 uint64_t zfb_size_in_byte;
653 enum frame_buffer_mode fb_mode;
654 bool dchub_initialzied;
655 bool dchub_info_valid;
658 struct dc_init_data {
659 struct hw_asic_id asic_id;
660 void *driver; /* ctx */
661 struct cgs_device *cgs_device;
662 struct dc_bounding_box_overrides bb_overrides;
664 int num_virtual_links;
666 * If 'vbios_override' not NULL, it will be called instead
667 * of the real VBIOS. Intended use is Diagnostics on FPGA.
669 struct dc_bios *vbios_override;
670 enum dce_environment dce_environment;
672 struct dmub_offload_funcs *dmub_if;
673 struct dc_reg_helper_state *dmub_offload;
675 struct dc_config flags;
678 struct dpcd_vendor_signature vendor_signature;
679 #if defined(CONFIG_DRM_AMD_DC_DCN)
680 bool force_smu_not_present;
684 struct dc_callback_init {
685 #ifdef CONFIG_DRM_AMD_DC_HDCP
686 struct cp_psp cp_psp;
692 struct dc *dc_create(const struct dc_init_data *init_params);
693 void dc_hardware_init(struct dc *dc);
695 int dc_get_vmid_use_vector(struct dc *dc);
696 void dc_setup_vm_context(struct dc *dc, struct dc_virtual_addr_space_config *va_config, int vmid);
697 /* Returns the number of vmids supported */
698 int dc_setup_system_context(struct dc *dc, struct dc_phy_addr_space_config *pa_config);
699 void dc_init_callbacks(struct dc *dc,
700 const struct dc_callback_init *init_params);
701 void dc_deinit_callbacks(struct dc *dc);
702 void dc_destroy(struct dc **dc);
704 /*******************************************************************************
706 ******************************************************************************/
709 TRANSFER_FUNC_POINTS = 1025
712 struct dc_hdr_static_metadata {
713 /* display chromaticities and white point in units of 0.00001 */
714 unsigned int chromaticity_green_x;
715 unsigned int chromaticity_green_y;
716 unsigned int chromaticity_blue_x;
717 unsigned int chromaticity_blue_y;
718 unsigned int chromaticity_red_x;
719 unsigned int chromaticity_red_y;
720 unsigned int chromaticity_white_point_x;
721 unsigned int chromaticity_white_point_y;
723 uint32_t min_luminance;
724 uint32_t max_luminance;
725 uint32_t maximum_content_light_level;
726 uint32_t maximum_frame_average_light_level;
729 enum dc_transfer_func_type {
731 TF_TYPE_DISTRIBUTED_POINTS,
736 struct dc_transfer_func_distributed_points {
737 struct fixed31_32 red[TRANSFER_FUNC_POINTS];
738 struct fixed31_32 green[TRANSFER_FUNC_POINTS];
739 struct fixed31_32 blue[TRANSFER_FUNC_POINTS];
741 uint16_t end_exponent;
742 uint16_t x_point_at_y1_red;
743 uint16_t x_point_at_y1_green;
744 uint16_t x_point_at_y1_blue;
747 enum dc_transfer_func_predefined {
748 TRANSFER_FUNCTION_SRGB,
749 TRANSFER_FUNCTION_BT709,
750 TRANSFER_FUNCTION_PQ,
751 TRANSFER_FUNCTION_LINEAR,
752 TRANSFER_FUNCTION_UNITY,
753 TRANSFER_FUNCTION_HLG,
754 TRANSFER_FUNCTION_HLG12,
755 TRANSFER_FUNCTION_GAMMA22,
756 TRANSFER_FUNCTION_GAMMA24,
757 TRANSFER_FUNCTION_GAMMA26
761 struct dc_transfer_func {
762 struct kref refcount;
763 enum dc_transfer_func_type type;
764 enum dc_transfer_func_predefined tf;
765 /* FP16 1.0 reference level in nits, default is 80 nits, only for PQ*/
766 uint32_t sdr_ref_white_level;
768 struct pwl_params pwl;
769 struct dc_transfer_func_distributed_points tf_pts;
774 union dc_3dlut_state {
776 uint32_t initialized:1; /*if 3dlut is went through color module for initialization */
777 uint32_t rmu_idx_valid:1; /*if mux settings are valid*/
778 uint32_t rmu_mux_num:3; /*index of mux to use*/
779 uint32_t mpc_rmu0_mux:4; /*select mpcc on mux, one of the following : mpcc0, mpcc1, mpcc2, mpcc3*/
780 uint32_t mpc_rmu1_mux:4;
781 uint32_t mpc_rmu2_mux:4;
782 uint32_t reserved:15;
789 struct kref refcount;
790 struct tetrahedral_params lut_3d;
791 struct fixed31_32 hdr_multiplier;
792 union dc_3dlut_state state;
795 * This structure is filled in by dc_surface_get_status and contains
796 * the last requested address and the currently active address so the called
797 * can determine if there are any outstanding flips
799 struct dc_plane_status {
800 struct dc_plane_address requested_address;
801 struct dc_plane_address current_address;
802 bool is_flip_pending;
806 union surface_update_flags {
809 uint32_t addr_update:1;
811 uint32_t dcc_change:1;
812 uint32_t color_space_change:1;
813 uint32_t horizontal_mirror_change:1;
814 uint32_t per_pixel_alpha_change:1;
815 uint32_t global_alpha_change:1;
817 uint32_t rotation_change:1;
818 uint32_t swizzle_change:1;
819 uint32_t scaling_change:1;
820 uint32_t position_change:1;
821 uint32_t in_transfer_func_change:1;
822 uint32_t input_csc_change:1;
823 uint32_t coeff_reduction_change:1;
824 uint32_t output_tf_change:1;
825 uint32_t pixel_format_change:1;
826 uint32_t plane_size_change:1;
827 uint32_t gamut_remap_change:1;
830 uint32_t new_plane:1;
831 uint32_t bpp_change:1;
832 uint32_t gamma_change:1;
833 uint32_t bandwidth_change:1;
834 uint32_t clock_change:1;
835 uint32_t stereo_format_change:1;
836 uint32_t full_update:1;
842 struct dc_plane_state {
843 struct dc_plane_address address;
844 struct dc_plane_flip_time time;
845 bool triplebuffer_flips;
846 struct scaling_taps scaling_quality;
847 struct rect src_rect;
848 struct rect dst_rect;
849 struct rect clip_rect;
851 struct plane_size plane_size;
852 union dc_tiling_info tiling_info;
854 struct dc_plane_dcc_param dcc;
856 struct dc_gamma *gamma_correction;
857 struct dc_transfer_func *in_transfer_func;
858 struct dc_bias_and_scale *bias_and_scale;
859 struct dc_csc_transform input_csc_color_matrix;
860 struct fixed31_32 coeff_reduction_factor;
861 struct fixed31_32 hdr_mult;
862 struct colorspace_transform gamut_remap_matrix;
864 // TODO: No longer used, remove
865 struct dc_hdr_static_metadata hdr_static_ctx;
867 enum dc_color_space color_space;
869 struct dc_3dlut *lut3d_func;
870 struct dc_transfer_func *in_shaper_func;
871 struct dc_transfer_func *blend_tf;
873 #if defined(CONFIG_DRM_AMD_DC_DCN)
874 struct dc_transfer_func *gamcor_tf;
876 enum surface_pixel_format format;
877 enum dc_rotation_angle rotation;
878 enum plane_stereo_format stereo_format;
880 bool is_tiling_rotated;
881 bool per_pixel_alpha;
883 int global_alpha_value;
886 bool horizontal_mirror;
889 union surface_update_flags update_flags;
890 /* private to DC core */
891 struct dc_plane_status status;
892 struct dc_context *ctx;
894 /* HACK: Workaround for forcing full reprogramming under some conditions */
895 bool force_full_update;
897 /* private to dc_surface.c */
898 enum dc_irq_source irq_source;
899 struct kref refcount;
902 struct dc_plane_info {
903 struct plane_size plane_size;
904 union dc_tiling_info tiling_info;
905 struct dc_plane_dcc_param dcc;
906 enum surface_pixel_format format;
907 enum dc_rotation_angle rotation;
908 enum plane_stereo_format stereo_format;
909 enum dc_color_space color_space;
910 bool horizontal_mirror;
912 bool per_pixel_alpha;
914 int global_alpha_value;
915 bool input_csc_enabled;
919 struct dc_scaling_info {
920 struct rect src_rect;
921 struct rect dst_rect;
922 struct rect clip_rect;
923 struct scaling_taps scaling_quality;
926 struct dc_surface_update {
927 struct dc_plane_state *surface;
929 /* isr safe update parameters. null means no updates */
930 const struct dc_flip_addrs *flip_addr;
931 const struct dc_plane_info *plane_info;
932 const struct dc_scaling_info *scaling_info;
933 struct fixed31_32 hdr_mult;
934 /* following updates require alloc/sleep/spin that is not isr safe,
935 * null means no updates
937 const struct dc_gamma *gamma;
938 const struct dc_transfer_func *in_transfer_func;
940 const struct dc_csc_transform *input_csc_color_matrix;
941 const struct fixed31_32 *coeff_reduction_factor;
942 const struct dc_transfer_func *func_shaper;
943 const struct dc_3dlut *lut3d_func;
944 const struct dc_transfer_func *blend_tf;
945 const struct colorspace_transform *gamut_remap_matrix;
949 * Create a new surface with default parameters;
951 struct dc_plane_state *dc_create_plane_state(struct dc *dc);
952 const struct dc_plane_status *dc_plane_get_status(
953 const struct dc_plane_state *plane_state);
955 void dc_plane_state_retain(struct dc_plane_state *plane_state);
956 void dc_plane_state_release(struct dc_plane_state *plane_state);
958 void dc_gamma_retain(struct dc_gamma *dc_gamma);
959 void dc_gamma_release(struct dc_gamma **dc_gamma);
960 struct dc_gamma *dc_create_gamma(void);
962 void dc_transfer_func_retain(struct dc_transfer_func *dc_tf);
963 void dc_transfer_func_release(struct dc_transfer_func *dc_tf);
964 struct dc_transfer_func *dc_create_transfer_func(void);
966 struct dc_3dlut *dc_create_3dlut_func(void);
967 void dc_3dlut_func_release(struct dc_3dlut *lut);
968 void dc_3dlut_func_retain(struct dc_3dlut *lut);
970 * This structure holds a surface address. There could be multiple addresses
971 * in cases such as Stereo 3D, Planar YUV, etc. Other per-flip attributes such
972 * as frame durations and DCC format can also be set.
974 struct dc_flip_addrs {
975 struct dc_plane_address address;
976 unsigned int flip_timestamp_in_us;
978 /* TODO: add flip duration for FreeSync */
979 bool triplebuffer_flips;
982 void dc_post_update_surfaces_to_stream(
985 #include "dc_stream.h"
988 * Structure to store surface/stream associations for validation
990 struct dc_validation_set {
991 struct dc_stream_state *stream;
992 struct dc_plane_state *plane_states[MAX_SURFACES];
996 bool dc_validate_seamless_boot_timing(const struct dc *dc,
997 const struct dc_sink *sink,
998 struct dc_crtc_timing *crtc_timing);
1000 enum dc_status dc_validate_plane(struct dc *dc, const struct dc_plane_state *plane_state);
1002 void get_clock_requirements_for_state(struct dc_state *state, struct AsicStateEx *info);
1004 bool dc_set_generic_gpio_for_stereo(bool enable,
1005 struct gpio_service *gpio_service);
1008 * fast_validate: we return after determining if we can support the new state,
1009 * but before we populate the programming info
1011 enum dc_status dc_validate_global_state(
1013 struct dc_state *new_ctx,
1014 bool fast_validate);
1017 void dc_resource_state_construct(
1018 const struct dc *dc,
1019 struct dc_state *dst_ctx);
1021 #if defined(CONFIG_DRM_AMD_DC_DCN)
1022 bool dc_acquire_release_mpc_3dlut(
1023 struct dc *dc, bool acquire,
1024 struct dc_stream_state *stream,
1025 struct dc_3dlut **lut,
1026 struct dc_transfer_func **shaper);
1029 void dc_resource_state_copy_construct(
1030 const struct dc_state *src_ctx,
1031 struct dc_state *dst_ctx);
1033 void dc_resource_state_copy_construct_current(
1034 const struct dc *dc,
1035 struct dc_state *dst_ctx);
1037 void dc_resource_state_destruct(struct dc_state *context);
1039 bool dc_resource_is_dsc_encoding_supported(const struct dc *dc);
1042 * TODO update to make it about validation sets
1043 * Set up streams and links associated to drive sinks
1044 * The streams parameter is an absolute set of all active streams.
1047 * Phy, Encoder, Timing Generator are programmed and enabled.
1048 * New streams are enabled with blank stream; no memory read.
1050 bool dc_commit_state(struct dc *dc, struct dc_state *context);
1052 void dc_power_down_on_boot(struct dc *dc);
1054 struct dc_state *dc_create_state(struct dc *dc);
1055 struct dc_state *dc_copy_state(struct dc_state *src_ctx);
1056 void dc_retain_state(struct dc_state *context);
1057 void dc_release_state(struct dc_state *context);
1059 /*******************************************************************************
1061 ******************************************************************************/
1064 union dpcd_rev dpcd_rev;
1065 union max_lane_count max_ln_count;
1066 union max_down_spread max_down_spread;
1067 union dprx_feature dprx_feature;
1069 /* valid only for eDP v1.4 or higher*/
1070 uint8_t edp_supported_link_rates_count;
1071 enum dc_link_rate edp_supported_link_rates[8];
1073 /* dongle type (DP converter, CV smart dongle) */
1074 enum display_dongle_type dongle_type;
1075 /* branch device or sink device */
1077 /* Dongle's downstream count. */
1078 union sink_count sink_count;
1079 /* If dongle_type == DISPLAY_DONGLE_DP_HDMI_CONVERTER,
1080 indicates 'Frame Sequential-to-lllFrame Pack' conversion capability.*/
1081 struct dc_dongle_caps dongle_caps;
1083 uint32_t sink_dev_id;
1084 int8_t sink_dev_id_str[6];
1085 int8_t sink_hw_revision;
1086 int8_t sink_fw_revision[2];
1088 uint32_t branch_dev_id;
1089 int8_t branch_dev_name[6];
1090 int8_t branch_hw_revision;
1091 int8_t branch_fw_revision[2];
1093 bool allow_invalid_MSA_timing_param;
1094 bool panel_mode_edp;
1095 bool dpcd_display_control_capable;
1096 bool ext_receiver_cap_field_present;
1097 bool dynamic_backlight_capable_edp;
1098 union dpcd_fec_capability fec_cap;
1099 struct dpcd_dsc_capabilities dsc_caps;
1100 struct dc_lttpr_caps lttpr_caps;
1101 struct psr_caps psr_caps;
1105 union dpcd_sink_ext_caps {
1107 /* 0 - Sink supports backlight adjust via PWM during SDR/HDR mode
1108 * 1 - Sink supports backlight adjust via AUX during SDR/HDR mode.
1110 uint8_t sdr_aux_backlight_control : 1;
1111 uint8_t hdr_aux_backlight_control : 1;
1112 uint8_t reserved_1 : 2;
1114 uint8_t reserved : 3;
1119 #if defined(CONFIG_DRM_AMD_DC_HDCP)
1120 union hdcp_rx_caps {
1125 uint8_t repeater : 1;
1126 uint8_t hdcp_capable : 1;
1127 uint8_t reserved : 6;
1135 uint8_t HDCP_CAPABLE:1;
1143 union hdcp_rx_caps rx_caps;
1144 union hdcp_bcaps bcaps;
1148 #include "dc_link.h"
1150 #if defined(CONFIG_DRM_AMD_DC_DCN)
1151 uint32_t dc_get_opp_for_plane(struct dc *dc, struct dc_plane_state *plane);
1154 /*******************************************************************************
1155 * Sink Interfaces - A sink corresponds to a display output device
1156 ******************************************************************************/
1158 struct dc_container_id {
1159 // 128bit GUID in binary form
1160 unsigned char guid[16];
1161 // 8 byte port ID -> ELD.PortID
1162 unsigned int portId[2];
1163 // 128bit GUID in binary formufacturer name -> ELD.ManufacturerName
1164 unsigned short manufacturerName;
1165 // 2 byte product code -> ELD.ProductCode
1166 unsigned short productCode;
1170 struct dc_sink_dsc_caps {
1171 // 'true' if these are virtual DPCD's DSC caps (immediately upstream of sink in MST topology),
1172 // 'false' if they are sink's DSC caps
1173 bool is_virtual_dpcd_dsc;
1174 struct dsc_dec_dpcd_caps dsc_dec_caps;
1177 struct dc_sink_fec_caps {
1178 bool is_rx_fec_supported;
1179 bool is_topology_fec_supported;
1183 * The sink structure contains EDID and other display device properties
1186 enum signal_type sink_signal;
1187 struct dc_edid dc_edid; /* raw edid */
1188 struct dc_edid_caps edid_caps; /* parse display caps */
1189 struct dc_container_id *dc_container_id;
1190 uint32_t dongle_max_pix_clk;
1192 struct stereo_3d_features features_3d[TIMING_3D_FORMAT_MAX];
1193 bool converter_disable_audio;
1195 struct dc_sink_dsc_caps dsc_caps;
1196 struct dc_sink_fec_caps fec_caps;
1198 bool is_vsc_sdp_colorimetry_supported;
1200 /* private to DC core */
1201 struct dc_link *link;
1202 struct dc_context *ctx;
1206 /* private to dc_sink.c */
1207 // refcount must be the last member in dc_sink, since we want the
1208 // sink structure to be logically cloneable up to (but not including)
1210 struct kref refcount;
1213 void dc_sink_retain(struct dc_sink *sink);
1214 void dc_sink_release(struct dc_sink *sink);
1216 struct dc_sink_init_data {
1217 enum signal_type sink_signal;
1218 struct dc_link *link;
1219 uint32_t dongle_max_pix_clk;
1220 bool converter_disable_audio;
1223 struct dc_sink *dc_sink_create(const struct dc_sink_init_data *init_params);
1225 /* Newer interfaces */
1227 struct dc_plane_address address;
1228 struct dc_cursor_attributes attributes;
1232 /*******************************************************************************
1233 * Interrupt interfaces
1234 ******************************************************************************/
1235 enum dc_irq_source dc_interrupt_to_irq_source(
1239 bool dc_interrupt_set(struct dc *dc, enum dc_irq_source src, bool enable);
1240 void dc_interrupt_ack(struct dc *dc, enum dc_irq_source src);
1241 enum dc_irq_source dc_get_hpd_irq_source_at_index(
1242 struct dc *dc, uint32_t link_index);
1244 /*******************************************************************************
1246 ******************************************************************************/
1248 void dc_set_power_state(
1250 enum dc_acpi_cm_power_state power_state);
1251 void dc_resume(struct dc *dc);
1253 void dc_power_down_on_boot(struct dc *dc);
1255 #if defined(CONFIG_DRM_AMD_DC_HDCP)
1259 enum hdcp_message_status dc_process_hdcp_msg(
1260 enum signal_type signal,
1261 struct dc_link *link,
1262 struct hdcp_protection_message *message_info);
1264 bool dc_is_dmcu_initialized(struct dc *dc);
1266 enum dc_status dc_set_clock(struct dc *dc, enum dc_clock_type clock_type, uint32_t clk_khz, uint32_t stepping);
1267 void dc_get_clock(struct dc *dc, enum dc_clock_type clock_type, struct dc_clock_config *clock_cfg);
1268 #if defined(CONFIG_DRM_AMD_DC_DCN)
1270 bool dc_is_plane_eligible_for_idle_optimizations(struct dc *dc, struct dc_plane_state *plane,
1271 struct dc_cursor_attributes *cursor_attr);
1273 void dc_allow_idle_optimizations(struct dc *dc, bool allow);
1276 * blank all streams, and set min and max memory clock to
1277 * lowest and highest DPM level, respectively
1279 void dc_unlock_memory_clock_frequency(struct dc *dc);
1282 * set min memory clock to the min required for current mode,
1283 * max to maxDPM, and unblank streams
1285 void dc_lock_memory_clock_frequency(struct dc *dc);
1287 /* cleanup on driver unload */
1288 void dc_hardware_release(struct dc *dc);
1292 bool dc_set_psr_allow_active(struct dc *dc, bool enable);
1294 /*******************************************************************************
1296 ******************************************************************************/
1298 #endif /* DC_INTERFACE_H_ */