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.
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:
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
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.
30 #include <linux/list.h>
31 #include <linux/irqreturn.h>
33 #include <drm/drm_device.h>
36 struct drm_gem_object;
39 struct dma_buf_attachment;
40 struct drm_display_mode;
41 struct drm_mode_create_dumb;
45 * enum drm_driver_feature - feature flags
47 * See &drm_driver.driver_features, drm_device.driver_features and
48 * drm_core_check_feature().
50 enum drm_driver_feature {
54 * Driver use the GEM memory manager. This should be set for all modern
61 * Driver supports mode setting interfaces (KMS).
63 DRIVER_MODESET = BIT(1),
67 * Driver supports dedicated render nodes. See also the :ref:`section on
68 * render nodes <drm_render_node>` for details.
70 DRIVER_RENDER = BIT(3),
74 * Driver supports the full atomic modesetting userspace API. Drivers
75 * which only use atomic internally, but do not the support the full
76 * userspace API (e.g. not all properties converted to atomic, or
77 * multi-plane updates are not guaranteed to be tear-free) should not
80 DRIVER_ATOMIC = BIT(4),
84 * Driver supports &drm_syncobj for explicit synchronization of command
87 DRIVER_SYNCOBJ = BIT(5),
89 * @DRIVER_SYNCOBJ_TIMELINE:
91 * Driver supports the timeline flavor of &drm_syncobj for explicit
92 * synchronization of command submission.
94 DRIVER_SYNCOBJ_TIMELINE = BIT(6),
96 /* IMPORTANT: Below are all the legacy flags, add new ones above. */
101 * Set up DRM AGP support, see drm_agp_init(), the DRM core will manage
102 * AGP resources. New drivers don't need this.
104 DRIVER_USE_AGP = BIT(25),
108 * Denote a legacy driver using shadow attach. Do not use.
110 DRIVER_LEGACY = BIT(26),
114 * Driver is capable of PCI DMA, mapping of PCI DMA buffers to userspace
115 * will be enabled. Only for legacy drivers. Do not use.
117 DRIVER_PCI_DMA = BIT(27),
121 * Driver can perform scatter/gather DMA, allocation and mapping of
122 * scatter/gather buffers will be enabled. Only for legacy drivers. Do
130 * Driver supports DMA, the userspace DMA API will be supported. Only
131 * for legacy drivers. Do not use.
133 DRIVER_HAVE_DMA = BIT(29),
137 * Legacy irq support. Only for legacy drivers. Do not use.
139 * New drivers can either use the drm_irq_install() and
140 * drm_irq_uninstall() helper functions, or roll their own irq support
141 * code by calling request_irq() directly.
143 DRIVER_HAVE_IRQ = BIT(30),
145 * @DRIVER_KMS_LEGACY_CONTEXT:
147 * Used only by nouveau for backwards compatibility with existing
148 * userspace. Do not use.
150 DRIVER_KMS_LEGACY_CONTEXT = BIT(31),
154 * struct drm_driver - DRM driver structure
156 * This structure represent the common code for a family of cards. There will be
157 * one &struct drm_device for each card present in this family. It contains lots
158 * of vfunc entries, and a pile of those probably should be moved to more
159 * appropriate places like &drm_mode_config_funcs or into a new operations
160 * structure for GEM drivers.
166 * Backward-compatible driver callback to complete
167 * initialization steps after the driver is registered. For
168 * this reason, may suffer from race conditions and its use is
169 * deprecated for new drivers. It is therefore only supported
170 * for existing drivers not yet converted to the new scheme.
171 * See drm_dev_init() and drm_dev_register() for proper and
172 * race-free way to set up a &struct drm_device.
174 * This is deprecated, do not use!
178 * Zero on success, non-zero value on failure.
180 int (*load) (struct drm_device *, unsigned long flags);
185 * Driver callback when a new &struct drm_file is opened. Useful for
186 * setting up driver-private data structures like buffer allocators,
187 * execution contexts or similar things. Such driver-private resources
188 * must be released again in @postclose.
190 * Since the display/modeset side of DRM can only be owned by exactly
191 * one &struct drm_file (see &drm_file.is_master and &drm_device.master)
192 * there should never be a need to set up any modeset related resources
193 * in this callback. Doing so would be a driver design bug.
197 * 0 on success, a negative error code on failure, which will be
198 * promoted to userspace as the result of the open() system call.
200 int (*open) (struct drm_device *, struct drm_file *);
205 * One of the driver callbacks when a new &struct drm_file is closed.
206 * Useful for tearing down driver-private data structures allocated in
207 * @open like buffer allocators, execution contexts or similar things.
209 * Since the display/modeset side of DRM can only be owned by exactly
210 * one &struct drm_file (see &drm_file.is_master and &drm_device.master)
211 * there should never be a need to tear down any modeset related
212 * resources in this callback. Doing so would be a driver design bug.
214 void (*postclose) (struct drm_device *, struct drm_file *);
219 * Called when the last &struct drm_file has been closed and there's
220 * currently no userspace client for the &struct drm_device.
222 * Modern drivers should only use this to force-restore the fbdev
223 * framebuffer using drm_fb_helper_restore_fbdev_mode_unlocked().
224 * Anything else would indicate there's something seriously wrong.
225 * Modern drivers can also use this to execute delayed power switching
226 * state changes, e.g. in conjunction with the :ref:`vga_switcheroo`
229 * This is called after @postclose hook has been called.
233 * All legacy drivers use this callback to de-initialize the hardware.
234 * This is purely because of the shadow-attach model, where the DRM
235 * kernel driver does not really own the hardware. Instead ownershipe is
236 * handled with the help of userspace through an inheritedly racy dance
237 * to set/unset the VT into raw mode.
239 * Legacy drivers initialize the hardware in the @firstopen callback,
240 * which isn't even called for modern drivers.
242 void (*lastclose) (struct drm_device *);
247 * Reverse the effects of the driver load callback. Ideally,
248 * the clean up performed by the driver should happen in the
249 * reverse order of the initialization. Similarly to the load
250 * hook, this handler is deprecated and its usage should be
251 * dropped in favor of an open-coded teardown function at the
252 * driver layer. See drm_dev_unregister() and drm_dev_put()
253 * for the proper way to remove a &struct drm_device.
255 * The unload() hook is called right after unregistering
259 void (*unload) (struct drm_device *);
264 * Optional callback for destroying device data after the final
265 * reference is released, i.e. the device is being destroyed. Drivers
266 * using this callback are responsible for calling drm_dev_fini()
267 * to finalize the device and then freeing the struct themselves.
269 void (*release) (struct drm_device *);
274 * Interrupt handler called when using drm_irq_install(). Not used by
275 * drivers which implement their own interrupt handling.
277 irqreturn_t(*irq_handler) (int irq, void *arg);
282 * Optional callback used by drm_irq_install() which is called before
283 * the interrupt handler is registered. This should be used to clear out
284 * any pending interrupts (from e.g. firmware based drives) and reset
285 * the interrupt handling registers.
287 void (*irq_preinstall) (struct drm_device *dev);
292 * Optional callback used by drm_irq_install() which is called after
293 * the interrupt handler is registered. This should be used to enable
294 * interrupt generation in the hardware.
296 int (*irq_postinstall) (struct drm_device *dev);
301 * Optional callback used by drm_irq_uninstall() which is called before
302 * the interrupt handler is unregistered. This should be used to disable
303 * interrupt generation in the hardware.
305 void (*irq_uninstall) (struct drm_device *dev);
310 * Called whenever the minor master is set. Only used by vmwgfx.
312 int (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
317 * Called whenever the minor master is dropped. Only used by vmwgfx.
319 void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv);
324 * Allows drivers to create driver-specific debugfs files.
326 int (*debugfs_init)(struct drm_minor *minor);
329 * @gem_free_object: deconstructor for drm_gem_objects
331 * This is deprecated and should not be used by new drivers. Use
332 * &drm_gem_object_funcs.free instead.
334 void (*gem_free_object) (struct drm_gem_object *obj);
337 * @gem_free_object_unlocked: deconstructor for drm_gem_objects
339 * This is deprecated and should not be used by new drivers. Use
340 * &drm_gem_object_funcs.free instead.
341 * Compared to @gem_free_object this is not encumbered with
342 * &drm_device.struct_mutex legacy locking schemes.
344 void (*gem_free_object_unlocked) (struct drm_gem_object *obj);
349 * This callback is deprecated in favour of &drm_gem_object_funcs.open.
351 * Driver hook called upon gem handle creation
353 int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
358 * This callback is deprecated in favour of &drm_gem_object_funcs.close.
360 * Driver hook called upon gem handle release
362 void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
367 * This callback is deprecated in favour of
368 * &drm_gem_object_funcs.print_info.
370 * If driver subclasses struct &drm_gem_object, it can implement this
371 * optional hook for printing additional driver specific info.
373 * drm_printf_indent() should be used in the callback passing it the
376 * This callback is called from drm_gem_print_info().
378 void (*gem_print_info)(struct drm_printer *p, unsigned int indent,
379 const struct drm_gem_object *obj);
382 * @gem_create_object: constructor for gem objects
384 * Hook for allocating the GEM object struct, for use by the CMA and
387 struct drm_gem_object *(*gem_create_object)(struct drm_device *dev,
390 * @prime_handle_to_fd:
392 * Main PRIME export function. Should be implemented with
393 * drm_gem_prime_handle_to_fd() for GEM based drivers.
395 * For an in-depth discussion see :ref:`PRIME buffer sharing
396 * documentation <prime_buffer_sharing>`.
398 int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
399 uint32_t handle, uint32_t flags, int *prime_fd);
401 * @prime_fd_to_handle:
403 * Main PRIME import function. Should be implemented with
404 * drm_gem_prime_fd_to_handle() for GEM based drivers.
406 * For an in-depth discussion see :ref:`PRIME buffer sharing
407 * documentation <prime_buffer_sharing>`.
409 int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
410 int prime_fd, uint32_t *handle);
414 * Export hook for GEM drivers. Deprecated in favour of
415 * &drm_gem_object_funcs.export.
417 struct dma_buf * (*gem_prime_export)(struct drm_gem_object *obj,
422 * Import hook for GEM drivers.
424 * This defaults to drm_gem_prime_import() if not set.
426 struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
427 struct dma_buf *dma_buf);
432 * Deprecated hook in favour of &drm_gem_object_funcs.pin.
434 int (*gem_prime_pin)(struct drm_gem_object *obj);
439 * Deprecated hook in favour of &drm_gem_object_funcs.unpin.
441 void (*gem_prime_unpin)(struct drm_gem_object *obj);
445 * @gem_prime_get_sg_table:
447 * Deprecated hook in favour of &drm_gem_object_funcs.get_sg_table.
449 struct sg_table *(*gem_prime_get_sg_table)(struct drm_gem_object *obj);
452 * @gem_prime_import_sg_table:
454 * Optional hook used by the PRIME helper functions
455 * drm_gem_prime_import() respectively drm_gem_prime_import_dev().
457 struct drm_gem_object *(*gem_prime_import_sg_table)(
458 struct drm_device *dev,
459 struct dma_buf_attachment *attach,
460 struct sg_table *sgt);
464 * Deprecated vmap hook for GEM drivers. Please use
465 * &drm_gem_object_funcs.vmap instead.
467 void *(*gem_prime_vmap)(struct drm_gem_object *obj);
472 * Deprecated vunmap hook for GEM drivers. Please use
473 * &drm_gem_object_funcs.vunmap instead.
475 void (*gem_prime_vunmap)(struct drm_gem_object *obj, void *vaddr);
480 * mmap hook for GEM drivers, used to implement dma-buf mmap in the
483 * FIXME: There's way too much duplication going on here, and also moved
484 * to &drm_gem_object_funcs.
486 int (*gem_prime_mmap)(struct drm_gem_object *obj,
487 struct vm_area_struct *vma);
492 * This creates a new dumb buffer in the driver's backing storage manager (GEM,
493 * TTM or something else entirely) and returns the resulting buffer handle. This
494 * handle can then be wrapped up into a framebuffer modeset object.
496 * Note that userspace is not allowed to use such objects for render
497 * acceleration - drivers must create their own private ioctls for such a use
500 * Width, height and depth are specified in the &drm_mode_create_dumb
501 * argument. The callback needs to fill the handle, pitch and size for
502 * the created buffer.
504 * Called by the user via ioctl.
508 * Zero on success, negative errno on failure.
510 int (*dumb_create)(struct drm_file *file_priv,
511 struct drm_device *dev,
512 struct drm_mode_create_dumb *args);
516 * Allocate an offset in the drm device node's address space to be able to
517 * memory map a dumb buffer.
519 * The default implementation is drm_gem_create_mmap_offset(). GEM based
520 * drivers must not overwrite this.
522 * Called by the user via ioctl.
526 * Zero on success, negative errno on failure.
528 int (*dumb_map_offset)(struct drm_file *file_priv,
529 struct drm_device *dev, uint32_t handle,
534 * This destroys the userspace handle for the given dumb backing storage buffer.
535 * Since buffer objects must be reference counted in the kernel a buffer object
536 * won't be immediately freed if a framebuffer modeset object still uses it.
538 * Called by the user via ioctl.
540 * The default implementation is drm_gem_dumb_destroy(). GEM based drivers
541 * must not overwrite this.
545 * Zero on success, negative errno on failure.
547 int (*dumb_destroy)(struct drm_file *file_priv,
548 struct drm_device *dev,
552 * @gem_vm_ops: Driver private ops for this object
554 * For GEM drivers this is deprecated in favour of
555 * &drm_gem_object_funcs.vm_ops.
557 const struct vm_operations_struct *gem_vm_ops;
559 /** @major: driver major number */
561 /** @minor: driver minor number */
563 /** @patchlevel: driver patch level */
565 /** @name: driver name */
567 /** @desc: driver description */
569 /** @date: driver date */
574 * Driver features, see &enum drm_driver_feature. Drivers can disable
575 * some features on a per-instance basis using
576 * &drm_device.driver_features.
583 * Array of driver-private IOCTL description entries. See the chapter on
584 * :ref:`IOCTL support in the userland interfaces
585 * chapter<drm_driver_ioctl>` for the full details.
588 const struct drm_ioctl_desc *ioctls;
589 /** @num_ioctls: Number of entries in @ioctls. */
595 * File operations for the DRM device node. See the discussion in
596 * :ref:`file operations<drm_driver_fops>` for in-depth coverage and
599 const struct file_operations *fops;
601 /* Everything below here is for legacy driver, never use! */
604 /* List of devices hanging off this driver with stealth attach. */
605 struct list_head legacy_dev_list;
606 int (*firstopen) (struct drm_device *);
607 void (*preclose) (struct drm_device *, struct drm_file *file_priv);
608 int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
609 int (*dma_quiescent) (struct drm_device *);
610 int (*context_dtor) (struct drm_device *dev, int context);
611 u32 (*get_vblank_counter)(struct drm_device *dev, unsigned int pipe);
612 int (*enable_vblank)(struct drm_device *dev, unsigned int pipe);
613 void (*disable_vblank)(struct drm_device *dev, unsigned int pipe);
617 int drm_dev_init(struct drm_device *dev,
618 struct drm_driver *driver,
619 struct device *parent);
620 int devm_drm_dev_init(struct device *parent,
621 struct drm_device *dev,
622 struct drm_driver *driver);
623 void drm_dev_fini(struct drm_device *dev);
625 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
626 struct device *parent);
627 int drm_dev_register(struct drm_device *dev, unsigned long flags);
628 void drm_dev_unregister(struct drm_device *dev);
630 void drm_dev_get(struct drm_device *dev);
631 void drm_dev_put(struct drm_device *dev);
632 void drm_put_dev(struct drm_device *dev);
633 bool drm_dev_enter(struct drm_device *dev, int *idx);
634 void drm_dev_exit(int idx);
635 void drm_dev_unplug(struct drm_device *dev);
638 * drm_dev_is_unplugged - is a DRM device unplugged
641 * This function can be called to check whether a hotpluggable is unplugged.
642 * Unplugging itself is singalled through drm_dev_unplug(). If a device is
643 * unplugged, these two functions guarantee that any store before calling
644 * drm_dev_unplug() is visible to callers of this function after it completes
646 * WARNING: This function fundamentally races against drm_dev_unplug(). It is
647 * recommended that drivers instead use the underlying drm_dev_enter() and
648 * drm_dev_exit() function pairs.
650 static inline bool drm_dev_is_unplugged(struct drm_device *dev)
654 if (drm_dev_enter(dev, &idx)) {
663 * drm_core_check_all_features - check driver feature flags mask
664 * @dev: DRM device to check
665 * @features: feature flag(s) mask
667 * This checks @dev for driver features, see &drm_driver.driver_features,
668 * &drm_device.driver_features, and the various &enum drm_driver_feature flags.
670 * Returns true if all features in the @features mask are supported, false
673 static inline bool drm_core_check_all_features(const struct drm_device *dev,
676 u32 supported = dev->driver->driver_features & dev->driver_features;
678 return features && (supported & features) == features;
682 * drm_core_check_feature - check driver feature flags
683 * @dev: DRM device to check
684 * @feature: feature flag
686 * This checks @dev for driver features, see &drm_driver.driver_features,
687 * &drm_device.driver_features, and the various &enum drm_driver_feature flags.
689 * Returns true if the @feature is supported, false otherwise.
691 static inline bool drm_core_check_feature(const struct drm_device *dev,
692 enum drm_driver_feature feature)
694 return drm_core_check_all_features(dev, feature);
698 * drm_drv_uses_atomic_modeset - check if the driver implements
702 * This check is useful if drivers do not have DRIVER_ATOMIC set but
703 * have atomic modesetting internally implemented.
705 static inline bool drm_drv_uses_atomic_modeset(struct drm_device *dev)
707 return drm_core_check_feature(dev, DRIVER_ATOMIC) ||
708 (dev->mode_config.funcs && dev->mode_config.funcs->atomic_commit != NULL);
712 int drm_dev_set_unique(struct drm_device *dev, const char *name);