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