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