GNU Linux-libre 4.19.211-gnu1
[releases.git] / include / drm / drm_modes.h
1 /*
2  * Copyright © 2006 Keith Packard
3  * Copyright © 2007-2008 Dave Airlie
4  * Copyright © 2007-2008 Intel Corporation
5  *   Jesse Barnes <jesse.barnes@intel.com>
6  * Copyright © 2014 Intel Corporation
7  *   Daniel Vetter <daniel.vetter@ffwll.ch>
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining a
10  * copy of this software and associated documentation files (the "Software"),
11  * to deal in the Software without restriction, including without limitation
12  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
13  * and/or sell copies of the Software, and to permit persons to whom the
14  * Software is furnished to do so, subject to the following conditions:
15  *
16  * The above copyright notice and this permission notice shall be included in
17  * all copies or substantial portions of the Software.
18  *
19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
22  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
23  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25  * OTHER DEALINGS IN THE SOFTWARE.
26  */
27 #ifndef __DRM_MODES_H__
28 #define __DRM_MODES_H__
29
30 #include <linux/hdmi.h>
31
32 #include <drm/drm_mode_object.h>
33 #include <drm/drm_connector.h>
34
35 struct videomode;
36
37 /*
38  * Note on terminology:  here, for brevity and convenience, we refer to connector
39  * control chips as 'CRTCs'.  They can control any type of connector, VGA, LVDS,
40  * DVI, etc.  And 'screen' refers to the whole of the visible display, which
41  * may span multiple monitors (and therefore multiple CRTC and connector
42  * structures).
43  */
44
45 /**
46  * enum drm_mode_status - hardware support status of a mode
47  * @MODE_OK: Mode OK
48  * @MODE_HSYNC: hsync out of range
49  * @MODE_VSYNC: vsync out of range
50  * @MODE_H_ILLEGAL: mode has illegal horizontal timings
51  * @MODE_V_ILLEGAL: mode has illegal horizontal timings
52  * @MODE_BAD_WIDTH: requires an unsupported linepitch
53  * @MODE_NOMODE: no mode with a matching name
54  * @MODE_NO_INTERLACE: interlaced mode not supported
55  * @MODE_NO_DBLESCAN: doublescan mode not supported
56  * @MODE_NO_VSCAN: multiscan mode not supported
57  * @MODE_MEM: insufficient video memory
58  * @MODE_VIRTUAL_X: mode width too large for specified virtual size
59  * @MODE_VIRTUAL_Y: mode height too large for specified virtual size
60  * @MODE_MEM_VIRT: insufficient video memory given virtual size
61  * @MODE_NOCLOCK: no fixed clock available
62  * @MODE_CLOCK_HIGH: clock required is too high
63  * @MODE_CLOCK_LOW: clock required is too low
64  * @MODE_CLOCK_RANGE: clock/mode isn't in a ClockRange
65  * @MODE_BAD_HVALUE: horizontal timing was out of range
66  * @MODE_BAD_VVALUE: vertical timing was out of range
67  * @MODE_BAD_VSCAN: VScan value out of range
68  * @MODE_HSYNC_NARROW: horizontal sync too narrow
69  * @MODE_HSYNC_WIDE: horizontal sync too wide
70  * @MODE_HBLANK_NARROW: horizontal blanking too narrow
71  * @MODE_HBLANK_WIDE: horizontal blanking too wide
72  * @MODE_VSYNC_NARROW: vertical sync too narrow
73  * @MODE_VSYNC_WIDE: vertical sync too wide
74  * @MODE_VBLANK_NARROW: vertical blanking too narrow
75  * @MODE_VBLANK_WIDE: vertical blanking too wide
76  * @MODE_PANEL: exceeds panel dimensions
77  * @MODE_INTERLACE_WIDTH: width too large for interlaced mode
78  * @MODE_ONE_WIDTH: only one width is supported
79  * @MODE_ONE_HEIGHT: only one height is supported
80  * @MODE_ONE_SIZE: only one resolution is supported
81  * @MODE_NO_REDUCED: monitor doesn't accept reduced blanking
82  * @MODE_NO_STEREO: stereo modes not supported
83  * @MODE_NO_420: ycbcr 420 modes not supported
84  * @MODE_STALE: mode has become stale
85  * @MODE_BAD: unspecified reason
86  * @MODE_ERROR: error condition
87  *
88  * This enum is used to filter out modes not supported by the driver/hardware
89  * combination.
90  */
91 enum drm_mode_status {
92         MODE_OK = 0,
93         MODE_HSYNC,
94         MODE_VSYNC,
95         MODE_H_ILLEGAL,
96         MODE_V_ILLEGAL,
97         MODE_BAD_WIDTH,
98         MODE_NOMODE,
99         MODE_NO_INTERLACE,
100         MODE_NO_DBLESCAN,
101         MODE_NO_VSCAN,
102         MODE_MEM,
103         MODE_VIRTUAL_X,
104         MODE_VIRTUAL_Y,
105         MODE_MEM_VIRT,
106         MODE_NOCLOCK,
107         MODE_CLOCK_HIGH,
108         MODE_CLOCK_LOW,
109         MODE_CLOCK_RANGE,
110         MODE_BAD_HVALUE,
111         MODE_BAD_VVALUE,
112         MODE_BAD_VSCAN,
113         MODE_HSYNC_NARROW,
114         MODE_HSYNC_WIDE,
115         MODE_HBLANK_NARROW,
116         MODE_HBLANK_WIDE,
117         MODE_VSYNC_NARROW,
118         MODE_VSYNC_WIDE,
119         MODE_VBLANK_NARROW,
120         MODE_VBLANK_WIDE,
121         MODE_PANEL,
122         MODE_INTERLACE_WIDTH,
123         MODE_ONE_WIDTH,
124         MODE_ONE_HEIGHT,
125         MODE_ONE_SIZE,
126         MODE_NO_REDUCED,
127         MODE_NO_STEREO,
128         MODE_NO_420,
129         MODE_STALE = -3,
130         MODE_BAD = -2,
131         MODE_ERROR = -1
132 };
133
134 #define DRM_MODE(nm, t, c, hd, hss, hse, ht, hsk, vd, vss, vse, vt, vs, f) \
135         .name = nm, .status = 0, .type = (t), .clock = (c), \
136         .hdisplay = (hd), .hsync_start = (hss), .hsync_end = (hse), \
137         .htotal = (ht), .hskew = (hsk), .vdisplay = (vd), \
138         .vsync_start = (vss), .vsync_end = (vse), .vtotal = (vt), \
139         .vscan = (vs), .flags = (f), \
140         .base.type = DRM_MODE_OBJECT_MODE
141
142 #define CRTC_INTERLACE_HALVE_V  (1 << 0) /* halve V values for interlacing */
143 #define CRTC_STEREO_DOUBLE      (1 << 1) /* adjust timings for stereo modes */
144 #define CRTC_NO_DBLSCAN         (1 << 2) /* don't adjust doublescan */
145 #define CRTC_NO_VSCAN           (1 << 3) /* don't adjust doublescan */
146 #define CRTC_STEREO_DOUBLE_ONLY (CRTC_STEREO_DOUBLE | CRTC_NO_DBLSCAN | CRTC_NO_VSCAN)
147
148 #define DRM_MODE_FLAG_3D_MAX    DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF
149
150 #define DRM_MODE_MATCH_TIMINGS (1 << 0)
151 #define DRM_MODE_MATCH_CLOCK (1 << 1)
152 #define DRM_MODE_MATCH_FLAGS (1 << 2)
153 #define DRM_MODE_MATCH_3D_FLAGS (1 << 3)
154 #define DRM_MODE_MATCH_ASPECT_RATIO (1 << 4)
155
156 /**
157  * struct drm_display_mode - DRM kernel-internal display mode structure
158  * @hdisplay: horizontal display size
159  * @hsync_start: horizontal sync start
160  * @hsync_end: horizontal sync end
161  * @htotal: horizontal total size
162  * @hskew: horizontal skew?!
163  * @vdisplay: vertical display size
164  * @vsync_start: vertical sync start
165  * @vsync_end: vertical sync end
166  * @vtotal: vertical total size
167  * @vscan: vertical scan?!
168  * @crtc_hdisplay: hardware mode horizontal display size
169  * @crtc_hblank_start: hardware mode horizontal blank start
170  * @crtc_hblank_end: hardware mode horizontal blank end
171  * @crtc_hsync_start: hardware mode horizontal sync start
172  * @crtc_hsync_end: hardware mode horizontal sync end
173  * @crtc_htotal: hardware mode horizontal total size
174  * @crtc_hskew: hardware mode horizontal skew?!
175  * @crtc_vdisplay: hardware mode vertical display size
176  * @crtc_vblank_start: hardware mode vertical blank start
177  * @crtc_vblank_end: hardware mode vertical blank end
178  * @crtc_vsync_start: hardware mode vertical sync start
179  * @crtc_vsync_end: hardware mode vertical sync end
180  * @crtc_vtotal: hardware mode vertical total size
181  *
182  * The horizontal and vertical timings are defined per the following diagram.
183  *
184  * ::
185  *
186  *
187  *               Active                 Front           Sync           Back
188  *              Region                 Porch                          Porch
189  *     <-----------------------><----------------><-------------><-------------->
190  *       //////////////////////|
191  *      ////////////////////// |
192  *     //////////////////////  |..................               ................
193  *                                                _______________
194  *     <----- [hv]display ----->
195  *     <------------- [hv]sync_start ------------>
196  *     <--------------------- [hv]sync_end --------------------->
197  *     <-------------------------------- [hv]total ----------------------------->*
198  *
199  * This structure contains two copies of timings. First are the plain timings,
200  * which specify the logical mode, as it would be for a progressive 1:1 scanout
201  * at the refresh rate userspace can observe through vblank timestamps. Then
202  * there's the hardware timings, which are corrected for interlacing,
203  * double-clocking and similar things. They are provided as a convenience, and
204  * can be appropriately computed using drm_mode_set_crtcinfo().
205  *
206  * For printing you can use %DRM_MODE_FMT and DRM_MODE_ARG().
207  */
208 struct drm_display_mode {
209         /**
210          * @head:
211          *
212          * struct list_head for mode lists.
213          */
214         struct list_head head;
215
216         /**
217          * @base:
218          *
219          * A display mode is a normal modeset object, possibly including public
220          * userspace id.
221          *
222          * FIXME:
223          *
224          * This can probably be removed since the entire concept of userspace
225          * managing modes explicitly has never landed in upstream kernel mode
226          * setting support.
227          */
228         struct drm_mode_object base;
229
230         /**
231          * @name:
232          *
233          * Human-readable name of the mode, filled out with drm_mode_set_name().
234          */
235         char name[DRM_DISPLAY_MODE_LEN];
236
237         /**
238          * @status:
239          *
240          * Status of the mode, used to filter out modes not supported by the
241          * hardware. See enum &drm_mode_status.
242          */
243         enum drm_mode_status status;
244
245         /**
246          * @type:
247          *
248          * A bitmask of flags, mostly about the source of a mode. Possible flags
249          * are:
250          *
251          *  - DRM_MODE_TYPE_PREFERRED: Preferred mode, usually the native
252          *    resolution of an LCD panel. There should only be one preferred
253          *    mode per connector at any given time.
254          *  - DRM_MODE_TYPE_DRIVER: Mode created by the driver, which is all of
255          *    them really. Drivers must set this bit for all modes they create
256          *    and expose to userspace.
257          *  - DRM_MODE_TYPE_USERDEF: Mode defined via kernel command line
258          *
259          * Plus a big list of flags which shouldn't be used at all, but are
260          * still around since these flags are also used in the userspace ABI.
261          * We no longer accept modes with these types though:
262          *
263          *  - DRM_MODE_TYPE_BUILTIN: Meant for hard-coded modes, unused.
264          *    Use DRM_MODE_TYPE_DRIVER instead.
265          *  - DRM_MODE_TYPE_DEFAULT: Again a leftover, use
266          *    DRM_MODE_TYPE_PREFERRED instead.
267          *  - DRM_MODE_TYPE_CLOCK_C and DRM_MODE_TYPE_CRTC_C: Define leftovers
268          *    which are stuck around for hysterical raisins only. No one has an
269          *    idea what they were meant for. Don't use.
270          */
271         unsigned int type;
272
273         /**
274          * @clock:
275          *
276          * Pixel clock in kHz.
277          */
278         int clock;              /* in kHz */
279         int hdisplay;
280         int hsync_start;
281         int hsync_end;
282         int htotal;
283         int hskew;
284         int vdisplay;
285         int vsync_start;
286         int vsync_end;
287         int vtotal;
288         int vscan;
289         /**
290          * @flags:
291          *
292          * Sync and timing flags:
293          *
294          *  - DRM_MODE_FLAG_PHSYNC: horizontal sync is active high.
295          *  - DRM_MODE_FLAG_NHSYNC: horizontal sync is active low.
296          *  - DRM_MODE_FLAG_PVSYNC: vertical sync is active high.
297          *  - DRM_MODE_FLAG_NVSYNC: vertical sync is active low.
298          *  - DRM_MODE_FLAG_INTERLACE: mode is interlaced.
299          *  - DRM_MODE_FLAG_DBLSCAN: mode uses doublescan.
300          *  - DRM_MODE_FLAG_CSYNC: mode uses composite sync.
301          *  - DRM_MODE_FLAG_PCSYNC: composite sync is active high.
302          *  - DRM_MODE_FLAG_NCSYNC: composite sync is active low.
303          *  - DRM_MODE_FLAG_HSKEW: hskew provided (not used?).
304          *  - DRM_MODE_FLAG_BCAST: <deprecated>
305          *  - DRM_MODE_FLAG_PIXMUX: <deprecated>
306          *  - DRM_MODE_FLAG_DBLCLK: double-clocked mode.
307          *  - DRM_MODE_FLAG_CLKDIV2: half-clocked mode.
308          *
309          * Additionally there's flags to specify how 3D modes are packed:
310          *
311          *  - DRM_MODE_FLAG_3D_NONE: normal, non-3D mode.
312          *  - DRM_MODE_FLAG_3D_FRAME_PACKING: 2 full frames for left and right.
313          *  - DRM_MODE_FLAG_3D_FIELD_ALTERNATIVE: interleaved like fields.
314          *  - DRM_MODE_FLAG_3D_LINE_ALTERNATIVE: interleaved lines.
315          *  - DRM_MODE_FLAG_3D_SIDE_BY_SIDE_FULL: side-by-side full frames.
316          *  - DRM_MODE_FLAG_3D_L_DEPTH: ?
317          *  - DRM_MODE_FLAG_3D_L_DEPTH_GFX_GFX_DEPTH: ?
318          *  - DRM_MODE_FLAG_3D_TOP_AND_BOTTOM: frame split into top and bottom
319          *    parts.
320          *  - DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF: frame split into left and
321          *    right parts.
322          */
323         unsigned int flags;
324
325         /**
326          * @width_mm:
327          *
328          * Addressable size of the output in mm, projectors should set this to
329          * 0.
330          */
331         int width_mm;
332
333         /**
334          * @height_mm:
335          *
336          * Addressable size of the output in mm, projectors should set this to
337          * 0.
338          */
339         int height_mm;
340
341         /**
342          * @crtc_clock:
343          *
344          * Actual pixel or dot clock in the hardware. This differs from the
345          * logical @clock when e.g. using interlacing, double-clocking, stereo
346          * modes or other fancy stuff that changes the timings and signals
347          * actually sent over the wire.
348          *
349          * This is again in kHz.
350          *
351          * Note that with digital outputs like HDMI or DP there's usually a
352          * massive confusion between the dot clock and the signal clock at the
353          * bit encoding level. Especially when a 8b/10b encoding is used and the
354          * difference is exactly a factor of 10.
355          */
356         int crtc_clock;
357         int crtc_hdisplay;
358         int crtc_hblank_start;
359         int crtc_hblank_end;
360         int crtc_hsync_start;
361         int crtc_hsync_end;
362         int crtc_htotal;
363         int crtc_hskew;
364         int crtc_vdisplay;
365         int crtc_vblank_start;
366         int crtc_vblank_end;
367         int crtc_vsync_start;
368         int crtc_vsync_end;
369         int crtc_vtotal;
370
371         /**
372          * @private:
373          *
374          * Pointer for driver private data. This can only be used for mode
375          * objects passed to drivers in modeset operations. It shouldn't be used
376          * by atomic drivers since they can store any additional data by
377          * subclassing state structures.
378          */
379         int *private;
380
381         /**
382          * @private_flags:
383          *
384          * Similar to @private, but just an integer.
385          */
386         int private_flags;
387
388         /**
389          * @vrefresh:
390          *
391          * Vertical refresh rate, for debug output in human readable form. Not
392          * used in a functional way.
393          *
394          * This value is in Hz.
395          */
396         int vrefresh;
397
398         /**
399          * @hsync:
400          *
401          * Horizontal refresh rate, for debug output in human readable form. Not
402          * used in a functional way.
403          *
404          * This value is in kHz.
405          */
406         int hsync;
407
408         /**
409          * @picture_aspect_ratio:
410          *
411          * Field for setting the HDMI picture aspect ratio of a mode.
412          */
413         enum hdmi_picture_aspect picture_aspect_ratio;
414
415         /**
416          * @export_head:
417          *
418          * struct list_head for modes to be exposed to the userspace.
419          * This is to maintain a list of exposed modes while preparing
420          * user-mode's list in drm_mode_getconnector ioctl. The purpose of this
421          * list_head only lies in the ioctl function, and is not expected to be
422          * used outside the function.
423          * Once used, the stale pointers are not reset, but left as it is, to
424          * avoid overhead of protecting it by mode_config.mutex.
425          */
426         struct list_head export_head;
427 };
428
429 /**
430  * DRM_MODE_FMT - printf string for &struct drm_display_mode
431  */
432 #define DRM_MODE_FMT    "%d:\"%s\" %d %d %d %d %d %d %d %d %d %d 0x%x 0x%x"
433
434 /**
435  * DRM_MODE_ARG - printf arguments for &struct drm_display_mode
436  * @m: display mode
437  */
438 #define DRM_MODE_ARG(m) \
439         (m)->base.id, (m)->name, (m)->vrefresh, (m)->clock, \
440         (m)->hdisplay, (m)->hsync_start, (m)->hsync_end, (m)->htotal, \
441         (m)->vdisplay, (m)->vsync_start, (m)->vsync_end, (m)->vtotal, \
442         (m)->type, (m)->flags
443
444 #define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
445
446 /**
447  * drm_mode_is_stereo - check for stereo mode flags
448  * @mode: drm_display_mode to check
449  *
450  * Returns:
451  * True if the mode is one of the stereo modes (like side-by-side), false if
452  * not.
453  */
454 static inline bool drm_mode_is_stereo(const struct drm_display_mode *mode)
455 {
456         return mode->flags & DRM_MODE_FLAG_3D_MASK;
457 }
458
459 struct drm_connector;
460 struct drm_cmdline_mode;
461
462 struct drm_display_mode *drm_mode_create(struct drm_device *dev);
463 void drm_mode_destroy(struct drm_device *dev, struct drm_display_mode *mode);
464 void drm_mode_convert_to_umode(struct drm_mode_modeinfo *out,
465                                const struct drm_display_mode *in);
466 int drm_mode_convert_umode(struct drm_device *dev,
467                            struct drm_display_mode *out,
468                            const struct drm_mode_modeinfo *in);
469 void drm_mode_probed_add(struct drm_connector *connector, struct drm_display_mode *mode);
470 void drm_mode_debug_printmodeline(const struct drm_display_mode *mode);
471 bool drm_mode_is_420_only(const struct drm_display_info *display,
472                           const struct drm_display_mode *mode);
473 bool drm_mode_is_420_also(const struct drm_display_info *display,
474                           const struct drm_display_mode *mode);
475 bool drm_mode_is_420(const struct drm_display_info *display,
476                      const struct drm_display_mode *mode);
477
478 struct drm_display_mode *drm_cvt_mode(struct drm_device *dev,
479                                       int hdisplay, int vdisplay, int vrefresh,
480                                       bool reduced, bool interlaced,
481                                       bool margins);
482 struct drm_display_mode *drm_gtf_mode(struct drm_device *dev,
483                                       int hdisplay, int vdisplay, int vrefresh,
484                                       bool interlaced, int margins);
485 struct drm_display_mode *drm_gtf_mode_complex(struct drm_device *dev,
486                                               int hdisplay, int vdisplay,
487                                               int vrefresh, bool interlaced,
488                                               int margins,
489                                               int GTF_M, int GTF_2C,
490                                               int GTF_K, int GTF_2J);
491 void drm_display_mode_from_videomode(const struct videomode *vm,
492                                      struct drm_display_mode *dmode);
493 void drm_display_mode_to_videomode(const struct drm_display_mode *dmode,
494                                    struct videomode *vm);
495 void drm_bus_flags_from_videomode(const struct videomode *vm, u32 *bus_flags);
496 int of_get_drm_display_mode(struct device_node *np,
497                             struct drm_display_mode *dmode, u32 *bus_flags,
498                             int index);
499
500 void drm_mode_set_name(struct drm_display_mode *mode);
501 int drm_mode_hsync(const struct drm_display_mode *mode);
502 int drm_mode_vrefresh(const struct drm_display_mode *mode);
503 void drm_mode_get_hv_timing(const struct drm_display_mode *mode,
504                             int *hdisplay, int *vdisplay);
505
506 void drm_mode_set_crtcinfo(struct drm_display_mode *p,
507                            int adjust_flags);
508 void drm_mode_copy(struct drm_display_mode *dst,
509                    const struct drm_display_mode *src);
510 struct drm_display_mode *drm_mode_duplicate(struct drm_device *dev,
511                                             const struct drm_display_mode *mode);
512 bool drm_mode_match(const struct drm_display_mode *mode1,
513                     const struct drm_display_mode *mode2,
514                     unsigned int match_flags);
515 bool drm_mode_equal(const struct drm_display_mode *mode1,
516                     const struct drm_display_mode *mode2);
517 bool drm_mode_equal_no_clocks(const struct drm_display_mode *mode1,
518                               const struct drm_display_mode *mode2);
519 bool drm_mode_equal_no_clocks_no_stereo(const struct drm_display_mode *mode1,
520                                         const struct drm_display_mode *mode2);
521
522 /* for use by the crtc helper probe functions */
523 enum drm_mode_status drm_mode_validate_driver(struct drm_device *dev,
524                                               const struct drm_display_mode *mode);
525 enum drm_mode_status drm_mode_validate_size(const struct drm_display_mode *mode,
526                                             int maxX, int maxY);
527 enum drm_mode_status
528 drm_mode_validate_ycbcr420(const struct drm_display_mode *mode,
529                            struct drm_connector *connector);
530 void drm_mode_prune_invalid(struct drm_device *dev,
531                             struct list_head *mode_list, bool verbose);
532 void drm_mode_sort(struct list_head *mode_list);
533 void drm_connector_list_update(struct drm_connector *connector);
534
535 /* parsing cmdline modes */
536 bool
537 drm_mode_parse_command_line_for_connector(const char *mode_option,
538                                           struct drm_connector *connector,
539                                           struct drm_cmdline_mode *mode);
540 struct drm_display_mode *
541 drm_mode_create_from_cmdline_mode(struct drm_device *dev,
542                                   struct drm_cmdline_mode *cmd);
543
544 #endif /* __DRM_MODES_H__ */