xref: /dragonfly/sys/dev/drm/include/drm/drmP.h (revision 4be47400)
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 #include <linux/agp_backend.h>
36 #include <linux/cdev.h>
37 #include <linux/dma-mapping.h>
38 #include <linux/file.h>
39 #include <linux/fs.h>
40 #include <linux/highmem.h>
41 #include <linux/idr.h>
42 #include <linux/init.h>
43 #include <linux/io.h>
44 #include <linux/jiffies.h>
45 #include <linux/kernel.h>
46 #include <linux/kref.h>
47 #include <linux/miscdevice.h>
48 #include <linux/mm.h>
49 #include <linux/mutex.h>
50 #include <linux/pci.h>
51 #include <linux/platform_device.h>
52 #include <linux/poll.h>
53 #include <linux/ratelimit.h>
54 #include <linux/rbtree.h>
55 #include <linux/sched.h>
56 #include <linux/slab.h>
57 #include <linux/types.h>
58 #include <linux/vmalloc.h>
59 #include <linux/workqueue.h>
60 #include <linux/dma-fence.h>
61 
62 #include <asm/mman.h>
63 #include <asm/pgalloc.h>
64 #include <linux/uaccess.h>
65 
66 #include <uapi/drm/drm.h>
67 #include <uapi/drm/drm_mode.h>
68 
69 #include <drm/drm_agpsupport.h>
70 #include <drm/drm_crtc.h>
71 #include <drm/drm_fourcc.h>
72 #include <drm/drm_global.h>
73 #include <drm/drm_hashtab.h>
74 #include <drm/drm_mem_util.h>
75 #include <drm/drm_mm.h>
76 #include <drm/drm_os_linux.h>
77 #include <drm/drm_sarea.h>
78 #include <drm/drm_vma_manager.h>
79 #include <drm/drm_drv.h>
80 
81 #include <sys/conf.h>
82 #include <sys/device.h>
83 #include <sys/sysctl.h>
84 
85 #include <vm/vm_extern.h>
86 #include <vm/vm_pager.h>
87 
88 struct module;
89 
90 struct drm_file;
91 struct drm_device;
92 struct drm_agp_head;
93 struct drm_local_map;
94 struct drm_device_dma;
95 struct drm_dma_handle;
96 struct drm_gem_object;
97 struct drm_master;
98 struct drm_vblank_crtc;
99 
100 struct device_node;
101 struct videomode;
102 struct reservation_object;
103 struct dma_buf_attachment;
104 
105 /*
106  * The following categories are defined:
107  *
108  * CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c, drm_memory.c, ...
109  *	 This is the category used by the DRM_DEBUG() macro.
110  *
111  * DRIVER: Used in the vendor specific part of the driver: i915, radeon, ...
112  *	   This is the category used by the DRM_DEBUG_DRIVER() macro.
113  *
114  * KMS: used in the modesetting code.
115  *	This is the category used by the DRM_DEBUG_KMS() macro.
116  *
117  * PRIME: used in the prime code.
118  *	  This is the category used by the DRM_DEBUG_PRIME() macro.
119  *
120  * ATOMIC: used in the atomic code.
121  *	  This is the category used by the DRM_DEBUG_ATOMIC() macro.
122  *
123  * VBL: used for verbose debug message in the vblank code
124  *	  This is the category used by the DRM_DEBUG_VBL() macro.
125  *
126  * DragonFly-specific categories:
127  *
128  * PID: used as modifier to include PID number in messages.
129  *	  This is the category used by the all debug macros.
130  *
131  * FIOCTL: used in failed ioctl debugging.
132  *	  This is the category used by the DRM_DEBUG_FIOCTL() macro.
133  *
134  * IOCTL: used in ioctl debugging.
135  *	  This is the category used by the DRM_DEBUG_IOCTL() macro.
136  *
137  * Enabling verbose debug messages is done through the drm.debug parameter,
138  * each category being enabled by a bit.
139  *
140  * drm.debug=0x1 will enable CORE messages
141  * drm.debug=0x2 will enable DRIVER messages
142  * drm.debug=0x3 will enable CORE and DRIVER messages
143  * ...
144  * drm.debug=0x3f will enable all messages
145  *
146  * An interesting feature is that it's possible to enable verbose logging at
147  * run-time by using the hw.drm.debug sysctl variable:
148  *   # sysctl hw.drm.debug=0xfff
149  */
150 #define DRM_UT_NONE		0x00
151 #define DRM_UT_CORE 		0x01
152 #define DRM_UT_DRIVER		0x02
153 #define DRM_UT_KMS		0x04
154 #define DRM_UT_PRIME		0x08
155 #define DRM_UT_ATOMIC		0x10
156 #define DRM_UT_VBL		0x20
157 #define DRM_UT_STATE		0x40
158 /* Extra DragonFly debug categories */
159 #ifdef __DragonFly__
160 #define DRM_UT_RES8		0x80	/* reserved for future expansion */
161 #define DRM_UT_PID		0x100
162 #define DRM_UT_FIOCTL		0x200
163 #define DRM_UT_IOCTL		0x400
164 #endif
165 
166 extern __printflike(2, 3)
167 void drm_ut_debug_printk(const char *function_name,
168 			 const char *format, ...);
169 extern __printflike(2, 3)
170 void drm_err(const char *func, const char *format, ...);
171 
172 /***********************************************************************/
173 /** \name DRM template customization defaults */
174 /*@{*/
175 
176 /***********************************************************************/
177 /** \name Macros to make printk easier */
178 /*@{*/
179 
180 #define _DRM_PRINTK(once, level, fmt, ...)				\
181 	do {								\
182 		printk##once(KERN_##level "[" DRM_NAME "] " fmt,	\
183 			     ##__VA_ARGS__);				\
184 	} while (0)
185 
186 #define DRM_INFO(fmt, ...)						\
187 	_DRM_PRINTK(, INFO, fmt, ##__VA_ARGS__)
188 #define DRM_NOTE(fmt, ...)						\
189 	_DRM_PRINTK(, NOTICE, fmt, ##__VA_ARGS__)
190 #define DRM_WARN(fmt, ...)						\
191 	_DRM_PRINTK(, WARNING, fmt, ##__VA_ARGS__)
192 
193 #define DRM_INFO_ONCE(fmt, ...)						\
194 	_DRM_PRINTK(_once, INFO, fmt, ##__VA_ARGS__)
195 #define DRM_NOTE_ONCE(fmt, ...)						\
196 	_DRM_PRINTK(_once, NOTICE, fmt, ##__VA_ARGS__)
197 #define DRM_WARN_ONCE(fmt, ...)						\
198 	_DRM_PRINTK(_once, WARNING, fmt, ##__VA_ARGS__)
199 
200 /**
201  * Error output.
202  *
203  * \param fmt printf() like format string.
204  * \param arg arguments
205  */
206 #define DRM_DEV_ERROR(dev, fmt, ...)					\
207 	drm_dev_printk(dev, KERN_ERR, DRM_UT_NONE, __func__, " *ERROR*",\
208 		       fmt, ##__VA_ARGS__)
209 #define DRM_ERROR(fmt, ...)						\
210 	drm_printk(KERN_ERR, DRM_UT_NONE, fmt,	##__VA_ARGS__)
211 
212 /**
213  * Rate limited error output.  Like DRM_ERROR() but won't flood the log.
214  *
215  * \param fmt printf() like format string.
216  * \param arg arguments
217  */
218 #define DRM_DEV_ERROR_RATELIMITED(dev, fmt, ...)			\
219 ({									\
220 	static DEFINE_RATELIMIT_STATE(_rs,				\
221 				      DEFAULT_RATELIMIT_INTERVAL,	\
222 				      DEFAULT_RATELIMIT_BURST);		\
223 									\
224 	if (__ratelimit(&_rs))						\
225 		DRM_DEV_ERROR(dev, fmt, ##__VA_ARGS__);			\
226 })
227 #define DRM_ERROR_RATELIMITED(fmt, ...)					\
228 	DRM_DEV_ERROR_RATELIMITED(NULL, fmt, ##__VA_ARGS__)
229 
230 #define DRM_DEV_INFO(dev, fmt, ...)					\
231 	drm_dev_printk(dev, KERN_INFO, DRM_UT_NONE, __func__, "", fmt,	\
232 		       ##__VA_ARGS__)
233 
234 #define DRM_DEV_INFO_ONCE(dev, fmt, ...)				\
235 ({									\
236 	static bool __print_once __read_mostly;				\
237 	if (!__print_once) {						\
238 		__print_once = true;					\
239 		DRM_DEV_INFO(dev, fmt, ##__VA_ARGS__);			\
240 	}								\
241 })
242 
243 /**
244  * Debug output.
245  *
246  * \param fmt printf() like format string.
247  * \param arg arguments
248  */
249 #define DRM_DEV_DEBUG(dev, fmt, args...)				\
250 	drm_dev_printk(dev, KERN_DEBUG, DRM_UT_CORE, __func__, "", fmt,	\
251 		       ##args)
252 #define DRM_DEBUG(fmt, ...)						\
253 	drm_printk(KERN_DEBUG, DRM_UT_CORE, fmt, ##__VA_ARGS__)
254 
255 #define DRM_DEV_DEBUG_DRIVER(dev, fmt, args...)				\
256 	drm_dev_printk(dev, KERN_DEBUG, DRM_UT_DRIVER, __func__, "",	\
257 		       fmt, ##args)
258 #define DRM_DEBUG_DRIVER(fmt, ...)					\
259 	drm_printk(KERN_DEBUG, DRM_UT_DRIVER, fmt, ##__VA_ARGS__)
260 
261 #define DRM_DEV_DEBUG_KMS(dev, fmt, args...)				\
262 	drm_dev_printk(dev, KERN_DEBUG, DRM_UT_KMS, __func__, "", fmt,	\
263 		       ##args)
264 #define DRM_DEBUG_KMS(fmt, ...)					\
265 	drm_printk(KERN_DEBUG, DRM_UT_KMS, fmt, ##__VA_ARGS__)
266 
267 #define DRM_DEV_DEBUG_PRIME(dev, fmt, args...)				\
268 	drm_dev_printk(dev, KERN_DEBUG, DRM_UT_PRIME, __func__, "",	\
269 		       fmt, ##args)
270 #define DRM_DEBUG_PRIME(fmt, ...)					\
271 	drm_printk(KERN_DEBUG, DRM_UT_PRIME, fmt, ##__VA_ARGS__)
272 
273 #define DRM_DEV_DEBUG_ATOMIC(dev, fmt, args...)				\
274 	drm_dev_printk(dev, KERN_DEBUG, DRM_UT_ATOMIC, __func__, "",	\
275 		       fmt, ##args)
276 #define DRM_DEBUG_ATOMIC(fmt, ...)					\
277 	drm_printk(KERN_DEBUG, DRM_UT_ATOMIC, fmt, ##__VA_ARGS__)
278 
279 #define DRM_DEV_DEBUG_VBL(dev, fmt, args...)				\
280 	drm_dev_printk(dev, KERN_DEBUG, DRM_UT_VBL, __func__, "", fmt,	\
281 		       ##args)
282 #define DRM_DEBUG_VBL(fmt, args...)					\
283 	do {								\
284 		if (unlikely(drm_debug & DRM_UT_VBL))			\
285 			drm_ut_debug_printk(__func__, fmt, ##args);	\
286 	} while (0)
287 
288 #ifdef __DragonFly__
289 #define DRM_DEBUG_FIOCTL(fmt, args...)					\
290 	do {								\
291 		if (unlikely(drm_debug & DRM_UT_FIOCTL))		\
292 			drm_ut_debug_printk(__func__, fmt, ##args);	\
293 	} while (0)
294 #define DRM_DEBUG_IOCTL(fmt, args...)					\
295 	do {								\
296 		if (unlikely(drm_debug & DRM_UT_IOCTL))			\
297 			drm_ut_debug_printk(__func__, fmt, ##args);	\
298 	} while (0)
299 #define DRM_DEBUG_VBLANK	DRM_DEBUG_VBL
300 #endif	/* __DragonFly__ */
301 
302 #define _DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, level, fmt, args...)	\
303 ({									\
304 	static DEFINE_RATELIMIT_STATE(_rs,				\
305 				      DEFAULT_RATELIMIT_INTERVAL,	\
306 				      DEFAULT_RATELIMIT_BURST);		\
307 	if (__ratelimit(&_rs))						\
308 		drm_dev_printk(dev, KERN_DEBUG, DRM_UT_ ## level,	\
309 			       __func__, "", fmt, ##args);		\
310 })
311 
312 /**
313  * Rate limited debug output. Like DRM_DEBUG() but won't flood the log.
314  *
315  * \param fmt printf() like format string.
316  * \param arg arguments
317  */
318 #define DRM_DEV_DEBUG_RATELIMITED(dev, fmt, args...)			\
319 	DEV__DRM_DEFINE_DEBUG_RATELIMITED(dev, CORE, fmt, ##args)
320 #define DRM_DEBUG_RATELIMITED(fmt, args...)				\
321 	DRM_DEV_DEBUG_RATELIMITED(NULL, fmt, ##args)
322 #define DRM_DEV_DEBUG_DRIVER_RATELIMITED(dev, fmt, args...)		\
323 	_DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, DRIVER, fmt, ##args)
324 #define DRM_DEBUG_DRIVER_RATELIMITED(fmt, args...)			\
325 	DRM_DEV_DEBUG_DRIVER_RATELIMITED(NULL, fmt, ##args)
326 #define DRM_DEV_DEBUG_KMS_RATELIMITED(dev, fmt, args...)		\
327 	_DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, KMS, fmt, ##args)
328 #define DRM_DEBUG_KMS_RATELIMITED(fmt, args...)				\
329 	DRM_DEV_DEBUG_KMS_RATELIMITED(NULL, fmt, ##args)
330 #define DRM_DEV_DEBUG_PRIME_RATELIMITED(dev, fmt, args...)		\
331 	_DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, PRIME, fmt, ##args)
332 #define DRM_DEBUG_PRIME_RATELIMITED(fmt, args...)			\
333 	DRM_DEV_DEBUG_PRIME_RATELIMITED(NULL, fmt, ##args)
334 
335 /* Format strings and argument splitters to simplify printing
336  * various "complex" objects
337  */
338 #define DRM_MODE_FMT    "%d:\"%s\" %d %d %d %d %d %d %d %d %d %d 0x%x 0x%x"
339 #define DRM_MODE_ARG(m) \
340 	(m)->base.id, (m)->name, (m)->vrefresh, (m)->clock, \
341 	(m)->hdisplay, (m)->hsync_start, (m)->hsync_end, (m)->htotal, \
342 	(m)->vdisplay, (m)->vsync_start, (m)->vsync_end, (m)->vtotal, \
343 	(m)->type, (m)->flags
344 
345 #define DRM_RECT_FMT    "%dx%d%+d%+d"
346 #define DRM_RECT_ARG(r) drm_rect_width(r), drm_rect_height(r), (r)->x1, (r)->y1
347 
348 /* for rect's in fixed-point format: */
349 #define DRM_RECT_FP_FMT "%d.%06ux%d.%06u%+d.%06u%+d.%06u"
350 #define DRM_RECT_FP_ARG(r) \
351 		drm_rect_width(r) >> 16, ((drm_rect_width(r) & 0xffff) * 15625) >> 10, \
352 		drm_rect_height(r) >> 16, ((drm_rect_height(r) & 0xffff) * 15625) >> 10, \
353 		(r)->x1 >> 16, (((r)->x1 & 0xffff) * 15625) >> 10, \
354 		(r)->y1 >> 16, (((r)->y1 & 0xffff) * 15625) >> 10
355 
356 /*@}*/
357 
358 /***********************************************************************/
359 /** \name Internal types and structures */
360 /*@{*/
361 
362 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
363 
364 #define DRM_DEV_MODE	(S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP)
365 #define DRM_DEV_UID	UID_ROOT
366 #define DRM_DEV_GID	GID_WHEEL
367 
368 #define DRM_CURPROC		curthread
369 #define DRM_STRUCTPROC		struct thread
370 #define DRM_LOCK(dev)		lockmgr(&(dev)->struct_mutex, LK_EXCLUSIVE)
371 #define DRM_UNLOCK(dev)		lockmgr(&(dev)->struct_mutex, LK_RELEASE)
372 
373 #define DRM_SYSCTL_HANDLER_ARGS	(SYSCTL_HANDLER_ARGS)
374 
375 #define drm_get_device_from_kdev(_kdev) (_kdev->si_drv1)
376 
377 int vm_phys_fictitious_reg_range(vm_paddr_t start, vm_paddr_t end,
378     vm_memattr_t memattr);
379 void vm_phys_fictitious_unreg_range(vm_paddr_t start, vm_paddr_t end);
380 vm_page_t vm_phys_fictitious_to_vm_page(vm_paddr_t pa);
381 
382 /**
383  * Ioctl function type.
384  *
385  * \param inode device inode.
386  * \param file_priv DRM file private pointer.
387  * \param cmd command.
388  * \param arg argument.
389  */
390 typedef int drm_ioctl_t(struct drm_device *dev, void *data,
391 			struct drm_file *file_priv);
392 
393 typedef int drm_ioctl_compat_t(struct file *filp, unsigned int cmd,
394 			       unsigned long arg);
395 
396 #define DRM_IOCTL_NR(n)                ((n) & 0xff)
397 #define DRM_MAJOR       226
398 
399 #define DRM_AUTH	0x1
400 #define DRM_MASTER	0x2
401 #define DRM_ROOT_ONLY	0x4
402 #define DRM_CONTROL_ALLOW 0x8
403 #define DRM_UNLOCKED	0x10
404 #define DRM_RENDER_ALLOW 0x20
405 
406 struct drm_ioctl_desc {
407 	unsigned int cmd;
408 	int flags;
409 	drm_ioctl_t *func;
410 	const char *name;
411 };
412 
413 /**
414  * Creates a driver or general drm_ioctl_desc array entry for the given
415  * ioctl, for use by drm_ioctl().
416  */
417 
418 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags)				\
419 	[DRM_IOCTL_NR(DRM_IOCTL_##ioctl) - DRM_COMMAND_BASE] = {	\
420 		.cmd = DRM_IOCTL_##ioctl,				\
421 		.func = _func,						\
422 		.flags = _flags,					\
423 		.name = #ioctl						\
424 	 }
425 
426 /* Event queued up for userspace to read */
427 struct drm_pending_event {
428 	struct completion *completion;
429 	void (*completion_release)(struct completion *completion);
430 	struct drm_event *event;
431 	struct dma_fence *fence;
432 	struct list_head link;
433 	struct list_head pending_link;
434 	struct drm_file *file_priv;
435 	pid_t pid; /* pid of requester, no guarantee it's valid by the time
436 		      we deliver the event, for tracing only */
437 };
438 
439 struct drm_prime_file_private {
440 	struct lock lock;
441 	struct rb_root dmabufs;
442 	struct rb_root handles;
443 };
444 
445 /** File private data */
446 struct drm_file {
447 	unsigned authenticated :1;
448 	/* true when the client has asked us to expose stereo 3D mode flags */
449 	unsigned stereo_allowed :1;
450 	/*
451 	 * true if client understands CRTC primary planes and cursor planes
452 	 * in the plane list
453 	 */
454 	unsigned universal_planes:1;
455 	/* true if client understands atomic properties */
456 	unsigned atomic:1;
457 	/*
458 	 * This client is the creator of @master.
459 	 * Protected by struct drm_device::master_mutex.
460 	 */
461 	unsigned is_master:1;
462 
463 	pid_t pid;
464 	drm_magic_t magic;
465 	struct list_head lhead;
466 	struct drm_minor *minor;
467 	unsigned long lock_count;
468 
469 	/** Mapping of mm object handles to object pointers. */
470 	struct idr object_idr;
471 	/** Lock for synchronization of access to object_idr. */
472 	spinlock_t table_lock;
473 
474 	struct file *filp;
475 	void *driver_priv;
476 
477 	struct drm_master *master; /* master this node is currently associated with
478 				      N.B. not always dev->master */
479 	/**
480 	 * fbs - List of framebuffers associated with this file.
481 	 *
482 	 * Protected by fbs_lock. Note that the fbs list holds a reference on
483 	 * the fb object to prevent it from untimely disappearing.
484 	 */
485 	struct list_head fbs;
486 	struct lock fbs_lock;
487 
488 	/** User-created blob properties; this retains a reference on the
489 	 *  property. */
490 	struct list_head blobs;
491 
492 	wait_queue_head_t event_wait;
493 	struct list_head pending_event_list;
494 	struct list_head event_list;
495 	int event_space;
496 
497 	struct lock event_read_lock;
498 
499 	struct drm_prime_file_private prime;
500 
501 #ifdef __DragonFly__
502 	struct drm_device *dev;
503 	unsigned long ioctl_count;
504 	struct kqinfo	  dkq;
505 #endif
506 };
507 
508 /**
509  * Lock data.
510  */
511 struct drm_lock_data {
512 	struct drm_hw_lock *hw_lock;	/**< Hardware lock */
513 	/** Private of lock holder's file (NULL=kernel) */
514 	struct drm_file *file_priv;
515 	wait_queue_head_t lock_queue;	/**< Queue of blocked processes */
516 	unsigned long lock_time;	/**< Time of last lock in jiffies */
517 	spinlock_t spinlock;
518 	uint32_t kernel_waiters;
519 	uint32_t user_waiters;
520 	int idle_has_lock;
521 };
522 
523 /**
524  * GEM specific mm private for tracking GEM objects
525  */
526 struct drm_gem_mm {
527 	struct drm_vma_offset_manager vma_manager;
528 	struct drm_mm offset_manager;	/**< Offset mgmt for buffer objects */
529 	struct drm_open_hash offset_hash; /**< User token hash table for maps */
530 	struct unrhdr *idxunr;
531 };
532 
533 /* Flags and return codes for get_vblank_timestamp() driver function. */
534 #define DRM_CALLED_FROM_VBLIRQ 1
535 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
536 #define DRM_VBLANKTIME_IN_VBLANK         (1 << 1)
537 
538 /* get_scanout_position() return flags */
539 #define DRM_SCANOUTPOS_VALID        (1 << 0)
540 #define DRM_SCANOUTPOS_IN_VBLANK    (1 << 1)
541 #define DRM_SCANOUTPOS_ACCURATE     (1 << 2)
542 
543 enum drm_minor_type {
544 	DRM_MINOR_PRIMARY,
545 	DRM_MINOR_CONTROL,
546 	DRM_MINOR_RENDER,
547 	DRM_MINOR_CNT,
548 };
549 
550 /**
551  * Info file list entry. This structure represents a debugfs or proc file to
552  * be created by the drm core
553  */
554 struct drm_info_list {
555 	const char *name; /** file name */
556 	int (*show)(struct seq_file*, void*); /** show callback */
557 	u32 driver_features; /**< Required driver features for this entry */
558 	void *data;
559 };
560 
561 /**
562  * debugfs node structure. This structure represents a debugfs file.
563  */
564 struct drm_info_node {
565 	struct list_head list;
566 	struct drm_minor *minor;
567 	const struct drm_info_list *info_ent;
568 	struct dentry *dent;
569 };
570 
571 /**
572  * DRM minor structure. This structure represents a drm minor number.
573  */
574 struct drm_minor {
575 	int index;			/**< Minor device number */
576 	int type;                       /**< Control or render */
577 	struct device *kdev;		/**< Linux device */
578 	struct drm_device *dev;
579 
580 	struct dentry *debugfs_root;
581 
582 	struct list_head debugfs_list;
583 	struct lock debugfs_lock; /* Protects debugfs_list. */
584 };
585 
586 struct drm_sysctl_info {
587 	struct sysctl_ctx_list ctx;
588 	char   name[2];
589 };
590 
591 /* Length for the array of resource pointers for drm_get_resource_*. */
592 #define DRM_MAX_PCI_RESOURCE	6
593 
594 /**
595  * DRM device structure. This structure represent a complete card that
596  * may contain multiple heads.
597  */
598 struct drm_device {
599 	struct list_head legacy_dev_list;/**< list of devices per driver for stealth attach cleanup */
600 	int if_version;			/**< Highest interface version set */
601 
602 	/** \name Lifetime Management */
603 	/*@{ */
604 	struct kref ref;		/**< Object ref-count */
605 	struct device *dev;		/**< Device structure of bus-device */
606 	struct drm_driver *driver;	/**< DRM driver managing the device */
607 	void *dev_private;		/**< DRM driver private data */
608 	struct drm_minor *control;		/**< Control node */
609 	struct drm_minor *primary;		/**< Primary node */
610 	struct drm_minor *render;		/**< Render node */
611 	bool registered;
612 
613 	/* currently active master for this device. Protected by master_mutex */
614 	struct drm_master *master;
615 
616 	atomic_t unplugged;			/**< Flag whether dev is dead */
617 	struct inode *anon_inode;		/**< inode for private address-space */
618 	char *unique;				/**< unique name of the device */
619 	/*@} */
620 
621 	/** \name Locks */
622 	/*@{ */
623 	struct lock struct_mutex;	/**< For others */
624 	struct lock master_mutex;      /**< For drm_minor::master and drm_file::is_master */
625 	/*@} */
626 
627 	/** \name Usage Counters */
628 	/*@{ */
629 	int open_count;			/**< Outstanding files open, protected by drm_global_mutex. */
630 	spinlock_t buf_lock;		/**< For drm_device::buf_use and a few other things. */
631 	int buf_use;			/**< Buffers in use -- cannot alloc */
632 	atomic_t buf_alloc;		/**< Buffer allocation in progress */
633 	/*@} */
634 
635 	struct lock filelist_mutex;
636 	struct list_head filelist;
637 
638 	/** \name Memory management */
639 	/*@{ */
640 	struct list_head maplist;	/**< Linked list of regions */
641 	struct drm_open_hash map_hash;	/**< User token hash table for maps */
642 
643 	/** \name Context handle management */
644 	/*@{ */
645 	struct list_head ctxlist;	/**< Linked list of context handles */
646 	struct lock ctxlist_mutex;	/**< For ctxlist */
647 
648 	struct idr ctx_idr;
649 
650 	struct list_head vmalist;	/**< List of vmas (for debugging) */
651 
652 	/*@} */
653 
654 	/** \name DMA support */
655 	/*@{ */
656 	struct drm_device_dma *dma;		/**< Optional pointer for DMA support */
657 	/*@} */
658 
659 	/** \name Context support */
660 	/*@{ */
661 
662 	__volatile__ long context_flag;	/**< Context swapping flag */
663 	int last_context;		/**< Last current context */
664 	/*@} */
665 
666 	/** \name VBLANK IRQ support */
667 	/*@{ */
668 	bool irq_enabled;
669 	int irq;
670 
671 	/*
672 	 * If true, vblank interrupt will be disabled immediately when the
673 	 * refcount drops to zero, as opposed to via the vblank disable
674 	 * timer.
675 	 * This can be set to true it the hardware has a working vblank
676 	 * counter and the driver uses drm_vblank_on() and drm_vblank_off()
677 	 * appropriately.
678 	 */
679 	bool vblank_disable_immediate;
680 
681 	/* array of size num_crtcs */
682 	struct drm_vblank_crtc *vblank;
683 
684 	spinlock_t vblank_time_lock;    /**< Protects vblank count and time updates during vblank enable/disable */
685 	spinlock_t vbl_lock;
686 
687 	u32 max_vblank_count;           /**< size of vblank counter register */
688 
689 	/**
690 	 * List of events
691 	 */
692 	struct list_head vblank_event_list;
693 	spinlock_t event_lock;
694 
695 	/*@} */
696 
697 	struct drm_agp_head *agp;	/**< AGP data */
698 
699 	struct pci_dev *pdev;		/**< PCI device structure */
700 #ifdef __alpha__
701 	struct pci_controller *hose;
702 #endif
703 
704 	struct platform_device *platformdev; /**< Platform device struture */
705 	struct virtio_device *virtdev;
706 
707 	struct drm_sg_mem *sg;	/**< Scatter gather memory */
708 	unsigned int num_crtcs;                  /**< Number of CRTCs on this device */
709 
710 	struct {
711 		int context;
712 		struct drm_hw_lock *lock;
713 	} sigdata;
714 
715 	struct drm_local_map *agp_buffer_map;
716 	unsigned int agp_buffer_token;
717 
718 	struct drm_mode_config mode_config;	/**< Current mode config */
719 
720 	/** \name GEM information */
721 	/*@{ */
722 	struct lock object_name_lock;
723 	struct idr object_name_idr;
724 	struct drm_vma_offset_manager *vma_offset_manager;
725 	/*@} */
726 	int switch_power_state;
727 #ifdef __DragonFly__
728 	/* Storage of resource pointers for drm_get_resource_* */
729 	struct resource   *pcir[DRM_MAX_PCI_RESOURCE];
730 	int		  pcirid[DRM_MAX_PCI_RESOURCE];
731 
732 	int		  pci_domain;
733 	int		  pci_bus;
734 	int		  pci_slot;
735 	int		  pci_func;
736 	char busid_str[128];
737 	int modesetting;
738 	void             *mm_private;
739 	struct drm_sysctl_info *sysctl;
740 
741 	struct idr magic_map;
742 
743 	int		  unique_len;	/* Length of unique field	   */
744 	struct cdev	  *devnode;	/* Device number for mknod	   */
745 
746 	struct lwkt_serialize irq_lock;	/* protects irq condition checks */
747 
748 	struct sigio      *buf_sigio;	/* Processes waiting for SIGIO     */
749 	void		  *drm_ttm_bdev;
750 
751 	struct drm_lock_data lock;	/* Information on hardware lock	   */
752 #endif
753 };
754 
755 #include <drm/drm_irq.h>
756 
757 #define DRM_SWITCH_POWER_ON 0
758 #define DRM_SWITCH_POWER_OFF 1
759 #define DRM_SWITCH_POWER_CHANGING 2
760 #define DRM_SWITCH_POWER_DYNAMIC_OFF 3
761 
762 static __inline__ int drm_core_check_feature(struct drm_device *dev,
763 					     int feature)
764 {
765 	return ((dev->driver->driver_features & feature) ? 1 : 0);
766 }
767 
768 static inline void drm_device_set_unplugged(struct drm_device *dev)
769 {
770 	smp_wmb();
771 	atomic_set(&dev->unplugged, 1);
772 }
773 
774 static inline int drm_device_is_unplugged(struct drm_device *dev)
775 {
776 	int ret = atomic_read(&dev->unplugged);
777 	smp_rmb();
778 	return ret;
779 }
780 
781 static inline bool drm_is_render_client(const struct drm_file *file_priv)
782 {
783 	return file_priv->minor->type == DRM_MINOR_RENDER;
784 }
785 
786 static inline bool drm_is_control_client(const struct drm_file *file_priv)
787 {
788 	return file_priv->minor->type == DRM_MINOR_CONTROL;
789 }
790 
791 static inline bool drm_is_primary_client(const struct drm_file *file_priv)
792 {
793 	return file_priv->minor->type == DRM_MINOR_PRIMARY;
794 }
795 
796 /******************************************************************/
797 /** \name Internal function definitions */
798 /*@{*/
799 
800 				/* Driver support (drm_drv.h) */
801 extern int drm_ioctl_permit(u32 flags, struct drm_file *file_priv);
802 int	drm_create_cdevs(device_t kdev);
803 d_ioctl_t drm_ioctl;
804 #ifdef CONFIG_COMPAT
805 extern long drm_compat_ioctl(struct file *filp,
806 			     unsigned int cmd, unsigned long arg);
807 #else
808 /* Let drm_compat_ioctl be assigned to .compat_ioctl unconditionally */
809 #define drm_compat_ioctl NULL
810 #endif
811 extern bool drm_ioctl_flags(unsigned int nr, unsigned int *flags);
812 
813 /* File Operations (drm_fops.c) */
814 d_open_t drm_open;
815 d_close_t drm_close;
816 d_read_t drm_read;
817 int drm_release(struct inode *inode, struct file *filp);
818 
819 /* DragonFly driver framework */
820 #ifdef __DragonFly__
821 d_kqfilter_t drm_kqfilter;
822 d_mmap_t drm_mmap;
823 d_mmap_single_t drm_mmap_single;
824 
825 int drm_device_detach(device_t kdev);
826 
827 void drm_cdevpriv_dtor(void *cd);
828 
829 int drm_add_busid_modesetting(struct drm_device *dev,
830     struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
831 #endif
832 
833 unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait);
834 int drm_event_reserve_init_locked(struct drm_device *dev,
835 				  struct drm_file *file_priv,
836 				  struct drm_pending_event *p,
837 				  struct drm_event *e);
838 int drm_event_reserve_init(struct drm_device *dev,
839 			   struct drm_file *file_priv,
840 			   struct drm_pending_event *p,
841 			   struct drm_event *e);
842 void drm_event_cancel_free(struct drm_device *dev,
843 			   struct drm_pending_event *p);
844 void drm_send_event_locked(struct drm_device *dev, struct drm_pending_event *e);
845 void drm_send_event(struct drm_device *dev, struct drm_pending_event *e);
846 
847 /* Misc. IOCTL support (drm_ioctl.c) */
848 int drm_noop(struct drm_device *dev, void *data,
849 	     struct drm_file *file_priv);
850 int drm_invalid_op(struct drm_device *dev, void *data,
851 		   struct drm_file *file_priv);
852 
853 /* Cache management (drm_cache.c) */
854 void drm_clflush_pages(struct page *pages[], unsigned long num_pages);
855 void drm_clflush_sg(struct sg_table *st);
856 void drm_clflush_virt_range(void *addr, unsigned long length);
857 
858 /*
859  * These are exported to drivers so that they can implement fencing using
860  * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
861  */
862 
863 				/* Debugfs support */
864 #if defined(CONFIG_DEBUG_FS)
865 extern int drm_debugfs_create_files(const struct drm_info_list *files,
866 				    int count, struct dentry *root,
867 				    struct drm_minor *minor);
868 extern int drm_debugfs_remove_files(const struct drm_info_list *files,
869 				    int count, struct drm_minor *minor);
870 #else
871 static inline int drm_debugfs_create_files(const struct drm_info_list *files,
872 					   int count, struct dentry *root,
873 					   struct drm_minor *minor)
874 {
875 	return 0;
876 }
877 
878 static inline int drm_debugfs_remove_files(const struct drm_info_list *files,
879 					   int count, struct drm_minor *minor)
880 {
881 	return 0;
882 }
883 #endif
884 
885 struct dma_buf_export_info;
886 
887 extern struct dma_buf *drm_gem_prime_export(struct drm_device *dev,
888 					    struct drm_gem_object *obj,
889 					    int flags);
890 extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
891 		struct drm_file *file_priv, uint32_t handle, uint32_t flags,
892 		int *prime_fd);
893 extern struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev,
894 		struct dma_buf *dma_buf);
895 extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
896 		struct drm_file *file_priv, int prime_fd, uint32_t *handle);
897 struct dma_buf *drm_gem_dmabuf_export(struct drm_device *dev,
898 				      struct dma_buf_export_info *exp_info);
899 extern void drm_gem_dmabuf_release(struct dma_buf *dma_buf);
900 
901 extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages,
902 					    dma_addr_t *addrs, int max_pages);
903 extern struct sg_table *drm_prime_pages_to_sg(struct page **pages, unsigned int nr_pages);
904 extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
905 
906 
907 extern struct drm_dma_handle *drm_pci_alloc(struct drm_device *dev, size_t size,
908 					    size_t align);
909 extern void drm_pci_free(struct drm_device *dev, struct drm_dma_handle * dmah);
910 
911 			       /* sysfs support (drm_sysfs.c) */
912 extern void drm_sysfs_hotplug_event(struct drm_device *dev);
913 
914 
915 /* XXX glue logic, should be done in drm_pci_init(), pending drm update */
916 void drm_init_pdev(device_t dev, struct pci_dev **pdev);
917 void drm_fini_pdev(struct pci_dev **pdev);
918 void drm_print_pdev(struct pci_dev *pdev);
919 
920 int drm_dev_set_unique(struct drm_device *dev, const char *name);
921 
922 /*@}*/
923 
924 /* PCI section */
925 static __inline__ int drm_pci_device_is_agp(struct drm_device *dev)
926 {
927 	if (dev->driver->device_is_agp != NULL) {
928 		int err = (*dev->driver->device_is_agp) (dev);
929 
930 		if (err != 2) {
931 			return err;
932 		}
933 	}
934 
935 	return (pci_find_extcap(dev->pdev->dev.bsddev, PCIY_AGP, NULL) == 0);
936 }
937 void drm_pci_agp_destroy(struct drm_device *dev);
938 
939 extern int drm_pci_init(struct drm_driver *driver, struct pci_driver *pdriver);
940 extern void drm_pci_exit(struct drm_driver *driver, struct pci_driver *pdriver);
941 #ifdef CONFIG_PCI
942 extern int drm_get_pci_dev(struct pci_dev *pdev,
943 			   const struct pci_device_id *ent,
944 			   struct drm_driver *driver);
945 extern int drm_pci_set_busid(struct drm_device *dev, struct drm_master *master);
946 #else
947 static inline int drm_get_pci_dev(struct pci_dev *pdev,
948 				  const struct pci_device_id *ent,
949 				  struct drm_driver *driver)
950 {
951 	return -ENOSYS;
952 }
953 
954 static inline int drm_pci_set_busid(struct drm_device *dev,
955 				    struct drm_master *master)
956 {
957 	return -ENOSYS;
958 }
959 #endif
960 
961 #define DRM_PCIE_SPEED_25 1
962 #define DRM_PCIE_SPEED_50 2
963 #define DRM_PCIE_SPEED_80 4
964 
965 extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
966 extern int drm_pcie_get_max_link_width(struct drm_device *dev, u32 *mlw);
967 
968 /* platform section */
969 extern int drm_platform_init(struct drm_driver *driver, struct platform_device *platform_device);
970 
971 /* returns true if currently okay to sleep */
972 static __inline__ bool drm_can_sleep(void)
973 {
974 	if (in_atomic() || in_dbg_master() || irqs_disabled())
975 		return false;
976 	return true;
977 }
978 
979 /* helper for handling conditionals in various for_each macros */
980 #define for_each_if(condition) if (!(condition)) {} else
981 
982 #ifdef __DragonFly__
983 struct drm_softc {
984 	void *drm_driver_data;
985 };
986 
987 /* sysctl support (drm_sysctl.h) */
988 extern int drm_sysctl_init(struct drm_device *dev);
989 extern int drm_sysctl_cleanup(struct drm_device *dev);
990 
991 unsigned long drm_get_resource_start(struct drm_device *dev,
992 				     unsigned int resource);
993 unsigned long drm_get_resource_len(struct drm_device *dev,
994 				   unsigned int resource);
995 
996 int ttm_bo_mmap_single(struct drm_device *dev, vm_ooffset_t *offset,
997     vm_size_t size, struct vm_object **obj_res, int nprot);
998 
999 int drm_gem_mmap_single(struct drm_device *dev, vm_ooffset_t *offset,
1000     vm_size_t size, struct vm_object **obj_res, int nprot);
1001 
1002 /* XXX: These are here only because of drm_sysctl.c */
1003 extern int drm_vblank_offdelay;
1004 extern unsigned int drm_timestamp_precision;
1005 #endif
1006 
1007 #endif
1008