3 * Header for DRM modesetting interface.
5 * \author Jakob Bornecrantz <wallbraker@gmail.com>
7 * \par Acknowledgements:
8 * Feb 2007, Dave Airlie <airlied@linux.ie>
12 * Copyright (c) 2007-2008 Tungsten Graphics, Inc., Cedar Park, Texas.
13 * Copyright (c) 2007-2008 Dave Airlie <airlied@linux.ie>
14 * Copyright (c) 2007-2008 Jakob Bornecrantz <wallbraker@gmail.com>
16 * Permission is hereby granted, free of charge, to any person obtaining a
17 * copy of this software and associated documentation files (the "Software"),
18 * to deal in the Software without restriction, including without limitation
19 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
20 * and/or sell copies of the Software, and to permit persons to whom the
21 * Software is furnished to do so, subject to the following conditions:
23 * The above copyright notice and this permission notice shall be included in
24 * all copies or substantial portions of the Software.
26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
27 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
28 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
29 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
30 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
31 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
36 #ifndef _XF86DRMMODE_H_
37 #define _XF86DRMMODE_H_
39 #if defined(__cplusplus)
48 * This is the interface for modesetting for drm.
50 * In order to use this interface you must include either <stdint.h> or another
51 * header defining uint32_t, int32_t and uint16_t.
53 * It aims to provide a randr1.2 compatible interface for modesettings in the
54 * kernel, the interface is also meant to be used by libraries like EGL.
56 * More information can be found in randrproto.txt which can be found here:
57 * http://gitweb.freedesktop.org/?p=xorg/proto/randrproto.git
59 * There are some major differences to be noted. Unlike the randr1.2 proto you
60 * need to create the memory object of the framebuffer yourself with the ttm
61 * buffer object interface. This object needs to be pinned.
65 * If we pickup an old version of drm.h which doesn't include drm_mode.h
66 * we should redefine defines. This is so that builds doesn't breaks with
67 * new libdrm on old kernels.
71 #define DRM_DISPLAY_INFO_LEN 32
72 #define DRM_CONNECTOR_NAME_LEN 32
73 #define DRM_DISPLAY_MODE_LEN 32
74 #define DRM_PROP_NAME_LEN 32
76 #define DRM_MODE_TYPE_BUILTIN (1<<0)
77 #define DRM_MODE_TYPE_CLOCK_C ((1<<1) | DRM_MODE_TYPE_BUILTIN)
78 #define DRM_MODE_TYPE_CRTC_C ((1<<2) | DRM_MODE_TYPE_BUILTIN)
79 #define DRM_MODE_TYPE_PREFERRED (1<<3)
80 #define DRM_MODE_TYPE_DEFAULT (1<<4)
81 #define DRM_MODE_TYPE_USERDEF (1<<5)
82 #define DRM_MODE_TYPE_DRIVER (1<<6)
84 /* Video mode flags */
85 /* bit compatible with the xorg definitions. */
86 #define DRM_MODE_FLAG_PHSYNC (1<<0)
87 #define DRM_MODE_FLAG_NHSYNC (1<<1)
88 #define DRM_MODE_FLAG_PVSYNC (1<<2)
89 #define DRM_MODE_FLAG_NVSYNC (1<<3)
90 #define DRM_MODE_FLAG_INTERLACE (1<<4)
91 #define DRM_MODE_FLAG_DBLSCAN (1<<5)
92 #define DRM_MODE_FLAG_CSYNC (1<<6)
93 #define DRM_MODE_FLAG_PCSYNC (1<<7)
94 #define DRM_MODE_FLAG_NCSYNC (1<<8)
95 #define DRM_MODE_FLAG_HSKEW (1<<9) /* hskew provided */
96 #define DRM_MODE_FLAG_BCAST (1<<10)
97 #define DRM_MODE_FLAG_PIXMUX (1<<11)
98 #define DRM_MODE_FLAG_DBLCLK (1<<12)
99 #define DRM_MODE_FLAG_CLKDIV2 (1<<13)
100 #define DRM_MODE_FLAG_3D_MASK (0x1f<<14)
101 #define DRM_MODE_FLAG_3D_NONE (0<<14)
102 #define DRM_MODE_FLAG_3D_FRAME_PACKING (1<<14)
103 #define DRM_MODE_FLAG_3D_FIELD_ALTERNATIVE (2<<14)
104 #define DRM_MODE_FLAG_3D_LINE_ALTERNATIVE (3<<14)
105 #define DRM_MODE_FLAG_3D_SIDE_BY_SIDE_FULL (4<<14)
106 #define DRM_MODE_FLAG_3D_L_DEPTH (5<<14)
107 #define DRM_MODE_FLAG_3D_L_DEPTH_GFX_GFX_DEPTH (6<<14)
108 #define DRM_MODE_FLAG_3D_TOP_AND_BOTTOM (7<<14)
109 #define DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF (8<<14)
112 /* bit compatible with the xorg definitions. */
113 #define DRM_MODE_DPMS_ON 0
114 #define DRM_MODE_DPMS_STANDBY 1
115 #define DRM_MODE_DPMS_SUSPEND 2
116 #define DRM_MODE_DPMS_OFF 3
118 /* Scaling mode options */
119 #define DRM_MODE_SCALE_NON_GPU 0
120 #define DRM_MODE_SCALE_FULLSCREEN 1
121 #define DRM_MODE_SCALE_NO_SCALE 2
122 #define DRM_MODE_SCALE_ASPECT 3
124 /* Dithering mode options */
125 #define DRM_MODE_DITHERING_OFF 0
126 #define DRM_MODE_DITHERING_ON 1
128 #define DRM_MODE_ENCODER_NONE 0
129 #define DRM_MODE_ENCODER_DAC 1
130 #define DRM_MODE_ENCODER_TMDS 2
131 #define DRM_MODE_ENCODER_LVDS 3
132 #define DRM_MODE_ENCODER_TVDAC 4
133 #define DRM_MODE_ENCODER_VIRTUAL 5
134 #define DRM_MODE_ENCODER_DSI 6
135 #define DRM_MODE_ENCODER_DPMST 7
136 #define DRM_MODE_ENCODER_DPI 8
138 #define DRM_MODE_SUBCONNECTOR_Automatic 0
139 #define DRM_MODE_SUBCONNECTOR_Unknown 0
140 #define DRM_MODE_SUBCONNECTOR_DVID 3
141 #define DRM_MODE_SUBCONNECTOR_DVIA 4
142 #define DRM_MODE_SUBCONNECTOR_Composite 5
143 #define DRM_MODE_SUBCONNECTOR_SVIDEO 6
144 #define DRM_MODE_SUBCONNECTOR_Component 8
145 #define DRM_MODE_SUBCONNECTOR_SCART 9
147 #define DRM_MODE_CONNECTOR_Unknown 0
148 #define DRM_MODE_CONNECTOR_VGA 1
149 #define DRM_MODE_CONNECTOR_DVII 2
150 #define DRM_MODE_CONNECTOR_DVID 3
151 #define DRM_MODE_CONNECTOR_DVIA 4
152 #define DRM_MODE_CONNECTOR_Composite 5
153 #define DRM_MODE_CONNECTOR_SVIDEO 6
154 #define DRM_MODE_CONNECTOR_LVDS 7
155 #define DRM_MODE_CONNECTOR_Component 8
156 #define DRM_MODE_CONNECTOR_9PinDIN 9
157 #define DRM_MODE_CONNECTOR_DisplayPort 10
158 #define DRM_MODE_CONNECTOR_HDMIA 11
159 #define DRM_MODE_CONNECTOR_HDMIB 12
160 #define DRM_MODE_CONNECTOR_TV 13
161 #define DRM_MODE_CONNECTOR_eDP 14
162 #define DRM_MODE_CONNECTOR_VIRTUAL 15
163 #define DRM_MODE_CONNECTOR_DSI 16
164 #define DRM_MODE_CONNECTOR_DPI 17
166 #define DRM_MODE_PROP_PENDING (1<<0)
167 #define DRM_MODE_PROP_RANGE (1<<1)
168 #define DRM_MODE_PROP_IMMUTABLE (1<<2)
169 #define DRM_MODE_PROP_ENUM (1<<3) /* enumerated type with text strings */
170 #define DRM_MODE_PROP_BLOB (1<<4)
172 #define DRM_MODE_CURSOR_BO (1<<0)
173 #define DRM_MODE_CURSOR_MOVE (1<<1)
175 #endif /* _DRM_MODE_H */
181 * Just because these are defined doesn't mean that the kernel
182 * can do that feature, its just for new code vs old libdrm.
184 #define DRM_MODE_FEATURE_KMS 1
185 #define DRM_MODE_FEATURE_DIRTYFB 1
188 typedef struct _drmModeRes {
196 int count_connectors;
197 uint32_t *connectors;
202 uint32_t min_width, max_width;
203 uint32_t min_height, max_height;
204 } drmModeRes, *drmModeResPtr;
206 typedef struct _drmModeModeInfo {
208 uint16_t hdisplay, hsync_start, hsync_end, htotal, hskew;
209 uint16_t vdisplay, vsync_start, vsync_end, vtotal, vscan;
215 char name[DRM_DISPLAY_MODE_LEN];
216 } drmModeModeInfo, *drmModeModeInfoPtr;
218 typedef struct _drmModeFB {
220 uint32_t width, height;
224 /* driver specific handle */
226 } drmModeFB, *drmModeFBPtr;
228 typedef struct drm_clip_rect drmModeClip, *drmModeClipPtr;
230 typedef struct _drmModePropertyBlob {
234 } drmModePropertyBlobRes, *drmModePropertyBlobPtr;
236 typedef struct _drmModeProperty {
239 char name[DRM_PROP_NAME_LEN];
241 uint64_t *values; /* store the blob lengths */
243 struct drm_mode_property_enum *enums;
245 uint32_t *blob_ids; /* store the blob IDs */
246 } drmModePropertyRes, *drmModePropertyPtr;
248 static __inline int drm_property_type_is(drmModePropertyPtr property,
251 /* instanceof for props.. handles extended type vs original types: */
252 if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
253 return (property->flags & DRM_MODE_PROP_EXTENDED_TYPE) == type;
254 return property->flags & type;
257 typedef struct _drmModeCrtc {
259 uint32_t buffer_id; /**< FB id to connect to 0 = disconnect */
261 uint32_t x, y; /**< Position on the framebuffer */
262 uint32_t width, height;
264 drmModeModeInfo mode;
266 int gamma_size; /**< Number of gamma stops */
268 } drmModeCrtc, *drmModeCrtcPtr;
270 typedef struct _drmModeEncoder {
272 uint32_t encoder_type;
274 uint32_t possible_crtcs;
275 uint32_t possible_clones;
276 } drmModeEncoder, *drmModeEncoderPtr;
279 DRM_MODE_CONNECTED = 1,
280 DRM_MODE_DISCONNECTED = 2,
281 DRM_MODE_UNKNOWNCONNECTION = 3
285 DRM_MODE_SUBPIXEL_UNKNOWN = 1,
286 DRM_MODE_SUBPIXEL_HORIZONTAL_RGB = 2,
287 DRM_MODE_SUBPIXEL_HORIZONTAL_BGR = 3,
288 DRM_MODE_SUBPIXEL_VERTICAL_RGB = 4,
289 DRM_MODE_SUBPIXEL_VERTICAL_BGR = 5,
290 DRM_MODE_SUBPIXEL_NONE = 6
293 typedef struct _drmModeConnector {
294 uint32_t connector_id;
295 uint32_t encoder_id; /**< Encoder currently connected to */
296 uint32_t connector_type;
297 uint32_t connector_type_id;
298 drmModeConnection connection;
299 uint32_t mmWidth, mmHeight; /**< HxW in millimeters */
300 drmModeSubPixel subpixel;
303 drmModeModeInfoPtr modes;
306 uint32_t *props; /**< List of property ids */
307 uint64_t *prop_values; /**< List of property values */
310 uint32_t *encoders; /**< List of encoder ids */
311 } drmModeConnector, *drmModeConnectorPtr;
313 #define DRM_PLANE_TYPE_OVERLAY 0
314 #define DRM_PLANE_TYPE_PRIMARY 1
315 #define DRM_PLANE_TYPE_CURSOR 2
317 typedef struct _drmModeObjectProperties {
318 uint32_t count_props;
320 uint64_t *prop_values;
321 } drmModeObjectProperties, *drmModeObjectPropertiesPtr;
323 typedef struct _drmModePlane {
324 uint32_t count_formats;
331 uint32_t crtc_x, crtc_y;
334 uint32_t possible_crtcs;
336 } drmModePlane, *drmModePlanePtr;
338 typedef struct _drmModePlaneRes {
339 uint32_t count_planes;
341 } drmModePlaneRes, *drmModePlaneResPtr;
343 extern void drmModeFreeModeInfo( drmModeModeInfoPtr ptr );
344 extern void drmModeFreeResources( drmModeResPtr ptr );
345 extern void drmModeFreeFB( drmModeFBPtr ptr );
346 extern void drmModeFreeCrtc( drmModeCrtcPtr ptr );
347 extern void drmModeFreeConnector( drmModeConnectorPtr ptr );
348 extern void drmModeFreeEncoder( drmModeEncoderPtr ptr );
349 extern void drmModeFreePlane( drmModePlanePtr ptr );
350 extern void drmModeFreePlaneResources(drmModePlaneResPtr ptr);
353 * Retrieves all of the resources associated with a card.
355 extern drmModeResPtr drmModeGetResources(int fd);
358 * FrameBuffer manipulation.
362 * Retrieve information about framebuffer bufferId
364 extern drmModeFBPtr drmModeGetFB(int fd, uint32_t bufferId);
367 * Creates a new framebuffer with an buffer object as its scanout buffer.
369 extern int drmModeAddFB(int fd, uint32_t width, uint32_t height, uint8_t depth,
370 uint8_t bpp, uint32_t pitch, uint32_t bo_handle,
372 /* ...with a specific pixel format */
373 extern int drmModeAddFB2(int fd, uint32_t width, uint32_t height,
374 uint32_t pixel_format, const uint32_t bo_handles[4],
375 const uint32_t pitches[4], const uint32_t offsets[4],
376 uint32_t *buf_id, uint32_t flags);
378 /* ...with format modifiers */
379 int drmModeAddFB2WithModifiers(int fd, uint32_t width, uint32_t height,
380 uint32_t pixel_format, const uint32_t bo_handles[4],
381 const uint32_t pitches[4], const uint32_t offsets[4],
382 const uint64_t modifier[4], uint32_t *buf_id,
386 * Destroies the given framebuffer.
388 extern int drmModeRmFB(int fd, uint32_t bufferId);
391 * Mark a region of a framebuffer as dirty.
393 extern int drmModeDirtyFB(int fd, uint32_t bufferId,
394 drmModeClipPtr clips, uint32_t num_clips);
402 * Retrieve information about the ctrt crtcId
404 extern drmModeCrtcPtr drmModeGetCrtc(int fd, uint32_t crtcId);
407 * Set the mode on a crtc crtcId with the given mode modeId.
409 int drmModeSetCrtc(int fd, uint32_t crtcId, uint32_t bufferId,
410 uint32_t x, uint32_t y, uint32_t *connectors, int count,
411 drmModeModeInfoPtr mode);
418 * Set the cursor on crtc
420 int drmModeSetCursor(int fd, uint32_t crtcId, uint32_t bo_handle, uint32_t width, uint32_t height);
422 int drmModeSetCursor2(int fd, uint32_t crtcId, uint32_t bo_handle, uint32_t width, uint32_t height, int32_t hot_x, int32_t hot_y);
424 * Move the cursor on crtc
426 int drmModeMoveCursor(int fd, uint32_t crtcId, int x, int y);
431 drmModeEncoderPtr drmModeGetEncoder(int fd, uint32_t encoder_id);
434 * Connector manipulation
438 * Retrieve all information about the connector connectorId. This will do a
439 * forced probe on the connector to retrieve remote information such as EDIDs
440 * from the display device.
442 extern drmModeConnectorPtr drmModeGetConnector(int fd,
443 uint32_t connectorId);
446 * Retrieve current information, i.e the currently active mode and encoder,
447 * about the connector connectorId. This will not do any probing on the
448 * connector or remote device, and only reports what is currently known.
449 * For the complete set of modes and encoders associated with the connector
450 * use drmModeGetConnector() which will do a probe to determine any display
451 * link changes first.
453 extern drmModeConnectorPtr drmModeGetConnectorCurrent(int fd,
454 uint32_t connector_id);
457 * Attaches the given mode to an connector.
459 extern int drmModeAttachMode(int fd, uint32_t connectorId, drmModeModeInfoPtr mode_info);
462 * Detaches a mode from the connector
463 * must be unused, by the given mode.
465 extern int drmModeDetachMode(int fd, uint32_t connectorId, drmModeModeInfoPtr mode_info);
467 extern drmModePropertyPtr drmModeGetProperty(int fd, uint32_t propertyId);
468 extern void drmModeFreeProperty(drmModePropertyPtr ptr);
470 extern drmModePropertyBlobPtr drmModeGetPropertyBlob(int fd, uint32_t blob_id);
471 extern void drmModeFreePropertyBlob(drmModePropertyBlobPtr ptr);
472 extern int drmModeConnectorSetProperty(int fd, uint32_t connector_id, uint32_t property_id,
474 extern int drmCheckModesettingSupported(const char *busid);
476 extern int drmModeCrtcSetGamma(int fd, uint32_t crtc_id, uint32_t size,
477 uint16_t *red, uint16_t *green, uint16_t *blue);
478 extern int drmModeCrtcGetGamma(int fd, uint32_t crtc_id, uint32_t size,
479 uint16_t *red, uint16_t *green, uint16_t *blue);
480 extern int drmModePageFlip(int fd, uint32_t crtc_id, uint32_t fb_id,
481 uint32_t flags, void *user_data);
482 extern int drmModePageFlipTarget(int fd, uint32_t crtc_id, uint32_t fb_id,
483 uint32_t flags, void *user_data,
484 uint32_t target_vblank);
486 extern drmModePlaneResPtr drmModeGetPlaneResources(int fd);
487 extern drmModePlanePtr drmModeGetPlane(int fd, uint32_t plane_id);
488 extern int drmModeSetPlane(int fd, uint32_t plane_id, uint32_t crtc_id,
489 uint32_t fb_id, uint32_t flags,
490 int32_t crtc_x, int32_t crtc_y,
491 uint32_t crtc_w, uint32_t crtc_h,
492 uint32_t src_x, uint32_t src_y,
493 uint32_t src_w, uint32_t src_h);
495 extern drmModeObjectPropertiesPtr drmModeObjectGetProperties(int fd,
497 uint32_t object_type);
498 extern void drmModeFreeObjectProperties(drmModeObjectPropertiesPtr ptr);
499 extern int drmModeObjectSetProperty(int fd, uint32_t object_id,
500 uint32_t object_type, uint32_t property_id,
504 typedef struct _drmModeAtomicReq drmModeAtomicReq, *drmModeAtomicReqPtr;
506 extern drmModeAtomicReqPtr drmModeAtomicAlloc(void);
507 extern drmModeAtomicReqPtr drmModeAtomicDuplicate(drmModeAtomicReqPtr req);
508 extern int drmModeAtomicMerge(drmModeAtomicReqPtr base,
509 drmModeAtomicReqPtr augment);
510 extern void drmModeAtomicFree(drmModeAtomicReqPtr req);
511 extern int drmModeAtomicGetCursor(drmModeAtomicReqPtr req);
512 extern void drmModeAtomicSetCursor(drmModeAtomicReqPtr req, int cursor);
513 extern int drmModeAtomicAddProperty(drmModeAtomicReqPtr req,
515 uint32_t property_id,
517 extern int drmModeAtomicCommit(int fd,
518 drmModeAtomicReqPtr req,
522 extern int drmModeCreatePropertyBlob(int fd, const void *data, size_t size,
524 extern int drmModeDestroyPropertyBlob(int fd, uint32_t id);
527 * DRM mode lease APIs. These create and manage new drm_masters with
528 * access to a subset of the available DRM resources
531 extern int drmModeCreateLease(int fd, const uint32_t *objects, int num_objects, int flags, uint32_t *lessee_id);
533 typedef struct drmModeLesseeList {
536 } drmModeLesseeListRes, *drmModeLesseeListPtr;
538 extern drmModeLesseeListPtr drmModeListLessees(int fd);
540 typedef struct drmModeObjectList {
543 } drmModeObjectListRes, *drmModeObjectListPtr;
545 extern drmModeObjectListPtr drmModeGetLease(int fd);
547 extern int drmModeRevokeLease(int fd, uint32_t lessee_id);
549 #if defined(__cplusplus)