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-model/ for more information.
  10  */
  11
  12 #ifndef _DEVICE_H_
  13 #define _DEVICE_H_
  14
  15 #include <linux/ioport.h>
  16 #include <linux/kobject.h>
  17 #include <linux/klist.h>
  18 #include <linux/list.h>
  19 #include <linux/lockdep.h>
  20 #include <linux/compiler.h>
  21 #include <linux/types.h>
  22 #include <linux/mutex.h>
  23 #include <linux/pm.h>
  24 #include <linux/atomic.h>
  25 #include <linux/ratelimit.h>
  26 #include <linux/uidgid.h>
  27 #include <linux/gfp.h>
  28 #include <linux/overflow.h>
  29 #include <asm/device.h>
  30
  31 struct device;
  32 struct device_private;
  33 struct device_driver;
  34 struct driver_private;
  35 struct module;
  36 struct class;
  37 struct subsys_private;
  38 struct bus_type;
  39 struct device_node;
  40 struct fwnode_handle;
  41 struct iommu_ops;
  42 struct iommu_group;
  43 struct iommu_fwspec;
  44 struct dev_pin_info;
  45
  46 struct bus_attribute {
  47         struct attribute        attr;
  48         ssize_t (*show)(struct bus_type *bus, char *buf);
  49         ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
  50 };
  51
  52 #define BUS_ATTR(_name, _mode, _show, _store)   \
  53         struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
  54 #define BUS_ATTR_RW(_name) \
  55         struct bus_attribute bus_attr_##_name = __ATTR_RW(_name)
  56 #define BUS_ATTR_RO(_name) \
  57         struct bus_attribute bus_attr_##_name = __ATTR_RO(_name)
  58
  59 extern int __must_check bus_create_file(struct bus_type *,
  60                                         struct bus_attribute *);
  61 extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
  62
  63 /**
  64  * struct bus_type - The bus type of the device
  65  *
  66  * @name:       The name of the bus.
  67  * @dev_name:   Used for subsystems to enumerate devices like ("foo%u", dev->id).
  68  * @dev_root:   Default device to use as the parent.
  69  * @bus_groups: Default attributes of the bus.
  70  * @dev_groups: Default attributes of the devices on the bus.
  71  * @drv_groups: Default attributes of the device drivers on the bus.
  72  * @match:      Called, perhaps multiple times, whenever a new device or driver
  73  *              is added for this bus. It should return a positive value if the
  74  *              given device can be handled by the given driver and zero
  75  *              otherwise. It may also return error code if determining that
  76  *              the driver supports the device is not possible. In case of
  77  *              -EPROBE_DEFER it will queue the device for deferred probing.
  78  * @uevent:     Called when a device is added, removed, or a few other things
  79  *              that generate uevents to add the environment variables.
  80  * @probe:      Called when a new device or driver add to this bus, and callback
  81  *              the specific driver's probe to initial the matched device.
  82  * @remove:     Called when a device removed from this bus.
  83  * @shutdown:   Called at shut-down time to quiesce the device.
  84  *
  85  * @online:     Called to put the device back online (after offlining it).
  86  * @offline:    Called to put the device offline for hot-removal. May fail.
  87  *
  88  * @suspend:    Called when a device on this bus wants to go to sleep mode.
  89  * @resume:     Called to bring a device on this bus out of sleep mode.
  90  * @num_vf:     Called to find out how many virtual functions a device on this
  91  *              bus supports.
  92  * @dma_configure:      Called to setup DMA configuration on a device on
  93  *                      this bus.
  94  * @pm:         Power management operations of this bus, callback the specific
  95  *              device driver's pm-ops.
  96  * @iommu_ops:  IOMMU specific operations for this bus, used to attach IOMMU
  97  *              driver implementations to a bus and allow the driver to do
  98  *              bus-specific setup
  99  * @p:          The private data of the driver core, only the driver core can
 100  *              touch this.
 101  * @lock_key:   Lock class key for use by the lock validator
 102  * @need_parent_lock:   When probing or removing a device on this bus, the
 103  *                      device core should lock the device's parent.
 104  *
 105  * A bus is a channel between the processor and one or more devices. For the
 106  * purposes of the device model, all devices are connected via a bus, even if
 107  * it is an internal, virtual, "platform" bus. Buses can plug into each other.
 108  * A USB controller is usually a PCI device, for example. The device model
 109  * represents the actual connections between buses and the devices they control.
 110  * A bus is represented by the bus_type structure. It contains the name, the
 111  * default attributes, the bus' methods, PM operations, and the driver core's
 112  * private data.
 113  */
 114 struct bus_type {
 115         const char              *name;
 116         const char              *dev_name;
 117         struct device           *dev_root;
 118         const struct attribute_group **bus_groups;
 119         const struct attribute_group **dev_groups;
 120         const struct attribute_group **drv_groups;
 121
 122         int (*match)(struct device *dev, struct device_driver *drv);
 123         int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
 124         int (*probe)(struct device *dev);
 125         int (*remove)(struct device *dev);
 126         void (*shutdown)(struct device *dev);
 127
 128         int (*online)(struct device *dev);
 129         int (*offline)(struct device *dev);
 130
 131         int (*suspend)(struct device *dev, pm_message_t state);
 132         int (*resume)(struct device *dev);
 133
 134         int (*num_vf)(struct device *dev);
 135
 136         int (*dma_configure)(struct device *dev);
 137
 138         const struct dev_pm_ops *pm;
 139
 140         const struct iommu_ops *iommu_ops;
 141
 142         struct subsys_private *p;
 143         struct lock_class_key lock_key;
 144
 145         bool need_parent_lock;
 146 };
 147
 148 extern int __must_check bus_register(struct bus_type *bus);
 149
 150 extern void bus_unregister(struct bus_type *bus);
 151
 152 extern int __must_check bus_rescan_devices(struct bus_type *bus);
 153
 154 /* iterator helpers for buses */
 155 struct subsys_dev_iter {
 156         struct klist_iter               ki;
 157         const struct device_type        *type;
 158 };
 159 void subsys_dev_iter_init(struct subsys_dev_iter *iter,
 160                          struct bus_type *subsys,
 161                          struct device *start,
 162                          const struct device_type *type);
 163 struct device *subsys_dev_iter_next(struct subsys_dev_iter *iter);
 164 void subsys_dev_iter_exit(struct subsys_dev_iter *iter);
 165
 166 int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
 167                      int (*fn)(struct device *dev, void *data));
 168 struct device *bus_find_device(struct bus_type *bus, struct device *start,
 169                                void *data,
 170                                int (*match)(struct device *dev, void *data));
 171 struct device *bus_find_device_by_name(struct bus_type *bus,
 172                                        struct device *start,
 173                                        const char *name);
 174 struct device *subsys_find_device_by_id(struct bus_type *bus, unsigned int id,
 175                                         struct device *hint);
 176 int bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
 177                      void *data, int (*fn)(struct device_driver *, void *));
 178 void bus_sort_breadthfirst(struct bus_type *bus,
 179                            int (*compare)(const struct device *a,
 180                                           const struct device *b));
 181 /*
 182  * Bus notifiers: Get notified of addition/removal of devices
 183  * and binding/unbinding of drivers to devices.
 184  * In the long run, it should be a replacement for the platform
 185  * notify hooks.
 186  */
 187 struct notifier_block;
 188
 189 extern int bus_register_notifier(struct bus_type *bus,
 190                                  struct notifier_block *nb);
 191 extern int bus_unregister_notifier(struct bus_type *bus,
 192                                    struct notifier_block *nb);
 193
 194 /* All 4 notifers below get called with the target struct device *
 195  * as an argument. Note that those functions are likely to be called
 196  * with the device lock held in the core, so be careful.
 197  */
 198 #define BUS_NOTIFY_ADD_DEVICE           0x00000001 /* device added */
 199 #define BUS_NOTIFY_DEL_DEVICE           0x00000002 /* device to be removed */
 200 #define BUS_NOTIFY_REMOVED_DEVICE       0x00000003 /* device removed */
 201 #define BUS_NOTIFY_BIND_DRIVER          0x00000004 /* driver about to be
 202                                                       bound */
 203 #define BUS_NOTIFY_BOUND_DRIVER         0x00000005 /* driver bound to device */
 204 #define BUS_NOTIFY_UNBIND_DRIVER        0x00000006 /* driver about to be
 205                                                       unbound */
 206 #define BUS_NOTIFY_UNBOUND_DRIVER       0x00000007 /* driver is unbound
 207                                                       from the device */
 208 #define BUS_NOTIFY_DRIVER_NOT_BOUND     0x00000008 /* driver fails to be bound */
 209
 210 extern struct kset *bus_get_kset(struct bus_type *bus);
 211 extern struct klist *bus_get_device_klist(struct bus_type *bus);
 212
 213 /**
 214  * enum probe_type - device driver probe type to try
 215  *      Device drivers may opt in for special handling of their
 216  *      respective probe routines. This tells the core what to
 217  *      expect and prefer.
 218  *
 219  * @PROBE_DEFAULT_STRATEGY: Used by drivers that work equally well
 220  *      whether probed synchronously or asynchronously.
 221  * @PROBE_PREFER_ASYNCHRONOUS: Drivers for "slow" devices which
 222  *      probing order is not essential for booting the system may
 223  *      opt into executing their probes asynchronously.
 224  * @PROBE_FORCE_SYNCHRONOUS: Use this to annotate drivers that need
 225  *      their probe routines to run synchronously with driver and
 226  *      device registration (with the exception of -EPROBE_DEFER
 227  *      handling - re-probing always ends up being done asynchronously).
 228  *
 229  * Note that the end goal is to switch the kernel to use asynchronous
 230  * probing by default, so annotating drivers with
 231  * %PROBE_PREFER_ASYNCHRONOUS is a temporary measure that allows us
 232  * to speed up boot process while we are validating the rest of the
 233  * drivers.
 234  */
 235 enum probe_type {
 236         PROBE_DEFAULT_STRATEGY,
 237         PROBE_PREFER_ASYNCHRONOUS,
 238         PROBE_FORCE_SYNCHRONOUS,
 239 };
 240
 241 /**
 242  * struct device_driver - The basic device driver structure
 243  * @name:       Name of the device driver.
 244  * @bus:        The bus which the device of this driver belongs to.
 245  * @owner:      The module owner.
 246  * @mod_name:   Used for built-in modules.
 247  * @suppress_bind_attrs: Disables bind/unbind via sysfs.
 248  * @probe_type: Type of the probe (synchronous or asynchronous) to use.
 249  * @of_match_table: The open firmware table.
 250  * @acpi_match_table: The ACPI match table.
 251  * @probe:      Called to query the existence of a specific device,
 252  *              whether this driver can work with it, and bind the driver
 253  *              to a specific device.
 254  * @remove:     Called when the device is removed from the system to
 255  *              unbind a device from this driver.
 256  * @shutdown:   Called at shut-down time to quiesce the device.
 257  * @suspend:    Called to put the device to sleep mode. Usually to a
 258  *              low power state.
 259  * @resume:     Called to bring a device from sleep mode.
 260  * @groups:     Default attributes that get created by the driver core
 261  *              automatically.
 262  * @pm:         Power management operations of the device which matched
 263  *              this driver.
 264  * @coredump:   Called when sysfs entry is written to. The device driver
 265  *              is expected to call the dev_coredump API resulting in a
 266  *              uevent.
 267  * @p:          Driver core's private data, no one other than the driver
 268  *              core can touch this.
 269  *
 270  * The device driver-model tracks all of the drivers known to the system.
 271  * The main reason for this tracking is to enable the driver core to match
 272  * up drivers with new devices. Once drivers are known objects within the
 273  * system, however, a number of other things become possible. Device drivers
 274  * can export information and configuration variables that are independent
 275  * of any specific device.
 276  */
 277 struct device_driver {
 278         const char              *name;
 279         struct bus_type         *bus;
 280
 281         struct module           *owner;
 282         const char              *mod_name;      /* used for built-in modules */
 283
 284         bool suppress_bind_attrs;       /* disables bind/unbind via sysfs */
 285         enum probe_type probe_type;
 286
 287         const struct of_device_id       *of_match_table;
 288         const struct acpi_device_id     *acpi_match_table;
 289
 290         int (*probe) (struct device *dev);
 291         int (*remove) (struct device *dev);
 292         void (*shutdown) (struct device *dev);
 293         int (*suspend) (struct device *dev, pm_message_t state);
 294         int (*resume) (struct device *dev);
 295         const struct attribute_group **groups;
 296
 297         const struct dev_pm_ops *pm;
 298         void (*coredump) (struct device *dev);
 299
 300         struct driver_private *p;
 301 };
 302
 303
 304 extern int __must_check driver_register(struct device_driver *drv);
 305 extern void driver_unregister(struct device_driver *drv);
 306
 307 extern struct device_driver *driver_find(const char *name,
 308                                          struct bus_type *bus);
 309 extern int driver_probe_done(void);
 310 extern void wait_for_device_probe(void);
 311
 312 /* sysfs interface for exporting driver attributes */
 313
 314 struct driver_attribute {
 315         struct attribute attr;
 316         ssize_t (*show)(struct device_driver *driver, char *buf);
 317         ssize_t (*store)(struct device_driver *driver, const char *buf,
 318                          size_t count);
 319 };
 320
 321 #define DRIVER_ATTR_RW(_name) \
 322         struct driver_attribute driver_attr_##_name = __ATTR_RW(_name)
 323 #define DRIVER_ATTR_RO(_name) \
 324         struct driver_attribute driver_attr_##_name = __ATTR_RO(_name)
 325 #define DRIVER_ATTR_WO(_name) \
 326         struct driver_attribute driver_attr_##_name = __ATTR_WO(_name)
 327
 328 extern int __must_check driver_create_file(struct device_driver *driver,
 329                                         const struct driver_attribute *attr);
 330 extern void driver_remove_file(struct device_driver *driver,
 331                                const struct driver_attribute *attr);
 332
 333 extern int __must_check driver_for_each_device(struct device_driver *drv,
 334                                                struct device *start,
 335                                                void *data,
 336                                                int (*fn)(struct device *dev,
 337                                                          void *));
 338 struct device *driver_find_device(struct device_driver *drv,
 339                                   struct device *start, void *data,
 340                                   int (*match)(struct device *dev, void *data));
 341
 342 int driver_deferred_probe_check_state(struct device *dev);
 343
 344 /**
 345  * struct subsys_interface - interfaces to device functions
 346  * @name:       name of the device function
 347  * @subsys:     subsytem of the devices to attach to
 348  * @node:       the list of functions registered at the subsystem
 349  * @add_dev:    device hookup to device function handler
 350  * @remove_dev: device hookup to device function handler
 351  *
 352  * Simple interfaces attached to a subsystem. Multiple interfaces can
 353  * attach to a subsystem and its devices. Unlike drivers, they do not
 354  * exclusively claim or control devices. Interfaces usually represent
 355  * a specific functionality of a subsystem/class of devices.
 356  */
 357 struct subsys_interface {
 358         const char *name;
 359         struct bus_type *subsys;
 360         struct list_head node;
 361         int (*add_dev)(struct device *dev, struct subsys_interface *sif);
 362         void (*remove_dev)(struct device *dev, struct subsys_interface *sif);
 363 };
 364
 365 int subsys_interface_register(struct subsys_interface *sif);
 366 void subsys_interface_unregister(struct subsys_interface *sif);
 367
 368 int subsys_system_register(struct bus_type *subsys,
 369                            const struct attribute_group **groups);
 370 int subsys_virtual_register(struct bus_type *subsys,
 371                             const struct attribute_group **groups);
 372
 373 /**
 374  * struct class - device classes
 375  * @name:       Name of the class.
 376  * @owner:      The module owner.
 377  * @class_groups: Default attributes of this class.
 378  * @dev_groups: Default attributes of the devices that belong to the class.
 379  * @dev_kobj:   The kobject that represents this class and links it into the hierarchy.
 380  * @dev_uevent: Called when a device is added, removed from this class, or a
 381  *              few other things that generate uevents to add the environment
 382  *              variables.
 383  * @devnode:    Callback to provide the devtmpfs.
 384  * @class_release: Called to release this class.
 385  * @dev_release: Called to release the device.
 386  * @shutdown_pre: Called at shut-down time before driver shutdown.
 387  * @ns_type:    Callbacks so sysfs can detemine namespaces.
 388  * @namespace:  Namespace of the device belongs to this class.
 389  * @get_ownership: Allows class to specify uid/gid of the sysfs directories
 390  *              for the devices belonging to the class. Usually tied to
 391  *              device's namespace.
 392  * @pm:         The default device power management operations of this class.
 393  * @p:          The private data of the driver core, no one other than the
 394  *              driver core can touch this.
 395  *
 396  * A class is a higher-level view of a device that abstracts out low-level
 397  * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
 398  * at the class level, they are all simply disks. Classes allow user space
 399  * to work with devices based on what they do, rather than how they are
 400  * connected or how they work.
 401  */
 402 struct class {
 403         const char              *name;
 404         struct module           *owner;
 405
 406         const struct attribute_group    **class_groups;
 407         const struct attribute_group    **dev_groups;
 408         struct kobject                  *dev_kobj;
 409
 410         int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
 411         char *(*devnode)(struct device *dev, umode_t *mode);
 412
 413         void (*class_release)(struct class *class);
 414         void (*dev_release)(struct device *dev);
 415
 416         int (*shutdown_pre)(struct device *dev);
 417
 418         const struct kobj_ns_type_operations *ns_type;
 419         const void *(*namespace)(struct device *dev);
 420
 421         void (*get_ownership)(struct device *dev, kuid_t *uid, kgid_t *gid);
 422
 423         const struct dev_pm_ops *pm;
 424
 425         struct subsys_private *p;
 426 };
 427
 428 struct class_dev_iter {
 429         struct klist_iter               ki;
 430         const struct device_type        *type;
 431 };
 432
 433 extern struct kobject *sysfs_dev_block_kobj;
 434 extern struct kobject *sysfs_dev_char_kobj;
 435 extern int __must_check __class_register(struct class *class,
 436                                          struct lock_class_key *key);
 437 extern void class_unregister(struct class *class);
 438
 439 /* This is a #define to keep the compiler from merging different
 440  * instances of the __key variable */
 441 #define class_register(class)                   \
 442 ({                                              \
 443         static struct lock_class_key __key;     \
 444         __class_register(class, &__key);        \
 445 })
 446
 447 struct class_compat;
 448 struct class_compat *class_compat_register(const char *name);
 449 void class_compat_unregister(struct class_compat *cls);
 450 int class_compat_create_link(struct class_compat *cls, struct device *dev,
 451                              struct device *device_link);
 452 void class_compat_remove_link(struct class_compat *cls, struct device *dev,
 453                               struct device *device_link);
 454
 455 extern void class_dev_iter_init(struct class_dev_iter *iter,
 456                                 struct class *class,
 457                                 struct device *start,
 458                                 const struct device_type *type);
 459 extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
 460 extern void class_dev_iter_exit(struct class_dev_iter *iter);
 461
 462 extern int class_for_each_device(struct class *class, struct device *start,
 463                                  void *data,
 464                                  int (*fn)(struct device *dev, void *data));
 465 extern struct device *class_find_device(struct class *class,
 466                                         struct device *start, const void *data,
 467                                         int (*match)(struct device *, const void *));
 468
 469 struct class_attribute {
 470         struct attribute attr;
 471         ssize_t (*show)(struct class *class, struct class_attribute *attr,
 472                         char *buf);
 473         ssize_t (*store)(struct class *class, struct class_attribute *attr,
 474                         const char *buf, size_t count);
 475 };
 476
 477 #define CLASS_ATTR_RW(_name) \
 478         struct class_attribute class_attr_##_name = __ATTR_RW(_name)
 479 #define CLASS_ATTR_RO(_name) \
 480         struct class_attribute class_attr_##_name = __ATTR_RO(_name)
 481 #define CLASS_ATTR_WO(_name) \
 482         struct class_attribute class_attr_##_name = __ATTR_WO(_name)
 483
 484 extern int __must_check class_create_file_ns(struct class *class,
 485                                              const struct class_attribute *attr,
 486                                              const void *ns);
 487 extern void class_remove_file_ns(struct class *class,
 488                                  const struct class_attribute *attr,
 489                                  const void *ns);
 490
 491 static inline int __must_check class_create_file(struct class *class,
 492                                         const struct class_attribute *attr)
 493 {
 494         return class_create_file_ns(class, attr, NULL);
 495 }
 496
 497 static inline void class_remove_file(struct class *class,
 498                                      const struct class_attribute *attr)
 499 {
 500         return class_remove_file_ns(class, attr, NULL);
 501 }
 502
 503 /* Simple class attribute that is just a static string */
 504 struct class_attribute_string {
 505         struct class_attribute attr;
 506         char *str;
 507 };
 508
 509 /* Currently read-only only */
 510 #define _CLASS_ATTR_STRING(_name, _mode, _str) \
 511         { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
 512 #define CLASS_ATTR_STRING(_name, _mode, _str) \
 513         struct class_attribute_string class_attr_##_name = \
 514                 _CLASS_ATTR_STRING(_name, _mode, _str)
 515
 516 extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr,
 517                         char *buf);
 518
 519 struct class_interface {
 520         struct list_head        node;
 521         struct class            *class;
 522
 523         int (*add_dev)          (struct device *, struct class_interface *);
 524         void (*remove_dev)      (struct device *, struct class_interface *);
 525 };
 526
 527 extern int __must_check class_interface_register(struct class_interface *);
 528 extern void class_interface_unregister(struct class_interface *);
 529
 530 extern struct class * __must_check __class_create(struct module *owner,
 531                                                   const char *name,
 532                                                   struct lock_class_key *key);
 533 extern void class_destroy(struct class *cls);
 534
 535 /* This is a #define to keep the compiler from merging different
 536  * instances of the __key variable */
 537 #define class_create(owner, name)               \
 538 ({                                              \
 539         static struct lock_class_key __key;     \
 540         __class_create(owner, name, &__key);    \
 541 })
 542
 543 /*
 544  * The type of device, "struct device" is embedded in. A class
 545  * or bus can contain devices of different types
 546  * like "partitions" and "disks", "mouse" and "event".
 547  * This identifies the device type and carries type-specific
 548  * information, equivalent to the kobj_type of a kobject.
 549  * If "name" is specified, the uevent will contain it in
 550  * the DEVTYPE variable.
 551  */
 552 struct device_type {
 553         const char *name;
 554         const struct attribute_group **groups;
 555         int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
 556         char *(*devnode)(struct device *dev, umode_t *mode,
 557                          kuid_t *uid, kgid_t *gid);
 558         void (*release)(struct device *dev);
 559
 560         const struct dev_pm_ops *pm;
 561 };
 562
 563 /* interface for exporting device attributes */
 564 struct device_attribute {
 565         struct attribute        attr;
 566         ssize_t (*show)(struct device *dev, struct device_attribute *attr,
 567                         char *buf);
 568         ssize_t (*store)(struct device *dev, struct device_attribute *attr,
 569                          const char *buf, size_t count);
 570 };
 571
 572 struct dev_ext_attribute {
 573         struct device_attribute attr;
 574         void *var;
 575 };
 576
 577 ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
 578                           char *buf);
 579 ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
 580                            const char *buf, size_t count);
 581 ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
 582                         char *buf);
 583 ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
 584                          const char *buf, size_t count);
 585 ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
 586                         char *buf);
 587 ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
 588                          const char *buf, size_t count);
 589
 590 #define DEVICE_ATTR(_name, _mode, _show, _store) \
 591         struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
 592 #define DEVICE_ATTR_PREALLOC(_name, _mode, _show, _store) \
 593         struct device_attribute dev_attr_##_name = \
 594                 __ATTR_PREALLOC(_name, _mode, _show, _store)
 595 #define DEVICE_ATTR_RW(_name) \
 596         struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
 597 #define DEVICE_ATTR_RO(_name) \
 598         struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
 599 #define DEVICE_ATTR_WO(_name) \
 600         struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
 601 #define DEVICE_ULONG_ATTR(_name, _mode, _var) \
 602         struct dev_ext_attribute dev_attr_##_name = \
 603                 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
 604 #define DEVICE_INT_ATTR(_name, _mode, _var) \
 605         struct dev_ext_attribute dev_attr_##_name = \
 606                 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
 607 #define DEVICE_BOOL_ATTR(_name, _mode, _var) \
 608         struct dev_ext_attribute dev_attr_##_name = \
 609                 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
 610 #define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
 611         struct device_attribute dev_attr_##_name =              \
 612                 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
 613
 614 extern int device_create_file(struct device *device,
 615                               const struct device_attribute *entry);
 616 extern void device_remove_file(struct device *dev,
 617                                const struct device_attribute *attr);
 618 extern bool device_remove_file_self(struct device *dev,
 619                                     const struct device_attribute *attr);
 620 extern int __must_check device_create_bin_file(struct device *dev,
 621                                         const struct bin_attribute *attr);
 622 extern void device_remove_bin_file(struct device *dev,
 623                                    const struct bin_attribute *attr);
 624
 625 /* device resource management */
 626 typedef void (*dr_release_t)(struct device *dev, void *res);
 627 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
 628
 629 #ifdef CONFIG_DEBUG_DEVRES
 630 extern void *__devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
 631                                  int nid, const char *name) __malloc;
 632 #define devres_alloc(release, size, gfp) \
 633         __devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release)
 634 #define devres_alloc_node(release, size, gfp, nid) \
 635         __devres_alloc_node(release, size, gfp, nid, #release)
 636 #else
 637 extern void *devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
 638                                int nid) __malloc;
 639 static inline void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp)
 640 {
 641         return devres_alloc_node(release, size, gfp, NUMA_NO_NODE);
 642 }
 643 #endif
 644
 645 extern void devres_for_each_res(struct device *dev, dr_release_t release,
 646                                 dr_match_t match, void *match_data,
 647                                 void (*fn)(struct device *, void *, void *),
 648                                 void *data);
 649 extern void devres_free(void *res);
 650 extern void devres_add(struct device *dev, void *res);
 651 extern void *devres_find(struct device *dev, dr_release_t release,
 652                          dr_match_t match, void *match_data);
 653 extern void *devres_get(struct device *dev, void *new_res,
 654                         dr_match_t match, void *match_data);
 655 extern void *devres_remove(struct device *dev, dr_release_t release,
 656                            dr_match_t match, void *match_data);
 657 extern int devres_destroy(struct device *dev, dr_release_t release,
 658                           dr_match_t match, void *match_data);
 659 extern int devres_release(struct device *dev, dr_release_t release,
 660                           dr_match_t match, void *match_data);
 661
 662 /* devres group */
 663 extern void * __must_check devres_open_group(struct device *dev, void *id,
 664                                              gfp_t gfp);
 665 extern void devres_close_group(struct device *dev, void *id);
 666 extern void devres_remove_group(struct device *dev, void *id);
 667 extern int devres_release_group(struct device *dev, void *id);
 668
 669 /* managed devm_k.alloc/kfree for device drivers */
 670 extern void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp) __malloc;
 671 extern __printf(3, 0)
 672 char *devm_kvasprintf(struct device *dev, gfp_t gfp, const char *fmt,
 673                       va_list ap) __malloc;
 674 extern __printf(3, 4)
 675 char *devm_kasprintf(struct device *dev, gfp_t gfp, const char *fmt, ...) __malloc;
 676 static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp)
 677 {
 678         return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
 679 }
 680 static inline void *devm_kmalloc_array(struct device *dev,
 681                                        size_t n, size_t size, gfp_t flags)
 682 {
 683         size_t bytes;
 684
 685         if (unlikely(check_mul_overflow(n, size, &bytes)))
 686                 return NULL;
 687
 688         return devm_kmalloc(dev, bytes, flags);
 689 }
 690 static inline void *devm_kcalloc(struct device *dev,
 691                                  size_t n, size_t size, gfp_t flags)
 692 {
 693         return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
 694 }
 695 extern void devm_kfree(struct device *dev, void *p);
 696 extern char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp) __malloc;
 697 extern void *devm_kmemdup(struct device *dev, const void *src, size_t len,
 698                           gfp_t gfp);
 699
 700 extern unsigned long devm_get_free_pages(struct device *dev,
 701                                          gfp_t gfp_mask, unsigned int order);
 702 extern void devm_free_pages(struct device *dev, unsigned long addr);
 703
 704 void __iomem *devm_ioremap_resource(struct device *dev, struct resource *res);
 705
 706 void __iomem *devm_of_iomap(struct device *dev,
 707                             struct device_node *node, int index,
 708                             resource_size_t *size);
 709
 710 /* allows to add/remove a custom action to devres stack */
 711 int devm_add_action(struct device *dev, void (*action)(void *), void *data);
 712 void devm_remove_action(struct device *dev, void (*action)(void *), void *data);
 713
 714 static inline int devm_add_action_or_reset(struct device *dev,
 715                                            void (*action)(void *), void *data)
 716 {
 717         int ret;
 718
 719         ret = devm_add_action(dev, action, data);
 720         if (ret)
 721                 action(data);
 722
 723         return ret;
 724 }
 725
 726 /**
 727  * devm_alloc_percpu - Resource-managed alloc_percpu
 728  * @dev: Device to allocate per-cpu memory for
 729  * @type: Type to allocate per-cpu memory for
 730  *
 731  * Managed alloc_percpu. Per-cpu memory allocated with this function is
 732  * automatically freed on driver detach.
 733  *
 734  * RETURNS:
 735  * Pointer to allocated memory on success, NULL on failure.
 736  */
 737 #define devm_alloc_percpu(dev, type)      \
 738         ((typeof(type) __percpu *)__devm_alloc_percpu((dev), sizeof(type), \
 739                                                       __alignof__(type)))
 740
 741 void __percpu *__devm_alloc_percpu(struct device *dev, size_t size,
 742                                    size_t align);
 743 void devm_free_percpu(struct device *dev, void __percpu *pdata);
 744
 745 struct device_dma_parameters {
 746         /*
 747          * a low level driver may set these to teach IOMMU code about
 748          * sg limitations.
 749          */
 750         unsigned int max_segment_size;
 751         unsigned long segment_boundary_mask;
 752 };
 753
 754 /**
 755  * struct device_connection - Device Connection Descriptor
 756  * @endpoint: The names of the two devices connected together
 757  * @id: Unique identifier for the connection
 758  * @list: List head, private, for internal use only
 759  */
 760 struct device_connection {
 761         const char              *endpoint[2];
 762         const char              *id;
 763         struct list_head        list;
 764 };
 765
 766 void *device_connection_find_match(struct device *dev, const char *con_id,
 767                                 void *data,
 768                                 void *(*match)(struct device_connection *con,
 769                                                int ep, void *data));
 770
 771 struct device *device_connection_find(struct device *dev, const char *con_id);
 772
 773 void device_connection_add(struct device_connection *con);
 774 void device_connection_remove(struct device_connection *con);
 775
 776 /**
 777  * enum device_link_state - Device link states.
 778  * @DL_STATE_NONE: The presence of the drivers is not being tracked.
 779  * @DL_STATE_DORMANT: None of the supplier/consumer drivers is present.
 780  * @DL_STATE_AVAILABLE: The supplier driver is present, but the consumer is not.
 781  * @DL_STATE_CONSUMER_PROBE: The consumer is probing (supplier driver present).
 782  * @DL_STATE_ACTIVE: Both the supplier and consumer drivers are present.
 783  * @DL_STATE_SUPPLIER_UNBIND: The supplier driver is unbinding.
 784  */
 785 enum device_link_state {
 786         DL_STATE_NONE = -1,
 787         DL_STATE_DORMANT = 0,
 788         DL_STATE_AVAILABLE,
 789         DL_STATE_CONSUMER_PROBE,
 790         DL_STATE_ACTIVE,
 791         DL_STATE_SUPPLIER_UNBIND,
 792 };
 793
 794 /*
 795  * Device link flags.
 796  *
 797  * STATELESS: The core won't track the presence of supplier/consumer drivers.
 798  * AUTOREMOVE_CONSUMER: Remove the link automatically on consumer driver unbind.
 799  * PM_RUNTIME: If set, the runtime PM framework will use this link.
 800  * RPM_ACTIVE: Run pm_runtime_get_sync() on the supplier during link creation.
 801  * AUTOREMOVE_SUPPLIER: Remove the link automatically on supplier driver unbind.
 802  */
 803 #define DL_FLAG_STATELESS               BIT(0)
 804 #define DL_FLAG_AUTOREMOVE_CONSUMER     BIT(1)
 805 #define DL_FLAG_PM_RUNTIME              BIT(2)
 806 #define DL_FLAG_RPM_ACTIVE              BIT(3)
 807 #define DL_FLAG_AUTOREMOVE_SUPPLIER     BIT(4)
 808
 809 /**
 810  * struct device_link - Device link representation.
 811  * @supplier: The device on the supplier end of the link.
 812  * @s_node: Hook to the supplier device's list of links to consumers.
 813  * @consumer: The device on the consumer end of the link.
 814  * @c_node: Hook to the consumer device's list of links to suppliers.
 815  * @status: The state of the link (with respect to the presence of drivers).
 816  * @flags: Link flags.
 817  * @rpm_active: Whether or not the consumer device is runtime-PM-active.
 818  * @kref: Count repeated addition of the same link.
 819  * @rcu_head: An RCU head to use for deferred execution of SRCU callbacks.
 820  */
 821 struct device_link {
 822         struct device *supplier;
 823         struct list_head s_node;
 824         struct device *consumer;
 825         struct list_head c_node;
 826         enum device_link_state status;
 827         u32 flags;
 828         bool rpm_active;
 829         struct kref kref;
 830 #ifdef CONFIG_SRCU
 831         struct rcu_head rcu_head;
 832 #endif
 833 };
 834
 835 /**
 836  * enum dl_dev_state - Device driver presence tracking information.
 837  * @DL_DEV_NO_DRIVER: There is no driver attached to the device.
 838  * @DL_DEV_PROBING: A driver is probing.
 839  * @DL_DEV_DRIVER_BOUND: The driver has been bound to the device.
 840  * @DL_DEV_UNBINDING: The driver is unbinding from the device.
 841  */
 842 enum dl_dev_state {
 843         DL_DEV_NO_DRIVER = 0,
 844         DL_DEV_PROBING,
 845         DL_DEV_DRIVER_BOUND,
 846         DL_DEV_UNBINDING,
 847 };
 848
 849 /**
 850  * struct dev_links_info - Device data related to device links.
 851  * @suppliers: List of links to supplier devices.
 852  * @consumers: List of links to consumer devices.
 853  * @status: Driver status information.
 854  */
 855 struct dev_links_info {
 856         struct list_head suppliers;
 857         struct list_head consumers;
 858         enum dl_dev_state status;
 859 };
 860
 861 /**
 862  * struct device - The basic device structure
 863  * @parent:     The device's "parent" device, the device to which it is attached.
 864  *              In most cases, a parent device is some sort of bus or host
 865  *              controller. If parent is NULL, the device, is a top-level device,
 866  *              which is not usually what you want.
 867  * @p:          Holds the private data of the driver core portions of the device.
 868  *              See the comment of the struct device_private for detail.
 869  * @kobj:       A top-level, abstract class from which other classes are derived.
 870  * @init_name:  Initial name of the device.
 871  * @type:       The type of device.
 872  *              This identifies the device type and carries type-specific
 873  *              information.
 874  * @mutex:      Mutex to synchronize calls to its driver.
 875  * @bus:        Type of bus device is on.
 876  * @driver:     Which driver has allocated this
 877  * @platform_data: Platform data specific to the device.
 878  *              Example: For devices on custom boards, as typical of embedded
 879  *              and SOC based hardware, Linux often uses platform_data to point
 880  *              to board-specific structures describing devices and how they
 881  *              are wired.  That can include what ports are available, chip
 882  *              variants, which GPIO pins act in what additional roles, and so
 883  *              on.  This shrinks the "Board Support Packages" (BSPs) and
 884  *              minimizes board-specific #ifdefs in drivers.
 885  * @driver_data: Private pointer for driver specific info.
 886  * @links:      Links to suppliers and consumers of this device.
 887  * @power:      For device power management.
 888  *              See Documentation/driver-api/pm/devices.rst for details.
 889  * @pm_domain:  Provide callbacks that are executed during system suspend,
 890  *              hibernation, system resume and during runtime PM transitions
 891  *              along with subsystem-level and driver-level callbacks.
 892  * @pins:       For device pin management.
 893  *              See Documentation/driver-api/pinctl.rst for details.
 894  * @msi_list:   Hosts MSI descriptors
 895  * @msi_domain: The generic MSI domain this device is using.
 896  * @numa_node:  NUMA node this device is close to.
 897  * @dma_ops:    DMA mapping operations for this device.
 898  * @dma_mask:   Dma mask (if dma'ble device).
 899  * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
 900  *              hardware supports 64-bit addresses for consistent allocations
 901  *              such descriptors.
 902  * @bus_dma_mask: Mask of an upstream bridge or bus which imposes a smaller DMA
 903  *              limit than the device itself supports.
 904  * @dma_pfn_offset: offset of DMA memory range relatively of RAM
 905  * @dma_parms:  A low level driver may set these to teach IOMMU code about
 906  *              segment limitations.
 907  * @dma_pools:  Dma pools (if dma'ble device).
 908  * @dma_mem:    Internal for coherent mem override.
 909  * @cma_area:   Contiguous memory area for dma allocations
 910  * @archdata:   For arch-specific additions.
 911  * @of_node:    Associated device tree node.
 912  * @fwnode:     Associated device node supplied by platform firmware.
 913  * @devt:       For creating the sysfs "dev".
 914  * @id:         device instance
 915  * @devres_lock: Spinlock to protect the resource of the device.
 916  * @devres_head: The resources list of the device.
 917  * @knode_class: The node used to add the device to the class list.
 918  * @class:      The class of the device.
 919  * @groups:     Optional attribute groups.
 920  * @release:    Callback to free the device after all references have
 921  *              gone away. This should be set by the allocator of the
 922  *              device (i.e. the bus driver that discovered the device).
 923  * @iommu_group: IOMMU group the device belongs to.
 924  * @iommu_fwspec: IOMMU-specific properties supplied by firmware.
 925  *
 926  * @offline_disabled: If set, the device is permanently online.
 927  * @offline:    Set after successful invocation of bus type's .offline().
 928  * @of_node_reused: Set if the device-tree node is shared with an ancestor
 929  *              device.
 930  * @dma_coherent: this particular device is dma coherent, even if the
 931  *              architecture supports non-coherent devices.
 932  *
 933  * At the lowest level, every device in a Linux system is represented by an
 934  * instance of struct device. The device structure contains the information
 935  * that the device model core needs to model the system. Most subsystems,
 936  * however, track additional information about the devices they host. As a
 937  * result, it is rare for devices to be represented by bare device structures;
 938  * instead, that structure, like kobject structures, is usually embedded within
 939  * a higher-level representation of the device.
 940  */
 941 struct device {
 942         struct device           *parent;
 943
 944         struct device_private   *p;
 945
 946         struct kobject kobj;
 947         const char              *init_name; /* initial name of the device */
 948         const struct device_type *type;
 949
 950         struct mutex            mutex;  /* mutex to synchronize calls to
 951                                          * its driver.
 952                                          */
 953
 954         struct bus_type *bus;           /* type of bus device is on */
 955         struct device_driver *driver;   /* which driver has allocated this
 956                                            device */
 957         void            *platform_data; /* Platform specific data, device
 958                                            core doesn't touch it */
 959         void            *driver_data;   /* Driver data, set and get with
 960                                            dev_set/get_drvdata */
 961         struct dev_links_info   links;
 962         struct dev_pm_info      power;
 963         struct dev_pm_domain    *pm_domain;
 964
 965 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
 966         struct irq_domain       *msi_domain;
 967 #endif
 968 #ifdef CONFIG_PINCTRL
 969         struct dev_pin_info     *pins;
 970 #endif
 971 #ifdef CONFIG_GENERIC_MSI_IRQ
 972         struct list_head        msi_list;
 973 #endif
 974
 975 #ifdef CONFIG_NUMA
 976         int             numa_node;      /* NUMA node this device is close to */
 977 #endif
 978         const struct dma_map_ops *dma_ops;
 979         u64             *dma_mask;      /* dma mask (if dma'able device) */
 980         u64             coherent_dma_mask;/* Like dma_mask, but for
 981                                              alloc_coherent mappings as
 982                                              not all hardware supports
 983                                              64 bit addresses for consistent
 984                                              allocations such descriptors. */
 985         u64             bus_dma_mask;   /* upstream dma_mask constraint */
 986         unsigned long   dma_pfn_offset;
 987
 988         struct device_dma_parameters *dma_parms;
 989
 990         struct list_head        dma_pools;      /* dma pools (if dma'ble) */
 991
 992         struct dma_coherent_mem *dma_mem; /* internal for coherent mem
 993                                              override */
 994 #ifdef CONFIG_DMA_CMA
 995         struct cma *cma_area;           /* contiguous memory area for dma
 996                                            allocations */
 997 #endif
 998         /* arch specific additions */
 999         struct dev_archdata     archdata;
1000
1001         struct device_node      *of_node; /* associated device tree node */
1002         struct fwnode_handle    *fwnode; /* firmware device node */
1003
1004         dev_t                   devt;   /* dev_t, creates the sysfs "dev" */
1005         u32                     id;     /* device instance */
1006
1007         spinlock_t              devres_lock;
1008         struct list_head        devres_head;
1009
1010         struct klist_node       knode_class;
1011         struct class            *class;
1012         const struct attribute_group **groups;  /* optional groups */
1013
1014         void    (*release)(struct device *dev);
1015         struct iommu_group      *iommu_group;
1016         struct iommu_fwspec     *iommu_fwspec;
1017
1018         bool                    offline_disabled:1;
1019         bool                    offline:1;
1020         bool                    of_node_reused:1;
1021 #if defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_DEVICE) || \
1022     defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU) || \
1023     defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU_ALL)
1024         bool                    dma_coherent:1;
1025 #endif
1026 };
1027
1028 static inline struct device *kobj_to_dev(struct kobject *kobj)
1029 {
1030         return container_of(kobj, struct device, kobj);
1031 }
1032
1033 /* Get the wakeup routines, which depend on struct device */
1034 #include <linux/pm_wakeup.h>
1035
1036 static inline const char *dev_name(const struct device *dev)
1037 {
1038         /* Use the init name until the kobject becomes available */
1039         if (dev->init_name)
1040                 return dev->init_name;
1041
1042         return kobject_name(&dev->kobj);
1043 }
1044
1045 extern __printf(2, 3)
1046 int dev_set_name(struct device *dev, const char *name, ...);
1047
1048 #ifdef CONFIG_NUMA
1049 static inline int dev_to_node(struct device *dev)
1050 {
1051         return dev->numa_node;
1052 }
1053 static inline void set_dev_node(struct device *dev, int node)
1054 {
1055         dev->numa_node = node;
1056 }
1057 #else
1058 static inline int dev_to_node(struct device *dev)
1059 {
1060         return -1;
1061 }
1062 static inline void set_dev_node(struct device *dev, int node)
1063 {
1064 }
1065 #endif
1066
1067 static inline struct irq_domain *dev_get_msi_domain(const struct device *dev)
1068 {
1069 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
1070         return dev->msi_domain;
1071 #else
1072         return NULL;
1073 #endif
1074 }
1075
1076 static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d)
1077 {
1078 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
1079         dev->msi_domain = d;
1080 #endif
1081 }
1082
1083 static inline void *dev_get_drvdata(const struct device *dev)
1084 {
1085         return dev->driver_data;
1086 }
1087
1088 static inline void dev_set_drvdata(struct device *dev, void *data)
1089 {
1090         dev->driver_data = data;
1091 }
1092
1093 static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
1094 {
1095         return dev ? dev->power.subsys_data : NULL;
1096 }
1097
1098 static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
1099 {
1100         return dev->kobj.uevent_suppress;
1101 }
1102
1103 static inline void dev_set_uevent_suppress(struct device *dev, int val)
1104 {
1105         dev->kobj.uevent_suppress = val;
1106 }
1107
1108 static inline int device_is_registered(struct device *dev)
1109 {
1110         return dev->kobj.state_in_sysfs;
1111 }
1112
1113 static inline void device_enable_async_suspend(struct device *dev)
1114 {
1115         if (!dev->power.is_prepared)
1116                 dev->power.async_suspend = true;
1117 }
1118
1119 static inline void device_disable_async_suspend(struct device *dev)
1120 {
1121         if (!dev->power.is_prepared)
1122                 dev->power.async_suspend = false;
1123 }
1124
1125 static inline bool device_async_suspend_enabled(struct device *dev)
1126 {
1127         return !!dev->power.async_suspend;
1128 }
1129
1130 static inline void dev_pm_syscore_device(struct device *dev, bool val)
1131 {
1132 #ifdef CONFIG_PM_SLEEP
1133         dev->power.syscore = val;
1134 #endif
1135 }
1136
1137 static inline void dev_pm_set_driver_flags(struct device *dev, u32 flags)
1138 {
1139         dev->power.driver_flags = flags;
1140 }
1141
1142 static inline bool dev_pm_test_driver_flags(struct device *dev, u32 flags)
1143 {
1144         return !!(dev->power.driver_flags & flags);
1145 }
1146
1147 static inline void device_lock(struct device *dev)
1148 {
1149         mutex_lock(&dev->mutex);
1150 }
1151
1152 static inline int device_lock_interruptible(struct device *dev)
1153 {
1154         return mutex_lock_interruptible(&dev->mutex);
1155 }
1156
1157 static inline int device_trylock(struct device *dev)
1158 {
1159         return mutex_trylock(&dev->mutex);
1160 }
1161
1162 static inline void device_unlock(struct device *dev)
1163 {
1164         mutex_unlock(&dev->mutex);
1165 }
1166
1167 static inline void device_lock_assert(struct device *dev)
1168 {
1169         lockdep_assert_held(&dev->mutex);
1170 }
1171
1172 static inline struct device_node *dev_of_node(struct device *dev)
1173 {
1174         if (!IS_ENABLED(CONFIG_OF))
1175                 return NULL;
1176         return dev->of_node;
1177 }
1178
1179 void driver_init(void);
1180
1181 /*
1182  * High level routines for use by the bus drivers
1183  */
1184 extern int __must_check device_register(struct device *dev);
1185 extern void device_unregister(struct device *dev);
1186 extern void device_initialize(struct device *dev);
1187 extern int __must_check device_add(struct device *dev);
1188 extern void device_del(struct device *dev);
1189 extern int device_for_each_child(struct device *dev, void *data,
1190                      int (*fn)(struct device *dev, void *data));
1191 extern int device_for_each_child_reverse(struct device *dev, void *data,
1192                      int (*fn)(struct device *dev, void *data));
1193 extern struct device *device_find_child(struct device *dev, void *data,
1194                                 int (*match)(struct device *dev, void *data));
1195 extern int device_rename(struct device *dev, const char *new_name);
1196 extern int device_move(struct device *dev, struct device *new_parent,
1197                        enum dpm_order dpm_order);
1198 extern const char *device_get_devnode(struct device *dev,
1199                                       umode_t *mode, kuid_t *uid, kgid_t *gid,
1200                                       const char **tmp);
1201
1202 static inline bool device_supports_offline(struct device *dev)
1203 {
1204         return dev->bus && dev->bus->offline && dev->bus->online;
1205 }
1206
1207 extern void lock_device_hotplug(void);
1208 extern void unlock_device_hotplug(void);
1209 extern int lock_device_hotplug_sysfs(void);
1210 extern int device_offline(struct device *dev);
1211 extern int device_online(struct device *dev);
1212 extern void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1213 extern void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1214 void device_set_of_node_from_dev(struct device *dev, const struct device *dev2);
1215
1216 static inline int dev_num_vf(struct device *dev)
1217 {
1218         if (dev->bus && dev->bus->num_vf)
1219                 return dev->bus->num_vf(dev);
1220         return 0;
1221 }
1222
1223 /*
1224  * Root device objects for grouping under /sys/devices
1225  */
1226 extern struct device *__root_device_register(const char *name,
1227                                              struct module *owner);
1228
1229 /* This is a macro to avoid include problems with THIS_MODULE */
1230 #define root_device_register(name) \
1231         __root_device_register(name, THIS_MODULE)
1232
1233 extern void root_device_unregister(struct device *root);
1234
1235 static inline void *dev_get_platdata(const struct device *dev)
1236 {
1237         return dev->platform_data;
1238 }
1239
1240 /*
1241  * Manual binding of a device to driver. See drivers/base/bus.c
1242  * for information on use.
1243  */
1244 extern int __must_check device_bind_driver(struct device *dev);
1245 extern void device_release_driver(struct device *dev);
1246 extern int  __must_check device_attach(struct device *dev);
1247 extern int __must_check driver_attach(struct device_driver *drv);
1248 extern void device_initial_probe(struct device *dev);
1249 extern int __must_check device_reprobe(struct device *dev);
1250
1251 extern bool device_is_bound(struct device *dev);
1252
1253 /*
1254  * Easy functions for dynamically creating devices on the fly
1255  */
1256 extern __printf(5, 0)
1257 struct device *device_create_vargs(struct class *cls, struct device *parent,
1258                                    dev_t devt, void *drvdata,
1259                                    const char *fmt, va_list vargs);
1260 extern __printf(5, 6)
1261 struct device *device_create(struct class *cls, struct device *parent,
1262                              dev_t devt, void *drvdata,
1263                              const char *fmt, ...);
1264 extern __printf(6, 7)
1265 struct device *device_create_with_groups(struct class *cls,
1266                              struct device *parent, dev_t devt, void *drvdata,
1267                              const struct attribute_group **groups,
1268                              const char *fmt, ...);
1269 extern void device_destroy(struct class *cls, dev_t devt);
1270
1271 extern int __must_check device_add_groups(struct device *dev,
1272                                         const struct attribute_group **groups);
1273 extern void device_remove_groups(struct device *dev,
1274                                  const struct attribute_group **groups);
1275
1276 static inline int __must_check device_add_group(struct device *dev,
1277                                         const struct attribute_group *grp)
1278 {
1279         const struct attribute_group *groups[] = { grp, NULL };
1280
1281         return device_add_groups(dev, groups);
1282 }
1283
1284 static inline void device_remove_group(struct device *dev,
1285                                        const struct attribute_group *grp)
1286 {
1287         const struct attribute_group *groups[] = { grp, NULL };
1288
1289         return device_remove_groups(dev, groups);
1290 }
1291
1292 extern int __must_check devm_device_add_groups(struct device *dev,
1293                                         const struct attribute_group **groups);
1294 extern void devm_device_remove_groups(struct device *dev,
1295                                       const struct attribute_group **groups);
1296 extern int __must_check devm_device_add_group(struct device *dev,
1297                                         const struct attribute_group *grp);
1298 extern void devm_device_remove_group(struct device *dev,
1299                                      const struct attribute_group *grp);
1300
1301 /*
1302  * Platform "fixup" functions - allow the platform to have their say
1303  * about devices and actions that the general device layer doesn't
1304  * know about.
1305  */
1306 /* Notify platform of device discovery */
1307 extern int (*platform_notify)(struct device *dev);
1308
1309 extern int (*platform_notify_remove)(struct device *dev);
1310
1311
1312 /*
1313  * get_device - atomically increment the reference count for the device.
1314  *
1315  */
1316 extern struct device *get_device(struct device *dev);
1317 extern void put_device(struct device *dev);
1318
1319 #ifdef CONFIG_DEVTMPFS
1320 extern int devtmpfs_create_node(struct device *dev);
1321 extern int devtmpfs_delete_node(struct device *dev);
1322 extern int devtmpfs_mount(const char *mntdir);
1323 #else
1324 static inline int devtmpfs_create_node(struct device *dev) { return 0; }
1325 static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
1326 static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
1327 #endif
1328
1329 /* drivers/base/power/shutdown.c */
1330 extern void device_shutdown(void);
1331
1332 /* debugging and troubleshooting/diagnostic helpers. */
1333 extern const char *dev_driver_string(const struct device *dev);
1334
1335 /* Device links interface. */
1336 struct device_link *device_link_add(struct device *consumer,
1337                                     struct device *supplier, u32 flags);
1338 void device_link_del(struct device_link *link);
1339 void device_link_remove(void *consumer, struct device *supplier);
1340
1341 #ifndef dev_fmt
1342 #define dev_fmt(fmt) fmt
1343 #endif
1344
1345 #ifdef CONFIG_PRINTK
1346
1347 __printf(3, 0)
1348 int dev_vprintk_emit(int level, const struct device *dev,
1349                      const char *fmt, va_list args);
1350 __printf(3, 4)
1351 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...);
1352
1353 __printf(3, 4)
1354 void dev_printk(const char *level, const struct device *dev,
1355                 const char *fmt, ...);
1356 __printf(2, 3)
1357 void _dev_emerg(const struct device *dev, const char *fmt, ...);
1358 __printf(2, 3)
1359 void _dev_alert(const struct device *dev, const char *fmt, ...);
1360 __printf(2, 3)
1361 void _dev_crit(const struct device *dev, const char *fmt, ...);
1362 __printf(2, 3)
1363 void _dev_err(const struct device *dev, const char *fmt, ...);
1364 __printf(2, 3)
1365 void _dev_warn(const struct device *dev, const char *fmt, ...);
1366 __printf(2, 3)
1367 void _dev_notice(const struct device *dev, const char *fmt, ...);
1368 __printf(2, 3)
1369 void _dev_info(const struct device *dev, const char *fmt, ...);
1370
1371 #else
1372
1373 static inline __printf(3, 0)
1374 int dev_vprintk_emit(int level, const struct device *dev,
1375                      const char *fmt, va_list args)
1376 { return 0; }
1377 static inline __printf(3, 4)
1378 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
1379 { return 0; }
1380
1381 static inline void __dev_printk(const char *level, const struct device *dev,
1382                                 struct va_format *vaf)
1383 {}
1384 static inline __printf(3, 4)
1385 void dev_printk(const char *level, const struct device *dev,
1386                  const char *fmt, ...)
1387 {}
1388
1389 static inline __printf(2, 3)
1390 void _dev_emerg(const struct device *dev, const char *fmt, ...)
1391 {}
1392 static inline __printf(2, 3)
1393 void _dev_crit(const struct device *dev, const char *fmt, ...)
1394 {}
1395 static inline __printf(2, 3)
1396 void _dev_alert(const struct device *dev, const char *fmt, ...)
1397 {}
1398 static inline __printf(2, 3)
1399 void _dev_err(const struct device *dev, const char *fmt, ...)
1400 {}
1401 static inline __printf(2, 3)
1402 void _dev_warn(const struct device *dev, const char *fmt, ...)
1403 {}
1404 static inline __printf(2, 3)
1405 void _dev_notice(const struct device *dev, const char *fmt, ...)
1406 {}
1407 static inline __printf(2, 3)
1408 void _dev_info(const struct device *dev, const char *fmt, ...)
1409 {}
1410
1411 #endif
1412
1413 /*
1414  * #defines for all the dev_<level> macros to prefix with whatever
1415  * possible use of #define dev_fmt(fmt) ...
1416  */
1417
1418 #define dev_emerg(dev, fmt, ...)                                        \
1419         _dev_emerg(dev, dev_fmt(fmt), ##__VA_ARGS__)
1420 #define dev_crit(dev, fmt, ...)                                         \
1421         _dev_crit(dev, dev_fmt(fmt), ##__VA_ARGS__)
1422 #define dev_alert(dev, fmt, ...)                                        \
1423         _dev_alert(dev, dev_fmt(fmt), ##__VA_ARGS__)
1424 #define dev_err(dev, fmt, ...)                                          \
1425         _dev_err(dev, dev_fmt(fmt), ##__VA_ARGS__)
1426 #define dev_warn(dev, fmt, ...)                                         \
1427         _dev_warn(dev, dev_fmt(fmt), ##__VA_ARGS__)
1428 #define dev_notice(dev, fmt, ...)                                       \
1429         _dev_notice(dev, dev_fmt(fmt), ##__VA_ARGS__)
1430 #define dev_info(dev, fmt, ...)                                         \
1431         _dev_info(dev, dev_fmt(fmt), ##__VA_ARGS__)
1432
1433 #if defined(CONFIG_DYNAMIC_DEBUG)
1434 #define dev_dbg(dev, fmt, ...)                                          \
1435         dynamic_dev_dbg(dev, dev_fmt(fmt), ##__VA_ARGS__)
1436 #elif defined(DEBUG)
1437 #define dev_dbg(dev, fmt, ...)                                          \
1438         dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__)
1439 #else
1440 #define dev_dbg(dev, fmt, ...)                                          \
1441 ({                                                                      \
1442         if (0)                                                          \
1443                 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \
1444 })
1445 #endif
1446
1447 #ifdef CONFIG_PRINTK
1448 #define dev_level_once(dev_level, dev, fmt, ...)                        \
1449 do {                                                                    \
1450         static bool __print_once __read_mostly;                         \
1451                                                                         \
1452         if (!__print_once) {                                            \
1453                 __print_once = true;                                    \
1454                 dev_level(dev, fmt, ##__VA_ARGS__);                     \
1455         }                                                               \
1456 } while (0)
1457 #else
1458 #define dev_level_once(dev_level, dev, fmt, ...)                        \
1459 do {                                                                    \
1460         if (0)                                                          \
1461                 dev_level(dev, fmt, ##__VA_ARGS__);                     \
1462 } while (0)
1463 #endif
1464
1465 #define dev_emerg_once(dev, fmt, ...)                                   \
1466         dev_level_once(dev_emerg, dev, fmt, ##__VA_ARGS__)
1467 #define dev_alert_once(dev, fmt, ...)                                   \
1468         dev_level_once(dev_alert, dev, fmt, ##__VA_ARGS__)
1469 #define dev_crit_once(dev, fmt, ...)                                    \
1470         dev_level_once(dev_crit, dev, fmt, ##__VA_ARGS__)
1471 #define dev_err_once(dev, fmt, ...)                                     \
1472         dev_level_once(dev_err, dev, fmt, ##__VA_ARGS__)
1473 #define dev_warn_once(dev, fmt, ...)                                    \
1474         dev_level_once(dev_warn, dev, fmt, ##__VA_ARGS__)
1475 #define dev_notice_once(dev, fmt, ...)                                  \
1476         dev_level_once(dev_notice, dev, fmt, ##__VA_ARGS__)
1477 #define dev_info_once(dev, fmt, ...)                                    \
1478         dev_level_once(dev_info, dev, fmt, ##__VA_ARGS__)
1479 #define dev_dbg_once(dev, fmt, ...)                                     \
1480         dev_level_once(dev_dbg, dev, fmt, ##__VA_ARGS__)
1481
1482 #define dev_level_ratelimited(dev_level, dev, fmt, ...)                 \
1483 do {                                                                    \
1484         static DEFINE_RATELIMIT_STATE(_rs,                              \
1485                                       DEFAULT_RATELIMIT_INTERVAL,       \
1486                                       DEFAULT_RATELIMIT_BURST);         \
1487         if (__ratelimit(&_rs))                                          \
1488                 dev_level(dev, fmt, ##__VA_ARGS__);                     \
1489 } while (0)
1490
1491 #define dev_emerg_ratelimited(dev, fmt, ...)                            \
1492         dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
1493 #define dev_alert_ratelimited(dev, fmt, ...)                            \
1494         dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
1495 #define dev_crit_ratelimited(dev, fmt, ...)                             \
1496         dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
1497 #define dev_err_ratelimited(dev, fmt, ...)                              \
1498         dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
1499 #define dev_warn_ratelimited(dev, fmt, ...)                             \
1500         dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
1501 #define dev_notice_ratelimited(dev, fmt, ...)                           \
1502         dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
1503 #define dev_info_ratelimited(dev, fmt, ...)                             \
1504         dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
1505 #if defined(CONFIG_DYNAMIC_DEBUG)
1506 /* descriptor check is first to prevent flooding with "callbacks suppressed" */
1507 #define dev_dbg_ratelimited(dev, fmt, ...)                              \
1508 do {                                                                    \
1509         static DEFINE_RATELIMIT_STATE(_rs,                              \
1510                                       DEFAULT_RATELIMIT_INTERVAL,       \
1511                                       DEFAULT_RATELIMIT_BURST);         \
1512         DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt);                 \
1513         if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) &&        \
1514             __ratelimit(&_rs))                                          \
1515                 __dynamic_dev_dbg(&descriptor, dev, dev_fmt(fmt),       \
1516                                   ##__VA_ARGS__);                       \
1517 } while (0)
1518 #elif defined(DEBUG)
1519 #define dev_dbg_ratelimited(dev, fmt, ...)                              \
1520 do {                                                                    \
1521         static DEFINE_RATELIMIT_STATE(_rs,                              \
1522                                       DEFAULT_RATELIMIT_INTERVAL,       \
1523                                       DEFAULT_RATELIMIT_BURST);         \
1524         if (__ratelimit(&_rs))                                          \
1525                 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \
1526 } while (0)
1527 #else
1528 #define dev_dbg_ratelimited(dev, fmt, ...)                              \
1529 do {                                                                    \
1530         if (0)                                                          \
1531                 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \
1532 } while (0)
1533 #endif
1534
1535 #ifdef VERBOSE_DEBUG
1536 #define dev_vdbg        dev_dbg
1537 #else
1538 #define dev_vdbg(dev, fmt, ...)                                         \
1539 ({                                                                      \
1540         if (0)                                                          \
1541                 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \
1542 })
1543 #endif
1544
1545 /*
1546  * dev_WARN*() acts like dev_printk(), but with the key difference of
1547  * using WARN/WARN_ONCE to include file/line information and a backtrace.
1548  */
1549 #define dev_WARN(dev, format, arg...) \
1550         WARN(1, "%s %s: " format, dev_driver_string(dev), dev_name(dev), ## arg);
1551
1552 #define dev_WARN_ONCE(dev, condition, format, arg...) \
1553         WARN_ONCE(condition, "%s %s: " format, \
1554                         dev_driver_string(dev), dev_name(dev), ## arg)
1555
1556 /* Create alias, so I can be autoloaded. */
1557 #define MODULE_ALIAS_CHARDEV(major,minor) \
1558         MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1559 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1560         MODULE_ALIAS("char-major-" __stringify(major) "-*")
1561
1562 #ifdef CONFIG_SYSFS_DEPRECATED
1563 extern long sysfs_deprecated;
1564 #else
1565 #define sysfs_deprecated 0
1566 #endif
1567
1568 /**
1569  * module_driver() - Helper macro for drivers that don't do anything
1570  * special in module init/exit. This eliminates a lot of boilerplate.
1571  * Each module may only use this macro once, and calling it replaces
1572  * module_init() and module_exit().
1573  *
1574  * @__driver: driver name
1575  * @__register: register function for this driver type
1576  * @__unregister: unregister function for this driver type
1577  * @...: Additional arguments to be passed to __register and __unregister.
1578  *
1579  * Use this macro to construct bus specific macros for registering
1580  * drivers, and do not use it on its own.
1581  */
1582 #define module_driver(__driver, __register, __unregister, ...) \
1583 static int __init __driver##_init(void) \
1584 { \
1585         return __register(&(__driver) , ##__VA_ARGS__); \
1586 } \
1587 module_init(__driver##_init); \
1588 static void __exit __driver##_exit(void) \
1589 { \
1590         __unregister(&(__driver) , ##__VA_ARGS__); \
1591 } \
1592 module_exit(__driver##_exit);
1593
1594 /**
1595  * builtin_driver() - Helper macro for drivers that don't do anything
1596  * special in init and have no exit. This eliminates some boilerplate.
1597  * Each driver may only use this macro once, and calling it replaces
1598  * device_initcall (or in some cases, the legacy __initcall).  This is
1599  * meant to be a direct parallel of module_driver() above but without
1600  * the __exit stuff that is not used for builtin cases.
1601  *
1602  * @__driver: driver name
1603  * @__register: register function for this driver type
1604  * @...: Additional arguments to be passed to __register
1605  *
1606  * Use this macro to construct bus specific macros for registering
1607  * drivers, and do not use it on its own.
1608  */
1609 #define builtin_driver(__driver, __register, ...) \
1610 static int __init __driver##_init(void) \
1611 { \
1612         return __register(&(__driver) , ##__VA_ARGS__); \
1613 } \
1614 device_initcall(__driver##_init);
1615
1616 #endif /* _DEVICE_H_ */