shared-core/drm.h

   1 /* drm.h -- Header for Direct Rendering Manager -*- linux-c -*-
   2  * Created: Mon Jan  4 10:05:05 1999 by faith@precisioninsight.com
   3  *
   4  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
   5  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
   6  * All rights reserved.
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a
   9  * copy of this software and associated documentation files (the "Software"),
  10  * to deal in the Software without restriction, including without limitation
  11  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  12  * and/or sell copies of the Software, and to permit persons to whom the
  13  * Software is furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice (including the next
  16  * paragraph) shall be included in all copies or substantial portions of the
  17  * Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  22  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  23  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  24  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  25  * OTHER DEALINGS IN THE SOFTWARE.
  26  *
  27  * Authors:
  28  *    Rickard E. (Rik) Faith <faith@valinux.com>
  29  *
  30  * Acknowledgements:
  31  * Dec 1999, Richard Henderson <rth@twiddle.net>, move to generic cmpxchg.
  32  *
  33  */
  34
  35 #ifndef _DRM_H_
  36 #define _DRM_H_
  37
  38 #if defined(__linux__)
  39 #include <linux/config.h>
  40 #include <asm/ioctl.h>          /* For _IO* macros */
  41 #define DRM_IOCTL_NR(n)      _IOC_NR(n)
  42 #elif defined(__FreeBSD__)
  43 #include <sys/ioccom.h>
  44 #define DRM_IOCTL_NR(n)      ((n) & 0xff)
  45 #endif
  46
  47 #define XFREE86_VERSION(major,minor,patch,snap) \
  48                 ((major << 16) | (minor << 8) | patch)
  49
  50 #ifndef CONFIG_XFREE86_VERSION
  51 #define CONFIG_XFREE86_VERSION XFREE86_VERSION(4,1,0,0)
  52 #endif
  53
  54 #if CONFIG_XFREE86_VERSION < XFREE86_VERSION(4,1,0,0)
  55 #define DRM_PROC_DEVICES "/proc/devices"
  56 #define DRM_PROC_MISC    "/proc/misc"
  57 #define DRM_PROC_DRM     "/proc/drm"
  58 #define DRM_DEV_DRM      "/dev/drm"
  59 #define DRM_DEV_MODE     (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP)
  60 #define DRM_DEV_UID      0
  61 #define DRM_DEV_GID      0
  62 #endif
  63
  64 #if CONFIG_XFREE86_VERSION >= XFREE86_VERSION(4,1,0,0)
  65 #define DRM_MAJOR       226
  66 #define DRM_MAX_MINOR   15
  67 #endif
  68 #define DRM_NAME        "drm"     /* Name in kernel, /dev, and /proc        */
  69 #define DRM_MIN_ORDER   5         /* At least 2^5 bytes = 32 bytes          */
  70 #define DRM_MAX_ORDER   22        /* Up to 2^22 bytes = 4MB                 */
  71 #define DRM_RAM_PERCENT 10        /* How much system ram can we lock?       */
  72
  73 #define _DRM_LOCK_HELD  0x80000000 /* Hardware lock is held                 */
  74 #define _DRM_LOCK_CONT  0x40000000 /* Hardware lock is contended            */
  75 #define _DRM_LOCK_IS_HELD(lock)    ((lock) & _DRM_LOCK_HELD)
  76 #define _DRM_LOCK_IS_CONT(lock)    ((lock) & _DRM_LOCK_CONT)
  77 #define _DRM_LOCKING_CONTEXT(lock) ((lock) & ~(_DRM_LOCK_HELD|_DRM_LOCK_CONT))
  78
  79 typedef unsigned long drm_handle_t;
  80 typedef unsigned int  drm_context_t;
  81 typedef unsigned int  drm_drawable_t;
  82 typedef unsigned int  drm_magic_t;
  83
  84 /* Warning: If you change this structure, make sure you change
  85  * XF86DRIClipRectRec in the server as well */
  86
  87 typedef struct drm_clip_rect {
  88         unsigned short  x1;
  89         unsigned short  y1;
  90         unsigned short  x2;
  91         unsigned short  y2;
  92 } drm_clip_rect_t;
  93
  94 typedef struct drm_tex_region {
  95         unsigned char   next;
  96         unsigned char   prev;
  97         unsigned char   in_use;
  98         unsigned char   padding;
  99         unsigned int    age;
 100 } drm_tex_region_t;
 101
 102 typedef struct drm_version {
 103         int    version_major;     /* Major version                          */
 104         int    version_minor;     /* Minor version                          */
 105         int    version_patchlevel;/* Patch level                            */
 106         size_t name_len;          /* Length of name buffer                  */
 107         char   *name;             /* Name of driver                         */
 108         size_t date_len;          /* Length of date buffer                  */
 109         char   *date;             /* User-space buffer to hold date         */
 110         size_t desc_len;          /* Length of desc buffer                  */
 111         char   *desc;             /* User-space buffer to hold desc         */
 112 } drm_version_t;
 113
 114 typedef struct drm_unique {
 115         size_t unique_len;        /* Length of unique                       */
 116         char   *unique;           /* Unique name for driver instantiation   */
 117 } drm_unique_t;
 118
 119 typedef struct drm_list {
 120         int              count;   /* Length of user-space structures        */
 121         drm_version_t    *version;
 122 } drm_list_t;
 123
 124 typedef struct drm_block {
 125         int              unused;
 126 } drm_block_t;
 127
 128 typedef struct drm_control {
 129         enum {
 130                 DRM_ADD_COMMAND,
 131                 DRM_RM_COMMAND,
 132                 DRM_INST_HANDLER,
 133                 DRM_UNINST_HANDLER
 134         }                func;
 135         int              irq;
 136 } drm_control_t;
 137
 138 typedef enum drm_map_type {
 139         _DRM_FRAME_BUFFER   = 0,  /* WC (no caching), no core dump          */
 140         _DRM_REGISTERS      = 1,  /* no caching, no core dump               */
 141         _DRM_SHM            = 2,  /* shared, cached                         */
 142         _DRM_AGP            = 3,  /* AGP/GART                               */
 143         _DRM_SCATTER_GATHER = 4   /* Scatter/gather memory for PCI DMA      */
 144 } drm_map_type_t;
 145
 146 typedef enum drm_map_flags {
 147         _DRM_RESTRICTED      = 0x01, /* Cannot be mapped to user-virtual    */
 148         _DRM_READ_ONLY       = 0x02,
 149         _DRM_LOCKED          = 0x04, /* shared, cached, locked              */
 150         _DRM_KERNEL          = 0x08, /* kernel requires access              */
 151         _DRM_WRITE_COMBINING = 0x10, /* use write-combining if available    */
 152         _DRM_CONTAINS_LOCK   = 0x20, /* SHM page that contains lock         */
 153         _DRM_REMOVABLE       = 0x40  /* Removable mapping                   */
 154 } drm_map_flags_t;
 155
 156 typedef struct drm_ctx_priv_map {
 157         unsigned int    ctx_id;  /* Context requesting private mapping */
 158         void            *handle; /* Handle of map */
 159 } drm_ctx_priv_map_t;
 160
 161 typedef struct drm_map {
 162         unsigned long   offset;  /* Requested physical address (0 for SAREA)*/
 163         unsigned long   size;    /* Requested physical size (bytes)         */
 164         drm_map_type_t  type;    /* Type of memory to map                   */
 165         drm_map_flags_t flags;   /* Flags                                   */
 166         void            *handle; /* User-space: "Handle" to pass to mmap    */
 167                                  /* Kernel-space: kernel-virtual address    */
 168         int             mtrr;    /* MTRR slot used                          */
 169                                  /* Private data                            */
 170 } drm_map_t;
 171
 172 typedef struct drm_client {
 173         int             idx;    /* Which client desired?                    */
 174         int             auth;   /* Is client authenticated?                 */
 175         unsigned long   pid;    /* Process id                               */
 176         unsigned long   uid;    /* User id                                  */
 177         unsigned long   magic;  /* Magic                                    */
 178         unsigned long   iocs;   /* Ioctl count                              */
 179 } drm_client_t;
 180
 181 typedef enum {
 182         _DRM_STAT_LOCK,
 183         _DRM_STAT_OPENS,
 184         _DRM_STAT_CLOSES,
 185         _DRM_STAT_IOCTLS,
 186         _DRM_STAT_LOCKS,
 187         _DRM_STAT_UNLOCKS,
 188         _DRM_STAT_VALUE,        /* Generic value                      */
 189         _DRM_STAT_BYTE,         /* Generic byte counter (1024bytes/K) */
 190         _DRM_STAT_COUNT,        /* Generic non-byte counter (1000/k)  */
 191
 192         _DRM_STAT_IRQ,          /* IRQ */
 193         _DRM_STAT_PRIMARY,      /* Primary DMA bytes */
 194         _DRM_STAT_SECONDARY,    /* Secondary DMA bytes */
 195         _DRM_STAT_DMA,          /* DMA */
 196         _DRM_STAT_SPECIAL,      /* Special DMA (e.g., priority or polled) */
 197         _DRM_STAT_MISSED        /* Missed DMA opportunity */
 198
 199                                 /* Add to the *END* of the list */
 200 } drm_stat_type_t;
 201
 202 typedef struct drm_stats {
 203         unsigned long count;
 204         struct {
 205                 unsigned long   value;
 206                 drm_stat_type_t type;
 207         } data[15];
 208 } drm_stats_t;
 209
 210 typedef enum drm_lock_flags {
 211         _DRM_LOCK_READY      = 0x01, /* Wait until hardware is ready for DMA */
 212         _DRM_LOCK_QUIESCENT  = 0x02, /* Wait until hardware quiescent        */
 213         _DRM_LOCK_FLUSH      = 0x04, /* Flush this context's DMA queue first */
 214         _DRM_LOCK_FLUSH_ALL  = 0x08, /* Flush all DMA queues first           */
 215                                 /* These *HALT* flags aren't supported yet
 216                                    -- they will be used to support the
 217                                    full-screen DGA-like mode. */
 218         _DRM_HALT_ALL_QUEUES = 0x10, /* Halt all current and future queues   */
 219         _DRM_HALT_CUR_QUEUES = 0x20  /* Halt all current queues              */
 220 } drm_lock_flags_t;
 221
 222 typedef struct drm_lock {
 223         int              context;
 224         drm_lock_flags_t flags;
 225 } drm_lock_t;
 226
 227 typedef enum drm_dma_flags {          /* These values *MUST* match xf86drm.h */
 228                                       /* Flags for DMA buffer dispatch       */
 229         _DRM_DMA_BLOCK        = 0x01, /* Block until buffer dispatched.
 230                                          Note, the buffer may not yet have
 231                                          been processed by the hardware --
 232                                          getting a hardware lock with the
 233                                          hardware quiescent will ensure
 234                                          that the buffer has been
 235                                          processed.                          */
 236         _DRM_DMA_WHILE_LOCKED = 0x02, /* Dispatch while lock held            */
 237         _DRM_DMA_PRIORITY     = 0x04, /* High priority dispatch              */
 238
 239                                       /* Flags for DMA buffer request        */
 240         _DRM_DMA_WAIT         = 0x10, /* Wait for free buffers               */
 241         _DRM_DMA_SMALLER_OK   = 0x20, /* Smaller-than-requested buffers ok   */
 242         _DRM_DMA_LARGER_OK    = 0x40  /* Larger-than-requested buffers ok    */
 243 } drm_dma_flags_t;
 244
 245 typedef struct drm_buf_desc {
 246         int           count;     /* Number of buffers of this size           */
 247         int           size;      /* Size in bytes                            */
 248         int           low_mark;  /* Low water mark                           */
 249         int           high_mark; /* High water mark                          */
 250         enum {
 251                 _DRM_PAGE_ALIGN = 0x01, /* Align on page boundaries for DMA  */
 252                 _DRM_AGP_BUFFER = 0x02, /* Buffer is in agp space            */
 253                 _DRM_SG_BUFFER  = 0x04  /* Scatter/gather memory buffer      */
 254         }             flags;
 255         unsigned long agp_start; /* Start address of where the agp buffers
 256                                   * are in the agp aperture */
 257 } drm_buf_desc_t;
 258
 259 typedef struct drm_buf_info {
 260         int            count;   /* Entries in list                           */
 261         drm_buf_desc_t *list;
 262 } drm_buf_info_t;
 263
 264 typedef struct drm_buf_free {
 265         int            count;
 266         int            *list;
 267 } drm_buf_free_t;
 268
 269 typedef struct drm_buf_pub {
 270         int               idx;         /* Index into master buflist          */
 271         int               total;       /* Buffer size                        */
 272         int               used;        /* Amount of buffer in use (for DMA)  */
 273         void              *address;    /* Address of buffer                  */
 274 } drm_buf_pub_t;
 275
 276 typedef struct drm_buf_map {
 277         int           count;    /* Length of buflist                        */
 278         void          *virtual; /* Mmaped area in user-virtual              */
 279         drm_buf_pub_t *list;    /* Buffer information                       */
 280 } drm_buf_map_t;
 281
 282 typedef struct drm_dma {
 283                                 /* Indices here refer to the offset into
 284                                    buflist in drm_buf_get_t.  */
 285         int             context;          /* Context handle                 */
 286         int             send_count;       /* Number of buffers to send      */
 287         int             *send_indices;    /* List of handles to buffers     */
 288         int             *send_sizes;      /* Lengths of data to send        */
 289         drm_dma_flags_t flags;            /* Flags                          */
 290         int             request_count;    /* Number of buffers requested    */
 291         int             request_size;     /* Desired size for buffers       */
 292         int             *request_indices; /* Buffer information             */
 293         int             *request_sizes;
 294         int             granted_count;    /* Number of buffers granted      */
 295 } drm_dma_t;
 296
 297 typedef enum {
 298         _DRM_CONTEXT_PRESERVED = 0x01,
 299         _DRM_CONTEXT_2DONLY    = 0x02
 300 } drm_ctx_flags_t;
 301
 302 typedef struct drm_ctx {
 303         drm_context_t   handle;
 304         drm_ctx_flags_t flags;
 305 } drm_ctx_t;
 306
 307 typedef struct drm_ctx_res {
 308         int             count;
 309         drm_ctx_t       *contexts;
 310 } drm_ctx_res_t;
 311
 312 typedef struct drm_draw {
 313         drm_drawable_t  handle;
 314 } drm_draw_t;
 315
 316 typedef struct drm_auth {
 317         drm_magic_t     magic;
 318 } drm_auth_t;
 319
 320 typedef struct drm_irq_busid {
 321         int irq;
 322         int busnum;
 323         int devnum;
 324         int funcnum;
 325 } drm_irq_busid_t;
 326
 327 typedef struct drm_agp_mode {
 328         unsigned long mode;
 329 } drm_agp_mode_t;
 330
 331                                 /* For drm_agp_alloc -- allocated a buffer */
 332 typedef struct drm_agp_buffer {
 333         unsigned long size;     /* In bytes -- will round to page boundary */
 334         unsigned long handle;   /* Used for BIND/UNBIND ioctls */
 335         unsigned long type;     /* Type of memory to allocate  */
 336         unsigned long physical; /* Physical used by i810       */
 337 } drm_agp_buffer_t;
 338
 339                                 /* For drm_agp_bind */
 340 typedef struct drm_agp_binding {
 341         unsigned long handle;   /* From drm_agp_buffer */
 342         unsigned long offset;   /* In bytes -- will round to page boundary */
 343 } drm_agp_binding_t;
 344
 345 typedef struct drm_agp_info {
 346         int            agp_version_major;
 347         int            agp_version_minor;
 348         unsigned long  mode;
 349         unsigned long  aperture_base;  /* physical address */
 350         unsigned long  aperture_size;  /* bytes */
 351         unsigned long  memory_allowed; /* bytes */
 352         unsigned long  memory_used;
 353
 354                                 /* PCI information */
 355         unsigned short id_vendor;
 356         unsigned short id_device;
 357 } drm_agp_info_t;
 358
 359 typedef struct drm_scatter_gather {
 360         unsigned long size;     /* In bytes -- will round to page boundary */
 361         unsigned long handle;   /* Used for mapping / unmapping */
 362 } drm_scatter_gather_t;
 363
 364 #define DRM_IOCTL_BASE                  'd'
 365 #define DRM_IO(nr)                      _IO(DRM_IOCTL_BASE,nr)
 366 #define DRM_IOR(nr,size)                _IOR(DRM_IOCTL_BASE,nr,size)
 367 #define DRM_IOW(nr,size)                _IOW(DRM_IOCTL_BASE,nr,size)
 368 #define DRM_IOWR(nr,size)               _IOWR(DRM_IOCTL_BASE,nr,size)
 369
 370
 371 #define DRM_IOCTL_VERSION               DRM_IOWR(0x00, drm_version_t)
 372 #define DRM_IOCTL_GET_UNIQUE            DRM_IOWR(0x01, drm_unique_t)
 373 #define DRM_IOCTL_GET_MAGIC             DRM_IOR( 0x02, drm_auth_t)
 374 #define DRM_IOCTL_IRQ_BUSID             DRM_IOWR(0x03, drm_irq_busid_t)
 375 #define DRM_IOCTL_GET_MAP               DRM_IOWR(0x04, drm_map_t)
 376 #define DRM_IOCTL_GET_CLIENT            DRM_IOWR(0x05, drm_client_t)
 377 #define DRM_IOCTL_GET_STATS             DRM_IOR( 0x06, drm_stats_t)
 378
 379 #define DRM_IOCTL_SET_UNIQUE            DRM_IOW( 0x10, drm_unique_t)
 380 #define DRM_IOCTL_AUTH_MAGIC            DRM_IOW( 0x11, drm_auth_t)
 381 #define DRM_IOCTL_BLOCK                 DRM_IOWR(0x12, drm_block_t)
 382 #define DRM_IOCTL_UNBLOCK               DRM_IOWR(0x13, drm_block_t)
 383 #define DRM_IOCTL_CONTROL               DRM_IOW( 0x14, drm_control_t)
 384 #define DRM_IOCTL_ADD_MAP               DRM_IOWR(0x15, drm_map_t)
 385 #define DRM_IOCTL_ADD_BUFS              DRM_IOWR(0x16, drm_buf_desc_t)
 386 #define DRM_IOCTL_MARK_BUFS             DRM_IOW( 0x17, drm_buf_desc_t)
 387 #define DRM_IOCTL_INFO_BUFS             DRM_IOWR(0x18, drm_buf_info_t)
 388 #define DRM_IOCTL_MAP_BUFS              DRM_IOWR(0x19, drm_buf_map_t)
 389 #define DRM_IOCTL_FREE_BUFS             DRM_IOW( 0x1a, drm_buf_free_t)
 390
 391 #define DRM_IOCTL_RM_MAP                DRM_IOW( 0x1b, drm_map_t)
 392
 393 #define DRM_IOCTL_SET_SAREA_CTX         DRM_IOW( 0x1c, drm_ctx_priv_map_t)
 394 #define DRM_IOCTL_GET_SAREA_CTX         DRM_IOWR(0x1d, drm_ctx_priv_map_t)
 395
 396 #define DRM_IOCTL_ADD_CTX               DRM_IOWR(0x20, drm_ctx_t)
 397 #define DRM_IOCTL_RM_CTX                DRM_IOWR(0x21, drm_ctx_t)
 398 #define DRM_IOCTL_MOD_CTX               DRM_IOW( 0x22, drm_ctx_t)
 399 #define DRM_IOCTL_GET_CTX               DRM_IOWR(0x23, drm_ctx_t)
 400 #define DRM_IOCTL_SWITCH_CTX            DRM_IOW( 0x24, drm_ctx_t)
 401 #define DRM_IOCTL_NEW_CTX               DRM_IOW( 0x25, drm_ctx_t)
 402 #define DRM_IOCTL_RES_CTX               DRM_IOWR(0x26, drm_ctx_res_t)
 403 #define DRM_IOCTL_ADD_DRAW              DRM_IOWR(0x27, drm_draw_t)
 404 #define DRM_IOCTL_RM_DRAW               DRM_IOWR(0x28, drm_draw_t)
 405 #define DRM_IOCTL_DMA                   DRM_IOWR(0x29, drm_dma_t)
 406 #define DRM_IOCTL_LOCK                  DRM_IOW( 0x2a, drm_lock_t)
 407 #define DRM_IOCTL_UNLOCK                DRM_IOW( 0x2b, drm_lock_t)
 408 #define DRM_IOCTL_FINISH                DRM_IOW( 0x2c, drm_lock_t)
 409
 410 #define DRM_IOCTL_AGP_ACQUIRE           DRM_IO(  0x30)
 411 #define DRM_IOCTL_AGP_RELEASE           DRM_IO(  0x31)
 412 #define DRM_IOCTL_AGP_ENABLE            DRM_IOW( 0x32, drm_agp_mode_t)
 413 #define DRM_IOCTL_AGP_INFO              DRM_IOR( 0x33, drm_agp_info_t)
 414 #define DRM_IOCTL_AGP_ALLOC             DRM_IOWR(0x34, drm_agp_buffer_t)
 415 #define DRM_IOCTL_AGP_FREE              DRM_IOW( 0x35, drm_agp_buffer_t)
 416 #define DRM_IOCTL_AGP_BIND              DRM_IOW( 0x36, drm_agp_binding_t)
 417 #define DRM_IOCTL_AGP_UNBIND            DRM_IOW( 0x37, drm_agp_binding_t)
 418
 419 #define DRM_IOCTL_SG_ALLOC              DRM_IOW( 0x38, drm_scatter_gather_t)
 420 #define DRM_IOCTL_SG_FREE               DRM_IOW( 0x39, drm_scatter_gather_t)
 421
 422 /* Device specfic ioctls should only be in their respective headers
 423  * The device specific ioctl range is 0x40 to 0x79.                  */
 424 #define DRM_COMMAND_BASE                0x40
 425
 426 #endif