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