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 dc_stream_status { 42 int primary_otg_inst; 43 int stream_enc_inst; 44 45 /** 46 * @plane_count: Total of planes attached to a single stream 47 */ 48 int plane_count; 49 int audio_inst; 50 struct timing_sync_info timing_sync_info; 51 struct dc_plane_state *plane_states[MAX_SURFACE_NUM]; 52 bool is_abm_supported; 53 }; 54 55 enum hubp_dmdata_mode { 56 DMDATA_SW_MODE, 57 DMDATA_HW_MODE 58 }; 59 60 struct dc_dmdata_attributes { 61 /* Specifies whether dynamic meta data will be updated by software 62 * or has to be fetched by hardware (DMA mode) 63 */ 64 enum hubp_dmdata_mode dmdata_mode; 65 /* Specifies if current dynamic meta data is to be used only for the current frame */ 66 bool dmdata_repeat; 67 /* Specifies the size of Dynamic Metadata surface in byte. Size of 0 means no Dynamic metadata is fetched */ 68 uint32_t dmdata_size; 69 /* Specifies if a new dynamic meta data should be fetched for an upcoming frame */ 70 bool dmdata_updated; 71 /* If hardware mode is used, the base address where DMDATA surface is located */ 72 PHYSICAL_ADDRESS_LOC address; 73 /* Specifies whether QOS level will be provided by TTU or it will come from DMDATA_QOS_LEVEL */ 74 bool dmdata_qos_mode; 75 /* If qos_mode = 1, this is the QOS value to be used: */ 76 uint32_t dmdata_qos_level; 77 /* Specifies the value in unit of REFCLK cycles to be added to the 78 * current time to produce the Amortized deadline for Dynamic Metadata chunk request 79 */ 80 uint32_t dmdata_dl_delta; 81 /* An unbounded array of uint32s, represents software dmdata to be loaded */ 82 uint32_t *dmdata_sw_data; 83 }; 84 85 struct dc_writeback_info { 86 bool wb_enabled; 87 int dwb_pipe_inst; 88 struct dc_dwb_params dwb_params; 89 struct mcif_buf_params mcif_buf_params; 90 struct mcif_warmup_params mcif_warmup_params; 91 /* the plane that is the input to TOP_MUX for MPCC that is the DWB source */ 92 struct dc_plane_state *writeback_source_plane; 93 /* source MPCC instance. for use by internally by dc */ 94 int mpcc_inst; 95 }; 96 97 struct dc_writeback_update { 98 unsigned int num_wb_info; 99 struct dc_writeback_info writeback_info[MAX_DWB_PIPES]; 100 }; 101 102 enum vertical_interrupt_ref_point { 103 START_V_UPDATE = 0, 104 START_V_SYNC, 105 INVALID_POINT 106 107 //For now, only v_update interrupt is used. 108 //START_V_BLANK, 109 //START_V_ACTIVE 110 }; 111 112 struct periodic_interrupt_config { 113 enum vertical_interrupt_ref_point ref_point; 114 int lines_offset; 115 }; 116 117 struct dc_mst_stream_bw_update { 118 bool is_increase; // is bandwidth reduced or increased 119 uint32_t mst_stream_bw; // new mst bandwidth in kbps 120 }; 121 122 union stream_update_flags { 123 struct { 124 uint32_t scaling:1; 125 uint32_t out_tf:1; 126 uint32_t out_csc:1; 127 uint32_t abm_level:1; 128 uint32_t dpms_off:1; 129 uint32_t gamut_remap:1; 130 uint32_t wb_update:1; 131 uint32_t dsc_changed : 1; 132 uint32_t mst_bw : 1; 133 uint32_t crtc_timing_adjust : 1; 134 uint32_t fams_changed : 1; 135 } bits; 136 137 uint32_t raw; 138 }; 139 140 struct test_pattern { 141 enum dp_test_pattern type; 142 enum dp_test_pattern_color_space color_space; 143 struct link_training_settings const *p_link_settings; 144 unsigned char const *p_custom_pattern; 145 unsigned int cust_pattern_size; 146 }; 147 148 #define SUBVP_DRR_MARGIN_US 100 // 100us for DRR margin (SubVP + DRR) 149 150 enum mall_stream_type { 151 SUBVP_NONE, // subvp not in use 152 SUBVP_MAIN, // subvp in use, this stream is main stream 153 SUBVP_PHANTOM, // subvp in use, this stream is a phantom stream 154 }; 155 156 struct mall_stream_config { 157 /* MALL stream config to indicate if the stream is phantom or not. 158 * We will use a phantom stream to indicate that the pipe is phantom. 159 */ 160 enum mall_stream_type type; 161 struct dc_stream_state *paired_stream; // master / slave stream 162 }; 163 164 /* Temp struct used to save and restore MALL config 165 * during validation. 166 * 167 * TODO: Move MALL config into dc_state instead of stream struct 168 * to avoid needing to save/restore. 169 */ 170 struct mall_temp_config { 171 struct mall_stream_config mall_stream_config[MAX_PIPES]; 172 bool is_phantom_plane[MAX_PIPES]; 173 }; 174 175 struct dc_stream_debug_options { 176 char force_odm_combine_segments; 177 }; 178 179 struct dc_stream_state { 180 // sink is deprecated, new code should not reference 181 // this pointer 182 struct dc_sink *sink; 183 184 struct dc_link *link; 185 /* For dynamic link encoder assignment, update the link encoder assigned to 186 * a stream via the volatile dc_state rather than the static dc_link. 187 */ 188 struct link_encoder *link_enc; 189 struct dc_stream_debug_options debug; 190 struct dc_panel_patch sink_patches; 191 union display_content_support content_support; 192 struct dc_crtc_timing timing; 193 struct dc_crtc_timing_adjust adjust; 194 struct dc_info_packet vrr_infopacket; 195 struct dc_info_packet vsc_infopacket; 196 struct dc_info_packet vsp_infopacket; 197 struct dc_info_packet hfvsif_infopacket; 198 struct dc_info_packet vtem_infopacket; 199 struct dc_info_packet adaptive_sync_infopacket; 200 uint8_t dsc_packed_pps[128]; 201 struct rect src; /* composition area */ 202 struct rect dst; /* stream addressable area */ 203 204 struct audio_info audio_info; 205 206 struct dc_info_packet hdr_static_metadata; 207 PHYSICAL_ADDRESS_LOC dmdata_address; 208 bool use_dynamic_meta; 209 210 struct dc_transfer_func *out_transfer_func; 211 struct colorspace_transform gamut_remap_matrix; 212 struct dc_csc_transform csc_color_matrix; 213 214 enum dc_color_space output_color_space; 215 enum dc_dither_option dither_option; 216 217 enum view_3d_format view_format; 218 219 bool use_vsc_sdp_for_colorimetry; 220 bool ignore_msa_timing_param; 221 222 /** 223 * @allow_freesync: 224 * 225 * It say if Freesync is enabled or not. 226 */ 227 bool allow_freesync; 228 229 /** 230 * @vrr_active_variable: 231 * 232 * It describes if VRR is in use. 233 */ 234 bool vrr_active_variable; 235 bool freesync_on_desktop; 236 237 bool converter_disable_audio; 238 uint8_t qs_bit; 239 uint8_t qy_bit; 240 241 /* TODO: custom INFO packets */ 242 /* TODO: ABM info (DMCU) */ 243 /* TODO: CEA VIC */ 244 245 /* DMCU info */ 246 unsigned int abm_level; 247 248 struct periodic_interrupt_config periodic_interrupt; 249 250 /* from core_stream struct */ 251 struct dc_context *ctx; 252 253 /* used by DCP and FMT */ 254 struct bit_depth_reduction_params bit_depth_params; 255 struct clamping_and_pixel_encoding_params clamping; 256 257 int phy_pix_clk; 258 enum signal_type signal; 259 bool dpms_off; 260 261 void *dm_stream_context; 262 263 struct dc_cursor_attributes cursor_attributes; 264 struct dc_cursor_position cursor_position; 265 uint32_t sdr_white_level; // for boosting (SDR) cursor in HDR mode 266 267 /* from stream struct */ 268 struct kref refcount; 269 270 struct crtc_trigger_info triggered_crtc_reset; 271 272 /* writeback */ 273 unsigned int num_wb_info; 274 struct dc_writeback_info writeback_info[MAX_DWB_PIPES]; 275 const struct dc_transfer_func *func_shaper; 276 const struct dc_3dlut *lut3d_func; 277 /* Computed state bits */ 278 bool mode_changed : 1; 279 280 /* Output from DC when stream state is committed or altered 281 * DC may only access these values during: 282 * dc_commit_state, dc_commit_state_no_check, dc_commit_streams 283 * values may not change outside of those calls 284 */ 285 struct { 286 // For interrupt management, some hardware instance 287 // offsets need to be exposed to DM 288 uint8_t otg_offset; 289 } out; 290 291 bool apply_edp_fast_boot_optimization; 292 bool apply_seamless_boot_optimization; 293 uint32_t apply_boot_odm_mode; 294 295 uint32_t stream_id; 296 297 struct test_pattern test_pattern; 298 union stream_update_flags update_flags; 299 300 bool has_non_synchronizable_pclk; 301 bool vblank_synchronized; 302 bool fpo_in_use; 303 struct mall_stream_config mall_stream_config; 304 }; 305 306 #define ABM_LEVEL_IMMEDIATE_DISABLE 255 307 308 struct dc_stream_update { 309 struct dc_stream_state *stream; 310 311 struct rect src; 312 struct rect dst; 313 struct dc_transfer_func *out_transfer_func; 314 struct dc_info_packet *hdr_static_metadata; 315 unsigned int *abm_level; 316 317 struct periodic_interrupt_config *periodic_interrupt; 318 319 struct dc_info_packet *vrr_infopacket; 320 struct dc_info_packet *vsc_infopacket; 321 struct dc_info_packet *vsp_infopacket; 322 struct dc_info_packet *hfvsif_infopacket; 323 struct dc_info_packet *vtem_infopacket; 324 struct dc_info_packet *adaptive_sync_infopacket; 325 bool *dpms_off; 326 bool integer_scaling_update; 327 bool *allow_freesync; 328 bool *vrr_active_variable; 329 330 struct colorspace_transform *gamut_remap; 331 enum dc_color_space *output_color_space; 332 enum dc_dither_option *dither_option; 333 334 struct dc_csc_transform *output_csc_transform; 335 336 struct dc_writeback_update *wb_update; 337 struct dc_dsc_config *dsc_config; 338 struct dc_mst_stream_bw_update *mst_bw_update; 339 struct dc_transfer_func *func_shaper; 340 struct dc_3dlut *lut3d_func; 341 342 struct test_pattern *pending_test_pattern; 343 struct dc_crtc_timing_adjust *crtc_timing_adjust; 344 }; 345 346 bool dc_is_stream_unchanged( 347 struct dc_stream_state *old_stream, struct dc_stream_state *stream); 348 bool dc_is_stream_scaling_unchanged( 349 struct dc_stream_state *old_stream, struct dc_stream_state *stream); 350 351 /* 352 * Setup stream attributes if no stream updates are provided 353 * there will be no impact on the stream parameters 354 * 355 * Set up surface attributes and associate to a stream 356 * The surfaces parameter is an absolute set of all surface active for the stream. 357 * If no surfaces are provided, the stream will be blanked; no memory read. 358 * Any flip related attribute changes must be done through this interface. 359 * 360 * After this call: 361 * Surfaces attributes are programmed and configured to be composed into stream. 362 * This does not trigger a flip. No surface address is programmed. 363 * 364 */ 365 bool dc_update_planes_and_stream(struct dc *dc, 366 struct dc_surface_update *surface_updates, int surface_count, 367 struct dc_stream_state *dc_stream, 368 struct dc_stream_update *stream_update); 369 370 /* 371 * Set up surface attributes and associate to a stream 372 * The surfaces parameter is an absolute set of all surface active for the stream. 373 * If no surfaces are provided, the stream will be blanked; no memory read. 374 * Any flip related attribute changes must be done through this interface. 375 * 376 * After this call: 377 * Surfaces attributes are programmed and configured to be composed into stream. 378 * This does not trigger a flip. No surface address is programmed. 379 */ 380 void dc_commit_updates_for_stream(struct dc *dc, 381 struct dc_surface_update *srf_updates, 382 int surface_count, 383 struct dc_stream_state *stream, 384 struct dc_stream_update *stream_update, 385 struct dc_state *state); 386 /* 387 * Log the current stream state. 388 */ 389 void dc_stream_log(const struct dc *dc, const struct dc_stream_state *stream); 390 391 uint8_t dc_get_current_stream_count(struct dc *dc); 392 struct dc_stream_state *dc_get_stream_at_index(struct dc *dc, uint8_t i); 393 394 /* 395 * Return the current frame counter. 396 */ 397 uint32_t dc_stream_get_vblank_counter(const struct dc_stream_state *stream); 398 399 /* 400 * Send dp sdp message. 401 */ 402 bool dc_stream_send_dp_sdp(const struct dc_stream_state *stream, 403 const uint8_t *custom_sdp_message, 404 unsigned int sdp_message_size); 405 406 /* TODO: Return parsed values rather than direct register read 407 * This has a dependency on the caller (amdgpu_display_get_crtc_scanoutpos) 408 * being refactored properly to be dce-specific 409 */ 410 bool dc_stream_get_scanoutpos(const struct dc_stream_state *stream, 411 uint32_t *v_blank_start, 412 uint32_t *v_blank_end, 413 uint32_t *h_position, 414 uint32_t *v_position); 415 416 enum dc_status dc_add_stream_to_ctx( 417 struct dc *dc, 418 struct dc_state *new_ctx, 419 struct dc_stream_state *stream); 420 421 enum dc_status dc_remove_stream_from_ctx( 422 struct dc *dc, 423 struct dc_state *new_ctx, 424 struct dc_stream_state *stream); 425 426 427 bool dc_add_plane_to_context( 428 const struct dc *dc, 429 struct dc_stream_state *stream, 430 struct dc_plane_state *plane_state, 431 struct dc_state *context); 432 433 bool dc_remove_plane_from_context( 434 const struct dc *dc, 435 struct dc_stream_state *stream, 436 struct dc_plane_state *plane_state, 437 struct dc_state *context); 438 439 bool dc_rem_all_planes_for_stream( 440 const struct dc *dc, 441 struct dc_stream_state *stream, 442 struct dc_state *context); 443 444 bool dc_add_all_planes_for_stream( 445 const struct dc *dc, 446 struct dc_stream_state *stream, 447 struct dc_plane_state * const *plane_states, 448 int plane_count, 449 struct dc_state *context); 450 451 bool dc_stream_add_writeback(struct dc *dc, 452 struct dc_stream_state *stream, 453 struct dc_writeback_info *wb_info); 454 455 bool dc_stream_remove_writeback(struct dc *dc, 456 struct dc_stream_state *stream, 457 uint32_t dwb_pipe_inst); 458 459 enum dc_status dc_stream_add_dsc_to_resource(struct dc *dc, 460 struct dc_state *state, 461 struct dc_stream_state *stream); 462 463 bool dc_stream_warmup_writeback(struct dc *dc, 464 int num_dwb, 465 struct dc_writeback_info *wb_info); 466 467 bool dc_stream_dmdata_status_done(struct dc *dc, struct dc_stream_state *stream); 468 469 bool dc_stream_set_dynamic_metadata(struct dc *dc, 470 struct dc_stream_state *stream, 471 struct dc_dmdata_attributes *dmdata_attr); 472 473 enum dc_status dc_validate_stream(struct dc *dc, struct dc_stream_state *stream); 474 475 /* 476 * Set up streams and links associated to drive sinks 477 * The streams parameter is an absolute set of all active streams. 478 * 479 * After this call: 480 * Phy, Encoder, Timing Generator are programmed and enabled. 481 * New streams are enabled with blank stream; no memory read. 482 */ 483 /* 484 * Enable stereo when commit_streams is not required, 485 * for example, frame alternate. 486 */ 487 void dc_enable_stereo( 488 struct dc *dc, 489 struct dc_state *context, 490 struct dc_stream_state *streams[], 491 uint8_t stream_count); 492 493 /* Triggers multi-stream synchronization. */ 494 void dc_trigger_sync(struct dc *dc, struct dc_state *context); 495 496 enum surface_update_type dc_check_update_surfaces_for_stream( 497 struct dc *dc, 498 struct dc_surface_update *updates, 499 int surface_count, 500 struct dc_stream_update *stream_update, 501 const struct dc_stream_status *stream_status); 502 503 /** 504 * Create a new default stream for the requested sink 505 */ 506 struct dc_stream_state *dc_create_stream_for_sink(struct dc_sink *dc_sink); 507 508 struct dc_stream_state *dc_copy_stream(const struct dc_stream_state *stream); 509 510 void update_stream_signal(struct dc_stream_state *stream, struct dc_sink *sink); 511 512 void dc_stream_retain(struct dc_stream_state *dc_stream); 513 void dc_stream_release(struct dc_stream_state *dc_stream); 514 515 struct dc_stream_status *dc_stream_get_status_from_state( 516 struct dc_state *state, 517 struct dc_stream_state *stream); 518 struct dc_stream_status *dc_stream_get_status( 519 struct dc_stream_state *dc_stream); 520 521 #ifndef TRIM_FSFT 522 bool dc_optimize_timing_for_fsft( 523 struct dc_stream_state *pStream, 524 unsigned int max_input_rate_in_khz); 525 #endif 526 527 /******************************************************************************* 528 * Cursor interfaces - To manages the cursor within a stream 529 ******************************************************************************/ 530 /* TODO: Deprecated once we switch to dc_set_cursor_position */ 531 bool dc_stream_set_cursor_attributes( 532 struct dc_stream_state *stream, 533 const struct dc_cursor_attributes *attributes); 534 535 bool dc_stream_set_cursor_position( 536 struct dc_stream_state *stream, 537 const struct dc_cursor_position *position); 538 539 540 bool dc_stream_adjust_vmin_vmax(struct dc *dc, 541 struct dc_stream_state *stream, 542 struct dc_crtc_timing_adjust *adjust); 543 544 bool dc_stream_get_last_used_drr_vtotal(struct dc *dc, 545 struct dc_stream_state *stream, 546 uint32_t *refresh_rate); 547 548 bool dc_stream_get_crtc_position(struct dc *dc, 549 struct dc_stream_state **stream, 550 int num_streams, 551 unsigned int *v_pos, 552 unsigned int *nom_v_pos); 553 554 #if defined(CONFIG_DRM_AMD_SECURE_DISPLAY) 555 bool dc_stream_forward_crc_window(struct dc_stream_state *stream, 556 struct rect *rect, 557 bool is_stop); 558 #endif 559 560 bool dc_stream_configure_crc(struct dc *dc, 561 struct dc_stream_state *stream, 562 struct crc_params *crc_window, 563 bool enable, 564 bool continuous); 565 566 bool dc_stream_get_crc(struct dc *dc, 567 struct dc_stream_state *stream, 568 uint32_t *r_cr, 569 uint32_t *g_y, 570 uint32_t *b_cb); 571 572 void dc_stream_set_static_screen_params(struct dc *dc, 573 struct dc_stream_state **stream, 574 int num_streams, 575 const struct dc_static_screen_params *params); 576 577 void dc_stream_set_dyn_expansion(struct dc *dc, struct dc_stream_state *stream, 578 enum dc_dynamic_expansion option); 579 580 void dc_stream_set_dither_option(struct dc_stream_state *stream, 581 enum dc_dither_option option); 582 583 bool dc_stream_set_gamut_remap(struct dc *dc, 584 const struct dc_stream_state *stream); 585 586 bool dc_stream_program_csc_matrix(struct dc *dc, 587 struct dc_stream_state *stream); 588 589 bool dc_stream_get_crtc_position(struct dc *dc, 590 struct dc_stream_state **stream, 591 int num_streams, 592 unsigned int *v_pos, 593 unsigned int *nom_v_pos); 594 595 struct pipe_ctx *dc_stream_get_pipe_ctx(struct dc_stream_state *stream); 596 597 void dc_dmub_update_dirty_rect(struct dc *dc, 598 int surface_count, 599 struct dc_stream_state *stream, 600 struct dc_surface_update *srf_updates, 601 struct dc_state *context); 602 #endif /* DC_STREAM_H_ */ 603