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