include/linux/device.h

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