Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
5367601b GKH |
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 | */ | |
ba33162a | 13 | #include <linux/notifier.h> |
a1bdc7aa | 14 | |
c6f7e72a | 15 | /** |
6b6e39a6 | 16 | * struct subsys_private - structure to hold the private to the driver core portions of the bus_type/class structure. |
c6f7e72a | 17 | * |
6b6e39a6 | 18 | * @subsys - the struct kset that defines this subsystem |
ca22e56d KS |
19 | * @devices_kset - the subsystem's 'devices' directory |
20 | * @interfaces - list of subsystem interfaces associated | |
21 | * @mutex - protect the devices, and interfaces lists. | |
6b6e39a6 KS |
22 | * |
23 | * @drivers_kset - the list of drivers associated | |
c6f7e72a GKH |
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 | |
6b6e39a6 | 27 | * on this bus. |
c6f7e72a | 28 | * @bus - pointer back to the struct bus_type that this structure is associated |
6b6e39a6 KS |
29 | * with. |
30 | * | |
6b6e39a6 KS |
31 | * @glue_dirs - "glue" directory to put in-between the parent device to |
32 | * avoid namespace conflicts | |
6b6e39a6 KS |
33 | * @class - pointer back to the struct class that this structure is associated |
34 | * with. | |
c6f7e72a GKH |
35 | * |
36 | * This structure is the one that is the actual kobject allowing struct | |
6b6e39a6 KS |
37 | * bus_type/class to be statically allocated safely. Nothing outside of the |
38 | * driver core should ever touch these fields. | |
c6f7e72a | 39 | */ |
6b6e39a6 | 40 | struct subsys_private { |
c6f7e72a | 41 | struct kset subsys; |
c6f7e72a | 42 | struct kset *devices_kset; |
ca22e56d KS |
43 | struct list_head interfaces; |
44 | struct mutex mutex; | |
6b6e39a6 KS |
45 | |
46 | struct kset *drivers_kset; | |
c6f7e72a GKH |
47 | struct klist klist_devices; |
48 | struct klist klist_drivers; | |
49 | struct blocking_notifier_head bus_notifier; | |
50 | unsigned int drivers_autoprobe:1; | |
51 | struct bus_type *bus; | |
6b6e39a6 | 52 | |
6b6e39a6 | 53 | struct kset glue_dirs; |
6b6e39a6 | 54 | struct class *class; |
c6f7e72a | 55 | }; |
6b6e39a6 | 56 | #define to_subsys_private(obj) container_of(obj, struct subsys_private, subsys.kobj) |
c6f7e72a | 57 | |
e5dd1278 GKH |
58 | struct driver_private { |
59 | struct kobject kobj; | |
60 | struct klist klist_devices; | |
61 | struct klist_node knode_bus; | |
62 | struct module_kobject *mkobj; | |
63 | struct device_driver *driver; | |
64 | }; | |
65 | #define to_driver(obj) container_of(obj, struct driver_private, kobj) | |
a1bdc7aa | 66 | |
fb069a5d GKH |
67 | /** |
68 | * struct device_private - structure to hold the private to the driver core portions of the device structure. | |
69 | * | |
f791b8c8 GKH |
70 | * @klist_children - klist containing all children of this device |
71 | * @knode_parent - node in sibling list | |
8940b4f3 | 72 | * @knode_driver - node in driver list |
ae1b4171 | 73 | * @knode_bus - node in bus list |
570d0200 | 74 | * @knode_class - node in class list |
ef8a3fd6 GKH |
75 | * @deferred_probe - entry in deferred_probe_list which is used to retry the |
76 | * binding of drivers which were unable to get all the resources needed by | |
77 | * the device; typically because it depends on another driver getting | |
78 | * probed first. | |
ef0ff683 | 79 | * @async_driver - pointer to device driver awaiting probe via async_probe |
82b2c3c5 | 80 | * @device - pointer back to the struct device that this structure is |
fb069a5d | 81 | * associated with. |
3451a495 AD |
82 | * @dead - This device is currently either in the process of or has been |
83 | * removed from the system. Any asynchronous events scheduled for this | |
84 | * device should exit without taking any action. | |
fb069a5d GKH |
85 | * |
86 | * Nothing outside of the driver core should ever touch these fields. | |
87 | */ | |
88 | struct device_private { | |
f791b8c8 GKH |
89 | struct klist klist_children; |
90 | struct klist_node knode_parent; | |
8940b4f3 | 91 | struct klist_node knode_driver; |
ae1b4171 | 92 | struct klist_node knode_bus; |
570d0200 | 93 | struct klist_node knode_class; |
ef8a3fd6 | 94 | struct list_head deferred_probe; |
ef0ff683 | 95 | struct device_driver *async_driver; |
d090b70e | 96 | char *deferred_probe_reason; |
fb069a5d | 97 | struct device *device; |
3451a495 | 98 | u8 dead:1; |
fb069a5d | 99 | }; |
f791b8c8 GKH |
100 | #define to_device_private_parent(obj) \ |
101 | container_of(obj, struct device_private, knode_parent) | |
8940b4f3 GKH |
102 | #define to_device_private_driver(obj) \ |
103 | container_of(obj, struct device_private, knode_driver) | |
ae1b4171 GKH |
104 | #define to_device_private_bus(obj) \ |
105 | container_of(obj, struct device_private, knode_bus) | |
570d0200 WY |
106 | #define to_device_private_class(obj) \ |
107 | container_of(obj, struct device_private, knode_class) | |
fb069a5d | 108 | |
c6f7e72a | 109 | /* initialisation functions */ |
a1bdc7aa BD |
110 | extern int devices_init(void); |
111 | extern int buses_init(void); | |
112 | extern int classes_init(void); | |
113 | extern int firmware_init(void); | |
4039483f MH |
114 | #ifdef CONFIG_SYS_HYPERVISOR |
115 | extern int hypervisor_init(void); | |
116 | #else | |
117 | static inline int hypervisor_init(void) { return 0; } | |
118 | #endif | |
a1bdc7aa | 119 | extern int platform_bus_init(void); |
024f7846 | 120 | extern void cpu_dev_init(void); |
caa73ea1 | 121 | extern void container_dev_init(void); |
471b12c4 DJ |
122 | #ifdef CONFIG_AUXILIARY_BUS |
123 | extern void auxiliary_bus_init(void); | |
124 | #else | |
125 | static inline void auxiliary_bus_init(void) { } | |
126 | #endif | |
a1bdc7aa | 127 | |
d73ce004 TH |
128 | struct kobject *virtual_device_parent(struct device *dev); |
129 | ||
4a3ad20c | 130 | extern int bus_add_device(struct device *dev); |
2023c610 | 131 | extern void bus_probe_device(struct device *dev); |
4a3ad20c | 132 | extern void bus_remove_device(struct device *dev); |
1da177e4 | 133 | |
4a3ad20c GKH |
134 | extern int bus_add_driver(struct device_driver *drv); |
135 | extern void bus_remove_driver(struct device_driver *drv); | |
9ed98953 RW |
136 | extern void device_release_driver_internal(struct device *dev, |
137 | struct device_driver *drv, | |
138 | struct device *parent); | |
1da177e4 | 139 | |
4a3ad20c | 140 | extern void driver_detach(struct device_driver *drv); |
d1c3414c | 141 | extern void driver_deferred_probe_del(struct device *dev); |
d090b70e AH |
142 | extern void device_set_deferred_probe_reason(const struct device *dev, |
143 | struct va_format *vaf); | |
49b420a1 ML |
144 | static inline int driver_match_device(struct device_driver *drv, |
145 | struct device *dev) | |
146 | { | |
5247aecf | 147 | return drv->bus->match ? drv->bus->match(dev, drv) : 1; |
49b420a1 | 148 | } |
765230b5 | 149 | extern bool driver_allows_async_probing(struct device_driver *drv); |
07e4a3e2 | 150 | |
ed0617b5 GKH |
151 | extern int driver_add_groups(struct device_driver *drv, |
152 | const struct attribute_group **groups); | |
153 | extern void driver_remove_groups(struct device_driver *drv, | |
154 | const struct attribute_group **groups); | |
ed88747c AD |
155 | int device_driver_attach(struct device_driver *drv, struct device *dev); |
156 | void device_driver_detach(struct device *dev); | |
ed0617b5 | 157 | |
aa49b913 | 158 | extern char *make_class_name(const char *name, struct kobject *kobj); |
1da177e4 | 159 | |
2a013455 | 160 | extern int devres_release_all(struct device *dev); |
013c074f SG |
161 | extern void device_block_probing(void); |
162 | extern void device_unblock_probing(void); | |
823bccfc | 163 | |
ca22e56d | 164 | /* /sys/devices directory */ |
881c6cfd | 165 | extern struct kset *devices_kset; |
52cdbdd4 | 166 | extern void devices_kset_move_last(struct device *dev); |
c63469a3 | 167 | |
92b42141 | 168 | #if defined(CONFIG_MODULES) && defined(CONFIG_SYSFS) |
c63469a3 GKH |
169 | extern void module_add_driver(struct module *mod, struct device_driver *drv); |
170 | extern void module_remove_driver(struct device_driver *drv); | |
171 | #else | |
172 | static inline void module_add_driver(struct module *mod, | |
173 | struct device_driver *drv) { } | |
174 | static inline void module_remove_driver(struct device_driver *drv) { } | |
175 | #endif | |
2b2af54a KS |
176 | |
177 | #ifdef CONFIG_DEVTMPFS | |
178 | extern int devtmpfs_init(void); | |
179 | #else | |
180 | static inline int devtmpfs_init(void) { return 0; } | |
181 | #endif | |
9ed98953 RW |
182 | |
183 | /* Device links support */ | |
184 | extern int device_links_read_lock(void); | |
185 | extern void device_links_read_unlock(int idx); | |
c2fa1e1b | 186 | extern int device_links_read_lock_held(void); |
9ed98953 | 187 | extern int device_links_check_suppliers(struct device *dev); |
b6f617df | 188 | extern void device_links_force_bind(struct device *dev); |
9ed98953 RW |
189 | extern void device_links_driver_bound(struct device *dev); |
190 | extern void device_links_driver_cleanup(struct device *dev); | |
191 | extern void device_links_no_driver(struct device *dev); | |
192 | extern bool device_links_busy(struct device *dev); | |
193 | extern void device_links_unbind_consumers(struct device *dev); | |
d46f3e3e | 194 | extern void fw_devlink_drivers_done(void); |
494fd7b7 FK |
195 | |
196 | /* device pm support */ | |
197 | void device_pm_move_to_tail(struct device *dev); | |
cf901a1c GKH |
198 | |
199 | #ifdef CONFIG_DEVTMPFS | |
200 | int devtmpfs_create_node(struct device *dev); | |
201 | int devtmpfs_delete_node(struct device *dev); | |
202 | #else | |
203 | static inline int devtmpfs_create_node(struct device *dev) { return 0; } | |
204 | static inline int devtmpfs_delete_node(struct device *dev) { return 0; } | |
205 | #endif |