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), 107*e6303f32SDanilo Krummrich /** 108*e6303f32SDanilo Krummrich * @DRIVER_GEM_GPUVA: 109*e6303f32SDanilo Krummrich * 110*e6303f32SDanilo Krummrich * Driver supports user defined GPU VA bindings for GEM objects. 111*e6303f32SDanilo Krummrich */ 112*e6303f32SDanilo Krummrich DRIVER_GEM_GPUVA = BIT(8), 1130e2a933bSDaniel Vetter 1140e2a933bSDaniel Vetter /* IMPORTANT: Below are all the legacy flags, add new ones above. */ 1150e2a933bSDaniel Vetter 1160e2a933bSDaniel Vetter /** 1170e2a933bSDaniel Vetter * @DRIVER_USE_AGP: 1180e2a933bSDaniel Vetter * 1190e2a933bSDaniel Vetter * Set up DRM AGP support, see drm_agp_init(), the DRM core will manage 1200e2a933bSDaniel Vetter * AGP resources. New drivers don't need this. 1210e2a933bSDaniel Vetter */ 1221ff49481SDaniel Vetter DRIVER_USE_AGP = BIT(25), 1230e2a933bSDaniel Vetter /** 1240e2a933bSDaniel Vetter * @DRIVER_LEGACY: 1250e2a933bSDaniel Vetter * 1260e2a933bSDaniel Vetter * Denote a legacy driver using shadow attach. Do not use. 1270e2a933bSDaniel Vetter */ 1281ff49481SDaniel Vetter DRIVER_LEGACY = BIT(26), 1290e2a933bSDaniel Vetter /** 1300e2a933bSDaniel Vetter * @DRIVER_PCI_DMA: 1310e2a933bSDaniel Vetter * 1320e2a933bSDaniel Vetter * Driver is capable of PCI DMA, mapping of PCI DMA buffers to userspace 1330e2a933bSDaniel Vetter * will be enabled. Only for legacy drivers. Do not use. 1340e2a933bSDaniel Vetter */ 1351ff49481SDaniel Vetter DRIVER_PCI_DMA = BIT(27), 1360e2a933bSDaniel Vetter /** 1370e2a933bSDaniel Vetter * @DRIVER_SG: 1380e2a933bSDaniel Vetter * 1390e2a933bSDaniel Vetter * Driver can perform scatter/gather DMA, allocation and mapping of 1400e2a933bSDaniel Vetter * scatter/gather buffers will be enabled. Only for legacy drivers. Do 1410e2a933bSDaniel Vetter * not use. 1420e2a933bSDaniel Vetter */ 1431ff49481SDaniel Vetter DRIVER_SG = BIT(28), 1440e2a933bSDaniel Vetter 1450e2a933bSDaniel Vetter /** 1460e2a933bSDaniel Vetter * @DRIVER_HAVE_DMA: 1470e2a933bSDaniel Vetter * 1480e2a933bSDaniel Vetter * Driver supports DMA, the userspace DMA API will be supported. Only 1490e2a933bSDaniel Vetter * for legacy drivers. Do not use. 1500e2a933bSDaniel Vetter */ 1511ff49481SDaniel Vetter DRIVER_HAVE_DMA = BIT(29), 1520e2a933bSDaniel Vetter /** 1530e2a933bSDaniel Vetter * @DRIVER_HAVE_IRQ: 1540e2a933bSDaniel Vetter * 1550e2a933bSDaniel Vetter * Legacy irq support. Only for legacy drivers. Do not use. 1560e2a933bSDaniel Vetter */ 1571ff49481SDaniel Vetter DRIVER_HAVE_IRQ = BIT(30), 1580e2a933bSDaniel Vetter }; 15985e634bcSDaniel Vetter 16085e634bcSDaniel Vetter /** 16185e634bcSDaniel Vetter * struct drm_driver - DRM driver structure 16285e634bcSDaniel Vetter * 16360e6ecfbSLuca Ceresoli * This structure represent the common code for a family of cards. There will be 16460e6ecfbSLuca Ceresoli * one &struct drm_device for each card present in this family. It contains lots 16560e6ecfbSLuca Ceresoli * of vfunc entries, and a pile of those probably should be moved to more 16685e634bcSDaniel Vetter * appropriate places like &drm_mode_config_funcs or into a new operations 16785e634bcSDaniel Vetter * structure for GEM drivers. 16885e634bcSDaniel Vetter */ 16985e634bcSDaniel Vetter struct drm_driver { 17056926500SGabriel Krisman Bertazi /** 17156926500SGabriel Krisman Bertazi * @load: 17256926500SGabriel Krisman Bertazi * 1734c8e84b8SDaniel Vetter * Backward-compatible driver callback to complete initialization steps 1744c8e84b8SDaniel Vetter * after the driver is registered. For this reason, may suffer from 1754c8e84b8SDaniel Vetter * race conditions and its use is deprecated for new drivers. It is 1764c8e84b8SDaniel Vetter * therefore only supported for existing drivers not yet converted to 1774c8e84b8SDaniel Vetter * the new scheme. See devm_drm_dev_alloc() and drm_dev_register() for 1784c8e84b8SDaniel Vetter * proper and race-free way to set up a &struct drm_device. 17956926500SGabriel Krisman Bertazi * 180b93658f8SDaniel Vetter * This is deprecated, do not use! 181b93658f8SDaniel Vetter * 18256926500SGabriel Krisman Bertazi * Returns: 18356926500SGabriel Krisman Bertazi * 18456926500SGabriel Krisman Bertazi * Zero on success, non-zero value on failure. 18556926500SGabriel Krisman Bertazi */ 18685e634bcSDaniel Vetter int (*load) (struct drm_device *, unsigned long flags); 187b93658f8SDaniel Vetter 188b93658f8SDaniel Vetter /** 189b93658f8SDaniel Vetter * @open: 190b93658f8SDaniel Vetter * 191b93658f8SDaniel Vetter * Driver callback when a new &struct drm_file is opened. Useful for 192b93658f8SDaniel Vetter * setting up driver-private data structures like buffer allocators, 193b93658f8SDaniel Vetter * execution contexts or similar things. Such driver-private resources 194b93658f8SDaniel Vetter * must be released again in @postclose. 195b93658f8SDaniel Vetter * 196b93658f8SDaniel Vetter * Since the display/modeset side of DRM can only be owned by exactly 197b93658f8SDaniel Vetter * one &struct drm_file (see &drm_file.is_master and &drm_device.master) 198b93658f8SDaniel Vetter * there should never be a need to set up any modeset related resources 199b93658f8SDaniel Vetter * in this callback. Doing so would be a driver design bug. 200b93658f8SDaniel Vetter * 201b93658f8SDaniel Vetter * Returns: 202b93658f8SDaniel Vetter * 203b93658f8SDaniel Vetter * 0 on success, a negative error code on failure, which will be 204b93658f8SDaniel Vetter * promoted to userspace as the result of the open() system call. 205b93658f8SDaniel Vetter */ 20685e634bcSDaniel Vetter int (*open) (struct drm_device *, struct drm_file *); 207b93658f8SDaniel Vetter 208b93658f8SDaniel Vetter /** 209b93658f8SDaniel Vetter * @postclose: 210b93658f8SDaniel Vetter * 211b93658f8SDaniel Vetter * One of the driver callbacks when a new &struct drm_file is closed. 212b93658f8SDaniel Vetter * Useful for tearing down driver-private data structures allocated in 213b93658f8SDaniel Vetter * @open like buffer allocators, execution contexts or similar things. 214b93658f8SDaniel Vetter * 215b93658f8SDaniel Vetter * Since the display/modeset side of DRM can only be owned by exactly 216b93658f8SDaniel Vetter * one &struct drm_file (see &drm_file.is_master and &drm_device.master) 217b93658f8SDaniel Vetter * there should never be a need to tear down any modeset related 218b93658f8SDaniel Vetter * resources in this callback. Doing so would be a driver design bug. 219b93658f8SDaniel Vetter */ 22085e634bcSDaniel Vetter void (*postclose) (struct drm_device *, struct drm_file *); 221b93658f8SDaniel Vetter 222b93658f8SDaniel Vetter /** 223b93658f8SDaniel Vetter * @lastclose: 224b93658f8SDaniel Vetter * 225b93658f8SDaniel Vetter * Called when the last &struct drm_file has been closed and there's 226b93658f8SDaniel Vetter * currently no userspace client for the &struct drm_device. 227b93658f8SDaniel Vetter * 228b93658f8SDaniel Vetter * Modern drivers should only use this to force-restore the fbdev 229b93658f8SDaniel Vetter * framebuffer using drm_fb_helper_restore_fbdev_mode_unlocked(). 230b93658f8SDaniel Vetter * Anything else would indicate there's something seriously wrong. 231b93658f8SDaniel Vetter * Modern drivers can also use this to execute delayed power switching 232b93658f8SDaniel Vetter * state changes, e.g. in conjunction with the :ref:`vga_switcheroo` 233b93658f8SDaniel Vetter * infrastructure. 234b93658f8SDaniel Vetter * 23545c3d213SDaniel Vetter * This is called after @postclose hook has been called. 236b93658f8SDaniel Vetter * 237b93658f8SDaniel Vetter * NOTE: 238b93658f8SDaniel Vetter * 239b93658f8SDaniel Vetter * All legacy drivers use this callback to de-initialize the hardware. 240b93658f8SDaniel Vetter * This is purely because of the shadow-attach model, where the DRM 241b93658f8SDaniel Vetter * kernel driver does not really own the hardware. Instead ownershipe is 242b93658f8SDaniel Vetter * handled with the help of userspace through an inheritedly racy dance 243b93658f8SDaniel Vetter * to set/unset the VT into raw mode. 244b93658f8SDaniel Vetter * 245b93658f8SDaniel Vetter * Legacy drivers initialize the hardware in the @firstopen callback, 246b93658f8SDaniel Vetter * which isn't even called for modern drivers. 247b93658f8SDaniel Vetter */ 24885e634bcSDaniel Vetter void (*lastclose) (struct drm_device *); 24956926500SGabriel Krisman Bertazi 25056926500SGabriel Krisman Bertazi /** 25156926500SGabriel Krisman Bertazi * @unload: 25256926500SGabriel Krisman Bertazi * 25356926500SGabriel Krisman Bertazi * Reverse the effects of the driver load callback. Ideally, 25456926500SGabriel Krisman Bertazi * the clean up performed by the driver should happen in the 25556926500SGabriel Krisman Bertazi * reverse order of the initialization. Similarly to the load 25656926500SGabriel Krisman Bertazi * hook, this handler is deprecated and its usage should be 25756926500SGabriel Krisman Bertazi * dropped in favor of an open-coded teardown function at the 2589a96f550SAishwarya Pant * driver layer. See drm_dev_unregister() and drm_dev_put() 25956926500SGabriel Krisman Bertazi * for the proper way to remove a &struct drm_device. 26056926500SGabriel Krisman Bertazi * 26156926500SGabriel Krisman Bertazi * The unload() hook is called right after unregistering 26256926500SGabriel Krisman Bertazi * the device. 26356926500SGabriel Krisman Bertazi * 26456926500SGabriel Krisman Bertazi */ 26511b3c20bSGabriel Krisman Bertazi void (*unload) (struct drm_device *); 266f30c9257SChris Wilson 267f30c9257SChris Wilson /** 268f30c9257SChris Wilson * @release: 269f30c9257SChris Wilson * 270f30c9257SChris Wilson * Optional callback for destroying device data after the final 271d33b58d0SDaniel Vetter * reference is released, i.e. the device is being destroyed. 2729e1ed9fbSDaniel Vetter * 2739e1ed9fbSDaniel Vetter * This is deprecated, clean up all memory allocations associated with a 2749e1ed9fbSDaniel Vetter * &drm_device using drmm_add_action(), drmm_kmalloc() and related 2759e1ed9fbSDaniel Vetter * managed resources functions. 276f30c9257SChris Wilson */ 277f30c9257SChris Wilson void (*release) (struct drm_device *); 278f30c9257SChris Wilson 27985e634bcSDaniel Vetter /** 2806c4789edSDaniel Vetter * @master_set: 2816c4789edSDaniel Vetter * 2826c4789edSDaniel Vetter * Called whenever the minor master is set. Only used by vmwgfx. 2836c4789edSDaniel Vetter */ 284907f5320SEmil Velikov void (*master_set)(struct drm_device *dev, struct drm_file *file_priv, 28585e634bcSDaniel Vetter bool from_open); 2866c4789edSDaniel Vetter /** 2876c4789edSDaniel Vetter * @master_drop: 2886c4789edSDaniel Vetter * 2896c4789edSDaniel Vetter * Called whenever the minor master is dropped. Only used by vmwgfx. 2906c4789edSDaniel Vetter */ 29185e634bcSDaniel Vetter void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv); 29285e634bcSDaniel Vetter 293d1b6c62fSSean Paul /** 294d1b6c62fSSean Paul * @debugfs_init: 295d1b6c62fSSean Paul * 296d1b6c62fSSean Paul * Allows drivers to create driver-specific debugfs files. 297d1b6c62fSSean Paul */ 2987ce84471SWambui Karuga void (*debugfs_init)(struct drm_minor *minor); 29985e634bcSDaniel Vetter 30085e634bcSDaniel Vetter /** 301218adc17SChris Wilson * @gem_create_object: constructor for gem objects 302218adc17SChris Wilson * 3034ff22f48SThomas Zimmermann * Hook for allocating the GEM object struct, for use by the CMA 3044ff22f48SThomas Zimmermann * and SHMEM GEM helpers. Returns a GEM object on success, or an 3054ff22f48SThomas Zimmermann * ERR_PTR()-encoded error code otherwise. 30685e634bcSDaniel Vetter */ 30785e634bcSDaniel Vetter struct drm_gem_object *(*gem_create_object)(struct drm_device *dev, 30885e634bcSDaniel Vetter size_t size); 309d693def4SThomas Zimmermann 310d1b6c62fSSean Paul /** 311d1b6c62fSSean Paul * @prime_handle_to_fd: 312d1b6c62fSSean Paul * 3136b85aa68SThomas Zimmermann * PRIME export function. Only used by vmwgfx. 314d1b6c62fSSean Paul */ 31585e634bcSDaniel Vetter int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv, 31685e634bcSDaniel Vetter uint32_t handle, uint32_t flags, int *prime_fd); 317d1b6c62fSSean Paul /** 318d1b6c62fSSean Paul * @prime_fd_to_handle: 319d1b6c62fSSean Paul * 3206b85aa68SThomas Zimmermann * PRIME import function. Only used by vmwgfx. 321d1b6c62fSSean Paul */ 32285e634bcSDaniel Vetter int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv, 32385e634bcSDaniel Vetter int prime_fd, uint32_t *handle); 324d693def4SThomas Zimmermann 325d1b6c62fSSean Paul /** 326d1b6c62fSSean Paul * @gem_prime_import: 327d1b6c62fSSean Paul * 328805dc614SDaniel Vetter * Import hook for GEM drivers. 329f0014881SNoralf Trønnes * 330f0014881SNoralf Trønnes * This defaults to drm_gem_prime_import() if not set. 331d1b6c62fSSean Paul */ 33285e634bcSDaniel Vetter struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev, 33385e634bcSDaniel Vetter struct dma_buf *dma_buf); 334805dc614SDaniel Vetter /** 335805dc614SDaniel Vetter * @gem_prime_import_sg_table: 336805dc614SDaniel Vetter * 337805dc614SDaniel Vetter * Optional hook used by the PRIME helper functions 338805dc614SDaniel Vetter * drm_gem_prime_import() respectively drm_gem_prime_import_dev(). 339805dc614SDaniel Vetter */ 34085e634bcSDaniel Vetter struct drm_gem_object *(*gem_prime_import_sg_table)( 34185e634bcSDaniel Vetter struct drm_device *dev, 34285e634bcSDaniel Vetter struct dma_buf_attachment *attach, 34385e634bcSDaniel Vetter struct sg_table *sgt); 34485e634bcSDaniel Vetter 3454f93624eSDaniel Vetter /** 3464f93624eSDaniel Vetter * @dumb_create: 3474f93624eSDaniel Vetter * 3484f93624eSDaniel Vetter * This creates a new dumb buffer in the driver's backing storage manager (GEM, 3494f93624eSDaniel Vetter * TTM or something else entirely) and returns the resulting buffer handle. This 3504f93624eSDaniel Vetter * handle can then be wrapped up into a framebuffer modeset object. 3514f93624eSDaniel Vetter * 3524f93624eSDaniel Vetter * Note that userspace is not allowed to use such objects for render 3534f93624eSDaniel Vetter * acceleration - drivers must create their own private ioctls for such a use 3544f93624eSDaniel Vetter * case. 3554f93624eSDaniel Vetter * 3564f93624eSDaniel Vetter * Width, height and depth are specified in the &drm_mode_create_dumb 3574f93624eSDaniel Vetter * argument. The callback needs to fill the handle, pitch and size for 3584f93624eSDaniel Vetter * the created buffer. 3594f93624eSDaniel Vetter * 3604f93624eSDaniel Vetter * Called by the user via ioctl. 3614f93624eSDaniel Vetter * 3624f93624eSDaniel Vetter * Returns: 3634f93624eSDaniel Vetter * 3644f93624eSDaniel Vetter * Zero on success, negative errno on failure. 3654f93624eSDaniel Vetter */ 36685e634bcSDaniel Vetter int (*dumb_create)(struct drm_file *file_priv, 36785e634bcSDaniel Vetter struct drm_device *dev, 36885e634bcSDaniel Vetter struct drm_mode_create_dumb *args); 3694f93624eSDaniel Vetter /** 3704f93624eSDaniel Vetter * @dumb_map_offset: 3714f93624eSDaniel Vetter * 3724f93624eSDaniel Vetter * Allocate an offset in the drm device node's address space to be able to 37339dea70dSDaniel Vetter * memory map a dumb buffer. 37439dea70dSDaniel Vetter * 37539dea70dSDaniel Vetter * The default implementation is drm_gem_create_mmap_offset(). GEM based 37639dea70dSDaniel Vetter * drivers must not overwrite this. 3774f93624eSDaniel Vetter * 3784f93624eSDaniel Vetter * Called by the user via ioctl. 3794f93624eSDaniel Vetter * 3804f93624eSDaniel Vetter * Returns: 3814f93624eSDaniel Vetter * 3824f93624eSDaniel Vetter * Zero on success, negative errno on failure. 3834f93624eSDaniel Vetter */ 38485e634bcSDaniel Vetter int (*dumb_map_offset)(struct drm_file *file_priv, 38585e634bcSDaniel Vetter struct drm_device *dev, uint32_t handle, 38685e634bcSDaniel Vetter uint64_t *offset); 38785e634bcSDaniel Vetter 3883f09a0cdSRob Clark /** 3893f09a0cdSRob Clark * @show_fdinfo: 3903f09a0cdSRob Clark * 3913f09a0cdSRob Clark * Print device specific fdinfo. See Documentation/gpu/drm-usage-stats.rst. 3923f09a0cdSRob Clark */ 3933f09a0cdSRob Clark void (*show_fdinfo)(struct drm_printer *p, struct drm_file *f); 3943f09a0cdSRob Clark 395d1b6c62fSSean Paul /** @major: driver major number */ 39685e634bcSDaniel Vetter int major; 397d1b6c62fSSean Paul /** @minor: driver minor number */ 39885e634bcSDaniel Vetter int minor; 399d1b6c62fSSean Paul /** @patchlevel: driver patch level */ 40085e634bcSDaniel Vetter int patchlevel; 401d1b6c62fSSean Paul /** @name: driver name */ 40285e634bcSDaniel Vetter char *name; 403d1b6c62fSSean Paul /** @desc: driver description */ 40485e634bcSDaniel Vetter char *desc; 405d1b6c62fSSean Paul /** @date: driver date */ 40685e634bcSDaniel Vetter char *date; 40785e634bcSDaniel Vetter 4080e2a933bSDaniel Vetter /** 4090e2a933bSDaniel Vetter * @driver_features: 4100e2a933bSDaniel Vetter * Driver features, see &enum drm_driver_feature. Drivers can disable 4110e2a933bSDaniel Vetter * some features on a per-instance basis using 4120e2a933bSDaniel Vetter * &drm_device.driver_features. 4130e2a933bSDaniel Vetter */ 41485e634bcSDaniel Vetter u32 driver_features; 415bb2eaba6SDaniel Vetter 416bb2eaba6SDaniel Vetter /** 417bb2eaba6SDaniel Vetter * @ioctls: 418bb2eaba6SDaniel Vetter * 419bb2eaba6SDaniel Vetter * Array of driver-private IOCTL description entries. See the chapter on 420bb2eaba6SDaniel Vetter * :ref:`IOCTL support in the userland interfaces 421bb2eaba6SDaniel Vetter * chapter<drm_driver_ioctl>` for the full details. 422bb2eaba6SDaniel Vetter */ 423bb2eaba6SDaniel Vetter 42485e634bcSDaniel Vetter const struct drm_ioctl_desc *ioctls; 425bb2eaba6SDaniel Vetter /** @num_ioctls: Number of entries in @ioctls. */ 42685e634bcSDaniel Vetter int num_ioctls; 427bb2eaba6SDaniel Vetter 428bb2eaba6SDaniel Vetter /** 429bb2eaba6SDaniel Vetter * @fops: 430bb2eaba6SDaniel Vetter * 431bb2eaba6SDaniel Vetter * File operations for the DRM device node. See the discussion in 432bb2eaba6SDaniel Vetter * :ref:`file operations<drm_driver_fops>` for in-depth coverage and 433bb2eaba6SDaniel Vetter * some examples. 434bb2eaba6SDaniel Vetter */ 43585e634bcSDaniel Vetter const struct file_operations *fops; 43685e634bcSDaniel Vetter 43757bb1ee6SDaniel Vetter #ifdef CONFIG_DRM_LEGACY 4380683c0abSDaniel Vetter /* Everything below here is for legacy driver, never use! */ 4390683c0abSDaniel Vetter /* private: */ 4400683c0abSDaniel Vetter 4410683c0abSDaniel Vetter int (*firstopen) (struct drm_device *); 44245c3d213SDaniel Vetter void (*preclose) (struct drm_device *, struct drm_file *file_priv); 4430683c0abSDaniel Vetter int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv); 4440683c0abSDaniel Vetter int (*dma_quiescent) (struct drm_device *); 4450683c0abSDaniel Vetter int (*context_dtor) (struct drm_device *dev, int context); 446c1736b90SThomas Zimmermann irqreturn_t (*irq_handler)(int irq, void *arg); 447c1736b90SThomas Zimmermann void (*irq_preinstall)(struct drm_device *dev); 448c1736b90SThomas Zimmermann int (*irq_postinstall)(struct drm_device *dev); 449c1736b90SThomas Zimmermann void (*irq_uninstall)(struct drm_device *dev); 450f397d66bSThomas Zimmermann u32 (*get_vblank_counter)(struct drm_device *dev, unsigned int pipe); 451f397d66bSThomas Zimmermann int (*enable_vblank)(struct drm_device *dev, unsigned int pipe); 452f397d66bSThomas Zimmermann void (*disable_vblank)(struct drm_device *dev, unsigned int pipe); 4530683c0abSDaniel Vetter int dev_priv_size; 45457bb1ee6SDaniel Vetter #endif 45585e634bcSDaniel Vetter }; 45685e634bcSDaniel Vetter 4578f5c7aa0SDaniel Vetter void *__devm_drm_dev_alloc(struct device *parent, 4588f5c7aa0SDaniel Vetter const struct drm_driver *driver, 459b0b5849eSDaniel Vetter size_t size, size_t offset); 460b0b5849eSDaniel Vetter 461b0b5849eSDaniel Vetter /** 462b0b5849eSDaniel Vetter * devm_drm_dev_alloc - Resource managed allocation of a &drm_device instance 463b0b5849eSDaniel Vetter * @parent: Parent device object 464b0b5849eSDaniel Vetter * @driver: DRM driver 465b0b5849eSDaniel Vetter * @type: the type of the struct which contains struct &drm_device 466b0b5849eSDaniel Vetter * @member: the name of the &drm_device within @type. 467b0b5849eSDaniel Vetter * 468b0b5849eSDaniel Vetter * This allocates and initialize a new DRM device. No device registration is done. 469b0b5849eSDaniel Vetter * Call drm_dev_register() to advertice the device to user space and register it 470b0b5849eSDaniel Vetter * with other core subsystems. This should be done last in the device 471b0b5849eSDaniel Vetter * initialization sequence to make sure userspace can't access an inconsistent 472b0b5849eSDaniel Vetter * state. 473b0b5849eSDaniel Vetter * 474b0b5849eSDaniel Vetter * The initial ref-count of the object is 1. Use drm_dev_get() and 475b0b5849eSDaniel Vetter * drm_dev_put() to take and drop further ref-counts. 476b0b5849eSDaniel Vetter * 477b0b5849eSDaniel Vetter * It is recommended that drivers embed &struct drm_device into their own device 478b0b5849eSDaniel Vetter * structure. 479b0b5849eSDaniel Vetter * 480b0b5849eSDaniel Vetter * Note that this manages the lifetime of the resulting &drm_device 481b0b5849eSDaniel Vetter * automatically using devres. The DRM device initialized with this function is 482b0b5849eSDaniel Vetter * automatically put on driver detach using drm_dev_put(). 483b0b5849eSDaniel Vetter * 484b0b5849eSDaniel Vetter * RETURNS: 485b0b5849eSDaniel Vetter * Pointer to new DRM device, or ERR_PTR on failure. 486b0b5849eSDaniel Vetter */ 487b0b5849eSDaniel Vetter #define devm_drm_dev_alloc(parent, driver, type, member) \ 488b0b5849eSDaniel Vetter ((type *) __devm_drm_dev_alloc(parent, driver, sizeof(type), \ 489b0b5849eSDaniel Vetter offsetof(type, member))) 490b0b5849eSDaniel Vetter 4918f5c7aa0SDaniel Vetter struct drm_device *drm_dev_alloc(const struct drm_driver *driver, 49285e634bcSDaniel Vetter struct device *parent); 49385e634bcSDaniel Vetter int drm_dev_register(struct drm_device *dev, unsigned long flags); 49485e634bcSDaniel Vetter void drm_dev_unregister(struct drm_device *dev); 49585e634bcSDaniel Vetter 4969a96f550SAishwarya Pant void drm_dev_get(struct drm_device *dev); 4979a96f550SAishwarya Pant void drm_dev_put(struct drm_device *dev); 49885e634bcSDaniel Vetter void drm_put_dev(struct drm_device *dev); 499bee330f3SNoralf Trønnes bool drm_dev_enter(struct drm_device *dev, int *idx); 500bee330f3SNoralf Trønnes void drm_dev_exit(int idx); 501c07dcd61SDaniel Vetter void drm_dev_unplug(struct drm_device *dev); 502c07dcd61SDaniel Vetter 503c07dcd61SDaniel Vetter /** 504c07dcd61SDaniel Vetter * drm_dev_is_unplugged - is a DRM device unplugged 505c07dcd61SDaniel Vetter * @dev: DRM device 506c07dcd61SDaniel Vetter * 507c07dcd61SDaniel Vetter * This function can be called to check whether a hotpluggable is unplugged. 508c07dcd61SDaniel Vetter * Unplugging itself is singalled through drm_dev_unplug(). If a device is 509c07dcd61SDaniel Vetter * unplugged, these two functions guarantee that any store before calling 510c07dcd61SDaniel Vetter * drm_dev_unplug() is visible to callers of this function after it completes 511168982d2SDaniel Vetter * 512168982d2SDaniel Vetter * WARNING: This function fundamentally races against drm_dev_unplug(). It is 513168982d2SDaniel Vetter * recommended that drivers instead use the underlying drm_dev_enter() and 514168982d2SDaniel Vetter * drm_dev_exit() function pairs. 515c07dcd61SDaniel Vetter */ 516bee330f3SNoralf Trønnes static inline bool drm_dev_is_unplugged(struct drm_device *dev) 517c07dcd61SDaniel Vetter { 518bee330f3SNoralf Trønnes int idx; 519bee330f3SNoralf Trønnes 520bee330f3SNoralf Trønnes if (drm_dev_enter(dev, &idx)) { 521bee330f3SNoralf Trønnes drm_dev_exit(idx); 522bee330f3SNoralf Trønnes return false; 523bee330f3SNoralf Trønnes } 524bee330f3SNoralf Trønnes 525bee330f3SNoralf Trønnes return true; 526c07dcd61SDaniel Vetter } 527c07dcd61SDaniel Vetter 5283479fc24SDaniel Vetter /** 52912a1d4e0SJani Nikula * drm_core_check_all_features - check driver feature flags mask 53012a1d4e0SJani Nikula * @dev: DRM device to check 53112a1d4e0SJani Nikula * @features: feature flag(s) mask 53212a1d4e0SJani Nikula * 53312a1d4e0SJani Nikula * This checks @dev for driver features, see &drm_driver.driver_features, 53412a1d4e0SJani Nikula * &drm_device.driver_features, and the various &enum drm_driver_feature flags. 53512a1d4e0SJani Nikula * 53612a1d4e0SJani Nikula * Returns true if all features in the @features mask are supported, false 53712a1d4e0SJani Nikula * otherwise. 53812a1d4e0SJani Nikula */ 53912a1d4e0SJani Nikula static inline bool drm_core_check_all_features(const struct drm_device *dev, 54012a1d4e0SJani Nikula u32 features) 54112a1d4e0SJani Nikula { 54212a1d4e0SJani Nikula u32 supported = dev->driver->driver_features & dev->driver_features; 54312a1d4e0SJani Nikula 54412a1d4e0SJani Nikula return features && (supported & features) == features; 54512a1d4e0SJani Nikula } 54612a1d4e0SJani Nikula 54712a1d4e0SJani Nikula /** 5483479fc24SDaniel Vetter * drm_core_check_feature - check driver feature flags 5493479fc24SDaniel Vetter * @dev: DRM device to check 5503479fc24SDaniel Vetter * @feature: feature flag 5513479fc24SDaniel Vetter * 55218ace11fSVille Syrjälä * This checks @dev for driver features, see &drm_driver.driver_features, 5530e2a933bSDaniel Vetter * &drm_device.driver_features, and the various &enum drm_driver_feature flags. 5543479fc24SDaniel Vetter * 5553479fc24SDaniel Vetter * Returns true if the @feature is supported, false otherwise. 5563479fc24SDaniel Vetter */ 55712a1d4e0SJani Nikula static inline bool drm_core_check_feature(const struct drm_device *dev, 55812a1d4e0SJani Nikula enum drm_driver_feature feature) 5593479fc24SDaniel Vetter { 56012a1d4e0SJani Nikula return drm_core_check_all_features(dev, feature); 5613479fc24SDaniel Vetter } 5623479fc24SDaniel Vetter 5633479fc24SDaniel Vetter /** 5643479fc24SDaniel Vetter * drm_drv_uses_atomic_modeset - check if the driver implements 5653479fc24SDaniel Vetter * atomic_commit() 5663479fc24SDaniel Vetter * @dev: DRM device 5673479fc24SDaniel Vetter * 5683479fc24SDaniel Vetter * This check is useful if drivers do not have DRIVER_ATOMIC set but 5693479fc24SDaniel Vetter * have atomic modesetting internally implemented. 5703479fc24SDaniel Vetter */ 5713479fc24SDaniel Vetter static inline bool drm_drv_uses_atomic_modeset(struct drm_device *dev) 5723479fc24SDaniel Vetter { 5733479fc24SDaniel Vetter return drm_core_check_feature(dev, DRIVER_ATOMIC) || 57457078338SDave Airlie (dev->mode_config.funcs && dev->mode_config.funcs->atomic_commit != NULL); 5753479fc24SDaniel Vetter } 5763479fc24SDaniel Vetter 57785e634bcSDaniel Vetter 5789a758d87SThomas Zimmermann /* TODO: Inline drm_firmware_drivers_only() in all its callers. */ 5799a758d87SThomas Zimmermann static inline bool drm_firmware_drivers_only(void) 5809a758d87SThomas Zimmermann { 5819a758d87SThomas Zimmermann return video_firmware_drivers_only(); 5829a758d87SThomas Zimmermann } 58363207455SDave Airlie 58485e634bcSDaniel Vetter #endif 585