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