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