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