drivers/gpu/drm/amd/display/dc/dc.h

   1 /*
   2  * Copyright 2012-2023 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 "dc_state.h"
  31 #include "dc_plane.h"
  32 #include "grph_object_defs.h"
  33 #include "logger_types.h"
  34 #include "hdcp_msg_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>
  39
  40 #include "hwss/hw_sequencer.h"
  41 #include "inc/compressor.h"
  42 #include "inc/hw/dmcu.h"
  43 #include "dml/display_mode_lib.h"
  44
  45 #include "dml2/dml2_wrapper.h"
  46
  47 #include "dmub/inc/dmub_cmd.h"
  48
  49 #include "spl/dc_spl_types.h"
  50
  51 struct abm_save_restore;
  52
  53 /* forward declaration */
  54 struct aux_payload;
  55 struct set_config_cmd_payload;
  56 struct dmub_notification;
  57
  58 #define DC_VER "3.2.309"
  59
  60 #define MAX_SURFACES 3
  61 #define MAX_PLANES 6
  62 #define MAX_STREAMS 6
  63 #define MIN_VIEWPORT_SIZE 12
  64 #define MAX_NUM_EDP 2
  65 #define MAX_HOST_ROUTERS_NUM 2
  66
  67 /* Display Core Interfaces */
  68 struct dc_versions {
  69         const char *dc_ver;
  70         struct dmcu_version dmcu_version;
  71 };
  72
  73 enum dp_protocol_version {
  74         DP_VERSION_1_4 = 0,
  75         DP_VERSION_2_1,
  76         DP_VERSION_UNKNOWN,
  77 };
  78
  79 enum dc_plane_type {
  80         DC_PLANE_TYPE_INVALID,
  81         DC_PLANE_TYPE_DCE_RGB,
  82         DC_PLANE_TYPE_DCE_UNDERLAY,
  83         DC_PLANE_TYPE_DCN_UNIVERSAL,
  84 };
  85
  86 // Sizes defined as multiples of 64KB
  87 enum det_size {
  88         DET_SIZE_DEFAULT = 0,
  89         DET_SIZE_192KB = 3,
  90         DET_SIZE_256KB = 4,
  91         DET_SIZE_320KB = 5,
  92         DET_SIZE_384KB = 6
  93 };
  94
  95
  96 struct dc_plane_cap {
  97         enum dc_plane_type type;
  98         uint32_t per_pixel_alpha : 1;
  99         struct {
 100                 uint32_t argb8888 : 1;
 101                 uint32_t nv12 : 1;
 102                 uint32_t fp16 : 1;
 103                 uint32_t p010 : 1;
 104                 uint32_t ayuv : 1;
 105         } pixel_format_support;
 106         // max upscaling factor x1000
 107         // upscaling factors are always >= 1
 108         // for example, 1080p -> 8K is 4.0, or 4000 raw value
 109         struct {
 110                 uint32_t argb8888;
 111                 uint32_t nv12;
 112                 uint32_t fp16;
 113         } max_upscale_factor;
 114         // max downscale factor x1000
 115         // downscale factors are always <= 1
 116         // for example, 8K -> 1080p is 0.25, or 250 raw value
 117         struct {
 118                 uint32_t argb8888;
 119                 uint32_t nv12;
 120                 uint32_t fp16;
 121         } max_downscale_factor;
 122         // minimal width/height
 123         uint32_t min_width;
 124         uint32_t min_height;
 125 };
 126
 127 /**
 128  * DOC: color-management-caps
 129  *
 130  * **Color management caps (DPP and MPC)**
 131  *
 132  * Modules/color calculates various color operations which are translated to
 133  * abstracted HW. DCE 5-12 had almost no important changes, but starting with
 134  * DCN1, every new generation comes with fairly major differences in color
 135  * pipeline. Therefore, we abstract color pipe capabilities so modules/DM can
 136  * decide mapping to HW block based on logical capabilities.
 137  */
 138
 139 /**
 140  * struct rom_curve_caps - predefined transfer function caps for degamma and regamma
 141  * @srgb: RGB color space transfer func
 142  * @bt2020: BT.2020 transfer func
 143  * @gamma2_2: standard gamma
 144  * @pq: perceptual quantizer transfer function
 145  * @hlg: hybrid log–gamma transfer function
 146  */
 147 struct rom_curve_caps {
 148         uint16_t srgb : 1;
 149         uint16_t bt2020 : 1;
 150         uint16_t gamma2_2 : 1;
 151         uint16_t pq : 1;
 152         uint16_t hlg : 1;
 153 };
 154
 155 /**
 156  * struct dpp_color_caps - color pipeline capabilities for display pipe and
 157  * plane blocks
 158  *
 159  * @dcn_arch: all DCE generations treated the same
 160  * @input_lut_shared: shared with DGAM. Input LUT is different than most LUTs,
 161  * just plain 256-entry lookup
 162  * @icsc: input color space conversion
 163  * @dgam_ram: programmable degamma LUT
 164  * @post_csc: post color space conversion, before gamut remap
 165  * @gamma_corr: degamma correction
 166  * @hw_3d_lut: 3D LUT support. It implies a shaper LUT before. It may be shared
 167  * with MPC by setting mpc:shared_3d_lut flag
 168  * @ogam_ram: programmable out/blend gamma LUT
 169  * @ocsc: output color space conversion
 170  * @dgam_rom_for_yuv: pre-defined degamma LUT for YUV planes
 171  * @dgam_rom_caps: pre-definied curve caps for degamma 1D LUT
 172  * @ogam_rom_caps: pre-definied curve caps for regamma 1D LUT
 173  *
 174  * Note: hdr_mult and gamut remap (CTM) are always available in DPP (in that order)
 175  */
 176 struct dpp_color_caps {
 177         uint16_t dcn_arch : 1;
 178         uint16_t input_lut_shared : 1;
 179         uint16_t icsc : 1;
 180         uint16_t dgam_ram : 1;
 181         uint16_t post_csc : 1;
 182         uint16_t gamma_corr : 1;
 183         uint16_t hw_3d_lut : 1;
 184         uint16_t ogam_ram : 1;
 185         uint16_t ocsc : 1;
 186         uint16_t dgam_rom_for_yuv : 1;
 187         struct rom_curve_caps dgam_rom_caps;
 188         struct rom_curve_caps ogam_rom_caps;
 189 };
 190
 191 /**
 192  * struct mpc_color_caps - color pipeline capabilities for multiple pipe and
 193  * plane combined blocks
 194  *
 195  * @gamut_remap: color transformation matrix
 196  * @ogam_ram: programmable out gamma LUT
 197  * @ocsc: output color space conversion matrix
 198  * @num_3dluts: MPC 3D LUT; always assumes a preceding shaper LUT
 199  * @shared_3d_lut: shared 3D LUT flag. Can be either DPP or MPC, but single
 200  * instance
 201  * @ogam_rom_caps: pre-definied curve caps for regamma 1D LUT
 202  */
 203 struct mpc_color_caps {
 204         uint16_t gamut_remap : 1;
 205         uint16_t ogam_ram : 1;
 206         uint16_t ocsc : 1;
 207         uint16_t num_3dluts : 3;
 208         uint16_t shared_3d_lut:1;
 209         struct rom_curve_caps ogam_rom_caps;
 210 };
 211
 212 /**
 213  * struct dc_color_caps - color pipes capabilities for DPP and MPC hw blocks
 214  * @dpp: color pipes caps for DPP
 215  * @mpc: color pipes caps for MPC
 216  */
 217 struct dc_color_caps {
 218         struct dpp_color_caps dpp;
 219         struct mpc_color_caps mpc;
 220 };
 221
 222 struct dc_dmub_caps {
 223         bool psr;
 224         bool mclk_sw;
 225         bool subvp_psr;
 226         bool gecc_enable;
 227         uint8_t fams_ver;
 228         bool aux_backlight_support;
 229 };
 230
 231 struct dc_scl_caps {
 232         bool sharpener_support;
 233 };
 234
 235 struct dc_caps {
 236         uint32_t max_streams;
 237         uint32_t max_links;
 238         uint32_t max_audios;
 239         uint32_t max_slave_planes;
 240         uint32_t max_slave_yuv_planes;
 241         uint32_t max_slave_rgb_planes;
 242         uint32_t max_planes;
 243         uint32_t max_downscale_ratio;
 244         uint32_t i2c_speed_in_khz;
 245         uint32_t i2c_speed_in_khz_hdcp;
 246         uint32_t dmdata_alloc_size;
 247         unsigned int max_cursor_size;
 248         unsigned int max_video_width;
 249         /*
 250          * max video plane width that can be safely assumed to be always
 251          * supported by single DPP pipe.
 252          */
 253         unsigned int max_optimizable_video_width;
 254         unsigned int min_horizontal_blanking_period;
 255         int linear_pitch_alignment;
 256         bool dcc_const_color;
 257         bool dynamic_audio;
 258         bool is_apu;
 259         bool dual_link_dvi;
 260         bool post_blend_color_processing;
 261         bool force_dp_tps4_for_cp2520;
 262         bool disable_dp_clk_share;
 263         bool psp_setup_panel_mode;
 264         bool extended_aux_timeout_support;
 265         bool dmcub_support;
 266         bool zstate_support;
 267         bool ips_support;
 268         uint32_t num_of_internal_disp;
 269         enum dp_protocol_version max_dp_protocol_version;
 270         unsigned int mall_size_per_mem_channel;
 271         unsigned int mall_size_total;
 272         unsigned int cursor_cache_size;
 273         struct dc_plane_cap planes[MAX_PLANES];
 274         struct dc_color_caps color;
 275         struct dc_dmub_caps dmub_caps;
 276         bool dp_hpo;
 277         bool dp_hdmi21_pcon_support;
 278         bool edp_dsc_support;
 279         bool vbios_lttpr_aware;
 280         bool vbios_lttpr_enable;
 281         uint32_t max_otg_num;
 282         uint32_t max_cab_allocation_bytes;
 283         uint32_t cache_line_size;
 284         uint32_t cache_num_ways;
 285         uint16_t subvp_fw_processing_delay_us;
 286         uint8_t subvp_drr_max_vblank_margin_us;
 287         uint16_t subvp_prefetch_end_to_mall_start_us;
 288         uint8_t subvp_swath_height_margin_lines; // subvp start line must be aligned to 2 x swath height
 289         uint16_t subvp_pstate_allow_width_us;
 290         uint16_t subvp_vertical_int_margin_us;
 291         bool seamless_odm;
 292         uint32_t max_v_total;
 293         uint32_t max_disp_clock_khz_at_vmin;
 294         uint8_t subvp_drr_vblank_start_margin_us;
 295         bool cursor_not_scaled;
 296         bool dcmode_power_limits_present;
 297         bool sequential_ono;
 298         /* Conservative limit for DCC cases which require ODM4:1 to support*/
 299         uint32_t dcc_plane_width_limit;
 300         struct dc_scl_caps scl_caps;
 301 };
 302
 303 struct dc_bug_wa {
 304         bool no_connect_phy_config;
 305         bool dedcn20_305_wa;
 306         bool skip_clock_update;
 307         bool lt_early_cr_pattern;
 308         struct {
 309                 uint8_t uclk : 1;
 310                 uint8_t fclk : 1;
 311                 uint8_t dcfclk : 1;
 312                 uint8_t dcfclk_ds: 1;
 313         } clock_update_disable_mask;
 314         bool skip_psr_ips_crtc_disable;
 315 };
 316 struct dc_dcc_surface_param {
 317         struct dc_size surface_size;
 318         enum surface_pixel_format format;
 319         unsigned int plane0_pitch;
 320         struct dc_size plane1_size;
 321         unsigned int plane1_pitch;
 322         union {
 323                 enum swizzle_mode_values swizzle_mode;
 324                 enum swizzle_mode_addr3_values swizzle_mode_addr3;
 325         };
 326         enum dc_scan_direction scan;
 327 };
 328
 329 struct dc_dcc_setting {
 330         unsigned int max_compressed_blk_size;
 331         unsigned int max_uncompressed_blk_size;
 332         bool independent_64b_blks;
 333         //These bitfields to be used starting with DCN 3.0
 334         struct {
 335                 uint32_t dcc_256_64_64 : 1;//available in ASICs before DCN 3.0 (the worst compression case)
 336                 uint32_t dcc_128_128_uncontrained : 1;  //available in ASICs before DCN 3.0
 337                 uint32_t dcc_256_128_128 : 1;           //available starting with DCN 3.0
 338                 uint32_t dcc_256_256_unconstrained : 1;  //available in ASICs before DCN 3.0 (the best compression case)
 339                 uint32_t dcc_256_256 : 1;  //available in ASICs starting with DCN 4.0x (the best compression case)
 340                 uint32_t dcc_256_128 : 1;  //available in ASICs starting with DCN 4.0x
 341                 uint32_t dcc_256_64 : 1;   //available in ASICs starting with DCN 4.0x (the worst compression case)
 342         } dcc_controls;
 343 };
 344
 345 struct dc_surface_dcc_cap {
 346         union {
 347                 struct {
 348                         struct dc_dcc_setting rgb;
 349                 } grph;
 350
 351                 struct {
 352                         struct dc_dcc_setting luma;
 353                         struct dc_dcc_setting chroma;
 354                 } video;
 355         };
 356
 357         bool capable;
 358         bool const_color_support;
 359 };
 360
 361 struct dc_static_screen_params {
 362         struct {
 363                 bool force_trigger;
 364                 bool cursor_update;
 365                 bool surface_update;
 366                 bool overlay_update;
 367         } triggers;
 368         unsigned int num_frames;
 369 };
 370
 371
 372 /* Surface update type is used by dc_update_surfaces_and_stream
 373  * The update type is determined at the very beginning of the function based
 374  * on parameters passed in and decides how much programming (or updating) is
 375  * going to be done during the call.
 376  *
 377  * UPDATE_TYPE_FAST is used for really fast updates that do not require much
 378  * logical calculations or hardware register programming. This update MUST be
 379  * ISR safe on windows. Currently fast update will only be used to flip surface
 380  * address.
 381  *
 382  * UPDATE_TYPE_MED is used for slower updates which require significant hw
 383  * re-programming however do not affect bandwidth consumption or clock
 384  * requirements. At present, this is the level at which front end updates
 385  * that do not require us to run bw_calcs happen. These are in/out transfer func
 386  * updates, viewport offset changes, recout size changes and pixel depth changes.
 387  * This update can be done at ISR, but we want to minimize how often this happens.
 388  *
 389  * UPDATE_TYPE_FULL is slow. Really slow. This requires us to recalculate our
 390  * bandwidth and clocks, possibly rearrange some pipes and reprogram anything front
 391  * end related. Any time viewport dimensions, recout dimensions, scaling ratios or
 392  * gamma need to be adjusted or pipe needs to be turned on (or disconnected) we do
 393  * a full update. This cannot be done at ISR level and should be a rare event.
 394  * Unless someone is stress testing mpo enter/exit, playing with colour or adjusting
 395  * underscan we don't expect to see this call at all.
 396  */
 397
 398 enum surface_update_type {
 399         UPDATE_TYPE_FAST, /* super fast, safe to execute in isr */
 400         UPDATE_TYPE_MED,  /* ISR safe, most of programming needed, no bw/clk change*/
 401         UPDATE_TYPE_FULL, /* may need to shuffle resources */
 402 };
 403
 404 /* Forward declaration*/
 405 struct dc;
 406 struct dc_plane_state;
 407 struct dc_state;
 408
 409 struct dc_cap_funcs {
 410         bool (*get_dcc_compression_cap)(const struct dc *dc,
 411                         const struct dc_dcc_surface_param *input,
 412                         struct dc_surface_dcc_cap *output);
 413         bool (*get_subvp_en)(struct dc *dc, struct dc_state *context);
 414 };
 415
 416 struct link_training_settings;
 417
 418 union allow_lttpr_non_transparent_mode {
 419         struct {
 420                 bool DP1_4A : 1;
 421                 bool DP2_0 : 1;
 422         } bits;
 423         unsigned char raw;
 424 };
 425
 426 /* Structure to hold configuration flags set by dm at dc creation. */
 427 struct dc_config {
 428         bool gpu_vm_support;
 429         bool disable_disp_pll_sharing;
 430         bool fbc_support;
 431         bool disable_fractional_pwm;
 432         bool allow_seamless_boot_optimization;
 433         bool seamless_boot_edp_requested;
 434         bool edp_not_connected;
 435         bool edp_no_power_sequencing;
 436         bool force_enum_edp;
 437         bool forced_clocks;
 438         union allow_lttpr_non_transparent_mode allow_lttpr_non_transparent_mode;
 439         bool multi_mon_pp_mclk_switch;
 440         bool disable_dmcu;
 441         bool enable_4to1MPC;
 442         bool enable_windowed_mpo_odm;
 443         bool forceHBR2CP2520; // Used for switching between test patterns TPS4 and CP2520
 444         uint32_t allow_edp_hotplug_detection;
 445         bool clamp_min_dcfclk;
 446         uint64_t vblank_alignment_dto_params;
 447         uint8_t  vblank_alignment_max_frame_time_diff;
 448         bool is_asymmetric_memory;
 449         bool is_single_rank_dimm;
 450         bool is_vmin_only_asic;
 451         bool use_spl;
 452         bool prefer_easf;
 453         bool use_pipe_ctx_sync_logic;
 454         bool ignore_dpref_ss;
 455         bool enable_mipi_converter_optimization;
 456         bool use_default_clock_table;
 457         bool force_bios_enable_lttpr;
 458         uint8_t force_bios_fixed_vs;
 459         int sdpif_request_limit_words_per_umc;
 460         bool dc_mode_clk_limit_support;
 461         bool EnableMinDispClkODM;
 462         bool enable_auto_dpm_test_logs;
 463         unsigned int disable_ips;
 464         unsigned int disable_ips_in_vpb;
 465         bool usb4_bw_alloc_support;
 466         bool allow_0_dtb_clk;
 467         bool use_assr_psp_message;
 468         bool support_edp0_on_dp1;
 469         unsigned int enable_fpo_flicker_detection;
 470         bool disable_hbr_audio_dp2;
 471         bool consolidated_dpia_dp_lt;
 472         bool set_pipe_unlock_order;
 473 };
 474
 475 enum visual_confirm {
 476         VISUAL_CONFIRM_DISABLE = 0,
 477         VISUAL_CONFIRM_SURFACE = 1,
 478         VISUAL_CONFIRM_HDR = 2,
 479         VISUAL_CONFIRM_MPCTREE = 4,
 480         VISUAL_CONFIRM_PSR = 5,
 481         VISUAL_CONFIRM_SWAPCHAIN = 6,
 482         VISUAL_CONFIRM_FAMS = 7,
 483         VISUAL_CONFIRM_SWIZZLE = 9,
 484         VISUAL_CONFIRM_REPLAY = 12,
 485         VISUAL_CONFIRM_SUBVP = 14,
 486         VISUAL_CONFIRM_MCLK_SWITCH = 16,
 487         VISUAL_CONFIRM_FAMS2 = 19,
 488         VISUAL_CONFIRM_HW_CURSOR = 20,
 489 };
 490
 491 enum dc_psr_power_opts {
 492         psr_power_opt_invalid = 0x0,
 493         psr_power_opt_smu_opt_static_screen = 0x1,
 494         psr_power_opt_z10_static_screen = 0x10,
 495         psr_power_opt_ds_disable_allow = 0x100,
 496 };
 497
 498 enum dml_hostvm_override_opts {
 499         DML_HOSTVM_NO_OVERRIDE = 0x0,
 500         DML_HOSTVM_OVERRIDE_FALSE = 0x1,
 501         DML_HOSTVM_OVERRIDE_TRUE = 0x2,
 502 };
 503
 504 enum dc_replay_power_opts {
 505         replay_power_opt_invalid                = 0x0,
 506         replay_power_opt_smu_opt_static_screen  = 0x1,
 507         replay_power_opt_z10_static_screen      = 0x10,
 508 };
 509
 510 enum dcc_option {
 511         DCC_ENABLE = 0,
 512         DCC_DISABLE = 1,
 513         DCC_HALF_REQ_DISALBE = 2,
 514 };
 515
 516 enum in_game_fams_config {
 517         INGAME_FAMS_SINGLE_DISP_ENABLE, // enable in-game fams
 518         INGAME_FAMS_DISABLE, // disable in-game fams
 519         INGAME_FAMS_MULTI_DISP_ENABLE, //enable in-game fams for multi-display
 520         INGAME_FAMS_MULTI_DISP_CLAMPED_ONLY, //enable in-game fams for multi-display only for clamped RR strategies
 521 };
 522
 523 /**
 524  * enum pipe_split_policy - Pipe split strategy supported by DCN
 525  *
 526  * This enum is used to define the pipe split policy supported by DCN. By
 527  * default, DC favors MPC_SPLIT_DYNAMIC.
 528  */
 529 enum pipe_split_policy {
 530         /**
 531          * @MPC_SPLIT_DYNAMIC: DC will automatically decide how to split the
 532          * pipe in order to bring the best trade-off between performance and
 533          * power consumption. This is the recommended option.
 534          */
 535         MPC_SPLIT_DYNAMIC = 0,
 536
 537         /**
 538          * @MPC_SPLIT_AVOID: Avoid pipe split, which means that DC will not
 539          * try any sort of split optimization.
 540          */
 541         MPC_SPLIT_AVOID = 1,
 542
 543         /**
 544          * @MPC_SPLIT_AVOID_MULT_DISP: With this option, DC will only try to
 545          * optimize the pipe utilization when using a single display; if the
 546          * user connects to a second display, DC will avoid pipe split.
 547          */
 548         MPC_SPLIT_AVOID_MULT_DISP = 2,
 549 };
 550
 551 enum wm_report_mode {
 552         WM_REPORT_DEFAULT = 0,
 553         WM_REPORT_OVERRIDE = 1,
 554 };
 555 enum dtm_pstate{
 556         dtm_level_p0 = 0,/*highest voltage*/
 557         dtm_level_p1,
 558         dtm_level_p2,
 559         dtm_level_p3,
 560         dtm_level_p4,/*when active_display_count = 0*/
 561 };
 562
 563 enum dcn_pwr_state {
 564         DCN_PWR_STATE_UNKNOWN = -1,
 565         DCN_PWR_STATE_MISSION_MODE = 0,
 566         DCN_PWR_STATE_LOW_POWER = 3,
 567 };
 568
 569 enum dcn_zstate_support_state {
 570         DCN_ZSTATE_SUPPORT_UNKNOWN,
 571         DCN_ZSTATE_SUPPORT_ALLOW,
 572         DCN_ZSTATE_SUPPORT_ALLOW_Z8_ONLY,
 573         DCN_ZSTATE_SUPPORT_ALLOW_Z8_Z10_ONLY,
 574         DCN_ZSTATE_SUPPORT_ALLOW_Z10_ONLY,
 575         DCN_ZSTATE_SUPPORT_DISALLOW,
 576 };
 577
 578 /*
 579  * struct dc_clocks - DC pipe clocks
 580  *
 581  * For any clocks that may differ per pipe only the max is stored in this
 582  * structure
 583  */
 584 struct dc_clocks {
 585         int dispclk_khz;
 586         int actual_dispclk_khz;
 587         int dppclk_khz;
 588         int actual_dppclk_khz;
 589         int disp_dpp_voltage_level_khz;
 590         int dcfclk_khz;
 591         int socclk_khz;
 592         int dcfclk_deep_sleep_khz;
 593         int fclk_khz;
 594         int phyclk_khz;
 595         int dramclk_khz;
 596         bool p_state_change_support;
 597         enum dcn_zstate_support_state zstate_support;
 598         bool dtbclk_en;
 599         int ref_dtbclk_khz;
 600         bool fclk_p_state_change_support;
 601         enum dcn_pwr_state pwr_state;
 602         /*
 603          * Elements below are not compared for the purposes of
 604          * optimization required
 605          */
 606         bool prev_p_state_change_support;
 607         bool fclk_prev_p_state_change_support;
 608         int num_ways;
 609         int host_router_bw_kbps[MAX_HOST_ROUTERS_NUM];
 610
 611         /*
 612          * @fw_based_mclk_switching
 613          *
 614          * DC has a mechanism that leverage the variable refresh rate to switch
 615          * memory clock in cases that we have a large latency to achieve the
 616          * memory clock change and a short vblank window. DC has some
 617          * requirements to enable this feature, and this field describes if the
 618          * system support or not such a feature.
 619          */
 620         bool fw_based_mclk_switching;
 621         bool fw_based_mclk_switching_shut_down;
 622         int prev_num_ways;
 623         enum dtm_pstate dtm_level;
 624         int max_supported_dppclk_khz;
 625         int max_supported_dispclk_khz;
 626         int bw_dppclk_khz; /*a copy of dppclk_khz*/
 627         int bw_dispclk_khz;
 628         int idle_dramclk_khz;
 629         int idle_fclk_khz;
 630 };
 631
 632 struct dc_bw_validation_profile {
 633         bool enable;
 634
 635         unsigned long long total_ticks;
 636         unsigned long long voltage_level_ticks;
 637         unsigned long long watermark_ticks;
 638         unsigned long long rq_dlg_ticks;
 639
 640         unsigned long long total_count;
 641         unsigned long long skip_fast_count;
 642         unsigned long long skip_pass_count;
 643         unsigned long long skip_fail_count;
 644 };
 645
 646 #define BW_VAL_TRACE_SETUP() \
 647                 unsigned long long end_tick = 0; \
 648                 unsigned long long voltage_level_tick = 0; \
 649                 unsigned long long watermark_tick = 0; \
 650                 unsigned long long start_tick = dc->debug.bw_val_profile.enable ? \
 651                                 dm_get_timestamp(dc->ctx) : 0
 652
 653 #define BW_VAL_TRACE_COUNT() \
 654                 if (dc->debug.bw_val_profile.enable) \
 655                         dc->debug.bw_val_profile.total_count++
 656
 657 #define BW_VAL_TRACE_SKIP(status) \
 658                 if (dc->debug.bw_val_profile.enable) { \
 659                         if (!voltage_level_tick) \
 660                                 voltage_level_tick = dm_get_timestamp(dc->ctx); \
 661                         dc->debug.bw_val_profile.skip_ ## status ## _count++; \
 662                 }
 663
 664 #define BW_VAL_TRACE_END_VOLTAGE_LEVEL() \
 665                 if (dc->debug.bw_val_profile.enable) \
 666                         voltage_level_tick = dm_get_timestamp(dc->ctx)
 667
 668 #define BW_VAL_TRACE_END_WATERMARKS() \
 669                 if (dc->debug.bw_val_profile.enable) \
 670                         watermark_tick = dm_get_timestamp(dc->ctx)
 671
 672 #define BW_VAL_TRACE_FINISH() \
 673                 if (dc->debug.bw_val_profile.enable) { \
 674                         end_tick = dm_get_timestamp(dc->ctx); \
 675                         dc->debug.bw_val_profile.total_ticks += end_tick - start_tick; \
 676                         dc->debug.bw_val_profile.voltage_level_ticks += voltage_level_tick - start_tick; \
 677                         if (watermark_tick) { \
 678                                 dc->debug.bw_val_profile.watermark_ticks += watermark_tick - voltage_level_tick; \
 679                                 dc->debug.bw_val_profile.rq_dlg_ticks += end_tick - watermark_tick; \
 680                         } \
 681                 }
 682
 683 union mem_low_power_enable_options {
 684         struct {
 685                 bool vga: 1;
 686                 bool i2c: 1;
 687                 bool dmcu: 1;
 688                 bool dscl: 1;
 689                 bool cm: 1;
 690                 bool mpc: 1;
 691                 bool optc: 1;
 692                 bool vpg: 1;
 693                 bool afmt: 1;
 694         } bits;
 695         uint32_t u32All;
 696 };
 697
 698 union root_clock_optimization_options {
 699         struct {
 700                 bool dpp: 1;
 701                 bool dsc: 1;
 702                 bool hdmistream: 1;
 703                 bool hdmichar: 1;
 704                 bool dpstream: 1;
 705                 bool symclk32_se: 1;
 706                 bool symclk32_le: 1;
 707                 bool symclk_fe: 1;
 708                 bool physymclk: 1;
 709                 bool dpiasymclk: 1;
 710                 uint32_t reserved: 22;
 711         } bits;
 712         uint32_t u32All;
 713 };
 714
 715 union fine_grain_clock_gating_enable_options {
 716         struct {
 717                 bool dccg_global_fgcg_rep : 1; /* Global fine grain clock gating of repeaters */
 718                 bool dchub : 1;    /* Display controller hub */
 719                 bool dchubbub : 1;
 720                 bool dpp : 1;      /* Display pipes and planes */
 721                 bool opp : 1;      /* Output pixel processing */
 722                 bool optc : 1;     /* Output pipe timing combiner */
 723                 bool dio : 1;      /* Display output */
 724                 bool dwb : 1;      /* Display writeback */
 725                 bool mmhubbub : 1; /* Multimedia hub */
 726                 bool dmu : 1;      /* Display core management unit */
 727                 bool az : 1;       /* Azalia */
 728                 bool dchvm : 1;
 729                 bool dsc : 1;      /* Display stream compression */
 730
 731                 uint32_t reserved : 19;
 732         } bits;
 733         uint32_t u32All;
 734 };
 735
 736 enum pg_hw_pipe_resources {
 737         PG_HUBP = 0,
 738         PG_DPP,
 739         PG_DSC,
 740         PG_MPCC,
 741         PG_OPP,
 742         PG_OPTC,
 743         PG_DPSTREAM,
 744         PG_HDMISTREAM,
 745         PG_PHYSYMCLK,
 746         PG_HW_PIPE_RESOURCES_NUM_ELEMENT
 747 };
 748
 749 enum pg_hw_resources {
 750         PG_DCCG = 0,
 751         PG_DCIO,
 752         PG_DIO,
 753         PG_DCHUBBUB,
 754         PG_DCHVM,
 755         PG_DWB,
 756         PG_HPO,
 757         PG_HW_RESOURCES_NUM_ELEMENT
 758 };
 759
 760 struct pg_block_update {
 761         bool pg_pipe_res_update[PG_HW_PIPE_RESOURCES_NUM_ELEMENT][MAX_PIPES];
 762         bool pg_res_update[PG_HW_RESOURCES_NUM_ELEMENT];
 763 };
 764
 765 union dpia_debug_options {
 766         struct {
 767                 uint32_t disable_dpia:1; /* bit 0 */
 768                 uint32_t force_non_lttpr:1; /* bit 1 */
 769                 uint32_t extend_aux_rd_interval:1; /* bit 2 */
 770                 uint32_t disable_mst_dsc_work_around:1; /* bit 3 */
 771                 uint32_t enable_force_tbt3_work_around:1; /* bit 4 */
 772                 uint32_t disable_usb4_pm_support:1; /* bit 5 */
 773                 uint32_t enable_consolidated_dpia_dp_lt:1; /* bit 6 */
 774                 uint32_t reserved:25;
 775         } bits;
 776         uint32_t raw;
 777 };
 778
 779 /* AUX wake work around options
 780  * 0: enable/disable work around
 781  * 1: use default timeout LINK_AUX_WAKE_TIMEOUT_MS
 782  * 15-2: reserved
 783  * 31-16: timeout in ms
 784  */
 785 union aux_wake_wa_options {
 786         struct {
 787                 uint32_t enable_wa : 1;
 788                 uint32_t use_default_timeout : 1;
 789                 uint32_t rsvd: 14;
 790                 uint32_t timeout_ms : 16;
 791         } bits;
 792         uint32_t raw;
 793 };
 794
 795 struct dc_debug_data {
 796         uint32_t ltFailCount;
 797         uint32_t i2cErrorCount;
 798         uint32_t auxErrorCount;
 799 };
 800
 801 struct dc_phy_addr_space_config {
 802         struct {
 803                 uint64_t start_addr;
 804                 uint64_t end_addr;
 805                 uint64_t fb_top;
 806                 uint64_t fb_offset;
 807                 uint64_t fb_base;
 808                 uint64_t agp_top;
 809                 uint64_t agp_bot;
 810                 uint64_t agp_base;
 811         } system_aperture;
 812
 813         struct {
 814                 uint64_t page_table_start_addr;
 815                 uint64_t page_table_end_addr;
 816                 uint64_t page_table_base_addr;
 817                 bool base_addr_is_mc_addr;
 818         } gart_config;
 819
 820         bool valid;
 821         bool is_hvm_enabled;
 822         uint64_t page_table_default_page_addr;
 823 };
 824
 825 struct dc_virtual_addr_space_config {
 826         uint64_t        page_table_base_addr;
 827         uint64_t        page_table_start_addr;
 828         uint64_t        page_table_end_addr;
 829         uint32_t        page_table_block_size_in_bytes;
 830         uint8_t         page_table_depth; // 1 = 1 level, 2 = 2 level, etc.  0 = invalid
 831 };
 832
 833 struct dc_bounding_box_overrides {
 834         int sr_exit_time_ns;
 835         int sr_enter_plus_exit_time_ns;
 836         int sr_exit_z8_time_ns;
 837         int sr_enter_plus_exit_z8_time_ns;
 838         int urgent_latency_ns;
 839         int percent_of_ideal_drambw;
 840         int dram_clock_change_latency_ns;
 841         int dummy_clock_change_latency_ns;
 842         int fclk_clock_change_latency_ns;
 843         /* This forces a hard min on the DCFCLK we use
 844          * for DML.  Unlike the debug option for forcing
 845          * DCFCLK, this override affects watermark calculations
 846          */
 847         int min_dcfclk_mhz;
 848 };
 849
 850 struct dc_state;
 851 struct resource_pool;
 852 struct dce_hwseq;
 853 struct link_service;
 854
 855 /*
 856  * struct dc_debug_options - DC debug struct
 857  *
 858  * This struct provides a simple mechanism for developers to change some
 859  * configurations, enable/disable features, and activate extra debug options.
 860  * This can be very handy to narrow down whether some specific feature is
 861  * causing an issue or not.
 862  */
 863 struct dc_debug_options {
 864         bool native422_support;
 865         bool disable_dsc;
 866         enum visual_confirm visual_confirm;
 867         int visual_confirm_rect_height;
 868
 869         bool sanity_checks;
 870         bool max_disp_clk;
 871         bool surface_trace;
 872         bool clock_trace;
 873         bool validation_trace;
 874         bool bandwidth_calcs_trace;
 875         int max_downscale_src_width;
 876
 877         /* stutter efficiency related */
 878         bool disable_stutter;
 879         bool use_max_lb;
 880         enum dcc_option disable_dcc;
 881
 882         /*
 883          * @pipe_split_policy: Define which pipe split policy is used by the
 884          * display core.
 885          */
 886         enum pipe_split_policy pipe_split_policy;
 887         bool force_single_disp_pipe_split;
 888         bool voltage_align_fclk;
 889         bool disable_min_fclk;
 890
 891         bool disable_dfs_bypass;
 892         bool disable_dpp_power_gate;
 893         bool disable_hubp_power_gate;
 894         bool disable_dsc_power_gate;
 895         bool disable_optc_power_gate;
 896         bool disable_hpo_power_gate;
 897         int dsc_min_slice_height_override;
 898         int dsc_bpp_increment_div;
 899         bool disable_pplib_wm_range;
 900         enum wm_report_mode pplib_wm_report_mode;
 901         unsigned int min_disp_clk_khz;
 902         unsigned int min_dpp_clk_khz;
 903         unsigned int min_dram_clk_khz;
 904         int sr_exit_time_dpm0_ns;
 905         int sr_enter_plus_exit_time_dpm0_ns;
 906         int sr_exit_time_ns;
 907         int sr_enter_plus_exit_time_ns;
 908         int sr_exit_z8_time_ns;
 909         int sr_enter_plus_exit_z8_time_ns;
 910         int urgent_latency_ns;
 911         uint32_t underflow_assert_delay_us;
 912         int percent_of_ideal_drambw;
 913         int dram_clock_change_latency_ns;
 914         bool optimized_watermark;
 915         int always_scale;
 916         bool disable_pplib_clock_request;
 917         bool disable_clock_gate;
 918         bool disable_mem_low_power;
 919         bool pstate_enabled;
 920         bool disable_dmcu;
 921         bool force_abm_enable;
 922         bool disable_stereo_support;
 923         bool vsr_support;
 924         bool performance_trace;
 925         bool az_endpoint_mute_only;
 926         bool always_use_regamma;
 927         bool recovery_enabled;
 928         bool avoid_vbios_exec_table;
 929         bool scl_reset_length10;
 930         bool hdmi20_disable;
 931         bool skip_detection_link_training;
 932         uint32_t edid_read_retry_times;
 933         unsigned int force_odm_combine; //bit vector based on otg inst
 934         unsigned int seamless_boot_odm_combine;
 935         unsigned int force_odm_combine_4to1; //bit vector based on otg inst
 936         int minimum_z8_residency_time;
 937         int minimum_z10_residency_time;
 938         bool disable_z9_mpc;
 939         unsigned int force_fclk_khz;
 940         bool enable_tri_buf;
 941         bool ips_disallow_entry;
 942         bool dmub_offload_enabled;
 943         bool dmcub_emulation;
 944         bool disable_idle_power_optimizations;
 945         unsigned int mall_size_override;
 946         unsigned int mall_additional_timer_percent;
 947         bool mall_error_as_fatal;
 948         bool dmub_command_table; /* for testing only */
 949         struct dc_bw_validation_profile bw_val_profile;
 950         bool disable_fec;
 951         bool disable_48mhz_pwrdwn;
 952         /* This forces a hard min on the DCFCLK requested to SMU/PP
 953          * watermarks are not affected.
 954          */
 955         unsigned int force_min_dcfclk_mhz;
 956         int dwb_fi_phase;
 957         bool disable_timing_sync;
 958         bool cm_in_bypass;
 959         int force_clock_mode;/*every mode change.*/
 960
 961         bool disable_dram_clock_change_vactive_support;
 962         bool validate_dml_output;
 963         bool enable_dmcub_surface_flip;
 964         bool usbc_combo_phy_reset_wa;
 965         bool enable_dram_clock_change_one_display_vactive;
 966         /* TODO - remove once tested */
 967         bool legacy_dp2_lt;
 968         bool set_mst_en_for_sst;
 969         bool disable_uhbr;
 970         bool force_dp2_lt_fallback_method;
 971         bool ignore_cable_id;
 972         union mem_low_power_enable_options enable_mem_low_power;
 973         union root_clock_optimization_options root_clock_optimization;
 974         union fine_grain_clock_gating_enable_options enable_fine_grain_clock_gating;
 975         bool hpo_optimization;
 976         bool force_vblank_alignment;
 977
 978         /* Enable dmub aux for legacy ddc */
 979         bool enable_dmub_aux_for_legacy_ddc;
 980         bool disable_fams;
 981         enum in_game_fams_config disable_fams_gaming;
 982         /* FEC/PSR1 sequence enable delay in 100us */
 983         uint8_t fec_enable_delay_in100us;
 984         bool enable_driver_sequence_debug;
 985         enum det_size crb_alloc_policy;
 986         int crb_alloc_policy_min_disp_count;
 987         bool disable_z10;
 988         bool enable_z9_disable_interface;
 989         bool psr_skip_crtc_disable;
 990         uint32_t ips_skip_crtc_disable_mask;
 991         union dpia_debug_options dpia_debug;
 992         bool disable_fixed_vs_aux_timeout_wa;
 993         uint32_t fixed_vs_aux_delay_config_wa;
 994         bool force_disable_subvp;
 995         bool force_subvp_mclk_switch;
 996         bool allow_sw_cursor_fallback;
 997         unsigned int force_subvp_num_ways;
 998         unsigned int force_mall_ss_num_ways;
 999         bool alloc_extra_way_for_cursor;
1000         uint32_t subvp_extra_lines;
1001         bool force_usr_allow;
1002         /* uses value at boot and disables switch */
1003         bool disable_dtb_ref_clk_switch;
1004         bool extended_blank_optimization;
1005         union aux_wake_wa_options aux_wake_wa;
1006         uint32_t mst_start_top_delay;
1007         uint8_t psr_power_use_phy_fsm;
1008         enum dml_hostvm_override_opts dml_hostvm_override;
1009         bool dml_disallow_alternate_prefetch_modes;
1010         bool use_legacy_soc_bb_mechanism;
1011         bool exit_idle_opt_for_cursor_updates;
1012         bool using_dml2;
1013         bool enable_single_display_2to1_odm_policy;
1014         bool enable_double_buffered_dsc_pg_support;
1015         bool enable_dp_dig_pixel_rate_div_policy;
1016         bool using_dml21;
1017         enum lttpr_mode lttpr_mode_override;
1018         unsigned int dsc_delay_factor_wa_x1000;
1019         unsigned int min_prefetch_in_strobe_ns;
1020         bool disable_unbounded_requesting;
1021         bool dig_fifo_off_in_blank;
1022         bool override_dispclk_programming;
1023         bool otg_crc_db;
1024         bool disallow_dispclk_dppclk_ds;
1025         bool disable_fpo_optimizations;
1026         bool support_eDP1_5;
1027         uint32_t fpo_vactive_margin_us;
1028         bool disable_fpo_vactive;
1029         bool disable_boot_optimizations;
1030         bool override_odm_optimization;
1031         bool minimize_dispclk_using_odm;
1032         bool disable_subvp_high_refresh;
1033         bool disable_dp_plus_plus_wa;
1034         uint32_t fpo_vactive_min_active_margin_us;
1035         uint32_t fpo_vactive_max_blank_us;
1036         bool enable_hpo_pg_support;
1037         bool enable_legacy_fast_update;
1038         bool disable_dc_mode_overwrite;
1039         bool replay_skip_crtc_disabled;
1040         bool ignore_pg;/*do nothing, let pmfw control it*/
1041         bool psp_disabled_wa;
1042         unsigned int ips2_eval_delay_us;
1043         unsigned int ips2_entry_delay_us;
1044         bool optimize_ips_handshake;
1045         bool disable_dmub_reallow_idle;
1046         bool disable_timeout;
1047         bool disable_extblankadj;
1048         bool enable_idle_reg_checks;
1049         unsigned int static_screen_wait_frames;
1050         uint32_t pwm_freq;
1051         bool force_chroma_subsampling_1tap;
1052         unsigned int dcc_meta_propagation_delay_us;
1053         bool disable_422_left_edge_pixel;
1054         bool dml21_force_pstate_method;
1055         uint32_t dml21_force_pstate_method_values[MAX_PIPES];
1056         uint32_t dml21_disable_pstate_method_mask;
1057         union dmub_fams2_global_feature_config fams2_config;
1058         bool enable_legacy_clock_update;
1059         unsigned int force_cositing;
1060         unsigned int disable_spl;
1061         unsigned int force_easf;
1062         unsigned int force_sharpness;
1063         unsigned int force_sharpness_level;
1064         unsigned int force_lls;
1065         bool notify_dpia_hr_bw;
1066         bool enable_ips_visual_confirm;
1067         unsigned int sharpen_policy;
1068         unsigned int scale_to_sharpness_policy;
1069         bool skip_full_updated_if_possible;
1070         unsigned int enable_oled_edp_power_up_opt;
1071 };
1072
1073
1074 /* Generic structure that can be used to query properties of DC. More fields
1075  * can be added as required.
1076  */
1077 struct dc_current_properties {
1078         unsigned int cursor_size_limit;
1079 };
1080
1081 enum frame_buffer_mode {
1082         FRAME_BUFFER_MODE_LOCAL_ONLY = 0,
1083         FRAME_BUFFER_MODE_ZFB_ONLY,
1084         FRAME_BUFFER_MODE_MIXED_ZFB_AND_LOCAL,
1085 } ;
1086
1087 struct dchub_init_data {
1088         int64_t zfb_phys_addr_base;
1089         int64_t zfb_mc_base_addr;
1090         uint64_t zfb_size_in_byte;
1091         enum frame_buffer_mode fb_mode;
1092         bool dchub_initialzied;
1093         bool dchub_info_valid;
1094 };
1095
1096 struct dml2_soc_bb;
1097
1098 struct dc_init_data {
1099         struct hw_asic_id asic_id;
1100         void *driver; /* ctx */
1101         struct cgs_device *cgs_device;
1102         struct dc_bounding_box_overrides bb_overrides;
1103
1104         int num_virtual_links;
1105         /*
1106          * If 'vbios_override' not NULL, it will be called instead
1107          * of the real VBIOS. Intended use is Diagnostics on FPGA.
1108          */
1109         struct dc_bios *vbios_override;
1110         enum dce_environment dce_environment;
1111
1112         struct dmub_offload_funcs *dmub_if;
1113         struct dc_reg_helper_state *dmub_offload;
1114
1115         struct dc_config flags;
1116         uint64_t log_mask;
1117
1118         struct dpcd_vendor_signature vendor_signature;
1119         bool force_smu_not_present;
1120         /*
1121          * IP offset for run time initializaion of register addresses
1122          *
1123          * DCN3.5+ will fail dc_create() if these fields are null for them. They are
1124          * applicable starting with DCN32/321 and are not used for ASICs upstreamed
1125          * before them.
1126          */
1127         uint32_t *dcn_reg_offsets;
1128         uint32_t *nbio_reg_offsets;
1129         uint32_t *clk_reg_offsets;
1130         struct dml2_soc_bb *bb_from_dmub;
1131 };
1132
1133 struct dc_callback_init {
1134         struct cp_psp cp_psp;
1135 };
1136
1137 struct dc *dc_create(const struct dc_init_data *init_params);
1138 void dc_hardware_init(struct dc *dc);
1139
1140 int dc_get_vmid_use_vector(struct dc *dc);
1141 void dc_setup_vm_context(struct dc *dc, struct dc_virtual_addr_space_config *va_config, int vmid);
1142 /* Returns the number of vmids supported */
1143 int dc_setup_system_context(struct dc *dc, struct dc_phy_addr_space_config *pa_config);
1144 void dc_init_callbacks(struct dc *dc,
1145                 const struct dc_callback_init *init_params);
1146 void dc_deinit_callbacks(struct dc *dc);
1147 void dc_destroy(struct dc **dc);
1148
1149 /* Surface Interfaces */
1150
1151 enum {
1152         TRANSFER_FUNC_POINTS = 1025
1153 };
1154
1155 struct dc_hdr_static_metadata {
1156         /* display chromaticities and white point in units of 0.00001 */
1157         unsigned int chromaticity_green_x;
1158         unsigned int chromaticity_green_y;
1159         unsigned int chromaticity_blue_x;
1160         unsigned int chromaticity_blue_y;
1161         unsigned int chromaticity_red_x;
1162         unsigned int chromaticity_red_y;
1163         unsigned int chromaticity_white_point_x;
1164         unsigned int chromaticity_white_point_y;
1165
1166         uint32_t min_luminance;
1167         uint32_t max_luminance;
1168         uint32_t maximum_content_light_level;
1169         uint32_t maximum_frame_average_light_level;
1170 };
1171
1172 enum dc_transfer_func_type {
1173         TF_TYPE_PREDEFINED,
1174         TF_TYPE_DISTRIBUTED_POINTS,
1175         TF_TYPE_BYPASS,
1176         TF_TYPE_HWPWL
1177 };
1178
1179 struct dc_transfer_func_distributed_points {
1180         struct fixed31_32 red[TRANSFER_FUNC_POINTS];
1181         struct fixed31_32 green[TRANSFER_FUNC_POINTS];
1182         struct fixed31_32 blue[TRANSFER_FUNC_POINTS];
1183
1184         uint16_t end_exponent;
1185         uint16_t x_point_at_y1_red;
1186         uint16_t x_point_at_y1_green;
1187         uint16_t x_point_at_y1_blue;
1188 };
1189
1190 enum dc_transfer_func_predefined {
1191         TRANSFER_FUNCTION_SRGB,
1192         TRANSFER_FUNCTION_BT709,
1193         TRANSFER_FUNCTION_PQ,
1194         TRANSFER_FUNCTION_LINEAR,
1195         TRANSFER_FUNCTION_UNITY,
1196         TRANSFER_FUNCTION_HLG,
1197         TRANSFER_FUNCTION_HLG12,
1198         TRANSFER_FUNCTION_GAMMA22,
1199         TRANSFER_FUNCTION_GAMMA24,
1200         TRANSFER_FUNCTION_GAMMA26
1201 };
1202
1203
1204 struct dc_transfer_func {
1205         struct kref refcount;
1206         enum dc_transfer_func_type type;
1207         enum dc_transfer_func_predefined tf;
1208         /* FP16 1.0 reference level in nits, default is 80 nits, only for PQ*/
1209         uint32_t sdr_ref_white_level;
1210         union {
1211                 struct pwl_params pwl;
1212                 struct dc_transfer_func_distributed_points tf_pts;
1213         };
1214 };
1215
1216
1217 union dc_3dlut_state {
1218         struct {
1219                 uint32_t initialized:1;         /*if 3dlut is went through color module for initialization */
1220                 uint32_t rmu_idx_valid:1;       /*if mux settings are valid*/
1221                 uint32_t rmu_mux_num:3;         /*index of mux to use*/
1222                 uint32_t mpc_rmu0_mux:4;        /*select mpcc on mux, one of the following : mpcc0, mpcc1, mpcc2, mpcc3*/
1223                 uint32_t mpc_rmu1_mux:4;
1224                 uint32_t mpc_rmu2_mux:4;
1225                 uint32_t reserved:15;
1226         } bits;
1227         uint32_t raw;
1228 };
1229
1230
1231 struct dc_3dlut {
1232         struct kref refcount;
1233         struct tetrahedral_params lut_3d;
1234         struct fixed31_32 hdr_multiplier;
1235         union dc_3dlut_state state;
1236 };
1237 /*
1238  * This structure is filled in by dc_surface_get_status and contains
1239  * the last requested address and the currently active address so the called
1240  * can determine if there are any outstanding flips
1241  */
1242 struct dc_plane_status {
1243         struct dc_plane_address requested_address;
1244         struct dc_plane_address current_address;
1245         bool is_flip_pending;
1246         bool is_right_eye;
1247 };
1248
1249 union surface_update_flags {
1250
1251         struct {
1252                 uint32_t addr_update:1;
1253                 /* Medium updates */
1254                 uint32_t dcc_change:1;
1255                 uint32_t color_space_change:1;
1256                 uint32_t horizontal_mirror_change:1;
1257                 uint32_t per_pixel_alpha_change:1;
1258                 uint32_t global_alpha_change:1;
1259                 uint32_t hdr_mult:1;
1260                 uint32_t rotation_change:1;
1261                 uint32_t swizzle_change:1;
1262                 uint32_t scaling_change:1;
1263                 uint32_t position_change:1;
1264                 uint32_t in_transfer_func_change:1;
1265                 uint32_t input_csc_change:1;
1266                 uint32_t coeff_reduction_change:1;
1267                 uint32_t output_tf_change:1;
1268                 uint32_t pixel_format_change:1;
1269                 uint32_t plane_size_change:1;
1270                 uint32_t gamut_remap_change:1;
1271
1272                 /* Full updates */
1273                 uint32_t new_plane:1;
1274                 uint32_t bpp_change:1;
1275                 uint32_t gamma_change:1;
1276                 uint32_t bandwidth_change:1;
1277                 uint32_t clock_change:1;
1278                 uint32_t stereo_format_change:1;
1279                 uint32_t lut_3d:1;
1280                 uint32_t tmz_changed:1;
1281                 uint32_t mcm_transfer_function_enable_change:1; /* disable or enable MCM transfer func */
1282                 uint32_t full_update:1;
1283                 uint32_t sdr_white_level_nits:1;
1284         } bits;
1285
1286         uint32_t raw;
1287 };
1288
1289 #define DC_REMOVE_PLANE_POINTERS 1
1290
1291 struct dc_plane_state {
1292         struct dc_plane_address address;
1293         struct dc_plane_flip_time time;
1294         bool triplebuffer_flips;
1295         struct scaling_taps scaling_quality;
1296         struct rect src_rect;
1297         struct rect dst_rect;
1298         struct rect clip_rect;
1299
1300         struct plane_size plane_size;
1301         union dc_tiling_info tiling_info;
1302
1303         struct dc_plane_dcc_param dcc;
1304
1305         struct dc_gamma gamma_correction;
1306         struct dc_transfer_func in_transfer_func;
1307         struct dc_bias_and_scale bias_and_scale;
1308         struct dc_csc_transform input_csc_color_matrix;
1309         struct fixed31_32 coeff_reduction_factor;
1310         struct fixed31_32 hdr_mult;
1311         struct colorspace_transform gamut_remap_matrix;
1312
1313         // TODO: No longer used, remove
1314         struct dc_hdr_static_metadata hdr_static_ctx;
1315
1316         enum dc_color_space color_space;
1317
1318         struct dc_3dlut lut3d_func;
1319         struct dc_transfer_func in_shaper_func;
1320         struct dc_transfer_func blend_tf;
1321
1322         struct dc_transfer_func *gamcor_tf;
1323         enum surface_pixel_format format;
1324         enum dc_rotation_angle rotation;
1325         enum plane_stereo_format stereo_format;
1326
1327         bool is_tiling_rotated;
1328         bool per_pixel_alpha;
1329         bool pre_multiplied_alpha;
1330         bool global_alpha;
1331         int  global_alpha_value;
1332         bool visible;
1333         bool flip_immediate;
1334         bool horizontal_mirror;
1335         int layer_index;
1336
1337         union surface_update_flags update_flags;
1338         bool flip_int_enabled;
1339         bool skip_manual_trigger;
1340
1341         /* private to DC core */
1342         struct dc_plane_status status;
1343         struct dc_context *ctx;
1344
1345         /* HACK: Workaround for forcing full reprogramming under some conditions */
1346         bool force_full_update;
1347
1348         bool is_phantom; // TODO: Change mall_stream_config into mall_plane_config instead
1349
1350         /* private to dc_surface.c */
1351         enum dc_irq_source irq_source;
1352         struct kref refcount;
1353         struct tg_color visual_confirm_color;
1354
1355         bool is_statically_allocated;
1356         enum chroma_cositing cositing;
1357         enum dc_cm2_shaper_3dlut_setting mcm_shaper_3dlut_setting;
1358         bool mcm_lut1d_enable;
1359         struct dc_cm2_func_luts mcm_luts;
1360         bool lut_bank_a;
1361         enum mpcc_movable_cm_location mcm_location;
1362         struct dc_csc_transform cursor_csc_color_matrix;
1363         bool adaptive_sharpness_en;
1364         int adaptive_sharpness_policy;
1365         int sharpness_level;
1366         enum linear_light_scaling linear_light_scaling;
1367         unsigned int sdr_white_level_nits;
1368 };
1369
1370 struct dc_plane_info {
1371         struct plane_size plane_size;
1372         union dc_tiling_info tiling_info;
1373         struct dc_plane_dcc_param dcc;
1374         enum surface_pixel_format format;
1375         enum dc_rotation_angle rotation;
1376         enum plane_stereo_format stereo_format;
1377         enum dc_color_space color_space;
1378         bool horizontal_mirror;
1379         bool visible;
1380         bool per_pixel_alpha;
1381         bool pre_multiplied_alpha;
1382         bool global_alpha;
1383         int  global_alpha_value;
1384         bool input_csc_enabled;
1385         int layer_index;
1386         enum chroma_cositing cositing;
1387 };
1388
1389 #include "dc_stream.h"
1390
1391 struct dc_scratch_space {
1392         /* used to temporarily backup plane states of a stream during
1393          * dc update. The reason is that plane states are overwritten
1394          * with surface updates in dc update. Once they are overwritten
1395          * current state is no longer valid. We want to temporarily
1396          * store current value in plane states so we can still recover
1397          * a valid current state during dc update.
1398          */
1399         struct dc_plane_state plane_states[MAX_SURFACE_NUM];
1400
1401         struct dc_stream_state stream_state;
1402 };
1403
1404 struct dc {
1405         struct dc_debug_options debug;
1406         struct dc_versions versions;
1407         struct dc_caps caps;
1408         struct dc_cap_funcs cap_funcs;
1409         struct dc_config config;
1410         struct dc_bounding_box_overrides bb_overrides;
1411         struct dc_bug_wa work_arounds;
1412         struct dc_context *ctx;
1413         struct dc_phy_addr_space_config vm_pa_config;
1414
1415         uint8_t link_count;
1416         struct dc_link *links[MAX_LINKS];
1417         struct link_service *link_srv;
1418
1419         struct dc_state *current_state;
1420         struct resource_pool *res_pool;
1421
1422         struct clk_mgr *clk_mgr;
1423
1424         /* Display Engine Clock levels */
1425         struct dm_pp_clock_levels sclk_lvls;
1426
1427         /* Inputs into BW and WM calculations. */
1428         struct bw_calcs_dceip *bw_dceip;
1429         struct bw_calcs_vbios *bw_vbios;
1430         struct dcn_soc_bounding_box *dcn_soc;
1431         struct dcn_ip_params *dcn_ip;
1432         struct display_mode_lib dml;
1433
1434         /* HW functions */
1435         struct hw_sequencer_funcs hwss;
1436         struct dce_hwseq *hwseq;
1437
1438         /* Require to optimize clocks and bandwidth for added/removed planes */
1439         bool optimized_required;
1440         bool wm_optimized_required;
1441         bool idle_optimizations_allowed;
1442         bool enable_c20_dtm_b0;
1443
1444         /* Require to maintain clocks and bandwidth for UEFI enabled HW */
1445
1446         /* FBC compressor */
1447         struct compressor *fbc_compressor;
1448
1449         struct dc_debug_data debug_data;
1450         struct dpcd_vendor_signature vendor_signature;
1451
1452         const char *build_id;
1453         struct vm_helper *vm_helper;
1454
1455         uint32_t *dcn_reg_offsets;
1456         uint32_t *nbio_reg_offsets;
1457         uint32_t *clk_reg_offsets;
1458
1459         /* Scratch memory */
1460         struct {
1461                 struct {
1462                         /*
1463                          * For matching clock_limits table in driver with table
1464                          * from PMFW.
1465                          */
1466                         struct _vcs_dpi_voltage_scaling_st clock_limits[DC__VOLTAGE_STATES];
1467                 } update_bw_bounding_box;
1468                 struct dc_scratch_space current_state;
1469                 struct dc_scratch_space new_state;
1470                 struct dc_stream_state temp_stream; // Used so we don't need to allocate stream on the stack
1471                 bool pipes_to_unlock_first[MAX_PIPES]; /* Any of the pipes indicated here should be unlocked first */
1472         } scratch;
1473
1474         struct dml2_configuration_options dml2_options;
1475         struct dml2_configuration_options dml2_tmp;
1476         enum dc_acpi_cm_power_state power_state;
1477
1478 };
1479
1480 struct dc_scaling_info {
1481         struct rect src_rect;
1482         struct rect dst_rect;
1483         struct rect clip_rect;
1484         struct scaling_taps scaling_quality;
1485 };
1486
1487 struct dc_fast_update {
1488         const struct dc_flip_addrs *flip_addr;
1489         const struct dc_gamma *gamma;
1490         const struct colorspace_transform *gamut_remap_matrix;
1491         const struct dc_csc_transform *input_csc_color_matrix;
1492         const struct fixed31_32 *coeff_reduction_factor;
1493         struct dc_transfer_func *out_transfer_func;
1494         struct dc_csc_transform *output_csc_transform;
1495         const struct dc_csc_transform *cursor_csc_color_matrix;
1496 };
1497
1498 struct dc_surface_update {
1499         struct dc_plane_state *surface;
1500
1501         /* isr safe update parameters.  null means no updates */
1502         const struct dc_flip_addrs *flip_addr;
1503         const struct dc_plane_info *plane_info;
1504         const struct dc_scaling_info *scaling_info;
1505         struct fixed31_32 hdr_mult;
1506         /* following updates require alloc/sleep/spin that is not isr safe,
1507          * null means no updates
1508          */
1509         const struct dc_gamma *gamma;
1510         const struct dc_transfer_func *in_transfer_func;
1511
1512         const struct dc_csc_transform *input_csc_color_matrix;
1513         const struct fixed31_32 *coeff_reduction_factor;
1514         const struct dc_transfer_func *func_shaper;
1515         const struct dc_3dlut *lut3d_func;
1516         const struct dc_transfer_func *blend_tf;
1517         const struct colorspace_transform *gamut_remap_matrix;
1518         /*
1519          * Color Transformations for pre-blend MCM (Shaper, 3DLUT, 1DLUT)
1520          *
1521          * change cm2_params.component_settings: Full update
1522          * change cm2_params.cm2_luts: Fast update
1523          */
1524         const struct dc_cm2_parameters *cm2_params;
1525         const struct dc_csc_transform *cursor_csc_color_matrix;
1526         unsigned int sdr_white_level_nits;
1527 };
1528
1529 /*
1530  * Create a new surface with default parameters;
1531  */
1532 void dc_gamma_retain(struct dc_gamma *dc_gamma);
1533 void dc_gamma_release(struct dc_gamma **dc_gamma);
1534 struct dc_gamma *dc_create_gamma(void);
1535
1536 void dc_transfer_func_retain(struct dc_transfer_func *dc_tf);
1537 void dc_transfer_func_release(struct dc_transfer_func *dc_tf);
1538 struct dc_transfer_func *dc_create_transfer_func(void);
1539
1540 struct dc_3dlut *dc_create_3dlut_func(void);
1541 void dc_3dlut_func_release(struct dc_3dlut *lut);
1542 void dc_3dlut_func_retain(struct dc_3dlut *lut);
1543
1544 void dc_post_update_surfaces_to_stream(
1545                 struct dc *dc);
1546
1547 #include "dc_stream.h"
1548
1549 /**
1550  * struct dc_validation_set - Struct to store surface/stream associations for validation
1551  */
1552 struct dc_validation_set {
1553         /**
1554          * @stream: Stream state properties
1555          */
1556         struct dc_stream_state *stream;
1557
1558         /**
1559          * @plane_states: Surface state
1560          */
1561         struct dc_plane_state *plane_states[MAX_SURFACES];
1562
1563         /**
1564          * @plane_count: Total of active planes
1565          */
1566         uint8_t plane_count;
1567 };
1568
1569 bool dc_validate_boot_timing(const struct dc *dc,
1570                                 const struct dc_sink *sink,
1571                                 struct dc_crtc_timing *crtc_timing);
1572
1573 enum dc_status dc_validate_plane(struct dc *dc, const struct dc_plane_state *plane_state);
1574
1575 void get_clock_requirements_for_state(struct dc_state *state, struct AsicStateEx *info);
1576
1577 enum dc_status dc_validate_with_context(struct dc *dc,
1578                                         const struct dc_validation_set set[],
1579                                         int set_count,
1580                                         struct dc_state *context,
1581                                         bool fast_validate);
1582
1583 bool dc_set_generic_gpio_for_stereo(bool enable,
1584                 struct gpio_service *gpio_service);
1585
1586 /*
1587  * fast_validate: we return after determining if we can support the new state,
1588  * but before we populate the programming info
1589  */
1590 enum dc_status dc_validate_global_state(
1591                 struct dc *dc,
1592                 struct dc_state *new_ctx,
1593                 bool fast_validate);
1594
1595 bool dc_acquire_release_mpc_3dlut(
1596                 struct dc *dc, bool acquire,
1597                 struct dc_stream_state *stream,
1598                 struct dc_3dlut **lut,
1599                 struct dc_transfer_func **shaper);
1600
1601 bool dc_resource_is_dsc_encoding_supported(const struct dc *dc);
1602 void get_audio_check(struct audio_info *aud_modes,
1603         struct audio_check *aud_chk);
1604
1605 bool fast_nonaddr_updates_exist(struct dc_fast_update *fast_update, int surface_count);
1606 void populate_fast_updates(struct dc_fast_update *fast_update,
1607                 struct dc_surface_update *srf_updates,
1608                 int surface_count,
1609                 struct dc_stream_update *stream_update);
1610 /*
1611  * Set up streams and links associated to drive sinks
1612  * The streams parameter is an absolute set of all active streams.
1613  *
1614  * After this call:
1615  *   Phy, Encoder, Timing Generator are programmed and enabled.
1616  *   New streams are enabled with blank stream; no memory read.
1617  */
1618 enum dc_status dc_commit_streams(struct dc *dc, struct dc_commit_streams_params *params);
1619
1620
1621 struct dc_plane_state *dc_get_surface_for_mpcc(struct dc *dc,
1622                 struct dc_stream_state *stream,
1623                 int mpcc_inst);
1624
1625
1626 uint32_t dc_get_opp_for_plane(struct dc *dc, struct dc_plane_state *plane);
1627
1628 void dc_set_disable_128b_132b_stream_overhead(bool disable);
1629
1630 /* The function returns minimum bandwidth required to drive a given timing
1631  * return - minimum required timing bandwidth in kbps.
1632  */
1633 uint32_t dc_bandwidth_in_kbps_from_timing(
1634                 const struct dc_crtc_timing *timing,
1635                 const enum dc_link_encoding_format link_encoding);
1636
1637 /* Link Interfaces */
1638 /*
1639  * A link contains one or more sinks and their connected status.
1640  * The currently active signal type (HDMI, DP-SST, DP-MST) is also reported.
1641  */
1642 struct dc_link {
1643         struct dc_sink *remote_sinks[MAX_SINKS_PER_LINK];
1644         unsigned int sink_count;
1645         struct dc_sink *local_sink;
1646         unsigned int link_index;
1647         enum dc_connection_type type;
1648         enum signal_type connector_signal;
1649         enum dc_irq_source irq_source_hpd;
1650         enum dc_irq_source irq_source_hpd_rx;/* aka DP Short Pulse  */
1651
1652         bool is_hpd_filter_disabled;
1653         bool dp_ss_off;
1654
1655         /**
1656          * @link_state_valid:
1657          *
1658          * If there is no link and local sink, this variable should be set to
1659          * false. Otherwise, it should be set to true; usually, the function
1660          * core_link_enable_stream sets this field to true.
1661          */
1662         bool link_state_valid;
1663         bool aux_access_disabled;
1664         bool sync_lt_in_progress;
1665         bool skip_stream_reenable;
1666         bool is_internal_display;
1667         /** @todo Rename. Flag an endpoint as having a programmable mapping to a DIG encoder. */
1668         bool is_dig_mapping_flexible;
1669         bool hpd_status; /* HPD status of link without physical HPD pin. */
1670         bool is_hpd_pending; /* Indicates a new received hpd */
1671
1672         /* USB4 DPIA links skip verifying link cap, instead performing the fallback method
1673          * for every link training. This is incompatible with DP LL compliance automation,
1674          * which expects the same link settings to be used every retry on a link loss.
1675          * This flag is used to skip the fallback when link loss occurs during automation.
1676          */
1677         bool skip_fallback_on_link_loss;
1678
1679         bool edp_sink_present;
1680
1681         struct dp_trace dp_trace;
1682
1683         /* caps is the same as reported_link_cap. link_traing use
1684          * reported_link_cap. Will clean up.  TODO
1685          */
1686         struct dc_link_settings reported_link_cap;
1687         struct dc_link_settings verified_link_cap;
1688         struct dc_link_settings cur_link_settings;
1689         struct dc_lane_settings cur_lane_setting[LANE_COUNT_DP_MAX];
1690         struct dc_link_settings preferred_link_setting;
1691         /* preferred_training_settings are override values that
1692          * come from DM. DM is responsible for the memory
1693          * management of the override pointers.
1694          */
1695         struct dc_link_training_overrides preferred_training_settings;
1696         struct dp_audio_test_data audio_test_data;
1697
1698         uint8_t ddc_hw_inst;
1699
1700         uint8_t hpd_src;
1701
1702         uint8_t link_enc_hw_inst;
1703         /* DIG link encoder ID. Used as index in link encoder resource pool.
1704          * For links with fixed mapping to DIG, this is not changed after dc_link
1705          * object creation.
1706          */
1707         enum engine_id eng_id;
1708         enum engine_id dpia_preferred_eng_id;
1709
1710         bool test_pattern_enabled;
1711         /* Pending/Current test pattern are only used to perform and track
1712          * FIXED_VS retimer test pattern/lane adjustment override state.
1713          * Pending allows link HWSS to differentiate PHY vs non-PHY pattern,
1714          * to perform specific lane adjust overrides before setting certain
1715          * PHY test patterns. In cases when lane adjust and set test pattern
1716          * calls are not performed atomically (i.e. performing link training),
1717          * pending_test_pattern will be invalid or contain a non-PHY test pattern
1718          * and current_test_pattern will contain required context for any future
1719          * set pattern/set lane adjust to transition between override state(s).
1720          * */
1721         enum dp_test_pattern current_test_pattern;
1722         enum dp_test_pattern pending_test_pattern;
1723
1724         union compliance_test_state compliance_test_state;
1725
1726         void *priv;
1727
1728         struct ddc_service *ddc;
1729
1730         enum dp_panel_mode panel_mode;
1731         bool aux_mode;
1732
1733         /* Private to DC core */
1734
1735         const struct dc *dc;
1736
1737         struct dc_context *ctx;
1738
1739         struct panel_cntl *panel_cntl;
1740         struct link_encoder *link_enc;
1741         struct graphics_object_id link_id;
1742         /* Endpoint type distinguishes display endpoints which do not have entries
1743          * in the BIOS connector table from those that do. Helps when tracking link
1744          * encoder to display endpoint assignments.
1745          */
1746         enum display_endpoint_type ep_type;
1747         union ddi_channel_mapping ddi_channel_mapping;
1748         struct connector_device_tag_info device_tag;
1749         struct dpcd_caps dpcd_caps;
1750         uint32_t dongle_max_pix_clk;
1751         unsigned short chip_caps;
1752         unsigned int dpcd_sink_count;
1753         struct hdcp_caps hdcp_caps;
1754         enum edp_revision edp_revision;
1755         union dpcd_sink_ext_caps dpcd_sink_ext_caps;
1756
1757         struct psr_settings psr_settings;
1758         struct replay_settings replay_settings;
1759
1760         /* Drive settings read from integrated info table */
1761         struct dc_lane_settings bios_forced_drive_settings;
1762
1763         /* Vendor specific LTTPR workaround variables */
1764         uint8_t vendor_specific_lttpr_link_rate_wa;
1765         bool apply_vendor_specific_lttpr_link_rate_wa;
1766
1767         /* MST record stream using this link */
1768         struct link_flags {
1769                 bool dp_keep_receiver_powered;
1770                 bool dp_skip_DID2;
1771                 bool dp_skip_reset_segment;
1772                 bool dp_skip_fs_144hz;
1773                 bool dp_mot_reset_segment;
1774                 /* Some USB4 docks do not handle turning off MST DSC once it has been enabled. */
1775                 bool dpia_mst_dsc_always_on;
1776                 /* Forced DPIA into TBT3 compatibility mode. */
1777                 bool dpia_forced_tbt3_mode;
1778                 bool dongle_mode_timing_override;
1779                 bool blank_stream_on_ocs_change;
1780                 bool read_dpcd204h_on_irq_hpd;
1781         } wa_flags;
1782         struct link_mst_stream_allocation_table mst_stream_alloc_table;
1783
1784         struct dc_link_status link_status;
1785         struct dprx_states dprx_states;
1786
1787         struct gpio *hpd_gpio;
1788         enum dc_link_fec_state fec_state;
1789         bool link_powered_externally;   // Used to bypass hardware sequencing delays when panel is powered down forcibly
1790
1791         struct dc_panel_config panel_config;
1792         struct phy_state phy_state;
1793         // BW ALLOCATON USB4 ONLY
1794         struct dc_dpia_bw_alloc dpia_bw_alloc_config;
1795         bool skip_implict_edp_power_control;
1796         enum backlight_control_type backlight_control_type;
1797 };
1798
1799 /* Return an enumerated dc_link.
1800  * dc_link order is constant and determined at
1801  * boot time.  They cannot be created or destroyed.
1802  * Use dc_get_caps() to get number of links.
1803  */
1804 struct dc_link *dc_get_link_at_index(struct dc *dc, uint32_t link_index);
1805
1806 /* Return instance id of the edp link. Inst 0 is primary edp link. */
1807 bool dc_get_edp_link_panel_inst(const struct dc *dc,
1808                 const struct dc_link *link,
1809                 unsigned int *inst_out);
1810
1811 /* Return an array of link pointers to edp links. */
1812 void dc_get_edp_links(const struct dc *dc,
1813                 struct dc_link **edp_links,
1814                 int *edp_num);
1815
1816 void dc_set_edp_power(const struct dc *dc, struct dc_link *edp_link,
1817                                  bool powerOn);
1818
1819 /* The function initiates detection handshake over the given link. It first
1820  * determines if there are display connections over the link. If so it initiates
1821  * detection protocols supported by the connected receiver device. The function
1822  * contains protocol specific handshake sequences which are sometimes mandatory
1823  * to establish a proper connection between TX and RX. So it is always
1824  * recommended to call this function as the first link operation upon HPD event
1825  * or power up event. Upon completion, the function will update link structure
1826  * in place based on latest RX capabilities. The function may also cause dpms
1827  * to be reset to off for all currently enabled streams to the link. It is DM's
1828  * responsibility to serialize detection and DPMS updates.
1829  *
1830  * @reason - Indicate which event triggers this detection. dc may customize
1831  * detection flow depending on the triggering events.
1832  * return false - if detection is not fully completed. This could happen when
1833  * there is an unrecoverable error during detection or detection is partially
1834  * completed (detection has been delegated to dm mst manager ie.
1835  * link->connection_type == dc_connection_mst_branch when returning false).
1836  * return true - detection is completed, link has been fully updated with latest
1837  * detection result.
1838  */
1839 bool dc_link_detect(struct dc_link *link, enum dc_detect_reason reason);
1840
1841 struct dc_sink_init_data;
1842
1843 /* When link connection type is dc_connection_mst_branch, remote sink can be
1844  * added to the link. The interface creates a remote sink and associates it with
1845  * current link. The sink will be retained by link until remove remote sink is
1846  * called.
1847  *
1848  * @dc_link - link the remote sink will be added to.
1849  * @edid - byte array of EDID raw data.
1850  * @len - size of the edid in byte
1851  * @init_data -
1852  */
1853 struct dc_sink *dc_link_add_remote_sink(
1854                 struct dc_link *dc_link,
1855                 const uint8_t *edid,
1856                 int len,
1857                 struct dc_sink_init_data *init_data);
1858
1859 /* Remove remote sink from a link with dc_connection_mst_branch connection type.
1860  * @link - link the sink should be removed from
1861  * @sink - sink to be removed.
1862  */
1863 void dc_link_remove_remote_sink(
1864         struct dc_link *link,
1865         struct dc_sink *sink);
1866
1867 /* Enable HPD interrupt handler for a given link */
1868 void dc_link_enable_hpd(const struct dc_link *link);
1869
1870 /* Disable HPD interrupt handler for a given link */
1871 void dc_link_disable_hpd(const struct dc_link *link);
1872
1873 /* determine if there is a sink connected to the link
1874  *
1875  * @type - dc_connection_single if connected, dc_connection_none otherwise.
1876  * return - false if an unexpected error occurs, true otherwise.
1877  *
1878  * NOTE: This function doesn't detect downstream sink connections i.e
1879  * dc_connection_mst_branch, dc_connection_sst_branch. In this case, it will
1880  * return dc_connection_single if the branch device is connected despite of
1881  * downstream sink's connection status.
1882  */
1883 bool dc_link_detect_connection_type(struct dc_link *link,
1884                 enum dc_connection_type *type);
1885
1886 /* query current hpd pin value
1887  * return - true HPD is asserted (HPD high), false otherwise (HPD low)
1888  *
1889  */
1890 bool dc_link_get_hpd_state(struct dc_link *link);
1891
1892 /* Getter for cached link status from given link */
1893 const struct dc_link_status *dc_link_get_status(const struct dc_link *link);
1894
1895 /* enable/disable hardware HPD filter.
1896  *
1897  * @link - The link the HPD pin is associated with.
1898  * @enable = true - enable hardware HPD filter. HPD event will only queued to irq
1899  * handler once after no HPD change has been detected within dc default HPD
1900  * filtering interval since last HPD event. i.e if display keeps toggling hpd
1901  * pulses within default HPD interval, no HPD event will be received until HPD
1902  * toggles have stopped. Then HPD event will be queued to irq handler once after
1903  * dc default HPD filtering interval since last HPD event.
1904  *
1905  * @enable = false - disable hardware HPD filter. HPD event will be queued
1906  * immediately to irq handler after no HPD change has been detected within
1907  * IRQ_HPD (aka HPD short pulse) interval (i.e 2ms).
1908  */
1909 void dc_link_enable_hpd_filter(struct dc_link *link, bool enable);
1910
1911 /* submit i2c read/write payloads through ddc channel
1912  * @link_index - index to a link with ddc in i2c mode
1913  * @cmd - i2c command structure
1914  * return - true if success, false otherwise.
1915  */
1916 bool dc_submit_i2c(
1917                 struct dc *dc,
1918                 uint32_t link_index,
1919                 struct i2c_command *cmd);
1920
1921 /* submit i2c read/write payloads through oem channel
1922  * @link_index - index to a link with ddc in i2c mode
1923  * @cmd - i2c command structure
1924  * return - true if success, false otherwise.
1925  */
1926 bool dc_submit_i2c_oem(
1927                 struct dc *dc,
1928                 struct i2c_command *cmd);
1929
1930 enum aux_return_code_type;
1931 /* Attempt to transfer the given aux payload. This function does not perform
1932  * retries or handle error states. The reply is returned in the payload->reply
1933  * and the result through operation_result. Returns the number of bytes
1934  * transferred,or -1 on a failure.
1935  */
1936 int dc_link_aux_transfer_raw(struct ddc_service *ddc,
1937                 struct aux_payload *payload,
1938                 enum aux_return_code_type *operation_result);
1939
1940 bool dc_is_oem_i2c_device_present(
1941         struct dc *dc,
1942         size_t slave_address
1943 );
1944
1945 /* return true if the connected receiver supports the hdcp version */
1946 bool dc_link_is_hdcp14(struct dc_link *link, enum signal_type signal);
1947 bool dc_link_is_hdcp22(struct dc_link *link, enum signal_type signal);
1948
1949 /* Notify DC about DP RX Interrupt (aka DP IRQ_HPD).
1950  *
1951  * TODO - When defer_handling is true the function will have a different purpose.
1952  * It no longer does complete hpd rx irq handling. We should create a separate
1953  * interface specifically for this case.
1954  *
1955  * Return:
1956  * true - Downstream port status changed. DM should call DC to do the
1957  * detection.
1958  * false - no change in Downstream port status. No further action required
1959  * from DM.
1960  */
1961 bool dc_link_handle_hpd_rx_irq(struct dc_link *dc_link,
1962                 union hpd_irq_data *hpd_irq_dpcd_data, bool *out_link_loss,
1963                 bool defer_handling, bool *has_left_work);
1964 /* handle DP specs define test automation sequence*/
1965 void dc_link_dp_handle_automated_test(struct dc_link *link);
1966
1967 /* handle DP Link loss sequence and try to recover RX link loss with best
1968  * effort
1969  */
1970 void dc_link_dp_handle_link_loss(struct dc_link *link);
1971
1972 /* Determine if hpd rx irq should be handled or ignored
1973  * return true - hpd rx irq should be handled.
1974  * return false - it is safe to ignore hpd rx irq event
1975  */
1976 bool dc_link_dp_allow_hpd_rx_irq(const struct dc_link *link);
1977
1978 /* Determine if link loss is indicated with a given hpd_irq_dpcd_data.
1979  * @link - link the hpd irq data associated with
1980  * @hpd_irq_dpcd_data - input hpd irq data
1981  * return - true if hpd irq data indicates a link lost
1982  */
1983 bool dc_link_check_link_loss_status(struct dc_link *link,
1984                 union hpd_irq_data *hpd_irq_dpcd_data);
1985
1986 /* Read hpd rx irq data from a given link
1987  * @link - link where the hpd irq data should be read from
1988  * @irq_data - output hpd irq data
1989  * return - DC_OK if hpd irq data is read successfully, otherwise hpd irq data
1990  * read has failed.
1991  */
1992 enum dc_status dc_link_dp_read_hpd_rx_irq_data(
1993         struct dc_link *link,
1994         union hpd_irq_data *irq_data);
1995
1996 /* The function clears recorded DP RX states in the link. DM should call this
1997  * function when it is resuming from S3 power state to previously connected links.
1998  *
1999  * TODO - in the future we should consider to expand link resume interface to
2000  * support clearing previous rx states. So we don't have to rely on dm to call
2001  * this interface explicitly.
2002  */
2003 void dc_link_clear_dprx_states(struct dc_link *link);
2004
2005 /* Destruct the mst topology of the link and reset the allocated payload table
2006  *
2007  * NOTE: this should only be called if DM chooses not to call dc_link_detect but
2008  * still wants to reset MST topology on an unplug event */
2009 bool dc_link_reset_cur_dp_mst_topology(struct dc_link *link);
2010
2011 /* The function calculates effective DP link bandwidth when a given link is
2012  * using the given link settings.
2013  *
2014  * return - total effective link bandwidth in kbps.
2015  */
2016 uint32_t dc_link_bandwidth_kbps(
2017         const struct dc_link *link,
2018         const struct dc_link_settings *link_setting);
2019
2020 /* The function takes a snapshot of current link resource allocation state
2021  * @dc: pointer to dc of the dm calling this
2022  * @map: a dc link resource snapshot defined internally to dc.
2023  *
2024  * DM needs to capture a snapshot of current link resource allocation mapping
2025  * and store it in its persistent storage.
2026  *
2027  * Some of the link resource is using first come first serve policy.
2028  * The allocation mapping depends on original hotplug order. This information
2029  * is lost after driver is loaded next time. The snapshot is used in order to
2030  * restore link resource to its previous state so user will get consistent
2031  * link capability allocation across reboot.
2032  *
2033  */
2034 void dc_get_cur_link_res_map(const struct dc *dc, uint32_t *map);
2035
2036 /* This function restores link resource allocation state from a snapshot
2037  * @dc: pointer to dc of the dm calling this
2038  * @map: a dc link resource snapshot defined internally to dc.
2039  *
2040  * DM needs to call this function after initial link detection on boot and
2041  * before first commit streams to restore link resource allocation state
2042  * from previous boot session.
2043  *
2044  * Some of the link resource is using first come first serve policy.
2045  * The allocation mapping depends on original hotplug order. This information
2046  * is lost after driver is loaded next time. The snapshot is used in order to
2047  * restore link resource to its previous state so user will get consistent
2048  * link capability allocation across reboot.
2049  *
2050  */
2051 void dc_restore_link_res_map(const struct dc *dc, uint32_t *map);
2052
2053 /* TODO: this is not meant to be exposed to DM. Should switch to stream update
2054  * interface i.e stream_update->dsc_config
2055  */
2056 bool dc_link_update_dsc_config(struct pipe_ctx *pipe_ctx);
2057
2058 /* translate a raw link rate data to bandwidth in kbps */
2059 uint32_t dc_link_bw_kbps_from_raw_frl_link_rate_data(const struct dc *dc, uint8_t bw);
2060
2061 /* determine the optimal bandwidth given link and required bw.
2062  * @link - current detected link
2063  * @req_bw - requested bandwidth in kbps
2064  * @link_settings - returned most optimal link settings that can fit the
2065  * requested bandwidth
2066  * return - false if link can't support requested bandwidth, true if link
2067  * settings is found.
2068  */
2069 bool dc_link_decide_edp_link_settings(struct dc_link *link,
2070                 struct dc_link_settings *link_settings,
2071                 uint32_t req_bw);
2072
2073 /* return the max dp link settings can be driven by the link without considering
2074  * connected RX device and its capability
2075  */
2076 bool dc_link_dp_get_max_link_enc_cap(const struct dc_link *link,
2077                 struct dc_link_settings *max_link_enc_cap);
2078
2079 /* determine when the link is driving MST mode, what DP link channel coding
2080  * format will be used. The decision will remain unchanged until next HPD event.
2081  *
2082  * @link -  a link with DP RX connection
2083  * return - if stream is committed to this link with MST signal type, type of
2084  * channel coding format dc will choose.
2085  */
2086 enum dp_link_encoding dc_link_dp_mst_decide_link_encoding_format(
2087                 const struct dc_link *link);
2088
2089 /* get max dp link settings the link can enable with all things considered. (i.e
2090  * TX/RX/Cable capabilities and dp override policies.
2091  *
2092  * @link - a link with DP RX connection
2093  * return - max dp link settings the link can enable.
2094  *
2095  */
2096 const struct dc_link_settings *dc_link_get_link_cap(const struct dc_link *link);
2097
2098 /* Get the highest encoding format that the link supports; highest meaning the
2099  * encoding format which supports the maximum bandwidth.
2100  *
2101  * @link - a link with DP RX connection
2102  * return - highest encoding format link supports.
2103  */
2104 enum dc_link_encoding_format dc_link_get_highest_encoding_format(const struct dc_link *link);
2105
2106 /* Check if a RX (ex. DP sink, MST hub, passive or active dongle) is connected
2107  * to a link with dp connector signal type.
2108  * @link - a link with dp connector signal type
2109  * return - true if connected, false otherwise
2110  */
2111 bool dc_link_is_dp_sink_present(struct dc_link *link);
2112
2113 /* Force DP lane settings update to main-link video signal and notify the change
2114  * to DP RX via DPCD. This is a debug interface used for video signal integrity
2115  * tuning purpose. The interface assumes link has already been enabled with DP
2116  * signal.
2117  *
2118  * @lt_settings - a container structure with desired hw_lane_settings
2119  */
2120 void dc_link_set_drive_settings(struct dc *dc,
2121                                 struct link_training_settings *lt_settings,
2122                                 struct dc_link *link);
2123
2124 /* Enable a test pattern in Link or PHY layer in an active link for compliance
2125  * test or debugging purpose. The test pattern will remain until next un-plug.
2126  *
2127  * @link - active link with DP signal output enabled.
2128  * @test_pattern - desired test pattern to output.
2129  * NOTE: set to DP_TEST_PATTERN_VIDEO_MODE to disable previous test pattern.
2130  * @test_pattern_color_space - for video test pattern choose a desired color
2131  * space.
2132  * @p_link_settings - For PHY pattern choose a desired link settings
2133  * @p_custom_pattern - some test pattern will require a custom input to
2134  * customize some pattern details. Otherwise keep it to NULL.
2135  * @cust_pattern_size - size of the custom pattern input.
2136  *
2137  */
2138 bool dc_link_dp_set_test_pattern(
2139         struct dc_link *link,
2140         enum dp_test_pattern test_pattern,
2141         enum dp_test_pattern_color_space test_pattern_color_space,
2142         const struct link_training_settings *p_link_settings,
2143         const unsigned char *p_custom_pattern,
2144         unsigned int cust_pattern_size);
2145
2146 /* Force DP link settings to always use a specific value until reboot to a
2147  * specific link. If link has already been enabled, the interface will also
2148  * switch to desired link settings immediately. This is a debug interface to
2149  * generic dp issue trouble shooting.
2150  */
2151 void dc_link_set_preferred_link_settings(struct dc *dc,
2152                 struct dc_link_settings *link_setting,
2153                 struct dc_link *link);
2154
2155 /* Force DP link to customize a specific link training behavior by overriding to
2156  * standard DP specs defined protocol. This is a debug interface to trouble shoot
2157  * display specific link training issues or apply some display specific
2158  * workaround in link training.
2159  *
2160  * @link_settings - if not NULL, force preferred link settings to the link.
2161  * @lt_override - a set of override pointers. If any pointer is none NULL, dc
2162  * will apply this particular override in future link training. If NULL is
2163  * passed in, dc resets previous overrides.
2164  * NOTE: DM must keep the memory from override pointers until DM resets preferred
2165  * training settings.
2166  */
2167 void dc_link_set_preferred_training_settings(struct dc *dc,
2168                 struct dc_link_settings *link_setting,
2169                 struct dc_link_training_overrides *lt_overrides,
2170                 struct dc_link *link,
2171                 bool skip_immediate_retrain);
2172
2173 /* return - true if FEC is supported with connected DP RX, false otherwise */
2174 bool dc_link_is_fec_supported(const struct dc_link *link);
2175
2176 /* query FEC enablement policy to determine if FEC will be enabled by dc during
2177  * link enablement.
2178  * return - true if FEC should be enabled, false otherwise.
2179  */
2180 bool dc_link_should_enable_fec(const struct dc_link *link);
2181
2182 /* determine lttpr mode the current link should be enabled with a specific link
2183  * settings.
2184  */
2185 enum lttpr_mode dc_link_decide_lttpr_mode(struct dc_link *link,
2186                 struct dc_link_settings *link_setting);
2187
2188 /* Force DP RX to update its power state.
2189  * NOTE: this interface doesn't update dp main-link. Calling this function will
2190  * cause DP TX main-link and DP RX power states out of sync. DM has to restore
2191  * RX power state back upon finish DM specific execution requiring DP RX in a
2192  * specific power state.
2193  * @on - true to set DP RX in D0 power state, false to set DP RX in D3 power
2194  * state.
2195  */
2196 void dc_link_dp_receiver_power_ctrl(struct dc_link *link, bool on);
2197
2198 /* Force link to read base dp receiver caps from dpcd 000h - 00Fh and overwrite
2199  * current value read from extended receiver cap from 02200h - 0220Fh.
2200  * Some DP RX has problems of providing accurate DP receiver caps from extended
2201  * field, this interface is a workaround to revert link back to use base caps.
2202  */
2203 void dc_link_overwrite_extended_receiver_cap(
2204                 struct dc_link *link);
2205
2206 void dc_link_edp_panel_backlight_power_on(struct dc_link *link,
2207                 bool wait_for_hpd);
2208
2209 /* Set backlight level of an embedded panel (eDP, LVDS).
2210  * backlight_pwm_u16_16 is unsigned 32 bit with 16 bit integer
2211  * and 16 bit fractional, where 1.0 is max backlight value.
2212  */
2213 bool dc_link_set_backlight_level(const struct dc_link *dc_link,
2214                 struct set_backlight_level_params *backlight_level_params);
2215
2216 /* Set/get nits-based backlight level of an embedded panel (eDP, LVDS). */
2217 bool dc_link_set_backlight_level_nits(struct dc_link *link,
2218                 bool isHDR,
2219                 uint32_t backlight_millinits,
2220                 uint32_t transition_time_in_ms);
2221
2222 bool dc_link_get_backlight_level_nits(struct dc_link *link,
2223                 uint32_t *backlight_millinits,
2224                 uint32_t *backlight_millinits_peak);
2225
2226 int dc_link_get_backlight_level(const struct dc_link *dc_link);
2227
2228 int dc_link_get_target_backlight_pwm(const struct dc_link *link);
2229
2230 bool dc_link_set_psr_allow_active(struct dc_link *dc_link, const bool *enable,
2231                 bool wait, bool force_static, const unsigned int *power_opts);
2232
2233 bool dc_link_get_psr_state(const struct dc_link *dc_link, enum dc_psr_state *state);
2234
2235 bool dc_link_setup_psr(struct dc_link *dc_link,
2236                 const struct dc_stream_state *stream, struct psr_config *psr_config,
2237                 struct psr_context *psr_context);
2238
2239 /*
2240  * Communicate with DMUB to allow or disallow Panel Replay on the specified link:
2241  *
2242  * @link: pointer to the dc_link struct instance
2243  * @enable: enable(active) or disable(inactive) replay
2244  * @wait: state transition need to wait the active set completed.
2245  * @force_static: force disable(inactive) the replay
2246  * @power_opts: set power optimazation parameters to DMUB.
2247  *
2248  * return: allow Replay active will return true, else will return false.
2249  */
2250 bool dc_link_set_replay_allow_active(struct dc_link *dc_link, const bool *enable,
2251                 bool wait, bool force_static, const unsigned int *power_opts);
2252
2253 bool dc_link_get_replay_state(const struct dc_link *dc_link, uint64_t *state);
2254
2255 /* On eDP links this function call will stall until T12 has elapsed.
2256  * If the panel is not in power off state, this function will return
2257  * immediately.
2258  */
2259 bool dc_link_wait_for_t12(struct dc_link *link);
2260
2261 /* Determine if dp trace has been initialized to reflect upto date result *
2262  * return - true if trace is initialized and has valid data. False dp trace
2263  * doesn't have valid result.
2264  */
2265 bool dc_dp_trace_is_initialized(struct dc_link *link);
2266
2267 /* Query a dp trace flag to indicate if the current dp trace data has been
2268  * logged before
2269  */
2270 bool dc_dp_trace_is_logged(struct dc_link *link,
2271                 bool in_detection);
2272
2273 /* Set dp trace flag to indicate whether DM has already logged the current dp
2274  * trace data. DM can set is_logged to true upon logging and check
2275  * dc_dp_trace_is_logged before logging to avoid logging the same result twice.
2276  */
2277 void dc_dp_trace_set_is_logged_flag(struct dc_link *link,
2278                 bool in_detection,
2279                 bool is_logged);
2280
2281 /* Obtain driver time stamp for last dp link training end. The time stamp is
2282  * formatted based on dm_get_timestamp DM function.
2283  * @in_detection - true to get link training end time stamp of last link
2284  * training in detection sequence. false to get link training end time stamp
2285  * of last link training in commit (dpms) sequence
2286  */
2287 unsigned long long dc_dp_trace_get_lt_end_timestamp(struct dc_link *link,
2288                 bool in_detection);
2289
2290 /* Get how many link training attempts dc has done with latest sequence.
2291  * @in_detection - true to get link training count of last link
2292  * training in detection sequence. false to get link training count of last link
2293  * training in commit (dpms) sequence
2294  */
2295 const struct dp_trace_lt_counts *dc_dp_trace_get_lt_counts(struct dc_link *link,
2296                 bool in_detection);
2297
2298 /* Get how many link loss has happened since last link training attempts */
2299 unsigned int dc_dp_trace_get_link_loss_count(struct dc_link *link);
2300
2301 /*
2302  *  USB4 DPIA BW ALLOCATION PUBLIC FUNCTIONS
2303  */
2304 /*
2305  * Send a request from DP-Tx requesting to allocate BW remotely after
2306  * allocating it locally. This will get processed by CM and a CB function
2307  * will be called.
2308  *
2309  * @link: pointer to the dc_link struct instance
2310  * @req_bw: The requested bw in Kbyte to allocated
2311  *
2312  * return: none
2313  */
2314 void dc_link_set_usb4_req_bw_req(struct dc_link *link, int req_bw);
2315
2316 /*
2317  * Handle function for when the status of the Request above is complete.
2318  * We will find out the result of allocating on CM and update structs.
2319  *
2320  * @link: pointer to the dc_link struct instance
2321  * @bw: Allocated or Estimated BW depending on the result
2322  * @result: Response type
2323  *
2324  * return: none
2325  */
2326 void dc_link_handle_usb4_bw_alloc_response(struct dc_link *link,
2327                 uint8_t bw, uint8_t result);
2328
2329 /*
2330  * Handle the USB4 BW Allocation related functionality here:
2331  * Plug => Try to allocate max bw from timing parameters supported by the sink
2332  * Unplug => de-allocate bw
2333  *
2334  * @link: pointer to the dc_link struct instance
2335  * @peak_bw: Peak bw used by the link/sink
2336  *
2337  * return: allocated bw else return 0
2338  */
2339 int dc_link_dp_dpia_handle_usb4_bandwidth_allocation_for_link(
2340                 struct dc_link *link, int peak_bw);
2341
2342 /*
2343  * Validate the BW of all the valid DPIA links to make sure it doesn't exceed
2344  * available BW for each host router
2345  *
2346  * @dc: pointer to dc struct
2347  * @stream: pointer to all possible streams
2348  * @count: number of valid DPIA streams
2349  *
2350  * return: TRUE if bw used by DPIAs doesn't exceed available BW else return FALSE
2351  */
2352 bool dc_link_dp_dpia_validate(struct dc *dc, const struct dc_stream_state *streams,
2353                 const unsigned int count);
2354
2355 /* Sink Interfaces - A sink corresponds to a display output device */
2356
2357 struct dc_container_id {
2358         // 128bit GUID in binary form
2359         unsigned char  guid[16];
2360         // 8 byte port ID -> ELD.PortID
2361         unsigned int   portId[2];
2362         // 128bit GUID in binary formufacturer name -> ELD.ManufacturerName
2363         unsigned short manufacturerName;
2364         // 2 byte product code -> ELD.ProductCode
2365         unsigned short productCode;
2366 };
2367
2368
2369 struct dc_sink_dsc_caps {
2370         // 'true' if these are virtual DPCD's DSC caps (immediately upstream of sink in MST topology),
2371         // 'false' if they are sink's DSC caps
2372         bool is_virtual_dpcd_dsc;
2373         // 'true' if MST topology supports DSC passthrough for sink
2374         // 'false' if MST topology does not support DSC passthrough
2375         bool is_dsc_passthrough_supported;
2376         struct dsc_dec_dpcd_caps dsc_dec_caps;
2377 };
2378
2379 struct dc_sink_fec_caps {
2380         bool is_rx_fec_supported;
2381         bool is_topology_fec_supported;
2382 };
2383
2384 struct scdc_caps {
2385         union hdmi_scdc_manufacturer_OUI_data manufacturer_OUI;
2386         union hdmi_scdc_device_id_data device_id;
2387 };
2388
2389 /*
2390  * The sink structure contains EDID and other display device properties
2391  */
2392 struct dc_sink {
2393         enum signal_type sink_signal;
2394         struct dc_edid dc_edid; /* raw edid */
2395         struct dc_edid_caps edid_caps; /* parse display caps */
2396         struct dc_container_id *dc_container_id;
2397         uint32_t dongle_max_pix_clk;
2398         void *priv;
2399         struct stereo_3d_features features_3d[TIMING_3D_FORMAT_MAX];
2400         bool converter_disable_audio;
2401
2402         struct scdc_caps scdc_caps;
2403         struct dc_sink_dsc_caps dsc_caps;
2404         struct dc_sink_fec_caps fec_caps;
2405
2406         bool is_vsc_sdp_colorimetry_supported;
2407
2408         /* private to DC core */
2409         struct dc_link *link;
2410         struct dc_context *ctx;
2411
2412         uint32_t sink_id;
2413
2414         /* private to dc_sink.c */
2415         // refcount must be the last member in dc_sink, since we want the
2416         // sink structure to be logically cloneable up to (but not including)
2417         // refcount
2418         struct kref refcount;
2419 };
2420
2421 void dc_sink_retain(struct dc_sink *sink);
2422 void dc_sink_release(struct dc_sink *sink);
2423
2424 struct dc_sink_init_data {
2425         enum signal_type sink_signal;
2426         struct dc_link *link;
2427         uint32_t dongle_max_pix_clk;
2428         bool converter_disable_audio;
2429 };
2430
2431 struct dc_sink *dc_sink_create(const struct dc_sink_init_data *init_params);
2432
2433 /* Newer interfaces  */
2434 struct dc_cursor {
2435         struct dc_plane_address address;
2436         struct dc_cursor_attributes attributes;
2437 };
2438
2439
2440 /* Interrupt interfaces */
2441 enum dc_irq_source dc_interrupt_to_irq_source(
2442                 struct dc *dc,
2443                 uint32_t src_id,
2444                 uint32_t ext_id);
2445 bool dc_interrupt_set(struct dc *dc, enum dc_irq_source src, bool enable);
2446 void dc_interrupt_ack(struct dc *dc, enum dc_irq_source src);
2447 enum dc_irq_source dc_get_hpd_irq_source_at_index(
2448                 struct dc *dc, uint32_t link_index);
2449
2450 void dc_notify_vsync_int_state(struct dc *dc, struct dc_stream_state *stream, bool enable);
2451
2452 /* Power Interfaces */
2453
2454 void dc_set_power_state(
2455                 struct dc *dc,
2456                 enum dc_acpi_cm_power_state power_state);
2457 void dc_resume(struct dc *dc);
2458
2459 void dc_power_down_on_boot(struct dc *dc);
2460
2461 /*
2462  * HDCP Interfaces
2463  */
2464 enum hdcp_message_status dc_process_hdcp_msg(
2465                 enum signal_type signal,
2466                 struct dc_link *link,
2467                 struct hdcp_protection_message *message_info);
2468 bool dc_is_dmcu_initialized(struct dc *dc);
2469
2470 enum dc_status dc_set_clock(struct dc *dc, enum dc_clock_type clock_type, uint32_t clk_khz, uint32_t stepping);
2471 void dc_get_clock(struct dc *dc, enum dc_clock_type clock_type, struct dc_clock_config *clock_cfg);
2472
2473 bool dc_is_plane_eligible_for_idle_optimizations(struct dc *dc,
2474                 unsigned int pitch,
2475                 unsigned int height,
2476                 enum surface_pixel_format format,
2477                 struct dc_cursor_attributes *cursor_attr);
2478
2479 #define dc_allow_idle_optimizations(dc, allow) dc_allow_idle_optimizations_internal(dc, allow, __func__)
2480 #define dc_exit_ips_for_hw_access(dc) dc_exit_ips_for_hw_access_internal(dc, __func__)
2481
2482 void dc_allow_idle_optimizations_internal(struct dc *dc, bool allow, const char *caller_name);
2483 void dc_exit_ips_for_hw_access_internal(struct dc *dc, const char *caller_name);
2484 bool dc_dmub_is_ips_idle_state(struct dc *dc);
2485
2486 /* set min and max memory clock to lowest and highest DPM level, respectively */
2487 void dc_unlock_memory_clock_frequency(struct dc *dc);
2488
2489 /* set min memory clock to the min required for current mode, max to maxDPM */
2490 void dc_lock_memory_clock_frequency(struct dc *dc);
2491
2492 /* set soft max for memclk, to be used for AC/DC switching clock limitations */
2493 void dc_enable_dcmode_clk_limit(struct dc *dc, bool enable);
2494
2495 /* cleanup on driver unload */
2496 void dc_hardware_release(struct dc *dc);
2497
2498 /* disables fw based mclk switch */
2499 void dc_mclk_switch_using_fw_based_vblank_stretch_shut_down(struct dc *dc);
2500
2501 bool dc_set_psr_allow_active(struct dc *dc, bool enable);
2502
2503 bool dc_set_replay_allow_active(struct dc *dc, bool active);
2504
2505 bool dc_set_ips_disable(struct dc *dc, unsigned int disable_ips);
2506
2507 void dc_z10_restore(const struct dc *dc);
2508 void dc_z10_save_init(struct dc *dc);
2509
2510 bool dc_is_dmub_outbox_supported(struct dc *dc);
2511 bool dc_enable_dmub_notifications(struct dc *dc);
2512
2513 bool dc_abm_save_restore(
2514                 struct dc *dc,
2515                 struct dc_stream_state *stream,
2516                 struct abm_save_restore *pData);
2517
2518 void dc_enable_dmub_outbox(struct dc *dc);
2519
2520 bool dc_process_dmub_aux_transfer_async(struct dc *dc,
2521                                 uint32_t link_index,
2522                                 struct aux_payload *payload);
2523
2524 /* Get dc link index from dpia port index */
2525 uint8_t get_link_index_from_dpia_port_index(const struct dc *dc,
2526                                 uint8_t dpia_port_index);
2527
2528 bool dc_process_dmub_set_config_async(struct dc *dc,
2529                                 uint32_t link_index,
2530                                 struct set_config_cmd_payload *payload,
2531                                 struct dmub_notification *notify);
2532
2533 enum dc_status dc_process_dmub_set_mst_slots(const struct dc *dc,
2534                                 uint32_t link_index,
2535                                 uint8_t mst_alloc_slots,
2536                                 uint8_t *mst_slots_in_use);
2537
2538 void dc_process_dmub_dpia_set_tps_notification(const struct dc *dc, uint32_t link_index, uint8_t tps);
2539
2540 void dc_process_dmub_dpia_hpd_int_enable(const struct dc *dc,
2541                                 uint32_t hpd_int_enable);
2542
2543 void dc_print_dmub_diagnostic_data(const struct dc *dc);
2544
2545 void dc_query_current_properties(struct dc *dc, struct dc_current_properties *properties);
2546
2547 struct dc_power_profile {
2548         int power_level; /* Lower is better */
2549 };
2550
2551 struct dc_power_profile dc_get_power_profile_for_dc_state(const struct dc_state *context);
2552
2553 /* DSC Interfaces */
2554 #include "dc_dsc.h"
2555
2556 /* Disable acc mode Interfaces */
2557 void dc_disable_accelerated_mode(struct dc *dc);
2558
2559 bool dc_is_timing_changed(struct dc_stream_state *cur_stream,
2560                        struct dc_stream_state *new_stream);
2561
2562 #endif /* DC_INTERFACE_H_ */