1b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */ 25367601bSGreg Kroah-Hartman /* 35367601bSGreg Kroah-Hartman * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org> 45367601bSGreg Kroah-Hartman * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de> 55367601bSGreg Kroah-Hartman * Copyright (c) 2008-2012 Novell Inc. 65367601bSGreg Kroah-Hartman * Copyright (c) 2012-2019 Greg Kroah-Hartman <gregkh@linuxfoundation.org> 75367601bSGreg Kroah-Hartman * Copyright (c) 2012-2019 Linux Foundation 85367601bSGreg Kroah-Hartman * 95367601bSGreg Kroah-Hartman * Core driver model functions and structures that should not be 105367601bSGreg Kroah-Hartman * shared outside of the drivers/base/ directory. 115367601bSGreg Kroah-Hartman * 125367601bSGreg Kroah-Hartman */ 13ba33162aSPaul Gortmaker #include <linux/notifier.h> 14a1bdc7aaSBen Dooks 15c6f7e72aSGreg Kroah-Hartman /** 166b6e39a6SKay Sievers * struct subsys_private - structure to hold the private to the driver core portions of the bus_type/class structure. 17c6f7e72aSGreg Kroah-Hartman * 186b6e39a6SKay Sievers * @subsys - the struct kset that defines this subsystem 19ca22e56dSKay Sievers * @devices_kset - the subsystem's 'devices' directory 20ca22e56dSKay Sievers * @interfaces - list of subsystem interfaces associated 21ca22e56dSKay Sievers * @mutex - protect the devices, and interfaces lists. 226b6e39a6SKay Sievers * 236b6e39a6SKay Sievers * @drivers_kset - the list of drivers associated 24c6f7e72aSGreg Kroah-Hartman * @klist_devices - the klist to iterate over the @devices_kset 25c6f7e72aSGreg Kroah-Hartman * @klist_drivers - the klist to iterate over the @drivers_kset 26c6f7e72aSGreg Kroah-Hartman * @bus_notifier - the bus notifier list for anything that cares about things 27c6f7e72aSGreg Kroah-Hartman * on this bus. 28c6f7e72aSGreg Kroah-Hartman * @bus - pointer back to the struct bus_type that this structure is associated 29c6f7e72aSGreg Kroah-Hartman * with. 309cc61e5fSGreg Kroah-Hartman * @dev_root: Default device to use as the parent. 31c6f7e72aSGreg Kroah-Hartman * 326b6e39a6SKay Sievers * @glue_dirs - "glue" directory to put in-between the parent device to 336b6e39a6SKay Sievers * avoid namespace conflicts 346b6e39a6SKay Sievers * @class - pointer back to the struct class that this structure is associated 356b6e39a6SKay Sievers * with. 3600945520SGreg Kroah-Hartman * @lock_key: Lock class key for use by the lock validator 376b6e39a6SKay Sievers * 38c6f7e72aSGreg Kroah-Hartman * This structure is the one that is the actual kobject allowing struct 396b6e39a6SKay Sievers * bus_type/class to be statically allocated safely. Nothing outside of the 406b6e39a6SKay Sievers * driver core should ever touch these fields. 41c6f7e72aSGreg Kroah-Hartman */ 426b6e39a6SKay Sievers struct subsys_private { 43c6f7e72aSGreg Kroah-Hartman struct kset subsys; 44c6f7e72aSGreg Kroah-Hartman struct kset *devices_kset; 45ca22e56dSKay Sievers struct list_head interfaces; 46ca22e56dSKay Sievers struct mutex mutex; 476b6e39a6SKay Sievers 486b6e39a6SKay Sievers struct kset *drivers_kset; 49c6f7e72aSGreg Kroah-Hartman struct klist klist_devices; 50c6f7e72aSGreg Kroah-Hartman struct klist klist_drivers; 51c6f7e72aSGreg Kroah-Hartman struct blocking_notifier_head bus_notifier; 52c6f7e72aSGreg Kroah-Hartman unsigned int drivers_autoprobe:1; 5300c4a3c4SGreg Kroah-Hartman const struct bus_type *bus; 549cc61e5fSGreg Kroah-Hartman struct device *dev_root; 556b6e39a6SKay Sievers 566b6e39a6SKay Sievers struct kset glue_dirs; 57*43a7206bSGreg Kroah-Hartman const struct class *class; 5837e98d9bSGreg Kroah-Hartman 5937e98d9bSGreg Kroah-Hartman struct lock_class_key lock_key; 60c6f7e72aSGreg Kroah-Hartman }; 617bbb89b4SGreg Kroah-Hartman #define to_subsys_private(obj) container_of_const(obj, struct subsys_private, subsys.kobj) 62a1bdc7aaSBen Dooks 63789be03aSGreg Kroah-Hartman static inline struct subsys_private *subsys_get(struct subsys_private *sp) 64789be03aSGreg Kroah-Hartman { 65789be03aSGreg Kroah-Hartman if (sp) 66789be03aSGreg Kroah-Hartman kset_get(&sp->subsys); 67789be03aSGreg Kroah-Hartman return sp; 68789be03aSGreg Kroah-Hartman } 69789be03aSGreg Kroah-Hartman 70789be03aSGreg Kroah-Hartman static inline void subsys_put(struct subsys_private *sp) 71789be03aSGreg Kroah-Hartman { 72789be03aSGreg Kroah-Hartman if (sp) 73789be03aSGreg Kroah-Hartman kset_put(&sp->subsys); 74789be03aSGreg Kroah-Hartman } 75789be03aSGreg Kroah-Hartman 767d90e81aSGreg Kroah-Hartman struct subsys_private *class_to_subsys(const struct class *class); 777d90e81aSGreg Kroah-Hartman 78e5dd1278SGreg Kroah-Hartman struct driver_private { 79e5dd1278SGreg Kroah-Hartman struct kobject kobj; 80e5dd1278SGreg Kroah-Hartman struct klist klist_devices; 81e5dd1278SGreg Kroah-Hartman struct klist_node knode_bus; 82e5dd1278SGreg Kroah-Hartman struct module_kobject *mkobj; 83e5dd1278SGreg Kroah-Hartman struct device_driver *driver; 84e5dd1278SGreg Kroah-Hartman }; 85e5dd1278SGreg Kroah-Hartman #define to_driver(obj) container_of(obj, struct driver_private, kobj) 86c6f7e72aSGreg Kroah-Hartman 87fb069a5dSGreg Kroah-Hartman /** 88fb069a5dSGreg Kroah-Hartman * struct device_private - structure to hold the private to the driver core portions of the device structure. 89fb069a5dSGreg Kroah-Hartman * 90f791b8c8SGreg Kroah-Hartman * @klist_children - klist containing all children of this device 91f791b8c8SGreg Kroah-Hartman * @knode_parent - node in sibling list 928940b4f3SGreg Kroah-Hartman * @knode_driver - node in driver list 93ae1b4171SGreg Kroah-Hartman * @knode_bus - node in bus list 94570d0200SWei Yang * @knode_class - node in class list 95ef8a3fd6SGreg Kroah-Hartman * @deferred_probe - entry in deferred_probe_list which is used to retry the 96ef8a3fd6SGreg Kroah-Hartman * binding of drivers which were unable to get all the resources needed by 97ef8a3fd6SGreg Kroah-Hartman * the device; typically because it depends on another driver getting 98ef8a3fd6SGreg Kroah-Hartman * probed first. 99ef0ff683SAlexander Duyck * @async_driver - pointer to device driver awaiting probe via async_probe 10082b2c3c5STomeu Vizoso * @device - pointer back to the struct device that this structure is 101fb069a5dSGreg Kroah-Hartman * associated with. 1023451a495SAlexander Duyck * @dead - This device is currently either in the process of or has been 1033451a495SAlexander Duyck * removed from the system. Any asynchronous events scheduled for this 1043451a495SAlexander Duyck * device should exit without taking any action. 105fb069a5dSGreg Kroah-Hartman * 106fb069a5dSGreg Kroah-Hartman * Nothing outside of the driver core should ever touch these fields. 107fb069a5dSGreg Kroah-Hartman */ 108fb069a5dSGreg Kroah-Hartman struct device_private { 109f791b8c8SGreg Kroah-Hartman struct klist klist_children; 110f791b8c8SGreg Kroah-Hartman struct klist_node knode_parent; 1118940b4f3SGreg Kroah-Hartman struct klist_node knode_driver; 112ae1b4171SGreg Kroah-Hartman struct klist_node knode_bus; 113570d0200SWei Yang struct klist_node knode_class; 114ef8a3fd6SGreg Kroah-Hartman struct list_head deferred_probe; 115ef0ff683SAlexander Duyck struct device_driver *async_driver; 116d090b70eSAndrzej Hajda char *deferred_probe_reason; 117fb069a5dSGreg Kroah-Hartman struct device *device; 1183451a495SAlexander Duyck u8 dead:1; 119fb069a5dSGreg Kroah-Hartman }; 120f791b8c8SGreg Kroah-Hartman #define to_device_private_parent(obj) \ 121f791b8c8SGreg Kroah-Hartman container_of(obj, struct device_private, knode_parent) 1228940b4f3SGreg Kroah-Hartman #define to_device_private_driver(obj) \ 1238940b4f3SGreg Kroah-Hartman container_of(obj, struct device_private, knode_driver) 124ae1b4171SGreg Kroah-Hartman #define to_device_private_bus(obj) \ 125ae1b4171SGreg Kroah-Hartman container_of(obj, struct device_private, knode_bus) 126570d0200SWei Yang #define to_device_private_class(obj) \ 127570d0200SWei Yang container_of(obj, struct device_private, knode_class) 128fb069a5dSGreg Kroah-Hartman 129c6f7e72aSGreg Kroah-Hartman /* initialisation functions */ 1308da5b970SGreg Kroah-Hartman int devices_init(void); 1318da5b970SGreg Kroah-Hartman int buses_init(void); 1328da5b970SGreg Kroah-Hartman int classes_init(void); 1338da5b970SGreg Kroah-Hartman int firmware_init(void); 1344039483fSMichael Holzheu #ifdef CONFIG_SYS_HYPERVISOR 1358da5b970SGreg Kroah-Hartman int hypervisor_init(void); 1364039483fSMichael Holzheu #else 1374039483fSMichael Holzheu static inline int hypervisor_init(void) { return 0; } 1384039483fSMichael Holzheu #endif 1398da5b970SGreg Kroah-Hartman int platform_bus_init(void); 1408da5b970SGreg Kroah-Hartman void cpu_dev_init(void); 1418da5b970SGreg Kroah-Hartman void container_dev_init(void); 142471b12c4SDave Jiang #ifdef CONFIG_AUXILIARY_BUS 1438da5b970SGreg Kroah-Hartman void auxiliary_bus_init(void); 144471b12c4SDave Jiang #else 145471b12c4SDave Jiang static inline void auxiliary_bus_init(void) { } 146471b12c4SDave Jiang #endif 147a1bdc7aaSBen Dooks 148d73ce004STejun Heo struct kobject *virtual_device_parent(struct device *dev); 149d73ce004STejun Heo 1508da5b970SGreg Kroah-Hartman int bus_add_device(struct device *dev); 1518da5b970SGreg Kroah-Hartman void bus_probe_device(struct device *dev); 1528da5b970SGreg Kroah-Hartman void bus_remove_device(struct device *dev); 153ed9f9181SGreg Kroah-Hartman void bus_notify(struct device *dev, enum bus_notifier_event value); 15463b823d7SGreg Kroah-Hartman bool bus_is_registered(const struct bus_type *bus); 1551da177e4SLinus Torvalds 1568da5b970SGreg Kroah-Hartman int bus_add_driver(struct device_driver *drv); 1578da5b970SGreg Kroah-Hartman void bus_remove_driver(struct device_driver *drv); 1588da5b970SGreg Kroah-Hartman void device_release_driver_internal(struct device *dev, struct device_driver *drv, 1599ed98953SRafael J. Wysocki struct device *parent); 1601da177e4SLinus Torvalds 1618da5b970SGreg Kroah-Hartman void driver_detach(struct device_driver *drv); 1628da5b970SGreg Kroah-Hartman void driver_deferred_probe_del(struct device *dev); 1638da5b970SGreg Kroah-Hartman void device_set_deferred_probe_reason(const struct device *dev, struct va_format *vaf); 16449b420a1SMing Lei static inline int driver_match_device(struct device_driver *drv, 16549b420a1SMing Lei struct device *dev) 16649b420a1SMing Lei { 1675247aecfSMing Lei return drv->bus->match ? drv->bus->match(dev, drv) : 1; 16849b420a1SMing Lei } 16907e4a3e2Smochel@digitalimplant.org 170f8fb5766SSaravana Kannan static inline void dev_sync_state(struct device *dev) 171f8fb5766SSaravana Kannan { 172f8fb5766SSaravana Kannan if (dev->bus->sync_state) 173f8fb5766SSaravana Kannan dev->bus->sync_state(dev); 174f8fb5766SSaravana Kannan else if (dev->driver && dev->driver->sync_state) 175f8fb5766SSaravana Kannan dev->driver->sync_state(dev); 176f8fb5766SSaravana Kannan } 177f8fb5766SSaravana Kannan 1788da5b970SGreg Kroah-Hartman int driver_add_groups(struct device_driver *drv, const struct attribute_group **groups); 1798da5b970SGreg Kroah-Hartman void driver_remove_groups(struct device_driver *drv, const struct attribute_group **groups); 180ed88747cSAlexander Duyck void device_driver_detach(struct device *dev); 181ed0617b5SGreg Kroah-Hartman 1828da5b970SGreg Kroah-Hartman int devres_release_all(struct device *dev); 1838da5b970SGreg Kroah-Hartman void device_block_probing(void); 1848da5b970SGreg Kroah-Hartman void device_unblock_probing(void); 1858da5b970SGreg Kroah-Hartman void deferred_probe_extend_timeout(void); 1868da5b970SGreg Kroah-Hartman void driver_deferred_probe_trigger(void); 18742bb5be8SGreg Kroah-Hartman const char *device_get_devnode(const struct device *dev, umode_t *mode, 18842bb5be8SGreg Kroah-Hartman kuid_t *uid, kgid_t *gid, const char **tmp); 189823bccfcSGreg Kroah-Hartman 190ca22e56dSKay Sievers /* /sys/devices directory */ 191881c6cfdSGreg Kroah-Hartman extern struct kset *devices_kset; 1928da5b970SGreg Kroah-Hartman void devices_kset_move_last(struct device *dev); 193c63469a3SGreg Kroah-Hartman 19492b42141SRandy Dunlap #if defined(CONFIG_MODULES) && defined(CONFIG_SYSFS) 1958da5b970SGreg Kroah-Hartman void module_add_driver(struct module *mod, struct device_driver *drv); 1968da5b970SGreg Kroah-Hartman void module_remove_driver(struct device_driver *drv); 197c63469a3SGreg Kroah-Hartman #else 198c63469a3SGreg Kroah-Hartman static inline void module_add_driver(struct module *mod, 199c63469a3SGreg Kroah-Hartman struct device_driver *drv) { } 200c63469a3SGreg Kroah-Hartman static inline void module_remove_driver(struct device_driver *drv) { } 201c63469a3SGreg Kroah-Hartman #endif 2022b2af54aSKay Sievers 2032b2af54aSKay Sievers #ifdef CONFIG_DEVTMPFS 2048da5b970SGreg Kroah-Hartman int devtmpfs_init(void); 2052b2af54aSKay Sievers #else 2062b2af54aSKay Sievers static inline int devtmpfs_init(void) { return 0; } 2072b2af54aSKay Sievers #endif 2089ed98953SRafael J. Wysocki 209d6bdbbdfSGreg Kroah-Hartman #ifdef CONFIG_BLOCK 210d6bdbbdfSGreg Kroah-Hartman extern struct class block_class; 211d6bdbbdfSGreg Kroah-Hartman static inline bool is_blockdev(struct device *dev) 212d6bdbbdfSGreg Kroah-Hartman { 213d6bdbbdfSGreg Kroah-Hartman return dev->class == &block_class; 214d6bdbbdfSGreg Kroah-Hartman } 215d6bdbbdfSGreg Kroah-Hartman #else 216d6bdbbdfSGreg Kroah-Hartman static inline bool is_blockdev(struct device *dev) { return false; } 217d6bdbbdfSGreg Kroah-Hartman #endif 218d6bdbbdfSGreg Kroah-Hartman 2199ed98953SRafael J. Wysocki /* Device links support */ 2208da5b970SGreg Kroah-Hartman int device_links_read_lock(void); 2218da5b970SGreg Kroah-Hartman void device_links_read_unlock(int idx); 2228da5b970SGreg Kroah-Hartman int device_links_read_lock_held(void); 2238da5b970SGreg Kroah-Hartman int device_links_check_suppliers(struct device *dev); 2248da5b970SGreg Kroah-Hartman void device_links_force_bind(struct device *dev); 2258da5b970SGreg Kroah-Hartman void device_links_driver_bound(struct device *dev); 2268da5b970SGreg Kroah-Hartman void device_links_driver_cleanup(struct device *dev); 2278da5b970SGreg Kroah-Hartman void device_links_no_driver(struct device *dev); 2288da5b970SGreg Kroah-Hartman bool device_links_busy(struct device *dev); 2298da5b970SGreg Kroah-Hartman void device_links_unbind_consumers(struct device *dev); 2308da5b970SGreg Kroah-Hartman void fw_devlink_drivers_done(void); 2318da5b970SGreg Kroah-Hartman void fw_devlink_probing_done(void); 232494fd7b7SFeng Kan 233494fd7b7SFeng Kan /* device pm support */ 234494fd7b7SFeng Kan void device_pm_move_to_tail(struct device *dev); 235cf901a1cSGreg Kroah-Hartman 236cf901a1cSGreg Kroah-Hartman #ifdef CONFIG_DEVTMPFS 237cf901a1cSGreg Kroah-Hartman int devtmpfs_create_node(struct device *dev); 238d3583f06SGreg Kroah-Hartman int devtmpfs_delete_node(struct device *dev); 239cf901a1cSGreg Kroah-Hartman #else 240cf901a1cSGreg Kroah-Hartman static inline int devtmpfs_create_node(struct device *dev) { return 0; } 241d3583f06SGreg Kroah-Hartman static inline int devtmpfs_delete_node(struct device *dev) { return 0; } 242cf901a1cSGreg Kroah-Hartman #endif 243384f5a85SRafael J. Wysocki 244384f5a85SRafael J. Wysocki void software_node_notify(struct device *dev); 245384f5a85SRafael J. Wysocki void software_node_notify_remove(struct device *dev); 246