xref: /openbmc/linux/drivers/base/base.h (revision 1c2dd16a)
1 #include <linux/notifier.h>
2 
3 /**
4  * struct subsys_private - structure to hold the private to the driver core portions of the bus_type/class structure.
5  *
6  * @subsys - the struct kset that defines this subsystem
7  * @devices_kset - the subsystem's 'devices' directory
8  * @interfaces - list of subsystem interfaces associated
9  * @mutex - protect the devices, and interfaces lists.
10  *
11  * @drivers_kset - the list of drivers associated
12  * @klist_devices - the klist to iterate over the @devices_kset
13  * @klist_drivers - the klist to iterate over the @drivers_kset
14  * @bus_notifier - the bus notifier list for anything that cares about things
15  *                 on this bus.
16  * @bus - pointer back to the struct bus_type that this structure is associated
17  *        with.
18  *
19  * @glue_dirs - "glue" directory to put in-between the parent device to
20  *              avoid namespace conflicts
21  * @class - pointer back to the struct class that this structure is associated
22  *          with.
23  *
24  * This structure is the one that is the actual kobject allowing struct
25  * bus_type/class to be statically allocated safely.  Nothing outside of the
26  * driver core should ever touch these fields.
27  */
28 struct subsys_private {
29 	struct kset subsys;
30 	struct kset *devices_kset;
31 	struct list_head interfaces;
32 	struct mutex mutex;
33 
34 	struct kset *drivers_kset;
35 	struct klist klist_devices;
36 	struct klist klist_drivers;
37 	struct blocking_notifier_head bus_notifier;
38 	unsigned int drivers_autoprobe:1;
39 	struct bus_type *bus;
40 
41 	struct kset glue_dirs;
42 	struct class *class;
43 };
44 #define to_subsys_private(obj) container_of(obj, struct subsys_private, subsys.kobj)
45 
46 struct driver_private {
47 	struct kobject kobj;
48 	struct klist klist_devices;
49 	struct klist_node knode_bus;
50 	struct module_kobject *mkobj;
51 	struct device_driver *driver;
52 };
53 #define to_driver(obj) container_of(obj, struct driver_private, kobj)
54 
55 /**
56  * struct device_private - structure to hold the private to the driver core portions of the device structure.
57  *
58  * @klist_children - klist containing all children of this device
59  * @knode_parent - node in sibling list
60  * @knode_driver - node in driver list
61  * @knode_bus - node in bus list
62  * @deferred_probe - entry in deferred_probe_list which is used to retry the
63  *	binding of drivers which were unable to get all the resources needed by
64  *	the device; typically because it depends on another driver getting
65  *	probed first.
66  * @device - pointer back to the struct device that this structure is
67  * associated with.
68  *
69  * Nothing outside of the driver core should ever touch these fields.
70  */
71 struct device_private {
72 	struct klist klist_children;
73 	struct klist_node knode_parent;
74 	struct klist_node knode_driver;
75 	struct klist_node knode_bus;
76 	struct list_head deferred_probe;
77 	struct device *device;
78 };
79 #define to_device_private_parent(obj)	\
80 	container_of(obj, struct device_private, knode_parent)
81 #define to_device_private_driver(obj)	\
82 	container_of(obj, struct device_private, knode_driver)
83 #define to_device_private_bus(obj)	\
84 	container_of(obj, struct device_private, knode_bus)
85 
86 extern int device_private_init(struct device *dev);
87 
88 /* initialisation functions */
89 extern int devices_init(void);
90 extern int buses_init(void);
91 extern int classes_init(void);
92 extern int firmware_init(void);
93 #ifdef CONFIG_SYS_HYPERVISOR
94 extern int hypervisor_init(void);
95 #else
96 static inline int hypervisor_init(void) { return 0; }
97 #endif
98 extern int platform_bus_init(void);
99 extern void cpu_dev_init(void);
100 extern void container_dev_init(void);
101 
102 struct kobject *virtual_device_parent(struct device *dev);
103 
104 extern int bus_add_device(struct device *dev);
105 extern void bus_probe_device(struct device *dev);
106 extern void bus_remove_device(struct device *dev);
107 
108 extern int bus_add_driver(struct device_driver *drv);
109 extern void bus_remove_driver(struct device_driver *drv);
110 extern void device_release_driver_internal(struct device *dev,
111 					   struct device_driver *drv,
112 					   struct device *parent);
113 
114 extern void driver_detach(struct device_driver *drv);
115 extern int driver_probe_device(struct device_driver *drv, struct device *dev);
116 extern void driver_deferred_probe_del(struct device *dev);
117 static inline int driver_match_device(struct device_driver *drv,
118 				      struct device *dev)
119 {
120 	return drv->bus->match ? drv->bus->match(dev, drv) : 1;
121 }
122 extern bool driver_allows_async_probing(struct device_driver *drv);
123 
124 extern int driver_add_groups(struct device_driver *drv,
125 			     const struct attribute_group **groups);
126 extern void driver_remove_groups(struct device_driver *drv,
127 				 const struct attribute_group **groups);
128 
129 extern int device_add_groups(struct device *dev,
130 			     const struct attribute_group **groups);
131 extern void device_remove_groups(struct device *dev,
132 				 const struct attribute_group **groups);
133 
134 extern char *make_class_name(const char *name, struct kobject *kobj);
135 
136 extern int devres_release_all(struct device *dev);
137 extern void device_block_probing(void);
138 extern void device_unblock_probing(void);
139 
140 /* /sys/devices directory */
141 extern struct kset *devices_kset;
142 extern void devices_kset_move_last(struct device *dev);
143 
144 #if defined(CONFIG_MODULES) && defined(CONFIG_SYSFS)
145 extern void module_add_driver(struct module *mod, struct device_driver *drv);
146 extern void module_remove_driver(struct device_driver *drv);
147 #else
148 static inline void module_add_driver(struct module *mod,
149 				     struct device_driver *drv) { }
150 static inline void module_remove_driver(struct device_driver *drv) { }
151 #endif
152 
153 #ifdef CONFIG_DEVTMPFS
154 extern int devtmpfs_init(void);
155 #else
156 static inline int devtmpfs_init(void) { return 0; }
157 #endif
158 
159 /* Device links support */
160 extern int device_links_read_lock(void);
161 extern void device_links_read_unlock(int idx);
162 extern int device_links_check_suppliers(struct device *dev);
163 extern void device_links_driver_bound(struct device *dev);
164 extern void device_links_driver_cleanup(struct device *dev);
165 extern void device_links_no_driver(struct device *dev);
166 extern bool device_links_busy(struct device *dev);
167 extern void device_links_unbind_consumers(struct device *dev);
168