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