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 {
69 uint32_t min_width, max_width;
70 uint32_t min_height, max_height;
71 } drmModeRes, *drmModeResPtr;
73 typedef struct drm_mode_fb_cmd drmModeFB, *drmModeFBPtr;
75 typedef struct _drmModePropertyBlob {
79 } drmModePropertyBlobRes, *drmModePropertyBlobPtr;
81 typedef struct _drmModeProperty {
84 char name[DRM_PROP_NAME_LEN];
86 uint64_t *values; // store the blob lengths
88 struct drm_mode_property_enum *enums;
90 uint32_t *blob_ids; // store the blob IDs
91 } drmModePropertyRes, *drmModePropertyPtr;
93 typedef struct _drmModeCrtc {
95 unsigned int buffer_id; /**< FB id to connect to 0 = disconnect*/
97 uint32_t x, y; /**< Position on the frameuffer */
98 uint32_t width, height;
100 struct drm_mode_modeinfo mode;
103 uint32_t outputs; /**< Outputs that are connected */
106 uint32_t possibles; /**< Outputs that can be connected */
108 int gamma_size; /**< Number of gamma stops */
110 } drmModeCrtc, *drmModeCrtcPtr;
112 typedef struct _drmModeEncoder {
113 unsigned int encoder_id;
114 unsigned int encoder_type;
117 } drmModeEncoder, *drmModeEncoderPtr;
120 DRM_MODE_CONNECTED = 1,
121 DRM_MODE_DISCONNECTED = 2,
122 DRM_MODE_UNKNOWNCONNECTION = 3
126 DRM_MODE_SUBPIXEL_UNKNOWN = 1,
127 DRM_MODE_SUBPIXEL_HORIZONTAL_RGB = 2,
128 DRM_MODE_SUBPIXEL_HORIZONTAL_BGR = 3,
129 DRM_MODE_SUBPIXEL_VERTICAL_RGB = 4,
130 DRM_MODE_SUBPIXEL_VERTICAL_BGR = 5,
131 DRM_MODE_SUBPIXEL_NONE = 6
134 typedef struct _drmModeOutput {
135 unsigned int output_id;
137 unsigned int crtc; /**< Crtc currently connected to */
138 unsigned int output_type;
139 unsigned int output_type_id;
140 drmModeConnection connection;
141 uint32_t mmWidth, mmHeight; /**< HxW in millimeters */
142 drmModeSubPixel subpixel;
145 uint32_t crtcs; /**< Possible crtc to connect to */
148 uint32_t clones; /**< Mask of clones */
151 struct drm_mode_modeinfo *modes;
154 uint32_t *props; /**< List of property ids */
155 uint64_t *prop_values; /**< List of property values */
157 } drmModeOutput, *drmModeOutputPtr;
161 extern void drmModeFreeModeInfo( struct drm_mode_modeinfo *ptr );
162 extern void drmModeFreeResources( drmModeResPtr ptr );
163 extern void drmModeFreeFB( drmModeFBPtr ptr );
164 extern void drmModeFreeCrtc( drmModeCrtcPtr ptr );
165 extern void drmModeFreeOutput( drmModeOutputPtr ptr );
168 * Retrives all of the resources associated with a card.
170 extern drmModeResPtr drmModeGetResources(int fd);
173 * Retrives the hotplug counter
175 extern uint32_t drmModeGetHotplug(int fd);
178 * FrameBuffer manipulation.
182 * Retrive information about framebuffer bufferId
184 extern drmModeFBPtr drmModeGetFB(int fd, uint32_t bufferId);
187 * Creates a new framebuffer with an buffer object as its scanout buffer.
189 extern int drmModeAddFB(int fd, uint32_t width, uint32_t height, uint8_t depth,
190 uint8_t bpp, uint32_t pitch, uint32_t bo_handle,
193 * Destroies the given framebuffer.
195 extern int drmModeRmFB(int fd, uint32_t bufferId);
198 * Replace a framebuffer object with a new one - for resizing the screen.
200 extern int drmModeReplaceFB(int fd, uint32_t buffer_id,
201 uint32_t width, uint32_t height, uint8_t depth,
202 uint8_t bpp, uint32_t pitch, uint32_t bo_handle);
209 * Retrive information about the ctrt crtcId
211 extern drmModeCrtcPtr drmModeGetCrtc(int fd, uint32_t crtcId);
214 * Set the mode on a crtc crtcId with the given mode modeId.
216 int drmModeSetCrtc(int fd, uint32_t crtcId, uint32_t bufferId,
217 uint32_t x, uint32_t y, uint32_t *outputs, int count,
218 struct drm_mode_modeinfo *mode);
225 * Set the cursor on crtc
227 int drmModeSetCursor(int fd, uint32_t crtcId, uint32_t bo_handle, uint32_t width, uint32_t height);
230 * Move the cursor on crtc
232 int drmModeMoveCursor(int fd, uint32_t crtcId, int x, int y);
237 drmModeEncoderPtr drmModeGetEncoder(int fd, uint32_t encoder_id);
240 * Output manipulation
244 * Retrive information about the output outputId.
246 extern drmModeOutputPtr drmModeGetOutput(int fd,
250 * Attaches the given mode to an output.
252 extern int drmModeAttachMode(int fd, uint32_t outputId, struct drm_mode_modeinfo *mode_info);
255 * Detaches a mode from the output
256 * must be unused, by the given mode.
258 extern int drmModeDetachMode(int fd, uint32_t outputId, struct drm_mode_modeinfo *mode_info);
260 extern drmModePropertyPtr drmModeGetProperty(int fd, uint32_t propertyId);
261 extern void drmModeFreeProperty(drmModePropertyPtr ptr);
263 extern drmModePropertyBlobPtr drmModeGetPropertyBlob(int fd, uint32_t blob_id);
264 extern void drmModeFreePropertyBlob(drmModePropertyBlobPtr ptr);
265 extern int drmModeOutputSetProperty(int fd, uint32_t output_id, uint32_t property_id,
267 extern int drmCheckModesettingSupported(const char *busid);