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
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:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
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
30 #include <linux/types.h>
32 #define DRM_DISPLAY_INFO_LEN 32
33 #define DRM_CONNECTOR_NAME_LEN 32
34 #define DRM_DISPLAY_MODE_LEN 32
35 #define DRM_PROP_NAME_LEN 32
37 #define DRM_MODE_TYPE_BUILTIN (1<<0)
38 #define DRM_MODE_TYPE_CLOCK_C ((1<<1) | DRM_MODE_TYPE_BUILTIN)
39 #define DRM_MODE_TYPE_CRTC_C ((1<<2) | DRM_MODE_TYPE_BUILTIN)
40 #define DRM_MODE_TYPE_PREFERRED (1<<3)
41 #define DRM_MODE_TYPE_DEFAULT (1<<4)
42 #define DRM_MODE_TYPE_USERDEF (1<<5)
43 #define DRM_MODE_TYPE_DRIVER (1<<6)
45 /* Video mode flags */
46 /* bit compatible with the xorg definitions. */
47 #define DRM_MODE_FLAG_PHSYNC (1<<0)
48 #define DRM_MODE_FLAG_NHSYNC (1<<1)
49 #define DRM_MODE_FLAG_PVSYNC (1<<2)
50 #define DRM_MODE_FLAG_NVSYNC (1<<3)
51 #define DRM_MODE_FLAG_INTERLACE (1<<4)
52 #define DRM_MODE_FLAG_DBLSCAN (1<<5)
53 #define DRM_MODE_FLAG_CSYNC (1<<6)
54 #define DRM_MODE_FLAG_PCSYNC (1<<7)
55 #define DRM_MODE_FLAG_NCSYNC (1<<8)
56 #define DRM_MODE_FLAG_HSKEW (1<<9) /* hskew provided */
57 #define DRM_MODE_FLAG_BCAST (1<<10)
58 #define DRM_MODE_FLAG_PIXMUX (1<<11)
59 #define DRM_MODE_FLAG_DBLCLK (1<<12)
60 #define DRM_MODE_FLAG_CLKDIV2 (1<<13)
62 * When adding a new stereo mode don't forget to adjust DRM_MODE_FLAGS_3D_MAX
63 * (define not exposed to user space).
65 #define DRM_MODE_FLAG_3D_MASK (0x1f<<14)
66 #define DRM_MODE_FLAG_3D_NONE (0<<14)
67 #define DRM_MODE_FLAG_3D_FRAME_PACKING (1<<14)
68 #define DRM_MODE_FLAG_3D_FIELD_ALTERNATIVE (2<<14)
69 #define DRM_MODE_FLAG_3D_LINE_ALTERNATIVE (3<<14)
70 #define DRM_MODE_FLAG_3D_SIDE_BY_SIDE_FULL (4<<14)
71 #define DRM_MODE_FLAG_3D_L_DEPTH (5<<14)
72 #define DRM_MODE_FLAG_3D_L_DEPTH_GFX_GFX_DEPTH (6<<14)
73 #define DRM_MODE_FLAG_3D_TOP_AND_BOTTOM (7<<14)
74 #define DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF (8<<14)
76 /* Picture aspect ratio options */
77 #define DRM_MODE_PICTURE_ASPECT_NONE 0
78 #define DRM_MODE_PICTURE_ASPECT_4_3 1
79 #define DRM_MODE_PICTURE_ASPECT_16_9 2
81 /* Aspect ratio flag bitmask (4 bits 22:19) */
82 #define DRM_MODE_FLAG_PIC_AR_MASK (0x0F<<19)
83 #define DRM_MODE_FLAG_PIC_AR_NONE \
84 (DRM_MODE_PICTURE_ASPECT_NONE<<19)
85 #define DRM_MODE_FLAG_PIC_AR_4_3 \
86 (DRM_MODE_PICTURE_ASPECT_4_3<<19)
87 #define DRM_MODE_FLAG_PIC_AR_16_9 \
88 (DRM_MODE_PICTURE_ASPECT_16_9<<19)
93 #define DRM_MODE_FLAG_420_MASK (0x03<<23)
94 #define DRM_MODE_FLAG_420 (1<<23)
95 #define DRM_MODE_FLAG_420_ONLY (1<<24)
98 /* bit compatible with the xorg definitions. */
99 #define DRM_MODE_DPMS_ON 0
100 #define DRM_MODE_DPMS_STANDBY 1
101 #define DRM_MODE_DPMS_SUSPEND 2
102 #define DRM_MODE_DPMS_OFF 3
104 /* Scaling mode options */
105 #define DRM_MODE_SCALE_NONE 0 /* Unmodified timing (display or
106 software can still scale) */
107 #define DRM_MODE_SCALE_FULLSCREEN 1 /* Full screen, ignore aspect */
108 #define DRM_MODE_SCALE_CENTER 2 /* Centered, no scaling */
109 #define DRM_MODE_SCALE_ASPECT 3 /* Full screen, preserve aspect */
111 /* Dithering mode options */
112 #define DRM_MODE_DITHERING_OFF 0
113 #define DRM_MODE_DITHERING_ON 1
114 #define DRM_MODE_DITHERING_AUTO 2
116 /* Dirty info options */
117 #define DRM_MODE_DIRTY_OFF 0
118 #define DRM_MODE_DIRTY_ON 1
119 #define DRM_MODE_DIRTY_ANNOTATE 2
121 struct drm_mode_modeinfo {
138 char name[DRM_DISPLAY_MODE_LEN];
141 struct drm_mode_card_res {
144 __u64 connector_id_ptr;
145 __u64 encoder_id_ptr;
148 __u32 count_connectors;
149 __u32 count_encoders;
156 struct drm_mode_crtc {
157 __u64 set_connectors_ptr;
158 __u32 count_connectors;
160 __u32 crtc_id; /**< Id */
161 __u32 fb_id; /**< Id of framebuffer */
163 __u32 x; /**< x Position on the framebuffer */
164 __u32 y; /**< y Position on the framebuffer */
168 struct drm_mode_modeinfo mode;
171 #define DRM_MODE_PRESENT_TOP_FIELD (1<<0)
172 #define DRM_MODE_PRESENT_BOTTOM_FIELD (1<<1)
174 /* Planes blend with or override other bits on the CRTC */
175 struct drm_mode_set_plane {
178 __u32 fb_id; /* fb object contains surface format type */
179 __u32 flags; /* see above flags */
181 /* Signed dest location allows it to be partially off screen */
187 /* Source values are 16.16 fixed point */
194 struct drm_mode_get_plane {
200 __u32 possible_crtcs;
203 __u32 count_format_types;
204 __u64 format_type_ptr;
207 struct drm_mode_get_plane_res {
212 #define DRM_MODE_ENCODER_NONE 0
213 #define DRM_MODE_ENCODER_DAC 1
214 #define DRM_MODE_ENCODER_TMDS 2
215 #define DRM_MODE_ENCODER_LVDS 3
216 #define DRM_MODE_ENCODER_TVDAC 4
217 #define DRM_MODE_ENCODER_VIRTUAL 5
218 #define DRM_MODE_ENCODER_DSI 6
219 #define DRM_MODE_ENCODER_DPMST 7
221 struct drm_mode_get_encoder {
225 __u32 crtc_id; /**< Id of crtc */
227 __u32 possible_crtcs;
228 __u32 possible_clones;
231 /* This is for connectors with multiple signal types. */
232 /* Try to match DRM_MODE_CONNECTOR_X as closely as possible. */
233 #define DRM_MODE_SUBCONNECTOR_Automatic 0
234 #define DRM_MODE_SUBCONNECTOR_Unknown 0
235 #define DRM_MODE_SUBCONNECTOR_DVID 3
236 #define DRM_MODE_SUBCONNECTOR_DVIA 4
237 #define DRM_MODE_SUBCONNECTOR_Composite 5
238 #define DRM_MODE_SUBCONNECTOR_SVIDEO 6
239 #define DRM_MODE_SUBCONNECTOR_Component 8
240 #define DRM_MODE_SUBCONNECTOR_SCART 9
242 #define DRM_MODE_CONNECTOR_Unknown 0
243 #define DRM_MODE_CONNECTOR_VGA 1
244 #define DRM_MODE_CONNECTOR_DVII 2
245 #define DRM_MODE_CONNECTOR_DVID 3
246 #define DRM_MODE_CONNECTOR_DVIA 4
247 #define DRM_MODE_CONNECTOR_Composite 5
248 #define DRM_MODE_CONNECTOR_SVIDEO 6
249 #define DRM_MODE_CONNECTOR_LVDS 7
250 #define DRM_MODE_CONNECTOR_Component 8
251 #define DRM_MODE_CONNECTOR_9PinDIN 9
252 #define DRM_MODE_CONNECTOR_DisplayPort 10
253 #define DRM_MODE_CONNECTOR_HDMIA 11
254 #define DRM_MODE_CONNECTOR_HDMIB 12
255 #define DRM_MODE_CONNECTOR_TV 13
256 #define DRM_MODE_CONNECTOR_eDP 14
257 #define DRM_MODE_CONNECTOR_VIRTUAL 15
258 #define DRM_MODE_CONNECTOR_DSI 16
260 struct drm_mode_get_connector {
265 __u64 prop_values_ptr;
269 __u32 count_encoders;
271 __u32 encoder_id; /**< Current Encoder */
272 __u32 connector_id; /**< Id */
273 __u32 connector_type;
274 __u32 connector_type_id;
277 __u32 mm_width; /**< width in millimeters */
278 __u32 mm_height; /**< height in millimeters */
284 #define DRM_MODE_PROP_PENDING (1<<0)
285 #define DRM_MODE_PROP_RANGE (1<<1)
286 #define DRM_MODE_PROP_IMMUTABLE (1<<2)
287 #define DRM_MODE_PROP_ENUM (1<<3) /* enumerated type with text strings */
288 #define DRM_MODE_PROP_BLOB (1<<4)
289 #define DRM_MODE_PROP_BITMASK (1<<5) /* bitmask of enumerated types */
291 /* non-extended types: legacy bitmask, one bit per type: */
292 #define DRM_MODE_PROP_LEGACY_TYPE ( \
293 DRM_MODE_PROP_RANGE | \
294 DRM_MODE_PROP_ENUM | \
295 DRM_MODE_PROP_BLOB | \
296 DRM_MODE_PROP_BITMASK)
298 /* extended-types: rather than continue to consume a bit per type,
299 * grab a chunk of the bits to use as integer type id.
301 #define DRM_MODE_PROP_EXTENDED_TYPE 0x0000ffc0
302 #define DRM_MODE_PROP_TYPE(n) ((n) << 6)
303 #define DRM_MODE_PROP_OBJECT DRM_MODE_PROP_TYPE(1)
304 #define DRM_MODE_PROP_SIGNED_RANGE DRM_MODE_PROP_TYPE(2)
306 /* the PROP_ATOMIC flag is used to hide properties from userspace that
307 * is not aware of atomic properties. This is mostly to work around
308 * older userspace (DDX drivers) that read/write each prop they find,
309 * witout being aware that this could be triggering a lengthy modeset.
311 #define DRM_MODE_PROP_ATOMIC 0x80000000
313 struct drm_mode_property_enum {
315 char name[DRM_PROP_NAME_LEN];
318 struct drm_mode_get_property {
319 __u64 values_ptr; /* values and blob lengths */
320 __u64 enum_blob_ptr; /* enum and blob id ptrs */
324 char name[DRM_PROP_NAME_LEN];
327 /* This is only used to count enum values, not blobs. The _blobs is
328 * simply because of a historical reason, i.e. backwards compat. */
329 __u32 count_enum_blobs;
332 struct drm_mode_connector_set_property {
338 struct drm_mode_obj_get_properties {
340 __u64 prop_values_ptr;
346 struct drm_mode_obj_set_property {
353 struct drm_mode_get_blob {
359 struct drm_mode_fb_cmd {
366 /* driver specific handle */
370 #define DRM_MODE_FB_INTERLACED (1<<0) /* for interlaced framebuffers */
371 #define DRM_MODE_FB_MODIFIERS (1<<1) /* enables ->modifer[] */
373 struct drm_mode_fb_cmd2 {
377 __u32 pixel_format; /* fourcc code from drm_fourcc.h */
378 __u32 flags; /* see above flags */
381 * In case of planar formats, this ioctl allows up to 4
382 * buffer objects with offsets and pitches per plane.
383 * The pitch and offset order is dictated by the fourcc,
384 * e.g. NV12 (http://fourcc.org/yuv.php#NV12) is described as:
386 * YUV 4:2:0 image with a plane of 8 bit Y samples
387 * followed by an interleaved U/V plane containing
388 * 8 bit 2x2 subsampled colour difference samples.
390 * So it would consist of Y as offsets[0] and UV as
391 * offsets[1]. Note that offsets[0] will generally
392 * be 0 (but this is not required).
394 * To accommodate tiled, compressed, etc formats, a per-plane
395 * modifier can be specified. The default value of zero
396 * indicates "native" format as specified by the fourcc.
397 * Vendor specific modifier token. This allows, for example,
398 * different tiling/swizzling pattern on different planes.
399 * See discussion above of DRM_FORMAT_MOD_xxx.
402 __u32 pitches[4]; /* pitch for each plane */
403 __u32 offsets[4]; /* offset of each plane */
404 __u64 modifier[4]; /* ie, tiling, compressed (per plane) */
407 #define DRM_MODE_FB_DIRTY_ANNOTATE_COPY 0x01
408 #define DRM_MODE_FB_DIRTY_ANNOTATE_FILL 0x02
409 #define DRM_MODE_FB_DIRTY_FLAGS 0x03
411 #define DRM_MODE_FB_DIRTY_MAX_CLIPS 256
414 * Mark a region of a framebuffer as dirty.
416 * Some hardware does not automatically update display contents
417 * as a hardware or software draw to a framebuffer. This ioctl
418 * allows userspace to tell the kernel and the hardware what
419 * regions of the framebuffer have changed.
421 * The kernel or hardware is free to update more then just the
422 * region specified by the clip rects. The kernel or hardware
423 * may also delay and/or coalesce several calls to dirty into a
426 * Userspace may annotate the updates, the annotates are a
427 * promise made by the caller that the change is either a copy
428 * of pixels or a fill of a single color in the region specified.
430 * If the DRM_MODE_FB_DIRTY_ANNOTATE_COPY flag is given then
431 * the number of updated regions are half of num_clips given,
432 * where the clip rects are paired in src and dst. The width and
433 * height of each one of the pairs must match.
435 * If the DRM_MODE_FB_DIRTY_ANNOTATE_FILL flag is given the caller
436 * promises that the region specified of the clip rects is filled
437 * completely with a single color as given in the color argument.
440 struct drm_mode_fb_dirty_cmd {
448 struct drm_mode_mode_cmd {
450 struct drm_mode_modeinfo mode;
453 #define DRM_MODE_CURSOR_BO 0x01
454 #define DRM_MODE_CURSOR_MOVE 0x02
455 #define DRM_MODE_CURSOR_FLAGS 0x03
458 * depending on the value in flags different members are used.
464 * handle - if 0 turns the cursor off
471 struct drm_mode_cursor {
478 /* driver specific handle */
482 struct drm_mode_cursor2 {
489 /* driver specific handle */
495 struct drm_mode_crtc_lut {
499 /* pointers to arrays */
505 #define DRM_MODE_PAGE_FLIP_EVENT 0x01
506 #define DRM_MODE_PAGE_FLIP_ASYNC 0x02
507 #define DRM_MODE_PAGE_FLIP_FLAGS (DRM_MODE_PAGE_FLIP_EVENT|DRM_MODE_PAGE_FLIP_ASYNC)
510 * Request a page flip on the specified crtc.
512 * This ioctl will ask KMS to schedule a page flip for the specified
513 * crtc. Once any pending rendering targeting the specified fb (as of
514 * ioctl time) has completed, the crtc will be reprogrammed to display
515 * that fb after the next vertical refresh. The ioctl returns
516 * immediately, but subsequent rendering to the current fb will block
517 * in the execbuffer ioctl until the page flip happens. If a page
518 * flip is already pending as the ioctl is called, EBUSY will be
521 * Flag DRM_MODE_PAGE_FLIP_EVENT requests that drm sends back a vblank
522 * event (see drm.h: struct drm_event_vblank) when the page flip is
523 * done. The user_data field passed in with this ioctl will be
524 * returned as the user_data field in the vblank event struct.
526 * Flag DRM_MODE_PAGE_FLIP_ASYNC requests that the flip happen
527 * 'as soon as possible', meaning that it not delay waiting for vblank.
528 * This may cause tearing on the screen.
530 * The reserved field must be zero until we figure out something
531 * clever to use it for.
534 struct drm_mode_crtc_page_flip {
542 /* create a dumb scanout buffer */
543 struct drm_mode_create_dumb {
548 /* handle, pitch, size will be returned */
554 /* set up for mmap of a dumb scanout buffer */
555 struct drm_mode_map_dumb {
556 /** Handle for the object being mapped. */
560 * Fake offset to use for subsequent mmap call
562 * This is a fixed-size type for 32/64 compatibility.
567 struct drm_mode_destroy_dumb {
571 /* page-flip flags are valid, plus: */
572 #define DRM_MODE_ATOMIC_TEST_ONLY 0x0100
573 #define DRM_MODE_ATOMIC_NONBLOCK 0x0200
574 #define DRM_MODE_ATOMIC_ALLOW_MODESET 0x0400
576 #define DRM_MODE_ATOMIC_FLAGS (\
577 DRM_MODE_PAGE_FLIP_EVENT |\
578 DRM_MODE_PAGE_FLIP_ASYNC |\
579 DRM_MODE_ATOMIC_TEST_ONLY |\
580 DRM_MODE_ATOMIC_NONBLOCK |\
581 DRM_MODE_ATOMIC_ALLOW_MODESET)
583 struct drm_mode_atomic {
587 __u64 count_props_ptr;
589 __u64 prop_values_ptr;
595 * Create a new 'blob' data property, copying length bytes from data pointer,
596 * and returning new blob ID.
598 struct drm_mode_create_blob {
599 /** Pointer to data to copy. */
601 /** Length of data to copy. */
603 /** Return: new property ID. */
608 * Destroy a user-created blob property.
610 struct drm_mode_destroy_blob {