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