blob: 9c927a539b1e5328be19756382003c2e92434277 [file] [log] [blame]
Dave Airlief453ba02008-11-07 14:05:41 -08001/*
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
Gabriel Laskarabd54222015-11-30 15:10:43 +010030#include "drm.h"
Bobby Powers10db4e12012-03-23 15:01:51 -070031
Emil Velikovebbb0e52016-04-07 18:49:00 +010032#if defined(__cplusplus)
33extern "C" {
34#endif
35
Jakob Bornecrantze0c84632008-12-19 14:50:50 +100036#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
Dave Airlief453ba02008-11-07 14:05:41 -080040
41#define DRM_MODE_TYPE_BUILTIN (1<<0)
42#define DRM_MODE_TYPE_CLOCK_C ((1<<1) | DRM_MODE_TYPE_BUILTIN)
43#define DRM_MODE_TYPE_CRTC_C ((1<<2) | DRM_MODE_TYPE_BUILTIN)
44#define DRM_MODE_TYPE_PREFERRED (1<<3)
45#define DRM_MODE_TYPE_DEFAULT (1<<4)
46#define DRM_MODE_TYPE_USERDEF (1<<5)
47#define DRM_MODE_TYPE_DRIVER (1<<6)
48
49/* Video mode flags */
50/* bit compatible with the xorg definitions. */
Damien Lespiau4aa17cf2013-09-25 16:45:21 +010051#define DRM_MODE_FLAG_PHSYNC (1<<0)
52#define DRM_MODE_FLAG_NHSYNC (1<<1)
53#define DRM_MODE_FLAG_PVSYNC (1<<2)
54#define DRM_MODE_FLAG_NVSYNC (1<<3)
55#define DRM_MODE_FLAG_INTERLACE (1<<4)
56#define DRM_MODE_FLAG_DBLSCAN (1<<5)
57#define DRM_MODE_FLAG_CSYNC (1<<6)
58#define DRM_MODE_FLAG_PCSYNC (1<<7)
59#define DRM_MODE_FLAG_NCSYNC (1<<8)
60#define DRM_MODE_FLAG_HSKEW (1<<9) /* hskew provided */
61#define DRM_MODE_FLAG_BCAST (1<<10)
62#define DRM_MODE_FLAG_PIXMUX (1<<11)
63#define DRM_MODE_FLAG_DBLCLK (1<<12)
64#define DRM_MODE_FLAG_CLKDIV2 (1<<13)
Damien Lespiau5848ad42013-09-27 12:11:50 +010065 /*
66 * When adding a new stereo mode don't forget to adjust DRM_MODE_FLAGS_3D_MAX
67 * (define not exposed to user space).
68 */
Damien Lespiauf7e121b2013-09-27 12:11:48 +010069#define DRM_MODE_FLAG_3D_MASK (0x1f<<14)
70#define DRM_MODE_FLAG_3D_NONE (0<<14)
71#define DRM_MODE_FLAG_3D_FRAME_PACKING (1<<14)
72#define DRM_MODE_FLAG_3D_FIELD_ALTERNATIVE (2<<14)
73#define DRM_MODE_FLAG_3D_LINE_ALTERNATIVE (3<<14)
74#define DRM_MODE_FLAG_3D_SIDE_BY_SIDE_FULL (4<<14)
75#define DRM_MODE_FLAG_3D_L_DEPTH (5<<14)
76#define DRM_MODE_FLAG_3D_L_DEPTH_GFX_GFX_DEPTH (6<<14)
77#define DRM_MODE_FLAG_3D_TOP_AND_BOTTOM (7<<14)
78#define DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF (8<<14)
Lloyd Atkinsonaf7952d2016-06-26 22:41:26 -040079#define DRM_MODE_FLAG_SEAMLESS (1<<19)
Padmanabhan Komandurubb107cf2017-05-03 13:37:39 -070080#define DRM_MODE_FLAG_SUPPORTS_RGB (1<<20)
81#define DRM_MODE_FLAG_SUPPORTS_YUV (1<<21)
Dave Airlief453ba02008-11-07 14:05:41 -080082
83/* DPMS flags */
84/* bit compatible with the xorg definitions. */
Jakob Bornecrantze0c84632008-12-19 14:50:50 +100085#define DRM_MODE_DPMS_ON 0
86#define DRM_MODE_DPMS_STANDBY 1
87#define DRM_MODE_DPMS_SUSPEND 2
88#define DRM_MODE_DPMS_OFF 3
Dave Airlief453ba02008-11-07 14:05:41 -080089
90/* Scaling mode options */
Jesse Barnes53bd8382009-07-01 10:04:40 -070091#define DRM_MODE_SCALE_NONE 0 /* Unmodified timing (display or
92 software can still scale) */
93#define DRM_MODE_SCALE_FULLSCREEN 1 /* Full screen, ignore aspect */
94#define DRM_MODE_SCALE_CENTER 2 /* Centered, no scaling */
95#define DRM_MODE_SCALE_ASPECT 3 /* Full screen, preserve aspect */
Dave Airlief453ba02008-11-07 14:05:41 -080096
Vandana Kannanff587e42014-06-11 10:46:48 +053097/* Picture aspect ratio options */
98#define DRM_MODE_PICTURE_ASPECT_NONE 0
99#define DRM_MODE_PICTURE_ASPECT_4_3 1
100#define DRM_MODE_PICTURE_ASPECT_16_9 2
101
Dave Airlief453ba02008-11-07 14:05:41 -0800102/* Dithering mode options */
Jakob Bornecrantze0c84632008-12-19 14:50:50 +1000103#define DRM_MODE_DITHERING_OFF 0
104#define DRM_MODE_DITHERING_ON 1
Ben Skeggs92897b52010-07-16 15:09:17 +1000105#define DRM_MODE_DITHERING_AUTO 2
Dave Airlief453ba02008-11-07 14:05:41 -0800106
Jakob Bornecrantz884840a2009-12-03 23:25:47 +0000107/* Dirty info options */
108#define DRM_MODE_DIRTY_OFF 0
109#define DRM_MODE_DIRTY_ON 1
110#define DRM_MODE_DIRTY_ANNOTATE 2
111
Dave Airlief453ba02008-11-07 14:05:41 -0800112struct drm_mode_modeinfo {
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100113 __u32 clock;
Rob Clarkbbda9c12015-08-19 19:21:14 -0400114 __u16 hdisplay;
115 __u16 hsync_start;
116 __u16 hsync_end;
117 __u16 htotal;
118 __u16 hskew;
119 __u16 vdisplay;
120 __u16 vsync_start;
121 __u16 vsync_end;
122 __u16 vtotal;
123 __u16 vscan;
Dave Airlief453ba02008-11-07 14:05:41 -0800124
Marcin Kościelnickifa5829b2010-01-23 10:25:28 +1000125 __u32 vrefresh;
Dave Airlief453ba02008-11-07 14:05:41 -0800126
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100127 __u32 flags;
128 __u32 type;
Dave Airlief453ba02008-11-07 14:05:41 -0800129 char name[DRM_DISPLAY_MODE_LEN];
130};
131
132struct drm_mode_card_res {
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100133 __u64 fb_id_ptr;
134 __u64 crtc_id_ptr;
135 __u64 connector_id_ptr;
136 __u64 encoder_id_ptr;
137 __u32 count_fbs;
138 __u32 count_crtcs;
139 __u32 count_connectors;
140 __u32 count_encoders;
Rob Clarkbbda9c12015-08-19 19:21:14 -0400141 __u32 min_width;
142 __u32 max_width;
143 __u32 min_height;
144 __u32 max_height;
Dave Airlief453ba02008-11-07 14:05:41 -0800145};
146
147struct drm_mode_crtc {
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100148 __u64 set_connectors_ptr;
149 __u32 count_connectors;
Dave Airlief453ba02008-11-07 14:05:41 -0800150
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100151 __u32 crtc_id; /**< Id */
152 __u32 fb_id; /**< Id of framebuffer */
Dave Airlief453ba02008-11-07 14:05:41 -0800153
Rob Clarkbbda9c12015-08-19 19:21:14 -0400154 __u32 x; /**< x Position on the framebuffer */
155 __u32 y; /**< y Position on the framebuffer */
Dave Airlief453ba02008-11-07 14:05:41 -0800156
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100157 __u32 gamma_size;
158 __u32 mode_valid;
Dave Airlief453ba02008-11-07 14:05:41 -0800159 struct drm_mode_modeinfo mode;
160};
161
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800162#define DRM_MODE_PRESENT_TOP_FIELD (1<<0)
163#define DRM_MODE_PRESENT_BOTTOM_FIELD (1<<1)
164
165/* Planes blend with or override other bits on the CRTC */
166struct drm_mode_set_plane {
167 __u32 plane_id;
168 __u32 crtc_id;
169 __u32 fb_id; /* fb object contains surface format type */
170 __u32 flags; /* see above flags */
171
172 /* Signed dest location allows it to be partially off screen */
Rob Clarkbbda9c12015-08-19 19:21:14 -0400173 __s32 crtc_x;
174 __s32 crtc_y;
175 __u32 crtc_w;
176 __u32 crtc_h;
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800177
178 /* Source values are 16.16 fixed point */
Rob Clarkbbda9c12015-08-19 19:21:14 -0400179 __u32 src_x;
180 __u32 src_y;
181 __u32 src_h;
182 __u32 src_w;
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800183};
184
185struct drm_mode_get_plane {
186 __u32 plane_id;
187
188 __u32 crtc_id;
189 __u32 fb_id;
190
191 __u32 possible_crtcs;
192 __u32 gamma_size;
193
194 __u32 count_format_types;
195 __u64 format_type_ptr;
196};
197
198struct drm_mode_get_plane_res {
199 __u64 plane_id_ptr;
200 __u32 count_planes;
201};
202
203#define DRM_MODE_ENCODER_NONE 0
204#define DRM_MODE_ENCODER_DAC 1
205#define DRM_MODE_ENCODER_TMDS 2
206#define DRM_MODE_ENCODER_LVDS 3
207#define DRM_MODE_ENCODER_TVDAC 4
Thomas Hellstroma7331e52011-10-22 10:36:19 +0200208#define DRM_MODE_ENCODER_VIRTUAL 5
Shobhit Kumarb8923272013-08-27 15:12:13 +0300209#define DRM_MODE_ENCODER_DSI 6
Dave Airlie182407a2014-05-02 11:09:54 +1000210#define DRM_MODE_ENCODER_DPMST 7
Eric Anholt0b27c022016-03-18 12:34:59 -0700211#define DRM_MODE_ENCODER_DPI 8
Dave Airlief453ba02008-11-07 14:05:41 -0800212
213struct drm_mode_get_encoder {
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100214 __u32 encoder_id;
215 __u32 encoder_type;
Dave Airlief453ba02008-11-07 14:05:41 -0800216
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100217 __u32 crtc_id; /**< Id of crtc */
Dave Airlief453ba02008-11-07 14:05:41 -0800218
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100219 __u32 possible_crtcs;
220 __u32 possible_clones;
Dave Airlief453ba02008-11-07 14:05:41 -0800221};
222
223/* This is for connectors with multiple signal types. */
224/* Try to match DRM_MODE_CONNECTOR_X as closely as possible. */
Jakob Bornecrantze0c84632008-12-19 14:50:50 +1000225#define DRM_MODE_SUBCONNECTOR_Automatic 0
226#define DRM_MODE_SUBCONNECTOR_Unknown 0
227#define DRM_MODE_SUBCONNECTOR_DVID 3
228#define DRM_MODE_SUBCONNECTOR_DVIA 4
229#define DRM_MODE_SUBCONNECTOR_Composite 5
230#define DRM_MODE_SUBCONNECTOR_SVIDEO 6
231#define DRM_MODE_SUBCONNECTOR_Component 8
Francisco Jerezaeaa1ad2009-08-02 04:19:19 +0200232#define DRM_MODE_SUBCONNECTOR_SCART 9
Dave Airlief453ba02008-11-07 14:05:41 -0800233
Jakob Bornecrantze0c84632008-12-19 14:50:50 +1000234#define DRM_MODE_CONNECTOR_Unknown 0
235#define DRM_MODE_CONNECTOR_VGA 1
236#define DRM_MODE_CONNECTOR_DVII 2
237#define DRM_MODE_CONNECTOR_DVID 3
238#define DRM_MODE_CONNECTOR_DVIA 4
239#define DRM_MODE_CONNECTOR_Composite 5
240#define DRM_MODE_CONNECTOR_SVIDEO 6
241#define DRM_MODE_CONNECTOR_LVDS 7
242#define DRM_MODE_CONNECTOR_Component 8
243#define DRM_MODE_CONNECTOR_9PinDIN 9
244#define DRM_MODE_CONNECTOR_DisplayPort 10
245#define DRM_MODE_CONNECTOR_HDMIA 11
246#define DRM_MODE_CONNECTOR_HDMIB 12
Francisco Jerez74bd3c22009-08-02 04:19:18 +0200247#define DRM_MODE_CONNECTOR_TV 13
Alex Deucher7970e672010-01-07 13:47:47 -0500248#define DRM_MODE_CONNECTOR_eDP 14
Thomas Hellstroma7331e52011-10-22 10:36:19 +0200249#define DRM_MODE_CONNECTOR_VIRTUAL 15
Shobhit Kumarb8923272013-08-27 15:12:13 +0300250#define DRM_MODE_CONNECTOR_DSI 16
Eric Anholt0b27c022016-03-18 12:34:59 -0700251#define DRM_MODE_CONNECTOR_DPI 17
Dave Airlief453ba02008-11-07 14:05:41 -0800252
253struct drm_mode_get_connector {
254
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100255 __u64 encoders_ptr;
256 __u64 modes_ptr;
257 __u64 props_ptr;
258 __u64 prop_values_ptr;
Dave Airlief453ba02008-11-07 14:05:41 -0800259
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100260 __u32 count_modes;
261 __u32 count_props;
262 __u32 count_encoders;
Dave Airlief453ba02008-11-07 14:05:41 -0800263
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100264 __u32 encoder_id; /**< Current Encoder */
265 __u32 connector_id; /**< Id */
266 __u32 connector_type;
267 __u32 connector_type_id;
Dave Airlief453ba02008-11-07 14:05:41 -0800268
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100269 __u32 connection;
Rob Clarkbbda9c12015-08-19 19:21:14 -0400270 __u32 mm_width; /**< width in millimeters */
271 __u32 mm_height; /**< height in millimeters */
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100272 __u32 subpixel;
Chris Wilsonbc5bd372013-10-16 09:49:02 +0100273
274 __u32 pad;
Dave Airlief453ba02008-11-07 14:05:41 -0800275};
276
Jakob Bornecrantze0c84632008-12-19 14:50:50 +1000277#define DRM_MODE_PROP_PENDING (1<<0)
278#define DRM_MODE_PROP_RANGE (1<<1)
279#define DRM_MODE_PROP_IMMUTABLE (1<<2)
280#define DRM_MODE_PROP_ENUM (1<<3) /* enumerated type with text strings */
281#define DRM_MODE_PROP_BLOB (1<<4)
Rob Clark49e27542012-05-17 02:23:26 -0600282#define DRM_MODE_PROP_BITMASK (1<<5) /* bitmask of enumerated types */
Dave Airlief453ba02008-11-07 14:05:41 -0800283
Rob Clark5ea22f22014-05-30 11:34:01 -0400284/* non-extended types: legacy bitmask, one bit per type: */
285#define DRM_MODE_PROP_LEGACY_TYPE ( \
286 DRM_MODE_PROP_RANGE | \
287 DRM_MODE_PROP_ENUM | \
288 DRM_MODE_PROP_BLOB | \
289 DRM_MODE_PROP_BITMASK)
290
291/* extended-types: rather than continue to consume a bit per type,
292 * grab a chunk of the bits to use as integer type id.
293 */
294#define DRM_MODE_PROP_EXTENDED_TYPE 0x0000ffc0
295#define DRM_MODE_PROP_TYPE(n) ((n) << 6)
Rob Clark98f75de2014-05-30 11:37:03 -0400296#define DRM_MODE_PROP_OBJECT DRM_MODE_PROP_TYPE(1)
Rob Clarkebc44cf2012-09-12 22:22:31 -0500297#define DRM_MODE_PROP_SIGNED_RANGE DRM_MODE_PROP_TYPE(2)
Rob Clark5ea22f22014-05-30 11:34:01 -0400298
Rob Clark88a48e22014-12-18 16:01:50 -0500299/* the PROP_ATOMIC flag is used to hide properties from userspace that
300 * is not aware of atomic properties. This is mostly to work around
301 * older userspace (DDX drivers) that read/write each prop they find,
302 * witout being aware that this could be triggering a lengthy modeset.
303 */
304#define DRM_MODE_PROP_ATOMIC 0x80000000
305
Dave Airlief453ba02008-11-07 14:05:41 -0800306struct drm_mode_property_enum {
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100307 __u64 value;
Jakob Bornecrantze0c84632008-12-19 14:50:50 +1000308 char name[DRM_PROP_NAME_LEN];
Dave Airlief453ba02008-11-07 14:05:41 -0800309};
310
311struct drm_mode_get_property {
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100312 __u64 values_ptr; /* values and blob lengths */
313 __u64 enum_blob_ptr; /* enum and blob id ptrs */
Dave Airlief453ba02008-11-07 14:05:41 -0800314
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100315 __u32 prop_id;
316 __u32 flags;
Jakob Bornecrantze0c84632008-12-19 14:50:50 +1000317 char name[DRM_PROP_NAME_LEN];
Dave Airlief453ba02008-11-07 14:05:41 -0800318
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100319 __u32 count_values;
Daniel Vetter3758b342014-11-19 18:38:10 +0100320 /* This is only used to count enum values, not blobs. The _blobs is
321 * simply because of a historical reason, i.e. backwards compat. */
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100322 __u32 count_enum_blobs;
Dave Airlief453ba02008-11-07 14:05:41 -0800323};
324
325struct drm_mode_connector_set_property {
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100326 __u64 value;
327 __u32 prop_id;
328 __u32 connector_id;
Dave Airlief453ba02008-11-07 14:05:41 -0800329};
330
Daniel Vetter8812f382016-03-30 16:19:44 +0200331#define DRM_MODE_OBJECT_CRTC 0xcccccccc
332#define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
333#define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
334#define DRM_MODE_OBJECT_MODE 0xdededede
335#define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
336#define DRM_MODE_OBJECT_FB 0xfbfbfbfb
337#define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
338#define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
339#define DRM_MODE_OBJECT_ANY 0
340
Paulo Zanonic5431882012-05-15 18:09:02 -0300341struct drm_mode_obj_get_properties {
342 __u64 props_ptr;
343 __u64 prop_values_ptr;
344 __u32 count_props;
345 __u32 obj_id;
346 __u32 obj_type;
347};
348
349struct drm_mode_obj_set_property {
350 __u64 value;
351 __u32 prop_id;
352 __u32 obj_id;
353 __u32 obj_type;
354};
355
Dave Airlief453ba02008-11-07 14:05:41 -0800356struct drm_mode_get_blob {
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100357 __u32 blob_id;
358 __u32 length;
359 __u64 data;
Dave Airlief453ba02008-11-07 14:05:41 -0800360};
361
362struct drm_mode_fb_cmd {
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100363 __u32 fb_id;
Rob Clarkbbda9c12015-08-19 19:21:14 -0400364 __u32 width;
365 __u32 height;
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100366 __u32 pitch;
367 __u32 bpp;
368 __u32 depth;
Jakob Bornecrantze0c84632008-12-19 14:50:50 +1000369 /* driver specific handle */
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100370 __u32 handle;
Dave Airlief453ba02008-11-07 14:05:41 -0800371};
372
Ville Syrjäläcc5b6f02011-12-20 00:06:38 +0200373#define DRM_MODE_FB_INTERLACED (1<<0) /* for interlaced framebuffers */
Rob Clarke3eb3252015-02-05 14:41:52 +0000374#define DRM_MODE_FB_MODIFIERS (1<<1) /* enables ->modifer[] */
Alan Kwongdfa8c082016-07-29 04:10:00 -0400375#define DRM_MODE_FB_SECURE (1<<2) /* for secure framebuffers */
Jesse Barnes308e5bc2011-11-14 14:51:28 -0800376
377struct drm_mode_fb_cmd2 {
378 __u32 fb_id;
Rob Clarkbbda9c12015-08-19 19:21:14 -0400379 __u32 width;
380 __u32 height;
Jesse Barnes308e5bc2011-11-14 14:51:28 -0800381 __u32 pixel_format; /* fourcc code from drm_fourcc.h */
382 __u32 flags; /* see above flags */
383
384 /*
385 * In case of planar formats, this ioctl allows up to 4
Rob Clarkae282902014-12-10 12:17:41 -0500386 * buffer objects with offsets and pitches per plane.
Jesse Barnes308e5bc2011-11-14 14:51:28 -0800387 * The pitch and offset order is dictated by the fourcc,
388 * e.g. NV12 (http://fourcc.org/yuv.php#NV12) is described as:
389 *
390 * YUV 4:2:0 image with a plane of 8 bit Y samples
391 * followed by an interleaved U/V plane containing
392 * 8 bit 2x2 subsampled colour difference samples.
393 *
Rob Clarkae282902014-12-10 12:17:41 -0500394 * So it would consist of Y as offsets[0] and UV as
395 * offsets[1]. Note that offsets[0] will generally
396 * be 0 (but this is not required).
Rob Clarke3eb3252015-02-05 14:41:52 +0000397 *
398 * To accommodate tiled, compressed, etc formats, a per-plane
399 * modifier can be specified. The default value of zero
400 * indicates "native" format as specified by the fourcc.
401 * Vendor specific modifier token. This allows, for example,
402 * different tiling/swizzling pattern on different planes.
403 * See discussion above of DRM_FORMAT_MOD_xxx.
Jesse Barnes308e5bc2011-11-14 14:51:28 -0800404 */
405 __u32 handles[4];
406 __u32 pitches[4]; /* pitch for each plane */
407 __u32 offsets[4]; /* offset of each plane */
Rob Clarke3eb3252015-02-05 14:41:52 +0000408 __u64 modifier[4]; /* ie, tiling, compressed (per plane) */
Jesse Barnes308e5bc2011-11-14 14:51:28 -0800409};
410
Jakob Bornecrantz884840a2009-12-03 23:25:47 +0000411#define DRM_MODE_FB_DIRTY_ANNOTATE_COPY 0x01
412#define DRM_MODE_FB_DIRTY_ANNOTATE_FILL 0x02
413#define DRM_MODE_FB_DIRTY_FLAGS 0x03
414
Xi Wanga5cd3352011-11-23 01:12:01 -0500415#define DRM_MODE_FB_DIRTY_MAX_CLIPS 256
416
Jakob Bornecrantz884840a2009-12-03 23:25:47 +0000417/*
418 * Mark a region of a framebuffer as dirty.
419 *
420 * Some hardware does not automatically update display contents
421 * as a hardware or software draw to a framebuffer. This ioctl
422 * allows userspace to tell the kernel and the hardware what
423 * regions of the framebuffer have changed.
424 *
425 * The kernel or hardware is free to update more then just the
426 * region specified by the clip rects. The kernel or hardware
427 * may also delay and/or coalesce several calls to dirty into a
428 * single update.
429 *
430 * Userspace may annotate the updates, the annotates are a
431 * promise made by the caller that the change is either a copy
432 * of pixels or a fill of a single color in the region specified.
433 *
434 * If the DRM_MODE_FB_DIRTY_ANNOTATE_COPY flag is given then
435 * the number of updated regions are half of num_clips given,
436 * where the clip rects are paired in src and dst. The width and
437 * height of each one of the pairs must match.
438 *
439 * If the DRM_MODE_FB_DIRTY_ANNOTATE_FILL flag is given the caller
440 * promises that the region specified of the clip rects is filled
441 * completely with a single color as given in the color argument.
442 */
443
444struct drm_mode_fb_dirty_cmd {
445 __u32 fb_id;
446 __u32 flags;
447 __u32 color;
448 __u32 num_clips;
449 __u64 clips_ptr;
450};
451
Dave Airlief453ba02008-11-07 14:05:41 -0800452struct drm_mode_mode_cmd {
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100453 __u32 connector_id;
Dave Airlief453ba02008-11-07 14:05:41 -0800454 struct drm_mode_modeinfo mode;
455};
456
Jakob Bornecrantz7c4eaca2012-08-16 08:29:03 +0000457#define DRM_MODE_CURSOR_BO 0x01
458#define DRM_MODE_CURSOR_MOVE 0x02
459#define DRM_MODE_CURSOR_FLAGS 0x03
Dave Airlief453ba02008-11-07 14:05:41 -0800460
461/*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300462 * depending on the value in flags different members are used.
Dave Airlief453ba02008-11-07 14:05:41 -0800463 *
464 * CURSOR_BO uses
Christopher Harvey715f59c2013-04-05 15:28:32 +0000465 * crtc_id
Dave Airlief453ba02008-11-07 14:05:41 -0800466 * width
467 * height
Christopher Harvey715f59c2013-04-05 15:28:32 +0000468 * handle - if 0 turns the cursor off
Dave Airlief453ba02008-11-07 14:05:41 -0800469 *
470 * CURSOR_MOVE uses
Christopher Harvey715f59c2013-04-05 15:28:32 +0000471 * crtc_id
Dave Airlief453ba02008-11-07 14:05:41 -0800472 * x
473 * y
474 */
475struct drm_mode_cursor {
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100476 __u32 flags;
477 __u32 crtc_id;
478 __s32 x;
479 __s32 y;
480 __u32 width;
481 __u32 height;
Jakob Bornecrantze0c84632008-12-19 14:50:50 +1000482 /* driver specific handle */
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100483 __u32 handle;
Dave Airlief453ba02008-11-07 14:05:41 -0800484};
485
Dave Airlie4c813d42013-06-20 11:48:52 +1000486struct drm_mode_cursor2 {
487 __u32 flags;
488 __u32 crtc_id;
489 __s32 x;
490 __s32 y;
491 __u32 width;
492 __u32 height;
493 /* driver specific handle */
494 __u32 handle;
495 __s32 hot_x;
496 __s32 hot_y;
497};
498
Dave Airlief453ba02008-11-07 14:05:41 -0800499struct drm_mode_crtc_lut {
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100500 __u32 crtc_id;
501 __u32 gamma_size;
Dave Airlief453ba02008-11-07 14:05:41 -0800502
503 /* pointers to arrays */
Arnd Bergmann1d7f83d2009-02-26 00:51:42 +0100504 __u64 red;
505 __u64 green;
506 __u64 blue;
Dave Airlief453ba02008-11-07 14:05:41 -0800507};
508
Lionel Landwerlin5488dc12016-02-26 17:05:00 +0000509struct drm_color_ctm {
510 /* Conversion matrix in S31.32 format. */
511 __s64 matrix[9];
512};
513
514struct drm_color_lut {
515 /*
516 * Data is U0.16 fixed point format.
517 */
518 __u16 red;
519 __u16 green;
520 __u16 blue;
521 __u16 reserved;
522};
523
Kristian Høgsbergd91d8a32009-11-17 12:43:55 -0500524#define DRM_MODE_PAGE_FLIP_EVENT 0x01
Keith Packard9bba0c42013-07-22 18:49:59 -0700525#define DRM_MODE_PAGE_FLIP_ASYNC 0x02
Michel Dänzerf8372972016-08-08 16:23:39 +0900526#define DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE 0x4
527#define DRM_MODE_PAGE_FLIP_TARGET_RELATIVE 0x8
528#define DRM_MODE_PAGE_FLIP_TARGET (DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE | \
529 DRM_MODE_PAGE_FLIP_TARGET_RELATIVE)
530#define DRM_MODE_PAGE_FLIP_FLAGS (DRM_MODE_PAGE_FLIP_EVENT | \
531 DRM_MODE_PAGE_FLIP_ASYNC | \
532 DRM_MODE_PAGE_FLIP_TARGET)
Kristian Høgsbergd91d8a32009-11-17 12:43:55 -0500533
534/*
535 * Request a page flip on the specified crtc.
536 *
537 * This ioctl will ask KMS to schedule a page flip for the specified
538 * crtc. Once any pending rendering targeting the specified fb (as of
539 * ioctl time) has completed, the crtc will be reprogrammed to display
540 * that fb after the next vertical refresh. The ioctl returns
541 * immediately, but subsequent rendering to the current fb will block
542 * in the execbuffer ioctl until the page flip happens. If a page
543 * flip is already pending as the ioctl is called, EBUSY will be
544 * returned.
545 *
Keith Packard9bba0c42013-07-22 18:49:59 -0700546 * Flag DRM_MODE_PAGE_FLIP_EVENT requests that drm sends back a vblank
547 * event (see drm.h: struct drm_event_vblank) when the page flip is
548 * done. The user_data field passed in with this ioctl will be
549 * returned as the user_data field in the vblank event struct.
550 *
551 * Flag DRM_MODE_PAGE_FLIP_ASYNC requests that the flip happen
552 * 'as soon as possible', meaning that it not delay waiting for vblank.
553 * This may cause tearing on the screen.
Kristian Høgsbergd91d8a32009-11-17 12:43:55 -0500554 *
Michel Dänzerf8372972016-08-08 16:23:39 +0900555 * The reserved field must be zero.
Kristian Høgsbergd91d8a32009-11-17 12:43:55 -0500556 */
557
558struct drm_mode_crtc_page_flip {
559 __u32 crtc_id;
560 __u32 fb_id;
561 __u32 flags;
562 __u32 reserved;
563 __u64 user_data;
564};
565
Michel Dänzerf8372972016-08-08 16:23:39 +0900566/*
567 * Request a page flip on the specified crtc.
568 *
569 * Same as struct drm_mode_crtc_page_flip, but supports new flags and
570 * re-purposes the reserved field:
571 *
572 * The sequence field must be zero unless either of the
573 * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is specified. When
574 * the ABSOLUTE flag is specified, the sequence field denotes the absolute
575 * vblank sequence when the flip should take effect. When the RELATIVE
576 * flag is specified, the sequence field denotes the relative (to the
577 * current one when the ioctl is called) vblank sequence when the flip
578 * should take effect. NOTE: DRM_IOCTL_WAIT_VBLANK must still be used to
579 * make sure the vblank sequence before the target one has passed before
580 * calling this ioctl. The purpose of the
581 * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is merely to clarify
582 * the target for when code dealing with a page flip runs during a
583 * vertical blank period.
584 */
585
586struct drm_mode_crtc_page_flip_target {
587 __u32 crtc_id;
588 __u32 fb_id;
589 __u32 flags;
590 __u32 sequence;
591 __u64 user_data;
592};
593
Dave Airlieff72145b2011-02-07 12:16:14 +1000594/* create a dumb scanout buffer */
595struct drm_mode_create_dumb {
Mikko Rapeli05623b72014-08-31 13:01:09 +0200596 __u32 height;
597 __u32 width;
598 __u32 bpp;
599 __u32 flags;
Dave Airlieff72145b2011-02-07 12:16:14 +1000600 /* handle, pitch, size will be returned */
Mikko Rapeli05623b72014-08-31 13:01:09 +0200601 __u32 handle;
602 __u32 pitch;
603 __u64 size;
Dave Airlieff72145b2011-02-07 12:16:14 +1000604};
605
606/* set up for mmap of a dumb scanout buffer */
607struct drm_mode_map_dumb {
608 /** Handle for the object being mapped. */
609 __u32 handle;
610 __u32 pad;
611 /**
612 * Fake offset to use for subsequent mmap call
613 *
614 * This is a fixed-size type for 32/64 compatibility.
615 */
616 __u64 offset;
617};
618
619struct drm_mode_destroy_dumb {
Mikko Rapeli05623b72014-08-31 13:01:09 +0200620 __u32 handle;
Dave Airlieff72145b2011-02-07 12:16:14 +1000621};
622
Rob Clarkd34f20d2014-12-18 16:01:56 -0500623/* page-flip flags are valid, plus: */
624#define DRM_MODE_ATOMIC_TEST_ONLY 0x0100
625#define DRM_MODE_ATOMIC_NONBLOCK 0x0200
626#define DRM_MODE_ATOMIC_ALLOW_MODESET 0x0400
627
628#define DRM_MODE_ATOMIC_FLAGS (\
629 DRM_MODE_PAGE_FLIP_EVENT |\
630 DRM_MODE_PAGE_FLIP_ASYNC |\
631 DRM_MODE_ATOMIC_TEST_ONLY |\
632 DRM_MODE_ATOMIC_NONBLOCK |\
633 DRM_MODE_ATOMIC_ALLOW_MODESET)
634
635struct drm_mode_atomic {
636 __u32 flags;
637 __u32 count_objs;
638 __u64 objs_ptr;
639 __u64 count_props_ptr;
640 __u64 props_ptr;
641 __u64 prop_values_ptr;
642 __u64 reserved;
643 __u64 user_data;
644};
645
Daniel Stonee2f5d2e2015-05-22 13:34:51 +0100646/**
647 * Create a new 'blob' data property, copying length bytes from data pointer,
648 * and returning new blob ID.
649 */
650struct drm_mode_create_blob {
651 /** Pointer to data to copy. */
652 __u64 data;
653 /** Length of data to copy. */
654 __u32 length;
655 /** Return: new property ID. */
656 __u32 blob_id;
657};
658
659/**
660 * Destroy a user-created blob property.
661 */
662struct drm_mode_destroy_blob {
663 __u32 blob_id;
664};
665
Emil Velikovebbb0e52016-04-07 18:49:00 +0100666#if defined(__cplusplus)
667}
668#endif
669
Dave Airlief453ba02008-11-07 14:05:41 -0800670#endif