1/*
2 * Copyright 2022 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/* FILE POLICY AND INTENDED USAGE:
30 *
31 * This header defines link component function interfaces aka link_service.
32 * link_service provides the only entry point to link functions with function
33 * pointer style. This header is strictly private in dc and should never be
34 * included by DM because it exposes too much dc detail including all dc
35 * private types defined in core_types.h. Otherwise it will break DM - DC
36 * encapsulation and turn DM into a maintenance nightmare.
37 *
38 * The following shows a link component relation map.
39 *
40 * DM to DC:
41 * DM includes dc.h
42 * dc_link_exports.c or other dc files implement dc.h
43 *
44 * DC to Link:
45 * dc_link_exports.c or other dc files include link_service.h
46 * link_factory.c implements link_service.h
47 *
48 * Link sub-component to Link sub-component:
49 * link_factory.c includes --> link_xxx.h
50 * link_xxx.c implements link_xxx.h
51
52 * As you can see if you ever need to add a new dc link function and call it on
53 * DM/dc side, it is very difficult because you will need layers of translation.
54 * The most appropriate approach to implement new requirements on DM/dc side is
55 * to extend or generalize the functionality of existing link function
56 * interfaces so minimal modification is needed outside link component to
57 * achieve your new requirements. This approach reduces or even eliminates the
58 * effort needed outside link component to support a new link feature. This also
59 * reduces code discrepancy among DMs to support the same link feature. If we
60 * test full code path on one version of DM, and there is no feature specific
61 * modification required on other DMs, then we can have higher confidence that
62 * the feature will run on other DMs and produce the same result. The following
63 * are some good examples to start with:
64 *
65 * - detect_link --> to add new link detection or capability retrieval routines
66 *
67 * - validate_mode_timing --> to add new timing validation conditions
68 *
69 * - set_dpms_on/set_dpms_off --> to include new link enablement sequences
70 *
71 * If you must add new link functions, you will need to:
72 * 1. declare the function pointer here under the suitable commented category.
73 * 2. Implement your function in the suitable link_xxx.c file.
74 * 3. Assign the function to link_service in link_factory.c
75 * 4. NEVER include link_xxx.h headers outside link component.
76 * 5. NEVER include link_service.h on DM side.
77 */
78#include "core_types.h"
79
80struct link_service *link_create_link_service(void);
81void link_destroy_link_service(struct link_service **link_srv);
82
83struct link_init_data {
84 const struct dc *dc;
85 struct dc_context *ctx; /* TODO: remove 'dal' when DC is complete. */
86 uint32_t connector_index; /* this will be mapped to the HPD pins */
87 uint32_t link_index; /* this is mapped to DAL display_index
88 TODO: remove it when DC is complete. */
89 bool is_dpia_link;
90};
91
92struct ddc_service_init_data {
93 struct graphics_object_id id;
94 struct dc_context *ctx;
95 struct dc_link *link;
96 bool is_dpia_link;
97};
98
99struct link_service {
100 /************************** Factory ***********************************/
101 struct dc_link *(*create_link)(
102 const struct link_init_data *init_params);
103 void (*destroy_link)(struct dc_link **link);
104
105
106 /************************** Detection *********************************/
107 bool (*detect_link)(struct dc_link *link, enum dc_detect_reason reason);
108 bool (*detect_connection_type)(struct dc_link *link,
109 enum dc_connection_type *type);
110 struct dc_sink *(*add_remote_sink)(
111 struct dc_link *link,
112 const uint8_t *edid,
113 int len,
114 struct dc_sink_init_data *init_data);
115 void (*remove_remote_sink)(struct dc_link *link, struct dc_sink *sink);
116 bool (*get_hpd_state)(struct dc_link *link);
117 struct gpio *(*get_hpd_gpio)(struct dc_bios *dcb,
118 struct graphics_object_id link_id,
119 struct gpio_service *gpio_service);
120 void (*enable_hpd)(const struct dc_link *link);
121 void (*disable_hpd)(const struct dc_link *link);
122 void (*enable_hpd_filter)(struct dc_link *link, bool enable);
123 bool (*reset_cur_dp_mst_topology)(struct dc_link *link);
124 const struct dc_link_status *(*get_status)(const struct dc_link *link);
125 bool (*is_hdcp1x_supported)(struct dc_link *link,
126 enum signal_type signal);
127 bool (*is_hdcp2x_supported)(struct dc_link *link,
128 enum signal_type signal);
129 void (*clear_dprx_states)(struct dc_link *link);
130
131
132 /*************************** Resource *********************************/
133 void (*get_cur_res_map)(const struct dc *dc, uint32_t *map);
134 void (*restore_res_map)(const struct dc *dc, uint32_t *map);
135 void (*get_cur_link_res)(const struct dc_link *link,
136 struct link_resource *link_res);
137
138
139 /*************************** Validation *******************************/
140 enum dc_status (*validate_mode_timing)(
141 const struct dc_stream_state *stream,
142 struct dc_link *link,
143 const struct dc_crtc_timing *timing);
144 uint32_t (*dp_link_bandwidth_kbps)(
145 const struct dc_link *link,
146 const struct dc_link_settings *link_settings);
147 enum dc_status (*validate_dp_tunnel_bandwidth)(
148 const struct dc *dc,
149 const struct dc_state *new_ctx);
150
151 uint32_t (*dp_required_hblank_size_bytes)(
152 const struct dc_link *link,
153 struct dp_audio_bandwidth_params *audio_params);
154
155
156 /*************************** DPMS *************************************/
157 void (*set_dpms_on)(struct dc_state *state, struct pipe_ctx *pipe_ctx);
158 void (*set_dpms_off)(struct pipe_ctx *pipe_ctx);
159 void (*resume)(struct dc_link *link);
160 void (*blank_all_dp_displays)(struct dc *dc);
161 void (*blank_all_edp_displays)(struct dc *dc);
162 void (*blank_dp_stream)(struct dc_link *link, bool hw_init);
163 enum dc_status (*increase_mst_payload)(
164 struct pipe_ctx *pipe_ctx, uint32_t req_pbn);
165 enum dc_status (*reduce_mst_payload)(
166 struct pipe_ctx *pipe_ctx, uint32_t req_pbn);
167 void (*set_dsc_on_stream)(struct pipe_ctx *pipe_ctx, bool enable);
168 bool (*set_dsc_enable)(struct pipe_ctx *pipe_ctx, bool enable);
169 bool (*update_dsc_config)(struct pipe_ctx *pipe_ctx);
170
171
172 /*************************** DDC **************************************/
173 struct ddc_service *(*create_ddc_service)(
174 struct ddc_service_init_data *ddc_init_data);
175 void (*destroy_ddc_service)(struct ddc_service **ddc);
176 bool (*query_ddc_data)(
177 struct ddc_service *ddc,
178 uint32_t address,
179 uint8_t *write_buf,
180 uint32_t write_size,
181 uint8_t *read_buf,
182 uint32_t read_size);
183 int (*aux_transfer_raw)(struct ddc_service *ddc,
184 struct aux_payload *payload,
185 enum aux_return_code_type *operation_result);
186 bool (*configure_fixed_vs_pe_retimer)(
187 struct ddc_service *ddc,
188 const uint8_t *data,
189 uint32_t len);
190 bool (*aux_transfer_with_retries_no_mutex)(struct ddc_service *ddc,
191 struct aux_payload *payload);
192 bool (*is_in_aux_transaction_mode)(struct ddc_service *ddc);
193 uint32_t (*get_aux_defer_delay)(struct ddc_service *ddc);
194
195
196 /*************************** DP Capability ****************************/
197 bool (*dp_is_sink_present)(struct dc_link *link);
198 bool (*dp_is_fec_supported)(const struct dc_link *link);
199 bool (*dp_is_128b_132b_signal)(struct pipe_ctx *pipe_ctx);
200 bool (*dp_get_max_link_enc_cap)(const struct dc_link *link,
201 struct dc_link_settings *max_link_enc_cap);
202 const struct dc_link_settings *(*dp_get_verified_link_cap)(
203 const struct dc_link *link);
204 enum dp_link_encoding (*dp_get_encoding_format)(
205 const struct dc_link_settings *link_settings);
206 bool (*dp_should_enable_fec)(const struct dc_link *link);
207 bool (*dp_decide_link_settings)(
208 struct dc_stream_state *stream,
209 struct dc_link_settings *link_setting);
210 void (*dp_decide_tunnel_settings)(
211 struct dc_stream_state *stream,
212 struct dc_tunnel_settings *dp_tunnel_setting);
213 enum dp_link_encoding (*mst_decide_link_encoding_format)(
214 const struct dc_link *link);
215 bool (*edp_decide_link_settings)(struct dc_link *link,
216 struct dc_link_settings *link_setting, uint32_t req_bw);
217 uint32_t (*bw_kbps_from_raw_frl_link_rate_data)(uint8_t bw);
218 bool (*dp_overwrite_extended_receiver_cap)(struct dc_link *link);
219 enum lttpr_mode (*dp_decide_lttpr_mode)(struct dc_link *link,
220 struct dc_link_settings *link_setting);
221 uint8_t (*dp_get_lttpr_count)(struct dc_link *link);
222 void (*edp_get_alpm_support)(struct dc_link *link,
223 bool *auxless_support,
224 bool *auxwake_support);
225
226 /*************************** DP DPIA/PHY ******************************/
227 void (*dpia_handle_usb4_bandwidth_allocation_for_link)(
228 struct dc_link *link, int peak_bw);
229 void (*dp_set_drive_settings)(
230 struct dc_link *link,
231 const struct link_resource *link_res,
232 struct link_training_settings *lt_settings);
233 void (*dpcd_write_rx_power_ctrl)(struct dc_link *link, bool on);
234
235
236 /*************************** DP IRQ Handler ***************************/
237 bool (*dp_parse_link_loss_status)(
238 struct dc_link *link,
239 union hpd_irq_data *hpd_irq_dpcd_data);
240 bool (*dp_should_allow_hpd_rx_irq)(const struct dc_link *link);
241 void (*dp_handle_link_loss)(struct dc_link *link);
242 enum dc_status (*dp_read_hpd_rx_irq_data)(
243 struct dc_link *link,
244 union hpd_irq_data *irq_data);
245 bool (*dp_handle_hpd_rx_irq)(struct dc_link *link,
246 union hpd_irq_data *out_hpd_irq_dpcd_data,
247 bool *out_link_loss,
248 bool defer_handling, bool *has_left_work);
249
250
251 /*************************** eDP Panel Control ************************/
252 void (*edp_panel_backlight_power_on)(
253 struct dc_link *link, bool wait_for_hpd);
254 int (*edp_get_backlight_level)(const struct dc_link *link);
255 bool (*edp_get_backlight_level_nits)(struct dc_link *link,
256 uint32_t *backlight_millinits_avg,
257 uint32_t *backlight_millinits_peak);
258 bool (*edp_set_backlight_level)(const struct dc_link *link,
259 struct set_backlight_level_params *backlight_level_params);
260 bool (*edp_set_backlight_level_nits)(struct dc_link *link,
261 bool isHDR,
262 uint32_t backlight_millinits,
263 uint32_t transition_time_in_ms);
264 int (*edp_get_target_backlight_pwm)(const struct dc_link *link);
265 bool (*edp_get_psr_state)(
266 const struct dc_link *link, enum dc_psr_state *state);
267 bool (*edp_set_psr_allow_active)(
268 struct dc_link *link,
269 const bool *allow_active,
270 bool wait,
271 bool force_static,
272 const unsigned int *power_opts);
273 bool (*edp_setup_psr)(struct dc_link *link,
274 const struct dc_stream_state *stream,
275 struct psr_config *psr_config,
276 struct psr_context *psr_context);
277 bool (*edp_set_sink_vtotal_in_psr_active)(
278 const struct dc_link *link,
279 uint16_t psr_vtotal_idle,
280 uint16_t psr_vtotal_su);
281 void (*edp_get_psr_residency)(
282 const struct dc_link *link, uint32_t *residency, enum psr_residency_mode mode);
283
284 bool (*edp_get_replay_state)(
285 const struct dc_link *link, uint64_t *state);
286 bool (*edp_set_replay_allow_active)(struct dc_link *dc_link,
287 const bool *enable, bool wait, bool force_static,
288 const unsigned int *power_opts);
289 bool (*edp_setup_replay)(struct dc_link *link,
290 const struct dc_stream_state *stream);
291 bool (*edp_send_replay_cmd)(struct dc_link *link,
292 enum replay_FW_Message_type msg,
293 union dmub_replay_cmd_set *cmd_data);
294 bool (*edp_set_coasting_vtotal)(
295 struct dc_link *link, uint32_t coasting_vtotal, uint16_t frame_skip_number);
296 bool (*edp_replay_residency)(const struct dc_link *link,
297 unsigned int *residency, const bool is_start,
298 const enum pr_residency_mode mode);
299 bool (*edp_set_replay_power_opt_and_coasting_vtotal)(struct dc_link *link,
300 const unsigned int *power_opts, uint32_t coasting_vtotal, uint16_t frame_skip_number);
301
302 bool (*edp_wait_for_t12)(struct dc_link *link);
303 bool (*edp_is_ilr_optimization_required)(struct dc_link *link,
304 struct dc_crtc_timing *crtc_timing);
305 bool (*edp_backlight_enable_aux)(struct dc_link *link, bool enable);
306 void (*edp_add_delay_for_T9)(struct dc_link *link);
307 bool (*edp_receiver_ready_T9)(struct dc_link *link);
308 bool (*edp_receiver_ready_T7)(struct dc_link *link);
309 bool (*edp_power_alpm_dpcd_enable)(struct dc_link *link, bool enable);
310 void (*edp_set_panel_power)(struct dc_link *link, bool powerOn);
311
312
313 /*************************** DP CTS ************************************/
314 void (*dp_handle_automated_test)(struct dc_link *link);
315 bool (*dp_set_test_pattern)(
316 struct dc_link *link,
317 enum dp_test_pattern test_pattern,
318 enum dp_test_pattern_color_space test_pattern_color_space,
319 const struct link_training_settings *p_link_settings,
320 const unsigned char *p_custom_pattern,
321 unsigned int cust_pattern_size);
322 void (*dp_set_preferred_link_settings)(struct dc *dc,
323 struct dc_link_settings *link_setting,
324 struct dc_link *link);
325 void (*dp_set_preferred_training_settings)(struct dc *dc,
326 struct dc_link_settings *link_setting,
327 struct dc_link_training_overrides *lt_overrides,
328 struct dc_link *link,
329 bool skip_immediate_retrain);
330
331
332 /*************************** DP Trace *********************************/
333 bool (*dp_trace_is_initialized)(struct dc_link *link);
334 void (*dp_trace_set_is_logged_flag)(struct dc_link *link,
335 bool in_detection,
336 bool is_logged);
337 bool (*dp_trace_is_logged)(struct dc_link *link, bool in_detection);
338 unsigned long long (*dp_trace_get_lt_end_timestamp)(
339 struct dc_link *link, bool in_detection);
340 const struct dp_trace_lt_counts *(*dp_trace_get_lt_counts)(
341 struct dc_link *link, bool in_detection);
342 unsigned int (*dp_trace_get_link_loss_count)(struct dc_link *link);
343 void (*dp_trace_set_edp_power_timestamp)(struct dc_link *link,
344 bool power_up);
345 uint64_t (*dp_trace_get_edp_poweron_timestamp)(struct dc_link *link);
346 uint64_t (*dp_trace_get_edp_poweroff_timestamp)(struct dc_link *link);
347 void (*dp_trace_source_sequence)(
348 struct dc_link *link, uint8_t dp_test_mode);
349};
350#endif /* __DC_LINK_HPD_H__ */
351

source code of linux/drivers/gpu/drm/amd/display/dc/inc/link_service.h