1 // SPDX-License-Identifier: GPL-2.0
3  * device.h - generic, centralized driver model
5  * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
6  * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de>
7  * Copyright (c) 2008-2009 Novell Inc.
9  * See Documentation/driver-api/driver-model/ for more information.
51  * struct subsys_interface - interfaces to device functions
61  * a specific functionality of a subsystem/class of devices.
83  * This identifies the device type and carries type-specific
100  * struct device_attribute - Interface for exporting device attributes.
114  * struct dev_ext_attribute - Exported device attribute with extra context.
139  * DEVICE_ATTR - Define a device attribute.
149  * .. code-block:: c
161  * DEVICE_ATTR_PREALLOC - Define a preallocated device attribute.
174  * DEVICE_ATTR_RW - Define a read-write device attribute.
184  * DEVICE_ATTR_ADMIN_RW - Define an admin-only read-write device attribute.
193  * DEVICE_ATTR_RO - Define a readable device attribute.
202  * DEVICE_ATTR_ADMIN_RO - Define an admin-only readable device attribute.
211  * DEVICE_ATTR_WO - Define an admin-only writable device attribute.
220  * DEVICE_ULONG_ATTR - Define a device attribute backed by an unsigned long.
233  * DEVICE_INT_ATTR - Define a device attribute backed by an int.
245  * DEVICE_BOOL_ATTR - Define a device attribute backed by a bool.
257  * DEVICE_STRING_ATTR_RO - Define a device attribute backed by a r/o string.
263  * string allocation is unknown, the attribute must be read-only.
381 	return ERR_PTR(-EINVAL);  in devm_ioremap_resource()
388 	return ERR_PTR(-EINVAL);  in devm_ioremap_resource_wc()
396 	return ERR_PTR(-EINVAL);  in devm_of_iomap()
424  * devm_alloc_percpu - Resource-managed alloc_percpu
425  * @dev: Device to allocate per-cpu memory for
426  * @type: Type to allocate per-cpu memory for
428  * Managed alloc_percpu. Per-cpu memory allocated with this function is
453  * enum device_link_state - Device link states.
462 	DL_STATE_NONE = -1,
495  * enum dl_dev_state - Device driver presence tracking information.
509  * enum device_removable - Whether the device is removable. The criteria for a
525  * struct dev_links_info - Device data related to device links.
539  * struct dev_msi_info - Device data related to MSI
551  * enum device_physical_location_panel - Describes which panel surface of the
553  * @DEVICE_PANEL_TOP: Device connection point is on the top panel.
554  * @DEVICE_PANEL_BOTTOM: Device connection point is on the bottom panel.
555  * @DEVICE_PANEL_LEFT: Device connection point is on the left panel.
556  * @DEVICE_PANEL_RIGHT: Device connection point is on the right panel.
557  * @DEVICE_PANEL_FRONT: Device connection point is on the front panel.
558  * @DEVICE_PANEL_BACK: Device connection point is on the back panel.
559  * @DEVICE_PANEL_UNKNOWN: The panel with device connection point is unknown.
572  * enum device_physical_location_vertical_position - Describes vertical
573  * position of the device connection point on the panel surface.
574  * @DEVICE_VERT_POS_UPPER: Device connection point is at upper part of panel.
575  * @DEVICE_VERT_POS_CENTER: Device connection point is at center part of panel.
576  * @DEVICE_VERT_POS_LOWER: Device connection point is at lower part of panel.
585  * enum device_physical_location_horizontal_position - Describes horizontal
586  * position of the device connection point on the panel surface.
587  * @DEVICE_HORI_POS_LEFT: Device connection point is at left part of panel.
588  * @DEVICE_HORI_POS_CENTER: Device connection point is at center part of panel.
589  * @DEVICE_HORI_POS_RIGHT: Device connection point is at right part of panel.
598  * struct device_physical_location - Device data related to physical location
600  * @panel: Panel surface of the system's housing that the device connection
603  *                     the panel.
605  *                       within the panel.
612 	enum device_physical_location_panel panel;  member
620  * struct device - The basic device structure
623  * 		controller. If parent is NULL, the device, is a top-level device,
627  * @kobj:	A top-level, abstract class from which other classes are derived.
630  * 		This identifies the device type and carries type-specific
635  * @platform_data: Platform data specific to the device.
638  * 		to board-specific structures describing devices and how they
642  * 		minimizes board-specific #ifdefs in drivers.
643  * @driver_data: Private pointer for driver specific info.
646  *		See Documentation/driver-api/pm/devices.rst for details.
649  * 		along with subsystem-level and driver-level callbacks.
652  *		See Documentation/driver-api/pin-control.rst for details.
658  * 		hardware supports 64-bit addresses for consistent allocations
672  * @archdata:	For arch-specific additions.
694  * @of_node_reused: Set if the device-tree node is shared with an ancestor
703  *		architecture supports non-coherent devices.
705  *		streaming DMA operations (->map_* / ->unmap_* / ->sync_*),
708  *		instance from ->dma_supported.
719  * a higher-level representation of the device.
733 	void		*platform_data;	/* Platform specific data, device
785 	/* arch specific additions */
833  * struct device_link - Device link representation.
841  * @rpm_active: Whether or not the consumer device is runtime-PM-active.
863  * device_iommu_mapped - Returns true when the device DMA is translated
869 	return (dev->iommu_group != NULL);  in device_iommu_mapped()
876  * dev_name - Return a device's name.
883 	if (dev->init_name)  in dev_name()
884 		return dev->init_name;  in dev_name()
886 	return kobject_name(&dev->kobj);  in dev_name()
890  * dev_bus_name - Return a device's bus/class name, if at all possible
898 	return dev->bus ? dev->bus->name : (dev->class ? dev->class->name : "");  in dev_bus_name()
906 	return dev->numa_node;  in dev_to_node()
910 	dev->numa_node = node;  in set_dev_node()
925 	return dev->msi.domain;  in dev_get_msi_domain()
934 	dev->msi.domain = d;  in dev_set_msi_domain()
940 	return dev->driver_data;  in dev_get_drvdata()
945 	dev->driver_data = data;  in dev_set_drvdata()
950 	return dev ? dev->power.subsys_data : NULL;  in dev_to_psd()
955 	return dev->kobj.uevent_suppress;  in dev_get_uevent_suppress()
960 	dev->kobj.uevent_suppress = val;  in dev_set_uevent_suppress()
965 	return dev->kobj.state_in_sysfs;  in device_is_registered()
970 	if (!dev->power.is_prepared)  in device_enable_async_suspend()
971 		dev->power.async_suspend = true;  in device_enable_async_suspend()
976 	if (!dev->power.is_prepared)  in device_disable_async_suspend()
977 		dev->power.async_suspend = false;  in device_disable_async_suspend()
982 	return !!dev->power.async_suspend;  in device_async_suspend_enabled()
987 	return dev->power.no_pm;  in device_pm_not_required()
992 	dev->power.no_pm = true;  in device_set_pm_not_required()
998 	dev->power.syscore = val;  in dev_pm_syscore_device()
1004 	dev->power.driver_flags = flags;  in dev_pm_set_driver_flags()
1009 	return !!(dev->power.driver_flags & flags);  in dev_pm_test_driver_flags()
1014 	mutex_lock(&dev->mutex);  in device_lock()
1019 	return mutex_lock_interruptible(&dev->mutex);  in device_lock_interruptible()
1024 	return mutex_trylock(&dev->mutex);  in device_trylock()
1029 	mutex_unlock(&dev->mutex);  in device_unlock()
1036 	lockdep_assert_held(&dev->mutex);  in DEFINE_GUARD()
1043 	if (dev->driver && dev->driver->sync_state)  in dev_has_sync_state()
1045 	if (dev->bus && dev->bus->sync_state)  in dev_has_sync_state()
1053 	dev->removable = removable;  in dev_set_removable()
1058 	return dev->removable == DEVICE_REMOVABLE;  in dev_is_removable()
1063 	return dev->removable != DEVICE_REMOVABLE_NOT_SUPPORTED;  in dev_removable_is_valid()
1097 	return dev->bus && dev->bus->offline && dev->bus->online;  in device_supports_offline()
1103 	lock_set_class(&__d2->mutex.dep_map, name, key, 0, _THIS_IP_); \
1107  * device_lock_set_class - Specify a temporary lock class while a device
1113  * from driver ->probe(). Take care to only override the default
1120 	dev_WARN_ONCE(__d, !lockdep_match_class(&__d->mutex,               \
1130  * device_lock_reset_class - Return a device to the default lockdep novalidate state
1134  * from driver ->remove().
1139 	lock_set_novalidate_class(&__d->mutex.dep_map, "&dev->mutex",  \
1158 	return dev->of_node;  in dev_of_node()
1163 	if (dev->bus && dev->bus->num_vf)  in dev_num_vf()
1164 		return dev->bus->num_vf(dev);  in dev_num_vf()
1181 	return dev->platform_data;  in dev_get_platdata()
1236  * get_device - atomically increment the reference count for the device.
1269 	MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1271 	MODULE_ALIAS("char-major-" __stringify(major) "-*")