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