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         /**
 493          * fbs - List of framebuffers associated with this file.
 494          *
 495          * Protected by fbs_lock. Note that the fbs list holds a reference on
 496          * the fb object to prevent it from untimely disappearing.
 497          */
 498         struct list_head fbs;
 499         struct lock fbs_lock;
 500
 501         wait_queue_head_t event_wait;
 502         struct list_head  event_list;
 503         int               event_space;
 504
 505         struct drm_prime_file_private prime;
 506 };
 507
 508 /**
 509  * Lock data.
 510  */
 511 struct drm_lock_data {
 512         struct drm_hw_lock *hw_lock;    /**< Hardware lock */
 513         /** Private of lock holder's file (NULL=kernel) */
 514         struct drm_file *file_priv;
 515         wait_queue_head_t lock_queue;   /**< Queue of blocked processes */
 516         unsigned long lock_time;        /**< Time of last lock in jiffies */
 517 };
 518
 519 /* This structure, in the struct drm_device, is always initialized while the
 520  * device
 521  * is open.  dev->dma_lock protects the incrementing of dev->buf_use, which
 522  * when set marks that no further bufs may be allocated until device teardown
 523  * occurs (when the last open of the device has closed).  The high/low
 524  * watermarks of bufs are only touched by the X Server, and thus not
 525  * concurrently accessed, so no locking is needed.
 526  */
 527 typedef struct drm_device_dma {
 528
 529         struct drm_buf_entry bufs[DRM_MAX_ORDER + 1];   /**< buffers, grouped by their size order */
 530         int buf_count;                  /**< total number of buffers */
 531         struct drm_buf **buflist;               /**< Vector of pointers into drm_device_dma::bufs */
 532         int seg_count;
 533         int page_count;                 /**< number of pages */
 534         unsigned long *pagelist;        /**< page list */
 535         unsigned long byte_count;
 536         enum {
 537                 _DRM_DMA_USE_AGP = 0x01,
 538                 _DRM_DMA_USE_SG = 0x02,
 539                 _DRM_DMA_USE_FB = 0x04,
 540                 _DRM_DMA_USE_PCI_RO = 0x08
 541         } flags;
 542
 543 } drm_device_dma_t;
 544
 545 typedef struct drm_agp_mem {
 546         void               *handle;
 547         unsigned long      bound; /* address */
 548         int                pages;
 549         struct drm_agp_mem *prev;
 550         struct drm_agp_mem *next;
 551 } drm_agp_mem_t;
 552
 553 typedef struct drm_agp_head {
 554         device_t           agpdev;
 555         struct agp_info    agp_info;
 556         const char         *chipset;
 557         drm_agp_mem_t      *memory;
 558         unsigned long      mode;
 559         int                enabled;
 560         int                acquired;
 561         unsigned long      base;
 562         int                agp_mtrr;
 563         int                cant_use_aperture;
 564         unsigned long      page_mask;
 565 } drm_agp_head_t;
 566
 567 typedef struct drm_sg_mem {
 568         vm_offset_t vaddr;
 569         vm_paddr_t *busaddr;
 570         vm_pindex_t pages;
 571 } drm_sg_mem_t;
 572
 573 /**
 574  * Kernel side of a mapping
 575  */
 576 struct drm_local_map {
 577         resource_size_t offset;  /**< Requested physical address (0 for SAREA)*/
 578         unsigned long size;      /**< Requested physical size (bytes) */
 579         enum drm_map_type type;  /**< Type of memory to map */
 580         enum drm_map_flags flags;        /**< Flags */
 581         void *handle;            /**< User-space: "Handle" to pass to mmap() */
 582                                  /**< Kernel-space: kernel-virtual address */
 583         int mtrr;                /**< MTRR slot used */
 584 };
 585
 586 typedef struct drm_local_map drm_local_map_t;
 587
 588 /**
 589  * Mappings list
 590  */
 591 struct drm_map_list {
 592         struct list_head head;          /**< list head */
 593         struct drm_hash_item hash;
 594         struct drm_local_map *map;      /**< mapping */
 595         uint64_t user_token;
 596         struct drm_master *master;
 597         struct drm_mm_node *file_offset_node;   /**< fake offset */
 598 };
 599
 600 /**
 601  * Context handle list
 602  */
 603 struct drm_ctx_list {
 604         struct list_head head;          /**< list head */
 605         drm_context_t handle;           /**< context handle */
 606         struct drm_file *tag;           /**< associated fd private data */
 607 };
 608
 609 struct drm_vblank_info {
 610         wait_queue_head_t queue;        /* vblank wait queue */
 611         atomic_t count;                 /* number of VBLANK interrupts */
 612                                         /* (driver must alloc the right number of counters) */
 613         atomic_t refcount;              /* number of users of vblank interrupts */
 614         u32 last;                       /* protected by dev->vbl_lock, used */
 615                                         /* for wraparound handling */
 616         int enabled;                    /* so we don't call enable more than */
 617                                         /* once per disable */
 618         int inmodeset;                  /* Display driver is setting mode */
 619 };
 620
 621 /* location of GART table */
 622 #define DRM_ATI_GART_MAIN 1
 623 #define DRM_ATI_GART_FB   2
 624
 625 #define DRM_ATI_GART_PCI 1
 626 #define DRM_ATI_GART_PCIE 2
 627 #define DRM_ATI_GART_IGP 3
 628
 629 struct drm_ati_pcigart_info {
 630         int gart_table_location;
 631         int gart_reg_if;
 632         void *addr;
 633         dma_addr_t bus_addr;
 634         dma_addr_t table_mask;
 635         dma_addr_t member_mask;
 636         struct drm_dma_handle *table_handle;
 637         drm_local_map_t mapping;
 638         int table_size;
 639         struct drm_dma_handle *dmah; /* handle for ATI PCIGART table */
 640 };
 641
 642 /**
 643  * GEM specific mm private for tracking GEM objects
 644  */
 645 struct drm_gem_mm {
 646         struct drm_open_hash offset_hash; /**< User token hash table for maps */
 647         struct unrhdr *idxunr;
 648 };
 649
 650 struct drm_gem_object {
 651         /** Reference count of this object */
 652         struct kref refcount;
 653
 654         /** Handle count of this object. Each handle also holds a reference */
 655         atomic_t handle_count; /* number of handles on this object */
 656
 657         /** Related drm device */
 658         struct drm_device *dev;
 659
 660         /** File representing the shmem storage: filp in Linux parlance */
 661         vm_object_t vm_obj;
 662
 663         bool on_map;
 664         struct drm_hash_item map_list;
 665
 666         /**
 667          * Size of the object, in bytes.  Immutable over the object's
 668          * lifetime.
 669          */
 670         size_t size;
 671
 672         /**
 673          * Global name for this object, starts at 1. 0 means unnamed.
 674          * Access is covered by the object_name_lock in the related drm_device
 675          */
 676         int name;
 677
 678         /**
 679          * Memory domains. These monitor which caches contain read/write data
 680          * related to the object. When transitioning from one set of domains
 681          * to another, the driver is called to ensure that caches are suitably
 682          * flushed and invalidated
 683          */
 684         uint32_t read_domains;
 685         uint32_t write_domain;
 686
 687         /**
 688          * While validating an exec operation, the
 689          * new read/write domain values are computed here.
 690          * They will be transferred to the above values
 691          * at the point that any cache flushing occurs
 692          */
 693         uint32_t pending_read_domains;
 694         uint32_t pending_write_domain;
 695
 696         void *driver_private;
 697
 698 #ifdef DUMBBELL_WIP
 699         /* dma buf exported from this GEM object */
 700         struct dma_buf *export_dma_buf;
 701
 702         /* dma buf attachment backing this object */
 703         struct dma_buf_attachment *import_attach;
 704 #endif /* DUMBBELL_WIP */
 705 };
 706
 707 #include "drm_crtc.h"
 708
 709 /* per-master structure */
 710 struct drm_master {
 711
 712         struct kref refcount; /* refcount for this master */
 713
 714         struct list_head head; /**< each minor contains a list of masters */
 715         struct drm_minor *minor; /**< link back to minor we are a master for */
 716
 717         char *unique;                   /**< Unique identifier: e.g., busid */
 718         int unique_len;                 /**< Length of unique field */
 719         int unique_size;                /**< amount allocated */
 720
 721         int blocked;                    /**< Blocked due to VC switch? */
 722
 723         /** \name Authentication */
 724         /*@{ */
 725         struct drm_open_hash magiclist;
 726         struct list_head magicfree;
 727         /*@} */
 728
 729         struct drm_lock_data lock;      /**< Information on hardware lock */
 730
 731         void *driver_priv; /**< Private structure for driver to use */
 732 };
 733
 734 /* Size of ringbuffer for vblank timestamps. Just double-buffer
 735  * in initial implementation.
 736  */
 737 #define DRM_VBLANKTIME_RBSIZE 2
 738
 739 /* Flags and return codes for get_vblank_timestamp() driver function. */
 740 #define DRM_CALLED_FROM_VBLIRQ 1
 741 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
 742 #define DRM_VBLANKTIME_INVBL             (1 << 1)
 743
 744 /* get_scanout_position() return flags */
 745 #define DRM_SCANOUTPOS_VALID        (1 << 0)
 746 #define DRM_SCANOUTPOS_INVBL        (1 << 1)
 747 #define DRM_SCANOUTPOS_ACCURATE     (1 << 2)
 748
 749 #ifndef DMA_BIT_MASK
 750 #define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : (1ULL<<(n)) - 1)
 751 #endif
 752
 753 #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
 754
 755 struct drm_driver {
 756         int     (*load)(struct drm_device *, unsigned long flags);
 757         int     (*use_msi)(struct drm_device *, unsigned long flags);
 758         int     (*firstopen)(struct drm_device *);
 759         int     (*open)(struct drm_device *, struct drm_file *);
 760         void    (*preclose)(struct drm_device *, struct drm_file *file_priv);
 761         void    (*postclose)(struct drm_device *, struct drm_file *);
 762         void    (*lastclose)(struct drm_device *);
 763         int     (*unload)(struct drm_device *);
 764         void    (*reclaim_buffers_locked)(struct drm_device *,
 765                                           struct drm_file *file_priv);
 766         int     (*dma_ioctl)(struct drm_device *dev, void *data,
 767                              struct drm_file *file_priv);
 768         void    (*dma_ready)(struct drm_device *);
 769         int     (*dma_quiescent)(struct drm_device *);
 770         int     (*dma_flush_block_and_flush)(struct drm_device *, int context,
 771                                              enum drm_lock_flags flags);
 772         int     (*dma_flush_unblock)(struct drm_device *, int context,
 773                                      enum drm_lock_flags flags);
 774         int     (*context_ctor)(struct drm_device *dev, int context);
 775         int     (*context_dtor)(struct drm_device *dev, int context);
 776         int     (*kernel_context_switch)(struct drm_device *dev, int old,
 777                                          int new);
 778         int     (*kernel_context_switch_unlock)(struct drm_device *dev);
 779         void    (*irq_preinstall)(struct drm_device *dev);
 780         int     (*irq_postinstall)(struct drm_device *dev);
 781         void    (*irq_uninstall)(struct drm_device *dev);
 782         void    (*irq_handler)(DRM_IRQ_ARGS);
 783
 784         u32     (*get_vblank_counter)(struct drm_device *dev, int crtc);
 785         int     (*enable_vblank)(struct drm_device *dev, int crtc);
 786         void    (*disable_vblank)(struct drm_device *dev, int crtc);
 787         int     (*get_scanout_position)(struct drm_device *dev, int crtc,
 788                     int *vpos, int *hpos);
 789
 790         int     (*get_vblank_timestamp)(struct drm_device *dev, int crtc,
 791                     int *max_error, struct timeval *vblank_time,
 792                     unsigned flags);
 793
 794         int     (*gem_init_object)(struct drm_gem_object *obj);
 795         void    (*gem_free_object)(struct drm_gem_object *obj);
 796         int     (*gem_open_object)(struct drm_gem_object *, struct drm_file *);
 797         void    (*gem_close_object)(struct drm_gem_object *, struct drm_file *);
 798
 799         struct cdev_pager_ops *gem_pager_ops;
 800
 801         int     (*dumb_create)(struct drm_file *file_priv,
 802                     struct drm_device *dev, struct drm_mode_create_dumb *args);
 803         int     (*dumb_map_offset)(struct drm_file *file_priv,
 804                     struct drm_device *dev, uint32_t handle, uint64_t *offset);
 805         int     (*dumb_destroy)(struct drm_file *file_priv,
 806                     struct drm_device *dev, uint32_t handle);
 807
 808         int     (*sysctl_init)(struct drm_device *dev,
 809                     struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
 810         void    (*sysctl_cleanup)(struct drm_device *dev);
 811
 812         drm_pci_id_list_t *id_entry;    /* PCI ID, name, and chipset private */
 813
 814         /**
 815          * Called by \c drm_device_is_agp.  Typically used to determine if a
 816          * card is really attached to AGP or not.
 817          *
 818          * \param dev  DRM device handle
 819          *
 820          * \returns
 821          * One of three values is returned depending on whether or not the
 822          * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
 823          * (return of 1), or may or may not be AGP (return of 2).
 824          */
 825         int     (*device_is_agp) (struct drm_device * dev);
 826
 827         drm_ioctl_desc_t *ioctls;
 828 #ifdef COMPAT_FREEBSD32
 829         drm_ioctl_desc_t *compat_ioctls;
 830         int     *compat_ioctls_nr;
 831 #endif
 832
 833         int     buf_priv_size;
 834
 835         int     major;
 836         int     minor;
 837         int     patchlevel;
 838         const char *name;               /* Simple driver name              */
 839         const char *desc;               /* Longer driver name              */
 840         const char *date;               /* Date of last major changes.     */
 841
 842         u32 driver_features;
 843         int num_ioctls;
 844 };
 845
 846 /**
 847  * DRM minor structure. This structure represents a drm minor number.
 848  */
 849 struct drm_minor {
 850         int index;                      /**< Minor device number */
 851         int type;                       /**< Control or render */
 852         device_t kdev;                  /**< OS device */
 853         struct drm_device *dev;
 854
 855         struct drm_master *master; /* currently active master for this node */
 856         struct list_head master_list;
 857         struct drm_mode_group mode_group;
 858 };
 859
 860 /* mode specified on the command line */
 861 struct drm_cmdline_mode {
 862         bool specified;
 863         bool refresh_specified;
 864         bool bpp_specified;
 865         int xres, yres;
 866         int bpp;
 867         int refresh;
 868         bool rb;
 869         bool interlace;
 870         bool cvt;
 871         bool margins;
 872         enum drm_connector_force force;
 873 };
 874
 875
 876 struct drm_pending_vblank_event {
 877         struct drm_pending_event base;
 878         int pipe;
 879         struct drm_event_vblank event;
 880 };
 881
 882 struct drm_sysctl_info {
 883         struct sysctl_ctx_list ctx;
 884         char   name[2];
 885 };
 886
 887 /* Length for the array of resource pointers for drm_get_resource_*. */
 888 #define DRM_MAX_PCI_RESOURCE    6
 889
 890 /**
 891  * DRM device structure. This structure represent a complete card that
 892  * may contain multiple heads.
 893  */
 894 struct drm_device {
 895         drm_pci_id_list_t *id_entry;    /* PCI ID, name, and chipset private */
 896
 897         uint16_t pci_subdevice;         /* PCI subsystem device id */
 898         uint16_t pci_subvendor;         /* PCI subsystem vendor id */
 899
 900         char              *unique;      /* Unique identifier: e.g., busid  */
 901         int               unique_len;   /* Length of unique field          */
 902         struct cdev       *devnode;     /* Device number for mknod         */
 903         int               if_version;   /* Highest interface version set */
 904
 905         int               flags;        /* Flags to open(2)                */
 906
 907                                 /* Locks */
 908         struct spinlock   dma_lock;     /* protects dev->dma */
 909         struct lwkt_serialize irq_lock; /* protects irq condition checks */
 910         struct lock       dev_lock;     /* protects everything else */
 911
 912         /** \name Locks */
 913         /*@{ */
 914         struct lock struct_mutex;       /**< For others */
 915         /*@} */
 916
 917         /** \name Usage Counters */
 918         /*@{ */
 919         int               open_count;   /* Outstanding files open          */
 920         int               buf_use;      /* Buffers in use -- cannot alloc  */
 921         /*@} */
 922
 923
 924         /** \name Performance counters */
 925         /*@{ */
 926         unsigned long     counters;
 927         enum drm_stat_type      types[15];
 928         atomic_t          counts[15];
 929         /*@} */
 930
 931                                 /* Authentication */
 932         drm_magic_head_t  magiclist[DRM_HASH_SIZE];
 933
 934         struct list_head filelist;
 935
 936         /** \name Memory management */
 937         /*@{ */
 938         struct list_head maplist;       /**< Linked list of regions */
 939         int map_count;                  /**< Number of mappable regions */
 940         struct drm_open_hash map_hash;  /**< User token hash table for maps */
 941
 942         /** \name Context handle management */
 943         /*@{ */
 944         struct list_head ctxlist;       /**< Linked list of context handles */
 945         int ctx_count;                  /**< Number of context handles */
 946         struct lock ctxlist_mutex;      /**< For ctxlist */
 947
 948         struct idr ctx_idr;
 949
 950         /*@} */
 951
 952         struct drm_lock_data lock;      /* Information on hardware lock    */
 953
 954                                 /* DMA queues (contexts) */
 955         drm_device_dma_t  *dma;         /* Optional pointer for DMA support */
 956
 957         int               irq;          /* Interrupt used by board         */
 958         int               msi_enabled;  /* MSI enabled */
 959         int               irqrid;       /* Interrupt used by board */
 960         struct resource   *irqr;        /* Resource for interrupt used by board    */
 961         void              *irqh;        /* Handle from bus_setup_intr      */
 962
 963         /* Storage of resource pointers for drm_get_resource_* */
 964         struct resource   *pcir[DRM_MAX_PCI_RESOURCE];
 965         int               pcirid[DRM_MAX_PCI_RESOURCE];
 966
 967         int               pci_domain;
 968         int               pci_bus;
 969         int               pci_slot;
 970         int               pci_func;
 971
 972         /** \name Context support */
 973         /*@{ */
 974         int irq_enabled;                /**< True if irq handler is enabled */
 975         __volatile__ long context_flag; /**< Context swapping flag */
 976         __volatile__ long interrupt_flag; /**< Interruption handler flag */
 977         __volatile__ long dma_flag;     /**< DMA dispatch flag */
 978         wait_queue_head_t context_wait; /**< Processes waiting on ctx switch */
 979         int last_checked;               /**< Last context checked for DMA */
 980         int last_context;               /**< Last current context */
 981         unsigned long last_switch;      /**< jiffies at last context switch */
 982         /*@} */
 983
 984         int               num_crtcs;
 985
 986         struct sigio      *buf_sigio;   /* Processes waiting for SIGIO     */
 987
 988                                 /* Sysctl support */
 989         struct drm_sysctl_info *sysctl;
 990         int               sysctl_node_idx;
 991
 992
 993         drm_sg_mem_t      *sg;  /* Scatter gather memory */
 994         unsigned long     *ctx_bitmap;
 995         void              *dev_private;
 996
 997         void              *drm_ttm_bdev;
 998
 999         /*
1000          * At load time, disabling the vblank interrupt won't be allowed since
1001          * old clients may not call the modeset ioctl and therefore misbehave.
1002          * Once the modeset ioctl *has* been called though, we can safely
1003          * disable them when unused.
1004          */
1005         int vblank_disable_allowed;
1006
1007         wait_queue_head_t *vbl_queue;   /**< VBLANK wait queue */
1008         atomic_t *_vblank_count;        /**< number of VBLANK interrupts (driver must alloc the right number of counters) */
1009         struct timeval *_vblank_time;   /**< timestamp of current vblank_count (drivers must alloc right number of fields) */
1010         struct lock vblank_time_lock;   /**< Protects vblank count and time updates during vblank enable/disable */
1011         struct lock vbl_lock;
1012         atomic_t *vblank_refcount;      /* number of users of vblank interruptsper crtc */
1013         u32 *last_vblank;               /* protected by dev->vbl_lock, used */
1014                                         /* for wraparound handling */
1015         int *vblank_enabled;            /* so we don't call enable more than
1016                                            once per disable */
1017         int *vblank_inmodeset;          /* Display driver is setting mode */
1018         u32 *last_vblank_wait;          /* Last vblank seqno waited per CRTC */
1019         struct timer_list vblank_disable_timer;
1020
1021         u32 max_vblank_count;           /**< size of vblank counter register */
1022
1023         /**
1024          * List of events
1025          */
1026         struct list_head vblank_event_list;
1027         struct lock     event_lock;
1028
1029         /*@} */
1030
1031         struct drm_agp_head *agp;       /**< AGP data */
1032
1033         struct device *dev;             /**< Device structure */
1034         struct pci_dev *pdev;           /**< PCI device structure */
1035         int pci_vendor;                 /**< PCI vendor id */
1036         int pci_device;                 /**< PCI device id */
1037
1038         struct drm_driver *driver;
1039         struct drm_local_map *agp_buffer_map;
1040         unsigned int agp_buffer_token;
1041         struct drm_minor *control;              /**< Control node for card */
1042         struct drm_minor *primary;              /**< render type primary screen head */
1043
1044         struct drm_mode_config mode_config;     /**< Current mode config */
1045
1046         /** \name GEM information */
1047         /*@{ */
1048         struct lock object_name_lock;
1049         struct idr object_name_idr;
1050         /*@} */
1051         void             *mm_private;
1052
1053         void *sysctl_private;
1054         char busid_str[128];
1055         int modesetting;
1056
1057         int switch_power_state;
1058 };
1059
1060 #define DRM_SWITCH_POWER_ON 0
1061 #define DRM_SWITCH_POWER_OFF 1
1062 #define DRM_SWITCH_POWER_CHANGING 2
1063
1064 static __inline__ int drm_core_check_feature(struct drm_device *dev,
1065                                              int feature)
1066 {
1067         return ((dev->driver->driver_features & feature) ? 1 : 0);
1068 }
1069
1070 #if __OS_HAS_AGP
1071 static inline int drm_core_has_AGP(struct drm_device *dev)
1072 {
1073         return drm_core_check_feature(dev, DRIVER_USE_AGP);
1074 }
1075 #else
1076 #define drm_core_has_AGP(dev) (0)
1077 #endif
1078
1079 enum dmi_field {
1080         DMI_NONE,
1081         DMI_BIOS_VENDOR,
1082         DMI_BIOS_VERSION,
1083         DMI_BIOS_DATE,
1084         DMI_SYS_VENDOR,
1085         DMI_PRODUCT_NAME,
1086         DMI_PRODUCT_VERSION,
1087         DMI_PRODUCT_SERIAL,
1088         DMI_PRODUCT_UUID,
1089         DMI_BOARD_VENDOR,
1090         DMI_BOARD_NAME,
1091         DMI_BOARD_VERSION,
1092         DMI_BOARD_SERIAL,
1093         DMI_BOARD_ASSET_TAG,
1094         DMI_CHASSIS_VENDOR,
1095         DMI_CHASSIS_TYPE,
1096         DMI_CHASSIS_VERSION,
1097         DMI_CHASSIS_SERIAL,
1098         DMI_CHASSIS_ASSET_TAG,
1099         DMI_STRING_MAX,
1100 };
1101
1102 struct dmi_strmatch {
1103         unsigned char slot;
1104         char substr[79];
1105 };
1106
1107 struct dmi_system_id {
1108         int (*callback)(const struct dmi_system_id *);
1109         const char *ident;
1110         struct dmi_strmatch matches[4];
1111 };
1112 #define DMI_MATCH(a, b) {(a), (b)}
1113 bool dmi_check_system(const struct dmi_system_id *);
1114
1115 extern int      drm_notyet_flag;
1116 extern int      drm_debug;
1117
1118 extern unsigned int drm_vblank_offdelay;
1119 extern unsigned int drm_timestamp_precision;
1120 extern unsigned int drm_timestamp_monotonic;
1121
1122 /* Device setup support (drm_drv.c) */
1123 int     drm_probe(device_t kdev, drm_pci_id_list_t *idlist);
1124 int     drm_attach(device_t kdev, drm_pci_id_list_t *idlist);
1125 int     drm_create_cdevs(device_t kdev);
1126
1127 d_ioctl_t drm_ioctl;
1128 extern int drm_lastclose(struct drm_device *dev);
1129
1130                                 /* Device support (drm_fops.h) */
1131 d_open_t drm_open;
1132 d_close_t drm_close;
1133 d_read_t drm_read;
1134 d_kqfilter_t drm_kqfilter;
1135 int drm_release(device_t kdev);
1136
1137 d_mmap_t drm_mmap;
1138 d_mmap_single_t drm_mmap_single;
1139 extern drm_local_map_t  *drm_getsarea(struct drm_device *dev);
1140
1141 void drm_cdevpriv_dtor(void *cd);
1142
1143 void drm_event_wakeup(struct drm_pending_event *e);
1144
1145 int drm_add_busid_modesetting(struct drm_device *dev,
1146     struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
1147
1148 /* File operations helpers (drm_fops.c) */
1149 extern int              drm_open_helper(struct cdev *kdev, int flags, int fmt,
1150                                          DRM_STRUCTPROC *p,
1151                                         struct drm_device *dev,
1152                                         struct file *fp);
1153 extern struct drm_file  *drm_find_file_by_proc(struct drm_device *dev,
1154                                         DRM_STRUCTPROC *p);
1155
1156 #ifdef DUMBBELL_WIP
1157 extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
1158                 struct drm_file *file_priv, uint32_t handle, uint32_t flags,
1159                 int *prime_fd);
1160 extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
1161                 struct drm_file *file_priv, int prime_fd, uint32_t *handle);
1162
1163 extern int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data,
1164                                         struct drm_file *file_priv);
1165 extern int drm_prime_fd_to_handle_ioctl(struct drm_device *dev, void *data,
1166                                         struct drm_file *file_priv);
1167
1168 #ifdef DUMBBELL_WIP
1169 /*
1170  * See drm_prime.c
1171  *   -- dumbbell@
1172  */
1173 extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, vm_page_t *pages,
1174                                             dma_addr_t *addrs, int max_pages);
1175 #endif /* DUMBBELL_WIP */
1176 extern struct sg_table *drm_prime_pages_to_sg(vm_page_t *pages, int nr_pages);
1177 extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
1178
1179
1180 void drm_prime_init_file_private(struct drm_prime_file_private *prime_fpriv);
1181 void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv);
1182 int drm_prime_add_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf, uint32_t handle);
1183 int drm_prime_lookup_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf, uint32_t *handle);
1184 void drm_prime_remove_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf);
1185
1186 int drm_prime_add_dma_buf(struct drm_device *dev, struct drm_gem_object *obj);
1187 int drm_prime_lookup_obj(struct drm_device *dev, struct dma_buf *buf,
1188                          struct drm_gem_object **obj);
1189 #endif /* DUMBBELL_WIP */
1190
1191 /* Memory management support (drm_memory.c) */
1192 void    drm_mem_init(void);
1193 void    drm_mem_uninit(void);
1194 void    *drm_ioremap_wc(struct drm_device *dev, drm_local_map_t *map);
1195 void    *drm_ioremap(struct drm_device *dev, drm_local_map_t *map);
1196 void    drm_ioremapfree(drm_local_map_t *map);
1197 int     drm_mtrr_add(unsigned long offset, size_t size, int flags);
1198 int     drm_mtrr_del(int handle, unsigned long offset, size_t size, int flags);
1199
1200 int     drm_ctxbitmap_init(struct drm_device *dev);
1201 void    drm_ctxbitmap_cleanup(struct drm_device *dev);
1202 void    drm_ctxbitmap_free(struct drm_device *dev, int ctx_handle);
1203
1204 /* Locking IOCTL support (drm_lock.c) */
1205 int     drm_lock_take(struct drm_lock_data *lock_data,
1206                       unsigned int context);
1207 int     drm_lock_transfer(struct drm_lock_data *lock_data,
1208                           unsigned int context);
1209 int     drm_lock_free(struct drm_lock_data *lock_data,
1210                       unsigned int context);
1211
1212 /*
1213  * These are exported to drivers so that they can implement fencing using
1214  * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
1215  */
1216
1217 unsigned long drm_get_resource_start(struct drm_device *dev,
1218                                      unsigned int resource);
1219 unsigned long drm_get_resource_len(struct drm_device *dev,
1220                                    unsigned int resource);
1221 void    drm_rmmap(struct drm_device *dev, drm_local_map_t *map);
1222 int     drm_order(unsigned long size);
1223 int     drm_addbufs_agp(struct drm_device *dev, struct drm_buf_desc *request);
1224 int     drm_addbufs_pci(struct drm_device *dev, struct drm_buf_desc *request);
1225 extern int drm_addmap(struct drm_device *dev, resource_size_t offset,
1226                       unsigned int size, enum drm_map_type type,
1227                       enum drm_map_flags flags, struct drm_local_map **map_ptr);
1228
1229 /* DMA support (drm_dma.c) */
1230 int     drm_dma_setup(struct drm_device *dev);
1231 void    drm_dma_takedown(struct drm_device *dev);
1232 void    drm_free_buffer(struct drm_device *dev, drm_buf_t *buf);
1233 void    drm_reclaim_buffers(struct drm_device *dev, struct drm_file *file_priv);
1234 #define drm_core_reclaim_buffers drm_reclaim_buffers
1235
1236                                 /* IRQ support (drm_irq.h) */
1237 int     drm_irq_install(struct drm_device *dev);
1238 int     drm_irq_uninstall(struct drm_device *dev);
1239 void    drm_driver_irq_preinstall(struct drm_device *dev);
1240 void    drm_driver_irq_postinstall(struct drm_device *dev);
1241 void    drm_driver_irq_uninstall(struct drm_device *dev);
1242
1243 void    drm_vblank_pre_modeset(struct drm_device *dev, int crtc);
1244 void    drm_vblank_post_modeset(struct drm_device *dev, int crtc);
1245 int     drm_modeset_ctl(struct drm_device *dev, void *data,
1246                         struct drm_file *file_priv);
1247
1248 extern int drm_vblank_init(struct drm_device *dev, int num_crtcs);
1249 extern int drm_wait_vblank(struct drm_device *dev, void *data,
1250                            struct drm_file *filp);
1251 extern int drm_vblank_wait(struct drm_device *dev, unsigned int *vbl_seq);
1252 extern u32 drm_vblank_count(struct drm_device *dev, int crtc);
1253 extern u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
1254                                      struct timeval *vblanktime);
1255 extern void drm_send_vblank_event(struct drm_device *dev, int crtc,
1256                                      struct drm_pending_vblank_event *e);
1257 extern bool drm_handle_vblank(struct drm_device *dev, int crtc);
1258 void drm_handle_vblank_events(struct drm_device *dev, int crtc);
1259 extern int drm_vblank_get(struct drm_device *dev, int crtc);
1260 extern void drm_vblank_put(struct drm_device *dev, int crtc);
1261 extern void drm_vblank_off(struct drm_device *dev, int crtc);
1262 extern void drm_vblank_cleanup(struct drm_device *dev);
1263 extern u32 drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
1264                                      struct timeval *tvblank, unsigned flags);
1265 extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
1266                                                  int crtc, int *max_error,
1267                                                  struct timeval *vblank_time,
1268                                                  unsigned flags,
1269                                                  struct drm_crtc *refcrtc);
1270 extern void drm_calc_timestamping_constants(struct drm_crtc *crtc);
1271
1272 /* AGP/PCI Express/GART support (drm_agpsupport.c) */
1273 int     drm_device_is_agp(struct drm_device *dev);
1274 int     drm_device_is_pcie(struct drm_device *dev);
1275 drm_agp_head_t *drm_agp_init(void);
1276 int     drm_agp_acquire(struct drm_device *dev);
1277 int     drm_agp_release(struct drm_device *dev);
1278 int     drm_agp_info(struct drm_device * dev, struct drm_agp_info *info);
1279 int     drm_agp_enable(struct drm_device *dev, struct drm_agp_mode mode);
1280 void    *drm_agp_allocate_memory(size_t pages, u32 type);
1281 int     drm_agp_free_memory(void *handle);
1282 int     drm_agp_bind_memory(void *handle, off_t start);
1283 int     drm_agp_unbind_memory(void *handle);
1284 int     drm_agp_alloc(struct drm_device *dev, struct drm_agp_buffer *request);
1285 int     drm_agp_free(struct drm_device *dev, struct drm_agp_buffer *request);
1286 int     drm_agp_bind(struct drm_device *dev, struct drm_agp_binding *request);
1287 int     drm_agp_unbind(struct drm_device *dev, struct drm_agp_binding *request);
1288
1289 /* Scatter Gather Support (drm_scatter.c) */
1290 void    drm_sg_cleanup(drm_sg_mem_t *entry);
1291 int     drm_sg_alloc(struct drm_device *dev, struct drm_scatter_gather * request);
1292
1293 /* sysctl support (drm_sysctl.h) */
1294 extern int              drm_sysctl_init(struct drm_device *dev);
1295 extern int              drm_sysctl_cleanup(struct drm_device *dev);
1296
1297 /* ATI PCIGART support (ati_pcigart.c) */
1298 int     drm_ati_pcigart_init(struct drm_device *dev,
1299                                 struct drm_ati_pcigart_info *gart_info);
1300 int     drm_ati_pcigart_cleanup(struct drm_device *dev,
1301                                 struct drm_ati_pcigart_info *gart_info);
1302
1303 /* Cache management (drm_memory.c) */
1304 void    drm_clflush_pages(vm_page_t *pages, unsigned long num_pages);
1305
1306 /* Locking IOCTL support (drm_drv.c) */
1307 int     drm_lock(struct drm_device *dev, void *data,
1308                  struct drm_file *file_priv);
1309 int     drm_unlock(struct drm_device *dev, void *data,
1310                    struct drm_file *file_priv);
1311 int     drm_version(struct drm_device *dev, void *data,
1312                     struct drm_file *file_priv);
1313 int     drm_setversion(struct drm_device *dev, void *data,
1314                        struct drm_file *file_priv);
1315
1316 /* Misc. IOCTL support (drm_ioctl.c) */
1317 int     drm_irq_by_busid(struct drm_device *dev, void *data,
1318                          struct drm_file *file_priv);
1319 int     drm_getunique(struct drm_device *dev, void *data,
1320                       struct drm_file *file_priv);
1321 int     drm_setunique(struct drm_device *dev, void *data,
1322                       struct drm_file *file_priv);
1323 int     drm_getmap(struct drm_device *dev, void *data,
1324                    struct drm_file *file_priv);
1325 int     drm_getclient(struct drm_device *dev, void *data,
1326                       struct drm_file *file_priv);
1327 int     drm_getstats(struct drm_device *dev, void *data,
1328                      struct drm_file *file_priv);
1329 int     drm_getcap(struct drm_device *dev, void *data,
1330                      struct drm_file *file_priv);
1331 int     drm_noop(struct drm_device *dev, void *data,
1332                  struct drm_file *file_priv);
1333
1334 /* Context IOCTL support (drm_context.c) */
1335 int     drm_resctx(struct drm_device *dev, void *data,
1336                    struct drm_file *file_priv);
1337 int     drm_addctx(struct drm_device *dev, void *data,
1338                    struct drm_file *file_priv);
1339 int     drm_modctx(struct drm_device *dev, void *data,
1340                    struct drm_file *file_priv);
1341 int     drm_getctx(struct drm_device *dev, void *data,
1342                    struct drm_file *file_priv);
1343 int     drm_switchctx(struct drm_device *dev, void *data,
1344                       struct drm_file *file_priv);
1345 int     drm_newctx(struct drm_device *dev, void *data,
1346                    struct drm_file *file_priv);
1347 int     drm_rmctx(struct drm_device *dev, void *data,
1348                   struct drm_file *file_priv);
1349 int     drm_setsareactx(struct drm_device *dev, void *data,
1350                         struct drm_file *file_priv);
1351 int     drm_getsareactx(struct drm_device *dev, void *data,
1352                         struct drm_file *file_priv);
1353
1354 /* Authentication IOCTL support (drm_auth.c) */
1355 int     drm_getmagic(struct drm_device *dev, void *data,
1356                      struct drm_file *file_priv);
1357 int     drm_authmagic(struct drm_device *dev, void *data,
1358                       struct drm_file *file_priv);
1359
1360 /* Buffer management support (drm_bufs.c) */
1361 int     drm_addmap_ioctl(struct drm_device *dev, void *data,
1362                          struct drm_file *file_priv);
1363 int     drm_rmmap_ioctl(struct drm_device *dev, void *data,
1364                         struct drm_file *file_priv);
1365 int     drm_addbufs(struct drm_device *dev, void *data,
1366                     struct drm_file *file_priv);
1367 int     drm_infobufs(struct drm_device *dev, void *data,
1368                      struct drm_file *file_priv);
1369 int     drm_markbufs(struct drm_device *dev, void *data,
1370                      struct drm_file *file_priv);
1371 int     drm_freebufs(struct drm_device *dev, void *data,
1372                      struct drm_file *file_priv);
1373 int     drm_mapbufs(struct drm_device *dev, void *data,
1374                     struct drm_file *file_priv);
1375
1376 /* DMA support (drm_dma.c) */
1377 int     drm_dma(struct drm_device *dev, void *data, struct drm_file *file_priv);
1378
1379 /* IRQ support (drm_irq.c) */
1380 int     drm_control(struct drm_device *dev, void *data,
1381                     struct drm_file *file_priv);
1382
1383 /* AGP/GART support (drm_agpsupport.c) */
1384 int     drm_agp_acquire_ioctl(struct drm_device *dev, void *data,
1385                               struct drm_file *file_priv);
1386 int     drm_agp_release_ioctl(struct drm_device *dev, void *data,
1387                               struct drm_file *file_priv);
1388 int     drm_agp_enable_ioctl(struct drm_device *dev, void *data,
1389                              struct drm_file *file_priv);
1390 int     drm_agp_info_ioctl(struct drm_device *dev, void *data,
1391                            struct drm_file *file_priv);
1392 int     drm_agp_alloc_ioctl(struct drm_device *dev, void *data,
1393                             struct drm_file *file_priv);
1394 int     drm_agp_free_ioctl(struct drm_device *dev, void *data,
1395                            struct drm_file *file_priv);
1396 int     drm_agp_unbind_ioctl(struct drm_device *dev, void *data,
1397                              struct drm_file *file_priv);
1398 int     drm_agp_bind_ioctl(struct drm_device *dev, void *data,
1399                            struct drm_file *file_priv);
1400
1401                                 /* Stub support (drm_stub.h) */
1402 extern int drm_setmaster_ioctl(struct drm_device *dev, void *data,
1403                                struct drm_file *file_priv);
1404 extern int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
1405                                 struct drm_file *file_priv);
1406
1407 /* Scatter Gather Support (drm_scatter.c) */
1408 int     drm_sg_alloc_ioctl(struct drm_device *dev, void *data,
1409                            struct drm_file *file_priv);
1410 int     drm_sg_free(struct drm_device *dev, void *data,
1411                     struct drm_file *file_priv);
1412
1413 /* consistent PCI memory functions (drm_pci.c) */
1414 extern drm_dma_handle_t *drm_pci_alloc(struct drm_device *dev, size_t size,
1415                                        size_t align);
1416 void    drm_pci_free(struct drm_device *dev, drm_dma_handle_t *dmah);
1417
1418                                /* sysfs support (drm_sysfs.c) */
1419 extern char *drm_get_connector_status_name(enum drm_connector_status status);
1420
1421 /* Graphics Execution Manager library functions (drm_gem.c) */
1422 int drm_gem_init(struct drm_device *dev);
1423 void drm_gem_destroy(struct drm_device *dev);
1424 void drm_gem_object_release(struct drm_gem_object *obj);
1425 void drm_gem_object_free(struct kref *kref);
1426
1427 int drm_gem_close_ioctl(struct drm_device *dev, void *data,
1428                         struct drm_file *file_priv);
1429 int drm_gem_flink_ioctl(struct drm_device *dev, void *data,
1430                         struct drm_file *file_priv);
1431 int drm_gem_open_ioctl(struct drm_device *dev, void *data,
1432                        struct drm_file *file_priv);
1433 void drm_gem_object_handle_free(struct drm_gem_object *obj);
1434
1435 #include <drm/drm_global.h>
1436
1437 static inline void
1438 drm_gem_object_reference(struct drm_gem_object *obj)
1439 {
1440         kref_get(&obj->refcount);
1441 }
1442
1443 static inline void
1444 drm_gem_object_unreference(struct drm_gem_object *obj)
1445 {
1446         if (obj != NULL)
1447                 kref_put(&obj->refcount, drm_gem_object_free);
1448 }
1449
1450 static inline void
1451 drm_gem_object_unreference_unlocked(struct drm_gem_object *obj)
1452 {
1453         if (obj != NULL) {
1454                 struct drm_device *dev = obj->dev;
1455                 DRM_LOCK(dev);
1456                 kref_put(&obj->refcount, drm_gem_object_free);
1457                 DRM_UNLOCK(dev);
1458         }
1459 }
1460
1461 int drm_gem_handle_create(struct drm_file *file_priv,
1462                           struct drm_gem_object *obj,
1463                           u32 *handlep);
1464 int drm_gem_handle_delete(struct drm_file *filp, u32 handle);
1465
1466 static inline void
1467 drm_gem_object_handle_reference(struct drm_gem_object *obj)
1468 {
1469         drm_gem_object_reference(obj);
1470         atomic_inc(&obj->handle_count);
1471 }
1472
1473 static inline void
1474 drm_gem_object_handle_unreference(struct drm_gem_object *obj)
1475 {
1476         if (obj == NULL)
1477                 return;
1478
1479         if (atomic_read(&obj->handle_count) == 0)
1480                 return;
1481         /*
1482          * Must bump handle count first as this may be the last
1483          * ref, in which case the object would disappear before we
1484          * checked for a name
1485          */
1486         if (atomic_dec_and_test(&obj->handle_count))
1487                 drm_gem_object_handle_free(obj);
1488         drm_gem_object_unreference(obj);
1489 }
1490
1491 static inline void
1492 drm_gem_object_handle_unreference_unlocked(struct drm_gem_object *obj)
1493 {
1494         if (obj == NULL)
1495                 return;
1496
1497         if (atomic_read(&obj->handle_count) == 0)
1498                 return;
1499
1500         /*
1501         * Must bump handle count first as this may be the last
1502         * ref, in which case the object would disappear before we
1503         * checked for a name
1504         */
1505
1506         if (atomic_dec_and_test(&obj->handle_count))
1507                 drm_gem_object_handle_free(obj);
1508         drm_gem_object_unreference_unlocked(obj);
1509 }
1510
1511 int drm_gem_object_init(struct drm_device *dev, struct drm_gem_object *obj,
1512     size_t size);
1513 int drm_gem_private_object_init(struct drm_device *dev,
1514     struct drm_gem_object *obj, size_t size);
1515 struct drm_gem_object *drm_gem_object_alloc(struct drm_device *dev,
1516     size_t size);
1517 struct drm_gem_object *drm_gem_object_lookup(struct drm_device *dev,
1518     struct drm_file *file_priv, uint32_t handle);
1519
1520 void drm_gem_open(struct drm_device *dev, struct drm_file *file_priv);
1521 void drm_gem_release(struct drm_device *dev, struct drm_file *file_priv);
1522
1523 int drm_gem_create_mmap_offset(struct drm_gem_object *obj);
1524 void drm_gem_free_mmap_offset(struct drm_gem_object *obj);
1525 int drm_gem_mmap_single(struct drm_device *dev, vm_ooffset_t *offset,
1526     vm_size_t size, struct vm_object **obj_res, int nprot);
1527 void drm_gem_pager_dtr(void *obj);
1528
1529 struct ttm_bo_device;
1530 int ttm_bo_mmap_single(struct ttm_bo_device *bdev, vm_ooffset_t *offset,
1531     vm_size_t size, struct vm_object **obj_res, int nprot);
1532 struct ttm_buffer_object;
1533 void ttm_bo_release_mmap(struct ttm_buffer_object *bo);
1534
1535 void drm_device_lock_mtx(struct drm_device *dev);
1536 void drm_device_unlock_mtx(struct drm_device *dev);
1537 int drm_device_sleep_mtx(struct drm_device *dev, void *chan, int flags,
1538     const char *msg, int timeout);
1539 void drm_device_assert_mtx_locked(struct drm_device *dev);
1540 void drm_device_assert_mtx_unlocked(struct drm_device *dev);
1541
1542 void drm_device_lock_struct(struct drm_device *dev);
1543 void drm_device_unlock_struct(struct drm_device *dev);
1544 int drm_device_sleep_struct(struct drm_device *dev, void *chan, int flags,
1545     const char *msg, int timeout);
1546 void drm_device_assert_struct_locked(struct drm_device *dev);
1547 void drm_device_assert_struct_unlocked(struct drm_device *dev);
1548
1549 void drm_compat_locking_init(struct drm_device *dev);
1550 void drm_sleep_locking_init(struct drm_device *dev);
1551
1552 /* drm_modes.c */
1553 bool drm_mode_parse_command_line_for_connector(const char *mode_option,
1554     struct drm_connector *connector, struct drm_cmdline_mode *mode);
1555 struct drm_display_mode *drm_mode_create_from_cmdline_mode(
1556     struct drm_device *dev, struct drm_cmdline_mode *cmd);
1557
1558 /* Inline replacements for drm_alloc and friends */
1559 static __inline__ void *
1560 drm_alloc(size_t size, struct malloc_type *area)
1561 {
1562         return kmalloc(size, area, M_WAITOK | M_NULLOK);
1563 }
1564
1565 static __inline__ void *
1566 drm_calloc(size_t nmemb, size_t size, struct malloc_type *area)
1567 {
1568         return kmalloc(size * nmemb, area, M_WAITOK | M_NULLOK | M_ZERO);
1569 }
1570
1571 static __inline__ void
1572 drm_free(void *pt, struct malloc_type *area)
1573 {
1574         kfree(pt);
1575 }
1576
1577 /* Inline replacements for DRM_IOREMAP macros */
1578 static __inline__ void
1579 drm_core_ioremap_wc(struct drm_local_map *map, struct drm_device *dev)
1580 {
1581         map->handle = drm_ioremap_wc(dev, map);
1582 }
1583 static __inline__ void
1584 drm_core_ioremap(struct drm_local_map *map, struct drm_device *dev)
1585 {
1586         map->handle = drm_ioremap(dev, map);
1587 }
1588 static __inline__ void
1589 drm_core_ioremapfree(struct drm_local_map *map, struct drm_device *dev)
1590 {
1591         if ( map->handle && map->size )
1592                 drm_ioremapfree(map);
1593 }
1594
1595 static __inline__ struct drm_local_map *
1596 drm_core_findmap(struct drm_device *dev, unsigned long offset)
1597 {
1598         struct drm_map_list *_entry;
1599
1600         list_for_each_entry(_entry, &dev->maplist, head) {
1601                 if (offset == (unsigned long)_entry->map->handle)
1602                         return _entry->map;
1603         }
1604         return NULL;
1605 }
1606
1607 static __inline__ void drm_core_dropmap(struct drm_map *map)
1608 {
1609 }
1610
1611 #include <drm/drm_mem_util.h>
1612
1613 /* FreeBSD compatibility macros */
1614 #define VM_OBJECT_WLOCK(object)         VM_OBJECT_LOCK(object)
1615 #define VM_OBJECT_WUNLOCK(object)       VM_OBJECT_UNLOCK(object)
1616
1617 #define DRM_PCIE_SPEED_25 1
1618 #define DRM_PCIE_SPEED_50 2
1619 #define DRM_PCIE_SPEED_80 4
1620
1621 extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
1622
1623 #define drm_can_sleep() (DRM_HZ & 1)
1624
1625 #endif /* __KERNEL__ */
1626 #endif /* _DRM_P_H_ */