xref: /openbmc/linux/drivers/base/core.c (revision 8375e74f)
1989d42e8SGreg Kroah-Hartman // SPDX-License-Identifier: GPL-2.0
21da177e4SLinus Torvalds /*
31da177e4SLinus Torvalds  * drivers/base/core.c - core driver model code (device registration, etc)
41da177e4SLinus Torvalds  *
51da177e4SLinus Torvalds  * Copyright (c) 2002-3 Patrick Mochel
61da177e4SLinus Torvalds  * Copyright (c) 2002-3 Open Source Development Labs
764bb5d2cSGreg Kroah-Hartman  * Copyright (c) 2006 Greg Kroah-Hartman <gregkh@suse.de>
864bb5d2cSGreg Kroah-Hartman  * Copyright (c) 2006 Novell, Inc.
91da177e4SLinus Torvalds  */
101da177e4SLinus Torvalds 
117847a145SHeikki Krogerus #include <linux/acpi.h>
1265650b35SRafael J. Wysocki #include <linux/cpufreq.h>
131da177e4SLinus Torvalds #include <linux/device.h>
141da177e4SLinus Torvalds #include <linux/err.h>
1597badf87SRafael J. Wysocki #include <linux/fwnode.h>
161da177e4SLinus Torvalds #include <linux/init.h>
171da177e4SLinus Torvalds #include <linux/module.h>
181da177e4SLinus Torvalds #include <linux/slab.h>
191da177e4SLinus Torvalds #include <linux/string.h>
2023681e47SGreg Kroah-Hartman #include <linux/kdev_t.h>
21116af378SBenjamin Herrenschmidt #include <linux/notifier.h>
2207d57a32SGrant Likely #include <linux/of.h>
2307d57a32SGrant Likely #include <linux/of_device.h>
24da231fd5SKay Sievers #include <linux/genhd.h>
25f75b1c60SDave Young #include <linux/mutex.h>
26af8db150SPeter Chen #include <linux/pm_runtime.h>
27c4e00daaSKay Sievers #include <linux/netdevice.h>
28174cd4b1SIngo Molnar #include <linux/sched/signal.h>
2963967685SGreg Kroah-Hartman #include <linux/sysfs.h>
301da177e4SLinus Torvalds 
311da177e4SLinus Torvalds #include "base.h"
321da177e4SLinus Torvalds #include "power/power.h"
331da177e4SLinus Torvalds 
34e52eec13SAndi Kleen #ifdef CONFIG_SYSFS_DEPRECATED
35e52eec13SAndi Kleen #ifdef CONFIG_SYSFS_DEPRECATED_V2
36e52eec13SAndi Kleen long sysfs_deprecated = 1;
37e52eec13SAndi Kleen #else
38e52eec13SAndi Kleen long sysfs_deprecated = 0;
39e52eec13SAndi Kleen #endif
403454bf96SHanjun Guo static int __init sysfs_deprecated_setup(char *arg)
41e52eec13SAndi Kleen {
4234da5e67SJingoo Han 	return kstrtol(arg, 10, &sysfs_deprecated);
43e52eec13SAndi Kleen }
44e52eec13SAndi Kleen early_param("sysfs.deprecated", sysfs_deprecated_setup);
45e52eec13SAndi Kleen #endif
46e52eec13SAndi Kleen 
479ed98953SRafael J. Wysocki /* Device links support. */
48e2ae9bccSSaravana Kannan static LIST_HEAD(wait_for_suppliers);
49e2ae9bccSSaravana Kannan static DEFINE_MUTEX(wfs_lock);
50fc5a251dSSaravana Kannan static LIST_HEAD(deferred_sync);
51fc5a251dSSaravana Kannan static unsigned int defer_sync_state_count = 1;
529ed98953SRafael J. Wysocki 
539ed98953SRafael J. Wysocki #ifdef CONFIG_SRCU
549ed98953SRafael J. Wysocki static DEFINE_MUTEX(device_links_lock);
559ed98953SRafael J. Wysocki DEFINE_STATIC_SRCU(device_links_srcu);
569ed98953SRafael J. Wysocki 
579ed98953SRafael J. Wysocki static inline void device_links_write_lock(void)
589ed98953SRafael J. Wysocki {
599ed98953SRafael J. Wysocki 	mutex_lock(&device_links_lock);
609ed98953SRafael J. Wysocki }
619ed98953SRafael J. Wysocki 
629ed98953SRafael J. Wysocki static inline void device_links_write_unlock(void)
639ed98953SRafael J. Wysocki {
649ed98953SRafael J. Wysocki 	mutex_unlock(&device_links_lock);
659ed98953SRafael J. Wysocki }
669ed98953SRafael J. Wysocki 
679ed98953SRafael J. Wysocki int device_links_read_lock(void)
689ed98953SRafael J. Wysocki {
699ed98953SRafael J. Wysocki 	return srcu_read_lock(&device_links_srcu);
709ed98953SRafael J. Wysocki }
719ed98953SRafael J. Wysocki 
729ed98953SRafael J. Wysocki void device_links_read_unlock(int idx)
739ed98953SRafael J. Wysocki {
749ed98953SRafael J. Wysocki 	srcu_read_unlock(&device_links_srcu, idx);
759ed98953SRafael J. Wysocki }
76c2fa1e1bSJoel Fernandes (Google) 
77c2fa1e1bSJoel Fernandes (Google) int device_links_read_lock_held(void)
78c2fa1e1bSJoel Fernandes (Google) {
79c2fa1e1bSJoel Fernandes (Google) 	return srcu_read_lock_held(&device_links_srcu);
80c2fa1e1bSJoel Fernandes (Google) }
819ed98953SRafael J. Wysocki #else /* !CONFIG_SRCU */
829ed98953SRafael J. Wysocki static DECLARE_RWSEM(device_links_lock);
839ed98953SRafael J. Wysocki 
849ed98953SRafael J. Wysocki static inline void device_links_write_lock(void)
859ed98953SRafael J. Wysocki {
869ed98953SRafael J. Wysocki 	down_write(&device_links_lock);
879ed98953SRafael J. Wysocki }
889ed98953SRafael J. Wysocki 
899ed98953SRafael J. Wysocki static inline void device_links_write_unlock(void)
909ed98953SRafael J. Wysocki {
919ed98953SRafael J. Wysocki 	up_write(&device_links_lock);
929ed98953SRafael J. Wysocki }
939ed98953SRafael J. Wysocki 
949ed98953SRafael J. Wysocki int device_links_read_lock(void)
959ed98953SRafael J. Wysocki {
969ed98953SRafael J. Wysocki 	down_read(&device_links_lock);
979ed98953SRafael J. Wysocki 	return 0;
989ed98953SRafael J. Wysocki }
999ed98953SRafael J. Wysocki 
1009ed98953SRafael J. Wysocki void device_links_read_unlock(int not_used)
1019ed98953SRafael J. Wysocki {
1029ed98953SRafael J. Wysocki 	up_read(&device_links_lock);
1039ed98953SRafael J. Wysocki }
104c2fa1e1bSJoel Fernandes (Google) 
105c2fa1e1bSJoel Fernandes (Google) #ifdef CONFIG_DEBUG_LOCK_ALLOC
106c2fa1e1bSJoel Fernandes (Google) int device_links_read_lock_held(void)
107c2fa1e1bSJoel Fernandes (Google) {
108c2fa1e1bSJoel Fernandes (Google) 	return lockdep_is_held(&device_links_lock);
109c2fa1e1bSJoel Fernandes (Google) }
110c2fa1e1bSJoel Fernandes (Google) #endif
1119ed98953SRafael J. Wysocki #endif /* !CONFIG_SRCU */
1129ed98953SRafael J. Wysocki 
1139ed98953SRafael J. Wysocki /**
1149ed98953SRafael J. Wysocki  * device_is_dependent - Check if one device depends on another one
1159ed98953SRafael J. Wysocki  * @dev: Device to check dependencies for.
1169ed98953SRafael J. Wysocki  * @target: Device to check against.
1179ed98953SRafael J. Wysocki  *
1189ed98953SRafael J. Wysocki  * Check if @target depends on @dev or any device dependent on it (its child or
1199ed98953SRafael J. Wysocki  * its consumer etc).  Return 1 if that is the case or 0 otherwise.
1209ed98953SRafael J. Wysocki  */
1219ed98953SRafael J. Wysocki static int device_is_dependent(struct device *dev, void *target)
1229ed98953SRafael J. Wysocki {
1239ed98953SRafael J. Wysocki 	struct device_link *link;
1249ed98953SRafael J. Wysocki 	int ret;
1259ed98953SRafael J. Wysocki 
126e16f4f3eSBenjamin Gaignard 	if (dev == target)
1279ed98953SRafael J. Wysocki 		return 1;
1289ed98953SRafael J. Wysocki 
1299ed98953SRafael J. Wysocki 	ret = device_for_each_child(dev, target, device_is_dependent);
1309ed98953SRafael J. Wysocki 	if (ret)
1319ed98953SRafael J. Wysocki 		return ret;
1329ed98953SRafael J. Wysocki 
1339ed98953SRafael J. Wysocki 	list_for_each_entry(link, &dev->links.consumers, s_node) {
13405ef983eSSaravana Kannan 		if (link->flags == (DL_FLAG_SYNC_STATE_ONLY | DL_FLAG_MANAGED))
13505ef983eSSaravana Kannan 			continue;
13605ef983eSSaravana Kannan 
137e16f4f3eSBenjamin Gaignard 		if (link->consumer == target)
1389ed98953SRafael J. Wysocki 			return 1;
1399ed98953SRafael J. Wysocki 
1409ed98953SRafael J. Wysocki 		ret = device_is_dependent(link->consumer, target);
1419ed98953SRafael J. Wysocki 		if (ret)
1429ed98953SRafael J. Wysocki 			break;
1439ed98953SRafael J. Wysocki 	}
1449ed98953SRafael J. Wysocki 	return ret;
1459ed98953SRafael J. Wysocki }
1469ed98953SRafael J. Wysocki 
147515db266SRafael J. Wysocki static void device_link_init_status(struct device_link *link,
148515db266SRafael J. Wysocki 				    struct device *consumer,
149515db266SRafael J. Wysocki 				    struct device *supplier)
150515db266SRafael J. Wysocki {
151515db266SRafael J. Wysocki 	switch (supplier->links.status) {
152515db266SRafael J. Wysocki 	case DL_DEV_PROBING:
153515db266SRafael J. Wysocki 		switch (consumer->links.status) {
154515db266SRafael J. Wysocki 		case DL_DEV_PROBING:
155515db266SRafael J. Wysocki 			/*
156515db266SRafael J. Wysocki 			 * A consumer driver can create a link to a supplier
157515db266SRafael J. Wysocki 			 * that has not completed its probing yet as long as it
158515db266SRafael J. Wysocki 			 * knows that the supplier is already functional (for
159515db266SRafael J. Wysocki 			 * example, it has just acquired some resources from the
160515db266SRafael J. Wysocki 			 * supplier).
161515db266SRafael J. Wysocki 			 */
162515db266SRafael J. Wysocki 			link->status = DL_STATE_CONSUMER_PROBE;
163515db266SRafael J. Wysocki 			break;
164515db266SRafael J. Wysocki 		default:
165515db266SRafael J. Wysocki 			link->status = DL_STATE_DORMANT;
166515db266SRafael J. Wysocki 			break;
167515db266SRafael J. Wysocki 		}
168515db266SRafael J. Wysocki 		break;
169515db266SRafael J. Wysocki 	case DL_DEV_DRIVER_BOUND:
170515db266SRafael J. Wysocki 		switch (consumer->links.status) {
171515db266SRafael J. Wysocki 		case DL_DEV_PROBING:
172515db266SRafael J. Wysocki 			link->status = DL_STATE_CONSUMER_PROBE;
173515db266SRafael J. Wysocki 			break;
174515db266SRafael J. Wysocki 		case DL_DEV_DRIVER_BOUND:
175515db266SRafael J. Wysocki 			link->status = DL_STATE_ACTIVE;
176515db266SRafael J. Wysocki 			break;
177515db266SRafael J. Wysocki 		default:
178515db266SRafael J. Wysocki 			link->status = DL_STATE_AVAILABLE;
179515db266SRafael J. Wysocki 			break;
180515db266SRafael J. Wysocki 		}
181515db266SRafael J. Wysocki 		break;
182515db266SRafael J. Wysocki 	case DL_DEV_UNBINDING:
183515db266SRafael J. Wysocki 		link->status = DL_STATE_SUPPLIER_UNBIND;
184515db266SRafael J. Wysocki 		break;
185515db266SRafael J. Wysocki 	default:
186515db266SRafael J. Wysocki 		link->status = DL_STATE_DORMANT;
187515db266SRafael J. Wysocki 		break;
188515db266SRafael J. Wysocki 	}
189515db266SRafael J. Wysocki }
190515db266SRafael J. Wysocki 
1919ed98953SRafael J. Wysocki static int device_reorder_to_tail(struct device *dev, void *not_used)
1929ed98953SRafael J. Wysocki {
1939ed98953SRafael J. Wysocki 	struct device_link *link;
1949ed98953SRafael J. Wysocki 
1959ed98953SRafael J. Wysocki 	/*
1969ed98953SRafael J. Wysocki 	 * Devices that have not been registered yet will be put to the ends
1979ed98953SRafael J. Wysocki 	 * of the lists during the registration, so skip them here.
1989ed98953SRafael J. Wysocki 	 */
1999ed98953SRafael J. Wysocki 	if (device_is_registered(dev))
2009ed98953SRafael J. Wysocki 		devices_kset_move_last(dev);
2019ed98953SRafael J. Wysocki 
2029ed98953SRafael J. Wysocki 	if (device_pm_initialized(dev))
2039ed98953SRafael J. Wysocki 		device_pm_move_last(dev);
2049ed98953SRafael J. Wysocki 
2059ed98953SRafael J. Wysocki 	device_for_each_child(dev, NULL, device_reorder_to_tail);
20605ef983eSSaravana Kannan 	list_for_each_entry(link, &dev->links.consumers, s_node) {
20705ef983eSSaravana Kannan 		if (link->flags == (DL_FLAG_SYNC_STATE_ONLY | DL_FLAG_MANAGED))
20805ef983eSSaravana Kannan 			continue;
2099ed98953SRafael J. Wysocki 		device_reorder_to_tail(link->consumer, NULL);
21005ef983eSSaravana Kannan 	}
2119ed98953SRafael J. Wysocki 
2129ed98953SRafael J. Wysocki 	return 0;
2139ed98953SRafael J. Wysocki }
2149ed98953SRafael J. Wysocki 
2159ed98953SRafael J. Wysocki /**
216494fd7b7SFeng Kan  * device_pm_move_to_tail - Move set of devices to the end of device lists
217494fd7b7SFeng Kan  * @dev: Device to move
218494fd7b7SFeng Kan  *
219494fd7b7SFeng Kan  * This is a device_reorder_to_tail() wrapper taking the requisite locks.
220494fd7b7SFeng Kan  *
221494fd7b7SFeng Kan  * It moves the @dev along with all of its children and all of its consumers
222494fd7b7SFeng Kan  * to the ends of the device_kset and dpm_list, recursively.
223494fd7b7SFeng Kan  */
224494fd7b7SFeng Kan void device_pm_move_to_tail(struct device *dev)
225494fd7b7SFeng Kan {
226494fd7b7SFeng Kan 	int idx;
227494fd7b7SFeng Kan 
228494fd7b7SFeng Kan 	idx = device_links_read_lock();
229494fd7b7SFeng Kan 	device_pm_lock();
230494fd7b7SFeng Kan 	device_reorder_to_tail(dev, NULL);
231494fd7b7SFeng Kan 	device_pm_unlock();
232494fd7b7SFeng Kan 	device_links_read_unlock(idx);
233494fd7b7SFeng Kan }
234494fd7b7SFeng Kan 
235515db266SRafael J. Wysocki #define DL_MANAGED_LINK_FLAGS (DL_FLAG_AUTOREMOVE_CONSUMER | \
236515db266SRafael J. Wysocki 			       DL_FLAG_AUTOREMOVE_SUPPLIER | \
23705ef983eSSaravana Kannan 			       DL_FLAG_AUTOPROBE_CONSUMER  | \
23805ef983eSSaravana Kannan 			       DL_FLAG_SYNC_STATE_ONLY)
239515db266SRafael J. Wysocki 
240fb583c8eSRafael J. Wysocki #define DL_ADD_VALID_FLAGS (DL_MANAGED_LINK_FLAGS | DL_FLAG_STATELESS | \
241fb583c8eSRafael J. Wysocki 			    DL_FLAG_PM_RUNTIME | DL_FLAG_RPM_ACTIVE)
242fb583c8eSRafael J. Wysocki 
243494fd7b7SFeng Kan /**
2449ed98953SRafael J. Wysocki  * device_link_add - Create a link between two devices.
2459ed98953SRafael J. Wysocki  * @consumer: Consumer end of the link.
2469ed98953SRafael J. Wysocki  * @supplier: Supplier end of the link.
2479ed98953SRafael J. Wysocki  * @flags: Link flags.
2489ed98953SRafael J. Wysocki  *
24921d5c57bSRafael J. Wysocki  * The caller is responsible for the proper synchronization of the link creation
25021d5c57bSRafael J. Wysocki  * with runtime PM.  First, setting the DL_FLAG_PM_RUNTIME flag will cause the
25121d5c57bSRafael J. Wysocki  * runtime PM framework to take the link into account.  Second, if the
25221d5c57bSRafael J. Wysocki  * DL_FLAG_RPM_ACTIVE flag is set in addition to it, the supplier devices will
25321d5c57bSRafael J. Wysocki  * be forced into the active metastate and reference-counted upon the creation
25421d5c57bSRafael J. Wysocki  * of the link.  If DL_FLAG_PM_RUNTIME is not set, DL_FLAG_RPM_ACTIVE will be
25521d5c57bSRafael J. Wysocki  * ignored.
25621d5c57bSRafael J. Wysocki  *
257515db266SRafael J. Wysocki  * If DL_FLAG_STATELESS is set in @flags, the caller of this function is
258515db266SRafael J. Wysocki  * expected to release the link returned by it directly with the help of either
259515db266SRafael J. Wysocki  * device_link_del() or device_link_remove().
26072175d4eSRafael J. Wysocki  *
26172175d4eSRafael J. Wysocki  * If that flag is not set, however, the caller of this function is handing the
26272175d4eSRafael J. Wysocki  * management of the link over to the driver core entirely and its return value
26372175d4eSRafael J. Wysocki  * can only be used to check whether or not the link is present.  In that case,
26472175d4eSRafael J. Wysocki  * the DL_FLAG_AUTOREMOVE_CONSUMER and DL_FLAG_AUTOREMOVE_SUPPLIER device link
26572175d4eSRafael J. Wysocki  * flags can be used to indicate to the driver core when the link can be safely
26672175d4eSRafael J. Wysocki  * deleted.  Namely, setting one of them in @flags indicates to the driver core
26772175d4eSRafael J. Wysocki  * that the link is not going to be used (by the given caller of this function)
26872175d4eSRafael J. Wysocki  * after unbinding the consumer or supplier driver, respectively, from its
26972175d4eSRafael J. Wysocki  * device, so the link can be deleted at that point.  If none of them is set,
27072175d4eSRafael J. Wysocki  * the link will be maintained until one of the devices pointed to by it (either
27172175d4eSRafael J. Wysocki  * the consumer or the supplier) is unregistered.
272c8d50986SRafael J. Wysocki  *
273e7dd4010SRafael J. Wysocki  * Also, if DL_FLAG_STATELESS, DL_FLAG_AUTOREMOVE_CONSUMER and
274e7dd4010SRafael J. Wysocki  * DL_FLAG_AUTOREMOVE_SUPPLIER are not set in @flags (that is, a persistent
275e7dd4010SRafael J. Wysocki  * managed device link is being added), the DL_FLAG_AUTOPROBE_CONSUMER flag can
276e7dd4010SRafael J. Wysocki  * be used to request the driver core to automaticall probe for a consmer
277e7dd4010SRafael J. Wysocki  * driver after successfully binding a driver to the supplier device.
278e7dd4010SRafael J. Wysocki  *
279515db266SRafael J. Wysocki  * The combination of DL_FLAG_STATELESS and one of DL_FLAG_AUTOREMOVE_CONSUMER,
280515db266SRafael J. Wysocki  * DL_FLAG_AUTOREMOVE_SUPPLIER, or DL_FLAG_AUTOPROBE_CONSUMER set in @flags at
281515db266SRafael J. Wysocki  * the same time is invalid and will cause NULL to be returned upfront.
282515db266SRafael J. Wysocki  * However, if a device link between the given @consumer and @supplier pair
283515db266SRafael J. Wysocki  * exists already when this function is called for them, the existing link will
284515db266SRafael J. Wysocki  * be returned regardless of its current type and status (the link's flags may
285515db266SRafael J. Wysocki  * be modified then).  The caller of this function is then expected to treat
286515db266SRafael J. Wysocki  * the link as though it has just been created, so (in particular) if
287515db266SRafael J. Wysocki  * DL_FLAG_STATELESS was passed in @flags, the link needs to be released
288515db266SRafael J. Wysocki  * explicitly when not needed any more (as stated above).
2899ed98953SRafael J. Wysocki  *
2909ed98953SRafael J. Wysocki  * A side effect of the link creation is re-ordering of dpm_list and the
2919ed98953SRafael J. Wysocki  * devices_kset list by moving the consumer device and all devices depending
2929ed98953SRafael J. Wysocki  * on it to the ends of these lists (that does not happen to devices that have
2939ed98953SRafael J. Wysocki  * not been registered when this function is called).
2949ed98953SRafael J. Wysocki  *
2959ed98953SRafael J. Wysocki  * The supplier device is required to be registered when this function is called
2969ed98953SRafael J. Wysocki  * and NULL will be returned if that is not the case.  The consumer device need
29764df1148SLukas Wunner  * not be registered, however.
2989ed98953SRafael J. Wysocki  */
2999ed98953SRafael J. Wysocki struct device_link *device_link_add(struct device *consumer,
3009ed98953SRafael J. Wysocki 				    struct device *supplier, u32 flags)
3019ed98953SRafael J. Wysocki {
3029ed98953SRafael J. Wysocki 	struct device_link *link;
3039ed98953SRafael J. Wysocki 
304fb583c8eSRafael J. Wysocki 	if (!consumer || !supplier || flags & ~DL_ADD_VALID_FLAGS ||
305515db266SRafael J. Wysocki 	    (flags & DL_FLAG_STATELESS && flags & DL_MANAGED_LINK_FLAGS) ||
30605ef983eSSaravana Kannan 	    (flags & DL_FLAG_SYNC_STATE_ONLY &&
30705ef983eSSaravana Kannan 	     flags != DL_FLAG_SYNC_STATE_ONLY) ||
308e7dd4010SRafael J. Wysocki 	    (flags & DL_FLAG_AUTOPROBE_CONSUMER &&
309e7dd4010SRafael J. Wysocki 	     flags & (DL_FLAG_AUTOREMOVE_CONSUMER |
310e7dd4010SRafael J. Wysocki 		      DL_FLAG_AUTOREMOVE_SUPPLIER)))
3119ed98953SRafael J. Wysocki 		return NULL;
3129ed98953SRafael J. Wysocki 
3135db25c9eSRafael J. Wysocki 	if (flags & DL_FLAG_PM_RUNTIME && flags & DL_FLAG_RPM_ACTIVE) {
3145db25c9eSRafael J. Wysocki 		if (pm_runtime_get_sync(supplier) < 0) {
3155db25c9eSRafael J. Wysocki 			pm_runtime_put_noidle(supplier);
3165db25c9eSRafael J. Wysocki 			return NULL;
3175db25c9eSRafael J. Wysocki 		}
3185db25c9eSRafael J. Wysocki 	}
3195db25c9eSRafael J. Wysocki 
320515db266SRafael J. Wysocki 	if (!(flags & DL_FLAG_STATELESS))
321515db266SRafael J. Wysocki 		flags |= DL_FLAG_MANAGED;
322515db266SRafael J. Wysocki 
3239ed98953SRafael J. Wysocki 	device_links_write_lock();
3249ed98953SRafael J. Wysocki 	device_pm_lock();
3259ed98953SRafael J. Wysocki 
3269ed98953SRafael J. Wysocki 	/*
3279ed98953SRafael J. Wysocki 	 * If the supplier has not been fully registered yet or there is a
32805ef983eSSaravana Kannan 	 * reverse (non-SYNC_STATE_ONLY) dependency between the consumer and
32905ef983eSSaravana Kannan 	 * the supplier already in the graph, return NULL. If the link is a
33005ef983eSSaravana Kannan 	 * SYNC_STATE_ONLY link, we don't check for reverse dependencies
33105ef983eSSaravana Kannan 	 * because it only affects sync_state() callbacks.
3329ed98953SRafael J. Wysocki 	 */
3339ed98953SRafael J. Wysocki 	if (!device_pm_initialized(supplier)
33405ef983eSSaravana Kannan 	    || (!(flags & DL_FLAG_SYNC_STATE_ONLY) &&
33505ef983eSSaravana Kannan 		  device_is_dependent(consumer, supplier))) {
3369ed98953SRafael J. Wysocki 		link = NULL;
3379ed98953SRafael J. Wysocki 		goto out;
3389ed98953SRafael J. Wysocki 	}
3399ed98953SRafael J. Wysocki 
34072175d4eSRafael J. Wysocki 	/*
34172175d4eSRafael J. Wysocki 	 * DL_FLAG_AUTOREMOVE_SUPPLIER indicates that the link will be needed
34272175d4eSRafael J. Wysocki 	 * longer than for DL_FLAG_AUTOREMOVE_CONSUMER and setting them both
34372175d4eSRafael J. Wysocki 	 * together doesn't make sense, so prefer DL_FLAG_AUTOREMOVE_SUPPLIER.
34472175d4eSRafael J. Wysocki 	 */
34572175d4eSRafael J. Wysocki 	if (flags & DL_FLAG_AUTOREMOVE_SUPPLIER)
34672175d4eSRafael J. Wysocki 		flags &= ~DL_FLAG_AUTOREMOVE_CONSUMER;
34772175d4eSRafael J. Wysocki 
348f265df55SRafael J. Wysocki 	list_for_each_entry(link, &supplier->links.consumers, s_node) {
349f265df55SRafael J. Wysocki 		if (link->consumer != consumer)
350f265df55SRafael J. Wysocki 			continue;
351f265df55SRafael J. Wysocki 
352e2f3cd83SRafael J. Wysocki 		if (flags & DL_FLAG_PM_RUNTIME) {
353e2f3cd83SRafael J. Wysocki 			if (!(link->flags & DL_FLAG_PM_RUNTIME)) {
3544c06c4e6SRafael J. Wysocki 				pm_runtime_new_link(consumer);
355e2f3cd83SRafael J. Wysocki 				link->flags |= DL_FLAG_PM_RUNTIME;
356e2f3cd83SRafael J. Wysocki 			}
357e2f3cd83SRafael J. Wysocki 			if (flags & DL_FLAG_RPM_ACTIVE)
35836003d4cSRafael J. Wysocki 				refcount_inc(&link->rpm_active);
359e2f3cd83SRafael J. Wysocki 		}
360e2f3cd83SRafael J. Wysocki 
36172175d4eSRafael J. Wysocki 		if (flags & DL_FLAG_STATELESS) {
362ead18c23SLukas Wunner 			kref_get(&link->kref);
36305ef983eSSaravana Kannan 			if (link->flags & DL_FLAG_SYNC_STATE_ONLY &&
36405ef983eSSaravana Kannan 			    !(link->flags & DL_FLAG_STATELESS)) {
36505ef983eSSaravana Kannan 				link->flags |= DL_FLAG_STATELESS;
36605ef983eSSaravana Kannan 				goto reorder;
36705ef983eSSaravana Kannan 			} else {
3689ed98953SRafael J. Wysocki 				goto out;
369ead18c23SLukas Wunner 			}
37005ef983eSSaravana Kannan 		}
3719ed98953SRafael J. Wysocki 
37272175d4eSRafael J. Wysocki 		/*
37372175d4eSRafael J. Wysocki 		 * If the life time of the link following from the new flags is
37472175d4eSRafael J. Wysocki 		 * longer than indicated by the flags of the existing link,
37572175d4eSRafael J. Wysocki 		 * update the existing link to stay around longer.
37672175d4eSRafael J. Wysocki 		 */
37772175d4eSRafael J. Wysocki 		if (flags & DL_FLAG_AUTOREMOVE_SUPPLIER) {
37872175d4eSRafael J. Wysocki 			if (link->flags & DL_FLAG_AUTOREMOVE_CONSUMER) {
37972175d4eSRafael J. Wysocki 				link->flags &= ~DL_FLAG_AUTOREMOVE_CONSUMER;
38072175d4eSRafael J. Wysocki 				link->flags |= DL_FLAG_AUTOREMOVE_SUPPLIER;
38172175d4eSRafael J. Wysocki 			}
38272175d4eSRafael J. Wysocki 		} else if (!(flags & DL_FLAG_AUTOREMOVE_CONSUMER)) {
38372175d4eSRafael J. Wysocki 			link->flags &= ~(DL_FLAG_AUTOREMOVE_CONSUMER |
38472175d4eSRafael J. Wysocki 					 DL_FLAG_AUTOREMOVE_SUPPLIER);
38572175d4eSRafael J. Wysocki 		}
386515db266SRafael J. Wysocki 		if (!(link->flags & DL_FLAG_MANAGED)) {
387515db266SRafael J. Wysocki 			kref_get(&link->kref);
388515db266SRafael J. Wysocki 			link->flags |= DL_FLAG_MANAGED;
389515db266SRafael J. Wysocki 			device_link_init_status(link, consumer, supplier);
390515db266SRafael J. Wysocki 		}
39105ef983eSSaravana Kannan 		if (link->flags & DL_FLAG_SYNC_STATE_ONLY &&
39205ef983eSSaravana Kannan 		    !(flags & DL_FLAG_SYNC_STATE_ONLY)) {
39305ef983eSSaravana Kannan 			link->flags &= ~DL_FLAG_SYNC_STATE_ONLY;
39405ef983eSSaravana Kannan 			goto reorder;
39505ef983eSSaravana Kannan 		}
39605ef983eSSaravana Kannan 
39772175d4eSRafael J. Wysocki 		goto out;
39872175d4eSRafael J. Wysocki 	}
39972175d4eSRafael J. Wysocki 
40021d5c57bSRafael J. Wysocki 	link = kzalloc(sizeof(*link), GFP_KERNEL);
4019ed98953SRafael J. Wysocki 	if (!link)
4029ed98953SRafael J. Wysocki 		goto out;
4039ed98953SRafael J. Wysocki 
404e2f3cd83SRafael J. Wysocki 	refcount_set(&link->rpm_active, 1);
405e2f3cd83SRafael J. Wysocki 
406baa8809fSRafael J. Wysocki 	if (flags & DL_FLAG_PM_RUNTIME) {
407e2f3cd83SRafael J. Wysocki 		if (flags & DL_FLAG_RPM_ACTIVE)
40836003d4cSRafael J. Wysocki 			refcount_inc(&link->rpm_active);
409e2f3cd83SRafael J. Wysocki 
4104c06c4e6SRafael J. Wysocki 		pm_runtime_new_link(consumer);
41121d5c57bSRafael J. Wysocki 	}
412e2f3cd83SRafael J. Wysocki 
4139ed98953SRafael J. Wysocki 	get_device(supplier);
4149ed98953SRafael J. Wysocki 	link->supplier = supplier;
4159ed98953SRafael J. Wysocki 	INIT_LIST_HEAD(&link->s_node);
4169ed98953SRafael J. Wysocki 	get_device(consumer);
4179ed98953SRafael J. Wysocki 	link->consumer = consumer;
4189ed98953SRafael J. Wysocki 	INIT_LIST_HEAD(&link->c_node);
4199ed98953SRafael J. Wysocki 	link->flags = flags;
420ead18c23SLukas Wunner 	kref_init(&link->kref);
4219ed98953SRafael J. Wysocki 
42264df1148SLukas Wunner 	/* Determine the initial link state. */
423515db266SRafael J. Wysocki 	if (flags & DL_FLAG_STATELESS)
4249ed98953SRafael J. Wysocki 		link->status = DL_STATE_NONE;
425515db266SRafael J. Wysocki 	else
426515db266SRafael J. Wysocki 		device_link_init_status(link, consumer, supplier);
4279ed98953SRafael J. Wysocki 
4289ed98953SRafael J. Wysocki 	/*
42915cfb094SRafael J. Wysocki 	 * Some callers expect the link creation during consumer driver probe to
43015cfb094SRafael J. Wysocki 	 * resume the supplier even without DL_FLAG_RPM_ACTIVE.
43115cfb094SRafael J. Wysocki 	 */
43215cfb094SRafael J. Wysocki 	if (link->status == DL_STATE_CONSUMER_PROBE &&
43315cfb094SRafael J. Wysocki 	    flags & DL_FLAG_PM_RUNTIME)
43415cfb094SRafael J. Wysocki 		pm_runtime_resume(supplier);
43515cfb094SRafael J. Wysocki 
43605ef983eSSaravana Kannan 	if (flags & DL_FLAG_SYNC_STATE_ONLY) {
43705ef983eSSaravana Kannan 		dev_dbg(consumer,
43805ef983eSSaravana Kannan 			"Linked as a sync state only consumer to %s\n",
43905ef983eSSaravana Kannan 			dev_name(supplier));
44005ef983eSSaravana Kannan 		goto out;
44105ef983eSSaravana Kannan 	}
44205ef983eSSaravana Kannan reorder:
44315cfb094SRafael J. Wysocki 	/*
4449ed98953SRafael J. Wysocki 	 * Move the consumer and all of the devices depending on it to the end
4459ed98953SRafael J. Wysocki 	 * of dpm_list and the devices_kset list.
4469ed98953SRafael J. Wysocki 	 *
4479ed98953SRafael J. Wysocki 	 * It is necessary to hold dpm_list locked throughout all that or else
4489ed98953SRafael J. Wysocki 	 * we may end up suspending with a wrong ordering of it.
4499ed98953SRafael J. Wysocki 	 */
4509ed98953SRafael J. Wysocki 	device_reorder_to_tail(consumer, NULL);
4519ed98953SRafael J. Wysocki 
4529ed98953SRafael J. Wysocki 	list_add_tail_rcu(&link->s_node, &supplier->links.consumers);
4539ed98953SRafael J. Wysocki 	list_add_tail_rcu(&link->c_node, &consumer->links.suppliers);
4549ed98953SRafael J. Wysocki 
4558a4b3269SJerome Brunet 	dev_dbg(consumer, "Linked as a consumer to %s\n", dev_name(supplier));
4569ed98953SRafael J. Wysocki 
4579ed98953SRafael J. Wysocki  out:
4589ed98953SRafael J. Wysocki 	device_pm_unlock();
4599ed98953SRafael J. Wysocki 	device_links_write_unlock();
4605db25c9eSRafael J. Wysocki 
461e2f3cd83SRafael J. Wysocki 	if ((flags & DL_FLAG_PM_RUNTIME && flags & DL_FLAG_RPM_ACTIVE) && !link)
4625db25c9eSRafael J. Wysocki 		pm_runtime_put(supplier);
4635db25c9eSRafael J. Wysocki 
4649ed98953SRafael J. Wysocki 	return link;
4659ed98953SRafael J. Wysocki }
4669ed98953SRafael J. Wysocki EXPORT_SYMBOL_GPL(device_link_add);
4679ed98953SRafael J. Wysocki 
468e2ae9bccSSaravana Kannan /**
469e2ae9bccSSaravana Kannan  * device_link_wait_for_supplier - Add device to wait_for_suppliers list
470e2ae9bccSSaravana Kannan  * @consumer: Consumer device
471e2ae9bccSSaravana Kannan  *
472e2ae9bccSSaravana Kannan  * Marks the @consumer device as waiting for suppliers to become available by
473e2ae9bccSSaravana Kannan  * adding it to the wait_for_suppliers list. The consumer device will never be
474e2ae9bccSSaravana Kannan  * probed until it's removed from the wait_for_suppliers list.
475e2ae9bccSSaravana Kannan  *
476e2ae9bccSSaravana Kannan  * The caller is responsible for adding the links to the supplier devices once
477e2ae9bccSSaravana Kannan  * they are available and removing the @consumer device from the
478e2ae9bccSSaravana Kannan  * wait_for_suppliers list once links to all the suppliers have been created.
479e2ae9bccSSaravana Kannan  *
480e2ae9bccSSaravana Kannan  * This function is NOT meant to be called from the probe function of the
481e2ae9bccSSaravana Kannan  * consumer but rather from code that creates/adds the consumer device.
482e2ae9bccSSaravana Kannan  */
483bcbbcfd5SSaravana Kannan static void device_link_wait_for_supplier(struct device *consumer,
484bcbbcfd5SSaravana Kannan 					  bool need_for_probe)
485e2ae9bccSSaravana Kannan {
486e2ae9bccSSaravana Kannan 	mutex_lock(&wfs_lock);
487e2ae9bccSSaravana Kannan 	list_add_tail(&consumer->links.needs_suppliers, &wait_for_suppliers);
488bcbbcfd5SSaravana Kannan 	consumer->links.need_for_probe = need_for_probe;
489e2ae9bccSSaravana Kannan 	mutex_unlock(&wfs_lock);
490e2ae9bccSSaravana Kannan }
491e2ae9bccSSaravana Kannan 
492bcbbcfd5SSaravana Kannan static void device_link_wait_for_mandatory_supplier(struct device *consumer)
493bcbbcfd5SSaravana Kannan {
494bcbbcfd5SSaravana Kannan 	device_link_wait_for_supplier(consumer, true);
495bcbbcfd5SSaravana Kannan }
496bcbbcfd5SSaravana Kannan 
497bcbbcfd5SSaravana Kannan static void device_link_wait_for_optional_supplier(struct device *consumer)
498bcbbcfd5SSaravana Kannan {
499bcbbcfd5SSaravana Kannan 	device_link_wait_for_supplier(consumer, false);
500bcbbcfd5SSaravana Kannan }
501bcbbcfd5SSaravana Kannan 
502e2ae9bccSSaravana Kannan /**
503e2ae9bccSSaravana Kannan  * device_link_add_missing_supplier_links - Add links from consumer devices to
504e2ae9bccSSaravana Kannan  *					    supplier devices, leaving any
505e2ae9bccSSaravana Kannan  *					    consumer with inactive suppliers on
506e2ae9bccSSaravana Kannan  *					    the wait_for_suppliers list
507e2ae9bccSSaravana Kannan  *
508e2ae9bccSSaravana Kannan  * Loops through all consumers waiting on suppliers and tries to add all their
509e2ae9bccSSaravana Kannan  * supplier links. If that succeeds, the consumer device is removed from
510e2ae9bccSSaravana Kannan  * wait_for_suppliers list. Otherwise, they are left in the wait_for_suppliers
511e2ae9bccSSaravana Kannan  * list.  Devices left on the wait_for_suppliers list will not be probed.
512e2ae9bccSSaravana Kannan  *
513e2ae9bccSSaravana Kannan  * The fwnode add_links callback is expected to return 0 if it has found and
514e2ae9bccSSaravana Kannan  * added all the supplier links for the consumer device. It should return an
515e2ae9bccSSaravana Kannan  * error if it isn't able to do so.
516e2ae9bccSSaravana Kannan  *
517e2ae9bccSSaravana Kannan  * The caller of device_link_wait_for_supplier() is expected to call this once
518e2ae9bccSSaravana Kannan  * it's aware of potential suppliers becoming available.
519e2ae9bccSSaravana Kannan  */
520e2ae9bccSSaravana Kannan static void device_link_add_missing_supplier_links(void)
521e2ae9bccSSaravana Kannan {
522e2ae9bccSSaravana Kannan 	struct device *dev, *tmp;
523e2ae9bccSSaravana Kannan 
524e2ae9bccSSaravana Kannan 	mutex_lock(&wfs_lock);
525e2ae9bccSSaravana Kannan 	list_for_each_entry_safe(dev, tmp, &wait_for_suppliers,
5261745d299SSaravana Kannan 				 links.needs_suppliers) {
5271745d299SSaravana Kannan 		int ret = fwnode_call_int_op(dev->fwnode, add_links, dev);
5281745d299SSaravana Kannan 		if (!ret)
529e2ae9bccSSaravana Kannan 			list_del_init(&dev->links.needs_suppliers);
5301745d299SSaravana Kannan 		else if (ret != -ENODEV)
5311745d299SSaravana Kannan 			dev->links.need_for_probe = false;
5321745d299SSaravana Kannan 	}
533e2ae9bccSSaravana Kannan 	mutex_unlock(&wfs_lock);
534e2ae9bccSSaravana Kannan }
535e2ae9bccSSaravana Kannan 
5369ed98953SRafael J. Wysocki static void device_link_free(struct device_link *link)
5379ed98953SRafael J. Wysocki {
538a1fdbfbbSRafael J. Wysocki 	while (refcount_dec_not_one(&link->rpm_active))
539a1fdbfbbSRafael J. Wysocki 		pm_runtime_put(link->supplier);
540a1fdbfbbSRafael J. Wysocki 
5419ed98953SRafael J. Wysocki 	put_device(link->consumer);
5429ed98953SRafael J. Wysocki 	put_device(link->supplier);
5439ed98953SRafael J. Wysocki 	kfree(link);
5449ed98953SRafael J. Wysocki }
5459ed98953SRafael J. Wysocki 
5469ed98953SRafael J. Wysocki #ifdef CONFIG_SRCU
5479ed98953SRafael J. Wysocki static void __device_link_free_srcu(struct rcu_head *rhead)
5489ed98953SRafael J. Wysocki {
5499ed98953SRafael J. Wysocki 	device_link_free(container_of(rhead, struct device_link, rcu_head));
5509ed98953SRafael J. Wysocki }
5519ed98953SRafael J. Wysocki 
552ead18c23SLukas Wunner static void __device_link_del(struct kref *kref)
5539ed98953SRafael J. Wysocki {
554ead18c23SLukas Wunner 	struct device_link *link = container_of(kref, struct device_link, kref);
555ead18c23SLukas Wunner 
5568a4b3269SJerome Brunet 	dev_dbg(link->consumer, "Dropping the link to %s\n",
5579ed98953SRafael J. Wysocki 		dev_name(link->supplier));
5589ed98953SRafael J. Wysocki 
559baa8809fSRafael J. Wysocki 	if (link->flags & DL_FLAG_PM_RUNTIME)
560baa8809fSRafael J. Wysocki 		pm_runtime_drop_link(link->consumer);
561baa8809fSRafael J. Wysocki 
5629ed98953SRafael J. Wysocki 	list_del_rcu(&link->s_node);
5639ed98953SRafael J. Wysocki 	list_del_rcu(&link->c_node);
5649ed98953SRafael J. Wysocki 	call_srcu(&device_links_srcu, &link->rcu_head, __device_link_free_srcu);
5659ed98953SRafael J. Wysocki }
5669ed98953SRafael J. Wysocki #else /* !CONFIG_SRCU */
567ead18c23SLukas Wunner static void __device_link_del(struct kref *kref)
5689ed98953SRafael J. Wysocki {
569ead18c23SLukas Wunner 	struct device_link *link = container_of(kref, struct device_link, kref);
570ead18c23SLukas Wunner 
5719ed98953SRafael J. Wysocki 	dev_info(link->consumer, "Dropping the link to %s\n",
5729ed98953SRafael J. Wysocki 		 dev_name(link->supplier));
5739ed98953SRafael J. Wysocki 
574433986c2SLukas Wunner 	if (link->flags & DL_FLAG_PM_RUNTIME)
575433986c2SLukas Wunner 		pm_runtime_drop_link(link->consumer);
576433986c2SLukas Wunner 
5779ed98953SRafael J. Wysocki 	list_del(&link->s_node);
5789ed98953SRafael J. Wysocki 	list_del(&link->c_node);
5799ed98953SRafael J. Wysocki 	device_link_free(link);
5809ed98953SRafael J. Wysocki }
5819ed98953SRafael J. Wysocki #endif /* !CONFIG_SRCU */
5829ed98953SRafael J. Wysocki 
58372175d4eSRafael J. Wysocki static void device_link_put_kref(struct device_link *link)
58472175d4eSRafael J. Wysocki {
58572175d4eSRafael J. Wysocki 	if (link->flags & DL_FLAG_STATELESS)
58672175d4eSRafael J. Wysocki 		kref_put(&link->kref, __device_link_del);
58772175d4eSRafael J. Wysocki 	else
58872175d4eSRafael J. Wysocki 		WARN(1, "Unable to drop a managed device link reference\n");
58972175d4eSRafael J. Wysocki }
59072175d4eSRafael J. Wysocki 
5919ed98953SRafael J. Wysocki /**
59272175d4eSRafael J. Wysocki  * device_link_del - Delete a stateless link between two devices.
5939ed98953SRafael J. Wysocki  * @link: Device link to delete.
5949ed98953SRafael J. Wysocki  *
5959ed98953SRafael J. Wysocki  * The caller must ensure proper synchronization of this function with runtime
596ead18c23SLukas Wunner  * PM.  If the link was added multiple times, it needs to be deleted as often.
597ead18c23SLukas Wunner  * Care is required for hotplugged devices:  Their links are purged on removal
598ead18c23SLukas Wunner  * and calling device_link_del() is then no longer allowed.
5999ed98953SRafael J. Wysocki  */
6009ed98953SRafael J. Wysocki void device_link_del(struct device_link *link)
6019ed98953SRafael J. Wysocki {
6029ed98953SRafael J. Wysocki 	device_links_write_lock();
6039ed98953SRafael J. Wysocki 	device_pm_lock();
60472175d4eSRafael J. Wysocki 	device_link_put_kref(link);
6059ed98953SRafael J. Wysocki 	device_pm_unlock();
6069ed98953SRafael J. Wysocki 	device_links_write_unlock();
6079ed98953SRafael J. Wysocki }
6089ed98953SRafael J. Wysocki EXPORT_SYMBOL_GPL(device_link_del);
6099ed98953SRafael J. Wysocki 
610d8842211Spascal paillet /**
61172175d4eSRafael J. Wysocki  * device_link_remove - Delete a stateless link between two devices.
612d8842211Spascal paillet  * @consumer: Consumer end of the link.
613d8842211Spascal paillet  * @supplier: Supplier end of the link.
614d8842211Spascal paillet  *
615d8842211Spascal paillet  * The caller must ensure proper synchronization of this function with runtime
616d8842211Spascal paillet  * PM.
617d8842211Spascal paillet  */
618d8842211Spascal paillet void device_link_remove(void *consumer, struct device *supplier)
619d8842211Spascal paillet {
620d8842211Spascal paillet 	struct device_link *link;
621d8842211Spascal paillet 
622d8842211Spascal paillet 	if (WARN_ON(consumer == supplier))
623d8842211Spascal paillet 		return;
624d8842211Spascal paillet 
625d8842211Spascal paillet 	device_links_write_lock();
626d8842211Spascal paillet 	device_pm_lock();
627d8842211Spascal paillet 
628d8842211Spascal paillet 	list_for_each_entry(link, &supplier->links.consumers, s_node) {
629d8842211Spascal paillet 		if (link->consumer == consumer) {
63072175d4eSRafael J. Wysocki 			device_link_put_kref(link);
631d8842211Spascal paillet 			break;
632d8842211Spascal paillet 		}
633d8842211Spascal paillet 	}
634d8842211Spascal paillet 
635d8842211Spascal paillet 	device_pm_unlock();
636d8842211Spascal paillet 	device_links_write_unlock();
637d8842211Spascal paillet }
638d8842211Spascal paillet EXPORT_SYMBOL_GPL(device_link_remove);
639d8842211Spascal paillet 
6409ed98953SRafael J. Wysocki static void device_links_missing_supplier(struct device *dev)
6419ed98953SRafael J. Wysocki {
6429ed98953SRafael J. Wysocki 	struct device_link *link;
6439ed98953SRafael J. Wysocki 
6449ed98953SRafael J. Wysocki 	list_for_each_entry(link, &dev->links.suppliers, c_node)
6459ed98953SRafael J. Wysocki 		if (link->status == DL_STATE_CONSUMER_PROBE)
6469ed98953SRafael J. Wysocki 			WRITE_ONCE(link->status, DL_STATE_AVAILABLE);
6479ed98953SRafael J. Wysocki }
6489ed98953SRafael J. Wysocki 
6499ed98953SRafael J. Wysocki /**
6509ed98953SRafael J. Wysocki  * device_links_check_suppliers - Check presence of supplier drivers.
6519ed98953SRafael J. Wysocki  * @dev: Consumer device.
6529ed98953SRafael J. Wysocki  *
6539ed98953SRafael J. Wysocki  * Check links from this device to any suppliers.  Walk the list of the device's
6549ed98953SRafael J. Wysocki  * links to suppliers and see if all of them are available.  If not, simply
6559ed98953SRafael J. Wysocki  * return -EPROBE_DEFER.
6569ed98953SRafael J. Wysocki  *
6579ed98953SRafael J. Wysocki  * We need to guarantee that the supplier will not go away after the check has
6589ed98953SRafael J. Wysocki  * been positive here.  It only can go away in __device_release_driver() and
6599ed98953SRafael J. Wysocki  * that function  checks the device's links to consumers.  This means we need to
6609ed98953SRafael J. Wysocki  * mark the link as "consumer probe in progress" to make the supplier removal
6619ed98953SRafael J. Wysocki  * wait for us to complete (or bad things may happen).
6629ed98953SRafael J. Wysocki  *
663515db266SRafael J. Wysocki  * Links without the DL_FLAG_MANAGED flag set are ignored.
6649ed98953SRafael J. Wysocki  */
6659ed98953SRafael J. Wysocki int device_links_check_suppliers(struct device *dev)
6669ed98953SRafael J. Wysocki {
6679ed98953SRafael J. Wysocki 	struct device_link *link;
6689ed98953SRafael J. Wysocki 	int ret = 0;
6699ed98953SRafael J. Wysocki 
670e2ae9bccSSaravana Kannan 	/*
671e2ae9bccSSaravana Kannan 	 * Device waiting for supplier to become available is not allowed to
672e2ae9bccSSaravana Kannan 	 * probe.
673e2ae9bccSSaravana Kannan 	 */
674e2ae9bccSSaravana Kannan 	mutex_lock(&wfs_lock);
675bcbbcfd5SSaravana Kannan 	if (!list_empty(&dev->links.needs_suppliers) &&
676bcbbcfd5SSaravana Kannan 	    dev->links.need_for_probe) {
677e2ae9bccSSaravana Kannan 		mutex_unlock(&wfs_lock);
678e2ae9bccSSaravana Kannan 		return -EPROBE_DEFER;
679e2ae9bccSSaravana Kannan 	}
680e2ae9bccSSaravana Kannan 	mutex_unlock(&wfs_lock);
681e2ae9bccSSaravana Kannan 
6829ed98953SRafael J. Wysocki 	device_links_write_lock();
6839ed98953SRafael J. Wysocki 
6849ed98953SRafael J. Wysocki 	list_for_each_entry(link, &dev->links.suppliers, c_node) {
68505ef983eSSaravana Kannan 		if (!(link->flags & DL_FLAG_MANAGED) ||
68605ef983eSSaravana Kannan 		    link->flags & DL_FLAG_SYNC_STATE_ONLY)
6879ed98953SRafael J. Wysocki 			continue;
6889ed98953SRafael J. Wysocki 
6899ed98953SRafael J. Wysocki 		if (link->status != DL_STATE_AVAILABLE) {
6909ed98953SRafael J. Wysocki 			device_links_missing_supplier(dev);
6919ed98953SRafael J. Wysocki 			ret = -EPROBE_DEFER;
6929ed98953SRafael J. Wysocki 			break;
6939ed98953SRafael J. Wysocki 		}
6949ed98953SRafael J. Wysocki 		WRITE_ONCE(link->status, DL_STATE_CONSUMER_PROBE);
6959ed98953SRafael J. Wysocki 	}
6969ed98953SRafael J. Wysocki 	dev->links.status = DL_DEV_PROBING;
6979ed98953SRafael J. Wysocki 
6989ed98953SRafael J. Wysocki 	device_links_write_unlock();
6999ed98953SRafael J. Wysocki 	return ret;
7009ed98953SRafael J. Wysocki }
7019ed98953SRafael J. Wysocki 
70226e77708SSaravana Kannan /**
70326e77708SSaravana Kannan  * __device_links_queue_sync_state - Queue a device for sync_state() callback
70426e77708SSaravana Kannan  * @dev: Device to call sync_state() on
70526e77708SSaravana Kannan  * @list: List head to queue the @dev on
70626e77708SSaravana Kannan  *
70726e77708SSaravana Kannan  * Queues a device for a sync_state() callback when the device links write lock
70826e77708SSaravana Kannan  * isn't held. This allows the sync_state() execution flow to use device links
70926e77708SSaravana Kannan  * APIs.  The caller must ensure this function is called with
71026e77708SSaravana Kannan  * device_links_write_lock() held.
71126e77708SSaravana Kannan  *
71226e77708SSaravana Kannan  * This function does a get_device() to make sure the device is not freed while
71326e77708SSaravana Kannan  * on this list.
71426e77708SSaravana Kannan  *
71526e77708SSaravana Kannan  * So the caller must also ensure that device_links_flush_sync_list() is called
71626e77708SSaravana Kannan  * as soon as the caller releases device_links_write_lock().  This is necessary
71726e77708SSaravana Kannan  * to make sure the sync_state() is called in a timely fashion and the
71826e77708SSaravana Kannan  * put_device() is called on this device.
71926e77708SSaravana Kannan  */
72026e77708SSaravana Kannan static void __device_links_queue_sync_state(struct device *dev,
72126e77708SSaravana Kannan 					    struct list_head *list)
722fc5a251dSSaravana Kannan {
723fc5a251dSSaravana Kannan 	struct device_link *link;
724fc5a251dSSaravana Kannan 
725fc5a251dSSaravana Kannan 	if (dev->state_synced)
726fc5a251dSSaravana Kannan 		return;
727fc5a251dSSaravana Kannan 
728fc5a251dSSaravana Kannan 	list_for_each_entry(link, &dev->links.consumers, s_node) {
729fc5a251dSSaravana Kannan 		if (!(link->flags & DL_FLAG_MANAGED))
730fc5a251dSSaravana Kannan 			continue;
731fc5a251dSSaravana Kannan 		if (link->status != DL_STATE_ACTIVE)
732fc5a251dSSaravana Kannan 			return;
733fc5a251dSSaravana Kannan 	}
734fc5a251dSSaravana Kannan 
73526e77708SSaravana Kannan 	/*
73626e77708SSaravana Kannan 	 * Set the flag here to avoid adding the same device to a list more
73726e77708SSaravana Kannan 	 * than once. This can happen if new consumers get added to the device
73826e77708SSaravana Kannan 	 * and probed before the list is flushed.
73926e77708SSaravana Kannan 	 */
74026e77708SSaravana Kannan 	dev->state_synced = true;
74126e77708SSaravana Kannan 
74226e77708SSaravana Kannan 	if (WARN_ON(!list_empty(&dev->links.defer_sync)))
74326e77708SSaravana Kannan 		return;
74426e77708SSaravana Kannan 
74526e77708SSaravana Kannan 	get_device(dev);
74626e77708SSaravana Kannan 	list_add_tail(&dev->links.defer_sync, list);
74726e77708SSaravana Kannan }
74826e77708SSaravana Kannan 
74926e77708SSaravana Kannan /**
75026e77708SSaravana Kannan  * device_links_flush_sync_list - Call sync_state() on a list of devices
75126e77708SSaravana Kannan  * @list: List of devices to call sync_state() on
75226e77708SSaravana Kannan  *
75326e77708SSaravana Kannan  * Calls sync_state() on all the devices that have been queued for it. This
75426e77708SSaravana Kannan  * function is used in conjunction with __device_links_queue_sync_state().
75526e77708SSaravana Kannan  */
75626e77708SSaravana Kannan static void device_links_flush_sync_list(struct list_head *list)
75726e77708SSaravana Kannan {
75826e77708SSaravana Kannan 	struct device *dev, *tmp;
75926e77708SSaravana Kannan 
76026e77708SSaravana Kannan 	list_for_each_entry_safe(dev, tmp, list, links.defer_sync) {
76126e77708SSaravana Kannan 		list_del_init(&dev->links.defer_sync);
76226e77708SSaravana Kannan 
76326e77708SSaravana Kannan 		device_lock(dev);
76426e77708SSaravana Kannan 
765fc5a251dSSaravana Kannan 		if (dev->bus->sync_state)
766fc5a251dSSaravana Kannan 			dev->bus->sync_state(dev);
767fc5a251dSSaravana Kannan 		else if (dev->driver && dev->driver->sync_state)
768fc5a251dSSaravana Kannan 			dev->driver->sync_state(dev);
769fc5a251dSSaravana Kannan 
77026e77708SSaravana Kannan 		device_unlock(dev);
77126e77708SSaravana Kannan 
77226e77708SSaravana Kannan 		put_device(dev);
77326e77708SSaravana Kannan 	}
774fc5a251dSSaravana Kannan }
775fc5a251dSSaravana Kannan 
776fc5a251dSSaravana Kannan void device_links_supplier_sync_state_pause(void)
777fc5a251dSSaravana Kannan {
778fc5a251dSSaravana Kannan 	device_links_write_lock();
779fc5a251dSSaravana Kannan 	defer_sync_state_count++;
780fc5a251dSSaravana Kannan 	device_links_write_unlock();
781fc5a251dSSaravana Kannan }
782fc5a251dSSaravana Kannan 
783fc5a251dSSaravana Kannan void device_links_supplier_sync_state_resume(void)
784fc5a251dSSaravana Kannan {
785fc5a251dSSaravana Kannan 	struct device *dev, *tmp;
78626e77708SSaravana Kannan 	LIST_HEAD(sync_list);
787fc5a251dSSaravana Kannan 
788fc5a251dSSaravana Kannan 	device_links_write_lock();
789fc5a251dSSaravana Kannan 	if (!defer_sync_state_count) {
790fc5a251dSSaravana Kannan 		WARN(true, "Unmatched sync_state pause/resume!");
791fc5a251dSSaravana Kannan 		goto out;
792fc5a251dSSaravana Kannan 	}
793fc5a251dSSaravana Kannan 	defer_sync_state_count--;
794fc5a251dSSaravana Kannan 	if (defer_sync_state_count)
795fc5a251dSSaravana Kannan 		goto out;
796fc5a251dSSaravana Kannan 
797fc5a251dSSaravana Kannan 	list_for_each_entry_safe(dev, tmp, &deferred_sync, links.defer_sync) {
79826e77708SSaravana Kannan 		/*
79926e77708SSaravana Kannan 		 * Delete from deferred_sync list before queuing it to
80026e77708SSaravana Kannan 		 * sync_list because defer_sync is used for both lists.
80126e77708SSaravana Kannan 		 */
802fc5a251dSSaravana Kannan 		list_del_init(&dev->links.defer_sync);
80326e77708SSaravana Kannan 		__device_links_queue_sync_state(dev, &sync_list);
804fc5a251dSSaravana Kannan 	}
805fc5a251dSSaravana Kannan out:
806fc5a251dSSaravana Kannan 	device_links_write_unlock();
80726e77708SSaravana Kannan 
80826e77708SSaravana Kannan 	device_links_flush_sync_list(&sync_list);
809fc5a251dSSaravana Kannan }
810fc5a251dSSaravana Kannan 
811fc5a251dSSaravana Kannan static int sync_state_resume_initcall(void)
812fc5a251dSSaravana Kannan {
813fc5a251dSSaravana Kannan 	device_links_supplier_sync_state_resume();
814fc5a251dSSaravana Kannan 	return 0;
815fc5a251dSSaravana Kannan }
816fc5a251dSSaravana Kannan late_initcall(sync_state_resume_initcall);
817fc5a251dSSaravana Kannan 
818fc5a251dSSaravana Kannan static void __device_links_supplier_defer_sync(struct device *sup)
819fc5a251dSSaravana Kannan {
820fc5a251dSSaravana Kannan 	if (list_empty(&sup->links.defer_sync))
821fc5a251dSSaravana Kannan 		list_add_tail(&sup->links.defer_sync, &deferred_sync);
822fc5a251dSSaravana Kannan }
823fc5a251dSSaravana Kannan 
8249ed98953SRafael J. Wysocki /**
8259ed98953SRafael J. Wysocki  * device_links_driver_bound - Update device links after probing its driver.
8269ed98953SRafael J. Wysocki  * @dev: Device to update the links for.
8279ed98953SRafael J. Wysocki  *
8289ed98953SRafael J. Wysocki  * The probe has been successful, so update links from this device to any
8299ed98953SRafael J. Wysocki  * consumers by changing their status to "available".
8309ed98953SRafael J. Wysocki  *
8319ed98953SRafael J. Wysocki  * Also change the status of @dev's links to suppliers to "active".
8329ed98953SRafael J. Wysocki  *
833515db266SRafael J. Wysocki  * Links without the DL_FLAG_MANAGED flag set are ignored.
8349ed98953SRafael J. Wysocki  */
8359ed98953SRafael J. Wysocki void device_links_driver_bound(struct device *dev)
8369ed98953SRafael J. Wysocki {
8379ed98953SRafael J. Wysocki 	struct device_link *link;
83826e77708SSaravana Kannan 	LIST_HEAD(sync_list);
8399ed98953SRafael J. Wysocki 
840bcbbcfd5SSaravana Kannan 	/*
841bcbbcfd5SSaravana Kannan 	 * If a device probes successfully, it's expected to have created all
842bcbbcfd5SSaravana Kannan 	 * the device links it needs to or make new device links as it needs
843bcbbcfd5SSaravana Kannan 	 * them. So, it no longer needs to wait on any suppliers.
844bcbbcfd5SSaravana Kannan 	 */
845bcbbcfd5SSaravana Kannan 	mutex_lock(&wfs_lock);
846bcbbcfd5SSaravana Kannan 	list_del_init(&dev->links.needs_suppliers);
847bcbbcfd5SSaravana Kannan 	mutex_unlock(&wfs_lock);
848bcbbcfd5SSaravana Kannan 
8499ed98953SRafael J. Wysocki 	device_links_write_lock();
8509ed98953SRafael J. Wysocki 
8519ed98953SRafael J. Wysocki 	list_for_each_entry(link, &dev->links.consumers, s_node) {
852515db266SRafael J. Wysocki 		if (!(link->flags & DL_FLAG_MANAGED))
8539ed98953SRafael J. Wysocki 			continue;
8549ed98953SRafael J. Wysocki 
85515cfb094SRafael J. Wysocki 		/*
85615cfb094SRafael J. Wysocki 		 * Links created during consumer probe may be in the "consumer
85715cfb094SRafael J. Wysocki 		 * probe" state to start with if the supplier is still probing
85815cfb094SRafael J. Wysocki 		 * when they are created and they may become "active" if the
85915cfb094SRafael J. Wysocki 		 * consumer probe returns first.  Skip them here.
86015cfb094SRafael J. Wysocki 		 */
86115cfb094SRafael J. Wysocki 		if (link->status == DL_STATE_CONSUMER_PROBE ||
86215cfb094SRafael J. Wysocki 		    link->status == DL_STATE_ACTIVE)
86315cfb094SRafael J. Wysocki 			continue;
86415cfb094SRafael J. Wysocki 
8659ed98953SRafael J. Wysocki 		WARN_ON(link->status != DL_STATE_DORMANT);
8669ed98953SRafael J. Wysocki 		WRITE_ONCE(link->status, DL_STATE_AVAILABLE);
867e7dd4010SRafael J. Wysocki 
868e7dd4010SRafael J. Wysocki 		if (link->flags & DL_FLAG_AUTOPROBE_CONSUMER)
869e7dd4010SRafael J. Wysocki 			driver_deferred_probe_add(link->consumer);
8709ed98953SRafael J. Wysocki 	}
8719ed98953SRafael J. Wysocki 
8729ed98953SRafael J. Wysocki 	list_for_each_entry(link, &dev->links.suppliers, c_node) {
873515db266SRafael J. Wysocki 		if (!(link->flags & DL_FLAG_MANAGED))
8749ed98953SRafael J. Wysocki 			continue;
8759ed98953SRafael J. Wysocki 
8769ed98953SRafael J. Wysocki 		WARN_ON(link->status != DL_STATE_CONSUMER_PROBE);
8779ed98953SRafael J. Wysocki 		WRITE_ONCE(link->status, DL_STATE_ACTIVE);
878fc5a251dSSaravana Kannan 
879fc5a251dSSaravana Kannan 		if (defer_sync_state_count)
880fc5a251dSSaravana Kannan 			__device_links_supplier_defer_sync(link->supplier);
881fc5a251dSSaravana Kannan 		else
88226e77708SSaravana Kannan 			__device_links_queue_sync_state(link->supplier,
88326e77708SSaravana Kannan 							&sync_list);
8849ed98953SRafael J. Wysocki 	}
8859ed98953SRafael J. Wysocki 
8869ed98953SRafael J. Wysocki 	dev->links.status = DL_DEV_DRIVER_BOUND;
8879ed98953SRafael J. Wysocki 
8889ed98953SRafael J. Wysocki 	device_links_write_unlock();
88926e77708SSaravana Kannan 
89026e77708SSaravana Kannan 	device_links_flush_sync_list(&sync_list);
8919ed98953SRafael J. Wysocki }
8929ed98953SRafael J. Wysocki 
893515db266SRafael J. Wysocki static void device_link_drop_managed(struct device_link *link)
894515db266SRafael J. Wysocki {
895515db266SRafael J. Wysocki 	link->flags &= ~DL_FLAG_MANAGED;
896515db266SRafael J. Wysocki 	WRITE_ONCE(link->status, DL_STATE_NONE);
897515db266SRafael J. Wysocki 	kref_put(&link->kref, __device_link_del);
898515db266SRafael J. Wysocki }
899515db266SRafael J. Wysocki 
9009ed98953SRafael J. Wysocki /**
9019ed98953SRafael J. Wysocki  * __device_links_no_driver - Update links of a device without a driver.
9029ed98953SRafael J. Wysocki  * @dev: Device without a drvier.
9039ed98953SRafael J. Wysocki  *
9049ed98953SRafael J. Wysocki  * Delete all non-persistent links from this device to any suppliers.
9059ed98953SRafael J. Wysocki  *
9069ed98953SRafael J. Wysocki  * Persistent links stay around, but their status is changed to "available",
9079ed98953SRafael J. Wysocki  * unless they already are in the "supplier unbind in progress" state in which
9089ed98953SRafael J. Wysocki  * case they need not be updated.
9099ed98953SRafael J. Wysocki  *
910515db266SRafael J. Wysocki  * Links without the DL_FLAG_MANAGED flag set are ignored.
9119ed98953SRafael J. Wysocki  */
9129ed98953SRafael J. Wysocki static void __device_links_no_driver(struct device *dev)
9139ed98953SRafael J. Wysocki {
9149ed98953SRafael J. Wysocki 	struct device_link *link, *ln;
9159ed98953SRafael J. Wysocki 
9169ed98953SRafael J. Wysocki 	list_for_each_entry_safe_reverse(link, ln, &dev->links.suppliers, c_node) {
917515db266SRafael J. Wysocki 		if (!(link->flags & DL_FLAG_MANAGED))
9189ed98953SRafael J. Wysocki 			continue;
9199ed98953SRafael J. Wysocki 
920e88728f4SVivek Gautam 		if (link->flags & DL_FLAG_AUTOREMOVE_CONSUMER)
921515db266SRafael J. Wysocki 			device_link_drop_managed(link);
92215cfb094SRafael J. Wysocki 		else if (link->status == DL_STATE_CONSUMER_PROBE ||
92315cfb094SRafael J. Wysocki 			 link->status == DL_STATE_ACTIVE)
9249ed98953SRafael J. Wysocki 			WRITE_ONCE(link->status, DL_STATE_AVAILABLE);
9259ed98953SRafael J. Wysocki 	}
9269ed98953SRafael J. Wysocki 
9279ed98953SRafael J. Wysocki 	dev->links.status = DL_DEV_NO_DRIVER;
9289ed98953SRafael J. Wysocki }
9299ed98953SRafael J. Wysocki 
93015cfb094SRafael J. Wysocki /**
93115cfb094SRafael J. Wysocki  * device_links_no_driver - Update links after failing driver probe.
93215cfb094SRafael J. Wysocki  * @dev: Device whose driver has just failed to probe.
93315cfb094SRafael J. Wysocki  *
93415cfb094SRafael J. Wysocki  * Clean up leftover links to consumers for @dev and invoke
93515cfb094SRafael J. Wysocki  * %__device_links_no_driver() to update links to suppliers for it as
93615cfb094SRafael J. Wysocki  * appropriate.
93715cfb094SRafael J. Wysocki  *
938515db266SRafael J. Wysocki  * Links without the DL_FLAG_MANAGED flag set are ignored.
93915cfb094SRafael J. Wysocki  */
9409ed98953SRafael J. Wysocki void device_links_no_driver(struct device *dev)
9419ed98953SRafael J. Wysocki {
94215cfb094SRafael J. Wysocki 	struct device_link *link;
94315cfb094SRafael J. Wysocki 
9449ed98953SRafael J. Wysocki 	device_links_write_lock();
94515cfb094SRafael J. Wysocki 
94615cfb094SRafael J. Wysocki 	list_for_each_entry(link, &dev->links.consumers, s_node) {
947515db266SRafael J. Wysocki 		if (!(link->flags & DL_FLAG_MANAGED))
94815cfb094SRafael J. Wysocki 			continue;
94915cfb094SRafael J. Wysocki 
95015cfb094SRafael J. Wysocki 		/*
95115cfb094SRafael J. Wysocki 		 * The probe has failed, so if the status of the link is
95215cfb094SRafael J. Wysocki 		 * "consumer probe" or "active", it must have been added by
95315cfb094SRafael J. Wysocki 		 * a probing consumer while this device was still probing.
95415cfb094SRafael J. Wysocki 		 * Change its state to "dormant", as it represents a valid
95515cfb094SRafael J. Wysocki 		 * relationship, but it is not functionally meaningful.
95615cfb094SRafael J. Wysocki 		 */
95715cfb094SRafael J. Wysocki 		if (link->status == DL_STATE_CONSUMER_PROBE ||
95815cfb094SRafael J. Wysocki 		    link->status == DL_STATE_ACTIVE)
95915cfb094SRafael J. Wysocki 			WRITE_ONCE(link->status, DL_STATE_DORMANT);
96015cfb094SRafael J. Wysocki 	}
96115cfb094SRafael J. Wysocki 
9629ed98953SRafael J. Wysocki 	__device_links_no_driver(dev);
96315cfb094SRafael J. Wysocki 
9649ed98953SRafael J. Wysocki 	device_links_write_unlock();
9659ed98953SRafael J. Wysocki }
9669ed98953SRafael J. Wysocki 
9679ed98953SRafael J. Wysocki /**
9689ed98953SRafael J. Wysocki  * device_links_driver_cleanup - Update links after driver removal.
9699ed98953SRafael J. Wysocki  * @dev: Device whose driver has just gone away.
9709ed98953SRafael J. Wysocki  *
9719ed98953SRafael J. Wysocki  * Update links to consumers for @dev by changing their status to "dormant" and
9729ed98953SRafael J. Wysocki  * invoke %__device_links_no_driver() to update links to suppliers for it as
9739ed98953SRafael J. Wysocki  * appropriate.
9749ed98953SRafael J. Wysocki  *
975515db266SRafael J. Wysocki  * Links without the DL_FLAG_MANAGED flag set are ignored.
9769ed98953SRafael J. Wysocki  */
9779ed98953SRafael J. Wysocki void device_links_driver_cleanup(struct device *dev)
9789ed98953SRafael J. Wysocki {
979c8d50986SRafael J. Wysocki 	struct device_link *link, *ln;
9809ed98953SRafael J. Wysocki 
9819ed98953SRafael J. Wysocki 	device_links_write_lock();
9829ed98953SRafael J. Wysocki 
983c8d50986SRafael J. Wysocki 	list_for_each_entry_safe(link, ln, &dev->links.consumers, s_node) {
984515db266SRafael J. Wysocki 		if (!(link->flags & DL_FLAG_MANAGED))
9859ed98953SRafael J. Wysocki 			continue;
9869ed98953SRafael J. Wysocki 
987e88728f4SVivek Gautam 		WARN_ON(link->flags & DL_FLAG_AUTOREMOVE_CONSUMER);
9889ed98953SRafael J. Wysocki 		WARN_ON(link->status != DL_STATE_SUPPLIER_UNBIND);
9891689cac5SVivek Gautam 
9901689cac5SVivek Gautam 		/*
9911689cac5SVivek Gautam 		 * autoremove the links between this @dev and its consumer
9921689cac5SVivek Gautam 		 * devices that are not active, i.e. where the link state
9931689cac5SVivek Gautam 		 * has moved to DL_STATE_SUPPLIER_UNBIND.
9941689cac5SVivek Gautam 		 */
9951689cac5SVivek Gautam 		if (link->status == DL_STATE_SUPPLIER_UNBIND &&
9961689cac5SVivek Gautam 		    link->flags & DL_FLAG_AUTOREMOVE_SUPPLIER)
997515db266SRafael J. Wysocki 			device_link_drop_managed(link);
9981689cac5SVivek Gautam 
9999ed98953SRafael J. Wysocki 		WRITE_ONCE(link->status, DL_STATE_DORMANT);
10009ed98953SRafael J. Wysocki 	}
10019ed98953SRafael J. Wysocki 
1002fc5a251dSSaravana Kannan 	list_del_init(&dev->links.defer_sync);
10039ed98953SRafael J. Wysocki 	__device_links_no_driver(dev);
10049ed98953SRafael J. Wysocki 
10059ed98953SRafael J. Wysocki 	device_links_write_unlock();
10069ed98953SRafael J. Wysocki }
10079ed98953SRafael J. Wysocki 
10089ed98953SRafael J. Wysocki /**
10099ed98953SRafael J. Wysocki  * device_links_busy - Check if there are any busy links to consumers.
10109ed98953SRafael J. Wysocki  * @dev: Device to check.
10119ed98953SRafael J. Wysocki  *
10129ed98953SRafael J. Wysocki  * Check each consumer of the device and return 'true' if its link's status
10139ed98953SRafael J. Wysocki  * is one of "consumer probe" or "active" (meaning that the given consumer is
10149ed98953SRafael J. Wysocki  * probing right now or its driver is present).  Otherwise, change the link
10159ed98953SRafael J. Wysocki  * state to "supplier unbind" to prevent the consumer from being probed
10169ed98953SRafael J. Wysocki  * successfully going forward.
10179ed98953SRafael J. Wysocki  *
10189ed98953SRafael J. Wysocki  * Return 'false' if there are no probing or active consumers.
10199ed98953SRafael J. Wysocki  *
1020515db266SRafael J. Wysocki  * Links without the DL_FLAG_MANAGED flag set are ignored.
10219ed98953SRafael J. Wysocki  */
10229ed98953SRafael J. Wysocki bool device_links_busy(struct device *dev)
10239ed98953SRafael J. Wysocki {
10249ed98953SRafael J. Wysocki 	struct device_link *link;
10259ed98953SRafael J. Wysocki 	bool ret = false;
10269ed98953SRafael J. Wysocki 
10279ed98953SRafael J. Wysocki 	device_links_write_lock();
10289ed98953SRafael J. Wysocki 
10299ed98953SRafael J. Wysocki 	list_for_each_entry(link, &dev->links.consumers, s_node) {
1030515db266SRafael J. Wysocki 		if (!(link->flags & DL_FLAG_MANAGED))
10319ed98953SRafael J. Wysocki 			continue;
10329ed98953SRafael J. Wysocki 
10339ed98953SRafael J. Wysocki 		if (link->status == DL_STATE_CONSUMER_PROBE
10349ed98953SRafael J. Wysocki 		    || link->status == DL_STATE_ACTIVE) {
10359ed98953SRafael J. Wysocki 			ret = true;
10369ed98953SRafael J. Wysocki 			break;
10379ed98953SRafael J. Wysocki 		}
10389ed98953SRafael J. Wysocki 		WRITE_ONCE(link->status, DL_STATE_SUPPLIER_UNBIND);
10399ed98953SRafael J. Wysocki 	}
10409ed98953SRafael J. Wysocki 
10419ed98953SRafael J. Wysocki 	dev->links.status = DL_DEV_UNBINDING;
10429ed98953SRafael J. Wysocki 
10439ed98953SRafael J. Wysocki 	device_links_write_unlock();
10449ed98953SRafael J. Wysocki 	return ret;
10459ed98953SRafael J. Wysocki }
10469ed98953SRafael J. Wysocki 
10479ed98953SRafael J. Wysocki /**
10489ed98953SRafael J. Wysocki  * device_links_unbind_consumers - Force unbind consumers of the given device.
10499ed98953SRafael J. Wysocki  * @dev: Device to unbind the consumers of.
10509ed98953SRafael J. Wysocki  *
10519ed98953SRafael J. Wysocki  * Walk the list of links to consumers for @dev and if any of them is in the
10529ed98953SRafael J. Wysocki  * "consumer probe" state, wait for all device probes in progress to complete
10539ed98953SRafael J. Wysocki  * and start over.
10549ed98953SRafael J. Wysocki  *
10559ed98953SRafael J. Wysocki  * If that's not the case, change the status of the link to "supplier unbind"
10569ed98953SRafael J. Wysocki  * and check if the link was in the "active" state.  If so, force the consumer
10579ed98953SRafael J. Wysocki  * driver to unbind and start over (the consumer will not re-probe as we have
10589ed98953SRafael J. Wysocki  * changed the state of the link already).
10599ed98953SRafael J. Wysocki  *
1060515db266SRafael J. Wysocki  * Links without the DL_FLAG_MANAGED flag set are ignored.
10619ed98953SRafael J. Wysocki  */
10629ed98953SRafael J. Wysocki void device_links_unbind_consumers(struct device *dev)
10639ed98953SRafael J. Wysocki {
10649ed98953SRafael J. Wysocki 	struct device_link *link;
10659ed98953SRafael J. Wysocki 
10669ed98953SRafael J. Wysocki  start:
10679ed98953SRafael J. Wysocki 	device_links_write_lock();
10689ed98953SRafael J. Wysocki 
10699ed98953SRafael J. Wysocki 	list_for_each_entry(link, &dev->links.consumers, s_node) {
10709ed98953SRafael J. Wysocki 		enum device_link_state status;
10719ed98953SRafael J. Wysocki 
107205ef983eSSaravana Kannan 		if (!(link->flags & DL_FLAG_MANAGED) ||
107305ef983eSSaravana Kannan 		    link->flags & DL_FLAG_SYNC_STATE_ONLY)
10749ed98953SRafael J. Wysocki 			continue;
10759ed98953SRafael J. Wysocki 
10769ed98953SRafael J. Wysocki 		status = link->status;
10779ed98953SRafael J. Wysocki 		if (status == DL_STATE_CONSUMER_PROBE) {
10789ed98953SRafael J. Wysocki 			device_links_write_unlock();
10799ed98953SRafael J. Wysocki 
10809ed98953SRafael J. Wysocki 			wait_for_device_probe();
10819ed98953SRafael J. Wysocki 			goto start;
10829ed98953SRafael J. Wysocki 		}
10839ed98953SRafael J. Wysocki 		WRITE_ONCE(link->status, DL_STATE_SUPPLIER_UNBIND);
10849ed98953SRafael J. Wysocki 		if (status == DL_STATE_ACTIVE) {
10859ed98953SRafael J. Wysocki 			struct device *consumer = link->consumer;
10869ed98953SRafael J. Wysocki 
10879ed98953SRafael J. Wysocki 			get_device(consumer);
10889ed98953SRafael J. Wysocki 
10899ed98953SRafael J. Wysocki 			device_links_write_unlock();
10909ed98953SRafael J. Wysocki 
10919ed98953SRafael J. Wysocki 			device_release_driver_internal(consumer, NULL,
10929ed98953SRafael J. Wysocki 						       consumer->parent);
10939ed98953SRafael J. Wysocki 			put_device(consumer);
10949ed98953SRafael J. Wysocki 			goto start;
10959ed98953SRafael J. Wysocki 		}
10969ed98953SRafael J. Wysocki 	}
10979ed98953SRafael J. Wysocki 
10989ed98953SRafael J. Wysocki 	device_links_write_unlock();
10999ed98953SRafael J. Wysocki }
11009ed98953SRafael J. Wysocki 
11019ed98953SRafael J. Wysocki /**
11029ed98953SRafael J. Wysocki  * device_links_purge - Delete existing links to other devices.
11039ed98953SRafael J. Wysocki  * @dev: Target device.
11049ed98953SRafael J. Wysocki  */
11059ed98953SRafael J. Wysocki static void device_links_purge(struct device *dev)
11069ed98953SRafael J. Wysocki {
11079ed98953SRafael J. Wysocki 	struct device_link *link, *ln;
11089ed98953SRafael J. Wysocki 
1109e2ae9bccSSaravana Kannan 	mutex_lock(&wfs_lock);
1110e2ae9bccSSaravana Kannan 	list_del(&dev->links.needs_suppliers);
1111e2ae9bccSSaravana Kannan 	mutex_unlock(&wfs_lock);
1112e2ae9bccSSaravana Kannan 
11139ed98953SRafael J. Wysocki 	/*
11149ed98953SRafael J. Wysocki 	 * Delete all of the remaining links from this device to any other
11159ed98953SRafael J. Wysocki 	 * devices (either consumers or suppliers).
11169ed98953SRafael J. Wysocki 	 */
11179ed98953SRafael J. Wysocki 	device_links_write_lock();
11189ed98953SRafael J. Wysocki 
11199ed98953SRafael J. Wysocki 	list_for_each_entry_safe_reverse(link, ln, &dev->links.suppliers, c_node) {
11209ed98953SRafael J. Wysocki 		WARN_ON(link->status == DL_STATE_ACTIVE);
1121ead18c23SLukas Wunner 		__device_link_del(&link->kref);
11229ed98953SRafael J. Wysocki 	}
11239ed98953SRafael J. Wysocki 
11249ed98953SRafael J. Wysocki 	list_for_each_entry_safe_reverse(link, ln, &dev->links.consumers, s_node) {
11259ed98953SRafael J. Wysocki 		WARN_ON(link->status != DL_STATE_DORMANT &&
11269ed98953SRafael J. Wysocki 			link->status != DL_STATE_NONE);
1127ead18c23SLukas Wunner 		__device_link_del(&link->kref);
11289ed98953SRafael J. Wysocki 	}
11299ed98953SRafael J. Wysocki 
11309ed98953SRafael J. Wysocki 	device_links_write_unlock();
11319ed98953SRafael J. Wysocki }
11329ed98953SRafael J. Wysocki 
11339ed98953SRafael J. Wysocki /* Device links support end. */
11349ed98953SRafael J. Wysocki 
11351da177e4SLinus Torvalds int (*platform_notify)(struct device *dev) = NULL;
11361da177e4SLinus Torvalds int (*platform_notify_remove)(struct device *dev) = NULL;
1137e105b8bfSDan Williams static struct kobject *dev_kobj;
1138e105b8bfSDan Williams struct kobject *sysfs_dev_char_kobj;
1139e105b8bfSDan Williams struct kobject *sysfs_dev_block_kobj;
11401da177e4SLinus Torvalds 
11415e33bc41SRafael J. Wysocki static DEFINE_MUTEX(device_hotplug_lock);
11425e33bc41SRafael J. Wysocki 
11435e33bc41SRafael J. Wysocki void lock_device_hotplug(void)
11445e33bc41SRafael J. Wysocki {
11455e33bc41SRafael J. Wysocki 	mutex_lock(&device_hotplug_lock);
11465e33bc41SRafael J. Wysocki }
11475e33bc41SRafael J. Wysocki 
11485e33bc41SRafael J. Wysocki void unlock_device_hotplug(void)
11495e33bc41SRafael J. Wysocki {
11505e33bc41SRafael J. Wysocki 	mutex_unlock(&device_hotplug_lock);
11515e33bc41SRafael J. Wysocki }
11525e33bc41SRafael J. Wysocki 
11535e33bc41SRafael J. Wysocki int lock_device_hotplug_sysfs(void)
11545e33bc41SRafael J. Wysocki {
11555e33bc41SRafael J. Wysocki 	if (mutex_trylock(&device_hotplug_lock))
11565e33bc41SRafael J. Wysocki 		return 0;
11575e33bc41SRafael J. Wysocki 
11585e33bc41SRafael J. Wysocki 	/* Avoid busy looping (5 ms of sleep should do). */
11595e33bc41SRafael J. Wysocki 	msleep(5);
11605e33bc41SRafael J. Wysocki 	return restart_syscall();
11615e33bc41SRafael J. Wysocki }
11625e33bc41SRafael J. Wysocki 
11634e886c29SGreg Kroah-Hartman #ifdef CONFIG_BLOCK
11644e886c29SGreg Kroah-Hartman static inline int device_is_not_partition(struct device *dev)
11654e886c29SGreg Kroah-Hartman {
11664e886c29SGreg Kroah-Hartman 	return !(dev->type == &part_type);
11674e886c29SGreg Kroah-Hartman }
11684e886c29SGreg Kroah-Hartman #else
11694e886c29SGreg Kroah-Hartman static inline int device_is_not_partition(struct device *dev)
11704e886c29SGreg Kroah-Hartman {
11714e886c29SGreg Kroah-Hartman 	return 1;
11724e886c29SGreg Kroah-Hartman }
11734e886c29SGreg Kroah-Hartman #endif
11741da177e4SLinus Torvalds 
117507de0e86SHeikki Krogerus static int
117607de0e86SHeikki Krogerus device_platform_notify(struct device *dev, enum kobject_action action)
117707de0e86SHeikki Krogerus {
11787847a145SHeikki Krogerus 	int ret;
11797847a145SHeikki Krogerus 
11807847a145SHeikki Krogerus 	ret = acpi_platform_notify(dev, action);
11817847a145SHeikki Krogerus 	if (ret)
11827847a145SHeikki Krogerus 		return ret;
11837847a145SHeikki Krogerus 
118459abd836SHeikki Krogerus 	ret = software_node_notify(dev, action);
118559abd836SHeikki Krogerus 	if (ret)
118659abd836SHeikki Krogerus 		return ret;
118759abd836SHeikki Krogerus 
118807de0e86SHeikki Krogerus 	if (platform_notify && action == KOBJ_ADD)
118907de0e86SHeikki Krogerus 		platform_notify(dev);
119007de0e86SHeikki Krogerus 	else if (platform_notify_remove && action == KOBJ_REMOVE)
119107de0e86SHeikki Krogerus 		platform_notify_remove(dev);
119207de0e86SHeikki Krogerus 	return 0;
119307de0e86SHeikki Krogerus }
119407de0e86SHeikki Krogerus 
11953e95637aSAlan Stern /**
11963e95637aSAlan Stern  * dev_driver_string - Return a device's driver name, if at all possible
11973e95637aSAlan Stern  * @dev: struct device to get the name of
11983e95637aSAlan Stern  *
11993e95637aSAlan Stern  * Will return the device's driver's name if it is bound to a device.  If
12009169c012Syan  * the device is not bound to a driver, it will return the name of the bus
12013e95637aSAlan Stern  * it is attached to.  If it is not attached to a bus either, an empty
12023e95637aSAlan Stern  * string will be returned.
12033e95637aSAlan Stern  */
1204bf9ca69fSJean Delvare const char *dev_driver_string(const struct device *dev)
12053e95637aSAlan Stern {
12063589972eSAlan Stern 	struct device_driver *drv;
12073589972eSAlan Stern 
12083589972eSAlan Stern 	/* dev->driver can change to NULL underneath us because of unbinding,
12093589972eSAlan Stern 	 * so be careful about accessing it.  dev->bus and dev->class should
12103589972eSAlan Stern 	 * never change once they are set, so they don't need special care.
12113589972eSAlan Stern 	 */
12126aa7de05SMark Rutland 	drv = READ_ONCE(dev->driver);
12133589972eSAlan Stern 	return drv ? drv->name :
1214a456b702SJean Delvare 			(dev->bus ? dev->bus->name :
1215a456b702SJean Delvare 			(dev->class ? dev->class->name : ""));
12163e95637aSAlan Stern }
1217310a922dSMatthew Wilcox EXPORT_SYMBOL(dev_driver_string);
12183e95637aSAlan Stern 
12191da177e4SLinus Torvalds #define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr)
12201da177e4SLinus Torvalds 
12214a3ad20cSGreg Kroah-Hartman static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr,
12224a3ad20cSGreg Kroah-Hartman 			     char *buf)
12231da177e4SLinus Torvalds {
12241da177e4SLinus Torvalds 	struct device_attribute *dev_attr = to_dev_attr(attr);
1225b0d1f807SLars-Peter Clausen 	struct device *dev = kobj_to_dev(kobj);
12264a0c20bfSDmitry Torokhov 	ssize_t ret = -EIO;
12271da177e4SLinus Torvalds 
12281da177e4SLinus Torvalds 	if (dev_attr->show)
122954b6f35cSYani Ioannou 		ret = dev_attr->show(dev, dev_attr, buf);
1230815d2d50SAndrew Morton 	if (ret >= (ssize_t)PAGE_SIZE) {
1231a52668c6SSergey Senozhatsky 		printk("dev_attr_show: %pS returned bad count\n",
1232a52668c6SSergey Senozhatsky 				dev_attr->show);
1233815d2d50SAndrew Morton 	}
12341da177e4SLinus Torvalds 	return ret;
12351da177e4SLinus Torvalds }
12361da177e4SLinus Torvalds 
12374a3ad20cSGreg Kroah-Hartman static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr,
12381da177e4SLinus Torvalds 			      const char *buf, size_t count)
12391da177e4SLinus Torvalds {
12401da177e4SLinus Torvalds 	struct device_attribute *dev_attr = to_dev_attr(attr);
1241b0d1f807SLars-Peter Clausen 	struct device *dev = kobj_to_dev(kobj);
12424a0c20bfSDmitry Torokhov 	ssize_t ret = -EIO;
12431da177e4SLinus Torvalds 
12441da177e4SLinus Torvalds 	if (dev_attr->store)
124554b6f35cSYani Ioannou 		ret = dev_attr->store(dev, dev_attr, buf, count);
12461da177e4SLinus Torvalds 	return ret;
12471da177e4SLinus Torvalds }
12481da177e4SLinus Torvalds 
124952cf25d0SEmese Revfy static const struct sysfs_ops dev_sysfs_ops = {
12501da177e4SLinus Torvalds 	.show	= dev_attr_show,
12511da177e4SLinus Torvalds 	.store	= dev_attr_store,
12521da177e4SLinus Torvalds };
12531da177e4SLinus Torvalds 
1254ca22e56dSKay Sievers #define to_ext_attr(x) container_of(x, struct dev_ext_attribute, attr)
1255ca22e56dSKay Sievers 
1256ca22e56dSKay Sievers ssize_t device_store_ulong(struct device *dev,
1257ca22e56dSKay Sievers 			   struct device_attribute *attr,
1258ca22e56dSKay Sievers 			   const char *buf, size_t size)
1259ca22e56dSKay Sievers {
1260ca22e56dSKay Sievers 	struct dev_ext_attribute *ea = to_ext_attr(attr);
1261f88184bfSKaitao cheng 	int ret;
1262f88184bfSKaitao cheng 	unsigned long new;
1263f88184bfSKaitao cheng 
1264f88184bfSKaitao cheng 	ret = kstrtoul(buf, 0, &new);
1265f88184bfSKaitao cheng 	if (ret)
1266f88184bfSKaitao cheng 		return ret;
1267ca22e56dSKay Sievers 	*(unsigned long *)(ea->var) = new;
1268ca22e56dSKay Sievers 	/* Always return full write size even if we didn't consume all */
1269ca22e56dSKay Sievers 	return size;
1270ca22e56dSKay Sievers }
1271ca22e56dSKay Sievers EXPORT_SYMBOL_GPL(device_store_ulong);
1272ca22e56dSKay Sievers 
1273ca22e56dSKay Sievers ssize_t device_show_ulong(struct device *dev,
1274ca22e56dSKay Sievers 			  struct device_attribute *attr,
1275ca22e56dSKay Sievers 			  char *buf)
1276ca22e56dSKay Sievers {
1277ca22e56dSKay Sievers 	struct dev_ext_attribute *ea = to_ext_attr(attr);
1278ca22e56dSKay Sievers 	return snprintf(buf, PAGE_SIZE, "%lx\n", *(unsigned long *)(ea->var));
1279ca22e56dSKay Sievers }
1280ca22e56dSKay Sievers EXPORT_SYMBOL_GPL(device_show_ulong);
1281ca22e56dSKay Sievers 
1282ca22e56dSKay Sievers ssize_t device_store_int(struct device *dev,
1283ca22e56dSKay Sievers 			 struct device_attribute *attr,
1284ca22e56dSKay Sievers 			 const char *buf, size_t size)
1285ca22e56dSKay Sievers {
1286ca22e56dSKay Sievers 	struct dev_ext_attribute *ea = to_ext_attr(attr);
1287f88184bfSKaitao cheng 	int ret;
1288f88184bfSKaitao cheng 	long new;
1289f88184bfSKaitao cheng 
1290f88184bfSKaitao cheng 	ret = kstrtol(buf, 0, &new);
1291f88184bfSKaitao cheng 	if (ret)
1292f88184bfSKaitao cheng 		return ret;
1293f88184bfSKaitao cheng 
1294f88184bfSKaitao cheng 	if (new > INT_MAX || new < INT_MIN)
1295ca22e56dSKay Sievers 		return -EINVAL;
1296ca22e56dSKay Sievers 	*(int *)(ea->var) = new;
1297ca22e56dSKay Sievers 	/* Always return full write size even if we didn't consume all */
1298ca22e56dSKay Sievers 	return size;
1299ca22e56dSKay Sievers }
1300ca22e56dSKay Sievers EXPORT_SYMBOL_GPL(device_store_int);
1301ca22e56dSKay Sievers 
1302ca22e56dSKay Sievers ssize_t device_show_int(struct device *dev,
1303ca22e56dSKay Sievers 			struct device_attribute *attr,
1304ca22e56dSKay Sievers 			char *buf)
1305ca22e56dSKay Sievers {
1306ca22e56dSKay Sievers 	struct dev_ext_attribute *ea = to_ext_attr(attr);
1307ca22e56dSKay Sievers 
1308ca22e56dSKay Sievers 	return snprintf(buf, PAGE_SIZE, "%d\n", *(int *)(ea->var));
1309ca22e56dSKay Sievers }
1310ca22e56dSKay Sievers EXPORT_SYMBOL_GPL(device_show_int);
13111da177e4SLinus Torvalds 
131291872392SBorislav Petkov ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
131391872392SBorislav Petkov 			  const char *buf, size_t size)
131491872392SBorislav Petkov {
131591872392SBorislav Petkov 	struct dev_ext_attribute *ea = to_ext_attr(attr);
131691872392SBorislav Petkov 
131791872392SBorislav Petkov 	if (strtobool(buf, ea->var) < 0)
131891872392SBorislav Petkov 		return -EINVAL;
131991872392SBorislav Petkov 
132091872392SBorislav Petkov 	return size;
132191872392SBorislav Petkov }
132291872392SBorislav Petkov EXPORT_SYMBOL_GPL(device_store_bool);
132391872392SBorislav Petkov 
132491872392SBorislav Petkov ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
132591872392SBorislav Petkov 			 char *buf)
132691872392SBorislav Petkov {
132791872392SBorislav Petkov 	struct dev_ext_attribute *ea = to_ext_attr(attr);
132891872392SBorislav Petkov 
132991872392SBorislav Petkov 	return snprintf(buf, PAGE_SIZE, "%d\n", *(bool *)(ea->var));
133091872392SBorislav Petkov }
133191872392SBorislav Petkov EXPORT_SYMBOL_GPL(device_show_bool);
133291872392SBorislav Petkov 
13331da177e4SLinus Torvalds /**
13341da177e4SLinus Torvalds  * device_release - free device structure.
13351da177e4SLinus Torvalds  * @kobj: device's kobject.
13361da177e4SLinus Torvalds  *
13371da177e4SLinus Torvalds  * This is called once the reference count for the object
13381da177e4SLinus Torvalds  * reaches 0. We forward the call to the device's release
13391da177e4SLinus Torvalds  * method, which should handle actually freeing the structure.
13401da177e4SLinus Torvalds  */
13411da177e4SLinus Torvalds static void device_release(struct kobject *kobj)
13421da177e4SLinus Torvalds {
1343b0d1f807SLars-Peter Clausen 	struct device *dev = kobj_to_dev(kobj);
1344fb069a5dSGreg Kroah-Hartman 	struct device_private *p = dev->p;
13451da177e4SLinus Torvalds 
1346a525a3ddSMing Lei 	/*
1347a525a3ddSMing Lei 	 * Some platform devices are driven without driver attached
1348a525a3ddSMing Lei 	 * and managed resources may have been acquired.  Make sure
1349a525a3ddSMing Lei 	 * all resources are released.
1350a525a3ddSMing Lei 	 *
1351a525a3ddSMing Lei 	 * Drivers still can add resources into device after device
1352a525a3ddSMing Lei 	 * is deleted but alive, so release devres here to avoid
1353a525a3ddSMing Lei 	 * possible memory leak.
1354a525a3ddSMing Lei 	 */
1355a525a3ddSMing Lei 	devres_release_all(dev);
1356a525a3ddSMing Lei 
13571da177e4SLinus Torvalds 	if (dev->release)
13581da177e4SLinus Torvalds 		dev->release(dev);
1359f9f852dfSKay Sievers 	else if (dev->type && dev->type->release)
1360f9f852dfSKay Sievers 		dev->type->release(dev);
13612620efefSGreg Kroah-Hartman 	else if (dev->class && dev->class->dev_release)
13622620efefSGreg Kroah-Hartman 		dev->class->dev_release(dev);
1363f810a5cfSArjan van de Ven 	else
1364186bddb2SEzequiel Garcia 		WARN(1, KERN_ERR "Device '%s' does not have a release() function, it is broken and must be fixed. See Documentation/kobject.txt.\n",
13651e0b2cf9SKay Sievers 			dev_name(dev));
1366fb069a5dSGreg Kroah-Hartman 	kfree(p);
13671da177e4SLinus Torvalds }
13681da177e4SLinus Torvalds 
1369bc451f20SEric W. Biederman static const void *device_namespace(struct kobject *kobj)
1370bc451f20SEric W. Biederman {
1371b0d1f807SLars-Peter Clausen 	struct device *dev = kobj_to_dev(kobj);
1372bc451f20SEric W. Biederman 	const void *ns = NULL;
1373bc451f20SEric W. Biederman 
1374bc451f20SEric W. Biederman 	if (dev->class && dev->class->ns_type)
1375bc451f20SEric W. Biederman 		ns = dev->class->namespace(dev);
1376bc451f20SEric W. Biederman 
1377bc451f20SEric W. Biederman 	return ns;
1378bc451f20SEric W. Biederman }
1379bc451f20SEric W. Biederman 
13809944e894SDmitry Torokhov static void device_get_ownership(struct kobject *kobj, kuid_t *uid, kgid_t *gid)
13819944e894SDmitry Torokhov {
13829944e894SDmitry Torokhov 	struct device *dev = kobj_to_dev(kobj);
13839944e894SDmitry Torokhov 
13849944e894SDmitry Torokhov 	if (dev->class && dev->class->get_ownership)
13859944e894SDmitry Torokhov 		dev->class->get_ownership(dev, uid, gid);
13869944e894SDmitry Torokhov }
13879944e894SDmitry Torokhov 
13888f4afc41SGreg Kroah-Hartman static struct kobj_type device_ktype = {
13891da177e4SLinus Torvalds 	.release	= device_release,
13901da177e4SLinus Torvalds 	.sysfs_ops	= &dev_sysfs_ops,
1391bc451f20SEric W. Biederman 	.namespace	= device_namespace,
13929944e894SDmitry Torokhov 	.get_ownership	= device_get_ownership,
13931da177e4SLinus Torvalds };
13941da177e4SLinus Torvalds 
13951da177e4SLinus Torvalds 
1396312c004dSKay Sievers static int dev_uevent_filter(struct kset *kset, struct kobject *kobj)
13971da177e4SLinus Torvalds {
13981da177e4SLinus Torvalds 	struct kobj_type *ktype = get_ktype(kobj);
13991da177e4SLinus Torvalds 
14008f4afc41SGreg Kroah-Hartman 	if (ktype == &device_ktype) {
1401b0d1f807SLars-Peter Clausen 		struct device *dev = kobj_to_dev(kobj);
14021da177e4SLinus Torvalds 		if (dev->bus)
14031da177e4SLinus Torvalds 			return 1;
140423681e47SGreg Kroah-Hartman 		if (dev->class)
140523681e47SGreg Kroah-Hartman 			return 1;
14061da177e4SLinus Torvalds 	}
14071da177e4SLinus Torvalds 	return 0;
14081da177e4SLinus Torvalds }
14091da177e4SLinus Torvalds 
1410312c004dSKay Sievers static const char *dev_uevent_name(struct kset *kset, struct kobject *kobj)
14111da177e4SLinus Torvalds {
1412b0d1f807SLars-Peter Clausen 	struct device *dev = kobj_to_dev(kobj);
14131da177e4SLinus Torvalds 
141423681e47SGreg Kroah-Hartman 	if (dev->bus)
14151da177e4SLinus Torvalds 		return dev->bus->name;
141623681e47SGreg Kroah-Hartman 	if (dev->class)
141723681e47SGreg Kroah-Hartman 		return dev->class->name;
141823681e47SGreg Kroah-Hartman 	return NULL;
14191da177e4SLinus Torvalds }
14201da177e4SLinus Torvalds 
14217eff2e7aSKay Sievers static int dev_uevent(struct kset *kset, struct kobject *kobj,
14227eff2e7aSKay Sievers 		      struct kobj_uevent_env *env)
14231da177e4SLinus Torvalds {
1424b0d1f807SLars-Peter Clausen 	struct device *dev = kobj_to_dev(kobj);
14251da177e4SLinus Torvalds 	int retval = 0;
14261da177e4SLinus Torvalds 
14276fcf53acSKay Sievers 	/* add device node properties if present */
142823681e47SGreg Kroah-Hartman 	if (MAJOR(dev->devt)) {
14296fcf53acSKay Sievers 		const char *tmp;
14306fcf53acSKay Sievers 		const char *name;
14312c9ede55SAl Viro 		umode_t mode = 0;
14324e4098a3SGreg Kroah-Hartman 		kuid_t uid = GLOBAL_ROOT_UID;
14334e4098a3SGreg Kroah-Hartman 		kgid_t gid = GLOBAL_ROOT_GID;
14346fcf53acSKay Sievers 
14357eff2e7aSKay Sievers 		add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt));
14367eff2e7aSKay Sievers 		add_uevent_var(env, "MINOR=%u", MINOR(dev->devt));
14373c2670e6SKay Sievers 		name = device_get_devnode(dev, &mode, &uid, &gid, &tmp);
14386fcf53acSKay Sievers 		if (name) {
14396fcf53acSKay Sievers 			add_uevent_var(env, "DEVNAME=%s", name);
1440e454cea2SKay Sievers 			if (mode)
1441e454cea2SKay Sievers 				add_uevent_var(env, "DEVMODE=%#o", mode & 0777);
14424e4098a3SGreg Kroah-Hartman 			if (!uid_eq(uid, GLOBAL_ROOT_UID))
14434e4098a3SGreg Kroah-Hartman 				add_uevent_var(env, "DEVUID=%u", from_kuid(&init_user_ns, uid));
14444e4098a3SGreg Kroah-Hartman 			if (!gid_eq(gid, GLOBAL_ROOT_GID))
14454e4098a3SGreg Kroah-Hartman 				add_uevent_var(env, "DEVGID=%u", from_kgid(&init_user_ns, gid));
14463c2670e6SKay Sievers 			kfree(tmp);
14476fcf53acSKay Sievers 		}
144823681e47SGreg Kroah-Hartman 	}
144923681e47SGreg Kroah-Hartman 
1450414264f9SKay Sievers 	if (dev->type && dev->type->name)
14517eff2e7aSKay Sievers 		add_uevent_var(env, "DEVTYPE=%s", dev->type->name);
1452414264f9SKay Sievers 
1453239378f1SKay Sievers 	if (dev->driver)
14547eff2e7aSKay Sievers 		add_uevent_var(env, "DRIVER=%s", dev->driver->name);
1455239378f1SKay Sievers 
145607d57a32SGrant Likely 	/* Add common DT information about the device */
145707d57a32SGrant Likely 	of_device_uevent(dev, env);
145807d57a32SGrant Likely 
14591da177e4SLinus Torvalds 	/* have the bus specific function add its stuff */
14607eff2e7aSKay Sievers 	if (dev->bus && dev->bus->uevent) {
14617eff2e7aSKay Sievers 		retval = dev->bus->uevent(dev, env);
1462f9f852dfSKay Sievers 		if (retval)
14637dc72b28SGreg Kroah-Hartman 			pr_debug("device: '%s': %s: bus uevent() returned %d\n",
14641e0b2cf9SKay Sievers 				 dev_name(dev), __func__, retval);
14651da177e4SLinus Torvalds 	}
14661da177e4SLinus Torvalds 
14672620efefSGreg Kroah-Hartman 	/* have the class specific function add its stuff */
14687eff2e7aSKay Sievers 	if (dev->class && dev->class->dev_uevent) {
14697eff2e7aSKay Sievers 		retval = dev->class->dev_uevent(dev, env);
1470f9f852dfSKay Sievers 		if (retval)
14717dc72b28SGreg Kroah-Hartman 			pr_debug("device: '%s': %s: class uevent() "
14721e0b2cf9SKay Sievers 				 "returned %d\n", dev_name(dev),
14732b3a302aSHarvey Harrison 				 __func__, retval);
14742620efefSGreg Kroah-Hartman 	}
1475f9f852dfSKay Sievers 
1476eef35c2dSStefan Weil 	/* have the device type specific function add its stuff */
14777eff2e7aSKay Sievers 	if (dev->type && dev->type->uevent) {
14787eff2e7aSKay Sievers 		retval = dev->type->uevent(dev, env);
1479f9f852dfSKay Sievers 		if (retval)
14807dc72b28SGreg Kroah-Hartman 			pr_debug("device: '%s': %s: dev_type uevent() "
14811e0b2cf9SKay Sievers 				 "returned %d\n", dev_name(dev),
14822b3a302aSHarvey Harrison 				 __func__, retval);
14832620efefSGreg Kroah-Hartman 	}
14842620efefSGreg Kroah-Hartman 
14851da177e4SLinus Torvalds 	return retval;
14861da177e4SLinus Torvalds }
14871da177e4SLinus Torvalds 
14889cd43611SEmese Revfy static const struct kset_uevent_ops device_uevent_ops = {
1489312c004dSKay Sievers 	.filter =	dev_uevent_filter,
1490312c004dSKay Sievers 	.name =		dev_uevent_name,
1491312c004dSKay Sievers 	.uevent =	dev_uevent,
14921da177e4SLinus Torvalds };
14931da177e4SLinus Torvalds 
1494c5e064a6SGreg Kroah-Hartman static ssize_t uevent_show(struct device *dev, struct device_attribute *attr,
149516574dccSKay Sievers 			   char *buf)
149616574dccSKay Sievers {
149716574dccSKay Sievers 	struct kobject *top_kobj;
149816574dccSKay Sievers 	struct kset *kset;
14997eff2e7aSKay Sievers 	struct kobj_uevent_env *env = NULL;
150016574dccSKay Sievers 	int i;
150116574dccSKay Sievers 	size_t count = 0;
150216574dccSKay Sievers 	int retval;
150316574dccSKay Sievers 
150416574dccSKay Sievers 	/* search the kset, the device belongs to */
150516574dccSKay Sievers 	top_kobj = &dev->kobj;
15065c5daf65SKay Sievers 	while (!top_kobj->kset && top_kobj->parent)
150716574dccSKay Sievers 		top_kobj = top_kobj->parent;
150816574dccSKay Sievers 	if (!top_kobj->kset)
150916574dccSKay Sievers 		goto out;
15105c5daf65SKay Sievers 
151116574dccSKay Sievers 	kset = top_kobj->kset;
151216574dccSKay Sievers 	if (!kset->uevent_ops || !kset->uevent_ops->uevent)
151316574dccSKay Sievers 		goto out;
151416574dccSKay Sievers 
151516574dccSKay Sievers 	/* respect filter */
151616574dccSKay Sievers 	if (kset->uevent_ops && kset->uevent_ops->filter)
151716574dccSKay Sievers 		if (!kset->uevent_ops->filter(kset, &dev->kobj))
151816574dccSKay Sievers 			goto out;
151916574dccSKay Sievers 
15207eff2e7aSKay Sievers 	env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL);
15217eff2e7aSKay Sievers 	if (!env)
1522c7308c81SGreg Kroah-Hartman 		return -ENOMEM;
1523c7308c81SGreg Kroah-Hartman 
152416574dccSKay Sievers 	/* let the kset specific function add its keys */
15257eff2e7aSKay Sievers 	retval = kset->uevent_ops->uevent(kset, &dev->kobj, env);
152616574dccSKay Sievers 	if (retval)
152716574dccSKay Sievers 		goto out;
152816574dccSKay Sievers 
152916574dccSKay Sievers 	/* copy keys to file */
15307eff2e7aSKay Sievers 	for (i = 0; i < env->envp_idx; i++)
15317eff2e7aSKay Sievers 		count += sprintf(&buf[count], "%s\n", env->envp[i]);
153216574dccSKay Sievers out:
15337eff2e7aSKay Sievers 	kfree(env);
153416574dccSKay Sievers 	return count;
153516574dccSKay Sievers }
153616574dccSKay Sievers 
1537c5e064a6SGreg Kroah-Hartman static ssize_t uevent_store(struct device *dev, struct device_attribute *attr,
1538a7fd6706SKay Sievers 			    const char *buf, size_t count)
1539a7fd6706SKay Sievers {
1540df44b479SPeter Rajnoha 	int rc;
1541df44b479SPeter Rajnoha 
1542df44b479SPeter Rajnoha 	rc = kobject_synth_uevent(&dev->kobj, buf, count);
1543df44b479SPeter Rajnoha 
1544df44b479SPeter Rajnoha 	if (rc) {
1545f36776faSPeter Rajnoha 		dev_err(dev, "uevent: failed to send synthetic uevent\n");
1546df44b479SPeter Rajnoha 		return rc;
1547df44b479SPeter Rajnoha 	}
154860a96a59SKay Sievers 
1549a7fd6706SKay Sievers 	return count;
1550a7fd6706SKay Sievers }
1551c5e064a6SGreg Kroah-Hartman static DEVICE_ATTR_RW(uevent);
1552a7fd6706SKay Sievers 
1553c5e064a6SGreg Kroah-Hartman static ssize_t online_show(struct device *dev, struct device_attribute *attr,
15544f3549d7SRafael J. Wysocki 			   char *buf)
15554f3549d7SRafael J. Wysocki {
15564f3549d7SRafael J. Wysocki 	bool val;
15574f3549d7SRafael J. Wysocki 
15585e33bc41SRafael J. Wysocki 	device_lock(dev);
15594f3549d7SRafael J. Wysocki 	val = !dev->offline;
15605e33bc41SRafael J. Wysocki 	device_unlock(dev);
15614f3549d7SRafael J. Wysocki 	return sprintf(buf, "%u\n", val);
15624f3549d7SRafael J. Wysocki }
15634f3549d7SRafael J. Wysocki 
1564c5e064a6SGreg Kroah-Hartman static ssize_t online_store(struct device *dev, struct device_attribute *attr,
15654f3549d7SRafael J. Wysocki 			    const char *buf, size_t count)
15664f3549d7SRafael J. Wysocki {
15674f3549d7SRafael J. Wysocki 	bool val;
15684f3549d7SRafael J. Wysocki 	int ret;
15694f3549d7SRafael J. Wysocki 
15704f3549d7SRafael J. Wysocki 	ret = strtobool(buf, &val);
15714f3549d7SRafael J. Wysocki 	if (ret < 0)
15724f3549d7SRafael J. Wysocki 		return ret;
15734f3549d7SRafael J. Wysocki 
15745e33bc41SRafael J. Wysocki 	ret = lock_device_hotplug_sysfs();
15755e33bc41SRafael J. Wysocki 	if (ret)
15765e33bc41SRafael J. Wysocki 		return ret;
15775e33bc41SRafael J. Wysocki 
15784f3549d7SRafael J. Wysocki 	ret = val ? device_online(dev) : device_offline(dev);
15794f3549d7SRafael J. Wysocki 	unlock_device_hotplug();
15804f3549d7SRafael J. Wysocki 	return ret < 0 ? ret : count;
15814f3549d7SRafael J. Wysocki }
1582c5e064a6SGreg Kroah-Hartman static DEVICE_ATTR_RW(online);
15834f3549d7SRafael J. Wysocki 
1584fa6fdb33SGreg Kroah-Hartman int device_add_groups(struct device *dev, const struct attribute_group **groups)
1585621a1672SDmitry Torokhov {
15863e9b2baeSGreg Kroah-Hartman 	return sysfs_create_groups(&dev->kobj, groups);
1587621a1672SDmitry Torokhov }
1588a7670d42SDmitry Torokhov EXPORT_SYMBOL_GPL(device_add_groups);
1589621a1672SDmitry Torokhov 
1590fa6fdb33SGreg Kroah-Hartman void device_remove_groups(struct device *dev,
1591a4dbd674SDavid Brownell 			  const struct attribute_group **groups)
1592621a1672SDmitry Torokhov {
15933e9b2baeSGreg Kroah-Hartman 	sysfs_remove_groups(&dev->kobj, groups);
1594621a1672SDmitry Torokhov }
1595a7670d42SDmitry Torokhov EXPORT_SYMBOL_GPL(device_remove_groups);
1596de0ff00dSGreg Kroah-Hartman 
159757b8ff07SDmitry Torokhov union device_attr_group_devres {
159857b8ff07SDmitry Torokhov 	const struct attribute_group *group;
159957b8ff07SDmitry Torokhov 	const struct attribute_group **groups;
160057b8ff07SDmitry Torokhov };
160157b8ff07SDmitry Torokhov 
160257b8ff07SDmitry Torokhov static int devm_attr_group_match(struct device *dev, void *res, void *data)
160357b8ff07SDmitry Torokhov {
160457b8ff07SDmitry Torokhov 	return ((union device_attr_group_devres *)res)->group == data;
160557b8ff07SDmitry Torokhov }
160657b8ff07SDmitry Torokhov 
160757b8ff07SDmitry Torokhov static void devm_attr_group_remove(struct device *dev, void *res)
160857b8ff07SDmitry Torokhov {
160957b8ff07SDmitry Torokhov 	union device_attr_group_devres *devres = res;
161057b8ff07SDmitry Torokhov 	const struct attribute_group *group = devres->group;
161157b8ff07SDmitry Torokhov 
161257b8ff07SDmitry Torokhov 	dev_dbg(dev, "%s: removing group %p\n", __func__, group);
161357b8ff07SDmitry Torokhov 	sysfs_remove_group(&dev->kobj, group);
161457b8ff07SDmitry Torokhov }
161557b8ff07SDmitry Torokhov 
161657b8ff07SDmitry Torokhov static void devm_attr_groups_remove(struct device *dev, void *res)
161757b8ff07SDmitry Torokhov {
161857b8ff07SDmitry Torokhov 	union device_attr_group_devres *devres = res;
161957b8ff07SDmitry Torokhov 	const struct attribute_group **groups = devres->groups;
162057b8ff07SDmitry Torokhov 
162157b8ff07SDmitry Torokhov 	dev_dbg(dev, "%s: removing groups %p\n", __func__, groups);
162257b8ff07SDmitry Torokhov 	sysfs_remove_groups(&dev->kobj, groups);
162357b8ff07SDmitry Torokhov }
162457b8ff07SDmitry Torokhov 
162557b8ff07SDmitry Torokhov /**
162657b8ff07SDmitry Torokhov  * devm_device_add_group - given a device, create a managed attribute group
162757b8ff07SDmitry Torokhov  * @dev:	The device to create the group for
162857b8ff07SDmitry Torokhov  * @grp:	The attribute group to create
162957b8ff07SDmitry Torokhov  *
163057b8ff07SDmitry Torokhov  * This function creates a group for the first time.  It will explicitly
163157b8ff07SDmitry Torokhov  * warn and error if any of the attribute files being created already exist.
163257b8ff07SDmitry Torokhov  *
163357b8ff07SDmitry Torokhov  * Returns 0 on success or error code on failure.
163457b8ff07SDmitry Torokhov  */
163557b8ff07SDmitry Torokhov int devm_device_add_group(struct device *dev, const struct attribute_group *grp)
163657b8ff07SDmitry Torokhov {
163757b8ff07SDmitry Torokhov 	union device_attr_group_devres *devres;
163857b8ff07SDmitry Torokhov 	int error;
163957b8ff07SDmitry Torokhov 
164057b8ff07SDmitry Torokhov 	devres = devres_alloc(devm_attr_group_remove,
164157b8ff07SDmitry Torokhov 			      sizeof(*devres), GFP_KERNEL);
164257b8ff07SDmitry Torokhov 	if (!devres)
164357b8ff07SDmitry Torokhov 		return -ENOMEM;
164457b8ff07SDmitry Torokhov 
164557b8ff07SDmitry Torokhov 	error = sysfs_create_group(&dev->kobj, grp);
164657b8ff07SDmitry Torokhov 	if (error) {
164757b8ff07SDmitry Torokhov 		devres_free(devres);
164857b8ff07SDmitry Torokhov 		return error;
164957b8ff07SDmitry Torokhov 	}
165057b8ff07SDmitry Torokhov 
165157b8ff07SDmitry Torokhov 	devres->group = grp;
165257b8ff07SDmitry Torokhov 	devres_add(dev, devres);
165357b8ff07SDmitry Torokhov 	return 0;
165457b8ff07SDmitry Torokhov }
165557b8ff07SDmitry Torokhov EXPORT_SYMBOL_GPL(devm_device_add_group);
165657b8ff07SDmitry Torokhov 
165757b8ff07SDmitry Torokhov /**
165857b8ff07SDmitry Torokhov  * devm_device_remove_group: remove a managed group from a device
165957b8ff07SDmitry Torokhov  * @dev:	device to remove the group from
166057b8ff07SDmitry Torokhov  * @grp:	group to remove
166157b8ff07SDmitry Torokhov  *
166257b8ff07SDmitry Torokhov  * This function removes a group of attributes from a device. The attributes
166357b8ff07SDmitry Torokhov  * previously have to have been created for this group, otherwise it will fail.
166457b8ff07SDmitry Torokhov  */
166557b8ff07SDmitry Torokhov void devm_device_remove_group(struct device *dev,
166657b8ff07SDmitry Torokhov 			      const struct attribute_group *grp)
166757b8ff07SDmitry Torokhov {
166857b8ff07SDmitry Torokhov 	WARN_ON(devres_release(dev, devm_attr_group_remove,
166957b8ff07SDmitry Torokhov 			       devm_attr_group_match,
167057b8ff07SDmitry Torokhov 			       /* cast away const */ (void *)grp));
167157b8ff07SDmitry Torokhov }
167257b8ff07SDmitry Torokhov EXPORT_SYMBOL_GPL(devm_device_remove_group);
167357b8ff07SDmitry Torokhov 
167457b8ff07SDmitry Torokhov /**
167557b8ff07SDmitry Torokhov  * devm_device_add_groups - create a bunch of managed attribute groups
167657b8ff07SDmitry Torokhov  * @dev:	The device to create the group for
167757b8ff07SDmitry Torokhov  * @groups:	The attribute groups to create, NULL terminated
167857b8ff07SDmitry Torokhov  *
167957b8ff07SDmitry Torokhov  * This function creates a bunch of managed attribute groups.  If an error
168057b8ff07SDmitry Torokhov  * occurs when creating a group, all previously created groups will be
168157b8ff07SDmitry Torokhov  * removed, unwinding everything back to the original state when this
168257b8ff07SDmitry Torokhov  * function was called.  It will explicitly warn and error if any of the
168357b8ff07SDmitry Torokhov  * attribute files being created already exist.
168457b8ff07SDmitry Torokhov  *
168557b8ff07SDmitry Torokhov  * Returns 0 on success or error code from sysfs_create_group on failure.
168657b8ff07SDmitry Torokhov  */
168757b8ff07SDmitry Torokhov int devm_device_add_groups(struct device *dev,
168857b8ff07SDmitry Torokhov 			   const struct attribute_group **groups)
168957b8ff07SDmitry Torokhov {
169057b8ff07SDmitry Torokhov 	union device_attr_group_devres *devres;
169157b8ff07SDmitry Torokhov 	int error;
169257b8ff07SDmitry Torokhov 
169357b8ff07SDmitry Torokhov 	devres = devres_alloc(devm_attr_groups_remove,
169457b8ff07SDmitry Torokhov 			      sizeof(*devres), GFP_KERNEL);
169557b8ff07SDmitry Torokhov 	if (!devres)
169657b8ff07SDmitry Torokhov 		return -ENOMEM;
169757b8ff07SDmitry Torokhov 
169857b8ff07SDmitry Torokhov 	error = sysfs_create_groups(&dev->kobj, groups);
169957b8ff07SDmitry Torokhov 	if (error) {
170057b8ff07SDmitry Torokhov 		devres_free(devres);
170157b8ff07SDmitry Torokhov 		return error;
170257b8ff07SDmitry Torokhov 	}
170357b8ff07SDmitry Torokhov 
170457b8ff07SDmitry Torokhov 	devres->groups = groups;
170557b8ff07SDmitry Torokhov 	devres_add(dev, devres);
170657b8ff07SDmitry Torokhov 	return 0;
170757b8ff07SDmitry Torokhov }
170857b8ff07SDmitry Torokhov EXPORT_SYMBOL_GPL(devm_device_add_groups);
170957b8ff07SDmitry Torokhov 
171057b8ff07SDmitry Torokhov /**
171157b8ff07SDmitry Torokhov  * devm_device_remove_groups - remove a list of managed groups
171257b8ff07SDmitry Torokhov  *
171357b8ff07SDmitry Torokhov  * @dev:	The device for the groups to be removed from
171457b8ff07SDmitry Torokhov  * @groups:	NULL terminated list of groups to be removed
171557b8ff07SDmitry Torokhov  *
171657b8ff07SDmitry Torokhov  * If groups is not NULL, remove the specified groups from the device.
171757b8ff07SDmitry Torokhov  */
171857b8ff07SDmitry Torokhov void devm_device_remove_groups(struct device *dev,
171957b8ff07SDmitry Torokhov 			       const struct attribute_group **groups)
172057b8ff07SDmitry Torokhov {
172157b8ff07SDmitry Torokhov 	WARN_ON(devres_release(dev, devm_attr_groups_remove,
172257b8ff07SDmitry Torokhov 			       devm_attr_group_match,
172357b8ff07SDmitry Torokhov 			       /* cast away const */ (void *)groups));
172457b8ff07SDmitry Torokhov }
172557b8ff07SDmitry Torokhov EXPORT_SYMBOL_GPL(devm_device_remove_groups);
17261da177e4SLinus Torvalds 
17272620efefSGreg Kroah-Hartman static int device_add_attrs(struct device *dev)
17282620efefSGreg Kroah-Hartman {
17292620efefSGreg Kroah-Hartman 	struct class *class = dev->class;
1730aed65af1SStephen Hemminger 	const struct device_type *type = dev->type;
1731621a1672SDmitry Torokhov 	int error;
17322620efefSGreg Kroah-Hartman 
1733621a1672SDmitry Torokhov 	if (class) {
1734d05a6f96SGreg Kroah-Hartman 		error = device_add_groups(dev, class->dev_groups);
17352620efefSGreg Kroah-Hartman 		if (error)
1736621a1672SDmitry Torokhov 			return error;
1737f9f852dfSKay Sievers 	}
1738f9f852dfSKay Sievers 
1739621a1672SDmitry Torokhov 	if (type) {
1740621a1672SDmitry Torokhov 		error = device_add_groups(dev, type->groups);
1741f9f852dfSKay Sievers 		if (error)
1742a6b01dedSGreg Kroah-Hartman 			goto err_remove_class_groups;
1743f9f852dfSKay Sievers 	}
1744621a1672SDmitry Torokhov 
1745621a1672SDmitry Torokhov 	error = device_add_groups(dev, dev->groups);
1746f9f852dfSKay Sievers 	if (error)
1747621a1672SDmitry Torokhov 		goto err_remove_type_groups;
1748621a1672SDmitry Torokhov 
17494f3549d7SRafael J. Wysocki 	if (device_supports_offline(dev) && !dev->offline_disabled) {
1750c5e064a6SGreg Kroah-Hartman 		error = device_create_file(dev, &dev_attr_online);
17514f3549d7SRafael J. Wysocki 		if (error)
1752ecfbf6fdSRafael J. Wysocki 			goto err_remove_dev_groups;
17534f3549d7SRafael J. Wysocki 	}
17544f3549d7SRafael J. Wysocki 
1755621a1672SDmitry Torokhov 	return 0;
1756621a1672SDmitry Torokhov 
1757ecfbf6fdSRafael J. Wysocki  err_remove_dev_groups:
1758ecfbf6fdSRafael J. Wysocki 	device_remove_groups(dev, dev->groups);
1759621a1672SDmitry Torokhov  err_remove_type_groups:
1760621a1672SDmitry Torokhov 	if (type)
1761621a1672SDmitry Torokhov 		device_remove_groups(dev, type->groups);
1762d05a6f96SGreg Kroah-Hartman  err_remove_class_groups:
1763d05a6f96SGreg Kroah-Hartman 	if (class)
1764d05a6f96SGreg Kroah-Hartman 		device_remove_groups(dev, class->dev_groups);
1765f9f852dfSKay Sievers 
17662620efefSGreg Kroah-Hartman 	return error;
17672620efefSGreg Kroah-Hartman }
17682620efefSGreg Kroah-Hartman 
17692620efefSGreg Kroah-Hartman static void device_remove_attrs(struct device *dev)
17702620efefSGreg Kroah-Hartman {
17712620efefSGreg Kroah-Hartman 	struct class *class = dev->class;
1772aed65af1SStephen Hemminger 	const struct device_type *type = dev->type;
17732620efefSGreg Kroah-Hartman 
1774c5e064a6SGreg Kroah-Hartman 	device_remove_file(dev, &dev_attr_online);
1775621a1672SDmitry Torokhov 	device_remove_groups(dev, dev->groups);
1776f9f852dfSKay Sievers 
1777621a1672SDmitry Torokhov 	if (type)
1778621a1672SDmitry Torokhov 		device_remove_groups(dev, type->groups);
1779621a1672SDmitry Torokhov 
1780a6b01dedSGreg Kroah-Hartman 	if (class)
1781d05a6f96SGreg Kroah-Hartman 		device_remove_groups(dev, class->dev_groups);
1782c97415a7SStefan Achatz }
17832620efefSGreg Kroah-Hartman 
1784c5e064a6SGreg Kroah-Hartman static ssize_t dev_show(struct device *dev, struct device_attribute *attr,
178523681e47SGreg Kroah-Hartman 			char *buf)
178623681e47SGreg Kroah-Hartman {
178723681e47SGreg Kroah-Hartman 	return print_dev_t(buf, dev->devt);
178823681e47SGreg Kroah-Hartman }
1789c5e064a6SGreg Kroah-Hartman static DEVICE_ATTR_RO(dev);
1790ad6a1e1cSTejun Heo 
1791ca22e56dSKay Sievers /* /sys/devices/ */
1792881c6cfdSGreg Kroah-Hartman struct kset *devices_kset;
17931da177e4SLinus Torvalds 
17941da177e4SLinus Torvalds /**
179552cdbdd4SGrygorii Strashko  * devices_kset_move_before - Move device in the devices_kset's list.
179652cdbdd4SGrygorii Strashko  * @deva: Device to move.
179752cdbdd4SGrygorii Strashko  * @devb: Device @deva should come before.
179852cdbdd4SGrygorii Strashko  */
179952cdbdd4SGrygorii Strashko static void devices_kset_move_before(struct device *deva, struct device *devb)
180052cdbdd4SGrygorii Strashko {
180152cdbdd4SGrygorii Strashko 	if (!devices_kset)
180252cdbdd4SGrygorii Strashko 		return;
180352cdbdd4SGrygorii Strashko 	pr_debug("devices_kset: Moving %s before %s\n",
180452cdbdd4SGrygorii Strashko 		 dev_name(deva), dev_name(devb));
180552cdbdd4SGrygorii Strashko 	spin_lock(&devices_kset->list_lock);
180652cdbdd4SGrygorii Strashko 	list_move_tail(&deva->kobj.entry, &devb->kobj.entry);
180752cdbdd4SGrygorii Strashko 	spin_unlock(&devices_kset->list_lock);
180852cdbdd4SGrygorii Strashko }
180952cdbdd4SGrygorii Strashko 
181052cdbdd4SGrygorii Strashko /**
181152cdbdd4SGrygorii Strashko  * devices_kset_move_after - Move device in the devices_kset's list.
181252cdbdd4SGrygorii Strashko  * @deva: Device to move
181352cdbdd4SGrygorii Strashko  * @devb: Device @deva should come after.
181452cdbdd4SGrygorii Strashko  */
181552cdbdd4SGrygorii Strashko static void devices_kset_move_after(struct device *deva, struct device *devb)
181652cdbdd4SGrygorii Strashko {
181752cdbdd4SGrygorii Strashko 	if (!devices_kset)
181852cdbdd4SGrygorii Strashko 		return;
181952cdbdd4SGrygorii Strashko 	pr_debug("devices_kset: Moving %s after %s\n",
182052cdbdd4SGrygorii Strashko 		 dev_name(deva), dev_name(devb));
182152cdbdd4SGrygorii Strashko 	spin_lock(&devices_kset->list_lock);
182252cdbdd4SGrygorii Strashko 	list_move(&deva->kobj.entry, &devb->kobj.entry);
182352cdbdd4SGrygorii Strashko 	spin_unlock(&devices_kset->list_lock);
182452cdbdd4SGrygorii Strashko }
182552cdbdd4SGrygorii Strashko 
182652cdbdd4SGrygorii Strashko /**
182752cdbdd4SGrygorii Strashko  * devices_kset_move_last - move the device to the end of devices_kset's list.
182852cdbdd4SGrygorii Strashko  * @dev: device to move
182952cdbdd4SGrygorii Strashko  */
183052cdbdd4SGrygorii Strashko void devices_kset_move_last(struct device *dev)
183152cdbdd4SGrygorii Strashko {
183252cdbdd4SGrygorii Strashko 	if (!devices_kset)
183352cdbdd4SGrygorii Strashko 		return;
183452cdbdd4SGrygorii Strashko 	pr_debug("devices_kset: Moving %s to end of list\n", dev_name(dev));
183552cdbdd4SGrygorii Strashko 	spin_lock(&devices_kset->list_lock);
183652cdbdd4SGrygorii Strashko 	list_move_tail(&dev->kobj.entry, &devices_kset->list);
183752cdbdd4SGrygorii Strashko 	spin_unlock(&devices_kset->list_lock);
183852cdbdd4SGrygorii Strashko }
183952cdbdd4SGrygorii Strashko 
184052cdbdd4SGrygorii Strashko /**
18411da177e4SLinus Torvalds  * device_create_file - create sysfs attribute file for device.
18421da177e4SLinus Torvalds  * @dev: device.
18431da177e4SLinus Torvalds  * @attr: device attribute descriptor.
18441da177e4SLinus Torvalds  */
184526579ab7SPhil Carmody int device_create_file(struct device *dev,
184626579ab7SPhil Carmody 		       const struct device_attribute *attr)
18471da177e4SLinus Torvalds {
18481da177e4SLinus Torvalds 	int error = 0;
18498f46baaaSFelipe Balbi 
18508f46baaaSFelipe Balbi 	if (dev) {
18518f46baaaSFelipe Balbi 		WARN(((attr->attr.mode & S_IWUGO) && !attr->store),
185297521978Sdyoung@redhat.com 			"Attribute %s: write permission without 'store'\n",
185397521978Sdyoung@redhat.com 			attr->attr.name);
18548f46baaaSFelipe Balbi 		WARN(((attr->attr.mode & S_IRUGO) && !attr->show),
185597521978Sdyoung@redhat.com 			"Attribute %s: read permission without 'show'\n",
185697521978Sdyoung@redhat.com 			attr->attr.name);
18571da177e4SLinus Torvalds 		error = sysfs_create_file(&dev->kobj, &attr->attr);
18588f46baaaSFelipe Balbi 	}
18598f46baaaSFelipe Balbi 
18601da177e4SLinus Torvalds 	return error;
18611da177e4SLinus Torvalds }
186286df2687SDavid Graham White EXPORT_SYMBOL_GPL(device_create_file);
18631da177e4SLinus Torvalds 
18641da177e4SLinus Torvalds /**
18651da177e4SLinus Torvalds  * device_remove_file - remove sysfs attribute file.
18661da177e4SLinus Torvalds  * @dev: device.
18671da177e4SLinus Torvalds  * @attr: device attribute descriptor.
18681da177e4SLinus Torvalds  */
186926579ab7SPhil Carmody void device_remove_file(struct device *dev,
187026579ab7SPhil Carmody 			const struct device_attribute *attr)
18711da177e4SLinus Torvalds {
18720c98b19fSCornelia Huck 	if (dev)
18731da177e4SLinus Torvalds 		sysfs_remove_file(&dev->kobj, &attr->attr);
18741da177e4SLinus Torvalds }
187586df2687SDavid Graham White EXPORT_SYMBOL_GPL(device_remove_file);
18761da177e4SLinus Torvalds 
18772589f188SGreg Kroah-Hartman /**
18786b0afc2aSTejun Heo  * device_remove_file_self - remove sysfs attribute file from its own method.
18796b0afc2aSTejun Heo  * @dev: device.
18806b0afc2aSTejun Heo  * @attr: device attribute descriptor.
18816b0afc2aSTejun Heo  *
18826b0afc2aSTejun Heo  * See kernfs_remove_self() for details.
18836b0afc2aSTejun Heo  */
18846b0afc2aSTejun Heo bool device_remove_file_self(struct device *dev,
18856b0afc2aSTejun Heo 			     const struct device_attribute *attr)
18866b0afc2aSTejun Heo {
18876b0afc2aSTejun Heo 	if (dev)
18886b0afc2aSTejun Heo 		return sysfs_remove_file_self(&dev->kobj, &attr->attr);
18896b0afc2aSTejun Heo 	else
18906b0afc2aSTejun Heo 		return false;
18916b0afc2aSTejun Heo }
18926b0afc2aSTejun Heo EXPORT_SYMBOL_GPL(device_remove_file_self);
18936b0afc2aSTejun Heo 
18946b0afc2aSTejun Heo /**
18952589f188SGreg Kroah-Hartman  * device_create_bin_file - create sysfs binary attribute file for device.
18962589f188SGreg Kroah-Hartman  * @dev: device.
18972589f188SGreg Kroah-Hartman  * @attr: device binary attribute descriptor.
18982589f188SGreg Kroah-Hartman  */
189966ecb92bSPhil Carmody int device_create_bin_file(struct device *dev,
190066ecb92bSPhil Carmody 			   const struct bin_attribute *attr)
19012589f188SGreg Kroah-Hartman {
19022589f188SGreg Kroah-Hartman 	int error = -EINVAL;
19032589f188SGreg Kroah-Hartman 	if (dev)
19042589f188SGreg Kroah-Hartman 		error = sysfs_create_bin_file(&dev->kobj, attr);
19052589f188SGreg Kroah-Hartman 	return error;
19062589f188SGreg Kroah-Hartman }
19072589f188SGreg Kroah-Hartman EXPORT_SYMBOL_GPL(device_create_bin_file);
19082589f188SGreg Kroah-Hartman 
19092589f188SGreg Kroah-Hartman /**
19102589f188SGreg Kroah-Hartman  * device_remove_bin_file - remove sysfs binary attribute file
19112589f188SGreg Kroah-Hartman  * @dev: device.
19122589f188SGreg Kroah-Hartman  * @attr: device binary attribute descriptor.
19132589f188SGreg Kroah-Hartman  */
191466ecb92bSPhil Carmody void device_remove_bin_file(struct device *dev,
191566ecb92bSPhil Carmody 			    const struct bin_attribute *attr)
19162589f188SGreg Kroah-Hartman {
19172589f188SGreg Kroah-Hartman 	if (dev)
19182589f188SGreg Kroah-Hartman 		sysfs_remove_bin_file(&dev->kobj, attr);
19192589f188SGreg Kroah-Hartman }
19202589f188SGreg Kroah-Hartman EXPORT_SYMBOL_GPL(device_remove_bin_file);
19212589f188SGreg Kroah-Hartman 
192234bb61f9SJames Bottomley static void klist_children_get(struct klist_node *n)
192334bb61f9SJames Bottomley {
1924f791b8c8SGreg Kroah-Hartman 	struct device_private *p = to_device_private_parent(n);
1925f791b8c8SGreg Kroah-Hartman 	struct device *dev = p->device;
192634bb61f9SJames Bottomley 
192734bb61f9SJames Bottomley 	get_device(dev);
192834bb61f9SJames Bottomley }
192934bb61f9SJames Bottomley 
193034bb61f9SJames Bottomley static void klist_children_put(struct klist_node *n)
193134bb61f9SJames Bottomley {
1932f791b8c8SGreg Kroah-Hartman 	struct device_private *p = to_device_private_parent(n);
1933f791b8c8SGreg Kroah-Hartman 	struct device *dev = p->device;
193434bb61f9SJames Bottomley 
193534bb61f9SJames Bottomley 	put_device(dev);
193634bb61f9SJames Bottomley }
193734bb61f9SJames Bottomley 
19381da177e4SLinus Torvalds /**
19391da177e4SLinus Torvalds  * device_initialize - init device structure.
19401da177e4SLinus Torvalds  * @dev: device.
19411da177e4SLinus Torvalds  *
19425739411aSCornelia Huck  * This prepares the device for use by other layers by initializing
19435739411aSCornelia Huck  * its fields.
19441da177e4SLinus Torvalds  * It is the first half of device_register(), if called by
19455739411aSCornelia Huck  * that function, though it can also be called separately, so one
19465739411aSCornelia Huck  * may use @dev's fields. In particular, get_device()/put_device()
19475739411aSCornelia Huck  * may be used for reference counting of @dev after calling this
19485739411aSCornelia Huck  * function.
19495739411aSCornelia Huck  *
1950b10d5efdSAlan Stern  * All fields in @dev must be initialized by the caller to 0, except
1951b10d5efdSAlan Stern  * for those explicitly set to some other value.  The simplest
1952b10d5efdSAlan Stern  * approach is to use kzalloc() to allocate the structure containing
1953b10d5efdSAlan Stern  * @dev.
1954b10d5efdSAlan Stern  *
19555739411aSCornelia Huck  * NOTE: Use put_device() to give up your reference instead of freeing
19565739411aSCornelia Huck  * @dev directly once you have called this function.
19571da177e4SLinus Torvalds  */
19581da177e4SLinus Torvalds void device_initialize(struct device *dev)
19591da177e4SLinus Torvalds {
1960881c6cfdSGreg Kroah-Hartman 	dev->kobj.kset = devices_kset;
1961f9cb074bSGreg Kroah-Hartman 	kobject_init(&dev->kobj, &device_ktype);
19621da177e4SLinus Torvalds 	INIT_LIST_HEAD(&dev->dma_pools);
19633142788bSThomas Gleixner 	mutex_init(&dev->mutex);
196487a30e1fSDan Williams #ifdef CONFIG_PROVE_LOCKING
196587a30e1fSDan Williams 	mutex_init(&dev->lockdep_mutex);
196687a30e1fSDan Williams #endif
19671704f47bSPeter Zijlstra 	lockdep_set_novalidate_class(&dev->mutex);
19689ac7849eSTejun Heo 	spin_lock_init(&dev->devres_lock);
19699ac7849eSTejun Heo 	INIT_LIST_HEAD(&dev->devres_head);
19703b98aeafSAlan Stern 	device_pm_init(dev);
197187348136SChristoph Hellwig 	set_dev_node(dev, -1);
19724a7cc831SJiang Liu #ifdef CONFIG_GENERIC_MSI_IRQ
19734a7cc831SJiang Liu 	INIT_LIST_HEAD(&dev->msi_list);
19744a7cc831SJiang Liu #endif
19759ed98953SRafael J. Wysocki 	INIT_LIST_HEAD(&dev->links.consumers);
19769ed98953SRafael J. Wysocki 	INIT_LIST_HEAD(&dev->links.suppliers);
1977e2ae9bccSSaravana Kannan 	INIT_LIST_HEAD(&dev->links.needs_suppliers);
1978fc5a251dSSaravana Kannan 	INIT_LIST_HEAD(&dev->links.defer_sync);
19799ed98953SRafael J. Wysocki 	dev->links.status = DL_DEV_NO_DRIVER;
19801da177e4SLinus Torvalds }
198186df2687SDavid Graham White EXPORT_SYMBOL_GPL(device_initialize);
19821da177e4SLinus Torvalds 
1983d73ce004STejun Heo struct kobject *virtual_device_parent(struct device *dev)
1984f0ee61a6SGreg Kroah-Hartman {
1985f0ee61a6SGreg Kroah-Hartman 	static struct kobject *virtual_dir = NULL;
1986f0ee61a6SGreg Kroah-Hartman 
1987f0ee61a6SGreg Kroah-Hartman 	if (!virtual_dir)
19884ff6abffSGreg Kroah-Hartman 		virtual_dir = kobject_create_and_add("virtual",
1989881c6cfdSGreg Kroah-Hartman 						     &devices_kset->kobj);
1990f0ee61a6SGreg Kroah-Hartman 
199186406245SKay Sievers 	return virtual_dir;
1992f0ee61a6SGreg Kroah-Hartman }
1993f0ee61a6SGreg Kroah-Hartman 
1994bc451f20SEric W. Biederman struct class_dir {
1995bc451f20SEric W. Biederman 	struct kobject kobj;
1996bc451f20SEric W. Biederman 	struct class *class;
1997bc451f20SEric W. Biederman };
1998bc451f20SEric W. Biederman 
1999bc451f20SEric W. Biederman #define to_class_dir(obj) container_of(obj, struct class_dir, kobj)
2000bc451f20SEric W. Biederman 
2001bc451f20SEric W. Biederman static void class_dir_release(struct kobject *kobj)
2002bc451f20SEric W. Biederman {
2003bc451f20SEric W. Biederman 	struct class_dir *dir = to_class_dir(kobj);
2004bc451f20SEric W. Biederman 	kfree(dir);
2005bc451f20SEric W. Biederman }
2006bc451f20SEric W. Biederman 
2007bc451f20SEric W. Biederman static const
2008bc451f20SEric W. Biederman struct kobj_ns_type_operations *class_dir_child_ns_type(struct kobject *kobj)
2009bc451f20SEric W. Biederman {
2010bc451f20SEric W. Biederman 	struct class_dir *dir = to_class_dir(kobj);
2011bc451f20SEric W. Biederman 	return dir->class->ns_type;
2012bc451f20SEric W. Biederman }
2013bc451f20SEric W. Biederman 
2014bc451f20SEric W. Biederman static struct kobj_type class_dir_ktype = {
2015bc451f20SEric W. Biederman 	.release	= class_dir_release,
2016bc451f20SEric W. Biederman 	.sysfs_ops	= &kobj_sysfs_ops,
2017bc451f20SEric W. Biederman 	.child_ns_type	= class_dir_child_ns_type
2018bc451f20SEric W. Biederman };
2019bc451f20SEric W. Biederman 
2020bc451f20SEric W. Biederman static struct kobject *
2021bc451f20SEric W. Biederman class_dir_create_and_add(struct class *class, struct kobject *parent_kobj)
2022bc451f20SEric W. Biederman {
2023bc451f20SEric W. Biederman 	struct class_dir *dir;
2024bc451f20SEric W. Biederman 	int retval;
2025bc451f20SEric W. Biederman 
2026bc451f20SEric W. Biederman 	dir = kzalloc(sizeof(*dir), GFP_KERNEL);
2027bc451f20SEric W. Biederman 	if (!dir)
202884d0c27dSTetsuo Handa 		return ERR_PTR(-ENOMEM);
2029bc451f20SEric W. Biederman 
2030bc451f20SEric W. Biederman 	dir->class = class;
2031bc451f20SEric W. Biederman 	kobject_init(&dir->kobj, &class_dir_ktype);
2032bc451f20SEric W. Biederman 
20336b6e39a6SKay Sievers 	dir->kobj.kset = &class->p->glue_dirs;
2034bc451f20SEric W. Biederman 
2035bc451f20SEric W. Biederman 	retval = kobject_add(&dir->kobj, parent_kobj, "%s", class->name);
2036bc451f20SEric W. Biederman 	if (retval < 0) {
2037bc451f20SEric W. Biederman 		kobject_put(&dir->kobj);
203884d0c27dSTetsuo Handa 		return ERR_PTR(retval);
2039bc451f20SEric W. Biederman 	}
2040bc451f20SEric W. Biederman 	return &dir->kobj;
2041bc451f20SEric W. Biederman }
2042bc451f20SEric W. Biederman 
2043e4a60d13SYijing Wang static DEFINE_MUTEX(gdp_mutex);
2044bc451f20SEric W. Biederman 
2045c744aeaeSCornelia Huck static struct kobject *get_device_parent(struct device *dev,
2046c744aeaeSCornelia Huck 					 struct device *parent)
204740fa5422SGreg Kroah-Hartman {
204886406245SKay Sievers 	if (dev->class) {
204986406245SKay Sievers 		struct kobject *kobj = NULL;
205086406245SKay Sievers 		struct kobject *parent_kobj;
205186406245SKay Sievers 		struct kobject *k;
205286406245SKay Sievers 
2053ead454feSRandy Dunlap #ifdef CONFIG_BLOCK
205439aba963SKay Sievers 		/* block disks show up in /sys/block */
2055e52eec13SAndi Kleen 		if (sysfs_deprecated && dev->class == &block_class) {
205639aba963SKay Sievers 			if (parent && parent->class == &block_class)
205739aba963SKay Sievers 				return &parent->kobj;
20586b6e39a6SKay Sievers 			return &block_class.p->subsys.kobj;
205939aba963SKay Sievers 		}
2060ead454feSRandy Dunlap #endif
2061e52eec13SAndi Kleen 
206286406245SKay Sievers 		/*
206386406245SKay Sievers 		 * If we have no parent, we live in "virtual".
20640f4dafc0SKay Sievers 		 * Class-devices with a non class-device as parent, live
20650f4dafc0SKay Sievers 		 * in a "glue" directory to prevent namespace collisions.
206686406245SKay Sievers 		 */
206786406245SKay Sievers 		if (parent == NULL)
206886406245SKay Sievers 			parent_kobj = virtual_device_parent(dev);
206924b1442dSEric W. Biederman 		else if (parent->class && !dev->class->ns_type)
207086406245SKay Sievers 			return &parent->kobj;
207186406245SKay Sievers 		else
207286406245SKay Sievers 			parent_kobj = &parent->kobj;
207386406245SKay Sievers 
207477d3d7c1STejun Heo 		mutex_lock(&gdp_mutex);
207577d3d7c1STejun Heo 
207686406245SKay Sievers 		/* find our class-directory at the parent and reference it */
20776b6e39a6SKay Sievers 		spin_lock(&dev->class->p->glue_dirs.list_lock);
20786b6e39a6SKay Sievers 		list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry)
207986406245SKay Sievers 			if (k->parent == parent_kobj) {
208086406245SKay Sievers 				kobj = kobject_get(k);
208186406245SKay Sievers 				break;
208286406245SKay Sievers 			}
20836b6e39a6SKay Sievers 		spin_unlock(&dev->class->p->glue_dirs.list_lock);
208477d3d7c1STejun Heo 		if (kobj) {
208577d3d7c1STejun Heo 			mutex_unlock(&gdp_mutex);
208686406245SKay Sievers 			return kobj;
208777d3d7c1STejun Heo 		}
208886406245SKay Sievers 
208986406245SKay Sievers 		/* or create a new class-directory at the parent device */
2090bc451f20SEric W. Biederman 		k = class_dir_create_and_add(dev->class, parent_kobj);
20910f4dafc0SKay Sievers 		/* do not emit an uevent for this simple "glue" directory */
209277d3d7c1STejun Heo 		mutex_unlock(&gdp_mutex);
209343968d2fSGreg Kroah-Hartman 		return k;
209486406245SKay Sievers 	}
209586406245SKay Sievers 
2096ca22e56dSKay Sievers 	/* subsystems can specify a default root directory for their devices */
2097ca22e56dSKay Sievers 	if (!parent && dev->bus && dev->bus->dev_root)
2098ca22e56dSKay Sievers 		return &dev->bus->dev_root->kobj;
2099ca22e56dSKay Sievers 
210086406245SKay Sievers 	if (parent)
2101c744aeaeSCornelia Huck 		return &parent->kobj;
2102c744aeaeSCornelia Huck 	return NULL;
2103c744aeaeSCornelia Huck }
2104da231fd5SKay Sievers 
2105cebf8fd1SMing Lei static inline bool live_in_glue_dir(struct kobject *kobj,
2106cebf8fd1SMing Lei 				    struct device *dev)
2107cebf8fd1SMing Lei {
2108cebf8fd1SMing Lei 	if (!kobj || !dev->class ||
2109cebf8fd1SMing Lei 	    kobj->kset != &dev->class->p->glue_dirs)
2110cebf8fd1SMing Lei 		return false;
2111cebf8fd1SMing Lei 	return true;
2112cebf8fd1SMing Lei }
2113cebf8fd1SMing Lei 
2114cebf8fd1SMing Lei static inline struct kobject *get_glue_dir(struct device *dev)
2115cebf8fd1SMing Lei {
2116cebf8fd1SMing Lei 	return dev->kobj.parent;
2117cebf8fd1SMing Lei }
2118cebf8fd1SMing Lei 
2119cebf8fd1SMing Lei /*
2120cebf8fd1SMing Lei  * make sure cleaning up dir as the last step, we need to make
2121cebf8fd1SMing Lei  * sure .release handler of kobject is run with holding the
2122cebf8fd1SMing Lei  * global lock
2123cebf8fd1SMing Lei  */
212463b6971aSCornelia Huck static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir)
2125da231fd5SKay Sievers {
2126ac43432cSMuchun Song 	unsigned int ref;
2127ac43432cSMuchun Song 
21280f4dafc0SKay Sievers 	/* see if we live in a "glue" directory */
2129cebf8fd1SMing Lei 	if (!live_in_glue_dir(glue_dir, dev))
2130da231fd5SKay Sievers 		return;
2131da231fd5SKay Sievers 
2132e4a60d13SYijing Wang 	mutex_lock(&gdp_mutex);
2133ac43432cSMuchun Song 	/**
2134ac43432cSMuchun Song 	 * There is a race condition between removing glue directory
2135ac43432cSMuchun Song 	 * and adding a new device under the glue directory.
2136ac43432cSMuchun Song 	 *
2137ac43432cSMuchun Song 	 * CPU1:                                         CPU2:
2138ac43432cSMuchun Song 	 *
2139ac43432cSMuchun Song 	 * device_add()
2140ac43432cSMuchun Song 	 *   get_device_parent()
2141ac43432cSMuchun Song 	 *     class_dir_create_and_add()
2142ac43432cSMuchun Song 	 *       kobject_add_internal()
2143ac43432cSMuchun Song 	 *         create_dir()    // create glue_dir
2144ac43432cSMuchun Song 	 *
2145ac43432cSMuchun Song 	 *                                               device_add()
2146ac43432cSMuchun Song 	 *                                                 get_device_parent()
2147ac43432cSMuchun Song 	 *                                                   kobject_get() // get glue_dir
2148ac43432cSMuchun Song 	 *
2149ac43432cSMuchun Song 	 * device_del()
2150ac43432cSMuchun Song 	 *   cleanup_glue_dir()
2151ac43432cSMuchun Song 	 *     kobject_del(glue_dir)
2152ac43432cSMuchun Song 	 *
2153ac43432cSMuchun Song 	 *                                               kobject_add()
2154ac43432cSMuchun Song 	 *                                                 kobject_add_internal()
2155ac43432cSMuchun Song 	 *                                                   create_dir() // in glue_dir
2156ac43432cSMuchun Song 	 *                                                     sysfs_create_dir_ns()
2157ac43432cSMuchun Song 	 *                                                       kernfs_create_dir_ns(sd)
2158ac43432cSMuchun Song 	 *
2159ac43432cSMuchun Song 	 *       sysfs_remove_dir() // glue_dir->sd=NULL
2160ac43432cSMuchun Song 	 *       sysfs_put()        // free glue_dir->sd
2161ac43432cSMuchun Song 	 *
2162ac43432cSMuchun Song 	 *                                                         // sd is freed
2163ac43432cSMuchun Song 	 *                                                         kernfs_new_node(sd)
2164ac43432cSMuchun Song 	 *                                                           kernfs_get(glue_dir)
2165ac43432cSMuchun Song 	 *                                                           kernfs_add_one()
2166ac43432cSMuchun Song 	 *                                                           kernfs_put()
2167ac43432cSMuchun Song 	 *
2168ac43432cSMuchun Song 	 * Before CPU1 remove last child device under glue dir, if CPU2 add
2169ac43432cSMuchun Song 	 * a new device under glue dir, the glue_dir kobject reference count
2170ac43432cSMuchun Song 	 * will be increase to 2 in kobject_get(k). And CPU2 has been called
2171ac43432cSMuchun Song 	 * kernfs_create_dir_ns(). Meanwhile, CPU1 call sysfs_remove_dir()
2172ac43432cSMuchun Song 	 * and sysfs_put(). This result in glue_dir->sd is freed.
2173ac43432cSMuchun Song 	 *
2174ac43432cSMuchun Song 	 * Then the CPU2 will see a stale "empty" but still potentially used
2175ac43432cSMuchun Song 	 * glue dir around in kernfs_new_node().
2176ac43432cSMuchun Song 	 *
2177ac43432cSMuchun Song 	 * In order to avoid this happening, we also should make sure that
2178ac43432cSMuchun Song 	 * kernfs_node for glue_dir is released in CPU1 only when refcount
2179ac43432cSMuchun Song 	 * for glue_dir kobj is 1.
2180ac43432cSMuchun Song 	 */
2181ac43432cSMuchun Song 	ref = kref_read(&glue_dir->kref);
2182ac43432cSMuchun Song 	if (!kobject_has_children(glue_dir) && !--ref)
2183726e4109SBenjamin Herrenschmidt 		kobject_del(glue_dir);
21840f4dafc0SKay Sievers 	kobject_put(glue_dir);
2185e4a60d13SYijing Wang 	mutex_unlock(&gdp_mutex);
2186da231fd5SKay Sievers }
218763b6971aSCornelia Huck 
21882ee97cafSCornelia Huck static int device_add_class_symlinks(struct device *dev)
21892ee97cafSCornelia Huck {
21905590f319SBenjamin Herrenschmidt 	struct device_node *of_node = dev_of_node(dev);
21912ee97cafSCornelia Huck 	int error;
21922ee97cafSCornelia Huck 
21935590f319SBenjamin Herrenschmidt 	if (of_node) {
21940c3c234bSRob Herring 		error = sysfs_create_link(&dev->kobj, of_node_kobj(of_node), "of_node");
21955590f319SBenjamin Herrenschmidt 		if (error)
21965590f319SBenjamin Herrenschmidt 			dev_warn(dev, "Error %d creating of_node link\n",error);
21975590f319SBenjamin Herrenschmidt 		/* An error here doesn't warrant bringing down the device */
21985590f319SBenjamin Herrenschmidt 	}
21995590f319SBenjamin Herrenschmidt 
22002ee97cafSCornelia Huck 	if (!dev->class)
22012ee97cafSCornelia Huck 		return 0;
2202da231fd5SKay Sievers 
22031fbfee6cSGreg Kroah-Hartman 	error = sysfs_create_link(&dev->kobj,
22046b6e39a6SKay Sievers 				  &dev->class->p->subsys.kobj,
22052ee97cafSCornelia Huck 				  "subsystem");
22062ee97cafSCornelia Huck 	if (error)
22075590f319SBenjamin Herrenschmidt 		goto out_devnode;
2208da231fd5SKay Sievers 
22094e886c29SGreg Kroah-Hartman 	if (dev->parent && device_is_not_partition(dev)) {
22104f01a757SDmitry Torokhov 		error = sysfs_create_link(&dev->kobj, &dev->parent->kobj,
22114f01a757SDmitry Torokhov 					  "device");
22124f01a757SDmitry Torokhov 		if (error)
221339aba963SKay Sievers 			goto out_subsys;
22142ee97cafSCornelia Huck 	}
221539aba963SKay Sievers 
2216ead454feSRandy Dunlap #ifdef CONFIG_BLOCK
221739aba963SKay Sievers 	/* /sys/block has directories and does not need symlinks */
2218e52eec13SAndi Kleen 	if (sysfs_deprecated && dev->class == &block_class)
221939aba963SKay Sievers 		return 0;
2220ead454feSRandy Dunlap #endif
222139aba963SKay Sievers 
222239aba963SKay Sievers 	/* link in the class directory pointing to the device */
22236b6e39a6SKay Sievers 	error = sysfs_create_link(&dev->class->p->subsys.kobj,
222439aba963SKay Sievers 				  &dev->kobj, dev_name(dev));
222539aba963SKay Sievers 	if (error)
222639aba963SKay Sievers 		goto out_device;
222739aba963SKay Sievers 
22282ee97cafSCornelia Huck 	return 0;
22292ee97cafSCornelia Huck 
223039aba963SKay Sievers out_device:
223139aba963SKay Sievers 	sysfs_remove_link(&dev->kobj, "device");
2232da231fd5SKay Sievers 
22332ee97cafSCornelia Huck out_subsys:
22342ee97cafSCornelia Huck 	sysfs_remove_link(&dev->kobj, "subsystem");
22355590f319SBenjamin Herrenschmidt out_devnode:
22365590f319SBenjamin Herrenschmidt 	sysfs_remove_link(&dev->kobj, "of_node");
22372ee97cafSCornelia Huck 	return error;
22382ee97cafSCornelia Huck }
22392ee97cafSCornelia Huck 
22402ee97cafSCornelia Huck static void device_remove_class_symlinks(struct device *dev)
22412ee97cafSCornelia Huck {
22425590f319SBenjamin Herrenschmidt 	if (dev_of_node(dev))
22435590f319SBenjamin Herrenschmidt 		sysfs_remove_link(&dev->kobj, "of_node");
22445590f319SBenjamin Herrenschmidt 
22452ee97cafSCornelia Huck 	if (!dev->class)
22462ee97cafSCornelia Huck 		return;
2247da231fd5SKay Sievers 
22484e886c29SGreg Kroah-Hartman 	if (dev->parent && device_is_not_partition(dev))
2249da231fd5SKay Sievers 		sysfs_remove_link(&dev->kobj, "device");
22502ee97cafSCornelia Huck 	sysfs_remove_link(&dev->kobj, "subsystem");
2251ead454feSRandy Dunlap #ifdef CONFIG_BLOCK
2252e52eec13SAndi Kleen 	if (sysfs_deprecated && dev->class == &block_class)
225339aba963SKay Sievers 		return;
2254ead454feSRandy Dunlap #endif
22556b6e39a6SKay Sievers 	sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev));
22562ee97cafSCornelia Huck }
22572ee97cafSCornelia Huck 
22581da177e4SLinus Torvalds /**
2259413c239fSStephen Rothwell  * dev_set_name - set a device name
2260413c239fSStephen Rothwell  * @dev: device
226146232366SRandy Dunlap  * @fmt: format string for the device's name
2262413c239fSStephen Rothwell  */
2263413c239fSStephen Rothwell int dev_set_name(struct device *dev, const char *fmt, ...)
2264413c239fSStephen Rothwell {
2265413c239fSStephen Rothwell 	va_list vargs;
22661fa5ae85SKay Sievers 	int err;
2267413c239fSStephen Rothwell 
2268413c239fSStephen Rothwell 	va_start(vargs, fmt);
22691fa5ae85SKay Sievers 	err = kobject_set_name_vargs(&dev->kobj, fmt, vargs);
2270413c239fSStephen Rothwell 	va_end(vargs);
22711fa5ae85SKay Sievers 	return err;
2272413c239fSStephen Rothwell }
2273413c239fSStephen Rothwell EXPORT_SYMBOL_GPL(dev_set_name);
2274413c239fSStephen Rothwell 
2275413c239fSStephen Rothwell /**
2276e105b8bfSDan Williams  * device_to_dev_kobj - select a /sys/dev/ directory for the device
2277e105b8bfSDan Williams  * @dev: device
2278e105b8bfSDan Williams  *
2279e105b8bfSDan Williams  * By default we select char/ for new entries.  Setting class->dev_obj
2280e105b8bfSDan Williams  * to NULL prevents an entry from being created.  class->dev_kobj must
2281e105b8bfSDan Williams  * be set (or cleared) before any devices are registered to the class
2282e105b8bfSDan Williams  * otherwise device_create_sys_dev_entry() and
22830d4e293cSPeter Korsgaard  * device_remove_sys_dev_entry() will disagree about the presence of
22840d4e293cSPeter Korsgaard  * the link.
2285e105b8bfSDan Williams  */
2286e105b8bfSDan Williams static struct kobject *device_to_dev_kobj(struct device *dev)
2287e105b8bfSDan Williams {
2288e105b8bfSDan Williams 	struct kobject *kobj;
2289e105b8bfSDan Williams 
2290e105b8bfSDan Williams 	if (dev->class)
2291e105b8bfSDan Williams 		kobj = dev->class->dev_kobj;
2292e105b8bfSDan Williams 	else
2293e105b8bfSDan Williams 		kobj = sysfs_dev_char_kobj;
2294e105b8bfSDan Williams 
2295e105b8bfSDan Williams 	return kobj;
2296e105b8bfSDan Williams }
2297e105b8bfSDan Williams 
2298e105b8bfSDan Williams static int device_create_sys_dev_entry(struct device *dev)
2299e105b8bfSDan Williams {
2300e105b8bfSDan Williams 	struct kobject *kobj = device_to_dev_kobj(dev);
2301e105b8bfSDan Williams 	int error = 0;
2302e105b8bfSDan Williams 	char devt_str[15];
2303e105b8bfSDan Williams 
2304e105b8bfSDan Williams 	if (kobj) {
2305e105b8bfSDan Williams 		format_dev_t(devt_str, dev->devt);
2306e105b8bfSDan Williams 		error = sysfs_create_link(kobj, &dev->kobj, devt_str);
2307e105b8bfSDan Williams 	}
2308e105b8bfSDan Williams 
2309e105b8bfSDan Williams 	return error;
2310e105b8bfSDan Williams }
2311e105b8bfSDan Williams 
2312e105b8bfSDan Williams static void device_remove_sys_dev_entry(struct device *dev)
2313e105b8bfSDan Williams {
2314e105b8bfSDan Williams 	struct kobject *kobj = device_to_dev_kobj(dev);
2315e105b8bfSDan Williams 	char devt_str[15];
2316e105b8bfSDan Williams 
2317e105b8bfSDan Williams 	if (kobj) {
2318e105b8bfSDan Williams 		format_dev_t(devt_str, dev->devt);
2319e105b8bfSDan Williams 		sysfs_remove_link(kobj, devt_str);
2320e105b8bfSDan Williams 	}
2321e105b8bfSDan Williams }
2322e105b8bfSDan Williams 
232346d3a037SShaokun Zhang static int device_private_init(struct device *dev)
2324b4028437SGreg Kroah-Hartman {
2325b4028437SGreg Kroah-Hartman 	dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL);
2326b4028437SGreg Kroah-Hartman 	if (!dev->p)
2327b4028437SGreg Kroah-Hartman 		return -ENOMEM;
2328b4028437SGreg Kroah-Hartman 	dev->p->device = dev;
2329b4028437SGreg Kroah-Hartman 	klist_init(&dev->p->klist_children, klist_children_get,
2330b4028437SGreg Kroah-Hartman 		   klist_children_put);
2331ef8a3fd6SGreg Kroah-Hartman 	INIT_LIST_HEAD(&dev->p->deferred_probe);
2332b4028437SGreg Kroah-Hartman 	return 0;
2333b4028437SGreg Kroah-Hartman }
2334b4028437SGreg Kroah-Hartman 
23358375e74fSSaravana Kannan u32 fw_devlink_flags;
23368375e74fSSaravana Kannan static int __init fw_devlink_setup(char *arg)
23378375e74fSSaravana Kannan {
23388375e74fSSaravana Kannan 	if (!arg)
23398375e74fSSaravana Kannan 		return -EINVAL;
23408375e74fSSaravana Kannan 
23418375e74fSSaravana Kannan 	if (strcmp(arg, "off") == 0) {
23428375e74fSSaravana Kannan 		fw_devlink_flags = 0;
23438375e74fSSaravana Kannan 	} else if (strcmp(arg, "permissive") == 0) {
23448375e74fSSaravana Kannan 		fw_devlink_flags = DL_FLAG_SYNC_STATE_ONLY;
23458375e74fSSaravana Kannan 	} else if (strcmp(arg, "on") == 0) {
23468375e74fSSaravana Kannan 		fw_devlink_flags = DL_FLAG_AUTOPROBE_CONSUMER;
23478375e74fSSaravana Kannan 	} else if (strcmp(arg, "rpm") == 0) {
23488375e74fSSaravana Kannan 		fw_devlink_flags = DL_FLAG_AUTOPROBE_CONSUMER |
23498375e74fSSaravana Kannan 				   DL_FLAG_PM_RUNTIME;
23508375e74fSSaravana Kannan 	}
23518375e74fSSaravana Kannan 	return 0;
23528375e74fSSaravana Kannan }
23538375e74fSSaravana Kannan early_param("fw_devlink", fw_devlink_setup);
23548375e74fSSaravana Kannan 
23558375e74fSSaravana Kannan u32 fw_devlink_get_flags(void)
23568375e74fSSaravana Kannan {
23578375e74fSSaravana Kannan 	return fw_devlink_flags;
23588375e74fSSaravana Kannan }
23598375e74fSSaravana Kannan 
2360e105b8bfSDan Williams /**
23611da177e4SLinus Torvalds  * device_add - add device to device hierarchy.
23621da177e4SLinus Torvalds  * @dev: device.
23631da177e4SLinus Torvalds  *
23641da177e4SLinus Torvalds  * This is part 2 of device_register(), though may be called
23651da177e4SLinus Torvalds  * separately _iff_ device_initialize() has been called separately.
23661da177e4SLinus Torvalds  *
23675739411aSCornelia Huck  * This adds @dev to the kobject hierarchy via kobject_add(), adds it
23681da177e4SLinus Torvalds  * to the global and sibling lists for the device, then
23691da177e4SLinus Torvalds  * adds it to the other relevant subsystems of the driver model.
23705739411aSCornelia Huck  *
2371b10d5efdSAlan Stern  * Do not call this routine or device_register() more than once for
2372b10d5efdSAlan Stern  * any device structure.  The driver model core is not designed to work
2373b10d5efdSAlan Stern  * with devices that get unregistered and then spring back to life.
2374b10d5efdSAlan Stern  * (Among other things, it's very hard to guarantee that all references
2375b10d5efdSAlan Stern  * to the previous incarnation of @dev have been dropped.)  Allocate
2376b10d5efdSAlan Stern  * and register a fresh new struct device instead.
2377b10d5efdSAlan Stern  *
23785739411aSCornelia Huck  * NOTE: _Never_ directly free @dev after calling this function, even
23795739411aSCornelia Huck  * if it returned an error! Always use put_device() to give up your
23805739411aSCornelia Huck  * reference instead.
2381affada72SBorislav Petkov  *
2382affada72SBorislav Petkov  * Rule of thumb is: if device_add() succeeds, you should call
2383affada72SBorislav Petkov  * device_del() when you want to get rid of it. If device_add() has
2384affada72SBorislav Petkov  * *not* succeeded, use *only* put_device() to drop the reference
2385affada72SBorislav Petkov  * count.
23861da177e4SLinus Torvalds  */
23871da177e4SLinus Torvalds int device_add(struct device *dev)
23881da177e4SLinus Torvalds {
238935dbf4efSViresh Kumar 	struct device *parent;
2390ca22e56dSKay Sievers 	struct kobject *kobj;
2391c47ed219SGreg Kroah-Hartman 	struct class_interface *class_intf;
239203324507SSaravana Kannan 	int error = -EINVAL, fw_ret;
2393cebf8fd1SMing Lei 	struct kobject *glue_dir = NULL;
2394775b64d2SRafael J. Wysocki 
23951da177e4SLinus Torvalds 	dev = get_device(dev);
2396c906a48aSGreg Kroah-Hartman 	if (!dev)
2397c906a48aSGreg Kroah-Hartman 		goto done;
2398c906a48aSGreg Kroah-Hartman 
2399fb069a5dSGreg Kroah-Hartman 	if (!dev->p) {
2400b4028437SGreg Kroah-Hartman 		error = device_private_init(dev);
2401b4028437SGreg Kroah-Hartman 		if (error)
2402fb069a5dSGreg Kroah-Hartman 			goto done;
2403fb069a5dSGreg Kroah-Hartman 	}
2404fb069a5dSGreg Kroah-Hartman 
24051fa5ae85SKay Sievers 	/*
24061fa5ae85SKay Sievers 	 * for statically allocated devices, which should all be converted
24071fa5ae85SKay Sievers 	 * some day, we need to initialize the name. We prevent reading back
24081fa5ae85SKay Sievers 	 * the name, and force the use of dev_name()
24091fa5ae85SKay Sievers 	 */
24101fa5ae85SKay Sievers 	if (dev->init_name) {
2411acc0e90fSGreg Kroah-Hartman 		dev_set_name(dev, "%s", dev->init_name);
24121fa5ae85SKay Sievers 		dev->init_name = NULL;
24131fa5ae85SKay Sievers 	}
2414c906a48aSGreg Kroah-Hartman 
2415ca22e56dSKay Sievers 	/* subsystems can specify simple device enumeration */
2416ca22e56dSKay Sievers 	if (!dev_name(dev) && dev->bus && dev->bus->dev_name)
2417ca22e56dSKay Sievers 		dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id);
2418ca22e56dSKay Sievers 
2419e6309e75SThomas Gleixner 	if (!dev_name(dev)) {
2420e6309e75SThomas Gleixner 		error = -EINVAL;
24215c8563d7SKay Sievers 		goto name_error;
2422e6309e75SThomas Gleixner 	}
24231da177e4SLinus Torvalds 
24241e0b2cf9SKay Sievers 	pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
2425c205ef48SGreg Kroah-Hartman 
24261da177e4SLinus Torvalds 	parent = get_device(dev->parent);
2427ca22e56dSKay Sievers 	kobj = get_device_parent(dev, parent);
242884d0c27dSTetsuo Handa 	if (IS_ERR(kobj)) {
242984d0c27dSTetsuo Handa 		error = PTR_ERR(kobj);
243084d0c27dSTetsuo Handa 		goto parent_error;
243184d0c27dSTetsuo Handa 	}
2432ca22e56dSKay Sievers 	if (kobj)
2433ca22e56dSKay Sievers 		dev->kobj.parent = kobj;
24341da177e4SLinus Torvalds 
24350d358f22SYinghai Lu 	/* use parent numa_node */
243656f2de81SZhen Lei 	if (parent && (dev_to_node(dev) == NUMA_NO_NODE))
24370d358f22SYinghai Lu 		set_dev_node(dev, dev_to_node(parent));
24380d358f22SYinghai Lu 
24391da177e4SLinus Torvalds 	/* first, register with generic layer. */
24408a577ffcSKay Sievers 	/* we require the name to be set before, and pass NULL */
24418a577ffcSKay Sievers 	error = kobject_add(&dev->kobj, dev->kobj.parent, NULL);
2442cebf8fd1SMing Lei 	if (error) {
2443cebf8fd1SMing Lei 		glue_dir = get_glue_dir(dev);
24441da177e4SLinus Torvalds 		goto Error;
2445cebf8fd1SMing Lei 	}
2446a7fd6706SKay Sievers 
244737022644SBrian Walsh 	/* notify platform of device entry */
244807de0e86SHeikki Krogerus 	error = device_platform_notify(dev, KOBJ_ADD);
244907de0e86SHeikki Krogerus 	if (error)
245007de0e86SHeikki Krogerus 		goto platform_error;
245137022644SBrian Walsh 
2452c5e064a6SGreg Kroah-Hartman 	error = device_create_file(dev, &dev_attr_uevent);
2453a306eea4SCornelia Huck 	if (error)
2454a306eea4SCornelia Huck 		goto attrError;
2455a7fd6706SKay Sievers 
24562ee97cafSCornelia Huck 	error = device_add_class_symlinks(dev);
24572ee97cafSCornelia Huck 	if (error)
24582ee97cafSCornelia Huck 		goto SymlinkError;
2459dc0afa83SCornelia Huck 	error = device_add_attrs(dev);
2460dc0afa83SCornelia Huck 	if (error)
24612620efefSGreg Kroah-Hartman 		goto AttrsError;
2462dc0afa83SCornelia Huck 	error = bus_add_device(dev);
2463dc0afa83SCornelia Huck 	if (error)
24641da177e4SLinus Torvalds 		goto BusError;
24653b98aeafSAlan Stern 	error = dpm_sysfs_add(dev);
246657eee3d2SRafael J. Wysocki 	if (error)
24673b98aeafSAlan Stern 		goto DPMError;
24683b98aeafSAlan Stern 	device_pm_add(dev);
2469ec0676eeSAlan Stern 
24700cd75047SSergey Klyaus 	if (MAJOR(dev->devt)) {
24710cd75047SSergey Klyaus 		error = device_create_file(dev, &dev_attr_dev);
24720cd75047SSergey Klyaus 		if (error)
24730cd75047SSergey Klyaus 			goto DevAttrError;
24740cd75047SSergey Klyaus 
24750cd75047SSergey Klyaus 		error = device_create_sys_dev_entry(dev);
24760cd75047SSergey Klyaus 		if (error)
24770cd75047SSergey Klyaus 			goto SysEntryError;
24780cd75047SSergey Klyaus 
24790cd75047SSergey Klyaus 		devtmpfs_create_node(dev);
24800cd75047SSergey Klyaus 	}
24810cd75047SSergey Klyaus 
2482ec0676eeSAlan Stern 	/* Notify clients of device addition.  This call must come
2483268863f4Smajianpeng 	 * after dpm_sysfs_add() and before kobject_uevent().
2484ec0676eeSAlan Stern 	 */
2485ec0676eeSAlan Stern 	if (dev->bus)
2486ec0676eeSAlan Stern 		blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
2487ec0676eeSAlan Stern 					     BUS_NOTIFY_ADD_DEVICE, dev);
2488ec0676eeSAlan Stern 
248953877d06SKay Sievers 	kobject_uevent(&dev->kobj, KOBJ_ADD);
2490372a67c0SSaravana Kannan 
2491372a67c0SSaravana Kannan 	if (dev->fwnode && !dev->fwnode->dev)
2492372a67c0SSaravana Kannan 		dev->fwnode->dev = dev;
2493372a67c0SSaravana Kannan 
2494e2ae9bccSSaravana Kannan 	/*
2495e2ae9bccSSaravana Kannan 	 * Check if any of the other devices (consumers) have been waiting for
2496e2ae9bccSSaravana Kannan 	 * this device (supplier) to be added so that they can create a device
2497e2ae9bccSSaravana Kannan 	 * link to it.
2498e2ae9bccSSaravana Kannan 	 *
2499e2ae9bccSSaravana Kannan 	 * This needs to happen after device_pm_add() because device_link_add()
2500e2ae9bccSSaravana Kannan 	 * requires the supplier be registered before it's called.
2501e2ae9bccSSaravana Kannan 	 *
2502e2ae9bccSSaravana Kannan 	 * But this also needs to happe before bus_probe_device() to make sure
2503e2ae9bccSSaravana Kannan 	 * waiting consumers can link to it before the driver is bound to the
2504e2ae9bccSSaravana Kannan 	 * device and the driver sync_state callback is called for this device.
2505e2ae9bccSSaravana Kannan 	 */
2506e2ae9bccSSaravana Kannan 	device_link_add_missing_supplier_links();
2507e2ae9bccSSaravana Kannan 
25088375e74fSSaravana Kannan 	if (fw_devlink_flags && fwnode_has_op(dev->fwnode, add_links)) {
250903324507SSaravana Kannan 		fw_ret = fwnode_call_int_op(dev->fwnode, add_links, dev);
251003324507SSaravana Kannan 		if (fw_ret == -ENODEV)
251103324507SSaravana Kannan 			device_link_wait_for_mandatory_supplier(dev);
251203324507SSaravana Kannan 		else if (fw_ret)
251303324507SSaravana Kannan 			device_link_wait_for_optional_supplier(dev);
251403324507SSaravana Kannan 	}
2515e2ae9bccSSaravana Kannan 
25162023c610SAlan Stern 	bus_probe_device(dev);
25171da177e4SLinus Torvalds 	if (parent)
2518f791b8c8SGreg Kroah-Hartman 		klist_add_tail(&dev->p->knode_parent,
2519f791b8c8SGreg Kroah-Hartman 			       &parent->p->klist_children);
25201da177e4SLinus Torvalds 
25215d9fd169SGreg Kroah-Hartman 	if (dev->class) {
2522ca22e56dSKay Sievers 		mutex_lock(&dev->class->p->mutex);
2523c47ed219SGreg Kroah-Hartman 		/* tie the class to the device */
2524570d0200SWei Yang 		klist_add_tail(&dev->p->knode_class,
25256b6e39a6SKay Sievers 			       &dev->class->p->klist_devices);
2526c47ed219SGreg Kroah-Hartman 
2527c47ed219SGreg Kroah-Hartman 		/* notify any interfaces that the device is here */
2528184f1f77SGreg Kroah-Hartman 		list_for_each_entry(class_intf,
2529ca22e56dSKay Sievers 				    &dev->class->p->interfaces, node)
2530c47ed219SGreg Kroah-Hartman 			if (class_intf->add_dev)
2531c47ed219SGreg Kroah-Hartman 				class_intf->add_dev(dev, class_intf);
2532ca22e56dSKay Sievers 		mutex_unlock(&dev->class->p->mutex);
25335d9fd169SGreg Kroah-Hartman 	}
2534c906a48aSGreg Kroah-Hartman done:
25351da177e4SLinus Torvalds 	put_device(dev);
25361da177e4SLinus Torvalds 	return error;
25370cd75047SSergey Klyaus  SysEntryError:
25380cd75047SSergey Klyaus 	if (MAJOR(dev->devt))
25390cd75047SSergey Klyaus 		device_remove_file(dev, &dev_attr_dev);
25400cd75047SSergey Klyaus  DevAttrError:
25410cd75047SSergey Klyaus 	device_pm_remove(dev);
25420cd75047SSergey Klyaus 	dpm_sysfs_remove(dev);
25433b98aeafSAlan Stern  DPMError:
254457eee3d2SRafael J. Wysocki 	bus_remove_device(dev);
254557eee3d2SRafael J. Wysocki  BusError:
25462620efefSGreg Kroah-Hartman 	device_remove_attrs(dev);
25472620efefSGreg Kroah-Hartman  AttrsError:
25482ee97cafSCornelia Huck 	device_remove_class_symlinks(dev);
25492ee97cafSCornelia Huck  SymlinkError:
2550c5e064a6SGreg Kroah-Hartman 	device_remove_file(dev, &dev_attr_uevent);
255123681e47SGreg Kroah-Hartman  attrError:
255207de0e86SHeikki Krogerus 	device_platform_notify(dev, KOBJ_REMOVE);
255307de0e86SHeikki Krogerus platform_error:
2554312c004dSKay Sievers 	kobject_uevent(&dev->kobj, KOBJ_REMOVE);
2555cebf8fd1SMing Lei 	glue_dir = get_glue_dir(dev);
25561da177e4SLinus Torvalds 	kobject_del(&dev->kobj);
25571da177e4SLinus Torvalds  Error:
2558cebf8fd1SMing Lei 	cleanup_glue_dir(dev, glue_dir);
255984d0c27dSTetsuo Handa parent_error:
25601da177e4SLinus Torvalds 	put_device(parent);
25615c8563d7SKay Sievers name_error:
25625c8563d7SKay Sievers 	kfree(dev->p);
25635c8563d7SKay Sievers 	dev->p = NULL;
2564c906a48aSGreg Kroah-Hartman 	goto done;
25651da177e4SLinus Torvalds }
256686df2687SDavid Graham White EXPORT_SYMBOL_GPL(device_add);
25671da177e4SLinus Torvalds 
25681da177e4SLinus Torvalds /**
25691da177e4SLinus Torvalds  * device_register - register a device with the system.
25701da177e4SLinus Torvalds  * @dev: pointer to the device structure
25711da177e4SLinus Torvalds  *
25721da177e4SLinus Torvalds  * This happens in two clean steps - initialize the device
25731da177e4SLinus Torvalds  * and add it to the system. The two steps can be called
25741da177e4SLinus Torvalds  * separately, but this is the easiest and most common.
25751da177e4SLinus Torvalds  * I.e. you should only call the two helpers separately if
25761da177e4SLinus Torvalds  * have a clearly defined need to use and refcount the device
25771da177e4SLinus Torvalds  * before it is added to the hierarchy.
25785739411aSCornelia Huck  *
2579b10d5efdSAlan Stern  * For more information, see the kerneldoc for device_initialize()
2580b10d5efdSAlan Stern  * and device_add().
2581b10d5efdSAlan Stern  *
25825739411aSCornelia Huck  * NOTE: _Never_ directly free @dev after calling this function, even
25835739411aSCornelia Huck  * if it returned an error! Always use put_device() to give up the
25845739411aSCornelia Huck  * reference initialized in this function instead.
25851da177e4SLinus Torvalds  */
25861da177e4SLinus Torvalds int device_register(struct device *dev)
25871da177e4SLinus Torvalds {
25881da177e4SLinus Torvalds 	device_initialize(dev);
25891da177e4SLinus Torvalds 	return device_add(dev);
25901da177e4SLinus Torvalds }
259186df2687SDavid Graham White EXPORT_SYMBOL_GPL(device_register);
25921da177e4SLinus Torvalds 
25931da177e4SLinus Torvalds /**
25941da177e4SLinus Torvalds  * get_device - increment reference count for device.
25951da177e4SLinus Torvalds  * @dev: device.
25961da177e4SLinus Torvalds  *
25971da177e4SLinus Torvalds  * This simply forwards the call to kobject_get(), though
25981da177e4SLinus Torvalds  * we do take care to provide for the case that we get a NULL
25991da177e4SLinus Torvalds  * pointer passed in.
26001da177e4SLinus Torvalds  */
26011da177e4SLinus Torvalds struct device *get_device(struct device *dev)
26021da177e4SLinus Torvalds {
2603b0d1f807SLars-Peter Clausen 	return dev ? kobj_to_dev(kobject_get(&dev->kobj)) : NULL;
26041da177e4SLinus Torvalds }
260586df2687SDavid Graham White EXPORT_SYMBOL_GPL(get_device);
26061da177e4SLinus Torvalds 
26071da177e4SLinus Torvalds /**
26081da177e4SLinus Torvalds  * put_device - decrement reference count.
26091da177e4SLinus Torvalds  * @dev: device in question.
26101da177e4SLinus Torvalds  */
26111da177e4SLinus Torvalds void put_device(struct device *dev)
26121da177e4SLinus Torvalds {
2613edfaa7c3SKay Sievers 	/* might_sleep(); */
26141da177e4SLinus Torvalds 	if (dev)
26151da177e4SLinus Torvalds 		kobject_put(&dev->kobj);
26161da177e4SLinus Torvalds }
261786df2687SDavid Graham White EXPORT_SYMBOL_GPL(put_device);
26181da177e4SLinus Torvalds 
261900289cd8SDan Williams bool kill_device(struct device *dev)
262000289cd8SDan Williams {
262100289cd8SDan Williams 	/*
262200289cd8SDan Williams 	 * Require the device lock and set the "dead" flag to guarantee that
262300289cd8SDan Williams 	 * the update behavior is consistent with the other bitfields near
262400289cd8SDan Williams 	 * it and that we cannot have an asynchronous probe routine trying
262500289cd8SDan Williams 	 * to run while we are tearing out the bus/class/sysfs from
262600289cd8SDan Williams 	 * underneath the device.
262700289cd8SDan Williams 	 */
262800289cd8SDan Williams 	lockdep_assert_held(&dev->mutex);
262900289cd8SDan Williams 
263000289cd8SDan Williams 	if (dev->p->dead)
263100289cd8SDan Williams 		return false;
263200289cd8SDan Williams 	dev->p->dead = true;
263300289cd8SDan Williams 	return true;
263400289cd8SDan Williams }
263500289cd8SDan Williams EXPORT_SYMBOL_GPL(kill_device);
263600289cd8SDan Williams 
26371da177e4SLinus Torvalds /**
26381da177e4SLinus Torvalds  * device_del - delete device from system.
26391da177e4SLinus Torvalds  * @dev: device.
26401da177e4SLinus Torvalds  *
26411da177e4SLinus Torvalds  * This is the first part of the device unregistration
26421da177e4SLinus Torvalds  * sequence. This removes the device from the lists we control
26431da177e4SLinus Torvalds  * from here, has it removed from the other driver model
26441da177e4SLinus Torvalds  * subsystems it was added to in device_add(), and removes it
26451da177e4SLinus Torvalds  * from the kobject hierarchy.
26461da177e4SLinus Torvalds  *
26471da177e4SLinus Torvalds  * NOTE: this should be called manually _iff_ device_add() was
26481da177e4SLinus Torvalds  * also called manually.
26491da177e4SLinus Torvalds  */
26501da177e4SLinus Torvalds void device_del(struct device *dev)
26511da177e4SLinus Torvalds {
26521da177e4SLinus Torvalds 	struct device *parent = dev->parent;
2653cebf8fd1SMing Lei 	struct kobject *glue_dir = NULL;
2654c47ed219SGreg Kroah-Hartman 	struct class_interface *class_intf;
26551da177e4SLinus Torvalds 
26563451a495SAlexander Duyck 	device_lock(dev);
265700289cd8SDan Williams 	kill_device(dev);
26583451a495SAlexander Duyck 	device_unlock(dev);
26593451a495SAlexander Duyck 
2660372a67c0SSaravana Kannan 	if (dev->fwnode && dev->fwnode->dev == dev)
2661372a67c0SSaravana Kannan 		dev->fwnode->dev = NULL;
2662372a67c0SSaravana Kannan 
2663ec0676eeSAlan Stern 	/* Notify clients of device removal.  This call must come
2664ec0676eeSAlan Stern 	 * before dpm_sysfs_remove().
2665ec0676eeSAlan Stern 	 */
2666ec0676eeSAlan Stern 	if (dev->bus)
2667ec0676eeSAlan Stern 		blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
2668ec0676eeSAlan Stern 					     BUS_NOTIFY_DEL_DEVICE, dev);
26699ed98953SRafael J. Wysocki 
26703b98aeafSAlan Stern 	dpm_sysfs_remove(dev);
26711da177e4SLinus Torvalds 	if (parent)
2672f791b8c8SGreg Kroah-Hartman 		klist_del(&dev->p->knode_parent);
2673e105b8bfSDan Williams 	if (MAJOR(dev->devt)) {
26742b2af54aSKay Sievers 		devtmpfs_delete_node(dev);
2675e105b8bfSDan Williams 		device_remove_sys_dev_entry(dev);
2676c5e064a6SGreg Kroah-Hartman 		device_remove_file(dev, &dev_attr_dev);
2677e105b8bfSDan Williams 	}
2678b9d9c82bSKay Sievers 	if (dev->class) {
2679da231fd5SKay Sievers 		device_remove_class_symlinks(dev);
268099ef3ef8SKay Sievers 
2681ca22e56dSKay Sievers 		mutex_lock(&dev->class->p->mutex);
2682c47ed219SGreg Kroah-Hartman 		/* notify any interfaces that the device is now gone */
2683184f1f77SGreg Kroah-Hartman 		list_for_each_entry(class_intf,
2684ca22e56dSKay Sievers 				    &dev->class->p->interfaces, node)
2685c47ed219SGreg Kroah-Hartman 			if (class_intf->remove_dev)
2686c47ed219SGreg Kroah-Hartman 				class_intf->remove_dev(dev, class_intf);
2687c47ed219SGreg Kroah-Hartman 		/* remove the device from the class list */
2688570d0200SWei Yang 		klist_del(&dev->p->knode_class);
2689ca22e56dSKay Sievers 		mutex_unlock(&dev->class->p->mutex);
2690b9d9c82bSKay Sievers 	}
2691c5e064a6SGreg Kroah-Hartman 	device_remove_file(dev, &dev_attr_uevent);
26922620efefSGreg Kroah-Hartman 	device_remove_attrs(dev);
269328953533SBenjamin Herrenschmidt 	bus_remove_device(dev);
26944b6d1f12SLongX Zhang 	device_pm_remove(dev);
2695d1c3414cSGrant Likely 	driver_deferred_probe_del(dev);
269607de0e86SHeikki Krogerus 	device_platform_notify(dev, KOBJ_REMOVE);
2697478573c9SLukas Wunner 	device_remove_properties(dev);
26982ec16150SJeffy Chen 	device_links_purge(dev);
26991da177e4SLinus Torvalds 
2700599bad38SJoerg Roedel 	if (dev->bus)
2701599bad38SJoerg Roedel 		blocking_notifier_call_chain(&dev->bus->p->bus_notifier,
2702599bad38SJoerg Roedel 					     BUS_NOTIFY_REMOVED_DEVICE, dev);
2703312c004dSKay Sievers 	kobject_uevent(&dev->kobj, KOBJ_REMOVE);
2704cebf8fd1SMing Lei 	glue_dir = get_glue_dir(dev);
27051da177e4SLinus Torvalds 	kobject_del(&dev->kobj);
2706cebf8fd1SMing Lei 	cleanup_glue_dir(dev, glue_dir);
27071da177e4SLinus Torvalds 	put_device(parent);
27081da177e4SLinus Torvalds }
270986df2687SDavid Graham White EXPORT_SYMBOL_GPL(device_del);
27101da177e4SLinus Torvalds 
27111da177e4SLinus Torvalds /**
27121da177e4SLinus Torvalds  * device_unregister - unregister device from system.
27131da177e4SLinus Torvalds  * @dev: device going away.
27141da177e4SLinus Torvalds  *
27151da177e4SLinus Torvalds  * We do this in two parts, like we do device_register(). First,
27161da177e4SLinus Torvalds  * we remove it from all the subsystems with device_del(), then
27171da177e4SLinus Torvalds  * we decrement the reference count via put_device(). If that
27181da177e4SLinus Torvalds  * is the final reference count, the device will be cleaned up
27191da177e4SLinus Torvalds  * via device_release() above. Otherwise, the structure will
27201da177e4SLinus Torvalds  * stick around until the final reference to the device is dropped.
27211da177e4SLinus Torvalds  */
27221da177e4SLinus Torvalds void device_unregister(struct device *dev)
27231da177e4SLinus Torvalds {
27241e0b2cf9SKay Sievers 	pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
27251da177e4SLinus Torvalds 	device_del(dev);
27261da177e4SLinus Torvalds 	put_device(dev);
27271da177e4SLinus Torvalds }
272886df2687SDavid Graham White EXPORT_SYMBOL_GPL(device_unregister);
27291da177e4SLinus Torvalds 
27303d060aebSAndy Shevchenko static struct device *prev_device(struct klist_iter *i)
27313d060aebSAndy Shevchenko {
27323d060aebSAndy Shevchenko 	struct klist_node *n = klist_prev(i);
27333d060aebSAndy Shevchenko 	struct device *dev = NULL;
27343d060aebSAndy Shevchenko 	struct device_private *p;
27353d060aebSAndy Shevchenko 
27363d060aebSAndy Shevchenko 	if (n) {
27373d060aebSAndy Shevchenko 		p = to_device_private_parent(n);
27383d060aebSAndy Shevchenko 		dev = p->device;
27393d060aebSAndy Shevchenko 	}
27403d060aebSAndy Shevchenko 	return dev;
27413d060aebSAndy Shevchenko }
27423d060aebSAndy Shevchenko 
274336239577Smochel@digitalimplant.org static struct device *next_device(struct klist_iter *i)
274436239577Smochel@digitalimplant.org {
274536239577Smochel@digitalimplant.org 	struct klist_node *n = klist_next(i);
2746f791b8c8SGreg Kroah-Hartman 	struct device *dev = NULL;
2747f791b8c8SGreg Kroah-Hartman 	struct device_private *p;
2748f791b8c8SGreg Kroah-Hartman 
2749f791b8c8SGreg Kroah-Hartman 	if (n) {
2750f791b8c8SGreg Kroah-Hartman 		p = to_device_private_parent(n);
2751f791b8c8SGreg Kroah-Hartman 		dev = p->device;
2752f791b8c8SGreg Kroah-Hartman 	}
2753f791b8c8SGreg Kroah-Hartman 	return dev;
275436239577Smochel@digitalimplant.org }
275536239577Smochel@digitalimplant.org 
27561da177e4SLinus Torvalds /**
2757e454cea2SKay Sievers  * device_get_devnode - path of device node file
27586fcf53acSKay Sievers  * @dev: device
2759e454cea2SKay Sievers  * @mode: returned file access mode
27603c2670e6SKay Sievers  * @uid: returned file owner
27613c2670e6SKay Sievers  * @gid: returned file group
27626fcf53acSKay Sievers  * @tmp: possibly allocated string
27636fcf53acSKay Sievers  *
27646fcf53acSKay Sievers  * Return the relative path of a possible device node.
27656fcf53acSKay Sievers  * Non-default names may need to allocate a memory to compose
27666fcf53acSKay Sievers  * a name. This memory is returned in tmp and needs to be
27676fcf53acSKay Sievers  * freed by the caller.
27686fcf53acSKay Sievers  */
2769e454cea2SKay Sievers const char *device_get_devnode(struct device *dev,
27704e4098a3SGreg Kroah-Hartman 			       umode_t *mode, kuid_t *uid, kgid_t *gid,
27713c2670e6SKay Sievers 			       const char **tmp)
27726fcf53acSKay Sievers {
27736fcf53acSKay Sievers 	char *s;
27746fcf53acSKay Sievers 
27756fcf53acSKay Sievers 	*tmp = NULL;
27766fcf53acSKay Sievers 
27776fcf53acSKay Sievers 	/* the device type may provide a specific name */
2778e454cea2SKay Sievers 	if (dev->type && dev->type->devnode)
27793c2670e6SKay Sievers 		*tmp = dev->type->devnode(dev, mode, uid, gid);
27806fcf53acSKay Sievers 	if (*tmp)
27816fcf53acSKay Sievers 		return *tmp;
27826fcf53acSKay Sievers 
27836fcf53acSKay Sievers 	/* the class may provide a specific name */
2784e454cea2SKay Sievers 	if (dev->class && dev->class->devnode)
2785e454cea2SKay Sievers 		*tmp = dev->class->devnode(dev, mode);
27866fcf53acSKay Sievers 	if (*tmp)
27876fcf53acSKay Sievers 		return *tmp;
27886fcf53acSKay Sievers 
27896fcf53acSKay Sievers 	/* return name without allocation, tmp == NULL */
27906fcf53acSKay Sievers 	if (strchr(dev_name(dev), '!') == NULL)
27916fcf53acSKay Sievers 		return dev_name(dev);
27926fcf53acSKay Sievers 
27936fcf53acSKay Sievers 	/* replace '!' in the name with '/' */
2794a29fd614SRasmus Villemoes 	s = kstrdup(dev_name(dev), GFP_KERNEL);
2795a29fd614SRasmus Villemoes 	if (!s)
27966fcf53acSKay Sievers 		return NULL;
2797a29fd614SRasmus Villemoes 	strreplace(s, '!', '/');
2798a29fd614SRasmus Villemoes 	return *tmp = s;
27996fcf53acSKay Sievers }
28006fcf53acSKay Sievers 
28016fcf53acSKay Sievers /**
28021da177e4SLinus Torvalds  * device_for_each_child - device child iterator.
2803c41455fbSRandy Dunlap  * @parent: parent struct device.
28041da177e4SLinus Torvalds  * @fn: function to be called for each device.
2805f8878dcbSRobert P. J. Day  * @data: data for the callback.
28061da177e4SLinus Torvalds  *
2807c41455fbSRandy Dunlap  * Iterate over @parent's child devices, and call @fn for each,
28081da177e4SLinus Torvalds  * passing it @data.
28091da177e4SLinus Torvalds  *
28101da177e4SLinus Torvalds  * We check the return of @fn each time. If it returns anything
28111da177e4SLinus Torvalds  * other than 0, we break out and return that value.
28121da177e4SLinus Torvalds  */
281336239577Smochel@digitalimplant.org int device_for_each_child(struct device *parent, void *data,
28144a3ad20cSGreg Kroah-Hartman 			  int (*fn)(struct device *dev, void *data))
28151da177e4SLinus Torvalds {
281636239577Smochel@digitalimplant.org 	struct klist_iter i;
28171da177e4SLinus Torvalds 	struct device *child;
28181da177e4SLinus Torvalds 	int error = 0;
28191da177e4SLinus Torvalds 
2820014c90dbSGreg Kroah-Hartman 	if (!parent->p)
2821014c90dbSGreg Kroah-Hartman 		return 0;
2822014c90dbSGreg Kroah-Hartman 
2823f791b8c8SGreg Kroah-Hartman 	klist_iter_init(&parent->p->klist_children, &i);
282493ead7c9SGimcuan Hui 	while (!error && (child = next_device(&i)))
282536239577Smochel@digitalimplant.org 		error = fn(child, data);
282636239577Smochel@digitalimplant.org 	klist_iter_exit(&i);
28271da177e4SLinus Torvalds 	return error;
28281da177e4SLinus Torvalds }
282986df2687SDavid Graham White EXPORT_SYMBOL_GPL(device_for_each_child);
28301da177e4SLinus Torvalds 
28315ab69981SCornelia Huck /**
28323d060aebSAndy Shevchenko  * device_for_each_child_reverse - device child iterator in reversed order.
28333d060aebSAndy Shevchenko  * @parent: parent struct device.
28343d060aebSAndy Shevchenko  * @fn: function to be called for each device.
28353d060aebSAndy Shevchenko  * @data: data for the callback.
28363d060aebSAndy Shevchenko  *
28373d060aebSAndy Shevchenko  * Iterate over @parent's child devices, and call @fn for each,
28383d060aebSAndy Shevchenko  * passing it @data.
28393d060aebSAndy Shevchenko  *
28403d060aebSAndy Shevchenko  * We check the return of @fn each time. If it returns anything
28413d060aebSAndy Shevchenko  * other than 0, we break out and return that value.
28423d060aebSAndy Shevchenko  */
28433d060aebSAndy Shevchenko int device_for_each_child_reverse(struct device *parent, void *data,
28443d060aebSAndy Shevchenko 				  int (*fn)(struct device *dev, void *data))
28453d060aebSAndy Shevchenko {
28463d060aebSAndy Shevchenko 	struct klist_iter i;
28473d060aebSAndy Shevchenko 	struct device *child;
28483d060aebSAndy Shevchenko 	int error = 0;
28493d060aebSAndy Shevchenko 
28503d060aebSAndy Shevchenko 	if (!parent->p)
28513d060aebSAndy Shevchenko 		return 0;
28523d060aebSAndy Shevchenko 
28533d060aebSAndy Shevchenko 	klist_iter_init(&parent->p->klist_children, &i);
28543d060aebSAndy Shevchenko 	while ((child = prev_device(&i)) && !error)
28553d060aebSAndy Shevchenko 		error = fn(child, data);
28563d060aebSAndy Shevchenko 	klist_iter_exit(&i);
28573d060aebSAndy Shevchenko 	return error;
28583d060aebSAndy Shevchenko }
28593d060aebSAndy Shevchenko EXPORT_SYMBOL_GPL(device_for_each_child_reverse);
28603d060aebSAndy Shevchenko 
28613d060aebSAndy Shevchenko /**
28625ab69981SCornelia Huck  * device_find_child - device iterator for locating a particular device.
28635ab69981SCornelia Huck  * @parent: parent struct device
28645ab69981SCornelia Huck  * @match: Callback function to check device
2865f8878dcbSRobert P. J. Day  * @data: Data to pass to match function
28665ab69981SCornelia Huck  *
28675ab69981SCornelia Huck  * This is similar to the device_for_each_child() function above, but it
28685ab69981SCornelia Huck  * returns a reference to a device that is 'found' for later use, as
28695ab69981SCornelia Huck  * determined by the @match callback.
28705ab69981SCornelia Huck  *
28715ab69981SCornelia Huck  * The callback should return 0 if the device doesn't match and non-zero
28725ab69981SCornelia Huck  * if it does.  If the callback returns non-zero and a reference to the
28735ab69981SCornelia Huck  * current device can be obtained, this function will return to the caller
28745ab69981SCornelia Huck  * and not iterate over any more devices.
2875a4e2400aSFederico Vaga  *
2876a4e2400aSFederico Vaga  * NOTE: you will need to drop the reference with put_device() after use.
28775ab69981SCornelia Huck  */
28785ab69981SCornelia Huck struct device *device_find_child(struct device *parent, void *data,
28794a3ad20cSGreg Kroah-Hartman 				 int (*match)(struct device *dev, void *data))
28805ab69981SCornelia Huck {
28815ab69981SCornelia Huck 	struct klist_iter i;
28825ab69981SCornelia Huck 	struct device *child;
28835ab69981SCornelia Huck 
28845ab69981SCornelia Huck 	if (!parent)
28855ab69981SCornelia Huck 		return NULL;
28865ab69981SCornelia Huck 
2887f791b8c8SGreg Kroah-Hartman 	klist_iter_init(&parent->p->klist_children, &i);
28885ab69981SCornelia Huck 	while ((child = next_device(&i)))
28895ab69981SCornelia Huck 		if (match(child, data) && get_device(child))
28905ab69981SCornelia Huck 			break;
28915ab69981SCornelia Huck 	klist_iter_exit(&i);
28925ab69981SCornelia Huck 	return child;
28935ab69981SCornelia Huck }
289486df2687SDavid Graham White EXPORT_SYMBOL_GPL(device_find_child);
28955ab69981SCornelia Huck 
2896dad9bb01SHeikki Krogerus /**
2897dad9bb01SHeikki Krogerus  * device_find_child_by_name - device iterator for locating a child device.
2898dad9bb01SHeikki Krogerus  * @parent: parent struct device
2899dad9bb01SHeikki Krogerus  * @name: name of the child device
2900dad9bb01SHeikki Krogerus  *
2901dad9bb01SHeikki Krogerus  * This is similar to the device_find_child() function above, but it
2902dad9bb01SHeikki Krogerus  * returns a reference to a device that has the name @name.
2903dad9bb01SHeikki Krogerus  *
2904dad9bb01SHeikki Krogerus  * NOTE: you will need to drop the reference with put_device() after use.
2905dad9bb01SHeikki Krogerus  */
2906dad9bb01SHeikki Krogerus struct device *device_find_child_by_name(struct device *parent,
2907dad9bb01SHeikki Krogerus 					 const char *name)
2908dad9bb01SHeikki Krogerus {
2909dad9bb01SHeikki Krogerus 	struct klist_iter i;
2910dad9bb01SHeikki Krogerus 	struct device *child;
2911dad9bb01SHeikki Krogerus 
2912dad9bb01SHeikki Krogerus 	if (!parent)
2913dad9bb01SHeikki Krogerus 		return NULL;
2914dad9bb01SHeikki Krogerus 
2915dad9bb01SHeikki Krogerus 	klist_iter_init(&parent->p->klist_children, &i);
2916dad9bb01SHeikki Krogerus 	while ((child = next_device(&i)))
2917dad9bb01SHeikki Krogerus 		if (!strcmp(dev_name(child), name) && get_device(child))
2918dad9bb01SHeikki Krogerus 			break;
2919dad9bb01SHeikki Krogerus 	klist_iter_exit(&i);
2920dad9bb01SHeikki Krogerus 	return child;
2921dad9bb01SHeikki Krogerus }
2922dad9bb01SHeikki Krogerus EXPORT_SYMBOL_GPL(device_find_child_by_name);
2923dad9bb01SHeikki Krogerus 
29241da177e4SLinus Torvalds int __init devices_init(void)
29251da177e4SLinus Torvalds {
2926881c6cfdSGreg Kroah-Hartman 	devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL);
2927881c6cfdSGreg Kroah-Hartman 	if (!devices_kset)
2928881c6cfdSGreg Kroah-Hartman 		return -ENOMEM;
2929e105b8bfSDan Williams 	dev_kobj = kobject_create_and_add("dev", NULL);
2930e105b8bfSDan Williams 	if (!dev_kobj)
2931e105b8bfSDan Williams 		goto dev_kobj_err;
2932e105b8bfSDan Williams 	sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj);
2933e105b8bfSDan Williams 	if (!sysfs_dev_block_kobj)
2934e105b8bfSDan Williams 		goto block_kobj_err;
2935e105b8bfSDan Williams 	sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj);
2936e105b8bfSDan Williams 	if (!sysfs_dev_char_kobj)
2937e105b8bfSDan Williams 		goto char_kobj_err;
2938e105b8bfSDan Williams 
2939881c6cfdSGreg Kroah-Hartman 	return 0;
2940e105b8bfSDan Williams 
2941e105b8bfSDan Williams  char_kobj_err:
2942e105b8bfSDan Williams 	kobject_put(sysfs_dev_block_kobj);
2943e105b8bfSDan Williams  block_kobj_err:
2944e105b8bfSDan Williams 	kobject_put(dev_kobj);
2945e105b8bfSDan Williams  dev_kobj_err:
2946e105b8bfSDan Williams 	kset_unregister(devices_kset);
2947e105b8bfSDan Williams 	return -ENOMEM;
29481da177e4SLinus Torvalds }
29491da177e4SLinus Torvalds 
29504f3549d7SRafael J. Wysocki static int device_check_offline(struct device *dev, void *not_used)
29514f3549d7SRafael J. Wysocki {
29524f3549d7SRafael J. Wysocki 	int ret;
29534f3549d7SRafael J. Wysocki 
29544f3549d7SRafael J. Wysocki 	ret = device_for_each_child(dev, NULL, device_check_offline);
29554f3549d7SRafael J. Wysocki 	if (ret)
29564f3549d7SRafael J. Wysocki 		return ret;
29574f3549d7SRafael J. Wysocki 
29584f3549d7SRafael J. Wysocki 	return device_supports_offline(dev) && !dev->offline ? -EBUSY : 0;
29594f3549d7SRafael J. Wysocki }
29604f3549d7SRafael J. Wysocki 
29614f3549d7SRafael J. Wysocki /**
29624f3549d7SRafael J. Wysocki  * device_offline - Prepare the device for hot-removal.
29634f3549d7SRafael J. Wysocki  * @dev: Device to be put offline.
29644f3549d7SRafael J. Wysocki  *
29654f3549d7SRafael J. Wysocki  * Execute the device bus type's .offline() callback, if present, to prepare
29664f3549d7SRafael J. Wysocki  * the device for a subsequent hot-removal.  If that succeeds, the device must
29674f3549d7SRafael J. Wysocki  * not be used until either it is removed or its bus type's .online() callback
29684f3549d7SRafael J. Wysocki  * is executed.
29694f3549d7SRafael J. Wysocki  *
29704f3549d7SRafael J. Wysocki  * Call under device_hotplug_lock.
29714f3549d7SRafael J. Wysocki  */
29724f3549d7SRafael J. Wysocki int device_offline(struct device *dev)
29734f3549d7SRafael J. Wysocki {
29744f3549d7SRafael J. Wysocki 	int ret;
29754f3549d7SRafael J. Wysocki 
29764f3549d7SRafael J. Wysocki 	if (dev->offline_disabled)
29774f3549d7SRafael J. Wysocki 		return -EPERM;
29784f3549d7SRafael J. Wysocki 
29794f3549d7SRafael J. Wysocki 	ret = device_for_each_child(dev, NULL, device_check_offline);
29804f3549d7SRafael J. Wysocki 	if (ret)
29814f3549d7SRafael J. Wysocki 		return ret;
29824f3549d7SRafael J. Wysocki 
29834f3549d7SRafael J. Wysocki 	device_lock(dev);
29844f3549d7SRafael J. Wysocki 	if (device_supports_offline(dev)) {
29854f3549d7SRafael J. Wysocki 		if (dev->offline) {
29864f3549d7SRafael J. Wysocki 			ret = 1;
29874f3549d7SRafael J. Wysocki 		} else {
29884f3549d7SRafael J. Wysocki 			ret = dev->bus->offline(dev);
29894f3549d7SRafael J. Wysocki 			if (!ret) {
29904f3549d7SRafael J. Wysocki 				kobject_uevent(&dev->kobj, KOBJ_OFFLINE);
29914f3549d7SRafael J. Wysocki 				dev->offline = true;
29924f3549d7SRafael J. Wysocki 			}
29934f3549d7SRafael J. Wysocki 		}
29944f3549d7SRafael J. Wysocki 	}
29954f3549d7SRafael J. Wysocki 	device_unlock(dev);
29964f3549d7SRafael J. Wysocki 
29974f3549d7SRafael J. Wysocki 	return ret;
29984f3549d7SRafael J. Wysocki }
29994f3549d7SRafael J. Wysocki 
30004f3549d7SRafael J. Wysocki /**
30014f3549d7SRafael J. Wysocki  * device_online - Put the device back online after successful device_offline().
30024f3549d7SRafael J. Wysocki  * @dev: Device to be put back online.
30034f3549d7SRafael J. Wysocki  *
30044f3549d7SRafael J. Wysocki  * If device_offline() has been successfully executed for @dev, but the device
30054f3549d7SRafael J. Wysocki  * has not been removed subsequently, execute its bus type's .online() callback
30064f3549d7SRafael J. Wysocki  * to indicate that the device can be used again.
30074f3549d7SRafael J. Wysocki  *
30084f3549d7SRafael J. Wysocki  * Call under device_hotplug_lock.
30094f3549d7SRafael J. Wysocki  */
30104f3549d7SRafael J. Wysocki int device_online(struct device *dev)
30114f3549d7SRafael J. Wysocki {
30124f3549d7SRafael J. Wysocki 	int ret = 0;
30134f3549d7SRafael J. Wysocki 
30144f3549d7SRafael J. Wysocki 	device_lock(dev);
30154f3549d7SRafael J. Wysocki 	if (device_supports_offline(dev)) {
30164f3549d7SRafael J. Wysocki 		if (dev->offline) {
30174f3549d7SRafael J. Wysocki 			ret = dev->bus->online(dev);
30184f3549d7SRafael J. Wysocki 			if (!ret) {
30194f3549d7SRafael J. Wysocki 				kobject_uevent(&dev->kobj, KOBJ_ONLINE);
30204f3549d7SRafael J. Wysocki 				dev->offline = false;
30214f3549d7SRafael J. Wysocki 			}
30224f3549d7SRafael J. Wysocki 		} else {
30234f3549d7SRafael J. Wysocki 			ret = 1;
30244f3549d7SRafael J. Wysocki 		}
30254f3549d7SRafael J. Wysocki 	}
30264f3549d7SRafael J. Wysocki 	device_unlock(dev);
30274f3549d7SRafael J. Wysocki 
30284f3549d7SRafael J. Wysocki 	return ret;
30294f3549d7SRafael J. Wysocki }
30304f3549d7SRafael J. Wysocki 
30317f100d15SKarthigan Srinivasan struct root_device {
30320aa0dc41SMark McLoughlin 	struct device dev;
30330aa0dc41SMark McLoughlin 	struct module *owner;
30340aa0dc41SMark McLoughlin };
30350aa0dc41SMark McLoughlin 
303693058424SJosh Triplett static inline struct root_device *to_root_device(struct device *d)
3037481e2079SFerenc Wagner {
3038481e2079SFerenc Wagner 	return container_of(d, struct root_device, dev);
3039481e2079SFerenc Wagner }
30400aa0dc41SMark McLoughlin 
30410aa0dc41SMark McLoughlin static void root_device_release(struct device *dev)
30420aa0dc41SMark McLoughlin {
30430aa0dc41SMark McLoughlin 	kfree(to_root_device(dev));
30440aa0dc41SMark McLoughlin }
30450aa0dc41SMark McLoughlin 
30460aa0dc41SMark McLoughlin /**
30470aa0dc41SMark McLoughlin  * __root_device_register - allocate and register a root device
30480aa0dc41SMark McLoughlin  * @name: root device name
30490aa0dc41SMark McLoughlin  * @owner: owner module of the root device, usually THIS_MODULE
30500aa0dc41SMark McLoughlin  *
30510aa0dc41SMark McLoughlin  * This function allocates a root device and registers it
30520aa0dc41SMark McLoughlin  * using device_register(). In order to free the returned
30530aa0dc41SMark McLoughlin  * device, use root_device_unregister().
30540aa0dc41SMark McLoughlin  *
30550aa0dc41SMark McLoughlin  * Root devices are dummy devices which allow other devices
30560aa0dc41SMark McLoughlin  * to be grouped under /sys/devices. Use this function to
30570aa0dc41SMark McLoughlin  * allocate a root device and then use it as the parent of
30580aa0dc41SMark McLoughlin  * any device which should appear under /sys/devices/{name}
30590aa0dc41SMark McLoughlin  *
30600aa0dc41SMark McLoughlin  * The /sys/devices/{name} directory will also contain a
30610aa0dc41SMark McLoughlin  * 'module' symlink which points to the @owner directory
30620aa0dc41SMark McLoughlin  * in sysfs.
30630aa0dc41SMark McLoughlin  *
3064f0eae0edSJani Nikula  * Returns &struct device pointer on success, or ERR_PTR() on error.
3065f0eae0edSJani Nikula  *
30660aa0dc41SMark McLoughlin  * Note: You probably want to use root_device_register().
30670aa0dc41SMark McLoughlin  */
30680aa0dc41SMark McLoughlin struct device *__root_device_register(const char *name, struct module *owner)
30690aa0dc41SMark McLoughlin {
30700aa0dc41SMark McLoughlin 	struct root_device *root;
30710aa0dc41SMark McLoughlin 	int err = -ENOMEM;
30720aa0dc41SMark McLoughlin 
30730aa0dc41SMark McLoughlin 	root = kzalloc(sizeof(struct root_device), GFP_KERNEL);
30740aa0dc41SMark McLoughlin 	if (!root)
30750aa0dc41SMark McLoughlin 		return ERR_PTR(err);
30760aa0dc41SMark McLoughlin 
3077acc0e90fSGreg Kroah-Hartman 	err = dev_set_name(&root->dev, "%s", name);
30780aa0dc41SMark McLoughlin 	if (err) {
30790aa0dc41SMark McLoughlin 		kfree(root);
30800aa0dc41SMark McLoughlin 		return ERR_PTR(err);
30810aa0dc41SMark McLoughlin 	}
30820aa0dc41SMark McLoughlin 
30830aa0dc41SMark McLoughlin 	root->dev.release = root_device_release;
30840aa0dc41SMark McLoughlin 
30850aa0dc41SMark McLoughlin 	err = device_register(&root->dev);
30860aa0dc41SMark McLoughlin 	if (err) {
30870aa0dc41SMark McLoughlin 		put_device(&root->dev);
30880aa0dc41SMark McLoughlin 		return ERR_PTR(err);
30890aa0dc41SMark McLoughlin 	}
30900aa0dc41SMark McLoughlin 
30911d9e882bSChristoph Egger #ifdef CONFIG_MODULES	/* gotta find a "cleaner" way to do this */
30920aa0dc41SMark McLoughlin 	if (owner) {
30930aa0dc41SMark McLoughlin 		struct module_kobject *mk = &owner->mkobj;
30940aa0dc41SMark McLoughlin 
30950aa0dc41SMark McLoughlin 		err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module");
30960aa0dc41SMark McLoughlin 		if (err) {
30970aa0dc41SMark McLoughlin 			device_unregister(&root->dev);
30980aa0dc41SMark McLoughlin 			return ERR_PTR(err);
30990aa0dc41SMark McLoughlin 		}
31000aa0dc41SMark McLoughlin 		root->owner = owner;
31010aa0dc41SMark McLoughlin 	}
31020aa0dc41SMark McLoughlin #endif
31030aa0dc41SMark McLoughlin 
31040aa0dc41SMark McLoughlin 	return &root->dev;
31050aa0dc41SMark McLoughlin }
31060aa0dc41SMark McLoughlin EXPORT_SYMBOL_GPL(__root_device_register);
31070aa0dc41SMark McLoughlin 
31080aa0dc41SMark McLoughlin /**
31090aa0dc41SMark McLoughlin  * root_device_unregister - unregister and free a root device
31107cbcf225SRandy Dunlap  * @dev: device going away
31110aa0dc41SMark McLoughlin  *
31120aa0dc41SMark McLoughlin  * This function unregisters and cleans up a device that was created by
31130aa0dc41SMark McLoughlin  * root_device_register().
31140aa0dc41SMark McLoughlin  */
31150aa0dc41SMark McLoughlin void root_device_unregister(struct device *dev)
31160aa0dc41SMark McLoughlin {
31170aa0dc41SMark McLoughlin 	struct root_device *root = to_root_device(dev);
31180aa0dc41SMark McLoughlin 
31190aa0dc41SMark McLoughlin 	if (root->owner)
31200aa0dc41SMark McLoughlin 		sysfs_remove_link(&root->dev.kobj, "module");
31210aa0dc41SMark McLoughlin 
31220aa0dc41SMark McLoughlin 	device_unregister(dev);
31230aa0dc41SMark McLoughlin }
31240aa0dc41SMark McLoughlin EXPORT_SYMBOL_GPL(root_device_unregister);
31250aa0dc41SMark McLoughlin 
312623681e47SGreg Kroah-Hartman 
312723681e47SGreg Kroah-Hartman static void device_create_release(struct device *dev)
312823681e47SGreg Kroah-Hartman {
31291e0b2cf9SKay Sievers 	pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
313023681e47SGreg Kroah-Hartman 	kfree(dev);
313123681e47SGreg Kroah-Hartman }
313223681e47SGreg Kroah-Hartman 
31336a8b55d7SMathieu Malaterre static __printf(6, 0) struct device *
313439ef3112SGuenter Roeck device_create_groups_vargs(struct class *class, struct device *parent,
313539ef3112SGuenter Roeck 			   dev_t devt, void *drvdata,
313639ef3112SGuenter Roeck 			   const struct attribute_group **groups,
313739ef3112SGuenter Roeck 			   const char *fmt, va_list args)
313839ef3112SGuenter Roeck {
313939ef3112SGuenter Roeck 	struct device *dev = NULL;
314039ef3112SGuenter Roeck 	int retval = -ENODEV;
314139ef3112SGuenter Roeck 
314239ef3112SGuenter Roeck 	if (class == NULL || IS_ERR(class))
314339ef3112SGuenter Roeck 		goto error;
314439ef3112SGuenter Roeck 
314539ef3112SGuenter Roeck 	dev = kzalloc(sizeof(*dev), GFP_KERNEL);
314639ef3112SGuenter Roeck 	if (!dev) {
314739ef3112SGuenter Roeck 		retval = -ENOMEM;
314839ef3112SGuenter Roeck 		goto error;
314939ef3112SGuenter Roeck 	}
315039ef3112SGuenter Roeck 
3151bbc780f8SDavid Herrmann 	device_initialize(dev);
315239ef3112SGuenter Roeck 	dev->devt = devt;
315339ef3112SGuenter Roeck 	dev->class = class;
315439ef3112SGuenter Roeck 	dev->parent = parent;
315539ef3112SGuenter Roeck 	dev->groups = groups;
315639ef3112SGuenter Roeck 	dev->release = device_create_release;
315739ef3112SGuenter Roeck 	dev_set_drvdata(dev, drvdata);
315839ef3112SGuenter Roeck 
315939ef3112SGuenter Roeck 	retval = kobject_set_name_vargs(&dev->kobj, fmt, args);
316039ef3112SGuenter Roeck 	if (retval)
316139ef3112SGuenter Roeck 		goto error;
316239ef3112SGuenter Roeck 
3163bbc780f8SDavid Herrmann 	retval = device_add(dev);
316439ef3112SGuenter Roeck 	if (retval)
316539ef3112SGuenter Roeck 		goto error;
316639ef3112SGuenter Roeck 
316739ef3112SGuenter Roeck 	return dev;
316839ef3112SGuenter Roeck 
316939ef3112SGuenter Roeck error:
317039ef3112SGuenter Roeck 	put_device(dev);
317139ef3112SGuenter Roeck 	return ERR_PTR(retval);
317239ef3112SGuenter Roeck }
317339ef3112SGuenter Roeck 
317423681e47SGreg Kroah-Hartman /**
31758882b394SGreg Kroah-Hartman  * device_create_vargs - creates a device and registers it with sysfs
31768882b394SGreg Kroah-Hartman  * @class: pointer to the struct class that this device should be registered to
31778882b394SGreg Kroah-Hartman  * @parent: pointer to the parent struct device of this new device, if any
31788882b394SGreg Kroah-Hartman  * @devt: the dev_t for the char device to be added
31798882b394SGreg Kroah-Hartman  * @drvdata: the data to be added to the device for callbacks
31808882b394SGreg Kroah-Hartman  * @fmt: string for the device's name
31818882b394SGreg Kroah-Hartman  * @args: va_list for the device's name
31828882b394SGreg Kroah-Hartman  *
31838882b394SGreg Kroah-Hartman  * This function can be used by char device classes.  A struct device
31848882b394SGreg Kroah-Hartman  * will be created in sysfs, registered to the specified class.
31858882b394SGreg Kroah-Hartman  *
31868882b394SGreg Kroah-Hartman  * A "dev" file will be created, showing the dev_t for the device, if
31878882b394SGreg Kroah-Hartman  * the dev_t is not 0,0.
31888882b394SGreg Kroah-Hartman  * If a pointer to a parent struct device is passed in, the newly created
31898882b394SGreg Kroah-Hartman  * struct device will be a child of that device in sysfs.
31908882b394SGreg Kroah-Hartman  * The pointer to the struct device will be returned from the call.
31918882b394SGreg Kroah-Hartman  * Any further sysfs files that might be required can be created using this
31928882b394SGreg Kroah-Hartman  * pointer.
31938882b394SGreg Kroah-Hartman  *
3194f0eae0edSJani Nikula  * Returns &struct device pointer on success, or ERR_PTR() on error.
3195f0eae0edSJani Nikula  *
31968882b394SGreg Kroah-Hartman  * Note: the struct class passed to this function must have previously
31978882b394SGreg Kroah-Hartman  * been created with a call to class_create().
31988882b394SGreg Kroah-Hartman  */
31998882b394SGreg Kroah-Hartman struct device *device_create_vargs(struct class *class, struct device *parent,
32008882b394SGreg Kroah-Hartman 				   dev_t devt, void *drvdata, const char *fmt,
32018882b394SGreg Kroah-Hartman 				   va_list args)
32028882b394SGreg Kroah-Hartman {
320339ef3112SGuenter Roeck 	return device_create_groups_vargs(class, parent, devt, drvdata, NULL,
320439ef3112SGuenter Roeck 					  fmt, args);
32058882b394SGreg Kroah-Hartman }
32068882b394SGreg Kroah-Hartman EXPORT_SYMBOL_GPL(device_create_vargs);
32078882b394SGreg Kroah-Hartman 
32088882b394SGreg Kroah-Hartman /**
32094e106739SGreg Kroah-Hartman  * device_create - creates a device and registers it with sysfs
32108882b394SGreg Kroah-Hartman  * @class: pointer to the struct class that this device should be registered to
32118882b394SGreg Kroah-Hartman  * @parent: pointer to the parent struct device of this new device, if any
32128882b394SGreg Kroah-Hartman  * @devt: the dev_t for the char device to be added
32138882b394SGreg Kroah-Hartman  * @drvdata: the data to be added to the device for callbacks
32148882b394SGreg Kroah-Hartman  * @fmt: string for the device's name
32158882b394SGreg Kroah-Hartman  *
32168882b394SGreg Kroah-Hartman  * This function can be used by char device classes.  A struct device
32178882b394SGreg Kroah-Hartman  * will be created in sysfs, registered to the specified class.
32188882b394SGreg Kroah-Hartman  *
32198882b394SGreg Kroah-Hartman  * A "dev" file will be created, showing the dev_t for the device, if
32208882b394SGreg Kroah-Hartman  * the dev_t is not 0,0.
32218882b394SGreg Kroah-Hartman  * If a pointer to a parent struct device is passed in, the newly created
32228882b394SGreg Kroah-Hartman  * struct device will be a child of that device in sysfs.
32238882b394SGreg Kroah-Hartman  * The pointer to the struct device will be returned from the call.
32248882b394SGreg Kroah-Hartman  * Any further sysfs files that might be required can be created using this
32258882b394SGreg Kroah-Hartman  * pointer.
32268882b394SGreg Kroah-Hartman  *
3227f0eae0edSJani Nikula  * Returns &struct device pointer on success, or ERR_PTR() on error.
3228f0eae0edSJani Nikula  *
32298882b394SGreg Kroah-Hartman  * Note: the struct class passed to this function must have previously
32308882b394SGreg Kroah-Hartman  * been created with a call to class_create().
32318882b394SGreg Kroah-Hartman  */
32324e106739SGreg Kroah-Hartman struct device *device_create(struct class *class, struct device *parent,
32334e106739SGreg Kroah-Hartman 			     dev_t devt, void *drvdata, const char *fmt, ...)
32348882b394SGreg Kroah-Hartman {
32358882b394SGreg Kroah-Hartman 	va_list vargs;
32368882b394SGreg Kroah-Hartman 	struct device *dev;
32378882b394SGreg Kroah-Hartman 
32388882b394SGreg Kroah-Hartman 	va_start(vargs, fmt);
32398882b394SGreg Kroah-Hartman 	dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
32408882b394SGreg Kroah-Hartman 	va_end(vargs);
32418882b394SGreg Kroah-Hartman 	return dev;
32428882b394SGreg Kroah-Hartman }
32434e106739SGreg Kroah-Hartman EXPORT_SYMBOL_GPL(device_create);
32448882b394SGreg Kroah-Hartman 
324539ef3112SGuenter Roeck /**
324639ef3112SGuenter Roeck  * device_create_with_groups - creates a device and registers it with sysfs
324739ef3112SGuenter Roeck  * @class: pointer to the struct class that this device should be registered to
324839ef3112SGuenter Roeck  * @parent: pointer to the parent struct device of this new device, if any
324939ef3112SGuenter Roeck  * @devt: the dev_t for the char device to be added
325039ef3112SGuenter Roeck  * @drvdata: the data to be added to the device for callbacks
325139ef3112SGuenter Roeck  * @groups: NULL-terminated list of attribute groups to be created
325239ef3112SGuenter Roeck  * @fmt: string for the device's name
325339ef3112SGuenter Roeck  *
325439ef3112SGuenter Roeck  * This function can be used by char device classes.  A struct device
325539ef3112SGuenter Roeck  * will be created in sysfs, registered to the specified class.
325639ef3112SGuenter Roeck  * Additional attributes specified in the groups parameter will also
325739ef3112SGuenter Roeck  * be created automatically.
325839ef3112SGuenter Roeck  *
325939ef3112SGuenter Roeck  * A "dev" file will be created, showing the dev_t for the device, if
326039ef3112SGuenter Roeck  * the dev_t is not 0,0.
326139ef3112SGuenter Roeck  * If a pointer to a parent struct device is passed in, the newly created
326239ef3112SGuenter Roeck  * struct device will be a child of that device in sysfs.
326339ef3112SGuenter Roeck  * The pointer to the struct device will be returned from the call.
326439ef3112SGuenter Roeck  * Any further sysfs files that might be required can be created using this
326539ef3112SGuenter Roeck  * pointer.
326639ef3112SGuenter Roeck  *
326739ef3112SGuenter Roeck  * Returns &struct device pointer on success, or ERR_PTR() on error.
326839ef3112SGuenter Roeck  *
326939ef3112SGuenter Roeck  * Note: the struct class passed to this function must have previously
327039ef3112SGuenter Roeck  * been created with a call to class_create().
327139ef3112SGuenter Roeck  */
327239ef3112SGuenter Roeck struct device *device_create_with_groups(struct class *class,
327339ef3112SGuenter Roeck 					 struct device *parent, dev_t devt,
327439ef3112SGuenter Roeck 					 void *drvdata,
327539ef3112SGuenter Roeck 					 const struct attribute_group **groups,
327639ef3112SGuenter Roeck 					 const char *fmt, ...)
327739ef3112SGuenter Roeck {
327839ef3112SGuenter Roeck 	va_list vargs;
327939ef3112SGuenter Roeck 	struct device *dev;
328039ef3112SGuenter Roeck 
328139ef3112SGuenter Roeck 	va_start(vargs, fmt);
328239ef3112SGuenter Roeck 	dev = device_create_groups_vargs(class, parent, devt, drvdata, groups,
328339ef3112SGuenter Roeck 					 fmt, vargs);
328439ef3112SGuenter Roeck 	va_end(vargs);
328539ef3112SGuenter Roeck 	return dev;
328639ef3112SGuenter Roeck }
328739ef3112SGuenter Roeck EXPORT_SYMBOL_GPL(device_create_with_groups);
328839ef3112SGuenter Roeck 
3289775b64d2SRafael J. Wysocki /**
3290775b64d2SRafael J. Wysocki  * device_destroy - removes a device that was created with device_create()
3291775b64d2SRafael J. Wysocki  * @class: pointer to the struct class that this device was registered with
3292775b64d2SRafael J. Wysocki  * @devt: the dev_t of the device that was previously registered
3293775b64d2SRafael J. Wysocki  *
3294775b64d2SRafael J. Wysocki  * This call unregisters and cleans up a device that was created with a
3295775b64d2SRafael J. Wysocki  * call to device_create().
3296775b64d2SRafael J. Wysocki  */
3297775b64d2SRafael J. Wysocki void device_destroy(struct class *class, dev_t devt)
3298775b64d2SRafael J. Wysocki {
3299775b64d2SRafael J. Wysocki 	struct device *dev;
3300775b64d2SRafael J. Wysocki 
33014495dfddSSuzuki K Poulose 	dev = class_find_device_by_devt(class, devt);
3302cd35449bSDave Young 	if (dev) {
3303cd35449bSDave Young 		put_device(dev);
330423681e47SGreg Kroah-Hartman 		device_unregister(dev);
330523681e47SGreg Kroah-Hartman 	}
3306cd35449bSDave Young }
330723681e47SGreg Kroah-Hartman EXPORT_SYMBOL_GPL(device_destroy);
3308a2de48caSGreg Kroah-Hartman 
3309a2de48caSGreg Kroah-Hartman /**
3310a2de48caSGreg Kroah-Hartman  * device_rename - renames a device
3311a2de48caSGreg Kroah-Hartman  * @dev: the pointer to the struct device to be renamed
3312a2de48caSGreg Kroah-Hartman  * @new_name: the new name of the device
3313030c1d2bSEric W. Biederman  *
3314030c1d2bSEric W. Biederman  * It is the responsibility of the caller to provide mutual
3315030c1d2bSEric W. Biederman  * exclusion between two different calls of device_rename
3316030c1d2bSEric W. Biederman  * on the same device to ensure that new_name is valid and
3317030c1d2bSEric W. Biederman  * won't conflict with other devices.
3318c6c0ac66SMichael Ellerman  *
3319a5462516STimur Tabi  * Note: Don't call this function.  Currently, the networking layer calls this
3320a5462516STimur Tabi  * function, but that will change.  The following text from Kay Sievers offers
3321a5462516STimur Tabi  * some insight:
3322a5462516STimur Tabi  *
3323a5462516STimur Tabi  * Renaming devices is racy at many levels, symlinks and other stuff are not
3324a5462516STimur Tabi  * replaced atomically, and you get a "move" uevent, but it's not easy to
3325a5462516STimur Tabi  * connect the event to the old and new device. Device nodes are not renamed at
3326a5462516STimur Tabi  * all, there isn't even support for that in the kernel now.
3327a5462516STimur Tabi  *
3328a5462516STimur Tabi  * In the meantime, during renaming, your target name might be taken by another
3329a5462516STimur Tabi  * driver, creating conflicts. Or the old name is taken directly after you
3330a5462516STimur Tabi  * renamed it -- then you get events for the same DEVPATH, before you even see
3331a5462516STimur Tabi  * the "move" event. It's just a mess, and nothing new should ever rely on
3332a5462516STimur Tabi  * kernel device renaming. Besides that, it's not even implemented now for
3333a5462516STimur Tabi  * other things than (driver-core wise very simple) network devices.
3334a5462516STimur Tabi  *
3335a5462516STimur Tabi  * We are currently about to change network renaming in udev to completely
3336a5462516STimur Tabi  * disallow renaming of devices in the same namespace as the kernel uses,
3337a5462516STimur Tabi  * because we can't solve the problems properly, that arise with swapping names
3338a5462516STimur Tabi  * of multiple interfaces without races. Means, renaming of eth[0-9]* will only
3339a5462516STimur Tabi  * be allowed to some other name than eth[0-9]*, for the aforementioned
3340a5462516STimur Tabi  * reasons.
3341a5462516STimur Tabi  *
3342a5462516STimur Tabi  * Make up a "real" name in the driver before you register anything, or add
3343a5462516STimur Tabi  * some other attributes for userspace to find the device, or use udev to add
3344a5462516STimur Tabi  * symlinks -- but never rename kernel devices later, it's a complete mess. We
3345a5462516STimur Tabi  * don't even want to get into that and try to implement the missing pieces in
3346a5462516STimur Tabi  * the core. We really have other pieces to fix in the driver core mess. :)
3347a2de48caSGreg Kroah-Hartman  */
33486937e8f8SJohannes Berg int device_rename(struct device *dev, const char *new_name)
3349a2de48caSGreg Kroah-Hartman {
33504b30ee58STejun Heo 	struct kobject *kobj = &dev->kobj;
33512ee97cafSCornelia Huck 	char *old_device_name = NULL;
3352a2de48caSGreg Kroah-Hartman 	int error;
3353a2de48caSGreg Kroah-Hartman 
3354a2de48caSGreg Kroah-Hartman 	dev = get_device(dev);
3355a2de48caSGreg Kroah-Hartman 	if (!dev)
3356a2de48caSGreg Kroah-Hartman 		return -EINVAL;
3357a2de48caSGreg Kroah-Hartman 
335869df7533Sethan.zhao 	dev_dbg(dev, "renaming to %s\n", new_name);
3359a2de48caSGreg Kroah-Hartman 
33601fa5ae85SKay Sievers 	old_device_name = kstrdup(dev_name(dev), GFP_KERNEL);
33612ee97cafSCornelia Huck 	if (!old_device_name) {
3362952ab431SJesper Juhl 		error = -ENOMEM;
33632ee97cafSCornelia Huck 		goto out;
3364952ab431SJesper Juhl 	}
3365a2de48caSGreg Kroah-Hartman 
3366f349cf34SEric W. Biederman 	if (dev->class) {
33674b30ee58STejun Heo 		error = sysfs_rename_link_ns(&dev->class->p->subsys.kobj,
33684b30ee58STejun Heo 					     kobj, old_device_name,
33694b30ee58STejun Heo 					     new_name, kobject_namespace(kobj));
3370f349cf34SEric W. Biederman 		if (error)
3371f349cf34SEric W. Biederman 			goto out;
3372f349cf34SEric W. Biederman 	}
337339aba963SKay Sievers 
33744b30ee58STejun Heo 	error = kobject_rename(kobj, new_name);
33751fa5ae85SKay Sievers 	if (error)
33762ee97cafSCornelia Huck 		goto out;
3377a2de48caSGreg Kroah-Hartman 
33782ee97cafSCornelia Huck out:
3379a2de48caSGreg Kroah-Hartman 	put_device(dev);
3380a2de48caSGreg Kroah-Hartman 
33812ee97cafSCornelia Huck 	kfree(old_device_name);
3382a2de48caSGreg Kroah-Hartman 
3383a2de48caSGreg Kroah-Hartman 	return error;
3384a2de48caSGreg Kroah-Hartman }
3385a2807dbcSJohannes Berg EXPORT_SYMBOL_GPL(device_rename);
33868a82472fSCornelia Huck 
33878a82472fSCornelia Huck static int device_move_class_links(struct device *dev,
33888a82472fSCornelia Huck 				   struct device *old_parent,
33898a82472fSCornelia Huck 				   struct device *new_parent)
33908a82472fSCornelia Huck {
3391f7f3461dSGreg Kroah-Hartman 	int error = 0;
33928a82472fSCornelia Huck 
3393f7f3461dSGreg Kroah-Hartman 	if (old_parent)
3394f7f3461dSGreg Kroah-Hartman 		sysfs_remove_link(&dev->kobj, "device");
3395f7f3461dSGreg Kroah-Hartman 	if (new_parent)
3396f7f3461dSGreg Kroah-Hartman 		error = sysfs_create_link(&dev->kobj, &new_parent->kobj,
3397f7f3461dSGreg Kroah-Hartman 					  "device");
3398f7f3461dSGreg Kroah-Hartman 	return error;
33998a82472fSCornelia Huck }
34008a82472fSCornelia Huck 
34018a82472fSCornelia Huck /**
34028a82472fSCornelia Huck  * device_move - moves a device to a new parent
34038a82472fSCornelia Huck  * @dev: the pointer to the struct device to be moved
340413509860SWolfram Sang  * @new_parent: the new parent of the device (can be NULL)
3405ffa6a705SCornelia Huck  * @dpm_order: how to reorder the dpm_list
34068a82472fSCornelia Huck  */
3407ffa6a705SCornelia Huck int device_move(struct device *dev, struct device *new_parent,
3408ffa6a705SCornelia Huck 		enum dpm_order dpm_order)
34098a82472fSCornelia Huck {
34108a82472fSCornelia Huck 	int error;
34118a82472fSCornelia Huck 	struct device *old_parent;
3412c744aeaeSCornelia Huck 	struct kobject *new_parent_kobj;
34138a82472fSCornelia Huck 
34148a82472fSCornelia Huck 	dev = get_device(dev);
34158a82472fSCornelia Huck 	if (!dev)
34168a82472fSCornelia Huck 		return -EINVAL;
34178a82472fSCornelia Huck 
3418ffa6a705SCornelia Huck 	device_pm_lock();
34198a82472fSCornelia Huck 	new_parent = get_device(new_parent);
3420c744aeaeSCornelia Huck 	new_parent_kobj = get_device_parent(dev, new_parent);
342184d0c27dSTetsuo Handa 	if (IS_ERR(new_parent_kobj)) {
342284d0c27dSTetsuo Handa 		error = PTR_ERR(new_parent_kobj);
342384d0c27dSTetsuo Handa 		put_device(new_parent);
342484d0c27dSTetsuo Handa 		goto out;
342584d0c27dSTetsuo Handa 	}
342663b6971aSCornelia Huck 
34271e0b2cf9SKay Sievers 	pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev),
34281e0b2cf9SKay Sievers 		 __func__, new_parent ? dev_name(new_parent) : "<NULL>");
3429c744aeaeSCornelia Huck 	error = kobject_move(&dev->kobj, new_parent_kobj);
34308a82472fSCornelia Huck 	if (error) {
343163b6971aSCornelia Huck 		cleanup_glue_dir(dev, new_parent_kobj);
34328a82472fSCornelia Huck 		put_device(new_parent);
34338a82472fSCornelia Huck 		goto out;
34348a82472fSCornelia Huck 	}
34358a82472fSCornelia Huck 	old_parent = dev->parent;
34368a82472fSCornelia Huck 	dev->parent = new_parent;
34378a82472fSCornelia Huck 	if (old_parent)
3438f791b8c8SGreg Kroah-Hartman 		klist_remove(&dev->p->knode_parent);
34390d358f22SYinghai Lu 	if (new_parent) {
3440f791b8c8SGreg Kroah-Hartman 		klist_add_tail(&dev->p->knode_parent,
3441f791b8c8SGreg Kroah-Hartman 			       &new_parent->p->klist_children);
34420d358f22SYinghai Lu 		set_dev_node(dev, dev_to_node(new_parent));
34430d358f22SYinghai Lu 	}
34440d358f22SYinghai Lu 
3445bdd4034dSRabin Vincent 	if (dev->class) {
34468a82472fSCornelia Huck 		error = device_move_class_links(dev, old_parent, new_parent);
34478a82472fSCornelia Huck 		if (error) {
34488a82472fSCornelia Huck 			/* We ignore errors on cleanup since we're hosed anyway... */
34498a82472fSCornelia Huck 			device_move_class_links(dev, new_parent, old_parent);
34508a82472fSCornelia Huck 			if (!kobject_move(&dev->kobj, &old_parent->kobj)) {
3451c744aeaeSCornelia Huck 				if (new_parent)
3452f791b8c8SGreg Kroah-Hartman 					klist_remove(&dev->p->knode_parent);
34530d358f22SYinghai Lu 				dev->parent = old_parent;
34540d358f22SYinghai Lu 				if (old_parent) {
3455f791b8c8SGreg Kroah-Hartman 					klist_add_tail(&dev->p->knode_parent,
3456f791b8c8SGreg Kroah-Hartman 						       &old_parent->p->klist_children);
34570d358f22SYinghai Lu 					set_dev_node(dev, dev_to_node(old_parent));
34580d358f22SYinghai Lu 				}
34598a82472fSCornelia Huck 			}
346063b6971aSCornelia Huck 			cleanup_glue_dir(dev, new_parent_kobj);
34618a82472fSCornelia Huck 			put_device(new_parent);
34628a82472fSCornelia Huck 			goto out;
34638a82472fSCornelia Huck 		}
3464bdd4034dSRabin Vincent 	}
3465ffa6a705SCornelia Huck 	switch (dpm_order) {
3466ffa6a705SCornelia Huck 	case DPM_ORDER_NONE:
3467ffa6a705SCornelia Huck 		break;
3468ffa6a705SCornelia Huck 	case DPM_ORDER_DEV_AFTER_PARENT:
3469ffa6a705SCornelia Huck 		device_pm_move_after(dev, new_parent);
347052cdbdd4SGrygorii Strashko 		devices_kset_move_after(dev, new_parent);
3471ffa6a705SCornelia Huck 		break;
3472ffa6a705SCornelia Huck 	case DPM_ORDER_PARENT_BEFORE_DEV:
3473ffa6a705SCornelia Huck 		device_pm_move_before(new_parent, dev);
347452cdbdd4SGrygorii Strashko 		devices_kset_move_before(new_parent, dev);
3475ffa6a705SCornelia Huck 		break;
3476ffa6a705SCornelia Huck 	case DPM_ORDER_DEV_LAST:
3477ffa6a705SCornelia Huck 		device_pm_move_last(dev);
347852cdbdd4SGrygorii Strashko 		devices_kset_move_last(dev);
3479ffa6a705SCornelia Huck 		break;
3480ffa6a705SCornelia Huck 	}
3481bdd4034dSRabin Vincent 
34828a82472fSCornelia Huck 	put_device(old_parent);
34838a82472fSCornelia Huck out:
3484ffa6a705SCornelia Huck 	device_pm_unlock();
34858a82472fSCornelia Huck 	put_device(dev);
34868a82472fSCornelia Huck 	return error;
34878a82472fSCornelia Huck }
34888a82472fSCornelia Huck EXPORT_SYMBOL_GPL(device_move);
348937b0c020SGreg Kroah-Hartman 
349037b0c020SGreg Kroah-Hartman /**
349137b0c020SGreg Kroah-Hartman  * device_shutdown - call ->shutdown() on each device to shutdown.
349237b0c020SGreg Kroah-Hartman  */
349337b0c020SGreg Kroah-Hartman void device_shutdown(void)
349437b0c020SGreg Kroah-Hartman {
3495f123db8eSBenson Leung 	struct device *dev, *parent;
349637b0c020SGreg Kroah-Hartman 
34973297c8fcSPingfan Liu 	wait_for_device_probe();
34983297c8fcSPingfan Liu 	device_block_probing();
34993297c8fcSPingfan Liu 
350065650b35SRafael J. Wysocki 	cpufreq_suspend();
350165650b35SRafael J. Wysocki 
35026245838fSHugh Daschbach 	spin_lock(&devices_kset->list_lock);
35036245838fSHugh Daschbach 	/*
35046245838fSHugh Daschbach 	 * Walk the devices list backward, shutting down each in turn.
35056245838fSHugh Daschbach 	 * Beware that device unplug events may also start pulling
35066245838fSHugh Daschbach 	 * devices offline, even as the system is shutting down.
35076245838fSHugh Daschbach 	 */
35086245838fSHugh Daschbach 	while (!list_empty(&devices_kset->list)) {
35096245838fSHugh Daschbach 		dev = list_entry(devices_kset->list.prev, struct device,
35106245838fSHugh Daschbach 				kobj.entry);
3511d1c6c030SMing Lei 
3512d1c6c030SMing Lei 		/*
3513d1c6c030SMing Lei 		 * hold reference count of device's parent to
3514d1c6c030SMing Lei 		 * prevent it from being freed because parent's
3515d1c6c030SMing Lei 		 * lock is to be held
3516d1c6c030SMing Lei 		 */
3517f123db8eSBenson Leung 		parent = get_device(dev->parent);
35186245838fSHugh Daschbach 		get_device(dev);
35196245838fSHugh Daschbach 		/*
35206245838fSHugh Daschbach 		 * Make sure the device is off the kset list, in the
35216245838fSHugh Daschbach 		 * event that dev->*->shutdown() doesn't remove it.
35226245838fSHugh Daschbach 		 */
35236245838fSHugh Daschbach 		list_del_init(&dev->kobj.entry);
35246245838fSHugh Daschbach 		spin_unlock(&devices_kset->list_lock);
3525fe6b91f4SAlan Stern 
3526d1c6c030SMing Lei 		/* hold lock to avoid race with probe/release */
3527f123db8eSBenson Leung 		if (parent)
3528f123db8eSBenson Leung 			device_lock(parent);
3529d1c6c030SMing Lei 		device_lock(dev);
3530d1c6c030SMing Lei 
3531fe6b91f4SAlan Stern 		/* Don't allow any more runtime suspends */
3532fe6b91f4SAlan Stern 		pm_runtime_get_noresume(dev);
3533fe6b91f4SAlan Stern 		pm_runtime_barrier(dev);
35346245838fSHugh Daschbach 
35357521621eSMichal Suchanek 		if (dev->class && dev->class->shutdown_pre) {
3536f77af151SJosh Zimmerman 			if (initcall_debug)
35377521621eSMichal Suchanek 				dev_info(dev, "shutdown_pre\n");
35387521621eSMichal Suchanek 			dev->class->shutdown_pre(dev);
35397521621eSMichal Suchanek 		}
35407521621eSMichal Suchanek 		if (dev->bus && dev->bus->shutdown) {
35410246c4faSShuoX Liu 			if (initcall_debug)
35420246c4faSShuoX Liu 				dev_info(dev, "shutdown\n");
354337b0c020SGreg Kroah-Hartman 			dev->bus->shutdown(dev);
354437b0c020SGreg Kroah-Hartman 		} else if (dev->driver && dev->driver->shutdown) {
35450246c4faSShuoX Liu 			if (initcall_debug)
35460246c4faSShuoX Liu 				dev_info(dev, "shutdown\n");
354737b0c020SGreg Kroah-Hartman 			dev->driver->shutdown(dev);
354837b0c020SGreg Kroah-Hartman 		}
3549d1c6c030SMing Lei 
3550d1c6c030SMing Lei 		device_unlock(dev);
3551f123db8eSBenson Leung 		if (parent)
3552f123db8eSBenson Leung 			device_unlock(parent);
3553d1c6c030SMing Lei 
35546245838fSHugh Daschbach 		put_device(dev);
3555f123db8eSBenson Leung 		put_device(parent);
35566245838fSHugh Daschbach 
35576245838fSHugh Daschbach 		spin_lock(&devices_kset->list_lock);
355837b0c020SGreg Kroah-Hartman 	}
35596245838fSHugh Daschbach 	spin_unlock(&devices_kset->list_lock);
356037b0c020SGreg Kroah-Hartman }
356199bcf217SJoe Perches 
356299bcf217SJoe Perches /*
356399bcf217SJoe Perches  * Device logging functions
356499bcf217SJoe Perches  */
356599bcf217SJoe Perches 
356699bcf217SJoe Perches #ifdef CONFIG_PRINTK
3567666f355fSJoe Perches static int
3568666f355fSJoe Perches create_syslog_header(const struct device *dev, char *hdr, size_t hdrlen)
356999bcf217SJoe Perches {
3570c4e00daaSKay Sievers 	const char *subsys;
3571798efc60SJoe Perches 	size_t pos = 0;
357299bcf217SJoe Perches 
3573c4e00daaSKay Sievers 	if (dev->class)
3574c4e00daaSKay Sievers 		subsys = dev->class->name;
3575c4e00daaSKay Sievers 	else if (dev->bus)
3576c4e00daaSKay Sievers 		subsys = dev->bus->name;
3577c4e00daaSKay Sievers 	else
3578798efc60SJoe Perches 		return 0;
3579c4e00daaSKay Sievers 
3580798efc60SJoe Perches 	pos += snprintf(hdr + pos, hdrlen - pos, "SUBSYSTEM=%s", subsys);
3581655e5b7cSBen Hutchings 	if (pos >= hdrlen)
3582655e5b7cSBen Hutchings 		goto overflow;
3583c4e00daaSKay Sievers 
3584c4e00daaSKay Sievers 	/*
3585c4e00daaSKay Sievers 	 * Add device identifier DEVICE=:
3586c4e00daaSKay Sievers 	 *   b12:8         block dev_t
3587c4e00daaSKay Sievers 	 *   c127:3        char dev_t
3588c4e00daaSKay Sievers 	 *   n8            netdev ifindex
3589c4e00daaSKay Sievers 	 *   +sound:card0  subsystem:devname
3590c4e00daaSKay Sievers 	 */
3591c4e00daaSKay Sievers 	if (MAJOR(dev->devt)) {
3592c4e00daaSKay Sievers 		char c;
3593c4e00daaSKay Sievers 
3594c4e00daaSKay Sievers 		if (strcmp(subsys, "block") == 0)
3595c4e00daaSKay Sievers 			c = 'b';
3596c4e00daaSKay Sievers 		else
3597c4e00daaSKay Sievers 			c = 'c';
3598798efc60SJoe Perches 		pos++;
3599798efc60SJoe Perches 		pos += snprintf(hdr + pos, hdrlen - pos,
3600c4e00daaSKay Sievers 				"DEVICE=%c%u:%u",
3601c4e00daaSKay Sievers 				c, MAJOR(dev->devt), MINOR(dev->devt));
3602c4e00daaSKay Sievers 	} else if (strcmp(subsys, "net") == 0) {
3603c4e00daaSKay Sievers 		struct net_device *net = to_net_dev(dev);
3604c4e00daaSKay Sievers 
3605798efc60SJoe Perches 		pos++;
3606798efc60SJoe Perches 		pos += snprintf(hdr + pos, hdrlen - pos,
3607c4e00daaSKay Sievers 				"DEVICE=n%u", net->ifindex);
3608c4e00daaSKay Sievers 	} else {
3609798efc60SJoe Perches 		pos++;
3610798efc60SJoe Perches 		pos += snprintf(hdr + pos, hdrlen - pos,
3611c4e00daaSKay Sievers 				"DEVICE=+%s:%s", subsys, dev_name(dev));
3612c4e00daaSKay Sievers 	}
3613af7f2158SJim Cromie 
3614655e5b7cSBen Hutchings 	if (pos >= hdrlen)
3615655e5b7cSBen Hutchings 		goto overflow;
3616655e5b7cSBen Hutchings 
3617798efc60SJoe Perches 	return pos;
3618655e5b7cSBen Hutchings 
3619655e5b7cSBen Hutchings overflow:
3620655e5b7cSBen Hutchings 	dev_WARN(dev, "device/subsystem name too long");
3621655e5b7cSBen Hutchings 	return 0;
362299bcf217SJoe Perches }
3623798efc60SJoe Perches 
362405e4e5b8SJoe Perches int dev_vprintk_emit(int level, const struct device *dev,
362505e4e5b8SJoe Perches 		     const char *fmt, va_list args)
362605e4e5b8SJoe Perches {
362705e4e5b8SJoe Perches 	char hdr[128];
362805e4e5b8SJoe Perches 	size_t hdrlen;
362905e4e5b8SJoe Perches 
363005e4e5b8SJoe Perches 	hdrlen = create_syslog_header(dev, hdr, sizeof(hdr));
363105e4e5b8SJoe Perches 
363205e4e5b8SJoe Perches 	return vprintk_emit(0, level, hdrlen ? hdr : NULL, hdrlen, fmt, args);
363305e4e5b8SJoe Perches }
363405e4e5b8SJoe Perches EXPORT_SYMBOL(dev_vprintk_emit);
363505e4e5b8SJoe Perches 
363605e4e5b8SJoe Perches int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
363705e4e5b8SJoe Perches {
363805e4e5b8SJoe Perches 	va_list args;
363905e4e5b8SJoe Perches 	int r;
364005e4e5b8SJoe Perches 
364105e4e5b8SJoe Perches 	va_start(args, fmt);
364205e4e5b8SJoe Perches 
364305e4e5b8SJoe Perches 	r = dev_vprintk_emit(level, dev, fmt, args);
364405e4e5b8SJoe Perches 
364505e4e5b8SJoe Perches 	va_end(args);
364605e4e5b8SJoe Perches 
364705e4e5b8SJoe Perches 	return r;
364805e4e5b8SJoe Perches }
364905e4e5b8SJoe Perches EXPORT_SYMBOL(dev_printk_emit);
365005e4e5b8SJoe Perches 
3651d1f1052cSJoe Perches static void __dev_printk(const char *level, const struct device *dev,
3652798efc60SJoe Perches 			struct va_format *vaf)
3653798efc60SJoe Perches {
3654d1f1052cSJoe Perches 	if (dev)
3655d1f1052cSJoe Perches 		dev_printk_emit(level[1] - '0', dev, "%s %s: %pV",
3656798efc60SJoe Perches 				dev_driver_string(dev), dev_name(dev), vaf);
3657d1f1052cSJoe Perches 	else
3658d1f1052cSJoe Perches 		printk("%s(NULL device *): %pV", level, vaf);
3659798efc60SJoe Perches }
366099bcf217SJoe Perches 
3661d1f1052cSJoe Perches void dev_printk(const char *level, const struct device *dev,
366299bcf217SJoe Perches 		const char *fmt, ...)
366399bcf217SJoe Perches {
366499bcf217SJoe Perches 	struct va_format vaf;
366599bcf217SJoe Perches 	va_list args;
366699bcf217SJoe Perches 
366799bcf217SJoe Perches 	va_start(args, fmt);
366899bcf217SJoe Perches 
366999bcf217SJoe Perches 	vaf.fmt = fmt;
367099bcf217SJoe Perches 	vaf.va = &args;
367199bcf217SJoe Perches 
3672d1f1052cSJoe Perches 	__dev_printk(level, dev, &vaf);
3673798efc60SJoe Perches 
367499bcf217SJoe Perches 	va_end(args);
367599bcf217SJoe Perches }
367699bcf217SJoe Perches EXPORT_SYMBOL(dev_printk);
367799bcf217SJoe Perches 
367899bcf217SJoe Perches #define define_dev_printk_level(func, kern_level)		\
3679d1f1052cSJoe Perches void func(const struct device *dev, const char *fmt, ...)	\
368099bcf217SJoe Perches {								\
368199bcf217SJoe Perches 	struct va_format vaf;					\
368299bcf217SJoe Perches 	va_list args;						\
368399bcf217SJoe Perches 								\
368499bcf217SJoe Perches 	va_start(args, fmt);					\
368599bcf217SJoe Perches 								\
368699bcf217SJoe Perches 	vaf.fmt = fmt;						\
368799bcf217SJoe Perches 	vaf.va = &args;						\
368899bcf217SJoe Perches 								\
3689d1f1052cSJoe Perches 	__dev_printk(kern_level, dev, &vaf);			\
3690798efc60SJoe Perches 								\
369199bcf217SJoe Perches 	va_end(args);						\
369299bcf217SJoe Perches }								\
369399bcf217SJoe Perches EXPORT_SYMBOL(func);
369499bcf217SJoe Perches 
3695663336eeSJoe Perches define_dev_printk_level(_dev_emerg, KERN_EMERG);
3696663336eeSJoe Perches define_dev_printk_level(_dev_alert, KERN_ALERT);
3697663336eeSJoe Perches define_dev_printk_level(_dev_crit, KERN_CRIT);
3698663336eeSJoe Perches define_dev_printk_level(_dev_err, KERN_ERR);
3699663336eeSJoe Perches define_dev_printk_level(_dev_warn, KERN_WARNING);
3700663336eeSJoe Perches define_dev_printk_level(_dev_notice, KERN_NOTICE);
370199bcf217SJoe Perches define_dev_printk_level(_dev_info, KERN_INFO);
370299bcf217SJoe Perches 
370399bcf217SJoe Perches #endif
370497badf87SRafael J. Wysocki 
370597badf87SRafael J. Wysocki static inline bool fwnode_is_primary(struct fwnode_handle *fwnode)
370697badf87SRafael J. Wysocki {
370797badf87SRafael J. Wysocki 	return fwnode && !IS_ERR(fwnode->secondary);
370897badf87SRafael J. Wysocki }
370997badf87SRafael J. Wysocki 
371097badf87SRafael J. Wysocki /**
371197badf87SRafael J. Wysocki  * set_primary_fwnode - Change the primary firmware node of a given device.
371297badf87SRafael J. Wysocki  * @dev: Device to handle.
371397badf87SRafael J. Wysocki  * @fwnode: New primary firmware node of the device.
371497badf87SRafael J. Wysocki  *
371597badf87SRafael J. Wysocki  * Set the device's firmware node pointer to @fwnode, but if a secondary
371697badf87SRafael J. Wysocki  * firmware node of the device is present, preserve it.
371797badf87SRafael J. Wysocki  */
371897badf87SRafael J. Wysocki void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode)
371997badf87SRafael J. Wysocki {
372097badf87SRafael J. Wysocki 	if (fwnode) {
372197badf87SRafael J. Wysocki 		struct fwnode_handle *fn = dev->fwnode;
372297badf87SRafael J. Wysocki 
372397badf87SRafael J. Wysocki 		if (fwnode_is_primary(fn))
372497badf87SRafael J. Wysocki 			fn = fn->secondary;
372597badf87SRafael J. Wysocki 
372655f89a8aSMika Westerberg 		if (fn) {
372755f89a8aSMika Westerberg 			WARN_ON(fwnode->secondary);
372897badf87SRafael J. Wysocki 			fwnode->secondary = fn;
372955f89a8aSMika Westerberg 		}
373097badf87SRafael J. Wysocki 		dev->fwnode = fwnode;
373197badf87SRafael J. Wysocki 	} else {
373297badf87SRafael J. Wysocki 		dev->fwnode = fwnode_is_primary(dev->fwnode) ?
373397badf87SRafael J. Wysocki 			dev->fwnode->secondary : NULL;
373497badf87SRafael J. Wysocki 	}
373597badf87SRafael J. Wysocki }
373697badf87SRafael J. Wysocki EXPORT_SYMBOL_GPL(set_primary_fwnode);
373797badf87SRafael J. Wysocki 
373897badf87SRafael J. Wysocki /**
373997badf87SRafael J. Wysocki  * set_secondary_fwnode - Change the secondary firmware node of a given device.
374097badf87SRafael J. Wysocki  * @dev: Device to handle.
374197badf87SRafael J. Wysocki  * @fwnode: New secondary firmware node of the device.
374297badf87SRafael J. Wysocki  *
374397badf87SRafael J. Wysocki  * If a primary firmware node of the device is present, set its secondary
374497badf87SRafael J. Wysocki  * pointer to @fwnode.  Otherwise, set the device's firmware node pointer to
374597badf87SRafael J. Wysocki  * @fwnode.
374697badf87SRafael J. Wysocki  */
374797badf87SRafael J. Wysocki void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode)
374897badf87SRafael J. Wysocki {
374997badf87SRafael J. Wysocki 	if (fwnode)
375097badf87SRafael J. Wysocki 		fwnode->secondary = ERR_PTR(-ENODEV);
375197badf87SRafael J. Wysocki 
375297badf87SRafael J. Wysocki 	if (fwnode_is_primary(dev->fwnode))
375397badf87SRafael J. Wysocki 		dev->fwnode->secondary = fwnode;
375497badf87SRafael J. Wysocki 	else
375597badf87SRafael J. Wysocki 		dev->fwnode = fwnode;
375697badf87SRafael J. Wysocki }
37574e75e1d7SJohan Hovold 
37584e75e1d7SJohan Hovold /**
37594e75e1d7SJohan Hovold  * device_set_of_node_from_dev - reuse device-tree node of another device
37604e75e1d7SJohan Hovold  * @dev: device whose device-tree node is being set
37614e75e1d7SJohan Hovold  * @dev2: device whose device-tree node is being reused
37624e75e1d7SJohan Hovold  *
37634e75e1d7SJohan Hovold  * Takes another reference to the new device-tree node after first dropping
37644e75e1d7SJohan Hovold  * any reference held to the old node.
37654e75e1d7SJohan Hovold  */
37664e75e1d7SJohan Hovold void device_set_of_node_from_dev(struct device *dev, const struct device *dev2)
37674e75e1d7SJohan Hovold {
37684e75e1d7SJohan Hovold 	of_node_put(dev->of_node);
37694e75e1d7SJohan Hovold 	dev->of_node = of_node_get(dev2->of_node);
37704e75e1d7SJohan Hovold 	dev->of_node_reused = true;
37714e75e1d7SJohan Hovold }
37724e75e1d7SJohan Hovold EXPORT_SYMBOL_GPL(device_set_of_node_from_dev);
377365b66682SSuzuki K Poulose 
37746cda08a2SSuzuki K Poulose int device_match_name(struct device *dev, const void *name)
37756cda08a2SSuzuki K Poulose {
37766cda08a2SSuzuki K Poulose 	return sysfs_streq(dev_name(dev), name);
37776cda08a2SSuzuki K Poulose }
37786cda08a2SSuzuki K Poulose EXPORT_SYMBOL_GPL(device_match_name);
37796cda08a2SSuzuki K Poulose 
378065b66682SSuzuki K Poulose int device_match_of_node(struct device *dev, const void *np)
378165b66682SSuzuki K Poulose {
378265b66682SSuzuki K Poulose 	return dev->of_node == np;
378365b66682SSuzuki K Poulose }
378465b66682SSuzuki K Poulose EXPORT_SYMBOL_GPL(device_match_of_node);
378567843bbaSSuzuki K Poulose 
378667843bbaSSuzuki K Poulose int device_match_fwnode(struct device *dev, const void *fwnode)
378767843bbaSSuzuki K Poulose {
378867843bbaSSuzuki K Poulose 	return dev_fwnode(dev) == fwnode;
378967843bbaSSuzuki K Poulose }
379067843bbaSSuzuki K Poulose EXPORT_SYMBOL_GPL(device_match_fwnode);
37914495dfddSSuzuki K Poulose 
37924495dfddSSuzuki K Poulose int device_match_devt(struct device *dev, const void *pdevt)
37934495dfddSSuzuki K Poulose {
37944495dfddSSuzuki K Poulose 	return dev->devt == *(dev_t *)pdevt;
37954495dfddSSuzuki K Poulose }
37964495dfddSSuzuki K Poulose EXPORT_SYMBOL_GPL(device_match_devt);
379700500147SSuzuki K Poulose 
379800500147SSuzuki K Poulose int device_match_acpi_dev(struct device *dev, const void *adev)
379900500147SSuzuki K Poulose {
380000500147SSuzuki K Poulose 	return ACPI_COMPANION(dev) == adev;
380100500147SSuzuki K Poulose }
380200500147SSuzuki K Poulose EXPORT_SYMBOL(device_match_acpi_dev);
38036bf85ba9SSuzuki K Poulose 
38046bf85ba9SSuzuki K Poulose int device_match_any(struct device *dev, const void *unused)
38056bf85ba9SSuzuki K Poulose {
38066bf85ba9SSuzuki K Poulose 	return 1;
38076bf85ba9SSuzuki K Poulose }
38086bf85ba9SSuzuki K Poulose EXPORT_SYMBOL_GPL(device_match_any);
3809