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