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  * PRECISION INSIGHT 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 OTHER
  25  * 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 /* $XFree86: xc/programs/Xserver/hw/xfree86/os-support/linux/drm/kernel/drm.h,v 1.9 2000/08/24 22:20:18 tsi Exp $ */
  35
  36 #ifndef _DRM_H_
  37 #define _DRM_H_
  38
  39 #if defined(__linux__)
  40 #include <asm/ioctl.h>          /* For _IO* macros */
  41 #elif defined(__FreeBSD__)
  42 #include <sys/ioccom.h>
  43 #endif
  44
  45 #define DRM_PROC_DEVICES "/proc/devices"
  46 #define DRM_PROC_MISC    "/proc/misc"
  47 #define DRM_PROC_DRM     "/proc/drm"
  48 #define DRM_DEV_DRM      "/dev/drm"
  49 #define DRM_DEV_MODE     (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP)
  50 #define DRM_DEV_UID      0
  51 #define DRM_DEV_GID      0
  52
  53
  54 #define DRM_NAME        "drm"     /* Name in kernel, /dev, and /proc        */
  55 #define DRM_MIN_ORDER   5         /* At least 2^5 bytes = 32 bytes          */
  56 #define DRM_MAX_ORDER   22        /* Up to 2^22 bytes = 4MB                 */
  57 #define DRM_RAM_PERCENT 10        /* How much system ram can we lock?       */
  58
  59 #define _DRM_LOCK_HELD  0x80000000 /* Hardware lock is held                 */
  60 #define _DRM_LOCK_CONT  0x40000000 /* Hardware lock is contended            */
  61 #define _DRM_LOCK_IS_HELD(lock)    ((lock) & _DRM_LOCK_HELD)
  62 #define _DRM_LOCK_IS_CONT(lock)    ((lock) & _DRM_LOCK_CONT)
  63 #define _DRM_LOCKING_CONTEXT(lock) ((lock) & ~(_DRM_LOCK_HELD|_DRM_LOCK_CONT))
  64
  65 typedef unsigned long drm_handle_t;
  66 typedef unsigned int  drm_context_t;
  67 typedef unsigned int  drm_drawable_t;
  68 typedef unsigned int  drm_magic_t;
  69
  70 /* Warning: If you change this structure, make sure you change
  71  * XF86DRIClipRectRec in the server as well */
  72
  73 typedef struct drm_clip_rect {
  74            unsigned short x1;
  75            unsigned short y1;
  76            unsigned short x2;
  77            unsigned short y2;
  78 } drm_clip_rect_t;
  79
  80 /* Seperate include files for the i810/mga/r128 specific structures */
  81 #include "mga_drm.h"
  82 #include "i810_drm.h"
  83 #include "r128_drm.h"
  84
  85 typedef struct drm_version {
  86         int    version_major;     /* Major version                          */
  87         int    version_minor;     /* Minor version                          */
  88         int    version_patchlevel;/* Patch level                            */
  89         size_t name_len;          /* Length of name buffer                  */
  90         char   *name;             /* Name of driver                         */
  91         size_t date_len;          /* Length of date buffer                  */
  92         char   *date;             /* User-space buffer to hold date         */
  93         size_t desc_len;          /* Length of desc buffer                  */
  94         char   *desc;             /* User-space buffer to hold desc         */
  95 } drm_version_t;
  96
  97 typedef struct drm_unique {
  98         size_t unique_len;        /* Length of unique                       */
  99         char   *unique;           /* Unique name for driver instantiation   */
 100 } drm_unique_t;
 101
 102 typedef struct drm_list {
 103         int              count;   /* Length of user-space structures        */
 104         drm_version_t    *version;
 105 } drm_list_t;
 106
 107 typedef struct drm_block {
 108         int              unused;
 109 } drm_block_t;
 110
 111 typedef struct drm_control {
 112         enum {
 113                 DRM_ADD_COMMAND,
 114                 DRM_RM_COMMAND,
 115                 DRM_INST_HANDLER,
 116                 DRM_UNINST_HANDLER
 117         }                func;
 118         int              irq;
 119 } drm_control_t;
 120
 121 typedef enum drm_map_type {
 122         _DRM_FRAME_BUFFER = 0,    /* WC (no caching), no core dump          */
 123         _DRM_REGISTERS    = 1,    /* no caching, no core dump               */
 124         _DRM_SHM          = 2,    /* shared, cached                         */
 125         _DRM_AGP          = 3     /* AGP/GART                               */
 126 } drm_map_type_t;
 127
 128 typedef enum drm_map_flags {
 129         _DRM_RESTRICTED      = 0x01, /* Cannot be mapped to user-virtual    */
 130         _DRM_READ_ONLY       = 0x02,
 131         _DRM_LOCKED          = 0x04, /* shared, cached, locked              */
 132         _DRM_KERNEL          = 0x08, /* kernel requires access              */
 133         _DRM_WRITE_COMBINING = 0x10, /* use write-combining if available    */
 134         _DRM_CONTAINS_LOCK   = 0x20  /* SHM page that contains lock         */
 135 } drm_map_flags_t;
 136
 137 typedef struct drm_map {
 138         unsigned long   offset;  /* Requested physical address (0 for SAREA)*/
 139         unsigned long   size;    /* Requested physical size (bytes)         */
 140         drm_map_type_t  type;    /* Type of memory to map                   */
 141         drm_map_flags_t flags;   /* Flags                                   */
 142         void            *handle; /* User-space: "Handle" to pass to mmap    */
 143                                  /* Kernel-space: kernel-virtual address    */
 144         int             mtrr;    /* MTRR slot used                          */
 145                                  /* Private data                            */
 146 } drm_map_t;
 147
 148 typedef enum drm_lock_flags {
 149         _DRM_LOCK_READY      = 0x01, /* Wait until hardware is ready for DMA */
 150         _DRM_LOCK_QUIESCENT  = 0x02, /* Wait until hardware quiescent        */
 151         _DRM_LOCK_FLUSH      = 0x04, /* Flush this context's DMA queue first */
 152         _DRM_LOCK_FLUSH_ALL  = 0x08, /* Flush all DMA queues first           */
 153                                 /* These *HALT* flags aren't supported yet
 154                                    -- they will be used to support the
 155                                    full-screen DGA-like mode. */
 156         _DRM_HALT_ALL_QUEUES = 0x10, /* Halt all current and future queues   */
 157         _DRM_HALT_CUR_QUEUES = 0x20  /* Halt all current queues              */
 158 } drm_lock_flags_t;
 159
 160 typedef struct drm_lock {
 161         int              context;
 162         drm_lock_flags_t flags;
 163 } drm_lock_t;
 164
 165 typedef enum drm_dma_flags {          /* These values *MUST* match xf86drm.h */
 166                                       /* Flags for DMA buffer dispatch       */
 167         _DRM_DMA_BLOCK        = 0x01, /* Block until buffer dispatched.
 168                                          Note, the buffer may not yet have
 169                                          been processed by the hardware --
 170                                          getting a hardware lock with the
 171                                          hardware quiescent will ensure
 172                                          that the buffer has been
 173                                          processed.                          */
 174         _DRM_DMA_WHILE_LOCKED = 0x02, /* Dispatch while lock held            */
 175         _DRM_DMA_PRIORITY     = 0x04, /* High priority dispatch              */
 176
 177                                       /* Flags for DMA buffer request        */
 178         _DRM_DMA_WAIT         = 0x10, /* Wait for free buffers               */
 179         _DRM_DMA_SMALLER_OK   = 0x20, /* Smaller-than-requested buffers ok   */
 180         _DRM_DMA_LARGER_OK    = 0x40  /* Larger-than-requested buffers ok    */
 181 } drm_dma_flags_t;
 182
 183 typedef struct drm_buf_desc {
 184         int           count;     /* Number of buffers of this size           */
 185         int           size;      /* Size in bytes                            */
 186         int           low_mark;  /* Low water mark                           */
 187         int           high_mark; /* High water mark                          */
 188         enum {
 189                 _DRM_PAGE_ALIGN = 0x01, /* Align on page boundaries for DMA  */
 190                 _DRM_AGP_BUFFER = 0x02  /* Buffer is in agp space            */
 191         }             flags;
 192         unsigned long agp_start; /* Start address of where the agp buffers
 193                                   * are in the agp aperture */
 194 } drm_buf_desc_t;
 195
 196 typedef struct drm_buf_info {
 197         int            count;   /* Entries in list                           */
 198         drm_buf_desc_t *list;
 199 } drm_buf_info_t;
 200
 201 typedef struct drm_buf_free {
 202         int            count;
 203         int            *list;
 204 } drm_buf_free_t;
 205
 206 typedef struct drm_buf_pub {
 207         int               idx;         /* Index into master buflist          */
 208         int               total;       /* Buffer size                        */
 209         int               used;        /* Amount of buffer in use (for DMA)  */
 210         void              *address;    /* Address of buffer                  */
 211 } drm_buf_pub_t;
 212
 213 typedef struct drm_buf_map {
 214         int           count;    /* Length of buflist                        */
 215         void          *virtual; /* Mmaped area in user-virtual              */
 216         drm_buf_pub_t *list;    /* Buffer information                       */
 217 } drm_buf_map_t;
 218
 219 typedef struct drm_dma {
 220                                 /* Indices here refer to the offset into
 221                                    buflist in drm_buf_get_t.  */
 222         int             context;          /* Context handle                 */
 223         int             send_count;       /* Number of buffers to send      */
 224         int             *send_indices;    /* List of handles to buffers     */
 225         int             *send_sizes;      /* Lengths of data to send        */
 226         drm_dma_flags_t flags;            /* Flags                          */
 227         int             request_count;    /* Number of buffers requested    */
 228         int             request_size;     /* Desired size for buffers       */
 229         int             *request_indices; /* Buffer information             */
 230         int             *request_sizes;
 231         int             granted_count;    /* Number of buffers granted      */
 232 } drm_dma_t;
 233
 234 typedef enum {
 235         _DRM_CONTEXT_PRESERVED = 0x01,
 236         _DRM_CONTEXT_2DONLY    = 0x02
 237 } drm_ctx_flags_t;
 238
 239 typedef struct drm_ctx {
 240         drm_context_t   handle;
 241         drm_ctx_flags_t flags;
 242 } drm_ctx_t;
 243
 244 typedef struct drm_ctx_res {
 245         int             count;
 246         drm_ctx_t       *contexts;
 247 } drm_ctx_res_t;
 248
 249 typedef struct drm_draw {
 250         drm_drawable_t  handle;
 251 } drm_draw_t;
 252
 253 typedef struct drm_auth {
 254         drm_magic_t     magic;
 255 } drm_auth_t;
 256
 257 typedef struct drm_irq_busid {
 258         int irq;
 259         int busnum;
 260         int devnum;
 261         int funcnum;
 262 } drm_irq_busid_t;
 263
 264 typedef struct drm_agp_mode {
 265         unsigned long mode;
 266 } drm_agp_mode_t;
 267
 268                                 /* For drm_agp_alloc -- allocated a buffer */
 269 typedef struct drm_agp_buffer {
 270         unsigned long size;     /* In bytes -- will round to page boundary */
 271         unsigned long handle;   /* Used for BIND/UNBIND ioctls */
 272         unsigned long type;     /* Type of memory to allocate  */
 273         unsigned long physical; /* Physical used by i810       */
 274 } drm_agp_buffer_t;
 275
 276                                 /* For drm_agp_bind */
 277 typedef struct drm_agp_binding {
 278         unsigned long handle;   /* From drm_agp_buffer */
 279         unsigned long offset;   /* In bytes -- will round to page boundary */
 280 } drm_agp_binding_t;
 281
 282 typedef struct drm_agp_info {
 283         int            agp_version_major;
 284         int            agp_version_minor;
 285         unsigned long  mode;
 286         unsigned long  aperture_base;  /* physical address */
 287         unsigned long  aperture_size;  /* bytes */
 288         unsigned long  memory_allowed; /* bytes */
 289         unsigned long  memory_used;
 290
 291                                 /* PCI information */
 292         unsigned short id_vendor;
 293         unsigned short id_device;
 294 } drm_agp_info_t;
 295
 296 #define DRM_IOCTL_BASE       'd'
 297 #if defined(__linux__)
 298 #define DRM_IOCTL_NR(n)      _IOC_NR(n)
 299 #elif defined(__FreeBSD__)
 300 #define DRM_IOCTL_NR(n)      ((n) & 0xff)
 301 #endif
 302 #define DRM_IO(nr)           _IO(DRM_IOCTL_BASE,nr)
 303 #define DRM_IOR(nr,size)     _IOR(DRM_IOCTL_BASE,nr,size)
 304 #define DRM_IOW(nr,size)     _IOW(DRM_IOCTL_BASE,nr,size)
 305 #define DRM_IOWR(nr,size)    _IOWR(DRM_IOCTL_BASE,nr,size)
 306
 307
 308 #define DRM_IOCTL_VERSION    DRM_IOWR(0x00, drm_version_t)
 309 #define DRM_IOCTL_GET_UNIQUE DRM_IOWR(0x01, drm_unique_t)
 310 #define DRM_IOCTL_GET_MAGIC  DRM_IOR( 0x02, drm_auth_t)
 311 #define DRM_IOCTL_IRQ_BUSID  DRM_IOWR(0x03, drm_irq_busid_t)
 312
 313 #define DRM_IOCTL_SET_UNIQUE DRM_IOW( 0x10, drm_unique_t)
 314 #define DRM_IOCTL_AUTH_MAGIC DRM_IOW( 0x11, drm_auth_t)
 315 #define DRM_IOCTL_BLOCK      DRM_IOWR(0x12, drm_block_t)
 316 #define DRM_IOCTL_UNBLOCK    DRM_IOWR(0x13, drm_block_t)
 317 #define DRM_IOCTL_CONTROL    DRM_IOW( 0x14, drm_control_t)
 318 #define DRM_IOCTL_ADD_MAP    DRM_IOWR(0x15, drm_map_t)
 319 #define DRM_IOCTL_ADD_BUFS   DRM_IOWR(0x16, drm_buf_desc_t)
 320 #define DRM_IOCTL_MARK_BUFS  DRM_IOW( 0x17, drm_buf_desc_t)
 321 #define DRM_IOCTL_INFO_BUFS  DRM_IOWR(0x18, drm_buf_info_t)
 322 #define DRM_IOCTL_MAP_BUFS   DRM_IOWR(0x19, drm_buf_map_t)
 323 #define DRM_IOCTL_FREE_BUFS  DRM_IOW( 0x1a, drm_buf_free_t)
 324
 325 #define DRM_IOCTL_ADD_CTX    DRM_IOWR(0x20, drm_ctx_t)
 326 #define DRM_IOCTL_RM_CTX     DRM_IOWR(0x21, drm_ctx_t)
 327 #define DRM_IOCTL_MOD_CTX    DRM_IOW( 0x22, drm_ctx_t)
 328 #define DRM_IOCTL_GET_CTX    DRM_IOWR(0x23, drm_ctx_t)
 329 #define DRM_IOCTL_SWITCH_CTX DRM_IOW( 0x24, drm_ctx_t)
 330 #define DRM_IOCTL_NEW_CTX    DRM_IOW( 0x25, drm_ctx_t)
 331 #define DRM_IOCTL_RES_CTX    DRM_IOWR(0x26, drm_ctx_res_t)
 332 #define DRM_IOCTL_ADD_DRAW   DRM_IOWR(0x27, drm_draw_t)
 333 #define DRM_IOCTL_RM_DRAW    DRM_IOWR(0x28, drm_draw_t)
 334 #define DRM_IOCTL_DMA        DRM_IOWR(0x29, drm_dma_t)
 335 #define DRM_IOCTL_LOCK       DRM_IOW( 0x2a, drm_lock_t)
 336 #define DRM_IOCTL_UNLOCK     DRM_IOW( 0x2b, drm_lock_t)
 337 #define DRM_IOCTL_FINISH     DRM_IOW( 0x2c, drm_lock_t)
 338
 339 #define DRM_IOCTL_AGP_ACQUIRE DRM_IO(  0x30)
 340 #define DRM_IOCTL_AGP_RELEASE DRM_IO(  0x31)
 341 #define DRM_IOCTL_AGP_ENABLE  DRM_IOW( 0x32, drm_agp_mode_t)
 342 #define DRM_IOCTL_AGP_INFO    DRM_IOR( 0x33, drm_agp_info_t)
 343 #define DRM_IOCTL_AGP_ALLOC   DRM_IOWR(0x34, drm_agp_buffer_t)
 344 #define DRM_IOCTL_AGP_FREE    DRM_IOW( 0x35, drm_agp_buffer_t)
 345 #define DRM_IOCTL_AGP_BIND    DRM_IOW( 0x36, drm_agp_binding_t)
 346 #define DRM_IOCTL_AGP_UNBIND  DRM_IOW( 0x37, drm_agp_binding_t)
 347
 348 /* Mga specific ioctls */
 349 #define DRM_IOCTL_MGA_INIT    DRM_IOW( 0x40, drm_mga_init_t)
 350 #define DRM_IOCTL_MGA_SWAP    DRM_IOW( 0x41, drm_mga_swap_t)
 351 #define DRM_IOCTL_MGA_CLEAR   DRM_IOW( 0x42, drm_mga_clear_t)
 352 #define DRM_IOCTL_MGA_ILOAD   DRM_IOW( 0x43, drm_mga_iload_t)
 353 #define DRM_IOCTL_MGA_VERTEX  DRM_IOW( 0x44, drm_mga_vertex_t)
 354 #define DRM_IOCTL_MGA_FLUSH   DRM_IOW( 0x45, drm_lock_t )
 355 #define DRM_IOCTL_MGA_INDICES DRM_IOW( 0x46, drm_mga_indices_t)
 356
 357 /* I810 specific ioctls */
 358 #define DRM_IOCTL_I810_INIT    DRM_IOW( 0x40, drm_i810_init_t)
 359 #define DRM_IOCTL_I810_VERTEX  DRM_IOW( 0x41, drm_i810_vertex_t)
 360 #define DRM_IOCTL_I810_CLEAR   DRM_IOW( 0x42, drm_i810_clear_t)
 361 #define DRM_IOCTL_I810_FLUSH   DRM_IO ( 0x43)
 362 #define DRM_IOCTL_I810_GETAGE  DRM_IO ( 0x44)
 363 #define DRM_IOCTL_I810_GETBUF  DRM_IOWR(0x45, drm_i810_dma_t)
 364 #define DRM_IOCTL_I810_SWAP    DRM_IO ( 0x46)
 365 #define DRM_IOCTL_I810_COPY    DRM_IOW( 0x47, drm_i810_copy_t)
 366 #define DRM_IOCTL_I810_DOCOPY  DRM_IO ( 0x48)
 367
 368 /* Rage 128 specific ioctls */
 369 #define DRM_IOCTL_R128_INIT     DRM_IOW( 0x40, drm_r128_init_t)
 370 #define DRM_IOCTL_R128_RESET    DRM_IO(  0x41)
 371 #define DRM_IOCTL_R128_FLUSH    DRM_IO(  0x42)
 372 #define DRM_IOCTL_R128_IDLE     DRM_IO(  0x43)
 373 #define DRM_IOCTL_R128_PACKET   DRM_IOW( 0x44, drm_r128_packet_t)
 374 #define DRM_IOCTL_R128_VERTEX   DRM_IOW( 0x45, drm_r128_vertex_t)
 375
 376 #endif