Back to home page

EIC code displayed by LXR

 
 

    


File indexing completed on 2025-01-18 10:01:49

0001 /*
0002  * Header for the Direct Rendering Manager
0003  *
0004  * Author: Rickard E. (Rik) Faith <faith@valinux.com>
0005  *
0006  * Acknowledgments:
0007  * Dec 1999, Richard Henderson <rth@twiddle.net>, move to generic cmpxchg.
0008  */
0009 
0010 /*
0011  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
0012  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
0013  * All rights reserved.
0014  *
0015  * Permission is hereby granted, free of charge, to any person obtaining a
0016  * copy of this software and associated documentation files (the "Software"),
0017  * to deal in the Software without restriction, including without limitation
0018  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
0019  * and/or sell copies of the Software, and to permit persons to whom the
0020  * Software is furnished to do so, subject to the following conditions:
0021  *
0022  * The above copyright notice and this permission notice (including the next
0023  * paragraph) shall be included in all copies or substantial portions of the
0024  * Software.
0025  *
0026  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
0027  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
0028  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
0029  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
0030  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
0031  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
0032  * OTHER DEALINGS IN THE SOFTWARE.
0033  */
0034 
0035 #ifndef _DRM_H_
0036 #define _DRM_H_
0037 
0038 #if   defined(__linux__)
0039 
0040 #include <linux/types.h>
0041 #include <asm/ioctl.h>
0042 typedef unsigned int drm_handle_t;
0043 
0044 #else /* One of the BSDs */
0045 
0046 #include <stdint.h>
0047 #include <sys/ioccom.h>
0048 #include <sys/types.h>
0049 typedef int8_t   __s8;
0050 typedef uint8_t  __u8;
0051 typedef int16_t  __s16;
0052 typedef uint16_t __u16;
0053 typedef int32_t  __s32;
0054 typedef uint32_t __u32;
0055 typedef int64_t  __s64;
0056 typedef uint64_t __u64;
0057 typedef size_t   __kernel_size_t;
0058 typedef unsigned long drm_handle_t;
0059 
0060 #endif
0061 
0062 #if defined(__cplusplus)
0063 extern "C" {
0064 #endif
0065 
0066 #define DRM_NAME    "drm"     /**< Name in kernel, /dev, and /proc */
0067 #define DRM_MIN_ORDER   5     /**< At least 2^5 bytes = 32 bytes */
0068 #define DRM_MAX_ORDER   22    /**< Up to 2^22 bytes = 4MB */
0069 #define DRM_RAM_PERCENT 10    /**< How much system ram can we lock? */
0070 
0071 #define _DRM_LOCK_HELD  0x80000000U /**< Hardware lock is held */
0072 #define _DRM_LOCK_CONT  0x40000000U /**< Hardware lock is contended */
0073 #define _DRM_LOCK_IS_HELD(lock)    ((lock) & _DRM_LOCK_HELD)
0074 #define _DRM_LOCK_IS_CONT(lock)    ((lock) & _DRM_LOCK_CONT)
0075 #define _DRM_LOCKING_CONTEXT(lock) ((lock) & ~(_DRM_LOCK_HELD|_DRM_LOCK_CONT))
0076 
0077 typedef unsigned int drm_context_t;
0078 typedef unsigned int drm_drawable_t;
0079 typedef unsigned int drm_magic_t;
0080 
0081 /*
0082  * Cliprect.
0083  *
0084  * \warning: If you change this structure, make sure you change
0085  * XF86DRIClipRectRec in the server as well
0086  *
0087  * \note KW: Actually it's illegal to change either for
0088  * backwards-compatibility reasons.
0089  */
0090 struct drm_clip_rect {
0091     unsigned short x1;
0092     unsigned short y1;
0093     unsigned short x2;
0094     unsigned short y2;
0095 };
0096 
0097 /*
0098  * Drawable information.
0099  */
0100 struct drm_drawable_info {
0101     unsigned int num_rects;
0102     struct drm_clip_rect *rects;
0103 };
0104 
0105 /*
0106  * Texture region,
0107  */
0108 struct drm_tex_region {
0109     unsigned char next;
0110     unsigned char prev;
0111     unsigned char in_use;
0112     unsigned char padding;
0113     unsigned int age;
0114 };
0115 
0116 /*
0117  * Hardware lock.
0118  *
0119  * The lock structure is a simple cache-line aligned integer.  To avoid
0120  * processor bus contention on a multiprocessor system, there should not be any
0121  * other data stored in the same cache line.
0122  */
0123 struct drm_hw_lock {
0124     __volatile__ unsigned int lock;     /**< lock variable */
0125     char padding[60];           /**< Pad to cache line */
0126 };
0127 
0128 /*
0129  * DRM_IOCTL_VERSION ioctl argument type.
0130  *
0131  * \sa drmGetVersion().
0132  */
0133 struct drm_version {
0134     int version_major;    /**< Major version */
0135     int version_minor;    /**< Minor version */
0136     int version_patchlevel;   /**< Patch level */
0137     __kernel_size_t name_len;     /**< Length of name buffer */
0138     char *name;   /**< Name of driver */
0139     __kernel_size_t date_len;     /**< Length of date buffer */
0140     char *date;   /**< User-space buffer to hold date */
0141     __kernel_size_t desc_len;     /**< Length of desc buffer */
0142     char *desc;   /**< User-space buffer to hold desc */
0143 };
0144 
0145 /*
0146  * DRM_IOCTL_GET_UNIQUE ioctl argument type.
0147  *
0148  * \sa drmGetBusid() and drmSetBusId().
0149  */
0150 struct drm_unique {
0151     __kernel_size_t unique_len;   /**< Length of unique */
0152     char *unique;     /**< Unique name for driver instantiation */
0153 };
0154 
0155 struct drm_list {
0156     int count;        /**< Length of user-space structures */
0157     struct drm_version *version;
0158 };
0159 
0160 struct drm_block {
0161     int unused;
0162 };
0163 
0164 /*
0165  * DRM_IOCTL_CONTROL ioctl argument type.
0166  *
0167  * \sa drmCtlInstHandler() and drmCtlUninstHandler().
0168  */
0169 struct drm_control {
0170     enum {
0171         DRM_ADD_COMMAND,
0172         DRM_RM_COMMAND,
0173         DRM_INST_HANDLER,
0174         DRM_UNINST_HANDLER
0175     } func;
0176     int irq;
0177 };
0178 
0179 /*
0180  * Type of memory to map.
0181  */
0182 enum drm_map_type {
0183     _DRM_FRAME_BUFFER = 0,    /**< WC (no caching), no core dump */
0184     _DRM_REGISTERS = 1,   /**< no caching, no core dump */
0185     _DRM_SHM = 2,         /**< shared, cached */
0186     _DRM_AGP = 3,         /**< AGP/GART */
0187     _DRM_SCATTER_GATHER = 4,  /**< Scatter/gather memory for PCI DMA */
0188     _DRM_CONSISTENT = 5   /**< Consistent memory for PCI DMA */
0189 };
0190 
0191 /*
0192  * Memory mapping flags.
0193  */
0194 enum drm_map_flags {
0195     _DRM_RESTRICTED = 0x01,      /**< Cannot be mapped to user-virtual */
0196     _DRM_READ_ONLY = 0x02,
0197     _DRM_LOCKED = 0x04,      /**< shared, cached, locked */
0198     _DRM_KERNEL = 0x08,      /**< kernel requires access */
0199     _DRM_WRITE_COMBINING = 0x10, /**< use write-combining if available */
0200     _DRM_CONTAINS_LOCK = 0x20,   /**< SHM page that contains lock */
0201     _DRM_REMOVABLE = 0x40,       /**< Removable mapping */
0202     _DRM_DRIVER = 0x80       /**< Managed by driver */
0203 };
0204 
0205 struct drm_ctx_priv_map {
0206     unsigned int ctx_id;     /**< Context requesting private mapping */
0207     void *handle;        /**< Handle of map */
0208 };
0209 
0210 /*
0211  * DRM_IOCTL_GET_MAP, DRM_IOCTL_ADD_MAP and DRM_IOCTL_RM_MAP ioctls
0212  * argument type.
0213  *
0214  * \sa drmAddMap().
0215  */
0216 struct drm_map {
0217     unsigned long offset;    /**< Requested physical address (0 for SAREA)*/
0218     unsigned long size;  /**< Requested physical size (bytes) */
0219     enum drm_map_type type;  /**< Type of memory to map */
0220     enum drm_map_flags flags;    /**< Flags */
0221     void *handle;        /**< User-space: "Handle" to pass to mmap() */
0222                  /**< Kernel-space: kernel-virtual address */
0223     int mtrr;        /**< MTRR slot used */
0224     /*   Private data */
0225 };
0226 
0227 /*
0228  * DRM_IOCTL_GET_CLIENT ioctl argument type.
0229  */
0230 struct drm_client {
0231     int idx;        /**< Which client desired? */
0232     int auth;       /**< Is client authenticated? */
0233     unsigned long pid;  /**< Process ID */
0234     unsigned long uid;  /**< User ID */
0235     unsigned long magic;    /**< Magic */
0236     unsigned long iocs; /**< Ioctl count */
0237 };
0238 
0239 enum drm_stat_type {
0240     _DRM_STAT_LOCK,
0241     _DRM_STAT_OPENS,
0242     _DRM_STAT_CLOSES,
0243     _DRM_STAT_IOCTLS,
0244     _DRM_STAT_LOCKS,
0245     _DRM_STAT_UNLOCKS,
0246     _DRM_STAT_VALUE,    /**< Generic value */
0247     _DRM_STAT_BYTE,     /**< Generic byte counter (1024bytes/K) */
0248     _DRM_STAT_COUNT,    /**< Generic non-byte counter (1000/k) */
0249 
0250     _DRM_STAT_IRQ,      /**< IRQ */
0251     _DRM_STAT_PRIMARY,  /**< Primary DMA bytes */
0252     _DRM_STAT_SECONDARY,    /**< Secondary DMA bytes */
0253     _DRM_STAT_DMA,      /**< DMA */
0254     _DRM_STAT_SPECIAL,  /**< Special DMA (e.g., priority or polled) */
0255     _DRM_STAT_MISSED    /**< Missed DMA opportunity */
0256         /* Add to the *END* of the list */
0257 };
0258 
0259 /*
0260  * DRM_IOCTL_GET_STATS ioctl argument type.
0261  */
0262 struct drm_stats {
0263     unsigned long count;
0264     struct {
0265         unsigned long value;
0266         enum drm_stat_type type;
0267     } data[15];
0268 };
0269 
0270 /*
0271  * Hardware locking flags.
0272  */
0273 enum drm_lock_flags {
0274     _DRM_LOCK_READY = 0x01,      /**< Wait until hardware is ready for DMA */
0275     _DRM_LOCK_QUIESCENT = 0x02,  /**< Wait until hardware quiescent */
0276     _DRM_LOCK_FLUSH = 0x04,      /**< Flush this context's DMA queue first */
0277     _DRM_LOCK_FLUSH_ALL = 0x08,  /**< Flush all DMA queues first */
0278     /* These *HALT* flags aren't supported yet
0279        -- they will be used to support the
0280        full-screen DGA-like mode. */
0281     _DRM_HALT_ALL_QUEUES = 0x10, /**< Halt all current and future queues */
0282     _DRM_HALT_CUR_QUEUES = 0x20  /**< Halt all current queues */
0283 };
0284 
0285 /*
0286  * DRM_IOCTL_LOCK, DRM_IOCTL_UNLOCK and DRM_IOCTL_FINISH ioctl argument type.
0287  *
0288  * \sa drmGetLock() and drmUnlock().
0289  */
0290 struct drm_lock {
0291     int context;
0292     enum drm_lock_flags flags;
0293 };
0294 
0295 /*
0296  * DMA flags
0297  *
0298  * \warning
0299  * These values \e must match xf86drm.h.
0300  *
0301  * \sa drm_dma.
0302  */
0303 enum drm_dma_flags {
0304     /* Flags for DMA buffer dispatch */
0305     _DRM_DMA_BLOCK = 0x01,        /**<
0306                        * Block until buffer dispatched.
0307                        *
0308                        * \note The buffer may not yet have
0309                        * been processed by the hardware --
0310                        * getting a hardware lock with the
0311                        * hardware quiescent will ensure
0312                        * that the buffer has been
0313                        * processed.
0314                        */
0315     _DRM_DMA_WHILE_LOCKED = 0x02, /**< Dispatch while lock held */
0316     _DRM_DMA_PRIORITY = 0x04,     /**< High priority dispatch */
0317 
0318     /* Flags for DMA buffer request */
0319     _DRM_DMA_WAIT = 0x10,         /**< Wait for free buffers */
0320     _DRM_DMA_SMALLER_OK = 0x20,   /**< Smaller-than-requested buffers OK */
0321     _DRM_DMA_LARGER_OK = 0x40     /**< Larger-than-requested buffers OK */
0322 };
0323 
0324 /*
0325  * DRM_IOCTL_ADD_BUFS and DRM_IOCTL_MARK_BUFS ioctl argument type.
0326  *
0327  * \sa drmAddBufs().
0328  */
0329 struct drm_buf_desc {
0330     int count;       /**< Number of buffers of this size */
0331     int size;        /**< Size in bytes */
0332     int low_mark;        /**< Low water mark */
0333     int high_mark;       /**< High water mark */
0334     enum {
0335         _DRM_PAGE_ALIGN = 0x01, /**< Align on page boundaries for DMA */
0336         _DRM_AGP_BUFFER = 0x02, /**< Buffer is in AGP space */
0337         _DRM_SG_BUFFER = 0x04,  /**< Scatter/gather memory buffer */
0338         _DRM_FB_BUFFER = 0x08,  /**< Buffer is in frame buffer */
0339         _DRM_PCI_BUFFER_RO = 0x10 /**< Map PCI DMA buffer read-only */
0340     } flags;
0341     unsigned long agp_start; /**<
0342                   * Start address of where the AGP buffers are
0343                   * in the AGP aperture
0344                   */
0345 };
0346 
0347 /*
0348  * DRM_IOCTL_INFO_BUFS ioctl argument type.
0349  */
0350 struct drm_buf_info {
0351     int count;      /**< Entries in list */
0352     struct drm_buf_desc *list;
0353 };
0354 
0355 /*
0356  * DRM_IOCTL_FREE_BUFS ioctl argument type.
0357  */
0358 struct drm_buf_free {
0359     int count;
0360     int *list;
0361 };
0362 
0363 /*
0364  * Buffer information
0365  *
0366  * \sa drm_buf_map.
0367  */
0368 struct drm_buf_pub {
0369     int idx;               /**< Index into the master buffer list */
0370     int total;             /**< Buffer size */
0371     int used;              /**< Amount of buffer in use (for DMA) */
0372     void *address;         /**< Address of buffer */
0373 };
0374 
0375 /*
0376  * DRM_IOCTL_MAP_BUFS ioctl argument type.
0377  */
0378 struct drm_buf_map {
0379     int count;      /**< Length of the buffer list */
0380 #ifdef __cplusplus
0381     void *virt;
0382 #else
0383     void *virtual;      /**< Mmap'd area in user-virtual */
0384 #endif
0385     struct drm_buf_pub *list;   /**< Buffer information */
0386 };
0387 
0388 /*
0389  * DRM_IOCTL_DMA ioctl argument type.
0390  *
0391  * Indices here refer to the offset into the buffer list in drm_buf_get.
0392  *
0393  * \sa drmDMA().
0394  */
0395 struct drm_dma {
0396     int context;              /**< Context handle */
0397     int send_count;           /**< Number of buffers to send */
0398     int *send_indices;    /**< List of handles to buffers */
0399     int *send_sizes;          /**< Lengths of data to send */
0400     enum drm_dma_flags flags;     /**< Flags */
0401     int request_count;        /**< Number of buffers requested */
0402     int request_size;         /**< Desired size for buffers */
0403     int *request_indices;     /**< Buffer information */
0404     int *request_sizes;
0405     int granted_count;        /**< Number of buffers granted */
0406 };
0407 
0408 enum drm_ctx_flags {
0409     _DRM_CONTEXT_PRESERVED = 0x01,
0410     _DRM_CONTEXT_2DONLY = 0x02
0411 };
0412 
0413 /*
0414  * DRM_IOCTL_ADD_CTX ioctl argument type.
0415  *
0416  * \sa drmCreateContext() and drmDestroyContext().
0417  */
0418 struct drm_ctx {
0419     drm_context_t handle;
0420     enum drm_ctx_flags flags;
0421 };
0422 
0423 /*
0424  * DRM_IOCTL_RES_CTX ioctl argument type.
0425  */
0426 struct drm_ctx_res {
0427     int count;
0428     struct drm_ctx *contexts;
0429 };
0430 
0431 /*
0432  * DRM_IOCTL_ADD_DRAW and DRM_IOCTL_RM_DRAW ioctl argument type.
0433  */
0434 struct drm_draw {
0435     drm_drawable_t handle;
0436 };
0437 
0438 /*
0439  * DRM_IOCTL_UPDATE_DRAW ioctl argument type.
0440  */
0441 typedef enum {
0442     DRM_DRAWABLE_CLIPRECTS
0443 } drm_drawable_info_type_t;
0444 
0445 struct drm_update_draw {
0446     drm_drawable_t handle;
0447     unsigned int type;
0448     unsigned int num;
0449     unsigned long long data;
0450 };
0451 
0452 /*
0453  * DRM_IOCTL_GET_MAGIC and DRM_IOCTL_AUTH_MAGIC ioctl argument type.
0454  */
0455 struct drm_auth {
0456     drm_magic_t magic;
0457 };
0458 
0459 /*
0460  * DRM_IOCTL_IRQ_BUSID ioctl argument type.
0461  *
0462  * \sa drmGetInterruptFromBusID().
0463  */
0464 struct drm_irq_busid {
0465     int irq;    /**< IRQ number */
0466     int busnum; /**< bus number */
0467     int devnum; /**< device number */
0468     int funcnum;    /**< function number */
0469 };
0470 
0471 enum drm_vblank_seq_type {
0472     _DRM_VBLANK_ABSOLUTE = 0x0, /**< Wait for specific vblank sequence number */
0473     _DRM_VBLANK_RELATIVE = 0x1, /**< Wait for given number of vblanks */
0474     /* bits 1-6 are reserved for high crtcs */
0475     _DRM_VBLANK_HIGH_CRTC_MASK = 0x0000003e,
0476     _DRM_VBLANK_EVENT = 0x4000000,   /**< Send event instead of blocking */
0477     _DRM_VBLANK_FLIP = 0x8000000,   /**< Scheduled buffer swap should flip */
0478     _DRM_VBLANK_NEXTONMISS = 0x10000000,    /**< If missed, wait for next vblank */
0479     _DRM_VBLANK_SECONDARY = 0x20000000, /**< Secondary display controller */
0480     _DRM_VBLANK_SIGNAL = 0x40000000 /**< Send signal instead of blocking, unsupported */
0481 };
0482 #define _DRM_VBLANK_HIGH_CRTC_SHIFT 1
0483 
0484 #define _DRM_VBLANK_TYPES_MASK (_DRM_VBLANK_ABSOLUTE | _DRM_VBLANK_RELATIVE)
0485 #define _DRM_VBLANK_FLAGS_MASK (_DRM_VBLANK_EVENT | _DRM_VBLANK_SIGNAL | \
0486                 _DRM_VBLANK_SECONDARY | _DRM_VBLANK_NEXTONMISS)
0487 
0488 struct drm_wait_vblank_request {
0489     enum drm_vblank_seq_type type;
0490     unsigned int sequence;
0491     unsigned long signal;
0492 };
0493 
0494 struct drm_wait_vblank_reply {
0495     enum drm_vblank_seq_type type;
0496     unsigned int sequence;
0497     long tval_sec;
0498     long tval_usec;
0499 };
0500 
0501 /*
0502  * DRM_IOCTL_WAIT_VBLANK ioctl argument type.
0503  *
0504  * \sa drmWaitVBlank().
0505  */
0506 union drm_wait_vblank {
0507     struct drm_wait_vblank_request request;
0508     struct drm_wait_vblank_reply reply;
0509 };
0510 
0511 #define _DRM_PRE_MODESET 1
0512 #define _DRM_POST_MODESET 2
0513 
0514 /*
0515  * DRM_IOCTL_MODESET_CTL ioctl argument type
0516  *
0517  * \sa drmModesetCtl().
0518  */
0519 struct drm_modeset_ctl {
0520     __u32 crtc;
0521     __u32 cmd;
0522 };
0523 
0524 /*
0525  * DRM_IOCTL_AGP_ENABLE ioctl argument type.
0526  *
0527  * \sa drmAgpEnable().
0528  */
0529 struct drm_agp_mode {
0530     unsigned long mode; /**< AGP mode */
0531 };
0532 
0533 /*
0534  * DRM_IOCTL_AGP_ALLOC and DRM_IOCTL_AGP_FREE ioctls argument type.
0535  *
0536  * \sa drmAgpAlloc() and drmAgpFree().
0537  */
0538 struct drm_agp_buffer {
0539     unsigned long size; /**< In bytes -- will round to page boundary */
0540     unsigned long handle;   /**< Used for binding / unbinding */
0541     unsigned long type; /**< Type of memory to allocate */
0542     unsigned long physical; /**< Physical used by i810 */
0543 };
0544 
0545 /*
0546  * DRM_IOCTL_AGP_BIND and DRM_IOCTL_AGP_UNBIND ioctls argument type.
0547  *
0548  * \sa drmAgpBind() and drmAgpUnbind().
0549  */
0550 struct drm_agp_binding {
0551     unsigned long handle;   /**< From drm_agp_buffer */
0552     unsigned long offset;   /**< In bytes -- will round to page boundary */
0553 };
0554 
0555 /*
0556  * DRM_IOCTL_AGP_INFO ioctl argument type.
0557  *
0558  * \sa drmAgpVersionMajor(), drmAgpVersionMinor(), drmAgpGetMode(),
0559  * drmAgpBase(), drmAgpSize(), drmAgpMemoryUsed(), drmAgpMemoryAvail(),
0560  * drmAgpVendorId() and drmAgpDeviceId().
0561  */
0562 struct drm_agp_info {
0563     int agp_version_major;
0564     int agp_version_minor;
0565     unsigned long mode;
0566     unsigned long aperture_base;    /* physical address */
0567     unsigned long aperture_size;    /* bytes */
0568     unsigned long memory_allowed;   /* bytes */
0569     unsigned long memory_used;
0570 
0571     /* PCI information */
0572     unsigned short id_vendor;
0573     unsigned short id_device;
0574 };
0575 
0576 /*
0577  * DRM_IOCTL_SG_ALLOC ioctl argument type.
0578  */
0579 struct drm_scatter_gather {
0580     unsigned long size; /**< In bytes -- will round to page boundary */
0581     unsigned long handle;   /**< Used for mapping / unmapping */
0582 };
0583 
0584 /*
0585  * DRM_IOCTL_SET_VERSION ioctl argument type.
0586  */
0587 struct drm_set_version {
0588     int drm_di_major;
0589     int drm_di_minor;
0590     int drm_dd_major;
0591     int drm_dd_minor;
0592 };
0593 
0594 /* DRM_IOCTL_GEM_CLOSE ioctl argument type */
0595 struct drm_gem_close {
0596     /** Handle of the object to be closed. */
0597     __u32 handle;
0598     __u32 pad;
0599 };
0600 
0601 /* DRM_IOCTL_GEM_FLINK ioctl argument type */
0602 struct drm_gem_flink {
0603     /** Handle for the object being named */
0604     __u32 handle;
0605 
0606     /** Returned global name */
0607     __u32 name;
0608 };
0609 
0610 /* DRM_IOCTL_GEM_OPEN ioctl argument type */
0611 struct drm_gem_open {
0612     /** Name of object being opened */
0613     __u32 name;
0614 
0615     /** Returned handle for the object */
0616     __u32 handle;
0617 
0618     /** Returned size of the object */
0619     __u64 size;
0620 };
0621 
0622 /**
0623  * DRM_CAP_DUMB_BUFFER
0624  *
0625  * If set to 1, the driver supports creating dumb buffers via the
0626  * &DRM_IOCTL_MODE_CREATE_DUMB ioctl.
0627  */
0628 #define DRM_CAP_DUMB_BUFFER     0x1
0629 /**
0630  * DRM_CAP_VBLANK_HIGH_CRTC
0631  *
0632  * If set to 1, the kernel supports specifying a :ref:`CRTC index<crtc_index>`
0633  * in the high bits of &drm_wait_vblank_request.type.
0634  *
0635  * Starting kernel version 2.6.39, this capability is always set to 1.
0636  */
0637 #define DRM_CAP_VBLANK_HIGH_CRTC    0x2
0638 /**
0639  * DRM_CAP_DUMB_PREFERRED_DEPTH
0640  *
0641  * The preferred bit depth for dumb buffers.
0642  *
0643  * The bit depth is the number of bits used to indicate the color of a single
0644  * pixel excluding any padding. This is different from the number of bits per
0645  * pixel. For instance, XRGB8888 has a bit depth of 24 but has 32 bits per
0646  * pixel.
0647  *
0648  * Note that this preference only applies to dumb buffers, it's irrelevant for
0649  * other types of buffers.
0650  */
0651 #define DRM_CAP_DUMB_PREFERRED_DEPTH    0x3
0652 /**
0653  * DRM_CAP_DUMB_PREFER_SHADOW
0654  *
0655  * If set to 1, the driver prefers userspace to render to a shadow buffer
0656  * instead of directly rendering to a dumb buffer. For best speed, userspace
0657  * should do streaming ordered memory copies into the dumb buffer and never
0658  * read from it.
0659  *
0660  * Note that this preference only applies to dumb buffers, it's irrelevant for
0661  * other types of buffers.
0662  */
0663 #define DRM_CAP_DUMB_PREFER_SHADOW  0x4
0664 /**
0665  * DRM_CAP_PRIME
0666  *
0667  * Bitfield of supported PRIME sharing capabilities. See &DRM_PRIME_CAP_IMPORT
0668  * and &DRM_PRIME_CAP_EXPORT.
0669  *
0670  * Starting from kernel version 6.6, both &DRM_PRIME_CAP_IMPORT and
0671  * &DRM_PRIME_CAP_EXPORT are always advertised.
0672  *
0673  * PRIME buffers are exposed as dma-buf file descriptors.
0674  * See :ref:`prime_buffer_sharing`.
0675  */
0676 #define DRM_CAP_PRIME           0x5
0677 /**
0678  * DRM_PRIME_CAP_IMPORT
0679  *
0680  * If this bit is set in &DRM_CAP_PRIME, the driver supports importing PRIME
0681  * buffers via the &DRM_IOCTL_PRIME_FD_TO_HANDLE ioctl.
0682  *
0683  * Starting from kernel version 6.6, this bit is always set in &DRM_CAP_PRIME.
0684  */
0685 #define  DRM_PRIME_CAP_IMPORT       0x1
0686 /**
0687  * DRM_PRIME_CAP_EXPORT
0688  *
0689  * If this bit is set in &DRM_CAP_PRIME, the driver supports exporting PRIME
0690  * buffers via the &DRM_IOCTL_PRIME_HANDLE_TO_FD ioctl.
0691  *
0692  * Starting from kernel version 6.6, this bit is always set in &DRM_CAP_PRIME.
0693  */
0694 #define  DRM_PRIME_CAP_EXPORT       0x2
0695 /**
0696  * DRM_CAP_TIMESTAMP_MONOTONIC
0697  *
0698  * If set to 0, the kernel will report timestamps with ``CLOCK_REALTIME`` in
0699  * struct drm_event_vblank. If set to 1, the kernel will report timestamps with
0700  * ``CLOCK_MONOTONIC``. See ``clock_gettime(2)`` for the definition of these
0701  * clocks.
0702  *
0703  * Starting from kernel version 2.6.39, the default value for this capability
0704  * is 1. Starting kernel version 4.15, this capability is always set to 1.
0705  */
0706 #define DRM_CAP_TIMESTAMP_MONOTONIC 0x6
0707 /**
0708  * DRM_CAP_ASYNC_PAGE_FLIP
0709  *
0710  * If set to 1, the driver supports &DRM_MODE_PAGE_FLIP_ASYNC for legacy
0711  * page-flips.
0712  */
0713 #define DRM_CAP_ASYNC_PAGE_FLIP     0x7
0714 /**
0715  * DRM_CAP_CURSOR_WIDTH
0716  *
0717  * The ``CURSOR_WIDTH`` and ``CURSOR_HEIGHT`` capabilities return a valid
0718  * width x height combination for the hardware cursor. The intention is that a
0719  * hardware agnostic userspace can query a cursor plane size to use.
0720  *
0721  * Note that the cross-driver contract is to merely return a valid size;
0722  * drivers are free to attach another meaning on top, eg. i915 returns the
0723  * maximum plane size.
0724  */
0725 #define DRM_CAP_CURSOR_WIDTH        0x8
0726 /**
0727  * DRM_CAP_CURSOR_HEIGHT
0728  *
0729  * See &DRM_CAP_CURSOR_WIDTH.
0730  */
0731 #define DRM_CAP_CURSOR_HEIGHT       0x9
0732 /**
0733  * DRM_CAP_ADDFB2_MODIFIERS
0734  *
0735  * If set to 1, the driver supports supplying modifiers in the
0736  * &DRM_IOCTL_MODE_ADDFB2 ioctl.
0737  */
0738 #define DRM_CAP_ADDFB2_MODIFIERS    0x10
0739 /**
0740  * DRM_CAP_PAGE_FLIP_TARGET
0741  *
0742  * If set to 1, the driver supports the &DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE and
0743  * &DRM_MODE_PAGE_FLIP_TARGET_RELATIVE flags in
0744  * &drm_mode_crtc_page_flip_target.flags for the &DRM_IOCTL_MODE_PAGE_FLIP
0745  * ioctl.
0746  */
0747 #define DRM_CAP_PAGE_FLIP_TARGET    0x11
0748 /**
0749  * DRM_CAP_CRTC_IN_VBLANK_EVENT
0750  *
0751  * If set to 1, the kernel supports reporting the CRTC ID in
0752  * &drm_event_vblank.crtc_id for the &DRM_EVENT_VBLANK and
0753  * &DRM_EVENT_FLIP_COMPLETE events.
0754  *
0755  * Starting kernel version 4.12, this capability is always set to 1.
0756  */
0757 #define DRM_CAP_CRTC_IN_VBLANK_EVENT    0x12
0758 /**
0759  * DRM_CAP_SYNCOBJ
0760  *
0761  * If set to 1, the driver supports sync objects. See :ref:`drm_sync_objects`.
0762  */
0763 #define DRM_CAP_SYNCOBJ     0x13
0764 /**
0765  * DRM_CAP_SYNCOBJ_TIMELINE
0766  *
0767  * If set to 1, the driver supports timeline operations on sync objects. See
0768  * :ref:`drm_sync_objects`.
0769  */
0770 #define DRM_CAP_SYNCOBJ_TIMELINE    0x14
0771 /**
0772  * DRM_CAP_ATOMIC_ASYNC_PAGE_FLIP
0773  *
0774  * If set to 1, the driver supports &DRM_MODE_PAGE_FLIP_ASYNC for atomic
0775  * commits.
0776  */
0777 #define DRM_CAP_ATOMIC_ASYNC_PAGE_FLIP  0x15
0778 
0779 /* DRM_IOCTL_GET_CAP ioctl argument type */
0780 struct drm_get_cap {
0781     __u64 capability;
0782     __u64 value;
0783 };
0784 
0785 /**
0786  * DRM_CLIENT_CAP_STEREO_3D
0787  *
0788  * If set to 1, the DRM core will expose the stereo 3D capabilities of the
0789  * monitor by advertising the supported 3D layouts in the flags of struct
0790  * drm_mode_modeinfo. See ``DRM_MODE_FLAG_3D_*``.
0791  *
0792  * This capability is always supported for all drivers starting from kernel
0793  * version 3.13.
0794  */
0795 #define DRM_CLIENT_CAP_STEREO_3D    1
0796 
0797 /**
0798  * DRM_CLIENT_CAP_UNIVERSAL_PLANES
0799  *
0800  * If set to 1, the DRM core will expose all planes (overlay, primary, and
0801  * cursor) to userspace.
0802  *
0803  * This capability has been introduced in kernel version 3.15. Starting from
0804  * kernel version 3.17, this capability is always supported for all drivers.
0805  */
0806 #define DRM_CLIENT_CAP_UNIVERSAL_PLANES  2
0807 
0808 /**
0809  * DRM_CLIENT_CAP_ATOMIC
0810  *
0811  * If set to 1, the DRM core will expose atomic properties to userspace. This
0812  * implicitly enables &DRM_CLIENT_CAP_UNIVERSAL_PLANES and
0813  * &DRM_CLIENT_CAP_ASPECT_RATIO.
0814  *
0815  * If the driver doesn't support atomic mode-setting, enabling this capability
0816  * will fail with -EOPNOTSUPP.
0817  *
0818  * This capability has been introduced in kernel version 4.0. Starting from
0819  * kernel version 4.2, this capability is always supported for atomic-capable
0820  * drivers.
0821  */
0822 #define DRM_CLIENT_CAP_ATOMIC   3
0823 
0824 /**
0825  * DRM_CLIENT_CAP_ASPECT_RATIO
0826  *
0827  * If set to 1, the DRM core will provide aspect ratio information in modes.
0828  * See ``DRM_MODE_FLAG_PIC_AR_*``.
0829  *
0830  * This capability is always supported for all drivers starting from kernel
0831  * version 4.18.
0832  */
0833 #define DRM_CLIENT_CAP_ASPECT_RATIO    4
0834 
0835 /**
0836  * DRM_CLIENT_CAP_WRITEBACK_CONNECTORS
0837  *
0838  * If set to 1, the DRM core will expose special connectors to be used for
0839  * writing back to memory the scene setup in the commit. The client must enable
0840  * &DRM_CLIENT_CAP_ATOMIC first.
0841  *
0842  * This capability is always supported for atomic-capable drivers starting from
0843  * kernel version 4.19.
0844  */
0845 #define DRM_CLIENT_CAP_WRITEBACK_CONNECTORS 5
0846 
0847 /**
0848  * DRM_CLIENT_CAP_CURSOR_PLANE_HOTSPOT
0849  *
0850  * Drivers for para-virtualized hardware (e.g. vmwgfx, qxl, virtio and
0851  * virtualbox) have additional restrictions for cursor planes (thus
0852  * making cursor planes on those drivers not truly universal,) e.g.
0853  * they need cursor planes to act like one would expect from a mouse
0854  * cursor and have correctly set hotspot properties.
0855  * If this client cap is not set the DRM core will hide cursor plane on
0856  * those virtualized drivers because not setting it implies that the
0857  * client is not capable of dealing with those extra restictions.
0858  * Clients which do set cursor hotspot and treat the cursor plane
0859  * like a mouse cursor should set this property.
0860  * The client must enable &DRM_CLIENT_CAP_ATOMIC first.
0861  *
0862  * Setting this property on drivers which do not special case
0863  * cursor planes (i.e. non-virtualized drivers) will return
0864  * EOPNOTSUPP, which can be used by userspace to gauge
0865  * requirements of the hardware/drivers they're running on.
0866  *
0867  * This capability is always supported for atomic-capable virtualized
0868  * drivers starting from kernel version 6.6.
0869  */
0870 #define DRM_CLIENT_CAP_CURSOR_PLANE_HOTSPOT 6
0871 
0872 /* DRM_IOCTL_SET_CLIENT_CAP ioctl argument type */
0873 struct drm_set_client_cap {
0874     __u64 capability;
0875     __u64 value;
0876 };
0877 
0878 #define DRM_RDWR O_RDWR
0879 #define DRM_CLOEXEC O_CLOEXEC
0880 struct drm_prime_handle {
0881     __u32 handle;
0882 
0883     /** Flags.. only applicable for handle->fd */
0884     __u32 flags;
0885 
0886     /** Returned dmabuf file descriptor */
0887     __s32 fd;
0888 };
0889 
0890 struct drm_syncobj_create {
0891     __u32 handle;
0892 #define DRM_SYNCOBJ_CREATE_SIGNALED (1 << 0)
0893     __u32 flags;
0894 };
0895 
0896 struct drm_syncobj_destroy {
0897     __u32 handle;
0898     __u32 pad;
0899 };
0900 
0901 #define DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_IMPORT_SYNC_FILE (1 << 0)
0902 #define DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_EXPORT_SYNC_FILE (1 << 0)
0903 struct drm_syncobj_handle {
0904     __u32 handle;
0905     __u32 flags;
0906 
0907     __s32 fd;
0908     __u32 pad;
0909 };
0910 
0911 struct drm_syncobj_transfer {
0912     __u32 src_handle;
0913     __u32 dst_handle;
0914     __u64 src_point;
0915     __u64 dst_point;
0916     __u32 flags;
0917     __u32 pad;
0918 };
0919 
0920 #define DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL (1 << 0)
0921 #define DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT (1 << 1)
0922 #define DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE (1 << 2) /* wait for time point to become available */
0923 #define DRM_SYNCOBJ_WAIT_FLAGS_WAIT_DEADLINE (1 << 3) /* set fence deadline to deadline_nsec */
0924 struct drm_syncobj_wait {
0925     __u64 handles;
0926     /* absolute timeout */
0927     __s64 timeout_nsec;
0928     __u32 count_handles;
0929     __u32 flags;
0930     __u32 first_signaled; /* only valid when not waiting all */
0931     __u32 pad;
0932     /**
0933      * @deadline_nsec - fence deadline hint
0934      *
0935      * Deadline hint, in absolute CLOCK_MONOTONIC, to set on backing
0936      * fence(s) if the DRM_SYNCOBJ_WAIT_FLAGS_WAIT_DEADLINE flag is
0937      * set.
0938      */
0939     __u64 deadline_nsec;
0940 };
0941 
0942 struct drm_syncobj_timeline_wait {
0943     __u64 handles;
0944     /* wait on specific timeline point for every handles*/
0945     __u64 points;
0946     /* absolute timeout */
0947     __s64 timeout_nsec;
0948     __u32 count_handles;
0949     __u32 flags;
0950     __u32 first_signaled; /* only valid when not waiting all */
0951     __u32 pad;
0952     /**
0953      * @deadline_nsec - fence deadline hint
0954      *
0955      * Deadline hint, in absolute CLOCK_MONOTONIC, to set on backing
0956      * fence(s) if the DRM_SYNCOBJ_WAIT_FLAGS_WAIT_DEADLINE flag is
0957      * set.
0958      */
0959     __u64 deadline_nsec;
0960 };
0961 
0962 /**
0963  * struct drm_syncobj_eventfd
0964  * @handle: syncobj handle.
0965  * @flags: Zero to wait for the point to be signalled, or
0966  *         &DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE to wait for a fence to be
0967  *         available for the point.
0968  * @point: syncobj timeline point (set to zero for binary syncobjs).
0969  * @fd: Existing eventfd to sent events to.
0970  * @pad: Must be zero.
0971  *
0972  * Register an eventfd to be signalled by a syncobj. The eventfd counter will
0973  * be incremented by one.
0974  */
0975 struct drm_syncobj_eventfd {
0976     __u32 handle;
0977     __u32 flags;
0978     __u64 point;
0979     __s32 fd;
0980     __u32 pad;
0981 };
0982 
0983 
0984 struct drm_syncobj_array {
0985     __u64 handles;
0986     __u32 count_handles;
0987     __u32 pad;
0988 };
0989 
0990 #define DRM_SYNCOBJ_QUERY_FLAGS_LAST_SUBMITTED (1 << 0) /* last available point on timeline syncobj */
0991 struct drm_syncobj_timeline_array {
0992     __u64 handles;
0993     __u64 points;
0994     __u32 count_handles;
0995     __u32 flags;
0996 };
0997 
0998 
0999 /* Query current scanout sequence number */
1000 struct drm_crtc_get_sequence {
1001     __u32 crtc_id;      /* requested crtc_id */
1002     __u32 active;       /* return: crtc output is active */
1003     __u64 sequence;     /* return: most recent vblank sequence */
1004     __s64 sequence_ns;  /* return: most recent time of first pixel out */
1005 };
1006 
1007 /* Queue event to be delivered at specified sequence. Time stamp marks
1008  * when the first pixel of the refresh cycle leaves the display engine
1009  * for the display
1010  */
1011 #define DRM_CRTC_SEQUENCE_RELATIVE      0x00000001  /* sequence is relative to current */
1012 #define DRM_CRTC_SEQUENCE_NEXT_ON_MISS      0x00000002  /* Use next sequence if we've missed */
1013 
1014 struct drm_crtc_queue_sequence {
1015     __u32 crtc_id;
1016     __u32 flags;
1017     __u64 sequence;     /* on input, target sequence. on output, actual sequence */
1018     __u64 user_data;    /* user data passed to event */
1019 };
1020 
1021 #if defined(__cplusplus)
1022 }
1023 #endif
1024 
1025 #include "drm_mode.h"
1026 
1027 #if defined(__cplusplus)
1028 extern "C" {
1029 #endif
1030 
1031 #define DRM_IOCTL_BASE          'd'
1032 #define DRM_IO(nr)          _IO(DRM_IOCTL_BASE,nr)
1033 #define DRM_IOR(nr,type)        _IOR(DRM_IOCTL_BASE,nr,type)
1034 #define DRM_IOW(nr,type)        _IOW(DRM_IOCTL_BASE,nr,type)
1035 #define DRM_IOWR(nr,type)       _IOWR(DRM_IOCTL_BASE,nr,type)
1036 
1037 #define DRM_IOCTL_VERSION       DRM_IOWR(0x00, struct drm_version)
1038 #define DRM_IOCTL_GET_UNIQUE        DRM_IOWR(0x01, struct drm_unique)
1039 #define DRM_IOCTL_GET_MAGIC     DRM_IOR( 0x02, struct drm_auth)
1040 #define DRM_IOCTL_IRQ_BUSID     DRM_IOWR(0x03, struct drm_irq_busid)
1041 #define DRM_IOCTL_GET_MAP               DRM_IOWR(0x04, struct drm_map)
1042 #define DRM_IOCTL_GET_CLIENT            DRM_IOWR(0x05, struct drm_client)
1043 #define DRM_IOCTL_GET_STATS             DRM_IOR( 0x06, struct drm_stats)
1044 #define DRM_IOCTL_SET_VERSION       DRM_IOWR(0x07, struct drm_set_version)
1045 #define DRM_IOCTL_MODESET_CTL           DRM_IOW(0x08, struct drm_modeset_ctl)
1046 /**
1047  * DRM_IOCTL_GEM_CLOSE - Close a GEM handle.
1048  *
1049  * GEM handles are not reference-counted by the kernel. User-space is
1050  * responsible for managing their lifetime. For example, if user-space imports
1051  * the same memory object twice on the same DRM file description, the same GEM
1052  * handle is returned by both imports, and user-space needs to ensure
1053  * &DRM_IOCTL_GEM_CLOSE is performed once only. The same situation can happen
1054  * when a memory object is allocated, then exported and imported again on the
1055  * same DRM file description. The &DRM_IOCTL_MODE_GETFB2 IOCTL is an exception
1056  * and always returns fresh new GEM handles even if an existing GEM handle
1057  * already refers to the same memory object before the IOCTL is performed.
1058  */
1059 #define DRM_IOCTL_GEM_CLOSE     DRM_IOW (0x09, struct drm_gem_close)
1060 #define DRM_IOCTL_GEM_FLINK     DRM_IOWR(0x0a, struct drm_gem_flink)
1061 #define DRM_IOCTL_GEM_OPEN      DRM_IOWR(0x0b, struct drm_gem_open)
1062 #define DRM_IOCTL_GET_CAP       DRM_IOWR(0x0c, struct drm_get_cap)
1063 #define DRM_IOCTL_SET_CLIENT_CAP    DRM_IOW( 0x0d, struct drm_set_client_cap)
1064 
1065 #define DRM_IOCTL_SET_UNIQUE        DRM_IOW( 0x10, struct drm_unique)
1066 #define DRM_IOCTL_AUTH_MAGIC        DRM_IOW( 0x11, struct drm_auth)
1067 #define DRM_IOCTL_BLOCK         DRM_IOWR(0x12, struct drm_block)
1068 #define DRM_IOCTL_UNBLOCK       DRM_IOWR(0x13, struct drm_block)
1069 #define DRM_IOCTL_CONTROL       DRM_IOW( 0x14, struct drm_control)
1070 #define DRM_IOCTL_ADD_MAP       DRM_IOWR(0x15, struct drm_map)
1071 #define DRM_IOCTL_ADD_BUFS      DRM_IOWR(0x16, struct drm_buf_desc)
1072 #define DRM_IOCTL_MARK_BUFS     DRM_IOW( 0x17, struct drm_buf_desc)
1073 #define DRM_IOCTL_INFO_BUFS     DRM_IOWR(0x18, struct drm_buf_info)
1074 #define DRM_IOCTL_MAP_BUFS      DRM_IOWR(0x19, struct drm_buf_map)
1075 #define DRM_IOCTL_FREE_BUFS     DRM_IOW( 0x1a, struct drm_buf_free)
1076 
1077 #define DRM_IOCTL_RM_MAP        DRM_IOW( 0x1b, struct drm_map)
1078 
1079 #define DRM_IOCTL_SET_SAREA_CTX     DRM_IOW( 0x1c, struct drm_ctx_priv_map)
1080 #define DRM_IOCTL_GET_SAREA_CTX     DRM_IOWR(0x1d, struct drm_ctx_priv_map)
1081 
1082 #define DRM_IOCTL_SET_MASTER            DRM_IO(0x1e)
1083 #define DRM_IOCTL_DROP_MASTER           DRM_IO(0x1f)
1084 
1085 #define DRM_IOCTL_ADD_CTX       DRM_IOWR(0x20, struct drm_ctx)
1086 #define DRM_IOCTL_RM_CTX        DRM_IOWR(0x21, struct drm_ctx)
1087 #define DRM_IOCTL_MOD_CTX       DRM_IOW( 0x22, struct drm_ctx)
1088 #define DRM_IOCTL_GET_CTX       DRM_IOWR(0x23, struct drm_ctx)
1089 #define DRM_IOCTL_SWITCH_CTX        DRM_IOW( 0x24, struct drm_ctx)
1090 #define DRM_IOCTL_NEW_CTX       DRM_IOW( 0x25, struct drm_ctx)
1091 #define DRM_IOCTL_RES_CTX       DRM_IOWR(0x26, struct drm_ctx_res)
1092 #define DRM_IOCTL_ADD_DRAW      DRM_IOWR(0x27, struct drm_draw)
1093 #define DRM_IOCTL_RM_DRAW       DRM_IOWR(0x28, struct drm_draw)
1094 #define DRM_IOCTL_DMA           DRM_IOWR(0x29, struct drm_dma)
1095 #define DRM_IOCTL_LOCK          DRM_IOW( 0x2a, struct drm_lock)
1096 #define DRM_IOCTL_UNLOCK        DRM_IOW( 0x2b, struct drm_lock)
1097 #define DRM_IOCTL_FINISH        DRM_IOW( 0x2c, struct drm_lock)
1098 
1099 /**
1100  * DRM_IOCTL_PRIME_HANDLE_TO_FD - Convert a GEM handle to a DMA-BUF FD.
1101  *
1102  * User-space sets &drm_prime_handle.handle with the GEM handle to export and
1103  * &drm_prime_handle.flags, and gets back a DMA-BUF file descriptor in
1104  * &drm_prime_handle.fd.
1105  *
1106  * The export can fail for any driver-specific reason, e.g. because export is
1107  * not supported for this specific GEM handle (but might be for others).
1108  *
1109  * Support for exporting DMA-BUFs is advertised via &DRM_PRIME_CAP_EXPORT.
1110  */
1111 #define DRM_IOCTL_PRIME_HANDLE_TO_FD    DRM_IOWR(0x2d, struct drm_prime_handle)
1112 /**
1113  * DRM_IOCTL_PRIME_FD_TO_HANDLE - Convert a DMA-BUF FD to a GEM handle.
1114  *
1115  * User-space sets &drm_prime_handle.fd with a DMA-BUF file descriptor to
1116  * import, and gets back a GEM handle in &drm_prime_handle.handle.
1117  * &drm_prime_handle.flags is unused.
1118  *
1119  * If an existing GEM handle refers to the memory object backing the DMA-BUF,
1120  * that GEM handle is returned. Therefore user-space which needs to handle
1121  * arbitrary DMA-BUFs must have a user-space lookup data structure to manually
1122  * reference-count duplicated GEM handles. For more information see
1123  * &DRM_IOCTL_GEM_CLOSE.
1124  *
1125  * The import can fail for any driver-specific reason, e.g. because import is
1126  * only supported for DMA-BUFs allocated on this DRM device.
1127  *
1128  * Support for importing DMA-BUFs is advertised via &DRM_PRIME_CAP_IMPORT.
1129  */
1130 #define DRM_IOCTL_PRIME_FD_TO_HANDLE    DRM_IOWR(0x2e, struct drm_prime_handle)
1131 
1132 #define DRM_IOCTL_AGP_ACQUIRE       DRM_IO(  0x30)
1133 #define DRM_IOCTL_AGP_RELEASE       DRM_IO(  0x31)
1134 #define DRM_IOCTL_AGP_ENABLE        DRM_IOW( 0x32, struct drm_agp_mode)
1135 #define DRM_IOCTL_AGP_INFO      DRM_IOR( 0x33, struct drm_agp_info)
1136 #define DRM_IOCTL_AGP_ALLOC     DRM_IOWR(0x34, struct drm_agp_buffer)
1137 #define DRM_IOCTL_AGP_FREE      DRM_IOW( 0x35, struct drm_agp_buffer)
1138 #define DRM_IOCTL_AGP_BIND      DRM_IOW( 0x36, struct drm_agp_binding)
1139 #define DRM_IOCTL_AGP_UNBIND        DRM_IOW( 0x37, struct drm_agp_binding)
1140 
1141 #define DRM_IOCTL_SG_ALLOC      DRM_IOWR(0x38, struct drm_scatter_gather)
1142 #define DRM_IOCTL_SG_FREE       DRM_IOW( 0x39, struct drm_scatter_gather)
1143 
1144 #define DRM_IOCTL_WAIT_VBLANK       DRM_IOWR(0x3a, union drm_wait_vblank)
1145 
1146 #define DRM_IOCTL_CRTC_GET_SEQUENCE DRM_IOWR(0x3b, struct drm_crtc_get_sequence)
1147 #define DRM_IOCTL_CRTC_QUEUE_SEQUENCE   DRM_IOWR(0x3c, struct drm_crtc_queue_sequence)
1148 
1149 #define DRM_IOCTL_UPDATE_DRAW       DRM_IOW(0x3f, struct drm_update_draw)
1150 
1151 #define DRM_IOCTL_MODE_GETRESOURCES DRM_IOWR(0xA0, struct drm_mode_card_res)
1152 #define DRM_IOCTL_MODE_GETCRTC      DRM_IOWR(0xA1, struct drm_mode_crtc)
1153 #define DRM_IOCTL_MODE_SETCRTC      DRM_IOWR(0xA2, struct drm_mode_crtc)
1154 #define DRM_IOCTL_MODE_CURSOR       DRM_IOWR(0xA3, struct drm_mode_cursor)
1155 #define DRM_IOCTL_MODE_GETGAMMA     DRM_IOWR(0xA4, struct drm_mode_crtc_lut)
1156 #define DRM_IOCTL_MODE_SETGAMMA     DRM_IOWR(0xA5, struct drm_mode_crtc_lut)
1157 #define DRM_IOCTL_MODE_GETENCODER   DRM_IOWR(0xA6, struct drm_mode_get_encoder)
1158 #define DRM_IOCTL_MODE_GETCONNECTOR DRM_IOWR(0xA7, struct drm_mode_get_connector)
1159 #define DRM_IOCTL_MODE_ATTACHMODE   DRM_IOWR(0xA8, struct drm_mode_mode_cmd) /* deprecated (never worked) */
1160 #define DRM_IOCTL_MODE_DETACHMODE   DRM_IOWR(0xA9, struct drm_mode_mode_cmd) /* deprecated (never worked) */
1161 
1162 #define DRM_IOCTL_MODE_GETPROPERTY  DRM_IOWR(0xAA, struct drm_mode_get_property)
1163 #define DRM_IOCTL_MODE_SETPROPERTY  DRM_IOWR(0xAB, struct drm_mode_connector_set_property)
1164 #define DRM_IOCTL_MODE_GETPROPBLOB  DRM_IOWR(0xAC, struct drm_mode_get_blob)
1165 #define DRM_IOCTL_MODE_GETFB        DRM_IOWR(0xAD, struct drm_mode_fb_cmd)
1166 #define DRM_IOCTL_MODE_ADDFB        DRM_IOWR(0xAE, struct drm_mode_fb_cmd)
1167 /**
1168  * DRM_IOCTL_MODE_RMFB - Remove a framebuffer.
1169  *
1170  * This removes a framebuffer previously added via ADDFB/ADDFB2. The IOCTL
1171  * argument is a framebuffer object ID.
1172  *
1173  * Warning: removing a framebuffer currently in-use on an enabled plane will
1174  * disable that plane. The CRTC the plane is linked to may also be disabled
1175  * (depending on driver capabilities).
1176  */
1177 #define DRM_IOCTL_MODE_RMFB     DRM_IOWR(0xAF, unsigned int)
1178 #define DRM_IOCTL_MODE_PAGE_FLIP    DRM_IOWR(0xB0, struct drm_mode_crtc_page_flip)
1179 #define DRM_IOCTL_MODE_DIRTYFB      DRM_IOWR(0xB1, struct drm_mode_fb_dirty_cmd)
1180 
1181 /**
1182  * DRM_IOCTL_MODE_CREATE_DUMB - Create a new dumb buffer object.
1183  *
1184  * KMS dumb buffers provide a very primitive way to allocate a buffer object
1185  * suitable for scanout and map it for software rendering. KMS dumb buffers are
1186  * not suitable for hardware-accelerated rendering nor video decoding. KMS dumb
1187  * buffers are not suitable to be displayed on any other device than the KMS
1188  * device where they were allocated from. Also see
1189  * :ref:`kms_dumb_buffer_objects`.
1190  *
1191  * The IOCTL argument is a struct drm_mode_create_dumb.
1192  *
1193  * User-space is expected to create a KMS dumb buffer via this IOCTL, then add
1194  * it as a KMS framebuffer via &DRM_IOCTL_MODE_ADDFB and map it via
1195  * &DRM_IOCTL_MODE_MAP_DUMB.
1196  *
1197  * &DRM_CAP_DUMB_BUFFER indicates whether this IOCTL is supported.
1198  * &DRM_CAP_DUMB_PREFERRED_DEPTH and &DRM_CAP_DUMB_PREFER_SHADOW indicate
1199  * driver preferences for dumb buffers.
1200  */
1201 #define DRM_IOCTL_MODE_CREATE_DUMB DRM_IOWR(0xB2, struct drm_mode_create_dumb)
1202 #define DRM_IOCTL_MODE_MAP_DUMB    DRM_IOWR(0xB3, struct drm_mode_map_dumb)
1203 #define DRM_IOCTL_MODE_DESTROY_DUMB    DRM_IOWR(0xB4, struct drm_mode_destroy_dumb)
1204 #define DRM_IOCTL_MODE_GETPLANERESOURCES DRM_IOWR(0xB5, struct drm_mode_get_plane_res)
1205 #define DRM_IOCTL_MODE_GETPLANE DRM_IOWR(0xB6, struct drm_mode_get_plane)
1206 #define DRM_IOCTL_MODE_SETPLANE DRM_IOWR(0xB7, struct drm_mode_set_plane)
1207 #define DRM_IOCTL_MODE_ADDFB2       DRM_IOWR(0xB8, struct drm_mode_fb_cmd2)
1208 #define DRM_IOCTL_MODE_OBJ_GETPROPERTIES    DRM_IOWR(0xB9, struct drm_mode_obj_get_properties)
1209 #define DRM_IOCTL_MODE_OBJ_SETPROPERTY  DRM_IOWR(0xBA, struct drm_mode_obj_set_property)
1210 #define DRM_IOCTL_MODE_CURSOR2      DRM_IOWR(0xBB, struct drm_mode_cursor2)
1211 #define DRM_IOCTL_MODE_ATOMIC       DRM_IOWR(0xBC, struct drm_mode_atomic)
1212 #define DRM_IOCTL_MODE_CREATEPROPBLOB   DRM_IOWR(0xBD, struct drm_mode_create_blob)
1213 #define DRM_IOCTL_MODE_DESTROYPROPBLOB  DRM_IOWR(0xBE, struct drm_mode_destroy_blob)
1214 
1215 #define DRM_IOCTL_SYNCOBJ_CREATE    DRM_IOWR(0xBF, struct drm_syncobj_create)
1216 #define DRM_IOCTL_SYNCOBJ_DESTROY   DRM_IOWR(0xC0, struct drm_syncobj_destroy)
1217 #define DRM_IOCTL_SYNCOBJ_HANDLE_TO_FD  DRM_IOWR(0xC1, struct drm_syncobj_handle)
1218 #define DRM_IOCTL_SYNCOBJ_FD_TO_HANDLE  DRM_IOWR(0xC2, struct drm_syncobj_handle)
1219 #define DRM_IOCTL_SYNCOBJ_WAIT      DRM_IOWR(0xC3, struct drm_syncobj_wait)
1220 #define DRM_IOCTL_SYNCOBJ_RESET     DRM_IOWR(0xC4, struct drm_syncobj_array)
1221 #define DRM_IOCTL_SYNCOBJ_SIGNAL    DRM_IOWR(0xC5, struct drm_syncobj_array)
1222 
1223 #define DRM_IOCTL_MODE_CREATE_LEASE DRM_IOWR(0xC6, struct drm_mode_create_lease)
1224 #define DRM_IOCTL_MODE_LIST_LESSEES DRM_IOWR(0xC7, struct drm_mode_list_lessees)
1225 #define DRM_IOCTL_MODE_GET_LEASE    DRM_IOWR(0xC8, struct drm_mode_get_lease)
1226 #define DRM_IOCTL_MODE_REVOKE_LEASE DRM_IOWR(0xC9, struct drm_mode_revoke_lease)
1227 
1228 #define DRM_IOCTL_SYNCOBJ_TIMELINE_WAIT DRM_IOWR(0xCA, struct drm_syncobj_timeline_wait)
1229 #define DRM_IOCTL_SYNCOBJ_QUERY     DRM_IOWR(0xCB, struct drm_syncobj_timeline_array)
1230 #define DRM_IOCTL_SYNCOBJ_TRANSFER  DRM_IOWR(0xCC, struct drm_syncobj_transfer)
1231 #define DRM_IOCTL_SYNCOBJ_TIMELINE_SIGNAL   DRM_IOWR(0xCD, struct drm_syncobj_timeline_array)
1232 
1233 /**
1234  * DRM_IOCTL_MODE_GETFB2 - Get framebuffer metadata.
1235  *
1236  * This queries metadata about a framebuffer. User-space fills
1237  * &drm_mode_fb_cmd2.fb_id as the input, and the kernels fills the rest of the
1238  * struct as the output.
1239  *
1240  * If the client is DRM master or has &CAP_SYS_ADMIN, &drm_mode_fb_cmd2.handles
1241  * will be filled with GEM buffer handles. Fresh new GEM handles are always
1242  * returned, even if another GEM handle referring to the same memory object
1243  * already exists on the DRM file description. The caller is responsible for
1244  * removing the new handles, e.g. via the &DRM_IOCTL_GEM_CLOSE IOCTL. The same
1245  * new handle will be returned for multiple planes in case they use the same
1246  * memory object. Planes are valid until one has a zero handle -- this can be
1247  * used to compute the number of planes.
1248  *
1249  * Otherwise, &drm_mode_fb_cmd2.handles will be zeroed and planes are valid
1250  * until one has a zero &drm_mode_fb_cmd2.pitches.
1251  *
1252  * If the framebuffer has a format modifier, &DRM_MODE_FB_MODIFIERS will be set
1253  * in &drm_mode_fb_cmd2.flags and &drm_mode_fb_cmd2.modifier will contain the
1254  * modifier. Otherwise, user-space must ignore &drm_mode_fb_cmd2.modifier.
1255  *
1256  * To obtain DMA-BUF FDs for each plane without leaking GEM handles, user-space
1257  * can export each handle via &DRM_IOCTL_PRIME_HANDLE_TO_FD, then immediately
1258  * close each unique handle via &DRM_IOCTL_GEM_CLOSE, making sure to not
1259  * double-close handles which are specified multiple times in the array.
1260  */
1261 #define DRM_IOCTL_MODE_GETFB2       DRM_IOWR(0xCE, struct drm_mode_fb_cmd2)
1262 
1263 #define DRM_IOCTL_SYNCOBJ_EVENTFD   DRM_IOWR(0xCF, struct drm_syncobj_eventfd)
1264 
1265 /**
1266  * DRM_IOCTL_MODE_CLOSEFB - Close a framebuffer.
1267  *
1268  * This closes a framebuffer previously added via ADDFB/ADDFB2. The IOCTL
1269  * argument is a framebuffer object ID.
1270  *
1271  * This IOCTL is similar to &DRM_IOCTL_MODE_RMFB, except it doesn't disable
1272  * planes and CRTCs. As long as the framebuffer is used by a plane, it's kept
1273  * alive. When the plane no longer uses the framebuffer (because the
1274  * framebuffer is replaced with another one, or the plane is disabled), the
1275  * framebuffer is cleaned up.
1276  *
1277  * This is useful to implement flicker-free transitions between two processes.
1278  *
1279  * Depending on the threat model, user-space may want to ensure that the
1280  * framebuffer doesn't expose any sensitive user information: closed
1281  * framebuffers attached to a plane can be read back by the next DRM master.
1282  */
1283 #define DRM_IOCTL_MODE_CLOSEFB      DRM_IOWR(0xD0, struct drm_mode_closefb)
1284 
1285 /*
1286  * Device specific ioctls should only be in their respective headers
1287  * The device specific ioctl range is from 0x40 to 0x9f.
1288  * Generic IOCTLS restart at 0xA0.
1289  *
1290  * \sa drmCommandNone(), drmCommandRead(), drmCommandWrite(), and
1291  * drmCommandReadWrite().
1292  */
1293 #define DRM_COMMAND_BASE                0x40
1294 #define DRM_COMMAND_END         0xA0
1295 
1296 /**
1297  * struct drm_event - Header for DRM events
1298  * @type: event type.
1299  * @length: total number of payload bytes (including header).
1300  *
1301  * This struct is a header for events written back to user-space on the DRM FD.
1302  * A read on the DRM FD will always only return complete events: e.g. if the
1303  * read buffer is 100 bytes large and there are two 64 byte events pending,
1304  * only one will be returned.
1305  *
1306  * Event types 0 - 0x7fffffff are generic DRM events, 0x80000000 and
1307  * up are chipset specific. Generic DRM events include &DRM_EVENT_VBLANK,
1308  * &DRM_EVENT_FLIP_COMPLETE and &DRM_EVENT_CRTC_SEQUENCE.
1309  */
1310 struct drm_event {
1311     __u32 type;
1312     __u32 length;
1313 };
1314 
1315 /**
1316  * DRM_EVENT_VBLANK - vertical blanking event
1317  *
1318  * This event is sent in response to &DRM_IOCTL_WAIT_VBLANK with the
1319  * &_DRM_VBLANK_EVENT flag set.
1320  *
1321  * The event payload is a struct drm_event_vblank.
1322  */
1323 #define DRM_EVENT_VBLANK 0x01
1324 /**
1325  * DRM_EVENT_FLIP_COMPLETE - page-flip completion event
1326  *
1327  * This event is sent in response to an atomic commit or legacy page-flip with
1328  * the &DRM_MODE_PAGE_FLIP_EVENT flag set.
1329  *
1330  * The event payload is a struct drm_event_vblank.
1331  */
1332 #define DRM_EVENT_FLIP_COMPLETE 0x02
1333 /**
1334  * DRM_EVENT_CRTC_SEQUENCE - CRTC sequence event
1335  *
1336  * This event is sent in response to &DRM_IOCTL_CRTC_QUEUE_SEQUENCE.
1337  *
1338  * The event payload is a struct drm_event_crtc_sequence.
1339  */
1340 #define DRM_EVENT_CRTC_SEQUENCE 0x03
1341 
1342 struct drm_event_vblank {
1343     struct drm_event base;
1344     __u64 user_data;
1345     __u32 tv_sec;
1346     __u32 tv_usec;
1347     __u32 sequence;
1348     __u32 crtc_id; /* 0 on older kernels that do not support this */
1349 };
1350 
1351 /* Event delivered at sequence. Time stamp marks when the first pixel
1352  * of the refresh cycle leaves the display engine for the display
1353  */
1354 struct drm_event_crtc_sequence {
1355     struct drm_event    base;
1356     __u64           user_data;
1357     __s64           time_ns;
1358     __u64           sequence;
1359 };
1360 
1361 /* typedef area */
1362 typedef struct drm_clip_rect drm_clip_rect_t;
1363 typedef struct drm_drawable_info drm_drawable_info_t;
1364 typedef struct drm_tex_region drm_tex_region_t;
1365 typedef struct drm_hw_lock drm_hw_lock_t;
1366 typedef struct drm_version drm_version_t;
1367 typedef struct drm_unique drm_unique_t;
1368 typedef struct drm_list drm_list_t;
1369 typedef struct drm_block drm_block_t;
1370 typedef struct drm_control drm_control_t;
1371 typedef enum drm_map_type drm_map_type_t;
1372 typedef enum drm_map_flags drm_map_flags_t;
1373 typedef struct drm_ctx_priv_map drm_ctx_priv_map_t;
1374 typedef struct drm_map drm_map_t;
1375 typedef struct drm_client drm_client_t;
1376 typedef enum drm_stat_type drm_stat_type_t;
1377 typedef struct drm_stats drm_stats_t;
1378 typedef enum drm_lock_flags drm_lock_flags_t;
1379 typedef struct drm_lock drm_lock_t;
1380 typedef enum drm_dma_flags drm_dma_flags_t;
1381 typedef struct drm_buf_desc drm_buf_desc_t;
1382 typedef struct drm_buf_info drm_buf_info_t;
1383 typedef struct drm_buf_free drm_buf_free_t;
1384 typedef struct drm_buf_pub drm_buf_pub_t;
1385 typedef struct drm_buf_map drm_buf_map_t;
1386 typedef struct drm_dma drm_dma_t;
1387 typedef union drm_wait_vblank drm_wait_vblank_t;
1388 typedef struct drm_agp_mode drm_agp_mode_t;
1389 typedef enum drm_ctx_flags drm_ctx_flags_t;
1390 typedef struct drm_ctx drm_ctx_t;
1391 typedef struct drm_ctx_res drm_ctx_res_t;
1392 typedef struct drm_draw drm_draw_t;
1393 typedef struct drm_update_draw drm_update_draw_t;
1394 typedef struct drm_auth drm_auth_t;
1395 typedef struct drm_irq_busid drm_irq_busid_t;
1396 typedef enum drm_vblank_seq_type drm_vblank_seq_type_t;
1397 
1398 typedef struct drm_agp_buffer drm_agp_buffer_t;
1399 typedef struct drm_agp_binding drm_agp_binding_t;
1400 typedef struct drm_agp_info drm_agp_info_t;
1401 typedef struct drm_scatter_gather drm_scatter_gather_t;
1402 typedef struct drm_set_version drm_set_version_t;
1403 
1404 #if defined(__cplusplus)
1405 }
1406 #endif
1407 
1408 #endif