include/drm/drm_modes.h

3  * Copyright © 2007-2008 Dave Airlie
4  * Copyright © 2007-2008 Intel Corporation
9  * Permission is hereby granted, free of charge, to any person obtaining a
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:
20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
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
46  * enum drm_mode_status - hardware support status of a mode
88  * This enum is used to filter out modes not supported by the driver/hardware
129 	MODE_STALE = -3,
130 	MODE_BAD = -2,
131 	MODE_ERROR = -1
142  * DRM_MODE_RES_MM - Calculates the display size from resolution and DPI
144  * @dpi: The number of dots per inch
146 #define DRM_MODE_RES_MM(res, dpi)	\  argument
147 	(((res) * 254ul) / ((dpi) * 10ul))
157  * DRM_MODE_INIT - Initialize display mode
171  * DRM_SIMPLE_MODE - Simple display mode
198  * struct drm_display_mode - DRM kernel-internal display mode structure
224  * user-space version see struct drm_mode_modeinfo.
233  *     <-----------------------><----------------><-------------><-------------->
238  *     <----- [hv]display ----->
239  *     <------------- [hv]sync_start ------------>
240  *     <--------------------- [hv]sync_end --------------------->
241  *     <-------------------------------- [hv]total ----------------------------->*
247  * double-clocking and similar things. They are provided as a convenience, and
274 	 *  - DRM_MODE_FLAG_PHSYNC: horizontal sync is active high.
275 	 *  - DRM_MODE_FLAG_NHSYNC: horizontal sync is active low.
276 	 *  - DRM_MODE_FLAG_PVSYNC: vertical sync is active high.
277 	 *  - DRM_MODE_FLAG_NVSYNC: vertical sync is active low.
278 	 *  - DRM_MODE_FLAG_INTERLACE: mode is interlaced.
279 	 *  - DRM_MODE_FLAG_DBLSCAN: mode uses doublescan.
280 	 *  - DRM_MODE_FLAG_CSYNC: mode uses composite sync.
281 	 *  - DRM_MODE_FLAG_PCSYNC: composite sync is active high.
282 	 *  - DRM_MODE_FLAG_NCSYNC: composite sync is active low.
283 	 *  - DRM_MODE_FLAG_HSKEW: hskew provided (not used?).
284 	 *  - DRM_MODE_FLAG_BCAST: <deprecated>
285 	 *  - DRM_MODE_FLAG_PIXMUX: <deprecated>
286 	 *  - DRM_MODE_FLAG_DBLCLK: double-clocked mode.
287 	 *  - DRM_MODE_FLAG_CLKDIV2: half-clocked mode.
289 	 * Additionally there's flags to specify how 3D modes are packed:
291 	 *  - DRM_MODE_FLAG_3D_NONE: normal, non-3D mode.
292 	 *  - DRM_MODE_FLAG_3D_FRAME_PACKING: 2 full frames for left and right.
293 	 *  - DRM_MODE_FLAG_3D_FIELD_ALTERNATIVE: interleaved like fields.
294 	 *  - DRM_MODE_FLAG_3D_LINE_ALTERNATIVE: interleaved lines.
295 	 *  - DRM_MODE_FLAG_3D_SIDE_BY_SIDE_FULL: side-by-side full frames.
296 	 *  - DRM_MODE_FLAG_3D_L_DEPTH: ?
297 	 *  - DRM_MODE_FLAG_3D_L_DEPTH_GFX_GFX_DEPTH: ?
298 	 *  - DRM_MODE_FLAG_3D_TOP_AND_BOTTOM: frame split into top and bottom
300 	 *  - DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF: frame split into left and
309 	 * logical @clock when e.g. using interlacing, double-clocking, stereo
338 	 * Addressable size of the output in mm, projectors should set this to
346 	 * Addressable size of the output in mm, projectors should set this to
357 	 *  - DRM_MODE_TYPE_PREFERRED: Preferred mode, usually the native
360 	 *  - DRM_MODE_TYPE_DRIVER: Mode created by the driver, which is all of
362 	 *    and expose to userspace.
363 	 *  - DRM_MODE_TYPE_USERDEF: Mode defined or selected via the kernel
370 	 *  - DRM_MODE_TYPE_BUILTIN: Meant for hard-coded modes, unused.
372 	 *  - DRM_MODE_TYPE_DEFAULT: Again a leftover, use
374 	 *  - DRM_MODE_TYPE_CLOCK_C and DRM_MODE_TYPE_CRTC_C: Define leftovers
383 	 * Indicates whether the mode is to be exposed to the userspace.
384 	 * This is to maintain a set of exposed modes while preparing
385 	 * user-mode's list in drm_mode_getconnector ioctl. The purpose of
386 	 * this only lies in the ioctl function, and is not to be used
401 	 * Human-readable name of the mode, filled out with drm_mode_set_name().
408 	 * Status of the mode, used to filter out modes not supported by the
423  * DRM_MODE_FMT - printf string for &struct drm_display_mode
428  * DRM_MODE_ARG - printf arguments for &struct drm_display_mode
432 	(m)->name, drm_mode_vrefresh(m), (m)->clock, \
433 	(m)->hdisplay, (m)->hsync_start, (m)->hsync_end, (m)->htotal, \
434 	(m)->vdisplay, (m)->vsync_start, (m)->vsync_end, (m)->vtotal, \
435 	(m)->type, (m)->flags
440  * drm_mode_is_stereo - check for stereo mode flags
441  * @mode: drm_display_mode to check
444  * True if the mode is one of the stereo modes (like side-by-side), false if
449 	return mode->flags & DRM_MODE_FLAG_3D_MASK;  in drm_mode_is_stereo()
520 	return -EINVAL;  in of_get_drm_display_mode()
526 	return -EINVAL;  in of_get_drm_panel_display_mode()