Home | History | Annotate | Download | only in drm
      1 /*
      2  * Copyright (c) 2007 Dave Airlie <airlied (at) linux.ie>
      3  * Copyright (c) 2007 Jakob Bornecrantz <wallbraker (at) gmail.com>
      4  * Copyright (c) 2008 Red Hat Inc.
      5  * Copyright (c) 2007-2008 Tungsten Graphics, Inc., Cedar Park, TX., USA
      6  * Copyright (c) 2007-2008 Intel Corporation
      7  *
      8  * Permission is hereby granted, free of charge, to any person obtaining a
      9  * copy of this software and associated documentation files (the "Software"),
     10  * to deal in the Software without restriction, including without limitation
     11  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
     12  * and/or sell copies of the Software, and to permit persons to whom the
     13  * Software is furnished to do so, subject to the following conditions:
     14  *
     15  * The above copyright notice and this permission notice shall be included in
     16  * all copies or substantial portions of the Software.
     17  *
     18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
     19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
     20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
     21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
     22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
     23  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
     24  * IN THE SOFTWARE.
     25  */
     26 
     27 #ifndef _DRM_MODE_H
     28 #define _DRM_MODE_H
     29 
     30 #include "drm.h"
     31 
     32 #if defined(__cplusplus)
     33 extern "C" {
     34 #endif
     35 
     36 #define DRM_DISPLAY_INFO_LEN	32
     37 #define DRM_CONNECTOR_NAME_LEN	32
     38 #define DRM_DISPLAY_MODE_LEN	32
     39 #define DRM_PROP_NAME_LEN	32
     40 
     41 #define DRM_MODE_TYPE_BUILTIN	(1<<0) /* deprecated */
     42 #define DRM_MODE_TYPE_CLOCK_C	((1<<1) | DRM_MODE_TYPE_BUILTIN) /* deprecated */
     43 #define DRM_MODE_TYPE_CRTC_C	((1<<2) | DRM_MODE_TYPE_BUILTIN) /* deprecated */
     44 #define DRM_MODE_TYPE_PREFERRED	(1<<3)
     45 #define DRM_MODE_TYPE_DEFAULT	(1<<4) /* deprecated */
     46 #define DRM_MODE_TYPE_USERDEF	(1<<5)
     47 #define DRM_MODE_TYPE_DRIVER	(1<<6)
     48 
     49 /* Video mode flags */
     50 /* bit compatible with the xrandr RR_ definitions (bits 0-13)
     51  *
     52  * ABI warning: Existing userspace really expects
     53  * the mode flags to match the xrandr definitions. Any
     54  * changes that don't match the xrandr definitions will
     55  * likely need a new client cap or some other mechanism
     56  * to avoid breaking existing userspace. This includes
     57  * allocating new flags in the previously unused bits!
     58  */
     59 #define DRM_MODE_FLAG_PHSYNC			(1<<0)
     60 #define DRM_MODE_FLAG_NHSYNC			(1<<1)
     61 #define DRM_MODE_FLAG_PVSYNC			(1<<2)
     62 #define DRM_MODE_FLAG_NVSYNC			(1<<3)
     63 #define DRM_MODE_FLAG_INTERLACE			(1<<4)
     64 #define DRM_MODE_FLAG_DBLSCAN			(1<<5)
     65 #define DRM_MODE_FLAG_CSYNC			(1<<6)
     66 #define DRM_MODE_FLAG_PCSYNC			(1<<7)
     67 #define DRM_MODE_FLAG_NCSYNC			(1<<8)
     68 #define DRM_MODE_FLAG_HSKEW			(1<<9) /* hskew provided */
     69 #define DRM_MODE_FLAG_BCAST			(1<<10) /* deprecated */
     70 #define DRM_MODE_FLAG_PIXMUX			(1<<11) /* deprecated */
     71 #define DRM_MODE_FLAG_DBLCLK			(1<<12)
     72 #define DRM_MODE_FLAG_CLKDIV2			(1<<13)
     73  /*
     74   * When adding a new stereo mode don't forget to adjust DRM_MODE_FLAGS_3D_MAX
     75   * (define not exposed to user space).
     76   */
     77 #define DRM_MODE_FLAG_3D_MASK			(0x1f<<14)
     78 #define  DRM_MODE_FLAG_3D_NONE		(0<<14)
     79 #define  DRM_MODE_FLAG_3D_FRAME_PACKING		(1<<14)
     80 #define  DRM_MODE_FLAG_3D_FIELD_ALTERNATIVE	(2<<14)
     81 #define  DRM_MODE_FLAG_3D_LINE_ALTERNATIVE	(3<<14)
     82 #define  DRM_MODE_FLAG_3D_SIDE_BY_SIDE_FULL	(4<<14)
     83 #define  DRM_MODE_FLAG_3D_L_DEPTH		(5<<14)
     84 #define  DRM_MODE_FLAG_3D_L_DEPTH_GFX_GFX_DEPTH	(6<<14)
     85 #define  DRM_MODE_FLAG_3D_TOP_AND_BOTTOM	(7<<14)
     86 #define  DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF	(8<<14)
     87 
     88 /* Picture aspect ratio options */
     89 #define DRM_MODE_PICTURE_ASPECT_NONE		0
     90 #define DRM_MODE_PICTURE_ASPECT_4_3		1
     91 #define DRM_MODE_PICTURE_ASPECT_16_9		2
     92 
     93 /* Aspect ratio flag bitmask (4 bits 22:19) */
     94 #define DRM_MODE_FLAG_PIC_AR_MASK		(0x0F<<19)
     95 #define  DRM_MODE_FLAG_PIC_AR_NONE \
     96 			(DRM_MODE_PICTURE_ASPECT_NONE<<19)
     97 #define  DRM_MODE_FLAG_PIC_AR_4_3 \
     98 			(DRM_MODE_PICTURE_ASPECT_4_3<<19)
     99 #define  DRM_MODE_FLAG_PIC_AR_16_9 \
    100 			(DRM_MODE_PICTURE_ASPECT_16_9<<19)
    101 
    102 /* DPMS flags */
    103 /* bit compatible with the xorg definitions. */
    104 #define DRM_MODE_DPMS_ON	0
    105 #define DRM_MODE_DPMS_STANDBY	1
    106 #define DRM_MODE_DPMS_SUSPEND	2
    107 #define DRM_MODE_DPMS_OFF	3
    108 
    109 /* Scaling mode options */
    110 #define DRM_MODE_SCALE_NONE		0 /* Unmodified timing (display or
    111 					     software can still scale) */
    112 #define DRM_MODE_SCALE_FULLSCREEN	1 /* Full screen, ignore aspect */
    113 #define DRM_MODE_SCALE_CENTER		2 /* Centered, no scaling */
    114 #define DRM_MODE_SCALE_ASPECT		3 /* Full screen, preserve aspect */
    115 
    116 /* Dithering mode options */
    117 #define DRM_MODE_DITHERING_OFF	0
    118 #define DRM_MODE_DITHERING_ON	1
    119 #define DRM_MODE_DITHERING_AUTO 2
    120 
    121 /* Dirty info options */
    122 #define DRM_MODE_DIRTY_OFF      0
    123 #define DRM_MODE_DIRTY_ON       1
    124 #define DRM_MODE_DIRTY_ANNOTATE 2
    125 
    126 /* Link Status options */
    127 #define DRM_MODE_LINK_STATUS_GOOD	0
    128 #define DRM_MODE_LINK_STATUS_BAD	1
    129 
    130 /*
    131  * DRM_MODE_ROTATE_<degrees>
    132  *
    133  * Signals that a drm plane is been rotated <degrees> degrees in counter
    134  * clockwise direction.
    135  *
    136  * This define is provided as a convenience, looking up the property id
    137  * using the name->prop id lookup is the preferred method.
    138  */
    139 #define DRM_MODE_ROTATE_0       (1<<0)
    140 #define DRM_MODE_ROTATE_90      (1<<1)
    141 #define DRM_MODE_ROTATE_180     (1<<2)
    142 #define DRM_MODE_ROTATE_270     (1<<3)
    143 
    144 /*
    145  * DRM_MODE_ROTATE_MASK
    146  *
    147  * Bitmask used to look for drm plane rotations.
    148  */
    149 #define DRM_MODE_ROTATE_MASK (\
    150 		DRM_MODE_ROTATE_0  | \
    151 		DRM_MODE_ROTATE_90  | \
    152 		DRM_MODE_ROTATE_180 | \
    153 		DRM_MODE_ROTATE_270)
    154 
    155 /*
    156  * DRM_MODE_REFLECT_<axis>
    157  *
    158  * Signals that the contents of a drm plane is reflected in the <axis> axis,
    159  * in the same way as mirroring.
    160  *
    161  * This define is provided as a convenience, looking up the property id
    162  * using the name->prop id lookup is the preferred method.
    163  */
    164 #define DRM_MODE_REFLECT_X      (1<<4)
    165 #define DRM_MODE_REFLECT_Y      (1<<5)
    166 
    167 /*
    168  * DRM_MODE_REFLECT_MASK
    169  *
    170  * Bitmask used to look for drm plane reflections.
    171  */
    172 #define DRM_MODE_REFLECT_MASK (\
    173 		DRM_MODE_REFLECT_X | \
    174 		DRM_MODE_REFLECT_Y)
    175 
    176 
    177 /*
    178  * Legacy definitions for old code that doesn't use
    179  * the above mask definitions. Don't use in future code.
    180  */
    181 /* rotation property bits */
    182 #define DRM_ROTATE_0   0
    183 #define DRM_ROTATE_90  1
    184 #define DRM_ROTATE_180 2
    185 #define DRM_ROTATE_270 3
    186 #define DRM_REFLECT_X  4
    187 #define DRM_REFLECT_Y  5
    188 
    189 /* Content Protection Flags */
    190 #define DRM_MODE_CONTENT_PROTECTION_UNDESIRED	0
    191 #define DRM_MODE_CONTENT_PROTECTION_DESIRED     1
    192 #define DRM_MODE_CONTENT_PROTECTION_ENABLED     2
    193 
    194 struct drm_mode_modeinfo {
    195 	__u32 clock;
    196 	__u16 hdisplay;
    197 	__u16 hsync_start;
    198 	__u16 hsync_end;
    199 	__u16 htotal;
    200 	__u16 hskew;
    201 	__u16 vdisplay;
    202 	__u16 vsync_start;
    203 	__u16 vsync_end;
    204 	__u16 vtotal;
    205 	__u16 vscan;
    206 
    207 	__u32 vrefresh;
    208 
    209 	__u32 flags;
    210 	__u32 type;
    211 	char name[DRM_DISPLAY_MODE_LEN];
    212 };
    213 
    214 struct drm_mode_card_res {
    215 	__u64 fb_id_ptr;
    216 	__u64 crtc_id_ptr;
    217 	__u64 connector_id_ptr;
    218 	__u64 encoder_id_ptr;
    219 	__u32 count_fbs;
    220 	__u32 count_crtcs;
    221 	__u32 count_connectors;
    222 	__u32 count_encoders;
    223 	__u32 min_width;
    224 	__u32 max_width;
    225 	__u32 min_height;
    226 	__u32 max_height;
    227 };
    228 
    229 struct drm_mode_crtc {
    230 	__u64 set_connectors_ptr;
    231 	__u32 count_connectors;
    232 
    233 	__u32 crtc_id; /**< Id */
    234 	__u32 fb_id; /**< Id of framebuffer */
    235 
    236 	__u32 x; /**< x Position on the framebuffer */
    237 	__u32 y; /**< y Position on the framebuffer */
    238 
    239 	__u32 gamma_size;
    240 	__u32 mode_valid;
    241 	struct drm_mode_modeinfo mode;
    242 };
    243 
    244 #define DRM_MODE_PRESENT_TOP_FIELD	(1<<0)
    245 #define DRM_MODE_PRESENT_BOTTOM_FIELD	(1<<1)
    246 
    247 /* Planes blend with or override other bits on the CRTC */
    248 struct drm_mode_set_plane {
    249 	__u32 plane_id;
    250 	__u32 crtc_id;
    251 	__u32 fb_id; /* fb object contains surface format type */
    252 	__u32 flags; /* see above flags */
    253 
    254 	/* Signed dest location allows it to be partially off screen */
    255 	__s32 crtc_x;
    256 	__s32 crtc_y;
    257 	__u32 crtc_w;
    258 	__u32 crtc_h;
    259 
    260 	/* Source values are 16.16 fixed point */
    261 	__u32 src_x;
    262 	__u32 src_y;
    263 	__u32 src_h;
    264 	__u32 src_w;
    265 };
    266 
    267 struct drm_mode_get_plane {
    268 	__u32 plane_id;
    269 
    270 	__u32 crtc_id;
    271 	__u32 fb_id;
    272 
    273 	__u32 possible_crtcs;
    274 	__u32 gamma_size;
    275 
    276 	__u32 count_format_types;
    277 	__u64 format_type_ptr;
    278 };
    279 
    280 struct drm_mode_get_plane_res {
    281 	__u64 plane_id_ptr;
    282 	__u32 count_planes;
    283 };
    284 
    285 #define DRM_MODE_ENCODER_NONE	0
    286 #define DRM_MODE_ENCODER_DAC	1
    287 #define DRM_MODE_ENCODER_TMDS	2
    288 #define DRM_MODE_ENCODER_LVDS	3
    289 #define DRM_MODE_ENCODER_TVDAC	4
    290 #define DRM_MODE_ENCODER_VIRTUAL 5
    291 #define DRM_MODE_ENCODER_DSI	6
    292 #define DRM_MODE_ENCODER_DPMST	7
    293 #define DRM_MODE_ENCODER_DPI	8
    294 
    295 struct drm_mode_get_encoder {
    296 	__u32 encoder_id;
    297 	__u32 encoder_type;
    298 
    299 	__u32 crtc_id; /**< Id of crtc */
    300 
    301 	__u32 possible_crtcs;
    302 	__u32 possible_clones;
    303 };
    304 
    305 /* This is for connectors with multiple signal types. */
    306 /* Try to match DRM_MODE_CONNECTOR_X as closely as possible. */
    307 enum drm_mode_subconnector {
    308 	DRM_MODE_SUBCONNECTOR_Automatic = 0,
    309 	DRM_MODE_SUBCONNECTOR_Unknown = 0,
    310 	DRM_MODE_SUBCONNECTOR_DVID = 3,
    311 	DRM_MODE_SUBCONNECTOR_DVIA = 4,
    312 	DRM_MODE_SUBCONNECTOR_Composite = 5,
    313 	DRM_MODE_SUBCONNECTOR_SVIDEO = 6,
    314 	DRM_MODE_SUBCONNECTOR_Component = 8,
    315 	DRM_MODE_SUBCONNECTOR_SCART = 9,
    316 };
    317 
    318 #define DRM_MODE_CONNECTOR_Unknown	0
    319 #define DRM_MODE_CONNECTOR_VGA		1
    320 #define DRM_MODE_CONNECTOR_DVII		2
    321 #define DRM_MODE_CONNECTOR_DVID		3
    322 #define DRM_MODE_CONNECTOR_DVIA		4
    323 #define DRM_MODE_CONNECTOR_Composite	5
    324 #define DRM_MODE_CONNECTOR_SVIDEO	6
    325 #define DRM_MODE_CONNECTOR_LVDS		7
    326 #define DRM_MODE_CONNECTOR_Component	8
    327 #define DRM_MODE_CONNECTOR_9PinDIN	9
    328 #define DRM_MODE_CONNECTOR_DisplayPort	10
    329 #define DRM_MODE_CONNECTOR_HDMIA	11
    330 #define DRM_MODE_CONNECTOR_HDMIB	12
    331 #define DRM_MODE_CONNECTOR_TV		13
    332 #define DRM_MODE_CONNECTOR_eDP		14
    333 #define DRM_MODE_CONNECTOR_VIRTUAL      15
    334 #define DRM_MODE_CONNECTOR_DSI		16
    335 #define DRM_MODE_CONNECTOR_DPI		17
    336 
    337 struct drm_mode_get_connector {
    338 
    339 	__u64 encoders_ptr;
    340 	__u64 modes_ptr;
    341 	__u64 props_ptr;
    342 	__u64 prop_values_ptr;
    343 
    344 	__u32 count_modes;
    345 	__u32 count_props;
    346 	__u32 count_encoders;
    347 
    348 	__u32 encoder_id; /**< Current Encoder */
    349 	__u32 connector_id; /**< Id */
    350 	__u32 connector_type;
    351 	__u32 connector_type_id;
    352 
    353 	__u32 connection;
    354 	__u32 mm_width;  /**< width in millimeters */
    355 	__u32 mm_height; /**< height in millimeters */
    356 	__u32 subpixel;
    357 
    358 	__u32 pad;
    359 };
    360 
    361 #define DRM_MODE_PROP_PENDING	(1<<0) /* deprecated, do not use */
    362 #define DRM_MODE_PROP_RANGE	(1<<1)
    363 #define DRM_MODE_PROP_IMMUTABLE	(1<<2)
    364 #define DRM_MODE_PROP_ENUM	(1<<3) /* enumerated type with text strings */
    365 #define DRM_MODE_PROP_BLOB	(1<<4)
    366 #define DRM_MODE_PROP_BITMASK	(1<<5) /* bitmask of enumerated types */
    367 
    368 /* non-extended types: legacy bitmask, one bit per type: */
    369 #define DRM_MODE_PROP_LEGACY_TYPE  ( \
    370 		DRM_MODE_PROP_RANGE | \
    371 		DRM_MODE_PROP_ENUM | \
    372 		DRM_MODE_PROP_BLOB | \
    373 		DRM_MODE_PROP_BITMASK)
    374 
    375 /* extended-types: rather than continue to consume a bit per type,
    376  * grab a chunk of the bits to use as integer type id.
    377  */
    378 #define DRM_MODE_PROP_EXTENDED_TYPE	0x0000ffc0
    379 #define DRM_MODE_PROP_TYPE(n)		((n) << 6)
    380 #define DRM_MODE_PROP_OBJECT		DRM_MODE_PROP_TYPE(1)
    381 #define DRM_MODE_PROP_SIGNED_RANGE	DRM_MODE_PROP_TYPE(2)
    382 
    383 /* the PROP_ATOMIC flag is used to hide properties from userspace that
    384  * is not aware of atomic properties.  This is mostly to work around
    385  * older userspace (DDX drivers) that read/write each prop they find,
    386  * witout being aware that this could be triggering a lengthy modeset.
    387  */
    388 #define DRM_MODE_PROP_ATOMIC        0x80000000
    389 
    390 struct drm_mode_property_enum {
    391 	__u64 value;
    392 	char name[DRM_PROP_NAME_LEN];
    393 };
    394 
    395 struct drm_mode_get_property {
    396 	__u64 values_ptr; /* values and blob lengths */
    397 	__u64 enum_blob_ptr; /* enum and blob id ptrs */
    398 
    399 	__u32 prop_id;
    400 	__u32 flags;
    401 	char name[DRM_PROP_NAME_LEN];
    402 
    403 	__u32 count_values;
    404 	/* This is only used to count enum values, not blobs. The _blobs is
    405 	 * simply because of a historical reason, i.e. backwards compat. */
    406 	__u32 count_enum_blobs;
    407 };
    408 
    409 struct drm_mode_connector_set_property {
    410 	__u64 value;
    411 	__u32 prop_id;
    412 	__u32 connector_id;
    413 };
    414 
    415 #define DRM_MODE_OBJECT_CRTC 0xcccccccc
    416 #define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
    417 #define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
    418 #define DRM_MODE_OBJECT_MODE 0xdededede
    419 #define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
    420 #define DRM_MODE_OBJECT_FB 0xfbfbfbfb
    421 #define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
    422 #define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
    423 #define DRM_MODE_OBJECT_ANY 0
    424 
    425 struct drm_mode_obj_get_properties {
    426 	__u64 props_ptr;
    427 	__u64 prop_values_ptr;
    428 	__u32 count_props;
    429 	__u32 obj_id;
    430 	__u32 obj_type;
    431 };
    432 
    433 struct drm_mode_obj_set_property {
    434 	__u64 value;
    435 	__u32 prop_id;
    436 	__u32 obj_id;
    437 	__u32 obj_type;
    438 };
    439 
    440 struct drm_mode_get_blob {
    441 	__u32 blob_id;
    442 	__u32 length;
    443 	__u64 data;
    444 };
    445 
    446 struct drm_mode_fb_cmd {
    447 	__u32 fb_id;
    448 	__u32 width;
    449 	__u32 height;
    450 	__u32 pitch;
    451 	__u32 bpp;
    452 	__u32 depth;
    453 	/* driver specific handle */
    454 	__u32 handle;
    455 };
    456 
    457 #define DRM_MODE_FB_INTERLACED	(1<<0) /* for interlaced framebuffers */
    458 #define DRM_MODE_FB_MODIFIERS	(1<<1) /* enables ->modifer[] */
    459 
    460 struct drm_mode_fb_cmd2 {
    461 	__u32 fb_id;
    462 	__u32 width;
    463 	__u32 height;
    464 	__u32 pixel_format; /* fourcc code from drm_fourcc.h */
    465 	__u32 flags; /* see above flags */
    466 
    467 	/*
    468 	 * In case of planar formats, this ioctl allows up to 4
    469 	 * buffer objects with offsets and pitches per plane.
    470 	 * The pitch and offset order is dictated by the fourcc,
    471 	 * e.g. NV12 (http://fourcc.org/yuv.php#NV12) is described as:
    472 	 *
    473 	 *   YUV 4:2:0 image with a plane of 8 bit Y samples
    474 	 *   followed by an interleaved U/V plane containing
    475 	 *   8 bit 2x2 subsampled colour difference samples.
    476 	 *
    477 	 * So it would consist of Y as offsets[0] and UV as
    478 	 * offsets[1].  Note that offsets[0] will generally
    479 	 * be 0 (but this is not required).
    480 	 *
    481 	 * To accommodate tiled, compressed, etc formats, a
    482 	 * modifier can be specified.  The default value of zero
    483 	 * indicates "native" format as specified by the fourcc.
    484 	 * Vendor specific modifier token.  Note that even though
    485 	 * it looks like we have a modifier per-plane, we in fact
    486 	 * do not. The modifier for each plane must be identical.
    487 	 * Thus all combinations of different data layouts for
    488 	 * multi plane formats must be enumerated as separate
    489 	 * modifiers.
    490 	 */
    491 	__u32 handles[4];
    492 	__u32 pitches[4]; /* pitch for each plane */
    493 	__u32 offsets[4]; /* offset of each plane */
    494 	__u64 modifier[4]; /* ie, tiling, compress */
    495 };
    496 
    497 #define DRM_MODE_FB_DIRTY_ANNOTATE_COPY 0x01
    498 #define DRM_MODE_FB_DIRTY_ANNOTATE_FILL 0x02
    499 #define DRM_MODE_FB_DIRTY_FLAGS         0x03
    500 
    501 #define DRM_MODE_FB_DIRTY_MAX_CLIPS     256
    502 
    503 /*
    504  * Mark a region of a framebuffer as dirty.
    505  *
    506  * Some hardware does not automatically update display contents
    507  * as a hardware or software draw to a framebuffer. This ioctl
    508  * allows userspace to tell the kernel and the hardware what
    509  * regions of the framebuffer have changed.
    510  *
    511  * The kernel or hardware is free to update more then just the
    512  * region specified by the clip rects. The kernel or hardware
    513  * may also delay and/or coalesce several calls to dirty into a
    514  * single update.
    515  *
    516  * Userspace may annotate the updates, the annotates are a
    517  * promise made by the caller that the change is either a copy
    518  * of pixels or a fill of a single color in the region specified.
    519  *
    520  * If the DRM_MODE_FB_DIRTY_ANNOTATE_COPY flag is given then
    521  * the number of updated regions are half of num_clips given,
    522  * where the clip rects are paired in src and dst. The width and
    523  * height of each one of the pairs must match.
    524  *
    525  * If the DRM_MODE_FB_DIRTY_ANNOTATE_FILL flag is given the caller
    526  * promises that the region specified of the clip rects is filled
    527  * completely with a single color as given in the color argument.
    528  */
    529 
    530 struct drm_mode_fb_dirty_cmd {
    531 	__u32 fb_id;
    532 	__u32 flags;
    533 	__u32 color;
    534 	__u32 num_clips;
    535 	__u64 clips_ptr;
    536 };
    537 
    538 struct drm_mode_mode_cmd {
    539 	__u32 connector_id;
    540 	struct drm_mode_modeinfo mode;
    541 };
    542 
    543 #define DRM_MODE_CURSOR_BO	0x01
    544 #define DRM_MODE_CURSOR_MOVE	0x02
    545 #define DRM_MODE_CURSOR_FLAGS	0x03
    546 
    547 /*
    548  * depending on the value in flags different members are used.
    549  *
    550  * CURSOR_BO uses
    551  *    crtc_id
    552  *    width
    553  *    height
    554  *    handle - if 0 turns the cursor off
    555  *
    556  * CURSOR_MOVE uses
    557  *    crtc_id
    558  *    x
    559  *    y
    560  */
    561 struct drm_mode_cursor {
    562 	__u32 flags;
    563 	__u32 crtc_id;
    564 	__s32 x;
    565 	__s32 y;
    566 	__u32 width;
    567 	__u32 height;
    568 	/* driver specific handle */
    569 	__u32 handle;
    570 };
    571 
    572 struct drm_mode_cursor2 {
    573 	__u32 flags;
    574 	__u32 crtc_id;
    575 	__s32 x;
    576 	__s32 y;
    577 	__u32 width;
    578 	__u32 height;
    579 	/* driver specific handle */
    580 	__u32 handle;
    581 	__s32 hot_x;
    582 	__s32 hot_y;
    583 };
    584 
    585 struct drm_mode_crtc_lut {
    586 	__u32 crtc_id;
    587 	__u32 gamma_size;
    588 
    589 	/* pointers to arrays */
    590 	__u64 red;
    591 	__u64 green;
    592 	__u64 blue;
    593 };
    594 
    595 struct drm_color_ctm {
    596 	/*
    597 	 * Conversion matrix in S31.32 sign-magnitude
    598 	 * (not two's complement!) format.
    599 	 */
    600 	__u64 matrix[9];
    601 };
    602 
    603 struct drm_color_lut {
    604 	/*
    605 	 * Data is U0.16 fixed point format.
    606 	 */
    607 	__u16 red;
    608 	__u16 green;
    609 	__u16 blue;
    610 	__u16 reserved;
    611 };
    612 
    613 #define DRM_MODE_PAGE_FLIP_EVENT 0x01
    614 #define DRM_MODE_PAGE_FLIP_ASYNC 0x02
    615 #define DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE 0x4
    616 #define DRM_MODE_PAGE_FLIP_TARGET_RELATIVE 0x8
    617 #define DRM_MODE_PAGE_FLIP_TARGET (DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE | \
    618 				   DRM_MODE_PAGE_FLIP_TARGET_RELATIVE)
    619 #define DRM_MODE_PAGE_FLIP_FLAGS (DRM_MODE_PAGE_FLIP_EVENT | \
    620 				  DRM_MODE_PAGE_FLIP_ASYNC | \
    621 				  DRM_MODE_PAGE_FLIP_TARGET)
    622 
    623 /*
    624  * Request a page flip on the specified crtc.
    625  *
    626  * This ioctl will ask KMS to schedule a page flip for the specified
    627  * crtc.  Once any pending rendering targeting the specified fb (as of
    628  * ioctl time) has completed, the crtc will be reprogrammed to display
    629  * that fb after the next vertical refresh.  The ioctl returns
    630  * immediately, but subsequent rendering to the current fb will block
    631  * in the execbuffer ioctl until the page flip happens.  If a page
    632  * flip is already pending as the ioctl is called, EBUSY will be
    633  * returned.
    634  *
    635  * Flag DRM_MODE_PAGE_FLIP_EVENT requests that drm sends back a vblank
    636  * event (see drm.h: struct drm_event_vblank) when the page flip is
    637  * done.  The user_data field passed in with this ioctl will be
    638  * returned as the user_data field in the vblank event struct.
    639  *
    640  * Flag DRM_MODE_PAGE_FLIP_ASYNC requests that the flip happen
    641  * 'as soon as possible', meaning that it not delay waiting for vblank.
    642  * This may cause tearing on the screen.
    643  *
    644  * The reserved field must be zero.
    645  */
    646 
    647 struct drm_mode_crtc_page_flip {
    648 	__u32 crtc_id;
    649 	__u32 fb_id;
    650 	__u32 flags;
    651 	__u32 reserved;
    652 	__u64 user_data;
    653 };
    654 
    655 /*
    656  * Request a page flip on the specified crtc.
    657  *
    658  * Same as struct drm_mode_crtc_page_flip, but supports new flags and
    659  * re-purposes the reserved field:
    660  *
    661  * The sequence field must be zero unless either of the
    662  * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is specified. When
    663  * the ABSOLUTE flag is specified, the sequence field denotes the absolute
    664  * vblank sequence when the flip should take effect. When the RELATIVE
    665  * flag is specified, the sequence field denotes the relative (to the
    666  * current one when the ioctl is called) vblank sequence when the flip
    667  * should take effect. NOTE: DRM_IOCTL_WAIT_VBLANK must still be used to
    668  * make sure the vblank sequence before the target one has passed before
    669  * calling this ioctl. The purpose of the
    670  * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is merely to clarify
    671  * the target for when code dealing with a page flip runs during a
    672  * vertical blank period.
    673  */
    674 
    675 struct drm_mode_crtc_page_flip_target {
    676 	__u32 crtc_id;
    677 	__u32 fb_id;
    678 	__u32 flags;
    679 	__u32 sequence;
    680 	__u64 user_data;
    681 };
    682 
    683 /* create a dumb scanout buffer */
    684 struct drm_mode_create_dumb {
    685 	__u32 height;
    686 	__u32 width;
    687 	__u32 bpp;
    688 	__u32 flags;
    689 	/* handle, pitch, size will be returned */
    690 	__u32 handle;
    691 	__u32 pitch;
    692 	__u64 size;
    693 };
    694 
    695 /* set up for mmap of a dumb scanout buffer */
    696 struct drm_mode_map_dumb {
    697 	/** Handle for the object being mapped. */
    698 	__u32 handle;
    699 	__u32 pad;
    700 	/**
    701 	 * Fake offset to use for subsequent mmap call
    702 	 *
    703 	 * This is a fixed-size type for 32/64 compatibility.
    704 	 */
    705 	__u64 offset;
    706 };
    707 
    708 struct drm_mode_destroy_dumb {
    709 	__u32 handle;
    710 };
    711 
    712 /* page-flip flags are valid, plus: */
    713 #define DRM_MODE_ATOMIC_TEST_ONLY 0x0100
    714 #define DRM_MODE_ATOMIC_NONBLOCK  0x0200
    715 #define DRM_MODE_ATOMIC_ALLOW_MODESET 0x0400
    716 
    717 #define DRM_MODE_ATOMIC_FLAGS (\
    718 		DRM_MODE_PAGE_FLIP_EVENT |\
    719 		DRM_MODE_PAGE_FLIP_ASYNC |\
    720 		DRM_MODE_ATOMIC_TEST_ONLY |\
    721 		DRM_MODE_ATOMIC_NONBLOCK |\
    722 		DRM_MODE_ATOMIC_ALLOW_MODESET)
    723 
    724 struct drm_mode_atomic {
    725 	__u32 flags;
    726 	__u32 count_objs;
    727 	__u64 objs_ptr;
    728 	__u64 count_props_ptr;
    729 	__u64 props_ptr;
    730 	__u64 prop_values_ptr;
    731 	__u64 reserved;
    732 	__u64 user_data;
    733 };
    734 
    735 struct drm_format_modifier_blob {
    736 #define FORMAT_BLOB_CURRENT 1
    737 	/* Version of this blob format */
    738 	__u32 version;
    739 
    740 	/* Flags */
    741 	__u32 flags;
    742 
    743 	/* Number of fourcc formats supported */
    744 	__u32 count_formats;
    745 
    746 	/* Where in this blob the formats exist (in bytes) */
    747 	__u32 formats_offset;
    748 
    749 	/* Number of drm_format_modifiers */
    750 	__u32 count_modifiers;
    751 
    752 	/* Where in this blob the modifiers exist (in bytes) */
    753 	__u32 modifiers_offset;
    754 
    755 	/* __u32 formats[] */
    756 	/* struct drm_format_modifier modifiers[] */
    757 };
    758 
    759 struct drm_format_modifier {
    760 	/* Bitmask of formats in get_plane format list this info applies to. The
    761 	 * offset allows a sliding window of which 64 formats (bits).
    762 	 *
    763 	 * Some examples:
    764 	 * In today's world with < 65 formats, and formats 0, and 2 are
    765 	 * supported
    766 	 * 0x0000000000000005
    767 	 *		  ^-offset = 0, formats = 5
    768 	 *
    769 	 * If the number formats grew to 128, and formats 98-102 are
    770 	 * supported with the modifier:
    771 	 *
    772 	 * 0x0000007c00000000 0000000000000000
    773 	 *		  ^
    774 	 *		  |__offset = 64, formats = 0x7c00000000
    775 	 *
    776 	 */
    777 	__u64 formats;
    778 	__u32 offset;
    779 	__u32 pad;
    780 
    781 	/* The modifier that applies to the >get_plane format list bitmask. */
    782 	__u64 modifier;
    783 };
    784 
    785 /**
    786  * Create a new 'blob' data property, copying length bytes from data pointer,
    787  * and returning new blob ID.
    788  */
    789 struct drm_mode_create_blob {
    790 	/** Pointer to data to copy. */
    791 	__u64 data;
    792 	/** Length of data to copy. */
    793 	__u32 length;
    794 	/** Return: new property ID. */
    795 	__u32 blob_id;
    796 };
    797 
    798 /**
    799  * Destroy a user-created blob property.
    800  */
    801 struct drm_mode_destroy_blob {
    802 	__u32 blob_id;
    803 };
    804 
    805 /**
    806  * Lease mode resources, creating another drm_master.
    807  */
    808 struct drm_mode_create_lease {
    809 	/** Pointer to array of object ids (__u32) */
    810 	__u64 object_ids;
    811 	/** Number of object ids */
    812 	__u32 object_count;
    813 	/** flags for new FD (O_CLOEXEC, etc) */
    814 	__u32 flags;
    815 
    816 	/** Return: unique identifier for lessee. */
    817 	__u32 lessee_id;
    818 	/** Return: file descriptor to new drm_master file */
    819 	__u32 fd;
    820 };
    821 
    822 /**
    823  * List lesses from a drm_master
    824  */
    825 struct drm_mode_list_lessees {
    826 	/** Number of lessees.
    827 	 * On input, provides length of the array.
    828 	 * On output, provides total number. No
    829 	 * more than the input number will be written
    830 	 * back, so two calls can be used to get
    831 	 * the size and then the data.
    832 	 */
    833 	__u32 count_lessees;
    834 	__u32 pad;
    835 
    836 	/** Pointer to lessees.
    837 	 * pointer to __u64 array of lessee ids
    838 	 */
    839 	__u64 lessees_ptr;
    840 };
    841 
    842 /**
    843  * Get leased objects
    844  */
    845 struct drm_mode_get_lease {
    846 	/** Number of leased objects.
    847 	 * On input, provides length of the array.
    848 	 * On output, provides total number. No
    849 	 * more than the input number will be written
    850 	 * back, so two calls can be used to get
    851 	 * the size and then the data.
    852 	 */
    853 	__u32 count_objects;
    854 	__u32 pad;
    855 
    856 	/** Pointer to objects.
    857 	 * pointer to __u32 array of object ids
    858 	 */
    859 	__u64 objects_ptr;
    860 };
    861 
    862 /**
    863  * Revoke lease
    864  */
    865 struct drm_mode_revoke_lease {
    866 	/** Unique ID of lessee
    867 	 */
    868 	__u32 lessee_id;
    869 };
    870 
    871 #if defined(__cplusplus)
    872 }
    873 #endif
    874 
    875 #endif
    876