include/linux/device.h

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