xref: /dragonfly/sys/dev/drm/include/drm/drmP.h (revision 38b5d46c)
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/mutex.h>
84 
85 #include <linux/atomic.h>
86 #include <linux/bug.h>
87 #include <linux/dma-mapping.h>
88 #include <linux/capability.h>
89 #include <linux/err.h>
90 #include <linux/idr.h>
91 #include <linux/pci.h>
92 #include <linux/jiffies.h>
93 #include <linux/kernel.h>
94 #include <linux/fs.h>
95 #include <linux/kref.h>
96 #include <linux/list.h>
97 #include <linux/mm.h>
98 #include <linux/moduleparam.h>
99 #include <linux/mutex.h>
100 #include <linux/pci.h>
101 #include <linux/slab.h>
102 #include <linux/scatterlist.h>
103 #include <linux/timer.h>
104 #include <asm/io.h>
105 #include <linux/seq_file.h>
106 #include <linux/types.h>
107 #include <linux/vmalloc.h>
108 #include <linux/wait.h>
109 #include <linux/workqueue.h>
110 
111 #include <asm/uaccess.h>
112 
113 #include <uapi_drm/drm.h>
114 #include <uapi_drm/drm_mode.h>
115 
116 #include <drm/drm_agpsupport.h>
117 #include <drm/drm_crtc.h>
118 #include <drm/drm_global.h>
119 #include <drm/drm_hashtab.h>
120 #include <drm/drm_mem_util.h>
121 #include <drm/drm_mm.h>
122 #include <drm/drm_os_linux.h>
123 #include <uapi_drm/drm_sarea.h>
124 #include <drm/drm_vma_manager.h>
125 
126 struct drm_file;
127 struct drm_device;
128 struct drm_agp_head;
129 struct drm_local_map;
130 struct drm_device_dma;
131 struct drm_dma_handle;
132 struct drm_gem_object;
133 
134 struct device_node;
135 #ifdef CONFIG_VIDEOMODE_HELPERS
136 struct videomode;	/* XXX empty struct in videomode.h ? */
137 #endif
138 struct reservation_object;
139 struct dma_buf_attachment;
140 
141 /*
142  * 4 debug categories are defined:
143  *
144  * CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c, drm_memory.c, ...
145  *	 This is the category used by the DRM_DEBUG() macro.
146  *
147  * DRIVER: Used in the vendor specific part of the driver: i915, radeon, ...
148  *	   This is the category used by the DRM_DEBUG_DRIVER() macro.
149  *
150  * KMS: used in the modesetting code.
151  *	This is the category used by the DRM_DEBUG_KMS() macro.
152  *
153  * PRIME: used in the prime code.
154  *	  This is the category used by the DRM_DEBUG_PRIME() macro.
155  *
156  * ATOMIC: used in the atomic code.
157  *	  This is the category used by the DRM_DEBUG_ATOMIC() macro.
158  *
159  *
160  * PID: used as modifier to include PID number in messages.
161  *	  This is the category used by the all debug macros.
162  *
163  * FIOCTL: used in failed ioctl debugging.
164  *	  This is the category used by the DRM_DEBUG_FIOCTL() macro.
165  *
166  * IOCTL: used in ioctl debugging.
167  *	  This is the category used by the DRM_DEBUG_IOCTL() macro.
168  *
169  * VBLANK: used in vblank debugging.
170  *	  This is the category used by the DRM_DEBUG_VBLANK() macro.
171  *
172  * Enabling verbose debug messages is done through the drm.debug parameter,
173  * each category being enabled by a bit.
174  *
175  * drm.debug=0x1 will enable CORE messages
176  * drm.debug=0x2 will enable DRIVER messages
177  * drm.debug=0x3 will enable CORE and DRIVER messages
178  * ...
179  * drm.debug=0xf will enable all messages
180  *
181  * An interesting feature is that it's possible to enable verbose logging at
182  * run-time by using hw.drm.debug sysctl variable:
183  *   # sysctl hw.drm.debug=0xfff
184  */
185 #define DRM_UT_CORE		0x01
186 #define DRM_UT_DRIVER		0x02
187 #define DRM_UT_KMS		0x04
188 #define DRM_UT_PRIME		0x08
189 #define DRM_UT_ATOMIC		0x10
190 #define DRM_UT_VBL		0x20
191 /* Extra DragonFly debug categories */
192 #ifdef __DragonFly__
193 #define DRM_UT_RES7		0x40	/* reserved for future expansion */
194 #define DRM_UT_RES8		0x80	/* reserved for future expansion */
195 #define DRM_UT_PID		0x100
196 #define DRM_UT_FIOCTL		0x200
197 #define DRM_UT_IOCTL		0x400
198 #define DRM_UT_VBLANK		0x800
199 #endif
200 
201 extern __printflike(2, 3)
202 void drm_ut_debug_printk(const char *function_name,
203 			 const char *format, ...);
204 extern __printflike(2, 3)
205 void drm_err(const char *func, const char *format, ...);
206 
207 /***********************************************************************/
208 /** \name DRM template customization defaults */
209 /*@{*/
210 
211 /* driver capabilities and requirements mask */
212 #define DRIVER_USE_AGP			0x1
213 #define DRIVER_PCI_DMA			0x8
214 #define DRIVER_SG			0x10
215 #define DRIVER_HAVE_DMA			0x20
216 #define DRIVER_HAVE_IRQ			0x40
217 #define DRIVER_IRQ_SHARED		0x80
218 #define DRIVER_GEM			0x1000
219 #define DRIVER_MODESET			0x2000
220 #define DRIVER_PRIME			0x4000
221 #define DRIVER_RENDER			0x8000
222 #define DRIVER_ATOMIC			0x10000
223 #define DRIVER_KMS_LEGACY_CONTEXT	0x20000
224 
225 #define DRM_MAGIC_HASH_ORDER  4  /**< Size of key hash table. Must be power of 2. */
226 
227 /***********************************************************************/
228 /** \name Macros to make printk easier */
229 /*@{*/
230 
231 /**
232  * Error output.
233  *
234  * \param fmt printf() like format string.
235  * \param arg arguments
236  */
237 #define DRM_ERROR(fmt, ...)				\
238 	drm_err(__func__, fmt, ##__VA_ARGS__)
239 
240 /**
241  * Rate limited error output.  Like DRM_ERROR() but won't flood the log.
242  *
243  * \param fmt printf() like format string.
244  * \param arg arguments
245  */
246 #define DRM_ERROR_RATELIMITED(fmt, ...)				\
247 ({									\
248 	static struct krate krate_derr = { .freq = 1, .count = -16 };	\
249 									\
250 	krateprintf(&krate_derr, "error: [" DRM_NAME ":%s] *ERROR* "	\
251 	    fmt, __func__, ##__VA_ARGS__);				\
252 })
253 
254 #define DRM_INFO(fmt, ...)				\
255 	printk(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
256 
257 #define DRM_INFO_ONCE(fmt, ...)				\
258 	printk_once(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
259 
260 /**
261  * Debug output.
262  *
263  * \param fmt printf() like format string.
264  * \param arg arguments
265  */
266 #define DRM_DEBUG(fmt, args...)						\
267 	do {								\
268 		if (unlikely(drm_debug & DRM_UT_CORE))			\
269 			drm_ut_debug_printk(__func__, fmt, ##args);	\
270 	} while (0)
271 
272 #define DRM_DEBUG_DRIVER(fmt, args...)					\
273 	do {								\
274 		if (unlikely(drm_debug & DRM_UT_DRIVER))		\
275 			drm_ut_debug_printk(__func__, fmt, ##args);	\
276 	} while (0)
277 #define DRM_DEBUG_KMS(fmt, args...)					\
278 	do {								\
279 		if (unlikely(drm_debug & DRM_UT_KMS))			\
280 			drm_ut_debug_printk(__func__, fmt, ##args);	\
281 	} while (0)
282 #define DRM_DEBUG_PRIME(fmt, args...)					\
283 	do {								\
284 		if (unlikely(drm_debug & DRM_UT_PRIME))			\
285 			drm_ut_debug_printk(__func__, fmt, ##args);	\
286 	} while (0)
287 #define DRM_DEBUG_ATOMIC(fmt, args...)					\
288 	do {								\
289 		if (unlikely(drm_debug & DRM_UT_ATOMIC))		\
290 			drm_ut_debug_printk(__func__, fmt, ##args);	\
291 	} while (0)
292 
293 #ifdef __DragonFly__
294 #define DRM_DEBUG_FIOCTL(fmt, args...)					\
295 	do {								\
296 		if (unlikely(drm_debug & DRM_UT_FIOCTL))		\
297 			drm_ut_debug_printk(__func__, fmt, ##args);	\
298 	} while (0)
299 #define DRM_DEBUG_IOCTL(fmt, args...)					\
300 	do {								\
301 		if (unlikely(drm_debug & DRM_UT_IOCTL))			\
302 			drm_ut_debug_printk(__func__, fmt, ##args);	\
303 	} while (0)
304 #define DRM_DEBUG_VBLANK(fmt, args...)					\
305 	do {								\
306 		if (unlikely(drm_debug & DRM_UT_VBLANK))		\
307 			drm_ut_debug_printk(__func__, fmt, ##args);	\
308 	} while (0)
309 #define DRM_DEBUG_VBL(fmt, args...)					\
310 	do {								\
311 		if (unlikely(drm_debug & DRM_UT_VBL))		\
312 			drm_ut_debug_printk(__func__, fmt, ##args);	\
313 	} while (0)
314 #endif
315 
316 /*@}*/
317 
318 /***********************************************************************/
319 /** \name Internal types and structures */
320 /*@{*/
321 
322 SYSCTL_DECL(_hw_drm);
323 
324 #define DRM_MAX(a,b) ((a)>(b)?(a):(b))
325 
326 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
327 
328 #define DRM_DEV_MODE	(S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP)
329 #define DRM_DEV_UID	UID_ROOT
330 #define DRM_DEV_GID	GID_WHEEL
331 
332 #define DRM_CURPROC		curthread
333 #define DRM_STRUCTPROC		struct thread
334 #define DRM_LOCK(dev)		lockmgr(&(dev)->struct_mutex, LK_EXCLUSIVE)
335 #define DRM_UNLOCK(dev)		lockmgr(&(dev)->struct_mutex, LK_RELEASE)
336 #define	DRM_LOCK_SLEEP(dev, chan, flags, msg, timeout)			\
337     (lksleep((chan), &(dev)->struct_mutex, (flags), (msg), (timeout)))
338 #if defined(INVARIANTS)
339 #define	DRM_LOCK_ASSERT(dev)	KKASSERT(lockstatus(&(dev)->struct_mutex, curthread) != 0);
340 #define	DRM_UNLOCK_ASSERT(dev)	KKASSERT(lockstatus(&(dev)->struct_mutex, curthread) == 0);
341 #else
342 #define	DRM_LOCK_ASSERT(d)
343 #define	DRM_UNLOCK_ASSERT(d)
344 #endif
345 
346 #define DRM_SYSCTL_HANDLER_ARGS	(SYSCTL_HANDLER_ARGS)
347 
348 typedef void			irqreturn_t;
349 #define IRQ_HANDLED		/* nothing */
350 #define IRQ_NONE		/* nothing */
351 
352 #define drm_get_device_from_kdev(_kdev) (_kdev->si_drv1)
353 
354 #define DRM_MTRR_WC		MDF_WRITECOMBINE
355 
356 int vm_phys_fictitious_reg_range(vm_paddr_t start, vm_paddr_t end,
357     vm_memattr_t memattr);
358 void vm_phys_fictitious_unreg_range(vm_paddr_t start, vm_paddr_t end);
359 vm_page_t vm_phys_fictitious_to_vm_page(vm_paddr_t pa);
360 
361 /* drm_memory.c */
362 int	drm_mtrr_add(unsigned long offset, size_t size, int flags);
363 int	drm_mtrr_del(int handle, unsigned long offset, size_t size, int flags);
364 
365 typedef struct drm_pci_id_list
366 {
367 	int vendor;
368 	int device;
369 	long driver_private;
370 	char *name;
371 } drm_pci_id_list_t;
372 
373 /**
374  * Ioctl function type.
375  *
376  * \param inode device inode.
377  * \param file_priv DRM file private pointer.
378  * \param cmd command.
379  * \param arg argument.
380  */
381 typedef int drm_ioctl_t(struct drm_device *dev, void *data,
382 			struct drm_file *file_priv);
383 
384 typedef int drm_ioctl_compat_t(struct file *filp, unsigned int cmd,
385 			       unsigned long arg);
386 
387 #define DRM_IOCTL_NR(n)                ((n) & 0xff)
388 
389 #define DRM_AUTH	0x1
390 #define DRM_MASTER	0x2
391 #define DRM_ROOT_ONLY	0x4
392 #define DRM_CONTROL_ALLOW 0x8
393 #define DRM_UNLOCKED	0x10
394 #define DRM_RENDER_ALLOW 0x20
395 
396 struct drm_ioctl_desc {
397 	unsigned int cmd;
398 	int flags;
399 	drm_ioctl_t *func;
400 	unsigned int cmd_drv;
401 	const char *name;
402 };
403 
404 /**
405  * Creates a driver or general drm_ioctl_desc array entry for the given
406  * ioctl, for use by drm_ioctl().
407  */
408 
409 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags)				\
410 	[DRM_IOCTL_NR(DRM_##ioctl)] = {					\
411 		.cmd = DRM_##ioctl,					\
412 		.func = _func,						\
413 		.flags = _flags,					\
414 		.cmd_drv = DRM_IOCTL_##ioctl,				\
415 		.name = #ioctl						\
416 	}
417 
418 typedef struct drm_magic_entry {
419 	struct list_head head;
420 	struct drm_hash_item hash_item;
421 	struct drm_file	       *priv;
422 	struct drm_magic_entry *next;
423 } drm_magic_entry_t;
424 
425 /* Event queued up for userspace to read */
426 struct drm_pending_event {
427 	struct drm_event *event;
428 	struct list_head link;
429 	struct drm_file *file_priv;
430 	pid_t pid; /* pid of requester, no guarantee it's valid by the time
431 		      we deliver the event, for tracing only */
432 	void (*destroy)(struct drm_pending_event *event);
433 };
434 
435 /* initial implementaton using a linked list - todo hashtab */
436 struct drm_prime_file_private {
437 	struct list_head head;
438 #ifdef DUMBBELL_WIP
439 	struct mutex lock;
440 #endif /* DUMBBELL_WIP */
441 };
442 
443 /** File private data */
444 struct drm_file {
445 	int authenticated;
446 	struct drm_device *dev;
447 	int		  master;
448 
449 	/* true when the client has asked us to expose stereo 3D mode flags */
450 	bool stereo_allowed;
451 	/*
452 	 * true if client understands CRTC primary planes and cursor planes
453 	 * in the plane list
454 	 */
455 	unsigned universal_planes:1;
456 	/* true if client understands atomic properties */
457 	unsigned atomic:1;
458 
459 	pid_t		  pid;
460 	uid_t		  uid;
461 	drm_magic_t	  magic;
462 	unsigned long	  ioctl_count;
463 	struct list_head lhead;
464 	struct kqinfo	  dkq;
465 
466 	/** Mapping of mm object handles to object pointers. */
467 	struct idr object_idr;
468 	/** Lock for synchronization of access to object_idr. */
469 	struct lock table_lock;
470 
471 	void *driver_priv;
472 
473 	int		  is_master;
474 	struct drm_master *masterp;
475 
476 	/**
477 	 * fbs - List of framebuffers associated with this file.
478 	 *
479 	 * Protected by fbs_lock. Note that the fbs list holds a reference on
480 	 * the fb object to prevent it from untimely disappearing.
481 	 */
482 	struct list_head fbs;
483 	struct lock fbs_lock;
484 
485 	/** User-created blob properties; this retains a reference on the
486 	 *  property. */
487 	struct list_head blobs;
488 
489 	wait_queue_head_t event_wait;
490 	struct list_head event_list;
491 	int event_space;
492 
493 	struct drm_prime_file_private prime;
494 };
495 
496 /**
497  * Lock data.
498  */
499 struct drm_lock_data {
500 	struct drm_hw_lock *hw_lock;	/**< Hardware lock */
501 	/** Private of lock holder's file (NULL=kernel) */
502 	struct drm_file *file_priv;
503 	wait_queue_head_t lock_queue;	/**< Queue of blocked processes */
504 	unsigned long lock_time;	/**< Time of last lock in jiffies */
505 };
506 
507 /**
508  * GEM specific mm private for tracking GEM objects
509  */
510 struct drm_gem_mm {
511 	struct drm_vma_offset_manager vma_manager;
512 	struct drm_mm offset_manager;	/**< Offset mgmt for buffer objects */
513 	struct drm_open_hash offset_hash; /**< User token hash table for maps */
514 	struct unrhdr *idxunr;
515 };
516 
517 /**
518  * struct drm_master - drm master structure
519  *
520  * @refcount: Refcount for this master object.
521  * @minor: Link back to minor char device we are master for. Immutable.
522  * @unique: Unique identifier: e.g. busid. Protected by drm_global_mutex.
523  * @unique_len: Length of unique field. Protected by drm_global_mutex.
524  * @unique_size: Amount allocated. Protected by drm_global_mutex.
525  * @magiclist: Hash of used authentication tokens. Protected by struct_mutex.
526  * @magicfree: List of used authentication tokens. Protected by struct_mutex.
527  * @lock: DRI lock information.
528  * @driver_priv: Pointer to driver-private information.
529  */
530 struct drm_master {
531 	struct kref refcount;		/* refcount for this master */
532 	struct list_head head;		/**< each minor contains a list of masters */
533 	struct drm_minor *minor;	/**< link back to minor we are a master for */
534 	char *unique;			/**< Unique identifier: e.g., busid */
535 	int unique_len;			/**< Length of unique field */
536 	int unique_size;		/**< amount allocated */
537 	int blocked;			/**< Blocked due to VC switch? */
538 	struct drm_open_hash magiclist;
539 	struct list_head magicfree;
540 	struct drm_lock_data lock;
541 	void *driver_priv;
542 };
543 
544 /* Size of ringbuffer for vblank timestamps. Just double-buffer
545  * in initial implementation.
546  */
547 #define DRM_VBLANKTIME_RBSIZE 2
548 
549 /* Flags and return codes for get_vblank_timestamp() driver function. */
550 #define DRM_CALLED_FROM_VBLIRQ 1
551 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
552 #define DRM_VBLANKTIME_IN_VBLANK         (1 << 1)
553 
554 /* get_scanout_position() return flags */
555 #define DRM_SCANOUTPOS_VALID        (1 << 0)
556 #define DRM_SCANOUTPOS_IN_VBLANK    (1 << 1)
557 #define DRM_SCANOUTPOS_ACCURATE     (1 << 2)
558 
559 /**
560  * DRM driver structure. This structure represent the common code for
561  * a family of cards. There will one drm_device for each card present
562  * in this family
563  */
564 struct drm_driver {
565 	int (*load) (struct drm_device *, unsigned long flags);
566 	int (*use_msi) (struct drm_device *, unsigned long flags);
567 	int (*firstopen) (struct drm_device *);
568 	int (*open) (struct drm_device *, struct drm_file *);
569 	void (*preclose) (struct drm_device *, struct drm_file *file_priv);
570 	void (*postclose) (struct drm_device *, struct drm_file *);
571 	void (*lastclose) (struct drm_device *);
572 	int (*unload) (struct drm_device *);
573 	void (*reclaim_buffers_locked) (struct drm_device *,
574 					struct drm_file *file_priv);
575 	int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
576 	int (*dma_quiescent) (struct drm_device *);
577 	int (*context_ctor) (struct drm_device *dev, int context);
578 	int (*context_dtor) (struct drm_device *dev, int context);
579 
580 	/**
581 	 * get_vblank_counter - get raw hardware vblank counter
582 	 * @dev: DRM device
583 	 * @pipe: counter to fetch
584 	 *
585 	 * Driver callback for fetching a raw hardware vblank counter for @crtc.
586 	 * If a device doesn't have a hardware counter, the driver can simply
587 	 * return the value of drm_vblank_count. The DRM core will account for
588 	 * missed vblank events while interrupts where disabled based on system
589 	 * timestamps.
590 	 *
591 	 * Wraparound handling and loss of events due to modesetting is dealt
592 	 * with in the DRM core code.
593 	 *
594 	 * RETURNS
595 	 * Raw vblank counter value.
596 	 */
597 	u32 (*get_vblank_counter) (struct drm_device *dev, unsigned int pipe);
598 
599 	/**
600 	 * enable_vblank - enable vblank interrupt events
601 	 * @dev: DRM device
602 	 * @pipe: which irq to enable
603 	 *
604 	 * Enable vblank interrupts for @crtc.  If the device doesn't have
605 	 * a hardware vblank counter, this routine should be a no-op, since
606 	 * interrupts will have to stay on to keep the count accurate.
607 	 *
608 	 * RETURNS
609 	 * Zero on success, appropriate errno if the given @crtc's vblank
610 	 * interrupt cannot be enabled.
611 	 */
612 	int (*enable_vblank) (struct drm_device *dev, unsigned int pipe);
613 
614 	/**
615 	 * disable_vblank - disable vblank interrupt events
616 	 * @dev: DRM device
617 	 * @pipe: which irq to enable
618 	 *
619 	 * Disable vblank interrupts for @crtc.  If the device doesn't have
620 	 * a hardware vblank counter, this routine should be a no-op, since
621 	 * interrupts will have to stay on to keep the count accurate.
622 	 */
623 	void (*disable_vblank) (struct drm_device *dev, unsigned int pipe);
624 
625 	/**
626 	 * Called by \c drm_device_is_agp.  Typically used to determine if a
627 	 * card is really attached to AGP or not.
628 	 *
629 	 * \param dev  DRM device handle
630 	 *
631 	 * \returns
632 	 * One of three values is returned depending on whether or not the
633 	 * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
634 	 * (return of 1), or may or may not be AGP (return of 2).
635 	 */
636 	int (*device_is_agp) (struct drm_device *dev);
637 
638 	/**
639 	 * Called by vblank timestamping code.
640 	 *
641 	 * Return the current display scanout position from a crtc, and an
642 	 * optional accurate ktime_get timestamp of when position was measured.
643 	 *
644 	 * \param dev  DRM device.
645 	 * \param pipe Id of the crtc to query.
646 	 * \param flags Flags from the caller (DRM_CALLED_FROM_VBLIRQ or 0).
647 	 * \param *vpos Target location for current vertical scanout position.
648 	 * \param *hpos Target location for current horizontal scanout position.
649 	 * \param *stime Target location for timestamp taken immediately before
650 	 *               scanout position query. Can be NULL to skip timestamp.
651 	 * \param *etime Target location for timestamp taken immediately after
652 	 *               scanout position query. Can be NULL to skip timestamp.
653 	 *
654 	 * Returns vpos as a positive number while in active scanout area.
655 	 * Returns vpos as a negative number inside vblank, counting the number
656 	 * of scanlines to go until end of vblank, e.g., -1 means "one scanline
657 	 * until start of active scanout / end of vblank."
658 	 *
659 	 * \return Flags, or'ed together as follows:
660 	 *
661 	 * DRM_SCANOUTPOS_VALID = Query successful.
662 	 * DRM_SCANOUTPOS_INVBL = Inside vblank.
663 	 * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
664 	 * this flag means that returned position may be offset by a constant
665 	 * but unknown small number of scanlines wrt. real scanout position.
666 	 *
667 	 */
668 	int (*get_scanout_position) (struct drm_device *dev, unsigned int pipe,
669 				     unsigned int flags, int *vpos, int *hpos,
670 				     ktime_t *stime, ktime_t *etime,
671 				     const struct drm_display_mode *mode);
672 
673 	/**
674 	 * Called by \c drm_get_last_vbltimestamp. Should return a precise
675 	 * timestamp when the most recent VBLANK interval ended or will end.
676 	 *
677 	 * Specifically, the timestamp in @vblank_time should correspond as
678 	 * closely as possible to the time when the first video scanline of
679 	 * the video frame after the end of VBLANK will start scanning out,
680 	 * the time immediately after end of the VBLANK interval. If the
681 	 * @crtc is currently inside VBLANK, this will be a time in the future.
682 	 * If the @crtc is currently scanning out a frame, this will be the
683 	 * past start time of the current scanout. This is meant to adhere
684 	 * to the OpenML OML_sync_control extension specification.
685 	 *
686 	 * \param dev dev DRM device handle.
687 	 * \param pipe crtc for which timestamp should be returned.
688 	 * \param *max_error Maximum allowable timestamp error in nanoseconds.
689 	 *                   Implementation should strive to provide timestamp
690 	 *                   with an error of at most *max_error nanoseconds.
691 	 *                   Returns true upper bound on error for timestamp.
692 	 * \param *vblank_time Target location for returned vblank timestamp.
693 	 * \param flags 0 = Defaults, no special treatment needed.
694 	 * \param       DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
695 	 *	        irq handler. Some drivers need to apply some workarounds
696 	 *              for gpu-specific vblank irq quirks if flag is set.
697 	 *
698 	 * \returns
699 	 * Zero if timestamping isn't supported in current display mode or a
700 	 * negative number on failure. A positive status code on success,
701 	 * which describes how the vblank_time timestamp was computed.
702 	 */
703 	int (*get_vblank_timestamp) (struct drm_device *dev, unsigned int pipe,
704 				     int *max_error,
705 				     struct timeval *vblank_time,
706 				     unsigned flags);
707 
708 	/* these have to be filled in */
709 
710 	void (*irq_handler) (void *arg);
711 	void (*irq_preinstall) (struct drm_device *dev);
712 	int (*irq_postinstall) (struct drm_device *dev);
713 	void (*irq_uninstall) (struct drm_device *dev);
714 
715 	/**
716 	 * Driver-specific constructor for drm_gem_objects, to set up
717 	 * obj->driver_private.
718 	 *
719 	 * Returns 0 on success.
720 	 */
721 	void (*gem_free_object) (struct drm_gem_object *obj);
722 	int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
723 	void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
724 
725 	int (*sysctl_init) (struct drm_device *dev,
726 		    struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
727 	void (*sysctl_cleanup) (struct drm_device *dev);
728 
729 	drm_pci_id_list_t *id_entry;	/* PCI ID, name, and chipset private */
730 
731 	/* dumb alloc support */
732 	int (*dumb_create)(struct drm_file *file_priv,
733 			   struct drm_device *dev,
734 			   struct drm_mode_create_dumb *args);
735 	int (*dumb_map_offset)(struct drm_file *file_priv,
736 			       struct drm_device *dev, uint32_t handle,
737 			       uint64_t *offset);
738 	int (*dumb_destroy)(struct drm_file *file_priv,
739 			    struct drm_device *dev,
740 			    uint32_t handle);
741 
742 	/* Driver private ops for this object */
743 	struct cdev_pager_ops *gem_pager_ops;
744 
745 	int major;
746 	int minor;
747 	int patchlevel;
748 	const char *name;		/* Simple driver name		   */
749 	const char *desc;		/* Longer driver name		   */
750 	const char *date;		/* Date of last major changes.	   */
751 
752 	u32 driver_features;
753 	int dev_priv_size;
754 	const struct drm_ioctl_desc *ioctls;
755 	int num_ioctls;
756 };
757 
758 /**
759  * Info file list entry. This structure represents a debugfs or proc file to
760  * be created by the drm core
761  */
762 struct drm_info_list {
763 	const char *name; /** file name */
764 	int (*show)(struct seq_file*, void*); /** show callback */
765 	u32 driver_features; /**< Required driver features for this entry */
766 	void *data;
767 };
768 
769 /**
770  * debugfs node structure. This structure represents a debugfs file.
771  */
772 struct drm_info_node {
773 	struct list_head list;
774 	struct drm_minor *minor;
775 	const struct drm_info_list *info_ent;
776 	struct dentry *dent;
777 };
778 
779 /**
780  * DRM minor structure. This structure represents a drm minor number.
781  */
782 struct drm_minor {
783 	int index;			/**< Minor device number */
784 	int type;                       /**< Control or render */
785 	device_t kdev;			/**< OS device */
786 	struct drm_device *dev;
787 
788 	/* currently active master for this node. Protected by master_mutex */
789 	struct drm_master *master;
790 };
791 
792 struct drm_pending_vblank_event {
793 	struct drm_pending_event base;
794 	unsigned int pipe;
795 	struct drm_event_vblank event;
796 };
797 
798 struct drm_vblank_crtc {
799 	struct drm_device *dev;		/* pointer to the drm_device */
800 	wait_queue_head_t queue;	/**< VBLANK wait queue */
801 	struct timer_list disable_timer;		/* delayed disable timer */
802 
803 	/* vblank counter, protected by dev->vblank_time_lock for writes */
804 	u32 count;
805 	/* vblank timestamps, protected by dev->vblank_time_lock for writes */
806 	struct timeval time[DRM_VBLANKTIME_RBSIZE];
807 
808 	atomic_t refcount;		/* number of users of vblank interruptsper crtc */
809 	u32 last;			/* protected by dev->vbl_lock, used */
810 					/* for wraparound handling */
811 	u32 last_wait;			/* Last vblank seqno waited per CRTC */
812 	unsigned int inmodeset;		/* Display driver is setting mode */
813 	unsigned int pipe;		/* crtc index */
814 	int framedur_ns;		/* frame/field duration in ns */
815 	int linedur_ns;			/* line duration in ns */
816 	int pixeldur_ns;		/* pixel duration in ns */
817 	bool enabled;			/* so we don't call enable more than
818 					   once per disable */
819 };
820 
821 struct drm_sysctl_info {
822 	struct sysctl_ctx_list ctx;
823 	char   name[2];
824 };
825 
826 /* Length for the array of resource pointers for drm_get_resource_*. */
827 #define DRM_MAX_PCI_RESOURCE	6
828 
829 /**
830  * DRM device structure. This structure represent a complete card that
831  * may contain multiple heads.
832  */
833 struct drm_device {
834 	drm_pci_id_list_t *id_entry;	/* PCI ID, name, and chipset private */
835 
836 	char		  *unique;	/* Unique identifier: e.g., busid  */
837 	int		  unique_len;	/* Length of unique field	   */
838 	struct cdev	  *devnode;	/* Device number for mknod	   */
839 	int		  if_version;	/* Highest interface version set */
840 
841 	int		  flags;	/* Flags to open(2)		   */
842 
843 				/* Locks */
844 	struct spinlock	  dma_lock;	/* protects dev->dma */
845 	struct lwkt_serialize irq_lock;	/* protects irq condition checks */
846 	struct lock	  dev_lock;	/* protects everything else */
847 
848 	/** \name Locks */
849 	/*@{ */
850 	struct lock struct_mutex;	/**< For others */
851 	struct lock master_mutex;	/**< For drm_minor::master */
852 	/*@} */
853 
854 	/** \name Usage Counters */
855 	/*@{ */
856 	int open_count;			/**< Outstanding files open, protected by drm_global_mutex. */
857 	struct spinlock buf_lock;	/**< For drm_device::buf_use and a few other things. */
858 	int buf_use;			/**< Buffers in use -- cannot alloc */
859 	atomic_t buf_alloc;		/**< Buffer allocation in progress */
860 	/*@} */
861 
862 
863 	/** \name Performance counters */
864 	/*@{ */
865 	unsigned long     counters;
866 	enum drm_stat_type	types[15];
867 	atomic_t          counts[15];
868 	/*@} */
869 
870 				/* Authentication */
871 	struct drm_open_hash magiclist;	/**< magic hash table */
872 	struct list_head magicfree;
873 
874 	struct list_head filelist;
875 
876 	/** \name Memory management */
877 	/*@{ */
878 	struct list_head maplist;	/**< Linked list of regions */
879 	int map_count;			/**< Number of mappable regions */
880 	struct drm_open_hash map_hash;	/**< User token hash table for maps */
881 
882 	/** \name Context handle management */
883 	/*@{ */
884 	struct list_head ctxlist;	/**< Linked list of context handles */
885 	int ctx_count;			/**< Number of context handles */
886 	struct lock ctxlist_mutex;	/**< For ctxlist */
887 
888 	struct idr ctx_idr;
889 
890 	/*@} */
891 
892 	struct drm_lock_data lock;	/* Information on hardware lock	   */
893 
894 	/** \name DMA support */
895 	/*@{ */
896 	struct drm_device_dma *dma;		/**< Optional pointer for DMA support */
897 	/*@} */
898 
899 	int		  irq_type;	/* IRQ type (MSI enabled or not) */
900 	int		  irqrid;	/* Interrupt used by board */
901 	struct resource   *irqr;	/* Resource for interrupt used by board	   */
902 	void		  *irqh;	/* Handle from bus_setup_intr      */
903 
904 	/* Storage of resource pointers for drm_get_resource_* */
905 	struct resource   *pcir[DRM_MAX_PCI_RESOURCE];
906 	int		  pcirid[DRM_MAX_PCI_RESOURCE];
907 
908 	int		  pci_domain;
909 	int		  pci_bus;
910 	int		  pci_slot;
911 	int		  pci_func;
912 
913 	/** \name Context support */
914 	/*@{ */
915 
916 	__volatile__ long context_flag;	/**< Context swapping flag */
917 	__volatile__ long interrupt_flag; /**< Interruption handler flag */
918 	__volatile__ long dma_flag;	/**< DMA dispatch flag */
919 	wait_queue_head_t context_wait;	/**< Processes waiting on ctx switch */
920 	int last_checked;		/**< Last context checked for DMA */
921 	int last_context;		/**< Last current context */
922 	unsigned long last_switch;	/**< jiffies at last context switch */
923 	/*@} */
924 
925 	/** \name VBLANK IRQ support */
926 	/*@{ */
927 	int irq_enabled;		/**< True if irq handler is enabled */
928 	int irq;			/* Interrupt used by board */
929 
930 	/*
931 	 * At load time, disabling the vblank interrupt won't be allowed since
932 	 * old clients may not call the modeset ioctl and therefore misbehave.
933 	 * Once the modeset ioctl *has* been called though, we can safely
934 	 * disable them when unused.
935 	 */
936 	bool vblank_disable_allowed;
937 
938 	/*
939 	 * If true, vblank interrupt will be disabled immediately when the
940 	 * refcount drops to zero, as opposed to via the vblank disable
941 	 * timer.
942 	 * This can be set to true it the hardware has a working vblank
943 	 * counter and the driver uses drm_vblank_on() and drm_vblank_off()
944 	 * appropriately.
945 	 */
946 	bool vblank_disable_immediate;
947 
948 	/* array of size num_crtcs */
949 	struct drm_vblank_crtc *vblank;
950 
951 	struct lock vblank_time_lock;    /**< Protects vblank count and time updates during vblank enable/disable */
952 	struct lock vbl_lock;
953 	struct timer_list vblank_disable_timer;
954 
955 	u32 max_vblank_count;           /**< size of vblank counter register */
956 
957 	/**
958 	 * List of events
959 	 */
960 	struct list_head vblank_event_list;
961 	struct lock event_lock;
962 
963 	/*@} */
964 
965 	struct sigio      *buf_sigio;	/* Processes waiting for SIGIO     */
966 
967 				/* Sysctl support */
968 	struct drm_sysctl_info *sysctl;
969 
970 
971 	struct drm_sg_mem *sg;	/**< Scatter gather memory */
972 	unsigned int num_crtcs;                  /**< Number of CRTCs on this device */
973 
974 	unsigned long     *ctx_bitmap;
975 	void		  *dev_private;
976 
977 	void		  *drm_ttm_bdev;
978 
979 	/*@} */
980 
981 	struct drm_agp_head *agp;	/**< AGP data */
982 
983 	struct device *dev;             /**< Device structure */
984 	struct pci_dev *pdev;		/**< PCI device structure */
985 
986 	struct drm_driver *driver;
987 	struct drm_local_map *agp_buffer_map;
988 	unsigned int agp_buffer_token;
989 	struct drm_minor *control;		/**< Control node for card */
990 	struct drm_minor *primary;		/**< render type primary screen head */
991 
992 	struct drm_mode_config mode_config;	/**< Current mode config */
993 
994 	/** \name GEM information */
995 	/*@{ */
996 	struct lock object_name_lock;
997 	struct idr object_name_idr;
998 	/*@} */
999 	void             *mm_private;
1000 
1001 	void *sysctl_private;
1002 	char busid_str[128];
1003 	int modesetting;
1004 
1005 	int switch_power_state;
1006 
1007 	atomic_t unplugged; /* device has been unplugged or gone away */
1008 };
1009 
1010 #define DRM_SWITCH_POWER_ON 0
1011 #define DRM_SWITCH_POWER_OFF 1
1012 #define DRM_SWITCH_POWER_CHANGING 2
1013 #define DRM_SWITCH_POWER_DYNAMIC_OFF 3
1014 
1015 static __inline__ int drm_core_check_feature(struct drm_device *dev,
1016 					     int feature)
1017 {
1018 	return ((dev->driver->driver_features & feature) ? 1 : 0);
1019 }
1020 
1021 static inline void drm_device_set_unplugged(struct drm_device *dev)
1022 {
1023 	smp_wmb();
1024 	atomic_set(&dev->unplugged, 1);
1025 }
1026 
1027 static inline int drm_device_is_unplugged(struct drm_device *dev)
1028 {
1029 	int ret = atomic_read(&dev->unplugged);
1030 	smp_rmb();
1031 	return ret;
1032 }
1033 
1034 static inline bool drm_is_primary_client(const struct drm_file *file_priv)
1035 {
1036 	return 0 /* file_priv->minor->type == DRM_MINOR_LEGACY */;
1037 }
1038 
1039 /**
1040  * drm_is_master() - Check whether a DRM open-file is DRM-Master
1041  * @file: DRM open-file context
1042  *
1043  * This checks whether a DRM open-file context is owner of the master context
1044  * attached to it. If a file owns a master context, it's called DRM-Master.
1045  * Per DRM device, only one such file can be DRM-Master at a time.
1046  *
1047  * Returns: True if the file is DRM-Master, otherwise false.
1048  */
1049 static inline bool drm_is_master(const struct drm_file *file)
1050 {
1051 #if 0
1052 	return file->master && file->master == file->minor->master;
1053 #else
1054 	return true;
1055 #endif
1056 }
1057 
1058 /******************************************************************/
1059 /** \name Internal function definitions */
1060 /*@{*/
1061 
1062 				/* Driver support (drm_drv.h) */
1063 extern int drm_ioctl_permit(u32 flags, struct drm_file *file_priv);
1064 int	drm_probe(device_t kdev, drm_pci_id_list_t *idlist);
1065 int	drm_attach(device_t kdev, drm_pci_id_list_t *idlist);
1066 int	drm_create_cdevs(device_t kdev);
1067 d_ioctl_t drm_ioctl;
1068 extern bool drm_ioctl_flags(unsigned int nr, unsigned int *flags);
1069 
1070 				/* Device support (drm_fops.h) */
1071 d_open_t drm_open;
1072 d_close_t drm_close;
1073 d_read_t drm_read;
1074 d_kqfilter_t drm_kqfilter;
1075 int drm_release(device_t kdev);
1076 
1077 d_mmap_t drm_mmap;
1078 d_mmap_single_t drm_mmap_single;
1079 
1080 void drm_cdevpriv_dtor(void *cd);
1081 
1082 int drm_add_busid_modesetting(struct drm_device *dev,
1083     struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
1084 
1085 /* File operations helpers (drm_fops.c) */
1086 extern int		drm_open_helper(struct cdev *kdev, int flags, int fmt,
1087 					 DRM_STRUCTPROC *p,
1088 					struct drm_device *dev,
1089 					struct file *fp);
1090 
1091 /* Misc. IOCTL support (drm_ioctl.c) */
1092 int drm_noop(struct drm_device *dev, void *data,
1093 	     struct drm_file *file_priv);
1094 int drm_invalid_op(struct drm_device *dev, void *data,
1095 		   struct drm_file *file_priv);
1096 
1097 /* Cache management (drm_cache.c) */
1098 void drm_clflush_pages(struct vm_page *pages[], unsigned long num_pages);
1099 void drm_clflush_sg(struct sg_table *st);
1100 void drm_clflush_virt_range(void *addr, unsigned long length);
1101 
1102 /*
1103  * These are exported to drivers so that they can implement fencing using
1104  * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
1105  */
1106 
1107 unsigned long drm_get_resource_start(struct drm_device *dev,
1108 				     unsigned int resource);
1109 unsigned long drm_get_resource_len(struct drm_device *dev,
1110 				   unsigned int resource);
1111 
1112 				/* IRQ support (drm_irq.h) */
1113 extern int drm_irq_install(struct drm_device *dev, int irq);
1114 extern int drm_irq_uninstall(struct drm_device *dev);
1115 
1116 extern int drm_vblank_init(struct drm_device *dev, unsigned int num_crtcs);
1117 extern int drm_wait_vblank(struct drm_device *dev, void *data,
1118 			   struct drm_file *filp);
1119 extern u32 drm_vblank_count(struct drm_device *dev, unsigned int pipe);
1120 extern u32 drm_crtc_vblank_count(struct drm_crtc *crtc);
1121 extern u32 drm_vblank_count_and_time(struct drm_device *dev, unsigned int pipe,
1122 				     struct timeval *vblanktime);
1123 extern u32 drm_crtc_vblank_count_and_time(struct drm_crtc *crtc,
1124 					  struct timeval *vblanktime);
1125 extern void drm_send_vblank_event(struct drm_device *dev, unsigned int pipe,
1126 				  struct drm_pending_vblank_event *e);
1127 extern void drm_crtc_send_vblank_event(struct drm_crtc *crtc,
1128 				       struct drm_pending_vblank_event *e);
1129 extern void drm_arm_vblank_event(struct drm_device *dev, unsigned int pipe,
1130 				 struct drm_pending_vblank_event *e);
1131 extern void drm_crtc_arm_vblank_event(struct drm_crtc *crtc,
1132 				      struct drm_pending_vblank_event *e);
1133 extern bool drm_handle_vblank(struct drm_device *dev, unsigned int pipe);
1134 extern bool drm_crtc_handle_vblank(struct drm_crtc *crtc);
1135 extern int drm_vblank_get(struct drm_device *dev, unsigned int pipe);
1136 extern void drm_vblank_put(struct drm_device *dev, unsigned int pipe);
1137 extern int drm_crtc_vblank_get(struct drm_crtc *crtc);
1138 extern void drm_crtc_vblank_put(struct drm_crtc *crtc);
1139 extern void drm_wait_one_vblank(struct drm_device *dev, unsigned int pipe);
1140 extern void drm_crtc_wait_one_vblank(struct drm_crtc *crtc);
1141 extern void drm_vblank_off(struct drm_device *dev, unsigned int pipe);
1142 extern void drm_vblank_on(struct drm_device *dev, unsigned int pipe);
1143 extern void drm_crtc_vblank_off(struct drm_crtc *crtc);
1144 extern void drm_crtc_vblank_reset(struct drm_crtc *crtc);
1145 extern void drm_crtc_vblank_on(struct drm_crtc *crtc);
1146 extern void drm_vblank_cleanup(struct drm_device *dev);
1147 extern u32 drm_vblank_no_hw_counter(struct drm_device *dev, unsigned int pipe);
1148 
1149 extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
1150 						 unsigned int pipe, int *max_error,
1151 						 struct timeval *vblank_time,
1152 						 unsigned flags,
1153 						 const struct drm_display_mode *mode);
1154 extern void drm_calc_timestamping_constants(struct drm_crtc *crtc,
1155 					    const struct drm_display_mode *mode);
1156 
1157 /**
1158  * drm_crtc_vblank_waitqueue - get vblank waitqueue for the CRTC
1159  * @crtc: which CRTC's vblank waitqueue to retrieve
1160  *
1161  * This function returns a pointer to the vblank waitqueue for the CRTC.
1162  * Drivers can use this to implement vblank waits using wait_event() & co.
1163  */
1164 static inline wait_queue_head_t *drm_crtc_vblank_waitqueue(struct drm_crtc *crtc)
1165 {
1166 	return &crtc->dev->vblank[drm_crtc_index(crtc)].queue;
1167 }
1168 
1169 /* Modesetting support */
1170 extern void drm_vblank_pre_modeset(struct drm_device *dev, unsigned int pipe);
1171 extern void drm_vblank_post_modeset(struct drm_device *dev, unsigned int pipe);
1172 
1173 				/* Stub support (drm_stub.h) */
1174 
1175 extern void drm_put_dev(struct drm_device *dev);
1176 extern void drm_unplug_dev(struct drm_device *dev);
1177 extern unsigned int drm_debug;
1178 extern bool drm_atomic;
1179 
1180 /* consistent PCI memory functions (drm_pci.c) */
1181 extern struct drm_dma_handle *drm_pci_alloc(struct drm_device *dev, size_t size,
1182 					    size_t align);
1183 extern void drm_pci_free(struct drm_device *dev, struct drm_dma_handle * dmah);
1184 
1185 			       /* sysfs support (drm_sysfs.c) */
1186 extern void drm_sysfs_hotplug_event(struct drm_device *dev);
1187 
1188 /* sysctl support (drm_sysctl.h) */
1189 extern int drm_sysctl_init(struct drm_device *dev);
1190 extern int drm_sysctl_cleanup(struct drm_device *dev);
1191 
1192 /* XXX: These are here only because of drm_sysctl.c */
1193 extern int drm_vblank_offdelay;
1194 extern unsigned int drm_timestamp_precision;
1195 
1196 int drm_gem_mmap_single(struct drm_device *dev, vm_ooffset_t *offset,
1197     vm_size_t size, struct vm_object **obj_res, int nprot);
1198 
1199 struct ttm_bo_device;
1200 int ttm_bo_mmap_single(struct ttm_bo_device *bdev, vm_ooffset_t *offset,
1201     vm_size_t size, struct vm_object **obj_res, int nprot);
1202 struct ttm_buffer_object;
1203 void ttm_bo_release_mmap(struct ttm_buffer_object *bo);
1204 
1205 /* simplified version of kvasnrprintf() for drm needs. */
1206 char *drm_vasprintf(int flags, const char *format, __va_list ap) __printflike(2, 0);
1207 char *drm_asprintf(int flags, const char *format, ...) __printflike(2, 3);
1208 
1209 /* XXX glue logic, should be done in drm_pci_init(), pending drm update */
1210 void drm_init_pdev(device_t dev, struct pci_dev **pdev);
1211 void drm_fini_pdev(struct pci_dev **pdev);
1212 void drm_print_pdev(struct pci_dev *pdev);
1213 
1214 /* Inline drm_free() helper for area kfree() */
1215 static __inline__ void
1216 drm_free(void *pt, struct malloc_type *area)
1217 {
1218 	/* kfree is special!!! */
1219 	if (pt != NULL)
1220 		(kfree)(pt, area);
1221 }
1222 
1223 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
1224 				 struct device *parent);
1225 void drm_dev_ref(struct drm_device *dev);
1226 void drm_dev_unref(struct drm_device *dev);
1227 int drm_dev_register(struct drm_device *dev, unsigned long flags);
1228 void drm_dev_unregister(struct drm_device *dev);
1229 int drm_dev_set_unique(struct drm_device *dev, const char *fmt, ...);
1230 
1231 
1232 /* PCI section */
1233 static __inline__ int drm_pci_device_is_agp(struct drm_device *dev)
1234 {
1235 	if (dev->driver->device_is_agp != NULL) {
1236 		int err = (*dev->driver->device_is_agp) (dev);
1237 
1238 		if (err != 2) {
1239 			return err;
1240 		}
1241 	}
1242 
1243 	return (pci_find_extcap(dev->pdev->dev.bsddev, PCIY_AGP, NULL) == 0);
1244 }
1245 
1246 #define DRM_PCIE_SPEED_25 1
1247 #define DRM_PCIE_SPEED_50 2
1248 #define DRM_PCIE_SPEED_80 4
1249 
1250 extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
1251 
1252 /* XXX bad */
1253 #define	drm_can_sleep()	(HZ & 1)
1254 
1255 #endif /* __KERNEL__ */
1256 
1257 /* helper for handling conditionals in various for_each macros */
1258 #define for_each_if(condition) if (!(condition)) {} else
1259 
1260 #endif /* _DRM_P_H_ */
1261