drivers/gpu/drm/amd/display/dc/dc_link.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_LINK_H_
  27 #define DC_LINK_H_
  28
  29 #include "dc.h"
  30 #include "dc_types.h"
  31 #include "grph_object_defs.h"
  32
  33 struct link_resource;
  34
  35 enum dc_link_fec_state {
  36         dc_link_fec_not_ready,
  37         dc_link_fec_ready,
  38         dc_link_fec_enabled
  39 };
  40
  41 struct dc_link_status {
  42         bool link_active;
  43         struct dpcd_caps *dpcd_caps;
  44 };
  45
  46 struct dprx_states {
  47         bool cable_id_written;
  48 };
  49
  50 /* DP MST stream allocation (payload bandwidth number) */
  51 struct link_mst_stream_allocation {
  52         /* DIG front */
  53         const struct stream_encoder *stream_enc;
  54         /* HPO DP Stream Encoder */
  55         const struct hpo_dp_stream_encoder *hpo_dp_stream_enc;
  56         /* associate DRM payload table with DC stream encoder */
  57         uint8_t vcp_id;
  58         /* number of slots required for the DP stream in transport packet */
  59         uint8_t slot_count;
  60 };
  61
  62 /* DP MST stream allocation table */
  63 struct link_mst_stream_allocation_table {
  64         /* number of DP video streams */
  65         int stream_count;
  66         /* array of stream allocations */
  67         struct link_mst_stream_allocation stream_allocations[MAX_CONTROLLER_NUM];
  68 };
  69
  70 struct time_stamp {
  71         uint64_t edp_poweroff;
  72         uint64_t edp_poweron;
  73 };
  74
  75 struct link_trace {
  76         struct time_stamp time_stamp;
  77 };
  78
  79 struct dp_trace_lt_counts {
  80         unsigned int total;
  81         unsigned int fail;
  82 };
  83
  84 struct dp_trace_lt {
  85         struct dp_trace_lt_counts counts;
  86         struct dp_trace_timestamps {
  87                 unsigned long long start;
  88                 unsigned long long end;
  89         } timestamps;
  90         enum link_training_result result;
  91         bool is_logged;
  92 };
  93
  94 struct dp_trace {
  95         struct dp_trace_lt detect_lt_trace;
  96         struct dp_trace_lt commit_lt_trace;
  97         unsigned int link_loss_count;
  98         bool is_initialized;
  99 };
 100
 101 /* PSR feature flags */
 102 struct psr_settings {
 103         bool psr_feature_enabled;               // PSR is supported by sink
 104         bool psr_allow_active;                  // PSR is currently active
 105         enum dc_psr_version psr_version;                // Internal PSR version, determined based on DPCD
 106
 107         /* These parameters are calculated in Driver,
 108          * based on display timing and Sink capabilities.
 109          * If VBLANK region is too small and Sink takes a long time
 110          * to set up RFB, it may take an extra frame to enter PSR state.
 111          */
 112         bool psr_frame_capture_indication_req;
 113         unsigned int psr_sdp_transmit_line_num_deadline;
 114         unsigned int psr_power_opt;
 115 };
 116
 117 /*
 118  * A link contains one or more sinks and their connected status.
 119  * The currently active signal type (HDMI, DP-SST, DP-MST) is also reported.
 120  */
 121 struct dc_link {
 122         struct dc_sink *remote_sinks[MAX_SINKS_PER_LINK];
 123         unsigned int sink_count;
 124         struct dc_sink *local_sink;
 125         unsigned int link_index;
 126         enum dc_connection_type type;
 127         enum signal_type connector_signal;
 128         enum dc_irq_source irq_source_hpd;
 129         enum dc_irq_source irq_source_hpd_rx;/* aka DP Short Pulse  */
 130         bool is_hpd_filter_disabled;
 131         bool dp_ss_off;
 132         bool link_state_valid;
 133         bool aux_access_disabled;
 134         bool sync_lt_in_progress;
 135         enum lttpr_mode lttpr_mode;
 136         bool is_internal_display;
 137
 138         /* TODO: Rename. Flag an endpoint as having a programmable mapping to a
 139          * DIG encoder. */
 140         bool is_dig_mapping_flexible;
 141         bool hpd_status; /* HPD status of link without physical HPD pin. */
 142         bool is_hpd_pending; /* Indicates a new received hpd */
 143
 144         bool edp_sink_present;
 145
 146         struct dp_trace dp_trace;
 147
 148         /* caps is the same as reported_link_cap. link_traing use
 149          * reported_link_cap. Will clean up.  TODO
 150          */
 151         struct dc_link_settings reported_link_cap;
 152         struct dc_link_settings verified_link_cap;
 153         struct dc_link_settings cur_link_settings;
 154         struct dc_lane_settings cur_lane_setting[LANE_COUNT_DP_MAX];
 155         struct dc_link_settings preferred_link_setting;
 156         /* preferred_training_settings are override values that
 157          * come from DM. DM is responsible for the memory
 158          * management of the override pointers.
 159          */
 160         struct dc_link_training_overrides preferred_training_settings;
 161         struct dp_audio_test_data audio_test_data;
 162
 163         uint8_t ddc_hw_inst;
 164
 165         uint8_t hpd_src;
 166
 167         uint8_t link_enc_hw_inst;
 168         /* DIG link encoder ID. Used as index in link encoder resource pool.
 169          * For links with fixed mapping to DIG, this is not changed after dc_link
 170          * object creation.
 171          */
 172         enum engine_id eng_id;
 173
 174         bool test_pattern_enabled;
 175         union compliance_test_state compliance_test_state;
 176
 177         void *priv;
 178
 179         struct ddc_service *ddc;
 180
 181         bool aux_mode;
 182
 183         /* Private to DC core */
 184
 185         const struct dc *dc;
 186
 187         struct dc_context *ctx;
 188
 189         struct panel_cntl *panel_cntl;
 190         struct link_encoder *link_enc;
 191         struct graphics_object_id link_id;
 192         /* Endpoint type distinguishes display endpoints which do not have entries
 193          * in the BIOS connector table from those that do. Helps when tracking link
 194          * encoder to display endpoint assignments.
 195          */
 196         enum display_endpoint_type ep_type;
 197         union ddi_channel_mapping ddi_channel_mapping;
 198         struct connector_device_tag_info device_tag;
 199         struct dpcd_caps dpcd_caps;
 200         uint32_t dongle_max_pix_clk;
 201         unsigned short chip_caps;
 202         unsigned int dpcd_sink_count;
 203 #if defined(CONFIG_DRM_AMD_DC_HDCP)
 204         struct hdcp_caps hdcp_caps;
 205 #endif
 206         enum edp_revision edp_revision;
 207         union dpcd_sink_ext_caps dpcd_sink_ext_caps;
 208
 209         struct psr_settings psr_settings;
 210
 211         /* Drive settings read from integrated info table */
 212         struct dc_lane_settings bios_forced_drive_settings;
 213
 214         /* Vendor specific LTTPR workaround variables */
 215         uint8_t vendor_specific_lttpr_link_rate_wa;
 216         bool apply_vendor_specific_lttpr_link_rate_wa;
 217
 218         /* MST record stream using this link */
 219         struct link_flags {
 220                 bool dp_keep_receiver_powered;
 221                 bool dp_skip_DID2;
 222                 bool dp_skip_reset_segment;
 223                 bool dp_mot_reset_segment;
 224                 /* Some USB4 docks do not handle turning off MST DSC once it has been enabled. */
 225                 bool dpia_mst_dsc_always_on;
 226                 /* Forced DPIA into TBT3 compatibility mode. */
 227                 bool dpia_forced_tbt3_mode;
 228         } wa_flags;
 229         struct link_mst_stream_allocation_table mst_stream_alloc_table;
 230
 231         struct dc_link_status link_status;
 232         struct dprx_states dprx_states;
 233
 234         struct link_trace link_trace;
 235         struct gpio *hpd_gpio;
 236         enum dc_link_fec_state fec_state;
 237 };
 238
 239 const struct dc_link_status *dc_link_get_status(const struct dc_link *dc_link);
 240
 241 /**
 242  * dc_get_link_at_index() - Return an enumerated dc_link.
 243  *
 244  * dc_link order is constant and determined at
 245  * boot time.  They cannot be created or destroyed.
 246  * Use dc_get_caps() to get number of links.
 247  */
 248 static inline struct dc_link *dc_get_link_at_index(struct dc *dc, uint32_t link_index)
 249 {
 250         return dc->links[link_index];
 251 }
 252
 253 static inline void get_edp_links(const struct dc *dc,
 254                 struct dc_link **edp_links,
 255                 int *edp_num)
 256 {
 257         int i;
 258
 259         *edp_num = 0;
 260         for (i = 0; i < dc->link_count; i++) {
 261                 // report any eDP links, even unconnected DDI's
 262                 if (!dc->links[i])
 263                         continue;
 264                 if (dc->links[i]->connector_signal == SIGNAL_TYPE_EDP) {
 265                         edp_links[*edp_num] = dc->links[i];
 266                         if (++(*edp_num) == MAX_NUM_EDP)
 267                                 return;
 268                 }
 269         }
 270 }
 271
 272 static inline bool dc_get_edp_link_panel_inst(const struct dc *dc,
 273                 const struct dc_link *link,
 274                 unsigned int *inst_out)
 275 {
 276         struct dc_link *edp_links[MAX_NUM_EDP];
 277         int edp_num;
 278
 279         if (link->connector_signal != SIGNAL_TYPE_EDP)
 280                 return false;
 281         get_edp_links(dc, edp_links, &edp_num);
 282         if ((edp_num > 1) && (link->link_index > edp_links[0]->link_index))
 283                 *inst_out = 1;
 284         else
 285                 *inst_out = 0;
 286         return true;
 287 }
 288
 289 /* Set backlight level of an embedded panel (eDP, LVDS).
 290  * backlight_pwm_u16_16 is unsigned 32 bit with 16 bit integer
 291  * and 16 bit fractional, where 1.0 is max backlight value.
 292  */
 293 bool dc_link_set_backlight_level(const struct dc_link *dc_link,
 294                 uint32_t backlight_pwm_u16_16,
 295                 uint32_t frame_ramp);
 296
 297 /* Set/get nits-based backlight level of an embedded panel (eDP, LVDS). */
 298 bool dc_link_set_backlight_level_nits(struct dc_link *link,
 299                 bool isHDR,
 300                 uint32_t backlight_millinits,
 301                 uint32_t transition_time_in_ms);
 302
 303 bool dc_link_get_backlight_level_nits(struct dc_link *link,
 304                 uint32_t *backlight_millinits,
 305                 uint32_t *backlight_millinits_peak);
 306
 307 bool dc_link_backlight_enable_aux(struct dc_link *link, bool enable);
 308
 309 bool dc_link_read_default_bl_aux(struct dc_link *link, uint32_t *backlight_millinits);
 310 bool dc_link_set_default_brightness_aux(struct dc_link *link);
 311
 312 int dc_link_get_backlight_level(const struct dc_link *dc_link);
 313
 314 int dc_link_get_target_backlight_pwm(const struct dc_link *link);
 315
 316 bool dc_link_set_psr_allow_active(struct dc_link *dc_link, const bool *enable,
 317                 bool wait, bool force_static, const unsigned int *power_opts);
 318
 319 bool dc_link_get_psr_state(const struct dc_link *dc_link, enum dc_psr_state *state);
 320
 321 bool dc_link_setup_psr(struct dc_link *dc_link,
 322                 const struct dc_stream_state *stream, struct psr_config *psr_config,
 323                 struct psr_context *psr_context);
 324
 325 void dc_link_get_psr_residency(const struct dc_link *link, uint32_t *residency);
 326
 327 void dc_link_blank_all_dp_displays(struct dc *dc);
 328
 329 void dc_link_blank_dp_stream(struct dc_link *link, bool hw_init);
 330
 331 /* Request DC to detect if there is a Panel connected.
 332  * boot - If this call is during initial boot.
 333  * Return false for any type of detection failure or MST detection
 334  * true otherwise. True meaning further action is required (status update
 335  * and OS notification).
 336  */
 337 enum dc_detect_reason {
 338         DETECT_REASON_BOOT,
 339         DETECT_REASON_RESUMEFROMS3S4,
 340         DETECT_REASON_HPD,
 341         DETECT_REASON_HPDRX,
 342         DETECT_REASON_FALLBACK,
 343         DETECT_REASON_RETRAIN,
 344 };
 345
 346 bool dc_link_detect(struct dc_link *dc_link, enum dc_detect_reason reason);
 347 bool dc_link_get_hpd_state(struct dc_link *dc_link);
 348 enum dc_status dc_link_allocate_mst_payload(struct pipe_ctx *pipe_ctx);
 349 enum dc_status dc_link_reduce_mst_payload(struct pipe_ctx *pipe_ctx, uint32_t req_pbn);
 350 enum dc_status dc_link_increase_mst_payload(struct pipe_ctx *pipe_ctx, uint32_t req_pbn);
 351
 352 /* Notify DC about DP RX Interrupt (aka Short Pulse Interrupt).
 353  * Return:
 354  * true - Downstream port status changed. DM should call DC to do the
 355  * detection.
 356  * false - no change in Downstream port status. No further action required
 357  * from DM. */
 358 bool dc_link_handle_hpd_rx_irq(struct dc_link *dc_link,
 359                 union hpd_irq_data *hpd_irq_dpcd_data, bool *out_link_loss,
 360                 bool defer_handling, bool *has_left_work);
 361
 362 /*
 363  * On eDP links this function call will stall until T12 has elapsed.
 364  * If the panel is not in power off state, this function will return
 365  * immediately.
 366  */
 367 bool dc_link_wait_for_t12(struct dc_link *link);
 368
 369 void dc_link_dp_handle_automated_test(struct dc_link *link);
 370 void dc_link_dp_handle_link_loss(struct dc_link *link);
 371 bool dc_link_dp_allow_hpd_rx_irq(const struct dc_link *link);
 372
 373 struct dc_sink_init_data;
 374
 375 struct dc_sink *dc_link_add_remote_sink(
 376                 struct dc_link *dc_link,
 377                 const uint8_t *edid,
 378                 int len,
 379                 struct dc_sink_init_data *init_data);
 380
 381 void dc_link_remove_remote_sink(
 382         struct dc_link *link,
 383         struct dc_sink *sink);
 384
 385 /* Used by diagnostics for virtual link at the moment */
 386
 387 void dc_link_dp_set_drive_settings(
 388         struct dc_link *link,
 389         const struct link_resource *link_res,
 390         struct link_training_settings *lt_settings);
 391
 392 bool dc_link_dp_perform_link_training_skip_aux(
 393         struct dc_link *link,
 394         const struct link_resource *link_res,
 395         const struct dc_link_settings *link_setting);
 396
 397 enum link_training_result dc_link_dp_perform_link_training(
 398         struct dc_link *link,
 399         const struct link_resource *link_res,
 400         const struct dc_link_settings *link_settings,
 401         bool skip_video_pattern);
 402
 403 bool dc_link_dp_sync_lt_begin(struct dc_link *link);
 404
 405 enum link_training_result dc_link_dp_sync_lt_attempt(
 406         struct dc_link *link,
 407         const struct link_resource *link_res,
 408         struct dc_link_settings *link_setting,
 409         struct dc_link_training_overrides *lt_settings);
 410
 411 bool dc_link_dp_sync_lt_end(struct dc_link *link, bool link_down);
 412
 413 void dc_link_dp_enable_hpd(const struct dc_link *link);
 414
 415 void dc_link_dp_disable_hpd(const struct dc_link *link);
 416
 417 bool dc_link_dp_set_test_pattern(
 418         struct dc_link *link,
 419         enum dp_test_pattern test_pattern,
 420         enum dp_test_pattern_color_space test_pattern_color_space,
 421         const struct link_training_settings *p_link_settings,
 422         const unsigned char *p_custom_pattern,
 423         unsigned int cust_pattern_size);
 424
 425 bool dc_link_dp_get_max_link_enc_cap(const struct dc_link *link, struct dc_link_settings *max_link_enc_cap);
 426
 427 void dc_link_enable_hpd_filter(struct dc_link *link, bool enable);
 428
 429 bool dc_link_is_dp_sink_present(struct dc_link *link);
 430
 431 bool dc_link_detect_sink(struct dc_link *link, enum dc_connection_type *type);
 432 /*
 433  * DPCD access interfaces
 434  */
 435
 436 #ifdef CONFIG_DRM_AMD_DC_HDCP
 437 bool dc_link_is_hdcp14(struct dc_link *link, enum signal_type signal);
 438 bool dc_link_is_hdcp22(struct dc_link *link, enum signal_type signal);
 439 #endif
 440 void dc_link_set_drive_settings(struct dc *dc,
 441                                 struct link_training_settings *lt_settings,
 442                                 const struct dc_link *link);
 443 void dc_link_set_preferred_link_settings(struct dc *dc,
 444                                          struct dc_link_settings *link_setting,
 445                                          struct dc_link *link);
 446 void dc_link_set_preferred_training_settings(struct dc *dc,
 447                                         struct dc_link_settings *link_setting,
 448                                         struct dc_link_training_overrides *lt_overrides,
 449                                         struct dc_link *link,
 450                                         bool skip_immediate_retrain);
 451 void dc_link_enable_hpd(const struct dc_link *link);
 452 void dc_link_disable_hpd(const struct dc_link *link);
 453 void dc_link_set_test_pattern(struct dc_link *link,
 454                         enum dp_test_pattern test_pattern,
 455                         enum dp_test_pattern_color_space test_pattern_color_space,
 456                         const struct link_training_settings *p_link_settings,
 457                         const unsigned char *p_custom_pattern,
 458                         unsigned int cust_pattern_size);
 459 uint32_t dc_link_bandwidth_kbps(
 460         const struct dc_link *link,
 461         const struct dc_link_settings *link_setting);
 462
 463 const struct dc_link_settings *dc_link_get_link_cap(
 464                 const struct dc_link *link);
 465
 466 void dc_link_overwrite_extended_receiver_cap(
 467                 struct dc_link *link);
 468
 469 bool dc_is_oem_i2c_device_present(
 470         struct dc *dc,
 471         size_t slave_address
 472 );
 473
 474 bool dc_submit_i2c(
 475                 struct dc *dc,
 476                 uint32_t link_index,
 477                 struct i2c_command *cmd);
 478
 479 bool dc_submit_i2c_oem(
 480                 struct dc *dc,
 481                 struct i2c_command *cmd);
 482
 483 uint32_t dc_bandwidth_in_kbps_from_timing(
 484         const struct dc_crtc_timing *timing);
 485
 486 bool dc_link_is_fec_supported(const struct dc_link *link);
 487 bool dc_link_should_enable_fec(const struct dc_link *link);
 488
 489 uint32_t dc_link_bw_kbps_from_raw_frl_link_rate_data(uint8_t bw);
 490 enum dp_link_encoding dc_link_dp_mst_decide_link_encoding_format(const struct dc_link *link);
 491
 492 void dc_link_get_cur_link_res(const struct dc_link *link,
 493                 struct link_resource *link_res);
 494 /* take a snapshot of current link resource allocation state */
 495 void dc_get_cur_link_res_map(const struct dc *dc, uint32_t *map);
 496 /* restore link resource allocation state from a snapshot */
 497 void dc_restore_link_res_map(const struct dc *dc, uint32_t *map);
 498 void dc_link_clear_dprx_states(struct dc_link *link);
 499 struct gpio *get_hpd_gpio(struct dc_bios *dcb,
 500                 struct graphics_object_id link_id,
 501                 struct gpio_service *gpio_service);
 502 void dp_trace_reset(struct dc_link *link);
 503 bool dc_dp_trace_is_initialized(struct dc_link *link);
 504 unsigned long long dc_dp_trace_get_lt_end_timestamp(struct dc_link *link,
 505                 bool in_detection);
 506 void dc_dp_trace_set_is_logged_flag(struct dc_link *link,
 507                 bool in_detection,
 508                 bool is_logged);
 509 bool dc_dp_trace_is_logged(struct dc_link *link,
 510                 bool in_detection);
 511 struct dp_trace_lt_counts *dc_dp_trace_get_lt_counts(struct dc_link *link,
 512                 bool in_detection);
 513 unsigned int dc_dp_trace_get_link_loss_count(struct dc_link *link);
 514 #endif /* DC_LINK_H_ */