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>
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:
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
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.
27 #ifndef __DRM_MODES_H__
28 #define __DRM_MODES_H__
30 #include <linux/hdmi.h>
32 #include <drm/drm_mode_object.h>
33 #include <drm/drm_connector.h>
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
46 * enum drm_mode_status - hardware support status of a mode
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_STALE: mode has become stale
84 * @MODE_BAD: unspecified reason
85 * @MODE_ERROR: error condition
87 * This enum is used to filter out modes not supported by the driver/hardware
90 enum drm_mode_status {
121 MODE_INTERLACE_WIDTH,
132 #define DRM_MODE_TYPE_CLOCK_CRTC_C (DRM_MODE_TYPE_CLOCK_C | \
133 DRM_MODE_TYPE_CRTC_C)
135 #define DRM_MODE(nm, t, c, hd, hss, hse, ht, hsk, vd, vss, vse, vt, vs, f) \
136 .name = nm, .status = 0, .type = (t), .clock = (c), \
137 .hdisplay = (hd), .hsync_start = (hss), .hsync_end = (hse), \
138 .htotal = (ht), .hskew = (hsk), .vdisplay = (vd), \
139 .vsync_start = (vss), .vsync_end = (vse), .vtotal = (vt), \
140 .vscan = (vs), .flags = (f), \
141 .base.type = DRM_MODE_OBJECT_MODE
143 #define CRTC_INTERLACE_HALVE_V (1 << 0) /* halve V values for interlacing */
144 #define CRTC_STEREO_DOUBLE (1 << 1) /* adjust timings for stereo modes */
145 #define CRTC_NO_DBLSCAN (1 << 2) /* don't adjust doublescan */
146 #define CRTC_NO_VSCAN (1 << 3) /* don't adjust doublescan */
147 #define CRTC_STEREO_DOUBLE_ONLY (CRTC_STEREO_DOUBLE | CRTC_NO_DBLSCAN | CRTC_NO_VSCAN)
149 #define DRM_MODE_FLAG_3D_MAX DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF
152 * struct drm_display_mode - DRM kernel-internal display mode structure
153 * @hdisplay: horizontal display size
154 * @hsync_start: horizontal sync start
155 * @hsync_end: horizontal sync end
156 * @htotal: horizontal total size
157 * @hskew: horizontal skew?!
158 * @vdisplay: vertical display size
159 * @vsync_start: vertical sync start
160 * @vsync_end: vertical sync end
161 * @vtotal: vertical total size
162 * @vscan: vertical scan?!
163 * @crtc_hdisplay: hardware mode horizontal display size
164 * @crtc_hblank_start: hardware mode horizontal blank start
165 * @crtc_hblank_end: hardware mode horizontal blank end
166 * @crtc_hsync_start: hardware mode horizontal sync start
167 * @crtc_hsync_end: hardware mode horizontal sync end
168 * @crtc_htotal: hardware mode horizontal total size
169 * @crtc_hskew: hardware mode horizontal skew?!
170 * @crtc_vdisplay: hardware mode vertical display size
171 * @crtc_vblank_start: hardware mode vertical blank start
172 * @crtc_vblank_end: hardware mode vertical blank end
173 * @crtc_vsync_start: hardware mode vertical sync start
174 * @crtc_vsync_end: hardware mode vertical sync end
175 * @crtc_vtotal: hardware mode vertical total size
177 * The horizontal and vertical timings are defined per the following diagram.
182 * Active Front Sync Back
184 * <-----------------------><----------------><-------------><-------------->
185 * //////////////////////|
186 * ////////////////////// |
187 * ////////////////////// |.................. ................
189 * <----- [hv]display ----->
190 * <------------- [hv]sync_start ------------>
191 * <--------------------- [hv]sync_end --------------------->
192 * <-------------------------------- [hv]total ----------------------------->*
194 * This structure contains two copies of timings. First are the plain timings,
195 * which specify the logical mode, as it would be for a progressive 1:1 scanout
196 * at the refresh rate userspace can observe through vblank timestamps. Then
197 * there's the hardware timings, which are corrected for interlacing,
198 * double-clocking and similar things. They are provided as a convenience, and
199 * can be appropriately computed using drm_mode_set_crtcinfo().
201 * For printing you can use %DRM_MODE_FMT and DRM_MODE_ARG().
203 struct drm_display_mode {
207 * struct list_head for mode lists.
209 struct list_head head;
214 * A display mode is a normal modeset object, possibly including public
219 * This can probably be removed since the entire concept of userspace
220 * managing modes explicitly has never landed in upstream kernel mode
223 struct drm_mode_object base;
228 * Human-readable name of the mode, filled out with drm_mode_set_name().
230 char name[DRM_DISPLAY_MODE_LEN];
235 * Status of the mode, used to filter out modes not supported by the
236 * hardware. See enum &drm_mode_status.
238 enum drm_mode_status status;
243 * A bitmask of flags, mostly about the source of a mode. Possible flags
246 * - DRM_MODE_TYPE_BUILTIN: Meant for hard-coded modes, effectively
248 * - DRM_MODE_TYPE_PREFERRED: Preferred mode, usually the native
249 * resolution of an LCD panel. There should only be one preferred
250 * mode per connector at any given time.
251 * - DRM_MODE_TYPE_DRIVER: Mode created by the driver, which is all of
252 * them really. Drivers must set this bit for all modes they create
253 * and expose to userspace.
255 * Plus a big list of flags which shouldn't be used at all, but are
256 * still around since these flags are also used in the userspace ABI:
258 * - DRM_MODE_TYPE_DEFAULT: Again a leftover, use
259 * DRM_MODE_TYPE_PREFERRED instead.
260 * - DRM_MODE_TYPE_CLOCK_C and DRM_MODE_TYPE_CRTC_C: Define leftovers
261 * which are stuck around for hysterical raisins only. No one has an
262 * idea what they were meant for. Don't use.
263 * - DRM_MODE_TYPE_USERDEF: Mode defined by userspace, again a vestige
264 * from older kms designs where userspace had to first add a custom
265 * mode to the kernel's mode list before it could use it. Don't use.
272 * Pixel clock in kHz.
274 int clock; /* in kHz */
288 * Sync and timing flags:
290 * - DRM_MODE_FLAG_PHSYNC: horizontal sync is active high.
291 * - DRM_MODE_FLAG_NHSYNC: horizontal sync is active low.
292 * - DRM_MODE_FLAG_PVSYNC: vertical sync is active high.
293 * - DRM_MODE_FLAG_NVSYNC: vertical sync is active low.
294 * - DRM_MODE_FLAG_INTERLACE: mode is interlaced.
295 * - DRM_MODE_FLAG_DBLSCAN: mode uses doublescan.
296 * - DRM_MODE_FLAG_CSYNC: mode uses composite sync.
297 * - DRM_MODE_FLAG_PCSYNC: composite sync is active high.
298 * - DRM_MODE_FLAG_NCSYNC: composite sync is active low.
299 * - DRM_MODE_FLAG_HSKEW: hskew provided (not used?).
300 * - DRM_MODE_FLAG_BCAST: not used?
301 * - DRM_MODE_FLAG_PIXMUX: not used?
302 * - DRM_MODE_FLAG_DBLCLK: double-clocked mode.
303 * - DRM_MODE_FLAG_CLKDIV2: half-clocked mode.
305 * Additionally there's flags to specify how 3D modes are packed:
307 * - DRM_MODE_FLAG_3D_NONE: normal, non-3D mode.
308 * - DRM_MODE_FLAG_3D_FRAME_PACKING: 2 full frames for left and right.
309 * - DRM_MODE_FLAG_3D_FIELD_ALTERNATIVE: interleaved like fields.
310 * - DRM_MODE_FLAG_3D_LINE_ALTERNATIVE: interleaved lines.
311 * - DRM_MODE_FLAG_3D_SIDE_BY_SIDE_FULL: side-by-side full frames.
312 * - DRM_MODE_FLAG_3D_L_DEPTH: ?
313 * - DRM_MODE_FLAG_3D_L_DEPTH_GFX_GFX_DEPTH: ?
314 * - DRM_MODE_FLAG_3D_TOP_AND_BOTTOM: frame split into top and bottom
316 * - DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF: frame split into left and
324 * Addressable size of the output in mm, projectors should set this to
332 * Addressable size of the output in mm, projectors should set this to
340 * Actual pixel or dot clock in the hardware. This differs from the
341 * logical @clock when e.g. using interlacing, double-clocking, stereo
342 * modes or other fancy stuff that changes the timings and signals
343 * actually sent over the wire.
345 * This is again in kHz.
347 * Note that with digital outputs like HDMI or DP there's usually a
348 * massive confusion between the dot clock and the signal clock at the
349 * bit encoding level. Especially when a 8b/10b encoding is used and the
350 * difference is exactly a factor of 10.
354 int crtc_hblank_start;
356 int crtc_hsync_start;
361 int crtc_vblank_start;
363 int crtc_vsync_start;
370 * Pointer for driver private data. This can only be used for mode
371 * objects passed to drivers in modeset operations. It shouldn't be used
372 * by atomic drivers since they can store any additional data by
373 * subclassing state structures.
380 * Similar to @private, but just an integer.
387 * Vertical refresh rate, for debug output in human readable form. Not
388 * used in a functional way.
390 * This value is in Hz.
397 * Horizontal refresh rate, for debug output in human readable form. Not
398 * used in a functional way.
400 * This value is in kHz.
405 * @picture_aspect_ratio:
407 * Field for setting the HDMI picture aspect ratio of a mode.
409 enum hdmi_picture_aspect picture_aspect_ratio;
413 * DRM_MODE_FMT - printf string for &struct drm_display_mode
415 #define DRM_MODE_FMT "%d:\"%s\" %d %d %d %d %d %d %d %d %d %d 0x%x 0x%x"
418 * DRM_MODE_ARG - printf arguments for &struct drm_display_mode
421 #define DRM_MODE_ARG(m) \
422 (m)->base.id, (m)->name, (m)->vrefresh, (m)->clock, \
423 (m)->hdisplay, (m)->hsync_start, (m)->hsync_end, (m)->htotal, \
424 (m)->vdisplay, (m)->vsync_start, (m)->vsync_end, (m)->vtotal, \
425 (m)->type, (m)->flags
427 #define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
430 * drm_mode_is_stereo - check for stereo mode flags
431 * @mode: drm_display_mode to check
434 * True if the mode is one of the stereo modes (like side-by-side), false if
437 static inline bool drm_mode_is_stereo(const struct drm_display_mode *mode)
439 return mode->flags & DRM_MODE_FLAG_3D_MASK;
442 struct drm_connector;
443 struct drm_cmdline_mode;
445 struct drm_display_mode *drm_mode_create(struct drm_device *dev);
446 void drm_mode_destroy(struct drm_device *dev, struct drm_display_mode *mode);
447 void drm_mode_convert_to_umode(struct drm_mode_modeinfo *out,
448 const struct drm_display_mode *in);
449 int drm_mode_convert_umode(struct drm_display_mode *out,
450 const struct drm_mode_modeinfo *in);
451 void drm_mode_probed_add(struct drm_connector *connector, struct drm_display_mode *mode);
452 void drm_mode_debug_printmodeline(const struct drm_display_mode *mode);
454 struct drm_display_mode *drm_cvt_mode(struct drm_device *dev,
455 int hdisplay, int vdisplay, int vrefresh,
456 bool reduced, bool interlaced,
458 struct drm_display_mode *drm_gtf_mode(struct drm_device *dev,
459 int hdisplay, int vdisplay, int vrefresh,
460 bool interlaced, int margins);
461 struct drm_display_mode *drm_gtf_mode_complex(struct drm_device *dev,
462 int hdisplay, int vdisplay,
463 int vrefresh, bool interlaced,
465 int GTF_M, int GTF_2C,
466 int GTF_K, int GTF_2J);
467 void drm_display_mode_from_videomode(const struct videomode *vm,
468 struct drm_display_mode *dmode);
469 void drm_display_mode_to_videomode(const struct drm_display_mode *dmode,
470 struct videomode *vm);
471 void drm_bus_flags_from_videomode(const struct videomode *vm, u32 *bus_flags);
472 int of_get_drm_display_mode(struct device_node *np,
473 struct drm_display_mode *dmode, u32 *bus_flags,
476 void drm_mode_set_name(struct drm_display_mode *mode);
477 int drm_mode_hsync(const struct drm_display_mode *mode);
478 int drm_mode_vrefresh(const struct drm_display_mode *mode);
479 void drm_mode_get_hv_timing(const struct drm_display_mode *mode,
480 int *hdisplay, int *vdisplay);
482 void drm_mode_set_crtcinfo(struct drm_display_mode *p,
484 void drm_mode_copy(struct drm_display_mode *dst,
485 const struct drm_display_mode *src);
486 struct drm_display_mode *drm_mode_duplicate(struct drm_device *dev,
487 const struct drm_display_mode *mode);
488 bool drm_mode_equal(const struct drm_display_mode *mode1,
489 const struct drm_display_mode *mode2);
490 bool drm_mode_equal_no_clocks(const struct drm_display_mode *mode1,
491 const struct drm_display_mode *mode2);
492 bool drm_mode_equal_no_clocks_no_stereo(const struct drm_display_mode *mode1,
493 const struct drm_display_mode *mode2);
495 /* for use by the crtc helper probe functions */
496 enum drm_mode_status drm_mode_validate_basic(const struct drm_display_mode *mode);
497 enum drm_mode_status drm_mode_validate_size(const struct drm_display_mode *mode,
499 void drm_mode_prune_invalid(struct drm_device *dev,
500 struct list_head *mode_list, bool verbose);
501 void drm_mode_sort(struct list_head *mode_list);
502 void drm_mode_connector_list_update(struct drm_connector *connector);
504 /* parsing cmdline modes */
506 drm_mode_parse_command_line_for_connector(const char *mode_option,
507 struct drm_connector *connector,
508 struct drm_cmdline_mode *mode);
509 struct drm_display_mode *
510 drm_mode_create_from_cmdline_mode(struct drm_device *dev,
511 struct drm_cmdline_mode *cmd);
513 #endif /* __DRM_MODES_H__ */