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) <year> <copyright holders>
14 * Permission is hereby granted, free of charge, to any person obtaining a
15 * copy of this software and associated documentation files (the "Software"),
16 * to deal in the Software without restriction, including without limitation
17 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
18 * and/or sell copies of the Software, and to permit persons to whom the
19 * Software is furnished to do so, subject to the following conditions:
21 * The above copyright notice and this permission notice shall be included in
22 * all copies or substantial portions of the Software.
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
27 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
38 * This is the interface for modesetting for drm.
40 * In order to use this interface you must include either <stdint.h> or another
41 * header defining uint32_t, int32_t and uint16_t.
43 * It aims to provide a randr1.2 compatible interface for modesettings in the
44 * kernel, the interface is also ment to be used by libraries like EGL.
46 * More information can be found in randrproto.txt which can be found here:
47 * http://gitweb.freedesktop.org/?p=xorg/proto/randrproto.git
49 * There are some major diffrences to be noted. Unlike the randr1.2 proto you
50 * need to create the memory object of the framebuffer yourself with the ttm
51 * buffer object interface. This object needs to be pinned.
55 typedef struct _drmModeRes {
66 uint32_t min_width, max_width;
67 uint32_t min_height, max_height;
68 } drmModeRes, *drmModeResPtr;
70 typedef struct drm_mode_fb_cmd drmModeFB, *drmModeFBPtr;
72 typedef struct _drmModeProperty {
75 unsigned char name[DRM_PROP_NAME_LEN];
79 struct drm_mode_property_enum *enums;
81 } drmModePropertyRes, *drmModePropertyPtr;
83 typedef struct _drmModeCrtc {
85 unsigned int buffer_id; /**< FB id to connect to 0 = disconnect*/
87 uint32_t x, y; /**< Position on the frameuffer */
88 uint32_t width, height;
90 struct drm_mode_modeinfo mode;
93 uint32_t outputs; /**< Outputs that are connected */
96 uint32_t possibles; /**< Outputs that can be connected */
98 int gamma_size; /**< Number of gamma stops */
100 } drmModeCrtc, *drmModeCrtcPtr;
103 DRM_MODE_CONNECTED = 1,
104 DRM_MODE_DISCONNECTED = 2,
105 DRM_MODE_UNKNOWNCONNECTION = 3
109 DRM_MODE_SUBPIXEL_UNKNOWN = 1,
110 DRM_MODE_SUBPIXEL_HORIZONTAL_RGB = 2,
111 DRM_MODE_SUBPIXEL_HORIZONTAL_BGR = 3,
112 DRM_MODE_SUBPIXEL_VERTICAL_RGB = 4,
113 DRM_MODE_SUBPIXEL_VERTICAL_BGR = 5,
114 DRM_MODE_SUBPIXEL_NONE = 6
117 typedef struct _drmModeOutput {
118 unsigned int output_id;
120 unsigned int crtc; /**< Crtc currently connected to */
121 unsigned char name[DRM_OUTPUT_NAME_LEN];
122 drmModeConnection connection;
123 uint32_t mmWidth, mmHeight; /**< HxW in millimeters */
124 drmModeSubPixel subpixel;
127 uint32_t crtcs; /**< Possible crtc to connect to */
130 uint32_t clones; /**< Mask of clones */
133 struct drm_mode_modeinfo *modes;
136 uint32_t *props; /**< List of property ids */
137 uint64_t *prop_values; /**< List of property values */
139 } drmModeOutput, *drmModeOutputPtr;
143 extern void drmModeFreeModeInfo( struct drm_mode_modeinfo *ptr );
144 extern void drmModeFreeResources( drmModeResPtr ptr );
145 extern void drmModeFreeFB( drmModeFBPtr ptr );
146 extern void drmModeFreeCrtc( drmModeCrtcPtr ptr );
147 extern void drmModeFreeOutput( drmModeOutputPtr ptr );
150 * Retrives all of the resources associated with a card.
152 extern drmModeResPtr drmModeGetResources(int fd);
156 * FrameBuffer manipulation.
160 * Retrive information about framebuffer bufferId
162 extern drmModeFBPtr drmModeGetFB(int fd, uint32_t bufferId);
165 * Creates a new framebuffer with an buffer object as its scanout buffer.
167 extern int drmModeAddFB(int fd, uint32_t width, uint32_t height, uint8_t depth,
168 uint8_t bpp, uint32_t pitch, drmBO *bo,
171 * Destroies the given framebuffer.
173 extern int drmModeRmFB(int fd, uint32_t bufferId);
181 * Retrive information about the ctrt crtcId
183 extern drmModeCrtcPtr drmModeGetCrtc(int fd, uint32_t crtcId);
186 * Set the mode on a crtc crtcId with the given mode modeId.
188 int drmModeSetCrtc(int fd, uint32_t crtcId, uint32_t bufferId,
189 uint32_t x, uint32_t y, uint32_t *outputs, int count,
190 struct drm_mode_modeinfo *mode);
194 * Output manipulation
198 * Retrive information about the output outputId.
200 extern drmModeOutputPtr drmModeGetOutput(int fd,
204 * Attaches the given mode to an output.
206 extern int drmModeAttachMode(int fd, uint32_t outputId, struct drm_mode_modeinfo *mode_info);
209 * Detaches a mode from the output
210 * must be unused, by the given mode.
212 extern int drmModeDetachMode(int fd, uint32_t outputId, struct drm_mode_modeinfo *mode_info);
214 extern drmModePropertyPtr drmModeGetProperty(int fd, uint32_t propertyId);
215 extern void drmModeFreeProperty(drmModePropertyPtr ptr);