2 * Copyright © 2006 Keith Packard
3 * Copyright © 2007-2008 Dave Airlie
4 * Copyright © 2007-2008 Intel Corporation
6 * Copyright © 2014 Intel Corporation
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_NO_420: ycbcr 420 modes not supported
84 * @MODE_STALE: mode has become stale
85 * @MODE_BAD: unspecified reason
86 * @MODE_ERROR: error condition
88 * This enum is used to filter out modes not supported by the driver/hardware
91 enum drm_mode_status {
122 MODE_INTERLACE_WIDTH,
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)
141 #define CRTC_INTERLACE_HALVE_V (1 << 0) /* halve V values for interlacing */
142 #define CRTC_STEREO_DOUBLE (1 << 1) /* adjust timings for stereo modes */
143 #define CRTC_NO_DBLSCAN (1 << 2) /* don't adjust doublescan */
144 #define CRTC_NO_VSCAN (1 << 3) /* don't adjust doublescan */
145 #define CRTC_STEREO_DOUBLE_ONLY (CRTC_STEREO_DOUBLE | CRTC_NO_DBLSCAN | CRTC_NO_VSCAN)
147 #define DRM_MODE_FLAG_3D_MAX DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF
149 #define DRM_MODE_MATCH_TIMINGS (1 << 0)
150 #define DRM_MODE_MATCH_CLOCK (1 << 1)
151 #define DRM_MODE_MATCH_FLAGS (1 << 2)
152 #define DRM_MODE_MATCH_3D_FLAGS (1 << 3)
153 #define DRM_MODE_MATCH_ASPECT_RATIO (1 << 4)
156 * struct drm_display_mode - DRM kernel-internal display mode structure
157 * @hdisplay: horizontal display size
158 * @hsync_start: horizontal sync start
159 * @hsync_end: horizontal sync end
160 * @htotal: horizontal total size
161 * @hskew: horizontal skew?!
162 * @vdisplay: vertical display size
163 * @vsync_start: vertical sync start
164 * @vsync_end: vertical sync end
165 * @vtotal: vertical total size
166 * @vscan: vertical scan?!
167 * @crtc_hdisplay: hardware mode horizontal display size
168 * @crtc_hblank_start: hardware mode horizontal blank start
169 * @crtc_hblank_end: hardware mode horizontal blank end
170 * @crtc_hsync_start: hardware mode horizontal sync start
171 * @crtc_hsync_end: hardware mode horizontal sync end
172 * @crtc_htotal: hardware mode horizontal total size
173 * @crtc_hskew: hardware mode horizontal skew?!
174 * @crtc_vdisplay: hardware mode vertical display size
175 * @crtc_vblank_start: hardware mode vertical blank start
176 * @crtc_vblank_end: hardware mode vertical blank end
177 * @crtc_vsync_start: hardware mode vertical sync start
178 * @crtc_vsync_end: hardware mode vertical sync end
179 * @crtc_vtotal: hardware mode vertical total size
181 * The horizontal and vertical timings are defined per the following diagram.
186 * Active Front Sync Back
188 * <-----------------------><----------------><-------------><-------------->
189 * //////////////////////|
190 * ////////////////////// |
191 * ////////////////////// |.................. ................
193 * <----- [hv]display ----->
194 * <------------- [hv]sync_start ------------>
195 * <--------------------- [hv]sync_end --------------------->
196 * <-------------------------------- [hv]total ----------------------------->*
198 * This structure contains two copies of timings. First are the plain timings,
199 * which specify the logical mode, as it would be for a progressive 1:1 scanout
200 * at the refresh rate userspace can observe through vblank timestamps. Then
201 * there's the hardware timings, which are corrected for interlacing,
202 * double-clocking and similar things. They are provided as a convenience, and
203 * can be appropriately computed using drm_mode_set_crtcinfo().
205 * For printing you can use %DRM_MODE_FMT and DRM_MODE_ARG().
207 struct drm_display_mode {
211 * struct list_head for mode lists.
213 struct list_head head;
218 * Human-readable name of the mode, filled out with drm_mode_set_name().
220 char name[DRM_DISPLAY_MODE_LEN];
225 * Status of the mode, used to filter out modes not supported by the
226 * hardware. See enum &drm_mode_status.
228 enum drm_mode_status status;
233 * A bitmask of flags, mostly about the source of a mode. Possible flags
236 * - DRM_MODE_TYPE_PREFERRED: Preferred mode, usually the native
237 * resolution of an LCD panel. There should only be one preferred
238 * mode per connector at any given time.
239 * - DRM_MODE_TYPE_DRIVER: Mode created by the driver, which is all of
240 * them really. Drivers must set this bit for all modes they create
241 * and expose to userspace.
242 * - DRM_MODE_TYPE_USERDEF: Mode defined via kernel command line
244 * Plus a big list of flags which shouldn't be used at all, but are
245 * still around since these flags are also used in the userspace ABI.
246 * We no longer accept modes with these types though:
248 * - DRM_MODE_TYPE_BUILTIN: Meant for hard-coded modes, unused.
249 * Use DRM_MODE_TYPE_DRIVER instead.
250 * - DRM_MODE_TYPE_DEFAULT: Again a leftover, use
251 * DRM_MODE_TYPE_PREFERRED instead.
252 * - DRM_MODE_TYPE_CLOCK_C and DRM_MODE_TYPE_CRTC_C: Define leftovers
253 * which are stuck around for hysterical raisins only. No one has an
254 * idea what they were meant for. Don't use.
261 * Pixel clock in kHz.
263 int clock; /* in kHz */
277 * Sync and timing flags:
279 * - DRM_MODE_FLAG_PHSYNC: horizontal sync is active high.
280 * - DRM_MODE_FLAG_NHSYNC: horizontal sync is active low.
281 * - DRM_MODE_FLAG_PVSYNC: vertical sync is active high.
282 * - DRM_MODE_FLAG_NVSYNC: vertical sync is active low.
283 * - DRM_MODE_FLAG_INTERLACE: mode is interlaced.
284 * - DRM_MODE_FLAG_DBLSCAN: mode uses doublescan.
285 * - DRM_MODE_FLAG_CSYNC: mode uses composite sync.
286 * - DRM_MODE_FLAG_PCSYNC: composite sync is active high.
287 * - DRM_MODE_FLAG_NCSYNC: composite sync is active low.
288 * - DRM_MODE_FLAG_HSKEW: hskew provided (not used?).
289 * - DRM_MODE_FLAG_BCAST: <deprecated>
290 * - DRM_MODE_FLAG_PIXMUX: <deprecated>
291 * - DRM_MODE_FLAG_DBLCLK: double-clocked mode.
292 * - DRM_MODE_FLAG_CLKDIV2: half-clocked mode.
294 * Additionally there's flags to specify how 3D modes are packed:
296 * - DRM_MODE_FLAG_3D_NONE: normal, non-3D mode.
297 * - DRM_MODE_FLAG_3D_FRAME_PACKING: 2 full frames for left and right.
298 * - DRM_MODE_FLAG_3D_FIELD_ALTERNATIVE: interleaved like fields.
299 * - DRM_MODE_FLAG_3D_LINE_ALTERNATIVE: interleaved lines.
300 * - DRM_MODE_FLAG_3D_SIDE_BY_SIDE_FULL: side-by-side full frames.
301 * - DRM_MODE_FLAG_3D_L_DEPTH: ?
302 * - DRM_MODE_FLAG_3D_L_DEPTH_GFX_GFX_DEPTH: ?
303 * - DRM_MODE_FLAG_3D_TOP_AND_BOTTOM: frame split into top and bottom
305 * - DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF: frame split into left and
313 * Addressable size of the output in mm, projectors should set this to
321 * Addressable size of the output in mm, projectors should set this to
329 * Actual pixel or dot clock in the hardware. This differs from the
330 * logical @clock when e.g. using interlacing, double-clocking, stereo
331 * modes or other fancy stuff that changes the timings and signals
332 * actually sent over the wire.
334 * This is again in kHz.
336 * Note that with digital outputs like HDMI or DP there's usually a
337 * massive confusion between the dot clock and the signal clock at the
338 * bit encoding level. Especially when a 8b/10b encoding is used and the
339 * difference is exactly a factor of 10.
343 int crtc_hblank_start;
345 int crtc_hsync_start;
350 int crtc_vblank_start;
352 int crtc_vsync_start;
359 * Pointer for driver private data. This can only be used for mode
360 * objects passed to drivers in modeset operations. It shouldn't be used
361 * by atomic drivers since they can store any additional data by
362 * subclassing state structures.
369 * Similar to @private, but just an integer.
376 * Vertical refresh rate, for debug output in human readable form. Not
377 * used in a functional way.
379 * This value is in Hz.
386 * Horizontal refresh rate, for debug output in human readable form. Not
387 * used in a functional way.
389 * This value is in kHz.
394 * @picture_aspect_ratio:
396 * Field for setting the HDMI picture aspect ratio of a mode.
398 enum hdmi_picture_aspect picture_aspect_ratio;
403 * struct list_head for modes to be exposed to the userspace.
404 * This is to maintain a list of exposed modes while preparing
405 * user-mode's list in drm_mode_getconnector ioctl. The purpose of this
406 * list_head only lies in the ioctl function, and is not expected to be
407 * used outside the function.
408 * Once used, the stale pointers are not reset, but left as it is, to
409 * avoid overhead of protecting it by mode_config.mutex.
411 struct list_head export_head;
415 * DRM_MODE_FMT - printf string for &struct drm_display_mode
417 #define DRM_MODE_FMT "\"%s\": %d %d %d %d %d %d %d %d %d %d 0x%x 0x%x"
420 * DRM_MODE_ARG - printf arguments for &struct drm_display_mode
423 #define DRM_MODE_ARG(m) \
424 (m)->name, (m)->vrefresh, (m)->clock, \
425 (m)->hdisplay, (m)->hsync_start, (m)->hsync_end, (m)->htotal, \
426 (m)->vdisplay, (m)->vsync_start, (m)->vsync_end, (m)->vtotal, \
427 (m)->type, (m)->flags
429 #define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
432 * drm_mode_is_stereo - check for stereo mode flags
433 * @mode: drm_display_mode to check
436 * True if the mode is one of the stereo modes (like side-by-side), false if
439 static inline bool drm_mode_is_stereo(const struct drm_display_mode *mode)
441 return mode->flags & DRM_MODE_FLAG_3D_MASK;
444 struct drm_connector;
445 struct drm_cmdline_mode;
447 struct drm_display_mode *drm_mode_create(struct drm_device *dev);
448 void drm_mode_destroy(struct drm_device *dev, struct drm_display_mode *mode);
449 void drm_mode_convert_to_umode(struct drm_mode_modeinfo *out,
450 const struct drm_display_mode *in);
451 int drm_mode_convert_umode(struct drm_device *dev,
452 struct drm_display_mode *out,
453 const struct drm_mode_modeinfo *in);
454 void drm_mode_probed_add(struct drm_connector *connector, struct drm_display_mode *mode);
455 void drm_mode_debug_printmodeline(const struct drm_display_mode *mode);
456 bool drm_mode_is_420_only(const struct drm_display_info *display,
457 const struct drm_display_mode *mode);
458 bool drm_mode_is_420_also(const struct drm_display_info *display,
459 const struct drm_display_mode *mode);
460 bool drm_mode_is_420(const struct drm_display_info *display,
461 const struct drm_display_mode *mode);
463 struct drm_display_mode *drm_cvt_mode(struct drm_device *dev,
464 int hdisplay, int vdisplay, int vrefresh,
465 bool reduced, bool interlaced,
467 struct drm_display_mode *drm_gtf_mode(struct drm_device *dev,
468 int hdisplay, int vdisplay, int vrefresh,
469 bool interlaced, int margins);
470 struct drm_display_mode *drm_gtf_mode_complex(struct drm_device *dev,
471 int hdisplay, int vdisplay,
472 int vrefresh, bool interlaced,
474 int GTF_M, int GTF_2C,
475 int GTF_K, int GTF_2J);
476 void drm_display_mode_from_videomode(const struct videomode *vm,
477 struct drm_display_mode *dmode);
478 void drm_display_mode_to_videomode(const struct drm_display_mode *dmode,
479 struct videomode *vm);
480 void drm_bus_flags_from_videomode(const struct videomode *vm, u32 *bus_flags);
481 int of_get_drm_display_mode(struct device_node *np,
482 struct drm_display_mode *dmode, u32 *bus_flags,
485 void drm_mode_set_name(struct drm_display_mode *mode);
486 int drm_mode_hsync(const struct drm_display_mode *mode);
487 int drm_mode_vrefresh(const struct drm_display_mode *mode);
488 void drm_mode_get_hv_timing(const struct drm_display_mode *mode,
489 int *hdisplay, int *vdisplay);
491 void drm_mode_set_crtcinfo(struct drm_display_mode *p,
493 void drm_mode_copy(struct drm_display_mode *dst,
494 const struct drm_display_mode *src);
495 struct drm_display_mode *drm_mode_duplicate(struct drm_device *dev,
496 const struct drm_display_mode *mode);
497 bool drm_mode_match(const struct drm_display_mode *mode1,
498 const struct drm_display_mode *mode2,
499 unsigned int match_flags);
500 bool drm_mode_equal(const struct drm_display_mode *mode1,
501 const struct drm_display_mode *mode2);
502 bool drm_mode_equal_no_clocks(const struct drm_display_mode *mode1,
503 const struct drm_display_mode *mode2);
504 bool drm_mode_equal_no_clocks_no_stereo(const struct drm_display_mode *mode1,
505 const struct drm_display_mode *mode2);
507 /* for use by the crtc helper probe functions */
508 enum drm_mode_status drm_mode_validate_driver(struct drm_device *dev,
509 const struct drm_display_mode *mode);
510 enum drm_mode_status drm_mode_validate_size(const struct drm_display_mode *mode,
513 drm_mode_validate_ycbcr420(const struct drm_display_mode *mode,
514 struct drm_connector *connector);
515 void drm_mode_prune_invalid(struct drm_device *dev,
516 struct list_head *mode_list, bool verbose);
517 void drm_mode_sort(struct list_head *mode_list);
518 void drm_connector_list_update(struct drm_connector *connector);
520 /* parsing cmdline modes */
522 drm_mode_parse_command_line_for_connector(const char *mode_option,
523 struct drm_connector *connector,
524 struct drm_cmdline_mode *mode);
525 struct drm_display_mode *
526 drm_mode_create_from_cmdline_mode(struct drm_device *dev,
527 struct drm_cmdline_mode *cmd);
529 #endif /* __DRM_MODES_H__ */