1 // SPDX-License-Identifier: GPL-2.0
3 * device.h - generic, centralized driver model
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.
9 * See Documentation/driver-api/driver-model/ for more information.
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>
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>
32 struct device_private;
34 struct driver_private;
37 struct subsys_private;
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);
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)
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 *);
65 * struct bus_type - The bus type of the device
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 * @add_links: Called, perhaps multiple times per device, after a device is
82 * added to this bus. The function is expected to create device
83 * links to all the suppliers of the input device that are
84 * available at the time this function is called. As in, the
85 * function should NOT stop at the first failed device link if
86 * other unlinked supplier devices are present in the system.
87 * This is necessary for the sync_state() callback to work
90 * Return 0 if device links have been successfully created to all
91 * the suppliers of this device. Return an error if some of the
92 * suppliers are not yet available and this function needs to be
93 * reattempted in the future.
94 * @probe: Called when a new device or driver add to this bus, and callback
95 * the specific driver's probe to initial the matched device.
96 * @sync_state: Called to sync device state to software state after all the
97 * state tracking consumers linked to this device (present at
98 * the time of late_initcall) have successfully bound to a
99 * driver. If the device has no consumers, this function will
100 * be called at late_initcall_sync level. If the device has
101 * consumers that are never bound to a driver, this function
102 * will never get called until they do.
103 * @remove: Called when a device removed from this bus.
104 * @shutdown: Called at shut-down time to quiesce the device.
106 * @online: Called to put the device back online (after offlining it).
107 * @offline: Called to put the device offline for hot-removal. May fail.
109 * @suspend: Called when a device on this bus wants to go to sleep mode.
110 * @resume: Called to bring a device on this bus out of sleep mode.
111 * @num_vf: Called to find out how many virtual functions a device on this
113 * @dma_configure: Called to setup DMA configuration on a device on
115 * @pm: Power management operations of this bus, callback the specific
116 * device driver's pm-ops.
117 * @iommu_ops: IOMMU specific operations for this bus, used to attach IOMMU
118 * driver implementations to a bus and allow the driver to do
120 * @p: The private data of the driver core, only the driver core can
122 * @lock_key: Lock class key for use by the lock validator
123 * @need_parent_lock: When probing or removing a device on this bus, the
124 * device core should lock the device's parent.
126 * A bus is a channel between the processor and one or more devices. For the
127 * purposes of the device model, all devices are connected via a bus, even if
128 * it is an internal, virtual, "platform" bus. Buses can plug into each other.
129 * A USB controller is usually a PCI device, for example. The device model
130 * represents the actual connections between buses and the devices they control.
131 * A bus is represented by the bus_type structure. It contains the name, the
132 * default attributes, the bus' methods, PM operations, and the driver core's
137 const char *dev_name;
138 struct device *dev_root;
139 const struct attribute_group **bus_groups;
140 const struct attribute_group **dev_groups;
141 const struct attribute_group **drv_groups;
143 int (*match)(struct device *dev, struct device_driver *drv);
144 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
145 int (*add_links)(struct device *dev);
146 int (*probe)(struct device *dev);
147 void (*sync_state)(struct device *dev);
148 int (*remove)(struct device *dev);
149 void (*shutdown)(struct device *dev);
151 int (*online)(struct device *dev);
152 int (*offline)(struct device *dev);
154 int (*suspend)(struct device *dev, pm_message_t state);
155 int (*resume)(struct device *dev);
157 int (*num_vf)(struct device *dev);
159 int (*dma_configure)(struct device *dev);
161 const struct dev_pm_ops *pm;
163 const struct iommu_ops *iommu_ops;
165 struct subsys_private *p;
166 struct lock_class_key lock_key;
168 bool need_parent_lock;
171 extern int __must_check bus_register(struct bus_type *bus);
173 extern void bus_unregister(struct bus_type *bus);
175 extern int __must_check bus_rescan_devices(struct bus_type *bus);
177 /* iterator helpers for buses */
178 struct subsys_dev_iter {
179 struct klist_iter ki;
180 const struct device_type *type;
182 void subsys_dev_iter_init(struct subsys_dev_iter *iter,
183 struct bus_type *subsys,
184 struct device *start,
185 const struct device_type *type);
186 struct device *subsys_dev_iter_next(struct subsys_dev_iter *iter);
187 void subsys_dev_iter_exit(struct subsys_dev_iter *iter);
189 int device_match_name(struct device *dev, const void *name);
190 int device_match_of_node(struct device *dev, const void *np);
191 int device_match_fwnode(struct device *dev, const void *fwnode);
192 int device_match_devt(struct device *dev, const void *pdevt);
193 int device_match_acpi_dev(struct device *dev, const void *adev);
194 int device_match_any(struct device *dev, const void *unused);
196 int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
197 int (*fn)(struct device *dev, void *data));
198 struct device *bus_find_device(struct bus_type *bus, struct device *start,
200 int (*match)(struct device *dev, const void *data));
202 * bus_find_device_by_name - device iterator for locating a particular device
203 * of a specific name.
205 * @start: Device to begin with
206 * @name: name of the device to match
208 static inline struct device *bus_find_device_by_name(struct bus_type *bus,
209 struct device *start,
212 return bus_find_device(bus, start, name, device_match_name);
216 * bus_find_device_by_of_node : device iterator for locating a particular device
217 * matching the of_node.
219 * @np: of_node of the device to match.
221 static inline struct device *
222 bus_find_device_by_of_node(struct bus_type *bus, const struct device_node *np)
224 return bus_find_device(bus, NULL, np, device_match_of_node);
228 * bus_find_device_by_fwnode : device iterator for locating a particular device
229 * matching the fwnode.
231 * @fwnode: fwnode of the device to match.
233 static inline struct device *
234 bus_find_device_by_fwnode(struct bus_type *bus, const struct fwnode_handle *fwnode)
236 return bus_find_device(bus, NULL, fwnode, device_match_fwnode);
240 * bus_find_device_by_devt : device iterator for locating a particular device
241 * matching the device type.
243 * @devt: device type of the device to match.
245 static inline struct device *bus_find_device_by_devt(struct bus_type *bus,
248 return bus_find_device(bus, NULL, &devt, device_match_devt);
252 * bus_find_next_device - Find the next device after a given device in a
255 * @cur: device to begin the search with.
257 static inline struct device *
258 bus_find_next_device(struct bus_type *bus,struct device *cur)
260 return bus_find_device(bus, cur, NULL, device_match_any);
267 * bus_find_device_by_acpi_dev : device iterator for locating a particular device
268 * matching the ACPI COMPANION device.
270 * @adev: ACPI COMPANION device to match.
272 static inline struct device *
273 bus_find_device_by_acpi_dev(struct bus_type *bus, const struct acpi_device *adev)
275 return bus_find_device(bus, NULL, adev, device_match_acpi_dev);
278 static inline struct device *
279 bus_find_device_by_acpi_dev(struct bus_type *bus, const void *adev)
285 struct device *subsys_find_device_by_id(struct bus_type *bus, unsigned int id,
286 struct device *hint);
287 int bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
288 void *data, int (*fn)(struct device_driver *, void *));
289 void bus_sort_breadthfirst(struct bus_type *bus,
290 int (*compare)(const struct device *a,
291 const struct device *b));
293 * Bus notifiers: Get notified of addition/removal of devices
294 * and binding/unbinding of drivers to devices.
295 * In the long run, it should be a replacement for the platform
298 struct notifier_block;
300 extern int bus_register_notifier(struct bus_type *bus,
301 struct notifier_block *nb);
302 extern int bus_unregister_notifier(struct bus_type *bus,
303 struct notifier_block *nb);
305 /* All 4 notifers below get called with the target struct device *
306 * as an argument. Note that those functions are likely to be called
307 * with the device lock held in the core, so be careful.
309 #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
310 #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device to be removed */
311 #define BUS_NOTIFY_REMOVED_DEVICE 0x00000003 /* device removed */
312 #define BUS_NOTIFY_BIND_DRIVER 0x00000004 /* driver about to be
314 #define BUS_NOTIFY_BOUND_DRIVER 0x00000005 /* driver bound to device */
315 #define BUS_NOTIFY_UNBIND_DRIVER 0x00000006 /* driver about to be
317 #define BUS_NOTIFY_UNBOUND_DRIVER 0x00000007 /* driver is unbound
319 #define BUS_NOTIFY_DRIVER_NOT_BOUND 0x00000008 /* driver fails to be bound */
321 extern struct kset *bus_get_kset(struct bus_type *bus);
322 extern struct klist *bus_get_device_klist(struct bus_type *bus);
325 * enum probe_type - device driver probe type to try
326 * Device drivers may opt in for special handling of their
327 * respective probe routines. This tells the core what to
330 * @PROBE_DEFAULT_STRATEGY: Used by drivers that work equally well
331 * whether probed synchronously or asynchronously.
332 * @PROBE_PREFER_ASYNCHRONOUS: Drivers for "slow" devices which
333 * probing order is not essential for booting the system may
334 * opt into executing their probes asynchronously.
335 * @PROBE_FORCE_SYNCHRONOUS: Use this to annotate drivers that need
336 * their probe routines to run synchronously with driver and
337 * device registration (with the exception of -EPROBE_DEFER
338 * handling - re-probing always ends up being done asynchronously).
340 * Note that the end goal is to switch the kernel to use asynchronous
341 * probing by default, so annotating drivers with
342 * %PROBE_PREFER_ASYNCHRONOUS is a temporary measure that allows us
343 * to speed up boot process while we are validating the rest of the
347 PROBE_DEFAULT_STRATEGY,
348 PROBE_PREFER_ASYNCHRONOUS,
349 PROBE_FORCE_SYNCHRONOUS,
353 * struct device_driver - The basic device driver structure
354 * @name: Name of the device driver.
355 * @bus: The bus which the device of this driver belongs to.
356 * @owner: The module owner.
357 * @mod_name: Used for built-in modules.
358 * @suppress_bind_attrs: Disables bind/unbind via sysfs.
359 * @probe_type: Type of the probe (synchronous or asynchronous) to use.
360 * @of_match_table: The open firmware table.
361 * @acpi_match_table: The ACPI match table.
362 * @edit_links: Called to allow a matched driver to edit the device links the
363 * bus might have added incorrectly. This will be useful to handle
364 * cases where the bus incorrectly adds functional dependencies
365 * that aren't true or tries to create cyclic dependencies. But
366 * doesn't correctly handle functional dependencies that are
367 * missed by the bus as the supplier's sync_state might get to
368 * execute before the driver for a missing consumer is loaded and
369 * gets to edit the device links for the consumer.
371 * This function might be called multiple times after a new device
372 * is added. The function is expected to create all the device
373 * links for the new device and return 0 if it was completed
374 * successfully or return an error if it needs to be reattempted
376 * @probe: Called to query the existence of a specific device,
377 * whether this driver can work with it, and bind the driver
378 * to a specific device.
379 * @sync_state: Called to sync device state to software state after all the
380 * state tracking consumers linked to this device (present at
381 * the time of late_initcall) have successfully bound to a
382 * driver. If the device has no consumers, this function will
383 * be called at late_initcall_sync level. If the device has
384 * consumers that are never bound to a driver, this function
385 * will never get called until they do.
386 * @remove: Called when the device is removed from the system to
387 * unbind a device from this driver.
388 * @shutdown: Called at shut-down time to quiesce the device.
389 * @suspend: Called to put the device to sleep mode. Usually to a
391 * @resume: Called to bring a device from sleep mode.
392 * @groups: Default attributes that get created by the driver core
394 * @dev_groups: Additional attributes attached to device instance once the
395 * it is bound to the driver.
396 * @pm: Power management operations of the device which matched
398 * @coredump: Called when sysfs entry is written to. The device driver
399 * is expected to call the dev_coredump API resulting in a
401 * @p: Driver core's private data, no one other than the driver
402 * core can touch this.
404 * The device driver-model tracks all of the drivers known to the system.
405 * The main reason for this tracking is to enable the driver core to match
406 * up drivers with new devices. Once drivers are known objects within the
407 * system, however, a number of other things become possible. Device drivers
408 * can export information and configuration variables that are independent
409 * of any specific device.
411 struct device_driver {
413 struct bus_type *bus;
415 struct module *owner;
416 const char *mod_name; /* used for built-in modules */
418 bool suppress_bind_attrs; /* disables bind/unbind via sysfs */
419 enum probe_type probe_type;
421 const struct of_device_id *of_match_table;
422 const struct acpi_device_id *acpi_match_table;
424 int (*edit_links)(struct device *dev);
425 int (*probe) (struct device *dev);
426 void (*sync_state)(struct device *dev);
427 int (*remove) (struct device *dev);
428 void (*shutdown) (struct device *dev);
429 int (*suspend) (struct device *dev, pm_message_t state);
430 int (*resume) (struct device *dev);
431 const struct attribute_group **groups;
432 const struct attribute_group **dev_groups;
434 const struct dev_pm_ops *pm;
435 void (*coredump) (struct device *dev);
437 struct driver_private *p;
441 extern int __must_check driver_register(struct device_driver *drv);
442 extern void driver_unregister(struct device_driver *drv);
444 extern struct device_driver *driver_find(const char *name,
445 struct bus_type *bus);
446 extern int driver_probe_done(void);
447 extern void wait_for_device_probe(void);
449 /* sysfs interface for exporting driver attributes */
451 struct driver_attribute {
452 struct attribute attr;
453 ssize_t (*show)(struct device_driver *driver, char *buf);
454 ssize_t (*store)(struct device_driver *driver, const char *buf,
458 #define DRIVER_ATTR_RW(_name) \
459 struct driver_attribute driver_attr_##_name = __ATTR_RW(_name)
460 #define DRIVER_ATTR_RO(_name) \
461 struct driver_attribute driver_attr_##_name = __ATTR_RO(_name)
462 #define DRIVER_ATTR_WO(_name) \
463 struct driver_attribute driver_attr_##_name = __ATTR_WO(_name)
465 extern int __must_check driver_create_file(struct device_driver *driver,
466 const struct driver_attribute *attr);
467 extern void driver_remove_file(struct device_driver *driver,
468 const struct driver_attribute *attr);
470 extern int __must_check driver_for_each_device(struct device_driver *drv,
471 struct device *start,
473 int (*fn)(struct device *dev,
475 struct device *driver_find_device(struct device_driver *drv,
476 struct device *start, const void *data,
477 int (*match)(struct device *dev, const void *data));
480 * driver_find_device_by_name - device iterator for locating a particular device
481 * of a specific name.
482 * @drv: the driver we're iterating
483 * @name: name of the device to match
485 static inline struct device *driver_find_device_by_name(struct device_driver *drv,
488 return driver_find_device(drv, NULL, name, device_match_name);
492 * driver_find_device_by_of_node- device iterator for locating a particular device
493 * by of_node pointer.
494 * @drv: the driver we're iterating
495 * @np: of_node pointer to match.
497 static inline struct device *
498 driver_find_device_by_of_node(struct device_driver *drv,
499 const struct device_node *np)
501 return driver_find_device(drv, NULL, np, device_match_of_node);
505 * driver_find_device_by_fwnode- device iterator for locating a particular device
507 * @drv: the driver we're iterating
508 * @fwnode: fwnode pointer to match.
510 static inline struct device *
511 driver_find_device_by_fwnode(struct device_driver *drv,
512 const struct fwnode_handle *fwnode)
514 return driver_find_device(drv, NULL, fwnode, device_match_fwnode);
518 * driver_find_device_by_devt- device iterator for locating a particular device
520 * @drv: the driver we're iterating
521 * @devt: devt pointer to match.
523 static inline struct device *driver_find_device_by_devt(struct device_driver *drv,
526 return driver_find_device(drv, NULL, &devt, device_match_devt);
529 static inline struct device *driver_find_next_device(struct device_driver *drv,
530 struct device *start)
532 return driver_find_device(drv, start, NULL, device_match_any);
537 * driver_find_device_by_acpi_dev : device iterator for locating a particular
538 * device matching the ACPI_COMPANION device.
539 * @drv: the driver we're iterating
540 * @adev: ACPI_COMPANION device to match.
542 static inline struct device *
543 driver_find_device_by_acpi_dev(struct device_driver *drv,
544 const struct acpi_device *adev)
546 return driver_find_device(drv, NULL, adev, device_match_acpi_dev);
549 static inline struct device *
550 driver_find_device_by_acpi_dev(struct device_driver *drv, const void *adev)
556 void driver_deferred_probe_add(struct device *dev);
557 int driver_deferred_probe_check_state(struct device *dev);
558 int driver_deferred_probe_check_state_continue(struct device *dev);
561 * struct subsys_interface - interfaces to device functions
562 * @name: name of the device function
563 * @subsys: subsytem of the devices to attach to
564 * @node: the list of functions registered at the subsystem
565 * @add_dev: device hookup to device function handler
566 * @remove_dev: device hookup to device function handler
568 * Simple interfaces attached to a subsystem. Multiple interfaces can
569 * attach to a subsystem and its devices. Unlike drivers, they do not
570 * exclusively claim or control devices. Interfaces usually represent
571 * a specific functionality of a subsystem/class of devices.
573 struct subsys_interface {
575 struct bus_type *subsys;
576 struct list_head node;
577 int (*add_dev)(struct device *dev, struct subsys_interface *sif);
578 void (*remove_dev)(struct device *dev, struct subsys_interface *sif);
581 int subsys_interface_register(struct subsys_interface *sif);
582 void subsys_interface_unregister(struct subsys_interface *sif);
584 int subsys_system_register(struct bus_type *subsys,
585 const struct attribute_group **groups);
586 int subsys_virtual_register(struct bus_type *subsys,
587 const struct attribute_group **groups);
590 * struct class - device classes
591 * @name: Name of the class.
592 * @owner: The module owner.
593 * @class_groups: Default attributes of this class.
594 * @dev_groups: Default attributes of the devices that belong to the class.
595 * @dev_kobj: The kobject that represents this class and links it into the hierarchy.
596 * @dev_uevent: Called when a device is added, removed from this class, or a
597 * few other things that generate uevents to add the environment
599 * @devnode: Callback to provide the devtmpfs.
600 * @class_release: Called to release this class.
601 * @dev_release: Called to release the device.
602 * @shutdown_pre: Called at shut-down time before driver shutdown.
603 * @ns_type: Callbacks so sysfs can detemine namespaces.
604 * @namespace: Namespace of the device belongs to this class.
605 * @get_ownership: Allows class to specify uid/gid of the sysfs directories
606 * for the devices belonging to the class. Usually tied to
607 * device's namespace.
608 * @pm: The default device power management operations of this class.
609 * @p: The private data of the driver core, no one other than the
610 * driver core can touch this.
612 * A class is a higher-level view of a device that abstracts out low-level
613 * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
614 * at the class level, they are all simply disks. Classes allow user space
615 * to work with devices based on what they do, rather than how they are
616 * connected or how they work.
620 struct module *owner;
622 const struct attribute_group **class_groups;
623 const struct attribute_group **dev_groups;
624 struct kobject *dev_kobj;
626 int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
627 char *(*devnode)(struct device *dev, umode_t *mode);
629 void (*class_release)(struct class *class);
630 void (*dev_release)(struct device *dev);
632 int (*shutdown_pre)(struct device *dev);
634 const struct kobj_ns_type_operations *ns_type;
635 const void *(*namespace)(struct device *dev);
637 void (*get_ownership)(struct device *dev, kuid_t *uid, kgid_t *gid);
639 const struct dev_pm_ops *pm;
641 struct subsys_private *p;
644 struct class_dev_iter {
645 struct klist_iter ki;
646 const struct device_type *type;
649 extern struct kobject *sysfs_dev_block_kobj;
650 extern struct kobject *sysfs_dev_char_kobj;
651 extern int __must_check __class_register(struct class *class,
652 struct lock_class_key *key);
653 extern void class_unregister(struct class *class);
655 /* This is a #define to keep the compiler from merging different
656 * instances of the __key variable */
657 #define class_register(class) \
659 static struct lock_class_key __key; \
660 __class_register(class, &__key); \
664 struct class_compat *class_compat_register(const char *name);
665 void class_compat_unregister(struct class_compat *cls);
666 int class_compat_create_link(struct class_compat *cls, struct device *dev,
667 struct device *device_link);
668 void class_compat_remove_link(struct class_compat *cls, struct device *dev,
669 struct device *device_link);
671 extern void class_dev_iter_init(struct class_dev_iter *iter,
673 struct device *start,
674 const struct device_type *type);
675 extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
676 extern void class_dev_iter_exit(struct class_dev_iter *iter);
678 extern int class_for_each_device(struct class *class, struct device *start,
680 int (*fn)(struct device *dev, void *data));
681 extern struct device *class_find_device(struct class *class,
682 struct device *start, const void *data,
683 int (*match)(struct device *, const void *));
686 * class_find_device_by_name - device iterator for locating a particular device
687 * of a specific name.
689 * @name: name of the device to match
691 static inline struct device *class_find_device_by_name(struct class *class,
694 return class_find_device(class, NULL, name, device_match_name);
698 * class_find_device_by_of_node : device iterator for locating a particular device
699 * matching the of_node.
701 * @np: of_node of the device to match.
703 static inline struct device *
704 class_find_device_by_of_node(struct class *class, const struct device_node *np)
706 return class_find_device(class, NULL, np, device_match_of_node);
710 * class_find_device_by_fwnode : device iterator for locating a particular device
711 * matching the fwnode.
713 * @fwnode: fwnode of the device to match.
715 static inline struct device *
716 class_find_device_by_fwnode(struct class *class,
717 const struct fwnode_handle *fwnode)
719 return class_find_device(class, NULL, fwnode, device_match_fwnode);
723 * class_find_device_by_devt : device iterator for locating a particular device
724 * matching the device type.
726 * @devt: device type of the device to match.
728 static inline struct device *class_find_device_by_devt(struct class *class,
731 return class_find_device(class, NULL, &devt, device_match_devt);
737 * class_find_device_by_acpi_dev : device iterator for locating a particular
738 * device matching the ACPI_COMPANION device.
740 * @adev: ACPI_COMPANION device to match.
742 static inline struct device *
743 class_find_device_by_acpi_dev(struct class *class, const struct acpi_device *adev)
745 return class_find_device(class, NULL, adev, device_match_acpi_dev);
748 static inline struct device *
749 class_find_device_by_acpi_dev(struct class *class, const void *adev)
755 struct class_attribute {
756 struct attribute attr;
757 ssize_t (*show)(struct class *class, struct class_attribute *attr,
759 ssize_t (*store)(struct class *class, struct class_attribute *attr,
760 const char *buf, size_t count);
763 #define CLASS_ATTR_RW(_name) \
764 struct class_attribute class_attr_##_name = __ATTR_RW(_name)
765 #define CLASS_ATTR_RO(_name) \
766 struct class_attribute class_attr_##_name = __ATTR_RO(_name)
767 #define CLASS_ATTR_WO(_name) \
768 struct class_attribute class_attr_##_name = __ATTR_WO(_name)
770 extern int __must_check class_create_file_ns(struct class *class,
771 const struct class_attribute *attr,
773 extern void class_remove_file_ns(struct class *class,
774 const struct class_attribute *attr,
777 static inline int __must_check class_create_file(struct class *class,
778 const struct class_attribute *attr)
780 return class_create_file_ns(class, attr, NULL);
783 static inline void class_remove_file(struct class *class,
784 const struct class_attribute *attr)
786 return class_remove_file_ns(class, attr, NULL);
789 /* Simple class attribute that is just a static string */
790 struct class_attribute_string {
791 struct class_attribute attr;
795 /* Currently read-only only */
796 #define _CLASS_ATTR_STRING(_name, _mode, _str) \
797 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
798 #define CLASS_ATTR_STRING(_name, _mode, _str) \
799 struct class_attribute_string class_attr_##_name = \
800 _CLASS_ATTR_STRING(_name, _mode, _str)
802 extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr,
805 struct class_interface {
806 struct list_head node;
809 int (*add_dev) (struct device *, struct class_interface *);
810 void (*remove_dev) (struct device *, struct class_interface *);
813 extern int __must_check class_interface_register(struct class_interface *);
814 extern void class_interface_unregister(struct class_interface *);
816 extern struct class * __must_check __class_create(struct module *owner,
818 struct lock_class_key *key);
819 extern void class_destroy(struct class *cls);
821 /* This is a #define to keep the compiler from merging different
822 * instances of the __key variable */
823 #define class_create(owner, name) \
825 static struct lock_class_key __key; \
826 __class_create(owner, name, &__key); \
830 * The type of device, "struct device" is embedded in. A class
831 * or bus can contain devices of different types
832 * like "partitions" and "disks", "mouse" and "event".
833 * This identifies the device type and carries type-specific
834 * information, equivalent to the kobj_type of a kobject.
835 * If "name" is specified, the uevent will contain it in
836 * the DEVTYPE variable.
840 const struct attribute_group **groups;
841 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
842 char *(*devnode)(struct device *dev, umode_t *mode,
843 kuid_t *uid, kgid_t *gid);
844 void (*release)(struct device *dev);
846 const struct dev_pm_ops *pm;
849 /* interface for exporting device attributes */
850 struct device_attribute {
851 struct attribute attr;
852 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
854 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
855 const char *buf, size_t count);
858 struct dev_ext_attribute {
859 struct device_attribute attr;
863 ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
865 ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
866 const char *buf, size_t count);
867 ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
869 ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
870 const char *buf, size_t count);
871 ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
873 ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
874 const char *buf, size_t count);
876 #define DEVICE_ATTR(_name, _mode, _show, _store) \
877 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
878 #define DEVICE_ATTR_PREALLOC(_name, _mode, _show, _store) \
879 struct device_attribute dev_attr_##_name = \
880 __ATTR_PREALLOC(_name, _mode, _show, _store)
881 #define DEVICE_ATTR_RW(_name) \
882 struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
883 #define DEVICE_ATTR_RO(_name) \
884 struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
885 #define DEVICE_ATTR_WO(_name) \
886 struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
887 #define DEVICE_ULONG_ATTR(_name, _mode, _var) \
888 struct dev_ext_attribute dev_attr_##_name = \
889 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
890 #define DEVICE_INT_ATTR(_name, _mode, _var) \
891 struct dev_ext_attribute dev_attr_##_name = \
892 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
893 #define DEVICE_BOOL_ATTR(_name, _mode, _var) \
894 struct dev_ext_attribute dev_attr_##_name = \
895 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
896 #define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
897 struct device_attribute dev_attr_##_name = \
898 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
900 extern int device_create_file(struct device *device,
901 const struct device_attribute *entry);
902 extern void device_remove_file(struct device *dev,
903 const struct device_attribute *attr);
904 extern bool device_remove_file_self(struct device *dev,
905 const struct device_attribute *attr);
906 extern int __must_check device_create_bin_file(struct device *dev,
907 const struct bin_attribute *attr);
908 extern void device_remove_bin_file(struct device *dev,
909 const struct bin_attribute *attr);
911 /* device resource management */
912 typedef void (*dr_release_t)(struct device *dev, void *res);
913 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
915 #ifdef CONFIG_DEBUG_DEVRES
916 extern void *__devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
917 int nid, const char *name) __malloc;
918 #define devres_alloc(release, size, gfp) \
919 __devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release)
920 #define devres_alloc_node(release, size, gfp, nid) \
921 __devres_alloc_node(release, size, gfp, nid, #release)
923 extern void *devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
925 static inline void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp)
927 return devres_alloc_node(release, size, gfp, NUMA_NO_NODE);
931 extern void devres_for_each_res(struct device *dev, dr_release_t release,
932 dr_match_t match, void *match_data,
933 void (*fn)(struct device *, void *, void *),
935 extern void devres_free(void *res);
936 extern void devres_add(struct device *dev, void *res);
937 extern void *devres_find(struct device *dev, dr_release_t release,
938 dr_match_t match, void *match_data);
939 extern void *devres_get(struct device *dev, void *new_res,
940 dr_match_t match, void *match_data);
941 extern void *devres_remove(struct device *dev, dr_release_t release,
942 dr_match_t match, void *match_data);
943 extern int devres_destroy(struct device *dev, dr_release_t release,
944 dr_match_t match, void *match_data);
945 extern int devres_release(struct device *dev, dr_release_t release,
946 dr_match_t match, void *match_data);
949 extern void * __must_check devres_open_group(struct device *dev, void *id,
951 extern void devres_close_group(struct device *dev, void *id);
952 extern void devres_remove_group(struct device *dev, void *id);
953 extern int devres_release_group(struct device *dev, void *id);
955 /* managed devm_k.alloc/kfree for device drivers */
956 extern void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp) __malloc;
957 extern __printf(3, 0)
958 char *devm_kvasprintf(struct device *dev, gfp_t gfp, const char *fmt,
959 va_list ap) __malloc;
960 extern __printf(3, 4)
961 char *devm_kasprintf(struct device *dev, gfp_t gfp, const char *fmt, ...) __malloc;
962 static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp)
964 return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
966 static inline void *devm_kmalloc_array(struct device *dev,
967 size_t n, size_t size, gfp_t flags)
971 if (unlikely(check_mul_overflow(n, size, &bytes)))
974 return devm_kmalloc(dev, bytes, flags);
976 static inline void *devm_kcalloc(struct device *dev,
977 size_t n, size_t size, gfp_t flags)
979 return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
981 extern void devm_kfree(struct device *dev, const void *p);
982 extern char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp) __malloc;
983 extern const char *devm_kstrdup_const(struct device *dev,
984 const char *s, gfp_t gfp);
985 extern void *devm_kmemdup(struct device *dev, const void *src, size_t len,
988 extern unsigned long devm_get_free_pages(struct device *dev,
989 gfp_t gfp_mask, unsigned int order);
990 extern void devm_free_pages(struct device *dev, unsigned long addr);
992 void __iomem *devm_ioremap_resource(struct device *dev,
993 const struct resource *res);
995 void __iomem *devm_of_iomap(struct device *dev,
996 struct device_node *node, int index,
997 resource_size_t *size);
999 /* allows to add/remove a custom action to devres stack */
1000 int devm_add_action(struct device *dev, void (*action)(void *), void *data);
1001 void devm_remove_action(struct device *dev, void (*action)(void *), void *data);
1002 void devm_release_action(struct device *dev, void (*action)(void *), void *data);
1004 static inline int devm_add_action_or_reset(struct device *dev,
1005 void (*action)(void *), void *data)
1009 ret = devm_add_action(dev, action, data);
1017 * devm_alloc_percpu - Resource-managed alloc_percpu
1018 * @dev: Device to allocate per-cpu memory for
1019 * @type: Type to allocate per-cpu memory for
1021 * Managed alloc_percpu. Per-cpu memory allocated with this function is
1022 * automatically freed on driver detach.
1025 * Pointer to allocated memory on success, NULL on failure.
1027 #define devm_alloc_percpu(dev, type) \
1028 ((typeof(type) __percpu *)__devm_alloc_percpu((dev), sizeof(type), \
1031 void __percpu *__devm_alloc_percpu(struct device *dev, size_t size,
1033 void devm_free_percpu(struct device *dev, void __percpu *pdata);
1035 struct device_dma_parameters {
1037 * a low level driver may set these to teach IOMMU code about
1040 unsigned int max_segment_size;
1041 unsigned long segment_boundary_mask;
1045 * struct device_connection - Device Connection Descriptor
1046 * @fwnode: The device node of the connected device
1047 * @endpoint: The names of the two devices connected together
1048 * @id: Unique identifier for the connection
1049 * @list: List head, private, for internal use only
1051 * NOTE: @fwnode is not used together with @endpoint. @fwnode is used when
1052 * platform firmware defines the connection. When the connection is registered
1053 * with device_connection_add() @endpoint is used instead.
1055 struct device_connection {
1056 struct fwnode_handle *fwnode;
1057 const char *endpoint[2];
1059 struct list_head list;
1062 void *device_connection_find_match(struct device *dev, const char *con_id,
1064 void *(*match)(struct device_connection *con,
1065 int ep, void *data));
1067 struct device *device_connection_find(struct device *dev, const char *con_id);
1069 void device_connection_add(struct device_connection *con);
1070 void device_connection_remove(struct device_connection *con);
1073 * device_connections_add - Add multiple device connections at once
1074 * @cons: Zero terminated array of device connection descriptors
1076 static inline void device_connections_add(struct device_connection *cons)
1078 struct device_connection *c;
1080 for (c = cons; c->endpoint[0]; c++)
1081 device_connection_add(c);
1085 * device_connections_remove - Remove multiple device connections at once
1086 * @cons: Zero terminated array of device connection descriptors
1088 static inline void device_connections_remove(struct device_connection *cons)
1090 struct device_connection *c;
1092 for (c = cons; c->endpoint[0]; c++)
1093 device_connection_remove(c);
1097 * enum device_link_state - Device link states.
1098 * @DL_STATE_NONE: The presence of the drivers is not being tracked.
1099 * @DL_STATE_DORMANT: None of the supplier/consumer drivers is present.
1100 * @DL_STATE_AVAILABLE: The supplier driver is present, but the consumer is not.
1101 * @DL_STATE_CONSUMER_PROBE: The consumer is probing (supplier driver present).
1102 * @DL_STATE_ACTIVE: Both the supplier and consumer drivers are present.
1103 * @DL_STATE_SUPPLIER_UNBIND: The supplier driver is unbinding.
1105 enum device_link_state {
1107 DL_STATE_DORMANT = 0,
1109 DL_STATE_CONSUMER_PROBE,
1111 DL_STATE_SUPPLIER_UNBIND,
1115 * Device link flags.
1117 * STATELESS: The core will not remove this link automatically.
1118 * AUTOREMOVE_CONSUMER: Remove the link automatically on consumer driver unbind.
1119 * PM_RUNTIME: If set, the runtime PM framework will use this link.
1120 * RPM_ACTIVE: Run pm_runtime_get_sync() on the supplier during link creation.
1121 * AUTOREMOVE_SUPPLIER: Remove the link automatically on supplier driver unbind.
1122 * AUTOPROBE_CONSUMER: Probe consumer driver automatically after supplier binds.
1123 * MANAGED: The core tracks presence of supplier/consumer drivers (internal).
1125 #define DL_FLAG_STATELESS BIT(0)
1126 #define DL_FLAG_AUTOREMOVE_CONSUMER BIT(1)
1127 #define DL_FLAG_PM_RUNTIME BIT(2)
1128 #define DL_FLAG_RPM_ACTIVE BIT(3)
1129 #define DL_FLAG_AUTOREMOVE_SUPPLIER BIT(4)
1130 #define DL_FLAG_AUTOPROBE_CONSUMER BIT(5)
1131 #define DL_FLAG_MANAGED BIT(6)
1134 * struct device_link - Device link representation.
1135 * @supplier: The device on the supplier end of the link.
1136 * @s_node: Hook to the supplier device's list of links to consumers.
1137 * @consumer: The device on the consumer end of the link.
1138 * @c_node: Hook to the consumer device's list of links to suppliers.
1139 * @status: The state of the link (with respect to the presence of drivers).
1140 * @flags: Link flags.
1141 * @rpm_active: Whether or not the consumer device is runtime-PM-active.
1142 * @kref: Count repeated addition of the same link.
1143 * @rcu_head: An RCU head to use for deferred execution of SRCU callbacks.
1144 * @supplier_preactivated: Supplier has been made active before consumer probe.
1146 struct device_link {
1147 struct device *supplier;
1148 struct list_head s_node;
1149 struct device *consumer;
1150 struct list_head c_node;
1151 enum device_link_state status;
1153 refcount_t rpm_active;
1156 struct rcu_head rcu_head;
1158 bool supplier_preactivated; /* Owned by consumer probe. */
1162 * enum dl_dev_state - Device driver presence tracking information.
1163 * @DL_DEV_NO_DRIVER: There is no driver attached to the device.
1164 * @DL_DEV_PROBING: A driver is probing.
1165 * @DL_DEV_DRIVER_BOUND: The driver has been bound to the device.
1166 * @DL_DEV_UNBINDING: The driver is unbinding from the device.
1169 DL_DEV_NO_DRIVER = 0,
1171 DL_DEV_DRIVER_BOUND,
1176 * struct dev_links_info - Device data related to device links.
1177 * @suppliers: List of links to supplier devices.
1178 * @consumers: List of links to consumer devices.
1179 * @needs_suppliers: Hook to global list of devices waiting for suppliers.
1180 * @defer_sync: Hook to global list of devices that have deferred sync_state.
1181 * @status: Driver status information.
1183 struct dev_links_info {
1184 struct list_head suppliers;
1185 struct list_head consumers;
1186 struct list_head needs_suppliers;
1187 struct list_head defer_sync;
1188 enum dl_dev_state status;
1192 * struct device - The basic device structure
1193 * @parent: The device's "parent" device, the device to which it is attached.
1194 * In most cases, a parent device is some sort of bus or host
1195 * controller. If parent is NULL, the device, is a top-level device,
1196 * which is not usually what you want.
1197 * @p: Holds the private data of the driver core portions of the device.
1198 * See the comment of the struct device_private for detail.
1199 * @kobj: A top-level, abstract class from which other classes are derived.
1200 * @init_name: Initial name of the device.
1201 * @type: The type of device.
1202 * This identifies the device type and carries type-specific
1204 * @mutex: Mutex to synchronize calls to its driver.
1205 * @lockdep_mutex: An optional debug lock that a subsystem can use as a
1206 * peer lock to gain localized lockdep coverage of the device_lock.
1207 * @bus: Type of bus device is on.
1208 * @driver: Which driver has allocated this
1209 * @platform_data: Platform data specific to the device.
1210 * Example: For devices on custom boards, as typical of embedded
1211 * and SOC based hardware, Linux often uses platform_data to point
1212 * to board-specific structures describing devices and how they
1213 * are wired. That can include what ports are available, chip
1214 * variants, which GPIO pins act in what additional roles, and so
1215 * on. This shrinks the "Board Support Packages" (BSPs) and
1216 * minimizes board-specific #ifdefs in drivers.
1217 * @driver_data: Private pointer for driver specific info.
1218 * @links: Links to suppliers and consumers of this device.
1219 * @power: For device power management.
1220 * See Documentation/driver-api/pm/devices.rst for details.
1221 * @pm_domain: Provide callbacks that are executed during system suspend,
1222 * hibernation, system resume and during runtime PM transitions
1223 * along with subsystem-level and driver-level callbacks.
1224 * @pins: For device pin management.
1225 * See Documentation/driver-api/pinctl.rst for details.
1226 * @msi_list: Hosts MSI descriptors
1227 * @msi_domain: The generic MSI domain this device is using.
1228 * @numa_node: NUMA node this device is close to.
1229 * @dma_ops: DMA mapping operations for this device.
1230 * @dma_mask: Dma mask (if dma'ble device).
1231 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
1232 * hardware supports 64-bit addresses for consistent allocations
1234 * @bus_dma_mask: Mask of an upstream bridge or bus which imposes a smaller DMA
1235 * limit than the device itself supports.
1236 * @dma_pfn_offset: offset of DMA memory range relatively of RAM
1237 * @dma_parms: A low level driver may set these to teach IOMMU code about
1238 * segment limitations.
1239 * @dma_pools: Dma pools (if dma'ble device).
1240 * @dma_mem: Internal for coherent mem override.
1241 * @cma_area: Contiguous memory area for dma allocations
1242 * @archdata: For arch-specific additions.
1243 * @of_node: Associated device tree node.
1244 * @fwnode: Associated device node supplied by platform firmware.
1245 * @devt: For creating the sysfs "dev".
1246 * @id: device instance
1247 * @devres_lock: Spinlock to protect the resource of the device.
1248 * @devres_head: The resources list of the device.
1249 * @knode_class: The node used to add the device to the class list.
1250 * @class: The class of the device.
1251 * @groups: Optional attribute groups.
1252 * @release: Callback to free the device after all references have
1253 * gone away. This should be set by the allocator of the
1254 * device (i.e. the bus driver that discovered the device).
1255 * @iommu_group: IOMMU group the device belongs to.
1256 * @iommu_fwspec: IOMMU-specific properties supplied by firmware.
1257 * @iommu_param: Per device generic IOMMU runtime data
1259 * @offline_disabled: If set, the device is permanently online.
1260 * @offline: Set after successful invocation of bus type's .offline().
1261 * @of_node_reused: Set if the device-tree node is shared with an ancestor
1263 * @has_edit_links: This device has a driver than is capable of
1264 * editing the device links created by driver core.
1265 * @state_synced: The hardware state of this device has been synced to match
1266 * the software state of this device by calling the driver/bus
1267 * sync_state() callback.
1268 * @dma_coherent: this particular device is dma coherent, even if the
1269 * architecture supports non-coherent devices.
1271 * At the lowest level, every device in a Linux system is represented by an
1272 * instance of struct device. The device structure contains the information
1273 * that the device model core needs to model the system. Most subsystems,
1274 * however, track additional information about the devices they host. As a
1275 * result, it is rare for devices to be represented by bare device structures;
1276 * instead, that structure, like kobject structures, is usually embedded within
1277 * a higher-level representation of the device.
1280 struct kobject kobj;
1281 struct device *parent;
1283 struct device_private *p;
1285 const char *init_name; /* initial name of the device */
1286 const struct device_type *type;
1288 struct bus_type *bus; /* type of bus device is on */
1289 struct device_driver *driver; /* which driver has allocated this
1291 void *platform_data; /* Platform specific data, device
1292 core doesn't touch it */
1293 void *driver_data; /* Driver data, set and get with
1294 dev_set_drvdata/dev_get_drvdata */
1295 #ifdef CONFIG_PROVE_LOCKING
1296 struct mutex lockdep_mutex;
1298 struct mutex mutex; /* mutex to synchronize calls to
1302 struct dev_links_info links;
1303 struct dev_pm_info power;
1304 struct dev_pm_domain *pm_domain;
1306 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
1307 struct irq_domain *msi_domain;
1309 #ifdef CONFIG_PINCTRL
1310 struct dev_pin_info *pins;
1312 #ifdef CONFIG_GENERIC_MSI_IRQ
1313 struct list_head msi_list;
1316 const struct dma_map_ops *dma_ops;
1317 u64 *dma_mask; /* dma mask (if dma'able device) */
1318 u64 coherent_dma_mask;/* Like dma_mask, but for
1319 alloc_coherent mappings as
1320 not all hardware supports
1321 64 bit addresses for consistent
1322 allocations such descriptors. */
1323 u64 bus_dma_mask; /* upstream dma_mask constraint */
1324 unsigned long dma_pfn_offset;
1326 struct device_dma_parameters *dma_parms;
1328 struct list_head dma_pools; /* dma pools (if dma'ble) */
1330 #ifdef CONFIG_DMA_DECLARE_COHERENT
1331 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
1334 #ifdef CONFIG_DMA_CMA
1335 struct cma *cma_area; /* contiguous memory area for dma
1338 /* arch specific additions */
1339 struct dev_archdata archdata;
1341 struct device_node *of_node; /* associated device tree node */
1342 struct fwnode_handle *fwnode; /* firmware device node */
1345 int numa_node; /* NUMA node this device is close to */
1347 dev_t devt; /* dev_t, creates the sysfs "dev" */
1348 u32 id; /* device instance */
1350 spinlock_t devres_lock;
1351 struct list_head devres_head;
1353 struct class *class;
1354 const struct attribute_group **groups; /* optional groups */
1356 void (*release)(struct device *dev);
1357 struct iommu_group *iommu_group;
1358 struct iommu_fwspec *iommu_fwspec;
1359 struct iommu_param *iommu_param;
1361 bool offline_disabled:1;
1363 bool of_node_reused:1;
1364 bool has_edit_links:1;
1365 bool state_synced:1;
1366 #if defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_DEVICE) || \
1367 defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU) || \
1368 defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU_ALL)
1369 bool dma_coherent:1;
1373 static inline struct device *kobj_to_dev(struct kobject *kobj)
1375 return container_of(kobj, struct device, kobj);
1379 * device_iommu_mapped - Returns true when the device DMA is translated
1381 * @dev: Device to perform the check on
1383 static inline bool device_iommu_mapped(struct device *dev)
1385 return (dev->iommu_group != NULL);
1388 /* Get the wakeup routines, which depend on struct device */
1389 #include <linux/pm_wakeup.h>
1391 static inline const char *dev_name(const struct device *dev)
1393 /* Use the init name until the kobject becomes available */
1395 return dev->init_name;
1397 return kobject_name(&dev->kobj);
1400 extern __printf(2, 3)
1401 int dev_set_name(struct device *dev, const char *name, ...);
1404 static inline int dev_to_node(struct device *dev)
1406 return dev->numa_node;
1408 static inline void set_dev_node(struct device *dev, int node)
1410 dev->numa_node = node;
1413 static inline int dev_to_node(struct device *dev)
1415 return NUMA_NO_NODE;
1417 static inline void set_dev_node(struct device *dev, int node)
1422 static inline struct irq_domain *dev_get_msi_domain(const struct device *dev)
1424 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
1425 return dev->msi_domain;
1431 static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d)
1433 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
1434 dev->msi_domain = d;
1438 static inline void *dev_get_drvdata(const struct device *dev)
1440 return dev->driver_data;
1443 static inline void dev_set_drvdata(struct device *dev, void *data)
1445 dev->driver_data = data;
1448 static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
1450 return dev ? dev->power.subsys_data : NULL;
1453 static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
1455 return dev->kobj.uevent_suppress;
1458 static inline void dev_set_uevent_suppress(struct device *dev, int val)
1460 dev->kobj.uevent_suppress = val;
1463 static inline int device_is_registered(struct device *dev)
1465 return dev->kobj.state_in_sysfs;
1468 static inline void device_enable_async_suspend(struct device *dev)
1470 if (!dev->power.is_prepared)
1471 dev->power.async_suspend = true;
1474 static inline void device_disable_async_suspend(struct device *dev)
1476 if (!dev->power.is_prepared)
1477 dev->power.async_suspend = false;
1480 static inline bool device_async_suspend_enabled(struct device *dev)
1482 return !!dev->power.async_suspend;
1485 static inline bool device_pm_not_required(struct device *dev)
1487 return dev->power.no_pm;
1490 static inline void device_set_pm_not_required(struct device *dev)
1492 dev->power.no_pm = true;
1495 static inline void dev_pm_syscore_device(struct device *dev, bool val)
1497 #ifdef CONFIG_PM_SLEEP
1498 dev->power.syscore = val;
1502 static inline void dev_pm_set_driver_flags(struct device *dev, u32 flags)
1504 dev->power.driver_flags = flags;
1507 static inline bool dev_pm_test_driver_flags(struct device *dev, u32 flags)
1509 return !!(dev->power.driver_flags & flags);
1512 static inline void device_lock(struct device *dev)
1514 mutex_lock(&dev->mutex);
1517 static inline int device_lock_interruptible(struct device *dev)
1519 return mutex_lock_interruptible(&dev->mutex);
1522 static inline int device_trylock(struct device *dev)
1524 return mutex_trylock(&dev->mutex);
1527 static inline void device_unlock(struct device *dev)
1529 mutex_unlock(&dev->mutex);
1532 static inline void device_lock_assert(struct device *dev)
1534 lockdep_assert_held(&dev->mutex);
1537 static inline struct device_node *dev_of_node(struct device *dev)
1539 if (!IS_ENABLED(CONFIG_OF) || !dev)
1541 return dev->of_node;
1544 void driver_init(void);
1547 * High level routines for use by the bus drivers
1549 extern int __must_check device_register(struct device *dev);
1550 extern void device_unregister(struct device *dev);
1551 extern void device_initialize(struct device *dev);
1552 extern int __must_check device_add(struct device *dev);
1553 extern void device_del(struct device *dev);
1554 extern int device_for_each_child(struct device *dev, void *data,
1555 int (*fn)(struct device *dev, void *data));
1556 extern int device_for_each_child_reverse(struct device *dev, void *data,
1557 int (*fn)(struct device *dev, void *data));
1558 extern struct device *device_find_child(struct device *dev, void *data,
1559 int (*match)(struct device *dev, void *data));
1560 extern struct device *device_find_child_by_name(struct device *parent,
1562 extern int device_rename(struct device *dev, const char *new_name);
1563 extern int device_move(struct device *dev, struct device *new_parent,
1564 enum dpm_order dpm_order);
1565 extern const char *device_get_devnode(struct device *dev,
1566 umode_t *mode, kuid_t *uid, kgid_t *gid,
1569 static inline bool device_supports_offline(struct device *dev)
1571 return dev->bus && dev->bus->offline && dev->bus->online;
1574 extern void lock_device_hotplug(void);
1575 extern void unlock_device_hotplug(void);
1576 extern int lock_device_hotplug_sysfs(void);
1577 extern int device_offline(struct device *dev);
1578 extern int device_online(struct device *dev);
1579 extern void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1580 extern void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1581 void device_set_of_node_from_dev(struct device *dev, const struct device *dev2);
1583 static inline int dev_num_vf(struct device *dev)
1585 if (dev->bus && dev->bus->num_vf)
1586 return dev->bus->num_vf(dev);
1591 * Root device objects for grouping under /sys/devices
1593 extern struct device *__root_device_register(const char *name,
1594 struct module *owner);
1596 /* This is a macro to avoid include problems with THIS_MODULE */
1597 #define root_device_register(name) \
1598 __root_device_register(name, THIS_MODULE)
1600 extern void root_device_unregister(struct device *root);
1602 static inline void *dev_get_platdata(const struct device *dev)
1604 return dev->platform_data;
1608 * Manual binding of a device to driver. See drivers/base/bus.c
1609 * for information on use.
1611 extern int __must_check device_bind_driver(struct device *dev);
1612 extern void device_release_driver(struct device *dev);
1613 extern int __must_check device_attach(struct device *dev);
1614 extern int __must_check driver_attach(struct device_driver *drv);
1615 extern void device_initial_probe(struct device *dev);
1616 extern int __must_check device_reprobe(struct device *dev);
1617 extern int driver_edit_links(struct device *dev);
1619 extern bool device_is_bound(struct device *dev);
1622 * Easy functions for dynamically creating devices on the fly
1624 extern __printf(5, 0)
1625 struct device *device_create_vargs(struct class *cls, struct device *parent,
1626 dev_t devt, void *drvdata,
1627 const char *fmt, va_list vargs);
1628 extern __printf(5, 6)
1629 struct device *device_create(struct class *cls, struct device *parent,
1630 dev_t devt, void *drvdata,
1631 const char *fmt, ...);
1632 extern __printf(6, 7)
1633 struct device *device_create_with_groups(struct class *cls,
1634 struct device *parent, dev_t devt, void *drvdata,
1635 const struct attribute_group **groups,
1636 const char *fmt, ...);
1637 extern void device_destroy(struct class *cls, dev_t devt);
1639 extern int __must_check device_add_groups(struct device *dev,
1640 const struct attribute_group **groups);
1641 extern void device_remove_groups(struct device *dev,
1642 const struct attribute_group **groups);
1644 static inline int __must_check device_add_group(struct device *dev,
1645 const struct attribute_group *grp)
1647 const struct attribute_group *groups[] = { grp, NULL };
1649 return device_add_groups(dev, groups);
1652 static inline void device_remove_group(struct device *dev,
1653 const struct attribute_group *grp)
1655 const struct attribute_group *groups[] = { grp, NULL };
1657 return device_remove_groups(dev, groups);
1660 extern int __must_check devm_device_add_groups(struct device *dev,
1661 const struct attribute_group **groups);
1662 extern void devm_device_remove_groups(struct device *dev,
1663 const struct attribute_group **groups);
1664 extern int __must_check devm_device_add_group(struct device *dev,
1665 const struct attribute_group *grp);
1666 extern void devm_device_remove_group(struct device *dev,
1667 const struct attribute_group *grp);
1670 * Platform "fixup" functions - allow the platform to have their say
1671 * about devices and actions that the general device layer doesn't
1674 /* Notify platform of device discovery */
1675 extern int (*platform_notify)(struct device *dev);
1677 extern int (*platform_notify_remove)(struct device *dev);
1681 * get_device - atomically increment the reference count for the device.
1684 extern struct device *get_device(struct device *dev);
1685 extern void put_device(struct device *dev);
1686 extern bool kill_device(struct device *dev);
1688 #ifdef CONFIG_DEVTMPFS
1689 extern int devtmpfs_create_node(struct device *dev);
1690 extern int devtmpfs_delete_node(struct device *dev);
1691 extern int devtmpfs_mount(const char *mntdir);
1693 static inline int devtmpfs_create_node(struct device *dev) { return 0; }
1694 static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
1695 static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
1698 /* drivers/base/power/shutdown.c */
1699 extern void device_shutdown(void);
1701 /* debugging and troubleshooting/diagnostic helpers. */
1702 extern const char *dev_driver_string(const struct device *dev);
1704 /* Device links interface. */
1705 struct device_link *device_link_add(struct device *consumer,
1706 struct device *supplier, u32 flags);
1707 void device_link_del(struct device_link *link);
1708 void device_link_remove(void *consumer, struct device *supplier);
1709 void device_link_remove_from_wfs(struct device *consumer);
1710 void device_links_supplier_sync_state_pause(void);
1711 void device_links_supplier_sync_state_resume(void);
1714 #define dev_fmt(fmt) fmt
1717 #ifdef CONFIG_PRINTK
1719 __printf(3, 0) __cold
1720 int dev_vprintk_emit(int level, const struct device *dev,
1721 const char *fmt, va_list args);
1722 __printf(3, 4) __cold
1723 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...);
1725 __printf(3, 4) __cold
1726 void dev_printk(const char *level, const struct device *dev,
1727 const char *fmt, ...);
1728 __printf(2, 3) __cold
1729 void _dev_emerg(const struct device *dev, const char *fmt, ...);
1730 __printf(2, 3) __cold
1731 void _dev_alert(const struct device *dev, const char *fmt, ...);
1732 __printf(2, 3) __cold
1733 void _dev_crit(const struct device *dev, const char *fmt, ...);
1734 __printf(2, 3) __cold
1735 void _dev_err(const struct device *dev, const char *fmt, ...);
1736 __printf(2, 3) __cold
1737 void _dev_warn(const struct device *dev, const char *fmt, ...);
1738 __printf(2, 3) __cold
1739 void _dev_notice(const struct device *dev, const char *fmt, ...);
1740 __printf(2, 3) __cold
1741 void _dev_info(const struct device *dev, const char *fmt, ...);
1745 static inline __printf(3, 0)
1746 int dev_vprintk_emit(int level, const struct device *dev,
1747 const char *fmt, va_list args)
1749 static inline __printf(3, 4)
1750 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
1753 static inline void __dev_printk(const char *level, const struct device *dev,
1754 struct va_format *vaf)
1756 static inline __printf(3, 4)
1757 void dev_printk(const char *level, const struct device *dev,
1758 const char *fmt, ...)
1761 static inline __printf(2, 3)
1762 void _dev_emerg(const struct device *dev, const char *fmt, ...)
1764 static inline __printf(2, 3)
1765 void _dev_crit(const struct device *dev, const char *fmt, ...)
1767 static inline __printf(2, 3)
1768 void _dev_alert(const struct device *dev, const char *fmt, ...)
1770 static inline __printf(2, 3)
1771 void _dev_err(const struct device *dev, const char *fmt, ...)
1773 static inline __printf(2, 3)
1774 void _dev_warn(const struct device *dev, const char *fmt, ...)
1776 static inline __printf(2, 3)
1777 void _dev_notice(const struct device *dev, const char *fmt, ...)
1779 static inline __printf(2, 3)
1780 void _dev_info(const struct device *dev, const char *fmt, ...)
1786 * #defines for all the dev_<level> macros to prefix with whatever
1787 * possible use of #define dev_fmt(fmt) ...
1790 #define dev_emerg(dev, fmt, ...) \
1791 _dev_emerg(dev, dev_fmt(fmt), ##__VA_ARGS__)
1792 #define dev_crit(dev, fmt, ...) \
1793 _dev_crit(dev, dev_fmt(fmt), ##__VA_ARGS__)
1794 #define dev_alert(dev, fmt, ...) \
1795 _dev_alert(dev, dev_fmt(fmt), ##__VA_ARGS__)
1796 #define dev_err(dev, fmt, ...) \
1797 _dev_err(dev, dev_fmt(fmt), ##__VA_ARGS__)
1798 #define dev_warn(dev, fmt, ...) \
1799 _dev_warn(dev, dev_fmt(fmt), ##__VA_ARGS__)
1800 #define dev_notice(dev, fmt, ...) \
1801 _dev_notice(dev, dev_fmt(fmt), ##__VA_ARGS__)
1802 #define dev_info(dev, fmt, ...) \
1803 _dev_info(dev, dev_fmt(fmt), ##__VA_ARGS__)
1805 #if defined(CONFIG_DYNAMIC_DEBUG)
1806 #define dev_dbg(dev, fmt, ...) \
1807 dynamic_dev_dbg(dev, dev_fmt(fmt), ##__VA_ARGS__)
1808 #elif defined(DEBUG)
1809 #define dev_dbg(dev, fmt, ...) \
1810 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__)
1812 #define dev_dbg(dev, fmt, ...) \
1815 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \
1819 #ifdef CONFIG_PRINTK
1820 #define dev_level_once(dev_level, dev, fmt, ...) \
1822 static bool __print_once __read_mostly; \
1824 if (!__print_once) { \
1825 __print_once = true; \
1826 dev_level(dev, fmt, ##__VA_ARGS__); \
1830 #define dev_level_once(dev_level, dev, fmt, ...) \
1833 dev_level(dev, fmt, ##__VA_ARGS__); \
1837 #define dev_emerg_once(dev, fmt, ...) \
1838 dev_level_once(dev_emerg, dev, fmt, ##__VA_ARGS__)
1839 #define dev_alert_once(dev, fmt, ...) \
1840 dev_level_once(dev_alert, dev, fmt, ##__VA_ARGS__)
1841 #define dev_crit_once(dev, fmt, ...) \
1842 dev_level_once(dev_crit, dev, fmt, ##__VA_ARGS__)
1843 #define dev_err_once(dev, fmt, ...) \
1844 dev_level_once(dev_err, dev, fmt, ##__VA_ARGS__)
1845 #define dev_warn_once(dev, fmt, ...) \
1846 dev_level_once(dev_warn, dev, fmt, ##__VA_ARGS__)
1847 #define dev_notice_once(dev, fmt, ...) \
1848 dev_level_once(dev_notice, dev, fmt, ##__VA_ARGS__)
1849 #define dev_info_once(dev, fmt, ...) \
1850 dev_level_once(dev_info, dev, fmt, ##__VA_ARGS__)
1851 #define dev_dbg_once(dev, fmt, ...) \
1852 dev_level_once(dev_dbg, dev, fmt, ##__VA_ARGS__)
1854 #define dev_level_ratelimited(dev_level, dev, fmt, ...) \
1856 static DEFINE_RATELIMIT_STATE(_rs, \
1857 DEFAULT_RATELIMIT_INTERVAL, \
1858 DEFAULT_RATELIMIT_BURST); \
1859 if (__ratelimit(&_rs)) \
1860 dev_level(dev, fmt, ##__VA_ARGS__); \
1863 #define dev_emerg_ratelimited(dev, fmt, ...) \
1864 dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
1865 #define dev_alert_ratelimited(dev, fmt, ...) \
1866 dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
1867 #define dev_crit_ratelimited(dev, fmt, ...) \
1868 dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
1869 #define dev_err_ratelimited(dev, fmt, ...) \
1870 dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
1871 #define dev_warn_ratelimited(dev, fmt, ...) \
1872 dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
1873 #define dev_notice_ratelimited(dev, fmt, ...) \
1874 dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
1875 #define dev_info_ratelimited(dev, fmt, ...) \
1876 dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
1877 #if defined(CONFIG_DYNAMIC_DEBUG)
1878 /* descriptor check is first to prevent flooding with "callbacks suppressed" */
1879 #define dev_dbg_ratelimited(dev, fmt, ...) \
1881 static DEFINE_RATELIMIT_STATE(_rs, \
1882 DEFAULT_RATELIMIT_INTERVAL, \
1883 DEFAULT_RATELIMIT_BURST); \
1884 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
1885 if (DYNAMIC_DEBUG_BRANCH(descriptor) && \
1886 __ratelimit(&_rs)) \
1887 __dynamic_dev_dbg(&descriptor, dev, dev_fmt(fmt), \
1890 #elif defined(DEBUG)
1891 #define dev_dbg_ratelimited(dev, fmt, ...) \
1893 static DEFINE_RATELIMIT_STATE(_rs, \
1894 DEFAULT_RATELIMIT_INTERVAL, \
1895 DEFAULT_RATELIMIT_BURST); \
1896 if (__ratelimit(&_rs)) \
1897 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \
1900 #define dev_dbg_ratelimited(dev, fmt, ...) \
1903 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \
1907 #ifdef VERBOSE_DEBUG
1908 #define dev_vdbg dev_dbg
1910 #define dev_vdbg(dev, fmt, ...) \
1913 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \
1918 * dev_WARN*() acts like dev_printk(), but with the key difference of
1919 * using WARN/WARN_ONCE to include file/line information and a backtrace.
1921 #define dev_WARN(dev, format, arg...) \
1922 WARN(1, "%s %s: " format, dev_driver_string(dev), dev_name(dev), ## arg);
1924 #define dev_WARN_ONCE(dev, condition, format, arg...) \
1925 WARN_ONCE(condition, "%s %s: " format, \
1926 dev_driver_string(dev), dev_name(dev), ## arg)
1928 /* Create alias, so I can be autoloaded. */
1929 #define MODULE_ALIAS_CHARDEV(major,minor) \
1930 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1931 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1932 MODULE_ALIAS("char-major-" __stringify(major) "-*")
1934 #ifdef CONFIG_SYSFS_DEPRECATED
1935 extern long sysfs_deprecated;
1937 #define sysfs_deprecated 0
1941 * module_driver() - Helper macro for drivers that don't do anything
1942 * special in module init/exit. This eliminates a lot of boilerplate.
1943 * Each module may only use this macro once, and calling it replaces
1944 * module_init() and module_exit().
1946 * @__driver: driver name
1947 * @__register: register function for this driver type
1948 * @__unregister: unregister function for this driver type
1949 * @...: Additional arguments to be passed to __register and __unregister.
1951 * Use this macro to construct bus specific macros for registering
1952 * drivers, and do not use it on its own.
1954 #define module_driver(__driver, __register, __unregister, ...) \
1955 static int __init __driver##_init(void) \
1957 return __register(&(__driver) , ##__VA_ARGS__); \
1959 module_init(__driver##_init); \
1960 static void __exit __driver##_exit(void) \
1962 __unregister(&(__driver) , ##__VA_ARGS__); \
1964 module_exit(__driver##_exit);
1967 * builtin_driver() - Helper macro for drivers that don't do anything
1968 * special in init and have no exit. This eliminates some boilerplate.
1969 * Each driver may only use this macro once, and calling it replaces
1970 * device_initcall (or in some cases, the legacy __initcall). This is
1971 * meant to be a direct parallel of module_driver() above but without
1972 * the __exit stuff that is not used for builtin cases.
1974 * @__driver: driver name
1975 * @__register: register function for this driver type
1976 * @...: Additional arguments to be passed to __register
1978 * Use this macro to construct bus specific macros for registering
1979 * drivers, and do not use it on its own.
1981 #define builtin_driver(__driver, __register, ...) \
1982 static int __init __driver##_init(void) \
1984 return __register(&(__driver) , ##__VA_ARGS__); \
1986 device_initcall(__driver##_init);
1988 #endif /* _DEVICE_H_ */