SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/char/drm/drmP.h

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