GNU Linux-libre 4.19.264-gnu1
[releases.git] / 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 struct dc_link_status {
33         struct dpcd_caps *dpcd_caps;
34 };
35
36 /* DP MST stream allocation (payload bandwidth number) */
37 struct link_mst_stream_allocation {
38         /* DIG front */
39         const struct stream_encoder *stream_enc;
40         /* associate DRM payload table with DC stream encoder */
41         uint8_t vcp_id;
42         /* number of slots required for the DP stream in transport packet */
43         uint8_t slot_count;
44 };
45
46 /* DP MST stream allocation table */
47 struct link_mst_stream_allocation_table {
48         /* number of DP video streams */
49         int stream_count;
50         /* array of stream allocations */
51         struct link_mst_stream_allocation stream_allocations[MAX_CONTROLLER_NUM];
52 };
53
54 struct time_stamp {
55         uint64_t edp_poweroff;
56         uint64_t edp_poweron;
57 };
58
59 struct link_trace {
60         struct time_stamp time_stamp;
61 };
62 /*
63  * A link contains one or more sinks and their connected status.
64  * The currently active signal type (HDMI, DP-SST, DP-MST) is also reported.
65  */
66 struct dc_link {
67         struct dc_sink *remote_sinks[MAX_SINKS_PER_LINK];
68         unsigned int sink_count;
69         struct dc_sink *local_sink;
70         unsigned int link_index;
71         enum dc_connection_type type;
72         enum signal_type connector_signal;
73         enum dc_irq_source irq_source_hpd;
74         enum dc_irq_source irq_source_hpd_rx;/* aka DP Short Pulse  */
75         bool is_hpd_filter_disabled;
76         bool dp_ss_off;
77
78         /* caps is the same as reported_link_cap. link_traing use
79          * reported_link_cap. Will clean up.  TODO
80          */
81         struct dc_link_settings reported_link_cap;
82         struct dc_link_settings verified_link_cap;
83         struct dc_link_settings cur_link_settings;
84         struct dc_lane_settings cur_lane_setting;
85         struct dc_link_settings preferred_link_setting;
86
87         uint8_t ddc_hw_inst;
88
89         uint8_t hpd_src;
90
91         uint8_t link_enc_hw_inst;
92
93         bool test_pattern_enabled;
94         union compliance_test_state compliance_test_state;
95
96         void *priv;
97
98         struct ddc_service *ddc;
99
100         bool aux_mode;
101
102         /* Private to DC core */
103
104         const struct dc *dc;
105
106         struct dc_context *ctx;
107
108         struct link_encoder *link_enc;
109         struct graphics_object_id link_id;
110         union ddi_channel_mapping ddi_channel_mapping;
111         struct connector_device_tag_info device_tag;
112         struct dpcd_caps dpcd_caps;
113         unsigned short chip_caps;
114         unsigned int dpcd_sink_count;
115         enum edp_revision edp_revision;
116         bool psr_enabled;
117
118         /* MST record stream using this link */
119         struct link_flags {
120                 bool dp_keep_receiver_powered;
121         } wa_flags;
122         struct link_mst_stream_allocation_table mst_stream_alloc_table;
123
124         struct dc_link_status link_status;
125
126         struct link_trace link_trace;
127 };
128
129 const struct dc_link_status *dc_link_get_status(const struct dc_link *dc_link);
130
131 /*
132  * Return an enumerated dc_link.  dc_link order is constant and determined at
133  * boot time.  They cannot be created or destroyed.
134  * Use dc_get_caps() to get number of links.
135  */
136 static inline struct dc_link *dc_get_link_at_index(struct dc *dc, uint32_t link_index)
137 {
138         return dc->links[link_index];
139 }
140
141 /* Set backlight level of an embedded panel (eDP, LVDS). */
142 bool dc_link_set_backlight_level(const struct dc_link *dc_link, uint32_t level,
143                 uint32_t frame_ramp, const struct dc_stream_state *stream);
144
145 int dc_link_get_backlight_level(const struct dc_link *dc_link);
146
147 bool dc_link_set_abm_disable(const struct dc_link *dc_link);
148
149 bool dc_link_set_psr_enable(const struct dc_link *dc_link, bool enable, bool wait);
150
151 bool dc_link_get_psr_state(const struct dc_link *dc_link, uint32_t *psr_state);
152
153 bool dc_link_setup_psr(struct dc_link *dc_link,
154                 const struct dc_stream_state *stream, struct psr_config *psr_config,
155                 struct psr_context *psr_context);
156
157 /* Request DC to detect if there is a Panel connected.
158  * boot - If this call is during initial boot.
159  * Return false for any type of detection failure or MST detection
160  * true otherwise. True meaning further action is required (status update
161  * and OS notification).
162  */
163 enum dc_detect_reason {
164         DETECT_REASON_BOOT,
165         DETECT_REASON_HPD,
166         DETECT_REASON_HPDRX,
167 };
168
169 bool dc_link_detect(struct dc_link *dc_link, enum dc_detect_reason reason);
170
171 /* Notify DC about DP RX Interrupt (aka Short Pulse Interrupt).
172  * Return:
173  * true - Downstream port status changed. DM should call DC to do the
174  * detection.
175  * false - no change in Downstream port status. No further action required
176  * from DM. */
177 bool dc_link_handle_hpd_rx_irq(struct dc_link *dc_link,
178                 union hpd_irq_data *hpd_irq_dpcd_data, bool *out_link_loss);
179
180 struct dc_sink_init_data;
181
182 struct dc_sink *dc_link_add_remote_sink(
183                 struct dc_link *dc_link,
184                 const uint8_t *edid,
185                 int len,
186                 struct dc_sink_init_data *init_data);
187
188 void dc_link_remove_remote_sink(
189         struct dc_link *link,
190         struct dc_sink *sink);
191
192 /* Used by diagnostics for virtual link at the moment */
193
194 void dc_link_dp_set_drive_settings(
195         struct dc_link *link,
196         struct link_training_settings *lt_settings);
197
198 enum link_training_result dc_link_dp_perform_link_training(
199         struct dc_link *link,
200         const struct dc_link_settings *link_setting,
201         bool skip_video_pattern);
202
203 void dc_link_dp_enable_hpd(const struct dc_link *link);
204
205 void dc_link_dp_disable_hpd(const struct dc_link *link);
206
207 bool dc_link_dp_set_test_pattern(
208         struct dc_link *link,
209         enum dp_test_pattern test_pattern,
210         const struct link_training_settings *p_link_settings,
211         const unsigned char *p_custom_pattern,
212         unsigned int cust_pattern_size);
213
214 void dc_link_enable_hpd_filter(struct dc_link *link, bool enable);
215
216 bool dc_link_is_dp_sink_present(struct dc_link *link);
217
218 bool dc_link_detect_sink(struct dc_link *link, enum dc_connection_type *type);
219 /*
220  * DPCD access interfaces
221  */
222
223 void dc_link_set_drive_settings(struct dc *dc,
224                                 struct link_training_settings *lt_settings,
225                                 const struct dc_link *link);
226 void dc_link_perform_link_training(struct dc *dc,
227                                    struct dc_link_settings *link_setting,
228                                    bool skip_video_pattern);
229 void dc_link_set_preferred_link_settings(struct dc *dc,
230                                          struct dc_link_settings *link_setting,
231                                          struct dc_link *link);
232 void dc_link_enable_hpd(const struct dc_link *link);
233 void dc_link_disable_hpd(const struct dc_link *link);
234 void dc_link_set_test_pattern(struct dc_link *link,
235                         enum dp_test_pattern test_pattern,
236                         const struct link_training_settings *p_link_settings,
237                         const unsigned char *p_custom_pattern,
238                         unsigned int cust_pattern_size);
239
240 bool dc_submit_i2c(
241                 struct dc *dc,
242                 uint32_t link_index,
243                 struct i2c_command *cmd);
244
245 #endif /* DC_LINK_H_ */