]> Gitweb @ Texas Instruments - Open Source Git Repositories - git.TI.com/gitweb - android/external-libgbm.git/blob - xf86drmMode.h
Merge pie-platform-release to aosp-master - DO NOT MERGE
[android/external-libgbm.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 #ifndef _XF86DRMMODE_H_
37 #define _XF86DRMMODE_H_
39 #if defined(__cplusplus)
40 extern "C" {
41 #endif
43 #include <drm.h>
45 /*
46  * This is the interface for modesetting for drm.
47  *
48  * In order to use this interface you must include either <stdint.h> or another
49  * header defining uint32_t, int32_t and uint16_t.
50  *
51  * It aims to provide a randr1.2 compatible interface for modesettings in the
52  * kernel, the interface is also ment to be used by libraries like EGL.
53  *
54  * More information can be found in randrproto.txt which can be found here:
55  * http://gitweb.freedesktop.org/?p=xorg/proto/randrproto.git
56  *
57  * There are some major diffrences to be noted. Unlike the randr1.2 proto you
58  * need to create the memory object of the framebuffer yourself with the ttm
59  * buffer object interface. This object needs to be pinned.
60  */
62 /*
63  * If we pickup an old version of drm.h which doesn't include drm_mode.h
64  * we should redefine defines. This is so that builds doesn't breaks with
65  * new libdrm on old kernels.
66  */
67 #ifndef _DRM_MODE_H
69 #define DRM_DISPLAY_INFO_LEN    32
70 #define DRM_CONNECTOR_NAME_LEN  32
71 #define DRM_DISPLAY_MODE_LEN    32
72 #define DRM_PROP_NAME_LEN       32
74 #define DRM_MODE_TYPE_BUILTIN   (1<<0)
75 #define DRM_MODE_TYPE_CLOCK_C   ((1<<1) | DRM_MODE_TYPE_BUILTIN)
76 #define DRM_MODE_TYPE_CRTC_C    ((1<<2) | DRM_MODE_TYPE_BUILTIN)
77 #define DRM_MODE_TYPE_PREFERRED (1<<3)
78 #define DRM_MODE_TYPE_DEFAULT   (1<<4)
79 #define DRM_MODE_TYPE_USERDEF   (1<<5)
80 #define DRM_MODE_TYPE_DRIVER    (1<<6)
82 /* Video mode flags */
83 /* bit compatible with the xorg definitions. */
84 #define DRM_MODE_FLAG_PHSYNC                    (1<<0)
85 #define DRM_MODE_FLAG_NHSYNC                    (1<<1)
86 #define DRM_MODE_FLAG_PVSYNC                    (1<<2)
87 #define DRM_MODE_FLAG_NVSYNC                    (1<<3)
88 #define DRM_MODE_FLAG_INTERLACE                 (1<<4)
89 #define DRM_MODE_FLAG_DBLSCAN                   (1<<5)
90 #define DRM_MODE_FLAG_CSYNC                     (1<<6)
91 #define DRM_MODE_FLAG_PCSYNC                    (1<<7)
92 #define DRM_MODE_FLAG_NCSYNC                    (1<<8)
93 #define DRM_MODE_FLAG_HSKEW                     (1<<9) /* hskew provided */
94 #define DRM_MODE_FLAG_BCAST                     (1<<10)
95 #define DRM_MODE_FLAG_PIXMUX                    (1<<11)
96 #define DRM_MODE_FLAG_DBLCLK                    (1<<12)
97 #define DRM_MODE_FLAG_CLKDIV2                   (1<<13)
98 #define DRM_MODE_FLAG_3D_MASK                   (0x1f<<14)
99 #define  DRM_MODE_FLAG_3D_NONE                  (0<<14)
100 #define  DRM_MODE_FLAG_3D_FRAME_PACKING         (1<<14)
101 #define  DRM_MODE_FLAG_3D_FIELD_ALTERNATIVE     (2<<14)
102 #define  DRM_MODE_FLAG_3D_LINE_ALTERNATIVE      (3<<14)
103 #define  DRM_MODE_FLAG_3D_SIDE_BY_SIDE_FULL     (4<<14)
104 #define  DRM_MODE_FLAG_3D_L_DEPTH               (5<<14)
105 #define  DRM_MODE_FLAG_3D_L_DEPTH_GFX_GFX_DEPTH (6<<14)
106 #define  DRM_MODE_FLAG_3D_TOP_AND_BOTTOM        (7<<14)
107 #define  DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF     (8<<14)
109 /* DPMS flags */
110 /* bit compatible with the xorg definitions. */
111 #define DRM_MODE_DPMS_ON        0
112 #define DRM_MODE_DPMS_STANDBY   1
113 #define DRM_MODE_DPMS_SUSPEND   2
114 #define DRM_MODE_DPMS_OFF       3
116 /* Scaling mode options */
117 #define DRM_MODE_SCALE_NON_GPU          0
118 #define DRM_MODE_SCALE_FULLSCREEN       1
119 #define DRM_MODE_SCALE_NO_SCALE         2
120 #define DRM_MODE_SCALE_ASPECT           3
122 /* Dithering mode options */
123 #define DRM_MODE_DITHERING_OFF  0
124 #define DRM_MODE_DITHERING_ON   1
126 #define DRM_MODE_ENCODER_NONE    0
127 #define DRM_MODE_ENCODER_DAC     1
128 #define DRM_MODE_ENCODER_TMDS    2
129 #define DRM_MODE_ENCODER_LVDS    3
130 #define DRM_MODE_ENCODER_TVDAC   4
131 #define DRM_MODE_ENCODER_VIRTUAL 5
132 #define DRM_MODE_ENCODER_DSI     6
133 #define DRM_MODE_ENCODER_DPMST   7
134 #define DRM_MODE_ENCODER_DPI     8
136 #define DRM_MODE_SUBCONNECTOR_Automatic 0
137 #define DRM_MODE_SUBCONNECTOR_Unknown   0
138 #define DRM_MODE_SUBCONNECTOR_DVID      3
139 #define DRM_MODE_SUBCONNECTOR_DVIA      4
140 #define DRM_MODE_SUBCONNECTOR_Composite 5
141 #define DRM_MODE_SUBCONNECTOR_SVIDEO    6
142 #define DRM_MODE_SUBCONNECTOR_Component 8
143 #define DRM_MODE_SUBCONNECTOR_SCART     9
145 #define DRM_MODE_CONNECTOR_Unknown      0
146 #define DRM_MODE_CONNECTOR_VGA          1
147 #define DRM_MODE_CONNECTOR_DVII         2
148 #define DRM_MODE_CONNECTOR_DVID         3
149 #define DRM_MODE_CONNECTOR_DVIA         4
150 #define DRM_MODE_CONNECTOR_Composite    5
151 #define DRM_MODE_CONNECTOR_SVIDEO       6
152 #define DRM_MODE_CONNECTOR_LVDS         7
153 #define DRM_MODE_CONNECTOR_Component    8
154 #define DRM_MODE_CONNECTOR_9PinDIN      9
155 #define DRM_MODE_CONNECTOR_DisplayPort  10
156 #define DRM_MODE_CONNECTOR_HDMIA        11
157 #define DRM_MODE_CONNECTOR_HDMIB        12
158 #define DRM_MODE_CONNECTOR_TV           13
159 #define DRM_MODE_CONNECTOR_eDP          14
160 #define DRM_MODE_CONNECTOR_VIRTUAL      15
161 #define DRM_MODE_CONNECTOR_DSI          16
162 #define DRM_MODE_CONNECTOR_DPI          17
164 #define DRM_MODE_PROP_PENDING   (1<<0)
165 #define DRM_MODE_PROP_RANGE     (1<<1)
166 #define DRM_MODE_PROP_IMMUTABLE (1<<2)
167 #define DRM_MODE_PROP_ENUM      (1<<3) /* enumerated type with text strings */
168 #define DRM_MODE_PROP_BLOB      (1<<4)
170 #define DRM_MODE_CURSOR_BO      (1<<0)
171 #define DRM_MODE_CURSOR_MOVE    (1<<1)
173 #endif /* _DRM_MODE_H */
176 /*
177  * Feature defines
178  *
179  * Just because these are defined doesn't mean that the kernel
180  * can do that feature, its just for new code vs old libdrm.
181  */
182 #define DRM_MODE_FEATURE_KMS            1
183 #define DRM_MODE_FEATURE_DIRTYFB        1
186 typedef struct _drmModeRes {
188         int count_fbs;
189         uint32_t *fbs;
191         int count_crtcs;
192         uint32_t *crtcs;
194         int count_connectors;
195         uint32_t *connectors;
197         int count_encoders;
198         uint32_t *encoders;
200         uint32_t min_width, max_width;
201         uint32_t min_height, max_height;
202 } drmModeRes, *drmModeResPtr;
204 typedef struct _drmModeModeInfo {
205         uint32_t clock;
206         uint16_t hdisplay, hsync_start, hsync_end, htotal, hskew;
207         uint16_t vdisplay, vsync_start, vsync_end, vtotal, vscan;
209         uint32_t vrefresh;
211         uint32_t flags;
212         uint32_t type;
213         char name[DRM_DISPLAY_MODE_LEN];
214 } drmModeModeInfo, *drmModeModeInfoPtr;
216 typedef struct _drmModeFB {
217         uint32_t fb_id;
218         uint32_t width, height;
219         uint32_t pitch;
220         uint32_t bpp;
221         uint32_t depth;
222         /* driver specific handle */
223         uint32_t handle;
224 } drmModeFB, *drmModeFBPtr;
226 typedef struct drm_clip_rect drmModeClip, *drmModeClipPtr;
228 typedef struct _drmModePropertyBlob {
229         uint32_t id;
230         uint32_t length;
231         void *data;
232 } drmModePropertyBlobRes, *drmModePropertyBlobPtr;
234 typedef struct _drmModeProperty {
235         uint32_t prop_id;
236         uint32_t flags;
237         char name[DRM_PROP_NAME_LEN];
238         int count_values;
239         uint64_t *values; /* store the blob lengths */
240         int count_enums;
241         struct drm_mode_property_enum *enums;
242         int count_blobs;
243         uint32_t *blob_ids; /* store the blob IDs */
244 } drmModePropertyRes, *drmModePropertyPtr;
246 static __inline int drm_property_type_is(drmModePropertyPtr property,
247                 uint32_t type)
249         /* instanceof for props.. handles extended type vs original types: */
250         if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
251                 return (property->flags & DRM_MODE_PROP_EXTENDED_TYPE) == type;
252         return property->flags & type;
255 typedef struct _drmModeCrtc {
256         uint32_t crtc_id;
257         uint32_t buffer_id; /**< FB id to connect to 0 = disconnect */
259         uint32_t x, y; /**< Position on the framebuffer */
260         uint32_t width, height;
261         int mode_valid;
262         drmModeModeInfo mode;
264         int gamma_size; /**< Number of gamma stops */
266 } drmModeCrtc, *drmModeCrtcPtr;
268 typedef struct _drmModeEncoder {
269         uint32_t encoder_id;
270         uint32_t encoder_type;
271         uint32_t crtc_id;
272         uint32_t possible_crtcs;
273         uint32_t possible_clones;
274 } drmModeEncoder, *drmModeEncoderPtr;
276 typedef enum {
277         DRM_MODE_CONNECTED         = 1,
278         DRM_MODE_DISCONNECTED      = 2,
279         DRM_MODE_UNKNOWNCONNECTION = 3
280 } drmModeConnection;
282 typedef enum {
283         DRM_MODE_SUBPIXEL_UNKNOWN        = 1,
284         DRM_MODE_SUBPIXEL_HORIZONTAL_RGB = 2,
285         DRM_MODE_SUBPIXEL_HORIZONTAL_BGR = 3,
286         DRM_MODE_SUBPIXEL_VERTICAL_RGB   = 4,
287         DRM_MODE_SUBPIXEL_VERTICAL_BGR   = 5,
288         DRM_MODE_SUBPIXEL_NONE           = 6
289 } drmModeSubPixel;
291 typedef struct _drmModeConnector {
292         uint32_t connector_id;
293         uint32_t encoder_id; /**< Encoder currently connected to */
294         uint32_t connector_type;
295         uint32_t connector_type_id;
296         drmModeConnection connection;
297         uint32_t mmWidth, mmHeight; /**< HxW in millimeters */
298         drmModeSubPixel subpixel;
300         int count_modes;
301         drmModeModeInfoPtr modes;
303         int count_props;
304         uint32_t *props; /**< List of property ids */
305         uint64_t *prop_values; /**< List of property values */
307         int count_encoders;
308         uint32_t *encoders; /**< List of encoder ids */
309 } drmModeConnector, *drmModeConnectorPtr;
311 #define DRM_PLANE_TYPE_OVERLAY 0
312 #define DRM_PLANE_TYPE_PRIMARY 1
313 #define DRM_PLANE_TYPE_CURSOR  2
315 typedef struct _drmModeObjectProperties {
316         uint32_t count_props;
317         uint32_t *props;
318         uint64_t *prop_values;
319 } drmModeObjectProperties, *drmModeObjectPropertiesPtr;
321 typedef struct _drmModePlane {
322         uint32_t count_formats;
323         uint32_t *formats;
324         uint32_t plane_id;
326         uint32_t crtc_id;
327         uint32_t fb_id;
329         uint32_t crtc_x, crtc_y;
330         uint32_t x, y;
332         uint32_t possible_crtcs;
333         uint32_t gamma_size;
334 } drmModePlane, *drmModePlanePtr;
336 typedef struct _drmModePlaneRes {
337         uint32_t count_planes;
338         uint32_t *planes;
339 } drmModePlaneRes, *drmModePlaneResPtr;
341 extern void drmModeFreeModeInfo( drmModeModeInfoPtr ptr );
342 extern void drmModeFreeResources( drmModeResPtr ptr );
343 extern void drmModeFreeFB( drmModeFBPtr ptr );
344 extern void drmModeFreeCrtc( drmModeCrtcPtr ptr );
345 extern void drmModeFreeConnector( drmModeConnectorPtr ptr );
346 extern void drmModeFreeEncoder( drmModeEncoderPtr ptr );
347 extern void drmModeFreePlane( drmModePlanePtr ptr );
348 extern void drmModeFreePlaneResources(drmModePlaneResPtr ptr);
350 /**
351  * Retrives all of the resources associated with a card.
352  */
353 extern drmModeResPtr drmModeGetResources(int fd);
355 /*
356  * FrameBuffer manipulation.
357  */
359 /**
360  * Retrive information about framebuffer bufferId
361  */
362 extern drmModeFBPtr drmModeGetFB(int fd, uint32_t bufferId);
364 /**
365  * Creates a new framebuffer with an buffer object as its scanout buffer.
366  */
367 extern int drmModeAddFB(int fd, uint32_t width, uint32_t height, uint8_t depth,
368                         uint8_t bpp, uint32_t pitch, uint32_t bo_handle,
369                         uint32_t *buf_id);
370 /* ...with a specific pixel format */
371 extern int drmModeAddFB2(int fd, uint32_t width, uint32_t height,
372                          uint32_t pixel_format, const uint32_t bo_handles[4],
373                          const uint32_t pitches[4], const uint32_t offsets[4],
374                          uint32_t *buf_id, uint32_t flags);
376 /* ...with format modifiers */
377 int drmModeAddFB2WithModifiers(int fd, uint32_t width, uint32_t height,
378                                uint32_t pixel_format, const uint32_t bo_handles[4],
379                                const uint32_t pitches[4], const uint32_t offsets[4],
380                                const uint64_t modifier[4], uint32_t *buf_id,
381                                    uint32_t flags);
383 /**
384  * Destroies the given framebuffer.
385  */
386 extern int drmModeRmFB(int fd, uint32_t bufferId);
388 /**
389  * Mark a region of a framebuffer as dirty.
390  */
391 extern int drmModeDirtyFB(int fd, uint32_t bufferId,
392                           drmModeClipPtr clips, uint32_t num_clips);
395 /*
396  * Crtc functions
397  */
399 /**
400  * Retrive information about the ctrt crtcId
401  */
402 extern drmModeCrtcPtr drmModeGetCrtc(int fd, uint32_t crtcId);
404 /**
405  * Set the mode on a crtc crtcId with the given mode modeId.
406  */
407 int drmModeSetCrtc(int fd, uint32_t crtcId, uint32_t bufferId,
408                    uint32_t x, uint32_t y, uint32_t *connectors, int count,
409                    drmModeModeInfoPtr mode);
411 /*
412  * Cursor functions
413  */
415 /**
416  * Set the cursor on crtc
417  */
418 int drmModeSetCursor(int fd, uint32_t crtcId, uint32_t bo_handle, uint32_t width, uint32_t height);
420 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);
421 /**
422  * Move the cursor on crtc
423  */
424 int drmModeMoveCursor(int fd, uint32_t crtcId, int x, int y);
426 /**
427  * Encoder functions
428  */
429 drmModeEncoderPtr drmModeGetEncoder(int fd, uint32_t encoder_id);
431 /*
432  * Connector manipulation
433  */
435 /**
436  * Retrieve all information about the connector connectorId. This will do a
437  * forced probe on the connector to retrieve remote information such as EDIDs
438  * from the display device.
439  */
440 extern drmModeConnectorPtr drmModeGetConnector(int fd,
441                                                uint32_t connectorId);
443 /**
444  * Retrieve current information, i.e the currently active mode and encoder,
445  * about the connector connectorId. This will not do any probing on the
446  * connector or remote device, and only reports what is currently known.
447  * For the complete set of modes and encoders associated with the connector
448  * use drmModeGetConnector() which will do a probe to determine any display
449  * link changes first.
450  */
451 extern drmModeConnectorPtr drmModeGetConnectorCurrent(int fd,
452                                                       uint32_t connector_id);
454 /**
455  * Attaches the given mode to an connector.
456  */
457 extern int drmModeAttachMode(int fd, uint32_t connectorId, drmModeModeInfoPtr mode_info);
459 /**
460  * Detaches a mode from the connector
461  * must be unused, by the given mode.
462  */
463 extern int drmModeDetachMode(int fd, uint32_t connectorId, drmModeModeInfoPtr mode_info);
465 extern drmModePropertyPtr drmModeGetProperty(int fd, uint32_t propertyId);
466 extern void drmModeFreeProperty(drmModePropertyPtr ptr);
468 extern drmModePropertyBlobPtr drmModeGetPropertyBlob(int fd, uint32_t blob_id);
469 extern void drmModeFreePropertyBlob(drmModePropertyBlobPtr ptr);
470 extern int drmModeConnectorSetProperty(int fd, uint32_t connector_id, uint32_t property_id,
471                                     uint64_t value);
472 extern int drmCheckModesettingSupported(const char *busid);
474 extern int drmModeCrtcSetGamma(int fd, uint32_t crtc_id, uint32_t size,
475                                uint16_t *red, uint16_t *green, uint16_t *blue);
476 extern int drmModeCrtcGetGamma(int fd, uint32_t crtc_id, uint32_t size,
477                                uint16_t *red, uint16_t *green, uint16_t *blue);
478 extern int drmModePageFlip(int fd, uint32_t crtc_id, uint32_t fb_id,
479                            uint32_t flags, void *user_data);
480 extern int drmModePageFlipTarget(int fd, uint32_t crtc_id, uint32_t fb_id,
481                                  uint32_t flags, void *user_data,
482                                  uint32_t target_vblank);
484 extern drmModePlaneResPtr drmModeGetPlaneResources(int fd);
485 extern drmModePlanePtr drmModeGetPlane(int fd, uint32_t plane_id);
486 extern int drmModeSetPlane(int fd, uint32_t plane_id, uint32_t crtc_id,
487                            uint32_t fb_id, uint32_t flags,
488                            int32_t crtc_x, int32_t crtc_y,
489                            uint32_t crtc_w, uint32_t crtc_h,
490                            uint32_t src_x, uint32_t src_y,
491                            uint32_t src_w, uint32_t src_h);
493 extern drmModeObjectPropertiesPtr drmModeObjectGetProperties(int fd,
494                                                         uint32_t object_id,
495                                                         uint32_t object_type);
496 extern void drmModeFreeObjectProperties(drmModeObjectPropertiesPtr ptr);
497 extern int drmModeObjectSetProperty(int fd, uint32_t object_id,
498                                     uint32_t object_type, uint32_t property_id,
499                                     uint64_t value);
502 typedef struct _drmModeAtomicReq drmModeAtomicReq, *drmModeAtomicReqPtr;
504 extern drmModeAtomicReqPtr drmModeAtomicAlloc(void);
505 extern drmModeAtomicReqPtr drmModeAtomicDuplicate(drmModeAtomicReqPtr req);
506 extern int drmModeAtomicMerge(drmModeAtomicReqPtr base,
507                               drmModeAtomicReqPtr augment);
508 extern void drmModeAtomicFree(drmModeAtomicReqPtr req);
509 extern int drmModeAtomicGetCursor(drmModeAtomicReqPtr req);
510 extern void drmModeAtomicSetCursor(drmModeAtomicReqPtr req, int cursor);
511 extern int drmModeAtomicAddProperty(drmModeAtomicReqPtr req,
512                                     uint32_t object_id,
513                                     uint32_t property_id,
514                                     uint64_t value);
515 extern int drmModeAtomicCommit(int fd,
516                                drmModeAtomicReqPtr req,
517                                uint32_t flags,
518                                void *user_data);
520 extern int drmModeCreatePropertyBlob(int fd, const void *data, size_t size,
521                                      uint32_t *id);
522 extern int drmModeDestroyPropertyBlob(int fd, uint32_t id);
524 /*
525  * DRM mode lease APIs. These create and manage new drm_masters with
526  * access to a subset of the available DRM resources
527  */
529 extern int drmModeCreateLease(int fd, const uint32_t *objects, int num_objects, int flags, uint32_t *lessee_id);
531 typedef struct drmModeLesseeList {
532         uint32_t count;
533         uint32_t lessees[0];
534 } drmModeLesseeListRes, *drmModeLesseeListPtr;
536 extern drmModeLesseeListPtr drmModeListLessees(int fd);
538 typedef struct drmModeObjectList {
539         uint32_t count;
540         uint32_t objects[0];
541 } drmModeObjectListRes, *drmModeObjectListPtr;
543 extern drmModeObjectListPtr drmModeGetLease(int fd);
545 extern int drmModeRevokeLease(int fd, uint32_t lessee_id);
547 #if defined(__cplusplus)
549 #endif
551 #endif