include/linux/device.h

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * device.h - generic, centralized 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  *
   9  * See Documentation/driver-api/driver-model/ for more information.
  10  */
  11
  12 #ifndef _DEVICE_H_
  13 #define _DEVICE_H_
  14
  15 #include <linux/dev_printk.h>
  16 #include <linux/energy_model.h>
  17 #include <linux/ioport.h>
  18 #include <linux/kobject.h>
  19 #include <linux/klist.h>
  20 #include <linux/list.h>
  21 #include <linux/lockdep.h>
  22 #include <linux/compiler.h>
  23 #include <linux/types.h>
  24 #include <linux/mutex.h>
  25 #include <linux/pm.h>
  26 #include <linux/atomic.h>
  27 #include <linux/uidgid.h>
  28 #include <linux/gfp.h>
  29 #include <linux/overflow.h>
  30 #include <linux/device/bus.h>
  31 #include <linux/device/class.h>
  32 #include <linux/device/driver.h>
  33 #include <linux/cleanup.h>
  34 #include <asm/device.h>
  35
  36 struct device;
  37 struct device_private;
  38 struct device_driver;
  39 struct driver_private;
  40 struct module;
  41 struct class;
  42 struct subsys_private;
  43 struct device_node;
  44 struct fwnode_handle;
  45 struct iommu_ops;
  46 struct iommu_group;
  47 struct dev_pin_info;
  48 struct dev_iommu;
  49 struct msi_device_data;
  50
  51 /**
  52  * struct subsys_interface - interfaces to device functions
  53  * @name:       name of the device function
  54  * @subsys:     subsystem of the devices to attach to
  55  * @node:       the list of functions registered at the subsystem
  56  * @add_dev:    device hookup to device function handler
  57  * @remove_dev: device hookup to device function handler
  58  *
  59  * Simple interfaces attached to a subsystem. Multiple interfaces can
  60  * attach to a subsystem and its devices. Unlike drivers, they do not
  61  * exclusively claim or control devices. Interfaces usually represent
  62  * a specific functionality of a subsystem/class of devices.
  63  */
  64 struct subsys_interface {
  65         const char *name;
  66         struct bus_type *subsys;
  67         struct list_head node;
  68         int (*add_dev)(struct device *dev, struct subsys_interface *sif);
  69         void (*remove_dev)(struct device *dev, struct subsys_interface *sif);
  70 };
  71
  72 int subsys_interface_register(struct subsys_interface *sif);
  73 void subsys_interface_unregister(struct subsys_interface *sif);
  74
  75 int subsys_system_register(struct bus_type *subsys,
  76                            const struct attribute_group **groups);
  77 int subsys_virtual_register(struct bus_type *subsys,
  78                             const struct attribute_group **groups);
  79
  80 /*
  81  * The type of device, "struct device" is embedded in. A class
  82  * or bus can contain devices of different types
  83  * like "partitions" and "disks", "mouse" and "event".
  84  * This identifies the device type and carries type-specific
  85  * information, equivalent to the kobj_type of a kobject.
  86  * If "name" is specified, the uevent will contain it in
  87  * the DEVTYPE variable.
  88  */
  89 struct device_type {
  90         const char *name;
  91         const struct attribute_group **groups;
  92         int (*uevent)(const struct device *dev, struct kobj_uevent_env *env);
  93         char *(*devnode)(const struct device *dev, umode_t *mode,
  94                          kuid_t *uid, kgid_t *gid);
  95         void (*release)(struct device *dev);
  96
  97         const struct dev_pm_ops *pm;
  98 };
  99
 100 /* interface for exporting device attributes */
 101 struct device_attribute {
 102         struct attribute        attr;
 103         ssize_t (*show)(struct device *dev, struct device_attribute *attr,
 104                         char *buf);
 105         ssize_t (*store)(struct device *dev, struct device_attribute *attr,
 106                          const char *buf, size_t count);
 107 };
 108
 109 struct dev_ext_attribute {
 110         struct device_attribute attr;
 111         void *var;
 112 };
 113
 114 ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
 115                           char *buf);
 116 ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
 117                            const char *buf, size_t count);
 118 ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
 119                         char *buf);
 120 ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
 121                          const char *buf, size_t count);
 122 ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
 123                         char *buf);
 124 ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
 125                          const char *buf, size_t count);
 126
 127 #define DEVICE_ATTR(_name, _mode, _show, _store) \
 128         struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
 129 #define DEVICE_ATTR_PREALLOC(_name, _mode, _show, _store) \
 130         struct device_attribute dev_attr_##_name = \
 131                 __ATTR_PREALLOC(_name, _mode, _show, _store)
 132 #define DEVICE_ATTR_RW(_name) \
 133         struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
 134 #define DEVICE_ATTR_ADMIN_RW(_name) \
 135         struct device_attribute dev_attr_##_name = __ATTR_RW_MODE(_name, 0600)
 136 #define DEVICE_ATTR_RO(_name) \
 137         struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
 138 #define DEVICE_ATTR_ADMIN_RO(_name) \
 139         struct device_attribute dev_attr_##_name = __ATTR_RO_MODE(_name, 0400)
 140 #define DEVICE_ATTR_WO(_name) \
 141         struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
 142 #define DEVICE_ULONG_ATTR(_name, _mode, _var) \
 143         struct dev_ext_attribute dev_attr_##_name = \
 144                 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
 145 #define DEVICE_INT_ATTR(_name, _mode, _var) \
 146         struct dev_ext_attribute dev_attr_##_name = \
 147                 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
 148 #define DEVICE_BOOL_ATTR(_name, _mode, _var) \
 149         struct dev_ext_attribute dev_attr_##_name = \
 150                 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
 151 #define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
 152         struct device_attribute dev_attr_##_name =              \
 153                 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
 154
 155 int device_create_file(struct device *device,
 156                        const struct device_attribute *entry);
 157 void device_remove_file(struct device *dev,
 158                         const struct device_attribute *attr);
 159 bool device_remove_file_self(struct device *dev,
 160                              const struct device_attribute *attr);
 161 int __must_check device_create_bin_file(struct device *dev,
 162                                         const struct bin_attribute *attr);
 163 void device_remove_bin_file(struct device *dev,
 164                             const struct bin_attribute *attr);
 165
 166 /* device resource management */
 167 typedef void (*dr_release_t)(struct device *dev, void *res);
 168 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
 169
 170 void *__devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
 171                           int nid, const char *name) __malloc;
 172 #define devres_alloc(release, size, gfp) \
 173         __devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release)
 174 #define devres_alloc_node(release, size, gfp, nid) \
 175         __devres_alloc_node(release, size, gfp, nid, #release)
 176
 177 void devres_for_each_res(struct device *dev, dr_release_t release,
 178                          dr_match_t match, void *match_data,
 179                          void (*fn)(struct device *, void *, void *),
 180                          void *data);
 181 void devres_free(void *res);
 182 void devres_add(struct device *dev, void *res);
 183 void *devres_find(struct device *dev, dr_release_t release,
 184                   dr_match_t match, void *match_data);
 185 void *devres_get(struct device *dev, void *new_res,
 186                  dr_match_t match, void *match_data);
 187 void *devres_remove(struct device *dev, dr_release_t release,
 188                     dr_match_t match, void *match_data);
 189 int devres_destroy(struct device *dev, dr_release_t release,
 190                    dr_match_t match, void *match_data);
 191 int devres_release(struct device *dev, dr_release_t release,
 192                    dr_match_t match, void *match_data);
 193
 194 /* devres group */
 195 void * __must_check devres_open_group(struct device *dev, void *id, gfp_t gfp);
 196 void devres_close_group(struct device *dev, void *id);
 197 void devres_remove_group(struct device *dev, void *id);
 198 int devres_release_group(struct device *dev, void *id);
 199
 200 /* managed devm_k.alloc/kfree for device drivers */
 201 void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp) __alloc_size(2);
 202 void *devm_krealloc(struct device *dev, void *ptr, size_t size,
 203                     gfp_t gfp) __must_check __realloc_size(3);
 204 __printf(3, 0) char *devm_kvasprintf(struct device *dev, gfp_t gfp,
 205                                      const char *fmt, va_list ap) __malloc;
 206 __printf(3, 4) char *devm_kasprintf(struct device *dev, gfp_t gfp,
 207                                     const char *fmt, ...) __malloc;
 208 static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp)
 209 {
 210         return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
 211 }
 212 static inline void *devm_kmalloc_array(struct device *dev,
 213                                        size_t n, size_t size, gfp_t flags)
 214 {
 215         size_t bytes;
 216
 217         if (unlikely(check_mul_overflow(n, size, &bytes)))
 218                 return NULL;
 219
 220         return devm_kmalloc(dev, bytes, flags);
 221 }
 222 static inline void *devm_kcalloc(struct device *dev,
 223                                  size_t n, size_t size, gfp_t flags)
 224 {
 225         return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
 226 }
 227 void devm_kfree(struct device *dev, const void *p);
 228 char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp) __malloc;
 229 const char *devm_kstrdup_const(struct device *dev, const char *s, gfp_t gfp);
 230 void *devm_kmemdup(struct device *dev, const void *src, size_t len, gfp_t gfp)
 231         __realloc_size(3);
 232
 233 unsigned long devm_get_free_pages(struct device *dev,
 234                                   gfp_t gfp_mask, unsigned int order);
 235 void devm_free_pages(struct device *dev, unsigned long addr);
 236
 237 void __iomem *devm_ioremap_resource(struct device *dev,
 238                                     const struct resource *res);
 239 void __iomem *devm_ioremap_resource_wc(struct device *dev,
 240                                        const struct resource *res);
 241
 242 void __iomem *devm_of_iomap(struct device *dev,
 243                             struct device_node *node, int index,
 244                             resource_size_t *size);
 245
 246 /* allows to add/remove a custom action to devres stack */
 247 void devm_remove_action(struct device *dev, void (*action)(void *), void *data);
 248 void devm_release_action(struct device *dev, void (*action)(void *), void *data);
 249
 250 int __devm_add_action(struct device *dev, void (*action)(void *), void *data, const char *name);
 251 #define devm_add_action(release, action, data) \
 252         __devm_add_action(release, action, data, #action)
 253
 254 static inline int __devm_add_action_or_reset(struct device *dev, void (*action)(void *),
 255                                              void *data, const char *name)
 256 {
 257         int ret;
 258
 259         ret = __devm_add_action(dev, action, data, name);
 260         if (ret)
 261                 action(data);
 262
 263         return ret;
 264 }
 265 #define devm_add_action_or_reset(release, action, data) \
 266         __devm_add_action_or_reset(release, action, data, #action)
 267
 268 /**
 269  * devm_alloc_percpu - Resource-managed alloc_percpu
 270  * @dev: Device to allocate per-cpu memory for
 271  * @type: Type to allocate per-cpu memory for
 272  *
 273  * Managed alloc_percpu. Per-cpu memory allocated with this function is
 274  * automatically freed on driver detach.
 275  *
 276  * RETURNS:
 277  * Pointer to allocated memory on success, NULL on failure.
 278  */
 279 #define devm_alloc_percpu(dev, type)      \
 280         ((typeof(type) __percpu *)__devm_alloc_percpu((dev), sizeof(type), \
 281                                                       __alignof__(type)))
 282
 283 void __percpu *__devm_alloc_percpu(struct device *dev, size_t size,
 284                                    size_t align);
 285 void devm_free_percpu(struct device *dev, void __percpu *pdata);
 286
 287 struct device_dma_parameters {
 288         /*
 289          * a low level driver may set these to teach IOMMU code about
 290          * sg limitations.
 291          */
 292         unsigned int max_segment_size;
 293         unsigned int min_align_mask;
 294         unsigned long segment_boundary_mask;
 295 };
 296
 297 /**
 298  * enum device_link_state - Device link states.
 299  * @DL_STATE_NONE: The presence of the drivers is not being tracked.
 300  * @DL_STATE_DORMANT: None of the supplier/consumer drivers is present.
 301  * @DL_STATE_AVAILABLE: The supplier driver is present, but the consumer is not.
 302  * @DL_STATE_CONSUMER_PROBE: The consumer is probing (supplier driver present).
 303  * @DL_STATE_ACTIVE: Both the supplier and consumer drivers are present.
 304  * @DL_STATE_SUPPLIER_UNBIND: The supplier driver is unbinding.
 305  */
 306 enum device_link_state {
 307         DL_STATE_NONE = -1,
 308         DL_STATE_DORMANT = 0,
 309         DL_STATE_AVAILABLE,
 310         DL_STATE_CONSUMER_PROBE,
 311         DL_STATE_ACTIVE,
 312         DL_STATE_SUPPLIER_UNBIND,
 313 };
 314
 315 /*
 316  * Device link flags.
 317  *
 318  * STATELESS: The core will not remove this link automatically.
 319  * AUTOREMOVE_CONSUMER: Remove the link automatically on consumer driver unbind.
 320  * PM_RUNTIME: If set, the runtime PM framework will use this link.
 321  * RPM_ACTIVE: Run pm_runtime_get_sync() on the supplier during link creation.
 322  * AUTOREMOVE_SUPPLIER: Remove the link automatically on supplier driver unbind.
 323  * AUTOPROBE_CONSUMER: Probe consumer driver automatically after supplier binds.
 324  * MANAGED: The core tracks presence of supplier/consumer drivers (internal).
 325  * SYNC_STATE_ONLY: Link only affects sync_state() behavior.
 326  * INFERRED: Inferred from data (eg: firmware) and not from driver actions.
 327  */
 328 #define DL_FLAG_STATELESS               BIT(0)
 329 #define DL_FLAG_AUTOREMOVE_CONSUMER     BIT(1)
 330 #define DL_FLAG_PM_RUNTIME              BIT(2)
 331 #define DL_FLAG_RPM_ACTIVE              BIT(3)
 332 #define DL_FLAG_AUTOREMOVE_SUPPLIER     BIT(4)
 333 #define DL_FLAG_AUTOPROBE_CONSUMER      BIT(5)
 334 #define DL_FLAG_MANAGED                 BIT(6)
 335 #define DL_FLAG_SYNC_STATE_ONLY         BIT(7)
 336 #define DL_FLAG_INFERRED                BIT(8)
 337 #define DL_FLAG_CYCLE                   BIT(9)
 338
 339 /**
 340  * enum dl_dev_state - Device driver presence tracking information.
 341  * @DL_DEV_NO_DRIVER: There is no driver attached to the device.
 342  * @DL_DEV_PROBING: A driver is probing.
 343  * @DL_DEV_DRIVER_BOUND: The driver has been bound to the device.
 344  * @DL_DEV_UNBINDING: The driver is unbinding from the device.
 345  */
 346 enum dl_dev_state {
 347         DL_DEV_NO_DRIVER = 0,
 348         DL_DEV_PROBING,
 349         DL_DEV_DRIVER_BOUND,
 350         DL_DEV_UNBINDING,
 351 };
 352
 353 /**
 354  * enum device_removable - Whether the device is removable. The criteria for a
 355  * device to be classified as removable is determined by its subsystem or bus.
 356  * @DEVICE_REMOVABLE_NOT_SUPPORTED: This attribute is not supported for this
 357  *                                  device (default).
 358  * @DEVICE_REMOVABLE_UNKNOWN:  Device location is Unknown.
 359  * @DEVICE_FIXED: Device is not removable by the user.
 360  * @DEVICE_REMOVABLE: Device is removable by the user.
 361  */
 362 enum device_removable {
 363         DEVICE_REMOVABLE_NOT_SUPPORTED = 0, /* must be 0 */
 364         DEVICE_REMOVABLE_UNKNOWN,
 365         DEVICE_FIXED,
 366         DEVICE_REMOVABLE,
 367 };
 368
 369 /**
 370  * struct dev_links_info - Device data related to device links.
 371  * @suppliers: List of links to supplier devices.
 372  * @consumers: List of links to consumer devices.
 373  * @defer_sync: Hook to global list of devices that have deferred sync_state.
 374  * @status: Driver status information.
 375  */
 376 struct dev_links_info {
 377         struct list_head suppliers;
 378         struct list_head consumers;
 379         struct list_head defer_sync;
 380         enum dl_dev_state status;
 381 };
 382
 383 /**
 384  * struct dev_msi_info - Device data related to MSI
 385  * @domain:     The MSI interrupt domain associated to the device
 386  * @data:       Pointer to MSI device data
 387  */
 388 struct dev_msi_info {
 389 #ifdef CONFIG_GENERIC_MSI_IRQ
 390         struct irq_domain       *domain;
 391         struct msi_device_data  *data;
 392 #endif
 393 };
 394
 395 /**
 396  * enum device_physical_location_panel - Describes which panel surface of the
 397  * system's housing the device connection point resides on.
 398  * @DEVICE_PANEL_TOP: Device connection point is on the top panel.
 399  * @DEVICE_PANEL_BOTTOM: Device connection point is on the bottom panel.
 400  * @DEVICE_PANEL_LEFT: Device connection point is on the left panel.
 401  * @DEVICE_PANEL_RIGHT: Device connection point is on the right panel.
 402  * @DEVICE_PANEL_FRONT: Device connection point is on the front panel.
 403  * @DEVICE_PANEL_BACK: Device connection point is on the back panel.
 404  * @DEVICE_PANEL_UNKNOWN: The panel with device connection point is unknown.
 405  */
 406 enum device_physical_location_panel {
 407         DEVICE_PANEL_TOP,
 408         DEVICE_PANEL_BOTTOM,
 409         DEVICE_PANEL_LEFT,
 410         DEVICE_PANEL_RIGHT,
 411         DEVICE_PANEL_FRONT,
 412         DEVICE_PANEL_BACK,
 413         DEVICE_PANEL_UNKNOWN,
 414 };
 415
 416 /**
 417  * enum device_physical_location_vertical_position - Describes vertical
 418  * position of the device connection point on the panel surface.
 419  * @DEVICE_VERT_POS_UPPER: Device connection point is at upper part of panel.
 420  * @DEVICE_VERT_POS_CENTER: Device connection point is at center part of panel.
 421  * @DEVICE_VERT_POS_LOWER: Device connection point is at lower part of panel.
 422  */
 423 enum device_physical_location_vertical_position {
 424         DEVICE_VERT_POS_UPPER,
 425         DEVICE_VERT_POS_CENTER,
 426         DEVICE_VERT_POS_LOWER,
 427 };
 428
 429 /**
 430  * enum device_physical_location_horizontal_position - Describes horizontal
 431  * position of the device connection point on the panel surface.
 432  * @DEVICE_HORI_POS_LEFT: Device connection point is at left part of panel.
 433  * @DEVICE_HORI_POS_CENTER: Device connection point is at center part of panel.
 434  * @DEVICE_HORI_POS_RIGHT: Device connection point is at right part of panel.
 435  */
 436 enum device_physical_location_horizontal_position {
 437         DEVICE_HORI_POS_LEFT,
 438         DEVICE_HORI_POS_CENTER,
 439         DEVICE_HORI_POS_RIGHT,
 440 };
 441
 442 /**
 443  * struct device_physical_location - Device data related to physical location
 444  * of the device connection point.
 445  * @panel: Panel surface of the system's housing that the device connection
 446  *         point resides on.
 447  * @vertical_position: Vertical position of the device connection point within
 448  *                     the panel.
 449  * @horizontal_position: Horizontal position of the device connection point
 450  *                       within the panel.
 451  * @dock: Set if the device connection point resides in a docking station or
 452  *        port replicator.
 453  * @lid: Set if this device connection point resides on the lid of laptop
 454  *       system.
 455  */
 456 struct device_physical_location {
 457         enum device_physical_location_panel panel;
 458         enum device_physical_location_vertical_position vertical_position;
 459         enum device_physical_location_horizontal_position horizontal_position;
 460         bool dock;
 461         bool lid;
 462 };
 463
 464 /**
 465  * struct device - The basic device structure
 466  * @parent:     The device's "parent" device, the device to which it is attached.
 467  *              In most cases, a parent device is some sort of bus or host
 468  *              controller. If parent is NULL, the device, is a top-level device,
 469  *              which is not usually what you want.
 470  * @p:          Holds the private data of the driver core portions of the device.
 471  *              See the comment of the struct device_private for detail.
 472  * @kobj:       A top-level, abstract class from which other classes are derived.
 473  * @init_name:  Initial name of the device.
 474  * @type:       The type of device.
 475  *              This identifies the device type and carries type-specific
 476  *              information.
 477  * @mutex:      Mutex to synchronize calls to its driver.
 478  * @bus:        Type of bus device is on.
 479  * @driver:     Which driver has allocated this
 480  * @platform_data: Platform data specific to the device.
 481  *              Example: For devices on custom boards, as typical of embedded
 482  *              and SOC based hardware, Linux often uses platform_data to point
 483  *              to board-specific structures describing devices and how they
 484  *              are wired.  That can include what ports are available, chip
 485  *              variants, which GPIO pins act in what additional roles, and so
 486  *              on.  This shrinks the "Board Support Packages" (BSPs) and
 487  *              minimizes board-specific #ifdefs in drivers.
 488  * @driver_data: Private pointer for driver specific info.
 489  * @links:      Links to suppliers and consumers of this device.
 490  * @power:      For device power management.
 491  *              See Documentation/driver-api/pm/devices.rst for details.
 492  * @pm_domain:  Provide callbacks that are executed during system suspend,
 493  *              hibernation, system resume and during runtime PM transitions
 494  *              along with subsystem-level and driver-level callbacks.
 495  * @em_pd:      device's energy model performance domain
 496  * @pins:       For device pin management.
 497  *              See Documentation/driver-api/pin-control.rst for details.
 498  * @msi:        MSI related data
 499  * @numa_node:  NUMA node this device is close to.
 500  * @dma_ops:    DMA mapping operations for this device.
 501  * @dma_mask:   Dma mask (if dma'ble device).
 502  * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
 503  *              hardware supports 64-bit addresses for consistent allocations
 504  *              such descriptors.
 505  * @bus_dma_limit: Limit of an upstream bridge or bus which imposes a smaller
 506  *              DMA limit than the device itself supports.
 507  * @dma_range_map: map for DMA memory ranges relative to that of RAM
 508  * @dma_parms:  A low level driver may set these to teach IOMMU code about
 509  *              segment limitations.
 510  * @dma_pools:  Dma pools (if dma'ble device).
 511  * @dma_mem:    Internal for coherent mem override.
 512  * @cma_area:   Contiguous memory area for dma allocations
 513  * @dma_io_tlb_mem: Pointer to the swiotlb pool used.  Not for driver use.
 514  * @archdata:   For arch-specific additions.
 515  * @of_node:    Associated device tree node.
 516  * @fwnode:     Associated device node supplied by platform firmware.
 517  * @devt:       For creating the sysfs "dev".
 518  * @id:         device instance
 519  * @devres_lock: Spinlock to protect the resource of the device.
 520  * @devres_head: The resources list of the device.
 521  * @knode_class: The node used to add the device to the class list.
 522  * @class:      The class of the device.
 523  * @groups:     Optional attribute groups.
 524  * @release:    Callback to free the device after all references have
 525  *              gone away. This should be set by the allocator of the
 526  *              device (i.e. the bus driver that discovered the device).
 527  * @iommu_group: IOMMU group the device belongs to.
 528  * @iommu:      Per device generic IOMMU runtime data
 529  * @physical_location: Describes physical location of the device connection
 530  *              point in the system housing.
 531  * @removable:  Whether the device can be removed from the system. This
 532  *              should be set by the subsystem / bus driver that discovered
 533  *              the device.
 534  *
 535  * @offline_disabled: If set, the device is permanently online.
 536  * @offline:    Set after successful invocation of bus type's .offline().
 537  * @of_node_reused: Set if the device-tree node is shared with an ancestor
 538  *              device.
 539  * @state_synced: The hardware state of this device has been synced to match
 540  *                the software state of this device by calling the driver/bus
 541  *                sync_state() callback.
 542  * @can_match:  The device has matched with a driver at least once or it is in
 543  *              a bus (like AMBA) which can't check for matching drivers until
 544  *              other devices probe successfully.
 545  * @dma_coherent: this particular device is dma coherent, even if the
 546  *              architecture supports non-coherent devices.
 547  * @dma_ops_bypass: If set to %true then the dma_ops are bypassed for the
 548  *              streaming DMA operations (->map_* / ->unmap_* / ->sync_*),
 549  *              and optionall (if the coherent mask is large enough) also
 550  *              for dma allocations.  This flag is managed by the dma ops
 551  *              instance from ->dma_supported.
 552  *
 553  * At the lowest level, every device in a Linux system is represented by an
 554  * instance of struct device. The device structure contains the information
 555  * that the device model core needs to model the system. Most subsystems,
 556  * however, track additional information about the devices they host. As a
 557  * result, it is rare for devices to be represented by bare device structures;
 558  * instead, that structure, like kobject structures, is usually embedded within
 559  * a higher-level representation of the device.
 560  */
 561 struct device {
 562         struct kobject kobj;
 563         struct device           *parent;
 564
 565         struct device_private   *p;
 566
 567         const char              *init_name; /* initial name of the device */
 568         const struct device_type *type;
 569
 570         const struct bus_type   *bus;   /* type of bus device is on */
 571         struct device_driver *driver;   /* which driver has allocated this
 572                                            device */
 573         void            *platform_data; /* Platform specific data, device
 574                                            core doesn't touch it */
 575         void            *driver_data;   /* Driver data, set and get with
 576                                            dev_set_drvdata/dev_get_drvdata */
 577         struct mutex            mutex;  /* mutex to synchronize calls to
 578                                          * its driver.
 579                                          */
 580
 581         struct dev_links_info   links;
 582         struct dev_pm_info      power;
 583         struct dev_pm_domain    *pm_domain;
 584
 585 #ifdef CONFIG_ENERGY_MODEL
 586         struct em_perf_domain   *em_pd;
 587 #endif
 588
 589 #ifdef CONFIG_PINCTRL
 590         struct dev_pin_info     *pins;
 591 #endif
 592         struct dev_msi_info     msi;
 593 #ifdef CONFIG_DMA_OPS
 594         const struct dma_map_ops *dma_ops;
 595 #endif
 596         u64             *dma_mask;      /* dma mask (if dma'able device) */
 597         u64             coherent_dma_mask;/* Like dma_mask, but for
 598                                              alloc_coherent mappings as
 599                                              not all hardware supports
 600                                              64 bit addresses for consistent
 601                                              allocations such descriptors. */
 602         u64             bus_dma_limit;  /* upstream dma constraint */
 603         const struct bus_dma_region *dma_range_map;
 604
 605         struct device_dma_parameters *dma_parms;
 606
 607         struct list_head        dma_pools;      /* dma pools (if dma'ble) */
 608
 609 #ifdef CONFIG_DMA_DECLARE_COHERENT
 610         struct dma_coherent_mem *dma_mem; /* internal for coherent mem
 611                                              override */
 612 #endif
 613 #ifdef CONFIG_DMA_CMA
 614         struct cma *cma_area;           /* contiguous memory area for dma
 615                                            allocations */
 616 #endif
 617 #ifdef CONFIG_SWIOTLB
 618         struct io_tlb_mem *dma_io_tlb_mem;
 619 #endif
 620         /* arch specific additions */
 621         struct dev_archdata     archdata;
 622
 623         struct device_node      *of_node; /* associated device tree node */
 624         struct fwnode_handle    *fwnode; /* firmware device node */
 625
 626 #ifdef CONFIG_NUMA
 627         int             numa_node;      /* NUMA node this device is close to */
 628 #endif
 629         dev_t                   devt;   /* dev_t, creates the sysfs "dev" */
 630         u32                     id;     /* device instance */
 631
 632         spinlock_t              devres_lock;
 633         struct list_head        devres_head;
 634
 635         const struct class      *class;
 636         const struct attribute_group **groups;  /* optional groups */
 637
 638         void    (*release)(struct device *dev);
 639         struct iommu_group      *iommu_group;
 640         struct dev_iommu        *iommu;
 641
 642         struct device_physical_location *physical_location;
 643
 644         enum device_removable   removable;
 645
 646         bool                    offline_disabled:1;
 647         bool                    offline:1;
 648         bool                    of_node_reused:1;
 649         bool                    state_synced:1;
 650         bool                    can_match:1;
 651 #if defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_DEVICE) || \
 652     defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU) || \
 653     defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU_ALL)
 654         bool                    dma_coherent:1;
 655 #endif
 656 #ifdef CONFIG_DMA_OPS_BYPASS
 657         bool                    dma_ops_bypass : 1;
 658 #endif
 659 };
 660
 661 /**
 662  * struct device_link - Device link representation.
 663  * @supplier: The device on the supplier end of the link.
 664  * @s_node: Hook to the supplier device's list of links to consumers.
 665  * @consumer: The device on the consumer end of the link.
 666  * @c_node: Hook to the consumer device's list of links to suppliers.
 667  * @link_dev: device used to expose link details in sysfs
 668  * @status: The state of the link (with respect to the presence of drivers).
 669  * @flags: Link flags.
 670  * @rpm_active: Whether or not the consumer device is runtime-PM-active.
 671  * @kref: Count repeated addition of the same link.
 672  * @rm_work: Work structure used for removing the link.
 673  * @supplier_preactivated: Supplier has been made active before consumer probe.
 674  */
 675 struct device_link {
 676         struct device *supplier;
 677         struct list_head s_node;
 678         struct device *consumer;
 679         struct list_head c_node;
 680         struct device link_dev;
 681         enum device_link_state status;
 682         u32 flags;
 683         refcount_t rpm_active;
 684         struct kref kref;
 685         struct work_struct rm_work;
 686         bool supplier_preactivated; /* Owned by consumer probe. */
 687 };
 688
 689 #define kobj_to_dev(__kobj)     container_of_const(__kobj, struct device, kobj)
 690
 691 /**
 692  * device_iommu_mapped - Returns true when the device DMA is translated
 693  *                       by an IOMMU
 694  * @dev: Device to perform the check on
 695  */
 696 static inline bool device_iommu_mapped(struct device *dev)
 697 {
 698         return (dev->iommu_group != NULL);
 699 }
 700
 701 /* Get the wakeup routines, which depend on struct device */
 702 #include <linux/pm_wakeup.h>
 703
 704 static inline const char *dev_name(const struct device *dev)
 705 {
 706         /* Use the init name until the kobject becomes available */
 707         if (dev->init_name)
 708                 return dev->init_name;
 709
 710         return kobject_name(&dev->kobj);
 711 }
 712
 713 /**
 714  * dev_bus_name - Return a device's bus/class name, if at all possible
 715  * @dev: struct device to get the bus/class name of
 716  *
 717  * Will return the name of the bus/class the device is attached to.  If it is
 718  * not attached to a bus/class, an empty string will be returned.
 719  */
 720 static inline const char *dev_bus_name(const struct device *dev)
 721 {
 722         return dev->bus ? dev->bus->name : (dev->class ? dev->class->name : "");
 723 }
 724
 725 __printf(2, 3) int dev_set_name(struct device *dev, const char *name, ...);
 726
 727 #ifdef CONFIG_NUMA
 728 static inline int dev_to_node(struct device *dev)
 729 {
 730         return dev->numa_node;
 731 }
 732 static inline void set_dev_node(struct device *dev, int node)
 733 {
 734         dev->numa_node = node;
 735 }
 736 #else
 737 static inline int dev_to_node(struct device *dev)
 738 {
 739         return NUMA_NO_NODE;
 740 }
 741 static inline void set_dev_node(struct device *dev, int node)
 742 {
 743 }
 744 #endif
 745
 746 static inline struct irq_domain *dev_get_msi_domain(const struct device *dev)
 747 {
 748 #ifdef CONFIG_GENERIC_MSI_IRQ
 749         return dev->msi.domain;
 750 #else
 751         return NULL;
 752 #endif
 753 }
 754
 755 static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d)
 756 {
 757 #ifdef CONFIG_GENERIC_MSI_IRQ
 758         dev->msi.domain = d;
 759 #endif
 760 }
 761
 762 static inline void *dev_get_drvdata(const struct device *dev)
 763 {
 764         return dev->driver_data;
 765 }
 766
 767 static inline void dev_set_drvdata(struct device *dev, void *data)
 768 {
 769         dev->driver_data = data;
 770 }
 771
 772 static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
 773 {
 774         return dev ? dev->power.subsys_data : NULL;
 775 }
 776
 777 static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
 778 {
 779         return dev->kobj.uevent_suppress;
 780 }
 781
 782 static inline void dev_set_uevent_suppress(struct device *dev, int val)
 783 {
 784         dev->kobj.uevent_suppress = val;
 785 }
 786
 787 static inline int device_is_registered(struct device *dev)
 788 {
 789         return dev->kobj.state_in_sysfs;
 790 }
 791
 792 static inline void device_enable_async_suspend(struct device *dev)
 793 {
 794         if (!dev->power.is_prepared)
 795                 dev->power.async_suspend = true;
 796 }
 797
 798 static inline void device_disable_async_suspend(struct device *dev)
 799 {
 800         if (!dev->power.is_prepared)
 801                 dev->power.async_suspend = false;
 802 }
 803
 804 static inline bool device_async_suspend_enabled(struct device *dev)
 805 {
 806         return !!dev->power.async_suspend;
 807 }
 808
 809 static inline bool device_pm_not_required(struct device *dev)
 810 {
 811         return dev->power.no_pm;
 812 }
 813
 814 static inline void device_set_pm_not_required(struct device *dev)
 815 {
 816         dev->power.no_pm = true;
 817 }
 818
 819 static inline void dev_pm_syscore_device(struct device *dev, bool val)
 820 {
 821 #ifdef CONFIG_PM_SLEEP
 822         dev->power.syscore = val;
 823 #endif
 824 }
 825
 826 static inline void dev_pm_set_driver_flags(struct device *dev, u32 flags)
 827 {
 828         dev->power.driver_flags = flags;
 829 }
 830
 831 static inline bool dev_pm_test_driver_flags(struct device *dev, u32 flags)
 832 {
 833         return !!(dev->power.driver_flags & flags);
 834 }
 835
 836 static inline void device_lock(struct device *dev)
 837 {
 838         mutex_lock(&dev->mutex);
 839 }
 840
 841 static inline int device_lock_interruptible(struct device *dev)
 842 {
 843         return mutex_lock_interruptible(&dev->mutex);
 844 }
 845
 846 static inline int device_trylock(struct device *dev)
 847 {
 848         return mutex_trylock(&dev->mutex);
 849 }
 850
 851 static inline void device_unlock(struct device *dev)
 852 {
 853         mutex_unlock(&dev->mutex);
 854 }
 855
 856 static inline void device_lock_assert(struct device *dev)
 857 {
 858         lockdep_assert_held(&dev->mutex);
 859 }
 860
 861 static inline struct device_node *dev_of_node(struct device *dev)
 862 {
 863         if (!IS_ENABLED(CONFIG_OF) || !dev)
 864                 return NULL;
 865         return dev->of_node;
 866 }
 867
 868 static inline bool dev_has_sync_state(struct device *dev)
 869 {
 870         if (!dev)
 871                 return false;
 872         if (dev->driver && dev->driver->sync_state)
 873                 return true;
 874         if (dev->bus && dev->bus->sync_state)
 875                 return true;
 876         return false;
 877 }
 878
 879 static inline void dev_set_removable(struct device *dev,
 880                                      enum device_removable removable)
 881 {
 882         dev->removable = removable;
 883 }
 884
 885 static inline bool dev_is_removable(struct device *dev)
 886 {
 887         return dev->removable == DEVICE_REMOVABLE;
 888 }
 889
 890 static inline bool dev_removable_is_valid(struct device *dev)
 891 {
 892         return dev->removable != DEVICE_REMOVABLE_NOT_SUPPORTED;
 893 }
 894
 895 /*
 896  * High level routines for use by the bus drivers
 897  */
 898 int __must_check device_register(struct device *dev);
 899 void device_unregister(struct device *dev);
 900 void device_initialize(struct device *dev);
 901 int __must_check device_add(struct device *dev);
 902 void device_del(struct device *dev);
 903
 904 DEFINE_FREE(device_del, struct device *, if (_T) device_del(_T))
 905
 906 int device_for_each_child(struct device *dev, void *data,
 907                           int (*fn)(struct device *dev, void *data));
 908 int device_for_each_child_reverse(struct device *dev, void *data,
 909                                   int (*fn)(struct device *dev, void *data));
 910 struct device *device_find_child(struct device *dev, void *data,
 911                                  int (*match)(struct device *dev, void *data));
 912 struct device *device_find_child_by_name(struct device *parent,
 913                                          const char *name);
 914 struct device *device_find_any_child(struct device *parent);
 915
 916 int device_rename(struct device *dev, const char *new_name);
 917 int device_move(struct device *dev, struct device *new_parent,
 918                 enum dpm_order dpm_order);
 919 int device_change_owner(struct device *dev, kuid_t kuid, kgid_t kgid);
 920 int device_is_dependent(struct device *dev, void *target);
 921
 922 static inline bool device_supports_offline(struct device *dev)
 923 {
 924         return dev->bus && dev->bus->offline && dev->bus->online;
 925 }
 926
 927 #define __device_lock_set_class(dev, name, key)                        \
 928 do {                                                                   \
 929         struct device *__d2 __maybe_unused = dev;                      \
 930         lock_set_class(&__d2->mutex.dep_map, name, key, 0, _THIS_IP_); \
 931 } while (0)
 932
 933 /**
 934  * device_lock_set_class - Specify a temporary lock class while a device
 935  *                         is attached to a driver
 936  * @dev: device to modify
 937  * @key: lock class key data
 938  *
 939  * This must be called with the device_lock() already held, for example
 940  * from driver ->probe(). Take care to only override the default
 941  * lockdep_no_validate class.
 942  */
 943 #ifdef CONFIG_LOCKDEP
 944 #define device_lock_set_class(dev, key)                                    \
 945 do {                                                                       \
 946         struct device *__d = dev;                                          \
 947         dev_WARN_ONCE(__d, !lockdep_match_class(&__d->mutex,               \
 948                                                 &__lockdep_no_validate__), \
 949                  "overriding existing custom lock class\n");               \
 950         __device_lock_set_class(__d, #key, key);                           \
 951 } while (0)
 952 #else
 953 #define device_lock_set_class(dev, key) __device_lock_set_class(dev, #key, key)
 954 #endif
 955
 956 /**
 957  * device_lock_reset_class - Return a device to the default lockdep novalidate state
 958  * @dev: device to modify
 959  *
 960  * This must be called with the device_lock() already held, for example
 961  * from driver ->remove().
 962  */
 963 #define device_lock_reset_class(dev) \
 964 do { \
 965         struct device *__d __maybe_unused = dev;                       \
 966         lock_set_novalidate_class(&__d->mutex.dep_map, "&dev->mutex",  \
 967                                   _THIS_IP_);                          \
 968 } while (0)
 969
 970 void lock_device_hotplug(void);
 971 void unlock_device_hotplug(void);
 972 int lock_device_hotplug_sysfs(void);
 973 int device_offline(struct device *dev);
 974 int device_online(struct device *dev);
 975 void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
 976 void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
 977 void device_set_of_node_from_dev(struct device *dev, const struct device *dev2);
 978 void device_set_node(struct device *dev, struct fwnode_handle *fwnode);
 979
 980 static inline int dev_num_vf(struct device *dev)
 981 {
 982         if (dev->bus && dev->bus->num_vf)
 983                 return dev->bus->num_vf(dev);
 984         return 0;
 985 }
 986
 987 /*
 988  * Root device objects for grouping under /sys/devices
 989  */
 990 struct device *__root_device_register(const char *name, struct module *owner);
 991
 992 /* This is a macro to avoid include problems with THIS_MODULE */
 993 #define root_device_register(name) \
 994         __root_device_register(name, THIS_MODULE)
 995
 996 void root_device_unregister(struct device *root);
 997
 998 static inline void *dev_get_platdata(const struct device *dev)
 999 {
1000         return dev->platform_data;
1001 }
1002
1003 /*
1004  * Manual binding of a device to driver. See drivers/base/bus.c
1005  * for information on use.
1006  */
1007 int __must_check device_driver_attach(struct device_driver *drv,
1008                                       struct device *dev);
1009 int __must_check device_bind_driver(struct device *dev);
1010 void device_release_driver(struct device *dev);
1011 int  __must_check device_attach(struct device *dev);
1012 int __must_check driver_attach(struct device_driver *drv);
1013 void device_initial_probe(struct device *dev);
1014 int __must_check device_reprobe(struct device *dev);
1015
1016 bool device_is_bound(struct device *dev);
1017
1018 /*
1019  * Easy functions for dynamically creating devices on the fly
1020  */
1021 __printf(5, 6) struct device *
1022 device_create(const struct class *cls, struct device *parent, dev_t devt,
1023               void *drvdata, const char *fmt, ...);
1024 __printf(6, 7) struct device *
1025 device_create_with_groups(const struct class *cls, struct device *parent, dev_t devt,
1026                           void *drvdata, const struct attribute_group **groups,
1027                           const char *fmt, ...);
1028 void device_destroy(const struct class *cls, dev_t devt);
1029
1030 int __must_check device_add_groups(struct device *dev,
1031                                    const struct attribute_group **groups);
1032 void device_remove_groups(struct device *dev,
1033                           const struct attribute_group **groups);
1034
1035 static inline int __must_check device_add_group(struct device *dev,
1036                                         const struct attribute_group *grp)
1037 {
1038         const struct attribute_group *groups[] = { grp, NULL };
1039
1040         return device_add_groups(dev, groups);
1041 }
1042
1043 static inline void device_remove_group(struct device *dev,
1044                                        const struct attribute_group *grp)
1045 {
1046         const struct attribute_group *groups[] = { grp, NULL };
1047
1048         return device_remove_groups(dev, groups);
1049 }
1050
1051 int __must_check devm_device_add_groups(struct device *dev,
1052                                         const struct attribute_group **groups);
1053 int __must_check devm_device_add_group(struct device *dev,
1054                                        const struct attribute_group *grp);
1055
1056 /*
1057  * Platform "fixup" functions - allow the platform to have their say
1058  * about devices and actions that the general device layer doesn't
1059  * know about.
1060  */
1061 /* Notify platform of device discovery */
1062 extern int (*platform_notify)(struct device *dev);
1063
1064 extern int (*platform_notify_remove)(struct device *dev);
1065
1066
1067 /*
1068  * get_device - atomically increment the reference count for the device.
1069  *
1070  */
1071 struct device *get_device(struct device *dev);
1072 void put_device(struct device *dev);
1073
1074 DEFINE_FREE(put_device, struct device *, if (_T) put_device(_T))
1075
1076 bool kill_device(struct device *dev);
1077
1078 #ifdef CONFIG_DEVTMPFS
1079 int devtmpfs_mount(void);
1080 #else
1081 static inline int devtmpfs_mount(void) { return 0; }
1082 #endif
1083
1084 /* drivers/base/power/shutdown.c */
1085 void device_shutdown(void);
1086
1087 /* debugging and troubleshooting/diagnostic helpers. */
1088 const char *dev_driver_string(const struct device *dev);
1089
1090 /* Device links interface. */
1091 struct device_link *device_link_add(struct device *consumer,
1092                                     struct device *supplier, u32 flags);
1093 void device_link_del(struct device_link *link);
1094 void device_link_remove(void *consumer, struct device *supplier);
1095 void device_links_supplier_sync_state_pause(void);
1096 void device_links_supplier_sync_state_resume(void);
1097
1098 __printf(3, 4) int dev_err_probe(const struct device *dev, int err, const char *fmt, ...);
1099
1100 /* Create alias, so I can be autoloaded. */
1101 #define MODULE_ALIAS_CHARDEV(major,minor) \
1102         MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1103 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1104         MODULE_ALIAS("char-major-" __stringify(major) "-*")
1105
1106 #endif /* _DEVICE_H_ */