]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - drivers/char/drm/drmP.h
drm: remove a bunch of typedefs on the userspace interface
[karo-tx-linux.git] / drivers / char / drm / drmP.h
1 /**
2  * \file drmP.h
3  * Private header for Direct Rendering Manager
4  *
5  * \author Rickard E. (Rik) Faith <faith@valinux.com>
6  * \author Gareth Hughes <gareth@valinux.com>
7  */
8
9 /*
10  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
11  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
12  * All rights reserved.
13  *
14  * Permission is hereby granted, free of charge, to any person obtaining a
15  * copy of this software and associated documentation files (the "Software"),
16  * to deal in the Software without restriction, including without limitation
17  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
18  * and/or sell copies of the Software, and to permit persons to whom the
19  * Software is furnished to do so, subject to the following conditions:
20  *
21  * The above copyright notice and this permission notice (including the next
22  * paragraph) shall be included in all copies or substantial portions of the
23  * Software.
24  *
25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
26  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
27  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
28  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
29  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
30  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
31  * OTHER DEALINGS IN THE SOFTWARE.
32  */
33
34 #ifndef _DRM_P_H_
35 #define _DRM_P_H_
36
37 /* If you want the memory alloc debug functionality, change define below */
38 /* #define DEBUG_MEMORY */
39
40 #ifdef __KERNEL__
41 #ifdef __alpha__
42 /* add include of current.h so that "current" is defined
43  * before static inline funcs in wait.h. Doing this so we
44  * can build the DRM (part of PI DRI). 4/21/2000 S + B */
45 #include <asm/current.h>
46 #endif                          /* __alpha__ */
47 #include <linux/module.h>
48 #include <linux/kernel.h>
49 #include <linux/miscdevice.h>
50 #include <linux/fs.h>
51 #include <linux/proc_fs.h>
52 #include <linux/init.h>
53 #include <linux/file.h>
54 #include <linux/pci.h>
55 #include <linux/jiffies.h>
56 #include <linux/smp_lock.h>     /* For (un)lock_kernel */
57 #include <linux/mm.h>
58 #include <linux/cdev.h>
59 #include <linux/mutex.h>
60 #if defined(__alpha__) || defined(__powerpc__)
61 #include <asm/pgtable.h>        /* For pte_wrprotect */
62 #endif
63 #include <asm/io.h>
64 #include <asm/mman.h>
65 #include <asm/uaccess.h>
66 #ifdef CONFIG_MTRR
67 #include <asm/mtrr.h>
68 #endif
69 #if defined(CONFIG_AGP) || defined(CONFIG_AGP_MODULE)
70 #include <linux/types.h>
71 #include <linux/agp_backend.h>
72 #endif
73 #include <linux/workqueue.h>
74 #include <linux/poll.h>
75 #include <asm/pgalloc.h>
76 #include "drm.h"
77
78 #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         enum drm_ctx_flags 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         struct drm_hw_lock *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         struct drm_hw_lock *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         struct drm_map *map;                    /**< mapping */
490         unsigned int user_token;
491 } drm_map_list_t;
492
493 typedef struct drm_map 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) (struct drm_map * map);
598         unsigned long (*get_reg_ofs) (struct drm_device * dev);
599         void (*set_version) (struct drm_device * dev,
600                              struct drm_set_version *sv);
601
602         int major;
603         int minor;
604         int patchlevel;
605         char *name;
606         char *desc;
607         char *date;
608
609         u32 driver_features;
610         int dev_priv_size;
611         drm_ioctl_desc_t *ioctls;
612         int num_ioctls;
613         struct file_operations fops;
614         struct pci_driver pci_driver;
615 };
616
617 /**
618  * DRM head structure. This structure represent a video head on a card
619  * that may contain multiple heads. Embed one per head of these in the
620  * private drm_device structure.
621  */
622 typedef struct drm_head {
623         int minor;                      /**< Minor device number */
624         struct drm_device *dev;
625         struct proc_dir_entry *dev_root;  /**< proc directory entry */
626         dev_t device;                   /**< Device number for mknod */
627         struct class_device *dev_class;
628 } drm_head_t;
629
630 /**
631  * DRM device structure. This structure represent a complete card that
632  * may contain multiple heads.
633  */
634 typedef struct drm_device {
635         char *unique;                   /**< Unique identifier: e.g., busid */
636         int unique_len;                 /**< Length of unique field */
637         char *devname;                  /**< For /proc/interrupts */
638         int if_version;                 /**< Highest interface version set */
639
640         int blocked;                    /**< Blocked due to VC switch? */
641
642         /** \name Locks */
643         /*@{ */
644         spinlock_t count_lock;          /**< For inuse, drm_device::open_count, drm_device::buf_use */
645         struct mutex struct_mutex;      /**< For others */
646         /*@} */
647
648         /** \name Usage Counters */
649         /*@{ */
650         int open_count;                 /**< Outstanding files open */
651         atomic_t ioctl_count;           /**< Outstanding IOCTLs pending */
652         atomic_t vma_count;             /**< Outstanding vma areas open */
653         int buf_use;                    /**< Buffers in use -- cannot alloc */
654         atomic_t buf_alloc;             /**< Buffer allocation in progress */
655         /*@} */
656
657         /** \name Performance counters */
658         /*@{ */
659         unsigned long counters;
660         enum drm_stat_type types[15];
661         atomic_t counts[15];
662         /*@} */
663
664         /** \name Authentication */
665         /*@{ */
666         struct list_head filelist;
667         drm_open_hash_t magiclist;      /**< magic hash table */
668         struct list_head magicfree;
669         /*@} */
670
671         /** \name Memory management */
672         /*@{ */
673         struct list_head maplist;       /**< Linked list of regions */
674         int map_count;                  /**< Number of mappable regions */
675         drm_open_hash_t map_hash;       /**< User token hash table for maps */
676
677         /** \name Context handle management */
678         /*@{ */
679         struct list_head ctxlist;       /**< Linked list of context handles */
680         int ctx_count;                  /**< Number of context handles */
681         struct mutex ctxlist_mutex;     /**< For ctxlist */
682
683         struct drm_map **context_sareas;            /**< per-context SAREA's */
684         int max_context;
685
686         struct list_head vmalist;       /**< List of vmas (for debugging) */
687         drm_lock_data_t lock;           /**< Information on hardware lock */
688         /*@} */
689
690         /** \name DMA queues (contexts) */
691         /*@{ */
692         int queue_count;                /**< Number of active DMA queues */
693         int queue_reserved;               /**< Number of reserved DMA queues */
694         int queue_slots;                /**< Actual length of queuelist */
695         drm_queue_t **queuelist;        /**< Vector of pointers to DMA queues */
696         drm_device_dma_t *dma;          /**< Optional pointer for DMA support */
697         /*@} */
698
699         /** \name Context support */
700         /*@{ */
701         int irq;                        /**< Interrupt used by board */
702         int irq_enabled;                /**< True if irq handler is enabled */
703         __volatile__ long context_flag; /**< Context swapping flag */
704         __volatile__ long interrupt_flag; /**< Interruption handler flag */
705         __volatile__ long dma_flag;     /**< DMA dispatch flag */
706         struct timer_list timer;        /**< Timer for delaying ctx switch */
707         wait_queue_head_t context_wait; /**< Processes waiting on ctx switch */
708         int last_checked;               /**< Last context checked for DMA */
709         int last_context;               /**< Last current context */
710         unsigned long last_switch;      /**< jiffies at last context switch */
711         /*@} */
712
713         struct work_struct work;
714         /** \name VBLANK IRQ support */
715         /*@{ */
716
717         wait_queue_head_t vbl_queue;    /**< VBLANK wait queue */
718         atomic_t vbl_received;
719         atomic_t vbl_received2;         /**< number of secondary VBLANK interrupts */
720         spinlock_t vbl_lock;
721         struct list_head vbl_sigs;              /**< signal list to send on VBLANK */
722         struct list_head vbl_sigs2;     /**< signals to send on secondary VBLANK */
723         unsigned int vbl_pending;
724         spinlock_t tasklet_lock;        /**< For drm_locked_tasklet */
725         void (*locked_tasklet_func)(struct drm_device *dev);
726
727         /*@} */
728         cycles_t ctx_start;
729         cycles_t lck_start;
730
731         struct fasync_struct *buf_async;/**< Processes waiting for SIGIO */
732         wait_queue_head_t buf_readers;  /**< Processes waiting to read */
733         wait_queue_head_t buf_writers;  /**< Processes waiting to ctx switch */
734
735         drm_agp_head_t *agp;    /**< AGP data */
736
737         struct pci_dev *pdev;           /**< PCI device structure */
738         int pci_vendor;                 /**< PCI vendor id */
739         int pci_device;                 /**< PCI device id */
740 #ifdef __alpha__
741         struct pci_controller *hose;
742 #endif
743         drm_sg_mem_t *sg;       /**< Scatter gather memory */
744         unsigned long *ctx_bitmap;      /**< context bitmap */
745         void *dev_private;              /**< device private data */
746         drm_sigdata_t sigdata;     /**< For block_all_signals */
747         sigset_t sigmask;
748
749         struct drm_driver *driver;
750         drm_local_map_t *agp_buffer_map;
751         unsigned int agp_buffer_token;
752         drm_head_t primary;             /**< primary screen head */
753
754         /** \name Drawable information */
755         /*@{ */
756         spinlock_t drw_lock;
757         unsigned int drw_bitfield_length;
758         u32 *drw_bitfield;
759         unsigned int drw_info_length;
760         struct drm_drawable_info **drw_info;
761         /*@} */
762 } drm_device_t;
763
764 static __inline__ int drm_core_check_feature(struct drm_device *dev,
765                                              int feature)
766 {
767         return ((dev->driver->driver_features & feature) ? 1 : 0);
768 }
769
770 #ifdef __alpha__
771 #define drm_get_pci_domain(dev) dev->hose->index
772 #else
773 #define drm_get_pci_domain(dev) 0
774 #endif
775
776 #if __OS_HAS_AGP
777 static inline int drm_core_has_AGP(struct drm_device *dev)
778 {
779         return drm_core_check_feature(dev, DRIVER_USE_AGP);
780 }
781 #else
782 #define drm_core_has_AGP(dev) (0)
783 #endif
784
785 #if __OS_HAS_MTRR
786 static inline int drm_core_has_MTRR(struct drm_device *dev)
787 {
788         return drm_core_check_feature(dev, DRIVER_USE_MTRR);
789 }
790
791 #define DRM_MTRR_WC             MTRR_TYPE_WRCOMB
792
793 static inline int drm_mtrr_add(unsigned long offset, unsigned long size,
794                                unsigned int flags)
795 {
796         return mtrr_add(offset, size, flags, 1);
797 }
798
799 static inline int drm_mtrr_del(int handle, unsigned long offset,
800                                unsigned long size, unsigned int flags)
801 {
802         return mtrr_del(handle, offset, size);
803 }
804
805 #else
806 #define drm_core_has_MTRR(dev) (0)
807
808 #define DRM_MTRR_WC             0
809
810 static inline int drm_mtrr_add(unsigned long offset, unsigned long size,
811                                unsigned int flags)
812 {
813         return 0;
814 }
815
816 static inline int drm_mtrr_del(int handle, unsigned long offset,
817                                unsigned long size, unsigned int flags)
818 {
819         return 0;
820 }
821 #endif
822
823 /******************************************************************/
824 /** \name Internal function definitions */
825 /*@{*/
826
827                                 /* Driver support (drm_drv.h) */
828 extern int drm_init(struct drm_driver *driver);
829 extern void drm_exit(struct drm_driver *driver);
830 extern int drm_ioctl(struct inode *inode, struct file *filp,
831                      unsigned int cmd, unsigned long arg);
832 extern long drm_compat_ioctl(struct file *filp,
833                              unsigned int cmd, unsigned long arg);
834 extern int drm_lastclose(drm_device_t *dev);
835
836                                 /* Device support (drm_fops.h) */
837 extern int drm_open(struct inode *inode, struct file *filp);
838 extern int drm_stub_open(struct inode *inode, struct file *filp);
839 extern int drm_fasync(int fd, struct file *filp, int on);
840 extern int drm_release(struct inode *inode, struct file *filp);
841
842                                 /* Mapping support (drm_vm.h) */
843 extern int drm_mmap(struct file *filp, struct vm_area_struct *vma);
844 extern unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait);
845
846                                 /* Memory management support (drm_memory.h) */
847 #include "drm_memory.h"
848 extern void drm_mem_init(void);
849 extern int drm_mem_info(char *buf, char **start, off_t offset,
850                         int request, int *eof, void *data);
851 extern void *drm_realloc(void *oldpt, size_t oldsize, size_t size, int area);
852
853 extern DRM_AGP_MEM *drm_alloc_agp(drm_device_t * dev, int pages, u32 type);
854 extern int drm_free_agp(DRM_AGP_MEM * handle, int pages);
855 extern int drm_bind_agp(DRM_AGP_MEM * handle, unsigned int start);
856 extern int drm_unbind_agp(DRM_AGP_MEM * handle);
857
858                                 /* Misc. IOCTL support (drm_ioctl.h) */
859 extern int drm_irq_by_busid(struct inode *inode, struct file *filp,
860                             unsigned int cmd, unsigned long arg);
861 extern int drm_getunique(struct inode *inode, struct file *filp,
862                          unsigned int cmd, unsigned long arg);
863 extern int drm_setunique(struct inode *inode, struct file *filp,
864                          unsigned int cmd, unsigned long arg);
865 extern int drm_getmap(struct inode *inode, struct file *filp,
866                       unsigned int cmd, unsigned long arg);
867 extern int drm_getclient(struct inode *inode, struct file *filp,
868                          unsigned int cmd, unsigned long arg);
869 extern int drm_getstats(struct inode *inode, struct file *filp,
870                         unsigned int cmd, unsigned long arg);
871 extern int drm_setversion(struct inode *inode, struct file *filp,
872                           unsigned int cmd, unsigned long arg);
873 extern int drm_noop(struct inode *inode, struct file *filp,
874                     unsigned int cmd, unsigned long arg);
875
876                                 /* Context IOCTL support (drm_context.h) */
877 extern int drm_resctx(struct inode *inode, struct file *filp,
878                       unsigned int cmd, unsigned long arg);
879 extern int drm_addctx(struct inode *inode, struct file *filp,
880                       unsigned int cmd, unsigned long arg);
881 extern int drm_modctx(struct inode *inode, struct file *filp,
882                       unsigned int cmd, unsigned long arg);
883 extern int drm_getctx(struct inode *inode, struct file *filp,
884                       unsigned int cmd, unsigned long arg);
885 extern int drm_switchctx(struct inode *inode, struct file *filp,
886                          unsigned int cmd, unsigned long arg);
887 extern int drm_newctx(struct inode *inode, struct file *filp,
888                       unsigned int cmd, unsigned long arg);
889 extern int drm_rmctx(struct inode *inode, struct file *filp,
890                      unsigned int cmd, unsigned long arg);
891
892 extern int drm_ctxbitmap_init(drm_device_t * dev);
893 extern void drm_ctxbitmap_cleanup(drm_device_t * dev);
894 extern void drm_ctxbitmap_free(drm_device_t * dev, int ctx_handle);
895
896 extern int drm_setsareactx(struct inode *inode, struct file *filp,
897                            unsigned int cmd, unsigned long arg);
898 extern int drm_getsareactx(struct inode *inode, struct file *filp,
899                            unsigned int cmd, unsigned long arg);
900
901                                 /* Drawable IOCTL support (drm_drawable.h) */
902 extern int drm_adddraw(struct inode *inode, struct file *filp,
903                        unsigned int cmd, unsigned long arg);
904 extern int drm_rmdraw(struct inode *inode, struct file *filp,
905                       unsigned int cmd, unsigned long arg);
906 extern int drm_update_drawable_info(struct inode *inode, struct file *filp,
907                        unsigned int cmd, unsigned long arg);
908 extern struct drm_drawable_info *drm_get_drawable_info(drm_device_t *dev,
909                                                   drm_drawable_t id);
910
911                                 /* Authentication IOCTL support (drm_auth.h) */
912 extern int drm_getmagic(struct inode *inode, struct file *filp,
913                         unsigned int cmd, unsigned long arg);
914 extern int drm_authmagic(struct inode *inode, struct file *filp,
915                          unsigned int cmd, unsigned long arg);
916
917                                 /* Locking IOCTL support (drm_lock.h) */
918 extern int drm_lock(struct inode *inode, struct file *filp,
919                     unsigned int cmd, unsigned long arg);
920 extern int drm_unlock(struct inode *inode, struct file *filp,
921                       unsigned int cmd, unsigned long arg);
922 extern int drm_lock_take(drm_lock_data_t *lock_data, unsigned int context);
923 extern int drm_lock_free(drm_lock_data_t *lock_data, unsigned int context);
924 extern void drm_idlelock_take(drm_lock_data_t *lock_data);
925 extern void drm_idlelock_release(drm_lock_data_t *lock_data);
926
927 /*
928  * These are exported to drivers so that they can implement fencing using
929  * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
930  */
931
932 extern int drm_i_have_hw_lock(struct file *filp);
933 extern int drm_kernel_take_hw_lock(struct file *filp);
934
935                                 /* Buffer management support (drm_bufs.h) */
936 extern int drm_addbufs_agp(drm_device_t * dev, struct drm_buf_desc * request);
937 extern int drm_addbufs_pci(drm_device_t * dev, struct drm_buf_desc * request);
938 extern int drm_addmap(drm_device_t * dev, unsigned int offset,
939                       unsigned int size, enum drm_map_type type,
940                       enum drm_map_flags flags, drm_local_map_t ** map_ptr);
941 extern int drm_addmap_ioctl(struct inode *inode, struct file *filp,
942                             unsigned int cmd, unsigned long arg);
943 extern int drm_rmmap(drm_device_t * dev, drm_local_map_t * map);
944 extern int drm_rmmap_locked(drm_device_t * dev, drm_local_map_t * map);
945 extern int drm_rmmap_ioctl(struct inode *inode, struct file *filp,
946                            unsigned int cmd, unsigned long arg);
947
948 extern int drm_order(unsigned long size);
949 extern int drm_addbufs(struct inode *inode, struct file *filp,
950                        unsigned int cmd, unsigned long arg);
951 extern int drm_infobufs(struct inode *inode, struct file *filp,
952                         unsigned int cmd, unsigned long arg);
953 extern int drm_markbufs(struct inode *inode, struct file *filp,
954                         unsigned int cmd, unsigned long arg);
955 extern int drm_freebufs(struct inode *inode, struct file *filp,
956                         unsigned int cmd, unsigned long arg);
957 extern int drm_mapbufs(struct inode *inode, struct file *filp,
958                        unsigned int cmd, unsigned long arg);
959 extern unsigned long drm_get_resource_start(drm_device_t * dev,
960                                             unsigned int resource);
961 extern unsigned long drm_get_resource_len(drm_device_t * dev,
962                                           unsigned int resource);
963
964                                 /* DMA support (drm_dma.h) */
965 extern int drm_dma_setup(drm_device_t * dev);
966 extern void drm_dma_takedown(drm_device_t * dev);
967 extern void drm_free_buffer(drm_device_t * dev, drm_buf_t * buf);
968 extern void drm_core_reclaim_buffers(drm_device_t * dev, struct file *filp);
969
970                                 /* IRQ support (drm_irq.h) */
971 extern int drm_control(struct inode *inode, struct file *filp,
972                        unsigned int cmd, unsigned long arg);
973 extern irqreturn_t drm_irq_handler(DRM_IRQ_ARGS);
974 extern int drm_irq_uninstall(drm_device_t * dev);
975 extern void drm_driver_irq_preinstall(drm_device_t * dev);
976 extern void drm_driver_irq_postinstall(drm_device_t * dev);
977 extern void drm_driver_irq_uninstall(drm_device_t * dev);
978
979 extern int drm_wait_vblank(struct inode *inode, struct file *filp,
980                            unsigned int cmd, unsigned long arg);
981 extern int drm_vblank_wait(drm_device_t * dev, unsigned int *vbl_seq);
982 extern void drm_vbl_send_signals(drm_device_t * dev);
983 extern void drm_locked_tasklet(drm_device_t *dev, void(*func)(drm_device_t*));
984
985                                 /* AGP/GART support (drm_agpsupport.h) */
986 extern drm_agp_head_t *drm_agp_init(drm_device_t * dev);
987 extern int drm_agp_acquire(drm_device_t * dev);
988 extern int drm_agp_acquire_ioctl(struct inode *inode, struct file *filp,
989                                  unsigned int cmd, unsigned long arg);
990 extern int drm_agp_release(drm_device_t * dev);
991 extern int drm_agp_release_ioctl(struct inode *inode, struct file *filp,
992                                  unsigned int cmd, unsigned long arg);
993 extern int drm_agp_enable(drm_device_t * dev, struct drm_agp_mode mode);
994 extern int drm_agp_enable_ioctl(struct inode *inode, struct file *filp,
995                                 unsigned int cmd, unsigned long arg);
996 extern int drm_agp_info(drm_device_t * dev, struct drm_agp_info * info);
997 extern int drm_agp_info_ioctl(struct inode *inode, struct file *filp,
998                               unsigned int cmd, unsigned long arg);
999 extern int drm_agp_alloc(drm_device_t *dev, struct drm_agp_buffer *request);
1000 extern int drm_agp_alloc_ioctl(struct inode *inode, struct file *filp,
1001                          unsigned int cmd, unsigned long arg);
1002 extern int drm_agp_free(drm_device_t *dev, struct drm_agp_buffer *request);
1003 extern int drm_agp_free_ioctl(struct inode *inode, struct file *filp,
1004                         unsigned int cmd, unsigned long arg);
1005 extern int drm_agp_unbind(drm_device_t *dev, struct drm_agp_binding *request);
1006 extern int drm_agp_unbind_ioctl(struct inode *inode, struct file *filp,
1007                           unsigned int cmd, unsigned long arg);
1008 extern int drm_agp_bind(drm_device_t *dev, struct drm_agp_binding *request);
1009 extern int drm_agp_bind_ioctl(struct inode *inode, struct file *filp,
1010                         unsigned int cmd, unsigned long arg);
1011 extern DRM_AGP_MEM *drm_agp_allocate_memory(struct agp_bridge_data *bridge,
1012                                             size_t pages, u32 type);
1013 extern int drm_agp_free_memory(DRM_AGP_MEM * handle);
1014 extern int drm_agp_bind_memory(DRM_AGP_MEM * handle, off_t start);
1015 extern int drm_agp_unbind_memory(DRM_AGP_MEM * handle);
1016
1017                                 /* Stub support (drm_stub.h) */
1018 extern int drm_get_dev(struct pci_dev *pdev, const struct pci_device_id *ent,
1019                        struct drm_driver *driver);
1020 extern int drm_put_dev(drm_device_t * dev);
1021 extern int drm_put_head(drm_head_t * head);
1022 extern unsigned int drm_debug;
1023 extern unsigned int drm_cards_limit;
1024 extern drm_head_t **drm_heads;
1025 extern struct class *drm_class;
1026 extern struct proc_dir_entry *drm_proc_root;
1027
1028 extern drm_local_map_t *drm_getsarea(struct drm_device *dev);
1029
1030                                 /* Proc support (drm_proc.h) */
1031 extern int drm_proc_init(drm_device_t * dev,
1032                          int minor,
1033                          struct proc_dir_entry *root,
1034                          struct proc_dir_entry **dev_root);
1035 extern int drm_proc_cleanup(int minor,
1036                             struct proc_dir_entry *root,
1037                             struct proc_dir_entry *dev_root);
1038
1039                                 /* Scatter Gather Support (drm_scatter.h) */
1040 extern void drm_sg_cleanup(drm_sg_mem_t * entry);
1041 extern int drm_sg_alloc(struct inode *inode, struct file *filp,
1042                         unsigned int cmd, unsigned long arg);
1043 extern int drm_sg_free(struct inode *inode, struct file *filp,
1044                        unsigned int cmd, unsigned long arg);
1045
1046                                /* ATI PCIGART support (ati_pcigart.h) */
1047 extern int drm_ati_pcigart_init(drm_device_t * dev,
1048                                 drm_ati_pcigart_info * gart_info);
1049 extern int drm_ati_pcigart_cleanup(drm_device_t * dev,
1050                                    drm_ati_pcigart_info * gart_info);
1051
1052 extern drm_dma_handle_t *drm_pci_alloc(drm_device_t * dev, size_t size,
1053                                        size_t align, dma_addr_t maxaddr);
1054 extern void __drm_pci_free(drm_device_t * dev, drm_dma_handle_t * dmah);
1055 extern void drm_pci_free(drm_device_t * dev, drm_dma_handle_t * dmah);
1056
1057                                /* sysfs support (drm_sysfs.c) */
1058 extern struct class *drm_sysfs_create(struct module *owner, char *name);
1059 extern void drm_sysfs_destroy(struct class *cs);
1060 extern struct class_device *drm_sysfs_device_add(struct class *cs,
1061                                                  drm_head_t *head);
1062 extern void drm_sysfs_device_remove(struct class_device *class_dev);
1063
1064 /*
1065  * Basic memory manager support (drm_mm.c)
1066  */
1067 extern drm_mm_node_t *drm_mm_get_block(drm_mm_node_t * parent,
1068                                        unsigned long size,
1069                                        unsigned alignment);
1070 void drm_mm_put_block(drm_mm_node_t * cur);
1071 extern drm_mm_node_t *drm_mm_search_free(const drm_mm_t *mm, unsigned long size,
1072                                          unsigned alignment, int best_match);
1073 extern int drm_mm_init(drm_mm_t *mm, unsigned long start, unsigned long size);
1074 extern void drm_mm_takedown(drm_mm_t *mm);
1075 extern int drm_mm_clean(drm_mm_t *mm);
1076 extern unsigned long drm_mm_tail_space(drm_mm_t *mm);
1077 extern int drm_mm_remove_space_from_tail(drm_mm_t *mm, unsigned long size);
1078 extern int drm_mm_add_space_to_tail(drm_mm_t *mm, unsigned long size);
1079
1080 extern void drm_core_ioremap(struct drm_map *map, struct drm_device *dev);
1081 extern void drm_core_ioremapfree(struct drm_map *map, struct drm_device *dev);
1082
1083 static __inline__ struct drm_map *drm_core_findmap(struct drm_device *dev,
1084                                                    unsigned int token)
1085 {
1086         drm_map_list_t *_entry;
1087         list_for_each_entry(_entry, &dev->maplist, head)
1088             if (_entry->user_token == token)
1089                 return _entry->map;
1090         return NULL;
1091 }
1092
1093 static __inline__ int drm_device_is_agp(drm_device_t * dev)
1094 {
1095         if (dev->driver->device_is_agp != NULL) {
1096                 int err = (*dev->driver->device_is_agp) (dev);
1097
1098                 if (err != 2) {
1099                         return err;
1100                 }
1101         }
1102
1103         return pci_find_capability(dev->pdev, PCI_CAP_ID_AGP);
1104 }
1105
1106 static __inline__ int drm_device_is_pcie(drm_device_t * dev)
1107 {
1108         return pci_find_capability(dev->pdev, PCI_CAP_ID_EXP);
1109 }
1110
1111 static __inline__ void drm_core_dropmap(struct drm_map *map)
1112 {
1113 }
1114
1115 #ifndef DEBUG_MEMORY
1116 /** Wrapper around kmalloc() */
1117 static __inline__ void *drm_alloc(size_t size, int area)
1118 {
1119         return kmalloc(size, GFP_KERNEL);
1120 }
1121
1122 /** Wrapper around kfree() */
1123 static __inline__ void drm_free(void *pt, size_t size, int area)
1124 {
1125         kfree(pt);
1126 }
1127
1128 /** Wrapper around kcalloc() */
1129 static __inline__ void *drm_calloc(size_t nmemb, size_t size, int area)
1130 {
1131         return kcalloc(nmemb, size, GFP_KERNEL);
1132 }
1133 #else
1134 extern void *drm_alloc(size_t size, int area);
1135 extern void drm_free(void *pt, size_t size, int area);
1136 extern void *drm_calloc(size_t nmemb, size_t size, int area);
1137 #endif
1138
1139 /*@}*/
1140
1141 extern unsigned long drm_core_get_map_ofs(struct drm_map * map);
1142 extern unsigned long drm_core_get_reg_ofs(struct drm_device *dev);
1143
1144 #endif                          /* __KERNEL__ */
1145 #endif