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_STREAM_H_ 27 #define DC_STREAM_H_ 28 29 #include "dc_types.h" 30 #include "grph_object_defs.h" 31 32 /******************************************************************************* 33 * Stream Interfaces 34 ******************************************************************************/ 35 struct timing_sync_info { 36 int group_id; 37 int group_size; 38 bool master; 39 }; 40 41 struct mall_stream_config { 42 /* MALL stream config to indicate if the stream is phantom or not. 43 * We will use a phantom stream to indicate that the pipe is phantom. 44 */ 45 enum mall_stream_type type; 46 struct dc_stream_state *paired_stream; // master / slave stream 47 bool subvp_limit_cursor_size; /* stream has/is using subvp limiting hw cursor support */ 48 bool cursor_size_limit_subvp; /* stream is using hw cursor config preventing subvp */ 49 }; 50 51 struct dc_stream_status { 52 int primary_otg_inst; 53 int stream_enc_inst; 54 55 /** 56 * @plane_count: Total of planes attached to a single stream 57 */ 58 int plane_count; 59 int audio_inst; 60 struct timing_sync_info timing_sync_info; 61 struct dc_plane_state *plane_states[MAX_SURFACES]; 62 bool is_abm_supported; 63 struct mall_stream_config mall_stream_config; 64 bool fpo_in_use; 65 }; 66 67 68 struct dc_writeback_info { 69 bool wb_enabled; 70 int dwb_pipe_inst; 71 struct dc_dwb_params dwb_params; 72 struct mcif_buf_params mcif_buf_params; 73 struct mcif_warmup_params mcif_warmup_params; 74 /* the plane that is the input to TOP_MUX for MPCC that is the DWB source */ 75 struct dc_plane_state *writeback_source_plane; 76 /* source MPCC instance. for use by internally by dc */ 77 int mpcc_inst; 78 }; 79 80 struct dc_writeback_update { 81 unsigned int num_wb_info; 82 struct dc_writeback_info writeback_info[MAX_DWB_PIPES]; 83 }; 84 85 enum vertical_interrupt_ref_point { 86 START_V_UPDATE = 0, 87 START_V_SYNC, 88 INVALID_POINT 89 90 //For now, only v_update interrupt is used. 91 //START_V_BLANK, 92 //START_V_ACTIVE 93 }; 94 95 struct periodic_interrupt_config { 96 enum vertical_interrupt_ref_point ref_point; 97 int lines_offset; 98 }; 99 100 struct dc_mst_stream_bw_update { 101 bool is_increase; // is bandwidth reduced or increased 102 uint32_t mst_stream_bw; // new mst bandwidth in kbps 103 }; 104 105 union stream_update_flags { 106 struct { 107 uint32_t scaling:1; 108 uint32_t out_tf:1; 109 uint32_t out_csc:1; 110 uint32_t abm_level:1; 111 uint32_t dpms_off:1; 112 uint32_t gamut_remap:1; 113 uint32_t wb_update:1; 114 uint32_t dsc_changed : 1; 115 uint32_t mst_bw : 1; 116 uint32_t crtc_timing_adjust : 1; 117 uint32_t fams_changed : 1; 118 uint32_t scaler_sharpener : 1; 119 uint32_t sharpening_required : 1; 120 uint32_t cursor_attr : 1; 121 uint32_t cursor_pos : 1; 122 uint32_t periodic_interrupt : 1; 123 uint32_t info_frame : 1; 124 uint32_t dmdata : 1; 125 uint32_t dither : 1; 126 } bits; 127 128 uint32_t raw; 129 }; 130 131 static inline void stream_update_flags_clear(union stream_update_flags *flags) 132 { 133 flags->raw = 0; 134 } 135 136 static inline void stream_update_flags_set_full(union stream_update_flags *flags) 137 { 138 stream_update_flags_clear(flags); 139 flags->bits.scaling = 1; 140 flags->bits.out_tf = 1; 141 flags->bits.out_csc = 1; 142 flags->bits.abm_level = 1; 143 flags->bits.dpms_off = 1; 144 flags->bits.gamut_remap = 1; 145 flags->bits.wb_update = 1; 146 flags->bits.dsc_changed = 1; 147 flags->bits.mst_bw = 1; 148 flags->bits.crtc_timing_adjust = 1; 149 flags->bits.fams_changed = 1; 150 flags->bits.scaler_sharpener = 1; 151 flags->bits.sharpening_required = 1; 152 flags->bits.cursor_attr = 1; 153 flags->bits.cursor_pos = 1; 154 flags->bits.periodic_interrupt = 1; 155 flags->bits.info_frame = 1; 156 flags->bits.dmdata = 1; 157 flags->bits.dither = 1; 158 } 159 160 struct test_pattern { 161 enum dp_test_pattern type; 162 enum dp_test_pattern_color_space color_space; 163 struct link_training_settings const *p_link_settings; 164 unsigned char const *p_custom_pattern; 165 unsigned int cust_pattern_size; 166 }; 167 168 #define SUBVP_DRR_MARGIN_US 100 // 100us for DRR margin (SubVP + DRR) 169 170 struct dc_stream_debug_options { 171 uint8_t force_odm_combine_segments; 172 /* 173 * When force_odm_combine_segments is non zero, allow dc to 174 * temporarily transition to ODM bypass when minimal transition state 175 * is required to prevent visual glitches showing on the screen 176 */ 177 uint8_t allow_transition_for_forced_odm; 178 }; 179 180 #define LUMINANCE_DATA_TABLE_SIZE 10 181 182 struct luminance_data { 183 bool is_valid; 184 int refresh_rate_hz[LUMINANCE_DATA_TABLE_SIZE]; 185 int luminance_millinits[LUMINANCE_DATA_TABLE_SIZE]; 186 int flicker_criteria_milli_nits_GAMING; 187 int flicker_criteria_milli_nits_STATIC; 188 unsigned int nominal_refresh_rate; 189 unsigned int dm_max_decrease_from_nominal; 190 }; 191 192 enum dc_drr_trigger_mode { 193 DRR_TRIGGER_ON_FLIP = 0, 194 DRR_TRIGGER_ON_FLIP_AND_CURSOR, 195 }; 196 197 struct dc_stream_state { 198 // sink is deprecated, new code should not reference 199 // this pointer 200 struct dc_sink *sink; 201 202 struct dc_link *link; 203 /* For dynamic link encoder assignment, update the link encoder assigned to 204 * a stream via the volatile dc_state rather than the static dc_link. 205 */ 206 struct link_encoder *link_enc; 207 struct dc_stream_debug_options debug; 208 struct dc_panel_patch sink_patches; 209 struct dc_crtc_timing timing; 210 struct dc_crtc_timing_adjust adjust; 211 struct dc_info_packet vrr_infopacket; 212 struct dc_info_packet vsc_infopacket; 213 struct dc_info_packet vsp_infopacket; 214 struct dc_info_packet hfvsif_infopacket; 215 struct dc_info_packet vtem_infopacket; 216 struct dc_info_packet adaptive_sync_infopacket; 217 struct dc_info_packet avi_infopacket; 218 uint8_t dsc_packed_pps[128]; 219 struct rect src; /* composition area */ 220 struct rect dst; /* stream addressable area */ 221 222 struct audio_info audio_info; 223 224 struct dc_info_packet hdr_static_metadata; 225 PHYSICAL_ADDRESS_LOC dmdata_address; 226 bool use_dynamic_meta; 227 228 struct dc_transfer_func out_transfer_func; 229 struct colorspace_transform gamut_remap_matrix; 230 struct dc_csc_transform csc_color_matrix; 231 232 enum dc_color_space output_color_space; 233 enum display_content_type content_type; 234 enum dc_dither_option dither_option; 235 236 enum view_3d_format view_format; 237 238 bool use_vsc_sdp_for_colorimetry; 239 bool ignore_msa_timing_param; 240 241 /** 242 * @allow_freesync: 243 * 244 * It say if Freesync is enabled or not. 245 */ 246 bool allow_freesync; 247 248 /** 249 * @vrr_active_variable: 250 * 251 * It describes if VRR is in use. 252 */ 253 bool vrr_active_variable; 254 bool freesync_on_desktop; 255 bool vrr_active_fixed; 256 257 bool converter_disable_audio; 258 uint8_t qs_bit; 259 uint8_t qy_bit; 260 261 /* TODO: custom INFO packets */ 262 /* TODO: ABM info (DMCU) */ 263 /* TODO: CEA VIC */ 264 265 /* DMCU info */ 266 unsigned int abm_level; 267 268 struct periodic_interrupt_config periodic_interrupt; 269 270 /* from core_stream struct */ 271 struct dc_context *ctx; 272 273 /* used by DCP and FMT */ 274 struct bit_depth_reduction_params bit_depth_params; 275 struct clamping_and_pixel_encoding_params clamping; 276 277 int phy_pix_clk; 278 enum signal_type signal; 279 bool dpms_off; 280 281 void *dm_stream_context; 282 283 struct dc_cursor_attributes cursor_attributes; 284 struct dc_cursor_position cursor_position; 285 bool hw_cursor_req; 286 287 uint32_t sdr_white_level; // for boosting (SDR) cursor in HDR mode 288 289 /* from stream struct */ 290 struct kref refcount; 291 292 struct crtc_trigger_info triggered_crtc_reset; 293 294 /* writeback */ 295 unsigned int num_wb_info; 296 struct dc_writeback_info writeback_info[MAX_DWB_PIPES]; 297 const struct dc_transfer_func *func_shaper; 298 const struct dc_3dlut *lut3d_func; 299 /* Computed state bits */ 300 bool mode_changed : 1; 301 302 /* Output from DC when stream state is committed or altered 303 * DC may only access these values during: 304 * dc_commit_state, dc_commit_state_no_check, dc_commit_streams 305 * values may not change outside of those calls 306 */ 307 struct { 308 // For interrupt management, some hardware instance 309 // offsets need to be exposed to DM 310 uint8_t otg_offset; 311 } out; 312 313 bool apply_edp_fast_boot_optimization; 314 bool apply_seamless_boot_optimization; 315 uint32_t apply_boot_odm_mode; 316 317 uint32_t stream_id; 318 319 struct test_pattern test_pattern; 320 union stream_update_flags update_flags; 321 322 bool has_non_synchronizable_pclk; 323 bool vblank_synchronized; 324 bool is_phantom; 325 326 struct luminance_data lumin_data; 327 bool scaler_sharpener_update; 328 bool sharpening_required; 329 330 enum dc_drr_trigger_mode drr_trigger_mode; 331 332 struct dc_update_scratch_space *update_scratch; 333 bool firmware_controlled_hdr_info_packet; 334 }; 335 336 #define ABM_LEVEL_IMMEDIATE_DISABLE 255 337 338 struct dc_stream_update { 339 struct dc_stream_state *stream; 340 341 struct rect src; 342 struct rect dst; 343 struct dc_transfer_func *out_transfer_func; 344 struct dc_info_packet *hdr_static_metadata; 345 unsigned int *abm_level; 346 347 struct periodic_interrupt_config *periodic_interrupt; 348 349 struct dc_info_packet *vrr_infopacket; 350 struct dc_info_packet *vsc_infopacket; 351 struct dc_info_packet *vsp_infopacket; 352 struct dc_info_packet *hfvsif_infopacket; 353 struct dc_info_packet *vtem_infopacket; 354 struct dc_info_packet *adaptive_sync_infopacket; 355 struct dc_info_packet *avi_infopacket; 356 357 bool *dpms_off; 358 bool integer_scaling_update; 359 bool *allow_freesync; 360 bool *vrr_active_variable; 361 bool *vrr_active_fixed; 362 363 struct colorspace_transform *gamut_remap; 364 enum dc_color_space *output_color_space; 365 enum dc_dither_option *dither_option; 366 367 struct dc_csc_transform *output_csc_transform; 368 369 struct dc_writeback_update *wb_update; 370 struct dc_dsc_config *dsc_config; 371 struct dc_mst_stream_bw_update *mst_bw_update; 372 struct dc_transfer_func *func_shaper; 373 struct dc_3dlut *lut3d_func; 374 375 struct test_pattern *pending_test_pattern; 376 struct dc_crtc_timing_adjust *crtc_timing_adjust; 377 378 struct dc_cursor_attributes *cursor_attributes; 379 struct dc_cursor_position *cursor_position; 380 bool *hw_cursor_req; 381 bool *scaler_sharpener_update; 382 bool *sharpening_required; 383 384 enum dc_drr_trigger_mode *drr_trigger_mode; 385 }; 386 387 bool dc_is_stream_unchanged( 388 struct dc_stream_state *old_stream, struct dc_stream_state *stream); 389 bool dc_is_stream_scaling_unchanged( 390 struct dc_stream_state *old_stream, struct dc_stream_state *stream); 391 392 /* 393 * Setup stream attributes if no stream updates are provided 394 * there will be no impact on the stream parameters 395 * 396 * Set up surface attributes and associate to a stream 397 * The surfaces parameter is an absolute set of all surface active for the stream. 398 * If no surfaces are provided, the stream will be blanked; no memory read. 399 * Any flip related attribute changes must be done through this interface. 400 * 401 * After this call: 402 * Surfaces attributes are programmed and configured to be composed into stream. 403 * This does not trigger a flip. No surface address is programmed. 404 * 405 */ 406 bool dc_update_planes_and_stream(struct dc *dc, 407 struct dc_surface_update *surface_updates, int surface_count, 408 struct dc_stream_state *dc_stream, 409 struct dc_stream_update *stream_update); 410 411 struct dc_update_scratch_space; 412 413 size_t dc_update_scratch_space_size(void); 414 415 struct dc_update_scratch_space *dc_update_planes_and_stream_init( 416 struct dc *dc, 417 struct dc_surface_update *surface_updates, 418 int surface_count, 419 struct dc_stream_state *dc_stream, 420 struct dc_stream_update *stream_update 421 ); 422 423 // Locked, false is failed 424 bool dc_update_planes_and_stream_prepare( 425 struct dc_update_scratch_space *scratch 426 ); 427 428 // Unlocked 429 void dc_update_planes_and_stream_execute( 430 const struct dc_update_scratch_space *scratch 431 ); 432 433 // Locked, true if call again 434 bool dc_update_planes_and_stream_cleanup( 435 struct dc_update_scratch_space *scratch 436 ); 437 438 /* 439 * Set up surface attributes and associate to a stream 440 * The surfaces parameter is an absolute set of all surface active for the stream. 441 * If no surfaces are provided, the stream will be blanked; no memory read. 442 * Any flip related attribute changes must be done through this interface. 443 * 444 * After this call: 445 * Surfaces attributes are programmed and configured to be composed into stream. 446 * This does not trigger a flip. No surface address is programmed. 447 */ 448 void dc_commit_updates_for_stream(struct dc *dc, 449 struct dc_surface_update *srf_updates, 450 int surface_count, 451 struct dc_stream_state *stream, 452 struct dc_stream_update *stream_update, 453 struct dc_state *state); 454 /* 455 * Log the current stream state. 456 */ 457 void dc_stream_log(const struct dc *dc, const struct dc_stream_state *stream); 458 459 uint8_t dc_get_current_stream_count(struct dc *dc); 460 struct dc_stream_state *dc_get_stream_at_index(struct dc *dc, uint8_t i); 461 462 /* 463 * Return the current frame counter. 464 */ 465 uint32_t dc_stream_get_vblank_counter(const struct dc_stream_state *stream); 466 467 /* 468 * Send dp sdp message. 469 */ 470 bool dc_stream_send_dp_sdp(const struct dc_stream_state *stream, 471 const uint8_t *custom_sdp_message, 472 unsigned int sdp_message_size); 473 474 /* TODO: Return parsed values rather than direct register read 475 * This has a dependency on the caller (amdgpu_display_get_crtc_scanoutpos) 476 * being refactored properly to be dce-specific 477 */ 478 bool dc_stream_get_scanoutpos(const struct dc_stream_state *stream, 479 uint32_t *v_blank_start, 480 uint32_t *v_blank_end, 481 uint32_t *h_position, 482 uint32_t *v_position); 483 484 bool dc_stream_add_writeback(struct dc *dc, 485 struct dc_stream_state *stream, 486 struct dc_writeback_info *wb_info); 487 488 bool dc_stream_fc_disable_writeback(struct dc *dc, 489 struct dc_stream_state *stream, 490 uint32_t dwb_pipe_inst); 491 492 bool dc_stream_remove_writeback(struct dc *dc, 493 struct dc_stream_state *stream, 494 uint32_t dwb_pipe_inst); 495 496 enum dc_status dc_stream_add_dsc_to_resource(struct dc *dc, 497 struct dc_state *state, 498 struct dc_stream_state *stream); 499 500 bool dc_stream_dmdata_status_done(struct dc *dc, struct dc_stream_state *stream); 501 502 bool dc_stream_set_dynamic_metadata(struct dc *dc, 503 struct dc_stream_state *stream, 504 struct dc_dmdata_attributes *dmdata_attr); 505 506 enum dc_status dc_validate_stream(struct dc *dc, struct dc_stream_state *stream); 507 508 /* 509 * Enable stereo when commit_streams is not required, 510 * for example, frame alternate. 511 */ 512 void dc_enable_stereo( 513 struct dc *dc, 514 struct dc_state *context, 515 struct dc_stream_state *streams[], 516 uint8_t stream_count); 517 518 /* Triggers multi-stream synchronization. */ 519 void dc_trigger_sync(struct dc *dc, struct dc_state *context); 520 521 struct surface_update_descriptor dc_check_update_surfaces_for_stream( 522 const struct dc_check_config *check_config, 523 struct dc_surface_update *updates, 524 int surface_count, 525 struct dc_stream_update *stream_update); 526 527 struct dc_link *dc_stream_get_link( 528 const struct dc_stream_state *dc_stream); 529 530 /** 531 * Create a new default stream for the requested sink 532 */ 533 struct dc_stream_state *dc_create_stream_for_sink(struct dc_sink *dc_sink); 534 535 struct dc_stream_state *dc_copy_stream(const struct dc_stream_state *stream); 536 537 void update_stream_signal(struct dc_stream_state *stream, struct dc_sink *sink); 538 539 void dc_stream_retain(struct dc_stream_state *dc_stream); 540 void dc_stream_release(struct dc_stream_state *dc_stream); 541 542 struct dc_stream_status *dc_stream_get_status(struct dc_stream_state *dc_stream); 543 const struct dc_stream_status *dc_stream_get_status_const(const struct dc_stream_state *dc_stream); 544 545 /******************************************************************************* 546 * Cursor interfaces - To manages the cursor within a stream 547 ******************************************************************************/ 548 /* TODO: Deprecated once we switch to dc_set_cursor_position */ 549 550 void program_cursor_attributes( 551 struct dc *dc, 552 struct dc_stream_state *stream); 553 554 void program_cursor_position( 555 struct dc *dc, 556 struct dc_stream_state *stream); 557 558 bool dc_stream_check_cursor_attributes( 559 const struct dc_stream_state *stream, 560 struct dc_state *state, 561 const struct dc_cursor_attributes *attributes); 562 563 bool dc_stream_set_cursor_attributes( 564 struct dc_stream_state *stream, 565 const struct dc_cursor_attributes *attributes); 566 567 bool dc_stream_program_cursor_attributes( 568 struct dc_stream_state *stream, 569 const struct dc_cursor_attributes *attributes); 570 571 bool dc_stream_set_cursor_position( 572 struct dc_stream_state *stream, 573 const struct dc_cursor_position *position); 574 575 bool dc_stream_program_cursor_position( 576 struct dc_stream_state *stream, 577 const struct dc_cursor_position *position); 578 579 580 bool dc_stream_adjust_vmin_vmax(struct dc *dc, 581 struct dc_stream_state *stream, 582 struct dc_crtc_timing_adjust *adjust); 583 584 bool dc_stream_get_last_used_drr_vtotal(struct dc *dc, 585 struct dc_stream_state *stream, 586 uint32_t *refresh_rate); 587 588 #if defined(CONFIG_DRM_AMD_SECURE_DISPLAY) 589 bool dc_stream_forward_crc_window(struct dc_stream_state *stream, 590 struct rect *rect, 591 uint8_t phy_id, 592 bool is_stop); 593 594 bool dc_stream_forward_multiple_crc_window(struct dc_stream_state *stream, 595 struct crc_window *window, 596 uint8_t phy_id, 597 bool stop); 598 #endif 599 600 bool dc_stream_configure_crc(struct dc *dc, 601 struct dc_stream_state *stream, 602 struct crc_params *crc_window, 603 bool enable, 604 bool continuous, 605 uint8_t idx, 606 bool reset, 607 enum crc_poly_mode crc_poly_mode); 608 609 bool dc_stream_get_crc(struct dc *dc, 610 struct dc_stream_state *stream, 611 uint8_t idx, 612 uint32_t *r_cr, 613 uint32_t *g_y, 614 uint32_t *b_cb); 615 616 void dc_stream_set_static_screen_params(struct dc *dc, 617 struct dc_stream_state **stream, 618 int num_streams, 619 const struct dc_static_screen_params *params); 620 621 void dc_stream_set_dyn_expansion(struct dc *dc, struct dc_stream_state *stream, 622 enum dc_dynamic_expansion option); 623 624 void dc_stream_set_dither_option(struct dc_stream_state *stream, 625 enum dc_dither_option option); 626 627 bool dc_stream_set_gamut_remap(struct dc *dc, 628 const struct dc_stream_state *stream); 629 630 bool dc_stream_program_csc_matrix(struct dc *dc, 631 struct dc_stream_state *stream); 632 633 struct dc_rmcm_3dlut *dc_stream_get_3dlut_for_stream( 634 const struct dc *dc, 635 const struct dc_stream_state *stream, 636 bool allocate_one); 637 638 void dc_stream_release_3dlut_for_stream( 639 const struct dc *dc, 640 const struct dc_stream_state *stream); 641 642 void dc_stream_init_rmcm_3dlut(struct dc *dc); 643 644 struct pipe_ctx *dc_stream_get_pipe_ctx(struct dc_stream_state *stream); 645 646 void dc_dmub_update_dirty_rect(struct dc *dc, 647 int surface_count, 648 struct dc_stream_state *stream, 649 const struct dc_surface_update *srf_updates, 650 struct dc_state *context); 651 652 bool dc_stream_is_cursor_limit_pending(struct dc *dc, struct dc_stream_state *stream); 653 bool dc_stream_can_clear_cursor_limit(struct dc *dc, struct dc_stream_state *stream); 654 655 #endif /* DC_STREAM_H_ */ 656