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