1/* SPDX-License-Identifier: GPL-2.0 */
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 */
13#include <linux/notifier.h>
14
15/**
16 * struct subsys_private - structure to hold the private to the driver core portions of the bus_type/class structure.
17 *
18 * @subsys - the struct kset that defines this subsystem
19 * @devices_kset - the subsystem's 'devices' directory
20 * @interfaces - list of subsystem interfaces associated
21 * @mutex - protect the devices, and interfaces lists.
22 *
23 * @drivers_kset - the list of drivers associated
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
27 * on this bus.
28 * @bus - pointer back to the struct bus_type that this structure is associated
29 * with.
30 *
31 * @glue_dirs - "glue" directory to put in-between the parent device to
32 * avoid namespace conflicts
33 * @class - pointer back to the struct class that this structure is associated
34 * with.
35 *
36 * This structure is the one that is the actual kobject allowing struct
37 * bus_type/class to be statically allocated safely. Nothing outside of the
38 * driver core should ever touch these fields.
39 */
40struct subsys_private {
41 struct kset subsys;
42 struct kset *devices_kset;
43 struct list_head interfaces;
44 struct mutex mutex;
45
46 struct kset *drivers_kset;
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;
52
53 struct kset glue_dirs;
54 struct class *class;
55};
56#define to_subsys_private(obj) container_of(obj, struct subsys_private, subsys.kobj)
57
58struct 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)
66
67/**
68 * struct device_private - structure to hold the private to the driver core portions of the device structure.
69 *
70 * @klist_children - klist containing all children of this device
71 * @knode_parent - node in sibling list
72 * @knode_driver - node in driver list
73 * @knode_bus - node in bus list
74 * @knode_class - node in class list
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.
79 * @async_driver - pointer to device driver awaiting probe via async_probe
80 * @device - pointer back to the struct device that this structure is
81 * associated with.
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.
85 *
86 * Nothing outside of the driver core should ever touch these fields.
87 */
88struct device_private {
89 struct klist klist_children;
90 struct klist_node knode_parent;
91 struct klist_node knode_driver;
92 struct klist_node knode_bus;
93 struct klist_node knode_class;
94 struct list_head deferred_probe;
95 struct device_driver *async_driver;
96 char *deferred_probe_reason;
97 struct device *device;
98 u8 dead:1;
99};
100#define to_device_private_parent(obj) \
101 container_of(obj, struct device_private, knode_parent)
102#define to_device_private_driver(obj) \
103 container_of(obj, struct device_private, knode_driver)
104#define to_device_private_bus(obj) \
105 container_of(obj, struct device_private, knode_bus)
106#define to_device_private_class(obj) \
107 container_of(obj, struct device_private, knode_class)
108
109/* initialisation functions */
110extern int devices_init(void);
111extern int buses_init(void);
112extern int classes_init(void);
113extern int firmware_init(void);
114#ifdef CONFIG_SYS_HYPERVISOR
115extern int hypervisor_init(void);
116#else
117static inline int hypervisor_init(void) { return 0; }
118#endif
119extern int platform_bus_init(void);
120extern void cpu_dev_init(void);
121extern void container_dev_init(void);
122#ifdef CONFIG_AUXILIARY_BUS
123extern void auxiliary_bus_init(void);
124#else
125static inline void auxiliary_bus_init(void) { }
126#endif
127
128struct kobject *virtual_device_parent(struct device *dev);
129
130extern int bus_add_device(struct device *dev);
131extern void bus_probe_device(struct device *dev);
132extern void bus_remove_device(struct device *dev);
133
134extern int bus_add_driver(struct device_driver *drv);
135extern void bus_remove_driver(struct device_driver *drv);
136extern void device_release_driver_internal(struct device *dev,
137 struct device_driver *drv,
138 struct device *parent);
139
140extern void driver_detach(struct device_driver *drv);
141extern void driver_deferred_probe_del(struct device *dev);
142extern void device_set_deferred_probe_reason(const struct device *dev,
143 struct va_format *vaf);
144static inline int driver_match_device(struct device_driver *drv,
145 struct device *dev)
146{
147 return drv->bus->match ? drv->bus->match(dev, drv) : 1;
148}
149extern bool driver_allows_async_probing(struct device_driver *drv);
150
151extern int driver_add_groups(struct device_driver *drv,
152 const struct attribute_group **groups);
153extern void driver_remove_groups(struct device_driver *drv,
154 const struct attribute_group **groups);
155void device_driver_detach(struct device *dev);
156
157extern char *make_class_name(const char *name, struct kobject *kobj);
158
159extern int devres_release_all(struct device *dev);
160extern void device_block_probing(void);
161extern void device_unblock_probing(void);
162extern void deferred_probe_extend_timeout(void);
163extern void driver_deferred_probe_trigger(void);
164
165/* /sys/devices directory */
166extern struct kset *devices_kset;
167extern void devices_kset_move_last(struct device *dev);
168
169#if defined(CONFIG_MODULES) && defined(CONFIG_SYSFS)
170extern void module_add_driver(struct module *mod, struct device_driver *drv);
171extern void module_remove_driver(struct device_driver *drv);
172#else
173static inline void module_add_driver(struct module *mod,
174 struct device_driver *drv) { }
175static inline void module_remove_driver(struct device_driver *drv) { }
176#endif
177
178#ifdef CONFIG_DEVTMPFS
179extern int devtmpfs_init(void);
180#else
181static inline int devtmpfs_init(void) { return 0; }
182#endif
183
184/* Device links support */
185extern int device_links_read_lock(void);
186extern void device_links_read_unlock(int idx);
187extern int device_links_read_lock_held(void);
188extern int device_links_check_suppliers(struct device *dev);
189extern void device_links_force_bind(struct device *dev);
190extern void device_links_driver_bound(struct device *dev);
191extern void device_links_driver_cleanup(struct device *dev);
192extern void device_links_no_driver(struct device *dev);
193extern bool device_links_busy(struct device *dev);
194extern void device_links_unbind_consumers(struct device *dev);
195extern void fw_devlink_drivers_done(void);
196
197/* device pm support */
198void device_pm_move_to_tail(struct device *dev);
199
200#ifdef CONFIG_DEVTMPFS
201int devtmpfs_create_node(struct device *dev);
202int devtmpfs_delete_node(struct device *dev);
203#else
204static inline int devtmpfs_create_node(struct device *dev) { return 0; }
205static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
206#endif
207
208void software_node_notify(struct device *dev);
209void software_node_notify_remove(struct device *dev);
210

source code of linux/drivers/base/base.h