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