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