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}
 
149
150extern int driver_add_groups(struct device_driver *drv,
151			     const struct attribute_group **groups);
152extern void driver_remove_groups(struct device_driver *drv,
153				 const struct attribute_group **groups);
 
154void device_driver_detach(struct device *dev);
155
 
 
156extern int devres_release_all(struct device *dev);
157extern void device_block_probing(void);
158extern void device_unblock_probing(void);
159extern void deferred_probe_extend_timeout(void);
160extern void driver_deferred_probe_trigger(void);
161
162/* /sys/devices directory */
163extern struct kset *devices_kset;
164extern void devices_kset_move_last(struct device *dev);
165
166#if defined(CONFIG_MODULES) && defined(CONFIG_SYSFS)
167extern void module_add_driver(struct module *mod, struct device_driver *drv);
168extern void module_remove_driver(struct device_driver *drv);
169#else
170static inline void module_add_driver(struct module *mod,
171				     struct device_driver *drv) { }
172static inline void module_remove_driver(struct device_driver *drv) { }
173#endif
174
175#ifdef CONFIG_DEVTMPFS
176extern int devtmpfs_init(void);
177#else
178static inline int devtmpfs_init(void) { return 0; }
179#endif
180
181/* Device links support */
182extern int device_links_read_lock(void);
183extern void device_links_read_unlock(int idx);
184extern int device_links_read_lock_held(void);
185extern int device_links_check_suppliers(struct device *dev);
186extern void device_links_force_bind(struct device *dev);
187extern void device_links_driver_bound(struct device *dev);
188extern void device_links_driver_cleanup(struct device *dev);
189extern void device_links_no_driver(struct device *dev);
190extern bool device_links_busy(struct device *dev);
191extern void device_links_unbind_consumers(struct device *dev);
192extern void fw_devlink_drivers_done(void);
193
194/* device pm support */
195void device_pm_move_to_tail(struct device *dev);
196
197#ifdef CONFIG_DEVTMPFS
198int devtmpfs_create_node(struct device *dev);
199int devtmpfs_delete_node(struct device *dev);
200#else
201static inline int devtmpfs_create_node(struct device *dev) { return 0; }
202static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
203#endif
204
205void software_node_notify(struct device *dev);
206void software_node_notify_remove(struct device *dev);

  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 * @knode_class - node in class list
 64 * @deferred_probe - entry in deferred_probe_list which is used to retry the
 65 *	binding of drivers which were unable to get all the resources needed by
 66 *	the device; typically because it depends on another driver getting
 67 *	probed first.
 68 * @async_driver - pointer to device driver awaiting probe via async_probe
 69 * @device - pointer back to the struct device that this structure is
 70 * associated with.
 71 * @dead - This device is currently either in the process of or has been
 72 *	removed from the system. Any asynchronous events scheduled for this
 73 *	device should exit without taking any action.
 74 *
 75 * Nothing outside of the driver core should ever touch these fields.
 76 */
 77struct device_private {
 78	struct klist klist_children;
 79	struct klist_node knode_parent;
 80	struct klist_node knode_driver;
 81	struct klist_node knode_bus;
 82	struct klist_node knode_class;
 83	struct list_head deferred_probe;
 84	struct device_driver *async_driver;
 
 85	struct device *device;
 86	u8 dead:1;
 87};
 88#define to_device_private_parent(obj)	\
 89	container_of(obj, struct device_private, knode_parent)
 90#define to_device_private_driver(obj)	\
 91	container_of(obj, struct device_private, knode_driver)
 92#define to_device_private_bus(obj)	\
 93	container_of(obj, struct device_private, knode_bus)
 94#define to_device_private_class(obj)	\
 95	container_of(obj, struct device_private, knode_class)
 96
 97/* initialisation functions */
 98extern int devices_init(void);
 99extern int buses_init(void);
100extern int classes_init(void);
101extern int firmware_init(void);
102#ifdef CONFIG_SYS_HYPERVISOR
103extern int hypervisor_init(void);
104#else
105static inline int hypervisor_init(void) { return 0; }
106#endif
107extern int platform_bus_init(void);
108extern void cpu_dev_init(void);
109extern void container_dev_init(void);
 
 
 
 
 
110
111struct kobject *virtual_device_parent(struct device *dev);
112
113extern int bus_add_device(struct device *dev);
114extern void bus_probe_device(struct device *dev);
115extern void bus_remove_device(struct device *dev);
116
117extern int bus_add_driver(struct device_driver *drv);
118extern void bus_remove_driver(struct device_driver *drv);
119extern void device_release_driver_internal(struct device *dev,
120					   struct device_driver *drv,
121					   struct device *parent);
122
123extern void driver_detach(struct device_driver *drv);
124extern int driver_probe_device(struct device_driver *drv, struct device *dev);
125extern void driver_deferred_probe_del(struct device *dev);
 
 
126static inline int driver_match_device(struct device_driver *drv,
127				      struct device *dev)
128{
129	return drv->bus->match ? drv->bus->match(dev, drv) : 1;
130}
131extern bool driver_allows_async_probing(struct device_driver *drv);
132
133extern int driver_add_groups(struct device_driver *drv,
134			     const struct attribute_group **groups);
135extern void driver_remove_groups(struct device_driver *drv,
136				 const struct attribute_group **groups);
137int device_driver_attach(struct device_driver *drv, struct device *dev);
138void device_driver_detach(struct device *dev);
139
140extern char *make_class_name(const char *name, struct kobject *kobj);
141
142extern int devres_release_all(struct device *dev);
143extern void device_block_probing(void);
144extern void device_unblock_probing(void);
 
 
145
146/* /sys/devices directory */
147extern struct kset *devices_kset;
148extern void devices_kset_move_last(struct device *dev);
149
150#if defined(CONFIG_MODULES) && defined(CONFIG_SYSFS)
151extern void module_add_driver(struct module *mod, struct device_driver *drv);
152extern void module_remove_driver(struct device_driver *drv);
153#else
154static inline void module_add_driver(struct module *mod,
155				     struct device_driver *drv) { }
156static inline void module_remove_driver(struct device_driver *drv) { }
157#endif
158
159#ifdef CONFIG_DEVTMPFS
160extern int devtmpfs_init(void);
161#else
162static inline int devtmpfs_init(void) { return 0; }
163#endif
164
165/* Device links support */
166extern int device_links_read_lock(void);
167extern void device_links_read_unlock(int idx);
168extern int device_links_read_lock_held(void);
169extern int device_links_check_suppliers(struct device *dev);
 
170extern void device_links_driver_bound(struct device *dev);
171extern void device_links_driver_cleanup(struct device *dev);
172extern void device_links_no_driver(struct device *dev);
173extern bool device_links_busy(struct device *dev);
174extern void device_links_unbind_consumers(struct device *dev);
 
175
176/* device pm support */
177void device_pm_move_to_tail(struct device *dev);