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