drm_mode.h revision 22944501 
1/*
2 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
3 * Copyright (c) 2007 Jakob Bornecrantz <wallbraker@gmail.com>
4 * Copyright (c) 2008 Red Hat Inc.
5 * Copyright (c) 2007-2008 Tungsten Graphics, Inc., Cedar Park, TX., USA
6 * Copyright (c) 2007-2008 Intel Corporation
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
24 * IN THE SOFTWARE.
25 */
26
27#ifndef _DRM_MODE_H
28#define _DRM_MODE_H
29
30#define DRM_DISPLAY_INFO_LEN	32
31#define DRM_CONNECTOR_NAME_LEN	32
32#define DRM_DISPLAY_MODE_LEN	32
33#define DRM_PROP_NAME_LEN	32
34
35#define DRM_MODE_TYPE_BUILTIN	(1<<0)
36#define DRM_MODE_TYPE_CLOCK_C	((1<<1) | DRM_MODE_TYPE_BUILTIN)
37#define DRM_MODE_TYPE_CRTC_C	((1<<2) | DRM_MODE_TYPE_BUILTIN)
38#define DRM_MODE_TYPE_PREFERRED	(1<<3)
39#define DRM_MODE_TYPE_DEFAULT	(1<<4)
40#define DRM_MODE_TYPE_USERDEF	(1<<5)
41#define DRM_MODE_TYPE_DRIVER	(1<<6)
42
43/* Video mode flags */
44/* bit compatible with the xorg definitions. */
45#define DRM_MODE_FLAG_PHSYNC	(1<<0)
46#define DRM_MODE_FLAG_NHSYNC	(1<<1)
47#define DRM_MODE_FLAG_PVSYNC	(1<<2)
48#define DRM_MODE_FLAG_NVSYNC	(1<<3)
49#define DRM_MODE_FLAG_INTERLACE	(1<<4)
50#define DRM_MODE_FLAG_DBLSCAN	(1<<5)
51#define DRM_MODE_FLAG_CSYNC	(1<<6)
52#define DRM_MODE_FLAG_PCSYNC	(1<<7)
53#define DRM_MODE_FLAG_NCSYNC	(1<<8)
54#define DRM_MODE_FLAG_HSKEW	(1<<9) /* hskew provided */
55#define DRM_MODE_FLAG_BCAST	(1<<10)
56#define DRM_MODE_FLAG_PIXMUX	(1<<11)
57#define DRM_MODE_FLAG_DBLCLK	(1<<12)
58#define DRM_MODE_FLAG_CLKDIV2	(1<<13)
59
60/* DPMS flags */
61/* bit compatible with the xorg definitions. */
62#define DRM_MODE_DPMS_ON	0
63#define DRM_MODE_DPMS_STANDBY	1
64#define DRM_MODE_DPMS_SUSPEND	2
65#define DRM_MODE_DPMS_OFF	3
66
67/* Scaling mode options */
68#define DRM_MODE_SCALE_NONE		0 /* Unmodified timing (display or
69					     software can still scale) */
70#define DRM_MODE_SCALE_FULLSCREEN	1 /* Full screen, ignore aspect */
71#define DRM_MODE_SCALE_CENTER		2 /* Centered, no scaling */
72#define DRM_MODE_SCALE_ASPECT		3 /* Full screen, preserve aspect */
73
74/* Dithering mode options */
75#define DRM_MODE_DITHERING_OFF	0
76#define DRM_MODE_DITHERING_ON	1
77
78struct drm_mode_modeinfo {
79	__u32 clock;
80	__u16 hdisplay, hsync_start, hsync_end, htotal, hskew;
81	__u16 vdisplay, vsync_start, vsync_end, vtotal, vscan;
82
83	__u32 vrefresh; /* vertical refresh * 1000 */
84
85	__u32 flags;
86	__u32 type;
87	char name[DRM_DISPLAY_MODE_LEN];
88};
89
90struct drm_mode_card_res {
91	__u64 fb_id_ptr;
92	__u64 crtc_id_ptr;
93	__u64 connector_id_ptr;
94	__u64 encoder_id_ptr;
95	__u32 count_fbs;
96	__u32 count_crtcs;
97	__u32 count_connectors;
98	__u32 count_encoders;
99	__u32 min_width, max_width;
100	__u32 min_height, max_height;
101};
102
103struct drm_mode_crtc {
104	__u64 set_connectors_ptr;
105	__u32 count_connectors;
106
107	__u32 crtc_id; /**< Id */
108	__u32 fb_id; /**< Id of framebuffer */
109
110	__u32 x, y; /**< Position on the frameuffer */
111
112	__u32 gamma_size;
113	__u32 mode_valid;
114	struct drm_mode_modeinfo mode;
115};
116
117#define DRM_MODE_ENCODER_NONE	0
118#define DRM_MODE_ENCODER_DAC	1
119#define DRM_MODE_ENCODER_TMDS	2
120#define DRM_MODE_ENCODER_LVDS	3
121#define DRM_MODE_ENCODER_TVDAC	4
122
123struct drm_mode_get_encoder {
124	__u32 encoder_id;
125	__u32 encoder_type;
126
127	__u32 crtc_id; /**< Id of crtc */
128
129	__u32 possible_crtcs;
130	__u32 possible_clones;
131};
132
133/* This is for connectors with multiple signal types. */
134/* Try to match DRM_MODE_CONNECTOR_X as closely as possible. */
135#define DRM_MODE_SUBCONNECTOR_Automatic	0
136#define DRM_MODE_SUBCONNECTOR_Unknown	0
137#define DRM_MODE_SUBCONNECTOR_DVID	3
138#define DRM_MODE_SUBCONNECTOR_DVIA	4
139#define DRM_MODE_SUBCONNECTOR_Composite	5
140#define DRM_MODE_SUBCONNECTOR_SVIDEO	6
141#define DRM_MODE_SUBCONNECTOR_Component	8
142#define DRM_MODE_SUBCONNECTOR_SCART	9
143
144#define DRM_MODE_CONNECTOR_Unknown	0
145#define DRM_MODE_CONNECTOR_VGA		1
146#define DRM_MODE_CONNECTOR_DVII		2
147#define DRM_MODE_CONNECTOR_DVID		3
148#define DRM_MODE_CONNECTOR_DVIA		4
149#define DRM_MODE_CONNECTOR_Composite	5
150#define DRM_MODE_CONNECTOR_SVIDEO	6
151#define DRM_MODE_CONNECTOR_LVDS		7
152#define DRM_MODE_CONNECTOR_Component	8
153#define DRM_MODE_CONNECTOR_9PinDIN	9
154#define DRM_MODE_CONNECTOR_DisplayPort	10
155#define DRM_MODE_CONNECTOR_HDMIA	11
156#define DRM_MODE_CONNECTOR_HDMIB	12
157#define DRM_MODE_CONNECTOR_TV		13
158
159struct drm_mode_get_connector {
160
161	__u64 encoders_ptr;
162	__u64 modes_ptr;
163	__u64 props_ptr;
164	__u64 prop_values_ptr;
165
166	__u32 count_modes;
167	__u32 count_props;
168	__u32 count_encoders;
169
170	__u32 encoder_id; /**< Current Encoder */
171	__u32 connector_id; /**< Id */
172	__u32 connector_type;
173	__u32 connector_type_id;
174
175	__u32 connection;
176	__u32 mm_width, mm_height; /**< HxW in millimeters */
177	__u32 subpixel;
178};
179
180#define DRM_MODE_PROP_PENDING	(1<<0)
181#define DRM_MODE_PROP_RANGE	(1<<1)
182#define DRM_MODE_PROP_IMMUTABLE	(1<<2)
183#define DRM_MODE_PROP_ENUM	(1<<3) /* enumerated type with text strings */
184#define DRM_MODE_PROP_BLOB	(1<<4)
185
186struct drm_mode_property_enum {
187	__u64 value;
188	char name[DRM_PROP_NAME_LEN];
189};
190
191struct drm_mode_get_property {
192	__u64 values_ptr; /* values and blob lengths */
193	__u64 enum_blob_ptr; /* enum and blob id ptrs */
194
195	__u32 prop_id;
196	__u32 flags;
197	char name[DRM_PROP_NAME_LEN];
198
199	__u32 count_values;
200	__u32 count_enum_blobs;
201};
202
203struct drm_mode_connector_set_property {
204	__u64 value;
205	__u32 prop_id;
206	__u32 connector_id;
207};
208
209struct drm_mode_get_blob {
210	__u32 blob_id;
211	__u32 length;
212	__u64 data;
213};
214
215struct drm_mode_fb_cmd {
216	__u32 fb_id;
217	__u32 width, height;
218	__u32 pitch;
219	__u32 bpp;
220	__u32 depth;
221	/* driver specific handle */
222	__u32 handle;
223};
224
225#define DRM_MODE_FB_DIRTY_ANNOTATE_COPY 0x01
226#define DRM_MODE_FB_DIRTY_ANNOTATE_FILL 0x02
227#define DRM_MODE_FB_DIRTY_FLAGS         0x03
228
229/*
230 * Mark a region of a framebuffer as dirty.
231 *
232 * Some hardware does not automatically update display contents
233 * as a hardware or software draw to a framebuffer. This ioctl
234 * allows userspace to tell the kernel and the hardware what
235 * regions of the framebuffer have changed.
236 *
237 * The kernel or hardware is free to update more then just the
238 * region specified by the clip rects. The kernel or hardware
239 * may also delay and/or coalesce several calls to dirty into a
240 * single update.
241 *
242 * Userspace may annotate the updates, the annotates are a
243 * promise made by the caller that the change is either a copy
244 * of pixels or a fill of a single color in the region specified.
245 *
246 * If the DRM_MODE_FB_DIRTY_ANNOTATE_COPY flag is given then
247 * the number of updated regions are half of num_clips given,
248 * where the clip rects are paired in src and dst. The width and
249 * height of each one of the pairs must match.
250 *
251 * If the DRM_MODE_FB_DIRTY_ANNOTATE_FILL flag is given the caller
252 * promises that the region specified of the clip rects is filled
253 * completely with a single color as given in the color argument.
254 */
255
256struct drm_mode_fb_dirty_cmd {
257	__u32 fb_id;
258	__u32 flags;
259	__u32 color;
260	__u32 num_clips;
261	__u64 clips_ptr;
262};
263
264struct drm_mode_mode_cmd {
265	__u32 connector_id;
266	struct drm_mode_modeinfo mode;
267};
268
269#define DRM_MODE_CURSOR_BO	(1<<0)
270#define DRM_MODE_CURSOR_MOVE	(1<<1)
271
272/*
273 * depending on the value in flags diffrent members are used.
274 *
275 * CURSOR_BO uses
276 *    crtc
277 *    width
278 *    height
279 *    handle - if 0 turns the cursor of
280 *
281 * CURSOR_MOVE uses
282 *    crtc
283 *    x
284 *    y
285 */
286struct drm_mode_cursor {
287	__u32 flags;
288	__u32 crtc_id;
289	__s32 x;
290	__s32 y;
291	__u32 width;
292	__u32 height;
293	/* driver specific handle */
294	__u32 handle;
295};
296
297struct drm_mode_crtc_lut {
298	__u32 crtc_id;
299	__u32 gamma_size;
300
301	/* pointers to arrays */
302	__u64 red;
303	__u64 green;
304	__u64 blue;
305};
306
307#define DRM_MODE_PAGE_FLIP_EVENT 0x01
308#define DRM_MODE_PAGE_FLIP_FLAGS DRM_MODE_PAGE_FLIP_EVENT
309
310struct drm_mode_crtc_page_flip {
311	uint32_t crtc_id;
312	uint32_t fb_id;
313	uint32_t flags;
314	uint32_t reserved;
315	uint64_t user_data;
316};
317
318#endif
319