include/drm/drm_drv.h

   1 /*
   2  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
   3  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
   4  * Copyright (c) 2009-2010, Code Aurora Forum.
   5  * Copyright 2016 Intel Corp.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11  * and/or sell copies of the Software, and to permit persons to whom the
  12  * Software is furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the next
  15  * paragraph) shall be included in all copies or substantial portions of the
  16  * Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  21  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  22  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  23  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  24  * OTHER DEALINGS IN THE SOFTWARE.
  25  */
  26
  27 #ifndef _DRM_DRV_H_
  28 #define _DRM_DRV_H_
  29
  30 #include <linux/list.h>
  31 #include <linux/irqreturn.h>
  32
  33 struct drm_device;
  34 struct drm_file;
  35 struct drm_gem_object;
  36 struct drm_master;
  37 struct drm_minor;
  38 struct dma_buf_attachment;
  39 struct drm_display_mode;
  40 struct drm_mode_create_dumb;
  41
  42 /* driver capabilities and requirements mask */
  43 #define DRIVER_USE_AGP                  0x1
  44 #define DRIVER_LEGACY                   0x2
  45 #define DRIVER_PCI_DMA                  0x8
  46 #define DRIVER_SG                       0x10
  47 #define DRIVER_HAVE_DMA                 0x20
  48 #define DRIVER_HAVE_IRQ                 0x40
  49 #define DRIVER_IRQ_SHARED               0x80
  50 #define DRIVER_GEM                      0x1000
  51 #define DRIVER_MODESET                  0x2000
  52 #define DRIVER_PRIME                    0x4000
  53 #define DRIVER_RENDER                   0x8000
  54 #define DRIVER_ATOMIC                   0x10000
  55 #define DRIVER_KMS_LEGACY_CONTEXT       0x20000
  56 #define DRIVER_SYNCOBJ                  0x40000
  57
  58 /**
  59  * struct drm_driver - DRM driver structure
  60  *
  61  * This structure represent the common code for a family of cards. There will
  62  * one drm_device for each card present in this family. It contains lots of
  63  * vfunc entries, and a pile of those probably should be moved to more
  64  * appropriate places like &drm_mode_config_funcs or into a new operations
  65  * structure for GEM drivers.
  66  */
  67 struct drm_driver {
  68         /**
  69          * @load:
  70          *
  71          * Backward-compatible driver callback to complete
  72          * initialization steps after the driver is registered.  For
  73          * this reason, may suffer from race conditions and its use is
  74          * deprecated for new drivers.  It is therefore only supported
  75          * for existing drivers not yet converted to the new scheme.
  76          * See drm_dev_init() and drm_dev_register() for proper and
  77          * race-free way to set up a &struct drm_device.
  78          *
  79          * This is deprecated, do not use!
  80          *
  81          * Returns:
  82          *
  83          * Zero on success, non-zero value on failure.
  84          */
  85         int (*load) (struct drm_device *, unsigned long flags);
  86
  87         /**
  88          * @open:
  89          *
  90          * Driver callback when a new &struct drm_file is opened. Useful for
  91          * setting up driver-private data structures like buffer allocators,
  92          * execution contexts or similar things. Such driver-private resources
  93          * must be released again in @postclose.
  94          *
  95          * Since the display/modeset side of DRM can only be owned by exactly
  96          * one &struct drm_file (see &drm_file.is_master and &drm_device.master)
  97          * there should never be a need to set up any modeset related resources
  98          * in this callback. Doing so would be a driver design bug.
  99          *
 100          * Returns:
 101          *
 102          * 0 on success, a negative error code on failure, which will be
 103          * promoted to userspace as the result of the open() system call.
 104          */
 105         int (*open) (struct drm_device *, struct drm_file *);
 106
 107         /**
 108          * @postclose:
 109          *
 110          * One of the driver callbacks when a new &struct drm_file is closed.
 111          * Useful for tearing down driver-private data structures allocated in
 112          * @open like buffer allocators, execution contexts or similar things.
 113          *
 114          * Since the display/modeset side of DRM can only be owned by exactly
 115          * one &struct drm_file (see &drm_file.is_master and &drm_device.master)
 116          * there should never be a need to tear down any modeset related
 117          * resources in this callback. Doing so would be a driver design bug.
 118          */
 119         void (*postclose) (struct drm_device *, struct drm_file *);
 120
 121         /**
 122          * @lastclose:
 123          *
 124          * Called when the last &struct drm_file has been closed and there's
 125          * currently no userspace client for the &struct drm_device.
 126          *
 127          * Modern drivers should only use this to force-restore the fbdev
 128          * framebuffer using drm_fb_helper_restore_fbdev_mode_unlocked().
 129          * Anything else would indicate there's something seriously wrong.
 130          * Modern drivers can also use this to execute delayed power switching
 131          * state changes, e.g. in conjunction with the :ref:`vga_switcheroo`
 132          * infrastructure.
 133          *
 134          * This is called after @postclose hook has been called.
 135          *
 136          * NOTE:
 137          *
 138          * All legacy drivers use this callback to de-initialize the hardware.
 139          * This is purely because of the shadow-attach model, where the DRM
 140          * kernel driver does not really own the hardware. Instead ownershipe is
 141          * handled with the help of userspace through an inheritedly racy dance
 142          * to set/unset the VT into raw mode.
 143          *
 144          * Legacy drivers initialize the hardware in the @firstopen callback,
 145          * which isn't even called for modern drivers.
 146          */
 147         void (*lastclose) (struct drm_device *);
 148
 149         /**
 150          * @unload:
 151          *
 152          * Reverse the effects of the driver load callback.  Ideally,
 153          * the clean up performed by the driver should happen in the
 154          * reverse order of the initialization.  Similarly to the load
 155          * hook, this handler is deprecated and its usage should be
 156          * dropped in favor of an open-coded teardown function at the
 157          * driver layer.  See drm_dev_unregister() and drm_dev_unref()
 158          * for the proper way to remove a &struct drm_device.
 159          *
 160          * The unload() hook is called right after unregistering
 161          * the device.
 162          *
 163          */
 164         void (*unload) (struct drm_device *);
 165
 166         /**
 167          * @release:
 168          *
 169          * Optional callback for destroying device data after the final
 170          * reference is released, i.e. the device is being destroyed. Drivers
 171          * using this callback are responsible for calling drm_dev_fini()
 172          * to finalize the device and then freeing the struct themselves.
 173          */
 174         void (*release) (struct drm_device *);
 175
 176         int (*set_busid)(struct drm_device *dev, struct drm_master *master);
 177
 178         /**
 179          * @get_vblank_counter:
 180          *
 181          * Driver callback for fetching a raw hardware vblank counter for the
 182          * CRTC specified with the pipe argument.  If a device doesn't have a
 183          * hardware counter, the driver can simply leave the hook as NULL.
 184          * The DRM core will account for missed vblank events while interrupts
 185          * where disabled based on system timestamps.
 186          *
 187          * Wraparound handling and loss of events due to modesetting is dealt
 188          * with in the DRM core code, as long as drivers call
 189          * drm_crtc_vblank_off() and drm_crtc_vblank_on() when disabling or
 190          * enabling a CRTC.
 191          *
 192          * This is deprecated and should not be used by new drivers.
 193          * Use &drm_crtc_funcs.get_vblank_counter instead.
 194          *
 195          * Returns:
 196          *
 197          * Raw vblank counter value.
 198          */
 199         u32 (*get_vblank_counter) (struct drm_device *dev, unsigned int pipe);
 200
 201         /**
 202          * @enable_vblank:
 203          *
 204          * Enable vblank interrupts for the CRTC specified with the pipe
 205          * argument.
 206          *
 207          * This is deprecated and should not be used by new drivers.
 208          * Use &drm_crtc_funcs.enable_vblank instead.
 209          *
 210          * Returns:
 211          *
 212          * Zero on success, appropriate errno if the given @crtc's vblank
 213          * interrupt cannot be enabled.
 214          */
 215         int (*enable_vblank) (struct drm_device *dev, unsigned int pipe);
 216
 217         /**
 218          * @disable_vblank:
 219          *
 220          * Disable vblank interrupts for the CRTC specified with the pipe
 221          * argument.
 222          *
 223          * This is deprecated and should not be used by new drivers.
 224          * Use &drm_crtc_funcs.disable_vblank instead.
 225          */
 226         void (*disable_vblank) (struct drm_device *dev, unsigned int pipe);
 227
 228         /**
 229          * @get_scanout_position:
 230          *
 231          * Called by vblank timestamping code.
 232          *
 233          * Returns the current display scanout position from a crtc, and an
 234          * optional accurate ktime_get() timestamp of when position was
 235          * measured. Note that this is a helper callback which is only used if a
 236          * driver uses drm_calc_vbltimestamp_from_scanoutpos() for the
 237          * @get_vblank_timestamp callback.
 238          *
 239          * Parameters:
 240          *
 241          * dev:
 242          *     DRM device.
 243          * pipe:
 244          *     Id of the crtc to query.
 245          * in_vblank_irq:
 246          *     True when called from drm_crtc_handle_vblank().  Some drivers
 247          *     need to apply some workarounds for gpu-specific vblank irq quirks
 248          *     if flag is set.
 249          * vpos:
 250          *     Target location for current vertical scanout position.
 251          * hpos:
 252          *     Target location for current horizontal scanout position.
 253          * stime:
 254          *     Target location for timestamp taken immediately before
 255          *     scanout position query. Can be NULL to skip timestamp.
 256          * etime:
 257          *     Target location for timestamp taken immediately after
 258          *     scanout position query. Can be NULL to skip timestamp.
 259          * mode:
 260          *     Current display timings.
 261          *
 262          * Returns vpos as a positive number while in active scanout area.
 263          * Returns vpos as a negative number inside vblank, counting the number
 264          * of scanlines to go until end of vblank, e.g., -1 means "one scanline
 265          * until start of active scanout / end of vblank."
 266          *
 267          * Returns:
 268          *
 269          * True on success, false if a reliable scanout position counter could
 270          * not be read out.
 271          *
 272          * FIXME:
 273          *
 274          * Since this is a helper to implement @get_vblank_timestamp, we should
 275          * move it to &struct drm_crtc_helper_funcs, like all the other
 276          * helper-internal hooks.
 277          */
 278         bool (*get_scanout_position) (struct drm_device *dev, unsigned int pipe,
 279                                       bool in_vblank_irq, int *vpos, int *hpos,
 280                                       ktime_t *stime, ktime_t *etime,
 281                                       const struct drm_display_mode *mode);
 282
 283         /**
 284          * @get_vblank_timestamp:
 285          *
 286          * Called by drm_get_last_vbltimestamp(). Should return a precise
 287          * timestamp when the most recent VBLANK interval ended or will end.
 288          *
 289          * Specifically, the timestamp in @vblank_time should correspond as
 290          * closely as possible to the time when the first video scanline of
 291          * the video frame after the end of VBLANK will start scanning out,
 292          * the time immediately after end of the VBLANK interval. If the
 293          * @crtc is currently inside VBLANK, this will be a time in the future.
 294          * If the @crtc is currently scanning out a frame, this will be the
 295          * past start time of the current scanout. This is meant to adhere
 296          * to the OpenML OML_sync_control extension specification.
 297          *
 298          * Paramters:
 299          *
 300          * dev:
 301          *     dev DRM device handle.
 302          * pipe:
 303          *     crtc for which timestamp should be returned.
 304          * max_error:
 305          *     Maximum allowable timestamp error in nanoseconds.
 306          *     Implementation should strive to provide timestamp
 307          *     with an error of at most max_error nanoseconds.
 308          *     Returns true upper bound on error for timestamp.
 309          * vblank_time:
 310          *     Target location for returned vblank timestamp.
 311          * in_vblank_irq:
 312          *     True when called from drm_crtc_handle_vblank().  Some drivers
 313          *     need to apply some workarounds for gpu-specific vblank irq quirks
 314          *     if flag is set.
 315          *
 316          * Returns:
 317          *
 318          * True on success, false on failure, which means the core should
 319          * fallback to a simple timestamp taken in drm_crtc_handle_vblank().
 320          *
 321          * FIXME:
 322          *
 323          * We should move this hook to &struct drm_crtc_funcs like all the other
 324          * vblank hooks.
 325          */
 326         bool (*get_vblank_timestamp) (struct drm_device *dev, unsigned int pipe,
 327                                      int *max_error,
 328                                      struct timeval *vblank_time,
 329                                      bool in_vblank_irq);
 330
 331         /**
 332          * @irq_handler:
 333          *
 334          * Interrupt handler called when using drm_irq_install(). Not used by
 335          * drivers which implement their own interrupt handling.
 336          */
 337         irqreturn_t(*irq_handler) (int irq, void *arg);
 338
 339         /**
 340          * @irq_preinstall:
 341          *
 342          * Optional callback used by drm_irq_install() which is called before
 343          * the interrupt handler is registered. This should be used to clear out
 344          * any pending interrupts (from e.g. firmware based drives) and reset
 345          * the interrupt handling registers.
 346          */
 347         void (*irq_preinstall) (struct drm_device *dev);
 348
 349         /**
 350          * @irq_postinstall:
 351          *
 352          * Optional callback used by drm_irq_install() which is called after
 353          * the interrupt handler is registered. This should be used to enable
 354          * interrupt generation in the hardware.
 355          */
 356         int (*irq_postinstall) (struct drm_device *dev);
 357
 358         /**
 359          * @irq_uninstall:
 360          *
 361          * Optional callback used by drm_irq_uninstall() which is called before
 362          * the interrupt handler is unregistered. This should be used to disable
 363          * interrupt generation in the hardware.
 364          */
 365         void (*irq_uninstall) (struct drm_device *dev);
 366
 367         /**
 368          * @master_create:
 369          *
 370          * Called whenever a new master is created. Only used by vmwgfx.
 371          */
 372         int (*master_create)(struct drm_device *dev, struct drm_master *master);
 373
 374         /**
 375          * @master_destroy:
 376          *
 377          * Called whenever a master is destroyed. Only used by vmwgfx.
 378          */
 379         void (*master_destroy)(struct drm_device *dev, struct drm_master *master);
 380
 381         /**
 382          * @master_set:
 383          *
 384          * Called whenever the minor master is set. Only used by vmwgfx.
 385          */
 386         int (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
 387                           bool from_open);
 388         /**
 389          * @master_drop:
 390          *
 391          * Called whenever the minor master is dropped. Only used by vmwgfx.
 392          */
 393         void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv);
 394
 395         int (*debugfs_init)(struct drm_minor *minor);
 396
 397         /**
 398          * @gem_free_object: deconstructor for drm_gem_objects
 399          *
 400          * This is deprecated and should not be used by new drivers. Use
 401          * @gem_free_object_unlocked instead.
 402          */
 403         void (*gem_free_object) (struct drm_gem_object *obj);
 404
 405         /**
 406          * @gem_free_object_unlocked: deconstructor for drm_gem_objects
 407          *
 408          * This is for drivers which are not encumbered with &drm_device.struct_mutex
 409          * legacy locking schemes. Use this hook instead of @gem_free_object.
 410          */
 411         void (*gem_free_object_unlocked) (struct drm_gem_object *obj);
 412
 413         int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
 414         void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
 415
 416         /**
 417          * @gem_create_object: constructor for gem objects
 418          *
 419          * Hook for allocating the GEM object struct, for use by core
 420          * helpers.
 421          */
 422         struct drm_gem_object *(*gem_create_object)(struct drm_device *dev,
 423                                                     size_t size);
 424
 425         /* prime: */
 426         /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */
 427         int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
 428                                 uint32_t handle, uint32_t flags, int *prime_fd);
 429         /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */
 430         int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
 431                                 int prime_fd, uint32_t *handle);
 432         /* export GEM -> dmabuf */
 433         struct dma_buf * (*gem_prime_export)(struct drm_device *dev,
 434                                 struct drm_gem_object *obj, int flags);
 435         /* import dmabuf -> GEM */
 436         struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
 437                                 struct dma_buf *dma_buf);
 438         /* low-level interface used by drm_gem_prime_{import,export} */
 439         int (*gem_prime_pin)(struct drm_gem_object *obj);
 440         void (*gem_prime_unpin)(struct drm_gem_object *obj);
 441         struct reservation_object * (*gem_prime_res_obj)(
 442                                 struct drm_gem_object *obj);
 443         struct sg_table *(*gem_prime_get_sg_table)(struct drm_gem_object *obj);
 444         struct drm_gem_object *(*gem_prime_import_sg_table)(
 445                                 struct drm_device *dev,
 446                                 struct dma_buf_attachment *attach,
 447                                 struct sg_table *sgt);
 448         void *(*gem_prime_vmap)(struct drm_gem_object *obj);
 449         void (*gem_prime_vunmap)(struct drm_gem_object *obj, void *vaddr);
 450         int (*gem_prime_mmap)(struct drm_gem_object *obj,
 451                                 struct vm_area_struct *vma);
 452
 453         /**
 454          * @dumb_create:
 455          *
 456          * This creates a new dumb buffer in the driver's backing storage manager (GEM,
 457          * TTM or something else entirely) and returns the resulting buffer handle. This
 458          * handle can then be wrapped up into a framebuffer modeset object.
 459          *
 460          * Note that userspace is not allowed to use such objects for render
 461          * acceleration - drivers must create their own private ioctls for such a use
 462          * case.
 463          *
 464          * Width, height and depth are specified in the &drm_mode_create_dumb
 465          * argument. The callback needs to fill the handle, pitch and size for
 466          * the created buffer.
 467          *
 468          * Called by the user via ioctl.
 469          *
 470          * Returns:
 471          *
 472          * Zero on success, negative errno on failure.
 473          */
 474         int (*dumb_create)(struct drm_file *file_priv,
 475                            struct drm_device *dev,
 476                            struct drm_mode_create_dumb *args);
 477         /**
 478          * @dumb_map_offset:
 479          *
 480          * Allocate an offset in the drm device node's address space to be able to
 481          * memory map a dumb buffer. GEM-based drivers must use
 482          * drm_gem_create_mmap_offset() to implement this.
 483          *
 484          * Called by the user via ioctl.
 485          *
 486          * Returns:
 487          *
 488          * Zero on success, negative errno on failure.
 489          */
 490         int (*dumb_map_offset)(struct drm_file *file_priv,
 491                                struct drm_device *dev, uint32_t handle,
 492                                uint64_t *offset);
 493         /**
 494          * @dumb_destroy:
 495          *
 496          * This destroys the userspace handle for the given dumb backing storage buffer.
 497          * Since buffer objects must be reference counted in the kernel a buffer object
 498          * won't be immediately freed if a framebuffer modeset object still uses it.
 499          *
 500          * Called by the user via ioctl.
 501          *
 502          * Returns:
 503          *
 504          * Zero on success, negative errno on failure.
 505          */
 506         int (*dumb_destroy)(struct drm_file *file_priv,
 507                             struct drm_device *dev,
 508                             uint32_t handle);
 509
 510         /* Driver private ops for this object */
 511         const struct vm_operations_struct *gem_vm_ops;
 512
 513         int major;
 514         int minor;
 515         int patchlevel;
 516         char *name;
 517         char *desc;
 518         char *date;
 519
 520         u32 driver_features;
 521         const struct drm_ioctl_desc *ioctls;
 522         int num_ioctls;
 523         const struct file_operations *fops;
 524
 525         /* Everything below here is for legacy driver, never use! */
 526         /* private: */
 527
 528         /* List of devices hanging off this driver with stealth attach. */
 529         struct list_head legacy_dev_list;
 530         int (*firstopen) (struct drm_device *);
 531         void (*preclose) (struct drm_device *, struct drm_file *file_priv);
 532         int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
 533         int (*dma_quiescent) (struct drm_device *);
 534         int (*context_dtor) (struct drm_device *dev, int context);
 535         int dev_priv_size;
 536 };
 537
 538 __printf(6, 7)
 539 void drm_dev_printk(const struct device *dev, const char *level,
 540                     unsigned int category, const char *function_name,
 541                     const char *prefix, const char *format, ...);
 542 __printf(3, 4)
 543 void drm_printk(const char *level, unsigned int category,
 544                 const char *format, ...);
 545 extern unsigned int drm_debug;
 546
 547 int drm_dev_init(struct drm_device *dev,
 548                  struct drm_driver *driver,
 549                  struct device *parent);
 550 void drm_dev_fini(struct drm_device *dev);
 551
 552 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
 553                                  struct device *parent);
 554 int drm_dev_register(struct drm_device *dev, unsigned long flags);
 555 void drm_dev_unregister(struct drm_device *dev);
 556
 557 void drm_dev_ref(struct drm_device *dev);
 558 void drm_dev_unref(struct drm_device *dev);
 559 void drm_put_dev(struct drm_device *dev);
 560 void drm_unplug_dev(struct drm_device *dev);
 561
 562 int drm_dev_set_unique(struct drm_device *dev, const char *name);
 563
 564
 565 #endif