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