1 // SPDX-License-Identifier: GPL-2.0
3 * drivers/base/core.c - core driver model code (device registration, etc)
5 * Copyright (c) 2002-3 Patrick Mochel
6 * Copyright (c) 2002-3 Open Source Development Labs
7 * Copyright (c) 2006 Greg Kroah-Hartman <gregkh@suse.de>
8 * Copyright (c) 2006 Novell, Inc.
11 #include <linux/acpi.h>
12 #include <linux/cpufreq.h>
13 #include <linux/device.h>
14 #include <linux/err.h>
15 #include <linux/fwnode.h>
16 #include <linux/init.h>
17 #include <linux/module.h>
18 #include <linux/slab.h>
19 #include <linux/string.h>
20 #include <linux/kdev_t.h>
21 #include <linux/notifier.h>
23 #include <linux/of_device.h>
24 #include <linux/blkdev.h>
25 #include <linux/mutex.h>
26 #include <linux/pm_runtime.h>
27 #include <linux/netdevice.h>
28 #include <linux/sched/signal.h>
29 #include <linux/sched/mm.h>
30 #include <linux/swiotlb.h>
31 #include <linux/sysfs.h>
32 #include <linux/dma-map-ops.h> /* for dma_default_coherent */
35 #include "power/power.h"
37 #ifdef CONFIG_SYSFS_DEPRECATED
38 #ifdef CONFIG_SYSFS_DEPRECATED_V2
39 long sysfs_deprecated = 1;
41 long sysfs_deprecated = 0;
43 static int __init sysfs_deprecated_setup(char *arg)
45 return kstrtol(arg, 10, &sysfs_deprecated);
47 early_param("sysfs.deprecated", sysfs_deprecated_setup);
50 /* Device links support. */
51 static LIST_HEAD(deferred_sync);
52 static unsigned int defer_sync_state_count = 1;
53 static DEFINE_MUTEX(fwnode_link_lock);
54 static bool fw_devlink_is_permissive(void);
55 static bool fw_devlink_drv_reg_done;
58 * fwnode_link_add - Create a link between two fwnode_handles.
59 * @con: Consumer end of the link.
60 * @sup: Supplier end of the link.
62 * Create a fwnode link between fwnode handles @con and @sup. The fwnode link
63 * represents the detail that the firmware lists @sup fwnode as supplying a
66 * The driver core will use the fwnode link to create a device link between the
67 * two device objects corresponding to @con and @sup when they are created. The
68 * driver core will automatically delete the fwnode link between @con and @sup
71 * Attempts to create duplicate links between the same pair of fwnode handles
72 * are ignored and there is no reference counting.
74 int fwnode_link_add(struct fwnode_handle *con, struct fwnode_handle *sup)
76 struct fwnode_link *link;
79 mutex_lock(&fwnode_link_lock);
81 list_for_each_entry(link, &sup->consumers, s_hook)
82 if (link->consumer == con)
85 link = kzalloc(sizeof(*link), GFP_KERNEL);
92 INIT_LIST_HEAD(&link->s_hook);
94 INIT_LIST_HEAD(&link->c_hook);
96 list_add(&link->s_hook, &sup->consumers);
97 list_add(&link->c_hook, &con->suppliers);
98 pr_debug("%pfwP Linked as a fwnode consumer to %pfwP\n",
101 mutex_unlock(&fwnode_link_lock);
107 * __fwnode_link_del - Delete a link between two fwnode_handles.
108 * @link: the fwnode_link to be deleted
110 * The fwnode_link_lock needs to be held when this function is called.
112 static void __fwnode_link_del(struct fwnode_link *link)
114 pr_debug("%pfwP Dropping the fwnode link to %pfwP\n",
115 link->consumer, link->supplier);
116 list_del(&link->s_hook);
117 list_del(&link->c_hook);
122 * fwnode_links_purge_suppliers - Delete all supplier links of fwnode_handle.
123 * @fwnode: fwnode whose supplier links need to be deleted
125 * Deletes all supplier links connecting directly to @fwnode.
127 static void fwnode_links_purge_suppliers(struct fwnode_handle *fwnode)
129 struct fwnode_link *link, *tmp;
131 mutex_lock(&fwnode_link_lock);
132 list_for_each_entry_safe(link, tmp, &fwnode->suppliers, c_hook)
133 __fwnode_link_del(link);
134 mutex_unlock(&fwnode_link_lock);
138 * fwnode_links_purge_consumers - Delete all consumer links of fwnode_handle.
139 * @fwnode: fwnode whose consumer links need to be deleted
141 * Deletes all consumer links connecting directly to @fwnode.
143 static void fwnode_links_purge_consumers(struct fwnode_handle *fwnode)
145 struct fwnode_link *link, *tmp;
147 mutex_lock(&fwnode_link_lock);
148 list_for_each_entry_safe(link, tmp, &fwnode->consumers, s_hook)
149 __fwnode_link_del(link);
150 mutex_unlock(&fwnode_link_lock);
154 * fwnode_links_purge - Delete all links connected to a fwnode_handle.
155 * @fwnode: fwnode whose links needs to be deleted
157 * Deletes all links connecting directly to a fwnode.
159 void fwnode_links_purge(struct fwnode_handle *fwnode)
161 fwnode_links_purge_suppliers(fwnode);
162 fwnode_links_purge_consumers(fwnode);
165 void fw_devlink_purge_absent_suppliers(struct fwnode_handle *fwnode)
167 struct fwnode_handle *child;
169 /* Don't purge consumer links of an added child */
173 fwnode->flags |= FWNODE_FLAG_NOT_DEVICE;
174 fwnode_links_purge_consumers(fwnode);
176 fwnode_for_each_available_child_node(fwnode, child)
177 fw_devlink_purge_absent_suppliers(child);
179 EXPORT_SYMBOL_GPL(fw_devlink_purge_absent_suppliers);
182 static DEFINE_MUTEX(device_links_lock);
183 DEFINE_STATIC_SRCU(device_links_srcu);
185 static inline void device_links_write_lock(void)
187 mutex_lock(&device_links_lock);
190 static inline void device_links_write_unlock(void)
192 mutex_unlock(&device_links_lock);
195 int device_links_read_lock(void) __acquires(&device_links_srcu)
197 return srcu_read_lock(&device_links_srcu);
200 void device_links_read_unlock(int idx) __releases(&device_links_srcu)
202 srcu_read_unlock(&device_links_srcu, idx);
205 int device_links_read_lock_held(void)
207 return srcu_read_lock_held(&device_links_srcu);
210 static void device_link_synchronize_removal(void)
212 synchronize_srcu(&device_links_srcu);
215 static void device_link_remove_from_lists(struct device_link *link)
217 list_del_rcu(&link->s_node);
218 list_del_rcu(&link->c_node);
220 #else /* !CONFIG_SRCU */
221 static DECLARE_RWSEM(device_links_lock);
223 static inline void device_links_write_lock(void)
225 down_write(&device_links_lock);
228 static inline void device_links_write_unlock(void)
230 up_write(&device_links_lock);
233 int device_links_read_lock(void)
235 down_read(&device_links_lock);
239 void device_links_read_unlock(int not_used)
241 up_read(&device_links_lock);
244 #ifdef CONFIG_DEBUG_LOCK_ALLOC
245 int device_links_read_lock_held(void)
247 return lockdep_is_held(&device_links_lock);
251 static inline void device_link_synchronize_removal(void)
255 static void device_link_remove_from_lists(struct device_link *link)
257 list_del(&link->s_node);
258 list_del(&link->c_node);
260 #endif /* !CONFIG_SRCU */
262 static bool device_is_ancestor(struct device *dev, struct device *target)
264 while (target->parent) {
265 target = target->parent;
273 * device_is_dependent - Check if one device depends on another one
274 * @dev: Device to check dependencies for.
275 * @target: Device to check against.
277 * Check if @target depends on @dev or any device dependent on it (its child or
278 * its consumer etc). Return 1 if that is the case or 0 otherwise.
280 int device_is_dependent(struct device *dev, void *target)
282 struct device_link *link;
286 * The "ancestors" check is needed to catch the case when the target
287 * device has not been completely initialized yet and it is still
288 * missing from the list of children of its parent device.
290 if (dev == target || device_is_ancestor(dev, target))
293 ret = device_for_each_child(dev, target, device_is_dependent);
297 list_for_each_entry(link, &dev->links.consumers, s_node) {
298 if ((link->flags & ~DL_FLAG_INFERRED) ==
299 (DL_FLAG_SYNC_STATE_ONLY | DL_FLAG_MANAGED))
302 if (link->consumer == target)
305 ret = device_is_dependent(link->consumer, target);
312 static void device_link_init_status(struct device_link *link,
313 struct device *consumer,
314 struct device *supplier)
316 switch (supplier->links.status) {
318 switch (consumer->links.status) {
321 * A consumer driver can create a link to a supplier
322 * that has not completed its probing yet as long as it
323 * knows that the supplier is already functional (for
324 * example, it has just acquired some resources from the
327 link->status = DL_STATE_CONSUMER_PROBE;
330 link->status = DL_STATE_DORMANT;
334 case DL_DEV_DRIVER_BOUND:
335 switch (consumer->links.status) {
337 link->status = DL_STATE_CONSUMER_PROBE;
339 case DL_DEV_DRIVER_BOUND:
340 link->status = DL_STATE_ACTIVE;
343 link->status = DL_STATE_AVAILABLE;
347 case DL_DEV_UNBINDING:
348 link->status = DL_STATE_SUPPLIER_UNBIND;
351 link->status = DL_STATE_DORMANT;
356 static int device_reorder_to_tail(struct device *dev, void *not_used)
358 struct device_link *link;
361 * Devices that have not been registered yet will be put to the ends
362 * of the lists during the registration, so skip them here.
364 if (device_is_registered(dev))
365 devices_kset_move_last(dev);
367 if (device_pm_initialized(dev))
368 device_pm_move_last(dev);
370 device_for_each_child(dev, NULL, device_reorder_to_tail);
371 list_for_each_entry(link, &dev->links.consumers, s_node) {
372 if ((link->flags & ~DL_FLAG_INFERRED) ==
373 (DL_FLAG_SYNC_STATE_ONLY | DL_FLAG_MANAGED))
375 device_reorder_to_tail(link->consumer, NULL);
382 * device_pm_move_to_tail - Move set of devices to the end of device lists
383 * @dev: Device to move
385 * This is a device_reorder_to_tail() wrapper taking the requisite locks.
387 * It moves the @dev along with all of its children and all of its consumers
388 * to the ends of the device_kset and dpm_list, recursively.
390 void device_pm_move_to_tail(struct device *dev)
394 idx = device_links_read_lock();
396 device_reorder_to_tail(dev, NULL);
398 device_links_read_unlock(idx);
401 #define to_devlink(dev) container_of((dev), struct device_link, link_dev)
403 static ssize_t status_show(struct device *dev,
404 struct device_attribute *attr, char *buf)
408 switch (to_devlink(dev)->status) {
410 output = "not tracked";
412 case DL_STATE_DORMANT:
415 case DL_STATE_AVAILABLE:
416 output = "available";
418 case DL_STATE_CONSUMER_PROBE:
419 output = "consumer probing";
421 case DL_STATE_ACTIVE:
424 case DL_STATE_SUPPLIER_UNBIND:
425 output = "supplier unbinding";
432 return sysfs_emit(buf, "%s\n", output);
434 static DEVICE_ATTR_RO(status);
436 static ssize_t auto_remove_on_show(struct device *dev,
437 struct device_attribute *attr, char *buf)
439 struct device_link *link = to_devlink(dev);
442 if (link->flags & DL_FLAG_AUTOREMOVE_SUPPLIER)
443 output = "supplier unbind";
444 else if (link->flags & DL_FLAG_AUTOREMOVE_CONSUMER)
445 output = "consumer unbind";
449 return sysfs_emit(buf, "%s\n", output);
451 static DEVICE_ATTR_RO(auto_remove_on);
453 static ssize_t runtime_pm_show(struct device *dev,
454 struct device_attribute *attr, char *buf)
456 struct device_link *link = to_devlink(dev);
458 return sysfs_emit(buf, "%d\n", !!(link->flags & DL_FLAG_PM_RUNTIME));
460 static DEVICE_ATTR_RO(runtime_pm);
462 static ssize_t sync_state_only_show(struct device *dev,
463 struct device_attribute *attr, char *buf)
465 struct device_link *link = to_devlink(dev);
467 return sysfs_emit(buf, "%d\n",
468 !!(link->flags & DL_FLAG_SYNC_STATE_ONLY));
470 static DEVICE_ATTR_RO(sync_state_only);
472 static struct attribute *devlink_attrs[] = {
473 &dev_attr_status.attr,
474 &dev_attr_auto_remove_on.attr,
475 &dev_attr_runtime_pm.attr,
476 &dev_attr_sync_state_only.attr,
479 ATTRIBUTE_GROUPS(devlink);
481 static void device_link_release_fn(struct work_struct *work)
483 struct device_link *link = container_of(work, struct device_link, rm_work);
485 /* Ensure that all references to the link object have been dropped. */
486 device_link_synchronize_removal();
488 pm_runtime_release_supplier(link, true);
490 put_device(link->consumer);
491 put_device(link->supplier);
495 static void devlink_dev_release(struct device *dev)
497 struct device_link *link = to_devlink(dev);
499 INIT_WORK(&link->rm_work, device_link_release_fn);
501 * It may take a while to complete this work because of the SRCU
502 * synchronization in device_link_release_fn() and if the consumer or
503 * supplier devices get deleted when it runs, so put it into the "long"
506 queue_work(system_long_wq, &link->rm_work);
509 static struct class devlink_class = {
511 .owner = THIS_MODULE,
512 .dev_groups = devlink_groups,
513 .dev_release = devlink_dev_release,
516 static int devlink_add_symlinks(struct device *dev,
517 struct class_interface *class_intf)
521 struct device_link *link = to_devlink(dev);
522 struct device *sup = link->supplier;
523 struct device *con = link->consumer;
526 len = max(strlen(dev_bus_name(sup)) + strlen(dev_name(sup)),
527 strlen(dev_bus_name(con)) + strlen(dev_name(con)));
529 len += strlen("supplier:") + 1;
530 buf = kzalloc(len, GFP_KERNEL);
534 ret = sysfs_create_link(&link->link_dev.kobj, &sup->kobj, "supplier");
538 ret = sysfs_create_link(&link->link_dev.kobj, &con->kobj, "consumer");
542 snprintf(buf, len, "consumer:%s:%s", dev_bus_name(con), dev_name(con));
543 ret = sysfs_create_link(&sup->kobj, &link->link_dev.kobj, buf);
547 snprintf(buf, len, "supplier:%s:%s", dev_bus_name(sup), dev_name(sup));
548 ret = sysfs_create_link(&con->kobj, &link->link_dev.kobj, buf);
555 snprintf(buf, len, "consumer:%s:%s", dev_bus_name(con), dev_name(con));
556 sysfs_remove_link(&sup->kobj, buf);
558 sysfs_remove_link(&link->link_dev.kobj, "consumer");
560 sysfs_remove_link(&link->link_dev.kobj, "supplier");
566 static void devlink_remove_symlinks(struct device *dev,
567 struct class_interface *class_intf)
569 struct device_link *link = to_devlink(dev);
571 struct device *sup = link->supplier;
572 struct device *con = link->consumer;
575 sysfs_remove_link(&link->link_dev.kobj, "consumer");
576 sysfs_remove_link(&link->link_dev.kobj, "supplier");
578 len = max(strlen(dev_bus_name(sup)) + strlen(dev_name(sup)),
579 strlen(dev_bus_name(con)) + strlen(dev_name(con)));
581 len += strlen("supplier:") + 1;
582 buf = kzalloc(len, GFP_KERNEL);
584 WARN(1, "Unable to properly free device link symlinks!\n");
588 if (device_is_registered(con)) {
589 snprintf(buf, len, "supplier:%s:%s", dev_bus_name(sup), dev_name(sup));
590 sysfs_remove_link(&con->kobj, buf);
592 snprintf(buf, len, "consumer:%s:%s", dev_bus_name(con), dev_name(con));
593 sysfs_remove_link(&sup->kobj, buf);
597 static struct class_interface devlink_class_intf = {
598 .class = &devlink_class,
599 .add_dev = devlink_add_symlinks,
600 .remove_dev = devlink_remove_symlinks,
603 static int __init devlink_class_init(void)
607 ret = class_register(&devlink_class);
611 ret = class_interface_register(&devlink_class_intf);
613 class_unregister(&devlink_class);
617 postcore_initcall(devlink_class_init);
619 #define DL_MANAGED_LINK_FLAGS (DL_FLAG_AUTOREMOVE_CONSUMER | \
620 DL_FLAG_AUTOREMOVE_SUPPLIER | \
621 DL_FLAG_AUTOPROBE_CONSUMER | \
622 DL_FLAG_SYNC_STATE_ONLY | \
625 #define DL_ADD_VALID_FLAGS (DL_MANAGED_LINK_FLAGS | DL_FLAG_STATELESS | \
626 DL_FLAG_PM_RUNTIME | DL_FLAG_RPM_ACTIVE)
629 * device_link_add - Create a link between two devices.
630 * @consumer: Consumer end of the link.
631 * @supplier: Supplier end of the link.
632 * @flags: Link flags.
634 * The caller is responsible for the proper synchronization of the link creation
635 * with runtime PM. First, setting the DL_FLAG_PM_RUNTIME flag will cause the
636 * runtime PM framework to take the link into account. Second, if the
637 * DL_FLAG_RPM_ACTIVE flag is set in addition to it, the supplier devices will
638 * be forced into the active meta state and reference-counted upon the creation
639 * of the link. If DL_FLAG_PM_RUNTIME is not set, DL_FLAG_RPM_ACTIVE will be
642 * If DL_FLAG_STATELESS is set in @flags, the caller of this function is
643 * expected to release the link returned by it directly with the help of either
644 * device_link_del() or device_link_remove().
646 * If that flag is not set, however, the caller of this function is handing the
647 * management of the link over to the driver core entirely and its return value
648 * can only be used to check whether or not the link is present. In that case,
649 * the DL_FLAG_AUTOREMOVE_CONSUMER and DL_FLAG_AUTOREMOVE_SUPPLIER device link
650 * flags can be used to indicate to the driver core when the link can be safely
651 * deleted. Namely, setting one of them in @flags indicates to the driver core
652 * that the link is not going to be used (by the given caller of this function)
653 * after unbinding the consumer or supplier driver, respectively, from its
654 * device, so the link can be deleted at that point. If none of them is set,
655 * the link will be maintained until one of the devices pointed to by it (either
656 * the consumer or the supplier) is unregistered.
658 * Also, if DL_FLAG_STATELESS, DL_FLAG_AUTOREMOVE_CONSUMER and
659 * DL_FLAG_AUTOREMOVE_SUPPLIER are not set in @flags (that is, a persistent
660 * managed device link is being added), the DL_FLAG_AUTOPROBE_CONSUMER flag can
661 * be used to request the driver core to automatically probe for a consumer
662 * driver after successfully binding a driver to the supplier device.
664 * The combination of DL_FLAG_STATELESS and one of DL_FLAG_AUTOREMOVE_CONSUMER,
665 * DL_FLAG_AUTOREMOVE_SUPPLIER, or DL_FLAG_AUTOPROBE_CONSUMER set in @flags at
666 * the same time is invalid and will cause NULL to be returned upfront.
667 * However, if a device link between the given @consumer and @supplier pair
668 * exists already when this function is called for them, the existing link will
669 * be returned regardless of its current type and status (the link's flags may
670 * be modified then). The caller of this function is then expected to treat
671 * the link as though it has just been created, so (in particular) if
672 * DL_FLAG_STATELESS was passed in @flags, the link needs to be released
673 * explicitly when not needed any more (as stated above).
675 * A side effect of the link creation is re-ordering of dpm_list and the
676 * devices_kset list by moving the consumer device and all devices depending
677 * on it to the ends of these lists (that does not happen to devices that have
678 * not been registered when this function is called).
680 * The supplier device is required to be registered when this function is called
681 * and NULL will be returned if that is not the case. The consumer device need
682 * not be registered, however.
684 struct device_link *device_link_add(struct device *consumer,
685 struct device *supplier, u32 flags)
687 struct device_link *link;
689 if (!consumer || !supplier || consumer == supplier ||
690 flags & ~DL_ADD_VALID_FLAGS ||
691 (flags & DL_FLAG_STATELESS && flags & DL_MANAGED_LINK_FLAGS) ||
692 (flags & DL_FLAG_SYNC_STATE_ONLY &&
693 (flags & ~DL_FLAG_INFERRED) != DL_FLAG_SYNC_STATE_ONLY) ||
694 (flags & DL_FLAG_AUTOPROBE_CONSUMER &&
695 flags & (DL_FLAG_AUTOREMOVE_CONSUMER |
696 DL_FLAG_AUTOREMOVE_SUPPLIER)))
699 if (flags & DL_FLAG_PM_RUNTIME && flags & DL_FLAG_RPM_ACTIVE) {
700 if (pm_runtime_get_sync(supplier) < 0) {
701 pm_runtime_put_noidle(supplier);
706 if (!(flags & DL_FLAG_STATELESS))
707 flags |= DL_FLAG_MANAGED;
709 device_links_write_lock();
713 * If the supplier has not been fully registered yet or there is a
714 * reverse (non-SYNC_STATE_ONLY) dependency between the consumer and
715 * the supplier already in the graph, return NULL. If the link is a
716 * SYNC_STATE_ONLY link, we don't check for reverse dependencies
717 * because it only affects sync_state() callbacks.
719 if (!device_pm_initialized(supplier)
720 || (!(flags & DL_FLAG_SYNC_STATE_ONLY) &&
721 device_is_dependent(consumer, supplier))) {
727 * SYNC_STATE_ONLY links are useless once a consumer device has probed.
728 * So, only create it if the consumer hasn't probed yet.
730 if (flags & DL_FLAG_SYNC_STATE_ONLY &&
731 consumer->links.status != DL_DEV_NO_DRIVER &&
732 consumer->links.status != DL_DEV_PROBING) {
738 * DL_FLAG_AUTOREMOVE_SUPPLIER indicates that the link will be needed
739 * longer than for DL_FLAG_AUTOREMOVE_CONSUMER and setting them both
740 * together doesn't make sense, so prefer DL_FLAG_AUTOREMOVE_SUPPLIER.
742 if (flags & DL_FLAG_AUTOREMOVE_SUPPLIER)
743 flags &= ~DL_FLAG_AUTOREMOVE_CONSUMER;
745 list_for_each_entry(link, &supplier->links.consumers, s_node) {
746 if (link->consumer != consumer)
749 if (link->flags & DL_FLAG_INFERRED &&
750 !(flags & DL_FLAG_INFERRED))
751 link->flags &= ~DL_FLAG_INFERRED;
753 if (flags & DL_FLAG_PM_RUNTIME) {
754 if (!(link->flags & DL_FLAG_PM_RUNTIME)) {
755 pm_runtime_new_link(consumer);
756 link->flags |= DL_FLAG_PM_RUNTIME;
758 if (flags & DL_FLAG_RPM_ACTIVE)
759 refcount_inc(&link->rpm_active);
762 if (flags & DL_FLAG_STATELESS) {
763 kref_get(&link->kref);
764 if (link->flags & DL_FLAG_SYNC_STATE_ONLY &&
765 !(link->flags & DL_FLAG_STATELESS)) {
766 link->flags |= DL_FLAG_STATELESS;
769 link->flags |= DL_FLAG_STATELESS;
775 * If the life time of the link following from the new flags is
776 * longer than indicated by the flags of the existing link,
777 * update the existing link to stay around longer.
779 if (flags & DL_FLAG_AUTOREMOVE_SUPPLIER) {
780 if (link->flags & DL_FLAG_AUTOREMOVE_CONSUMER) {
781 link->flags &= ~DL_FLAG_AUTOREMOVE_CONSUMER;
782 link->flags |= DL_FLAG_AUTOREMOVE_SUPPLIER;
784 } else if (!(flags & DL_FLAG_AUTOREMOVE_CONSUMER)) {
785 link->flags &= ~(DL_FLAG_AUTOREMOVE_CONSUMER |
786 DL_FLAG_AUTOREMOVE_SUPPLIER);
788 if (!(link->flags & DL_FLAG_MANAGED)) {
789 kref_get(&link->kref);
790 link->flags |= DL_FLAG_MANAGED;
791 device_link_init_status(link, consumer, supplier);
793 if (link->flags & DL_FLAG_SYNC_STATE_ONLY &&
794 !(flags & DL_FLAG_SYNC_STATE_ONLY)) {
795 link->flags &= ~DL_FLAG_SYNC_STATE_ONLY;
802 link = kzalloc(sizeof(*link), GFP_KERNEL);
806 refcount_set(&link->rpm_active, 1);
808 get_device(supplier);
809 link->supplier = supplier;
810 INIT_LIST_HEAD(&link->s_node);
811 get_device(consumer);
812 link->consumer = consumer;
813 INIT_LIST_HEAD(&link->c_node);
815 kref_init(&link->kref);
817 link->link_dev.class = &devlink_class;
818 device_set_pm_not_required(&link->link_dev);
819 dev_set_name(&link->link_dev, "%s:%s--%s:%s",
820 dev_bus_name(supplier), dev_name(supplier),
821 dev_bus_name(consumer), dev_name(consumer));
822 if (device_register(&link->link_dev)) {
823 put_device(&link->link_dev);
828 if (flags & DL_FLAG_PM_RUNTIME) {
829 if (flags & DL_FLAG_RPM_ACTIVE)
830 refcount_inc(&link->rpm_active);
832 pm_runtime_new_link(consumer);
835 /* Determine the initial link state. */
836 if (flags & DL_FLAG_STATELESS)
837 link->status = DL_STATE_NONE;
839 device_link_init_status(link, consumer, supplier);
842 * Some callers expect the link creation during consumer driver probe to
843 * resume the supplier even without DL_FLAG_RPM_ACTIVE.
845 if (link->status == DL_STATE_CONSUMER_PROBE &&
846 flags & DL_FLAG_PM_RUNTIME)
847 pm_runtime_resume(supplier);
849 list_add_tail_rcu(&link->s_node, &supplier->links.consumers);
850 list_add_tail_rcu(&link->c_node, &consumer->links.suppliers);
852 if (flags & DL_FLAG_SYNC_STATE_ONLY) {
854 "Linked as a sync state only consumer to %s\n",
861 * Move the consumer and all of the devices depending on it to the end
862 * of dpm_list and the devices_kset list.
864 * It is necessary to hold dpm_list locked throughout all that or else
865 * we may end up suspending with a wrong ordering of it.
867 device_reorder_to_tail(consumer, NULL);
869 dev_dbg(consumer, "Linked as a consumer to %s\n", dev_name(supplier));
873 device_links_write_unlock();
875 if ((flags & DL_FLAG_PM_RUNTIME && flags & DL_FLAG_RPM_ACTIVE) && !link)
876 pm_runtime_put(supplier);
880 EXPORT_SYMBOL_GPL(device_link_add);
882 static void __device_link_del(struct kref *kref)
884 struct device_link *link = container_of(kref, struct device_link, kref);
886 dev_dbg(link->consumer, "Dropping the link to %s\n",
887 dev_name(link->supplier));
889 pm_runtime_drop_link(link);
891 device_link_remove_from_lists(link);
892 device_unregister(&link->link_dev);
895 static void device_link_put_kref(struct device_link *link)
897 if (link->flags & DL_FLAG_STATELESS)
898 kref_put(&link->kref, __device_link_del);
899 else if (!device_is_registered(link->consumer))
900 __device_link_del(&link->kref);
902 WARN(1, "Unable to drop a managed device link reference\n");
906 * device_link_del - Delete a stateless link between two devices.
907 * @link: Device link to delete.
909 * The caller must ensure proper synchronization of this function with runtime
910 * PM. If the link was added multiple times, it needs to be deleted as often.
911 * Care is required for hotplugged devices: Their links are purged on removal
912 * and calling device_link_del() is then no longer allowed.
914 void device_link_del(struct device_link *link)
916 device_links_write_lock();
917 device_link_put_kref(link);
918 device_links_write_unlock();
920 EXPORT_SYMBOL_GPL(device_link_del);
923 * device_link_remove - Delete a stateless link between two devices.
924 * @consumer: Consumer end of the link.
925 * @supplier: Supplier end of the link.
927 * The caller must ensure proper synchronization of this function with runtime
930 void device_link_remove(void *consumer, struct device *supplier)
932 struct device_link *link;
934 if (WARN_ON(consumer == supplier))
937 device_links_write_lock();
939 list_for_each_entry(link, &supplier->links.consumers, s_node) {
940 if (link->consumer == consumer) {
941 device_link_put_kref(link);
946 device_links_write_unlock();
948 EXPORT_SYMBOL_GPL(device_link_remove);
950 static void device_links_missing_supplier(struct device *dev)
952 struct device_link *link;
954 list_for_each_entry(link, &dev->links.suppliers, c_node) {
955 if (link->status != DL_STATE_CONSUMER_PROBE)
958 if (link->supplier->links.status == DL_DEV_DRIVER_BOUND) {
959 WRITE_ONCE(link->status, DL_STATE_AVAILABLE);
961 WARN_ON(!(link->flags & DL_FLAG_SYNC_STATE_ONLY));
962 WRITE_ONCE(link->status, DL_STATE_DORMANT);
968 * device_links_check_suppliers - Check presence of supplier drivers.
969 * @dev: Consumer device.
971 * Check links from this device to any suppliers. Walk the list of the device's
972 * links to suppliers and see if all of them are available. If not, simply
973 * return -EPROBE_DEFER.
975 * We need to guarantee that the supplier will not go away after the check has
976 * been positive here. It only can go away in __device_release_driver() and
977 * that function checks the device's links to consumers. This means we need to
978 * mark the link as "consumer probe in progress" to make the supplier removal
979 * wait for us to complete (or bad things may happen).
981 * Links without the DL_FLAG_MANAGED flag set are ignored.
983 int device_links_check_suppliers(struct device *dev)
985 struct device_link *link;
987 struct fwnode_handle *sup_fw;
990 * Device waiting for supplier to become available is not allowed to
993 mutex_lock(&fwnode_link_lock);
994 if (dev->fwnode && !list_empty(&dev->fwnode->suppliers) &&
995 !fw_devlink_is_permissive()) {
996 sup_fw = list_first_entry(&dev->fwnode->suppliers,
999 dev_err_probe(dev, -EPROBE_DEFER, "wait for supplier %pfwP\n",
1001 mutex_unlock(&fwnode_link_lock);
1002 return -EPROBE_DEFER;
1004 mutex_unlock(&fwnode_link_lock);
1006 device_links_write_lock();
1008 list_for_each_entry(link, &dev->links.suppliers, c_node) {
1009 if (!(link->flags & DL_FLAG_MANAGED))
1012 if (link->status != DL_STATE_AVAILABLE &&
1013 !(link->flags & DL_FLAG_SYNC_STATE_ONLY)) {
1014 device_links_missing_supplier(dev);
1015 dev_err_probe(dev, -EPROBE_DEFER,
1016 "supplier %s not ready\n",
1017 dev_name(link->supplier));
1018 ret = -EPROBE_DEFER;
1021 WRITE_ONCE(link->status, DL_STATE_CONSUMER_PROBE);
1023 dev->links.status = DL_DEV_PROBING;
1025 device_links_write_unlock();
1030 * __device_links_queue_sync_state - Queue a device for sync_state() callback
1031 * @dev: Device to call sync_state() on
1032 * @list: List head to queue the @dev on
1034 * Queues a device for a sync_state() callback when the device links write lock
1035 * isn't held. This allows the sync_state() execution flow to use device links
1036 * APIs. The caller must ensure this function is called with
1037 * device_links_write_lock() held.
1039 * This function does a get_device() to make sure the device is not freed while
1042 * So the caller must also ensure that device_links_flush_sync_list() is called
1043 * as soon as the caller releases device_links_write_lock(). This is necessary
1044 * to make sure the sync_state() is called in a timely fashion and the
1045 * put_device() is called on this device.
1047 static void __device_links_queue_sync_state(struct device *dev,
1048 struct list_head *list)
1050 struct device_link *link;
1052 if (!dev_has_sync_state(dev))
1054 if (dev->state_synced)
1057 list_for_each_entry(link, &dev->links.consumers, s_node) {
1058 if (!(link->flags & DL_FLAG_MANAGED))
1060 if (link->status != DL_STATE_ACTIVE)
1065 * Set the flag here to avoid adding the same device to a list more
1066 * than once. This can happen if new consumers get added to the device
1067 * and probed before the list is flushed.
1069 dev->state_synced = true;
1071 if (WARN_ON(!list_empty(&dev->links.defer_sync)))
1075 list_add_tail(&dev->links.defer_sync, list);
1079 * device_links_flush_sync_list - Call sync_state() on a list of devices
1080 * @list: List of devices to call sync_state() on
1081 * @dont_lock_dev: Device for which lock is already held by the caller
1083 * Calls sync_state() on all the devices that have been queued for it. This
1084 * function is used in conjunction with __device_links_queue_sync_state(). The
1085 * @dont_lock_dev parameter is useful when this function is called from a
1086 * context where a device lock is already held.
1088 static void device_links_flush_sync_list(struct list_head *list,
1089 struct device *dont_lock_dev)
1091 struct device *dev, *tmp;
1093 list_for_each_entry_safe(dev, tmp, list, links.defer_sync) {
1094 list_del_init(&dev->links.defer_sync);
1096 if (dev != dont_lock_dev)
1099 if (dev->bus->sync_state)
1100 dev->bus->sync_state(dev);
1101 else if (dev->driver && dev->driver->sync_state)
1102 dev->driver->sync_state(dev);
1104 if (dev != dont_lock_dev)
1111 void device_links_supplier_sync_state_pause(void)
1113 device_links_write_lock();
1114 defer_sync_state_count++;
1115 device_links_write_unlock();
1118 void device_links_supplier_sync_state_resume(void)
1120 struct device *dev, *tmp;
1121 LIST_HEAD(sync_list);
1123 device_links_write_lock();
1124 if (!defer_sync_state_count) {
1125 WARN(true, "Unmatched sync_state pause/resume!");
1128 defer_sync_state_count--;
1129 if (defer_sync_state_count)
1132 list_for_each_entry_safe(dev, tmp, &deferred_sync, links.defer_sync) {
1134 * Delete from deferred_sync list before queuing it to
1135 * sync_list because defer_sync is used for both lists.
1137 list_del_init(&dev->links.defer_sync);
1138 __device_links_queue_sync_state(dev, &sync_list);
1141 device_links_write_unlock();
1143 device_links_flush_sync_list(&sync_list, NULL);
1146 static int sync_state_resume_initcall(void)
1148 device_links_supplier_sync_state_resume();
1151 late_initcall(sync_state_resume_initcall);
1153 static void __device_links_supplier_defer_sync(struct device *sup)
1155 if (list_empty(&sup->links.defer_sync) && dev_has_sync_state(sup))
1156 list_add_tail(&sup->links.defer_sync, &deferred_sync);
1159 static void device_link_drop_managed(struct device_link *link)
1161 link->flags &= ~DL_FLAG_MANAGED;
1162 WRITE_ONCE(link->status, DL_STATE_NONE);
1163 kref_put(&link->kref, __device_link_del);
1166 static ssize_t waiting_for_supplier_show(struct device *dev,
1167 struct device_attribute *attr,
1173 val = !list_empty(&dev->fwnode->suppliers);
1175 return sysfs_emit(buf, "%u\n", val);
1177 static DEVICE_ATTR_RO(waiting_for_supplier);
1180 * device_links_force_bind - Prepares device to be force bound
1181 * @dev: Consumer device.
1183 * device_bind_driver() force binds a device to a driver without calling any
1184 * driver probe functions. So the consumer really isn't going to wait for any
1185 * supplier before it's bound to the driver. We still want the device link
1186 * states to be sensible when this happens.
1188 * In preparation for device_bind_driver(), this function goes through each
1189 * supplier device links and checks if the supplier is bound. If it is, then
1190 * the device link status is set to CONSUMER_PROBE. Otherwise, the device link
1191 * is dropped. Links without the DL_FLAG_MANAGED flag set are ignored.
1193 void device_links_force_bind(struct device *dev)
1195 struct device_link *link, *ln;
1197 device_links_write_lock();
1199 list_for_each_entry_safe(link, ln, &dev->links.suppliers, c_node) {
1200 if (!(link->flags & DL_FLAG_MANAGED))
1203 if (link->status != DL_STATE_AVAILABLE) {
1204 device_link_drop_managed(link);
1207 WRITE_ONCE(link->status, DL_STATE_CONSUMER_PROBE);
1209 dev->links.status = DL_DEV_PROBING;
1211 device_links_write_unlock();
1215 * device_links_driver_bound - Update device links after probing its driver.
1216 * @dev: Device to update the links for.
1218 * The probe has been successful, so update links from this device to any
1219 * consumers by changing their status to "available".
1221 * Also change the status of @dev's links to suppliers to "active".
1223 * Links without the DL_FLAG_MANAGED flag set are ignored.
1225 void device_links_driver_bound(struct device *dev)
1227 struct device_link *link, *ln;
1228 LIST_HEAD(sync_list);
1231 * If a device binds successfully, it's expected to have created all
1232 * the device links it needs to or make new device links as it needs
1233 * them. So, fw_devlink no longer needs to create device links to any
1234 * of the device's suppliers.
1236 * Also, if a child firmware node of this bound device is not added as
1237 * a device by now, assume it is never going to be added and make sure
1238 * other devices don't defer probe indefinitely by waiting for such a
1241 if (dev->fwnode && dev->fwnode->dev == dev) {
1242 struct fwnode_handle *child;
1243 fwnode_links_purge_suppliers(dev->fwnode);
1244 fwnode_for_each_available_child_node(dev->fwnode, child)
1245 fw_devlink_purge_absent_suppliers(child);
1247 device_remove_file(dev, &dev_attr_waiting_for_supplier);
1249 device_links_write_lock();
1251 list_for_each_entry(link, &dev->links.consumers, s_node) {
1252 if (!(link->flags & DL_FLAG_MANAGED))
1256 * Links created during consumer probe may be in the "consumer
1257 * probe" state to start with if the supplier is still probing
1258 * when they are created and they may become "active" if the
1259 * consumer probe returns first. Skip them here.
1261 if (link->status == DL_STATE_CONSUMER_PROBE ||
1262 link->status == DL_STATE_ACTIVE)
1265 WARN_ON(link->status != DL_STATE_DORMANT);
1266 WRITE_ONCE(link->status, DL_STATE_AVAILABLE);
1268 if (link->flags & DL_FLAG_AUTOPROBE_CONSUMER)
1269 driver_deferred_probe_add(link->consumer);
1272 if (defer_sync_state_count)
1273 __device_links_supplier_defer_sync(dev);
1275 __device_links_queue_sync_state(dev, &sync_list);
1277 list_for_each_entry_safe(link, ln, &dev->links.suppliers, c_node) {
1278 struct device *supplier;
1280 if (!(link->flags & DL_FLAG_MANAGED))
1283 supplier = link->supplier;
1284 if (link->flags & DL_FLAG_SYNC_STATE_ONLY) {
1286 * When DL_FLAG_SYNC_STATE_ONLY is set, it means no
1287 * other DL_MANAGED_LINK_FLAGS have been set. So, it's
1288 * save to drop the managed link completely.
1290 device_link_drop_managed(link);
1292 WARN_ON(link->status != DL_STATE_CONSUMER_PROBE);
1293 WRITE_ONCE(link->status, DL_STATE_ACTIVE);
1297 * This needs to be done even for the deleted
1298 * DL_FLAG_SYNC_STATE_ONLY device link in case it was the last
1299 * device link that was preventing the supplier from getting a
1300 * sync_state() call.
1302 if (defer_sync_state_count)
1303 __device_links_supplier_defer_sync(supplier);
1305 __device_links_queue_sync_state(supplier, &sync_list);
1308 dev->links.status = DL_DEV_DRIVER_BOUND;
1310 device_links_write_unlock();
1312 device_links_flush_sync_list(&sync_list, dev);
1316 * __device_links_no_driver - Update links of a device without a driver.
1317 * @dev: Device without a drvier.
1319 * Delete all non-persistent links from this device to any suppliers.
1321 * Persistent links stay around, but their status is changed to "available",
1322 * unless they already are in the "supplier unbind in progress" state in which
1323 * case they need not be updated.
1325 * Links without the DL_FLAG_MANAGED flag set are ignored.
1327 static void __device_links_no_driver(struct device *dev)
1329 struct device_link *link, *ln;
1331 list_for_each_entry_safe_reverse(link, ln, &dev->links.suppliers, c_node) {
1332 if (!(link->flags & DL_FLAG_MANAGED))
1335 if (link->flags & DL_FLAG_AUTOREMOVE_CONSUMER) {
1336 device_link_drop_managed(link);
1340 if (link->status != DL_STATE_CONSUMER_PROBE &&
1341 link->status != DL_STATE_ACTIVE)
1344 if (link->supplier->links.status == DL_DEV_DRIVER_BOUND) {
1345 WRITE_ONCE(link->status, DL_STATE_AVAILABLE);
1347 WARN_ON(!(link->flags & DL_FLAG_SYNC_STATE_ONLY));
1348 WRITE_ONCE(link->status, DL_STATE_DORMANT);
1352 dev->links.status = DL_DEV_NO_DRIVER;
1356 * device_links_no_driver - Update links after failing driver probe.
1357 * @dev: Device whose driver has just failed to probe.
1359 * Clean up leftover links to consumers for @dev and invoke
1360 * %__device_links_no_driver() to update links to suppliers for it as
1363 * Links without the DL_FLAG_MANAGED flag set are ignored.
1365 void device_links_no_driver(struct device *dev)
1367 struct device_link *link;
1369 device_links_write_lock();
1371 list_for_each_entry(link, &dev->links.consumers, s_node) {
1372 if (!(link->flags & DL_FLAG_MANAGED))
1376 * The probe has failed, so if the status of the link is
1377 * "consumer probe" or "active", it must have been added by
1378 * a probing consumer while this device was still probing.
1379 * Change its state to "dormant", as it represents a valid
1380 * relationship, but it is not functionally meaningful.
1382 if (link->status == DL_STATE_CONSUMER_PROBE ||
1383 link->status == DL_STATE_ACTIVE)
1384 WRITE_ONCE(link->status, DL_STATE_DORMANT);
1387 __device_links_no_driver(dev);
1389 device_links_write_unlock();
1393 * device_links_driver_cleanup - Update links after driver removal.
1394 * @dev: Device whose driver has just gone away.
1396 * Update links to consumers for @dev by changing their status to "dormant" and
1397 * invoke %__device_links_no_driver() to update links to suppliers for it as
1400 * Links without the DL_FLAG_MANAGED flag set are ignored.
1402 void device_links_driver_cleanup(struct device *dev)
1404 struct device_link *link, *ln;
1406 device_links_write_lock();
1408 list_for_each_entry_safe(link, ln, &dev->links.consumers, s_node) {
1409 if (!(link->flags & DL_FLAG_MANAGED))
1412 WARN_ON(link->flags & DL_FLAG_AUTOREMOVE_CONSUMER);
1413 WARN_ON(link->status != DL_STATE_SUPPLIER_UNBIND);
1416 * autoremove the links between this @dev and its consumer
1417 * devices that are not active, i.e. where the link state
1418 * has moved to DL_STATE_SUPPLIER_UNBIND.
1420 if (link->status == DL_STATE_SUPPLIER_UNBIND &&
1421 link->flags & DL_FLAG_AUTOREMOVE_SUPPLIER)
1422 device_link_drop_managed(link);
1424 WRITE_ONCE(link->status, DL_STATE_DORMANT);
1427 list_del_init(&dev->links.defer_sync);
1428 __device_links_no_driver(dev);
1430 device_links_write_unlock();
1434 * device_links_busy - Check if there are any busy links to consumers.
1435 * @dev: Device to check.
1437 * Check each consumer of the device and return 'true' if its link's status
1438 * is one of "consumer probe" or "active" (meaning that the given consumer is
1439 * probing right now or its driver is present). Otherwise, change the link
1440 * state to "supplier unbind" to prevent the consumer from being probed
1441 * successfully going forward.
1443 * Return 'false' if there are no probing or active consumers.
1445 * Links without the DL_FLAG_MANAGED flag set are ignored.
1447 bool device_links_busy(struct device *dev)
1449 struct device_link *link;
1452 device_links_write_lock();
1454 list_for_each_entry(link, &dev->links.consumers, s_node) {
1455 if (!(link->flags & DL_FLAG_MANAGED))
1458 if (link->status == DL_STATE_CONSUMER_PROBE
1459 || link->status == DL_STATE_ACTIVE) {
1463 WRITE_ONCE(link->status, DL_STATE_SUPPLIER_UNBIND);
1466 dev->links.status = DL_DEV_UNBINDING;
1468 device_links_write_unlock();
1473 * device_links_unbind_consumers - Force unbind consumers of the given device.
1474 * @dev: Device to unbind the consumers of.
1476 * Walk the list of links to consumers for @dev and if any of them is in the
1477 * "consumer probe" state, wait for all device probes in progress to complete
1480 * If that's not the case, change the status of the link to "supplier unbind"
1481 * and check if the link was in the "active" state. If so, force the consumer
1482 * driver to unbind and start over (the consumer will not re-probe as we have
1483 * changed the state of the link already).
1485 * Links without the DL_FLAG_MANAGED flag set are ignored.
1487 void device_links_unbind_consumers(struct device *dev)
1489 struct device_link *link;
1492 device_links_write_lock();
1494 list_for_each_entry(link, &dev->links.consumers, s_node) {
1495 enum device_link_state status;
1497 if (!(link->flags & DL_FLAG_MANAGED) ||
1498 link->flags & DL_FLAG_SYNC_STATE_ONLY)
1501 status = link->status;
1502 if (status == DL_STATE_CONSUMER_PROBE) {
1503 device_links_write_unlock();
1505 wait_for_device_probe();
1508 WRITE_ONCE(link->status, DL_STATE_SUPPLIER_UNBIND);
1509 if (status == DL_STATE_ACTIVE) {
1510 struct device *consumer = link->consumer;
1512 get_device(consumer);
1514 device_links_write_unlock();
1516 device_release_driver_internal(consumer, NULL,
1518 put_device(consumer);
1523 device_links_write_unlock();
1527 * device_links_purge - Delete existing links to other devices.
1528 * @dev: Target device.
1530 static void device_links_purge(struct device *dev)
1532 struct device_link *link, *ln;
1534 if (dev->class == &devlink_class)
1538 * Delete all of the remaining links from this device to any other
1539 * devices (either consumers or suppliers).
1541 device_links_write_lock();
1543 list_for_each_entry_safe_reverse(link, ln, &dev->links.suppliers, c_node) {
1544 WARN_ON(link->status == DL_STATE_ACTIVE);
1545 __device_link_del(&link->kref);
1548 list_for_each_entry_safe_reverse(link, ln, &dev->links.consumers, s_node) {
1549 WARN_ON(link->status != DL_STATE_DORMANT &&
1550 link->status != DL_STATE_NONE);
1551 __device_link_del(&link->kref);
1554 device_links_write_unlock();
1557 #define FW_DEVLINK_FLAGS_PERMISSIVE (DL_FLAG_INFERRED | \
1558 DL_FLAG_SYNC_STATE_ONLY)
1559 #define FW_DEVLINK_FLAGS_ON (DL_FLAG_INFERRED | \
1560 DL_FLAG_AUTOPROBE_CONSUMER)
1561 #define FW_DEVLINK_FLAGS_RPM (FW_DEVLINK_FLAGS_ON | \
1564 static u32 fw_devlink_flags = FW_DEVLINK_FLAGS_ON;
1565 static int __init fw_devlink_setup(char *arg)
1570 if (strcmp(arg, "off") == 0) {
1571 fw_devlink_flags = 0;
1572 } else if (strcmp(arg, "permissive") == 0) {
1573 fw_devlink_flags = FW_DEVLINK_FLAGS_PERMISSIVE;
1574 } else if (strcmp(arg, "on") == 0) {
1575 fw_devlink_flags = FW_DEVLINK_FLAGS_ON;
1576 } else if (strcmp(arg, "rpm") == 0) {
1577 fw_devlink_flags = FW_DEVLINK_FLAGS_RPM;
1581 early_param("fw_devlink", fw_devlink_setup);
1583 static bool fw_devlink_strict;
1584 static int __init fw_devlink_strict_setup(char *arg)
1586 return strtobool(arg, &fw_devlink_strict);
1588 early_param("fw_devlink.strict", fw_devlink_strict_setup);
1590 u32 fw_devlink_get_flags(void)
1592 return fw_devlink_flags;
1595 static bool fw_devlink_is_permissive(void)
1597 return fw_devlink_flags == FW_DEVLINK_FLAGS_PERMISSIVE;
1600 bool fw_devlink_is_strict(void)
1602 return fw_devlink_strict && !fw_devlink_is_permissive();
1605 static void fw_devlink_parse_fwnode(struct fwnode_handle *fwnode)
1607 if (fwnode->flags & FWNODE_FLAG_LINKS_ADDED)
1610 fwnode_call_int_op(fwnode, add_links);
1611 fwnode->flags |= FWNODE_FLAG_LINKS_ADDED;
1614 static void fw_devlink_parse_fwtree(struct fwnode_handle *fwnode)
1616 struct fwnode_handle *child = NULL;
1618 fw_devlink_parse_fwnode(fwnode);
1620 while ((child = fwnode_get_next_available_child_node(fwnode, child)))
1621 fw_devlink_parse_fwtree(child);
1624 static void fw_devlink_relax_link(struct device_link *link)
1626 if (!(link->flags & DL_FLAG_INFERRED))
1629 if (link->flags == (DL_FLAG_MANAGED | FW_DEVLINK_FLAGS_PERMISSIVE))
1632 pm_runtime_drop_link(link);
1633 link->flags = DL_FLAG_MANAGED | FW_DEVLINK_FLAGS_PERMISSIVE;
1634 dev_dbg(link->consumer, "Relaxing link with %s\n",
1635 dev_name(link->supplier));
1638 static int fw_devlink_no_driver(struct device *dev, void *data)
1640 struct device_link *link = to_devlink(dev);
1642 if (!link->supplier->can_match)
1643 fw_devlink_relax_link(link);
1648 void fw_devlink_drivers_done(void)
1650 fw_devlink_drv_reg_done = true;
1651 device_links_write_lock();
1652 class_for_each_device(&devlink_class, NULL, NULL,
1653 fw_devlink_no_driver);
1654 device_links_write_unlock();
1657 static void fw_devlink_unblock_consumers(struct device *dev)
1659 struct device_link *link;
1661 if (!fw_devlink_flags || fw_devlink_is_permissive())
1664 device_links_write_lock();
1665 list_for_each_entry(link, &dev->links.consumers, s_node)
1666 fw_devlink_relax_link(link);
1667 device_links_write_unlock();
1671 * fw_devlink_relax_cycle - Convert cyclic links to SYNC_STATE_ONLY links
1672 * @con: Device to check dependencies for.
1673 * @sup: Device to check against.
1675 * Check if @sup depends on @con or any device dependent on it (its child or
1676 * its consumer etc). When such a cyclic dependency is found, convert all
1677 * device links created solely by fw_devlink into SYNC_STATE_ONLY device links.
1678 * This is the equivalent of doing fw_devlink=permissive just between the
1679 * devices in the cycle. We need to do this because, at this point, fw_devlink
1680 * can't tell which of these dependencies is not a real dependency.
1682 * Return 1 if a cycle is found. Otherwise, return 0.
1684 static int fw_devlink_relax_cycle(struct device *con, void *sup)
1686 struct device_link *link;
1692 ret = device_for_each_child(con, sup, fw_devlink_relax_cycle);
1696 list_for_each_entry(link, &con->links.consumers, s_node) {
1697 if ((link->flags & ~DL_FLAG_INFERRED) ==
1698 (DL_FLAG_SYNC_STATE_ONLY | DL_FLAG_MANAGED))
1701 if (!fw_devlink_relax_cycle(link->consumer, sup))
1706 fw_devlink_relax_link(link);
1712 * fw_devlink_create_devlink - Create a device link from a consumer to fwnode
1713 * @con: consumer device for the device link
1714 * @sup_handle: fwnode handle of supplier
1715 * @flags: devlink flags
1717 * This function will try to create a device link between the consumer device
1718 * @con and the supplier device represented by @sup_handle.
1720 * The supplier has to be provided as a fwnode because incorrect cycles in
1721 * fwnode links can sometimes cause the supplier device to never be created.
1722 * This function detects such cases and returns an error if it cannot create a
1723 * device link from the consumer to a missing supplier.
1726 * 0 on successfully creating a device link
1727 * -EINVAL if the device link cannot be created as expected
1728 * -EAGAIN if the device link cannot be created right now, but it may be
1729 * possible to do that in the future
1731 static int fw_devlink_create_devlink(struct device *con,
1732 struct fwnode_handle *sup_handle, u32 flags)
1734 struct device *sup_dev;
1738 * In some cases, a device P might also be a supplier to its child node
1739 * C. However, this would defer the probe of C until the probe of P
1740 * completes successfully. This is perfectly fine in the device driver
1741 * model. device_add() doesn't guarantee probe completion of the device
1742 * by the time it returns.
1744 * However, there are a few drivers that assume C will finish probing
1745 * as soon as it's added and before P finishes probing. So, we provide
1746 * a flag to let fw_devlink know not to delay the probe of C until the
1747 * probe of P completes successfully.
1749 * When such a flag is set, we can't create device links where P is the
1750 * supplier of C as that would delay the probe of C.
1752 if (sup_handle->flags & FWNODE_FLAG_NEEDS_CHILD_BOUND_ON_ADD &&
1753 fwnode_is_ancestor_of(sup_handle, con->fwnode))
1756 sup_dev = get_dev_from_fwnode(sup_handle);
1759 * If it's one of those drivers that don't actually bind to
1760 * their device using driver core, then don't wait on this
1761 * supplier device indefinitely.
1763 if (sup_dev->links.status == DL_DEV_NO_DRIVER &&
1764 sup_handle->flags & FWNODE_FLAG_INITIALIZED) {
1770 * If this fails, it is due to cycles in device links. Just
1771 * give up on this link and treat it as invalid.
1773 if (!device_link_add(con, sup_dev, flags) &&
1774 !(flags & DL_FLAG_SYNC_STATE_ONLY)) {
1775 dev_info(con, "Fixing up cyclic dependency with %s\n",
1777 device_links_write_lock();
1778 fw_devlink_relax_cycle(con, sup_dev);
1779 device_links_write_unlock();
1780 device_link_add(con, sup_dev,
1781 FW_DEVLINK_FLAGS_PERMISSIVE);
1788 /* Supplier that's already initialized without a struct device. */
1789 if (sup_handle->flags & FWNODE_FLAG_INITIALIZED)
1793 * DL_FLAG_SYNC_STATE_ONLY doesn't block probing and supports
1794 * cycles. So cycle detection isn't necessary and shouldn't be
1797 if (flags & DL_FLAG_SYNC_STATE_ONLY)
1801 * If we can't find the supplier device from its fwnode, it might be
1802 * due to a cyclic dependency between fwnodes. Some of these cycles can
1803 * be broken by applying logic. Check for these types of cycles and
1804 * break them so that devices in the cycle probe properly.
1806 * If the supplier's parent is dependent on the consumer, then the
1807 * consumer and supplier have a cyclic dependency. Since fw_devlink
1808 * can't tell which of the inferred dependencies are incorrect, don't
1809 * enforce probe ordering between any of the devices in this cyclic
1810 * dependency. Do this by relaxing all the fw_devlink device links in
1811 * this cycle and by treating the fwnode link between the consumer and
1812 * the supplier as an invalid dependency.
1814 sup_dev = fwnode_get_next_parent_dev(sup_handle);
1815 if (sup_dev && device_is_dependent(con, sup_dev)) {
1816 dev_info(con, "Fixing up cyclic dependency with %pfwP (%s)\n",
1817 sup_handle, dev_name(sup_dev));
1818 device_links_write_lock();
1819 fw_devlink_relax_cycle(con, sup_dev);
1820 device_links_write_unlock();
1824 * Can't check for cycles or no cycles. So let's try
1831 put_device(sup_dev);
1836 * __fw_devlink_link_to_consumers - Create device links to consumers of a device
1837 * @dev: Device that needs to be linked to its consumers
1839 * This function looks at all the consumer fwnodes of @dev and creates device
1840 * links between the consumer device and @dev (supplier).
1842 * If the consumer device has not been added yet, then this function creates a
1843 * SYNC_STATE_ONLY link between @dev (supplier) and the closest ancestor device
1844 * of the consumer fwnode. This is necessary to make sure @dev doesn't get a
1845 * sync_state() callback before the real consumer device gets to be added and
1848 * Once device links are created from the real consumer to @dev (supplier), the
1849 * fwnode links are deleted.
1851 static void __fw_devlink_link_to_consumers(struct device *dev)
1853 struct fwnode_handle *fwnode = dev->fwnode;
1854 struct fwnode_link *link, *tmp;
1856 list_for_each_entry_safe(link, tmp, &fwnode->consumers, s_hook) {
1857 u32 dl_flags = fw_devlink_get_flags();
1858 struct device *con_dev;
1859 bool own_link = true;
1862 con_dev = get_dev_from_fwnode(link->consumer);
1864 * If consumer device is not available yet, make a "proxy"
1865 * SYNC_STATE_ONLY link from the consumer's parent device to
1866 * the supplier device. This is necessary to make sure the
1867 * supplier doesn't get a sync_state() callback before the real
1868 * consumer can create a device link to the supplier.
1870 * This proxy link step is needed to handle the case where the
1871 * consumer's parent device is added before the supplier.
1874 con_dev = fwnode_get_next_parent_dev(link->consumer);
1876 * However, if the consumer's parent device is also the
1877 * parent of the supplier, don't create a
1878 * consumer-supplier link from the parent to its child
1879 * device. Such a dependency is impossible.
1882 fwnode_is_ancestor_of(con_dev->fwnode, fwnode)) {
1883 put_device(con_dev);
1887 dl_flags = FW_DEVLINK_FLAGS_PERMISSIVE;
1894 ret = fw_devlink_create_devlink(con_dev, fwnode, dl_flags);
1895 put_device(con_dev);
1896 if (!own_link || ret == -EAGAIN)
1899 __fwnode_link_del(link);
1904 * __fw_devlink_link_to_suppliers - Create device links to suppliers of a device
1905 * @dev: The consumer device that needs to be linked to its suppliers
1906 * @fwnode: Root of the fwnode tree that is used to create device links
1908 * This function looks at all the supplier fwnodes of fwnode tree rooted at
1909 * @fwnode and creates device links between @dev (consumer) and all the
1910 * supplier devices of the entire fwnode tree at @fwnode.
1912 * The function creates normal (non-SYNC_STATE_ONLY) device links between @dev
1913 * and the real suppliers of @dev. Once these device links are created, the
1914 * fwnode links are deleted. When such device links are successfully created,
1915 * this function is called recursively on those supplier devices. This is
1916 * needed to detect and break some invalid cycles in fwnode links. See
1917 * fw_devlink_create_devlink() for more details.
1919 * In addition, it also looks at all the suppliers of the entire fwnode tree
1920 * because some of the child devices of @dev that have not been added yet
1921 * (because @dev hasn't probed) might already have their suppliers added to
1922 * driver core. So, this function creates SYNC_STATE_ONLY device links between
1923 * @dev (consumer) and these suppliers to make sure they don't execute their
1924 * sync_state() callbacks before these child devices have a chance to create
1925 * their device links. The fwnode links that correspond to the child devices
1926 * aren't delete because they are needed later to create the device links
1927 * between the real consumer and supplier devices.
1929 static void __fw_devlink_link_to_suppliers(struct device *dev,
1930 struct fwnode_handle *fwnode)
1932 bool own_link = (dev->fwnode == fwnode);
1933 struct fwnode_link *link, *tmp;
1934 struct fwnode_handle *child = NULL;
1938 dl_flags = fw_devlink_get_flags();
1940 dl_flags = FW_DEVLINK_FLAGS_PERMISSIVE;
1942 list_for_each_entry_safe(link, tmp, &fwnode->suppliers, c_hook) {
1944 struct device *sup_dev;
1945 struct fwnode_handle *sup = link->supplier;
1947 ret = fw_devlink_create_devlink(dev, sup, dl_flags);
1948 if (!own_link || ret == -EAGAIN)
1951 __fwnode_link_del(link);
1953 /* If no device link was created, nothing more to do. */
1958 * If a device link was successfully created to a supplier, we
1959 * now need to try and link the supplier to all its suppliers.
1961 * This is needed to detect and delete false dependencies in
1962 * fwnode links that haven't been converted to a device link
1963 * yet. See comments in fw_devlink_create_devlink() for more
1964 * details on the false dependency.
1966 * Without deleting these false dependencies, some devices will
1967 * never probe because they'll keep waiting for their false
1968 * dependency fwnode links to be converted to device links.
1970 sup_dev = get_dev_from_fwnode(sup);
1971 __fw_devlink_link_to_suppliers(sup_dev, sup_dev->fwnode);
1972 put_device(sup_dev);
1976 * Make "proxy" SYNC_STATE_ONLY device links to represent the needs of
1977 * all the descendants. This proxy link step is needed to handle the
1978 * case where the supplier is added before the consumer's parent device
1981 while ((child = fwnode_get_next_available_child_node(fwnode, child)))
1982 __fw_devlink_link_to_suppliers(dev, child);
1985 static void fw_devlink_link_device(struct device *dev)
1987 struct fwnode_handle *fwnode = dev->fwnode;
1989 if (!fw_devlink_flags)
1992 fw_devlink_parse_fwtree(fwnode);
1994 mutex_lock(&fwnode_link_lock);
1995 __fw_devlink_link_to_consumers(dev);
1996 __fw_devlink_link_to_suppliers(dev, fwnode);
1997 mutex_unlock(&fwnode_link_lock);
2000 /* Device links support end. */
2002 int (*platform_notify)(struct device *dev) = NULL;
2003 int (*platform_notify_remove)(struct device *dev) = NULL;
2004 static struct kobject *dev_kobj;
2005 struct kobject *sysfs_dev_char_kobj;
2006 struct kobject *sysfs_dev_block_kobj;
2008 static DEFINE_MUTEX(device_hotplug_lock);
2010 void lock_device_hotplug(void)
2012 mutex_lock(&device_hotplug_lock);
2015 void unlock_device_hotplug(void)
2017 mutex_unlock(&device_hotplug_lock);
2020 int lock_device_hotplug_sysfs(void)
2022 if (mutex_trylock(&device_hotplug_lock))
2025 /* Avoid busy looping (5 ms of sleep should do). */
2027 return restart_syscall();
2031 static inline int device_is_not_partition(struct device *dev)
2033 return !(dev->type == &part_type);
2036 static inline int device_is_not_partition(struct device *dev)
2042 static void device_platform_notify(struct device *dev)
2044 acpi_device_notify(dev);
2046 software_node_notify(dev);
2048 if (platform_notify)
2049 platform_notify(dev);
2052 static void device_platform_notify_remove(struct device *dev)
2054 acpi_device_notify_remove(dev);
2056 software_node_notify_remove(dev);
2058 if (platform_notify_remove)
2059 platform_notify_remove(dev);
2063 * dev_driver_string - Return a device's driver name, if at all possible
2064 * @dev: struct device to get the name of
2066 * Will return the device's driver's name if it is bound to a device. If
2067 * the device is not bound to a driver, it will return the name of the bus
2068 * it is attached to. If it is not attached to a bus either, an empty
2069 * string will be returned.
2071 const char *dev_driver_string(const struct device *dev)
2073 struct device_driver *drv;
2075 /* dev->driver can change to NULL underneath us because of unbinding,
2076 * so be careful about accessing it. dev->bus and dev->class should
2077 * never change once they are set, so they don't need special care.
2079 drv = READ_ONCE(dev->driver);
2080 return drv ? drv->name : dev_bus_name(dev);
2082 EXPORT_SYMBOL(dev_driver_string);
2084 #define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
2086 static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
2089 struct device_attribute *dev_attr = to_dev_attr(attr);
2090 struct device *dev = kobj_to_dev(kobj);
2094 ret = dev_attr->show(dev, dev_attr, buf);
2095 if (ret >= (ssize_t)PAGE_SIZE) {
2096 printk("dev_attr_show: %pS returned bad count\n",
2102 static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
2103 const char *buf, size_t count)
2105 struct device_attribute *dev_attr = to_dev_attr(attr);
2106 struct device *dev = kobj_to_dev(kobj);
2109 if (dev_attr->store)
2110 ret = dev_attr->store(dev, dev_attr, buf, count);
2114 static const struct sysfs_ops dev_sysfs_ops = {
2115 .show = dev_attr_show,
2116 .store = dev_attr_store,
2119 #define to_ext_attr(x) container_of(x, struct dev_ext_attribute, attr)
2121 ssize_t device_store_ulong(struct device *dev,
2122 struct device_attribute *attr,
2123 const char *buf, size_t size)
2125 struct dev_ext_attribute *ea = to_ext_attr(attr);
2129 ret = kstrtoul(buf, 0, &new);
2132 *(unsigned long *)(ea->var) = new;
2133 /* Always return full write size even if we didn't consume all */
2136 EXPORT_SYMBOL_GPL(device_store_ulong);
2138 ssize_t device_show_ulong(struct device *dev,
2139 struct device_attribute *attr,
2142 struct dev_ext_attribute *ea = to_ext_attr(attr);
2143 return sysfs_emit(buf, "%lx\n", *(unsigned long *)(ea->var));
2145 EXPORT_SYMBOL_GPL(device_show_ulong);
2147 ssize_t device_store_int(struct device *dev,
2148 struct device_attribute *attr,
2149 const char *buf, size_t size)
2151 struct dev_ext_attribute *ea = to_ext_attr(attr);
2155 ret = kstrtol(buf, 0, &new);
2159 if (new > INT_MAX || new < INT_MIN)
2161 *(int *)(ea->var) = new;
2162 /* Always return full write size even if we didn't consume all */
2165 EXPORT_SYMBOL_GPL(device_store_int);
2167 ssize_t device_show_int(struct device *dev,
2168 struct device_attribute *attr,
2171 struct dev_ext_attribute *ea = to_ext_attr(attr);
2173 return sysfs_emit(buf, "%d\n", *(int *)(ea->var));
2175 EXPORT_SYMBOL_GPL(device_show_int);
2177 ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
2178 const char *buf, size_t size)
2180 struct dev_ext_attribute *ea = to_ext_attr(attr);
2182 if (strtobool(buf, ea->var) < 0)
2187 EXPORT_SYMBOL_GPL(device_store_bool);
2189 ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
2192 struct dev_ext_attribute *ea = to_ext_attr(attr);
2194 return sysfs_emit(buf, "%d\n", *(bool *)(ea->var));
2196 EXPORT_SYMBOL_GPL(device_show_bool);
2199 * device_release - free device structure.
2200 * @kobj: device's kobject.
2202 * This is called once the reference count for the object
2203 * reaches 0. We forward the call to the device's release
2204 * method, which should handle actually freeing the structure.
2206 static void device_release(struct kobject *kobj)
2208 struct device *dev = kobj_to_dev(kobj);
2209 struct device_private *p = dev->p;
2212 * Some platform devices are driven without driver attached
2213 * and managed resources may have been acquired. Make sure
2214 * all resources are released.
2216 * Drivers still can add resources into device after device
2217 * is deleted but alive, so release devres here to avoid
2218 * possible memory leak.
2220 devres_release_all(dev);
2222 kfree(dev->dma_range_map);
2226 else if (dev->type && dev->type->release)
2227 dev->type->release(dev);
2228 else if (dev->class && dev->class->dev_release)
2229 dev->class->dev_release(dev);
2231 WARN(1, KERN_ERR "Device '%s' does not have a release() function, it is broken and must be fixed. See Documentation/core-api/kobject.rst.\n",
2236 static const void *device_namespace(struct kobject *kobj)
2238 struct device *dev = kobj_to_dev(kobj);
2239 const void *ns = NULL;
2241 if (dev->class && dev->class->ns_type)
2242 ns = dev->class->namespace(dev);
2247 static void device_get_ownership(struct kobject *kobj, kuid_t *uid, kgid_t *gid)
2249 struct device *dev = kobj_to_dev(kobj);
2251 if (dev->class && dev->class->get_ownership)
2252 dev->class->get_ownership(dev, uid, gid);
2255 static struct kobj_type device_ktype = {
2256 .release = device_release,
2257 .sysfs_ops = &dev_sysfs_ops,
2258 .namespace = device_namespace,
2259 .get_ownership = device_get_ownership,
2263 static int dev_uevent_filter(struct kobject *kobj)
2265 const struct kobj_type *ktype = get_ktype(kobj);
2267 if (ktype == &device_ktype) {
2268 struct device *dev = kobj_to_dev(kobj);
2277 static const char *dev_uevent_name(struct kobject *kobj)
2279 struct device *dev = kobj_to_dev(kobj);
2282 return dev->bus->name;
2284 return dev->class->name;
2288 static int dev_uevent(struct kobject *kobj, struct kobj_uevent_env *env)
2290 struct device *dev = kobj_to_dev(kobj);
2293 /* add device node properties if present */
2294 if (MAJOR(dev->devt)) {
2298 kuid_t uid = GLOBAL_ROOT_UID;
2299 kgid_t gid = GLOBAL_ROOT_GID;
2301 add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
2302 add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
2303 name = device_get_devnode(dev, &mode, &uid, &gid, &tmp);
2305 add_uevent_var(env, "DEVNAME=%s", name);
2307 add_uevent_var(env, "DEVMODE=%#o", mode & 0777);
2308 if (!uid_eq(uid, GLOBAL_ROOT_UID))
2309 add_uevent_var(env, "DEVUID=%u", from_kuid(&init_user_ns, uid));
2310 if (!gid_eq(gid, GLOBAL_ROOT_GID))
2311 add_uevent_var(env, "DEVGID=%u", from_kgid(&init_user_ns, gid));
2316 if (dev->type && dev->type->name)
2317 add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
2320 add_uevent_var(env, "DRIVER=%s", dev->driver->name);
2322 /* Add common DT information about the device */
2323 of_device_uevent(dev, env);
2325 /* have the bus specific function add its stuff */
2326 if (dev->bus && dev->bus->uevent) {
2327 retval = dev->bus->uevent(dev, env);
2329 pr_debug("device: '%s': %s: bus uevent() returned %d\n",
2330 dev_name(dev), __func__, retval);
2333 /* have the class specific function add its stuff */
2334 if (dev->class && dev->class->dev_uevent) {
2335 retval = dev->class->dev_uevent(dev, env);
2337 pr_debug("device: '%s': %s: class uevent() "
2338 "returned %d\n", dev_name(dev),
2342 /* have the device type specific function add its stuff */
2343 if (dev->type && dev->type->uevent) {
2344 retval = dev->type->uevent(dev, env);
2346 pr_debug("device: '%s': %s: dev_type uevent() "
2347 "returned %d\n", dev_name(dev),
2354 static const struct kset_uevent_ops device_uevent_ops = {
2355 .filter = dev_uevent_filter,
2356 .name = dev_uevent_name,
2357 .uevent = dev_uevent,
2360 static ssize_t uevent_show(struct device *dev, struct device_attribute *attr,
2363 struct kobject *top_kobj;
2365 struct kobj_uevent_env *env = NULL;
2370 /* search the kset, the device belongs to */
2371 top_kobj = &dev->kobj;
2372 while (!top_kobj->kset && top_kobj->parent)
2373 top_kobj = top_kobj->parent;
2374 if (!top_kobj->kset)
2377 kset = top_kobj->kset;
2378 if (!kset->uevent_ops || !kset->uevent_ops->uevent)
2381 /* respect filter */
2382 if (kset->uevent_ops && kset->uevent_ops->filter)
2383 if (!kset->uevent_ops->filter(&dev->kobj))
2386 env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
2390 /* let the kset specific function add its keys */
2391 retval = kset->uevent_ops->uevent(&dev->kobj, env);
2395 /* copy keys to file */
2396 for (i = 0; i < env->envp_idx; i++)
2397 len += sysfs_emit_at(buf, len, "%s\n", env->envp[i]);
2403 static ssize_t uevent_store(struct device *dev, struct device_attribute *attr,
2404 const char *buf, size_t count)
2408 rc = kobject_synth_uevent(&dev->kobj, buf, count);
2411 dev_err(dev, "uevent: failed to send synthetic uevent\n");
2417 static DEVICE_ATTR_RW(uevent);
2419 static ssize_t online_show(struct device *dev, struct device_attribute *attr,
2425 val = !dev->offline;
2427 return sysfs_emit(buf, "%u\n", val);
2430 static ssize_t online_store(struct device *dev, struct device_attribute *attr,
2431 const char *buf, size_t count)
2436 ret = strtobool(buf, &val);
2440 ret = lock_device_hotplug_sysfs();
2444 ret = val ? device_online(dev) : device_offline(dev);
2445 unlock_device_hotplug();
2446 return ret < 0 ? ret : count;
2448 static DEVICE_ATTR_RW(online);
2450 static ssize_t removable_show(struct device *dev, struct device_attribute *attr,
2455 switch (dev->removable) {
2456 case DEVICE_REMOVABLE:
2465 return sysfs_emit(buf, "%s\n", loc);
2467 static DEVICE_ATTR_RO(removable);
2469 int device_add_groups(struct device *dev, const struct attribute_group **groups)
2471 return sysfs_create_groups(&dev->kobj, groups);
2473 EXPORT_SYMBOL_GPL(device_add_groups);
2475 void device_remove_groups(struct device *dev,
2476 const struct attribute_group **groups)
2478 sysfs_remove_groups(&dev->kobj, groups);
2480 EXPORT_SYMBOL_GPL(device_remove_groups);
2482 union device_attr_group_devres {
2483 const struct attribute_group *group;
2484 const struct attribute_group **groups;
2487 static int devm_attr_group_match(struct device *dev, void *res, void *data)
2489 return ((union device_attr_group_devres *)res)->group == data;
2492 static void devm_attr_group_remove(struct device *dev, void *res)
2494 union device_attr_group_devres *devres = res;
2495 const struct attribute_group *group = devres->group;
2497 dev_dbg(dev, "%s: removing group %p\n", __func__, group);
2498 sysfs_remove_group(&dev->kobj, group);
2501 static void devm_attr_groups_remove(struct device *dev, void *res)
2503 union device_attr_group_devres *devres = res;
2504 const struct attribute_group **groups = devres->groups;
2506 dev_dbg(dev, "%s: removing groups %p\n", __func__, groups);
2507 sysfs_remove_groups(&dev->kobj, groups);
2511 * devm_device_add_group - given a device, create a managed attribute group
2512 * @dev: The device to create the group for
2513 * @grp: The attribute group to create
2515 * This function creates a group for the first time. It will explicitly
2516 * warn and error if any of the attribute files being created already exist.
2518 * Returns 0 on success or error code on failure.
2520 int devm_device_add_group(struct device *dev, const struct attribute_group *grp)
2522 union device_attr_group_devres *devres;
2525 devres = devres_alloc(devm_attr_group_remove,
2526 sizeof(*devres), GFP_KERNEL);
2530 error = sysfs_create_group(&dev->kobj, grp);
2532 devres_free(devres);
2536 devres->group = grp;
2537 devres_add(dev, devres);
2540 EXPORT_SYMBOL_GPL(devm_device_add_group);
2543 * devm_device_remove_group: remove a managed group from a device
2544 * @dev: device to remove the group from
2545 * @grp: group to remove
2547 * This function removes a group of attributes from a device. The attributes
2548 * previously have to have been created for this group, otherwise it will fail.
2550 void devm_device_remove_group(struct device *dev,
2551 const struct attribute_group *grp)
2553 WARN_ON(devres_release(dev, devm_attr_group_remove,
2554 devm_attr_group_match,
2555 /* cast away const */ (void *)grp));
2557 EXPORT_SYMBOL_GPL(devm_device_remove_group);
2560 * devm_device_add_groups - create a bunch of managed attribute groups
2561 * @dev: The device to create the group for
2562 * @groups: The attribute groups to create, NULL terminated
2564 * This function creates a bunch of managed attribute groups. If an error
2565 * occurs when creating a group, all previously created groups will be
2566 * removed, unwinding everything back to the original state when this
2567 * function was called. It will explicitly warn and error if any of the
2568 * attribute files being created already exist.
2570 * Returns 0 on success or error code from sysfs_create_group on failure.
2572 int devm_device_add_groups(struct device *dev,
2573 const struct attribute_group **groups)
2575 union device_attr_group_devres *devres;
2578 devres = devres_alloc(devm_attr_groups_remove,
2579 sizeof(*devres), GFP_KERNEL);
2583 error = sysfs_create_groups(&dev->kobj, groups);
2585 devres_free(devres);
2589 devres->groups = groups;
2590 devres_add(dev, devres);
2593 EXPORT_SYMBOL_GPL(devm_device_add_groups);
2596 * devm_device_remove_groups - remove a list of managed groups
2598 * @dev: The device for the groups to be removed from
2599 * @groups: NULL terminated list of groups to be removed
2601 * If groups is not NULL, remove the specified groups from the device.
2603 void devm_device_remove_groups(struct device *dev,
2604 const struct attribute_group **groups)
2606 WARN_ON(devres_release(dev, devm_attr_groups_remove,
2607 devm_attr_group_match,
2608 /* cast away const */ (void *)groups));
2610 EXPORT_SYMBOL_GPL(devm_device_remove_groups);
2612 static int device_add_attrs(struct device *dev)
2614 struct class *class = dev->class;
2615 const struct device_type *type = dev->type;
2619 error = device_add_groups(dev, class->dev_groups);
2625 error = device_add_groups(dev, type->groups);
2627 goto err_remove_class_groups;
2630 error = device_add_groups(dev, dev->groups);
2632 goto err_remove_type_groups;
2634 if (device_supports_offline(dev) && !dev->offline_disabled) {
2635 error = device_create_file(dev, &dev_attr_online);
2637 goto err_remove_dev_groups;
2640 if (fw_devlink_flags && !fw_devlink_is_permissive() && dev->fwnode) {
2641 error = device_create_file(dev, &dev_attr_waiting_for_supplier);
2643 goto err_remove_dev_online;
2646 if (dev_removable_is_valid(dev)) {
2647 error = device_create_file(dev, &dev_attr_removable);
2649 goto err_remove_dev_waiting_for_supplier;
2654 err_remove_dev_waiting_for_supplier:
2655 device_remove_file(dev, &dev_attr_waiting_for_supplier);
2656 err_remove_dev_online:
2657 device_remove_file(dev, &dev_attr_online);
2658 err_remove_dev_groups:
2659 device_remove_groups(dev, dev->groups);
2660 err_remove_type_groups:
2662 device_remove_groups(dev, type->groups);
2663 err_remove_class_groups:
2665 device_remove_groups(dev, class->dev_groups);
2670 static void device_remove_attrs(struct device *dev)
2672 struct class *class = dev->class;
2673 const struct device_type *type = dev->type;
2675 device_remove_file(dev, &dev_attr_removable);
2676 device_remove_file(dev, &dev_attr_waiting_for_supplier);
2677 device_remove_file(dev, &dev_attr_online);
2678 device_remove_groups(dev, dev->groups);
2681 device_remove_groups(dev, type->groups);
2684 device_remove_groups(dev, class->dev_groups);
2687 static ssize_t dev_show(struct device *dev, struct device_attribute *attr,
2690 return print_dev_t(buf, dev->devt);
2692 static DEVICE_ATTR_RO(dev);
2695 struct kset *devices_kset;
2698 * devices_kset_move_before - Move device in the devices_kset's list.
2699 * @deva: Device to move.
2700 * @devb: Device @deva should come before.
2702 static void devices_kset_move_before(struct device *deva, struct device *devb)
2706 pr_debug("devices_kset: Moving %s before %s\n",
2707 dev_name(deva), dev_name(devb));
2708 spin_lock(&devices_kset->list_lock);
2709 list_move_tail(&deva->kobj.entry, &devb->kobj.entry);
2710 spin_unlock(&devices_kset->list_lock);
2714 * devices_kset_move_after - Move device in the devices_kset's list.
2715 * @deva: Device to move
2716 * @devb: Device @deva should come after.
2718 static void devices_kset_move_after(struct device *deva, struct device *devb)
2722 pr_debug("devices_kset: Moving %s after %s\n",
2723 dev_name(deva), dev_name(devb));
2724 spin_lock(&devices_kset->list_lock);
2725 list_move(&deva->kobj.entry, &devb->kobj.entry);
2726 spin_unlock(&devices_kset->list_lock);
2730 * devices_kset_move_last - move the device to the end of devices_kset's list.
2731 * @dev: device to move
2733 void devices_kset_move_last(struct device *dev)
2737 pr_debug("devices_kset: Moving %s to end of list\n", dev_name(dev));
2738 spin_lock(&devices_kset->list_lock);
2739 list_move_tail(&dev->kobj.entry, &devices_kset->list);
2740 spin_unlock(&devices_kset->list_lock);
2744 * device_create_file - create sysfs attribute file for device.
2746 * @attr: device attribute descriptor.
2748 int device_create_file(struct device *dev,
2749 const struct device_attribute *attr)
2754 WARN(((attr->attr.mode & S_IWUGO) && !attr->store),
2755 "Attribute %s: write permission without 'store'\n",
2757 WARN(((attr->attr.mode & S_IRUGO) && !attr->show),
2758 "Attribute %s: read permission without 'show'\n",
2760 error = sysfs_create_file(&dev->kobj, &attr->attr);
2765 EXPORT_SYMBOL_GPL(device_create_file);
2768 * device_remove_file - remove sysfs attribute file.
2770 * @attr: device attribute descriptor.
2772 void device_remove_file(struct device *dev,
2773 const struct device_attribute *attr)
2776 sysfs_remove_file(&dev->kobj, &attr->attr);
2778 EXPORT_SYMBOL_GPL(device_remove_file);
2781 * device_remove_file_self - remove sysfs attribute file from its own method.
2783 * @attr: device attribute descriptor.
2785 * See kernfs_remove_self() for details.
2787 bool device_remove_file_self(struct device *dev,
2788 const struct device_attribute *attr)
2791 return sysfs_remove_file_self(&dev->kobj, &attr->attr);
2795 EXPORT_SYMBOL_GPL(device_remove_file_self);
2798 * device_create_bin_file - create sysfs binary attribute file for device.
2800 * @attr: device binary attribute descriptor.
2802 int device_create_bin_file(struct device *dev,
2803 const struct bin_attribute *attr)
2805 int error = -EINVAL;
2807 error = sysfs_create_bin_file(&dev->kobj, attr);
2810 EXPORT_SYMBOL_GPL(device_create_bin_file);
2813 * device_remove_bin_file - remove sysfs binary attribute file
2815 * @attr: device binary attribute descriptor.
2817 void device_remove_bin_file(struct device *dev,
2818 const struct bin_attribute *attr)
2821 sysfs_remove_bin_file(&dev->kobj, attr);
2823 EXPORT_SYMBOL_GPL(device_remove_bin_file);
2825 static void klist_children_get(struct klist_node *n)
2827 struct device_private *p = to_device_private_parent(n);
2828 struct device *dev = p->device;
2833 static void klist_children_put(struct klist_node *n)
2835 struct device_private *p = to_device_private_parent(n);
2836 struct device *dev = p->device;
2842 * device_initialize - init device structure.
2845 * This prepares the device for use by other layers by initializing
2847 * It is the first half of device_register(), if called by
2848 * that function, though it can also be called separately, so one
2849 * may use @dev's fields. In particular, get_device()/put_device()
2850 * may be used for reference counting of @dev after calling this
2853 * All fields in @dev must be initialized by the caller to 0, except
2854 * for those explicitly set to some other value. The simplest
2855 * approach is to use kzalloc() to allocate the structure containing
2858 * NOTE: Use put_device() to give up your reference instead of freeing
2859 * @dev directly once you have called this function.
2861 void device_initialize(struct device *dev)
2863 dev->kobj.kset = devices_kset;
2864 kobject_init(&dev->kobj, &device_ktype);
2865 INIT_LIST_HEAD(&dev->dma_pools);
2866 mutex_init(&dev->mutex);
2867 #ifdef CONFIG_PROVE_LOCKING
2868 mutex_init(&dev->lockdep_mutex);
2870 lockdep_set_novalidate_class(&dev->mutex);
2871 spin_lock_init(&dev->devres_lock);
2872 INIT_LIST_HEAD(&dev->devres_head);
2873 device_pm_init(dev);
2874 set_dev_node(dev, NUMA_NO_NODE);
2875 INIT_LIST_HEAD(&dev->links.consumers);
2876 INIT_LIST_HEAD(&dev->links.suppliers);
2877 INIT_LIST_HEAD(&dev->links.defer_sync);
2878 dev->links.status = DL_DEV_NO_DRIVER;
2879 #if defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_DEVICE) || \
2880 defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU) || \
2881 defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU_ALL)
2882 dev->dma_coherent = dma_default_coherent;
2884 #ifdef CONFIG_SWIOTLB
2885 dev->dma_io_tlb_mem = &io_tlb_default_mem;
2888 EXPORT_SYMBOL_GPL(device_initialize);
2890 struct kobject *virtual_device_parent(struct device *dev)
2892 static struct kobject *virtual_dir = NULL;
2895 virtual_dir = kobject_create_and_add("virtual",
2896 &devices_kset->kobj);
2902 struct kobject kobj;
2903 struct class *class;
2906 #define to_class_dir(obj) container_of(obj, struct class_dir, kobj)
2908 static void class_dir_release(struct kobject *kobj)
2910 struct class_dir *dir = to_class_dir(kobj);
2915 struct kobj_ns_type_operations *class_dir_child_ns_type(struct kobject *kobj)
2917 struct class_dir *dir = to_class_dir(kobj);
2918 return dir->class->ns_type;
2921 static struct kobj_type class_dir_ktype = {
2922 .release = class_dir_release,
2923 .sysfs_ops = &kobj_sysfs_ops,
2924 .child_ns_type = class_dir_child_ns_type
2927 static struct kobject *
2928 class_dir_create_and_add(struct class *class, struct kobject *parent_kobj)
2930 struct class_dir *dir;
2933 dir = kzalloc(sizeof(*dir), GFP_KERNEL);
2935 return ERR_PTR(-ENOMEM);
2938 kobject_init(&dir->kobj, &class_dir_ktype);
2940 dir->kobj.kset = &class->p->glue_dirs;
2942 retval = kobject_add(&dir->kobj, parent_kobj, "%s", class->name);
2944 kobject_put(&dir->kobj);
2945 return ERR_PTR(retval);
2950 static DEFINE_MUTEX(gdp_mutex);
2952 static struct kobject *get_device_parent(struct device *dev,
2953 struct device *parent)
2956 struct kobject *kobj = NULL;
2957 struct kobject *parent_kobj;
2961 /* block disks show up in /sys/block */
2962 if (sysfs_deprecated && dev->class == &block_class) {
2963 if (parent && parent->class == &block_class)
2964 return &parent->kobj;
2965 return &block_class.p->subsys.kobj;
2970 * If we have no parent, we live in "virtual".
2971 * Class-devices with a non class-device as parent, live
2972 * in a "glue" directory to prevent namespace collisions.
2975 parent_kobj = virtual_device_parent(dev);
2976 else if (parent->class && !dev->class->ns_type)
2977 return &parent->kobj;
2979 parent_kobj = &parent->kobj;
2981 mutex_lock(&gdp_mutex);
2983 /* find our class-directory at the parent and reference it */
2984 spin_lock(&dev->class->p->glue_dirs.list_lock);
2985 list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
2986 if (k->parent == parent_kobj) {
2987 kobj = kobject_get(k);
2990 spin_unlock(&dev->class->p->glue_dirs.list_lock);
2992 mutex_unlock(&gdp_mutex);
2996 /* or create a new class-directory at the parent device */
2997 k = class_dir_create_and_add(dev->class, parent_kobj);
2998 /* do not emit an uevent for this simple "glue" directory */
2999 mutex_unlock(&gdp_mutex);
3003 /* subsystems can specify a default root directory for their devices */
3004 if (!parent && dev->bus && dev->bus->dev_root)
3005 return &dev->bus->dev_root->kobj;
3008 return &parent->kobj;
3012 static inline bool live_in_glue_dir(struct kobject *kobj,
3015 if (!kobj || !dev->class ||
3016 kobj->kset != &dev->class->p->glue_dirs)
3021 static inline struct kobject *get_glue_dir(struct device *dev)
3023 return dev->kobj.parent;
3027 * kobject_has_children - Returns whether a kobject has children.
3028 * @kobj: the object to test
3030 * This will return whether a kobject has other kobjects as children.
3032 * It does NOT account for the presence of attribute files, only sub
3033 * directories. It also assumes there is no concurrent addition or
3034 * removal of such children, and thus relies on external locking.
3036 static inline bool kobject_has_children(struct kobject *kobj)
3038 WARN_ON_ONCE(kref_read(&kobj->kref) == 0);
3040 return kobj->sd && kobj->sd->dir.subdirs;
3044 * make sure cleaning up dir as the last step, we need to make
3045 * sure .release handler of kobject is run with holding the
3048 static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
3052 /* see if we live in a "glue" directory */
3053 if (!live_in_glue_dir(glue_dir, dev))
3056 mutex_lock(&gdp_mutex);
3058 * There is a race condition between removing glue directory
3059 * and adding a new device under the glue directory.
3064 * get_device_parent()
3065 * class_dir_create_and_add()
3066 * kobject_add_internal()
3067 * create_dir() // create glue_dir
3070 * get_device_parent()
3071 * kobject_get() // get glue_dir
3074 * cleanup_glue_dir()
3075 * kobject_del(glue_dir)
3078 * kobject_add_internal()
3079 * create_dir() // in glue_dir
3080 * sysfs_create_dir_ns()
3081 * kernfs_create_dir_ns(sd)
3083 * sysfs_remove_dir() // glue_dir->sd=NULL
3084 * sysfs_put() // free glue_dir->sd
3087 * kernfs_new_node(sd)
3088 * kernfs_get(glue_dir)
3092 * Before CPU1 remove last child device under glue dir, if CPU2 add
3093 * a new device under glue dir, the glue_dir kobject reference count
3094 * will be increase to 2 in kobject_get(k). And CPU2 has been called
3095 * kernfs_create_dir_ns(). Meanwhile, CPU1 call sysfs_remove_dir()
3096 * and sysfs_put(). This result in glue_dir->sd is freed.
3098 * Then the CPU2 will see a stale "empty" but still potentially used
3099 * glue dir around in kernfs_new_node().
3101 * In order to avoid this happening, we also should make sure that
3102 * kernfs_node for glue_dir is released in CPU1 only when refcount
3103 * for glue_dir kobj is 1.
3105 ref = kref_read(&glue_dir->kref);
3106 if (!kobject_has_children(glue_dir) && !--ref)
3107 kobject_del(glue_dir);
3108 kobject_put(glue_dir);
3109 mutex_unlock(&gdp_mutex);
3112 static int device_add_class_symlinks(struct device *dev)
3114 struct device_node *of_node = dev_of_node(dev);
3118 error = sysfs_create_link(&dev->kobj, of_node_kobj(of_node), "of_node");
3120 dev_warn(dev, "Error %d creating of_node link\n",error);
3121 /* An error here doesn't warrant bringing down the device */
3127 error = sysfs_create_link(&dev->kobj,
3128 &dev->class->p->subsys.kobj,
3133 if (dev->parent && device_is_not_partition(dev)) {
3134 error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
3141 /* /sys/block has directories and does not need symlinks */
3142 if (sysfs_deprecated && dev->class == &block_class)
3146 /* link in the class directory pointing to the device */
3147 error = sysfs_create_link(&dev->class->p->subsys.kobj,
3148 &dev->kobj, dev_name(dev));
3155 sysfs_remove_link(&dev->kobj, "device");
3158 sysfs_remove_link(&dev->kobj, "subsystem");
3160 sysfs_remove_link(&dev->kobj, "of_node");
3164 static void device_remove_class_symlinks(struct device *dev)
3166 if (dev_of_node(dev))
3167 sysfs_remove_link(&dev->kobj, "of_node");
3172 if (dev->parent && device_is_not_partition(dev))
3173 sysfs_remove_link(&dev->kobj, "device");
3174 sysfs_remove_link(&dev->kobj, "subsystem");
3176 if (sysfs_deprecated && dev->class == &block_class)
3179 sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
3183 * dev_set_name - set a device name
3185 * @fmt: format string for the device's name
3187 int dev_set_name(struct device *dev, const char *fmt, ...)
3192 va_start(vargs, fmt);
3193 err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
3197 EXPORT_SYMBOL_GPL(dev_set_name);
3200 * device_to_dev_kobj - select a /sys/dev/ directory for the device
3203 * By default we select char/ for new entries. Setting class->dev_obj
3204 * to NULL prevents an entry from being created. class->dev_kobj must
3205 * be set (or cleared) before any devices are registered to the class
3206 * otherwise device_create_sys_dev_entry() and
3207 * device_remove_sys_dev_entry() will disagree about the presence of
3210 static struct kobject *device_to_dev_kobj(struct device *dev)
3212 struct kobject *kobj;
3215 kobj = dev->class->dev_kobj;
3217 kobj = sysfs_dev_char_kobj;
3222 static int device_create_sys_dev_entry(struct device *dev)
3224 struct kobject *kobj = device_to_dev_kobj(dev);
3229 format_dev_t(devt_str, dev->devt);
3230 error = sysfs_create_link(kobj, &dev->kobj, devt_str);
3236 static void device_remove_sys_dev_entry(struct device *dev)
3238 struct kobject *kobj = device_to_dev_kobj(dev);
3242 format_dev_t(devt_str, dev->devt);
3243 sysfs_remove_link(kobj, devt_str);
3247 static int device_private_init(struct device *dev)
3249 dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
3252 dev->p->device = dev;
3253 klist_init(&dev->p->klist_children, klist_children_get,
3254 klist_children_put);
3255 INIT_LIST_HEAD(&dev->p->deferred_probe);
3260 * device_add - add device to device hierarchy.
3263 * This is part 2 of device_register(), though may be called
3264 * separately _iff_ device_initialize() has been called separately.
3266 * This adds @dev to the kobject hierarchy via kobject_add(), adds it
3267 * to the global and sibling lists for the device, then
3268 * adds it to the other relevant subsystems of the driver model.
3270 * Do not call this routine or device_register() more than once for
3271 * any device structure. The driver model core is not designed to work
3272 * with devices that get unregistered and then spring back to life.
3273 * (Among other things, it's very hard to guarantee that all references
3274 * to the previous incarnation of @dev have been dropped.) Allocate
3275 * and register a fresh new struct device instead.
3277 * NOTE: _Never_ directly free @dev after calling this function, even
3278 * if it returned an error! Always use put_device() to give up your
3279 * reference instead.
3281 * Rule of thumb is: if device_add() succeeds, you should call
3282 * device_del() when you want to get rid of it. If device_add() has
3283 * *not* succeeded, use *only* put_device() to drop the reference
3286 int device_add(struct device *dev)
3288 struct device *parent;
3289 struct kobject *kobj;
3290 struct class_interface *class_intf;
3291 int error = -EINVAL;
3292 struct kobject *glue_dir = NULL;
3294 dev = get_device(dev);
3299 error = device_private_init(dev);
3305 * for statically allocated devices, which should all be converted
3306 * some day, we need to initialize the name. We prevent reading back
3307 * the name, and force the use of dev_name()
3309 if (dev->init_name) {
3310 dev_set_name(dev, "%s", dev->init_name);
3311 dev->init_name = NULL;
3314 /* subsystems can specify simple device enumeration */
3315 if (!dev_name(dev) && dev->bus && dev->bus->dev_name)
3316 dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id);
3318 if (!dev_name(dev)) {
3323 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
3325 parent = get_device(dev->parent);
3326 kobj = get_device_parent(dev, parent);
3328 error = PTR_ERR(kobj);
3332 dev->kobj.parent = kobj;
3334 /* use parent numa_node */
3335 if (parent && (dev_to_node(dev) == NUMA_NO_NODE))
3336 set_dev_node(dev, dev_to_node(parent));
3338 /* first, register with generic layer. */
3339 /* we require the name to be set before, and pass NULL */
3340 error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
3342 glue_dir = get_glue_dir(dev);
3346 /* notify platform of device entry */
3347 device_platform_notify(dev);
3349 error = device_create_file(dev, &dev_attr_uevent);
3353 error = device_add_class_symlinks(dev);
3356 error = device_add_attrs(dev);
3359 error = bus_add_device(dev);
3362 error = dpm_sysfs_add(dev);
3367 if (MAJOR(dev->devt)) {
3368 error = device_create_file(dev, &dev_attr_dev);
3372 error = device_create_sys_dev_entry(dev);
3376 devtmpfs_create_node(dev);
3379 /* Notify clients of device addition. This call must come
3380 * after dpm_sysfs_add() and before kobject_uevent().
3383 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
3384 BUS_NOTIFY_ADD_DEVICE, dev);
3386 kobject_uevent(&dev->kobj, KOBJ_ADD);
3389 * Check if any of the other devices (consumers) have been waiting for
3390 * this device (supplier) to be added so that they can create a device
3393 * This needs to happen after device_pm_add() because device_link_add()
3394 * requires the supplier be registered before it's called.
3396 * But this also needs to happen before bus_probe_device() to make sure
3397 * waiting consumers can link to it before the driver is bound to the
3398 * device and the driver sync_state callback is called for this device.
3400 if (dev->fwnode && !dev->fwnode->dev) {
3401 dev->fwnode->dev = dev;
3402 fw_devlink_link_device(dev);
3405 bus_probe_device(dev);
3408 * If all driver registration is done and a newly added device doesn't
3409 * match with any driver, don't block its consumers from probing in
3410 * case the consumer device is able to operate without this supplier.
3412 if (dev->fwnode && fw_devlink_drv_reg_done && !dev->can_match)
3413 fw_devlink_unblock_consumers(dev);
3416 klist_add_tail(&dev->p->knode_parent,
3417 &parent->p->klist_children);
3420 mutex_lock(&dev->class->p->mutex);
3421 /* tie the class to the device */
3422 klist_add_tail(&dev->p->knode_class,
3423 &dev->class->p->klist_devices);
3425 /* notify any interfaces that the device is here */
3426 list_for_each_entry(class_intf,
3427 &dev->class->p->interfaces, node)
3428 if (class_intf->add_dev)
3429 class_intf->add_dev(dev, class_intf);
3430 mutex_unlock(&dev->class->p->mutex);
3436 if (MAJOR(dev->devt))
3437 device_remove_file(dev, &dev_attr_dev);
3439 device_pm_remove(dev);
3440 dpm_sysfs_remove(dev);
3442 bus_remove_device(dev);
3444 device_remove_attrs(dev);
3446 device_remove_class_symlinks(dev);
3448 device_remove_file(dev, &dev_attr_uevent);
3450 device_platform_notify_remove(dev);
3451 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
3452 glue_dir = get_glue_dir(dev);
3453 kobject_del(&dev->kobj);
3455 cleanup_glue_dir(dev, glue_dir);
3463 EXPORT_SYMBOL_GPL(device_add);
3466 * device_register - register a device with the system.
3467 * @dev: pointer to the device structure
3469 * This happens in two clean steps - initialize the device
3470 * and add it to the system. The two steps can be called
3471 * separately, but this is the easiest and most common.
3472 * I.e. you should only call the two helpers separately if
3473 * have a clearly defined need to use and refcount the device
3474 * before it is added to the hierarchy.
3476 * For more information, see the kerneldoc for device_initialize()
3479 * NOTE: _Never_ directly free @dev after calling this function, even
3480 * if it returned an error! Always use put_device() to give up the
3481 * reference initialized in this function instead.
3483 int device_register(struct device *dev)
3485 device_initialize(dev);
3486 return device_add(dev);
3488 EXPORT_SYMBOL_GPL(device_register);
3491 * get_device - increment reference count for device.
3494 * This simply forwards the call to kobject_get(), though
3495 * we do take care to provide for the case that we get a NULL
3496 * pointer passed in.
3498 struct device *get_device(struct device *dev)
3500 return dev ? kobj_to_dev(kobject_get(&dev->kobj)) : NULL;
3502 EXPORT_SYMBOL_GPL(get_device);
3505 * put_device - decrement reference count.
3506 * @dev: device in question.
3508 void put_device(struct device *dev)
3510 /* might_sleep(); */
3512 kobject_put(&dev->kobj);
3514 EXPORT_SYMBOL_GPL(put_device);
3516 bool kill_device(struct device *dev)
3519 * Require the device lock and set the "dead" flag to guarantee that
3520 * the update behavior is consistent with the other bitfields near
3521 * it and that we cannot have an asynchronous probe routine trying
3522 * to run while we are tearing out the bus/class/sysfs from
3523 * underneath the device.
3525 device_lock_assert(dev);
3529 dev->p->dead = true;
3532 EXPORT_SYMBOL_GPL(kill_device);
3535 * device_del - delete device from system.
3538 * This is the first part of the device unregistration
3539 * sequence. This removes the device from the lists we control
3540 * from here, has it removed from the other driver model
3541 * subsystems it was added to in device_add(), and removes it
3542 * from the kobject hierarchy.
3544 * NOTE: this should be called manually _iff_ device_add() was
3545 * also called manually.
3547 void device_del(struct device *dev)
3549 struct device *parent = dev->parent;
3550 struct kobject *glue_dir = NULL;
3551 struct class_interface *class_intf;
3552 unsigned int noio_flag;
3558 if (dev->fwnode && dev->fwnode->dev == dev)
3559 dev->fwnode->dev = NULL;
3561 /* Notify clients of device removal. This call must come
3562 * before dpm_sysfs_remove().
3564 noio_flag = memalloc_noio_save();
3566 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
3567 BUS_NOTIFY_DEL_DEVICE, dev);
3569 dpm_sysfs_remove(dev);
3571 klist_del(&dev->p->knode_parent);
3572 if (MAJOR(dev->devt)) {
3573 devtmpfs_delete_node(dev);
3574 device_remove_sys_dev_entry(dev);
3575 device_remove_file(dev, &dev_attr_dev);
3578 device_remove_class_symlinks(dev);
3580 mutex_lock(&dev->class->p->mutex);
3581 /* notify any interfaces that the device is now gone */
3582 list_for_each_entry(class_intf,
3583 &dev->class->p->interfaces, node)
3584 if (class_intf->remove_dev)
3585 class_intf->remove_dev(dev, class_intf);
3586 /* remove the device from the class list */
3587 klist_del(&dev->p->knode_class);
3588 mutex_unlock(&dev->class->p->mutex);
3590 device_remove_file(dev, &dev_attr_uevent);
3591 device_remove_attrs(dev);
3592 bus_remove_device(dev);
3593 device_pm_remove(dev);
3594 driver_deferred_probe_del(dev);
3595 device_platform_notify_remove(dev);
3596 device_links_purge(dev);
3599 blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
3600 BUS_NOTIFY_REMOVED_DEVICE, dev);
3601 kobject_uevent(&dev->kobj, KOBJ_REMOVE);
3602 glue_dir = get_glue_dir(dev);
3603 kobject_del(&dev->kobj);
3604 cleanup_glue_dir(dev, glue_dir);
3605 memalloc_noio_restore(noio_flag);
3608 EXPORT_SYMBOL_GPL(device_del);
3611 * device_unregister - unregister device from system.
3612 * @dev: device going away.
3614 * We do this in two parts, like we do device_register(). First,
3615 * we remove it from all the subsystems with device_del(), then
3616 * we decrement the reference count via put_device(). If that
3617 * is the final reference count, the device will be cleaned up
3618 * via device_release() above. Otherwise, the structure will
3619 * stick around until the final reference to the device is dropped.
3621 void device_unregister(struct device *dev)
3623 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
3627 EXPORT_SYMBOL_GPL(device_unregister);
3629 static struct device *prev_device(struct klist_iter *i)
3631 struct klist_node *n = klist_prev(i);
3632 struct device *dev = NULL;
3633 struct device_private *p;
3636 p = to_device_private_parent(n);
3642 static struct device *next_device(struct klist_iter *i)
3644 struct klist_node *n = klist_next(i);
3645 struct device *dev = NULL;
3646 struct device_private *p;
3649 p = to_device_private_parent(n);
3656 * device_get_devnode - path of device node file
3658 * @mode: returned file access mode
3659 * @uid: returned file owner
3660 * @gid: returned file group
3661 * @tmp: possibly allocated string
3663 * Return the relative path of a possible device node.
3664 * Non-default names may need to allocate a memory to compose
3665 * a name. This memory is returned in tmp and needs to be
3666 * freed by the caller.
3668 const char *device_get_devnode(struct device *dev,
3669 umode_t *mode, kuid_t *uid, kgid_t *gid,
3676 /* the device type may provide a specific name */
3677 if (dev->type && dev->type->devnode)
3678 *tmp = dev->type->devnode(dev, mode, uid, gid);
3682 /* the class may provide a specific name */
3683 if (dev->class && dev->class->devnode)
3684 *tmp = dev->class->devnode(dev, mode);
3688 /* return name without allocation, tmp == NULL */
3689 if (strchr(dev_name(dev), '!') == NULL)
3690 return dev_name(dev);
3692 /* replace '!' in the name with '/' */
3693 s = kstrdup(dev_name(dev), GFP_KERNEL);
3696 strreplace(s, '!', '/');
3701 * device_for_each_child - device child iterator.
3702 * @parent: parent struct device.
3703 * @fn: function to be called for each device.
3704 * @data: data for the callback.
3706 * Iterate over @parent's child devices, and call @fn for each,
3709 * We check the return of @fn each time. If it returns anything
3710 * other than 0, we break out and return that value.
3712 int device_for_each_child(struct device *parent, void *data,
3713 int (*fn)(struct device *dev, void *data))
3715 struct klist_iter i;
3716 struct device *child;
3722 klist_iter_init(&parent->p->klist_children, &i);
3723 while (!error && (child = next_device(&i)))
3724 error = fn(child, data);
3725 klist_iter_exit(&i);
3728 EXPORT_SYMBOL_GPL(device_for_each_child);
3731 * device_for_each_child_reverse - device child iterator in reversed order.
3732 * @parent: parent struct device.
3733 * @fn: function to be called for each device.
3734 * @data: data for the callback.
3736 * Iterate over @parent's child devices, and call @fn for each,
3739 * We check the return of @fn each time. If it returns anything
3740 * other than 0, we break out and return that value.
3742 int device_for_each_child_reverse(struct device *parent, void *data,
3743 int (*fn)(struct device *dev, void *data))
3745 struct klist_iter i;
3746 struct device *child;
3752 klist_iter_init(&parent->p->klist_children, &i);
3753 while ((child = prev_device(&i)) && !error)
3754 error = fn(child, data);
3755 klist_iter_exit(&i);
3758 EXPORT_SYMBOL_GPL(device_for_each_child_reverse);
3761 * device_find_child - device iterator for locating a particular device.
3762 * @parent: parent struct device
3763 * @match: Callback function to check device
3764 * @data: Data to pass to match function
3766 * This is similar to the device_for_each_child() function above, but it
3767 * returns a reference to a device that is 'found' for later use, as
3768 * determined by the @match callback.
3770 * The callback should return 0 if the device doesn't match and non-zero
3771 * if it does. If the callback returns non-zero and a reference to the
3772 * current device can be obtained, this function will return to the caller
3773 * and not iterate over any more devices.
3775 * NOTE: you will need to drop the reference with put_device() after use.
3777 struct device *device_find_child(struct device *parent, void *data,
3778 int (*match)(struct device *dev, void *data))
3780 struct klist_iter i;
3781 struct device *child;
3786 klist_iter_init(&parent->p->klist_children, &i);
3787 while ((child = next_device(&i)))
3788 if (match(child, data) && get_device(child))
3790 klist_iter_exit(&i);
3793 EXPORT_SYMBOL_GPL(device_find_child);
3796 * device_find_child_by_name - device iterator for locating a child device.
3797 * @parent: parent struct device
3798 * @name: name of the child device
3800 * This is similar to the device_find_child() function above, but it
3801 * returns a reference to a device that has the name @name.
3803 * NOTE: you will need to drop the reference with put_device() after use.
3805 struct device *device_find_child_by_name(struct device *parent,
3808 struct klist_iter i;
3809 struct device *child;
3814 klist_iter_init(&parent->p->klist_children, &i);
3815 while ((child = next_device(&i)))
3816 if (sysfs_streq(dev_name(child), name) && get_device(child))
3818 klist_iter_exit(&i);
3821 EXPORT_SYMBOL_GPL(device_find_child_by_name);
3823 int __init devices_init(void)
3825 devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
3828 dev_kobj = kobject_create_and_add("dev", NULL);
3831 sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
3832 if (!sysfs_dev_block_kobj)
3833 goto block_kobj_err;
3834 sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
3835 if (!sysfs_dev_char_kobj)
3841 kobject_put(sysfs_dev_block_kobj);
3843 kobject_put(dev_kobj);
3845 kset_unregister(devices_kset);
3849 static int device_check_offline(struct device *dev, void *not_used)
3853 ret = device_for_each_child(dev, NULL, device_check_offline);
3857 return device_supports_offline(dev) && !dev->offline ? -EBUSY : 0;
3861 * device_offline - Prepare the device for hot-removal.
3862 * @dev: Device to be put offline.
3864 * Execute the device bus type's .offline() callback, if present, to prepare
3865 * the device for a subsequent hot-removal. If that succeeds, the device must
3866 * not be used until either it is removed or its bus type's .online() callback
3869 * Call under device_hotplug_lock.
3871 int device_offline(struct device *dev)
3875 if (dev->offline_disabled)
3878 ret = device_for_each_child(dev, NULL, device_check_offline);
3883 if (device_supports_offline(dev)) {
3887 ret = dev->bus->offline(dev);
3889 kobject_uevent(&dev->kobj, KOBJ_OFFLINE);
3890 dev->offline = true;
3900 * device_online - Put the device back online after successful device_offline().
3901 * @dev: Device to be put back online.
3903 * If device_offline() has been successfully executed for @dev, but the device
3904 * has not been removed subsequently, execute its bus type's .online() callback
3905 * to indicate that the device can be used again.
3907 * Call under device_hotplug_lock.
3909 int device_online(struct device *dev)
3914 if (device_supports_offline(dev)) {
3916 ret = dev->bus->online(dev);
3918 kobject_uevent(&dev->kobj, KOBJ_ONLINE);
3919 dev->offline = false;
3930 struct root_device {
3932 struct module *owner;
3935 static inline struct root_device *to_root_device(struct device *d)
3937 return container_of(d, struct root_device, dev);
3940 static void root_device_release(struct device *dev)
3942 kfree(to_root_device(dev));
3946 * __root_device_register - allocate and register a root device
3947 * @name: root device name
3948 * @owner: owner module of the root device, usually THIS_MODULE
3950 * This function allocates a root device and registers it
3951 * using device_register(). In order to free the returned
3952 * device, use root_device_unregister().
3954 * Root devices are dummy devices which allow other devices
3955 * to be grouped under /sys/devices. Use this function to
3956 * allocate a root device and then use it as the parent of
3957 * any device which should appear under /sys/devices/{name}
3959 * The /sys/devices/{name} directory will also contain a
3960 * 'module' symlink which points to the @owner directory
3963 * Returns &struct device pointer on success, or ERR_PTR() on error.
3965 * Note: You probably want to use root_device_register().
3967 struct device *__root_device_register(const char *name, struct module *owner)
3969 struct root_device *root;
3972 root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
3974 return ERR_PTR(err);
3976 err = dev_set_name(&root->dev, "%s", name);
3979 return ERR_PTR(err);
3982 root->dev.release = root_device_release;
3984 err = device_register(&root->dev);
3986 put_device(&root->dev);
3987 return ERR_PTR(err);
3990 #ifdef CONFIG_MODULES /* gotta find a "cleaner" way to do this */
3992 struct module_kobject *mk = &owner->mkobj;
3994 err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
3996 device_unregister(&root->dev);
3997 return ERR_PTR(err);
3999 root->owner = owner;
4005 EXPORT_SYMBOL_GPL(__root_device_register);
4008 * root_device_unregister - unregister and free a root device
4009 * @dev: device going away
4011 * This function unregisters and cleans up a device that was created by
4012 * root_device_register().
4014 void root_device_unregister(struct device *dev)
4016 struct root_device *root = to_root_device(dev);
4019 sysfs_remove_link(&root->dev.kobj, "module");
4021 device_unregister(dev);
4023 EXPORT_SYMBOL_GPL(root_device_unregister);
4026 static void device_create_release(struct device *dev)
4028 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
4032 static __printf(6, 0) struct device *
4033 device_create_groups_vargs(struct class *class, struct device *parent,
4034 dev_t devt, void *drvdata,
4035 const struct attribute_group **groups,
4036 const char *fmt, va_list args)
4038 struct device *dev = NULL;
4039 int retval = -ENODEV;
4041 if (class == NULL || IS_ERR(class))
4044 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
4050 device_initialize(dev);
4053 dev->parent = parent;
4054 dev->groups = groups;
4055 dev->release = device_create_release;
4056 dev_set_drvdata(dev, drvdata);
4058 retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
4062 retval = device_add(dev);
4070 return ERR_PTR(retval);
4074 * device_create - creates a device and registers it with sysfs
4075 * @class: pointer to the struct class that this device should be registered to
4076 * @parent: pointer to the parent struct device of this new device, if any
4077 * @devt: the dev_t for the char device to be added
4078 * @drvdata: the data to be added to the device for callbacks
4079 * @fmt: string for the device's name
4081 * This function can be used by char device classes. A struct device
4082 * will be created in sysfs, registered to the specified class.
4084 * A "dev" file will be created, showing the dev_t for the device, if
4085 * the dev_t is not 0,0.
4086 * If a pointer to a parent struct device is passed in, the newly created
4087 * struct device will be a child of that device in sysfs.
4088 * The pointer to the struct device will be returned from the call.
4089 * Any further sysfs files that might be required can be created using this
4092 * Returns &struct device pointer on success, or ERR_PTR() on error.
4094 * Note: the struct class passed to this function must have previously
4095 * been created with a call to class_create().
4097 struct device *device_create(struct class *class, struct device *parent,
4098 dev_t devt, void *drvdata, const char *fmt, ...)
4103 va_start(vargs, fmt);
4104 dev = device_create_groups_vargs(class, parent, devt, drvdata, NULL,
4109 EXPORT_SYMBOL_GPL(device_create);
4112 * device_create_with_groups - creates a device and registers it with sysfs
4113 * @class: pointer to the struct class that this device should be registered to
4114 * @parent: pointer to the parent struct device of this new device, if any
4115 * @devt: the dev_t for the char device to be added
4116 * @drvdata: the data to be added to the device for callbacks
4117 * @groups: NULL-terminated list of attribute groups to be created
4118 * @fmt: string for the device's name
4120 * This function can be used by char device classes. A struct device
4121 * will be created in sysfs, registered to the specified class.
4122 * Additional attributes specified in the groups parameter will also
4123 * be created automatically.
4125 * A "dev" file will be created, showing the dev_t for the device, if
4126 * the dev_t is not 0,0.
4127 * If a pointer to a parent struct device is passed in, the newly created
4128 * struct device will be a child of that device in sysfs.
4129 * The pointer to the struct device will be returned from the call.
4130 * Any further sysfs files that might be required can be created using this
4133 * Returns &struct device pointer on success, or ERR_PTR() on error.
4135 * Note: the struct class passed to this function must have previously
4136 * been created with a call to class_create().
4138 struct device *device_create_with_groups(struct class *class,
4139 struct device *parent, dev_t devt,
4141 const struct attribute_group **groups,
4142 const char *fmt, ...)
4147 va_start(vargs, fmt);
4148 dev = device_create_groups_vargs(class, parent, devt, drvdata, groups,
4153 EXPORT_SYMBOL_GPL(device_create_with_groups);
4156 * device_destroy - removes a device that was created with device_create()
4157 * @class: pointer to the struct class that this device was registered with
4158 * @devt: the dev_t of the device that was previously registered
4160 * This call unregisters and cleans up a device that was created with a
4161 * call to device_create().
4163 void device_destroy(struct class *class, dev_t devt)
4167 dev = class_find_device_by_devt(class, devt);
4170 device_unregister(dev);
4173 EXPORT_SYMBOL_GPL(device_destroy);
4176 * device_rename - renames a device
4177 * @dev: the pointer to the struct device to be renamed
4178 * @new_name: the new name of the device
4180 * It is the responsibility of the caller to provide mutual
4181 * exclusion between two different calls of device_rename
4182 * on the same device to ensure that new_name is valid and
4183 * won't conflict with other devices.
4185 * Note: Don't call this function. Currently, the networking layer calls this
4186 * function, but that will change. The following text from Kay Sievers offers
4189 * Renaming devices is racy at many levels, symlinks and other stuff are not
4190 * replaced atomically, and you get a "move" uevent, but it's not easy to
4191 * connect the event to the old and new device. Device nodes are not renamed at
4192 * all, there isn't even support for that in the kernel now.
4194 * In the meantime, during renaming, your target name might be taken by another
4195 * driver, creating conflicts. Or the old name is taken directly after you
4196 * renamed it -- then you get events for the same DEVPATH, before you even see
4197 * the "move" event. It's just a mess, and nothing new should ever rely on
4198 * kernel device renaming. Besides that, it's not even implemented now for
4199 * other things than (driver-core wise very simple) network devices.
4201 * We are currently about to change network renaming in udev to completely
4202 * disallow renaming of devices in the same namespace as the kernel uses,
4203 * because we can't solve the problems properly, that arise with swapping names
4204 * of multiple interfaces without races. Means, renaming of eth[0-9]* will only
4205 * be allowed to some other name than eth[0-9]*, for the aforementioned
4208 * Make up a "real" name in the driver before you register anything, or add
4209 * some other attributes for userspace to find the device, or use udev to add
4210 * symlinks -- but never rename kernel devices later, it's a complete mess. We
4211 * don't even want to get into that and try to implement the missing pieces in
4212 * the core. We really have other pieces to fix in the driver core mess. :)
4214 int device_rename(struct device *dev, const char *new_name)
4216 struct kobject *kobj = &dev->kobj;
4217 char *old_device_name = NULL;
4220 dev = get_device(dev);
4224 dev_dbg(dev, "renaming to %s\n", new_name);
4226 old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
4227 if (!old_device_name) {
4233 error = sysfs_rename_link_ns(&dev->class->p->subsys.kobj,
4234 kobj, old_device_name,
4235 new_name, kobject_namespace(kobj));
4240 error = kobject_rename(kobj, new_name);
4247 kfree(old_device_name);
4251 EXPORT_SYMBOL_GPL(device_rename);
4253 static int device_move_class_links(struct device *dev,
4254 struct device *old_parent,
4255 struct device *new_parent)
4260 sysfs_remove_link(&dev->kobj, "device");
4262 error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
4268 * device_move - moves a device to a new parent
4269 * @dev: the pointer to the struct device to be moved
4270 * @new_parent: the new parent of the device (can be NULL)
4271 * @dpm_order: how to reorder the dpm_list
4273 int device_move(struct device *dev, struct device *new_parent,
4274 enum dpm_order dpm_order)
4277 struct device *old_parent;
4278 struct kobject *new_parent_kobj;
4280 dev = get_device(dev);
4285 new_parent = get_device(new_parent);
4286 new_parent_kobj = get_device_parent(dev, new_parent);
4287 if (IS_ERR(new_parent_kobj)) {
4288 error = PTR_ERR(new_parent_kobj);
4289 put_device(new_parent);
4293 pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
4294 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
4295 error = kobject_move(&dev->kobj, new_parent_kobj);
4297 cleanup_glue_dir(dev, new_parent_kobj);
4298 put_device(new_parent);
4301 old_parent = dev->parent;
4302 dev->parent = new_parent;
4304 klist_remove(&dev->p->knode_parent);
4306 klist_add_tail(&dev->p->knode_parent,
4307 &new_parent->p->klist_children);
4308 set_dev_node(dev, dev_to_node(new_parent));
4312 error = device_move_class_links(dev, old_parent, new_parent);
4314 /* We ignore errors on cleanup since we're hosed anyway... */
4315 device_move_class_links(dev, new_parent, old_parent);
4316 if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
4318 klist_remove(&dev->p->knode_parent);
4319 dev->parent = old_parent;
4321 klist_add_tail(&dev->p->knode_parent,
4322 &old_parent->p->klist_children);
4323 set_dev_node(dev, dev_to_node(old_parent));
4326 cleanup_glue_dir(dev, new_parent_kobj);
4327 put_device(new_parent);
4331 switch (dpm_order) {
4332 case DPM_ORDER_NONE:
4334 case DPM_ORDER_DEV_AFTER_PARENT:
4335 device_pm_move_after(dev, new_parent);
4336 devices_kset_move_after(dev, new_parent);
4338 case DPM_ORDER_PARENT_BEFORE_DEV:
4339 device_pm_move_before(new_parent, dev);
4340 devices_kset_move_before(new_parent, dev);
4342 case DPM_ORDER_DEV_LAST:
4343 device_pm_move_last(dev);
4344 devices_kset_move_last(dev);
4348 put_device(old_parent);
4354 EXPORT_SYMBOL_GPL(device_move);
4356 static int device_attrs_change_owner(struct device *dev, kuid_t kuid,
4359 struct kobject *kobj = &dev->kobj;
4360 struct class *class = dev->class;
4361 const struct device_type *type = dev->type;
4366 * Change the device groups of the device class for @dev to
4369 error = sysfs_groups_change_owner(kobj, class->dev_groups, kuid,
4377 * Change the device groups of the device type for @dev to
4380 error = sysfs_groups_change_owner(kobj, type->groups, kuid,
4386 /* Change the device groups of @dev to @kuid/@kgid. */
4387 error = sysfs_groups_change_owner(kobj, dev->groups, kuid, kgid);
4391 if (device_supports_offline(dev) && !dev->offline_disabled) {
4392 /* Change online device attributes of @dev to @kuid/@kgid. */
4393 error = sysfs_file_change_owner(kobj, dev_attr_online.attr.name,
4403 * device_change_owner - change the owner of an existing device.
4405 * @kuid: new owner's kuid
4406 * @kgid: new owner's kgid
4408 * This changes the owner of @dev and its corresponding sysfs entries to
4409 * @kuid/@kgid. This function closely mirrors how @dev was added via driver
4412 * Returns 0 on success or error code on failure.
4414 int device_change_owner(struct device *dev, kuid_t kuid, kgid_t kgid)
4417 struct kobject *kobj = &dev->kobj;
4419 dev = get_device(dev);
4424 * Change the kobject and the default attributes and groups of the
4425 * ktype associated with it to @kuid/@kgid.
4427 error = sysfs_change_owner(kobj, kuid, kgid);
4432 * Change the uevent file for @dev to the new owner. The uevent file
4433 * was created in a separate step when @dev got added and we mirror
4436 error = sysfs_file_change_owner(kobj, dev_attr_uevent.attr.name, kuid,
4442 * Change the device groups, the device groups associated with the
4443 * device class, and the groups associated with the device type of @dev
4446 error = device_attrs_change_owner(dev, kuid, kgid);
4450 error = dpm_sysfs_change_owner(dev, kuid, kgid);
4455 if (sysfs_deprecated && dev->class == &block_class)
4460 * Change the owner of the symlink located in the class directory of
4461 * the device class associated with @dev which points to the actual
4462 * directory entry for @dev to @kuid/@kgid. This ensures that the
4463 * symlink shows the same permissions as its target.
4465 error = sysfs_link_change_owner(&dev->class->p->subsys.kobj, &dev->kobj,
4466 dev_name(dev), kuid, kgid);
4474 EXPORT_SYMBOL_GPL(device_change_owner);
4477 * device_shutdown - call ->shutdown() on each device to shutdown.
4479 void device_shutdown(void)
4481 struct device *dev, *parent;
4483 wait_for_device_probe();
4484 device_block_probing();
4488 spin_lock(&devices_kset->list_lock);
4490 * Walk the devices list backward, shutting down each in turn.
4491 * Beware that device unplug events may also start pulling
4492 * devices offline, even as the system is shutting down.
4494 while (!list_empty(&devices_kset->list)) {
4495 dev = list_entry(devices_kset->list.prev, struct device,
4499 * hold reference count of device's parent to
4500 * prevent it from being freed because parent's
4501 * lock is to be held
4503 parent = get_device(dev->parent);
4506 * Make sure the device is off the kset list, in the
4507 * event that dev->*->shutdown() doesn't remove it.
4509 list_del_init(&dev->kobj.entry);
4510 spin_unlock(&devices_kset->list_lock);
4512 /* hold lock to avoid race with probe/release */
4514 device_lock(parent);
4517 /* Don't allow any more runtime suspends */
4518 pm_runtime_get_noresume(dev);
4519 pm_runtime_barrier(dev);
4521 if (dev->class && dev->class->shutdown_pre) {
4523 dev_info(dev, "shutdown_pre\n");
4524 dev->class->shutdown_pre(dev);
4526 if (dev->bus && dev->bus->shutdown) {
4528 dev_info(dev, "shutdown\n");
4529 dev->bus->shutdown(dev);
4530 } else if (dev->driver && dev->driver->shutdown) {
4532 dev_info(dev, "shutdown\n");
4533 dev->driver->shutdown(dev);
4538 device_unlock(parent);
4543 spin_lock(&devices_kset->list_lock);
4545 spin_unlock(&devices_kset->list_lock);
4549 * Device logging functions
4552 #ifdef CONFIG_PRINTK
4554 set_dev_info(const struct device *dev, struct dev_printk_info *dev_info)
4558 memset(dev_info, 0, sizeof(*dev_info));
4561 subsys = dev->class->name;
4563 subsys = dev->bus->name;
4567 strscpy(dev_info->subsystem, subsys, sizeof(dev_info->subsystem));
4570 * Add device identifier DEVICE=:
4574 * +sound:card0 subsystem:devname
4576 if (MAJOR(dev->devt)) {
4579 if (strcmp(subsys, "block") == 0)
4584 snprintf(dev_info->device, sizeof(dev_info->device),
4585 "%c%u:%u", c, MAJOR(dev->devt), MINOR(dev->devt));
4586 } else if (strcmp(subsys, "net") == 0) {
4587 struct net_device *net = to_net_dev(dev);
4589 snprintf(dev_info->device, sizeof(dev_info->device),
4590 "n%u", net->ifindex);
4592 snprintf(dev_info->device, sizeof(dev_info->device),
4593 "+%s:%s", subsys, dev_name(dev));
4597 int dev_vprintk_emit(int level, const struct device *dev,
4598 const char *fmt, va_list args)
4600 struct dev_printk_info dev_info;
4602 set_dev_info(dev, &dev_info);
4604 return vprintk_emit(0, level, &dev_info, fmt, args);
4606 EXPORT_SYMBOL(dev_vprintk_emit);
4608 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
4613 va_start(args, fmt);
4615 r = dev_vprintk_emit(level, dev, fmt, args);
4621 EXPORT_SYMBOL(dev_printk_emit);
4623 static void __dev_printk(const char *level, const struct device *dev,
4624 struct va_format *vaf)
4627 dev_printk_emit(level[1] - '0', dev, "%s %s: %pV",
4628 dev_driver_string(dev), dev_name(dev), vaf);
4630 printk("%s(NULL device *): %pV", level, vaf);
4633 void _dev_printk(const char *level, const struct device *dev,
4634 const char *fmt, ...)
4636 struct va_format vaf;
4639 va_start(args, fmt);
4644 __dev_printk(level, dev, &vaf);
4648 EXPORT_SYMBOL(_dev_printk);
4650 #define define_dev_printk_level(func, kern_level) \
4651 void func(const struct device *dev, const char *fmt, ...) \
4653 struct va_format vaf; \
4656 va_start(args, fmt); \
4661 __dev_printk(kern_level, dev, &vaf); \
4665 EXPORT_SYMBOL(func);
4667 define_dev_printk_level(_dev_emerg, KERN_EMERG);
4668 define_dev_printk_level(_dev_alert, KERN_ALERT);
4669 define_dev_printk_level(_dev_crit, KERN_CRIT);
4670 define_dev_printk_level(_dev_err, KERN_ERR);
4671 define_dev_printk_level(_dev_warn, KERN_WARNING);
4672 define_dev_printk_level(_dev_notice, KERN_NOTICE);
4673 define_dev_printk_level(_dev_info, KERN_INFO);
4678 * dev_err_probe - probe error check and log helper
4679 * @dev: the pointer to the struct device
4680 * @err: error value to test
4681 * @fmt: printf-style format string
4682 * @...: arguments as specified in the format string
4684 * This helper implements common pattern present in probe functions for error
4685 * checking: print debug or error message depending if the error value is
4686 * -EPROBE_DEFER and propagate error upwards.
4687 * In case of -EPROBE_DEFER it sets also defer probe reason, which can be
4688 * checked later by reading devices_deferred debugfs attribute.
4689 * It replaces code sequence::
4691 * if (err != -EPROBE_DEFER)
4692 * dev_err(dev, ...);
4694 * dev_dbg(dev, ...);
4699 * return dev_err_probe(dev, err, ...);
4701 * Note that it is deemed acceptable to use this function for error
4702 * prints during probe even if the @err is known to never be -EPROBE_DEFER.
4703 * The benefit compared to a normal dev_err() is the standardized format
4704 * of the error code and the fact that the error code is returned.
4709 int dev_err_probe(const struct device *dev, int err, const char *fmt, ...)
4711 struct va_format vaf;
4714 va_start(args, fmt);
4718 if (err != -EPROBE_DEFER) {
4719 dev_err(dev, "error %pe: %pV", ERR_PTR(err), &vaf);
4721 device_set_deferred_probe_reason(dev, &vaf);
4722 dev_dbg(dev, "error %pe: %pV", ERR_PTR(err), &vaf);
4729 EXPORT_SYMBOL_GPL(dev_err_probe);
4731 static inline bool fwnode_is_primary(struct fwnode_handle *fwnode)
4733 return fwnode && !IS_ERR(fwnode->secondary);
4737 * set_primary_fwnode - Change the primary firmware node of a given device.
4738 * @dev: Device to handle.
4739 * @fwnode: New primary firmware node of the device.
4741 * Set the device's firmware node pointer to @fwnode, but if a secondary
4742 * firmware node of the device is present, preserve it.
4744 * Valid fwnode cases are:
4745 * - primary --> secondary --> -ENODEV
4746 * - primary --> NULL
4747 * - secondary --> -ENODEV
4750 void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode)
4752 struct device *parent = dev->parent;
4753 struct fwnode_handle *fn = dev->fwnode;
4756 if (fwnode_is_primary(fn))
4760 WARN_ON(fwnode->secondary);
4761 fwnode->secondary = fn;
4763 dev->fwnode = fwnode;
4765 if (fwnode_is_primary(fn)) {
4766 dev->fwnode = fn->secondary;
4767 /* Set fn->secondary = NULL, so fn remains the primary fwnode */
4768 if (!(parent && fn == parent->fwnode))
4769 fn->secondary = NULL;
4775 EXPORT_SYMBOL_GPL(set_primary_fwnode);
4778 * set_secondary_fwnode - Change the secondary firmware node of a given device.
4779 * @dev: Device to handle.
4780 * @fwnode: New secondary firmware node of the device.
4782 * If a primary firmware node of the device is present, set its secondary
4783 * pointer to @fwnode. Otherwise, set the device's firmware node pointer to
4786 void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode)
4789 fwnode->secondary = ERR_PTR(-ENODEV);
4791 if (fwnode_is_primary(dev->fwnode))
4792 dev->fwnode->secondary = fwnode;
4794 dev->fwnode = fwnode;
4796 EXPORT_SYMBOL_GPL(set_secondary_fwnode);
4799 * device_set_of_node_from_dev - reuse device-tree node of another device
4800 * @dev: device whose device-tree node is being set
4801 * @dev2: device whose device-tree node is being reused
4803 * Takes another reference to the new device-tree node after first dropping
4804 * any reference held to the old node.
4806 void device_set_of_node_from_dev(struct device *dev, const struct device *dev2)
4808 of_node_put(dev->of_node);
4809 dev->of_node = of_node_get(dev2->of_node);
4810 dev->of_node_reused = true;
4812 EXPORT_SYMBOL_GPL(device_set_of_node_from_dev);
4814 void device_set_node(struct device *dev, struct fwnode_handle *fwnode)
4816 dev->fwnode = fwnode;
4817 dev->of_node = to_of_node(fwnode);
4819 EXPORT_SYMBOL_GPL(device_set_node);
4821 int device_match_name(struct device *dev, const void *name)
4823 return sysfs_streq(dev_name(dev), name);
4825 EXPORT_SYMBOL_GPL(device_match_name);
4827 int device_match_of_node(struct device *dev, const void *np)
4829 return dev->of_node == np;
4831 EXPORT_SYMBOL_GPL(device_match_of_node);
4833 int device_match_fwnode(struct device *dev, const void *fwnode)
4835 return dev_fwnode(dev) == fwnode;
4837 EXPORT_SYMBOL_GPL(device_match_fwnode);
4839 int device_match_devt(struct device *dev, const void *pdevt)
4841 return dev->devt == *(dev_t *)pdevt;
4843 EXPORT_SYMBOL_GPL(device_match_devt);
4845 int device_match_acpi_dev(struct device *dev, const void *adev)
4847 return ACPI_COMPANION(dev) == adev;
4849 EXPORT_SYMBOL(device_match_acpi_dev);
4851 int device_match_acpi_handle(struct device *dev, const void *handle)
4853 return ACPI_HANDLE(dev) == handle;
4855 EXPORT_SYMBOL(device_match_acpi_handle);
4857 int device_match_any(struct device *dev, const void *unused)
4861 EXPORT_SYMBOL_GPL(device_match_any);