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