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