drivers/gpu/drm/amd/display/dc/dc.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_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 #include "gpio_types.h"
  33 #include "link_service_types.h"
  34 #include "grph_object_ctrl_defs.h"
  35 #include <inc/hw/opp.h>
  36
  37 #include "inc/hw_sequencer.h"
  38 #include "inc/compressor.h"
  39 #include "dml/display_mode_lib.h"
  40
  41 #define DC_VER "3.1.07"
  42
  43 #define MAX_SURFACES 3
  44 #define MAX_STREAMS 6
  45 #define MAX_SINKS_PER_LINK 4
  46
  47
  48 /*******************************************************************************
  49  * Display Core Interfaces
  50  ******************************************************************************/
  51 struct dc_caps {
  52         uint32_t max_streams;
  53         uint32_t max_links;
  54         uint32_t max_audios;
  55         uint32_t max_slave_planes;
  56         uint32_t max_planes;
  57         uint32_t max_downscale_ratio;
  58         uint32_t i2c_speed_in_khz;
  59         unsigned int max_cursor_size;
  60         unsigned int max_video_width;
  61         bool dcc_const_color;
  62         bool dynamic_audio;
  63 };
  64
  65 struct dc_dcc_surface_param {
  66         struct dc_size surface_size;
  67         enum surface_pixel_format format;
  68         enum swizzle_mode_values swizzle_mode;
  69         enum dc_scan_direction scan;
  70 };
  71
  72 struct dc_dcc_setting {
  73         unsigned int max_compressed_blk_size;
  74         unsigned int max_uncompressed_blk_size;
  75         bool independent_64b_blks;
  76 };
  77
  78 struct dc_surface_dcc_cap {
  79         union {
  80                 struct {
  81                         struct dc_dcc_setting rgb;
  82                 } grph;
  83
  84                 struct {
  85                         struct dc_dcc_setting luma;
  86                         struct dc_dcc_setting chroma;
  87                 } video;
  88         };
  89
  90         bool capable;
  91         bool const_color_support;
  92 };
  93
  94 struct dc_static_screen_events {
  95         bool cursor_update;
  96         bool surface_update;
  97         bool overlay_update;
  98 };
  99
 100 /* Forward declaration*/
 101 struct dc;
 102 struct dc_plane_state;
 103 struct dc_state;
 104
 105 struct dc_cap_funcs {
 106         bool (*get_dcc_compression_cap)(const struct dc *dc,
 107                         const struct dc_dcc_surface_param *input,
 108                         struct dc_surface_dcc_cap *output);
 109 };
 110
 111 struct dc_stream_state_funcs {
 112         bool (*adjust_vmin_vmax)(struct dc *dc,
 113                         struct dc_stream_state **stream,
 114                         int num_streams,
 115                         int vmin,
 116                         int vmax);
 117         bool (*get_crtc_position)(struct dc *dc,
 118                         struct dc_stream_state **stream,
 119                         int num_streams,
 120                         unsigned int *v_pos,
 121                         unsigned int *nom_v_pos);
 122
 123         bool (*set_gamut_remap)(struct dc *dc,
 124                         const struct dc_stream_state *stream);
 125
 126         bool (*program_csc_matrix)(struct dc *dc,
 127                         struct dc_stream_state *stream);
 128
 129         void (*set_static_screen_events)(struct dc *dc,
 130                         struct dc_stream_state **stream,
 131                         int num_streams,
 132                         const struct dc_static_screen_events *events);
 133
 134         void (*set_dither_option)(struct dc_stream_state *stream,
 135                         enum dc_dither_option option);
 136
 137         void (*set_dpms)(struct dc *dc,
 138                         struct dc_stream_state *stream,
 139                         bool dpms_off);
 140 };
 141
 142 struct link_training_settings;
 143
 144 struct dc_link_funcs {
 145         void (*set_drive_settings)(struct dc *dc,
 146                         struct link_training_settings *lt_settings,
 147                         const struct dc_link *link);
 148         void (*perform_link_training)(struct dc *dc,
 149                         struct dc_link_settings *link_setting,
 150                         bool skip_video_pattern);
 151         void (*set_preferred_link_settings)(struct dc *dc,
 152                         struct dc_link_settings *link_setting,
 153                         struct dc_link *link);
 154         void (*enable_hpd)(const struct dc_link *link);
 155         void (*disable_hpd)(const struct dc_link *link);
 156         void (*set_test_pattern)(
 157                         struct dc_link *link,
 158                         enum dp_test_pattern test_pattern,
 159                         const struct link_training_settings *p_link_settings,
 160                         const unsigned char *p_custom_pattern,
 161                         unsigned int cust_pattern_size);
 162 };
 163
 164 /* Structure to hold configuration flags set by dm at dc creation. */
 165 struct dc_config {
 166         bool gpu_vm_support;
 167         bool disable_disp_pll_sharing;
 168 };
 169
 170 enum dcc_option {
 171         DCC_ENABLE = 0,
 172         DCC_DISABLE = 1,
 173         DCC_HALF_REQ_DISALBE = 2,
 174 };
 175
 176 enum pipe_split_policy {
 177         MPC_SPLIT_DYNAMIC = 0,
 178         MPC_SPLIT_AVOID = 1,
 179         MPC_SPLIT_AVOID_MULT_DISP = 2,
 180 };
 181
 182 enum wm_report_mode {
 183         WM_REPORT_DEFAULT = 0,
 184         WM_REPORT_OVERRIDE = 1,
 185 };
 186
 187 struct dc_debug {
 188         bool surface_visual_confirm;
 189         bool sanity_checks;
 190         bool max_disp_clk;
 191         bool surface_trace;
 192         bool timing_trace;
 193         bool clock_trace;
 194         bool validation_trace;
 195
 196         /* stutter efficiency related */
 197         bool disable_stutter;
 198         bool use_max_lb;
 199         enum dcc_option disable_dcc;
 200         enum pipe_split_policy pipe_split_policy;
 201         bool force_single_disp_pipe_split;
 202         bool voltage_align_fclk;
 203
 204         bool disable_dfs_bypass;
 205         bool disable_dpp_power_gate;
 206         bool disable_hubp_power_gate;
 207         bool disable_pplib_wm_range;
 208         enum wm_report_mode pplib_wm_report_mode;
 209         unsigned int min_disp_clk_khz;
 210         int sr_exit_time_dpm0_ns;
 211         int sr_enter_plus_exit_time_dpm0_ns;
 212         int sr_exit_time_ns;
 213         int sr_enter_plus_exit_time_ns;
 214         int urgent_latency_ns;
 215         int percent_of_ideal_drambw;
 216         int dram_clock_change_latency_ns;
 217         int always_scale;
 218         bool disable_pplib_clock_request;
 219         bool disable_clock_gate;
 220         bool disable_dmcu;
 221         bool disable_psr;
 222         bool force_abm_enable;
 223         bool disable_hbup_pg;
 224         bool disable_dpp_pg;
 225         bool disable_stereo_support;
 226         bool vsr_support;
 227         bool performance_trace;
 228 };
 229 struct dc_state;
 230 struct resource_pool;
 231 struct dce_hwseq;
 232 struct dc {
 233         struct dc_caps caps;
 234         struct dc_cap_funcs cap_funcs;
 235         struct dc_stream_state_funcs stream_funcs;
 236         struct dc_link_funcs link_funcs;
 237         struct dc_config config;
 238         struct dc_debug debug;
 239
 240         struct dc_context *ctx;
 241
 242         uint8_t link_count;
 243         struct dc_link *links[MAX_PIPES * 2];
 244
 245         struct dc_state *current_state;
 246         struct resource_pool *res_pool;
 247
 248         /* Display Engine Clock levels */
 249         struct dm_pp_clock_levels sclk_lvls;
 250
 251         /* Inputs into BW and WM calculations. */
 252         struct bw_calcs_dceip *bw_dceip;
 253         struct bw_calcs_vbios *bw_vbios;
 254 #ifdef CONFIG_DRM_AMD_DC_DCN1_0
 255         struct dcn_soc_bounding_box *dcn_soc;
 256         struct dcn_ip_params *dcn_ip;
 257         struct display_mode_lib dml;
 258 #endif
 259
 260         /* HW functions */
 261         struct hw_sequencer_funcs hwss;
 262         struct dce_hwseq *hwseq;
 263
 264         /* temp store of dm_pp_display_configuration
 265          * to compare to see if display config changed
 266          */
 267         struct dm_pp_display_configuration prev_display_config;
 268
 269         /* FBC compressor */
 270 #if defined(CONFIG_DRM_AMD_DC_FBC)
 271         struct compressor *fbc_compressor;
 272 #endif
 273 };
 274
 275 enum frame_buffer_mode {
 276         FRAME_BUFFER_MODE_LOCAL_ONLY = 0,
 277         FRAME_BUFFER_MODE_ZFB_ONLY,
 278         FRAME_BUFFER_MODE_MIXED_ZFB_AND_LOCAL,
 279 } ;
 280
 281 struct dchub_init_data {
 282         int64_t zfb_phys_addr_base;
 283         int64_t zfb_mc_base_addr;
 284         uint64_t zfb_size_in_byte;
 285         enum frame_buffer_mode fb_mode;
 286         bool dchub_initialzied;
 287         bool dchub_info_valid;
 288 };
 289
 290 struct dc_init_data {
 291         struct hw_asic_id asic_id;
 292         void *driver; /* ctx */
 293         struct cgs_device *cgs_device;
 294
 295         int num_virtual_links;
 296         /*
 297          * If 'vbios_override' not NULL, it will be called instead
 298          * of the real VBIOS. Intended use is Diagnostics on FPGA.
 299          */
 300         struct dc_bios *vbios_override;
 301         enum dce_environment dce_environment;
 302
 303         struct dc_config flags;
 304         uint32_t log_mask;
 305 #if defined(CONFIG_DRM_AMD_DC_FBC)
 306         uint64_t fbc_gpu_addr;
 307 #endif
 308 };
 309
 310 struct dc *dc_create(const struct dc_init_data *init_params);
 311
 312 void dc_destroy(struct dc **dc);
 313
 314 /*******************************************************************************
 315  * Surface Interfaces
 316  ******************************************************************************/
 317
 318 enum {
 319         TRANSFER_FUNC_POINTS = 1025
 320 };
 321
 322 // Moved here from color module for linux
 323 enum color_transfer_func {
 324         transfer_func_unknown,
 325         transfer_func_srgb,
 326         transfer_func_bt709,
 327         transfer_func_pq2084,
 328         transfer_func_pq2084_interim,
 329         transfer_func_linear_0_1,
 330         transfer_func_linear_0_125,
 331         transfer_func_dolbyvision,
 332         transfer_func_gamma_22,
 333         transfer_func_gamma_26
 334 };
 335
 336 enum color_color_space {
 337         color_space_unsupported,
 338         color_space_srgb,
 339         color_space_bt601,
 340         color_space_bt709,
 341         color_space_xv_ycc_bt601,
 342         color_space_xv_ycc_bt709,
 343         color_space_xr_rgb,
 344         color_space_bt2020,
 345         color_space_adobe,
 346         color_space_dci_p3,
 347         color_space_sc_rgb_ms_ref,
 348         color_space_display_native,
 349         color_space_app_ctrl,
 350         color_space_dolby_vision,
 351         color_space_custom_coordinates
 352 };
 353
 354 struct dc_hdr_static_metadata {
 355         /* display chromaticities and white point in units of 0.00001 */
 356         unsigned int chromaticity_green_x;
 357         unsigned int chromaticity_green_y;
 358         unsigned int chromaticity_blue_x;
 359         unsigned int chromaticity_blue_y;
 360         unsigned int chromaticity_red_x;
 361         unsigned int chromaticity_red_y;
 362         unsigned int chromaticity_white_point_x;
 363         unsigned int chromaticity_white_point_y;
 364
 365         uint32_t min_luminance;
 366         uint32_t max_luminance;
 367         uint32_t maximum_content_light_level;
 368         uint32_t maximum_frame_average_light_level;
 369
 370         bool hdr_supported;
 371         bool is_hdr;
 372 };
 373
 374 enum dc_transfer_func_type {
 375         TF_TYPE_PREDEFINED,
 376         TF_TYPE_DISTRIBUTED_POINTS,
 377         TF_TYPE_BYPASS
 378 };
 379
 380 struct dc_transfer_func_distributed_points {
 381         struct fixed31_32 red[TRANSFER_FUNC_POINTS];
 382         struct fixed31_32 green[TRANSFER_FUNC_POINTS];
 383         struct fixed31_32 blue[TRANSFER_FUNC_POINTS];
 384
 385         uint16_t end_exponent;
 386         uint16_t x_point_at_y1_red;
 387         uint16_t x_point_at_y1_green;
 388         uint16_t x_point_at_y1_blue;
 389 };
 390
 391 enum dc_transfer_func_predefined {
 392         TRANSFER_FUNCTION_SRGB,
 393         TRANSFER_FUNCTION_BT709,
 394         TRANSFER_FUNCTION_PQ,
 395         TRANSFER_FUNCTION_LINEAR,
 396 };
 397
 398 struct dc_transfer_func {
 399         struct kref refcount;
 400         struct dc_transfer_func_distributed_points tf_pts;
 401         enum dc_transfer_func_type type;
 402         enum dc_transfer_func_predefined tf;
 403         struct dc_context *ctx;
 404 };
 405
 406 /*
 407  * This structure is filled in by dc_surface_get_status and contains
 408  * the last requested address and the currently active address so the called
 409  * can determine if there are any outstanding flips
 410  */
 411 struct dc_plane_status {
 412         struct dc_plane_address requested_address;
 413         struct dc_plane_address current_address;
 414         bool is_flip_pending;
 415         bool is_right_eye;
 416 };
 417
 418 struct dc_plane_state {
 419         struct dc_plane_address address;
 420         struct scaling_taps scaling_quality;
 421         struct rect src_rect;
 422         struct rect dst_rect;
 423         struct rect clip_rect;
 424
 425         union plane_size plane_size;
 426         union dc_tiling_info tiling_info;
 427
 428         struct dc_plane_dcc_param dcc;
 429         struct dc_hdr_static_metadata hdr_static_ctx;
 430
 431         struct dc_gamma *gamma_correction;
 432         struct dc_transfer_func *in_transfer_func;
 433
 434         // sourceContentAttribute cache
 435         bool is_source_input_valid;
 436         struct dc_hdr_static_metadata source_input_mastering_info;
 437         enum color_color_space source_input_color_space;
 438         enum color_transfer_func source_input_tf;
 439
 440         enum dc_color_space color_space;
 441         enum surface_pixel_format format;
 442         enum dc_rotation_angle rotation;
 443         enum plane_stereo_format stereo_format;
 444
 445         bool per_pixel_alpha;
 446         bool visible;
 447         bool flip_immediate;
 448         bool horizontal_mirror;
 449
 450         /* private to DC core */
 451         struct dc_plane_status status;
 452         struct dc_context *ctx;
 453
 454         /* private to dc_surface.c */
 455         enum dc_irq_source irq_source;
 456         struct kref refcount;
 457 };
 458
 459 struct dc_plane_info {
 460         union plane_size plane_size;
 461         union dc_tiling_info tiling_info;
 462         struct dc_plane_dcc_param dcc;
 463         enum surface_pixel_format format;
 464         enum dc_rotation_angle rotation;
 465         enum plane_stereo_format stereo_format;
 466         enum dc_color_space color_space; /*todo: wrong place, fits in scaling info*/
 467         bool horizontal_mirror;
 468         bool visible;
 469         bool per_pixel_alpha;
 470 };
 471
 472 struct dc_scaling_info {
 473         struct rect src_rect;
 474         struct rect dst_rect;
 475         struct rect clip_rect;
 476         struct scaling_taps scaling_quality;
 477 };
 478
 479 struct dc_surface_update {
 480         struct dc_plane_state *surface;
 481
 482         /* isr safe update parameters.  null means no updates */
 483         struct dc_flip_addrs *flip_addr;
 484         struct dc_plane_info *plane_info;
 485         struct dc_scaling_info *scaling_info;
 486         /* following updates require alloc/sleep/spin that is not isr safe,
 487          * null means no updates
 488          */
 489         /* gamma TO BE REMOVED */
 490         struct dc_gamma *gamma;
 491         struct dc_transfer_func *in_transfer_func;
 492         struct dc_hdr_static_metadata *hdr_static_metadata;
 493 };
 494
 495 /*
 496  * Create a new surface with default parameters;
 497  */
 498 struct dc_plane_state *dc_create_plane_state(struct dc *dc);
 499 const struct dc_plane_status *dc_plane_get_status(
 500                 const struct dc_plane_state *plane_state);
 501
 502 void dc_plane_state_retain(struct dc_plane_state *plane_state);
 503 void dc_plane_state_release(struct dc_plane_state *plane_state);
 504
 505 void dc_gamma_retain(struct dc_gamma *dc_gamma);
 506 void dc_gamma_release(struct dc_gamma **dc_gamma);
 507 struct dc_gamma *dc_create_gamma(void);
 508
 509 void dc_transfer_func_retain(struct dc_transfer_func *dc_tf);
 510 void dc_transfer_func_release(struct dc_transfer_func *dc_tf);
 511 struct dc_transfer_func *dc_create_transfer_func(void);
 512
 513 /*
 514  * This structure holds a surface address.  There could be multiple addresses
 515  * in cases such as Stereo 3D, Planar YUV, etc.  Other per-flip attributes such
 516  * as frame durations and DCC format can also be set.
 517  */
 518 struct dc_flip_addrs {
 519         struct dc_plane_address address;
 520         bool flip_immediate;
 521         /* TODO: add flip duration for FreeSync */
 522 };
 523
 524 bool dc_post_update_surfaces_to_stream(
 525                 struct dc *dc);
 526
 527 /* Surface update type is used by dc_update_surfaces_and_stream
 528  * The update type is determined at the very beginning of the function based
 529  * on parameters passed in and decides how much programming (or updating) is
 530  * going to be done during the call.
 531  *
 532  * UPDATE_TYPE_FAST is used for really fast updates that do not require much
 533  * logical calculations or hardware register programming. This update MUST be
 534  * ISR safe on windows. Currently fast update will only be used to flip surface
 535  * address.
 536  *
 537  * UPDATE_TYPE_MED is used for slower updates which require significant hw
 538  * re-programming however do not affect bandwidth consumption or clock
 539  * requirements. At present, this is the level at which front end updates
 540  * that do not require us to run bw_calcs happen. These are in/out transfer func
 541  * updates, viewport offset changes, recout size changes and pixel depth changes.
 542  * This update can be done at ISR, but we want to minimize how often this happens.
 543  *
 544  * UPDATE_TYPE_FULL is slow. Really slow. This requires us to recalculate our
 545  * bandwidth and clocks, possibly rearrange some pipes and reprogram anything front
 546  * end related. Any time viewport dimensions, recout dimensions, scaling ratios or
 547  * gamma need to be adjusted or pipe needs to be turned on (or disconnected) we do
 548  * a full update. This cannot be done at ISR level and should be a rare event.
 549  * Unless someone is stress testing mpo enter/exit, playing with colour or adjusting
 550  * underscan we don't expect to see this call at all.
 551  */
 552
 553 enum surface_update_type {
 554         UPDATE_TYPE_FAST, /* super fast, safe to execute in isr */
 555         UPDATE_TYPE_MED,  /* ISR safe, most of programming needed, no bw/clk change*/
 556         UPDATE_TYPE_FULL, /* may need to shuffle resources */
 557 };
 558
 559 /*******************************************************************************
 560  * Stream Interfaces
 561  ******************************************************************************/
 562
 563 struct dc_stream_status {
 564         int primary_otg_inst;
 565         int stream_enc_inst;
 566         int plane_count;
 567         struct dc_plane_state *plane_states[MAX_SURFACE_NUM];
 568
 569         /*
 570          * link this stream passes through
 571          */
 572         struct dc_link *link;
 573 };
 574
 575 struct dc_stream_state {
 576         struct dc_sink *sink;
 577         struct dc_crtc_timing timing;
 578
 579         struct rect src; /* composition area */
 580         struct rect dst; /* stream addressable area */
 581
 582         struct audio_info audio_info;
 583
 584         struct freesync_context freesync_ctx;
 585
 586         struct dc_transfer_func *out_transfer_func;
 587         struct colorspace_transform gamut_remap_matrix;
 588         struct csc_transform csc_color_matrix;
 589
 590         enum signal_type output_signal;
 591
 592         enum dc_color_space output_color_space;
 593         enum dc_dither_option dither_option;
 594
 595         enum view_3d_format view_format;
 596
 597         bool ignore_msa_timing_param;
 598         /* TODO: custom INFO packets */
 599         /* TODO: ABM info (DMCU) */
 600         /* TODO: PSR info */
 601         /* TODO: CEA VIC */
 602
 603         /* from core_stream struct */
 604         struct dc_context *ctx;
 605
 606         /* used by DCP and FMT */
 607         struct bit_depth_reduction_params bit_depth_params;
 608         struct clamping_and_pixel_encoding_params clamping;
 609
 610         int phy_pix_clk;
 611         enum signal_type signal;
 612         bool dpms_off;
 613
 614         struct dc_stream_status status;
 615
 616         struct dc_cursor_attributes cursor_attributes;
 617
 618         /* from stream struct */
 619         struct kref refcount;
 620 };
 621
 622 struct dc_stream_update {
 623         struct rect src;
 624         struct rect dst;
 625         struct dc_transfer_func *out_transfer_func;
 626 };
 627
 628 bool dc_is_stream_unchanged(
 629         struct dc_stream_state *old_stream, struct dc_stream_state *stream);
 630 bool dc_is_stream_scaling_unchanged(
 631         struct dc_stream_state *old_stream, struct dc_stream_state *stream);
 632
 633 /*
 634  * Set up surface attributes and associate to a stream
 635  * The surfaces parameter is an absolute set of all surface active for the stream.
 636  * If no surfaces are provided, the stream will be blanked; no memory read.
 637  * Any flip related attribute changes must be done through this interface.
 638  *
 639  * After this call:
 640  *   Surfaces attributes are programmed and configured to be composed into stream.
 641  *   This does not trigger a flip.  No surface address is programmed.
 642  */
 643
 644 bool dc_commit_planes_to_stream(
 645                 struct dc *dc,
 646                 struct dc_plane_state **plane_states,
 647                 uint8_t new_plane_count,
 648                 struct dc_stream_state *dc_stream,
 649                 struct dc_state *state);
 650
 651 void dc_commit_updates_for_stream(struct dc *dc,
 652                 struct dc_surface_update *srf_updates,
 653                 int surface_count,
 654                 struct dc_stream_state *stream,
 655                 struct dc_stream_update *stream_update,
 656                 struct dc_plane_state **plane_states,
 657                 struct dc_state *state);
 658 /*
 659  * Log the current stream state.
 660  */
 661 void dc_stream_log(
 662         const struct dc_stream_state *stream,
 663         struct dal_logger *dc_logger,
 664         enum dc_log_type log_type);
 665
 666 uint8_t dc_get_current_stream_count(struct dc *dc);
 667 struct dc_stream_state *dc_get_stream_at_index(struct dc *dc, uint8_t i);
 668
 669 /*
 670  * Return the current frame counter.
 671  */
 672 uint32_t dc_stream_get_vblank_counter(const struct dc_stream_state *stream);
 673
 674 /* TODO: Return parsed values rather than direct register read
 675  * This has a dependency on the caller (amdgpu_get_crtc_scanoutpos)
 676  * being refactored properly to be dce-specific
 677  */
 678 bool dc_stream_get_scanoutpos(const struct dc_stream_state *stream,
 679                                   uint32_t *v_blank_start,
 680                                   uint32_t *v_blank_end,
 681                                   uint32_t *h_position,
 682                                   uint32_t *v_position);
 683
 684 enum dc_status dc_add_stream_to_ctx(
 685                         struct dc *dc,
 686                 struct dc_state *new_ctx,
 687                 struct dc_stream_state *stream);
 688
 689 enum dc_status dc_remove_stream_from_ctx(
 690                 struct dc *dc,
 691                         struct dc_state *new_ctx,
 692                         struct dc_stream_state *stream);
 693
 694
 695 bool dc_add_plane_to_context(
 696                 const struct dc *dc,
 697                 struct dc_stream_state *stream,
 698                 struct dc_plane_state *plane_state,
 699                 struct dc_state *context);
 700
 701 bool dc_remove_plane_from_context(
 702                 const struct dc *dc,
 703                 struct dc_stream_state *stream,
 704                 struct dc_plane_state *plane_state,
 705                 struct dc_state *context);
 706
 707 bool dc_rem_all_planes_for_stream(
 708                 const struct dc *dc,
 709                 struct dc_stream_state *stream,
 710                 struct dc_state *context);
 711
 712 bool dc_add_all_planes_for_stream(
 713                 const struct dc *dc,
 714                 struct dc_stream_state *stream,
 715                 struct dc_plane_state * const *plane_states,
 716                 int plane_count,
 717                 struct dc_state *context);
 718
 719 /*
 720  * Structure to store surface/stream associations for validation
 721  */
 722 struct dc_validation_set {
 723         struct dc_stream_state *stream;
 724         struct dc_plane_state *plane_states[MAX_SURFACES];
 725         uint8_t plane_count;
 726 };
 727
 728 enum dc_status dc_validate_stream(struct dc *dc, struct dc_stream_state *stream);
 729
 730 enum dc_status dc_validate_plane(struct dc *dc, const struct dc_plane_state *plane_state);
 731
 732 enum dc_status dc_validate_global_state(
 733                 struct dc *dc,
 734                 struct dc_state *new_ctx);
 735
 736 /*
 737  * This function takes a stream and checks if it is guaranteed to be supported.
 738  * Guaranteed means that MAX_COFUNC similar streams are supported.
 739  *
 740  * After this call:
 741  *   No hardware is programmed for call.  Only validation is done.
 742  */
 743
 744
 745 void dc_resource_state_construct(
 746                 const struct dc *dc,
 747                 struct dc_state *dst_ctx);
 748
 749 void dc_resource_state_copy_construct(
 750                 const struct dc_state *src_ctx,
 751                 struct dc_state *dst_ctx);
 752
 753 void dc_resource_state_copy_construct_current(
 754                 const struct dc *dc,
 755                 struct dc_state *dst_ctx);
 756
 757 void dc_resource_state_destruct(struct dc_state *context);
 758
 759 /*
 760  * TODO update to make it about validation sets
 761  * Set up streams and links associated to drive sinks
 762  * The streams parameter is an absolute set of all active streams.
 763  *
 764  * After this call:
 765  *   Phy, Encoder, Timing Generator are programmed and enabled.
 766  *   New streams are enabled with blank stream; no memory read.
 767  */
 768 bool dc_commit_state(struct dc *dc, struct dc_state *context);
 769
 770 /*
 771  * Set up streams and links associated to drive sinks
 772  * The streams parameter is an absolute set of all active streams.
 773  *
 774  * After this call:
 775  *   Phy, Encoder, Timing Generator are programmed and enabled.
 776  *   New streams are enabled with blank stream; no memory read.
 777  */
 778 /*
 779  * Enable stereo when commit_streams is not required,
 780  * for example, frame alternate.
 781  */
 782 bool dc_enable_stereo(
 783         struct dc *dc,
 784         struct dc_state *context,
 785         struct dc_stream_state *streams[],
 786         uint8_t stream_count);
 787
 788 /**
 789  * Create a new default stream for the requested sink
 790  */
 791 struct dc_stream_state *dc_create_stream_for_sink(struct dc_sink *dc_sink);
 792
 793 void dc_stream_retain(struct dc_stream_state *dc_stream);
 794 void dc_stream_release(struct dc_stream_state *dc_stream);
 795
 796 struct dc_stream_status *dc_stream_get_status(
 797         struct dc_stream_state *dc_stream);
 798
 799 enum surface_update_type dc_check_update_surfaces_for_stream(
 800                 struct dc *dc,
 801                 struct dc_surface_update *updates,
 802                 int surface_count,
 803                 struct dc_stream_update *stream_update,
 804                 const struct dc_stream_status *stream_status);
 805
 806
 807 struct dc_state *dc_create_state(void);
 808 void dc_retain_state(struct dc_state *context);
 809 void dc_release_state(struct dc_state *context);
 810
 811 /*******************************************************************************
 812  * Link Interfaces
 813  ******************************************************************************/
 814
 815 struct dpcd_caps {
 816         union dpcd_rev dpcd_rev;
 817         union max_lane_count max_ln_count;
 818         union max_down_spread max_down_spread;
 819
 820         /* dongle type (DP converter, CV smart dongle) */
 821         enum display_dongle_type dongle_type;
 822         /* Dongle's downstream count. */
 823         union sink_count sink_count;
 824         /* If dongle_type == DISPLAY_DONGLE_DP_HDMI_CONVERTER,
 825         indicates 'Frame Sequential-to-lllFrame Pack' conversion capability.*/
 826         struct dc_dongle_caps dongle_caps;
 827
 828         uint32_t sink_dev_id;
 829         uint32_t branch_dev_id;
 830         int8_t branch_dev_name[6];
 831         int8_t branch_hw_revision;
 832
 833         bool allow_invalid_MSA_timing_param;
 834         bool panel_mode_edp;
 835         bool dpcd_display_control_capable;
 836 };
 837
 838 struct dc_link_status {
 839         struct dpcd_caps *dpcd_caps;
 840 };
 841
 842 /* DP MST stream allocation (payload bandwidth number) */
 843 struct link_mst_stream_allocation {
 844         /* DIG front */
 845         const struct stream_encoder *stream_enc;
 846         /* associate DRM payload table with DC stream encoder */
 847         uint8_t vcp_id;
 848         /* number of slots required for the DP stream in transport packet */
 849         uint8_t slot_count;
 850 };
 851
 852 /* DP MST stream allocation table */
 853 struct link_mst_stream_allocation_table {
 854         /* number of DP video streams */
 855         int stream_count;
 856         /* array of stream allocations */
 857         struct link_mst_stream_allocation stream_allocations[MAX_CONTROLLER_NUM];
 858 };
 859
 860 /*
 861  * A link contains one or more sinks and their connected status.
 862  * The currently active signal type (HDMI, DP-SST, DP-MST) is also reported.
 863  */
 864 struct dc_link {
 865         struct dc_sink *remote_sinks[MAX_SINKS_PER_LINK];
 866         unsigned int sink_count;
 867         struct dc_sink *local_sink;
 868         unsigned int link_index;
 869         enum dc_connection_type type;
 870         enum signal_type connector_signal;
 871         enum dc_irq_source irq_source_hpd;
 872         enum dc_irq_source irq_source_hpd_rx;/* aka DP Short Pulse  */
 873         /* caps is the same as reported_link_cap. link_traing use
 874          * reported_link_cap. Will clean up.  TODO
 875          */
 876         struct dc_link_settings reported_link_cap;
 877         struct dc_link_settings verified_link_cap;
 878         struct dc_link_settings cur_link_settings;
 879         struct dc_lane_settings cur_lane_setting;
 880         struct dc_link_settings preferred_link_setting;
 881
 882         uint8_t ddc_hw_inst;
 883
 884         uint8_t hpd_src;
 885
 886         uint8_t link_enc_hw_inst;
 887
 888         bool test_pattern_enabled;
 889         union compliance_test_state compliance_test_state;
 890
 891         void *priv;
 892
 893         struct ddc_service *ddc;
 894
 895         bool aux_mode;
 896
 897         /* Private to DC core */
 898
 899         const struct dc *dc;
 900
 901         struct dc_context *ctx;
 902
 903         struct link_encoder *link_enc;
 904         struct graphics_object_id link_id;
 905         union ddi_channel_mapping ddi_channel_mapping;
 906         struct connector_device_tag_info device_tag;
 907         struct dpcd_caps dpcd_caps;
 908         unsigned short chip_caps;
 909         unsigned int dpcd_sink_count;
 910         enum edp_revision edp_revision;
 911         bool psr_enabled;
 912
 913         /* MST record stream using this link */
 914         struct link_flags {
 915                 bool dp_keep_receiver_powered;
 916         } wa_flags;
 917         struct link_mst_stream_allocation_table mst_stream_alloc_table;
 918
 919         struct dc_link_status link_status;
 920
 921 };
 922
 923 const struct dc_link_status *dc_link_get_status(const struct dc_link *dc_link);
 924
 925 /*
 926  * Return an enumerated dc_link.  dc_link order is constant and determined at
 927  * boot time.  They cannot be created or destroyed.
 928  * Use dc_get_caps() to get number of links.
 929  */
 930 static inline struct dc_link *dc_get_link_at_index(struct dc *dc, uint32_t link_index)
 931 {
 932         return dc->links[link_index];
 933 }
 934
 935 /* Set backlight level of an embedded panel (eDP, LVDS). */
 936 bool dc_link_set_backlight_level(const struct dc_link *dc_link, uint32_t level,
 937                 uint32_t frame_ramp, const struct dc_stream_state *stream);
 938
 939 bool dc_link_set_psr_enable(const struct dc_link *dc_link, bool enable, bool wait);
 940
 941 bool dc_link_get_psr_state(const struct dc_link *dc_link, uint32_t *psr_state);
 942
 943 bool dc_link_setup_psr(struct dc_link *dc_link,
 944                 const struct dc_stream_state *stream, struct psr_config *psr_config,
 945                 struct psr_context *psr_context);
 946
 947 /* Request DC to detect if there is a Panel connected.
 948  * boot - If this call is during initial boot.
 949  * Return false for any type of detection failure or MST detection
 950  * true otherwise. True meaning further action is required (status update
 951  * and OS notification).
 952  */
 953 enum dc_detect_reason {
 954         DETECT_REASON_BOOT,
 955         DETECT_REASON_HPD,
 956         DETECT_REASON_HPDRX,
 957 };
 958
 959 bool dc_link_detect(struct dc_link *dc_link, enum dc_detect_reason reason);
 960
 961 /* Notify DC about DP RX Interrupt (aka Short Pulse Interrupt).
 962  * Return:
 963  * true - Downstream port status changed. DM should call DC to do the
 964  * detection.
 965  * false - no change in Downstream port status. No further action required
 966  * from DM. */
 967 bool dc_link_handle_hpd_rx_irq(struct dc_link *dc_link,
 968                 union hpd_irq_data *hpd_irq_dpcd_data);
 969
 970 struct dc_sink_init_data;
 971
 972 struct dc_sink *dc_link_add_remote_sink(
 973                 struct dc_link *dc_link,
 974                 const uint8_t *edid,
 975                 int len,
 976                 struct dc_sink_init_data *init_data);
 977
 978 void dc_link_remove_remote_sink(
 979         struct dc_link *link,
 980         struct dc_sink *sink);
 981
 982 /* Used by diagnostics for virtual link at the moment */
 983
 984 void dc_link_dp_set_drive_settings(
 985         struct dc_link *link,
 986         struct link_training_settings *lt_settings);
 987
 988 enum link_training_result dc_link_dp_perform_link_training(
 989         struct dc_link *link,
 990         const struct dc_link_settings *link_setting,
 991         bool skip_video_pattern);
 992
 993 void dc_link_dp_enable_hpd(const struct dc_link *link);
 994
 995 void dc_link_dp_disable_hpd(const struct dc_link *link);
 996
 997 bool dc_link_dp_set_test_pattern(
 998         struct dc_link *link,
 999         enum dp_test_pattern test_pattern,
1000         const struct link_training_settings *p_link_settings,
1001         const unsigned char *p_custom_pattern,
1002         unsigned int cust_pattern_size);
1003
1004 /*******************************************************************************
1005  * Sink Interfaces - A sink corresponds to a display output device
1006  ******************************************************************************/
1007
1008 struct dc_container_id {
1009         // 128bit GUID in binary form
1010         unsigned char  guid[16];
1011         // 8 byte port ID -> ELD.PortID
1012         unsigned int   portId[2];
1013         // 128bit GUID in binary formufacturer name -> ELD.ManufacturerName
1014         unsigned short manufacturerName;
1015         // 2 byte product code -> ELD.ProductCode
1016         unsigned short productCode;
1017 };
1018
1019
1020
1021 /*
1022  * The sink structure contains EDID and other display device properties
1023  */
1024 struct dc_sink {
1025         enum signal_type sink_signal;
1026         struct dc_edid dc_edid; /* raw edid */
1027         struct dc_edid_caps edid_caps; /* parse display caps */
1028         struct dc_container_id *dc_container_id;
1029         uint32_t dongle_max_pix_clk;
1030         void *priv;
1031         struct stereo_3d_features features_3d[TIMING_3D_FORMAT_MAX];
1032         bool converter_disable_audio;
1033
1034         /* private to DC core */
1035         struct dc_link *link;
1036         struct dc_context *ctx;
1037
1038         /* private to dc_sink.c */
1039         struct kref refcount;
1040 };
1041
1042 void dc_sink_retain(struct dc_sink *sink);
1043 void dc_sink_release(struct dc_sink *sink);
1044
1045 struct dc_sink_init_data {
1046         enum signal_type sink_signal;
1047         struct dc_link *link;
1048         uint32_t dongle_max_pix_clk;
1049         bool converter_disable_audio;
1050 };
1051
1052 struct dc_sink *dc_sink_create(const struct dc_sink_init_data *init_params);
1053
1054 /*******************************************************************************
1055  * Cursor interfaces - To manages the cursor within a stream
1056  ******************************************************************************/
1057 /* TODO: Deprecated once we switch to dc_set_cursor_position */
1058 bool dc_stream_set_cursor_attributes(
1059         struct dc_stream_state *stream,
1060         const struct dc_cursor_attributes *attributes);
1061
1062 bool dc_stream_set_cursor_position(
1063         struct dc_stream_state *stream,
1064         const struct dc_cursor_position *position);
1065
1066 /* Newer interfaces  */
1067 struct dc_cursor {
1068         struct dc_plane_address address;
1069         struct dc_cursor_attributes attributes;
1070 };
1071
1072 /*******************************************************************************
1073  * Interrupt interfaces
1074  ******************************************************************************/
1075 enum dc_irq_source dc_interrupt_to_irq_source(
1076                 struct dc *dc,
1077                 uint32_t src_id,
1078                 uint32_t ext_id);
1079 void dc_interrupt_set(struct dc *dc, enum dc_irq_source src, bool enable);
1080 void dc_interrupt_ack(struct dc *dc, enum dc_irq_source src);
1081 enum dc_irq_source dc_get_hpd_irq_source_at_index(
1082                 struct dc *dc, uint32_t link_index);
1083
1084 /*******************************************************************************
1085  * Power Interfaces
1086  ******************************************************************************/
1087
1088 void dc_set_power_state(
1089                 struct dc *dc,
1090                 enum dc_acpi_cm_power_state power_state);
1091 void dc_resume(struct dc *dc);
1092
1093 /*
1094  * DPCD access interfaces
1095  */
1096
1097 bool dc_submit_i2c(
1098                 struct dc *dc,
1099                 uint32_t link_index,
1100                 struct i2c_command *cmd);
1101
1102
1103 #endif /* DC_INTERFACE_H_ */