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