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