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