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