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/seqlock.h>
  56 #include <linux/slab.h>
  57 #include <linux/types.h>
  58 #include <linux/vmalloc.h>
  59 #include <linux/workqueue.h>
  60 #include <linux/fence.h>
  61
  62 #include <asm/mman.h>
  63 #include <asm/pgalloc.h>
  64 #include <asm/uaccess.h>
  65
  66 #include <uapi/drm/drm.h>
  67 #include <uapi/drm/drm_mode.h>
  68
  69 #include <drm/drm_agpsupport.h>
  70 #include <drm/drm_crtc.h>
  71 #include <drm/drm_fourcc.h>
  72 #include <drm/drm_global.h>
  73 #include <drm/drm_hashtab.h>
  74 #include <drm/drm_mem_util.h>
  75 #include <drm/drm_mm.h>
  76 #include <drm/drm_os_linux.h>
  77 #include <drm/drm_sarea.h>
  78 #include <drm/drm_vma_manager.h>
  79
  80 struct module;
  81
  82 struct drm_file;
  83 struct drm_device;
  84 struct drm_agp_head;
  85 struct drm_local_map;
  86 struct drm_device_dma;
  87 struct drm_dma_handle;
  88 struct drm_gem_object;
  89
  90 struct device_node;
  91 struct videomode;
  92 struct reservation_object;
  93 struct dma_buf_attachment;
  94
  95 /*
  96  * The following categories are defined:
  97  *
  98  * CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c, drm_memory.c, ...
  99  *       This is the category used by the DRM_DEBUG() macro.
 100  *
 101  * DRIVER: Used in the vendor specific part of the driver: i915, radeon, ...
 102  *         This is the category used by the DRM_DEBUG_DRIVER() macro.
 103  *
 104  * KMS: used in the modesetting code.
 105  *      This is the category used by the DRM_DEBUG_KMS() macro.
 106  *
 107  * PRIME: used in the prime code.
 108  *        This is the category used by the DRM_DEBUG_PRIME() macro.
 109  *
 110  * ATOMIC: used in the atomic code.
 111  *        This is the category used by the DRM_DEBUG_ATOMIC() macro.
 112  *
 113  * VBL: used for verbose debug message in the vblank code
 114  *        This is the category used by the DRM_DEBUG_VBL() macro.
 115  *
 116  * Enabling verbose debug messages is done through the drm.debug parameter,
 117  * each category being enabled by a bit.
 118  *
 119  * drm.debug=0x1 will enable CORE messages
 120  * drm.debug=0x2 will enable DRIVER messages
 121  * drm.debug=0x3 will enable CORE and DRIVER messages
 122  * ...
 123  * drm.debug=0x3f will enable all messages
 124  *
 125  * An interesting feature is that it's possible to enable verbose logging at
 126  * run-time by echoing the debug value in its sysfs node:
 127  *   # echo 0xf > /sys/module/drm/parameters/debug
 128  */
 129 #define DRM_UT_CORE             0x01
 130 #define DRM_UT_DRIVER           0x02
 131 #define DRM_UT_KMS              0x04
 132 #define DRM_UT_PRIME            0x08
 133 #define DRM_UT_ATOMIC           0x10
 134 #define DRM_UT_VBL              0x20
 135
 136 extern __printf(2, 3)
 137 void drm_ut_debug_printk(const char *function_name,
 138                          const char *format, ...);
 139 extern __printf(1, 2)
 140 void drm_err(const char *format, ...);
 141
 142 /***********************************************************************/
 143 /** \name DRM template customization defaults */
 144 /*@{*/
 145
 146 /* driver capabilities and requirements mask */
 147 #define DRIVER_USE_AGP                  0x1
 148 #define DRIVER_PCI_DMA                  0x8
 149 #define DRIVER_SG                       0x10
 150 #define DRIVER_HAVE_DMA                 0x20
 151 #define DRIVER_HAVE_IRQ                 0x40
 152 #define DRIVER_IRQ_SHARED               0x80
 153 #define DRIVER_GEM                      0x1000
 154 #define DRIVER_MODESET                  0x2000
 155 #define DRIVER_PRIME                    0x4000
 156 #define DRIVER_RENDER                   0x8000
 157 #define DRIVER_ATOMIC                   0x10000
 158 #define DRIVER_KMS_LEGACY_CONTEXT       0x20000
 159
 160 /***********************************************************************/
 161 /** \name Macros to make printk easier */
 162 /*@{*/
 163
 164 /**
 165  * Error output.
 166  *
 167  * \param fmt printf() like format string.
 168  * \param arg arguments
 169  */
 170 #define DRM_ERROR(fmt, ...)                             \
 171         drm_err(fmt, ##__VA_ARGS__)
 172
 173 /**
 174  * Rate limited error output.  Like DRM_ERROR() but won't flood the log.
 175  *
 176  * \param fmt printf() like format string.
 177  * \param arg arguments
 178  */
 179 #define DRM_ERROR_RATELIMITED(fmt, ...)                         \
 180 ({                                                                      \
 181         static DEFINE_RATELIMIT_STATE(_rs,                              \
 182                                       DEFAULT_RATELIMIT_INTERVAL,       \
 183                                       DEFAULT_RATELIMIT_BURST);         \
 184                                                                         \
 185         if (__ratelimit(&_rs))                                          \
 186                 drm_err(fmt, ##__VA_ARGS__);                            \
 187 })
 188
 189 #define DRM_INFO(fmt, ...)                              \
 190         printk(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
 191
 192 #define DRM_INFO_ONCE(fmt, ...)                         \
 193         printk_once(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
 194
 195 /**
 196  * Debug output.
 197  *
 198  * \param fmt printf() like format string.
 199  * \param arg arguments
 200  */
 201 #define DRM_DEBUG(fmt, args...)                                         \
 202         do {                                                            \
 203                 if (unlikely(drm_debug & DRM_UT_CORE))                  \
 204                         drm_ut_debug_printk(__func__, fmt, ##args);     \
 205         } while (0)
 206
 207 #define DRM_DEBUG_DRIVER(fmt, args...)                                  \
 208         do {                                                            \
 209                 if (unlikely(drm_debug & DRM_UT_DRIVER))                \
 210                         drm_ut_debug_printk(__func__, fmt, ##args);     \
 211         } while (0)
 212 #define DRM_DEBUG_KMS(fmt, args...)                                     \
 213         do {                                                            \
 214                 if (unlikely(drm_debug & DRM_UT_KMS))                   \
 215                         drm_ut_debug_printk(__func__, fmt, ##args);     \
 216         } while (0)
 217 #define DRM_DEBUG_PRIME(fmt, args...)                                   \
 218         do {                                                            \
 219                 if (unlikely(drm_debug & DRM_UT_PRIME))                 \
 220                         drm_ut_debug_printk(__func__, fmt, ##args);     \
 221         } while (0)
 222 #define DRM_DEBUG_ATOMIC(fmt, args...)                                  \
 223         do {                                                            \
 224                 if (unlikely(drm_debug & DRM_UT_ATOMIC))                \
 225                         drm_ut_debug_printk(__func__, fmt, ##args);     \
 226         } while (0)
 227 #define DRM_DEBUG_VBL(fmt, args...)                                     \
 228         do {                                                            \
 229                 if (unlikely(drm_debug & DRM_UT_VBL))                   \
 230                         drm_ut_debug_printk(__func__, fmt, ##args);     \
 231         } while (0)
 232
 233 /*@}*/
 234
 235 /***********************************************************************/
 236 /** \name Internal types and structures */
 237 /*@{*/
 238
 239 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
 240
 241 /**
 242  * Ioctl function type.
 243  *
 244  * \param inode device inode.
 245  * \param file_priv DRM file private pointer.
 246  * \param cmd command.
 247  * \param arg argument.
 248  */
 249 typedef int drm_ioctl_t(struct drm_device *dev, void *data,
 250                         struct drm_file *file_priv);
 251
 252 typedef int drm_ioctl_compat_t(struct file *filp, unsigned int cmd,
 253                                unsigned long arg);
 254
 255 #define DRM_IOCTL_NR(n)                _IOC_NR(n)
 256 #define DRM_MAJOR       226
 257
 258 #define DRM_AUTH        0x1
 259 #define DRM_MASTER      0x2
 260 #define DRM_ROOT_ONLY   0x4
 261 #define DRM_CONTROL_ALLOW 0x8
 262 #define DRM_UNLOCKED    0x10
 263 #define DRM_RENDER_ALLOW 0x20
 264
 265 struct drm_ioctl_desc {
 266         unsigned int cmd;
 267         int flags;
 268         drm_ioctl_t *func;
 269         const char *name;
 270 };
 271
 272 /**
 273  * Creates a driver or general drm_ioctl_desc array entry for the given
 274  * ioctl, for use by drm_ioctl().
 275  */
 276
 277 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags)                         \
 278         [DRM_IOCTL_NR(DRM_IOCTL_##ioctl) - DRM_COMMAND_BASE] = {        \
 279                 .cmd = DRM_IOCTL_##ioctl,                               \
 280                 .func = _func,                                          \
 281                 .flags = _flags,                                        \
 282                 .name = #ioctl                                          \
 283          }
 284
 285 /* Event queued up for userspace to read */
 286 struct drm_pending_event {
 287         struct completion *completion;
 288         struct drm_event *event;
 289         struct fence *fence;
 290         struct list_head link;
 291         struct list_head pending_link;
 292         struct drm_file *file_priv;
 293         pid_t pid; /* pid of requester, no guarantee it's valid by the time
 294                       we deliver the event, for tracing only */
 295 };
 296
 297 /* initial implementaton using a linked list - todo hashtab */
 298 struct drm_prime_file_private {
 299         struct list_head head;
 300         struct mutex lock;
 301 };
 302
 303 /** File private data */
 304 struct drm_file {
 305         unsigned authenticated :1;
 306         /* Whether we're master for a minor. Protected by master_mutex */
 307         unsigned is_master :1;
 308         /* true when the client has asked us to expose stereo 3D mode flags */
 309         unsigned stereo_allowed :1;
 310         /*
 311          * true if client understands CRTC primary planes and cursor planes
 312          * in the plane list
 313          */
 314         unsigned universal_planes:1;
 315         /* true if client understands atomic properties */
 316         unsigned atomic:1;
 317         /*
 318          * This client is allowed to gain master privileges for @master.
 319          * Protected by struct drm_device::master_mutex.
 320          */
 321         unsigned allowed_master:1;
 322
 323         struct pid *pid;
 324         kuid_t uid;
 325         drm_magic_t magic;
 326         struct list_head lhead;
 327         struct drm_minor *minor;
 328         unsigned long lock_count;
 329
 330         /** Mapping of mm object handles to object pointers. */
 331         struct idr object_idr;
 332         /** Lock for synchronization of access to object_idr. */
 333         spinlock_t table_lock;
 334
 335         struct file *filp;
 336         void *driver_priv;
 337
 338         struct drm_master *master; /* master this node is currently associated with
 339                                       N.B. not always dev->master */
 340         /**
 341          * fbs - List of framebuffers associated with this file.
 342          *
 343          * Protected by fbs_lock. Note that the fbs list holds a reference on
 344          * the fb object to prevent it from untimely disappearing.
 345          */
 346         struct list_head fbs;
 347         struct mutex fbs_lock;
 348
 349         /** User-created blob properties; this retains a reference on the
 350          *  property. */
 351         struct list_head blobs;
 352
 353         wait_queue_head_t event_wait;
 354         struct list_head pending_event_list;
 355         struct list_head event_list;
 356         int event_space;
 357
 358         struct mutex event_read_lock;
 359
 360         struct drm_prime_file_private prime;
 361 };
 362
 363 /**
 364  * Lock data.
 365  */
 366 struct drm_lock_data {
 367         struct drm_hw_lock *hw_lock;    /**< Hardware lock */
 368         /** Private of lock holder's file (NULL=kernel) */
 369         struct drm_file *file_priv;
 370         wait_queue_head_t lock_queue;   /**< Queue of blocked processes */
 371         unsigned long lock_time;        /**< Time of last lock in jiffies */
 372         spinlock_t spinlock;
 373         uint32_t kernel_waiters;
 374         uint32_t user_waiters;
 375         int idle_has_lock;
 376 };
 377
 378 /**
 379  * struct drm_master - drm master structure
 380  *
 381  * @refcount: Refcount for this master object.
 382  * @dev: Link back to the DRM device
 383  * @unique: Unique identifier: e.g. busid. Protected by drm_global_mutex.
 384  * @unique_len: Length of unique field. Protected by drm_global_mutex.
 385  * @magic_map: Map of used authentication tokens. Protected by struct_mutex.
 386  * @lock: DRI lock information.
 387  * @driver_priv: Pointer to driver-private information.
 388  *
 389  * Note that master structures are only relevant for the legacy/primary device
 390  * nodes, hence there can only be one per device, not one per drm_minor.
 391  */
 392 struct drm_master {
 393         struct kref refcount;
 394         struct drm_device *dev;
 395         char *unique;
 396         int unique_len;
 397         struct idr magic_map;
 398         struct drm_lock_data lock;
 399         void *driver_priv;
 400 };
 401
 402 /* Flags and return codes for get_vblank_timestamp() driver function. */
 403 #define DRM_CALLED_FROM_VBLIRQ 1
 404 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
 405 #define DRM_VBLANKTIME_IN_VBLANK         (1 << 1)
 406
 407 /* get_scanout_position() return flags */
 408 #define DRM_SCANOUTPOS_VALID        (1 << 0)
 409 #define DRM_SCANOUTPOS_IN_VBLANK    (1 << 1)
 410 #define DRM_SCANOUTPOS_ACCURATE     (1 << 2)
 411
 412 /**
 413  * DRM driver structure. This structure represent the common code for
 414  * a family of cards. There will one drm_device for each card present
 415  * in this family
 416  */
 417 struct drm_driver {
 418         int (*load) (struct drm_device *, unsigned long flags);
 419         int (*firstopen) (struct drm_device *);
 420         int (*open) (struct drm_device *, struct drm_file *);
 421         void (*preclose) (struct drm_device *, struct drm_file *file_priv);
 422         void (*postclose) (struct drm_device *, struct drm_file *);
 423         void (*lastclose) (struct drm_device *);
 424         int (*unload) (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          * use drm_vblank_no_hw_counter() function. 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, the driver should use the
 456          * drm_vblank_no_hw_counter() function that keeps a virtual counter.
 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, the driver should use the
 471          * drm_vblank_no_hw_counter() function that keeps a virtual counter.
 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
 713
 714 struct drm_pending_vblank_event {
 715         struct drm_pending_event base;
 716         unsigned int pipe;
 717         struct drm_event_vblank event;
 718 };
 719
 720 struct drm_vblank_crtc {
 721         struct drm_device *dev;         /* pointer to the drm_device */
 722         wait_queue_head_t queue;        /**< VBLANK wait queue */
 723         struct timer_list disable_timer;                /* delayed disable timer */
 724
 725         seqlock_t seqlock;              /* protects vblank count and time */
 726
 727         u32 count;                      /* vblank counter */
 728         struct timeval time;            /* vblank timestamp */
 729
 730         atomic_t refcount;              /* number of users of vblank interruptsper crtc */
 731         u32 last;                       /* protected by dev->vbl_lock, used */
 732                                         /* for wraparound handling */
 733         u32 last_wait;                  /* Last vblank seqno waited per CRTC */
 734         unsigned int inmodeset;         /* Display driver is setting mode */
 735         unsigned int pipe;              /* crtc index */
 736         int framedur_ns;                /* frame/field duration in ns */
 737         int linedur_ns;                 /* line duration in ns */
 738         bool enabled;                   /* so we don't call enable more than
 739                                            once per disable */
 740 };
 741
 742 /**
 743  * DRM device structure. This structure represent a complete card that
 744  * may contain multiple heads.
 745  */
 746 struct drm_device {
 747         struct list_head legacy_dev_list;/**< list of devices per driver for stealth attach cleanup */
 748         int if_version;                 /**< Highest interface version set */
 749
 750         /** \name Lifetime Management */
 751         /*@{ */
 752         struct kref ref;                /**< Object ref-count */
 753         struct device *dev;             /**< Device structure of bus-device */
 754         struct drm_driver *driver;      /**< DRM driver managing the device */
 755         void *dev_private;              /**< DRM driver private data */
 756         struct drm_minor *control;              /**< Control node */
 757         struct drm_minor *primary;              /**< Primary node */
 758         struct drm_minor *render;               /**< Render node */
 759
 760         /* currently active master for this device. Protected by master_mutex */
 761         struct drm_master *master;
 762
 763         atomic_t unplugged;                     /**< Flag whether dev is dead */
 764         struct inode *anon_inode;               /**< inode for private address-space */
 765         char *unique;                           /**< unique name of the device */
 766         /*@} */
 767
 768         /** \name Locks */
 769         /*@{ */
 770         struct mutex struct_mutex;      /**< For others */
 771         struct mutex master_mutex;      /**< For drm_minor::master and drm_file::is_master */
 772         /*@} */
 773
 774         /** \name Usage Counters */
 775         /*@{ */
 776         int open_count;                 /**< Outstanding files open, protected by drm_global_mutex. */
 777         spinlock_t buf_lock;            /**< For drm_device::buf_use and a few other things. */
 778         int buf_use;                    /**< Buffers in use -- cannot alloc */
 779         atomic_t buf_alloc;             /**< Buffer allocation in progress */
 780         /*@} */
 781
 782         struct mutex filelist_mutex;
 783         struct list_head filelist;
 784
 785         /** \name Memory management */
 786         /*@{ */
 787         struct list_head maplist;       /**< Linked list of regions */
 788         struct drm_open_hash map_hash;  /**< User token hash table for maps */
 789
 790         /** \name Context handle management */
 791         /*@{ */
 792         struct list_head ctxlist;       /**< Linked list of context handles */
 793         struct mutex ctxlist_mutex;     /**< For ctxlist */
 794
 795         struct idr ctx_idr;
 796
 797         struct list_head vmalist;       /**< List of vmas (for debugging) */
 798
 799         /*@} */
 800
 801         /** \name DMA support */
 802         /*@{ */
 803         struct drm_device_dma *dma;             /**< Optional pointer for DMA support */
 804         /*@} */
 805
 806         /** \name Context support */
 807         /*@{ */
 808
 809         __volatile__ long context_flag; /**< Context swapping flag */
 810         int last_context;               /**< Last current context */
 811         /*@} */
 812
 813         /** \name VBLANK IRQ support */
 814         /*@{ */
 815         bool irq_enabled;
 816         int irq;
 817
 818         /*
 819          * If true, vblank interrupt will be disabled immediately when the
 820          * refcount drops to zero, as opposed to via the vblank disable
 821          * timer.
 822          * This can be set to true it the hardware has a working vblank
 823          * counter and the driver uses drm_vblank_on() and drm_vblank_off()
 824          * appropriately.
 825          */
 826         bool vblank_disable_immediate;
 827
 828         /* array of size num_crtcs */
 829         struct drm_vblank_crtc *vblank;
 830
 831         spinlock_t vblank_time_lock;    /**< Protects vblank count and time updates during vblank enable/disable */
 832         spinlock_t vbl_lock;
 833
 834         u32 max_vblank_count;           /**< size of vblank counter register */
 835
 836         /**
 837          * List of events
 838          */
 839         struct list_head vblank_event_list;
 840         spinlock_t event_lock;
 841
 842         /*@} */
 843
 844         struct drm_agp_head *agp;       /**< AGP data */
 845
 846         struct pci_dev *pdev;           /**< PCI device structure */
 847 #ifdef __alpha__
 848         struct pci_controller *hose;
 849 #endif
 850
 851         struct platform_device *platformdev; /**< Platform device struture */
 852         struct virtio_device *virtdev;
 853
 854         struct drm_sg_mem *sg;  /**< Scatter gather memory */
 855         unsigned int num_crtcs;                  /**< Number of CRTCs on this device */
 856
 857         struct {
 858                 int context;
 859                 struct drm_hw_lock *lock;
 860         } sigdata;
 861
 862         struct drm_local_map *agp_buffer_map;
 863         unsigned int agp_buffer_token;
 864
 865         struct drm_mode_config mode_config;     /**< Current mode config */
 866
 867         /** \name GEM information */
 868         /*@{ */
 869         struct mutex object_name_lock;
 870         struct idr object_name_idr;
 871         struct drm_vma_offset_manager *vma_offset_manager;
 872         /*@} */
 873         int switch_power_state;
 874 };
 875
 876 #define DRM_SWITCH_POWER_ON 0
 877 #define DRM_SWITCH_POWER_OFF 1
 878 #define DRM_SWITCH_POWER_CHANGING 2
 879 #define DRM_SWITCH_POWER_DYNAMIC_OFF 3
 880
 881 static __inline__ int drm_core_check_feature(struct drm_device *dev,
 882                                              int feature)
 883 {
 884         return ((dev->driver->driver_features & feature) ? 1 : 0);
 885 }
 886
 887 static inline void drm_device_set_unplugged(struct drm_device *dev)
 888 {
 889         smp_wmb();
 890         atomic_set(&dev->unplugged, 1);
 891 }
 892
 893 static inline int drm_device_is_unplugged(struct drm_device *dev)
 894 {
 895         int ret = atomic_read(&dev->unplugged);
 896         smp_rmb();
 897         return ret;
 898 }
 899
 900 static inline bool drm_is_render_client(const struct drm_file *file_priv)
 901 {
 902         return file_priv->minor->type == DRM_MINOR_RENDER;
 903 }
 904
 905 static inline bool drm_is_control_client(const struct drm_file *file_priv)
 906 {
 907         return file_priv->minor->type == DRM_MINOR_CONTROL;
 908 }
 909
 910 static inline bool drm_is_primary_client(const struct drm_file *file_priv)
 911 {
 912         return file_priv->minor->type == DRM_MINOR_LEGACY;
 913 }
 914
 915 /******************************************************************/
 916 /** \name Internal function definitions */
 917 /*@{*/
 918
 919                                 /* Driver support (drm_drv.h) */
 920 extern int drm_ioctl_permit(u32 flags, struct drm_file *file_priv);
 921 extern long drm_ioctl(struct file *filp,
 922                       unsigned int cmd, unsigned long arg);
 923 extern long drm_compat_ioctl(struct file *filp,
 924                              unsigned int cmd, unsigned long arg);
 925 extern bool drm_ioctl_flags(unsigned int nr, unsigned int *flags);
 926
 927 /* File Operations (drm_fops.c) */
 928 int drm_open(struct inode *inode, struct file *filp);
 929 ssize_t drm_read(struct file *filp, char __user *buffer,
 930                  size_t count, loff_t *offset);
 931 int drm_release(struct inode *inode, struct file *filp);
 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_crtc_send_vblank_event(struct drm_crtc *crtc,
 976                                        struct drm_pending_vblank_event *e);
 977 extern void drm_crtc_arm_vblank_event(struct drm_crtc *crtc,
 978                                       struct drm_pending_vblank_event *e);
 979 extern bool drm_handle_vblank(struct drm_device *dev, unsigned int pipe);
 980 extern bool drm_crtc_handle_vblank(struct drm_crtc *crtc);
 981 extern int drm_crtc_vblank_get(struct drm_crtc *crtc);
 982 extern void drm_crtc_vblank_put(struct drm_crtc *crtc);
 983 extern void drm_wait_one_vblank(struct drm_device *dev, unsigned int pipe);
 984 extern void drm_crtc_wait_one_vblank(struct drm_crtc *crtc);
 985 extern void drm_vblank_off(struct drm_device *dev, unsigned int pipe);
 986 extern void drm_vblank_on(struct drm_device *dev, unsigned int pipe);
 987 extern void drm_crtc_vblank_off(struct drm_crtc *crtc);
 988 extern void drm_crtc_vblank_reset(struct drm_crtc *crtc);
 989 extern void drm_crtc_vblank_on(struct drm_crtc *crtc);
 990 extern void drm_vblank_cleanup(struct drm_device *dev);
 991 extern u32 drm_accurate_vblank_count(struct drm_crtc *crtc);
 992 extern u32 drm_vblank_no_hw_counter(struct drm_device *dev, unsigned int pipe);
 993
 994 extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
 995                                                  unsigned int pipe, int *max_error,
 996                                                  struct timeval *vblank_time,
 997                                                  unsigned flags,
 998                                                  const struct drm_display_mode *mode);
 999 extern void drm_calc_timestamping_constants(struct drm_crtc *crtc,
1000                                             const struct drm_display_mode *mode);
1001
1002 /**
1003  * drm_crtc_vblank_waitqueue - get vblank waitqueue for the CRTC
1004  * @crtc: which CRTC's vblank waitqueue to retrieve
1005  *
1006  * This function returns a pointer to the vblank waitqueue for the CRTC.
1007  * Drivers can use this to implement vblank waits using wait_event() & co.
1008  */
1009 static inline wait_queue_head_t *drm_crtc_vblank_waitqueue(struct drm_crtc *crtc)
1010 {
1011         return &crtc->dev->vblank[drm_crtc_index(crtc)].queue;
1012 }
1013
1014 /* Modesetting support */
1015 extern void drm_vblank_pre_modeset(struct drm_device *dev, unsigned int pipe);
1016 extern void drm_vblank_post_modeset(struct drm_device *dev, unsigned int pipe);
1017
1018                                 /* Stub support (drm_stub.h) */
1019 extern struct drm_master *drm_master_get(struct drm_master *master);
1020 extern void drm_master_put(struct drm_master **master);
1021
1022 extern void drm_put_dev(struct drm_device *dev);
1023 extern void drm_unplug_dev(struct drm_device *dev);
1024 extern unsigned int drm_debug;
1025 extern bool drm_atomic;
1026
1027                                 /* Debugfs support */
1028 #if defined(CONFIG_DEBUG_FS)
1029 extern int drm_debugfs_create_files(const struct drm_info_list *files,
1030                                     int count, struct dentry *root,
1031                                     struct drm_minor *minor);
1032 extern int drm_debugfs_remove_files(const struct drm_info_list *files,
1033                                     int count, struct drm_minor *minor);
1034 #else
1035 static inline int drm_debugfs_create_files(const struct drm_info_list *files,
1036                                            int count, struct dentry *root,
1037                                            struct drm_minor *minor)
1038 {
1039         return 0;
1040 }
1041
1042 static inline int drm_debugfs_remove_files(const struct drm_info_list *files,
1043                                            int count, struct drm_minor *minor)
1044 {
1045         return 0;
1046 }
1047 #endif
1048
1049 extern struct dma_buf *drm_gem_prime_export(struct drm_device *dev,
1050                 struct drm_gem_object *obj, int flags);
1051 extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
1052                 struct drm_file *file_priv, uint32_t handle, uint32_t flags,
1053                 int *prime_fd);
1054 extern struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev,
1055                 struct dma_buf *dma_buf);
1056 extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
1057                 struct drm_file *file_priv, int prime_fd, uint32_t *handle);
1058 extern void drm_gem_dmabuf_release(struct dma_buf *dma_buf);
1059
1060 extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages,
1061                                             dma_addr_t *addrs, int max_pages);
1062 extern struct sg_table *drm_prime_pages_to_sg(struct page **pages, unsigned int nr_pages);
1063 extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
1064
1065
1066 extern struct drm_dma_handle *drm_pci_alloc(struct drm_device *dev, size_t size,
1067                                             size_t align);
1068 extern void drm_pci_free(struct drm_device *dev, struct drm_dma_handle * dmah);
1069
1070                                /* sysfs support (drm_sysfs.c) */
1071 extern void drm_sysfs_hotplug_event(struct drm_device *dev);
1072
1073
1074 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
1075                                  struct device *parent);
1076 int drm_dev_init(struct drm_device *dev,
1077                  struct drm_driver *driver,
1078                  struct device *parent);
1079 void drm_dev_ref(struct drm_device *dev);
1080 void drm_dev_unref(struct drm_device *dev);
1081 int drm_dev_register(struct drm_device *dev, unsigned long flags);
1082 void drm_dev_unregister(struct drm_device *dev);
1083 int drm_dev_set_unique(struct drm_device *dev, const char *name);
1084
1085 struct drm_minor *drm_minor_acquire(unsigned int minor_id);
1086 void drm_minor_release(struct drm_minor *minor);
1087
1088 /*@}*/
1089
1090 /* PCI section */
1091 static __inline__ int drm_pci_device_is_agp(struct drm_device *dev)
1092 {
1093         if (dev->driver->device_is_agp != NULL) {
1094                 int err = (*dev->driver->device_is_agp) (dev);
1095
1096                 if (err != 2) {
1097                         return err;
1098                 }
1099         }
1100
1101         return pci_find_capability(dev->pdev, PCI_CAP_ID_AGP);
1102 }
1103 void drm_pci_agp_destroy(struct drm_device *dev);
1104
1105 extern int drm_pci_init(struct drm_driver *driver, struct pci_driver *pdriver);
1106 extern void drm_pci_exit(struct drm_driver *driver, struct pci_driver *pdriver);
1107 #ifdef CONFIG_PCI
1108 extern int drm_get_pci_dev(struct pci_dev *pdev,
1109                            const struct pci_device_id *ent,
1110                            struct drm_driver *driver);
1111 extern int drm_pci_set_busid(struct drm_device *dev, struct drm_master *master);
1112 #else
1113 static inline int drm_get_pci_dev(struct pci_dev *pdev,
1114                                   const struct pci_device_id *ent,
1115                                   struct drm_driver *driver)
1116 {
1117         return -ENOSYS;
1118 }
1119
1120 static inline int drm_pci_set_busid(struct drm_device *dev,
1121                                     struct drm_master *master)
1122 {
1123         return -ENOSYS;
1124 }
1125 #endif
1126
1127 #define DRM_PCIE_SPEED_25 1
1128 #define DRM_PCIE_SPEED_50 2
1129 #define DRM_PCIE_SPEED_80 4
1130
1131 extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
1132 extern int drm_pcie_get_max_link_width(struct drm_device *dev, u32 *mlw);
1133
1134 /* platform section */
1135 extern int drm_platform_init(struct drm_driver *driver, struct platform_device *platform_device);
1136 extern int drm_platform_set_busid(struct drm_device *d, struct drm_master *m);
1137
1138 /* returns true if currently okay to sleep */
1139 static __inline__ bool drm_can_sleep(void)
1140 {
1141         if (in_atomic() || in_dbg_master() || irqs_disabled())
1142                 return false;
1143         return true;
1144 }
1145
1146 /* helper for handling conditionals in various for_each macros */
1147 #define for_each_if(condition) if (!(condition)) {} else
1148
1149 #endif