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