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