drivers/base/base.h

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