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