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;
43 /* driver capabilities and requirements mask */
44 #define DRIVER_USE_AGP 0x1
45 #define DRIVER_LEGACY 0x2
46 #define DRIVER_PCI_DMA 0x8
47 #define DRIVER_SG 0x10
48 #define DRIVER_HAVE_DMA 0x20
49 #define DRIVER_HAVE_IRQ 0x40
50 #define DRIVER_IRQ_SHARED 0x80
51 #define DRIVER_GEM 0x1000
52 #define DRIVER_MODESET 0x2000
53 #define DRIVER_PRIME 0x4000
54 #define DRIVER_RENDER 0x8000
55 #define DRIVER_ATOMIC 0x10000
56 #define DRIVER_KMS_LEGACY_CONTEXT 0x20000
57 #define DRIVER_SYNCOBJ 0x40000
58 #define DRIVER_PREFER_XBGR_30BPP 0x80000
61 * struct drm_driver - DRM driver structure
63 * This structure represent the common code for a family of cards. There will
64 * one drm_device for each card present in this family. It contains lots of
65 * vfunc entries, and a pile of those probably should be moved to more
66 * appropriate places like &drm_mode_config_funcs or into a new operations
67 * structure for GEM drivers.
73 * Backward-compatible driver callback to complete
74 * initialization steps after the driver is registered. For
75 * this reason, may suffer from race conditions and its use is
76 * deprecated for new drivers. It is therefore only supported
77 * for existing drivers not yet converted to the new scheme.
78 * See drm_dev_init() and drm_dev_register() for proper and
79 * race-free way to set up a &struct drm_device.
81 * This is deprecated, do not use!
85 * Zero on success, non-zero value on failure.
87 int (*load) (struct drm_device *, unsigned long flags);
92 * Driver callback when a new &struct drm_file is opened. Useful for
93 * setting up driver-private data structures like buffer allocators,
94 * execution contexts or similar things. Such driver-private resources
95 * must be released again in @postclose.
97 * Since the display/modeset side of DRM can only be owned by exactly
98 * one &struct drm_file (see &drm_file.is_master and &drm_device.master)
99 * there should never be a need to set up any modeset related resources
100 * in this callback. Doing so would be a driver design bug.
104 * 0 on success, a negative error code on failure, which will be
105 * promoted to userspace as the result of the open() system call.
107 int (*open) (struct drm_device *, struct drm_file *);
112 * One of the driver callbacks when a new &struct drm_file is closed.
113 * Useful for tearing down driver-private data structures allocated in
114 * @open like buffer allocators, execution contexts or similar things.
116 * Since the display/modeset side of DRM can only be owned by exactly
117 * one &struct drm_file (see &drm_file.is_master and &drm_device.master)
118 * there should never be a need to tear down any modeset related
119 * resources in this callback. Doing so would be a driver design bug.
121 void (*postclose) (struct drm_device *, struct drm_file *);
126 * Called when the last &struct drm_file has been closed and there's
127 * currently no userspace client for the &struct drm_device.
129 * Modern drivers should only use this to force-restore the fbdev
130 * framebuffer using drm_fb_helper_restore_fbdev_mode_unlocked().
131 * Anything else would indicate there's something seriously wrong.
132 * Modern drivers can also use this to execute delayed power switching
133 * state changes, e.g. in conjunction with the :ref:`vga_switcheroo`
136 * This is called after @postclose hook has been called.
140 * All legacy drivers use this callback to de-initialize the hardware.
141 * This is purely because of the shadow-attach model, where the DRM
142 * kernel driver does not really own the hardware. Instead ownershipe is
143 * handled with the help of userspace through an inheritedly racy dance
144 * to set/unset the VT into raw mode.
146 * Legacy drivers initialize the hardware in the @firstopen callback,
147 * which isn't even called for modern drivers.
149 void (*lastclose) (struct drm_device *);
154 * Reverse the effects of the driver load callback. Ideally,
155 * the clean up performed by the driver should happen in the
156 * reverse order of the initialization. Similarly to the load
157 * hook, this handler is deprecated and its usage should be
158 * dropped in favor of an open-coded teardown function at the
159 * driver layer. See drm_dev_unregister() and drm_dev_unref()
160 * for the proper way to remove a &struct drm_device.
162 * The unload() hook is called right after unregistering
166 void (*unload) (struct drm_device *);
171 * Optional callback for destroying device data after the final
172 * reference is released, i.e. the device is being destroyed. Drivers
173 * using this callback are responsible for calling drm_dev_fini()
174 * to finalize the device and then freeing the struct themselves.
176 void (*release) (struct drm_device *);
179 * @get_vblank_counter:
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.
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
192 * This is deprecated and should not be used by new drivers.
193 * Use &drm_crtc_funcs.get_vblank_counter instead.
197 * Raw vblank counter value.
199 u32 (*get_vblank_counter) (struct drm_device *dev, unsigned int pipe);
204 * Enable vblank interrupts for the CRTC specified with the pipe
207 * This is deprecated and should not be used by new drivers.
208 * Use &drm_crtc_funcs.enable_vblank instead.
212 * Zero on success, appropriate errno if the given @crtc's vblank
213 * interrupt cannot be enabled.
215 int (*enable_vblank) (struct drm_device *dev, unsigned int pipe);
220 * Disable vblank interrupts for the CRTC specified with the pipe
223 * This is deprecated and should not be used by new drivers.
224 * Use &drm_crtc_funcs.disable_vblank instead.
226 void (*disable_vblank) (struct drm_device *dev, unsigned int pipe);
229 * @get_scanout_position:
231 * Called by vblank timestamping code.
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.
244 * Id of the crtc to query.
246 * True when called from drm_crtc_handle_vblank(). Some drivers
247 * need to apply some workarounds for gpu-specific vblank irq quirks
250 * Target location for current vertical scanout position.
252 * Target location for current horizontal scanout position.
254 * Target location for timestamp taken immediately before
255 * scanout position query. Can be NULL to skip timestamp.
257 * Target location for timestamp taken immediately after
258 * scanout position query. Can be NULL to skip timestamp.
260 * Current display timings.
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."
269 * True on success, false if a reliable scanout position counter could
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.
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);
284 * @get_vblank_timestamp:
286 * Called by drm_get_last_vbltimestamp(). Should return a precise
287 * timestamp when the most recent VBLANK interval ended or will end.
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.
301 * dev DRM device handle.
303 * crtc for which timestamp should be returned.
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.
310 * Target location for returned vblank timestamp.
312 * True when called from drm_crtc_handle_vblank(). Some drivers
313 * need to apply some workarounds for gpu-specific vblank irq quirks
318 * True on success, false on failure, which means the core should
319 * fallback to a simple timestamp taken in drm_crtc_handle_vblank().
323 * We should move this hook to &struct drm_crtc_funcs like all the other
326 bool (*get_vblank_timestamp) (struct drm_device *dev, unsigned int pipe,
328 struct timeval *vblank_time,
334 * Interrupt handler called when using drm_irq_install(). Not used by
335 * drivers which implement their own interrupt handling.
337 irqreturn_t(*irq_handler) (int irq, void *arg);
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.
347 void (*irq_preinstall) (struct drm_device *dev);
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.
356 int (*irq_postinstall) (struct drm_device *dev);
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.
365 void (*irq_uninstall) (struct drm_device *dev);
370 * Called whenever a new master is created. Only used by vmwgfx.
372 int (*master_create)(struct drm_device *dev, struct drm_master *master);
377 * Called whenever a master is destroyed. Only used by vmwgfx.
379 void (*master_destroy)(struct drm_device *dev, struct drm_master *master);
384 * Called whenever the minor master is set. Only used by vmwgfx.
386 int (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
391 * Called whenever the minor master is dropped. Only used by vmwgfx.
393 void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv);
398 * Allows drivers to create driver-specific debugfs files.
400 int (*debugfs_init)(struct drm_minor *minor);
403 * @gem_free_object: deconstructor for drm_gem_objects
405 * This is deprecated and should not be used by new drivers. Use
406 * @gem_free_object_unlocked instead.
408 void (*gem_free_object) (struct drm_gem_object *obj);
411 * @gem_free_object_unlocked: deconstructor for drm_gem_objects
413 * This is for drivers which are not encumbered with &drm_device.struct_mutex
414 * legacy locking schemes. Use this hook instead of @gem_free_object.
416 void (*gem_free_object_unlocked) (struct drm_gem_object *obj);
421 * Driver hook called upon gem handle creation
423 int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
428 * Driver hook called upon gem handle release
430 void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
433 * @gem_create_object: constructor for gem objects
435 * Hook for allocating the GEM object struct, for use by core
438 struct drm_gem_object *(*gem_create_object)(struct drm_device *dev,
443 * @prime_handle_to_fd:
445 * export handle -> fd (see drm_gem_prime_handle_to_fd() helper)
447 int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
448 uint32_t handle, uint32_t flags, int *prime_fd);
450 * @prime_fd_to_handle:
452 * import fd -> handle (see drm_gem_prime_fd_to_handle() helper)
454 int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
455 int prime_fd, uint32_t *handle);
459 * export GEM -> dmabuf
461 struct dma_buf * (*gem_prime_export)(struct drm_device *dev,
462 struct drm_gem_object *obj, int flags);
466 * import dmabuf -> GEM
468 struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
469 struct dma_buf *dma_buf);
470 int (*gem_prime_pin)(struct drm_gem_object *obj);
471 void (*gem_prime_unpin)(struct drm_gem_object *obj);
472 struct reservation_object * (*gem_prime_res_obj)(
473 struct drm_gem_object *obj);
474 struct sg_table *(*gem_prime_get_sg_table)(struct drm_gem_object *obj);
475 struct drm_gem_object *(*gem_prime_import_sg_table)(
476 struct drm_device *dev,
477 struct dma_buf_attachment *attach,
478 struct sg_table *sgt);
479 void *(*gem_prime_vmap)(struct drm_gem_object *obj);
480 void (*gem_prime_vunmap)(struct drm_gem_object *obj, void *vaddr);
481 int (*gem_prime_mmap)(struct drm_gem_object *obj,
482 struct vm_area_struct *vma);
487 * This creates a new dumb buffer in the driver's backing storage manager (GEM,
488 * TTM or something else entirely) and returns the resulting buffer handle. This
489 * handle can then be wrapped up into a framebuffer modeset object.
491 * Note that userspace is not allowed to use such objects for render
492 * acceleration - drivers must create their own private ioctls for such a use
495 * Width, height and depth are specified in the &drm_mode_create_dumb
496 * argument. The callback needs to fill the handle, pitch and size for
497 * the created buffer.
499 * Called by the user via ioctl.
503 * Zero on success, negative errno on failure.
505 int (*dumb_create)(struct drm_file *file_priv,
506 struct drm_device *dev,
507 struct drm_mode_create_dumb *args);
511 * Allocate an offset in the drm device node's address space to be able to
512 * memory map a dumb buffer. GEM-based drivers must use
513 * drm_gem_create_mmap_offset() to implement this.
515 * Called by the user via ioctl.
519 * Zero on success, negative errno on failure.
521 int (*dumb_map_offset)(struct drm_file *file_priv,
522 struct drm_device *dev, uint32_t handle,
527 * This destroys the userspace handle for the given dumb backing storage buffer.
528 * Since buffer objects must be reference counted in the kernel a buffer object
529 * won't be immediately freed if a framebuffer modeset object still uses it.
531 * Called by the user via ioctl.
535 * Zero on success, negative errno on failure.
537 int (*dumb_destroy)(struct drm_file *file_priv,
538 struct drm_device *dev,
542 * @gem_vm_ops: Driver private ops for this object
544 const struct vm_operations_struct *gem_vm_ops;
546 /** @major: driver major number */
548 /** @minor: driver minor number */
550 /** @patchlevel: driver patch level */
552 /** @name: driver name */
554 /** @desc: driver description */
556 /** @date: driver date */
559 /** @driver_features: driver features */
565 * Array of driver-private IOCTL description entries. See the chapter on
566 * :ref:`IOCTL support in the userland interfaces
567 * chapter<drm_driver_ioctl>` for the full details.
570 const struct drm_ioctl_desc *ioctls;
571 /** @num_ioctls: Number of entries in @ioctls. */
577 * File operations for the DRM device node. See the discussion in
578 * :ref:`file operations<drm_driver_fops>` for in-depth coverage and
581 const struct file_operations *fops;
583 /* Everything below here is for legacy driver, never use! */
586 /* List of devices hanging off this driver with stealth attach. */
587 struct list_head legacy_dev_list;
588 int (*firstopen) (struct drm_device *);
589 void (*preclose) (struct drm_device *, struct drm_file *file_priv);
590 int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
591 int (*dma_quiescent) (struct drm_device *);
592 int (*context_dtor) (struct drm_device *dev, int context);
597 void drm_dev_printk(const struct device *dev, const char *level,
598 unsigned int category, const char *function_name,
599 const char *prefix, const char *format, ...);
601 void drm_printk(const char *level, unsigned int category,
602 const char *format, ...);
603 extern unsigned int drm_debug;
605 int drm_dev_init(struct drm_device *dev,
606 struct drm_driver *driver,
607 struct device *parent);
608 void drm_dev_fini(struct drm_device *dev);
610 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
611 struct device *parent);
612 int drm_dev_register(struct drm_device *dev, unsigned long flags);
613 void drm_dev_unregister(struct drm_device *dev);
615 void drm_dev_ref(struct drm_device *dev);
616 void drm_dev_unref(struct drm_device *dev);
617 void drm_put_dev(struct drm_device *dev);
618 void drm_dev_unplug(struct drm_device *dev);
621 * drm_dev_is_unplugged - is a DRM device unplugged
624 * This function can be called to check whether a hotpluggable is unplugged.
625 * Unplugging itself is singalled through drm_dev_unplug(). If a device is
626 * unplugged, these two functions guarantee that any store before calling
627 * drm_dev_unplug() is visible to callers of this function after it completes
629 static inline int drm_dev_is_unplugged(struct drm_device *dev)
631 int ret = atomic_read(&dev->unplugged);
637 int drm_dev_set_unique(struct drm_device *dev, const char *name);