README: add Vulkan into the generic description
[piglit.git] / src / drm-uapi / drm.h
blob02540248deb1691050b71c453b6d6dcd04ffca91
1 /*
2 * Header for the Direct Rendering Manager
4 * Author: Rickard E. (Rik) Faith <faith@valinux.com>
6 * Acknowledgments:
7 * Dec 1999, Richard Henderson <rth@twiddle.net>, move to generic cmpxchg.
8 */
11 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
12 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
13 * All rights reserved.
15 * Permission is hereby granted, free of charge, to any person obtaining a
16 * copy of this software and associated documentation files (the "Software"),
17 * to deal in the Software without restriction, including without limitation
18 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
19 * and/or sell copies of the Software, and to permit persons to whom the
20 * Software is furnished to do so, subject to the following conditions:
22 * The above copyright notice and this permission notice (including the next
23 * paragraph) shall be included in all copies or substantial portions of the
24 * Software.
26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
27 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
28 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
29 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
30 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
31 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
32 * OTHER DEALINGS IN THE SOFTWARE.
35 #ifndef _DRM_H_
36 #define _DRM_H_
38 #if defined(__linux__)
40 #include <linux/types.h>
41 #include <asm/ioctl.h>
42 typedef unsigned int drm_handle_t;
44 #else /* One of the BSDs */
46 #include <stdint.h>
47 #include <sys/ioccom.h>
48 #include <sys/types.h>
49 typedef int8_t __s8;
50 typedef uint8_t __u8;
51 typedef int16_t __s16;
52 typedef uint16_t __u16;
53 typedef int32_t __s32;
54 typedef uint32_t __u32;
55 typedef int64_t __s64;
56 typedef uint64_t __u64;
57 typedef size_t __kernel_size_t;
58 typedef unsigned long drm_handle_t;
60 #endif
62 #if defined(__cplusplus)
63 extern "C" {
64 #endif
66 #define DRM_NAME "drm" /**< Name in kernel, /dev, and /proc */
67 #define DRM_MIN_ORDER 5 /**< At least 2^5 bytes = 32 bytes */
68 #define DRM_MAX_ORDER 22 /**< Up to 2^22 bytes = 4MB */
69 #define DRM_RAM_PERCENT 10 /**< How much system ram can we lock? */
71 #define _DRM_LOCK_HELD 0x80000000U /**< Hardware lock is held */
72 #define _DRM_LOCK_CONT 0x40000000U /**< Hardware lock is contended */
73 #define _DRM_LOCK_IS_HELD(lock) ((lock) & _DRM_LOCK_HELD)
74 #define _DRM_LOCK_IS_CONT(lock) ((lock) & _DRM_LOCK_CONT)
75 #define _DRM_LOCKING_CONTEXT(lock) ((lock) & ~(_DRM_LOCK_HELD|_DRM_LOCK_CONT))
77 typedef unsigned int drm_context_t;
78 typedef unsigned int drm_drawable_t;
79 typedef unsigned int drm_magic_t;
82 * Cliprect.
84 * \warning: If you change this structure, make sure you change
85 * XF86DRIClipRectRec in the server as well
87 * \note KW: Actually it's illegal to change either for
88 * backwards-compatibility reasons.
90 struct drm_clip_rect {
91 unsigned short x1;
92 unsigned short y1;
93 unsigned short x2;
94 unsigned short y2;
98 * Drawable information.
100 struct drm_drawable_info {
101 unsigned int num_rects;
102 struct drm_clip_rect *rects;
106 * Texture region,
108 struct drm_tex_region {
109 unsigned char next;
110 unsigned char prev;
111 unsigned char in_use;
112 unsigned char padding;
113 unsigned int age;
117 * Hardware lock.
119 * The lock structure is a simple cache-line aligned integer. To avoid
120 * processor bus contention on a multiprocessor system, there should not be any
121 * other data stored in the same cache line.
123 struct drm_hw_lock {
124 __volatile__ unsigned int lock; /**< lock variable */
125 char padding[60]; /**< Pad to cache line */
129 * DRM_IOCTL_VERSION ioctl argument type.
131 * \sa drmGetVersion().
133 struct drm_version {
134 int version_major; /**< Major version */
135 int version_minor; /**< Minor version */
136 int version_patchlevel; /**< Patch level */
137 __kernel_size_t name_len; /**< Length of name buffer */
138 char *name; /**< Name of driver */
139 __kernel_size_t date_len; /**< Length of date buffer */
140 char *date; /**< User-space buffer to hold date */
141 __kernel_size_t desc_len; /**< Length of desc buffer */
142 char *desc; /**< User-space buffer to hold desc */
146 * DRM_IOCTL_GET_UNIQUE ioctl argument type.
148 * \sa drmGetBusid() and drmSetBusId().
150 struct drm_unique {
151 __kernel_size_t unique_len; /**< Length of unique */
152 char *unique; /**< Unique name for driver instantiation */
155 struct drm_list {
156 int count; /**< Length of user-space structures */
157 struct drm_version *version;
160 struct drm_block {
161 int unused;
165 * DRM_IOCTL_CONTROL ioctl argument type.
167 * \sa drmCtlInstHandler() and drmCtlUninstHandler().
169 struct drm_control {
170 enum {
171 DRM_ADD_COMMAND,
172 DRM_RM_COMMAND,
173 DRM_INST_HANDLER,
174 DRM_UNINST_HANDLER
175 } func;
176 int irq;
180 * Type of memory to map.
182 enum drm_map_type {
183 _DRM_FRAME_BUFFER = 0, /**< WC (no caching), no core dump */
184 _DRM_REGISTERS = 1, /**< no caching, no core dump */
185 _DRM_SHM = 2, /**< shared, cached */
186 _DRM_AGP = 3, /**< AGP/GART */
187 _DRM_SCATTER_GATHER = 4, /**< Scatter/gather memory for PCI DMA */
188 _DRM_CONSISTENT = 5 /**< Consistent memory for PCI DMA */
192 * Memory mapping flags.
194 enum drm_map_flags {
195 _DRM_RESTRICTED = 0x01, /**< Cannot be mapped to user-virtual */
196 _DRM_READ_ONLY = 0x02,
197 _DRM_LOCKED = 0x04, /**< shared, cached, locked */
198 _DRM_KERNEL = 0x08, /**< kernel requires access */
199 _DRM_WRITE_COMBINING = 0x10, /**< use write-combining if available */
200 _DRM_CONTAINS_LOCK = 0x20, /**< SHM page that contains lock */
201 _DRM_REMOVABLE = 0x40, /**< Removable mapping */
202 _DRM_DRIVER = 0x80 /**< Managed by driver */
205 struct drm_ctx_priv_map {
206 unsigned int ctx_id; /**< Context requesting private mapping */
207 void *handle; /**< Handle of map */
211 * DRM_IOCTL_GET_MAP, DRM_IOCTL_ADD_MAP and DRM_IOCTL_RM_MAP ioctls
212 * argument type.
214 * \sa drmAddMap().
216 struct drm_map {
217 unsigned long offset; /**< Requested physical address (0 for SAREA)*/
218 unsigned long size; /**< Requested physical size (bytes) */
219 enum drm_map_type type; /**< Type of memory to map */
220 enum drm_map_flags flags; /**< Flags */
221 void *handle; /**< User-space: "Handle" to pass to mmap() */
222 /**< Kernel-space: kernel-virtual address */
223 int mtrr; /**< MTRR slot used */
224 /* Private data */
228 * DRM_IOCTL_GET_CLIENT ioctl argument type.
230 struct drm_client {
231 int idx; /**< Which client desired? */
232 int auth; /**< Is client authenticated? */
233 unsigned long pid; /**< Process ID */
234 unsigned long uid; /**< User ID */
235 unsigned long magic; /**< Magic */
236 unsigned long iocs; /**< Ioctl count */
239 enum drm_stat_type {
240 _DRM_STAT_LOCK,
241 _DRM_STAT_OPENS,
242 _DRM_STAT_CLOSES,
243 _DRM_STAT_IOCTLS,
244 _DRM_STAT_LOCKS,
245 _DRM_STAT_UNLOCKS,
246 _DRM_STAT_VALUE, /**< Generic value */
247 _DRM_STAT_BYTE, /**< Generic byte counter (1024bytes/K) */
248 _DRM_STAT_COUNT, /**< Generic non-byte counter (1000/k) */
250 _DRM_STAT_IRQ, /**< IRQ */
251 _DRM_STAT_PRIMARY, /**< Primary DMA bytes */
252 _DRM_STAT_SECONDARY, /**< Secondary DMA bytes */
253 _DRM_STAT_DMA, /**< DMA */
254 _DRM_STAT_SPECIAL, /**< Special DMA (e.g., priority or polled) */
255 _DRM_STAT_MISSED /**< Missed DMA opportunity */
256 /* Add to the *END* of the list */
260 * DRM_IOCTL_GET_STATS ioctl argument type.
262 struct drm_stats {
263 unsigned long count;
264 struct {
265 unsigned long value;
266 enum drm_stat_type type;
267 } data[15];
271 * Hardware locking flags.
273 enum drm_lock_flags {
274 _DRM_LOCK_READY = 0x01, /**< Wait until hardware is ready for DMA */
275 _DRM_LOCK_QUIESCENT = 0x02, /**< Wait until hardware quiescent */
276 _DRM_LOCK_FLUSH = 0x04, /**< Flush this context's DMA queue first */
277 _DRM_LOCK_FLUSH_ALL = 0x08, /**< Flush all DMA queues first */
278 /* These *HALT* flags aren't supported yet
279 -- they will be used to support the
280 full-screen DGA-like mode. */
281 _DRM_HALT_ALL_QUEUES = 0x10, /**< Halt all current and future queues */
282 _DRM_HALT_CUR_QUEUES = 0x20 /**< Halt all current queues */
286 * DRM_IOCTL_LOCK, DRM_IOCTL_UNLOCK and DRM_IOCTL_FINISH ioctl argument type.
288 * \sa drmGetLock() and drmUnlock().
290 struct drm_lock {
291 int context;
292 enum drm_lock_flags flags;
296 * DMA flags
298 * \warning
299 * These values \e must match xf86drm.h.
301 * \sa drm_dma.
303 enum drm_dma_flags {
304 /* Flags for DMA buffer dispatch */
305 _DRM_DMA_BLOCK = 0x01, /**<
306 * Block until buffer dispatched.
308 * \note The buffer may not yet have
309 * been processed by the hardware --
310 * getting a hardware lock with the
311 * hardware quiescent will ensure
312 * that the buffer has been
313 * processed.
315 _DRM_DMA_WHILE_LOCKED = 0x02, /**< Dispatch while lock held */
316 _DRM_DMA_PRIORITY = 0x04, /**< High priority dispatch */
318 /* Flags for DMA buffer request */
319 _DRM_DMA_WAIT = 0x10, /**< Wait for free buffers */
320 _DRM_DMA_SMALLER_OK = 0x20, /**< Smaller-than-requested buffers OK */
321 _DRM_DMA_LARGER_OK = 0x40 /**< Larger-than-requested buffers OK */
325 * DRM_IOCTL_ADD_BUFS and DRM_IOCTL_MARK_BUFS ioctl argument type.
327 * \sa drmAddBufs().
329 struct drm_buf_desc {
330 int count; /**< Number of buffers of this size */
331 int size; /**< Size in bytes */
332 int low_mark; /**< Low water mark */
333 int high_mark; /**< High water mark */
334 enum {
335 _DRM_PAGE_ALIGN = 0x01, /**< Align on page boundaries for DMA */
336 _DRM_AGP_BUFFER = 0x02, /**< Buffer is in AGP space */
337 _DRM_SG_BUFFER = 0x04, /**< Scatter/gather memory buffer */
338 _DRM_FB_BUFFER = 0x08, /**< Buffer is in frame buffer */
339 _DRM_PCI_BUFFER_RO = 0x10 /**< Map PCI DMA buffer read-only */
340 } flags;
341 unsigned long agp_start; /**<
342 * Start address of where the AGP buffers are
343 * in the AGP aperture
348 * DRM_IOCTL_INFO_BUFS ioctl argument type.
350 struct drm_buf_info {
351 int count; /**< Entries in list */
352 struct drm_buf_desc *list;
356 * DRM_IOCTL_FREE_BUFS ioctl argument type.
358 struct drm_buf_free {
359 int count;
360 int *list;
364 * Buffer information
366 * \sa drm_buf_map.
368 struct drm_buf_pub {
369 int idx; /**< Index into the master buffer list */
370 int total; /**< Buffer size */
371 int used; /**< Amount of buffer in use (for DMA) */
372 void *address; /**< Address of buffer */
376 * DRM_IOCTL_MAP_BUFS ioctl argument type.
378 struct drm_buf_map {
379 int count; /**< Length of the buffer list */
380 #ifdef __cplusplus
381 void *virt;
382 #else
383 void *virtual; /**< Mmap'd area in user-virtual */
384 #endif
385 struct drm_buf_pub *list; /**< Buffer information */
389 * DRM_IOCTL_DMA ioctl argument type.
391 * Indices here refer to the offset into the buffer list in drm_buf_get.
393 * \sa drmDMA().
395 struct drm_dma {
396 int context; /**< Context handle */
397 int send_count; /**< Number of buffers to send */
398 int *send_indices; /**< List of handles to buffers */
399 int *send_sizes; /**< Lengths of data to send */
400 enum drm_dma_flags flags; /**< Flags */
401 int request_count; /**< Number of buffers requested */
402 int request_size; /**< Desired size for buffers */
403 int *request_indices; /**< Buffer information */
404 int *request_sizes;
405 int granted_count; /**< Number of buffers granted */
408 enum drm_ctx_flags {
409 _DRM_CONTEXT_PRESERVED = 0x01,
410 _DRM_CONTEXT_2DONLY = 0x02
414 * DRM_IOCTL_ADD_CTX ioctl argument type.
416 * \sa drmCreateContext() and drmDestroyContext().
418 struct drm_ctx {
419 drm_context_t handle;
420 enum drm_ctx_flags flags;
424 * DRM_IOCTL_RES_CTX ioctl argument type.
426 struct drm_ctx_res {
427 int count;
428 struct drm_ctx *contexts;
432 * DRM_IOCTL_ADD_DRAW and DRM_IOCTL_RM_DRAW ioctl argument type.
434 struct drm_draw {
435 drm_drawable_t handle;
439 * DRM_IOCTL_UPDATE_DRAW ioctl argument type.
441 typedef enum {
442 DRM_DRAWABLE_CLIPRECTS
443 } drm_drawable_info_type_t;
445 struct drm_update_draw {
446 drm_drawable_t handle;
447 unsigned int type;
448 unsigned int num;
449 unsigned long long data;
453 * DRM_IOCTL_GET_MAGIC and DRM_IOCTL_AUTH_MAGIC ioctl argument type.
455 struct drm_auth {
456 drm_magic_t magic;
460 * DRM_IOCTL_IRQ_BUSID ioctl argument type.
462 * \sa drmGetInterruptFromBusID().
464 struct drm_irq_busid {
465 int irq; /**< IRQ number */
466 int busnum; /**< bus number */
467 int devnum; /**< device number */
468 int funcnum; /**< function number */
471 enum drm_vblank_seq_type {
472 _DRM_VBLANK_ABSOLUTE = 0x0, /**< Wait for specific vblank sequence number */
473 _DRM_VBLANK_RELATIVE = 0x1, /**< Wait for given number of vblanks */
474 /* bits 1-6 are reserved for high crtcs */
475 _DRM_VBLANK_HIGH_CRTC_MASK = 0x0000003e,
476 _DRM_VBLANK_EVENT = 0x4000000, /**< Send event instead of blocking */
477 _DRM_VBLANK_FLIP = 0x8000000, /**< Scheduled buffer swap should flip */
478 _DRM_VBLANK_NEXTONMISS = 0x10000000, /**< If missed, wait for next vblank */
479 _DRM_VBLANK_SECONDARY = 0x20000000, /**< Secondary display controller */
480 _DRM_VBLANK_SIGNAL = 0x40000000 /**< Send signal instead of blocking, unsupported */
482 #define _DRM_VBLANK_HIGH_CRTC_SHIFT 1
484 #define _DRM_VBLANK_TYPES_MASK (_DRM_VBLANK_ABSOLUTE | _DRM_VBLANK_RELATIVE)
485 #define _DRM_VBLANK_FLAGS_MASK (_DRM_VBLANK_EVENT | _DRM_VBLANK_SIGNAL | \
486 _DRM_VBLANK_SECONDARY | _DRM_VBLANK_NEXTONMISS)
488 struct drm_wait_vblank_request {
489 enum drm_vblank_seq_type type;
490 unsigned int sequence;
491 unsigned long signal;
494 struct drm_wait_vblank_reply {
495 enum drm_vblank_seq_type type;
496 unsigned int sequence;
497 long tval_sec;
498 long tval_usec;
502 * DRM_IOCTL_WAIT_VBLANK ioctl argument type.
504 * \sa drmWaitVBlank().
506 union drm_wait_vblank {
507 struct drm_wait_vblank_request request;
508 struct drm_wait_vblank_reply reply;
511 #define _DRM_PRE_MODESET 1
512 #define _DRM_POST_MODESET 2
515 * DRM_IOCTL_MODESET_CTL ioctl argument type
517 * \sa drmModesetCtl().
519 struct drm_modeset_ctl {
520 __u32 crtc;
521 __u32 cmd;
525 * DRM_IOCTL_AGP_ENABLE ioctl argument type.
527 * \sa drmAgpEnable().
529 struct drm_agp_mode {
530 unsigned long mode; /**< AGP mode */
534 * DRM_IOCTL_AGP_ALLOC and DRM_IOCTL_AGP_FREE ioctls argument type.
536 * \sa drmAgpAlloc() and drmAgpFree().
538 struct drm_agp_buffer {
539 unsigned long size; /**< In bytes -- will round to page boundary */
540 unsigned long handle; /**< Used for binding / unbinding */
541 unsigned long type; /**< Type of memory to allocate */
542 unsigned long physical; /**< Physical used by i810 */
546 * DRM_IOCTL_AGP_BIND and DRM_IOCTL_AGP_UNBIND ioctls argument type.
548 * \sa drmAgpBind() and drmAgpUnbind().
550 struct drm_agp_binding {
551 unsigned long handle; /**< From drm_agp_buffer */
552 unsigned long offset; /**< In bytes -- will round to page boundary */
556 * DRM_IOCTL_AGP_INFO ioctl argument type.
558 * \sa drmAgpVersionMajor(), drmAgpVersionMinor(), drmAgpGetMode(),
559 * drmAgpBase(), drmAgpSize(), drmAgpMemoryUsed(), drmAgpMemoryAvail(),
560 * drmAgpVendorId() and drmAgpDeviceId().
562 struct drm_agp_info {
563 int agp_version_major;
564 int agp_version_minor;
565 unsigned long mode;
566 unsigned long aperture_base; /* physical address */
567 unsigned long aperture_size; /* bytes */
568 unsigned long memory_allowed; /* bytes */
569 unsigned long memory_used;
571 /* PCI information */
572 unsigned short id_vendor;
573 unsigned short id_device;
577 * DRM_IOCTL_SG_ALLOC ioctl argument type.
579 struct drm_scatter_gather {
580 unsigned long size; /**< In bytes -- will round to page boundary */
581 unsigned long handle; /**< Used for mapping / unmapping */
585 * DRM_IOCTL_SET_VERSION ioctl argument type.
587 struct drm_set_version {
588 int drm_di_major;
589 int drm_di_minor;
590 int drm_dd_major;
591 int drm_dd_minor;
594 /* DRM_IOCTL_GEM_CLOSE ioctl argument type */
595 struct drm_gem_close {
596 /** Handle of the object to be closed. */
597 __u32 handle;
598 __u32 pad;
601 /* DRM_IOCTL_GEM_FLINK ioctl argument type */
602 struct drm_gem_flink {
603 /** Handle for the object being named */
604 __u32 handle;
606 /** Returned global name */
607 __u32 name;
610 /* DRM_IOCTL_GEM_OPEN ioctl argument type */
611 struct drm_gem_open {
612 /** Name of object being opened */
613 __u32 name;
615 /** Returned handle for the object */
616 __u32 handle;
618 /** Returned size of the object */
619 __u64 size;
623 * DRM_CAP_DUMB_BUFFER
625 * If set to 1, the driver supports creating dumb buffers via the
626 * &DRM_IOCTL_MODE_CREATE_DUMB ioctl.
628 #define DRM_CAP_DUMB_BUFFER 0x1
630 * DRM_CAP_VBLANK_HIGH_CRTC
632 * If set to 1, the kernel supports specifying a :ref:`CRTC index<crtc_index>`
633 * in the high bits of &drm_wait_vblank_request.type.
635 * Starting kernel version 2.6.39, this capability is always set to 1.
637 #define DRM_CAP_VBLANK_HIGH_CRTC 0x2
639 * DRM_CAP_DUMB_PREFERRED_DEPTH
641 * The preferred bit depth for dumb buffers.
643 * The bit depth is the number of bits used to indicate the color of a single
644 * pixel excluding any padding. This is different from the number of bits per
645 * pixel. For instance, XRGB8888 has a bit depth of 24 but has 32 bits per
646 * pixel.
648 * Note that this preference only applies to dumb buffers, it's irrelevant for
649 * other types of buffers.
651 #define DRM_CAP_DUMB_PREFERRED_DEPTH 0x3
653 * DRM_CAP_DUMB_PREFER_SHADOW
655 * If set to 1, the driver prefers userspace to render to a shadow buffer
656 * instead of directly rendering to a dumb buffer. For best speed, userspace
657 * should do streaming ordered memory copies into the dumb buffer and never
658 * read from it.
660 * Note that this preference only applies to dumb buffers, it's irrelevant for
661 * other types of buffers.
663 #define DRM_CAP_DUMB_PREFER_SHADOW 0x4
665 * DRM_CAP_PRIME
667 * Bitfield of supported PRIME sharing capabilities. See &DRM_PRIME_CAP_IMPORT
668 * and &DRM_PRIME_CAP_EXPORT.
670 * Starting from kernel version 6.6, both &DRM_PRIME_CAP_IMPORT and
671 * &DRM_PRIME_CAP_EXPORT are always advertised.
673 * PRIME buffers are exposed as dma-buf file descriptors.
674 * See :ref:`prime_buffer_sharing`.
676 #define DRM_CAP_PRIME 0x5
678 * DRM_PRIME_CAP_IMPORT
680 * If this bit is set in &DRM_CAP_PRIME, the driver supports importing PRIME
681 * buffers via the &DRM_IOCTL_PRIME_FD_TO_HANDLE ioctl.
683 * Starting from kernel version 6.6, this bit is always set in &DRM_CAP_PRIME.
685 #define DRM_PRIME_CAP_IMPORT 0x1
687 * DRM_PRIME_CAP_EXPORT
689 * If this bit is set in &DRM_CAP_PRIME, the driver supports exporting PRIME
690 * buffers via the &DRM_IOCTL_PRIME_HANDLE_TO_FD ioctl.
692 * Starting from kernel version 6.6, this bit is always set in &DRM_CAP_PRIME.
694 #define DRM_PRIME_CAP_EXPORT 0x2
696 * DRM_CAP_TIMESTAMP_MONOTONIC
698 * If set to 0, the kernel will report timestamps with ``CLOCK_REALTIME`` in
699 * struct drm_event_vblank. If set to 1, the kernel will report timestamps with
700 * ``CLOCK_MONOTONIC``. See ``clock_gettime(2)`` for the definition of these
701 * clocks.
703 * Starting from kernel version 2.6.39, the default value for this capability
704 * is 1. Starting kernel version 4.15, this capability is always set to 1.
706 #define DRM_CAP_TIMESTAMP_MONOTONIC 0x6
708 * DRM_CAP_ASYNC_PAGE_FLIP
710 * If set to 1, the driver supports &DRM_MODE_PAGE_FLIP_ASYNC.
712 #define DRM_CAP_ASYNC_PAGE_FLIP 0x7
714 * DRM_CAP_CURSOR_WIDTH
716 * The ``CURSOR_WIDTH`` and ``CURSOR_HEIGHT`` capabilities return a valid
717 * width x height combination for the hardware cursor. The intention is that a
718 * hardware agnostic userspace can query a cursor plane size to use.
720 * Note that the cross-driver contract is to merely return a valid size;
721 * drivers are free to attach another meaning on top, eg. i915 returns the
722 * maximum plane size.
724 #define DRM_CAP_CURSOR_WIDTH 0x8
726 * DRM_CAP_CURSOR_HEIGHT
728 * See &DRM_CAP_CURSOR_WIDTH.
730 #define DRM_CAP_CURSOR_HEIGHT 0x9
732 * DRM_CAP_ADDFB2_MODIFIERS
734 * If set to 1, the driver supports supplying modifiers in the
735 * &DRM_IOCTL_MODE_ADDFB2 ioctl.
737 #define DRM_CAP_ADDFB2_MODIFIERS 0x10
739 * DRM_CAP_PAGE_FLIP_TARGET
741 * If set to 1, the driver supports the &DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE and
742 * &DRM_MODE_PAGE_FLIP_TARGET_RELATIVE flags in
743 * &drm_mode_crtc_page_flip_target.flags for the &DRM_IOCTL_MODE_PAGE_FLIP
744 * ioctl.
746 #define DRM_CAP_PAGE_FLIP_TARGET 0x11
748 * DRM_CAP_CRTC_IN_VBLANK_EVENT
750 * If set to 1, the kernel supports reporting the CRTC ID in
751 * &drm_event_vblank.crtc_id for the &DRM_EVENT_VBLANK and
752 * &DRM_EVENT_FLIP_COMPLETE events.
754 * Starting kernel version 4.12, this capability is always set to 1.
756 #define DRM_CAP_CRTC_IN_VBLANK_EVENT 0x12
758 * DRM_CAP_SYNCOBJ
760 * If set to 1, the driver supports sync objects. See :ref:`drm_sync_objects`.
762 #define DRM_CAP_SYNCOBJ 0x13
764 * DRM_CAP_SYNCOBJ_TIMELINE
766 * If set to 1, the driver supports timeline operations on sync objects. See
767 * :ref:`drm_sync_objects`.
769 #define DRM_CAP_SYNCOBJ_TIMELINE 0x14
771 /* DRM_IOCTL_GET_CAP ioctl argument type */
772 struct drm_get_cap {
773 __u64 capability;
774 __u64 value;
778 * DRM_CLIENT_CAP_STEREO_3D
780 * If set to 1, the DRM core will expose the stereo 3D capabilities of the
781 * monitor by advertising the supported 3D layouts in the flags of struct
782 * drm_mode_modeinfo. See ``DRM_MODE_FLAG_3D_*``.
784 * This capability is always supported for all drivers starting from kernel
785 * version 3.13.
787 #define DRM_CLIENT_CAP_STEREO_3D 1
790 * DRM_CLIENT_CAP_UNIVERSAL_PLANES
792 * If set to 1, the DRM core will expose all planes (overlay, primary, and
793 * cursor) to userspace.
795 * This capability has been introduced in kernel version 3.15. Starting from
796 * kernel version 3.17, this capability is always supported for all drivers.
798 #define DRM_CLIENT_CAP_UNIVERSAL_PLANES 2
801 * DRM_CLIENT_CAP_ATOMIC
803 * If set to 1, the DRM core will expose atomic properties to userspace. This
804 * implicitly enables &DRM_CLIENT_CAP_UNIVERSAL_PLANES and
805 * &DRM_CLIENT_CAP_ASPECT_RATIO.
807 * If the driver doesn't support atomic mode-setting, enabling this capability
808 * will fail with -EOPNOTSUPP.
810 * This capability has been introduced in kernel version 4.0. Starting from
811 * kernel version 4.2, this capability is always supported for atomic-capable
812 * drivers.
814 #define DRM_CLIENT_CAP_ATOMIC 3
817 * DRM_CLIENT_CAP_ASPECT_RATIO
819 * If set to 1, the DRM core will provide aspect ratio information in modes.
820 * See ``DRM_MODE_FLAG_PIC_AR_*``.
822 * This capability is always supported for all drivers starting from kernel
823 * version 4.18.
825 #define DRM_CLIENT_CAP_ASPECT_RATIO 4
828 * DRM_CLIENT_CAP_WRITEBACK_CONNECTORS
830 * If set to 1, the DRM core will expose special connectors to be used for
831 * writing back to memory the scene setup in the commit. The client must enable
832 * &DRM_CLIENT_CAP_ATOMIC first.
834 * This capability is always supported for atomic-capable drivers starting from
835 * kernel version 4.19.
837 #define DRM_CLIENT_CAP_WRITEBACK_CONNECTORS 5
839 /* DRM_IOCTL_SET_CLIENT_CAP ioctl argument type */
840 struct drm_set_client_cap {
841 __u64 capability;
842 __u64 value;
845 #define DRM_RDWR O_RDWR
846 #define DRM_CLOEXEC O_CLOEXEC
847 struct drm_prime_handle {
848 __u32 handle;
850 /** Flags.. only applicable for handle->fd */
851 __u32 flags;
853 /** Returned dmabuf file descriptor */
854 __s32 fd;
857 struct drm_syncobj_create {
858 __u32 handle;
859 #define DRM_SYNCOBJ_CREATE_SIGNALED (1 << 0)
860 __u32 flags;
863 struct drm_syncobj_destroy {
864 __u32 handle;
865 __u32 pad;
868 #define DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_IMPORT_SYNC_FILE (1 << 0)
869 #define DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_EXPORT_SYNC_FILE (1 << 0)
870 struct drm_syncobj_handle {
871 __u32 handle;
872 __u32 flags;
874 __s32 fd;
875 __u32 pad;
878 struct drm_syncobj_transfer {
879 __u32 src_handle;
880 __u32 dst_handle;
881 __u64 src_point;
882 __u64 dst_point;
883 __u32 flags;
884 __u32 pad;
887 #define DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL (1 << 0)
888 #define DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT (1 << 1)
889 #define DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE (1 << 2) /* wait for time point to become available */
890 struct drm_syncobj_wait {
891 __u64 handles;
892 /* absolute timeout */
893 __s64 timeout_nsec;
894 __u32 count_handles;
895 __u32 flags;
896 __u32 first_signaled; /* only valid when not waiting all */
897 __u32 pad;
900 struct drm_syncobj_timeline_wait {
901 __u64 handles;
902 /* wait on specific timeline point for every handles*/
903 __u64 points;
904 /* absolute timeout */
905 __s64 timeout_nsec;
906 __u32 count_handles;
907 __u32 flags;
908 __u32 first_signaled; /* only valid when not waiting all */
909 __u32 pad;
913 * struct drm_syncobj_eventfd
914 * @handle: syncobj handle.
915 * @flags: Zero to wait for the point to be signalled, or
916 * &DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE to wait for a fence to be
917 * available for the point.
918 * @point: syncobj timeline point (set to zero for binary syncobjs).
919 * @fd: Existing eventfd to sent events to.
920 * @pad: Must be zero.
922 * Register an eventfd to be signalled by a syncobj. The eventfd counter will
923 * be incremented by one.
925 struct drm_syncobj_eventfd {
926 __u32 handle;
927 __u32 flags;
928 __u64 point;
929 __s32 fd;
930 __u32 pad;
934 struct drm_syncobj_array {
935 __u64 handles;
936 __u32 count_handles;
937 __u32 pad;
940 #define DRM_SYNCOBJ_QUERY_FLAGS_LAST_SUBMITTED (1 << 0) /* last available point on timeline syncobj */
941 struct drm_syncobj_timeline_array {
942 __u64 handles;
943 __u64 points;
944 __u32 count_handles;
945 __u32 flags;
949 /* Query current scanout sequence number */
950 struct drm_crtc_get_sequence {
951 __u32 crtc_id; /* requested crtc_id */
952 __u32 active; /* return: crtc output is active */
953 __u64 sequence; /* return: most recent vblank sequence */
954 __s64 sequence_ns; /* return: most recent time of first pixel out */
957 /* Queue event to be delivered at specified sequence. Time stamp marks
958 * when the first pixel of the refresh cycle leaves the display engine
959 * for the display
961 #define DRM_CRTC_SEQUENCE_RELATIVE 0x00000001 /* sequence is relative to current */
962 #define DRM_CRTC_SEQUENCE_NEXT_ON_MISS 0x00000002 /* Use next sequence if we've missed */
964 struct drm_crtc_queue_sequence {
965 __u32 crtc_id;
966 __u32 flags;
967 __u64 sequence; /* on input, target sequence. on output, actual sequence */
968 __u64 user_data; /* user data passed to event */
971 #if defined(__cplusplus)
973 #endif
975 #include "drm_mode.h"
977 #if defined(__cplusplus)
978 extern "C" {
979 #endif
981 #define DRM_IOCTL_BASE 'd'
982 #define DRM_IO(nr) _IO(DRM_IOCTL_BASE,nr)
983 #define DRM_IOR(nr,type) _IOR(DRM_IOCTL_BASE,nr,type)
984 #define DRM_IOW(nr,type) _IOW(DRM_IOCTL_BASE,nr,type)
985 #define DRM_IOWR(nr,type) _IOWR(DRM_IOCTL_BASE,nr,type)
987 #define DRM_IOCTL_VERSION DRM_IOWR(0x00, struct drm_version)
988 #define DRM_IOCTL_GET_UNIQUE DRM_IOWR(0x01, struct drm_unique)
989 #define DRM_IOCTL_GET_MAGIC DRM_IOR( 0x02, struct drm_auth)
990 #define DRM_IOCTL_IRQ_BUSID DRM_IOWR(0x03, struct drm_irq_busid)
991 #define DRM_IOCTL_GET_MAP DRM_IOWR(0x04, struct drm_map)
992 #define DRM_IOCTL_GET_CLIENT DRM_IOWR(0x05, struct drm_client)
993 #define DRM_IOCTL_GET_STATS DRM_IOR( 0x06, struct drm_stats)
994 #define DRM_IOCTL_SET_VERSION DRM_IOWR(0x07, struct drm_set_version)
995 #define DRM_IOCTL_MODESET_CTL DRM_IOW(0x08, struct drm_modeset_ctl)
997 * DRM_IOCTL_GEM_CLOSE - Close a GEM handle.
999 * GEM handles are not reference-counted by the kernel. User-space is
1000 * responsible for managing their lifetime. For example, if user-space imports
1001 * the same memory object twice on the same DRM file description, the same GEM
1002 * handle is returned by both imports, and user-space needs to ensure
1003 * &DRM_IOCTL_GEM_CLOSE is performed once only. The same situation can happen
1004 * when a memory object is allocated, then exported and imported again on the
1005 * same DRM file description. The &DRM_IOCTL_MODE_GETFB2 IOCTL is an exception
1006 * and always returns fresh new GEM handles even if an existing GEM handle
1007 * already refers to the same memory object before the IOCTL is performed.
1009 #define DRM_IOCTL_GEM_CLOSE DRM_IOW (0x09, struct drm_gem_close)
1010 #define DRM_IOCTL_GEM_FLINK DRM_IOWR(0x0a, struct drm_gem_flink)
1011 #define DRM_IOCTL_GEM_OPEN DRM_IOWR(0x0b, struct drm_gem_open)
1012 #define DRM_IOCTL_GET_CAP DRM_IOWR(0x0c, struct drm_get_cap)
1013 #define DRM_IOCTL_SET_CLIENT_CAP DRM_IOW( 0x0d, struct drm_set_client_cap)
1015 #define DRM_IOCTL_SET_UNIQUE DRM_IOW( 0x10, struct drm_unique)
1016 #define DRM_IOCTL_AUTH_MAGIC DRM_IOW( 0x11, struct drm_auth)
1017 #define DRM_IOCTL_BLOCK DRM_IOWR(0x12, struct drm_block)
1018 #define DRM_IOCTL_UNBLOCK DRM_IOWR(0x13, struct drm_block)
1019 #define DRM_IOCTL_CONTROL DRM_IOW( 0x14, struct drm_control)
1020 #define DRM_IOCTL_ADD_MAP DRM_IOWR(0x15, struct drm_map)
1021 #define DRM_IOCTL_ADD_BUFS DRM_IOWR(0x16, struct drm_buf_desc)
1022 #define DRM_IOCTL_MARK_BUFS DRM_IOW( 0x17, struct drm_buf_desc)
1023 #define DRM_IOCTL_INFO_BUFS DRM_IOWR(0x18, struct drm_buf_info)
1024 #define DRM_IOCTL_MAP_BUFS DRM_IOWR(0x19, struct drm_buf_map)
1025 #define DRM_IOCTL_FREE_BUFS DRM_IOW( 0x1a, struct drm_buf_free)
1027 #define DRM_IOCTL_RM_MAP DRM_IOW( 0x1b, struct drm_map)
1029 #define DRM_IOCTL_SET_SAREA_CTX DRM_IOW( 0x1c, struct drm_ctx_priv_map)
1030 #define DRM_IOCTL_GET_SAREA_CTX DRM_IOWR(0x1d, struct drm_ctx_priv_map)
1032 #define DRM_IOCTL_SET_MASTER DRM_IO(0x1e)
1033 #define DRM_IOCTL_DROP_MASTER DRM_IO(0x1f)
1035 #define DRM_IOCTL_ADD_CTX DRM_IOWR(0x20, struct drm_ctx)
1036 #define DRM_IOCTL_RM_CTX DRM_IOWR(0x21, struct drm_ctx)
1037 #define DRM_IOCTL_MOD_CTX DRM_IOW( 0x22, struct drm_ctx)
1038 #define DRM_IOCTL_GET_CTX DRM_IOWR(0x23, struct drm_ctx)
1039 #define DRM_IOCTL_SWITCH_CTX DRM_IOW( 0x24, struct drm_ctx)
1040 #define DRM_IOCTL_NEW_CTX DRM_IOW( 0x25, struct drm_ctx)
1041 #define DRM_IOCTL_RES_CTX DRM_IOWR(0x26, struct drm_ctx_res)
1042 #define DRM_IOCTL_ADD_DRAW DRM_IOWR(0x27, struct drm_draw)
1043 #define DRM_IOCTL_RM_DRAW DRM_IOWR(0x28, struct drm_draw)
1044 #define DRM_IOCTL_DMA DRM_IOWR(0x29, struct drm_dma)
1045 #define DRM_IOCTL_LOCK DRM_IOW( 0x2a, struct drm_lock)
1046 #define DRM_IOCTL_UNLOCK DRM_IOW( 0x2b, struct drm_lock)
1047 #define DRM_IOCTL_FINISH DRM_IOW( 0x2c, struct drm_lock)
1050 * DRM_IOCTL_PRIME_HANDLE_TO_FD - Convert a GEM handle to a DMA-BUF FD.
1052 * User-space sets &drm_prime_handle.handle with the GEM handle to export and
1053 * &drm_prime_handle.flags, and gets back a DMA-BUF file descriptor in
1054 * &drm_prime_handle.fd.
1056 * The export can fail for any driver-specific reason, e.g. because export is
1057 * not supported for this specific GEM handle (but might be for others).
1059 * Support for exporting DMA-BUFs is advertised via &DRM_PRIME_CAP_EXPORT.
1061 #define DRM_IOCTL_PRIME_HANDLE_TO_FD DRM_IOWR(0x2d, struct drm_prime_handle)
1063 * DRM_IOCTL_PRIME_FD_TO_HANDLE - Convert a DMA-BUF FD to a GEM handle.
1065 * User-space sets &drm_prime_handle.fd with a DMA-BUF file descriptor to
1066 * import, and gets back a GEM handle in &drm_prime_handle.handle.
1067 * &drm_prime_handle.flags is unused.
1069 * If an existing GEM handle refers to the memory object backing the DMA-BUF,
1070 * that GEM handle is returned. Therefore user-space which needs to handle
1071 * arbitrary DMA-BUFs must have a user-space lookup data structure to manually
1072 * reference-count duplicated GEM handles. For more information see
1073 * &DRM_IOCTL_GEM_CLOSE.
1075 * The import can fail for any driver-specific reason, e.g. because import is
1076 * only supported for DMA-BUFs allocated on this DRM device.
1078 * Support for importing DMA-BUFs is advertised via &DRM_PRIME_CAP_IMPORT.
1080 #define DRM_IOCTL_PRIME_FD_TO_HANDLE DRM_IOWR(0x2e, struct drm_prime_handle)
1082 #define DRM_IOCTL_AGP_ACQUIRE DRM_IO( 0x30)
1083 #define DRM_IOCTL_AGP_RELEASE DRM_IO( 0x31)
1084 #define DRM_IOCTL_AGP_ENABLE DRM_IOW( 0x32, struct drm_agp_mode)
1085 #define DRM_IOCTL_AGP_INFO DRM_IOR( 0x33, struct drm_agp_info)
1086 #define DRM_IOCTL_AGP_ALLOC DRM_IOWR(0x34, struct drm_agp_buffer)
1087 #define DRM_IOCTL_AGP_FREE DRM_IOW( 0x35, struct drm_agp_buffer)
1088 #define DRM_IOCTL_AGP_BIND DRM_IOW( 0x36, struct drm_agp_binding)
1089 #define DRM_IOCTL_AGP_UNBIND DRM_IOW( 0x37, struct drm_agp_binding)
1091 #define DRM_IOCTL_SG_ALLOC DRM_IOWR(0x38, struct drm_scatter_gather)
1092 #define DRM_IOCTL_SG_FREE DRM_IOW( 0x39, struct drm_scatter_gather)
1094 #define DRM_IOCTL_WAIT_VBLANK DRM_IOWR(0x3a, union drm_wait_vblank)
1096 #define DRM_IOCTL_CRTC_GET_SEQUENCE DRM_IOWR(0x3b, struct drm_crtc_get_sequence)
1097 #define DRM_IOCTL_CRTC_QUEUE_SEQUENCE DRM_IOWR(0x3c, struct drm_crtc_queue_sequence)
1099 #define DRM_IOCTL_UPDATE_DRAW DRM_IOW(0x3f, struct drm_update_draw)
1101 #define DRM_IOCTL_MODE_GETRESOURCES DRM_IOWR(0xA0, struct drm_mode_card_res)
1102 #define DRM_IOCTL_MODE_GETCRTC DRM_IOWR(0xA1, struct drm_mode_crtc)
1103 #define DRM_IOCTL_MODE_SETCRTC DRM_IOWR(0xA2, struct drm_mode_crtc)
1104 #define DRM_IOCTL_MODE_CURSOR DRM_IOWR(0xA3, struct drm_mode_cursor)
1105 #define DRM_IOCTL_MODE_GETGAMMA DRM_IOWR(0xA4, struct drm_mode_crtc_lut)
1106 #define DRM_IOCTL_MODE_SETGAMMA DRM_IOWR(0xA5, struct drm_mode_crtc_lut)
1107 #define DRM_IOCTL_MODE_GETENCODER DRM_IOWR(0xA6, struct drm_mode_get_encoder)
1108 #define DRM_IOCTL_MODE_GETCONNECTOR DRM_IOWR(0xA7, struct drm_mode_get_connector)
1109 #define DRM_IOCTL_MODE_ATTACHMODE DRM_IOWR(0xA8, struct drm_mode_mode_cmd) /* deprecated (never worked) */
1110 #define DRM_IOCTL_MODE_DETACHMODE DRM_IOWR(0xA9, struct drm_mode_mode_cmd) /* deprecated (never worked) */
1112 #define DRM_IOCTL_MODE_GETPROPERTY DRM_IOWR(0xAA, struct drm_mode_get_property)
1113 #define DRM_IOCTL_MODE_SETPROPERTY DRM_IOWR(0xAB, struct drm_mode_connector_set_property)
1114 #define DRM_IOCTL_MODE_GETPROPBLOB DRM_IOWR(0xAC, struct drm_mode_get_blob)
1115 #define DRM_IOCTL_MODE_GETFB DRM_IOWR(0xAD, struct drm_mode_fb_cmd)
1116 #define DRM_IOCTL_MODE_ADDFB DRM_IOWR(0xAE, struct drm_mode_fb_cmd)
1118 * DRM_IOCTL_MODE_RMFB - Remove a framebuffer.
1120 * This removes a framebuffer previously added via ADDFB/ADDFB2. The IOCTL
1121 * argument is a framebuffer object ID.
1123 * Warning: removing a framebuffer currently in-use on an enabled plane will
1124 * disable that plane. The CRTC the plane is linked to may also be disabled
1125 * (depending on driver capabilities).
1127 #define DRM_IOCTL_MODE_RMFB DRM_IOWR(0xAF, unsigned int)
1128 #define DRM_IOCTL_MODE_PAGE_FLIP DRM_IOWR(0xB0, struct drm_mode_crtc_page_flip)
1129 #define DRM_IOCTL_MODE_DIRTYFB DRM_IOWR(0xB1, struct drm_mode_fb_dirty_cmd)
1131 #define DRM_IOCTL_MODE_CREATE_DUMB DRM_IOWR(0xB2, struct drm_mode_create_dumb)
1132 #define DRM_IOCTL_MODE_MAP_DUMB DRM_IOWR(0xB3, struct drm_mode_map_dumb)
1133 #define DRM_IOCTL_MODE_DESTROY_DUMB DRM_IOWR(0xB4, struct drm_mode_destroy_dumb)
1134 #define DRM_IOCTL_MODE_GETPLANERESOURCES DRM_IOWR(0xB5, struct drm_mode_get_plane_res)
1135 #define DRM_IOCTL_MODE_GETPLANE DRM_IOWR(0xB6, struct drm_mode_get_plane)
1136 #define DRM_IOCTL_MODE_SETPLANE DRM_IOWR(0xB7, struct drm_mode_set_plane)
1137 #define DRM_IOCTL_MODE_ADDFB2 DRM_IOWR(0xB8, struct drm_mode_fb_cmd2)
1138 #define DRM_IOCTL_MODE_OBJ_GETPROPERTIES DRM_IOWR(0xB9, struct drm_mode_obj_get_properties)
1139 #define DRM_IOCTL_MODE_OBJ_SETPROPERTY DRM_IOWR(0xBA, struct drm_mode_obj_set_property)
1140 #define DRM_IOCTL_MODE_CURSOR2 DRM_IOWR(0xBB, struct drm_mode_cursor2)
1141 #define DRM_IOCTL_MODE_ATOMIC DRM_IOWR(0xBC, struct drm_mode_atomic)
1142 #define DRM_IOCTL_MODE_CREATEPROPBLOB DRM_IOWR(0xBD, struct drm_mode_create_blob)
1143 #define DRM_IOCTL_MODE_DESTROYPROPBLOB DRM_IOWR(0xBE, struct drm_mode_destroy_blob)
1145 #define DRM_IOCTL_SYNCOBJ_CREATE DRM_IOWR(0xBF, struct drm_syncobj_create)
1146 #define DRM_IOCTL_SYNCOBJ_DESTROY DRM_IOWR(0xC0, struct drm_syncobj_destroy)
1147 #define DRM_IOCTL_SYNCOBJ_HANDLE_TO_FD DRM_IOWR(0xC1, struct drm_syncobj_handle)
1148 #define DRM_IOCTL_SYNCOBJ_FD_TO_HANDLE DRM_IOWR(0xC2, struct drm_syncobj_handle)
1149 #define DRM_IOCTL_SYNCOBJ_WAIT DRM_IOWR(0xC3, struct drm_syncobj_wait)
1150 #define DRM_IOCTL_SYNCOBJ_RESET DRM_IOWR(0xC4, struct drm_syncobj_array)
1151 #define DRM_IOCTL_SYNCOBJ_SIGNAL DRM_IOWR(0xC5, struct drm_syncobj_array)
1153 #define DRM_IOCTL_MODE_CREATE_LEASE DRM_IOWR(0xC6, struct drm_mode_create_lease)
1154 #define DRM_IOCTL_MODE_LIST_LESSEES DRM_IOWR(0xC7, struct drm_mode_list_lessees)
1155 #define DRM_IOCTL_MODE_GET_LEASE DRM_IOWR(0xC8, struct drm_mode_get_lease)
1156 #define DRM_IOCTL_MODE_REVOKE_LEASE DRM_IOWR(0xC9, struct drm_mode_revoke_lease)
1158 #define DRM_IOCTL_SYNCOBJ_TIMELINE_WAIT DRM_IOWR(0xCA, struct drm_syncobj_timeline_wait)
1159 #define DRM_IOCTL_SYNCOBJ_QUERY DRM_IOWR(0xCB, struct drm_syncobj_timeline_array)
1160 #define DRM_IOCTL_SYNCOBJ_TRANSFER DRM_IOWR(0xCC, struct drm_syncobj_transfer)
1161 #define DRM_IOCTL_SYNCOBJ_TIMELINE_SIGNAL DRM_IOWR(0xCD, struct drm_syncobj_timeline_array)
1164 * DRM_IOCTL_MODE_GETFB2 - Get framebuffer metadata.
1166 * This queries metadata about a framebuffer. User-space fills
1167 * &drm_mode_fb_cmd2.fb_id as the input, and the kernels fills the rest of the
1168 * struct as the output.
1170 * If the client is DRM master or has &CAP_SYS_ADMIN, &drm_mode_fb_cmd2.handles
1171 * will be filled with GEM buffer handles. Fresh new GEM handles are always
1172 * returned, even if another GEM handle referring to the same memory object
1173 * already exists on the DRM file description. The caller is responsible for
1174 * removing the new handles, e.g. via the &DRM_IOCTL_GEM_CLOSE IOCTL. The same
1175 * new handle will be returned for multiple planes in case they use the same
1176 * memory object. Planes are valid until one has a zero handle -- this can be
1177 * used to compute the number of planes.
1179 * Otherwise, &drm_mode_fb_cmd2.handles will be zeroed and planes are valid
1180 * until one has a zero &drm_mode_fb_cmd2.pitches.
1182 * If the framebuffer has a format modifier, &DRM_MODE_FB_MODIFIERS will be set
1183 * in &drm_mode_fb_cmd2.flags and &drm_mode_fb_cmd2.modifier will contain the
1184 * modifier. Otherwise, user-space must ignore &drm_mode_fb_cmd2.modifier.
1186 * To obtain DMA-BUF FDs for each plane without leaking GEM handles, user-space
1187 * can export each handle via &DRM_IOCTL_PRIME_HANDLE_TO_FD, then immediately
1188 * close each unique handle via &DRM_IOCTL_GEM_CLOSE, making sure to not
1189 * double-close handles which are specified multiple times in the array.
1191 #define DRM_IOCTL_MODE_GETFB2 DRM_IOWR(0xCE, struct drm_mode_fb_cmd2)
1193 #define DRM_IOCTL_SYNCOBJ_EVENTFD DRM_IOWR(0xCF, struct drm_syncobj_eventfd)
1196 * Device specific ioctls should only be in their respective headers
1197 * The device specific ioctl range is from 0x40 to 0x9f.
1198 * Generic IOCTLS restart at 0xA0.
1200 * \sa drmCommandNone(), drmCommandRead(), drmCommandWrite(), and
1201 * drmCommandReadWrite().
1203 #define DRM_COMMAND_BASE 0x40
1204 #define DRM_COMMAND_END 0xA0
1207 * struct drm_event - Header for DRM events
1208 * @type: event type.
1209 * @length: total number of payload bytes (including header).
1211 * This struct is a header for events written back to user-space on the DRM FD.
1212 * A read on the DRM FD will always only return complete events: e.g. if the
1213 * read buffer is 100 bytes large and there are two 64 byte events pending,
1214 * only one will be returned.
1216 * Event types 0 - 0x7fffffff are generic DRM events, 0x80000000 and
1217 * up are chipset specific. Generic DRM events include &DRM_EVENT_VBLANK,
1218 * &DRM_EVENT_FLIP_COMPLETE and &DRM_EVENT_CRTC_SEQUENCE.
1220 struct drm_event {
1221 __u32 type;
1222 __u32 length;
1226 * DRM_EVENT_VBLANK - vertical blanking event
1228 * This event is sent in response to &DRM_IOCTL_WAIT_VBLANK with the
1229 * &_DRM_VBLANK_EVENT flag set.
1231 * The event payload is a struct drm_event_vblank.
1233 #define DRM_EVENT_VBLANK 0x01
1235 * DRM_EVENT_FLIP_COMPLETE - page-flip completion event
1237 * This event is sent in response to an atomic commit or legacy page-flip with
1238 * the &DRM_MODE_PAGE_FLIP_EVENT flag set.
1240 * The event payload is a struct drm_event_vblank.
1242 #define DRM_EVENT_FLIP_COMPLETE 0x02
1244 * DRM_EVENT_CRTC_SEQUENCE - CRTC sequence event
1246 * This event is sent in response to &DRM_IOCTL_CRTC_QUEUE_SEQUENCE.
1248 * The event payload is a struct drm_event_crtc_sequence.
1250 #define DRM_EVENT_CRTC_SEQUENCE 0x03
1252 struct drm_event_vblank {
1253 struct drm_event base;
1254 __u64 user_data;
1255 __u32 tv_sec;
1256 __u32 tv_usec;
1257 __u32 sequence;
1258 __u32 crtc_id; /* 0 on older kernels that do not support this */
1261 /* Event delivered at sequence. Time stamp marks when the first pixel
1262 * of the refresh cycle leaves the display engine for the display
1264 struct drm_event_crtc_sequence {
1265 struct drm_event base;
1266 __u64 user_data;
1267 __s64 time_ns;
1268 __u64 sequence;
1271 /* typedef area */
1272 typedef struct drm_clip_rect drm_clip_rect_t;
1273 typedef struct drm_drawable_info drm_drawable_info_t;
1274 typedef struct drm_tex_region drm_tex_region_t;
1275 typedef struct drm_hw_lock drm_hw_lock_t;
1276 typedef struct drm_version drm_version_t;
1277 typedef struct drm_unique drm_unique_t;
1278 typedef struct drm_list drm_list_t;
1279 typedef struct drm_block drm_block_t;
1280 typedef struct drm_control drm_control_t;
1281 typedef enum drm_map_type drm_map_type_t;
1282 typedef enum drm_map_flags drm_map_flags_t;
1283 typedef struct drm_ctx_priv_map drm_ctx_priv_map_t;
1284 typedef struct drm_map drm_map_t;
1285 typedef struct drm_client drm_client_t;
1286 typedef enum drm_stat_type drm_stat_type_t;
1287 typedef struct drm_stats drm_stats_t;
1288 typedef enum drm_lock_flags drm_lock_flags_t;
1289 typedef struct drm_lock drm_lock_t;
1290 typedef enum drm_dma_flags drm_dma_flags_t;
1291 typedef struct drm_buf_desc drm_buf_desc_t;
1292 typedef struct drm_buf_info drm_buf_info_t;
1293 typedef struct drm_buf_free drm_buf_free_t;
1294 typedef struct drm_buf_pub drm_buf_pub_t;
1295 typedef struct drm_buf_map drm_buf_map_t;
1296 typedef struct drm_dma drm_dma_t;
1297 typedef union drm_wait_vblank drm_wait_vblank_t;
1298 typedef struct drm_agp_mode drm_agp_mode_t;
1299 typedef enum drm_ctx_flags drm_ctx_flags_t;
1300 typedef struct drm_ctx drm_ctx_t;
1301 typedef struct drm_ctx_res drm_ctx_res_t;
1302 typedef struct drm_draw drm_draw_t;
1303 typedef struct drm_update_draw drm_update_draw_t;
1304 typedef struct drm_auth drm_auth_t;
1305 typedef struct drm_irq_busid drm_irq_busid_t;
1306 typedef enum drm_vblank_seq_type drm_vblank_seq_type_t;
1308 typedef struct drm_agp_buffer drm_agp_buffer_t;
1309 typedef struct drm_agp_binding drm_agp_binding_t;
1310 typedef struct drm_agp_info drm_agp_info_t;
1311 typedef struct drm_scatter_gather drm_scatter_gather_t;
1312 typedef struct drm_set_version drm_set_version_t;
1314 #if defined(__cplusplus)
1316 #endif
1318 #endif