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