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