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