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

   1 /*
   2  * Internal Header for the Direct Rendering Manager
   3  *
   4  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
   5  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
   6  * Copyright (c) 2009-2010, Code Aurora Forum.
   7  * All rights reserved.
   8  *
   9  * Author: Rickard E. (Rik) Faith <faith@valinux.com>
  10  * Author: Gareth Hughes <gareth@valinux.com>
  11  *
  12  * Permission is hereby granted, free of charge, to any person obtaining a
  13  * copy of this software and associated documentation files (the "Software"),
  14  * to deal in the Software without restriction, including without limitation
  15  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  16  * and/or sell copies of the Software, and to permit persons to whom the
  17  * Software is furnished to do so, subject to the following conditions:
  18  *
  19  * The above copyright notice and this permission notice (including the next
  20  * paragraph) shall be included in all copies or substantial portions of the
  21  * Software.
  22  *
  23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  24  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  25  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  26  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  27  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  28  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  29  * OTHER DEALINGS IN THE SOFTWARE.
  30  */
  31
  32 #ifndef _DRM_P_H_
  33 #define _DRM_P_H_
  34
  35 #if defined(_KERNEL) || defined(__KERNEL__)
  36
  37 #include <sys/param.h>
  38 #include <sys/queue.h>
  39 #include <sys/malloc.h>
  40 #include <sys/kernel.h>
  41 #include <sys/ktr.h>
  42 #include <sys/module.h>
  43 #include <sys/systm.h>
  44 #include <sys/device.h>
  45 #include <sys/sglist.h>
  46 #include <sys/stat.h>
  47 #include <sys/priv.h>
  48 #include <sys/proc.h>
  49 #include <sys/lock.h>
  50 #include <sys/spinlock.h>
  51 #include <sys/spinlock2.h>
  52 #include <sys/fcntl.h>
  53 #include <sys/uio.h>
  54 #include <sys/filio.h>
  55 #include <sys/sysctl.h>
  56 #include <sys/bus.h>
  57 #include <sys/queue.h>
  58 #include <sys/signalvar.h>
  59 #include <sys/poll.h>
  60 #include <linux/highmem.h>
  61 #include <sys/sbuf.h>
  62 #include <sys/taskqueue.h>
  63 #include <sys/tree.h>
  64 #include <vm/vm.h>
  65 #include <vm/pmap.h>
  66 #include <vm/vm_extern.h>
  67 #include <vm/vm_kern.h>
  68 #include <vm/vm_map.h>
  69 #include <vm/vm_object.h>
  70 #include <vm/vm_page2.h>
  71 #include <vm/vm_pager.h>
  72 #include <vm/vm_param.h>
  73 #include <machine/param.h>
  74 #include <machine/pmap.h>
  75 #ifdef __x86_64__
  76 #include <machine/specialreg.h>
  77 #endif
  78 #include <machine/sysarch.h>
  79 #include <sys/endian.h>
  80 #include <sys/mman.h>
  81 #include <sys/rman.h>
  82 #include <sys/memrange.h>
  83 #include <sys/agpio.h>
  84 #include <sys/mutex.h>
  85
  86 MALLOC_DECLARE(M_DRM);
  87
  88 #include <uapi_drm/drm.h>
  89 #include <uapi_drm/drm_sarea.h>
  90
  91 #include <linux/atomic.h>
  92 #include <linux/bug.h>
  93 #include <linux/dma-mapping.h>
  94 #include <linux/capability.h>
  95 #include <linux/err.h>
  96 #include <linux/idr.h>
  97 #include <linux/pci.h>
  98 #include <linux/jiffies.h>
  99 #include <linux/kernel.h>
 100 #include <linux/fs.h>
 101 #include <linux/kref.h>
 102 #include <linux/list.h>
 103 #include <linux/mm.h>
 104 #include <linux/moduleparam.h>
 105 #include <linux/mutex.h>
 106 #include <linux/slab.h>
 107 #include <linux/scatterlist.h>
 108 #include <linux/timer.h>
 109 #include <asm/io.h>
 110 #include <linux/seq_file.h>
 111 #include <linux/types.h>
 112 #include <linux/vmalloc.h>
 113 #include <linux/wait.h>
 114 #include <linux/workqueue.h>
 115
 116 #include <asm/uaccess.h>
 117
 118 #include <drm/drm_global.h>
 119
 120 #include <drm/drm_vma_manager.h>
 121
 122 struct drm_file;
 123 struct drm_device;
 124 struct drm_agp_head;
 125 struct drm_gem_object;
 126
 127 struct device_node;
 128 struct videomode;
 129
 130 #include <drm/drm_os_linux.h>
 131 #include <drm/drm_hashtab.h>
 132 #include <drm/drm_mm.h>
 133
 134 /*
 135  * 4 debug categories are defined:
 136  *
 137  * CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c, drm_memory.c, ...
 138  *       This is the category used by the DRM_DEBUG() macro.
 139  *
 140  * DRIVER: Used in the vendor specific part of the driver: i915, radeon, ...
 141  *         This is the category used by the DRM_DEBUG_DRIVER() macro.
 142  *
 143  * KMS: used in the modesetting code.
 144  *      This is the category used by the DRM_DEBUG_KMS() macro.
 145  *
 146  * PRIME: used in the prime code.
 147  *        This is the category used by the DRM_DEBUG_PRIME() macro.
 148  *
 149  * Enabling verbose debug messages is done through the drm.debug parameter,
 150  * each category being enabled by a bit.
 151  *
 152  * drm.debug=0x1 will enable CORE messages
 153  * drm.debug=0x2 will enable DRIVER messages
 154  * drm.debug=0x3 will enable CORE and DRIVER messages
 155  * ...
 156  * drm.debug=0xf will enable all messages
 157  *
 158  * An interesting feature is that it's possible to enable verbose logging at
 159  * run-time by echoing the debug value in its sysfs node:
 160  *   # echo 0xf > /sys/module/drm/parameters/debug
 161  */
 162 #define DRM_UT_CORE             0x01
 163 #define DRM_UT_DRIVER           0x02
 164 #define DRM_UT_KMS              0x04
 165 #define DRM_UT_PRIME            0x08
 166
 167 void drm_ut_debug_printk(const char *function_name,
 168                          const char *format, ...);
 169
 170 void drm_err(const char *format, ...);
 171
 172 /***********************************************************************/
 173 /** \name DRM template customization defaults */
 174 /*@{*/
 175
 176 /* driver capabilities and requirements mask */
 177 #define DRIVER_USE_AGP     0x1
 178 #define DRIVER_REQUIRE_AGP 0x2
 179 #define DRIVER_PCI_DMA     0x8
 180 #define DRIVER_SG          0x10
 181 #define DRIVER_HAVE_DMA    0x20
 182 #define DRIVER_HAVE_IRQ    0x40
 183 #define DRIVER_IRQ_SHARED  0x80
 184 #define DRIVER_DMA_QUEUE   0x200
 185 #define DRIVER_GEM         0x1000
 186 #define DRIVER_MODESET     0x2000
 187 #define DRIVER_PRIME       0x4000
 188 #define DRIVER_RENDER      0x8000
 189 #define DRIVER_ATOMIC      0x10000
 190
 191 /***********************************************************************/
 192 /** \name Begin the DRM... */
 193 /*@{*/
 194
 195 #define DRM_MAGIC_HASH_ORDER  4  /**< Size of key hash table. Must be power of 2. */
 196
 197 /*@}*/
 198
 199 /***********************************************************************/
 200 /** \name Macros to make printk easier */
 201 /*@{*/
 202
 203 /**
 204  * Error output.
 205  *
 206  * \param fmt printf() like format string.
 207  * \param arg arguments
 208  */
 209 #define DRM_ERROR(fmt, ...) \
 210         kprintf("error: [" DRM_NAME ":pid%d:%s] *ERROR* " fmt,          \
 211             DRM_CURRENTPID, __func__ , ##__VA_ARGS__)
 212
 213 #define DRM_GEM_MAPPING_MASK    (3ULL << 62)
 214 #define DRM_GEM_MAPPING_KEY     (2ULL << 62) /* Non-canonical address form */
 215 #define DRM_GEM_MAX_IDX         0x3fffff
 216 #define DRM_GEM_MAPPING_IDX(o)  (((o) >> 40) & DRM_GEM_MAX_IDX)
 217 #define DRM_GEM_MAPPING_OFF(i)  (((uint64_t)(i)) << 40)
 218 #define DRM_GEM_MAPPING_MAPOFF(o) \
 219     ((o) & ~(DRM_GEM_MAPPING_OFF(DRM_GEM_MAX_IDX) | DRM_GEM_MAPPING_KEY))
 220
 221 SYSCTL_DECL(_hw_drm);
 222
 223 #define DRM_MAX(a,b) ((a)>(b)?(a):(b))
 224
 225 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
 226
 227 #define __OS_HAS_AGP    1
 228
 229 #define DRM_DEV_MODE    (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP)
 230 #define DRM_DEV_UID     UID_ROOT
 231 #define DRM_DEV_GID     GID_WHEEL
 232
 233 #define DRM_CURPROC             curthread
 234 #define DRM_STRUCTPROC          struct thread
 235 #define DRM_CURRENTPID          (curproc != NULL ? curproc->p_pid : -1)
 236 #define DRM_LOCK(dev)           lockmgr(&(dev)->struct_mutex, LK_EXCLUSIVE)
 237 #define DRM_UNLOCK(dev)         lockmgr(&(dev)->struct_mutex, LK_RELEASE)
 238 #define DRM_LOCK_SLEEP(dev, chan, flags, msg, timeout)                  \
 239     (lksleep((chan), &(dev)->struct_mutex, (flags), (msg), (timeout)))
 240 #if defined(INVARIANTS)
 241 #define DRM_LOCK_ASSERT(dev)    KKASSERT(lockstatus(&(dev)->struct_mutex, curthread) != 0);
 242 #define DRM_UNLOCK_ASSERT(dev)  KKASSERT(lockstatus(&(dev)->struct_mutex, curthread) == 0);
 243 #else
 244 #define DRM_LOCK_ASSERT(d)
 245 #define DRM_UNLOCK_ASSERT(d)
 246 #endif
 247
 248 #define DRM_SYSCTL_HANDLER_ARGS (SYSCTL_HANDLER_ARGS)
 249
 250 typedef void                    irqreturn_t;
 251 #define IRQ_HANDLED             /* nothing */
 252 #define IRQ_NONE                /* nothing */
 253
 254 enum {
 255         DRM_IS_NOT_AGP,
 256         DRM_IS_AGP,
 257         DRM_MIGHT_BE_AGP
 258 };
 259 #define DRM_AGP_MEM             struct agp_memory_info
 260
 261 #define drm_get_device_from_kdev(_kdev) (_kdev->si_drv1)
 262
 263 #define DRM_AGP_FIND_DEVICE()   agp_find_device()
 264 #define DRM_MTRR_WC             MDF_WRITECOMBINE
 265
 266 #define LOCK_TEST_WITH_RETURN(dev, file_priv)                           \
 267 do {                                                                    \
 268         if (!_DRM_LOCK_IS_HELD(dev->lock.hw_lock->lock) ||              \
 269              dev->lock.file_priv != file_priv) {                        \
 270                 DRM_ERROR("%s called without lock held\n",              \
 271                            __FUNCTION__);                               \
 272                 return EINVAL;                                          \
 273         }                                                               \
 274 } while (0)
 275
 276 /* Returns -errno to shared code */
 277 #define DRM_WAIT_ON( ret, queue, timeout, condition )           \
 278 for ( ret = 0 ; !ret && !(condition) ; ) {                      \
 279         lwkt_serialize_enter(&dev->irq_lock);                   \
 280         if (!(condition)) {                                     \
 281             tsleep_interlock(&(queue), PCATCH);                 \
 282             lwkt_serialize_exit(&dev->irq_lock);                \
 283             ret = -tsleep(&(queue), PCATCH | PINTERLOCKED,      \
 284                           "drmwtq", (timeout));                 \
 285         } else {                                                \
 286                 lwkt_serialize_exit(&dev->irq_lock);            \
 287         }                                                       \
 288 }
 289
 290 int vm_phys_fictitious_reg_range(vm_paddr_t start, vm_paddr_t end,
 291     vm_memattr_t memattr);
 292 void vm_phys_fictitious_unreg_range(vm_paddr_t start, vm_paddr_t end);
 293 vm_page_t vm_phys_fictitious_to_vm_page(vm_paddr_t pa);
 294
 295 /***********************************************************************/
 296 /** \name Macros to make printk easier */
 297 /*@{*/
 298
 299
 300 #define DRM_INFO(fmt, ...)  kprintf("info: [" DRM_NAME "] " fmt , ##__VA_ARGS__)
 301
 302 #define DRM_INFO_ONCE(fmt, ...)                         \
 303         printk_once(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
 304
 305 #define DRM_DEBUGBITS_DEBUG             0x1
 306 #define DRM_DEBUGBITS_KMS               0x2
 307 #define DRM_DEBUGBITS_FAILED_IOCTL      0x4
 308 #define DRM_DEBUGBITS_VERBOSE           0x8
 309
 310 #define DRM_DEBUG(fmt, ...) do {                                        \
 311         if ((drm_debug & DRM_DEBUGBITS_DEBUG) != 0)             \
 312                 kprintf("[" DRM_NAME ":pid%d:%s] " fmt, DRM_CURRENTPID, \
 313                         __func__ , ##__VA_ARGS__);                      \
 314 } while (0)
 315
 316 #define DRM_DEBUG_VERBOSE(fmt, ...) do {                                \
 317         if ((drm_debug & DRM_DEBUGBITS_VERBOSE) != 0)           \
 318                 kprintf("[" DRM_NAME ":pid%d:%s] " fmt, DRM_CURRENTPID, \
 319                         __func__ , ##__VA_ARGS__);                      \
 320 } while (0)
 321
 322 #define DRM_DEBUG_KMS(fmt, ...) do {                                    \
 323         if ((drm_debug & DRM_DEBUGBITS_KMS) != 0)                       \
 324                 kprintf("[" DRM_NAME ":KMS:pid%d:%s] " fmt, DRM_CURRENTPID,\
 325                         __func__ , ##__VA_ARGS__);                      \
 326 } while (0)
 327
 328 #define DRM_DEBUG_DRIVER(fmt, ...) do {                                 \
 329         if ((drm_debug & DRM_DEBUGBITS_KMS) != 0)                       \
 330                 kprintf("[" DRM_NAME ":KMS:pid%d:%s] " fmt, DRM_CURRENTPID,\
 331                         __func__ , ##__VA_ARGS__);                      \
 332 } while (0)
 333
 334 #define DRM_LOG_KMS(fmt, ...) do {                                      \
 335         kprintf("[" DRM_NAME ":KMS:pid%d:%s] " fmt, DRM_CURRENTPID,     \
 336                         __func__ , ##__VA_ARGS__);                      \
 337 } while (0)
 338
 339 #define dev_dbg(dev, fmt, ...) do {                                     \
 340         if ((drm_debug& DRM_DEBUGBITS_KMS) != 0) {                      \
 341                 device_printf((dev), "debug: " fmt, ## __VA_ARGS__);    \
 342         }                                                               \
 343 } while (0)
 344
 345 typedef struct drm_pci_id_list
 346 {
 347         int vendor;
 348         int device;
 349         long driver_private;
 350         char *name;
 351 } drm_pci_id_list_t;
 352
 353 /**
 354  * Ioctl function type.
 355  *
 356  * \param inode device inode.
 357  * \param file_priv DRM file private pointer.
 358  * \param cmd command.
 359  * \param arg argument.
 360  */
 361 typedef int drm_ioctl_t(struct drm_device *dev, void *data,
 362                         struct drm_file *file_priv);
 363
 364 typedef int drm_ioctl_compat_t(struct file *filp, unsigned int cmd,
 365                                unsigned long arg);
 366
 367 #define DRM_IOCTL_NR(n)                ((n) & 0xff)
 368
 369 #define DRM_AUTH        0x1
 370 #define DRM_MASTER      0x2
 371 #define DRM_ROOT_ONLY   0x4
 372 #define DRM_CONTROL_ALLOW 0x8
 373 #define DRM_UNLOCKED    0x10
 374 #define DRM_RENDER_ALLOW 0x20
 375
 376 struct drm_ioctl_desc {
 377         unsigned int cmd;
 378         int flags;
 379         drm_ioctl_t *func;
 380         unsigned int cmd_drv;
 381         const char *name;
 382 };
 383
 384 /**
 385  * Creates a driver or general drm_ioctl_desc array entry for the given
 386  * ioctl, for use by drm_ioctl().
 387  */
 388 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags)                 \
 389         [DRM_IOCTL_NR(DRM_##ioctl)] = {.cmd = DRM_##ioctl, .func = _func, .flags = _flags, .cmd_drv = DRM_IOCTL_##ioctl}
 390
 391 typedef struct drm_magic_entry {
 392         struct list_head head;
 393         struct drm_hash_item hash_item;
 394         struct drm_file        *priv;
 395         struct drm_magic_entry *next;
 396 } drm_magic_entry_t;
 397
 398 typedef struct drm_magic_head {
 399         struct drm_magic_entry *head;
 400         struct drm_magic_entry *tail;
 401 } drm_magic_head_t;
 402
 403 typedef struct drm_buf {
 404         int idx;                       /**< Index into master buflist */
 405         int total;                     /**< Buffer size */
 406         int order;                     /**< log-base-2(total) */
 407         int used;                      /**< Amount of buffer in use (for DMA) */
 408         unsigned long offset;          /**< Byte offset (used internally) */
 409         void *address;                 /**< Address of buffer */
 410         unsigned long bus_address;     /**< Bus address of buffer */
 411         struct drm_buf *next;          /**< Kernel-only: used for free list */
 412         __volatile__ int waiting;      /**< On kernel DMA queue */
 413         __volatile__ int pending;      /**< On hardware DMA queue */
 414         struct drm_file *file_priv;    /**< Private of holding file descr */
 415         int context;                   /**< Kernel queue for this buffer */
 416         int while_locked;              /**< Dispatch this buffer while locked */
 417         enum {
 418                 DRM_LIST_NONE = 0,
 419                 DRM_LIST_FREE = 1,
 420                 DRM_LIST_WAIT = 2,
 421                 DRM_LIST_PEND = 3,
 422                 DRM_LIST_PRIO = 4,
 423                 DRM_LIST_RECLAIM = 5
 424         } list;                        /**< Which list we're on */
 425
 426         int dev_priv_size;               /**< Size of buffer private storage */
 427         void *dev_private;               /**< Per-buffer private storage */
 428 } drm_buf_t;
 429
 430 /** bufs is one longer than it has to be */
 431 struct drm_waitlist {
 432         int count;                      /**< Number of possible buffers */
 433         struct drm_buf **bufs;          /**< List of pointers to buffers */
 434         struct drm_buf **rp;                    /**< Read pointer */
 435         struct drm_buf **wp;                    /**< Write pointer */
 436         struct drm_buf **end;           /**< End pointer */
 437         struct spinlock *read_lock;
 438         struct spinlock *write_lock;
 439 };
 440
 441 typedef struct drm_dma_handle {
 442         void *vaddr;
 443         size_t size;
 444         bus_addr_t busaddr;
 445         bus_dma_tag_t tag;
 446         bus_dmamap_t map;
 447 } drm_dma_handle_t;
 448
 449 typedef struct drm_buf_entry {
 450         int               buf_size;
 451         int               buf_count;
 452         drm_buf_t         *buflist;
 453         int               seg_count;
 454         int               page_order;
 455         struct drm_dma_handle **seglist;
 456
 457         int low_mark;                   /**< Low water mark */
 458         int high_mark;                  /**< High water mark */
 459 } drm_buf_entry_t;
 460
 461 /* Event queued up for userspace to read */
 462 struct drm_pending_event {
 463         struct drm_event *event;
 464         struct list_head link;
 465         struct drm_file *file_priv;
 466         pid_t pid; /* pid of requester, no guarantee it's valid by the time
 467                       we deliver the event, for tracing only */
 468         void (*destroy)(struct drm_pending_event *event);
 469 };
 470
 471 /* initial implementaton using a linked list - todo hashtab */
 472 struct drm_prime_file_private {
 473         struct list_head head;
 474 #ifdef DUMBBELL_WIP
 475         struct mutex lock;
 476 #endif /* DUMBBELL_WIP */
 477 };
 478
 479 /** File private data */
 480 struct drm_file {
 481         int authenticated;
 482         struct drm_device *dev;
 483         int               master;
 484
 485         /* true when the client has asked us to expose stereo 3D mode flags */
 486         bool stereo_allowed;
 487         /*
 488          * true if client understands CRTC primary planes and cursor planes
 489          * in the plane list
 490          */
 491         unsigned universal_planes:1;
 492         /* true if client understands atomic properties */
 493         unsigned atomic:1;
 494
 495         pid_t             pid;
 496         uid_t             uid;
 497         drm_magic_t       magic;
 498         unsigned long     ioctl_count;
 499         struct list_head lhead;
 500         struct kqinfo     dkq;
 501
 502         /** Mapping of mm object handles to object pointers. */
 503         struct idr object_idr;
 504         /** Lock for synchronization of access to object_idr. */
 505         struct lock table_lock;
 506
 507         void             *driver_priv;
 508
 509         int               is_master;
 510         struct drm_master *masterp;
 511
 512         /**
 513          * fbs - List of framebuffers associated with this file.
 514          *
 515          * Protected by fbs_lock. Note that the fbs list holds a reference on
 516          * the fb object to prevent it from untimely disappearing.
 517          */
 518         struct list_head fbs;
 519         struct lock fbs_lock;
 520
 521         wait_queue_head_t event_wait;
 522         struct list_head  event_list;
 523         int               event_space;
 524
 525         struct drm_prime_file_private prime;
 526 };
 527
 528 /**
 529  * Lock data.
 530  */
 531 struct drm_lock_data {
 532         struct drm_hw_lock *hw_lock;    /**< Hardware lock */
 533         /** Private of lock holder's file (NULL=kernel) */
 534         struct drm_file *file_priv;
 535         wait_queue_head_t lock_queue;   /**< Queue of blocked processes */
 536         unsigned long lock_time;        /**< Time of last lock in jiffies */
 537 };
 538
 539 /* This structure, in the struct drm_device, is always initialized while the
 540  * device
 541  * is open.  dev->dma_lock protects the incrementing of dev->buf_use, which
 542  * when set marks that no further bufs may be allocated until device teardown
 543  * occurs (when the last open of the device has closed).  The high/low
 544  * watermarks of bufs are only touched by the X Server, and thus not
 545  * concurrently accessed, so no locking is needed.
 546  */
 547 typedef struct drm_device_dma {
 548
 549         struct drm_buf_entry bufs[DRM_MAX_ORDER + 1];   /**< buffers, grouped by their size order */
 550         int buf_count;                  /**< total number of buffers */
 551         struct drm_buf **buflist;               /**< Vector of pointers into drm_device_dma::bufs */
 552         int seg_count;
 553         int page_count;                 /**< number of pages */
 554         unsigned long *pagelist;        /**< page list */
 555         unsigned long byte_count;
 556         enum {
 557                 _DRM_DMA_USE_AGP = 0x01,
 558                 _DRM_DMA_USE_SG = 0x02,
 559                 _DRM_DMA_USE_FB = 0x04,
 560                 _DRM_DMA_USE_PCI_RO = 0x08
 561         } flags;
 562
 563 } drm_device_dma_t;
 564
 565 typedef struct drm_sg_mem {
 566         vm_offset_t vaddr;
 567         vm_paddr_t *busaddr;
 568         vm_pindex_t pages;
 569 } drm_sg_mem_t;
 570
 571 /**
 572  * Kernel side of a mapping
 573  */
 574 struct drm_local_map {
 575         resource_size_t offset;  /**< Requested physical address (0 for SAREA)*/
 576         unsigned long size;      /**< Requested physical size (bytes) */
 577         enum drm_map_type type;  /**< Type of memory to map */
 578         enum drm_map_flags flags;        /**< Flags */
 579         void *handle;            /**< User-space: "Handle" to pass to mmap() */
 580                                  /**< Kernel-space: kernel-virtual address */
 581         int mtrr;                /**< MTRR slot used */
 582 };
 583
 584 typedef struct drm_local_map drm_local_map_t;
 585
 586 /**
 587  * Mappings list
 588  */
 589 struct drm_map_list {
 590         struct list_head head;          /**< list head */
 591         struct drm_hash_item hash;
 592         struct drm_local_map *map;      /**< mapping */
 593         uint64_t user_token;
 594         struct drm_master *master;
 595         struct drm_mm_node *file_offset_node;   /**< fake offset */
 596 };
 597
 598 /**
 599  * GEM specific mm private for tracking GEM objects
 600  */
 601 struct drm_gem_mm {
 602         struct drm_vma_offset_manager vma_manager;
 603         struct drm_mm offset_manager;   /**< Offset mgmt for buffer objects */
 604         struct drm_open_hash offset_hash; /**< User token hash table for maps */
 605         struct unrhdr *idxunr;
 606 };
 607
 608
 609 #include "drm_crtc.h"
 610
 611 /**
 612  * struct drm_master - drm master structure
 613  *
 614  * @refcount: Refcount for this master object.
 615  * @minor: Link back to minor char device we are master for. Immutable.
 616  * @unique: Unique identifier: e.g. busid. Protected by drm_global_mutex.
 617  * @unique_len: Length of unique field. Protected by drm_global_mutex.
 618  * @unique_size: Amount allocated. Protected by drm_global_mutex.
 619  * @magiclist: Hash of used authentication tokens. Protected by struct_mutex.
 620  * @magicfree: List of used authentication tokens. Protected by struct_mutex.
 621  * @lock: DRI lock information.
 622  * @driver_priv: Pointer to driver-private information.
 623  */
 624 struct drm_master {
 625
 626         struct kref refcount; /* refcount for this master */
 627
 628         struct list_head head; /**< each minor contains a list of masters */
 629         struct drm_minor *minor; /**< link back to minor we are a master for */
 630
 631         char *unique;                   /**< Unique identifier: e.g., busid */
 632         int unique_len;                 /**< Length of unique field */
 633         int unique_size;                /**< amount allocated */
 634
 635         int blocked;                    /**< Blocked due to VC switch? */
 636
 637         struct drm_open_hash magiclist;
 638         struct list_head magicfree;
 639         struct drm_lock_data lock;
 640         void *driver_priv;
 641 };
 642
 643 /* Size of ringbuffer for vblank timestamps. Just double-buffer
 644  * in initial implementation.
 645  */
 646 #define DRM_VBLANKTIME_RBSIZE 2
 647
 648 /* Flags and return codes for get_vblank_timestamp() driver function. */
 649 #define DRM_CALLED_FROM_VBLIRQ 1
 650 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
 651 #define DRM_VBLANKTIME_IN_VBLANK         (1 << 1)
 652
 653 /* get_scanout_position() return flags */
 654 #define DRM_SCANOUTPOS_VALID        (1 << 0)
 655 #define DRM_SCANOUTPOS_IN_VBLANK    (1 << 1)
 656 #define DRM_SCANOUTPOS_ACCURATE     (1 << 2)
 657
 658 #ifndef DMA_BIT_MASK
 659 #define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : (1ULL<<(n)) - 1)
 660 #endif
 661
 662 #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
 663
 664 /**
 665  * DRM driver structure. This structure represent the common code for
 666  * a family of cards. There will one drm_device for each card present
 667  * in this family
 668  */
 669 struct drm_driver {
 670         int     (*load)(struct drm_device *, unsigned long flags);
 671         int     (*use_msi)(struct drm_device *, unsigned long flags);
 672         int     (*firstopen)(struct drm_device *);
 673         int     (*open)(struct drm_device *, struct drm_file *);
 674         void    (*preclose)(struct drm_device *, struct drm_file *file_priv);
 675         void    (*postclose)(struct drm_device *, struct drm_file *);
 676         void    (*lastclose)(struct drm_device *);
 677         int     (*unload)(struct drm_device *);
 678         void    (*reclaim_buffers_locked)(struct drm_device *,
 679                                           struct drm_file *file_priv);
 680         int     (*dma_ioctl)(struct drm_device *dev, void *data,
 681                              struct drm_file *file_priv);
 682         void    (*dma_ready)(struct drm_device *);
 683         int     (*dma_quiescent)(struct drm_device *);
 684         int     (*dma_flush_block_and_flush)(struct drm_device *, int context,
 685                                              enum drm_lock_flags flags);
 686         int     (*dma_flush_unblock)(struct drm_device *, int context,
 687                                      enum drm_lock_flags flags);
 688         int     (*context_ctor)(struct drm_device *dev, int context);
 689         int     (*context_dtor)(struct drm_device *dev, int context);
 690         int     (*kernel_context_switch)(struct drm_device *dev, int old,
 691                                          int new);
 692         int     (*kernel_context_switch_unlock)(struct drm_device *dev);
 693         void    (*irq_preinstall)(struct drm_device *dev);
 694         int     (*irq_postinstall)(struct drm_device *dev);
 695         void    (*irq_uninstall)(struct drm_device *dev);
 696         void    (*irq_handler)(void *arg);
 697
 698         u32     (*get_vblank_counter)(struct drm_device *dev, int crtc);
 699         int     (*enable_vblank)(struct drm_device *dev, int crtc);
 700         void    (*disable_vblank)(struct drm_device *dev, int crtc);
 701
 702         /**
 703          * Called by vblank timestamping code.
 704          *
 705          * Return the current display scanout position from a crtc, and an
 706          * optional accurate ktime_get timestamp of when position was measured.
 707          *
 708          * \param dev  DRM device.
 709          * \param crtc Id of the crtc to query.
 710          * \param flags Flags from the caller (DRM_CALLED_FROM_VBLIRQ or 0).
 711          * \param *vpos Target location for current vertical scanout position.
 712          * \param *hpos Target location for current horizontal scanout position.
 713          * \param *stime Target location for timestamp taken immediately before
 714          *               scanout position query. Can be NULL to skip timestamp.
 715          * \param *etime Target location for timestamp taken immediately after
 716          *               scanout position query. Can be NULL to skip timestamp.
 717          *
 718          * Returns vpos as a positive number while in active scanout area.
 719          * Returns vpos as a negative number inside vblank, counting the number
 720          * of scanlines to go until end of vblank, e.g., -1 means "one scanline
 721          * until start of active scanout / end of vblank."
 722          *
 723          * \return Flags, or'ed together as follows:
 724          *
 725          * DRM_SCANOUTPOS_VALID = Query successful.
 726          * DRM_SCANOUTPOS_INVBL = Inside vblank.
 727          * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
 728          * this flag means that returned position may be offset by a constant
 729          * but unknown small number of scanlines wrt. real scanout position.
 730          *
 731          */
 732         int (*get_scanout_position) (struct drm_device *dev, int crtc,
 733                                      unsigned int flags,
 734                                      int *vpos, int *hpos, ktime_t *stime,
 735                                      ktime_t *etime);
 736
 737         int     (*get_vblank_timestamp)(struct drm_device *dev, int crtc,
 738                     int *max_error, struct timeval *vblank_time,
 739                     unsigned flags);
 740
 741         void    (*gem_free_object)(struct drm_gem_object *obj);
 742         int     (*gem_open_object)(struct drm_gem_object *, struct drm_file *);
 743         void    (*gem_close_object)(struct drm_gem_object *, struct drm_file *);
 744
 745         struct cdev_pager_ops *gem_pager_ops;
 746
 747         int     (*dumb_create)(struct drm_file *file_priv,
 748                     struct drm_device *dev, struct drm_mode_create_dumb *args);
 749         int     (*dumb_map_offset)(struct drm_file *file_priv,
 750                     struct drm_device *dev, uint32_t handle, uint64_t *offset);
 751         int     (*dumb_destroy)(struct drm_file *file_priv,
 752                     struct drm_device *dev, uint32_t handle);
 753
 754         int     (*sysctl_init)(struct drm_device *dev,
 755                     struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
 756         void    (*sysctl_cleanup)(struct drm_device *dev);
 757
 758         drm_pci_id_list_t *id_entry;    /* PCI ID, name, and chipset private */
 759
 760         /**
 761          * Called by \c drm_device_is_agp.  Typically used to determine if a
 762          * card is really attached to AGP or not.
 763          *
 764          * \param dev  DRM device handle
 765          *
 766          * \returns
 767          * One of three values is returned depending on whether or not the
 768          * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
 769          * (return of 1), or may or may not be AGP (return of 2).
 770          */
 771         int     (*device_is_agp) (struct drm_device * dev);
 772
 773         int     major;
 774         int     minor;
 775         int     patchlevel;
 776         const char *name;               /* Simple driver name              */
 777         const char *desc;               /* Longer driver name              */
 778         const char *date;               /* Date of last major changes.     */
 779
 780         u32 driver_features;
 781         int dev_priv_size;
 782         const struct drm_ioctl_desc *ioctls;
 783         int num_ioctls;
 784 };
 785
 786 /**
 787  * Info file list entry. This structure represents a debugfs or proc file to
 788  * be created by the drm core
 789  */
 790 struct drm_info_list {
 791         const char *name; /** file name */
 792         int (*show)(struct seq_file*, void*); /** show callback */
 793         u32 driver_features; /**< Required driver features for this entry */
 794         void *data;
 795 };
 796
 797 /**
 798  * debugfs node structure. This structure represents a debugfs file.
 799  */
 800 struct drm_info_node {
 801         struct list_head list;
 802         struct drm_minor *minor;
 803         const struct drm_info_list *info_ent;
 804         struct dentry *dent;
 805 };
 806
 807 /**
 808  * DRM minor structure. This structure represents a drm minor number.
 809  */
 810 struct drm_minor {
 811         int index;                      /**< Minor device number */
 812         int type;                       /**< Control or render */
 813         device_t kdev;                  /**< OS device */
 814         struct drm_device *dev;
 815
 816         struct drm_master *master; /* currently active master for this node */
 817         struct list_head master_list;
 818         struct drm_mode_group mode_group;
 819 };
 820
 821 struct drm_pending_vblank_event {
 822         struct drm_pending_event base;
 823         int pipe;
 824         struct drm_event_vblank event;
 825 };
 826
 827 struct drm_sysctl_info {
 828         struct sysctl_ctx_list ctx;
 829         char   name[2];
 830 };
 831
 832 /* Length for the array of resource pointers for drm_get_resource_*. */
 833 #define DRM_MAX_PCI_RESOURCE    6
 834
 835 struct drm_vblank_crtc {
 836         struct drm_device *dev;         /* pointer to the drm_device */
 837         wait_queue_head_t queue;        /**< VBLANK wait queue */
 838         struct timeval time[DRM_VBLANKTIME_RBSIZE];     /**< timestamp of current count */
 839         struct timer_list disable_timer;                /* delayed disable timer */
 840         atomic_t count;                 /**< number of VBLANK interrupts */
 841         atomic_t refcount;              /* number of users of vblank interruptsper crtc */
 842         u32 last;                       /* protected by dev->vbl_lock, used */
 843                                         /* for wraparound handling */
 844         u32 last_wait;                  /* Last vblank seqno waited per CRTC */
 845         unsigned int inmodeset;         /* Display driver is setting mode */
 846         int crtc;                       /* crtc index */
 847         bool enabled;                   /* so we don't call enable more than
 848                                            once per disable */
 849 };
 850
 851 /**
 852  * DRM device structure. This structure represent a complete card that
 853  * may contain multiple heads.
 854  */
 855 struct drm_device {
 856         drm_pci_id_list_t *id_entry;    /* PCI ID, name, and chipset private */
 857
 858         uint16_t pci_subdevice;         /* PCI subsystem device id */
 859         uint16_t pci_subvendor;         /* PCI subsystem vendor id */
 860
 861         char              *unique;      /* Unique identifier: e.g., busid  */
 862         int               unique_len;   /* Length of unique field          */
 863         struct cdev       *devnode;     /* Device number for mknod         */
 864         int               if_version;   /* Highest interface version set */
 865
 866         int               flags;        /* Flags to open(2)                */
 867
 868                                 /* Locks */
 869         struct spinlock   dma_lock;     /* protects dev->dma */
 870         struct lwkt_serialize irq_lock; /* protects irq condition checks */
 871         struct lock       dev_lock;     /* protects everything else */
 872
 873         /** \name Locks */
 874         /*@{ */
 875         struct lock struct_mutex;       /**< For others */
 876         struct lock master_mutex;       /**< For drm_minor::master */
 877         /*@} */
 878
 879         /** \name Usage Counters */
 880         /*@{ */
 881         int open_count;                 /**< Outstanding files open, protected by drm_global_mutex. */
 882         struct spinlock buf_lock;       /**< For drm_device::buf_use and a few other things. */
 883         int buf_use;                    /**< Buffers in use -- cannot alloc */
 884         atomic_t buf_alloc;             /**< Buffer allocation in progress */
 885         /*@} */
 886
 887
 888         /** \name Performance counters */
 889         /*@{ */
 890         unsigned long     counters;
 891         enum drm_stat_type      types[15];
 892         atomic_t          counts[15];
 893         /*@} */
 894
 895                                 /* Authentication */
 896         struct drm_open_hash magiclist; /**< magic hash table */
 897         struct list_head magicfree;
 898
 899         struct list_head filelist;
 900
 901         /** \name Memory management */
 902         /*@{ */
 903         struct list_head maplist;       /**< Linked list of regions */
 904         int map_count;                  /**< Number of mappable regions */
 905         struct drm_open_hash map_hash;  /**< User token hash table for maps */
 906
 907         /** \name Context handle management */
 908         /*@{ */
 909         struct list_head ctxlist;       /**< Linked list of context handles */
 910         int ctx_count;                  /**< Number of context handles */
 911         struct lock ctxlist_mutex;      /**< For ctxlist */
 912
 913         struct idr ctx_idr;
 914
 915         /*@} */
 916
 917         struct drm_lock_data lock;      /* Information on hardware lock    */
 918
 919                                 /* DMA queues (contexts) */
 920         drm_device_dma_t  *dma;         /* Optional pointer for DMA support */
 921
 922         int               irq;          /* Interrupt used by board         */
 923         int               irq_type;     /* IRQ type (MSI enabled or not) */
 924         int               irqrid;       /* Interrupt used by board */
 925         struct resource   *irqr;        /* Resource for interrupt used by board    */
 926         void              *irqh;        /* Handle from bus_setup_intr      */
 927
 928         /* Storage of resource pointers for drm_get_resource_* */
 929         struct resource   *pcir[DRM_MAX_PCI_RESOURCE];
 930         int               pcirid[DRM_MAX_PCI_RESOURCE];
 931
 932         int               pci_domain;
 933         int               pci_bus;
 934         int               pci_slot;
 935         int               pci_func;
 936
 937         /** \name Context support */
 938         /*@{ */
 939         int irq_enabled;                /**< True if irq handler is enabled */
 940         __volatile__ long context_flag; /**< Context swapping flag */
 941         __volatile__ long interrupt_flag; /**< Interruption handler flag */
 942         __volatile__ long dma_flag;     /**< DMA dispatch flag */
 943         wait_queue_head_t context_wait; /**< Processes waiting on ctx switch */
 944         int last_checked;               /**< Last context checked for DMA */
 945         int last_context;               /**< Last current context */
 946         unsigned long last_switch;      /**< jiffies at last context switch */
 947         /*@} */
 948
 949         /** \name VBLANK IRQ support */
 950         /*@{ */
 951
 952         /*
 953          * At load time, disabling the vblank interrupt won't be allowed since
 954          * old clients may not call the modeset ioctl and therefore misbehave.
 955          * Once the modeset ioctl *has* been called though, we can safely
 956          * disable them when unused.
 957          */
 958         bool vblank_disable_allowed;
 959
 960         /*
 961          * If true, vblank interrupt will be disabled immediately when the
 962          * refcount drops to zero, as opposed to via the vblank disable
 963          * timer.
 964          * This can be set to true it the hardware has a working vblank
 965          * counter and the driver uses drm_vblank_on() and drm_vblank_off()
 966          * appropriately.
 967          */
 968         bool vblank_disable_immediate;
 969
 970         /* array of size num_crtcs */
 971         struct drm_vblank_crtc *vblank;
 972
 973         struct lock vblank_time_lock;    /**< Protects vblank count and time updates during vblank enable/disable */
 974         struct lock vbl_lock;
 975         struct timer_list vblank_disable_timer;
 976
 977         u32 max_vblank_count;           /**< size of vblank counter register */
 978
 979         /**
 980          * List of events
 981          */
 982         struct list_head vblank_event_list;
 983         struct lock event_lock;
 984
 985         /*@} */
 986
 987         struct sigio      *buf_sigio;   /* Processes waiting for SIGIO     */
 988
 989                                 /* Sysctl support */
 990         struct drm_sysctl_info *sysctl;
 991
 992
 993         drm_sg_mem_t      *sg;  /* Scatter gather memory */
 994         unsigned int num_crtcs;                  /**< Number of CRTCs on this device */
 995
 996         unsigned long     *ctx_bitmap;
 997         void              *dev_private;
 998
 999         void              *drm_ttm_bdev;
1000
1001         /*@} */
1002
1003         struct drm_agp_head *agp;       /**< AGP data */
1004
1005         struct device *dev;             /**< Device structure */
1006         struct pci_dev *pdev;           /**< PCI device structure */
1007         int pci_vendor;                 /**< PCI vendor id */
1008         int pci_device;                 /**< PCI device id */
1009
1010         struct drm_driver *driver;
1011         struct drm_local_map *agp_buffer_map;
1012         unsigned int agp_buffer_token;
1013         struct drm_minor *control;              /**< Control node for card */
1014         struct drm_minor *primary;              /**< render type primary screen head */
1015
1016         struct drm_mode_config mode_config;     /**< Current mode config */
1017
1018         /** \name GEM information */
1019         /*@{ */
1020         struct lock object_name_lock;
1021         struct idr object_name_idr;
1022         /*@} */
1023         void             *mm_private;
1024
1025         void *sysctl_private;
1026         char busid_str[128];
1027         int modesetting;
1028
1029         int switch_power_state;
1030
1031         atomic_t unplugged; /* device has been unplugged or gone away */
1032 };
1033
1034 #define DRM_SWITCH_POWER_ON 0
1035 #define DRM_SWITCH_POWER_OFF 1
1036 #define DRM_SWITCH_POWER_CHANGING 2
1037 #define DRM_SWITCH_POWER_DYNAMIC_OFF 3
1038
1039 static __inline__ int drm_core_check_feature(struct drm_device *dev,
1040                                              int feature)
1041 {
1042         return ((dev->driver->driver_features & feature) ? 1 : 0);
1043 }
1044
1045 static inline void drm_device_set_unplugged(struct drm_device *dev)
1046 {
1047         smp_wmb();
1048         atomic_set(&dev->unplugged, 1);
1049 }
1050
1051 static inline int drm_device_is_unplugged(struct drm_device *dev)
1052 {
1053         int ret = atomic_read(&dev->unplugged);
1054         smp_rmb();
1055         return ret;
1056 }
1057
1058 static inline bool drm_is_primary_client(const struct drm_file *file_priv)
1059 {
1060         return 0 /* file_priv->minor->type == DRM_MINOR_LEGACY */;
1061 }
1062
1063 /**
1064  * drm_is_master() - Check whether a DRM open-file is DRM-Master
1065  * @file: DRM open-file context
1066  *
1067  * This checks whether a DRM open-file context is owner of the master context
1068  * attached to it. If a file owns a master context, it's called DRM-Master.
1069  * Per DRM device, only one such file can be DRM-Master at a time.
1070  *
1071  * Returns: True if the file is DRM-Master, otherwise false.
1072  */
1073 static inline bool drm_is_master(const struct drm_file *file)
1074 {
1075 #if 0
1076         return file->master && file->master == file->minor->master;
1077 #else
1078         return true;
1079 #endif
1080 }
1081
1082 /******************************************************************/
1083 /** \name Internal function definitions */
1084 /*@{*/
1085
1086 #if __OS_HAS_AGP
1087 static inline int drm_core_has_AGP(struct drm_device *dev)
1088 {
1089         return drm_core_check_feature(dev, DRIVER_USE_AGP);
1090 }
1091 #else
1092 #define drm_core_has_AGP(dev) (0)
1093 #endif
1094
1095 extern int      drm_notyet_flag;
1096 extern unsigned int drm_rnodes;
1097 extern unsigned int drm_universal_planes;
1098
1099 extern int drm_vblank_offdelay;
1100 extern unsigned int drm_timestamp_precision;
1101
1102                                 /* Driver support (drm_drv.h) */
1103 int     drm_probe(device_t kdev, drm_pci_id_list_t *idlist);
1104 int     drm_attach(device_t kdev, drm_pci_id_list_t *idlist);
1105 int     drm_create_cdevs(device_t kdev);
1106 d_ioctl_t drm_ioctl;
1107 extern bool drm_ioctl_flags(unsigned int nr, unsigned int *flags);
1108
1109                                 /* Device support (drm_fops.h) */
1110 d_open_t drm_open;
1111 d_close_t drm_close;
1112 d_read_t drm_read;
1113 d_kqfilter_t drm_kqfilter;
1114 int drm_release(device_t kdev);
1115
1116 d_mmap_t drm_mmap;
1117 d_mmap_single_t drm_mmap_single;
1118
1119 void drm_cdevpriv_dtor(void *cd);
1120
1121 int drm_add_busid_modesetting(struct drm_device *dev,
1122     struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
1123
1124 /* File operations helpers (drm_fops.c) */
1125 extern int              drm_open_helper(struct cdev *kdev, int flags, int fmt,
1126                                          DRM_STRUCTPROC *p,
1127                                         struct drm_device *dev,
1128                                         struct file *fp);
1129 extern struct drm_file  *drm_find_file_by_proc(struct drm_device *dev,
1130                                         DRM_STRUCTPROC *p);
1131
1132 #ifdef DUMBBELL_WIP
1133 extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
1134                 struct drm_file *file_priv, uint32_t handle, uint32_t flags,
1135                 int *prime_fd);
1136 extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
1137                 struct drm_file *file_priv, int prime_fd, uint32_t *handle);
1138
1139 extern int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data,
1140                                         struct drm_file *file_priv);
1141 extern int drm_prime_fd_to_handle_ioctl(struct drm_device *dev, void *data,
1142                                         struct drm_file *file_priv);
1143
1144 extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, vm_page_t *pages,
1145                                             dma_addr_t *addrs, int max_pages);
1146 #endif /* DUMBBELL_WIP */
1147 extern struct sg_table *drm_prime_pages_to_sg(vm_page_t *pages, int nr_pages);
1148 extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
1149
1150 #ifdef DUMBBELL_WIP
1151 void drm_prime_init_file_private(struct drm_prime_file_private *prime_fpriv);
1152 void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv);
1153 int drm_prime_add_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf, uint32_t handle);
1154 int drm_prime_lookup_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf, uint32_t *handle);
1155 void drm_prime_remove_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf);
1156
1157 int drm_prime_add_dma_buf(struct drm_device *dev, struct drm_gem_object *obj);
1158 int drm_prime_lookup_obj(struct drm_device *dev, struct dma_buf *buf,
1159                          struct drm_gem_object **obj);
1160 #endif /* DUMBBELL_WIP */
1161
1162 void    drm_mem_init(void);
1163 void    drm_mem_uninit(void);
1164 void    *drm_ioremap_wc(struct drm_device *dev, drm_local_map_t *map);
1165 void    *drm_ioremap(struct drm_device *dev, drm_local_map_t *map);
1166 void    drm_ioremapfree(drm_local_map_t *map);
1167 int     drm_mtrr_add(unsigned long offset, size_t size, int flags);
1168 int     drm_mtrr_del(int handle, unsigned long offset, size_t size, int flags);
1169
1170 /* Locking IOCTL support (drm_lock.c) */
1171 int     drm_lock_take(struct drm_lock_data *lock_data,
1172                       unsigned int context);
1173 int     drm_lock_transfer(struct drm_lock_data *lock_data,
1174                           unsigned int context);
1175 int     drm_lock_free(struct drm_lock_data *lock_data,
1176                       unsigned int context);
1177
1178 /*
1179  * These are exported to drivers so that they can implement fencing using
1180  * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
1181  */
1182
1183 unsigned long drm_get_resource_start(struct drm_device *dev,
1184                                      unsigned int resource);
1185 unsigned long drm_get_resource_len(struct drm_device *dev,
1186                                    unsigned int resource);
1187
1188                                 /* IRQ support (drm_irq.h) */
1189 extern int drm_irq_install(struct drm_device *dev, int irq);
1190 int     drm_irq_uninstall(struct drm_device *dev);
1191 void    drm_driver_irq_preinstall(struct drm_device *dev);
1192 void    drm_driver_irq_postinstall(struct drm_device *dev);
1193 void    drm_driver_irq_uninstall(struct drm_device *dev);
1194
1195 extern int drm_vblank_init(struct drm_device *dev, int num_crtcs);
1196 extern int drm_wait_vblank(struct drm_device *dev, void *data,
1197                            struct drm_file *filp);
1198 extern u32 drm_vblank_count(struct drm_device *dev, int crtc);
1199 extern u32 drm_crtc_vblank_count(struct drm_crtc *crtc);
1200 extern u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
1201                                      struct timeval *vblanktime);
1202 extern void drm_send_vblank_event(struct drm_device *dev, int crtc,
1203                                      struct drm_pending_vblank_event *e);
1204 extern void drm_crtc_send_vblank_event(struct drm_crtc *crtc,
1205                                        struct drm_pending_vblank_event *e);
1206 extern bool drm_handle_vblank(struct drm_device *dev, int crtc);
1207 extern bool drm_crtc_handle_vblank(struct drm_crtc *crtc);
1208 extern int drm_vblank_get(struct drm_device *dev, int crtc);
1209 extern void drm_vblank_put(struct drm_device *dev, int crtc);
1210 extern int drm_crtc_vblank_get(struct drm_crtc *crtc);
1211 extern void drm_crtc_vblank_put(struct drm_crtc *crtc);
1212 extern void drm_wait_one_vblank(struct drm_device *dev, int crtc);
1213 extern void drm_crtc_wait_one_vblank(struct drm_crtc *crtc);
1214 extern void drm_vblank_off(struct drm_device *dev, int crtc);
1215 extern void drm_vblank_on(struct drm_device *dev, int crtc);
1216 extern void drm_crtc_vblank_off(struct drm_crtc *crtc);
1217 extern void drm_crtc_vblank_on(struct drm_crtc *crtc);
1218 extern void drm_vblank_cleanup(struct drm_device *dev);
1219
1220 extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
1221                                                  int crtc, int *max_error,
1222                                                  struct timeval *vblank_time,
1223                                                  unsigned flags,
1224                                                  const struct drm_crtc *refcrtc,
1225                                                  const struct drm_display_mode *mode);
1226 extern void drm_calc_timestamping_constants(struct drm_crtc *crtc,
1227                                             const struct drm_display_mode *mode);
1228
1229 /**
1230  * drm_crtc_vblank_waitqueue - get vblank waitqueue for the CRTC
1231  * @crtc: which CRTC's vblank waitqueue to retrieve
1232  *
1233  * This function returns a pointer to the vblank waitqueue for the CRTC.
1234  * Drivers can use this to implement vblank waits using wait_event() & co.
1235  */
1236 static inline wait_queue_head_t *drm_crtc_vblank_waitqueue(struct drm_crtc *crtc)
1237 {
1238        return &crtc->dev->vblank[drm_crtc_index(crtc)].queue;
1239 }
1240
1241 /* Modesetting support */
1242 extern void drm_vblank_pre_modeset(struct drm_device *dev, int crtc);
1243 extern void drm_vblank_post_modeset(struct drm_device *dev, int crtc);
1244
1245                                 /* AGP/GART support (drm_agpsupport.h) */
1246
1247 #include <drm/drm_agpsupport.h>
1248
1249 /* sysctl support (drm_sysctl.h) */
1250 extern int              drm_sysctl_init(struct drm_device *dev);
1251 extern int              drm_sysctl_cleanup(struct drm_device *dev);
1252
1253 /* Cache management (drm_memory.c) */
1254 void    drm_clflush_pages(vm_page_t *pages, unsigned long num_pages);
1255
1256 /* Locking IOCTL support (drm_drv.c) */
1257 int     drm_lock(struct drm_device *dev, void *data,
1258                  struct drm_file *file_priv);
1259 int     drm_unlock(struct drm_device *dev, void *data,
1260                    struct drm_file *file_priv);
1261 int     drm_setversion(struct drm_device *dev, void *data,
1262                        struct drm_file *file_priv);
1263
1264 /*
1265  * These are exported to drivers so that they can implement fencing using
1266  * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
1267  */
1268
1269 extern int drm_i_have_hw_lock(struct drm_device *dev, struct drm_file *file_priv);
1270
1271 /* Misc. IOCTL support (drm_ioctl.c) */
1272 int     drm_noop(struct drm_device *dev, void *data,
1273                  struct drm_file *file_priv);
1274
1275 /* Cache management (drm_cache.c) */
1276 void drm_clflush_virt_range(void *addr, unsigned long length);
1277
1278 /* DMA support (drm_dma.c) */
1279 int     drm_dma(struct drm_device *dev, void *data, struct drm_file *file_priv);
1280
1281                                 /* Stub support (drm_stub.h) */
1282
1283 extern void drm_put_dev(struct drm_device *dev);
1284 extern void drm_unplug_dev(struct drm_device *dev);
1285 extern unsigned int drm_debug;
1286 extern bool drm_atomic;
1287
1288 /* Scatter Gather Support (drm_scatter.c) */
1289 int     drm_sg_alloc_ioctl(struct drm_device *dev, void *data,
1290                            struct drm_file *file_priv);
1291 int     drm_sg_free(struct drm_device *dev, void *data,
1292                     struct drm_file *file_priv);
1293
1294 /* consistent PCI memory functions (drm_pci.c) */
1295 extern drm_dma_handle_t *drm_pci_alloc(struct drm_device *dev, size_t size,
1296                                        size_t align);
1297 void    drm_pci_free(struct drm_device *dev, drm_dma_handle_t *dmah);
1298
1299                                /* sysfs support (drm_sysfs.c) */
1300 extern void drm_sysfs_hotplug_event(struct drm_device *dev);
1301
1302 int drm_gem_mmap_single(struct drm_device *dev, vm_ooffset_t *offset,
1303     vm_size_t size, struct vm_object **obj_res, int nprot);
1304 void drm_gem_pager_dtr(void *obj);
1305
1306 struct ttm_bo_device;
1307 int ttm_bo_mmap_single(struct ttm_bo_device *bdev, vm_ooffset_t *offset,
1308     vm_size_t size, struct vm_object **obj_res, int nprot);
1309 struct ttm_buffer_object;
1310 void ttm_bo_release_mmap(struct ttm_buffer_object *bo);
1311
1312 void drm_device_lock_mtx(struct drm_device *dev);
1313 void drm_device_unlock_mtx(struct drm_device *dev);
1314 int drm_device_sleep_mtx(struct drm_device *dev, void *chan, int flags,
1315     const char *msg, int timeout);
1316 void drm_device_assert_mtx_locked(struct drm_device *dev);
1317 void drm_device_assert_mtx_unlocked(struct drm_device *dev);
1318
1319 void drm_device_lock_struct(struct drm_device *dev);
1320 void drm_device_unlock_struct(struct drm_device *dev);
1321 int drm_device_sleep_struct(struct drm_device *dev, void *chan, int flags,
1322     const char *msg, int timeout);
1323 void drm_device_assert_struct_locked(struct drm_device *dev);
1324 void drm_device_assert_struct_unlocked(struct drm_device *dev);
1325
1326 void drm_compat_locking_init(struct drm_device *dev);
1327 void drm_sleep_locking_init(struct drm_device *dev);
1328
1329 /* XXX glue logic, should be done in drm_pci_init(), pending drm update */
1330 void drm_init_pdev(struct device *dev, struct pci_dev **pdev);
1331 void drm_fini_pdev(struct pci_dev **pdev);
1332
1333 /* Inline replacements for drm_alloc and friends */
1334 static __inline__ void *
1335 drm_alloc(size_t size, struct malloc_type *area)
1336 {
1337         return kmalloc(size, area, M_WAITOK | M_NULLOK);
1338 }
1339
1340 static __inline__ void *
1341 drm_calloc(size_t nmemb, size_t size, struct malloc_type *area)
1342 {
1343         return kmalloc(size * nmemb, area, M_WAITOK | M_NULLOK | M_ZERO);
1344 }
1345
1346 static __inline__ void
1347 drm_free(void *pt, struct malloc_type *area)
1348 {
1349         /* kfree is special!!! */
1350         if (pt != NULL)
1351                 (kfree)(pt, area);
1352 }
1353
1354 static __inline__ void
1355 drm_core_ioremap_wc(struct drm_local_map *map, struct drm_device *dev)
1356 {
1357         map->handle = drm_ioremap_wc(dev, map);
1358 }
1359 static __inline__ void
1360 drm_core_ioremap(struct drm_local_map *map, struct drm_device *dev)
1361 {
1362         map->handle = drm_ioremap(dev, map);
1363 }
1364 static __inline__ void
1365 drm_core_ioremapfree(struct drm_local_map *map, struct drm_device *dev)
1366 {
1367         if ( map->handle && map->size )
1368                 drm_ioremapfree(map);
1369 }
1370
1371 static __inline__ struct drm_local_map *
1372 drm_core_findmap(struct drm_device *dev, unsigned long offset)
1373 {
1374         struct drm_map_list *_entry;
1375
1376         list_for_each_entry(_entry, &dev->maplist, head) {
1377                 if (offset == (unsigned long)_entry->map->handle)
1378                         return _entry->map;
1379         }
1380         return NULL;
1381 }
1382
1383 static __inline__ void drm_core_dropmap(struct drm_map *map)
1384 {
1385 }
1386
1387 #include <drm/drm_mem_util.h>
1388
1389 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
1390                                  struct device *parent);
1391 void drm_dev_ref(struct drm_device *dev);
1392 void drm_dev_unref(struct drm_device *dev);
1393 int drm_dev_register(struct drm_device *dev, unsigned long flags);
1394 void drm_dev_unregister(struct drm_device *dev);
1395 int drm_dev_set_unique(struct drm_device *dev, const char *fmt, ...);
1396
1397 /* FreeBSD compatibility macros */
1398 #define VM_OBJECT_WLOCK(object)         VM_OBJECT_LOCK(object)
1399 #define VM_OBJECT_WUNLOCK(object)       VM_OBJECT_UNLOCK(object)
1400
1401 #define DRM_PCIE_SPEED_25 1
1402 #define DRM_PCIE_SPEED_50 2
1403 #define DRM_PCIE_SPEED_80 4
1404
1405 extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
1406
1407 /* XXX bad */
1408 #define drm_can_sleep() (HZ & 1)
1409
1410 #endif /* __KERNEL__ */
1411 #endif /* _DRM_P_H_ */