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