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/platform_device.h>
  51 #include <linux/poll.h>
  52 #include <linux/ratelimit.h>
  53 #include <linux/sched.h>
  54 #include <linux/slab.h>
  55 #include <linux/types.h>
  56 #include <linux/vmalloc.h>
  57 #include <linux/workqueue.h>
  58 #include <linux/dma-fence.h>
  59 #include <linux/module.h>
  60
  61 #include <asm/mman.h>
  62 #include <asm/pgalloc.h>
  63 #include <linux/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_drv.h>
  78 #include <drm/drm_prime.h>
  79 #include <drm/drm_pci.h>
  80 #include <drm/drm_file.h>
  81 #include <drm/drm_debugfs.h>
  82 #include <drm/drm_ioctl.h>
  83 #include <drm/drm_sysfs.h>
  84
  85 struct module;
  86
  87 struct drm_device;
  88 struct drm_agp_head;
  89 struct drm_local_map;
  90 struct drm_device_dma;
  91 struct drm_gem_object;
  92 struct drm_master;
  93 struct drm_vblank_crtc;
  94 struct drm_vma_offset_manager;
  95
  96 struct device_node;
  97 struct videomode;
  98 struct reservation_object;
  99 struct dma_buf_attachment;
 100
 101 struct pci_dev;
 102 struct pci_controller;
 103
 104 /*
 105  * The following categories are defined:
 106  *
 107  * CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c, drm_memory.c, ...
 108  *       This is the category used by the DRM_DEBUG() macro.
 109  *
 110  * DRIVER: Used in the vendor specific part of the driver: i915, radeon, ...
 111  *         This is the category used by the DRM_DEBUG_DRIVER() macro.
 112  *
 113  * KMS: used in the modesetting code.
 114  *      This is the category used by the DRM_DEBUG_KMS() macro.
 115  *
 116  * PRIME: used in the prime code.
 117  *        This is the category used by the DRM_DEBUG_PRIME() macro.
 118  *
 119  * ATOMIC: used in the atomic code.
 120  *        This is the category used by the DRM_DEBUG_ATOMIC() macro.
 121  *
 122  * VBL: used for verbose debug message in the vblank code
 123  *        This is the category used by the DRM_DEBUG_VBL() macro.
 124  *
 125  * Enabling verbose debug messages is done through the drm.debug parameter,
 126  * each category being enabled by a bit.
 127  *
 128  * drm.debug=0x1 will enable CORE messages
 129  * drm.debug=0x2 will enable DRIVER messages
 130  * drm.debug=0x3 will enable CORE and DRIVER messages
 131  * ...
 132  * drm.debug=0x3f will enable all messages
 133  *
 134  * An interesting feature is that it's possible to enable verbose logging at
 135  * run-time by echoing the debug value in its sysfs node:
 136  *   # echo 0xf > /sys/module/drm/parameters/debug
 137  */
 138 #define DRM_UT_NONE             0x00
 139 #define DRM_UT_CORE             0x01
 140 #define DRM_UT_DRIVER           0x02
 141 #define DRM_UT_KMS              0x04
 142 #define DRM_UT_PRIME            0x08
 143 #define DRM_UT_ATOMIC           0x10
 144 #define DRM_UT_VBL              0x20
 145 #define DRM_UT_STATE            0x40
 146
 147 /***********************************************************************/
 148 /** \name DRM template customization defaults */
 149 /*@{*/
 150
 151 /***********************************************************************/
 152 /** \name Macros to make printk easier */
 153 /*@{*/
 154
 155 #define _DRM_PRINTK(once, level, fmt, ...)                              \
 156         do {                                                            \
 157                 printk##once(KERN_##level "[" DRM_NAME "] " fmt,        \
 158                              ##__VA_ARGS__);                            \
 159         } while (0)
 160
 161 #define DRM_INFO(fmt, ...)                                              \
 162         _DRM_PRINTK(, INFO, fmt, ##__VA_ARGS__)
 163 #define DRM_NOTE(fmt, ...)                                              \
 164         _DRM_PRINTK(, NOTICE, fmt, ##__VA_ARGS__)
 165 #define DRM_WARN(fmt, ...)                                              \
 166         _DRM_PRINTK(, WARNING, fmt, ##__VA_ARGS__)
 167
 168 #define DRM_INFO_ONCE(fmt, ...)                                         \
 169         _DRM_PRINTK(_once, INFO, fmt, ##__VA_ARGS__)
 170 #define DRM_NOTE_ONCE(fmt, ...)                                         \
 171         _DRM_PRINTK(_once, NOTICE, fmt, ##__VA_ARGS__)
 172 #define DRM_WARN_ONCE(fmt, ...)                                         \
 173         _DRM_PRINTK(_once, WARNING, fmt, ##__VA_ARGS__)
 174
 175 /**
 176  * Error output.
 177  *
 178  * \param fmt printf() like format string.
 179  * \param arg arguments
 180  */
 181 #define DRM_DEV_ERROR(dev, fmt, ...)                                    \
 182         drm_dev_printk(dev, KERN_ERR, DRM_UT_NONE, __func__, " *ERROR*",\
 183                        fmt, ##__VA_ARGS__)
 184 #define DRM_ERROR(fmt, ...)                                             \
 185         drm_printk(KERN_ERR, DRM_UT_NONE, fmt,  ##__VA_ARGS__)
 186
 187 /**
 188  * Rate limited error output.  Like DRM_ERROR() but won't flood the log.
 189  *
 190  * \param fmt printf() like format string.
 191  * \param arg arguments
 192  */
 193 #define DRM_DEV_ERROR_RATELIMITED(dev, fmt, ...)                        \
 194 ({                                                                      \
 195         static DEFINE_RATELIMIT_STATE(_rs,                              \
 196                                       DEFAULT_RATELIMIT_INTERVAL,       \
 197                                       DEFAULT_RATELIMIT_BURST);         \
 198                                                                         \
 199         if (__ratelimit(&_rs))                                          \
 200                 DRM_DEV_ERROR(dev, fmt, ##__VA_ARGS__);                 \
 201 })
 202 #define DRM_ERROR_RATELIMITED(fmt, ...)                                 \
 203         DRM_DEV_ERROR_RATELIMITED(NULL, fmt, ##__VA_ARGS__)
 204
 205 #define DRM_DEV_INFO(dev, fmt, ...)                                     \
 206         drm_dev_printk(dev, KERN_INFO, DRM_UT_NONE, __func__, "", fmt,  \
 207                        ##__VA_ARGS__)
 208
 209 #define DRM_DEV_INFO_ONCE(dev, fmt, ...)                                \
 210 ({                                                                      \
 211         static bool __print_once __read_mostly;                         \
 212         if (!__print_once) {                                            \
 213                 __print_once = true;                                    \
 214                 DRM_DEV_INFO(dev, fmt, ##__VA_ARGS__);                  \
 215         }                                                               \
 216 })
 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, ...)                                             \
 228         drm_printk(KERN_DEBUG, DRM_UT_CORE, fmt, ##__VA_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, ...)                                      \
 234         drm_printk(KERN_DEBUG, DRM_UT_DRIVER, fmt, ##__VA_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, ...)                                 \
 240         drm_printk(KERN_DEBUG, DRM_UT_KMS, fmt, ##__VA_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, ...)                                       \
 246         drm_printk(KERN_DEBUG, DRM_UT_PRIME, fmt, ##__VA_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, ...)                                      \
 252         drm_printk(KERN_DEBUG, DRM_UT_ATOMIC, fmt, ##__VA_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, ...)                                 \
 258         drm_printk(KERN_DEBUG, DRM_UT_VBL, fmt, ##__VA_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 /* Format strings and argument splitters to simplify printing
 294  * various "complex" objects
 295  */
 296 #define DRM_MODE_FMT    "%d:\"%s\" %d %d %d %d %d %d %d %d %d %d 0x%x 0x%x"
 297 #define DRM_MODE_ARG(m) \
 298         (m)->base.id, (m)->name, (m)->vrefresh, (m)->clock, \
 299         (m)->hdisplay, (m)->hsync_start, (m)->hsync_end, (m)->htotal, \
 300         (m)->vdisplay, (m)->vsync_start, (m)->vsync_end, (m)->vtotal, \
 301         (m)->type, (m)->flags
 302
 303 #define DRM_RECT_FMT    "%dx%d%+d%+d"
 304 #define DRM_RECT_ARG(r) drm_rect_width(r), drm_rect_height(r), (r)->x1, (r)->y1
 305
 306 /* for rect's in fixed-point format: */
 307 #define DRM_RECT_FP_FMT "%d.%06ux%d.%06u%+d.%06u%+d.%06u"
 308 #define DRM_RECT_FP_ARG(r) \
 309                 drm_rect_width(r) >> 16, ((drm_rect_width(r) & 0xffff) * 15625) >> 10, \
 310                 drm_rect_height(r) >> 16, ((drm_rect_height(r) & 0xffff) * 15625) >> 10, \
 311                 (r)->x1 >> 16, (((r)->x1 & 0xffff) * 15625) >> 10, \
 312                 (r)->y1 >> 16, (((r)->y1 & 0xffff) * 15625) >> 10
 313
 314 /*@}*/
 315
 316 /***********************************************************************/
 317 /** \name Internal types and structures */
 318 /*@{*/
 319
 320 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
 321
 322
 323 /* Flags and return codes for get_vblank_timestamp() driver function. */
 324 #define DRM_CALLED_FROM_VBLIRQ 1
 325 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
 326
 327 /* get_scanout_position() return flags */
 328 #define DRM_SCANOUTPOS_VALID        (1 << 0)
 329 #define DRM_SCANOUTPOS_IN_VBLANK    (1 << 1)
 330 #define DRM_SCANOUTPOS_ACCURATE     (1 << 2)
 331
 332 /**
 333  * DRM device structure. This structure represent a complete card that
 334  * may contain multiple heads.
 335  */
 336 struct drm_device {
 337         struct list_head legacy_dev_list;/**< list of devices per driver for stealth attach cleanup */
 338         int if_version;                 /**< Highest interface version set */
 339
 340         /** \name Lifetime Management */
 341         /*@{ */
 342         struct kref ref;                /**< Object ref-count */
 343         struct device *dev;             /**< Device structure of bus-device */
 344         struct drm_driver *driver;      /**< DRM driver managing the device */
 345         void *dev_private;              /**< DRM driver private data */
 346         struct drm_minor *control;              /**< Control node */
 347         struct drm_minor *primary;              /**< Primary node */
 348         struct drm_minor *render;               /**< Render node */
 349         bool registered;
 350
 351         /* currently active master for this device. Protected by master_mutex */
 352         struct drm_master *master;
 353
 354         atomic_t unplugged;                     /**< Flag whether dev is dead */
 355         struct inode *anon_inode;               /**< inode for private address-space */
 356         char *unique;                           /**< unique name of the device */
 357         /*@} */
 358
 359         /** \name Locks */
 360         /*@{ */
 361         struct mutex struct_mutex;      /**< For others */
 362         struct mutex master_mutex;      /**< For drm_minor::master and drm_file::is_master */
 363         /*@} */
 364
 365         /** \name Usage Counters */
 366         /*@{ */
 367         int open_count;                 /**< Outstanding files open, protected by drm_global_mutex. */
 368         spinlock_t buf_lock;            /**< For drm_device::buf_use and a few other things. */
 369         int buf_use;                    /**< Buffers in use -- cannot alloc */
 370         atomic_t buf_alloc;             /**< Buffer allocation in progress */
 371         /*@} */
 372
 373         struct mutex filelist_mutex;
 374         struct list_head filelist;
 375
 376         /** \name Memory management */
 377         /*@{ */
 378         struct list_head maplist;       /**< Linked list of regions */
 379         struct drm_open_hash map_hash;  /**< User token hash table for maps */
 380
 381         /** \name Context handle management */
 382         /*@{ */
 383         struct list_head ctxlist;       /**< Linked list of context handles */
 384         struct mutex ctxlist_mutex;     /**< For ctxlist */
 385
 386         struct idr ctx_idr;
 387
 388         struct list_head vmalist;       /**< List of vmas (for debugging) */
 389
 390         /*@} */
 391
 392         /** \name DMA support */
 393         /*@{ */
 394         struct drm_device_dma *dma;             /**< Optional pointer for DMA support */
 395         /*@} */
 396
 397         /** \name Context support */
 398         /*@{ */
 399
 400         __volatile__ long context_flag; /**< Context swapping flag */
 401         int last_context;               /**< Last current context */
 402         /*@} */
 403
 404         /** \name VBLANK IRQ support */
 405         /*@{ */
 406         bool irq_enabled;
 407         int irq;
 408
 409         /*
 410          * If true, vblank interrupt will be disabled immediately when the
 411          * refcount drops to zero, as opposed to via the vblank disable
 412          * timer.
 413          * This can be set to true it the hardware has a working vblank
 414          * counter and the driver uses drm_vblank_on() and drm_vblank_off()
 415          * appropriately.
 416          */
 417         bool vblank_disable_immediate;
 418
 419         /* array of size num_crtcs */
 420         struct drm_vblank_crtc *vblank;
 421
 422         spinlock_t vblank_time_lock;    /**< Protects vblank count and time updates during vblank enable/disable */
 423         spinlock_t vbl_lock;
 424
 425         u32 max_vblank_count;           /**< size of vblank counter register */
 426
 427         /**
 428          * List of events
 429          */
 430         struct list_head vblank_event_list;
 431         spinlock_t event_lock;
 432
 433         /*@} */
 434
 435         struct drm_agp_head *agp;       /**< AGP data */
 436
 437         struct pci_dev *pdev;           /**< PCI device structure */
 438 #ifdef __alpha__
 439         struct pci_controller *hose;
 440 #endif
 441
 442         struct virtio_device *virtdev;
 443
 444         struct drm_sg_mem *sg;  /**< Scatter gather memory */
 445         unsigned int num_crtcs;                  /**< Number of CRTCs on this device */
 446
 447         struct {
 448                 int context;
 449                 struct drm_hw_lock *lock;
 450         } sigdata;
 451
 452         struct drm_local_map *agp_buffer_map;
 453         unsigned int agp_buffer_token;
 454
 455         struct drm_mode_config mode_config;     /**< Current mode config */
 456
 457         /** \name GEM information */
 458         /*@{ */
 459         struct mutex object_name_lock;
 460         struct idr object_name_idr;
 461         struct drm_vma_offset_manager *vma_offset_manager;
 462         /*@} */
 463         int switch_power_state;
 464 };
 465
 466 /**
 467  * drm_drv_uses_atomic_modeset - check if the driver implements
 468  * atomic_commit()
 469  * @dev: DRM device
 470  *
 471  * This check is useful if drivers do not have DRIVER_ATOMIC set but
 472  * have atomic modesetting internally implemented.
 473  */
 474 static inline bool drm_drv_uses_atomic_modeset(struct drm_device *dev)
 475 {
 476         return dev->mode_config.funcs->atomic_commit != NULL;
 477 }
 478
 479 #include <drm/drm_irq.h>
 480
 481 #define DRM_SWITCH_POWER_ON 0
 482 #define DRM_SWITCH_POWER_OFF 1
 483 #define DRM_SWITCH_POWER_CHANGING 2
 484 #define DRM_SWITCH_POWER_DYNAMIC_OFF 3
 485
 486 static __inline__ int drm_core_check_feature(struct drm_device *dev,
 487                                              int feature)
 488 {
 489         return ((dev->driver->driver_features & feature) ? 1 : 0);
 490 }
 491
 492 static inline void drm_device_set_unplugged(struct drm_device *dev)
 493 {
 494         smp_wmb();
 495         atomic_set(&dev->unplugged, 1);
 496 }
 497
 498 static inline int drm_device_is_unplugged(struct drm_device *dev)
 499 {
 500         int ret = atomic_read(&dev->unplugged);
 501         smp_rmb();
 502         return ret;
 503 }
 504
 505 /******************************************************************/
 506 /** \name Internal function definitions */
 507 /*@{*/
 508
 509                                 /* Driver support (drm_drv.h) */
 510
 511 /*
 512  * These are exported to drivers so that they can implement fencing using
 513  * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
 514  */
 515
 516 /*@}*/
 517
 518 /* returns true if currently okay to sleep */
 519 static __inline__ bool drm_can_sleep(void)
 520 {
 521         if (in_atomic() || in_dbg_master() || irqs_disabled())
 522                 return false;
 523         return true;
 524 }
 525
 526 /* helper for handling conditionals in various for_each macros */
 527 #define for_each_if(condition) if (!(condition)) {} else
 528
 529 #endif