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