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