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