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