drmP.h revision 183573
1/* drmP.h -- Private header for Direct Rendering Manager -*- linux-c -*-
2 * Created: Mon Jan  4 10:05:05 1999 by faith@precisioninsight.com
3 */
4/*-
5 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
6 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
7 * All rights reserved.
8 *
9 * Permission is hereby granted, free of charge, to any person obtaining a
10 * copy of this software and associated documentation files (the "Software"),
11 * to deal in the Software without restriction, including without limitation
12 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
13 * and/or sell copies of the Software, and to permit persons to whom the
14 * Software is furnished to do so, subject to the following conditions:
15 *
16 * The above copyright notice and this permission notice (including the next
17 * paragraph) shall be included in all copies or substantial portions of the
18 * Software.
19 *
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
23 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
24 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
25 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
26 * OTHER DEALINGS IN THE SOFTWARE.
27 *
28 * Authors:
29 *    Rickard E. (Rik) Faith <faith@valinux.com>
30 *    Gareth Hughes <gareth@valinux.com>
31 *
32 */
33
34#include <sys/cdefs.h>
35__FBSDID("$FreeBSD: head/sys/dev/drm/drmP.h 183573 2008-10-03 16:59:11Z rnoland $");
36
37#ifndef _DRM_P_H_
38#define _DRM_P_H_
39
40#if defined(_KERNEL) || defined(__KERNEL__)
41
42struct drm_device;
43struct drm_file;
44
45#include <sys/param.h>
46#include <sys/queue.h>
47#include <sys/malloc.h>
48#include <sys/kernel.h>
49#include <sys/module.h>
50#include <sys/systm.h>
51#include <sys/conf.h>
52#include <sys/stat.h>
53#if __FreeBSD_version >= 700000
54#include <sys/priv.h>
55#endif
56#include <sys/proc.h>
57#include <sys/lock.h>
58#include <sys/fcntl.h>
59#include <sys/uio.h>
60#include <sys/filio.h>
61#include <sys/sysctl.h>
62#include <sys/bus.h>
63#include <sys/signalvar.h>
64#include <sys/poll.h>
65#include <sys/tree.h>
66#include <sys/taskqueue.h>
67#include <vm/vm.h>
68#include <vm/pmap.h>
69#include <vm/vm_extern.h>
70#include <vm/vm_map.h>
71#include <vm/vm_param.h>
72#include <machine/param.h>
73#include <machine/pmap.h>
74#include <machine/bus.h>
75#include <machine/resource.h>
76#include <machine/specialreg.h>
77#include <machine/sysarch.h>
78#include <sys/endian.h>
79#include <sys/mman.h>
80#include <sys/rman.h>
81#include <sys/memrange.h>
82#if __FreeBSD_version >= 800004
83#include <dev/agp/agpvar.h>
84#else /* __FreeBSD_version >= 800004 */
85#include <pci/agpvar.h>
86#endif /* __FreeBSD_version >= 800004 */
87#include <sys/agpio.h>
88#include <sys/mutex.h>
89#include <dev/pci/pcivar.h>
90#include <sys/selinfo.h>
91#include <sys/bus.h>
92
93#include "dev/drm/drm.h"
94#include "dev/drm/drm_linux_list.h"
95#include "dev/drm/drm_atomic.h"
96#include "dev/drm/drm_internal.h"
97
98#include <opt_drm.h>
99#ifdef DRM_DEBUG
100#undef DRM_DEBUG
101#define DRM_DEBUG_DEFAULT_ON 1
102#endif /* DRM_DEBUG */
103
104#if defined(DRM_LINUX) && DRM_LINUX && !defined(__amd64__)
105#include <sys/file.h>
106#include <sys/proc.h>
107#include <machine/../linux/linux.h>
108#include <machine/../linux/linux_proto.h>
109#else
110/* Either it was defined when it shouldn't be (FreeBSD amd64) or it isn't
111 * supported on this OS yet.
112 */
113#undef DRM_LINUX
114#define DRM_LINUX 0
115#endif
116
117/* driver capabilities and requirements mask */
118#define DRIVER_USE_AGP     0x1
119#define DRIVER_REQUIRE_AGP 0x2
120#define DRIVER_USE_MTRR    0x4
121#define DRIVER_PCI_DMA     0x8
122#define DRIVER_SG          0x10
123#define DRIVER_HAVE_DMA    0x20
124#define DRIVER_HAVE_IRQ    0x40
125#define DRIVER_DMA_QUEUE   0x100
126
127
128#define DRM_HASH_SIZE	      16 /* Size of key hash table		  */
129#define DRM_KERNEL_CONTEXT    0	 /* Change drm_resctx if changed	  */
130#define DRM_RESERVED_CONTEXTS 1	 /* Change drm_resctx if changed	  */
131
132#define DRM_MEM_DMA	   0
133#define DRM_MEM_SAREA	   1
134#define DRM_MEM_DRIVER	   2
135#define DRM_MEM_MAGIC	   3
136#define DRM_MEM_IOCTLS	   4
137#define DRM_MEM_MAPS	   5
138#define DRM_MEM_BUFS	   6
139#define DRM_MEM_SEGS	   7
140#define DRM_MEM_PAGES	   8
141#define DRM_MEM_FILES	  9
142#define DRM_MEM_QUEUES	  10
143#define DRM_MEM_CMDS	  11
144#define DRM_MEM_MAPPINGS  12
145#define DRM_MEM_BUFLISTS  13
146#define DRM_MEM_AGPLISTS  14
147#define DRM_MEM_TOTALAGP  15
148#define DRM_MEM_BOUNDAGP  16
149#define DRM_MEM_CTXBITMAP 17
150#define DRM_MEM_STUB	  18
151#define DRM_MEM_SGLISTS	  19
152#define DRM_MEM_DRAWABLE  20
153
154#define DRM_MAX_CTXBITMAP (PAGE_SIZE * 8)
155
156				/* Internal types and structures */
157#define DRM_ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
158#define DRM_MIN(a,b) ((a)<(b)?(a):(b))
159#define DRM_MAX(a,b) ((a)>(b)?(a):(b))
160
161#define DRM_IF_VERSION(maj, min) (maj << 16 | min)
162
163MALLOC_DECLARE(M_DRM);
164
165#define __OS_HAS_AGP	1
166
167#define DRM_DEV_MODE	(S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP)
168#define DRM_DEV_UID	0
169#define DRM_DEV_GID	0
170
171#define wait_queue_head_t	atomic_t
172#define DRM_WAKEUP(w)		wakeup((void *)w)
173#define DRM_WAKEUP_INT(w)	wakeup(w)
174#define DRM_INIT_WAITQUEUE(queue) do {(void)(queue);} while (0)
175
176#define DRM_CURPROC		curthread
177#define DRM_STRUCTPROC		struct thread
178#define DRM_SPINTYPE		struct mtx
179#define DRM_SPININIT(l,name)	mtx_init(l, name, NULL, MTX_DEF)
180#define DRM_SPINUNINIT(l)	mtx_destroy(l)
181#define DRM_SPINLOCK(l)		mtx_lock(l)
182#define DRM_SPINUNLOCK(u)	mtx_unlock(u)
183#define DRM_SPINLOCK_IRQSAVE(l, irqflags) do {		\
184	mtx_lock(l);					\
185	(void)irqflags;					\
186} while (0)
187#define DRM_SPINUNLOCK_IRQRESTORE(u, irqflags) mtx_unlock(u)
188#define DRM_SPINLOCK_ASSERT(l)	mtx_assert(l, MA_OWNED)
189#define DRM_CURRENTPID		curthread->td_proc->p_pid
190#define DRM_LOCK()		mtx_lock(&dev->dev_lock)
191#define DRM_UNLOCK() 		mtx_unlock(&dev->dev_lock)
192#define DRM_SYSCTL_HANDLER_ARGS	(SYSCTL_HANDLER_ARGS)
193
194#define DRM_IRQ_ARGS		void *arg
195typedef void			irqreturn_t;
196#define IRQ_HANDLED		/* nothing */
197#define IRQ_NONE		/* nothing */
198
199enum {
200	DRM_IS_NOT_AGP,
201	DRM_IS_AGP,
202	DRM_MIGHT_BE_AGP
203};
204#define DRM_AGP_MEM		struct agp_memory_info
205
206#define drm_get_device_from_kdev(_kdev) (_kdev->si_drv1)
207
208#define PAGE_ALIGN(addr) round_page(addr)
209/* DRM_SUSER returns true if the user is superuser */
210#if __FreeBSD_version >= 700000
211#define DRM_SUSER(p)		(priv_check(p, PRIV_DRIVER) == 0)
212#else
213#define DRM_SUSER(p)		(suser(p) == 0)
214#endif
215#define DRM_AGP_FIND_DEVICE()	agp_find_device()
216#define DRM_MTRR_WC		MDF_WRITECOMBINE
217#define jiffies			ticks
218
219/* Capabilities taken from src/sys/dev/pci/pcireg.h. */
220#ifndef PCIY_AGP
221#define PCIY_AGP	0x02
222#endif
223
224#ifndef PCIY_EXPRESS
225#define PCIY_EXPRESS	0x10
226#endif
227
228typedef unsigned long dma_addr_t;
229typedef u_int64_t u64;
230typedef u_int32_t u32;
231typedef u_int16_t u16;
232typedef u_int8_t u8;
233
234/* DRM_READMEMORYBARRIER() prevents reordering of reads.
235 * DRM_WRITEMEMORYBARRIER() prevents reordering of writes.
236 * DRM_MEMORYBARRIER() prevents reordering of reads and writes.
237 */
238#if defined(__i386__)
239#define DRM_READMEMORYBARRIER()		__asm __volatile( \
240					"lock; addl $0,0(%%esp)" : : : "memory");
241#define DRM_WRITEMEMORYBARRIER()	__asm __volatile("" : : : "memory");
242#define DRM_MEMORYBARRIER()		__asm __volatile( \
243					"lock; addl $0,0(%%esp)" : : : "memory");
244#elif defined(__alpha__)
245#define DRM_READMEMORYBARRIER()		alpha_mb();
246#define DRM_WRITEMEMORYBARRIER()	alpha_wmb();
247#define DRM_MEMORYBARRIER()		alpha_mb();
248#elif defined(__amd64__)
249#define DRM_READMEMORYBARRIER()		__asm __volatile( \
250					"lock; addl $0,0(%%rsp)" : : : "memory");
251#define DRM_WRITEMEMORYBARRIER()	__asm __volatile("" : : : "memory");
252#define DRM_MEMORYBARRIER()		__asm __volatile( \
253					"lock; addl $0,0(%%rsp)" : : : "memory");
254#endif
255
256#define DRM_READ8(map, offset)						\
257	*(volatile u_int8_t *) (((unsigned long)(map)->handle) + (offset))
258#define DRM_READ16(map, offset)						\
259	*(volatile u_int16_t *) (((unsigned long)(map)->handle) + (offset))
260#define DRM_READ32(map, offset)						\
261	*(volatile u_int32_t *)(((unsigned long)(map)->handle) + (offset))
262#define DRM_WRITE8(map, offset, val)					\
263	*(volatile u_int8_t *) (((unsigned long)(map)->handle) + (offset)) = val
264#define DRM_WRITE16(map, offset, val)					\
265	*(volatile u_int16_t *) (((unsigned long)(map)->handle) + (offset)) = val
266#define DRM_WRITE32(map, offset, val)					\
267	*(volatile u_int32_t *)(((unsigned long)(map)->handle) + (offset)) = val
268
269#define DRM_VERIFYAREA_READ( uaddr, size )		\
270	(!useracc(__DECONST(caddr_t, uaddr), size, VM_PROT_READ))
271
272#define DRM_COPY_TO_USER(user, kern, size) \
273	copyout(kern, user, size)
274#define DRM_COPY_FROM_USER(kern, user, size) \
275	copyin(user, kern, size)
276#define DRM_COPY_FROM_USER_UNCHECKED(arg1, arg2, arg3) 	\
277	copyin(arg2, arg1, arg3)
278#define DRM_COPY_TO_USER_UNCHECKED(arg1, arg2, arg3)	\
279	copyout(arg2, arg1, arg3)
280#define DRM_GET_USER_UNCHECKED(val, uaddr)		\
281	((val) = fuword32(uaddr), 0)
282
283#define cpu_to_le32(x) htole32(x)
284#define le32_to_cpu(x) le32toh(x)
285
286#define DRM_HZ			hz
287#define DRM_UDELAY(udelay)	DELAY(udelay)
288#define DRM_TIME_SLICE		(hz/20)  /* Time slice for GLXContexts	  */
289
290#define DRM_GET_PRIV_SAREA(_dev, _ctx, _map) do {	\
291	(_map) = (_dev)->context_sareas[_ctx];		\
292} while(0)
293
294#define LOCK_TEST_WITH_RETURN(dev, file_priv)				\
295do {									\
296	if (!_DRM_LOCK_IS_HELD(dev->lock.hw_lock->lock) ||		\
297	     dev->lock.file_priv != file_priv) {			\
298		DRM_ERROR("%s called without lock held\n",		\
299			   __FUNCTION__);				\
300		return EINVAL;						\
301	}								\
302} while (0)
303
304/* Returns -errno to shared code */
305#define DRM_WAIT_ON( ret, queue, timeout, condition )		\
306for ( ret = 0 ; !ret && !(condition) ; ) {			\
307	DRM_UNLOCK();						\
308	mtx_lock(&dev->irq_lock);				\
309	if (!(condition))					\
310	   ret = -mtx_sleep(&(queue), &dev->irq_lock, 		\
311			 PZERO | PCATCH, "drmwtq", (timeout));	\
312	mtx_unlock(&dev->irq_lock);				\
313	DRM_LOCK();						\
314}
315
316#define DRM_ERROR(fmt, arg...) \
317	printf("error: [" DRM_NAME ":pid%d:%s] *ERROR* " fmt,		\
318	    DRM_CURRENTPID, __func__ , ## arg)
319
320#define DRM_INFO(fmt, arg...)  printf("info: [" DRM_NAME "] " fmt , ## arg)
321
322#define DRM_DEBUG(fmt, arg...) do {					\
323	if (drm_debug_flag)						\
324		printf("[" DRM_NAME ":pid%d:%s] " fmt, DRM_CURRENTPID,	\
325			__func__ , ## arg);				\
326} while (0)
327
328typedef struct drm_pci_id_list
329{
330	int vendor;
331	int device;
332	long driver_private;
333	char *name;
334} drm_pci_id_list_t;
335
336#define DRM_AUTH	0x1
337#define DRM_MASTER	0x2
338#define DRM_ROOT_ONLY	0x4
339typedef struct drm_ioctl_desc {
340	unsigned long cmd;
341	int (*func)(struct drm_device *dev, void *data,
342		    struct drm_file *file_priv);
343	int flags;
344} drm_ioctl_desc_t;
345/**
346 * Creates a driver or general drm_ioctl_desc array entry for the given
347 * ioctl, for use by drm_ioctl().
348 */
349#define DRM_IOCTL_DEF(ioctl, func, flags) \
350	[DRM_IOCTL_NR(ioctl)] = {ioctl, func, flags}
351
352typedef struct drm_magic_entry {
353	drm_magic_t	       magic;
354	struct drm_file	       *priv;
355	struct drm_magic_entry *next;
356} drm_magic_entry_t;
357
358typedef struct drm_magic_head {
359	struct drm_magic_entry *head;
360	struct drm_magic_entry *tail;
361} drm_magic_head_t;
362
363typedef struct drm_buf {
364	int		  idx;	       /* Index into master buflist	     */
365	int		  total;       /* Buffer size			     */
366	int		  order;       /* log-base-2(total)		     */
367	int		  used;	       /* Amount of buffer in use (for DMA)  */
368	unsigned long	  offset;      /* Byte offset (used internally)	     */
369	void		  *address;    /* Address of buffer		     */
370	unsigned long	  bus_address; /* Bus address of buffer		     */
371	struct drm_buf	  *next;       /* Kernel-only: used for free list    */
372	__volatile__ int  pending;     /* On hardware DMA queue		     */
373	struct drm_file   *file_priv;  /* Unique identifier of holding process */
374	int		  context;     /* Kernel queue for this buffer	     */
375	enum {
376		DRM_LIST_NONE	 = 0,
377		DRM_LIST_FREE	 = 1,
378		DRM_LIST_WAIT	 = 2,
379		DRM_LIST_PEND	 = 3,
380		DRM_LIST_PRIO	 = 4,
381		DRM_LIST_RECLAIM = 5
382	}		  list;	       /* Which list we're on		     */
383
384	int		  dev_priv_size; /* Size of buffer private stoarge   */
385	void		  *dev_private;  /* Per-buffer private storage       */
386} drm_buf_t;
387
388typedef struct drm_freelist {
389	int		  initialized; /* Freelist in use		   */
390	atomic_t	  count;       /* Number of free buffers	   */
391	drm_buf_t	  *next;       /* End pointer			   */
392
393	int		  low_mark;    /* Low water mark		   */
394	int		  high_mark;   /* High water mark		   */
395} drm_freelist_t;
396
397typedef struct drm_dma_handle {
398	void *vaddr;
399	bus_addr_t busaddr;
400	bus_dma_tag_t tag;
401	bus_dmamap_t map;
402} drm_dma_handle_t;
403
404typedef struct drm_buf_entry {
405	int		  buf_size;
406	int		  buf_count;
407	drm_buf_t	  *buflist;
408	int		  seg_count;
409	drm_dma_handle_t  **seglist;
410	int		  page_order;
411
412	drm_freelist_t	  freelist;
413} drm_buf_entry_t;
414
415typedef TAILQ_HEAD(drm_file_list, drm_file) drm_file_list_t;
416struct drm_file {
417	TAILQ_ENTRY(drm_file) link;
418	struct drm_device *dev;
419	int		  authenticated;
420	int		  master;
421	int		  minor;
422	pid_t		  pid;
423	uid_t		  uid;
424	drm_magic_t	  magic;
425	unsigned long	  ioctl_count;
426	void		 *driver_priv;
427};
428
429typedef struct drm_lock_data {
430	struct drm_hw_lock	*hw_lock;	/* Hardware lock		   */
431	struct drm_file   *file_priv;   /* Unique identifier of holding process (NULL is kernel)*/
432	int		  lock_queue;	/* Queue of blocked processes	   */
433	unsigned long	  lock_time;	/* Time of last lock in jiffies	   */
434} drm_lock_data_t;
435
436/* This structure, in the struct drm_device, is always initialized while the
437 * device
438 * is open.  dev->dma_lock protects the incrementing of dev->buf_use, which
439 * when set marks that no further bufs may be allocated until device teardown
440 * occurs (when the last open of the device has closed).  The high/low
441 * watermarks of bufs are only touched by the X Server, and thus not
442 * concurrently accessed, so no locking is needed.
443 */
444typedef struct drm_device_dma {
445	drm_buf_entry_t	  bufs[DRM_MAX_ORDER+1];
446	int		  buf_count;
447	drm_buf_t	  **buflist;	/* Vector of pointers info bufs	   */
448	int		  seg_count;
449	int		  page_count;
450	unsigned long	  *pagelist;
451	unsigned long	  byte_count;
452	enum {
453		_DRM_DMA_USE_AGP = 0x01,
454		_DRM_DMA_USE_SG  = 0x02
455	} flags;
456} drm_device_dma_t;
457
458typedef struct drm_agp_mem {
459	void               *handle;
460	unsigned long      bound; /* address */
461	int                pages;
462	struct drm_agp_mem *prev;
463	struct drm_agp_mem *next;
464} drm_agp_mem_t;
465
466typedef struct drm_agp_head {
467	device_t	   agpdev;
468	struct agp_info    info;
469	const char         *chipset;
470	drm_agp_mem_t      *memory;
471	unsigned long      mode;
472	int                enabled;
473	int                acquired;
474	unsigned long      base;
475   	int 		   mtrr;
476	int		   cant_use_aperture;
477	unsigned long	   page_mask;
478} drm_agp_head_t;
479
480typedef struct drm_sg_mem {
481	unsigned long   handle;
482	void            *virtual;
483	int             pages;
484	dma_addr_t	*busaddr;
485	drm_dma_handle_t *dmah;	/* Handle to PCI memory for ATI PCIGART table */
486} drm_sg_mem_t;
487
488typedef TAILQ_HEAD(drm_map_list, drm_local_map) drm_map_list_t;
489
490typedef struct drm_local_map {
491	unsigned long	offset;	 /* Physical address (0 for SAREA)*/
492	unsigned long	size;	 /* Physical size (bytes)	    */
493	enum drm_map_type	type;	 /* Type of memory mapped		    */
494	enum drm_map_flags	flags;	 /* Flags				    */
495	void		*handle; /* User-space: "Handle" to pass to mmap    */
496				 /* Kernel-space: kernel-virtual address    */
497	int		mtrr;	 /* Boolean: MTRR used */
498				 /* Private data			    */
499	int		rid;	 /* PCI resource ID for bus_space */
500	struct resource *bsr;
501	bus_space_tag_t bst;
502	bus_space_handle_t bsh;
503	drm_dma_handle_t *dmah;
504	TAILQ_ENTRY(drm_local_map) link;
505} drm_local_map_t;
506
507TAILQ_HEAD(drm_vbl_sig_list, drm_vbl_sig);
508typedef struct drm_vbl_sig {
509	TAILQ_ENTRY(drm_vbl_sig) link;
510	unsigned int	sequence;
511	int		signo;
512	int		pid;
513} drm_vbl_sig_t;
514
515struct drm_vblank_info {
516	wait_queue_head_t queue;	/* vblank wait queue */
517	atomic_t count;			/* number of VBLANK interrupts */
518					/* (driver must alloc the right number of counters) */
519	struct drm_vbl_sig_list sigs;	/* signal list to send on VBLANK */
520	atomic_t refcount;		/* number of users of vblank interrupts */
521	u32 last;			/* protected by dev->vbl_lock, used */
522					/* for wraparound handling */
523	int enabled;			/* so we don't call enable more than */
524					/* once per disable */
525	int inmodeset;			/* Display driver is setting mode */
526};
527
528/* location of GART table */
529#define DRM_ATI_GART_MAIN 1
530#define DRM_ATI_GART_FB   2
531
532#define DRM_ATI_GART_PCI  1
533#define DRM_ATI_GART_PCIE 2
534#define DRM_ATI_GART_IGP  3
535
536struct drm_ati_pcigart_info {
537	int gart_table_location;
538	int gart_reg_if;
539	void *addr;
540	dma_addr_t bus_addr;
541	dma_addr_t table_mask;
542	dma_addr_t member_mask;
543	struct drm_dma_handle *table_handle;
544	drm_local_map_t mapping;
545	int table_size;
546};
547
548#ifndef DMA_BIT_MASK
549#define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : (1ULL<<(n)) - 1)
550#endif
551
552#define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
553
554struct drm_driver_info {
555	int	(*load)(struct drm_device *, unsigned long flags);
556	int	(*firstopen)(struct drm_device *);
557	int	(*open)(struct drm_device *, struct drm_file *);
558	void	(*preclose)(struct drm_device *, struct drm_file *file_priv);
559	void	(*postclose)(struct drm_device *, struct drm_file *);
560	void	(*lastclose)(struct drm_device *);
561	int	(*unload)(struct drm_device *);
562	void	(*reclaim_buffers_locked)(struct drm_device *,
563					  struct drm_file *file_priv);
564	int	(*dma_ioctl)(struct drm_device *dev, void *data,
565			     struct drm_file *file_priv);
566	void	(*dma_ready)(struct drm_device *);
567	int	(*dma_quiescent)(struct drm_device *);
568	int	(*dma_flush_block_and_flush)(struct drm_device *, int context,
569					     enum drm_lock_flags flags);
570	int	(*dma_flush_unblock)(struct drm_device *, int context,
571				     enum drm_lock_flags flags);
572	int	(*context_ctor)(struct drm_device *dev, int context);
573	int	(*context_dtor)(struct drm_device *dev, int context);
574	int	(*kernel_context_switch)(struct drm_device *dev, int old,
575					 int new);
576	int	(*kernel_context_switch_unlock)(struct drm_device *dev);
577	void	(*irq_preinstall)(struct drm_device *dev);
578	int	(*irq_postinstall)(struct drm_device *dev);
579	void	(*irq_uninstall)(struct drm_device *dev);
580	void	(*irq_handler)(DRM_IRQ_ARGS);
581	u32	(*get_vblank_counter)(struct drm_device *dev, int crtc);
582	int	(*enable_vblank)(struct drm_device *dev, int crtc);
583	void	(*disable_vblank)(struct drm_device *dev, int crtc);
584
585	drm_pci_id_list_t *id_entry;	/* PCI ID, name, and chipset private */
586
587	/**
588	 * Called by \c drm_device_is_agp.  Typically used to determine if a
589	 * card is really attached to AGP or not.
590	 *
591	 * \param dev  DRM device handle
592	 *
593	 * \returns
594	 * One of three values is returned depending on whether or not the
595	 * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
596	 * (return of 1), or may or may not be AGP (return of 2).
597	 */
598	int	(*device_is_agp) (struct drm_device * dev);
599
600	drm_ioctl_desc_t *ioctls;
601	int	max_ioctl;
602
603	int	buf_priv_size;
604
605	int	major;
606	int	minor;
607	int	patchlevel;
608	const char *name;		/* Simple driver name		   */
609	const char *desc;		/* Longer driver name		   */
610	const char *date;		/* Date of last major changes.	   */
611
612	u32 driver_features;
613};
614
615/* Length for the array of resource pointers for drm_get_resource_*. */
616#define DRM_MAX_PCI_RESOURCE	3
617
618/**
619 * DRM device functions structure
620 */
621struct drm_device {
622	struct drm_driver_info *driver;
623	drm_pci_id_list_t *id_entry;	/* PCI ID, name, and chipset private */
624
625	u_int16_t pci_device;		/* PCI device id */
626	u_int16_t pci_vendor;		/* PCI vendor id */
627
628	char		  *unique;	/* Unique identifier: e.g., busid  */
629	int		  unique_len;	/* Length of unique field	   */
630	device_t	  device;	/* Device instance from newbus     */
631	struct cdev	  *devnode;	/* Device number for mknod	   */
632	int		  if_version;	/* Highest interface version set */
633
634	int		  flags;	/* Flags to open(2)		   */
635
636				/* Locks */
637	struct mtx	  vbl_lock;	/* protects vblank operations */
638	struct mtx	  dma_lock;	/* protects dev->dma */
639	struct mtx	  irq_lock;	/* protects irq condition checks */
640	struct mtx	  dev_lock;	/* protects everything else */
641	DRM_SPINTYPE	  drw_lock;
642	DRM_SPINTYPE	  tsk_lock;
643
644				/* Usage Counters */
645	int		  open_count;	/* Outstanding files open	   */
646	int		  buf_use;	/* Buffers in use -- cannot alloc  */
647
648				/* Performance counters */
649	unsigned long     counters;
650	enum drm_stat_type	types[15];
651	atomic_t          counts[15];
652
653				/* Authentication */
654	drm_file_list_t   files;
655	drm_magic_head_t  magiclist[DRM_HASH_SIZE];
656
657	/* Linked list of mappable regions. Protected by dev_lock */
658	drm_map_list_t	  maplist;
659
660	drm_local_map_t	  **context_sareas;
661	int		  max_context;
662
663	drm_lock_data_t	  lock;		/* Information on hardware lock	   */
664
665				/* DMA queues (contexts) */
666	drm_device_dma_t  *dma;		/* Optional pointer for DMA support */
667
668				/* Context support */
669	int		  irq;		/* Interrupt used by board	   */
670	int		  irq_enabled;	/* True if the irq handler is enabled */
671	int		  irqrid;	/* Interrupt used by board */
672	struct resource   *irqr;	/* Resource for interrupt used by board	   */
673	void		  *irqh;	/* Handle from bus_setup_intr      */
674
675	/* Storage of resource pointers for drm_get_resource_* */
676	struct resource   *pcir[DRM_MAX_PCI_RESOURCE];
677	int		  pcirid[DRM_MAX_PCI_RESOURCE];
678
679	int		  pci_domain;
680	int		  pci_bus;
681	int		  pci_slot;
682	int		  pci_func;
683
684	atomic_t	  context_flag;	/* Context swapping flag	   */
685	int		  last_context;	/* Last current context		   */
686
687	int		  vblank_disable_allowed;
688	atomic_t 	  vbl_signal_pending;	/* number of signals pending on all crtcs */
689	struct callout	  vblank_disable_timer;
690	u32		  max_vblank_count;	/* size of vblank counter register */
691	struct drm_vblank_info *vblank;		/* per crtc vblank info */
692	int		  num_crtcs;
693
694	struct sigio      *buf_sigio;	/* Processes waiting for SIGIO     */
695
696				/* Sysctl support */
697	struct drm_sysctl_info *sysctl;
698
699	drm_agp_head_t    *agp;
700	drm_sg_mem_t      *sg;  /* Scatter gather memory */
701	atomic_t          *ctx_bitmap;
702	void		  *dev_private;
703	unsigned int	  agp_buffer_token;
704	drm_local_map_t   *agp_buffer_map;
705
706	struct unrhdr	  *drw_unrhdr;
707	/* RB tree of drawable infos */
708	RB_HEAD(drawable_tree, bsd_drm_drawable_info) drw_head;
709
710	struct task	  locked_task;
711	void		  (*locked_task_call)(struct drm_device *dev);
712};
713
714static __inline__ int drm_core_check_feature(struct drm_device *dev,
715					     int feature)
716{
717	return ((dev->driver->driver_features & feature) ? 1 : 0);
718}
719
720#if __OS_HAS_AGP
721static inline int drm_core_has_AGP(struct drm_device *dev)
722{
723	return drm_core_check_feature(dev, DRIVER_USE_AGP);
724}
725#else
726#define drm_core_has_AGP(dev) (0)
727#endif
728
729extern int	drm_debug_flag;
730
731/* Device setup support (drm_drv.c) */
732int	drm_probe(device_t nbdev, drm_pci_id_list_t *idlist);
733int	drm_attach(device_t nbdev, drm_pci_id_list_t *idlist);
734void	drm_close(void *data);
735int	drm_detach(device_t nbdev);
736d_ioctl_t drm_ioctl;
737d_open_t drm_open;
738d_read_t drm_read;
739d_poll_t drm_poll;
740d_mmap_t drm_mmap;
741extern drm_local_map_t	*drm_getsarea(struct drm_device *dev);
742
743/* File operations helpers (drm_fops.c) */
744extern int		drm_open_helper(struct cdev *kdev, int flags, int fmt,
745					 DRM_STRUCTPROC *p,
746					struct drm_device *dev);
747
748/* Memory management support (drm_memory.c) */
749void	drm_mem_init(void);
750void	drm_mem_uninit(void);
751void	*drm_alloc(size_t size, int area);
752void	*drm_calloc(size_t nmemb, size_t size, int area);
753void	*drm_realloc(void *oldpt, size_t oldsize, size_t size,
754				   int area);
755void	drm_free(void *pt, size_t size, int area);
756void	*drm_ioremap_wc(struct drm_device *dev, drm_local_map_t *map);
757void	*drm_ioremap(struct drm_device *dev, drm_local_map_t *map);
758void	drm_ioremapfree(drm_local_map_t *map);
759int	drm_mtrr_add(unsigned long offset, size_t size, int flags);
760int	drm_mtrr_del(int handle, unsigned long offset, size_t size, int flags);
761
762int	drm_context_switch(struct drm_device *dev, int old, int new);
763int	drm_context_switch_complete(struct drm_device *dev, int new);
764
765int	drm_ctxbitmap_init(struct drm_device *dev);
766void	drm_ctxbitmap_cleanup(struct drm_device *dev);
767void	drm_ctxbitmap_free(struct drm_device *dev, int ctx_handle);
768int	drm_ctxbitmap_next(struct drm_device *dev);
769
770/* Locking IOCTL support (drm_lock.c) */
771int	drm_lock_take(struct drm_lock_data *lock_data,
772		      unsigned int context);
773int	drm_lock_transfer(struct drm_lock_data *lock_data,
774			  unsigned int context);
775int	drm_lock_free(struct drm_lock_data *lock_data,
776		      unsigned int context);
777
778/* Buffer management support (drm_bufs.c) */
779unsigned long drm_get_resource_start(struct drm_device *dev,
780				     unsigned int resource);
781unsigned long drm_get_resource_len(struct drm_device *dev,
782				   unsigned int resource);
783void	drm_rmmap(struct drm_device *dev, drm_local_map_t *map);
784int	drm_order(unsigned long size);
785int	drm_addmap(struct drm_device *dev, unsigned long offset,
786		   unsigned long size,
787		   enum drm_map_type type, enum drm_map_flags flags,
788		   drm_local_map_t **map_ptr);
789int	drm_addbufs_pci(struct drm_device *dev, struct drm_buf_desc *request);
790int	drm_addbufs_sg(struct drm_device *dev, struct drm_buf_desc *request);
791int	drm_addbufs_agp(struct drm_device *dev, struct drm_buf_desc *request);
792
793/* DMA support (drm_dma.c) */
794int	drm_dma_setup(struct drm_device *dev);
795void	drm_dma_takedown(struct drm_device *dev);
796void	drm_free_buffer(struct drm_device *dev, drm_buf_t *buf);
797void	drm_reclaim_buffers(struct drm_device *dev, struct drm_file *file_priv);
798#define drm_core_reclaim_buffers drm_reclaim_buffers
799
800/* IRQ support (drm_irq.c) */
801int	drm_irq_install(struct drm_device *dev);
802int	drm_irq_uninstall(struct drm_device *dev);
803irqreturn_t drm_irq_handler(DRM_IRQ_ARGS);
804void	drm_driver_irq_preinstall(struct drm_device *dev);
805void	drm_driver_irq_postinstall(struct drm_device *dev);
806void	drm_driver_irq_uninstall(struct drm_device *dev);
807void	drm_handle_vblank(struct drm_device *dev, int crtc);
808u32	drm_vblank_count(struct drm_device *dev, int crtc);
809int	drm_vblank_get(struct drm_device *dev, int crtc);
810void	drm_vblank_put(struct drm_device *dev, int crtc);
811int	drm_vblank_wait(struct drm_device *dev, unsigned int *vbl_seq);
812int	drm_vblank_init(struct drm_device *dev, int num_crtcs);
813void	drm_vbl_send_signals(struct drm_device *dev, int crtc);
814int 	drm_modeset_ctl(struct drm_device *dev, void *data,
815			struct drm_file *file_priv);
816
817/* AGP/PCI Express/GART support (drm_agpsupport.c) */
818int	drm_device_is_agp(struct drm_device *dev);
819int	drm_device_is_pcie(struct drm_device *dev);
820drm_agp_head_t *drm_agp_init(void);
821int	drm_agp_acquire(struct drm_device *dev);
822int	drm_agp_release(struct drm_device *dev);
823int	drm_agp_info(struct drm_device * dev, struct drm_agp_info *info);
824int	drm_agp_enable(struct drm_device *dev, struct drm_agp_mode mode);
825void	*drm_agp_allocate_memory(size_t pages, u32 type);
826int	drm_agp_free_memory(void *handle);
827int	drm_agp_bind_memory(void *handle, off_t start);
828int	drm_agp_unbind_memory(void *handle);
829int	drm_agp_alloc(struct drm_device *dev, struct drm_agp_buffer *request);
830int	drm_agp_free(struct drm_device *dev, struct drm_agp_buffer *request);
831int	drm_agp_bind(struct drm_device *dev, struct drm_agp_binding *request);
832int	drm_agp_unbind(struct drm_device *dev, struct drm_agp_binding *request);
833
834/* Scatter Gather Support (drm_scatter.c) */
835void	drm_sg_cleanup(drm_sg_mem_t *entry);
836int	drm_sg_alloc(struct drm_device *dev, struct drm_scatter_gather * request);
837
838/* sysctl support (drm_sysctl.h) */
839extern int		drm_sysctl_init(struct drm_device *dev);
840extern int		drm_sysctl_cleanup(struct drm_device *dev);
841
842/* ATI PCIGART support (ati_pcigart.c) */
843int	drm_ati_pcigart_init(struct drm_device *dev,
844				struct drm_ati_pcigart_info *gart_info);
845int	drm_ati_pcigart_cleanup(struct drm_device *dev,
846				struct drm_ati_pcigart_info *gart_info);
847
848/* Locking IOCTL support (drm_drv.c) */
849int	drm_lock(struct drm_device *dev, void *data,
850		 struct drm_file *file_priv);
851int	drm_unlock(struct drm_device *dev, void *data,
852		   struct drm_file *file_priv);
853int	drm_version(struct drm_device *dev, void *data,
854		    struct drm_file *file_priv);
855int	drm_setversion(struct drm_device *dev, void *data,
856		       struct drm_file *file_priv);
857
858/* Misc. IOCTL support (drm_ioctl.c) */
859int	drm_irq_by_busid(struct drm_device *dev, void *data,
860			 struct drm_file *file_priv);
861int	drm_getunique(struct drm_device *dev, void *data,
862		      struct drm_file *file_priv);
863int	drm_setunique(struct drm_device *dev, void *data,
864		      struct drm_file *file_priv);
865int	drm_getmap(struct drm_device *dev, void *data,
866		   struct drm_file *file_priv);
867int	drm_getclient(struct drm_device *dev, void *data,
868		      struct drm_file *file_priv);
869int	drm_getstats(struct drm_device *dev, void *data,
870		     struct drm_file *file_priv);
871int	drm_noop(struct drm_device *dev, void *data,
872		 struct drm_file *file_priv);
873
874/* Context IOCTL support (drm_context.c) */
875int	drm_resctx(struct drm_device *dev, void *data,
876		   struct drm_file *file_priv);
877int	drm_addctx(struct drm_device *dev, void *data,
878		   struct drm_file *file_priv);
879int	drm_modctx(struct drm_device *dev, void *data,
880		   struct drm_file *file_priv);
881int	drm_getctx(struct drm_device *dev, void *data,
882		   struct drm_file *file_priv);
883int	drm_switchctx(struct drm_device *dev, void *data,
884		      struct drm_file *file_priv);
885int	drm_newctx(struct drm_device *dev, void *data,
886		   struct drm_file *file_priv);
887int	drm_rmctx(struct drm_device *dev, void *data,
888		  struct drm_file *file_priv);
889int	drm_setsareactx(struct drm_device *dev, void *data,
890			struct drm_file *file_priv);
891int	drm_getsareactx(struct drm_device *dev, void *data,
892			struct drm_file *file_priv);
893
894/* Drawable IOCTL support (drm_drawable.c) */
895int	drm_adddraw(struct drm_device *dev, void *data,
896		    struct drm_file *file_priv);
897int	drm_rmdraw(struct drm_device *dev, void *data,
898		   struct drm_file *file_priv);
899int	drm_update_draw(struct drm_device *dev, void *data,
900			struct drm_file *file_priv);
901struct drm_drawable_info *drm_get_drawable_info(struct drm_device *dev,
902						int handle);
903
904/* Drawable support (drm_drawable.c) */
905void drm_drawable_free_all(struct drm_device *dev);
906
907/* Authentication IOCTL support (drm_auth.c) */
908int	drm_getmagic(struct drm_device *dev, void *data,
909		     struct drm_file *file_priv);
910int	drm_authmagic(struct drm_device *dev, void *data,
911		      struct drm_file *file_priv);
912
913/* Buffer management support (drm_bufs.c) */
914int	drm_addmap_ioctl(struct drm_device *dev, void *data,
915			 struct drm_file *file_priv);
916int	drm_rmmap_ioctl(struct drm_device *dev, void *data,
917			struct drm_file *file_priv);
918int	drm_addbufs_ioctl(struct drm_device *dev, void *data,
919			  struct drm_file *file_priv);
920int	drm_infobufs(struct drm_device *dev, void *data,
921		     struct drm_file *file_priv);
922int	drm_markbufs(struct drm_device *dev, void *data,
923		     struct drm_file *file_priv);
924int	drm_freebufs(struct drm_device *dev, void *data,
925		     struct drm_file *file_priv);
926int	drm_mapbufs(struct drm_device *dev, void *data,
927		    struct drm_file *file_priv);
928
929/* DMA support (drm_dma.c) */
930int	drm_dma(struct drm_device *dev, void *data, struct drm_file *file_priv);
931
932/* IRQ support (drm_irq.c) */
933int	drm_control(struct drm_device *dev, void *data,
934		    struct drm_file *file_priv);
935int	drm_wait_vblank(struct drm_device *dev, void *data,
936			struct drm_file *file_priv);
937void	drm_locked_tasklet(struct drm_device *dev,
938			   void (*tasklet)(struct drm_device *dev));
939
940/* AGP/GART support (drm_agpsupport.c) */
941int	drm_agp_acquire_ioctl(struct drm_device *dev, void *data,
942			      struct drm_file *file_priv);
943int	drm_agp_release_ioctl(struct drm_device *dev, void *data,
944			      struct drm_file *file_priv);
945int	drm_agp_enable_ioctl(struct drm_device *dev, void *data,
946			     struct drm_file *file_priv);
947int	drm_agp_info_ioctl(struct drm_device *dev, void *data,
948			   struct drm_file *file_priv);
949int	drm_agp_alloc_ioctl(struct drm_device *dev, void *data,
950			    struct drm_file *file_priv);
951int	drm_agp_free_ioctl(struct drm_device *dev, void *data,
952			   struct drm_file *file_priv);
953int	drm_agp_unbind_ioctl(struct drm_device *dev, void *data,
954			     struct drm_file *file_priv);
955int	drm_agp_bind_ioctl(struct drm_device *dev, void *data,
956			   struct drm_file *file_priv);
957
958/* Scatter Gather Support (drm_scatter.c) */
959int	drm_sg_alloc_ioctl(struct drm_device *dev, void *data,
960			   struct drm_file *file_priv);
961int	drm_sg_free(struct drm_device *dev, void *data,
962		    struct drm_file *file_priv);
963
964/* consistent PCI memory functions (drm_pci.c) */
965drm_dma_handle_t *drm_pci_alloc(struct drm_device *dev, size_t size,
966				size_t align, dma_addr_t maxaddr);
967void	drm_pci_free(struct drm_device *dev, drm_dma_handle_t *dmah);
968
969/* Inline replacements for DRM_IOREMAP macros */
970static __inline__ void
971drm_core_ioremap_wc(struct drm_local_map *map, struct drm_device *dev)
972{
973	map->handle = drm_ioremap_wc(dev, map);
974}
975static __inline__ void
976drm_core_ioremap(struct drm_local_map *map, struct drm_device *dev)
977{
978	map->handle = drm_ioremap(dev, map);
979}
980static __inline__ void
981drm_core_ioremapfree(struct drm_local_map *map, struct drm_device *dev)
982{
983	if ( map->handle && map->size )
984		drm_ioremapfree(map);
985}
986
987static __inline__ struct drm_local_map *
988drm_core_findmap(struct drm_device *dev, unsigned long offset)
989{
990	drm_local_map_t *map;
991
992	DRM_SPINLOCK_ASSERT(&dev->dev_lock);
993	TAILQ_FOREACH(map, &dev->maplist, link) {
994		if (map->offset == offset)
995			return map;
996	}
997	return NULL;
998}
999
1000static __inline__ void drm_core_dropmap(struct drm_map *map)
1001{
1002}
1003
1004#endif /* __KERNEL__ */
1005#endif /* _DRM_P_H_ */
1006