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