xref: /openbmc/linux/drivers/base/base.h (revision ba33162a)
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 list of devices associated
8  *
9  * @drivers_kset - the list of drivers associated
10  * @klist_devices - the klist to iterate over the @devices_kset
11  * @klist_drivers - the klist to iterate over the @drivers_kset
12  * @bus_notifier - the bus notifier list for anything that cares about things
13  *                 on this bus.
14  * @bus - pointer back to the struct bus_type that this structure is associated
15  *        with.
16  *
17  * @class_interfaces - list of class_interfaces associated
18  * @glue_dirs - "glue" directory to put in-between the parent device to
19  *              avoid namespace conflicts
20  * @class_mutex - mutex to protect the children, devices, and interfaces lists.
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 
32 	struct kset *drivers_kset;
33 	struct klist klist_devices;
34 	struct klist klist_drivers;
35 	struct blocking_notifier_head bus_notifier;
36 	unsigned int drivers_autoprobe:1;
37 	struct bus_type *bus;
38 
39 	struct list_head class_interfaces;
40 	struct kset glue_dirs;
41 	struct mutex class_mutex;
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  * @driver_data - private pointer for driver specific info.  Will turn into a
63  * list soon.
64  * @device - pointer back to the struct class that this structure is
65  * associated with.
66  *
67  * Nothing outside of the driver core should ever touch these fields.
68  */
69 struct device_private {
70 	struct klist klist_children;
71 	struct klist_node knode_parent;
72 	struct klist_node knode_driver;
73 	struct klist_node knode_bus;
74 	void *driver_data;
75 	struct device *device;
76 };
77 #define to_device_private_parent(obj)	\
78 	container_of(obj, struct device_private, knode_parent)
79 #define to_device_private_driver(obj)	\
80 	container_of(obj, struct device_private, knode_driver)
81 #define to_device_private_bus(obj)	\
82 	container_of(obj, struct device_private, knode_bus)
83 
84 extern int device_private_init(struct device *dev);
85 
86 /* initialisation functions */
87 extern int devices_init(void);
88 extern int buses_init(void);
89 extern int classes_init(void);
90 extern int firmware_init(void);
91 #ifdef CONFIG_SYS_HYPERVISOR
92 extern int hypervisor_init(void);
93 #else
94 static inline int hypervisor_init(void) { return 0; }
95 #endif
96 extern int platform_bus_init(void);
97 extern int system_bus_init(void);
98 extern int cpu_dev_init(void);
99 
100 extern int bus_add_device(struct device *dev);
101 extern void bus_probe_device(struct device *dev);
102 extern void bus_remove_device(struct device *dev);
103 
104 extern int bus_add_driver(struct device_driver *drv);
105 extern void bus_remove_driver(struct device_driver *drv);
106 
107 extern void driver_detach(struct device_driver *drv);
108 extern int driver_probe_device(struct device_driver *drv, struct device *dev);
109 static inline int driver_match_device(struct device_driver *drv,
110 				      struct device *dev)
111 {
112 	return drv->bus->match ? drv->bus->match(dev, drv) : 1;
113 }
114 
115 extern char *make_class_name(const char *name, struct kobject *kobj);
116 
117 extern int devres_release_all(struct device *dev);
118 
119 extern struct kset *devices_kset;
120 
121 #if defined(CONFIG_MODULES) && defined(CONFIG_SYSFS)
122 extern void module_add_driver(struct module *mod, struct device_driver *drv);
123 extern void module_remove_driver(struct device_driver *drv);
124 #else
125 static inline void module_add_driver(struct module *mod,
126 				     struct device_driver *drv) { }
127 static inline void module_remove_driver(struct device_driver *drv) { }
128 #endif
129 
130 #ifdef CONFIG_DEVTMPFS
131 extern int devtmpfs_init(void);
132 #else
133 static inline int devtmpfs_init(void) { return 0; }
134 #endif
135