include/drm/drmP.h

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