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