include/linux/device.h

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