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