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