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