shared-core/drm.h

   1 /**
   2  * \file drm.h
   3  * Header for the Direct Rendering Manager
   4  *
   5  * \author Rickard E. (Rik) Faith <faith@valinux.com>
   6  *
   7  * \par Acknowledgments:
   8  * Dec 1999, Richard Henderson <rth@twiddle.net>, move to generic \c cmpxchg.
   9  */
  10
  11 /*
  12  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
  13  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
  14  * All rights reserved.
  15  *
  16  * Permission is hereby granted, free of charge, to any person obtaining a
  17  * copy of this software and associated documentation files (the "Software"),
  18  * to deal in the Software without restriction, including without limitation
  19  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  20  * and/or sell copies of the Software, and to permit persons to whom the
  21  * Software is furnished to do so, subject to the following conditions:
  22  *
  23  * The above copyright notice and this permission notice (including the next
  24  * paragraph) shall be included in all copies or substantial portions of the
  25  * Software.
  26  *
  27  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  28  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  29  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  30  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  31  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  32  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  33  * OTHER DEALINGS IN THE SOFTWARE.
  34  */
  35
  36 /**
  37  * \mainpage
  38  *
  39  * The Direct Rendering Manager (DRM) is a device-independent kernel-level
  40  * device driver that provides support for the XFree86 Direct Rendering
  41  * Infrastructure (DRI).
  42  *
  43  * The DRM supports the Direct Rendering Infrastructure (DRI) in four major
  44  * ways:
  45  *     -# The DRM provides synchronized access to the graphics hardware via
  46  *        the use of an optimized two-tiered lock.
  47  *     -# The DRM enforces the DRI security policy for access to the graphics
  48  *        hardware by only allowing authenticated X11 clients access to
  49  *        restricted regions of memory.
  50  *     -# The DRM provides a generic DMA engine, complete with multiple
  51  *        queues and the ability to detect the need for an OpenGL context
  52  *        switch.
  53  *     -# The DRM is extensible via the use of small device-specific modules
  54  *        that rely extensively on the API exported by the DRM module.
  55  *
  56  */
  57
  58 #ifndef _DRM_H_
  59 #define _DRM_H_
  60
  61 #ifndef __user
  62 #define __user
  63 #endif
  64 #ifndef __iomem
  65 #define __iomem
  66 #endif
  67
  68 #ifdef __GNUC__
  69 # define DEPRECATED  __attribute__ ((deprecated))
  70 #else
  71 # define DEPRECATED
  72 #endif
  73
  74 #if defined(__linux__)
  75 #include <asm/ioctl.h>          /* For _IO* macros */
  76 #define DRM_IOCTL_NR(n)         _IOC_NR(n)
  77 #define DRM_IOC_VOID            _IOC_NONE
  78 #define DRM_IOC_READ            _IOC_READ
  79 #define DRM_IOC_WRITE           _IOC_WRITE
  80 #define DRM_IOC_READWRITE       _IOC_READ|_IOC_WRITE
  81 #define DRM_IOC(dir, group, nr, size) _IOC(dir, group, nr, size)
  82 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
  83 #include <sys/ioccom.h>
  84 #define DRM_IOCTL_NR(n)         ((n) & 0xff)
  85 #define DRM_IOC_VOID            IOC_VOID
  86 #define DRM_IOC_READ            IOC_OUT
  87 #define DRM_IOC_WRITE           IOC_IN
  88 #define DRM_IOC_READWRITE       IOC_INOUT
  89 #define DRM_IOC(dir, group, nr, size) _IOC(dir, group, nr, size)
  90 #endif
  91
  92 #define XFREE86_VERSION(major,minor,patch,snap) \
  93                 ((major << 16) | (minor << 8) | patch)
  94
  95 #ifndef CONFIG_XFREE86_VERSION
  96 #define CONFIG_XFREE86_VERSION XFREE86_VERSION(4,1,0,0)
  97 #endif
  98
  99 #if CONFIG_XFREE86_VERSION < XFREE86_VERSION(4,1,0,0)
 100 #define DRM_PROC_DEVICES "/proc/devices"
 101 #define DRM_PROC_MISC    "/proc/misc"
 102 #define DRM_PROC_DRM     "/proc/drm"
 103 #define DRM_DEV_DRM      "/dev/drm"
 104 #define DRM_DEV_MODE     (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP)
 105 #define DRM_DEV_UID      0
 106 #define DRM_DEV_GID      0
 107 #endif
 108
 109 #if CONFIG_XFREE86_VERSION >= XFREE86_VERSION(4,1,0,0)
 110 #ifdef __OpenBSD__
 111 #define DRM_MAJOR       81
 112 #endif
 113 #if defined(__linux__) || defined(__NetBSD__)
 114 #define DRM_MAJOR       226
 115 #endif
 116 #define DRM_MAX_MINOR   15
 117 #endif
 118 #define DRM_NAME        "drm"     /**< Name in kernel, /dev, and /proc */
 119 #define DRM_MIN_ORDER   5         /**< At least 2^5 bytes = 32 bytes */
 120 #define DRM_MAX_ORDER   22        /**< Up to 2^22 bytes = 4MB */
 121 #define DRM_RAM_PERCENT 10        /**< How much system ram can we lock? */
 122
 123 #define _DRM_LOCK_HELD  0x80000000U /**< Hardware lock is held */
 124 #define _DRM_LOCK_CONT  0x40000000U /**< Hardware lock is contended */
 125 #define _DRM_LOCK_IS_HELD(lock)    ((lock) & _DRM_LOCK_HELD)
 126 #define _DRM_LOCK_IS_CONT(lock)    ((lock) & _DRM_LOCK_CONT)
 127 #define _DRM_LOCKING_CONTEXT(lock) ((lock) & ~(_DRM_LOCK_HELD|_DRM_LOCK_CONT))
 128
 129 #if defined(__linux__)
 130 #if defined(__KERNEL__)
 131 typedef __u64 drm_u64_t;
 132 #else
 133 typedef unsigned long long drm_u64_t;
 134 #endif
 135
 136 typedef unsigned int drm_handle_t;
 137 #else
 138 #include <sys/types.h>
 139 typedef u_int64_t drm_u64_t;
 140 typedef unsigned long drm_handle_t;     /**< To mapped regions */
 141 #endif
 142 typedef unsigned int drm_context_t;     /**< GLXContext handle */
 143 typedef unsigned int drm_drawable_t;
 144 typedef unsigned int drm_magic_t;       /**< Magic for authentication */
 145
 146 /**
 147  * Cliprect.
 148  *
 149  * \warning If you change this structure, make sure you change
 150  * XF86DRIClipRectRec in the server as well
 151  *
 152  * \note KW: Actually it's illegal to change either for
 153  * backwards-compatibility reasons.
 154  */
 155 typedef struct drm_clip_rect {
 156         unsigned short x1;
 157         unsigned short y1;
 158         unsigned short x2;
 159         unsigned short y2;
 160 } drm_clip_rect_t;
 161
 162 /**
 163  * Drawable information.
 164  */
 165 typedef struct drm_drawable_info {
 166         unsigned int num_rects;
 167         drm_clip_rect_t *rects;
 168 } drm_drawable_info_t;
 169
 170 /**
 171  * Texture region,
 172  */
 173 typedef struct drm_tex_region {
 174         unsigned char next;
 175         unsigned char prev;
 176         unsigned char in_use;
 177         unsigned char padding;
 178         unsigned int age;
 179 } drm_tex_region_t;
 180
 181 /**
 182  * Hardware lock.
 183  *
 184  * The lock structure is a simple cache-line aligned integer.  To avoid
 185  * processor bus contention on a multiprocessor system, there should not be any
 186  * other data stored in the same cache line.
 187  */
 188 typedef struct drm_hw_lock {
 189         __volatile__ unsigned int lock;         /**< lock variable */
 190         char padding[60];                       /**< Pad to cache line */
 191 } drm_hw_lock_t;
 192
 193 /* This is beyond ugly, and only works on GCC.  However, it allows me to use
 194  * drm.h in places (i.e., in the X-server) where I can't use size_t.  The real
 195  * fix is to use uint32_t instead of size_t, but that fix will break existing
 196  * LP64 (i.e., PowerPC64, SPARC64, IA-64, Alpha, etc.) systems.  That *will*
 197  * eventually happen, though.  I chose 'unsigned long' to be the fallback type
 198  * because that works on all the platforms I know about.  Hopefully, the
 199  * real fix will happen before that bites us.
 200  */
 201
 202 #ifdef __SIZE_TYPE__
 203 # define DRM_SIZE_T __SIZE_TYPE__
 204 #else
 205 # warning "__SIZE_TYPE__ not defined.  Assuming sizeof(size_t) == sizeof(unsigned long)!"
 206 # define DRM_SIZE_T unsigned long
 207 #endif
 208
 209 /**
 210  * DRM_IOCTL_VERSION ioctl argument type.
 211  *
 212  * \sa drmGetVersion().
 213  */
 214 typedef struct drm_version {
 215         int version_major;        /**< Major version */
 216         int version_minor;        /**< Minor version */
 217         int version_patchlevel;   /**< Patch level */
 218         DRM_SIZE_T name_len;      /**< Length of name buffer */
 219         char __user *name;                /**< Name of driver */
 220         DRM_SIZE_T date_len;      /**< Length of date buffer */
 221         char __user *date;                /**< User-space buffer to hold date */
 222         DRM_SIZE_T desc_len;      /**< Length of desc buffer */
 223         char __user *desc;                /**< User-space buffer to hold desc */
 224 } drm_version_t;
 225
 226 /**
 227  * DRM_IOCTL_GET_UNIQUE ioctl argument type.
 228  *
 229  * \sa drmGetBusid() and drmSetBusId().
 230  */
 231 typedef struct drm_unique {
 232         DRM_SIZE_T unique_len;    /**< Length of unique */
 233         char __user *unique;              /**< Unique name for driver instantiation */
 234 } drm_unique_t;
 235
 236 #undef DRM_SIZE_T
 237
 238 typedef struct drm_list {
 239         int count;                /**< Length of user-space structures */
 240         drm_version_t __user *version;
 241 } drm_list_t;
 242
 243 typedef struct drm_block {
 244         int unused;
 245 } drm_block_t;
 246
 247 /**
 248  * DRM_IOCTL_CONTROL ioctl argument type.
 249  *
 250  * \sa drmCtlInstHandler() and drmCtlUninstHandler().
 251  */
 252 typedef struct drm_control {
 253         enum {
 254                 DRM_ADD_COMMAND,
 255                 DRM_RM_COMMAND,
 256                 DRM_INST_HANDLER,
 257                 DRM_UNINST_HANDLER
 258         } func;
 259         int irq;
 260 } drm_control_t;
 261
 262 /**
 263  * Type of memory to map.
 264  */
 265 typedef enum drm_map_type {
 266         _DRM_FRAME_BUFFER = 0,    /**< WC (no caching), no core dump */
 267         _DRM_REGISTERS = 1,       /**< no caching, no core dump */
 268         _DRM_SHM = 2,             /**< shared, cached */
 269         _DRM_AGP = 3,             /**< AGP/GART */
 270         _DRM_SCATTER_GATHER = 4,  /**< Scatter/gather memory for PCI DMA */
 271         _DRM_CONSISTENT = 5,      /**< Consistent memory for PCI DMA */
 272         _DRM_TTM = 6
 273 } drm_map_type_t;
 274
 275 /**
 276  * Memory mapping flags.
 277  */
 278 typedef enum drm_map_flags {
 279         _DRM_RESTRICTED = 0x01,      /**< Cannot be mapped to user-virtual */
 280         _DRM_READ_ONLY = 0x02,
 281         _DRM_LOCKED = 0x04,          /**< shared, cached, locked */
 282         _DRM_KERNEL = 0x08,          /**< kernel requires access */
 283         _DRM_WRITE_COMBINING = 0x10, /**< use write-combining if available */
 284         _DRM_CONTAINS_LOCK = 0x20,   /**< SHM page that contains lock */
 285         _DRM_REMOVABLE = 0x40        /**< Removable mapping */
 286 } drm_map_flags_t;
 287
 288 typedef struct drm_ctx_priv_map {
 289         unsigned int ctx_id;     /**< Context requesting private mapping */
 290         void *handle;            /**< Handle of map */
 291 } drm_ctx_priv_map_t;
 292
 293 /**
 294  * DRM_IOCTL_GET_MAP, DRM_IOCTL_ADD_MAP and DRM_IOCTL_RM_MAP ioctls
 295  * argument type.
 296  *
 297  * \sa drmAddMap().
 298  */
 299 typedef struct drm_map {
 300         unsigned long offset;    /**< Requested physical address (0 for SAREA)*/
 301         unsigned long size;      /**< Requested physical size (bytes) */
 302         drm_map_type_t type;     /**< Type of memory to map */
 303         drm_map_flags_t flags;   /**< Flags */
 304         void *handle;            /**< User-space: "Handle" to pass to mmap() */
 305                                  /**< Kernel-space: kernel-virtual address */
 306         int mtrr;                /**< MTRR slot used */
 307         /*   Private data */
 308 } drm_map_t;
 309
 310 /**
 311  * DRM_IOCTL_GET_CLIENT ioctl argument type.
 312  */
 313 typedef struct drm_client {
 314         int idx;                /**< Which client desired? */
 315         int auth;               /**< Is client authenticated? */
 316         unsigned long pid;      /**< Process ID */
 317         unsigned long uid;      /**< User ID */
 318         unsigned long magic;    /**< Magic */
 319         unsigned long iocs;     /**< Ioctl count */
 320 } drm_client_t;
 321
 322 typedef enum {
 323         _DRM_STAT_LOCK,
 324         _DRM_STAT_OPENS,
 325         _DRM_STAT_CLOSES,
 326         _DRM_STAT_IOCTLS,
 327         _DRM_STAT_LOCKS,
 328         _DRM_STAT_UNLOCKS,
 329         _DRM_STAT_VALUE,        /**< Generic value */
 330         _DRM_STAT_BYTE,         /**< Generic byte counter (1024bytes/K) */
 331         _DRM_STAT_COUNT,        /**< Generic non-byte counter (1000/k) */
 332
 333         _DRM_STAT_IRQ,          /**< IRQ */
 334         _DRM_STAT_PRIMARY,      /**< Primary DMA bytes */
 335         _DRM_STAT_SECONDARY,    /**< Secondary DMA bytes */
 336         _DRM_STAT_DMA,          /**< DMA */
 337         _DRM_STAT_SPECIAL,      /**< Special DMA (e.g., priority or polled) */
 338         _DRM_STAT_MISSED        /**< Missed DMA opportunity */
 339             /* Add to the *END* of the list */
 340 } drm_stat_type_t;
 341
 342 /**
 343  * DRM_IOCTL_GET_STATS ioctl argument type.
 344  */
 345 typedef struct drm_stats {
 346         unsigned long count;
 347         struct {
 348                 unsigned long value;
 349                 drm_stat_type_t type;
 350         } data[15];
 351 } drm_stats_t;
 352
 353 /**
 354  * Hardware locking flags.
 355  */
 356 typedef enum drm_lock_flags {
 357         _DRM_LOCK_READY = 0x01,      /**< Wait until hardware is ready for DMA */
 358         _DRM_LOCK_QUIESCENT = 0x02,  /**< Wait until hardware quiescent */
 359         _DRM_LOCK_FLUSH = 0x04,      /**< Flush this context's DMA queue first */
 360         _DRM_LOCK_FLUSH_ALL = 0x08,  /**< Flush all DMA queues first */
 361         /* These *HALT* flags aren't supported yet
 362            -- they will be used to support the
 363            full-screen DGA-like mode. */
 364         _DRM_HALT_ALL_QUEUES = 0x10, /**< Halt all current and future queues */
 365         _DRM_HALT_CUR_QUEUES = 0x20  /**< Halt all current queues */
 366 } drm_lock_flags_t;
 367
 368 /**
 369  * DRM_IOCTL_LOCK, DRM_IOCTL_UNLOCK and DRM_IOCTL_FINISH ioctl argument type.
 370  *
 371  * \sa drmGetLock() and drmUnlock().
 372  */
 373 typedef struct drm_lock {
 374         int context;
 375         drm_lock_flags_t flags;
 376 } drm_lock_t;
 377
 378 /**
 379  * DMA flags
 380  *
 381  * \warning
 382  * These values \e must match xf86drm.h.
 383  *
 384  * \sa drm_dma.
 385  */
 386 typedef enum drm_dma_flags {
 387         /* Flags for DMA buffer dispatch */
 388         _DRM_DMA_BLOCK = 0x01,        /**<
 389                                        * Block until buffer dispatched.
 390                                        *
 391                                        * \note The buffer may not yet have
 392                                        * been processed by the hardware --
 393                                        * getting a hardware lock with the
 394                                        * hardware quiescent will ensure
 395                                        * that the buffer has been
 396                                        * processed.
 397                                        */
 398         _DRM_DMA_WHILE_LOCKED = 0x02, /**< Dispatch while lock held */
 399         _DRM_DMA_PRIORITY = 0x04,     /**< High priority dispatch */
 400
 401         /* Flags for DMA buffer request */
 402         _DRM_DMA_WAIT = 0x10,         /**< Wait for free buffers */
 403         _DRM_DMA_SMALLER_OK = 0x20,   /**< Smaller-than-requested buffers OK */
 404         _DRM_DMA_LARGER_OK = 0x40     /**< Larger-than-requested buffers OK */
 405 } drm_dma_flags_t;
 406
 407 /**
 408  * DRM_IOCTL_ADD_BUFS and DRM_IOCTL_MARK_BUFS ioctl argument type.
 409  *
 410  * \sa drmAddBufs().
 411  */
 412 typedef struct drm_buf_desc {
 413         int count;               /**< Number of buffers of this size */
 414         int size;                /**< Size in bytes */
 415         int low_mark;            /**< Low water mark */
 416         int high_mark;           /**< High water mark */
 417         enum {
 418                 _DRM_PAGE_ALIGN = 0x01, /**< Align on page boundaries for DMA */
 419                 _DRM_AGP_BUFFER = 0x02, /**< Buffer is in AGP space */
 420                 _DRM_SG_BUFFER  = 0x04, /**< Scatter/gather memory buffer */
 421                 _DRM_FB_BUFFER  = 0x08, /**< Buffer is in frame buffer */
 422                 _DRM_PCI_BUFFER_RO = 0x10 /**< Map PCI DMA buffer read-only */
 423         } flags;
 424         unsigned long agp_start; /**<
 425                                   * Start address of where the AGP buffers are
 426                                   * in the AGP aperture
 427                                   */
 428 } drm_buf_desc_t;
 429
 430 /**
 431  * DRM_IOCTL_INFO_BUFS ioctl argument type.
 432  */
 433 typedef struct drm_buf_info {
 434         int count;                /**< Number of buffers described in list */
 435         drm_buf_desc_t __user *list;      /**< List of buffer descriptions */
 436 } drm_buf_info_t;
 437
 438 /**
 439  * DRM_IOCTL_FREE_BUFS ioctl argument type.
 440  */
 441 typedef struct drm_buf_free {
 442         int count;
 443         int __user *list;
 444 } drm_buf_free_t;
 445
 446 /**
 447  * Buffer information
 448  *
 449  * \sa drm_buf_map.
 450  */
 451 typedef struct drm_buf_pub {
 452         int idx;                       /**< Index into the master buffer list */
 453         int total;                     /**< Buffer size */
 454         int used;                      /**< Amount of buffer in use (for DMA) */
 455         void __user *address;          /**< Address of buffer */
 456 } drm_buf_pub_t;
 457
 458 /**
 459  * DRM_IOCTL_MAP_BUFS ioctl argument type.
 460  */
 461 typedef struct drm_buf_map {
 462         int count;              /**< Length of the buffer list */
 463 #if defined(__cplusplus)
 464         void __user *c_virtual;
 465 #else
 466         void __user *virtual;           /**< Mmap'd area in user-virtual */
 467 #endif
 468         drm_buf_pub_t __user *list;     /**< Buffer information */
 469 } drm_buf_map_t;
 470
 471 /**
 472  * DRM_IOCTL_DMA ioctl argument type.
 473  *
 474  * Indices here refer to the offset into the buffer list in drm_buf_get.
 475  *
 476  * \sa drmDMA().
 477  */
 478 typedef struct drm_dma {
 479         int context;                      /**< Context handle */
 480         int send_count;                   /**< Number of buffers to send */
 481         int __user *send_indices;         /**< List of handles to buffers */
 482         int __user *send_sizes;           /**< Lengths of data to send */
 483         drm_dma_flags_t flags;            /**< Flags */
 484         int request_count;                /**< Number of buffers requested */
 485         int request_size;                 /**< Desired size for buffers */
 486         int __user *request_indices;     /**< Buffer information */
 487         int __user *request_sizes;
 488         int granted_count;                /**< Number of buffers granted */
 489 } drm_dma_t;
 490
 491 typedef enum {
 492         _DRM_CONTEXT_PRESERVED = 0x01,
 493         _DRM_CONTEXT_2DONLY = 0x02
 494 } drm_ctx_flags_t;
 495
 496 /**
 497  * DRM_IOCTL_ADD_CTX ioctl argument type.
 498  *
 499  * \sa drmCreateContext() and drmDestroyContext().
 500  */
 501 typedef struct drm_ctx {
 502         drm_context_t handle;
 503         drm_ctx_flags_t flags;
 504 } drm_ctx_t;
 505
 506 /**
 507  * DRM_IOCTL_RES_CTX ioctl argument type.
 508  */
 509 typedef struct drm_ctx_res {
 510         int count;
 511         drm_ctx_t __user *contexts;
 512 } drm_ctx_res_t;
 513
 514 /**
 515  * DRM_IOCTL_ADD_DRAW and DRM_IOCTL_RM_DRAW ioctl argument type.
 516  */
 517 typedef struct drm_draw {
 518         drm_drawable_t handle;
 519 } drm_draw_t;
 520
 521 /**
 522  * DRM_IOCTL_UPDATE_DRAW ioctl argument type.
 523  */
 524 typedef enum {
 525         DRM_DRAWABLE_CLIPRECTS,
 526 } drm_drawable_info_type_t;
 527
 528 typedef struct drm_update_draw {
 529         drm_drawable_t handle;
 530         unsigned int type;
 531         unsigned int num;
 532         unsigned long long data;
 533 } drm_update_draw_t;
 534
 535 /**
 536  * DRM_IOCTL_GET_MAGIC and DRM_IOCTL_AUTH_MAGIC ioctl argument type.
 537  */
 538 typedef struct drm_auth {
 539         drm_magic_t magic;
 540 } drm_auth_t;
 541
 542 /**
 543  * DRM_IOCTL_IRQ_BUSID ioctl argument type.
 544  *
 545  * \sa drmGetInterruptFromBusID().
 546  */
 547 typedef struct drm_irq_busid {
 548         int irq;        /**< IRQ number */
 549         int busnum;     /**< bus number */
 550         int devnum;     /**< device number */
 551         int funcnum;    /**< function number */
 552 } drm_irq_busid_t;
 553
 554 typedef enum {
 555         _DRM_VBLANK_ABSOLUTE = 0x0,     /**< Wait for specific vblank sequence number */
 556         _DRM_VBLANK_RELATIVE = 0x1,     /**< Wait for given number of vblanks */
 557         _DRM_VBLANK_FLIP = 0x8000000,   /**< Scheduled buffer swap should flip */
 558         _DRM_VBLANK_NEXTONMISS = 0x10000000,    /**< If missed, wait for next vblank */
 559         _DRM_VBLANK_SECONDARY = 0x20000000,     /**< Secondary display controller */
 560         _DRM_VBLANK_SIGNAL = 0x40000000 /**< Send signal instead of blocking */
 561 } drm_vblank_seq_type_t;
 562
 563 #define _DRM_VBLANK_TYPES_MASK (_DRM_VBLANK_ABSOLUTE | _DRM_VBLANK_RELATIVE)
 564 #define _DRM_VBLANK_FLAGS_MASK (_DRM_VBLANK_SIGNAL | _DRM_VBLANK_SECONDARY | \
 565                                 _DRM_VBLANK_NEXTONMISS)
 566
 567 struct drm_wait_vblank_request {
 568         drm_vblank_seq_type_t type;
 569         unsigned int sequence;
 570         unsigned long signal;
 571 };
 572
 573 struct drm_wait_vblank_reply {
 574         drm_vblank_seq_type_t type;
 575         unsigned int sequence;
 576         long tval_sec;
 577         long tval_usec;
 578 };
 579
 580 /**
 581  * DRM_IOCTL_WAIT_VBLANK ioctl argument type.
 582  *
 583  * \sa drmWaitVBlank().
 584  */
 585 typedef union drm_wait_vblank {
 586         struct drm_wait_vblank_request request;
 587         struct drm_wait_vblank_reply reply;
 588 } drm_wait_vblank_t;
 589
 590 /**
 591  * DRM_IOCTL_AGP_ENABLE ioctl argument type.
 592  *
 593  * \sa drmAgpEnable().
 594  */
 595 typedef struct drm_agp_mode {
 596         unsigned long mode;     /**< AGP mode */
 597 } drm_agp_mode_t;
 598
 599 /**
 600  * DRM_IOCTL_AGP_ALLOC and DRM_IOCTL_AGP_FREE ioctls argument type.
 601  *
 602  * \sa drmAgpAlloc() and drmAgpFree().
 603  */
 604 typedef struct drm_agp_buffer {
 605         unsigned long size;     /**< In bytes -- will round to page boundary */
 606         unsigned long handle;   /**< Used for binding / unbinding */
 607         unsigned long type;     /**< Type of memory to allocate */
 608         unsigned long physical; /**< Physical used by i810 */
 609 } drm_agp_buffer_t;
 610
 611 /**
 612  * DRM_IOCTL_AGP_BIND and DRM_IOCTL_AGP_UNBIND ioctls argument type.
 613  *
 614  * \sa drmAgpBind() and drmAgpUnbind().
 615  */
 616 typedef struct drm_agp_binding {
 617         unsigned long handle;   /**< From drm_agp_buffer */
 618         unsigned long offset;   /**< In bytes -- will round to page boundary */
 619 } drm_agp_binding_t;
 620
 621 /**
 622  * DRM_IOCTL_AGP_INFO ioctl argument type.
 623  *
 624  * \sa drmAgpVersionMajor(), drmAgpVersionMinor(), drmAgpGetMode(),
 625  * drmAgpBase(), drmAgpSize(), drmAgpMemoryUsed(), drmAgpMemoryAvail(),
 626  * drmAgpVendorId() and drmAgpDeviceId().
 627  */
 628 typedef struct drm_agp_info {
 629         int agp_version_major;
 630         int agp_version_minor;
 631         unsigned long mode;
 632         unsigned long aperture_base;   /**< physical address */
 633         unsigned long aperture_size;   /**< bytes */
 634         unsigned long memory_allowed;  /**< bytes */
 635         unsigned long memory_used;
 636
 637         /** \name PCI information */
 638         /*@{ */
 639         unsigned short id_vendor;
 640         unsigned short id_device;
 641         /*@} */
 642 } drm_agp_info_t;
 643
 644 /**
 645  * DRM_IOCTL_SG_ALLOC ioctl argument type.
 646  */
 647 typedef struct drm_scatter_gather {
 648         unsigned long size;     /**< In bytes -- will round to page boundary */
 649         unsigned long handle;   /**< Used for mapping / unmapping */
 650 } drm_scatter_gather_t;
 651
 652 /**
 653  * DRM_IOCTL_SET_VERSION ioctl argument type.
 654  */
 655 typedef struct drm_set_version {
 656         int drm_di_major;
 657         int drm_di_minor;
 658         int drm_dd_major;
 659         int drm_dd_minor;
 660 } drm_set_version_t;
 661
 662
 663 #define DRM_FENCE_FLAG_EMIT                0x00000001
 664 #define DRM_FENCE_FLAG_SHAREABLE           0x00000002
 665 #define DRM_FENCE_FLAG_WAIT_LAZY           0x00000004
 666 #define DRM_FENCE_FLAG_WAIT_IGNORE_SIGNALS 0x00000008
 667
 668 /* Reserved for driver use */
 669 #define DRM_FENCE_MASK_DRIVER              0xFF000000
 670
 671 #define DRM_FENCE_TYPE_EXE                 0x00000001
 672
 673 typedef struct drm_fence_arg {
 674         unsigned int handle;
 675         unsigned int class;
 676         unsigned int type;
 677         unsigned int flags;
 678         unsigned int signaled;
 679         unsigned int pad64;
 680         drm_u64_t expand_pad[3]; /*Future expansion */
 681 } drm_fence_arg_t;
 682
 683 /* Buffer permissions, referring to how the GPU uses the buffers.
 684  * these translate to fence types used for the buffers.
 685  * Typically a texture buffer is read, A destination buffer is write and
 686  *  a command (batch-) buffer is exe. Can be or-ed together.
 687  */
 688
 689 #define DRM_BO_FLAG_READ        (1ULL << 0)
 690 #define DRM_BO_FLAG_WRITE       (1ULL << 1)
 691 #define DRM_BO_FLAG_EXE         (1ULL << 2)
 692
 693 /*
 694  * Status flags. Can be read to determine the actual state of a buffer.
 695  * Can also be set in the buffer mask before validation.
 696  */
 697
 698 /*
 699  * Mask: Never evict this buffer. Not even with force. This type of buffer is only
 700  * available to root and must be manually removed before buffer manager shutdown
 701  * or lock.
 702  * Flags: Acknowledge
 703  */
 704 #define DRM_BO_FLAG_NO_EVICT    (1ULL << 4)
 705
 706 /*
 707  * Mask: Require that the buffer is placed in mappable memory when validated.
 708  *       If not set the buffer may or may not be in mappable memory when validated.
 709  * Flags: If set, the buffer is in mappable memory.
 710  */
 711 #define DRM_BO_FLAG_MAPPABLE    (1ULL << 5)
 712
 713 /* Mask: The buffer should be shareable with other processes.
 714  * Flags: The buffer is shareable with other processes.
 715  */
 716 #define DRM_BO_FLAG_SHAREABLE   (1ULL << 6)
 717
 718 /* Mask: If set, place the buffer in cache-coherent memory if available.
 719  *       If clear, never place the buffer in cache coherent memory if validated.
 720  * Flags: The buffer is currently in cache-coherent memory.
 721  */
 722 #define DRM_BO_FLAG_CACHED      (1ULL << 7)
 723
 724 /* Mask: Make sure that every time this buffer is validated,
 725  *       it ends up on the same location provided that the memory mask is the same.
 726  *       The buffer will also not be evicted when claiming space for
 727  *       other buffers. Basically a pinned buffer but it may be thrown out as
 728  *       part of buffer manager shutdown or locking.
 729  * Flags: Acknowledge.
 730  */
 731 #define DRM_BO_FLAG_NO_MOVE     (1ULL << 8)
 732
 733 /* Mask: Make sure the buffer is in cached memory when mapped for reading.
 734  * Flags: Acknowledge.
 735  */
 736 #define DRM_BO_FLAG_READ_CACHED    (1ULL << 19)
 737
 738 /* Mask: Force DRM_BO_FLAG_CACHED flag strictly also if it is set.
 739  * Flags: Acknowledge.
 740  */
 741 #define DRM_BO_FLAG_FORCE_CACHING  (1ULL << 13)
 742
 743 /*
 744  * Mask: Force DRM_BO_FLAG_MAPPABLE flag strictly also if it is clear.
 745  * Flags: Acknowledge.
 746  */
 747 #define DRM_BO_FLAG_FORCE_MAPPABLE (1ULL << 14)
 748
 749 /*
 750  * Memory type flags that can be or'ed together in the mask, but only
 751  * one appears in flags.
 752  */
 753
 754 /* System memory */
 755 #define DRM_BO_FLAG_MEM_LOCAL  (1ULL << 24)
 756 /* Translation table memory */
 757 #define DRM_BO_FLAG_MEM_TT     (1ULL << 25)
 758 /* Vram memory */
 759 #define DRM_BO_FLAG_MEM_VRAM   (1ULL << 26)
 760 /* Up to the driver to define. */
 761 #define DRM_BO_FLAG_MEM_PRIV0  (1ULL << 27)
 762 #define DRM_BO_FLAG_MEM_PRIV1  (1ULL << 28)
 763 #define DRM_BO_FLAG_MEM_PRIV2  (1ULL << 29)
 764 #define DRM_BO_FLAG_MEM_PRIV3  (1ULL << 30)
 765 #define DRM_BO_FLAG_MEM_PRIV4  (1ULL << 31)
 766 /* We can add more of these now with a 64-bit flag type */
 767
 768 /* Memory flag mask */
 769 #define DRM_BO_MASK_MEM         0x00000000FF000000ULL
 770 #define DRM_BO_MASK_MEMTYPE     0x00000000FF0000A0ULL
 771
 772 /* Driver-private flags */
 773 #define DRM_BO_MASK_DRIVER      0xFFFF000000000000ULL
 774
 775 /* Don't block on validate and map */
 776 #define DRM_BO_HINT_DONT_BLOCK  0x00000002
 777 /* Don't place this buffer on the unfenced list.*/
 778 #define DRM_BO_HINT_DONT_FENCE  0x00000004
 779 #define DRM_BO_HINT_WAIT_LAZY   0x00000008
 780 #define DRM_BO_HINT_ALLOW_UNFENCED_MAP 0x00000010
 781
 782 #define DRM_BO_INIT_MAGIC 0xfe769812
 783 #define DRM_BO_INIT_MAJOR 0
 784 #define DRM_BO_INIT_MINOR 1
 785
 786
 787 typedef enum {
 788         drm_bo_type_dc,
 789         drm_bo_type_user,
 790         drm_bo_type_fake,
 791         drm_bo_type_kernel, /* for initial kernel allocations */
 792 }drm_bo_type_t;
 793
 794 struct drm_bo_info_req {
 795         drm_u64_t mask;
 796         drm_u64_t flags;
 797         unsigned int handle;
 798         unsigned int hint;
 799         unsigned int fence_class;
 800         unsigned int pad64;
 801 };
 802
 803 struct drm_bo_create_req {
 804         drm_u64_t mask;
 805         drm_u64_t size;
 806         drm_u64_t buffer_start;
 807         unsigned int hint;
 808         unsigned int page_alignment;
 809         drm_bo_type_t type;
 810         unsigned int pad64;
 811 };
 812
 813 struct drm_bo_op_req {
 814         enum {
 815                 drm_bo_validate,
 816                 drm_bo_fence,
 817                 drm_bo_ref_fence,
 818         } op;
 819         unsigned int arg_handle;
 820         struct drm_bo_info_req bo_req;
 821 };
 822
 823 /*
 824  * Reply flags
 825  */
 826
 827 #define DRM_BO_REP_BUSY 0x00000001
 828
 829 struct drm_bo_info_rep {
 830         drm_u64_t flags;
 831         drm_u64_t mask;
 832         drm_u64_t size;
 833         drm_u64_t offset;
 834         drm_u64_t arg_handle;
 835         drm_u64_t buffer_start;
 836         unsigned int handle;
 837         unsigned int fence_flags;
 838         unsigned int rep_flags;
 839         unsigned int page_alignment;
 840         unsigned int desired_tile_stride;
 841         unsigned int hw_tile_stride;
 842         unsigned int tile_info;
 843         unsigned int pad64;
 844         drm_u64_t expand_pad[4]; /*Future expansion */
 845 };
 846
 847 struct drm_bo_arg_rep {
 848         struct drm_bo_info_rep bo_info;
 849         int ret;
 850         unsigned int pad64;
 851 };
 852
 853 struct drm_bo_create_arg {
 854         union {
 855                 struct drm_bo_create_req req;
 856                 struct drm_bo_info_rep rep;
 857         } d;
 858 };
 859
 860 struct drm_bo_handle_arg {
 861         unsigned int handle;
 862 };
 863
 864 struct drm_bo_reference_info_arg {
 865         union {
 866                 struct drm_bo_handle_arg req;
 867                 struct drm_bo_info_rep rep;
 868         } d;
 869 };
 870
 871 struct drm_bo_map_wait_idle_arg {
 872         union {
 873                 struct drm_bo_info_req req;
 874                 struct drm_bo_info_rep rep;
 875         } d;
 876 };
 877
 878 struct drm_bo_op_arg {
 879         drm_u64_t next;
 880         union {
 881                 struct drm_bo_op_req req;
 882                 struct drm_bo_arg_rep rep;
 883         } d;
 884         int handled;
 885         unsigned int pad64;
 886 };
 887
 888 #define DRM_BO_MEM_LOCAL 0
 889 #define DRM_BO_MEM_TT 1
 890 #define DRM_BO_MEM_VRAM 2
 891 #define DRM_BO_MEM_PRIV0 3
 892 #define DRM_BO_MEM_PRIV1 4
 893 #define DRM_BO_MEM_PRIV2 5
 894 #define DRM_BO_MEM_PRIV3 6
 895 #define DRM_BO_MEM_PRIV4 7
 896
 897 #define DRM_BO_MEM_TYPES 8 /* For now. */
 898
 899 typedef struct drm_mm_type_arg {
 900         unsigned int mem_type;
 901 } drm_mm_type_arg_t;
 902
 903 typedef struct drm_mm_init_arg {
 904         unsigned int magic;
 905         unsigned int major;
 906         unsigned int minor;
 907         unsigned int mem_type;
 908         drm_u64_t p_offset;
 909         drm_u64_t p_size;
 910 } drm_mm_init_arg_t;
 911
 912 /**
 913  * \name Ioctls Definitions
 914  */
 915 /*@{*/
 916
 917 #define DRM_IOCTL_BASE                  'd'
 918 #define DRM_IO(nr)                      _IO(DRM_IOCTL_BASE,nr)
 919 #define DRM_IOR(nr,type)                _IOR(DRM_IOCTL_BASE,nr,type)
 920 #define DRM_IOW(nr,type)                _IOW(DRM_IOCTL_BASE,nr,type)
 921 #define DRM_IOWR(nr,type)               _IOWR(DRM_IOCTL_BASE,nr,type)
 922
 923 #define DRM_IOCTL_VERSION               DRM_IOWR(0x00, drm_version_t)
 924 #define DRM_IOCTL_GET_UNIQUE            DRM_IOWR(0x01, drm_unique_t)
 925 #define DRM_IOCTL_GET_MAGIC             DRM_IOR( 0x02, drm_auth_t)
 926 #define DRM_IOCTL_IRQ_BUSID             DRM_IOWR(0x03, drm_irq_busid_t)
 927 #define DRM_IOCTL_GET_MAP               DRM_IOWR(0x04, drm_map_t)
 928 #define DRM_IOCTL_GET_CLIENT            DRM_IOWR(0x05, drm_client_t)
 929 #define DRM_IOCTL_GET_STATS             DRM_IOR( 0x06, drm_stats_t)
 930 #define DRM_IOCTL_SET_VERSION           DRM_IOWR(0x07, drm_set_version_t)
 931
 932 #define DRM_IOCTL_SET_UNIQUE            DRM_IOW( 0x10, drm_unique_t)
 933 #define DRM_IOCTL_AUTH_MAGIC            DRM_IOW( 0x11, drm_auth_t)
 934 #define DRM_IOCTL_BLOCK                 DRM_IOWR(0x12, drm_block_t)
 935 #define DRM_IOCTL_UNBLOCK               DRM_IOWR(0x13, drm_block_t)
 936 #define DRM_IOCTL_CONTROL               DRM_IOW( 0x14, drm_control_t)
 937 #define DRM_IOCTL_ADD_MAP               DRM_IOWR(0x15, drm_map_t)
 938 #define DRM_IOCTL_ADD_BUFS              DRM_IOWR(0x16, drm_buf_desc_t)
 939 #define DRM_IOCTL_MARK_BUFS             DRM_IOW( 0x17, drm_buf_desc_t)
 940 #define DRM_IOCTL_INFO_BUFS             DRM_IOWR(0x18, drm_buf_info_t)
 941 #define DRM_IOCTL_MAP_BUFS              DRM_IOWR(0x19, drm_buf_map_t)
 942 #define DRM_IOCTL_FREE_BUFS             DRM_IOW( 0x1a, drm_buf_free_t)
 943
 944 #define DRM_IOCTL_RM_MAP                DRM_IOW( 0x1b, drm_map_t)
 945
 946 #define DRM_IOCTL_SET_SAREA_CTX         DRM_IOW( 0x1c, drm_ctx_priv_map_t)
 947 #define DRM_IOCTL_GET_SAREA_CTX         DRM_IOWR(0x1d, drm_ctx_priv_map_t)
 948
 949 #define DRM_IOCTL_ADD_CTX               DRM_IOWR(0x20, drm_ctx_t)
 950 #define DRM_IOCTL_RM_CTX                DRM_IOWR(0x21, drm_ctx_t)
 951 #define DRM_IOCTL_MOD_CTX               DRM_IOW( 0x22, drm_ctx_t)
 952 #define DRM_IOCTL_GET_CTX               DRM_IOWR(0x23, drm_ctx_t)
 953 #define DRM_IOCTL_SWITCH_CTX            DRM_IOW( 0x24, drm_ctx_t)
 954 #define DRM_IOCTL_NEW_CTX               DRM_IOW( 0x25, drm_ctx_t)
 955 #define DRM_IOCTL_RES_CTX               DRM_IOWR(0x26, drm_ctx_res_t)
 956 #define DRM_IOCTL_ADD_DRAW              DRM_IOWR(0x27, drm_draw_t)
 957 #define DRM_IOCTL_RM_DRAW               DRM_IOWR(0x28, drm_draw_t)
 958 #define DRM_IOCTL_DMA                   DRM_IOWR(0x29, drm_dma_t)
 959 #define DRM_IOCTL_LOCK                  DRM_IOW( 0x2a, drm_lock_t)
 960 #define DRM_IOCTL_UNLOCK                DRM_IOW( 0x2b, drm_lock_t)
 961 #define DRM_IOCTL_FINISH                DRM_IOW( 0x2c, drm_lock_t)
 962
 963 #define DRM_IOCTL_AGP_ACQUIRE           DRM_IO(  0x30)
 964 #define DRM_IOCTL_AGP_RELEASE           DRM_IO(  0x31)
 965 #define DRM_IOCTL_AGP_ENABLE            DRM_IOW( 0x32, drm_agp_mode_t)
 966 #define DRM_IOCTL_AGP_INFO              DRM_IOR( 0x33, drm_agp_info_t)
 967 #define DRM_IOCTL_AGP_ALLOC             DRM_IOWR(0x34, drm_agp_buffer_t)
 968 #define DRM_IOCTL_AGP_FREE              DRM_IOW( 0x35, drm_agp_buffer_t)
 969 #define DRM_IOCTL_AGP_BIND              DRM_IOW( 0x36, drm_agp_binding_t)
 970 #define DRM_IOCTL_AGP_UNBIND            DRM_IOW( 0x37, drm_agp_binding_t)
 971
 972 #define DRM_IOCTL_SG_ALLOC              DRM_IOW( 0x38, drm_scatter_gather_t)
 973 #define DRM_IOCTL_SG_FREE               DRM_IOW( 0x39, drm_scatter_gather_t)
 974
 975 #define DRM_IOCTL_WAIT_VBLANK           DRM_IOWR(0x3a, drm_wait_vblank_t)
 976
 977 #define DRM_IOCTL_UPDATE_DRAW           DRM_IOW(0x3f, drm_update_draw_t)
 978
 979 #define DRM_IOCTL_MM_INIT               DRM_IOWR(0xc0, drm_mm_init_arg_t)
 980 #define DRM_IOCTL_MM_TAKEDOWN           DRM_IOWR(0xc1, drm_mm_type_arg_t)
 981 #define DRM_IOCTL_MM_LOCK               DRM_IOWR(0xc2, drm_mm_type_arg_t)
 982 #define DRM_IOCTL_MM_UNLOCK             DRM_IOWR(0xc3, drm_mm_type_arg_t)
 983
 984 #define DRM_IOCTL_FENCE_CREATE          DRM_IOWR(0xc4, drm_fence_arg_t)
 985 #define DRM_IOCTL_FENCE_DESTROY         DRM_IOWR(0xc5, drm_fence_arg_t)
 986 #define DRM_IOCTL_FENCE_REFERENCE       DRM_IOWR(0xc6, drm_fence_arg_t)
 987 #define DRM_IOCTL_FENCE_UNREFERENCE     DRM_IOWR(0xc7, drm_fence_arg_t)
 988 #define DRM_IOCTL_FENCE_SIGNALED        DRM_IOWR(0xc8, drm_fence_arg_t)
 989 #define DRM_IOCTL_FENCE_FLUSH           DRM_IOWR(0xc9, drm_fence_arg_t)
 990 #define DRM_IOCTL_FENCE_WAIT            DRM_IOWR(0xca, drm_fence_arg_t)
 991 #define DRM_IOCTL_FENCE_EMIT            DRM_IOWR(0xcb, drm_fence_arg_t)
 992 #define DRM_IOCTL_FENCE_BUFFERS         DRM_IOWR(0xcc, drm_fence_arg_t)
 993
 994 #define DRM_IOCTL_BO_CREATE             DRM_IOWR(0xcd, struct drm_bo_create_arg)
 995 #define DRM_IOCTL_BO_DESTROY            DRM_IOWR(0xce, struct drm_bo_handle_arg)
 996 #define DRM_IOCTL_BO_MAP                DRM_IOWR(0xcf, struct drm_bo_map_wait_idle_arg)
 997 #define DRM_IOCTL_BO_UNMAP              DRM_IOWR(0xd0, struct drm_bo_handle_arg)
 998 #define DRM_IOCTL_BO_REFERENCE          DRM_IOWR(0xd1, struct drm_bo_reference_info_arg)
 999 #define DRM_IOCTL_BO_UNREFERENCE        DRM_IOWR(0xd2, struct drm_bo_handle_arg)
1000 #define DRM_IOCTL_BO_OP                 DRM_IOWR(0xd3, struct drm_bo_op_arg)
1001 #define DRM_IOCTL_BO_INFO               DRM_IOWR(0xd4, struct drm_bo_reference_info_arg)
1002 #define DRM_IOCTL_BO_WAIT_IDLE          DRM_IOWR(0xd5, struct drm_bo_map_wait_idle_arg)
1003
1004
1005 /*@}*/
1006
1007 /**
1008  * Device specific ioctls should only be in their respective headers
1009  * The device specific ioctl range is from 0x40 to 0x99.
1010  * Generic IOCTLS restart at 0xA0.
1011  *
1012  * \sa drmCommandNone(), drmCommandRead(), drmCommandWrite(), and
1013  * drmCommandReadWrite().
1014  */
1015 #define DRM_COMMAND_BASE                0x40
1016 #define DRM_COMMAND_END                 0xA0
1017
1018 #endif