ee7c454449072f9eb7f7c703ae8789e7712d23f6
[glsdk/libdrm.git] / xf86drmMode.h
1 /*
2  * \file xf86drmMode.h
3  * Header for DRM modesetting interface.
4  *
5  * \author Jakob Bornecrantz <wallbraker@gmail.com>
6  *
7  * \par Acknowledgements:
8  * Feb 2007, Dave Airlie <airlied@linux.ie>
9  */
11 /*
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>
15  *
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:
22  *
23  * The above copyright notice and this permission notice shall be included in
24  * all copies or substantial portions of the Software.
25  *
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
32  * IN THE SOFTWARE.
33  *
34  */
36 #include <drm.h>
38 /*
39  * This is the interface for modesetting for drm.
40  *
41  * In order to use this interface you must include either <stdint.h> or another
42  * header defining uint32_t, int32_t and uint16_t.
43  *
44  * It aims to provide a randr1.2 compatible interface for modesettings in the
45  * kernel, the interface is also ment to be used by libraries like EGL.
46  *
47  * More information can be found in randrproto.txt which can be found here:
48  * http://gitweb.freedesktop.org/?p=xorg/proto/randrproto.git
49  *
50  * There are some major diffrences to be noted. Unlike the randr1.2 proto you
51  * need to create the memory object of the framebuffer yourself with the ttm
52  * buffer object interface. This object needs to be pinned.
53  */
55 /*
56  * If we pickup an old version of drm.h which doesn't include drm_mode.h
57  * we should redefine defines. This is so that builds doesn't breaks with
58  * new libdrm on old kernels.
59  */
60 #ifndef _DRM_MODE_H
62 #define DRM_DISPLAY_INFO_LEN    32
63 #define DRM_CONNECTOR_NAME_LEN  32
64 #define DRM_DISPLAY_MODE_LEN    32
65 #define DRM_PROP_NAME_LEN       32
67 #define DRM_MODE_TYPE_BUILTIN   (1<<0)
68 #define DRM_MODE_TYPE_CLOCK_C   ((1<<1) | DRM_MODE_TYPE_BUILTIN)
69 #define DRM_MODE_TYPE_CRTC_C    ((1<<2) | DRM_MODE_TYPE_BUILTIN)
70 #define DRM_MODE_TYPE_PREFERRED (1<<3)
71 #define DRM_MODE_TYPE_DEFAULT   (1<<4)
72 #define DRM_MODE_TYPE_USERDEF   (1<<5)
73 #define DRM_MODE_TYPE_DRIVER    (1<<6)
75 /* Video mode flags */
76 /* bit compatible with the xorg definitions. */
77 #define DRM_MODE_FLAG_PHSYNC    (1<<0)
78 #define DRM_MODE_FLAG_NHSYNC    (1<<1)
79 #define DRM_MODE_FLAG_PVSYNC    (1<<2)
80 #define DRM_MODE_FLAG_NVSYNC    (1<<3)
81 #define DRM_MODE_FLAG_INTERLACE (1<<4)
82 #define DRM_MODE_FLAG_DBLSCAN   (1<<5)
83 #define DRM_MODE_FLAG_CSYNC     (1<<6)
84 #define DRM_MODE_FLAG_PCSYNC    (1<<7)
85 #define DRM_MODE_FLAG_NCSYNC    (1<<8)
86 #define DRM_MODE_FLAG_HSKEW     (1<<9) /* hskew provided */
87 #define DRM_MODE_FLAG_BCAST     (1<<10)
88 #define DRM_MODE_FLAG_PIXMUX    (1<<11)
89 #define DRM_MODE_FLAG_DBLCLK    (1<<12)
90 #define DRM_MODE_FLAG_CLKDIV2   (1<<13)
92 /* DPMS flags */
93 /* bit compatible with the xorg definitions. */
94 #define DRM_MODE_DPMS_ON        0
95 #define DRM_MODE_DPMS_STANDBY   1
96 #define DRM_MODE_DPMS_SUSPEND   2
97 #define DRM_MODE_DPMS_OFF       3
99 /* Scaling mode options */
100 #define DRM_MODE_SCALE_NON_GPU          0
101 #define DRM_MODE_SCALE_FULLSCREEN       1
102 #define DRM_MODE_SCALE_NO_SCALE         2
103 #define DRM_MODE_SCALE_ASPECT           3
105 /* Dithering mode options */
106 #define DRM_MODE_DITHERING_OFF  0
107 #define DRM_MODE_DITHERING_ON   1
109 #define DRM_MODE_ENCODER_NONE   0
110 #define DRM_MODE_ENCODER_DAC    1
111 #define DRM_MODE_ENCODER_TMDS   2
112 #define DRM_MODE_ENCODER_LVDS   3
113 #define DRM_MODE_ENCODER_TVDAC  4
115 #define DRM_MODE_SUBCONNECTOR_Automatic 0
116 #define DRM_MODE_SUBCONNECTOR_Unknown   0
117 #define DRM_MODE_SUBCONNECTOR_DVID      3
118 #define DRM_MODE_SUBCONNECTOR_DVIA      4
119 #define DRM_MODE_SUBCONNECTOR_Composite 5
120 #define DRM_MODE_SUBCONNECTOR_SVIDEO    6
121 #define DRM_MODE_SUBCONNECTOR_Component 8
123 #define DRM_MODE_CONNECTOR_Unknown      0
124 #define DRM_MODE_CONNECTOR_VGA          1
125 #define DRM_MODE_CONNECTOR_DVII         2
126 #define DRM_MODE_CONNECTOR_DVID         3
127 #define DRM_MODE_CONNECTOR_DVIA         4
128 #define DRM_MODE_CONNECTOR_Composite    5
129 #define DRM_MODE_CONNECTOR_SVIDEO       6
130 #define DRM_MODE_CONNECTOR_LVDS         7
131 #define DRM_MODE_CONNECTOR_Component    8
132 #define DRM_MODE_CONNECTOR_9PinDIN      9
133 #define DRM_MODE_CONNECTOR_DisplayPort  10
134 #define DRM_MODE_CONNECTOR_HDMIA        11
135 #define DRM_MODE_CONNECTOR_HDMIB        12
136 #define DRM_MODE_CONNECTOR_TV           13
137 #define DRM_MODE_CONNECTOR_eDP          14
139 #define DRM_MODE_PROP_PENDING   (1<<0)
140 #define DRM_MODE_PROP_RANGE     (1<<1)
141 #define DRM_MODE_PROP_IMMUTABLE (1<<2)
142 #define DRM_MODE_PROP_ENUM      (1<<3) /* enumerated type with text strings */
143 #define DRM_MODE_PROP_BLOB      (1<<4)
145 #define DRM_MODE_CURSOR_BO      (1<<0)
146 #define DRM_MODE_CURSOR_MOVE    (1<<1)
148 #endif /* _DRM_MODE_H */
151 /*
152  * Feature defines
153  *
154  * Just because these are defined doesn't mean that the kernel
155  * can do that feature, its just for new code vs old libdrm.
156  */
157 #define DRM_MODE_FEATURE_KMS            1
158 #define DRM_MODE_FEATURE_DIRTYFB        1
161 typedef struct _drmModeRes {
163         int count_fbs;
164         uint32_t *fbs;
166         int count_crtcs;
167         uint32_t *crtcs;
169         int count_connectors;
170         uint32_t *connectors;
172         int count_encoders;
173         uint32_t *encoders;
175         uint32_t min_width, max_width;
176         uint32_t min_height, max_height;
177 } drmModeRes, *drmModeResPtr;
179 typedef struct _drmModeModeInfo {
180         uint32_t clock;
181         uint16_t hdisplay, hsync_start, hsync_end, htotal, hskew;
182         uint16_t vdisplay, vsync_start, vsync_end, vtotal, vscan;
184         uint32_t vrefresh;
186         uint32_t flags;
187         uint32_t type;
188         char name[DRM_DISPLAY_MODE_LEN];
189 } drmModeModeInfo, *drmModeModeInfoPtr;
191 typedef struct _drmModeFB {
192         uint32_t fb_id;
193         uint32_t width, height;
194         uint32_t pitch;
195         uint32_t bpp;
196         uint32_t depth;
197         /* driver specific handle */
198         uint32_t handle;
199 } drmModeFB, *drmModeFBPtr;
201 typedef struct drm_clip_rect drmModeClip, *drmModeClipPtr;
203 typedef struct _drmModePropertyBlob {
204         uint32_t id;
205         uint32_t length;
206         void *data;
207 } drmModePropertyBlobRes, *drmModePropertyBlobPtr;
209 typedef struct _drmModeProperty {
210         uint32_t prop_id;
211         uint32_t flags;
212         char name[DRM_PROP_NAME_LEN];
213         int count_values;
214         uint64_t *values; // store the blob lengths
215         int count_enums;
216         struct drm_mode_property_enum *enums;
217         int count_blobs;
218         uint32_t *blob_ids; // store the blob IDs
219 } drmModePropertyRes, *drmModePropertyPtr;
221 typedef struct _drmModeCrtc {
222         uint32_t crtc_id;
223         uint32_t buffer_id; /**< FB id to connect to 0 = disconnect */
225         uint32_t x, y; /**< Position on the framebuffer */
226         uint32_t width, height;
227         int mode_valid;
228         drmModeModeInfo mode;
230         int gamma_size; /**< Number of gamma stops */
232 } drmModeCrtc, *drmModeCrtcPtr;
234 typedef struct _drmModeEncoder {
235         uint32_t encoder_id;
236         uint32_t encoder_type;
237         uint32_t crtc_id;
238         uint32_t possible_crtcs;
239         uint32_t possible_clones;
240 } drmModeEncoder, *drmModeEncoderPtr;
242 typedef enum {
243         DRM_MODE_CONNECTED         = 1,
244         DRM_MODE_DISCONNECTED      = 2,
245         DRM_MODE_UNKNOWNCONNECTION = 3
246 } drmModeConnection;
248 typedef enum {
249         DRM_MODE_SUBPIXEL_UNKNOWN        = 1,
250         DRM_MODE_SUBPIXEL_HORIZONTAL_RGB = 2,
251         DRM_MODE_SUBPIXEL_HORIZONTAL_BGR = 3,
252         DRM_MODE_SUBPIXEL_VERTICAL_RGB   = 4,
253         DRM_MODE_SUBPIXEL_VERTICAL_BGR   = 5,
254         DRM_MODE_SUBPIXEL_NONE           = 6
255 } drmModeSubPixel;
257 typedef struct _drmModeConnector {
258         uint32_t connector_id;
259         uint32_t encoder_id; /**< Encoder currently connected to */
260         uint32_t connector_type;
261         uint32_t connector_type_id;
262         drmModeConnection connection;
263         uint32_t mmWidth, mmHeight; /**< HxW in millimeters */
264         drmModeSubPixel subpixel;
266         int count_modes;
267         drmModeModeInfoPtr modes;
269         int count_props;
270         uint32_t *props; /**< List of property ids */
271         uint64_t *prop_values; /**< List of property values */
273         int count_encoders;
274         uint32_t *encoders; /**< List of encoder ids */
275 } drmModeConnector, *drmModeConnectorPtr;
279 extern void drmModeFreeModeInfo( drmModeModeInfoPtr ptr );
280 extern void drmModeFreeResources( drmModeResPtr ptr );
281 extern void drmModeFreeFB( drmModeFBPtr ptr );
282 extern void drmModeFreeCrtc( drmModeCrtcPtr ptr );
283 extern void drmModeFreeConnector( drmModeConnectorPtr ptr );
284 extern void drmModeFreeEncoder( drmModeEncoderPtr ptr );
286 /**
287  * Retrives all of the resources associated with a card.
288  */
289 extern drmModeResPtr drmModeGetResources(int fd);
291 /*
292  * FrameBuffer manipulation.
293  */
295 /**
296  * Retrive information about framebuffer bufferId
297  */
298 extern drmModeFBPtr drmModeGetFB(int fd, uint32_t bufferId);
300 /**
301  * Creates a new framebuffer with an buffer object as its scanout buffer.
302  */
303 extern int drmModeAddFB(int fd, uint32_t width, uint32_t height, uint8_t depth,
304                         uint8_t bpp, uint32_t pitch, uint32_t bo_handle,
305                         uint32_t *buf_id);
306 /**
307  * Destroies the given framebuffer.
308  */
309 extern int drmModeRmFB(int fd, uint32_t bufferId);
311 /**
312  * Mark a region of a framebuffer as dirty.
313  */
314 extern int drmModeDirtyFB(int fd, uint32_t bufferId,
315                           drmModeClipPtr clips, uint32_t num_clips);
318 /*
319  * Crtc functions
320  */
322 /**
323  * Retrive information about the ctrt crtcId
324  */
325 extern drmModeCrtcPtr drmModeGetCrtc(int fd, uint32_t crtcId);
327 /**
328  * Set the mode on a crtc crtcId with the given mode modeId.
329  */
330 int drmModeSetCrtc(int fd, uint32_t crtcId, uint32_t bufferId,
331                    uint32_t x, uint32_t y, uint32_t *connectors, int count,
332                    drmModeModeInfoPtr mode);
334 /*
335  * Cursor functions
336  */
338 /**
339  * Set the cursor on crtc
340  */
341 int drmModeSetCursor(int fd, uint32_t crtcId, uint32_t bo_handle, uint32_t width, uint32_t height);
343 /**
344  * Move the cursor on crtc
345  */
346 int drmModeMoveCursor(int fd, uint32_t crtcId, int x, int y);
348 /**
349  * Encoder functions
350  */
351 drmModeEncoderPtr drmModeGetEncoder(int fd, uint32_t encoder_id);
353 /*
354  * Connector manipulation
355  */
357 /**
358  * Retrive information about the connector connectorId.
359  */
360 extern drmModeConnectorPtr drmModeGetConnector(int fd,
361                 uint32_t connectorId);
363 /**
364  * Attaches the given mode to an connector.
365  */
366 extern int drmModeAttachMode(int fd, uint32_t connectorId, drmModeModeInfoPtr mode_info);
368 /**
369  * Detaches a mode from the connector
370  * must be unused, by the given mode.
371  */
372 extern int drmModeDetachMode(int fd, uint32_t connectorId, drmModeModeInfoPtr mode_info);
374 extern drmModePropertyPtr drmModeGetProperty(int fd, uint32_t propertyId);
375 extern void drmModeFreeProperty(drmModePropertyPtr ptr);
377 extern drmModePropertyBlobPtr drmModeGetPropertyBlob(int fd, uint32_t blob_id);
378 extern void drmModeFreePropertyBlob(drmModePropertyBlobPtr ptr);
379 extern int drmModeConnectorSetProperty(int fd, uint32_t connector_id, uint32_t property_id,
380                                     uint64_t value);
381 extern int drmCheckModesettingSupported(const char *busid);
383 extern int drmModeCrtcSetGamma(int fd, uint32_t crtc_id, uint32_t size,
384                                uint16_t *red, uint16_t *green, uint16_t *blue);
385 extern int drmModeCrtcGetGamma(int fd, uint32_t crtc_id, uint32_t size,
386                                uint16_t *red, uint16_t *green, uint16_t *blue);
387 extern int drmModePageFlip(int fd, uint32_t crtc_id, uint32_t fb_id,
388                            uint32_t flags, void *user_data);