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