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> 1773060022SChristophe JAILLET #include <linux/kstrtox.h> 181da177e4SLinus Torvalds #include <linux/module.h> 191da177e4SLinus Torvalds #include <linux/slab.h> 201da177e4SLinus Torvalds #include <linux/string.h> 2123681e47SGreg Kroah-Hartman #include <linux/kdev_t.h> 22116af378SBenjamin Herrenschmidt #include <linux/notifier.h> 2307d57a32SGrant Likely #include <linux/of.h> 2407d57a32SGrant Likely #include <linux/of_device.h> 25322cbb50SChristoph Hellwig #include <linux/blkdev.h> 26f75b1c60SDave Young #include <linux/mutex.h> 27af8db150SPeter Chen #include <linux/pm_runtime.h> 28c4e00daaSKay Sievers #include <linux/netdevice.h> 29174cd4b1SIngo Molnar #include <linux/sched/signal.h> 30b8530017SOliver Neukum #include <linux/sched/mm.h> 3169031f50SClaire Chang #include <linux/swiotlb.h> 3263967685SGreg Kroah-Hartman #include <linux/sysfs.h> 336d4e9a8eSChristoph Hellwig #include <linux/dma-map-ops.h> /* for dma_default_coherent */ 341da177e4SLinus Torvalds 351da177e4SLinus Torvalds #include "base.h" 366423d295SWon Chung #include "physical_location.h" 371da177e4SLinus Torvalds #include "power/power.h" 381da177e4SLinus Torvalds 399ed98953SRafael J. Wysocki /* Device links support. */ 40fc5a251dSSaravana Kannan static LIST_HEAD(deferred_sync); 41fc5a251dSSaravana Kannan static unsigned int defer_sync_state_count = 1; 427b337cb3SSaravana Kannan static DEFINE_MUTEX(fwnode_link_lock); 4325ac86c6SSaravana Kannan static bool fw_devlink_is_permissive(void); 443a2dbc51SSaravana Kannan static void __fw_devlink_link_to_consumers(struct device *dev); 45d46f3e3eSSaravana Kannan static bool fw_devlink_drv_reg_done; 462f8c3ae8SSaravana Kannan static bool fw_devlink_best_effort; 477b337cb3SSaravana Kannan 487b337cb3SSaravana Kannan /** 493a2dbc51SSaravana Kannan * __fwnode_link_add - Create a link between two fwnode_handles. 507b337cb3SSaravana Kannan * @con: Consumer end of the link. 517b337cb3SSaravana Kannan * @sup: Supplier end of the link. 527b337cb3SSaravana Kannan * 537b337cb3SSaravana Kannan * Create a fwnode link between fwnode handles @con and @sup. The fwnode link 547b337cb3SSaravana Kannan * represents the detail that the firmware lists @sup fwnode as supplying a 557b337cb3SSaravana Kannan * resource to @con. 567b337cb3SSaravana Kannan * 577b337cb3SSaravana Kannan * The driver core will use the fwnode link to create a device link between the 587b337cb3SSaravana Kannan * two device objects corresponding to @con and @sup when they are created. The 597b337cb3SSaravana Kannan * driver core will automatically delete the fwnode link between @con and @sup 607b337cb3SSaravana Kannan * after doing that. 617b337cb3SSaravana Kannan * 627b337cb3SSaravana Kannan * Attempts to create duplicate links between the same pair of fwnode handles 637b337cb3SSaravana Kannan * are ignored and there is no reference counting. 647b337cb3SSaravana Kannan */ 653a2dbc51SSaravana Kannan static int __fwnode_link_add(struct fwnode_handle *con, 666a6dfdf8SSaravana Kannan struct fwnode_handle *sup, u8 flags) 677b337cb3SSaravana Kannan { 687b337cb3SSaravana Kannan struct fwnode_link *link; 697b337cb3SSaravana Kannan 707b337cb3SSaravana Kannan list_for_each_entry(link, &sup->consumers, s_hook) 716a6dfdf8SSaravana Kannan if (link->consumer == con) { 726a6dfdf8SSaravana Kannan link->flags |= flags; 733a2dbc51SSaravana Kannan return 0; 746a6dfdf8SSaravana Kannan } 757b337cb3SSaravana Kannan 767b337cb3SSaravana Kannan link = kzalloc(sizeof(*link), GFP_KERNEL); 773a2dbc51SSaravana Kannan if (!link) 783a2dbc51SSaravana Kannan return -ENOMEM; 797b337cb3SSaravana Kannan 807b337cb3SSaravana Kannan link->supplier = sup; 817b337cb3SSaravana Kannan INIT_LIST_HEAD(&link->s_hook); 827b337cb3SSaravana Kannan link->consumer = con; 837b337cb3SSaravana Kannan INIT_LIST_HEAD(&link->c_hook); 846a6dfdf8SSaravana Kannan link->flags = flags; 857b337cb3SSaravana Kannan 867b337cb3SSaravana Kannan list_add(&link->s_hook, &sup->consumers); 877b337cb3SSaravana Kannan list_add(&link->c_hook, &con->suppliers); 880c058fb9SSaravana Kannan pr_debug("%pfwf Linked as a fwnode consumer to %pfwf\n", 89ebd6823aSSaravana Kannan con, sup); 907b337cb3SSaravana Kannan 913a2dbc51SSaravana Kannan return 0; 923a2dbc51SSaravana Kannan } 933a2dbc51SSaravana Kannan 943a2dbc51SSaravana Kannan int fwnode_link_add(struct fwnode_handle *con, struct fwnode_handle *sup) 953a2dbc51SSaravana Kannan { 963a2dbc51SSaravana Kannan int ret; 973a2dbc51SSaravana Kannan 983a2dbc51SSaravana Kannan mutex_lock(&fwnode_link_lock); 996a6dfdf8SSaravana Kannan ret = __fwnode_link_add(con, sup, 0); 1003a2dbc51SSaravana Kannan mutex_unlock(&fwnode_link_lock); 1017b337cb3SSaravana Kannan return ret; 1027b337cb3SSaravana Kannan } 1037b337cb3SSaravana Kannan 1047b337cb3SSaravana Kannan /** 10576f13081SSaravana Kannan * __fwnode_link_del - Delete a link between two fwnode_handles. 10676f13081SSaravana Kannan * @link: the fwnode_link to be deleted 10776f13081SSaravana Kannan * 10876f13081SSaravana Kannan * The fwnode_link_lock needs to be held when this function is called. 10976f13081SSaravana Kannan */ 11076f13081SSaravana Kannan static void __fwnode_link_del(struct fwnode_link *link) 11176f13081SSaravana Kannan { 1120c058fb9SSaravana Kannan pr_debug("%pfwf Dropping the fwnode link to %pfwf\n", 113ebd6823aSSaravana Kannan link->consumer, link->supplier); 11476f13081SSaravana Kannan list_del(&link->s_hook); 11576f13081SSaravana Kannan list_del(&link->c_hook); 11676f13081SSaravana Kannan kfree(link); 11776f13081SSaravana Kannan } 11876f13081SSaravana Kannan 11976f13081SSaravana Kannan /** 1206a6dfdf8SSaravana Kannan * __fwnode_link_cycle - Mark a fwnode link as being part of a cycle. 1216a6dfdf8SSaravana Kannan * @link: the fwnode_link to be marked 1226a6dfdf8SSaravana Kannan * 1236a6dfdf8SSaravana Kannan * The fwnode_link_lock needs to be held when this function is called. 1246a6dfdf8SSaravana Kannan */ 1256a6dfdf8SSaravana Kannan static void __fwnode_link_cycle(struct fwnode_link *link) 1266a6dfdf8SSaravana Kannan { 1276a6dfdf8SSaravana Kannan pr_debug("%pfwf: Relaxing link with %pfwf\n", 1286a6dfdf8SSaravana Kannan link->consumer, link->supplier); 1296a6dfdf8SSaravana Kannan link->flags |= FWLINK_FLAG_CYCLE; 1306a6dfdf8SSaravana Kannan } 1316a6dfdf8SSaravana Kannan 1326a6dfdf8SSaravana Kannan /** 1337b337cb3SSaravana Kannan * fwnode_links_purge_suppliers - Delete all supplier links of fwnode_handle. 1347b337cb3SSaravana Kannan * @fwnode: fwnode whose supplier links need to be deleted 1357b337cb3SSaravana Kannan * 1367b337cb3SSaravana Kannan * Deletes all supplier links connecting directly to @fwnode. 1377b337cb3SSaravana Kannan */ 1387b337cb3SSaravana Kannan static void fwnode_links_purge_suppliers(struct fwnode_handle *fwnode) 1397b337cb3SSaravana Kannan { 1407b337cb3SSaravana Kannan struct fwnode_link *link, *tmp; 1417b337cb3SSaravana Kannan 1427b337cb3SSaravana Kannan mutex_lock(&fwnode_link_lock); 14376f13081SSaravana Kannan list_for_each_entry_safe(link, tmp, &fwnode->suppliers, c_hook) 14476f13081SSaravana Kannan __fwnode_link_del(link); 1457b337cb3SSaravana Kannan mutex_unlock(&fwnode_link_lock); 1467b337cb3SSaravana Kannan } 1477b337cb3SSaravana Kannan 1487b337cb3SSaravana Kannan /** 1497b337cb3SSaravana Kannan * fwnode_links_purge_consumers - Delete all consumer links of fwnode_handle. 1507b337cb3SSaravana Kannan * @fwnode: fwnode whose consumer links need to be deleted 1517b337cb3SSaravana Kannan * 1527b337cb3SSaravana Kannan * Deletes all consumer links connecting directly to @fwnode. 1537b337cb3SSaravana Kannan */ 1547b337cb3SSaravana Kannan static void fwnode_links_purge_consumers(struct fwnode_handle *fwnode) 1557b337cb3SSaravana Kannan { 1567b337cb3SSaravana Kannan struct fwnode_link *link, *tmp; 1577b337cb3SSaravana Kannan 1587b337cb3SSaravana Kannan mutex_lock(&fwnode_link_lock); 15976f13081SSaravana Kannan list_for_each_entry_safe(link, tmp, &fwnode->consumers, s_hook) 16076f13081SSaravana Kannan __fwnode_link_del(link); 1617b337cb3SSaravana Kannan mutex_unlock(&fwnode_link_lock); 1627b337cb3SSaravana Kannan } 1637b337cb3SSaravana Kannan 1647b337cb3SSaravana Kannan /** 1657b337cb3SSaravana Kannan * fwnode_links_purge - Delete all links connected to a fwnode_handle. 1667b337cb3SSaravana Kannan * @fwnode: fwnode whose links needs to be deleted 1677b337cb3SSaravana Kannan * 1687b337cb3SSaravana Kannan * Deletes all links connecting directly to a fwnode. 1697b337cb3SSaravana Kannan */ 1707b337cb3SSaravana Kannan void fwnode_links_purge(struct fwnode_handle *fwnode) 1717b337cb3SSaravana Kannan { 1727b337cb3SSaravana Kannan fwnode_links_purge_suppliers(fwnode); 1737b337cb3SSaravana Kannan fwnode_links_purge_consumers(fwnode); 1747b337cb3SSaravana Kannan } 1759ed98953SRafael J. Wysocki 17628ec344bSSaravana Kannan void fw_devlink_purge_absent_suppliers(struct fwnode_handle *fwnode) 1779528e0d9SSaravana Kannan { 1789528e0d9SSaravana Kannan struct fwnode_handle *child; 1799528e0d9SSaravana Kannan 1809528e0d9SSaravana Kannan /* Don't purge consumer links of an added child */ 1819528e0d9SSaravana Kannan if (fwnode->dev) 1829528e0d9SSaravana Kannan return; 1839528e0d9SSaravana Kannan 1849528e0d9SSaravana Kannan fwnode->flags |= FWNODE_FLAG_NOT_DEVICE; 1859528e0d9SSaravana Kannan fwnode_links_purge_consumers(fwnode); 1869528e0d9SSaravana Kannan 1879528e0d9SSaravana Kannan fwnode_for_each_available_child_node(fwnode, child) 1889528e0d9SSaravana Kannan fw_devlink_purge_absent_suppliers(child); 1899528e0d9SSaravana Kannan } 19028ec344bSSaravana Kannan EXPORT_SYMBOL_GPL(fw_devlink_purge_absent_suppliers); 1919528e0d9SSaravana Kannan 1923a2dbc51SSaravana Kannan /** 1933a2dbc51SSaravana Kannan * __fwnode_links_move_consumers - Move consumer from @from to @to fwnode_handle 1943a2dbc51SSaravana Kannan * @from: move consumers away from this fwnode 1953a2dbc51SSaravana Kannan * @to: move consumers to this fwnode 1963a2dbc51SSaravana Kannan * 1973a2dbc51SSaravana Kannan * Move all consumer links from @from fwnode to @to fwnode. 1983a2dbc51SSaravana Kannan */ 1993a2dbc51SSaravana Kannan static void __fwnode_links_move_consumers(struct fwnode_handle *from, 2003a2dbc51SSaravana Kannan struct fwnode_handle *to) 2013a2dbc51SSaravana Kannan { 2023a2dbc51SSaravana Kannan struct fwnode_link *link, *tmp; 2033a2dbc51SSaravana Kannan 2043a2dbc51SSaravana Kannan list_for_each_entry_safe(link, tmp, &from->consumers, s_hook) { 2056a6dfdf8SSaravana Kannan __fwnode_link_add(link->consumer, to, link->flags); 2063a2dbc51SSaravana Kannan __fwnode_link_del(link); 2073a2dbc51SSaravana Kannan } 2083a2dbc51SSaravana Kannan } 2093a2dbc51SSaravana Kannan 2103a2dbc51SSaravana Kannan /** 2113a2dbc51SSaravana Kannan * __fw_devlink_pickup_dangling_consumers - Pick up dangling consumers 2123a2dbc51SSaravana Kannan * @fwnode: fwnode from which to pick up dangling consumers 2133a2dbc51SSaravana Kannan * @new_sup: fwnode of new supplier 2143a2dbc51SSaravana Kannan * 2153a2dbc51SSaravana Kannan * If the @fwnode has a corresponding struct device and the device supports 2163a2dbc51SSaravana Kannan * probing (that is, added to a bus), then we want to let fw_devlink create 2173a2dbc51SSaravana Kannan * MANAGED device links to this device, so leave @fwnode and its descendant's 2183a2dbc51SSaravana Kannan * fwnode links alone. 2193a2dbc51SSaravana Kannan * 2203a2dbc51SSaravana Kannan * Otherwise, move its consumers to the new supplier @new_sup. 2213a2dbc51SSaravana Kannan */ 2223a2dbc51SSaravana Kannan static void __fw_devlink_pickup_dangling_consumers(struct fwnode_handle *fwnode, 2233a2dbc51SSaravana Kannan struct fwnode_handle *new_sup) 2243a2dbc51SSaravana Kannan { 2253a2dbc51SSaravana Kannan struct fwnode_handle *child; 2263a2dbc51SSaravana Kannan 2273a2dbc51SSaravana Kannan if (fwnode->dev && fwnode->dev->bus) 2283a2dbc51SSaravana Kannan return; 2293a2dbc51SSaravana Kannan 2303a2dbc51SSaravana Kannan fwnode->flags |= FWNODE_FLAG_NOT_DEVICE; 2313a2dbc51SSaravana Kannan __fwnode_links_move_consumers(fwnode, new_sup); 2323a2dbc51SSaravana Kannan 2333a2dbc51SSaravana Kannan fwnode_for_each_available_child_node(fwnode, child) 2343a2dbc51SSaravana Kannan __fw_devlink_pickup_dangling_consumers(child, new_sup); 2353a2dbc51SSaravana Kannan } 2363a2dbc51SSaravana Kannan 2379ed98953SRafael J. Wysocki static DEFINE_MUTEX(device_links_lock); 2389ed98953SRafael J. Wysocki DEFINE_STATIC_SRCU(device_links_srcu); 2399ed98953SRafael J. Wysocki 2409ed98953SRafael J. Wysocki static inline void device_links_write_lock(void) 2419ed98953SRafael J. Wysocki { 2429ed98953SRafael J. Wysocki mutex_lock(&device_links_lock); 2439ed98953SRafael J. Wysocki } 2449ed98953SRafael J. Wysocki 2459ed98953SRafael J. Wysocki static inline void device_links_write_unlock(void) 2469ed98953SRafael J. Wysocki { 2479ed98953SRafael J. Wysocki mutex_unlock(&device_links_lock); 2489ed98953SRafael J. Wysocki } 2499ed98953SRafael J. Wysocki 25068464d79SJules Irenge int device_links_read_lock(void) __acquires(&device_links_srcu) 2519ed98953SRafael J. Wysocki { 2529ed98953SRafael J. Wysocki return srcu_read_lock(&device_links_srcu); 2539ed98953SRafael J. Wysocki } 2549ed98953SRafael J. Wysocki 255ab7789c5SJules Irenge void device_links_read_unlock(int idx) __releases(&device_links_srcu) 2569ed98953SRafael J. Wysocki { 2579ed98953SRafael J. Wysocki srcu_read_unlock(&device_links_srcu, idx); 2589ed98953SRafael J. Wysocki } 259c2fa1e1bSJoel Fernandes (Google) 260c2fa1e1bSJoel Fernandes (Google) int device_links_read_lock_held(void) 261c2fa1e1bSJoel Fernandes (Google) { 262c2fa1e1bSJoel Fernandes (Google) return srcu_read_lock_held(&device_links_srcu); 263c2fa1e1bSJoel Fernandes (Google) } 26480dd33cfSRafael J. Wysocki 26580dd33cfSRafael J. Wysocki static void device_link_synchronize_removal(void) 26680dd33cfSRafael J. Wysocki { 26780dd33cfSRafael J. Wysocki synchronize_srcu(&device_links_srcu); 26880dd33cfSRafael J. Wysocki } 2690c871315SRafael J. Wysocki 2700c871315SRafael J. Wysocki static void device_link_remove_from_lists(struct device_link *link) 2710c871315SRafael J. Wysocki { 2720c871315SRafael J. Wysocki list_del_rcu(&link->s_node); 2730c871315SRafael J. Wysocki list_del_rcu(&link->c_node); 2740c871315SRafael J. Wysocki } 2759ed98953SRafael J. Wysocki 2763d1cf435SRafael J. Wysocki static bool device_is_ancestor(struct device *dev, struct device *target) 2773d1cf435SRafael J. Wysocki { 2783d1cf435SRafael J. Wysocki while (target->parent) { 2793d1cf435SRafael J. Wysocki target = target->parent; 2803d1cf435SRafael J. Wysocki if (dev == target) 2813d1cf435SRafael J. Wysocki return true; 2823d1cf435SRafael J. Wysocki } 2833d1cf435SRafael J. Wysocki return false; 2843d1cf435SRafael J. Wysocki } 2853d1cf435SRafael J. Wysocki 28667cad5c6SSaravana Kannan static inline bool device_link_flag_is_sync_state_only(u32 flags) 28767cad5c6SSaravana Kannan { 28867cad5c6SSaravana Kannan return (flags & ~(DL_FLAG_INFERRED | DL_FLAG_CYCLE)) == 28967cad5c6SSaravana Kannan (DL_FLAG_SYNC_STATE_ONLY | DL_FLAG_MANAGED); 29067cad5c6SSaravana Kannan } 29167cad5c6SSaravana Kannan 2929ed98953SRafael J. Wysocki /** 2939ed98953SRafael J. Wysocki * device_is_dependent - Check if one device depends on another one 2949ed98953SRafael J. Wysocki * @dev: Device to check dependencies for. 2959ed98953SRafael J. Wysocki * @target: Device to check against. 2969ed98953SRafael J. Wysocki * 2979ed98953SRafael J. Wysocki * Check if @target depends on @dev or any device dependent on it (its child or 2989ed98953SRafael J. Wysocki * its consumer etc). Return 1 if that is the case or 0 otherwise. 2999ed98953SRafael J. Wysocki */ 3007d34ca38SSaravana Kannan int device_is_dependent(struct device *dev, void *target) 3019ed98953SRafael J. Wysocki { 3029ed98953SRafael J. Wysocki struct device_link *link; 3039ed98953SRafael J. Wysocki int ret; 3049ed98953SRafael J. Wysocki 3053d1cf435SRafael J. Wysocki /* 3063d1cf435SRafael J. Wysocki * The "ancestors" check is needed to catch the case when the target 3073d1cf435SRafael J. Wysocki * device has not been completely initialized yet and it is still 3083d1cf435SRafael J. Wysocki * missing from the list of children of its parent device. 3093d1cf435SRafael J. Wysocki */ 3103d1cf435SRafael J. Wysocki if (dev == target || device_is_ancestor(dev, target)) 3119ed98953SRafael J. Wysocki return 1; 3129ed98953SRafael J. Wysocki 3139ed98953SRafael J. Wysocki ret = device_for_each_child(dev, target, device_is_dependent); 3149ed98953SRafael J. Wysocki if (ret) 3159ed98953SRafael J. Wysocki return ret; 3169ed98953SRafael J. Wysocki 3179ed98953SRafael J. Wysocki list_for_each_entry(link, &dev->links.consumers, s_node) { 31867cad5c6SSaravana Kannan if (device_link_flag_is_sync_state_only(link->flags)) 31905ef983eSSaravana Kannan continue; 32005ef983eSSaravana Kannan 321e16f4f3eSBenjamin Gaignard if (link->consumer == target) 3229ed98953SRafael J. Wysocki return 1; 3239ed98953SRafael J. Wysocki 3249ed98953SRafael J. Wysocki ret = device_is_dependent(link->consumer, target); 3259ed98953SRafael J. Wysocki if (ret) 3269ed98953SRafael J. Wysocki break; 3279ed98953SRafael J. Wysocki } 3289ed98953SRafael J. Wysocki return ret; 3299ed98953SRafael J. Wysocki } 3309ed98953SRafael J. Wysocki 331515db266SRafael J. Wysocki static void device_link_init_status(struct device_link *link, 332515db266SRafael J. Wysocki struct device *consumer, 333515db266SRafael J. Wysocki struct device *supplier) 334515db266SRafael J. Wysocki { 335515db266SRafael J. Wysocki switch (supplier->links.status) { 336515db266SRafael J. Wysocki case DL_DEV_PROBING: 337515db266SRafael J. Wysocki switch (consumer->links.status) { 338515db266SRafael J. Wysocki case DL_DEV_PROBING: 339515db266SRafael J. Wysocki /* 340515db266SRafael J. Wysocki * A consumer driver can create a link to a supplier 341515db266SRafael J. Wysocki * that has not completed its probing yet as long as it 342515db266SRafael J. Wysocki * knows that the supplier is already functional (for 343515db266SRafael J. Wysocki * example, it has just acquired some resources from the 344515db266SRafael J. Wysocki * supplier). 345515db266SRafael J. Wysocki */ 346515db266SRafael J. Wysocki link->status = DL_STATE_CONSUMER_PROBE; 347515db266SRafael J. Wysocki break; 348515db266SRafael J. Wysocki default: 349515db266SRafael J. Wysocki link->status = DL_STATE_DORMANT; 350515db266SRafael J. Wysocki break; 351515db266SRafael J. Wysocki } 352515db266SRafael J. Wysocki break; 353515db266SRafael J. Wysocki case DL_DEV_DRIVER_BOUND: 354515db266SRafael J. Wysocki switch (consumer->links.status) { 355515db266SRafael J. Wysocki case DL_DEV_PROBING: 356515db266SRafael J. Wysocki link->status = DL_STATE_CONSUMER_PROBE; 357515db266SRafael J. Wysocki break; 358515db266SRafael J. Wysocki case DL_DEV_DRIVER_BOUND: 359515db266SRafael J. Wysocki link->status = DL_STATE_ACTIVE; 360515db266SRafael J. Wysocki break; 361515db266SRafael J. Wysocki default: 362515db266SRafael J. Wysocki link->status = DL_STATE_AVAILABLE; 363515db266SRafael J. Wysocki break; 364515db266SRafael J. Wysocki } 365515db266SRafael J. Wysocki break; 366515db266SRafael J. Wysocki case DL_DEV_UNBINDING: 367515db266SRafael J. Wysocki link->status = DL_STATE_SUPPLIER_UNBIND; 368515db266SRafael J. Wysocki break; 369515db266SRafael J. Wysocki default: 370515db266SRafael J. Wysocki link->status = DL_STATE_DORMANT; 371515db266SRafael J. Wysocki break; 372515db266SRafael J. Wysocki } 373515db266SRafael J. Wysocki } 374515db266SRafael J. Wysocki 3759ed98953SRafael J. Wysocki static int device_reorder_to_tail(struct device *dev, void *not_used) 3769ed98953SRafael J. Wysocki { 3779ed98953SRafael J. Wysocki struct device_link *link; 3789ed98953SRafael J. Wysocki 3799ed98953SRafael J. Wysocki /* 3809ed98953SRafael J. Wysocki * Devices that have not been registered yet will be put to the ends 3819ed98953SRafael J. Wysocki * of the lists during the registration, so skip them here. 3829ed98953SRafael J. Wysocki */ 3839ed98953SRafael J. Wysocki if (device_is_registered(dev)) 3849ed98953SRafael J. Wysocki devices_kset_move_last(dev); 3859ed98953SRafael J. Wysocki 3869ed98953SRafael J. Wysocki if (device_pm_initialized(dev)) 3879ed98953SRafael J. Wysocki device_pm_move_last(dev); 3889ed98953SRafael J. Wysocki 3899ed98953SRafael J. Wysocki device_for_each_child(dev, NULL, device_reorder_to_tail); 39005ef983eSSaravana Kannan list_for_each_entry(link, &dev->links.consumers, s_node) { 39167cad5c6SSaravana Kannan if (device_link_flag_is_sync_state_only(link->flags)) 39205ef983eSSaravana Kannan continue; 3939ed98953SRafael J. Wysocki device_reorder_to_tail(link->consumer, NULL); 39405ef983eSSaravana Kannan } 3959ed98953SRafael J. Wysocki 3969ed98953SRafael J. Wysocki return 0; 3979ed98953SRafael J. Wysocki } 3989ed98953SRafael J. Wysocki 3999ed98953SRafael J. Wysocki /** 400494fd7b7SFeng Kan * device_pm_move_to_tail - Move set of devices to the end of device lists 401494fd7b7SFeng Kan * @dev: Device to move 402494fd7b7SFeng Kan * 403494fd7b7SFeng Kan * This is a device_reorder_to_tail() wrapper taking the requisite locks. 404494fd7b7SFeng Kan * 405494fd7b7SFeng Kan * It moves the @dev along with all of its children and all of its consumers 406494fd7b7SFeng Kan * to the ends of the device_kset and dpm_list, recursively. 407494fd7b7SFeng Kan */ 408494fd7b7SFeng Kan void device_pm_move_to_tail(struct device *dev) 409494fd7b7SFeng Kan { 410494fd7b7SFeng Kan int idx; 411494fd7b7SFeng Kan 412494fd7b7SFeng Kan idx = device_links_read_lock(); 413494fd7b7SFeng Kan device_pm_lock(); 414494fd7b7SFeng Kan device_reorder_to_tail(dev, NULL); 415494fd7b7SFeng Kan device_pm_unlock(); 416494fd7b7SFeng Kan device_links_read_unlock(idx); 417494fd7b7SFeng Kan } 418494fd7b7SFeng Kan 419287905e6SSaravana Kannan #define to_devlink(dev) container_of((dev), struct device_link, link_dev) 420287905e6SSaravana Kannan 421287905e6SSaravana Kannan static ssize_t status_show(struct device *dev, 422287905e6SSaravana Kannan struct device_attribute *attr, char *buf) 423287905e6SSaravana Kannan { 424948b3edbSJoe Perches const char *output; 425287905e6SSaravana Kannan 426287905e6SSaravana Kannan switch (to_devlink(dev)->status) { 427287905e6SSaravana Kannan case DL_STATE_NONE: 428948b3edbSJoe Perches output = "not tracked"; 429948b3edbSJoe Perches break; 430287905e6SSaravana Kannan case DL_STATE_DORMANT: 431948b3edbSJoe Perches output = "dormant"; 432948b3edbSJoe Perches break; 433287905e6SSaravana Kannan case DL_STATE_AVAILABLE: 434948b3edbSJoe Perches output = "available"; 435948b3edbSJoe Perches break; 436287905e6SSaravana Kannan case DL_STATE_CONSUMER_PROBE: 437948b3edbSJoe Perches output = "consumer probing"; 438948b3edbSJoe Perches break; 439287905e6SSaravana Kannan case DL_STATE_ACTIVE: 440948b3edbSJoe Perches output = "active"; 441948b3edbSJoe Perches break; 442287905e6SSaravana Kannan case DL_STATE_SUPPLIER_UNBIND: 443948b3edbSJoe Perches output = "supplier unbinding"; 444948b3edbSJoe Perches break; 445287905e6SSaravana Kannan default: 446948b3edbSJoe Perches output = "unknown"; 447948b3edbSJoe Perches break; 448287905e6SSaravana Kannan } 449948b3edbSJoe Perches 450948b3edbSJoe Perches return sysfs_emit(buf, "%s\n", output); 451287905e6SSaravana Kannan } 452287905e6SSaravana Kannan static DEVICE_ATTR_RO(status); 453287905e6SSaravana Kannan 454287905e6SSaravana Kannan static ssize_t auto_remove_on_show(struct device *dev, 455287905e6SSaravana Kannan struct device_attribute *attr, char *buf) 456287905e6SSaravana Kannan { 457287905e6SSaravana Kannan struct device_link *link = to_devlink(dev); 458973c3911SJoe Perches const char *output; 459287905e6SSaravana Kannan 460287905e6SSaravana Kannan if (link->flags & DL_FLAG_AUTOREMOVE_SUPPLIER) 461973c3911SJoe Perches output = "supplier unbind"; 462287905e6SSaravana Kannan else if (link->flags & DL_FLAG_AUTOREMOVE_CONSUMER) 463973c3911SJoe Perches output = "consumer unbind"; 464287905e6SSaravana Kannan else 465973c3911SJoe Perches output = "never"; 466287905e6SSaravana Kannan 467973c3911SJoe Perches return sysfs_emit(buf, "%s\n", output); 468287905e6SSaravana Kannan } 469287905e6SSaravana Kannan static DEVICE_ATTR_RO(auto_remove_on); 470287905e6SSaravana Kannan 471287905e6SSaravana Kannan static ssize_t runtime_pm_show(struct device *dev, 472287905e6SSaravana Kannan struct device_attribute *attr, char *buf) 473287905e6SSaravana Kannan { 474287905e6SSaravana Kannan struct device_link *link = to_devlink(dev); 475287905e6SSaravana Kannan 476aa838896SJoe Perches return sysfs_emit(buf, "%d\n", !!(link->flags & DL_FLAG_PM_RUNTIME)); 477287905e6SSaravana Kannan } 478287905e6SSaravana Kannan static DEVICE_ATTR_RO(runtime_pm); 479287905e6SSaravana Kannan 480287905e6SSaravana Kannan static ssize_t sync_state_only_show(struct device *dev, 481287905e6SSaravana Kannan struct device_attribute *attr, char *buf) 482287905e6SSaravana Kannan { 483287905e6SSaravana Kannan struct device_link *link = to_devlink(dev); 484287905e6SSaravana Kannan 485aa838896SJoe Perches return sysfs_emit(buf, "%d\n", 486aa838896SJoe Perches !!(link->flags & DL_FLAG_SYNC_STATE_ONLY)); 487287905e6SSaravana Kannan } 488287905e6SSaravana Kannan static DEVICE_ATTR_RO(sync_state_only); 489287905e6SSaravana Kannan 490287905e6SSaravana Kannan static struct attribute *devlink_attrs[] = { 491287905e6SSaravana Kannan &dev_attr_status.attr, 492287905e6SSaravana Kannan &dev_attr_auto_remove_on.attr, 493287905e6SSaravana Kannan &dev_attr_runtime_pm.attr, 494287905e6SSaravana Kannan &dev_attr_sync_state_only.attr, 495287905e6SSaravana Kannan NULL, 496287905e6SSaravana Kannan }; 497287905e6SSaravana Kannan ATTRIBUTE_GROUPS(devlink); 498287905e6SSaravana Kannan 49980dd33cfSRafael J. Wysocki static void device_link_release_fn(struct work_struct *work) 500843e600bSSaravana Kannan { 50180dd33cfSRafael J. Wysocki struct device_link *link = container_of(work, struct device_link, rm_work); 50280dd33cfSRafael J. Wysocki 50380dd33cfSRafael J. Wysocki /* Ensure that all references to the link object have been dropped. */ 50480dd33cfSRafael J. Wysocki device_link_synchronize_removal(); 50580dd33cfSRafael J. Wysocki 50607358194SRafael J. Wysocki pm_runtime_release_supplier(link); 50788737106SRafael J. Wysocki /* 50888737106SRafael J. Wysocki * If supplier_preactivated is set, the link has been dropped between 50988737106SRafael J. Wysocki * the pm_runtime_get_suppliers() and pm_runtime_put_suppliers() calls 51088737106SRafael J. Wysocki * in __driver_probe_device(). In that case, drop the supplier's 51188737106SRafael J. Wysocki * PM-runtime usage counter to remove the reference taken by 51288737106SRafael J. Wysocki * pm_runtime_get_suppliers(). 51388737106SRafael J. Wysocki */ 51488737106SRafael J. Wysocki if (link->supplier_preactivated) 51588737106SRafael J. Wysocki pm_runtime_put_noidle(link->supplier); 51688737106SRafael J. Wysocki 51707358194SRafael J. Wysocki pm_request_idle(link->supplier); 518843e600bSSaravana Kannan 519843e600bSSaravana Kannan put_device(link->consumer); 520843e600bSSaravana Kannan put_device(link->supplier); 521843e600bSSaravana Kannan kfree(link); 522843e600bSSaravana Kannan } 523843e600bSSaravana Kannan 524287905e6SSaravana Kannan static void devlink_dev_release(struct device *dev) 525287905e6SSaravana Kannan { 526843e600bSSaravana Kannan struct device_link *link = to_devlink(dev); 527843e600bSSaravana Kannan 52880dd33cfSRafael J. Wysocki INIT_WORK(&link->rm_work, device_link_release_fn); 52980dd33cfSRafael J. Wysocki /* 53080dd33cfSRafael J. Wysocki * It may take a while to complete this work because of the SRCU 53180dd33cfSRafael J. Wysocki * synchronization in device_link_release_fn() and if the consumer or 53280dd33cfSRafael J. Wysocki * supplier devices get deleted when it runs, so put it into the "long" 53380dd33cfSRafael J. Wysocki * workqueue. 53480dd33cfSRafael J. Wysocki */ 53580dd33cfSRafael J. Wysocki queue_work(system_long_wq, &link->rm_work); 536287905e6SSaravana Kannan } 537287905e6SSaravana Kannan 538287905e6SSaravana Kannan static struct class devlink_class = { 539287905e6SSaravana Kannan .name = "devlink", 540287905e6SSaravana Kannan .owner = THIS_MODULE, 541287905e6SSaravana Kannan .dev_groups = devlink_groups, 542287905e6SSaravana Kannan .dev_release = devlink_dev_release, 543287905e6SSaravana Kannan }; 544287905e6SSaravana Kannan 545287905e6SSaravana Kannan static int devlink_add_symlinks(struct device *dev, 546287905e6SSaravana Kannan struct class_interface *class_intf) 547287905e6SSaravana Kannan { 548287905e6SSaravana Kannan int ret; 549287905e6SSaravana Kannan size_t len; 550287905e6SSaravana Kannan struct device_link *link = to_devlink(dev); 551287905e6SSaravana Kannan struct device *sup = link->supplier; 552287905e6SSaravana Kannan struct device *con = link->consumer; 553287905e6SSaravana Kannan char *buf; 554287905e6SSaravana Kannan 555e020ff61SSaravana Kannan len = max(strlen(dev_bus_name(sup)) + strlen(dev_name(sup)), 556e020ff61SSaravana Kannan strlen(dev_bus_name(con)) + strlen(dev_name(con))); 557e020ff61SSaravana Kannan len += strlen(":"); 558287905e6SSaravana Kannan len += strlen("supplier:") + 1; 559287905e6SSaravana Kannan buf = kzalloc(len, GFP_KERNEL); 560287905e6SSaravana Kannan if (!buf) 561287905e6SSaravana Kannan return -ENOMEM; 562287905e6SSaravana Kannan 563287905e6SSaravana Kannan ret = sysfs_create_link(&link->link_dev.kobj, &sup->kobj, "supplier"); 564287905e6SSaravana Kannan if (ret) 565287905e6SSaravana Kannan goto out; 566287905e6SSaravana Kannan 567287905e6SSaravana Kannan ret = sysfs_create_link(&link->link_dev.kobj, &con->kobj, "consumer"); 568287905e6SSaravana Kannan if (ret) 569287905e6SSaravana Kannan goto err_con; 570287905e6SSaravana Kannan 571e020ff61SSaravana Kannan snprintf(buf, len, "consumer:%s:%s", dev_bus_name(con), dev_name(con)); 572287905e6SSaravana Kannan ret = sysfs_create_link(&sup->kobj, &link->link_dev.kobj, buf); 573287905e6SSaravana Kannan if (ret) 574287905e6SSaravana Kannan goto err_con_dev; 575287905e6SSaravana Kannan 576e020ff61SSaravana Kannan snprintf(buf, len, "supplier:%s:%s", dev_bus_name(sup), dev_name(sup)); 577287905e6SSaravana Kannan ret = sysfs_create_link(&con->kobj, &link->link_dev.kobj, buf); 578287905e6SSaravana Kannan if (ret) 579287905e6SSaravana Kannan goto err_sup_dev; 580287905e6SSaravana Kannan 581287905e6SSaravana Kannan goto out; 582287905e6SSaravana Kannan 583287905e6SSaravana Kannan err_sup_dev: 584e020ff61SSaravana Kannan snprintf(buf, len, "consumer:%s:%s", dev_bus_name(con), dev_name(con)); 585287905e6SSaravana Kannan sysfs_remove_link(&sup->kobj, buf); 586287905e6SSaravana Kannan err_con_dev: 587287905e6SSaravana Kannan sysfs_remove_link(&link->link_dev.kobj, "consumer"); 588287905e6SSaravana Kannan err_con: 589287905e6SSaravana Kannan sysfs_remove_link(&link->link_dev.kobj, "supplier"); 590287905e6SSaravana Kannan out: 591287905e6SSaravana Kannan kfree(buf); 592287905e6SSaravana Kannan return ret; 593287905e6SSaravana Kannan } 594287905e6SSaravana Kannan 595287905e6SSaravana Kannan static void devlink_remove_symlinks(struct device *dev, 596287905e6SSaravana Kannan struct class_interface *class_intf) 597287905e6SSaravana Kannan { 598287905e6SSaravana Kannan struct device_link *link = to_devlink(dev); 599287905e6SSaravana Kannan size_t len; 600287905e6SSaravana Kannan struct device *sup = link->supplier; 601287905e6SSaravana Kannan struct device *con = link->consumer; 602287905e6SSaravana Kannan char *buf; 603287905e6SSaravana Kannan 604287905e6SSaravana Kannan sysfs_remove_link(&link->link_dev.kobj, "consumer"); 605287905e6SSaravana Kannan sysfs_remove_link(&link->link_dev.kobj, "supplier"); 606287905e6SSaravana Kannan 607e020ff61SSaravana Kannan len = max(strlen(dev_bus_name(sup)) + strlen(dev_name(sup)), 608e020ff61SSaravana Kannan strlen(dev_bus_name(con)) + strlen(dev_name(con))); 609e020ff61SSaravana Kannan len += strlen(":"); 610287905e6SSaravana Kannan len += strlen("supplier:") + 1; 611287905e6SSaravana Kannan buf = kzalloc(len, GFP_KERNEL); 612287905e6SSaravana Kannan if (!buf) { 613287905e6SSaravana Kannan WARN(1, "Unable to properly free device link symlinks!\n"); 614287905e6SSaravana Kannan return; 615287905e6SSaravana Kannan } 616287905e6SSaravana Kannan 617e64daad6SAdrian Hunter if (device_is_registered(con)) { 618e020ff61SSaravana Kannan snprintf(buf, len, "supplier:%s:%s", dev_bus_name(sup), dev_name(sup)); 619287905e6SSaravana Kannan sysfs_remove_link(&con->kobj, buf); 620e64daad6SAdrian Hunter } 621e020ff61SSaravana Kannan snprintf(buf, len, "consumer:%s:%s", dev_bus_name(con), dev_name(con)); 622287905e6SSaravana Kannan sysfs_remove_link(&sup->kobj, buf); 623287905e6SSaravana Kannan kfree(buf); 624287905e6SSaravana Kannan } 625287905e6SSaravana Kannan 626287905e6SSaravana Kannan static struct class_interface devlink_class_intf = { 627287905e6SSaravana Kannan .class = &devlink_class, 628287905e6SSaravana Kannan .add_dev = devlink_add_symlinks, 629287905e6SSaravana Kannan .remove_dev = devlink_remove_symlinks, 630287905e6SSaravana Kannan }; 631287905e6SSaravana Kannan 632287905e6SSaravana Kannan static int __init devlink_class_init(void) 633287905e6SSaravana Kannan { 634287905e6SSaravana Kannan int ret; 635287905e6SSaravana Kannan 636287905e6SSaravana Kannan ret = class_register(&devlink_class); 637287905e6SSaravana Kannan if (ret) 638287905e6SSaravana Kannan return ret; 639287905e6SSaravana Kannan 640287905e6SSaravana Kannan ret = class_interface_register(&devlink_class_intf); 641287905e6SSaravana Kannan if (ret) 642287905e6SSaravana Kannan class_unregister(&devlink_class); 643287905e6SSaravana Kannan 644287905e6SSaravana Kannan return ret; 645287905e6SSaravana Kannan } 646287905e6SSaravana Kannan postcore_initcall(devlink_class_init); 647287905e6SSaravana Kannan 648515db266SRafael J. Wysocki #define DL_MANAGED_LINK_FLAGS (DL_FLAG_AUTOREMOVE_CONSUMER | \ 649515db266SRafael J. Wysocki DL_FLAG_AUTOREMOVE_SUPPLIER | \ 65005ef983eSSaravana Kannan DL_FLAG_AUTOPROBE_CONSUMER | \ 6514b9bbb29SSaravana Kannan DL_FLAG_SYNC_STATE_ONLY | \ 65267cad5c6SSaravana Kannan DL_FLAG_INFERRED | \ 65367cad5c6SSaravana Kannan DL_FLAG_CYCLE) 654515db266SRafael J. Wysocki 655fb583c8eSRafael J. Wysocki #define DL_ADD_VALID_FLAGS (DL_MANAGED_LINK_FLAGS | DL_FLAG_STATELESS | \ 656fb583c8eSRafael J. Wysocki DL_FLAG_PM_RUNTIME | DL_FLAG_RPM_ACTIVE) 657fb583c8eSRafael J. Wysocki 658494fd7b7SFeng Kan /** 6599ed98953SRafael J. Wysocki * device_link_add - Create a link between two devices. 6609ed98953SRafael J. Wysocki * @consumer: Consumer end of the link. 6619ed98953SRafael J. Wysocki * @supplier: Supplier end of the link. 6629ed98953SRafael J. Wysocki * @flags: Link flags. 6639ed98953SRafael J. Wysocki * 66421d5c57bSRafael J. Wysocki * The caller is responsible for the proper synchronization of the link creation 66521d5c57bSRafael J. Wysocki * with runtime PM. First, setting the DL_FLAG_PM_RUNTIME flag will cause the 66621d5c57bSRafael J. Wysocki * runtime PM framework to take the link into account. Second, if the 66721d5c57bSRafael J. Wysocki * DL_FLAG_RPM_ACTIVE flag is set in addition to it, the supplier devices will 66821d5c57bSRafael J. Wysocki * be forced into the active meta state and reference-counted upon the creation 66921d5c57bSRafael J. Wysocki * of the link. If DL_FLAG_PM_RUNTIME is not set, DL_FLAG_RPM_ACTIVE will be 67021d5c57bSRafael J. Wysocki * ignored. 67121d5c57bSRafael J. Wysocki * 672515db266SRafael J. Wysocki * If DL_FLAG_STATELESS is set in @flags, the caller of this function is 673515db266SRafael J. Wysocki * expected to release the link returned by it directly with the help of either 674515db266SRafael J. Wysocki * device_link_del() or device_link_remove(). 67572175d4eSRafael J. Wysocki * 67672175d4eSRafael J. Wysocki * If that flag is not set, however, the caller of this function is handing the 67772175d4eSRafael J. Wysocki * management of the link over to the driver core entirely and its return value 67872175d4eSRafael J. Wysocki * can only be used to check whether or not the link is present. In that case, 67972175d4eSRafael J. Wysocki * the DL_FLAG_AUTOREMOVE_CONSUMER and DL_FLAG_AUTOREMOVE_SUPPLIER device link 68072175d4eSRafael J. Wysocki * flags can be used to indicate to the driver core when the link can be safely 68172175d4eSRafael J. Wysocki * deleted. Namely, setting one of them in @flags indicates to the driver core 68272175d4eSRafael J. Wysocki * that the link is not going to be used (by the given caller of this function) 68372175d4eSRafael J. Wysocki * after unbinding the consumer or supplier driver, respectively, from its 68472175d4eSRafael J. Wysocki * device, so the link can be deleted at that point. If none of them is set, 68572175d4eSRafael J. Wysocki * the link will be maintained until one of the devices pointed to by it (either 68672175d4eSRafael J. Wysocki * the consumer or the supplier) is unregistered. 687c8d50986SRafael J. Wysocki * 688e7dd4010SRafael J. Wysocki * Also, if DL_FLAG_STATELESS, DL_FLAG_AUTOREMOVE_CONSUMER and 689e7dd4010SRafael J. Wysocki * DL_FLAG_AUTOREMOVE_SUPPLIER are not set in @flags (that is, a persistent 690e7dd4010SRafael J. Wysocki * managed device link is being added), the DL_FLAG_AUTOPROBE_CONSUMER flag can 691d475f8eaSThierry Reding * be used to request the driver core to automatically probe for a consumer 692e7dd4010SRafael J. Wysocki * driver after successfully binding a driver to the supplier device. 693e7dd4010SRafael J. Wysocki * 694515db266SRafael J. Wysocki * The combination of DL_FLAG_STATELESS and one of DL_FLAG_AUTOREMOVE_CONSUMER, 695515db266SRafael J. Wysocki * DL_FLAG_AUTOREMOVE_SUPPLIER, or DL_FLAG_AUTOPROBE_CONSUMER set in @flags at 696515db266SRafael J. Wysocki * the same time is invalid and will cause NULL to be returned upfront. 697515db266SRafael J. Wysocki * However, if a device link between the given @consumer and @supplier pair 698515db266SRafael J. Wysocki * exists already when this function is called for them, the existing link will 699515db266SRafael J. Wysocki * be returned regardless of its current type and status (the link's flags may 700515db266SRafael J. Wysocki * be modified then). The caller of this function is then expected to treat 701515db266SRafael J. Wysocki * the link as though it has just been created, so (in particular) if 702515db266SRafael J. Wysocki * DL_FLAG_STATELESS was passed in @flags, the link needs to be released 703515db266SRafael J. Wysocki * explicitly when not needed any more (as stated above). 7049ed98953SRafael J. Wysocki * 7059ed98953SRafael J. Wysocki * A side effect of the link creation is re-ordering of dpm_list and the 7069ed98953SRafael J. Wysocki * devices_kset list by moving the consumer device and all devices depending 7079ed98953SRafael J. Wysocki * on it to the ends of these lists (that does not happen to devices that have 7089ed98953SRafael J. Wysocki * not been registered when this function is called). 7099ed98953SRafael J. Wysocki * 7109ed98953SRafael J. Wysocki * The supplier device is required to be registered when this function is called 7119ed98953SRafael J. Wysocki * and NULL will be returned if that is not the case. The consumer device need 71264df1148SLukas Wunner * not be registered, however. 7139ed98953SRafael J. Wysocki */ 7149ed98953SRafael J. Wysocki struct device_link *device_link_add(struct device *consumer, 7159ed98953SRafael J. Wysocki struct device *supplier, u32 flags) 7169ed98953SRafael J. Wysocki { 7179ed98953SRafael J. Wysocki struct device_link *link; 7189ed98953SRafael J. Wysocki 719f729a592SSaravana Kannan if (!consumer || !supplier || consumer == supplier || 720f729a592SSaravana Kannan flags & ~DL_ADD_VALID_FLAGS || 721515db266SRafael J. Wysocki (flags & DL_FLAG_STATELESS && flags & DL_MANAGED_LINK_FLAGS) || 722e7dd4010SRafael J. Wysocki (flags & DL_FLAG_AUTOPROBE_CONSUMER && 723e7dd4010SRafael J. Wysocki flags & (DL_FLAG_AUTOREMOVE_CONSUMER | 724e7dd4010SRafael J. Wysocki DL_FLAG_AUTOREMOVE_SUPPLIER))) 7259ed98953SRafael J. Wysocki return NULL; 7269ed98953SRafael J. Wysocki 7275db25c9eSRafael J. Wysocki if (flags & DL_FLAG_PM_RUNTIME && flags & DL_FLAG_RPM_ACTIVE) { 7285db25c9eSRafael J. Wysocki if (pm_runtime_get_sync(supplier) < 0) { 7295db25c9eSRafael J. Wysocki pm_runtime_put_noidle(supplier); 7305db25c9eSRafael J. Wysocki return NULL; 7315db25c9eSRafael J. Wysocki } 7325db25c9eSRafael J. Wysocki } 7335db25c9eSRafael J. Wysocki 734515db266SRafael J. Wysocki if (!(flags & DL_FLAG_STATELESS)) 735515db266SRafael J. Wysocki flags |= DL_FLAG_MANAGED; 736515db266SRafael J. Wysocki 73767cad5c6SSaravana Kannan if (flags & DL_FLAG_SYNC_STATE_ONLY && 73867cad5c6SSaravana Kannan !device_link_flag_is_sync_state_only(flags)) 73967cad5c6SSaravana Kannan return NULL; 74067cad5c6SSaravana Kannan 7419ed98953SRafael J. Wysocki device_links_write_lock(); 7429ed98953SRafael J. Wysocki device_pm_lock(); 7439ed98953SRafael J. Wysocki 7449ed98953SRafael J. Wysocki /* 7459ed98953SRafael J. Wysocki * If the supplier has not been fully registered yet or there is a 74605ef983eSSaravana Kannan * reverse (non-SYNC_STATE_ONLY) dependency between the consumer and 74705ef983eSSaravana Kannan * the supplier already in the graph, return NULL. If the link is a 74805ef983eSSaravana Kannan * SYNC_STATE_ONLY link, we don't check for reverse dependencies 74905ef983eSSaravana Kannan * because it only affects sync_state() callbacks. 7509ed98953SRafael J. Wysocki */ 7519ed98953SRafael J. Wysocki if (!device_pm_initialized(supplier) 75205ef983eSSaravana Kannan || (!(flags & DL_FLAG_SYNC_STATE_ONLY) && 75305ef983eSSaravana Kannan device_is_dependent(consumer, supplier))) { 7549ed98953SRafael J. Wysocki link = NULL; 7559ed98953SRafael J. Wysocki goto out; 7569ed98953SRafael J. Wysocki } 7579ed98953SRafael J. Wysocki 75872175d4eSRafael J. Wysocki /* 759ac66c5bbSSaravana Kannan * SYNC_STATE_ONLY links are useless once a consumer device has probed. 760ac66c5bbSSaravana Kannan * So, only create it if the consumer hasn't probed yet. 761ac66c5bbSSaravana Kannan */ 762ac66c5bbSSaravana Kannan if (flags & DL_FLAG_SYNC_STATE_ONLY && 763ac66c5bbSSaravana Kannan consumer->links.status != DL_DEV_NO_DRIVER && 764ac66c5bbSSaravana Kannan consumer->links.status != DL_DEV_PROBING) { 765ac66c5bbSSaravana Kannan link = NULL; 766ac66c5bbSSaravana Kannan goto out; 767ac66c5bbSSaravana Kannan } 768ac66c5bbSSaravana Kannan 769ac66c5bbSSaravana Kannan /* 77072175d4eSRafael J. Wysocki * DL_FLAG_AUTOREMOVE_SUPPLIER indicates that the link will be needed 77172175d4eSRafael J. Wysocki * longer than for DL_FLAG_AUTOREMOVE_CONSUMER and setting them both 77272175d4eSRafael J. Wysocki * together doesn't make sense, so prefer DL_FLAG_AUTOREMOVE_SUPPLIER. 77372175d4eSRafael J. Wysocki */ 77472175d4eSRafael J. Wysocki if (flags & DL_FLAG_AUTOREMOVE_SUPPLIER) 77572175d4eSRafael J. Wysocki flags &= ~DL_FLAG_AUTOREMOVE_CONSUMER; 77672175d4eSRafael J. Wysocki 777f265df55SRafael J. Wysocki list_for_each_entry(link, &supplier->links.consumers, s_node) { 778f265df55SRafael J. Wysocki if (link->consumer != consumer) 779f265df55SRafael J. Wysocki continue; 780f265df55SRafael J. Wysocki 7814b9bbb29SSaravana Kannan if (link->flags & DL_FLAG_INFERRED && 7824b9bbb29SSaravana Kannan !(flags & DL_FLAG_INFERRED)) 7834b9bbb29SSaravana Kannan link->flags &= ~DL_FLAG_INFERRED; 7844b9bbb29SSaravana Kannan 785e2f3cd83SRafael J. Wysocki if (flags & DL_FLAG_PM_RUNTIME) { 786e2f3cd83SRafael J. Wysocki if (!(link->flags & DL_FLAG_PM_RUNTIME)) { 7874c06c4e6SRafael J. Wysocki pm_runtime_new_link(consumer); 788e2f3cd83SRafael J. Wysocki link->flags |= DL_FLAG_PM_RUNTIME; 789e2f3cd83SRafael J. Wysocki } 790e2f3cd83SRafael J. Wysocki if (flags & DL_FLAG_RPM_ACTIVE) 79136003d4cSRafael J. Wysocki refcount_inc(&link->rpm_active); 792e2f3cd83SRafael J. Wysocki } 793e2f3cd83SRafael J. Wysocki 79472175d4eSRafael J. Wysocki if (flags & DL_FLAG_STATELESS) { 795ead18c23SLukas Wunner kref_get(&link->kref); 79621c27f06SSaravana Kannan if (link->flags & DL_FLAG_SYNC_STATE_ONLY && 79744e96049SSaravana Kannan !(link->flags & DL_FLAG_STATELESS)) { 79844e96049SSaravana Kannan link->flags |= DL_FLAG_STATELESS; 79905ef983eSSaravana Kannan goto reorder; 80044e96049SSaravana Kannan } else { 80144e96049SSaravana Kannan link->flags |= DL_FLAG_STATELESS; 8029ed98953SRafael J. Wysocki goto out; 803ead18c23SLukas Wunner } 80444e96049SSaravana Kannan } 8059ed98953SRafael J. Wysocki 80672175d4eSRafael J. Wysocki /* 80772175d4eSRafael J. Wysocki * If the life time of the link following from the new flags is 80872175d4eSRafael J. Wysocki * longer than indicated by the flags of the existing link, 80972175d4eSRafael J. Wysocki * update the existing link to stay around longer. 81072175d4eSRafael J. Wysocki */ 81172175d4eSRafael J. Wysocki if (flags & DL_FLAG_AUTOREMOVE_SUPPLIER) { 81272175d4eSRafael J. Wysocki if (link->flags & DL_FLAG_AUTOREMOVE_CONSUMER) { 81372175d4eSRafael J. Wysocki link->flags &= ~DL_FLAG_AUTOREMOVE_CONSUMER; 81472175d4eSRafael J. Wysocki link->flags |= DL_FLAG_AUTOREMOVE_SUPPLIER; 81572175d4eSRafael J. Wysocki } 81672175d4eSRafael J. Wysocki } else if (!(flags & DL_FLAG_AUTOREMOVE_CONSUMER)) { 81772175d4eSRafael J. Wysocki link->flags &= ~(DL_FLAG_AUTOREMOVE_CONSUMER | 81872175d4eSRafael J. Wysocki DL_FLAG_AUTOREMOVE_SUPPLIER); 81972175d4eSRafael J. Wysocki } 820515db266SRafael J. Wysocki if (!(link->flags & DL_FLAG_MANAGED)) { 821515db266SRafael J. Wysocki kref_get(&link->kref); 822515db266SRafael J. Wysocki link->flags |= DL_FLAG_MANAGED; 823515db266SRafael J. Wysocki device_link_init_status(link, consumer, supplier); 824515db266SRafael J. Wysocki } 82505ef983eSSaravana Kannan if (link->flags & DL_FLAG_SYNC_STATE_ONLY && 82605ef983eSSaravana Kannan !(flags & DL_FLAG_SYNC_STATE_ONLY)) { 82705ef983eSSaravana Kannan link->flags &= ~DL_FLAG_SYNC_STATE_ONLY; 82805ef983eSSaravana Kannan goto reorder; 82905ef983eSSaravana Kannan } 83005ef983eSSaravana Kannan 83172175d4eSRafael J. Wysocki goto out; 83272175d4eSRafael J. Wysocki } 83372175d4eSRafael J. Wysocki 83421d5c57bSRafael J. Wysocki link = kzalloc(sizeof(*link), GFP_KERNEL); 8359ed98953SRafael J. Wysocki if (!link) 8369ed98953SRafael J. Wysocki goto out; 8379ed98953SRafael J. Wysocki 838e2f3cd83SRafael J. Wysocki refcount_set(&link->rpm_active, 1); 839e2f3cd83SRafael J. Wysocki 8409ed98953SRafael J. Wysocki get_device(supplier); 8419ed98953SRafael J. Wysocki link->supplier = supplier; 8429ed98953SRafael J. Wysocki INIT_LIST_HEAD(&link->s_node); 8439ed98953SRafael J. Wysocki get_device(consumer); 8449ed98953SRafael J. Wysocki link->consumer = consumer; 8459ed98953SRafael J. Wysocki INIT_LIST_HEAD(&link->c_node); 8469ed98953SRafael J. Wysocki link->flags = flags; 847ead18c23SLukas Wunner kref_init(&link->kref); 8489ed98953SRafael J. Wysocki 849287905e6SSaravana Kannan link->link_dev.class = &devlink_class; 850287905e6SSaravana Kannan device_set_pm_not_required(&link->link_dev); 851e020ff61SSaravana Kannan dev_set_name(&link->link_dev, "%s:%s--%s:%s", 852e020ff61SSaravana Kannan dev_bus_name(supplier), dev_name(supplier), 853e020ff61SSaravana Kannan dev_bus_name(consumer), dev_name(consumer)); 854287905e6SSaravana Kannan if (device_register(&link->link_dev)) { 855df0a1814SYang Yingliang put_device(&link->link_dev); 856287905e6SSaravana Kannan link = NULL; 857287905e6SSaravana Kannan goto out; 858287905e6SSaravana Kannan } 859287905e6SSaravana Kannan 860287905e6SSaravana Kannan if (flags & DL_FLAG_PM_RUNTIME) { 861287905e6SSaravana Kannan if (flags & DL_FLAG_RPM_ACTIVE) 862287905e6SSaravana Kannan refcount_inc(&link->rpm_active); 863287905e6SSaravana Kannan 864287905e6SSaravana Kannan pm_runtime_new_link(consumer); 865287905e6SSaravana Kannan } 866287905e6SSaravana Kannan 86764df1148SLukas Wunner /* Determine the initial link state. */ 868515db266SRafael J. Wysocki if (flags & DL_FLAG_STATELESS) 8699ed98953SRafael J. Wysocki link->status = DL_STATE_NONE; 870515db266SRafael J. Wysocki else 871515db266SRafael J. Wysocki device_link_init_status(link, consumer, supplier); 8729ed98953SRafael J. Wysocki 8739ed98953SRafael J. Wysocki /* 87415cfb094SRafael J. Wysocki * Some callers expect the link creation during consumer driver probe to 87515cfb094SRafael J. Wysocki * resume the supplier even without DL_FLAG_RPM_ACTIVE. 87615cfb094SRafael J. Wysocki */ 87715cfb094SRafael J. Wysocki if (link->status == DL_STATE_CONSUMER_PROBE && 87815cfb094SRafael J. Wysocki flags & DL_FLAG_PM_RUNTIME) 87915cfb094SRafael J. Wysocki pm_runtime_resume(supplier); 88015cfb094SRafael J. Wysocki 88121c27f06SSaravana Kannan list_add_tail_rcu(&link->s_node, &supplier->links.consumers); 88221c27f06SSaravana Kannan list_add_tail_rcu(&link->c_node, &consumer->links.suppliers); 88321c27f06SSaravana Kannan 88405ef983eSSaravana Kannan if (flags & DL_FLAG_SYNC_STATE_ONLY) { 88505ef983eSSaravana Kannan dev_dbg(consumer, 88605ef983eSSaravana Kannan "Linked as a sync state only consumer to %s\n", 88705ef983eSSaravana Kannan dev_name(supplier)); 88805ef983eSSaravana Kannan goto out; 88905ef983eSSaravana Kannan } 89021c27f06SSaravana Kannan 89105ef983eSSaravana Kannan reorder: 89215cfb094SRafael J. Wysocki /* 8939ed98953SRafael J. Wysocki * Move the consumer and all of the devices depending on it to the end 8949ed98953SRafael J. Wysocki * of dpm_list and the devices_kset list. 8959ed98953SRafael J. Wysocki * 8969ed98953SRafael J. Wysocki * It is necessary to hold dpm_list locked throughout all that or else 8979ed98953SRafael J. Wysocki * we may end up suspending with a wrong ordering of it. 8989ed98953SRafael J. Wysocki */ 8999ed98953SRafael J. Wysocki device_reorder_to_tail(consumer, NULL); 9009ed98953SRafael J. Wysocki 9018a4b3269SJerome Brunet dev_dbg(consumer, "Linked as a consumer to %s\n", dev_name(supplier)); 9029ed98953SRafael J. Wysocki 9039ed98953SRafael J. Wysocki out: 9049ed98953SRafael J. Wysocki device_pm_unlock(); 9059ed98953SRafael J. Wysocki device_links_write_unlock(); 9065db25c9eSRafael J. Wysocki 907e2f3cd83SRafael J. Wysocki if ((flags & DL_FLAG_PM_RUNTIME && flags & DL_FLAG_RPM_ACTIVE) && !link) 9085db25c9eSRafael J. Wysocki pm_runtime_put(supplier); 9095db25c9eSRafael J. Wysocki 9109ed98953SRafael J. Wysocki return link; 9119ed98953SRafael J. Wysocki } 9129ed98953SRafael J. Wysocki EXPORT_SYMBOL_GPL(device_link_add); 9139ed98953SRafael J. Wysocki 914ead18c23SLukas Wunner static void __device_link_del(struct kref *kref) 9159ed98953SRafael J. Wysocki { 916ead18c23SLukas Wunner struct device_link *link = container_of(kref, struct device_link, kref); 917ead18c23SLukas Wunner 9188a4b3269SJerome Brunet dev_dbg(link->consumer, "Dropping the link to %s\n", 9199ed98953SRafael J. Wysocki dev_name(link->supplier)); 9209ed98953SRafael J. Wysocki 921e0e398e2SRafael J. Wysocki pm_runtime_drop_link(link); 922baa8809fSRafael J. Wysocki 9230c871315SRafael J. Wysocki device_link_remove_from_lists(link); 924843e600bSSaravana Kannan device_unregister(&link->link_dev); 9259ed98953SRafael J. Wysocki } 9269ed98953SRafael J. Wysocki 92772175d4eSRafael J. Wysocki static void device_link_put_kref(struct device_link *link) 92872175d4eSRafael J. Wysocki { 92972175d4eSRafael J. Wysocki if (link->flags & DL_FLAG_STATELESS) 93072175d4eSRafael J. Wysocki kref_put(&link->kref, __device_link_del); 931bf25967aSAdrian Hunter else if (!device_is_registered(link->consumer)) 932bf25967aSAdrian Hunter __device_link_del(&link->kref); 93372175d4eSRafael J. Wysocki else 93472175d4eSRafael J. Wysocki WARN(1, "Unable to drop a managed device link reference\n"); 93572175d4eSRafael J. Wysocki } 93672175d4eSRafael J. Wysocki 9379ed98953SRafael J. Wysocki /** 93872175d4eSRafael J. Wysocki * device_link_del - Delete a stateless link between two devices. 9399ed98953SRafael J. Wysocki * @link: Device link to delete. 9409ed98953SRafael J. Wysocki * 9419ed98953SRafael J. Wysocki * The caller must ensure proper synchronization of this function with runtime 942ead18c23SLukas Wunner * PM. If the link was added multiple times, it needs to be deleted as often. 943ead18c23SLukas Wunner * Care is required for hotplugged devices: Their links are purged on removal 944ead18c23SLukas Wunner * and calling device_link_del() is then no longer allowed. 9459ed98953SRafael J. Wysocki */ 9469ed98953SRafael J. Wysocki void device_link_del(struct device_link *link) 9479ed98953SRafael J. Wysocki { 9489ed98953SRafael J. Wysocki device_links_write_lock(); 94972175d4eSRafael J. Wysocki device_link_put_kref(link); 9509ed98953SRafael J. Wysocki device_links_write_unlock(); 9519ed98953SRafael J. Wysocki } 9529ed98953SRafael J. Wysocki EXPORT_SYMBOL_GPL(device_link_del); 9539ed98953SRafael J. Wysocki 954d8842211Spascal paillet /** 95572175d4eSRafael J. Wysocki * device_link_remove - Delete a stateless link between two devices. 956d8842211Spascal paillet * @consumer: Consumer end of the link. 957d8842211Spascal paillet * @supplier: Supplier end of the link. 958d8842211Spascal paillet * 959d8842211Spascal paillet * The caller must ensure proper synchronization of this function with runtime 960d8842211Spascal paillet * PM. 961d8842211Spascal paillet */ 962d8842211Spascal paillet void device_link_remove(void *consumer, struct device *supplier) 963d8842211Spascal paillet { 964d8842211Spascal paillet struct device_link *link; 965d8842211Spascal paillet 966d8842211Spascal paillet if (WARN_ON(consumer == supplier)) 967d8842211Spascal paillet return; 968d8842211Spascal paillet 969d8842211Spascal paillet device_links_write_lock(); 970d8842211Spascal paillet 971d8842211Spascal paillet list_for_each_entry(link, &supplier->links.consumers, s_node) { 972d8842211Spascal paillet if (link->consumer == consumer) { 97372175d4eSRafael J. Wysocki device_link_put_kref(link); 974d8842211Spascal paillet break; 975d8842211Spascal paillet } 976d8842211Spascal paillet } 977d8842211Spascal paillet 978d8842211Spascal paillet device_links_write_unlock(); 979d8842211Spascal paillet } 980d8842211Spascal paillet EXPORT_SYMBOL_GPL(device_link_remove); 981d8842211Spascal paillet 9829ed98953SRafael J. Wysocki static void device_links_missing_supplier(struct device *dev) 9839ed98953SRafael J. Wysocki { 9849ed98953SRafael J. Wysocki struct device_link *link; 9859ed98953SRafael J. Wysocki 9868c3e315dSSaravana Kannan list_for_each_entry(link, &dev->links.suppliers, c_node) { 9878c3e315dSSaravana Kannan if (link->status != DL_STATE_CONSUMER_PROBE) 9888c3e315dSSaravana Kannan continue; 9898c3e315dSSaravana Kannan 9908c3e315dSSaravana Kannan if (link->supplier->links.status == DL_DEV_DRIVER_BOUND) { 9919ed98953SRafael J. Wysocki WRITE_ONCE(link->status, DL_STATE_AVAILABLE); 9928c3e315dSSaravana Kannan } else { 9938c3e315dSSaravana Kannan WARN_ON(!(link->flags & DL_FLAG_SYNC_STATE_ONLY)); 9948c3e315dSSaravana Kannan WRITE_ONCE(link->status, DL_STATE_DORMANT); 9958c3e315dSSaravana Kannan } 9968c3e315dSSaravana Kannan } 9979ed98953SRafael J. Wysocki } 9989ed98953SRafael J. Wysocki 9992f8c3ae8SSaravana Kannan static bool dev_is_best_effort(struct device *dev) 10002f8c3ae8SSaravana Kannan { 10018f486cabSSaravana Kannan return (fw_devlink_best_effort && dev->can_match) || 10028f486cabSSaravana Kannan (dev->fwnode && (dev->fwnode->flags & FWNODE_FLAG_BEST_EFFORT)); 10032f8c3ae8SSaravana Kannan } 10042f8c3ae8SSaravana Kannan 10056a6dfdf8SSaravana Kannan static struct fwnode_handle *fwnode_links_check_suppliers( 10066a6dfdf8SSaravana Kannan struct fwnode_handle *fwnode) 10076a6dfdf8SSaravana Kannan { 10086a6dfdf8SSaravana Kannan struct fwnode_link *link; 10096a6dfdf8SSaravana Kannan 10106a6dfdf8SSaravana Kannan if (!fwnode || fw_devlink_is_permissive()) 10116a6dfdf8SSaravana Kannan return NULL; 10126a6dfdf8SSaravana Kannan 10136a6dfdf8SSaravana Kannan list_for_each_entry(link, &fwnode->suppliers, c_hook) 10146a6dfdf8SSaravana Kannan if (!(link->flags & FWLINK_FLAG_CYCLE)) 10156a6dfdf8SSaravana Kannan return link->supplier; 10166a6dfdf8SSaravana Kannan 10176a6dfdf8SSaravana Kannan return NULL; 10186a6dfdf8SSaravana Kannan } 10196a6dfdf8SSaravana Kannan 10209ed98953SRafael J. Wysocki /** 10219ed98953SRafael J. Wysocki * device_links_check_suppliers - Check presence of supplier drivers. 10229ed98953SRafael J. Wysocki * @dev: Consumer device. 10239ed98953SRafael J. Wysocki * 10249ed98953SRafael J. Wysocki * Check links from this device to any suppliers. Walk the list of the device's 10259ed98953SRafael J. Wysocki * links to suppliers and see if all of them are available. If not, simply 10269ed98953SRafael J. Wysocki * return -EPROBE_DEFER. 10279ed98953SRafael J. Wysocki * 10289ed98953SRafael J. Wysocki * We need to guarantee that the supplier will not go away after the check has 10299ed98953SRafael J. Wysocki * been positive here. It only can go away in __device_release_driver() and 10309ed98953SRafael J. Wysocki * that function checks the device's links to consumers. This means we need to 10319ed98953SRafael J. Wysocki * mark the link as "consumer probe in progress" to make the supplier removal 10329ed98953SRafael J. Wysocki * wait for us to complete (or bad things may happen). 10339ed98953SRafael J. Wysocki * 1034515db266SRafael J. Wysocki * Links without the DL_FLAG_MANAGED flag set are ignored. 10359ed98953SRafael J. Wysocki */ 10369ed98953SRafael J. Wysocki int device_links_check_suppliers(struct device *dev) 10379ed98953SRafael J. Wysocki { 10389ed98953SRafael J. Wysocki struct device_link *link; 10392f8c3ae8SSaravana Kannan int ret = 0, fwnode_ret = 0; 104068223eeeSSaravana Kannan struct fwnode_handle *sup_fw; 10419ed98953SRafael J. Wysocki 1042e2ae9bccSSaravana Kannan /* 1043e2ae9bccSSaravana Kannan * Device waiting for supplier to become available is not allowed to 1044e2ae9bccSSaravana Kannan * probe. 1045e2ae9bccSSaravana Kannan */ 104625ac86c6SSaravana Kannan mutex_lock(&fwnode_link_lock); 10476a6dfdf8SSaravana Kannan sup_fw = fwnode_links_check_suppliers(dev->fwnode); 10486a6dfdf8SSaravana Kannan if (sup_fw) { 10492f8c3ae8SSaravana Kannan if (!dev_is_best_effort(dev)) { 10502f8c3ae8SSaravana Kannan fwnode_ret = -EPROBE_DEFER; 10512f8c3ae8SSaravana Kannan dev_err_probe(dev, -EPROBE_DEFER, 10520c058fb9SSaravana Kannan "wait for supplier %pfwf\n", sup_fw); 10532f8c3ae8SSaravana Kannan } else { 10542f8c3ae8SSaravana Kannan fwnode_ret = -EAGAIN; 10552f8c3ae8SSaravana Kannan } 1056e2ae9bccSSaravana Kannan } 105725ac86c6SSaravana Kannan mutex_unlock(&fwnode_link_lock); 10582f8c3ae8SSaravana Kannan if (fwnode_ret == -EPROBE_DEFER) 10592f8c3ae8SSaravana Kannan return fwnode_ret; 1060e2ae9bccSSaravana Kannan 10619ed98953SRafael J. Wysocki device_links_write_lock(); 10629ed98953SRafael J. Wysocki 10639ed98953SRafael J. Wysocki list_for_each_entry(link, &dev->links.suppliers, c_node) { 10648c3e315dSSaravana Kannan if (!(link->flags & DL_FLAG_MANAGED)) 10659ed98953SRafael J. Wysocki continue; 10669ed98953SRafael J. Wysocki 10678c3e315dSSaravana Kannan if (link->status != DL_STATE_AVAILABLE && 10688c3e315dSSaravana Kannan !(link->flags & DL_FLAG_SYNC_STATE_ONLY)) { 10692f8c3ae8SSaravana Kannan 10702f8c3ae8SSaravana Kannan if (dev_is_best_effort(dev) && 10712f8c3ae8SSaravana Kannan link->flags & DL_FLAG_INFERRED && 10722f8c3ae8SSaravana Kannan !link->supplier->can_match) { 10732f8c3ae8SSaravana Kannan ret = -EAGAIN; 10742f8c3ae8SSaravana Kannan continue; 10752f8c3ae8SSaravana Kannan } 10762f8c3ae8SSaravana Kannan 10779ed98953SRafael J. Wysocki device_links_missing_supplier(dev); 107868223eeeSSaravana Kannan dev_err_probe(dev, -EPROBE_DEFER, 107968223eeeSSaravana Kannan "supplier %s not ready\n", 10801f0dfa05SSaravana Kannan dev_name(link->supplier)); 10819ed98953SRafael J. Wysocki ret = -EPROBE_DEFER; 10829ed98953SRafael J. Wysocki break; 10839ed98953SRafael J. Wysocki } 10849ed98953SRafael J. Wysocki WRITE_ONCE(link->status, DL_STATE_CONSUMER_PROBE); 10859ed98953SRafael J. Wysocki } 10869ed98953SRafael J. Wysocki dev->links.status = DL_DEV_PROBING; 10879ed98953SRafael J. Wysocki 10889ed98953SRafael J. Wysocki device_links_write_unlock(); 10892f8c3ae8SSaravana Kannan 10902f8c3ae8SSaravana Kannan return ret ? ret : fwnode_ret; 10919ed98953SRafael J. Wysocki } 10929ed98953SRafael J. Wysocki 109326e77708SSaravana Kannan /** 109426e77708SSaravana Kannan * __device_links_queue_sync_state - Queue a device for sync_state() callback 109526e77708SSaravana Kannan * @dev: Device to call sync_state() on 109626e77708SSaravana Kannan * @list: List head to queue the @dev on 109726e77708SSaravana Kannan * 109826e77708SSaravana Kannan * Queues a device for a sync_state() callback when the device links write lock 109926e77708SSaravana Kannan * isn't held. This allows the sync_state() execution flow to use device links 110026e77708SSaravana Kannan * APIs. The caller must ensure this function is called with 110126e77708SSaravana Kannan * device_links_write_lock() held. 110226e77708SSaravana Kannan * 110326e77708SSaravana Kannan * This function does a get_device() to make sure the device is not freed while 110426e77708SSaravana Kannan * on this list. 110526e77708SSaravana Kannan * 110626e77708SSaravana Kannan * So the caller must also ensure that device_links_flush_sync_list() is called 110726e77708SSaravana Kannan * as soon as the caller releases device_links_write_lock(). This is necessary 110826e77708SSaravana Kannan * to make sure the sync_state() is called in a timely fashion and the 110926e77708SSaravana Kannan * put_device() is called on this device. 111026e77708SSaravana Kannan */ 111126e77708SSaravana Kannan static void __device_links_queue_sync_state(struct device *dev, 111226e77708SSaravana Kannan struct list_head *list) 1113fc5a251dSSaravana Kannan { 1114fc5a251dSSaravana Kannan struct device_link *link; 1115fc5a251dSSaravana Kannan 111677036165SSaravana Kannan if (!dev_has_sync_state(dev)) 111777036165SSaravana Kannan return; 1118fc5a251dSSaravana Kannan if (dev->state_synced) 1119fc5a251dSSaravana Kannan return; 1120fc5a251dSSaravana Kannan 1121fc5a251dSSaravana Kannan list_for_each_entry(link, &dev->links.consumers, s_node) { 1122fc5a251dSSaravana Kannan if (!(link->flags & DL_FLAG_MANAGED)) 1123fc5a251dSSaravana Kannan continue; 1124fc5a251dSSaravana Kannan if (link->status != DL_STATE_ACTIVE) 1125fc5a251dSSaravana Kannan return; 1126fc5a251dSSaravana Kannan } 1127fc5a251dSSaravana Kannan 112826e77708SSaravana Kannan /* 112926e77708SSaravana Kannan * Set the flag here to avoid adding the same device to a list more 113026e77708SSaravana Kannan * than once. This can happen if new consumers get added to the device 113126e77708SSaravana Kannan * and probed before the list is flushed. 113226e77708SSaravana Kannan */ 113326e77708SSaravana Kannan dev->state_synced = true; 113426e77708SSaravana Kannan 11353b052a3eSSaravana Kannan if (WARN_ON(!list_empty(&dev->links.defer_sync))) 113626e77708SSaravana Kannan return; 113726e77708SSaravana Kannan 113826e77708SSaravana Kannan get_device(dev); 11393b052a3eSSaravana Kannan list_add_tail(&dev->links.defer_sync, list); 114026e77708SSaravana Kannan } 114126e77708SSaravana Kannan 114226e77708SSaravana Kannan /** 114326e77708SSaravana Kannan * device_links_flush_sync_list - Call sync_state() on a list of devices 114426e77708SSaravana Kannan * @list: List of devices to call sync_state() on 114521eb93f4SSaravana Kannan * @dont_lock_dev: Device for which lock is already held by the caller 114626e77708SSaravana Kannan * 114726e77708SSaravana Kannan * Calls sync_state() on all the devices that have been queued for it. This 114821eb93f4SSaravana Kannan * function is used in conjunction with __device_links_queue_sync_state(). The 114921eb93f4SSaravana Kannan * @dont_lock_dev parameter is useful when this function is called from a 115021eb93f4SSaravana Kannan * context where a device lock is already held. 115126e77708SSaravana Kannan */ 115221eb93f4SSaravana Kannan static void device_links_flush_sync_list(struct list_head *list, 115321eb93f4SSaravana Kannan struct device *dont_lock_dev) 115426e77708SSaravana Kannan { 115526e77708SSaravana Kannan struct device *dev, *tmp; 115626e77708SSaravana Kannan 11573b052a3eSSaravana Kannan list_for_each_entry_safe(dev, tmp, list, links.defer_sync) { 11583b052a3eSSaravana Kannan list_del_init(&dev->links.defer_sync); 115926e77708SSaravana Kannan 116021eb93f4SSaravana Kannan if (dev != dont_lock_dev) 116126e77708SSaravana Kannan device_lock(dev); 116226e77708SSaravana Kannan 1163*f8fb5766SSaravana Kannan dev_sync_state(dev); 1164fc5a251dSSaravana Kannan 116521eb93f4SSaravana Kannan if (dev != dont_lock_dev) 116626e77708SSaravana Kannan device_unlock(dev); 116726e77708SSaravana Kannan 116826e77708SSaravana Kannan put_device(dev); 116926e77708SSaravana Kannan } 1170fc5a251dSSaravana Kannan } 1171fc5a251dSSaravana Kannan 1172fc5a251dSSaravana Kannan void device_links_supplier_sync_state_pause(void) 1173fc5a251dSSaravana Kannan { 1174fc5a251dSSaravana Kannan device_links_write_lock(); 1175fc5a251dSSaravana Kannan defer_sync_state_count++; 1176fc5a251dSSaravana Kannan device_links_write_unlock(); 1177fc5a251dSSaravana Kannan } 1178fc5a251dSSaravana Kannan 1179fc5a251dSSaravana Kannan void device_links_supplier_sync_state_resume(void) 1180fc5a251dSSaravana Kannan { 1181fc5a251dSSaravana Kannan struct device *dev, *tmp; 118226e77708SSaravana Kannan LIST_HEAD(sync_list); 1183fc5a251dSSaravana Kannan 1184fc5a251dSSaravana Kannan device_links_write_lock(); 1185fc5a251dSSaravana Kannan if (!defer_sync_state_count) { 1186fc5a251dSSaravana Kannan WARN(true, "Unmatched sync_state pause/resume!"); 1187fc5a251dSSaravana Kannan goto out; 1188fc5a251dSSaravana Kannan } 1189fc5a251dSSaravana Kannan defer_sync_state_count--; 1190fc5a251dSSaravana Kannan if (defer_sync_state_count) 1191fc5a251dSSaravana Kannan goto out; 1192fc5a251dSSaravana Kannan 11933b052a3eSSaravana Kannan list_for_each_entry_safe(dev, tmp, &deferred_sync, links.defer_sync) { 119426e77708SSaravana Kannan /* 119526e77708SSaravana Kannan * Delete from deferred_sync list before queuing it to 11963b052a3eSSaravana Kannan * sync_list because defer_sync is used for both lists. 119726e77708SSaravana Kannan */ 11983b052a3eSSaravana Kannan list_del_init(&dev->links.defer_sync); 119926e77708SSaravana Kannan __device_links_queue_sync_state(dev, &sync_list); 1200fc5a251dSSaravana Kannan } 1201fc5a251dSSaravana Kannan out: 1202fc5a251dSSaravana Kannan device_links_write_unlock(); 120326e77708SSaravana Kannan 120421eb93f4SSaravana Kannan device_links_flush_sync_list(&sync_list, NULL); 1205fc5a251dSSaravana Kannan } 1206fc5a251dSSaravana Kannan 1207fc5a251dSSaravana Kannan static int sync_state_resume_initcall(void) 1208fc5a251dSSaravana Kannan { 1209fc5a251dSSaravana Kannan device_links_supplier_sync_state_resume(); 1210fc5a251dSSaravana Kannan return 0; 1211fc5a251dSSaravana Kannan } 1212fc5a251dSSaravana Kannan late_initcall(sync_state_resume_initcall); 1213fc5a251dSSaravana Kannan 1214fc5a251dSSaravana Kannan static void __device_links_supplier_defer_sync(struct device *sup) 1215fc5a251dSSaravana Kannan { 12163b052a3eSSaravana Kannan if (list_empty(&sup->links.defer_sync) && dev_has_sync_state(sup)) 12173b052a3eSSaravana Kannan list_add_tail(&sup->links.defer_sync, &deferred_sync); 1218fc5a251dSSaravana Kannan } 1219fc5a251dSSaravana Kannan 122021c27f06SSaravana Kannan static void device_link_drop_managed(struct device_link *link) 122121c27f06SSaravana Kannan { 122221c27f06SSaravana Kannan link->flags &= ~DL_FLAG_MANAGED; 122321c27f06SSaravana Kannan WRITE_ONCE(link->status, DL_STATE_NONE); 122421c27f06SSaravana Kannan kref_put(&link->kref, __device_link_del); 122521c27f06SSaravana Kannan } 122621c27f06SSaravana Kannan 1227da6d6475SSaravana Kannan static ssize_t waiting_for_supplier_show(struct device *dev, 1228da6d6475SSaravana Kannan struct device_attribute *attr, 1229da6d6475SSaravana Kannan char *buf) 1230da6d6475SSaravana Kannan { 1231da6d6475SSaravana Kannan bool val; 1232da6d6475SSaravana Kannan 1233da6d6475SSaravana Kannan device_lock(dev); 12346a6dfdf8SSaravana Kannan mutex_lock(&fwnode_link_lock); 12356a6dfdf8SSaravana Kannan val = !!fwnode_links_check_suppliers(dev->fwnode); 12366a6dfdf8SSaravana Kannan mutex_unlock(&fwnode_link_lock); 1237da6d6475SSaravana Kannan device_unlock(dev); 1238aa838896SJoe Perches return sysfs_emit(buf, "%u\n", val); 1239da6d6475SSaravana Kannan } 1240da6d6475SSaravana Kannan static DEVICE_ATTR_RO(waiting_for_supplier); 1241da6d6475SSaravana Kannan 12429ed98953SRafael J. Wysocki /** 1243b6f617dfSSaravana Kannan * device_links_force_bind - Prepares device to be force bound 1244b6f617dfSSaravana Kannan * @dev: Consumer device. 1245b6f617dfSSaravana Kannan * 1246b6f617dfSSaravana Kannan * device_bind_driver() force binds a device to a driver without calling any 1247b6f617dfSSaravana Kannan * driver probe functions. So the consumer really isn't going to wait for any 1248b6f617dfSSaravana Kannan * supplier before it's bound to the driver. We still want the device link 1249b6f617dfSSaravana Kannan * states to be sensible when this happens. 1250b6f617dfSSaravana Kannan * 1251b6f617dfSSaravana Kannan * In preparation for device_bind_driver(), this function goes through each 1252b6f617dfSSaravana Kannan * supplier device links and checks if the supplier is bound. If it is, then 1253b6f617dfSSaravana Kannan * the device link status is set to CONSUMER_PROBE. Otherwise, the device link 1254b6f617dfSSaravana Kannan * is dropped. Links without the DL_FLAG_MANAGED flag set are ignored. 1255b6f617dfSSaravana Kannan */ 1256b6f617dfSSaravana Kannan void device_links_force_bind(struct device *dev) 1257b6f617dfSSaravana Kannan { 1258b6f617dfSSaravana Kannan struct device_link *link, *ln; 1259b6f617dfSSaravana Kannan 1260b6f617dfSSaravana Kannan device_links_write_lock(); 1261b6f617dfSSaravana Kannan 1262b6f617dfSSaravana Kannan list_for_each_entry_safe(link, ln, &dev->links.suppliers, c_node) { 1263b6f617dfSSaravana Kannan if (!(link->flags & DL_FLAG_MANAGED)) 1264b6f617dfSSaravana Kannan continue; 1265b6f617dfSSaravana Kannan 1266b6f617dfSSaravana Kannan if (link->status != DL_STATE_AVAILABLE) { 1267b6f617dfSSaravana Kannan device_link_drop_managed(link); 1268b6f617dfSSaravana Kannan continue; 1269b6f617dfSSaravana Kannan } 1270b6f617dfSSaravana Kannan WRITE_ONCE(link->status, DL_STATE_CONSUMER_PROBE); 1271b6f617dfSSaravana Kannan } 1272b6f617dfSSaravana Kannan dev->links.status = DL_DEV_PROBING; 1273b6f617dfSSaravana Kannan 1274b6f617dfSSaravana Kannan device_links_write_unlock(); 1275b6f617dfSSaravana Kannan } 1276b6f617dfSSaravana Kannan 1277b6f617dfSSaravana Kannan /** 12789ed98953SRafael J. Wysocki * device_links_driver_bound - Update device links after probing its driver. 12799ed98953SRafael J. Wysocki * @dev: Device to update the links for. 12809ed98953SRafael J. Wysocki * 12819ed98953SRafael J. Wysocki * The probe has been successful, so update links from this device to any 12829ed98953SRafael J. Wysocki * consumers by changing their status to "available". 12839ed98953SRafael J. Wysocki * 12849ed98953SRafael J. Wysocki * Also change the status of @dev's links to suppliers to "active". 12859ed98953SRafael J. Wysocki * 1286515db266SRafael J. Wysocki * Links without the DL_FLAG_MANAGED flag set are ignored. 12879ed98953SRafael J. Wysocki */ 12889ed98953SRafael J. Wysocki void device_links_driver_bound(struct device *dev) 12899ed98953SRafael J. Wysocki { 129021c27f06SSaravana Kannan struct device_link *link, *ln; 129126e77708SSaravana Kannan LIST_HEAD(sync_list); 12929ed98953SRafael J. Wysocki 1293bcbbcfd5SSaravana Kannan /* 12949528e0d9SSaravana Kannan * If a device binds successfully, it's expected to have created all 1295bcbbcfd5SSaravana Kannan * the device links it needs to or make new device links as it needs 12969528e0d9SSaravana Kannan * them. So, fw_devlink no longer needs to create device links to any 12979528e0d9SSaravana Kannan * of the device's suppliers. 12989528e0d9SSaravana Kannan * 12993a2dbc51SSaravana Kannan * Also, if a child firmware node of this bound device is not added as a 13003a2dbc51SSaravana Kannan * device by now, assume it is never going to be added. Make this bound 13013a2dbc51SSaravana Kannan * device the fallback supplier to the dangling consumers of the child 13023a2dbc51SSaravana Kannan * firmware node because this bound device is probably implementing the 13033a2dbc51SSaravana Kannan * child firmware node functionality and we don't want the dangling 13043a2dbc51SSaravana Kannan * consumers to defer probe indefinitely waiting for a device for the 13053a2dbc51SSaravana Kannan * child firmware node. 1306bcbbcfd5SSaravana Kannan */ 13079528e0d9SSaravana Kannan if (dev->fwnode && dev->fwnode->dev == dev) { 13089528e0d9SSaravana Kannan struct fwnode_handle *child; 1309f9aa4606SSaravana Kannan fwnode_links_purge_suppliers(dev->fwnode); 13103a2dbc51SSaravana Kannan mutex_lock(&fwnode_link_lock); 13119528e0d9SSaravana Kannan fwnode_for_each_available_child_node(dev->fwnode, child) 13123a2dbc51SSaravana Kannan __fw_devlink_pickup_dangling_consumers(child, 13133a2dbc51SSaravana Kannan dev->fwnode); 13143a2dbc51SSaravana Kannan __fw_devlink_link_to_consumers(dev); 13153a2dbc51SSaravana Kannan mutex_unlock(&fwnode_link_lock); 13169528e0d9SSaravana Kannan } 1317da6d6475SSaravana Kannan device_remove_file(dev, &dev_attr_waiting_for_supplier); 1318bcbbcfd5SSaravana Kannan 13199ed98953SRafael J. Wysocki device_links_write_lock(); 13209ed98953SRafael J. Wysocki 13219ed98953SRafael J. Wysocki list_for_each_entry(link, &dev->links.consumers, s_node) { 1322515db266SRafael J. Wysocki if (!(link->flags & DL_FLAG_MANAGED)) 13239ed98953SRafael J. Wysocki continue; 13249ed98953SRafael J. Wysocki 132515cfb094SRafael J. Wysocki /* 132615cfb094SRafael J. Wysocki * Links created during consumer probe may be in the "consumer 132715cfb094SRafael J. Wysocki * probe" state to start with if the supplier is still probing 132815cfb094SRafael J. Wysocki * when they are created and they may become "active" if the 132915cfb094SRafael J. Wysocki * consumer probe returns first. Skip them here. 133015cfb094SRafael J. Wysocki */ 133115cfb094SRafael J. Wysocki if (link->status == DL_STATE_CONSUMER_PROBE || 133215cfb094SRafael J. Wysocki link->status == DL_STATE_ACTIVE) 133315cfb094SRafael J. Wysocki continue; 133415cfb094SRafael J. Wysocki 13359ed98953SRafael J. Wysocki WARN_ON(link->status != DL_STATE_DORMANT); 13369ed98953SRafael J. Wysocki WRITE_ONCE(link->status, DL_STATE_AVAILABLE); 1337e7dd4010SRafael J. Wysocki 1338e7dd4010SRafael J. Wysocki if (link->flags & DL_FLAG_AUTOPROBE_CONSUMER) 1339e7dd4010SRafael J. Wysocki driver_deferred_probe_add(link->consumer); 13409ed98953SRafael J. Wysocki } 13419ed98953SRafael J. Wysocki 134221eb93f4SSaravana Kannan if (defer_sync_state_count) 134321eb93f4SSaravana Kannan __device_links_supplier_defer_sync(dev); 134421eb93f4SSaravana Kannan else 134521eb93f4SSaravana Kannan __device_links_queue_sync_state(dev, &sync_list); 134621eb93f4SSaravana Kannan 134721c27f06SSaravana Kannan list_for_each_entry_safe(link, ln, &dev->links.suppliers, c_node) { 134821c27f06SSaravana Kannan struct device *supplier; 134921c27f06SSaravana Kannan 1350515db266SRafael J. Wysocki if (!(link->flags & DL_FLAG_MANAGED)) 13519ed98953SRafael J. Wysocki continue; 13529ed98953SRafael J. Wysocki 135321c27f06SSaravana Kannan supplier = link->supplier; 135421c27f06SSaravana Kannan if (link->flags & DL_FLAG_SYNC_STATE_ONLY) { 135521c27f06SSaravana Kannan /* 135621c27f06SSaravana Kannan * When DL_FLAG_SYNC_STATE_ONLY is set, it means no 135721c27f06SSaravana Kannan * other DL_MANAGED_LINK_FLAGS have been set. So, it's 135821c27f06SSaravana Kannan * save to drop the managed link completely. 135921c27f06SSaravana Kannan */ 136021c27f06SSaravana Kannan device_link_drop_managed(link); 13612f8c3ae8SSaravana Kannan } else if (dev_is_best_effort(dev) && 13622f8c3ae8SSaravana Kannan link->flags & DL_FLAG_INFERRED && 13632f8c3ae8SSaravana Kannan link->status != DL_STATE_CONSUMER_PROBE && 13642f8c3ae8SSaravana Kannan !link->supplier->can_match) { 13652f8c3ae8SSaravana Kannan /* 13662f8c3ae8SSaravana Kannan * When dev_is_best_effort() is true, we ignore device 13672f8c3ae8SSaravana Kannan * links to suppliers that don't have a driver. If the 13682f8c3ae8SSaravana Kannan * consumer device still managed to probe, there's no 13692f8c3ae8SSaravana Kannan * point in maintaining a device link in a weird state 13702f8c3ae8SSaravana Kannan * (consumer probed before supplier). So delete it. 13712f8c3ae8SSaravana Kannan */ 13722f8c3ae8SSaravana Kannan device_link_drop_managed(link); 137321c27f06SSaravana Kannan } else { 13749ed98953SRafael J. Wysocki WARN_ON(link->status != DL_STATE_CONSUMER_PROBE); 13759ed98953SRafael J. Wysocki WRITE_ONCE(link->status, DL_STATE_ACTIVE); 137621c27f06SSaravana Kannan } 1377fc5a251dSSaravana Kannan 137821c27f06SSaravana Kannan /* 137921c27f06SSaravana Kannan * This needs to be done even for the deleted 138021c27f06SSaravana Kannan * DL_FLAG_SYNC_STATE_ONLY device link in case it was the last 138121c27f06SSaravana Kannan * device link that was preventing the supplier from getting a 138221c27f06SSaravana Kannan * sync_state() call. 138321c27f06SSaravana Kannan */ 1384fc5a251dSSaravana Kannan if (defer_sync_state_count) 138521c27f06SSaravana Kannan __device_links_supplier_defer_sync(supplier); 1386fc5a251dSSaravana Kannan else 138721c27f06SSaravana Kannan __device_links_queue_sync_state(supplier, &sync_list); 13889ed98953SRafael J. Wysocki } 13899ed98953SRafael J. Wysocki 13909ed98953SRafael J. Wysocki dev->links.status = DL_DEV_DRIVER_BOUND; 13919ed98953SRafael J. Wysocki 13929ed98953SRafael J. Wysocki device_links_write_unlock(); 139326e77708SSaravana Kannan 139421eb93f4SSaravana Kannan device_links_flush_sync_list(&sync_list, dev); 13959ed98953SRafael J. Wysocki } 13969ed98953SRafael J. Wysocki 13979ed98953SRafael J. Wysocki /** 13989ed98953SRafael J. Wysocki * __device_links_no_driver - Update links of a device without a driver. 13999ed98953SRafael J. Wysocki * @dev: Device without a drvier. 14009ed98953SRafael J. Wysocki * 14019ed98953SRafael J. Wysocki * Delete all non-persistent links from this device to any suppliers. 14029ed98953SRafael J. Wysocki * 14039ed98953SRafael J. Wysocki * Persistent links stay around, but their status is changed to "available", 14049ed98953SRafael J. Wysocki * unless they already are in the "supplier unbind in progress" state in which 14059ed98953SRafael J. Wysocki * case they need not be updated. 14069ed98953SRafael J. Wysocki * 1407515db266SRafael J. Wysocki * Links without the DL_FLAG_MANAGED flag set are ignored. 14089ed98953SRafael J. Wysocki */ 14099ed98953SRafael J. Wysocki static void __device_links_no_driver(struct device *dev) 14109ed98953SRafael J. Wysocki { 14119ed98953SRafael J. Wysocki struct device_link *link, *ln; 14129ed98953SRafael J. Wysocki 14139ed98953SRafael J. Wysocki list_for_each_entry_safe_reverse(link, ln, &dev->links.suppliers, c_node) { 1414515db266SRafael J. Wysocki if (!(link->flags & DL_FLAG_MANAGED)) 14159ed98953SRafael J. Wysocki continue; 14169ed98953SRafael J. Wysocki 14178c3e315dSSaravana Kannan if (link->flags & DL_FLAG_AUTOREMOVE_CONSUMER) { 1418515db266SRafael J. Wysocki device_link_drop_managed(link); 14198c3e315dSSaravana Kannan continue; 14208c3e315dSSaravana Kannan } 14218c3e315dSSaravana Kannan 14228c3e315dSSaravana Kannan if (link->status != DL_STATE_CONSUMER_PROBE && 14238c3e315dSSaravana Kannan link->status != DL_STATE_ACTIVE) 14248c3e315dSSaravana Kannan continue; 14258c3e315dSSaravana Kannan 14268c3e315dSSaravana Kannan if (link->supplier->links.status == DL_DEV_DRIVER_BOUND) { 14279ed98953SRafael J. Wysocki WRITE_ONCE(link->status, DL_STATE_AVAILABLE); 14288c3e315dSSaravana Kannan } else { 14298c3e315dSSaravana Kannan WARN_ON(!(link->flags & DL_FLAG_SYNC_STATE_ONLY)); 14308c3e315dSSaravana Kannan WRITE_ONCE(link->status, DL_STATE_DORMANT); 14318c3e315dSSaravana Kannan } 14329ed98953SRafael J. Wysocki } 14339ed98953SRafael J. Wysocki 14349ed98953SRafael J. Wysocki dev->links.status = DL_DEV_NO_DRIVER; 14359ed98953SRafael J. Wysocki } 14369ed98953SRafael J. Wysocki 143715cfb094SRafael J. Wysocki /** 143815cfb094SRafael J. Wysocki * device_links_no_driver - Update links after failing driver probe. 143915cfb094SRafael J. Wysocki * @dev: Device whose driver has just failed to probe. 144015cfb094SRafael J. Wysocki * 144115cfb094SRafael J. Wysocki * Clean up leftover links to consumers for @dev and invoke 144215cfb094SRafael J. Wysocki * %__device_links_no_driver() to update links to suppliers for it as 144315cfb094SRafael J. Wysocki * appropriate. 144415cfb094SRafael J. Wysocki * 1445515db266SRafael J. Wysocki * Links without the DL_FLAG_MANAGED flag set are ignored. 144615cfb094SRafael J. Wysocki */ 14479ed98953SRafael J. Wysocki void device_links_no_driver(struct device *dev) 14489ed98953SRafael J. Wysocki { 144915cfb094SRafael J. Wysocki struct device_link *link; 145015cfb094SRafael J. Wysocki 14519ed98953SRafael J. Wysocki device_links_write_lock(); 145215cfb094SRafael J. Wysocki 145315cfb094SRafael J. Wysocki list_for_each_entry(link, &dev->links.consumers, s_node) { 1454515db266SRafael J. Wysocki if (!(link->flags & DL_FLAG_MANAGED)) 145515cfb094SRafael J. Wysocki continue; 145615cfb094SRafael J. Wysocki 145715cfb094SRafael J. Wysocki /* 145815cfb094SRafael J. Wysocki * The probe has failed, so if the status of the link is 145915cfb094SRafael J. Wysocki * "consumer probe" or "active", it must have been added by 146015cfb094SRafael J. Wysocki * a probing consumer while this device was still probing. 146115cfb094SRafael J. Wysocki * Change its state to "dormant", as it represents a valid 146215cfb094SRafael J. Wysocki * relationship, but it is not functionally meaningful. 146315cfb094SRafael J. Wysocki */ 146415cfb094SRafael J. Wysocki if (link->status == DL_STATE_CONSUMER_PROBE || 146515cfb094SRafael J. Wysocki link->status == DL_STATE_ACTIVE) 146615cfb094SRafael J. Wysocki WRITE_ONCE(link->status, DL_STATE_DORMANT); 146715cfb094SRafael J. Wysocki } 146815cfb094SRafael J. Wysocki 14699ed98953SRafael J. Wysocki __device_links_no_driver(dev); 147015cfb094SRafael J. Wysocki 14719ed98953SRafael J. Wysocki device_links_write_unlock(); 14729ed98953SRafael J. Wysocki } 14739ed98953SRafael J. Wysocki 14749ed98953SRafael J. Wysocki /** 14759ed98953SRafael J. Wysocki * device_links_driver_cleanup - Update links after driver removal. 14769ed98953SRafael J. Wysocki * @dev: Device whose driver has just gone away. 14779ed98953SRafael J. Wysocki * 14789ed98953SRafael J. Wysocki * Update links to consumers for @dev by changing their status to "dormant" and 14799ed98953SRafael J. Wysocki * invoke %__device_links_no_driver() to update links to suppliers for it as 14809ed98953SRafael J. Wysocki * appropriate. 14819ed98953SRafael J. Wysocki * 1482515db266SRafael J. Wysocki * Links without the DL_FLAG_MANAGED flag set are ignored. 14839ed98953SRafael J. Wysocki */ 14849ed98953SRafael J. Wysocki void device_links_driver_cleanup(struct device *dev) 14859ed98953SRafael J. Wysocki { 1486c8d50986SRafael J. Wysocki struct device_link *link, *ln; 14879ed98953SRafael J. Wysocki 14889ed98953SRafael J. Wysocki device_links_write_lock(); 14899ed98953SRafael J. Wysocki 1490c8d50986SRafael J. Wysocki list_for_each_entry_safe(link, ln, &dev->links.consumers, s_node) { 1491515db266SRafael J. Wysocki if (!(link->flags & DL_FLAG_MANAGED)) 14929ed98953SRafael J. Wysocki continue; 14939ed98953SRafael J. Wysocki 1494e88728f4SVivek Gautam WARN_ON(link->flags & DL_FLAG_AUTOREMOVE_CONSUMER); 14959ed98953SRafael J. Wysocki WARN_ON(link->status != DL_STATE_SUPPLIER_UNBIND); 14961689cac5SVivek Gautam 14971689cac5SVivek Gautam /* 14981689cac5SVivek Gautam * autoremove the links between this @dev and its consumer 14991689cac5SVivek Gautam * devices that are not active, i.e. where the link state 15001689cac5SVivek Gautam * has moved to DL_STATE_SUPPLIER_UNBIND. 15011689cac5SVivek Gautam */ 15021689cac5SVivek Gautam if (link->status == DL_STATE_SUPPLIER_UNBIND && 15031689cac5SVivek Gautam link->flags & DL_FLAG_AUTOREMOVE_SUPPLIER) 1504515db266SRafael J. Wysocki device_link_drop_managed(link); 15051689cac5SVivek Gautam 15069ed98953SRafael J. Wysocki WRITE_ONCE(link->status, DL_STATE_DORMANT); 15079ed98953SRafael J. Wysocki } 15089ed98953SRafael J. Wysocki 15093b052a3eSSaravana Kannan list_del_init(&dev->links.defer_sync); 15109ed98953SRafael J. Wysocki __device_links_no_driver(dev); 15119ed98953SRafael J. Wysocki 15129ed98953SRafael J. Wysocki device_links_write_unlock(); 15139ed98953SRafael J. Wysocki } 15149ed98953SRafael J. Wysocki 15159ed98953SRafael J. Wysocki /** 15169ed98953SRafael J. Wysocki * device_links_busy - Check if there are any busy links to consumers. 15179ed98953SRafael J. Wysocki * @dev: Device to check. 15189ed98953SRafael J. Wysocki * 15199ed98953SRafael J. Wysocki * Check each consumer of the device and return 'true' if its link's status 15209ed98953SRafael J. Wysocki * is one of "consumer probe" or "active" (meaning that the given consumer is 15219ed98953SRafael J. Wysocki * probing right now or its driver is present). Otherwise, change the link 15229ed98953SRafael J. Wysocki * state to "supplier unbind" to prevent the consumer from being probed 15239ed98953SRafael J. Wysocki * successfully going forward. 15249ed98953SRafael J. Wysocki * 15259ed98953SRafael J. Wysocki * Return 'false' if there are no probing or active consumers. 15269ed98953SRafael J. Wysocki * 1527515db266SRafael J. Wysocki * Links without the DL_FLAG_MANAGED flag set are ignored. 15289ed98953SRafael J. Wysocki */ 15299ed98953SRafael J. Wysocki bool device_links_busy(struct device *dev) 15309ed98953SRafael J. Wysocki { 15319ed98953SRafael J. Wysocki struct device_link *link; 15329ed98953SRafael J. Wysocki bool ret = false; 15339ed98953SRafael J. Wysocki 15349ed98953SRafael J. Wysocki device_links_write_lock(); 15359ed98953SRafael J. Wysocki 15369ed98953SRafael J. Wysocki list_for_each_entry(link, &dev->links.consumers, s_node) { 1537515db266SRafael J. Wysocki if (!(link->flags & DL_FLAG_MANAGED)) 15389ed98953SRafael J. Wysocki continue; 15399ed98953SRafael J. Wysocki 15409ed98953SRafael J. Wysocki if (link->status == DL_STATE_CONSUMER_PROBE 15419ed98953SRafael J. Wysocki || link->status == DL_STATE_ACTIVE) { 15429ed98953SRafael J. Wysocki ret = true; 15439ed98953SRafael J. Wysocki break; 15449ed98953SRafael J. Wysocki } 15459ed98953SRafael J. Wysocki WRITE_ONCE(link->status, DL_STATE_SUPPLIER_UNBIND); 15469ed98953SRafael J. Wysocki } 15479ed98953SRafael J. Wysocki 15489ed98953SRafael J. Wysocki dev->links.status = DL_DEV_UNBINDING; 15499ed98953SRafael J. Wysocki 15509ed98953SRafael J. Wysocki device_links_write_unlock(); 15519ed98953SRafael J. Wysocki return ret; 15529ed98953SRafael J. Wysocki } 15539ed98953SRafael J. Wysocki 15549ed98953SRafael J. Wysocki /** 15559ed98953SRafael J. Wysocki * device_links_unbind_consumers - Force unbind consumers of the given device. 15569ed98953SRafael J. Wysocki * @dev: Device to unbind the consumers of. 15579ed98953SRafael J. Wysocki * 15589ed98953SRafael J. Wysocki * Walk the list of links to consumers for @dev and if any of them is in the 15599ed98953SRafael J. Wysocki * "consumer probe" state, wait for all device probes in progress to complete 15609ed98953SRafael J. Wysocki * and start over. 15619ed98953SRafael J. Wysocki * 15629ed98953SRafael J. Wysocki * If that's not the case, change the status of the link to "supplier unbind" 15639ed98953SRafael J. Wysocki * and check if the link was in the "active" state. If so, force the consumer 15649ed98953SRafael J. Wysocki * driver to unbind and start over (the consumer will not re-probe as we have 15659ed98953SRafael J. Wysocki * changed the state of the link already). 15669ed98953SRafael J. Wysocki * 1567515db266SRafael J. Wysocki * Links without the DL_FLAG_MANAGED flag set are ignored. 15689ed98953SRafael J. Wysocki */ 15699ed98953SRafael J. Wysocki void device_links_unbind_consumers(struct device *dev) 15709ed98953SRafael J. Wysocki { 15719ed98953SRafael J. Wysocki struct device_link *link; 15729ed98953SRafael J. Wysocki 15739ed98953SRafael J. Wysocki start: 15749ed98953SRafael J. Wysocki device_links_write_lock(); 15759ed98953SRafael J. Wysocki 15769ed98953SRafael J. Wysocki list_for_each_entry(link, &dev->links.consumers, s_node) { 15779ed98953SRafael J. Wysocki enum device_link_state status; 15789ed98953SRafael J. Wysocki 157905ef983eSSaravana Kannan if (!(link->flags & DL_FLAG_MANAGED) || 158005ef983eSSaravana Kannan link->flags & DL_FLAG_SYNC_STATE_ONLY) 15819ed98953SRafael J. Wysocki continue; 15829ed98953SRafael J. Wysocki 15839ed98953SRafael J. Wysocki status = link->status; 15849ed98953SRafael J. Wysocki if (status == DL_STATE_CONSUMER_PROBE) { 15859ed98953SRafael J. Wysocki device_links_write_unlock(); 15869ed98953SRafael J. Wysocki 15879ed98953SRafael J. Wysocki wait_for_device_probe(); 15889ed98953SRafael J. Wysocki goto start; 15899ed98953SRafael J. Wysocki } 15909ed98953SRafael J. Wysocki WRITE_ONCE(link->status, DL_STATE_SUPPLIER_UNBIND); 15919ed98953SRafael J. Wysocki if (status == DL_STATE_ACTIVE) { 15929ed98953SRafael J. Wysocki struct device *consumer = link->consumer; 15939ed98953SRafael J. Wysocki 15949ed98953SRafael J. Wysocki get_device(consumer); 15959ed98953SRafael J. Wysocki 15969ed98953SRafael J. Wysocki device_links_write_unlock(); 15979ed98953SRafael J. Wysocki 15989ed98953SRafael J. Wysocki device_release_driver_internal(consumer, NULL, 15999ed98953SRafael J. Wysocki consumer->parent); 16009ed98953SRafael J. Wysocki put_device(consumer); 16019ed98953SRafael J. Wysocki goto start; 16029ed98953SRafael J. Wysocki } 16039ed98953SRafael J. Wysocki } 16049ed98953SRafael J. Wysocki 16059ed98953SRafael J. Wysocki device_links_write_unlock(); 16069ed98953SRafael J. Wysocki } 16079ed98953SRafael J. Wysocki 16089ed98953SRafael J. Wysocki /** 16099ed98953SRafael J. Wysocki * device_links_purge - Delete existing links to other devices. 16109ed98953SRafael J. Wysocki * @dev: Target device. 16119ed98953SRafael J. Wysocki */ 16129ed98953SRafael J. Wysocki static void device_links_purge(struct device *dev) 16139ed98953SRafael J. Wysocki { 16149ed98953SRafael J. Wysocki struct device_link *link, *ln; 16159ed98953SRafael J. Wysocki 1616287905e6SSaravana Kannan if (dev->class == &devlink_class) 1617287905e6SSaravana Kannan return; 1618287905e6SSaravana Kannan 16199ed98953SRafael J. Wysocki /* 16209ed98953SRafael J. Wysocki * Delete all of the remaining links from this device to any other 16219ed98953SRafael J. Wysocki * devices (either consumers or suppliers). 16229ed98953SRafael J. Wysocki */ 16239ed98953SRafael J. Wysocki device_links_write_lock(); 16249ed98953SRafael J. Wysocki 16259ed98953SRafael J. Wysocki list_for_each_entry_safe_reverse(link, ln, &dev->links.suppliers, c_node) { 16269ed98953SRafael J. Wysocki WARN_ON(link->status == DL_STATE_ACTIVE); 1627ead18c23SLukas Wunner __device_link_del(&link->kref); 16289ed98953SRafael J. Wysocki } 16299ed98953SRafael J. Wysocki 16309ed98953SRafael J. Wysocki list_for_each_entry_safe_reverse(link, ln, &dev->links.consumers, s_node) { 16319ed98953SRafael J. Wysocki WARN_ON(link->status != DL_STATE_DORMANT && 16329ed98953SRafael J. Wysocki link->status != DL_STATE_NONE); 1633ead18c23SLukas Wunner __device_link_del(&link->kref); 16349ed98953SRafael J. Wysocki } 16359ed98953SRafael J. Wysocki 16369ed98953SRafael J. Wysocki device_links_write_unlock(); 16379ed98953SRafael J. Wysocki } 16389ed98953SRafael J. Wysocki 1639b90fb8f6SSaravana Kannan #define FW_DEVLINK_FLAGS_PERMISSIVE (DL_FLAG_INFERRED | \ 1640b90fb8f6SSaravana Kannan DL_FLAG_SYNC_STATE_ONLY) 1641b90fb8f6SSaravana Kannan #define FW_DEVLINK_FLAGS_ON (DL_FLAG_INFERRED | \ 1642b90fb8f6SSaravana Kannan DL_FLAG_AUTOPROBE_CONSUMER) 1643b90fb8f6SSaravana Kannan #define FW_DEVLINK_FLAGS_RPM (FW_DEVLINK_FLAGS_ON | \ 1644b90fb8f6SSaravana Kannan DL_FLAG_PM_RUNTIME) 1645b90fb8f6SSaravana Kannan 1646ea718c69SSaravana Kannan static u32 fw_devlink_flags = FW_DEVLINK_FLAGS_ON; 164742926ac3SSaravana Kannan static int __init fw_devlink_setup(char *arg) 164842926ac3SSaravana Kannan { 164942926ac3SSaravana Kannan if (!arg) 165042926ac3SSaravana Kannan return -EINVAL; 165142926ac3SSaravana Kannan 165242926ac3SSaravana Kannan if (strcmp(arg, "off") == 0) { 165342926ac3SSaravana Kannan fw_devlink_flags = 0; 165442926ac3SSaravana Kannan } else if (strcmp(arg, "permissive") == 0) { 1655b90fb8f6SSaravana Kannan fw_devlink_flags = FW_DEVLINK_FLAGS_PERMISSIVE; 165642926ac3SSaravana Kannan } else if (strcmp(arg, "on") == 0) { 1657b90fb8f6SSaravana Kannan fw_devlink_flags = FW_DEVLINK_FLAGS_ON; 165842926ac3SSaravana Kannan } else if (strcmp(arg, "rpm") == 0) { 1659b90fb8f6SSaravana Kannan fw_devlink_flags = FW_DEVLINK_FLAGS_RPM; 166042926ac3SSaravana Kannan } 166142926ac3SSaravana Kannan return 0; 166242926ac3SSaravana Kannan } 166342926ac3SSaravana Kannan early_param("fw_devlink", fw_devlink_setup); 166442926ac3SSaravana Kannan 1665d8ab4685SGreg Kroah-Hartman static bool fw_devlink_strict; 166619d0f5f6SSaravana Kannan static int __init fw_devlink_strict_setup(char *arg) 166719d0f5f6SSaravana Kannan { 166873060022SChristophe JAILLET return kstrtobool(arg, &fw_devlink_strict); 166919d0f5f6SSaravana Kannan } 167019d0f5f6SSaravana Kannan early_param("fw_devlink.strict", fw_devlink_strict_setup); 167119d0f5f6SSaravana Kannan 1672ffbe08a8SSaravana Kannan #define FW_DEVLINK_SYNC_STATE_STRICT 0 1673ffbe08a8SSaravana Kannan #define FW_DEVLINK_SYNC_STATE_TIMEOUT 1 1674ffbe08a8SSaravana Kannan 1675ffbe08a8SSaravana Kannan static int fw_devlink_sync_state; 1676ffbe08a8SSaravana Kannan static int __init fw_devlink_sync_state_setup(char *arg) 1677ffbe08a8SSaravana Kannan { 1678ffbe08a8SSaravana Kannan if (!arg) 1679ffbe08a8SSaravana Kannan return -EINVAL; 1680ffbe08a8SSaravana Kannan 1681ffbe08a8SSaravana Kannan if (strcmp(arg, "strict") == 0) { 1682ffbe08a8SSaravana Kannan fw_devlink_sync_state = FW_DEVLINK_SYNC_STATE_STRICT; 1683ffbe08a8SSaravana Kannan return 0; 1684ffbe08a8SSaravana Kannan } else if (strcmp(arg, "timeout") == 0) { 1685ffbe08a8SSaravana Kannan fw_devlink_sync_state = FW_DEVLINK_SYNC_STATE_TIMEOUT; 1686ffbe08a8SSaravana Kannan return 0; 1687ffbe08a8SSaravana Kannan } 1688ffbe08a8SSaravana Kannan return -EINVAL; 1689ffbe08a8SSaravana Kannan } 1690ffbe08a8SSaravana Kannan early_param("fw_devlink.sync_state", fw_devlink_sync_state_setup); 1691ffbe08a8SSaravana Kannan 1692cd115c04SSaravana Kannan static inline u32 fw_devlink_get_flags(u8 fwlink_flags) 169342926ac3SSaravana Kannan { 1694cd115c04SSaravana Kannan if (fwlink_flags & FWLINK_FLAG_CYCLE) 1695cd115c04SSaravana Kannan return FW_DEVLINK_FLAGS_PERMISSIVE | DL_FLAG_CYCLE; 1696cd115c04SSaravana Kannan 169742926ac3SSaravana Kannan return fw_devlink_flags; 169842926ac3SSaravana Kannan } 169942926ac3SSaravana Kannan 170042926ac3SSaravana Kannan static bool fw_devlink_is_permissive(void) 170142926ac3SSaravana Kannan { 1702b90fb8f6SSaravana Kannan return fw_devlink_flags == FW_DEVLINK_FLAGS_PERMISSIVE; 170342926ac3SSaravana Kannan } 170442926ac3SSaravana Kannan 170519d0f5f6SSaravana Kannan bool fw_devlink_is_strict(void) 170619d0f5f6SSaravana Kannan { 170719d0f5f6SSaravana Kannan return fw_devlink_strict && !fw_devlink_is_permissive(); 17089ed98953SRafael J. Wysocki } 17099ed98953SRafael J. Wysocki 1710c2c724c8SSaravana Kannan static void fw_devlink_parse_fwnode(struct fwnode_handle *fwnode) 1711c2c724c8SSaravana Kannan { 1712c2c724c8SSaravana Kannan if (fwnode->flags & FWNODE_FLAG_LINKS_ADDED) 1713c2c724c8SSaravana Kannan return; 1714c2c724c8SSaravana Kannan 17152d09e6ebSSaravana Kannan fwnode_call_int_op(fwnode, add_links); 1716c2c724c8SSaravana Kannan fwnode->flags |= FWNODE_FLAG_LINKS_ADDED; 1717c2c724c8SSaravana Kannan } 1718c2c724c8SSaravana Kannan 1719c2c724c8SSaravana Kannan static void fw_devlink_parse_fwtree(struct fwnode_handle *fwnode) 1720c2c724c8SSaravana Kannan { 1721c2c724c8SSaravana Kannan struct fwnode_handle *child = NULL; 1722c2c724c8SSaravana Kannan 1723c2c724c8SSaravana Kannan fw_devlink_parse_fwnode(fwnode); 1724c2c724c8SSaravana Kannan 1725c2c724c8SSaravana Kannan while ((child = fwnode_get_next_available_child_node(fwnode, child))) 1726c2c724c8SSaravana Kannan fw_devlink_parse_fwtree(child); 1727c2c724c8SSaravana Kannan } 1728c2c724c8SSaravana Kannan 1729d46f3e3eSSaravana Kannan static void fw_devlink_relax_link(struct device_link *link) 1730d46f3e3eSSaravana Kannan { 1731d46f3e3eSSaravana Kannan if (!(link->flags & DL_FLAG_INFERRED)) 1732d46f3e3eSSaravana Kannan return; 1733d46f3e3eSSaravana Kannan 173467cad5c6SSaravana Kannan if (device_link_flag_is_sync_state_only(link->flags)) 1735d46f3e3eSSaravana Kannan return; 1736d46f3e3eSSaravana Kannan 1737d46f3e3eSSaravana Kannan pm_runtime_drop_link(link); 1738d46f3e3eSSaravana Kannan link->flags = DL_FLAG_MANAGED | FW_DEVLINK_FLAGS_PERMISSIVE; 1739d46f3e3eSSaravana Kannan dev_dbg(link->consumer, "Relaxing link with %s\n", 1740d46f3e3eSSaravana Kannan dev_name(link->supplier)); 1741d46f3e3eSSaravana Kannan } 1742d46f3e3eSSaravana Kannan 1743d46f3e3eSSaravana Kannan static int fw_devlink_no_driver(struct device *dev, void *data) 1744d46f3e3eSSaravana Kannan { 1745d46f3e3eSSaravana Kannan struct device_link *link = to_devlink(dev); 1746d46f3e3eSSaravana Kannan 1747d46f3e3eSSaravana Kannan if (!link->supplier->can_match) 1748d46f3e3eSSaravana Kannan fw_devlink_relax_link(link); 1749d46f3e3eSSaravana Kannan 1750d46f3e3eSSaravana Kannan return 0; 1751d46f3e3eSSaravana Kannan } 1752d46f3e3eSSaravana Kannan 1753d46f3e3eSSaravana Kannan void fw_devlink_drivers_done(void) 1754d46f3e3eSSaravana Kannan { 1755d46f3e3eSSaravana Kannan fw_devlink_drv_reg_done = true; 1756d46f3e3eSSaravana Kannan device_links_write_lock(); 1757d46f3e3eSSaravana Kannan class_for_each_device(&devlink_class, NULL, NULL, 1758d46f3e3eSSaravana Kannan fw_devlink_no_driver); 1759d46f3e3eSSaravana Kannan device_links_write_unlock(); 1760d46f3e3eSSaravana Kannan } 1761d46f3e3eSSaravana Kannan 1762ffbe08a8SSaravana Kannan static int fw_devlink_dev_sync_state(struct device *dev, void *data) 1763ffbe08a8SSaravana Kannan { 1764ffbe08a8SSaravana Kannan struct device_link *link = to_devlink(dev); 1765ffbe08a8SSaravana Kannan struct device *sup = link->supplier; 1766ffbe08a8SSaravana Kannan 1767ffbe08a8SSaravana Kannan if (!(link->flags & DL_FLAG_MANAGED) || 1768ffbe08a8SSaravana Kannan link->status == DL_STATE_ACTIVE || sup->state_synced || 1769ffbe08a8SSaravana Kannan !dev_has_sync_state(sup)) 1770ffbe08a8SSaravana Kannan return 0; 1771ffbe08a8SSaravana Kannan 1772ffbe08a8SSaravana Kannan if (fw_devlink_sync_state == FW_DEVLINK_SYNC_STATE_STRICT) { 1773ffbe08a8SSaravana Kannan dev_warn(sup, "sync_state() pending due to %s\n", 1774ffbe08a8SSaravana Kannan dev_name(link->consumer)); 1775ffbe08a8SSaravana Kannan return 0; 1776ffbe08a8SSaravana Kannan } 1777ffbe08a8SSaravana Kannan 1778ffbe08a8SSaravana Kannan if (!list_empty(&sup->links.defer_sync)) 1779ffbe08a8SSaravana Kannan return 0; 1780ffbe08a8SSaravana Kannan 1781ffbe08a8SSaravana Kannan dev_warn(sup, "Timed out. Forcing sync_state()\n"); 1782ffbe08a8SSaravana Kannan sup->state_synced = true; 1783ffbe08a8SSaravana Kannan get_device(sup); 1784ffbe08a8SSaravana Kannan list_add_tail(&sup->links.defer_sync, data); 1785ffbe08a8SSaravana Kannan 1786ffbe08a8SSaravana Kannan return 0; 1787ffbe08a8SSaravana Kannan } 1788ffbe08a8SSaravana Kannan 1789ffbe08a8SSaravana Kannan void fw_devlink_probing_done(void) 1790ffbe08a8SSaravana Kannan { 1791ffbe08a8SSaravana Kannan LIST_HEAD(sync_list); 1792ffbe08a8SSaravana Kannan 1793ffbe08a8SSaravana Kannan device_links_write_lock(); 1794ffbe08a8SSaravana Kannan class_for_each_device(&devlink_class, NULL, &sync_list, 1795ffbe08a8SSaravana Kannan fw_devlink_dev_sync_state); 1796ffbe08a8SSaravana Kannan device_links_write_unlock(); 1797ffbe08a8SSaravana Kannan device_links_flush_sync_list(&sync_list, NULL); 1798ffbe08a8SSaravana Kannan } 1799ffbe08a8SSaravana Kannan 18002f8c3ae8SSaravana Kannan /** 18012f8c3ae8SSaravana Kannan * wait_for_init_devices_probe - Try to probe any device needed for init 18022f8c3ae8SSaravana Kannan * 18032f8c3ae8SSaravana Kannan * Some devices might need to be probed and bound successfully before the kernel 18042f8c3ae8SSaravana Kannan * boot sequence can finish and move on to init/userspace. For example, a 18052f8c3ae8SSaravana Kannan * network interface might need to be bound to be able to mount a NFS rootfs. 18062f8c3ae8SSaravana Kannan * 18072f8c3ae8SSaravana Kannan * With fw_devlink=on by default, some of these devices might be blocked from 18082f8c3ae8SSaravana Kannan * probing because they are waiting on a optional supplier that doesn't have a 18092f8c3ae8SSaravana Kannan * driver. While fw_devlink will eventually identify such devices and unblock 18102f8c3ae8SSaravana Kannan * the probing automatically, it might be too late by the time it unblocks the 18112f8c3ae8SSaravana Kannan * probing of devices. For example, the IP4 autoconfig might timeout before 18122f8c3ae8SSaravana Kannan * fw_devlink unblocks probing of the network interface. 18132f8c3ae8SSaravana Kannan * 18142f8c3ae8SSaravana Kannan * This function is available to temporarily try and probe all devices that have 18152f8c3ae8SSaravana Kannan * a driver even if some of their suppliers haven't been added or don't have 18162f8c3ae8SSaravana Kannan * drivers. 18172f8c3ae8SSaravana Kannan * 18182f8c3ae8SSaravana Kannan * The drivers can then decide which of the suppliers are optional vs mandatory 18192f8c3ae8SSaravana Kannan * and probe the device if possible. By the time this function returns, all such 18202f8c3ae8SSaravana Kannan * "best effort" probes are guaranteed to be completed. If a device successfully 18212f8c3ae8SSaravana Kannan * probes in this mode, we delete all fw_devlink discovered dependencies of that 18222f8c3ae8SSaravana Kannan * device where the supplier hasn't yet probed successfully because they have to 18232f8c3ae8SSaravana Kannan * be optional dependencies. 18242f8c3ae8SSaravana Kannan * 18252f8c3ae8SSaravana Kannan * Any devices that didn't successfully probe go back to being treated as if 18262f8c3ae8SSaravana Kannan * this function was never called. 18272f8c3ae8SSaravana Kannan * 18282f8c3ae8SSaravana Kannan * This also means that some devices that aren't needed for init and could have 18292f8c3ae8SSaravana Kannan * waited for their optional supplier to probe (when the supplier's module is 18302f8c3ae8SSaravana Kannan * loaded later on) would end up probing prematurely with limited functionality. 18312f8c3ae8SSaravana Kannan * So call this function only when boot would fail without it. 18322f8c3ae8SSaravana Kannan */ 18332f8c3ae8SSaravana Kannan void __init wait_for_init_devices_probe(void) 18342f8c3ae8SSaravana Kannan { 18352f8c3ae8SSaravana Kannan if (!fw_devlink_flags || fw_devlink_is_permissive()) 18362f8c3ae8SSaravana Kannan return; 18372f8c3ae8SSaravana Kannan 18382f8c3ae8SSaravana Kannan /* 18392f8c3ae8SSaravana Kannan * Wait for all ongoing probes to finish so that the "best effort" is 18402f8c3ae8SSaravana Kannan * only applied to devices that can't probe otherwise. 18412f8c3ae8SSaravana Kannan */ 18422f8c3ae8SSaravana Kannan wait_for_device_probe(); 18432f8c3ae8SSaravana Kannan 18442f8c3ae8SSaravana Kannan pr_info("Trying to probe devices needed for running init ...\n"); 18452f8c3ae8SSaravana Kannan fw_devlink_best_effort = true; 18462f8c3ae8SSaravana Kannan driver_deferred_probe_trigger(); 18472f8c3ae8SSaravana Kannan 18482f8c3ae8SSaravana Kannan /* 18492f8c3ae8SSaravana Kannan * Wait for all "best effort" probes to finish before going back to 18502f8c3ae8SSaravana Kannan * normal enforcement. 18512f8c3ae8SSaravana Kannan */ 18522f8c3ae8SSaravana Kannan wait_for_device_probe(); 18532f8c3ae8SSaravana Kannan fw_devlink_best_effort = false; 18542f8c3ae8SSaravana Kannan } 18552f8c3ae8SSaravana Kannan 1856d46f3e3eSSaravana Kannan static void fw_devlink_unblock_consumers(struct device *dev) 1857d46f3e3eSSaravana Kannan { 1858d46f3e3eSSaravana Kannan struct device_link *link; 1859d46f3e3eSSaravana Kannan 1860d46f3e3eSSaravana Kannan if (!fw_devlink_flags || fw_devlink_is_permissive()) 1861d46f3e3eSSaravana Kannan return; 1862d46f3e3eSSaravana Kannan 1863d46f3e3eSSaravana Kannan device_links_write_lock(); 1864d46f3e3eSSaravana Kannan list_for_each_entry(link, &dev->links.consumers, s_node) 1865d46f3e3eSSaravana Kannan fw_devlink_relax_link(link); 1866d46f3e3eSSaravana Kannan device_links_write_unlock(); 1867d46f3e3eSSaravana Kannan } 1868d46f3e3eSSaravana Kannan 1869b0e2fa4fSSaravana Kannan 1870411c0d58SSaravana Kannan static bool fwnode_init_without_drv(struct fwnode_handle *fwnode) 1871b0e2fa4fSSaravana Kannan { 1872411c0d58SSaravana Kannan struct device *dev; 1873411c0d58SSaravana Kannan bool ret; 1874b0e2fa4fSSaravana Kannan 1875411c0d58SSaravana Kannan if (!(fwnode->flags & FWNODE_FLAG_INITIALIZED)) 1876411c0d58SSaravana Kannan return false; 1877b0e2fa4fSSaravana Kannan 1878411c0d58SSaravana Kannan dev = get_dev_from_fwnode(fwnode); 1879411c0d58SSaravana Kannan ret = !dev || dev->links.status == DL_DEV_NO_DRIVER; 1880411c0d58SSaravana Kannan put_device(dev); 1881411c0d58SSaravana Kannan 1882b0e2fa4fSSaravana Kannan return ret; 1883b0e2fa4fSSaravana Kannan } 1884411c0d58SSaravana Kannan 1885411c0d58SSaravana Kannan static bool fwnode_ancestor_init_without_drv(struct fwnode_handle *fwnode) 1886411c0d58SSaravana Kannan { 1887411c0d58SSaravana Kannan struct fwnode_handle *parent; 1888411c0d58SSaravana Kannan 1889411c0d58SSaravana Kannan fwnode_for_each_parent_node(fwnode, parent) { 1890411c0d58SSaravana Kannan if (fwnode_init_without_drv(parent)) { 1891411c0d58SSaravana Kannan fwnode_handle_put(parent); 1892411c0d58SSaravana Kannan return true; 1893411c0d58SSaravana Kannan } 1894411c0d58SSaravana Kannan } 1895411c0d58SSaravana Kannan 1896411c0d58SSaravana Kannan return false; 1897411c0d58SSaravana Kannan } 1898411c0d58SSaravana Kannan 1899b0e2fa4fSSaravana Kannan /** 19003fb16866SSaravana Kannan * __fw_devlink_relax_cycles - Relax and mark dependency cycles. 19013fb16866SSaravana Kannan * @con: Potential consumer device. 19023fb16866SSaravana Kannan * @sup_handle: Potential supplier's fwnode. 19033fb16866SSaravana Kannan * 19043fb16866SSaravana Kannan * Needs to be called with fwnode_lock and device link lock held. 19053fb16866SSaravana Kannan * 19063fb16866SSaravana Kannan * Check if @sup_handle or any of its ancestors or suppliers direct/indirectly 19073fb16866SSaravana Kannan * depend on @con. This function can detect multiple cyles between @sup_handle 19083fb16866SSaravana Kannan * and @con. When such dependency cycles are found, convert all device links 19093fb16866SSaravana Kannan * created solely by fw_devlink into SYNC_STATE_ONLY device links. Also, mark 19103fb16866SSaravana Kannan * all fwnode links in the cycle with FWLINK_FLAG_CYCLE so that when they are 19113fb16866SSaravana Kannan * converted into a device link in the future, they are created as 19123fb16866SSaravana Kannan * SYNC_STATE_ONLY device links. This is the equivalent of doing 19133fb16866SSaravana Kannan * fw_devlink=permissive just between the devices in the cycle. We need to do 19143fb16866SSaravana Kannan * this because, at this point, fw_devlink can't tell which of these 19153fb16866SSaravana Kannan * dependencies is not a real dependency. 19163fb16866SSaravana Kannan * 19173fb16866SSaravana Kannan * Return true if one or more cycles were found. Otherwise, return false. 19183fb16866SSaravana Kannan */ 19193fb16866SSaravana Kannan static bool __fw_devlink_relax_cycles(struct device *con, 19203fb16866SSaravana Kannan struct fwnode_handle *sup_handle) 19213fb16866SSaravana Kannan { 19223fb16866SSaravana Kannan struct device *sup_dev = NULL, *par_dev = NULL; 19233fb16866SSaravana Kannan struct fwnode_link *link; 19243fb16866SSaravana Kannan struct device_link *dev_link; 19253fb16866SSaravana Kannan bool ret = false; 19263fb16866SSaravana Kannan 19273fb16866SSaravana Kannan if (!sup_handle) 19283fb16866SSaravana Kannan return false; 19293fb16866SSaravana Kannan 19303fb16866SSaravana Kannan /* 19313fb16866SSaravana Kannan * We aren't trying to find all cycles. Just a cycle between con and 19323fb16866SSaravana Kannan * sup_handle. 19333fb16866SSaravana Kannan */ 19343fb16866SSaravana Kannan if (sup_handle->flags & FWNODE_FLAG_VISITED) 19353fb16866SSaravana Kannan return false; 19363fb16866SSaravana Kannan 19373fb16866SSaravana Kannan sup_handle->flags |= FWNODE_FLAG_VISITED; 19383fb16866SSaravana Kannan 19393fb16866SSaravana Kannan sup_dev = get_dev_from_fwnode(sup_handle); 19403fb16866SSaravana Kannan 19413fb16866SSaravana Kannan /* Termination condition. */ 19423fb16866SSaravana Kannan if (sup_dev == con) { 19433fb16866SSaravana Kannan ret = true; 19443fb16866SSaravana Kannan goto out; 19453fb16866SSaravana Kannan } 19463fb16866SSaravana Kannan 19473fb16866SSaravana Kannan /* 19483fb16866SSaravana Kannan * If sup_dev is bound to a driver and @con hasn't started binding to a 19493fb16866SSaravana Kannan * driver, sup_dev can't be a consumer of @con. So, no need to check 19503fb16866SSaravana Kannan * further. 19513fb16866SSaravana Kannan */ 19523fb16866SSaravana Kannan if (sup_dev && sup_dev->links.status == DL_DEV_DRIVER_BOUND && 19533fb16866SSaravana Kannan con->links.status == DL_DEV_NO_DRIVER) { 19543fb16866SSaravana Kannan ret = false; 19553fb16866SSaravana Kannan goto out; 19563fb16866SSaravana Kannan } 19573fb16866SSaravana Kannan 19583fb16866SSaravana Kannan list_for_each_entry(link, &sup_handle->suppliers, c_hook) { 19593fb16866SSaravana Kannan if (__fw_devlink_relax_cycles(con, link->supplier)) { 19603fb16866SSaravana Kannan __fwnode_link_cycle(link); 19613fb16866SSaravana Kannan ret = true; 19623fb16866SSaravana Kannan } 19633fb16866SSaravana Kannan } 19643fb16866SSaravana Kannan 19653fb16866SSaravana Kannan /* 19663fb16866SSaravana Kannan * Give priority to device parent over fwnode parent to account for any 19673fb16866SSaravana Kannan * quirks in how fwnodes are converted to devices. 19683fb16866SSaravana Kannan */ 19693fb16866SSaravana Kannan if (sup_dev) 19703fb16866SSaravana Kannan par_dev = get_device(sup_dev->parent); 19713fb16866SSaravana Kannan else 19723fb16866SSaravana Kannan par_dev = fwnode_get_next_parent_dev(sup_handle); 19733fb16866SSaravana Kannan 19743fb16866SSaravana Kannan if (par_dev && __fw_devlink_relax_cycles(con, par_dev->fwnode)) 19753fb16866SSaravana Kannan ret = true; 19763fb16866SSaravana Kannan 19773fb16866SSaravana Kannan if (!sup_dev) 19783fb16866SSaravana Kannan goto out; 19793fb16866SSaravana Kannan 19803fb16866SSaravana Kannan list_for_each_entry(dev_link, &sup_dev->links.suppliers, c_node) { 19813fb16866SSaravana Kannan /* 19823fb16866SSaravana Kannan * Ignore a SYNC_STATE_ONLY flag only if it wasn't marked as 19833fb16866SSaravana Kannan * such due to a cycle. 19843fb16866SSaravana Kannan */ 19853fb16866SSaravana Kannan if (device_link_flag_is_sync_state_only(dev_link->flags) && 19863fb16866SSaravana Kannan !(dev_link->flags & DL_FLAG_CYCLE)) 19873fb16866SSaravana Kannan continue; 19883fb16866SSaravana Kannan 19893fb16866SSaravana Kannan if (__fw_devlink_relax_cycles(con, 19903fb16866SSaravana Kannan dev_link->supplier->fwnode)) { 19913fb16866SSaravana Kannan fw_devlink_relax_link(dev_link); 19923fb16866SSaravana Kannan dev_link->flags |= DL_FLAG_CYCLE; 19933fb16866SSaravana Kannan ret = true; 19943fb16866SSaravana Kannan } 19953fb16866SSaravana Kannan } 19963fb16866SSaravana Kannan 19973fb16866SSaravana Kannan out: 19983fb16866SSaravana Kannan sup_handle->flags &= ~FWNODE_FLAG_VISITED; 19993fb16866SSaravana Kannan put_device(sup_dev); 20003fb16866SSaravana Kannan put_device(par_dev); 20019ed98953SRafael J. Wysocki return ret; 20021da177e4SLinus Torvalds } 20031da177e4SLinus Torvalds 2004f9aa4606SSaravana Kannan /** 2005f9aa4606SSaravana Kannan * fw_devlink_create_devlink - Create a device link from a consumer to fwnode 200637c52f74SPierre-Louis Bossart * @con: consumer device for the device link 200737c52f74SPierre-Louis Bossart * @sup_handle: fwnode handle of supplier 2008cd115c04SSaravana Kannan * @link: fwnode link that's being converted to a device link 2009f9aa4606SSaravana Kannan * 2010f9aa4606SSaravana Kannan * This function will try to create a device link between the consumer device 2011f9aa4606SSaravana Kannan * @con and the supplier device represented by @sup_handle. 2012f9aa4606SSaravana Kannan * 2013f9aa4606SSaravana Kannan * The supplier has to be provided as a fwnode because incorrect cycles in 2014f9aa4606SSaravana Kannan * fwnode links can sometimes cause the supplier device to never be created. 2015f9aa4606SSaravana Kannan * This function detects such cases and returns an error if it cannot create a 2016f9aa4606SSaravana Kannan * device link from the consumer to a missing supplier. 2017f9aa4606SSaravana Kannan * 2018f9aa4606SSaravana Kannan * Returns, 2019f9aa4606SSaravana Kannan * 0 on successfully creating a device link 2020f9aa4606SSaravana Kannan * -EINVAL if the device link cannot be created as expected 2021f9aa4606SSaravana Kannan * -EAGAIN if the device link cannot be created right now, but it may be 2022f9aa4606SSaravana Kannan * possible to do that in the future 2023f9aa4606SSaravana Kannan */ 2024f9aa4606SSaravana Kannan static int fw_devlink_create_devlink(struct device *con, 2025cd115c04SSaravana Kannan struct fwnode_handle *sup_handle, 2026cd115c04SSaravana Kannan struct fwnode_link *link) 2027f9aa4606SSaravana Kannan { 2028f9aa4606SSaravana Kannan struct device *sup_dev; 2029f9aa4606SSaravana Kannan int ret = 0; 2030cd115c04SSaravana Kannan u32 flags; 2031cd115c04SSaravana Kannan 2032cd115c04SSaravana Kannan if (con->fwnode == link->consumer) 2033cd115c04SSaravana Kannan flags = fw_devlink_get_flags(link->flags); 2034cd115c04SSaravana Kannan else 2035cd115c04SSaravana Kannan flags = FW_DEVLINK_FLAGS_PERMISSIVE; 2036f9aa4606SSaravana Kannan 20375501765aSSaravana Kannan /* 20385501765aSSaravana Kannan * In some cases, a device P might also be a supplier to its child node 20395501765aSSaravana Kannan * C. However, this would defer the probe of C until the probe of P 20405501765aSSaravana Kannan * completes successfully. This is perfectly fine in the device driver 20415501765aSSaravana Kannan * model. device_add() doesn't guarantee probe completion of the device 20425501765aSSaravana Kannan * by the time it returns. 20435501765aSSaravana Kannan * 20445501765aSSaravana Kannan * However, there are a few drivers that assume C will finish probing 20455501765aSSaravana Kannan * as soon as it's added and before P finishes probing. So, we provide 20465501765aSSaravana Kannan * a flag to let fw_devlink know not to delay the probe of C until the 20475501765aSSaravana Kannan * probe of P completes successfully. 20485501765aSSaravana Kannan * 20495501765aSSaravana Kannan * When such a flag is set, we can't create device links where P is the 20505501765aSSaravana Kannan * supplier of C as that would delay the probe of C. 20515501765aSSaravana Kannan */ 20525501765aSSaravana Kannan if (sup_handle->flags & FWNODE_FLAG_NEEDS_CHILD_BOUND_ON_ADD && 20535501765aSSaravana Kannan fwnode_is_ancestor_of(sup_handle, con->fwnode)) 20545501765aSSaravana Kannan return -EINVAL; 20555501765aSSaravana Kannan 20563fb16866SSaravana Kannan /* 20573fb16866SSaravana Kannan * SYNC_STATE_ONLY device links don't block probing and supports cycles. 20583fb16866SSaravana Kannan * So cycle detection isn't necessary and shouldn't be done. 20593fb16866SSaravana Kannan */ 20603fb16866SSaravana Kannan if (!(flags & DL_FLAG_SYNC_STATE_ONLY)) { 20613fb16866SSaravana Kannan device_links_write_lock(); 20623fb16866SSaravana Kannan if (__fw_devlink_relax_cycles(con, sup_handle)) { 20633fb16866SSaravana Kannan __fwnode_link_cycle(link); 20643fb16866SSaravana Kannan flags = fw_devlink_get_flags(link->flags); 20653fb16866SSaravana Kannan dev_info(con, "Fixed dependency cycle(s) with %pfwf\n", 20663fb16866SSaravana Kannan sup_handle); 20673fb16866SSaravana Kannan } 20683fb16866SSaravana Kannan device_links_write_unlock(); 20693fb16866SSaravana Kannan } 20703fb16866SSaravana Kannan 20713a2dbc51SSaravana Kannan if (sup_handle->flags & FWNODE_FLAG_NOT_DEVICE) 20723a2dbc51SSaravana Kannan sup_dev = fwnode_get_next_parent_dev(sup_handle); 20733a2dbc51SSaravana Kannan else 2074f9aa4606SSaravana Kannan sup_dev = get_dev_from_fwnode(sup_handle); 20753a2dbc51SSaravana Kannan 2076f9aa4606SSaravana Kannan if (sup_dev) { 2077f9aa4606SSaravana Kannan /* 207874c782cfSSaravana Kannan * If it's one of those drivers that don't actually bind to 207974c782cfSSaravana Kannan * their device using driver core, then don't wait on this 208074c782cfSSaravana Kannan * supplier device indefinitely. 208174c782cfSSaravana Kannan */ 208274c782cfSSaravana Kannan if (sup_dev->links.status == DL_DEV_NO_DRIVER && 208374c782cfSSaravana Kannan sup_handle->flags & FWNODE_FLAG_INITIALIZED) { 20843fb16866SSaravana Kannan dev_dbg(con, 20853fb16866SSaravana Kannan "Not linking %pfwf - dev might never probe\n", 20863fb16866SSaravana Kannan sup_handle); 208774c782cfSSaravana Kannan ret = -EINVAL; 208874c782cfSSaravana Kannan goto out; 208974c782cfSSaravana Kannan } 209074c782cfSSaravana Kannan 209163098724SSaravana Kannan if (con != sup_dev && !device_link_add(con, sup_dev, flags)) { 209263098724SSaravana Kannan dev_err(con, "Failed to create device link (0x%x) with %s\n", 209363098724SSaravana Kannan flags, dev_name(sup_dev)); 2094f9aa4606SSaravana Kannan ret = -EINVAL; 2095b0e2fa4fSSaravana Kannan } 2096f9aa4606SSaravana Kannan 2097f9aa4606SSaravana Kannan goto out; 2098f9aa4606SSaravana Kannan } 2099f9aa4606SSaravana Kannan 2100411c0d58SSaravana Kannan /* 2101411c0d58SSaravana Kannan * Supplier or supplier's ancestor already initialized without a struct 2102411c0d58SSaravana Kannan * device or being probed by a driver. 2103411c0d58SSaravana Kannan */ 2104411c0d58SSaravana Kannan if (fwnode_init_without_drv(sup_handle) || 2105411c0d58SSaravana Kannan fwnode_ancestor_init_without_drv(sup_handle)) { 21063fb16866SSaravana Kannan dev_dbg(con, "Not linking %pfwf - might never become dev\n", 2107411c0d58SSaravana Kannan sup_handle); 210874c782cfSSaravana Kannan return -EINVAL; 2109f9aa4606SSaravana Kannan } 2110f9aa4606SSaravana Kannan 2111f9aa4606SSaravana Kannan ret = -EAGAIN; 2112f9aa4606SSaravana Kannan out: 2113f9aa4606SSaravana Kannan put_device(sup_dev); 2114f9aa4606SSaravana Kannan return ret; 2115f9aa4606SSaravana Kannan } 2116f9aa4606SSaravana Kannan 2117f9aa4606SSaravana Kannan /** 2118f9aa4606SSaravana Kannan * __fw_devlink_link_to_consumers - Create device links to consumers of a device 211937c52f74SPierre-Louis Bossart * @dev: Device that needs to be linked to its consumers 2120f9aa4606SSaravana Kannan * 2121f9aa4606SSaravana Kannan * This function looks at all the consumer fwnodes of @dev and creates device 2122f9aa4606SSaravana Kannan * links between the consumer device and @dev (supplier). 2123f9aa4606SSaravana Kannan * 2124f9aa4606SSaravana Kannan * If the consumer device has not been added yet, then this function creates a 2125f9aa4606SSaravana Kannan * SYNC_STATE_ONLY link between @dev (supplier) and the closest ancestor device 2126f9aa4606SSaravana Kannan * of the consumer fwnode. This is necessary to make sure @dev doesn't get a 2127f9aa4606SSaravana Kannan * sync_state() callback before the real consumer device gets to be added and 2128f9aa4606SSaravana Kannan * then probed. 2129f9aa4606SSaravana Kannan * 2130f9aa4606SSaravana Kannan * Once device links are created from the real consumer to @dev (supplier), the 2131f9aa4606SSaravana Kannan * fwnode links are deleted. 2132f9aa4606SSaravana Kannan */ 2133f9aa4606SSaravana Kannan static void __fw_devlink_link_to_consumers(struct device *dev) 2134f9aa4606SSaravana Kannan { 2135f9aa4606SSaravana Kannan struct fwnode_handle *fwnode = dev->fwnode; 2136f9aa4606SSaravana Kannan struct fwnode_link *link, *tmp; 2137f9aa4606SSaravana Kannan 2138f9aa4606SSaravana Kannan list_for_each_entry_safe(link, tmp, &fwnode->consumers, s_hook) { 2139f9aa4606SSaravana Kannan struct device *con_dev; 2140f9aa4606SSaravana Kannan bool own_link = true; 2141f9aa4606SSaravana Kannan int ret; 2142f9aa4606SSaravana Kannan 2143f9aa4606SSaravana Kannan con_dev = get_dev_from_fwnode(link->consumer); 2144f9aa4606SSaravana Kannan /* 2145f9aa4606SSaravana Kannan * If consumer device is not available yet, make a "proxy" 2146f9aa4606SSaravana Kannan * SYNC_STATE_ONLY link from the consumer's parent device to 2147f9aa4606SSaravana Kannan * the supplier device. This is necessary to make sure the 2148f9aa4606SSaravana Kannan * supplier doesn't get a sync_state() callback before the real 2149f9aa4606SSaravana Kannan * consumer can create a device link to the supplier. 2150f9aa4606SSaravana Kannan * 2151f9aa4606SSaravana Kannan * This proxy link step is needed to handle the case where the 2152f9aa4606SSaravana Kannan * consumer's parent device is added before the supplier. 2153f9aa4606SSaravana Kannan */ 2154f9aa4606SSaravana Kannan if (!con_dev) { 2155f9aa4606SSaravana Kannan con_dev = fwnode_get_next_parent_dev(link->consumer); 2156f9aa4606SSaravana Kannan /* 2157f9aa4606SSaravana Kannan * However, if the consumer's parent device is also the 2158f9aa4606SSaravana Kannan * parent of the supplier, don't create a 2159f9aa4606SSaravana Kannan * consumer-supplier link from the parent to its child 2160f9aa4606SSaravana Kannan * device. Such a dependency is impossible. 2161f9aa4606SSaravana Kannan */ 2162f9aa4606SSaravana Kannan if (con_dev && 2163f9aa4606SSaravana Kannan fwnode_is_ancestor_of(con_dev->fwnode, fwnode)) { 2164f9aa4606SSaravana Kannan put_device(con_dev); 2165f9aa4606SSaravana Kannan con_dev = NULL; 2166f9aa4606SSaravana Kannan } else { 2167f9aa4606SSaravana Kannan own_link = false; 2168f9aa4606SSaravana Kannan } 2169f9aa4606SSaravana Kannan } 2170f9aa4606SSaravana Kannan 2171f9aa4606SSaravana Kannan if (!con_dev) 2172f9aa4606SSaravana Kannan continue; 2173f9aa4606SSaravana Kannan 2174cd115c04SSaravana Kannan ret = fw_devlink_create_devlink(con_dev, fwnode, link); 2175f9aa4606SSaravana Kannan put_device(con_dev); 2176f9aa4606SSaravana Kannan if (!own_link || ret == -EAGAIN) 2177f9aa4606SSaravana Kannan continue; 2178f9aa4606SSaravana Kannan 217976f13081SSaravana Kannan __fwnode_link_del(link); 2180f9aa4606SSaravana Kannan } 2181f9aa4606SSaravana Kannan } 2182f9aa4606SSaravana Kannan 2183f9aa4606SSaravana Kannan /** 2184f9aa4606SSaravana Kannan * __fw_devlink_link_to_suppliers - Create device links to suppliers of a device 218537c52f74SPierre-Louis Bossart * @dev: The consumer device that needs to be linked to its suppliers 218637c52f74SPierre-Louis Bossart * @fwnode: Root of the fwnode tree that is used to create device links 2187f9aa4606SSaravana Kannan * 2188f9aa4606SSaravana Kannan * This function looks at all the supplier fwnodes of fwnode tree rooted at 2189f9aa4606SSaravana Kannan * @fwnode and creates device links between @dev (consumer) and all the 2190f9aa4606SSaravana Kannan * supplier devices of the entire fwnode tree at @fwnode. 2191f9aa4606SSaravana Kannan * 2192f9aa4606SSaravana Kannan * The function creates normal (non-SYNC_STATE_ONLY) device links between @dev 2193f9aa4606SSaravana Kannan * and the real suppliers of @dev. Once these device links are created, the 21943fb16866SSaravana Kannan * fwnode links are deleted. 2195f9aa4606SSaravana Kannan * 2196f9aa4606SSaravana Kannan * In addition, it also looks at all the suppliers of the entire fwnode tree 2197f9aa4606SSaravana Kannan * because some of the child devices of @dev that have not been added yet 2198f9aa4606SSaravana Kannan * (because @dev hasn't probed) might already have their suppliers added to 2199f9aa4606SSaravana Kannan * driver core. So, this function creates SYNC_STATE_ONLY device links between 2200f9aa4606SSaravana Kannan * @dev (consumer) and these suppliers to make sure they don't execute their 2201f9aa4606SSaravana Kannan * sync_state() callbacks before these child devices have a chance to create 2202f9aa4606SSaravana Kannan * their device links. The fwnode links that correspond to the child devices 2203f9aa4606SSaravana Kannan * aren't delete because they are needed later to create the device links 2204f9aa4606SSaravana Kannan * between the real consumer and supplier devices. 2205f9aa4606SSaravana Kannan */ 2206f9aa4606SSaravana Kannan static void __fw_devlink_link_to_suppliers(struct device *dev, 2207f9aa4606SSaravana Kannan struct fwnode_handle *fwnode) 2208f9aa4606SSaravana Kannan { 2209f9aa4606SSaravana Kannan bool own_link = (dev->fwnode == fwnode); 2210f9aa4606SSaravana Kannan struct fwnode_link *link, *tmp; 2211f9aa4606SSaravana Kannan struct fwnode_handle *child = NULL; 2212f9aa4606SSaravana Kannan 2213f9aa4606SSaravana Kannan list_for_each_entry_safe(link, tmp, &fwnode->suppliers, c_hook) { 2214f9aa4606SSaravana Kannan int ret; 2215f9aa4606SSaravana Kannan struct fwnode_handle *sup = link->supplier; 2216f9aa4606SSaravana Kannan 2217cd115c04SSaravana Kannan ret = fw_devlink_create_devlink(dev, sup, link); 2218f9aa4606SSaravana Kannan if (!own_link || ret == -EAGAIN) 2219f9aa4606SSaravana Kannan continue; 2220f9aa4606SSaravana Kannan 222176f13081SSaravana Kannan __fwnode_link_del(link); 2222f9aa4606SSaravana Kannan } 2223f9aa4606SSaravana Kannan 2224f9aa4606SSaravana Kannan /* 2225f9aa4606SSaravana Kannan * Make "proxy" SYNC_STATE_ONLY device links to represent the needs of 2226f9aa4606SSaravana Kannan * all the descendants. This proxy link step is needed to handle the 2227f9aa4606SSaravana Kannan * case where the supplier is added before the consumer's parent device 2228f9aa4606SSaravana Kannan * (@dev). 2229f9aa4606SSaravana Kannan */ 2230f9aa4606SSaravana Kannan while ((child = fwnode_get_next_available_child_node(fwnode, child))) 2231f9aa4606SSaravana Kannan __fw_devlink_link_to_suppliers(dev, child); 2232f9aa4606SSaravana Kannan } 2233f9aa4606SSaravana Kannan 22341da177e4SLinus Torvalds static void fw_devlink_link_device(struct device *dev) 22351da177e4SLinus Torvalds { 2236f9aa4606SSaravana Kannan struct fwnode_handle *fwnode = dev->fwnode; 22371da177e4SLinus Torvalds 2238f9aa4606SSaravana Kannan if (!fw_devlink_flags) 2239f9aa4606SSaravana Kannan return; 22401da177e4SLinus Torvalds 2241f9aa4606SSaravana Kannan fw_devlink_parse_fwtree(fwnode); 2242f9aa4606SSaravana Kannan 2243f9aa4606SSaravana Kannan mutex_lock(&fwnode_link_lock); 2244f9aa4606SSaravana Kannan __fw_devlink_link_to_consumers(dev); 2245f9aa4606SSaravana Kannan __fw_devlink_link_to_suppliers(dev, fwnode); 2246f9aa4606SSaravana Kannan mutex_unlock(&fwnode_link_lock); 22471da177e4SLinus Torvalds } 22481da177e4SLinus Torvalds 22491da177e4SLinus Torvalds /* Device links support end. */ 22501da177e4SLinus Torvalds 22511da177e4SLinus Torvalds int (*platform_notify)(struct device *dev) = NULL; 22521da177e4SLinus Torvalds int (*platform_notify_remove)(struct device *dev) = NULL; 22531da177e4SLinus Torvalds static struct kobject *dev_kobj; 22541da177e4SLinus Torvalds struct kobject *sysfs_dev_char_kobj; 22551da177e4SLinus Torvalds struct kobject *sysfs_dev_block_kobj; 22561da177e4SLinus Torvalds 22571da177e4SLinus Torvalds static DEFINE_MUTEX(device_hotplug_lock); 22581da177e4SLinus Torvalds 22591da177e4SLinus Torvalds void lock_device_hotplug(void) 22601da177e4SLinus Torvalds { 22611da177e4SLinus Torvalds mutex_lock(&device_hotplug_lock); 22621da177e4SLinus Torvalds } 22631da177e4SLinus Torvalds 22641da177e4SLinus Torvalds void unlock_device_hotplug(void) 22651da177e4SLinus Torvalds { 22661da177e4SLinus Torvalds mutex_unlock(&device_hotplug_lock); 22671da177e4SLinus Torvalds } 22681da177e4SLinus Torvalds 22691da177e4SLinus Torvalds int lock_device_hotplug_sysfs(void) 22701da177e4SLinus Torvalds { 22711da177e4SLinus Torvalds if (mutex_trylock(&device_hotplug_lock)) 22721da177e4SLinus Torvalds return 0; 22731da177e4SLinus Torvalds 22741da177e4SLinus Torvalds /* Avoid busy looping (5 ms of sleep should do). */ 22751da177e4SLinus Torvalds msleep(5); 22761da177e4SLinus Torvalds return restart_syscall(); 22771da177e4SLinus Torvalds } 22781da177e4SLinus Torvalds 22791da177e4SLinus Torvalds #ifdef CONFIG_BLOCK 22801da177e4SLinus Torvalds static inline int device_is_not_partition(struct device *dev) 22811da177e4SLinus Torvalds { 22821da177e4SLinus Torvalds return !(dev->type == &part_type); 22831da177e4SLinus Torvalds } 22841da177e4SLinus Torvalds #else 22851da177e4SLinus Torvalds static inline int device_is_not_partition(struct device *dev) 22861da177e4SLinus Torvalds { 22871da177e4SLinus Torvalds return 1; 22881da177e4SLinus Torvalds } 22891da177e4SLinus Torvalds #endif 22901da177e4SLinus Torvalds 2291b2ebd9ddSRafael J. Wysocki static void device_platform_notify(struct device *dev) 229207de0e86SHeikki Krogerus { 2293d0b8e398SRafael J. Wysocki acpi_device_notify(dev); 22947847a145SHeikki Krogerus 2295b2ebd9ddSRafael J. Wysocki software_node_notify(dev); 22967847a145SHeikki Krogerus 2297b2ebd9ddSRafael J. Wysocki if (platform_notify) 229807de0e86SHeikki Krogerus platform_notify(dev); 2299b2ebd9ddSRafael J. Wysocki } 2300b2ebd9ddSRafael J. Wysocki 2301b2ebd9ddSRafael J. Wysocki static void device_platform_notify_remove(struct device *dev) 2302b2ebd9ddSRafael J. Wysocki { 2303d0b8e398SRafael J. Wysocki acpi_device_notify_remove(dev); 230407de0e86SHeikki Krogerus 2305384f5a85SRafael J. Wysocki software_node_notify_remove(dev); 23064e886c29SGreg Kroah-Hartman 2307b2ebd9ddSRafael J. Wysocki if (platform_notify_remove) 23084e886c29SGreg Kroah-Hartman platform_notify_remove(dev); 23094e886c29SGreg Kroah-Hartman } 23101da177e4SLinus Torvalds 23113e95637aSAlan Stern /** 23123e95637aSAlan Stern * dev_driver_string - Return a device's driver name, if at all possible 23133e95637aSAlan Stern * @dev: struct device to get the name of 23143e95637aSAlan Stern * 23153e95637aSAlan Stern * Will return the device's driver's name if it is bound to a device. If 23169169c012Syan * the device is not bound to a driver, it will return the name of the bus 23173e95637aSAlan Stern * it is attached to. If it is not attached to a bus either, an empty 23183e95637aSAlan Stern * string will be returned. 23193e95637aSAlan Stern */ 2320bf9ca69fSJean Delvare const char *dev_driver_string(const struct device *dev) 23213e95637aSAlan Stern { 23223589972eSAlan Stern struct device_driver *drv; 23233589972eSAlan Stern 23243589972eSAlan Stern /* dev->driver can change to NULL underneath us because of unbinding, 23253589972eSAlan Stern * so be careful about accessing it. dev->bus and dev->class should 23263589972eSAlan Stern * never change once they are set, so they don't need special care. 23273589972eSAlan Stern */ 23286aa7de05SMark Rutland drv = READ_ONCE(dev->driver); 2329e020ff61SSaravana Kannan return drv ? drv->name : dev_bus_name(dev); 23303e95637aSAlan Stern } 2331310a922dSMatthew Wilcox EXPORT_SYMBOL(dev_driver_string); 23323e95637aSAlan Stern 23331da177e4SLinus Torvalds #define to_dev_attr(_attr) container_of(_attr, struct device_attribute, attr) 23341da177e4SLinus Torvalds 23354a3ad20cSGreg Kroah-Hartman static ssize_t dev_attr_show(struct kobject *kobj, struct attribute *attr, 23364a3ad20cSGreg Kroah-Hartman char *buf) 23371da177e4SLinus Torvalds { 23381da177e4SLinus Torvalds struct device_attribute *dev_attr = to_dev_attr(attr); 2339b0d1f807SLars-Peter Clausen struct device *dev = kobj_to_dev(kobj); 23404a0c20bfSDmitry Torokhov ssize_t ret = -EIO; 23411da177e4SLinus Torvalds 23421da177e4SLinus Torvalds if (dev_attr->show) 234354b6f35cSYani Ioannou ret = dev_attr->show(dev, dev_attr, buf); 2344815d2d50SAndrew Morton if (ret >= (ssize_t)PAGE_SIZE) { 2345a52668c6SSergey Senozhatsky printk("dev_attr_show: %pS returned bad count\n", 2346a52668c6SSergey Senozhatsky dev_attr->show); 2347815d2d50SAndrew Morton } 23481da177e4SLinus Torvalds return ret; 23491da177e4SLinus Torvalds } 23501da177e4SLinus Torvalds 23514a3ad20cSGreg Kroah-Hartman static ssize_t dev_attr_store(struct kobject *kobj, struct attribute *attr, 23521da177e4SLinus Torvalds const char *buf, size_t count) 23531da177e4SLinus Torvalds { 23541da177e4SLinus Torvalds struct device_attribute *dev_attr = to_dev_attr(attr); 2355b0d1f807SLars-Peter Clausen struct device *dev = kobj_to_dev(kobj); 23564a0c20bfSDmitry Torokhov ssize_t ret = -EIO; 23571da177e4SLinus Torvalds 23581da177e4SLinus Torvalds if (dev_attr->store) 235954b6f35cSYani Ioannou ret = dev_attr->store(dev, dev_attr, buf, count); 23601da177e4SLinus Torvalds return ret; 23611da177e4SLinus Torvalds } 23621da177e4SLinus Torvalds 236352cf25d0SEmese Revfy static const struct sysfs_ops dev_sysfs_ops = { 23641da177e4SLinus Torvalds .show = dev_attr_show, 23651da177e4SLinus Torvalds .store = dev_attr_store, 23661da177e4SLinus Torvalds }; 23671da177e4SLinus Torvalds 2368ca22e56dSKay Sievers #define to_ext_attr(x) container_of(x, struct dev_ext_attribute, attr) 2369ca22e56dSKay Sievers 2370ca22e56dSKay Sievers ssize_t device_store_ulong(struct device *dev, 2371ca22e56dSKay Sievers struct device_attribute *attr, 2372ca22e56dSKay Sievers const char *buf, size_t size) 2373ca22e56dSKay Sievers { 2374ca22e56dSKay Sievers struct dev_ext_attribute *ea = to_ext_attr(attr); 2375f88184bfSKaitao cheng int ret; 2376f88184bfSKaitao cheng unsigned long new; 2377f88184bfSKaitao cheng 2378f88184bfSKaitao cheng ret = kstrtoul(buf, 0, &new); 2379f88184bfSKaitao cheng if (ret) 2380f88184bfSKaitao cheng return ret; 2381ca22e56dSKay Sievers *(unsigned long *)(ea->var) = new; 2382ca22e56dSKay Sievers /* Always return full write size even if we didn't consume all */ 2383ca22e56dSKay Sievers return size; 2384ca22e56dSKay Sievers } 2385ca22e56dSKay Sievers EXPORT_SYMBOL_GPL(device_store_ulong); 2386ca22e56dSKay Sievers 2387ca22e56dSKay Sievers ssize_t device_show_ulong(struct device *dev, 2388ca22e56dSKay Sievers struct device_attribute *attr, 2389ca22e56dSKay Sievers char *buf) 2390ca22e56dSKay Sievers { 2391ca22e56dSKay Sievers struct dev_ext_attribute *ea = to_ext_attr(attr); 2392aa838896SJoe Perches return sysfs_emit(buf, "%lx\n", *(unsigned long *)(ea->var)); 2393ca22e56dSKay Sievers } 2394ca22e56dSKay Sievers EXPORT_SYMBOL_GPL(device_show_ulong); 2395ca22e56dSKay Sievers 2396ca22e56dSKay Sievers ssize_t device_store_int(struct device *dev, 2397ca22e56dSKay Sievers struct device_attribute *attr, 2398ca22e56dSKay Sievers const char *buf, size_t size) 2399ca22e56dSKay Sievers { 2400ca22e56dSKay Sievers struct dev_ext_attribute *ea = to_ext_attr(attr); 2401f88184bfSKaitao cheng int ret; 2402f88184bfSKaitao cheng long new; 2403f88184bfSKaitao cheng 2404f88184bfSKaitao cheng ret = kstrtol(buf, 0, &new); 2405f88184bfSKaitao cheng if (ret) 2406f88184bfSKaitao cheng return ret; 2407f88184bfSKaitao cheng 2408f88184bfSKaitao cheng if (new > INT_MAX || new < INT_MIN) 2409ca22e56dSKay Sievers return -EINVAL; 2410ca22e56dSKay Sievers *(int *)(ea->var) = new; 2411ca22e56dSKay Sievers /* Always return full write size even if we didn't consume all */ 2412ca22e56dSKay Sievers return size; 2413ca22e56dSKay Sievers } 2414ca22e56dSKay Sievers EXPORT_SYMBOL_GPL(device_store_int); 2415ca22e56dSKay Sievers 2416ca22e56dSKay Sievers ssize_t device_show_int(struct device *dev, 2417ca22e56dSKay Sievers struct device_attribute *attr, 2418ca22e56dSKay Sievers char *buf) 2419ca22e56dSKay Sievers { 2420ca22e56dSKay Sievers struct dev_ext_attribute *ea = to_ext_attr(attr); 2421ca22e56dSKay Sievers 2422aa838896SJoe Perches return sysfs_emit(buf, "%d\n", *(int *)(ea->var)); 2423ca22e56dSKay Sievers } 2424ca22e56dSKay Sievers EXPORT_SYMBOL_GPL(device_show_int); 24251da177e4SLinus Torvalds 242691872392SBorislav Petkov ssize_t device_store_bool(struct device *dev, struct device_attribute *attr, 242791872392SBorislav Petkov const char *buf, size_t size) 242891872392SBorislav Petkov { 242991872392SBorislav Petkov struct dev_ext_attribute *ea = to_ext_attr(attr); 243091872392SBorislav Petkov 243173060022SChristophe JAILLET if (kstrtobool(buf, ea->var) < 0) 243291872392SBorislav Petkov return -EINVAL; 243391872392SBorislav Petkov 243491872392SBorislav Petkov return size; 243591872392SBorislav Petkov } 243691872392SBorislav Petkov EXPORT_SYMBOL_GPL(device_store_bool); 243791872392SBorislav Petkov 243891872392SBorislav Petkov ssize_t device_show_bool(struct device *dev, struct device_attribute *attr, 243991872392SBorislav Petkov char *buf) 244091872392SBorislav Petkov { 244191872392SBorislav Petkov struct dev_ext_attribute *ea = to_ext_attr(attr); 244291872392SBorislav Petkov 2443aa838896SJoe Perches return sysfs_emit(buf, "%d\n", *(bool *)(ea->var)); 244491872392SBorislav Petkov } 244591872392SBorislav Petkov EXPORT_SYMBOL_GPL(device_show_bool); 244691872392SBorislav Petkov 24471da177e4SLinus Torvalds /** 24481da177e4SLinus Torvalds * device_release - free device structure. 24491da177e4SLinus Torvalds * @kobj: device's kobject. 24501da177e4SLinus Torvalds * 24511da177e4SLinus Torvalds * This is called once the reference count for the object 24521da177e4SLinus Torvalds * reaches 0. We forward the call to the device's release 24531da177e4SLinus Torvalds * method, which should handle actually freeing the structure. 24541da177e4SLinus Torvalds */ 24551da177e4SLinus Torvalds static void device_release(struct kobject *kobj) 24561da177e4SLinus Torvalds { 2457b0d1f807SLars-Peter Clausen struct device *dev = kobj_to_dev(kobj); 2458fb069a5dSGreg Kroah-Hartman struct device_private *p = dev->p; 24591da177e4SLinus Torvalds 2460a525a3ddSMing Lei /* 2461a525a3ddSMing Lei * Some platform devices are driven without driver attached 2462a525a3ddSMing Lei * and managed resources may have been acquired. Make sure 2463a525a3ddSMing Lei * all resources are released. 2464a525a3ddSMing Lei * 2465a525a3ddSMing Lei * Drivers still can add resources into device after device 2466a525a3ddSMing Lei * is deleted but alive, so release devres here to avoid 2467a525a3ddSMing Lei * possible memory leak. 2468a525a3ddSMing Lei */ 2469a525a3ddSMing Lei devres_release_all(dev); 2470a525a3ddSMing Lei 2471e0d07278SJim Quinlan kfree(dev->dma_range_map); 2472e0d07278SJim Quinlan 24731da177e4SLinus Torvalds if (dev->release) 24741da177e4SLinus Torvalds dev->release(dev); 2475f9f852dfSKay Sievers else if (dev->type && dev->type->release) 2476f9f852dfSKay Sievers dev->type->release(dev); 24772620efefSGreg Kroah-Hartman else if (dev->class && dev->class->dev_release) 24782620efefSGreg Kroah-Hartman dev->class->dev_release(dev); 2479f810a5cfSArjan van de Ven else 24800c1bc6b8SMauro Carvalho Chehab WARN(1, KERN_ERR "Device '%s' does not have a release() function, it is broken and must be fixed. See Documentation/core-api/kobject.rst.\n", 24811e0b2cf9SKay Sievers dev_name(dev)); 2482fb069a5dSGreg Kroah-Hartman kfree(p); 24831da177e4SLinus Torvalds } 24841da177e4SLinus Torvalds 248502a476d9SGreg Kroah-Hartman static const void *device_namespace(const struct kobject *kobj) 2486bc451f20SEric W. Biederman { 2487fa627348SGreg Kroah-Hartman const struct device *dev = kobj_to_dev(kobj); 2488bc451f20SEric W. Biederman const void *ns = NULL; 2489bc451f20SEric W. Biederman 2490bc451f20SEric W. Biederman if (dev->class && dev->class->ns_type) 2491bc451f20SEric W. Biederman ns = dev->class->namespace(dev); 2492bc451f20SEric W. Biederman 2493bc451f20SEric W. Biederman return ns; 2494bc451f20SEric W. Biederman } 2495bc451f20SEric W. Biederman 249602a476d9SGreg Kroah-Hartman static void device_get_ownership(const struct kobject *kobj, kuid_t *uid, kgid_t *gid) 24979944e894SDmitry Torokhov { 2498fa627348SGreg Kroah-Hartman const struct device *dev = kobj_to_dev(kobj); 24999944e894SDmitry Torokhov 25009944e894SDmitry Torokhov if (dev->class && dev->class->get_ownership) 25019944e894SDmitry Torokhov dev->class->get_ownership(dev, uid, gid); 25029944e894SDmitry Torokhov } 25039944e894SDmitry Torokhov 2504c83d9ab4SThomas Weißschuh static const struct kobj_type device_ktype = { 25051da177e4SLinus Torvalds .release = device_release, 25061da177e4SLinus Torvalds .sysfs_ops = &dev_sysfs_ops, 2507bc451f20SEric W. Biederman .namespace = device_namespace, 25089944e894SDmitry Torokhov .get_ownership = device_get_ownership, 25091da177e4SLinus Torvalds }; 25101da177e4SLinus Torvalds 25111da177e4SLinus Torvalds 2512c45a88bbSGreg Kroah-Hartman static int dev_uevent_filter(const struct kobject *kobj) 25131da177e4SLinus Torvalds { 2514ee6d3dd4SWedson Almeida Filho const struct kobj_type *ktype = get_ktype(kobj); 25151da177e4SLinus Torvalds 25168f4afc41SGreg Kroah-Hartman if (ktype == &device_ktype) { 2517c45a88bbSGreg Kroah-Hartman const struct device *dev = kobj_to_dev(kobj); 25181da177e4SLinus Torvalds if (dev->bus) 25191da177e4SLinus Torvalds return 1; 252023681e47SGreg Kroah-Hartman if (dev->class) 252123681e47SGreg Kroah-Hartman return 1; 25221da177e4SLinus Torvalds } 25231da177e4SLinus Torvalds return 0; 25241da177e4SLinus Torvalds } 25251da177e4SLinus Torvalds 2526a53d1accSGreg Kroah-Hartman static const char *dev_uevent_name(const struct kobject *kobj) 25271da177e4SLinus Torvalds { 2528a53d1accSGreg Kroah-Hartman const struct device *dev = kobj_to_dev(kobj); 25291da177e4SLinus Torvalds 253023681e47SGreg Kroah-Hartman if (dev->bus) 25311da177e4SLinus Torvalds return dev->bus->name; 253223681e47SGreg Kroah-Hartman if (dev->class) 253323681e47SGreg Kroah-Hartman return dev->class->name; 253423681e47SGreg Kroah-Hartman return NULL; 25351da177e4SLinus Torvalds } 25361da177e4SLinus Torvalds 253756d5f362SGreg Kroah-Hartman static int dev_uevent(const struct kobject *kobj, struct kobj_uevent_env *env) 25381da177e4SLinus Torvalds { 253956d5f362SGreg Kroah-Hartman const struct device *dev = kobj_to_dev(kobj); 25401da177e4SLinus Torvalds int retval = 0; 25411da177e4SLinus Torvalds 25426fcf53acSKay Sievers /* add device node properties if present */ 254323681e47SGreg Kroah-Hartman if (MAJOR(dev->devt)) { 25446fcf53acSKay Sievers const char *tmp; 25456fcf53acSKay Sievers const char *name; 25462c9ede55SAl Viro umode_t mode = 0; 25474e4098a3SGreg Kroah-Hartman kuid_t uid = GLOBAL_ROOT_UID; 25484e4098a3SGreg Kroah-Hartman kgid_t gid = GLOBAL_ROOT_GID; 25496fcf53acSKay Sievers 25507eff2e7aSKay Sievers add_uevent_var(env, "MAJOR=%u", MAJOR(dev->devt)); 25517eff2e7aSKay Sievers add_uevent_var(env, "MINOR=%u", MINOR(dev->devt)); 25523c2670e6SKay Sievers name = device_get_devnode(dev, &mode, &uid, &gid, &tmp); 25536fcf53acSKay Sievers if (name) { 25546fcf53acSKay Sievers add_uevent_var(env, "DEVNAME=%s", name); 2555e454cea2SKay Sievers if (mode) 2556e454cea2SKay Sievers add_uevent_var(env, "DEVMODE=%#o", mode & 0777); 25574e4098a3SGreg Kroah-Hartman if (!uid_eq(uid, GLOBAL_ROOT_UID)) 25584e4098a3SGreg Kroah-Hartman add_uevent_var(env, "DEVUID=%u", from_kuid(&init_user_ns, uid)); 25594e4098a3SGreg Kroah-Hartman if (!gid_eq(gid, GLOBAL_ROOT_GID)) 25604e4098a3SGreg Kroah-Hartman add_uevent_var(env, "DEVGID=%u", from_kgid(&init_user_ns, gid)); 25613c2670e6SKay Sievers kfree(tmp); 25626fcf53acSKay Sievers } 256323681e47SGreg Kroah-Hartman } 256423681e47SGreg Kroah-Hartman 2565414264f9SKay Sievers if (dev->type && dev->type->name) 25667eff2e7aSKay Sievers add_uevent_var(env, "DEVTYPE=%s", dev->type->name); 2567414264f9SKay Sievers 2568239378f1SKay Sievers if (dev->driver) 25697eff2e7aSKay Sievers add_uevent_var(env, "DRIVER=%s", dev->driver->name); 2570239378f1SKay Sievers 257107d57a32SGrant Likely /* Add common DT information about the device */ 257207d57a32SGrant Likely of_device_uevent(dev, env); 257307d57a32SGrant Likely 25741da177e4SLinus Torvalds /* have the bus specific function add its stuff */ 25757eff2e7aSKay Sievers if (dev->bus && dev->bus->uevent) { 25767eff2e7aSKay Sievers retval = dev->bus->uevent(dev, env); 2577f9f852dfSKay Sievers if (retval) 25787dc72b28SGreg Kroah-Hartman pr_debug("device: '%s': %s: bus uevent() returned %d\n", 25791e0b2cf9SKay Sievers dev_name(dev), __func__, retval); 25801da177e4SLinus Torvalds } 25811da177e4SLinus Torvalds 25822620efefSGreg Kroah-Hartman /* have the class specific function add its stuff */ 25837eff2e7aSKay Sievers if (dev->class && dev->class->dev_uevent) { 25847eff2e7aSKay Sievers retval = dev->class->dev_uevent(dev, env); 2585f9f852dfSKay Sievers if (retval) 25867dc72b28SGreg Kroah-Hartman pr_debug("device: '%s': %s: class uevent() " 25871e0b2cf9SKay Sievers "returned %d\n", dev_name(dev), 25882b3a302aSHarvey Harrison __func__, retval); 25892620efefSGreg Kroah-Hartman } 2590f9f852dfSKay Sievers 2591eef35c2dSStefan Weil /* have the device type specific function add its stuff */ 25927eff2e7aSKay Sievers if (dev->type && dev->type->uevent) { 25937eff2e7aSKay Sievers retval = dev->type->uevent(dev, env); 2594f9f852dfSKay Sievers if (retval) 25957dc72b28SGreg Kroah-Hartman pr_debug("device: '%s': %s: dev_type uevent() " 25961e0b2cf9SKay Sievers "returned %d\n", dev_name(dev), 25972b3a302aSHarvey Harrison __func__, retval); 25982620efefSGreg Kroah-Hartman } 25992620efefSGreg Kroah-Hartman 26001da177e4SLinus Torvalds return retval; 26011da177e4SLinus Torvalds } 26021da177e4SLinus Torvalds 26039cd43611SEmese Revfy static const struct kset_uevent_ops device_uevent_ops = { 2604312c004dSKay Sievers .filter = dev_uevent_filter, 2605312c004dSKay Sievers .name = dev_uevent_name, 2606312c004dSKay Sievers .uevent = dev_uevent, 26071da177e4SLinus Torvalds }; 26081da177e4SLinus Torvalds 2609c5e064a6SGreg Kroah-Hartman static ssize_t uevent_show(struct device *dev, struct device_attribute *attr, 261016574dccSKay Sievers char *buf) 261116574dccSKay Sievers { 261216574dccSKay Sievers struct kobject *top_kobj; 261316574dccSKay Sievers struct kset *kset; 26147eff2e7aSKay Sievers struct kobj_uevent_env *env = NULL; 261516574dccSKay Sievers int i; 2616948b3edbSJoe Perches int len = 0; 261716574dccSKay Sievers int retval; 261816574dccSKay Sievers 261916574dccSKay Sievers /* search the kset, the device belongs to */ 262016574dccSKay Sievers top_kobj = &dev->kobj; 26215c5daf65SKay Sievers while (!top_kobj->kset && top_kobj->parent) 262216574dccSKay Sievers top_kobj = top_kobj->parent; 262316574dccSKay Sievers if (!top_kobj->kset) 262416574dccSKay Sievers goto out; 26255c5daf65SKay Sievers 262616574dccSKay Sievers kset = top_kobj->kset; 262716574dccSKay Sievers if (!kset->uevent_ops || !kset->uevent_ops->uevent) 262816574dccSKay Sievers goto out; 262916574dccSKay Sievers 263016574dccSKay Sievers /* respect filter */ 263116574dccSKay Sievers if (kset->uevent_ops && kset->uevent_ops->filter) 2632cf6299b6SGreg Kroah-Hartman if (!kset->uevent_ops->filter(&dev->kobj)) 263316574dccSKay Sievers goto out; 263416574dccSKay Sievers 26357eff2e7aSKay Sievers env = kzalloc(sizeof(struct kobj_uevent_env), GFP_KERNEL); 26367eff2e7aSKay Sievers if (!env) 2637c7308c81SGreg Kroah-Hartman return -ENOMEM; 2638c7308c81SGreg Kroah-Hartman 263916574dccSKay Sievers /* let the kset specific function add its keys */ 2640cf6299b6SGreg Kroah-Hartman retval = kset->uevent_ops->uevent(&dev->kobj, env); 264116574dccSKay Sievers if (retval) 264216574dccSKay Sievers goto out; 264316574dccSKay Sievers 264416574dccSKay Sievers /* copy keys to file */ 26457eff2e7aSKay Sievers for (i = 0; i < env->envp_idx; i++) 2646948b3edbSJoe Perches len += sysfs_emit_at(buf, len, "%s\n", env->envp[i]); 264716574dccSKay Sievers out: 26487eff2e7aSKay Sievers kfree(env); 2649948b3edbSJoe Perches return len; 265016574dccSKay Sievers } 265116574dccSKay Sievers 2652c5e064a6SGreg Kroah-Hartman static ssize_t uevent_store(struct device *dev, struct device_attribute *attr, 2653a7fd6706SKay Sievers const char *buf, size_t count) 2654a7fd6706SKay Sievers { 2655df44b479SPeter Rajnoha int rc; 2656df44b479SPeter Rajnoha 2657df44b479SPeter Rajnoha rc = kobject_synth_uevent(&dev->kobj, buf, count); 2658df44b479SPeter Rajnoha 2659df44b479SPeter Rajnoha if (rc) { 26606bb7ea3aSBrian Norris dev_err(dev, "uevent: failed to send synthetic uevent: %d\n", rc); 2661df44b479SPeter Rajnoha return rc; 2662df44b479SPeter Rajnoha } 266360a96a59SKay Sievers 2664a7fd6706SKay Sievers return count; 2665a7fd6706SKay Sievers } 2666c5e064a6SGreg Kroah-Hartman static DEVICE_ATTR_RW(uevent); 2667a7fd6706SKay Sievers 2668c5e064a6SGreg Kroah-Hartman static ssize_t online_show(struct device *dev, struct device_attribute *attr, 26694f3549d7SRafael J. Wysocki char *buf) 26704f3549d7SRafael J. Wysocki { 26714f3549d7SRafael J. Wysocki bool val; 26724f3549d7SRafael J. Wysocki 26735e33bc41SRafael J. Wysocki device_lock(dev); 26744f3549d7SRafael J. Wysocki val = !dev->offline; 26755e33bc41SRafael J. Wysocki device_unlock(dev); 2676aa838896SJoe Perches return sysfs_emit(buf, "%u\n", val); 26774f3549d7SRafael J. Wysocki } 26784f3549d7SRafael J. Wysocki 2679c5e064a6SGreg Kroah-Hartman static ssize_t online_store(struct device *dev, struct device_attribute *attr, 26804f3549d7SRafael J. Wysocki const char *buf, size_t count) 26814f3549d7SRafael J. Wysocki { 26824f3549d7SRafael J. Wysocki bool val; 26834f3549d7SRafael J. Wysocki int ret; 26844f3549d7SRafael J. Wysocki 268573060022SChristophe JAILLET ret = kstrtobool(buf, &val); 26864f3549d7SRafael J. Wysocki if (ret < 0) 26874f3549d7SRafael J. Wysocki return ret; 26884f3549d7SRafael J. Wysocki 26895e33bc41SRafael J. Wysocki ret = lock_device_hotplug_sysfs(); 26905e33bc41SRafael J. Wysocki if (ret) 26915e33bc41SRafael J. Wysocki return ret; 26925e33bc41SRafael J. Wysocki 26934f3549d7SRafael J. Wysocki ret = val ? device_online(dev) : device_offline(dev); 26944f3549d7SRafael J. Wysocki unlock_device_hotplug(); 26954f3549d7SRafael J. Wysocki return ret < 0 ? ret : count; 26964f3549d7SRafael J. Wysocki } 2697c5e064a6SGreg Kroah-Hartman static DEVICE_ATTR_RW(online); 26984f3549d7SRafael J. Wysocki 269970f400d4SRajat Jain static ssize_t removable_show(struct device *dev, struct device_attribute *attr, 270070f400d4SRajat Jain char *buf) 270170f400d4SRajat Jain { 270270f400d4SRajat Jain const char *loc; 270370f400d4SRajat Jain 270470f400d4SRajat Jain switch (dev->removable) { 270570f400d4SRajat Jain case DEVICE_REMOVABLE: 270670f400d4SRajat Jain loc = "removable"; 270770f400d4SRajat Jain break; 270870f400d4SRajat Jain case DEVICE_FIXED: 270970f400d4SRajat Jain loc = "fixed"; 271070f400d4SRajat Jain break; 271170f400d4SRajat Jain default: 271270f400d4SRajat Jain loc = "unknown"; 271370f400d4SRajat Jain } 271470f400d4SRajat Jain return sysfs_emit(buf, "%s\n", loc); 271570f400d4SRajat Jain } 271670f400d4SRajat Jain static DEVICE_ATTR_RO(removable); 271770f400d4SRajat Jain 2718fa6fdb33SGreg Kroah-Hartman int device_add_groups(struct device *dev, const struct attribute_group **groups) 2719621a1672SDmitry Torokhov { 27203e9b2baeSGreg Kroah-Hartman return sysfs_create_groups(&dev->kobj, groups); 2721621a1672SDmitry Torokhov } 2722a7670d42SDmitry Torokhov EXPORT_SYMBOL_GPL(device_add_groups); 2723621a1672SDmitry Torokhov 2724fa6fdb33SGreg Kroah-Hartman void device_remove_groups(struct device *dev, 2725a4dbd674SDavid Brownell const struct attribute_group **groups) 2726621a1672SDmitry Torokhov { 27273e9b2baeSGreg Kroah-Hartman sysfs_remove_groups(&dev->kobj, groups); 2728621a1672SDmitry Torokhov } 2729a7670d42SDmitry Torokhov EXPORT_SYMBOL_GPL(device_remove_groups); 2730de0ff00dSGreg Kroah-Hartman 273157b8ff07SDmitry Torokhov union device_attr_group_devres { 273257b8ff07SDmitry Torokhov const struct attribute_group *group; 273357b8ff07SDmitry Torokhov const struct attribute_group **groups; 273457b8ff07SDmitry Torokhov }; 273557b8ff07SDmitry Torokhov 273657b8ff07SDmitry Torokhov static void devm_attr_group_remove(struct device *dev, void *res) 273757b8ff07SDmitry Torokhov { 273857b8ff07SDmitry Torokhov union device_attr_group_devres *devres = res; 273957b8ff07SDmitry Torokhov const struct attribute_group *group = devres->group; 274057b8ff07SDmitry Torokhov 274157b8ff07SDmitry Torokhov dev_dbg(dev, "%s: removing group %p\n", __func__, group); 274257b8ff07SDmitry Torokhov sysfs_remove_group(&dev->kobj, group); 274357b8ff07SDmitry Torokhov } 274457b8ff07SDmitry Torokhov 274557b8ff07SDmitry Torokhov static void devm_attr_groups_remove(struct device *dev, void *res) 274657b8ff07SDmitry Torokhov { 274757b8ff07SDmitry Torokhov union device_attr_group_devres *devres = res; 274857b8ff07SDmitry Torokhov const struct attribute_group **groups = devres->groups; 274957b8ff07SDmitry Torokhov 275057b8ff07SDmitry Torokhov dev_dbg(dev, "%s: removing groups %p\n", __func__, groups); 275157b8ff07SDmitry Torokhov sysfs_remove_groups(&dev->kobj, groups); 275257b8ff07SDmitry Torokhov } 275357b8ff07SDmitry Torokhov 275457b8ff07SDmitry Torokhov /** 275557b8ff07SDmitry Torokhov * devm_device_add_group - given a device, create a managed attribute group 275657b8ff07SDmitry Torokhov * @dev: The device to create the group for 275757b8ff07SDmitry Torokhov * @grp: The attribute group to create 275857b8ff07SDmitry Torokhov * 275957b8ff07SDmitry Torokhov * This function creates a group for the first time. It will explicitly 276057b8ff07SDmitry Torokhov * warn and error if any of the attribute files being created already exist. 276157b8ff07SDmitry Torokhov * 276257b8ff07SDmitry Torokhov * Returns 0 on success or error code on failure. 276357b8ff07SDmitry Torokhov */ 276457b8ff07SDmitry Torokhov int devm_device_add_group(struct device *dev, const struct attribute_group *grp) 276557b8ff07SDmitry Torokhov { 276657b8ff07SDmitry Torokhov union device_attr_group_devres *devres; 276757b8ff07SDmitry Torokhov int error; 276857b8ff07SDmitry Torokhov 276957b8ff07SDmitry Torokhov devres = devres_alloc(devm_attr_group_remove, 277057b8ff07SDmitry Torokhov sizeof(*devres), GFP_KERNEL); 277157b8ff07SDmitry Torokhov if (!devres) 277257b8ff07SDmitry Torokhov return -ENOMEM; 277357b8ff07SDmitry Torokhov 277457b8ff07SDmitry Torokhov error = sysfs_create_group(&dev->kobj, grp); 277557b8ff07SDmitry Torokhov if (error) { 277657b8ff07SDmitry Torokhov devres_free(devres); 277757b8ff07SDmitry Torokhov return error; 277857b8ff07SDmitry Torokhov } 277957b8ff07SDmitry Torokhov 278057b8ff07SDmitry Torokhov devres->group = grp; 278157b8ff07SDmitry Torokhov devres_add(dev, devres); 278257b8ff07SDmitry Torokhov return 0; 278357b8ff07SDmitry Torokhov } 278457b8ff07SDmitry Torokhov EXPORT_SYMBOL_GPL(devm_device_add_group); 278557b8ff07SDmitry Torokhov 278657b8ff07SDmitry Torokhov /** 278757b8ff07SDmitry Torokhov * devm_device_add_groups - create a bunch of managed attribute groups 278857b8ff07SDmitry Torokhov * @dev: The device to create the group for 278957b8ff07SDmitry Torokhov * @groups: The attribute groups to create, NULL terminated 279057b8ff07SDmitry Torokhov * 279157b8ff07SDmitry Torokhov * This function creates a bunch of managed attribute groups. If an error 279257b8ff07SDmitry Torokhov * occurs when creating a group, all previously created groups will be 279357b8ff07SDmitry Torokhov * removed, unwinding everything back to the original state when this 279457b8ff07SDmitry Torokhov * function was called. It will explicitly warn and error if any of the 279557b8ff07SDmitry Torokhov * attribute files being created already exist. 279657b8ff07SDmitry Torokhov * 279757b8ff07SDmitry Torokhov * Returns 0 on success or error code from sysfs_create_group on failure. 279857b8ff07SDmitry Torokhov */ 279957b8ff07SDmitry Torokhov int devm_device_add_groups(struct device *dev, 280057b8ff07SDmitry Torokhov const struct attribute_group **groups) 280157b8ff07SDmitry Torokhov { 280257b8ff07SDmitry Torokhov union device_attr_group_devres *devres; 280357b8ff07SDmitry Torokhov int error; 280457b8ff07SDmitry Torokhov 280557b8ff07SDmitry Torokhov devres = devres_alloc(devm_attr_groups_remove, 280657b8ff07SDmitry Torokhov sizeof(*devres), GFP_KERNEL); 280757b8ff07SDmitry Torokhov if (!devres) 280857b8ff07SDmitry Torokhov return -ENOMEM; 280957b8ff07SDmitry Torokhov 281057b8ff07SDmitry Torokhov error = sysfs_create_groups(&dev->kobj, groups); 281157b8ff07SDmitry Torokhov if (error) { 281257b8ff07SDmitry Torokhov devres_free(devres); 281357b8ff07SDmitry Torokhov return error; 281457b8ff07SDmitry Torokhov } 281557b8ff07SDmitry Torokhov 281657b8ff07SDmitry Torokhov devres->groups = groups; 281757b8ff07SDmitry Torokhov devres_add(dev, devres); 281857b8ff07SDmitry Torokhov return 0; 281957b8ff07SDmitry Torokhov } 282057b8ff07SDmitry Torokhov EXPORT_SYMBOL_GPL(devm_device_add_groups); 282157b8ff07SDmitry Torokhov 28222620efefSGreg Kroah-Hartman static int device_add_attrs(struct device *dev) 28232620efefSGreg Kroah-Hartman { 28242620efefSGreg Kroah-Hartman struct class *class = dev->class; 2825aed65af1SStephen Hemminger const struct device_type *type = dev->type; 2826621a1672SDmitry Torokhov int error; 28272620efefSGreg Kroah-Hartman 2828621a1672SDmitry Torokhov if (class) { 2829d05a6f96SGreg Kroah-Hartman error = device_add_groups(dev, class->dev_groups); 28302620efefSGreg Kroah-Hartman if (error) 2831621a1672SDmitry Torokhov return error; 2832f9f852dfSKay Sievers } 2833f9f852dfSKay Sievers 2834621a1672SDmitry Torokhov if (type) { 2835621a1672SDmitry Torokhov error = device_add_groups(dev, type->groups); 2836f9f852dfSKay Sievers if (error) 2837a6b01dedSGreg Kroah-Hartman goto err_remove_class_groups; 2838f9f852dfSKay Sievers } 2839621a1672SDmitry Torokhov 2840621a1672SDmitry Torokhov error = device_add_groups(dev, dev->groups); 2841f9f852dfSKay Sievers if (error) 2842621a1672SDmitry Torokhov goto err_remove_type_groups; 2843621a1672SDmitry Torokhov 28444f3549d7SRafael J. Wysocki if (device_supports_offline(dev) && !dev->offline_disabled) { 2845c5e064a6SGreg Kroah-Hartman error = device_create_file(dev, &dev_attr_online); 28464f3549d7SRafael J. Wysocki if (error) 2847ecfbf6fdSRafael J. Wysocki goto err_remove_dev_groups; 28484f3549d7SRafael J. Wysocki } 28494f3549d7SRafael J. Wysocki 285025ac86c6SSaravana Kannan if (fw_devlink_flags && !fw_devlink_is_permissive() && dev->fwnode) { 2851da6d6475SSaravana Kannan error = device_create_file(dev, &dev_attr_waiting_for_supplier); 2852da6d6475SSaravana Kannan if (error) 2853da6d6475SSaravana Kannan goto err_remove_dev_online; 2854da6d6475SSaravana Kannan } 2855da6d6475SSaravana Kannan 285670f400d4SRajat Jain if (dev_removable_is_valid(dev)) { 285770f400d4SRajat Jain error = device_create_file(dev, &dev_attr_removable); 285870f400d4SRajat Jain if (error) 285970f400d4SRajat Jain goto err_remove_dev_waiting_for_supplier; 286070f400d4SRajat Jain } 286170f400d4SRajat Jain 28626423d295SWon Chung if (dev_add_physical_location(dev)) { 28636423d295SWon Chung error = device_add_group(dev, 28646423d295SWon Chung &dev_attr_physical_location_group); 28656423d295SWon Chung if (error) 28666423d295SWon Chung goto err_remove_dev_removable; 28676423d295SWon Chung } 28686423d295SWon Chung 2869621a1672SDmitry Torokhov return 0; 2870621a1672SDmitry Torokhov 28716423d295SWon Chung err_remove_dev_removable: 28726423d295SWon Chung device_remove_file(dev, &dev_attr_removable); 287370f400d4SRajat Jain err_remove_dev_waiting_for_supplier: 287470f400d4SRajat Jain device_remove_file(dev, &dev_attr_waiting_for_supplier); 2875da6d6475SSaravana Kannan err_remove_dev_online: 2876da6d6475SSaravana Kannan device_remove_file(dev, &dev_attr_online); 2877ecfbf6fdSRafael J. Wysocki err_remove_dev_groups: 2878ecfbf6fdSRafael J. Wysocki device_remove_groups(dev, dev->groups); 2879621a1672SDmitry Torokhov err_remove_type_groups: 2880621a1672SDmitry Torokhov if (type) 2881621a1672SDmitry Torokhov device_remove_groups(dev, type->groups); 2882d05a6f96SGreg Kroah-Hartman err_remove_class_groups: 2883d05a6f96SGreg Kroah-Hartman if (class) 2884d05a6f96SGreg Kroah-Hartman device_remove_groups(dev, class->dev_groups); 2885f9f852dfSKay Sievers 28862620efefSGreg Kroah-Hartman return error; 28872620efefSGreg Kroah-Hartman } 28882620efefSGreg Kroah-Hartman 28892620efefSGreg Kroah-Hartman static void device_remove_attrs(struct device *dev) 28902620efefSGreg Kroah-Hartman { 28912620efefSGreg Kroah-Hartman struct class *class = dev->class; 2892aed65af1SStephen Hemminger const struct device_type *type = dev->type; 28932620efefSGreg Kroah-Hartman 28946423d295SWon Chung if (dev->physical_location) { 28956423d295SWon Chung device_remove_group(dev, &dev_attr_physical_location_group); 28966423d295SWon Chung kfree(dev->physical_location); 28976423d295SWon Chung } 28986423d295SWon Chung 289970f400d4SRajat Jain device_remove_file(dev, &dev_attr_removable); 2900da6d6475SSaravana Kannan device_remove_file(dev, &dev_attr_waiting_for_supplier); 2901c5e064a6SGreg Kroah-Hartman device_remove_file(dev, &dev_attr_online); 2902621a1672SDmitry Torokhov device_remove_groups(dev, dev->groups); 2903f9f852dfSKay Sievers 2904621a1672SDmitry Torokhov if (type) 2905621a1672SDmitry Torokhov device_remove_groups(dev, type->groups); 2906621a1672SDmitry Torokhov 2907a6b01dedSGreg Kroah-Hartman if (class) 2908d05a6f96SGreg Kroah-Hartman device_remove_groups(dev, class->dev_groups); 2909c97415a7SStefan Achatz } 29102620efefSGreg Kroah-Hartman 2911c5e064a6SGreg Kroah-Hartman static ssize_t dev_show(struct device *dev, struct device_attribute *attr, 291223681e47SGreg Kroah-Hartman char *buf) 291323681e47SGreg Kroah-Hartman { 291423681e47SGreg Kroah-Hartman return print_dev_t(buf, dev->devt); 291523681e47SGreg Kroah-Hartman } 2916c5e064a6SGreg Kroah-Hartman static DEVICE_ATTR_RO(dev); 2917ad6a1e1cSTejun Heo 2918ca22e56dSKay Sievers /* /sys/devices/ */ 2919881c6cfdSGreg Kroah-Hartman struct kset *devices_kset; 29201da177e4SLinus Torvalds 29211da177e4SLinus Torvalds /** 292252cdbdd4SGrygorii Strashko * devices_kset_move_before - Move device in the devices_kset's list. 292352cdbdd4SGrygorii Strashko * @deva: Device to move. 292452cdbdd4SGrygorii Strashko * @devb: Device @deva should come before. 292552cdbdd4SGrygorii Strashko */ 292652cdbdd4SGrygorii Strashko static void devices_kset_move_before(struct device *deva, struct device *devb) 292752cdbdd4SGrygorii Strashko { 292852cdbdd4SGrygorii Strashko if (!devices_kset) 292952cdbdd4SGrygorii Strashko return; 293052cdbdd4SGrygorii Strashko pr_debug("devices_kset: Moving %s before %s\n", 293152cdbdd4SGrygorii Strashko dev_name(deva), dev_name(devb)); 293252cdbdd4SGrygorii Strashko spin_lock(&devices_kset->list_lock); 293352cdbdd4SGrygorii Strashko list_move_tail(&deva->kobj.entry, &devb->kobj.entry); 293452cdbdd4SGrygorii Strashko spin_unlock(&devices_kset->list_lock); 293552cdbdd4SGrygorii Strashko } 293652cdbdd4SGrygorii Strashko 293752cdbdd4SGrygorii Strashko /** 293852cdbdd4SGrygorii Strashko * devices_kset_move_after - Move device in the devices_kset's list. 293952cdbdd4SGrygorii Strashko * @deva: Device to move 294052cdbdd4SGrygorii Strashko * @devb: Device @deva should come after. 294152cdbdd4SGrygorii Strashko */ 294252cdbdd4SGrygorii Strashko static void devices_kset_move_after(struct device *deva, struct device *devb) 294352cdbdd4SGrygorii Strashko { 294452cdbdd4SGrygorii Strashko if (!devices_kset) 294552cdbdd4SGrygorii Strashko return; 294652cdbdd4SGrygorii Strashko pr_debug("devices_kset: Moving %s after %s\n", 294752cdbdd4SGrygorii Strashko dev_name(deva), dev_name(devb)); 294852cdbdd4SGrygorii Strashko spin_lock(&devices_kset->list_lock); 294952cdbdd4SGrygorii Strashko list_move(&deva->kobj.entry, &devb->kobj.entry); 295052cdbdd4SGrygorii Strashko spin_unlock(&devices_kset->list_lock); 295152cdbdd4SGrygorii Strashko } 295252cdbdd4SGrygorii Strashko 295352cdbdd4SGrygorii Strashko /** 295452cdbdd4SGrygorii Strashko * devices_kset_move_last - move the device to the end of devices_kset's list. 295552cdbdd4SGrygorii Strashko * @dev: device to move 295652cdbdd4SGrygorii Strashko */ 295752cdbdd4SGrygorii Strashko void devices_kset_move_last(struct device *dev) 295852cdbdd4SGrygorii Strashko { 295952cdbdd4SGrygorii Strashko if (!devices_kset) 296052cdbdd4SGrygorii Strashko return; 296152cdbdd4SGrygorii Strashko pr_debug("devices_kset: Moving %s to end of list\n", dev_name(dev)); 296252cdbdd4SGrygorii Strashko spin_lock(&devices_kset->list_lock); 296352cdbdd4SGrygorii Strashko list_move_tail(&dev->kobj.entry, &devices_kset->list); 296452cdbdd4SGrygorii Strashko spin_unlock(&devices_kset->list_lock); 296552cdbdd4SGrygorii Strashko } 296652cdbdd4SGrygorii Strashko 296752cdbdd4SGrygorii Strashko /** 29681da177e4SLinus Torvalds * device_create_file - create sysfs attribute file for device. 29691da177e4SLinus Torvalds * @dev: device. 29701da177e4SLinus Torvalds * @attr: device attribute descriptor. 29711da177e4SLinus Torvalds */ 297226579ab7SPhil Carmody int device_create_file(struct device *dev, 297326579ab7SPhil Carmody const struct device_attribute *attr) 29741da177e4SLinus Torvalds { 29751da177e4SLinus Torvalds int error = 0; 29768f46baaaSFelipe Balbi 29778f46baaaSFelipe Balbi if (dev) { 29788f46baaaSFelipe Balbi WARN(((attr->attr.mode & S_IWUGO) && !attr->store), 297997521978Sdyoung@redhat.com "Attribute %s: write permission without 'store'\n", 298097521978Sdyoung@redhat.com attr->attr.name); 29818f46baaaSFelipe Balbi WARN(((attr->attr.mode & S_IRUGO) && !attr->show), 298297521978Sdyoung@redhat.com "Attribute %s: read permission without 'show'\n", 298397521978Sdyoung@redhat.com attr->attr.name); 29841da177e4SLinus Torvalds error = sysfs_create_file(&dev->kobj, &attr->attr); 29858f46baaaSFelipe Balbi } 29868f46baaaSFelipe Balbi 29871da177e4SLinus Torvalds return error; 29881da177e4SLinus Torvalds } 298986df2687SDavid Graham White EXPORT_SYMBOL_GPL(device_create_file); 29901da177e4SLinus Torvalds 29911da177e4SLinus Torvalds /** 29921da177e4SLinus Torvalds * device_remove_file - remove sysfs attribute file. 29931da177e4SLinus Torvalds * @dev: device. 29941da177e4SLinus Torvalds * @attr: device attribute descriptor. 29951da177e4SLinus Torvalds */ 299626579ab7SPhil Carmody void device_remove_file(struct device *dev, 299726579ab7SPhil Carmody const struct device_attribute *attr) 29981da177e4SLinus Torvalds { 29990c98b19fSCornelia Huck if (dev) 30001da177e4SLinus Torvalds sysfs_remove_file(&dev->kobj, &attr->attr); 30011da177e4SLinus Torvalds } 300286df2687SDavid Graham White EXPORT_SYMBOL_GPL(device_remove_file); 30031da177e4SLinus Torvalds 30042589f188SGreg Kroah-Hartman /** 30056b0afc2aSTejun Heo * device_remove_file_self - remove sysfs attribute file from its own method. 30066b0afc2aSTejun Heo * @dev: device. 30076b0afc2aSTejun Heo * @attr: device attribute descriptor. 30086b0afc2aSTejun Heo * 30096b0afc2aSTejun Heo * See kernfs_remove_self() for details. 30106b0afc2aSTejun Heo */ 30116b0afc2aSTejun Heo bool device_remove_file_self(struct device *dev, 30126b0afc2aSTejun Heo const struct device_attribute *attr) 30136b0afc2aSTejun Heo { 30146b0afc2aSTejun Heo if (dev) 30156b0afc2aSTejun Heo return sysfs_remove_file_self(&dev->kobj, &attr->attr); 30166b0afc2aSTejun Heo else 30176b0afc2aSTejun Heo return false; 30186b0afc2aSTejun Heo } 30196b0afc2aSTejun Heo EXPORT_SYMBOL_GPL(device_remove_file_self); 30206b0afc2aSTejun Heo 30216b0afc2aSTejun Heo /** 30222589f188SGreg Kroah-Hartman * device_create_bin_file - create sysfs binary attribute file for device. 30232589f188SGreg Kroah-Hartman * @dev: device. 30242589f188SGreg Kroah-Hartman * @attr: device binary attribute descriptor. 30252589f188SGreg Kroah-Hartman */ 302666ecb92bSPhil Carmody int device_create_bin_file(struct device *dev, 302766ecb92bSPhil Carmody const struct bin_attribute *attr) 30282589f188SGreg Kroah-Hartman { 30292589f188SGreg Kroah-Hartman int error = -EINVAL; 30302589f188SGreg Kroah-Hartman if (dev) 30312589f188SGreg Kroah-Hartman error = sysfs_create_bin_file(&dev->kobj, attr); 30322589f188SGreg Kroah-Hartman return error; 30332589f188SGreg Kroah-Hartman } 30342589f188SGreg Kroah-Hartman EXPORT_SYMBOL_GPL(device_create_bin_file); 30352589f188SGreg Kroah-Hartman 30362589f188SGreg Kroah-Hartman /** 30372589f188SGreg Kroah-Hartman * device_remove_bin_file - remove sysfs binary attribute file 30382589f188SGreg Kroah-Hartman * @dev: device. 30392589f188SGreg Kroah-Hartman * @attr: device binary attribute descriptor. 30402589f188SGreg Kroah-Hartman */ 304166ecb92bSPhil Carmody void device_remove_bin_file(struct device *dev, 304266ecb92bSPhil Carmody const struct bin_attribute *attr) 30432589f188SGreg Kroah-Hartman { 30442589f188SGreg Kroah-Hartman if (dev) 30452589f188SGreg Kroah-Hartman sysfs_remove_bin_file(&dev->kobj, attr); 30462589f188SGreg Kroah-Hartman } 30472589f188SGreg Kroah-Hartman EXPORT_SYMBOL_GPL(device_remove_bin_file); 30482589f188SGreg Kroah-Hartman 304934bb61f9SJames Bottomley static void klist_children_get(struct klist_node *n) 305034bb61f9SJames Bottomley { 3051f791b8c8SGreg Kroah-Hartman struct device_private *p = to_device_private_parent(n); 3052f791b8c8SGreg Kroah-Hartman struct device *dev = p->device; 305334bb61f9SJames Bottomley 305434bb61f9SJames Bottomley get_device(dev); 305534bb61f9SJames Bottomley } 305634bb61f9SJames Bottomley 305734bb61f9SJames Bottomley static void klist_children_put(struct klist_node *n) 305834bb61f9SJames Bottomley { 3059f791b8c8SGreg Kroah-Hartman struct device_private *p = to_device_private_parent(n); 3060f791b8c8SGreg Kroah-Hartman struct device *dev = p->device; 306134bb61f9SJames Bottomley 306234bb61f9SJames Bottomley put_device(dev); 306334bb61f9SJames Bottomley } 306434bb61f9SJames Bottomley 30651da177e4SLinus Torvalds /** 30661da177e4SLinus Torvalds * device_initialize - init device structure. 30671da177e4SLinus Torvalds * @dev: device. 30681da177e4SLinus Torvalds * 30695739411aSCornelia Huck * This prepares the device for use by other layers by initializing 30705739411aSCornelia Huck * its fields. 30711da177e4SLinus Torvalds * It is the first half of device_register(), if called by 30725739411aSCornelia Huck * that function, though it can also be called separately, so one 30735739411aSCornelia Huck * may use @dev's fields. In particular, get_device()/put_device() 30745739411aSCornelia Huck * may be used for reference counting of @dev after calling this 30755739411aSCornelia Huck * function. 30765739411aSCornelia Huck * 3077b10d5efdSAlan Stern * All fields in @dev must be initialized by the caller to 0, except 3078b10d5efdSAlan Stern * for those explicitly set to some other value. The simplest 3079b10d5efdSAlan Stern * approach is to use kzalloc() to allocate the structure containing 3080b10d5efdSAlan Stern * @dev. 3081b10d5efdSAlan Stern * 30825739411aSCornelia Huck * NOTE: Use put_device() to give up your reference instead of freeing 30835739411aSCornelia Huck * @dev directly once you have called this function. 30841da177e4SLinus Torvalds */ 30851da177e4SLinus Torvalds void device_initialize(struct device *dev) 30861da177e4SLinus Torvalds { 3087881c6cfdSGreg Kroah-Hartman dev->kobj.kset = devices_kset; 3088f9cb074bSGreg Kroah-Hartman kobject_init(&dev->kobj, &device_ktype); 30891da177e4SLinus Torvalds INIT_LIST_HEAD(&dev->dma_pools); 30903142788bSThomas Gleixner mutex_init(&dev->mutex); 30911704f47bSPeter Zijlstra lockdep_set_novalidate_class(&dev->mutex); 30929ac7849eSTejun Heo spin_lock_init(&dev->devres_lock); 30939ac7849eSTejun Heo INIT_LIST_HEAD(&dev->devres_head); 30943b98aeafSAlan Stern device_pm_init(dev); 3095d460d7f7SMax Gurtovoy set_dev_node(dev, NUMA_NO_NODE); 30969ed98953SRafael J. Wysocki INIT_LIST_HEAD(&dev->links.consumers); 30979ed98953SRafael J. Wysocki INIT_LIST_HEAD(&dev->links.suppliers); 30983b052a3eSSaravana Kannan INIT_LIST_HEAD(&dev->links.defer_sync); 30999ed98953SRafael J. Wysocki dev->links.status = DL_DEV_NO_DRIVER; 31006d4e9a8eSChristoph Hellwig #if defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_DEVICE) || \ 31016d4e9a8eSChristoph Hellwig defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU) || \ 31026d4e9a8eSChristoph Hellwig defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU_ALL) 31036d4e9a8eSChristoph Hellwig dev->dma_coherent = dma_default_coherent; 31046d4e9a8eSChristoph Hellwig #endif 310569031f50SClaire Chang #ifdef CONFIG_SWIOTLB 3106463e862aSWill Deacon dev->dma_io_tlb_mem = &io_tlb_default_mem; 310769031f50SClaire Chang #endif 31081da177e4SLinus Torvalds } 310986df2687SDavid Graham White EXPORT_SYMBOL_GPL(device_initialize); 31101da177e4SLinus Torvalds 3111d73ce004STejun Heo struct kobject *virtual_device_parent(struct device *dev) 3112f0ee61a6SGreg Kroah-Hartman { 3113f0ee61a6SGreg Kroah-Hartman static struct kobject *virtual_dir = NULL; 3114f0ee61a6SGreg Kroah-Hartman 3115f0ee61a6SGreg Kroah-Hartman if (!virtual_dir) 31164ff6abffSGreg Kroah-Hartman virtual_dir = kobject_create_and_add("virtual", 3117881c6cfdSGreg Kroah-Hartman &devices_kset->kobj); 3118f0ee61a6SGreg Kroah-Hartman 311986406245SKay Sievers return virtual_dir; 3120f0ee61a6SGreg Kroah-Hartman } 3121f0ee61a6SGreg Kroah-Hartman 3122bc451f20SEric W. Biederman struct class_dir { 3123bc451f20SEric W. Biederman struct kobject kobj; 3124bc451f20SEric W. Biederman struct class *class; 3125bc451f20SEric W. Biederman }; 3126bc451f20SEric W. Biederman 3127bc451f20SEric W. Biederman #define to_class_dir(obj) container_of(obj, struct class_dir, kobj) 3128bc451f20SEric W. Biederman 3129bc451f20SEric W. Biederman static void class_dir_release(struct kobject *kobj) 3130bc451f20SEric W. Biederman { 3131bc451f20SEric W. Biederman struct class_dir *dir = to_class_dir(kobj); 3132bc451f20SEric W. Biederman kfree(dir); 3133bc451f20SEric W. Biederman } 3134bc451f20SEric W. Biederman 3135bc451f20SEric W. Biederman static const 313602a476d9SGreg Kroah-Hartman struct kobj_ns_type_operations *class_dir_child_ns_type(const struct kobject *kobj) 3137bc451f20SEric W. Biederman { 313802a476d9SGreg Kroah-Hartman const struct class_dir *dir = to_class_dir(kobj); 3139bc451f20SEric W. Biederman return dir->class->ns_type; 3140bc451f20SEric W. Biederman } 3141bc451f20SEric W. Biederman 3142c83d9ab4SThomas Weißschuh static const struct kobj_type class_dir_ktype = { 3143bc451f20SEric W. Biederman .release = class_dir_release, 3144bc451f20SEric W. Biederman .sysfs_ops = &kobj_sysfs_ops, 3145bc451f20SEric W. Biederman .child_ns_type = class_dir_child_ns_type 3146bc451f20SEric W. Biederman }; 3147bc451f20SEric W. Biederman 3148bc451f20SEric W. Biederman static struct kobject * 3149bc451f20SEric W. Biederman class_dir_create_and_add(struct class *class, struct kobject *parent_kobj) 3150bc451f20SEric W. Biederman { 3151bc451f20SEric W. Biederman struct class_dir *dir; 3152bc451f20SEric W. Biederman int retval; 3153bc451f20SEric W. Biederman 3154bc451f20SEric W. Biederman dir = kzalloc(sizeof(*dir), GFP_KERNEL); 3155bc451f20SEric W. Biederman if (!dir) 315684d0c27dSTetsuo Handa return ERR_PTR(-ENOMEM); 3157bc451f20SEric W. Biederman 3158bc451f20SEric W. Biederman dir->class = class; 3159bc451f20SEric W. Biederman kobject_init(&dir->kobj, &class_dir_ktype); 3160bc451f20SEric W. Biederman 31616b6e39a6SKay Sievers dir->kobj.kset = &class->p->glue_dirs; 3162bc451f20SEric W. Biederman 3163bc451f20SEric W. Biederman retval = kobject_add(&dir->kobj, parent_kobj, "%s", class->name); 3164bc451f20SEric W. Biederman if (retval < 0) { 3165bc451f20SEric W. Biederman kobject_put(&dir->kobj); 316684d0c27dSTetsuo Handa return ERR_PTR(retval); 3167bc451f20SEric W. Biederman } 3168bc451f20SEric W. Biederman return &dir->kobj; 3169bc451f20SEric W. Biederman } 3170bc451f20SEric W. Biederman 3171e4a60d13SYijing Wang static DEFINE_MUTEX(gdp_mutex); 3172bc451f20SEric W. Biederman 3173c744aeaeSCornelia Huck static struct kobject *get_device_parent(struct device *dev, 3174c744aeaeSCornelia Huck struct device *parent) 317540fa5422SGreg Kroah-Hartman { 317686406245SKay Sievers struct kobject *kobj = NULL; 31778c99377eSGreg Kroah-Hartman 31788c99377eSGreg Kroah-Hartman if (dev->class) { 317986406245SKay Sievers struct kobject *parent_kobj; 318086406245SKay Sievers struct kobject *k; 318186406245SKay Sievers 318286406245SKay Sievers /* 318386406245SKay Sievers * If we have no parent, we live in "virtual". 31840f4dafc0SKay Sievers * Class-devices with a non class-device as parent, live 31850f4dafc0SKay Sievers * in a "glue" directory to prevent namespace collisions. 318686406245SKay Sievers */ 318786406245SKay Sievers if (parent == NULL) 318886406245SKay Sievers parent_kobj = virtual_device_parent(dev); 318924b1442dSEric W. Biederman else if (parent->class && !dev->class->ns_type) 319086406245SKay Sievers return &parent->kobj; 319186406245SKay Sievers else 319286406245SKay Sievers parent_kobj = &parent->kobj; 319386406245SKay Sievers 319477d3d7c1STejun Heo mutex_lock(&gdp_mutex); 319577d3d7c1STejun Heo 319686406245SKay Sievers /* find our class-directory at the parent and reference it */ 31976b6e39a6SKay Sievers spin_lock(&dev->class->p->glue_dirs.list_lock); 31986b6e39a6SKay Sievers list_for_each_entry(k, &dev->class->p->glue_dirs.list, entry) 319986406245SKay Sievers if (k->parent == parent_kobj) { 320086406245SKay Sievers kobj = kobject_get(k); 320186406245SKay Sievers break; 320286406245SKay Sievers } 32036b6e39a6SKay Sievers spin_unlock(&dev->class->p->glue_dirs.list_lock); 320477d3d7c1STejun Heo if (kobj) { 320577d3d7c1STejun Heo mutex_unlock(&gdp_mutex); 320686406245SKay Sievers return kobj; 320777d3d7c1STejun Heo } 320886406245SKay Sievers 320986406245SKay Sievers /* or create a new class-directory at the parent device */ 3210bc451f20SEric W. Biederman k = class_dir_create_and_add(dev->class, parent_kobj); 32110f4dafc0SKay Sievers /* do not emit an uevent for this simple "glue" directory */ 321277d3d7c1STejun Heo mutex_unlock(&gdp_mutex); 321343968d2fSGreg Kroah-Hartman return k; 321486406245SKay Sievers } 321586406245SKay Sievers 3216ca22e56dSKay Sievers /* subsystems can specify a default root directory for their devices */ 32178c99377eSGreg Kroah-Hartman if (!parent && dev->bus) { 32188c99377eSGreg Kroah-Hartman struct device *dev_root = bus_get_dev_root(dev->bus); 32198c99377eSGreg Kroah-Hartman 32208c99377eSGreg Kroah-Hartman if (dev_root) { 32218c99377eSGreg Kroah-Hartman kobj = &dev_root->kobj; 32228c99377eSGreg Kroah-Hartman put_device(dev_root); 32238c99377eSGreg Kroah-Hartman return kobj; 32248c99377eSGreg Kroah-Hartman } 32258c99377eSGreg Kroah-Hartman } 3226ca22e56dSKay Sievers 322786406245SKay Sievers if (parent) 3228c744aeaeSCornelia Huck return &parent->kobj; 3229c744aeaeSCornelia Huck return NULL; 3230c744aeaeSCornelia Huck } 3231da231fd5SKay Sievers 3232cebf8fd1SMing Lei static inline bool live_in_glue_dir(struct kobject *kobj, 3233cebf8fd1SMing Lei struct device *dev) 3234cebf8fd1SMing Lei { 3235cebf8fd1SMing Lei if (!kobj || !dev->class || 3236cebf8fd1SMing Lei kobj->kset != &dev->class->p->glue_dirs) 3237cebf8fd1SMing Lei return false; 3238cebf8fd1SMing Lei return true; 3239cebf8fd1SMing Lei } 3240cebf8fd1SMing Lei 3241cebf8fd1SMing Lei static inline struct kobject *get_glue_dir(struct device *dev) 3242cebf8fd1SMing Lei { 3243cebf8fd1SMing Lei return dev->kobj.parent; 3244cebf8fd1SMing Lei } 3245cebf8fd1SMing Lei 3246f0832664SIngo Molnar /** 3247f0832664SIngo Molnar * kobject_has_children - Returns whether a kobject has children. 3248f0832664SIngo Molnar * @kobj: the object to test 3249f0832664SIngo Molnar * 3250f0832664SIngo Molnar * This will return whether a kobject has other kobjects as children. 3251f0832664SIngo Molnar * 3252f0832664SIngo Molnar * It does NOT account for the presence of attribute files, only sub 3253f0832664SIngo Molnar * directories. It also assumes there is no concurrent addition or 3254f0832664SIngo Molnar * removal of such children, and thus relies on external locking. 3255f0832664SIngo Molnar */ 3256f0832664SIngo Molnar static inline bool kobject_has_children(struct kobject *kobj) 3257f0832664SIngo Molnar { 3258f0832664SIngo Molnar WARN_ON_ONCE(kref_read(&kobj->kref) == 0); 3259f0832664SIngo Molnar 3260f0832664SIngo Molnar return kobj->sd && kobj->sd->dir.subdirs; 3261f0832664SIngo Molnar } 3262f0832664SIngo Molnar 3263cebf8fd1SMing Lei /* 3264cebf8fd1SMing Lei * make sure cleaning up dir as the last step, we need to make 3265cebf8fd1SMing Lei * sure .release handler of kobject is run with holding the 3266cebf8fd1SMing Lei * global lock 3267cebf8fd1SMing Lei */ 326863b6971aSCornelia Huck static void cleanup_glue_dir(struct device *dev, struct kobject *glue_dir) 3269da231fd5SKay Sievers { 3270ac43432cSMuchun Song unsigned int ref; 3271ac43432cSMuchun Song 32720f4dafc0SKay Sievers /* see if we live in a "glue" directory */ 3273cebf8fd1SMing Lei if (!live_in_glue_dir(glue_dir, dev)) 3274da231fd5SKay Sievers return; 3275da231fd5SKay Sievers 3276e4a60d13SYijing Wang mutex_lock(&gdp_mutex); 3277ac43432cSMuchun Song /** 3278ac43432cSMuchun Song * There is a race condition between removing glue directory 3279ac43432cSMuchun Song * and adding a new device under the glue directory. 3280ac43432cSMuchun Song * 3281ac43432cSMuchun Song * CPU1: CPU2: 3282ac43432cSMuchun Song * 3283ac43432cSMuchun Song * device_add() 3284ac43432cSMuchun Song * get_device_parent() 3285ac43432cSMuchun Song * class_dir_create_and_add() 3286ac43432cSMuchun Song * kobject_add_internal() 3287ac43432cSMuchun Song * create_dir() // create glue_dir 3288ac43432cSMuchun Song * 3289ac43432cSMuchun Song * device_add() 3290ac43432cSMuchun Song * get_device_parent() 3291ac43432cSMuchun Song * kobject_get() // get glue_dir 3292ac43432cSMuchun Song * 3293ac43432cSMuchun Song * device_del() 3294ac43432cSMuchun Song * cleanup_glue_dir() 3295ac43432cSMuchun Song * kobject_del(glue_dir) 3296ac43432cSMuchun Song * 3297ac43432cSMuchun Song * kobject_add() 3298ac43432cSMuchun Song * kobject_add_internal() 3299ac43432cSMuchun Song * create_dir() // in glue_dir 3300ac43432cSMuchun Song * sysfs_create_dir_ns() 3301ac43432cSMuchun Song * kernfs_create_dir_ns(sd) 3302ac43432cSMuchun Song * 3303ac43432cSMuchun Song * sysfs_remove_dir() // glue_dir->sd=NULL 3304ac43432cSMuchun Song * sysfs_put() // free glue_dir->sd 3305ac43432cSMuchun Song * 3306ac43432cSMuchun Song * // sd is freed 3307ac43432cSMuchun Song * kernfs_new_node(sd) 3308ac43432cSMuchun Song * kernfs_get(glue_dir) 3309ac43432cSMuchun Song * kernfs_add_one() 3310ac43432cSMuchun Song * kernfs_put() 3311ac43432cSMuchun Song * 3312ac43432cSMuchun Song * Before CPU1 remove last child device under glue dir, if CPU2 add 3313ac43432cSMuchun Song * a new device under glue dir, the glue_dir kobject reference count 3314ac43432cSMuchun Song * will be increase to 2 in kobject_get(k). And CPU2 has been called 3315ac43432cSMuchun Song * kernfs_create_dir_ns(). Meanwhile, CPU1 call sysfs_remove_dir() 3316ac43432cSMuchun Song * and sysfs_put(). This result in glue_dir->sd is freed. 3317ac43432cSMuchun Song * 3318ac43432cSMuchun Song * Then the CPU2 will see a stale "empty" but still potentially used 3319ac43432cSMuchun Song * glue dir around in kernfs_new_node(). 3320ac43432cSMuchun Song * 3321ac43432cSMuchun Song * In order to avoid this happening, we also should make sure that 3322ac43432cSMuchun Song * kernfs_node for glue_dir is released in CPU1 only when refcount 3323ac43432cSMuchun Song * for glue_dir kobj is 1. 3324ac43432cSMuchun Song */ 3325ac43432cSMuchun Song ref = kref_read(&glue_dir->kref); 3326ac43432cSMuchun Song if (!kobject_has_children(glue_dir) && !--ref) 3327726e4109SBenjamin Herrenschmidt kobject_del(glue_dir); 33280f4dafc0SKay Sievers kobject_put(glue_dir); 3329e4a60d13SYijing Wang mutex_unlock(&gdp_mutex); 3330da231fd5SKay Sievers } 333163b6971aSCornelia Huck 33322ee97cafSCornelia Huck static int device_add_class_symlinks(struct device *dev) 33332ee97cafSCornelia Huck { 33345590f319SBenjamin Herrenschmidt struct device_node *of_node = dev_of_node(dev); 33352ee97cafSCornelia Huck int error; 33362ee97cafSCornelia Huck 33375590f319SBenjamin Herrenschmidt if (of_node) { 33380c3c234bSRob Herring error = sysfs_create_link(&dev->kobj, of_node_kobj(of_node), "of_node"); 33395590f319SBenjamin Herrenschmidt if (error) 33405590f319SBenjamin Herrenschmidt dev_warn(dev, "Error %d creating of_node link\n",error); 33415590f319SBenjamin Herrenschmidt /* An error here doesn't warrant bringing down the device */ 33425590f319SBenjamin Herrenschmidt } 33435590f319SBenjamin Herrenschmidt 33442ee97cafSCornelia Huck if (!dev->class) 33452ee97cafSCornelia Huck return 0; 3346da231fd5SKay Sievers 33471fbfee6cSGreg Kroah-Hartman error = sysfs_create_link(&dev->kobj, 33486b6e39a6SKay Sievers &dev->class->p->subsys.kobj, 33492ee97cafSCornelia Huck "subsystem"); 33502ee97cafSCornelia Huck if (error) 33515590f319SBenjamin Herrenschmidt goto out_devnode; 3352da231fd5SKay Sievers 33534e886c29SGreg Kroah-Hartman if (dev->parent && device_is_not_partition(dev)) { 33544f01a757SDmitry Torokhov error = sysfs_create_link(&dev->kobj, &dev->parent->kobj, 33554f01a757SDmitry Torokhov "device"); 33564f01a757SDmitry Torokhov if (error) 335739aba963SKay Sievers goto out_subsys; 33582ee97cafSCornelia Huck } 335939aba963SKay Sievers 336039aba963SKay Sievers /* link in the class directory pointing to the device */ 33616b6e39a6SKay Sievers error = sysfs_create_link(&dev->class->p->subsys.kobj, 336239aba963SKay Sievers &dev->kobj, dev_name(dev)); 336339aba963SKay Sievers if (error) 336439aba963SKay Sievers goto out_device; 336539aba963SKay Sievers 33662ee97cafSCornelia Huck return 0; 33672ee97cafSCornelia Huck 336839aba963SKay Sievers out_device: 336939aba963SKay Sievers sysfs_remove_link(&dev->kobj, "device"); 3370da231fd5SKay Sievers 33712ee97cafSCornelia Huck out_subsys: 33722ee97cafSCornelia Huck sysfs_remove_link(&dev->kobj, "subsystem"); 33735590f319SBenjamin Herrenschmidt out_devnode: 33745590f319SBenjamin Herrenschmidt sysfs_remove_link(&dev->kobj, "of_node"); 33752ee97cafSCornelia Huck return error; 33762ee97cafSCornelia Huck } 33772ee97cafSCornelia Huck 33782ee97cafSCornelia Huck static void device_remove_class_symlinks(struct device *dev) 33792ee97cafSCornelia Huck { 33805590f319SBenjamin Herrenschmidt if (dev_of_node(dev)) 33815590f319SBenjamin Herrenschmidt sysfs_remove_link(&dev->kobj, "of_node"); 33825590f319SBenjamin Herrenschmidt 33832ee97cafSCornelia Huck if (!dev->class) 33842ee97cafSCornelia Huck return; 3385da231fd5SKay Sievers 33864e886c29SGreg Kroah-Hartman if (dev->parent && device_is_not_partition(dev)) 3387da231fd5SKay Sievers sysfs_remove_link(&dev->kobj, "device"); 33882ee97cafSCornelia Huck sysfs_remove_link(&dev->kobj, "subsystem"); 33896b6e39a6SKay Sievers sysfs_delete_link(&dev->class->p->subsys.kobj, &dev->kobj, dev_name(dev)); 33902ee97cafSCornelia Huck } 33912ee97cafSCornelia Huck 33921da177e4SLinus Torvalds /** 3393413c239fSStephen Rothwell * dev_set_name - set a device name 3394413c239fSStephen Rothwell * @dev: device 339546232366SRandy Dunlap * @fmt: format string for the device's name 3396413c239fSStephen Rothwell */ 3397413c239fSStephen Rothwell int dev_set_name(struct device *dev, const char *fmt, ...) 3398413c239fSStephen Rothwell { 3399413c239fSStephen Rothwell va_list vargs; 34001fa5ae85SKay Sievers int err; 3401413c239fSStephen Rothwell 3402413c239fSStephen Rothwell va_start(vargs, fmt); 34031fa5ae85SKay Sievers err = kobject_set_name_vargs(&dev->kobj, fmt, vargs); 3404413c239fSStephen Rothwell va_end(vargs); 34051fa5ae85SKay Sievers return err; 3406413c239fSStephen Rothwell } 3407413c239fSStephen Rothwell EXPORT_SYMBOL_GPL(dev_set_name); 3408413c239fSStephen Rothwell 3409413c239fSStephen Rothwell /** 3410e105b8bfSDan Williams * device_to_dev_kobj - select a /sys/dev/ directory for the device 3411e105b8bfSDan Williams * @dev: device 3412e105b8bfSDan Williams * 3413e105b8bfSDan Williams * By default we select char/ for new entries. Setting class->dev_obj 3414e105b8bfSDan Williams * to NULL prevents an entry from being created. class->dev_kobj must 3415e105b8bfSDan Williams * be set (or cleared) before any devices are registered to the class 3416e105b8bfSDan Williams * otherwise device_create_sys_dev_entry() and 34170d4e293cSPeter Korsgaard * device_remove_sys_dev_entry() will disagree about the presence of 34180d4e293cSPeter Korsgaard * the link. 3419e105b8bfSDan Williams */ 3420e105b8bfSDan Williams static struct kobject *device_to_dev_kobj(struct device *dev) 3421e105b8bfSDan Williams { 3422e105b8bfSDan Williams struct kobject *kobj; 3423e105b8bfSDan Williams 3424e105b8bfSDan Williams if (dev->class) 3425e105b8bfSDan Williams kobj = dev->class->dev_kobj; 3426e105b8bfSDan Williams else 3427e105b8bfSDan Williams kobj = sysfs_dev_char_kobj; 3428e105b8bfSDan Williams 3429e105b8bfSDan Williams return kobj; 3430e105b8bfSDan Williams } 3431e105b8bfSDan Williams 3432e105b8bfSDan Williams static int device_create_sys_dev_entry(struct device *dev) 3433e105b8bfSDan Williams { 3434e105b8bfSDan Williams struct kobject *kobj = device_to_dev_kobj(dev); 3435e105b8bfSDan Williams int error = 0; 3436e105b8bfSDan Williams char devt_str[15]; 3437e105b8bfSDan Williams 3438e105b8bfSDan Williams if (kobj) { 3439e105b8bfSDan Williams format_dev_t(devt_str, dev->devt); 3440e105b8bfSDan Williams error = sysfs_create_link(kobj, &dev->kobj, devt_str); 3441e105b8bfSDan Williams } 3442e105b8bfSDan Williams 3443e105b8bfSDan Williams return error; 3444e105b8bfSDan Williams } 3445e105b8bfSDan Williams 3446e105b8bfSDan Williams static void device_remove_sys_dev_entry(struct device *dev) 3447e105b8bfSDan Williams { 3448e105b8bfSDan Williams struct kobject *kobj = device_to_dev_kobj(dev); 3449e105b8bfSDan Williams char devt_str[15]; 3450e105b8bfSDan Williams 3451e105b8bfSDan Williams if (kobj) { 3452e105b8bfSDan Williams format_dev_t(devt_str, dev->devt); 3453e105b8bfSDan Williams sysfs_remove_link(kobj, devt_str); 3454e105b8bfSDan Williams } 3455e105b8bfSDan Williams } 3456e105b8bfSDan Williams 345746d3a037SShaokun Zhang static int device_private_init(struct device *dev) 3458b4028437SGreg Kroah-Hartman { 3459b4028437SGreg Kroah-Hartman dev->p = kzalloc(sizeof(*dev->p), GFP_KERNEL); 3460b4028437SGreg Kroah-Hartman if (!dev->p) 3461b4028437SGreg Kroah-Hartman return -ENOMEM; 3462b4028437SGreg Kroah-Hartman dev->p->device = dev; 3463b4028437SGreg Kroah-Hartman klist_init(&dev->p->klist_children, klist_children_get, 3464b4028437SGreg Kroah-Hartman klist_children_put); 3465ef8a3fd6SGreg Kroah-Hartman INIT_LIST_HEAD(&dev->p->deferred_probe); 3466b4028437SGreg Kroah-Hartman return 0; 3467b4028437SGreg Kroah-Hartman } 3468b4028437SGreg Kroah-Hartman 3469e105b8bfSDan Williams /** 34701da177e4SLinus Torvalds * device_add - add device to device hierarchy. 34711da177e4SLinus Torvalds * @dev: device. 34721da177e4SLinus Torvalds * 34731da177e4SLinus Torvalds * This is part 2 of device_register(), though may be called 34741da177e4SLinus Torvalds * separately _iff_ device_initialize() has been called separately. 34751da177e4SLinus Torvalds * 34765739411aSCornelia Huck * This adds @dev to the kobject hierarchy via kobject_add(), adds it 34771da177e4SLinus Torvalds * to the global and sibling lists for the device, then 34781da177e4SLinus Torvalds * adds it to the other relevant subsystems of the driver model. 34795739411aSCornelia Huck * 3480b10d5efdSAlan Stern * Do not call this routine or device_register() more than once for 3481b10d5efdSAlan Stern * any device structure. The driver model core is not designed to work 3482b10d5efdSAlan Stern * with devices that get unregistered and then spring back to life. 3483b10d5efdSAlan Stern * (Among other things, it's very hard to guarantee that all references 3484b10d5efdSAlan Stern * to the previous incarnation of @dev have been dropped.) Allocate 3485b10d5efdSAlan Stern * and register a fresh new struct device instead. 3486b10d5efdSAlan Stern * 34875739411aSCornelia Huck * NOTE: _Never_ directly free @dev after calling this function, even 34885739411aSCornelia Huck * if it returned an error! Always use put_device() to give up your 34895739411aSCornelia Huck * reference instead. 3490affada72SBorislav Petkov * 3491affada72SBorislav Petkov * Rule of thumb is: if device_add() succeeds, you should call 3492affada72SBorislav Petkov * device_del() when you want to get rid of it. If device_add() has 3493affada72SBorislav Petkov * *not* succeeded, use *only* put_device() to drop the reference 3494affada72SBorislav Petkov * count. 34951da177e4SLinus Torvalds */ 34961da177e4SLinus Torvalds int device_add(struct device *dev) 34971da177e4SLinus Torvalds { 349835dbf4efSViresh Kumar struct device *parent; 3499ca22e56dSKay Sievers struct kobject *kobj; 3500c47ed219SGreg Kroah-Hartman struct class_interface *class_intf; 35015f5377eaSSaravana Kannan int error = -EINVAL; 3502cebf8fd1SMing Lei struct kobject *glue_dir = NULL; 3503775b64d2SRafael J. Wysocki 35041da177e4SLinus Torvalds dev = get_device(dev); 3505c906a48aSGreg Kroah-Hartman if (!dev) 3506c906a48aSGreg Kroah-Hartman goto done; 3507c906a48aSGreg Kroah-Hartman 3508fb069a5dSGreg Kroah-Hartman if (!dev->p) { 3509b4028437SGreg Kroah-Hartman error = device_private_init(dev); 3510b4028437SGreg Kroah-Hartman if (error) 3511fb069a5dSGreg Kroah-Hartman goto done; 3512fb069a5dSGreg Kroah-Hartman } 3513fb069a5dSGreg Kroah-Hartman 35141fa5ae85SKay Sievers /* 35151fa5ae85SKay Sievers * for statically allocated devices, which should all be converted 35161fa5ae85SKay Sievers * some day, we need to initialize the name. We prevent reading back 35171fa5ae85SKay Sievers * the name, and force the use of dev_name() 35181fa5ae85SKay Sievers */ 35191fa5ae85SKay Sievers if (dev->init_name) { 3520acc0e90fSGreg Kroah-Hartman dev_set_name(dev, "%s", dev->init_name); 35211fa5ae85SKay Sievers dev->init_name = NULL; 35221fa5ae85SKay Sievers } 3523c906a48aSGreg Kroah-Hartman 3524ca22e56dSKay Sievers /* subsystems can specify simple device enumeration */ 3525ca22e56dSKay Sievers if (!dev_name(dev) && dev->bus && dev->bus->dev_name) 3526ca22e56dSKay Sievers dev_set_name(dev, "%s%u", dev->bus->dev_name, dev->id); 3527ca22e56dSKay Sievers 3528e6309e75SThomas Gleixner if (!dev_name(dev)) { 3529e6309e75SThomas Gleixner error = -EINVAL; 35305c8563d7SKay Sievers goto name_error; 3531e6309e75SThomas Gleixner } 35321da177e4SLinus Torvalds 35331e0b2cf9SKay Sievers pr_debug("device: '%s': %s\n", dev_name(dev), __func__); 3534c205ef48SGreg Kroah-Hartman 35351da177e4SLinus Torvalds parent = get_device(dev->parent); 3536ca22e56dSKay Sievers kobj = get_device_parent(dev, parent); 353784d0c27dSTetsuo Handa if (IS_ERR(kobj)) { 353884d0c27dSTetsuo Handa error = PTR_ERR(kobj); 353984d0c27dSTetsuo Handa goto parent_error; 354084d0c27dSTetsuo Handa } 3541ca22e56dSKay Sievers if (kobj) 3542ca22e56dSKay Sievers dev->kobj.parent = kobj; 35431da177e4SLinus Torvalds 35440d358f22SYinghai Lu /* use parent numa_node */ 354556f2de81SZhen Lei if (parent && (dev_to_node(dev) == NUMA_NO_NODE)) 35460d358f22SYinghai Lu set_dev_node(dev, dev_to_node(parent)); 35470d358f22SYinghai Lu 35481da177e4SLinus Torvalds /* first, register with generic layer. */ 35498a577ffcSKay Sievers /* we require the name to be set before, and pass NULL */ 35508a577ffcSKay Sievers error = kobject_add(&dev->kobj, dev->kobj.parent, NULL); 3551cebf8fd1SMing Lei if (error) { 35526977b1a5SZhengchao Shao glue_dir = kobj; 35531da177e4SLinus Torvalds goto Error; 3554cebf8fd1SMing Lei } 3555a7fd6706SKay Sievers 355637022644SBrian Walsh /* notify platform of device entry */ 3557b2ebd9ddSRafael J. Wysocki device_platform_notify(dev); 355837022644SBrian Walsh 3559c5e064a6SGreg Kroah-Hartman error = device_create_file(dev, &dev_attr_uevent); 3560a306eea4SCornelia Huck if (error) 3561a306eea4SCornelia Huck goto attrError; 3562a7fd6706SKay Sievers 35632ee97cafSCornelia Huck error = device_add_class_symlinks(dev); 35642ee97cafSCornelia Huck if (error) 35652ee97cafSCornelia Huck goto SymlinkError; 3566dc0afa83SCornelia Huck error = device_add_attrs(dev); 3567dc0afa83SCornelia Huck if (error) 35682620efefSGreg Kroah-Hartman goto AttrsError; 3569dc0afa83SCornelia Huck error = bus_add_device(dev); 3570dc0afa83SCornelia Huck if (error) 35711da177e4SLinus Torvalds goto BusError; 35723b98aeafSAlan Stern error = dpm_sysfs_add(dev); 357357eee3d2SRafael J. Wysocki if (error) 35743b98aeafSAlan Stern goto DPMError; 35753b98aeafSAlan Stern device_pm_add(dev); 3576ec0676eeSAlan Stern 35770cd75047SSergey Klyaus if (MAJOR(dev->devt)) { 35780cd75047SSergey Klyaus error = device_create_file(dev, &dev_attr_dev); 35790cd75047SSergey Klyaus if (error) 35800cd75047SSergey Klyaus goto DevAttrError; 35810cd75047SSergey Klyaus 35820cd75047SSergey Klyaus error = device_create_sys_dev_entry(dev); 35830cd75047SSergey Klyaus if (error) 35840cd75047SSergey Klyaus goto SysEntryError; 35850cd75047SSergey Klyaus 35860cd75047SSergey Klyaus devtmpfs_create_node(dev); 35870cd75047SSergey Klyaus } 35880cd75047SSergey Klyaus 3589ec0676eeSAlan Stern /* Notify clients of device addition. This call must come 3590268863f4Smajianpeng * after dpm_sysfs_add() and before kobject_uevent(). 3591ec0676eeSAlan Stern */ 3592ed9f9181SGreg Kroah-Hartman bus_notify(dev, BUS_NOTIFY_ADD_DEVICE); 359353877d06SKay Sievers kobject_uevent(&dev->kobj, KOBJ_ADD); 3594372a67c0SSaravana Kannan 3595e2ae9bccSSaravana Kannan /* 3596e2ae9bccSSaravana Kannan * Check if any of the other devices (consumers) have been waiting for 3597e2ae9bccSSaravana Kannan * this device (supplier) to be added so that they can create a device 3598e2ae9bccSSaravana Kannan * link to it. 3599e2ae9bccSSaravana Kannan * 3600e2ae9bccSSaravana Kannan * This needs to happen after device_pm_add() because device_link_add() 3601e2ae9bccSSaravana Kannan * requires the supplier be registered before it's called. 3602e2ae9bccSSaravana Kannan * 36032cd38fd1SSaravana Kannan * But this also needs to happen before bus_probe_device() to make sure 3604e2ae9bccSSaravana Kannan * waiting consumers can link to it before the driver is bound to the 3605e2ae9bccSSaravana Kannan * device and the driver sync_state callback is called for this device. 3606e2ae9bccSSaravana Kannan */ 36072cd38fd1SSaravana Kannan if (dev->fwnode && !dev->fwnode->dev) { 36082cd38fd1SSaravana Kannan dev->fwnode->dev = dev; 36095f5377eaSSaravana Kannan fw_devlink_link_device(dev); 361003324507SSaravana Kannan } 3611e2ae9bccSSaravana Kannan 36122023c610SAlan Stern bus_probe_device(dev); 3613d46f3e3eSSaravana Kannan 3614d46f3e3eSSaravana Kannan /* 3615d46f3e3eSSaravana Kannan * If all driver registration is done and a newly added device doesn't 3616d46f3e3eSSaravana Kannan * match with any driver, don't block its consumers from probing in 3617d46f3e3eSSaravana Kannan * case the consumer device is able to operate without this supplier. 3618d46f3e3eSSaravana Kannan */ 3619d46f3e3eSSaravana Kannan if (dev->fwnode && fw_devlink_drv_reg_done && !dev->can_match) 3620d46f3e3eSSaravana Kannan fw_devlink_unblock_consumers(dev); 3621d46f3e3eSSaravana Kannan 36221da177e4SLinus Torvalds if (parent) 3623f791b8c8SGreg Kroah-Hartman klist_add_tail(&dev->p->knode_parent, 3624f791b8c8SGreg Kroah-Hartman &parent->p->klist_children); 36251da177e4SLinus Torvalds 36265d9fd169SGreg Kroah-Hartman if (dev->class) { 3627ca22e56dSKay Sievers mutex_lock(&dev->class->p->mutex); 3628c47ed219SGreg Kroah-Hartman /* tie the class to the device */ 3629570d0200SWei Yang klist_add_tail(&dev->p->knode_class, 36306b6e39a6SKay Sievers &dev->class->p->klist_devices); 3631c47ed219SGreg Kroah-Hartman 3632c47ed219SGreg Kroah-Hartman /* notify any interfaces that the device is here */ 3633184f1f77SGreg Kroah-Hartman list_for_each_entry(class_intf, 3634ca22e56dSKay Sievers &dev->class->p->interfaces, node) 3635c47ed219SGreg Kroah-Hartman if (class_intf->add_dev) 3636c47ed219SGreg Kroah-Hartman class_intf->add_dev(dev, class_intf); 3637ca22e56dSKay Sievers mutex_unlock(&dev->class->p->mutex); 36385d9fd169SGreg Kroah-Hartman } 3639c906a48aSGreg Kroah-Hartman done: 36401da177e4SLinus Torvalds put_device(dev); 36411da177e4SLinus Torvalds return error; 36420cd75047SSergey Klyaus SysEntryError: 36430cd75047SSergey Klyaus if (MAJOR(dev->devt)) 36440cd75047SSergey Klyaus device_remove_file(dev, &dev_attr_dev); 36450cd75047SSergey Klyaus DevAttrError: 36460cd75047SSergey Klyaus device_pm_remove(dev); 36470cd75047SSergey Klyaus dpm_sysfs_remove(dev); 36483b98aeafSAlan Stern DPMError: 3649f6837f34SYang Yingliang dev->driver = NULL; 365057eee3d2SRafael J. Wysocki bus_remove_device(dev); 365157eee3d2SRafael J. Wysocki BusError: 36522620efefSGreg Kroah-Hartman device_remove_attrs(dev); 36532620efefSGreg Kroah-Hartman AttrsError: 36542ee97cafSCornelia Huck device_remove_class_symlinks(dev); 36552ee97cafSCornelia Huck SymlinkError: 3656c5e064a6SGreg Kroah-Hartman device_remove_file(dev, &dev_attr_uevent); 365723681e47SGreg Kroah-Hartman attrError: 3658b2ebd9ddSRafael J. Wysocki device_platform_notify_remove(dev); 3659312c004dSKay Sievers kobject_uevent(&dev->kobj, KOBJ_REMOVE); 3660cebf8fd1SMing Lei glue_dir = get_glue_dir(dev); 36611da177e4SLinus Torvalds kobject_del(&dev->kobj); 36621da177e4SLinus Torvalds Error: 3663cebf8fd1SMing Lei cleanup_glue_dir(dev, glue_dir); 366484d0c27dSTetsuo Handa parent_error: 36651da177e4SLinus Torvalds put_device(parent); 36665c8563d7SKay Sievers name_error: 36675c8563d7SKay Sievers kfree(dev->p); 36685c8563d7SKay Sievers dev->p = NULL; 3669c906a48aSGreg Kroah-Hartman goto done; 36701da177e4SLinus Torvalds } 367186df2687SDavid Graham White EXPORT_SYMBOL_GPL(device_add); 36721da177e4SLinus Torvalds 36731da177e4SLinus Torvalds /** 36741da177e4SLinus Torvalds * device_register - register a device with the system. 36751da177e4SLinus Torvalds * @dev: pointer to the device structure 36761da177e4SLinus Torvalds * 36771da177e4SLinus Torvalds * This happens in two clean steps - initialize the device 36781da177e4SLinus Torvalds * and add it to the system. The two steps can be called 36791da177e4SLinus Torvalds * separately, but this is the easiest and most common. 36801da177e4SLinus Torvalds * I.e. you should only call the two helpers separately if 36811da177e4SLinus Torvalds * have a clearly defined need to use and refcount the device 36821da177e4SLinus Torvalds * before it is added to the hierarchy. 36835739411aSCornelia Huck * 3684b10d5efdSAlan Stern * For more information, see the kerneldoc for device_initialize() 3685b10d5efdSAlan Stern * and device_add(). 3686b10d5efdSAlan Stern * 36875739411aSCornelia Huck * NOTE: _Never_ directly free @dev after calling this function, even 36885739411aSCornelia Huck * if it returned an error! Always use put_device() to give up the 36895739411aSCornelia Huck * reference initialized in this function instead. 36901da177e4SLinus Torvalds */ 36911da177e4SLinus Torvalds int device_register(struct device *dev) 36921da177e4SLinus Torvalds { 36931da177e4SLinus Torvalds device_initialize(dev); 36941da177e4SLinus Torvalds return device_add(dev); 36951da177e4SLinus Torvalds } 369686df2687SDavid Graham White EXPORT_SYMBOL_GPL(device_register); 36971da177e4SLinus Torvalds 36981da177e4SLinus Torvalds /** 36991da177e4SLinus Torvalds * get_device - increment reference count for device. 37001da177e4SLinus Torvalds * @dev: device. 37011da177e4SLinus Torvalds * 37021da177e4SLinus Torvalds * This simply forwards the call to kobject_get(), though 37031da177e4SLinus Torvalds * we do take care to provide for the case that we get a NULL 37041da177e4SLinus Torvalds * pointer passed in. 37051da177e4SLinus Torvalds */ 37061da177e4SLinus Torvalds struct device *get_device(struct device *dev) 37071da177e4SLinus Torvalds { 3708b0d1f807SLars-Peter Clausen return dev ? kobj_to_dev(kobject_get(&dev->kobj)) : NULL; 37091da177e4SLinus Torvalds } 371086df2687SDavid Graham White EXPORT_SYMBOL_GPL(get_device); 37111da177e4SLinus Torvalds 37121da177e4SLinus Torvalds /** 37131da177e4SLinus Torvalds * put_device - decrement reference count. 37141da177e4SLinus Torvalds * @dev: device in question. 37151da177e4SLinus Torvalds */ 37161da177e4SLinus Torvalds void put_device(struct device *dev) 37171da177e4SLinus Torvalds { 3718edfaa7c3SKay Sievers /* might_sleep(); */ 37191da177e4SLinus Torvalds if (dev) 37201da177e4SLinus Torvalds kobject_put(&dev->kobj); 37211da177e4SLinus Torvalds } 372286df2687SDavid Graham White EXPORT_SYMBOL_GPL(put_device); 37231da177e4SLinus Torvalds 372400289cd8SDan Williams bool kill_device(struct device *dev) 372500289cd8SDan Williams { 372600289cd8SDan Williams /* 372700289cd8SDan Williams * Require the device lock and set the "dead" flag to guarantee that 372800289cd8SDan Williams * the update behavior is consistent with the other bitfields near 372900289cd8SDan Williams * it and that we cannot have an asynchronous probe routine trying 373000289cd8SDan Williams * to run while we are tearing out the bus/class/sysfs from 373100289cd8SDan Williams * underneath the device. 373200289cd8SDan Williams */ 37338c60a141SJulian Wiedmann device_lock_assert(dev); 373400289cd8SDan Williams 373500289cd8SDan Williams if (dev->p->dead) 373600289cd8SDan Williams return false; 373700289cd8SDan Williams dev->p->dead = true; 373800289cd8SDan Williams return true; 373900289cd8SDan Williams } 374000289cd8SDan Williams EXPORT_SYMBOL_GPL(kill_device); 374100289cd8SDan Williams 37421da177e4SLinus Torvalds /** 37431da177e4SLinus Torvalds * device_del - delete device from system. 37441da177e4SLinus Torvalds * @dev: device. 37451da177e4SLinus Torvalds * 37461da177e4SLinus Torvalds * This is the first part of the device unregistration 37471da177e4SLinus Torvalds * sequence. This removes the device from the lists we control 37481da177e4SLinus Torvalds * from here, has it removed from the other driver model 37491da177e4SLinus Torvalds * subsystems it was added to in device_add(), and removes it 37501da177e4SLinus Torvalds * from the kobject hierarchy. 37511da177e4SLinus Torvalds * 37521da177e4SLinus Torvalds * NOTE: this should be called manually _iff_ device_add() was 37531da177e4SLinus Torvalds * also called manually. 37541da177e4SLinus Torvalds */ 37551da177e4SLinus Torvalds void device_del(struct device *dev) 37561da177e4SLinus Torvalds { 37571da177e4SLinus Torvalds struct device *parent = dev->parent; 3758cebf8fd1SMing Lei struct kobject *glue_dir = NULL; 3759c47ed219SGreg Kroah-Hartman struct class_interface *class_intf; 3760b8530017SOliver Neukum unsigned int noio_flag; 37611da177e4SLinus Torvalds 37623451a495SAlexander Duyck device_lock(dev); 376300289cd8SDan Williams kill_device(dev); 37643451a495SAlexander Duyck device_unlock(dev); 37653451a495SAlexander Duyck 3766372a67c0SSaravana Kannan if (dev->fwnode && dev->fwnode->dev == dev) 3767372a67c0SSaravana Kannan dev->fwnode->dev = NULL; 3768372a67c0SSaravana Kannan 3769ec0676eeSAlan Stern /* Notify clients of device removal. This call must come 3770ec0676eeSAlan Stern * before dpm_sysfs_remove(). 3771ec0676eeSAlan Stern */ 3772b8530017SOliver Neukum noio_flag = memalloc_noio_save(); 3773ed9f9181SGreg Kroah-Hartman bus_notify(dev, BUS_NOTIFY_DEL_DEVICE); 37749ed98953SRafael J. Wysocki 37753b98aeafSAlan Stern dpm_sysfs_remove(dev); 37761da177e4SLinus Torvalds if (parent) 3777f791b8c8SGreg Kroah-Hartman klist_del(&dev->p->knode_parent); 3778e105b8bfSDan Williams if (MAJOR(dev->devt)) { 37792b2af54aSKay Sievers devtmpfs_delete_node(dev); 3780e105b8bfSDan Williams device_remove_sys_dev_entry(dev); 3781c5e064a6SGreg Kroah-Hartman device_remove_file(dev, &dev_attr_dev); 3782e105b8bfSDan Williams } 3783b9d9c82bSKay Sievers if (dev->class) { 3784da231fd5SKay Sievers device_remove_class_symlinks(dev); 378599ef3ef8SKay Sievers 3786ca22e56dSKay Sievers mutex_lock(&dev->class->p->mutex); 3787c47ed219SGreg Kroah-Hartman /* notify any interfaces that the device is now gone */ 3788184f1f77SGreg Kroah-Hartman list_for_each_entry(class_intf, 3789ca22e56dSKay Sievers &dev->class->p->interfaces, node) 3790c47ed219SGreg Kroah-Hartman if (class_intf->remove_dev) 3791c47ed219SGreg Kroah-Hartman class_intf->remove_dev(dev, class_intf); 3792c47ed219SGreg Kroah-Hartman /* remove the device from the class list */ 3793570d0200SWei Yang klist_del(&dev->p->knode_class); 3794ca22e56dSKay Sievers mutex_unlock(&dev->class->p->mutex); 3795b9d9c82bSKay Sievers } 3796c5e064a6SGreg Kroah-Hartman device_remove_file(dev, &dev_attr_uevent); 37972620efefSGreg Kroah-Hartman device_remove_attrs(dev); 379828953533SBenjamin Herrenschmidt bus_remove_device(dev); 37994b6d1f12SLongX Zhang device_pm_remove(dev); 3800d1c3414cSGrant Likely driver_deferred_probe_del(dev); 3801b2ebd9ddSRafael J. Wysocki device_platform_notify_remove(dev); 38022ec16150SJeffy Chen device_links_purge(dev); 38031da177e4SLinus Torvalds 3804ed9f9181SGreg Kroah-Hartman bus_notify(dev, BUS_NOTIFY_REMOVED_DEVICE); 3805312c004dSKay Sievers kobject_uevent(&dev->kobj, KOBJ_REMOVE); 3806cebf8fd1SMing Lei glue_dir = get_glue_dir(dev); 38071da177e4SLinus Torvalds kobject_del(&dev->kobj); 3808cebf8fd1SMing Lei cleanup_glue_dir(dev, glue_dir); 3809b8530017SOliver Neukum memalloc_noio_restore(noio_flag); 38101da177e4SLinus Torvalds put_device(parent); 38111da177e4SLinus Torvalds } 381286df2687SDavid Graham White EXPORT_SYMBOL_GPL(device_del); 38131da177e4SLinus Torvalds 38141da177e4SLinus Torvalds /** 38151da177e4SLinus Torvalds * device_unregister - unregister device from system. 38161da177e4SLinus Torvalds * @dev: device going away. 38171da177e4SLinus Torvalds * 38181da177e4SLinus Torvalds * We do this in two parts, like we do device_register(). First, 38191da177e4SLinus Torvalds * we remove it from all the subsystems with device_del(), then 38201da177e4SLinus Torvalds * we decrement the reference count via put_device(). If that 38211da177e4SLinus Torvalds * is the final reference count, the device will be cleaned up 38221da177e4SLinus Torvalds * via device_release() above. Otherwise, the structure will 38231da177e4SLinus Torvalds * stick around until the final reference to the device is dropped. 38241da177e4SLinus Torvalds */ 38251da177e4SLinus Torvalds void device_unregister(struct device *dev) 38261da177e4SLinus Torvalds { 38271e0b2cf9SKay Sievers pr_debug("device: '%s': %s\n", dev_name(dev), __func__); 38281da177e4SLinus Torvalds device_del(dev); 38291da177e4SLinus Torvalds put_device(dev); 38301da177e4SLinus Torvalds } 383186df2687SDavid Graham White EXPORT_SYMBOL_GPL(device_unregister); 38321da177e4SLinus Torvalds 38333d060aebSAndy Shevchenko static struct device *prev_device(struct klist_iter *i) 38343d060aebSAndy Shevchenko { 38353d060aebSAndy Shevchenko struct klist_node *n = klist_prev(i); 38363d060aebSAndy Shevchenko struct device *dev = NULL; 38373d060aebSAndy Shevchenko struct device_private *p; 38383d060aebSAndy Shevchenko 38393d060aebSAndy Shevchenko if (n) { 38403d060aebSAndy Shevchenko p = to_device_private_parent(n); 38413d060aebSAndy Shevchenko dev = p->device; 38423d060aebSAndy Shevchenko } 38433d060aebSAndy Shevchenko return dev; 38443d060aebSAndy Shevchenko } 38453d060aebSAndy Shevchenko 384636239577Smochel@digitalimplant.org static struct device *next_device(struct klist_iter *i) 384736239577Smochel@digitalimplant.org { 384836239577Smochel@digitalimplant.org struct klist_node *n = klist_next(i); 3849f791b8c8SGreg Kroah-Hartman struct device *dev = NULL; 3850f791b8c8SGreg Kroah-Hartman struct device_private *p; 3851f791b8c8SGreg Kroah-Hartman 3852f791b8c8SGreg Kroah-Hartman if (n) { 3853f791b8c8SGreg Kroah-Hartman p = to_device_private_parent(n); 3854f791b8c8SGreg Kroah-Hartman dev = p->device; 3855f791b8c8SGreg Kroah-Hartman } 3856f791b8c8SGreg Kroah-Hartman return dev; 385736239577Smochel@digitalimplant.org } 385836239577Smochel@digitalimplant.org 38591da177e4SLinus Torvalds /** 3860e454cea2SKay Sievers * device_get_devnode - path of device node file 38616fcf53acSKay Sievers * @dev: device 3862e454cea2SKay Sievers * @mode: returned file access mode 38633c2670e6SKay Sievers * @uid: returned file owner 38643c2670e6SKay Sievers * @gid: returned file group 38656fcf53acSKay Sievers * @tmp: possibly allocated string 38666fcf53acSKay Sievers * 38676fcf53acSKay Sievers * Return the relative path of a possible device node. 38686fcf53acSKay Sievers * Non-default names may need to allocate a memory to compose 38696fcf53acSKay Sievers * a name. This memory is returned in tmp and needs to be 38706fcf53acSKay Sievers * freed by the caller. 38716fcf53acSKay Sievers */ 387242bb5be8SGreg Kroah-Hartman const char *device_get_devnode(const struct device *dev, 38734e4098a3SGreg Kroah-Hartman umode_t *mode, kuid_t *uid, kgid_t *gid, 38743c2670e6SKay Sievers const char **tmp) 38756fcf53acSKay Sievers { 38766fcf53acSKay Sievers char *s; 38776fcf53acSKay Sievers 38786fcf53acSKay Sievers *tmp = NULL; 38796fcf53acSKay Sievers 38806fcf53acSKay Sievers /* the device type may provide a specific name */ 3881e454cea2SKay Sievers if (dev->type && dev->type->devnode) 38823c2670e6SKay Sievers *tmp = dev->type->devnode(dev, mode, uid, gid); 38836fcf53acSKay Sievers if (*tmp) 38846fcf53acSKay Sievers return *tmp; 38856fcf53acSKay Sievers 38866fcf53acSKay Sievers /* the class may provide a specific name */ 3887e454cea2SKay Sievers if (dev->class && dev->class->devnode) 3888e454cea2SKay Sievers *tmp = dev->class->devnode(dev, mode); 38896fcf53acSKay Sievers if (*tmp) 38906fcf53acSKay Sievers return *tmp; 38916fcf53acSKay Sievers 38926fcf53acSKay Sievers /* return name without allocation, tmp == NULL */ 38936fcf53acSKay Sievers if (strchr(dev_name(dev), '!') == NULL) 38946fcf53acSKay Sievers return dev_name(dev); 38956fcf53acSKay Sievers 38966fcf53acSKay Sievers /* replace '!' in the name with '/' */ 3897a29fd614SRasmus Villemoes s = kstrdup(dev_name(dev), GFP_KERNEL); 3898a29fd614SRasmus Villemoes if (!s) 38996fcf53acSKay Sievers return NULL; 3900a29fd614SRasmus Villemoes strreplace(s, '!', '/'); 3901a29fd614SRasmus Villemoes return *tmp = s; 39026fcf53acSKay Sievers } 39036fcf53acSKay Sievers 39046fcf53acSKay Sievers /** 39051da177e4SLinus Torvalds * device_for_each_child - device child iterator. 3906c41455fbSRandy Dunlap * @parent: parent struct device. 39071da177e4SLinus Torvalds * @fn: function to be called for each device. 3908f8878dcbSRobert P. J. Day * @data: data for the callback. 39091da177e4SLinus Torvalds * 3910c41455fbSRandy Dunlap * Iterate over @parent's child devices, and call @fn for each, 39111da177e4SLinus Torvalds * passing it @data. 39121da177e4SLinus Torvalds * 39131da177e4SLinus Torvalds * We check the return of @fn each time. If it returns anything 39141da177e4SLinus Torvalds * other than 0, we break out and return that value. 39151da177e4SLinus Torvalds */ 391636239577Smochel@digitalimplant.org int device_for_each_child(struct device *parent, void *data, 39174a3ad20cSGreg Kroah-Hartman int (*fn)(struct device *dev, void *data)) 39181da177e4SLinus Torvalds { 391936239577Smochel@digitalimplant.org struct klist_iter i; 39201da177e4SLinus Torvalds struct device *child; 39211da177e4SLinus Torvalds int error = 0; 39221da177e4SLinus Torvalds 3923014c90dbSGreg Kroah-Hartman if (!parent->p) 3924014c90dbSGreg Kroah-Hartman return 0; 3925014c90dbSGreg Kroah-Hartman 3926f791b8c8SGreg Kroah-Hartman klist_iter_init(&parent->p->klist_children, &i); 392793ead7c9SGimcuan Hui while (!error && (child = next_device(&i))) 392836239577Smochel@digitalimplant.org error = fn(child, data); 392936239577Smochel@digitalimplant.org klist_iter_exit(&i); 39301da177e4SLinus Torvalds return error; 39311da177e4SLinus Torvalds } 393286df2687SDavid Graham White EXPORT_SYMBOL_GPL(device_for_each_child); 39331da177e4SLinus Torvalds 39345ab69981SCornelia Huck /** 39353d060aebSAndy Shevchenko * device_for_each_child_reverse - device child iterator in reversed order. 39363d060aebSAndy Shevchenko * @parent: parent struct device. 39373d060aebSAndy Shevchenko * @fn: function to be called for each device. 39383d060aebSAndy Shevchenko * @data: data for the callback. 39393d060aebSAndy Shevchenko * 39403d060aebSAndy Shevchenko * Iterate over @parent's child devices, and call @fn for each, 39413d060aebSAndy Shevchenko * passing it @data. 39423d060aebSAndy Shevchenko * 39433d060aebSAndy Shevchenko * We check the return of @fn each time. If it returns anything 39443d060aebSAndy Shevchenko * other than 0, we break out and return that value. 39453d060aebSAndy Shevchenko */ 39463d060aebSAndy Shevchenko int device_for_each_child_reverse(struct device *parent, void *data, 39473d060aebSAndy Shevchenko int (*fn)(struct device *dev, void *data)) 39483d060aebSAndy Shevchenko { 39493d060aebSAndy Shevchenko struct klist_iter i; 39503d060aebSAndy Shevchenko struct device *child; 39513d060aebSAndy Shevchenko int error = 0; 39523d060aebSAndy Shevchenko 39533d060aebSAndy Shevchenko if (!parent->p) 39543d060aebSAndy Shevchenko return 0; 39553d060aebSAndy Shevchenko 39563d060aebSAndy Shevchenko klist_iter_init(&parent->p->klist_children, &i); 39573d060aebSAndy Shevchenko while ((child = prev_device(&i)) && !error) 39583d060aebSAndy Shevchenko error = fn(child, data); 39593d060aebSAndy Shevchenko klist_iter_exit(&i); 39603d060aebSAndy Shevchenko return error; 39613d060aebSAndy Shevchenko } 39623d060aebSAndy Shevchenko EXPORT_SYMBOL_GPL(device_for_each_child_reverse); 39633d060aebSAndy Shevchenko 39643d060aebSAndy Shevchenko /** 39655ab69981SCornelia Huck * device_find_child - device iterator for locating a particular device. 39665ab69981SCornelia Huck * @parent: parent struct device 39675ab69981SCornelia Huck * @match: Callback function to check device 3968f8878dcbSRobert P. J. Day * @data: Data to pass to match function 39695ab69981SCornelia Huck * 39705ab69981SCornelia Huck * This is similar to the device_for_each_child() function above, but it 39715ab69981SCornelia Huck * returns a reference to a device that is 'found' for later use, as 39725ab69981SCornelia Huck * determined by the @match callback. 39735ab69981SCornelia Huck * 39745ab69981SCornelia Huck * The callback should return 0 if the device doesn't match and non-zero 39755ab69981SCornelia Huck * if it does. If the callback returns non-zero and a reference to the 39765ab69981SCornelia Huck * current device can be obtained, this function will return to the caller 39775ab69981SCornelia Huck * and not iterate over any more devices. 3978a4e2400aSFederico Vaga * 3979a4e2400aSFederico Vaga * NOTE: you will need to drop the reference with put_device() after use. 39805ab69981SCornelia Huck */ 39815ab69981SCornelia Huck struct device *device_find_child(struct device *parent, void *data, 39824a3ad20cSGreg Kroah-Hartman int (*match)(struct device *dev, void *data)) 39835ab69981SCornelia Huck { 39845ab69981SCornelia Huck struct klist_iter i; 39855ab69981SCornelia Huck struct device *child; 39865ab69981SCornelia Huck 39875ab69981SCornelia Huck if (!parent) 39885ab69981SCornelia Huck return NULL; 39895ab69981SCornelia Huck 3990f791b8c8SGreg Kroah-Hartman klist_iter_init(&parent->p->klist_children, &i); 39915ab69981SCornelia Huck while ((child = next_device(&i))) 39925ab69981SCornelia Huck if (match(child, data) && get_device(child)) 39935ab69981SCornelia Huck break; 39945ab69981SCornelia Huck klist_iter_exit(&i); 39955ab69981SCornelia Huck return child; 39965ab69981SCornelia Huck } 399786df2687SDavid Graham White EXPORT_SYMBOL_GPL(device_find_child); 39985ab69981SCornelia Huck 3999dad9bb01SHeikki Krogerus /** 4000dad9bb01SHeikki Krogerus * device_find_child_by_name - device iterator for locating a child device. 4001dad9bb01SHeikki Krogerus * @parent: parent struct device 4002dad9bb01SHeikki Krogerus * @name: name of the child device 4003dad9bb01SHeikki Krogerus * 4004dad9bb01SHeikki Krogerus * This is similar to the device_find_child() function above, but it 4005dad9bb01SHeikki Krogerus * returns a reference to a device that has the name @name. 4006dad9bb01SHeikki Krogerus * 4007dad9bb01SHeikki Krogerus * NOTE: you will need to drop the reference with put_device() after use. 4008dad9bb01SHeikki Krogerus */ 4009dad9bb01SHeikki Krogerus struct device *device_find_child_by_name(struct device *parent, 4010dad9bb01SHeikki Krogerus const char *name) 4011dad9bb01SHeikki Krogerus { 4012dad9bb01SHeikki Krogerus struct klist_iter i; 4013dad9bb01SHeikki Krogerus struct device *child; 4014dad9bb01SHeikki Krogerus 4015dad9bb01SHeikki Krogerus if (!parent) 4016dad9bb01SHeikki Krogerus return NULL; 4017dad9bb01SHeikki Krogerus 4018dad9bb01SHeikki Krogerus klist_iter_init(&parent->p->klist_children, &i); 4019dad9bb01SHeikki Krogerus while ((child = next_device(&i))) 4020c77f520dSDan Williams if (sysfs_streq(dev_name(child), name) && get_device(child)) 4021dad9bb01SHeikki Krogerus break; 4022dad9bb01SHeikki Krogerus klist_iter_exit(&i); 4023dad9bb01SHeikki Krogerus return child; 4024dad9bb01SHeikki Krogerus } 4025dad9bb01SHeikki Krogerus EXPORT_SYMBOL_GPL(device_find_child_by_name); 4026dad9bb01SHeikki Krogerus 402782b070beSAndy Shevchenko static int match_any(struct device *dev, void *unused) 402882b070beSAndy Shevchenko { 402982b070beSAndy Shevchenko return 1; 403082b070beSAndy Shevchenko } 403182b070beSAndy Shevchenko 403282b070beSAndy Shevchenko /** 403382b070beSAndy Shevchenko * device_find_any_child - device iterator for locating a child device, if any. 403482b070beSAndy Shevchenko * @parent: parent struct device 403582b070beSAndy Shevchenko * 403682b070beSAndy Shevchenko * This is similar to the device_find_child() function above, but it 403782b070beSAndy Shevchenko * returns a reference to a child device, if any. 403882b070beSAndy Shevchenko * 403982b070beSAndy Shevchenko * NOTE: you will need to drop the reference with put_device() after use. 404082b070beSAndy Shevchenko */ 404182b070beSAndy Shevchenko struct device *device_find_any_child(struct device *parent) 404282b070beSAndy Shevchenko { 404382b070beSAndy Shevchenko return device_find_child(parent, NULL, match_any); 404482b070beSAndy Shevchenko } 404582b070beSAndy Shevchenko EXPORT_SYMBOL_GPL(device_find_any_child); 404682b070beSAndy Shevchenko 40471da177e4SLinus Torvalds int __init devices_init(void) 40481da177e4SLinus Torvalds { 4049881c6cfdSGreg Kroah-Hartman devices_kset = kset_create_and_add("devices", &device_uevent_ops, NULL); 4050881c6cfdSGreg Kroah-Hartman if (!devices_kset) 4051881c6cfdSGreg Kroah-Hartman return -ENOMEM; 4052e105b8bfSDan Williams dev_kobj = kobject_create_and_add("dev", NULL); 4053e105b8bfSDan Williams if (!dev_kobj) 4054e105b8bfSDan Williams goto dev_kobj_err; 4055e105b8bfSDan Williams sysfs_dev_block_kobj = kobject_create_and_add("block", dev_kobj); 4056e105b8bfSDan Williams if (!sysfs_dev_block_kobj) 4057e105b8bfSDan Williams goto block_kobj_err; 4058e105b8bfSDan Williams sysfs_dev_char_kobj = kobject_create_and_add("char", dev_kobj); 4059e105b8bfSDan Williams if (!sysfs_dev_char_kobj) 4060e105b8bfSDan Williams goto char_kobj_err; 4061e105b8bfSDan Williams 4062881c6cfdSGreg Kroah-Hartman return 0; 4063e105b8bfSDan Williams 4064e105b8bfSDan Williams char_kobj_err: 4065e105b8bfSDan Williams kobject_put(sysfs_dev_block_kobj); 4066e105b8bfSDan Williams block_kobj_err: 4067e105b8bfSDan Williams kobject_put(dev_kobj); 4068e105b8bfSDan Williams dev_kobj_err: 4069e105b8bfSDan Williams kset_unregister(devices_kset); 4070e105b8bfSDan Williams return -ENOMEM; 40711da177e4SLinus Torvalds } 40721da177e4SLinus Torvalds 40734f3549d7SRafael J. Wysocki static int device_check_offline(struct device *dev, void *not_used) 40744f3549d7SRafael J. Wysocki { 40754f3549d7SRafael J. Wysocki int ret; 40764f3549d7SRafael J. Wysocki 40774f3549d7SRafael J. Wysocki ret = device_for_each_child(dev, NULL, device_check_offline); 40784f3549d7SRafael J. Wysocki if (ret) 40794f3549d7SRafael J. Wysocki return ret; 40804f3549d7SRafael J. Wysocki 40814f3549d7SRafael J. Wysocki return device_supports_offline(dev) && !dev->offline ? -EBUSY : 0; 40824f3549d7SRafael J. Wysocki } 40834f3549d7SRafael J. Wysocki 40844f3549d7SRafael J. Wysocki /** 40854f3549d7SRafael J. Wysocki * device_offline - Prepare the device for hot-removal. 40864f3549d7SRafael J. Wysocki * @dev: Device to be put offline. 40874f3549d7SRafael J. Wysocki * 40884f3549d7SRafael J. Wysocki * Execute the device bus type's .offline() callback, if present, to prepare 40894f3549d7SRafael J. Wysocki * the device for a subsequent hot-removal. If that succeeds, the device must 40904f3549d7SRafael J. Wysocki * not be used until either it is removed or its bus type's .online() callback 40914f3549d7SRafael J. Wysocki * is executed. 40924f3549d7SRafael J. Wysocki * 40934f3549d7SRafael J. Wysocki * Call under device_hotplug_lock. 40944f3549d7SRafael J. Wysocki */ 40954f3549d7SRafael J. Wysocki int device_offline(struct device *dev) 40964f3549d7SRafael J. Wysocki { 40974f3549d7SRafael J. Wysocki int ret; 40984f3549d7SRafael J. Wysocki 40994f3549d7SRafael J. Wysocki if (dev->offline_disabled) 41004f3549d7SRafael J. Wysocki return -EPERM; 41014f3549d7SRafael J. Wysocki 41024f3549d7SRafael J. Wysocki ret = device_for_each_child(dev, NULL, device_check_offline); 41034f3549d7SRafael J. Wysocki if (ret) 41044f3549d7SRafael J. Wysocki return ret; 41054f3549d7SRafael J. Wysocki 41064f3549d7SRafael J. Wysocki device_lock(dev); 41074f3549d7SRafael J. Wysocki if (device_supports_offline(dev)) { 41084f3549d7SRafael J. Wysocki if (dev->offline) { 41094f3549d7SRafael J. Wysocki ret = 1; 41104f3549d7SRafael J. Wysocki } else { 41114f3549d7SRafael J. Wysocki ret = dev->bus->offline(dev); 41124f3549d7SRafael J. Wysocki if (!ret) { 41134f3549d7SRafael J. Wysocki kobject_uevent(&dev->kobj, KOBJ_OFFLINE); 41144f3549d7SRafael J. Wysocki dev->offline = true; 41154f3549d7SRafael J. Wysocki } 41164f3549d7SRafael J. Wysocki } 41174f3549d7SRafael J. Wysocki } 41184f3549d7SRafael J. Wysocki device_unlock(dev); 41194f3549d7SRafael J. Wysocki 41204f3549d7SRafael J. Wysocki return ret; 41214f3549d7SRafael J. Wysocki } 41224f3549d7SRafael J. Wysocki 41234f3549d7SRafael J. Wysocki /** 41244f3549d7SRafael J. Wysocki * device_online - Put the device back online after successful device_offline(). 41254f3549d7SRafael J. Wysocki * @dev: Device to be put back online. 41264f3549d7SRafael J. Wysocki * 41274f3549d7SRafael J. Wysocki * If device_offline() has been successfully executed for @dev, but the device 41284f3549d7SRafael J. Wysocki * has not been removed subsequently, execute its bus type's .online() callback 41294f3549d7SRafael J. Wysocki * to indicate that the device can be used again. 41304f3549d7SRafael J. Wysocki * 41314f3549d7SRafael J. Wysocki * Call under device_hotplug_lock. 41324f3549d7SRafael J. Wysocki */ 41334f3549d7SRafael J. Wysocki int device_online(struct device *dev) 41344f3549d7SRafael J. Wysocki { 41354f3549d7SRafael J. Wysocki int ret = 0; 41364f3549d7SRafael J. Wysocki 41374f3549d7SRafael J. Wysocki device_lock(dev); 41384f3549d7SRafael J. Wysocki if (device_supports_offline(dev)) { 41394f3549d7SRafael J. Wysocki if (dev->offline) { 41404f3549d7SRafael J. Wysocki ret = dev->bus->online(dev); 41414f3549d7SRafael J. Wysocki if (!ret) { 41424f3549d7SRafael J. Wysocki kobject_uevent(&dev->kobj, KOBJ_ONLINE); 41434f3549d7SRafael J. Wysocki dev->offline = false; 41444f3549d7SRafael J. Wysocki } 41454f3549d7SRafael J. Wysocki } else { 41464f3549d7SRafael J. Wysocki ret = 1; 41474f3549d7SRafael J. Wysocki } 41484f3549d7SRafael J. Wysocki } 41494f3549d7SRafael J. Wysocki device_unlock(dev); 41504f3549d7SRafael J. Wysocki 41514f3549d7SRafael J. Wysocki return ret; 41524f3549d7SRafael J. Wysocki } 41534f3549d7SRafael J. Wysocki 41547f100d15SKarthigan Srinivasan struct root_device { 41550aa0dc41SMark McLoughlin struct device dev; 41560aa0dc41SMark McLoughlin struct module *owner; 41570aa0dc41SMark McLoughlin }; 41580aa0dc41SMark McLoughlin 415993058424SJosh Triplett static inline struct root_device *to_root_device(struct device *d) 4160481e2079SFerenc Wagner { 4161481e2079SFerenc Wagner return container_of(d, struct root_device, dev); 4162481e2079SFerenc Wagner } 41630aa0dc41SMark McLoughlin 41640aa0dc41SMark McLoughlin static void root_device_release(struct device *dev) 41650aa0dc41SMark McLoughlin { 41660aa0dc41SMark McLoughlin kfree(to_root_device(dev)); 41670aa0dc41SMark McLoughlin } 41680aa0dc41SMark McLoughlin 41690aa0dc41SMark McLoughlin /** 41700aa0dc41SMark McLoughlin * __root_device_register - allocate and register a root device 41710aa0dc41SMark McLoughlin * @name: root device name 41720aa0dc41SMark McLoughlin * @owner: owner module of the root device, usually THIS_MODULE 41730aa0dc41SMark McLoughlin * 41740aa0dc41SMark McLoughlin * This function allocates a root device and registers it 41750aa0dc41SMark McLoughlin * using device_register(). In order to free the returned 41760aa0dc41SMark McLoughlin * device, use root_device_unregister(). 41770aa0dc41SMark McLoughlin * 41780aa0dc41SMark McLoughlin * Root devices are dummy devices which allow other devices 41790aa0dc41SMark McLoughlin * to be grouped under /sys/devices. Use this function to 41800aa0dc41SMark McLoughlin * allocate a root device and then use it as the parent of 41810aa0dc41SMark McLoughlin * any device which should appear under /sys/devices/{name} 41820aa0dc41SMark McLoughlin * 41830aa0dc41SMark McLoughlin * The /sys/devices/{name} directory will also contain a 41840aa0dc41SMark McLoughlin * 'module' symlink which points to the @owner directory 41850aa0dc41SMark McLoughlin * in sysfs. 41860aa0dc41SMark McLoughlin * 4187f0eae0edSJani Nikula * Returns &struct device pointer on success, or ERR_PTR() on error. 4188f0eae0edSJani Nikula * 41890aa0dc41SMark McLoughlin * Note: You probably want to use root_device_register(). 41900aa0dc41SMark McLoughlin */ 41910aa0dc41SMark McLoughlin struct device *__root_device_register(const char *name, struct module *owner) 41920aa0dc41SMark McLoughlin { 41930aa0dc41SMark McLoughlin struct root_device *root; 41940aa0dc41SMark McLoughlin int err = -ENOMEM; 41950aa0dc41SMark McLoughlin 41960aa0dc41SMark McLoughlin root = kzalloc(sizeof(struct root_device), GFP_KERNEL); 41970aa0dc41SMark McLoughlin if (!root) 41980aa0dc41SMark McLoughlin return ERR_PTR(err); 41990aa0dc41SMark McLoughlin 4200acc0e90fSGreg Kroah-Hartman err = dev_set_name(&root->dev, "%s", name); 42010aa0dc41SMark McLoughlin if (err) { 42020aa0dc41SMark McLoughlin kfree(root); 42030aa0dc41SMark McLoughlin return ERR_PTR(err); 42040aa0dc41SMark McLoughlin } 42050aa0dc41SMark McLoughlin 42060aa0dc41SMark McLoughlin root->dev.release = root_device_release; 42070aa0dc41SMark McLoughlin 42080aa0dc41SMark McLoughlin err = device_register(&root->dev); 42090aa0dc41SMark McLoughlin if (err) { 42100aa0dc41SMark McLoughlin put_device(&root->dev); 42110aa0dc41SMark McLoughlin return ERR_PTR(err); 42120aa0dc41SMark McLoughlin } 42130aa0dc41SMark McLoughlin 42141d9e882bSChristoph Egger #ifdef CONFIG_MODULES /* gotta find a "cleaner" way to do this */ 42150aa0dc41SMark McLoughlin if (owner) { 42160aa0dc41SMark McLoughlin struct module_kobject *mk = &owner->mkobj; 42170aa0dc41SMark McLoughlin 42180aa0dc41SMark McLoughlin err = sysfs_create_link(&root->dev.kobj, &mk->kobj, "module"); 42190aa0dc41SMark McLoughlin if (err) { 42200aa0dc41SMark McLoughlin device_unregister(&root->dev); 42210aa0dc41SMark McLoughlin return ERR_PTR(err); 42220aa0dc41SMark McLoughlin } 42230aa0dc41SMark McLoughlin root->owner = owner; 42240aa0dc41SMark McLoughlin } 42250aa0dc41SMark McLoughlin #endif 42260aa0dc41SMark McLoughlin 42270aa0dc41SMark McLoughlin return &root->dev; 42280aa0dc41SMark McLoughlin } 42290aa0dc41SMark McLoughlin EXPORT_SYMBOL_GPL(__root_device_register); 42300aa0dc41SMark McLoughlin 42310aa0dc41SMark McLoughlin /** 42320aa0dc41SMark McLoughlin * root_device_unregister - unregister and free a root device 42337cbcf225SRandy Dunlap * @dev: device going away 42340aa0dc41SMark McLoughlin * 42350aa0dc41SMark McLoughlin * This function unregisters and cleans up a device that was created by 42360aa0dc41SMark McLoughlin * root_device_register(). 42370aa0dc41SMark McLoughlin */ 42380aa0dc41SMark McLoughlin void root_device_unregister(struct device *dev) 42390aa0dc41SMark McLoughlin { 42400aa0dc41SMark McLoughlin struct root_device *root = to_root_device(dev); 42410aa0dc41SMark McLoughlin 42420aa0dc41SMark McLoughlin if (root->owner) 42430aa0dc41SMark McLoughlin sysfs_remove_link(&root->dev.kobj, "module"); 42440aa0dc41SMark McLoughlin 42450aa0dc41SMark McLoughlin device_unregister(dev); 42460aa0dc41SMark McLoughlin } 42470aa0dc41SMark McLoughlin EXPORT_SYMBOL_GPL(root_device_unregister); 42480aa0dc41SMark McLoughlin 424923681e47SGreg Kroah-Hartman 425023681e47SGreg Kroah-Hartman static void device_create_release(struct device *dev) 425123681e47SGreg Kroah-Hartman { 42521e0b2cf9SKay Sievers pr_debug("device: '%s': %s\n", dev_name(dev), __func__); 425323681e47SGreg Kroah-Hartman kfree(dev); 425423681e47SGreg Kroah-Hartman } 425523681e47SGreg Kroah-Hartman 42566a8b55d7SMathieu Malaterre static __printf(6, 0) struct device * 425739ef3112SGuenter Roeck device_create_groups_vargs(struct class *class, struct device *parent, 425839ef3112SGuenter Roeck dev_t devt, void *drvdata, 425939ef3112SGuenter Roeck const struct attribute_group **groups, 426039ef3112SGuenter Roeck const char *fmt, va_list args) 426139ef3112SGuenter Roeck { 426239ef3112SGuenter Roeck struct device *dev = NULL; 426339ef3112SGuenter Roeck int retval = -ENODEV; 426439ef3112SGuenter Roeck 4265d70590d5SYang Yingliang if (IS_ERR_OR_NULL(class)) 426639ef3112SGuenter Roeck goto error; 426739ef3112SGuenter Roeck 426839ef3112SGuenter Roeck dev = kzalloc(sizeof(*dev), GFP_KERNEL); 426939ef3112SGuenter Roeck if (!dev) { 427039ef3112SGuenter Roeck retval = -ENOMEM; 427139ef3112SGuenter Roeck goto error; 427239ef3112SGuenter Roeck } 427339ef3112SGuenter Roeck 4274bbc780f8SDavid Herrmann device_initialize(dev); 427539ef3112SGuenter Roeck dev->devt = devt; 427639ef3112SGuenter Roeck dev->class = class; 427739ef3112SGuenter Roeck dev->parent = parent; 427839ef3112SGuenter Roeck dev->groups = groups; 427939ef3112SGuenter Roeck dev->release = device_create_release; 428039ef3112SGuenter Roeck dev_set_drvdata(dev, drvdata); 428139ef3112SGuenter Roeck 428239ef3112SGuenter Roeck retval = kobject_set_name_vargs(&dev->kobj, fmt, args); 428339ef3112SGuenter Roeck if (retval) 428439ef3112SGuenter Roeck goto error; 428539ef3112SGuenter Roeck 4286bbc780f8SDavid Herrmann retval = device_add(dev); 428739ef3112SGuenter Roeck if (retval) 428839ef3112SGuenter Roeck goto error; 428939ef3112SGuenter Roeck 429039ef3112SGuenter Roeck return dev; 429139ef3112SGuenter Roeck 429239ef3112SGuenter Roeck error: 429339ef3112SGuenter Roeck put_device(dev); 429439ef3112SGuenter Roeck return ERR_PTR(retval); 429539ef3112SGuenter Roeck } 429639ef3112SGuenter Roeck 429723681e47SGreg Kroah-Hartman /** 42984e106739SGreg Kroah-Hartman * device_create - creates a device and registers it with sysfs 42998882b394SGreg Kroah-Hartman * @class: pointer to the struct class that this device should be registered to 43008882b394SGreg Kroah-Hartman * @parent: pointer to the parent struct device of this new device, if any 43018882b394SGreg Kroah-Hartman * @devt: the dev_t for the char device to be added 43028882b394SGreg Kroah-Hartman * @drvdata: the data to be added to the device for callbacks 43038882b394SGreg Kroah-Hartman * @fmt: string for the device's name 43048882b394SGreg Kroah-Hartman * 43058882b394SGreg Kroah-Hartman * This function can be used by char device classes. A struct device 43068882b394SGreg Kroah-Hartman * will be created in sysfs, registered to the specified class. 43078882b394SGreg Kroah-Hartman * 43088882b394SGreg Kroah-Hartman * A "dev" file will be created, showing the dev_t for the device, if 43098882b394SGreg Kroah-Hartman * the dev_t is not 0,0. 43108882b394SGreg Kroah-Hartman * If a pointer to a parent struct device is passed in, the newly created 43118882b394SGreg Kroah-Hartman * struct device will be a child of that device in sysfs. 43128882b394SGreg Kroah-Hartman * The pointer to the struct device will be returned from the call. 43138882b394SGreg Kroah-Hartman * Any further sysfs files that might be required can be created using this 43148882b394SGreg Kroah-Hartman * pointer. 43158882b394SGreg Kroah-Hartman * 4316f0eae0edSJani Nikula * Returns &struct device pointer on success, or ERR_PTR() on error. 4317f0eae0edSJani Nikula * 43188882b394SGreg Kroah-Hartman * Note: the struct class passed to this function must have previously 43198882b394SGreg Kroah-Hartman * been created with a call to class_create(). 43208882b394SGreg Kroah-Hartman */ 43214e106739SGreg Kroah-Hartman struct device *device_create(struct class *class, struct device *parent, 43224e106739SGreg Kroah-Hartman dev_t devt, void *drvdata, const char *fmt, ...) 43238882b394SGreg Kroah-Hartman { 43248882b394SGreg Kroah-Hartman va_list vargs; 43258882b394SGreg Kroah-Hartman struct device *dev; 43268882b394SGreg Kroah-Hartman 43278882b394SGreg Kroah-Hartman va_start(vargs, fmt); 43284c747466SChristoph Hellwig dev = device_create_groups_vargs(class, parent, devt, drvdata, NULL, 43294c747466SChristoph Hellwig fmt, vargs); 43308882b394SGreg Kroah-Hartman va_end(vargs); 43318882b394SGreg Kroah-Hartman return dev; 43328882b394SGreg Kroah-Hartman } 43334e106739SGreg Kroah-Hartman EXPORT_SYMBOL_GPL(device_create); 43348882b394SGreg Kroah-Hartman 433539ef3112SGuenter Roeck /** 433639ef3112SGuenter Roeck * device_create_with_groups - creates a device and registers it with sysfs 433739ef3112SGuenter Roeck * @class: pointer to the struct class that this device should be registered to 433839ef3112SGuenter Roeck * @parent: pointer to the parent struct device of this new device, if any 433939ef3112SGuenter Roeck * @devt: the dev_t for the char device to be added 434039ef3112SGuenter Roeck * @drvdata: the data to be added to the device for callbacks 434139ef3112SGuenter Roeck * @groups: NULL-terminated list of attribute groups to be created 434239ef3112SGuenter Roeck * @fmt: string for the device's name 434339ef3112SGuenter Roeck * 434439ef3112SGuenter Roeck * This function can be used by char device classes. A struct device 434539ef3112SGuenter Roeck * will be created in sysfs, registered to the specified class. 434639ef3112SGuenter Roeck * Additional attributes specified in the groups parameter will also 434739ef3112SGuenter Roeck * be created automatically. 434839ef3112SGuenter Roeck * 434939ef3112SGuenter Roeck * A "dev" file will be created, showing the dev_t for the device, if 435039ef3112SGuenter Roeck * the dev_t is not 0,0. 435139ef3112SGuenter Roeck * If a pointer to a parent struct device is passed in, the newly created 435239ef3112SGuenter Roeck * struct device will be a child of that device in sysfs. 435339ef3112SGuenter Roeck * The pointer to the struct device will be returned from the call. 435439ef3112SGuenter Roeck * Any further sysfs files that might be required can be created using this 435539ef3112SGuenter Roeck * pointer. 435639ef3112SGuenter Roeck * 435739ef3112SGuenter Roeck * Returns &struct device pointer on success, or ERR_PTR() on error. 435839ef3112SGuenter Roeck * 435939ef3112SGuenter Roeck * Note: the struct class passed to this function must have previously 436039ef3112SGuenter Roeck * been created with a call to class_create(). 436139ef3112SGuenter Roeck */ 436239ef3112SGuenter Roeck struct device *device_create_with_groups(struct class *class, 436339ef3112SGuenter Roeck struct device *parent, dev_t devt, 436439ef3112SGuenter Roeck void *drvdata, 436539ef3112SGuenter Roeck const struct attribute_group **groups, 436639ef3112SGuenter Roeck const char *fmt, ...) 436739ef3112SGuenter Roeck { 436839ef3112SGuenter Roeck va_list vargs; 436939ef3112SGuenter Roeck struct device *dev; 437039ef3112SGuenter Roeck 437139ef3112SGuenter Roeck va_start(vargs, fmt); 437239ef3112SGuenter Roeck dev = device_create_groups_vargs(class, parent, devt, drvdata, groups, 437339ef3112SGuenter Roeck fmt, vargs); 437439ef3112SGuenter Roeck va_end(vargs); 437539ef3112SGuenter Roeck return dev; 437639ef3112SGuenter Roeck } 437739ef3112SGuenter Roeck EXPORT_SYMBOL_GPL(device_create_with_groups); 437839ef3112SGuenter Roeck 4379775b64d2SRafael J. Wysocki /** 4380775b64d2SRafael J. Wysocki * device_destroy - removes a device that was created with device_create() 4381775b64d2SRafael J. Wysocki * @class: pointer to the struct class that this device was registered with 4382775b64d2SRafael J. Wysocki * @devt: the dev_t of the device that was previously registered 4383775b64d2SRafael J. Wysocki * 4384775b64d2SRafael J. Wysocki * This call unregisters and cleans up a device that was created with a 4385775b64d2SRafael J. Wysocki * call to device_create(). 4386775b64d2SRafael J. Wysocki */ 4387775b64d2SRafael J. Wysocki void device_destroy(struct class *class, dev_t devt) 4388775b64d2SRafael J. Wysocki { 4389775b64d2SRafael J. Wysocki struct device *dev; 4390775b64d2SRafael J. Wysocki 43914495dfddSSuzuki K Poulose dev = class_find_device_by_devt(class, devt); 4392cd35449bSDave Young if (dev) { 4393cd35449bSDave Young put_device(dev); 439423681e47SGreg Kroah-Hartman device_unregister(dev); 439523681e47SGreg Kroah-Hartman } 4396cd35449bSDave Young } 439723681e47SGreg Kroah-Hartman EXPORT_SYMBOL_GPL(device_destroy); 4398a2de48caSGreg Kroah-Hartman 4399a2de48caSGreg Kroah-Hartman /** 4400a2de48caSGreg Kroah-Hartman * device_rename - renames a device 4401a2de48caSGreg Kroah-Hartman * @dev: the pointer to the struct device to be renamed 4402a2de48caSGreg Kroah-Hartman * @new_name: the new name of the device 4403030c1d2bSEric W. Biederman * 4404030c1d2bSEric W. Biederman * It is the responsibility of the caller to provide mutual 4405030c1d2bSEric W. Biederman * exclusion between two different calls of device_rename 4406030c1d2bSEric W. Biederman * on the same device to ensure that new_name is valid and 4407030c1d2bSEric W. Biederman * won't conflict with other devices. 4408c6c0ac66SMichael Ellerman * 4409a5462516STimur Tabi * Note: Don't call this function. Currently, the networking layer calls this 4410a5462516STimur Tabi * function, but that will change. The following text from Kay Sievers offers 4411a5462516STimur Tabi * some insight: 4412a5462516STimur Tabi * 4413a5462516STimur Tabi * Renaming devices is racy at many levels, symlinks and other stuff are not 4414a5462516STimur Tabi * replaced atomically, and you get a "move" uevent, but it's not easy to 4415a5462516STimur Tabi * connect the event to the old and new device. Device nodes are not renamed at 4416a5462516STimur Tabi * all, there isn't even support for that in the kernel now. 4417a5462516STimur Tabi * 4418a5462516STimur Tabi * In the meantime, during renaming, your target name might be taken by another 4419a5462516STimur Tabi * driver, creating conflicts. Or the old name is taken directly after you 4420a5462516STimur Tabi * renamed it -- then you get events for the same DEVPATH, before you even see 4421a5462516STimur Tabi * the "move" event. It's just a mess, and nothing new should ever rely on 4422a5462516STimur Tabi * kernel device renaming. Besides that, it's not even implemented now for 4423a5462516STimur Tabi * other things than (driver-core wise very simple) network devices. 4424a5462516STimur Tabi * 4425a5462516STimur Tabi * We are currently about to change network renaming in udev to completely 4426a5462516STimur Tabi * disallow renaming of devices in the same namespace as the kernel uses, 4427a5462516STimur Tabi * because we can't solve the problems properly, that arise with swapping names 4428a5462516STimur Tabi * of multiple interfaces without races. Means, renaming of eth[0-9]* will only 4429a5462516STimur Tabi * be allowed to some other name than eth[0-9]*, for the aforementioned 4430a5462516STimur Tabi * reasons. 4431a5462516STimur Tabi * 4432a5462516STimur Tabi * Make up a "real" name in the driver before you register anything, or add 4433a5462516STimur Tabi * some other attributes for userspace to find the device, or use udev to add 4434a5462516STimur Tabi * symlinks -- but never rename kernel devices later, it's a complete mess. We 4435a5462516STimur Tabi * don't even want to get into that and try to implement the missing pieces in 4436a5462516STimur Tabi * the core. We really have other pieces to fix in the driver core mess. :) 4437a2de48caSGreg Kroah-Hartman */ 44386937e8f8SJohannes Berg int device_rename(struct device *dev, const char *new_name) 4439a2de48caSGreg Kroah-Hartman { 44404b30ee58STejun Heo struct kobject *kobj = &dev->kobj; 44412ee97cafSCornelia Huck char *old_device_name = NULL; 4442a2de48caSGreg Kroah-Hartman int error; 4443a2de48caSGreg Kroah-Hartman 4444a2de48caSGreg Kroah-Hartman dev = get_device(dev); 4445a2de48caSGreg Kroah-Hartman if (!dev) 4446a2de48caSGreg Kroah-Hartman return -EINVAL; 4447a2de48caSGreg Kroah-Hartman 444869df7533Sethan.zhao dev_dbg(dev, "renaming to %s\n", new_name); 4449a2de48caSGreg Kroah-Hartman 44501fa5ae85SKay Sievers old_device_name = kstrdup(dev_name(dev), GFP_KERNEL); 44512ee97cafSCornelia Huck if (!old_device_name) { 4452952ab431SJesper Juhl error = -ENOMEM; 44532ee97cafSCornelia Huck goto out; 4454952ab431SJesper Juhl } 4455a2de48caSGreg Kroah-Hartman 4456f349cf34SEric W. Biederman if (dev->class) { 44574b30ee58STejun Heo error = sysfs_rename_link_ns(&dev->class->p->subsys.kobj, 44584b30ee58STejun Heo kobj, old_device_name, 44594b30ee58STejun Heo new_name, kobject_namespace(kobj)); 4460f349cf34SEric W. Biederman if (error) 4461f349cf34SEric W. Biederman goto out; 4462f349cf34SEric W. Biederman } 446339aba963SKay Sievers 44644b30ee58STejun Heo error = kobject_rename(kobj, new_name); 44651fa5ae85SKay Sievers if (error) 44662ee97cafSCornelia Huck goto out; 4467a2de48caSGreg Kroah-Hartman 44682ee97cafSCornelia Huck out: 4469a2de48caSGreg Kroah-Hartman put_device(dev); 4470a2de48caSGreg Kroah-Hartman 44712ee97cafSCornelia Huck kfree(old_device_name); 4472a2de48caSGreg Kroah-Hartman 4473a2de48caSGreg Kroah-Hartman return error; 4474a2de48caSGreg Kroah-Hartman } 4475a2807dbcSJohannes Berg EXPORT_SYMBOL_GPL(device_rename); 44768a82472fSCornelia Huck 44778a82472fSCornelia Huck static int device_move_class_links(struct device *dev, 44788a82472fSCornelia Huck struct device *old_parent, 44798a82472fSCornelia Huck struct device *new_parent) 44808a82472fSCornelia Huck { 4481f7f3461dSGreg Kroah-Hartman int error = 0; 44828a82472fSCornelia Huck 4483f7f3461dSGreg Kroah-Hartman if (old_parent) 4484f7f3461dSGreg Kroah-Hartman sysfs_remove_link(&dev->kobj, "device"); 4485f7f3461dSGreg Kroah-Hartman if (new_parent) 4486f7f3461dSGreg Kroah-Hartman error = sysfs_create_link(&dev->kobj, &new_parent->kobj, 4487f7f3461dSGreg Kroah-Hartman "device"); 4488f7f3461dSGreg Kroah-Hartman return error; 44898a82472fSCornelia Huck } 44908a82472fSCornelia Huck 44918a82472fSCornelia Huck /** 44928a82472fSCornelia Huck * device_move - moves a device to a new parent 44938a82472fSCornelia Huck * @dev: the pointer to the struct device to be moved 449413509860SWolfram Sang * @new_parent: the new parent of the device (can be NULL) 4495ffa6a705SCornelia Huck * @dpm_order: how to reorder the dpm_list 44968a82472fSCornelia Huck */ 4497ffa6a705SCornelia Huck int device_move(struct device *dev, struct device *new_parent, 4498ffa6a705SCornelia Huck enum dpm_order dpm_order) 44998a82472fSCornelia Huck { 45008a82472fSCornelia Huck int error; 45018a82472fSCornelia Huck struct device *old_parent; 4502c744aeaeSCornelia Huck struct kobject *new_parent_kobj; 45038a82472fSCornelia Huck 45048a82472fSCornelia Huck dev = get_device(dev); 45058a82472fSCornelia Huck if (!dev) 45068a82472fSCornelia Huck return -EINVAL; 45078a82472fSCornelia Huck 4508ffa6a705SCornelia Huck device_pm_lock(); 45098a82472fSCornelia Huck new_parent = get_device(new_parent); 4510c744aeaeSCornelia Huck new_parent_kobj = get_device_parent(dev, new_parent); 451184d0c27dSTetsuo Handa if (IS_ERR(new_parent_kobj)) { 451284d0c27dSTetsuo Handa error = PTR_ERR(new_parent_kobj); 451384d0c27dSTetsuo Handa put_device(new_parent); 451484d0c27dSTetsuo Handa goto out; 451584d0c27dSTetsuo Handa } 451663b6971aSCornelia Huck 45171e0b2cf9SKay Sievers pr_debug("device: '%s': %s: moving to '%s'\n", dev_name(dev), 45181e0b2cf9SKay Sievers __func__, new_parent ? dev_name(new_parent) : "<NULL>"); 4519c744aeaeSCornelia Huck error = kobject_move(&dev->kobj, new_parent_kobj); 45208a82472fSCornelia Huck if (error) { 452163b6971aSCornelia Huck cleanup_glue_dir(dev, new_parent_kobj); 45228a82472fSCornelia Huck put_device(new_parent); 45238a82472fSCornelia Huck goto out; 45248a82472fSCornelia Huck } 45258a82472fSCornelia Huck old_parent = dev->parent; 45268a82472fSCornelia Huck dev->parent = new_parent; 45278a82472fSCornelia Huck if (old_parent) 4528f791b8c8SGreg Kroah-Hartman klist_remove(&dev->p->knode_parent); 45290d358f22SYinghai Lu if (new_parent) { 4530f791b8c8SGreg Kroah-Hartman klist_add_tail(&dev->p->knode_parent, 4531f791b8c8SGreg Kroah-Hartman &new_parent->p->klist_children); 45320d358f22SYinghai Lu set_dev_node(dev, dev_to_node(new_parent)); 45330d358f22SYinghai Lu } 45340d358f22SYinghai Lu 4535bdd4034dSRabin Vincent if (dev->class) { 45368a82472fSCornelia Huck error = device_move_class_links(dev, old_parent, new_parent); 45378a82472fSCornelia Huck if (error) { 45388a82472fSCornelia Huck /* We ignore errors on cleanup since we're hosed anyway... */ 45398a82472fSCornelia Huck device_move_class_links(dev, new_parent, old_parent); 45408a82472fSCornelia Huck if (!kobject_move(&dev->kobj, &old_parent->kobj)) { 4541c744aeaeSCornelia Huck if (new_parent) 4542f791b8c8SGreg Kroah-Hartman klist_remove(&dev->p->knode_parent); 45430d358f22SYinghai Lu dev->parent = old_parent; 45440d358f22SYinghai Lu if (old_parent) { 4545f791b8c8SGreg Kroah-Hartman klist_add_tail(&dev->p->knode_parent, 4546f791b8c8SGreg Kroah-Hartman &old_parent->p->klist_children); 45470d358f22SYinghai Lu set_dev_node(dev, dev_to_node(old_parent)); 45480d358f22SYinghai Lu } 45498a82472fSCornelia Huck } 455063b6971aSCornelia Huck cleanup_glue_dir(dev, new_parent_kobj); 45518a82472fSCornelia Huck put_device(new_parent); 45528a82472fSCornelia Huck goto out; 45538a82472fSCornelia Huck } 4554bdd4034dSRabin Vincent } 4555ffa6a705SCornelia Huck switch (dpm_order) { 4556ffa6a705SCornelia Huck case DPM_ORDER_NONE: 4557ffa6a705SCornelia Huck break; 4558ffa6a705SCornelia Huck case DPM_ORDER_DEV_AFTER_PARENT: 4559ffa6a705SCornelia Huck device_pm_move_after(dev, new_parent); 456052cdbdd4SGrygorii Strashko devices_kset_move_after(dev, new_parent); 4561ffa6a705SCornelia Huck break; 4562ffa6a705SCornelia Huck case DPM_ORDER_PARENT_BEFORE_DEV: 4563ffa6a705SCornelia Huck device_pm_move_before(new_parent, dev); 456452cdbdd4SGrygorii Strashko devices_kset_move_before(new_parent, dev); 4565ffa6a705SCornelia Huck break; 4566ffa6a705SCornelia Huck case DPM_ORDER_DEV_LAST: 4567ffa6a705SCornelia Huck device_pm_move_last(dev); 456852cdbdd4SGrygorii Strashko devices_kset_move_last(dev); 4569ffa6a705SCornelia Huck break; 4570ffa6a705SCornelia Huck } 4571bdd4034dSRabin Vincent 45728a82472fSCornelia Huck put_device(old_parent); 45738a82472fSCornelia Huck out: 4574ffa6a705SCornelia Huck device_pm_unlock(); 45758a82472fSCornelia Huck put_device(dev); 45768a82472fSCornelia Huck return error; 45778a82472fSCornelia Huck } 45788a82472fSCornelia Huck EXPORT_SYMBOL_GPL(device_move); 457937b0c020SGreg Kroah-Hartman 4580b8f33e5dSChristian Brauner static int device_attrs_change_owner(struct device *dev, kuid_t kuid, 4581b8f33e5dSChristian Brauner kgid_t kgid) 4582b8f33e5dSChristian Brauner { 4583b8f33e5dSChristian Brauner struct kobject *kobj = &dev->kobj; 4584b8f33e5dSChristian Brauner struct class *class = dev->class; 4585b8f33e5dSChristian Brauner const struct device_type *type = dev->type; 4586b8f33e5dSChristian Brauner int error; 4587b8f33e5dSChristian Brauner 4588b8f33e5dSChristian Brauner if (class) { 4589b8f33e5dSChristian Brauner /* 4590b8f33e5dSChristian Brauner * Change the device groups of the device class for @dev to 4591b8f33e5dSChristian Brauner * @kuid/@kgid. 4592b8f33e5dSChristian Brauner */ 4593b8f33e5dSChristian Brauner error = sysfs_groups_change_owner(kobj, class->dev_groups, kuid, 4594b8f33e5dSChristian Brauner kgid); 4595b8f33e5dSChristian Brauner if (error) 4596b8f33e5dSChristian Brauner return error; 4597b8f33e5dSChristian Brauner } 4598b8f33e5dSChristian Brauner 4599b8f33e5dSChristian Brauner if (type) { 4600b8f33e5dSChristian Brauner /* 4601b8f33e5dSChristian Brauner * Change the device groups of the device type for @dev to 4602b8f33e5dSChristian Brauner * @kuid/@kgid. 4603b8f33e5dSChristian Brauner */ 4604b8f33e5dSChristian Brauner error = sysfs_groups_change_owner(kobj, type->groups, kuid, 4605b8f33e5dSChristian Brauner kgid); 4606b8f33e5dSChristian Brauner if (error) 4607b8f33e5dSChristian Brauner return error; 4608b8f33e5dSChristian Brauner } 4609b8f33e5dSChristian Brauner 4610b8f33e5dSChristian Brauner /* Change the device groups of @dev to @kuid/@kgid. */ 4611b8f33e5dSChristian Brauner error = sysfs_groups_change_owner(kobj, dev->groups, kuid, kgid); 4612b8f33e5dSChristian Brauner if (error) 4613b8f33e5dSChristian Brauner return error; 4614b8f33e5dSChristian Brauner 4615b8f33e5dSChristian Brauner if (device_supports_offline(dev) && !dev->offline_disabled) { 4616b8f33e5dSChristian Brauner /* Change online device attributes of @dev to @kuid/@kgid. */ 4617b8f33e5dSChristian Brauner error = sysfs_file_change_owner(kobj, dev_attr_online.attr.name, 4618b8f33e5dSChristian Brauner kuid, kgid); 4619b8f33e5dSChristian Brauner if (error) 4620b8f33e5dSChristian Brauner return error; 4621b8f33e5dSChristian Brauner } 4622b8f33e5dSChristian Brauner 4623b8f33e5dSChristian Brauner return 0; 4624b8f33e5dSChristian Brauner } 4625b8f33e5dSChristian Brauner 4626b8f33e5dSChristian Brauner /** 4627b8f33e5dSChristian Brauner * device_change_owner - change the owner of an existing device. 4628b8f33e5dSChristian Brauner * @dev: device. 4629b8f33e5dSChristian Brauner * @kuid: new owner's kuid 4630b8f33e5dSChristian Brauner * @kgid: new owner's kgid 4631b8f33e5dSChristian Brauner * 4632b8f33e5dSChristian Brauner * This changes the owner of @dev and its corresponding sysfs entries to 4633b8f33e5dSChristian Brauner * @kuid/@kgid. This function closely mirrors how @dev was added via driver 4634b8f33e5dSChristian Brauner * core. 4635b8f33e5dSChristian Brauner * 4636b8f33e5dSChristian Brauner * Returns 0 on success or error code on failure. 4637b8f33e5dSChristian Brauner */ 4638b8f33e5dSChristian Brauner int device_change_owner(struct device *dev, kuid_t kuid, kgid_t kgid) 4639b8f33e5dSChristian Brauner { 4640b8f33e5dSChristian Brauner int error; 4641b8f33e5dSChristian Brauner struct kobject *kobj = &dev->kobj; 4642b8f33e5dSChristian Brauner 4643b8f33e5dSChristian Brauner dev = get_device(dev); 4644b8f33e5dSChristian Brauner if (!dev) 4645b8f33e5dSChristian Brauner return -EINVAL; 4646b8f33e5dSChristian Brauner 4647b8f33e5dSChristian Brauner /* 4648b8f33e5dSChristian Brauner * Change the kobject and the default attributes and groups of the 4649b8f33e5dSChristian Brauner * ktype associated with it to @kuid/@kgid. 4650b8f33e5dSChristian Brauner */ 4651b8f33e5dSChristian Brauner error = sysfs_change_owner(kobj, kuid, kgid); 4652b8f33e5dSChristian Brauner if (error) 4653b8f33e5dSChristian Brauner goto out; 4654b8f33e5dSChristian Brauner 4655b8f33e5dSChristian Brauner /* 4656b8f33e5dSChristian Brauner * Change the uevent file for @dev to the new owner. The uevent file 4657b8f33e5dSChristian Brauner * was created in a separate step when @dev got added and we mirror 4658b8f33e5dSChristian Brauner * that step here. 4659b8f33e5dSChristian Brauner */ 4660b8f33e5dSChristian Brauner error = sysfs_file_change_owner(kobj, dev_attr_uevent.attr.name, kuid, 4661b8f33e5dSChristian Brauner kgid); 4662b8f33e5dSChristian Brauner if (error) 4663b8f33e5dSChristian Brauner goto out; 4664b8f33e5dSChristian Brauner 4665b8f33e5dSChristian Brauner /* 4666b8f33e5dSChristian Brauner * Change the device groups, the device groups associated with the 4667b8f33e5dSChristian Brauner * device class, and the groups associated with the device type of @dev 4668b8f33e5dSChristian Brauner * to @kuid/@kgid. 4669b8f33e5dSChristian Brauner */ 4670b8f33e5dSChristian Brauner error = device_attrs_change_owner(dev, kuid, kgid); 4671b8f33e5dSChristian Brauner if (error) 4672b8f33e5dSChristian Brauner goto out; 4673b8f33e5dSChristian Brauner 46743b52fc5dSChristian Brauner error = dpm_sysfs_change_owner(dev, kuid, kgid); 46753b52fc5dSChristian Brauner if (error) 46763b52fc5dSChristian Brauner goto out; 46773b52fc5dSChristian Brauner 4678b8f33e5dSChristian Brauner /* 4679b8f33e5dSChristian Brauner * Change the owner of the symlink located in the class directory of 4680b8f33e5dSChristian Brauner * the device class associated with @dev which points to the actual 4681b8f33e5dSChristian Brauner * directory entry for @dev to @kuid/@kgid. This ensures that the 4682b8f33e5dSChristian Brauner * symlink shows the same permissions as its target. 4683b8f33e5dSChristian Brauner */ 4684b8f33e5dSChristian Brauner error = sysfs_link_change_owner(&dev->class->p->subsys.kobj, &dev->kobj, 4685b8f33e5dSChristian Brauner dev_name(dev), kuid, kgid); 4686b8f33e5dSChristian Brauner if (error) 4687b8f33e5dSChristian Brauner goto out; 4688b8f33e5dSChristian Brauner 4689b8f33e5dSChristian Brauner out: 4690b8f33e5dSChristian Brauner put_device(dev); 4691b8f33e5dSChristian Brauner return error; 4692b8f33e5dSChristian Brauner } 4693b8f33e5dSChristian Brauner EXPORT_SYMBOL_GPL(device_change_owner); 4694b8f33e5dSChristian Brauner 469537b0c020SGreg Kroah-Hartman /** 469637b0c020SGreg Kroah-Hartman * device_shutdown - call ->shutdown() on each device to shutdown. 469737b0c020SGreg Kroah-Hartman */ 469837b0c020SGreg Kroah-Hartman void device_shutdown(void) 469937b0c020SGreg Kroah-Hartman { 4700f123db8eSBenson Leung struct device *dev, *parent; 470137b0c020SGreg Kroah-Hartman 47023297c8fcSPingfan Liu wait_for_device_probe(); 47033297c8fcSPingfan Liu device_block_probing(); 47043297c8fcSPingfan Liu 470565650b35SRafael J. Wysocki cpufreq_suspend(); 470665650b35SRafael J. Wysocki 47076245838fSHugh Daschbach spin_lock(&devices_kset->list_lock); 47086245838fSHugh Daschbach /* 47096245838fSHugh Daschbach * Walk the devices list backward, shutting down each in turn. 47106245838fSHugh Daschbach * Beware that device unplug events may also start pulling 47116245838fSHugh Daschbach * devices offline, even as the system is shutting down. 47126245838fSHugh Daschbach */ 47136245838fSHugh Daschbach while (!list_empty(&devices_kset->list)) { 47146245838fSHugh Daschbach dev = list_entry(devices_kset->list.prev, struct device, 47156245838fSHugh Daschbach kobj.entry); 4716d1c6c030SMing Lei 4717d1c6c030SMing Lei /* 4718d1c6c030SMing Lei * hold reference count of device's parent to 4719d1c6c030SMing Lei * prevent it from being freed because parent's 4720d1c6c030SMing Lei * lock is to be held 4721d1c6c030SMing Lei */ 4722f123db8eSBenson Leung parent = get_device(dev->parent); 47236245838fSHugh Daschbach get_device(dev); 47246245838fSHugh Daschbach /* 47256245838fSHugh Daschbach * Make sure the device is off the kset list, in the 47266245838fSHugh Daschbach * event that dev->*->shutdown() doesn't remove it. 47276245838fSHugh Daschbach */ 47286245838fSHugh Daschbach list_del_init(&dev->kobj.entry); 47296245838fSHugh Daschbach spin_unlock(&devices_kset->list_lock); 4730fe6b91f4SAlan Stern 4731d1c6c030SMing Lei /* hold lock to avoid race with probe/release */ 4732f123db8eSBenson Leung if (parent) 4733f123db8eSBenson Leung device_lock(parent); 4734d1c6c030SMing Lei device_lock(dev); 4735d1c6c030SMing Lei 4736fe6b91f4SAlan Stern /* Don't allow any more runtime suspends */ 4737fe6b91f4SAlan Stern pm_runtime_get_noresume(dev); 4738fe6b91f4SAlan Stern pm_runtime_barrier(dev); 47396245838fSHugh Daschbach 47407521621eSMichal Suchanek if (dev->class && dev->class->shutdown_pre) { 4741f77af151SJosh Zimmerman if (initcall_debug) 47427521621eSMichal Suchanek dev_info(dev, "shutdown_pre\n"); 47437521621eSMichal Suchanek dev->class->shutdown_pre(dev); 47447521621eSMichal Suchanek } 47457521621eSMichal Suchanek if (dev->bus && dev->bus->shutdown) { 47460246c4faSShuoX Liu if (initcall_debug) 47470246c4faSShuoX Liu dev_info(dev, "shutdown\n"); 474837b0c020SGreg Kroah-Hartman dev->bus->shutdown(dev); 474937b0c020SGreg Kroah-Hartman } else if (dev->driver && dev->driver->shutdown) { 47500246c4faSShuoX Liu if (initcall_debug) 47510246c4faSShuoX Liu dev_info(dev, "shutdown\n"); 475237b0c020SGreg Kroah-Hartman dev->driver->shutdown(dev); 475337b0c020SGreg Kroah-Hartman } 4754d1c6c030SMing Lei 4755d1c6c030SMing Lei device_unlock(dev); 4756f123db8eSBenson Leung if (parent) 4757f123db8eSBenson Leung device_unlock(parent); 4758d1c6c030SMing Lei 47596245838fSHugh Daschbach put_device(dev); 4760f123db8eSBenson Leung put_device(parent); 47616245838fSHugh Daschbach 47626245838fSHugh Daschbach spin_lock(&devices_kset->list_lock); 476337b0c020SGreg Kroah-Hartman } 47646245838fSHugh Daschbach spin_unlock(&devices_kset->list_lock); 476537b0c020SGreg Kroah-Hartman } 476699bcf217SJoe Perches 476799bcf217SJoe Perches /* 476899bcf217SJoe Perches * Device logging functions 476999bcf217SJoe Perches */ 477099bcf217SJoe Perches 477199bcf217SJoe Perches #ifdef CONFIG_PRINTK 477274caba7fSJohn Ogness static void 477374caba7fSJohn Ogness set_dev_info(const struct device *dev, struct dev_printk_info *dev_info) 477499bcf217SJoe Perches { 4775c4e00daaSKay Sievers const char *subsys; 477674caba7fSJohn Ogness 477774caba7fSJohn Ogness memset(dev_info, 0, sizeof(*dev_info)); 477899bcf217SJoe Perches 4779c4e00daaSKay Sievers if (dev->class) 4780c4e00daaSKay Sievers subsys = dev->class->name; 4781c4e00daaSKay Sievers else if (dev->bus) 4782c4e00daaSKay Sievers subsys = dev->bus->name; 4783c4e00daaSKay Sievers else 478474caba7fSJohn Ogness return; 4785c4e00daaSKay Sievers 478674caba7fSJohn Ogness strscpy(dev_info->subsystem, subsys, sizeof(dev_info->subsystem)); 4787c4e00daaSKay Sievers 4788c4e00daaSKay Sievers /* 4789c4e00daaSKay Sievers * Add device identifier DEVICE=: 4790c4e00daaSKay Sievers * b12:8 block dev_t 4791c4e00daaSKay Sievers * c127:3 char dev_t 4792c4e00daaSKay Sievers * n8 netdev ifindex 4793c4e00daaSKay Sievers * +sound:card0 subsystem:devname 4794c4e00daaSKay Sievers */ 4795c4e00daaSKay Sievers if (MAJOR(dev->devt)) { 4796c4e00daaSKay Sievers char c; 4797c4e00daaSKay Sievers 4798c4e00daaSKay Sievers if (strcmp(subsys, "block") == 0) 4799c4e00daaSKay Sievers c = 'b'; 4800c4e00daaSKay Sievers else 4801c4e00daaSKay Sievers c = 'c'; 480274caba7fSJohn Ogness 480374caba7fSJohn Ogness snprintf(dev_info->device, sizeof(dev_info->device), 480474caba7fSJohn Ogness "%c%u:%u", c, MAJOR(dev->devt), MINOR(dev->devt)); 4805c4e00daaSKay Sievers } else if (strcmp(subsys, "net") == 0) { 4806c4e00daaSKay Sievers struct net_device *net = to_net_dev(dev); 4807c4e00daaSKay Sievers 480874caba7fSJohn Ogness snprintf(dev_info->device, sizeof(dev_info->device), 480974caba7fSJohn Ogness "n%u", net->ifindex); 4810c4e00daaSKay Sievers } else { 481174caba7fSJohn Ogness snprintf(dev_info->device, sizeof(dev_info->device), 481274caba7fSJohn Ogness "+%s:%s", subsys, dev_name(dev)); 4813c4e00daaSKay Sievers } 481499bcf217SJoe Perches } 4815798efc60SJoe Perches 481605e4e5b8SJoe Perches int dev_vprintk_emit(int level, const struct device *dev, 481705e4e5b8SJoe Perches const char *fmt, va_list args) 481805e4e5b8SJoe Perches { 481974caba7fSJohn Ogness struct dev_printk_info dev_info; 482005e4e5b8SJoe Perches 482174caba7fSJohn Ogness set_dev_info(dev, &dev_info); 482205e4e5b8SJoe Perches 482374caba7fSJohn Ogness return vprintk_emit(0, level, &dev_info, fmt, args); 482405e4e5b8SJoe Perches } 482505e4e5b8SJoe Perches EXPORT_SYMBOL(dev_vprintk_emit); 482605e4e5b8SJoe Perches 482705e4e5b8SJoe Perches int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...) 482805e4e5b8SJoe Perches { 482905e4e5b8SJoe Perches va_list args; 483005e4e5b8SJoe Perches int r; 483105e4e5b8SJoe Perches 483205e4e5b8SJoe Perches va_start(args, fmt); 483305e4e5b8SJoe Perches 483405e4e5b8SJoe Perches r = dev_vprintk_emit(level, dev, fmt, args); 483505e4e5b8SJoe Perches 483605e4e5b8SJoe Perches va_end(args); 483705e4e5b8SJoe Perches 483805e4e5b8SJoe Perches return r; 483905e4e5b8SJoe Perches } 484005e4e5b8SJoe Perches EXPORT_SYMBOL(dev_printk_emit); 484105e4e5b8SJoe Perches 4842d1f1052cSJoe Perches static void __dev_printk(const char *level, const struct device *dev, 4843798efc60SJoe Perches struct va_format *vaf) 4844798efc60SJoe Perches { 4845d1f1052cSJoe Perches if (dev) 4846d1f1052cSJoe Perches dev_printk_emit(level[1] - '0', dev, "%s %s: %pV", 4847798efc60SJoe Perches dev_driver_string(dev), dev_name(dev), vaf); 4848d1f1052cSJoe Perches else 4849d1f1052cSJoe Perches printk("%s(NULL device *): %pV", level, vaf); 4850798efc60SJoe Perches } 485199bcf217SJoe Perches 4852ad7d61f1SChris Down void _dev_printk(const char *level, const struct device *dev, 485399bcf217SJoe Perches const char *fmt, ...) 485499bcf217SJoe Perches { 485599bcf217SJoe Perches struct va_format vaf; 485699bcf217SJoe Perches va_list args; 485799bcf217SJoe Perches 485899bcf217SJoe Perches va_start(args, fmt); 485999bcf217SJoe Perches 486099bcf217SJoe Perches vaf.fmt = fmt; 486199bcf217SJoe Perches vaf.va = &args; 486299bcf217SJoe Perches 4863d1f1052cSJoe Perches __dev_printk(level, dev, &vaf); 4864798efc60SJoe Perches 486599bcf217SJoe Perches va_end(args); 486699bcf217SJoe Perches } 4867ad7d61f1SChris Down EXPORT_SYMBOL(_dev_printk); 486899bcf217SJoe Perches 486999bcf217SJoe Perches #define define_dev_printk_level(func, kern_level) \ 4870d1f1052cSJoe Perches void func(const struct device *dev, const char *fmt, ...) \ 487199bcf217SJoe Perches { \ 487299bcf217SJoe Perches struct va_format vaf; \ 487399bcf217SJoe Perches va_list args; \ 487499bcf217SJoe Perches \ 487599bcf217SJoe Perches va_start(args, fmt); \ 487699bcf217SJoe Perches \ 487799bcf217SJoe Perches vaf.fmt = fmt; \ 487899bcf217SJoe Perches vaf.va = &args; \ 487999bcf217SJoe Perches \ 4880d1f1052cSJoe Perches __dev_printk(kern_level, dev, &vaf); \ 4881798efc60SJoe Perches \ 488299bcf217SJoe Perches va_end(args); \ 488399bcf217SJoe Perches } \ 488499bcf217SJoe Perches EXPORT_SYMBOL(func); 488599bcf217SJoe Perches 4886663336eeSJoe Perches define_dev_printk_level(_dev_emerg, KERN_EMERG); 4887663336eeSJoe Perches define_dev_printk_level(_dev_alert, KERN_ALERT); 4888663336eeSJoe Perches define_dev_printk_level(_dev_crit, KERN_CRIT); 4889663336eeSJoe Perches define_dev_printk_level(_dev_err, KERN_ERR); 4890663336eeSJoe Perches define_dev_printk_level(_dev_warn, KERN_WARNING); 4891663336eeSJoe Perches define_dev_printk_level(_dev_notice, KERN_NOTICE); 489299bcf217SJoe Perches define_dev_printk_level(_dev_info, KERN_INFO); 489399bcf217SJoe Perches 489499bcf217SJoe Perches #endif 489597badf87SRafael J. Wysocki 4896a787e540SAndrzej Hajda /** 4897a787e540SAndrzej Hajda * dev_err_probe - probe error check and log helper 4898a787e540SAndrzej Hajda * @dev: the pointer to the struct device 4899a787e540SAndrzej Hajda * @err: error value to test 4900a787e540SAndrzej Hajda * @fmt: printf-style format string 4901a787e540SAndrzej Hajda * @...: arguments as specified in the format string 4902a787e540SAndrzej Hajda * 4903a787e540SAndrzej Hajda * This helper implements common pattern present in probe functions for error 4904a787e540SAndrzej Hajda * checking: print debug or error message depending if the error value is 4905a787e540SAndrzej Hajda * -EPROBE_DEFER and propagate error upwards. 4906d090b70eSAndrzej Hajda * In case of -EPROBE_DEFER it sets also defer probe reason, which can be 4907d090b70eSAndrzej Hajda * checked later by reading devices_deferred debugfs attribute. 4908074b3aadSMauro Carvalho Chehab * It replaces code sequence:: 4909074b3aadSMauro Carvalho Chehab * 4910a787e540SAndrzej Hajda * if (err != -EPROBE_DEFER) 4911a787e540SAndrzej Hajda * dev_err(dev, ...); 4912a787e540SAndrzej Hajda * else 4913a787e540SAndrzej Hajda * dev_dbg(dev, ...); 4914a787e540SAndrzej Hajda * return err; 4915074b3aadSMauro Carvalho Chehab * 4916074b3aadSMauro Carvalho Chehab * with:: 4917074b3aadSMauro Carvalho Chehab * 4918a787e540SAndrzej Hajda * return dev_err_probe(dev, err, ...); 4919a787e540SAndrzej Hajda * 49207065f922SDouglas Anderson * Note that it is deemed acceptable to use this function for error 49217065f922SDouglas Anderson * prints during probe even if the @err is known to never be -EPROBE_DEFER. 49227065f922SDouglas Anderson * The benefit compared to a normal dev_err() is the standardized format 49237065f922SDouglas Anderson * of the error code and the fact that the error code is returned. 49247065f922SDouglas Anderson * 4925a787e540SAndrzej Hajda * Returns @err. 4926a787e540SAndrzej Hajda * 4927a787e540SAndrzej Hajda */ 4928a787e540SAndrzej Hajda int dev_err_probe(const struct device *dev, int err, const char *fmt, ...) 4929a787e540SAndrzej Hajda { 4930a787e540SAndrzej Hajda struct va_format vaf; 4931a787e540SAndrzej Hajda va_list args; 4932a787e540SAndrzej Hajda 4933a787e540SAndrzej Hajda va_start(args, fmt); 4934a787e540SAndrzej Hajda vaf.fmt = fmt; 4935a787e540SAndrzej Hajda vaf.va = &args; 4936a787e540SAndrzej Hajda 4937d090b70eSAndrzej Hajda if (err != -EPROBE_DEFER) { 4938693a8e93SMichał Mirosław dev_err(dev, "error %pe: %pV", ERR_PTR(err), &vaf); 4939d090b70eSAndrzej Hajda } else { 4940d090b70eSAndrzej Hajda device_set_deferred_probe_reason(dev, &vaf); 4941693a8e93SMichał Mirosław dev_dbg(dev, "error %pe: %pV", ERR_PTR(err), &vaf); 4942d090b70eSAndrzej Hajda } 4943a787e540SAndrzej Hajda 4944a787e540SAndrzej Hajda va_end(args); 4945a787e540SAndrzej Hajda 4946a787e540SAndrzej Hajda return err; 4947a787e540SAndrzej Hajda } 4948a787e540SAndrzej Hajda EXPORT_SYMBOL_GPL(dev_err_probe); 4949a787e540SAndrzej Hajda 495097badf87SRafael J. Wysocki static inline bool fwnode_is_primary(struct fwnode_handle *fwnode) 495197badf87SRafael J. Wysocki { 495297badf87SRafael J. Wysocki return fwnode && !IS_ERR(fwnode->secondary); 495397badf87SRafael J. Wysocki } 495497badf87SRafael J. Wysocki 495597badf87SRafael J. Wysocki /** 495697badf87SRafael J. Wysocki * set_primary_fwnode - Change the primary firmware node of a given device. 495797badf87SRafael J. Wysocki * @dev: Device to handle. 495897badf87SRafael J. Wysocki * @fwnode: New primary firmware node of the device. 495997badf87SRafael J. Wysocki * 496097badf87SRafael J. Wysocki * Set the device's firmware node pointer to @fwnode, but if a secondary 496197badf87SRafael J. Wysocki * firmware node of the device is present, preserve it. 49623f7bddafSBard Liao * 49633f7bddafSBard Liao * Valid fwnode cases are: 49643f7bddafSBard Liao * - primary --> secondary --> -ENODEV 49653f7bddafSBard Liao * - primary --> NULL 49663f7bddafSBard Liao * - secondary --> -ENODEV 49673f7bddafSBard Liao * - NULL 496897badf87SRafael J. Wysocki */ 496997badf87SRafael J. Wysocki void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode) 497097badf87SRafael J. Wysocki { 497199aed922SAndy Shevchenko struct device *parent = dev->parent; 497297badf87SRafael J. Wysocki struct fwnode_handle *fn = dev->fwnode; 497397badf87SRafael J. Wysocki 4974c15e1bddSHeikki Krogerus if (fwnode) { 497597badf87SRafael J. Wysocki if (fwnode_is_primary(fn)) 497697badf87SRafael J. Wysocki fn = fn->secondary; 497797badf87SRafael J. Wysocki 497855f89a8aSMika Westerberg if (fn) { 497955f89a8aSMika Westerberg WARN_ON(fwnode->secondary); 498097badf87SRafael J. Wysocki fwnode->secondary = fn; 498155f89a8aSMika Westerberg } 498297badf87SRafael J. Wysocki dev->fwnode = fwnode; 498397badf87SRafael J. Wysocki } else { 4984c15e1bddSHeikki Krogerus if (fwnode_is_primary(fn)) { 4985c15e1bddSHeikki Krogerus dev->fwnode = fn->secondary; 49863f7bddafSBard Liao /* Set fn->secondary = NULL, so fn remains the primary fwnode */ 498799aed922SAndy Shevchenko if (!(parent && fn == parent->fwnode)) 498847f44699SBard Liao fn->secondary = NULL; 4989c15e1bddSHeikki Krogerus } else { 4990c15e1bddSHeikki Krogerus dev->fwnode = NULL; 4991c15e1bddSHeikki Krogerus } 499297badf87SRafael J. Wysocki } 499397badf87SRafael J. Wysocki } 499497badf87SRafael J. Wysocki EXPORT_SYMBOL_GPL(set_primary_fwnode); 499597badf87SRafael J. Wysocki 499697badf87SRafael J. Wysocki /** 499797badf87SRafael J. Wysocki * set_secondary_fwnode - Change the secondary firmware node of a given device. 499897badf87SRafael J. Wysocki * @dev: Device to handle. 499997badf87SRafael J. Wysocki * @fwnode: New secondary firmware node of the device. 500097badf87SRafael J. Wysocki * 500197badf87SRafael J. Wysocki * If a primary firmware node of the device is present, set its secondary 500297badf87SRafael J. Wysocki * pointer to @fwnode. Otherwise, set the device's firmware node pointer to 500397badf87SRafael J. Wysocki * @fwnode. 500497badf87SRafael J. Wysocki */ 500597badf87SRafael J. Wysocki void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode) 500697badf87SRafael J. Wysocki { 500797badf87SRafael J. Wysocki if (fwnode) 500897badf87SRafael J. Wysocki fwnode->secondary = ERR_PTR(-ENODEV); 500997badf87SRafael J. Wysocki 501097badf87SRafael J. Wysocki if (fwnode_is_primary(dev->fwnode)) 501197badf87SRafael J. Wysocki dev->fwnode->secondary = fwnode; 501297badf87SRafael J. Wysocki else 501397badf87SRafael J. Wysocki dev->fwnode = fwnode; 501497badf87SRafael J. Wysocki } 501596489ae1SAndy Shevchenko EXPORT_SYMBOL_GPL(set_secondary_fwnode); 50164e75e1d7SJohan Hovold 50174e75e1d7SJohan Hovold /** 50184e75e1d7SJohan Hovold * device_set_of_node_from_dev - reuse device-tree node of another device 50194e75e1d7SJohan Hovold * @dev: device whose device-tree node is being set 50204e75e1d7SJohan Hovold * @dev2: device whose device-tree node is being reused 50214e75e1d7SJohan Hovold * 50224e75e1d7SJohan Hovold * Takes another reference to the new device-tree node after first dropping 50234e75e1d7SJohan Hovold * any reference held to the old node. 50244e75e1d7SJohan Hovold */ 50254e75e1d7SJohan Hovold void device_set_of_node_from_dev(struct device *dev, const struct device *dev2) 50264e75e1d7SJohan Hovold { 50274e75e1d7SJohan Hovold of_node_put(dev->of_node); 50284e75e1d7SJohan Hovold dev->of_node = of_node_get(dev2->of_node); 50294e75e1d7SJohan Hovold dev->of_node_reused = true; 50304e75e1d7SJohan Hovold } 50314e75e1d7SJohan Hovold EXPORT_SYMBOL_GPL(device_set_of_node_from_dev); 503265b66682SSuzuki K Poulose 503343e76d46SIoana Ciornei void device_set_node(struct device *dev, struct fwnode_handle *fwnode) 503443e76d46SIoana Ciornei { 503543e76d46SIoana Ciornei dev->fwnode = fwnode; 503643e76d46SIoana Ciornei dev->of_node = to_of_node(fwnode); 503743e76d46SIoana Ciornei } 503843e76d46SIoana Ciornei EXPORT_SYMBOL_GPL(device_set_node); 503943e76d46SIoana Ciornei 50406cda08a2SSuzuki K Poulose int device_match_name(struct device *dev, const void *name) 50416cda08a2SSuzuki K Poulose { 50426cda08a2SSuzuki K Poulose return sysfs_streq(dev_name(dev), name); 50436cda08a2SSuzuki K Poulose } 50446cda08a2SSuzuki K Poulose EXPORT_SYMBOL_GPL(device_match_name); 50456cda08a2SSuzuki K Poulose 504665b66682SSuzuki K Poulose int device_match_of_node(struct device *dev, const void *np) 504765b66682SSuzuki K Poulose { 504865b66682SSuzuki K Poulose return dev->of_node == np; 504965b66682SSuzuki K Poulose } 505065b66682SSuzuki K Poulose EXPORT_SYMBOL_GPL(device_match_of_node); 505167843bbaSSuzuki K Poulose 505267843bbaSSuzuki K Poulose int device_match_fwnode(struct device *dev, const void *fwnode) 505367843bbaSSuzuki K Poulose { 505467843bbaSSuzuki K Poulose return dev_fwnode(dev) == fwnode; 505567843bbaSSuzuki K Poulose } 505667843bbaSSuzuki K Poulose EXPORT_SYMBOL_GPL(device_match_fwnode); 50574495dfddSSuzuki K Poulose 50584495dfddSSuzuki K Poulose int device_match_devt(struct device *dev, const void *pdevt) 50594495dfddSSuzuki K Poulose { 50604495dfddSSuzuki K Poulose return dev->devt == *(dev_t *)pdevt; 50614495dfddSSuzuki K Poulose } 50624495dfddSSuzuki K Poulose EXPORT_SYMBOL_GPL(device_match_devt); 506300500147SSuzuki K Poulose 506400500147SSuzuki K Poulose int device_match_acpi_dev(struct device *dev, const void *adev) 506500500147SSuzuki K Poulose { 506600500147SSuzuki K Poulose return ACPI_COMPANION(dev) == adev; 506700500147SSuzuki K Poulose } 506800500147SSuzuki K Poulose EXPORT_SYMBOL(device_match_acpi_dev); 50696bf85ba9SSuzuki K Poulose 5070a164ff53SAndy Shevchenko int device_match_acpi_handle(struct device *dev, const void *handle) 5071a164ff53SAndy Shevchenko { 5072a164ff53SAndy Shevchenko return ACPI_HANDLE(dev) == handle; 5073a164ff53SAndy Shevchenko } 5074a164ff53SAndy Shevchenko EXPORT_SYMBOL(device_match_acpi_handle); 5075a164ff53SAndy Shevchenko 50766bf85ba9SSuzuki K Poulose int device_match_any(struct device *dev, const void *unused) 50776bf85ba9SSuzuki K Poulose { 50786bf85ba9SSuzuki K Poulose return 1; 50796bf85ba9SSuzuki K Poulose } 50806bf85ba9SSuzuki K Poulose EXPORT_SYMBOL_GPL(device_match_any); 5081