Back to home page

EIC code displayed by LXR

 
 

    


File indexing completed on 2025-01-18 10:01:49

0001 /*
0002  * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
0003  * Copyright (c) 2007 Jakob Bornecrantz <wallbraker@gmail.com>
0004  * Copyright (c) 2008 Red Hat Inc.
0005  * Copyright (c) 2007-2008 Tungsten Graphics, Inc., Cedar Park, TX., USA
0006  * Copyright (c) 2007-2008 Intel Corporation
0007  *
0008  * Permission is hereby granted, free of charge, to any person obtaining a
0009  * copy of this software and associated documentation files (the "Software"),
0010  * to deal in the Software without restriction, including without limitation
0011  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
0012  * and/or sell copies of the Software, and to permit persons to whom the
0013  * Software is furnished to do so, subject to the following conditions:
0014  *
0015  * The above copyright notice and this permission notice shall be included in
0016  * all copies or substantial portions of the Software.
0017  *
0018  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
0019  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
0020  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
0021  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
0022  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
0023  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
0024  * IN THE SOFTWARE.
0025  */
0026 
0027 #ifndef _DRM_MODE_H
0028 #define _DRM_MODE_H
0029 
0030 #include "drm.h"
0031 
0032 #if defined(__cplusplus)
0033 extern "C" {
0034 #endif
0035 
0036 /**
0037  * DOC: overview
0038  *
0039  * DRM exposes many UAPI and structure definitions to have a consistent
0040  * and standardized interface with users.
0041  * Userspace can refer to these structure definitions and UAPI formats
0042  * to communicate to drivers.
0043  */
0044 
0045 #define DRM_CONNECTOR_NAME_LEN  32
0046 #define DRM_DISPLAY_MODE_LEN    32
0047 #define DRM_PROP_NAME_LEN   32
0048 
0049 #define DRM_MODE_TYPE_BUILTIN   (1<<0) /* deprecated */
0050 #define DRM_MODE_TYPE_CLOCK_C   ((1<<1) | DRM_MODE_TYPE_BUILTIN) /* deprecated */
0051 #define DRM_MODE_TYPE_CRTC_C    ((1<<2) | DRM_MODE_TYPE_BUILTIN) /* deprecated */
0052 #define DRM_MODE_TYPE_PREFERRED (1<<3)
0053 #define DRM_MODE_TYPE_DEFAULT   (1<<4) /* deprecated */
0054 #define DRM_MODE_TYPE_USERDEF   (1<<5)
0055 #define DRM_MODE_TYPE_DRIVER    (1<<6)
0056 
0057 #define DRM_MODE_TYPE_ALL   (DRM_MODE_TYPE_PREFERRED |  \
0058                  DRM_MODE_TYPE_USERDEF |    \
0059                  DRM_MODE_TYPE_DRIVER)
0060 
0061 /* Video mode flags */
0062 /* bit compatible with the xrandr RR_ definitions (bits 0-13)
0063  *
0064  * ABI warning: Existing userspace really expects
0065  * the mode flags to match the xrandr definitions. Any
0066  * changes that don't match the xrandr definitions will
0067  * likely need a new client cap or some other mechanism
0068  * to avoid breaking existing userspace. This includes
0069  * allocating new flags in the previously unused bits!
0070  */
0071 #define DRM_MODE_FLAG_PHSYNC            (1<<0)
0072 #define DRM_MODE_FLAG_NHSYNC            (1<<1)
0073 #define DRM_MODE_FLAG_PVSYNC            (1<<2)
0074 #define DRM_MODE_FLAG_NVSYNC            (1<<3)
0075 #define DRM_MODE_FLAG_INTERLACE         (1<<4)
0076 #define DRM_MODE_FLAG_DBLSCAN           (1<<5)
0077 #define DRM_MODE_FLAG_CSYNC         (1<<6)
0078 #define DRM_MODE_FLAG_PCSYNC            (1<<7)
0079 #define DRM_MODE_FLAG_NCSYNC            (1<<8)
0080 #define DRM_MODE_FLAG_HSKEW         (1<<9) /* hskew provided */
0081 #define DRM_MODE_FLAG_BCAST         (1<<10) /* deprecated */
0082 #define DRM_MODE_FLAG_PIXMUX            (1<<11) /* deprecated */
0083 #define DRM_MODE_FLAG_DBLCLK            (1<<12)
0084 #define DRM_MODE_FLAG_CLKDIV2           (1<<13)
0085  /*
0086   * When adding a new stereo mode don't forget to adjust DRM_MODE_FLAGS_3D_MAX
0087   * (define not exposed to user space).
0088   */
0089 #define DRM_MODE_FLAG_3D_MASK           (0x1f<<14)
0090 #define  DRM_MODE_FLAG_3D_NONE      (0<<14)
0091 #define  DRM_MODE_FLAG_3D_FRAME_PACKING     (1<<14)
0092 #define  DRM_MODE_FLAG_3D_FIELD_ALTERNATIVE (2<<14)
0093 #define  DRM_MODE_FLAG_3D_LINE_ALTERNATIVE  (3<<14)
0094 #define  DRM_MODE_FLAG_3D_SIDE_BY_SIDE_FULL (4<<14)
0095 #define  DRM_MODE_FLAG_3D_L_DEPTH       (5<<14)
0096 #define  DRM_MODE_FLAG_3D_L_DEPTH_GFX_GFX_DEPTH (6<<14)
0097 #define  DRM_MODE_FLAG_3D_TOP_AND_BOTTOM    (7<<14)
0098 #define  DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF (8<<14)
0099 
0100 /* Picture aspect ratio options */
0101 #define DRM_MODE_PICTURE_ASPECT_NONE        0
0102 #define DRM_MODE_PICTURE_ASPECT_4_3     1
0103 #define DRM_MODE_PICTURE_ASPECT_16_9        2
0104 #define DRM_MODE_PICTURE_ASPECT_64_27       3
0105 #define DRM_MODE_PICTURE_ASPECT_256_135     4
0106 
0107 /* Content type options */
0108 #define DRM_MODE_CONTENT_TYPE_NO_DATA       0
0109 #define DRM_MODE_CONTENT_TYPE_GRAPHICS      1
0110 #define DRM_MODE_CONTENT_TYPE_PHOTO     2
0111 #define DRM_MODE_CONTENT_TYPE_CINEMA        3
0112 #define DRM_MODE_CONTENT_TYPE_GAME      4
0113 
0114 /* Aspect ratio flag bitmask (4 bits 22:19) */
0115 #define DRM_MODE_FLAG_PIC_AR_MASK       (0x0F<<19)
0116 #define  DRM_MODE_FLAG_PIC_AR_NONE \
0117             (DRM_MODE_PICTURE_ASPECT_NONE<<19)
0118 #define  DRM_MODE_FLAG_PIC_AR_4_3 \
0119             (DRM_MODE_PICTURE_ASPECT_4_3<<19)
0120 #define  DRM_MODE_FLAG_PIC_AR_16_9 \
0121             (DRM_MODE_PICTURE_ASPECT_16_9<<19)
0122 #define  DRM_MODE_FLAG_PIC_AR_64_27 \
0123             (DRM_MODE_PICTURE_ASPECT_64_27<<19)
0124 #define  DRM_MODE_FLAG_PIC_AR_256_135 \
0125             (DRM_MODE_PICTURE_ASPECT_256_135<<19)
0126 
0127 #define  DRM_MODE_FLAG_ALL  (DRM_MODE_FLAG_PHSYNC |     \
0128                  DRM_MODE_FLAG_NHSYNC |     \
0129                  DRM_MODE_FLAG_PVSYNC |     \
0130                  DRM_MODE_FLAG_NVSYNC |     \
0131                  DRM_MODE_FLAG_INTERLACE |  \
0132                  DRM_MODE_FLAG_DBLSCAN |    \
0133                  DRM_MODE_FLAG_CSYNC |      \
0134                  DRM_MODE_FLAG_PCSYNC |     \
0135                  DRM_MODE_FLAG_NCSYNC |     \
0136                  DRM_MODE_FLAG_HSKEW |      \
0137                  DRM_MODE_FLAG_DBLCLK |     \
0138                  DRM_MODE_FLAG_CLKDIV2 |    \
0139                  DRM_MODE_FLAG_3D_MASK)
0140 
0141 /* DPMS flags */
0142 /* bit compatible with the xorg definitions. */
0143 #define DRM_MODE_DPMS_ON    0
0144 #define DRM_MODE_DPMS_STANDBY   1
0145 #define DRM_MODE_DPMS_SUSPEND   2
0146 #define DRM_MODE_DPMS_OFF   3
0147 
0148 /* Scaling mode options */
0149 #define DRM_MODE_SCALE_NONE     0 /* Unmodified timing (display or
0150                          software can still scale) */
0151 #define DRM_MODE_SCALE_FULLSCREEN   1 /* Full screen, ignore aspect */
0152 #define DRM_MODE_SCALE_CENTER       2 /* Centered, no scaling */
0153 #define DRM_MODE_SCALE_ASPECT       3 /* Full screen, preserve aspect */
0154 
0155 /* Dithering mode options */
0156 #define DRM_MODE_DITHERING_OFF  0
0157 #define DRM_MODE_DITHERING_ON   1
0158 #define DRM_MODE_DITHERING_AUTO 2
0159 
0160 /* Dirty info options */
0161 #define DRM_MODE_DIRTY_OFF      0
0162 #define DRM_MODE_DIRTY_ON       1
0163 #define DRM_MODE_DIRTY_ANNOTATE 2
0164 
0165 /* Link Status options */
0166 #define DRM_MODE_LINK_STATUS_GOOD   0
0167 #define DRM_MODE_LINK_STATUS_BAD    1
0168 
0169 /*
0170  * DRM_MODE_ROTATE_<degrees>
0171  *
0172  * Signals that a drm plane is been rotated <degrees> degrees in counter
0173  * clockwise direction.
0174  *
0175  * This define is provided as a convenience, looking up the property id
0176  * using the name->prop id lookup is the preferred method.
0177  */
0178 #define DRM_MODE_ROTATE_0       (1<<0)
0179 #define DRM_MODE_ROTATE_90      (1<<1)
0180 #define DRM_MODE_ROTATE_180     (1<<2)
0181 #define DRM_MODE_ROTATE_270     (1<<3)
0182 
0183 /*
0184  * DRM_MODE_ROTATE_MASK
0185  *
0186  * Bitmask used to look for drm plane rotations.
0187  */
0188 #define DRM_MODE_ROTATE_MASK (\
0189         DRM_MODE_ROTATE_0  | \
0190         DRM_MODE_ROTATE_90  | \
0191         DRM_MODE_ROTATE_180 | \
0192         DRM_MODE_ROTATE_270)
0193 
0194 /*
0195  * DRM_MODE_REFLECT_<axis>
0196  *
0197  * Signals that the contents of a drm plane is reflected along the <axis> axis,
0198  * in the same way as mirroring.
0199  * See kerneldoc chapter "Plane Composition Properties" for more details.
0200  *
0201  * This define is provided as a convenience, looking up the property id
0202  * using the name->prop id lookup is the preferred method.
0203  */
0204 #define DRM_MODE_REFLECT_X      (1<<4)
0205 #define DRM_MODE_REFLECT_Y      (1<<5)
0206 
0207 /*
0208  * DRM_MODE_REFLECT_MASK
0209  *
0210  * Bitmask used to look for drm plane reflections.
0211  */
0212 #define DRM_MODE_REFLECT_MASK (\
0213         DRM_MODE_REFLECT_X | \
0214         DRM_MODE_REFLECT_Y)
0215 
0216 /* Content Protection Flags */
0217 #define DRM_MODE_CONTENT_PROTECTION_UNDESIRED   0
0218 #define DRM_MODE_CONTENT_PROTECTION_DESIRED     1
0219 #define DRM_MODE_CONTENT_PROTECTION_ENABLED     2
0220 
0221 /**
0222  * struct drm_mode_modeinfo - Display mode information.
0223  * @clock: pixel clock in kHz
0224  * @hdisplay: horizontal display size
0225  * @hsync_start: horizontal sync start
0226  * @hsync_end: horizontal sync end
0227  * @htotal: horizontal total size
0228  * @hskew: horizontal skew
0229  * @vdisplay: vertical display size
0230  * @vsync_start: vertical sync start
0231  * @vsync_end: vertical sync end
0232  * @vtotal: vertical total size
0233  * @vscan: vertical scan
0234  * @vrefresh: approximate vertical refresh rate in Hz
0235  * @flags: bitmask of misc. flags, see DRM_MODE_FLAG_* defines
0236  * @type: bitmask of type flags, see DRM_MODE_TYPE_* defines
0237  * @name: string describing the mode resolution
0238  *
0239  * This is the user-space API display mode information structure. For the
0240  * kernel version see struct drm_display_mode.
0241  */
0242 struct drm_mode_modeinfo {
0243     __u32 clock;
0244     __u16 hdisplay;
0245     __u16 hsync_start;
0246     __u16 hsync_end;
0247     __u16 htotal;
0248     __u16 hskew;
0249     __u16 vdisplay;
0250     __u16 vsync_start;
0251     __u16 vsync_end;
0252     __u16 vtotal;
0253     __u16 vscan;
0254 
0255     __u32 vrefresh;
0256 
0257     __u32 flags;
0258     __u32 type;
0259     char name[DRM_DISPLAY_MODE_LEN];
0260 };
0261 
0262 struct drm_mode_card_res {
0263     __u64 fb_id_ptr;
0264     __u64 crtc_id_ptr;
0265     __u64 connector_id_ptr;
0266     __u64 encoder_id_ptr;
0267     __u32 count_fbs;
0268     __u32 count_crtcs;
0269     __u32 count_connectors;
0270     __u32 count_encoders;
0271     __u32 min_width;
0272     __u32 max_width;
0273     __u32 min_height;
0274     __u32 max_height;
0275 };
0276 
0277 struct drm_mode_crtc {
0278     __u64 set_connectors_ptr;
0279     __u32 count_connectors;
0280 
0281     __u32 crtc_id; /**< Id */
0282     __u32 fb_id; /**< Id of framebuffer */
0283 
0284     __u32 x; /**< x Position on the framebuffer */
0285     __u32 y; /**< y Position on the framebuffer */
0286 
0287     __u32 gamma_size;
0288     __u32 mode_valid;
0289     struct drm_mode_modeinfo mode;
0290 };
0291 
0292 #define DRM_MODE_PRESENT_TOP_FIELD  (1<<0)
0293 #define DRM_MODE_PRESENT_BOTTOM_FIELD   (1<<1)
0294 
0295 /* Planes blend with or override other bits on the CRTC */
0296 struct drm_mode_set_plane {
0297     __u32 plane_id;
0298     __u32 crtc_id;
0299     __u32 fb_id; /* fb object contains surface format type */
0300     __u32 flags; /* see above flags */
0301 
0302     /* Signed dest location allows it to be partially off screen */
0303     __s32 crtc_x;
0304     __s32 crtc_y;
0305     __u32 crtc_w;
0306     __u32 crtc_h;
0307 
0308     /* Source values are 16.16 fixed point */
0309     __u32 src_x;
0310     __u32 src_y;
0311     __u32 src_h;
0312     __u32 src_w;
0313 };
0314 
0315 /**
0316  * struct drm_mode_get_plane - Get plane metadata.
0317  *
0318  * Userspace can perform a GETPLANE ioctl to retrieve information about a
0319  * plane.
0320  *
0321  * To retrieve the number of formats supported, set @count_format_types to zero
0322  * and call the ioctl. @count_format_types will be updated with the value.
0323  *
0324  * To retrieve these formats, allocate an array with the memory needed to store
0325  * @count_format_types formats. Point @format_type_ptr to this array and call
0326  * the ioctl again (with @count_format_types still set to the value returned in
0327  * the first ioctl call).
0328  */
0329 struct drm_mode_get_plane {
0330     /**
0331      * @plane_id: Object ID of the plane whose information should be
0332      * retrieved. Set by caller.
0333      */
0334     __u32 plane_id;
0335 
0336     /** @crtc_id: Object ID of the current CRTC. */
0337     __u32 crtc_id;
0338     /** @fb_id: Object ID of the current fb. */
0339     __u32 fb_id;
0340 
0341     /**
0342      * @possible_crtcs: Bitmask of CRTC's compatible with the plane. CRTC's
0343      * are created and they receive an index, which corresponds to their
0344      * position in the bitmask. Bit N corresponds to
0345      * :ref:`CRTC index<crtc_index>` N.
0346      */
0347     __u32 possible_crtcs;
0348     /** @gamma_size: Never used. */
0349     __u32 gamma_size;
0350 
0351     /** @count_format_types: Number of formats. */
0352     __u32 count_format_types;
0353     /**
0354      * @format_type_ptr: Pointer to ``__u32`` array of formats that are
0355      * supported by the plane. These formats do not require modifiers.
0356      */
0357     __u64 format_type_ptr;
0358 };
0359 
0360 struct drm_mode_get_plane_res {
0361     __u64 plane_id_ptr;
0362     __u32 count_planes;
0363 };
0364 
0365 #define DRM_MODE_ENCODER_NONE   0
0366 #define DRM_MODE_ENCODER_DAC    1
0367 #define DRM_MODE_ENCODER_TMDS   2
0368 #define DRM_MODE_ENCODER_LVDS   3
0369 #define DRM_MODE_ENCODER_TVDAC  4
0370 #define DRM_MODE_ENCODER_VIRTUAL 5
0371 #define DRM_MODE_ENCODER_DSI    6
0372 #define DRM_MODE_ENCODER_DPMST  7
0373 #define DRM_MODE_ENCODER_DPI    8
0374 
0375 struct drm_mode_get_encoder {
0376     __u32 encoder_id;
0377     __u32 encoder_type;
0378 
0379     __u32 crtc_id; /**< Id of crtc */
0380 
0381     __u32 possible_crtcs;
0382     __u32 possible_clones;
0383 };
0384 
0385 /* This is for connectors with multiple signal types. */
0386 /* Try to match DRM_MODE_CONNECTOR_X as closely as possible. */
0387 enum drm_mode_subconnector {
0388     DRM_MODE_SUBCONNECTOR_Automatic   = 0,  /* DVI-I, TV     */
0389     DRM_MODE_SUBCONNECTOR_Unknown     = 0,  /* DVI-I, TV, DP */
0390     DRM_MODE_SUBCONNECTOR_VGA     = 1,  /*            DP */
0391     DRM_MODE_SUBCONNECTOR_DVID    = 3,  /* DVI-I      DP */
0392     DRM_MODE_SUBCONNECTOR_DVIA    = 4,  /* DVI-I         */
0393     DRM_MODE_SUBCONNECTOR_Composite   = 5,  /*        TV     */
0394     DRM_MODE_SUBCONNECTOR_SVIDEO      = 6,  /*        TV     */
0395     DRM_MODE_SUBCONNECTOR_Component   = 8,  /*        TV     */
0396     DRM_MODE_SUBCONNECTOR_SCART   = 9,  /*        TV     */
0397     DRM_MODE_SUBCONNECTOR_DisplayPort = 10, /*            DP */
0398     DRM_MODE_SUBCONNECTOR_HDMIA       = 11, /*            DP */
0399     DRM_MODE_SUBCONNECTOR_Native      = 15, /*            DP */
0400     DRM_MODE_SUBCONNECTOR_Wireless    = 18, /*            DP */
0401 };
0402 
0403 #define DRM_MODE_CONNECTOR_Unknown  0
0404 #define DRM_MODE_CONNECTOR_VGA      1
0405 #define DRM_MODE_CONNECTOR_DVII     2
0406 #define DRM_MODE_CONNECTOR_DVID     3
0407 #define DRM_MODE_CONNECTOR_DVIA     4
0408 #define DRM_MODE_CONNECTOR_Composite    5
0409 #define DRM_MODE_CONNECTOR_SVIDEO   6
0410 #define DRM_MODE_CONNECTOR_LVDS     7
0411 #define DRM_MODE_CONNECTOR_Component    8
0412 #define DRM_MODE_CONNECTOR_9PinDIN  9
0413 #define DRM_MODE_CONNECTOR_DisplayPort  10
0414 #define DRM_MODE_CONNECTOR_HDMIA    11
0415 #define DRM_MODE_CONNECTOR_HDMIB    12
0416 #define DRM_MODE_CONNECTOR_TV       13
0417 #define DRM_MODE_CONNECTOR_eDP      14
0418 #define DRM_MODE_CONNECTOR_VIRTUAL      15
0419 #define DRM_MODE_CONNECTOR_DSI      16
0420 #define DRM_MODE_CONNECTOR_DPI      17
0421 #define DRM_MODE_CONNECTOR_WRITEBACK    18
0422 #define DRM_MODE_CONNECTOR_SPI      19
0423 #define DRM_MODE_CONNECTOR_USB      20
0424 
0425 /**
0426  * struct drm_mode_get_connector - Get connector metadata.
0427  *
0428  * User-space can perform a GETCONNECTOR ioctl to retrieve information about a
0429  * connector. User-space is expected to retrieve encoders, modes and properties
0430  * by performing this ioctl at least twice: the first time to retrieve the
0431  * number of elements, the second time to retrieve the elements themselves.
0432  *
0433  * To retrieve the number of elements, set @count_props and @count_encoders to
0434  * zero, set @count_modes to 1, and set @modes_ptr to a temporary struct
0435  * drm_mode_modeinfo element.
0436  *
0437  * To retrieve the elements, allocate arrays for @encoders_ptr, @modes_ptr,
0438  * @props_ptr and @prop_values_ptr, then set @count_modes, @count_props and
0439  * @count_encoders to their capacity.
0440  *
0441  * Performing the ioctl only twice may be racy: the number of elements may have
0442  * changed with a hotplug event in-between the two ioctls. User-space is
0443  * expected to retry the last ioctl until the number of elements stabilizes.
0444  * The kernel won't fill any array which doesn't have the expected length.
0445  *
0446  * **Force-probing a connector**
0447  *
0448  * If the @count_modes field is set to zero and the DRM client is the current
0449  * DRM master, the kernel will perform a forced probe on the connector to
0450  * refresh the connector status, modes and EDID. A forced-probe can be slow,
0451  * might cause flickering and the ioctl will block.
0452  *
0453  * User-space needs to force-probe connectors to ensure their metadata is
0454  * up-to-date at startup and after receiving a hot-plug event. User-space
0455  * may perform a forced-probe when the user explicitly requests it. User-space
0456  * shouldn't perform a forced-probe in other situations.
0457  */
0458 struct drm_mode_get_connector {
0459     /** @encoders_ptr: Pointer to ``__u32`` array of object IDs. */
0460     __u64 encoders_ptr;
0461     /** @modes_ptr: Pointer to struct drm_mode_modeinfo array. */
0462     __u64 modes_ptr;
0463     /** @props_ptr: Pointer to ``__u32`` array of property IDs. */
0464     __u64 props_ptr;
0465     /** @prop_values_ptr: Pointer to ``__u64`` array of property values. */
0466     __u64 prop_values_ptr;
0467 
0468     /** @count_modes: Number of modes. */
0469     __u32 count_modes;
0470     /** @count_props: Number of properties. */
0471     __u32 count_props;
0472     /** @count_encoders: Number of encoders. */
0473     __u32 count_encoders;
0474 
0475     /** @encoder_id: Object ID of the current encoder. */
0476     __u32 encoder_id;
0477     /** @connector_id: Object ID of the connector. */
0478     __u32 connector_id;
0479     /**
0480      * @connector_type: Type of the connector.
0481      *
0482      * See DRM_MODE_CONNECTOR_* defines.
0483      */
0484     __u32 connector_type;
0485     /**
0486      * @connector_type_id: Type-specific connector number.
0487      *
0488      * This is not an object ID. This is a per-type connector number. Each
0489      * (type, type_id) combination is unique across all connectors of a DRM
0490      * device.
0491      *
0492      * The (type, type_id) combination is not a stable identifier: the
0493      * type_id can change depending on the driver probe order.
0494      */
0495     __u32 connector_type_id;
0496 
0497     /**
0498      * @connection: Status of the connector.
0499      *
0500      * See enum drm_connector_status.
0501      */
0502     __u32 connection;
0503     /** @mm_width: Width of the connected sink in millimeters. */
0504     __u32 mm_width;
0505     /** @mm_height: Height of the connected sink in millimeters. */
0506     __u32 mm_height;
0507     /**
0508      * @subpixel: Subpixel order of the connected sink.
0509      *
0510      * See enum subpixel_order.
0511      */
0512     __u32 subpixel;
0513 
0514     /** @pad: Padding, must be zero. */
0515     __u32 pad;
0516 };
0517 
0518 #define DRM_MODE_PROP_PENDING   (1<<0) /* deprecated, do not use */
0519 #define DRM_MODE_PROP_RANGE (1<<1)
0520 #define DRM_MODE_PROP_IMMUTABLE (1<<2)
0521 #define DRM_MODE_PROP_ENUM  (1<<3) /* enumerated type with text strings */
0522 #define DRM_MODE_PROP_BLOB  (1<<4)
0523 #define DRM_MODE_PROP_BITMASK   (1<<5) /* bitmask of enumerated types */
0524 
0525 /* non-extended types: legacy bitmask, one bit per type: */
0526 #define DRM_MODE_PROP_LEGACY_TYPE  ( \
0527         DRM_MODE_PROP_RANGE | \
0528         DRM_MODE_PROP_ENUM | \
0529         DRM_MODE_PROP_BLOB | \
0530         DRM_MODE_PROP_BITMASK)
0531 
0532 /* extended-types: rather than continue to consume a bit per type,
0533  * grab a chunk of the bits to use as integer type id.
0534  */
0535 #define DRM_MODE_PROP_EXTENDED_TYPE 0x0000ffc0
0536 #define DRM_MODE_PROP_TYPE(n)       ((n) << 6)
0537 #define DRM_MODE_PROP_OBJECT        DRM_MODE_PROP_TYPE(1)
0538 #define DRM_MODE_PROP_SIGNED_RANGE  DRM_MODE_PROP_TYPE(2)
0539 
0540 /* the PROP_ATOMIC flag is used to hide properties from userspace that
0541  * is not aware of atomic properties.  This is mostly to work around
0542  * older userspace (DDX drivers) that read/write each prop they find,
0543  * without being aware that this could be triggering a lengthy modeset.
0544  */
0545 #define DRM_MODE_PROP_ATOMIC        0x80000000
0546 
0547 /**
0548  * struct drm_mode_property_enum - Description for an enum/bitfield entry.
0549  * @value: numeric value for this enum entry.
0550  * @name: symbolic name for this enum entry.
0551  *
0552  * See struct drm_property_enum for details.
0553  */
0554 struct drm_mode_property_enum {
0555     __u64 value;
0556     char name[DRM_PROP_NAME_LEN];
0557 };
0558 
0559 /**
0560  * struct drm_mode_get_property - Get property metadata.
0561  *
0562  * User-space can perform a GETPROPERTY ioctl to retrieve information about a
0563  * property. The same property may be attached to multiple objects, see
0564  * "Modeset Base Object Abstraction".
0565  *
0566  * The meaning of the @values_ptr field changes depending on the property type.
0567  * See &drm_property.flags for more details.
0568  *
0569  * The @enum_blob_ptr and @count_enum_blobs fields are only meaningful when the
0570  * property has the type &DRM_MODE_PROP_ENUM or &DRM_MODE_PROP_BITMASK. For
0571  * backwards compatibility, the kernel will always set @count_enum_blobs to
0572  * zero when the property has the type &DRM_MODE_PROP_BLOB. User-space must
0573  * ignore these two fields if the property has a different type.
0574  *
0575  * User-space is expected to retrieve values and enums by performing this ioctl
0576  * at least twice: the first time to retrieve the number of elements, the
0577  * second time to retrieve the elements themselves.
0578  *
0579  * To retrieve the number of elements, set @count_values and @count_enum_blobs
0580  * to zero, then call the ioctl. @count_values will be updated with the number
0581  * of elements. If the property has the type &DRM_MODE_PROP_ENUM or
0582  * &DRM_MODE_PROP_BITMASK, @count_enum_blobs will be updated as well.
0583  *
0584  * To retrieve the elements themselves, allocate an array for @values_ptr and
0585  * set @count_values to its capacity. If the property has the type
0586  * &DRM_MODE_PROP_ENUM or &DRM_MODE_PROP_BITMASK, allocate an array for
0587  * @enum_blob_ptr and set @count_enum_blobs to its capacity. Calling the ioctl
0588  * again will fill the arrays.
0589  */
0590 struct drm_mode_get_property {
0591     /** @values_ptr: Pointer to a ``__u64`` array. */
0592     __u64 values_ptr;
0593     /** @enum_blob_ptr: Pointer to a struct drm_mode_property_enum array. */
0594     __u64 enum_blob_ptr;
0595 
0596     /**
0597      * @prop_id: Object ID of the property which should be retrieved. Set
0598      * by the caller.
0599      */
0600     __u32 prop_id;
0601     /**
0602      * @flags: ``DRM_MODE_PROP_*`` bitfield. See &drm_property.flags for
0603      * a definition of the flags.
0604      */
0605     __u32 flags;
0606     /**
0607      * @name: Symbolic property name. User-space should use this field to
0608      * recognize properties.
0609      */
0610     char name[DRM_PROP_NAME_LEN];
0611 
0612     /** @count_values: Number of elements in @values_ptr. */
0613     __u32 count_values;
0614     /** @count_enum_blobs: Number of elements in @enum_blob_ptr. */
0615     __u32 count_enum_blobs;
0616 };
0617 
0618 struct drm_mode_connector_set_property {
0619     __u64 value;
0620     __u32 prop_id;
0621     __u32 connector_id;
0622 };
0623 
0624 #define DRM_MODE_OBJECT_CRTC 0xcccccccc
0625 #define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
0626 #define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
0627 #define DRM_MODE_OBJECT_MODE 0xdededede
0628 #define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
0629 #define DRM_MODE_OBJECT_FB 0xfbfbfbfb
0630 #define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
0631 #define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
0632 #define DRM_MODE_OBJECT_ANY 0
0633 
0634 struct drm_mode_obj_get_properties {
0635     __u64 props_ptr;
0636     __u64 prop_values_ptr;
0637     __u32 count_props;
0638     __u32 obj_id;
0639     __u32 obj_type;
0640 };
0641 
0642 struct drm_mode_obj_set_property {
0643     __u64 value;
0644     __u32 prop_id;
0645     __u32 obj_id;
0646     __u32 obj_type;
0647 };
0648 
0649 struct drm_mode_get_blob {
0650     __u32 blob_id;
0651     __u32 length;
0652     __u64 data;
0653 };
0654 
0655 struct drm_mode_fb_cmd {
0656     __u32 fb_id;
0657     __u32 width;
0658     __u32 height;
0659     __u32 pitch;
0660     __u32 bpp;
0661     __u32 depth;
0662     /* driver specific handle */
0663     __u32 handle;
0664 };
0665 
0666 #define DRM_MODE_FB_INTERLACED  (1<<0) /* for interlaced framebuffers */
0667 #define DRM_MODE_FB_MODIFIERS   (1<<1) /* enables ->modifier[] */
0668 
0669 /**
0670  * struct drm_mode_fb_cmd2 - Frame-buffer metadata.
0671  *
0672  * This struct holds frame-buffer metadata. There are two ways to use it:
0673  *
0674  * - User-space can fill this struct and perform a &DRM_IOCTL_MODE_ADDFB2
0675  *   ioctl to register a new frame-buffer. The new frame-buffer object ID will
0676  *   be set by the kernel in @fb_id.
0677  * - User-space can set @fb_id and perform a &DRM_IOCTL_MODE_GETFB2 ioctl to
0678  *   fetch metadata about an existing frame-buffer.
0679  *
0680  * In case of planar formats, this struct allows up to 4 buffer objects with
0681  * offsets and pitches per plane. The pitch and offset order are dictated by
0682  * the format FourCC as defined by ``drm_fourcc.h``, e.g. NV12 is described as:
0683  *
0684  *     YUV 4:2:0 image with a plane of 8-bit Y samples followed by an
0685  *     interleaved U/V plane containing 8-bit 2x2 subsampled colour difference
0686  *     samples.
0687  *
0688  * So it would consist of a Y plane at ``offsets[0]`` and a UV plane at
0689  * ``offsets[1]``.
0690  *
0691  * To accommodate tiled, compressed, etc formats, a modifier can be specified.
0692  * For more information see the "Format Modifiers" section. Note that even
0693  * though it looks like we have a modifier per-plane, we in fact do not. The
0694  * modifier for each plane must be identical. Thus all combinations of
0695  * different data layouts for multi-plane formats must be enumerated as
0696  * separate modifiers.
0697  *
0698  * All of the entries in @handles, @pitches, @offsets and @modifier must be
0699  * zero when unused. Warning, for @offsets and @modifier zero can't be used to
0700  * figure out whether the entry is used or not since it's a valid value (a zero
0701  * offset is common, and a zero modifier is &DRM_FORMAT_MOD_LINEAR).
0702  */
0703 struct drm_mode_fb_cmd2 {
0704     /** @fb_id: Object ID of the frame-buffer. */
0705     __u32 fb_id;
0706     /** @width: Width of the frame-buffer. */
0707     __u32 width;
0708     /** @height: Height of the frame-buffer. */
0709     __u32 height;
0710     /**
0711      * @pixel_format: FourCC format code, see ``DRM_FORMAT_*`` constants in
0712      * ``drm_fourcc.h``.
0713      */
0714     __u32 pixel_format;
0715     /**
0716      * @flags: Frame-buffer flags (see &DRM_MODE_FB_INTERLACED and
0717      * &DRM_MODE_FB_MODIFIERS).
0718      */
0719     __u32 flags;
0720 
0721     /**
0722      * @handles: GEM buffer handle, one per plane. Set to 0 if the plane is
0723      * unused. The same handle can be used for multiple planes.
0724      */
0725     __u32 handles[4];
0726     /** @pitches: Pitch (aka. stride) in bytes, one per plane. */
0727     __u32 pitches[4];
0728     /** @offsets: Offset into the buffer in bytes, one per plane. */
0729     __u32 offsets[4];
0730     /**
0731      * @modifier: Format modifier, one per plane. See ``DRM_FORMAT_MOD_*``
0732      * constants in ``drm_fourcc.h``. All planes must use the same
0733      * modifier. Ignored unless &DRM_MODE_FB_MODIFIERS is set in @flags.
0734      */
0735     __u64 modifier[4];
0736 };
0737 
0738 #define DRM_MODE_FB_DIRTY_ANNOTATE_COPY 0x01
0739 #define DRM_MODE_FB_DIRTY_ANNOTATE_FILL 0x02
0740 #define DRM_MODE_FB_DIRTY_FLAGS         0x03
0741 
0742 #define DRM_MODE_FB_DIRTY_MAX_CLIPS     256
0743 
0744 /*
0745  * Mark a region of a framebuffer as dirty.
0746  *
0747  * Some hardware does not automatically update display contents
0748  * as a hardware or software draw to a framebuffer. This ioctl
0749  * allows userspace to tell the kernel and the hardware what
0750  * regions of the framebuffer have changed.
0751  *
0752  * The kernel or hardware is free to update more then just the
0753  * region specified by the clip rects. The kernel or hardware
0754  * may also delay and/or coalesce several calls to dirty into a
0755  * single update.
0756  *
0757  * Userspace may annotate the updates, the annotates are a
0758  * promise made by the caller that the change is either a copy
0759  * of pixels or a fill of a single color in the region specified.
0760  *
0761  * If the DRM_MODE_FB_DIRTY_ANNOTATE_COPY flag is given then
0762  * the number of updated regions are half of num_clips given,
0763  * where the clip rects are paired in src and dst. The width and
0764  * height of each one of the pairs must match.
0765  *
0766  * If the DRM_MODE_FB_DIRTY_ANNOTATE_FILL flag is given the caller
0767  * promises that the region specified of the clip rects is filled
0768  * completely with a single color as given in the color argument.
0769  */
0770 
0771 struct drm_mode_fb_dirty_cmd {
0772     __u32 fb_id;
0773     __u32 flags;
0774     __u32 color;
0775     __u32 num_clips;
0776     __u64 clips_ptr;
0777 };
0778 
0779 struct drm_mode_mode_cmd {
0780     __u32 connector_id;
0781     struct drm_mode_modeinfo mode;
0782 };
0783 
0784 #define DRM_MODE_CURSOR_BO  0x01
0785 #define DRM_MODE_CURSOR_MOVE    0x02
0786 #define DRM_MODE_CURSOR_FLAGS   0x03
0787 
0788 /*
0789  * depending on the value in flags different members are used.
0790  *
0791  * CURSOR_BO uses
0792  *    crtc_id
0793  *    width
0794  *    height
0795  *    handle - if 0 turns the cursor off
0796  *
0797  * CURSOR_MOVE uses
0798  *    crtc_id
0799  *    x
0800  *    y
0801  */
0802 struct drm_mode_cursor {
0803     __u32 flags;
0804     __u32 crtc_id;
0805     __s32 x;
0806     __s32 y;
0807     __u32 width;
0808     __u32 height;
0809     /* driver specific handle */
0810     __u32 handle;
0811 };
0812 
0813 struct drm_mode_cursor2 {
0814     __u32 flags;
0815     __u32 crtc_id;
0816     __s32 x;
0817     __s32 y;
0818     __u32 width;
0819     __u32 height;
0820     /* driver specific handle */
0821     __u32 handle;
0822     __s32 hot_x;
0823     __s32 hot_y;
0824 };
0825 
0826 struct drm_mode_crtc_lut {
0827     __u32 crtc_id;
0828     __u32 gamma_size;
0829 
0830     /* pointers to arrays */
0831     __u64 red;
0832     __u64 green;
0833     __u64 blue;
0834 };
0835 
0836 struct drm_color_ctm {
0837     /*
0838      * Conversion matrix in S31.32 sign-magnitude
0839      * (not two's complement!) format.
0840      *
0841      * out   matrix    in
0842      * |R|   |0 1 2|   |R|
0843      * |G| = |3 4 5| x |G|
0844      * |B|   |6 7 8|   |B|
0845      */
0846     __u64 matrix[9];
0847 };
0848 
0849 struct drm_color_lut {
0850     /*
0851      * Values are mapped linearly to 0.0 - 1.0 range, with 0x0 == 0.0 and
0852      * 0xffff == 1.0.
0853      */
0854     __u16 red;
0855     __u16 green;
0856     __u16 blue;
0857     __u16 reserved;
0858 };
0859 
0860 /**
0861  * struct drm_plane_size_hint - Plane size hints
0862  *
0863  * The plane SIZE_HINTS property blob contains an
0864  * array of struct drm_plane_size_hint.
0865  */
0866 struct drm_plane_size_hint {
0867     __u16 width;
0868     __u16 height;
0869 };
0870 
0871 /**
0872  * struct hdr_metadata_infoframe - HDR Metadata Infoframe Data.
0873  *
0874  * HDR Metadata Infoframe as per CTA 861.G spec. This is expected
0875  * to match exactly with the spec.
0876  *
0877  * Userspace is expected to pass the metadata information as per
0878  * the format described in this structure.
0879  */
0880 struct hdr_metadata_infoframe {
0881     /**
0882      * @eotf: Electro-Optical Transfer Function (EOTF)
0883      * used in the stream.
0884      */
0885     __u8 eotf;
0886     /**
0887      * @metadata_type: Static_Metadata_Descriptor_ID.
0888      */
0889     __u8 metadata_type;
0890     /**
0891      * @display_primaries: Color Primaries of the Data.
0892      * These are coded as unsigned 16-bit values in units of
0893      * 0.00002, where 0x0000 represents zero and 0xC350
0894      * represents 1.0000.
0895      * @display_primaries.x: X coordinate of color primary.
0896      * @display_primaries.y: Y coordinate of color primary.
0897      */
0898     struct {
0899         __u16 x, y;
0900     } display_primaries[3];
0901     /**
0902      * @white_point: White Point of Colorspace Data.
0903      * These are coded as unsigned 16-bit values in units of
0904      * 0.00002, where 0x0000 represents zero and 0xC350
0905      * represents 1.0000.
0906      * @white_point.x: X coordinate of whitepoint of color primary.
0907      * @white_point.y: Y coordinate of whitepoint of color primary.
0908      */
0909     struct {
0910         __u16 x, y;
0911     } white_point;
0912     /**
0913      * @max_display_mastering_luminance: Max Mastering Display Luminance.
0914      * This value is coded as an unsigned 16-bit value in units of 1 cd/m2,
0915      * where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2.
0916      */
0917     __u16 max_display_mastering_luminance;
0918     /**
0919      * @min_display_mastering_luminance: Min Mastering Display Luminance.
0920      * This value is coded as an unsigned 16-bit value in units of
0921      * 0.0001 cd/m2, where 0x0001 represents 0.0001 cd/m2 and 0xFFFF
0922      * represents 6.5535 cd/m2.
0923      */
0924     __u16 min_display_mastering_luminance;
0925     /**
0926      * @max_cll: Max Content Light Level.
0927      * This value is coded as an unsigned 16-bit value in units of 1 cd/m2,
0928      * where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2.
0929      */
0930     __u16 max_cll;
0931     /**
0932      * @max_fall: Max Frame Average Light Level.
0933      * This value is coded as an unsigned 16-bit value in units of 1 cd/m2,
0934      * where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2.
0935      */
0936     __u16 max_fall;
0937 };
0938 
0939 /**
0940  * struct hdr_output_metadata - HDR output metadata
0941  *
0942  * Metadata Information to be passed from userspace
0943  */
0944 struct hdr_output_metadata {
0945     /**
0946      * @metadata_type: Static_Metadata_Descriptor_ID.
0947      */
0948     __u32 metadata_type;
0949     /**
0950      * @hdmi_metadata_type1: HDR Metadata Infoframe.
0951      */
0952     union {
0953         struct hdr_metadata_infoframe hdmi_metadata_type1;
0954     };
0955 };
0956 
0957 /**
0958  * DRM_MODE_PAGE_FLIP_EVENT
0959  *
0960  * Request that the kernel sends back a vblank event (see
0961  * struct drm_event_vblank) with the &DRM_EVENT_FLIP_COMPLETE type when the
0962  * page-flip is done.
0963  */
0964 #define DRM_MODE_PAGE_FLIP_EVENT 0x01
0965 /**
0966  * DRM_MODE_PAGE_FLIP_ASYNC
0967  *
0968  * Request that the page-flip is performed as soon as possible, ie. with no
0969  * delay due to waiting for vblank. This may cause tearing to be visible on
0970  * the screen.
0971  *
0972  * When used with atomic uAPI, the driver will return an error if the hardware
0973  * doesn't support performing an asynchronous page-flip for this update.
0974  * User-space should handle this, e.g. by falling back to a regular page-flip.
0975  *
0976  * Note, some hardware might need to perform one last synchronous page-flip
0977  * before being able to switch to asynchronous page-flips. As an exception,
0978  * the driver will return success even though that first page-flip is not
0979  * asynchronous.
0980  */
0981 #define DRM_MODE_PAGE_FLIP_ASYNC 0x02
0982 #define DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE 0x4
0983 #define DRM_MODE_PAGE_FLIP_TARGET_RELATIVE 0x8
0984 #define DRM_MODE_PAGE_FLIP_TARGET (DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE | \
0985                    DRM_MODE_PAGE_FLIP_TARGET_RELATIVE)
0986 /**
0987  * DRM_MODE_PAGE_FLIP_FLAGS
0988  *
0989  * Bitmask of flags suitable for &drm_mode_crtc_page_flip_target.flags.
0990  */
0991 #define DRM_MODE_PAGE_FLIP_FLAGS (DRM_MODE_PAGE_FLIP_EVENT | \
0992                   DRM_MODE_PAGE_FLIP_ASYNC | \
0993                   DRM_MODE_PAGE_FLIP_TARGET)
0994 
0995 /*
0996  * Request a page flip on the specified crtc.
0997  *
0998  * This ioctl will ask KMS to schedule a page flip for the specified
0999  * crtc.  Once any pending rendering targeting the specified fb (as of
1000  * ioctl time) has completed, the crtc will be reprogrammed to display
1001  * that fb after the next vertical refresh.  The ioctl returns
1002  * immediately, but subsequent rendering to the current fb will block
1003  * in the execbuffer ioctl until the page flip happens.  If a page
1004  * flip is already pending as the ioctl is called, EBUSY will be
1005  * returned.
1006  *
1007  * Flag DRM_MODE_PAGE_FLIP_EVENT requests that drm sends back a vblank
1008  * event (see drm.h: struct drm_event_vblank) when the page flip is
1009  * done.  The user_data field passed in with this ioctl will be
1010  * returned as the user_data field in the vblank event struct.
1011  *
1012  * Flag DRM_MODE_PAGE_FLIP_ASYNC requests that the flip happen
1013  * 'as soon as possible', meaning that it not delay waiting for vblank.
1014  * This may cause tearing on the screen.
1015  *
1016  * The reserved field must be zero.
1017  */
1018 
1019 struct drm_mode_crtc_page_flip {
1020     __u32 crtc_id;
1021     __u32 fb_id;
1022     __u32 flags;
1023     __u32 reserved;
1024     __u64 user_data;
1025 };
1026 
1027 /*
1028  * Request a page flip on the specified crtc.
1029  *
1030  * Same as struct drm_mode_crtc_page_flip, but supports new flags and
1031  * re-purposes the reserved field:
1032  *
1033  * The sequence field must be zero unless either of the
1034  * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is specified. When
1035  * the ABSOLUTE flag is specified, the sequence field denotes the absolute
1036  * vblank sequence when the flip should take effect. When the RELATIVE
1037  * flag is specified, the sequence field denotes the relative (to the
1038  * current one when the ioctl is called) vblank sequence when the flip
1039  * should take effect. NOTE: DRM_IOCTL_WAIT_VBLANK must still be used to
1040  * make sure the vblank sequence before the target one has passed before
1041  * calling this ioctl. The purpose of the
1042  * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is merely to clarify
1043  * the target for when code dealing with a page flip runs during a
1044  * vertical blank period.
1045  */
1046 
1047 struct drm_mode_crtc_page_flip_target {
1048     __u32 crtc_id;
1049     __u32 fb_id;
1050     __u32 flags;
1051     __u32 sequence;
1052     __u64 user_data;
1053 };
1054 
1055 /**
1056  * struct drm_mode_create_dumb - Create a KMS dumb buffer for scanout.
1057  * @height: buffer height in pixels
1058  * @width: buffer width in pixels
1059  * @bpp: bits per pixel
1060  * @flags: must be zero
1061  * @handle: buffer object handle
1062  * @pitch: number of bytes between two consecutive lines
1063  * @size: size of the whole buffer in bytes
1064  *
1065  * User-space fills @height, @width, @bpp and @flags. If the IOCTL succeeds,
1066  * the kernel fills @handle, @pitch and @size.
1067  */
1068 struct drm_mode_create_dumb {
1069     __u32 height;
1070     __u32 width;
1071     __u32 bpp;
1072     __u32 flags;
1073 
1074     __u32 handle;
1075     __u32 pitch;
1076     __u64 size;
1077 };
1078 
1079 /* set up for mmap of a dumb scanout buffer */
1080 struct drm_mode_map_dumb {
1081     /** Handle for the object being mapped. */
1082     __u32 handle;
1083     __u32 pad;
1084     /**
1085      * Fake offset to use for subsequent mmap call
1086      *
1087      * This is a fixed-size type for 32/64 compatibility.
1088      */
1089     __u64 offset;
1090 };
1091 
1092 struct drm_mode_destroy_dumb {
1093     __u32 handle;
1094 };
1095 
1096 /**
1097  * DRM_MODE_ATOMIC_TEST_ONLY
1098  *
1099  * Do not apply the atomic commit, instead check whether the hardware supports
1100  * this configuration.
1101  *
1102  * See &drm_mode_config_funcs.atomic_check for more details on test-only
1103  * commits.
1104  */
1105 #define DRM_MODE_ATOMIC_TEST_ONLY 0x0100
1106 /**
1107  * DRM_MODE_ATOMIC_NONBLOCK
1108  *
1109  * Do not block while applying the atomic commit. The &DRM_IOCTL_MODE_ATOMIC
1110  * IOCTL returns immediately instead of waiting for the changes to be applied
1111  * in hardware. Note, the driver will still check that the update can be
1112  * applied before retuning.
1113  */
1114 #define DRM_MODE_ATOMIC_NONBLOCK  0x0200
1115 /**
1116  * DRM_MODE_ATOMIC_ALLOW_MODESET
1117  *
1118  * Allow the update to result in temporary or transient visible artifacts while
1119  * the update is being applied. Applying the update may also take significantly
1120  * more time than a page flip. All visual artifacts will disappear by the time
1121  * the update is completed, as signalled through the vblank event's timestamp
1122  * (see struct drm_event_vblank).
1123  *
1124  * This flag must be set when the KMS update might cause visible artifacts.
1125  * Without this flag such KMS update will return a EINVAL error. What kind of
1126  * update may cause visible artifacts depends on the driver and the hardware.
1127  * User-space that needs to know beforehand if an update might cause visible
1128  * artifacts can use &DRM_MODE_ATOMIC_TEST_ONLY without
1129  * &DRM_MODE_ATOMIC_ALLOW_MODESET to see if it fails.
1130  *
1131  * To the best of the driver's knowledge, visual artifacts are guaranteed to
1132  * not appear when this flag is not set. Some sinks might display visual
1133  * artifacts outside of the driver's control.
1134  */
1135 #define DRM_MODE_ATOMIC_ALLOW_MODESET 0x0400
1136 
1137 /**
1138  * DRM_MODE_ATOMIC_FLAGS
1139  *
1140  * Bitfield of flags accepted by the &DRM_IOCTL_MODE_ATOMIC IOCTL in
1141  * &drm_mode_atomic.flags.
1142  */
1143 #define DRM_MODE_ATOMIC_FLAGS (\
1144         DRM_MODE_PAGE_FLIP_EVENT |\
1145         DRM_MODE_PAGE_FLIP_ASYNC |\
1146         DRM_MODE_ATOMIC_TEST_ONLY |\
1147         DRM_MODE_ATOMIC_NONBLOCK |\
1148         DRM_MODE_ATOMIC_ALLOW_MODESET)
1149 
1150 struct drm_mode_atomic {
1151     __u32 flags;
1152     __u32 count_objs;
1153     __u64 objs_ptr;
1154     __u64 count_props_ptr;
1155     __u64 props_ptr;
1156     __u64 prop_values_ptr;
1157     __u64 reserved;
1158     __u64 user_data;
1159 };
1160 
1161 struct drm_format_modifier_blob {
1162 #define FORMAT_BLOB_CURRENT 1
1163     /* Version of this blob format */
1164     __u32 version;
1165 
1166     /* Flags */
1167     __u32 flags;
1168 
1169     /* Number of fourcc formats supported */
1170     __u32 count_formats;
1171 
1172     /* Where in this blob the formats exist (in bytes) */
1173     __u32 formats_offset;
1174 
1175     /* Number of drm_format_modifiers */
1176     __u32 count_modifiers;
1177 
1178     /* Where in this blob the modifiers exist (in bytes) */
1179     __u32 modifiers_offset;
1180 
1181     /* __u32 formats[] */
1182     /* struct drm_format_modifier modifiers[] */
1183 };
1184 
1185 struct drm_format_modifier {
1186     /* Bitmask of formats in get_plane format list this info applies to. The
1187      * offset allows a sliding window of which 64 formats (bits).
1188      *
1189      * Some examples:
1190      * In today's world with < 65 formats, and formats 0, and 2 are
1191      * supported
1192      * 0x0000000000000005
1193      *        ^-offset = 0, formats = 5
1194      *
1195      * If the number formats grew to 128, and formats 98-102 are
1196      * supported with the modifier:
1197      *
1198      * 0x0000007c00000000 0000000000000000
1199      *        ^
1200      *        |__offset = 64, formats = 0x7c00000000
1201      *
1202      */
1203     __u64 formats;
1204     __u32 offset;
1205     __u32 pad;
1206 
1207     /* The modifier that applies to the >get_plane format list bitmask. */
1208     __u64 modifier;
1209 };
1210 
1211 /**
1212  * struct drm_mode_create_blob - Create New blob property
1213  *
1214  * Create a new 'blob' data property, copying length bytes from data pointer,
1215  * and returning new blob ID.
1216  */
1217 struct drm_mode_create_blob {
1218     /** @data: Pointer to data to copy. */
1219     __u64 data;
1220     /** @length: Length of data to copy. */
1221     __u32 length;
1222     /** @blob_id: Return: new property ID. */
1223     __u32 blob_id;
1224 };
1225 
1226 /**
1227  * struct drm_mode_destroy_blob - Destroy user blob
1228  * @blob_id: blob_id to destroy
1229  *
1230  * Destroy a user-created blob property.
1231  *
1232  * User-space can release blobs as soon as they do not need to refer to them by
1233  * their blob object ID.  For instance, if you are using a MODE_ID blob in an
1234  * atomic commit and you will not make another commit re-using the same ID, you
1235  * can destroy the blob as soon as the commit has been issued, without waiting
1236  * for it to complete.
1237  */
1238 struct drm_mode_destroy_blob {
1239     __u32 blob_id;
1240 };
1241 
1242 /**
1243  * struct drm_mode_create_lease - Create lease
1244  *
1245  * Lease mode resources, creating another drm_master.
1246  *
1247  * The @object_ids array must reference at least one CRTC, one connector and
1248  * one plane if &DRM_CLIENT_CAP_UNIVERSAL_PLANES is enabled. Alternatively,
1249  * the lease can be completely empty.
1250  */
1251 struct drm_mode_create_lease {
1252     /** @object_ids: Pointer to array of object ids (__u32) */
1253     __u64 object_ids;
1254     /** @object_count: Number of object ids */
1255     __u32 object_count;
1256     /** @flags: flags for new FD (O_CLOEXEC, etc) */
1257     __u32 flags;
1258 
1259     /** @lessee_id: Return: unique identifier for lessee. */
1260     __u32 lessee_id;
1261     /** @fd: Return: file descriptor to new drm_master file */
1262     __u32 fd;
1263 };
1264 
1265 /**
1266  * struct drm_mode_list_lessees - List lessees
1267  *
1268  * List lesses from a drm_master.
1269  */
1270 struct drm_mode_list_lessees {
1271     /**
1272      * @count_lessees: Number of lessees.
1273      *
1274      * On input, provides length of the array.
1275      * On output, provides total number. No
1276      * more than the input number will be written
1277      * back, so two calls can be used to get
1278      * the size and then the data.
1279      */
1280     __u32 count_lessees;
1281     /** @pad: Padding. */
1282     __u32 pad;
1283 
1284     /**
1285      * @lessees_ptr: Pointer to lessees.
1286      *
1287      * Pointer to __u64 array of lessee ids
1288      */
1289     __u64 lessees_ptr;
1290 };
1291 
1292 /**
1293  * struct drm_mode_get_lease - Get Lease
1294  *
1295  * Get leased objects.
1296  */
1297 struct drm_mode_get_lease {
1298     /**
1299      * @count_objects: Number of leased objects.
1300      *
1301      * On input, provides length of the array.
1302      * On output, provides total number. No
1303      * more than the input number will be written
1304      * back, so two calls can be used to get
1305      * the size and then the data.
1306      */
1307     __u32 count_objects;
1308     /** @pad: Padding. */
1309     __u32 pad;
1310 
1311     /**
1312      * @objects_ptr: Pointer to objects.
1313      *
1314      * Pointer to __u32 array of object ids.
1315      */
1316     __u64 objects_ptr;
1317 };
1318 
1319 /**
1320  * struct drm_mode_revoke_lease - Revoke lease
1321  */
1322 struct drm_mode_revoke_lease {
1323     /** @lessee_id: Unique ID of lessee */
1324     __u32 lessee_id;
1325 };
1326 
1327 /**
1328  * struct drm_mode_rect - Two dimensional rectangle.
1329  * @x1: Horizontal starting coordinate (inclusive).
1330  * @y1: Vertical starting coordinate (inclusive).
1331  * @x2: Horizontal ending coordinate (exclusive).
1332  * @y2: Vertical ending coordinate (exclusive).
1333  *
1334  * With drm subsystem using struct drm_rect to manage rectangular area this
1335  * export it to user-space.
1336  *
1337  * Currently used by drm_mode_atomic blob property FB_DAMAGE_CLIPS.
1338  */
1339 struct drm_mode_rect {
1340     __s32 x1;
1341     __s32 y1;
1342     __s32 x2;
1343     __s32 y2;
1344 };
1345 
1346 /**
1347  * struct drm_mode_closefb
1348  * @fb_id: Framebuffer ID.
1349  * @pad: Must be zero.
1350  */
1351 struct drm_mode_closefb {
1352     __u32 fb_id;
1353     __u32 pad;
1354 };
1355 
1356 #if defined(__cplusplus)
1357 }
1358 #endif
1359 
1360 #endif