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