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.
137  * DEVICE_ATTR - Define a device attribute.
147  * .. code-block:: c
159  * DEVICE_ATTR_PREALLOC - Define a preallocated device attribute.
172  * DEVICE_ATTR_RW - Define a read-write device attribute.
182  * DEVICE_ATTR_ADMIN_RW - Define an admin-only read-write device attribute.
191  * DEVICE_ATTR_RO - Define a readable device attribute.
200  * DEVICE_ATTR_ADMIN_RO - Define an admin-only readable device attribute.
209  * DEVICE_ATTR_WO - Define an admin-only writable device attribute.
218  * DEVICE_ULONG_ATTR - Define a device attribute backed by an unsigned long.
231  * DEVICE_INT_ATTR - Define a device attribute backed by an int.
243  * DEVICE_BOOL_ATTR - Define a device attribute backed by a bool.
366 	return ERR_PTR(-EINVAL);  in devm_ioremap_resource()
373 	return ERR_PTR(-EINVAL);  in devm_ioremap_resource_wc()
381 	return ERR_PTR(-EINVAL);  in devm_of_iomap()
409  * devm_alloc_percpu - Resource-managed alloc_percpu
410  * @dev: Device to allocate per-cpu memory for
411  * @type: Type to allocate per-cpu memory for
413  * Managed alloc_percpu. Per-cpu memory allocated with this function is
438  * enum device_link_state - Device link states.
447 	DL_STATE_NONE = -1,
480  * enum dl_dev_state - Device driver presence tracking information.
494  * enum device_removable - Whether the device is removable. The criteria for a
510  * struct dev_links_info - Device data related to device links.
524  * struct dev_msi_info - Device data related to MSI
536  * enum device_physical_location_panel - Describes which panel surface of the
538  * @DEVICE_PANEL_TOP: Device connection point is on the top panel.
539  * @DEVICE_PANEL_BOTTOM: Device connection point is on the bottom panel.
540  * @DEVICE_PANEL_LEFT: Device connection point is on the left panel.
541  * @DEVICE_PANEL_RIGHT: Device connection point is on the right panel.
542  * @DEVICE_PANEL_FRONT: Device connection point is on the front panel.
543  * @DEVICE_PANEL_BACK: Device connection point is on the back panel.
544  * @DEVICE_PANEL_UNKNOWN: The panel with device connection point is unknown.
557  * enum device_physical_location_vertical_position - Describes vertical
558  * position of the device connection point on the panel surface.
559  * @DEVICE_VERT_POS_UPPER: Device connection point is at upper part of panel.
560  * @DEVICE_VERT_POS_CENTER: Device connection point is at center part of panel.
561  * @DEVICE_VERT_POS_LOWER: Device connection point is at lower part of panel.
570  * enum device_physical_location_horizontal_position - Describes horizontal
571  * position of the device connection point on the panel surface.
572  * @DEVICE_HORI_POS_LEFT: Device connection point is at left part of panel.
573  * @DEVICE_HORI_POS_CENTER: Device connection point is at center part of panel.
574  * @DEVICE_HORI_POS_RIGHT: Device connection point is at right part of panel.
583  * struct device_physical_location - Device data related to physical location
585  * @panel: Panel surface of the system's housing that the device connection
588  *                     the panel.
590  *                       within the panel.
597 	enum device_physical_location_panel panel;  member
605  * struct device - The basic device structure
608  * 		controller. If parent is NULL, the device, is a top-level device,
612  * @kobj:	A top-level, abstract class from which other classes are derived.
615  * 		This identifies the device type and carries type-specific
620  * @platform_data: Platform data specific to the device.
623  * 		to board-specific structures describing devices and how they
627  * 		minimizes board-specific #ifdefs in drivers.
628  * @driver_data: Private pointer for driver specific info.
631  *		See Documentation/driver-api/pm/devices.rst for details.
634  * 		along with subsystem-level and driver-level callbacks.
637  *		See Documentation/driver-api/pin-control.rst for details.
643  * 		hardware supports 64-bit addresses for consistent allocations
657  * @archdata:	For arch-specific additions.
679  * @of_node_reused: Set if the device-tree node is shared with an ancestor
688  *		architecture supports non-coherent devices.
690  *		streaming DMA operations (->map_* / ->unmap_* / ->sync_*),
693  *		instance from ->dma_supported.
701  * a higher-level representation of the device.
715 	void		*platform_data;	/* Platform specific data, device
767 	/* arch specific additions */
809  * struct device_link - Device link representation.
817  * @rpm_active: Whether or not the consumer device is runtime-PM-active.
839  * device_iommu_mapped - Returns true when the device DMA is translated
845 	return (dev->iommu_group != NULL);  in device_iommu_mapped()
852  * dev_name - Return a device's name.
859 	if (dev->init_name)  in dev_name()
860 		return dev->init_name;  in dev_name()
862 	return kobject_name(&dev->kobj);  in dev_name()
866  * dev_bus_name - Return a device's bus/class name, if at all possible
874 	return dev->bus ? dev->bus->name : (dev->class ? dev->class->name : "");  in dev_bus_name()
882 	return dev->numa_node;  in dev_to_node()
886 	dev->numa_node = node;  in set_dev_node()
901 	return dev->msi.domain;  in dev_get_msi_domain()
910 	dev->msi.domain = d;  in dev_set_msi_domain()
916 	return dev->driver_data;  in dev_get_drvdata()
921 	dev->driver_data = data;  in dev_set_drvdata()
926 	return dev ? dev->power.subsys_data : NULL;  in dev_to_psd()
931 	return dev->kobj.uevent_suppress;  in dev_get_uevent_suppress()
936 	dev->kobj.uevent_suppress = val;  in dev_set_uevent_suppress()
941 	return dev->kobj.state_in_sysfs;  in device_is_registered()
946 	if (!dev->power.is_prepared)  in device_enable_async_suspend()
947 		dev->power.async_suspend = true;  in device_enable_async_suspend()
952 	if (!dev->power.is_prepared)  in device_disable_async_suspend()
953 		dev->power.async_suspend = false;  in device_disable_async_suspend()
958 	return !!dev->power.async_suspend;  in device_async_suspend_enabled()
963 	return dev->power.no_pm;  in device_pm_not_required()
968 	dev->power.no_pm = true;  in device_set_pm_not_required()
974 	dev->power.syscore = val;  in dev_pm_syscore_device()
980 	dev->power.driver_flags = flags;  in dev_pm_set_driver_flags()
985 	return !!(dev->power.driver_flags & flags);  in dev_pm_test_driver_flags()
990 	mutex_lock(&dev->mutex);  in device_lock()
995 	return mutex_lock_interruptible(&dev->mutex);  in device_lock_interruptible()
1000 	return mutex_trylock(&dev->mutex);  in device_trylock()
1005 	mutex_unlock(&dev->mutex);  in device_unlock()
1012 	lockdep_assert_held(&dev->mutex);  in DEFINE_GUARD()
1019 	return dev->of_node;  in dev_of_node()
1026 	if (dev->driver && dev->driver->sync_state)  in dev_has_sync_state()
1028 	if (dev->bus && dev->bus->sync_state)  in dev_has_sync_state()
1036 	dev->removable = removable;  in dev_set_removable()
1041 	return dev->removable == DEVICE_REMOVABLE;  in dev_is_removable()
1046 	return dev->removable != DEVICE_REMOVABLE_NOT_SUPPORTED;  in dev_removable_is_valid()
1077 	return dev->bus && dev->bus->offline && dev->bus->online;  in device_supports_offline()
1083 	lock_set_class(&__d2->mutex.dep_map, name, key, 0, _THIS_IP_); \
1087  * device_lock_set_class - Specify a temporary lock class while a device
1093  * from driver ->probe(). Take care to only override the default
1100 	dev_WARN_ONCE(__d, !lockdep_match_class(&__d->mutex,               \
1110  * device_lock_reset_class - Return a device to the default lockdep novalidate state
1114  * from driver ->remove().
1119 	lock_set_novalidate_class(&__d->mutex.dep_map, "&dev->mutex",  \
1135 	if (dev->bus && dev->bus->num_vf)  in dev_num_vf()
1136 		return dev->bus->num_vf(dev);  in dev_num_vf()
1153 	return dev->platform_data;  in dev_get_platdata()
1210  * Platform "fixup" functions - allow the platform to have their say
1221  * get_device - atomically increment the reference count for the device.
1253 	MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1255 	MODULE_ALIAS("char-major-" __stringify(major) "-*")