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)
78 /* bit compatible with the xorg definitions. */
79 #define DRM_MODE_DPMS_ON 0
80 #define DRM_MODE_DPMS_STANDBY 1
81 #define DRM_MODE_DPMS_SUSPEND 2
82 #define DRM_MODE_DPMS_OFF 3
84 /* Scaling mode options */
85 #define DRM_MODE_SCALE_NONE 0 /* Unmodified timing (display or
86 software can still scale) */
87 #define DRM_MODE_SCALE_FULLSCREEN 1 /* Full screen, ignore aspect */
88 #define DRM_MODE_SCALE_CENTER 2 /* Centered, no scaling */
89 #define DRM_MODE_SCALE_ASPECT 3 /* Full screen, preserve aspect */
91 /* Picture aspect ratio options */
92 #define DRM_MODE_PICTURE_ASPECT_NONE 0
93 #define DRM_MODE_PICTURE_ASPECT_4_3 1
94 #define DRM_MODE_PICTURE_ASPECT_16_9 2
96 /* Dithering mode options */
97 #define DRM_MODE_DITHERING_OFF 0
98 #define DRM_MODE_DITHERING_ON 1
99 #define DRM_MODE_DITHERING_AUTO 2
101 /* Dirty info options */
102 #define DRM_MODE_DIRTY_OFF 0
103 #define DRM_MODE_DIRTY_ON 1
104 #define DRM_MODE_DIRTY_ANNOTATE 2
106 struct drm_mode_modeinfo
{
108 __u16 hdisplay
, hsync_start
, hsync_end
, htotal
, hskew
;
109 __u16 vdisplay
, vsync_start
, vsync_end
, vtotal
, vscan
;
115 char name
[DRM_DISPLAY_MODE_LEN
];
118 struct drm_mode_card_res
{
121 __u64 connector_id_ptr
;
122 __u64 encoder_id_ptr
;
125 __u32 count_connectors
;
126 __u32 count_encoders
;
127 __u32 min_width
, max_width
;
128 __u32 min_height
, max_height
;
131 struct drm_mode_crtc
{
132 __u64 set_connectors_ptr
;
133 __u32 count_connectors
;
135 __u32 crtc_id
; /**< Id */
136 __u32 fb_id
; /**< Id of framebuffer */
138 __u32 x
, y
; /**< Position on the frameuffer */
142 struct drm_mode_modeinfo mode
;
145 #define DRM_MODE_PRESENT_TOP_FIELD (1<<0)
146 #define DRM_MODE_PRESENT_BOTTOM_FIELD (1<<1)
148 /* Planes blend with or override other bits on the CRTC */
149 struct drm_mode_set_plane
{
152 __u32 fb_id
; /* fb object contains surface format type */
153 __u32 flags
; /* see above flags */
155 /* Signed dest location allows it to be partially off screen */
156 __s32 crtc_x
, crtc_y
;
157 __u32 crtc_w
, crtc_h
;
159 /* Source values are 16.16 fixed point */
164 struct drm_mode_get_plane
{
170 __u32 possible_crtcs
;
173 __u32 count_format_types
;
174 __u64 format_type_ptr
;
177 struct drm_mode_get_plane_res
{
182 #define DRM_MODE_ENCODER_NONE 0
183 #define DRM_MODE_ENCODER_DAC 1
184 #define DRM_MODE_ENCODER_TMDS 2
185 #define DRM_MODE_ENCODER_LVDS 3
186 #define DRM_MODE_ENCODER_TVDAC 4
187 #define DRM_MODE_ENCODER_VIRTUAL 5
188 #define DRM_MODE_ENCODER_DSI 6
189 #define DRM_MODE_ENCODER_DPMST 7
191 struct drm_mode_get_encoder
{
195 __u32 crtc_id
; /**< Id of crtc */
197 __u32 possible_crtcs
;
198 __u32 possible_clones
;
201 /* This is for connectors with multiple signal types. */
202 /* Try to match DRM_MODE_CONNECTOR_X as closely as possible. */
203 #define DRM_MODE_SUBCONNECTOR_Automatic 0
204 #define DRM_MODE_SUBCONNECTOR_Unknown 0
205 #define DRM_MODE_SUBCONNECTOR_DVID 3
206 #define DRM_MODE_SUBCONNECTOR_DVIA 4
207 #define DRM_MODE_SUBCONNECTOR_Composite 5
208 #define DRM_MODE_SUBCONNECTOR_SVIDEO 6
209 #define DRM_MODE_SUBCONNECTOR_Component 8
210 #define DRM_MODE_SUBCONNECTOR_SCART 9
212 #define DRM_MODE_CONNECTOR_Unknown 0
213 #define DRM_MODE_CONNECTOR_VGA 1
214 #define DRM_MODE_CONNECTOR_DVII 2
215 #define DRM_MODE_CONNECTOR_DVID 3
216 #define DRM_MODE_CONNECTOR_DVIA 4
217 #define DRM_MODE_CONNECTOR_Composite 5
218 #define DRM_MODE_CONNECTOR_SVIDEO 6
219 #define DRM_MODE_CONNECTOR_LVDS 7
220 #define DRM_MODE_CONNECTOR_Component 8
221 #define DRM_MODE_CONNECTOR_9PinDIN 9
222 #define DRM_MODE_CONNECTOR_DisplayPort 10
223 #define DRM_MODE_CONNECTOR_HDMIA 11
224 #define DRM_MODE_CONNECTOR_HDMIB 12
225 #define DRM_MODE_CONNECTOR_TV 13
226 #define DRM_MODE_CONNECTOR_eDP 14
227 #define DRM_MODE_CONNECTOR_VIRTUAL 15
228 #define DRM_MODE_CONNECTOR_DSI 16
230 struct drm_mode_get_connector
{
235 __u64 prop_values_ptr
;
239 __u32 count_encoders
;
241 __u32 encoder_id
; /**< Current Encoder */
242 __u32 connector_id
; /**< Id */
243 __u32 connector_type
;
244 __u32 connector_type_id
;
247 __u32 mm_width
, mm_height
; /**< HxW in millimeters */
253 #define DRM_MODE_PROP_PENDING (1<<0)
254 #define DRM_MODE_PROP_RANGE (1<<1)
255 #define DRM_MODE_PROP_IMMUTABLE (1<<2)
256 #define DRM_MODE_PROP_ENUM (1<<3) /* enumerated type with text strings */
257 #define DRM_MODE_PROP_BLOB (1<<4)
258 #define DRM_MODE_PROP_BITMASK (1<<5) /* bitmask of enumerated types */
260 /* non-extended types: legacy bitmask, one bit per type: */
261 #define DRM_MODE_PROP_LEGACY_TYPE ( \
262 DRM_MODE_PROP_RANGE | \
263 DRM_MODE_PROP_ENUM | \
264 DRM_MODE_PROP_BLOB | \
265 DRM_MODE_PROP_BITMASK)
267 /* extended-types: rather than continue to consume a bit per type,
268 * grab a chunk of the bits to use as integer type id.
270 #define DRM_MODE_PROP_EXTENDED_TYPE 0x0000ffc0
271 #define DRM_MODE_PROP_TYPE(n) ((n) << 6)
272 #define DRM_MODE_PROP_OBJECT DRM_MODE_PROP_TYPE(1)
273 #define DRM_MODE_PROP_SIGNED_RANGE DRM_MODE_PROP_TYPE(2)
275 /* the PROP_ATOMIC flag is used to hide properties from userspace that
276 * is not aware of atomic properties. This is mostly to work around
277 * older userspace (DDX drivers) that read/write each prop they find,
278 * witout being aware that this could be triggering a lengthy modeset.
280 #define DRM_MODE_PROP_ATOMIC 0x80000000
282 struct drm_mode_property_enum
{
284 char name
[DRM_PROP_NAME_LEN
];
287 struct drm_mode_get_property
{
288 __u64 values_ptr
; /* values and blob lengths */
289 __u64 enum_blob_ptr
; /* enum and blob id ptrs */
293 char name
[DRM_PROP_NAME_LEN
];
296 /* This is only used to count enum values, not blobs. The _blobs is
297 * simply because of a historical reason, i.e. backwards compat. */
298 __u32 count_enum_blobs
;
301 struct drm_mode_connector_set_property
{
307 struct drm_mode_obj_get_properties
{
309 __u64 prop_values_ptr
;
315 struct drm_mode_obj_set_property
{
322 struct drm_mode_get_blob
{
328 struct drm_mode_fb_cmd
{
334 /* driver specific handle */
338 #define DRM_MODE_FB_INTERLACED (1<<0) /* for interlaced framebuffers */
339 #define DRM_MODE_FB_MODIFIERS (1<<1) /* enables ->modifer[] */
341 struct drm_mode_fb_cmd2
{
344 __u32 pixel_format
; /* fourcc code from drm_fourcc.h */
345 __u32 flags
; /* see above flags */
348 * In case of planar formats, this ioctl allows up to 4
349 * buffer objects with offsets and pitches per plane.
350 * The pitch and offset order is dictated by the fourcc,
351 * e.g. NV12 (http://fourcc.org/yuv.php#NV12) is described as:
353 * YUV 4:2:0 image with a plane of 8 bit Y samples
354 * followed by an interleaved U/V plane containing
355 * 8 bit 2x2 subsampled colour difference samples.
357 * So it would consist of Y as offsets[0] and UV as
358 * offsets[1]. Note that offsets[0] will generally
359 * be 0 (but this is not required).
361 * To accommodate tiled, compressed, etc formats, a per-plane
362 * modifier can be specified. The default value of zero
363 * indicates "native" format as specified by the fourcc.
364 * Vendor specific modifier token. This allows, for example,
365 * different tiling/swizzling pattern on different planes.
366 * See discussion above of DRM_FORMAT_MOD_xxx.
369 __u32 pitches
[4]; /* pitch for each plane */
370 __u32 offsets
[4]; /* offset of each plane */
371 __u64 modifier
[4]; /* ie, tiling, compressed (per plane) */
374 #define DRM_MODE_FB_DIRTY_ANNOTATE_COPY 0x01
375 #define DRM_MODE_FB_DIRTY_ANNOTATE_FILL 0x02
376 #define DRM_MODE_FB_DIRTY_FLAGS 0x03
378 #define DRM_MODE_FB_DIRTY_MAX_CLIPS 256
381 * Mark a region of a framebuffer as dirty.
383 * Some hardware does not automatically update display contents
384 * as a hardware or software draw to a framebuffer. This ioctl
385 * allows userspace to tell the kernel and the hardware what
386 * regions of the framebuffer have changed.
388 * The kernel or hardware is free to update more then just the
389 * region specified by the clip rects. The kernel or hardware
390 * may also delay and/or coalesce several calls to dirty into a
393 * Userspace may annotate the updates, the annotates are a
394 * promise made by the caller that the change is either a copy
395 * of pixels or a fill of a single color in the region specified.
397 * If the DRM_MODE_FB_DIRTY_ANNOTATE_COPY flag is given then
398 * the number of updated regions are half of num_clips given,
399 * where the clip rects are paired in src and dst. The width and
400 * height of each one of the pairs must match.
402 * If the DRM_MODE_FB_DIRTY_ANNOTATE_FILL flag is given the caller
403 * promises that the region specified of the clip rects is filled
404 * completely with a single color as given in the color argument.
407 struct drm_mode_fb_dirty_cmd
{
415 struct drm_mode_mode_cmd
{
417 struct drm_mode_modeinfo mode
;
420 #define DRM_MODE_CURSOR_BO 0x01
421 #define DRM_MODE_CURSOR_MOVE 0x02
422 #define DRM_MODE_CURSOR_FLAGS 0x03
425 * depending on the value in flags different members are used.
431 * handle - if 0 turns the cursor off
438 struct drm_mode_cursor
{
445 /* driver specific handle */
449 struct drm_mode_cursor2
{
456 /* driver specific handle */
462 struct drm_mode_crtc_lut
{
466 /* pointers to arrays */
472 #define DRM_MODE_PAGE_FLIP_EVENT 0x01
473 #define DRM_MODE_PAGE_FLIP_ASYNC 0x02
474 #define DRM_MODE_PAGE_FLIP_FLAGS (DRM_MODE_PAGE_FLIP_EVENT|DRM_MODE_PAGE_FLIP_ASYNC)
477 * Request a page flip on the specified crtc.
479 * This ioctl will ask KMS to schedule a page flip for the specified
480 * crtc. Once any pending rendering targeting the specified fb (as of
481 * ioctl time) has completed, the crtc will be reprogrammed to display
482 * that fb after the next vertical refresh. The ioctl returns
483 * immediately, but subsequent rendering to the current fb will block
484 * in the execbuffer ioctl until the page flip happens. If a page
485 * flip is already pending as the ioctl is called, EBUSY will be
488 * Flag DRM_MODE_PAGE_FLIP_EVENT requests that drm sends back a vblank
489 * event (see drm.h: struct drm_event_vblank) when the page flip is
490 * done. The user_data field passed in with this ioctl will be
491 * returned as the user_data field in the vblank event struct.
493 * Flag DRM_MODE_PAGE_FLIP_ASYNC requests that the flip happen
494 * 'as soon as possible', meaning that it not delay waiting for vblank.
495 * This may cause tearing on the screen.
497 * The reserved field must be zero until we figure out something
498 * clever to use it for.
501 struct drm_mode_crtc_page_flip
{
509 /* create a dumb scanout buffer */
510 struct drm_mode_create_dumb
{
515 /* handle, pitch, size will be returned */
521 /* set up for mmap of a dumb scanout buffer */
522 struct drm_mode_map_dumb
{
523 /** Handle for the object being mapped. */
527 * Fake offset to use for subsequent mmap call
529 * This is a fixed-size type for 32/64 compatibility.
534 struct drm_mode_destroy_dumb
{
538 /* page-flip flags are valid, plus: */
539 #define DRM_MODE_ATOMIC_TEST_ONLY 0x0100
540 #define DRM_MODE_ATOMIC_NONBLOCK 0x0200
541 #define DRM_MODE_ATOMIC_ALLOW_MODESET 0x0400
543 #define DRM_MODE_ATOMIC_FLAGS (\
544 DRM_MODE_PAGE_FLIP_EVENT |\
545 DRM_MODE_PAGE_FLIP_ASYNC |\
546 DRM_MODE_ATOMIC_TEST_ONLY |\
547 DRM_MODE_ATOMIC_NONBLOCK |\
548 DRM_MODE_ATOMIC_ALLOW_MODESET)
550 struct drm_mode_atomic
{
554 __u64 count_props_ptr
;
556 __u64 prop_values_ptr
;
562 * Create a new 'blob' data property, copying length bytes from data pointer,
563 * and returning new blob ID.
565 struct drm_mode_create_blob
{
566 /** Pointer to data to copy. */
568 /** Length of data to copy. */
570 /** Return: new property ID. */
575 * Destroy a user-created blob property.
577 struct drm_mode_destroy_blob
{