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  * device_connections_add - Add multiple device connections at once
 778  * @cons: Zero terminated array of device connection descriptors
 779  */
 780 static inline void device_connections_add(struct device_connection *cons)
 781 {
 782         struct device_connection *c;
 783
 784         for (c = cons; c->endpoint[0]; c++)
 785                 device_connection_add(c);
 786 }
 787
 788 /**
 789  * device_connections_remove - Remove multiple device connections at once
 790  * @cons: Zero terminated array of device connection descriptors
 791  */
 792 static inline void device_connections_remove(struct device_connection *cons)
 793 {
 794         struct device_connection *c;
 795
 796         for (c = cons; c->endpoint[0]; c++)
 797                 device_connection_remove(c);
 798 }
 799
 800 /**
 801  * enum device_link_state - Device link states.
 802  * @DL_STATE_NONE: The presence of the drivers is not being tracked.
 803  * @DL_STATE_DORMANT: None of the supplier/consumer drivers is present.
 804  * @DL_STATE_AVAILABLE: The supplier driver is present, but the consumer is not.
 805  * @DL_STATE_CONSUMER_PROBE: The consumer is probing (supplier driver present).
 806  * @DL_STATE_ACTIVE: Both the supplier and consumer drivers are present.
 807  * @DL_STATE_SUPPLIER_UNBIND: The supplier driver is unbinding.
 808  */
 809 enum device_link_state {
 810         DL_STATE_NONE = -1,
 811         DL_STATE_DORMANT = 0,
 812         DL_STATE_AVAILABLE,
 813         DL_STATE_CONSUMER_PROBE,
 814         DL_STATE_ACTIVE,
 815         DL_STATE_SUPPLIER_UNBIND,
 816 };
 817
 818 /*
 819  * Device link flags.
 820  *
 821  * STATELESS: The core won't track the presence of supplier/consumer drivers.
 822  * AUTOREMOVE_CONSUMER: Remove the link automatically on consumer driver unbind.
 823  * PM_RUNTIME: If set, the runtime PM framework will use this link.
 824  * RPM_ACTIVE: Run pm_runtime_get_sync() on the supplier during link creation.
 825  * AUTOREMOVE_SUPPLIER: Remove the link automatically on supplier driver unbind.
 826  */
 827 #define DL_FLAG_STATELESS               BIT(0)
 828 #define DL_FLAG_AUTOREMOVE_CONSUMER     BIT(1)
 829 #define DL_FLAG_PM_RUNTIME              BIT(2)
 830 #define DL_FLAG_RPM_ACTIVE              BIT(3)
 831 #define DL_FLAG_AUTOREMOVE_SUPPLIER     BIT(4)
 832
 833 /**
 834  * struct device_link - Device link representation.
 835  * @supplier: The device on the supplier end of the link.
 836  * @s_node: Hook to the supplier device's list of links to consumers.
 837  * @consumer: The device on the consumer end of the link.
 838  * @c_node: Hook to the consumer device's list of links to suppliers.
 839  * @status: The state of the link (with respect to the presence of drivers).
 840  * @flags: Link flags.
 841  * @rpm_active: Whether or not the consumer device is runtime-PM-active.
 842  * @kref: Count repeated addition of the same link.
 843  * @rcu_head: An RCU head to use for deferred execution of SRCU callbacks.
 844  */
 845 struct device_link {
 846         struct device *supplier;
 847         struct list_head s_node;
 848         struct device *consumer;
 849         struct list_head c_node;
 850         enum device_link_state status;
 851         u32 flags;
 852         bool rpm_active;
 853         struct kref kref;
 854 #ifdef CONFIG_SRCU
 855         struct rcu_head rcu_head;
 856 #endif
 857 };
 858
 859 /**
 860  * enum dl_dev_state - Device driver presence tracking information.
 861  * @DL_DEV_NO_DRIVER: There is no driver attached to the device.
 862  * @DL_DEV_PROBING: A driver is probing.
 863  * @DL_DEV_DRIVER_BOUND: The driver has been bound to the device.
 864  * @DL_DEV_UNBINDING: The driver is unbinding from the device.
 865  */
 866 enum dl_dev_state {
 867         DL_DEV_NO_DRIVER = 0,
 868         DL_DEV_PROBING,
 869         DL_DEV_DRIVER_BOUND,
 870         DL_DEV_UNBINDING,
 871 };
 872
 873 /**
 874  * struct dev_links_info - Device data related to device links.
 875  * @suppliers: List of links to supplier devices.
 876  * @consumers: List of links to consumer devices.
 877  * @status: Driver status information.
 878  */
 879 struct dev_links_info {
 880         struct list_head suppliers;
 881         struct list_head consumers;
 882         enum dl_dev_state status;
 883 };
 884
 885 /**
 886  * struct device - The basic device structure
 887  * @parent:     The device's "parent" device, the device to which it is attached.
 888  *              In most cases, a parent device is some sort of bus or host
 889  *              controller. If parent is NULL, the device, is a top-level device,
 890  *              which is not usually what you want.
 891  * @p:          Holds the private data of the driver core portions of the device.
 892  *              See the comment of the struct device_private for detail.
 893  * @kobj:       A top-level, abstract class from which other classes are derived.
 894  * @init_name:  Initial name of the device.
 895  * @type:       The type of device.
 896  *              This identifies the device type and carries type-specific
 897  *              information.
 898  * @mutex:      Mutex to synchronize calls to its driver.
 899  * @bus:        Type of bus device is on.
 900  * @driver:     Which driver has allocated this
 901  * @platform_data: Platform data specific to the device.
 902  *              Example: For devices on custom boards, as typical of embedded
 903  *              and SOC based hardware, Linux often uses platform_data to point
 904  *              to board-specific structures describing devices and how they
 905  *              are wired.  That can include what ports are available, chip
 906  *              variants, which GPIO pins act in what additional roles, and so
 907  *              on.  This shrinks the "Board Support Packages" (BSPs) and
 908  *              minimizes board-specific #ifdefs in drivers.
 909  * @driver_data: Private pointer for driver specific info.
 910  * @links:      Links to suppliers and consumers of this device.
 911  * @power:      For device power management.
 912  *              See Documentation/driver-api/pm/devices.rst for details.
 913  * @pm_domain:  Provide callbacks that are executed during system suspend,
 914  *              hibernation, system resume and during runtime PM transitions
 915  *              along with subsystem-level and driver-level callbacks.
 916  * @pins:       For device pin management.
 917  *              See Documentation/driver-api/pinctl.rst for details.
 918  * @msi_list:   Hosts MSI descriptors
 919  * @msi_domain: The generic MSI domain this device is using.
 920  * @numa_node:  NUMA node this device is close to.
 921  * @dma_ops:    DMA mapping operations for this device.
 922  * @dma_mask:   Dma mask (if dma'ble device).
 923  * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
 924  *              hardware supports 64-bit addresses for consistent allocations
 925  *              such descriptors.
 926  * @bus_dma_mask: Mask of an upstream bridge or bus which imposes a smaller DMA
 927  *              limit than the device itself supports.
 928  * @dma_pfn_offset: offset of DMA memory range relatively of RAM
 929  * @dma_parms:  A low level driver may set these to teach IOMMU code about
 930  *              segment limitations.
 931  * @dma_pools:  Dma pools (if dma'ble device).
 932  * @dma_mem:    Internal for coherent mem override.
 933  * @cma_area:   Contiguous memory area for dma allocations
 934  * @archdata:   For arch-specific additions.
 935  * @of_node:    Associated device tree node.
 936  * @fwnode:     Associated device node supplied by platform firmware.
 937  * @devt:       For creating the sysfs "dev".
 938  * @id:         device instance
 939  * @devres_lock: Spinlock to protect the resource of the device.
 940  * @devres_head: The resources list of the device.
 941  * @knode_class: The node used to add the device to the class list.
 942  * @class:      The class of the device.
 943  * @groups:     Optional attribute groups.
 944  * @release:    Callback to free the device after all references have
 945  *              gone away. This should be set by the allocator of the
 946  *              device (i.e. the bus driver that discovered the device).
 947  * @iommu_group: IOMMU group the device belongs to.
 948  * @iommu_fwspec: IOMMU-specific properties supplied by firmware.
 949  *
 950  * @offline_disabled: If set, the device is permanently online.
 951  * @offline:    Set after successful invocation of bus type's .offline().
 952  * @of_node_reused: Set if the device-tree node is shared with an ancestor
 953  *              device.
 954  *
 955  * At the lowest level, every device in a Linux system is represented by an
 956  * instance of struct device. The device structure contains the information
 957  * that the device model core needs to model the system. Most subsystems,
 958  * however, track additional information about the devices they host. As a
 959  * result, it is rare for devices to be represented by bare device structures;
 960  * instead, that structure, like kobject structures, is usually embedded within
 961  * a higher-level representation of the device.
 962  */
 963 struct device {
 964         struct device           *parent;
 965
 966         struct device_private   *p;
 967
 968         struct kobject kobj;
 969         const char              *init_name; /* initial name of the device */
 970         const struct device_type *type;
 971
 972         struct mutex            mutex;  /* mutex to synchronize calls to
 973                                          * its driver.
 974                                          */
 975
 976         struct bus_type *bus;           /* type of bus device is on */
 977         struct device_driver *driver;   /* which driver has allocated this
 978                                            device */
 979         void            *platform_data; /* Platform specific data, device
 980                                            core doesn't touch it */
 981         void            *driver_data;   /* Driver data, set and get with
 982                                            dev_set/get_drvdata */
 983         struct dev_links_info   links;
 984         struct dev_pm_info      power;
 985         struct dev_pm_domain    *pm_domain;
 986
 987 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
 988         struct irq_domain       *msi_domain;
 989 #endif
 990 #ifdef CONFIG_PINCTRL
 991         struct dev_pin_info     *pins;
 992 #endif
 993 #ifdef CONFIG_GENERIC_MSI_IRQ
 994         struct list_head        msi_list;
 995 #endif
 996
 997 #ifdef CONFIG_NUMA
 998         int             numa_node;      /* NUMA node this device is close to */
 999 #endif
1000         const struct dma_map_ops *dma_ops;
1001         u64             *dma_mask;      /* dma mask (if dma'able device) */
1002         u64             coherent_dma_mask;/* Like dma_mask, but for
1003                                              alloc_coherent mappings as
1004                                              not all hardware supports
1005                                              64 bit addresses for consistent
1006                                              allocations such descriptors. */
1007         u64             bus_dma_mask;   /* upstream dma_mask constraint */
1008         unsigned long   dma_pfn_offset;
1009
1010         struct device_dma_parameters *dma_parms;
1011
1012         struct list_head        dma_pools;      /* dma pools (if dma'ble) */
1013
1014         struct dma_coherent_mem *dma_mem; /* internal for coherent mem
1015                                              override */
1016 #ifdef CONFIG_DMA_CMA
1017         struct cma *cma_area;           /* contiguous memory area for dma
1018                                            allocations */
1019 #endif
1020         /* arch specific additions */
1021         struct dev_archdata     archdata;
1022
1023         struct device_node      *of_node; /* associated device tree node */
1024         struct fwnode_handle    *fwnode; /* firmware device node */
1025
1026         dev_t                   devt;   /* dev_t, creates the sysfs "dev" */
1027         u32                     id;     /* device instance */
1028
1029         spinlock_t              devres_lock;
1030         struct list_head        devres_head;
1031
1032         struct klist_node       knode_class;
1033         struct class            *class;
1034         const struct attribute_group **groups;  /* optional groups */
1035
1036         void    (*release)(struct device *dev);
1037         struct iommu_group      *iommu_group;
1038         struct iommu_fwspec     *iommu_fwspec;
1039
1040         bool                    offline_disabled:1;
1041         bool                    offline:1;
1042         bool                    of_node_reused:1;
1043 };
1044
1045 static inline struct device *kobj_to_dev(struct kobject *kobj)
1046 {
1047         return container_of(kobj, struct device, kobj);
1048 }
1049
1050 /* Get the wakeup routines, which depend on struct device */
1051 #include <linux/pm_wakeup.h>
1052
1053 static inline const char *dev_name(const struct device *dev)
1054 {
1055         /* Use the init name until the kobject becomes available */
1056         if (dev->init_name)
1057                 return dev->init_name;
1058
1059         return kobject_name(&dev->kobj);
1060 }
1061
1062 extern __printf(2, 3)
1063 int dev_set_name(struct device *dev, const char *name, ...);
1064
1065 #ifdef CONFIG_NUMA
1066 static inline int dev_to_node(struct device *dev)
1067 {
1068         return dev->numa_node;
1069 }
1070 static inline void set_dev_node(struct device *dev, int node)
1071 {
1072         dev->numa_node = node;
1073 }
1074 #else
1075 static inline int dev_to_node(struct device *dev)
1076 {
1077         return -1;
1078 }
1079 static inline void set_dev_node(struct device *dev, int node)
1080 {
1081 }
1082 #endif
1083
1084 static inline struct irq_domain *dev_get_msi_domain(const struct device *dev)
1085 {
1086 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
1087         return dev->msi_domain;
1088 #else
1089         return NULL;
1090 #endif
1091 }
1092
1093 static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d)
1094 {
1095 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
1096         dev->msi_domain = d;
1097 #endif
1098 }
1099
1100 static inline void *dev_get_drvdata(const struct device *dev)
1101 {
1102         return dev->driver_data;
1103 }
1104
1105 static inline void dev_set_drvdata(struct device *dev, void *data)
1106 {
1107         dev->driver_data = data;
1108 }
1109
1110 static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
1111 {
1112         return dev ? dev->power.subsys_data : NULL;
1113 }
1114
1115 static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
1116 {
1117         return dev->kobj.uevent_suppress;
1118 }
1119
1120 static inline void dev_set_uevent_suppress(struct device *dev, int val)
1121 {
1122         dev->kobj.uevent_suppress = val;
1123 }
1124
1125 static inline int device_is_registered(struct device *dev)
1126 {
1127         return dev->kobj.state_in_sysfs;
1128 }
1129
1130 static inline void device_enable_async_suspend(struct device *dev)
1131 {
1132         if (!dev->power.is_prepared)
1133                 dev->power.async_suspend = true;
1134 }
1135
1136 static inline void device_disable_async_suspend(struct device *dev)
1137 {
1138         if (!dev->power.is_prepared)
1139                 dev->power.async_suspend = false;
1140 }
1141
1142 static inline bool device_async_suspend_enabled(struct device *dev)
1143 {
1144         return !!dev->power.async_suspend;
1145 }
1146
1147 static inline void dev_pm_syscore_device(struct device *dev, bool val)
1148 {
1149 #ifdef CONFIG_PM_SLEEP
1150         dev->power.syscore = val;
1151 #endif
1152 }
1153
1154 static inline void dev_pm_set_driver_flags(struct device *dev, u32 flags)
1155 {
1156         dev->power.driver_flags = flags;
1157 }
1158
1159 static inline bool dev_pm_test_driver_flags(struct device *dev, u32 flags)
1160 {
1161         return !!(dev->power.driver_flags & flags);
1162 }
1163
1164 static inline void device_lock(struct device *dev)
1165 {
1166         mutex_lock(&dev->mutex);
1167 }
1168
1169 static inline int device_lock_interruptible(struct device *dev)
1170 {
1171         return mutex_lock_interruptible(&dev->mutex);
1172 }
1173
1174 static inline int device_trylock(struct device *dev)
1175 {
1176         return mutex_trylock(&dev->mutex);
1177 }
1178
1179 static inline void device_unlock(struct device *dev)
1180 {
1181         mutex_unlock(&dev->mutex);
1182 }
1183
1184 static inline void device_lock_assert(struct device *dev)
1185 {
1186         lockdep_assert_held(&dev->mutex);
1187 }
1188
1189 static inline struct device_node *dev_of_node(struct device *dev)
1190 {
1191         if (!IS_ENABLED(CONFIG_OF))
1192                 return NULL;
1193         return dev->of_node;
1194 }
1195
1196 void driver_init(void);
1197
1198 /*
1199  * High level routines for use by the bus drivers
1200  */
1201 extern int __must_check device_register(struct device *dev);
1202 extern void device_unregister(struct device *dev);
1203 extern void device_initialize(struct device *dev);
1204 extern int __must_check device_add(struct device *dev);
1205 extern void device_del(struct device *dev);
1206 extern int device_for_each_child(struct device *dev, void *data,
1207                      int (*fn)(struct device *dev, void *data));
1208 extern int device_for_each_child_reverse(struct device *dev, void *data,
1209                      int (*fn)(struct device *dev, void *data));
1210 extern struct device *device_find_child(struct device *dev, void *data,
1211                                 int (*match)(struct device *dev, void *data));
1212 extern int device_rename(struct device *dev, const char *new_name);
1213 extern int device_move(struct device *dev, struct device *new_parent,
1214                        enum dpm_order dpm_order);
1215 extern const char *device_get_devnode(struct device *dev,
1216                                       umode_t *mode, kuid_t *uid, kgid_t *gid,
1217                                       const char **tmp);
1218
1219 static inline bool device_supports_offline(struct device *dev)
1220 {
1221         return dev->bus && dev->bus->offline && dev->bus->online;
1222 }
1223
1224 extern void lock_device_hotplug(void);
1225 extern void unlock_device_hotplug(void);
1226 extern int lock_device_hotplug_sysfs(void);
1227 extern int device_offline(struct device *dev);
1228 extern int device_online(struct device *dev);
1229 extern void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1230 extern void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1231 void device_set_of_node_from_dev(struct device *dev, const struct device *dev2);
1232
1233 static inline int dev_num_vf(struct device *dev)
1234 {
1235         if (dev->bus && dev->bus->num_vf)
1236                 return dev->bus->num_vf(dev);
1237         return 0;
1238 }
1239
1240 /*
1241  * Root device objects for grouping under /sys/devices
1242  */
1243 extern struct device *__root_device_register(const char *name,
1244                                              struct module *owner);
1245
1246 /* This is a macro to avoid include problems with THIS_MODULE */
1247 #define root_device_register(name) \
1248         __root_device_register(name, THIS_MODULE)
1249
1250 extern void root_device_unregister(struct device *root);
1251
1252 static inline void *dev_get_platdata(const struct device *dev)
1253 {
1254         return dev->platform_data;
1255 }
1256
1257 /*
1258  * Manual binding of a device to driver. See drivers/base/bus.c
1259  * for information on use.
1260  */
1261 extern int __must_check device_bind_driver(struct device *dev);
1262 extern void device_release_driver(struct device *dev);
1263 extern int  __must_check device_attach(struct device *dev);
1264 extern int __must_check driver_attach(struct device_driver *drv);
1265 extern void device_initial_probe(struct device *dev);
1266 extern int __must_check device_reprobe(struct device *dev);
1267
1268 extern bool device_is_bound(struct device *dev);
1269
1270 /*
1271  * Easy functions for dynamically creating devices on the fly
1272  */
1273 extern __printf(5, 0)
1274 struct device *device_create_vargs(struct class *cls, struct device *parent,
1275                                    dev_t devt, void *drvdata,
1276                                    const char *fmt, va_list vargs);
1277 extern __printf(5, 6)
1278 struct device *device_create(struct class *cls, struct device *parent,
1279                              dev_t devt, void *drvdata,
1280                              const char *fmt, ...);
1281 extern __printf(6, 7)
1282 struct device *device_create_with_groups(struct class *cls,
1283                              struct device *parent, dev_t devt, void *drvdata,
1284                              const struct attribute_group **groups,
1285                              const char *fmt, ...);
1286 extern void device_destroy(struct class *cls, dev_t devt);
1287
1288 extern int __must_check device_add_groups(struct device *dev,
1289                                         const struct attribute_group **groups);
1290 extern void device_remove_groups(struct device *dev,
1291                                  const struct attribute_group **groups);
1292
1293 static inline int __must_check device_add_group(struct device *dev,
1294                                         const struct attribute_group *grp)
1295 {
1296         const struct attribute_group *groups[] = { grp, NULL };
1297
1298         return device_add_groups(dev, groups);
1299 }
1300
1301 static inline void device_remove_group(struct device *dev,
1302                                        const struct attribute_group *grp)
1303 {
1304         const struct attribute_group *groups[] = { grp, NULL };
1305
1306         return device_remove_groups(dev, groups);
1307 }
1308
1309 extern int __must_check devm_device_add_groups(struct device *dev,
1310                                         const struct attribute_group **groups);
1311 extern void devm_device_remove_groups(struct device *dev,
1312                                       const struct attribute_group **groups);
1313 extern int __must_check devm_device_add_group(struct device *dev,
1314                                         const struct attribute_group *grp);
1315 extern void devm_device_remove_group(struct device *dev,
1316                                      const struct attribute_group *grp);
1317
1318 /*
1319  * Platform "fixup" functions - allow the platform to have their say
1320  * about devices and actions that the general device layer doesn't
1321  * know about.
1322  */
1323 /* Notify platform of device discovery */
1324 extern int (*platform_notify)(struct device *dev);
1325
1326 extern int (*platform_notify_remove)(struct device *dev);
1327
1328
1329 /*
1330  * get_device - atomically increment the reference count for the device.
1331  *
1332  */
1333 extern struct device *get_device(struct device *dev);
1334 extern void put_device(struct device *dev);
1335
1336 #ifdef CONFIG_DEVTMPFS
1337 extern int devtmpfs_create_node(struct device *dev);
1338 extern int devtmpfs_delete_node(struct device *dev);
1339 extern int devtmpfs_mount(const char *mntdir);
1340 #else
1341 static inline int devtmpfs_create_node(struct device *dev) { return 0; }
1342 static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
1343 static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
1344 #endif
1345
1346 /* drivers/base/power/shutdown.c */
1347 extern void device_shutdown(void);
1348
1349 /* debugging and troubleshooting/diagnostic helpers. */
1350 extern const char *dev_driver_string(const struct device *dev);
1351
1352 /* Device links interface. */
1353 struct device_link *device_link_add(struct device *consumer,
1354                                     struct device *supplier, u32 flags);
1355 void device_link_del(struct device_link *link);
1356 void device_link_remove(void *consumer, struct device *supplier);
1357
1358 #ifndef dev_fmt
1359 #define dev_fmt(fmt) fmt
1360 #endif
1361
1362 #ifdef CONFIG_PRINTK
1363
1364 __printf(3, 0)
1365 int dev_vprintk_emit(int level, const struct device *dev,
1366                      const char *fmt, va_list args);
1367 __printf(3, 4)
1368 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...);
1369
1370 __printf(3, 4)
1371 void dev_printk(const char *level, const struct device *dev,
1372                 const char *fmt, ...);
1373 __printf(2, 3)
1374 void _dev_emerg(const struct device *dev, const char *fmt, ...);
1375 __printf(2, 3)
1376 void _dev_alert(const struct device *dev, const char *fmt, ...);
1377 __printf(2, 3)
1378 void _dev_crit(const struct device *dev, const char *fmt, ...);
1379 __printf(2, 3)
1380 void _dev_err(const struct device *dev, const char *fmt, ...);
1381 __printf(2, 3)
1382 void _dev_warn(const struct device *dev, const char *fmt, ...);
1383 __printf(2, 3)
1384 void _dev_notice(const struct device *dev, const char *fmt, ...);
1385 __printf(2, 3)
1386 void _dev_info(const struct device *dev, const char *fmt, ...);
1387
1388 #else
1389
1390 static inline __printf(3, 0)
1391 int dev_vprintk_emit(int level, const struct device *dev,
1392                      const char *fmt, va_list args)
1393 { return 0; }
1394 static inline __printf(3, 4)
1395 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
1396 { return 0; }
1397
1398 static inline void __dev_printk(const char *level, const struct device *dev,
1399                                 struct va_format *vaf)
1400 {}
1401 static inline __printf(3, 4)
1402 void dev_printk(const char *level, const struct device *dev,
1403                  const char *fmt, ...)
1404 {}
1405
1406 static inline __printf(2, 3)
1407 void _dev_emerg(const struct device *dev, const char *fmt, ...)
1408 {}
1409 static inline __printf(2, 3)
1410 void _dev_crit(const struct device *dev, const char *fmt, ...)
1411 {}
1412 static inline __printf(2, 3)
1413 void _dev_alert(const struct device *dev, const char *fmt, ...)
1414 {}
1415 static inline __printf(2, 3)
1416 void _dev_err(const struct device *dev, const char *fmt, ...)
1417 {}
1418 static inline __printf(2, 3)
1419 void _dev_warn(const struct device *dev, const char *fmt, ...)
1420 {}
1421 static inline __printf(2, 3)
1422 void _dev_notice(const struct device *dev, const char *fmt, ...)
1423 {}
1424 static inline __printf(2, 3)
1425 void _dev_info(const struct device *dev, const char *fmt, ...)
1426 {}
1427
1428 #endif
1429
1430 /*
1431  * #defines for all the dev_<level> macros to prefix with whatever
1432  * possible use of #define dev_fmt(fmt) ...
1433  */
1434
1435 #define dev_emerg(dev, fmt, ...)                                        \
1436         _dev_emerg(dev, dev_fmt(fmt), ##__VA_ARGS__)
1437 #define dev_crit(dev, fmt, ...)                                         \
1438         _dev_crit(dev, dev_fmt(fmt), ##__VA_ARGS__)
1439 #define dev_alert(dev, fmt, ...)                                        \
1440         _dev_alert(dev, dev_fmt(fmt), ##__VA_ARGS__)
1441 #define dev_err(dev, fmt, ...)                                          \
1442         _dev_err(dev, dev_fmt(fmt), ##__VA_ARGS__)
1443 #define dev_warn(dev, fmt, ...)                                         \
1444         _dev_warn(dev, dev_fmt(fmt), ##__VA_ARGS__)
1445 #define dev_notice(dev, fmt, ...)                                       \
1446         _dev_notice(dev, dev_fmt(fmt), ##__VA_ARGS__)
1447 #define dev_info(dev, fmt, ...)                                         \
1448         _dev_info(dev, dev_fmt(fmt), ##__VA_ARGS__)
1449
1450 #if defined(CONFIG_DYNAMIC_DEBUG)
1451 #define dev_dbg(dev, fmt, ...)                                          \
1452         dynamic_dev_dbg(dev, dev_fmt(fmt), ##__VA_ARGS__)
1453 #elif defined(DEBUG)
1454 #define dev_dbg(dev, fmt, ...)                                          \
1455         dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__)
1456 #else
1457 #define dev_dbg(dev, fmt, ...)                                          \
1458 ({                                                                      \
1459         if (0)                                                          \
1460                 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \
1461 })
1462 #endif
1463
1464 #ifdef CONFIG_PRINTK
1465 #define dev_level_once(dev_level, dev, fmt, ...)                        \
1466 do {                                                                    \
1467         static bool __print_once __read_mostly;                         \
1468                                                                         \
1469         if (!__print_once) {                                            \
1470                 __print_once = true;                                    \
1471                 dev_level(dev, fmt, ##__VA_ARGS__);                     \
1472         }                                                               \
1473 } while (0)
1474 #else
1475 #define dev_level_once(dev_level, dev, fmt, ...)                        \
1476 do {                                                                    \
1477         if (0)                                                          \
1478                 dev_level(dev, fmt, ##__VA_ARGS__);                     \
1479 } while (0)
1480 #endif
1481
1482 #define dev_emerg_once(dev, fmt, ...)                                   \
1483         dev_level_once(dev_emerg, dev, fmt, ##__VA_ARGS__)
1484 #define dev_alert_once(dev, fmt, ...)                                   \
1485         dev_level_once(dev_alert, dev, fmt, ##__VA_ARGS__)
1486 #define dev_crit_once(dev, fmt, ...)                                    \
1487         dev_level_once(dev_crit, dev, fmt, ##__VA_ARGS__)
1488 #define dev_err_once(dev, fmt, ...)                                     \
1489         dev_level_once(dev_err, dev, fmt, ##__VA_ARGS__)
1490 #define dev_warn_once(dev, fmt, ...)                                    \
1491         dev_level_once(dev_warn, dev, fmt, ##__VA_ARGS__)
1492 #define dev_notice_once(dev, fmt, ...)                                  \
1493         dev_level_once(dev_notice, dev, fmt, ##__VA_ARGS__)
1494 #define dev_info_once(dev, fmt, ...)                                    \
1495         dev_level_once(dev_info, dev, fmt, ##__VA_ARGS__)
1496 #define dev_dbg_once(dev, fmt, ...)                                     \
1497         dev_level_once(dev_dbg, dev, fmt, ##__VA_ARGS__)
1498
1499 #define dev_level_ratelimited(dev_level, dev, fmt, ...)                 \
1500 do {                                                                    \
1501         static DEFINE_RATELIMIT_STATE(_rs,                              \
1502                                       DEFAULT_RATELIMIT_INTERVAL,       \
1503                                       DEFAULT_RATELIMIT_BURST);         \
1504         if (__ratelimit(&_rs))                                          \
1505                 dev_level(dev, fmt, ##__VA_ARGS__);                     \
1506 } while (0)
1507
1508 #define dev_emerg_ratelimited(dev, fmt, ...)                            \
1509         dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
1510 #define dev_alert_ratelimited(dev, fmt, ...)                            \
1511         dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
1512 #define dev_crit_ratelimited(dev, fmt, ...)                             \
1513         dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
1514 #define dev_err_ratelimited(dev, fmt, ...)                              \
1515         dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
1516 #define dev_warn_ratelimited(dev, fmt, ...)                             \
1517         dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
1518 #define dev_notice_ratelimited(dev, fmt, ...)                           \
1519         dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
1520 #define dev_info_ratelimited(dev, fmt, ...)                             \
1521         dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
1522 #if defined(CONFIG_DYNAMIC_DEBUG)
1523 /* descriptor check is first to prevent flooding with "callbacks suppressed" */
1524 #define dev_dbg_ratelimited(dev, fmt, ...)                              \
1525 do {                                                                    \
1526         static DEFINE_RATELIMIT_STATE(_rs,                              \
1527                                       DEFAULT_RATELIMIT_INTERVAL,       \
1528                                       DEFAULT_RATELIMIT_BURST);         \
1529         DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt);                 \
1530         if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) &&        \
1531             __ratelimit(&_rs))                                          \
1532                 __dynamic_dev_dbg(&descriptor, dev, dev_fmt(fmt),       \
1533                                   ##__VA_ARGS__);                       \
1534 } while (0)
1535 #elif defined(DEBUG)
1536 #define dev_dbg_ratelimited(dev, fmt, ...)                              \
1537 do {                                                                    \
1538         static DEFINE_RATELIMIT_STATE(_rs,                              \
1539                                       DEFAULT_RATELIMIT_INTERVAL,       \
1540                                       DEFAULT_RATELIMIT_BURST);         \
1541         if (__ratelimit(&_rs))                                          \
1542                 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \
1543 } while (0)
1544 #else
1545 #define dev_dbg_ratelimited(dev, fmt, ...)                              \
1546 do {                                                                    \
1547         if (0)                                                          \
1548                 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \
1549 } while (0)
1550 #endif
1551
1552 #ifdef VERBOSE_DEBUG
1553 #define dev_vdbg        dev_dbg
1554 #else
1555 #define dev_vdbg(dev, fmt, ...)                                         \
1556 ({                                                                      \
1557         if (0)                                                          \
1558                 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \
1559 })
1560 #endif
1561
1562 /*
1563  * dev_WARN*() acts like dev_printk(), but with the key difference of
1564  * using WARN/WARN_ONCE to include file/line information and a backtrace.
1565  */
1566 #define dev_WARN(dev, format, arg...) \
1567         WARN(1, "%s %s: " format, dev_driver_string(dev), dev_name(dev), ## arg);
1568
1569 #define dev_WARN_ONCE(dev, condition, format, arg...) \
1570         WARN_ONCE(condition, "%s %s: " format, \
1571                         dev_driver_string(dev), dev_name(dev), ## arg)
1572
1573 /* Create alias, so I can be autoloaded. */
1574 #define MODULE_ALIAS_CHARDEV(major,minor) \
1575         MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1576 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1577         MODULE_ALIAS("char-major-" __stringify(major) "-*")
1578
1579 #ifdef CONFIG_SYSFS_DEPRECATED
1580 extern long sysfs_deprecated;
1581 #else
1582 #define sysfs_deprecated 0
1583 #endif
1584
1585 /**
1586  * module_driver() - Helper macro for drivers that don't do anything
1587  * special in module init/exit. This eliminates a lot of boilerplate.
1588  * Each module may only use this macro once, and calling it replaces
1589  * module_init() and module_exit().
1590  *
1591  * @__driver: driver name
1592  * @__register: register function for this driver type
1593  * @__unregister: unregister function for this driver type
1594  * @...: Additional arguments to be passed to __register and __unregister.
1595  *
1596  * Use this macro to construct bus specific macros for registering
1597  * drivers, and do not use it on its own.
1598  */
1599 #define module_driver(__driver, __register, __unregister, ...) \
1600 static int __init __driver##_init(void) \
1601 { \
1602         return __register(&(__driver) , ##__VA_ARGS__); \
1603 } \
1604 module_init(__driver##_init); \
1605 static void __exit __driver##_exit(void) \
1606 { \
1607         __unregister(&(__driver) , ##__VA_ARGS__); \
1608 } \
1609 module_exit(__driver##_exit);
1610
1611 /**
1612  * builtin_driver() - Helper macro for drivers that don't do anything
1613  * special in init and have no exit. This eliminates some boilerplate.
1614  * Each driver may only use this macro once, and calling it replaces
1615  * device_initcall (or in some cases, the legacy __initcall).  This is
1616  * meant to be a direct parallel of module_driver() above but without
1617  * the __exit stuff that is not used for builtin cases.
1618  *
1619  * @__driver: driver name
1620  * @__register: register function for this driver type
1621  * @...: Additional arguments to be passed to __register
1622  *
1623  * Use this macro to construct bus specific macros for registering
1624  * drivers, and do not use it on its own.
1625  */
1626 #define builtin_driver(__driver, __register, ...) \
1627 static int __init __driver##_init(void) \
1628 { \
1629         return __register(&(__driver) , ##__VA_ARGS__); \
1630 } \
1631 device_initcall(__driver##_init);
1632
1633 #endif /* _DEVICE_H_ */