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

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