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