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