Home | History | Annotate | Download | only in drm-uapi
      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)
     42 #define DRM_MODE_TYPE_CLOCK_C	((1<<1) | DRM_MODE_TYPE_BUILTIN)
     43 #define DRM_MODE_TYPE_CRTC_C	((1<<2) | DRM_MODE_TYPE_BUILTIN)
     44 #define DRM_MODE_TYPE_PREFERRED	(1<<3)
     45 #define DRM_MODE_TYPE_DEFAULT	(1<<4)
     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)
     70 #define DRM_MODE_FLAG_PIXMUX			(1<<11)
     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 struct drm_mode_modeinfo {
    178 	__u32 clock;
    179 	__u16 hdisplay;
    180 	__u16 hsync_start;
    181 	__u16 hsync_end;
    182 	__u16 htotal;
    183 	__u16 hskew;
    184 	__u16 vdisplay;
    185 	__u16 vsync_start;
    186 	__u16 vsync_end;
    187 	__u16 vtotal;
    188 	__u16 vscan;
    189 
    190 	__u32 vrefresh;
    191 
    192 	__u32 flags;
    193 	__u32 type;
    194 	char name[DRM_DISPLAY_MODE_LEN];
    195 };
    196 
    197 struct drm_mode_card_res {
    198 	__u64 fb_id_ptr;
    199 	__u64 crtc_id_ptr;
    200 	__u64 connector_id_ptr;
    201 	__u64 encoder_id_ptr;
    202 	__u32 count_fbs;
    203 	__u32 count_crtcs;
    204 	__u32 count_connectors;
    205 	__u32 count_encoders;
    206 	__u32 min_width;
    207 	__u32 max_width;
    208 	__u32 min_height;
    209 	__u32 max_height;
    210 };
    211 
    212 struct drm_mode_crtc {
    213 	__u64 set_connectors_ptr;
    214 	__u32 count_connectors;
    215 
    216 	__u32 crtc_id; /**< Id */
    217 	__u32 fb_id; /**< Id of framebuffer */
    218 
    219 	__u32 x; /**< x Position on the framebuffer */
    220 	__u32 y; /**< y Position on the framebuffer */
    221 
    222 	__u32 gamma_size;
    223 	__u32 mode_valid;
    224 	struct drm_mode_modeinfo mode;
    225 };
    226 
    227 #define DRM_MODE_PRESENT_TOP_FIELD	(1<<0)
    228 #define DRM_MODE_PRESENT_BOTTOM_FIELD	(1<<1)
    229 
    230 /* Planes blend with or override other bits on the CRTC */
    231 struct drm_mode_set_plane {
    232 	__u32 plane_id;
    233 	__u32 crtc_id;
    234 	__u32 fb_id; /* fb object contains surface format type */
    235 	__u32 flags; /* see above flags */
    236 
    237 	/* Signed dest location allows it to be partially off screen */
    238 	__s32 crtc_x;
    239 	__s32 crtc_y;
    240 	__u32 crtc_w;
    241 	__u32 crtc_h;
    242 
    243 	/* Source values are 16.16 fixed point */
    244 	__u32 src_x;
    245 	__u32 src_y;
    246 	__u32 src_h;
    247 	__u32 src_w;
    248 };
    249 
    250 struct drm_mode_get_plane {
    251 	__u32 plane_id;
    252 
    253 	__u32 crtc_id;
    254 	__u32 fb_id;
    255 
    256 	__u32 possible_crtcs;
    257 	__u32 gamma_size;
    258 
    259 	__u32 count_format_types;
    260 	__u64 format_type_ptr;
    261 };
    262 
    263 struct drm_mode_get_plane_res {
    264 	__u64 plane_id_ptr;
    265 	__u32 count_planes;
    266 };
    267 
    268 #define DRM_MODE_ENCODER_NONE	0
    269 #define DRM_MODE_ENCODER_DAC	1
    270 #define DRM_MODE_ENCODER_TMDS	2
    271 #define DRM_MODE_ENCODER_LVDS	3
    272 #define DRM_MODE_ENCODER_TVDAC	4
    273 #define DRM_MODE_ENCODER_VIRTUAL 5
    274 #define DRM_MODE_ENCODER_DSI	6
    275 #define DRM_MODE_ENCODER_DPMST	7
    276 #define DRM_MODE_ENCODER_DPI	8
    277 
    278 struct drm_mode_get_encoder {
    279 	__u32 encoder_id;
    280 	__u32 encoder_type;
    281 
    282 	__u32 crtc_id; /**< Id of crtc */
    283 
    284 	__u32 possible_crtcs;
    285 	__u32 possible_clones;
    286 };
    287 
    288 /* This is for connectors with multiple signal types. */
    289 /* Try to match DRM_MODE_CONNECTOR_X as closely as possible. */
    290 enum drm_mode_subconnector {
    291 	DRM_MODE_SUBCONNECTOR_Automatic = 0,
    292 	DRM_MODE_SUBCONNECTOR_Unknown = 0,
    293 	DRM_MODE_SUBCONNECTOR_DVID = 3,
    294 	DRM_MODE_SUBCONNECTOR_DVIA = 4,
    295 	DRM_MODE_SUBCONNECTOR_Composite = 5,
    296 	DRM_MODE_SUBCONNECTOR_SVIDEO = 6,
    297 	DRM_MODE_SUBCONNECTOR_Component = 8,
    298 	DRM_MODE_SUBCONNECTOR_SCART = 9,
    299 };
    300 
    301 #define DRM_MODE_CONNECTOR_Unknown	0
    302 #define DRM_MODE_CONNECTOR_VGA		1
    303 #define DRM_MODE_CONNECTOR_DVII		2
    304 #define DRM_MODE_CONNECTOR_DVID		3
    305 #define DRM_MODE_CONNECTOR_DVIA		4
    306 #define DRM_MODE_CONNECTOR_Composite	5
    307 #define DRM_MODE_CONNECTOR_SVIDEO	6
    308 #define DRM_MODE_CONNECTOR_LVDS		7
    309 #define DRM_MODE_CONNECTOR_Component	8
    310 #define DRM_MODE_CONNECTOR_9PinDIN	9
    311 #define DRM_MODE_CONNECTOR_DisplayPort	10
    312 #define DRM_MODE_CONNECTOR_HDMIA	11
    313 #define DRM_MODE_CONNECTOR_HDMIB	12
    314 #define DRM_MODE_CONNECTOR_TV		13
    315 #define DRM_MODE_CONNECTOR_eDP		14
    316 #define DRM_MODE_CONNECTOR_VIRTUAL      15
    317 #define DRM_MODE_CONNECTOR_DSI		16
    318 #define DRM_MODE_CONNECTOR_DPI		17
    319 
    320 struct drm_mode_get_connector {
    321 
    322 	__u64 encoders_ptr;
    323 	__u64 modes_ptr;
    324 	__u64 props_ptr;
    325 	__u64 prop_values_ptr;
    326 
    327 	__u32 count_modes;
    328 	__u32 count_props;
    329 	__u32 count_encoders;
    330 
    331 	__u32 encoder_id; /**< Current Encoder */
    332 	__u32 connector_id; /**< Id */
    333 	__u32 connector_type;
    334 	__u32 connector_type_id;
    335 
    336 	__u32 connection;
    337 	__u32 mm_width;  /**< width in millimeters */
    338 	__u32 mm_height; /**< height in millimeters */
    339 	__u32 subpixel;
    340 
    341 	__u32 pad;
    342 };
    343 
    344 #define DRM_MODE_PROP_PENDING	(1<<0)
    345 #define DRM_MODE_PROP_RANGE	(1<<1)
    346 #define DRM_MODE_PROP_IMMUTABLE	(1<<2)
    347 #define DRM_MODE_PROP_ENUM	(1<<3) /* enumerated type with text strings */
    348 #define DRM_MODE_PROP_BLOB	(1<<4)
    349 #define DRM_MODE_PROP_BITMASK	(1<<5) /* bitmask of enumerated types */
    350 
    351 /* non-extended types: legacy bitmask, one bit per type: */
    352 #define DRM_MODE_PROP_LEGACY_TYPE  ( \
    353 		DRM_MODE_PROP_RANGE | \
    354 		DRM_MODE_PROP_ENUM | \
    355 		DRM_MODE_PROP_BLOB | \
    356 		DRM_MODE_PROP_BITMASK)
    357 
    358 /* extended-types: rather than continue to consume a bit per type,
    359  * grab a chunk of the bits to use as integer type id.
    360  */
    361 #define DRM_MODE_PROP_EXTENDED_TYPE	0x0000ffc0
    362 #define DRM_MODE_PROP_TYPE(n)		((n) << 6)
    363 #define DRM_MODE_PROP_OBJECT		DRM_MODE_PROP_TYPE(1)
    364 #define DRM_MODE_PROP_SIGNED_RANGE	DRM_MODE_PROP_TYPE(2)
    365 
    366 /* the PROP_ATOMIC flag is used to hide properties from userspace that
    367  * is not aware of atomic properties.  This is mostly to work around
    368  * older userspace (DDX drivers) that read/write each prop they find,
    369  * witout being aware that this could be triggering a lengthy modeset.
    370  */
    371 #define DRM_MODE_PROP_ATOMIC        0x80000000
    372 
    373 struct drm_mode_property_enum {
    374 	__u64 value;
    375 	char name[DRM_PROP_NAME_LEN];
    376 };
    377 
    378 struct drm_mode_get_property {
    379 	__u64 values_ptr; /* values and blob lengths */
    380 	__u64 enum_blob_ptr; /* enum and blob id ptrs */
    381 
    382 	__u32 prop_id;
    383 	__u32 flags;
    384 	char name[DRM_PROP_NAME_LEN];
    385 
    386 	__u32 count_values;
    387 	/* This is only used to count enum values, not blobs. The _blobs is
    388 	 * simply because of a historical reason, i.e. backwards compat. */
    389 	__u32 count_enum_blobs;
    390 };
    391 
    392 struct drm_mode_connector_set_property {
    393 	__u64 value;
    394 	__u32 prop_id;
    395 	__u32 connector_id;
    396 };
    397 
    398 #define DRM_MODE_OBJECT_CRTC 0xcccccccc
    399 #define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
    400 #define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
    401 #define DRM_MODE_OBJECT_MODE 0xdededede
    402 #define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
    403 #define DRM_MODE_OBJECT_FB 0xfbfbfbfb
    404 #define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
    405 #define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
    406 #define DRM_MODE_OBJECT_ANY 0
    407 
    408 struct drm_mode_obj_get_properties {
    409 	__u64 props_ptr;
    410 	__u64 prop_values_ptr;
    411 	__u32 count_props;
    412 	__u32 obj_id;
    413 	__u32 obj_type;
    414 };
    415 
    416 struct drm_mode_obj_set_property {
    417 	__u64 value;
    418 	__u32 prop_id;
    419 	__u32 obj_id;
    420 	__u32 obj_type;
    421 };
    422 
    423 struct drm_mode_get_blob {
    424 	__u32 blob_id;
    425 	__u32 length;
    426 	__u64 data;
    427 };
    428 
    429 struct drm_mode_fb_cmd {
    430 	__u32 fb_id;
    431 	__u32 width;
    432 	__u32 height;
    433 	__u32 pitch;
    434 	__u32 bpp;
    435 	__u32 depth;
    436 	/* driver specific handle */
    437 	__u32 handle;
    438 };
    439 
    440 #define DRM_MODE_FB_INTERLACED	(1<<0) /* for interlaced framebuffers */
    441 #define DRM_MODE_FB_MODIFIERS	(1<<1) /* enables ->modifer[] */
    442 
    443 struct drm_mode_fb_cmd2 {
    444 	__u32 fb_id;
    445 	__u32 width;
    446 	__u32 height;
    447 	__u32 pixel_format; /* fourcc code from drm_fourcc.h */
    448 	__u32 flags; /* see above flags */
    449 
    450 	/*
    451 	 * In case of planar formats, this ioctl allows up to 4
    452 	 * buffer objects with offsets and pitches per plane.
    453 	 * The pitch and offset order is dictated by the fourcc,
    454 	 * e.g. NV12 (http://fourcc.org/yuv.php#NV12) is described as:
    455 	 *
    456 	 *   YUV 4:2:0 image with a plane of 8 bit Y samples
    457 	 *   followed by an interleaved U/V plane containing
    458 	 *   8 bit 2x2 subsampled colour difference samples.
    459 	 *
    460 	 * So it would consist of Y as offsets[0] and UV as
    461 	 * offsets[1].  Note that offsets[0] will generally
    462 	 * be 0 (but this is not required).
    463 	 *
    464 	 * To accommodate tiled, compressed, etc formats, a
    465 	 * modifier can be specified.  The default value of zero
    466 	 * indicates "native" format as specified by the fourcc.
    467 	 * Vendor specific modifier token.  Note that even though
    468 	 * it looks like we have a modifier per-plane, we in fact
    469 	 * do not. The modifier for each plane must be identical.
    470 	 * Thus all combinations of different data layouts for
    471 	 * multi plane formats must be enumerated as separate
    472 	 * modifiers.
    473 	 */
    474 	__u32 handles[4];
    475 	__u32 pitches[4]; /* pitch for each plane */
    476 	__u32 offsets[4]; /* offset of each plane */
    477 	__u64 modifier[4]; /* ie, tiling, compress */
    478 };
    479 
    480 #define DRM_MODE_FB_DIRTY_ANNOTATE_COPY 0x01
    481 #define DRM_MODE_FB_DIRTY_ANNOTATE_FILL 0x02
    482 #define DRM_MODE_FB_DIRTY_FLAGS         0x03
    483 
    484 #define DRM_MODE_FB_DIRTY_MAX_CLIPS     256
    485 
    486 /*
    487  * Mark a region of a framebuffer as dirty.
    488  *
    489  * Some hardware does not automatically update display contents
    490  * as a hardware or software draw to a framebuffer. This ioctl
    491  * allows userspace to tell the kernel and the hardware what
    492  * regions of the framebuffer have changed.
    493  *
    494  * The kernel or hardware is free to update more then just the
    495  * region specified by the clip rects. The kernel or hardware
    496  * may also delay and/or coalesce several calls to dirty into a
    497  * single update.
    498  *
    499  * Userspace may annotate the updates, the annotates are a
    500  * promise made by the caller that the change is either a copy
    501  * of pixels or a fill of a single color in the region specified.
    502  *
    503  * If the DRM_MODE_FB_DIRTY_ANNOTATE_COPY flag is given then
    504  * the number of updated regions are half of num_clips given,
    505  * where the clip rects are paired in src and dst. The width and
    506  * height of each one of the pairs must match.
    507  *
    508  * If the DRM_MODE_FB_DIRTY_ANNOTATE_FILL flag is given the caller
    509  * promises that the region specified of the clip rects is filled
    510  * completely with a single color as given in the color argument.
    511  */
    512 
    513 struct drm_mode_fb_dirty_cmd {
    514 	__u32 fb_id;
    515 	__u32 flags;
    516 	__u32 color;
    517 	__u32 num_clips;
    518 	__u64 clips_ptr;
    519 };
    520 
    521 struct drm_mode_mode_cmd {
    522 	__u32 connector_id;
    523 	struct drm_mode_modeinfo mode;
    524 };
    525 
    526 #define DRM_MODE_CURSOR_BO	0x01
    527 #define DRM_MODE_CURSOR_MOVE	0x02
    528 #define DRM_MODE_CURSOR_FLAGS	0x03
    529 
    530 /*
    531  * depending on the value in flags different members are used.
    532  *
    533  * CURSOR_BO uses
    534  *    crtc_id
    535  *    width
    536  *    height
    537  *    handle - if 0 turns the cursor off
    538  *
    539  * CURSOR_MOVE uses
    540  *    crtc_id
    541  *    x
    542  *    y
    543  */
    544 struct drm_mode_cursor {
    545 	__u32 flags;
    546 	__u32 crtc_id;
    547 	__s32 x;
    548 	__s32 y;
    549 	__u32 width;
    550 	__u32 height;
    551 	/* driver specific handle */
    552 	__u32 handle;
    553 };
    554 
    555 struct drm_mode_cursor2 {
    556 	__u32 flags;
    557 	__u32 crtc_id;
    558 	__s32 x;
    559 	__s32 y;
    560 	__u32 width;
    561 	__u32 height;
    562 	/* driver specific handle */
    563 	__u32 handle;
    564 	__s32 hot_x;
    565 	__s32 hot_y;
    566 };
    567 
    568 struct drm_mode_crtc_lut {
    569 	__u32 crtc_id;
    570 	__u32 gamma_size;
    571 
    572 	/* pointers to arrays */
    573 	__u64 red;
    574 	__u64 green;
    575 	__u64 blue;
    576 };
    577 
    578 struct drm_color_ctm {
    579 	/* Conversion matrix in S31.32 format. */
    580 	__s64 matrix[9];
    581 };
    582 
    583 struct drm_color_lut {
    584 	/*
    585 	 * Data is U0.16 fixed point format.
    586 	 */
    587 	__u16 red;
    588 	__u16 green;
    589 	__u16 blue;
    590 	__u16 reserved;
    591 };
    592 
    593 #define DRM_MODE_PAGE_FLIP_EVENT 0x01
    594 #define DRM_MODE_PAGE_FLIP_ASYNC 0x02
    595 #define DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE 0x4
    596 #define DRM_MODE_PAGE_FLIP_TARGET_RELATIVE 0x8
    597 #define DRM_MODE_PAGE_FLIP_TARGET (DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE | \
    598 				   DRM_MODE_PAGE_FLIP_TARGET_RELATIVE)
    599 #define DRM_MODE_PAGE_FLIP_FLAGS (DRM_MODE_PAGE_FLIP_EVENT | \
    600 				  DRM_MODE_PAGE_FLIP_ASYNC | \
    601 				  DRM_MODE_PAGE_FLIP_TARGET)
    602 
    603 /*
    604  * Request a page flip on the specified crtc.
    605  *
    606  * This ioctl will ask KMS to schedule a page flip for the specified
    607  * crtc.  Once any pending rendering targeting the specified fb (as of
    608  * ioctl time) has completed, the crtc will be reprogrammed to display
    609  * that fb after the next vertical refresh.  The ioctl returns
    610  * immediately, but subsequent rendering to the current fb will block
    611  * in the execbuffer ioctl until the page flip happens.  If a page
    612  * flip is already pending as the ioctl is called, EBUSY will be
    613  * returned.
    614  *
    615  * Flag DRM_MODE_PAGE_FLIP_EVENT requests that drm sends back a vblank
    616  * event (see drm.h: struct drm_event_vblank) when the page flip is
    617  * done.  The user_data field passed in with this ioctl will be
    618  * returned as the user_data field in the vblank event struct.
    619  *
    620  * Flag DRM_MODE_PAGE_FLIP_ASYNC requests that the flip happen
    621  * 'as soon as possible', meaning that it not delay waiting for vblank.
    622  * This may cause tearing on the screen.
    623  *
    624  * The reserved field must be zero.
    625  */
    626 
    627 struct drm_mode_crtc_page_flip {
    628 	__u32 crtc_id;
    629 	__u32 fb_id;
    630 	__u32 flags;
    631 	__u32 reserved;
    632 	__u64 user_data;
    633 };
    634 
    635 /*
    636  * Request a page flip on the specified crtc.
    637  *
    638  * Same as struct drm_mode_crtc_page_flip, but supports new flags and
    639  * re-purposes the reserved field:
    640  *
    641  * The sequence field must be zero unless either of the
    642  * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is specified. When
    643  * the ABSOLUTE flag is specified, the sequence field denotes the absolute
    644  * vblank sequence when the flip should take effect. When the RELATIVE
    645  * flag is specified, the sequence field denotes the relative (to the
    646  * current one when the ioctl is called) vblank sequence when the flip
    647  * should take effect. NOTE: DRM_IOCTL_WAIT_VBLANK must still be used to
    648  * make sure the vblank sequence before the target one has passed before
    649  * calling this ioctl. The purpose of the
    650  * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is merely to clarify
    651  * the target for when code dealing with a page flip runs during a
    652  * vertical blank period.
    653  */
    654 
    655 struct drm_mode_crtc_page_flip_target {
    656 	__u32 crtc_id;
    657 	__u32 fb_id;
    658 	__u32 flags;
    659 	__u32 sequence;
    660 	__u64 user_data;
    661 };
    662 
    663 /* create a dumb scanout buffer */
    664 struct drm_mode_create_dumb {
    665 	__u32 height;
    666 	__u32 width;
    667 	__u32 bpp;
    668 	__u32 flags;
    669 	/* handle, pitch, size will be returned */
    670 	__u32 handle;
    671 	__u32 pitch;
    672 	__u64 size;
    673 };
    674 
    675 /* set up for mmap of a dumb scanout buffer */
    676 struct drm_mode_map_dumb {
    677 	/** Handle for the object being mapped. */
    678 	__u32 handle;
    679 	__u32 pad;
    680 	/**
    681 	 * Fake offset to use for subsequent mmap call
    682 	 *
    683 	 * This is a fixed-size type for 32/64 compatibility.
    684 	 */
    685 	__u64 offset;
    686 };
    687 
    688 struct drm_mode_destroy_dumb {
    689 	__u32 handle;
    690 };
    691 
    692 /* page-flip flags are valid, plus: */
    693 #define DRM_MODE_ATOMIC_TEST_ONLY 0x0100
    694 #define DRM_MODE_ATOMIC_NONBLOCK  0x0200
    695 #define DRM_MODE_ATOMIC_ALLOW_MODESET 0x0400
    696 
    697 #define DRM_MODE_ATOMIC_FLAGS (\
    698 		DRM_MODE_PAGE_FLIP_EVENT |\
    699 		DRM_MODE_PAGE_FLIP_ASYNC |\
    700 		DRM_MODE_ATOMIC_TEST_ONLY |\
    701 		DRM_MODE_ATOMIC_NONBLOCK |\
    702 		DRM_MODE_ATOMIC_ALLOW_MODESET)
    703 
    704 struct drm_mode_atomic {
    705 	__u32 flags;
    706 	__u32 count_objs;
    707 	__u64 objs_ptr;
    708 	__u64 count_props_ptr;
    709 	__u64 props_ptr;
    710 	__u64 prop_values_ptr;
    711 	__u64 reserved;
    712 	__u64 user_data;
    713 };
    714 
    715 struct drm_format_modifier_blob {
    716 #define FORMAT_BLOB_CURRENT 1
    717 	/* Version of this blob format */
    718 	__u32 version;
    719 
    720 	/* Flags */
    721 	__u32 flags;
    722 
    723 	/* Number of fourcc formats supported */
    724 	__u32 count_formats;
    725 
    726 	/* Where in this blob the formats exist (in bytes) */
    727 	__u32 formats_offset;
    728 
    729 	/* Number of drm_format_modifiers */
    730 	__u32 count_modifiers;
    731 
    732 	/* Where in this blob the modifiers exist (in bytes) */
    733 	__u32 modifiers_offset;
    734 
    735 	/* __u32 formats[] */
    736 	/* struct drm_format_modifier modifiers[] */
    737 };
    738 
    739 struct drm_format_modifier {
    740 	/* Bitmask of formats in get_plane format list this info applies to. The
    741 	 * offset allows a sliding window of which 64 formats (bits).
    742 	 *
    743 	 * Some examples:
    744 	 * In today's world with < 65 formats, and formats 0, and 2 are
    745 	 * supported
    746 	 * 0x0000000000000005
    747 	 *		  ^-offset = 0, formats = 5
    748 	 *
    749 	 * If the number formats grew to 128, and formats 98-102 are
    750 	 * supported with the modifier:
    751 	 *
    752 	 * 0x0000007c00000000 0000000000000000
    753 	 *		  ^
    754 	 *		  |__offset = 64, formats = 0x7c00000000
    755 	 *
    756 	 */
    757 	__u64 formats;
    758 	__u32 offset;
    759 	__u32 pad;
    760 
    761 	/* The modifier that applies to the >get_plane format list bitmask. */
    762 	__u64 modifier;
    763 };
    764 
    765 /**
    766  * Create a new 'blob' data property, copying length bytes from data pointer,
    767  * and returning new blob ID.
    768  */
    769 struct drm_mode_create_blob {
    770 	/** Pointer to data to copy. */
    771 	__u64 data;
    772 	/** Length of data to copy. */
    773 	__u32 length;
    774 	/** Return: new property ID. */
    775 	__u32 blob_id;
    776 };
    777 
    778 /**
    779  * Destroy a user-created blob property.
    780  */
    781 struct drm_mode_destroy_blob {
    782 	__u32 blob_id;
    783 };
    784 
    785 /**
    786  * Lease mode resources, creating another drm_master.
    787  */
    788 struct drm_mode_create_lease {
    789 	/** Pointer to array of object ids (__u32) */
    790 	__u64 object_ids;
    791 	/** Number of object ids */
    792 	__u32 object_count;
    793 	/** flags for new FD (O_CLOEXEC, etc) */
    794 	__u32 flags;
    795 
    796 	/** Return: unique identifier for lessee. */
    797 	__u32 lessee_id;
    798 	/** Return: file descriptor to new drm_master file */
    799 	__u32 fd;
    800 };
    801 
    802 /**
    803  * List lesses from a drm_master
    804  */
    805 struct drm_mode_list_lessees {
    806 	/** Number of lessees.
    807 	 * On input, provides length of the array.
    808 	 * On output, provides total number. No
    809 	 * more than the input number will be written
    810 	 * back, so two calls can be used to get
    811 	 * the size and then the data.
    812 	 */
    813 	__u32 count_lessees;
    814 	__u32 pad;
    815 
    816 	/** Pointer to lessees.
    817 	 * pointer to __u64 array of lessee ids
    818 	 */
    819 	__u64 lessees_ptr;
    820 };
    821 
    822 /**
    823  * Get leased objects
    824  */
    825 struct drm_mode_get_lease {
    826 	/** Number of leased objects.
    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_objects;
    834 	__u32 pad;
    835 
    836 	/** Pointer to objects.
    837 	 * pointer to __u32 array of object ids
    838 	 */
    839 	__u64 objects_ptr;
    840 };
    841 
    842 /**
    843  * Revoke lease
    844  */
    845 struct drm_mode_revoke_lease {
    846 	/** Unique ID of lessee
    847 	 */
    848 	__u32 lessee_id;
    849 };
    850 
    851 #if defined(__cplusplus)
    852 }
    853 #endif
    854 
    855 #endif
    856