5  * Copyright (c) 2007-2008 Tungsten Graphics, Inc., Cedar Park, TX., USA
6  * Copyright (c) 2007-2008 Intel Corporation
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
61 /* Video mode flags */
62 /* bit compatible with the xrandr RR_ definitions (bits 0-13)
65  * the mode flags to match the xrandr definitions. Any
69  * allocating new flags in the previously unused bits!
141 /* DPMS flags */
175  * This define is provided as a convenience, looking up the property id
176  * using the name->prop id lookup is the preferred method.
198  * in the same way as mirroring.
201  * This define is provided as a convenience, looking up the property id
202  * using the name->prop id lookup is the preferred method.
216 /* Content Protection Flags */
222  * struct drm_mode_modeinfo - Display mode information.
235  * @flags: bitmask of misc. flags, see DRM_MODE_FLAG_* defines
236  * @type: bitmask of type flags, see DRM_MODE_TYPE_* defines
239  * This is the user-space API display mode information structure. For the
257 	__u32 flags;  member
300 	__u32 flags; /* see above flags */  member
316  * struct drm_mode_get_plane - Get plane metadata.
386 /* Try to match DRM_MODE_CONNECTOR_X as closely as possible. */
387 enum drm_mode_subconnector {
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
500 	 * See enum drm_connector_status.
510 	 * See enum subpixel_order.
525 /* non-extended types: legacy bitmask, one bit per type: */
532 /* extended-types: rather than continue to consume a bit per type,
533  * grab a chunk of the bits to use as integer type id.
548  * struct drm_mode_property_enum - Description for an enum/bitfield entry.
549  * @value: numeric value for this enum entry.
550  * @name: symbolic name for this enum entry.
560  * struct drm_mode_get_property - Get property metadata.
562  * User-space can perform a GETPROPERTY ioctl to retrieve information about a
567  * See &drm_property.flags for more details.
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
582  * &DRM_MODE_PROP_BITMASK, @count_enum_blobs will be updated as well.
602 	 * @flags: ``DRM_MODE_PROP_*`` bitfield. See &drm_property.flags for
603 	 * a definition of the flags.
605 	__u32 flags;  member
607 	 * @name: Symbolic property name. User-space should use this field to
668 #define DRM_MODE_FB_MODIFIERS	(1<<1) /* enables ->modifier[] */
671  * struct drm_mode_fb_cmd2 - Frame-buffer metadata.
673  * This struct holds frame-buffer metadata. There are two ways to use it:
675  * - User-space can fill this struct and perform a &DRM_IOCTL_MODE_ADDFB2
676  *   ioctl to register a new frame-buffer. The new frame-buffer object ID will
678  * - User-space can set @fb_id and perform a &DRM_IOCTL_MODE_GETFB2 ioctl to
679  *   fetch metadata about an existing frame-buffer.
683  * the format FourCC as defined by ``drm_fourcc.h``, e.g. NV12 is described as:
685  *     YUV 4:2:0 image with a plane of 8-bit Y samples followed by an
686  *     interleaved U/V plane containing 8-bit 2x2 subsampled colour difference
694  * though it looks like we have a modifier per-plane, we in fact do not. The
696  * different data layouts for multi-plane formats must be enumerated as
705 	/** @fb_id: Object ID of the frame-buffer. */
707 	/** @width: Width of the frame-buffer. */
709 	/** @height: Height of the frame-buffer. */
717 	 * @flags: Frame-buffer flags (see &DRM_MODE_FB_INTERLACED and
720 	__u32 flags;  member
734 	 * modifier. Ignored unless &DRM_MODE_FB_MODIFIERS is set in @flags.
746  * Mark a region of a framebuffer as dirty.
749  * as a hardware or software draw to a framebuffer. This ioctl
769  * completely with a single color as given in the color argument.
774 	__u32 flags;  member
790  * depending on the value in flags different members are used.
796  *    handle - if 0 turns the cursor off
804 	__u32 flags;  member
815 	__u32 flags;  member
839 	 * Conversion matrix in S31.32 sign-magnitude
852 	 * Conversion matrix with 3x4 dimensions in S31.32 sign-magnitude
866 	 * Values are mapped linearly to 0.0 - 1.0 range, with 0x0 == 0.0 and
878  * 32-bit per channel color LUT entry, similar to drm_color_lut.
888  * enum drm_colorop_type - Type of color operation
891  * and defines a different set of properties. This enum defines all types and
892  * gives a high-level description.
894 enum drm_colorop_type {
898 	 * enum string "1D Curve"
908 	 * enum string "1D LUT"
922 	 * enum string "3x4 Matrix"
938 	 * enum string "Multiplier"
941 	 * multiplier is specified as a S31.32 via the MULTIPLIER
949 	 * enum string "3D LUT"
970  * enum drm_colorop_lut3d_interpolation_type - type of 3DLUT interpolation
972 enum drm_colorop_lut3d_interpolation_type {
982  * enum drm_colorop_lut1d_interpolation_type - type of interpolation for 1D LUTs
984 enum drm_colorop_lut1d_interpolation_type {
995  * struct drm_plane_size_hint - Plane size hints
1008  * struct hdr_metadata_infoframe - HDR Metadata Infoframe Data.
1010  * HDR Metadata Infoframe as per CTA 861.G spec. This is expected
1013  * Userspace is expected to pass the metadata information as per
1018 	 * @eotf: Electro-Optical Transfer Function (EOTF)
1028 	 * These are coded as unsigned 16-bit values in units of
1039 	 * These are coded as unsigned 16-bit values in units of
1050 	 * This value is coded as an unsigned 16-bit value in units of 1 cd/m2,
1056 	 * This value is coded as an unsigned 16-bit value in units of
1063 	 * This value is coded as an unsigned 16-bit value in units of 1 cd/m2,
1069 	 * This value is coded as an unsigned 16-bit value in units of 1 cd/m2,
1076  * struct hdr_output_metadata - HDR output metadata
1098  * page-flip is done.
1112  * Request that the page-flip is performed as soon as possible, ie. with no
1117  * doesn't support performing an asynchronous page-flip for this update.
1118  * User-space should handle this, e.g. by falling back to a regular page-flip.
1120  * Note, some hardware might need to perform one last synchronous page-flip
1121  * before being able to switch to asynchronous page-flips. As an exception,
1122  * the driver will return success even though that first page-flip is not
1133  * Bitmask of flags suitable for &drm_mode_crtc_page_flip_target.flags.
1143  * crtc.  Once any pending rendering targeting the specified fb (as of
1148  * flip is already pending as the ioctl is called, EBUSY will be
1154  * returned as the user_data field in the vblank event struct.
1157  * 'as soon as possible', meaning that it not delay waiting for vblank.
1166 	__u32 flags;  member
1174  * Same as struct drm_mode_crtc_page_flip, but supports new flags and
1175  * re-purposes the reserved field:
1178  * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is specified. When
1186  * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is merely to clarify
1194 	__u32 flags;  member
1200  * struct drm_mode_create_dumb - Create a KMS dumb buffer for scanout.
1204  * @flags: must be zero
1209  * User-space fills @height, @width, @bpp and @flags. If the IOCTL succeeds,
1212  * The value of @bpp is a color-mode number describing a specific format
1218  * Support for all modes and formats is optional. Even if dumb-buffer
1224  * +------------+------------------------+------------------------+
1230  * +------------+------------------------+------------------------+
1232  * +------------+------------------------+------------------------+
1234  * +------------+------------------------+------------------------+
1238  * +------------+------------------------+------------------------+
1241  * +------------+------------------------+------------------------+
1244  * +------------+------------------------+------------------------+
1247  * +------------+------------------------+------------------------+
1250  * +------------+------------------------+------------------------+
1257  * with single-plane RGB data. Allocation of other framebuffer
1264 	__u32 flags;  member
1279 	 * This is a fixed-size type for 32/64 compatibility.
1294  * See &drm_mode_config_funcs.atomic_check for more details on test-only
1313  * the update is completed, as signalled through the vblank event's timestamp
1319  * User-space that needs to know beforehand if an update might cause visible
1332  * Bitfield of flags accepted by the &DRM_IOCTL_MODE_ATOMIC IOCTL in
1333  * &drm_mode_atomic.flags.
1343 	__u32 flags;  member
1358 	/* Flags */
1359 	__u32 flags;  member
1385 	 *		  ^-offset = 0, formats = 5
1387 	 * If the number formats grew to 128, and formats 98-102 are
1404  * struct drm_mode_create_blob - Create New blob property
1419  * struct drm_mode_destroy_blob - Destroy user blob
1422  * Destroy a user-created blob property.
1424  * User-space can release blobs as soon as they do not need to refer to them by
1426  * atomic commit and you will not make another commit re-using the same ID, you
1427  * can destroy the blob as soon as the commit has been issued, without waiting
1435  * struct drm_mode_create_lease - Create lease
1448 	/** @flags: flags for new FD (O_CLOEXEC, etc) */
1449 	__u32 flags;  member
1458  * struct drm_mode_list_lessees - List lessees
1485  * struct drm_mode_get_lease - Get Lease
1512  * struct drm_mode_revoke_lease - Revoke lease
1520  * struct drm_mode_rect - Two dimensional rectangle.
1527  * export it to user-space.