uapi/drm/drm_mode.h

5  * Copyright (c) 2007-2008 Tungsten Graphics, Inc., Cedar Park, TX., USA
6  * Copyright (c) 2007-2008 Intel Corporation
62 /* bit compatible with the xrandr RR_ definitions (bits 0-13)
176  * using the name->prop id lookup is the preferred method.
202  * using the name->prop id lookup is the preferred method.
222  * struct drm_mode_modeinfo - Display mode information.
224  * @hdisplay: horizontal display size
225  * @hsync_start: horizontal sync start
226  * @hsync_end: horizontal sync end
227  * @htotal: horizontal total size
228  * @hskew: horizontal skew
239  * This is the user-space API display mode information structure. For the
316  * struct drm_mode_get_plane - Get plane metadata.
388 	DRM_MODE_SUBCONNECTOR_Automatic   = 0,  /* DVI-I, TV     */
389 	DRM_MODE_SUBCONNECTOR_Unknown     = 0,  /* DVI-I, TV, DP */
391 	DRM_MODE_SUBCONNECTOR_DVID	  = 3,  /* DVI-I      DP */
392 	DRM_MODE_SUBCONNECTOR_DVIA	  = 4,  /* DVI-I         */
426  * struct drm_mode_get_connector - Get connector metadata.
428  * User-space can perform a GETCONNECTOR ioctl to retrieve information about a
429  * connector. User-space is expected to retrieve encoders, modes and properties
442  * changed with a hotplug event in-between the two ioctls. User-space is
446  * **Force-probing a connector**
450  * refresh the connector status, modes and EDID. A forced-probe can be slow,
453  * User-space needs to force-probe connectors to ensure their metadata is
454  * up-to-date at startup and after receiving a hot-plug event. User-space
455  * may perform a forced-probe when the user explicitly requests it. User-space
456  * shouldn't perform a forced-probe in other situations.
486 	 * @connector_type_id: Type-specific connector number.
488 	 * This is not an object ID. This is a per-type connector number. Each
525 /* non-extended types: legacy bitmask, one bit per type: */
532 /* extended-types: rather than continue to consume a bit per type,
548  * struct drm_mode_property_enum - Description for an enum/bitfield entry.
560  * struct drm_mode_get_property - Get property metadata.
562  * User-space can perform a GETPROPERTY ioctl to retrieve information about a
572  * zero when the property has the type &DRM_MODE_PROP_BLOB. User-space must
575  * User-space is expected to retrieve values and enums by performing this ioctl
607 	 * @name: Symbolic property name. User-space should use this field to
667 #define DRM_MODE_FB_MODIFIERS	(1<<1) /* enables ->modifier[] */
670  * struct drm_mode_fb_cmd2 - Frame-buffer metadata.
672  * This struct holds frame-buffer metadata. There are two ways to use it:
674  * - User-space can fill this struct and perform a &DRM_IOCTL_MODE_ADDFB2
675  *   ioctl to register a new frame-buffer. The new frame-buffer object ID will
677  * - User-space can set @fb_id and perform a &DRM_IOCTL_MODE_GETFB2 ioctl to
678  *   fetch metadata about an existing frame-buffer.
684  *     YUV 4:2:0 image with a plane of 8-bit Y samples followed by an
685  *     interleaved U/V plane containing 8-bit 2x2 subsampled colour difference
693  * though it looks like we have a modifier per-plane, we in fact do not. The
695  * different data layouts for multi-plane formats must be enumerated as
704 	/** @fb_id: Object ID of the frame-buffer. */
706 	/** @width: Width of the frame-buffer. */
708 	/** @height: Height of the frame-buffer. */
716 	 * @flags: Frame-buffer flags (see &DRM_MODE_FB_INTERLACED and
795  *    handle - if 0 turns the cursor off
838 	 * Conversion matrix in S31.32 sign-magnitude
851 	 * Values are mapped linearly to 0.0 - 1.0 range, with 0x0 == 0.0 and
861  * struct drm_plane_size_hint - Plane size hints
874  * struct hdr_metadata_infoframe - HDR Metadata Infoframe Data.
884 	 * @eotf: Electro-Optical Transfer Function (EOTF)
894 	 * These are coded as unsigned 16-bit values in units of
905 	 * These are coded as unsigned 16-bit values in units of
916 	 * This value is coded as an unsigned 16-bit value in units of 1 cd/m2,
922 	 * This value is coded as an unsigned 16-bit value in units of
929 	 * This value is coded as an unsigned 16-bit value in units of 1 cd/m2,
935 	 * This value is coded as an unsigned 16-bit value in units of 1 cd/m2,
942  * struct hdr_output_metadata - HDR output metadata
964  * page-flip is done.
970  * Request that the page-flip is performed as soon as possible, ie. with no
975  * doesn't support performing an asynchronous page-flip for this update.
976  * User-space should handle this, e.g. by falling back to a regular page-flip.
978  * Note, some hardware might need to perform one last synchronous page-flip
979  * before being able to switch to asynchronous page-flips. As an exception,
980  * the driver will return success even though that first page-flip is not
998  * Request a page flip on the specified crtc.
1000  * This ioctl will ask KMS to schedule a page flip for the specified
1005  * in the execbuffer ioctl until the page flip happens.  If a page
1006  * flip is already pending as the ioctl is called, EBUSY will be
1010  * event (see drm.h: struct drm_event_vblank) when the page flip is
1014  * Flag DRM_MODE_PAGE_FLIP_ASYNC requests that the flip happen
1030  * Request a page flip on the specified crtc.
1033  * re-purposes the reserved field:
1038  * vblank sequence when the flip should take effect. When the RELATIVE
1040  * current one when the ioctl is called) vblank sequence when the flip
1045  * the target for when code dealing with a page flip runs during a
1058  * struct drm_mode_create_dumb - Create a KMS dumb buffer for scanout.
1067  * User-space fills @height, @width, @bpp and @flags. If the IOCTL succeeds,
1089 	 * This is a fixed-size type for 32/64 compatibility.
1104  * See &drm_mode_config_funcs.atomic_check for more details on test-only
1122  * more time than a page flip. All visual artifacts will disappear by the time
1129  * User-space that needs to know beforehand if an update might cause visible
1195 	 *		  ^-offset = 0, formats = 5
1197 	 * If the number formats grew to 128, and formats 98-102 are
1214  * struct drm_mode_create_blob - Create New blob property
1229  * struct drm_mode_destroy_blob - Destroy user blob
1232  * Destroy a user-created blob property.
1234  * User-space can release blobs as soon as they do not need to refer to them by
1236  * atomic commit and you will not make another commit re-using the same ID, you
1245  * struct drm_mode_create_lease - Create lease
1268  * struct drm_mode_list_lessees - List lessees
1295  * struct drm_mode_get_lease - Get Lease
1322  * struct drm_mode_revoke_lease - Revoke lease
1330  * struct drm_mode_rect - Two dimensional rectangle.
1331  * @x1: Horizontal starting coordinate (inclusive).
1333  * @x2: Horizontal ending coordinate (exclusive).
1337  * export it to user-space.