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