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