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