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