sys/dev/drm/include/drm/drmP.h

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