drm: use kcalloc now that it is available..
[linux-2.6.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/config.h>
48 #include <linux/module.h>
49 #include <linux/kernel.h>
50 #include <linux/miscdevice.h>
51 #include <linux/fs.h>
52 #include <linux/proc_fs.h>
53 #include <linux/init.h>
54 #include <linux/file.h>
55 #include <linux/pci.h>
56 #include <linux/version.h>
57 #include <linux/jiffies.h>
58 #include <linux/smp_lock.h>     /* For (un)lock_kernel */
59 #include <linux/mm.h>
60 #include <linux/cdev.h>
61 #if defined(__alpha__) || defined(__powerpc__)
62 #include <asm/pgtable.h> /* For pte_wrprotect */
63 #endif
64 #include <asm/io.h>
65 #include <asm/mman.h>
66 #include <asm/uaccess.h>
67 #ifdef CONFIG_MTRR
68 #include <asm/mtrr.h>
69 #endif
70 #if defined(CONFIG_AGP) || defined(CONFIG_AGP_MODULE)
71 #include <linux/types.h>
72 #include <linux/agp_backend.h>
73 #endif
74 #include <linux/workqueue.h>
75 #include <linux/poll.h>
76 #include <asm/pgalloc.h>
77 #include "drm.h"
78
79 #define __OS_HAS_AGP (defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE)))
80 #define __OS_HAS_MTRR (defined(CONFIG_MTRR))
81
82 #include "drm_os_linux.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
100 /***********************************************************************/
101 /** \name Begin the DRM... */
102 /*@{*/
103
104 #define DRM_DEBUG_CODE 2          /**< Include debugging code if > 1, then
105                                      also include looping detection. */
106
107 #define DRM_HASH_SIZE         16 /**< Size of key hash table. Must be power of 2. */
108 #define DRM_KERNEL_CONTEXT    0  /**< Change drm_resctx if changed */
109 #define DRM_RESERVED_CONTEXTS 1  /**< Change drm_resctx if changed */
110 #define DRM_LOOPING_LIMIT     5000000
111 #define DRM_BSZ               1024 /**< Buffer size for /dev/drm? output */
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
140 #define DRM_MAX_CTXBITMAP (PAGE_SIZE * 8)
141         
142 /*@}*/
143
144
145 /***********************************************************************/
146 /** \name Backward compatibility section */
147 /*@{*/
148
149 #ifndef MODULE_LICENSE
150 #define MODULE_LICENSE(x) 
151 #endif
152
153 #ifndef preempt_disable
154 #define preempt_disable()
155 #define preempt_enable()
156 #endif
157
158 #ifndef pte_offset_map 
159 #define pte_offset_map pte_offset
160 #define pte_unmap(pte)
161 #endif
162
163 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,4,19)
164 static inline struct page * vmalloc_to_page(void * vmalloc_addr)
165 {
166         unsigned long addr = (unsigned long) vmalloc_addr;
167         struct page *page = NULL;
168         pgd_t *pgd = pgd_offset_k(addr);
169         pmd_t *pmd;
170         pte_t *ptep, pte;
171   
172         if (!pgd_none(*pgd)) {
173                 pmd = pmd_offset(pgd, addr);
174                 if (!pmd_none(*pmd)) {
175                         preempt_disable();
176                         ptep = pte_offset_map(pmd, addr);
177                         pte = *ptep;
178                         if (pte_present(pte))
179                                 page = pte_page(pte);
180                         pte_unmap(ptep);
181                         preempt_enable();
182                 }
183         }
184         return page;
185 }
186 #endif
187
188 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0)
189 #define DRM_RPR_ARG(vma)
190 #else
191 #define DRM_RPR_ARG(vma) vma,
192 #endif
193
194 #define VM_OFFSET(vma) ((vma)->vm_pgoff << PAGE_SHIFT)
195
196 /*@}*/
197
198
199 /***********************************************************************/
200 /** \name Macros to make printk easier */
201 /*@{*/
202
203 /**
204  * Error output.
205  *
206  * \param fmt printf() like format string.
207  * \param arg arguments
208  */
209 #define DRM_ERROR(fmt, arg...) \
210         printk(KERN_ERR "[" DRM_NAME ":%s] *ERROR* " fmt , __FUNCTION__ , ##arg)
211
212 /**
213  * Memory error output.
214  *
215  * \param area memory area where the error occurred.
216  * \param fmt printf() like format string.
217  * \param arg arguments
218  */
219 #define DRM_MEM_ERROR(area, fmt, arg...) \
220         printk(KERN_ERR "[" DRM_NAME ":%s:%s] *ERROR* " fmt , __FUNCTION__, \
221                drm_mem_stats[area].name , ##arg)
222
223 #define DRM_INFO(fmt, arg...)  printk(KERN_INFO "[" DRM_NAME "] " fmt , ##arg)
224
225 /**
226  * Debug output.
227  * 
228  * \param fmt printf() like format string.
229  * \param arg arguments
230  */
231 #if DRM_DEBUG_CODE
232 #define DRM_DEBUG(fmt, arg...)                                          \
233         do {                                                            \
234                 if ( drm_debug )                        \
235                         printk(KERN_DEBUG                               \
236                                "[" DRM_NAME ":%s] " fmt ,       \
237                                __FUNCTION__ , ##arg);                   \
238         } while (0)
239 #else
240 #define DRM_DEBUG(fmt, arg...)           do { } while (0)
241 #endif
242
243 #define DRM_PROC_LIMIT (PAGE_SIZE-80)
244
245 #define DRM_PROC_PRINT(fmt, arg...)                                     \
246    len += sprintf(&buf[len], fmt , ##arg);                              \
247    if (len > DRM_PROC_LIMIT) { *eof = 1; return len - offset; }
248
249 #define DRM_PROC_PRINT_RET(ret, fmt, arg...)                            \
250    len += sprintf(&buf[len], fmt , ##arg);                              \
251    if (len > DRM_PROC_LIMIT) { ret; *eof = 1; return len - offset; }
252
253 /*@}*/
254
255
256 /***********************************************************************/
257 /** \name Internal types and structures */
258 /*@{*/
259
260 #define DRM_ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
261 #define DRM_MIN(a,b) ((a)<(b)?(a):(b))
262 #define DRM_MAX(a,b) ((a)>(b)?(a):(b))
263
264 #define DRM_LEFTCOUNT(x) (((x)->rp + (x)->count - (x)->wp) % ((x)->count + 1))
265 #define DRM_BUFCOUNT(x) ((x)->count - DRM_LEFTCOUNT(x))
266 #define DRM_WAITCOUNT(dev,idx) DRM_BUFCOUNT(&dev->queuelist[idx]->waitlist)
267
268 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
269 /**
270  * Get the private SAREA mapping.
271  *
272  * \param _dev DRM device.
273  * \param _ctx context number.
274  * \param _map output mapping.
275  */
276 #define DRM_GET_PRIV_SAREA(_dev, _ctx, _map) do {       \
277         (_map) = (_dev)->context_sareas[_ctx];          \
278 } while(0)
279
280 /**
281  * Test that the hardware lock is held by the caller, returning otherwise.
282  *
283  * \param dev DRM device.
284  * \param filp file pointer of the caller.
285  */
286 #define LOCK_TEST_WITH_RETURN( dev, filp )                              \
287 do {                                                                    \
288         if ( !_DRM_LOCK_IS_HELD( dev->lock.hw_lock->lock ) ||           \
289              dev->lock.filp != filp ) {                         \
290                 DRM_ERROR( "%s called without lock held\n",             \
291                            __FUNCTION__ );                              \
292                 return -EINVAL;                                         \
293         }                                                               \
294 } while (0)
295
296 /**
297  * Copy and IOCTL return string to user space
298  */
299 #define DRM_COPY( name, value )                                         \
300         len = strlen( value );                                          \
301         if ( len > name##_len ) len = name##_len;                       \
302         name##_len = strlen( value );                                   \
303         if ( len && name ) {                                            \
304                 if ( copy_to_user( name, value, len ) )                 \
305                         return -EFAULT;                                 \
306         }
307         
308 /**
309  * Ioctl function type.
310  *
311  * \param inode device inode.
312  * \param filp file pointer.
313  * \param cmd command.
314  * \param arg argument.
315  */
316 typedef int drm_ioctl_t( struct inode *inode, struct file *filp,
317                          unsigned int cmd, unsigned long arg );
318
319 typedef int drm_ioctl_compat_t(struct file *filp, unsigned int cmd,
320                                unsigned long arg);
321
322 typedef struct drm_ioctl_desc {
323         drm_ioctl_t          *func;
324         int                  auth_needed;
325         int                  root_only;
326 } drm_ioctl_desc_t;
327
328 typedef struct drm_devstate {
329         pid_t             owner;        /**< X server pid holding x_lock */
330 } drm_devstate_t;
331
332 typedef struct drm_magic_entry {
333         drm_magic_t            magic;
334         struct drm_file        *priv;
335         struct drm_magic_entry *next;
336 } drm_magic_entry_t;
337
338 typedef struct drm_magic_head {
339         struct drm_magic_entry *head;
340         struct drm_magic_entry *tail;
341 } drm_magic_head_t;
342
343 typedef struct drm_vma_entry {
344         struct vm_area_struct *vma;
345         struct drm_vma_entry  *next;
346         pid_t                 pid;
347 } drm_vma_entry_t;
348
349 /**
350  * DMA buffer.
351  */
352 typedef struct drm_buf {
353         int               idx;         /**< Index into master buflist */
354         int               total;       /**< Buffer size */
355         int               order;       /**< log-base-2(total) */
356         int               used;        /**< Amount of buffer in use (for DMA) */
357         unsigned long     offset;      /**< Byte offset (used internally) */
358         void              *address;    /**< Address of buffer */
359         unsigned long     bus_address; /**< Bus address of buffer */
360         struct drm_buf    *next;       /**< Kernel-only: used for free list */
361         __volatile__ int  waiting;     /**< On kernel DMA queue */
362         __volatile__ int  pending;     /**< On hardware DMA queue */
363         wait_queue_head_t dma_wait;    /**< Processes waiting */
364         struct file       *filp;       /**< Pointer to holding file descr */
365         int               context;     /**< Kernel queue for this buffer */
366         int               while_locked;/**< Dispatch this buffer while locked */
367         enum {
368                 DRM_LIST_NONE    = 0,
369                 DRM_LIST_FREE    = 1,
370                 DRM_LIST_WAIT    = 2,
371                 DRM_LIST_PEND    = 3,
372                 DRM_LIST_PRIO    = 4,
373                 DRM_LIST_RECLAIM = 5
374         }                 list;        /**< Which list we're on */
375
376         int               dev_priv_size; /**< Size of buffer private storage */
377         void              *dev_private;  /**< Per-buffer private storage */
378 } drm_buf_t;
379
380
381 /** bufs is one longer than it has to be */
382 typedef struct drm_waitlist {
383         int               count;        /**< Number of possible buffers */
384         drm_buf_t         **bufs;       /**< List of pointers to buffers */
385         drm_buf_t         **rp;         /**< Read pointer */
386         drm_buf_t         **wp;         /**< Write pointer */
387         drm_buf_t         **end;        /**< End pointer */
388         spinlock_t        read_lock;
389         spinlock_t        write_lock;
390 } drm_waitlist_t;
391
392 typedef struct drm_freelist {
393         int               initialized; /**< Freelist in use */
394         atomic_t          count;       /**< Number of free buffers */
395         drm_buf_t         *next;       /**< End pointer */
396
397         wait_queue_head_t waiting;     /**< Processes waiting on free bufs */
398         int               low_mark;    /**< Low water mark */
399         int               high_mark;   /**< High water mark */
400         atomic_t          wfh;         /**< If waiting for high mark */
401         spinlock_t        lock;
402 } drm_freelist_t;
403
404 /**
405  * Buffer entry.  There is one of this for each buffer size order.
406  */
407 typedef struct drm_buf_entry {
408         int               buf_size;     /**< size */
409         int               buf_count;    /**< number of buffers */
410         drm_buf_t         *buflist;     /**< buffer list */
411         int               seg_count;
412         int               page_order;
413         unsigned long     *seglist;
414
415         drm_freelist_t    freelist;
416 } drm_buf_entry_t;
417
418 /** File private data */
419 typedef struct drm_file {
420         int               authenticated;
421         int               minor;
422         pid_t             pid;
423         uid_t             uid;
424         drm_magic_t       magic;
425         unsigned long     ioctl_count;
426         struct drm_file   *next;
427         struct drm_file   *prev;
428         struct drm_head   *head;
429         int               remove_auth_on_close;
430         unsigned long     lock_count;
431         void              *driver_priv;
432 } drm_file_t;
433
434 /** Wait queue */
435 typedef struct drm_queue {
436         atomic_t          use_count;    /**< Outstanding uses (+1) */
437         atomic_t          finalization; /**< Finalization in progress */
438         atomic_t          block_count;  /**< Count of processes waiting */
439         atomic_t          block_read;   /**< Queue blocked for reads */
440         wait_queue_head_t read_queue;   /**< Processes waiting on block_read */
441         atomic_t          block_write;  /**< Queue blocked for writes */
442         wait_queue_head_t write_queue;  /**< Processes waiting on block_write */
443 #if 1
444         atomic_t          total_queued; /**< Total queued statistic */
445         atomic_t          total_flushed;/**< Total flushes statistic */
446         atomic_t          total_locks;  /**< Total locks statistics */
447 #endif
448         drm_ctx_flags_t   flags;        /**< Context preserving and 2D-only */
449         drm_waitlist_t    waitlist;     /**< Pending buffers */
450         wait_queue_head_t flush_queue;  /**< Processes waiting until flush */
451 } drm_queue_t;
452
453 /**
454  * Lock data.
455  */
456 typedef struct drm_lock_data {
457         drm_hw_lock_t     *hw_lock;     /**< Hardware lock */
458         struct file       *filp;        /**< File descr of lock holder (0=kernel) */
459         wait_queue_head_t lock_queue;   /**< Queue of blocked processes */
460         unsigned long     lock_time;    /**< Time of last lock in jiffies */
461 } drm_lock_data_t;
462
463 /**
464  * DMA data.
465  */
466 typedef struct drm_device_dma {
467
468         drm_buf_entry_t   bufs[DRM_MAX_ORDER+1];        /**< buffers, grouped by their size order */
469         int               buf_count;    /**< total number of buffers */
470         drm_buf_t         **buflist;    /**< Vector of pointers into drm_device_dma::bufs */
471         int               seg_count;
472         int               page_count;   /**< number of pages */
473         unsigned long     *pagelist;    /**< page list */
474         unsigned long     byte_count;
475         enum {
476                 _DRM_DMA_USE_AGP = 0x01,
477                 _DRM_DMA_USE_SG  = 0x02
478         } flags;
479
480 } drm_device_dma_t;
481
482 /** 
483  * AGP memory entry.  Stored as a doubly linked list.
484  */
485 typedef struct drm_agp_mem {
486         unsigned long      handle;      /**< handle */
487         DRM_AGP_MEM        *memory;     
488         unsigned long      bound;       /**< address */
489         int                pages;
490         struct drm_agp_mem *prev;       /**< previous entry */
491         struct drm_agp_mem *next;       /**< next entry */
492 } drm_agp_mem_t;
493
494 /**
495  * AGP data.
496  *
497  * \sa drm_agp_init() and drm_device::agp.
498  */
499 typedef struct drm_agp_head {
500         DRM_AGP_KERN       agp_info;    /**< AGP device information */
501         drm_agp_mem_t      *memory;     /**< memory entries */
502         unsigned long      mode;        /**< AGP mode */
503         struct agp_bridge_data  *bridge;
504         int                enabled;     /**< whether the AGP bus as been enabled */
505         int                acquired;    /**< whether the AGP device has been acquired */
506         unsigned long      base;
507         int                agp_mtrr;
508         int                cant_use_aperture;
509         unsigned long      page_mask;
510 } drm_agp_head_t;
511
512 /**
513  * Scatter-gather memory.
514  */
515 typedef struct drm_sg_mem {
516         unsigned long   handle;
517         void            *virtual;
518         int             pages;
519         struct page     **pagelist;
520         dma_addr_t      *busaddr;
521 } drm_sg_mem_t;
522
523 typedef struct drm_sigdata {
524         int           context;
525         drm_hw_lock_t *lock;
526 } drm_sigdata_t;
527
528 /**
529  * Mappings list
530  */
531 typedef struct drm_map_list {
532         struct list_head        head;   /**< list head */
533         drm_map_t               *map;   /**< mapping */
534 } drm_map_list_t;
535
536 typedef drm_map_t drm_local_map_t;
537
538 /**
539  * Context handle list
540  */
541 typedef struct drm_ctx_list {
542         struct list_head        head;   /**< list head */
543         drm_context_t           handle; /**< context handle */
544         drm_file_t              *tag;   /**< associated fd private data */
545 } drm_ctx_list_t;
546
547
548 typedef struct drm_vbl_sig {
549         struct list_head        head;
550         unsigned int            sequence;
551         struct siginfo          info;
552         struct task_struct      *task;
553 } drm_vbl_sig_t;
554
555
556 /**
557  * DRM driver structure. This structure represent the common code for
558  * a family of cards. There will one drm_device for each card present
559  * in this family
560  */
561 struct drm_device;
562
563 struct drm_driver {
564         int (*preinit)(struct drm_device *, unsigned long flags);
565         void (*prerelease)(struct drm_device *, struct file *filp);
566         void (*pretakedown)(struct drm_device *);
567         int (*postcleanup)(struct drm_device *);
568         int (*presetup)(struct drm_device *);
569         int (*postsetup)(struct drm_device *);
570         int (*dma_ioctl)( DRM_IOCTL_ARGS );
571         int (*open_helper)(struct drm_device *, drm_file_t *);
572         void (*free_filp_priv)(struct drm_device *, drm_file_t *);
573         void (*release)(struct drm_device *, struct file *filp);
574         void (*dma_ready)(struct drm_device *);
575         int (*dma_quiescent)(struct drm_device *);
576         int (*context_ctor)(struct drm_device *dev, int context);
577         int (*context_dtor)(struct drm_device *dev, int context);
578         int (*kernel_context_switch)(struct drm_device *dev, int old, int new);
579         void (*kernel_context_switch_unlock)(struct drm_device *dev, drm_lock_t *lock);
580         int (*vblank_wait)(struct drm_device *dev, unsigned int *sequence);
581         /* these have to be filled in */
582         int (*postinit)(struct drm_device *, unsigned long flags);
583         irqreturn_t (*irq_handler)( DRM_IRQ_ARGS );
584         void (*irq_preinstall)(struct drm_device *dev);
585         void (*irq_postinstall)(struct drm_device *dev);
586         void (*irq_uninstall)(struct drm_device *dev);
587         void (*reclaim_buffers)(struct drm_device *dev, struct file *filp);
588         unsigned long (*get_map_ofs)(drm_map_t *map);
589         unsigned long (*get_reg_ofs)(struct drm_device *dev);
590         void (*set_version)(struct drm_device *dev, drm_set_version_t *sv);
591         int (*version)(drm_version_t *version);
592         u32 driver_features;
593         int dev_priv_size;
594         drm_ioctl_desc_t *ioctls;
595         int num_ioctls;
596         struct file_operations fops;
597         struct pci_driver pci_driver;
598 };
599
600 /**
601  * DRM head structure. This structure represent a video head on a card
602  * that may contain multiple heads. Embed one per head of these in the
603  * private drm_device structure.
604  */
605 typedef struct drm_head {
606         int minor;                      /**< Minor device number */
607         struct drm_device *dev;
608         struct proc_dir_entry *dev_root;  /**< proc directory entry */
609         dev_t device;                   /**< Device number for mknod */
610         struct class_device *dev_class;
611 } drm_head_t;
612
613 /**
614  * DRM device structure. This structure represent a complete card that
615  * may contain multiple heads.
616  */
617 typedef struct drm_device {
618         char              *unique;      /**< Unique identifier: e.g., busid */
619         int               unique_len;   /**< Length of unique field */
620         char              *devname;     /**< For /proc/interrupts */
621         int               if_version;   /**< Highest interface version set */
622
623         int               blocked;      /**< Blocked due to VC switch? */
624
625         /** \name Locks */
626         /*@{*/
627         spinlock_t        count_lock;   /**< For inuse, drm_device::open_count, drm_device::buf_use */
628         struct semaphore  struct_sem;   /**< For others */
629         /*@}*/
630
631         /** \name Usage Counters */
632         /*@{*/
633         int               open_count;   /**< Outstanding files open */
634         atomic_t          ioctl_count;  /**< Outstanding IOCTLs pending */
635         atomic_t          vma_count;    /**< Outstanding vma areas open */
636         int               buf_use;      /**< Buffers in use -- cannot alloc */
637         atomic_t          buf_alloc;    /**< Buffer allocation in progress */
638         /*@}*/
639
640         /** \name Performance counters */
641         /*@{*/
642         unsigned long     counters;
643         drm_stat_type_t   types[15];
644         atomic_t          counts[15];
645         /*@}*/
646
647         /** \name Authentication */
648         /*@{*/
649         drm_file_t        *file_first;  /**< file list head */
650         drm_file_t        *file_last;   /**< file list tail */
651         drm_magic_head_t  magiclist[DRM_HASH_SIZE];     /**< magic hash table */
652         /*@}*/
653
654         /** \name Memory management */
655         /*@{*/
656         drm_map_list_t    *maplist;     /**< Linked list of regions */
657         int               map_count;    /**< Number of mappable regions */
658
659         /** \name Context handle management */
660         /*@{*/
661         drm_ctx_list_t    *ctxlist;     /**< Linked list of context handles */
662         int               ctx_count;    /**< Number of context handles */
663         struct semaphore  ctxlist_sem;  /**< For ctxlist */
664
665         drm_map_t         **context_sareas; /**< per-context SAREA's */
666         int               max_context;
667
668         drm_vma_entry_t   *vmalist;     /**< List of vmas (for debugging) */
669         drm_lock_data_t   lock;         /**< Information on hardware lock */
670         /*@}*/
671
672         /** \name DMA queues (contexts) */
673         /*@{*/
674         int               queue_count;  /**< Number of active DMA queues */
675         int               queue_reserved; /**< Number of reserved DMA queues */
676         int               queue_slots;  /**< Actual length of queuelist */
677         drm_queue_t       **queuelist;  /**< Vector of pointers to DMA queues */
678         drm_device_dma_t  *dma;         /**< Optional pointer for DMA support */
679         /*@}*/
680
681         /** \name Context support */
682         /*@{*/
683         int               irq;          /**< Interrupt used by board */
684         int               irq_enabled;  /**< True if irq handler is enabled */
685         __volatile__ long context_flag; /**< Context swapping flag */
686         __volatile__ long interrupt_flag; /**< Interruption handler flag */
687         __volatile__ long dma_flag;     /**< DMA dispatch flag */
688         struct timer_list timer;        /**< Timer for delaying ctx switch */
689         wait_queue_head_t context_wait; /**< Processes waiting on ctx switch */
690         int               last_checked; /**< Last context checked for DMA */
691         int               last_context; /**< Last current context */
692         unsigned long     last_switch;  /**< jiffies at last context switch */
693         /*@}*/
694         
695         struct work_struct      work;
696         /** \name VBLANK IRQ support */
697         /*@{*/
698
699         wait_queue_head_t vbl_queue;    /**< VBLANK wait queue */
700         atomic_t          vbl_received;
701         spinlock_t        vbl_lock;
702         drm_vbl_sig_t     vbl_sigs;     /**< signal list to send on VBLANK */
703         unsigned int      vbl_pending;
704
705         /*@}*/
706         cycles_t          ctx_start;
707         cycles_t          lck_start;
708
709         char              buf[DRM_BSZ]; /**< Output buffer */
710         char              *buf_rp;      /**< Read pointer */
711         char              *buf_wp;      /**< Write pointer */
712         char              *buf_end;     /**< End pointer */
713         struct fasync_struct *buf_async;/**< Processes waiting for SIGIO */
714         wait_queue_head_t buf_readers;  /**< Processes waiting to read */
715         wait_queue_head_t buf_writers;  /**< Processes waiting to ctx switch */
716
717         drm_agp_head_t    *agp; /**< AGP data */
718
719         struct pci_dev    *pdev;        /**< PCI device structure */
720         int               pci_domain;   /**< PCI bus domain number */
721         int               pci_bus;      /**< PCI bus number */
722         int               pci_slot;     /**< PCI slot number */
723         int               pci_func;     /**< PCI function number */
724 #ifdef __alpha__
725 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,4,3)
726         struct pci_controler *hose;
727 #else
728         struct pci_controller *hose;
729 #endif
730 #endif
731         drm_sg_mem_t      *sg;  /**< Scatter gather memory */
732         unsigned long     *ctx_bitmap;  /**< context bitmap */
733         void              *dev_private; /**< device private data */
734         drm_sigdata_t     sigdata; /**< For block_all_signals */
735         sigset_t          sigmask;
736
737         struct            drm_driver *driver;
738         drm_local_map_t   *agp_buffer_map;
739         drm_head_t primary;             /**< primary screen head */
740 } drm_device_t;
741
742 static __inline__ int drm_core_check_feature(struct drm_device *dev, int feature)
743 {
744         return ((dev->driver->driver_features & feature) ? 1 : 0);
745 }
746
747 #if __OS_HAS_AGP
748 static inline int drm_core_has_AGP(struct drm_device *dev)
749 {
750   return drm_core_check_feature(dev, DRIVER_USE_AGP);
751 }
752 #else
753 #define drm_core_has_AGP(dev) (0)
754 #endif
755
756 #if __OS_HAS_MTRR
757 static inline int drm_core_has_MTRR(struct drm_device *dev)
758 {
759   return drm_core_check_feature(dev, DRIVER_USE_MTRR);
760 }
761 #else
762 #define drm_core_has_MTRR(dev) (0)
763 #endif
764
765 /******************************************************************/
766 /** \name Internal function definitions */
767 /*@{*/
768
769                                 /* Misc. support (drm_init.h) */
770 extern int           drm_flags;
771 extern void          drm_parse_options( char *s );
772 extern int           drm_cpu_valid( void );
773
774                                 /* Driver support (drm_drv.h) */
775 extern int           drm_init(struct drm_driver *driver);
776 extern void          drm_exit(struct drm_driver *driver);
777 extern int           drm_version(struct inode *inode, struct file *filp,
778                                   unsigned int cmd, unsigned long arg);
779 extern int           drm_ioctl(struct inode *inode, struct file *filp,
780                                 unsigned int cmd, unsigned long arg);
781 extern long          drm_compat_ioctl(struct file *filp,
782                                 unsigned int cmd, unsigned long arg);
783 extern int           drm_takedown(drm_device_t * dev);
784
785                                 /* Device support (drm_fops.h) */
786 extern int           drm_open(struct inode *inode, struct file *filp);
787 extern int           drm_stub_open(struct inode *inode, struct file *filp);
788 extern int           drm_open_helper(struct inode *inode, struct file *filp,
789                                       drm_device_t *dev);
790 extern int           drm_flush(struct file *filp);
791 extern int           drm_fasync(int fd, struct file *filp, int on);
792 extern int           drm_release(struct inode *inode, struct file *filp);
793
794                                 /* Mapping support (drm_vm.h) */
795 extern void          drm_vm_open(struct vm_area_struct *vma);
796 extern void          drm_vm_close(struct vm_area_struct *vma);
797 extern void          drm_vm_shm_close(struct vm_area_struct *vma);
798 extern int           drm_mmap_dma(struct file *filp,
799                                    struct vm_area_struct *vma);
800 extern int           drm_mmap(struct file *filp, struct vm_area_struct *vma);
801 extern unsigned int  drm_poll(struct file *filp, struct poll_table_struct *wait);
802 extern ssize_t       drm_read(struct file *filp, char __user *buf, size_t count, loff_t *off);
803
804                                 /* Memory management support (drm_memory.h) */
805 #include "drm_memory.h"
806 extern void          drm_mem_init(void);
807 extern int           drm_mem_info(char *buf, char **start, off_t offset,
808                                    int request, int *eof, void *data);
809 extern void          *drm_realloc(void *oldpt, size_t oldsize, size_t size,
810                                    int area);
811 extern unsigned long drm_alloc_pages(int order, int area);
812 extern void          drm_free_pages(unsigned long address, int order,
813                                      int area);
814 extern void          *drm_ioremap(unsigned long offset, unsigned long size, drm_device_t *dev);
815 extern void          *drm_ioremap_nocache(unsigned long offset, unsigned long size,
816                                            drm_device_t *dev);
817 extern void          drm_ioremapfree(void *pt, unsigned long size, drm_device_t *dev);
818
819 extern DRM_AGP_MEM   *drm_alloc_agp(struct agp_bridge_data *bridge, int pages, u32 type);
820 extern int           drm_free_agp(DRM_AGP_MEM *handle, int pages);
821 extern int           drm_bind_agp(DRM_AGP_MEM *handle, unsigned int start);
822 extern int           drm_unbind_agp(DRM_AGP_MEM *handle);
823
824                                 /* Misc. IOCTL support (drm_ioctl.h) */
825 extern int           drm_irq_by_busid(struct inode *inode, struct file *filp,
826                                        unsigned int cmd, unsigned long arg);
827 extern int           drm_getunique(struct inode *inode, struct file *filp,
828                                     unsigned int cmd, unsigned long arg);
829 extern int           drm_setunique(struct inode *inode, struct file *filp,
830                                     unsigned int cmd, unsigned long arg);
831 extern int           drm_getmap(struct inode *inode, struct file *filp,
832                                  unsigned int cmd, unsigned long arg);
833 extern int           drm_getclient(struct inode *inode, struct file *filp,
834                                     unsigned int cmd, unsigned long arg);
835 extern int           drm_getstats(struct inode *inode, struct file *filp,
836                                    unsigned int cmd, unsigned long arg);
837 extern int           drm_setversion(struct inode *inode, struct file *filp,
838                                      unsigned int cmd, unsigned long arg);
839
840                                 /* Context IOCTL support (drm_context.h) */
841 extern int           drm_resctx( struct inode *inode, struct file *filp,
842                                   unsigned int cmd, unsigned long arg );
843 extern int           drm_addctx( struct inode *inode, struct file *filp,
844                                   unsigned int cmd, unsigned long arg );
845 extern int           drm_modctx( struct inode *inode, struct file *filp,
846                                   unsigned int cmd, unsigned long arg );
847 extern int           drm_getctx( struct inode *inode, struct file *filp,
848                                   unsigned int cmd, unsigned long arg );
849 extern int           drm_switchctx( struct inode *inode, struct file *filp,
850                                      unsigned int cmd, unsigned long arg );
851 extern int           drm_newctx( struct inode *inode, struct file *filp,
852                                   unsigned int cmd, unsigned long arg );
853 extern int           drm_rmctx( struct inode *inode, struct file *filp,
854                                  unsigned int cmd, unsigned long arg );
855
856 extern int           drm_context_switch(drm_device_t *dev, int old, int new);
857 extern int           drm_context_switch_complete(drm_device_t *dev, int new);
858
859 extern int           drm_ctxbitmap_init( drm_device_t *dev );
860 extern void          drm_ctxbitmap_cleanup( drm_device_t *dev );
861 extern void          drm_ctxbitmap_free( drm_device_t *dev, int ctx_handle );
862
863 extern int           drm_setsareactx( struct inode *inode, struct file *filp,
864                                        unsigned int cmd, unsigned long arg );
865 extern int           drm_getsareactx( struct inode *inode, struct file *filp,
866                                        unsigned int cmd, unsigned long arg );
867
868                                 /* Drawable IOCTL support (drm_drawable.h) */
869 extern int           drm_adddraw(struct inode *inode, struct file *filp,
870                                   unsigned int cmd, unsigned long arg);
871 extern int           drm_rmdraw(struct inode *inode, struct file *filp,
872                                  unsigned int cmd, unsigned long arg);
873
874
875                                 /* Authentication IOCTL support (drm_auth.h) */
876 extern int           drm_add_magic(drm_device_t *dev, drm_file_t *priv,
877                                     drm_magic_t magic);
878 extern int           drm_remove_magic(drm_device_t *dev, drm_magic_t magic);
879 extern int           drm_getmagic(struct inode *inode, struct file *filp,
880                                    unsigned int cmd, unsigned long arg);
881 extern int           drm_authmagic(struct inode *inode, struct file *filp,
882                                     unsigned int cmd, unsigned long arg);
883
884                                 /* Placeholder for ioctls past */
885 extern int           drm_noop(struct inode *inode, struct file *filp,
886                                   unsigned int cmd, unsigned long arg);
887
888                                 /* Locking IOCTL support (drm_lock.h) */
889 extern int           drm_lock(struct inode *inode, struct file *filp,
890                                unsigned int cmd, unsigned long arg);
891 extern int           drm_unlock(struct inode *inode, struct file *filp,
892                                  unsigned int cmd, unsigned long arg);
893 extern int           drm_lock_take(__volatile__ unsigned int *lock,
894                                     unsigned int context);
895 extern int           drm_lock_transfer(drm_device_t *dev,
896                                         __volatile__ unsigned int *lock,
897                                         unsigned int context);
898 extern int           drm_lock_free(drm_device_t *dev,
899                                     __volatile__ unsigned int *lock,
900                                     unsigned int context);
901 extern int           drm_notifier(void *priv);
902
903                                 /* Buffer management support (drm_bufs.h) */
904 extern int           drm_order( unsigned long size );
905 extern int           drm_addmap( struct inode *inode, struct file *filp,
906                                   unsigned int cmd, unsigned long arg );
907 extern int           drm_rmmap( struct inode *inode, struct file *filp,
908                                  unsigned int cmd, unsigned long arg );
909 extern int           drm_addbufs( struct inode *inode, struct file *filp,
910                                    unsigned int cmd, unsigned long arg );
911 extern int           drm_infobufs( struct inode *inode, struct file *filp,
912                                     unsigned int cmd, unsigned long arg );
913 extern int           drm_markbufs( struct inode *inode, struct file *filp,
914                                     unsigned int cmd, unsigned long arg );
915 extern int           drm_freebufs( struct inode *inode, struct file *filp,
916                                     unsigned int cmd, unsigned long arg );
917 extern int           drm_mapbufs( struct inode *inode, struct file *filp,
918                                    unsigned int cmd, unsigned long arg );
919
920                                 /* DMA support (drm_dma.h) */
921 extern int           drm_dma_setup(drm_device_t *dev);
922 extern void          drm_dma_takedown(drm_device_t *dev);
923 extern void          drm_free_buffer(drm_device_t *dev, drm_buf_t *buf);
924 extern void          drm_core_reclaim_buffers(drm_device_t *dev, struct file *filp);
925
926                                 /* IRQ support (drm_irq.h) */
927 extern int           drm_control( struct inode *inode, struct file *filp,
928                                    unsigned int cmd, unsigned long arg );
929 extern int           drm_irq_install( drm_device_t *dev );
930 extern int           drm_irq_uninstall( drm_device_t *dev );
931 extern irqreturn_t   drm_irq_handler( DRM_IRQ_ARGS );
932 extern void          drm_driver_irq_preinstall( drm_device_t *dev );
933 extern void          drm_driver_irq_postinstall( drm_device_t *dev );
934 extern void          drm_driver_irq_uninstall( drm_device_t *dev );
935
936 extern int           drm_wait_vblank(struct inode *inode, struct file *filp,
937                                       unsigned int cmd, unsigned long arg);
938 extern int           drm_vblank_wait(drm_device_t *dev, unsigned int *vbl_seq);
939 extern void          drm_vbl_send_signals( drm_device_t *dev );
940
941                                 /* AGP/GART support (drm_agpsupport.h) */
942 extern drm_agp_head_t *drm_agp_init(drm_device_t *dev);
943 extern int            drm_agp_acquire(struct inode *inode, struct file *filp,
944                                        unsigned int cmd, unsigned long arg);
945 extern void           drm_agp_do_release(drm_device_t *dev);
946 extern int            drm_agp_release(struct inode *inode, struct file *filp,
947                                        unsigned int cmd, unsigned long arg);
948 extern int            drm_agp_enable(struct inode *inode, struct file *filp,
949                                       unsigned int cmd, unsigned long arg);
950 extern int            drm_agp_info(struct inode *inode, struct file *filp,
951                                     unsigned int cmd, unsigned long arg);
952 extern int            drm_agp_alloc(struct inode *inode, struct file *filp,
953                                      unsigned int cmd, unsigned long arg);
954 extern int            drm_agp_free(struct inode *inode, struct file *filp,
955                                     unsigned int cmd, unsigned long arg);
956 extern int            drm_agp_unbind(struct inode *inode, struct file *filp,
957                                       unsigned int cmd, unsigned long arg);
958 extern int            drm_agp_bind(struct inode *inode, struct file *filp,
959                                     unsigned int cmd, unsigned long arg);
960 extern DRM_AGP_MEM    *drm_agp_allocate_memory(struct agp_bridge_data *bridge, size_t pages, u32 type);
961 extern int            drm_agp_free_memory(DRM_AGP_MEM *handle);
962 extern int            drm_agp_bind_memory(DRM_AGP_MEM *handle, off_t start);
963 extern int            drm_agp_unbind_memory(DRM_AGP_MEM *handle);
964
965                                 /* Stub support (drm_stub.h) */
966 extern int drm_get_dev(struct pci_dev *pdev, const struct pci_device_id *ent,
967                      struct drm_driver *driver);
968 extern int drm_put_dev(drm_device_t * dev);
969 extern int drm_get_head(drm_device_t * dev, drm_head_t *head);
970 extern int drm_put_head(drm_head_t * head);
971 extern unsigned int   drm_debug;
972 extern unsigned int   drm_cards_limit;
973 extern drm_head_t **drm_heads;
974 extern struct drm_sysfs_class *drm_class;
975 extern struct proc_dir_entry *drm_proc_root;
976
977                                 /* Proc support (drm_proc.h) */
978 extern int            drm_proc_init(drm_device_t *dev,
979                                              int minor,
980                                              struct proc_dir_entry *root,
981                                              struct proc_dir_entry **dev_root);
982 extern int            drm_proc_cleanup(int minor,
983                                         struct proc_dir_entry *root,
984                                         struct proc_dir_entry *dev_root);
985
986                                 /* Scatter Gather Support (drm_scatter.h) */
987 extern void           drm_sg_cleanup(drm_sg_mem_t *entry);
988 extern int            drm_sg_alloc(struct inode *inode, struct file *filp,
989                                     unsigned int cmd, unsigned long arg);
990 extern int            drm_sg_free(struct inode *inode, struct file *filp,
991                                    unsigned int cmd, unsigned long arg);
992
993                                /* ATI PCIGART support (ati_pcigart.h) */
994 extern int            drm_ati_pcigart_init(drm_device_t *dev,
995                                             unsigned long *addr,
996                                             dma_addr_t *bus_addr);
997 extern int            drm_ati_pcigart_cleanup(drm_device_t *dev,
998                                                unsigned long addr,
999                                                dma_addr_t bus_addr);
1000
1001 extern void *drm_pci_alloc(drm_device_t * dev, size_t size,
1002                            size_t align, dma_addr_t maxaddr,
1003                            dma_addr_t * busaddr);
1004
1005 extern void drm_pci_free(drm_device_t * dev, size_t size,
1006                          void *vaddr, dma_addr_t busaddr);
1007
1008                                /* sysfs support (drm_sysfs.c) */
1009 struct drm_sysfs_class;
1010 extern struct drm_sysfs_class *drm_sysfs_create(struct module *owner,
1011                                                 char *name);
1012 extern void drm_sysfs_destroy(struct drm_sysfs_class *cs);
1013 extern struct class_device *drm_sysfs_device_add(struct drm_sysfs_class *cs,
1014                                                  dev_t dev,
1015                                                  struct device *device,
1016                                                  const char *fmt, ...);
1017 extern void drm_sysfs_device_remove(dev_t dev);
1018
1019
1020 /* Inline replacements for DRM_IOREMAP macros */
1021 static __inline__ void drm_core_ioremap(struct drm_map *map, struct drm_device *dev)
1022 {
1023         map->handle = drm_ioremap( map->offset, map->size, dev );
1024 }
1025
1026 static __inline__ void drm_core_ioremap_nocache(struct drm_map *map, struct drm_device *dev)
1027 {
1028         map->handle = drm_ioremap_nocache(map->offset, map->size, dev);
1029 }
1030
1031 static __inline__ void drm_core_ioremapfree(struct drm_map *map, struct drm_device *dev)
1032 {
1033         if ( map->handle && map->size )
1034                 drm_ioremapfree( map->handle, map->size, dev );
1035 }
1036
1037 static __inline__ struct drm_map *drm_core_findmap(struct drm_device *dev, unsigned long offset)
1038 {
1039         struct list_head *_list;
1040         list_for_each( _list, &dev->maplist->head ) {
1041                 drm_map_list_t *_entry = list_entry( _list, drm_map_list_t, head );
1042                 if ( _entry->map &&
1043                      _entry->map->offset == offset ) {
1044                         return _entry->map;
1045                 }
1046         }
1047         return NULL;
1048 }
1049
1050 static __inline__ void drm_core_dropmap(struct drm_map *map)
1051 {
1052 }
1053
1054 #ifndef DEBUG_MEMORY
1055 /** Wrapper around kmalloc() */
1056 static __inline__ void *drm_alloc(size_t size, int area)
1057 {
1058         return kmalloc(size, GFP_KERNEL);
1059 }
1060
1061 /** Wrapper around kfree() */
1062 static __inline__ void drm_free(void *pt, size_t size, int area)
1063 {
1064         kfree(pt);
1065 }
1066
1067 /** Wrapper around kcalloc() */
1068 static __inline__ void *drm_calloc(size_t nmemb, size_t size, int area)
1069 {
1070         return kcalloc(nmemb, size, GFP_KERNEL);
1071 }
1072 #else
1073 extern void *drm_alloc(size_t size, int area);
1074 extern void drm_free(void *pt, size_t size, int area);
1075 extern void *drm_calloc(size_t nmemb, size_t size, int area);
1076 #endif
1077
1078 /*@}*/
1079
1080 extern unsigned long drm_core_get_map_ofs(drm_map_t *map);
1081 extern unsigned long drm_core_get_reg_ofs(struct drm_device *dev);
1082
1083 #endif /* __KERNEL__ */
1084 #endif