include/drm/drmP.h

   1 /**
   2  * \file drmP.h
   3  * Private header for Direct Rendering Manager
   4  *
   5  * \author Rickard E. (Rik) Faith <faith@valinux.com>
   6  * \author Gareth Hughes <gareth@valinux.com>
   7  */
   8
   9 /*
  10  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
  11  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
  12  * Copyright (c) 2009-2010, Code Aurora Forum.
  13  * All rights reserved.
  14  *
  15  * Permission is hereby granted, free of charge, to any person obtaining a
  16  * copy of this software and associated documentation files (the "Software"),
  17  * to deal in the Software without restriction, including without limitation
  18  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  19  * and/or sell copies of the Software, and to permit persons to whom the
  20  * Software is furnished to do so, subject to the following conditions:
  21  *
  22  * The above copyright notice and this permission notice (including the next
  23  * paragraph) shall be included in all copies or substantial portions of the
  24  * Software.
  25  *
  26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  27  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  28  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  29  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  30  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  31  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  32  * OTHER DEALINGS IN THE SOFTWARE.
  33  */
  34
  35 #ifndef _DRM_P_H_
  36 #define _DRM_P_H_
  37
  38 #ifdef __KERNEL__
  39 #ifdef __alpha__
  40 /* add include of current.h so that "current" is defined
  41  * before static inline funcs in wait.h. Doing this so we
  42  * can build the DRM (part of PI DRI). 4/21/2000 S + B */
  43 #include <asm/current.h>
  44 #endif                          /* __alpha__ */
  45 #include <linux/kernel.h>
  46 #include <linux/miscdevice.h>
  47 #include <linux/fs.h>
  48 #include <linux/init.h>
  49 #include <linux/file.h>
  50 #include <linux/platform_device.h>
  51 #include <linux/pci.h>
  52 #include <linux/jiffies.h>
  53 #include <linux/dma-mapping.h>
  54 #include <linux/mm.h>
  55 #include <linux/cdev.h>
  56 #include <linux/mutex.h>
  57 #include <linux/io.h>
  58 #include <linux/slab.h>
  59 #if defined(__alpha__) || defined(__powerpc__)
  60 #include <asm/pgtable.h>        /* For pte_wrprotect */
  61 #endif
  62 #include <asm/mman.h>
  63 #include <asm/uaccess.h>
  64 #include <linux/types.h>
  65 #include <linux/agp_backend.h>
  66 #include <linux/workqueue.h>
  67 #include <linux/poll.h>
  68 #include <asm/pgalloc.h>
  69 #include <drm/drm.h>
  70 #include <drm/drm_sarea.h>
  71 #include <drm/drm_vma_manager.h>
  72
  73 #include <linux/idr.h>
  74
  75 #define __OS_HAS_AGP (defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE)))
  76
  77 struct module;
  78
  79 struct drm_file;
  80 struct drm_device;
  81
  82 struct device_node;
  83 struct videomode;
  84
  85 #include <drm/drm_os_linux.h>
  86 #include <drm/drm_hashtab.h>
  87 #include <drm/drm_mm.h>
  88
  89 #define DRM_UT_CORE             0x01
  90 #define DRM_UT_DRIVER           0x02
  91 #define DRM_UT_KMS              0x04
  92 #define DRM_UT_PRIME            0x08
  93 /*
  94  * Three debug levels are defined.
  95  * drm_core, drm_driver, drm_kms
  96  * drm_core level can be used in the generic drm code. For example:
  97  *      drm_ioctl, drm_mm, drm_memory
  98  * The macro definition of DRM_DEBUG is used.
  99  *      DRM_DEBUG(fmt, args...)
 100  *      The debug info by using the DRM_DEBUG can be obtained by adding
 101  *      the boot option of "drm.debug=1".
 102  *
 103  * drm_driver level can be used in the specific drm driver. It is used
 104  * to add the debug info related with the drm driver. For example:
 105  * i915_drv, i915_dma, i915_gem, radeon_drv,
 106  *      The macro definition of DRM_DEBUG_DRIVER can be used.
 107  *      DRM_DEBUG_DRIVER(fmt, args...)
 108  *      The debug info by using the DRM_DEBUG_DRIVER can be obtained by
 109  *      adding the boot option of "drm.debug=0x02"
 110  *
 111  * drm_kms level can be used in the KMS code related with specific drm driver.
 112  * It is used to add the debug info related with KMS mode. For example:
 113  * the connector/crtc ,
 114  *      The macro definition of DRM_DEBUG_KMS can be used.
 115  *      DRM_DEBUG_KMS(fmt, args...)
 116  *      The debug info by using the DRM_DEBUG_KMS can be obtained by
 117  *      adding the boot option of "drm.debug=0x04"
 118  *
 119  * If we add the boot option of "drm.debug=0x06", we can get the debug info by
 120  * using the DRM_DEBUG_KMS and DRM_DEBUG_DRIVER.
 121  * If we add the boot option of "drm.debug=0x05", we can get the debug info by
 122  * using the DRM_DEBUG_KMS and DRM_DEBUG.
 123  */
 124
 125 extern __printf(4, 5)
 126 void drm_ut_debug_printk(unsigned int request_level,
 127                          const char *prefix,
 128                          const char *function_name,
 129                          const char *format, ...);
 130 extern __printf(2, 3)
 131 int drm_err(const char *func, const char *format, ...);
 132
 133 /***********************************************************************/
 134 /** \name DRM template customization defaults */
 135 /*@{*/
 136
 137 /* driver capabilities and requirements mask */
 138 #define DRIVER_USE_AGP     0x1
 139 #define DRIVER_REQUIRE_AGP 0x2
 140 #define DRIVER_PCI_DMA     0x8
 141 #define DRIVER_SG          0x10
 142 #define DRIVER_HAVE_DMA    0x20
 143 #define DRIVER_HAVE_IRQ    0x40
 144 #define DRIVER_IRQ_SHARED  0x80
 145 #define DRIVER_GEM         0x1000
 146 #define DRIVER_MODESET     0x2000
 147 #define DRIVER_PRIME       0x4000
 148 #define DRIVER_RENDER      0x8000
 149
 150 #define DRIVER_BUS_PCI 0x1
 151 #define DRIVER_BUS_PLATFORM 0x2
 152 #define DRIVER_BUS_USB 0x3
 153
 154 /***********************************************************************/
 155 /** \name Begin the DRM... */
 156 /*@{*/
 157
 158 #define DRM_DEBUG_CODE 2          /**< Include debugging code if > 1, then
 159                                      also include looping detection. */
 160
 161 #define DRM_MAGIC_HASH_ORDER  4  /**< Size of key hash table. Must be power of 2. */
 162 #define DRM_KERNEL_CONTEXT    0  /**< Change drm_resctx if changed */
 163 #define DRM_RESERVED_CONTEXTS 1  /**< Change drm_resctx if changed */
 164
 165 #define DRM_MAP_HASH_OFFSET 0x10000000
 166
 167 /*@}*/
 168
 169 /***********************************************************************/
 170 /** \name Macros to make printk easier */
 171 /*@{*/
 172
 173 /**
 174  * Error output.
 175  *
 176  * \param fmt printf() like format string.
 177  * \param arg arguments
 178  */
 179 #define DRM_ERROR(fmt, ...)                             \
 180         drm_err(__func__, fmt, ##__VA_ARGS__)
 181
 182 #define DRM_INFO(fmt, ...)                              \
 183         printk(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
 184
 185 /**
 186  * Debug output.
 187  *
 188  * \param fmt printf() like format string.
 189  * \param arg arguments
 190  */
 191 #if DRM_DEBUG_CODE
 192 #define DRM_DEBUG(fmt, args...)                                         \
 193         do {                                                            \
 194                 drm_ut_debug_printk(DRM_UT_CORE, DRM_NAME,              \
 195                                         __func__, fmt, ##args);         \
 196         } while (0)
 197
 198 #define DRM_DEBUG_DRIVER(fmt, args...)                                  \
 199         do {                                                            \
 200                 drm_ut_debug_printk(DRM_UT_DRIVER, DRM_NAME,            \
 201                                         __func__, fmt, ##args);         \
 202         } while (0)
 203 #define DRM_DEBUG_KMS(fmt, args...)                             \
 204         do {                                                            \
 205                 drm_ut_debug_printk(DRM_UT_KMS, DRM_NAME,               \
 206                                          __func__, fmt, ##args);        \
 207         } while (0)
 208 #define DRM_DEBUG_PRIME(fmt, args...)                                   \
 209         do {                                                            \
 210                 drm_ut_debug_printk(DRM_UT_PRIME, DRM_NAME,             \
 211                                         __func__, fmt, ##args);         \
 212         } while (0)
 213 #define DRM_LOG(fmt, args...)                                           \
 214         do {                                                            \
 215                 drm_ut_debug_printk(DRM_UT_CORE, NULL,                  \
 216                                         NULL, fmt, ##args);             \
 217         } while (0)
 218 #define DRM_LOG_KMS(fmt, args...)                                       \
 219         do {                                                            \
 220                 drm_ut_debug_printk(DRM_UT_KMS, NULL,                   \
 221                                         NULL, fmt, ##args);             \
 222         } while (0)
 223 #define DRM_LOG_MODE(fmt, args...)                                      \
 224         do {                                                            \
 225                 drm_ut_debug_printk(DRM_UT_MODE, NULL,                  \
 226                                         NULL, fmt, ##args);             \
 227         } while (0)
 228 #define DRM_LOG_DRIVER(fmt, args...)                                    \
 229         do {                                                            \
 230                 drm_ut_debug_printk(DRM_UT_DRIVER, NULL,                \
 231                                         NULL, fmt, ##args);             \
 232         } while (0)
 233 #else
 234 #define DRM_DEBUG_DRIVER(fmt, args...) do { } while (0)
 235 #define DRM_DEBUG_KMS(fmt, args...)     do { } while (0)
 236 #define DRM_DEBUG_PRIME(fmt, args...)   do { } while (0)
 237 #define DRM_DEBUG(fmt, arg...)           do { } while (0)
 238 #define DRM_LOG(fmt, arg...)            do { } while (0)
 239 #define DRM_LOG_KMS(fmt, args...) do { } while (0)
 240 #define DRM_LOG_MODE(fmt, arg...) do { } while (0)
 241 #define DRM_LOG_DRIVER(fmt, arg...) do { } while (0)
 242
 243 #endif
 244
 245 /*@}*/
 246
 247 /***********************************************************************/
 248 /** \name Internal types and structures */
 249 /*@{*/
 250
 251 #define DRM_ARRAY_SIZE(x) ARRAY_SIZE(x)
 252
 253 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
 254
 255 /**
 256  * Test that the hardware lock is held by the caller, returning otherwise.
 257  *
 258  * \param dev DRM device.
 259  * \param filp file pointer of the caller.
 260  */
 261 #define LOCK_TEST_WITH_RETURN( dev, _file_priv )                                \
 262 do {                                                                            \
 263         if (!_DRM_LOCK_IS_HELD(_file_priv->master->lock.hw_lock->lock) ||       \
 264             _file_priv->master->lock.file_priv != _file_priv)   {               \
 265                 DRM_ERROR( "%s called without lock held, held  %d owner %p %p\n",\
 266                            __func__, _DRM_LOCK_IS_HELD(_file_priv->master->lock.hw_lock->lock),\
 267                            _file_priv->master->lock.file_priv, _file_priv);     \
 268                 return -EINVAL;                                                 \
 269         }                                                                       \
 270 } while (0)
 271
 272 /**
 273  * Ioctl function type.
 274  *
 275  * \param inode device inode.
 276  * \param file_priv DRM file private pointer.
 277  * \param cmd command.
 278  * \param arg argument.
 279  */
 280 typedef int drm_ioctl_t(struct drm_device *dev, void *data,
 281                         struct drm_file *file_priv);
 282
 283 typedef int drm_ioctl_compat_t(struct file *filp, unsigned int cmd,
 284                                unsigned long arg);
 285
 286 #define DRM_IOCTL_NR(n)                _IOC_NR(n)
 287 #define DRM_MAJOR       226
 288
 289 #define DRM_AUTH        0x1
 290 #define DRM_MASTER      0x2
 291 #define DRM_ROOT_ONLY   0x4
 292 #define DRM_CONTROL_ALLOW 0x8
 293 #define DRM_UNLOCKED    0x10
 294 #define DRM_RENDER_ALLOW 0x20
 295
 296 struct drm_ioctl_desc {
 297         unsigned int cmd;
 298         int flags;
 299         drm_ioctl_t *func;
 300         unsigned int cmd_drv;
 301         const char *name;
 302 };
 303
 304 /**
 305  * Creates a driver or general drm_ioctl_desc array entry for the given
 306  * ioctl, for use by drm_ioctl().
 307  */
 308
 309 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags)                 \
 310         [DRM_IOCTL_NR(DRM_##ioctl)] = {.cmd = DRM_##ioctl, .func = _func, .flags = _flags, .cmd_drv = DRM_IOCTL_##ioctl, .name = #ioctl}
 311
 312 struct drm_magic_entry {
 313         struct list_head head;
 314         struct drm_hash_item hash_item;
 315         struct drm_file *priv;
 316 };
 317
 318 struct drm_vma_entry {
 319         struct list_head head;
 320         struct vm_area_struct *vma;
 321         pid_t pid;
 322 };
 323
 324 /**
 325  * DMA buffer.
 326  */
 327 struct drm_buf {
 328         int idx;                       /**< Index into master buflist */
 329         int total;                     /**< Buffer size */
 330         int order;                     /**< log-base-2(total) */
 331         int used;                      /**< Amount of buffer in use (for DMA) */
 332         unsigned long offset;          /**< Byte offset (used internally) */
 333         void *address;                 /**< Address of buffer */
 334         unsigned long bus_address;     /**< Bus address of buffer */
 335         struct drm_buf *next;          /**< Kernel-only: used for free list */
 336         __volatile__ int waiting;      /**< On kernel DMA queue */
 337         __volatile__ int pending;      /**< On hardware DMA queue */
 338         struct drm_file *file_priv;    /**< Private of holding file descr */
 339         int context;                   /**< Kernel queue for this buffer */
 340         int while_locked;              /**< Dispatch this buffer while locked */
 341         enum {
 342                 DRM_LIST_NONE = 0,
 343                 DRM_LIST_FREE = 1,
 344                 DRM_LIST_WAIT = 2,
 345                 DRM_LIST_PEND = 3,
 346                 DRM_LIST_PRIO = 4,
 347                 DRM_LIST_RECLAIM = 5
 348         } list;                        /**< Which list we're on */
 349
 350         int dev_priv_size;               /**< Size of buffer private storage */
 351         void *dev_private;               /**< Per-buffer private storage */
 352 };
 353
 354 /** bufs is one longer than it has to be */
 355 struct drm_waitlist {
 356         int count;                      /**< Number of possible buffers */
 357         struct drm_buf **bufs;          /**< List of pointers to buffers */
 358         struct drm_buf **rp;                    /**< Read pointer */
 359         struct drm_buf **wp;                    /**< Write pointer */
 360         struct drm_buf **end;           /**< End pointer */
 361         spinlock_t read_lock;
 362         spinlock_t write_lock;
 363 };
 364
 365 struct drm_freelist {
 366         int initialized;               /**< Freelist in use */
 367         atomic_t count;                /**< Number of free buffers */
 368         struct drm_buf *next;          /**< End pointer */
 369
 370         wait_queue_head_t waiting;     /**< Processes waiting on free bufs */
 371         int low_mark;                  /**< Low water mark */
 372         int high_mark;                 /**< High water mark */
 373         atomic_t wfh;                  /**< If waiting for high mark */
 374         spinlock_t lock;
 375 };
 376
 377 typedef struct drm_dma_handle {
 378         dma_addr_t busaddr;
 379         void *vaddr;
 380         size_t size;
 381 } drm_dma_handle_t;
 382
 383 /**
 384  * Buffer entry.  There is one of this for each buffer size order.
 385  */
 386 struct drm_buf_entry {
 387         int buf_size;                   /**< size */
 388         int buf_count;                  /**< number of buffers */
 389         struct drm_buf *buflist;                /**< buffer list */
 390         int seg_count;
 391         int page_order;
 392         struct drm_dma_handle **seglist;
 393
 394         struct drm_freelist freelist;
 395 };
 396
 397 /* Event queued up for userspace to read */
 398 struct drm_pending_event {
 399         struct drm_event *event;
 400         struct list_head link;
 401         struct drm_file *file_priv;
 402         pid_t pid; /* pid of requester, no guarantee it's valid by the time
 403                       we deliver the event, for tracing only */
 404         void (*destroy)(struct drm_pending_event *event);
 405 };
 406
 407 /* initial implementaton using a linked list - todo hashtab */
 408 struct drm_prime_file_private {
 409         struct list_head head;
 410         struct mutex lock;
 411 };
 412
 413 /** File private data */
 414 struct drm_file {
 415         int authenticated;
 416         struct pid *pid;
 417         kuid_t uid;
 418         drm_magic_t magic;
 419         unsigned long ioctl_count;
 420         struct list_head lhead;
 421         struct drm_minor *minor;
 422         unsigned long lock_count;
 423
 424         /** Mapping of mm object handles to object pointers. */
 425         struct idr object_idr;
 426         /** Lock for synchronization of access to object_idr. */
 427         spinlock_t table_lock;
 428
 429         struct file *filp;
 430         void *driver_priv;
 431
 432         int is_master; /* this file private is a master for a minor */
 433         struct drm_master *master; /* master this node is currently associated with
 434                                       N.B. not always minor->master */
 435
 436         /**
 437          * fbs - List of framebuffers associated with this file.
 438          *
 439          * Protected by fbs_lock. Note that the fbs list holds a reference on
 440          * the fb object to prevent it from untimely disappearing.
 441          */
 442         struct list_head fbs;
 443         struct mutex fbs_lock;
 444
 445         wait_queue_head_t event_wait;
 446         struct list_head event_list;
 447         int event_space;
 448
 449         struct drm_prime_file_private prime;
 450 };
 451
 452 /** Wait queue */
 453 struct drm_queue {
 454         atomic_t use_count;             /**< Outstanding uses (+1) */
 455         atomic_t finalization;          /**< Finalization in progress */
 456         atomic_t block_count;           /**< Count of processes waiting */
 457         atomic_t block_read;            /**< Queue blocked for reads */
 458         wait_queue_head_t read_queue;   /**< Processes waiting on block_read */
 459         atomic_t block_write;           /**< Queue blocked for writes */
 460         wait_queue_head_t write_queue;  /**< Processes waiting on block_write */
 461         atomic_t total_queued;          /**< Total queued statistic */
 462         atomic_t total_flushed;         /**< Total flushes statistic */
 463         atomic_t total_locks;           /**< Total locks statistics */
 464         enum drm_ctx_flags flags;       /**< Context preserving and 2D-only */
 465         struct drm_waitlist waitlist;   /**< Pending buffers */
 466         wait_queue_head_t flush_queue;  /**< Processes waiting until flush */
 467 };
 468
 469 /**
 470  * Lock data.
 471  */
 472 struct drm_lock_data {
 473         struct drm_hw_lock *hw_lock;    /**< Hardware lock */
 474         /** Private of lock holder's file (NULL=kernel) */
 475         struct drm_file *file_priv;
 476         wait_queue_head_t lock_queue;   /**< Queue of blocked processes */
 477         unsigned long lock_time;        /**< Time of last lock in jiffies */
 478         spinlock_t spinlock;
 479         uint32_t kernel_waiters;
 480         uint32_t user_waiters;
 481         int idle_has_lock;
 482 };
 483
 484 /**
 485  * DMA data.
 486  */
 487 struct drm_device_dma {
 488
 489         struct drm_buf_entry bufs[DRM_MAX_ORDER + 1];   /**< buffers, grouped by their size order */
 490         int buf_count;                  /**< total number of buffers */
 491         struct drm_buf **buflist;               /**< Vector of pointers into drm_device_dma::bufs */
 492         int seg_count;
 493         int page_count;                 /**< number of pages */
 494         unsigned long *pagelist;        /**< page list */
 495         unsigned long byte_count;
 496         enum {
 497                 _DRM_DMA_USE_AGP = 0x01,
 498                 _DRM_DMA_USE_SG = 0x02,
 499                 _DRM_DMA_USE_FB = 0x04,
 500                 _DRM_DMA_USE_PCI_RO = 0x08
 501         } flags;
 502
 503 };
 504
 505 /**
 506  * AGP memory entry.  Stored as a doubly linked list.
 507  */
 508 struct drm_agp_mem {
 509         unsigned long handle;           /**< handle */
 510         DRM_AGP_MEM *memory;
 511         unsigned long bound;            /**< address */
 512         int pages;
 513         struct list_head head;
 514 };
 515
 516 /**
 517  * AGP data.
 518  *
 519  * \sa drm_agp_init() and drm_device::agp.
 520  */
 521 struct drm_agp_head {
 522         DRM_AGP_KERN agp_info;          /**< AGP device information */
 523         struct list_head memory;
 524         unsigned long mode;             /**< AGP mode */
 525         struct agp_bridge_data *bridge;
 526         int enabled;                    /**< whether the AGP bus as been enabled */
 527         int acquired;                   /**< whether the AGP device has been acquired */
 528         unsigned long base;
 529         int agp_mtrr;
 530         int cant_use_aperture;
 531         unsigned long page_mask;
 532 };
 533
 534 /**
 535  * Scatter-gather memory.
 536  */
 537 struct drm_sg_mem {
 538         unsigned long handle;
 539         void *virtual;
 540         int pages;
 541         struct page **pagelist;
 542         dma_addr_t *busaddr;
 543 };
 544
 545 struct drm_sigdata {
 546         int context;
 547         struct drm_hw_lock *lock;
 548 };
 549
 550
 551 /**
 552  * Kernel side of a mapping
 553  */
 554 struct drm_local_map {
 555         resource_size_t offset;  /**< Requested physical address (0 for SAREA)*/
 556         unsigned long size;      /**< Requested physical size (bytes) */
 557         enum drm_map_type type;  /**< Type of memory to map */
 558         enum drm_map_flags flags;        /**< Flags */
 559         void *handle;            /**< User-space: "Handle" to pass to mmap() */
 560                                  /**< Kernel-space: kernel-virtual address */
 561         int mtrr;                /**< MTRR slot used */
 562 };
 563
 564 typedef struct drm_local_map drm_local_map_t;
 565
 566 /**
 567  * Mappings list
 568  */
 569 struct drm_map_list {
 570         struct list_head head;          /**< list head */
 571         struct drm_hash_item hash;
 572         struct drm_local_map *map;      /**< mapping */
 573         uint64_t user_token;
 574         struct drm_master *master;
 575 };
 576
 577 /**
 578  * Context handle list
 579  */
 580 struct drm_ctx_list {
 581         struct list_head head;          /**< list head */
 582         drm_context_t handle;           /**< context handle */
 583         struct drm_file *tag;           /**< associated fd private data */
 584 };
 585
 586 /* location of GART table */
 587 #define DRM_ATI_GART_MAIN 1
 588 #define DRM_ATI_GART_FB   2
 589
 590 #define DRM_ATI_GART_PCI 1
 591 #define DRM_ATI_GART_PCIE 2
 592 #define DRM_ATI_GART_IGP 3
 593
 594 struct drm_ati_pcigart_info {
 595         int gart_table_location;
 596         int gart_reg_if;
 597         void *addr;
 598         dma_addr_t bus_addr;
 599         dma_addr_t table_mask;
 600         struct drm_dma_handle *table_handle;
 601         struct drm_local_map mapping;
 602         int table_size;
 603 };
 604
 605 /**
 606  * GEM specific mm private for tracking GEM objects
 607  */
 608 struct drm_gem_mm {
 609         struct drm_vma_offset_manager vma_manager;
 610 };
 611
 612 /**
 613  * This structure defines the drm_mm memory object, which will be used by the
 614  * DRM for its buffer objects.
 615  */
 616 struct drm_gem_object {
 617         /** Reference count of this object */
 618         struct kref refcount;
 619
 620         /**
 621          * handle_count - gem file_priv handle count of this object
 622          *
 623          * Each handle also holds a reference. Note that when the handle_count
 624          * drops to 0 any global names (e.g. the id in the flink namespace) will
 625          * be cleared.
 626          *
 627          * Protected by dev->object_name_lock.
 628          * */
 629         unsigned handle_count;
 630
 631         /** Related drm device */
 632         struct drm_device *dev;
 633
 634         /** File representing the shmem storage */
 635         struct file *filp;
 636
 637         /* Mapping info for this object */
 638         struct drm_vma_offset_node vma_node;
 639
 640         /**
 641          * Size of the object, in bytes.  Immutable over the object's
 642          * lifetime.
 643          */
 644         size_t size;
 645
 646         /**
 647          * Global name for this object, starts at 1. 0 means unnamed.
 648          * Access is covered by the object_name_lock in the related drm_device
 649          */
 650         int name;
 651
 652         /**
 653          * Memory domains. These monitor which caches contain read/write data
 654          * related to the object. When transitioning from one set of domains
 655          * to another, the driver is called to ensure that caches are suitably
 656          * flushed and invalidated
 657          */
 658         uint32_t read_domains;
 659         uint32_t write_domain;
 660
 661         /**
 662          * While validating an exec operation, the
 663          * new read/write domain values are computed here.
 664          * They will be transferred to the above values
 665          * at the point that any cache flushing occurs
 666          */
 667         uint32_t pending_read_domains;
 668         uint32_t pending_write_domain;
 669
 670         /**
 671          * dma_buf - dma buf associated with this GEM object
 672          *
 673          * Pointer to the dma-buf associated with this gem object (either
 674          * through importing or exporting). We break the resulting reference
 675          * loop when the last gem handle for this object is released.
 676          *
 677          * Protected by obj->object_name_lock
 678          */
 679         struct dma_buf *dma_buf;
 680
 681         /**
 682          * import_attach - dma buf attachment backing this object
 683          *
 684          * Any foreign dma_buf imported as a gem object has this set to the
 685          * attachment point for the device. This is invariant over the lifetime
 686          * of a gem object.
 687          *
 688          * The driver's ->gem_free_object callback is responsible for cleaning
 689          * up the dma_buf attachment and references acquired at import time.
 690          *
 691          * Note that the drm gem/prime core does not depend upon drivers setting
 692          * this field any more. So for drivers where this doesn't make sense
 693          * (e.g. virtual devices or a displaylink behind an usb bus) they can
 694          * simply leave it as NULL.
 695          */
 696         struct dma_buf_attachment *import_attach;
 697 };
 698
 699 #include <drm/drm_crtc.h>
 700
 701 /* per-master structure */
 702 struct drm_master {
 703
 704         struct kref refcount; /* refcount for this master */
 705
 706         struct list_head head; /**< each minor contains a list of masters */
 707         struct drm_minor *minor; /**< link back to minor we are a master for */
 708
 709         char *unique;                   /**< Unique identifier: e.g., busid */
 710         int unique_len;                 /**< Length of unique field */
 711         int unique_size;                /**< amount allocated */
 712
 713         int blocked;                    /**< Blocked due to VC switch? */
 714
 715         /** \name Authentication */
 716         /*@{ */
 717         struct drm_open_hash magiclist;
 718         struct list_head magicfree;
 719         /*@} */
 720
 721         struct drm_lock_data lock;      /**< Information on hardware lock */
 722
 723         void *driver_priv; /**< Private structure for driver to use */
 724 };
 725
 726 /* Size of ringbuffer for vblank timestamps. Just double-buffer
 727  * in initial implementation.
 728  */
 729 #define DRM_VBLANKTIME_RBSIZE 2
 730
 731 /* Flags and return codes for get_vblank_timestamp() driver function. */
 732 #define DRM_CALLED_FROM_VBLIRQ 1
 733 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
 734 #define DRM_VBLANKTIME_INVBL             (1 << 1)
 735
 736 /* get_scanout_position() return flags */
 737 #define DRM_SCANOUTPOS_VALID        (1 << 0)
 738 #define DRM_SCANOUTPOS_INVBL        (1 << 1)
 739 #define DRM_SCANOUTPOS_ACCURATE     (1 << 2)
 740
 741 struct drm_bus {
 742         int bus_type;
 743         int (*get_irq)(struct drm_device *dev);
 744         const char *(*get_name)(struct drm_device *dev);
 745         int (*set_busid)(struct drm_device *dev, struct drm_master *master);
 746         int (*set_unique)(struct drm_device *dev, struct drm_master *master,
 747                           struct drm_unique *unique);
 748         int (*irq_by_busid)(struct drm_device *dev, struct drm_irq_busid *p);
 749         /* hooks that are for PCI */
 750         int (*agp_init)(struct drm_device *dev);
 751         void (*agp_destroy)(struct drm_device *dev);
 752
 753 };
 754
 755 /**
 756  * DRM driver structure. This structure represent the common code for
 757  * a family of cards. There will one drm_device for each card present
 758  * in this family
 759  */
 760 struct drm_driver {
 761         int (*load) (struct drm_device *, unsigned long flags);
 762         int (*firstopen) (struct drm_device *);
 763         int (*open) (struct drm_device *, struct drm_file *);
 764         void (*preclose) (struct drm_device *, struct drm_file *file_priv);
 765         void (*postclose) (struct drm_device *, struct drm_file *);
 766         void (*lastclose) (struct drm_device *);
 767         int (*unload) (struct drm_device *);
 768         int (*suspend) (struct drm_device *, pm_message_t state);
 769         int (*resume) (struct drm_device *);
 770         int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
 771         int (*dma_quiescent) (struct drm_device *);
 772         int (*context_dtor) (struct drm_device *dev, int context);
 773
 774         /**
 775          * get_vblank_counter - get raw hardware vblank counter
 776          * @dev: DRM device
 777          * @crtc: counter to fetch
 778          *
 779          * Driver callback for fetching a raw hardware vblank counter for @crtc.
 780          * If a device doesn't have a hardware counter, the driver can simply
 781          * return the value of drm_vblank_count. The DRM core will account for
 782          * missed vblank events while interrupts where disabled based on system
 783          * timestamps.
 784          *
 785          * Wraparound handling and loss of events due to modesetting is dealt
 786          * with in the DRM core code.
 787          *
 788          * RETURNS
 789          * Raw vblank counter value.
 790          */
 791         u32 (*get_vblank_counter) (struct drm_device *dev, int crtc);
 792
 793         /**
 794          * enable_vblank - enable vblank interrupt events
 795          * @dev: DRM device
 796          * @crtc: which irq to enable
 797          *
 798          * Enable vblank interrupts for @crtc.  If the device doesn't have
 799          * a hardware vblank counter, this routine should be a no-op, since
 800          * interrupts will have to stay on to keep the count accurate.
 801          *
 802          * RETURNS
 803          * Zero on success, appropriate errno if the given @crtc's vblank
 804          * interrupt cannot be enabled.
 805          */
 806         int (*enable_vblank) (struct drm_device *dev, int crtc);
 807
 808         /**
 809          * disable_vblank - disable vblank interrupt events
 810          * @dev: DRM device
 811          * @crtc: which irq to enable
 812          *
 813          * Disable vblank interrupts for @crtc.  If the device doesn't have
 814          * a hardware vblank counter, this routine should be a no-op, since
 815          * interrupts will have to stay on to keep the count accurate.
 816          */
 817         void (*disable_vblank) (struct drm_device *dev, int crtc);
 818
 819         /**
 820          * Called by \c drm_device_is_agp.  Typically used to determine if a
 821          * card is really attached to AGP or not.
 822          *
 823          * \param dev  DRM device handle
 824          *
 825          * \returns
 826          * One of three values is returned depending on whether or not the
 827          * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
 828          * (return of 1), or may or may not be AGP (return of 2).
 829          */
 830         int (*device_is_agp) (struct drm_device *dev);
 831
 832         /**
 833          * Called by vblank timestamping code.
 834          *
 835          * Return the current display scanout position from a crtc.
 836          *
 837          * \param dev  DRM device.
 838          * \param crtc Id of the crtc to query.
 839          * \param *vpos Target location for current vertical scanout position.
 840          * \param *hpos Target location for current horizontal scanout position.
 841          *
 842          * Returns vpos as a positive number while in active scanout area.
 843          * Returns vpos as a negative number inside vblank, counting the number
 844          * of scanlines to go until end of vblank, e.g., -1 means "one scanline
 845          * until start of active scanout / end of vblank."
 846          *
 847          * \return Flags, or'ed together as follows:
 848          *
 849          * DRM_SCANOUTPOS_VALID = Query successful.
 850          * DRM_SCANOUTPOS_INVBL = Inside vblank.
 851          * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
 852          * this flag means that returned position may be offset by a constant
 853          * but unknown small number of scanlines wrt. real scanout position.
 854          *
 855          */
 856         int (*get_scanout_position) (struct drm_device *dev, int crtc,
 857                                      int *vpos, int *hpos);
 858
 859         /**
 860          * Called by \c drm_get_last_vbltimestamp. Should return a precise
 861          * timestamp when the most recent VBLANK interval ended or will end.
 862          *
 863          * Specifically, the timestamp in @vblank_time should correspond as
 864          * closely as possible to the time when the first video scanline of
 865          * the video frame after the end of VBLANK will start scanning out,
 866          * the time immediately after end of the VBLANK interval. If the
 867          * @crtc is currently inside VBLANK, this will be a time in the future.
 868          * If the @crtc is currently scanning out a frame, this will be the
 869          * past start time of the current scanout. This is meant to adhere
 870          * to the OpenML OML_sync_control extension specification.
 871          *
 872          * \param dev dev DRM device handle.
 873          * \param crtc crtc for which timestamp should be returned.
 874          * \param *max_error Maximum allowable timestamp error in nanoseconds.
 875          *                   Implementation should strive to provide timestamp
 876          *                   with an error of at most *max_error nanoseconds.
 877          *                   Returns true upper bound on error for timestamp.
 878          * \param *vblank_time Target location for returned vblank timestamp.
 879          * \param flags 0 = Defaults, no special treatment needed.
 880          * \param       DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
 881          *              irq handler. Some drivers need to apply some workarounds
 882          *              for gpu-specific vblank irq quirks if flag is set.
 883          *
 884          * \returns
 885          * Zero if timestamping isn't supported in current display mode or a
 886          * negative number on failure. A positive status code on success,
 887          * which describes how the vblank_time timestamp was computed.
 888          */
 889         int (*get_vblank_timestamp) (struct drm_device *dev, int crtc,
 890                                      int *max_error,
 891                                      struct timeval *vblank_time,
 892                                      unsigned flags);
 893
 894         /* these have to be filled in */
 895
 896         irqreturn_t(*irq_handler) (DRM_IRQ_ARGS);
 897         void (*irq_preinstall) (struct drm_device *dev);
 898         int (*irq_postinstall) (struct drm_device *dev);
 899         void (*irq_uninstall) (struct drm_device *dev);
 900
 901         /* Master routines */
 902         int (*master_create)(struct drm_device *dev, struct drm_master *master);
 903         void (*master_destroy)(struct drm_device *dev, struct drm_master *master);
 904         /**
 905          * master_set is called whenever the minor master is set.
 906          * master_drop is called whenever the minor master is dropped.
 907          */
 908
 909         int (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
 910                           bool from_open);
 911         void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv,
 912                             bool from_release);
 913
 914         int (*debugfs_init)(struct drm_minor *minor);
 915         void (*debugfs_cleanup)(struct drm_minor *minor);
 916
 917         /**
 918          * Driver-specific constructor for drm_gem_objects, to set up
 919          * obj->driver_private.
 920          *
 921          * Returns 0 on success.
 922          */
 923         void (*gem_free_object) (struct drm_gem_object *obj);
 924         int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
 925         void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
 926
 927         /* prime: */
 928         /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */
 929         int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
 930                                 uint32_t handle, uint32_t flags, int *prime_fd);
 931         /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */
 932         int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
 933                                 int prime_fd, uint32_t *handle);
 934         /* export GEM -> dmabuf */
 935         struct dma_buf * (*gem_prime_export)(struct drm_device *dev,
 936                                 struct drm_gem_object *obj, int flags);
 937         /* import dmabuf -> GEM */
 938         struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
 939                                 struct dma_buf *dma_buf);
 940         /* low-level interface used by drm_gem_prime_{import,export} */
 941         int (*gem_prime_pin)(struct drm_gem_object *obj);
 942         void (*gem_prime_unpin)(struct drm_gem_object *obj);
 943         struct sg_table *(*gem_prime_get_sg_table)(struct drm_gem_object *obj);
 944         struct drm_gem_object *(*gem_prime_import_sg_table)(
 945                                 struct drm_device *dev, size_t size,
 946                                 struct sg_table *sgt);
 947         void *(*gem_prime_vmap)(struct drm_gem_object *obj);
 948         void (*gem_prime_vunmap)(struct drm_gem_object *obj, void *vaddr);
 949         int (*gem_prime_mmap)(struct drm_gem_object *obj,
 950                                 struct vm_area_struct *vma);
 951
 952         /* vga arb irq handler */
 953         void (*vgaarb_irq)(struct drm_device *dev, bool state);
 954
 955         /* dumb alloc support */
 956         int (*dumb_create)(struct drm_file *file_priv,
 957                            struct drm_device *dev,
 958                            struct drm_mode_create_dumb *args);
 959         int (*dumb_map_offset)(struct drm_file *file_priv,
 960                                struct drm_device *dev, uint32_t handle,
 961                                uint64_t *offset);
 962         int (*dumb_destroy)(struct drm_file *file_priv,
 963                             struct drm_device *dev,
 964                             uint32_t handle);
 965
 966         /* Driver private ops for this object */
 967         const struct vm_operations_struct *gem_vm_ops;
 968
 969         int major;
 970         int minor;
 971         int patchlevel;
 972         char *name;
 973         char *desc;
 974         char *date;
 975
 976         u32 driver_features;
 977         int dev_priv_size;
 978         const struct drm_ioctl_desc *ioctls;
 979         int num_ioctls;
 980         const struct file_operations *fops;
 981         union {
 982                 struct pci_driver *pci;
 983                 struct platform_device *platform_device;
 984                 struct usb_driver *usb;
 985         } kdriver;
 986         struct drm_bus *bus;
 987
 988         /* List of devices hanging off this driver */
 989         struct list_head device_list;
 990 };
 991
 992 #define DRM_MINOR_UNASSIGNED 0
 993 #define DRM_MINOR_LEGACY 1
 994 #define DRM_MINOR_CONTROL 2
 995 #define DRM_MINOR_RENDER 3
 996
 997
 998 /**
 999  * debugfs node list. This structure represents a debugfs file to
1000  * be created by the drm core
1001  */
1002 struct drm_debugfs_list {
1003         const char *name; /** file name */
1004         int (*show)(struct seq_file*, void*); /** show callback */
1005         u32 driver_features; /**< Required driver features for this entry */
1006 };
1007
1008 /**
1009  * debugfs node structure. This structure represents a debugfs file.
1010  */
1011 struct drm_debugfs_node {
1012         struct list_head list;
1013         struct drm_minor *minor;
1014         struct drm_debugfs_list *debugfs_ent;
1015         struct dentry *dent;
1016 };
1017
1018 /**
1019  * Info file list entry. This structure represents a debugfs or proc file to
1020  * be created by the drm core
1021  */
1022 struct drm_info_list {
1023         const char *name; /** file name */
1024         int (*show)(struct seq_file*, void*); /** show callback */
1025         u32 driver_features; /**< Required driver features for this entry */
1026         void *data;
1027 };
1028
1029 /**
1030  * debugfs node structure. This structure represents a debugfs file.
1031  */
1032 struct drm_info_node {
1033         struct list_head list;
1034         struct drm_minor *minor;
1035         const struct drm_info_list *info_ent;
1036         struct dentry *dent;
1037 };
1038
1039 /**
1040  * DRM minor structure. This structure represents a drm minor number.
1041  */
1042 struct drm_minor {
1043         int index;                      /**< Minor device number */
1044         int type;                       /**< Control or render */
1045         dev_t device;                   /**< Device number for mknod */
1046         struct device kdev;             /**< Linux device */
1047         struct drm_device *dev;
1048
1049         struct dentry *debugfs_root;
1050
1051         struct list_head debugfs_list;
1052         struct mutex debugfs_lock; /* Protects debugfs_list. */
1053
1054         struct drm_master *master; /* currently active master for this node */
1055         struct list_head master_list;
1056         struct drm_mode_group mode_group;
1057 };
1058
1059 /* mode specified on the command line */
1060 struct drm_cmdline_mode {
1061         bool specified;
1062         bool refresh_specified;
1063         bool bpp_specified;
1064         int xres, yres;
1065         int bpp;
1066         int refresh;
1067         bool rb;
1068         bool interlace;
1069         bool cvt;
1070         bool margins;
1071         enum drm_connector_force force;
1072 };
1073
1074
1075 struct drm_pending_vblank_event {
1076         struct drm_pending_event base;
1077         int pipe;
1078         struct drm_event_vblank event;
1079 };
1080
1081 /**
1082  * DRM device structure. This structure represent a complete card that
1083  * may contain multiple heads.
1084  */
1085 struct drm_device {
1086         struct list_head driver_item;   /**< list of devices per driver */
1087         char *devname;                  /**< For /proc/interrupts */
1088         int if_version;                 /**< Highest interface version set */
1089
1090         /** \name Locks */
1091         /*@{ */
1092         spinlock_t count_lock;          /**< For inuse, drm_device::open_count, drm_device::buf_use */
1093         struct mutex struct_mutex;      /**< For others */
1094         /*@} */
1095
1096         /** \name Usage Counters */
1097         /*@{ */
1098         int open_count;                 /**< Outstanding files open */
1099         atomic_t ioctl_count;           /**< Outstanding IOCTLs pending */
1100         atomic_t vma_count;             /**< Outstanding vma areas open */
1101         int buf_use;                    /**< Buffers in use -- cannot alloc */
1102         atomic_t buf_alloc;             /**< Buffer allocation in progress */
1103         /*@} */
1104
1105         /** \name Performance counters */
1106         /*@{ */
1107         unsigned long counters;
1108         enum drm_stat_type types[15];
1109         atomic_t counts[15];
1110         /*@} */
1111
1112         struct list_head filelist;
1113
1114         /** \name Memory management */
1115         /*@{ */
1116         struct list_head maplist;       /**< Linked list of regions */
1117         int map_count;                  /**< Number of mappable regions */
1118         struct drm_open_hash map_hash;  /**< User token hash table for maps */
1119
1120         /** \name Context handle management */
1121         /*@{ */
1122         struct list_head ctxlist;       /**< Linked list of context handles */
1123         int ctx_count;                  /**< Number of context handles */
1124         struct mutex ctxlist_mutex;     /**< For ctxlist */
1125
1126         struct idr ctx_idr;
1127
1128         struct list_head vmalist;       /**< List of vmas (for debugging) */
1129
1130         /*@} */
1131
1132         /** \name DMA support */
1133         /*@{ */
1134         struct drm_device_dma *dma;             /**< Optional pointer for DMA support */
1135         /*@} */
1136
1137         /** \name Context support */
1138         /*@{ */
1139         int irq_enabled;                /**< True if irq handler is enabled */
1140         __volatile__ long context_flag; /**< Context swapping flag */
1141         int last_context;               /**< Last current context */
1142         /*@} */
1143
1144         struct work_struct work;
1145         /** \name VBLANK IRQ support */
1146         /*@{ */
1147
1148         /*
1149          * At load time, disabling the vblank interrupt won't be allowed since
1150          * old clients may not call the modeset ioctl and therefore misbehave.
1151          * Once the modeset ioctl *has* been called though, we can safely
1152          * disable them when unused.
1153          */
1154         int vblank_disable_allowed;
1155
1156         wait_queue_head_t *vbl_queue;   /**< VBLANK wait queue */
1157         atomic_t *_vblank_count;        /**< number of VBLANK interrupts (driver must alloc the right number of counters) */
1158         struct timeval *_vblank_time;   /**< timestamp of current vblank_count (drivers must alloc right number of fields) */
1159         spinlock_t vblank_time_lock;    /**< Protects vblank count and time updates during vblank enable/disable */
1160         spinlock_t vbl_lock;
1161         atomic_t *vblank_refcount;      /* number of users of vblank interruptsper crtc */
1162         u32 *last_vblank;               /* protected by dev->vbl_lock, used */
1163                                         /* for wraparound handling */
1164         int *vblank_enabled;            /* so we don't call enable more than
1165                                            once per disable */
1166         int *vblank_inmodeset;          /* Display driver is setting mode */
1167         u32 *last_vblank_wait;          /* Last vblank seqno waited per CRTC */
1168         struct timer_list vblank_disable_timer;
1169
1170         u32 max_vblank_count;           /**< size of vblank counter register */
1171
1172         /**
1173          * List of events
1174          */
1175         struct list_head vblank_event_list;
1176         spinlock_t event_lock;
1177
1178         /*@} */
1179
1180         struct drm_agp_head *agp;       /**< AGP data */
1181
1182         struct device *dev;             /**< Device structure */
1183         struct pci_dev *pdev;           /**< PCI device structure */
1184         int pci_vendor;                 /**< PCI vendor id */
1185         int pci_device;                 /**< PCI device id */
1186 #ifdef __alpha__
1187         struct pci_controller *hose;
1188 #endif
1189
1190         struct platform_device *platformdev; /**< Platform device struture */
1191         struct usb_device *usbdev;
1192
1193         struct drm_sg_mem *sg;  /**< Scatter gather memory */
1194         unsigned int num_crtcs;                  /**< Number of CRTCs on this device */
1195         void *dev_private;              /**< device private data */
1196         void *mm_private;
1197         struct address_space *dev_mapping;
1198         struct drm_sigdata sigdata;        /**< For block_all_signals */
1199         sigset_t sigmask;
1200
1201         struct drm_driver *driver;
1202         struct drm_local_map *agp_buffer_map;
1203         unsigned int agp_buffer_token;
1204         struct drm_minor *control;              /**< Control node for card */
1205         struct drm_minor *primary;              /**< render type primary screen head */
1206         struct drm_minor *render;               /**< render node for card */
1207
1208         struct drm_mode_config mode_config;     /**< Current mode config */
1209
1210         /** \name GEM information */
1211         /*@{ */
1212         struct mutex object_name_lock;
1213         struct idr object_name_idr;
1214         /*@} */
1215         int switch_power_state;
1216
1217         atomic_t unplugged; /* device has been unplugged or gone away */
1218 };
1219
1220 #define DRM_SWITCH_POWER_ON 0
1221 #define DRM_SWITCH_POWER_OFF 1
1222 #define DRM_SWITCH_POWER_CHANGING 2
1223 #define DRM_SWITCH_POWER_DYNAMIC_OFF 3
1224
1225 static __inline__ int drm_core_check_feature(struct drm_device *dev,
1226                                              int feature)
1227 {
1228         return ((dev->driver->driver_features & feature) ? 1 : 0);
1229 }
1230
1231 static inline int drm_dev_to_irq(struct drm_device *dev)
1232 {
1233         return dev->driver->bus->get_irq(dev);
1234 }
1235
1236 static inline void drm_device_set_unplugged(struct drm_device *dev)
1237 {
1238         smp_wmb();
1239         atomic_set(&dev->unplugged, 1);
1240 }
1241
1242 static inline int drm_device_is_unplugged(struct drm_device *dev)
1243 {
1244         int ret = atomic_read(&dev->unplugged);
1245         smp_rmb();
1246         return ret;
1247 }
1248
1249 static inline bool drm_modeset_is_locked(struct drm_device *dev)
1250 {
1251         return mutex_is_locked(&dev->mode_config.mutex);
1252 }
1253
1254 static inline bool drm_is_render_client(struct drm_file *file_priv)
1255 {
1256         return file_priv->minor->type == DRM_MINOR_RENDER;
1257 }
1258
1259 /******************************************************************/
1260 /** \name Internal function definitions */
1261 /*@{*/
1262
1263                                 /* Driver support (drm_drv.h) */
1264 extern long drm_ioctl(struct file *filp,
1265                       unsigned int cmd, unsigned long arg);
1266 extern long drm_compat_ioctl(struct file *filp,
1267                              unsigned int cmd, unsigned long arg);
1268 extern int drm_lastclose(struct drm_device *dev);
1269
1270                                 /* Device support (drm_fops.h) */
1271 extern struct mutex drm_global_mutex;
1272 extern int drm_open(struct inode *inode, struct file *filp);
1273 extern int drm_stub_open(struct inode *inode, struct file *filp);
1274 extern ssize_t drm_read(struct file *filp, char __user *buffer,
1275                         size_t count, loff_t *offset);
1276 extern int drm_release(struct inode *inode, struct file *filp);
1277
1278                                 /* Mapping support (drm_vm.h) */
1279 extern int drm_mmap(struct file *filp, struct vm_area_struct *vma);
1280 extern int drm_mmap_locked(struct file *filp, struct vm_area_struct *vma);
1281 extern void drm_vm_open_locked(struct drm_device *dev, struct vm_area_struct *vma);
1282 extern void drm_vm_close_locked(struct drm_device *dev, struct vm_area_struct *vma);
1283 extern unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait);
1284
1285                                 /* Memory management support (drm_memory.h) */
1286 #include <drm/drm_memory.h>
1287
1288                                 /* Misc. IOCTL support (drm_ioctl.h) */
1289 extern int drm_irq_by_busid(struct drm_device *dev, void *data,
1290                             struct drm_file *file_priv);
1291 extern int drm_getunique(struct drm_device *dev, void *data,
1292                          struct drm_file *file_priv);
1293 extern int drm_setunique(struct drm_device *dev, void *data,
1294                          struct drm_file *file_priv);
1295 extern int drm_getmap(struct drm_device *dev, void *data,
1296                       struct drm_file *file_priv);
1297 extern int drm_getclient(struct drm_device *dev, void *data,
1298                          struct drm_file *file_priv);
1299 extern int drm_getstats(struct drm_device *dev, void *data,
1300                         struct drm_file *file_priv);
1301 extern int drm_getcap(struct drm_device *dev, void *data,
1302                       struct drm_file *file_priv);
1303 extern int drm_setversion(struct drm_device *dev, void *data,
1304                           struct drm_file *file_priv);
1305 extern int drm_noop(struct drm_device *dev, void *data,
1306                     struct drm_file *file_priv);
1307
1308                                 /* Context IOCTL support (drm_context.h) */
1309 extern int drm_resctx(struct drm_device *dev, void *data,
1310                       struct drm_file *file_priv);
1311 extern int drm_addctx(struct drm_device *dev, void *data,
1312                       struct drm_file *file_priv);
1313 extern int drm_getctx(struct drm_device *dev, void *data,
1314                       struct drm_file *file_priv);
1315 extern int drm_switchctx(struct drm_device *dev, void *data,
1316                          struct drm_file *file_priv);
1317 extern int drm_newctx(struct drm_device *dev, void *data,
1318                       struct drm_file *file_priv);
1319 extern int drm_rmctx(struct drm_device *dev, void *data,
1320                      struct drm_file *file_priv);
1321
1322 extern int drm_ctxbitmap_init(struct drm_device *dev);
1323 extern void drm_ctxbitmap_cleanup(struct drm_device *dev);
1324 extern void drm_ctxbitmap_free(struct drm_device *dev, int ctx_handle);
1325
1326 extern int drm_setsareactx(struct drm_device *dev, void *data,
1327                            struct drm_file *file_priv);
1328 extern int drm_getsareactx(struct drm_device *dev, void *data,
1329                            struct drm_file *file_priv);
1330
1331                                 /* Authentication IOCTL support (drm_auth.h) */
1332 extern int drm_getmagic(struct drm_device *dev, void *data,
1333                         struct drm_file *file_priv);
1334 extern int drm_authmagic(struct drm_device *dev, void *data,
1335                          struct drm_file *file_priv);
1336 extern int drm_remove_magic(struct drm_master *master, drm_magic_t magic);
1337
1338 /* Cache management (drm_cache.c) */
1339 void drm_clflush_pages(struct page *pages[], unsigned long num_pages);
1340 void drm_clflush_sg(struct sg_table *st);
1341 void drm_clflush_virt_range(char *addr, unsigned long length);
1342
1343                                 /* Locking IOCTL support (drm_lock.h) */
1344 extern int drm_lock(struct drm_device *dev, void *data,
1345                     struct drm_file *file_priv);
1346 extern int drm_unlock(struct drm_device *dev, void *data,
1347                       struct drm_file *file_priv);
1348 extern int drm_lock_free(struct drm_lock_data *lock_data, unsigned int context);
1349 extern void drm_idlelock_take(struct drm_lock_data *lock_data);
1350 extern void drm_idlelock_release(struct drm_lock_data *lock_data);
1351
1352 /*
1353  * These are exported to drivers so that they can implement fencing using
1354  * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
1355  */
1356
1357 extern int drm_i_have_hw_lock(struct drm_device *dev, struct drm_file *file_priv);
1358
1359                                 /* Buffer management support (drm_bufs.h) */
1360 extern int drm_addbufs_agp(struct drm_device *dev, struct drm_buf_desc * request);
1361 extern int drm_addbufs_pci(struct drm_device *dev, struct drm_buf_desc * request);
1362 extern int drm_addmap(struct drm_device *dev, resource_size_t offset,
1363                       unsigned int size, enum drm_map_type type,
1364                       enum drm_map_flags flags, struct drm_local_map **map_ptr);
1365 extern int drm_addmap_ioctl(struct drm_device *dev, void *data,
1366                             struct drm_file *file_priv);
1367 extern int drm_rmmap(struct drm_device *dev, struct drm_local_map *map);
1368 extern int drm_rmmap_locked(struct drm_device *dev, struct drm_local_map *map);
1369 extern int drm_rmmap_ioctl(struct drm_device *dev, void *data,
1370                            struct drm_file *file_priv);
1371 extern int drm_addbufs(struct drm_device *dev, void *data,
1372                        struct drm_file *file_priv);
1373 extern int drm_infobufs(struct drm_device *dev, void *data,
1374                         struct drm_file *file_priv);
1375 extern int drm_markbufs(struct drm_device *dev, void *data,
1376                         struct drm_file *file_priv);
1377 extern int drm_freebufs(struct drm_device *dev, void *data,
1378                         struct drm_file *file_priv);
1379 extern int drm_mapbufs(struct drm_device *dev, void *data,
1380                        struct drm_file *file_priv);
1381 extern int drm_dma_ioctl(struct drm_device *dev, void *data,
1382                          struct drm_file *file_priv);
1383
1384                                 /* DMA support (drm_dma.h) */
1385 extern int drm_legacy_dma_setup(struct drm_device *dev);
1386 extern void drm_legacy_dma_takedown(struct drm_device *dev);
1387 extern void drm_free_buffer(struct drm_device *dev, struct drm_buf * buf);
1388 extern void drm_core_reclaim_buffers(struct drm_device *dev,
1389                                      struct drm_file *filp);
1390
1391                                 /* IRQ support (drm_irq.h) */
1392 extern int drm_control(struct drm_device *dev, void *data,
1393                        struct drm_file *file_priv);
1394 extern int drm_irq_install(struct drm_device *dev);
1395 extern int drm_irq_uninstall(struct drm_device *dev);
1396
1397 extern int drm_vblank_init(struct drm_device *dev, int num_crtcs);
1398 extern int drm_wait_vblank(struct drm_device *dev, void *data,
1399                            struct drm_file *filp);
1400 extern u32 drm_vblank_count(struct drm_device *dev, int crtc);
1401 extern u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
1402                                      struct timeval *vblanktime);
1403 extern void drm_send_vblank_event(struct drm_device *dev, int crtc,
1404                                      struct drm_pending_vblank_event *e);
1405 extern bool drm_handle_vblank(struct drm_device *dev, int crtc);
1406 extern int drm_vblank_get(struct drm_device *dev, int crtc);
1407 extern void drm_vblank_put(struct drm_device *dev, int crtc);
1408 extern void drm_vblank_off(struct drm_device *dev, int crtc);
1409 extern void drm_vblank_cleanup(struct drm_device *dev);
1410 extern u32 drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
1411                                      struct timeval *tvblank, unsigned flags);
1412 extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
1413                                                  int crtc, int *max_error,
1414                                                  struct timeval *vblank_time,
1415                                                  unsigned flags,
1416                                                  struct drm_crtc *refcrtc);
1417 extern void drm_calc_timestamping_constants(struct drm_crtc *crtc);
1418
1419 extern bool
1420 drm_mode_parse_command_line_for_connector(const char *mode_option,
1421                                           struct drm_connector *connector,
1422                                           struct drm_cmdline_mode *mode);
1423
1424 extern struct drm_display_mode *
1425 drm_mode_create_from_cmdline_mode(struct drm_device *dev,
1426                                   struct drm_cmdline_mode *cmd);
1427
1428 extern int drm_display_mode_from_videomode(const struct videomode *vm,
1429                                            struct drm_display_mode *dmode);
1430 extern int of_get_drm_display_mode(struct device_node *np,
1431                                    struct drm_display_mode *dmode,
1432                                    int index);
1433
1434 /* Modesetting support */
1435 extern void drm_vblank_pre_modeset(struct drm_device *dev, int crtc);
1436 extern void drm_vblank_post_modeset(struct drm_device *dev, int crtc);
1437 extern int drm_modeset_ctl(struct drm_device *dev, void *data,
1438                            struct drm_file *file_priv);
1439
1440                                 /* AGP/GART support (drm_agpsupport.h) */
1441
1442 #include <drm/drm_agpsupport.h>
1443
1444                                 /* Stub support (drm_stub.h) */
1445 extern int drm_setmaster_ioctl(struct drm_device *dev, void *data,
1446                                struct drm_file *file_priv);
1447 extern int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
1448                                 struct drm_file *file_priv);
1449 struct drm_master *drm_master_create(struct drm_minor *minor);
1450 extern struct drm_master *drm_master_get(struct drm_master *master);
1451 extern void drm_master_put(struct drm_master **master);
1452
1453 extern void drm_put_dev(struct drm_device *dev);
1454 extern int drm_put_minor(struct drm_minor **minor);
1455 extern void drm_unplug_dev(struct drm_device *dev);
1456 extern unsigned int drm_debug;
1457 extern unsigned int drm_rnodes;
1458
1459 extern unsigned int drm_vblank_offdelay;
1460 extern unsigned int drm_timestamp_precision;
1461 extern unsigned int drm_timestamp_monotonic;
1462
1463 extern struct class *drm_class;
1464 extern struct dentry *drm_debugfs_root;
1465
1466 extern struct idr drm_minors_idr;
1467
1468 extern struct drm_local_map *drm_getsarea(struct drm_device *dev);
1469
1470                                 /* Debugfs support */
1471 #if defined(CONFIG_DEBUG_FS)
1472 extern int drm_debugfs_init(struct drm_minor *minor, int minor_id,
1473                             struct dentry *root);
1474 extern int drm_debugfs_create_files(struct drm_info_list *files, int count,
1475                                     struct dentry *root, struct drm_minor *minor);
1476 extern int drm_debugfs_remove_files(struct drm_info_list *files, int count,
1477                                     struct drm_minor *minor);
1478 extern int drm_debugfs_cleanup(struct drm_minor *minor);
1479 #endif
1480
1481                                 /* Info file support */
1482 extern int drm_name_info(struct seq_file *m, void *data);
1483 extern int drm_vm_info(struct seq_file *m, void *data);
1484 extern int drm_bufs_info(struct seq_file *m, void *data);
1485 extern int drm_vblank_info(struct seq_file *m, void *data);
1486 extern int drm_clients_info(struct seq_file *m, void* data);
1487 extern int drm_gem_name_info(struct seq_file *m, void *data);
1488
1489
1490 extern struct dma_buf *drm_gem_prime_export(struct drm_device *dev,
1491                 struct drm_gem_object *obj, int flags);
1492 extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
1493                 struct drm_file *file_priv, uint32_t handle, uint32_t flags,
1494                 int *prime_fd);
1495 extern struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev,
1496                 struct dma_buf *dma_buf);
1497 extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
1498                 struct drm_file *file_priv, int prime_fd, uint32_t *handle);
1499 extern void drm_gem_dmabuf_release(struct dma_buf *dma_buf);
1500
1501 extern int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data,
1502                                         struct drm_file *file_priv);
1503 extern int drm_prime_fd_to_handle_ioctl(struct drm_device *dev, void *data,
1504                                         struct drm_file *file_priv);
1505
1506 extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages,
1507                                             dma_addr_t *addrs, int max_pages);
1508 extern struct sg_table *drm_prime_pages_to_sg(struct page **pages, int nr_pages);
1509 extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
1510
1511 int drm_gem_dumb_destroy(struct drm_file *file,
1512                          struct drm_device *dev,
1513                          uint32_t handle);
1514
1515 void drm_prime_init_file_private(struct drm_prime_file_private *prime_fpriv);
1516 void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv);
1517 void drm_prime_remove_buf_handle_locked(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf);
1518
1519 #if DRM_DEBUG_CODE
1520 extern int drm_vma_info(struct seq_file *m, void *data);
1521 #endif
1522
1523                                 /* Scatter Gather Support (drm_scatter.h) */
1524 extern void drm_legacy_sg_cleanup(struct drm_device *dev);
1525 extern int drm_sg_alloc(struct drm_device *dev, void *data,
1526                         struct drm_file *file_priv);
1527 extern int drm_sg_free(struct drm_device *dev, void *data,
1528                        struct drm_file *file_priv);
1529
1530                                /* ATI PCIGART support (ati_pcigart.h) */
1531 extern int drm_ati_pcigart_init(struct drm_device *dev,
1532                                 struct drm_ati_pcigart_info * gart_info);
1533 extern int drm_ati_pcigart_cleanup(struct drm_device *dev,
1534                                    struct drm_ati_pcigart_info * gart_info);
1535
1536 extern drm_dma_handle_t *drm_pci_alloc(struct drm_device *dev, size_t size,
1537                                        size_t align);
1538 extern void __drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
1539 extern void drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
1540
1541                                /* sysfs support (drm_sysfs.c) */
1542 struct drm_sysfs_class;
1543 extern struct class *drm_sysfs_create(struct module *owner, char *name);
1544 extern void drm_sysfs_destroy(void);
1545 extern int drm_sysfs_device_add(struct drm_minor *minor);
1546 extern void drm_sysfs_hotplug_event(struct drm_device *dev);
1547 extern void drm_sysfs_device_remove(struct drm_minor *minor);
1548 extern int drm_sysfs_connector_add(struct drm_connector *connector);
1549 extern void drm_sysfs_connector_remove(struct drm_connector *connector);
1550
1551 /* Graphics Execution Manager library functions (drm_gem.c) */
1552 int drm_gem_init(struct drm_device *dev);
1553 void drm_gem_destroy(struct drm_device *dev);
1554 void drm_gem_object_release(struct drm_gem_object *obj);
1555 void drm_gem_object_free(struct kref *kref);
1556 int drm_gem_object_init(struct drm_device *dev,
1557                         struct drm_gem_object *obj, size_t size);
1558 void drm_gem_private_object_init(struct drm_device *dev,
1559                                  struct drm_gem_object *obj, size_t size);
1560 void drm_gem_vm_open(struct vm_area_struct *vma);
1561 void drm_gem_vm_close(struct vm_area_struct *vma);
1562 int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size,
1563                      struct vm_area_struct *vma);
1564 int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma);
1565
1566 #include <drm/drm_global.h>
1567
1568 static inline void
1569 drm_gem_object_reference(struct drm_gem_object *obj)
1570 {
1571         kref_get(&obj->refcount);
1572 }
1573
1574 static inline void
1575 drm_gem_object_unreference(struct drm_gem_object *obj)
1576 {
1577         if (obj != NULL)
1578                 kref_put(&obj->refcount, drm_gem_object_free);
1579 }
1580
1581 static inline void
1582 drm_gem_object_unreference_unlocked(struct drm_gem_object *obj)
1583 {
1584         if (obj && !atomic_add_unless(&obj->refcount.refcount, -1, 1)) {
1585                 struct drm_device *dev = obj->dev;
1586
1587                 mutex_lock(&dev->struct_mutex);
1588                 if (likely(atomic_dec_and_test(&obj->refcount.refcount)))
1589                         drm_gem_object_free(&obj->refcount);
1590                 mutex_unlock(&dev->struct_mutex);
1591         }
1592 }
1593
1594 int drm_gem_handle_create_tail(struct drm_file *file_priv,
1595                                struct drm_gem_object *obj,
1596                                u32 *handlep);
1597 int drm_gem_handle_create(struct drm_file *file_priv,
1598                           struct drm_gem_object *obj,
1599                           u32 *handlep);
1600 int drm_gem_handle_delete(struct drm_file *filp, u32 handle);
1601
1602
1603 void drm_gem_free_mmap_offset(struct drm_gem_object *obj);
1604 int drm_gem_create_mmap_offset(struct drm_gem_object *obj);
1605 int drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size);
1606
1607 struct page **drm_gem_get_pages(struct drm_gem_object *obj, gfp_t gfpmask);
1608 void drm_gem_put_pages(struct drm_gem_object *obj, struct page **pages,
1609                 bool dirty, bool accessed);
1610
1611 struct drm_gem_object *drm_gem_object_lookup(struct drm_device *dev,
1612                                              struct drm_file *filp,
1613                                              u32 handle);
1614 int drm_gem_close_ioctl(struct drm_device *dev, void *data,
1615                         struct drm_file *file_priv);
1616 int drm_gem_flink_ioctl(struct drm_device *dev, void *data,
1617                         struct drm_file *file_priv);
1618 int drm_gem_open_ioctl(struct drm_device *dev, void *data,
1619                        struct drm_file *file_priv);
1620 void drm_gem_open(struct drm_device *dev, struct drm_file *file_private);
1621 void drm_gem_release(struct drm_device *dev, struct drm_file *file_private);
1622
1623 extern void drm_core_ioremap(struct drm_local_map *map, struct drm_device *dev);
1624 extern void drm_core_ioremap_wc(struct drm_local_map *map, struct drm_device *dev);
1625 extern void drm_core_ioremapfree(struct drm_local_map *map, struct drm_device *dev);
1626
1627 static __inline__ struct drm_local_map *drm_core_findmap(struct drm_device *dev,
1628                                                          unsigned int token)
1629 {
1630         struct drm_map_list *_entry;
1631         list_for_each_entry(_entry, &dev->maplist, head)
1632             if (_entry->user_token == token)
1633                 return _entry->map;
1634         return NULL;
1635 }
1636
1637 static __inline__ void drm_core_dropmap(struct drm_local_map *map)
1638 {
1639 }
1640
1641 #include <drm/drm_mem_util.h>
1642
1643 extern int drm_fill_in_dev(struct drm_device *dev,
1644                            const struct pci_device_id *ent,
1645                            struct drm_driver *driver);
1646 int drm_get_minor(struct drm_device *dev, struct drm_minor **minor, int type);
1647 /*@}*/
1648
1649 /* PCI section */
1650 static __inline__ int drm_pci_device_is_agp(struct drm_device *dev)
1651 {
1652         if (dev->driver->device_is_agp != NULL) {
1653                 int err = (*dev->driver->device_is_agp) (dev);
1654
1655                 if (err != 2) {
1656                         return err;
1657                 }
1658         }
1659
1660         return pci_find_capability(dev->pdev, PCI_CAP_ID_AGP);
1661 }
1662
1663 extern int drm_pci_init(struct drm_driver *driver, struct pci_driver *pdriver);
1664 extern void drm_pci_exit(struct drm_driver *driver, struct pci_driver *pdriver);
1665 extern int drm_get_pci_dev(struct pci_dev *pdev,
1666                            const struct pci_device_id *ent,
1667                            struct drm_driver *driver);
1668
1669 #define DRM_PCIE_SPEED_25 1
1670 #define DRM_PCIE_SPEED_50 2
1671 #define DRM_PCIE_SPEED_80 4
1672
1673 extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
1674
1675 /* platform section */
1676 extern int drm_platform_init(struct drm_driver *driver, struct platform_device *platform_device);
1677 extern void drm_platform_exit(struct drm_driver *driver, struct platform_device *platform_device);
1678
1679 /* returns true if currently okay to sleep */
1680 static __inline__ bool drm_can_sleep(void)
1681 {
1682         if (in_atomic() || in_dbg_master() || irqs_disabled())
1683                 return false;
1684         return true;
1685 }
1686
1687 #endif                          /* __KERNEL__ */
1688 #endif