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 struct drm_local_map;
  83 struct drm_device_dma;
  84 struct drm_dma_handle;
  85 struct drm_gem_object;
  86
  87 struct device_node;
  88 struct videomode;
  89 struct reservation_object;
  90 struct dma_buf_attachment;
  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  * ATOMIC: used in the atomic code.
 108  *        This is the category used by the DRM_DEBUG_ATOMIC() macro.
 109  *
 110  * Enabling verbose debug messages is done through the drm.debug parameter,
 111  * each category being enabled by a bit.
 112  *
 113  * drm.debug=0x1 will enable CORE messages
 114  * drm.debug=0x2 will enable DRIVER messages
 115  * drm.debug=0x3 will enable CORE and DRIVER messages
 116  * ...
 117  * drm.debug=0xf will enable all messages
 118  *
 119  * An interesting feature is that it's possible to enable verbose logging at
 120  * run-time by echoing the debug value in its sysfs node:
 121  *   # echo 0xf > /sys/module/drm/parameters/debug
 122  */
 123 #define DRM_UT_CORE             0x01
 124 #define DRM_UT_DRIVER           0x02
 125 #define DRM_UT_KMS              0x04
 126 #define DRM_UT_PRIME            0x08
 127 #define DRM_UT_ATOMIC           0x10
 128
 129 extern __printf(2, 3)
 130 void drm_ut_debug_printk(const char *function_name,
 131                          const char *format, ...);
 132 extern __printf(1, 2)
 133 void drm_err(const char *format, ...);
 134
 135 /***********************************************************************/
 136 /** \name DRM template customization defaults */
 137 /*@{*/
 138
 139 /* driver capabilities and requirements mask */
 140 #define DRIVER_USE_AGP     0x1
 141 #define DRIVER_PCI_DMA     0x8
 142 #define DRIVER_SG          0x10
 143 #define DRIVER_HAVE_DMA    0x20
 144 #define DRIVER_HAVE_IRQ    0x40
 145 #define DRIVER_IRQ_SHARED  0x80
 146 #define DRIVER_GEM         0x1000
 147 #define DRIVER_MODESET     0x2000
 148 #define DRIVER_PRIME       0x4000
 149 #define DRIVER_RENDER      0x8000
 150 #define DRIVER_ATOMIC      0x10000
 151
 152 /***********************************************************************/
 153 /** \name Macros to make printk easier */
 154 /*@{*/
 155
 156 /**
 157  * Error output.
 158  *
 159  * \param fmt printf() like format string.
 160  * \param arg arguments
 161  */
 162 #define DRM_ERROR(fmt, ...)                             \
 163         drm_err(fmt, ##__VA_ARGS__)
 164
 165 /**
 166  * Rate limited error output.  Like DRM_ERROR() but won't flood the log.
 167  *
 168  * \param fmt printf() like format string.
 169  * \param arg arguments
 170  */
 171 #define DRM_ERROR_RATELIMITED(fmt, ...)                         \
 172 ({                                                                      \
 173         static DEFINE_RATELIMIT_STATE(_rs,                              \
 174                                       DEFAULT_RATELIMIT_INTERVAL,       \
 175                                       DEFAULT_RATELIMIT_BURST);         \
 176                                                                         \
 177         if (__ratelimit(&_rs))                                          \
 178                 drm_err(fmt, ##__VA_ARGS__);                            \
 179 })
 180
 181 #define DRM_INFO(fmt, ...)                              \
 182         printk(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
 183
 184 #define DRM_INFO_ONCE(fmt, ...)                         \
 185         printk_once(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
 186
 187 /**
 188  * Debug output.
 189  *
 190  * \param fmt printf() like format string.
 191  * \param arg arguments
 192  */
 193 #define DRM_DEBUG(fmt, args...)                                         \
 194         do {                                                            \
 195                 if (unlikely(drm_debug & DRM_UT_CORE))                  \
 196                         drm_ut_debug_printk(__func__, fmt, ##args);     \
 197         } while (0)
 198
 199 #define DRM_DEBUG_DRIVER(fmt, args...)                                  \
 200         do {                                                            \
 201                 if (unlikely(drm_debug & DRM_UT_DRIVER))                \
 202                         drm_ut_debug_printk(__func__, fmt, ##args);     \
 203         } while (0)
 204 #define DRM_DEBUG_KMS(fmt, args...)                                     \
 205         do {                                                            \
 206                 if (unlikely(drm_debug & DRM_UT_KMS))                   \
 207                         drm_ut_debug_printk(__func__, fmt, ##args);     \
 208         } while (0)
 209 #define DRM_DEBUG_PRIME(fmt, args...)                                   \
 210         do {                                                            \
 211                 if (unlikely(drm_debug & DRM_UT_PRIME))                 \
 212                         drm_ut_debug_printk(__func__, fmt, ##args);     \
 213         } while (0)
 214 #define DRM_DEBUG_ATOMIC(fmt, args...)                                  \
 215         do {                                                            \
 216                 if (unlikely(drm_debug & DRM_UT_ATOMIC))                \
 217                         drm_ut_debug_printk(__func__, fmt, ##args);     \
 218         } while (0)
 219
 220 /*@}*/
 221
 222 /***********************************************************************/
 223 /** \name Internal types and structures */
 224 /*@{*/
 225
 226 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
 227
 228 /**
 229  * Ioctl function type.
 230  *
 231  * \param inode device inode.
 232  * \param file_priv DRM file private pointer.
 233  * \param cmd command.
 234  * \param arg argument.
 235  */
 236 typedef int drm_ioctl_t(struct drm_device *dev, void *data,
 237                         struct drm_file *file_priv);
 238
 239 typedef int drm_ioctl_compat_t(struct file *filp, unsigned int cmd,
 240                                unsigned long arg);
 241
 242 #define DRM_IOCTL_NR(n)                _IOC_NR(n)
 243 #define DRM_MAJOR       226
 244
 245 #define DRM_AUTH        0x1
 246 #define DRM_MASTER      0x2
 247 #define DRM_ROOT_ONLY   0x4
 248 #define DRM_CONTROL_ALLOW 0x8
 249 #define DRM_UNLOCKED    0x10
 250 #define DRM_RENDER_ALLOW 0x20
 251
 252 struct drm_ioctl_desc {
 253         unsigned int cmd;
 254         int flags;
 255         drm_ioctl_t *func;
 256         unsigned int cmd_drv;
 257         const char *name;
 258 };
 259
 260 /**
 261  * Creates a driver or general drm_ioctl_desc array entry for the given
 262  * ioctl, for use by drm_ioctl().
 263  */
 264
 265 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags)                 \
 266         [DRM_IOCTL_NR(DRM_##ioctl)] = {.cmd = DRM_##ioctl, .func = _func, .flags = _flags, .cmd_drv = DRM_IOCTL_##ioctl, .name = #ioctl}
 267
 268 /* Event queued up for userspace to read */
 269 struct drm_pending_event {
 270         struct drm_event *event;
 271         struct list_head link;
 272         struct drm_file *file_priv;
 273         pid_t pid; /* pid of requester, no guarantee it's valid by the time
 274                       we deliver the event, for tracing only */
 275         void (*destroy)(struct drm_pending_event *event);
 276 };
 277
 278 /* initial implementaton using a linked list - todo hashtab */
 279 struct drm_prime_file_private {
 280         struct list_head head;
 281         struct mutex lock;
 282 };
 283
 284 /** File private data */
 285 struct drm_file {
 286         unsigned authenticated :1;
 287         /* Whether we're master for a minor. Protected by master_mutex */
 288         unsigned is_master :1;
 289         /* true when the client has asked us to expose stereo 3D mode flags */
 290         unsigned stereo_allowed :1;
 291         /*
 292          * true if client understands CRTC primary planes and cursor planes
 293          * in the plane list
 294          */
 295         unsigned universal_planes:1;
 296         /* true if client understands atomic properties */
 297         unsigned atomic:1;
 298
 299         struct pid *pid;
 300         kuid_t uid;
 301         drm_magic_t magic;
 302         struct list_head lhead;
 303         struct drm_minor *minor;
 304         unsigned long lock_count;
 305
 306         /** Mapping of mm object handles to object pointers. */
 307         struct idr object_idr;
 308         /** Lock for synchronization of access to object_idr. */
 309         spinlock_t table_lock;
 310
 311         struct file *filp;
 312         void *driver_priv;
 313
 314         struct drm_master *master; /* master this node is currently associated with
 315                                       N.B. not always minor->master */
 316         /**
 317          * fbs - List of framebuffers associated with this file.
 318          *
 319          * Protected by fbs_lock. Note that the fbs list holds a reference on
 320          * the fb object to prevent it from untimely disappearing.
 321          */
 322         struct list_head fbs;
 323         struct mutex fbs_lock;
 324
 325         wait_queue_head_t event_wait;
 326         struct list_head event_list;
 327         int event_space;
 328
 329         struct drm_prime_file_private prime;
 330 };
 331
 332 /**
 333  * Lock data.
 334  */
 335 struct drm_lock_data {
 336         struct drm_hw_lock *hw_lock;    /**< Hardware lock */
 337         /** Private of lock holder's file (NULL=kernel) */
 338         struct drm_file *file_priv;
 339         wait_queue_head_t lock_queue;   /**< Queue of blocked processes */
 340         unsigned long lock_time;        /**< Time of last lock in jiffies */
 341         spinlock_t spinlock;
 342         uint32_t kernel_waiters;
 343         uint32_t user_waiters;
 344         int idle_has_lock;
 345 };
 346
 347 /**
 348  * struct drm_master - drm master structure
 349  *
 350  * @refcount: Refcount for this master object.
 351  * @minor: Link back to minor char device we are master for. Immutable.
 352  * @unique: Unique identifier: e.g. busid. Protected by drm_global_mutex.
 353  * @unique_len: Length of unique field. Protected by drm_global_mutex.
 354  * @magiclist: Hash of used authentication tokens. Protected by struct_mutex.
 355  * @magicfree: List of used authentication tokens. Protected by struct_mutex.
 356  * @lock: DRI lock information.
 357  * @driver_priv: Pointer to driver-private information.
 358  */
 359 struct drm_master {
 360         struct kref refcount;
 361         struct drm_minor *minor;
 362         char *unique;
 363         int unique_len;
 364         struct drm_open_hash magiclist;
 365         struct list_head magicfree;
 366         struct drm_lock_data lock;
 367         void *driver_priv;
 368 };
 369
 370 /* Size of ringbuffer for vblank timestamps. Just double-buffer
 371  * in initial implementation.
 372  */
 373 #define DRM_VBLANKTIME_RBSIZE 2
 374
 375 /* Flags and return codes for get_vblank_timestamp() driver function. */
 376 #define DRM_CALLED_FROM_VBLIRQ 1
 377 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
 378 #define DRM_VBLANKTIME_IN_VBLANK         (1 << 1)
 379
 380 /* get_scanout_position() return flags */
 381 #define DRM_SCANOUTPOS_VALID        (1 << 0)
 382 #define DRM_SCANOUTPOS_IN_VBLANK    (1 << 1)
 383 #define DRM_SCANOUTPOS_ACCURATE     (1 << 2)
 384
 385 /**
 386  * DRM driver structure. This structure represent the common code for
 387  * a family of cards. There will one drm_device for each card present
 388  * in this family
 389  */
 390 struct drm_driver {
 391         int (*load) (struct drm_device *, unsigned long flags);
 392         int (*firstopen) (struct drm_device *);
 393         int (*open) (struct drm_device *, struct drm_file *);
 394         void (*preclose) (struct drm_device *, struct drm_file *file_priv);
 395         void (*postclose) (struct drm_device *, struct drm_file *);
 396         void (*lastclose) (struct drm_device *);
 397         int (*unload) (struct drm_device *);
 398         int (*suspend) (struct drm_device *, pm_message_t state);
 399         int (*resume) (struct drm_device *);
 400         int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
 401         int (*dma_quiescent) (struct drm_device *);
 402         int (*context_dtor) (struct drm_device *dev, int context);
 403         int (*set_busid)(struct drm_device *dev, struct drm_master *master);
 404
 405         /**
 406          * get_vblank_counter - get raw hardware vblank counter
 407          * @dev: DRM device
 408          * @crtc: counter to fetch
 409          *
 410          * Driver callback for fetching a raw hardware vblank counter for @crtc.
 411          * If a device doesn't have a hardware counter, the driver can simply
 412          * return the value of drm_vblank_count. The DRM core will account for
 413          * missed vblank events while interrupts where disabled based on system
 414          * timestamps.
 415          *
 416          * Wraparound handling and loss of events due to modesetting is dealt
 417          * with in the DRM core code.
 418          *
 419          * RETURNS
 420          * Raw vblank counter value.
 421          */
 422         u32 (*get_vblank_counter) (struct drm_device *dev, int crtc);
 423
 424         /**
 425          * enable_vblank - enable vblank interrupt events
 426          * @dev: DRM device
 427          * @crtc: which irq to enable
 428          *
 429          * Enable vblank interrupts for @crtc.  If the device doesn't have
 430          * a hardware vblank counter, this routine should be a no-op, since
 431          * interrupts will have to stay on to keep the count accurate.
 432          *
 433          * RETURNS
 434          * Zero on success, appropriate errno if the given @crtc's vblank
 435          * interrupt cannot be enabled.
 436          */
 437         int (*enable_vblank) (struct drm_device *dev, int crtc);
 438
 439         /**
 440          * disable_vblank - disable vblank interrupt events
 441          * @dev: DRM device
 442          * @crtc: which irq to enable
 443          *
 444          * Disable vblank interrupts for @crtc.  If the device doesn't have
 445          * a hardware vblank counter, this routine should be a no-op, since
 446          * interrupts will have to stay on to keep the count accurate.
 447          */
 448         void (*disable_vblank) (struct drm_device *dev, int crtc);
 449
 450         /**
 451          * Called by \c drm_device_is_agp.  Typically used to determine if a
 452          * card is really attached to AGP or not.
 453          *
 454          * \param dev  DRM device handle
 455          *
 456          * \returns
 457          * One of three values is returned depending on whether or not the
 458          * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
 459          * (return of 1), or may or may not be AGP (return of 2).
 460          */
 461         int (*device_is_agp) (struct drm_device *dev);
 462
 463         /**
 464          * Called by vblank timestamping code.
 465          *
 466          * Return the current display scanout position from a crtc, and an
 467          * optional accurate ktime_get timestamp of when position was measured.
 468          *
 469          * \param dev  DRM device.
 470          * \param crtc Id of the crtc to query.
 471          * \param flags Flags from the caller (DRM_CALLED_FROM_VBLIRQ or 0).
 472          * \param *vpos Target location for current vertical scanout position.
 473          * \param *hpos Target location for current horizontal scanout position.
 474          * \param *stime Target location for timestamp taken immediately before
 475          *               scanout position query. Can be NULL to skip timestamp.
 476          * \param *etime Target location for timestamp taken immediately after
 477          *               scanout position query. Can be NULL to skip timestamp.
 478          *
 479          * Returns vpos as a positive number while in active scanout area.
 480          * Returns vpos as a negative number inside vblank, counting the number
 481          * of scanlines to go until end of vblank, e.g., -1 means "one scanline
 482          * until start of active scanout / end of vblank."
 483          *
 484          * \return Flags, or'ed together as follows:
 485          *
 486          * DRM_SCANOUTPOS_VALID = Query successful.
 487          * DRM_SCANOUTPOS_INVBL = Inside vblank.
 488          * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
 489          * this flag means that returned position may be offset by a constant
 490          * but unknown small number of scanlines wrt. real scanout position.
 491          *
 492          */
 493         int (*get_scanout_position) (struct drm_device *dev, int crtc,
 494                                      unsigned int flags,
 495                                      int *vpos, int *hpos, ktime_t *stime,
 496                                      ktime_t *etime);
 497
 498         /**
 499          * Called by \c drm_get_last_vbltimestamp. Should return a precise
 500          * timestamp when the most recent VBLANK interval ended or will end.
 501          *
 502          * Specifically, the timestamp in @vblank_time should correspond as
 503          * closely as possible to the time when the first video scanline of
 504          * the video frame after the end of VBLANK will start scanning out,
 505          * the time immediately after end of the VBLANK interval. If the
 506          * @crtc is currently inside VBLANK, this will be a time in the future.
 507          * If the @crtc is currently scanning out a frame, this will be the
 508          * past start time of the current scanout. This is meant to adhere
 509          * to the OpenML OML_sync_control extension specification.
 510          *
 511          * \param dev dev DRM device handle.
 512          * \param crtc crtc for which timestamp should be returned.
 513          * \param *max_error Maximum allowable timestamp error in nanoseconds.
 514          *                   Implementation should strive to provide timestamp
 515          *                   with an error of at most *max_error nanoseconds.
 516          *                   Returns true upper bound on error for timestamp.
 517          * \param *vblank_time Target location for returned vblank timestamp.
 518          * \param flags 0 = Defaults, no special treatment needed.
 519          * \param       DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
 520          *              irq handler. Some drivers need to apply some workarounds
 521          *              for gpu-specific vblank irq quirks if flag is set.
 522          *
 523          * \returns
 524          * Zero if timestamping isn't supported in current display mode or a
 525          * negative number on failure. A positive status code on success,
 526          * which describes how the vblank_time timestamp was computed.
 527          */
 528         int (*get_vblank_timestamp) (struct drm_device *dev, int crtc,
 529                                      int *max_error,
 530                                      struct timeval *vblank_time,
 531                                      unsigned flags);
 532
 533         /* these have to be filled in */
 534
 535         irqreturn_t(*irq_handler) (int irq, void *arg);
 536         void (*irq_preinstall) (struct drm_device *dev);
 537         int (*irq_postinstall) (struct drm_device *dev);
 538         void (*irq_uninstall) (struct drm_device *dev);
 539
 540         /* Master routines */
 541         int (*master_create)(struct drm_device *dev, struct drm_master *master);
 542         void (*master_destroy)(struct drm_device *dev, struct drm_master *master);
 543         /**
 544          * master_set is called whenever the minor master is set.
 545          * master_drop is called whenever the minor master is dropped.
 546          */
 547
 548         int (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
 549                           bool from_open);
 550         void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv,
 551                             bool from_release);
 552
 553         int (*debugfs_init)(struct drm_minor *minor);
 554         void (*debugfs_cleanup)(struct drm_minor *minor);
 555
 556         /**
 557          * Driver-specific constructor for drm_gem_objects, to set up
 558          * obj->driver_private.
 559          *
 560          * Returns 0 on success.
 561          */
 562         void (*gem_free_object) (struct drm_gem_object *obj);
 563         int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
 564         void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
 565
 566         /* prime: */
 567         /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */
 568         int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
 569                                 uint32_t handle, uint32_t flags, int *prime_fd);
 570         /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */
 571         int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
 572                                 int prime_fd, uint32_t *handle);
 573         /* export GEM -> dmabuf */
 574         struct dma_buf * (*gem_prime_export)(struct drm_device *dev,
 575                                 struct drm_gem_object *obj, int flags);
 576         /* import dmabuf -> GEM */
 577         struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
 578                                 struct dma_buf *dma_buf);
 579         /* low-level interface used by drm_gem_prime_{import,export} */
 580         int (*gem_prime_pin)(struct drm_gem_object *obj);
 581         void (*gem_prime_unpin)(struct drm_gem_object *obj);
 582         struct reservation_object * (*gem_prime_res_obj)(
 583                                 struct drm_gem_object *obj);
 584         struct sg_table *(*gem_prime_get_sg_table)(struct drm_gem_object *obj);
 585         struct drm_gem_object *(*gem_prime_import_sg_table)(
 586                                 struct drm_device *dev,
 587                                 struct dma_buf_attachment *attach,
 588                                 struct sg_table *sgt);
 589         void *(*gem_prime_vmap)(struct drm_gem_object *obj);
 590         void (*gem_prime_vunmap)(struct drm_gem_object *obj, void *vaddr);
 591         int (*gem_prime_mmap)(struct drm_gem_object *obj,
 592                                 struct vm_area_struct *vma);
 593
 594         /* vga arb irq handler */
 595         void (*vgaarb_irq)(struct drm_device *dev, bool state);
 596
 597         /* dumb alloc support */
 598         int (*dumb_create)(struct drm_file *file_priv,
 599                            struct drm_device *dev,
 600                            struct drm_mode_create_dumb *args);
 601         int (*dumb_map_offset)(struct drm_file *file_priv,
 602                                struct drm_device *dev, uint32_t handle,
 603                                uint64_t *offset);
 604         int (*dumb_destroy)(struct drm_file *file_priv,
 605                             struct drm_device *dev,
 606                             uint32_t handle);
 607
 608         /* Driver private ops for this object */
 609         const struct vm_operations_struct *gem_vm_ops;
 610
 611         int major;
 612         int minor;
 613         int patchlevel;
 614         char *name;
 615         char *desc;
 616         char *date;
 617
 618         u32 driver_features;
 619         int dev_priv_size;
 620         const struct drm_ioctl_desc *ioctls;
 621         int num_ioctls;
 622         const struct file_operations *fops;
 623
 624         /* List of devices hanging off this driver with stealth attach. */
 625         struct list_head legacy_dev_list;
 626 };
 627
 628 enum drm_minor_type {
 629         DRM_MINOR_LEGACY,
 630         DRM_MINOR_CONTROL,
 631         DRM_MINOR_RENDER,
 632         DRM_MINOR_CNT,
 633 };
 634
 635 /**
 636  * Info file list entry. This structure represents a debugfs or proc file to
 637  * be created by the drm core
 638  */
 639 struct drm_info_list {
 640         const char *name; /** file name */
 641         int (*show)(struct seq_file*, void*); /** show callback */
 642         u32 driver_features; /**< Required driver features for this entry */
 643         void *data;
 644 };
 645
 646 /**
 647  * debugfs node structure. This structure represents a debugfs file.
 648  */
 649 struct drm_info_node {
 650         struct list_head list;
 651         struct drm_minor *minor;
 652         const struct drm_info_list *info_ent;
 653         struct dentry *dent;
 654 };
 655
 656 /**
 657  * DRM minor structure. This structure represents a drm minor number.
 658  */
 659 struct drm_minor {
 660         int index;                      /**< Minor device number */
 661         int type;                       /**< Control or render */
 662         struct device *kdev;            /**< Linux device */
 663         struct drm_device *dev;
 664
 665         struct dentry *debugfs_root;
 666
 667         struct list_head debugfs_list;
 668         struct mutex debugfs_lock; /* Protects debugfs_list. */
 669
 670         /* currently active master for this node. Protected by master_mutex */
 671         struct drm_master *master;
 672         struct drm_mode_group mode_group;
 673 };
 674
 675
 676 struct drm_pending_vblank_event {
 677         struct drm_pending_event base;
 678         int pipe;
 679         struct drm_event_vblank event;
 680 };
 681
 682 struct drm_vblank_crtc {
 683         struct drm_device *dev;         /* pointer to the drm_device */
 684         wait_queue_head_t queue;        /**< VBLANK wait queue */
 685         struct timeval time[DRM_VBLANKTIME_RBSIZE];     /**< timestamp of current count */
 686         struct timer_list disable_timer;                /* delayed disable timer */
 687         atomic_t count;                 /**< number of VBLANK interrupts */
 688         atomic_t refcount;              /* number of users of vblank interruptsper crtc */
 689         u32 last;                       /* protected by dev->vbl_lock, used */
 690                                         /* for wraparound handling */
 691         u32 last_wait;                  /* Last vblank seqno waited per CRTC */
 692         unsigned int inmodeset;         /* Display driver is setting mode */
 693         int crtc;                       /* crtc index */
 694         bool enabled;                   /* so we don't call enable more than
 695                                            once per disable */
 696 };
 697
 698 /**
 699  * DRM device structure. This structure represent a complete card that
 700  * may contain multiple heads.
 701  */
 702 struct drm_device {
 703         struct list_head legacy_dev_list;/**< list of devices per driver for stealth attach cleanup */
 704         int if_version;                 /**< Highest interface version set */
 705
 706         /** \name Lifetime Management */
 707         /*@{ */
 708         struct kref ref;                /**< Object ref-count */
 709         struct device *dev;             /**< Device structure of bus-device */
 710         struct drm_driver *driver;      /**< DRM driver managing the device */
 711         void *dev_private;              /**< DRM driver private data */
 712         struct drm_minor *control;              /**< Control node */
 713         struct drm_minor *primary;              /**< Primary node */
 714         struct drm_minor *render;               /**< Render node */
 715         atomic_t unplugged;                     /**< Flag whether dev is dead */
 716         struct inode *anon_inode;               /**< inode for private address-space */
 717         char *unique;                           /**< unique name of the device */
 718         /*@} */
 719
 720         /** \name Locks */
 721         /*@{ */
 722         struct mutex struct_mutex;      /**< For others */
 723         struct mutex master_mutex;      /**< For drm_minor::master and drm_file::is_master */
 724         /*@} */
 725
 726         /** \name Usage Counters */
 727         /*@{ */
 728         int open_count;                 /**< Outstanding files open, protected by drm_global_mutex. */
 729         spinlock_t buf_lock;            /**< For drm_device::buf_use and a few other things. */
 730         int buf_use;                    /**< Buffers in use -- cannot alloc */
 731         atomic_t buf_alloc;             /**< Buffer allocation in progress */
 732         /*@} */
 733
 734         struct list_head filelist;
 735
 736         /** \name Memory management */
 737         /*@{ */
 738         struct list_head maplist;       /**< Linked list of regions */
 739         struct drm_open_hash map_hash;  /**< User token hash table for maps */
 740
 741         /** \name Context handle management */
 742         /*@{ */
 743         struct list_head ctxlist;       /**< Linked list of context handles */
 744         struct mutex ctxlist_mutex;     /**< For ctxlist */
 745
 746         struct idr ctx_idr;
 747
 748         struct list_head vmalist;       /**< List of vmas (for debugging) */
 749
 750         /*@} */
 751
 752         /** \name DMA support */
 753         /*@{ */
 754         struct drm_device_dma *dma;             /**< Optional pointer for DMA support */
 755         /*@} */
 756
 757         /** \name Context support */
 758         /*@{ */
 759
 760         __volatile__ long context_flag; /**< Context swapping flag */
 761         int last_context;               /**< Last current context */
 762         /*@} */
 763
 764         /** \name VBLANK IRQ support */
 765         /*@{ */
 766         bool irq_enabled;
 767         int irq;
 768
 769         /*
 770          * At load time, disabling the vblank interrupt won't be allowed since
 771          * old clients may not call the modeset ioctl and therefore misbehave.
 772          * Once the modeset ioctl *has* been called though, we can safely
 773          * disable them when unused.
 774          */
 775         bool vblank_disable_allowed;
 776
 777         /*
 778          * If true, vblank interrupt will be disabled immediately when the
 779          * refcount drops to zero, as opposed to via the vblank disable
 780          * timer.
 781          * This can be set to true it the hardware has a working vblank
 782          * counter and the driver uses drm_vblank_on() and drm_vblank_off()
 783          * appropriately.
 784          */
 785         bool vblank_disable_immediate;
 786
 787         /* array of size num_crtcs */
 788         struct drm_vblank_crtc *vblank;
 789
 790         spinlock_t vblank_time_lock;    /**< Protects vblank count and time updates during vblank enable/disable */
 791         spinlock_t vbl_lock;
 792
 793         u32 max_vblank_count;           /**< size of vblank counter register */
 794
 795         /**
 796          * List of events
 797          */
 798         struct list_head vblank_event_list;
 799         spinlock_t event_lock;
 800
 801         /*@} */
 802
 803         struct drm_agp_head *agp;       /**< AGP data */
 804
 805         struct pci_dev *pdev;           /**< PCI device structure */
 806 #ifdef __alpha__
 807         struct pci_controller *hose;
 808 #endif
 809
 810         struct platform_device *platformdev; /**< Platform device struture */
 811
 812         struct drm_sg_mem *sg;  /**< Scatter gather memory */
 813         unsigned int num_crtcs;                  /**< Number of CRTCs on this device */
 814         sigset_t sigmask;
 815
 816         struct {
 817                 int context;
 818                 struct drm_hw_lock *lock;
 819         } sigdata;
 820
 821         struct drm_local_map *agp_buffer_map;
 822         unsigned int agp_buffer_token;
 823
 824         struct drm_mode_config mode_config;     /**< Current mode config */
 825
 826         /** \name GEM information */
 827         /*@{ */
 828         struct mutex object_name_lock;
 829         struct idr object_name_idr;
 830         struct drm_vma_offset_manager *vma_offset_manager;
 831         /*@} */
 832         int switch_power_state;
 833 };
 834
 835 #define DRM_SWITCH_POWER_ON 0
 836 #define DRM_SWITCH_POWER_OFF 1
 837 #define DRM_SWITCH_POWER_CHANGING 2
 838 #define DRM_SWITCH_POWER_DYNAMIC_OFF 3
 839
 840 static __inline__ int drm_core_check_feature(struct drm_device *dev,
 841                                              int feature)
 842 {
 843         return ((dev->driver->driver_features & feature) ? 1 : 0);
 844 }
 845
 846 static inline void drm_device_set_unplugged(struct drm_device *dev)
 847 {
 848         smp_wmb();
 849         atomic_set(&dev->unplugged, 1);
 850 }
 851
 852 static inline int drm_device_is_unplugged(struct drm_device *dev)
 853 {
 854         int ret = atomic_read(&dev->unplugged);
 855         smp_rmb();
 856         return ret;
 857 }
 858
 859 static inline bool drm_is_render_client(const struct drm_file *file_priv)
 860 {
 861         return file_priv->minor->type == DRM_MINOR_RENDER;
 862 }
 863
 864 static inline bool drm_is_control_client(const struct drm_file *file_priv)
 865 {
 866         return file_priv->minor->type == DRM_MINOR_CONTROL;
 867 }
 868
 869 static inline bool drm_is_primary_client(const struct drm_file *file_priv)
 870 {
 871         return file_priv->minor->type == DRM_MINOR_LEGACY;
 872 }
 873
 874 /******************************************************************/
 875 /** \name Internal function definitions */
 876 /*@{*/
 877
 878                                 /* Driver support (drm_drv.h) */
 879 extern long drm_ioctl(struct file *filp,
 880                       unsigned int cmd, unsigned long arg);
 881 extern long drm_compat_ioctl(struct file *filp,
 882                              unsigned int cmd, unsigned long arg);
 883 extern bool drm_ioctl_flags(unsigned int nr, unsigned int *flags);
 884
 885                                 /* Device support (drm_fops.h) */
 886 extern int drm_open(struct inode *inode, struct file *filp);
 887 extern ssize_t drm_read(struct file *filp, char __user *buffer,
 888                         size_t count, loff_t *offset);
 889 extern int drm_release(struct inode *inode, struct file *filp);
 890
 891                                 /* Mapping support (drm_vm.h) */
 892 extern unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait);
 893
 894 /* Misc. IOCTL support (drm_ioctl.c) */
 895 int drm_noop(struct drm_device *dev, void *data,
 896              struct drm_file *file_priv);
 897
 898 /* Cache management (drm_cache.c) */
 899 void drm_clflush_pages(struct page *pages[], unsigned long num_pages);
 900 void drm_clflush_sg(struct sg_table *st);
 901 void drm_clflush_virt_range(void *addr, unsigned long length);
 902
 903 /*
 904  * These are exported to drivers so that they can implement fencing using
 905  * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
 906  */
 907
 908                                 /* IRQ support (drm_irq.h) */
 909 extern int drm_irq_install(struct drm_device *dev, int irq);
 910 extern int drm_irq_uninstall(struct drm_device *dev);
 911
 912 extern int drm_vblank_init(struct drm_device *dev, int num_crtcs);
 913 extern int drm_wait_vblank(struct drm_device *dev, void *data,
 914                            struct drm_file *filp);
 915 extern u32 drm_vblank_count(struct drm_device *dev, int crtc);
 916 extern u32 drm_crtc_vblank_count(struct drm_crtc *crtc);
 917 extern u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
 918                                      struct timeval *vblanktime);
 919 extern void drm_send_vblank_event(struct drm_device *dev, int crtc,
 920                                      struct drm_pending_vblank_event *e);
 921 extern void drm_crtc_send_vblank_event(struct drm_crtc *crtc,
 922                                        struct drm_pending_vblank_event *e);
 923 extern bool drm_handle_vblank(struct drm_device *dev, int crtc);
 924 extern bool drm_crtc_handle_vblank(struct drm_crtc *crtc);
 925 extern int drm_vblank_get(struct drm_device *dev, int crtc);
 926 extern void drm_vblank_put(struct drm_device *dev, int crtc);
 927 extern int drm_crtc_vblank_get(struct drm_crtc *crtc);
 928 extern void drm_crtc_vblank_put(struct drm_crtc *crtc);
 929 extern void drm_wait_one_vblank(struct drm_device *dev, int crtc);
 930 extern void drm_crtc_wait_one_vblank(struct drm_crtc *crtc);
 931 extern void drm_vblank_off(struct drm_device *dev, int crtc);
 932 extern void drm_vblank_on(struct drm_device *dev, int crtc);
 933 extern void drm_crtc_vblank_off(struct drm_crtc *crtc);
 934 extern void drm_crtc_vblank_reset(struct drm_crtc *crtc);
 935 extern void drm_crtc_vblank_on(struct drm_crtc *crtc);
 936 extern void drm_vblank_cleanup(struct drm_device *dev);
 937
 938 extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
 939                                                  int crtc, int *max_error,
 940                                                  struct timeval *vblank_time,
 941                                                  unsigned flags,
 942                                                  const struct drm_crtc *refcrtc,
 943                                                  const struct drm_display_mode *mode);
 944 extern void drm_calc_timestamping_constants(struct drm_crtc *crtc,
 945                                             const struct drm_display_mode *mode);
 946
 947 /**
 948  * drm_crtc_vblank_waitqueue - get vblank waitqueue for the CRTC
 949  * @crtc: which CRTC's vblank waitqueue to retrieve
 950  *
 951  * This function returns a pointer to the vblank waitqueue for the CRTC.
 952  * Drivers can use this to implement vblank waits using wait_event() & co.
 953  */
 954 static inline wait_queue_head_t *drm_crtc_vblank_waitqueue(struct drm_crtc *crtc)
 955 {
 956         return &crtc->dev->vblank[drm_crtc_index(crtc)].queue;
 957 }
 958
 959 /* Modesetting support */
 960 extern void drm_vblank_pre_modeset(struct drm_device *dev, int crtc);
 961 extern void drm_vblank_post_modeset(struct drm_device *dev, int crtc);
 962
 963                                 /* Stub support (drm_stub.h) */
 964 extern struct drm_master *drm_master_get(struct drm_master *master);
 965 extern void drm_master_put(struct drm_master **master);
 966
 967 extern void drm_put_dev(struct drm_device *dev);
 968 extern void drm_unplug_dev(struct drm_device *dev);
 969 extern unsigned int drm_debug;
 970 extern bool drm_atomic;
 971
 972                                 /* Debugfs support */
 973 #if defined(CONFIG_DEBUG_FS)
 974 extern int drm_debugfs_create_files(const struct drm_info_list *files,
 975                                     int count, struct dentry *root,
 976                                     struct drm_minor *minor);
 977 extern int drm_debugfs_remove_files(const struct drm_info_list *files,
 978                                     int count, struct drm_minor *minor);
 979 #else
 980 static inline int drm_debugfs_create_files(const struct drm_info_list *files,
 981                                            int count, struct dentry *root,
 982                                            struct drm_minor *minor)
 983 {
 984         return 0;
 985 }
 986
 987 static inline int drm_debugfs_remove_files(const struct drm_info_list *files,
 988                                            int count, struct drm_minor *minor)
 989 {
 990         return 0;
 991 }
 992 #endif
 993
 994 extern struct dma_buf *drm_gem_prime_export(struct drm_device *dev,
 995                 struct drm_gem_object *obj, int flags);
 996 extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
 997                 struct drm_file *file_priv, uint32_t handle, uint32_t flags,
 998                 int *prime_fd);
 999 extern struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev,
1000                 struct dma_buf *dma_buf);
1001 extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
1002                 struct drm_file *file_priv, int prime_fd, uint32_t *handle);
1003 extern void drm_gem_dmabuf_release(struct dma_buf *dma_buf);
1004
1005 extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages,
1006                                             dma_addr_t *addrs, int max_pages);
1007 extern struct sg_table *drm_prime_pages_to_sg(struct page **pages, unsigned int nr_pages);
1008 extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
1009
1010
1011 extern struct drm_dma_handle *drm_pci_alloc(struct drm_device *dev, size_t size,
1012                                             size_t align);
1013 extern void drm_pci_free(struct drm_device *dev, struct drm_dma_handle * dmah);
1014
1015                                /* sysfs support (drm_sysfs.c) */
1016 extern void drm_sysfs_hotplug_event(struct drm_device *dev);
1017
1018
1019 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
1020                                  struct device *parent);
1021 void drm_dev_ref(struct drm_device *dev);
1022 void drm_dev_unref(struct drm_device *dev);
1023 int drm_dev_register(struct drm_device *dev, unsigned long flags);
1024 void drm_dev_unregister(struct drm_device *dev);
1025 int drm_dev_set_unique(struct drm_device *dev, const char *fmt, ...);
1026
1027 struct drm_minor *drm_minor_acquire(unsigned int minor_id);
1028 void drm_minor_release(struct drm_minor *minor);
1029
1030 /*@}*/
1031
1032 /* PCI section */
1033 static __inline__ int drm_pci_device_is_agp(struct drm_device *dev)
1034 {
1035         if (dev->driver->device_is_agp != NULL) {
1036                 int err = (*dev->driver->device_is_agp) (dev);
1037
1038                 if (err != 2) {
1039                         return err;
1040                 }
1041         }
1042
1043         return pci_find_capability(dev->pdev, PCI_CAP_ID_AGP);
1044 }
1045 void drm_pci_agp_destroy(struct drm_device *dev);
1046
1047 extern int drm_pci_init(struct drm_driver *driver, struct pci_driver *pdriver);
1048 extern void drm_pci_exit(struct drm_driver *driver, struct pci_driver *pdriver);
1049 #ifdef CONFIG_PCI
1050 extern int drm_get_pci_dev(struct pci_dev *pdev,
1051                            const struct pci_device_id *ent,
1052                            struct drm_driver *driver);
1053 extern int drm_pci_set_busid(struct drm_device *dev, struct drm_master *master);
1054 #else
1055 static inline int drm_get_pci_dev(struct pci_dev *pdev,
1056                                   const struct pci_device_id *ent,
1057                                   struct drm_driver *driver)
1058 {
1059         return -ENOSYS;
1060 }
1061
1062 static inline int drm_pci_set_busid(struct drm_device *dev,
1063                                     struct drm_master *master)
1064 {
1065         return -ENOSYS;
1066 }
1067 #endif
1068
1069 #define DRM_PCIE_SPEED_25 1
1070 #define DRM_PCIE_SPEED_50 2
1071 #define DRM_PCIE_SPEED_80 4
1072
1073 extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
1074
1075 /* platform section */
1076 extern int drm_platform_init(struct drm_driver *driver, struct platform_device *platform_device);
1077 extern int drm_platform_set_busid(struct drm_device *d, struct drm_master *m);
1078
1079 /* returns true if currently okay to sleep */
1080 static __inline__ bool drm_can_sleep(void)
1081 {
1082         if (in_atomic() || in_dbg_master() || irqs_disabled())
1083                 return false;
1084         return true;
1085 }
1086
1087 #endif