xref: /dragonfly/sys/dev/drm/include/drm/drmP.h (revision ef3ac1d1)
1 /**
2  * \file drmP.h
3  * Private header for Direct Rendering Manager
4  *
5  * \author Rickard E. (Rik) Faith <faith@valinux.com>
6  * \author Gareth Hughes <gareth@valinux.com>
7  */
8 
9 /*
10  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
11  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
12  * Copyright (c) 2009-2010, Code Aurora Forum.
13  * All rights reserved.
14  *
15  * Permission is hereby granted, free of charge, to any person obtaining a
16  * copy of this software and associated documentation files (the "Software"),
17  * to deal in the Software without restriction, including without limitation
18  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
19  * and/or sell copies of the Software, and to permit persons to whom the
20  * Software is furnished to do so, subject to the following conditions:
21  *
22  * The above copyright notice and this permission notice (including the next
23  * paragraph) shall be included in all copies or substantial portions of the
24  * Software.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
27  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
28  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
29  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
30  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
31  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
32  * OTHER DEALINGS IN THE SOFTWARE.
33  *
34  * $FreeBSD: head/sys/dev/drm2/drmP.h 255045 2013-08-29 23:09:34Z jkim $
35  */
36 
37 #ifndef _DRM_P_H_
38 #define _DRM_P_H_
39 
40 #if defined(_KERNEL) || defined(__KERNEL__)
41 
42 #include <sys/param.h>
43 #include <sys/queue.h>
44 #include <sys/malloc.h>
45 #include <sys/kernel.h>
46 #include <sys/ktr.h>
47 #include <sys/module.h>
48 #include <sys/systm.h>
49 #include <sys/device.h>
50 #include <sys/sglist.h>
51 #include <sys/stat.h>
52 #include <sys/priv.h>
53 #include <sys/proc.h>
54 #include <sys/lock.h>
55 #include <sys/spinlock.h>
56 #include <sys/spinlock2.h>
57 #include <sys/fcntl.h>
58 #include <sys/uio.h>
59 #include <sys/filio.h>
60 #include <sys/sysctl.h>
61 #include <sys/bus.h>
62 #include <sys/queue.h>
63 #include <sys/signalvar.h>
64 #include <sys/poll.h>
65 #include <sys/sbuf.h>
66 #include <sys/taskqueue.h>
67 #include <sys/tree.h>
68 #include <vm/vm.h>
69 #include <vm/pmap.h>
70 #include <vm/vm_extern.h>
71 #include <vm/vm_kern.h>
72 #include <vm/vm_map.h>
73 #include <vm/vm_object.h>
74 #include <vm/vm_page2.h>
75 #include <vm/vm_pager.h>
76 #include <vm/vm_param.h>
77 #include <machine/param.h>
78 #include <machine/pmap.h>
79 #if defined(__i386__) || defined(__amd64__)
80 #include <machine/specialreg.h>
81 #endif
82 #include <machine/sysarch.h>
83 #include <sys/endian.h>
84 #include <sys/mman.h>
85 #include <sys/rman.h>
86 #include <sys/memrange.h>
87 #include <dev/agp/agpvar.h>
88 #include <sys/agpio.h>
89 #include <sys/mutex.h>
90 #include <bus/pci/pcivar.h>
91 #include <bus/pci/pcireg.h>
92 
93 #include <uapi_drm/drm.h>
94 #include <uapi_drm/drm_sarea.h>
95 
96 #include <linux/atomic.h>
97 #include <linux/err.h>
98 #include <linux/idr.h>
99 #include <linux/pci.h>
100 #include <linux/jiffies.h>
101 #include <linux/kernel.h>
102 #include <linux/kref.h>
103 #include <linux/list.h>
104 #include <linux/mm.h>
105 #include <linux/mutex.h>
106 #include <linux/timer.h>
107 #include <asm/io.h>
108 #include <linux/types.h>
109 #include <linux/wait.h>
110 
111 #include <asm/uaccess.h>
112 
113 struct drm_file;
114 struct drm_device;
115 
116 #include <drm/drm_os_linux.h>
117 #include <drm/drm_hashtab.h>
118 #include <drm/drm_mm.h>
119 
120 #define DRM_UT_CORE 		0x01
121 #define DRM_UT_DRIVER		0x02
122 #define DRM_UT_KMS		0x04
123 #define DRM_UT_PRIME		0x08
124 
125 #include "opt_drm.h"
126 #ifdef DRM_DEBUG
127 #undef DRM_DEBUG
128 #define DRM_DEBUG_DEFAULT_ON 1
129 #endif /* DRM_DEBUG */
130 
131 #define	DRM_DEBUGBITS_DEBUG		0x1
132 #define	DRM_DEBUGBITS_KMS		0x2
133 #define	DRM_DEBUGBITS_FAILED_IOCTL	0x4
134 
135 #undef DRM_LINUX
136 #define DRM_LINUX 0
137 
138 /***********************************************************************/
139 /** \name DRM template customization defaults */
140 /*@{*/
141 
142 /* driver capabilities and requirements mask */
143 #define DRIVER_USE_AGP     0x1
144 #define DRIVER_REQUIRE_AGP 0x2
145 #define DRIVER_USE_MTRR    0x4
146 #define DRIVER_PCI_DMA     0x8
147 #define DRIVER_SG          0x10
148 #define DRIVER_HAVE_DMA    0x20
149 #define DRIVER_HAVE_IRQ    0x40
150 #define DRIVER_IRQ_SHARED  0x80
151 #define DRIVER_IRQ_VBL     0x100
152 #define DRIVER_DMA_QUEUE   0x200
153 #define DRIVER_FB_DMA      0x400
154 #define DRIVER_IRQ_VBL2    0x800
155 #define DRIVER_GEM         0x1000
156 #define DRIVER_MODESET     0x2000
157 #define DRIVER_PRIME       0x4000
158 #define DRIVER_LOCKLESS_IRQ 0x8000
159 
160 /***********************************************************************/
161 /** \name Begin the DRM... */
162 /*@{*/
163 
164 #define DRM_HASH_SIZE	      16 /* Size of key hash table		  */
165 #define DRM_KERNEL_CONTEXT    0	 /* Change drm_resctx if changed	  */
166 #define DRM_RESERVED_CONTEXTS 1	 /* Change drm_resctx if changed	  */
167 
168 #define	DRM_GEM_MAPPING_MASK	(3ULL << 62)
169 #define	DRM_GEM_MAPPING_KEY	(2ULL << 62) /* Non-canonical address form */
170 #define	DRM_GEM_MAX_IDX		0x3fffff
171 #define	DRM_GEM_MAPPING_IDX(o)	(((o) >> 40) & DRM_GEM_MAX_IDX)
172 #define	DRM_GEM_MAPPING_OFF(i)	(((uint64_t)(i)) << 40)
173 #define	DRM_GEM_MAPPING_MAPOFF(o) \
174     ((o) & ~(DRM_GEM_MAPPING_OFF(DRM_GEM_MAX_IDX) | DRM_GEM_MAPPING_KEY))
175 
176 MALLOC_DECLARE(M_DRM);
177 
178 SYSCTL_DECL(_hw_drm);
179 
180 #define DRM_MAX_CTXBITMAP (PAGE_SIZE * 8)
181 
182 /***********************************************************************/
183 /** \name Internal types and structures */
184 /*@{*/
185 
186 #define DRM_ARRAY_SIZE(x) NELEM(x)
187 #define DRM_MIN(a,b) ((a)<(b)?(a):(b))
188 #define DRM_MAX(a,b) ((a)>(b)?(a):(b))
189 
190 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
191 
192 #define __OS_HAS_AGP	1
193 
194 #define DRM_DEV_MODE	(S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP)
195 #define DRM_DEV_UID	0
196 #define DRM_DEV_GID	0
197 
198 #define DRM_WAKEUP(w)		wakeup((void *)w)
199 #define DRM_WAKEUP_INT(w)	wakeup(w)
200 #define DRM_INIT_WAITQUEUE(queue) do {(void)(queue);} while (0)
201 
202 #define DRM_CURPROC		curthread
203 #define DRM_STRUCTPROC		struct thread
204 #define DRM_CURRENTPID		(curproc != NULL ? curproc->p_pid : -1)
205 #define DRM_LOCK(dev)		lockmgr(&(dev)->dev_struct_lock, LK_EXCLUSIVE)
206 #define DRM_UNLOCK(dev)		lockmgr(&(dev)->dev_struct_lock, LK_RELEASE)
207 #define	DRM_LOCK_SLEEP(dev, chan, flags, msg, timeout)			\
208     (lksleep((chan), &(dev)->dev_struct_lock, (flags), (msg), (timeout)))
209 #if defined(INVARIANTS)
210 #define	DRM_LOCK_ASSERT(dev)	KKASSERT(lockstatus(&(dev)->dev_struct_lock, curthread) != 0);
211 #define	DRM_UNLOCK_ASSERT(dev)	KKASSERT(lockstatus(&(dev)->dev_struct_lock, curthread) == 0);
212 #else
213 #define	DRM_LOCK_ASSERT(d)
214 #define	DRM_UNLOCK_ASSERT(d)
215 #endif
216 
217 #define DRM_SYSCTL_HANDLER_ARGS	(SYSCTL_HANDLER_ARGS)
218 
219 #define DRM_IRQ_ARGS		void *arg
220 typedef void			irqreturn_t;
221 #define IRQ_HANDLED		/* nothing */
222 #define IRQ_NONE		/* nothing */
223 
224 enum {
225 	DRM_IS_NOT_AGP,
226 	DRM_IS_AGP,
227 	DRM_MIGHT_BE_AGP
228 };
229 #define DRM_AGP_MEM		struct agp_memory_info
230 
231 #define drm_get_device_from_kdev(_kdev) (_kdev->si_drv1)
232 
233 /* DRM_SUSER returns true if the user is superuser */
234 #define DRM_SUSER(p)		(priv_check(p, PRIV_DRIVER) == 0)
235 #define DRM_AGP_FIND_DEVICE()	agp_find_device()
236 #define DRM_MTRR_WC		MDF_WRITECOMBINE
237 
238 /* DRM_READMEMORYBARRIER() prevents reordering of reads.
239  * DRM_WRITEMEMORYBARRIER() prevents reordering of writes.
240  * DRM_MEMORYBARRIER() prevents reordering of reads and writes.
241  */
242 #define DRM_READMEMORYBARRIER()		cpu_lfence()
243 #define DRM_WRITEMEMORYBARRIER()	cpu_sfence()
244 #define DRM_MEMORYBARRIER()		cpu_mfence()
245 
246 #define DRM_VERIFYAREA_READ( uaddr, size )		\
247 	(!useracc(__DECONST(caddr_t, uaddr), size, VM_PROT_READ))
248 
249 #define DRM_COPY_TO_USER(user, kern, size) \
250 	copyout(kern, user, size)
251 #define DRM_COPY_FROM_USER(kern, user, size) \
252 	copyin(user, kern, size)
253 #define DRM_COPY_FROM_USER_UNCHECKED(arg1, arg2, arg3) 	\
254 	copyin(arg2, arg1, arg3)
255 #define DRM_COPY_TO_USER_UNCHECKED(arg1, arg2, arg3)	\
256 	copyout(arg2, arg1, arg3)
257 #define DRM_GET_USER_UNCHECKED(val, uaddr)		\
258 	((val) = fuword32(uaddr), 0)
259 
260 #define	drm_can_sleep()	(DRM_HZ & 1)
261 
262 #define DRM_GET_PRIV_SAREA(_dev, _ctx, _map) do {	\
263 	(_map) = (_dev)->context_sareas[_ctx];		\
264 } while(0)
265 
266 #define LOCK_TEST_WITH_RETURN(dev, file_priv)				\
267 do {									\
268 	if (!_DRM_LOCK_IS_HELD(dev->lock.hw_lock->lock) ||		\
269 	     dev->lock.file_priv != file_priv) {			\
270 		DRM_ERROR("%s called without lock held\n",		\
271 			   __FUNCTION__);				\
272 		return EINVAL;						\
273 	}								\
274 } while (0)
275 
276 /* Returns -errno to shared code */
277 #define DRM_WAIT_ON( ret, queue, timeout, condition )		\
278 for ( ret = 0 ; !ret && !(condition) ; ) {			\
279 	DRM_UNLOCK(dev);					\
280 	lwkt_serialize_enter(&dev->irq_lock);			\
281 	if (!(condition)) {					\
282             tsleep_interlock(&(queue), PCATCH);			\
283             lwkt_serialize_exit(&dev->irq_lock);		\
284             ret = -tsleep(&(queue), PCATCH | PINTERLOCKED,	\
285 			  "drmwtq", (timeout));			\
286         } else {                                                \
287                 lwkt_serialize_exit(&dev->irq_lock);            \
288         }                                                 	\
289 	DRM_LOCK(dev);						\
290 }
291 
292 __inline static void
293 vm_page_unhold_pages(vm_page_t *ma, int count)
294 {
295 	int i;
296 
297 	for (i = 0; i < count; i++)
298 		vm_page_unhold(ma[i]);
299 }
300 
301 int vm_phys_fictitious_reg_range(vm_paddr_t start, vm_paddr_t end,
302     vm_memattr_t memattr);
303 void vm_phys_fictitious_unreg_range(vm_paddr_t start, vm_paddr_t end);
304 vm_page_t vm_phys_fictitious_to_vm_page(vm_paddr_t pa);
305 
306 #define DRM_ERROR(fmt, ...) \
307 	kprintf("error: [" DRM_NAME ":pid%d:%s] *ERROR* " fmt,		\
308 	    DRM_CURRENTPID, __func__ , ##__VA_ARGS__)
309 
310 #define DRM_INFO(fmt, ...)  kprintf("info: [" DRM_NAME "] " fmt , ##__VA_ARGS__)
311 
312 #define DRM_DEBUG(fmt, ...) do {					\
313 	if ((drm_debug & DRM_DEBUGBITS_DEBUG) != 0)		\
314 		kprintf("[" DRM_NAME ":pid%d:%s] " fmt, DRM_CURRENTPID,	\
315 			__func__ , ##__VA_ARGS__);			\
316 } while (0)
317 
318 #define DRM_DEBUG_KMS(fmt, ...) do {					\
319 	if ((drm_debug & DRM_DEBUGBITS_KMS) != 0)			\
320 		kprintf("[" DRM_NAME ":KMS:pid%d:%s] " fmt, DRM_CURRENTPID,\
321 			__func__ , ##__VA_ARGS__);			\
322 } while (0)
323 
324 #define DRM_DEBUG_DRIVER(fmt, ...) do {					\
325 	if ((drm_debug & DRM_DEBUGBITS_KMS) != 0)			\
326 		kprintf("[" DRM_NAME ":KMS:pid%d:%s] " fmt, DRM_CURRENTPID,\
327 			__func__ , ##__VA_ARGS__);			\
328 } while (0)
329 
330 #define	dev_err(dev, fmt, ...)						\
331 	device_printf((dev), "error: " fmt, ## __VA_ARGS__)
332 #define	dev_warn(dev, fmt, ...)						\
333 	device_printf((dev), "warning: " fmt, ## __VA_ARGS__)
334 #define	dev_info(dev, fmt, ...)						\
335 	device_printf((dev), "info: " fmt, ## __VA_ARGS__)
336 #define	dev_dbg(dev, fmt, ...) do {					\
337 	if ((drm_debug& DRM_DEBUGBITS_KMS) != 0) {			\
338 		device_printf((dev), "debug: " fmt, ## __VA_ARGS__);	\
339 	}								\
340 } while (0)
341 
342 typedef struct drm_pci_id_list
343 {
344 	int vendor;
345 	int device;
346 	long driver_private;
347 	char *name;
348 } drm_pci_id_list_t;
349 
350 struct drm_msi_blacklist_entry
351 {
352 	int vendor;
353 	int device;
354 };
355 
356 #define DRM_IOCTL_NR(n)                ((n) & 0xff)
357 
358 #define DRM_AUTH	0x1
359 #define DRM_MASTER	0x2
360 #define DRM_ROOT_ONLY	0x4
361 #define DRM_CONTROL_ALLOW 0x8
362 #define DRM_UNLOCKED	0x10
363 
364 typedef struct drm_ioctl_desc {
365 	unsigned long cmd;
366 	int (*func)(struct drm_device *dev, void *data,
367 		    struct drm_file *file_priv);
368 	int flags;
369 	unsigned int cmd_drv;
370 } drm_ioctl_desc_t;
371 
372 /**
373  * Creates a driver or general drm_ioctl_desc array entry for the given
374  * ioctl, for use by drm_ioctl().
375  */
376 #define DRM_IOCTL_DEF(ioctl, func, flags) \
377 	[DRM_IOCTL_NR(ioctl)] = {ioctl, func, flags}
378 
379 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags)			\
380 	[DRM_IOCTL_NR(DRM_##ioctl)] = {.cmd = DRM_##ioctl, .func = _func, .flags = _flags, .cmd_drv = DRM_IOCTL_##ioctl}
381 
382 typedef struct drm_magic_entry {
383 	drm_magic_t	       magic;
384 	struct drm_file	       *priv;
385 	struct drm_magic_entry *next;
386 } drm_magic_entry_t;
387 
388 typedef struct drm_magic_head {
389 	struct drm_magic_entry *head;
390 	struct drm_magic_entry *tail;
391 } drm_magic_head_t;
392 
393 typedef struct drm_buf {
394 	int idx;		       /**< Index into master buflist */
395 	int total;		       /**< Buffer size */
396 	int order;		       /**< log-base-2(total) */
397 	int used;		       /**< Amount of buffer in use (for DMA) */
398 	unsigned long offset;	       /**< Byte offset (used internally) */
399 	void *address;		       /**< Address of buffer */
400 	unsigned long bus_address;     /**< Bus address of buffer */
401 	struct drm_buf *next;	       /**< Kernel-only: used for free list */
402 	__volatile__ int waiting;      /**< On kernel DMA queue */
403 	__volatile__ int pending;      /**< On hardware DMA queue */
404 	struct drm_file *file_priv;    /**< Private of holding file descr */
405 	int context;		       /**< Kernel queue for this buffer */
406 	int while_locked;	       /**< Dispatch this buffer while locked */
407 	enum {
408 		DRM_LIST_NONE = 0,
409 		DRM_LIST_FREE = 1,
410 		DRM_LIST_WAIT = 2,
411 		DRM_LIST_PEND = 3,
412 		DRM_LIST_PRIO = 4,
413 		DRM_LIST_RECLAIM = 5
414 	} list;			       /**< Which list we're on */
415 
416 	int dev_priv_size;		 /**< Size of buffer private storage */
417 	void *dev_private;		 /**< Per-buffer private storage */
418 } drm_buf_t;
419 
420 struct drm_freelist {
421 	int		  initialized; /* Freelist in use		   */
422 	atomic_t	  count;       /* Number of free buffers	   */
423 	drm_buf_t	  *next;       /* End pointer			   */
424 
425 	wait_queue_head_t waiting;     /**< Processes waiting on free bufs */
426 	int		  low_mark;    /* Low water mark		   */
427 	int		  high_mark;   /* High water mark		   */
428 };
429 
430 typedef struct drm_dma_handle {
431 	void *vaddr;
432 	bus_addr_t busaddr;
433 	bus_dma_tag_t tag;
434 	bus_dmamap_t map;
435 } drm_dma_handle_t;
436 
437 typedef struct drm_buf_entry {
438 	int		  buf_size;
439 	int		  buf_count;
440 	drm_buf_t	  *buflist;
441 	int		  seg_count;
442 	drm_dma_handle_t  **seglist;
443 	int		  page_order;
444 
445 	struct drm_freelist freelist;
446 } drm_buf_entry_t;
447 
448 /* Event queued up for userspace to read */
449 struct drm_pending_event {
450 	struct drm_event *event;
451 	struct list_head link;
452 	struct drm_file *file_priv;
453 	pid_t pid; /* pid of requester, no guarantee it's valid by the time
454 		      we deliver the event, for tracing only */
455 	void (*destroy)(struct drm_pending_event *event);
456 };
457 
458 /* initial implementaton using a linked list - todo hashtab */
459 struct drm_prime_file_private {
460 	struct list_head head;
461 #ifdef DUMBBELL_WIP
462 	struct mutex lock;
463 #endif /* DUMBBELL_WIP */
464 };
465 
466 /** File private data */
467 struct drm_file {
468 	int authenticated;
469 	struct drm_device *dev;
470 	int		  master;
471 	pid_t		  pid;
472 	uid_t		  uid;
473 	drm_magic_t	  magic;
474 	unsigned long	  ioctl_count;
475 	struct list_head lhead;
476 	struct kqinfo	  dkq;
477 
478 	/** Mapping of mm object handles to object pointers. */
479 	struct idr object_idr;
480 	/** Lock for synchronization of access to object_idr. */
481 	struct lock table_lock;
482 
483 	void		 *driver_priv;
484 
485 	int		  is_master;
486 	struct drm_master *masterp;
487 
488 	struct list_head  fbs;
489 
490 	wait_queue_head_t event_wait;
491 	struct list_head  event_list;
492 	int		  event_space;
493 
494 	struct drm_prime_file_private prime;
495 };
496 
497 /**
498  * Lock data.
499  */
500 struct drm_lock_data {
501 	struct drm_hw_lock *hw_lock;	/**< Hardware lock */
502 	/** Private of lock holder's file (NULL=kernel) */
503 	struct drm_file *file_priv;
504 	wait_queue_head_t lock_queue;	/**< Queue of blocked processes */
505 	unsigned long lock_time;	/**< Time of last lock in jiffies */
506 };
507 
508 /* This structure, in the struct drm_device, is always initialized while the
509  * device
510  * is open.  dev->dma_lock protects the incrementing of dev->buf_use, which
511  * when set marks that no further bufs may be allocated until device teardown
512  * occurs (when the last open of the device has closed).  The high/low
513  * watermarks of bufs are only touched by the X Server, and thus not
514  * concurrently accessed, so no locking is needed.
515  */
516 typedef struct drm_device_dma {
517 
518 	struct drm_buf_entry bufs[DRM_MAX_ORDER + 1];	/**< buffers, grouped by their size order */
519 	int buf_count;			/**< total number of buffers */
520 	struct drm_buf **buflist;		/**< Vector of pointers into drm_device_dma::bufs */
521 	int seg_count;
522 	int page_count;			/**< number of pages */
523 	unsigned long *pagelist;	/**< page list */
524 	unsigned long byte_count;
525 	enum {
526 		_DRM_DMA_USE_AGP = 0x01,
527 		_DRM_DMA_USE_SG = 0x02,
528 		_DRM_DMA_USE_FB = 0x04,
529 		_DRM_DMA_USE_PCI_RO = 0x08
530 	} flags;
531 
532 } drm_device_dma_t;
533 
534 typedef struct drm_agp_mem {
535 	void               *handle;
536 	unsigned long      bound; /* address */
537 	int                pages;
538 	struct drm_agp_mem *prev;
539 	struct drm_agp_mem *next;
540 } drm_agp_mem_t;
541 
542 typedef struct drm_agp_head {
543 	device_t	   agpdev;
544 	struct agp_info    agp_info;
545 	const char         *chipset;
546 	drm_agp_mem_t      *memory;
547 	unsigned long      mode;
548 	int                enabled;
549 	int                acquired;
550 	unsigned long      base;
551 	int		   agp_mtrr;
552 	int		   cant_use_aperture;
553 	unsigned long	   page_mask;
554 } drm_agp_head_t;
555 
556 typedef struct drm_sg_mem {
557 	vm_offset_t vaddr;
558 	vm_paddr_t *busaddr;
559 	vm_pindex_t pages;
560 } drm_sg_mem_t;
561 
562 /**
563  * Kernel side of a mapping
564  */
565 struct drm_local_map {
566 	resource_size_t offset;	 /**< Requested physical address (0 for SAREA)*/
567 	unsigned long size;	 /**< Requested physical size (bytes) */
568 	enum drm_map_type type;	 /**< Type of memory to map */
569 	enum drm_map_flags flags;	 /**< Flags */
570 	void *handle;		 /**< User-space: "Handle" to pass to mmap() */
571 				 /**< Kernel-space: kernel-virtual address */
572 	int mtrr;		 /**< MTRR slot used */
573 };
574 
575 typedef struct drm_local_map drm_local_map_t;
576 
577 /**
578  * Mappings list
579  */
580 struct drm_map_list {
581 	struct list_head head;		/**< list head */
582 	struct drm_hash_item hash;
583 	struct drm_local_map *map;	/**< mapping */
584 	uint64_t user_token;
585 	struct drm_master *master;
586 	struct drm_mm_node *file_offset_node;	/**< fake offset */
587 };
588 
589 struct drm_vblank_info {
590 	wait_queue_head_t queue;	/* vblank wait queue */
591 	atomic_t count;			/* number of VBLANK interrupts */
592 					/* (driver must alloc the right number of counters) */
593 	atomic_t refcount;		/* number of users of vblank interrupts */
594 	u32 last;			/* protected by dev->vbl_lock, used */
595 					/* for wraparound handling */
596 	int enabled;			/* so we don't call enable more than */
597 					/* once per disable */
598 	int inmodeset;			/* Display driver is setting mode */
599 };
600 
601 /* location of GART table */
602 #define DRM_ATI_GART_MAIN 1
603 #define DRM_ATI_GART_FB   2
604 
605 #define DRM_ATI_GART_PCI 1
606 #define DRM_ATI_GART_PCIE 2
607 #define DRM_ATI_GART_IGP 3
608 
609 struct drm_ati_pcigart_info {
610 	int gart_table_location;
611 	int gart_reg_if;
612 	void *addr;
613 	dma_addr_t bus_addr;
614 	dma_addr_t table_mask;
615 	dma_addr_t member_mask;
616 	struct drm_dma_handle *table_handle;
617 	drm_local_map_t mapping;
618 	int table_size;
619 	struct drm_dma_handle *dmah; /* handle for ATI PCIGART table */
620 };
621 
622 /**
623  * GEM specific mm private for tracking GEM objects
624  */
625 struct drm_gem_mm {
626 	struct drm_open_hash offset_hash; /**< User token hash table for maps */
627 	struct unrhdr *idxunr;
628 };
629 
630 struct drm_gem_object {
631 	/** Reference count of this object */
632 	struct kref refcount;
633 
634 	/** Handle count of this object. Each handle also holds a reference */
635 	atomic_t handle_count; /* number of handles on this object */
636 
637 	/** Related drm device */
638 	struct drm_device *dev;
639 
640 	/** File representing the shmem storage: filp in Linux parlance */
641 	vm_object_t vm_obj;
642 
643 	bool on_map;
644 	struct drm_hash_item map_list;
645 
646 	/**
647 	 * Size of the object, in bytes.  Immutable over the object's
648 	 * lifetime.
649 	 */
650 	size_t size;
651 
652 	/**
653 	 * Global name for this object, starts at 1. 0 means unnamed.
654 	 * Access is covered by the object_name_lock in the related drm_device
655 	 */
656 	int name;
657 
658 	/**
659 	 * Memory domains. These monitor which caches contain read/write data
660 	 * related to the object. When transitioning from one set of domains
661 	 * to another, the driver is called to ensure that caches are suitably
662 	 * flushed and invalidated
663 	 */
664 	uint32_t read_domains;
665 	uint32_t write_domain;
666 
667 	/**
668 	 * While validating an exec operation, the
669 	 * new read/write domain values are computed here.
670 	 * They will be transferred to the above values
671 	 * at the point that any cache flushing occurs
672 	 */
673 	uint32_t pending_read_domains;
674 	uint32_t pending_write_domain;
675 
676 	void *driver_private;
677 
678 #ifdef DUMBBELL_WIP
679 	/* dma buf exported from this GEM object */
680 	struct dma_buf *export_dma_buf;
681 
682 	/* dma buf attachment backing this object */
683 	struct dma_buf_attachment *import_attach;
684 #endif /* DUMBBELL_WIP */
685 };
686 
687 #include "drm_crtc.h"
688 
689 /* per-master structure */
690 struct drm_master {
691 
692 	struct kref refcount; /* refcount for this master */
693 
694 	struct list_head head; /**< each minor contains a list of masters */
695 	struct drm_minor *minor; /**< link back to minor we are a master for */
696 
697 	char *unique;			/**< Unique identifier: e.g., busid */
698 	int unique_len;			/**< Length of unique field */
699 	int unique_size;		/**< amount allocated */
700 
701 	int blocked;			/**< Blocked due to VC switch? */
702 
703 	/** \name Authentication */
704 	/*@{ */
705 	struct drm_open_hash magiclist;
706 	struct list_head magicfree;
707 	/*@} */
708 
709 	struct drm_lock_data lock;	/**< Information on hardware lock */
710 
711 	void *driver_priv; /**< Private structure for driver to use */
712 };
713 
714 /* Size of ringbuffer for vblank timestamps. Just double-buffer
715  * in initial implementation.
716  */
717 #define DRM_VBLANKTIME_RBSIZE 2
718 
719 /* Flags and return codes for get_vblank_timestamp() driver function. */
720 #define DRM_CALLED_FROM_VBLIRQ 1
721 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
722 #define DRM_VBLANKTIME_INVBL             (1 << 1)
723 
724 /* get_scanout_position() return flags */
725 #define DRM_SCANOUTPOS_VALID        (1 << 0)
726 #define DRM_SCANOUTPOS_INVBL        (1 << 1)
727 #define DRM_SCANOUTPOS_ACCURATE     (1 << 2)
728 
729 #ifndef DMA_BIT_MASK
730 #define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : (1ULL<<(n)) - 1)
731 #endif
732 
733 #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
734 
735 struct drm_driver {
736 	int	(*load)(struct drm_device *, unsigned long flags);
737 	int	(*use_msi)(struct drm_device *, unsigned long flags);
738 	int	(*firstopen)(struct drm_device *);
739 	int	(*open)(struct drm_device *, struct drm_file *);
740 	void	(*preclose)(struct drm_device *, struct drm_file *file_priv);
741 	void	(*postclose)(struct drm_device *, struct drm_file *);
742 	void	(*lastclose)(struct drm_device *);
743 	int	(*unload)(struct drm_device *);
744 	void	(*reclaim_buffers_locked)(struct drm_device *,
745 					  struct drm_file *file_priv);
746 	int	(*dma_ioctl)(struct drm_device *dev, void *data,
747 			     struct drm_file *file_priv);
748 	void	(*dma_ready)(struct drm_device *);
749 	int	(*dma_quiescent)(struct drm_device *);
750 	int	(*dma_flush_block_and_flush)(struct drm_device *, int context,
751 					     enum drm_lock_flags flags);
752 	int	(*dma_flush_unblock)(struct drm_device *, int context,
753 				     enum drm_lock_flags flags);
754 	int	(*context_ctor)(struct drm_device *dev, int context);
755 	int	(*context_dtor)(struct drm_device *dev, int context);
756 	int	(*kernel_context_switch)(struct drm_device *dev, int old,
757 					 int new);
758 	int	(*kernel_context_switch_unlock)(struct drm_device *dev);
759 	void	(*irq_preinstall)(struct drm_device *dev);
760 	int	(*irq_postinstall)(struct drm_device *dev);
761 	void	(*irq_uninstall)(struct drm_device *dev);
762 	void	(*irq_handler)(DRM_IRQ_ARGS);
763 
764 	u32	(*get_vblank_counter)(struct drm_device *dev, int crtc);
765 	int	(*enable_vblank)(struct drm_device *dev, int crtc);
766 	void	(*disable_vblank)(struct drm_device *dev, int crtc);
767 	int	(*get_scanout_position)(struct drm_device *dev, int crtc,
768 		    int *vpos, int *hpos);
769 
770 	int	(*get_vblank_timestamp)(struct drm_device *dev, int crtc,
771 		    int *max_error, struct timeval *vblank_time,
772 		    unsigned flags);
773 
774 	int	(*gem_init_object)(struct drm_gem_object *obj);
775 	void	(*gem_free_object)(struct drm_gem_object *obj);
776 	int	(*gem_open_object)(struct drm_gem_object *, struct drm_file *);
777 	void	(*gem_close_object)(struct drm_gem_object *, struct drm_file *);
778 
779 	struct cdev_pager_ops *gem_pager_ops;
780 
781 	int	(*dumb_create)(struct drm_file *file_priv,
782 		    struct drm_device *dev, struct drm_mode_create_dumb *args);
783 	int	(*dumb_map_offset)(struct drm_file *file_priv,
784 		    struct drm_device *dev, uint32_t handle, uint64_t *offset);
785 	int	(*dumb_destroy)(struct drm_file *file_priv,
786 		    struct drm_device *dev, uint32_t handle);
787 
788 	int	(*sysctl_init)(struct drm_device *dev,
789 		    struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
790 	void	(*sysctl_cleanup)(struct drm_device *dev);
791 
792 	drm_pci_id_list_t *id_entry;	/* PCI ID, name, and chipset private */
793 
794 	/**
795 	 * Called by \c drm_device_is_agp.  Typically used to determine if a
796 	 * card is really attached to AGP or not.
797 	 *
798 	 * \param dev  DRM device handle
799 	 *
800 	 * \returns
801 	 * One of three values is returned depending on whether or not the
802 	 * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
803 	 * (return of 1), or may or may not be AGP (return of 2).
804 	 */
805 	int	(*device_is_agp) (struct drm_device * dev);
806 
807 	drm_ioctl_desc_t *ioctls;
808 #ifdef COMPAT_FREEBSD32
809 	drm_ioctl_desc_t *compat_ioctls;
810 	int	*compat_ioctls_nr;
811 #endif
812 
813 	int	buf_priv_size;
814 
815 	int	major;
816 	int	minor;
817 	int	patchlevel;
818 	const char *name;		/* Simple driver name		   */
819 	const char *desc;		/* Longer driver name		   */
820 	const char *date;		/* Date of last major changes.	   */
821 
822 	u32 driver_features;
823 	int num_ioctls;
824 };
825 
826 /**
827  * DRM minor structure. This structure represents a drm minor number.
828  */
829 struct drm_minor {
830 	int index;			/**< Minor device number */
831 	int type;                       /**< Control or render */
832 	device_t kdev;			/**< OS device */
833 	struct drm_device *dev;
834 
835 	struct drm_master *master; /* currently active master for this node */
836 	struct list_head master_list;
837 	struct drm_mode_group mode_group;
838 };
839 
840 /* mode specified on the command line */
841 struct drm_cmdline_mode {
842 	bool specified;
843 	bool refresh_specified;
844 	bool bpp_specified;
845 	int xres, yres;
846 	int bpp;
847 	int refresh;
848 	bool rb;
849 	bool interlace;
850 	bool cvt;
851 	bool margins;
852 	enum drm_connector_force force;
853 };
854 
855 
856 struct drm_pending_vblank_event {
857 	struct drm_pending_event base;
858 	int pipe;
859 	struct drm_event_vblank event;
860 };
861 
862 /* Length for the array of resource pointers for drm_get_resource_*. */
863 #define DRM_MAX_PCI_RESOURCE	6
864 
865 /**
866  * DRM device structure. This structure represent a complete card that
867  * may contain multiple heads.
868  */
869 struct drm_device {
870 	drm_pci_id_list_t *id_entry;	/* PCI ID, name, and chipset private */
871 
872 	uint16_t pci_device;		/* PCI device id */
873 	uint16_t pci_vendor;		/* PCI vendor id */
874 	uint16_t pci_subdevice;		/* PCI subsystem device id */
875 	uint16_t pci_subvendor;		/* PCI subsystem vendor id */
876 
877 	char		  *unique;	/* Unique identifier: e.g., busid  */
878 	int		  unique_len;	/* Length of unique field	   */
879 	struct cdev	  *devnode;	/* Device number for mknod	   */
880 	int		  if_version;	/* Highest interface version set */
881 
882 	int		  flags;	/* Flags to open(2)		   */
883 
884 				/* Locks */
885 	struct spinlock	  dma_lock;	/* protects dev->dma */
886 	struct lwkt_serialize irq_lock;	/* protects irq condition checks */
887 	struct lock	  dev_lock;	/* protects everything else */
888 	struct lock	  dev_struct_lock;
889 
890 	/** \name Locks */
891 	/*@{ */
892 	struct lock struct_mutex;	/**< For others */
893 	/*@} */
894 
895 	/** \name Usage Counters */
896 	/*@{ */
897 	int		  open_count;	/* Outstanding files open	   */
898 	int		  buf_use;	/* Buffers in use -- cannot alloc  */
899 	/*@} */
900 
901 
902 	/** \name Performance counters */
903 	/*@{ */
904 	unsigned long     counters;
905 	enum drm_stat_type	types[15];
906 	atomic_t          counts[15];
907 	/*@} */
908 
909 				/* Authentication */
910 	drm_magic_head_t  magiclist[DRM_HASH_SIZE];
911 
912 	struct list_head filelist;
913 
914 	/** \name Memory management */
915 	/*@{ */
916 	struct list_head maplist;	/**< Linked list of regions */
917 	int map_count;			/**< Number of mappable regions */
918 	struct drm_open_hash map_hash;	/**< User token hash table for maps */
919 
920 	drm_local_map_t	  **context_sareas;
921 	int		  max_context;
922 
923 	struct drm_lock_data lock;	/* Information on hardware lock	   */
924 
925 				/* DMA queues (contexts) */
926 	drm_device_dma_t  *dma;		/* Optional pointer for DMA support */
927 
928 				/* Context support */
929 	int		  irq;		/* Interrupt used by board	   */
930 	int		  msi_enabled;	/* MSI enabled */
931 	int		  irqrid;	/* Interrupt used by board */
932 	struct resource   *irqr;	/* Resource for interrupt used by board	   */
933 	void		  *irqh;	/* Handle from bus_setup_intr      */
934 
935 	/* Storage of resource pointers for drm_get_resource_* */
936 	struct resource   *pcir[DRM_MAX_PCI_RESOURCE];
937 	int		  pcirid[DRM_MAX_PCI_RESOURCE];
938 
939 	int		  pci_domain;
940 	int		  pci_bus;
941 	int		  pci_slot;
942 	int		  pci_func;
943 
944 	/** \name Context support */
945 	/*@{ */
946 	int irq_enabled;		/**< True if irq handler is enabled */
947 	__volatile__ long context_flag;	/**< Context swapping flag */
948 	int last_context;		/**< Last current context */
949 	/*@} */
950 
951 	int		  num_crtcs;
952 
953 	struct sigio      *buf_sigio;	/* Processes waiting for SIGIO     */
954 
955 				/* Sysctl support */
956 	struct drm_sysctl_info *sysctl;
957 	int		  sysctl_node_idx;
958 
959 	drm_agp_head_t    *agp;
960 
961 	struct device *dev;             /**< Device structure */
962 
963 	drm_sg_mem_t      *sg;  /* Scatter gather memory */
964 	unsigned long     *ctx_bitmap;
965 	void		  *dev_private;
966 
967 	void		  *drm_ttm_bdev;
968 
969 	/*
970 	 * At load time, disabling the vblank interrupt won't be allowed since
971 	 * old clients may not call the modeset ioctl and therefore misbehave.
972 	 * Once the modeset ioctl *has* been called though, we can safely
973 	 * disable them when unused.
974 	 */
975 	int vblank_disable_allowed;
976 
977 	wait_queue_head_t *vbl_queue;   /**< VBLANK wait queue */
978 	atomic_t *_vblank_count;        /**< number of VBLANK interrupts (driver must alloc the right number of counters) */
979 	struct timeval *_vblank_time;   /**< timestamp of current vblank_count (drivers must alloc right number of fields) */
980 	struct lock vblank_time_lock;   /**< Protects vblank count and time updates during vblank enable/disable */
981 	struct lock vbl_lock;
982 	atomic_t *vblank_refcount;      /* number of users of vblank interruptsper crtc */
983 	u32 *last_vblank;               /* protected by dev->vbl_lock, used */
984 					/* for wraparound handling */
985 	int *vblank_enabled;            /* so we don't call enable more than
986 					   once per disable */
987 	int *vblank_inmodeset;          /* Display driver is setting mode */
988 	u32 *last_vblank_wait;		/* Last vblank seqno waited per CRTC */
989 	struct timer_list vblank_disable_timer;
990 
991 	u32 max_vblank_count;           /**< size of vblank counter register */
992 
993 	/**
994 	 * List of events
995 	 */
996 	struct list_head vblank_event_list;
997 	struct lock	event_lock;
998 
999 	struct drm_driver *driver;
1000 	struct drm_local_map *agp_buffer_map;
1001 	unsigned int agp_buffer_token;
1002 	struct drm_minor *control;		/**< Control node for card */
1003 	struct drm_minor *primary;		/**< render type primary screen head */
1004 
1005         struct drm_mode_config mode_config;	/**< Current mode config */
1006 
1007 	/** \name GEM information */
1008 	/*@{ */
1009 	struct lock object_name_lock;
1010 	struct idr object_name_idr;
1011 	/*@} */
1012 	void             *mm_private;
1013 
1014 	void *sysctl_private;
1015 	char busid_str[128];
1016 	int modesetting;
1017 
1018 	int switch_power_state;
1019 };
1020 
1021 #define DRM_SWITCH_POWER_ON 0
1022 #define DRM_SWITCH_POWER_OFF 1
1023 #define DRM_SWITCH_POWER_CHANGING 2
1024 
1025 static __inline__ int drm_core_check_feature(struct drm_device *dev,
1026 					     int feature)
1027 {
1028 	return ((dev->driver->driver_features & feature) ? 1 : 0);
1029 }
1030 
1031 #if __OS_HAS_AGP
1032 static inline int drm_core_has_AGP(struct drm_device *dev)
1033 {
1034 	return drm_core_check_feature(dev, DRIVER_USE_AGP);
1035 }
1036 #else
1037 #define drm_core_has_AGP(dev) (0)
1038 #endif
1039 
1040 enum dmi_field {
1041         DMI_NONE,
1042         DMI_BIOS_VENDOR,
1043         DMI_BIOS_VERSION,
1044         DMI_BIOS_DATE,
1045         DMI_SYS_VENDOR,
1046         DMI_PRODUCT_NAME,
1047         DMI_PRODUCT_VERSION,
1048         DMI_PRODUCT_SERIAL,
1049         DMI_PRODUCT_UUID,
1050         DMI_BOARD_VENDOR,
1051         DMI_BOARD_NAME,
1052         DMI_BOARD_VERSION,
1053         DMI_BOARD_SERIAL,
1054         DMI_BOARD_ASSET_TAG,
1055         DMI_CHASSIS_VENDOR,
1056         DMI_CHASSIS_TYPE,
1057         DMI_CHASSIS_VERSION,
1058         DMI_CHASSIS_SERIAL,
1059         DMI_CHASSIS_ASSET_TAG,
1060         DMI_STRING_MAX,
1061 };
1062 
1063 struct dmi_strmatch {
1064 	unsigned char slot;
1065 	char substr[79];
1066 };
1067 
1068 struct dmi_system_id {
1069         int (*callback)(const struct dmi_system_id *);
1070         const char *ident;
1071         struct dmi_strmatch matches[4];
1072 };
1073 #define	DMI_MATCH(a, b) {(a), (b)}
1074 bool dmi_check_system(const struct dmi_system_id *);
1075 
1076 extern int	drm_notyet_flag;
1077 extern int	drm_debug;
1078 
1079 extern unsigned int drm_vblank_offdelay;
1080 extern unsigned int drm_timestamp_precision;
1081 extern unsigned int drm_timestamp_monotonic;
1082 
1083 /* Device setup support (drm_drv.c) */
1084 int	drm_probe(device_t kdev, drm_pci_id_list_t *idlist);
1085 int	drm_attach(device_t kdev, drm_pci_id_list_t *idlist);
1086 int	drm_create_cdevs(device_t kdev);
1087 int	drm_detach(device_t kdev);
1088 d_ioctl_t drm_ioctl;
1089 d_open_t drm_open;
1090 d_close_t drm_close;
1091 d_read_t drm_read;
1092 d_kqfilter_t drm_kqfilter;
1093 d_mmap_t drm_mmap;
1094 d_mmap_single_t drm_mmap_single;
1095 extern drm_local_map_t	*drm_getsarea(struct drm_device *dev);
1096 
1097 void drm_cdevpriv_dtor(void *cd);
1098 
1099 void drm_event_wakeup(struct drm_pending_event *e);
1100 
1101 int drm_add_busid_modesetting(struct drm_device *dev,
1102     struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
1103 
1104 /* File operations helpers (drm_fops.c) */
1105 extern int		drm_open_helper(struct cdev *kdev, int flags, int fmt,
1106 					 DRM_STRUCTPROC *p,
1107 					struct drm_device *dev,
1108 					struct file *fp);
1109 extern struct drm_file	*drm_find_file_by_proc(struct drm_device *dev,
1110 					DRM_STRUCTPROC *p);
1111 
1112 #ifdef DUMBBELL_WIP
1113 extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
1114 		struct drm_file *file_priv, uint32_t handle, uint32_t flags,
1115 		int *prime_fd);
1116 extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
1117 		struct drm_file *file_priv, int prime_fd, uint32_t *handle);
1118 
1119 extern int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data,
1120 					struct drm_file *file_priv);
1121 extern int drm_prime_fd_to_handle_ioctl(struct drm_device *dev, void *data,
1122 					struct drm_file *file_priv);
1123 
1124 #ifdef DUMBBELL_WIP
1125 /*
1126  * See drm_prime.c
1127  *   -- dumbbell@
1128  */
1129 extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, vm_page_t *pages,
1130 					    dma_addr_t *addrs, int max_pages);
1131 #endif /* DUMBBELL_WIP */
1132 extern struct sg_table *drm_prime_pages_to_sg(vm_page_t *pages, int nr_pages);
1133 extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
1134 
1135 
1136 void drm_prime_init_file_private(struct drm_prime_file_private *prime_fpriv);
1137 void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv);
1138 int drm_prime_add_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf, uint32_t handle);
1139 int drm_prime_lookup_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf, uint32_t *handle);
1140 void drm_prime_remove_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf);
1141 
1142 int drm_prime_add_dma_buf(struct drm_device *dev, struct drm_gem_object *obj);
1143 int drm_prime_lookup_obj(struct drm_device *dev, struct dma_buf *buf,
1144 			 struct drm_gem_object **obj);
1145 #endif /* DUMBBELL_WIP */
1146 
1147 /* Memory management support (drm_memory.c) */
1148 void	drm_mem_init(void);
1149 void	drm_mem_uninit(void);
1150 void	*drm_ioremap_wc(struct drm_device *dev, drm_local_map_t *map);
1151 void	*drm_ioremap(struct drm_device *dev, drm_local_map_t *map);
1152 void	drm_ioremapfree(drm_local_map_t *map);
1153 int	drm_mtrr_add(unsigned long offset, size_t size, int flags);
1154 int	drm_mtrr_del(int handle, unsigned long offset, size_t size, int flags);
1155 
1156 int	drm_ctxbitmap_init(struct drm_device *dev);
1157 void	drm_ctxbitmap_cleanup(struct drm_device *dev);
1158 void	drm_ctxbitmap_free(struct drm_device *dev, int ctx_handle);
1159 int	drm_ctxbitmap_next(struct drm_device *dev);
1160 
1161 /* Locking IOCTL support (drm_lock.c) */
1162 int	drm_lock_take(struct drm_lock_data *lock_data,
1163 		      unsigned int context);
1164 int	drm_lock_transfer(struct drm_lock_data *lock_data,
1165 			  unsigned int context);
1166 int	drm_lock_free(struct drm_lock_data *lock_data,
1167 		      unsigned int context);
1168 
1169 /*
1170  * These are exported to drivers so that they can implement fencing using
1171  * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
1172  */
1173 
1174 unsigned long drm_get_resource_start(struct drm_device *dev,
1175 				     unsigned int resource);
1176 unsigned long drm_get_resource_len(struct drm_device *dev,
1177 				   unsigned int resource);
1178 void	drm_rmmap(struct drm_device *dev, drm_local_map_t *map);
1179 int	drm_order(unsigned long size);
1180 int	drm_addbufs_agp(struct drm_device *dev, struct drm_buf_desc *request);
1181 int	drm_addbufs_pci(struct drm_device *dev, struct drm_buf_desc *request);
1182 extern int drm_addmap(struct drm_device *dev, resource_size_t offset,
1183 		      unsigned int size, enum drm_map_type type,
1184 		      enum drm_map_flags flags, struct drm_local_map **map_ptr);
1185 
1186 /* DMA support (drm_dma.c) */
1187 int	drm_dma_setup(struct drm_device *dev);
1188 void	drm_dma_takedown(struct drm_device *dev);
1189 void	drm_free_buffer(struct drm_device *dev, drm_buf_t *buf);
1190 void	drm_reclaim_buffers(struct drm_device *dev, struct drm_file *file_priv);
1191 #define drm_core_reclaim_buffers drm_reclaim_buffers
1192 
1193 				/* IRQ support (drm_irq.h) */
1194 int	drm_irq_install(struct drm_device *dev);
1195 int	drm_irq_uninstall(struct drm_device *dev);
1196 void	drm_driver_irq_preinstall(struct drm_device *dev);
1197 void	drm_driver_irq_postinstall(struct drm_device *dev);
1198 void	drm_driver_irq_uninstall(struct drm_device *dev);
1199 
1200 void	drm_vblank_pre_modeset(struct drm_device *dev, int crtc);
1201 void	drm_vblank_post_modeset(struct drm_device *dev, int crtc);
1202 int 	drm_modeset_ctl(struct drm_device *dev, void *data,
1203 			struct drm_file *file_priv);
1204 
1205 extern int drm_vblank_init(struct drm_device *dev, int num_crtcs);
1206 extern int drm_wait_vblank(struct drm_device *dev, void *data,
1207 			   struct drm_file *filp);
1208 extern int drm_vblank_wait(struct drm_device *dev, unsigned int *vbl_seq);
1209 extern u32 drm_vblank_count(struct drm_device *dev, int crtc);
1210 extern u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
1211 				     struct timeval *vblanktime);
1212 extern void drm_send_vblank_event(struct drm_device *dev, int crtc,
1213 				     struct drm_pending_vblank_event *e);
1214 extern bool drm_handle_vblank(struct drm_device *dev, int crtc);
1215 void drm_handle_vblank_events(struct drm_device *dev, int crtc);
1216 extern int drm_vblank_get(struct drm_device *dev, int crtc);
1217 extern void drm_vblank_put(struct drm_device *dev, int crtc);
1218 extern void drm_vblank_off(struct drm_device *dev, int crtc);
1219 extern void drm_vblank_cleanup(struct drm_device *dev);
1220 extern u32 drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
1221 				     struct timeval *tvblank, unsigned flags);
1222 extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
1223 						 int crtc, int *max_error,
1224 						 struct timeval *vblank_time,
1225 						 unsigned flags,
1226 						 struct drm_crtc *refcrtc);
1227 extern void drm_calc_timestamping_constants(struct drm_crtc *crtc);
1228 
1229 /* AGP/PCI Express/GART support (drm_agpsupport.c) */
1230 int	drm_device_is_agp(struct drm_device *dev);
1231 int	drm_device_is_pcie(struct drm_device *dev);
1232 drm_agp_head_t *drm_agp_init(void);
1233 int	drm_agp_acquire(struct drm_device *dev);
1234 int	drm_agp_release(struct drm_device *dev);
1235 int	drm_agp_info(struct drm_device * dev, struct drm_agp_info *info);
1236 int	drm_agp_enable(struct drm_device *dev, struct drm_agp_mode mode);
1237 void	*drm_agp_allocate_memory(size_t pages, u32 type);
1238 int	drm_agp_free_memory(void *handle);
1239 int	drm_agp_bind_memory(void *handle, off_t start);
1240 int	drm_agp_unbind_memory(void *handle);
1241 int	drm_agp_alloc(struct drm_device *dev, struct drm_agp_buffer *request);
1242 int	drm_agp_free(struct drm_device *dev, struct drm_agp_buffer *request);
1243 int	drm_agp_bind(struct drm_device *dev, struct drm_agp_binding *request);
1244 int	drm_agp_unbind(struct drm_device *dev, struct drm_agp_binding *request);
1245 
1246 /* Scatter Gather Support (drm_scatter.c) */
1247 void	drm_sg_cleanup(drm_sg_mem_t *entry);
1248 int	drm_sg_alloc(struct drm_device *dev, struct drm_scatter_gather * request);
1249 
1250 /* sysctl support (drm_sysctl.h) */
1251 extern int		drm_sysctl_init(struct drm_device *dev);
1252 extern int		drm_sysctl_cleanup(struct drm_device *dev);
1253 
1254 /* ATI PCIGART support (ati_pcigart.c) */
1255 int	drm_ati_pcigart_init(struct drm_device *dev,
1256 				struct drm_ati_pcigart_info *gart_info);
1257 int	drm_ati_pcigart_cleanup(struct drm_device *dev,
1258 				struct drm_ati_pcigart_info *gart_info);
1259 
1260 /* Cache management (drm_memory.c) */
1261 void	drm_clflush_pages(vm_page_t *pages, unsigned long num_pages);
1262 
1263 /* Locking IOCTL support (drm_drv.c) */
1264 int	drm_lock(struct drm_device *dev, void *data,
1265 		 struct drm_file *file_priv);
1266 int	drm_unlock(struct drm_device *dev, void *data,
1267 		   struct drm_file *file_priv);
1268 int	drm_version(struct drm_device *dev, void *data,
1269 		    struct drm_file *file_priv);
1270 int	drm_setversion(struct drm_device *dev, void *data,
1271 		       struct drm_file *file_priv);
1272 
1273 /* Misc. IOCTL support (drm_ioctl.c) */
1274 int	drm_irq_by_busid(struct drm_device *dev, void *data,
1275 			 struct drm_file *file_priv);
1276 int	drm_getunique(struct drm_device *dev, void *data,
1277 		      struct drm_file *file_priv);
1278 int	drm_setunique(struct drm_device *dev, void *data,
1279 		      struct drm_file *file_priv);
1280 int	drm_getmap(struct drm_device *dev, void *data,
1281 		   struct drm_file *file_priv);
1282 int	drm_getclient(struct drm_device *dev, void *data,
1283 		      struct drm_file *file_priv);
1284 int	drm_getstats(struct drm_device *dev, void *data,
1285 		     struct drm_file *file_priv);
1286 int	drm_getcap(struct drm_device *dev, void *data,
1287 		     struct drm_file *file_priv);
1288 int	drm_noop(struct drm_device *dev, void *data,
1289 		 struct drm_file *file_priv);
1290 
1291 /* Context IOCTL support (drm_context.c) */
1292 int	drm_resctx(struct drm_device *dev, void *data,
1293 		   struct drm_file *file_priv);
1294 int	drm_addctx(struct drm_device *dev, void *data,
1295 		   struct drm_file *file_priv);
1296 int	drm_modctx(struct drm_device *dev, void *data,
1297 		   struct drm_file *file_priv);
1298 int	drm_getctx(struct drm_device *dev, void *data,
1299 		   struct drm_file *file_priv);
1300 int	drm_switchctx(struct drm_device *dev, void *data,
1301 		      struct drm_file *file_priv);
1302 int	drm_newctx(struct drm_device *dev, void *data,
1303 		   struct drm_file *file_priv);
1304 int	drm_rmctx(struct drm_device *dev, void *data,
1305 		  struct drm_file *file_priv);
1306 int	drm_setsareactx(struct drm_device *dev, void *data,
1307 			struct drm_file *file_priv);
1308 int	drm_getsareactx(struct drm_device *dev, void *data,
1309 			struct drm_file *file_priv);
1310 
1311 /* Authentication IOCTL support (drm_auth.c) */
1312 int	drm_getmagic(struct drm_device *dev, void *data,
1313 		     struct drm_file *file_priv);
1314 int	drm_authmagic(struct drm_device *dev, void *data,
1315 		      struct drm_file *file_priv);
1316 
1317 /* Buffer management support (drm_bufs.c) */
1318 int	drm_addmap_ioctl(struct drm_device *dev, void *data,
1319 			 struct drm_file *file_priv);
1320 int	drm_rmmap_ioctl(struct drm_device *dev, void *data,
1321 			struct drm_file *file_priv);
1322 int	drm_addbufs(struct drm_device *dev, void *data,
1323 		    struct drm_file *file_priv);
1324 int	drm_infobufs(struct drm_device *dev, void *data,
1325 		     struct drm_file *file_priv);
1326 int	drm_markbufs(struct drm_device *dev, void *data,
1327 		     struct drm_file *file_priv);
1328 int	drm_freebufs(struct drm_device *dev, void *data,
1329 		     struct drm_file *file_priv);
1330 int	drm_mapbufs(struct drm_device *dev, void *data,
1331 		    struct drm_file *file_priv);
1332 
1333 /* DMA support (drm_dma.c) */
1334 int	drm_dma(struct drm_device *dev, void *data, struct drm_file *file_priv);
1335 
1336 /* IRQ support (drm_irq.c) */
1337 int	drm_control(struct drm_device *dev, void *data,
1338 		    struct drm_file *file_priv);
1339 
1340 /* AGP/GART support (drm_agpsupport.c) */
1341 int	drm_agp_acquire_ioctl(struct drm_device *dev, void *data,
1342 			      struct drm_file *file_priv);
1343 int	drm_agp_release_ioctl(struct drm_device *dev, void *data,
1344 			      struct drm_file *file_priv);
1345 int	drm_agp_enable_ioctl(struct drm_device *dev, void *data,
1346 			     struct drm_file *file_priv);
1347 int	drm_agp_info_ioctl(struct drm_device *dev, void *data,
1348 			   struct drm_file *file_priv);
1349 int	drm_agp_alloc_ioctl(struct drm_device *dev, void *data,
1350 			    struct drm_file *file_priv);
1351 int	drm_agp_free_ioctl(struct drm_device *dev, void *data,
1352 			   struct drm_file *file_priv);
1353 int	drm_agp_unbind_ioctl(struct drm_device *dev, void *data,
1354 			     struct drm_file *file_priv);
1355 int	drm_agp_bind_ioctl(struct drm_device *dev, void *data,
1356 			   struct drm_file *file_priv);
1357 
1358 				/* Stub support (drm_stub.h) */
1359 extern int drm_setmaster_ioctl(struct drm_device *dev, void *data,
1360 			       struct drm_file *file_priv);
1361 extern int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
1362 				struct drm_file *file_priv);
1363 
1364 /* Scatter Gather Support (drm_scatter.c) */
1365 int	drm_sg_alloc_ioctl(struct drm_device *dev, void *data,
1366 			   struct drm_file *file_priv);
1367 int	drm_sg_free(struct drm_device *dev, void *data,
1368 		    struct drm_file *file_priv);
1369 
1370 /* consistent PCI memory functions (drm_pci.c) */
1371 drm_dma_handle_t *drm_pci_alloc(struct drm_device *dev, size_t size,
1372 				size_t align, dma_addr_t maxaddr);
1373 void	drm_pci_free(struct drm_device *dev, drm_dma_handle_t *dmah);
1374 
1375 			       /* sysfs support (drm_sysfs.c) */
1376 extern char *drm_get_connector_status_name(enum drm_connector_status status);
1377 
1378 /* Graphics Execution Manager library functions (drm_gem.c) */
1379 int drm_gem_init(struct drm_device *dev);
1380 void drm_gem_destroy(struct drm_device *dev);
1381 void drm_gem_object_release(struct drm_gem_object *obj);
1382 void drm_gem_object_free(struct kref *kref);
1383 
1384 int drm_gem_close_ioctl(struct drm_device *dev, void *data,
1385 			struct drm_file *file_priv);
1386 int drm_gem_flink_ioctl(struct drm_device *dev, void *data,
1387 			struct drm_file *file_priv);
1388 int drm_gem_open_ioctl(struct drm_device *dev, void *data,
1389 		       struct drm_file *file_priv);
1390 void drm_gem_object_handle_free(struct drm_gem_object *obj);
1391 
1392 #include <drm/drm_global.h>
1393 
1394 static inline void
1395 drm_gem_object_reference(struct drm_gem_object *obj)
1396 {
1397 	kref_get(&obj->refcount);
1398 }
1399 
1400 static inline void
1401 drm_gem_object_unreference(struct drm_gem_object *obj)
1402 {
1403 	if (obj != NULL)
1404 		kref_put(&obj->refcount, drm_gem_object_free);
1405 }
1406 
1407 static inline void
1408 drm_gem_object_unreference_unlocked(struct drm_gem_object *obj)
1409 {
1410 	if (obj != NULL) {
1411 		struct drm_device *dev = obj->dev;
1412 		DRM_LOCK(dev);
1413 		kref_put(&obj->refcount, drm_gem_object_free);
1414 		DRM_UNLOCK(dev);
1415 	}
1416 }
1417 
1418 int drm_gem_handle_create(struct drm_file *file_priv,
1419 			  struct drm_gem_object *obj,
1420 			  u32 *handlep);
1421 int drm_gem_handle_delete(struct drm_file *filp, u32 handle);
1422 
1423 static inline void
1424 drm_gem_object_handle_reference(struct drm_gem_object *obj)
1425 {
1426 	drm_gem_object_reference(obj);
1427 	atomic_inc(&obj->handle_count);
1428 }
1429 
1430 static inline void
1431 drm_gem_object_handle_unreference(struct drm_gem_object *obj)
1432 {
1433 	if (obj == NULL)
1434 		return;
1435 
1436 	if (atomic_read(&obj->handle_count) == 0)
1437 		return;
1438 	/*
1439 	 * Must bump handle count first as this may be the last
1440 	 * ref, in which case the object would disappear before we
1441 	 * checked for a name
1442 	 */
1443 	if (atomic_dec_and_test(&obj->handle_count))
1444 		drm_gem_object_handle_free(obj);
1445 	drm_gem_object_unreference(obj);
1446 }
1447 
1448 static inline void
1449 drm_gem_object_handle_unreference_unlocked(struct drm_gem_object *obj)
1450 {
1451 	if (obj == NULL)
1452 		return;
1453 
1454 	if (atomic_read(&obj->handle_count) == 0)
1455 		return;
1456 
1457 	/*
1458 	* Must bump handle count first as this may be the last
1459 	* ref, in which case the object would disappear before we
1460 	* checked for a name
1461 	*/
1462 
1463 	if (atomic_dec_and_test(&obj->handle_count))
1464 		drm_gem_object_handle_free(obj);
1465 	drm_gem_object_unreference_unlocked(obj);
1466 }
1467 
1468 int drm_gem_object_init(struct drm_device *dev, struct drm_gem_object *obj,
1469     size_t size);
1470 int drm_gem_private_object_init(struct drm_device *dev,
1471     struct drm_gem_object *obj, size_t size);
1472 struct drm_gem_object *drm_gem_object_alloc(struct drm_device *dev,
1473     size_t size);
1474 struct drm_gem_object *drm_gem_object_lookup(struct drm_device *dev,
1475     struct drm_file *file_priv, uint32_t handle);
1476 
1477 void drm_gem_open(struct drm_device *dev, struct drm_file *file_priv);
1478 void drm_gem_release(struct drm_device *dev, struct drm_file *file_priv);
1479 
1480 int drm_gem_create_mmap_offset(struct drm_gem_object *obj);
1481 void drm_gem_free_mmap_offset(struct drm_gem_object *obj);
1482 int drm_gem_mmap_single(struct drm_device *dev, vm_ooffset_t *offset,
1483     vm_size_t size, struct vm_object **obj_res, int nprot);
1484 void drm_gem_pager_dtr(void *obj);
1485 
1486 struct ttm_bo_device;
1487 int ttm_bo_mmap_single(struct ttm_bo_device *bdev, vm_ooffset_t *offset,
1488     vm_size_t size, struct vm_object **obj_res, int nprot);
1489 struct ttm_buffer_object;
1490 void ttm_bo_release_mmap(struct ttm_buffer_object *bo);
1491 
1492 void drm_device_lock_mtx(struct drm_device *dev);
1493 void drm_device_unlock_mtx(struct drm_device *dev);
1494 int drm_device_sleep_mtx(struct drm_device *dev, void *chan, int flags,
1495     const char *msg, int timeout);
1496 void drm_device_assert_mtx_locked(struct drm_device *dev);
1497 void drm_device_assert_mtx_unlocked(struct drm_device *dev);
1498 
1499 void drm_device_lock_struct(struct drm_device *dev);
1500 void drm_device_unlock_struct(struct drm_device *dev);
1501 int drm_device_sleep_struct(struct drm_device *dev, void *chan, int flags,
1502     const char *msg, int timeout);
1503 void drm_device_assert_struct_locked(struct drm_device *dev);
1504 void drm_device_assert_struct_unlocked(struct drm_device *dev);
1505 
1506 void drm_compat_locking_init(struct drm_device *dev);
1507 void drm_sleep_locking_init(struct drm_device *dev);
1508 
1509 /* drm_modes.c */
1510 bool drm_mode_parse_command_line_for_connector(const char *mode_option,
1511     struct drm_connector *connector, struct drm_cmdline_mode *mode);
1512 struct drm_display_mode *drm_mode_create_from_cmdline_mode(
1513     struct drm_device *dev, struct drm_cmdline_mode *cmd);
1514 
1515 /* Inline replacements for drm_alloc and friends */
1516 static __inline__ void *
1517 drm_alloc(size_t size, struct malloc_type *area)
1518 {
1519 	return kmalloc(size, area, M_NOWAIT);
1520 }
1521 
1522 static __inline__ void *
1523 drm_calloc(size_t nmemb, size_t size, struct malloc_type *area)
1524 {
1525 	return kmalloc(size * nmemb, area, M_NOWAIT | M_ZERO);
1526 }
1527 
1528 static __inline__ void *
1529 drm_realloc(void *oldpt, size_t oldsize, size_t size,
1530     struct malloc_type *area)
1531 {
1532 	void *res;
1533 	res = krealloc(oldpt, size, area, M_NOWAIT);
1534 	if (res == NULL && oldpt != NULL)
1535 		kfree(oldpt,area);
1536 	return res;
1537 }
1538 
1539 static __inline__ void
1540 drm_free(void *pt, struct malloc_type *area)
1541 {
1542 	if (pt != NULL)
1543 		kfree(pt, area);
1544 }
1545 
1546 /* Inline replacements for DRM_IOREMAP macros */
1547 static __inline__ void
1548 drm_core_ioremap_wc(struct drm_local_map *map, struct drm_device *dev)
1549 {
1550 	map->handle = drm_ioremap_wc(dev, map);
1551 }
1552 static __inline__ void
1553 drm_core_ioremap(struct drm_local_map *map, struct drm_device *dev)
1554 {
1555 	map->handle = drm_ioremap(dev, map);
1556 }
1557 static __inline__ void
1558 drm_core_ioremapfree(struct drm_local_map *map, struct drm_device *dev)
1559 {
1560 	if ( map->handle && map->size )
1561 		drm_ioremapfree(map);
1562 }
1563 
1564 static __inline__ struct drm_local_map *
1565 drm_core_findmap(struct drm_device *dev, unsigned long offset)
1566 {
1567 	struct drm_map_list *_entry;
1568 
1569 	list_for_each_entry(_entry, &dev->maplist, head) {
1570 		if (offset == (unsigned long)_entry->map->handle)
1571 			return _entry->map;
1572 	}
1573 	return NULL;
1574 }
1575 
1576 static __inline__ void drm_core_dropmap(struct drm_map *map)
1577 {
1578 }
1579 
1580 #include <drm/drm_mem_util.h>
1581 
1582 /* FreeBSD compatibility macros */
1583 #define VM_OBJECT_WLOCK(object)		VM_OBJECT_LOCK(object)
1584 #define VM_OBJECT_WUNLOCK(object)	VM_OBJECT_UNLOCK(object)
1585 
1586 #define DRM_PCIE_SPEED_25 1
1587 #define DRM_PCIE_SPEED_50 2
1588 #define DRM_PCIE_SPEED_80 4
1589 
1590 extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
1591 
1592 #define	drm_can_sleep()	(DRM_HZ & 1)
1593 
1594 #endif /* __KERNEL__ */
1595 #endif /* _DRM_P_H_ */
1596