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