include/drm/drmP.h

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