drivers/gpu/drm/amd/display/dc/dc_stream.h

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