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