xref: /openbmc/linux/drivers/base/base.h (revision e9e8bcb8)
1 
2 /**
3  * struct subsys_private - structure to hold the private to the driver core portions of the bus_type/class structure.
4  *
5  * @subsys - the struct kset that defines this subsystem
6  * @devices_kset - the list of devices associated
7  *
8  * @drivers_kset - the list of drivers associated
9  * @klist_devices - the klist to iterate over the @devices_kset
10  * @klist_drivers - the klist to iterate over the @drivers_kset
11  * @bus_notifier - the bus notifier list for anything that cares about things
12  *                 on this bus.
13  * @bus - pointer back to the struct bus_type that this structure is associated
14  *        with.
15  *
16  * @class_interfaces - list of class_interfaces associated
17  * @glue_dirs - "glue" directory to put in-between the parent device to
18  *              avoid namespace conflicts
19  * @class_mutex - mutex to protect the children, devices, and interfaces lists.
20  * @class - pointer back to the struct class that this structure is associated
21  *          with.
22  *
23  * This structure is the one that is the actual kobject allowing struct
24  * bus_type/class to be statically allocated safely.  Nothing outside of the
25  * driver core should ever touch these fields.
26  */
27 struct subsys_private {
28 	struct kset subsys;
29 	struct kset *devices_kset;
30 
31 	struct kset *drivers_kset;
32 	struct klist klist_devices;
33 	struct klist klist_drivers;
34 	struct blocking_notifier_head bus_notifier;
35 	unsigned int drivers_autoprobe:1;
36 	struct bus_type *bus;
37 
38 	struct list_head class_interfaces;
39 	struct kset glue_dirs;
40 	struct mutex class_mutex;
41 	struct class *class;
42 };
43 #define to_subsys_private(obj) container_of(obj, struct subsys_private, subsys.kobj)
44 
45 struct driver_private {
46 	struct kobject kobj;
47 	struct klist klist_devices;
48 	struct klist_node knode_bus;
49 	struct module_kobject *mkobj;
50 	struct device_driver *driver;
51 };
52 #define to_driver(obj) container_of(obj, struct driver_private, kobj)
53 
54 /**
55  * struct device_private - structure to hold the private to the driver core portions of the device structure.
56  *
57  * @klist_children - klist containing all children of this device
58  * @knode_parent - node in sibling list
59  * @knode_driver - node in driver list
60  * @knode_bus - node in bus list
61  * @driver_data - private pointer for driver specific info.  Will turn into a
62  * list soon.
63  * @device - pointer back to the struct class that this structure is
64  * associated with.
65  *
66  * Nothing outside of the driver core should ever touch these fields.
67  */
68 struct device_private {
69 	struct klist klist_children;
70 	struct klist_node knode_parent;
71 	struct klist_node knode_driver;
72 	struct klist_node knode_bus;
73 	void *driver_data;
74 	struct device *device;
75 };
76 #define to_device_private_parent(obj)	\
77 	container_of(obj, struct device_private, knode_parent)
78 #define to_device_private_driver(obj)	\
79 	container_of(obj, struct device_private, knode_driver)
80 #define to_device_private_bus(obj)	\
81 	container_of(obj, struct device_private, knode_bus)
82 
83 extern int device_private_init(struct device *dev);
84 
85 /* initialisation functions */
86 extern int devices_init(void);
87 extern int buses_init(void);
88 extern int classes_init(void);
89 extern int firmware_init(void);
90 #ifdef CONFIG_SYS_HYPERVISOR
91 extern int hypervisor_init(void);
92 #else
93 static inline int hypervisor_init(void) { return 0; }
94 #endif
95 extern int platform_bus_init(void);
96 extern int system_bus_init(void);
97 extern int cpu_dev_init(void);
98 
99 extern int bus_add_device(struct device *dev);
100 extern void bus_probe_device(struct device *dev);
101 extern void bus_remove_device(struct device *dev);
102 
103 extern int bus_add_driver(struct device_driver *drv);
104 extern void bus_remove_driver(struct device_driver *drv);
105 
106 extern void driver_detach(struct device_driver *drv);
107 extern int driver_probe_device(struct device_driver *drv, struct device *dev);
108 static inline int driver_match_device(struct device_driver *drv,
109 				      struct device *dev)
110 {
111 	return drv->bus->match ? drv->bus->match(dev, drv) : 1;
112 }
113 
114 extern char *make_class_name(const char *name, struct kobject *kobj);
115 
116 extern int devres_release_all(struct device *dev);
117 
118 extern struct kset *devices_kset;
119 
120 #if defined(CONFIG_MODULES) && defined(CONFIG_SYSFS)
121 extern void module_add_driver(struct module *mod, struct device_driver *drv);
122 extern void module_remove_driver(struct device_driver *drv);
123 #else
124 static inline void module_add_driver(struct module *mod,
125 				     struct device_driver *drv) { }
126 static inline void module_remove_driver(struct device_driver *drv) { }
127 #endif
128 
129 #ifdef CONFIG_DEVTMPFS
130 extern int devtmpfs_init(void);
131 #else
132 static inline int devtmpfs_init(void) { return 0; }
133 #endif
134