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 #if defined(__cplusplus) || defined(c_plusplus)
43 * This is the interface for modesetting for drm.
45 * In order to use this interface you must include either <stdint.h> or another
46 * header defining uint32_t, int32_t and uint16_t.
48 * It aims to provide a randr1.2 compatible interface for modesettings in the
49 * kernel, the interface is also ment to be used by libraries like EGL.
51 * More information can be found in randrproto.txt which can be found here:
52 * http://gitweb.freedesktop.org/?p=xorg/proto/randrproto.git
54 * There are some major diffrences to be noted. Unlike the randr1.2 proto you
55 * need to create the memory object of the framebuffer yourself with the ttm
56 * buffer object interface. This object needs to be pinned.
60 * If we pickup an old version of drm.h which doesn't include drm_mode.h
61 * we should redefine defines. This is so that builds doesn't breaks with
62 * new libdrm on old kernels.
66 #define DRM_DISPLAY_INFO_LEN 32
67 #define DRM_CONNECTOR_NAME_LEN 32
68 #define DRM_DISPLAY_MODE_LEN 32
69 #define DRM_PROP_NAME_LEN 32
71 #define DRM_MODE_TYPE_BUILTIN (1<<0)
72 #define DRM_MODE_TYPE_CLOCK_C ((1<<1) | DRM_MODE_TYPE_BUILTIN)
73 #define DRM_MODE_TYPE_CRTC_C ((1<<2) | DRM_MODE_TYPE_BUILTIN)
74 #define DRM_MODE_TYPE_PREFERRED (1<<3)
75 #define DRM_MODE_TYPE_DEFAULT (1<<4)
76 #define DRM_MODE_TYPE_USERDEF (1<<5)
77 #define DRM_MODE_TYPE_DRIVER (1<<6)
79 /* Video mode flags */
80 /* bit compatible with the xorg definitions. */
81 #define DRM_MODE_FLAG_PHSYNC (1<<0)
82 #define DRM_MODE_FLAG_NHSYNC (1<<1)
83 #define DRM_MODE_FLAG_PVSYNC (1<<2)
84 #define DRM_MODE_FLAG_NVSYNC (1<<3)
85 #define DRM_MODE_FLAG_INTERLACE (1<<4)
86 #define DRM_MODE_FLAG_DBLSCAN (1<<5)
87 #define DRM_MODE_FLAG_CSYNC (1<<6)
88 #define DRM_MODE_FLAG_PCSYNC (1<<7)
89 #define DRM_MODE_FLAG_NCSYNC (1<<8)
90 #define DRM_MODE_FLAG_HSKEW (1<<9) /* hskew provided */
91 #define DRM_MODE_FLAG_BCAST (1<<10)
92 #define DRM_MODE_FLAG_PIXMUX (1<<11)
93 #define DRM_MODE_FLAG_DBLCLK (1<<12)
94 #define DRM_MODE_FLAG_CLKDIV2 (1<<13)
97 /* bit compatible with the xorg definitions. */
98 #define DRM_MODE_DPMS_ON 0
99 #define DRM_MODE_DPMS_STANDBY 1
100 #define DRM_MODE_DPMS_SUSPEND 2
101 #define DRM_MODE_DPMS_OFF 3
103 /* Scaling mode options */
104 #define DRM_MODE_SCALE_NON_GPU 0
105 #define DRM_MODE_SCALE_FULLSCREEN 1
106 #define DRM_MODE_SCALE_NO_SCALE 2
107 #define DRM_MODE_SCALE_ASPECT 3
109 /* Dithering mode options */
110 #define DRM_MODE_DITHERING_OFF 0
111 #define DRM_MODE_DITHERING_ON 1
113 #define DRM_MODE_ENCODER_NONE 0
114 #define DRM_MODE_ENCODER_DAC 1
115 #define DRM_MODE_ENCODER_TMDS 2
116 #define DRM_MODE_ENCODER_LVDS 3
117 #define DRM_MODE_ENCODER_TVDAC 4
119 #define DRM_MODE_SUBCONNECTOR_Automatic 0
120 #define DRM_MODE_SUBCONNECTOR_Unknown 0
121 #define DRM_MODE_SUBCONNECTOR_DVID 3
122 #define DRM_MODE_SUBCONNECTOR_DVIA 4
123 #define DRM_MODE_SUBCONNECTOR_Composite 5
124 #define DRM_MODE_SUBCONNECTOR_SVIDEO 6
125 #define DRM_MODE_SUBCONNECTOR_Component 8
127 #define DRM_MODE_CONNECTOR_Unknown 0
128 #define DRM_MODE_CONNECTOR_VGA 1
129 #define DRM_MODE_CONNECTOR_DVII 2
130 #define DRM_MODE_CONNECTOR_DVID 3
131 #define DRM_MODE_CONNECTOR_DVIA 4
132 #define DRM_MODE_CONNECTOR_Composite 5
133 #define DRM_MODE_CONNECTOR_SVIDEO 6
134 #define DRM_MODE_CONNECTOR_LVDS 7
135 #define DRM_MODE_CONNECTOR_Component 8
136 #define DRM_MODE_CONNECTOR_9PinDIN 9
137 #define DRM_MODE_CONNECTOR_DisplayPort 10
138 #define DRM_MODE_CONNECTOR_HDMIA 11
139 #define DRM_MODE_CONNECTOR_HDMIB 12
140 #define DRM_MODE_CONNECTOR_TV 13
141 #define DRM_MODE_CONNECTOR_eDP 14
143 #define DRM_MODE_PROP_PENDING (1<<0)
144 #define DRM_MODE_PROP_RANGE (1<<1)
145 #define DRM_MODE_PROP_IMMUTABLE (1<<2)
146 #define DRM_MODE_PROP_ENUM (1<<3) /* enumerated type with text strings */
147 #define DRM_MODE_PROP_BLOB (1<<4)
149 #define DRM_MODE_CURSOR_BO (1<<0)
150 #define DRM_MODE_CURSOR_MOVE (1<<1)
152 #endif /* _DRM_MODE_H */
158 * Just because these are defined doesn't mean that the kernel
159 * can do that feature, its just for new code vs old libdrm.
161 #define DRM_MODE_FEATURE_KMS 1
162 #define DRM_MODE_FEATURE_DIRTYFB 1
165 typedef struct _drmModeRes {
173 int count_connectors;
174 uint32_t *connectors;
179 uint32_t min_width, max_width;
180 uint32_t min_height, max_height;
181 } drmModeRes, *drmModeResPtr;
183 typedef struct _drmModeModeInfo {
185 uint16_t hdisplay, hsync_start, hsync_end, htotal, hskew;
186 uint16_t vdisplay, vsync_start, vsync_end, vtotal, vscan;
192 char name[DRM_DISPLAY_MODE_LEN];
193 } drmModeModeInfo, *drmModeModeInfoPtr;
195 typedef struct _drmModeFB {
197 uint32_t width, height;
201 /* driver specific handle */
203 } drmModeFB, *drmModeFBPtr;
205 typedef struct drm_clip_rect drmModeClip, *drmModeClipPtr;
207 typedef struct _drmModePropertyBlob {
211 } drmModePropertyBlobRes, *drmModePropertyBlobPtr;
213 typedef struct _drmModeProperty {
216 char name[DRM_PROP_NAME_LEN];
218 uint64_t *values; // store the blob lengths
220 struct drm_mode_property_enum *enums;
222 uint32_t *blob_ids; // store the blob IDs
223 } drmModePropertyRes, *drmModePropertyPtr;
225 typedef struct _drmModeCrtc {
227 uint32_t buffer_id; /**< FB id to connect to 0 = disconnect */
229 uint32_t x, y; /**< Position on the framebuffer */
230 uint32_t width, height;
232 drmModeModeInfo mode;
234 int gamma_size; /**< Number of gamma stops */
236 } drmModeCrtc, *drmModeCrtcPtr;
238 typedef struct _drmModeEncoder {
240 uint32_t encoder_type;
242 uint32_t possible_crtcs;
243 uint32_t possible_clones;
244 } drmModeEncoder, *drmModeEncoderPtr;
247 DRM_MODE_CONNECTED = 1,
248 DRM_MODE_DISCONNECTED = 2,
249 DRM_MODE_UNKNOWNCONNECTION = 3
253 DRM_MODE_SUBPIXEL_UNKNOWN = 1,
254 DRM_MODE_SUBPIXEL_HORIZONTAL_RGB = 2,
255 DRM_MODE_SUBPIXEL_HORIZONTAL_BGR = 3,
256 DRM_MODE_SUBPIXEL_VERTICAL_RGB = 4,
257 DRM_MODE_SUBPIXEL_VERTICAL_BGR = 5,
258 DRM_MODE_SUBPIXEL_NONE = 6
261 typedef struct _drmModeConnector {
262 uint32_t connector_id;
263 uint32_t encoder_id; /**< Encoder currently connected to */
264 uint32_t connector_type;
265 uint32_t connector_type_id;
266 drmModeConnection connection;
267 uint32_t mmWidth, mmHeight; /**< HxW in millimeters */
268 drmModeSubPixel subpixel;
271 drmModeModeInfoPtr modes;
274 uint32_t *props; /**< List of property ids */
275 uint64_t *prop_values; /**< List of property values */
278 uint32_t *encoders; /**< List of encoder ids */
279 } drmModeConnector, *drmModeConnectorPtr;
281 typedef struct _drmModePlane {
282 uint32_t count_formats;
289 uint32_t crtc_x, crtc_y;
292 uint32_t possible_crtcs;
294 } drmModePlane, *drmModePlanePtr;
296 typedef struct _drmModePlaneRes {
297 uint32_t count_planes;
299 } drmModePlaneRes, *drmModePlaneResPtr;
301 extern void drmModeFreeModeInfo( drmModeModeInfoPtr ptr );
302 extern void drmModeFreeResources( drmModeResPtr ptr );
303 extern void drmModeFreeFB( drmModeFBPtr ptr );
304 extern void drmModeFreeCrtc( drmModeCrtcPtr ptr );
305 extern void drmModeFreeConnector( drmModeConnectorPtr ptr );
306 extern void drmModeFreeEncoder( drmModeEncoderPtr ptr );
307 extern void drmModeFreePlane( drmModePlanePtr ptr );
308 extern void drmModeFreePlaneResources(drmModePlaneResPtr ptr);
311 * Retrives all of the resources associated with a card.
313 extern drmModeResPtr drmModeGetResources(int fd);
316 * FrameBuffer manipulation.
320 * Retrive information about framebuffer bufferId
322 extern drmModeFBPtr drmModeGetFB(int fd, uint32_t bufferId);
325 * Creates a new framebuffer with an buffer object as its scanout buffer.
327 extern int drmModeAddFB(int fd, uint32_t width, uint32_t height, uint8_t depth,
328 uint8_t bpp, uint32_t pitch, uint32_t bo_handle,
330 /* ...with a specific pixel format */
331 extern int drmModeAddFB2(int fd, uint32_t width, uint32_t height,
332 uint32_t pixel_format, uint32_t bo_handles[4],
333 uint32_t pitches[4], uint32_t offsets[4],
334 uint32_t *buf_id, uint32_t flags);
336 * Destroies the given framebuffer.
338 extern int drmModeRmFB(int fd, uint32_t bufferId);
341 * Mark a region of a framebuffer as dirty.
343 extern int drmModeDirtyFB(int fd, uint32_t bufferId,
344 drmModeClipPtr clips, uint32_t num_clips);
352 * Retrive information about the ctrt crtcId
354 extern drmModeCrtcPtr drmModeGetCrtc(int fd, uint32_t crtcId);
357 * Set the mode on a crtc crtcId with the given mode modeId.
359 int drmModeSetCrtc(int fd, uint32_t crtcId, uint32_t bufferId,
360 uint32_t x, uint32_t y, uint32_t *connectors, int count,
361 drmModeModeInfoPtr mode);
368 * Set the cursor on crtc
370 int drmModeSetCursor(int fd, uint32_t crtcId, uint32_t bo_handle, uint32_t width, uint32_t height);
373 * Move the cursor on crtc
375 int drmModeMoveCursor(int fd, uint32_t crtcId, int x, int y);
380 drmModeEncoderPtr drmModeGetEncoder(int fd, uint32_t encoder_id);
383 * Connector manipulation
387 * Retrive information about the connector connectorId.
389 extern drmModeConnectorPtr drmModeGetConnector(int fd,
390 uint32_t connectorId);
393 * Attaches the given mode to an connector.
395 extern int drmModeAttachMode(int fd, uint32_t connectorId, drmModeModeInfoPtr mode_info);
398 * Detaches a mode from the connector
399 * must be unused, by the given mode.
401 extern int drmModeDetachMode(int fd, uint32_t connectorId, drmModeModeInfoPtr mode_info);
403 extern drmModePropertyPtr drmModeGetProperty(int fd, uint32_t propertyId);
404 extern void drmModeFreeProperty(drmModePropertyPtr ptr);
406 extern drmModePropertyBlobPtr drmModeGetPropertyBlob(int fd, uint32_t blob_id);
407 extern void drmModeFreePropertyBlob(drmModePropertyBlobPtr ptr);
408 extern int drmModeConnectorSetProperty(int fd, uint32_t connector_id, uint32_t property_id,
410 extern int drmCheckModesettingSupported(const char *busid);
412 extern int drmModeCrtcSetGamma(int fd, uint32_t crtc_id, uint32_t size,
413 uint16_t *red, uint16_t *green, uint16_t *blue);
414 extern int drmModeCrtcGetGamma(int fd, uint32_t crtc_id, uint32_t size,
415 uint16_t *red, uint16_t *green, uint16_t *blue);
416 extern int drmModePageFlip(int fd, uint32_t crtc_id, uint32_t fb_id,
417 uint32_t flags, void *user_data);
419 extern drmModePlaneResPtr drmModeGetPlaneResources(int fd);
420 extern drmModePlanePtr drmModeGetPlane(int fd, uint32_t plane_id);
421 extern int drmModeSetPlane(int fd, uint32_t plane_id, uint32_t crtc_id,
422 uint32_t fb_id, uint32_t flags,
423 uint32_t crtc_x, uint32_t crtc_y,
424 uint32_t crtc_w, uint32_t crtc_h,
425 uint32_t src_x, uint32_t src_y,
426 uint32_t src_w, uint32_t src_h);
428 #if defined(__cplusplus) || defined(c_plusplus)