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