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