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_types.h"
  30 #include "grph_object_defs.h"
  31
  32 #ifdef CONFIG_DRM_AMD_DC_DSC_SUPPORT
  33 enum dc_link_fec_state {
  34         dc_link_fec_not_ready,
  35         dc_link_fec_ready,
  36         dc_link_fec_enabled
  37 };
  38 #endif
  39 struct dc_link_status {
  40         bool link_active;
  41         struct dpcd_caps *dpcd_caps;
  42 };
  43
  44 /* DP MST stream allocation (payload bandwidth number) */
  45 struct link_mst_stream_allocation {
  46         /* DIG front */
  47         const struct stream_encoder *stream_enc;
  48         /* associate DRM payload table with DC stream encoder */
  49         uint8_t vcp_id;
  50         /* number of slots required for the DP stream in transport packet */
  51         uint8_t slot_count;
  52 };
  53
  54 /* DP MST stream allocation table */
  55 struct link_mst_stream_allocation_table {
  56         /* number of DP video streams */
  57         int stream_count;
  58         /* array of stream allocations */
  59         struct link_mst_stream_allocation stream_allocations[MAX_CONTROLLER_NUM];
  60 };
  61
  62 struct time_stamp {
  63         uint64_t edp_poweroff;
  64         uint64_t edp_poweron;
  65 };
  66
  67 struct link_trace {
  68         struct time_stamp time_stamp;
  69 };
  70 /*
  71  * A link contains one or more sinks and their connected status.
  72  * The currently active signal type (HDMI, DP-SST, DP-MST) is also reported.
  73  */
  74 struct dc_link {
  75         struct dc_sink *remote_sinks[MAX_SINKS_PER_LINK];
  76         unsigned int sink_count;
  77         struct dc_sink *local_sink;
  78         unsigned int link_index;
  79         enum dc_connection_type type;
  80         enum signal_type connector_signal;
  81         enum dc_irq_source irq_source_hpd;
  82         enum dc_irq_source irq_source_hpd_rx;/* aka DP Short Pulse  */
  83         bool is_hpd_filter_disabled;
  84         bool dp_ss_off;
  85         bool link_state_valid;
  86         bool aux_access_disabled;
  87         bool sync_lt_in_progress;
  88
  89         /* caps is the same as reported_link_cap. link_traing use
  90          * reported_link_cap. Will clean up.  TODO
  91          */
  92         struct dc_link_settings reported_link_cap;
  93         struct dc_link_settings verified_link_cap;
  94         struct dc_link_settings cur_link_settings;
  95         struct dc_lane_settings cur_lane_setting;
  96         struct dc_link_settings preferred_link_setting;
  97         struct dc_link_training_overrides preferred_training_settings;
  98
  99         uint8_t ddc_hw_inst;
 100
 101         uint8_t hpd_src;
 102
 103         uint8_t link_enc_hw_inst;
 104
 105         bool test_pattern_enabled;
 106         union compliance_test_state compliance_test_state;
 107
 108         void *priv;
 109
 110         struct ddc_service *ddc;
 111
 112         bool aux_mode;
 113
 114         /* Private to DC core */
 115
 116         const struct dc *dc;
 117
 118         struct dc_context *ctx;
 119
 120         struct link_encoder *link_enc;
 121         struct graphics_object_id link_id;
 122         union ddi_channel_mapping ddi_channel_mapping;
 123         struct connector_device_tag_info device_tag;
 124         struct dpcd_caps dpcd_caps;
 125         uint32_t dongle_max_pix_clk;
 126         unsigned short chip_caps;
 127         unsigned int dpcd_sink_count;
 128         enum edp_revision edp_revision;
 129         bool psr_feature_enabled;
 130         bool psr_allow_active;
 131
 132         /* MST record stream using this link */
 133         struct link_flags {
 134                 bool dp_keep_receiver_powered;
 135                 bool dp_skip_DID2;
 136         } wa_flags;
 137         struct link_mst_stream_allocation_table mst_stream_alloc_table;
 138
 139         struct dc_link_status link_status;
 140
 141         struct link_trace link_trace;
 142         struct gpio *hpd_gpio;
 143 #ifdef CONFIG_DRM_AMD_DC_DSC_SUPPORT
 144         enum dc_link_fec_state fec_state;
 145 #endif
 146 };
 147
 148 const struct dc_link_status *dc_link_get_status(const struct dc_link *dc_link);
 149
 150 /**
 151  * dc_get_link_at_index() - Return an enumerated dc_link.
 152  *
 153  * dc_link order is constant and determined at
 154  * boot time.  They cannot be created or destroyed.
 155  * Use dc_get_caps() to get number of links.
 156  */
 157 static inline struct dc_link *dc_get_link_at_index(struct dc *dc, uint32_t link_index)
 158 {
 159         return dc->links[link_index];
 160 }
 161
 162 static inline struct dc_link *get_edp_link(const struct dc *dc)
 163 {
 164         int i;
 165
 166         // report any eDP links, even unconnected DDI's
 167         for (i = 0; i < dc->link_count; i++) {
 168                 if (dc->links[i]->connector_signal == SIGNAL_TYPE_EDP)
 169                         return dc->links[i];
 170         }
 171         return NULL;
 172 }
 173
 174 /* Set backlight level of an embedded panel (eDP, LVDS).
 175  * backlight_pwm_u16_16 is unsigned 32 bit with 16 bit integer
 176  * and 16 bit fractional, where 1.0 is max backlight value.
 177  */
 178 bool dc_link_set_backlight_level(const struct dc_link *dc_link,
 179                 uint32_t backlight_pwm_u16_16,
 180                 uint32_t frame_ramp);
 181
 182 int dc_link_get_backlight_level(const struct dc_link *dc_link);
 183
 184 bool dc_link_set_abm_disable(const struct dc_link *dc_link);
 185
 186 bool dc_link_set_psr_allow_active(struct dc_link *dc_link, bool enable, bool wait);
 187
 188 bool dc_link_get_psr_state(const struct dc_link *dc_link, uint32_t *psr_state);
 189
 190 bool dc_link_setup_psr(struct dc_link *dc_link,
 191                 const struct dc_stream_state *stream, struct psr_config *psr_config,
 192                 struct psr_context *psr_context);
 193
 194 /* Request DC to detect if there is a Panel connected.
 195  * boot - If this call is during initial boot.
 196  * Return false for any type of detection failure or MST detection
 197  * true otherwise. True meaning further action is required (status update
 198  * and OS notification).
 199  */
 200 enum dc_detect_reason {
 201         DETECT_REASON_BOOT,
 202         DETECT_REASON_HPD,
 203         DETECT_REASON_HPDRX,
 204 };
 205
 206 bool dc_link_detect(struct dc_link *dc_link, enum dc_detect_reason reason);
 207 bool dc_link_get_hpd_state(struct dc_link *dc_link);
 208 enum dc_status dc_link_allocate_mst_payload(struct pipe_ctx *pipe_ctx);
 209
 210 /* Notify DC about DP RX Interrupt (aka Short Pulse Interrupt).
 211  * Return:
 212  * true - Downstream port status changed. DM should call DC to do the
 213  * detection.
 214  * false - no change in Downstream port status. No further action required
 215  * from DM. */
 216 bool dc_link_handle_hpd_rx_irq(struct dc_link *dc_link,
 217                 union hpd_irq_data *hpd_irq_dpcd_data, bool *out_link_loss);
 218
 219 struct dc_sink_init_data;
 220
 221 struct dc_sink *dc_link_add_remote_sink(
 222                 struct dc_link *dc_link,
 223                 const uint8_t *edid,
 224                 int len,
 225                 struct dc_sink_init_data *init_data);
 226
 227 void dc_link_remove_remote_sink(
 228         struct dc_link *link,
 229         struct dc_sink *sink);
 230
 231 /* Used by diagnostics for virtual link at the moment */
 232
 233 void dc_link_dp_set_drive_settings(
 234         struct dc_link *link,
 235         struct link_training_settings *lt_settings);
 236
 237 bool dc_link_dp_perform_link_training_skip_aux(
 238         struct dc_link *link,
 239         const struct dc_link_settings *link_setting);
 240
 241 enum link_training_result dc_link_dp_perform_link_training(
 242         struct dc_link *link,
 243         const struct dc_link_settings *link_setting,
 244         bool skip_video_pattern);
 245
 246 bool dc_link_dp_sync_lt_begin(struct dc_link *link);
 247
 248 enum link_training_result dc_link_dp_sync_lt_attempt(
 249         struct dc_link *link,
 250         struct dc_link_settings *link_setting,
 251         struct dc_link_training_overrides *lt_settings);
 252
 253 bool dc_link_dp_sync_lt_end(struct dc_link *link, bool link_down);
 254
 255 void dc_link_dp_enable_hpd(const struct dc_link *link);
 256
 257 void dc_link_dp_disable_hpd(const struct dc_link *link);
 258
 259 bool dc_link_dp_set_test_pattern(
 260         struct dc_link *link,
 261         enum dp_test_pattern test_pattern,
 262         const struct link_training_settings *p_link_settings,
 263         const unsigned char *p_custom_pattern,
 264         unsigned int cust_pattern_size);
 265
 266 void dc_link_enable_hpd_filter(struct dc_link *link, bool enable);
 267
 268 bool dc_link_is_dp_sink_present(struct dc_link *link);
 269
 270 bool dc_link_detect_sink(struct dc_link *link, enum dc_connection_type *type);
 271 /*
 272  * DPCD access interfaces
 273  */
 274
 275 void dc_link_set_drive_settings(struct dc *dc,
 276                                 struct link_training_settings *lt_settings,
 277                                 const struct dc_link *link);
 278 void dc_link_perform_link_training(struct dc *dc,
 279                                    struct dc_link_settings *link_setting,
 280                                    bool skip_video_pattern);
 281 void dc_link_set_preferred_link_settings(struct dc *dc,
 282                                          struct dc_link_settings *link_setting,
 283                                          struct dc_link *link);
 284 void dc_link_set_preferred_training_settings(struct dc *dc,
 285                                         struct dc_link_settings *link_setting,
 286                                         struct dc_link_training_overrides *lt_overrides,
 287                                         struct dc_link *link,
 288                                         bool skip_immediate_retrain);
 289 void dc_link_enable_hpd(const struct dc_link *link);
 290 void dc_link_disable_hpd(const struct dc_link *link);
 291 void dc_link_set_test_pattern(struct dc_link *link,
 292                         enum dp_test_pattern test_pattern,
 293                         const struct link_training_settings *p_link_settings,
 294                         const unsigned char *p_custom_pattern,
 295                         unsigned int cust_pattern_size);
 296 uint32_t dc_link_bandwidth_kbps(
 297         const struct dc_link *link,
 298         const struct dc_link_settings *link_setting);
 299
 300 const struct dc_link_settings *dc_link_get_link_cap(
 301                 const struct dc_link *link);
 302
 303 bool dc_submit_i2c(
 304                 struct dc *dc,
 305                 uint32_t link_index,
 306                 struct i2c_command *cmd);
 307
 308 bool dc_submit_i2c_oem(
 309                 struct dc *dc,
 310                 struct i2c_command *cmd);
 311
 312 uint32_t dc_bandwidth_in_kbps_from_timing(
 313         const struct dc_crtc_timing *timing);
 314 #endif /* DC_LINK_H_ */