3 * Private header for Direct Rendering Manager
5 * \author Rickard E. (Rik) Faith <faith@valinux.com>
6 * \author Gareth Hughes <gareth@valinux.com>
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
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.
37 /* If you want the memory alloc debug functionality, change define below */
38 /* #define DEBUG_MEMORY */
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>
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/dma-mapping.h>
59 #include <linux/cdev.h>
60 #include <linux/mutex.h>
61 #if defined(__alpha__) || defined(__powerpc__)
62 #include <asm/pgtable.h> /* For pte_wrprotect */
66 #include <asm/uaccess.h>
70 #if defined(CONFIG_AGP) || defined(CONFIG_AGP_MODULE)
71 #include <linux/types.h>
72 #include <linux/agp_backend.h>
74 #include <linux/workqueue.h>
75 #include <linux/poll.h>
76 #include <asm/pgalloc.h>
79 #include <linux/idr.h>
81 #define __OS_HAS_AGP (defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE)))
82 #define __OS_HAS_MTRR (defined(CONFIG_MTRR))
87 #include "drm_os_linux.h"
88 #include "drm_hashtab.h"
90 /***********************************************************************/
91 /** \name DRM template customization defaults */
94 /* driver capabilities and requirements mask */
95 #define DRIVER_USE_AGP 0x1
96 #define DRIVER_REQUIRE_AGP 0x2
97 #define DRIVER_USE_MTRR 0x4
98 #define DRIVER_PCI_DMA 0x8
99 #define DRIVER_SG 0x10
100 #define DRIVER_HAVE_DMA 0x20
101 #define DRIVER_HAVE_IRQ 0x40
102 #define DRIVER_IRQ_SHARED 0x80
103 #define DRIVER_IRQ_VBL 0x100
104 #define DRIVER_DMA_QUEUE 0x200
105 #define DRIVER_FB_DMA 0x400
106 #define DRIVER_IRQ_VBL2 0x800
107 #define DRIVER_GEM 0x1000
109 /***********************************************************************/
110 /** \name Begin the DRM... */
113 #define DRM_DEBUG_CODE 2 /**< Include debugging code if > 1, then
114 also include looping detection. */
116 #define DRM_MAGIC_HASH_ORDER 4 /**< Size of key hash table. Must be power of 2. */
117 #define DRM_KERNEL_CONTEXT 0 /**< Change drm_resctx if changed */
118 #define DRM_RESERVED_CONTEXTS 1 /**< Change drm_resctx if changed */
119 #define DRM_LOOPING_LIMIT 5000000
120 #define DRM_TIME_SLICE (HZ/20) /**< Time slice for GLXContexts */
121 #define DRM_LOCK_SLICE 1 /**< Time slice for lock, in jiffies */
123 #define DRM_FLAG_DEBUG 0x01
125 #define DRM_MEM_DMA 0
126 #define DRM_MEM_SAREA 1
127 #define DRM_MEM_DRIVER 2
128 #define DRM_MEM_MAGIC 3
129 #define DRM_MEM_IOCTLS 4
130 #define DRM_MEM_MAPS 5
131 #define DRM_MEM_VMAS 6
132 #define DRM_MEM_BUFS 7
133 #define DRM_MEM_SEGS 8
134 #define DRM_MEM_PAGES 9
135 #define DRM_MEM_FILES 10
136 #define DRM_MEM_QUEUES 11
137 #define DRM_MEM_CMDS 12
138 #define DRM_MEM_MAPPINGS 13
139 #define DRM_MEM_BUFLISTS 14
140 #define DRM_MEM_AGPLISTS 15
141 #define DRM_MEM_TOTALAGP 16
142 #define DRM_MEM_BOUNDAGP 17
143 #define DRM_MEM_CTXBITMAP 18
144 #define DRM_MEM_STUB 19
145 #define DRM_MEM_SGLISTS 20
146 #define DRM_MEM_CTXLIST 21
147 #define DRM_MEM_MM 22
148 #define DRM_MEM_HASHTAB 23
150 #define DRM_MAX_CTXBITMAP (PAGE_SIZE * 8)
151 #define DRM_MAP_HASH_OFFSET 0x10000000
155 /***********************************************************************/
156 /** \name Macros to make printk easier */
162 * \param fmt printf() like format string.
163 * \param arg arguments
165 #define DRM_ERROR(fmt, arg...) \
166 printk(KERN_ERR "[" DRM_NAME ":%s] *ERROR* " fmt , __func__ , ##arg)
169 * Memory error output.
171 * \param area memory area where the error occurred.
172 * \param fmt printf() like format string.
173 * \param arg arguments
175 #define DRM_MEM_ERROR(area, fmt, arg...) \
176 printk(KERN_ERR "[" DRM_NAME ":%s:%s] *ERROR* " fmt , __func__, \
177 drm_mem_stats[area].name , ##arg)
179 #define DRM_INFO(fmt, arg...) printk(KERN_INFO "[" DRM_NAME "] " fmt , ##arg)
184 * \param fmt printf() like format string.
185 * \param arg arguments
188 #define DRM_DEBUG(fmt, arg...) \
192 "[" DRM_NAME ":%s] " fmt , \
196 #define DRM_DEBUG(fmt, arg...) do { } while (0)
199 #define DRM_PROC_LIMIT (PAGE_SIZE-80)
201 #define DRM_PROC_PRINT(fmt, arg...) \
202 len += sprintf(&buf[len], fmt , ##arg); \
203 if (len > DRM_PROC_LIMIT) { *eof = 1; return len - offset; }
205 #define DRM_PROC_PRINT_RET(ret, fmt, arg...) \
206 len += sprintf(&buf[len], fmt , ##arg); \
207 if (len > DRM_PROC_LIMIT) { ret; *eof = 1; return len - offset; }
211 /***********************************************************************/
212 /** \name Internal types and structures */
215 #define DRM_ARRAY_SIZE(x) ARRAY_SIZE(x)
217 #define DRM_LEFTCOUNT(x) (((x)->rp + (x)->count - (x)->wp) % ((x)->count + 1))
218 #define DRM_BUFCOUNT(x) ((x)->count - DRM_LEFTCOUNT(x))
219 #define DRM_WAITCOUNT(dev,idx) DRM_BUFCOUNT(&dev->queuelist[idx]->waitlist)
221 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
223 * Get the private SAREA mapping.
225 * \param _dev DRM device.
226 * \param _ctx context number.
227 * \param _map output mapping.
229 #define DRM_GET_PRIV_SAREA(_dev, _ctx, _map) do { \
230 (_map) = (_dev)->context_sareas[_ctx]; \
234 * Test that the hardware lock is held by the caller, returning otherwise.
236 * \param dev DRM device.
237 * \param filp file pointer of the caller.
239 #define LOCK_TEST_WITH_RETURN( dev, file_priv ) \
241 if (!_DRM_LOCK_IS_HELD(file_priv->master->lock.hw_lock->lock) || \
242 file_priv->master->lock.file_priv != file_priv) { \
243 DRM_ERROR( "%s called without lock held, held %d owner %p %p\n",\
244 __func__, _DRM_LOCK_IS_HELD(file_priv->master->lock.hw_lock->lock),\
245 file_priv->master->lock.file_priv, file_priv); \
251 * Copy and IOCTL return string to user space
253 #define DRM_COPY( name, value ) \
254 len = strlen( value ); \
255 if ( len > name##_len ) len = name##_len; \
256 name##_len = strlen( value ); \
257 if ( len && name ) { \
258 if ( copy_to_user( name, value, len ) ) \
263 * Ioctl function type.
265 * \param inode device inode.
266 * \param file_priv DRM file private pointer.
267 * \param cmd command.
268 * \param arg argument.
270 typedef int drm_ioctl_t(struct drm_device *dev, void *data,
271 struct drm_file *file_priv);
273 typedef int drm_ioctl_compat_t(struct file *filp, unsigned int cmd,
277 #define DRM_MASTER 0x2
278 #define DRM_ROOT_ONLY 0x4
280 struct drm_ioctl_desc {
287 * Creates a driver or general drm_ioctl_desc array entry for the given
288 * ioctl, for use by drm_ioctl().
290 #define DRM_IOCTL_DEF(ioctl, func, flags) \
291 [DRM_IOCTL_NR(ioctl)] = {ioctl, func, flags}
293 struct drm_magic_entry {
294 struct list_head head;
295 struct drm_hash_item hash_item;
296 struct drm_file *priv;
299 struct drm_vma_entry {
300 struct list_head head;
301 struct vm_area_struct *vma;
309 int idx; /**< Index into master buflist */
310 int total; /**< Buffer size */
311 int order; /**< log-base-2(total) */
312 int used; /**< Amount of buffer in use (for DMA) */
313 unsigned long offset; /**< Byte offset (used internally) */
314 void *address; /**< Address of buffer */
315 unsigned long bus_address; /**< Bus address of buffer */
316 struct drm_buf *next; /**< Kernel-only: used for free list */
317 __volatile__ int waiting; /**< On kernel DMA queue */
318 __volatile__ int pending; /**< On hardware DMA queue */
319 wait_queue_head_t dma_wait; /**< Processes waiting */
320 struct drm_file *file_priv; /**< Private of holding file descr */
321 int context; /**< Kernel queue for this buffer */
322 int while_locked; /**< Dispatch this buffer while locked */
330 } list; /**< Which list we're on */
332 int dev_priv_size; /**< Size of buffer private storage */
333 void *dev_private; /**< Per-buffer private storage */
336 /** bufs is one longer than it has to be */
337 struct drm_waitlist {
338 int count; /**< Number of possible buffers */
339 struct drm_buf **bufs; /**< List of pointers to buffers */
340 struct drm_buf **rp; /**< Read pointer */
341 struct drm_buf **wp; /**< Write pointer */
342 struct drm_buf **end; /**< End pointer */
343 spinlock_t read_lock;
344 spinlock_t write_lock;
347 struct drm_freelist {
348 int initialized; /**< Freelist in use */
349 atomic_t count; /**< Number of free buffers */
350 struct drm_buf *next; /**< End pointer */
352 wait_queue_head_t waiting; /**< Processes waiting on free bufs */
353 int low_mark; /**< Low water mark */
354 int high_mark; /**< High water mark */
355 atomic_t wfh; /**< If waiting for high mark */
359 typedef struct drm_dma_handle {
366 * Buffer entry. There is one of this for each buffer size order.
368 struct drm_buf_entry {
369 int buf_size; /**< size */
370 int buf_count; /**< number of buffers */
371 struct drm_buf *buflist; /**< buffer list */
374 struct drm_dma_handle **seglist;
376 struct drm_freelist freelist;
379 /** File private data */
385 unsigned long ioctl_count;
386 struct list_head lhead;
387 struct drm_minor *minor;
388 unsigned long lock_count;
390 /** Mapping of mm object handles to object pointers. */
391 struct idr object_idr;
392 /** Lock for synchronization of access to object_idr. */
393 spinlock_t table_lock;
398 int is_master; /* this file private is a master for a minor */
399 struct drm_master *master; /* master this node is currently associated with
400 N.B. not always minor->master */
405 atomic_t use_count; /**< Outstanding uses (+1) */
406 atomic_t finalization; /**< Finalization in progress */
407 atomic_t block_count; /**< Count of processes waiting */
408 atomic_t block_read; /**< Queue blocked for reads */
409 wait_queue_head_t read_queue; /**< Processes waiting on block_read */
410 atomic_t block_write; /**< Queue blocked for writes */
411 wait_queue_head_t write_queue; /**< Processes waiting on block_write */
412 atomic_t total_queued; /**< Total queued statistic */
413 atomic_t total_flushed; /**< Total flushes statistic */
414 atomic_t total_locks; /**< Total locks statistics */
415 enum drm_ctx_flags flags; /**< Context preserving and 2D-only */
416 struct drm_waitlist waitlist; /**< Pending buffers */
417 wait_queue_head_t flush_queue; /**< Processes waiting until flush */
423 struct drm_lock_data {
424 struct drm_hw_lock *hw_lock; /**< Hardware lock */
425 /** Private of lock holder's file (NULL=kernel) */
426 struct drm_file *file_priv;
427 wait_queue_head_t lock_queue; /**< Queue of blocked processes */
428 unsigned long lock_time; /**< Time of last lock in jiffies */
430 uint32_t kernel_waiters;
431 uint32_t user_waiters;
438 struct drm_device_dma {
440 struct drm_buf_entry bufs[DRM_MAX_ORDER + 1]; /**< buffers, grouped by their size order */
441 int buf_count; /**< total number of buffers */
442 struct drm_buf **buflist; /**< Vector of pointers into drm_device_dma::bufs */
444 int page_count; /**< number of pages */
445 unsigned long *pagelist; /**< page list */
446 unsigned long byte_count;
448 _DRM_DMA_USE_AGP = 0x01,
449 _DRM_DMA_USE_SG = 0x02,
450 _DRM_DMA_USE_FB = 0x04,
451 _DRM_DMA_USE_PCI_RO = 0x08
457 * AGP memory entry. Stored as a doubly linked list.
460 unsigned long handle; /**< handle */
462 unsigned long bound; /**< address */
464 struct list_head head;
470 * \sa drm_agp_init() and drm_device::agp.
472 struct drm_agp_head {
473 DRM_AGP_KERN agp_info; /**< AGP device information */
474 struct list_head memory;
475 unsigned long mode; /**< AGP mode */
476 struct agp_bridge_data *bridge;
477 int enabled; /**< whether the AGP bus as been enabled */
478 int acquired; /**< whether the AGP device has been acquired */
481 int cant_use_aperture;
482 unsigned long page_mask;
486 * Scatter-gather memory.
489 unsigned long handle;
492 struct page **pagelist;
498 struct drm_hw_lock *lock;
503 * Generic memory manager structs
507 struct list_head fl_entry;
508 struct list_head ml_entry;
517 struct list_head fl_entry;
518 struct list_head ml_entry;
525 struct drm_map_list {
526 struct list_head head; /**< list head */
527 struct drm_hash_item hash;
528 struct drm_map *map; /**< mapping */
530 struct drm_master *master;
533 typedef struct drm_map drm_local_map_t;
536 * Context handle list
538 struct drm_ctx_list {
539 struct list_head head; /**< list head */
540 drm_context_t handle; /**< context handle */
541 struct drm_file *tag; /**< associated fd private data */
545 struct list_head head;
546 unsigned int sequence;
548 struct task_struct *task;
551 /* location of GART table */
552 #define DRM_ATI_GART_MAIN 1
553 #define DRM_ATI_GART_FB 2
555 #define DRM_ATI_GART_PCI 1
556 #define DRM_ATI_GART_PCIE 2
557 #define DRM_ATI_GART_IGP 3
559 struct drm_ati_pcigart_info {
560 int gart_table_location;
564 dma_addr_t table_mask;
565 struct drm_dma_handle *table_handle;
566 drm_local_map_t mapping;
571 * This structure defines the drm_mm memory object, which will be used by the
572 * DRM for its buffer objects.
574 struct drm_gem_object {
575 /** Reference count of this object */
576 struct kref refcount;
578 /** Handle count of this object. Each handle also holds a reference */
579 struct kref handlecount;
581 /** Related drm device */
582 struct drm_device *dev;
584 /** File representing the shmem storage */
588 * Size of the object, in bytes. Immutable over the object's
594 * Global name for this object, starts at 1. 0 means unnamed.
595 * Access is covered by the object_name_lock in the related drm_device
600 * Memory domains. These monitor which caches contain read/write data
601 * related to the object. When transitioning from one set of domains
602 * to another, the driver is called to ensure that caches are suitably
603 * flushed and invalidated
605 uint32_t read_domains;
606 uint32_t write_domain;
609 * While validating an exec operation, the
610 * new read/write domain values are computed here.
611 * They will be transferred to the above values
612 * at the point that any cache flushing occurs
614 uint32_t pending_read_domains;
615 uint32_t pending_write_domain;
617 void *driver_private;
620 /* per-master structure */
623 struct kref refcount; /* refcount for this master */
625 struct list_head head; /**< each minor contains a list of masters */
626 struct drm_minor *minor; /**< link back to minor we are a master for */
628 char *unique; /**< Unique identifier: e.g., busid */
629 int unique_len; /**< Length of unique field */
631 int blocked; /**< Blocked due to VC switch? */
633 /** \name Authentication */
635 struct drm_open_hash magiclist;
636 struct list_head magicfree;
639 struct drm_lock_data lock; /**< Information on hardware lock */
641 void *driver_priv; /**< Private structure for driver to use */
645 * DRM driver structure. This structure represent the common code for
646 * a family of cards. There will one drm_device for each card present
650 int (*load) (struct drm_device *, unsigned long flags);
651 int (*firstopen) (struct drm_device *);
652 int (*open) (struct drm_device *, struct drm_file *);
653 void (*preclose) (struct drm_device *, struct drm_file *file_priv);
654 void (*postclose) (struct drm_device *, struct drm_file *);
655 void (*lastclose) (struct drm_device *);
656 int (*unload) (struct drm_device *);
657 int (*suspend) (struct drm_device *, pm_message_t state);
658 int (*resume) (struct drm_device *);
659 int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
660 void (*dma_ready) (struct drm_device *);
661 int (*dma_quiescent) (struct drm_device *);
662 int (*context_ctor) (struct drm_device *dev, int context);
663 int (*context_dtor) (struct drm_device *dev, int context);
664 int (*kernel_context_switch) (struct drm_device *dev, int old,
666 void (*kernel_context_switch_unlock) (struct drm_device *dev);
667 int (*dri_library_name) (struct drm_device *dev, char *buf);
670 * get_vblank_counter - get raw hardware vblank counter
672 * @crtc: counter to fetch
674 * Driver callback for fetching a raw hardware vblank counter
675 * for @crtc. If a device doesn't have a hardware counter, the
676 * driver can simply return the value of drm_vblank_count and
677 * make the enable_vblank() and disable_vblank() hooks into no-ops,
678 * leaving interrupts enabled at all times.
680 * Wraparound handling and loss of events due to modesetting is dealt
681 * with in the DRM core code.
684 * Raw vblank counter value.
686 u32 (*get_vblank_counter) (struct drm_device *dev, int crtc);
689 * enable_vblank - enable vblank interrupt events
691 * @crtc: which irq to enable
693 * Enable vblank interrupts for @crtc. If the device doesn't have
694 * a hardware vblank counter, this routine should be a no-op, since
695 * interrupts will have to stay on to keep the count accurate.
698 * Zero on success, appropriate errno if the given @crtc's vblank
699 * interrupt cannot be enabled.
701 int (*enable_vblank) (struct drm_device *dev, int crtc);
704 * disable_vblank - disable vblank interrupt events
706 * @crtc: which irq to enable
708 * Disable vblank interrupts for @crtc. If the device doesn't have
709 * a hardware vblank counter, this routine should be a no-op, since
710 * interrupts will have to stay on to keep the count accurate.
712 void (*disable_vblank) (struct drm_device *dev, int crtc);
715 * Called by \c drm_device_is_agp. Typically used to determine if a
716 * card is really attached to AGP or not.
718 * \param dev DRM device handle
721 * One of three values is returned depending on whether or not the
722 * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
723 * (return of 1), or may or may not be AGP (return of 2).
725 int (*device_is_agp) (struct drm_device *dev);
727 /* these have to be filled in */
729 irqreturn_t(*irq_handler) (DRM_IRQ_ARGS);
730 void (*irq_preinstall) (struct drm_device *dev);
731 int (*irq_postinstall) (struct drm_device *dev);
732 void (*irq_uninstall) (struct drm_device *dev);
733 void (*reclaim_buffers) (struct drm_device *dev,
734 struct drm_file * file_priv);
735 void (*reclaim_buffers_locked) (struct drm_device *dev,
736 struct drm_file *file_priv);
737 void (*reclaim_buffers_idlelocked) (struct drm_device *dev,
738 struct drm_file *file_priv);
739 unsigned long (*get_map_ofs) (struct drm_map * map);
740 unsigned long (*get_reg_ofs) (struct drm_device *dev);
741 void (*set_version) (struct drm_device *dev,
742 struct drm_set_version *sv);
744 /* Master routines */
745 int (*master_create)(struct drm_device *dev, struct drm_master *master);
746 void (*master_destroy)(struct drm_device *dev, struct drm_master *master);
748 int (*proc_init)(struct drm_minor *minor);
749 void (*proc_cleanup)(struct drm_minor *minor);
752 * Driver-specific constructor for drm_gem_objects, to set up
753 * obj->driver_private.
755 * Returns 0 on success.
757 int (*gem_init_object) (struct drm_gem_object *obj);
758 void (*gem_free_object) (struct drm_gem_object *obj);
769 struct drm_ioctl_desc *ioctls;
771 struct file_operations fops;
772 struct pci_driver pci_driver;
773 /* List of devices hanging off this driver */
774 struct list_head device_list;
777 #define DRM_MINOR_UNASSIGNED 0
778 #define DRM_MINOR_LEGACY 1
781 * DRM minor structure. This structure represents a drm minor number.
784 int index; /**< Minor device number */
785 int type; /**< Control or render */
786 dev_t device; /**< Device number for mknod */
787 struct device kdev; /**< Linux device */
788 struct drm_device *dev;
789 struct proc_dir_entry *dev_root; /**< proc directory entry */
790 struct drm_master *master; /* currently active master for this node */
791 struct list_head master_list;
795 * DRM device structure. This structure represent a complete card that
796 * may contain multiple heads.
799 struct list_head driver_item; /**< list of devices per driver */
800 char *devname; /**< For /proc/interrupts */
801 int if_version; /**< Highest interface version set */
805 spinlock_t count_lock; /**< For inuse, drm_device::open_count, drm_device::buf_use */
806 struct mutex struct_mutex; /**< For others */
809 /** \name Usage Counters */
811 int open_count; /**< Outstanding files open */
812 atomic_t ioctl_count; /**< Outstanding IOCTLs pending */
813 atomic_t vma_count; /**< Outstanding vma areas open */
814 int buf_use; /**< Buffers in use -- cannot alloc */
815 atomic_t buf_alloc; /**< Buffer allocation in progress */
818 /** \name Performance counters */
820 unsigned long counters;
821 enum drm_stat_type types[15];
825 struct list_head filelist;
827 /** \name Memory management */
829 struct list_head maplist; /**< Linked list of regions */
830 int map_count; /**< Number of mappable regions */
831 struct drm_open_hash map_hash; /**< User token hash table for maps */
833 /** \name Context handle management */
835 struct list_head ctxlist; /**< Linked list of context handles */
836 int ctx_count; /**< Number of context handles */
837 struct mutex ctxlist_mutex; /**< For ctxlist */
841 struct list_head vmalist; /**< List of vmas (for debugging) */
844 /** \name DMA queues (contexts) */
846 int queue_count; /**< Number of active DMA queues */
847 int queue_reserved; /**< Number of reserved DMA queues */
848 int queue_slots; /**< Actual length of queuelist */
849 struct drm_queue **queuelist; /**< Vector of pointers to DMA queues */
850 struct drm_device_dma *dma; /**< Optional pointer for DMA support */
853 /** \name Context support */
855 int irq_enabled; /**< True if irq handler is enabled */
856 __volatile__ long context_flag; /**< Context swapping flag */
857 __volatile__ long interrupt_flag; /**< Interruption handler flag */
858 __volatile__ long dma_flag; /**< DMA dispatch flag */
859 struct timer_list timer; /**< Timer for delaying ctx switch */
860 wait_queue_head_t context_wait; /**< Processes waiting on ctx switch */
861 int last_checked; /**< Last context checked for DMA */
862 int last_context; /**< Last current context */
863 unsigned long last_switch; /**< jiffies at last context switch */
866 struct work_struct work;
867 /** \name VBLANK IRQ support */
871 * At load time, disabling the vblank interrupt won't be allowed since
872 * old clients may not call the modeset ioctl and therefore misbehave.
873 * Once the modeset ioctl *has* been called though, we can safely
874 * disable them when unused.
876 int vblank_disable_allowed;
878 wait_queue_head_t *vbl_queue; /**< VBLANK wait queue */
879 atomic_t *_vblank_count; /**< number of VBLANK interrupts (driver must alloc the right number of counters) */
881 struct list_head *vbl_sigs; /**< signal list to send on VBLANK */
882 atomic_t vbl_signal_pending; /* number of signals pending on all crtcs*/
883 atomic_t *vblank_refcount; /* number of users of vblank interruptsper crtc */
884 u32 *last_vblank; /* protected by dev->vbl_lock, used */
885 /* for wraparound handling */
886 int *vblank_enabled; /* so we don't call enable more than
888 int *vblank_inmodeset; /* Display driver is setting mode */
889 struct timer_list vblank_disable_timer;
891 u32 max_vblank_count; /**< size of vblank counter register */
897 struct fasync_struct *buf_async;/**< Processes waiting for SIGIO */
898 wait_queue_head_t buf_readers; /**< Processes waiting to read */
899 wait_queue_head_t buf_writers; /**< Processes waiting to ctx switch */
901 struct drm_agp_head *agp; /**< AGP data */
903 struct pci_dev *pdev; /**< PCI device structure */
904 int pci_vendor; /**< PCI vendor id */
905 int pci_device; /**< PCI device id */
907 struct pci_controller *hose;
909 struct drm_sg_mem *sg; /**< Scatter gather memory */
910 int num_crtcs; /**< Number of CRTCs on this device */
911 void *dev_private; /**< device private data */
912 struct drm_sigdata sigdata; /**< For block_all_signals */
915 struct drm_driver *driver;
916 drm_local_map_t *agp_buffer_map;
917 unsigned int agp_buffer_token;
918 struct drm_minor *primary; /**< render type primary screen head */
920 /** \name Drawable information */
926 /** \name GEM information */
928 spinlock_t object_name_lock;
929 struct idr object_name_idr;
930 atomic_t object_count;
931 atomic_t object_memory;
937 uint32_t invalidate_domains; /* domains pending invalidation */
938 uint32_t flush_domains; /* domains pending flush */
943 static inline int drm_dev_to_irq(struct drm_device *dev)
945 return dev->pdev->irq;
948 static __inline__ int drm_core_check_feature(struct drm_device *dev,
951 return ((dev->driver->driver_features & feature) ? 1 : 0);
955 #define drm_get_pci_domain(dev) dev->hose->index
957 #define drm_get_pci_domain(dev) 0
961 static inline int drm_core_has_AGP(struct drm_device *dev)
963 return drm_core_check_feature(dev, DRIVER_USE_AGP);
966 #define drm_core_has_AGP(dev) (0)
970 static inline int drm_core_has_MTRR(struct drm_device *dev)
972 return drm_core_check_feature(dev, DRIVER_USE_MTRR);
975 #define DRM_MTRR_WC MTRR_TYPE_WRCOMB
977 static inline int drm_mtrr_add(unsigned long offset, unsigned long size,
980 return mtrr_add(offset, size, flags, 1);
983 static inline int drm_mtrr_del(int handle, unsigned long offset,
984 unsigned long size, unsigned int flags)
986 return mtrr_del(handle, offset, size);
990 #define drm_core_has_MTRR(dev) (0)
992 #define DRM_MTRR_WC 0
994 static inline int drm_mtrr_add(unsigned long offset, unsigned long size,
1000 static inline int drm_mtrr_del(int handle, unsigned long offset,
1001 unsigned long size, unsigned int flags)
1007 /******************************************************************/
1008 /** \name Internal function definitions */
1011 /* Driver support (drm_drv.h) */
1012 extern int drm_init(struct drm_driver *driver);
1013 extern void drm_exit(struct drm_driver *driver);
1014 extern int drm_ioctl(struct inode *inode, struct file *filp,
1015 unsigned int cmd, unsigned long arg);
1016 extern long drm_compat_ioctl(struct file *filp,
1017 unsigned int cmd, unsigned long arg);
1018 extern int drm_lastclose(struct drm_device *dev);
1020 /* Device support (drm_fops.h) */
1021 extern int drm_open(struct inode *inode, struct file *filp);
1022 extern int drm_stub_open(struct inode *inode, struct file *filp);
1023 extern int drm_fasync(int fd, struct file *filp, int on);
1024 extern int drm_release(struct inode *inode, struct file *filp);
1026 /* Mapping support (drm_vm.h) */
1027 extern int drm_mmap(struct file *filp, struct vm_area_struct *vma);
1028 extern unsigned long drm_core_get_map_ofs(struct drm_map * map);
1029 extern unsigned long drm_core_get_reg_ofs(struct drm_device *dev);
1030 extern unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait);
1032 /* Memory management support (drm_memory.h) */
1033 #include "drm_memory.h"
1034 extern void drm_mem_init(void);
1035 extern int drm_mem_info(char *buf, char **start, off_t offset,
1036 int request, int *eof, void *data);
1037 extern void *drm_realloc(void *oldpt, size_t oldsize, size_t size, int area);
1039 extern DRM_AGP_MEM *drm_alloc_agp(struct drm_device *dev, int pages, u32 type);
1040 extern int drm_free_agp(DRM_AGP_MEM * handle, int pages);
1041 extern int drm_bind_agp(DRM_AGP_MEM * handle, unsigned int start);
1042 extern DRM_AGP_MEM *drm_agp_bind_pages(struct drm_device *dev,
1043 struct page **pages,
1044 unsigned long num_pages,
1045 uint32_t gtt_offset,
1047 extern int drm_unbind_agp(DRM_AGP_MEM * handle);
1049 /* Misc. IOCTL support (drm_ioctl.h) */
1050 extern int drm_irq_by_busid(struct drm_device *dev, void *data,
1051 struct drm_file *file_priv);
1052 extern int drm_getunique(struct drm_device *dev, void *data,
1053 struct drm_file *file_priv);
1054 extern int drm_setunique(struct drm_device *dev, void *data,
1055 struct drm_file *file_priv);
1056 extern int drm_getmap(struct drm_device *dev, void *data,
1057 struct drm_file *file_priv);
1058 extern int drm_getclient(struct drm_device *dev, void *data,
1059 struct drm_file *file_priv);
1060 extern int drm_getstats(struct drm_device *dev, void *data,
1061 struct drm_file *file_priv);
1062 extern int drm_setversion(struct drm_device *dev, void *data,
1063 struct drm_file *file_priv);
1064 extern int drm_noop(struct drm_device *dev, void *data,
1065 struct drm_file *file_priv);
1067 /* Context IOCTL support (drm_context.h) */
1068 extern int drm_resctx(struct drm_device *dev, void *data,
1069 struct drm_file *file_priv);
1070 extern int drm_addctx(struct drm_device *dev, void *data,
1071 struct drm_file *file_priv);
1072 extern int drm_modctx(struct drm_device *dev, void *data,
1073 struct drm_file *file_priv);
1074 extern int drm_getctx(struct drm_device *dev, void *data,
1075 struct drm_file *file_priv);
1076 extern int drm_switchctx(struct drm_device *dev, void *data,
1077 struct drm_file *file_priv);
1078 extern int drm_newctx(struct drm_device *dev, void *data,
1079 struct drm_file *file_priv);
1080 extern int drm_rmctx(struct drm_device *dev, void *data,
1081 struct drm_file *file_priv);
1083 extern int drm_ctxbitmap_init(struct drm_device *dev);
1084 extern void drm_ctxbitmap_cleanup(struct drm_device *dev);
1085 extern void drm_ctxbitmap_free(struct drm_device *dev, int ctx_handle);
1087 extern int drm_setsareactx(struct drm_device *dev, void *data,
1088 struct drm_file *file_priv);
1089 extern int drm_getsareactx(struct drm_device *dev, void *data,
1090 struct drm_file *file_priv);
1092 /* Drawable IOCTL support (drm_drawable.h) */
1093 extern int drm_adddraw(struct drm_device *dev, void *data,
1094 struct drm_file *file_priv);
1095 extern int drm_rmdraw(struct drm_device *dev, void *data,
1096 struct drm_file *file_priv);
1097 extern int drm_update_drawable_info(struct drm_device *dev, void *data,
1098 struct drm_file *file_priv);
1099 extern struct drm_drawable_info *drm_get_drawable_info(struct drm_device *dev,
1101 extern void drm_drawable_free_all(struct drm_device *dev);
1103 /* Authentication IOCTL support (drm_auth.h) */
1104 extern int drm_getmagic(struct drm_device *dev, void *data,
1105 struct drm_file *file_priv);
1106 extern int drm_authmagic(struct drm_device *dev, void *data,
1107 struct drm_file *file_priv);
1109 /* Cache management (drm_cache.c) */
1110 void drm_clflush_pages(struct page *pages[], unsigned long num_pages);
1112 /* Locking IOCTL support (drm_lock.h) */
1113 extern int drm_lock(struct drm_device *dev, void *data,
1114 struct drm_file *file_priv);
1115 extern int drm_unlock(struct drm_device *dev, void *data,
1116 struct drm_file *file_priv);
1117 extern int drm_lock_take(struct drm_lock_data *lock_data, unsigned int context);
1118 extern int drm_lock_free(struct drm_lock_data *lock_data, unsigned int context);
1119 extern void drm_idlelock_take(struct drm_lock_data *lock_data);
1120 extern void drm_idlelock_release(struct drm_lock_data *lock_data);
1123 * These are exported to drivers so that they can implement fencing using
1124 * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
1127 extern int drm_i_have_hw_lock(struct drm_device *dev, struct drm_file *file_priv);
1129 /* Buffer management support (drm_bufs.h) */
1130 extern int drm_addbufs_agp(struct drm_device *dev, struct drm_buf_desc * request);
1131 extern int drm_addbufs_pci(struct drm_device *dev, struct drm_buf_desc * request);
1132 extern int drm_addmap(struct drm_device *dev, unsigned int offset,
1133 unsigned int size, enum drm_map_type type,
1134 enum drm_map_flags flags, drm_local_map_t ** map_ptr);
1135 extern int drm_addmap_ioctl(struct drm_device *dev, void *data,
1136 struct drm_file *file_priv);
1137 extern int drm_rmmap(struct drm_device *dev, drm_local_map_t *map);
1138 extern int drm_rmmap_locked(struct drm_device *dev, drm_local_map_t *map);
1139 extern int drm_rmmap_ioctl(struct drm_device *dev, void *data,
1140 struct drm_file *file_priv);
1141 extern int drm_addbufs(struct drm_device *dev, void *data,
1142 struct drm_file *file_priv);
1143 extern int drm_infobufs(struct drm_device *dev, void *data,
1144 struct drm_file *file_priv);
1145 extern int drm_markbufs(struct drm_device *dev, void *data,
1146 struct drm_file *file_priv);
1147 extern int drm_freebufs(struct drm_device *dev, void *data,
1148 struct drm_file *file_priv);
1149 extern int drm_mapbufs(struct drm_device *dev, void *data,
1150 struct drm_file *file_priv);
1151 extern int drm_order(unsigned long size);
1152 extern unsigned long drm_get_resource_start(struct drm_device *dev,
1153 unsigned int resource);
1154 extern unsigned long drm_get_resource_len(struct drm_device *dev,
1155 unsigned int resource);
1157 /* DMA support (drm_dma.h) */
1158 extern int drm_dma_setup(struct drm_device *dev);
1159 extern void drm_dma_takedown(struct drm_device *dev);
1160 extern void drm_free_buffer(struct drm_device *dev, struct drm_buf * buf);
1161 extern void drm_core_reclaim_buffers(struct drm_device *dev,
1162 struct drm_file *filp);
1164 /* IRQ support (drm_irq.h) */
1165 extern int drm_control(struct drm_device *dev, void *data,
1166 struct drm_file *file_priv);
1167 extern irqreturn_t drm_irq_handler(DRM_IRQ_ARGS);
1168 extern int drm_irq_install(struct drm_device *dev);
1169 extern int drm_irq_uninstall(struct drm_device *dev);
1170 extern void drm_driver_irq_preinstall(struct drm_device *dev);
1171 extern void drm_driver_irq_postinstall(struct drm_device *dev);
1172 extern void drm_driver_irq_uninstall(struct drm_device *dev);
1174 extern int drm_vblank_init(struct drm_device *dev, int num_crtcs);
1175 extern int drm_wait_vblank(struct drm_device *dev, void *data,
1176 struct drm_file *filp);
1177 extern int drm_vblank_wait(struct drm_device *dev, unsigned int *vbl_seq);
1178 extern u32 drm_vblank_count(struct drm_device *dev, int crtc);
1179 extern void drm_handle_vblank(struct drm_device *dev, int crtc);
1180 extern int drm_vblank_get(struct drm_device *dev, int crtc);
1181 extern void drm_vblank_put(struct drm_device *dev, int crtc);
1182 extern void drm_vblank_cleanup(struct drm_device *dev);
1183 /* Modesetting support */
1184 extern int drm_modeset_ctl(struct drm_device *dev, void *data,
1185 struct drm_file *file_priv);
1187 /* AGP/GART support (drm_agpsupport.h) */
1188 extern struct drm_agp_head *drm_agp_init(struct drm_device *dev);
1189 extern int drm_agp_acquire(struct drm_device *dev);
1190 extern int drm_agp_acquire_ioctl(struct drm_device *dev, void *data,
1191 struct drm_file *file_priv);
1192 extern int drm_agp_release(struct drm_device *dev);
1193 extern int drm_agp_release_ioctl(struct drm_device *dev, void *data,
1194 struct drm_file *file_priv);
1195 extern int drm_agp_enable(struct drm_device *dev, struct drm_agp_mode mode);
1196 extern int drm_agp_enable_ioctl(struct drm_device *dev, void *data,
1197 struct drm_file *file_priv);
1198 extern int drm_agp_info(struct drm_device *dev, struct drm_agp_info *info);
1199 extern int drm_agp_info_ioctl(struct drm_device *dev, void *data,
1200 struct drm_file *file_priv);
1201 extern int drm_agp_alloc(struct drm_device *dev, struct drm_agp_buffer *request);
1202 extern int drm_agp_alloc_ioctl(struct drm_device *dev, void *data,
1203 struct drm_file *file_priv);
1204 extern int drm_agp_free(struct drm_device *dev, struct drm_agp_buffer *request);
1205 extern int drm_agp_free_ioctl(struct drm_device *dev, void *data,
1206 struct drm_file *file_priv);
1207 extern int drm_agp_unbind(struct drm_device *dev, struct drm_agp_binding *request);
1208 extern int drm_agp_unbind_ioctl(struct drm_device *dev, void *data,
1209 struct drm_file *file_priv);
1210 extern int drm_agp_bind(struct drm_device *dev, struct drm_agp_binding *request);
1211 extern int drm_agp_bind_ioctl(struct drm_device *dev, void *data,
1212 struct drm_file *file_priv);
1213 extern DRM_AGP_MEM *drm_agp_allocate_memory(struct agp_bridge_data *bridge, size_t pages, u32 type);
1214 extern int drm_agp_free_memory(DRM_AGP_MEM * handle);
1215 extern int drm_agp_bind_memory(DRM_AGP_MEM * handle, off_t start);
1216 extern int drm_agp_unbind_memory(DRM_AGP_MEM * handle);
1217 extern void drm_agp_chipset_flush(struct drm_device *dev);
1219 /* Stub support (drm_stub.h) */
1220 extern int drm_setmaster_ioctl(struct drm_device *dev, void *data,
1221 struct drm_file *file_priv);
1222 extern int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
1223 struct drm_file *file_priv);
1224 struct drm_master *drm_master_create(struct drm_minor *minor);
1225 extern struct drm_master *drm_master_get(struct drm_master *master);
1226 extern void drm_master_put(struct drm_master **master);
1227 extern int drm_get_dev(struct pci_dev *pdev, const struct pci_device_id *ent,
1228 struct drm_driver *driver);
1229 extern int drm_put_dev(struct drm_device *dev);
1230 extern int drm_put_minor(struct drm_minor **minor);
1231 extern unsigned int drm_debug;
1233 extern struct class *drm_class;
1234 extern struct proc_dir_entry *drm_proc_root;
1236 extern struct idr drm_minors_idr;
1238 extern drm_local_map_t *drm_getsarea(struct drm_device *dev);
1240 /* Proc support (drm_proc.h) */
1241 extern int drm_proc_init(struct drm_minor *minor, int minor_id,
1242 struct proc_dir_entry *root);
1243 extern int drm_proc_cleanup(struct drm_minor *minor, struct proc_dir_entry *root);
1245 /* Scatter Gather Support (drm_scatter.h) */
1246 extern void drm_sg_cleanup(struct drm_sg_mem * entry);
1247 extern int drm_sg_alloc_ioctl(struct drm_device *dev, void *data,
1248 struct drm_file *file_priv);
1249 extern int drm_sg_alloc(struct drm_device *dev, struct drm_scatter_gather * request);
1250 extern int drm_sg_free(struct drm_device *dev, void *data,
1251 struct drm_file *file_priv);
1253 /* ATI PCIGART support (ati_pcigart.h) */
1254 extern int drm_ati_pcigart_init(struct drm_device *dev,
1255 struct drm_ati_pcigart_info * gart_info);
1256 extern int drm_ati_pcigart_cleanup(struct drm_device *dev,
1257 struct drm_ati_pcigart_info * gart_info);
1259 extern drm_dma_handle_t *drm_pci_alloc(struct drm_device *dev, size_t size,
1260 size_t align, dma_addr_t maxaddr);
1261 extern void __drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
1262 extern void drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
1264 /* sysfs support (drm_sysfs.c) */
1265 struct drm_sysfs_class;
1266 extern struct class *drm_sysfs_create(struct module *owner, char *name);
1267 extern void drm_sysfs_destroy(void);
1268 extern int drm_sysfs_device_add(struct drm_minor *minor);
1269 extern void drm_sysfs_device_remove(struct drm_minor *minor);
1272 * Basic memory manager support (drm_mm.c)
1274 extern struct drm_mm_node *drm_mm_get_block(struct drm_mm_node * parent,
1276 unsigned alignment);
1277 extern void drm_mm_put_block(struct drm_mm_node * cur);
1278 extern struct drm_mm_node *drm_mm_search_free(const struct drm_mm *mm, unsigned long size,
1279 unsigned alignment, int best_match);
1280 extern int drm_mm_init(struct drm_mm *mm, unsigned long start, unsigned long size);
1281 extern void drm_mm_takedown(struct drm_mm *mm);
1282 extern int drm_mm_clean(struct drm_mm *mm);
1283 extern unsigned long drm_mm_tail_space(struct drm_mm *mm);
1284 extern int drm_mm_remove_space_from_tail(struct drm_mm *mm, unsigned long size);
1285 extern int drm_mm_add_space_to_tail(struct drm_mm *mm, unsigned long size);
1287 /* Graphics Execution Manager library functions (drm_gem.c) */
1288 int drm_gem_init(struct drm_device *dev);
1289 void drm_gem_object_free(struct kref *kref);
1290 struct drm_gem_object *drm_gem_object_alloc(struct drm_device *dev,
1292 void drm_gem_object_handle_free(struct kref *kref);
1295 drm_gem_object_reference(struct drm_gem_object *obj)
1297 kref_get(&obj->refcount);
1301 drm_gem_object_unreference(struct drm_gem_object *obj)
1306 kref_put(&obj->refcount, drm_gem_object_free);
1309 int drm_gem_handle_create(struct drm_file *file_priv,
1310 struct drm_gem_object *obj,
1314 drm_gem_object_handle_reference(struct drm_gem_object *obj)
1316 drm_gem_object_reference(obj);
1317 kref_get(&obj->handlecount);
1321 drm_gem_object_handle_unreference(struct drm_gem_object *obj)
1327 * Must bump handle count first as this may be the last
1328 * ref, in which case the object would disappear before we
1329 * checked for a name
1331 kref_put(&obj->handlecount, drm_gem_object_handle_free);
1332 drm_gem_object_unreference(obj);
1335 struct drm_gem_object *drm_gem_object_lookup(struct drm_device *dev,
1336 struct drm_file *filp,
1338 int drm_gem_close_ioctl(struct drm_device *dev, void *data,
1339 struct drm_file *file_priv);
1340 int drm_gem_flink_ioctl(struct drm_device *dev, void *data,
1341 struct drm_file *file_priv);
1342 int drm_gem_open_ioctl(struct drm_device *dev, void *data,
1343 struct drm_file *file_priv);
1344 void drm_gem_open(struct drm_device *dev, struct drm_file *file_private);
1345 void drm_gem_release(struct drm_device *dev, struct drm_file *file_private);
1347 extern void drm_core_ioremap(struct drm_map *map, struct drm_device *dev);
1348 extern void drm_core_ioremap_wc(struct drm_map *map, struct drm_device *dev);
1349 extern void drm_core_ioremapfree(struct drm_map *map, struct drm_device *dev);
1351 static __inline__ struct drm_map *drm_core_findmap(struct drm_device *dev,
1354 struct drm_map_list *_entry;
1355 list_for_each_entry(_entry, &dev->maplist, head)
1356 if (_entry->user_token == token)
1361 static __inline__ int drm_device_is_agp(struct drm_device *dev)
1363 if (dev->driver->device_is_agp != NULL) {
1364 int err = (*dev->driver->device_is_agp) (dev);
1371 return pci_find_capability(dev->pdev, PCI_CAP_ID_AGP);
1374 static __inline__ int drm_device_is_pcie(struct drm_device *dev)
1376 return pci_find_capability(dev->pdev, PCI_CAP_ID_EXP);
1379 static __inline__ void drm_core_dropmap(struct drm_map *map)
1383 #ifndef DEBUG_MEMORY
1384 /** Wrapper around kmalloc() */
1385 static __inline__ void *drm_alloc(size_t size, int area)
1387 return kmalloc(size, GFP_KERNEL);
1390 /** Wrapper around kfree() */
1391 static __inline__ void drm_free(void *pt, size_t size, int area)
1396 /** Wrapper around kcalloc() */
1397 static __inline__ void *drm_calloc(size_t nmemb, size_t size, int area)
1399 return kcalloc(nmemb, size, GFP_KERNEL);
1402 extern void *drm_alloc(size_t size, int area);
1403 extern void drm_free(void *pt, size_t size, int area);
1404 extern void *drm_calloc(size_t nmemb, size_t size, int area);
1409 #endif /* __KERNEL__ */