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 {
65 uint32_t frameBufferId;
74 struct drm_mode_modeinfo *modes;
76 } drmModeRes, *drmModeResPtr;
78 typedef struct _drmModeFrameBuffer {
85 } drmModeFrameBuffer, *drmModeFrameBufferPtr;
87 typedef struct _drmModeCrtc {
89 unsigned int bufferId; /**< Buffer currently connected to */
91 uint32_t x, y; /**< Position on the frameuffer */
92 uint32_t width, height;
93 uint32_t mode; /**< Current mode used */
96 uint32_t outputs; /**< Outputs that are connected */
99 uint32_t possibles; /**< Outputs that can be connected */
101 int gamma_size; /**< Number of gamma stops */
103 } drmModeCrtc, *drmModeCrtcPtr;
106 DRM_MODE_CONNECTED = 1,
107 DRM_MODE_DISCONNECTED = 2,
108 DRM_MODE_UNKNOWNCONNECTION = 3
112 DRM_MODE_SUBPIXEL_UNKNOWN = 1,
113 DRM_MODE_SUBPIXEL_HORIZONTAL_RGB = 2,
114 DRM_MODE_SUBPIXEL_HORIZONTAL_BGR = 3,
115 DRM_MODE_SUBPIXEL_VERTICAL_RGB = 4,
116 DRM_MODE_SUBPIXEL_VERTICAL_BGR = 5,
117 DRM_MODE_SUBPIXEL_NONE = 6
120 typedef struct _drmModeOutput {
122 unsigned int crtc; /**< Crtc currently connected to */
123 unsigned char name[DRM_OUTPUT_NAME_LEN];
124 drmModeConnection connection;
125 uint32_t mmWidth, mmHeight; /**< HxW in millimeters */
126 drmModeSubPixel subpixel;
129 uint32_t crtcs; /**< Possible crtc to connect to */
132 uint32_t clones; /**< Mask of clones */
135 uint32_t *modes; /**< List of modes ids */
137 } drmModeOutput, *drmModeOutputPtr;
140 * RRSetScreenConfig o
143 * RRGetScreenSizeRange - see frameBuffer info
145 * RRGetScreenResources
149 * RRListOutputProperties *
150 * RRQueryOutputProperty *
151 * RRConfigureOutputProperty *
152 * RRChangeOutputProperty *
153 * RRDeleteOutputProperty *
154 * RRGetOutputProperty *
164 * RRGetCrtcGammaSize - see crtc info
168 * drmModeGetResources
171 * drmModeGetFrameBufferInfo
172 * drmModeSetFrameBufferSize
175 * drmModeSetCrtcConfig
176 * drmModeGetCrtcGamma
177 * drmModeSetCrtcGamma
179 * drmModeGetOutputInfo
183 * drmModeAddOutputMode
184 * drmModeDeleteOutputMode
187 extern void drmModeFreeModeInfo( struct drm_mode_modeinfo *ptr );
188 extern void drmModeFreeResources( drmModeResPtr ptr );
189 extern void drmModeFreeFrameBuffer( drmModeFrameBufferPtr ptr );
190 extern void drmModeFreeCrtc( drmModeCrtcPtr ptr );
191 extern void drmModeFreeOutput( drmModeOutputPtr ptr );
194 * Retrives all of the resources associated with a card.
196 extern drmModeResPtr drmModeGetResources(int fd);
199 * Forces a probe of the give output outputId, on 0 all will be probed.
201 extern int drmModeForceProbe(int fd, uint32_t outputId);
205 * FrameBuffer manipulation.
209 * Retrive information about framebuffer bufferId
211 extern drmModeFrameBufferPtr drmModeGetFramebuffer(int fd,
215 * Creates a new framebuffer with an buffer object as its scanout buffer.
217 extern int drmModeAddFB(int fd, uint32_t width, uint32_t height,
218 uint8_t bpp, uint32_t pitch, drmBO *bo, uint32_t *buf_id);
220 * Destroies the given framebuffer.
222 extern int drmModeRmFB(int fd, uint32_t bufferId);
225 * Changes the scanout buffer to the given buffer object.
227 extern int drmModeFlipFrameBuffer(int fd, uint32_t bufferId, drmBO *bo);
234 * Retrive information about the ctrt crtcId
236 extern drmModeCrtcPtr drmModeGetCrtc(int fd, uint32_t crtcId);
239 * Set the mode on a crtc crtcId with the given mode modeId.
241 extern int drmModeSetCrtc(int fd, uint32_t crtcId, uint32_t bufferId,
242 uint32_t x, uint32_t y, uint32_t modeId,
243 uint32_t *outputs, int count);
246 * Gets the gamma from a crtc
248 extern drmModeGammaTriplePtr drmModeGetCrtcGamma(int fd, uint32_t crtcId,
252 * Sets the gamma on a crtc
254 extern int drmModeSetCrtcGamma(int fd, uint32_t crtcId,
255 drmModeGammaTriplePtr ptr, int count);
260 * Output manipulation
264 * Retrive information about the output outputId.
266 extern drmModeOutputPtr drmModeGetOutput(int fd,
270 * Creates a new mode from the given mode info.
271 * Name must be unique.
273 extern uint32_t drmModeNewMode(int fd, struct drm_mode_modeinfo *modeInfo);
276 * Destroys a mode created with CreateMode, must be unused.
278 extern int drmModeDesMode(int fd, uint32_t modeId);
281 * Adds the given mode to an output.
283 extern int drmModeAddMode(int fd, uint32_t outputId, uint32_t modeId);
286 * Deletes a mode Added with AddOutputMode from the output,
287 * must be unused, by the given mode.
289 extern int drmModeDelMode(int fd, uint32_t outputId, uint32_t modeId);