?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
WIP FPC-III support
[linux/fpc-iii.git] / include / uapi / drm / drm_mode.h
blobb49fbf2bdc408d914b4839d0e3e5f7fadc776c8d
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 #include "drm.h"
31
32 #if defined(__cplusplus)
33 extern "C" {
34 #endif
35
36 /**
37 * DOC: overview
38 *
39 * DRM exposes many UAPI and structure definition to have a consistent
40 * and standardized interface with user.
41 * Userspace can refer to these structure definitions and UAPI formats
42 * to communicate to driver
43 */
44
45 #define DRM_CONNECTOR_NAME_LEN 32
46 #define DRM_DISPLAY_MODE_LEN 32
47 #define DRM_PROP_NAME_LEN 32
48
49 #define DRM_MODE_TYPE_BUILTIN (1<<0) /* deprecated */
50 #define DRM_MODE_TYPE_CLOCK_C ((1<<1) | DRM_MODE_TYPE_BUILTIN) /* deprecated */
51 #define DRM_MODE_TYPE_CRTC_C ((1<<2) | DRM_MODE_TYPE_BUILTIN) /* deprecated */
52 #define DRM_MODE_TYPE_PREFERRED (1<<3)
53 #define DRM_MODE_TYPE_DEFAULT (1<<4) /* deprecated */
54 #define DRM_MODE_TYPE_USERDEF (1<<5)
55 #define DRM_MODE_TYPE_DRIVER (1<<6)
56
57 #define DRM_MODE_TYPE_ALL (DRM_MODE_TYPE_PREFERRED | \
58 DRM_MODE_TYPE_USERDEF | \
59 DRM_MODE_TYPE_DRIVER)
60
61 /* Video mode flags */
62 /* bit compatible with the xrandr RR_ definitions (bits 0-13)
63 *
64 * ABI warning: Existing userspace really expects
65 * the mode flags to match the xrandr definitions. Any
66 * changes that don't match the xrandr definitions will
67 * likely need a new client cap or some other mechanism
68 * to avoid breaking existing userspace. This includes
69 * allocating new flags in the previously unused bits!
70 */
71 #define DRM_MODE_FLAG_PHSYNC (1<<0)
72 #define DRM_MODE_FLAG_NHSYNC (1<<1)
73 #define DRM_MODE_FLAG_PVSYNC (1<<2)
74 #define DRM_MODE_FLAG_NVSYNC (1<<3)
75 #define DRM_MODE_FLAG_INTERLACE (1<<4)
76 #define DRM_MODE_FLAG_DBLSCAN (1<<5)
77 #define DRM_MODE_FLAG_CSYNC (1<<6)
78 #define DRM_MODE_FLAG_PCSYNC (1<<7)
79 #define DRM_MODE_FLAG_NCSYNC (1<<8)
80 #define DRM_MODE_FLAG_HSKEW (1<<9) /* hskew provided */
81 #define DRM_MODE_FLAG_BCAST (1<<10) /* deprecated */
82 #define DRM_MODE_FLAG_PIXMUX (1<<11) /* deprecated */
83 #define DRM_MODE_FLAG_DBLCLK (1<<12)
84 #define DRM_MODE_FLAG_CLKDIV2 (1<<13)
85 /*
86 * When adding a new stereo mode don't forget to adjust DRM_MODE_FLAGS_3D_MAX
87 * (define not exposed to user space).
88 */
89 #define DRM_MODE_FLAG_3D_MASK (0x1f<<14)
90 #define DRM_MODE_FLAG_3D_NONE (0<<14)
91 #define DRM_MODE_FLAG_3D_FRAME_PACKING (1<<14)
92 #define DRM_MODE_FLAG_3D_FIELD_ALTERNATIVE (2<<14)
93 #define DRM_MODE_FLAG_3D_LINE_ALTERNATIVE (3<<14)
94 #define DRM_MODE_FLAG_3D_SIDE_BY_SIDE_FULL (4<<14)
95 #define DRM_MODE_FLAG_3D_L_DEPTH (5<<14)
96 #define DRM_MODE_FLAG_3D_L_DEPTH_GFX_GFX_DEPTH (6<<14)
97 #define DRM_MODE_FLAG_3D_TOP_AND_BOTTOM (7<<14)
98 #define DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF (8<<14)
99
100 /* Picture aspect ratio options */
101 #define DRM_MODE_PICTURE_ASPECT_NONE 0
102 #define DRM_MODE_PICTURE_ASPECT_4_3 1
103 #define DRM_MODE_PICTURE_ASPECT_16_9 2
104 #define DRM_MODE_PICTURE_ASPECT_64_27 3
105 #define DRM_MODE_PICTURE_ASPECT_256_135 4
106
107 /* Content type options */
108 #define DRM_MODE_CONTENT_TYPE_NO_DATA 0
109 #define DRM_MODE_CONTENT_TYPE_GRAPHICS 1
110 #define DRM_MODE_CONTENT_TYPE_PHOTO 2
111 #define DRM_MODE_CONTENT_TYPE_CINEMA 3
112 #define DRM_MODE_CONTENT_TYPE_GAME 4
113
114 /* Aspect ratio flag bitmask (4 bits 22:19) */
115 #define DRM_MODE_FLAG_PIC_AR_MASK (0x0F<<19)
116 #define DRM_MODE_FLAG_PIC_AR_NONE \
117 (DRM_MODE_PICTURE_ASPECT_NONE<<19)
118 #define DRM_MODE_FLAG_PIC_AR_4_3 \
119 (DRM_MODE_PICTURE_ASPECT_4_3<<19)
120 #define DRM_MODE_FLAG_PIC_AR_16_9 \
121 (DRM_MODE_PICTURE_ASPECT_16_9<<19)
122 #define DRM_MODE_FLAG_PIC_AR_64_27 \
123 (DRM_MODE_PICTURE_ASPECT_64_27<<19)
124 #define DRM_MODE_FLAG_PIC_AR_256_135 \
125 (DRM_MODE_PICTURE_ASPECT_256_135<<19)
126
127 #define DRM_MODE_FLAG_ALL (DRM_MODE_FLAG_PHSYNC | \
128 DRM_MODE_FLAG_NHSYNC | \
129 DRM_MODE_FLAG_PVSYNC | \
130 DRM_MODE_FLAG_NVSYNC | \
131 DRM_MODE_FLAG_INTERLACE | \
132 DRM_MODE_FLAG_DBLSCAN | \
133 DRM_MODE_FLAG_CSYNC | \
134 DRM_MODE_FLAG_PCSYNC | \
135 DRM_MODE_FLAG_NCSYNC | \
136 DRM_MODE_FLAG_HSKEW | \
137 DRM_MODE_FLAG_DBLCLK | \
138 DRM_MODE_FLAG_CLKDIV2 | \
139 DRM_MODE_FLAG_3D_MASK)
140
141 /* DPMS flags */
142 /* bit compatible with the xorg definitions. */
143 #define DRM_MODE_DPMS_ON 0
144 #define DRM_MODE_DPMS_STANDBY 1
145 #define DRM_MODE_DPMS_SUSPEND 2
146 #define DRM_MODE_DPMS_OFF 3
147
148 /* Scaling mode options */
149 #define DRM_MODE_SCALE_NONE 0 /* Unmodified timing (display or
150 software can still scale) */
151 #define DRM_MODE_SCALE_FULLSCREEN 1 /* Full screen, ignore aspect */
152 #define DRM_MODE_SCALE_CENTER 2 /* Centered, no scaling */
153 #define DRM_MODE_SCALE_ASPECT 3 /* Full screen, preserve aspect */
154
155 /* Dithering mode options */
156 #define DRM_MODE_DITHERING_OFF 0
157 #define DRM_MODE_DITHERING_ON 1
158 #define DRM_MODE_DITHERING_AUTO 2
159
160 /* Dirty info options */
161 #define DRM_MODE_DIRTY_OFF 0
162 #define DRM_MODE_DIRTY_ON 1
163 #define DRM_MODE_DIRTY_ANNOTATE 2
164
165 /* Link Status options */
166 #define DRM_MODE_LINK_STATUS_GOOD 0
167 #define DRM_MODE_LINK_STATUS_BAD 1
168
169 /*
170 * DRM_MODE_ROTATE_<degrees>
171 *
172 * Signals that a drm plane is been rotated <degrees> degrees in counter
173 * clockwise direction.
174 *
175 * This define is provided as a convenience, looking up the property id
176 * using the name->prop id lookup is the preferred method.
177 */
178 #define DRM_MODE_ROTATE_0 (1<<0)
179 #define DRM_MODE_ROTATE_90 (1<<1)
180 #define DRM_MODE_ROTATE_180 (1<<2)
181 #define DRM_MODE_ROTATE_270 (1<<3)
182
183 /*
184 * DRM_MODE_ROTATE_MASK
185 *
186 * Bitmask used to look for drm plane rotations.
187 */
188 #define DRM_MODE_ROTATE_MASK (\
189 DRM_MODE_ROTATE_0 | \
190 DRM_MODE_ROTATE_90 | \
191 DRM_MODE_ROTATE_180 | \
192 DRM_MODE_ROTATE_270)
193
194 /*
195 * DRM_MODE_REFLECT_<axis>
196 *
197 * Signals that the contents of a drm plane is reflected along the <axis> axis,
198 * in the same way as mirroring.
199 * See kerneldoc chapter "Plane Composition Properties" for more details.
200 *
201 * This define is provided as a convenience, looking up the property id
202 * using the name->prop id lookup is the preferred method.
203 */
204 #define DRM_MODE_REFLECT_X (1<<4)
205 #define DRM_MODE_REFLECT_Y (1<<5)
206
207 /*
208 * DRM_MODE_REFLECT_MASK
209 *
210 * Bitmask used to look for drm plane reflections.
211 */
212 #define DRM_MODE_REFLECT_MASK (\
213 DRM_MODE_REFLECT_X | \
214 DRM_MODE_REFLECT_Y)
215
216 /* Content Protection Flags */
217 #define DRM_MODE_CONTENT_PROTECTION_UNDESIRED 0
218 #define DRM_MODE_CONTENT_PROTECTION_DESIRED 1
219 #define DRM_MODE_CONTENT_PROTECTION_ENABLED 2
220
221 /**
222 * struct drm_mode_modeinfo - Display mode information.
223 * @clock: pixel clock in kHz
224 * @hdisplay: horizontal display size
225 * @hsync_start: horizontal sync start
226 * @hsync_end: horizontal sync end
227 * @htotal: horizontal total size
228 * @hskew: horizontal skew
229 * @vdisplay: vertical display size
230 * @vsync_start: vertical sync start
231 * @vsync_end: vertical sync end
232 * @vtotal: vertical total size
233 * @vscan: vertical scan
234 * @vrefresh: approximate vertical refresh rate in Hz
235 * @flags: bitmask of misc. flags, see DRM_MODE_FLAG_* defines
236 * @type: bitmask of type flags, see DRM_MODE_TYPE_* defines
237 * @name: string describing the mode resolution
238 *
239 * This is the user-space API display mode information structure. For the
240 * kernel version see struct drm_display_mode.
241 */
242 struct drm_mode_modeinfo {
243 __u32 clock;
244 __u16 hdisplay;
245 __u16 hsync_start;
246 __u16 hsync_end;
247 __u16 htotal;
248 __u16 hskew;
249 __u16 vdisplay;
250 __u16 vsync_start;
251 __u16 vsync_end;
252 __u16 vtotal;
253 __u16 vscan;
254
255 __u32 vrefresh;
256
257 __u32 flags;
258 __u32 type;
259 char name[DRM_DISPLAY_MODE_LEN];
260 };
261
262 struct drm_mode_card_res {
263 __u64 fb_id_ptr;
264 __u64 crtc_id_ptr;
265 __u64 connector_id_ptr;
266 __u64 encoder_id_ptr;
267 __u32 count_fbs;
268 __u32 count_crtcs;
269 __u32 count_connectors;
270 __u32 count_encoders;
271 __u32 min_width;
272 __u32 max_width;
273 __u32 min_height;
274 __u32 max_height;
275 };
276
277 struct drm_mode_crtc {
278 __u64 set_connectors_ptr;
279 __u32 count_connectors;
280
281 __u32 crtc_id; /**< Id */
282 __u32 fb_id; /**< Id of framebuffer */
283
284 __u32 x; /**< x Position on the framebuffer */
285 __u32 y; /**< y Position on the framebuffer */
286
287 __u32 gamma_size;
288 __u32 mode_valid;
289 struct drm_mode_modeinfo mode;
290 };
291
292 #define DRM_MODE_PRESENT_TOP_FIELD (1<<0)
293 #define DRM_MODE_PRESENT_BOTTOM_FIELD (1<<1)
294
295 /* Planes blend with or override other bits on the CRTC */
296 struct drm_mode_set_plane {
297 __u32 plane_id;
298 __u32 crtc_id;
299 __u32 fb_id; /* fb object contains surface format type */
300 __u32 flags; /* see above flags */
301
302 /* Signed dest location allows it to be partially off screen */
303 __s32 crtc_x;
304 __s32 crtc_y;
305 __u32 crtc_w;
306 __u32 crtc_h;
307
308 /* Source values are 16.16 fixed point */
309 __u32 src_x;
310 __u32 src_y;
311 __u32 src_h;
312 __u32 src_w;
313 };
314
315 struct drm_mode_get_plane {
316 __u32 plane_id;
317
318 __u32 crtc_id;
319 __u32 fb_id;
320
321 __u32 possible_crtcs;
322 __u32 gamma_size;
323
324 __u32 count_format_types;
325 __u64 format_type_ptr;
326 };
327
328 struct drm_mode_get_plane_res {
329 __u64 plane_id_ptr;
330 __u32 count_planes;
331 };
332
333 #define DRM_MODE_ENCODER_NONE 0
334 #define DRM_MODE_ENCODER_DAC 1
335 #define DRM_MODE_ENCODER_TMDS 2
336 #define DRM_MODE_ENCODER_LVDS 3
337 #define DRM_MODE_ENCODER_TVDAC 4
338 #define DRM_MODE_ENCODER_VIRTUAL 5
339 #define DRM_MODE_ENCODER_DSI 6
340 #define DRM_MODE_ENCODER_DPMST 7
341 #define DRM_MODE_ENCODER_DPI 8
342
343 struct drm_mode_get_encoder {
344 __u32 encoder_id;
345 __u32 encoder_type;
346
347 __u32 crtc_id; /**< Id of crtc */
348
349 __u32 possible_crtcs;
350 __u32 possible_clones;
351 };
352
353 /* This is for connectors with multiple signal types. */
354 /* Try to match DRM_MODE_CONNECTOR_X as closely as possible. */
355 enum drm_mode_subconnector {
356 DRM_MODE_SUBCONNECTOR_Automatic = 0, /* DVI-I, TV */
357 DRM_MODE_SUBCONNECTOR_Unknown = 0, /* DVI-I, TV, DP */
358 DRM_MODE_SUBCONNECTOR_VGA = 1, /* DP */
359 DRM_MODE_SUBCONNECTOR_DVID = 3, /* DVI-I DP */
360 DRM_MODE_SUBCONNECTOR_DVIA = 4, /* DVI-I */
361 DRM_MODE_SUBCONNECTOR_Composite = 5, /* TV */
362 DRM_MODE_SUBCONNECTOR_SVIDEO = 6, /* TV */
363 DRM_MODE_SUBCONNECTOR_Component = 8, /* TV */
364 DRM_MODE_SUBCONNECTOR_SCART = 9, /* TV */
365 DRM_MODE_SUBCONNECTOR_DisplayPort = 10, /* DP */
366 DRM_MODE_SUBCONNECTOR_HDMIA = 11, /* DP */
367 DRM_MODE_SUBCONNECTOR_Native = 15, /* DP */
368 DRM_MODE_SUBCONNECTOR_Wireless = 18, /* DP */
369 };
370
371 #define DRM_MODE_CONNECTOR_Unknown 0
372 #define DRM_MODE_CONNECTOR_VGA 1
373 #define DRM_MODE_CONNECTOR_DVII 2
374 #define DRM_MODE_CONNECTOR_DVID 3
375 #define DRM_MODE_CONNECTOR_DVIA 4
376 #define DRM_MODE_CONNECTOR_Composite 5
377 #define DRM_MODE_CONNECTOR_SVIDEO 6
378 #define DRM_MODE_CONNECTOR_LVDS 7
379 #define DRM_MODE_CONNECTOR_Component 8
380 #define DRM_MODE_CONNECTOR_9PinDIN 9
381 #define DRM_MODE_CONNECTOR_DisplayPort 10
382 #define DRM_MODE_CONNECTOR_HDMIA 11
383 #define DRM_MODE_CONNECTOR_HDMIB 12
384 #define DRM_MODE_CONNECTOR_TV 13
385 #define DRM_MODE_CONNECTOR_eDP 14
386 #define DRM_MODE_CONNECTOR_VIRTUAL 15
387 #define DRM_MODE_CONNECTOR_DSI 16
388 #define DRM_MODE_CONNECTOR_DPI 17
389 #define DRM_MODE_CONNECTOR_WRITEBACK 18
390 #define DRM_MODE_CONNECTOR_SPI 19
391
392 /**
393 * struct drm_mode_get_connector - Get connector metadata.
394 *
395 * User-space can perform a GETCONNECTOR ioctl to retrieve information about a
396 * connector. User-space is expected to retrieve encoders, modes and properties
397 * by performing this ioctl at least twice: the first time to retrieve the
398 * number of elements, the second time to retrieve the elements themselves.
399 *
400 * To retrieve the number of elements, set @count_props and @count_encoders to
401 * zero, set @count_modes to 1, and set @modes_ptr to a temporary struct
402 * drm_mode_modeinfo element.
403 *
404 * To retrieve the elements, allocate arrays for @encoders_ptr, @modes_ptr,
405 * @props_ptr and @prop_values_ptr, then set @count_modes, @count_props and
406 * @count_encoders to their capacity.
407 *
408 * Performing the ioctl only twice may be racy: the number of elements may have
409 * changed with a hotplug event in-between the two ioctls. User-space is
410 * expected to retry the last ioctl until the number of elements stabilizes.
411 * The kernel won't fill any array which doesn't have the expected length.
412 *
413 * **Force-probing a connector**
414 *
415 * If the @count_modes field is set to zero, the kernel will perform a forced
416 * probe on the connector to refresh the connector status, modes and EDID.
417 * A forced-probe can be slow and the ioctl will block. A force-probe can cause
418 * flickering and temporary freezes, so it should not be performed
419 * automatically.
420 *
421 * User-space shouldn't need to force-probe connectors in general: the kernel
422 * will automatically take care of probing connectors that don't support
423 * hot-plug detection when appropriate. However, user-space may force-probe
424 * connectors on user request (e.g. clicking a "Scan connectors" button, or
425 * opening a UI to manage screens).
426 */
427 struct drm_mode_get_connector {
428 /** @encoders_ptr: Pointer to ``__u32`` array of object IDs. */
429 __u64 encoders_ptr;
430 /** @modes_ptr: Pointer to struct drm_mode_modeinfo array. */
431 __u64 modes_ptr;
432 /** @props_ptr: Pointer to ``__u32`` array of property IDs. */
433 __u64 props_ptr;
434 /** @prop_values_ptr: Pointer to ``__u64`` array of property values. */
435 __u64 prop_values_ptr;
436
437 /** @count_modes: Number of modes. */
438 __u32 count_modes;
439 /** @count_props: Number of properties. */
440 __u32 count_props;
441 /** @count_encoders: Number of encoders. */
442 __u32 count_encoders;
443
444 /** @encoder_id: Object ID of the current encoder. */
445 __u32 encoder_id;
446 /** @connector_id: Object ID of the connector. */
447 __u32 connector_id;
448 /**
449 * @connector_type: Type of the connector.
450 *
451 * See DRM_MODE_CONNECTOR_* defines.
452 */
453 __u32 connector_type;
454 /**
455 * @connector_type_id: Type-specific connector number.
456 *
457 * This is not an object ID. This is a per-type connector number. Each
458 * (type, type_id) combination is unique across all connectors of a DRM
459 * device.
460 */
461 __u32 connector_type_id;
462
463 /**
464 * @connection: Status of the connector.
465 *
466 * See enum drm_connector_status.
467 */
468 __u32 connection;
469 /** @mm_width: Width of the connected sink in millimeters. */
470 __u32 mm_width;
471 /** @mm_height: Height of the connected sink in millimeters. */
472 __u32 mm_height;
473 /**
474 * @subpixel: Subpixel order of the connected sink.
475 *
476 * See enum subpixel_order.
477 */
478 __u32 subpixel;
479
480 /** @pad: Padding, must be zero. */
481 __u32 pad;
482 };
483
484 #define DRM_MODE_PROP_PENDING (1<<0) /* deprecated, do not use */
485 #define DRM_MODE_PROP_RANGE (1<<1)
486 #define DRM_MODE_PROP_IMMUTABLE (1<<2)
487 #define DRM_MODE_PROP_ENUM (1<<3) /* enumerated type with text strings */
488 #define DRM_MODE_PROP_BLOB (1<<4)
489 #define DRM_MODE_PROP_BITMASK (1<<5) /* bitmask of enumerated types */
490
491 /* non-extended types: legacy bitmask, one bit per type: */
492 #define DRM_MODE_PROP_LEGACY_TYPE ( \
493 DRM_MODE_PROP_RANGE | \
494 DRM_MODE_PROP_ENUM | \
495 DRM_MODE_PROP_BLOB | \
496 DRM_MODE_PROP_BITMASK)
497
498 /* extended-types: rather than continue to consume a bit per type,
499 * grab a chunk of the bits to use as integer type id.
500 */
501 #define DRM_MODE_PROP_EXTENDED_TYPE 0x0000ffc0
502 #define DRM_MODE_PROP_TYPE(n) ((n) << 6)
503 #define DRM_MODE_PROP_OBJECT DRM_MODE_PROP_TYPE(1)
504 #define DRM_MODE_PROP_SIGNED_RANGE DRM_MODE_PROP_TYPE(2)
505
506 /* the PROP_ATOMIC flag is used to hide properties from userspace that
507 * is not aware of atomic properties. This is mostly to work around
508 * older userspace (DDX drivers) that read/write each prop they find,
509 * witout being aware that this could be triggering a lengthy modeset.
510 */
511 #define DRM_MODE_PROP_ATOMIC 0x80000000
512
513 struct drm_mode_property_enum {
514 __u64 value;
515 char name[DRM_PROP_NAME_LEN];
516 };
517
518 struct drm_mode_get_property {
519 __u64 values_ptr; /* values and blob lengths */
520 __u64 enum_blob_ptr; /* enum and blob id ptrs */
521
522 __u32 prop_id;
523 __u32 flags;
524 char name[DRM_PROP_NAME_LEN];
525
526 __u32 count_values;
527 /* This is only used to count enum values, not blobs. The _blobs is
528 * simply because of a historical reason, i.e. backwards compat. */
529 __u32 count_enum_blobs;
530 };
531
532 struct drm_mode_connector_set_property {
533 __u64 value;
534 __u32 prop_id;
535 __u32 connector_id;
536 };
537
538 #define DRM_MODE_OBJECT_CRTC 0xcccccccc
539 #define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
540 #define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
541 #define DRM_MODE_OBJECT_MODE 0xdededede
542 #define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
543 #define DRM_MODE_OBJECT_FB 0xfbfbfbfb
544 #define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
545 #define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
546 #define DRM_MODE_OBJECT_ANY 0
547
548 struct drm_mode_obj_get_properties {
549 __u64 props_ptr;
550 __u64 prop_values_ptr;
551 __u32 count_props;
552 __u32 obj_id;
553 __u32 obj_type;
554 };
555
556 struct drm_mode_obj_set_property {
557 __u64 value;
558 __u32 prop_id;
559 __u32 obj_id;
560 __u32 obj_type;
561 };
562
563 struct drm_mode_get_blob {
564 __u32 blob_id;
565 __u32 length;
566 __u64 data;
567 };
568
569 struct drm_mode_fb_cmd {
570 __u32 fb_id;
571 __u32 width;
572 __u32 height;
573 __u32 pitch;
574 __u32 bpp;
575 __u32 depth;
576 /* driver specific handle */
577 __u32 handle;
578 };
579
580 #define DRM_MODE_FB_INTERLACED (1<<0) /* for interlaced framebuffers */
581 #define DRM_MODE_FB_MODIFIERS (1<<1) /* enables ->modifer[] */
582
583 struct drm_mode_fb_cmd2 {
584 __u32 fb_id;
585 __u32 width;
586 __u32 height;
587 __u32 pixel_format; /* fourcc code from drm_fourcc.h */
588 __u32 flags; /* see above flags */
589
590 /*
591 * In case of planar formats, this ioctl allows up to 4
592 * buffer objects with offsets and pitches per plane.
593 * The pitch and offset order is dictated by the fourcc,
594 * e.g. NV12 (https://fourcc.org/yuv.php#NV12) is described as:
595 *
596 * YUV 4:2:0 image with a plane of 8 bit Y samples
597 * followed by an interleaved U/V plane containing
598 * 8 bit 2x2 subsampled colour difference samples.
599 *
600 * So it would consist of Y as offsets[0] and UV as
601 * offsets[1]. Note that offsets[0] will generally
602 * be 0 (but this is not required).
603 *
604 * To accommodate tiled, compressed, etc formats, a
605 * modifier can be specified. The default value of zero
606 * indicates "native" format as specified by the fourcc.
607 * Vendor specific modifier token. Note that even though
608 * it looks like we have a modifier per-plane, we in fact
609 * do not. The modifier for each plane must be identical.
610 * Thus all combinations of different data layouts for
611 * multi plane formats must be enumerated as separate
612 * modifiers.
613 */
614 __u32 handles[4];
615 __u32 pitches[4]; /* pitch for each plane */
616 __u32 offsets[4]; /* offset of each plane */
617 __u64 modifier[4]; /* ie, tiling, compress */
618 };
619
620 #define DRM_MODE_FB_DIRTY_ANNOTATE_COPY 0x01
621 #define DRM_MODE_FB_DIRTY_ANNOTATE_FILL 0x02
622 #define DRM_MODE_FB_DIRTY_FLAGS 0x03
623
624 #define DRM_MODE_FB_DIRTY_MAX_CLIPS 256
625
626 /*
627 * Mark a region of a framebuffer as dirty.
628 *
629 * Some hardware does not automatically update display contents
630 * as a hardware or software draw to a framebuffer. This ioctl
631 * allows userspace to tell the kernel and the hardware what
632 * regions of the framebuffer have changed.
633 *
634 * The kernel or hardware is free to update more then just the
635 * region specified by the clip rects. The kernel or hardware
636 * may also delay and/or coalesce several calls to dirty into a
637 * single update.
638 *
639 * Userspace may annotate the updates, the annotates are a
640 * promise made by the caller that the change is either a copy
641 * of pixels or a fill of a single color in the region specified.
642 *
643 * If the DRM_MODE_FB_DIRTY_ANNOTATE_COPY flag is given then
644 * the number of updated regions are half of num_clips given,
645 * where the clip rects are paired in src and dst. The width and
646 * height of each one of the pairs must match.
647 *
648 * If the DRM_MODE_FB_DIRTY_ANNOTATE_FILL flag is given the caller
649 * promises that the region specified of the clip rects is filled
650 * completely with a single color as given in the color argument.
651 */
652
653 struct drm_mode_fb_dirty_cmd {
654 __u32 fb_id;
655 __u32 flags;
656 __u32 color;
657 __u32 num_clips;
658 __u64 clips_ptr;
659 };
660
661 struct drm_mode_mode_cmd {
662 __u32 connector_id;
663 struct drm_mode_modeinfo mode;
664 };
665
666 #define DRM_MODE_CURSOR_BO 0x01
667 #define DRM_MODE_CURSOR_MOVE 0x02
668 #define DRM_MODE_CURSOR_FLAGS 0x03
669
670 /*
671 * depending on the value in flags different members are used.
672 *
673 * CURSOR_BO uses
674 * crtc_id
675 * width
676 * height
677 * handle - if 0 turns the cursor off
678 *
679 * CURSOR_MOVE uses
680 * crtc_id
681 * x
682 * y
683 */
684 struct drm_mode_cursor {
685 __u32 flags;
686 __u32 crtc_id;
687 __s32 x;
688 __s32 y;
689 __u32 width;
690 __u32 height;
691 /* driver specific handle */
692 __u32 handle;
693 };
694
695 struct drm_mode_cursor2 {
696 __u32 flags;
697 __u32 crtc_id;
698 __s32 x;
699 __s32 y;
700 __u32 width;
701 __u32 height;
702 /* driver specific handle */
703 __u32 handle;
704 __s32 hot_x;
705 __s32 hot_y;
706 };
707
708 struct drm_mode_crtc_lut {
709 __u32 crtc_id;
710 __u32 gamma_size;
711
712 /* pointers to arrays */
713 __u64 red;
714 __u64 green;
715 __u64 blue;
716 };
717
718 struct drm_color_ctm {
719 /*
720 * Conversion matrix in S31.32 sign-magnitude
721 * (not two's complement!) format.
722 */
723 __u64 matrix[9];
724 };
725
726 struct drm_color_lut {
727 /*
728 * Values are mapped linearly to 0.0 - 1.0 range, with 0x0 == 0.0 and
729 * 0xffff == 1.0.
730 */
731 __u16 red;
732 __u16 green;
733 __u16 blue;
734 __u16 reserved;
735 };
736
737 /**
738 * struct hdr_metadata_infoframe - HDR Metadata Infoframe Data.
739 *
740 * HDR Metadata Infoframe as per CTA 861.G spec. This is expected
741 * to match exactly with the spec.
742 *
743 * Userspace is expected to pass the metadata information as per
744 * the format described in this structure.
745 */
746 struct hdr_metadata_infoframe {
747 /**
748 * @eotf: Electro-Optical Transfer Function (EOTF)
749 * used in the stream.
750 */
751 __u8 eotf;
752 /**
753 * @metadata_type: Static_Metadata_Descriptor_ID.
754 */
755 __u8 metadata_type;
756 /**
757 * @display_primaries: Color Primaries of the Data.
758 * These are coded as unsigned 16-bit values in units of
759 * 0.00002, where 0x0000 represents zero and 0xC350
760 * represents 1.0000.
761 * @display_primaries.x: X cordinate of color primary.
762 * @display_primaries.y: Y cordinate of color primary.
763 */
764 struct {
765 __u16 x, y;
766 } display_primaries[3];
767 /**
768 * @white_point: White Point of Colorspace Data.
769 * These are coded as unsigned 16-bit values in units of
770 * 0.00002, where 0x0000 represents zero and 0xC350
771 * represents 1.0000.
772 * @white_point.x: X cordinate of whitepoint of color primary.
773 * @white_point.y: Y cordinate of whitepoint of color primary.
774 */
775 struct {
776 __u16 x, y;
777 } white_point;
778 /**
779 * @max_display_mastering_luminance: Max Mastering Display Luminance.
780 * This value is coded as an unsigned 16-bit value in units of 1 cd/m2,
781 * where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2.
782 */
783 __u16 max_display_mastering_luminance;
784 /**
785 * @min_display_mastering_luminance: Min Mastering Display Luminance.
786 * This value is coded as an unsigned 16-bit value in units of
787 * 0.0001 cd/m2, where 0x0001 represents 0.0001 cd/m2 and 0xFFFF
788 * represents 6.5535 cd/m2.
789 */
790 __u16 min_display_mastering_luminance;
791 /**
792 * @max_cll: Max Content Light Level.
793 * This value is coded as an unsigned 16-bit value in units of 1 cd/m2,
794 * where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2.
795 */
796 __u16 max_cll;
797 /**
798 * @max_fall: Max Frame Average Light Level.
799 * This value is coded as an unsigned 16-bit value in units of 1 cd/m2,
800 * where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2.
801 */
802 __u16 max_fall;
803 };
804
805 /**
806 * struct hdr_output_metadata - HDR output metadata
807 *
808 * Metadata Information to be passed from userspace
809 */
810 struct hdr_output_metadata {
811 /**
812 * @metadata_type: Static_Metadata_Descriptor_ID.
813 */
814 __u32 metadata_type;
815 /**
816 * @hdmi_metadata_type1: HDR Metadata Infoframe.
817 */
818 union {
819 struct hdr_metadata_infoframe hdmi_metadata_type1;
820 };
821 };
822
823 #define DRM_MODE_PAGE_FLIP_EVENT 0x01
824 #define DRM_MODE_PAGE_FLIP_ASYNC 0x02
825 #define DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE 0x4
826 #define DRM_MODE_PAGE_FLIP_TARGET_RELATIVE 0x8
827 #define DRM_MODE_PAGE_FLIP_TARGET (DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE | \
828 DRM_MODE_PAGE_FLIP_TARGET_RELATIVE)
829 #define DRM_MODE_PAGE_FLIP_FLAGS (DRM_MODE_PAGE_FLIP_EVENT | \
830 DRM_MODE_PAGE_FLIP_ASYNC | \
831 DRM_MODE_PAGE_FLIP_TARGET)
832
833 /*
834 * Request a page flip on the specified crtc.
835 *
836 * This ioctl will ask KMS to schedule a page flip for the specified
837 * crtc. Once any pending rendering targeting the specified fb (as of
838 * ioctl time) has completed, the crtc will be reprogrammed to display
839 * that fb after the next vertical refresh. The ioctl returns
840 * immediately, but subsequent rendering to the current fb will block
841 * in the execbuffer ioctl until the page flip happens. If a page
842 * flip is already pending as the ioctl is called, EBUSY will be
843 * returned.
844 *
845 * Flag DRM_MODE_PAGE_FLIP_EVENT requests that drm sends back a vblank
846 * event (see drm.h: struct drm_event_vblank) when the page flip is
847 * done. The user_data field passed in with this ioctl will be
848 * returned as the user_data field in the vblank event struct.
849 *
850 * Flag DRM_MODE_PAGE_FLIP_ASYNC requests that the flip happen
851 * 'as soon as possible', meaning that it not delay waiting for vblank.
852 * This may cause tearing on the screen.
853 *
854 * The reserved field must be zero.
855 */
856
857 struct drm_mode_crtc_page_flip {
858 __u32 crtc_id;
859 __u32 fb_id;
860 __u32 flags;
861 __u32 reserved;
862 __u64 user_data;
863 };
864
865 /*
866 * Request a page flip on the specified crtc.
867 *
868 * Same as struct drm_mode_crtc_page_flip, but supports new flags and
869 * re-purposes the reserved field:
870 *
871 * The sequence field must be zero unless either of the
872 * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is specified. When
873 * the ABSOLUTE flag is specified, the sequence field denotes the absolute
874 * vblank sequence when the flip should take effect. When the RELATIVE
875 * flag is specified, the sequence field denotes the relative (to the
876 * current one when the ioctl is called) vblank sequence when the flip
877 * should take effect. NOTE: DRM_IOCTL_WAIT_VBLANK must still be used to
878 * make sure the vblank sequence before the target one has passed before
879 * calling this ioctl. The purpose of the
880 * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is merely to clarify
881 * the target for when code dealing with a page flip runs during a
882 * vertical blank period.
883 */
884
885 struct drm_mode_crtc_page_flip_target {
886 __u32 crtc_id;
887 __u32 fb_id;
888 __u32 flags;
889 __u32 sequence;
890 __u64 user_data;
891 };
892
893 /* create a dumb scanout buffer */
894 struct drm_mode_create_dumb {
895 __u32 height;
896 __u32 width;
897 __u32 bpp;
898 __u32 flags;
899 /* handle, pitch, size will be returned */
900 __u32 handle;
901 __u32 pitch;
902 __u64 size;
903 };
904
905 /* set up for mmap of a dumb scanout buffer */
906 struct drm_mode_map_dumb {
907 /** Handle for the object being mapped. */
908 __u32 handle;
909 __u32 pad;
910 /**
911 * Fake offset to use for subsequent mmap call
912 *
913 * This is a fixed-size type for 32/64 compatibility.
914 */
915 __u64 offset;
916 };
917
918 struct drm_mode_destroy_dumb {
919 __u32 handle;
920 };
921
922 /* page-flip flags are valid, plus: */
923 #define DRM_MODE_ATOMIC_TEST_ONLY 0x0100
924 #define DRM_MODE_ATOMIC_NONBLOCK 0x0200
925 #define DRM_MODE_ATOMIC_ALLOW_MODESET 0x0400
926
927 #define DRM_MODE_ATOMIC_FLAGS (\
928 DRM_MODE_PAGE_FLIP_EVENT |\
929 DRM_MODE_PAGE_FLIP_ASYNC |\
930 DRM_MODE_ATOMIC_TEST_ONLY |\
931 DRM_MODE_ATOMIC_NONBLOCK |\
932 DRM_MODE_ATOMIC_ALLOW_MODESET)
933
934 struct drm_mode_atomic {
935 __u32 flags;
936 __u32 count_objs;
937 __u64 objs_ptr;
938 __u64 count_props_ptr;
939 __u64 props_ptr;
940 __u64 prop_values_ptr;
941 __u64 reserved;
942 __u64 user_data;
943 };
944
945 struct drm_format_modifier_blob {
946 #define FORMAT_BLOB_CURRENT 1
947 /* Version of this blob format */
948 __u32 version;
949
950 /* Flags */
951 __u32 flags;
952
953 /* Number of fourcc formats supported */
954 __u32 count_formats;
955
956 /* Where in this blob the formats exist (in bytes) */
957 __u32 formats_offset;
958
959 /* Number of drm_format_modifiers */
960 __u32 count_modifiers;
961
962 /* Where in this blob the modifiers exist (in bytes) */
963 __u32 modifiers_offset;
964
965 /* __u32 formats[] */
966 /* struct drm_format_modifier modifiers[] */
967 };
968
969 struct drm_format_modifier {
970 /* Bitmask of formats in get_plane format list this info applies to. The
971 * offset allows a sliding window of which 64 formats (bits).
972 *
973 * Some examples:
974 * In today's world with < 65 formats, and formats 0, and 2 are
975 * supported
976 * 0x0000000000000005
977 * ^-offset = 0, formats = 5
978 *
979 * If the number formats grew to 128, and formats 98-102 are
980 * supported with the modifier:
981 *
982 * 0x0000007c00000000 0000000000000000
983 * ^
984 * |__offset = 64, formats = 0x7c00000000
985 *
986 */
987 __u64 formats;
988 __u32 offset;
989 __u32 pad;
990
991 /* The modifier that applies to the >get_plane format list bitmask. */
992 __u64 modifier;
993 };
994
995 /**
996 * struct drm_mode_create_blob - Create New block property
997 *
998 * Create a new 'blob' data property, copying length bytes from data pointer,
999 * and returning new blob ID.
1000 */
1001 struct drm_mode_create_blob {
1002 /** @data: Pointer to data to copy. */
1003 __u64 data;
1004 /** @length: Length of data to copy. */
1005 __u32 length;
1006 /** @blob_id: Return: new property ID. */
1007 __u32 blob_id;
1008 };
1009
1010 /**
1011 * struct drm_mode_destroy_blob - Destroy user blob
1012 * @blob_id: blob_id to destroy
1013 *
1014 * Destroy a user-created blob property.
1015 *
1016 * User-space can release blobs as soon as they do not need to refer to them by
1017 * their blob object ID. For instance, if you are using a MODE_ID blob in an
1018 * atomic commit and you will not make another commit re-using the same ID, you
1019 * can destroy the blob as soon as the commit has been issued, without waiting
1020 * for it to complete.
1021 */
1022 struct drm_mode_destroy_blob {
1023 __u32 blob_id;
1024 };
1025
1026 /**
1027 * struct drm_mode_create_lease - Create lease
1028 *
1029 * Lease mode resources, creating another drm_master.
1030 */
1031 struct drm_mode_create_lease {
1032 /** @object_ids: Pointer to array of object ids (__u32) */
1033 __u64 object_ids;
1034 /** @object_count: Number of object ids */
1035 __u32 object_count;
1036 /** @flags: flags for new FD (O_CLOEXEC, etc) */
1037 __u32 flags;
1038
1039 /** @lessee_id: Return: unique identifier for lessee. */
1040 __u32 lessee_id;
1041 /** @fd: Return: file descriptor to new drm_master file */
1042 __u32 fd;
1043 };
1044
1045 /**
1046 * struct drm_mode_list_lessees - List lessees
1047 *
1048 * List lesses from a drm_master.
1049 */
1050 struct drm_mode_list_lessees {
1051 /**
1052 * @count_lessees: Number of lessees.
1053 *
1054 * On input, provides length of the array.
1055 * On output, provides total number. No
1056 * more than the input number will be written
1057 * back, so two calls can be used to get
1058 * the size and then the data.
1059 */
1060 __u32 count_lessees;
1061 /** @pad: Padding. */
1062 __u32 pad;
1063
1064 /**
1065 * @lessees_ptr: Pointer to lessees.
1066 *
1067 * Pointer to __u64 array of lessee ids
1068 */
1069 __u64 lessees_ptr;
1070 };
1071
1072 /**
1073 * struct drm_mode_get_lease - Get Lease
1074 *
1075 * Get leased objects.
1076 */
1077 struct drm_mode_get_lease {
1078 /**
1079 * @count_objects: Number of leased objects.
1080 *
1081 * On input, provides length of the array.
1082 * On output, provides total number. No
1083 * more than the input number will be written
1084 * back, so two calls can be used to get
1085 * the size and then the data.
1086 */
1087 __u32 count_objects;
1088 /** @pad: Padding. */
1089 __u32 pad;
1090
1091 /**
1092 * @objects_ptr: Pointer to objects.
1093 *
1094 * Pointer to __u32 array of object ids.
1095 */
1096 __u64 objects_ptr;
1097 };
1098
1099 /**
1100 * struct drm_mode_revoke_lease - Revoke lease
1101 */
1102 struct drm_mode_revoke_lease {
1103 /** @lessee_id: Unique ID of lessee */
1104 __u32 lessee_id;
1105 };
1106
1107 /**
1108 * struct drm_mode_rect - Two dimensional rectangle.
1109 * @x1: Horizontal starting coordinate (inclusive).
1110 * @y1: Vertical starting coordinate (inclusive).
1111 * @x2: Horizontal ending coordinate (exclusive).
1112 * @y2: Vertical ending coordinate (exclusive).
1113 *
1114 * With drm subsystem using struct drm_rect to manage rectangular area this
1115 * export it to user-space.
1116 *
1117 * Currently used by drm_mode_atomic blob property FB_DAMAGE_CLIPS.
1118 */
1119 struct drm_mode_rect {
1120 __s32 x1;
1121 __s32 y1;
1122 __s32 x2;
1123 __s32 y2;
1124 };
1125
1126 #if defined(__cplusplus)
1127 }
1128 #endif
1129
1130 #endif
Linux with added FPC-III support