include/drm/drmP.h

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