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