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