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