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