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