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