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