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.
15 #include <linux/dev_printk.h>
16 #include <linux/energy_model.h>
17 #include <linux/ioport.h>
18 #include <linux/kobject.h>
19 #include <linux/klist.h>
20 #include <linux/list.h>
21 #include <linux/lockdep.h>
22 #include <linux/compiler.h>
23 #include <linux/types.h>
24 #include <linux/mutex.h>
26 #include <linux/atomic.h>
27 #include <linux/uidgid.h>
28 #include <linux/gfp.h>
29 #include <linux/overflow.h>
30 #include <linux/device/bus.h>
31 #include <linux/device/class.h>
32 #include <linux/device/driver.h>
33 #include <asm/device.h>
36 struct device_private;
38 struct driver_private;
41 struct subsys_private;
48 struct msi_device_data;
51 * struct subsys_interface - interfaces to device functions
52 * @name: name of the device function
53 * @subsys: subsystem of the devices to attach to
54 * @node: the list of functions registered at the subsystem
55 * @add_dev: device hookup to device function handler
56 * @remove_dev: device hookup to device function handler
58 * Simple interfaces attached to a subsystem. Multiple interfaces can
59 * attach to a subsystem and its devices. Unlike drivers, they do not
60 * exclusively claim or control devices. Interfaces usually represent
61 * a specific functionality of a subsystem/class of devices.
63 struct subsys_interface {
65 struct bus_type *subsys;
66 struct list_head node;
67 int (*add_dev)(struct device *dev, struct subsys_interface *sif);
68 void (*remove_dev)(struct device *dev, struct subsys_interface *sif);
71 int subsys_interface_register(struct subsys_interface *sif);
72 void subsys_interface_unregister(struct subsys_interface *sif);
74 int subsys_system_register(struct bus_type *subsys,
75 const struct attribute_group **groups);
76 int subsys_virtual_register(struct bus_type *subsys,
77 const struct attribute_group **groups);
80 * The type of device, "struct device" is embedded in. A class
81 * or bus can contain devices of different types
82 * like "partitions" and "disks", "mouse" and "event".
83 * This identifies the device type and carries type-specific
84 * information, equivalent to the kobj_type of a kobject.
85 * If "name" is specified, the uevent will contain it in
86 * the DEVTYPE variable.
90 const struct attribute_group **groups;
91 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
92 char *(*devnode)(struct device *dev, umode_t *mode,
93 kuid_t *uid, kgid_t *gid);
94 void (*release)(struct device *dev);
96 const struct dev_pm_ops *pm;
99 /* interface for exporting device attributes */
100 struct device_attribute {
101 struct attribute attr;
102 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
104 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
105 const char *buf, size_t count);
108 struct dev_ext_attribute {
109 struct device_attribute attr;
113 ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
115 ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
116 const char *buf, size_t count);
117 ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
119 ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
120 const char *buf, size_t count);
121 ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
123 ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
124 const char *buf, size_t count);
126 #define DEVICE_ATTR(_name, _mode, _show, _store) \
127 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
128 #define DEVICE_ATTR_PREALLOC(_name, _mode, _show, _store) \
129 struct device_attribute dev_attr_##_name = \
130 __ATTR_PREALLOC(_name, _mode, _show, _store)
131 #define DEVICE_ATTR_RW(_name) \
132 struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
133 #define DEVICE_ATTR_ADMIN_RW(_name) \
134 struct device_attribute dev_attr_##_name = __ATTR_RW_MODE(_name, 0600)
135 #define DEVICE_ATTR_RO(_name) \
136 struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
137 #define DEVICE_ATTR_ADMIN_RO(_name) \
138 struct device_attribute dev_attr_##_name = __ATTR_RO_MODE(_name, 0400)
139 #define DEVICE_ATTR_WO(_name) \
140 struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
141 #define DEVICE_ULONG_ATTR(_name, _mode, _var) \
142 struct dev_ext_attribute dev_attr_##_name = \
143 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
144 #define DEVICE_INT_ATTR(_name, _mode, _var) \
145 struct dev_ext_attribute dev_attr_##_name = \
146 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
147 #define DEVICE_BOOL_ATTR(_name, _mode, _var) \
148 struct dev_ext_attribute dev_attr_##_name = \
149 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
150 #define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
151 struct device_attribute dev_attr_##_name = \
152 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
154 int device_create_file(struct device *device,
155 const struct device_attribute *entry);
156 void device_remove_file(struct device *dev,
157 const struct device_attribute *attr);
158 bool device_remove_file_self(struct device *dev,
159 const struct device_attribute *attr);
160 int __must_check device_create_bin_file(struct device *dev,
161 const struct bin_attribute *attr);
162 void device_remove_bin_file(struct device *dev,
163 const struct bin_attribute *attr);
165 /* device resource management */
166 typedef void (*dr_release_t)(struct device *dev, void *res);
167 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
169 void *__devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
170 int nid, const char *name) __malloc;
171 #define devres_alloc(release, size, gfp) \
172 __devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release)
173 #define devres_alloc_node(release, size, gfp, nid) \
174 __devres_alloc_node(release, size, gfp, nid, #release)
176 void devres_for_each_res(struct device *dev, dr_release_t release,
177 dr_match_t match, void *match_data,
178 void (*fn)(struct device *, void *, void *),
180 void devres_free(void *res);
181 void devres_add(struct device *dev, void *res);
182 void *devres_find(struct device *dev, dr_release_t release,
183 dr_match_t match, void *match_data);
184 void *devres_get(struct device *dev, void *new_res,
185 dr_match_t match, void *match_data);
186 void *devres_remove(struct device *dev, dr_release_t release,
187 dr_match_t match, void *match_data);
188 int devres_destroy(struct device *dev, dr_release_t release,
189 dr_match_t match, void *match_data);
190 int devres_release(struct device *dev, dr_release_t release,
191 dr_match_t match, void *match_data);
194 void * __must_check devres_open_group(struct device *dev, void *id, gfp_t gfp);
195 void devres_close_group(struct device *dev, void *id);
196 void devres_remove_group(struct device *dev, void *id);
197 int devres_release_group(struct device *dev, void *id);
199 /* managed devm_k.alloc/kfree for device drivers */
200 void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp) __malloc;
201 void *devm_krealloc(struct device *dev, void *ptr, size_t size,
202 gfp_t gfp) __must_check;
203 __printf(3, 0) char *devm_kvasprintf(struct device *dev, gfp_t gfp,
204 const char *fmt, va_list ap) __malloc;
205 __printf(3, 4) char *devm_kasprintf(struct device *dev, gfp_t gfp,
206 const char *fmt, ...) __malloc;
207 static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp)
209 return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
211 static inline void *devm_kmalloc_array(struct device *dev,
212 size_t n, size_t size, gfp_t flags)
216 if (unlikely(check_mul_overflow(n, size, &bytes)))
219 return devm_kmalloc(dev, bytes, flags);
221 static inline void *devm_kcalloc(struct device *dev,
222 size_t n, size_t size, gfp_t flags)
224 return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
226 void devm_kfree(struct device *dev, const void *p);
227 char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp) __malloc;
228 const char *devm_kstrdup_const(struct device *dev, const char *s, gfp_t gfp);
229 void *devm_kmemdup(struct device *dev, const void *src, size_t len, gfp_t gfp);
231 unsigned long devm_get_free_pages(struct device *dev,
232 gfp_t gfp_mask, unsigned int order);
233 void devm_free_pages(struct device *dev, unsigned long addr);
235 void __iomem *devm_ioremap_resource(struct device *dev,
236 const struct resource *res);
237 void __iomem *devm_ioremap_resource_wc(struct device *dev,
238 const struct resource *res);
240 void __iomem *devm_of_iomap(struct device *dev,
241 struct device_node *node, int index,
242 resource_size_t *size);
244 /* allows to add/remove a custom action to devres stack */
245 int devm_add_action(struct device *dev, void (*action)(void *), void *data);
246 void devm_remove_action(struct device *dev, void (*action)(void *), void *data);
247 void devm_release_action(struct device *dev, void (*action)(void *), void *data);
249 static inline int devm_add_action_or_reset(struct device *dev,
250 void (*action)(void *), void *data)
254 ret = devm_add_action(dev, action, data);
262 * devm_alloc_percpu - Resource-managed alloc_percpu
263 * @dev: Device to allocate per-cpu memory for
264 * @type: Type to allocate per-cpu memory for
266 * Managed alloc_percpu. Per-cpu memory allocated with this function is
267 * automatically freed on driver detach.
270 * Pointer to allocated memory on success, NULL on failure.
272 #define devm_alloc_percpu(dev, type) \
273 ((typeof(type) __percpu *)__devm_alloc_percpu((dev), sizeof(type), \
276 void __percpu *__devm_alloc_percpu(struct device *dev, size_t size,
278 void devm_free_percpu(struct device *dev, void __percpu *pdata);
280 struct device_dma_parameters {
282 * a low level driver may set these to teach IOMMU code about
285 unsigned int max_segment_size;
286 unsigned int min_align_mask;
287 unsigned long segment_boundary_mask;
291 * enum device_link_state - Device link states.
292 * @DL_STATE_NONE: The presence of the drivers is not being tracked.
293 * @DL_STATE_DORMANT: None of the supplier/consumer drivers is present.
294 * @DL_STATE_AVAILABLE: The supplier driver is present, but the consumer is not.
295 * @DL_STATE_CONSUMER_PROBE: The consumer is probing (supplier driver present).
296 * @DL_STATE_ACTIVE: Both the supplier and consumer drivers are present.
297 * @DL_STATE_SUPPLIER_UNBIND: The supplier driver is unbinding.
299 enum device_link_state {
301 DL_STATE_DORMANT = 0,
303 DL_STATE_CONSUMER_PROBE,
305 DL_STATE_SUPPLIER_UNBIND,
311 * STATELESS: The core will not remove this link automatically.
312 * AUTOREMOVE_CONSUMER: Remove the link automatically on consumer driver unbind.
313 * PM_RUNTIME: If set, the runtime PM framework will use this link.
314 * RPM_ACTIVE: Run pm_runtime_get_sync() on the supplier during link creation.
315 * AUTOREMOVE_SUPPLIER: Remove the link automatically on supplier driver unbind.
316 * AUTOPROBE_CONSUMER: Probe consumer driver automatically after supplier binds.
317 * MANAGED: The core tracks presence of supplier/consumer drivers (internal).
318 * SYNC_STATE_ONLY: Link only affects sync_state() behavior.
319 * INFERRED: Inferred from data (eg: firmware) and not from driver actions.
321 #define DL_FLAG_STATELESS BIT(0)
322 #define DL_FLAG_AUTOREMOVE_CONSUMER BIT(1)
323 #define DL_FLAG_PM_RUNTIME BIT(2)
324 #define DL_FLAG_RPM_ACTIVE BIT(3)
325 #define DL_FLAG_AUTOREMOVE_SUPPLIER BIT(4)
326 #define DL_FLAG_AUTOPROBE_CONSUMER BIT(5)
327 #define DL_FLAG_MANAGED BIT(6)
328 #define DL_FLAG_SYNC_STATE_ONLY BIT(7)
329 #define DL_FLAG_INFERRED BIT(8)
332 * enum dl_dev_state - Device driver presence tracking information.
333 * @DL_DEV_NO_DRIVER: There is no driver attached to the device.
334 * @DL_DEV_PROBING: A driver is probing.
335 * @DL_DEV_DRIVER_BOUND: The driver has been bound to the device.
336 * @DL_DEV_UNBINDING: The driver is unbinding from the device.
339 DL_DEV_NO_DRIVER = 0,
346 * enum device_removable - Whether the device is removable. The criteria for a
347 * device to be classified as removable is determined by its subsystem or bus.
348 * @DEVICE_REMOVABLE_NOT_SUPPORTED: This attribute is not supported for this
350 * @DEVICE_REMOVABLE_UNKNOWN: Device location is Unknown.
351 * @DEVICE_FIXED: Device is not removable by the user.
352 * @DEVICE_REMOVABLE: Device is removable by the user.
354 enum device_removable {
355 DEVICE_REMOVABLE_NOT_SUPPORTED = 0, /* must be 0 */
356 DEVICE_REMOVABLE_UNKNOWN,
362 * struct dev_links_info - Device data related to device links.
363 * @suppliers: List of links to supplier devices.
364 * @consumers: List of links to consumer devices.
365 * @defer_sync: Hook to global list of devices that have deferred sync_state.
366 * @status: Driver status information.
368 struct dev_links_info {
369 struct list_head suppliers;
370 struct list_head consumers;
371 struct list_head defer_sync;
372 enum dl_dev_state status;
376 * struct dev_msi_info - Device data related to MSI
377 * @domain: The MSI interrupt domain associated to the device
378 * @data: Pointer to MSI device data
380 struct dev_msi_info {
381 #ifdef CONFIG_GENERIC_MSI_IRQ
382 struct irq_domain *domain;
383 struct msi_device_data *data;
388 * enum device_physical_location_panel - Describes which panel surface of the
389 * system's housing the device connection point resides on.
390 * @DEVICE_PANEL_TOP: Device connection point is on the top panel.
391 * @DEVICE_PANEL_BOTTOM: Device connection point is on the bottom panel.
392 * @DEVICE_PANEL_LEFT: Device connection point is on the left panel.
393 * @DEVICE_PANEL_RIGHT: Device connection point is on the right panel.
394 * @DEVICE_PANEL_FRONT: Device connection point is on the front panel.
395 * @DEVICE_PANEL_BACK: Device connection point is on the back panel.
396 * @DEVICE_PANEL_UNKNOWN: The panel with device connection point is unknown.
398 enum device_physical_location_panel {
405 DEVICE_PANEL_UNKNOWN,
409 * enum device_physical_location_vertical_position - Describes vertical
410 * position of the device connection point on the panel surface.
411 * @DEVICE_VERT_POS_UPPER: Device connection point is at upper part of panel.
412 * @DEVICE_VERT_POS_CENTER: Device connection point is at center part of panel.
413 * @DEVICE_VERT_POS_LOWER: Device connection point is at lower part of panel.
415 enum device_physical_location_vertical_position {
416 DEVICE_VERT_POS_UPPER,
417 DEVICE_VERT_POS_CENTER,
418 DEVICE_VERT_POS_LOWER,
422 * enum device_physical_location_horizontal_position - Describes horizontal
423 * position of the device connection point on the panel surface.
424 * @DEVICE_HORI_POS_LEFT: Device connection point is at left part of panel.
425 * @DEVICE_HORI_POS_CENTER: Device connection point is at center part of panel.
426 * @DEVICE_HORI_POS_RIGHT: Device connection point is at right part of panel.
428 enum device_physical_location_horizontal_position {
429 DEVICE_HORI_POS_LEFT,
430 DEVICE_HORI_POS_CENTER,
431 DEVICE_HORI_POS_RIGHT,
435 * struct device_physical_location - Device data related to physical location
436 * of the device connection point.
437 * @panel: Panel surface of the system's housing that the device connection
439 * @vertical_position: Vertical position of the device connection point within
441 * @horizontal_position: Horizontal position of the device connection point
443 * @dock: Set if the device connection point resides in a docking station or
445 * @lid: Set if this device connection point resides on the lid of laptop
448 struct device_physical_location {
449 enum device_physical_location_panel panel;
450 enum device_physical_location_vertical_position vertical_position;
451 enum device_physical_location_horizontal_position horizontal_position;
457 * struct device - The basic device structure
458 * @parent: The device's "parent" device, the device to which it is attached.
459 * In most cases, a parent device is some sort of bus or host
460 * controller. If parent is NULL, the device, is a top-level device,
461 * which is not usually what you want.
462 * @p: Holds the private data of the driver core portions of the device.
463 * See the comment of the struct device_private for detail.
464 * @kobj: A top-level, abstract class from which other classes are derived.
465 * @init_name: Initial name of the device.
466 * @type: The type of device.
467 * This identifies the device type and carries type-specific
469 * @mutex: Mutex to synchronize calls to its driver.
470 * @bus: Type of bus device is on.
471 * @driver: Which driver has allocated this
472 * @platform_data: Platform data specific to the device.
473 * Example: For devices on custom boards, as typical of embedded
474 * and SOC based hardware, Linux often uses platform_data to point
475 * to board-specific structures describing devices and how they
476 * are wired. That can include what ports are available, chip
477 * variants, which GPIO pins act in what additional roles, and so
478 * on. This shrinks the "Board Support Packages" (BSPs) and
479 * minimizes board-specific #ifdefs in drivers.
480 * @driver_data: Private pointer for driver specific info.
481 * @links: Links to suppliers and consumers of this device.
482 * @power: For device power management.
483 * See Documentation/driver-api/pm/devices.rst for details.
484 * @pm_domain: Provide callbacks that are executed during system suspend,
485 * hibernation, system resume and during runtime PM transitions
486 * along with subsystem-level and driver-level callbacks.
487 * @em_pd: device's energy model performance domain
488 * @pins: For device pin management.
489 * See Documentation/driver-api/pin-control.rst for details.
490 * @msi: MSI related data
491 * @numa_node: NUMA node this device is close to.
492 * @dma_ops: DMA mapping operations for this device.
493 * @dma_mask: Dma mask (if dma'ble device).
494 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
495 * hardware supports 64-bit addresses for consistent allocations
497 * @bus_dma_limit: Limit of an upstream bridge or bus which imposes a smaller
498 * DMA limit than the device itself supports.
499 * @dma_range_map: map for DMA memory ranges relative to that of RAM
500 * @dma_parms: A low level driver may set these to teach IOMMU code about
501 * segment limitations.
502 * @dma_pools: Dma pools (if dma'ble device).
503 * @dma_mem: Internal for coherent mem override.
504 * @cma_area: Contiguous memory area for dma allocations
505 * @dma_io_tlb_mem: Pointer to the swiotlb pool used. Not for driver use.
506 * @archdata: For arch-specific additions.
507 * @of_node: Associated device tree node.
508 * @fwnode: Associated device node supplied by platform firmware.
509 * @devt: For creating the sysfs "dev".
510 * @id: device instance
511 * @devres_lock: Spinlock to protect the resource of the device.
512 * @devres_head: The resources list of the device.
513 * @knode_class: The node used to add the device to the class list.
514 * @class: The class of the device.
515 * @groups: Optional attribute groups.
516 * @release: Callback to free the device after all references have
517 * gone away. This should be set by the allocator of the
518 * device (i.e. the bus driver that discovered the device).
519 * @iommu_group: IOMMU group the device belongs to.
520 * @iommu: Per device generic IOMMU runtime data
521 * @physical_location: Describes physical location of the device connection
522 * point in the system housing.
523 * @removable: Whether the device can be removed from the system. This
524 * should be set by the subsystem / bus driver that discovered
527 * @offline_disabled: If set, the device is permanently online.
528 * @offline: Set after successful invocation of bus type's .offline().
529 * @of_node_reused: Set if the device-tree node is shared with an ancestor
531 * @state_synced: The hardware state of this device has been synced to match
532 * the software state of this device by calling the driver/bus
533 * sync_state() callback.
534 * @can_match: The device has matched with a driver at least once or it is in
535 * a bus (like AMBA) which can't check for matching drivers until
536 * other devices probe successfully.
537 * @dma_coherent: this particular device is dma coherent, even if the
538 * architecture supports non-coherent devices.
539 * @dma_ops_bypass: If set to %true then the dma_ops are bypassed for the
540 * streaming DMA operations (->map_* / ->unmap_* / ->sync_*),
541 * and optionall (if the coherent mask is large enough) also
542 * for dma allocations. This flag is managed by the dma ops
543 * instance from ->dma_supported.
545 * At the lowest level, every device in a Linux system is represented by an
546 * instance of struct device. The device structure contains the information
547 * that the device model core needs to model the system. Most subsystems,
548 * however, track additional information about the devices they host. As a
549 * result, it is rare for devices to be represented by bare device structures;
550 * instead, that structure, like kobject structures, is usually embedded within
551 * a higher-level representation of the device.
555 struct device *parent;
557 struct device_private *p;
559 const char *init_name; /* initial name of the device */
560 const struct device_type *type;
562 struct bus_type *bus; /* type of bus device is on */
563 struct device_driver *driver; /* which driver has allocated this
565 void *platform_data; /* Platform specific data, device
566 core doesn't touch it */
567 void *driver_data; /* Driver data, set and get with
568 dev_set_drvdata/dev_get_drvdata */
569 struct mutex mutex; /* mutex to synchronize calls to
573 struct dev_links_info links;
574 struct dev_pm_info power;
575 struct dev_pm_domain *pm_domain;
577 #ifdef CONFIG_ENERGY_MODEL
578 struct em_perf_domain *em_pd;
581 #ifdef CONFIG_PINCTRL
582 struct dev_pin_info *pins;
584 struct dev_msi_info msi;
585 #ifdef CONFIG_DMA_OPS
586 const struct dma_map_ops *dma_ops;
588 u64 *dma_mask; /* dma mask (if dma'able device) */
589 u64 coherent_dma_mask;/* Like dma_mask, but for
590 alloc_coherent mappings as
591 not all hardware supports
592 64 bit addresses for consistent
593 allocations such descriptors. */
594 u64 bus_dma_limit; /* upstream dma constraint */
595 const struct bus_dma_region *dma_range_map;
597 struct device_dma_parameters *dma_parms;
599 struct list_head dma_pools; /* dma pools (if dma'ble) */
601 #ifdef CONFIG_DMA_DECLARE_COHERENT
602 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
605 #ifdef CONFIG_DMA_CMA
606 struct cma *cma_area; /* contiguous memory area for dma
609 #ifdef CONFIG_SWIOTLB
610 struct io_tlb_mem *dma_io_tlb_mem;
612 /* arch specific additions */
613 struct dev_archdata archdata;
615 struct device_node *of_node; /* associated device tree node */
616 struct fwnode_handle *fwnode; /* firmware device node */
619 int numa_node; /* NUMA node this device is close to */
621 dev_t devt; /* dev_t, creates the sysfs "dev" */
622 u32 id; /* device instance */
624 spinlock_t devres_lock;
625 struct list_head devres_head;
628 const struct attribute_group **groups; /* optional groups */
630 void (*release)(struct device *dev);
631 struct iommu_group *iommu_group;
632 struct dev_iommu *iommu;
634 struct device_physical_location *physical_location;
636 enum device_removable removable;
638 bool offline_disabled:1;
640 bool of_node_reused:1;
643 #if defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_DEVICE) || \
644 defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU) || \
645 defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU_ALL)
648 #ifdef CONFIG_DMA_OPS_BYPASS
649 bool dma_ops_bypass : 1;
654 * struct device_link - Device link representation.
655 * @supplier: The device on the supplier end of the link.
656 * @s_node: Hook to the supplier device's list of links to consumers.
657 * @consumer: The device on the consumer end of the link.
658 * @c_node: Hook to the consumer device's list of links to suppliers.
659 * @link_dev: device used to expose link details in sysfs
660 * @status: The state of the link (with respect to the presence of drivers).
661 * @flags: Link flags.
662 * @rpm_active: Whether or not the consumer device is runtime-PM-active.
663 * @kref: Count repeated addition of the same link.
664 * @rm_work: Work structure used for removing the link.
665 * @supplier_preactivated: Supplier has been made active before consumer probe.
668 struct device *supplier;
669 struct list_head s_node;
670 struct device *consumer;
671 struct list_head c_node;
672 struct device link_dev;
673 enum device_link_state status;
675 refcount_t rpm_active;
677 struct work_struct rm_work;
678 bool supplier_preactivated; /* Owned by consumer probe. */
681 static inline struct device *kobj_to_dev(struct kobject *kobj)
683 return container_of(kobj, struct device, kobj);
687 * device_iommu_mapped - Returns true when the device DMA is translated
689 * @dev: Device to perform the check on
691 static inline bool device_iommu_mapped(struct device *dev)
693 return (dev->iommu_group != NULL);
696 /* Get the wakeup routines, which depend on struct device */
697 #include <linux/pm_wakeup.h>
699 static inline const char *dev_name(const struct device *dev)
701 /* Use the init name until the kobject becomes available */
703 return dev->init_name;
705 return kobject_name(&dev->kobj);
709 * dev_bus_name - Return a device's bus/class name, if at all possible
710 * @dev: struct device to get the bus/class name of
712 * Will return the name of the bus/class the device is attached to. If it is
713 * not attached to a bus/class, an empty string will be returned.
715 static inline const char *dev_bus_name(const struct device *dev)
717 return dev->bus ? dev->bus->name : (dev->class ? dev->class->name : "");
720 __printf(2, 3) int dev_set_name(struct device *dev, const char *name, ...);
723 static inline int dev_to_node(struct device *dev)
725 return dev->numa_node;
727 static inline void set_dev_node(struct device *dev, int node)
729 dev->numa_node = node;
732 static inline int dev_to_node(struct device *dev)
736 static inline void set_dev_node(struct device *dev, int node)
741 static inline struct irq_domain *dev_get_msi_domain(const struct device *dev)
743 #ifdef CONFIG_GENERIC_MSI_IRQ
744 return dev->msi.domain;
750 static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d)
752 #ifdef CONFIG_GENERIC_MSI_IRQ
757 static inline void *dev_get_drvdata(const struct device *dev)
759 return dev->driver_data;
762 static inline void dev_set_drvdata(struct device *dev, void *data)
764 dev->driver_data = data;
767 static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
769 return dev ? dev->power.subsys_data : NULL;
772 static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
774 return dev->kobj.uevent_suppress;
777 static inline void dev_set_uevent_suppress(struct device *dev, int val)
779 dev->kobj.uevent_suppress = val;
782 static inline int device_is_registered(struct device *dev)
784 return dev->kobj.state_in_sysfs;
787 static inline void device_enable_async_suspend(struct device *dev)
789 if (!dev->power.is_prepared)
790 dev->power.async_suspend = true;
793 static inline void device_disable_async_suspend(struct device *dev)
795 if (!dev->power.is_prepared)
796 dev->power.async_suspend = false;
799 static inline bool device_async_suspend_enabled(struct device *dev)
801 return !!dev->power.async_suspend;
804 static inline bool device_pm_not_required(struct device *dev)
806 return dev->power.no_pm;
809 static inline void device_set_pm_not_required(struct device *dev)
811 dev->power.no_pm = true;
814 static inline void dev_pm_syscore_device(struct device *dev, bool val)
816 #ifdef CONFIG_PM_SLEEP
817 dev->power.syscore = val;
821 static inline void dev_pm_set_driver_flags(struct device *dev, u32 flags)
823 dev->power.driver_flags = flags;
826 static inline bool dev_pm_test_driver_flags(struct device *dev, u32 flags)
828 return !!(dev->power.driver_flags & flags);
831 static inline void device_lock(struct device *dev)
833 mutex_lock(&dev->mutex);
836 static inline int device_lock_interruptible(struct device *dev)
838 return mutex_lock_interruptible(&dev->mutex);
841 static inline int device_trylock(struct device *dev)
843 return mutex_trylock(&dev->mutex);
846 static inline void device_unlock(struct device *dev)
848 mutex_unlock(&dev->mutex);
851 static inline void device_lock_assert(struct device *dev)
853 lockdep_assert_held(&dev->mutex);
856 static inline struct device_node *dev_of_node(struct device *dev)
858 if (!IS_ENABLED(CONFIG_OF) || !dev)
863 static inline bool dev_has_sync_state(struct device *dev)
867 if (dev->driver && dev->driver->sync_state)
869 if (dev->bus && dev->bus->sync_state)
874 static inline void dev_set_removable(struct device *dev,
875 enum device_removable removable)
877 dev->removable = removable;
880 static inline bool dev_is_removable(struct device *dev)
882 return dev->removable == DEVICE_REMOVABLE;
885 static inline bool dev_removable_is_valid(struct device *dev)
887 return dev->removable != DEVICE_REMOVABLE_NOT_SUPPORTED;
891 * High level routines for use by the bus drivers
893 int __must_check device_register(struct device *dev);
894 void device_unregister(struct device *dev);
895 void device_initialize(struct device *dev);
896 int __must_check device_add(struct device *dev);
897 void device_del(struct device *dev);
898 int device_for_each_child(struct device *dev, void *data,
899 int (*fn)(struct device *dev, void *data));
900 int device_for_each_child_reverse(struct device *dev, void *data,
901 int (*fn)(struct device *dev, void *data));
902 struct device *device_find_child(struct device *dev, void *data,
903 int (*match)(struct device *dev, void *data));
904 struct device *device_find_child_by_name(struct device *parent,
906 struct device *device_find_any_child(struct device *parent);
908 int device_rename(struct device *dev, const char *new_name);
909 int device_move(struct device *dev, struct device *new_parent,
910 enum dpm_order dpm_order);
911 int device_change_owner(struct device *dev, kuid_t kuid, kgid_t kgid);
912 const char *device_get_devnode(struct device *dev, umode_t *mode, kuid_t *uid,
913 kgid_t *gid, const char **tmp);
914 int device_is_dependent(struct device *dev, void *target);
916 static inline bool device_supports_offline(struct device *dev)
918 return dev->bus && dev->bus->offline && dev->bus->online;
921 #define __device_lock_set_class(dev, name, key) \
923 struct device *__d2 __maybe_unused = dev; \
924 lock_set_class(&__d2->mutex.dep_map, name, key, 0, _THIS_IP_); \
928 * device_lock_set_class - Specify a temporary lock class while a device
929 * is attached to a driver
930 * @dev: device to modify
931 * @key: lock class key data
933 * This must be called with the device_lock() already held, for example
934 * from driver ->probe(). Take care to only override the default
935 * lockdep_no_validate class.
937 #ifdef CONFIG_LOCKDEP
938 #define device_lock_set_class(dev, key) \
940 struct device *__d = dev; \
941 dev_WARN_ONCE(__d, !lockdep_match_class(&__d->mutex, \
942 &__lockdep_no_validate__), \
943 "overriding existing custom lock class\n"); \
944 __device_lock_set_class(__d, #key, key); \
947 #define device_lock_set_class(dev, key) __device_lock_set_class(dev, #key, key)
951 * device_lock_reset_class - Return a device to the default lockdep novalidate state
952 * @dev: device to modify
954 * This must be called with the device_lock() already held, for example
955 * from driver ->remove().
957 #define device_lock_reset_class(dev) \
959 struct device *__d __maybe_unused = dev; \
960 lock_set_novalidate_class(&__d->mutex.dep_map, "&dev->mutex", \
964 void lock_device_hotplug(void);
965 void unlock_device_hotplug(void);
966 int lock_device_hotplug_sysfs(void);
967 int device_offline(struct device *dev);
968 int device_online(struct device *dev);
969 void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
970 void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
971 void device_set_of_node_from_dev(struct device *dev, const struct device *dev2);
972 void device_set_node(struct device *dev, struct fwnode_handle *fwnode);
974 static inline int dev_num_vf(struct device *dev)
976 if (dev->bus && dev->bus->num_vf)
977 return dev->bus->num_vf(dev);
982 * Root device objects for grouping under /sys/devices
984 struct device *__root_device_register(const char *name, struct module *owner);
986 /* This is a macro to avoid include problems with THIS_MODULE */
987 #define root_device_register(name) \
988 __root_device_register(name, THIS_MODULE)
990 void root_device_unregister(struct device *root);
992 static inline void *dev_get_platdata(const struct device *dev)
994 return dev->platform_data;
998 * Manual binding of a device to driver. See drivers/base/bus.c
999 * for information on use.
1001 int __must_check device_driver_attach(struct device_driver *drv,
1002 struct device *dev);
1003 int __must_check device_bind_driver(struct device *dev);
1004 void device_release_driver(struct device *dev);
1005 int __must_check device_attach(struct device *dev);
1006 int __must_check driver_attach(struct device_driver *drv);
1007 void device_initial_probe(struct device *dev);
1008 int __must_check device_reprobe(struct device *dev);
1010 bool device_is_bound(struct device *dev);
1013 * Easy functions for dynamically creating devices on the fly
1015 __printf(5, 6) struct device *
1016 device_create(struct class *cls, struct device *parent, dev_t devt,
1017 void *drvdata, const char *fmt, ...);
1018 __printf(6, 7) struct device *
1019 device_create_with_groups(struct class *cls, struct device *parent, dev_t devt,
1020 void *drvdata, const struct attribute_group **groups,
1021 const char *fmt, ...);
1022 void device_destroy(struct class *cls, dev_t devt);
1024 int __must_check device_add_groups(struct device *dev,
1025 const struct attribute_group **groups);
1026 void device_remove_groups(struct device *dev,
1027 const struct attribute_group **groups);
1029 static inline int __must_check device_add_group(struct device *dev,
1030 const struct attribute_group *grp)
1032 const struct attribute_group *groups[] = { grp, NULL };
1034 return device_add_groups(dev, groups);
1037 static inline void device_remove_group(struct device *dev,
1038 const struct attribute_group *grp)
1040 const struct attribute_group *groups[] = { grp, NULL };
1042 return device_remove_groups(dev, groups);
1045 int __must_check devm_device_add_groups(struct device *dev,
1046 const struct attribute_group **groups);
1047 void devm_device_remove_groups(struct device *dev,
1048 const struct attribute_group **groups);
1049 int __must_check devm_device_add_group(struct device *dev,
1050 const struct attribute_group *grp);
1051 void devm_device_remove_group(struct device *dev,
1052 const struct attribute_group *grp);
1055 * Platform "fixup" functions - allow the platform to have their say
1056 * about devices and actions that the general device layer doesn't
1059 /* Notify platform of device discovery */
1060 extern int (*platform_notify)(struct device *dev);
1062 extern int (*platform_notify_remove)(struct device *dev);
1066 * get_device - atomically increment the reference count for the device.
1069 struct device *get_device(struct device *dev);
1070 void put_device(struct device *dev);
1071 bool kill_device(struct device *dev);
1073 #ifdef CONFIG_DEVTMPFS
1074 int devtmpfs_mount(void);
1076 static inline int devtmpfs_mount(void) { return 0; }
1079 /* drivers/base/power/shutdown.c */
1080 void device_shutdown(void);
1082 /* debugging and troubleshooting/diagnostic helpers. */
1083 const char *dev_driver_string(const struct device *dev);
1085 /* Device links interface. */
1086 struct device_link *device_link_add(struct device *consumer,
1087 struct device *supplier, u32 flags);
1088 void device_link_del(struct device_link *link);
1089 void device_link_remove(void *consumer, struct device *supplier);
1090 void device_links_supplier_sync_state_pause(void);
1091 void device_links_supplier_sync_state_resume(void);
1093 extern __printf(3, 4)
1094 int dev_err_probe(const struct device *dev, int err, const char *fmt, ...);
1096 /* Create alias, so I can be autoloaded. */
1097 #define MODULE_ALIAS_CHARDEV(major,minor) \
1098 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1099 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1100 MODULE_ALIAS("char-major-" __stringify(major) "-*")
1102 #ifdef CONFIG_SYSFS_DEPRECATED
1103 extern long sysfs_deprecated;
1105 #define sysfs_deprecated 0
1108 #endif /* _DEVICE_H_ */