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