xref: /freebsd/sys/dev/drm2/drmP.h (revision 90aac0d83bc9645f51ef0c2aeae6f9c0540bb031)
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 #ifndef _DRM_P_H_
37 #define _DRM_P_H_
38 
39 #if defined(_KERNEL) || defined(__KERNEL__)
40 
41 #include <sys/param.h>
42 #include <sys/queue.h>
43 #include <sys/malloc.h>
44 #include <sys/kernel.h>
45 #include <sys/ktr.h>
46 #include <sys/module.h>
47 #include <sys/systm.h>
48 #include <sys/conf.h>
49 #include <sys/sglist.h>
50 #include <sys/stat.h>
51 #include <sys/priv.h>
52 #include <sys/proc.h>
53 #include <sys/limits.h>
54 #include <sys/lock.h>
55 #include <sys/fcntl.h>
56 #include <sys/uio.h>
57 #include <sys/filio.h>
58 #include <sys/rwlock.h>
59 #include <sys/selinfo.h>
60 #include <sys/sysctl.h>
61 #include <sys/bus.h>
62 #include <sys/queue.h>
63 #include <sys/signalvar.h>
64 #include <sys/poll.h>
65 #include <sys/sbuf.h>
66 #include <sys/taskqueue.h>
67 #include <sys/tree.h>
68 #include <sys/vmmeter.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/bus.h>
80 #include <machine/resource.h>
81 #if defined(__i386__) || defined(__amd64__)
82 #include <machine/specialreg.h>
83 #endif
84 #include <machine/sysarch.h>
85 #include <sys/endian.h>
86 #include <sys/mman.h>
87 #include <sys/rman.h>
88 #include <sys/memrange.h>
89 #include <dev/agp/agpvar.h>
90 #include <sys/agpio.h>
91 #include <sys/mutex.h>
92 #include <dev/pci/pcivar.h>
93 #include <dev/pci/pcireg.h>
94 #include <sys/selinfo.h>
95 #include <sys/bus.h>
96 
97 #include <dev/drm2/drm.h>
98 #include <dev/drm2/drm_sarea.h>
99 
100 #include <dev/drm2/drm_atomic.h>
101 #include <dev/drm2/drm_linux_list.h>
102 #include <dev/drm2/drm_gem_names.h>
103 
104 #include <dev/drm2/drm_os_freebsd.h>
105 
106 #if defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE))
107 #define __OS_HAS_AGP 1
108 #else
109 #define __OS_HAS_AGP 0
110 #endif
111 #if defined(CONFIG_MTRR)
112 #define __OS_HAS_MTRR 1
113 #else
114 #define __OS_HAS_MTRR 0
115 #endif
116 
117 struct drm_file;
118 struct drm_device;
119 
120 #include <dev/drm2/drm_hashtab.h>
121 #include <dev/drm2/drm_mm.h>
122 
123 #include "opt_drm.h"
124 #include "opt_syscons.h"
125 #ifdef DRM_DEBUG
126 #undef DRM_DEBUG
127 #define DRM_DEBUG_DEFAULT_ON 1
128 #endif /* DRM_DEBUG */
129 
130 #define	DRM_DEBUGBITS_DEBUG		0x1
131 #define	DRM_DEBUGBITS_KMS		0x2
132 #define	DRM_DEBUGBITS_FAILED_IOCTL	0x4
133 
134 #undef DRM_LINUX
135 #define DRM_LINUX 0
136 
137 /***********************************************************************/
138 /** \name DRM template customization defaults */
139 /*@{*/
140 
141 /* driver capabilities and requirements mask */
142 #define DRIVER_USE_AGP     0x1
143 #define DRIVER_REQUIRE_AGP 0x2
144 #define DRIVER_USE_MTRR    0x4
145 #define DRIVER_PCI_DMA     0x8
146 #define DRIVER_SG          0x10
147 #define DRIVER_HAVE_DMA    0x20
148 #define DRIVER_HAVE_IRQ    0x40
149 #define DRIVER_IRQ_SHARED  0x80
150 #define DRIVER_IRQ_VBL     0x100
151 #define DRIVER_DMA_QUEUE   0x200
152 #define DRIVER_FB_DMA      0x400
153 #define DRIVER_IRQ_VBL2    0x800
154 #define DRIVER_GEM         0x1000
155 #define DRIVER_MODESET     0x2000
156 #define DRIVER_PRIME       0x4000
157 
158 #define DRIVER_BUS_PCI 0x1
159 #define DRIVER_BUS_PLATFORM 0x2
160 #define DRIVER_BUS_USB 0x3
161 
162 /***********************************************************************/
163 /** \name Begin the DRM... */
164 /*@{*/
165 
166 #define DRM_DEBUG_CODE 2	  /**< Include debugging code if > 1, then
167 				     also include looping detection. */
168 
169 #define DRM_MAGIC_HASH_ORDER  4  /**< Size of key hash table. Must be power of 2. */
170 #define DRM_KERNEL_CONTEXT    0	 /**< Change drm_resctx if changed */
171 #define DRM_RESERVED_CONTEXTS 1	 /**< Change drm_resctx if changed */
172 #define DRM_LOOPING_LIMIT     5000000
173 #define DRM_TIME_SLICE	      (HZ/20)  /**< Time slice for GLXContexts */
174 #define DRM_LOCK_SLICE	      1	/**< Time slice for lock, in jiffies */
175 
176 #define DRM_FLAG_DEBUG	  0x01
177 
178 #define DRM_MAX_CTXBITMAP (PAGE_SIZE * 8)
179 #define DRM_MAP_HASH_OFFSET 0x10000000
180 
181 /*@}*/
182 
183 /***********************************************************************/
184 /** \name Macros to make printk easier */
185 /*@{*/
186 
187 /**
188  * Error output.
189  *
190  * \param fmt printf() like format string.
191  * \param arg arguments
192  */
193 #define DRM_ERROR(fmt, ...) \
194 	printf("error: [" DRM_NAME ":pid%d:%s] *ERROR* " fmt,		\
195 	    DRM_CURRENTPID, __func__ , ##__VA_ARGS__)
196 
197 #define DRM_WARNING(fmt, ...)  printf("warning: [" DRM_NAME "] " fmt , ##__VA_ARGS__)
198 #define DRM_INFO(fmt, ...)  printf("info: [" DRM_NAME "] " fmt , ##__VA_ARGS__)
199 
200 /**
201  * Debug output.
202  *
203  * \param fmt printf() like format string.
204  * \param arg arguments
205  */
206 #define DRM_DEBUG(fmt, ...) do {					\
207 	if ((drm_debug & DRM_DEBUGBITS_DEBUG) != 0)			\
208 		printf("[" DRM_NAME ":pid%d:%s] " fmt, DRM_CURRENTPID,	\
209 			__func__ , ##__VA_ARGS__);			\
210 } while (0)
211 
212 #define DRM_DEBUG_DRIVER(fmt, ...) do {					\
213 	if ((drm_debug & DRM_DEBUGBITS_KMS) != 0)			\
214 		printf("[" DRM_NAME ":KMS:pid%d:%s] " fmt, DRM_CURRENTPID,\
215 			__func__ , ##__VA_ARGS__);			\
216 } while (0)
217 
218 #define DRM_DEBUG_KMS(fmt, ...) do {					\
219 	if ((drm_debug & DRM_DEBUGBITS_KMS) != 0)			\
220 		printf("[" DRM_NAME ":KMS:pid%d:%s] " fmt, DRM_CURRENTPID,\
221 			__func__ , ##__VA_ARGS__);			\
222 } while (0)
223 
224 #define DRM_LOG(fmt, ...) do {						\
225 	if ((drm_debug & DRM_DEBUGBITS_KMS) != 0)			\
226 		printf("[" DRM_NAME "]:pid%d:%s]" fmt, DRM_CURRENTPID,	\
227 			__func__ , ##__VA_ARGS__);			\
228 } while (0)
229 
230 #define DRM_LOG_KMS(fmt, ...) do {					\
231 	if ((drm_debug & DRM_DEBUGBITS_KMS) != 0)			\
232 		printf("[" DRM_NAME "]:KMS:pid%d:%s]" fmt, DRM_CURRENTPID,\
233 			__func__ , ##__VA_ARGS__);			\
234 } while (0)
235 
236 #define DRM_LOG_MODE(fmt, ...) do {					\
237 	if ((drm_debug & DRM_DEBUGBITS_KMS) != 0)			\
238 		printf("[" DRM_NAME "]:pid%d:%s]" fmt, DRM_CURRENTPID,	\
239 			__func__ , ##__VA_ARGS__);			\
240 } while (0)
241 
242 #define DRM_LOG_DRIVER(fmt, ...) do {					\
243 	if ((drm_debug & DRM_DEBUGBITS_KMS) != 0)			\
244 		printf("[" DRM_NAME "]:KMS:pid%d:%s]" fmt, DRM_CURRENTPID,\
245 			__func__ , ##__VA_ARGS__);			\
246 } while (0)
247 
248 /*@}*/
249 
250 /***********************************************************************/
251 /** \name Internal types and structures */
252 /*@{*/
253 
254 #define DRM_ARRAY_SIZE(x) ARRAY_SIZE(x)
255 
256 #define DRM_LEFTCOUNT(x) (((x)->rp + (x)->count - (x)->wp) % ((x)->count + 1))
257 #define DRM_BUFCOUNT(x) ((x)->count - DRM_LEFTCOUNT(x))
258 
259 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
260 
261 /**
262  * Test that the hardware lock is held by the caller, returning otherwise.
263  *
264  * \param dev DRM device.
265  * \param filp file pointer of the caller.
266  */
267 #define LOCK_TEST_WITH_RETURN( dev, _file_priv )				\
268 do {										\
269 	if (!_DRM_LOCK_IS_HELD(_file_priv->master->lock.hw_lock->lock) ||	\
270 	    _file_priv->master->lock.file_priv != _file_priv)	{		\
271 		DRM_ERROR( "%s called without lock held, held  %d owner %p %p\n",\
272 			   __func__, _DRM_LOCK_IS_HELD(_file_priv->master->lock.hw_lock->lock),\
273 			   _file_priv->master->lock.file_priv, _file_priv);	\
274 		return -EINVAL;							\
275 	}									\
276 } while (0)
277 
278 /**
279  * Ioctl function type.
280  *
281  * \param inode device inode.
282  * \param file_priv DRM file private pointer.
283  * \param cmd command.
284  * \param arg argument.
285  */
286 typedef int drm_ioctl_t(struct drm_device *dev, void *data,
287 			struct drm_file *file_priv);
288 
289 #define DRM_IOCTL_NR(n)                ((n) & 0xff)
290 #define DRM_MAJOR       226
291 
292 #define DRM_AUTH	0x1
293 #define	DRM_MASTER	0x2
294 #define DRM_ROOT_ONLY	0x4
295 #define DRM_CONTROL_ALLOW 0x8
296 #define DRM_UNLOCKED	0x10
297 
298 struct drm_ioctl_desc {
299 	unsigned long cmd;
300 	int flags;
301 	drm_ioctl_t *func;
302 	unsigned int cmd_drv;
303 };
304 
305 /**
306  * Creates a driver or general drm_ioctl_desc array entry for the given
307  * ioctl, for use by drm_ioctl().
308  */
309 
310 #define DRM_IOCTL_DEF(ioctl, _func, _flags) \
311 	[DRM_IOCTL_NR(ioctl)] = {.cmd = ioctl, .func = _func, .flags = _flags, .cmd_drv = 0}
312 
313 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags)			\
314 	[DRM_IOCTL_NR(DRM_##ioctl)] = {.cmd = DRM_##ioctl, .func = _func, .flags = _flags, .cmd_drv = DRM_IOCTL_##ioctl}
315 
316 struct drm_magic_entry {
317 	struct list_head head;
318 	struct drm_hash_item hash_item;
319 	struct drm_file *priv;
320 };
321 
322 /**
323  * DMA buffer.
324  */
325 struct drm_buf {
326 	int idx;		       /**< Index into master buflist */
327 	int total;		       /**< Buffer size */
328 	int order;		       /**< log-base-2(total) */
329 	int used;		       /**< Amount of buffer in use (for DMA) */
330 	unsigned long offset;	       /**< Byte offset (used internally) */
331 	void *address;		       /**< Address of buffer */
332 	unsigned long bus_address;     /**< Bus address of buffer */
333 	struct drm_buf *next;	       /**< Kernel-only: used for free list */
334 	__volatile__ int waiting;      /**< On kernel DMA queue */
335 	__volatile__ int pending;      /**< On hardware DMA queue */
336 	struct drm_file *file_priv;    /**< Private of holding file descr */
337 	int context;		       /**< Kernel queue for this buffer */
338 	int while_locked;	       /**< Dispatch this buffer while locked */
339 	enum {
340 		DRM_LIST_NONE = 0,
341 		DRM_LIST_FREE = 1,
342 		DRM_LIST_WAIT = 2,
343 		DRM_LIST_PEND = 3,
344 		DRM_LIST_PRIO = 4,
345 		DRM_LIST_RECLAIM = 5
346 	} list;			       /**< Which list we're on */
347 
348 	int dev_priv_size;		 /**< Size of buffer private storage */
349 	void *dev_private;		 /**< Per-buffer private storage */
350 };
351 
352 struct drm_freelist {
353 	int initialized;	       /**< Freelist in use */
354 	atomic_t count;		       /**< Number of free buffers */
355 	struct drm_buf *next;	       /**< End pointer */
356 
357 #ifdef FREEBSD_NOTYET
358 	wait_queue_head_t waiting;     /**< Processes waiting on free bufs */
359 #endif /* defined(FREEBSD_NOTYET) */
360 	int low_mark;		       /**< Low water mark */
361 	int high_mark;		       /**< High water mark */
362 #ifdef FREEBSD_NOTYET
363 	atomic_t wfh;		       /**< If waiting for high mark */
364 	spinlock_t lock;
365 #endif /* defined(FREEBSD_NOTYET) */
366 };
367 
368 typedef struct drm_dma_handle {
369 	void *vaddr;
370 	bus_addr_t busaddr;
371 	bus_dma_tag_t tag;
372 	bus_dmamap_t map;
373 } drm_dma_handle_t;
374 
375 /**
376  * Buffer entry.  There is one of this for each buffer size order.
377  */
378 struct drm_buf_entry {
379 	int buf_size;			/**< size */
380 	int buf_count;			/**< number of buffers */
381 	struct drm_buf *buflist;		/**< buffer list */
382 	int seg_count;
383 	int page_order;
384 	struct drm_dma_handle **seglist;
385 
386 	struct drm_freelist freelist;
387 };
388 
389 /* Event queued up for userspace to read */
390 struct drm_pending_event {
391 	struct drm_event *event;
392 	struct list_head link;
393 	struct drm_file *file_priv;
394 	pid_t pid; /* pid of requester, no guarantee it's valid by the time
395 		      we deliver the event, for tracing only */
396 	void (*destroy)(struct drm_pending_event *event);
397 };
398 
399 /* initial implementaton using a linked list - todo hashtab */
400 struct drm_prime_file_private {
401 	struct list_head head;
402 	struct mtx lock;
403 };
404 
405 struct drm_file {
406 	int authenticated;
407 	pid_t pid;
408 	uid_t uid;
409 	drm_magic_t magic;
410 	unsigned long ioctl_count;
411 	struct list_head lhead;
412 	struct drm_minor *minor;
413 	unsigned long lock_count;
414 
415 	void *driver_priv;
416 	struct drm_gem_names object_names;
417 
418 	int is_master; /* this file private is a master for a minor */
419 	struct drm_master *master; /* master this node is currently associated with
420 				      N.B. not always minor->master */
421 	struct list_head fbs;
422 
423 	struct selinfo event_poll;
424 	struct list_head event_list;
425 	int event_space;
426 
427 	struct drm_prime_file_private prime;
428 };
429 
430 /**
431  * Lock data.
432  */
433 struct drm_lock_data {
434 	struct drm_hw_lock *hw_lock;	/**< Hardware lock */
435 	/** Private of lock holder's file (NULL=kernel) */
436 	struct drm_file *file_priv;
437 	wait_queue_head_t lock_queue;	/**< Queue of blocked processes */
438 	unsigned long lock_time;	/**< Time of last lock in jiffies */
439 	struct mtx spinlock;
440 	uint32_t kernel_waiters;
441 	uint32_t user_waiters;
442 	int idle_has_lock;
443 };
444 
445 /**
446  * DMA data.
447  */
448 struct drm_device_dma {
449 
450 	struct drm_buf_entry bufs[DRM_MAX_ORDER + 1];	/**< buffers, grouped by their size order */
451 	int buf_count;			/**< total number of buffers */
452 	struct drm_buf **buflist;		/**< Vector of pointers into drm_device_dma::bufs */
453 	int seg_count;
454 	int page_count;			/**< number of pages */
455 	unsigned long *pagelist;	/**< page list */
456 	unsigned long byte_count;
457 	enum {
458 		_DRM_DMA_USE_AGP = 0x01,
459 		_DRM_DMA_USE_SG = 0x02,
460 		_DRM_DMA_USE_FB = 0x04,
461 		_DRM_DMA_USE_PCI_RO = 0x08
462 	} flags;
463 
464 };
465 
466 /**
467  * AGP memory entry.  Stored as a doubly linked list.
468  */
469 struct drm_agp_mem {
470 	unsigned long handle;		/**< handle */
471 	DRM_AGP_MEM *memory;
472 	unsigned long bound;		/**< address */
473 	int pages;
474 	struct list_head head;
475 };
476 
477 /**
478  * AGP data.
479  *
480  * \sa drm_agp_init() and drm_device::agp.
481  */
482 struct drm_agp_head {
483 	DRM_AGP_KERN agp_info;		/**< AGP device information */
484 	struct list_head memory;
485 	unsigned long mode;		/**< AGP mode */
486 	device_t bridge;
487 	int enabled;			/**< whether the AGP bus as been enabled */
488 	int acquired;			/**< whether the AGP device has been acquired */
489 	unsigned long base;
490 	int agp_mtrr;
491 	int cant_use_aperture;
492 };
493 
494 /**
495  * Scatter-gather memory.
496  */
497 struct drm_sg_mem {
498 	void *vaddr;
499 	vm_paddr_t *busaddr;
500 	vm_pindex_t pages;
501 };
502 
503 struct drm_sigdata {
504 	int context;
505 	struct drm_hw_lock *lock;
506 };
507 
508 /**
509  * Kernel side of a mapping
510  */
511 #define DRM_MAP_HANDLE_BITS	(sizeof(void *) == 4 ? 4 : 24)
512 #define DRM_MAP_HANDLE_SHIFT	(sizeof(void *) * 8 - DRM_MAP_HANDLE_BITS)
513 
514 struct drm_local_map {
515 	resource_size_t offset;	 /**< Requested physical address (0 for SAREA)*/
516 	unsigned long size;	 /**< Requested physical size (bytes) */
517 	enum drm_map_type type;	 /**< Type of memory to map */
518 	enum drm_map_flags flags;	 /**< Flags */
519 	void *handle;		 /**< User-space: "Handle" to pass to mmap() */
520 				 /**< Kernel-space: kernel-virtual address */
521 	int mtrr;		 /**< MTRR slot used */
522 
523 				  /* Private data                         */
524 	drm_dma_handle_t *dmah;
525 };
526 
527 typedef struct drm_local_map drm_local_map_t;
528 
529 /**
530  * Mappings list
531  */
532 struct drm_map_list {
533 	struct list_head head;		/**< list head */
534 	struct drm_hash_item hash;
535 	struct drm_local_map *map;	/**< mapping */
536 	uint64_t user_token;
537 	struct drm_master *master;
538 	struct drm_mm_node *file_offset_node;	/**< fake offset */
539 };
540 
541 /**
542  * Context handle list
543  */
544 struct drm_ctx_list {
545 	struct list_head head;		/**< list head */
546 	drm_context_t handle;		/**< context handle */
547 	struct drm_file *tag;		/**< associated fd private data */
548 };
549 
550 /* location of GART table */
551 #define DRM_ATI_GART_MAIN 1
552 #define DRM_ATI_GART_FB   2
553 
554 #define DRM_ATI_GART_PCI 1
555 #define DRM_ATI_GART_PCIE 2
556 #define DRM_ATI_GART_IGP 3
557 
558 struct drm_ati_pcigart_info {
559 	int gart_table_location;
560 	int gart_reg_if;
561 	void *addr;
562 	dma_addr_t bus_addr;
563 	dma_addr_t table_mask;
564 	struct drm_dma_handle *table_handle;
565 	struct drm_local_map mapping;
566 	int table_size;
567 	struct drm_dma_handle *dmah; /* handle for ATI PCIGART table FIXME */
568 };
569 
570 /**
571  * GEM specific mm private for tracking GEM objects
572  */
573 struct drm_gem_mm {
574 	struct unrhdr *idxunr;
575 	struct drm_open_hash offset_hash; /**< User token hash table for maps */
576 };
577 
578 /**
579  * This structure defines the drm_mm memory object, which will be used by the
580  * DRM for its buffer objects.
581  */
582 struct drm_gem_object {
583 	/** Reference count of this object */
584 	u_int refcount;
585 
586 	/** Handle count of this object. Each handle also holds a reference */
587 	atomic_t handle_count; /* number of handles on this object */
588 
589 	/** Related drm device */
590 	struct drm_device *dev;
591 
592 	/** File representing the shmem storage: filp in Linux parlance */
593 	vm_object_t vm_obj;
594 
595 	/* Mapping info for this object */
596 	bool on_map;
597 	struct drm_hash_item map_list;
598 
599 	/**
600 	 * Size of the object, in bytes.  Immutable over the object's
601 	 * lifetime.
602 	 */
603 	size_t size;
604 
605 	/**
606 	 * Global name for this object, starts at 1. 0 means unnamed.
607 	 * Access is covered by the object_name_lock in the related drm_device
608 	 */
609 	int name;
610 
611 	/**
612 	 * Memory domains. These monitor which caches contain read/write data
613 	 * related to the object. When transitioning from one set of domains
614 	 * to another, the driver is called to ensure that caches are suitably
615 	 * flushed and invalidated
616 	 */
617 	uint32_t read_domains;
618 	uint32_t write_domain;
619 
620 	/**
621 	 * While validating an exec operation, the
622 	 * new read/write domain values are computed here.
623 	 * They will be transferred to the above values
624 	 * at the point that any cache flushing occurs
625 	 */
626 	uint32_t pending_read_domains;
627 	uint32_t pending_write_domain;
628 
629 	void *driver_private;
630 
631 #ifdef FREEBSD_NOTYET
632 	/* dma buf exported from this GEM object */
633 	struct dma_buf *export_dma_buf;
634 
635 	/* dma buf attachment backing this object */
636 	struct dma_buf_attachment *import_attach;
637 #endif /* FREEBSD_NOTYET */
638 };
639 
640 #include <dev/drm2/drm_crtc.h>
641 
642 /* per-master structure */
643 struct drm_master {
644 
645 	u_int refcount; /* refcount for this master */
646 
647 	struct list_head head; /**< each minor contains a list of masters */
648 	struct drm_minor *minor; /**< link back to minor we are a master for */
649 
650 	char *unique;			/**< Unique identifier: e.g., busid */
651 	int unique_len;			/**< Length of unique field */
652 	int unique_size;		/**< amount allocated */
653 
654 	int blocked;			/**< Blocked due to VC switch? */
655 
656 	/** \name Authentication */
657 	/*@{ */
658 	struct drm_open_hash magiclist;
659 	struct list_head magicfree;
660 	/*@} */
661 
662 	struct drm_lock_data lock;	/**< Information on hardware lock */
663 
664 	void *driver_priv; /**< Private structure for driver to use */
665 };
666 
667 /* Size of ringbuffer for vblank timestamps. Just double-buffer
668  * in initial implementation.
669  */
670 #define DRM_VBLANKTIME_RBSIZE 2
671 
672 /* Flags and return codes for get_vblank_timestamp() driver function. */
673 #define DRM_CALLED_FROM_VBLIRQ 1
674 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
675 #define DRM_VBLANKTIME_INVBL             (1 << 1)
676 
677 /* get_scanout_position() return flags */
678 #define DRM_SCANOUTPOS_VALID        (1 << 0)
679 #define DRM_SCANOUTPOS_INVBL        (1 << 1)
680 #define DRM_SCANOUTPOS_ACCURATE     (1 << 2)
681 
682 struct drm_bus {
683 	int bus_type;
684 	int (*get_irq)(struct drm_device *dev);
685 	void (*free_irq)(struct drm_device *dev);
686 	const char *(*get_name)(struct drm_device *dev);
687 	int (*set_busid)(struct drm_device *dev, struct drm_master *master);
688 	int (*set_unique)(struct drm_device *dev, struct drm_master *master,
689 			  struct drm_unique *unique);
690 	int (*irq_by_busid)(struct drm_device *dev, struct drm_irq_busid *p);
691 	/* hooks that are for PCI */
692 	int (*agp_init)(struct drm_device *dev);
693 
694 };
695 
696 /**
697  * DRM driver structure. This structure represent the common code for
698  * a family of cards. There will one drm_device for each card present
699  * in this family
700  */
701 struct drm_driver {
702 	int (*load) (struct drm_device *, unsigned long flags);
703 	int (*firstopen) (struct drm_device *);
704 	int (*open) (struct drm_device *, struct drm_file *);
705 	void (*preclose) (struct drm_device *, struct drm_file *file_priv);
706 	void (*postclose) (struct drm_device *, struct drm_file *);
707 	void (*lastclose) (struct drm_device *);
708 	int (*unload) (struct drm_device *);
709 	int (*suspend) (struct drm_device *, pm_message_t state);
710 	int (*resume) (struct drm_device *);
711 	int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
712 	int (*dma_quiescent) (struct drm_device *);
713 	int (*context_dtor) (struct drm_device *dev, int context);
714 
715 	/**
716 	 * get_vblank_counter - get raw hardware vblank counter
717 	 * @dev: DRM device
718 	 * @crtc: counter to fetch
719 	 *
720 	 * Driver callback for fetching a raw hardware vblank counter for @crtc.
721 	 * If a device doesn't have a hardware counter, the driver can simply
722 	 * return the value of drm_vblank_count. The DRM core will account for
723 	 * missed vblank events while interrupts where disabled based on system
724 	 * timestamps.
725 	 *
726 	 * Wraparound handling and loss of events due to modesetting is dealt
727 	 * with in the DRM core code.
728 	 *
729 	 * RETURNS
730 	 * Raw vblank counter value.
731 	 */
732 	u32 (*get_vblank_counter) (struct drm_device *dev, int crtc);
733 
734 	/**
735 	 * enable_vblank - enable vblank interrupt events
736 	 * @dev: DRM device
737 	 * @crtc: which irq to enable
738 	 *
739 	 * Enable vblank interrupts for @crtc.  If the device doesn't have
740 	 * a hardware vblank counter, this routine should be a no-op, since
741 	 * interrupts will have to stay on to keep the count accurate.
742 	 *
743 	 * RETURNS
744 	 * Zero on success, appropriate errno if the given @crtc's vblank
745 	 * interrupt cannot be enabled.
746 	 */
747 	int (*enable_vblank) (struct drm_device *dev, int crtc);
748 
749 	/**
750 	 * disable_vblank - disable vblank interrupt events
751 	 * @dev: DRM device
752 	 * @crtc: which irq to enable
753 	 *
754 	 * Disable vblank interrupts for @crtc.  If the device doesn't have
755 	 * a hardware vblank counter, this routine should be a no-op, since
756 	 * interrupts will have to stay on to keep the count accurate.
757 	 */
758 	void (*disable_vblank) (struct drm_device *dev, int crtc);
759 
760 	/**
761 	 * Called by \c drm_device_is_agp.  Typically used to determine if a
762 	 * card is really attached to AGP or not.
763 	 *
764 	 * \param dev  DRM device handle
765 	 *
766 	 * \returns
767 	 * One of three values is returned depending on whether or not the
768 	 * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
769 	 * (return of 1), or may or may not be AGP (return of 2).
770 	 */
771 	int (*device_is_agp) (struct drm_device *dev);
772 
773 	/**
774 	 * Called by vblank timestamping code.
775 	 *
776 	 * Return the current display scanout position from a crtc.
777 	 *
778 	 * \param dev  DRM device.
779 	 * \param crtc Id of the crtc to query.
780 	 * \param *vpos Target location for current vertical scanout position.
781 	 * \param *hpos Target location for current horizontal scanout position.
782 	 *
783 	 * Returns vpos as a positive number while in active scanout area.
784 	 * Returns vpos as a negative number inside vblank, counting the number
785 	 * of scanlines to go until end of vblank, e.g., -1 means "one scanline
786 	 * until start of active scanout / end of vblank."
787 	 *
788 	 * \return Flags, or'ed together as follows:
789 	 *
790 	 * DRM_SCANOUTPOS_VALID = Query successful.
791 	 * DRM_SCANOUTPOS_INVBL = Inside vblank.
792 	 * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
793 	 * this flag means that returned position may be offset by a constant
794 	 * but unknown small number of scanlines wrt. real scanout position.
795 	 *
796 	 */
797 	int (*get_scanout_position) (struct drm_device *dev, int crtc,
798 				     int *vpos, int *hpos);
799 
800 	/**
801 	 * Called by \c drm_get_last_vbltimestamp. Should return a precise
802 	 * timestamp when the most recent VBLANK interval ended or will end.
803 	 *
804 	 * Specifically, the timestamp in @vblank_time should correspond as
805 	 * closely as possible to the time when the first video scanline of
806 	 * the video frame after the end of VBLANK will start scanning out,
807 	 * the time immediately after end of the VBLANK interval. If the
808 	 * @crtc is currently inside VBLANK, this will be a time in the future.
809 	 * If the @crtc is currently scanning out a frame, this will be the
810 	 * past start time of the current scanout. This is meant to adhere
811 	 * to the OpenML OML_sync_control extension specification.
812 	 *
813 	 * \param dev dev DRM device handle.
814 	 * \param crtc crtc for which timestamp should be returned.
815 	 * \param *max_error Maximum allowable timestamp error in nanoseconds.
816 	 *                   Implementation should strive to provide timestamp
817 	 *                   with an error of at most *max_error nanoseconds.
818 	 *                   Returns true upper bound on error for timestamp.
819 	 * \param *vblank_time Target location for returned vblank timestamp.
820 	 * \param flags 0 = Defaults, no special treatment needed.
821 	 * \param       DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
822 	 *	        irq handler. Some drivers need to apply some workarounds
823 	 *              for gpu-specific vblank irq quirks if flag is set.
824 	 *
825 	 * \returns
826 	 * Zero if timestamping isn't supported in current display mode or a
827 	 * negative number on failure. A positive status code on success,
828 	 * which describes how the vblank_time timestamp was computed.
829 	 */
830 	int (*get_vblank_timestamp) (struct drm_device *dev, int crtc,
831 				     int *max_error,
832 				     struct timeval *vblank_time,
833 				     unsigned flags);
834 
835 	/* these have to be filled in */
836 
837 	irqreturn_t(*irq_handler) (DRM_IRQ_ARGS);
838 	void (*irq_preinstall) (struct drm_device *dev);
839 	int (*irq_postinstall) (struct drm_device *dev);
840 	void (*irq_uninstall) (struct drm_device *dev);
841 	void (*set_version) (struct drm_device *dev,
842 			     struct drm_set_version *sv);
843 
844 	/* Master routines */
845 	int (*master_create)(struct drm_device *dev, struct drm_master *master);
846 	void (*master_destroy)(struct drm_device *dev, struct drm_master *master);
847 	/**
848 	 * master_set is called whenever the minor master is set.
849 	 * master_drop is called whenever the minor master is dropped.
850 	 */
851 
852 	int (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
853 			  bool from_open);
854 	void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv,
855 			    bool from_release);
856 
857 	/**
858 	 * Driver-specific constructor for drm_gem_objects, to set up
859 	 * obj->driver_private.
860 	 *
861 	 * Returns 0 on success.
862 	 */
863 	int (*gem_init_object) (struct drm_gem_object *obj);
864 	void (*gem_free_object) (struct drm_gem_object *obj);
865 	int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
866 	void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
867 
868 #ifdef FREEBSD_NOTYET
869 	/* prime: */
870 	/* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */
871 	int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
872 				uint32_t handle, uint32_t flags, int *prime_fd);
873 	/* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */
874 	int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
875 				int prime_fd, uint32_t *handle);
876 	/* export GEM -> dmabuf */
877 	struct dma_buf * (*gem_prime_export)(struct drm_device *dev,
878 				struct drm_gem_object *obj, int flags);
879 	/* import dmabuf -> GEM */
880 	struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
881 				struct dma_buf *dma_buf);
882 #endif /* defined(FREEBSD_NOTYET) */
883 
884 	/* dumb alloc support */
885 	int (*dumb_create)(struct drm_file *file_priv,
886 			   struct drm_device *dev,
887 			   struct drm_mode_create_dumb *args);
888 	int (*dumb_map_offset)(struct drm_file *file_priv,
889 			       struct drm_device *dev, uint32_t handle,
890 			       uint64_t *offset);
891 	int (*dumb_destroy)(struct drm_file *file_priv,
892 			    struct drm_device *dev,
893 			    uint32_t handle);
894 
895 	/* Driver private ops for this object */
896 	struct cdev_pager_ops *gem_pager_ops;
897 
898 	int	(*sysctl_init)(struct drm_device *dev,
899 		    struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
900 	void	(*sysctl_cleanup)(struct drm_device *dev);
901 
902 	int major;
903 	int minor;
904 	int patchlevel;
905 	char *name;
906 	char *desc;
907 	char *date;
908 
909 	u32 driver_features;
910 	int dev_priv_size;
911 	struct drm_ioctl_desc *ioctls;
912 	int num_ioctls;
913 	struct drm_bus *bus;
914 #ifdef COMPAT_FREEBSD32
915 	struct drm_ioctl_desc *compat_ioctls;
916 	int *num_compat_ioctls;
917 #endif
918 
919 	int	buf_priv_size;
920 };
921 
922 #define DRM_MINOR_UNASSIGNED 0
923 #define DRM_MINOR_LEGACY 1
924 #define DRM_MINOR_CONTROL 2
925 #define DRM_MINOR_RENDER 3
926 
927 /**
928  * DRM minor structure. This structure represents a drm minor number.
929  */
930 struct drm_minor {
931 	int index;			/**< Minor device number */
932 	int type;                       /**< Control or render */
933 	struct cdev *device;		/**< Device number for mknod */
934 	device_t kdev;			/**< OS device */
935 	struct drm_device *dev;
936 
937 	struct drm_master *master; /* currently active master for this node */
938 	struct list_head master_list;
939 	struct drm_mode_group mode_group;
940 
941 	struct sigio *buf_sigio;	/* Processes waiting for SIGIO     */
942 };
943 
944 /* mode specified on the command line */
945 struct drm_cmdline_mode {
946 	bool specified;
947 	bool refresh_specified;
948 	bool bpp_specified;
949 	int xres, yres;
950 	int bpp;
951 	int refresh;
952 	bool rb;
953 	bool interlace;
954 	bool cvt;
955 	bool margins;
956 	enum drm_connector_force force;
957 };
958 
959 
960 struct drm_pending_vblank_event {
961 	struct drm_pending_event base;
962 	int pipe;
963 	struct drm_event_vblank event;
964 };
965 
966 /**
967  * DRM device structure. This structure represent a complete card that
968  * may contain multiple heads.
969  */
970 struct drm_device {
971 	int if_version;			/**< Highest interface version set */
972 
973 	/** \name Locks */
974 	/*@{ */
975 	struct mtx count_lock;		/**< For inuse, drm_device::open_count, drm_device::buf_use */
976 	struct sx dev_struct_lock;	/**< For others */
977 	/*@} */
978 
979 	/** \name Usage Counters */
980 	/*@{ */
981 	int open_count;			/**< Outstanding files open */
982 	atomic_t ioctl_count;		/**< Outstanding IOCTLs pending */
983 	atomic_t vma_count;		/**< Outstanding vma areas open */
984 	int buf_use;			/**< Buffers in use -- cannot alloc */
985 	atomic_t buf_alloc;		/**< Buffer allocation in progress */
986 	/*@} */
987 
988 	/** \name Performance counters */
989 	/*@{ */
990 	unsigned long counters;
991 	enum drm_stat_type types[15];
992 	atomic_t counts[15];
993 	/*@} */
994 
995 	struct list_head filelist;
996 
997 	/** \name Memory management */
998 	/*@{ */
999 	struct list_head maplist;	/**< Linked list of regions */
1000 	int map_count;			/**< Number of mappable regions */
1001 	struct drm_open_hash map_hash;	/**< User token hash table for maps */
1002 
1003 	/** \name Context handle management */
1004 	/*@{ */
1005 	struct list_head ctxlist;	/**< Linked list of context handles */
1006 	int ctx_count;			/**< Number of context handles */
1007 	struct mtx ctxlist_mutex;	/**< For ctxlist */
1008 	drm_local_map_t **context_sareas;
1009 	int max_context;
1010 	unsigned long *ctx_bitmap;
1011 
1012 	/*@} */
1013 
1014 	/** \name DMA support */
1015 	/*@{ */
1016 	struct drm_device_dma *dma;		/**< Optional pointer for DMA support */
1017 	/*@} */
1018 
1019 	/** \name Context support */
1020 	/*@{ */
1021 	int irq_enabled;		/**< True if irq handler is enabled */
1022 	atomic_t context_flag;		/**< Context swapping flag */
1023 	atomic_t interrupt_flag;	/**< Interruption handler flag */
1024 	atomic_t dma_flag;		/**< DMA dispatch flag */
1025 	wait_queue_head_t context_wait;	/**< Processes waiting on ctx switch */
1026 	int last_checked;		/**< Last context checked for DMA */
1027 	int last_context;		/**< Last current context */
1028 	unsigned long last_switch;	/**< jiffies at last context switch */
1029 	/*@} */
1030 
1031 	/** \name VBLANK IRQ support */
1032 	/*@{ */
1033 
1034 	/*
1035 	 * At load time, disabling the vblank interrupt won't be allowed since
1036 	 * old clients may not call the modeset ioctl and therefore misbehave.
1037 	 * Once the modeset ioctl *has* been called though, we can safely
1038 	 * disable them when unused.
1039 	 */
1040 	int vblank_disable_allowed;
1041 
1042 	atomic_t *_vblank_count;        /**< number of VBLANK interrupts (driver must alloc the right number of counters) */
1043 	struct timeval *_vblank_time;   /**< timestamp of current vblank_count (drivers must alloc right number of fields) */
1044 	struct mtx vblank_time_lock;    /**< Protects vblank count and time updates during vblank enable/disable */
1045 	struct mtx vbl_lock;
1046 	atomic_t *vblank_refcount;      /* number of users of vblank interruptsper crtc */
1047 	u32 *last_vblank;               /* protected by dev->vbl_lock, used */
1048 					/* for wraparound handling */
1049 	int *vblank_enabled;            /* so we don't call enable more than
1050 					   once per disable */
1051 	int *vblank_inmodeset;          /* Display driver is setting mode */
1052 	u32 *last_vblank_wait;		/* Last vblank seqno waited per CRTC */
1053 	struct callout vblank_disable_callout;
1054 
1055 	u32 max_vblank_count;           /**< size of vblank counter register */
1056 
1057 	/**
1058 	 * List of events
1059 	 */
1060 	struct list_head vblank_event_list;
1061 	struct mtx event_lock;
1062 
1063 	/*@} */
1064 
1065 	struct drm_agp_head *agp;	/**< AGP data */
1066 
1067 	device_t dev;			/* Device instance from newbus */
1068 	uint16_t pci_device;		/* PCI device id */
1069 	uint16_t pci_vendor;		/* PCI vendor id */
1070 	uint16_t pci_subdevice;		/* PCI subsystem device id */
1071 	uint16_t pci_subvendor;		/* PCI subsystem vendor id */
1072 
1073 	struct drm_sg_mem *sg;	/**< Scatter gather memory */
1074 	unsigned int num_crtcs;                  /**< Number of CRTCs on this device */
1075 	void *dev_private;		/**< device private data */
1076 	void *mm_private;
1077 	struct drm_sigdata sigdata;	   /**< For block_all_signals */
1078 	sigset_t sigmask;
1079 
1080 	struct drm_driver *driver;
1081 	struct drm_local_map *agp_buffer_map;
1082 	unsigned int agp_buffer_token;
1083 	struct drm_minor *control;		/**< Control node for card */
1084 	struct drm_minor *primary;		/**< render type primary screen head */
1085 
1086         struct drm_mode_config mode_config;	/**< Current mode config */
1087 
1088 	/** \name GEM information */
1089 	/*@{ */
1090 	struct sx object_name_lock;
1091 	struct drm_gem_names object_names;
1092 	/*@} */
1093 	int switch_power_state;
1094 
1095 	atomic_t unplugged; /* device has been unplugged or gone away */
1096 
1097 				/* Locks */
1098 	struct mtx	  dma_lock;	/* protects dev->dma */
1099 	struct mtx	  irq_lock;	/* protects irq condition checks */
1100 
1101 				/* Context support */
1102 	int		  irq;		/* Interrupt used by board	   */
1103 	int		  msi_enabled;	/* MSI enabled */
1104 	int		  irqrid;	/* Interrupt used by board */
1105 	struct resource   *irqr;	/* Resource for interrupt used by board	   */
1106 	void		  *irqh;	/* Handle from bus_setup_intr      */
1107 
1108 	/* Storage of resource pointers for drm_get_resource_* */
1109 #define	DRM_MAX_PCI_RESOURCE	6
1110 	struct resource   *pcir[DRM_MAX_PCI_RESOURCE];
1111 	int		  pcirid[DRM_MAX_PCI_RESOURCE];
1112 	struct mtx	  pcir_lock;
1113 
1114 	int		  pci_domain;
1115 	int		  pci_bus;
1116 	int		  pci_slot;
1117 	int		  pci_func;
1118 
1119 				/* Sysctl support */
1120 	struct drm_sysctl_info *sysctl;
1121 	int		  sysctl_node_idx;
1122 
1123 	void		  *drm_ttm_bdev;
1124 
1125 	void *sysctl_private;
1126 	char busid_str[128];
1127 	int modesetting;
1128 
1129 	const drm_pci_id_list_t *id_entry;	/* PCI ID, name, and chipset private */
1130 };
1131 
1132 #define DRM_SWITCH_POWER_ON 0
1133 #define DRM_SWITCH_POWER_OFF 1
1134 #define DRM_SWITCH_POWER_CHANGING 2
1135 
1136 static __inline__ int drm_core_check_feature(struct drm_device *dev,
1137 					     int feature)
1138 {
1139 	return ((dev->driver->driver_features & feature) ? 1 : 0);
1140 }
1141 
1142 static inline int drm_dev_to_irq(struct drm_device *dev)
1143 {
1144 	return dev->driver->bus->get_irq(dev);
1145 }
1146 
1147 
1148 #if __OS_HAS_AGP
1149 static inline int drm_core_has_AGP(struct drm_device *dev)
1150 {
1151 	return drm_core_check_feature(dev, DRIVER_USE_AGP);
1152 }
1153 #else
1154 #define drm_core_has_AGP(dev) (0)
1155 #endif
1156 
1157 #if __OS_HAS_MTRR
1158 static inline int drm_core_has_MTRR(struct drm_device *dev)
1159 {
1160 	return drm_core_check_feature(dev, DRIVER_USE_MTRR);
1161 }
1162 
1163 #define DRM_MTRR_WC		MDF_WRITECOMBINE
1164 
1165 int drm_mtrr_add(unsigned long offset, unsigned long size, unsigned int flags);
1166 int drm_mtrr_del(int handle, unsigned long offset, unsigned long size, unsigned int flags);
1167 
1168 #else
1169 #define drm_core_has_MTRR(dev) (0)
1170 
1171 #define DRM_MTRR_WC		0
1172 
1173 static inline int drm_mtrr_add(unsigned long offset, unsigned long size,
1174 			       unsigned int flags)
1175 {
1176 	return 0;
1177 }
1178 
1179 static inline int drm_mtrr_del(int handle, unsigned long offset,
1180 			       unsigned long size, unsigned int flags)
1181 {
1182 	return 0;
1183 }
1184 #endif
1185 
1186 /******************************************************************/
1187 /** \name Internal function definitions */
1188 /*@{*/
1189 
1190 				/* Driver support (drm_drv.h) */
1191 d_ioctl_t drm_ioctl;
1192 extern int drm_lastclose(struct drm_device *dev);
1193 
1194 				/* Device support (drm_fops.h) */
1195 extern struct sx drm_global_mutex;
1196 d_open_t drm_open;
1197 d_read_t drm_read;
1198 extern void drm_release(void *data);
1199 
1200 				/* Mapping support (drm_vm.h) */
1201 d_mmap_t drm_mmap;
1202 int	drm_mmap_single(struct cdev *kdev, vm_ooffset_t *offset,
1203 	    vm_size_t size, struct vm_object **obj_res, int nprot);
1204 d_poll_t drm_poll;
1205 
1206 
1207 				/* Misc. IOCTL support (drm_ioctl.h) */
1208 extern int drm_irq_by_busid(struct drm_device *dev, void *data,
1209 			    struct drm_file *file_priv);
1210 extern int drm_getunique(struct drm_device *dev, void *data,
1211 			 struct drm_file *file_priv);
1212 extern int drm_setunique(struct drm_device *dev, void *data,
1213 			 struct drm_file *file_priv);
1214 extern int drm_getmap(struct drm_device *dev, void *data,
1215 		      struct drm_file *file_priv);
1216 extern int drm_getclient(struct drm_device *dev, void *data,
1217 			 struct drm_file *file_priv);
1218 extern int drm_getstats(struct drm_device *dev, void *data,
1219 			struct drm_file *file_priv);
1220 extern int drm_getcap(struct drm_device *dev, void *data,
1221 		      struct drm_file *file_priv);
1222 extern int drm_setversion(struct drm_device *dev, void *data,
1223 			  struct drm_file *file_priv);
1224 extern int drm_noop(struct drm_device *dev, void *data,
1225 		    struct drm_file *file_priv);
1226 
1227 				/* Context IOCTL support (drm_context.h) */
1228 extern int drm_resctx(struct drm_device *dev, void *data,
1229 		      struct drm_file *file_priv);
1230 extern int drm_addctx(struct drm_device *dev, void *data,
1231 		      struct drm_file *file_priv);
1232 extern int drm_modctx(struct drm_device *dev, void *data,
1233 		      struct drm_file *file_priv);
1234 extern int drm_getctx(struct drm_device *dev, void *data,
1235 		      struct drm_file *file_priv);
1236 extern int drm_switchctx(struct drm_device *dev, void *data,
1237 			 struct drm_file *file_priv);
1238 extern int drm_newctx(struct drm_device *dev, void *data,
1239 		      struct drm_file *file_priv);
1240 extern int drm_rmctx(struct drm_device *dev, void *data,
1241 		     struct drm_file *file_priv);
1242 
1243 extern int drm_ctxbitmap_init(struct drm_device *dev);
1244 extern void drm_ctxbitmap_cleanup(struct drm_device *dev);
1245 extern void drm_ctxbitmap_free(struct drm_device *dev, int ctx_handle);
1246 
1247 extern int drm_setsareactx(struct drm_device *dev, void *data,
1248 			   struct drm_file *file_priv);
1249 extern int drm_getsareactx(struct drm_device *dev, void *data,
1250 			   struct drm_file *file_priv);
1251 
1252 				/* Authentication IOCTL support (drm_auth.h) */
1253 extern int drm_getmagic(struct drm_device *dev, void *data,
1254 			struct drm_file *file_priv);
1255 extern int drm_authmagic(struct drm_device *dev, void *data,
1256 			 struct drm_file *file_priv);
1257 extern int drm_remove_magic(struct drm_master *master, drm_magic_t magic);
1258 
1259 /* Cache management (drm_cache.c) */
1260 void drm_clflush_pages(vm_page_t *pages, unsigned long num_pages);
1261 void drm_clflush_virt_range(char *addr, unsigned long length);
1262 
1263 				/* Locking IOCTL support (drm_lock.h) */
1264 extern int drm_lock(struct drm_device *dev, void *data,
1265 		    struct drm_file *file_priv);
1266 extern int drm_unlock(struct drm_device *dev, void *data,
1267 		      struct drm_file *file_priv);
1268 extern int drm_lock_free(struct drm_lock_data *lock_data, unsigned int context);
1269 extern void drm_idlelock_take(struct drm_lock_data *lock_data);
1270 extern void drm_idlelock_release(struct drm_lock_data *lock_data);
1271 
1272 /*
1273  * These are exported to drivers so that they can implement fencing using
1274  * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
1275  */
1276 
1277 extern int drm_i_have_hw_lock(struct drm_device *dev, struct drm_file *file_priv);
1278 
1279 				/* Buffer management support (drm_bufs.h) */
1280 extern int drm_addbufs_agp(struct drm_device *dev, struct drm_buf_desc * request);
1281 extern int drm_addbufs_pci(struct drm_device *dev, struct drm_buf_desc * request);
1282 extern int drm_addmap(struct drm_device *dev, resource_size_t offset,
1283 		      unsigned int size, enum drm_map_type type,
1284 		      enum drm_map_flags flags, struct drm_local_map **map_ptr);
1285 extern int drm_addmap_ioctl(struct drm_device *dev, void *data,
1286 			    struct drm_file *file_priv);
1287 extern int drm_rmmap(struct drm_device *dev, struct drm_local_map *map);
1288 extern int drm_rmmap_locked(struct drm_device *dev, struct drm_local_map *map);
1289 extern int drm_rmmap_ioctl(struct drm_device *dev, void *data,
1290 			   struct drm_file *file_priv);
1291 extern int drm_addbufs(struct drm_device *dev, void *data,
1292 		       struct drm_file *file_priv);
1293 extern int drm_infobufs(struct drm_device *dev, void *data,
1294 			struct drm_file *file_priv);
1295 extern int drm_markbufs(struct drm_device *dev, void *data,
1296 			struct drm_file *file_priv);
1297 extern int drm_freebufs(struct drm_device *dev, void *data,
1298 			struct drm_file *file_priv);
1299 extern int drm_mapbufs(struct drm_device *dev, void *data,
1300 		       struct drm_file *file_priv);
1301 extern int drm_order(unsigned long size);
1302 
1303 				/* DMA support (drm_dma.h) */
1304 extern int drm_dma_setup(struct drm_device *dev);
1305 extern void drm_dma_takedown(struct drm_device *dev);
1306 extern void drm_free_buffer(struct drm_device *dev, struct drm_buf * buf);
1307 extern void drm_core_reclaim_buffers(struct drm_device *dev,
1308 				     struct drm_file *filp);
1309 
1310 				/* IRQ support (drm_irq.h) */
1311 extern int drm_control(struct drm_device *dev, void *data,
1312 		       struct drm_file *file_priv);
1313 extern int drm_irq_install(struct drm_device *dev);
1314 extern int drm_irq_uninstall(struct drm_device *dev);
1315 
1316 extern int drm_vblank_init(struct drm_device *dev, int num_crtcs);
1317 extern int drm_wait_vblank(struct drm_device *dev, void *data,
1318 			   struct drm_file *filp);
1319 extern int drm_vblank_wait(struct drm_device *dev, unsigned int *vbl_seq);
1320 extern u32 drm_vblank_count(struct drm_device *dev, int crtc);
1321 extern u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
1322 				     struct timeval *vblanktime);
1323 extern void drm_send_vblank_event(struct drm_device *dev, int crtc,
1324 				     struct drm_pending_vblank_event *e);
1325 extern bool drm_handle_vblank(struct drm_device *dev, int crtc);
1326 extern int drm_vblank_get(struct drm_device *dev, int crtc);
1327 extern void drm_vblank_put(struct drm_device *dev, int crtc);
1328 extern void drm_vblank_off(struct drm_device *dev, int crtc);
1329 extern void drm_vblank_cleanup(struct drm_device *dev);
1330 extern u32 drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
1331 				     struct timeval *tvblank, unsigned flags);
1332 extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
1333 						 int crtc, int *max_error,
1334 						 struct timeval *vblank_time,
1335 						 unsigned flags,
1336 						 struct drm_crtc *refcrtc);
1337 extern void drm_calc_timestamping_constants(struct drm_crtc *crtc);
1338 
1339 extern bool
1340 drm_mode_parse_command_line_for_connector(const char *mode_option,
1341 					  struct drm_connector *connector,
1342 					  struct drm_cmdline_mode *mode);
1343 
1344 extern struct drm_display_mode *
1345 drm_mode_create_from_cmdline_mode(struct drm_device *dev,
1346 				  struct drm_cmdline_mode *cmd);
1347 
1348 /* Modesetting support */
1349 extern void drm_vblank_pre_modeset(struct drm_device *dev, int crtc);
1350 extern void drm_vblank_post_modeset(struct drm_device *dev, int crtc);
1351 extern int drm_modeset_ctl(struct drm_device *dev, void *data,
1352 			   struct drm_file *file_priv);
1353 
1354 
1355 				/* Stub support (drm_stub.h) */
1356 extern int drm_setmaster_ioctl(struct drm_device *dev, void *data,
1357 			       struct drm_file *file_priv);
1358 extern int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
1359 				struct drm_file *file_priv);
1360 struct drm_master *drm_master_create(struct drm_minor *minor);
1361 extern struct drm_master *drm_master_get(struct drm_master *master);
1362 extern void drm_master_put(struct drm_master **master);
1363 
1364 extern void drm_put_dev(struct drm_device *dev);
1365 extern int drm_put_minor(struct drm_minor **minor);
1366 extern void drm_unplug_dev(struct drm_device *dev);
1367 extern unsigned int drm_debug;
1368 extern unsigned int drm_notyet;
1369 
1370 extern unsigned int drm_vblank_offdelay;
1371 extern unsigned int drm_timestamp_precision;
1372 extern unsigned int drm_timestamp_monotonic;
1373 
1374 extern struct drm_local_map *drm_getsarea(struct drm_device *dev);
1375 
1376 
1377 #ifdef FREEBSD_NOTYET
1378 extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
1379 		struct drm_file *file_priv, uint32_t handle, uint32_t flags,
1380 		int *prime_fd);
1381 extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
1382 		struct drm_file *file_priv, int prime_fd, uint32_t *handle);
1383 
1384 extern int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data,
1385 					struct drm_file *file_priv);
1386 extern int drm_prime_fd_to_handle_ioctl(struct drm_device *dev, void *data,
1387 					struct drm_file *file_priv);
1388 
1389 extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, vm_page_t *pages,
1390 					    dma_addr_t *addrs, int max_pages);
1391 extern struct sg_table *drm_prime_pages_to_sg(vm_page_t *pages, int nr_pages);
1392 extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
1393 
1394 
1395 void drm_prime_init_file_private(struct drm_prime_file_private *prime_fpriv);
1396 void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv);
1397 int drm_prime_add_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf, uint32_t handle);
1398 int drm_prime_lookup_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf, uint32_t *handle);
1399 void drm_prime_remove_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf);
1400 
1401 int drm_prime_add_dma_buf(struct drm_device *dev, struct drm_gem_object *obj);
1402 int drm_prime_lookup_obj(struct drm_device *dev, struct dma_buf *buf,
1403 			 struct drm_gem_object **obj);
1404 #endif /* FREEBSD_NOTYET */
1405 
1406 				/* Scatter Gather Support (drm_scatter.h) */
1407 extern void drm_sg_cleanup(struct drm_sg_mem * entry);
1408 extern int drm_sg_alloc_ioctl(struct drm_device *dev, void *data,
1409 			struct drm_file *file_priv);
1410 extern int drm_sg_alloc(struct drm_device *dev, struct drm_scatter_gather * request);
1411 extern int drm_sg_free(struct drm_device *dev, void *data,
1412 		       struct drm_file *file_priv);
1413 
1414 			       /* ATI PCIGART support (ati_pcigart.h) */
1415 extern int drm_ati_pcigart_init(struct drm_device *dev,
1416 				struct drm_ati_pcigart_info * gart_info);
1417 extern int drm_ati_pcigart_cleanup(struct drm_device *dev,
1418 				   struct drm_ati_pcigart_info * gart_info);
1419 
1420 extern drm_dma_handle_t *drm_pci_alloc(struct drm_device *dev, size_t size,
1421 				       size_t align, dma_addr_t maxaddr);
1422 extern void __drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
1423 extern void drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
1424 
1425 /* Graphics Execution Manager library functions (drm_gem.c) */
1426 int drm_gem_init(struct drm_device *dev);
1427 void drm_gem_destroy(struct drm_device *dev);
1428 void drm_gem_object_release(struct drm_gem_object *obj);
1429 void drm_gem_object_free(struct drm_gem_object *obj);
1430 struct drm_gem_object *drm_gem_object_alloc(struct drm_device *dev,
1431 					    size_t size);
1432 int drm_gem_object_init(struct drm_device *dev,
1433 			struct drm_gem_object *obj, size_t size);
1434 int drm_gem_private_object_init(struct drm_device *dev,
1435 			struct drm_gem_object *obj, size_t size);
1436 void drm_gem_object_handle_free(struct drm_gem_object *obj);
1437 int drm_gem_mmap_single(struct drm_device *dev, vm_ooffset_t *offset,
1438     vm_size_t size, struct vm_object **obj_res, int nprot);
1439 void drm_gem_pager_dtr(void *obj);
1440 
1441 #include <dev/drm2/drm_global.h>
1442 
1443 static inline void
1444 drm_gem_object_reference(struct drm_gem_object *obj)
1445 {
1446 
1447 	KASSERT(obj->refcount > 0, ("Dangling obj %p", obj));
1448 	refcount_acquire(&obj->refcount);
1449 }
1450 
1451 static inline void
1452 drm_gem_object_unreference(struct drm_gem_object *obj)
1453 {
1454 
1455 	if (obj == NULL)
1456 		return;
1457 	if (refcount_release(&obj->refcount))
1458 		drm_gem_object_free(obj);
1459 }
1460 
1461 static inline void
1462 drm_gem_object_unreference_unlocked(struct drm_gem_object *obj)
1463 {
1464 	if (obj != NULL) {
1465 		struct drm_device *dev = obj->dev;
1466 		DRM_LOCK(dev);
1467 		drm_gem_object_unreference(obj);
1468 		DRM_UNLOCK(dev);
1469 	}
1470 }
1471 
1472 int drm_gem_handle_create(struct drm_file *file_priv,
1473 			  struct drm_gem_object *obj,
1474 			  u32 *handlep);
1475 int drm_gem_handle_delete(struct drm_file *filp, u32 handle);
1476 
1477 static inline void
1478 drm_gem_object_handle_reference(struct drm_gem_object *obj)
1479 {
1480 	drm_gem_object_reference(obj);
1481 	atomic_inc(&obj->handle_count);
1482 }
1483 
1484 static inline void
1485 drm_gem_object_handle_unreference(struct drm_gem_object *obj)
1486 {
1487 	if (obj == NULL)
1488 		return;
1489 
1490 	if (atomic_read(&obj->handle_count) == 0)
1491 		return;
1492 	/*
1493 	 * Must bump handle count first as this may be the last
1494 	 * ref, in which case the object would disappear before we
1495 	 * checked for a name
1496 	 */
1497 	if (atomic_dec_and_test(&obj->handle_count))
1498 		drm_gem_object_handle_free(obj);
1499 	drm_gem_object_unreference(obj);
1500 }
1501 
1502 static inline void
1503 drm_gem_object_handle_unreference_unlocked(struct drm_gem_object *obj)
1504 {
1505 	if (obj == NULL)
1506 		return;
1507 
1508 	if (atomic_read(&obj->handle_count) == 0)
1509 		return;
1510 
1511 	/*
1512 	* Must bump handle count first as this may be the last
1513 	* ref, in which case the object would disappear before we
1514 	* checked for a name
1515 	*/
1516 
1517 	if (atomic_dec_and_test(&obj->handle_count))
1518 		drm_gem_object_handle_free(obj);
1519 	drm_gem_object_unreference_unlocked(obj);
1520 }
1521 
1522 void drm_gem_free_mmap_offset(struct drm_gem_object *obj);
1523 int drm_gem_create_mmap_offset(struct drm_gem_object *obj);
1524 
1525 struct drm_gem_object *drm_gem_object_lookup(struct drm_device *dev,
1526 					     struct drm_file *filp,
1527 					     u32 handle);
1528 int drm_gem_close_ioctl(struct drm_device *dev, void *data,
1529 			struct drm_file *file_priv);
1530 int drm_gem_flink_ioctl(struct drm_device *dev, void *data,
1531 			struct drm_file *file_priv);
1532 int drm_gem_open_ioctl(struct drm_device *dev, void *data,
1533 		       struct drm_file *file_priv);
1534 void drm_gem_open(struct drm_device *dev, struct drm_file *file_private);
1535 void drm_gem_release(struct drm_device *dev, struct drm_file *file_private);
1536 
1537 extern void drm_core_ioremap(struct drm_local_map *map, struct drm_device *dev);
1538 extern void drm_core_ioremap_wc(struct drm_local_map *map, struct drm_device *dev);
1539 extern void drm_core_ioremapfree(struct drm_local_map *map, struct drm_device *dev);
1540 
1541 static __inline__ struct drm_local_map *drm_core_findmap(struct drm_device *dev,
1542 							 unsigned int token)
1543 {
1544 	struct drm_map_list *_entry;
1545 	list_for_each_entry(_entry, &dev->maplist, head)
1546 	    if (_entry->user_token == token)
1547 		return _entry->map;
1548 	return NULL;
1549 }
1550 
1551 static __inline__ void drm_core_dropmap(struct drm_local_map *map)
1552 {
1553 }
1554 
1555 #include <dev/drm2/drm_mem_util.h>
1556 
1557 extern int drm_fill_in_dev(struct drm_device *dev,
1558 			   struct drm_driver *driver);
1559 extern void drm_cancel_fill_in_dev(struct drm_device *dev);
1560 int drm_get_minor(struct drm_device *dev, struct drm_minor **minor, int type);
1561 /*@}*/
1562 
1563 /* PCI section */
1564 int drm_pci_device_is_agp(struct drm_device *dev);
1565 int drm_pci_device_is_pcie(struct drm_device *dev);
1566 
1567 extern int drm_get_pci_dev(device_t kdev, struct drm_device *dev,
1568 			   struct drm_driver *driver);
1569 
1570 #define DRM_PCIE_SPEED_25 1
1571 #define DRM_PCIE_SPEED_50 2
1572 #define DRM_PCIE_SPEED_80 4
1573 
1574 extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
1575 
1576 #define	drm_can_sleep()	(DRM_HZ & 1)
1577 
1578 /* Platform section */
1579 int drm_get_platform_dev(device_t kdev, struct drm_device *dev,
1580 			 struct drm_driver *driver);
1581 
1582 /* FreeBSD specific -- should be moved to drm_os_freebsd.h */
1583 
1584 #define	DRM_GEM_MAPPING_MASK	(3ULL << 62)
1585 #define	DRM_GEM_MAPPING_KEY	(2ULL << 62) /* Non-canonical address form */
1586 #define	DRM_GEM_MAX_IDX		0x3fffff
1587 #define	DRM_GEM_MAPPING_IDX(o)	(((o) >> 40) & DRM_GEM_MAX_IDX)
1588 #define	DRM_GEM_MAPPING_OFF(i)	(((uint64_t)(i)) << 40)
1589 #define	DRM_GEM_MAPPING_MAPOFF(o) \
1590     ((o) & ~(DRM_GEM_MAPPING_OFF(DRM_GEM_MAX_IDX) | DRM_GEM_MAPPING_KEY))
1591 
1592 SYSCTL_DECL(_hw_drm);
1593 
1594 #define DRM_DEV_MODE	(S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP)
1595 #define DRM_DEV_UID	UID_ROOT
1596 #define DRM_DEV_GID	GID_VIDEO
1597 
1598 #define DRM_WAKEUP(w)		wakeup((void *)w)
1599 #define DRM_WAKEUP_INT(w)	wakeup(w)
1600 #define DRM_INIT_WAITQUEUE(queue) do {(void)(queue);} while (0)
1601 
1602 #define DRM_CURPROC		curthread
1603 #define DRM_STRUCTPROC		struct thread
1604 #define DRM_SPINTYPE		struct mtx
1605 #define DRM_SPININIT(l,name)	mtx_init(l, name, NULL, MTX_DEF)
1606 #define DRM_SPINUNINIT(l)	mtx_destroy(l)
1607 #define DRM_SPINLOCK(l)		mtx_lock(l)
1608 #define DRM_SPINUNLOCK(u)	mtx_unlock(u)
1609 #define DRM_SPINLOCK_IRQSAVE(l, irqflags) do {		\
1610 	mtx_lock(l);					\
1611 	(void)irqflags;					\
1612 } while (0)
1613 #define DRM_SPINUNLOCK_IRQRESTORE(u, irqflags) mtx_unlock(u)
1614 #define DRM_SPINLOCK_ASSERT(l)	mtx_assert(l, MA_OWNED)
1615 #define	DRM_LOCK_SLEEP(dev, chan, flags, msg, timeout)			\
1616     (sx_sleep((chan), &(dev)->dev_struct_lock, (flags), (msg), (timeout)))
1617 #if defined(INVARIANTS)
1618 #define	DRM_LOCK_ASSERT(dev)	sx_assert(&(dev)->dev_struct_lock, SA_XLOCKED)
1619 #define	DRM_UNLOCK_ASSERT(dev)	sx_assert(&(dev)->dev_struct_lock, SA_UNLOCKED)
1620 #else
1621 #define	DRM_LOCK_ASSERT(d)
1622 #define	DRM_UNLOCK_ASSERT(d)
1623 #endif
1624 
1625 #define DRM_SYSCTL_HANDLER_ARGS	(SYSCTL_HANDLER_ARGS)
1626 
1627 enum {
1628 	DRM_IS_NOT_AGP,
1629 	DRM_IS_AGP,
1630 	DRM_MIGHT_BE_AGP
1631 };
1632 
1633 #define DRM_VERIFYAREA_READ( uaddr, size )		\
1634 	(!useracc(__DECONST(caddr_t, uaddr), size, VM_PROT_READ))
1635 
1636 #define DRM_COPY_TO_USER(user, kern, size) \
1637 	copyout(kern, user, size)
1638 #define DRM_COPY_FROM_USER(kern, user, size) \
1639 	copyin(user, kern, size)
1640 #define DRM_COPY_FROM_USER_UNCHECKED(arg1, arg2, arg3) 	\
1641 	copyin(arg2, arg1, arg3)
1642 #define DRM_COPY_TO_USER_UNCHECKED(arg1, arg2, arg3)	\
1643 	copyout(arg2, arg1, arg3)
1644 #define DRM_GET_USER_UNCHECKED(val, uaddr)		\
1645 	((val) = fuword32(uaddr), 0)
1646 
1647 #define DRM_GET_PRIV_SAREA(_dev, _ctx, _map) do {	\
1648 	(_map) = (_dev)->context_sareas[_ctx];		\
1649 } while(0)
1650 
1651 /* Returns -errno to shared code */
1652 #define DRM_WAIT_ON( ret, queue, timeout, condition )		\
1653 for ( ret = 0 ; !ret && !(condition) ; ) {			\
1654 	DRM_UNLOCK(dev);					\
1655 	mtx_lock(&dev->irq_lock);				\
1656 	if (!(condition))					\
1657 	    ret = -mtx_sleep(&(queue), &dev->irq_lock, 		\
1658 		PCATCH, "drmwtq", (timeout));			\
1659 	    if (ret == -ERESTART)				\
1660 	        ret = -ERESTARTSYS;				\
1661 	mtx_unlock(&dev->irq_lock);				\
1662 	DRM_LOCK(dev);						\
1663 }
1664 
1665 #define	dev_err(dev, fmt, ...)						\
1666 	device_printf((dev), "error: " fmt, ## __VA_ARGS__)
1667 #define	dev_warn(dev, fmt, ...)						\
1668 	device_printf((dev), "warning: " fmt, ## __VA_ARGS__)
1669 #define	dev_info(dev, fmt, ...)						\
1670 	device_printf((dev), "info: " fmt, ## __VA_ARGS__)
1671 #define	dev_dbg(dev, fmt, ...) do {					\
1672 	if ((drm_debug& DRM_DEBUGBITS_KMS) != 0) {			\
1673 		device_printf((dev), "debug: " fmt, ## __VA_ARGS__);	\
1674 	}								\
1675 } while (0)
1676 
1677 struct drm_msi_blacklist_entry
1678 {
1679 	int vendor;
1680 	int device;
1681 };
1682 
1683 struct drm_vblank_info {
1684 	wait_queue_head_t queue;	/* vblank wait queue */
1685 	atomic_t count;			/* number of VBLANK interrupts */
1686 					/* (driver must alloc the right number of counters) */
1687 	atomic_t refcount;		/* number of users of vblank interrupts */
1688 	u32 last;			/* protected by dev->vbl_lock, used */
1689 					/* for wraparound handling */
1690 	int enabled;			/* so we don't call enable more than */
1691 					/* once per disable */
1692 	int inmodeset;			/* Display driver is setting mode */
1693 };
1694 
1695 #ifndef DMA_BIT_MASK
1696 #define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : (1ULL<<(n)) - 1)
1697 #endif
1698 
1699 #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
1700 
1701 enum dmi_field {
1702         DMI_NONE,
1703         DMI_BIOS_VENDOR,
1704         DMI_BIOS_VERSION,
1705         DMI_BIOS_DATE,
1706         DMI_SYS_VENDOR,
1707         DMI_PRODUCT_NAME,
1708         DMI_PRODUCT_VERSION,
1709         DMI_PRODUCT_SERIAL,
1710         DMI_PRODUCT_UUID,
1711         DMI_BOARD_VENDOR,
1712         DMI_BOARD_NAME,
1713         DMI_BOARD_VERSION,
1714         DMI_BOARD_SERIAL,
1715         DMI_BOARD_ASSET_TAG,
1716         DMI_CHASSIS_VENDOR,
1717         DMI_CHASSIS_TYPE,
1718         DMI_CHASSIS_VERSION,
1719         DMI_CHASSIS_SERIAL,
1720         DMI_CHASSIS_ASSET_TAG,
1721         DMI_STRING_MAX,
1722 };
1723 
1724 struct dmi_strmatch {
1725 	unsigned char slot;
1726 	char substr[79];
1727 };
1728 
1729 struct dmi_system_id {
1730         int (*callback)(const struct dmi_system_id *);
1731         const char *ident;
1732         struct dmi_strmatch matches[4];
1733 };
1734 #define	DMI_MATCH(a, b) {(a), (b)}
1735 bool dmi_check_system(const struct dmi_system_id *);
1736 
1737 /* Device setup support (drm_drv.c) */
1738 int	drm_probe_helper(device_t kdev, const drm_pci_id_list_t *idlist);
1739 int	drm_attach_helper(device_t kdev, const drm_pci_id_list_t *idlist,
1740 	    struct drm_driver *driver);
1741 int	drm_generic_suspend(device_t kdev);
1742 int	drm_generic_resume(device_t kdev);
1743 int	drm_generic_detach(device_t kdev);
1744 
1745 void drm_event_wakeup(struct drm_pending_event *e);
1746 
1747 int drm_add_busid_modesetting(struct drm_device *dev,
1748     struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
1749 
1750 /* Buffer management support (drm_bufs.c) */
1751 unsigned long drm_get_resource_start(struct drm_device *dev,
1752 				     unsigned int resource);
1753 unsigned long drm_get_resource_len(struct drm_device *dev,
1754 				   unsigned int resource);
1755 
1756 /* IRQ support (drm_irq.c) */
1757 irqreturn_t drm_irq_handler(DRM_IRQ_ARGS);
1758 void	drm_driver_irq_preinstall(struct drm_device *dev);
1759 void	drm_driver_irq_postinstall(struct drm_device *dev);
1760 void	drm_driver_irq_uninstall(struct drm_device *dev);
1761 
1762 /* sysctl support (drm_sysctl.h) */
1763 extern int		drm_sysctl_init(struct drm_device *dev);
1764 extern int		drm_sysctl_cleanup(struct drm_device *dev);
1765 
1766 int	drm_version(struct drm_device *dev, void *data,
1767 		    struct drm_file *file_priv);
1768 
1769 /* consistent PCI memory functions (drm_pci.c) */
1770 int	drm_pci_set_busid(struct drm_device *dev, struct drm_master *master);
1771 int	drm_pci_set_unique(struct drm_device *dev, struct drm_master *master,
1772 	    struct drm_unique *u);
1773 int	drm_pci_agp_init(struct drm_device *dev);
1774 int	drm_pci_enable_msi(struct drm_device *dev);
1775 void	drm_pci_disable_msi(struct drm_device *dev);
1776 
1777 struct ttm_bo_device;
1778 int ttm_bo_mmap_single(struct ttm_bo_device *bdev, vm_ooffset_t *offset,
1779     vm_size_t size, struct vm_object **obj_res, int nprot);
1780 struct ttm_buffer_object;
1781 void ttm_bo_release_mmap(struct ttm_buffer_object *bo);
1782 
1783 #if  __OS_HAS_AGP
1784 				/* Memory management support (drm_memory.h) */
1785 extern void drm_free_agp(DRM_AGP_MEM * handle, int pages);
1786 extern int drm_bind_agp(DRM_AGP_MEM * handle, unsigned int start);
1787 #ifdef FREEBSD_NOTYET
1788 extern DRM_AGP_MEM *drm_agp_bind_pages(struct drm_device *dev,
1789 				       struct page **pages,
1790 				       unsigned long num_pages,
1791 				       uint32_t gtt_offset,
1792 				       uint32_t type);
1793 #endif /* FREEBSD_NOTYET */
1794 extern int drm_unbind_agp(DRM_AGP_MEM * handle);
1795 
1796 				/* AGP/GART support (drm_agpsupport.h) */
1797 extern struct drm_agp_head *drm_agp_init(struct drm_device *dev);
1798 extern int drm_agp_acquire(struct drm_device *dev);
1799 extern int drm_agp_acquire_ioctl(struct drm_device *dev, void *data,
1800 				 struct drm_file *file_priv);
1801 extern int drm_agp_release(struct drm_device *dev);
1802 extern int drm_agp_release_ioctl(struct drm_device *dev, void *data,
1803 				 struct drm_file *file_priv);
1804 extern int drm_agp_enable(struct drm_device *dev, struct drm_agp_mode mode);
1805 extern int drm_agp_enable_ioctl(struct drm_device *dev, void *data,
1806 				struct drm_file *file_priv);
1807 extern int drm_agp_info(struct drm_device *dev, struct drm_agp_info *info);
1808 extern int drm_agp_info_ioctl(struct drm_device *dev, void *data,
1809 			struct drm_file *file_priv);
1810 extern int drm_agp_alloc(struct drm_device *dev, struct drm_agp_buffer *request);
1811 extern int drm_agp_alloc_ioctl(struct drm_device *dev, void *data,
1812 			 struct drm_file *file_priv);
1813 extern int drm_agp_free(struct drm_device *dev, struct drm_agp_buffer *request);
1814 extern int drm_agp_free_ioctl(struct drm_device *dev, void *data,
1815 			struct drm_file *file_priv);
1816 extern int drm_agp_unbind(struct drm_device *dev, struct drm_agp_binding *request);
1817 extern int drm_agp_unbind_ioctl(struct drm_device *dev, void *data,
1818 			  struct drm_file *file_priv);
1819 extern int drm_agp_bind(struct drm_device *dev, struct drm_agp_binding *request);
1820 extern int drm_agp_bind_ioctl(struct drm_device *dev, void *data,
1821 			struct drm_file *file_priv);
1822 
1823 #else
1824 
1825 static inline void drm_free_agp(DRM_AGP_MEM * handle, int pages)
1826 {
1827 }
1828 
1829 static inline int drm_bind_agp(DRM_AGP_MEM * handle, unsigned int start)
1830 {
1831 	return -ENODEV;
1832 }
1833 
1834 static inline int drm_unbind_agp(DRM_AGP_MEM * handle)
1835 {
1836 	return -ENODEV;
1837 }
1838 #ifdef FREEBSD_NOTYET
1839 static inline struct agp_memory *drm_agp_bind_pages(struct drm_device *dev,
1840 					      struct page **pages,
1841 					      unsigned long num_pages,
1842 					      uint32_t gtt_offset,
1843 					      uint32_t type)
1844 {
1845 	return NULL;
1846 }
1847 #endif
1848 static inline struct drm_agp_head *drm_agp_init(struct drm_device *dev)
1849 {
1850 	return NULL;
1851 }
1852 
1853 static inline void drm_agp_clear(struct drm_device *dev)
1854 {
1855 }
1856 
1857 static inline int drm_agp_acquire(struct drm_device *dev)
1858 {
1859 	return -ENODEV;
1860 }
1861 
1862 static inline int drm_agp_acquire_ioctl(struct drm_device *dev, void *data,
1863 					struct drm_file *file_priv)
1864 {
1865 	return -ENODEV;
1866 }
1867 
1868 static inline int drm_agp_release(struct drm_device *dev)
1869 {
1870 	return -ENODEV;
1871 }
1872 
1873 static inline int drm_agp_release_ioctl(struct drm_device *dev, void *data,
1874 					struct drm_file *file_priv)
1875 {
1876 	return -ENODEV;
1877 }
1878 
1879 static inline int drm_agp_enable(struct drm_device *dev,
1880 				 struct drm_agp_mode mode)
1881 {
1882 	return -ENODEV;
1883 }
1884 
1885 static inline int drm_agp_enable_ioctl(struct drm_device *dev, void *data,
1886 				       struct drm_file *file_priv)
1887 {
1888 	return -ENODEV;
1889 }
1890 
1891 static inline int drm_agp_info(struct drm_device *dev,
1892 			       struct drm_agp_info *info)
1893 {
1894 	return -ENODEV;
1895 }
1896 
1897 static inline int drm_agp_info_ioctl(struct drm_device *dev, void *data,
1898 				     struct drm_file *file_priv)
1899 {
1900 	return -ENODEV;
1901 }
1902 
1903 static inline int drm_agp_alloc(struct drm_device *dev,
1904 				struct drm_agp_buffer *request)
1905 {
1906 	return -ENODEV;
1907 }
1908 
1909 static inline int drm_agp_alloc_ioctl(struct drm_device *dev, void *data,
1910 				      struct drm_file *file_priv)
1911 {
1912 	return -ENODEV;
1913 }
1914 
1915 static inline int drm_agp_free(struct drm_device *dev,
1916 			       struct drm_agp_buffer *request)
1917 {
1918 	return -ENODEV;
1919 }
1920 
1921 static inline int drm_agp_free_ioctl(struct drm_device *dev, void *data,
1922 				     struct drm_file *file_priv)
1923 {
1924 	return -ENODEV;
1925 }
1926 
1927 static inline int drm_agp_unbind(struct drm_device *dev,
1928 				 struct drm_agp_binding *request)
1929 {
1930 	return -ENODEV;
1931 }
1932 
1933 static inline int drm_agp_unbind_ioctl(struct drm_device *dev, void *data,
1934 				       struct drm_file *file_priv)
1935 {
1936 	return -ENODEV;
1937 }
1938 
1939 static inline int drm_agp_bind(struct drm_device *dev,
1940 			       struct drm_agp_binding *request)
1941 {
1942 	return -ENODEV;
1943 }
1944 
1945 static inline int drm_agp_bind_ioctl(struct drm_device *dev, void *data,
1946 				     struct drm_file *file_priv)
1947 {
1948 	return -ENODEV;
1949 }
1950 
1951 #endif /* __OS_HAS_AGP */
1952 
1953 #endif				/* __KERNEL__ */
1954 #endif
1955