Merge tag 'char-misc-4.19-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/gregk...
[sfrench/cifs-2.6.git] / drivers / gpu / drm / i915 / intel_display.h
1 /*
2  * Copyright © 2006-2017 Intel Corporation
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 (including the next
12  * paragraph) shall be included in all copies or substantial portions of the
13  * Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21  * IN THE SOFTWARE.
22  *
23  */
24
25 #ifndef _INTEL_DISPLAY_H_
26 #define _INTEL_DISPLAY_H_
27
28 enum pipe {
29         INVALID_PIPE = -1,
30
31         PIPE_A = 0,
32         PIPE_B,
33         PIPE_C,
34         _PIPE_EDP,
35
36         I915_MAX_PIPES = _PIPE_EDP
37 };
38
39 #define pipe_name(p) ((p) + 'A')
40
41 enum transcoder {
42         TRANSCODER_A = 0,
43         TRANSCODER_B,
44         TRANSCODER_C,
45         TRANSCODER_EDP,
46         TRANSCODER_DSI_A,
47         TRANSCODER_DSI_C,
48
49         I915_MAX_TRANSCODERS
50 };
51
52 static inline const char *transcoder_name(enum transcoder transcoder)
53 {
54         switch (transcoder) {
55         case TRANSCODER_A:
56                 return "A";
57         case TRANSCODER_B:
58                 return "B";
59         case TRANSCODER_C:
60                 return "C";
61         case TRANSCODER_EDP:
62                 return "EDP";
63         case TRANSCODER_DSI_A:
64                 return "DSI A";
65         case TRANSCODER_DSI_C:
66                 return "DSI C";
67         default:
68                 return "<invalid>";
69         }
70 }
71
72 static inline bool transcoder_is_dsi(enum transcoder transcoder)
73 {
74         return transcoder == TRANSCODER_DSI_A || transcoder == TRANSCODER_DSI_C;
75 }
76
77 /*
78  * Global legacy plane identifier. Valid only for primary/sprite
79  * planes on pre-g4x, and only for primary planes on g4x-bdw.
80  */
81 enum i9xx_plane_id {
82         PLANE_A,
83         PLANE_B,
84         PLANE_C,
85 };
86
87 #define plane_name(p) ((p) + 'A')
88 #define sprite_name(p, s) ((p) * INTEL_INFO(dev_priv)->num_sprites[(p)] + (s) + 'A')
89
90 /*
91  * Per-pipe plane identifier.
92  * I915_MAX_PLANES in the enum below is the maximum (across all platforms)
93  * number of planes per CRTC.  Not all platforms really have this many planes,
94  * which means some arrays of size I915_MAX_PLANES may have unused entries
95  * between the topmost sprite plane and the cursor plane.
96  *
97  * This is expected to be passed to various register macros
98  * (eg. PLANE_CTL(), PS_PLANE_SEL(), etc.) so adjust with care.
99  */
100 enum plane_id {
101         PLANE_PRIMARY,
102         PLANE_SPRITE0,
103         PLANE_SPRITE1,
104         PLANE_SPRITE2,
105         PLANE_CURSOR,
106
107         I915_MAX_PLANES,
108 };
109
110 #define for_each_plane_id_on_crtc(__crtc, __p) \
111         for ((__p) = PLANE_PRIMARY; (__p) < I915_MAX_PLANES; (__p)++) \
112                 for_each_if((__crtc)->plane_ids_mask & BIT(__p))
113
114 enum port {
115         PORT_NONE = -1,
116
117         PORT_A = 0,
118         PORT_B,
119         PORT_C,
120         PORT_D,
121         PORT_E,
122         PORT_F,
123
124         I915_MAX_PORTS
125 };
126
127 #define port_name(p) ((p) + 'A')
128
129 enum tc_port {
130         PORT_TC_NONE = -1,
131
132         PORT_TC1 = 0,
133         PORT_TC2,
134         PORT_TC3,
135         PORT_TC4,
136
137         I915_MAX_TC_PORTS
138 };
139
140 enum dpio_channel {
141         DPIO_CH0,
142         DPIO_CH1
143 };
144
145 enum dpio_phy {
146         DPIO_PHY0,
147         DPIO_PHY1,
148         DPIO_PHY2,
149 };
150
151 #define I915_NUM_PHYS_VLV 2
152
153 enum aux_ch {
154         AUX_CH_A,
155         AUX_CH_B,
156         AUX_CH_C,
157         AUX_CH_D,
158         AUX_CH_E, /* ICL+ */
159         AUX_CH_F,
160 };
161
162 #define aux_ch_name(a) ((a) + 'A')
163
164 enum intel_display_power_domain {
165         POWER_DOMAIN_PIPE_A,
166         POWER_DOMAIN_PIPE_B,
167         POWER_DOMAIN_PIPE_C,
168         POWER_DOMAIN_PIPE_A_PANEL_FITTER,
169         POWER_DOMAIN_PIPE_B_PANEL_FITTER,
170         POWER_DOMAIN_PIPE_C_PANEL_FITTER,
171         POWER_DOMAIN_TRANSCODER_A,
172         POWER_DOMAIN_TRANSCODER_B,
173         POWER_DOMAIN_TRANSCODER_C,
174         POWER_DOMAIN_TRANSCODER_EDP,
175         POWER_DOMAIN_TRANSCODER_DSI_A,
176         POWER_DOMAIN_TRANSCODER_DSI_C,
177         POWER_DOMAIN_PORT_DDI_A_LANES,
178         POWER_DOMAIN_PORT_DDI_B_LANES,
179         POWER_DOMAIN_PORT_DDI_C_LANES,
180         POWER_DOMAIN_PORT_DDI_D_LANES,
181         POWER_DOMAIN_PORT_DDI_E_LANES,
182         POWER_DOMAIN_PORT_DDI_F_LANES,
183         POWER_DOMAIN_PORT_DDI_A_IO,
184         POWER_DOMAIN_PORT_DDI_B_IO,
185         POWER_DOMAIN_PORT_DDI_C_IO,
186         POWER_DOMAIN_PORT_DDI_D_IO,
187         POWER_DOMAIN_PORT_DDI_E_IO,
188         POWER_DOMAIN_PORT_DDI_F_IO,
189         POWER_DOMAIN_PORT_DSI,
190         POWER_DOMAIN_PORT_CRT,
191         POWER_DOMAIN_PORT_OTHER,
192         POWER_DOMAIN_VGA,
193         POWER_DOMAIN_AUDIO,
194         POWER_DOMAIN_PLLS,
195         POWER_DOMAIN_AUX_A,
196         POWER_DOMAIN_AUX_B,
197         POWER_DOMAIN_AUX_C,
198         POWER_DOMAIN_AUX_D,
199         POWER_DOMAIN_AUX_E,
200         POWER_DOMAIN_AUX_F,
201         POWER_DOMAIN_AUX_IO_A,
202         POWER_DOMAIN_AUX_TBT1,
203         POWER_DOMAIN_AUX_TBT2,
204         POWER_DOMAIN_AUX_TBT3,
205         POWER_DOMAIN_AUX_TBT4,
206         POWER_DOMAIN_GMBUS,
207         POWER_DOMAIN_MODESET,
208         POWER_DOMAIN_GT_IRQ,
209         POWER_DOMAIN_INIT,
210
211         POWER_DOMAIN_NUM,
212 };
213
214 #define POWER_DOMAIN_PIPE(pipe) ((pipe) + POWER_DOMAIN_PIPE_A)
215 #define POWER_DOMAIN_PIPE_PANEL_FITTER(pipe) \
216                 ((pipe) + POWER_DOMAIN_PIPE_A_PANEL_FITTER)
217 #define POWER_DOMAIN_TRANSCODER(tran) \
218         ((tran) == TRANSCODER_EDP ? POWER_DOMAIN_TRANSCODER_EDP : \
219          (tran) + POWER_DOMAIN_TRANSCODER_A)
220
221 /* Used by dp and fdi links */
222 struct intel_link_m_n {
223         u32 tu;
224         u32 gmch_m;
225         u32 gmch_n;
226         u32 link_m;
227         u32 link_n;
228 };
229
230 #define for_each_pipe(__dev_priv, __p) \
231         for ((__p) = 0; (__p) < INTEL_INFO(__dev_priv)->num_pipes; (__p)++)
232
233 #define for_each_pipe_masked(__dev_priv, __p, __mask) \
234         for ((__p) = 0; (__p) < INTEL_INFO(__dev_priv)->num_pipes; (__p)++) \
235                 for_each_if((__mask) & BIT(__p))
236
237 #define for_each_cpu_transcoder_masked(__dev_priv, __t, __mask) \
238         for ((__t) = 0; (__t) < I915_MAX_TRANSCODERS; (__t)++)  \
239                 for_each_if ((__mask) & (1 << (__t)))
240
241 #define for_each_universal_plane(__dev_priv, __pipe, __p)               \
242         for ((__p) = 0;                                                 \
243              (__p) < INTEL_INFO(__dev_priv)->num_sprites[(__pipe)] + 1; \
244              (__p)++)
245
246 #define for_each_sprite(__dev_priv, __p, __s)                           \
247         for ((__s) = 0;                                                 \
248              (__s) < INTEL_INFO(__dev_priv)->num_sprites[(__p)];        \
249              (__s)++)
250
251 #define for_each_port_masked(__port, __ports_mask) \
252         for ((__port) = PORT_A; (__port) < I915_MAX_PORTS; (__port)++)  \
253                 for_each_if((__ports_mask) & BIT(__port))
254
255 #define for_each_crtc(dev, crtc) \
256         list_for_each_entry(crtc, &(dev)->mode_config.crtc_list, head)
257
258 #define for_each_intel_plane(dev, intel_plane) \
259         list_for_each_entry(intel_plane,                        \
260                             &(dev)->mode_config.plane_list,     \
261                             base.head)
262
263 #define for_each_intel_plane_mask(dev, intel_plane, plane_mask)         \
264         list_for_each_entry(intel_plane,                                \
265                             &(dev)->mode_config.plane_list,             \
266                             base.head)                                  \
267                 for_each_if((plane_mask) &                              \
268                             drm_plane_mask(&intel_plane->base)))
269
270 #define for_each_intel_plane_on_crtc(dev, intel_crtc, intel_plane)      \
271         list_for_each_entry(intel_plane,                                \
272                             &(dev)->mode_config.plane_list,             \
273                             base.head)                                  \
274                 for_each_if((intel_plane)->pipe == (intel_crtc)->pipe)
275
276 #define for_each_intel_crtc(dev, intel_crtc)                            \
277         list_for_each_entry(intel_crtc,                                 \
278                             &(dev)->mode_config.crtc_list,              \
279                             base.head)
280
281 #define for_each_intel_crtc_mask(dev, intel_crtc, crtc_mask)            \
282         list_for_each_entry(intel_crtc,                                 \
283                             &(dev)->mode_config.crtc_list,              \
284                             base.head)                                  \
285                 for_each_if((crtc_mask) & drm_crtc_mask(&intel_crtc->base))
286
287 #define for_each_intel_encoder(dev, intel_encoder)              \
288         list_for_each_entry(intel_encoder,                      \
289                             &(dev)->mode_config.encoder_list,   \
290                             base.head)
291
292 #define for_each_intel_dp(dev, intel_encoder)                   \
293         for_each_intel_encoder(dev, intel_encoder)              \
294                 for_each_if(intel_encoder_is_dp(intel_encoder))
295
296 #define for_each_intel_connector_iter(intel_connector, iter) \
297         while ((intel_connector = to_intel_connector(drm_connector_list_iter_next(iter))))
298
299 #define for_each_encoder_on_crtc(dev, __crtc, intel_encoder) \
300         list_for_each_entry((intel_encoder), &(dev)->mode_config.encoder_list, base.head) \
301                 for_each_if((intel_encoder)->base.crtc == (__crtc))
302
303 #define for_each_connector_on_encoder(dev, __encoder, intel_connector) \
304         list_for_each_entry((intel_connector), &(dev)->mode_config.connector_list, base.head) \
305                 for_each_if((intel_connector)->base.encoder == (__encoder))
306
307 #define for_each_power_domain(domain, mask)                             \
308         for ((domain) = 0; (domain) < POWER_DOMAIN_NUM; (domain)++)     \
309                 for_each_if(BIT_ULL(domain) & (mask))
310
311 #define for_each_power_well(__dev_priv, __power_well)                           \
312         for ((__power_well) = (__dev_priv)->power_domains.power_wells;  \
313              (__power_well) - (__dev_priv)->power_domains.power_wells < \
314                 (__dev_priv)->power_domains.power_well_count;           \
315              (__power_well)++)
316
317 #define for_each_power_well_rev(__dev_priv, __power_well)                       \
318         for ((__power_well) = (__dev_priv)->power_domains.power_wells +         \
319                               (__dev_priv)->power_domains.power_well_count - 1; \
320              (__power_well) - (__dev_priv)->power_domains.power_wells >= 0;     \
321              (__power_well)--)
322
323 #define for_each_power_domain_well(__dev_priv, __power_well, __domain_mask)     \
324         for_each_power_well(__dev_priv, __power_well)                           \
325                 for_each_if((__power_well)->domains & (__domain_mask))
326
327 #define for_each_power_domain_well_rev(__dev_priv, __power_well, __domain_mask) \
328         for_each_power_well_rev(__dev_priv, __power_well)                       \
329                 for_each_if((__power_well)->domains & (__domain_mask))
330
331 #define for_each_new_intel_plane_in_state(__state, plane, new_plane_state, __i) \
332         for ((__i) = 0; \
333              (__i) < (__state)->base.dev->mode_config.num_total_plane && \
334                      ((plane) = to_intel_plane((__state)->base.planes[__i].ptr), \
335                       (new_plane_state) = to_intel_plane_state((__state)->base.planes[__i].new_state), 1); \
336              (__i)++) \
337                 for_each_if(plane)
338
339 #define for_each_new_intel_crtc_in_state(__state, crtc, new_crtc_state, __i) \
340         for ((__i) = 0; \
341              (__i) < (__state)->base.dev->mode_config.num_crtc && \
342                      ((crtc) = to_intel_crtc((__state)->base.crtcs[__i].ptr), \
343                       (new_crtc_state) = to_intel_crtc_state((__state)->base.crtcs[__i].new_state), 1); \
344              (__i)++) \
345                 for_each_if(crtc)
346
347 #define for_each_oldnew_intel_plane_in_state(__state, plane, old_plane_state, new_plane_state, __i) \
348         for ((__i) = 0; \
349              (__i) < (__state)->base.dev->mode_config.num_total_plane && \
350                      ((plane) = to_intel_plane((__state)->base.planes[__i].ptr), \
351                       (old_plane_state) = to_intel_plane_state((__state)->base.planes[__i].old_state), \
352                       (new_plane_state) = to_intel_plane_state((__state)->base.planes[__i].new_state), 1); \
353              (__i)++) \
354                 for_each_if(plane)
355
356 void intel_link_compute_m_n(int bpp, int nlanes,
357                             int pixel_clock, int link_clock,
358                             struct intel_link_m_n *m_n,
359                             bool reduce_m_n);
360
361 #endif