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