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