include/linux/device/bus.h

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * bus.h - the bus-specific portions of the driver model
   4  *
   5  * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
   6  * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de>
   7  * Copyright (c) 2008-2009 Novell Inc.
   8  * Copyright (c) 2012-2019 Greg Kroah-Hartman <gregkh@linuxfoundation.org>
   9  * Copyright (c) 2012-2019 Linux Foundation
  10  *
  11  * See Documentation/driver-api/driver-model/ for more information.
  12  */
  13
  14 #ifndef _DEVICE_BUS_H_
  15 #define _DEVICE_BUS_H_
  16
  17 #include <linux/kobject.h>
  18 #include <linux/klist.h>
  19 #include <linux/pm.h>
  20
  21 struct device_driver;
  22 struct fwnode_handle;
  23
  24 /**
  25  * struct bus_type - The bus type of the device
  26  *
  27  * @name:       The name of the bus.
  28  * @dev_name:   Used for subsystems to enumerate devices like ("foo%u", dev->id).
  29  * @bus_groups: Default attributes of the bus.
  30  * @dev_groups: Default attributes of the devices on the bus.
  31  * @drv_groups: Default attributes of the device drivers on the bus.
  32  * @match:      Called, perhaps multiple times, whenever a new device or driver
  33  *              is added for this bus. It should return a positive value if the
  34  *              given device can be handled by the given driver and zero
  35  *              otherwise. It may also return error code if determining that
  36  *              the driver supports the device is not possible. In case of
  37  *              -EPROBE_DEFER it will queue the device for deferred probing.
  38  * @uevent:     Called when a device is added, removed, or a few other things
  39  *              that generate uevents to add the environment variables.
  40  * @probe:      Called when a new device or driver add to this bus, and callback
  41  *              the specific driver's probe to initial the matched device.
  42  * @sync_state: Called to sync device state to software state after all the
  43  *              state tracking consumers linked to this device (present at
  44  *              the time of late_initcall) have successfully bound to a
  45  *              driver. If the device has no consumers, this function will
  46  *              be called at late_initcall_sync level. If the device has
  47  *              consumers that are never bound to a driver, this function
  48  *              will never get called until they do.
  49  * @remove:     Called when a device removed from this bus.
  50  * @shutdown:   Called at shut-down time to quiesce the device.
  51  *
  52  * @online:     Called to put the device back online (after offlining it).
  53  * @offline:    Called to put the device offline for hot-removal. May fail.
  54  *
  55  * @suspend:    Called when a device on this bus wants to go to sleep mode.
  56  * @resume:     Called to bring a device on this bus out of sleep mode.
  57  * @num_vf:     Called to find out how many virtual functions a device on this
  58  *              bus supports.
  59  * @dma_configure:      Called to setup DMA configuration on a device on
  60  *                      this bus.
  61  * @dma_cleanup:        Called to cleanup DMA configuration on a device on
  62  *                      this bus.
  63  * @pm:         Power management operations of this bus, callback the specific
  64  *              device driver's pm-ops.
  65  * @iommu_ops:  IOMMU specific operations for this bus, used to attach IOMMU
  66  *              driver implementations to a bus and allow the driver to do
  67  *              bus-specific setup
  68  * @lock_key:   Lock class key for use by the lock validator
  69  * @need_parent_lock:   When probing or removing a device on this bus, the
  70  *                      device core should lock the device's parent.
  71  *
  72  * A bus is a channel between the processor and one or more devices. For the
  73  * purposes of the device model, all devices are connected via a bus, even if
  74  * it is an internal, virtual, "platform" bus. Buses can plug into each other.
  75  * A USB controller is usually a PCI device, for example. The device model
  76  * represents the actual connections between buses and the devices they control.
  77  * A bus is represented by the bus_type structure. It contains the name, the
  78  * default attributes, the bus' methods, PM operations, and the driver core's
  79  * private data.
  80  */
  81 struct bus_type {
  82         const char              *name;
  83         const char              *dev_name;
  84         const struct attribute_group **bus_groups;
  85         const struct attribute_group **dev_groups;
  86         const struct attribute_group **drv_groups;
  87
  88         int (*match)(struct device *dev, struct device_driver *drv);
  89         int (*uevent)(const struct device *dev, struct kobj_uevent_env *env);
  90         int (*probe)(struct device *dev);
  91         void (*sync_state)(struct device *dev);
  92         void (*remove)(struct device *dev);
  93         void (*shutdown)(struct device *dev);
  94
  95         int (*online)(struct device *dev);
  96         int (*offline)(struct device *dev);
  97
  98         int (*suspend)(struct device *dev, pm_message_t state);
  99         int (*resume)(struct device *dev);
 100
 101         int (*num_vf)(struct device *dev);
 102
 103         int (*dma_configure)(struct device *dev);
 104         void (*dma_cleanup)(struct device *dev);
 105
 106         const struct dev_pm_ops *pm;
 107
 108         const struct iommu_ops *iommu_ops;
 109
 110         bool need_parent_lock;
 111 };
 112
 113 extern int __must_check bus_register(struct bus_type *bus);
 114
 115 extern void bus_unregister(const struct bus_type *bus);
 116
 117 extern int __must_check bus_rescan_devices(struct bus_type *bus);
 118
 119 struct bus_attribute {
 120         struct attribute        attr;
 121         ssize_t (*show)(struct bus_type *bus, char *buf);
 122         ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
 123 };
 124
 125 #define BUS_ATTR_RW(_name) \
 126         struct bus_attribute bus_attr_##_name = __ATTR_RW(_name)
 127 #define BUS_ATTR_RO(_name) \
 128         struct bus_attribute bus_attr_##_name = __ATTR_RO(_name)
 129 #define BUS_ATTR_WO(_name) \
 130         struct bus_attribute bus_attr_##_name = __ATTR_WO(_name)
 131
 132 int __must_check bus_create_file(const struct bus_type *bus, struct bus_attribute *attr);
 133 void bus_remove_file(const struct bus_type *bus, struct bus_attribute *attr);
 134
 135 /* Generic device matching functions that all busses can use to match with */
 136 int device_match_name(struct device *dev, const void *name);
 137 int device_match_of_node(struct device *dev, const void *np);
 138 int device_match_fwnode(struct device *dev, const void *fwnode);
 139 int device_match_devt(struct device *dev, const void *pdevt);
 140 int device_match_acpi_dev(struct device *dev, const void *adev);
 141 int device_match_acpi_handle(struct device *dev, const void *handle);
 142 int device_match_any(struct device *dev, const void *unused);
 143
 144 /* iterator helpers for buses */
 145 int bus_for_each_dev(const struct bus_type *bus, struct device *start, void *data,
 146                      int (*fn)(struct device *dev, void *data));
 147 struct device *bus_find_device(const struct bus_type *bus, struct device *start,
 148                                const void *data,
 149                                int (*match)(struct device *dev, const void *data));
 150 /**
 151  * bus_find_device_by_name - device iterator for locating a particular device
 152  * of a specific name.
 153  * @bus: bus type
 154  * @start: Device to begin with
 155  * @name: name of the device to match
 156  */
 157 static inline struct device *bus_find_device_by_name(const struct bus_type *bus,
 158                                                      struct device *start,
 159                                                      const char *name)
 160 {
 161         return bus_find_device(bus, start, name, device_match_name);
 162 }
 163
 164 /**
 165  * bus_find_device_by_of_node : device iterator for locating a particular device
 166  * matching the of_node.
 167  * @bus: bus type
 168  * @np: of_node of the device to match.
 169  */
 170 static inline struct device *
 171 bus_find_device_by_of_node(const struct bus_type *bus, const struct device_node *np)
 172 {
 173         return bus_find_device(bus, NULL, np, device_match_of_node);
 174 }
 175
 176 /**
 177  * bus_find_device_by_fwnode : device iterator for locating a particular device
 178  * matching the fwnode.
 179  * @bus: bus type
 180  * @fwnode: fwnode of the device to match.
 181  */
 182 static inline struct device *
 183 bus_find_device_by_fwnode(const struct bus_type *bus, const struct fwnode_handle *fwnode)
 184 {
 185         return bus_find_device(bus, NULL, fwnode, device_match_fwnode);
 186 }
 187
 188 /**
 189  * bus_find_device_by_devt : device iterator for locating a particular device
 190  * matching the device type.
 191  * @bus: bus type
 192  * @devt: device type of the device to match.
 193  */
 194 static inline struct device *bus_find_device_by_devt(const struct bus_type *bus,
 195                                                      dev_t devt)
 196 {
 197         return bus_find_device(bus, NULL, &devt, device_match_devt);
 198 }
 199
 200 /**
 201  * bus_find_next_device - Find the next device after a given device in a
 202  * given bus.
 203  * @bus: bus type
 204  * @cur: device to begin the search with.
 205  */
 206 static inline struct device *
 207 bus_find_next_device(const struct bus_type *bus,struct device *cur)
 208 {
 209         return bus_find_device(bus, cur, NULL, device_match_any);
 210 }
 211
 212 #ifdef CONFIG_ACPI
 213 struct acpi_device;
 214
 215 /**
 216  * bus_find_device_by_acpi_dev : device iterator for locating a particular device
 217  * matching the ACPI COMPANION device.
 218  * @bus: bus type
 219  * @adev: ACPI COMPANION device to match.
 220  */
 221 static inline struct device *
 222 bus_find_device_by_acpi_dev(const struct bus_type *bus, const struct acpi_device *adev)
 223 {
 224         return bus_find_device(bus, NULL, adev, device_match_acpi_dev);
 225 }
 226 #else
 227 static inline struct device *
 228 bus_find_device_by_acpi_dev(const struct bus_type *bus, const void *adev)
 229 {
 230         return NULL;
 231 }
 232 #endif
 233
 234 int bus_for_each_drv(const struct bus_type *bus, struct device_driver *start,
 235                      void *data, int (*fn)(struct device_driver *, void *));
 236 void bus_sort_breadthfirst(struct bus_type *bus,
 237                            int (*compare)(const struct device *a,
 238                                           const struct device *b));
 239 /*
 240  * Bus notifiers: Get notified of addition/removal of devices
 241  * and binding/unbinding of drivers to devices.
 242  * In the long run, it should be a replacement for the platform
 243  * notify hooks.
 244  */
 245 struct notifier_block;
 246
 247 extern int bus_register_notifier(const struct bus_type *bus,
 248                                  struct notifier_block *nb);
 249 extern int bus_unregister_notifier(const struct bus_type *bus,
 250                                    struct notifier_block *nb);
 251
 252 /**
 253  * enum bus_notifier_event - Bus Notifier events that have happened
 254  * @BUS_NOTIFY_ADD_DEVICE: device is added to this bus
 255  * @BUS_NOTIFY_DEL_DEVICE: device is about to be removed from this bus
 256  * @BUS_NOTIFY_REMOVED_DEVICE: device is successfully removed from this bus
 257  * @BUS_NOTIFY_BIND_DRIVER: a driver is about to be bound to this device on this bus
 258  * @BUS_NOTIFY_BOUND_DRIVER: a driver is successfully bound to this device on this bus
 259  * @BUS_NOTIFY_UNBIND_DRIVER: a driver is about to be unbound from this device on this bus
 260  * @BUS_NOTIFY_UNBOUND_DRIVER: a driver is successfully unbound from this device on this bus
 261  * @BUS_NOTIFY_DRIVER_NOT_BOUND: a driver failed to be bound to this device on this bus
 262  *
 263  * These are the value passed to a bus notifier when a specific event happens.
 264  *
 265  * Note that bus notifiers are likely to be called with the device lock already
 266  * held by the driver core, so be careful in any notifier callback as to what
 267  * you do with the device structure.
 268  *
 269  * All bus notifiers are called with the target struct device * as an argument.
 270  */
 271 enum bus_notifier_event {
 272         BUS_NOTIFY_ADD_DEVICE,
 273         BUS_NOTIFY_DEL_DEVICE,
 274         BUS_NOTIFY_REMOVED_DEVICE,
 275         BUS_NOTIFY_BIND_DRIVER,
 276         BUS_NOTIFY_BOUND_DRIVER,
 277         BUS_NOTIFY_UNBIND_DRIVER,
 278         BUS_NOTIFY_UNBOUND_DRIVER,
 279         BUS_NOTIFY_DRIVER_NOT_BOUND,
 280 };
 281
 282 extern struct kset *bus_get_kset(const struct bus_type *bus);
 283 struct device *bus_get_dev_root(const struct bus_type *bus);
 284
 285 #endif