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