sys/dev/drm2/drmP.h

   1 /**
   2  * \file drmP.h
   3  * Private header for Direct Rendering Manager
   4  *
   5  * \author Rickard E. (Rik) Faith <faith@valinux.com>
   6  * \author Gareth Hughes <gareth@valinux.com>
   7  */
   8
   9 /*
  10  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
  11  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
  12  * Copyright (c) 2009-2010, Code Aurora Forum.
  13  * All rights reserved.
  14  *
  15  * Permission is hereby granted, free of charge, to any person obtaining a
  16  * copy of this software and associated documentation files (the "Software"),
  17  * to deal in the Software without restriction, including without limitation
  18  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  19  * and/or sell copies of the Software, and to permit persons to whom the
  20  * Software is furnished to do so, subject to the following conditions:
  21  *
  22  * The above copyright notice and this permission notice (including the next
  23  * paragraph) shall be included in all copies or substantial portions of the
  24  * Software.
  25  *
  26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  27  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  28  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  29  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  30  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  31  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  32  * OTHER DEALINGS IN THE SOFTWARE.
  33  */
  34
  35 #include <sys/cdefs.h>
  36 __FBSDID("$FreeBSD$");
  37
  38 #ifndef _DRM_P_H_
  39 #define _DRM_P_H_
  40
  41 #if defined(_KERNEL) || defined(__KERNEL__)
  42
  43 #include <sys/param.h>
  44 #include <sys/queue.h>
  45 #include <sys/malloc.h>
  46 #include <sys/kernel.h>
  47 #include <sys/ktr.h>
  48 #include <sys/module.h>
  49 #include <sys/systm.h>
  50 #include <sys/conf.h>
  51 #include <sys/sglist.h>
  52 #include <sys/stat.h>
  53 #include <sys/priv.h>
  54 #include <sys/proc.h>
  55 #include <sys/lock.h>
  56 #include <sys/fcntl.h>
  57 #include <sys/uio.h>
  58 #include <sys/filio.h>
  59 #include <sys/rwlock.h>
  60 #include <sys/selinfo.h>
  61 #include <sys/sysctl.h>
  62 #include <sys/bus.h>
  63 #include <sys/queue.h>
  64 #include <sys/signalvar.h>
  65 #include <sys/poll.h>
  66 #include <sys/sbuf.h>
  67 #include <sys/taskqueue.h>
  68 #include <sys/tree.h>
  69 #include <vm/vm.h>
  70 #include <vm/pmap.h>
  71 #include <vm/vm_extern.h>
  72 #include <vm/vm_kern.h>
  73 #include <vm/vm_map.h>
  74 #include <vm/vm_object.h>
  75 #include <vm/vm_page.h>
  76 #include <vm/vm_pager.h>
  77 #include <vm/vm_param.h>
  78 #include <vm/vm_phys.h>
  79 #include <machine/bus.h>
  80 #include <machine/resource.h>
  81 #if defined(__i386__) || defined(__amd64__)
  82 #include <machine/specialreg.h>
  83 #endif
  84 #include <machine/sysarch.h>
  85 #include <sys/endian.h>
  86 #include <sys/mman.h>
  87 #include <sys/rman.h>
  88 #include <sys/memrange.h>
  89 #include <dev/agp/agpvar.h>
  90 #include <sys/agpio.h>
  91 #include <sys/mutex.h>
  92 #include <dev/pci/pcivar.h>
  93 #include <dev/pci/pcireg.h>
  94 #include <sys/selinfo.h>
  95 #include <sys/bus.h>
  96
  97 #include <dev/drm2/drm.h>
  98 #include <dev/drm2/drm_sarea.h>
  99
 100 #include <dev/drm2/drm_atomic.h>
 101 #include <dev/drm2/drm_linux_list.h>
 102 #include <dev/drm2/drm_gem_names.h>
 103
 104 #include <dev/drm2/drm_os_freebsd.h>
 105
 106 #define __OS_HAS_AGP (defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE)))
 107 #define __OS_HAS_MTRR (defined(CONFIG_MTRR))
 108
 109 struct drm_file;
 110 struct drm_device;
 111
 112 #include <dev/drm2/drm_hashtab.h>
 113 #include <dev/drm2/drm_mm.h>
 114
 115 #include "opt_compat.h"
 116 #include "opt_drm.h"
 117 #include "opt_syscons.h"
 118 #ifdef DRM_DEBUG
 119 #undef DRM_DEBUG
 120 #define DRM_DEBUG_DEFAULT_ON 1
 121 #endif /* DRM_DEBUG */
 122
 123 #define DRM_DEBUGBITS_DEBUG             0x1
 124 #define DRM_DEBUGBITS_KMS               0x2
 125 #define DRM_DEBUGBITS_FAILED_IOCTL      0x4
 126
 127 #undef DRM_LINUX
 128 #define DRM_LINUX 0
 129
 130 /***********************************************************************/
 131 /** \name DRM template customization defaults */
 132 /*@{*/
 133
 134 /* driver capabilities and requirements mask */
 135 #define DRIVER_USE_AGP     0x1
 136 #define DRIVER_REQUIRE_AGP 0x2
 137 #define DRIVER_USE_MTRR    0x4
 138 #define DRIVER_PCI_DMA     0x8
 139 #define DRIVER_SG          0x10
 140 #define DRIVER_HAVE_DMA    0x20
 141 #define DRIVER_HAVE_IRQ    0x40
 142 #define DRIVER_IRQ_SHARED  0x80
 143 #define DRIVER_IRQ_VBL     0x100
 144 #define DRIVER_DMA_QUEUE   0x200
 145 #define DRIVER_FB_DMA      0x400
 146 #define DRIVER_IRQ_VBL2    0x800
 147 #define DRIVER_GEM         0x1000
 148 #define DRIVER_MODESET     0x2000
 149 #define DRIVER_PRIME       0x4000
 150
 151 #define DRIVER_BUS_PCI 0x1
 152 #define DRIVER_BUS_PLATFORM 0x2
 153 #define DRIVER_BUS_USB 0x3
 154
 155 /***********************************************************************/
 156 /** \name Begin the DRM... */
 157 /*@{*/
 158
 159 #define DRM_DEBUG_CODE 2          /**< Include debugging code if > 1, then
 160                                      also include looping detection. */
 161
 162 #define DRM_MAGIC_HASH_ORDER  4  /**< Size of key hash table. Must be power of 2. */
 163 #define DRM_KERNEL_CONTEXT    0  /**< Change drm_resctx if changed */
 164 #define DRM_RESERVED_CONTEXTS 1  /**< Change drm_resctx if changed */
 165 #define DRM_LOOPING_LIMIT     5000000
 166 #define DRM_TIME_SLICE        (HZ/20)  /**< Time slice for GLXContexts */
 167 #define DRM_LOCK_SLICE        1 /**< Time slice for lock, in jiffies */
 168
 169 #define DRM_FLAG_DEBUG    0x01
 170
 171 #define DRM_MAX_CTXBITMAP (PAGE_SIZE * 8)
 172 #define DRM_MAP_HASH_OFFSET 0x10000000
 173
 174 /*@}*/
 175
 176 /***********************************************************************/
 177 /** \name Macros to make printk easier */
 178 /*@{*/
 179
 180 /**
 181  * Error output.
 182  *
 183  * \param fmt printf() like format string.
 184  * \param arg arguments
 185  */
 186 #define DRM_ERROR(fmt, ...) \
 187         printf("error: [" DRM_NAME ":pid%d:%s] *ERROR* " fmt,           \
 188             DRM_CURRENTPID, __func__ , ##__VA_ARGS__)
 189
 190 #define DRM_WARNING(fmt, ...)  printf("warning: [" DRM_NAME "] " fmt , ##__VA_ARGS__)
 191 #define DRM_INFO(fmt, ...)  printf("info: [" DRM_NAME "] " fmt , ##__VA_ARGS__)
 192
 193 /**
 194  * Debug output.
 195  *
 196  * \param fmt printf() like format string.
 197  * \param arg arguments
 198  */
 199 #define DRM_DEBUG(fmt, ...) do {                                        \
 200         if ((drm_debug & DRM_DEBUGBITS_DEBUG) != 0)                     \
 201                 printf("[" DRM_NAME ":pid%d:%s] " fmt, DRM_CURRENTPID,  \
 202                         __func__ , ##__VA_ARGS__);                      \
 203 } while (0)
 204
 205 #define DRM_DEBUG_DRIVER(fmt, ...) do {                                 \
 206         if ((drm_debug & DRM_DEBUGBITS_KMS) != 0)                       \
 207                 printf("[" DRM_NAME ":KMS:pid%d:%s] " fmt, DRM_CURRENTPID,\
 208                         __func__ , ##__VA_ARGS__);                      \
 209 } while (0)
 210
 211 #define DRM_DEBUG_KMS(fmt, ...) do {                                    \
 212         if ((drm_debug & DRM_DEBUGBITS_KMS) != 0)                       \
 213                 printf("[" DRM_NAME ":KMS:pid%d:%s] " fmt, DRM_CURRENTPID,\
 214                         __func__ , ##__VA_ARGS__);                      \
 215 } while (0)
 216
 217 #define DRM_LOG(fmt, ...) do {                                          \
 218         if ((drm_debug & DRM_DEBUGBITS_KMS) != 0)                       \
 219                 printf("[" DRM_NAME "]:pid%d:%s]" fmt, DRM_CURRENTPID,  \
 220                         __func__ , ##__VA_ARGS__);                      \
 221 } while (0)
 222
 223 #define DRM_LOG_KMS(fmt, ...) do {                                      \
 224         if ((drm_debug & DRM_DEBUGBITS_KMS) != 0)                       \
 225                 printf("[" DRM_NAME "]:KMS:pid%d:%s]" fmt, DRM_CURRENTPID,\
 226                         __func__ , ##__VA_ARGS__);                      \
 227 } while (0)
 228
 229 #define DRM_LOG_MODE(fmt, ...) do {                                     \
 230         if ((drm_debug & DRM_DEBUGBITS_KMS) != 0)                       \
 231                 printf("[" DRM_NAME "]:pid%d:%s]" fmt, DRM_CURRENTPID,  \
 232                         __func__ , ##__VA_ARGS__);                      \
 233 } while (0)
 234
 235 #define DRM_LOG_DRIVER(fmt, ...) do {                                   \
 236         if ((drm_debug & DRM_DEBUGBITS_KMS) != 0)                       \
 237                 printf("[" DRM_NAME "]:KMS:pid%d:%s]" fmt, DRM_CURRENTPID,\
 238                         __func__ , ##__VA_ARGS__);                      \
 239 } while (0)
 240
 241 /*@}*/
 242
 243 /***********************************************************************/
 244 /** \name Internal types and structures */
 245 /*@{*/
 246
 247 #define DRM_ARRAY_SIZE(x) ARRAY_SIZE(x)
 248
 249 #define DRM_LEFTCOUNT(x) (((x)->rp + (x)->count - (x)->wp) % ((x)->count + 1))
 250 #define DRM_BUFCOUNT(x) ((x)->count - DRM_LEFTCOUNT(x))
 251
 252 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
 253
 254 /**
 255  * Test that the hardware lock is held by the caller, returning otherwise.
 256  *
 257  * \param dev DRM device.
 258  * \param filp file pointer of the caller.
 259  */
 260 #define LOCK_TEST_WITH_RETURN( dev, _file_priv )                                \
 261 do {                                                                            \
 262         if (!_DRM_LOCK_IS_HELD(_file_priv->master->lock.hw_lock->lock) ||       \
 263             _file_priv->master->lock.file_priv != _file_priv)   {               \
 264                 DRM_ERROR( "%s called without lock held, held  %d owner %p %p\n",\
 265                            __func__, _DRM_LOCK_IS_HELD(_file_priv->master->lock.hw_lock->lock),\
 266                            _file_priv->master->lock.file_priv, _file_priv);     \
 267                 return -EINVAL;                                                 \
 268         }                                                                       \
 269 } while (0)
 270
 271 /**
 272  * Ioctl function type.
 273  *
 274  * \param inode device inode.
 275  * \param file_priv DRM file private pointer.
 276  * \param cmd command.
 277  * \param arg argument.
 278  */
 279 typedef int drm_ioctl_t(struct drm_device *dev, void *data,
 280                         struct drm_file *file_priv);
 281
 282 #define DRM_IOCTL_NR(n)                ((n) & 0xff)
 283 #define DRM_MAJOR       226
 284
 285 #define DRM_AUTH        0x1
 286 #define DRM_MASTER      0x2
 287 #define DRM_ROOT_ONLY   0x4
 288 #define DRM_CONTROL_ALLOW 0x8
 289 #define DRM_UNLOCKED    0x10
 290
 291 struct drm_ioctl_desc {
 292         unsigned long cmd;
 293         int flags;
 294         drm_ioctl_t *func;
 295         unsigned int cmd_drv;
 296 };
 297
 298 /**
 299  * Creates a driver or general drm_ioctl_desc array entry for the given
 300  * ioctl, for use by drm_ioctl().
 301  */
 302
 303 #define DRM_IOCTL_DEF(ioctl, _func, _flags) \
 304         [DRM_IOCTL_NR(ioctl)] = {.cmd = ioctl, .func = _func, .flags = _flags, .cmd_drv = 0}
 305
 306 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags)                 \
 307         [DRM_IOCTL_NR(DRM_##ioctl)] = {.cmd = DRM_##ioctl, .func = _func, .flags = _flags, .cmd_drv = DRM_IOCTL_##ioctl}
 308
 309 struct drm_magic_entry {
 310         struct list_head head;
 311         struct drm_hash_item hash_item;
 312         struct drm_file *priv;
 313 };
 314
 315 /**
 316  * DMA buffer.
 317  */
 318 struct drm_buf {
 319         int idx;                       /**< Index into master buflist */
 320         int total;                     /**< Buffer size */
 321         int order;                     /**< log-base-2(total) */
 322         int used;                      /**< Amount of buffer in use (for DMA) */
 323         unsigned long offset;          /**< Byte offset (used internally) */
 324         void *address;                 /**< Address of buffer */
 325         unsigned long bus_address;     /**< Bus address of buffer */
 326         struct drm_buf *next;          /**< Kernel-only: used for free list */
 327         __volatile__ int waiting;      /**< On kernel DMA queue */
 328         __volatile__ int pending;      /**< On hardware DMA queue */
 329         struct drm_file *file_priv;    /**< Private of holding file descr */
 330         int context;                   /**< Kernel queue for this buffer */
 331         int while_locked;              /**< Dispatch this buffer while locked */
 332         enum {
 333                 DRM_LIST_NONE = 0,
 334                 DRM_LIST_FREE = 1,
 335                 DRM_LIST_WAIT = 2,
 336                 DRM_LIST_PEND = 3,
 337                 DRM_LIST_PRIO = 4,
 338                 DRM_LIST_RECLAIM = 5
 339         } list;                        /**< Which list we're on */
 340
 341         int dev_priv_size;               /**< Size of buffer private storage */
 342         void *dev_private;               /**< Per-buffer private storage */
 343 };
 344
 345 struct drm_freelist {
 346         int initialized;               /**< Freelist in use */
 347         atomic_t count;                /**< Number of free buffers */
 348         struct drm_buf *next;          /**< End pointer */
 349
 350 #ifdef FREEBSD_NOTYET
 351         wait_queue_head_t waiting;     /**< Processes waiting on free bufs */
 352 #endif /* defined(FREEBSD_NOTYET) */
 353         int low_mark;                  /**< Low water mark */
 354         int high_mark;                 /**< High water mark */
 355 #ifdef FREEBSD_NOTYET
 356         atomic_t wfh;                  /**< If waiting for high mark */
 357         spinlock_t lock;
 358 #endif /* defined(FREEBSD_NOTYET) */
 359 };
 360
 361 typedef struct drm_dma_handle {
 362         void *vaddr;
 363         bus_addr_t busaddr;
 364         bus_dma_tag_t tag;
 365         bus_dmamap_t map;
 366 } drm_dma_handle_t;
 367
 368 /**
 369  * Buffer entry.  There is one of this for each buffer size order.
 370  */
 371 struct drm_buf_entry {
 372         int buf_size;                   /**< size */
 373         int buf_count;                  /**< number of buffers */
 374         struct drm_buf *buflist;                /**< buffer list */
 375         int seg_count;
 376         int page_order;
 377         struct drm_dma_handle **seglist;
 378
 379         struct drm_freelist freelist;
 380 };
 381
 382 /* Event queued up for userspace to read */
 383 struct drm_pending_event {
 384         struct drm_event *event;
 385         struct list_head link;
 386         struct drm_file *file_priv;
 387         pid_t pid; /* pid of requester, no guarantee it's valid by the time
 388                       we deliver the event, for tracing only */
 389         void (*destroy)(struct drm_pending_event *event);
 390 };
 391
 392 /* initial implementaton using a linked list - todo hashtab */
 393 struct drm_prime_file_private {
 394         struct list_head head;
 395         struct mtx lock;
 396 };
 397
 398 struct drm_file {
 399         int authenticated;
 400         pid_t pid;
 401         uid_t uid;
 402         drm_magic_t magic;
 403         unsigned long ioctl_count;
 404         struct list_head lhead;
 405         struct drm_minor *minor;
 406         unsigned long lock_count;
 407
 408         void *driver_priv;
 409         struct drm_gem_names object_names;
 410
 411         int is_master; /* this file private is a master for a minor */
 412         struct drm_master *master; /* master this node is currently associated with
 413                                       N.B. not always minor->master */
 414         struct list_head fbs;
 415
 416         struct selinfo event_poll;
 417         struct list_head event_list;
 418         int event_space;
 419
 420         struct drm_prime_file_private prime;
 421 };
 422
 423 /**
 424  * Lock data.
 425  */
 426 struct drm_lock_data {
 427         struct drm_hw_lock *hw_lock;    /**< Hardware lock */
 428         /** Private of lock holder's file (NULL=kernel) */
 429         struct drm_file *file_priv;
 430         wait_queue_head_t lock_queue;   /**< Queue of blocked processes */
 431         unsigned long lock_time;        /**< Time of last lock in jiffies */
 432         struct mtx spinlock;
 433         uint32_t kernel_waiters;
 434         uint32_t user_waiters;
 435         int idle_has_lock;
 436 };
 437
 438 /**
 439  * DMA data.
 440  */
 441 struct drm_device_dma {
 442
 443         struct drm_buf_entry bufs[DRM_MAX_ORDER + 1];   /**< buffers, grouped by their size order */
 444         int buf_count;                  /**< total number of buffers */
 445         struct drm_buf **buflist;               /**< Vector of pointers into drm_device_dma::bufs */
 446         int seg_count;
 447         int page_count;                 /**< number of pages */
 448         unsigned long *pagelist;        /**< page list */
 449         unsigned long byte_count;
 450         enum {
 451                 _DRM_DMA_USE_AGP = 0x01,
 452                 _DRM_DMA_USE_SG = 0x02,
 453                 _DRM_DMA_USE_FB = 0x04,
 454                 _DRM_DMA_USE_PCI_RO = 0x08
 455         } flags;
 456
 457 };
 458
 459 /**
 460  * AGP memory entry.  Stored as a doubly linked list.
 461  */
 462 struct drm_agp_mem {
 463         unsigned long handle;           /**< handle */
 464         DRM_AGP_MEM *memory;
 465         unsigned long bound;            /**< address */
 466         int pages;
 467         struct list_head head;
 468 };
 469
 470 /**
 471  * AGP data.
 472  *
 473  * \sa drm_agp_init() and drm_device::agp.
 474  */
 475 struct drm_agp_head {
 476         DRM_AGP_KERN agp_info;          /**< AGP device information */
 477         struct list_head memory;
 478         unsigned long mode;             /**< AGP mode */
 479         device_t bridge;
 480         int enabled;                    /**< whether the AGP bus as been enabled */
 481         int acquired;                   /**< whether the AGP device has been acquired */
 482         unsigned long base;
 483         int agp_mtrr;
 484         int cant_use_aperture;
 485 };
 486
 487 /**
 488  * Scatter-gather memory.
 489  */
 490 struct drm_sg_mem {
 491         vm_offset_t vaddr;
 492         vm_paddr_t *busaddr;
 493         vm_pindex_t pages;
 494 };
 495
 496 struct drm_sigdata {
 497         int context;
 498         struct drm_hw_lock *lock;
 499 };
 500
 501 /**
 502  * Kernel side of a mapping
 503  */
 504 #define DRM_MAP_HANDLE_BITS     (sizeof(void *) == 4 ? 4 : 24)
 505 #define DRM_MAP_HANDLE_SHIFT    (sizeof(void *) * 8 - DRM_MAP_HANDLE_BITS)
 506
 507 struct drm_local_map {
 508         resource_size_t offset;  /**< Requested physical address (0 for SAREA)*/
 509         unsigned long size;      /**< Requested physical size (bytes) */
 510         enum drm_map_type type;  /**< Type of memory to map */
 511         enum drm_map_flags flags;        /**< Flags */
 512         void *handle;            /**< User-space: "Handle" to pass to mmap() */
 513                                  /**< Kernel-space: kernel-virtual address */
 514         int mtrr;                /**< MTRR slot used */
 515
 516                                   /* Private data                         */
 517         drm_dma_handle_t *dmah;
 518 };
 519
 520 typedef struct drm_local_map drm_local_map_t;
 521
 522 /**
 523  * Mappings list
 524  */
 525 struct drm_map_list {
 526         struct list_head head;          /**< list head */
 527         struct drm_hash_item hash;
 528         struct drm_local_map *map;      /**< mapping */
 529         uint64_t user_token;
 530         struct drm_master *master;
 531         struct drm_mm_node *file_offset_node;   /**< fake offset */
 532 };
 533
 534 /**
 535  * Context handle list
 536  */
 537 struct drm_ctx_list {
 538         struct list_head head;          /**< list head */
 539         drm_context_t handle;           /**< context handle */
 540         struct drm_file *tag;           /**< associated fd private data */
 541 };
 542
 543 /* location of GART table */
 544 #define DRM_ATI_GART_MAIN 1
 545 #define DRM_ATI_GART_FB   2
 546
 547 #define DRM_ATI_GART_PCI 1
 548 #define DRM_ATI_GART_PCIE 2
 549 #define DRM_ATI_GART_IGP 3
 550
 551 struct drm_ati_pcigart_info {
 552         int gart_table_location;
 553         int gart_reg_if;
 554         void *addr;
 555         dma_addr_t bus_addr;
 556         dma_addr_t table_mask;
 557         struct drm_dma_handle *table_handle;
 558         struct drm_local_map mapping;
 559         int table_size;
 560         struct drm_dma_handle *dmah; /* handle for ATI PCIGART table FIXME */
 561 };
 562
 563 /**
 564  * GEM specific mm private for tracking GEM objects
 565  */
 566 struct drm_gem_mm {
 567         struct unrhdr *idxunr;
 568         struct drm_open_hash offset_hash; /**< User token hash table for maps */
 569 };
 570
 571 /**
 572  * This structure defines the drm_mm memory object, which will be used by the
 573  * DRM for its buffer objects.
 574  */
 575 struct drm_gem_object {
 576         /** Reference count of this object */
 577         u_int refcount;
 578
 579         /** Handle count of this object. Each handle also holds a reference */
 580         atomic_t handle_count; /* number of handles on this object */
 581
 582         /** Related drm device */
 583         struct drm_device *dev;
 584
 585         /** File representing the shmem storage: filp in Linux parlance */
 586         vm_object_t vm_obj;
 587
 588         /* Mapping info for this object */
 589         bool on_map;
 590         struct drm_hash_item map_list;
 591
 592         /**
 593          * Size of the object, in bytes.  Immutable over the object's
 594          * lifetime.
 595          */
 596         size_t size;
 597
 598         /**
 599          * Global name for this object, starts at 1. 0 means unnamed.
 600          * Access is covered by the object_name_lock in the related drm_device
 601          */
 602         int name;
 603
 604         /**
 605          * Memory domains. These monitor which caches contain read/write data
 606          * related to the object. When transitioning from one set of domains
 607          * to another, the driver is called to ensure that caches are suitably
 608          * flushed and invalidated
 609          */
 610         uint32_t read_domains;
 611         uint32_t write_domain;
 612
 613         /**
 614          * While validating an exec operation, the
 615          * new read/write domain values are computed here.
 616          * They will be transferred to the above values
 617          * at the point that any cache flushing occurs
 618          */
 619         uint32_t pending_read_domains;
 620         uint32_t pending_write_domain;
 621
 622         void *driver_private;
 623
 624 #ifdef FREEBSD_NOTYET
 625         /* dma buf exported from this GEM object */
 626         struct dma_buf *export_dma_buf;
 627
 628         /* dma buf attachment backing this object */
 629         struct dma_buf_attachment *import_attach;
 630 #endif /* FREEBSD_NOTYET */
 631 };
 632
 633 #include <dev/drm2/drm_crtc.h>
 634
 635 /* per-master structure */
 636 struct drm_master {
 637
 638         u_int refcount; /* refcount for this master */
 639
 640         struct list_head head; /**< each minor contains a list of masters */
 641         struct drm_minor *minor; /**< link back to minor we are a master for */
 642
 643         char *unique;                   /**< Unique identifier: e.g., busid */
 644         int unique_len;                 /**< Length of unique field */
 645         int unique_size;                /**< amount allocated */
 646
 647         int blocked;                    /**< Blocked due to VC switch? */
 648
 649         /** \name Authentication */
 650         /*@{ */
 651         struct drm_open_hash magiclist;
 652         struct list_head magicfree;
 653         /*@} */
 654
 655         struct drm_lock_data lock;      /**< Information on hardware lock */
 656
 657         void *driver_priv; /**< Private structure for driver to use */
 658 };
 659
 660 /* Size of ringbuffer for vblank timestamps. Just double-buffer
 661  * in initial implementation.
 662  */
 663 #define DRM_VBLANKTIME_RBSIZE 2
 664
 665 /* Flags and return codes for get_vblank_timestamp() driver function. */
 666 #define DRM_CALLED_FROM_VBLIRQ 1
 667 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
 668 #define DRM_VBLANKTIME_INVBL             (1 << 1)
 669
 670 /* get_scanout_position() return flags */
 671 #define DRM_SCANOUTPOS_VALID        (1 << 0)
 672 #define DRM_SCANOUTPOS_INVBL        (1 << 1)
 673 #define DRM_SCANOUTPOS_ACCURATE     (1 << 2)
 674
 675 struct drm_bus {
 676         int bus_type;
 677         int (*get_irq)(struct drm_device *dev);
 678         void (*free_irq)(struct drm_device *dev);
 679         const char *(*get_name)(struct drm_device *dev);
 680         int (*set_busid)(struct drm_device *dev, struct drm_master *master);
 681         int (*set_unique)(struct drm_device *dev, struct drm_master *master,
 682                           struct drm_unique *unique);
 683         int (*irq_by_busid)(struct drm_device *dev, struct drm_irq_busid *p);
 684         /* hooks that are for PCI */
 685         int (*agp_init)(struct drm_device *dev);
 686
 687 };
 688
 689 /**
 690  * DRM driver structure. This structure represent the common code for
 691  * a family of cards. There will one drm_device for each card present
 692  * in this family
 693  */
 694 struct drm_driver {
 695         int (*load) (struct drm_device *, unsigned long flags);
 696         int (*firstopen) (struct drm_device *);
 697         int (*open) (struct drm_device *, struct drm_file *);
 698         void (*preclose) (struct drm_device *, struct drm_file *file_priv);
 699         void (*postclose) (struct drm_device *, struct drm_file *);
 700         void (*lastclose) (struct drm_device *);
 701         int (*unload) (struct drm_device *);
 702         int (*suspend) (struct drm_device *, pm_message_t state);
 703         int (*resume) (struct drm_device *);
 704         int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
 705         int (*dma_quiescent) (struct drm_device *);
 706         int (*context_dtor) (struct drm_device *dev, int context);
 707
 708         /**
 709          * get_vblank_counter - get raw hardware vblank counter
 710          * @dev: DRM device
 711          * @crtc: counter to fetch
 712          *
 713          * Driver callback for fetching a raw hardware vblank counter for @crtc.
 714          * If a device doesn't have a hardware counter, the driver can simply
 715          * return the value of drm_vblank_count. The DRM core will account for
 716          * missed vblank events while interrupts where disabled based on system
 717          * timestamps.
 718          *
 719          * Wraparound handling and loss of events due to modesetting is dealt
 720          * with in the DRM core code.
 721          *
 722          * RETURNS
 723          * Raw vblank counter value.
 724          */
 725         u32 (*get_vblank_counter) (struct drm_device *dev, int crtc);
 726
 727         /**
 728          * enable_vblank - enable vblank interrupt events
 729          * @dev: DRM device
 730          * @crtc: which irq to enable
 731          *
 732          * Enable vblank interrupts for @crtc.  If the device doesn't have
 733          * a hardware vblank counter, this routine should be a no-op, since
 734          * interrupts will have to stay on to keep the count accurate.
 735          *
 736          * RETURNS
 737          * Zero on success, appropriate errno if the given @crtc's vblank
 738          * interrupt cannot be enabled.
 739          */
 740         int (*enable_vblank) (struct drm_device *dev, int crtc);
 741
 742         /**
 743          * disable_vblank - disable vblank interrupt events
 744          * @dev: DRM device
 745          * @crtc: which irq to enable
 746          *
 747          * Disable vblank interrupts for @crtc.  If the device doesn't have
 748          * a hardware vblank counter, this routine should be a no-op, since
 749          * interrupts will have to stay on to keep the count accurate.
 750          */
 751         void (*disable_vblank) (struct drm_device *dev, int crtc);
 752
 753         /**
 754          * Called by \c drm_device_is_agp.  Typically used to determine if a
 755          * card is really attached to AGP or not.
 756          *
 757          * \param dev  DRM device handle
 758          *
 759          * \returns
 760          * One of three values is returned depending on whether or not the
 761          * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
 762          * (return of 1), or may or may not be AGP (return of 2).
 763          */
 764         int (*device_is_agp) (struct drm_device *dev);
 765
 766         /**
 767          * Called by vblank timestamping code.
 768          *
 769          * Return the current display scanout position from a crtc.
 770          *
 771          * \param dev  DRM device.
 772          * \param crtc Id of the crtc to query.
 773          * \param *vpos Target location for current vertical scanout position.
 774          * \param *hpos Target location for current horizontal scanout position.
 775          *
 776          * Returns vpos as a positive number while in active scanout area.
 777          * Returns vpos as a negative number inside vblank, counting the number
 778          * of scanlines to go until end of vblank, e.g., -1 means "one scanline
 779          * until start of active scanout / end of vblank."
 780          *
 781          * \return Flags, or'ed together as follows:
 782          *
 783          * DRM_SCANOUTPOS_VALID = Query successful.
 784          * DRM_SCANOUTPOS_INVBL = Inside vblank.
 785          * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
 786          * this flag means that returned position may be offset by a constant
 787          * but unknown small number of scanlines wrt. real scanout position.
 788          *
 789          */
 790         int (*get_scanout_position) (struct drm_device *dev, int crtc,
 791                                      int *vpos, int *hpos);
 792
 793         /**
 794          * Called by \c drm_get_last_vbltimestamp. Should return a precise
 795          * timestamp when the most recent VBLANK interval ended or will end.
 796          *
 797          * Specifically, the timestamp in @vblank_time should correspond as
 798          * closely as possible to the time when the first video scanline of
 799          * the video frame after the end of VBLANK will start scanning out,
 800          * the time immediately after end of the VBLANK interval. If the
 801          * @crtc is currently inside VBLANK, this will be a time in the future.
 802          * If the @crtc is currently scanning out a frame, this will be the
 803          * past start time of the current scanout. This is meant to adhere
 804          * to the OpenML OML_sync_control extension specification.
 805          *
 806          * \param dev dev DRM device handle.
 807          * \param crtc crtc for which timestamp should be returned.
 808          * \param *max_error Maximum allowable timestamp error in nanoseconds.
 809          *                   Implementation should strive to provide timestamp
 810          *                   with an error of at most *max_error nanoseconds.
 811          *                   Returns true upper bound on error for timestamp.
 812          * \param *vblank_time Target location for returned vblank timestamp.
 813          * \param flags 0 = Defaults, no special treatment needed.
 814          * \param       DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
 815          *              irq handler. Some drivers need to apply some workarounds
 816          *              for gpu-specific vblank irq quirks if flag is set.
 817          *
 818          * \returns
 819          * Zero if timestamping isn't supported in current display mode or a
 820          * negative number on failure. A positive status code on success,
 821          * which describes how the vblank_time timestamp was computed.
 822          */
 823         int (*get_vblank_timestamp) (struct drm_device *dev, int crtc,
 824                                      int *max_error,
 825                                      struct timeval *vblank_time,
 826                                      unsigned flags);
 827
 828         /* these have to be filled in */
 829
 830         irqreturn_t(*irq_handler) (DRM_IRQ_ARGS);
 831         void (*irq_preinstall) (struct drm_device *dev);
 832         int (*irq_postinstall) (struct drm_device *dev);
 833         void (*irq_uninstall) (struct drm_device *dev);
 834         void (*set_version) (struct drm_device *dev,
 835                              struct drm_set_version *sv);
 836
 837         /* Master routines */
 838         int (*master_create)(struct drm_device *dev, struct drm_master *master);
 839         void (*master_destroy)(struct drm_device *dev, struct drm_master *master);
 840         /**
 841          * master_set is called whenever the minor master is set.
 842          * master_drop is called whenever the minor master is dropped.
 843          */
 844
 845         int (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
 846                           bool from_open);
 847         void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv,
 848                             bool from_release);
 849
 850         /**
 851          * Driver-specific constructor for drm_gem_objects, to set up
 852          * obj->driver_private.
 853          *
 854          * Returns 0 on success.
 855          */
 856         int (*gem_init_object) (struct drm_gem_object *obj);
 857         void (*gem_free_object) (struct drm_gem_object *obj);
 858         int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
 859         void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
 860
 861 #ifdef FREEBSD_NOTYET
 862         /* prime: */
 863         /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */
 864         int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
 865                                 uint32_t handle, uint32_t flags, int *prime_fd);
 866         /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */
 867         int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
 868                                 int prime_fd, uint32_t *handle);
 869         /* export GEM -> dmabuf */
 870         struct dma_buf * (*gem_prime_export)(struct drm_device *dev,
 871                                 struct drm_gem_object *obj, int flags);
 872         /* import dmabuf -> GEM */
 873         struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
 874                                 struct dma_buf *dma_buf);
 875 #endif /* defined(FREEBSD_NOTYET) */
 876
 877         /* dumb alloc support */
 878         int (*dumb_create)(struct drm_file *file_priv,
 879                            struct drm_device *dev,
 880                            struct drm_mode_create_dumb *args);
 881         int (*dumb_map_offset)(struct drm_file *file_priv,
 882                                struct drm_device *dev, uint32_t handle,
 883                                uint64_t *offset);
 884         int (*dumb_destroy)(struct drm_file *file_priv,
 885                             struct drm_device *dev,
 886                             uint32_t handle);
 887
 888         /* Driver private ops for this object */
 889         struct cdev_pager_ops *gem_pager_ops;
 890
 891         int     (*sysctl_init)(struct drm_device *dev,
 892                     struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
 893         void    (*sysctl_cleanup)(struct drm_device *dev);
 894
 895         int major;
 896         int minor;
 897         int patchlevel;
 898         char *name;
 899         char *desc;
 900         char *date;
 901
 902         u32 driver_features;
 903         int dev_priv_size;
 904         struct drm_ioctl_desc *ioctls;
 905         int num_ioctls;
 906         struct drm_bus *bus;
 907 #ifdef COMPAT_FREEBSD32
 908         struct drm_ioctl_desc *compat_ioctls;
 909         int *num_compat_ioctls;
 910 #endif
 911
 912         int     buf_priv_size;
 913 };
 914
 915 #define DRM_MINOR_UNASSIGNED 0
 916 #define DRM_MINOR_LEGACY 1
 917 #define DRM_MINOR_CONTROL 2
 918 #define DRM_MINOR_RENDER 3
 919
 920 /**
 921  * DRM minor structure. This structure represents a drm minor number.
 922  */
 923 struct drm_minor {
 924         int index;                      /**< Minor device number */
 925         int type;                       /**< Control or render */
 926         struct cdev *device;            /**< Device number for mknod */
 927         device_t kdev;                  /**< OS device */
 928         struct drm_device *dev;
 929
 930         struct drm_master *master; /* currently active master for this node */
 931         struct list_head master_list;
 932         struct drm_mode_group mode_group;
 933
 934         struct sigio *buf_sigio;        /* Processes waiting for SIGIO     */
 935 };
 936
 937 /* mode specified on the command line */
 938 struct drm_cmdline_mode {
 939         bool specified;
 940         bool refresh_specified;
 941         bool bpp_specified;
 942         int xres, yres;
 943         int bpp;
 944         int refresh;
 945         bool rb;
 946         bool interlace;
 947         bool cvt;
 948         bool margins;
 949         enum drm_connector_force force;
 950 };
 951
 952
 953 struct drm_pending_vblank_event {
 954         struct drm_pending_event base;
 955         int pipe;
 956         struct drm_event_vblank event;
 957 };
 958
 959 /**
 960  * DRM device structure. This structure represent a complete card that
 961  * may contain multiple heads.
 962  */
 963 struct drm_device {
 964         int if_version;                 /**< Highest interface version set */
 965
 966         /** \name Locks */
 967         /*@{ */
 968         struct mtx count_lock;          /**< For inuse, drm_device::open_count, drm_device::buf_use */
 969         struct sx dev_struct_lock;      /**< For others */
 970         /*@} */
 971
 972         /** \name Usage Counters */
 973         /*@{ */
 974         int open_count;                 /**< Outstanding files open */
 975         atomic_t ioctl_count;           /**< Outstanding IOCTLs pending */
 976         atomic_t vma_count;             /**< Outstanding vma areas open */
 977         int buf_use;                    /**< Buffers in use -- cannot alloc */
 978         atomic_t buf_alloc;             /**< Buffer allocation in progress */
 979         /*@} */
 980
 981         /** \name Performance counters */
 982         /*@{ */
 983         unsigned long counters;
 984         enum drm_stat_type types[15];
 985         atomic_t counts[15];
 986         /*@} */
 987
 988         struct list_head filelist;
 989
 990         /** \name Memory management */
 991         /*@{ */
 992         struct list_head maplist;       /**< Linked list of regions */
 993         int map_count;                  /**< Number of mappable regions */
 994         struct drm_open_hash map_hash;  /**< User token hash table for maps */
 995
 996         /** \name Context handle management */
 997         /*@{ */
 998         struct list_head ctxlist;       /**< Linked list of context handles */
 999         int ctx_count;                  /**< Number of context handles */
1000         struct mtx ctxlist_mutex;       /**< For ctxlist */
1001         drm_local_map_t **context_sareas;
1002         int max_context;
1003         unsigned long *ctx_bitmap;
1004
1005         /*@} */
1006
1007         /** \name DMA support */
1008         /*@{ */
1009         struct drm_device_dma *dma;             /**< Optional pointer for DMA support */
1010         /*@} */
1011
1012         /** \name Context support */
1013         /*@{ */
1014         int irq_enabled;                /**< True if irq handler is enabled */
1015         atomic_t context_flag;          /**< Context swapping flag */
1016         atomic_t interrupt_flag;        /**< Interruption handler flag */
1017         atomic_t dma_flag;              /**< DMA dispatch flag */
1018         wait_queue_head_t context_wait; /**< Processes waiting on ctx switch */
1019         int last_checked;               /**< Last context checked for DMA */
1020         int last_context;               /**< Last current context */
1021         unsigned long last_switch;      /**< jiffies at last context switch */
1022         /*@} */
1023
1024         /** \name VBLANK IRQ support */
1025         /*@{ */
1026
1027         /*
1028          * At load time, disabling the vblank interrupt won't be allowed since
1029          * old clients may not call the modeset ioctl and therefore misbehave.
1030          * Once the modeset ioctl *has* been called though, we can safely
1031          * disable them when unused.
1032          */
1033         int vblank_disable_allowed;
1034
1035         atomic_t *_vblank_count;        /**< number of VBLANK interrupts (driver must alloc the right number of counters) */
1036         struct timeval *_vblank_time;   /**< timestamp of current vblank_count (drivers must alloc right number of fields) */
1037         struct mtx vblank_time_lock;    /**< Protects vblank count and time updates during vblank enable/disable */
1038         struct mtx vbl_lock;
1039         atomic_t *vblank_refcount;      /* number of users of vblank interruptsper crtc */
1040         u32 *last_vblank;               /* protected by dev->vbl_lock, used */
1041                                         /* for wraparound handling */
1042         int *vblank_enabled;            /* so we don't call enable more than
1043                                            once per disable */
1044         int *vblank_inmodeset;          /* Display driver is setting mode */
1045         u32 *last_vblank_wait;          /* Last vblank seqno waited per CRTC */
1046         struct callout vblank_disable_callout;
1047
1048         u32 max_vblank_count;           /**< size of vblank counter register */
1049
1050         /**
1051          * List of events
1052          */
1053         struct list_head vblank_event_list;
1054         struct mtx event_lock;
1055
1056         /*@} */
1057
1058         struct drm_agp_head *agp;       /**< AGP data */
1059
1060         device_t dev;                   /* Device instance from newbus */
1061         uint16_t pci_device;            /* PCI device id */
1062         uint16_t pci_vendor;            /* PCI vendor id */
1063         uint16_t pci_subdevice;         /* PCI subsystem device id */
1064         uint16_t pci_subvendor;         /* PCI subsystem vendor id */
1065
1066         struct drm_sg_mem *sg;  /**< Scatter gather memory */
1067         unsigned int num_crtcs;                  /**< Number of CRTCs on this device */
1068         void *dev_private;              /**< device private data */
1069         void *mm_private;
1070         struct drm_sigdata sigdata;        /**< For block_all_signals */
1071         sigset_t sigmask;
1072
1073         struct drm_driver *driver;
1074         struct drm_local_map *agp_buffer_map;
1075         unsigned int agp_buffer_token;
1076         struct drm_minor *control;              /**< Control node for card */
1077         struct drm_minor *primary;              /**< render type primary screen head */
1078
1079         struct drm_mode_config mode_config;     /**< Current mode config */
1080
1081         /** \name GEM information */
1082         /*@{ */
1083         struct sx object_name_lock;
1084         struct drm_gem_names object_names;
1085         /*@} */
1086         int switch_power_state;
1087
1088         atomic_t unplugged; /* device has been unplugged or gone away */
1089
1090                                 /* Locks */
1091         struct mtx        dma_lock;     /* protects dev->dma */
1092         struct mtx        irq_lock;     /* protects irq condition checks */
1093
1094                                 /* Context support */
1095         int               irq;          /* Interrupt used by board         */
1096         int               msi_enabled;  /* MSI enabled */
1097         int               irqrid;       /* Interrupt used by board */
1098         struct resource   *irqr;        /* Resource for interrupt used by board    */
1099         void              *irqh;        /* Handle from bus_setup_intr      */
1100
1101         /* Storage of resource pointers for drm_get_resource_* */
1102 #define DRM_MAX_PCI_RESOURCE    6
1103         struct resource   *pcir[DRM_MAX_PCI_RESOURCE];
1104         int               pcirid[DRM_MAX_PCI_RESOURCE];
1105         struct mtx        pcir_lock;
1106
1107         int               pci_domain;
1108         int               pci_bus;
1109         int               pci_slot;
1110         int               pci_func;
1111
1112                                 /* Sysctl support */
1113         struct drm_sysctl_info *sysctl;
1114         int               sysctl_node_idx;
1115
1116         void              *drm_ttm_bdev;
1117
1118         void *sysctl_private;
1119         char busid_str[128];
1120         int modesetting;
1121
1122         const drm_pci_id_list_t *id_entry;      /* PCI ID, name, and chipset private */
1123 };
1124
1125 #define DRM_SWITCH_POWER_ON 0
1126 #define DRM_SWITCH_POWER_OFF 1
1127 #define DRM_SWITCH_POWER_CHANGING 2
1128
1129 static __inline__ int drm_core_check_feature(struct drm_device *dev,
1130                                              int feature)
1131 {
1132         return ((dev->driver->driver_features & feature) ? 1 : 0);
1133 }
1134
1135 static inline int drm_dev_to_irq(struct drm_device *dev)
1136 {
1137         return dev->driver->bus->get_irq(dev);
1138 }
1139
1140
1141 #if __OS_HAS_AGP
1142 static inline int drm_core_has_AGP(struct drm_device *dev)
1143 {
1144         return drm_core_check_feature(dev, DRIVER_USE_AGP);
1145 }
1146 #else
1147 #define drm_core_has_AGP(dev) (0)
1148 #endif
1149
1150 #if __OS_HAS_MTRR
1151 static inline int drm_core_has_MTRR(struct drm_device *dev)
1152 {
1153         return drm_core_check_feature(dev, DRIVER_USE_MTRR);
1154 }
1155
1156 #define DRM_MTRR_WC             MDF_WRITECOMBINE
1157
1158 int drm_mtrr_add(unsigned long offset, unsigned long size, unsigned int flags);
1159 int drm_mtrr_del(int handle, unsigned long offset, unsigned long size, unsigned int flags);
1160
1161 #else
1162 #define drm_core_has_MTRR(dev) (0)
1163
1164 #define DRM_MTRR_WC             0
1165
1166 static inline int drm_mtrr_add(unsigned long offset, unsigned long size,
1167                                unsigned int flags)
1168 {
1169         return 0;
1170 }
1171
1172 static inline int drm_mtrr_del(int handle, unsigned long offset,
1173                                unsigned long size, unsigned int flags)
1174 {
1175         return 0;
1176 }
1177 #endif
1178
1179 /******************************************************************/
1180 /** \name Internal function definitions */
1181 /*@{*/
1182
1183                                 /* Driver support (drm_drv.h) */
1184 d_ioctl_t drm_ioctl;
1185 extern int drm_lastclose(struct drm_device *dev);
1186
1187                                 /* Device support (drm_fops.h) */
1188 extern struct sx drm_global_mutex;
1189 d_open_t drm_open;
1190 d_read_t drm_read;
1191 extern void drm_release(void *data);
1192
1193                                 /* Mapping support (drm_vm.h) */
1194 d_mmap_t drm_mmap;
1195 int     drm_mmap_single(struct cdev *kdev, vm_ooffset_t *offset,
1196             vm_size_t size, struct vm_object **obj_res, int nprot);
1197 d_poll_t drm_poll;
1198
1199                                 /* Memory management support (drm_memory.h) */
1200 extern void drm_free_agp(DRM_AGP_MEM * handle, int pages);
1201 extern int drm_bind_agp(DRM_AGP_MEM * handle, unsigned int start);
1202 #ifdef FREEBSD_NOTYET
1203 extern DRM_AGP_MEM *drm_agp_bind_pages(struct drm_device *dev,
1204                                        struct page **pages,
1205                                        unsigned long num_pages,
1206                                        uint32_t gtt_offset,
1207                                        uint32_t type);
1208 #endif /* FREEBSD_NOTYET */
1209 extern int drm_unbind_agp(DRM_AGP_MEM * handle);
1210
1211                                 /* Misc. IOCTL support (drm_ioctl.h) */
1212 extern int drm_irq_by_busid(struct drm_device *dev, void *data,
1213                             struct drm_file *file_priv);
1214 extern int drm_getunique(struct drm_device *dev, void *data,
1215                          struct drm_file *file_priv);
1216 extern int drm_setunique(struct drm_device *dev, void *data,
1217                          struct drm_file *file_priv);
1218 extern int drm_getmap(struct drm_device *dev, void *data,
1219                       struct drm_file *file_priv);
1220 extern int drm_getclient(struct drm_device *dev, void *data,
1221                          struct drm_file *file_priv);
1222 extern int drm_getstats(struct drm_device *dev, void *data,
1223                         struct drm_file *file_priv);
1224 extern int drm_getcap(struct drm_device *dev, void *data,
1225                       struct drm_file *file_priv);
1226 extern int drm_setversion(struct drm_device *dev, void *data,
1227                           struct drm_file *file_priv);
1228 extern int drm_noop(struct drm_device *dev, void *data,
1229                     struct drm_file *file_priv);
1230
1231                                 /* Context IOCTL support (drm_context.h) */
1232 extern int drm_resctx(struct drm_device *dev, void *data,
1233                       struct drm_file *file_priv);
1234 extern int drm_addctx(struct drm_device *dev, void *data,
1235                       struct drm_file *file_priv);
1236 extern int drm_modctx(struct drm_device *dev, void *data,
1237                       struct drm_file *file_priv);
1238 extern int drm_getctx(struct drm_device *dev, void *data,
1239                       struct drm_file *file_priv);
1240 extern int drm_switchctx(struct drm_device *dev, void *data,
1241                          struct drm_file *file_priv);
1242 extern int drm_newctx(struct drm_device *dev, void *data,
1243                       struct drm_file *file_priv);
1244 extern int drm_rmctx(struct drm_device *dev, void *data,
1245                      struct drm_file *file_priv);
1246
1247 extern int drm_ctxbitmap_init(struct drm_device *dev);
1248 extern void drm_ctxbitmap_cleanup(struct drm_device *dev);
1249 extern void drm_ctxbitmap_free(struct drm_device *dev, int ctx_handle);
1250
1251 extern int drm_setsareactx(struct drm_device *dev, void *data,
1252                            struct drm_file *file_priv);
1253 extern int drm_getsareactx(struct drm_device *dev, void *data,
1254                            struct drm_file *file_priv);
1255
1256                                 /* Authentication IOCTL support (drm_auth.h) */
1257 extern int drm_getmagic(struct drm_device *dev, void *data,
1258                         struct drm_file *file_priv);
1259 extern int drm_authmagic(struct drm_device *dev, void *data,
1260                          struct drm_file *file_priv);
1261 extern int drm_remove_magic(struct drm_master *master, drm_magic_t magic);
1262
1263 /* Cache management (drm_cache.c) */
1264 void drm_clflush_pages(vm_page_t *pages, unsigned long num_pages);
1265 void drm_clflush_virt_range(char *addr, unsigned long length);
1266
1267                                 /* Locking IOCTL support (drm_lock.h) */
1268 extern int drm_lock(struct drm_device *dev, void *data,
1269                     struct drm_file *file_priv);
1270 extern int drm_unlock(struct drm_device *dev, void *data,
1271                       struct drm_file *file_priv);
1272 extern int drm_lock_free(struct drm_lock_data *lock_data, unsigned int context);
1273 extern void drm_idlelock_take(struct drm_lock_data *lock_data);
1274 extern void drm_idlelock_release(struct drm_lock_data *lock_data);
1275
1276 /*
1277  * These are exported to drivers so that they can implement fencing using
1278  * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
1279  */
1280
1281 extern int drm_i_have_hw_lock(struct drm_device *dev, struct drm_file *file_priv);
1282
1283                                 /* Buffer management support (drm_bufs.h) */
1284 extern int drm_addbufs_agp(struct drm_device *dev, struct drm_buf_desc * request);
1285 extern int drm_addbufs_pci(struct drm_device *dev, struct drm_buf_desc * request);
1286 extern int drm_addmap(struct drm_device *dev, resource_size_t offset,
1287                       unsigned int size, enum drm_map_type type,
1288                       enum drm_map_flags flags, struct drm_local_map **map_ptr);
1289 extern int drm_addmap_ioctl(struct drm_device *dev, void *data,
1290                             struct drm_file *file_priv);
1291 extern int drm_rmmap(struct drm_device *dev, struct drm_local_map *map);
1292 extern int drm_rmmap_locked(struct drm_device *dev, struct drm_local_map *map);
1293 extern int drm_rmmap_ioctl(struct drm_device *dev, void *data,
1294                            struct drm_file *file_priv);
1295 extern int drm_addbufs(struct drm_device *dev, void *data,
1296                        struct drm_file *file_priv);
1297 extern int drm_infobufs(struct drm_device *dev, void *data,
1298                         struct drm_file *file_priv);
1299 extern int drm_markbufs(struct drm_device *dev, void *data,
1300                         struct drm_file *file_priv);
1301 extern int drm_freebufs(struct drm_device *dev, void *data,
1302                         struct drm_file *file_priv);
1303 extern int drm_mapbufs(struct drm_device *dev, void *data,
1304                        struct drm_file *file_priv);
1305 extern int drm_order(unsigned long size);
1306
1307                                 /* DMA support (drm_dma.h) */
1308 extern int drm_dma_setup(struct drm_device *dev);
1309 extern void drm_dma_takedown(struct drm_device *dev);
1310 extern void drm_free_buffer(struct drm_device *dev, struct drm_buf * buf);
1311 extern void drm_core_reclaim_buffers(struct drm_device *dev,
1312                                      struct drm_file *filp);
1313
1314                                 /* IRQ support (drm_irq.h) */
1315 extern int drm_control(struct drm_device *dev, void *data,
1316                        struct drm_file *file_priv);
1317 extern int drm_irq_install(struct drm_device *dev);
1318 extern int drm_irq_uninstall(struct drm_device *dev);
1319
1320 extern int drm_vblank_init(struct drm_device *dev, int num_crtcs);
1321 extern int drm_wait_vblank(struct drm_device *dev, void *data,
1322                            struct drm_file *filp);
1323 extern int drm_vblank_wait(struct drm_device *dev, unsigned int *vbl_seq);
1324 extern u32 drm_vblank_count(struct drm_device *dev, int crtc);
1325 extern u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
1326                                      struct timeval *vblanktime);
1327 extern void drm_send_vblank_event(struct drm_device *dev, int crtc,
1328                                      struct drm_pending_vblank_event *e);
1329 extern bool drm_handle_vblank(struct drm_device *dev, int crtc);
1330 extern int drm_vblank_get(struct drm_device *dev, int crtc);
1331 extern void drm_vblank_put(struct drm_device *dev, int crtc);
1332 extern void drm_vblank_off(struct drm_device *dev, int crtc);
1333 extern void drm_vblank_cleanup(struct drm_device *dev);
1334 extern u32 drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
1335                                      struct timeval *tvblank, unsigned flags);
1336 extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
1337                                                  int crtc, int *max_error,
1338                                                  struct timeval *vblank_time,
1339                                                  unsigned flags,
1340                                                  struct drm_crtc *refcrtc);
1341 extern void drm_calc_timestamping_constants(struct drm_crtc *crtc);
1342
1343 extern bool
1344 drm_mode_parse_command_line_for_connector(const char *mode_option,
1345                                           struct drm_connector *connector,
1346                                           struct drm_cmdline_mode *mode);
1347
1348 extern struct drm_display_mode *
1349 drm_mode_create_from_cmdline_mode(struct drm_device *dev,
1350                                   struct drm_cmdline_mode *cmd);
1351
1352 /* Modesetting support */
1353 extern void drm_vblank_pre_modeset(struct drm_device *dev, int crtc);
1354 extern void drm_vblank_post_modeset(struct drm_device *dev, int crtc);
1355 extern int drm_modeset_ctl(struct drm_device *dev, void *data,
1356                            struct drm_file *file_priv);
1357
1358                                 /* AGP/GART support (drm_agpsupport.h) */
1359 extern struct drm_agp_head *drm_agp_init(struct drm_device *dev);
1360 extern int drm_agp_acquire(struct drm_device *dev);
1361 extern int drm_agp_acquire_ioctl(struct drm_device *dev, void *data,
1362                                  struct drm_file *file_priv);
1363 extern int drm_agp_release(struct drm_device *dev);
1364 extern int drm_agp_release_ioctl(struct drm_device *dev, void *data,
1365                                  struct drm_file *file_priv);
1366 extern int drm_agp_enable(struct drm_device *dev, struct drm_agp_mode mode);
1367 extern int drm_agp_enable_ioctl(struct drm_device *dev, void *data,
1368                                 struct drm_file *file_priv);
1369 extern int drm_agp_info(struct drm_device *dev, struct drm_agp_info *info);
1370 extern int drm_agp_info_ioctl(struct drm_device *dev, void *data,
1371                         struct drm_file *file_priv);
1372 extern int drm_agp_alloc(struct drm_device *dev, struct drm_agp_buffer *request);
1373 extern int drm_agp_alloc_ioctl(struct drm_device *dev, void *data,
1374                          struct drm_file *file_priv);
1375 extern int drm_agp_free(struct drm_device *dev, struct drm_agp_buffer *request);
1376 extern int drm_agp_free_ioctl(struct drm_device *dev, void *data,
1377                         struct drm_file *file_priv);
1378 extern int drm_agp_unbind(struct drm_device *dev, struct drm_agp_binding *request);
1379 extern int drm_agp_unbind_ioctl(struct drm_device *dev, void *data,
1380                           struct drm_file *file_priv);
1381 extern int drm_agp_bind(struct drm_device *dev, struct drm_agp_binding *request);
1382 extern int drm_agp_bind_ioctl(struct drm_device *dev, void *data,
1383                         struct drm_file *file_priv);
1384
1385                                 /* Stub support (drm_stub.h) */
1386 extern int drm_setmaster_ioctl(struct drm_device *dev, void *data,
1387                                struct drm_file *file_priv);
1388 extern int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
1389                                 struct drm_file *file_priv);
1390 struct drm_master *drm_master_create(struct drm_minor *minor);
1391 extern struct drm_master *drm_master_get(struct drm_master *master);
1392 extern void drm_master_put(struct drm_master **master);
1393
1394 extern void drm_put_dev(struct drm_device *dev);
1395 extern int drm_put_minor(struct drm_minor **minor);
1396 extern void drm_unplug_dev(struct drm_device *dev);
1397 extern unsigned int drm_debug;
1398 extern unsigned int drm_notyet;
1399
1400 extern unsigned int drm_vblank_offdelay;
1401 extern unsigned int drm_timestamp_precision;
1402 extern unsigned int drm_timestamp_monotonic;
1403
1404 extern struct drm_local_map *drm_getsarea(struct drm_device *dev);
1405
1406
1407 #ifdef FREEBSD_NOTYET
1408 extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
1409                 struct drm_file *file_priv, uint32_t handle, uint32_t flags,
1410                 int *prime_fd);
1411 extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
1412                 struct drm_file *file_priv, int prime_fd, uint32_t *handle);
1413
1414 extern int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data,
1415                                         struct drm_file *file_priv);
1416 extern int drm_prime_fd_to_handle_ioctl(struct drm_device *dev, void *data,
1417                                         struct drm_file *file_priv);
1418
1419 extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, vm_page_t *pages,
1420                                             dma_addr_t *addrs, int max_pages);
1421 extern struct sg_table *drm_prime_pages_to_sg(vm_page_t *pages, int nr_pages);
1422 extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
1423
1424
1425 void drm_prime_init_file_private(struct drm_prime_file_private *prime_fpriv);
1426 void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv);
1427 int drm_prime_add_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf, uint32_t handle);
1428 int drm_prime_lookup_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf, uint32_t *handle);
1429 void drm_prime_remove_imported_buf_handle(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf);
1430
1431 int drm_prime_add_dma_buf(struct drm_device *dev, struct drm_gem_object *obj);
1432 int drm_prime_lookup_obj(struct drm_device *dev, struct dma_buf *buf,
1433                          struct drm_gem_object **obj);
1434 #endif /* FREEBSD_NOTYET */
1435
1436                                 /* Scatter Gather Support (drm_scatter.h) */
1437 extern void drm_sg_cleanup(struct drm_sg_mem * entry);
1438 extern int drm_sg_alloc_ioctl(struct drm_device *dev, void *data,
1439                         struct drm_file *file_priv);
1440 extern int drm_sg_alloc(struct drm_device *dev, struct drm_scatter_gather * request);
1441 extern int drm_sg_free(struct drm_device *dev, void *data,
1442                        struct drm_file *file_priv);
1443
1444                                /* ATI PCIGART support (ati_pcigart.h) */
1445 extern int drm_ati_pcigart_init(struct drm_device *dev,
1446                                 struct drm_ati_pcigart_info * gart_info);
1447 extern int drm_ati_pcigart_cleanup(struct drm_device *dev,
1448                                    struct drm_ati_pcigart_info * gart_info);
1449
1450 extern drm_dma_handle_t *drm_pci_alloc(struct drm_device *dev, size_t size,
1451                                        size_t align, dma_addr_t maxaddr);
1452 extern void __drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
1453 extern void drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
1454
1455 /* Graphics Execution Manager library functions (drm_gem.c) */
1456 int drm_gem_init(struct drm_device *dev);
1457 void drm_gem_destroy(struct drm_device *dev);
1458 void drm_gem_object_release(struct drm_gem_object *obj);
1459 void drm_gem_object_free(struct drm_gem_object *obj);
1460 struct drm_gem_object *drm_gem_object_alloc(struct drm_device *dev,
1461                                             size_t size);
1462 int drm_gem_object_init(struct drm_device *dev,
1463                         struct drm_gem_object *obj, size_t size);
1464 int drm_gem_private_object_init(struct drm_device *dev,
1465                         struct drm_gem_object *obj, size_t size);
1466 void drm_gem_object_handle_free(struct drm_gem_object *obj);
1467 int drm_gem_mmap_single(struct drm_device *dev, vm_ooffset_t *offset,
1468     vm_size_t size, struct vm_object **obj_res, int nprot);
1469 void drm_gem_pager_dtr(void *obj);
1470
1471 #include <dev/drm2/drm_global.h>
1472
1473 static inline void
1474 drm_gem_object_reference(struct drm_gem_object *obj)
1475 {
1476
1477         KASSERT(obj->refcount > 0, ("Dangling obj %p", obj));
1478         refcount_acquire(&obj->refcount);
1479 }
1480
1481 static inline void
1482 drm_gem_object_unreference(struct drm_gem_object *obj)
1483 {
1484
1485         if (obj == NULL)
1486                 return;
1487         if (refcount_release(&obj->refcount))
1488                 drm_gem_object_free(obj);
1489 }
1490
1491 static inline void
1492 drm_gem_object_unreference_unlocked(struct drm_gem_object *obj)
1493 {
1494         if (obj != NULL) {
1495                 struct drm_device *dev = obj->dev;
1496                 DRM_LOCK(dev);
1497                 drm_gem_object_unreference(obj);
1498                 DRM_UNLOCK(dev);
1499         }
1500 }
1501
1502 int drm_gem_handle_create(struct drm_file *file_priv,
1503                           struct drm_gem_object *obj,
1504                           u32 *handlep);
1505 int drm_gem_handle_delete(struct drm_file *filp, u32 handle);
1506
1507 static inline void
1508 drm_gem_object_handle_reference(struct drm_gem_object *obj)
1509 {
1510         drm_gem_object_reference(obj);
1511         atomic_inc(&obj->handle_count);
1512 }
1513
1514 static inline void
1515 drm_gem_object_handle_unreference(struct drm_gem_object *obj)
1516 {
1517         if (obj == NULL)
1518                 return;
1519
1520         if (atomic_read(&obj->handle_count) == 0)
1521                 return;
1522         /*
1523          * Must bump handle count first as this may be the last
1524          * ref, in which case the object would disappear before we
1525          * checked for a name
1526          */
1527         if (atomic_dec_and_test(&obj->handle_count))
1528                 drm_gem_object_handle_free(obj);
1529         drm_gem_object_unreference(obj);
1530 }
1531
1532 static inline void
1533 drm_gem_object_handle_unreference_unlocked(struct drm_gem_object *obj)
1534 {
1535         if (obj == NULL)
1536                 return;
1537
1538         if (atomic_read(&obj->handle_count) == 0)
1539                 return;
1540
1541         /*
1542         * Must bump handle count first as this may be the last
1543         * ref, in which case the object would disappear before we
1544         * checked for a name
1545         */
1546
1547         if (atomic_dec_and_test(&obj->handle_count))
1548                 drm_gem_object_handle_free(obj);
1549         drm_gem_object_unreference_unlocked(obj);
1550 }
1551
1552 void drm_gem_free_mmap_offset(struct drm_gem_object *obj);
1553 int drm_gem_create_mmap_offset(struct drm_gem_object *obj);
1554
1555 struct drm_gem_object *drm_gem_object_lookup(struct drm_device *dev,
1556                                              struct drm_file *filp,
1557                                              u32 handle);
1558 int drm_gem_close_ioctl(struct drm_device *dev, void *data,
1559                         struct drm_file *file_priv);
1560 int drm_gem_flink_ioctl(struct drm_device *dev, void *data,
1561                         struct drm_file *file_priv);
1562 int drm_gem_open_ioctl(struct drm_device *dev, void *data,
1563                        struct drm_file *file_priv);
1564 void drm_gem_open(struct drm_device *dev, struct drm_file *file_private);
1565 void drm_gem_release(struct drm_device *dev, struct drm_file *file_private);
1566
1567 extern void drm_core_ioremap(struct drm_local_map *map, struct drm_device *dev);
1568 extern void drm_core_ioremap_wc(struct drm_local_map *map, struct drm_device *dev);
1569 extern void drm_core_ioremapfree(struct drm_local_map *map, struct drm_device *dev);
1570
1571 static __inline__ struct drm_local_map *drm_core_findmap(struct drm_device *dev,
1572                                                          unsigned int token)
1573 {
1574         struct drm_map_list *_entry;
1575         list_for_each_entry(_entry, &dev->maplist, head)
1576             if (_entry->user_token == token)
1577                 return _entry->map;
1578         return NULL;
1579 }
1580
1581 static __inline__ void drm_core_dropmap(struct drm_local_map *map)
1582 {
1583 }
1584
1585 #include <dev/drm2/drm_mem_util.h>
1586
1587 extern int drm_fill_in_dev(struct drm_device *dev,
1588                            struct drm_driver *driver);
1589 extern void drm_cancel_fill_in_dev(struct drm_device *dev);
1590 int drm_get_minor(struct drm_device *dev, struct drm_minor **minor, int type);
1591 /*@}*/
1592
1593 /* PCI section */
1594 int drm_pci_device_is_agp(struct drm_device *dev);
1595 int drm_pci_device_is_pcie(struct drm_device *dev);
1596
1597 extern int drm_get_pci_dev(device_t kdev, struct drm_device *dev,
1598                            struct drm_driver *driver);
1599
1600 #define DRM_PCIE_SPEED_25 1
1601 #define DRM_PCIE_SPEED_50 2
1602 #define DRM_PCIE_SPEED_80 4
1603
1604 extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
1605
1606 #define drm_can_sleep() (DRM_HZ & 1)
1607
1608 /* FreeBSD specific -- should be moved to drm_os_freebsd.h */
1609
1610 #define DRM_GEM_MAPPING_MASK    (3ULL << 62)
1611 #define DRM_GEM_MAPPING_KEY     (2ULL << 62) /* Non-canonical address form */
1612 #define DRM_GEM_MAX_IDX         0x3fffff
1613 #define DRM_GEM_MAPPING_IDX(o)  (((o) >> 40) & DRM_GEM_MAX_IDX)
1614 #define DRM_GEM_MAPPING_OFF(i)  (((uint64_t)(i)) << 40)
1615 #define DRM_GEM_MAPPING_MAPOFF(o) \
1616     ((o) & ~(DRM_GEM_MAPPING_OFF(DRM_GEM_MAX_IDX) | DRM_GEM_MAPPING_KEY))
1617
1618 SYSCTL_DECL(_hw_drm);
1619
1620 #define DRM_DEV_MODE    (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP)
1621 #define DRM_DEV_UID     UID_ROOT
1622 #define DRM_DEV_GID     GID_VIDEO
1623
1624 #define DRM_WAKEUP(w)           wakeup((void *)w)
1625 #define DRM_WAKEUP_INT(w)       wakeup(w)
1626 #define DRM_INIT_WAITQUEUE(queue) do {(void)(queue);} while (0)
1627
1628 #define DRM_CURPROC             curthread
1629 #define DRM_STRUCTPROC          struct thread
1630 #define DRM_SPINTYPE            struct mtx
1631 #define DRM_SPININIT(l,name)    mtx_init(l, name, NULL, MTX_DEF)
1632 #define DRM_SPINUNINIT(l)       mtx_destroy(l)
1633 #define DRM_SPINLOCK(l)         mtx_lock(l)
1634 #define DRM_SPINUNLOCK(u)       mtx_unlock(u)
1635 #define DRM_SPINLOCK_IRQSAVE(l, irqflags) do {          \
1636         mtx_lock(l);                                    \
1637         (void)irqflags;                                 \
1638 } while (0)
1639 #define DRM_SPINUNLOCK_IRQRESTORE(u, irqflags) mtx_unlock(u)
1640 #define DRM_SPINLOCK_ASSERT(l)  mtx_assert(l, MA_OWNED)
1641 #define DRM_LOCK_SLEEP(dev, chan, flags, msg, timeout)                  \
1642     (sx_sleep((chan), &(dev)->dev_struct_lock, (flags), (msg), (timeout)))
1643 #if defined(INVARIANTS)
1644 #define DRM_LOCK_ASSERT(dev)    sx_assert(&(dev)->dev_struct_lock, SA_XLOCKED)
1645 #define DRM_UNLOCK_ASSERT(dev)  sx_assert(&(dev)->dev_struct_lock, SA_UNLOCKED)
1646 #else
1647 #define DRM_LOCK_ASSERT(d)
1648 #define DRM_UNLOCK_ASSERT(d)
1649 #endif
1650
1651 #define DRM_SYSCTL_HANDLER_ARGS (SYSCTL_HANDLER_ARGS)
1652
1653 enum {
1654         DRM_IS_NOT_AGP,
1655         DRM_IS_AGP,
1656         DRM_MIGHT_BE_AGP
1657 };
1658
1659 #define DRM_VERIFYAREA_READ( uaddr, size )              \
1660         (!useracc(__DECONST(caddr_t, uaddr), size, VM_PROT_READ))
1661
1662 #define DRM_COPY_TO_USER(user, kern, size) \
1663         copyout(kern, user, size)
1664 #define DRM_COPY_FROM_USER(kern, user, size) \
1665         copyin(user, kern, size)
1666 #define DRM_COPY_FROM_USER_UNCHECKED(arg1, arg2, arg3)  \
1667         copyin(arg2, arg1, arg3)
1668 #define DRM_COPY_TO_USER_UNCHECKED(arg1, arg2, arg3)    \
1669         copyout(arg2, arg1, arg3)
1670 #define DRM_GET_USER_UNCHECKED(val, uaddr)              \
1671         ((val) = fuword32(uaddr), 0)
1672
1673 #define DRM_GET_PRIV_SAREA(_dev, _ctx, _map) do {       \
1674         (_map) = (_dev)->context_sareas[_ctx];          \
1675 } while(0)
1676
1677 /* Returns -errno to shared code */
1678 #define DRM_WAIT_ON( ret, queue, timeout, condition )           \
1679 for ( ret = 0 ; !ret && !(condition) ; ) {                      \
1680         DRM_UNLOCK(dev);                                        \
1681         mtx_lock(&dev->irq_lock);                               \
1682         if (!(condition))                                       \
1683             ret = -mtx_sleep(&(queue), &dev->irq_lock,          \
1684                 PCATCH, "drmwtq", (timeout));                   \
1685             if (ret == -ERESTART)                               \
1686                 ret = -ERESTARTSYS;                             \
1687         mtx_unlock(&dev->irq_lock);                             \
1688         DRM_LOCK(dev);                                          \
1689 }
1690
1691 #define dev_err(dev, fmt, ...)                                          \
1692         device_printf((dev), "error: " fmt, ## __VA_ARGS__)
1693 #define dev_warn(dev, fmt, ...)                                         \
1694         device_printf((dev), "warning: " fmt, ## __VA_ARGS__)
1695 #define dev_info(dev, fmt, ...)                                         \
1696         device_printf((dev), "info: " fmt, ## __VA_ARGS__)
1697 #define dev_dbg(dev, fmt, ...) do {                                     \
1698         if ((drm_debug& DRM_DEBUGBITS_KMS) != 0) {                      \
1699                 device_printf((dev), "debug: " fmt, ## __VA_ARGS__);    \
1700         }                                                               \
1701 } while (0)
1702
1703 struct drm_msi_blacklist_entry
1704 {
1705         int vendor;
1706         int device;
1707 };
1708
1709 struct drm_vblank_info {
1710         wait_queue_head_t queue;        /* vblank wait queue */
1711         atomic_t count;                 /* number of VBLANK interrupts */
1712                                         /* (driver must alloc the right number of counters) */
1713         atomic_t refcount;              /* number of users of vblank interrupts */
1714         u32 last;                       /* protected by dev->vbl_lock, used */
1715                                         /* for wraparound handling */
1716         int enabled;                    /* so we don't call enable more than */
1717                                         /* once per disable */
1718         int inmodeset;                  /* Display driver is setting mode */
1719 };
1720
1721 #ifndef DMA_BIT_MASK
1722 #define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : (1ULL<<(n)) - 1)
1723 #endif
1724
1725 #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
1726
1727 enum dmi_field {
1728         DMI_NONE,
1729         DMI_BIOS_VENDOR,
1730         DMI_BIOS_VERSION,
1731         DMI_BIOS_DATE,
1732         DMI_SYS_VENDOR,
1733         DMI_PRODUCT_NAME,
1734         DMI_PRODUCT_VERSION,
1735         DMI_PRODUCT_SERIAL,
1736         DMI_PRODUCT_UUID,
1737         DMI_BOARD_VENDOR,
1738         DMI_BOARD_NAME,
1739         DMI_BOARD_VERSION,
1740         DMI_BOARD_SERIAL,
1741         DMI_BOARD_ASSET_TAG,
1742         DMI_CHASSIS_VENDOR,
1743         DMI_CHASSIS_TYPE,
1744         DMI_CHASSIS_VERSION,
1745         DMI_CHASSIS_SERIAL,
1746         DMI_CHASSIS_ASSET_TAG,
1747         DMI_STRING_MAX,
1748 };
1749
1750 struct dmi_strmatch {
1751         unsigned char slot;
1752         char substr[79];
1753 };
1754
1755 struct dmi_system_id {
1756         int (*callback)(const struct dmi_system_id *);
1757         const char *ident;
1758         struct dmi_strmatch matches[4];
1759 };
1760 #define DMI_MATCH(a, b) {(a), (b)}
1761 bool dmi_check_system(const struct dmi_system_id *);
1762
1763 /* Device setup support (drm_drv.c) */
1764 int     drm_probe_helper(device_t kdev, const drm_pci_id_list_t *idlist);
1765 int     drm_attach_helper(device_t kdev, const drm_pci_id_list_t *idlist,
1766             struct drm_driver *driver);
1767 int     drm_generic_suspend(device_t kdev);
1768 int     drm_generic_resume(device_t kdev);
1769 int     drm_generic_detach(device_t kdev);
1770
1771 void drm_event_wakeup(struct drm_pending_event *e);
1772
1773 int drm_add_busid_modesetting(struct drm_device *dev,
1774     struct sysctl_ctx_list *ctx, struct sysctl_oid *top);
1775
1776 /* Buffer management support (drm_bufs.c) */
1777 unsigned long drm_get_resource_start(struct drm_device *dev,
1778                                      unsigned int resource);
1779 unsigned long drm_get_resource_len(struct drm_device *dev,
1780                                    unsigned int resource);
1781
1782 /* IRQ support (drm_irq.c) */
1783 irqreturn_t drm_irq_handler(DRM_IRQ_ARGS);
1784 void    drm_driver_irq_preinstall(struct drm_device *dev);
1785 void    drm_driver_irq_postinstall(struct drm_device *dev);
1786 void    drm_driver_irq_uninstall(struct drm_device *dev);
1787
1788 /* sysctl support (drm_sysctl.h) */
1789 extern int              drm_sysctl_init(struct drm_device *dev);
1790 extern int              drm_sysctl_cleanup(struct drm_device *dev);
1791
1792 int     drm_version(struct drm_device *dev, void *data,
1793                     struct drm_file *file_priv);
1794
1795 /* consistent PCI memory functions (drm_pci.c) */
1796 int     drm_pci_set_busid(struct drm_device *dev, struct drm_master *master);
1797 int     drm_pci_set_unique(struct drm_device *dev, struct drm_master *master,
1798             struct drm_unique *u);
1799 int     drm_pci_agp_init(struct drm_device *dev);
1800 int     drm_pci_enable_msi(struct drm_device *dev);
1801 void    drm_pci_disable_msi(struct drm_device *dev);
1802
1803 struct ttm_bo_device;
1804 int ttm_bo_mmap_single(struct ttm_bo_device *bdev, vm_ooffset_t *offset,
1805     vm_size_t size, struct vm_object **obj_res, int nprot);
1806 struct ttm_buffer_object;
1807 void ttm_bo_release_mmap(struct ttm_buffer_object *bo);
1808
1809 #endif                          /* __KERNEL__ */
1810 #endif