xref: /linux/include/uapi/drm/drm_mode.h (revision e08a1d97d33e2ac05cd368b955f9fdc2823f15fd)
1 /*
2  * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
3  * Copyright (c) 2007 Jakob Bornecrantz <wallbraker@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 xorg definitions. */
51 #define DRM_MODE_FLAG_PHSYNC			(1<<0)
52 #define DRM_MODE_FLAG_NHSYNC			(1<<1)
53 #define DRM_MODE_FLAG_PVSYNC			(1<<2)
54 #define DRM_MODE_FLAG_NVSYNC			(1<<3)
55 #define DRM_MODE_FLAG_INTERLACE			(1<<4)
56 #define DRM_MODE_FLAG_DBLSCAN			(1<<5)
57 #define DRM_MODE_FLAG_CSYNC			(1<<6)
58 #define DRM_MODE_FLAG_PCSYNC			(1<<7)
59 #define DRM_MODE_FLAG_NCSYNC			(1<<8)
60 #define DRM_MODE_FLAG_HSKEW			(1<<9) /* hskew provided */
61 #define DRM_MODE_FLAG_BCAST			(1<<10)
62 #define DRM_MODE_FLAG_PIXMUX			(1<<11)
63 #define DRM_MODE_FLAG_DBLCLK			(1<<12)
64 #define DRM_MODE_FLAG_CLKDIV2			(1<<13)
65  /*
66   * When adding a new stereo mode don't forget to adjust DRM_MODE_FLAGS_3D_MAX
67   * (define not exposed to user space).
68   */
69 #define DRM_MODE_FLAG_3D_MASK			(0x1f<<14)
70 #define  DRM_MODE_FLAG_3D_NONE			(0<<14)
71 #define  DRM_MODE_FLAG_3D_FRAME_PACKING		(1<<14)
72 #define  DRM_MODE_FLAG_3D_FIELD_ALTERNATIVE	(2<<14)
73 #define  DRM_MODE_FLAG_3D_LINE_ALTERNATIVE	(3<<14)
74 #define  DRM_MODE_FLAG_3D_SIDE_BY_SIDE_FULL	(4<<14)
75 #define  DRM_MODE_FLAG_3D_L_DEPTH		(5<<14)
76 #define  DRM_MODE_FLAG_3D_L_DEPTH_GFX_GFX_DEPTH	(6<<14)
77 #define  DRM_MODE_FLAG_3D_TOP_AND_BOTTOM	(7<<14)
78 #define  DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF	(8<<14)
79 
80 /* Picture aspect ratio options */
81 #define DRM_MODE_PICTURE_ASPECT_NONE		0
82 #define DRM_MODE_PICTURE_ASPECT_4_3		1
83 #define DRM_MODE_PICTURE_ASPECT_16_9		2
84 #define DRM_MODE_PICTURE_ASPECT_64_27		3
85 #define DRM_MODE_PICTURE_ASPECT_256_135		4
86 
87 /* Aspect ratio flag bitmask (4 bits 22:19) */
88 #define DRM_MODE_FLAG_PIC_AR_MASK		(0x0F<<19)
89 #define  DRM_MODE_FLAG_PIC_AR_NONE \
90 			(DRM_MODE_PICTURE_ASPECT_NONE<<19)
91 #define  DRM_MODE_FLAG_PIC_AR_4_3 \
92 			(DRM_MODE_PICTURE_ASPECT_4_3<<19)
93 #define  DRM_MODE_FLAG_PIC_AR_16_9 \
94 			(DRM_MODE_PICTURE_ASPECT_16_9<<19)
95 #define  DRM_MODE_FLAG_PIC_AR_64_27 \
96 			(DRM_MODE_PICTURE_ASPECT_64_27<<19)
97 #define  DRM_MODE_FLAG_PIC_AR_256_135 \
98 			(DRM_MODE_PICTURE_ASPECT_256_135<<19)
99 
100 /* DPMS flags */
101 /* bit compatible with the xorg definitions. */
102 #define DRM_MODE_DPMS_ON	0
103 #define DRM_MODE_DPMS_STANDBY	1
104 #define DRM_MODE_DPMS_SUSPEND	2
105 #define DRM_MODE_DPMS_OFF	3
106 
107 /* Scaling mode options */
108 #define DRM_MODE_SCALE_NONE		0 /* Unmodified timing (display or
109 					     software can still scale) */
110 #define DRM_MODE_SCALE_FULLSCREEN	1 /* Full screen, ignore aspect */
111 #define DRM_MODE_SCALE_CENTER		2 /* Centered, no scaling */
112 #define DRM_MODE_SCALE_ASPECT		3 /* Full screen, preserve aspect */
113 
114 /* Dithering mode options */
115 #define DRM_MODE_DITHERING_OFF	0
116 #define DRM_MODE_DITHERING_ON	1
117 #define DRM_MODE_DITHERING_AUTO 2
118 
119 /* Dirty info options */
120 #define DRM_MODE_DIRTY_OFF      0
121 #define DRM_MODE_DIRTY_ON       1
122 #define DRM_MODE_DIRTY_ANNOTATE 2
123 
124 struct drm_mode_modeinfo {
125 	__u32 clock;
126 	__u16 hdisplay;
127 	__u16 hsync_start;
128 	__u16 hsync_end;
129 	__u16 htotal;
130 	__u16 hskew;
131 	__u16 vdisplay;
132 	__u16 vsync_start;
133 	__u16 vsync_end;
134 	__u16 vtotal;
135 	__u16 vscan;
136 
137 	__u32 vrefresh;
138 
139 	__u32 flags;
140 	__u32 type;
141 	char name[DRM_DISPLAY_MODE_LEN];
142 };
143 
144 struct drm_mode_card_res {
145 	__u64 fb_id_ptr;
146 	__u64 crtc_id_ptr;
147 	__u64 connector_id_ptr;
148 	__u64 encoder_id_ptr;
149 	__u32 count_fbs;
150 	__u32 count_crtcs;
151 	__u32 count_connectors;
152 	__u32 count_encoders;
153 	__u32 min_width;
154 	__u32 max_width;
155 	__u32 min_height;
156 	__u32 max_height;
157 };
158 
159 struct drm_mode_crtc {
160 	__u64 set_connectors_ptr;
161 	__u32 count_connectors;
162 
163 	__u32 crtc_id; /**< Id */
164 	__u32 fb_id; /**< Id of framebuffer */
165 
166 	__u32 x; /**< x Position on the framebuffer */
167 	__u32 y; /**< y Position on the framebuffer */
168 
169 	__u32 gamma_size;
170 	__u32 mode_valid;
171 	struct drm_mode_modeinfo mode;
172 };
173 
174 #define DRM_MODE_PRESENT_TOP_FIELD	(1<<0)
175 #define DRM_MODE_PRESENT_BOTTOM_FIELD	(1<<1)
176 
177 /* Planes blend with or override other bits on the CRTC */
178 struct drm_mode_set_plane {
179 	__u32 plane_id;
180 	__u32 crtc_id;
181 	__u32 fb_id; /* fb object contains surface format type */
182 	__u32 flags; /* see above flags */
183 
184 	/* Signed dest location allows it to be partially off screen */
185 	__s32 crtc_x;
186 	__s32 crtc_y;
187 	__u32 crtc_w;
188 	__u32 crtc_h;
189 
190 	/* Source values are 16.16 fixed point */
191 	__u32 src_x;
192 	__u32 src_y;
193 	__u32 src_h;
194 	__u32 src_w;
195 };
196 
197 struct drm_mode_get_plane {
198 	__u32 plane_id;
199 
200 	__u32 crtc_id;
201 	__u32 fb_id;
202 
203 	__u32 possible_crtcs;
204 	__u32 gamma_size;
205 
206 	__u32 count_format_types;
207 	__u64 format_type_ptr;
208 };
209 
210 struct drm_mode_get_plane_res {
211 	__u64 plane_id_ptr;
212 	__u32 count_planes;
213 };
214 
215 #define DRM_MODE_ENCODER_NONE	0
216 #define DRM_MODE_ENCODER_DAC	1
217 #define DRM_MODE_ENCODER_TMDS	2
218 #define DRM_MODE_ENCODER_LVDS	3
219 #define DRM_MODE_ENCODER_TVDAC	4
220 #define DRM_MODE_ENCODER_VIRTUAL 5
221 #define DRM_MODE_ENCODER_DSI	6
222 #define DRM_MODE_ENCODER_DPMST	7
223 #define DRM_MODE_ENCODER_DPI	8
224 
225 struct drm_mode_get_encoder {
226 	__u32 encoder_id;
227 	__u32 encoder_type;
228 
229 	__u32 crtc_id; /**< Id of crtc */
230 
231 	__u32 possible_crtcs;
232 	__u32 possible_clones;
233 };
234 
235 /* This is for connectors with multiple signal types. */
236 /* Try to match DRM_MODE_CONNECTOR_X as closely as possible. */
237 #define DRM_MODE_SUBCONNECTOR_Automatic	0
238 #define DRM_MODE_SUBCONNECTOR_Unknown	0
239 #define DRM_MODE_SUBCONNECTOR_DVID	3
240 #define DRM_MODE_SUBCONNECTOR_DVIA	4
241 #define DRM_MODE_SUBCONNECTOR_Composite	5
242 #define DRM_MODE_SUBCONNECTOR_SVIDEO	6
243 #define DRM_MODE_SUBCONNECTOR_Component	8
244 #define DRM_MODE_SUBCONNECTOR_SCART	9
245 
246 #define DRM_MODE_CONNECTOR_Unknown	0
247 #define DRM_MODE_CONNECTOR_VGA		1
248 #define DRM_MODE_CONNECTOR_DVII		2
249 #define DRM_MODE_CONNECTOR_DVID		3
250 #define DRM_MODE_CONNECTOR_DVIA		4
251 #define DRM_MODE_CONNECTOR_Composite	5
252 #define DRM_MODE_CONNECTOR_SVIDEO	6
253 #define DRM_MODE_CONNECTOR_LVDS		7
254 #define DRM_MODE_CONNECTOR_Component	8
255 #define DRM_MODE_CONNECTOR_9PinDIN	9
256 #define DRM_MODE_CONNECTOR_DisplayPort	10
257 #define DRM_MODE_CONNECTOR_HDMIA	11
258 #define DRM_MODE_CONNECTOR_HDMIB	12
259 #define DRM_MODE_CONNECTOR_TV		13
260 #define DRM_MODE_CONNECTOR_eDP		14
261 #define DRM_MODE_CONNECTOR_VIRTUAL      15
262 #define DRM_MODE_CONNECTOR_DSI		16
263 #define DRM_MODE_CONNECTOR_DPI		17
264 
265 struct drm_mode_get_connector {
266 
267 	__u64 encoders_ptr;
268 	__u64 modes_ptr;
269 	__u64 props_ptr;
270 	__u64 prop_values_ptr;
271 
272 	__u32 count_modes;
273 	__u32 count_props;
274 	__u32 count_encoders;
275 
276 	__u32 encoder_id; /**< Current Encoder */
277 	__u32 connector_id; /**< Id */
278 	__u32 connector_type;
279 	__u32 connector_type_id;
280 
281 	__u32 connection;
282 	__u32 mm_width;  /**< width in millimeters */
283 	__u32 mm_height; /**< height in millimeters */
284 	__u32 subpixel;
285 
286 	__u32 pad;
287 };
288 
289 #define DRM_MODE_PROP_PENDING	(1<<0)
290 #define DRM_MODE_PROP_RANGE	(1<<1)
291 #define DRM_MODE_PROP_IMMUTABLE	(1<<2)
292 #define DRM_MODE_PROP_ENUM	(1<<3) /* enumerated type with text strings */
293 #define DRM_MODE_PROP_BLOB	(1<<4)
294 #define DRM_MODE_PROP_BITMASK	(1<<5) /* bitmask of enumerated types */
295 
296 /* non-extended types: legacy bitmask, one bit per type: */
297 #define DRM_MODE_PROP_LEGACY_TYPE  ( \
298 		DRM_MODE_PROP_RANGE | \
299 		DRM_MODE_PROP_ENUM | \
300 		DRM_MODE_PROP_BLOB | \
301 		DRM_MODE_PROP_BITMASK)
302 
303 /* extended-types: rather than continue to consume a bit per type,
304  * grab a chunk of the bits to use as integer type id.
305  */
306 #define DRM_MODE_PROP_EXTENDED_TYPE	0x0000ffc0
307 #define DRM_MODE_PROP_TYPE(n)		((n) << 6)
308 #define DRM_MODE_PROP_OBJECT		DRM_MODE_PROP_TYPE(1)
309 #define DRM_MODE_PROP_SIGNED_RANGE	DRM_MODE_PROP_TYPE(2)
310 
311 /* the PROP_ATOMIC flag is used to hide properties from userspace that
312  * is not aware of atomic properties.  This is mostly to work around
313  * older userspace (DDX drivers) that read/write each prop they find,
314  * witout being aware that this could be triggering a lengthy modeset.
315  */
316 #define DRM_MODE_PROP_ATOMIC        0x80000000
317 
318 struct drm_mode_property_enum {
319 	__u64 value;
320 	char name[DRM_PROP_NAME_LEN];
321 };
322 
323 struct drm_mode_get_property {
324 	__u64 values_ptr; /* values and blob lengths */
325 	__u64 enum_blob_ptr; /* enum and blob id ptrs */
326 
327 	__u32 prop_id;
328 	__u32 flags;
329 	char name[DRM_PROP_NAME_LEN];
330 
331 	__u32 count_values;
332 	/* This is only used to count enum values, not blobs. The _blobs is
333 	 * simply because of a historical reason, i.e. backwards compat. */
334 	__u32 count_enum_blobs;
335 };
336 
337 struct drm_mode_connector_set_property {
338 	__u64 value;
339 	__u32 prop_id;
340 	__u32 connector_id;
341 };
342 
343 #define DRM_MODE_OBJECT_CRTC 0xcccccccc
344 #define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
345 #define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
346 #define DRM_MODE_OBJECT_MODE 0xdededede
347 #define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
348 #define DRM_MODE_OBJECT_FB 0xfbfbfbfb
349 #define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
350 #define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
351 #define DRM_MODE_OBJECT_ANY 0
352 
353 struct drm_mode_obj_get_properties {
354 	__u64 props_ptr;
355 	__u64 prop_values_ptr;
356 	__u32 count_props;
357 	__u32 obj_id;
358 	__u32 obj_type;
359 };
360 
361 struct drm_mode_obj_set_property {
362 	__u64 value;
363 	__u32 prop_id;
364 	__u32 obj_id;
365 	__u32 obj_type;
366 };
367 
368 struct drm_mode_get_blob {
369 	__u32 blob_id;
370 	__u32 length;
371 	__u64 data;
372 };
373 
374 struct drm_mode_fb_cmd {
375 	__u32 fb_id;
376 	__u32 width;
377 	__u32 height;
378 	__u32 pitch;
379 	__u32 bpp;
380 	__u32 depth;
381 	/* driver specific handle */
382 	__u32 handle;
383 };
384 
385 #define DRM_MODE_FB_INTERLACED	(1<<0) /* for interlaced framebuffers */
386 #define DRM_MODE_FB_MODIFIERS	(1<<1) /* enables ->modifer[] */
387 
388 struct drm_mode_fb_cmd2 {
389 	__u32 fb_id;
390 	__u32 width;
391 	__u32 height;
392 	__u32 pixel_format; /* fourcc code from drm_fourcc.h */
393 	__u32 flags; /* see above flags */
394 
395 	/*
396 	 * In case of planar formats, this ioctl allows up to 4
397 	 * buffer objects with offsets and pitches per plane.
398 	 * The pitch and offset order is dictated by the fourcc,
399 	 * e.g. NV12 (http://fourcc.org/yuv.php#NV12) is described as:
400 	 *
401 	 *   YUV 4:2:0 image with a plane of 8 bit Y samples
402 	 *   followed by an interleaved U/V plane containing
403 	 *   8 bit 2x2 subsampled colour difference samples.
404 	 *
405 	 * So it would consist of Y as offsets[0] and UV as
406 	 * offsets[1].  Note that offsets[0] will generally
407 	 * be 0 (but this is not required).
408 	 *
409 	 * To accommodate tiled, compressed, etc formats, a per-plane
410 	 * modifier can be specified.  The default value of zero
411 	 * indicates "native" format as specified by the fourcc.
412 	 * Vendor specific modifier token.  This allows, for example,
413 	 * different tiling/swizzling pattern on different planes.
414 	 * See discussion above of DRM_FORMAT_MOD_xxx.
415 	 */
416 	__u32 handles[4];
417 	__u32 pitches[4]; /* pitch for each plane */
418 	__u32 offsets[4]; /* offset of each plane */
419 	__u64 modifier[4]; /* ie, tiling, compressed (per plane) */
420 };
421 
422 #define DRM_MODE_FB_DIRTY_ANNOTATE_COPY 0x01
423 #define DRM_MODE_FB_DIRTY_ANNOTATE_FILL 0x02
424 #define DRM_MODE_FB_DIRTY_FLAGS         0x03
425 
426 #define DRM_MODE_FB_DIRTY_MAX_CLIPS     256
427 
428 /*
429  * Mark a region of a framebuffer as dirty.
430  *
431  * Some hardware does not automatically update display contents
432  * as a hardware or software draw to a framebuffer. This ioctl
433  * allows userspace to tell the kernel and the hardware what
434  * regions of the framebuffer have changed.
435  *
436  * The kernel or hardware is free to update more then just the
437  * region specified by the clip rects. The kernel or hardware
438  * may also delay and/or coalesce several calls to dirty into a
439  * single update.
440  *
441  * Userspace may annotate the updates, the annotates are a
442  * promise made by the caller that the change is either a copy
443  * of pixels or a fill of a single color in the region specified.
444  *
445  * If the DRM_MODE_FB_DIRTY_ANNOTATE_COPY flag is given then
446  * the number of updated regions are half of num_clips given,
447  * where the clip rects are paired in src and dst. The width and
448  * height of each one of the pairs must match.
449  *
450  * If the DRM_MODE_FB_DIRTY_ANNOTATE_FILL flag is given the caller
451  * promises that the region specified of the clip rects is filled
452  * completely with a single color as given in the color argument.
453  */
454 
455 struct drm_mode_fb_dirty_cmd {
456 	__u32 fb_id;
457 	__u32 flags;
458 	__u32 color;
459 	__u32 num_clips;
460 	__u64 clips_ptr;
461 };
462 
463 struct drm_mode_mode_cmd {
464 	__u32 connector_id;
465 	struct drm_mode_modeinfo mode;
466 };
467 
468 #define DRM_MODE_CURSOR_BO	0x01
469 #define DRM_MODE_CURSOR_MOVE	0x02
470 #define DRM_MODE_CURSOR_FLAGS	0x03
471 
472 /*
473  * depending on the value in flags different members are used.
474  *
475  * CURSOR_BO uses
476  *    crtc_id
477  *    width
478  *    height
479  *    handle - if 0 turns the cursor off
480  *
481  * CURSOR_MOVE uses
482  *    crtc_id
483  *    x
484  *    y
485  */
486 struct drm_mode_cursor {
487 	__u32 flags;
488 	__u32 crtc_id;
489 	__s32 x;
490 	__s32 y;
491 	__u32 width;
492 	__u32 height;
493 	/* driver specific handle */
494 	__u32 handle;
495 };
496 
497 struct drm_mode_cursor2 {
498 	__u32 flags;
499 	__u32 crtc_id;
500 	__s32 x;
501 	__s32 y;
502 	__u32 width;
503 	__u32 height;
504 	/* driver specific handle */
505 	__u32 handle;
506 	__s32 hot_x;
507 	__s32 hot_y;
508 };
509 
510 struct drm_mode_crtc_lut {
511 	__u32 crtc_id;
512 	__u32 gamma_size;
513 
514 	/* pointers to arrays */
515 	__u64 red;
516 	__u64 green;
517 	__u64 blue;
518 };
519 
520 struct drm_color_ctm {
521 	/* Conversion matrix in S31.32 format. */
522 	__s64 matrix[9];
523 };
524 
525 struct drm_color_lut {
526 	/*
527 	 * Data is U0.16 fixed point format.
528 	 */
529 	__u16 red;
530 	__u16 green;
531 	__u16 blue;
532 	__u16 reserved;
533 };
534 
535 #define DRM_MODE_PAGE_FLIP_EVENT 0x01
536 #define DRM_MODE_PAGE_FLIP_ASYNC 0x02
537 #define DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE 0x4
538 #define DRM_MODE_PAGE_FLIP_TARGET_RELATIVE 0x8
539 #define DRM_MODE_PAGE_FLIP_TARGET (DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE | \
540 				   DRM_MODE_PAGE_FLIP_TARGET_RELATIVE)
541 #define DRM_MODE_PAGE_FLIP_FLAGS (DRM_MODE_PAGE_FLIP_EVENT | \
542 				  DRM_MODE_PAGE_FLIP_ASYNC | \
543 				  DRM_MODE_PAGE_FLIP_TARGET)
544 
545 /*
546  * Request a page flip on the specified crtc.
547  *
548  * This ioctl will ask KMS to schedule a page flip for the specified
549  * crtc.  Once any pending rendering targeting the specified fb (as of
550  * ioctl time) has completed, the crtc will be reprogrammed to display
551  * that fb after the next vertical refresh.  The ioctl returns
552  * immediately, but subsequent rendering to the current fb will block
553  * in the execbuffer ioctl until the page flip happens.  If a page
554  * flip is already pending as the ioctl is called, EBUSY will be
555  * returned.
556  *
557  * Flag DRM_MODE_PAGE_FLIP_EVENT requests that drm sends back a vblank
558  * event (see drm.h: struct drm_event_vblank) when the page flip is
559  * done.  The user_data field passed in with this ioctl will be
560  * returned as the user_data field in the vblank event struct.
561  *
562  * Flag DRM_MODE_PAGE_FLIP_ASYNC requests that the flip happen
563  * 'as soon as possible', meaning that it not delay waiting for vblank.
564  * This may cause tearing on the screen.
565  *
566  * The reserved field must be zero.
567  */
568 
569 struct drm_mode_crtc_page_flip {
570 	__u32 crtc_id;
571 	__u32 fb_id;
572 	__u32 flags;
573 	__u32 reserved;
574 	__u64 user_data;
575 };
576 
577 /*
578  * Request a page flip on the specified crtc.
579  *
580  * Same as struct drm_mode_crtc_page_flip, but supports new flags and
581  * re-purposes the reserved field:
582  *
583  * The sequence field must be zero unless either of the
584  * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is specified. When
585  * the ABSOLUTE flag is specified, the sequence field denotes the absolute
586  * vblank sequence when the flip should take effect. When the RELATIVE
587  * flag is specified, the sequence field denotes the relative (to the
588  * current one when the ioctl is called) vblank sequence when the flip
589  * should take effect. NOTE: DRM_IOCTL_WAIT_VBLANK must still be used to
590  * make sure the vblank sequence before the target one has passed before
591  * calling this ioctl. The purpose of the
592  * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is merely to clarify
593  * the target for when code dealing with a page flip runs during a
594  * vertical blank period.
595  */
596 
597 struct drm_mode_crtc_page_flip_target {
598 	__u32 crtc_id;
599 	__u32 fb_id;
600 	__u32 flags;
601 	__u32 sequence;
602 	__u64 user_data;
603 };
604 
605 /* create a dumb scanout buffer */
606 struct drm_mode_create_dumb {
607 	__u32 height;
608 	__u32 width;
609 	__u32 bpp;
610 	__u32 flags;
611 	/* handle, pitch, size will be returned */
612 	__u32 handle;
613 	__u32 pitch;
614 	__u64 size;
615 };
616 
617 /* set up for mmap of a dumb scanout buffer */
618 struct drm_mode_map_dumb {
619 	/** Handle for the object being mapped. */
620 	__u32 handle;
621 	__u32 pad;
622 	/**
623 	 * Fake offset to use for subsequent mmap call
624 	 *
625 	 * This is a fixed-size type for 32/64 compatibility.
626 	 */
627 	__u64 offset;
628 };
629 
630 struct drm_mode_destroy_dumb {
631 	__u32 handle;
632 };
633 
634 /* page-flip flags are valid, plus: */
635 #define DRM_MODE_ATOMIC_TEST_ONLY 0x0100
636 #define DRM_MODE_ATOMIC_NONBLOCK  0x0200
637 #define DRM_MODE_ATOMIC_ALLOW_MODESET 0x0400
638 
639 #define DRM_MODE_ATOMIC_FLAGS (\
640 		DRM_MODE_PAGE_FLIP_EVENT |\
641 		DRM_MODE_PAGE_FLIP_ASYNC |\
642 		DRM_MODE_ATOMIC_TEST_ONLY |\
643 		DRM_MODE_ATOMIC_NONBLOCK |\
644 		DRM_MODE_ATOMIC_ALLOW_MODESET)
645 
646 struct drm_mode_atomic {
647 	__u32 flags;
648 	__u32 count_objs;
649 	__u64 objs_ptr;
650 	__u64 count_props_ptr;
651 	__u64 props_ptr;
652 	__u64 prop_values_ptr;
653 	__u64 reserved;
654 	__u64 user_data;
655 };
656 
657 /**
658  * Create a new 'blob' data property, copying length bytes from data pointer,
659  * and returning new blob ID.
660  */
661 struct drm_mode_create_blob {
662 	/** Pointer to data to copy. */
663 	__u64 data;
664 	/** Length of data to copy. */
665 	__u32 length;
666 	/** Return: new property ID. */
667 	__u32 blob_id;
668 };
669 
670 /**
671  * Destroy a user-created blob property.
672  */
673 struct drm_mode_destroy_blob {
674 	__u32 blob_id;
675 };
676 
677 #if defined(__cplusplus)
678 }
679 #endif
680 
681 #endif
682