Add support for generic object properties IOCTLs
[glsdk/libdrm.git] / include / drm / drm_mode.h
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  */
27 #ifndef _DRM_MODE_H
28 #define _DRM_MODE_H
30 #define DRM_DISPLAY_INFO_LEN    32
31 #define DRM_CONNECTOR_NAME_LEN  32
32 #define DRM_DISPLAY_MODE_LEN    32
33 #define DRM_PROP_NAME_LEN       32
35 #define DRM_MODE_TYPE_BUILTIN   (1<<0)
36 #define DRM_MODE_TYPE_CLOCK_C   ((1<<1) | DRM_MODE_TYPE_BUILTIN)
37 #define DRM_MODE_TYPE_CRTC_C    ((1<<2) | DRM_MODE_TYPE_BUILTIN)
38 #define DRM_MODE_TYPE_PREFERRED (1<<3)
39 #define DRM_MODE_TYPE_DEFAULT   (1<<4)
40 #define DRM_MODE_TYPE_USERDEF   (1<<5)
41 #define DRM_MODE_TYPE_DRIVER    (1<<6)
43 /* Video mode flags */
44 /* bit compatible with the xorg definitions. */
45 #define DRM_MODE_FLAG_PHSYNC    (1<<0)
46 #define DRM_MODE_FLAG_NHSYNC    (1<<1)
47 #define DRM_MODE_FLAG_PVSYNC    (1<<2)
48 #define DRM_MODE_FLAG_NVSYNC    (1<<3)
49 #define DRM_MODE_FLAG_INTERLACE (1<<4)
50 #define DRM_MODE_FLAG_DBLSCAN   (1<<5)
51 #define DRM_MODE_FLAG_CSYNC     (1<<6)
52 #define DRM_MODE_FLAG_PCSYNC    (1<<7)
53 #define DRM_MODE_FLAG_NCSYNC    (1<<8)
54 #define DRM_MODE_FLAG_HSKEW     (1<<9) /* hskew provided */
55 #define DRM_MODE_FLAG_BCAST     (1<<10)
56 #define DRM_MODE_FLAG_PIXMUX    (1<<11)
57 #define DRM_MODE_FLAG_DBLCLK    (1<<12)
58 #define DRM_MODE_FLAG_CLKDIV2   (1<<13)
60 /* DPMS flags */
61 /* bit compatible with the xorg definitions. */
62 #define DRM_MODE_DPMS_ON        0
63 #define DRM_MODE_DPMS_STANDBY   1
64 #define DRM_MODE_DPMS_SUSPEND   2
65 #define DRM_MODE_DPMS_OFF       3
67 /* Scaling mode options */
68 #define DRM_MODE_SCALE_NONE             0 /* Unmodified timing (display or
69                                              software can still scale) */
70 #define DRM_MODE_SCALE_FULLSCREEN       1 /* Full screen, ignore aspect */
71 #define DRM_MODE_SCALE_CENTER           2 /* Centered, no scaling */
72 #define DRM_MODE_SCALE_ASPECT           3 /* Full screen, preserve aspect */
74 /* Dithering mode options */
75 #define DRM_MODE_DITHERING_OFF  0
76 #define DRM_MODE_DITHERING_ON   1
77 #define DRM_MODE_DITHERING_AUTO 2
79 /* Dirty info options */
80 #define DRM_MODE_DIRTY_OFF      0
81 #define DRM_MODE_DIRTY_ON       1
82 #define DRM_MODE_DIRTY_ANNOTATE 2
84 struct drm_mode_modeinfo {
85         __u32 clock;
86         __u16 hdisplay, hsync_start, hsync_end, htotal, hskew;
87         __u16 vdisplay, vsync_start, vsync_end, vtotal, vscan;
89         __u32 vrefresh;
91         __u32 flags;
92         __u32 type;
93         char name[DRM_DISPLAY_MODE_LEN];
94 };
96 struct drm_mode_card_res {
97         __u64 fb_id_ptr;
98         __u64 crtc_id_ptr;
99         __u64 connector_id_ptr;
100         __u64 encoder_id_ptr;
101         __u32 count_fbs;
102         __u32 count_crtcs;
103         __u32 count_connectors;
104         __u32 count_encoders;
105         __u32 min_width, max_width;
106         __u32 min_height, max_height;
107 };
109 struct drm_mode_crtc {
110         __u64 set_connectors_ptr;
111         __u32 count_connectors;
113         __u32 crtc_id; /**< Id */
114         __u32 fb_id; /**< Id of framebuffer */
116         __u32 x, y; /**< Position on the frameuffer */
118         __u32 gamma_size;
119         __u32 mode_valid;
120         struct drm_mode_modeinfo mode;
121 };
123 #define DRM_MODE_PRESENT_TOP_FIELD     (1<<0)
124 #define DRM_MODE_PRESENT_BOTTOM_FIELD  (1<<1)
126 /* Planes blend with or override other bits on the CRTC */
127 struct drm_mode_set_plane {
128         __u32 plane_id;
129         __u32 crtc_id;
130         __u32 fb_id; /* fb object contains surface format type */
131         __u32 flags;
133         /* Signed dest location allows it to be partially off screen */
134         __s32 crtc_x, crtc_y;
135         __u32 crtc_w, crtc_h;
137         /* Source values are 16.16 fixed point */
138         __u32 src_x, src_y;
139         __u32 src_h, src_w;
140 };
142 struct drm_mode_get_plane {
143         __u32 plane_id;
145         __u32 crtc_id;
146         __u32 fb_id;
148         __u32 possible_crtcs;
149         __u32 gamma_size;
151         __u32 count_format_types;
152         __u64 format_type_ptr;
153 };
155 struct drm_mode_get_plane_res {
156         __u64 plane_id_ptr;
157         __u32 count_planes;
158 };
160 #define DRM_MODE_ENCODER_NONE   0
161 #define DRM_MODE_ENCODER_DAC    1
162 #define DRM_MODE_ENCODER_TMDS   2
163 #define DRM_MODE_ENCODER_LVDS   3
164 #define DRM_MODE_ENCODER_TVDAC  4
166 struct drm_mode_get_encoder {
167         __u32 encoder_id;
168         __u32 encoder_type;
170         __u32 crtc_id; /**< Id of crtc */
172         __u32 possible_crtcs;
173         __u32 possible_clones;
174 };
176 /* This is for connectors with multiple signal types. */
177 /* Try to match DRM_MODE_CONNECTOR_X as closely as possible. */
178 #define DRM_MODE_SUBCONNECTOR_Automatic 0
179 #define DRM_MODE_SUBCONNECTOR_Unknown   0
180 #define DRM_MODE_SUBCONNECTOR_DVID      3
181 #define DRM_MODE_SUBCONNECTOR_DVIA      4
182 #define DRM_MODE_SUBCONNECTOR_Composite 5
183 #define DRM_MODE_SUBCONNECTOR_SVIDEO    6
184 #define DRM_MODE_SUBCONNECTOR_Component 8
185 #define DRM_MODE_SUBCONNECTOR_SCART     9
187 #define DRM_MODE_CONNECTOR_Unknown      0
188 #define DRM_MODE_CONNECTOR_VGA          1
189 #define DRM_MODE_CONNECTOR_DVII         2
190 #define DRM_MODE_CONNECTOR_DVID         3
191 #define DRM_MODE_CONNECTOR_DVIA         4
192 #define DRM_MODE_CONNECTOR_Composite    5
193 #define DRM_MODE_CONNECTOR_SVIDEO       6
194 #define DRM_MODE_CONNECTOR_LVDS         7
195 #define DRM_MODE_CONNECTOR_Component    8
196 #define DRM_MODE_CONNECTOR_9PinDIN      9
197 #define DRM_MODE_CONNECTOR_DisplayPort  10
198 #define DRM_MODE_CONNECTOR_HDMIA        11
199 #define DRM_MODE_CONNECTOR_HDMIB        12
200 #define DRM_MODE_CONNECTOR_TV           13
201 #define DRM_MODE_CONNECTOR_eDP          14
203 struct drm_mode_get_connector {
205         __u64 encoders_ptr;
206         __u64 modes_ptr;
207         __u64 props_ptr;
208         __u64 prop_values_ptr;
210         __u32 count_modes;
211         __u32 count_props;
212         __u32 count_encoders;
214         __u32 encoder_id; /**< Current Encoder */
215         __u32 connector_id; /**< Id */
216         __u32 connector_type;
217         __u32 connector_type_id;
219         __u32 connection;
220         __u32 mm_width, mm_height; /**< HxW in millimeters */
221         __u32 subpixel;
222 };
224 #define DRM_MODE_PROP_PENDING   (1<<0)
225 #define DRM_MODE_PROP_RANGE     (1<<1)
226 #define DRM_MODE_PROP_IMMUTABLE (1<<2)
227 #define DRM_MODE_PROP_ENUM      (1<<3) /* enumerated type with text strings */
228 #define DRM_MODE_PROP_BLOB      (1<<4)
230 struct drm_mode_property_enum {
231         __u64 value;
232         char name[DRM_PROP_NAME_LEN];
233 };
235 struct drm_mode_get_property {
236         __u64 values_ptr; /* values and blob lengths */
237         __u64 enum_blob_ptr; /* enum and blob id ptrs */
239         __u32 prop_id;
240         __u32 flags;
241         char name[DRM_PROP_NAME_LEN];
243         __u32 count_values;
244         __u32 count_enum_blobs;
245 };
247 struct drm_mode_connector_set_property {
248         __u64 value;
249         __u32 prop_id;
250         __u32 connector_id;
251 };
253 #define DRM_MODE_OBJECT_CRTC 0xcccccccc
254 #define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
255 #define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
256 #define DRM_MODE_OBJECT_MODE 0xdededede
257 #define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
258 #define DRM_MODE_OBJECT_FB 0xfbfbfbfb
259 #define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
260 #define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
262 struct drm_mode_obj_get_properties {
263         __u64 props_ptr;
264         __u64 prop_values_ptr;
265         __u32 count_props;
266         __u32 obj_id;
267         __u32 obj_type;
268 };
270 struct drm_mode_obj_set_property {
271         __u64 value;
272         __u32 prop_id;
273         __u32 obj_id;
274         __u32 obj_type;
275 };
277 struct drm_mode_get_blob {
278         __u32 blob_id;
279         __u32 length;
280         __u64 data;
281 };
283 struct drm_mode_fb_cmd {
284         __u32 fb_id;
285         __u32 width, height;
286         __u32 pitch;
287         __u32 bpp;
288         __u32 depth;
289         /* driver specific handle */
290         __u32 handle;
291 };
293 #define DRM_MODE_FB_INTERLACED (1<<0) /* for interlaced framebuffers */
295 struct drm_mode_fb_cmd2 {
296         __u32 fb_id;
297         __u32 width, height;
298         __u32 pixel_format; /* fourcc code from drm_fourcc.h */
299         __u32 flags;
301         /*
302          * In case of planar formats, this ioctl allows up to 4
303          * buffer objects with offsets and pitches per plane.
304          * The pitch and offset order is dictated by the fourcc,
305          * e.g. NV12 (http://fourcc.org/yuv.php#NV12) is described as:
306          *
307          *   YUV 4:2:0 image with a plane of 8 bit Y samples
308          *   followed by an interleaved U/V plane containing
309          *   8 bit 2x2 subsampled colour difference samples.
310          *
311          * So it would consist of Y as offset[0] and UV as
312          * offset[1].  Note that offset[0] will generally
313          * be 0.
314          */
315         __u32 handles[4];
316         __u32 pitches[4]; /* pitch for each plane */
317         __u32 offsets[4]; /* offset of each plane */
318 };
320 #define DRM_MODE_FB_DIRTY_ANNOTATE_COPY 0x01
321 #define DRM_MODE_FB_DIRTY_ANNOTATE_FILL 0x02
322 #define DRM_MODE_FB_DIRTY_FLAGS         0x03
324 /*
325  * Mark a region of a framebuffer as dirty.
326  *
327  * Some hardware does not automatically update display contents
328  * as a hardware or software draw to a framebuffer. This ioctl
329  * allows userspace to tell the kernel and the hardware what
330  * regions of the framebuffer have changed.
331  *
332  * The kernel or hardware is free to update more then just the
333  * region specified by the clip rects. The kernel or hardware
334  * may also delay and/or coalesce several calls to dirty into a
335  * single update.
336  *
337  * Userspace may annotate the updates, the annotates are a
338  * promise made by the caller that the change is either a copy
339  * of pixels or a fill of a single color in the region specified.
340  *
341  * If the DRM_MODE_FB_DIRTY_ANNOTATE_COPY flag is given then
342  * the number of updated regions are half of num_clips given,
343  * where the clip rects are paired in src and dst. The width and
344  * height of each one of the pairs must match.
345  *
346  * If the DRM_MODE_FB_DIRTY_ANNOTATE_FILL flag is given the caller
347  * promises that the region specified of the clip rects is filled
348  * completely with a single color as given in the color argument.
349  */
351 struct drm_mode_fb_dirty_cmd {
352         __u32 fb_id;
353         __u32 flags;
354         __u32 color;
355         __u32 num_clips;
356         __u64 clips_ptr;
357 };
359 struct drm_mode_mode_cmd {
360         __u32 connector_id;
361         struct drm_mode_modeinfo mode;
362 };
364 #define DRM_MODE_CURSOR_BO      (1<<0)
365 #define DRM_MODE_CURSOR_MOVE    (1<<1)
367 /*
368  * depending on the value in flags diffrent members are used.
369  *
370  * CURSOR_BO uses
371  *    crtc
372  *    width
373  *    height
374  *    handle - if 0 turns the cursor of
375  *
376  * CURSOR_MOVE uses
377  *    crtc
378  *    x
379  *    y
380  */
381 struct drm_mode_cursor {
382         __u32 flags;
383         __u32 crtc_id;
384         __s32 x;
385         __s32 y;
386         __u32 width;
387         __u32 height;
388         /* driver specific handle */
389         __u32 handle;
390 };
392 struct drm_mode_crtc_lut {
393         __u32 crtc_id;
394         __u32 gamma_size;
396         /* pointers to arrays */
397         __u64 red;
398         __u64 green;
399         __u64 blue;
400 };
402 #define DRM_MODE_PAGE_FLIP_EVENT 0x01
403 #define DRM_MODE_PAGE_FLIP_FLAGS DRM_MODE_PAGE_FLIP_EVENT
405 /*
406  * Request a page flip on the specified crtc.
407  *
408  * This ioctl will ask KMS to schedule a page flip for the specified
409  * crtc.  Once any pending rendering targeting the specified fb (as of
410  * ioctl time) has completed, the crtc will be reprogrammed to display
411  * that fb after the next vertical refresh.  The ioctl returns
412  * immediately, but subsequent rendering to the current fb will block
413  * in the execbuffer ioctl until the page flip happens.  If a page
414  * flip is already pending as the ioctl is called, EBUSY will be
415  * returned.
416  *
417  * The ioctl supports one flag, DRM_MODE_PAGE_FLIP_EVENT, which will
418  * request that drm sends back a vblank event (see drm.h: struct
419  * drm_event_vblank) when the page flip is done.  The user_data field
420  * passed in with this ioctl will be returned as the user_data field
421  * in the vblank event struct.
422  *
423  * The reserved field must be zero until we figure out something
424  * clever to use it for.
425  */
427 struct drm_mode_crtc_page_flip {
428         __u32 crtc_id;
429         __u32 fb_id;
430         __u32 flags;
431         __u32 reserved;
432         __u64 user_data;
433 };
435 /* create a dumb scanout buffer */
436 struct drm_mode_create_dumb {
437         __u32 height;
438         __u32 width;
439         __u32 bpp;
440         __u32 flags;
441         /* handle, pitch, size will be returned */
442         __u32 handle;
443         __u32 pitch;
444         __u64 size;
445 };
447 /* set up for mmap of a dumb scanout buffer */
448 struct drm_mode_map_dumb {
449         /** Handle for the object being mapped. */
450         __u32 handle;
451         __u32 pad;
452         /**
453          * Fake offset to use for subsequent mmap call
454          *
455          * This is a fixed-size type for 32/64 compatibility.
456          */
457         __u64 offset;
458 };
460 struct drm_mode_destroy_dumb {
461         __u32 handle;
462 };
464 #endif