drm: remove second forward decleration of drm device struct.
[linux-2.6.git] / drivers / char / drm / drmP.h
blobdde02a15fa59d0f584dbf4bd63feaede1803afe6
1 /**
2 * \file drmP.h
3 * Private header for Direct Rendering Manager
5 * \author Rickard E. (Rik) Faith <faith@valinux.com>
6 * \author Gareth Hughes <gareth@valinux.com>
7 */
9 /*
10 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
11 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
12 * All rights reserved.
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:
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.
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.
34 #ifndef _DRM_P_H_
35 #define _DRM_P_H_
37 /* If you want the memory alloc debug functionality, change define below */
38 /* #define DEBUG_MEMORY */
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"
78 #include <linux/idr.h>
80 #define __OS_HAS_AGP (defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE)))
81 #define __OS_HAS_MTRR (defined(CONFIG_MTRR))
83 struct drm_file;
84 struct drm_device;
86 #include "drm_os_linux.h"
87 #include "drm_hashtab.h"
89 /***********************************************************************/
90 /** \name DRM template customization defaults */
91 /*@{*/
93 /* driver capabilities and requirements mask */
94 #define DRIVER_USE_AGP 0x1
95 #define DRIVER_REQUIRE_AGP 0x2
96 #define DRIVER_USE_MTRR 0x4
97 #define DRIVER_PCI_DMA 0x8
98 #define DRIVER_SG 0x10
99 #define DRIVER_HAVE_DMA 0x20
100 #define DRIVER_HAVE_IRQ 0x40
101 #define DRIVER_IRQ_SHARED 0x80
102 #define DRIVER_IRQ_VBL 0x100
103 #define DRIVER_DMA_QUEUE 0x200
104 #define DRIVER_FB_DMA 0x400
105 #define DRIVER_IRQ_VBL2 0x800
107 /***********************************************************************/
108 /** \name Begin the DRM... */
109 /*@{*/
111 #define DRM_DEBUG_CODE 2 /**< Include debugging code if > 1, then
112 also include looping detection. */
114 #define DRM_MAGIC_HASH_ORDER 4 /**< Size of key hash table. Must be power of 2. */
115 #define DRM_KERNEL_CONTEXT 0 /**< Change drm_resctx if changed */
116 #define DRM_RESERVED_CONTEXTS 1 /**< Change drm_resctx if changed */
117 #define DRM_LOOPING_LIMIT 5000000
118 #define DRM_TIME_SLICE (HZ/20) /**< Time slice for GLXContexts */
119 #define DRM_LOCK_SLICE 1 /**< Time slice for lock, in jiffies */
121 #define DRM_FLAG_DEBUG 0x01
123 #define DRM_MEM_DMA 0
124 #define DRM_MEM_SAREA 1
125 #define DRM_MEM_DRIVER 2
126 #define DRM_MEM_MAGIC 3
127 #define DRM_MEM_IOCTLS 4
128 #define DRM_MEM_MAPS 5
129 #define DRM_MEM_VMAS 6
130 #define DRM_MEM_BUFS 7
131 #define DRM_MEM_SEGS 8
132 #define DRM_MEM_PAGES 9
133 #define DRM_MEM_FILES 10
134 #define DRM_MEM_QUEUES 11
135 #define DRM_MEM_CMDS 12
136 #define DRM_MEM_MAPPINGS 13
137 #define DRM_MEM_BUFLISTS 14
138 #define DRM_MEM_AGPLISTS 15
139 #define DRM_MEM_TOTALAGP 16
140 #define DRM_MEM_BOUNDAGP 17
141 #define DRM_MEM_CTXBITMAP 18
142 #define DRM_MEM_STUB 19
143 #define DRM_MEM_SGLISTS 20
144 #define DRM_MEM_CTXLIST 21
145 #define DRM_MEM_MM 22
146 #define DRM_MEM_HASHTAB 23
148 #define DRM_MAX_CTXBITMAP (PAGE_SIZE * 8)
149 #define DRM_MAP_HASH_OFFSET 0x10000000
151 /*@}*/
153 /***********************************************************************/
154 /** \name Macros to make printk easier */
155 /*@{*/
158 * Error output.
160 * \param fmt printf() like format string.
161 * \param arg arguments
163 #define DRM_ERROR(fmt, arg...) \
164 printk(KERN_ERR "[" DRM_NAME ":%s] *ERROR* " fmt , __FUNCTION__ , ##arg)
167 * Memory error output.
169 * \param area memory area where the error occurred.
170 * \param fmt printf() like format string.
171 * \param arg arguments
173 #define DRM_MEM_ERROR(area, fmt, arg...) \
174 printk(KERN_ERR "[" DRM_NAME ":%s:%s] *ERROR* " fmt , __FUNCTION__, \
175 drm_mem_stats[area].name , ##arg)
177 #define DRM_INFO(fmt, arg...) printk(KERN_INFO "[" DRM_NAME "] " fmt , ##arg)
180 * Debug output.
182 * \param fmt printf() like format string.
183 * \param arg arguments
185 #if DRM_DEBUG_CODE
186 #define DRM_DEBUG(fmt, arg...) \
187 do { \
188 if ( drm_debug ) \
189 printk(KERN_DEBUG \
190 "[" DRM_NAME ":%s] " fmt , \
191 __FUNCTION__ , ##arg); \
192 } while (0)
193 #else
194 #define DRM_DEBUG(fmt, arg...) do { } while (0)
195 #endif
197 #define DRM_PROC_LIMIT (PAGE_SIZE-80)
199 #define DRM_PROC_PRINT(fmt, arg...) \
200 len += sprintf(&buf[len], fmt , ##arg); \
201 if (len > DRM_PROC_LIMIT) { *eof = 1; return len - offset; }
203 #define DRM_PROC_PRINT_RET(ret, fmt, arg...) \
204 len += sprintf(&buf[len], fmt , ##arg); \
205 if (len > DRM_PROC_LIMIT) { ret; *eof = 1; return len - offset; }
207 /*@}*/
209 /***********************************************************************/
210 /** \name Internal types and structures */
211 /*@{*/
213 #define DRM_ARRAY_SIZE(x) ARRAY_SIZE(x)
215 #define DRM_LEFTCOUNT(x) (((x)->rp + (x)->count - (x)->wp) % ((x)->count + 1))
216 #define DRM_BUFCOUNT(x) ((x)->count - DRM_LEFTCOUNT(x))
217 #define DRM_WAITCOUNT(dev,idx) DRM_BUFCOUNT(&dev->queuelist[idx]->waitlist)
219 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
221 * Get the private SAREA mapping.
223 * \param _dev DRM device.
224 * \param _ctx context number.
225 * \param _map output mapping.
227 #define DRM_GET_PRIV_SAREA(_dev, _ctx, _map) do { \
228 (_map) = (_dev)->context_sareas[_ctx]; \
229 } while(0)
232 * Test that the hardware lock is held by the caller, returning otherwise.
234 * \param dev DRM device.
235 * \param filp file pointer of the caller.
237 #define LOCK_TEST_WITH_RETURN( dev, file_priv ) \
238 do { \
239 if ( !_DRM_LOCK_IS_HELD( dev->lock.hw_lock->lock ) || \
240 dev->lock.file_priv != file_priv ) { \
241 DRM_ERROR( "%s called without lock held, held %d owner %p %p\n",\
242 __FUNCTION__, _DRM_LOCK_IS_HELD( dev->lock.hw_lock->lock ),\
243 dev->lock.file_priv, file_priv ); \
244 return -EINVAL; \
246 } while (0)
249 * Copy and IOCTL return string to user space
251 #define DRM_COPY( name, value ) \
252 len = strlen( value ); \
253 if ( len > name##_len ) len = name##_len; \
254 name##_len = strlen( value ); \
255 if ( len && name ) { \
256 if ( copy_to_user( name, value, len ) ) \
257 return -EFAULT; \
261 * Ioctl function type.
263 * \param inode device inode.
264 * \param file_priv DRM file private pointer.
265 * \param cmd command.
266 * \param arg argument.
268 typedef int drm_ioctl_t(struct drm_device *dev, void *data,
269 struct drm_file *file_priv);
271 typedef int drm_ioctl_compat_t(struct file *filp, unsigned int cmd,
272 unsigned long arg);
274 #define DRM_AUTH 0x1
275 #define DRM_MASTER 0x2
276 #define DRM_ROOT_ONLY 0x4
278 struct drm_ioctl_desc {
279 unsigned int cmd;
280 drm_ioctl_t *func;
281 int flags;
285 * Creates a driver or general drm_ioctl_desc array entry for the given
286 * ioctl, for use by drm_ioctl().
288 #define DRM_IOCTL_DEF(ioctl, func, flags) \
289 [DRM_IOCTL_NR(ioctl)] = {ioctl, func, flags}
291 struct drm_magic_entry {
292 struct list_head head;
293 struct drm_hash_item hash_item;
294 struct drm_file *priv;
295 struct drm_magic_entry *next;
298 struct drm_vma_entry {
299 struct list_head head;
300 struct vm_area_struct *vma;
301 pid_t pid;
305 * DMA buffer.
307 struct drm_buf {
308 int idx; /**< Index into master buflist */
309 int total; /**< Buffer size */
310 int order; /**< log-base-2(total) */
311 int used; /**< Amount of buffer in use (for DMA) */
312 unsigned long offset; /**< Byte offset (used internally) */
313 void *address; /**< Address of buffer */
314 unsigned long bus_address; /**< Bus address of buffer */
315 struct drm_buf *next; /**< Kernel-only: used for free list */
316 __volatile__ int waiting; /**< On kernel DMA queue */
317 __volatile__ int pending; /**< On hardware DMA queue */
318 wait_queue_head_t dma_wait; /**< Processes waiting */
319 struct drm_file *file_priv; /**< Private of holding file descr */
320 int context; /**< Kernel queue for this buffer */
321 int while_locked; /**< Dispatch this buffer while locked */
322 enum {
323 DRM_LIST_NONE = 0,
324 DRM_LIST_FREE = 1,
325 DRM_LIST_WAIT = 2,
326 DRM_LIST_PEND = 3,
327 DRM_LIST_PRIO = 4,
328 DRM_LIST_RECLAIM = 5
329 } list; /**< Which list we're on */
331 int dev_priv_size; /**< Size of buffer private storage */
332 void *dev_private; /**< Per-buffer private storage */
335 /** bufs is one longer than it has to be */
336 struct drm_waitlist {
337 int count; /**< Number of possible buffers */
338 struct drm_buf **bufs; /**< List of pointers to buffers */
339 struct drm_buf **rp; /**< Read pointer */
340 struct drm_buf **wp; /**< Write pointer */
341 struct drm_buf **end; /**< End pointer */
342 spinlock_t read_lock;
343 spinlock_t write_lock;
346 struct drm_freelist {
347 int initialized; /**< Freelist in use */
348 atomic_t count; /**< Number of free buffers */
349 struct drm_buf *next; /**< End pointer */
351 wait_queue_head_t waiting; /**< Processes waiting on free bufs */
352 int low_mark; /**< Low water mark */
353 int high_mark; /**< High water mark */
354 atomic_t wfh; /**< If waiting for high mark */
355 spinlock_t lock;
358 typedef struct drm_dma_handle {
359 dma_addr_t busaddr;
360 void *vaddr;
361 size_t size;
362 } drm_dma_handle_t;
365 * Buffer entry. There is one of this for each buffer size order.
367 struct drm_buf_entry {
368 int buf_size; /**< size */
369 int buf_count; /**< number of buffers */
370 struct drm_buf *buflist; /**< buffer list */
371 int seg_count;
372 int page_order;
373 struct drm_dma_handle **seglist;
375 struct drm_freelist freelist;
378 /** File private data */
379 struct drm_file {
380 int authenticated;
381 int master;
382 int minor;
383 pid_t pid;
384 uid_t uid;
385 drm_magic_t magic;
386 unsigned long ioctl_count;
387 struct list_head lhead;
388 struct drm_head *head;
389 int remove_auth_on_close;
390 unsigned long lock_count;
391 void *driver_priv;
392 struct file *filp;
395 /** Wait queue */
396 struct drm_queue {
397 atomic_t use_count; /**< Outstanding uses (+1) */
398 atomic_t finalization; /**< Finalization in progress */
399 atomic_t block_count; /**< Count of processes waiting */
400 atomic_t block_read; /**< Queue blocked for reads */
401 wait_queue_head_t read_queue; /**< Processes waiting on block_read */
402 atomic_t block_write; /**< Queue blocked for writes */
403 wait_queue_head_t write_queue; /**< Processes waiting on block_write */
404 #if 1
405 atomic_t total_queued; /**< Total queued statistic */
406 atomic_t total_flushed; /**< Total flushes statistic */
407 atomic_t total_locks; /**< Total locks statistics */
408 #endif
409 enum drm_ctx_flags flags; /**< Context preserving and 2D-only */
410 struct drm_waitlist waitlist; /**< Pending buffers */
411 wait_queue_head_t flush_queue; /**< Processes waiting until flush */
415 * Lock data.
417 struct drm_lock_data {
418 struct drm_hw_lock *hw_lock; /**< Hardware lock */
419 struct drm_file *file_priv; /**< File descr of lock holder (0=kernel) */
420 wait_queue_head_t lock_queue; /**< Queue of blocked processes */
421 unsigned long lock_time; /**< Time of last lock in jiffies */
422 spinlock_t spinlock;
423 uint32_t kernel_waiters;
424 uint32_t user_waiters;
425 int idle_has_lock;
429 * DMA data.
431 struct drm_device_dma {
433 struct drm_buf_entry bufs[DRM_MAX_ORDER + 1]; /**< buffers, grouped by their size order */
434 int buf_count; /**< total number of buffers */
435 struct drm_buf **buflist; /**< Vector of pointers into drm_device_dma::bufs */
436 int seg_count;
437 int page_count; /**< number of pages */
438 unsigned long *pagelist; /**< page list */
439 unsigned long byte_count;
440 enum {
441 _DRM_DMA_USE_AGP = 0x01,
442 _DRM_DMA_USE_SG = 0x02,
443 _DRM_DMA_USE_FB = 0x04,
444 _DRM_DMA_USE_PCI_RO = 0x08
445 } flags;
450 * AGP memory entry. Stored as a doubly linked list.
452 struct drm_agp_mem {
453 unsigned long handle; /**< handle */
454 DRM_AGP_MEM *memory;
455 unsigned long bound; /**< address */
456 int pages;
457 struct list_head head;
461 * AGP data.
463 * \sa drm_agp_init() and drm_device::agp.
465 struct drm_agp_head {
466 DRM_AGP_KERN agp_info; /**< AGP device information */
467 struct list_head memory;
468 unsigned long mode; /**< AGP mode */
469 struct agp_bridge_data *bridge;
470 int enabled; /**< whether the AGP bus as been enabled */
471 int acquired; /**< whether the AGP device has been acquired */
472 unsigned long base;
473 int agp_mtrr;
474 int cant_use_aperture;
475 unsigned long page_mask;
479 * Scatter-gather memory.
481 struct drm_sg_mem {
482 unsigned long handle;
483 void *virtual;
484 int pages;
485 struct page **pagelist;
486 dma_addr_t *busaddr;
489 struct drm_sigdata {
490 int context;
491 struct drm_hw_lock *lock;
495 * Mappings list
497 struct drm_map_list {
498 struct list_head head; /**< list head */
499 struct drm_hash_item hash;
500 struct drm_map *map; /**< mapping */
501 unsigned int user_token;
504 typedef struct drm_map drm_local_map_t;
507 * Context handle list
509 struct drm_ctx_list {
510 struct list_head head; /**< list head */
511 drm_context_t handle; /**< context handle */
512 struct drm_file *tag; /**< associated fd private data */
515 struct drm_vbl_sig {
516 struct list_head head;
517 unsigned int sequence;
518 struct siginfo info;
519 struct task_struct *task;
522 /* location of GART table */
523 #define DRM_ATI_GART_MAIN 1
524 #define DRM_ATI_GART_FB 2
526 #define DRM_ATI_GART_PCI 1
527 #define DRM_ATI_GART_PCIE 2
528 #define DRM_ATI_GART_IGP 3
530 struct drm_ati_pcigart_info {
531 int gart_table_location;
532 int gart_reg_if;
533 void *addr;
534 dma_addr_t bus_addr;
535 drm_local_map_t mapping;
536 int table_size;
540 * Generic memory manager structs
542 struct drm_mm_node {
543 struct list_head fl_entry;
544 struct list_head ml_entry;
545 int free;
546 unsigned long start;
547 unsigned long size;
548 struct drm_mm *mm;
549 void *private;
552 struct drm_mm {
553 struct list_head fl_entry;
554 struct list_head ml_entry;
558 * DRM driver structure. This structure represent the common code for
559 * a family of cards. There will one drm_device for each card present
560 * in this family
562 struct drm_driver {
563 int (*load) (struct drm_device *, unsigned long flags);
564 int (*firstopen) (struct drm_device *);
565 int (*open) (struct drm_device *, struct drm_file *);
566 void (*preclose) (struct drm_device *, struct drm_file *file_priv);
567 void (*postclose) (struct drm_device *, struct drm_file *);
568 void (*lastclose) (struct drm_device *);
569 int (*unload) (struct drm_device *);
570 int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
571 void (*dma_ready) (struct drm_device *);
572 int (*dma_quiescent) (struct drm_device *);
573 int (*context_ctor) (struct drm_device *dev, int context);
574 int (*context_dtor) (struct drm_device *dev, int context);
575 int (*kernel_context_switch) (struct drm_device *dev, int old,
576 int new);
577 void (*kernel_context_switch_unlock) (struct drm_device *dev);
578 int (*vblank_wait) (struct drm_device *dev, unsigned int *sequence);
579 int (*vblank_wait2) (struct drm_device *dev, unsigned int *sequence);
580 int (*dri_library_name) (struct drm_device *dev, char *buf);
583 * Called by \c drm_device_is_agp. Typically used to determine if a
584 * card is really attached to AGP or not.
586 * \param dev DRM device handle
588 * \returns
589 * One of three values is returned depending on whether or not the
590 * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
591 * (return of 1), or may or may not be AGP (return of 2).
593 int (*device_is_agp) (struct drm_device *dev);
595 /* these have to be filled in */
597 irqreturn_t(*irq_handler) (DRM_IRQ_ARGS);
598 void (*irq_preinstall) (struct drm_device *dev);
599 void (*irq_postinstall) (struct drm_device *dev);
600 void (*irq_uninstall) (struct drm_device *dev);
601 void (*reclaim_buffers) (struct drm_device *dev,
602 struct drm_file * file_priv);
603 void (*reclaim_buffers_locked) (struct drm_device *dev,
604 struct drm_file *file_priv);
605 void (*reclaim_buffers_idlelocked) (struct drm_device *dev,
606 struct drm_file *file_priv);
607 unsigned long (*get_map_ofs) (struct drm_map * map);
608 unsigned long (*get_reg_ofs) (struct drm_device *dev);
609 void (*set_version) (struct drm_device *dev,
610 struct drm_set_version *sv);
612 int major;
613 int minor;
614 int patchlevel;
615 char *name;
616 char *desc;
617 char *date;
619 u32 driver_features;
620 int dev_priv_size;
621 struct drm_ioctl_desc *ioctls;
622 int num_ioctls;
623 struct file_operations fops;
624 struct pci_driver pci_driver;
628 * DRM head structure. This structure represent a video head on a card
629 * that may contain multiple heads. Embed one per head of these in the
630 * private drm_device structure.
632 struct drm_head {
633 int minor; /**< Minor device number */
634 struct drm_device *dev;
635 struct proc_dir_entry *dev_root; /**< proc directory entry */
636 dev_t device; /**< Device number for mknod */
637 struct class_device *dev_class;
641 * DRM device structure. This structure represent a complete card that
642 * may contain multiple heads.
644 struct drm_device {
645 char *unique; /**< Unique identifier: e.g., busid */
646 int unique_len; /**< Length of unique field */
647 char *devname; /**< For /proc/interrupts */
648 int if_version; /**< Highest interface version set */
650 int blocked; /**< Blocked due to VC switch? */
652 /** \name Locks */
653 /*@{ */
654 spinlock_t count_lock; /**< For inuse, drm_device::open_count, drm_device::buf_use */
655 struct mutex struct_mutex; /**< For others */
656 /*@} */
658 /** \name Usage Counters */
659 /*@{ */
660 int open_count; /**< Outstanding files open */
661 atomic_t ioctl_count; /**< Outstanding IOCTLs pending */
662 atomic_t vma_count; /**< Outstanding vma areas open */
663 int buf_use; /**< Buffers in use -- cannot alloc */
664 atomic_t buf_alloc; /**< Buffer allocation in progress */
665 /*@} */
667 /** \name Performance counters */
668 /*@{ */
669 unsigned long counters;
670 enum drm_stat_type types[15];
671 atomic_t counts[15];
672 /*@} */
674 /** \name Authentication */
675 /*@{ */
676 struct list_head filelist;
677 struct drm_open_hash magiclist; /**< magic hash table */
678 struct list_head magicfree;
679 /*@} */
681 /** \name Memory management */
682 /*@{ */
683 struct list_head maplist; /**< Linked list of regions */
684 int map_count; /**< Number of mappable regions */
685 struct drm_open_hash map_hash; /**< User token hash table for maps */
687 /** \name Context handle management */
688 /*@{ */
689 struct list_head ctxlist; /**< Linked list of context handles */
690 int ctx_count; /**< Number of context handles */
691 struct mutex ctxlist_mutex; /**< For ctxlist */
693 struct idr ctx_idr;
695 struct list_head vmalist; /**< List of vmas (for debugging) */
696 struct drm_lock_data lock; /**< Information on hardware lock */
697 /*@} */
699 /** \name DMA queues (contexts) */
700 /*@{ */
701 int queue_count; /**< Number of active DMA queues */
702 int queue_reserved; /**< Number of reserved DMA queues */
703 int queue_slots; /**< Actual length of queuelist */
704 struct drm_queue **queuelist; /**< Vector of pointers to DMA queues */
705 struct drm_device_dma *dma; /**< Optional pointer for DMA support */
706 /*@} */
708 /** \name Context support */
709 /*@{ */
710 int irq; /**< Interrupt used by board */
711 int irq_enabled; /**< True if irq handler is enabled */
712 __volatile__ long context_flag; /**< Context swapping flag */
713 __volatile__ long interrupt_flag; /**< Interruption handler flag */
714 __volatile__ long dma_flag; /**< DMA dispatch flag */
715 struct timer_list timer; /**< Timer for delaying ctx switch */
716 wait_queue_head_t context_wait; /**< Processes waiting on ctx switch */
717 int last_checked; /**< Last context checked for DMA */
718 int last_context; /**< Last current context */
719 unsigned long last_switch; /**< jiffies at last context switch */
720 /*@} */
722 struct work_struct work;
723 /** \name VBLANK IRQ support */
724 /*@{ */
726 wait_queue_head_t vbl_queue; /**< VBLANK wait queue */
727 atomic_t vbl_received;
728 atomic_t vbl_received2; /**< number of secondary VBLANK interrupts */
729 spinlock_t vbl_lock;
730 struct list_head vbl_sigs; /**< signal list to send on VBLANK */
731 struct list_head vbl_sigs2; /**< signals to send on secondary VBLANK */
732 unsigned int vbl_pending;
733 spinlock_t tasklet_lock; /**< For drm_locked_tasklet */
734 void (*locked_tasklet_func)(struct drm_device *dev);
736 /*@} */
737 cycles_t ctx_start;
738 cycles_t lck_start;
740 struct fasync_struct *buf_async;/**< Processes waiting for SIGIO */
741 wait_queue_head_t buf_readers; /**< Processes waiting to read */
742 wait_queue_head_t buf_writers; /**< Processes waiting to ctx switch */
744 struct drm_agp_head *agp; /**< AGP data */
746 struct pci_dev *pdev; /**< PCI device structure */
747 int pci_vendor; /**< PCI vendor id */
748 int pci_device; /**< PCI device id */
749 #ifdef __alpha__
750 struct pci_controller *hose;
751 #endif
752 struct drm_sg_mem *sg; /**< Scatter gather memory */
753 unsigned long *ctx_bitmap; /**< context bitmap */
754 void *dev_private; /**< device private data */
755 struct drm_sigdata sigdata; /**< For block_all_signals */
756 sigset_t sigmask;
758 struct drm_driver *driver;
759 drm_local_map_t *agp_buffer_map;
760 unsigned int agp_buffer_token;
761 struct drm_head primary; /**< primary screen head */
763 /** \name Drawable information */
764 /*@{ */
765 spinlock_t drw_lock;
766 struct idr drw_idr;
767 /*@} */
770 static __inline__ int drm_core_check_feature(struct drm_device *dev,
771 int feature)
773 return ((dev->driver->driver_features & feature) ? 1 : 0);
776 #ifdef __alpha__
777 #define drm_get_pci_domain(dev) dev->hose->index
778 #else
779 #define drm_get_pci_domain(dev) 0
780 #endif
782 #if __OS_HAS_AGP
783 static inline int drm_core_has_AGP(struct drm_device *dev)
785 return drm_core_check_feature(dev, DRIVER_USE_AGP);
787 #else
788 #define drm_core_has_AGP(dev) (0)
789 #endif
791 #if __OS_HAS_MTRR
792 static inline int drm_core_has_MTRR(struct drm_device *dev)
794 return drm_core_check_feature(dev, DRIVER_USE_MTRR);
797 #define DRM_MTRR_WC MTRR_TYPE_WRCOMB
799 static inline int drm_mtrr_add(unsigned long offset, unsigned long size,
800 unsigned int flags)
802 return mtrr_add(offset, size, flags, 1);
805 static inline int drm_mtrr_del(int handle, unsigned long offset,
806 unsigned long size, unsigned int flags)
808 return mtrr_del(handle, offset, size);
811 #else
812 #define drm_core_has_MTRR(dev) (0)
814 #define DRM_MTRR_WC 0
816 static inline int drm_mtrr_add(unsigned long offset, unsigned long size,
817 unsigned int flags)
819 return 0;
822 static inline int drm_mtrr_del(int handle, unsigned long offset,
823 unsigned long size, unsigned int flags)
825 return 0;
827 #endif
829 /******************************************************************/
830 /** \name Internal function definitions */
831 /*@{*/
833 /* Driver support (drm_drv.h) */
834 extern int drm_init(struct drm_driver *driver);
835 extern void drm_exit(struct drm_driver *driver);
836 extern int drm_ioctl(struct inode *inode, struct file *filp,
837 unsigned int cmd, unsigned long arg);
838 extern long drm_compat_ioctl(struct file *filp,
839 unsigned int cmd, unsigned long arg);
840 extern int drm_lastclose(struct drm_device *dev);
842 /* Device support (drm_fops.h) */
843 extern int drm_open(struct inode *inode, struct file *filp);
844 extern int drm_stub_open(struct inode *inode, struct file *filp);
845 extern int drm_fasync(int fd, struct file *filp, int on);
846 extern int drm_release(struct inode *inode, struct file *filp);
848 /* Mapping support (drm_vm.h) */
849 extern int drm_mmap(struct file *filp, struct vm_area_struct *vma);
850 extern unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait);
852 /* Memory management support (drm_memory.h) */
853 #include "drm_memory.h"
854 extern void drm_mem_init(void);
855 extern int drm_mem_info(char *buf, char **start, off_t offset,
856 int request, int *eof, void *data);
857 extern void *drm_realloc(void *oldpt, size_t oldsize, size_t size, int area);
859 extern DRM_AGP_MEM *drm_alloc_agp(struct drm_device *dev, int pages, u32 type);
860 extern int drm_free_agp(DRM_AGP_MEM * handle, int pages);
861 extern int drm_bind_agp(DRM_AGP_MEM * handle, unsigned int start);
862 extern int drm_unbind_agp(DRM_AGP_MEM * handle);
864 /* Misc. IOCTL support (drm_ioctl.h) */
865 extern int drm_irq_by_busid(struct drm_device *dev, void *data,
866 struct drm_file *file_priv);
867 extern int drm_getunique(struct drm_device *dev, void *data,
868 struct drm_file *file_priv);
869 extern int drm_setunique(struct drm_device *dev, void *data,
870 struct drm_file *file_priv);
871 extern int drm_getmap(struct drm_device *dev, void *data,
872 struct drm_file *file_priv);
873 extern int drm_getclient(struct drm_device *dev, void *data,
874 struct drm_file *file_priv);
875 extern int drm_getstats(struct drm_device *dev, void *data,
876 struct drm_file *file_priv);
877 extern int drm_setversion(struct drm_device *dev, void *data,
878 struct drm_file *file_priv);
879 extern int drm_noop(struct drm_device *dev, void *data,
880 struct drm_file *file_priv);
882 /* Context IOCTL support (drm_context.h) */
883 extern int drm_resctx(struct drm_device *dev, void *data,
884 struct drm_file *file_priv);
885 extern int drm_addctx(struct drm_device *dev, void *data,
886 struct drm_file *file_priv);
887 extern int drm_modctx(struct drm_device *dev, void *data,
888 struct drm_file *file_priv);
889 extern int drm_getctx(struct drm_device *dev, void *data,
890 struct drm_file *file_priv);
891 extern int drm_switchctx(struct drm_device *dev, void *data,
892 struct drm_file *file_priv);
893 extern int drm_newctx(struct drm_device *dev, void *data,
894 struct drm_file *file_priv);
895 extern int drm_rmctx(struct drm_device *dev, void *data,
896 struct drm_file *file_priv);
898 extern int drm_ctxbitmap_init(struct drm_device *dev);
899 extern void drm_ctxbitmap_cleanup(struct drm_device *dev);
900 extern void drm_ctxbitmap_free(struct drm_device *dev, int ctx_handle);
902 extern int drm_setsareactx(struct drm_device *dev, void *data,
903 struct drm_file *file_priv);
904 extern int drm_getsareactx(struct drm_device *dev, void *data,
905 struct drm_file *file_priv);
907 /* Drawable IOCTL support (drm_drawable.h) */
908 extern int drm_adddraw(struct drm_device *dev, void *data,
909 struct drm_file *file_priv);
910 extern int drm_rmdraw(struct drm_device *dev, void *data,
911 struct drm_file *file_priv);
912 extern int drm_update_drawable_info(struct drm_device *dev, void *data,
913 struct drm_file *file_priv);
914 extern struct drm_drawable_info *drm_get_drawable_info(struct drm_device *dev,
915 drm_drawable_t id);
916 extern void drm_drawable_free_all(struct drm_device *dev);
918 /* Authentication IOCTL support (drm_auth.h) */
919 extern int drm_getmagic(struct drm_device *dev, void *data,
920 struct drm_file *file_priv);
921 extern int drm_authmagic(struct drm_device *dev, void *data,
922 struct drm_file *file_priv);
924 /* Locking IOCTL support (drm_lock.h) */
925 extern int drm_lock(struct drm_device *dev, void *data,
926 struct drm_file *file_priv);
927 extern int drm_unlock(struct drm_device *dev, void *data,
928 struct drm_file *file_priv);
929 extern int drm_lock_take(struct drm_lock_data *lock_data, unsigned int context);
930 extern int drm_lock_free(struct drm_lock_data *lock_data, unsigned int context);
931 extern void drm_idlelock_take(struct drm_lock_data *lock_data);
932 extern void drm_idlelock_release(struct drm_lock_data *lock_data);
935 * These are exported to drivers so that they can implement fencing using
936 * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
939 extern int drm_i_have_hw_lock(struct drm_device *dev, struct drm_file *file_priv);
941 /* Buffer management support (drm_bufs.h) */
942 extern int drm_addbufs_agp(struct drm_device *dev, struct drm_buf_desc * request);
943 extern int drm_addbufs_pci(struct drm_device *dev, struct drm_buf_desc * request);
944 extern int drm_addmap(struct drm_device *dev, unsigned int offset,
945 unsigned int size, enum drm_map_type type,
946 enum drm_map_flags flags, drm_local_map_t ** map_ptr);
947 extern int drm_addmap_ioctl(struct drm_device *dev, void *data,
948 struct drm_file *file_priv);
949 extern int drm_rmmap(struct drm_device *dev, drm_local_map_t *map);
950 extern int drm_rmmap_locked(struct drm_device *dev, drm_local_map_t *map);
951 extern int drm_rmmap_ioctl(struct drm_device *dev, void *data,
952 struct drm_file *file_priv);
953 extern int drm_addbufs(struct drm_device *dev, void *data,
954 struct drm_file *file_priv);
955 extern int drm_infobufs(struct drm_device *dev, void *data,
956 struct drm_file *file_priv);
957 extern int drm_markbufs(struct drm_device *dev, void *data,
958 struct drm_file *file_priv);
959 extern int drm_freebufs(struct drm_device *dev, void *data,
960 struct drm_file *file_priv);
961 extern int drm_mapbufs(struct drm_device *dev, void *data,
962 struct drm_file *file_priv);
963 extern int drm_order(unsigned long size);
964 extern unsigned long drm_get_resource_start(struct drm_device *dev,
965 unsigned int resource);
966 extern unsigned long drm_get_resource_len(struct drm_device *dev,
967 unsigned int resource);
969 /* DMA support (drm_dma.h) */
970 extern int drm_dma_setup(struct drm_device *dev);
971 extern void drm_dma_takedown(struct drm_device *dev);
972 extern void drm_free_buffer(struct drm_device *dev, struct drm_buf * buf);
973 extern void drm_core_reclaim_buffers(struct drm_device *dev,
974 struct drm_file *filp);
976 /* IRQ support (drm_irq.h) */
977 extern int drm_control(struct drm_device *dev, void *data,
978 struct drm_file *file_priv);
979 extern irqreturn_t drm_irq_handler(DRM_IRQ_ARGS);
980 extern int drm_irq_uninstall(struct drm_device *dev);
981 extern void drm_driver_irq_preinstall(struct drm_device *dev);
982 extern void drm_driver_irq_postinstall(struct drm_device *dev);
983 extern void drm_driver_irq_uninstall(struct drm_device *dev);
985 extern int drm_wait_vblank(struct drm_device *dev, void *data,
986 struct drm_file *file_priv);
987 extern int drm_vblank_wait(struct drm_device *dev, unsigned int *vbl_seq);
988 extern void drm_vbl_send_signals(struct drm_device *dev);
989 extern void drm_locked_tasklet(struct drm_device *dev, void(*func)(struct drm_device*));
991 /* AGP/GART support (drm_agpsupport.h) */
992 extern struct drm_agp_head *drm_agp_init(struct drm_device *dev);
993 extern int drm_agp_acquire(struct drm_device *dev);
994 extern int drm_agp_acquire_ioctl(struct drm_device *dev, void *data,
995 struct drm_file *file_priv);
996 extern int drm_agp_release(struct drm_device *dev);
997 extern int drm_agp_release_ioctl(struct drm_device *dev, void *data,
998 struct drm_file *file_priv);
999 extern int drm_agp_enable(struct drm_device *dev, struct drm_agp_mode mode);
1000 extern int drm_agp_enable_ioctl(struct drm_device *dev, void *data,
1001 struct drm_file *file_priv);
1002 extern int drm_agp_info(struct drm_device *dev, struct drm_agp_info *info);
1003 extern int drm_agp_info_ioctl(struct drm_device *dev, void *data,
1004 struct drm_file *file_priv);
1005 extern int drm_agp_alloc(struct drm_device *dev, struct drm_agp_buffer *request);
1006 extern int drm_agp_alloc_ioctl(struct drm_device *dev, void *data,
1007 struct drm_file *file_priv);
1008 extern int drm_agp_free(struct drm_device *dev, struct drm_agp_buffer *request);
1009 extern int drm_agp_free_ioctl(struct drm_device *dev, void *data,
1010 struct drm_file *file_priv);
1011 extern int drm_agp_unbind(struct drm_device *dev, struct drm_agp_binding *request);
1012 extern int drm_agp_unbind_ioctl(struct drm_device *dev, void *data,
1013 struct drm_file *file_priv);
1014 extern int drm_agp_bind(struct drm_device *dev, struct drm_agp_binding *request);
1015 extern int drm_agp_bind_ioctl(struct drm_device *dev, void *data,
1016 struct drm_file *file_priv);
1017 extern DRM_AGP_MEM *drm_agp_allocate_memory(struct agp_bridge_data *bridge, size_t pages, u32 type);
1018 extern int drm_agp_free_memory(DRM_AGP_MEM * handle);
1019 extern int drm_agp_bind_memory(DRM_AGP_MEM * handle, off_t start);
1020 extern int drm_agp_unbind_memory(DRM_AGP_MEM * handle);
1022 /* Stub support (drm_stub.h) */
1023 extern int drm_get_dev(struct pci_dev *pdev, const struct pci_device_id *ent,
1024 struct drm_driver *driver);
1025 extern int drm_put_dev(struct drm_device *dev);
1026 extern int drm_put_head(struct drm_head *head);
1027 extern unsigned int drm_debug;
1028 extern unsigned int drm_cards_limit;
1029 extern struct drm_head **drm_heads;
1030 extern struct class *drm_class;
1031 extern struct proc_dir_entry *drm_proc_root;
1033 extern drm_local_map_t *drm_getsarea(struct drm_device *dev);
1035 /* Proc support (drm_proc.h) */
1036 extern int drm_proc_init(struct drm_device *dev,
1037 int minor,
1038 struct proc_dir_entry *root,
1039 struct proc_dir_entry **dev_root);
1040 extern int drm_proc_cleanup(int minor,
1041 struct proc_dir_entry *root,
1042 struct proc_dir_entry *dev_root);
1044 /* Scatter Gather Support (drm_scatter.h) */
1045 extern void drm_sg_cleanup(struct drm_sg_mem * entry);
1046 extern int drm_sg_alloc_ioctl(struct drm_device *dev, void *data,
1047 struct drm_file *file_priv);
1048 extern int drm_sg_alloc(struct drm_device *dev, struct drm_scatter_gather * request);
1049 extern int drm_sg_free(struct drm_device *dev, void *data,
1050 struct drm_file *file_priv);
1052 /* ATI PCIGART support (ati_pcigart.h) */
1053 extern int drm_ati_pcigart_init(struct drm_device *dev,
1054 struct drm_ati_pcigart_info * gart_info);
1055 extern int drm_ati_pcigart_cleanup(struct drm_device *dev,
1056 struct drm_ati_pcigart_info * gart_info);
1058 extern drm_dma_handle_t *drm_pci_alloc(struct drm_device *dev, size_t size,
1059 size_t align, dma_addr_t maxaddr);
1060 extern void __drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
1061 extern void drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
1063 /* sysfs support (drm_sysfs.c) */
1064 extern struct class *drm_sysfs_create(struct module *owner, char *name);
1065 extern void drm_sysfs_destroy(struct class *cs);
1066 extern struct class_device *drm_sysfs_device_add(struct class *cs,
1067 struct drm_head *head);
1068 extern void drm_sysfs_device_remove(struct class_device *class_dev);
1071 * Basic memory manager support (drm_mm.c)
1073 extern struct drm_mm_node *drm_mm_get_block(struct drm_mm_node * parent,
1074 unsigned long size,
1075 unsigned alignment);
1076 void drm_mm_put_block(struct drm_mm_node * cur);
1077 extern struct drm_mm_node *drm_mm_search_free(const struct drm_mm *mm, unsigned long size,
1078 unsigned alignment, int best_match);
1079 extern int drm_mm_init(struct drm_mm *mm, unsigned long start, unsigned long size);
1080 extern void drm_mm_takedown(struct drm_mm *mm);
1081 extern int drm_mm_clean(struct drm_mm *mm);
1082 extern unsigned long drm_mm_tail_space(struct drm_mm *mm);
1083 extern int drm_mm_remove_space_from_tail(struct drm_mm *mm, unsigned long size);
1084 extern int drm_mm_add_space_to_tail(struct drm_mm *mm, unsigned long size);
1086 extern void drm_core_ioremap(struct drm_map *map, struct drm_device *dev);
1087 extern void drm_core_ioremapfree(struct drm_map *map, struct drm_device *dev);
1089 static __inline__ struct drm_map *drm_core_findmap(struct drm_device *dev,
1090 unsigned int token)
1092 struct drm_map_list *_entry;
1093 list_for_each_entry(_entry, &dev->maplist, head)
1094 if (_entry->user_token == token)
1095 return _entry->map;
1096 return NULL;
1099 static __inline__ int drm_device_is_agp(struct drm_device *dev)
1101 if (dev->driver->device_is_agp != NULL) {
1102 int err = (*dev->driver->device_is_agp) (dev);
1104 if (err != 2) {
1105 return err;
1109 return pci_find_capability(dev->pdev, PCI_CAP_ID_AGP);
1112 static __inline__ int drm_device_is_pcie(struct drm_device *dev)
1114 return pci_find_capability(dev->pdev, PCI_CAP_ID_EXP);
1117 static __inline__ void drm_core_dropmap(struct drm_map *map)
1121 #ifndef DEBUG_MEMORY
1122 /** Wrapper around kmalloc() */
1123 static __inline__ void *drm_alloc(size_t size, int area)
1125 return kmalloc(size, GFP_KERNEL);
1128 /** Wrapper around kfree() */
1129 static __inline__ void drm_free(void *pt, size_t size, int area)
1131 kfree(pt);
1134 /** Wrapper around kcalloc() */
1135 static __inline__ void *drm_calloc(size_t nmemb, size_t size, int area)
1137 return kcalloc(nmemb, size, GFP_KERNEL);
1139 #else
1140 extern void *drm_alloc(size_t size, int area);
1141 extern void drm_free(void *pt, size_t size, int area);
1142 extern void *drm_calloc(size_t nmemb, size_t size, int area);
1143 #endif
1145 /*@}*/
1147 extern unsigned long drm_core_get_map_ofs(struct drm_map * map);
1148 extern unsigned long drm_core_get_reg_ofs(struct drm_device *dev);
1150 #endif /* __KERNEL__ */
1151 #endif