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