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