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