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