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
  57 /**
  58  * struct drm_driver - DRM driver structure
  59  *
  60  * This structure represent the common code for a family of cards. There will
  61  * one drm_device for each card present in this family. It contains lots of
  62  * vfunc entries, and a pile of those probably should be moved to more
  63  * appropriate places like &drm_mode_config_funcs or into a new operations
  64  * structure for GEM drivers.
  65  */
  66 struct drm_driver {
  67
  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          * Returns:
  80          *
  81          * Zero on success, non-zero value on failure.
  82          */
  83         int (*load) (struct drm_device *, unsigned long flags);
  84         int (*firstopen) (struct drm_device *);
  85         int (*open) (struct drm_device *, struct drm_file *);
  86         void (*preclose) (struct drm_device *, struct drm_file *file_priv);
  87         void (*postclose) (struct drm_device *, struct drm_file *);
  88         void (*lastclose) (struct drm_device *);
  89
  90         /**
  91          * @unload:
  92          *
  93          * Reverse the effects of the driver load callback.  Ideally,
  94          * the clean up performed by the driver should happen in the
  95          * reverse order of the initialization.  Similarly to the load
  96          * hook, this handler is deprecated and its usage should be
  97          * dropped in favor of an open-coded teardown function at the
  98          * driver layer.  See drm_dev_unregister() and drm_dev_unref()
  99          * for the proper way to remove a &struct drm_device.
 100          *
 101          * The unload() hook is called right after unregistering
 102          * the device.
 103          *
 104          */
 105         void (*unload) (struct drm_device *);
 106         int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
 107         int (*dma_quiescent) (struct drm_device *);
 108         int (*context_dtor) (struct drm_device *dev, int context);
 109         int (*set_busid)(struct drm_device *dev, struct drm_master *master);
 110
 111         /**
 112          * @get_vblank_counter:
 113          *
 114          * Driver callback for fetching a raw hardware vblank counter for the
 115          * CRTC specified with the pipe argument.  If a device doesn't have a
 116          * hardware counter, the driver can simply use
 117          * drm_vblank_no_hw_counter() function. The DRM core will account for
 118          * missed vblank events while interrupts where disabled based on system
 119          * timestamps.
 120          *
 121          * Wraparound handling and loss of events due to modesetting is dealt
 122          * with in the DRM core code, as long as drivers call
 123          * drm_crtc_vblank_off() and drm_crtc_vblank_on() when disabling or
 124          * enabling a CRTC.
 125          *
 126          * Returns:
 127          *
 128          * Raw vblank counter value.
 129          */
 130         u32 (*get_vblank_counter) (struct drm_device *dev, unsigned int pipe);
 131
 132         /**
 133          * @enable_vblank:
 134          *
 135          * Enable vblank interrupts for the CRTC specified with the pipe
 136          * argument.
 137          *
 138          * Returns:
 139          *
 140          * Zero on success, appropriate errno if the given @crtc's vblank
 141          * interrupt cannot be enabled.
 142          */
 143         int (*enable_vblank) (struct drm_device *dev, unsigned int pipe);
 144
 145         /**
 146          * @disable_vblank:
 147          *
 148          * Disable vblank interrupts for the CRTC specified with the pipe
 149          * argument.
 150          */
 151         void (*disable_vblank) (struct drm_device *dev, unsigned int pipe);
 152
 153         /**
 154          * @get_scanout_position:
 155          *
 156          * Called by vblank timestamping code.
 157          *
 158          * Returns the current display scanout position from a crtc, and an
 159          * optional accurate ktime_get() timestamp of when position was
 160          * measured. Note that this is a helper callback which is only used if a
 161          * driver uses drm_calc_vbltimestamp_from_scanoutpos() for the
 162          * @get_vblank_timestamp callback.
 163          *
 164          * Parameters:
 165          *
 166          * dev:
 167          *     DRM device.
 168          * pipe:
 169          *     Id of the crtc to query.
 170          * flags:
 171          *     Flags from the caller (DRM_CALLED_FROM_VBLIRQ or 0).
 172          * vpos:
 173          *     Target location for current vertical scanout position.
 174          * hpos:
 175          *     Target location for current horizontal scanout position.
 176          * stime:
 177          *     Target location for timestamp taken immediately before
 178          *     scanout position query. Can be NULL to skip timestamp.
 179          * etime:
 180          *     Target location for timestamp taken immediately after
 181          *     scanout position query. Can be NULL to skip timestamp.
 182          * mode:
 183          *     Current display timings.
 184          *
 185          * Returns vpos as a positive number while in active scanout area.
 186          * Returns vpos as a negative number inside vblank, counting the number
 187          * of scanlines to go until end of vblank, e.g., -1 means "one scanline
 188          * until start of active scanout / end of vblank."
 189          *
 190          * Returns:
 191          *
 192          * Flags, or'ed together as follows:
 193          *
 194          * DRM_SCANOUTPOS_VALID:
 195          *     Query successful.
 196          * DRM_SCANOUTPOS_INVBL:
 197          *     Inside vblank.
 198          * DRM_SCANOUTPOS_ACCURATE: Returned position is accurate. A lack of
 199          *     this flag means that returned position may be offset by a
 200          *     constant but unknown small number of scanlines wrt. real scanout
 201          *     position.
 202          *
 203          */
 204         int (*get_scanout_position) (struct drm_device *dev, unsigned int pipe,
 205                                      unsigned int flags, int *vpos, int *hpos,
 206                                      ktime_t *stime, ktime_t *etime,
 207                                      const struct drm_display_mode *mode);
 208
 209         /**
 210          * @get_vblank_timestamp:
 211          *
 212          * Called by drm_get_last_vbltimestamp(). Should return a precise
 213          * timestamp when the most recent VBLANK interval ended or will end.
 214          *
 215          * Specifically, the timestamp in @vblank_time should correspond as
 216          * closely as possible to the time when the first video scanline of
 217          * the video frame after the end of VBLANK will start scanning out,
 218          * the time immediately after end of the VBLANK interval. If the
 219          * @crtc is currently inside VBLANK, this will be a time in the future.
 220          * If the @crtc is currently scanning out a frame, this will be the
 221          * past start time of the current scanout. This is meant to adhere
 222          * to the OpenML OML_sync_control extension specification.
 223          *
 224          * Paramters:
 225          *
 226          * dev:
 227          *     dev DRM device handle.
 228          * pipe:
 229          *     crtc for which timestamp should be returned.
 230          * max_error:
 231          *     Maximum allowable timestamp error in nanoseconds.
 232          *     Implementation should strive to provide timestamp
 233          *     with an error of at most max_error nanoseconds.
 234          *     Returns true upper bound on error for timestamp.
 235          * vblank_time:
 236          *     Target location for returned vblank timestamp.
 237          * flags:
 238          *     0 = Defaults, no special treatment needed.
 239          *     DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
 240          *     irq handler. Some drivers need to apply some workarounds
 241          *     for gpu-specific vblank irq quirks if flag is set.
 242          *
 243          * Returns:
 244          *
 245          * Zero if timestamping isn't supported in current display mode or a
 246          * negative number on failure. A positive status code on success,
 247          * which describes how the vblank_time timestamp was computed.
 248          */
 249         int (*get_vblank_timestamp) (struct drm_device *dev, unsigned int pipe,
 250                                      int *max_error,
 251                                      struct timeval *vblank_time,
 252                                      unsigned flags);
 253
 254         /* these have to be filled in */
 255
 256         irqreturn_t(*irq_handler) (int irq, void *arg);
 257         void (*irq_preinstall) (struct drm_device *dev);
 258         int (*irq_postinstall) (struct drm_device *dev);
 259         void (*irq_uninstall) (struct drm_device *dev);
 260
 261         /**
 262          * @master_create:
 263          *
 264          * Called whenever a new master is created. Only used by vmwgfx.
 265          */
 266         int (*master_create)(struct drm_device *dev, struct drm_master *master);
 267
 268         /**
 269          * @master_destroy:
 270          *
 271          * Called whenever a master is destroyed. Only used by vmwgfx.
 272          */
 273         void (*master_destroy)(struct drm_device *dev, struct drm_master *master);
 274
 275         /**
 276          * @master_set:
 277          *
 278          * Called whenever the minor master is set. Only used by vmwgfx.
 279          */
 280         int (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
 281                           bool from_open);
 282         /**
 283          * @master_drop:
 284          *
 285          * Called whenever the minor master is dropped. Only used by vmwgfx.
 286          */
 287         void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv);
 288
 289         int (*debugfs_init)(struct drm_minor *minor);
 290         void (*debugfs_cleanup)(struct drm_minor *minor);
 291
 292         /**
 293          * @gem_free_object: deconstructor for drm_gem_objects
 294          *
 295          * This is deprecated and should not be used by new drivers. Use
 296          * @gem_free_object_unlocked instead.
 297          */
 298         void (*gem_free_object) (struct drm_gem_object *obj);
 299
 300         /**
 301          * @gem_free_object_unlocked: deconstructor for drm_gem_objects
 302          *
 303          * This is for drivers which are not encumbered with &drm_device.struct_mutex
 304          * legacy locking schemes. Use this hook instead of @gem_free_object.
 305          */
 306         void (*gem_free_object_unlocked) (struct drm_gem_object *obj);
 307
 308         int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
 309         void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
 310
 311         /**
 312          * @gem_create_object: constructor for gem objects
 313          *
 314          * Hook for allocating the GEM object struct, for use by core
 315          * helpers.
 316          */
 317         struct drm_gem_object *(*gem_create_object)(struct drm_device *dev,
 318                                                     size_t size);
 319
 320         /* prime: */
 321         /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */
 322         int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
 323                                 uint32_t handle, uint32_t flags, int *prime_fd);
 324         /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */
 325         int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
 326                                 int prime_fd, uint32_t *handle);
 327         /* export GEM -> dmabuf */
 328         struct dma_buf * (*gem_prime_export)(struct drm_device *dev,
 329                                 struct drm_gem_object *obj, int flags);
 330         /* import dmabuf -> GEM */
 331         struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
 332                                 struct dma_buf *dma_buf);
 333         /* low-level interface used by drm_gem_prime_{import,export} */
 334         int (*gem_prime_pin)(struct drm_gem_object *obj);
 335         void (*gem_prime_unpin)(struct drm_gem_object *obj);
 336         struct reservation_object * (*gem_prime_res_obj)(
 337                                 struct drm_gem_object *obj);
 338         struct sg_table *(*gem_prime_get_sg_table)(struct drm_gem_object *obj);
 339         struct drm_gem_object *(*gem_prime_import_sg_table)(
 340                                 struct drm_device *dev,
 341                                 struct dma_buf_attachment *attach,
 342                                 struct sg_table *sgt);
 343         void *(*gem_prime_vmap)(struct drm_gem_object *obj);
 344         void (*gem_prime_vunmap)(struct drm_gem_object *obj, void *vaddr);
 345         int (*gem_prime_mmap)(struct drm_gem_object *obj,
 346                                 struct vm_area_struct *vma);
 347
 348         /**
 349          * @dumb_create:
 350          *
 351          * This creates a new dumb buffer in the driver's backing storage manager (GEM,
 352          * TTM or something else entirely) and returns the resulting buffer handle. This
 353          * handle can then be wrapped up into a framebuffer modeset object.
 354          *
 355          * Note that userspace is not allowed to use such objects for render
 356          * acceleration - drivers must create their own private ioctls for such a use
 357          * case.
 358          *
 359          * Width, height and depth are specified in the &drm_mode_create_dumb
 360          * argument. The callback needs to fill the handle, pitch and size for
 361          * the created buffer.
 362          *
 363          * Called by the user via ioctl.
 364          *
 365          * Returns:
 366          *
 367          * Zero on success, negative errno on failure.
 368          */
 369         int (*dumb_create)(struct drm_file *file_priv,
 370                            struct drm_device *dev,
 371                            struct drm_mode_create_dumb *args);
 372         /**
 373          * @dumb_map_offset:
 374          *
 375          * Allocate an offset in the drm device node's address space to be able to
 376          * memory map a dumb buffer. GEM-based drivers must use
 377          * drm_gem_create_mmap_offset() to implement this.
 378          *
 379          * Called by the user via ioctl.
 380          *
 381          * Returns:
 382          *
 383          * Zero on success, negative errno on failure.
 384          */
 385         int (*dumb_map_offset)(struct drm_file *file_priv,
 386                                struct drm_device *dev, uint32_t handle,
 387                                uint64_t *offset);
 388         /**
 389          * @dumb_destroy:
 390          *
 391          * This destroys the userspace handle for the given dumb backing storage buffer.
 392          * Since buffer objects must be reference counted in the kernel a buffer object
 393          * won't be immediately freed if a framebuffer modeset object still uses it.
 394          *
 395          * Called by the user via ioctl.
 396          *
 397          * Returns:
 398          *
 399          * Zero on success, negative errno on failure.
 400          */
 401         int (*dumb_destroy)(struct drm_file *file_priv,
 402                             struct drm_device *dev,
 403                             uint32_t handle);
 404
 405         /* Driver private ops for this object */
 406         const struct vm_operations_struct *gem_vm_ops;
 407
 408         int major;
 409         int minor;
 410         int patchlevel;
 411         char *name;
 412         char *desc;
 413         char *date;
 414
 415         u32 driver_features;
 416         int dev_priv_size;
 417         const struct drm_ioctl_desc *ioctls;
 418         int num_ioctls;
 419         const struct file_operations *fops;
 420
 421         /* List of devices hanging off this driver with stealth attach. */
 422         struct list_head legacy_dev_list;
 423 };
 424
 425 extern __printf(6, 7)
 426 void drm_dev_printk(const struct device *dev, const char *level,
 427                     unsigned int category, const char *function_name,
 428                     const char *prefix, const char *format, ...);
 429 extern __printf(3, 4)
 430 void drm_printk(const char *level, unsigned int category,
 431                 const char *format, ...);
 432 extern unsigned int drm_debug;
 433
 434 int drm_dev_init(struct drm_device *dev,
 435                  struct drm_driver *driver,
 436                  struct device *parent);
 437 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
 438                                  struct device *parent);
 439 int drm_dev_register(struct drm_device *dev, unsigned long flags);
 440 void drm_dev_unregister(struct drm_device *dev);
 441
 442 void drm_dev_ref(struct drm_device *dev);
 443 void drm_dev_unref(struct drm_device *dev);
 444 void drm_put_dev(struct drm_device *dev);
 445 void drm_unplug_dev(struct drm_device *dev);
 446
 447 int drm_dev_set_unique(struct drm_device *dev, const char *name);
 448
 449
 450 #endif