1/**
2 * \file drmP.h
3 * Private header for Direct Rendering Manager
4 *
5 * \author Rickard E. (Rik) Faith <faith@valinux.com>
6 * \author Gareth Hughes <gareth@valinux.com>
7 */
8
9/*
10 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
11 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
12 * Copyright (c) 2009-2010, Code Aurora Forum.
13 * All rights reserved.
14 *
15 * Permission is hereby granted, free of charge, to any person obtaining a
16 * copy of this software and associated documentation files (the "Software"),
17 * to deal in the Software without restriction, including without limitation
18 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
19 * and/or sell copies of the Software, and to permit persons to whom the
20 * Software is furnished to do so, subject to the following conditions:
21 *
22 * The above copyright notice and this permission notice (including the next
23 * paragraph) shall be included in all copies or substantial portions of the
24 * Software.
25 *
26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
27 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
28 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
29 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
30 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
31 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
32 * OTHER DEALINGS IN THE SOFTWARE.
33 */
34
35#include <sys/cdefs.h>
36__FBSDID("$FreeBSD$");
37
38#ifndef _DRM_P_H_
39#define _DRM_P_H_
40
41#if defined(_KERNEL) || defined(__KERNEL__)
42
43#include <sys/param.h>
44#include <sys/queue.h>
45#include <sys/malloc.h>
46#include <sys/kernel.h>
47#include <sys/ktr.h>
48#include <sys/module.h>
49#include <sys/systm.h>
50#include <sys/conf.h>
51#include <sys/sglist.h>
52#include <sys/stat.h>
53#include <sys/priv.h>
54#include <sys/proc.h>
55#include <sys/lock.h>
56#include <sys/fcntl.h>
57#include <sys/uio.h>
58#include <sys/filio.h>
59#include <sys/rwlock.h>
60#include <sys/selinfo.h>
61#include <sys/sysctl.h>
62#include <sys/bus.h>
63#include <sys/queue.h>
64#include <sys/signalvar.h>
65#include <sys/poll.h>
66#include <sys/sbuf.h>
67#include <sys/taskqueue.h>
68#include <sys/tree.h>
69#include <vm/vm.h>
70#include <vm/pmap.h>
71#include <vm/vm_extern.h>
72#include <vm/vm_kern.h>
73#include <vm/vm_map.h>
74#include <vm/vm_object.h>
75#include <vm/vm_page.h>
76#include <vm/vm_pager.h>
77#include <vm/vm_param.h>
78#include <vm/vm_phys.h>
79#include <machine/param.h>
80#include <machine/pmap.h>
81#include <machine/bus.h>
82#include <machine/resource.h>
83#if defined(__i386__) || defined(__amd64__)
84#include <machine/specialreg.h>
85#endif
86#include <machine/sysarch.h>
87#include <sys/endian.h>
88#include <sys/mman.h>
89#include <sys/rman.h>
90#include <sys/memrange.h>
91#include <dev/agp/agpvar.h>
92#include <sys/agpio.h>
93#include <sys/mutex.h>
94#include <dev/pci/pcivar.h>
95#include <dev/pci/pcireg.h>
96#include <sys/selinfo.h>
97#include <sys/bus.h>
98
99#include <dev/drm2/drm.h>
100#include <dev/drm2/drm_sarea.h>
101
102#include <dev/drm2/drm_atomic.h>
103#include <dev/drm2/drm_internal.h>
104#include <dev/drm2/drm_linux_list.h>
105#include <dev/drm2/drm_gem_names.h>
106
107struct drm_file;
108struct drm_device;
109
110#include <dev/drm2/drm_os_freebsd.h>
111#include <dev/drm2/drm_hashtab.h>
112#include <dev/drm2/drm_mm.h>
113
114#include "opt_compat.h"
115#include "opt_drm.h"
116#ifdef DRM_DEBUG
117#undef DRM_DEBUG
118#define DRM_DEBUG_DEFAULT_ON 1
119#endif /* DRM_DEBUG */
120
121#define	DRM_DEBUGBITS_DEBUG		0x1
122#define	DRM_DEBUGBITS_KMS		0x2
123#define	DRM_DEBUGBITS_FAILED_IOCTL	0x4
124
125#undef DRM_LINUX
126#define DRM_LINUX 0
127
128/***********************************************************************/
129/** \name DRM template customization defaults */
130/*@{*/
131
132/* driver capabilities and requirements mask */
133#define DRIVER_USE_AGP     0x1
134#define DRIVER_REQUIRE_AGP 0x2
135#define DRIVER_USE_MTRR    0x4
136#define DRIVER_PCI_DMA     0x8
137#define DRIVER_SG          0x10
138#define DRIVER_HAVE_DMA    0x20
139#define DRIVER_HAVE_IRQ    0x40
140#define DRIVER_IRQ_SHARED  0x80
141#define DRIVER_IRQ_VBL     0x100
142#define DRIVER_DMA_QUEUE   0x200
143#define DRIVER_FB_DMA      0x400
144#define DRIVER_IRQ_VBL2    0x800
145#define DRIVER_GEM         0x1000
146#define DRIVER_MODESET     0x2000
147#define DRIVER_PRIME       0x4000
148#define DRIVER_LOCKLESS_IRQ 0x8000
149
150
151#define DRM_HASH_SIZE	      16 /* Size of key hash table		  */
152#define DRM_KERNEL_CONTEXT    0	 /* Change drm_resctx if changed	  */
153#define DRM_RESERVED_CONTEXTS 1	 /* Change drm_resctx if changed	  */
154
155#define	DRM_GEM_MAPPING_MASK	(3ULL << 62)
156#define	DRM_GEM_MAPPING_KEY	(2ULL << 62) /* Non-canonical address form */
157#define	DRM_GEM_MAX_IDX		0x3fffff
158#define	DRM_GEM_MAPPING_IDX(o)	(((o) >> 40) & DRM_GEM_MAX_IDX)
159#define	DRM_GEM_MAPPING_OFF(i)	(((uint64_t)(i)) << 40)
160#define	DRM_GEM_MAPPING_MAPOFF(o) \
161    ((o) & ~(DRM_GEM_MAPPING_OFF(DRM_GEM_MAX_IDX) | DRM_GEM_MAPPING_KEY))
162
163MALLOC_DECLARE(DRM_MEM_DMA);
164MALLOC_DECLARE(DRM_MEM_SAREA);
165MALLOC_DECLARE(DRM_MEM_DRIVER);
166MALLOC_DECLARE(DRM_MEM_MAGIC);
167MALLOC_DECLARE(DRM_MEM_IOCTLS);
168MALLOC_DECLARE(DRM_MEM_MAPS);
169MALLOC_DECLARE(DRM_MEM_BUFS);
170MALLOC_DECLARE(DRM_MEM_SEGS);
171MALLOC_DECLARE(DRM_MEM_PAGES);
172MALLOC_DECLARE(DRM_MEM_FILES);
173MALLOC_DECLARE(DRM_MEM_QUEUES);
174MALLOC_DECLARE(DRM_MEM_CMDS);
175MALLOC_DECLARE(DRM_MEM_MAPPINGS);
176MALLOC_DECLARE(DRM_MEM_BUFLISTS);
177MALLOC_DECLARE(DRM_MEM_AGPLISTS);
178MALLOC_DECLARE(DRM_MEM_CTXBITMAP);
179MALLOC_DECLARE(DRM_MEM_SGLISTS);
180MALLOC_DECLARE(DRM_MEM_DRAWABLE);
181MALLOC_DECLARE(DRM_MEM_MM);
182MALLOC_DECLARE(DRM_MEM_HASHTAB);
183MALLOC_DECLARE(DRM_MEM_KMS);
184
185SYSCTL_DECL(_hw_drm);
186
187#define DRM_MAX_CTXBITMAP (PAGE_SIZE * 8)
188
189/***********************************************************************/
190/** \name Internal types and structures */
191/*@{*/
192
193#define DRM_ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
194#define DRM_MIN(a,b) ((a)<(b)?(a):(b))
195#define DRM_MAX(a,b) ((a)>(b)?(a):(b))
196
197#define DRM_IF_VERSION(maj, min) (maj << 16 | min)
198
199#define __OS_HAS_AGP	1
200
201#define DRM_DEV_MODE	(S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP)
202#define DRM_DEV_UID	0
203#define DRM_DEV_GID	0
204
205#define wait_queue_head_t	atomic_t
206#define DRM_WAKEUP(w)		wakeup((void *)w)
207#define DRM_WAKEUP_INT(w)	wakeup(w)
208#define DRM_INIT_WAITQUEUE(queue) do {(void)(queue);} while (0)
209
210#define DRM_CURPROC		curthread
211#define DRM_STRUCTPROC		struct thread
212#define DRM_SPINTYPE		struct mtx
213#define DRM_SPININIT(l,name)	mtx_init(l, name, NULL, MTX_DEF)
214#define DRM_SPINUNINIT(l)	mtx_destroy(l)
215#define DRM_SPINLOCK(l)		mtx_lock(l)
216#define DRM_SPINUNLOCK(u)	mtx_unlock(u)
217#define DRM_SPINLOCK_IRQSAVE(l, irqflags) do {		\
218	mtx_lock(l);					\
219	(void)irqflags;					\
220} while (0)
221#define DRM_SPINUNLOCK_IRQRESTORE(u, irqflags) mtx_unlock(u)
222#define DRM_SPINLOCK_ASSERT(l)	mtx_assert(l, MA_OWNED)
223#define DRM_CURRENTPID		curthread->td_proc->p_pid
224#define DRM_LOCK(dev)		sx_xlock(&(dev)->dev_struct_lock)
225#define DRM_UNLOCK(dev) 	sx_xunlock(&(dev)->dev_struct_lock)
226#define	DRM_LOCK_SLEEP(dev, chan, flags, msg, timeout)			\
227    (sx_sleep((chan), &(dev)->dev_struct_lock, (flags), (msg), (timeout)))
228#if defined(INVARIANTS)
229#define	DRM_LOCK_ASSERT(dev)	sx_assert(&(dev)->dev_struct_lock, SA_XLOCKED)
230#define	DRM_UNLOCK_ASSERT(dev)	sx_assert(&(dev)->dev_struct_lock, SA_UNLOCKED)
231#else
232#define	DRM_LOCK_ASSERT(d)
233#define	DRM_UNLOCK_ASSERT(d)
234#endif
235
236#define DRM_SYSCTL_HANDLER_ARGS	(SYSCTL_HANDLER_ARGS)
237
238#define DRM_IRQ_ARGS		void *arg
239typedef void			irqreturn_t;
240#define IRQ_HANDLED		/* nothing */
241#define IRQ_NONE		/* nothing */
242
243enum {
244	DRM_IS_NOT_AGP,
245	DRM_IS_AGP,
246	DRM_MIGHT_BE_AGP
247};
248#define DRM_AGP_MEM		struct agp_memory_info
249
250#define drm_get_device_from_kdev(_kdev) (_kdev->si_drv1)
251
252#define PAGE_ALIGN(addr) round_page(addr)
253/* DRM_SUSER returns true if the user is superuser */
254#define DRM_SUSER(p)		(priv_check(p, PRIV_DRIVER) == 0)
255#define DRM_AGP_FIND_DEVICE()	agp_find_device()
256#define DRM_MTRR_WC		MDF_WRITECOMBINE
257#define jiffies			ticks
258#define	jiffies_to_msecs(x)	(((int64_t)(x)) * 1000 / hz)
259#define	msecs_to_jiffies(x)	(((int64_t)(x)) * hz / 1000)
260#define	time_after(a,b)		((long)(b) - (long)(a) < 0)
261#define	time_after_eq(a,b)	((long)(b) - (long)(a) <= 0)
262#define drm_msleep(x, msg)	pause((msg), ((int64_t)(x)) * hz / 1000)
263
264/* DRM_READMEMORYBARRIER() prevents reordering of reads.
265 * DRM_WRITEMEMORYBARRIER() prevents reordering of writes.
266 * DRM_MEMORYBARRIER() prevents reordering of reads and writes.
267 */
268#define DRM_READMEMORYBARRIER()		rmb()
269#define DRM_WRITEMEMORYBARRIER()	wmb()
270#define DRM_MEMORYBARRIER()		mb()
271
272#define DRM_READ8(map, offset)						\
273	*(volatile u_int8_t *)(((vm_offset_t)(map)->virtual) +		\
274	    (vm_offset_t)(offset))
275#define DRM_READ16(map, offset)						\
276	le16toh(*(volatile u_int16_t *)(((vm_offset_t)(map)->virtual) +	\
277	    (vm_offset_t)(offset)))
278#define DRM_READ32(map, offset)						\
279	le32toh(*(volatile u_int32_t *)(((vm_offset_t)(map)->virtual) +	\
280	    (vm_offset_t)(offset)))
281#define DRM_READ64(map, offset)						\
282	le64toh(*(volatile u_int64_t *)(((vm_offset_t)(map)->virtual) +	\
283	    (vm_offset_t)(offset)))
284#define DRM_WRITE8(map, offset, val)					\
285	*(volatile u_int8_t *)(((vm_offset_t)(map)->virtual) +		\
286	    (vm_offset_t)(offset)) = val
287#define DRM_WRITE16(map, offset, val)					\
288	*(volatile u_int16_t *)(((vm_offset_t)(map)->virtual) +		\
289	    (vm_offset_t)(offset)) = htole16(val)
290#define DRM_WRITE32(map, offset, val)					\
291	*(volatile u_int32_t *)(((vm_offset_t)(map)->virtual) +		\
292	    (vm_offset_t)(offset)) = htole32(val)
293#define DRM_WRITE64(map, offset, val)					\
294	*(volatile u_int64_t *)(((vm_offset_t)(map)->virtual) +		\
295	    (vm_offset_t)(offset)) = htole64(val)
296
297#define DRM_VERIFYAREA_READ( uaddr, size )		\
298	(!useracc(__DECONST(caddr_t, uaddr), size, VM_PROT_READ))
299
300#define DRM_COPY_TO_USER(user, kern, size) \
301	copyout(kern, user, size)
302#define DRM_COPY_FROM_USER(kern, user, size) \
303	copyin(user, kern, size)
304#define DRM_COPY_FROM_USER_UNCHECKED(arg1, arg2, arg3) 	\
305	copyin(arg2, arg1, arg3)
306#define DRM_COPY_TO_USER_UNCHECKED(arg1, arg2, arg3)	\
307	copyout(arg2, arg1, arg3)
308#define DRM_GET_USER_UNCHECKED(val, uaddr)		\
309	((val) = fuword32(uaddr), 0)
310
311#define DRM_GET_PRIV_SAREA(_dev, _ctx, _map) do {	\
312	(_map) = (_dev)->context_sareas[_ctx];		\
313} while(0)
314
315#define LOCK_TEST_WITH_RETURN(dev, file_priv)				\
316do {									\
317	if (!_DRM_LOCK_IS_HELD(dev->lock.hw_lock->lock) ||		\
318	     dev->lock.file_priv != file_priv) {			\
319		DRM_ERROR("%s called without lock held\n",		\
320			   __FUNCTION__);				\
321		return EINVAL;						\
322	}								\
323} while (0)
324
325/* Returns -errno to shared code */
326#define DRM_WAIT_ON( ret, queue, timeout, condition )		\
327for ( ret = 0 ; !ret && !(condition) ; ) {			\
328	DRM_UNLOCK(dev);						\
329	mtx_lock(&dev->irq_lock);				\
330	if (!(condition))					\
331	    ret = -mtx_sleep(&(queue), &dev->irq_lock, 		\
332		PCATCH, "drmwtq", (timeout));			\
333	mtx_unlock(&dev->irq_lock);				\
334	DRM_LOCK(dev);						\
335}
336
337#define DRM_ERROR(fmt, ...) \
338	printf("error: [" DRM_NAME ":pid%d:%s] *ERROR* " fmt,		\
339	    DRM_CURRENTPID, __func__ , ##__VA_ARGS__)
340
341#define DRM_INFO(fmt, ...)  printf("info: [" DRM_NAME "] " fmt , ##__VA_ARGS__)
342
343#define DRM_DEBUG(fmt, ...) do {					\
344	if ((drm_debug_flag & DRM_DEBUGBITS_DEBUG) != 0)		\
345		printf("[" DRM_NAME ":pid%d:%s] " fmt, DRM_CURRENTPID,	\
346			__func__ , ##__VA_ARGS__);			\
347} while (0)
348
349#define DRM_DEBUG_KMS(fmt, ...) do {					\
350	if ((drm_debug_flag & DRM_DEBUGBITS_KMS) != 0)			\
351		printf("[" DRM_NAME ":KMS:pid%d:%s] " fmt, DRM_CURRENTPID,\
352			__func__ , ##__VA_ARGS__);			\
353} while (0)
354
355#define DRM_DEBUG_DRIVER(fmt, ...) do {					\
356	if ((drm_debug_flag & DRM_DEBUGBITS_KMS) != 0)			\
357		printf("[" DRM_NAME ":KMS:pid%d:%s] " fmt, DRM_CURRENTPID,\
358			__func__ , ##__VA_ARGS__);			\
359} while (0)
360
361#define	dev_err(dev, fmt, ...)						\
362	device_printf((dev), "error: " fmt, ## __VA_ARGS__)
363#define	dev_warn(dev, fmt, ...)						\
364	device_printf((dev), "warning: " fmt, ## __VA_ARGS__)
365#define	dev_info(dev, fmt, ...)						\
366	device_printf((dev), "info: " fmt, ## __VA_ARGS__)
367#define	dev_dbg(dev, fmt, ...) do {					\
368	if ((drm_debug_flag& DRM_DEBUGBITS_KMS) != 0) {			\
369		device_printf((dev), "debug: " fmt, ## __VA_ARGS__);	\
370	}								\
371} while (0)
372
373typedef struct drm_pci_id_list
374{
375	int vendor;
376	int device;
377	long driver_private;
378	char *name;
379} drm_pci_id_list_t;
380
381struct drm_msi_blacklist_entry
382{
383	int vendor;
384	int device;
385};
386
387#define DRM_AUTH	0x1
388#define	DRM_MASTER	0x2
389#define DRM_ROOT_ONLY	0x4
390#define DRM_CONTROL_ALLOW 0x8
391#define DRM_UNLOCKED	0x10
392
393typedef struct drm_ioctl_desc {
394	unsigned long cmd;
395	int (*func)(struct drm_device *dev, void *data,
396		    struct drm_file *file_priv);
397	int flags;
398	unsigned int cmd_drv;
399} drm_ioctl_desc_t;
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(ioctl, func, flags) \
406	[DRM_IOCTL_NR(ioctl)] = {ioctl, func, flags}
407
408#define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags)			\
409	[DRM_IOCTL_NR(DRM_##ioctl)] = {.cmd = DRM_##ioctl, .func = _func, .flags = _flags, .cmd_drv = DRM_IOCTL_##ioctl}
410
411typedef struct drm_magic_entry {
412	drm_magic_t	       magic;
413	struct drm_file	       *priv;
414	struct drm_magic_entry *next;
415} drm_magic_entry_t;
416
417typedef struct drm_magic_head {
418	struct drm_magic_entry *head;
419	struct drm_magic_entry *tail;
420} drm_magic_head_t;
421
422typedef struct drm_buf {
423	int idx;		       /**< Index into master buflist */
424	int total;		       /**< Buffer size */
425	int order;		       /**< log-base-2(total) */
426	int used;		       /**< Amount of buffer in use (for DMA) */
427	unsigned long offset;	       /**< Byte offset (used internally) */
428	void *address;		       /**< Address of buffer */
429	unsigned long bus_address;     /**< Bus address of buffer */
430	struct drm_buf *next;	       /**< Kernel-only: used for free list */
431	__volatile__ int waiting;      /**< On kernel DMA queue */
432	__volatile__ int pending;      /**< On hardware DMA queue */
433	struct drm_file *file_priv;    /**< Private of holding file descr */
434	int context;		       /**< Kernel queue for this buffer */
435	int while_locked;	       /**< Dispatch this buffer while locked */
436	enum {
437		DRM_LIST_NONE = 0,
438		DRM_LIST_FREE = 1,
439		DRM_LIST_WAIT = 2,
440		DRM_LIST_PEND = 3,
441		DRM_LIST_PRIO = 4,
442		DRM_LIST_RECLAIM = 5
443	} list;			       /**< Which list we're on */
444
445	int dev_priv_size;		 /**< Size of buffer private storage */
446	void *dev_private;		 /**< Per-buffer private storage */
447} drm_buf_t;
448
449typedef struct drm_freelist {
450	int		  initialized; /* Freelist in use		   */
451	atomic_t	  count;       /* Number of free buffers	   */
452	drm_buf_t	  *next;       /* End pointer			   */
453
454	int		  low_mark;    /* Low water mark		   */
455	int		  high_mark;   /* High water mark		   */
456} drm_freelist_t;
457
458typedef struct drm_dma_handle {
459	void *vaddr;
460	bus_addr_t busaddr;
461	bus_dma_tag_t tag;
462	bus_dmamap_t map;
463} drm_dma_handle_t;
464
465typedef struct drm_buf_entry {
466	int		  buf_size;
467	int		  buf_count;
468	drm_buf_t	  *buflist;
469	int		  seg_count;
470	drm_dma_handle_t  **seglist;
471	int		  page_order;
472
473	drm_freelist_t	  freelist;
474} drm_buf_entry_t;
475
476/* Event queued up for userspace to read */
477struct drm_pending_event {
478	struct drm_event *event;
479	struct list_head link;
480	struct drm_file *file_priv;
481	pid_t pid; /* pid of requester, no guarantee it's valid by the time
482		      we deliver the event, for tracing only */
483	void (*destroy)(struct drm_pending_event *event);
484};
485
486/* initial implementaton using a linked list - todo hashtab */
487struct drm_prime_file_private {
488	struct list_head head;
489#ifdef DUMBBELL_WIP
490	struct mutex lock;
491#endif /* DUMBBELL_WIP */
492};
493
494typedef TAILQ_HEAD(drm_file_list, drm_file) drm_file_list_t;
495struct drm_file {
496	TAILQ_ENTRY(drm_file) link;
497	struct drm_device *dev;
498	int		  authenticated;
499	int		  master;
500	pid_t		  pid;
501	uid_t		  uid;
502	drm_magic_t	  magic;
503	unsigned long	  ioctl_count;
504
505	void		 *driver_priv;
506	struct drm_gem_names object_names;
507
508	int		  is_master;
509	struct drm_master *masterp;
510
511	struct list_head  fbs;
512
513	struct list_head  event_list;
514	int		  event_space;
515	struct selinfo	  event_poll;
516
517	struct drm_prime_file_private prime;
518};
519
520typedef struct drm_lock_data {
521	struct drm_hw_lock	*hw_lock;	/* Hardware lock		   */
522	struct drm_file   *file_priv;   /* Unique identifier of holding process (NULL is kernel)*/
523	int		  lock_queue;	/* Queue of blocked processes	   */
524	unsigned long	  lock_time;	/* Time of last lock in jiffies	   */
525} drm_lock_data_t;
526
527/* This structure, in the struct drm_device, is always initialized while the
528 * device
529 * is open.  dev->dma_lock protects the incrementing of dev->buf_use, which
530 * when set marks that no further bufs may be allocated until device teardown
531 * occurs (when the last open of the device has closed).  The high/low
532 * watermarks of bufs are only touched by the X Server, and thus not
533 * concurrently accessed, so no locking is needed.
534 */
535typedef struct drm_device_dma {
536
537	struct drm_buf_entry bufs[DRM_MAX_ORDER + 1];	/**< buffers, grouped by their size order */
538	int buf_count;			/**< total number of buffers */
539	struct drm_buf **buflist;		/**< Vector of pointers into drm_device_dma::bufs */
540	int seg_count;
541	int page_count;			/**< number of pages */
542	unsigned long *pagelist;	/**< page list */
543	unsigned long byte_count;
544	enum {
545		_DRM_DMA_USE_AGP = 0x01,
546		_DRM_DMA_USE_SG = 0x02,
547		_DRM_DMA_USE_FB = 0x04,
548		_DRM_DMA_USE_PCI_RO = 0x08
549	} flags;
550
551} drm_device_dma_t;
552
553typedef struct drm_agp_mem {
554	void               *handle;
555	unsigned long      bound; /* address */
556	int                pages;
557	struct drm_agp_mem *prev;
558	struct drm_agp_mem *next;
559} drm_agp_mem_t;
560
561typedef struct drm_agp_head {
562	device_t	   agpdev;
563	struct agp_info    info;
564	const char         *chipset;
565	drm_agp_mem_t      *memory;
566	unsigned long      mode;
567	int                enabled;
568	int                acquired;
569	unsigned long      base;
570   	int 		   mtrr;
571	int		   cant_use_aperture;
572	unsigned long	   page_mask;
573} drm_agp_head_t;
574
575typedef struct drm_sg_mem {
576	vm_offset_t vaddr;
577	vm_paddr_t *busaddr;
578	vm_pindex_t pages;
579} drm_sg_mem_t;
580
581#define DRM_MAP_HANDLE_BITS	(sizeof(void *) == 4 ? 4 : 24)
582#define DRM_MAP_HANDLE_SHIFT	(sizeof(void *) * 8 - DRM_MAP_HANDLE_BITS)
583typedef TAILQ_HEAD(drm_map_list, drm_local_map) drm_map_list_t;
584
585typedef struct drm_local_map {
586	unsigned long offset;	  /* Physical address (0 for SAREA)       */
587	unsigned long size;	  /* Physical size (bytes)                */
588	enum drm_map_type type;	  /* Type of memory mapped                */
589	enum drm_map_flags flags; /* Flags                                */
590	void *handle;		  /* User-space: "Handle" to pass to mmap */
591				  /* Kernel-space: kernel-virtual address */
592	int mtrr;		  /* Boolean: MTRR used                   */
593				  /* Private data                         */
594	int rid;		  /* PCI resource ID for bus_space        */
595	void *virtual;		  /* Kernel-space: kernel-virtual address */
596	struct resource *bsr;
597	bus_space_tag_t bst;
598	bus_space_handle_t bsh;
599	drm_dma_handle_t *dmah;
600	TAILQ_ENTRY(drm_local_map) link;
601} drm_local_map_t;
602
603struct drm_vblank_info {
604	wait_queue_head_t queue;	/* vblank wait queue */
605	atomic_t count;			/* number of VBLANK interrupts */
606					/* (driver must alloc the right number of counters) */
607	atomic_t refcount;		/* number of users of vblank interrupts */
608	u32 last;			/* protected by dev->vbl_lock, used */
609					/* for wraparound handling */
610	int enabled;			/* so we don't call enable more than */
611					/* once per disable */
612	int inmodeset;			/* Display driver is setting mode */
613};
614
615/* location of GART table */
616#define DRM_ATI_GART_MAIN 1
617#define DRM_ATI_GART_FB   2
618
619#define DRM_ATI_GART_PCI 1
620#define DRM_ATI_GART_PCIE 2
621#define DRM_ATI_GART_IGP 3
622
623struct drm_ati_pcigart_info {
624	int gart_table_location;
625	int gart_reg_if;
626	void *addr;
627	dma_addr_t bus_addr;
628	dma_addr_t table_mask;
629	dma_addr_t member_mask;
630	struct drm_dma_handle *table_handle;
631	drm_local_map_t mapping;
632	int table_size;
633	struct drm_dma_handle *dmah; /* handle for ATI PCIGART table */
634};
635
636typedef vm_paddr_t resource_size_t;
637
638/**
639 * GEM specific mm private for tracking GEM objects
640 */
641struct drm_gem_mm {
642	struct drm_open_hash offset_hash; /**< User token hash table for maps */
643	struct unrhdr *idxunr;
644};
645
646struct drm_gem_object {
647	/** Reference count of this object */
648	u_int refcount;
649
650	/** Handle count of this object. Each handle also holds a reference */
651	u_int handle_count; /* number of handles on this object */
652
653	/** Related drm device */
654	struct drm_device *dev;
655
656	/** File representing the shmem storage: filp in Linux parlance */
657	vm_object_t vm_obj;
658
659	bool on_map;
660	struct drm_hash_item map_list;
661
662	/**
663	 * Size of the object, in bytes.  Immutable over the object's
664	 * lifetime.
665	 */
666	size_t size;
667
668	/**
669	 * Global name for this object, starts at 1. 0 means unnamed.
670	 * Access is covered by the object_name_lock in the related drm_device
671	 */
672	int name;
673
674	/**
675	 * Memory domains. These monitor which caches contain read/write data
676	 * related to the object. When transitioning from one set of domains
677	 * to another, the driver is called to ensure that caches are suitably
678	 * flushed and invalidated
679	 */
680	uint32_t read_domains;
681	uint32_t write_domain;
682
683	/**
684	 * While validating an exec operation, the
685	 * new read/write domain values are computed here.
686	 * They will be transferred to the above values
687	 * at the point that any cache flushing occurs
688	 */
689	uint32_t pending_read_domains;
690	uint32_t pending_write_domain;
691
692	void *driver_private;
693
694#ifdef DUMBBELL_WIP
695	/* dma buf exported from this GEM object */
696	struct dma_buf *export_dma_buf;
697
698	/* dma buf attachment backing this object */
699	struct dma_buf_attachment *import_attach;
700#endif /* DUMBBELL_WIP */
701};
702
703#include "drm_crtc.h"
704
705/* per-master structure */
706struct drm_master {
707
708	u_int refcount; /* refcount for this master */
709
710	struct list_head head; /**< each minor contains a list of masters */
711	struct drm_minor *minor; /**< link back to minor we are a master for */
712
713	char *unique;			/**< Unique identifier: e.g., busid */
714	int unique_len;			/**< Length of unique field */
715	int unique_size;		/**< amount allocated */
716
717	int blocked;			/**< Blocked due to VC switch? */
718
719	/** \name Authentication */
720	/*@{ */
721	struct drm_open_hash magiclist;
722	struct list_head magicfree;
723	/*@} */
724
725	struct drm_lock_data lock;	/**< Information on hardware lock */
726
727	void *driver_priv; /**< Private structure for driver to use */
728};
729
730/* Size of ringbuffer for vblank timestamps. Just double-buffer
731 * in initial implementation.
732 */
733#define DRM_VBLANKTIME_RBSIZE 2
734
735/* Flags and return codes for get_vblank_timestamp() driver function. */
736#define DRM_CALLED_FROM_VBLIRQ 1
737#define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
738#define DRM_VBLANKTIME_INVBL             (1 << 1)
739
740/* get_scanout_position() return flags */
741#define DRM_SCANOUTPOS_VALID        (1 << 0)
742#define DRM_SCANOUTPOS_INVBL        (1 << 1)
743#define DRM_SCANOUTPOS_ACCURATE     (1 << 2)
744
745#ifndef DMA_BIT_MASK
746#define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : (1ULL<<(n)) - 1)
747#endif
748
749#define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
750
751struct drm_driver_info {
752	int	(*load)(struct drm_device *, unsigned long flags);
753	int	(*use_msi)(struct drm_device *, unsigned long flags);
754	int	(*firstopen)(struct drm_device *);
755	int	(*open)(struct drm_device *, struct drm_file *);
756	void	(*preclose)(struct drm_device *, struct drm_file *file_priv);
757	void	(*postclose)(struct drm_device *, struct drm_file *);
758	void	(*lastclose)(struct drm_device *);
759	int	(*unload)(struct drm_device *);
760	void	(*reclaim_buffers_locked)(struct drm_device *,
761					  struct drm_file *file_priv);
762	int	(*dma_ioctl)(struct drm_device *dev, void *data,
763			     struct drm_file *file_priv);
764	void	(*dma_ready)(struct drm_device *);
765	int	(*dma_quiescent)(struct drm_device *);
766	int	(*dma_flush_block_and_flush)(struct drm_device *, int context,
767					     enum drm_lock_flags flags);
768	int	(*dma_flush_unblock)(struct drm_device *, int context,
769				     enum drm_lock_flags flags);
770	int	(*context_ctor)(struct drm_device *dev, int context);
771	int	(*context_dtor)(struct drm_device *dev, int context);
772	int	(*kernel_context_switch)(struct drm_device *dev, int old,
773					 int new);
774	int	(*kernel_context_switch_unlock)(struct drm_device *dev);
775	void	(*irq_preinstall)(struct drm_device *dev);
776	int	(*irq_postinstall)(struct drm_device *dev);
777	void	(*irq_uninstall)(struct drm_device *dev);
778	void	(*irq_handler)(DRM_IRQ_ARGS);
779
780	u32	(*get_vblank_counter)(struct drm_device *dev, int crtc);
781	int	(*enable_vblank)(struct drm_device *dev, int crtc);
782	void	(*disable_vblank)(struct drm_device *dev, int crtc);
783	int	(*get_scanout_position)(struct drm_device *dev, int crtc,
784		    int *vpos, int *hpos);
785
786	int	(*get_vblank_timestamp)(struct drm_device *dev, int crtc,
787		    int *max_error, struct timeval *vblank_time,
788		    unsigned flags);
789
790	int	(*gem_init_object)(struct drm_gem_object *obj);
791	void	(*gem_free_object)(struct drm_gem_object *obj);
792	int	(*gem_open_object)(struct drm_gem_object *, struct drm_file *);
793	void	(*gem_close_object)(struct drm_gem_object *, struct drm_file *);
794
795	struct cdev_pager_ops *gem_pager_ops;
796
797	int	(*dumb_create)(struct drm_file *file_priv,
798		    struct drm_device *dev, struct drm_mode_create_dumb *args);
799	int	(*dumb_map_offset)(struct drm_file *file_priv,
800		    struct drm_device *dev, uint32_t handle, uint64_t *offset);
801	int	(*dumb_destroy)(struct drm_file *file_priv,
802		    struct drm_device *dev, uint32_t handle);
803
804	int	(*sysctl_init)(struct drm_device *dev,
805		    struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
806	void	(*sysctl_cleanup)(struct drm_device *dev);
807
808	drm_pci_id_list_t *id_entry;	/* PCI ID, name, and chipset private */
809
810	/**
811	 * Called by \c drm_device_is_agp.  Typically used to determine if a
812	 * card is really attached to AGP or not.
813	 *
814	 * \param dev  DRM device handle
815	 *
816	 * \returns
817	 * One of three values is returned depending on whether or not the
818	 * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
819	 * (return of 1), or may or may not be AGP (return of 2).
820	 */
821	int	(*device_is_agp) (struct drm_device * dev);
822
823	drm_ioctl_desc_t *ioctls;
824#ifdef COMPAT_FREEBSD32
825	drm_ioctl_desc_t *compat_ioctls;
826	int	*compat_ioctls_nr;
827#endif
828	int	max_ioctl;
829
830	int	buf_priv_size;
831
832	int	major;
833	int	minor;
834	int	patchlevel;
835	const char *name;		/* Simple driver name		   */
836	const char *desc;		/* Longer driver name		   */
837	const char *date;		/* Date of last major changes.	   */
838
839	u32 driver_features;
840};
841
842/**
843 * DRM minor structure. This structure represents a drm minor number.
844 */
845struct drm_minor {
846	int index;			/**< Minor device number */
847	int type;                       /**< Control or render */
848	device_t kdev;			/**< OS device */
849	struct drm_device *dev;
850
851	struct drm_master *master; /* currently active master for this node */
852	struct list_head master_list;
853	struct drm_mode_group mode_group;
854};
855
856/* mode specified on the command line */
857struct drm_cmdline_mode {
858	bool specified;
859	bool refresh_specified;
860	bool bpp_specified;
861	int xres, yres;
862	int bpp;
863	int refresh;
864	bool rb;
865	bool interlace;
866	bool cvt;
867	bool margins;
868	enum drm_connector_force force;
869};
870
871
872struct drm_pending_vblank_event {
873	struct drm_pending_event base;
874	int pipe;
875	struct drm_event_vblank event;
876};
877
878/* Length for the array of resource pointers for drm_get_resource_*. */
879#define DRM_MAX_PCI_RESOURCE	6
880
881/**
882 * DRM device structure. This structure represent a complete card that
883 * may contain multiple heads.
884 */
885struct drm_device {
886	struct drm_driver_info *driver;
887	drm_pci_id_list_t *id_entry;	/* PCI ID, name, and chipset private */
888
889	uint16_t pci_device;		/* PCI device id */
890	uint16_t pci_vendor;		/* PCI vendor id */
891	uint16_t pci_subdevice;		/* PCI subsystem device id */
892	uint16_t pci_subvendor;		/* PCI subsystem vendor id */
893
894	char		  *unique;	/* Unique identifier: e.g., busid  */
895	int		  unique_len;	/* Length of unique field	   */
896	device_t	  device;	/* Device instance from newbus     */
897	struct cdev	  *devnode;	/* Device number for mknod	   */
898	int		  if_version;	/* Highest interface version set */
899
900	int		  flags;	/* Flags to open(2)		   */
901
902				/* Locks */
903	struct mtx	  dma_lock;	/* protects dev->dma */
904	struct mtx	  irq_lock;	/* protects irq condition checks */
905	struct mtx	  dev_lock;	/* protects everything else */
906	struct sx	  dev_struct_lock;
907	DRM_SPINTYPE	  drw_lock;
908
909				/* Usage Counters */
910	int		  open_count;	/* Outstanding files open	   */
911	int		  buf_use;	/* Buffers in use -- cannot alloc  */
912
913				/* Performance counters */
914	unsigned long     counters;
915	enum drm_stat_type	types[15];
916	atomic_t          counts[15];
917
918				/* Authentication */
919	drm_file_list_t   files;
920	drm_magic_head_t  magiclist[DRM_HASH_SIZE];
921
922	/* Linked list of mappable regions. Protected by dev_lock */
923	drm_map_list_t	  maplist;
924	struct unrhdr	  *map_unrhdr;
925
926	drm_local_map_t	  **context_sareas;
927	int		  max_context;
928
929	drm_lock_data_t	  lock;		/* Information on hardware lock	   */
930
931				/* DMA queues (contexts) */
932	drm_device_dma_t  *dma;		/* Optional pointer for DMA support */
933
934				/* Context support */
935	int		  irq;		/* Interrupt used by board	   */
936	int		  irq_enabled;	/* True if the irq handler is enabled */
937	int		  msi_enabled;	/* MSI enabled */
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	atomic_t	  context_flag;	/* Context swapping flag	   */
952	int		  last_context;	/* Last current context		   */
953
954	int		  num_crtcs;
955
956	struct sigio      *buf_sigio;	/* Processes waiting for SIGIO     */
957
958				/* Sysctl support */
959	struct drm_sysctl_info *sysctl;
960	int		  sysctl_node_idx;
961
962	drm_agp_head_t    *agp;
963	drm_sg_mem_t      *sg;  /* Scatter gather memory */
964	unsigned long     *ctx_bitmap;
965	void		  *dev_private;
966	unsigned int	  agp_buffer_token;
967	drm_local_map_t   *agp_buffer_map;
968
969	struct drm_minor *control;		/**< Control node for card */
970	struct drm_minor *primary;		/**< render type primary screen head */
971
972	void		  *drm_ttm_bdev;
973	struct unrhdr	  *drw_unrhdr;
974	/* RB tree of drawable infos */
975	RB_HEAD(drawable_tree, bsd_drm_drawable_info) drw_head;
976
977	int vblank_disable_allowed;
978
979	atomic_t *_vblank_count;        /**< number of VBLANK interrupts (driver must alloc the right number of counters) */
980	struct timeval *_vblank_time;   /**< timestamp of current vblank_count (drivers must alloc right number of fields) */
981	struct mtx vblank_time_lock;    /**< Protects vblank count and time updates during vblank enable/disable */
982	struct mtx vbl_lock;
983	atomic_t *vblank_refcount;      /* number of users of vblank interruptsper crtc */
984	u32 *last_vblank;               /* protected by dev->vbl_lock, used */
985					/* for wraparound handling */
986	int *vblank_enabled;            /* so we don't call enable more than
987					   once per disable */
988	int *vblank_inmodeset;          /* Display driver is setting mode */
989	u32 *last_vblank_wait;		/* Last vblank seqno waited per CRTC */
990	struct callout vblank_disable_callout;
991
992	u32 max_vblank_count;           /**< size of vblank counter register */
993
994	struct list_head vblank_event_list;
995	struct mtx	 event_lock;
996
997        struct drm_mode_config mode_config;	/**< Current mode config */
998
999	/* GEM part */
1000	struct sx	  object_name_lock;
1001	struct drm_gem_names object_names;
1002	void		 *mm_private;
1003
1004	void *sysctl_private;
1005	char busid_str[128];
1006	int modesetting;
1007
1008	int switch_power_state;
1009};
1010
1011#define DRM_SWITCH_POWER_ON 0
1012#define DRM_SWITCH_POWER_OFF 1
1013#define DRM_SWITCH_POWER_CHANGING 2
1014
1015static __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#if __OS_HAS_AGP
1022static inline int drm_core_has_AGP(struct drm_device *dev)
1023{
1024	return drm_core_check_feature(dev, DRIVER_USE_AGP);
1025}
1026#else
1027#define drm_core_has_AGP(dev) (0)
1028#endif
1029
1030enum dmi_field {
1031        DMI_NONE,
1032        DMI_BIOS_VENDOR,
1033        DMI_BIOS_VERSION,
1034        DMI_BIOS_DATE,
1035        DMI_SYS_VENDOR,
1036        DMI_PRODUCT_NAME,
1037        DMI_PRODUCT_VERSION,
1038        DMI_PRODUCT_SERIAL,
1039        DMI_PRODUCT_UUID,
1040        DMI_BOARD_VENDOR,
1041        DMI_BOARD_NAME,
1042        DMI_BOARD_VERSION,
1043        DMI_BOARD_SERIAL,
1044        DMI_BOARD_ASSET_TAG,
1045        DMI_CHASSIS_VENDOR,
1046        DMI_CHASSIS_TYPE,
1047        DMI_CHASSIS_VERSION,
1048        DMI_CHASSIS_SERIAL,
1049        DMI_CHASSIS_ASSET_TAG,
1050        DMI_STRING_MAX,
1051};
1052
1053struct dmi_strmatch {
1054	unsigned char slot;
1055	char substr[79];
1056};
1057
1058struct dmi_system_id {
1059        int (*callback)(const struct dmi_system_id *);
1060        const char *ident;
1061        struct dmi_strmatch matches[4];
1062};
1063#define	DMI_MATCH(a, b) {(a), (b)}
1064bool dmi_check_system(const struct dmi_system_id *);
1065
1066extern int	drm_debug_flag;
1067extern int	drm_notyet_flag;
1068extern unsigned int drm_vblank_offdelay;
1069extern unsigned int drm_timestamp_precision;
1070extern unsigned int drm_timestamp_monotonic;
1071
1072/* Device setup support (drm_drv.c) */
1073int	drm_probe(device_t kdev, drm_pci_id_list_t *idlist);
1074int	drm_attach(device_t kdev, drm_pci_id_list_t *idlist);
1075int	drm_create_cdevs(device_t kdev);
1076void	drm_close(void *data);
1077int	drm_detach(device_t kdev);
1078d_ioctl_t drm_ioctl;
1079d_open_t drm_open;
1080d_read_t drm_read;
1081d_poll_t drm_poll;
1082d_mmap_t drm_mmap;
1083extern drm_local_map_t	*drm_getsarea(struct drm_device *dev);
1084
1085void drm_event_wakeup(struct drm_pending_event *e);
1086
1087int drm_add_busid_modesetting(struct drm_device *dev,
1088    struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
1089
1090/* File operations helpers (drm_fops.c) */
1091extern int		drm_open_helper(struct cdev *kdev, int flags, int fmt,
1092					 DRM_STRUCTPROC *p,
1093					struct drm_device *dev);
1094
1095#ifdef DUMBBELL_WIP
1096extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
1097		struct drm_file *file_priv, uint32_t handle, uint32_t flags,
1098		int *prime_fd);
1099extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
1100		struct drm_file *file_priv, int prime_fd, uint32_t *handle);
1101
1102extern int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data,
1103					struct drm_file *file_priv);
1104extern int drm_prime_fd_to_handle_ioctl(struct drm_device *dev, void *data,
1105					struct drm_file *file_priv);
1106
1107#ifdef DUMBBELL_WIP
1108/*
1109 * See drm_prime.c
1110 *   -- dumbbell@
1111 */
1112extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, vm_page_t *pages,
1113					    dma_addr_t *addrs, int max_pages);
1114#endif /* DUMBBELL_WIP */
1115extern struct sg_table *drm_prime_pages_to_sg(vm_page_t *pages, int nr_pages);
1116extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
1117
1118
1119void drm_prime_init_file_private(struct drm_prime_file_private *prime_fpriv);
1120void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv);
1121int drm_prime_add_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf, uint32_t handle);
1122int drm_prime_lookup_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf, uint32_t *handle);
1123void drm_prime_remove_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf);
1124
1125int drm_prime_add_dma_buf(struct drm_device *dev, struct drm_gem_object *obj);
1126int drm_prime_lookup_obj(struct drm_device *dev, struct dma_buf *buf,
1127			 struct drm_gem_object **obj);
1128#endif /* DUMBBELL_WIP */
1129
1130/* Memory management support (drm_memory.c) */
1131void	drm_mem_init(void);
1132void	drm_mem_uninit(void);
1133void	*drm_ioremap_wc(struct drm_device *dev, drm_local_map_t *map);
1134void	*drm_ioremap(struct drm_device *dev, drm_local_map_t *map);
1135void	drm_ioremapfree(drm_local_map_t *map);
1136int	drm_mtrr_add(unsigned long offset, size_t size, int flags);
1137int	drm_mtrr_del(int handle, unsigned long offset, size_t size, int flags);
1138
1139int	drm_context_switch(struct drm_device *dev, int old, int new);
1140int	drm_context_switch_complete(struct drm_device *dev, int new);
1141
1142int	drm_ctxbitmap_init(struct drm_device *dev);
1143void	drm_ctxbitmap_cleanup(struct drm_device *dev);
1144void	drm_ctxbitmap_free(struct drm_device *dev, int ctx_handle);
1145int	drm_ctxbitmap_next(struct drm_device *dev);
1146
1147/* Locking IOCTL support (drm_lock.c) */
1148int	drm_lock_take(struct drm_lock_data *lock_data,
1149		      unsigned int context);
1150int	drm_lock_transfer(struct drm_lock_data *lock_data,
1151			  unsigned int context);
1152int	drm_lock_free(struct drm_lock_data *lock_data,
1153		      unsigned int context);
1154
1155/* Buffer management support (drm_bufs.c) */
1156unsigned long drm_get_resource_start(struct drm_device *dev,
1157				     unsigned int resource);
1158unsigned long drm_get_resource_len(struct drm_device *dev,
1159				   unsigned int resource);
1160void	drm_rmmap(struct drm_device *dev, drm_local_map_t *map);
1161int	drm_order(unsigned long size);
1162int	drm_addmap(struct drm_device *dev, unsigned long offset,
1163		   unsigned long size,
1164		   enum drm_map_type type, enum drm_map_flags flags,
1165		   drm_local_map_t **map_ptr);
1166int	drm_addbufs_pci(struct drm_device *dev, struct drm_buf_desc *request);
1167int	drm_addbufs_sg(struct drm_device *dev, struct drm_buf_desc *request);
1168int	drm_addbufs_agp(struct drm_device *dev, struct drm_buf_desc *request);
1169
1170/* DMA support (drm_dma.c) */
1171int	drm_dma_setup(struct drm_device *dev);
1172void	drm_dma_takedown(struct drm_device *dev);
1173void	drm_free_buffer(struct drm_device *dev, drm_buf_t *buf);
1174void	drm_reclaim_buffers(struct drm_device *dev, struct drm_file *file_priv);
1175#define drm_core_reclaim_buffers drm_reclaim_buffers
1176
1177/* IRQ support (drm_irq.c) */
1178int	drm_irq_install(struct drm_device *dev);
1179int	drm_irq_uninstall(struct drm_device *dev);
1180irqreturn_t drm_irq_handler(DRM_IRQ_ARGS);
1181void	drm_driver_irq_preinstall(struct drm_device *dev);
1182void	drm_driver_irq_postinstall(struct drm_device *dev);
1183void	drm_driver_irq_uninstall(struct drm_device *dev);
1184
1185void	drm_vblank_pre_modeset(struct drm_device *dev, int crtc);
1186void	drm_vblank_post_modeset(struct drm_device *dev, int crtc);
1187int 	drm_modeset_ctl(struct drm_device *dev, void *data,
1188			struct drm_file *file_priv);
1189
1190extern int drm_vblank_init(struct drm_device *dev, int num_crtcs);
1191extern int drm_wait_vblank(struct drm_device *dev, void *data,
1192			   struct drm_file *filp);
1193extern int drm_vblank_wait(struct drm_device *dev, unsigned int *vbl_seq);
1194extern u32 drm_vblank_count(struct drm_device *dev, int crtc);
1195extern u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
1196				     struct timeval *vblanktime);
1197extern bool drm_handle_vblank(struct drm_device *dev, int crtc);
1198void drm_handle_vblank_events(struct drm_device *dev, int crtc);
1199extern int drm_vblank_get(struct drm_device *dev, int crtc);
1200extern void drm_vblank_put(struct drm_device *dev, int crtc);
1201extern void drm_vblank_off(struct drm_device *dev, int crtc);
1202extern void drm_vblank_cleanup(struct drm_device *dev);
1203extern u32 drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
1204				     struct timeval *tvblank, unsigned flags);
1205extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
1206						 int crtc, int *max_error,
1207						 struct timeval *vblank_time,
1208						 unsigned flags,
1209						 struct drm_crtc *refcrtc);
1210extern void drm_calc_timestamping_constants(struct drm_crtc *crtc);
1211
1212struct timeval ns_to_timeval(const int64_t nsec);
1213int64_t timeval_to_ns(const struct timeval *tv);
1214
1215/* AGP/PCI Express/GART support (drm_agpsupport.c) */
1216int	drm_device_is_agp(struct drm_device *dev);
1217int	drm_device_is_pcie(struct drm_device *dev);
1218drm_agp_head_t *drm_agp_init(void);
1219int	drm_agp_acquire(struct drm_device *dev);
1220int	drm_agp_release(struct drm_device *dev);
1221int	drm_agp_info(struct drm_device * dev, struct drm_agp_info *info);
1222int	drm_agp_enable(struct drm_device *dev, struct drm_agp_mode mode);
1223void	*drm_agp_allocate_memory(size_t pages, u32 type);
1224int	drm_agp_free_memory(void *handle);
1225int	drm_agp_bind_memory(void *handle, off_t start);
1226int	drm_agp_unbind_memory(void *handle);
1227int	drm_agp_alloc(struct drm_device *dev, struct drm_agp_buffer *request);
1228int	drm_agp_free(struct drm_device *dev, struct drm_agp_buffer *request);
1229int	drm_agp_bind(struct drm_device *dev, struct drm_agp_binding *request);
1230int	drm_agp_unbind(struct drm_device *dev, struct drm_agp_binding *request);
1231
1232/* Scatter Gather Support (drm_scatter.c) */
1233void	drm_sg_cleanup(drm_sg_mem_t *entry);
1234int	drm_sg_alloc(struct drm_device *dev, struct drm_scatter_gather * request);
1235
1236/* sysctl support (drm_sysctl.h) */
1237extern int		drm_sysctl_init(struct drm_device *dev);
1238extern int		drm_sysctl_cleanup(struct drm_device *dev);
1239
1240/* ATI PCIGART support (ati_pcigart.c) */
1241int	drm_ati_pcigart_init(struct drm_device *dev,
1242				struct drm_ati_pcigart_info *gart_info);
1243int	drm_ati_pcigart_cleanup(struct drm_device *dev,
1244				struct drm_ati_pcigart_info *gart_info);
1245
1246/* Cache management (drm_memory.c) */
1247void	drm_clflush_pages(vm_page_t *pages, unsigned long num_pages);
1248
1249/* Locking IOCTL support (drm_drv.c) */
1250int	drm_lock(struct drm_device *dev, void *data,
1251		 struct drm_file *file_priv);
1252int	drm_unlock(struct drm_device *dev, void *data,
1253		   struct drm_file *file_priv);
1254int	drm_version(struct drm_device *dev, void *data,
1255		    struct drm_file *file_priv);
1256int	drm_setversion(struct drm_device *dev, void *data,
1257		       struct drm_file *file_priv);
1258
1259/* Misc. IOCTL support (drm_ioctl.c) */
1260int	drm_irq_by_busid(struct drm_device *dev, void *data,
1261			 struct drm_file *file_priv);
1262int	drm_getunique(struct drm_device *dev, void *data,
1263		      struct drm_file *file_priv);
1264int	drm_setunique(struct drm_device *dev, void *data,
1265		      struct drm_file *file_priv);
1266int	drm_getmap(struct drm_device *dev, void *data,
1267		   struct drm_file *file_priv);
1268int	drm_getclient(struct drm_device *dev, void *data,
1269		      struct drm_file *file_priv);
1270int	drm_getstats(struct drm_device *dev, void *data,
1271		     struct drm_file *file_priv);
1272int	drm_getcap(struct drm_device *dev, void *data,
1273		     struct drm_file *file_priv);
1274int	drm_noop(struct drm_device *dev, void *data,
1275		 struct drm_file *file_priv);
1276
1277/* Context IOCTL support (drm_context.c) */
1278int	drm_resctx(struct drm_device *dev, void *data,
1279		   struct drm_file *file_priv);
1280int	drm_addctx(struct drm_device *dev, void *data,
1281		   struct drm_file *file_priv);
1282int	drm_modctx(struct drm_device *dev, void *data,
1283		   struct drm_file *file_priv);
1284int	drm_getctx(struct drm_device *dev, void *data,
1285		   struct drm_file *file_priv);
1286int	drm_switchctx(struct drm_device *dev, void *data,
1287		      struct drm_file *file_priv);
1288int	drm_newctx(struct drm_device *dev, void *data,
1289		   struct drm_file *file_priv);
1290int	drm_rmctx(struct drm_device *dev, void *data,
1291		  struct drm_file *file_priv);
1292int	drm_setsareactx(struct drm_device *dev, void *data,
1293			struct drm_file *file_priv);
1294int	drm_getsareactx(struct drm_device *dev, void *data,
1295			struct drm_file *file_priv);
1296
1297/* Drawable IOCTL support (drm_drawable.c) */
1298int	drm_adddraw(struct drm_device *dev, void *data,
1299		    struct drm_file *file_priv);
1300int	drm_rmdraw(struct drm_device *dev, void *data,
1301		   struct drm_file *file_priv);
1302int	drm_update_draw(struct drm_device *dev, void *data,
1303			struct drm_file *file_priv);
1304struct drm_drawable_info *drm_get_drawable_info(struct drm_device *dev,
1305						int handle);
1306
1307/* Drawable support (drm_drawable.c) */
1308void drm_drawable_free_all(struct drm_device *dev);
1309
1310/* Authentication IOCTL support (drm_auth.c) */
1311int	drm_getmagic(struct drm_device *dev, void *data,
1312		     struct drm_file *file_priv);
1313int	drm_authmagic(struct drm_device *dev, void *data,
1314		      struct drm_file *file_priv);
1315
1316/* Buffer management support (drm_bufs.c) */
1317int	drm_addmap_ioctl(struct drm_device *dev, void *data,
1318			 struct drm_file *file_priv);
1319int	drm_rmmap_ioctl(struct drm_device *dev, void *data,
1320			struct drm_file *file_priv);
1321int	drm_addbufs(struct drm_device *dev, void *data,
1322		    struct drm_file *file_priv);
1323int	drm_infobufs(struct drm_device *dev, void *data,
1324		     struct drm_file *file_priv);
1325int	drm_markbufs(struct drm_device *dev, void *data,
1326		     struct drm_file *file_priv);
1327int	drm_freebufs(struct drm_device *dev, void *data,
1328		     struct drm_file *file_priv);
1329int	drm_mapbufs(struct drm_device *dev, void *data,
1330		    struct drm_file *file_priv);
1331
1332/* DMA support (drm_dma.c) */
1333int	drm_dma(struct drm_device *dev, void *data, struct drm_file *file_priv);
1334
1335/* IRQ support (drm_irq.c) */
1336int	drm_control(struct drm_device *dev, void *data,
1337		    struct drm_file *file_priv);
1338
1339/* AGP/GART support (drm_agpsupport.c) */
1340int	drm_agp_acquire_ioctl(struct drm_device *dev, void *data,
1341			      struct drm_file *file_priv);
1342int	drm_agp_release_ioctl(struct drm_device *dev, void *data,
1343			      struct drm_file *file_priv);
1344int	drm_agp_enable_ioctl(struct drm_device *dev, void *data,
1345			     struct drm_file *file_priv);
1346int	drm_agp_info_ioctl(struct drm_device *dev, void *data,
1347			   struct drm_file *file_priv);
1348int	drm_agp_alloc_ioctl(struct drm_device *dev, void *data,
1349			    struct drm_file *file_priv);
1350int	drm_agp_free_ioctl(struct drm_device *dev, void *data,
1351			   struct drm_file *file_priv);
1352int	drm_agp_unbind_ioctl(struct drm_device *dev, void *data,
1353			     struct drm_file *file_priv);
1354int	drm_agp_bind_ioctl(struct drm_device *dev, void *data,
1355			   struct drm_file *file_priv);
1356
1357				/* Stub support (drm_stub.h) */
1358extern int drm_setmaster_ioctl(struct drm_device *dev, void *data,
1359			       struct drm_file *file_priv);
1360extern int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
1361				struct drm_file *file_priv);
1362
1363/* Scatter Gather Support (drm_scatter.c) */
1364int	drm_sg_alloc_ioctl(struct drm_device *dev, void *data,
1365			   struct drm_file *file_priv);
1366int	drm_sg_free(struct drm_device *dev, void *data,
1367		    struct drm_file *file_priv);
1368
1369/* consistent PCI memory functions (drm_pci.c) */
1370drm_dma_handle_t *drm_pci_alloc(struct drm_device *dev, size_t size,
1371				size_t align, dma_addr_t maxaddr);
1372void	drm_pci_free(struct drm_device *dev, drm_dma_handle_t *dmah);
1373
1374/* Graphics Execution Manager library functions (drm_gem.c) */
1375int drm_gem_init(struct drm_device *dev);
1376void drm_gem_destroy(struct drm_device *dev);
1377
1378int drm_gem_close_ioctl(struct drm_device *dev, void *data,
1379			struct drm_file *file_priv);
1380int drm_gem_flink_ioctl(struct drm_device *dev, void *data,
1381			struct drm_file *file_priv);
1382int drm_gem_open_ioctl(struct drm_device *dev, void *data,
1383		       struct drm_file *file_priv);
1384int drm_gem_handle_create(struct drm_file *file_priv,
1385			  struct drm_gem_object *obj,
1386			  u32 *handlep);
1387int drm_gem_handle_delete(struct drm_file *file_priv, uint32_t handle);
1388void drm_gem_object_handle_reference(struct drm_gem_object *obj);
1389void drm_gem_object_handle_unreference(struct drm_gem_object *obj);
1390void drm_gem_object_handle_unreference_unlocked(struct drm_gem_object *obj);
1391void drm_gem_object_handle_free(struct drm_gem_object *obj);
1392void drm_gem_object_reference(struct drm_gem_object *obj);
1393void drm_gem_object_unreference(struct drm_gem_object *obj);
1394void drm_gem_object_unreference_unlocked(struct drm_gem_object *obj);
1395void drm_gem_object_release(struct drm_gem_object *obj);
1396void drm_gem_object_free(struct drm_gem_object *obj);
1397int drm_gem_object_init(struct drm_device *dev, struct drm_gem_object *obj,
1398    size_t size);
1399int drm_gem_private_object_init(struct drm_device *dev,
1400    struct drm_gem_object *obj, size_t size);
1401struct drm_gem_object *drm_gem_object_alloc(struct drm_device *dev,
1402    size_t size);
1403struct drm_gem_object *drm_gem_object_lookup(struct drm_device *dev,
1404    struct drm_file *file_priv, uint32_t handle);
1405
1406void drm_gem_open(struct drm_device *dev, struct drm_file *file_priv);
1407void drm_gem_release(struct drm_device *dev, struct drm_file *file_priv);
1408
1409int drm_gem_create_mmap_offset(struct drm_gem_object *obj);
1410void drm_gem_free_mmap_offset(struct drm_gem_object *obj);
1411int drm_gem_mmap_single(struct drm_device *dev, vm_ooffset_t *offset,
1412    vm_size_t size, struct vm_object **obj_res, int nprot);
1413void drm_gem_pager_dtr(void *obj);
1414
1415struct ttm_bo_device;
1416int ttm_bo_mmap_single(struct ttm_bo_device *bdev, vm_ooffset_t *offset,
1417    vm_size_t size, struct vm_object **obj_res, int nprot);
1418struct ttm_buffer_object;
1419void ttm_bo_release_mmap(struct ttm_buffer_object *bo);
1420
1421void drm_device_lock_mtx(struct drm_device *dev);
1422void drm_device_unlock_mtx(struct drm_device *dev);
1423int drm_device_sleep_mtx(struct drm_device *dev, void *chan, int flags,
1424    const char *msg, int timeout);
1425void drm_device_assert_mtx_locked(struct drm_device *dev);
1426void drm_device_assert_mtx_unlocked(struct drm_device *dev);
1427
1428void drm_device_lock_struct(struct drm_device *dev);
1429void drm_device_unlock_struct(struct drm_device *dev);
1430int drm_device_sleep_struct(struct drm_device *dev, void *chan, int flags,
1431    const char *msg, int timeout);
1432void drm_device_assert_struct_locked(struct drm_device *dev);
1433void drm_device_assert_struct_unlocked(struct drm_device *dev);
1434
1435void drm_compat_locking_init(struct drm_device *dev);
1436void drm_sleep_locking_init(struct drm_device *dev);
1437
1438/* drm_modes.c */
1439bool drm_mode_parse_command_line_for_connector(const char *mode_option,
1440    struct drm_connector *connector, struct drm_cmdline_mode *mode);
1441struct drm_display_mode *drm_mode_create_from_cmdline_mode(
1442    struct drm_device *dev, struct drm_cmdline_mode *cmd);
1443
1444/* drm_edid.c */
1445u8 *drm_find_cea_extension(struct edid *edid);
1446
1447/* Inline replacements for drm_alloc and friends */
1448static __inline__ void *
1449drm_alloc(size_t size, struct malloc_type *area)
1450{
1451	return malloc(size, area, M_NOWAIT);
1452}
1453
1454static __inline__ void *
1455drm_calloc(size_t nmemb, size_t size, struct malloc_type *area)
1456{
1457	return malloc(size * nmemb, area, M_NOWAIT | M_ZERO);
1458}
1459
1460static __inline__ void *
1461drm_realloc(void *oldpt, size_t oldsize, size_t size,
1462    struct malloc_type *area)
1463{
1464	return reallocf(oldpt, size, area, M_NOWAIT);
1465}
1466
1467static __inline__ void
1468drm_free(void *pt, size_t size, struct malloc_type *area)
1469{
1470	free(pt, area);
1471}
1472
1473/* Inline replacements for DRM_IOREMAP macros */
1474static __inline__ void
1475drm_core_ioremap_wc(struct drm_local_map *map, struct drm_device *dev)
1476{
1477	map->virtual = drm_ioremap_wc(dev, map);
1478}
1479static __inline__ void
1480drm_core_ioremap(struct drm_local_map *map, struct drm_device *dev)
1481{
1482	map->virtual = drm_ioremap(dev, map);
1483}
1484static __inline__ void
1485drm_core_ioremapfree(struct drm_local_map *map, struct drm_device *dev)
1486{
1487	if ( map->virtual && map->size )
1488		drm_ioremapfree(map);
1489}
1490
1491static __inline__ struct drm_local_map *
1492drm_core_findmap(struct drm_device *dev, unsigned long offset)
1493{
1494	drm_local_map_t *map;
1495
1496	DRM_LOCK_ASSERT(dev);
1497	TAILQ_FOREACH(map, &dev->maplist, link) {
1498		if (offset == (unsigned long)map->handle)
1499			return map;
1500	}
1501	return NULL;
1502}
1503
1504static __inline__ void drm_core_dropmap(struct drm_map *map)
1505{
1506}
1507
1508#define DRM_PCIE_SPEED_25 1
1509#define DRM_PCIE_SPEED_50 2
1510#define DRM_PCIE_SPEED_80 4
1511
1512extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
1513
1514#define	drm_can_sleep()	(DRM_HZ & 1)
1515
1516#endif /* __KERNEL__ */
1517#endif /* _DRM_P_H_ */
1518