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