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