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