drivers/char/drm/drmP.h

   1 /**
   2  * \file drmP.h
   3  * Private header for Direct Rendering Manager
   4  *
   5  * \author Rickard E. (Rik) Faith <faith@valinux.com>
   6  * \author Gareth Hughes <gareth@valinux.com>
   7  */
   8
   9 /*
  10  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
  11  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
  12  * All rights reserved.
  13  *
  14  * Permission is hereby granted, free of charge, to any person obtaining a
  15  * copy of this software and associated documentation files (the "Software"),
  16  * to deal in the Software without restriction, including without limitation
  17  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  18  * and/or sell copies of the Software, and to permit persons to whom the
  19  * Software is furnished to do so, subject to the following conditions:
  20  *
  21  * The above copyright notice and this permission notice (including the next
  22  * paragraph) shall be included in all copies or substantial portions of the
  23  * Software.
  24  *
  25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  26  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  27  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  28  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  29  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  30  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  31  * OTHER DEALINGS IN THE SOFTWARE.
  32  */
  33
  34 #ifndef _DRM_P_H_
  35 #define _DRM_P_H_
  36
  37 /* If you want the memory alloc debug functionality, change define below */
  38 /* #define DEBUG_MEMORY */
  39
  40 #ifdef __KERNEL__
  41 #ifdef __alpha__
  42 /* add include of current.h so that "current" is defined
  43  * before static inline funcs in wait.h. Doing this so we
  44  * can build the DRM (part of PI DRI). 4/21/2000 S + B */
  45 #include <asm/current.h>
  46 #endif                          /* __alpha__ */
  47 #include <linux/module.h>
  48 #include <linux/kernel.h>
  49 #include <linux/miscdevice.h>
  50 #include <linux/fs.h>
  51 #include <linux/proc_fs.h>
  52 #include <linux/init.h>
  53 #include <linux/file.h>
  54 #include <linux/pci.h>
  55 #include <linux/jiffies.h>
  56 #include <linux/smp_lock.h>     /* For (un)lock_kernel */
  57 #include <linux/mm.h>
  58 #include <linux/cdev.h>
  59 #include <linux/mutex.h>
  60 #if defined(__alpha__) || defined(__powerpc__)
  61 #include <asm/pgtable.h>        /* For pte_wrprotect */
  62 #endif
  63 #include <asm/io.h>
  64 #include <asm/mman.h>
  65 #include <asm/uaccess.h>
  66 #ifdef CONFIG_MTRR
  67 #include <asm/mtrr.h>
  68 #endif
  69 #if defined(CONFIG_AGP) || defined(CONFIG_AGP_MODULE)
  70 #include <linux/types.h>
  71 #include <linux/agp_backend.h>
  72 #endif
  73 #include <linux/workqueue.h>
  74 #include <linux/poll.h>
  75 #include <asm/pgalloc.h>
  76 #include "drm.h"
  77
  78 #define __OS_HAS_AGP (defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE)))
  79 #define __OS_HAS_MTRR (defined(CONFIG_MTRR))
  80
  81 #include "drm_os_linux.h"
  82
  83 /***********************************************************************/
  84 /** \name DRM template customization defaults */
  85 /*@{*/
  86
  87 /* driver capabilities and requirements mask */
  88 #define DRIVER_USE_AGP     0x1
  89 #define DRIVER_REQUIRE_AGP 0x2
  90 #define DRIVER_USE_MTRR    0x4
  91 #define DRIVER_PCI_DMA     0x8
  92 #define DRIVER_SG          0x10
  93 #define DRIVER_HAVE_DMA    0x20
  94 #define DRIVER_HAVE_IRQ    0x40
  95 #define DRIVER_IRQ_SHARED  0x80
  96 #define DRIVER_IRQ_VBL     0x100
  97 #define DRIVER_DMA_QUEUE   0x200
  98 #define DRIVER_FB_DMA      0x400
  99
 100 /***********************************************************************/
 101 /** \name Begin the DRM... */
 102 /*@{*/
 103
 104 #define DRM_DEBUG_CODE 2          /**< Include debugging code if > 1, then
 105                                      also include looping detection. */
 106
 107 #define DRM_HASH_SIZE         16 /**< Size of key hash table. Must be power of 2. */
 108 #define DRM_KERNEL_CONTEXT    0  /**< Change drm_resctx if changed */
 109 #define DRM_RESERVED_CONTEXTS 1  /**< Change drm_resctx if changed */
 110 #define DRM_LOOPING_LIMIT     5000000
 111 #define DRM_TIME_SLICE        (HZ/20)  /**< Time slice for GLXContexts */
 112 #define DRM_LOCK_SLICE        1 /**< Time slice for lock, in jiffies */
 113
 114 #define DRM_FLAG_DEBUG    0x01
 115
 116 #define DRM_MEM_DMA        0
 117 #define DRM_MEM_SAREA      1
 118 #define DRM_MEM_DRIVER     2
 119 #define DRM_MEM_MAGIC      3
 120 #define DRM_MEM_IOCTLS     4
 121 #define DRM_MEM_MAPS       5
 122 #define DRM_MEM_VMAS       6
 123 #define DRM_MEM_BUFS       7
 124 #define DRM_MEM_SEGS       8
 125 #define DRM_MEM_PAGES      9
 126 #define DRM_MEM_FILES     10
 127 #define DRM_MEM_QUEUES    11
 128 #define DRM_MEM_CMDS      12
 129 #define DRM_MEM_MAPPINGS  13
 130 #define DRM_MEM_BUFLISTS  14
 131 #define DRM_MEM_AGPLISTS  15
 132 #define DRM_MEM_TOTALAGP  16
 133 #define DRM_MEM_BOUNDAGP  17
 134 #define DRM_MEM_CTXBITMAP 18
 135 #define DRM_MEM_STUB      19
 136 #define DRM_MEM_SGLISTS   20
 137 #define DRM_MEM_CTXLIST  21
 138
 139 #define DRM_MAX_CTXBITMAP (PAGE_SIZE * 8)
 140
 141 /*@}*/
 142
 143 /***********************************************************************/
 144 /** \name Macros to make printk easier */
 145 /*@{*/
 146
 147 /**
 148  * Error output.
 149  *
 150  * \param fmt printf() like format string.
 151  * \param arg arguments
 152  */
 153 #define DRM_ERROR(fmt, arg...) \
 154         printk(KERN_ERR "[" DRM_NAME ":%s] *ERROR* " fmt , __FUNCTION__ , ##arg)
 155
 156 /**
 157  * Memory error output.
 158  *
 159  * \param area memory area where the error occurred.
 160  * \param fmt printf() like format string.
 161  * \param arg arguments
 162  */
 163 #define DRM_MEM_ERROR(area, fmt, arg...) \
 164         printk(KERN_ERR "[" DRM_NAME ":%s:%s] *ERROR* " fmt , __FUNCTION__, \
 165                drm_mem_stats[area].name , ##arg)
 166
 167 #define DRM_INFO(fmt, arg...)  printk(KERN_INFO "[" DRM_NAME "] " fmt , ##arg)
 168
 169 /**
 170  * Debug output.
 171  *
 172  * \param fmt printf() like format string.
 173  * \param arg arguments
 174  */
 175 #if DRM_DEBUG_CODE
 176 #define DRM_DEBUG(fmt, arg...)                                          \
 177         do {                                                            \
 178                 if ( drm_debug )                        \
 179                         printk(KERN_DEBUG                               \
 180                                "[" DRM_NAME ":%s] " fmt ,       \
 181                                __FUNCTION__ , ##arg);                   \
 182         } while (0)
 183 #else
 184 #define DRM_DEBUG(fmt, arg...)           do { } while (0)
 185 #endif
 186
 187 #define DRM_PROC_LIMIT (PAGE_SIZE-80)
 188
 189 #define DRM_PROC_PRINT(fmt, arg...)                                     \
 190    len += sprintf(&buf[len], fmt , ##arg);                              \
 191    if (len > DRM_PROC_LIMIT) { *eof = 1; return len - offset; }
 192
 193 #define DRM_PROC_PRINT_RET(ret, fmt, arg...)                            \
 194    len += sprintf(&buf[len], fmt , ##arg);                              \
 195    if (len > DRM_PROC_LIMIT) { ret; *eof = 1; return len - offset; }
 196
 197 /*@}*/
 198
 199 /***********************************************************************/
 200 /** \name Internal types and structures */
 201 /*@{*/
 202
 203 #define DRM_ARRAY_SIZE(x) ARRAY_SIZE(x)
 204
 205 #define DRM_LEFTCOUNT(x) (((x)->rp + (x)->count - (x)->wp) % ((x)->count + 1))
 206 #define DRM_BUFCOUNT(x) ((x)->count - DRM_LEFTCOUNT(x))
 207 #define DRM_WAITCOUNT(dev,idx) DRM_BUFCOUNT(&dev->queuelist[idx]->waitlist)
 208
 209 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
 210 /**
 211  * Get the private SAREA mapping.
 212  *
 213  * \param _dev DRM device.
 214  * \param _ctx context number.
 215  * \param _map output mapping.
 216  */
 217 #define DRM_GET_PRIV_SAREA(_dev, _ctx, _map) do {       \
 218         (_map) = (_dev)->context_sareas[_ctx];          \
 219 } while(0)
 220
 221 /**
 222  * Test that the hardware lock is held by the caller, returning otherwise.
 223  *
 224  * \param dev DRM device.
 225  * \param filp file pointer of the caller.
 226  */
 227 #define LOCK_TEST_WITH_RETURN( dev, filp )                              \
 228 do {                                                                    \
 229         if ( !_DRM_LOCK_IS_HELD( dev->lock.hw_lock->lock ) ||           \
 230              dev->lock.filp != filp ) {                         \
 231                 DRM_ERROR( "%s called without lock held\n",             \
 232                            __FUNCTION__ );                              \
 233                 return -EINVAL;                                         \
 234         }                                                               \
 235 } while (0)
 236
 237 /**
 238  * Copy and IOCTL return string to user space
 239  */
 240 #define DRM_COPY( name, value )                                         \
 241         len = strlen( value );                                          \
 242         if ( len > name##_len ) len = name##_len;                       \
 243         name##_len = strlen( value );                                   \
 244         if ( len && name ) {                                            \
 245                 if ( copy_to_user( name, value, len ) )                 \
 246                         return -EFAULT;                                 \
 247         }
 248
 249 /**
 250  * Ioctl function type.
 251  *
 252  * \param inode device inode.
 253  * \param filp file pointer.
 254  * \param cmd command.
 255  * \param arg argument.
 256  */
 257 typedef int drm_ioctl_t(struct inode *inode, struct file *filp,
 258                         unsigned int cmd, unsigned long arg);
 259
 260 typedef int drm_ioctl_compat_t(struct file *filp, unsigned int cmd,
 261                                unsigned long arg);
 262
 263 #define DRM_AUTH        0x1
 264 #define DRM_MASTER      0x2
 265 #define DRM_ROOT_ONLY   0x4
 266
 267 typedef struct drm_ioctl_desc {
 268         drm_ioctl_t *func;
 269         int flags;
 270 } drm_ioctl_desc_t;
 271
 272 typedef struct drm_devstate {
 273         pid_t owner;                    /**< X server pid holding x_lock */
 274 } drm_devstate_t;
 275
 276 typedef struct drm_magic_entry {
 277         drm_magic_t magic;
 278         struct drm_file *priv;
 279         struct drm_magic_entry *next;
 280 } drm_magic_entry_t;
 281
 282 typedef struct drm_magic_head {
 283         struct drm_magic_entry *head;
 284         struct drm_magic_entry *tail;
 285 } drm_magic_head_t;
 286
 287 typedef struct drm_vma_entry {
 288         struct vm_area_struct *vma;
 289         struct drm_vma_entry *next;
 290         pid_t pid;
 291 } drm_vma_entry_t;
 292
 293 /**
 294  * DMA buffer.
 295  */
 296 typedef struct drm_buf {
 297         int idx;                       /**< Index into master buflist */
 298         int total;                     /**< Buffer size */
 299         int order;                     /**< log-base-2(total) */
 300         int used;                      /**< Amount of buffer in use (for DMA) */
 301         unsigned long offset;          /**< Byte offset (used internally) */
 302         void *address;                 /**< Address of buffer */
 303         unsigned long bus_address;     /**< Bus address of buffer */
 304         struct drm_buf *next;          /**< Kernel-only: used for free list */
 305         __volatile__ int waiting;      /**< On kernel DMA queue */
 306         __volatile__ int pending;      /**< On hardware DMA queue */
 307         wait_queue_head_t dma_wait;    /**< Processes waiting */
 308         struct file *filp;             /**< Pointer to holding file descr */
 309         int context;                   /**< Kernel queue for this buffer */
 310         int while_locked;              /**< Dispatch this buffer while locked */
 311         enum {
 312                 DRM_LIST_NONE = 0,
 313                 DRM_LIST_FREE = 1,
 314                 DRM_LIST_WAIT = 2,
 315                 DRM_LIST_PEND = 3,
 316                 DRM_LIST_PRIO = 4,
 317                 DRM_LIST_RECLAIM = 5
 318         } list;                        /**< Which list we're on */
 319
 320         int dev_priv_size;               /**< Size of buffer private storage */
 321         void *dev_private;               /**< Per-buffer private storage */
 322 } drm_buf_t;
 323
 324 /** bufs is one longer than it has to be */
 325 typedef struct drm_waitlist {
 326         int count;                      /**< Number of possible buffers */
 327         drm_buf_t **bufs;               /**< List of pointers to buffers */
 328         drm_buf_t **rp;                 /**< Read pointer */
 329         drm_buf_t **wp;                 /**< Write pointer */
 330         drm_buf_t **end;                /**< End pointer */
 331         spinlock_t read_lock;
 332         spinlock_t write_lock;
 333 } drm_waitlist_t;
 334
 335 typedef struct drm_freelist {
 336         int initialized;               /**< Freelist in use */
 337         atomic_t count;                /**< Number of free buffers */
 338         drm_buf_t *next;               /**< End pointer */
 339
 340         wait_queue_head_t waiting;     /**< Processes waiting on free bufs */
 341         int low_mark;                  /**< Low water mark */
 342         int high_mark;                 /**< High water mark */
 343         atomic_t wfh;                  /**< If waiting for high mark */
 344         spinlock_t lock;
 345 } drm_freelist_t;
 346
 347 typedef struct drm_dma_handle {
 348         dma_addr_t busaddr;
 349         void *vaddr;
 350         size_t size;
 351 } drm_dma_handle_t;
 352
 353 /**
 354  * Buffer entry.  There is one of this for each buffer size order.
 355  */
 356 typedef struct drm_buf_entry {
 357         int buf_size;                   /**< size */
 358         int buf_count;                  /**< number of buffers */
 359         drm_buf_t *buflist;             /**< buffer list */
 360         int seg_count;
 361         int page_order;
 362         drm_dma_handle_t **seglist;
 363
 364         drm_freelist_t freelist;
 365 } drm_buf_entry_t;
 366
 367 /** File private data */
 368 typedef struct drm_file {
 369         int authenticated;
 370         int master;
 371         int minor;
 372         pid_t pid;
 373         uid_t uid;
 374         drm_magic_t magic;
 375         unsigned long ioctl_count;
 376         struct drm_file *next;
 377         struct drm_file *prev;
 378         struct drm_head *head;
 379         int remove_auth_on_close;
 380         unsigned long lock_count;
 381         void *driver_priv;
 382 } drm_file_t;
 383
 384 /** Wait queue */
 385 typedef struct drm_queue {
 386         atomic_t use_count;             /**< Outstanding uses (+1) */
 387         atomic_t finalization;          /**< Finalization in progress */
 388         atomic_t block_count;           /**< Count of processes waiting */
 389         atomic_t block_read;            /**< Queue blocked for reads */
 390         wait_queue_head_t read_queue;   /**< Processes waiting on block_read */
 391         atomic_t block_write;           /**< Queue blocked for writes */
 392         wait_queue_head_t write_queue;  /**< Processes waiting on block_write */
 393 #if 1
 394         atomic_t total_queued;          /**< Total queued statistic */
 395         atomic_t total_flushed;         /**< Total flushes statistic */
 396         atomic_t total_locks;           /**< Total locks statistics */
 397 #endif
 398         drm_ctx_flags_t flags;          /**< Context preserving and 2D-only */
 399         drm_waitlist_t waitlist;        /**< Pending buffers */
 400         wait_queue_head_t flush_queue;  /**< Processes waiting until flush */
 401 } drm_queue_t;
 402
 403 /**
 404  * Lock data.
 405  */
 406 typedef struct drm_lock_data {
 407         drm_hw_lock_t *hw_lock;         /**< Hardware lock */
 408         struct file *filp;              /**< File descr of lock holder (0=kernel) */
 409         wait_queue_head_t lock_queue;   /**< Queue of blocked processes */
 410         unsigned long lock_time;        /**< Time of last lock in jiffies */
 411 } drm_lock_data_t;
 412
 413 /**
 414  * DMA data.
 415  */
 416 typedef struct drm_device_dma {
 417
 418         drm_buf_entry_t bufs[DRM_MAX_ORDER + 1];        /**< buffers, grouped by their size order */
 419         int buf_count;                  /**< total number of buffers */
 420         drm_buf_t **buflist;            /**< Vector of pointers into drm_device_dma::bufs */
 421         int seg_count;
 422         int page_count;                 /**< number of pages */
 423         unsigned long *pagelist;        /**< page list */
 424         unsigned long byte_count;
 425         enum {
 426                 _DRM_DMA_USE_AGP = 0x01,
 427                 _DRM_DMA_USE_SG = 0x02,
 428                 _DRM_DMA_USE_FB = 0x04
 429         } flags;
 430
 431 } drm_device_dma_t;
 432
 433 /**
 434  * AGP memory entry.  Stored as a doubly linked list.
 435  */
 436 typedef struct drm_agp_mem {
 437         unsigned long handle;           /**< handle */
 438         DRM_AGP_MEM *memory;
 439         unsigned long bound;            /**< address */
 440         int pages;
 441         struct drm_agp_mem *prev;       /**< previous entry */
 442         struct drm_agp_mem *next;       /**< next entry */
 443 } drm_agp_mem_t;
 444
 445 /**
 446  * AGP data.
 447  *
 448  * \sa drm_agp_init() and drm_device::agp.
 449  */
 450 typedef struct drm_agp_head {
 451         DRM_AGP_KERN agp_info;          /**< AGP device information */
 452         drm_agp_mem_t *memory;          /**< memory entries */
 453         unsigned long mode;             /**< AGP mode */
 454         struct agp_bridge_data *bridge;
 455         int enabled;                    /**< whether the AGP bus as been enabled */
 456         int acquired;                   /**< whether the AGP device has been acquired */
 457         unsigned long base;
 458         int agp_mtrr;
 459         int cant_use_aperture;
 460         unsigned long page_mask;
 461 } drm_agp_head_t;
 462
 463 /**
 464  * Scatter-gather memory.
 465  */
 466 typedef struct drm_sg_mem {
 467         unsigned long handle;
 468         void *virtual;
 469         int pages;
 470         struct page **pagelist;
 471         dma_addr_t *busaddr;
 472 } drm_sg_mem_t;
 473
 474 typedef struct drm_sigdata {
 475         int context;
 476         drm_hw_lock_t *lock;
 477 } drm_sigdata_t;
 478
 479 /**
 480  * Mappings list
 481  */
 482 typedef struct drm_map_list {
 483         struct list_head head;          /**< list head */
 484         drm_map_t *map;                 /**< mapping */
 485         unsigned int user_token;
 486 } drm_map_list_t;
 487
 488 typedef drm_map_t drm_local_map_t;
 489
 490 /**
 491  * Context handle list
 492  */
 493 typedef struct drm_ctx_list {
 494         struct list_head head;          /**< list head */
 495         drm_context_t handle;           /**< context handle */
 496         drm_file_t *tag;                /**< associated fd private data */
 497 } drm_ctx_list_t;
 498
 499 typedef struct drm_vbl_sig {
 500         struct list_head head;
 501         unsigned int sequence;
 502         struct siginfo info;
 503         struct task_struct *task;
 504 } drm_vbl_sig_t;
 505
 506 /* location of GART table */
 507 #define DRM_ATI_GART_MAIN 1
 508 #define DRM_ATI_GART_FB   2
 509
 510 typedef struct ati_pcigart_info {
 511         int gart_table_location;
 512         int is_pcie;
 513         void *addr;
 514         dma_addr_t bus_addr;
 515         drm_local_map_t mapping;
 516 } drm_ati_pcigart_info;
 517
 518 /**
 519  * DRM driver structure. This structure represent the common code for
 520  * a family of cards. There will one drm_device for each card present
 521  * in this family
 522  */
 523 struct drm_device;
 524
 525 struct drm_driver {
 526         int (*load) (struct drm_device *, unsigned long flags);
 527         int (*firstopen) (struct drm_device *);
 528         int (*open) (struct drm_device *, drm_file_t *);
 529         void (*preclose) (struct drm_device *, struct file * filp);
 530         void (*postclose) (struct drm_device *, drm_file_t *);
 531         void (*lastclose) (struct drm_device *);
 532         int (*unload) (struct drm_device *);
 533         int (*dma_ioctl) (DRM_IOCTL_ARGS);
 534         void (*dma_ready) (struct drm_device *);
 535         int (*dma_quiescent) (struct drm_device *);
 536         int (*context_ctor) (struct drm_device * dev, int context);
 537         int (*context_dtor) (struct drm_device * dev, int context);
 538         int (*kernel_context_switch) (struct drm_device * dev, int old,
 539                                       int new);
 540         void (*kernel_context_switch_unlock) (struct drm_device * dev,
 541                                               drm_lock_t *lock);
 542         int (*vblank_wait) (struct drm_device * dev, unsigned int *sequence);
 543         int (*dri_library_name) (struct drm_device *dev, char *buf);
 544
 545         /**
 546          * Called by \c drm_device_is_agp.  Typically used to determine if a
 547          * card is really attached to AGP or not.
 548          *
 549          * \param dev  DRM device handle
 550          *
 551          * \returns
 552          * One of three values is returned depending on whether or not the
 553          * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
 554          * (return of 1), or may or may not be AGP (return of 2).
 555          */
 556         int (*device_is_agp) (struct drm_device * dev);
 557
 558         /* these have to be filled in */
 559
 560         irqreturn_t(*irq_handler) (DRM_IRQ_ARGS);
 561         void (*irq_preinstall) (struct drm_device * dev);
 562         void (*irq_postinstall) (struct drm_device * dev);
 563         void (*irq_uninstall) (struct drm_device * dev);
 564         void (*reclaim_buffers) (struct drm_device * dev, struct file * filp);
 565         void (*reclaim_buffers_locked) (struct drm_device *dev,
 566                                         struct file *filp);
 567         unsigned long (*get_map_ofs) (drm_map_t * map);
 568         unsigned long (*get_reg_ofs) (struct drm_device * dev);
 569         void (*set_version) (struct drm_device * dev, drm_set_version_t * sv);
 570
 571         int major;
 572         int minor;
 573         int patchlevel;
 574         char *name;
 575         char *desc;
 576         char *date;
 577
 578         u32 driver_features;
 579         int dev_priv_size;
 580         drm_ioctl_desc_t *ioctls;
 581         int num_ioctls;
 582         struct file_operations fops;
 583         struct pci_driver pci_driver;
 584 };
 585
 586 /**
 587  * DRM head structure. This structure represent a video head on a card
 588  * that may contain multiple heads. Embed one per head of these in the
 589  * private drm_device structure.
 590  */
 591 typedef struct drm_head {
 592         int minor;                      /**< Minor device number */
 593         struct drm_device *dev;
 594         struct proc_dir_entry *dev_root;  /**< proc directory entry */
 595         dev_t device;                   /**< Device number for mknod */
 596         struct class_device *dev_class;
 597 } drm_head_t;
 598
 599 /**
 600  * DRM device structure. This structure represent a complete card that
 601  * may contain multiple heads.
 602  */
 603 typedef struct drm_device {
 604         char *unique;                   /**< Unique identifier: e.g., busid */
 605         int unique_len;                 /**< Length of unique field */
 606         char *devname;                  /**< For /proc/interrupts */
 607         int if_version;                 /**< Highest interface version set */
 608
 609         int blocked;                    /**< Blocked due to VC switch? */
 610
 611         /** \name Locks */
 612         /*@{ */
 613         spinlock_t count_lock;          /**< For inuse, drm_device::open_count, drm_device::buf_use */
 614         struct mutex struct_mutex;      /**< For others */
 615         /*@} */
 616
 617         /** \name Usage Counters */
 618         /*@{ */
 619         int open_count;                 /**< Outstanding files open */
 620         atomic_t ioctl_count;           /**< Outstanding IOCTLs pending */
 621         atomic_t vma_count;             /**< Outstanding vma areas open */
 622         int buf_use;                    /**< Buffers in use -- cannot alloc */
 623         atomic_t buf_alloc;             /**< Buffer allocation in progress */
 624         /*@} */
 625
 626         /** \name Performance counters */
 627         /*@{ */
 628         unsigned long counters;
 629         drm_stat_type_t types[15];
 630         atomic_t counts[15];
 631         /*@} */
 632
 633         /** \name Authentication */
 634         /*@{ */
 635         drm_file_t *file_first;         /**< file list head */
 636         drm_file_t *file_last;          /**< file list tail */
 637         drm_magic_head_t magiclist[DRM_HASH_SIZE];      /**< magic hash table */
 638         /*@} */
 639
 640         /** \name Memory management */
 641         /*@{ */
 642         drm_map_list_t *maplist;        /**< Linked list of regions */
 643         int map_count;                  /**< Number of mappable regions */
 644
 645         /** \name Context handle management */
 646         /*@{ */
 647         drm_ctx_list_t *ctxlist;        /**< Linked list of context handles */
 648         int ctx_count;                  /**< Number of context handles */
 649         struct mutex ctxlist_mutex;     /**< For ctxlist */
 650
 651         drm_map_t **context_sareas;         /**< per-context SAREA's */
 652         int max_context;
 653
 654         drm_vma_entry_t *vmalist;       /**< List of vmas (for debugging) */
 655         drm_lock_data_t lock;           /**< Information on hardware lock */
 656         /*@} */
 657
 658         /** \name DMA queues (contexts) */
 659         /*@{ */
 660         int queue_count;                /**< Number of active DMA queues */
 661         int queue_reserved;               /**< Number of reserved DMA queues */
 662         int queue_slots;                /**< Actual length of queuelist */
 663         drm_queue_t **queuelist;        /**< Vector of pointers to DMA queues */
 664         drm_device_dma_t *dma;          /**< Optional pointer for DMA support */
 665         /*@} */
 666
 667         /** \name Context support */
 668         /*@{ */
 669         int irq;                        /**< Interrupt used by board */
 670         int irq_enabled;                /**< True if irq handler is enabled */
 671         __volatile__ long context_flag; /**< Context swapping flag */
 672         __volatile__ long interrupt_flag; /**< Interruption handler flag */
 673         __volatile__ long dma_flag;     /**< DMA dispatch flag */
 674         struct timer_list timer;        /**< Timer for delaying ctx switch */
 675         wait_queue_head_t context_wait; /**< Processes waiting on ctx switch */
 676         int last_checked;               /**< Last context checked for DMA */
 677         int last_context;               /**< Last current context */
 678         unsigned long last_switch;      /**< jiffies at last context switch */
 679         /*@} */
 680
 681         struct work_struct work;
 682         /** \name VBLANK IRQ support */
 683         /*@{ */
 684
 685         wait_queue_head_t vbl_queue;    /**< VBLANK wait queue */
 686         atomic_t vbl_received;
 687         spinlock_t vbl_lock;
 688         drm_vbl_sig_t vbl_sigs;         /**< signal list to send on VBLANK */
 689         unsigned int vbl_pending;
 690
 691         /*@} */
 692         cycles_t ctx_start;
 693         cycles_t lck_start;
 694
 695         struct fasync_struct *buf_async;/**< Processes waiting for SIGIO */
 696         wait_queue_head_t buf_readers;  /**< Processes waiting to read */
 697         wait_queue_head_t buf_writers;  /**< Processes waiting to ctx switch */
 698
 699         drm_agp_head_t *agp;    /**< AGP data */
 700
 701         struct pci_dev *pdev;           /**< PCI device structure */
 702         int pci_domain;                 /**< PCI bus domain number */
 703 #ifdef __alpha__
 704         struct pci_controller *hose;
 705 #endif
 706         drm_sg_mem_t *sg;       /**< Scatter gather memory */
 707         unsigned long *ctx_bitmap;      /**< context bitmap */
 708         void *dev_private;              /**< device private data */
 709         drm_sigdata_t sigdata;     /**< For block_all_signals */
 710         sigset_t sigmask;
 711
 712         struct drm_driver *driver;
 713         drm_local_map_t *agp_buffer_map;
 714         unsigned int agp_buffer_token;
 715         drm_head_t primary;             /**< primary screen head */
 716 } drm_device_t;
 717
 718 static __inline__ int drm_core_check_feature(struct drm_device *dev,
 719                                              int feature)
 720 {
 721         return ((dev->driver->driver_features & feature) ? 1 : 0);
 722 }
 723
 724 #if __OS_HAS_AGP
 725 static inline int drm_core_has_AGP(struct drm_device *dev)
 726 {
 727         return drm_core_check_feature(dev, DRIVER_USE_AGP);
 728 }
 729 #else
 730 #define drm_core_has_AGP(dev) (0)
 731 #endif
 732
 733 #if __OS_HAS_MTRR
 734 static inline int drm_core_has_MTRR(struct drm_device *dev)
 735 {
 736         return drm_core_check_feature(dev, DRIVER_USE_MTRR);
 737 }
 738
 739 #define DRM_MTRR_WC             MTRR_TYPE_WRCOMB
 740
 741 static inline int drm_mtrr_add(unsigned long offset, unsigned long size,
 742                                unsigned int flags)
 743 {
 744         return mtrr_add(offset, size, flags, 1);
 745 }
 746
 747 static inline int drm_mtrr_del(int handle, unsigned long offset,
 748                                unsigned long size, unsigned int flags)
 749 {
 750         return mtrr_del(handle, offset, size);
 751 }
 752
 753 #else
 754 #define drm_core_has_MTRR(dev) (0)
 755
 756 #define DRM_MTRR_WC             0
 757
 758 static inline int drm_mtrr_add(unsigned long offset, unsigned long size,
 759                                unsigned int flags)
 760 {
 761         return 0;
 762 }
 763
 764 static inline int drm_mtrr_del(int handle, unsigned long offset,
 765                                unsigned long size, unsigned int flags)
 766 {
 767         return 0;
 768 }
 769 #endif
 770
 771 /******************************************************************/
 772 /** \name Internal function definitions */
 773 /*@{*/
 774
 775                                 /* Driver support (drm_drv.h) */
 776 extern int drm_init(struct drm_driver *driver);
 777 extern void drm_exit(struct drm_driver *driver);
 778 extern int drm_ioctl(struct inode *inode, struct file *filp,
 779                      unsigned int cmd, unsigned long arg);
 780 extern long drm_compat_ioctl(struct file *filp,
 781                              unsigned int cmd, unsigned long arg);
 782 extern int drm_lastclose(drm_device_t *dev);
 783
 784                                 /* Device support (drm_fops.h) */
 785 extern int drm_open(struct inode *inode, struct file *filp);
 786 extern int drm_stub_open(struct inode *inode, struct file *filp);
 787 extern int drm_fasync(int fd, struct file *filp, int on);
 788 extern int drm_release(struct inode *inode, struct file *filp);
 789
 790                                 /* Mapping support (drm_vm.h) */
 791 extern int drm_mmap(struct file *filp, struct vm_area_struct *vma);
 792 extern unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait);
 793
 794                                 /* Memory management support (drm_memory.h) */
 795 #include "drm_memory.h"
 796 extern void drm_mem_init(void);
 797 extern int drm_mem_info(char *buf, char **start, off_t offset,
 798                         int request, int *eof, void *data);
 799 extern void *drm_realloc(void *oldpt, size_t oldsize, size_t size, int area);
 800 extern void *drm_ioremap(unsigned long offset, unsigned long size,
 801                          drm_device_t * dev);
 802 extern void drm_ioremapfree(void *pt, unsigned long size, drm_device_t * dev);
 803
 804 extern DRM_AGP_MEM *drm_alloc_agp(drm_device_t * dev, int pages, u32 type);
 805 extern int drm_free_agp(DRM_AGP_MEM * handle, int pages);
 806 extern int drm_bind_agp(DRM_AGP_MEM * handle, unsigned int start);
 807 extern int drm_unbind_agp(DRM_AGP_MEM * handle);
 808
 809                                 /* Misc. IOCTL support (drm_ioctl.h) */
 810 extern int drm_irq_by_busid(struct inode *inode, struct file *filp,
 811                             unsigned int cmd, unsigned long arg);
 812 extern int drm_getunique(struct inode *inode, struct file *filp,
 813                          unsigned int cmd, unsigned long arg);
 814 extern int drm_setunique(struct inode *inode, struct file *filp,
 815                          unsigned int cmd, unsigned long arg);
 816 extern int drm_getmap(struct inode *inode, struct file *filp,
 817                       unsigned int cmd, unsigned long arg);
 818 extern int drm_getclient(struct inode *inode, struct file *filp,
 819                          unsigned int cmd, unsigned long arg);
 820 extern int drm_getstats(struct inode *inode, struct file *filp,
 821                         unsigned int cmd, unsigned long arg);
 822 extern int drm_setversion(struct inode *inode, struct file *filp,
 823                           unsigned int cmd, unsigned long arg);
 824 extern int drm_noop(struct inode *inode, struct file *filp,
 825                     unsigned int cmd, unsigned long arg);
 826
 827                                 /* Context IOCTL support (drm_context.h) */
 828 extern int drm_resctx(struct inode *inode, struct file *filp,
 829                       unsigned int cmd, unsigned long arg);
 830 extern int drm_addctx(struct inode *inode, struct file *filp,
 831                       unsigned int cmd, unsigned long arg);
 832 extern int drm_modctx(struct inode *inode, struct file *filp,
 833                       unsigned int cmd, unsigned long arg);
 834 extern int drm_getctx(struct inode *inode, struct file *filp,
 835                       unsigned int cmd, unsigned long arg);
 836 extern int drm_switchctx(struct inode *inode, struct file *filp,
 837                          unsigned int cmd, unsigned long arg);
 838 extern int drm_newctx(struct inode *inode, struct file *filp,
 839                       unsigned int cmd, unsigned long arg);
 840 extern int drm_rmctx(struct inode *inode, struct file *filp,
 841                      unsigned int cmd, unsigned long arg);
 842
 843 extern int drm_ctxbitmap_init(drm_device_t * dev);
 844 extern void drm_ctxbitmap_cleanup(drm_device_t * dev);
 845 extern void drm_ctxbitmap_free(drm_device_t * dev, int ctx_handle);
 846
 847 extern int drm_setsareactx(struct inode *inode, struct file *filp,
 848                            unsigned int cmd, unsigned long arg);
 849 extern int drm_getsareactx(struct inode *inode, struct file *filp,
 850                            unsigned int cmd, unsigned long arg);
 851
 852                                 /* Drawable IOCTL support (drm_drawable.h) */
 853 extern int drm_adddraw(struct inode *inode, struct file *filp,
 854                        unsigned int cmd, unsigned long arg);
 855 extern int drm_rmdraw(struct inode *inode, struct file *filp,
 856                       unsigned int cmd, unsigned long arg);
 857
 858                                 /* Authentication IOCTL support (drm_auth.h) */
 859 extern int drm_getmagic(struct inode *inode, struct file *filp,
 860                         unsigned int cmd, unsigned long arg);
 861 extern int drm_authmagic(struct inode *inode, struct file *filp,
 862                          unsigned int cmd, unsigned long arg);
 863
 864                                 /* Locking IOCTL support (drm_lock.h) */
 865 extern int drm_lock(struct inode *inode, struct file *filp,
 866                     unsigned int cmd, unsigned long arg);
 867 extern int drm_unlock(struct inode *inode, struct file *filp,
 868                       unsigned int cmd, unsigned long arg);
 869 extern int drm_lock_take(__volatile__ unsigned int *lock, unsigned int context);
 870 extern int drm_lock_free(drm_device_t * dev,
 871                          __volatile__ unsigned int *lock, unsigned int context);
 872
 873                                 /* Buffer management support (drm_bufs.h) */
 874 extern int drm_addbufs_agp(drm_device_t * dev, drm_buf_desc_t * request);
 875 extern int drm_addbufs_pci(drm_device_t * dev, drm_buf_desc_t * request);
 876 extern int drm_addmap(drm_device_t * dev, unsigned int offset,
 877                       unsigned int size, drm_map_type_t type,
 878                       drm_map_flags_t flags, drm_local_map_t ** map_ptr);
 879 extern int drm_addmap_ioctl(struct inode *inode, struct file *filp,
 880                             unsigned int cmd, unsigned long arg);
 881 extern int drm_rmmap(drm_device_t * dev, drm_local_map_t * map);
 882 extern int drm_rmmap_locked(drm_device_t * dev, drm_local_map_t * map);
 883 extern int drm_rmmap_ioctl(struct inode *inode, struct file *filp,
 884                            unsigned int cmd, unsigned long arg);
 885
 886 extern int drm_order(unsigned long size);
 887 extern int drm_addbufs(struct inode *inode, struct file *filp,
 888                        unsigned int cmd, unsigned long arg);
 889 extern int drm_infobufs(struct inode *inode, struct file *filp,
 890                         unsigned int cmd, unsigned long arg);
 891 extern int drm_markbufs(struct inode *inode, struct file *filp,
 892                         unsigned int cmd, unsigned long arg);
 893 extern int drm_freebufs(struct inode *inode, struct file *filp,
 894                         unsigned int cmd, unsigned long arg);
 895 extern int drm_mapbufs(struct inode *inode, struct file *filp,
 896                        unsigned int cmd, unsigned long arg);
 897 extern unsigned long drm_get_resource_start(drm_device_t * dev,
 898                                             unsigned int resource);
 899 extern unsigned long drm_get_resource_len(drm_device_t * dev,
 900                                           unsigned int resource);
 901
 902                                 /* DMA support (drm_dma.h) */
 903 extern int drm_dma_setup(drm_device_t * dev);
 904 extern void drm_dma_takedown(drm_device_t * dev);
 905 extern void drm_free_buffer(drm_device_t * dev, drm_buf_t * buf);
 906 extern void drm_core_reclaim_buffers(drm_device_t * dev, struct file *filp);
 907
 908                                 /* IRQ support (drm_irq.h) */
 909 extern int drm_control(struct inode *inode, struct file *filp,
 910                        unsigned int cmd, unsigned long arg);
 911 extern irqreturn_t drm_irq_handler(DRM_IRQ_ARGS);
 912 extern int drm_irq_uninstall(drm_device_t * dev);
 913 extern void drm_driver_irq_preinstall(drm_device_t * dev);
 914 extern void drm_driver_irq_postinstall(drm_device_t * dev);
 915 extern void drm_driver_irq_uninstall(drm_device_t * dev);
 916
 917 extern int drm_wait_vblank(struct inode *inode, struct file *filp,
 918                            unsigned int cmd, unsigned long arg);
 919 extern int drm_vblank_wait(drm_device_t * dev, unsigned int *vbl_seq);
 920 extern void drm_vbl_send_signals(drm_device_t * dev);
 921
 922                                 /* AGP/GART support (drm_agpsupport.h) */
 923 extern drm_agp_head_t *drm_agp_init(drm_device_t * dev);
 924 extern int drm_agp_acquire(drm_device_t * dev);
 925 extern int drm_agp_acquire_ioctl(struct inode *inode, struct file *filp,
 926                                  unsigned int cmd, unsigned long arg);
 927 extern int drm_agp_release(drm_device_t * dev);
 928 extern int drm_agp_release_ioctl(struct inode *inode, struct file *filp,
 929                                  unsigned int cmd, unsigned long arg);
 930 extern int drm_agp_enable(drm_device_t * dev, drm_agp_mode_t mode);
 931 extern int drm_agp_enable_ioctl(struct inode *inode, struct file *filp,
 932                                 unsigned int cmd, unsigned long arg);
 933 extern int drm_agp_info(drm_device_t * dev, drm_agp_info_t * info);
 934 extern int drm_agp_info_ioctl(struct inode *inode, struct file *filp,
 935                               unsigned int cmd, unsigned long arg);
 936 extern int drm_agp_alloc(drm_device_t *dev, drm_agp_buffer_t *request);
 937 extern int drm_agp_alloc_ioctl(struct inode *inode, struct file *filp,
 938                          unsigned int cmd, unsigned long arg);
 939 extern int drm_agp_free(drm_device_t *dev, drm_agp_buffer_t *request);
 940 extern int drm_agp_free_ioctl(struct inode *inode, struct file *filp,
 941                         unsigned int cmd, unsigned long arg);
 942 extern int drm_agp_unbind(drm_device_t *dev, drm_agp_binding_t *request);
 943 extern int drm_agp_unbind_ioctl(struct inode *inode, struct file *filp,
 944                           unsigned int cmd, unsigned long arg);
 945 extern int drm_agp_bind(drm_device_t *dev, drm_agp_binding_t *request);
 946 extern int drm_agp_bind_ioctl(struct inode *inode, struct file *filp,
 947                         unsigned int cmd, unsigned long arg);
 948 extern DRM_AGP_MEM *drm_agp_allocate_memory(struct agp_bridge_data *bridge,
 949                                             size_t pages, u32 type);
 950 extern int drm_agp_free_memory(DRM_AGP_MEM * handle);
 951 extern int drm_agp_bind_memory(DRM_AGP_MEM * handle, off_t start);
 952 extern int drm_agp_unbind_memory(DRM_AGP_MEM * handle);
 953
 954                                 /* Stub support (drm_stub.h) */
 955 extern int drm_get_dev(struct pci_dev *pdev, const struct pci_device_id *ent,
 956                        struct drm_driver *driver);
 957 extern int drm_put_dev(drm_device_t * dev);
 958 extern int drm_put_head(drm_head_t * head);
 959 extern unsigned int drm_debug;
 960 extern unsigned int drm_cards_limit;
 961 extern drm_head_t **drm_heads;
 962 extern struct class *drm_class;
 963 extern struct proc_dir_entry *drm_proc_root;
 964
 965                                 /* Proc support (drm_proc.h) */
 966 extern int drm_proc_init(drm_device_t * dev,
 967                          int minor,
 968                          struct proc_dir_entry *root,
 969                          struct proc_dir_entry **dev_root);
 970 extern int drm_proc_cleanup(int minor,
 971                             struct proc_dir_entry *root,
 972                             struct proc_dir_entry *dev_root);
 973
 974                                 /* Scatter Gather Support (drm_scatter.h) */
 975 extern void drm_sg_cleanup(drm_sg_mem_t * entry);
 976 extern int drm_sg_alloc(struct inode *inode, struct file *filp,
 977                         unsigned int cmd, unsigned long arg);
 978 extern int drm_sg_free(struct inode *inode, struct file *filp,
 979                        unsigned int cmd, unsigned long arg);
 980
 981                                /* ATI PCIGART support (ati_pcigart.h) */
 982 extern int drm_ati_pcigart_init(drm_device_t * dev,
 983                                 drm_ati_pcigart_info * gart_info);
 984 extern int drm_ati_pcigart_cleanup(drm_device_t * dev,
 985                                    drm_ati_pcigart_info * gart_info);
 986
 987 extern drm_dma_handle_t *drm_pci_alloc(drm_device_t * dev, size_t size,
 988                                        size_t align, dma_addr_t maxaddr);
 989 extern void __drm_pci_free(drm_device_t * dev, drm_dma_handle_t * dmah);
 990 extern void drm_pci_free(drm_device_t * dev, drm_dma_handle_t * dmah);
 991
 992                                /* sysfs support (drm_sysfs.c) */
 993 extern struct class *drm_sysfs_create(struct module *owner, char *name);
 994 extern void drm_sysfs_destroy(struct class *cs);
 995 extern struct class_device *drm_sysfs_device_add(struct class *cs,
 996                                                  drm_head_t *head);
 997 extern void drm_sysfs_device_remove(struct class_device *class_dev);
 998
 999 /* Inline replacements for DRM_IOREMAP macros */
1000 static __inline__ void drm_core_ioremap(struct drm_map *map,
1001                                         struct drm_device *dev)
1002 {
1003         map->handle = drm_ioremap(map->offset, map->size, dev);
1004 }
1005
1006 #if 0
1007 static __inline__ void drm_core_ioremap_nocache(struct drm_map *map,
1008                                                 struct drm_device *dev)
1009 {
1010         map->handle = drm_ioremap_nocache(map->offset, map->size, dev);
1011 }
1012 #endif  /*  0  */
1013
1014 static __inline__ void drm_core_ioremapfree(struct drm_map *map,
1015                                             struct drm_device *dev)
1016 {
1017         if (map->handle && map->size)
1018                 drm_ioremapfree(map->handle, map->size, dev);
1019 }
1020
1021 static __inline__ struct drm_map *drm_core_findmap(struct drm_device *dev,
1022                                                    unsigned int token)
1023 {
1024         drm_map_list_t *_entry;
1025         list_for_each_entry(_entry, &dev->maplist->head, head)
1026             if (_entry->user_token == token)
1027                 return _entry->map;
1028         return NULL;
1029 }
1030
1031 static __inline__ int drm_device_is_agp(drm_device_t * dev)
1032 {
1033         if (dev->driver->device_is_agp != NULL) {
1034                 int err = (*dev->driver->device_is_agp) (dev);
1035
1036                 if (err != 2) {
1037                         return err;
1038                 }
1039         }
1040
1041         return pci_find_capability(dev->pdev, PCI_CAP_ID_AGP);
1042 }
1043
1044 static __inline__ int drm_device_is_pcie(drm_device_t * dev)
1045 {
1046         return pci_find_capability(dev->pdev, PCI_CAP_ID_EXP);
1047 }
1048
1049 static __inline__ void drm_core_dropmap(struct drm_map *map)
1050 {
1051 }
1052
1053 #ifndef DEBUG_MEMORY
1054 /** Wrapper around kmalloc() */
1055 static __inline__ void *drm_alloc(size_t size, int area)
1056 {
1057         return kmalloc(size, GFP_KERNEL);
1058 }
1059
1060 /** Wrapper around kfree() */
1061 static __inline__ void drm_free(void *pt, size_t size, int area)
1062 {
1063         kfree(pt);
1064 }
1065
1066 /** Wrapper around kcalloc() */
1067 static __inline__ void *drm_calloc(size_t nmemb, size_t size, int area)
1068 {
1069         return kcalloc(nmemb, size, GFP_KERNEL);
1070 }
1071 #else
1072 extern void *drm_alloc(size_t size, int area);
1073 extern void drm_free(void *pt, size_t size, int area);
1074 extern void *drm_calloc(size_t nmemb, size_t size, int area);
1075 #endif
1076
1077 /*@}*/
1078
1079 extern unsigned long drm_core_get_map_ofs(drm_map_t * map);
1080 extern unsigned long drm_core_get_reg_ofs(struct drm_device *dev);
1081
1082 #ifndef pci_pretty_name
1083 #define pci_pretty_name(dev) ""
1084 #endif
1085
1086 #endif                          /* __KERNEL__ */
1087 #endif