185e634bcSDaniel Vetter /*
285e634bcSDaniel Vetter * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
385e634bcSDaniel Vetter * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
485e634bcSDaniel Vetter * Copyright (c) 2009-2010, Code Aurora Forum.
585e634bcSDaniel Vetter * Copyright 2016 Intel Corp.
685e634bcSDaniel Vetter *
785e634bcSDaniel Vetter * Permission is hereby granted, free of charge, to any person obtaining a
885e634bcSDaniel Vetter * copy of this software and associated documentation files (the "Software"),
985e634bcSDaniel Vetter * to deal in the Software without restriction, including without limitation
1085e634bcSDaniel Vetter * the rights to use, copy, modify, merge, publish, distribute, sublicense,
1185e634bcSDaniel Vetter * and/or sell copies of the Software, and to permit persons to whom the
1285e634bcSDaniel Vetter * Software is furnished to do so, subject to the following conditions:
1385e634bcSDaniel Vetter *
1485e634bcSDaniel Vetter * The above copyright notice and this permission notice (including the next
1585e634bcSDaniel Vetter * paragraph) shall be included in all copies or substantial portions of the
1685e634bcSDaniel Vetter * Software.
1785e634bcSDaniel Vetter *
1885e634bcSDaniel Vetter * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
1985e634bcSDaniel Vetter * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
2085e634bcSDaniel Vetter * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
2185e634bcSDaniel Vetter * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
2285e634bcSDaniel Vetter * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
2385e634bcSDaniel Vetter * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
2485e634bcSDaniel Vetter * OTHER DEALINGS IN THE SOFTWARE.
2585e634bcSDaniel Vetter */
2685e634bcSDaniel Vetter
2785e634bcSDaniel Vetter #ifndef _DRM_DRV_H_
2885e634bcSDaniel Vetter #define _DRM_DRV_H_
2985e634bcSDaniel Vetter
3085e634bcSDaniel Vetter #include <linux/list.h>
3185e634bcSDaniel Vetter #include <linux/irqreturn.h>
3285e634bcSDaniel Vetter
339a758d87SThomas Zimmermann #include <video/nomodeset.h>
349a758d87SThomas Zimmermann
35c07dcd61SDaniel Vetter #include <drm/drm_device.h>
36c07dcd61SDaniel Vetter
3785e634bcSDaniel Vetter struct drm_file;
3885e634bcSDaniel Vetter struct drm_gem_object;
3985e634bcSDaniel Vetter struct drm_master;
4085e634bcSDaniel Vetter struct drm_minor;
41d693def4SThomas Zimmermann struct dma_buf;
4285e634bcSDaniel Vetter struct dma_buf_attachment;
4385e634bcSDaniel Vetter struct drm_display_mode;
4485e634bcSDaniel Vetter struct drm_mode_create_dumb;
4545d58b40SNoralf Trønnes struct drm_printer;
46d693def4SThomas Zimmermann struct sg_table;
4785e634bcSDaniel Vetter
480e2a933bSDaniel Vetter /**
490e2a933bSDaniel Vetter * enum drm_driver_feature - feature flags
500e2a933bSDaniel Vetter *
510e2a933bSDaniel Vetter * See &drm_driver.driver_features, drm_device.driver_features and
520e2a933bSDaniel Vetter * drm_core_check_feature().
530e2a933bSDaniel Vetter */
540e2a933bSDaniel Vetter enum drm_driver_feature {
550e2a933bSDaniel Vetter /**
560e2a933bSDaniel Vetter * @DRIVER_GEM:
570e2a933bSDaniel Vetter *
580e2a933bSDaniel Vetter * Driver use the GEM memory manager. This should be set for all modern
590e2a933bSDaniel Vetter * drivers.
600e2a933bSDaniel Vetter */
610e2a933bSDaniel Vetter DRIVER_GEM = BIT(0),
620e2a933bSDaniel Vetter /**
630e2a933bSDaniel Vetter * @DRIVER_MODESET:
640e2a933bSDaniel Vetter *
650e2a933bSDaniel Vetter * Driver supports mode setting interfaces (KMS).
660e2a933bSDaniel Vetter */
670e2a933bSDaniel Vetter DRIVER_MODESET = BIT(1),
680e2a933bSDaniel Vetter /**
690e2a933bSDaniel Vetter * @DRIVER_RENDER:
700e2a933bSDaniel Vetter *
710e2a933bSDaniel Vetter * Driver supports dedicated render nodes. See also the :ref:`section on
720e2a933bSDaniel Vetter * render nodes <drm_render_node>` for details.
730e2a933bSDaniel Vetter */
740e2a933bSDaniel Vetter DRIVER_RENDER = BIT(3),
750e2a933bSDaniel Vetter /**
760e2a933bSDaniel Vetter * @DRIVER_ATOMIC:
770e2a933bSDaniel Vetter *
780e2a933bSDaniel Vetter * Driver supports the full atomic modesetting userspace API. Drivers
79ee84c58bSDafna Hirschfeld * which only use atomic internally, but do not support the full
800e2a933bSDaniel Vetter * userspace API (e.g. not all properties converted to atomic, or
810e2a933bSDaniel Vetter * multi-plane updates are not guaranteed to be tear-free) should not
820e2a933bSDaniel Vetter * set this flag.
830e2a933bSDaniel Vetter */
840e2a933bSDaniel Vetter DRIVER_ATOMIC = BIT(4),
850e2a933bSDaniel Vetter /**
860e2a933bSDaniel Vetter * @DRIVER_SYNCOBJ:
870e2a933bSDaniel Vetter *
880e2a933bSDaniel Vetter * Driver supports &drm_syncobj for explicit synchronization of command
890e2a933bSDaniel Vetter * submission.
900e2a933bSDaniel Vetter */
910e2a933bSDaniel Vetter DRIVER_SYNCOBJ = BIT(5),
92060cebb2SLionel Landwerlin /**
93060cebb2SLionel Landwerlin * @DRIVER_SYNCOBJ_TIMELINE:
94060cebb2SLionel Landwerlin *
95060cebb2SLionel Landwerlin * Driver supports the timeline flavor of &drm_syncobj for explicit
96060cebb2SLionel Landwerlin * synchronization of command submission.
97060cebb2SLionel Landwerlin */
98060cebb2SLionel Landwerlin DRIVER_SYNCOBJ_TIMELINE = BIT(6),
992c204f3dSOded Gabbay /**
1002c204f3dSOded Gabbay * @DRIVER_COMPUTE_ACCEL:
1012c204f3dSOded Gabbay *
1022c204f3dSOded Gabbay * Driver supports compute acceleration devices. This flag is mutually exclusive with
1032c204f3dSOded Gabbay * @DRIVER_RENDER and @DRIVER_MODESET. Devices that support both graphics and compute
1042c204f3dSOded Gabbay * acceleration should be handled by two drivers that are connected using auxiliary bus.
1052c204f3dSOded Gabbay */
1062c204f3dSOded Gabbay DRIVER_COMPUTE_ACCEL = BIT(7),
107e6303f32SDanilo Krummrich /**
108e6303f32SDanilo Krummrich * @DRIVER_GEM_GPUVA:
109e6303f32SDanilo Krummrich *
110e6303f32SDanilo Krummrich * Driver supports user defined GPU VA bindings for GEM objects.
111e6303f32SDanilo Krummrich */
112e6303f32SDanilo Krummrich DRIVER_GEM_GPUVA = BIT(8),
113*87b3b45cSZack Rusin /**
114*87b3b45cSZack Rusin * @DRIVER_CURSOR_HOTSPOT:
115*87b3b45cSZack Rusin *
116*87b3b45cSZack Rusin * Driver supports and requires cursor hotspot information in the
117*87b3b45cSZack Rusin * cursor plane (e.g. cursor plane has to actually track the mouse
118*87b3b45cSZack Rusin * cursor and the clients are required to set hotspot in order for
119*87b3b45cSZack Rusin * the cursor planes to work correctly).
120*87b3b45cSZack Rusin */
121*87b3b45cSZack Rusin DRIVER_CURSOR_HOTSPOT = BIT(9),
1220e2a933bSDaniel Vetter
1230e2a933bSDaniel Vetter /* IMPORTANT: Below are all the legacy flags, add new ones above. */
1240e2a933bSDaniel Vetter
1250e2a933bSDaniel Vetter /**
1260e2a933bSDaniel Vetter * @DRIVER_USE_AGP:
1270e2a933bSDaniel Vetter *
1280e2a933bSDaniel Vetter * Set up DRM AGP support, see drm_agp_init(), the DRM core will manage
1290e2a933bSDaniel Vetter * AGP resources. New drivers don't need this.
1300e2a933bSDaniel Vetter */
1311ff49481SDaniel Vetter DRIVER_USE_AGP = BIT(25),
1320e2a933bSDaniel Vetter /**
1330e2a933bSDaniel Vetter * @DRIVER_LEGACY:
1340e2a933bSDaniel Vetter *
1350e2a933bSDaniel Vetter * Denote a legacy driver using shadow attach. Do not use.
1360e2a933bSDaniel Vetter */
1371ff49481SDaniel Vetter DRIVER_LEGACY = BIT(26),
1380e2a933bSDaniel Vetter /**
1390e2a933bSDaniel Vetter * @DRIVER_PCI_DMA:
1400e2a933bSDaniel Vetter *
1410e2a933bSDaniel Vetter * Driver is capable of PCI DMA, mapping of PCI DMA buffers to userspace
1420e2a933bSDaniel Vetter * will be enabled. Only for legacy drivers. Do not use.
1430e2a933bSDaniel Vetter */
1441ff49481SDaniel Vetter DRIVER_PCI_DMA = BIT(27),
1450e2a933bSDaniel Vetter /**
1460e2a933bSDaniel Vetter * @DRIVER_SG:
1470e2a933bSDaniel Vetter *
1480e2a933bSDaniel Vetter * Driver can perform scatter/gather DMA, allocation and mapping of
1490e2a933bSDaniel Vetter * scatter/gather buffers will be enabled. Only for legacy drivers. Do
1500e2a933bSDaniel Vetter * not use.
1510e2a933bSDaniel Vetter */
1521ff49481SDaniel Vetter DRIVER_SG = BIT(28),
1530e2a933bSDaniel Vetter
1540e2a933bSDaniel Vetter /**
1550e2a933bSDaniel Vetter * @DRIVER_HAVE_DMA:
1560e2a933bSDaniel Vetter *
1570e2a933bSDaniel Vetter * Driver supports DMA, the userspace DMA API will be supported. Only
1580e2a933bSDaniel Vetter * for legacy drivers. Do not use.
1590e2a933bSDaniel Vetter */
1601ff49481SDaniel Vetter DRIVER_HAVE_DMA = BIT(29),
1610e2a933bSDaniel Vetter /**
1620e2a933bSDaniel Vetter * @DRIVER_HAVE_IRQ:
1630e2a933bSDaniel Vetter *
1640e2a933bSDaniel Vetter * Legacy irq support. Only for legacy drivers. Do not use.
1650e2a933bSDaniel Vetter */
1661ff49481SDaniel Vetter DRIVER_HAVE_IRQ = BIT(30),
1670e2a933bSDaniel Vetter };
16885e634bcSDaniel Vetter
16985e634bcSDaniel Vetter /**
17085e634bcSDaniel Vetter * struct drm_driver - DRM driver structure
17185e634bcSDaniel Vetter *
17260e6ecfbSLuca Ceresoli * This structure represent the common code for a family of cards. There will be
17360e6ecfbSLuca Ceresoli * one &struct drm_device for each card present in this family. It contains lots
17460e6ecfbSLuca Ceresoli * of vfunc entries, and a pile of those probably should be moved to more
17585e634bcSDaniel Vetter * appropriate places like &drm_mode_config_funcs or into a new operations
17685e634bcSDaniel Vetter * structure for GEM drivers.
17785e634bcSDaniel Vetter */
17885e634bcSDaniel Vetter struct drm_driver {
17956926500SGabriel Krisman Bertazi /**
18056926500SGabriel Krisman Bertazi * @load:
18156926500SGabriel Krisman Bertazi *
1824c8e84b8SDaniel Vetter * Backward-compatible driver callback to complete initialization steps
1834c8e84b8SDaniel Vetter * after the driver is registered. For this reason, may suffer from
1844c8e84b8SDaniel Vetter * race conditions and its use is deprecated for new drivers. It is
1854c8e84b8SDaniel Vetter * therefore only supported for existing drivers not yet converted to
1864c8e84b8SDaniel Vetter * the new scheme. See devm_drm_dev_alloc() and drm_dev_register() for
1874c8e84b8SDaniel Vetter * proper and race-free way to set up a &struct drm_device.
18856926500SGabriel Krisman Bertazi *
189b93658f8SDaniel Vetter * This is deprecated, do not use!
190b93658f8SDaniel Vetter *
19156926500SGabriel Krisman Bertazi * Returns:
19256926500SGabriel Krisman Bertazi *
19356926500SGabriel Krisman Bertazi * Zero on success, non-zero value on failure.
19456926500SGabriel Krisman Bertazi */
19585e634bcSDaniel Vetter int (*load) (struct drm_device *, unsigned long flags);
196b93658f8SDaniel Vetter
197b93658f8SDaniel Vetter /**
198b93658f8SDaniel Vetter * @open:
199b93658f8SDaniel Vetter *
200b93658f8SDaniel Vetter * Driver callback when a new &struct drm_file is opened. Useful for
201b93658f8SDaniel Vetter * setting up driver-private data structures like buffer allocators,
202b93658f8SDaniel Vetter * execution contexts or similar things. Such driver-private resources
203b93658f8SDaniel Vetter * must be released again in @postclose.
204b93658f8SDaniel Vetter *
205b93658f8SDaniel Vetter * Since the display/modeset side of DRM can only be owned by exactly
206b93658f8SDaniel Vetter * one &struct drm_file (see &drm_file.is_master and &drm_device.master)
207b93658f8SDaniel Vetter * there should never be a need to set up any modeset related resources
208b93658f8SDaniel Vetter * in this callback. Doing so would be a driver design bug.
209b93658f8SDaniel Vetter *
210b93658f8SDaniel Vetter * Returns:
211b93658f8SDaniel Vetter *
212b93658f8SDaniel Vetter * 0 on success, a negative error code on failure, which will be
213b93658f8SDaniel Vetter * promoted to userspace as the result of the open() system call.
214b93658f8SDaniel Vetter */
21585e634bcSDaniel Vetter int (*open) (struct drm_device *, struct drm_file *);
216b93658f8SDaniel Vetter
217b93658f8SDaniel Vetter /**
218b93658f8SDaniel Vetter * @postclose:
219b93658f8SDaniel Vetter *
220b93658f8SDaniel Vetter * One of the driver callbacks when a new &struct drm_file is closed.
221b93658f8SDaniel Vetter * Useful for tearing down driver-private data structures allocated in
222b93658f8SDaniel Vetter * @open like buffer allocators, execution contexts or similar things.
223b93658f8SDaniel Vetter *
224b93658f8SDaniel Vetter * Since the display/modeset side of DRM can only be owned by exactly
225b93658f8SDaniel Vetter * one &struct drm_file (see &drm_file.is_master and &drm_device.master)
226b93658f8SDaniel Vetter * there should never be a need to tear down any modeset related
227b93658f8SDaniel Vetter * resources in this callback. Doing so would be a driver design bug.
228b93658f8SDaniel Vetter */
22985e634bcSDaniel Vetter void (*postclose) (struct drm_device *, struct drm_file *);
230b93658f8SDaniel Vetter
231b93658f8SDaniel Vetter /**
232b93658f8SDaniel Vetter * @lastclose:
233b93658f8SDaniel Vetter *
234b93658f8SDaniel Vetter * Called when the last &struct drm_file has been closed and there's
235b93658f8SDaniel Vetter * currently no userspace client for the &struct drm_device.
236b93658f8SDaniel Vetter *
237b93658f8SDaniel Vetter * Modern drivers should only use this to force-restore the fbdev
238b93658f8SDaniel Vetter * framebuffer using drm_fb_helper_restore_fbdev_mode_unlocked().
239b93658f8SDaniel Vetter * Anything else would indicate there's something seriously wrong.
240b93658f8SDaniel Vetter * Modern drivers can also use this to execute delayed power switching
241b93658f8SDaniel Vetter * state changes, e.g. in conjunction with the :ref:`vga_switcheroo`
242b93658f8SDaniel Vetter * infrastructure.
243b93658f8SDaniel Vetter *
24445c3d213SDaniel Vetter * This is called after @postclose hook has been called.
245b93658f8SDaniel Vetter *
246b93658f8SDaniel Vetter * NOTE:
247b93658f8SDaniel Vetter *
248b93658f8SDaniel Vetter * All legacy drivers use this callback to de-initialize the hardware.
249b93658f8SDaniel Vetter * This is purely because of the shadow-attach model, where the DRM
250b93658f8SDaniel Vetter * kernel driver does not really own the hardware. Instead ownershipe is
251b93658f8SDaniel Vetter * handled with the help of userspace through an inheritedly racy dance
252b93658f8SDaniel Vetter * to set/unset the VT into raw mode.
253b93658f8SDaniel Vetter *
254b93658f8SDaniel Vetter * Legacy drivers initialize the hardware in the @firstopen callback,
255b93658f8SDaniel Vetter * which isn't even called for modern drivers.
256b93658f8SDaniel Vetter */
25785e634bcSDaniel Vetter void (*lastclose) (struct drm_device *);
25856926500SGabriel Krisman Bertazi
25956926500SGabriel Krisman Bertazi /**
26056926500SGabriel Krisman Bertazi * @unload:
26156926500SGabriel Krisman Bertazi *
26256926500SGabriel Krisman Bertazi * Reverse the effects of the driver load callback. Ideally,
26356926500SGabriel Krisman Bertazi * the clean up performed by the driver should happen in the
26456926500SGabriel Krisman Bertazi * reverse order of the initialization. Similarly to the load
26556926500SGabriel Krisman Bertazi * hook, this handler is deprecated and its usage should be
26656926500SGabriel Krisman Bertazi * dropped in favor of an open-coded teardown function at the
2679a96f550SAishwarya Pant * driver layer. See drm_dev_unregister() and drm_dev_put()
26856926500SGabriel Krisman Bertazi * for the proper way to remove a &struct drm_device.
26956926500SGabriel Krisman Bertazi *
27056926500SGabriel Krisman Bertazi * The unload() hook is called right after unregistering
27156926500SGabriel Krisman Bertazi * the device.
27256926500SGabriel Krisman Bertazi *
27356926500SGabriel Krisman Bertazi */
27411b3c20bSGabriel Krisman Bertazi void (*unload) (struct drm_device *);
275f30c9257SChris Wilson
276f30c9257SChris Wilson /**
277f30c9257SChris Wilson * @release:
278f30c9257SChris Wilson *
279f30c9257SChris Wilson * Optional callback for destroying device data after the final
280d33b58d0SDaniel Vetter * reference is released, i.e. the device is being destroyed.
2819e1ed9fbSDaniel Vetter *
2829e1ed9fbSDaniel Vetter * This is deprecated, clean up all memory allocations associated with a
2839e1ed9fbSDaniel Vetter * &drm_device using drmm_add_action(), drmm_kmalloc() and related
2849e1ed9fbSDaniel Vetter * managed resources functions.
285f30c9257SChris Wilson */
286f30c9257SChris Wilson void (*release) (struct drm_device *);
287f30c9257SChris Wilson
28885e634bcSDaniel Vetter /**
2896c4789edSDaniel Vetter * @master_set:
2906c4789edSDaniel Vetter *
2916c4789edSDaniel Vetter * Called whenever the minor master is set. Only used by vmwgfx.
2926c4789edSDaniel Vetter */
293907f5320SEmil Velikov void (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
29485e634bcSDaniel Vetter bool from_open);
2956c4789edSDaniel Vetter /**
2966c4789edSDaniel Vetter * @master_drop:
2976c4789edSDaniel Vetter *
2986c4789edSDaniel Vetter * Called whenever the minor master is dropped. Only used by vmwgfx.
2996c4789edSDaniel Vetter */
30085e634bcSDaniel Vetter void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv);
30185e634bcSDaniel Vetter
302d1b6c62fSSean Paul /**
303d1b6c62fSSean Paul * @debugfs_init:
304d1b6c62fSSean Paul *
305d1b6c62fSSean Paul * Allows drivers to create driver-specific debugfs files.
306d1b6c62fSSean Paul */
3077ce84471SWambui Karuga void (*debugfs_init)(struct drm_minor *minor);
30885e634bcSDaniel Vetter
30985e634bcSDaniel Vetter /**
310218adc17SChris Wilson * @gem_create_object: constructor for gem objects
311218adc17SChris Wilson *
3124ff22f48SThomas Zimmermann * Hook for allocating the GEM object struct, for use by the CMA
3134ff22f48SThomas Zimmermann * and SHMEM GEM helpers. Returns a GEM object on success, or an
3144ff22f48SThomas Zimmermann * ERR_PTR()-encoded error code otherwise.
31585e634bcSDaniel Vetter */
31685e634bcSDaniel Vetter struct drm_gem_object *(*gem_create_object)(struct drm_device *dev,
31785e634bcSDaniel Vetter size_t size);
318d693def4SThomas Zimmermann
319d1b6c62fSSean Paul /**
320d1b6c62fSSean Paul * @prime_handle_to_fd:
321d1b6c62fSSean Paul *
3226b85aa68SThomas Zimmermann * PRIME export function. Only used by vmwgfx.
323d1b6c62fSSean Paul */
32485e634bcSDaniel Vetter int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
32585e634bcSDaniel Vetter uint32_t handle, uint32_t flags, int *prime_fd);
326d1b6c62fSSean Paul /**
327d1b6c62fSSean Paul * @prime_fd_to_handle:
328d1b6c62fSSean Paul *
3296b85aa68SThomas Zimmermann * PRIME import function. Only used by vmwgfx.
330d1b6c62fSSean Paul */
33185e634bcSDaniel Vetter int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
33285e634bcSDaniel Vetter int prime_fd, uint32_t *handle);
333d693def4SThomas Zimmermann
334d1b6c62fSSean Paul /**
335d1b6c62fSSean Paul * @gem_prime_import:
336d1b6c62fSSean Paul *
337805dc614SDaniel Vetter * Import hook for GEM drivers.
338f0014881SNoralf Trønnes *
339f0014881SNoralf Trønnes * This defaults to drm_gem_prime_import() if not set.
340d1b6c62fSSean Paul */
34185e634bcSDaniel Vetter struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
34285e634bcSDaniel Vetter struct dma_buf *dma_buf);
343805dc614SDaniel Vetter /**
344805dc614SDaniel Vetter * @gem_prime_import_sg_table:
345805dc614SDaniel Vetter *
346805dc614SDaniel Vetter * Optional hook used by the PRIME helper functions
347805dc614SDaniel Vetter * drm_gem_prime_import() respectively drm_gem_prime_import_dev().
348805dc614SDaniel Vetter */
34985e634bcSDaniel Vetter struct drm_gem_object *(*gem_prime_import_sg_table)(
35085e634bcSDaniel Vetter struct drm_device *dev,
35185e634bcSDaniel Vetter struct dma_buf_attachment *attach,
35285e634bcSDaniel Vetter struct sg_table *sgt);
35385e634bcSDaniel Vetter
3544f93624eSDaniel Vetter /**
3554f93624eSDaniel Vetter * @dumb_create:
3564f93624eSDaniel Vetter *
3574f93624eSDaniel Vetter * This creates a new dumb buffer in the driver's backing storage manager (GEM,
3584f93624eSDaniel Vetter * TTM or something else entirely) and returns the resulting buffer handle. This
3594f93624eSDaniel Vetter * handle can then be wrapped up into a framebuffer modeset object.
3604f93624eSDaniel Vetter *
3614f93624eSDaniel Vetter * Note that userspace is not allowed to use such objects for render
3624f93624eSDaniel Vetter * acceleration - drivers must create their own private ioctls for such a use
3634f93624eSDaniel Vetter * case.
3644f93624eSDaniel Vetter *
3654f93624eSDaniel Vetter * Width, height and depth are specified in the &drm_mode_create_dumb
3664f93624eSDaniel Vetter * argument. The callback needs to fill the handle, pitch and size for
3674f93624eSDaniel Vetter * the created buffer.
3684f93624eSDaniel Vetter *
3694f93624eSDaniel Vetter * Called by the user via ioctl.
3704f93624eSDaniel Vetter *
3714f93624eSDaniel Vetter * Returns:
3724f93624eSDaniel Vetter *
3734f93624eSDaniel Vetter * Zero on success, negative errno on failure.
3744f93624eSDaniel Vetter */
37585e634bcSDaniel Vetter int (*dumb_create)(struct drm_file *file_priv,
37685e634bcSDaniel Vetter struct drm_device *dev,
37785e634bcSDaniel Vetter struct drm_mode_create_dumb *args);
3784f93624eSDaniel Vetter /**
3794f93624eSDaniel Vetter * @dumb_map_offset:
3804f93624eSDaniel Vetter *
3814f93624eSDaniel Vetter * Allocate an offset in the drm device node's address space to be able to
38239dea70dSDaniel Vetter * memory map a dumb buffer.
38339dea70dSDaniel Vetter *
38439dea70dSDaniel Vetter * The default implementation is drm_gem_create_mmap_offset(). GEM based
38539dea70dSDaniel Vetter * drivers must not overwrite this.
3864f93624eSDaniel Vetter *
3874f93624eSDaniel Vetter * Called by the user via ioctl.
3884f93624eSDaniel Vetter *
3894f93624eSDaniel Vetter * Returns:
3904f93624eSDaniel Vetter *
3914f93624eSDaniel Vetter * Zero on success, negative errno on failure.
3924f93624eSDaniel Vetter */
39385e634bcSDaniel Vetter int (*dumb_map_offset)(struct drm_file *file_priv,
39485e634bcSDaniel Vetter struct drm_device *dev, uint32_t handle,
39585e634bcSDaniel Vetter uint64_t *offset);
39685e634bcSDaniel Vetter
3973f09a0cdSRob Clark /**
3983f09a0cdSRob Clark * @show_fdinfo:
3993f09a0cdSRob Clark *
4003f09a0cdSRob Clark * Print device specific fdinfo. See Documentation/gpu/drm-usage-stats.rst.
4013f09a0cdSRob Clark */
4023f09a0cdSRob Clark void (*show_fdinfo)(struct drm_printer *p, struct drm_file *f);
4033f09a0cdSRob Clark
404d1b6c62fSSean Paul /** @major: driver major number */
40585e634bcSDaniel Vetter int major;
406d1b6c62fSSean Paul /** @minor: driver minor number */
40785e634bcSDaniel Vetter int minor;
408d1b6c62fSSean Paul /** @patchlevel: driver patch level */
40985e634bcSDaniel Vetter int patchlevel;
410d1b6c62fSSean Paul /** @name: driver name */
41185e634bcSDaniel Vetter char *name;
412d1b6c62fSSean Paul /** @desc: driver description */
41385e634bcSDaniel Vetter char *desc;
414d1b6c62fSSean Paul /** @date: driver date */
41585e634bcSDaniel Vetter char *date;
41685e634bcSDaniel Vetter
4170e2a933bSDaniel Vetter /**
4180e2a933bSDaniel Vetter * @driver_features:
4190e2a933bSDaniel Vetter * Driver features, see &enum drm_driver_feature. Drivers can disable
4200e2a933bSDaniel Vetter * some features on a per-instance basis using
4210e2a933bSDaniel Vetter * &drm_device.driver_features.
4220e2a933bSDaniel Vetter */
42385e634bcSDaniel Vetter u32 driver_features;
424bb2eaba6SDaniel Vetter
425bb2eaba6SDaniel Vetter /**
426bb2eaba6SDaniel Vetter * @ioctls:
427bb2eaba6SDaniel Vetter *
428bb2eaba6SDaniel Vetter * Array of driver-private IOCTL description entries. See the chapter on
429bb2eaba6SDaniel Vetter * :ref:`IOCTL support in the userland interfaces
430bb2eaba6SDaniel Vetter * chapter<drm_driver_ioctl>` for the full details.
431bb2eaba6SDaniel Vetter */
432bb2eaba6SDaniel Vetter
43385e634bcSDaniel Vetter const struct drm_ioctl_desc *ioctls;
434bb2eaba6SDaniel Vetter /** @num_ioctls: Number of entries in @ioctls. */
43585e634bcSDaniel Vetter int num_ioctls;
436bb2eaba6SDaniel Vetter
437bb2eaba6SDaniel Vetter /**
438bb2eaba6SDaniel Vetter * @fops:
439bb2eaba6SDaniel Vetter *
440bb2eaba6SDaniel Vetter * File operations for the DRM device node. See the discussion in
441bb2eaba6SDaniel Vetter * :ref:`file operations<drm_driver_fops>` for in-depth coverage and
442bb2eaba6SDaniel Vetter * some examples.
443bb2eaba6SDaniel Vetter */
44485e634bcSDaniel Vetter const struct file_operations *fops;
44585e634bcSDaniel Vetter
44657bb1ee6SDaniel Vetter #ifdef CONFIG_DRM_LEGACY
4470683c0abSDaniel Vetter /* Everything below here is for legacy driver, never use! */
4480683c0abSDaniel Vetter /* private: */
4490683c0abSDaniel Vetter
4500683c0abSDaniel Vetter int (*firstopen) (struct drm_device *);
45145c3d213SDaniel Vetter void (*preclose) (struct drm_device *, struct drm_file *file_priv);
4520683c0abSDaniel Vetter int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
4530683c0abSDaniel Vetter int (*dma_quiescent) (struct drm_device *);
4540683c0abSDaniel Vetter int (*context_dtor) (struct drm_device *dev, int context);
455c1736b90SThomas Zimmermann irqreturn_t (*irq_handler)(int irq, void *arg);
456c1736b90SThomas Zimmermann void (*irq_preinstall)(struct drm_device *dev);
457c1736b90SThomas Zimmermann int (*irq_postinstall)(struct drm_device *dev);
458c1736b90SThomas Zimmermann void (*irq_uninstall)(struct drm_device *dev);
459f397d66bSThomas Zimmermann u32 (*get_vblank_counter)(struct drm_device *dev, unsigned int pipe);
460f397d66bSThomas Zimmermann int (*enable_vblank)(struct drm_device *dev, unsigned int pipe);
461f397d66bSThomas Zimmermann void (*disable_vblank)(struct drm_device *dev, unsigned int pipe);
4620683c0abSDaniel Vetter int dev_priv_size;
46357bb1ee6SDaniel Vetter #endif
46485e634bcSDaniel Vetter };
46585e634bcSDaniel Vetter
4668f5c7aa0SDaniel Vetter void *__devm_drm_dev_alloc(struct device *parent,
4678f5c7aa0SDaniel Vetter const struct drm_driver *driver,
468b0b5849eSDaniel Vetter size_t size, size_t offset);
469b0b5849eSDaniel Vetter
470b0b5849eSDaniel Vetter /**
471b0b5849eSDaniel Vetter * devm_drm_dev_alloc - Resource managed allocation of a &drm_device instance
472b0b5849eSDaniel Vetter * @parent: Parent device object
473b0b5849eSDaniel Vetter * @driver: DRM driver
474b0b5849eSDaniel Vetter * @type: the type of the struct which contains struct &drm_device
475b0b5849eSDaniel Vetter * @member: the name of the &drm_device within @type.
476b0b5849eSDaniel Vetter *
477b0b5849eSDaniel Vetter * This allocates and initialize a new DRM device. No device registration is done.
478b0b5849eSDaniel Vetter * Call drm_dev_register() to advertice the device to user space and register it
479b0b5849eSDaniel Vetter * with other core subsystems. This should be done last in the device
480b0b5849eSDaniel Vetter * initialization sequence to make sure userspace can't access an inconsistent
481b0b5849eSDaniel Vetter * state.
482b0b5849eSDaniel Vetter *
483b0b5849eSDaniel Vetter * The initial ref-count of the object is 1. Use drm_dev_get() and
484b0b5849eSDaniel Vetter * drm_dev_put() to take and drop further ref-counts.
485b0b5849eSDaniel Vetter *
486b0b5849eSDaniel Vetter * It is recommended that drivers embed &struct drm_device into their own device
487b0b5849eSDaniel Vetter * structure.
488b0b5849eSDaniel Vetter *
489b0b5849eSDaniel Vetter * Note that this manages the lifetime of the resulting &drm_device
490b0b5849eSDaniel Vetter * automatically using devres. The DRM device initialized with this function is
491b0b5849eSDaniel Vetter * automatically put on driver detach using drm_dev_put().
492b0b5849eSDaniel Vetter *
493b0b5849eSDaniel Vetter * RETURNS:
494b0b5849eSDaniel Vetter * Pointer to new DRM device, or ERR_PTR on failure.
495b0b5849eSDaniel Vetter */
496b0b5849eSDaniel Vetter #define devm_drm_dev_alloc(parent, driver, type, member) \
497b0b5849eSDaniel Vetter ((type *) __devm_drm_dev_alloc(parent, driver, sizeof(type), \
498b0b5849eSDaniel Vetter offsetof(type, member)))
499b0b5849eSDaniel Vetter
5008f5c7aa0SDaniel Vetter struct drm_device *drm_dev_alloc(const struct drm_driver *driver,
50185e634bcSDaniel Vetter struct device *parent);
50285e634bcSDaniel Vetter int drm_dev_register(struct drm_device *dev, unsigned long flags);
50385e634bcSDaniel Vetter void drm_dev_unregister(struct drm_device *dev);
50485e634bcSDaniel Vetter
5059a96f550SAishwarya Pant void drm_dev_get(struct drm_device *dev);
5069a96f550SAishwarya Pant void drm_dev_put(struct drm_device *dev);
50785e634bcSDaniel Vetter void drm_put_dev(struct drm_device *dev);
508bee330f3SNoralf Trønnes bool drm_dev_enter(struct drm_device *dev, int *idx);
509bee330f3SNoralf Trønnes void drm_dev_exit(int idx);
510c07dcd61SDaniel Vetter void drm_dev_unplug(struct drm_device *dev);
511c07dcd61SDaniel Vetter
512c07dcd61SDaniel Vetter /**
513c07dcd61SDaniel Vetter * drm_dev_is_unplugged - is a DRM device unplugged
514c07dcd61SDaniel Vetter * @dev: DRM device
515c07dcd61SDaniel Vetter *
516c07dcd61SDaniel Vetter * This function can be called to check whether a hotpluggable is unplugged.
517c07dcd61SDaniel Vetter * Unplugging itself is singalled through drm_dev_unplug(). If a device is
518c07dcd61SDaniel Vetter * unplugged, these two functions guarantee that any store before calling
519c07dcd61SDaniel Vetter * drm_dev_unplug() is visible to callers of this function after it completes
520168982d2SDaniel Vetter *
521168982d2SDaniel Vetter * WARNING: This function fundamentally races against drm_dev_unplug(). It is
522168982d2SDaniel Vetter * recommended that drivers instead use the underlying drm_dev_enter() and
523168982d2SDaniel Vetter * drm_dev_exit() function pairs.
524c07dcd61SDaniel Vetter */
drm_dev_is_unplugged(struct drm_device * dev)525bee330f3SNoralf Trønnes static inline bool drm_dev_is_unplugged(struct drm_device *dev)
526c07dcd61SDaniel Vetter {
527bee330f3SNoralf Trønnes int idx;
528bee330f3SNoralf Trønnes
529bee330f3SNoralf Trønnes if (drm_dev_enter(dev, &idx)) {
530bee330f3SNoralf Trønnes drm_dev_exit(idx);
531bee330f3SNoralf Trønnes return false;
532bee330f3SNoralf Trønnes }
533bee330f3SNoralf Trønnes
534bee330f3SNoralf Trønnes return true;
535c07dcd61SDaniel Vetter }
536c07dcd61SDaniel Vetter
5373479fc24SDaniel Vetter /**
53812a1d4e0SJani Nikula * drm_core_check_all_features - check driver feature flags mask
53912a1d4e0SJani Nikula * @dev: DRM device to check
54012a1d4e0SJani Nikula * @features: feature flag(s) mask
54112a1d4e0SJani Nikula *
54212a1d4e0SJani Nikula * This checks @dev for driver features, see &drm_driver.driver_features,
54312a1d4e0SJani Nikula * &drm_device.driver_features, and the various &enum drm_driver_feature flags.
54412a1d4e0SJani Nikula *
54512a1d4e0SJani Nikula * Returns true if all features in the @features mask are supported, false
54612a1d4e0SJani Nikula * otherwise.
54712a1d4e0SJani Nikula */
drm_core_check_all_features(const struct drm_device * dev,u32 features)54812a1d4e0SJani Nikula static inline bool drm_core_check_all_features(const struct drm_device *dev,
54912a1d4e0SJani Nikula u32 features)
55012a1d4e0SJani Nikula {
55112a1d4e0SJani Nikula u32 supported = dev->driver->driver_features & dev->driver_features;
55212a1d4e0SJani Nikula
55312a1d4e0SJani Nikula return features && (supported & features) == features;
55412a1d4e0SJani Nikula }
55512a1d4e0SJani Nikula
55612a1d4e0SJani Nikula /**
5573479fc24SDaniel Vetter * drm_core_check_feature - check driver feature flags
5583479fc24SDaniel Vetter * @dev: DRM device to check
5593479fc24SDaniel Vetter * @feature: feature flag
5603479fc24SDaniel Vetter *
56118ace11fSVille Syrjälä * This checks @dev for driver features, see &drm_driver.driver_features,
5620e2a933bSDaniel Vetter * &drm_device.driver_features, and the various &enum drm_driver_feature flags.
5633479fc24SDaniel Vetter *
5643479fc24SDaniel Vetter * Returns true if the @feature is supported, false otherwise.
5653479fc24SDaniel Vetter */
drm_core_check_feature(const struct drm_device * dev,enum drm_driver_feature feature)56612a1d4e0SJani Nikula static inline bool drm_core_check_feature(const struct drm_device *dev,
56712a1d4e0SJani Nikula enum drm_driver_feature feature)
5683479fc24SDaniel Vetter {
56912a1d4e0SJani Nikula return drm_core_check_all_features(dev, feature);
5703479fc24SDaniel Vetter }
5713479fc24SDaniel Vetter
5723479fc24SDaniel Vetter /**
5733479fc24SDaniel Vetter * drm_drv_uses_atomic_modeset - check if the driver implements
5743479fc24SDaniel Vetter * atomic_commit()
5753479fc24SDaniel Vetter * @dev: DRM device
5763479fc24SDaniel Vetter *
5773479fc24SDaniel Vetter * This check is useful if drivers do not have DRIVER_ATOMIC set but
5783479fc24SDaniel Vetter * have atomic modesetting internally implemented.
5793479fc24SDaniel Vetter */
drm_drv_uses_atomic_modeset(struct drm_device * dev)5803479fc24SDaniel Vetter static inline bool drm_drv_uses_atomic_modeset(struct drm_device *dev)
5813479fc24SDaniel Vetter {
5823479fc24SDaniel Vetter return drm_core_check_feature(dev, DRIVER_ATOMIC) ||
58357078338SDave Airlie (dev->mode_config.funcs && dev->mode_config.funcs->atomic_commit != NULL);
5843479fc24SDaniel Vetter }
5853479fc24SDaniel Vetter
58685e634bcSDaniel Vetter
5879a758d87SThomas Zimmermann /* TODO: Inline drm_firmware_drivers_only() in all its callers. */
drm_firmware_drivers_only(void)5889a758d87SThomas Zimmermann static inline bool drm_firmware_drivers_only(void)
5899a758d87SThomas Zimmermann {
5909a758d87SThomas Zimmermann return video_firmware_drivers_only();
5919a758d87SThomas Zimmermann }
59263207455SDave Airlie
59385e634bcSDaniel Vetter #endif
594