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