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 randr 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 * All framebuffer, crtc and output ids start at 1 while 0 is either an invalid
50 * parameter or used to indicate that the command should disconnect from the
51 * currently bound target, as with drmModeMapOutput.
53 * Currently only one framebuffer exist and has a id of 1, which is also the
54 * default framebuffer and should allways be avaible to the client, unless
55 * it is locked/used or any other limiting state is applied on it.
59 typedef struct _drmModeGammaTriple {
61 } drmModeGammaTriple, *drmModeGammaTriplePtr;
63 typedef struct _drmModeRes {
75 struct drm_mode_modeinfo *modes;
77 } drmModeRes, *drmModeResPtr;
79 typedef struct drm_mode_fb_cmd drmModeFB, *drmModeFBPtr;
81 typedef struct _drmModeCrtc {
83 unsigned int buffer_id; /**< FB id to connect to 0 = disconnect*/
85 uint32_t x, y; /**< Position on the frameuffer */
86 uint32_t width, height;
87 uint32_t mode; /**< Current mode used */
90 uint32_t outputs; /**< Outputs that are connected */
93 uint32_t possibles; /**< Outputs that can be connected */
95 int gamma_size; /**< Number of gamma stops */
97 } drmModeCrtc, *drmModeCrtcPtr;
100 DRM_MODE_CONNECTED = 1,
101 DRM_MODE_DISCONNECTED = 2,
102 DRM_MODE_UNKNOWNCONNECTION = 3
106 DRM_MODE_SUBPIXEL_UNKNOWN = 1,
107 DRM_MODE_SUBPIXEL_HORIZONTAL_RGB = 2,
108 DRM_MODE_SUBPIXEL_HORIZONTAL_BGR = 3,
109 DRM_MODE_SUBPIXEL_VERTICAL_RGB = 4,
110 DRM_MODE_SUBPIXEL_VERTICAL_BGR = 5,
111 DRM_MODE_SUBPIXEL_NONE = 6
114 typedef struct _drmModeOutput {
116 unsigned int crtc; /**< Crtc currently connected to */
117 unsigned char name[DRM_OUTPUT_NAME_LEN];
118 drmModeConnection connection;
119 uint32_t mmWidth, mmHeight; /**< HxW in millimeters */
120 drmModeSubPixel subpixel;
123 uint32_t crtcs; /**< Possible crtc to connect to */
126 uint32_t clones; /**< Mask of clones */
129 uint32_t *modes; /**< List of modes ids */
131 } drmModeOutput, *drmModeOutputPtr;
134 * RRSetScreenConfig o
137 * RRGetScreenSizeRange - see frameBuffer info
139 * RRGetScreenResources
143 * RRListOutputProperties *
144 * RRQueryOutputProperty *
145 * RRConfigureOutputProperty *
146 * RRChangeOutputProperty *
147 * RRDeleteOutputProperty *
148 * RRGetOutputProperty *
158 * RRGetCrtcGammaSize - see crtc info
162 * drmModeGetResources
165 * drmModeGetFrameBufferInfo
166 * drmModeSetFrameBufferSize
169 * drmModeSetCrtcConfig
170 * drmModeGetCrtcGamma
171 * drmModeSetCrtcGamma
173 * drmModeGetOutputInfo
177 * drmModeAddOutputMode
178 * drmModeDeleteOutputMode
181 extern void drmModeFreeModeInfo( struct drm_mode_modeinfo *ptr );
182 extern void drmModeFreeResources( drmModeResPtr ptr );
183 extern void drmModeFreeFB( drmModeFBPtr ptr );
184 extern void drmModeFreeCrtc( drmModeCrtcPtr ptr );
185 extern void drmModeFreeOutput( drmModeOutputPtr ptr );
188 * Retrives all of the resources associated with a card.
190 extern drmModeResPtr drmModeGetResources(int fd);
193 * Forces a probe of the give output outputId, on 0 all will be probed.
195 extern int drmModeForceProbe(int fd, uint32_t outputId);
199 * FrameBuffer manipulation.
203 * Retrive information about framebuffer bufferId
205 extern drmModeFBPtr drmModeGetFB(int fd, uint32_t bufferId);
208 * Creates a new framebuffer with an buffer object as its scanout buffer.
210 extern int drmModeAddFB(int fd, uint32_t width, uint32_t height, uint8_t depth,
211 uint8_t bpp, uint32_t pitch, drmBO *bo,
214 * Destroies the given framebuffer.
216 extern int drmModeRmFB(int fd, uint32_t bufferId);
219 * Changes the scanout buffer to the given buffer object.
221 extern int drmModeFlipFrameBuffer(int fd, uint32_t bufferId, drmBO *bo);
228 * Retrive information about the ctrt crtcId
230 extern drmModeCrtcPtr drmModeGetCrtc(int fd, uint32_t crtcId);
233 * Set the mode on a crtc crtcId with the given mode modeId.
235 extern int drmModeSetCrtc(int fd, uint32_t crtcId, uint32_t bufferId,
236 uint32_t x, uint32_t y, uint32_t modeId,
237 uint32_t *outputs, int count);
240 * Gets the gamma from a crtc
242 extern drmModeGammaTriplePtr drmModeGetCrtcGamma(int fd, uint32_t crtcId,
246 * Sets the gamma on a crtc
248 extern int drmModeSetCrtcGamma(int fd, uint32_t crtcId,
249 drmModeGammaTriplePtr ptr, int count);
254 * Output manipulation
258 * Retrive information about the output outputId.
260 extern drmModeOutputPtr drmModeGetOutput(int fd,
264 * Adds a new mode from the given mode info.
265 * Name must be unique.
267 extern uint32_t drmModeAddMode(int fd, struct drm_mode_modeinfo *modeInfo);
270 * Removes a mode created with AddMode, must be unused.
272 extern int drmModeRmMode(int fd, uint32_t modeId);
275 * Attaches the given mode to an output.
277 extern int drmModeAttachMode(int fd, uint32_t outputId, uint32_t modeId);
280 * Detaches a mode from the output
281 * must be unused, by the given mode.
283 extern int drmModeDetachMode(int fd, uint32_t outputId, uint32_t modeId);