1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org> 4 * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de> 5 * Copyright (c) 2008-2012 Novell Inc. 6 * Copyright (c) 2012-2019 Greg Kroah-Hartman <gregkh@linuxfoundation.org> 7 * Copyright (c) 2012-2019 Linux Foundation 8 * 9 * Core driver model functions and structures that should not be 10 * shared outside of the drivers/base/ directory. 11 * 12 */ 13 #include <linux/notifier.h> 14 15 /** 16 * struct subsys_private - structure to hold the private to the driver core portions of the bus_type/class structure. 17 * 18 * @subsys - the struct kset that defines this subsystem 19 * @devices_kset - the subsystem's 'devices' directory 20 * @interfaces - list of subsystem interfaces associated 21 * @mutex - protect the devices, and interfaces lists. 22 * 23 * @drivers_kset - the list of drivers associated 24 * @klist_devices - the klist to iterate over the @devices_kset 25 * @klist_drivers - the klist to iterate over the @drivers_kset 26 * @bus_notifier - the bus notifier list for anything that cares about things 27 * on this bus. 28 * @bus - pointer back to the struct bus_type that this structure is associated 29 * with. 30 * @dev_root: Default device to use as the parent. 31 * 32 * @glue_dirs - "glue" directory to put in-between the parent device to 33 * avoid namespace conflicts 34 * @class - pointer back to the struct class that this structure is associated 35 * with. 36 * @lock_key: Lock class key for use by the lock validator 37 * 38 * This structure is the one that is the actual kobject allowing struct 39 * bus_type/class to be statically allocated safely. Nothing outside of the 40 * driver core should ever touch these fields. 41 */ 42 struct subsys_private { 43 struct kset subsys; 44 struct kset *devices_kset; 45 struct list_head interfaces; 46 struct mutex mutex; 47 48 struct kset *drivers_kset; 49 struct klist klist_devices; 50 struct klist klist_drivers; 51 struct blocking_notifier_head bus_notifier; 52 unsigned int drivers_autoprobe:1; 53 const struct bus_type *bus; 54 struct device *dev_root; 55 56 struct kset glue_dirs; 57 struct class *class; 58 59 struct lock_class_key lock_key; 60 }; 61 #define to_subsys_private(obj) container_of_const(obj, struct subsys_private, subsys.kobj) 62 63 static inline struct subsys_private *subsys_get(struct subsys_private *sp) 64 { 65 if (sp) 66 kset_get(&sp->subsys); 67 return sp; 68 } 69 70 static inline void subsys_put(struct subsys_private *sp) 71 { 72 if (sp) 73 kset_put(&sp->subsys); 74 } 75 76 struct driver_private { 77 struct kobject kobj; 78 struct klist klist_devices; 79 struct klist_node knode_bus; 80 struct module_kobject *mkobj; 81 struct device_driver *driver; 82 }; 83 #define to_driver(obj) container_of(obj, struct driver_private, kobj) 84 85 /** 86 * struct device_private - structure to hold the private to the driver core portions of the device structure. 87 * 88 * @klist_children - klist containing all children of this device 89 * @knode_parent - node in sibling list 90 * @knode_driver - node in driver list 91 * @knode_bus - node in bus list 92 * @knode_class - node in class list 93 * @deferred_probe - entry in deferred_probe_list which is used to retry the 94 * binding of drivers which were unable to get all the resources needed by 95 * the device; typically because it depends on another driver getting 96 * probed first. 97 * @async_driver - pointer to device driver awaiting probe via async_probe 98 * @device - pointer back to the struct device that this structure is 99 * associated with. 100 * @dead - This device is currently either in the process of or has been 101 * removed from the system. Any asynchronous events scheduled for this 102 * device should exit without taking any action. 103 * 104 * Nothing outside of the driver core should ever touch these fields. 105 */ 106 struct device_private { 107 struct klist klist_children; 108 struct klist_node knode_parent; 109 struct klist_node knode_driver; 110 struct klist_node knode_bus; 111 struct klist_node knode_class; 112 struct list_head deferred_probe; 113 struct device_driver *async_driver; 114 char *deferred_probe_reason; 115 struct device *device; 116 u8 dead:1; 117 }; 118 #define to_device_private_parent(obj) \ 119 container_of(obj, struct device_private, knode_parent) 120 #define to_device_private_driver(obj) \ 121 container_of(obj, struct device_private, knode_driver) 122 #define to_device_private_bus(obj) \ 123 container_of(obj, struct device_private, knode_bus) 124 #define to_device_private_class(obj) \ 125 container_of(obj, struct device_private, knode_class) 126 127 /* initialisation functions */ 128 int devices_init(void); 129 int buses_init(void); 130 int classes_init(void); 131 int firmware_init(void); 132 #ifdef CONFIG_SYS_HYPERVISOR 133 int hypervisor_init(void); 134 #else 135 static inline int hypervisor_init(void) { return 0; } 136 #endif 137 int platform_bus_init(void); 138 void cpu_dev_init(void); 139 void container_dev_init(void); 140 #ifdef CONFIG_AUXILIARY_BUS 141 void auxiliary_bus_init(void); 142 #else 143 static inline void auxiliary_bus_init(void) { } 144 #endif 145 146 struct kobject *virtual_device_parent(struct device *dev); 147 148 int bus_add_device(struct device *dev); 149 void bus_probe_device(struct device *dev); 150 void bus_remove_device(struct device *dev); 151 void bus_notify(struct device *dev, enum bus_notifier_event value); 152 bool bus_is_registered(const struct bus_type *bus); 153 154 int bus_add_driver(struct device_driver *drv); 155 void bus_remove_driver(struct device_driver *drv); 156 void device_release_driver_internal(struct device *dev, struct device_driver *drv, 157 struct device *parent); 158 159 void driver_detach(struct device_driver *drv); 160 void driver_deferred_probe_del(struct device *dev); 161 void device_set_deferred_probe_reason(const struct device *dev, struct va_format *vaf); 162 static inline int driver_match_device(struct device_driver *drv, 163 struct device *dev) 164 { 165 return drv->bus->match ? drv->bus->match(dev, drv) : 1; 166 } 167 168 static inline void dev_sync_state(struct device *dev) 169 { 170 if (dev->bus->sync_state) 171 dev->bus->sync_state(dev); 172 else if (dev->driver && dev->driver->sync_state) 173 dev->driver->sync_state(dev); 174 } 175 176 int driver_add_groups(struct device_driver *drv, const struct attribute_group **groups); 177 void driver_remove_groups(struct device_driver *drv, const struct attribute_group **groups); 178 void device_driver_detach(struct device *dev); 179 180 int devres_release_all(struct device *dev); 181 void device_block_probing(void); 182 void device_unblock_probing(void); 183 void deferred_probe_extend_timeout(void); 184 void driver_deferred_probe_trigger(void); 185 const char *device_get_devnode(const struct device *dev, umode_t *mode, 186 kuid_t *uid, kgid_t *gid, const char **tmp); 187 188 /* /sys/devices directory */ 189 extern struct kset *devices_kset; 190 void devices_kset_move_last(struct device *dev); 191 192 /* /sys/dev/char directory */ 193 extern struct kobject *sysfs_dev_char_kobj; 194 195 #if defined(CONFIG_MODULES) && defined(CONFIG_SYSFS) 196 void module_add_driver(struct module *mod, struct device_driver *drv); 197 void module_remove_driver(struct device_driver *drv); 198 #else 199 static inline void module_add_driver(struct module *mod, 200 struct device_driver *drv) { } 201 static inline void module_remove_driver(struct device_driver *drv) { } 202 #endif 203 204 #ifdef CONFIG_DEVTMPFS 205 int devtmpfs_init(void); 206 #else 207 static inline int devtmpfs_init(void) { return 0; } 208 #endif 209 210 /* Device links support */ 211 int device_links_read_lock(void); 212 void device_links_read_unlock(int idx); 213 int device_links_read_lock_held(void); 214 int device_links_check_suppliers(struct device *dev); 215 void device_links_force_bind(struct device *dev); 216 void device_links_driver_bound(struct device *dev); 217 void device_links_driver_cleanup(struct device *dev); 218 void device_links_no_driver(struct device *dev); 219 bool device_links_busy(struct device *dev); 220 void device_links_unbind_consumers(struct device *dev); 221 void fw_devlink_drivers_done(void); 222 void fw_devlink_probing_done(void); 223 224 /* device pm support */ 225 void device_pm_move_to_tail(struct device *dev); 226 227 #ifdef CONFIG_DEVTMPFS 228 int devtmpfs_create_node(struct device *dev); 229 int devtmpfs_delete_node(struct device *dev); 230 #else 231 static inline int devtmpfs_create_node(struct device *dev) { return 0; } 232 static inline int devtmpfs_delete_node(struct device *dev) { return 0; } 233 #endif 234 235 void software_node_notify(struct device *dev); 236 void software_node_notify_remove(struct device *dev); 237