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

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