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