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