blob: 0d32544b6f91668c1d3493c875498b4f8e609cb5 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Paul Gortmakerba331622011-05-26 18:08:35 -04002#include <linux/notifier.h>
Ben Dooksa1bdc7a2005-10-13 17:54:41 +01003
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -07004/**
Kay Sievers6b6e39a2010-11-15 23:13:18 +01005 * struct subsys_private - structure to hold the private to the driver core portions of the bus_type/class structure.
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -07006 *
Kay Sievers6b6e39a2010-11-15 23:13:18 +01007 * @subsys - the struct kset that defines this subsystem
Kay Sieversca22e562011-12-14 14:29:38 -08008 * @devices_kset - the subsystem's 'devices' directory
9 * @interfaces - list of subsystem interfaces associated
10 * @mutex - protect the devices, and interfaces lists.
Kay Sievers6b6e39a2010-11-15 23:13:18 +010011 *
12 * @drivers_kset - the list of drivers associated
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -070013 * @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
Kay Sievers6b6e39a2010-11-15 23:13:18 +010016 * on this bus.
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -070017 * @bus - pointer back to the struct bus_type that this structure is associated
Kay Sievers6b6e39a2010-11-15 23:13:18 +010018 * with.
19 *
Kay Sievers6b6e39a2010-11-15 23:13:18 +010020 * @glue_dirs - "glue" directory to put in-between the parent device to
21 * avoid namespace conflicts
Kay Sievers6b6e39a2010-11-15 23:13:18 +010022 * @class - pointer back to the struct class that this structure is associated
23 * with.
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -070024 *
25 * This structure is the one that is the actual kobject allowing struct
Kay Sievers6b6e39a2010-11-15 23:13:18 +010026 * bus_type/class to be statically allocated safely. Nothing outside of the
27 * driver core should ever touch these fields.
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -070028 */
Kay Sievers6b6e39a2010-11-15 23:13:18 +010029struct subsys_private {
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -070030 struct kset subsys;
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -070031 struct kset *devices_kset;
Kay Sieversca22e562011-12-14 14:29:38 -080032 struct list_head interfaces;
33 struct mutex mutex;
Kay Sievers6b6e39a2010-11-15 23:13:18 +010034
35 struct kset *drivers_kset;
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -070036 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;
Kay Sievers6b6e39a2010-11-15 23:13:18 +010041
Kay Sievers6b6e39a2010-11-15 23:13:18 +010042 struct kset glue_dirs;
Kay Sievers6b6e39a2010-11-15 23:13:18 +010043 struct class *class;
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -070044};
Kay Sievers6b6e39a2010-11-15 23:13:18 +010045#define to_subsys_private(obj) container_of(obj, struct subsys_private, subsys.kobj)
Ben Dooksa1bdc7a2005-10-13 17:54:41 +010046
Greg Kroah-Hartmane5dd1272007-11-28 15:59:15 -080047struct 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)
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -070055
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -080056/**
57 * struct device_private - structure to hold the private to the driver core portions of the device structure.
58 *
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -080059 * @klist_children - klist containing all children of this device
60 * @knode_parent - node in sibling list
Greg Kroah-Hartman8940b4f2008-12-16 12:25:49 -080061 * @knode_driver - node in driver list
Greg Kroah-Hartmanae1b4172008-12-16 12:26:21 -080062 * @knode_bus - node in bus list
Wei Yang570d02002019-01-18 10:34:59 +080063 * @knode_class - node in class list
Greg Kroah-Hartmanef8a3fd2012-03-08 12:17:22 -080064 * @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.
Alexander Duyckef0ff682019-01-22 10:39:21 -080068 * @async_driver - pointer to device driver awaiting probe via async_probe
Tomeu Vizoso82b2c3c2015-06-29 16:59:02 +020069 * @device - pointer back to the struct device that this structure is
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -080070 * associated with.
Alexander Duyck3451a492019-01-22 10:39:10 -080071 * @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.
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -080074 *
75 * Nothing outside of the driver core should ever touch these fields.
76 */
77struct device_private {
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -080078 struct klist klist_children;
79 struct klist_node knode_parent;
Greg Kroah-Hartman8940b4f2008-12-16 12:25:49 -080080 struct klist_node knode_driver;
Greg Kroah-Hartmanae1b4172008-12-16 12:26:21 -080081 struct klist_node knode_bus;
Wei Yang570d02002019-01-18 10:34:59 +080082 struct klist_node knode_class;
Greg Kroah-Hartmanef8a3fd2012-03-08 12:17:22 -080083 struct list_head deferred_probe;
Alexander Duyckef0ff682019-01-22 10:39:21 -080084 struct device_driver *async_driver;
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -080085 struct device *device;
Alexander Duyck3451a492019-01-22 10:39:10 -080086 u8 dead:1;
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -080087};
Greg Kroah-Hartmanf791b8c2008-12-16 12:24:56 -080088#define to_device_private_parent(obj) \
89 container_of(obj, struct device_private, knode_parent)
Greg Kroah-Hartman8940b4f2008-12-16 12:25:49 -080090#define to_device_private_driver(obj) \
91 container_of(obj, struct device_private, knode_driver)
Greg Kroah-Hartmanae1b4172008-12-16 12:26:21 -080092#define to_device_private_bus(obj) \
93 container_of(obj, struct device_private, knode_bus)
Wei Yang570d02002019-01-18 10:34:59 +080094#define to_device_private_class(obj) \
95 container_of(obj, struct device_private, knode_class)
Greg Kroah-Hartmanfb069a52008-12-16 12:23:36 -080096
Greg Kroah-Hartmanc6f7e722007-11-01 19:41:16 -070097/* initialisation functions */
Ben Dooksa1bdc7a2005-10-13 17:54:41 +010098extern int devices_init(void);
99extern int buses_init(void);
100extern int classes_init(void);
101extern int firmware_init(void);
Michael Holzheu40394832006-05-09 12:53:49 +0200102#ifdef CONFIG_SYS_HYPERVISOR
103extern int hypervisor_init(void);
104#else
105static inline int hypervisor_init(void) { return 0; }
106#endif
Ben Dooksa1bdc7a2005-10-13 17:54:41 +0100107extern int platform_bus_init(void);
Ben Hutchings024f7842012-01-10 02:59:49 +0000108extern void cpu_dev_init(void);
Rafael J. Wysockicaa73ea2013-12-29 15:25:48 +0100109extern void container_dev_init(void);
Ben Dooksa1bdc7a2005-10-13 17:54:41 +0100110
Tejun Heod73ce002013-03-12 11:30:05 -0700111struct kobject *virtual_device_parent(struct device *dev);
112
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800113extern int bus_add_device(struct device *dev);
Alan Stern2023c612009-07-30 15:27:18 -0400114extern void bus_probe_device(struct device *dev);
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800115extern void bus_remove_device(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800117extern int bus_add_driver(struct device_driver *drv);
118extern void bus_remove_driver(struct device_driver *drv);
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +0100119extern void device_release_driver_internal(struct device *dev,
120 struct device_driver *drv,
121 struct device *parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
Greg Kroah-Hartman4a3ad202008-01-24 22:50:12 -0800123extern void driver_detach(struct device_driver *drv);
124extern int driver_probe_device(struct device_driver *drv, struct device *dev);
Grant Likelyd1c34142012-03-05 08:47:41 -0700125extern void driver_deferred_probe_del(struct device *dev);
Ming Lei49b420a2009-01-21 23:27:47 +0800126static inline int driver_match_device(struct device_driver *drv,
127 struct device *dev)
128{
Ming Lei5247aec2009-03-27 21:50:00 +0800129 return drv->bus->match ? drv->bus->match(dev, drv) : 1;
Ming Lei49b420a2009-01-21 23:27:47 +0800130}
Dmitry Torokhov765230b2015-03-30 16:20:04 -0700131extern bool driver_allows_async_probing(struct device_driver *drv);
mochel@digitalimplant.org07e4a3e2005-03-21 10:52:54 -0800132
Greg Kroah-Hartmaned0617b2013-08-08 15:22:56 -0700133extern 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);
Alexander Duycked887472019-01-22 10:39:16 -0800137int device_driver_attach(struct device_driver *drv, struct device *dev);
138void device_driver_detach(struct device *dev);
Greg Kroah-Hartmaned0617b2013-08-08 15:22:56 -0700139
Greg Kroah-Hartmanaa49b912006-06-20 13:59:20 -0700140extern char *make_class_name(const char *name, struct kobject *kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
Adrian Bunk2a013452007-06-18 01:42:54 +0200142extern int devres_release_all(struct device *dev);
Strashko, Grygorii013c0742015-11-10 11:42:34 +0200143extern void device_block_probing(void);
144extern void device_unblock_probing(void);
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700145
Kay Sieversca22e562011-12-14 14:29:38 -0800146/* /sys/devices directory */
Greg Kroah-Hartman881c6cfd2007-11-01 09:29:06 -0600147extern struct kset *devices_kset;
Grygorii Strashko52cdbdd2015-07-27 20:43:01 +0300148extern void devices_kset_move_last(struct device *dev);
Greg Kroah-Hartmanc63469a2007-11-28 12:23:18 -0800149
Randy Dunlap92b42142007-12-31 10:05:43 -0800150#if defined(CONFIG_MODULES) && defined(CONFIG_SYSFS)
Greg Kroah-Hartmanc63469a2007-11-28 12:23:18 -0800151extern 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
Kay Sievers2b2af542009-04-30 15:23:42 +0200158
159#ifdef CONFIG_DEVTMPFS
160extern int devtmpfs_init(void);
161#else
162static inline int devtmpfs_init(void) { return 0; }
163#endif
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +0100164
165/* Device links support */
166extern int device_links_read_lock(void);
167extern void device_links_read_unlock(int idx);
Joel Fernandes (Google)c2fa1e12019-07-16 18:12:25 -0400168extern int device_links_read_lock_held(void);
Rafael J. Wysocki9ed98952016-10-30 17:32:16 +0100169extern 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);
Feng Kan494fd7b2018-04-10 16:57:06 -0700175
176/* device pm support */
177void device_pm_move_to_tail(struct device *dev);