1 /* $NetBSD: dc_link.h,v 1.2 2021/12/18 23:45:00 riastradh Exp $ */
2
3 /*
4 * Copyright 2012-14 Advanced Micro Devices, Inc.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
20 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22 * OTHER DEALINGS IN THE SOFTWARE.
23 *
24 * Authors: AMD
25 *
26 */
27
28 #ifndef DC_LINK_H_
29 #define DC_LINK_H_
30
31 #include "dc_types.h"
32 #include "grph_object_defs.h"
33
34 enum dc_link_fec_state {
35 dc_link_fec_not_ready,
36 dc_link_fec_ready,
37 dc_link_fec_enabled
38 };
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 bool is_lttpr_mode_transparent;
89
90 /* caps is the same as reported_link_cap. link_traing use
91 * reported_link_cap. Will clean up. TODO
92 */
93 struct dc_link_settings reported_link_cap;
94 struct dc_link_settings verified_link_cap;
95 struct dc_link_settings cur_link_settings;
96 struct dc_lane_settings cur_lane_setting;
97 struct dc_link_settings preferred_link_setting;
98 struct dc_link_training_overrides preferred_training_settings;
99 struct dp_audio_test_data audio_test_data;
100
101 uint8_t ddc_hw_inst;
102
103 uint8_t hpd_src;
104
105 uint8_t link_enc_hw_inst;
106
107 bool test_pattern_enabled;
108 union compliance_test_state compliance_test_state;
109
110 void *priv;
111
112 struct ddc_service *ddc;
113
114 bool aux_mode;
115
116 /* Private to DC core */
117
118 const struct dc *dc;
119
120 struct dc_context *ctx;
121
122 struct link_encoder *link_enc;
123 struct graphics_object_id link_id;
124 union ddi_channel_mapping ddi_channel_mapping;
125 struct connector_device_tag_info device_tag;
126 struct dpcd_caps dpcd_caps;
127 uint32_t dongle_max_pix_clk;
128 unsigned short chip_caps;
129 unsigned int dpcd_sink_count;
130 enum edp_revision edp_revision;
131 bool psr_feature_enabled;
132 bool psr_allow_active;
133
134 /* MST record stream using this link */
135 struct link_flags {
136 bool dp_keep_receiver_powered;
137 bool dp_skip_DID2;
138 bool dp_skip_reset_segment;
139 } wa_flags;
140 struct link_mst_stream_allocation_table mst_stream_alloc_table;
141
142 struct dc_link_status link_status;
143
144 struct link_trace link_trace;
145 struct gpio *hpd_gpio;
146 enum dc_link_fec_state fec_state;
147 };
148
149 const struct dc_link_status *dc_link_get_status(const struct dc_link *dc_link);
150
151 /**
152 * dc_get_link_at_index() - Return an enumerated dc_link.
153 *
154 * dc_link order is constant and determined at
155 * boot time. They cannot be created or destroyed.
156 * Use dc_get_caps() to get number of links.
157 */
dc_get_link_at_index(struct dc * dc,uint32_t link_index)158 static inline struct dc_link *dc_get_link_at_index(struct dc *dc, uint32_t link_index)
159 {
160 return dc->links[link_index];
161 }
162
get_edp_link(const struct dc * dc)163 static inline struct dc_link *get_edp_link(const struct dc *dc)
164 {
165 int i;
166
167 // report any eDP links, even unconnected DDI's
168 for (i = 0; i < dc->link_count; i++) {
169 if (dc->links[i]->connector_signal == SIGNAL_TYPE_EDP)
170 return dc->links[i];
171 }
172 return NULL;
173 }
174
175 /* Set backlight level of an embedded panel (eDP, LVDS).
176 * backlight_pwm_u16_16 is unsigned 32 bit with 16 bit integer
177 * and 16 bit fractional, where 1.0 is max backlight value.
178 */
179 bool dc_link_set_backlight_level(const struct dc_link *dc_link,
180 uint32_t backlight_pwm_u16_16,
181 uint32_t frame_ramp);
182
183 int dc_link_get_backlight_level(const struct dc_link *dc_link);
184
185 bool dc_link_set_abm_disable(const struct dc_link *dc_link);
186
187 bool dc_link_set_psr_allow_active(struct dc_link *dc_link, bool enable, bool wait);
188
189 bool dc_link_get_psr_state(const struct dc_link *dc_link, uint32_t *psr_state);
190
191 bool dc_link_setup_psr(struct dc_link *dc_link,
192 const struct dc_stream_state *stream, struct psr_config *psr_config,
193 struct psr_context *psr_context);
194
195 /* Request DC to detect if there is a Panel connected.
196 * boot - If this call is during initial boot.
197 * Return false for any type of detection failure or MST detection
198 * true otherwise. True meaning further action is required (status update
199 * and OS notification).
200 */
201 enum dc_detect_reason {
202 DETECT_REASON_BOOT,
203 DETECT_REASON_HPD,
204 DETECT_REASON_HPDRX,
205 };
206
207 bool dc_link_detect(struct dc_link *dc_link, enum dc_detect_reason reason);
208 bool dc_link_get_hpd_state(struct dc_link *dc_link);
209 enum dc_status dc_link_allocate_mst_payload(struct pipe_ctx *pipe_ctx);
210 enum dc_status dc_link_reallocate_mst_payload(struct dc_link *link);
211
212 /* Notify DC about DP RX Interrupt (aka Short Pulse Interrupt).
213 * Return:
214 * true - Downstream port status changed. DM should call DC to do the
215 * detection.
216 * false - no change in Downstream port status. No further action required
217 * from DM. */
218 bool dc_link_handle_hpd_rx_irq(struct dc_link *dc_link,
219 union hpd_irq_data *hpd_irq_dpcd_data, bool *out_link_loss);
220
221 struct dc_sink_init_data;
222
223 struct dc_sink *dc_link_add_remote_sink(
224 struct dc_link *dc_link,
225 const uint8_t *edid,
226 int len,
227 struct dc_sink_init_data *init_data);
228
229 void dc_link_remove_remote_sink(
230 struct dc_link *link,
231 struct dc_sink *sink);
232
233 /* Used by diagnostics for virtual link at the moment */
234
235 void dc_link_dp_set_drive_settings(
236 struct dc_link *link,
237 struct link_training_settings *lt_settings);
238
239 bool dc_link_dp_perform_link_training_skip_aux(
240 struct dc_link *link,
241 const struct dc_link_settings *link_setting);
242
243 enum link_training_result dc_link_dp_perform_link_training(
244 struct dc_link *link,
245 const struct dc_link_settings *link_setting,
246 bool skip_video_pattern);
247
248 bool dc_link_dp_sync_lt_begin(struct dc_link *link);
249
250 enum link_training_result dc_link_dp_sync_lt_attempt(
251 struct dc_link *link,
252 struct dc_link_settings *link_setting,
253 struct dc_link_training_overrides *lt_settings);
254
255 bool dc_link_dp_sync_lt_end(struct dc_link *link, bool link_down);
256
257 void dc_link_dp_enable_hpd(const struct dc_link *link);
258
259 void dc_link_dp_disable_hpd(const struct dc_link *link);
260
261 bool dc_link_dp_set_test_pattern(
262 struct dc_link *link,
263 enum dp_test_pattern test_pattern,
264 enum dp_test_pattern_color_space test_pattern_color_space,
265 const struct link_training_settings *p_link_settings,
266 const unsigned char *p_custom_pattern,
267 unsigned int cust_pattern_size);
268
269 void dc_link_enable_hpd_filter(struct dc_link *link, bool enable);
270
271 bool dc_link_is_dp_sink_present(struct dc_link *link);
272
273 bool dc_link_detect_sink(struct dc_link *link, enum dc_connection_type *type);
274 /*
275 * DPCD access interfaces
276 */
277
278 void dc_link_set_drive_settings(struct dc *dc,
279 struct link_training_settings *lt_settings,
280 const struct dc_link *link);
281 void dc_link_perform_link_training(struct dc *dc,
282 struct dc_link_settings *link_setting,
283 bool skip_video_pattern);
284 void dc_link_set_preferred_link_settings(struct dc *dc,
285 struct dc_link_settings *link_setting,
286 struct dc_link *link);
287 void dc_link_set_preferred_training_settings(struct dc *dc,
288 struct dc_link_settings *link_setting,
289 struct dc_link_training_overrides *lt_overrides,
290 struct dc_link *link,
291 bool skip_immediate_retrain);
292 void dc_link_enable_hpd(const struct dc_link *link);
293 void dc_link_disable_hpd(const struct dc_link *link);
294 void dc_link_set_test_pattern(struct dc_link *link,
295 enum dp_test_pattern test_pattern,
296 enum dp_test_pattern_color_space test_pattern_color_space,
297 const struct link_training_settings *p_link_settings,
298 const unsigned char *p_custom_pattern,
299 unsigned int cust_pattern_size);
300 uint32_t dc_link_bandwidth_kbps(
301 const struct dc_link *link,
302 const struct dc_link_settings *link_setting);
303
304 const struct dc_link_settings *dc_link_get_link_cap(
305 const struct dc_link *link);
306
307 void dc_link_overwrite_extended_receiver_cap(
308 struct dc_link *link);
309
310 bool dc_submit_i2c(
311 struct dc *dc,
312 uint32_t link_index,
313 struct i2c_command *cmd);
314
315 bool dc_submit_i2c_oem(
316 struct dc *dc,
317 struct i2c_command *cmd);
318
319 uint32_t dc_bandwidth_in_kbps_from_timing(
320 const struct dc_crtc_timing *timing);
321 #endif /* DC_LINK_H_ */
322