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