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