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