xref: /dragonfly/sys/dev/drm/include/drm/drmP.h (revision 23b3ef78)
1 /*
2  * Internal Header for the Direct Rendering Manager
3  *
4  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
5  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
6  * Copyright (c) 2009-2010, Code Aurora Forum.
7  * All rights reserved.
8  *
9  * Author: Rickard E. (Rik) Faith <faith@valinux.com>
10  * Author: Gareth Hughes <gareth@valinux.com>
11  *
12  * Permission is hereby granted, free of charge, to any person obtaining a
13  * copy of this software and associated documentation files (the "Software"),
14  * to deal in the Software without restriction, including without limitation
15  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
16  * and/or sell copies of the Software, and to permit persons to whom the
17  * Software is furnished to do so, subject to the following conditions:
18  *
19  * The above copyright notice and this permission notice (including the next
20  * paragraph) shall be included in all copies or substantial portions of the
21  * Software.
22  *
23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
26  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
27  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
28  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
29  * OTHER DEALINGS IN THE SOFTWARE.
30  */
31 
32 #ifndef _DRM_P_H_
33 #define _DRM_P_H_
34 
35 #if defined(_KERNEL) || defined(__KERNEL__)
36 
37 #include <sys/param.h>
38 #include <sys/queue.h>
39 #include <sys/malloc.h>
40 #include <sys/kernel.h>
41 #include <sys/ktr.h>
42 #include <sys/module.h>
43 #include <sys/systm.h>
44 #include <sys/device.h>
45 #include <sys/sglist.h>
46 #include <sys/stat.h>
47 #include <sys/priv.h>
48 #include <sys/proc.h>
49 #include <sys/lock.h>
50 #include <sys/spinlock.h>
51 #include <sys/spinlock2.h>
52 #include <sys/fcntl.h>
53 #include <sys/uio.h>
54 #include <sys/filio.h>
55 #include <sys/sysctl.h>
56 #include <sys/bus.h>
57 #include <sys/queue.h>
58 #include <sys/signalvar.h>
59 #include <sys/poll.h>
60 #include <linux/highmem.h>
61 #include <sys/sbuf.h>
62 #include <sys/taskqueue.h>
63 #include <sys/tree.h>
64 #include <vm/vm.h>
65 #include <vm/pmap.h>
66 #include <vm/vm_extern.h>
67 #include <vm/vm_kern.h>
68 #include <vm/vm_map.h>
69 #include <vm/vm_object.h>
70 #include <vm/vm_page2.h>
71 #include <vm/vm_pager.h>
72 #include <vm/vm_param.h>
73 #include <machine/param.h>
74 #include <machine/pmap.h>
75 #ifdef __x86_64__
76 #include <machine/specialreg.h>
77 #endif
78 #include <machine/sysarch.h>
79 #include <sys/endian.h>
80 #include <sys/mman.h>
81 #include <sys/rman.h>
82 #include <sys/memrange.h>
83 #include <sys/agpio.h>
84 #include <sys/mutex.h>
85 
86 MALLOC_DECLARE(M_DRM);
87 
88 #include <uapi_drm/drm.h>
89 #include <uapi_drm/drm_sarea.h>
90 
91 #include <linux/atomic.h>
92 #include <linux/bug.h>
93 #include <linux/dma-mapping.h>
94 #include <linux/capability.h>
95 #include <linux/err.h>
96 #include <linux/idr.h>
97 #include <linux/pci.h>
98 #include <linux/jiffies.h>
99 #include <linux/kernel.h>
100 #include <linux/fs.h>
101 #include <linux/kref.h>
102 #include <linux/list.h>
103 #include <linux/mm.h>
104 #include <linux/moduleparam.h>
105 #include <linux/mutex.h>
106 #include <linux/slab.h>
107 #include <linux/scatterlist.h>
108 #include <linux/timer.h>
109 #include <asm/io.h>
110 #include <linux/seq_file.h>
111 #include <linux/types.h>
112 #include <linux/vmalloc.h>
113 #include <linux/wait.h>
114 #include <linux/workqueue.h>
115 
116 #include <asm/uaccess.h>
117 
118 #include <drm/drm_global.h>
119 
120 #include <drm/drm_vma_manager.h>
121 
122 #include <drm/drm_os_linux.h>
123 #include <drm/drm_hashtab.h>
124 #include <drm/drm_mm.h>
125 
126 struct drm_file;
127 struct drm_device;
128 struct drm_agp_head;
129 struct drm_gem_object;
130 
131 struct device_node;
132 struct videomode;
133 struct reservation_object;
134 struct dma_buf_attachment;
135 
136 /*
137  * 4 debug categories are defined:
138  *
139  * CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c, drm_memory.c, ...
140  *	 This is the category used by the DRM_DEBUG() macro.
141  *
142  * DRIVER: Used in the vendor specific part of the driver: i915, radeon, ...
143  *	   This is the category used by the DRM_DEBUG_DRIVER() macro.
144  *
145  * KMS: used in the modesetting code.
146  *	This is the category used by the DRM_DEBUG_KMS() macro.
147  *
148  * PRIME: used in the prime code.
149  *	  This is the category used by the DRM_DEBUG_PRIME() macro.
150  *
151  * ATOMIC: used in the atomic code.
152  *	  This is the category used by the DRM_DEBUG_ATOMIC() macro.
153  *
154  * Enabling verbose debug messages is done through the drm.debug parameter,
155  * each category being enabled by a bit.
156  *
157  * drm.debug=0x1 will enable CORE messages
158  * drm.debug=0x2 will enable DRIVER messages
159  * drm.debug=0x3 will enable CORE and DRIVER messages
160  * ...
161  * drm.debug=0xf will enable all messages
162  *
163  * An interesting feature is that it's possible to enable verbose logging at
164  * run-time by echoing the debug value in its sysfs node:
165  *   # echo 0xf > /sys/module/drm/parameters/debug
166  */
167 #define DRM_UT_CORE 		0x01
168 #define DRM_UT_DRIVER		0x02
169 #define DRM_UT_KMS		0x04
170 #define DRM_UT_PRIME		0x08
171 #define DRM_UT_ATOMIC		0x10
172 
173 void drm_ut_debug_printk(const char *function_name,
174 			 const char *format, ...);
175 
176 void drm_err(const char *format, ...);
177 
178 /***********************************************************************/
179 /** \name DRM template customization defaults */
180 /*@{*/
181 
182 /* driver capabilities and requirements mask */
183 #define DRIVER_USE_AGP     0x1
184 #define DRIVER_REQUIRE_AGP 0x2
185 #define DRIVER_PCI_DMA     0x8
186 #define DRIVER_SG          0x10
187 #define DRIVER_HAVE_DMA    0x20
188 #define DRIVER_HAVE_IRQ    0x40
189 #define DRIVER_IRQ_SHARED  0x80
190 #define DRIVER_DMA_QUEUE   0x200
191 #define DRIVER_GEM         0x1000
192 #define DRIVER_MODESET     0x2000
193 #define DRIVER_PRIME       0x4000
194 #define DRIVER_RENDER      0x8000
195 #define DRIVER_ATOMIC      0x10000
196 
197 #define DRM_MAGIC_HASH_ORDER  4  /**< Size of key hash table. Must be power of 2. */
198 
199 /***********************************************************************/
200 /** \name Macros to make printk easier */
201 /*@{*/
202 
203 /**
204  * Error output.
205  *
206  * \param fmt printf() like format string.
207  * \param arg arguments
208  */
209 #define DRM_ERROR(fmt, ...) \
210 	kprintf("error: [" DRM_NAME ":pid%d:%s] *ERROR* " fmt,		\
211 	    DRM_CURRENTPID, __func__ , ##__VA_ARGS__)
212 
213 /**
214  * Rate limited error output.  Like DRM_ERROR() but won't flood the log.
215  *
216  * \param fmt printf() like format string.
217  * \param arg arguments
218  */
219 
220 #define DRM_INFO(fmt, ...)  kprintf("info: [" DRM_NAME "] " fmt , ##__VA_ARGS__)
221 
222 #define DRM_INFO_ONCE(fmt, ...)				\
223 	printk_once(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
224 
225 /**
226  * Debug output.
227  *
228  * \param fmt printf() like format string.
229  * \param arg arguments
230  */
231 
232 #define	DRM_DEBUGBITS_DEBUG		0x1
233 #define	DRM_DEBUGBITS_KMS		0x2
234 #define	DRM_DEBUGBITS_FAILED_IOCTL	0x4
235 #define	DRM_DEBUGBITS_VERBOSE		0x8
236 
237 #define DRM_DEBUG(fmt, ...) do {					\
238 	if ((drm_debug & DRM_DEBUGBITS_DEBUG) != 0)		\
239 		kprintf("[" DRM_NAME ":pid%d:%s] " fmt, DRM_CURRENTPID,	\
240 			__func__ , ##__VA_ARGS__);			\
241 } while (0)
242 
243 #define DRM_DEBUG_VERBOSE(fmt, ...) do {				\
244 	if ((drm_debug & DRM_DEBUGBITS_VERBOSE) != 0)		\
245 		kprintf("[" DRM_NAME ":pid%d:%s] " fmt, DRM_CURRENTPID,	\
246 			__func__ , ##__VA_ARGS__);			\
247 } while (0)
248 
249 #define DRM_DEBUG_KMS(fmt, ...) do {					\
250 	if ((drm_debug & DRM_DEBUGBITS_KMS) != 0)			\
251 		kprintf("[" DRM_NAME ":KMS:pid%d:%s] " fmt, DRM_CURRENTPID,\
252 			__func__ , ##__VA_ARGS__);			\
253 } while (0)
254 
255 #define DRM_DEBUG_DRIVER(fmt, ...) do {					\
256 	if ((drm_debug & DRM_DEBUGBITS_KMS) != 0)			\
257 		kprintf("[" DRM_NAME ":KMS:pid%d:%s] " fmt, DRM_CURRENTPID,\
258 			__func__ , ##__VA_ARGS__);			\
259 } while (0)
260 
261 #define DRM_DEBUG_ATOMIC(fmt, args...)					\
262 	do {								\
263 		if (unlikely(drm_debug & DRM_UT_ATOMIC))		\
264 			drm_ut_debug_printk(__func__, fmt, ##args);	\
265 	} while (0)
266 
267 /*@}*/
268 
269 /***********************************************************************/
270 /** \name Internal types and structures */
271 /*@{*/
272 
273 #define	DRM_GEM_MAPPING_MASK	(3ULL << 62)
274 #define	DRM_GEM_MAPPING_KEY	(2ULL << 62) /* Non-canonical address form */
275 #define	DRM_GEM_MAX_IDX		0x3fffff
276 #define	DRM_GEM_MAPPING_IDX(o)	(((o) >> 40) & DRM_GEM_MAX_IDX)
277 #define	DRM_GEM_MAPPING_OFF(i)	(((uint64_t)(i)) << 40)
278 #define	DRM_GEM_MAPPING_MAPOFF(o) \
279     ((o) & ~(DRM_GEM_MAPPING_OFF(DRM_GEM_MAX_IDX) | DRM_GEM_MAPPING_KEY))
280 
281 SYSCTL_DECL(_hw_drm);
282 
283 #define DRM_MAX(a,b) ((a)>(b)?(a):(b))
284 
285 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
286 
287 #define __OS_HAS_AGP	1
288 
289 #define DRM_DEV_MODE	(S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP)
290 #define DRM_DEV_UID	UID_ROOT
291 #define DRM_DEV_GID	GID_WHEEL
292 
293 #define DRM_CURPROC		curthread
294 #define DRM_STRUCTPROC		struct thread
295 #define DRM_CURRENTPID		(curproc != NULL ? curproc->p_pid : -1)
296 #define DRM_LOCK(dev)		lockmgr(&(dev)->struct_mutex, LK_EXCLUSIVE)
297 #define DRM_UNLOCK(dev)		lockmgr(&(dev)->struct_mutex, LK_RELEASE)
298 #define	DRM_LOCK_SLEEP(dev, chan, flags, msg, timeout)			\
299     (lksleep((chan), &(dev)->struct_mutex, (flags), (msg), (timeout)))
300 #if defined(INVARIANTS)
301 #define	DRM_LOCK_ASSERT(dev)	KKASSERT(lockstatus(&(dev)->struct_mutex, curthread) != 0);
302 #define	DRM_UNLOCK_ASSERT(dev)	KKASSERT(lockstatus(&(dev)->struct_mutex, curthread) == 0);
303 #else
304 #define	DRM_LOCK_ASSERT(d)
305 #define	DRM_UNLOCK_ASSERT(d)
306 #endif
307 
308 #define DRM_SYSCTL_HANDLER_ARGS	(SYSCTL_HANDLER_ARGS)
309 
310 typedef void			irqreturn_t;
311 #define IRQ_HANDLED		/* nothing */
312 #define IRQ_NONE		/* nothing */
313 
314 enum {
315 	DRM_IS_NOT_AGP,
316 	DRM_IS_AGP,
317 	DRM_MIGHT_BE_AGP
318 };
319 #define DRM_AGP_MEM		struct agp_memory_info
320 
321 #define drm_get_device_from_kdev(_kdev) (_kdev->si_drv1)
322 
323 #define DRM_AGP_FIND_DEVICE()	agp_find_device()
324 #define DRM_MTRR_WC		MDF_WRITECOMBINE
325 
326 #define LOCK_TEST_WITH_RETURN(dev, file_priv)				\
327 do {									\
328 	if (!_DRM_LOCK_IS_HELD(dev->lock.hw_lock->lock) ||		\
329 	     dev->lock.file_priv != file_priv) {			\
330 		DRM_ERROR("%s called without lock held\n",		\
331 			   __FUNCTION__);				\
332 		return EINVAL;						\
333 	}								\
334 } while (0)
335 
336 /* Returns -errno to shared code */
337 #define DRM_WAIT_ON( ret, queue, timeout, condition )		\
338 for ( ret = 0 ; !ret && !(condition) ; ) {			\
339 	lwkt_serialize_enter(&dev->irq_lock);			\
340 	if (!(condition)) {					\
341             tsleep_interlock(&(queue), PCATCH);			\
342             lwkt_serialize_exit(&dev->irq_lock);		\
343             ret = -tsleep(&(queue), PCATCH | PINTERLOCKED,	\
344 			  "drmwtq", (timeout));			\
345         } else {                                                \
346                 lwkt_serialize_exit(&dev->irq_lock);            \
347         }                                                 	\
348 }
349 
350 int vm_phys_fictitious_reg_range(vm_paddr_t start, vm_paddr_t end,
351     vm_memattr_t memattr);
352 void vm_phys_fictitious_unreg_range(vm_paddr_t start, vm_paddr_t end);
353 vm_page_t vm_phys_fictitious_to_vm_page(vm_paddr_t pa);
354 
355 
356 #define	dev_dbg(dev, fmt, ...) do {					\
357 	if ((drm_debug& DRM_DEBUGBITS_KMS) != 0) {			\
358 		device_printf((dev), "debug: " fmt, ## __VA_ARGS__);	\
359 	}								\
360 } while (0)
361 
362 typedef struct drm_pci_id_list
363 {
364 	int vendor;
365 	int device;
366 	long driver_private;
367 	char *name;
368 } drm_pci_id_list_t;
369 
370 /**
371  * Ioctl function type.
372  *
373  * \param inode device inode.
374  * \param file_priv DRM file private pointer.
375  * \param cmd command.
376  * \param arg argument.
377  */
378 typedef int drm_ioctl_t(struct drm_device *dev, void *data,
379 			struct drm_file *file_priv);
380 
381 typedef int drm_ioctl_compat_t(struct file *filp, unsigned int cmd,
382 			       unsigned long arg);
383 
384 #define DRM_IOCTL_NR(n)                ((n) & 0xff)
385 
386 #define DRM_AUTH	0x1
387 #define DRM_MASTER	0x2
388 #define DRM_ROOT_ONLY	0x4
389 #define DRM_CONTROL_ALLOW 0x8
390 #define DRM_UNLOCKED	0x10
391 #define DRM_RENDER_ALLOW 0x20
392 
393 struct drm_ioctl_desc {
394 	unsigned int cmd;
395 	int flags;
396 	drm_ioctl_t *func;
397 	unsigned int cmd_drv;
398 	const char *name;
399 };
400 
401 /**
402  * Creates a driver or general drm_ioctl_desc array entry for the given
403  * ioctl, for use by drm_ioctl().
404  */
405 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags)			\
406 	[DRM_IOCTL_NR(DRM_##ioctl)] = {.cmd = DRM_##ioctl, .func = _func, .flags = _flags, .cmd_drv = DRM_IOCTL_##ioctl}
407 
408 typedef struct drm_magic_entry {
409 	struct list_head head;
410 	struct drm_hash_item hash_item;
411 	struct drm_file	       *priv;
412 	struct drm_magic_entry *next;
413 } drm_magic_entry_t;
414 
415 typedef struct drm_magic_head {
416 	struct drm_magic_entry *head;
417 	struct drm_magic_entry *tail;
418 } drm_magic_head_t;
419 
420 typedef struct drm_buf {
421 	int idx;		       /**< Index into master buflist */
422 	int total;		       /**< Buffer size */
423 	int order;		       /**< log-base-2(total) */
424 	int used;		       /**< Amount of buffer in use (for DMA) */
425 	unsigned long offset;	       /**< Byte offset (used internally) */
426 	void *address;		       /**< Address of buffer */
427 	unsigned long bus_address;     /**< Bus address of buffer */
428 	struct drm_buf *next;	       /**< Kernel-only: used for free list */
429 	__volatile__ int waiting;      /**< On kernel DMA queue */
430 	__volatile__ int pending;      /**< On hardware DMA queue */
431 	struct drm_file *file_priv;    /**< Private of holding file descr */
432 	int context;		       /**< Kernel queue for this buffer */
433 	int while_locked;	       /**< Dispatch this buffer while locked */
434 	enum {
435 		DRM_LIST_NONE = 0,
436 		DRM_LIST_FREE = 1,
437 		DRM_LIST_WAIT = 2,
438 		DRM_LIST_PEND = 3,
439 		DRM_LIST_PRIO = 4,
440 		DRM_LIST_RECLAIM = 5
441 	} list;			       /**< Which list we're on */
442 
443 	int dev_priv_size;		 /**< Size of buffer private storage */
444 	void *dev_private;		 /**< Per-buffer private storage */
445 } drm_buf_t;
446 
447 /** bufs is one longer than it has to be */
448 struct drm_waitlist {
449 	int count;			/**< Number of possible buffers */
450 	struct drm_buf **bufs;		/**< List of pointers to buffers */
451 	struct drm_buf **rp;			/**< Read pointer */
452 	struct drm_buf **wp;			/**< Write pointer */
453 	struct drm_buf **end;		/**< End pointer */
454 	struct spinlock *read_lock;
455 	struct spinlock *write_lock;
456 };
457 
458 typedef struct drm_dma_handle {
459 	void *vaddr;
460 	size_t size;
461 	bus_addr_t busaddr;
462 	bus_dma_tag_t tag;
463 	bus_dmamap_t map;
464 } drm_dma_handle_t;
465 
466 typedef struct drm_buf_entry {
467 	int		  buf_size;
468 	int		  buf_count;
469 	drm_buf_t	  *buflist;
470 	int		  seg_count;
471 	int		  page_order;
472 	struct drm_dma_handle **seglist;
473 
474 	int low_mark;			/**< Low water mark */
475 	int high_mark;			/**< High water mark */
476 } drm_buf_entry_t;
477 
478 /* Event queued up for userspace to read */
479 struct drm_pending_event {
480 	struct drm_event *event;
481 	struct list_head link;
482 	struct drm_file *file_priv;
483 	pid_t pid; /* pid of requester, no guarantee it's valid by the time
484 		      we deliver the event, for tracing only */
485 	void (*destroy)(struct drm_pending_event *event);
486 };
487 
488 /* initial implementaton using a linked list - todo hashtab */
489 struct drm_prime_file_private {
490 	struct list_head head;
491 #ifdef DUMBBELL_WIP
492 	struct mutex lock;
493 #endif /* DUMBBELL_WIP */
494 };
495 
496 /** File private data */
497 struct drm_file {
498 	int authenticated;
499 	struct drm_device *dev;
500 	int		  master;
501 
502 	/* true when the client has asked us to expose stereo 3D mode flags */
503 	bool stereo_allowed;
504 	/*
505 	 * true if client understands CRTC primary planes and cursor planes
506 	 * in the plane list
507 	 */
508 	unsigned universal_planes:1;
509 	/* true if client understands atomic properties */
510 	unsigned atomic:1;
511 
512 	pid_t		  pid;
513 	uid_t		  uid;
514 	drm_magic_t	  magic;
515 	unsigned long	  ioctl_count;
516 	struct list_head lhead;
517 	struct kqinfo	  dkq;
518 
519 	/** Mapping of mm object handles to object pointers. */
520 	struct idr object_idr;
521 	/** Lock for synchronization of access to object_idr. */
522 	struct lock table_lock;
523 
524 	void		 *driver_priv;
525 
526 	int		  is_master;
527 	struct drm_master *masterp;
528 
529 	/**
530 	 * fbs - List of framebuffers associated with this file.
531 	 *
532 	 * Protected by fbs_lock. Note that the fbs list holds a reference on
533 	 * the fb object to prevent it from untimely disappearing.
534 	 */
535 	struct list_head fbs;
536 	struct lock fbs_lock;
537 
538 	wait_queue_head_t event_wait;
539 	struct list_head  event_list;
540 	int		  event_space;
541 
542 	struct drm_prime_file_private prime;
543 };
544 
545 /**
546  * Lock data.
547  */
548 struct drm_lock_data {
549 	struct drm_hw_lock *hw_lock;	/**< Hardware lock */
550 	/** Private of lock holder's file (NULL=kernel) */
551 	struct drm_file *file_priv;
552 	wait_queue_head_t lock_queue;	/**< Queue of blocked processes */
553 	unsigned long lock_time;	/**< Time of last lock in jiffies */
554 };
555 
556 /* This structure, in the struct drm_device, is always initialized while the
557  * device
558  * is open.  dev->dma_lock protects the incrementing of dev->buf_use, which
559  * when set marks that no further bufs may be allocated until device teardown
560  * occurs (when the last open of the device has closed).  The high/low
561  * watermarks of bufs are only touched by the X Server, and thus not
562  * concurrently accessed, so no locking is needed.
563  */
564 typedef struct drm_device_dma {
565 
566 	struct drm_buf_entry bufs[DRM_MAX_ORDER + 1];	/**< buffers, grouped by their size order */
567 	int buf_count;			/**< total number of buffers */
568 	struct drm_buf **buflist;		/**< Vector of pointers into drm_device_dma::bufs */
569 	int seg_count;
570 	int page_count;			/**< number of pages */
571 	unsigned long *pagelist;	/**< page list */
572 	unsigned long byte_count;
573 	enum {
574 		_DRM_DMA_USE_AGP = 0x01,
575 		_DRM_DMA_USE_SG = 0x02,
576 		_DRM_DMA_USE_FB = 0x04,
577 		_DRM_DMA_USE_PCI_RO = 0x08
578 	} flags;
579 
580 } drm_device_dma_t;
581 
582 typedef struct drm_sg_mem {
583 	vm_offset_t vaddr;
584 	vm_paddr_t *busaddr;
585 	vm_pindex_t pages;
586 } drm_sg_mem_t;
587 
588 /**
589  * Kernel side of a mapping
590  */
591 struct drm_local_map {
592 	resource_size_t offset;	 /**< Requested physical address (0 for SAREA)*/
593 	unsigned long size;	 /**< Requested physical size (bytes) */
594 	enum drm_map_type type;	 /**< Type of memory to map */
595 	enum drm_map_flags flags;	 /**< Flags */
596 	void *handle;		 /**< User-space: "Handle" to pass to mmap() */
597 				 /**< Kernel-space: kernel-virtual address */
598 	int mtrr;		 /**< MTRR slot used */
599 };
600 
601 typedef struct drm_local_map drm_local_map_t;
602 
603 /**
604  * Mappings list
605  */
606 struct drm_map_list {
607 	struct list_head head;		/**< list head */
608 	struct drm_hash_item hash;
609 	struct drm_local_map *map;	/**< mapping */
610 	uint64_t user_token;
611 	struct drm_master *master;
612 	struct drm_mm_node *file_offset_node;	/**< fake offset */
613 };
614 
615 /**
616  * GEM specific mm private for tracking GEM objects
617  */
618 struct drm_gem_mm {
619 	struct drm_vma_offset_manager vma_manager;
620 	struct drm_mm offset_manager;	/**< Offset mgmt for buffer objects */
621 	struct drm_open_hash offset_hash; /**< User token hash table for maps */
622 	struct unrhdr *idxunr;
623 };
624 
625 
626 #include "drm_crtc.h"
627 
628 /**
629  * struct drm_master - drm master structure
630  *
631  * @refcount: Refcount for this master object.
632  * @minor: Link back to minor char device we are master for. Immutable.
633  * @unique: Unique identifier: e.g. busid. Protected by drm_global_mutex.
634  * @unique_len: Length of unique field. Protected by drm_global_mutex.
635  * @unique_size: Amount allocated. Protected by drm_global_mutex.
636  * @magiclist: Hash of used authentication tokens. Protected by struct_mutex.
637  * @magicfree: List of used authentication tokens. Protected by struct_mutex.
638  * @lock: DRI lock information.
639  * @driver_priv: Pointer to driver-private information.
640  */
641 struct drm_master {
642 
643 	struct kref refcount; /* refcount for this master */
644 
645 	struct list_head head; /**< each minor contains a list of masters */
646 	struct drm_minor *minor; /**< link back to minor we are a master for */
647 
648 	char *unique;			/**< Unique identifier: e.g., busid */
649 	int unique_len;			/**< Length of unique field */
650 	int unique_size;		/**< amount allocated */
651 
652 	int blocked;			/**< Blocked due to VC switch? */
653 
654 	struct drm_open_hash magiclist;
655 	struct list_head magicfree;
656 	struct drm_lock_data lock;
657 	void *driver_priv;
658 };
659 
660 /* Size of ringbuffer for vblank timestamps. Just double-buffer
661  * in initial implementation.
662  */
663 #define DRM_VBLANKTIME_RBSIZE 2
664 
665 /* Flags and return codes for get_vblank_timestamp() driver function. */
666 #define DRM_CALLED_FROM_VBLIRQ 1
667 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
668 #define DRM_VBLANKTIME_IN_VBLANK         (1 << 1)
669 
670 /* get_scanout_position() return flags */
671 #define DRM_SCANOUTPOS_VALID        (1 << 0)
672 #define DRM_SCANOUTPOS_IN_VBLANK    (1 << 1)
673 #define DRM_SCANOUTPOS_ACCURATE     (1 << 2)
674 
675 #ifndef DMA_BIT_MASK
676 #define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : (1ULL<<(n)) - 1)
677 #endif
678 
679 #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
680 
681 /**
682  * DRM driver structure. This structure represent the common code for
683  * a family of cards. There will one drm_device for each card present
684  * in this family
685  */
686 struct drm_driver {
687 	int	(*load)(struct drm_device *, unsigned long flags);
688 	int	(*use_msi)(struct drm_device *, unsigned long flags);
689 	int	(*firstopen)(struct drm_device *);
690 	int	(*open)(struct drm_device *, struct drm_file *);
691 	void	(*preclose)(struct drm_device *, struct drm_file *file_priv);
692 	void	(*postclose)(struct drm_device *, struct drm_file *);
693 	void	(*lastclose)(struct drm_device *);
694 	int	(*unload)(struct drm_device *);
695 	void	(*reclaim_buffers_locked)(struct drm_device *,
696 					  struct drm_file *file_priv);
697 	int	(*dma_ioctl)(struct drm_device *dev, void *data,
698 			     struct drm_file *file_priv);
699 	void	(*dma_ready)(struct drm_device *);
700 	int	(*dma_quiescent)(struct drm_device *);
701 	int	(*dma_flush_block_and_flush)(struct drm_device *, int context,
702 					     enum drm_lock_flags flags);
703 	int	(*dma_flush_unblock)(struct drm_device *, int context,
704 				     enum drm_lock_flags flags);
705 	int	(*context_ctor)(struct drm_device *dev, int context);
706 	int	(*context_dtor)(struct drm_device *dev, int context);
707 	int	(*kernel_context_switch)(struct drm_device *dev, int old,
708 					 int new);
709 	int	(*kernel_context_switch_unlock)(struct drm_device *dev);
710 	void	(*irq_preinstall)(struct drm_device *dev);
711 	int	(*irq_postinstall)(struct drm_device *dev);
712 	void	(*irq_uninstall)(struct drm_device *dev);
713 	void	(*irq_handler)(void *arg);
714 
715 	u32	(*get_vblank_counter)(struct drm_device *dev, int crtc);
716 	int	(*enable_vblank)(struct drm_device *dev, int crtc);
717 	void	(*disable_vblank)(struct drm_device *dev, int crtc);
718 
719 	/**
720 	 * Called by vblank timestamping code.
721 	 *
722 	 * Return the current display scanout position from a crtc, and an
723 	 * optional accurate ktime_get timestamp of when position was measured.
724 	 *
725 	 * \param dev  DRM device.
726 	 * \param crtc Id of the crtc to query.
727 	 * \param flags Flags from the caller (DRM_CALLED_FROM_VBLIRQ or 0).
728 	 * \param *vpos Target location for current vertical scanout position.
729 	 * \param *hpos Target location for current horizontal scanout position.
730 	 * \param *stime Target location for timestamp taken immediately before
731 	 *               scanout position query. Can be NULL to skip timestamp.
732 	 * \param *etime Target location for timestamp taken immediately after
733 	 *               scanout position query. Can be NULL to skip timestamp.
734 	 *
735 	 * Returns vpos as a positive number while in active scanout area.
736 	 * Returns vpos as a negative number inside vblank, counting the number
737 	 * of scanlines to go until end of vblank, e.g., -1 means "one scanline
738 	 * until start of active scanout / end of vblank."
739 	 *
740 	 * \return Flags, or'ed together as follows:
741 	 *
742 	 * DRM_SCANOUTPOS_VALID = Query successful.
743 	 * DRM_SCANOUTPOS_INVBL = Inside vblank.
744 	 * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
745 	 * this flag means that returned position may be offset by a constant
746 	 * but unknown small number of scanlines wrt. real scanout position.
747 	 *
748 	 */
749 	int (*get_scanout_position) (struct drm_device *dev, int crtc,
750 				     unsigned int flags,
751 				     int *vpos, int *hpos, ktime_t *stime,
752 				     ktime_t *etime);
753 
754 	int	(*get_vblank_timestamp)(struct drm_device *dev, int crtc,
755 		    int *max_error, struct timeval *vblank_time,
756 		    unsigned flags);
757 
758 	void	(*gem_free_object)(struct drm_gem_object *obj);
759 	int	(*gem_open_object)(struct drm_gem_object *, struct drm_file *);
760 	void	(*gem_close_object)(struct drm_gem_object *, struct drm_file *);
761 
762 	struct cdev_pager_ops *gem_pager_ops;
763 
764 	int	(*dumb_create)(struct drm_file *file_priv,
765 		    struct drm_device *dev, struct drm_mode_create_dumb *args);
766 	int	(*dumb_map_offset)(struct drm_file *file_priv,
767 		    struct drm_device *dev, uint32_t handle, uint64_t *offset);
768 	int	(*dumb_destroy)(struct drm_file *file_priv,
769 		    struct drm_device *dev, uint32_t handle);
770 
771 	int	(*sysctl_init)(struct drm_device *dev,
772 		    struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
773 	void	(*sysctl_cleanup)(struct drm_device *dev);
774 
775 	drm_pci_id_list_t *id_entry;	/* PCI ID, name, and chipset private */
776 
777 	/**
778 	 * Called by \c drm_device_is_agp.  Typically used to determine if a
779 	 * card is really attached to AGP or not.
780 	 *
781 	 * \param dev  DRM device handle
782 	 *
783 	 * \returns
784 	 * One of three values is returned depending on whether or not the
785 	 * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
786 	 * (return of 1), or may or may not be AGP (return of 2).
787 	 */
788 	int	(*device_is_agp) (struct drm_device * dev);
789 
790 	int	major;
791 	int	minor;
792 	int	patchlevel;
793 	const char *name;		/* Simple driver name		   */
794 	const char *desc;		/* Longer driver name		   */
795 	const char *date;		/* Date of last major changes.	   */
796 
797 	u32 driver_features;
798 	int dev_priv_size;
799 	const struct drm_ioctl_desc *ioctls;
800 	int num_ioctls;
801 };
802 
803 /**
804  * Info file list entry. This structure represents a debugfs or proc file to
805  * be created by the drm core
806  */
807 struct drm_info_list {
808 	const char *name; /** file name */
809 	int (*show)(struct seq_file*, void*); /** show callback */
810 	u32 driver_features; /**< Required driver features for this entry */
811 	void *data;
812 };
813 
814 /**
815  * debugfs node structure. This structure represents a debugfs file.
816  */
817 struct drm_info_node {
818 	struct list_head list;
819 	struct drm_minor *minor;
820 	const struct drm_info_list *info_ent;
821 	struct dentry *dent;
822 };
823 
824 /**
825  * DRM minor structure. This structure represents a drm minor number.
826  */
827 struct drm_minor {
828 	int index;			/**< Minor device number */
829 	int type;                       /**< Control or render */
830 	device_t kdev;			/**< OS device */
831 	struct drm_device *dev;
832 
833 	struct drm_master *master; /* currently active master for this node */
834 	struct list_head master_list;
835 	struct drm_mode_group mode_group;
836 };
837 
838 struct drm_pending_vblank_event {
839 	struct drm_pending_event base;
840 	int pipe;
841 	struct drm_event_vblank event;
842 };
843 
844 struct drm_sysctl_info {
845 	struct sysctl_ctx_list ctx;
846 	char   name[2];
847 };
848 
849 /* Length for the array of resource pointers for drm_get_resource_*. */
850 #define DRM_MAX_PCI_RESOURCE	6
851 
852 struct drm_vblank_crtc {
853 	struct drm_device *dev;		/* pointer to the drm_device */
854 	wait_queue_head_t queue;	/**< VBLANK wait queue */
855 	struct timeval time[DRM_VBLANKTIME_RBSIZE];	/**< timestamp of current count */
856 	struct timer_list disable_timer;		/* delayed disable timer */
857 	atomic_t count;			/**< number of VBLANK interrupts */
858 	atomic_t refcount;		/* number of users of vblank interruptsper crtc */
859 	u32 last;			/* protected by dev->vbl_lock, used */
860 					/* for wraparound handling */
861 	u32 last_wait;			/* Last vblank seqno waited per CRTC */
862 	unsigned int inmodeset;		/* Display driver is setting mode */
863 	int crtc;			/* crtc index */
864 	bool enabled;			/* so we don't call enable more than
865 					   once per disable */
866 };
867 
868 /**
869  * DRM device structure. This structure represent a complete card that
870  * may contain multiple heads.
871  */
872 struct drm_device {
873 	drm_pci_id_list_t *id_entry;	/* PCI ID, name, and chipset private */
874 
875 	char		  *unique;	/* Unique identifier: e.g., busid  */
876 	int		  unique_len;	/* Length of unique field	   */
877 	struct cdev	  *devnode;	/* Device number for mknod	   */
878 	int		  if_version;	/* Highest interface version set */
879 
880 	int		  flags;	/* Flags to open(2)		   */
881 
882 				/* Locks */
883 	struct spinlock	  dma_lock;	/* protects dev->dma */
884 	struct lwkt_serialize irq_lock;	/* protects irq condition checks */
885 	struct lock	  dev_lock;	/* protects everything else */
886 
887 	/** \name Locks */
888 	/*@{ */
889 	struct lock struct_mutex;	/**< For others */
890 	struct lock master_mutex;	/**< For drm_minor::master */
891 	/*@} */
892 
893 	/** \name Usage Counters */
894 	/*@{ */
895 	int open_count;			/**< Outstanding files open, protected by drm_global_mutex. */
896 	struct spinlock buf_lock;	/**< For drm_device::buf_use and a few other things. */
897 	int buf_use;			/**< Buffers in use -- cannot alloc */
898 	atomic_t buf_alloc;		/**< Buffer allocation in progress */
899 	/*@} */
900 
901 
902 	/** \name Performance counters */
903 	/*@{ */
904 	unsigned long     counters;
905 	enum drm_stat_type	types[15];
906 	atomic_t          counts[15];
907 	/*@} */
908 
909 				/* Authentication */
910 	struct drm_open_hash magiclist;	/**< magic hash table */
911 	struct list_head magicfree;
912 
913 	struct list_head filelist;
914 
915 	/** \name Memory management */
916 	/*@{ */
917 	struct list_head maplist;	/**< Linked list of regions */
918 	int map_count;			/**< Number of mappable regions */
919 	struct drm_open_hash map_hash;	/**< User token hash table for maps */
920 
921 	/** \name Context handle management */
922 	/*@{ */
923 	struct list_head ctxlist;	/**< Linked list of context handles */
924 	int ctx_count;			/**< Number of context handles */
925 	struct lock ctxlist_mutex;	/**< For ctxlist */
926 
927 	struct idr ctx_idr;
928 
929 	/*@} */
930 
931 	struct drm_lock_data lock;	/* Information on hardware lock	   */
932 
933 				/* DMA queues (contexts) */
934 	drm_device_dma_t  *dma;		/* Optional pointer for DMA support */
935 
936 	int		  irq;		/* Interrupt used by board	   */
937 	int		  irq_type;	/* IRQ type (MSI enabled or not) */
938 	int		  irqrid;	/* Interrupt used by board */
939 	struct resource   *irqr;	/* Resource for interrupt used by board	   */
940 	void		  *irqh;	/* Handle from bus_setup_intr      */
941 
942 	/* Storage of resource pointers for drm_get_resource_* */
943 	struct resource   *pcir[DRM_MAX_PCI_RESOURCE];
944 	int		  pcirid[DRM_MAX_PCI_RESOURCE];
945 
946 	int		  pci_domain;
947 	int		  pci_bus;
948 	int		  pci_slot;
949 	int		  pci_func;
950 
951 	/** \name Context support */
952 	/*@{ */
953 	int irq_enabled;		/**< True if irq handler is enabled */
954 	__volatile__ long context_flag;	/**< Context swapping flag */
955 	__volatile__ long interrupt_flag; /**< Interruption handler flag */
956 	__volatile__ long dma_flag;	/**< DMA dispatch flag */
957 	wait_queue_head_t context_wait;	/**< Processes waiting on ctx switch */
958 	int last_checked;		/**< Last context checked for DMA */
959 	int last_context;		/**< Last current context */
960 	unsigned long last_switch;	/**< jiffies at last context switch */
961 	/*@} */
962 
963 	/** \name VBLANK IRQ support */
964 	/*@{ */
965 
966 	/*
967 	 * At load time, disabling the vblank interrupt won't be allowed since
968 	 * old clients may not call the modeset ioctl and therefore misbehave.
969 	 * Once the modeset ioctl *has* been called though, we can safely
970 	 * disable them when unused.
971 	 */
972 	bool vblank_disable_allowed;
973 
974 	/*
975 	 * If true, vblank interrupt will be disabled immediately when the
976 	 * refcount drops to zero, as opposed to via the vblank disable
977 	 * timer.
978 	 * This can be set to true it the hardware has a working vblank
979 	 * counter and the driver uses drm_vblank_on() and drm_vblank_off()
980 	 * appropriately.
981 	 */
982 	bool vblank_disable_immediate;
983 
984 	/* array of size num_crtcs */
985 	struct drm_vblank_crtc *vblank;
986 
987 	struct lock vblank_time_lock;    /**< Protects vblank count and time updates during vblank enable/disable */
988 	struct lock vbl_lock;
989 	struct timer_list vblank_disable_timer;
990 
991 	u32 max_vblank_count;           /**< size of vblank counter register */
992 
993 	/**
994 	 * List of events
995 	 */
996 	struct list_head vblank_event_list;
997 	struct lock event_lock;
998 
999 	/*@} */
1000 
1001 	struct sigio      *buf_sigio;	/* Processes waiting for SIGIO     */
1002 
1003 				/* Sysctl support */
1004 	struct drm_sysctl_info *sysctl;
1005 
1006 
1007 	drm_sg_mem_t      *sg;  /* Scatter gather memory */
1008 	unsigned int num_crtcs;                  /**< Number of CRTCs on this device */
1009 
1010 	unsigned long     *ctx_bitmap;
1011 	void		  *dev_private;
1012 
1013 	void		  *drm_ttm_bdev;
1014 
1015 	/*@} */
1016 
1017 	struct drm_agp_head *agp;	/**< AGP data */
1018 
1019 	struct device *dev;             /**< Device structure */
1020 	struct pci_dev *pdev;		/**< PCI device structure */
1021 
1022 	struct drm_driver *driver;
1023 	struct drm_local_map *agp_buffer_map;
1024 	unsigned int agp_buffer_token;
1025 	struct drm_minor *control;		/**< Control node for card */
1026 	struct drm_minor *primary;		/**< render type primary screen head */
1027 
1028         struct drm_mode_config mode_config;	/**< Current mode config */
1029 
1030 	/** \name GEM information */
1031 	/*@{ */
1032 	struct lock object_name_lock;
1033 	struct idr object_name_idr;
1034 	/*@} */
1035 	void             *mm_private;
1036 
1037 	void *sysctl_private;
1038 	char busid_str[128];
1039 	int modesetting;
1040 
1041 	int switch_power_state;
1042 
1043 	atomic_t unplugged; /* device has been unplugged or gone away */
1044 };
1045 
1046 #define DRM_SWITCH_POWER_ON 0
1047 #define DRM_SWITCH_POWER_OFF 1
1048 #define DRM_SWITCH_POWER_CHANGING 2
1049 #define DRM_SWITCH_POWER_DYNAMIC_OFF 3
1050 
1051 static __inline__ int drm_core_check_feature(struct drm_device *dev,
1052 					     int feature)
1053 {
1054 	return ((dev->driver->driver_features & feature) ? 1 : 0);
1055 }
1056 
1057 static inline void drm_device_set_unplugged(struct drm_device *dev)
1058 {
1059 	smp_wmb();
1060 	atomic_set(&dev->unplugged, 1);
1061 }
1062 
1063 static inline int drm_device_is_unplugged(struct drm_device *dev)
1064 {
1065 	int ret = atomic_read(&dev->unplugged);
1066 	smp_rmb();
1067 	return ret;
1068 }
1069 
1070 static inline bool drm_is_primary_client(const struct drm_file *file_priv)
1071 {
1072 	return 0 /* file_priv->minor->type == DRM_MINOR_LEGACY */;
1073 }
1074 
1075 /**
1076  * drm_is_master() - Check whether a DRM open-file is DRM-Master
1077  * @file: DRM open-file context
1078  *
1079  * This checks whether a DRM open-file context is owner of the master context
1080  * attached to it. If a file owns a master context, it's called DRM-Master.
1081  * Per DRM device, only one such file can be DRM-Master at a time.
1082  *
1083  * Returns: True if the file is DRM-Master, otherwise false.
1084  */
1085 static inline bool drm_is_master(const struct drm_file *file)
1086 {
1087 #if 0
1088 	return file->master && file->master == file->minor->master;
1089 #else
1090 	return true;
1091 #endif
1092 }
1093 
1094 /******************************************************************/
1095 /** \name Internal function definitions */
1096 /*@{*/
1097 
1098 #if __OS_HAS_AGP
1099 static inline int drm_core_has_AGP(struct drm_device *dev)
1100 {
1101 	return drm_core_check_feature(dev, DRIVER_USE_AGP);
1102 }
1103 #else
1104 #define drm_core_has_AGP(dev) (0)
1105 #endif
1106 
1107 extern int	drm_notyet_flag;
1108 extern unsigned int drm_rnodes;
1109 extern unsigned int drm_universal_planes;
1110 
1111 extern int drm_vblank_offdelay;
1112 extern unsigned int drm_timestamp_precision;
1113 
1114 				/* Driver support (drm_drv.h) */
1115 int	drm_probe(device_t kdev, drm_pci_id_list_t *idlist);
1116 int	drm_attach(device_t kdev, drm_pci_id_list_t *idlist);
1117 int	drm_create_cdevs(device_t kdev);
1118 d_ioctl_t drm_ioctl;
1119 extern bool drm_ioctl_flags(unsigned int nr, unsigned int *flags);
1120 
1121 				/* Device support (drm_fops.h) */
1122 d_open_t drm_open;
1123 d_close_t drm_close;
1124 d_read_t drm_read;
1125 d_kqfilter_t drm_kqfilter;
1126 int drm_release(device_t kdev);
1127 
1128 d_mmap_t drm_mmap;
1129 d_mmap_single_t drm_mmap_single;
1130 
1131 void drm_cdevpriv_dtor(void *cd);
1132 
1133 int drm_add_busid_modesetting(struct drm_device *dev,
1134     struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
1135 
1136 /* File operations helpers (drm_fops.c) */
1137 extern int		drm_open_helper(struct cdev *kdev, int flags, int fmt,
1138 					 DRM_STRUCTPROC *p,
1139 					struct drm_device *dev,
1140 					struct file *fp);
1141 extern struct drm_file	*drm_find_file_by_proc(struct drm_device *dev,
1142 					DRM_STRUCTPROC *p);
1143 
1144 #ifdef DUMBBELL_WIP
1145 extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
1146 		struct drm_file *file_priv, uint32_t handle, uint32_t flags,
1147 		int *prime_fd);
1148 extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
1149 		struct drm_file *file_priv, int prime_fd, uint32_t *handle);
1150 
1151 extern int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data,
1152 					struct drm_file *file_priv);
1153 extern int drm_prime_fd_to_handle_ioctl(struct drm_device *dev, void *data,
1154 					struct drm_file *file_priv);
1155 
1156 extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, vm_page_t *pages,
1157 					    dma_addr_t *addrs, int max_pages);
1158 #endif /* DUMBBELL_WIP */
1159 extern struct sg_table *drm_prime_pages_to_sg(vm_page_t *pages, int nr_pages);
1160 extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
1161 
1162 #ifdef DUMBBELL_WIP
1163 void drm_prime_init_file_private(struct drm_prime_file_private *prime_fpriv);
1164 void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv);
1165 int drm_prime_add_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf, uint32_t handle);
1166 int drm_prime_lookup_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf, uint32_t *handle);
1167 void drm_prime_remove_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf);
1168 
1169 int drm_prime_add_dma_buf(struct drm_device *dev, struct drm_gem_object *obj);
1170 int drm_prime_lookup_obj(struct drm_device *dev, struct dma_buf *buf,
1171 			 struct drm_gem_object **obj);
1172 #endif /* DUMBBELL_WIP */
1173 
1174 void	drm_mem_init(void);
1175 void	drm_mem_uninit(void);
1176 void	*drm_ioremap_wc(struct drm_device *dev, drm_local_map_t *map);
1177 void	*drm_ioremap(struct drm_device *dev, drm_local_map_t *map);
1178 void	drm_ioremapfree(drm_local_map_t *map);
1179 int	drm_mtrr_add(unsigned long offset, size_t size, int flags);
1180 int	drm_mtrr_del(int handle, unsigned long offset, size_t size, int flags);
1181 
1182 /* Locking IOCTL support (drm_lock.c) */
1183 int	drm_lock_take(struct drm_lock_data *lock_data,
1184 		      unsigned int context);
1185 int	drm_lock_transfer(struct drm_lock_data *lock_data,
1186 			  unsigned int context);
1187 int	drm_lock_free(struct drm_lock_data *lock_data,
1188 		      unsigned int context);
1189 
1190 /*
1191  * These are exported to drivers so that they can implement fencing using
1192  * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
1193  */
1194 
1195 unsigned long drm_get_resource_start(struct drm_device *dev,
1196 				     unsigned int resource);
1197 unsigned long drm_get_resource_len(struct drm_device *dev,
1198 				   unsigned int resource);
1199 
1200 				/* IRQ support (drm_irq.h) */
1201 extern int drm_irq_install(struct drm_device *dev, int irq);
1202 int	drm_irq_uninstall(struct drm_device *dev);
1203 void	drm_driver_irq_preinstall(struct drm_device *dev);
1204 void	drm_driver_irq_postinstall(struct drm_device *dev);
1205 void	drm_driver_irq_uninstall(struct drm_device *dev);
1206 
1207 extern int drm_vblank_init(struct drm_device *dev, int num_crtcs);
1208 extern int drm_wait_vblank(struct drm_device *dev, void *data,
1209 			   struct drm_file *filp);
1210 extern u32 drm_vblank_count(struct drm_device *dev, int crtc);
1211 extern u32 drm_crtc_vblank_count(struct drm_crtc *crtc);
1212 extern u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
1213 				     struct timeval *vblanktime);
1214 extern void drm_send_vblank_event(struct drm_device *dev, int crtc,
1215 				     struct drm_pending_vblank_event *e);
1216 extern void drm_crtc_send_vblank_event(struct drm_crtc *crtc,
1217 				       struct drm_pending_vblank_event *e);
1218 extern bool drm_handle_vblank(struct drm_device *dev, int crtc);
1219 extern bool drm_crtc_handle_vblank(struct drm_crtc *crtc);
1220 extern int drm_vblank_get(struct drm_device *dev, int crtc);
1221 extern void drm_vblank_put(struct drm_device *dev, int crtc);
1222 extern int drm_crtc_vblank_get(struct drm_crtc *crtc);
1223 extern void drm_crtc_vblank_put(struct drm_crtc *crtc);
1224 extern void drm_wait_one_vblank(struct drm_device *dev, int crtc);
1225 extern void drm_crtc_wait_one_vblank(struct drm_crtc *crtc);
1226 extern void drm_vblank_off(struct drm_device *dev, int crtc);
1227 extern void drm_vblank_on(struct drm_device *dev, int crtc);
1228 extern void drm_crtc_vblank_off(struct drm_crtc *crtc);
1229 extern void drm_crtc_vblank_reset(struct drm_crtc *crtc);
1230 extern void drm_crtc_vblank_on(struct drm_crtc *crtc);
1231 extern void drm_vblank_cleanup(struct drm_device *dev);
1232 
1233 extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
1234 						 int crtc, int *max_error,
1235 						 struct timeval *vblank_time,
1236 						 unsigned flags,
1237 						 const struct drm_crtc *refcrtc,
1238 						 const struct drm_display_mode *mode);
1239 extern void drm_calc_timestamping_constants(struct drm_crtc *crtc,
1240 					    const struct drm_display_mode *mode);
1241 
1242 /**
1243  * drm_crtc_vblank_waitqueue - get vblank waitqueue for the CRTC
1244  * @crtc: which CRTC's vblank waitqueue to retrieve
1245  *
1246  * This function returns a pointer to the vblank waitqueue for the CRTC.
1247  * Drivers can use this to implement vblank waits using wait_event() & co.
1248  */
1249 static inline wait_queue_head_t *drm_crtc_vblank_waitqueue(struct drm_crtc *crtc)
1250 {
1251        return &crtc->dev->vblank[drm_crtc_index(crtc)].queue;
1252 }
1253 
1254 /* Modesetting support */
1255 extern void drm_vblank_pre_modeset(struct drm_device *dev, int crtc);
1256 extern void drm_vblank_post_modeset(struct drm_device *dev, int crtc);
1257 
1258 				/* AGP/GART support (drm_agpsupport.h) */
1259 
1260 #include <drm/drm_agpsupport.h>
1261 
1262 /* sysctl support (drm_sysctl.h) */
1263 extern int		drm_sysctl_init(struct drm_device *dev);
1264 extern int		drm_sysctl_cleanup(struct drm_device *dev);
1265 
1266 /* Cache management (drm_memory.c) */
1267 void	drm_clflush_pages(vm_page_t *pages, unsigned long num_pages);
1268 
1269 /* Locking IOCTL support (drm_drv.c) */
1270 int	drm_lock(struct drm_device *dev, void *data,
1271 		 struct drm_file *file_priv);
1272 int	drm_unlock(struct drm_device *dev, void *data,
1273 		   struct drm_file *file_priv);
1274 int	drm_setversion(struct drm_device *dev, void *data,
1275 		       struct drm_file *file_priv);
1276 
1277 /*
1278  * These are exported to drivers so that they can implement fencing using
1279  * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
1280  */
1281 
1282 extern int drm_i_have_hw_lock(struct drm_device *dev, struct drm_file *file_priv);
1283 
1284 /* Misc. IOCTL support (drm_ioctl.c) */
1285 int	drm_noop(struct drm_device *dev, void *data,
1286 		 struct drm_file *file_priv);
1287 
1288 /* Cache management (drm_cache.c) */
1289 void drm_clflush_virt_range(void *addr, unsigned long length);
1290 
1291 /* DMA support (drm_dma.c) */
1292 int	drm_dma(struct drm_device *dev, void *data, struct drm_file *file_priv);
1293 
1294 				/* Stub support (drm_stub.h) */
1295 
1296 extern void drm_put_dev(struct drm_device *dev);
1297 extern void drm_unplug_dev(struct drm_device *dev);
1298 extern unsigned int drm_debug;
1299 extern bool drm_atomic;
1300 
1301 /* Scatter Gather Support (drm_scatter.c) */
1302 int	drm_sg_alloc_ioctl(struct drm_device *dev, void *data,
1303 			   struct drm_file *file_priv);
1304 int	drm_sg_free(struct drm_device *dev, void *data,
1305 		    struct drm_file *file_priv);
1306 
1307 /* consistent PCI memory functions (drm_pci.c) */
1308 extern drm_dma_handle_t *drm_pci_alloc(struct drm_device *dev, size_t size,
1309 				       size_t align);
1310 void	drm_pci_free(struct drm_device *dev, drm_dma_handle_t *dmah);
1311 
1312 			       /* sysfs support (drm_sysfs.c) */
1313 extern void drm_sysfs_hotplug_event(struct drm_device *dev);
1314 
1315 int drm_gem_mmap_single(struct drm_device *dev, vm_ooffset_t *offset,
1316     vm_size_t size, struct vm_object **obj_res, int nprot);
1317 void drm_gem_pager_dtr(void *obj);
1318 
1319 struct ttm_bo_device;
1320 int ttm_bo_mmap_single(struct ttm_bo_device *bdev, vm_ooffset_t *offset,
1321     vm_size_t size, struct vm_object **obj_res, int nprot);
1322 struct ttm_buffer_object;
1323 void ttm_bo_release_mmap(struct ttm_buffer_object *bo);
1324 
1325 void drm_device_lock_mtx(struct drm_device *dev);
1326 void drm_device_unlock_mtx(struct drm_device *dev);
1327 int drm_device_sleep_mtx(struct drm_device *dev, void *chan, int flags,
1328     const char *msg, int timeout);
1329 void drm_device_assert_mtx_locked(struct drm_device *dev);
1330 void drm_device_assert_mtx_unlocked(struct drm_device *dev);
1331 
1332 void drm_device_lock_struct(struct drm_device *dev);
1333 void drm_device_unlock_struct(struct drm_device *dev);
1334 int drm_device_sleep_struct(struct drm_device *dev, void *chan, int flags,
1335     const char *msg, int timeout);
1336 void drm_device_assert_struct_locked(struct drm_device *dev);
1337 void drm_device_assert_struct_unlocked(struct drm_device *dev);
1338 
1339 void drm_compat_locking_init(struct drm_device *dev);
1340 void drm_sleep_locking_init(struct drm_device *dev);
1341 
1342 /* XXX glue logic, should be done in drm_pci_init(), pending drm update */
1343 void drm_init_pdev(struct device *dev, struct pci_dev **pdev);
1344 void drm_fini_pdev(struct pci_dev **pdev);
1345 
1346 /* Inline replacements for drm_alloc and friends */
1347 static __inline__ void *
1348 drm_alloc(size_t size, struct malloc_type *area)
1349 {
1350 	return kmalloc(size, area, M_WAITOK | M_NULLOK);
1351 }
1352 
1353 static __inline__ void *
1354 drm_calloc(size_t nmemb, size_t size, struct malloc_type *area)
1355 {
1356 	return kmalloc(size * nmemb, area, M_WAITOK | M_NULLOK | M_ZERO);
1357 }
1358 
1359 static __inline__ void
1360 drm_free(void *pt, struct malloc_type *area)
1361 {
1362 	/* kfree is special!!! */
1363 	if (pt != NULL)
1364 		(kfree)(pt, area);
1365 }
1366 
1367 static __inline__ void
1368 drm_core_ioremap_wc(struct drm_local_map *map, struct drm_device *dev)
1369 {
1370 	map->handle = drm_ioremap_wc(dev, map);
1371 }
1372 static __inline__ void
1373 drm_core_ioremap(struct drm_local_map *map, struct drm_device *dev)
1374 {
1375 	map->handle = drm_ioremap(dev, map);
1376 }
1377 static __inline__ void
1378 drm_core_ioremapfree(struct drm_local_map *map, struct drm_device *dev)
1379 {
1380 	if ( map->handle && map->size )
1381 		drm_ioremapfree(map);
1382 }
1383 
1384 static __inline__ struct drm_local_map *
1385 drm_core_findmap(struct drm_device *dev, unsigned long offset)
1386 {
1387 	struct drm_map_list *_entry;
1388 
1389 	list_for_each_entry(_entry, &dev->maplist, head) {
1390 		if (offset == (unsigned long)_entry->map->handle)
1391 			return _entry->map;
1392 	}
1393 	return NULL;
1394 }
1395 
1396 static __inline__ void drm_core_dropmap(struct drm_map *map)
1397 {
1398 }
1399 
1400 #include <drm/drm_mem_util.h>
1401 
1402 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
1403 				 struct device *parent);
1404 void drm_dev_ref(struct drm_device *dev);
1405 void drm_dev_unref(struct drm_device *dev);
1406 int drm_dev_register(struct drm_device *dev, unsigned long flags);
1407 void drm_dev_unregister(struct drm_device *dev);
1408 int drm_dev_set_unique(struct drm_device *dev, const char *fmt, ...);
1409 
1410 /* FreeBSD compatibility macros */
1411 #define VM_OBJECT_WLOCK(object)		VM_OBJECT_LOCK(object)
1412 #define VM_OBJECT_WUNLOCK(object)	VM_OBJECT_UNLOCK(object)
1413 
1414 #define DRM_PCIE_SPEED_25 1
1415 #define DRM_PCIE_SPEED_50 2
1416 #define DRM_PCIE_SPEED_80 4
1417 
1418 extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
1419 
1420 /* XXX bad */
1421 #define	drm_can_sleep()	(HZ & 1)
1422 
1423 #endif /* __KERNEL__ */
1424 #endif /* _DRM_P_H_ */
1425