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.
88 * Return 0 if device links have been successfully created to all
89 * the suppliers of this device. Return an error if some of the
90 * suppliers are not yet available and this function needs to be
91 * reattempted in the future.
92 * @probe: Called when a new device or driver add to this bus, and callback
93 * the specific driver's probe to initial the matched device.
94 * @remove: Called when a device removed from this bus.
95 * @shutdown: Called at shut-down time to quiesce the device.
97 * @online: Called to put the device back online (after offlining it).
98 * @offline: Called to put the device offline for hot-removal. May fail.
100 * @suspend: Called when a device on this bus wants to go to sleep mode.
101 * @resume: Called to bring a device on this bus out of sleep mode.
102 * @num_vf: Called to find out how many virtual functions a device on this
104 * @dma_configure: Called to setup DMA configuration on a device on
106 * @pm: Power management operations of this bus, callback the specific
107 * device driver's pm-ops.
108 * @iommu_ops: IOMMU specific operations for this bus, used to attach IOMMU
109 * driver implementations to a bus and allow the driver to do
111 * @p: The private data of the driver core, only the driver core can
113 * @lock_key: Lock class key for use by the lock validator
114 * @need_parent_lock: When probing or removing a device on this bus, the
115 * device core should lock the device's parent.
117 * A bus is a channel between the processor and one or more devices. For the
118 * purposes of the device model, all devices are connected via a bus, even if
119 * it is an internal, virtual, "platform" bus. Buses can plug into each other.
120 * A USB controller is usually a PCI device, for example. The device model
121 * represents the actual connections between buses and the devices they control.
122 * A bus is represented by the bus_type structure. It contains the name, the
123 * default attributes, the bus' methods, PM operations, and the driver core's
128 const char *dev_name;
129 struct device *dev_root;
130 const struct attribute_group **bus_groups;
131 const struct attribute_group **dev_groups;
132 const struct attribute_group **drv_groups;
134 int (*match)(struct device *dev, struct device_driver *drv);
135 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
136 int (*add_links)(struct device *dev);
137 int (*probe)(struct device *dev);
138 int (*remove)(struct device *dev);
139 void (*shutdown)(struct device *dev);
141 int (*online)(struct device *dev);
142 int (*offline)(struct device *dev);
144 int (*suspend)(struct device *dev, pm_message_t state);
145 int (*resume)(struct device *dev);
147 int (*num_vf)(struct device *dev);
149 int (*dma_configure)(struct device *dev);
151 const struct dev_pm_ops *pm;
153 const struct iommu_ops *iommu_ops;
155 struct subsys_private *p;
156 struct lock_class_key lock_key;
158 bool need_parent_lock;
161 extern int __must_check bus_register(struct bus_type *bus);
163 extern void bus_unregister(struct bus_type *bus);
165 extern int __must_check bus_rescan_devices(struct bus_type *bus);
167 /* iterator helpers for buses */
168 struct subsys_dev_iter {
169 struct klist_iter ki;
170 const struct device_type *type;
172 void subsys_dev_iter_init(struct subsys_dev_iter *iter,
173 struct bus_type *subsys,
174 struct device *start,
175 const struct device_type *type);
176 struct device *subsys_dev_iter_next(struct subsys_dev_iter *iter);
177 void subsys_dev_iter_exit(struct subsys_dev_iter *iter);
179 int device_match_name(struct device *dev, const void *name);
180 int device_match_of_node(struct device *dev, const void *np);
181 int device_match_fwnode(struct device *dev, const void *fwnode);
182 int device_match_devt(struct device *dev, const void *pdevt);
183 int device_match_acpi_dev(struct device *dev, const void *adev);
184 int device_match_any(struct device *dev, const void *unused);
186 int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
187 int (*fn)(struct device *dev, void *data));
188 struct device *bus_find_device(struct bus_type *bus, struct device *start,
190 int (*match)(struct device *dev, const void *data));
192 * bus_find_device_by_name - device iterator for locating a particular device
193 * of a specific name.
195 * @start: Device to begin with
196 * @name: name of the device to match
198 static inline struct device *bus_find_device_by_name(struct bus_type *bus,
199 struct device *start,
202 return bus_find_device(bus, start, name, device_match_name);
206 * bus_find_device_by_of_node : device iterator for locating a particular device
207 * matching the of_node.
209 * @np: of_node of the device to match.
211 static inline struct device *
212 bus_find_device_by_of_node(struct bus_type *bus, const struct device_node *np)
214 return bus_find_device(bus, NULL, np, device_match_of_node);
218 * bus_find_device_by_fwnode : device iterator for locating a particular device
219 * matching the fwnode.
221 * @fwnode: fwnode of the device to match.
223 static inline struct device *
224 bus_find_device_by_fwnode(struct bus_type *bus, const struct fwnode_handle *fwnode)
226 return bus_find_device(bus, NULL, fwnode, device_match_fwnode);
230 * bus_find_device_by_devt : device iterator for locating a particular device
231 * matching the device type.
233 * @devt: device type of the device to match.
235 static inline struct device *bus_find_device_by_devt(struct bus_type *bus,
238 return bus_find_device(bus, NULL, &devt, device_match_devt);
242 * bus_find_next_device - Find the next device after a given device in a
245 * @cur: device to begin the search with.
247 static inline struct device *
248 bus_find_next_device(struct bus_type *bus,struct device *cur)
250 return bus_find_device(bus, cur, NULL, device_match_any);
257 * bus_find_device_by_acpi_dev : device iterator for locating a particular device
258 * matching the ACPI COMPANION device.
260 * @adev: ACPI COMPANION device to match.
262 static inline struct device *
263 bus_find_device_by_acpi_dev(struct bus_type *bus, const struct acpi_device *adev)
265 return bus_find_device(bus, NULL, adev, device_match_acpi_dev);
268 static inline struct device *
269 bus_find_device_by_acpi_dev(struct bus_type *bus, const void *adev)
275 struct device *subsys_find_device_by_id(struct bus_type *bus, unsigned int id,
276 struct device *hint);
277 int bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
278 void *data, int (*fn)(struct device_driver *, void *));
279 void bus_sort_breadthfirst(struct bus_type *bus,
280 int (*compare)(const struct device *a,
281 const struct device *b));
283 * Bus notifiers: Get notified of addition/removal of devices
284 * and binding/unbinding of drivers to devices.
285 * In the long run, it should be a replacement for the platform
288 struct notifier_block;
290 extern int bus_register_notifier(struct bus_type *bus,
291 struct notifier_block *nb);
292 extern int bus_unregister_notifier(struct bus_type *bus,
293 struct notifier_block *nb);
295 /* All 4 notifers below get called with the target struct device *
296 * as an argument. Note that those functions are likely to be called
297 * with the device lock held in the core, so be careful.
299 #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
300 #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device to be removed */
301 #define BUS_NOTIFY_REMOVED_DEVICE 0x00000003 /* device removed */
302 #define BUS_NOTIFY_BIND_DRIVER 0x00000004 /* driver about to be
304 #define BUS_NOTIFY_BOUND_DRIVER 0x00000005 /* driver bound to device */
305 #define BUS_NOTIFY_UNBIND_DRIVER 0x00000006 /* driver about to be
307 #define BUS_NOTIFY_UNBOUND_DRIVER 0x00000007 /* driver is unbound
309 #define BUS_NOTIFY_DRIVER_NOT_BOUND 0x00000008 /* driver fails to be bound */
311 extern struct kset *bus_get_kset(struct bus_type *bus);
312 extern struct klist *bus_get_device_klist(struct bus_type *bus);
315 * enum probe_type - device driver probe type to try
316 * Device drivers may opt in for special handling of their
317 * respective probe routines. This tells the core what to
320 * @PROBE_DEFAULT_STRATEGY: Used by drivers that work equally well
321 * whether probed synchronously or asynchronously.
322 * @PROBE_PREFER_ASYNCHRONOUS: Drivers for "slow" devices which
323 * probing order is not essential for booting the system may
324 * opt into executing their probes asynchronously.
325 * @PROBE_FORCE_SYNCHRONOUS: Use this to annotate drivers that need
326 * their probe routines to run synchronously with driver and
327 * device registration (with the exception of -EPROBE_DEFER
328 * handling - re-probing always ends up being done asynchronously).
330 * Note that the end goal is to switch the kernel to use asynchronous
331 * probing by default, so annotating drivers with
332 * %PROBE_PREFER_ASYNCHRONOUS is a temporary measure that allows us
333 * to speed up boot process while we are validating the rest of the
337 PROBE_DEFAULT_STRATEGY,
338 PROBE_PREFER_ASYNCHRONOUS,
339 PROBE_FORCE_SYNCHRONOUS,
343 * struct device_driver - The basic device driver structure
344 * @name: Name of the device driver.
345 * @bus: The bus which the device of this driver belongs to.
346 * @owner: The module owner.
347 * @mod_name: Used for built-in modules.
348 * @suppress_bind_attrs: Disables bind/unbind via sysfs.
349 * @probe_type: Type of the probe (synchronous or asynchronous) to use.
350 * @of_match_table: The open firmware table.
351 * @acpi_match_table: The ACPI match table.
352 * @edit_links: Called to allow a matched driver to edit the device links the
353 * bus might have added incorrectly. This will be useful to handle
354 * cases where the bus incorrectly adds functional dependencies
355 * that aren't true or tries to create cyclic dependencies. But
356 * doesn't correctly handle functional dependencies that are
357 * missed by the bus as the supplier's sync_state might get to
358 * execute before the driver for a missing consumer is loaded and
359 * gets to edit the device links for the consumer.
361 * This function might be called multiple times after a new device
362 * is added. The function is expected to create all the device
363 * links for the new device and return 0 if it was completed
364 * successfully or return an error if it needs to be reattempted
366 * @probe: Called to query the existence of a specific device,
367 * whether this driver can work with it, and bind the driver
368 * to a specific device.
369 * @remove: Called when the device is removed from the system to
370 * unbind a device from this driver.
371 * @shutdown: Called at shut-down time to quiesce the device.
372 * @suspend: Called to put the device to sleep mode. Usually to a
374 * @resume: Called to bring a device from sleep mode.
375 * @groups: Default attributes that get created by the driver core
377 * @dev_groups: Additional attributes attached to device instance once the
378 * it is bound to the driver.
379 * @pm: Power management operations of the device which matched
381 * @coredump: Called when sysfs entry is written to. The device driver
382 * is expected to call the dev_coredump API resulting in a
384 * @p: Driver core's private data, no one other than the driver
385 * core can touch this.
387 * The device driver-model tracks all of the drivers known to the system.
388 * The main reason for this tracking is to enable the driver core to match
389 * up drivers with new devices. Once drivers are known objects within the
390 * system, however, a number of other things become possible. Device drivers
391 * can export information and configuration variables that are independent
392 * of any specific device.
394 struct device_driver {
396 struct bus_type *bus;
398 struct module *owner;
399 const char *mod_name; /* used for built-in modules */
401 bool suppress_bind_attrs; /* disables bind/unbind via sysfs */
402 enum probe_type probe_type;
404 const struct of_device_id *of_match_table;
405 const struct acpi_device_id *acpi_match_table;
407 int (*edit_links)(struct device *dev);
408 int (*probe) (struct device *dev);
409 int (*remove) (struct device *dev);
410 void (*shutdown) (struct device *dev);
411 int (*suspend) (struct device *dev, pm_message_t state);
412 int (*resume) (struct device *dev);
413 const struct attribute_group **groups;
414 const struct attribute_group **dev_groups;
416 const struct dev_pm_ops *pm;
417 void (*coredump) (struct device *dev);
419 struct driver_private *p;
423 extern int __must_check driver_register(struct device_driver *drv);
424 extern void driver_unregister(struct device_driver *drv);
426 extern struct device_driver *driver_find(const char *name,
427 struct bus_type *bus);
428 extern int driver_probe_done(void);
429 extern void wait_for_device_probe(void);
431 /* sysfs interface for exporting driver attributes */
433 struct driver_attribute {
434 struct attribute attr;
435 ssize_t (*show)(struct device_driver *driver, char *buf);
436 ssize_t (*store)(struct device_driver *driver, const char *buf,
440 #define DRIVER_ATTR_RW(_name) \
441 struct driver_attribute driver_attr_##_name = __ATTR_RW(_name)
442 #define DRIVER_ATTR_RO(_name) \
443 struct driver_attribute driver_attr_##_name = __ATTR_RO(_name)
444 #define DRIVER_ATTR_WO(_name) \
445 struct driver_attribute driver_attr_##_name = __ATTR_WO(_name)
447 extern int __must_check driver_create_file(struct device_driver *driver,
448 const struct driver_attribute *attr);
449 extern void driver_remove_file(struct device_driver *driver,
450 const struct driver_attribute *attr);
452 extern int __must_check driver_for_each_device(struct device_driver *drv,
453 struct device *start,
455 int (*fn)(struct device *dev,
457 struct device *driver_find_device(struct device_driver *drv,
458 struct device *start, const void *data,
459 int (*match)(struct device *dev, const void *data));
462 * driver_find_device_by_name - device iterator for locating a particular device
463 * of a specific name.
464 * @drv: the driver we're iterating
465 * @name: name of the device to match
467 static inline struct device *driver_find_device_by_name(struct device_driver *drv,
470 return driver_find_device(drv, NULL, name, device_match_name);
474 * driver_find_device_by_of_node- device iterator for locating a particular device
475 * by of_node pointer.
476 * @drv: the driver we're iterating
477 * @np: of_node pointer to match.
479 static inline struct device *
480 driver_find_device_by_of_node(struct device_driver *drv,
481 const struct device_node *np)
483 return driver_find_device(drv, NULL, np, device_match_of_node);
487 * driver_find_device_by_fwnode- device iterator for locating a particular device
489 * @drv: the driver we're iterating
490 * @fwnode: fwnode pointer to match.
492 static inline struct device *
493 driver_find_device_by_fwnode(struct device_driver *drv,
494 const struct fwnode_handle *fwnode)
496 return driver_find_device(drv, NULL, fwnode, device_match_fwnode);
500 * driver_find_device_by_devt- device iterator for locating a particular device
502 * @drv: the driver we're iterating
503 * @devt: devt pointer to match.
505 static inline struct device *driver_find_device_by_devt(struct device_driver *drv,
508 return driver_find_device(drv, NULL, &devt, device_match_devt);
511 static inline struct device *driver_find_next_device(struct device_driver *drv,
512 struct device *start)
514 return driver_find_device(drv, start, NULL, device_match_any);
519 * driver_find_device_by_acpi_dev : device iterator for locating a particular
520 * device matching the ACPI_COMPANION device.
521 * @drv: the driver we're iterating
522 * @adev: ACPI_COMPANION device to match.
524 static inline struct device *
525 driver_find_device_by_acpi_dev(struct device_driver *drv,
526 const struct acpi_device *adev)
528 return driver_find_device(drv, NULL, adev, device_match_acpi_dev);
531 static inline struct device *
532 driver_find_device_by_acpi_dev(struct device_driver *drv, const void *adev)
538 void driver_deferred_probe_add(struct device *dev);
539 int driver_deferred_probe_check_state(struct device *dev);
540 int driver_deferred_probe_check_state_continue(struct device *dev);
543 * struct subsys_interface - interfaces to device functions
544 * @name: name of the device function
545 * @subsys: subsytem of the devices to attach to
546 * @node: the list of functions registered at the subsystem
547 * @add_dev: device hookup to device function handler
548 * @remove_dev: device hookup to device function handler
550 * Simple interfaces attached to a subsystem. Multiple interfaces can
551 * attach to a subsystem and its devices. Unlike drivers, they do not
552 * exclusively claim or control devices. Interfaces usually represent
553 * a specific functionality of a subsystem/class of devices.
555 struct subsys_interface {
557 struct bus_type *subsys;
558 struct list_head node;
559 int (*add_dev)(struct device *dev, struct subsys_interface *sif);
560 void (*remove_dev)(struct device *dev, struct subsys_interface *sif);
563 int subsys_interface_register(struct subsys_interface *sif);
564 void subsys_interface_unregister(struct subsys_interface *sif);
566 int subsys_system_register(struct bus_type *subsys,
567 const struct attribute_group **groups);
568 int subsys_virtual_register(struct bus_type *subsys,
569 const struct attribute_group **groups);
572 * struct class - device classes
573 * @name: Name of the class.
574 * @owner: The module owner.
575 * @class_groups: Default attributes of this class.
576 * @dev_groups: Default attributes of the devices that belong to the class.
577 * @dev_kobj: The kobject that represents this class and links it into the hierarchy.
578 * @dev_uevent: Called when a device is added, removed from this class, or a
579 * few other things that generate uevents to add the environment
581 * @devnode: Callback to provide the devtmpfs.
582 * @class_release: Called to release this class.
583 * @dev_release: Called to release the device.
584 * @shutdown_pre: Called at shut-down time before driver shutdown.
585 * @ns_type: Callbacks so sysfs can detemine namespaces.
586 * @namespace: Namespace of the device belongs to this class.
587 * @get_ownership: Allows class to specify uid/gid of the sysfs directories
588 * for the devices belonging to the class. Usually tied to
589 * device's namespace.
590 * @pm: The default device power management operations of this class.
591 * @p: The private data of the driver core, no one other than the
592 * driver core can touch this.
594 * A class is a higher-level view of a device that abstracts out low-level
595 * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
596 * at the class level, they are all simply disks. Classes allow user space
597 * to work with devices based on what they do, rather than how they are
598 * connected or how they work.
602 struct module *owner;
604 const struct attribute_group **class_groups;
605 const struct attribute_group **dev_groups;
606 struct kobject *dev_kobj;
608 int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
609 char *(*devnode)(struct device *dev, umode_t *mode);
611 void (*class_release)(struct class *class);
612 void (*dev_release)(struct device *dev);
614 int (*shutdown_pre)(struct device *dev);
616 const struct kobj_ns_type_operations *ns_type;
617 const void *(*namespace)(struct device *dev);
619 void (*get_ownership)(struct device *dev, kuid_t *uid, kgid_t *gid);
621 const struct dev_pm_ops *pm;
623 struct subsys_private *p;
626 struct class_dev_iter {
627 struct klist_iter ki;
628 const struct device_type *type;
631 extern struct kobject *sysfs_dev_block_kobj;
632 extern struct kobject *sysfs_dev_char_kobj;
633 extern int __must_check __class_register(struct class *class,
634 struct lock_class_key *key);
635 extern void class_unregister(struct class *class);
637 /* This is a #define to keep the compiler from merging different
638 * instances of the __key variable */
639 #define class_register(class) \
641 static struct lock_class_key __key; \
642 __class_register(class, &__key); \
646 struct class_compat *class_compat_register(const char *name);
647 void class_compat_unregister(struct class_compat *cls);
648 int class_compat_create_link(struct class_compat *cls, struct device *dev,
649 struct device *device_link);
650 void class_compat_remove_link(struct class_compat *cls, struct device *dev,
651 struct device *device_link);
653 extern void class_dev_iter_init(struct class_dev_iter *iter,
655 struct device *start,
656 const struct device_type *type);
657 extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
658 extern void class_dev_iter_exit(struct class_dev_iter *iter);
660 extern int class_for_each_device(struct class *class, struct device *start,
662 int (*fn)(struct device *dev, void *data));
663 extern struct device *class_find_device(struct class *class,
664 struct device *start, const void *data,
665 int (*match)(struct device *, const void *));
668 * class_find_device_by_name - device iterator for locating a particular device
669 * of a specific name.
671 * @name: name of the device to match
673 static inline struct device *class_find_device_by_name(struct class *class,
676 return class_find_device(class, NULL, name, device_match_name);
680 * class_find_device_by_of_node : device iterator for locating a particular device
681 * matching the of_node.
683 * @np: of_node of the device to match.
685 static inline struct device *
686 class_find_device_by_of_node(struct class *class, const struct device_node *np)
688 return class_find_device(class, NULL, np, device_match_of_node);
692 * class_find_device_by_fwnode : device iterator for locating a particular device
693 * matching the fwnode.
695 * @fwnode: fwnode of the device to match.
697 static inline struct device *
698 class_find_device_by_fwnode(struct class *class,
699 const struct fwnode_handle *fwnode)
701 return class_find_device(class, NULL, fwnode, device_match_fwnode);
705 * class_find_device_by_devt : device iterator for locating a particular device
706 * matching the device type.
708 * @devt: device type of the device to match.
710 static inline struct device *class_find_device_by_devt(struct class *class,
713 return class_find_device(class, NULL, &devt, device_match_devt);
719 * class_find_device_by_acpi_dev : device iterator for locating a particular
720 * device matching the ACPI_COMPANION device.
722 * @adev: ACPI_COMPANION device to match.
724 static inline struct device *
725 class_find_device_by_acpi_dev(struct class *class, const struct acpi_device *adev)
727 return class_find_device(class, NULL, adev, device_match_acpi_dev);
730 static inline struct device *
731 class_find_device_by_acpi_dev(struct class *class, const void *adev)
737 struct class_attribute {
738 struct attribute attr;
739 ssize_t (*show)(struct class *class, struct class_attribute *attr,
741 ssize_t (*store)(struct class *class, struct class_attribute *attr,
742 const char *buf, size_t count);
745 #define CLASS_ATTR_RW(_name) \
746 struct class_attribute class_attr_##_name = __ATTR_RW(_name)
747 #define CLASS_ATTR_RO(_name) \
748 struct class_attribute class_attr_##_name = __ATTR_RO(_name)
749 #define CLASS_ATTR_WO(_name) \
750 struct class_attribute class_attr_##_name = __ATTR_WO(_name)
752 extern int __must_check class_create_file_ns(struct class *class,
753 const struct class_attribute *attr,
755 extern void class_remove_file_ns(struct class *class,
756 const struct class_attribute *attr,
759 static inline int __must_check class_create_file(struct class *class,
760 const struct class_attribute *attr)
762 return class_create_file_ns(class, attr, NULL);
765 static inline void class_remove_file(struct class *class,
766 const struct class_attribute *attr)
768 return class_remove_file_ns(class, attr, NULL);
771 /* Simple class attribute that is just a static string */
772 struct class_attribute_string {
773 struct class_attribute attr;
777 /* Currently read-only only */
778 #define _CLASS_ATTR_STRING(_name, _mode, _str) \
779 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
780 #define CLASS_ATTR_STRING(_name, _mode, _str) \
781 struct class_attribute_string class_attr_##_name = \
782 _CLASS_ATTR_STRING(_name, _mode, _str)
784 extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr,
787 struct class_interface {
788 struct list_head node;
791 int (*add_dev) (struct device *, struct class_interface *);
792 void (*remove_dev) (struct device *, struct class_interface *);
795 extern int __must_check class_interface_register(struct class_interface *);
796 extern void class_interface_unregister(struct class_interface *);
798 extern struct class * __must_check __class_create(struct module *owner,
800 struct lock_class_key *key);
801 extern void class_destroy(struct class *cls);
803 /* This is a #define to keep the compiler from merging different
804 * instances of the __key variable */
805 #define class_create(owner, name) \
807 static struct lock_class_key __key; \
808 __class_create(owner, name, &__key); \
812 * The type of device, "struct device" is embedded in. A class
813 * or bus can contain devices of different types
814 * like "partitions" and "disks", "mouse" and "event".
815 * This identifies the device type and carries type-specific
816 * information, equivalent to the kobj_type of a kobject.
817 * If "name" is specified, the uevent will contain it in
818 * the DEVTYPE variable.
822 const struct attribute_group **groups;
823 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
824 char *(*devnode)(struct device *dev, umode_t *mode,
825 kuid_t *uid, kgid_t *gid);
826 void (*release)(struct device *dev);
828 const struct dev_pm_ops *pm;
831 /* interface for exporting device attributes */
832 struct device_attribute {
833 struct attribute attr;
834 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
836 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
837 const char *buf, size_t count);
840 struct dev_ext_attribute {
841 struct device_attribute attr;
845 ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
847 ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
848 const char *buf, size_t count);
849 ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
851 ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
852 const char *buf, size_t count);
853 ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
855 ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
856 const char *buf, size_t count);
858 #define DEVICE_ATTR(_name, _mode, _show, _store) \
859 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
860 #define DEVICE_ATTR_PREALLOC(_name, _mode, _show, _store) \
861 struct device_attribute dev_attr_##_name = \
862 __ATTR_PREALLOC(_name, _mode, _show, _store)
863 #define DEVICE_ATTR_RW(_name) \
864 struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
865 #define DEVICE_ATTR_RO(_name) \
866 struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
867 #define DEVICE_ATTR_WO(_name) \
868 struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
869 #define DEVICE_ULONG_ATTR(_name, _mode, _var) \
870 struct dev_ext_attribute dev_attr_##_name = \
871 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
872 #define DEVICE_INT_ATTR(_name, _mode, _var) \
873 struct dev_ext_attribute dev_attr_##_name = \
874 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
875 #define DEVICE_BOOL_ATTR(_name, _mode, _var) \
876 struct dev_ext_attribute dev_attr_##_name = \
877 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
878 #define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
879 struct device_attribute dev_attr_##_name = \
880 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
882 extern int device_create_file(struct device *device,
883 const struct device_attribute *entry);
884 extern void device_remove_file(struct device *dev,
885 const struct device_attribute *attr);
886 extern bool device_remove_file_self(struct device *dev,
887 const struct device_attribute *attr);
888 extern int __must_check device_create_bin_file(struct device *dev,
889 const struct bin_attribute *attr);
890 extern void device_remove_bin_file(struct device *dev,
891 const struct bin_attribute *attr);
893 /* device resource management */
894 typedef void (*dr_release_t)(struct device *dev, void *res);
895 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
897 #ifdef CONFIG_DEBUG_DEVRES
898 extern void *__devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
899 int nid, const char *name) __malloc;
900 #define devres_alloc(release, size, gfp) \
901 __devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release)
902 #define devres_alloc_node(release, size, gfp, nid) \
903 __devres_alloc_node(release, size, gfp, nid, #release)
905 extern void *devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
907 static inline void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp)
909 return devres_alloc_node(release, size, gfp, NUMA_NO_NODE);
913 extern void devres_for_each_res(struct device *dev, dr_release_t release,
914 dr_match_t match, void *match_data,
915 void (*fn)(struct device *, void *, void *),
917 extern void devres_free(void *res);
918 extern void devres_add(struct device *dev, void *res);
919 extern void *devres_find(struct device *dev, dr_release_t release,
920 dr_match_t match, void *match_data);
921 extern void *devres_get(struct device *dev, void *new_res,
922 dr_match_t match, void *match_data);
923 extern void *devres_remove(struct device *dev, dr_release_t release,
924 dr_match_t match, void *match_data);
925 extern int devres_destroy(struct device *dev, dr_release_t release,
926 dr_match_t match, void *match_data);
927 extern int devres_release(struct device *dev, dr_release_t release,
928 dr_match_t match, void *match_data);
931 extern void * __must_check devres_open_group(struct device *dev, void *id,
933 extern void devres_close_group(struct device *dev, void *id);
934 extern void devres_remove_group(struct device *dev, void *id);
935 extern int devres_release_group(struct device *dev, void *id);
937 /* managed devm_k.alloc/kfree for device drivers */
938 extern void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp) __malloc;
939 extern __printf(3, 0)
940 char *devm_kvasprintf(struct device *dev, gfp_t gfp, const char *fmt,
941 va_list ap) __malloc;
942 extern __printf(3, 4)
943 char *devm_kasprintf(struct device *dev, gfp_t gfp, const char *fmt, ...) __malloc;
944 static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp)
946 return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
948 static inline void *devm_kmalloc_array(struct device *dev,
949 size_t n, size_t size, gfp_t flags)
953 if (unlikely(check_mul_overflow(n, size, &bytes)))
956 return devm_kmalloc(dev, bytes, flags);
958 static inline void *devm_kcalloc(struct device *dev,
959 size_t n, size_t size, gfp_t flags)
961 return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
963 extern void devm_kfree(struct device *dev, const void *p);
964 extern char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp) __malloc;
965 extern const char *devm_kstrdup_const(struct device *dev,
966 const char *s, gfp_t gfp);
967 extern void *devm_kmemdup(struct device *dev, const void *src, size_t len,
970 extern unsigned long devm_get_free_pages(struct device *dev,
971 gfp_t gfp_mask, unsigned int order);
972 extern void devm_free_pages(struct device *dev, unsigned long addr);
974 void __iomem *devm_ioremap_resource(struct device *dev,
975 const struct resource *res);
977 void __iomem *devm_of_iomap(struct device *dev,
978 struct device_node *node, int index,
979 resource_size_t *size);
981 /* allows to add/remove a custom action to devres stack */
982 int devm_add_action(struct device *dev, void (*action)(void *), void *data);
983 void devm_remove_action(struct device *dev, void (*action)(void *), void *data);
984 void devm_release_action(struct device *dev, void (*action)(void *), void *data);
986 static inline int devm_add_action_or_reset(struct device *dev,
987 void (*action)(void *), void *data)
991 ret = devm_add_action(dev, action, data);
999 * devm_alloc_percpu - Resource-managed alloc_percpu
1000 * @dev: Device to allocate per-cpu memory for
1001 * @type: Type to allocate per-cpu memory for
1003 * Managed alloc_percpu. Per-cpu memory allocated with this function is
1004 * automatically freed on driver detach.
1007 * Pointer to allocated memory on success, NULL on failure.
1009 #define devm_alloc_percpu(dev, type) \
1010 ((typeof(type) __percpu *)__devm_alloc_percpu((dev), sizeof(type), \
1013 void __percpu *__devm_alloc_percpu(struct device *dev, size_t size,
1015 void devm_free_percpu(struct device *dev, void __percpu *pdata);
1017 struct device_dma_parameters {
1019 * a low level driver may set these to teach IOMMU code about
1022 unsigned int max_segment_size;
1023 unsigned long segment_boundary_mask;
1027 * struct device_connection - Device Connection Descriptor
1028 * @fwnode: The device node of the connected device
1029 * @endpoint: The names of the two devices connected together
1030 * @id: Unique identifier for the connection
1031 * @list: List head, private, for internal use only
1033 * NOTE: @fwnode is not used together with @endpoint. @fwnode is used when
1034 * platform firmware defines the connection. When the connection is registered
1035 * with device_connection_add() @endpoint is used instead.
1037 struct device_connection {
1038 struct fwnode_handle *fwnode;
1039 const char *endpoint[2];
1041 struct list_head list;
1044 void *device_connection_find_match(struct device *dev, const char *con_id,
1046 void *(*match)(struct device_connection *con,
1047 int ep, void *data));
1049 struct device *device_connection_find(struct device *dev, const char *con_id);
1051 void device_connection_add(struct device_connection *con);
1052 void device_connection_remove(struct device_connection *con);
1055 * device_connections_add - Add multiple device connections at once
1056 * @cons: Zero terminated array of device connection descriptors
1058 static inline void device_connections_add(struct device_connection *cons)
1060 struct device_connection *c;
1062 for (c = cons; c->endpoint[0]; c++)
1063 device_connection_add(c);
1067 * device_connections_remove - Remove multiple device connections at once
1068 * @cons: Zero terminated array of device connection descriptors
1070 static inline void device_connections_remove(struct device_connection *cons)
1072 struct device_connection *c;
1074 for (c = cons; c->endpoint[0]; c++)
1075 device_connection_remove(c);
1079 * enum device_link_state - Device link states.
1080 * @DL_STATE_NONE: The presence of the drivers is not being tracked.
1081 * @DL_STATE_DORMANT: None of the supplier/consumer drivers is present.
1082 * @DL_STATE_AVAILABLE: The supplier driver is present, but the consumer is not.
1083 * @DL_STATE_CONSUMER_PROBE: The consumer is probing (supplier driver present).
1084 * @DL_STATE_ACTIVE: Both the supplier and consumer drivers are present.
1085 * @DL_STATE_SUPPLIER_UNBIND: The supplier driver is unbinding.
1087 enum device_link_state {
1089 DL_STATE_DORMANT = 0,
1091 DL_STATE_CONSUMER_PROBE,
1093 DL_STATE_SUPPLIER_UNBIND,
1097 * Device link flags.
1099 * STATELESS: The core will not remove this link automatically.
1100 * AUTOREMOVE_CONSUMER: Remove the link automatically on consumer driver unbind.
1101 * PM_RUNTIME: If set, the runtime PM framework will use this link.
1102 * RPM_ACTIVE: Run pm_runtime_get_sync() on the supplier during link creation.
1103 * AUTOREMOVE_SUPPLIER: Remove the link automatically on supplier driver unbind.
1104 * AUTOPROBE_CONSUMER: Probe consumer driver automatically after supplier binds.
1105 * MANAGED: The core tracks presence of supplier/consumer drivers (internal).
1107 #define DL_FLAG_STATELESS BIT(0)
1108 #define DL_FLAG_AUTOREMOVE_CONSUMER BIT(1)
1109 #define DL_FLAG_PM_RUNTIME BIT(2)
1110 #define DL_FLAG_RPM_ACTIVE BIT(3)
1111 #define DL_FLAG_AUTOREMOVE_SUPPLIER BIT(4)
1112 #define DL_FLAG_AUTOPROBE_CONSUMER BIT(5)
1113 #define DL_FLAG_MANAGED BIT(6)
1116 * struct device_link - Device link representation.
1117 * @supplier: The device on the supplier end of the link.
1118 * @s_node: Hook to the supplier device's list of links to consumers.
1119 * @consumer: The device on the consumer end of the link.
1120 * @c_node: Hook to the consumer device's list of links to suppliers.
1121 * @status: The state of the link (with respect to the presence of drivers).
1122 * @flags: Link flags.
1123 * @rpm_active: Whether or not the consumer device is runtime-PM-active.
1124 * @kref: Count repeated addition of the same link.
1125 * @rcu_head: An RCU head to use for deferred execution of SRCU callbacks.
1126 * @supplier_preactivated: Supplier has been made active before consumer probe.
1128 struct device_link {
1129 struct device *supplier;
1130 struct list_head s_node;
1131 struct device *consumer;
1132 struct list_head c_node;
1133 enum device_link_state status;
1135 refcount_t rpm_active;
1138 struct rcu_head rcu_head;
1140 bool supplier_preactivated; /* Owned by consumer probe. */
1144 * enum dl_dev_state - Device driver presence tracking information.
1145 * @DL_DEV_NO_DRIVER: There is no driver attached to the device.
1146 * @DL_DEV_PROBING: A driver is probing.
1147 * @DL_DEV_DRIVER_BOUND: The driver has been bound to the device.
1148 * @DL_DEV_UNBINDING: The driver is unbinding from the device.
1151 DL_DEV_NO_DRIVER = 0,
1153 DL_DEV_DRIVER_BOUND,
1158 * struct dev_links_info - Device data related to device links.
1159 * @suppliers: List of links to supplier devices.
1160 * @consumers: List of links to consumer devices.
1161 * @needs_suppliers: Hook to global list of devices waiting for suppliers.
1162 * @status: Driver status information.
1164 struct dev_links_info {
1165 struct list_head suppliers;
1166 struct list_head consumers;
1167 struct list_head needs_suppliers;
1168 enum dl_dev_state status;
1172 * struct device - The basic device structure
1173 * @parent: The device's "parent" device, the device to which it is attached.
1174 * In most cases, a parent device is some sort of bus or host
1175 * controller. If parent is NULL, the device, is a top-level device,
1176 * which is not usually what you want.
1177 * @p: Holds the private data of the driver core portions of the device.
1178 * See the comment of the struct device_private for detail.
1179 * @kobj: A top-level, abstract class from which other classes are derived.
1180 * @init_name: Initial name of the device.
1181 * @type: The type of device.
1182 * This identifies the device type and carries type-specific
1184 * @mutex: Mutex to synchronize calls to its driver.
1185 * @lockdep_mutex: An optional debug lock that a subsystem can use as a
1186 * peer lock to gain localized lockdep coverage of the device_lock.
1187 * @bus: Type of bus device is on.
1188 * @driver: Which driver has allocated this
1189 * @platform_data: Platform data specific to the device.
1190 * Example: For devices on custom boards, as typical of embedded
1191 * and SOC based hardware, Linux often uses platform_data to point
1192 * to board-specific structures describing devices and how they
1193 * are wired. That can include what ports are available, chip
1194 * variants, which GPIO pins act in what additional roles, and so
1195 * on. This shrinks the "Board Support Packages" (BSPs) and
1196 * minimizes board-specific #ifdefs in drivers.
1197 * @driver_data: Private pointer for driver specific info.
1198 * @links: Links to suppliers and consumers of this device.
1199 * @power: For device power management.
1200 * See Documentation/driver-api/pm/devices.rst for details.
1201 * @pm_domain: Provide callbacks that are executed during system suspend,
1202 * hibernation, system resume and during runtime PM transitions
1203 * along with subsystem-level and driver-level callbacks.
1204 * @pins: For device pin management.
1205 * See Documentation/driver-api/pinctl.rst for details.
1206 * @msi_list: Hosts MSI descriptors
1207 * @msi_domain: The generic MSI domain this device is using.
1208 * @numa_node: NUMA node this device is close to.
1209 * @dma_ops: DMA mapping operations for this device.
1210 * @dma_mask: Dma mask (if dma'ble device).
1211 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
1212 * hardware supports 64-bit addresses for consistent allocations
1214 * @bus_dma_mask: Mask of an upstream bridge or bus which imposes a smaller DMA
1215 * limit than the device itself supports.
1216 * @dma_pfn_offset: offset of DMA memory range relatively of RAM
1217 * @dma_parms: A low level driver may set these to teach IOMMU code about
1218 * segment limitations.
1219 * @dma_pools: Dma pools (if dma'ble device).
1220 * @dma_mem: Internal for coherent mem override.
1221 * @cma_area: Contiguous memory area for dma allocations
1222 * @archdata: For arch-specific additions.
1223 * @of_node: Associated device tree node.
1224 * @fwnode: Associated device node supplied by platform firmware.
1225 * @devt: For creating the sysfs "dev".
1226 * @id: device instance
1227 * @devres_lock: Spinlock to protect the resource of the device.
1228 * @devres_head: The resources list of the device.
1229 * @knode_class: The node used to add the device to the class list.
1230 * @class: The class of the device.
1231 * @groups: Optional attribute groups.
1232 * @release: Callback to free the device after all references have
1233 * gone away. This should be set by the allocator of the
1234 * device (i.e. the bus driver that discovered the device).
1235 * @iommu_group: IOMMU group the device belongs to.
1236 * @iommu_fwspec: IOMMU-specific properties supplied by firmware.
1237 * @iommu_param: Per device generic IOMMU runtime data
1239 * @offline_disabled: If set, the device is permanently online.
1240 * @offline: Set after successful invocation of bus type's .offline().
1241 * @of_node_reused: Set if the device-tree node is shared with an ancestor
1243 * @has_edit_links: This device has a driver than is capable of
1244 * editing the device links created by driver core.
1245 * @dma_coherent: this particular device is dma coherent, even if the
1246 * architecture supports non-coherent devices.
1248 * At the lowest level, every device in a Linux system is represented by an
1249 * instance of struct device. The device structure contains the information
1250 * that the device model core needs to model the system. Most subsystems,
1251 * however, track additional information about the devices they host. As a
1252 * result, it is rare for devices to be represented by bare device structures;
1253 * instead, that structure, like kobject structures, is usually embedded within
1254 * a higher-level representation of the device.
1257 struct kobject kobj;
1258 struct device *parent;
1260 struct device_private *p;
1262 const char *init_name; /* initial name of the device */
1263 const struct device_type *type;
1265 struct bus_type *bus; /* type of bus device is on */
1266 struct device_driver *driver; /* which driver has allocated this
1268 void *platform_data; /* Platform specific data, device
1269 core doesn't touch it */
1270 void *driver_data; /* Driver data, set and get with
1271 dev_set_drvdata/dev_get_drvdata */
1272 #ifdef CONFIG_PROVE_LOCKING
1273 struct mutex lockdep_mutex;
1275 struct mutex mutex; /* mutex to synchronize calls to
1279 struct dev_links_info links;
1280 struct dev_pm_info power;
1281 struct dev_pm_domain *pm_domain;
1283 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
1284 struct irq_domain *msi_domain;
1286 #ifdef CONFIG_PINCTRL
1287 struct dev_pin_info *pins;
1289 #ifdef CONFIG_GENERIC_MSI_IRQ
1290 struct list_head msi_list;
1293 const struct dma_map_ops *dma_ops;
1294 u64 *dma_mask; /* dma mask (if dma'able device) */
1295 u64 coherent_dma_mask;/* Like dma_mask, but for
1296 alloc_coherent mappings as
1297 not all hardware supports
1298 64 bit addresses for consistent
1299 allocations such descriptors. */
1300 u64 bus_dma_mask; /* upstream dma_mask constraint */
1301 unsigned long dma_pfn_offset;
1303 struct device_dma_parameters *dma_parms;
1305 struct list_head dma_pools; /* dma pools (if dma'ble) */
1307 #ifdef CONFIG_DMA_DECLARE_COHERENT
1308 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
1311 #ifdef CONFIG_DMA_CMA
1312 struct cma *cma_area; /* contiguous memory area for dma
1315 /* arch specific additions */
1316 struct dev_archdata archdata;
1318 struct device_node *of_node; /* associated device tree node */
1319 struct fwnode_handle *fwnode; /* firmware device node */
1322 int numa_node; /* NUMA node this device is close to */
1324 dev_t devt; /* dev_t, creates the sysfs "dev" */
1325 u32 id; /* device instance */
1327 spinlock_t devres_lock;
1328 struct list_head devres_head;
1330 struct class *class;
1331 const struct attribute_group **groups; /* optional groups */
1333 void (*release)(struct device *dev);
1334 struct iommu_group *iommu_group;
1335 struct iommu_fwspec *iommu_fwspec;
1336 struct iommu_param *iommu_param;
1338 bool offline_disabled:1;
1340 bool of_node_reused:1;
1341 bool has_edit_links:1;
1342 #if defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_DEVICE) || \
1343 defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU) || \
1344 defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU_ALL)
1345 bool dma_coherent:1;
1349 static inline struct device *kobj_to_dev(struct kobject *kobj)
1351 return container_of(kobj, struct device, kobj);
1355 * device_iommu_mapped - Returns true when the device DMA is translated
1357 * @dev: Device to perform the check on
1359 static inline bool device_iommu_mapped(struct device *dev)
1361 return (dev->iommu_group != NULL);
1364 /* Get the wakeup routines, which depend on struct device */
1365 #include <linux/pm_wakeup.h>
1367 static inline const char *dev_name(const struct device *dev)
1369 /* Use the init name until the kobject becomes available */
1371 return dev->init_name;
1373 return kobject_name(&dev->kobj);
1376 extern __printf(2, 3)
1377 int dev_set_name(struct device *dev, const char *name, ...);
1380 static inline int dev_to_node(struct device *dev)
1382 return dev->numa_node;
1384 static inline void set_dev_node(struct device *dev, int node)
1386 dev->numa_node = node;
1389 static inline int dev_to_node(struct device *dev)
1391 return NUMA_NO_NODE;
1393 static inline void set_dev_node(struct device *dev, int node)
1398 static inline struct irq_domain *dev_get_msi_domain(const struct device *dev)
1400 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
1401 return dev->msi_domain;
1407 static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d)
1409 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
1410 dev->msi_domain = d;
1414 static inline void *dev_get_drvdata(const struct device *dev)
1416 return dev->driver_data;
1419 static inline void dev_set_drvdata(struct device *dev, void *data)
1421 dev->driver_data = data;
1424 static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
1426 return dev ? dev->power.subsys_data : NULL;
1429 static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
1431 return dev->kobj.uevent_suppress;
1434 static inline void dev_set_uevent_suppress(struct device *dev, int val)
1436 dev->kobj.uevent_suppress = val;
1439 static inline int device_is_registered(struct device *dev)
1441 return dev->kobj.state_in_sysfs;
1444 static inline void device_enable_async_suspend(struct device *dev)
1446 if (!dev->power.is_prepared)
1447 dev->power.async_suspend = true;
1450 static inline void device_disable_async_suspend(struct device *dev)
1452 if (!dev->power.is_prepared)
1453 dev->power.async_suspend = false;
1456 static inline bool device_async_suspend_enabled(struct device *dev)
1458 return !!dev->power.async_suspend;
1461 static inline bool device_pm_not_required(struct device *dev)
1463 return dev->power.no_pm;
1466 static inline void device_set_pm_not_required(struct device *dev)
1468 dev->power.no_pm = true;
1471 static inline void dev_pm_syscore_device(struct device *dev, bool val)
1473 #ifdef CONFIG_PM_SLEEP
1474 dev->power.syscore = val;
1478 static inline void dev_pm_set_driver_flags(struct device *dev, u32 flags)
1480 dev->power.driver_flags = flags;
1483 static inline bool dev_pm_test_driver_flags(struct device *dev, u32 flags)
1485 return !!(dev->power.driver_flags & flags);
1488 static inline void device_lock(struct device *dev)
1490 mutex_lock(&dev->mutex);
1493 static inline int device_lock_interruptible(struct device *dev)
1495 return mutex_lock_interruptible(&dev->mutex);
1498 static inline int device_trylock(struct device *dev)
1500 return mutex_trylock(&dev->mutex);
1503 static inline void device_unlock(struct device *dev)
1505 mutex_unlock(&dev->mutex);
1508 static inline void device_lock_assert(struct device *dev)
1510 lockdep_assert_held(&dev->mutex);
1513 static inline struct device_node *dev_of_node(struct device *dev)
1515 if (!IS_ENABLED(CONFIG_OF) || !dev)
1517 return dev->of_node;
1520 void driver_init(void);
1523 * High level routines for use by the bus drivers
1525 extern int __must_check device_register(struct device *dev);
1526 extern void device_unregister(struct device *dev);
1527 extern void device_initialize(struct device *dev);
1528 extern int __must_check device_add(struct device *dev);
1529 extern void device_del(struct device *dev);
1530 extern int device_for_each_child(struct device *dev, void *data,
1531 int (*fn)(struct device *dev, void *data));
1532 extern int device_for_each_child_reverse(struct device *dev, void *data,
1533 int (*fn)(struct device *dev, void *data));
1534 extern struct device *device_find_child(struct device *dev, void *data,
1535 int (*match)(struct device *dev, void *data));
1536 extern struct device *device_find_child_by_name(struct device *parent,
1538 extern int device_rename(struct device *dev, const char *new_name);
1539 extern int device_move(struct device *dev, struct device *new_parent,
1540 enum dpm_order dpm_order);
1541 extern const char *device_get_devnode(struct device *dev,
1542 umode_t *mode, kuid_t *uid, kgid_t *gid,
1545 static inline bool device_supports_offline(struct device *dev)
1547 return dev->bus && dev->bus->offline && dev->bus->online;
1550 extern void lock_device_hotplug(void);
1551 extern void unlock_device_hotplug(void);
1552 extern int lock_device_hotplug_sysfs(void);
1553 extern int device_offline(struct device *dev);
1554 extern int device_online(struct device *dev);
1555 extern void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1556 extern void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1557 void device_set_of_node_from_dev(struct device *dev, const struct device *dev2);
1559 static inline int dev_num_vf(struct device *dev)
1561 if (dev->bus && dev->bus->num_vf)
1562 return dev->bus->num_vf(dev);
1567 * Root device objects for grouping under /sys/devices
1569 extern struct device *__root_device_register(const char *name,
1570 struct module *owner);
1572 /* This is a macro to avoid include problems with THIS_MODULE */
1573 #define root_device_register(name) \
1574 __root_device_register(name, THIS_MODULE)
1576 extern void root_device_unregister(struct device *root);
1578 static inline void *dev_get_platdata(const struct device *dev)
1580 return dev->platform_data;
1584 * Manual binding of a device to driver. See drivers/base/bus.c
1585 * for information on use.
1587 extern int __must_check device_bind_driver(struct device *dev);
1588 extern void device_release_driver(struct device *dev);
1589 extern int __must_check device_attach(struct device *dev);
1590 extern int __must_check driver_attach(struct device_driver *drv);
1591 extern void device_initial_probe(struct device *dev);
1592 extern int __must_check device_reprobe(struct device *dev);
1593 extern int driver_edit_links(struct device *dev);
1595 extern bool device_is_bound(struct device *dev);
1598 * Easy functions for dynamically creating devices on the fly
1600 extern __printf(5, 0)
1601 struct device *device_create_vargs(struct class *cls, struct device *parent,
1602 dev_t devt, void *drvdata,
1603 const char *fmt, va_list vargs);
1604 extern __printf(5, 6)
1605 struct device *device_create(struct class *cls, struct device *parent,
1606 dev_t devt, void *drvdata,
1607 const char *fmt, ...);
1608 extern __printf(6, 7)
1609 struct device *device_create_with_groups(struct class *cls,
1610 struct device *parent, dev_t devt, void *drvdata,
1611 const struct attribute_group **groups,
1612 const char *fmt, ...);
1613 extern void device_destroy(struct class *cls, dev_t devt);
1615 extern int __must_check device_add_groups(struct device *dev,
1616 const struct attribute_group **groups);
1617 extern void device_remove_groups(struct device *dev,
1618 const struct attribute_group **groups);
1620 static inline int __must_check device_add_group(struct device *dev,
1621 const struct attribute_group *grp)
1623 const struct attribute_group *groups[] = { grp, NULL };
1625 return device_add_groups(dev, groups);
1628 static inline void device_remove_group(struct device *dev,
1629 const struct attribute_group *grp)
1631 const struct attribute_group *groups[] = { grp, NULL };
1633 return device_remove_groups(dev, groups);
1636 extern int __must_check devm_device_add_groups(struct device *dev,
1637 const struct attribute_group **groups);
1638 extern void devm_device_remove_groups(struct device *dev,
1639 const struct attribute_group **groups);
1640 extern int __must_check devm_device_add_group(struct device *dev,
1641 const struct attribute_group *grp);
1642 extern void devm_device_remove_group(struct device *dev,
1643 const struct attribute_group *grp);
1646 * Platform "fixup" functions - allow the platform to have their say
1647 * about devices and actions that the general device layer doesn't
1650 /* Notify platform of device discovery */
1651 extern int (*platform_notify)(struct device *dev);
1653 extern int (*platform_notify_remove)(struct device *dev);
1657 * get_device - atomically increment the reference count for the device.
1660 extern struct device *get_device(struct device *dev);
1661 extern void put_device(struct device *dev);
1662 extern bool kill_device(struct device *dev);
1664 #ifdef CONFIG_DEVTMPFS
1665 extern int devtmpfs_create_node(struct device *dev);
1666 extern int devtmpfs_delete_node(struct device *dev);
1667 extern int devtmpfs_mount(const char *mntdir);
1669 static inline int devtmpfs_create_node(struct device *dev) { return 0; }
1670 static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
1671 static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
1674 /* drivers/base/power/shutdown.c */
1675 extern void device_shutdown(void);
1677 /* debugging and troubleshooting/diagnostic helpers. */
1678 extern const char *dev_driver_string(const struct device *dev);
1680 /* Device links interface. */
1681 struct device_link *device_link_add(struct device *consumer,
1682 struct device *supplier, u32 flags);
1683 void device_link_del(struct device_link *link);
1684 void device_link_remove(void *consumer, struct device *supplier);
1685 void device_link_remove_from_wfs(struct device *consumer);
1688 #define dev_fmt(fmt) fmt
1691 #ifdef CONFIG_PRINTK
1693 __printf(3, 0) __cold
1694 int dev_vprintk_emit(int level, const struct device *dev,
1695 const char *fmt, va_list args);
1696 __printf(3, 4) __cold
1697 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...);
1699 __printf(3, 4) __cold
1700 void dev_printk(const char *level, const struct device *dev,
1701 const char *fmt, ...);
1702 __printf(2, 3) __cold
1703 void _dev_emerg(const struct device *dev, const char *fmt, ...);
1704 __printf(2, 3) __cold
1705 void _dev_alert(const struct device *dev, const char *fmt, ...);
1706 __printf(2, 3) __cold
1707 void _dev_crit(const struct device *dev, const char *fmt, ...);
1708 __printf(2, 3) __cold
1709 void _dev_err(const struct device *dev, const char *fmt, ...);
1710 __printf(2, 3) __cold
1711 void _dev_warn(const struct device *dev, const char *fmt, ...);
1712 __printf(2, 3) __cold
1713 void _dev_notice(const struct device *dev, const char *fmt, ...);
1714 __printf(2, 3) __cold
1715 void _dev_info(const struct device *dev, const char *fmt, ...);
1719 static inline __printf(3, 0)
1720 int dev_vprintk_emit(int level, const struct device *dev,
1721 const char *fmt, va_list args)
1723 static inline __printf(3, 4)
1724 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
1727 static inline void __dev_printk(const char *level, const struct device *dev,
1728 struct va_format *vaf)
1730 static inline __printf(3, 4)
1731 void dev_printk(const char *level, const struct device *dev,
1732 const char *fmt, ...)
1735 static inline __printf(2, 3)
1736 void _dev_emerg(const struct device *dev, const char *fmt, ...)
1738 static inline __printf(2, 3)
1739 void _dev_crit(const struct device *dev, const char *fmt, ...)
1741 static inline __printf(2, 3)
1742 void _dev_alert(const struct device *dev, const char *fmt, ...)
1744 static inline __printf(2, 3)
1745 void _dev_err(const struct device *dev, const char *fmt, ...)
1747 static inline __printf(2, 3)
1748 void _dev_warn(const struct device *dev, const char *fmt, ...)
1750 static inline __printf(2, 3)
1751 void _dev_notice(const struct device *dev, const char *fmt, ...)
1753 static inline __printf(2, 3)
1754 void _dev_info(const struct device *dev, const char *fmt, ...)
1760 * #defines for all the dev_<level> macros to prefix with whatever
1761 * possible use of #define dev_fmt(fmt) ...
1764 #define dev_emerg(dev, fmt, ...) \
1765 _dev_emerg(dev, dev_fmt(fmt), ##__VA_ARGS__)
1766 #define dev_crit(dev, fmt, ...) \
1767 _dev_crit(dev, dev_fmt(fmt), ##__VA_ARGS__)
1768 #define dev_alert(dev, fmt, ...) \
1769 _dev_alert(dev, dev_fmt(fmt), ##__VA_ARGS__)
1770 #define dev_err(dev, fmt, ...) \
1771 _dev_err(dev, dev_fmt(fmt), ##__VA_ARGS__)
1772 #define dev_warn(dev, fmt, ...) \
1773 _dev_warn(dev, dev_fmt(fmt), ##__VA_ARGS__)
1774 #define dev_notice(dev, fmt, ...) \
1775 _dev_notice(dev, dev_fmt(fmt), ##__VA_ARGS__)
1776 #define dev_info(dev, fmt, ...) \
1777 _dev_info(dev, dev_fmt(fmt), ##__VA_ARGS__)
1779 #if defined(CONFIG_DYNAMIC_DEBUG)
1780 #define dev_dbg(dev, fmt, ...) \
1781 dynamic_dev_dbg(dev, dev_fmt(fmt), ##__VA_ARGS__)
1782 #elif defined(DEBUG)
1783 #define dev_dbg(dev, fmt, ...) \
1784 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__)
1786 #define dev_dbg(dev, fmt, ...) \
1789 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \
1793 #ifdef CONFIG_PRINTK
1794 #define dev_level_once(dev_level, dev, fmt, ...) \
1796 static bool __print_once __read_mostly; \
1798 if (!__print_once) { \
1799 __print_once = true; \
1800 dev_level(dev, fmt, ##__VA_ARGS__); \
1804 #define dev_level_once(dev_level, dev, fmt, ...) \
1807 dev_level(dev, fmt, ##__VA_ARGS__); \
1811 #define dev_emerg_once(dev, fmt, ...) \
1812 dev_level_once(dev_emerg, dev, fmt, ##__VA_ARGS__)
1813 #define dev_alert_once(dev, fmt, ...) \
1814 dev_level_once(dev_alert, dev, fmt, ##__VA_ARGS__)
1815 #define dev_crit_once(dev, fmt, ...) \
1816 dev_level_once(dev_crit, dev, fmt, ##__VA_ARGS__)
1817 #define dev_err_once(dev, fmt, ...) \
1818 dev_level_once(dev_err, dev, fmt, ##__VA_ARGS__)
1819 #define dev_warn_once(dev, fmt, ...) \
1820 dev_level_once(dev_warn, dev, fmt, ##__VA_ARGS__)
1821 #define dev_notice_once(dev, fmt, ...) \
1822 dev_level_once(dev_notice, dev, fmt, ##__VA_ARGS__)
1823 #define dev_info_once(dev, fmt, ...) \
1824 dev_level_once(dev_info, dev, fmt, ##__VA_ARGS__)
1825 #define dev_dbg_once(dev, fmt, ...) \
1826 dev_level_once(dev_dbg, dev, fmt, ##__VA_ARGS__)
1828 #define dev_level_ratelimited(dev_level, dev, fmt, ...) \
1830 static DEFINE_RATELIMIT_STATE(_rs, \
1831 DEFAULT_RATELIMIT_INTERVAL, \
1832 DEFAULT_RATELIMIT_BURST); \
1833 if (__ratelimit(&_rs)) \
1834 dev_level(dev, fmt, ##__VA_ARGS__); \
1837 #define dev_emerg_ratelimited(dev, fmt, ...) \
1838 dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
1839 #define dev_alert_ratelimited(dev, fmt, ...) \
1840 dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
1841 #define dev_crit_ratelimited(dev, fmt, ...) \
1842 dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
1843 #define dev_err_ratelimited(dev, fmt, ...) \
1844 dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
1845 #define dev_warn_ratelimited(dev, fmt, ...) \
1846 dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
1847 #define dev_notice_ratelimited(dev, fmt, ...) \
1848 dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
1849 #define dev_info_ratelimited(dev, fmt, ...) \
1850 dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
1851 #if defined(CONFIG_DYNAMIC_DEBUG)
1852 /* descriptor check is first to prevent flooding with "callbacks suppressed" */
1853 #define dev_dbg_ratelimited(dev, fmt, ...) \
1855 static DEFINE_RATELIMIT_STATE(_rs, \
1856 DEFAULT_RATELIMIT_INTERVAL, \
1857 DEFAULT_RATELIMIT_BURST); \
1858 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
1859 if (DYNAMIC_DEBUG_BRANCH(descriptor) && \
1860 __ratelimit(&_rs)) \
1861 __dynamic_dev_dbg(&descriptor, dev, dev_fmt(fmt), \
1864 #elif defined(DEBUG)
1865 #define dev_dbg_ratelimited(dev, fmt, ...) \
1867 static DEFINE_RATELIMIT_STATE(_rs, \
1868 DEFAULT_RATELIMIT_INTERVAL, \
1869 DEFAULT_RATELIMIT_BURST); \
1870 if (__ratelimit(&_rs)) \
1871 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \
1874 #define dev_dbg_ratelimited(dev, fmt, ...) \
1877 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \
1881 #ifdef VERBOSE_DEBUG
1882 #define dev_vdbg dev_dbg
1884 #define dev_vdbg(dev, fmt, ...) \
1887 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \
1892 * dev_WARN*() acts like dev_printk(), but with the key difference of
1893 * using WARN/WARN_ONCE to include file/line information and a backtrace.
1895 #define dev_WARN(dev, format, arg...) \
1896 WARN(1, "%s %s: " format, dev_driver_string(dev), dev_name(dev), ## arg);
1898 #define dev_WARN_ONCE(dev, condition, format, arg...) \
1899 WARN_ONCE(condition, "%s %s: " format, \
1900 dev_driver_string(dev), dev_name(dev), ## arg)
1902 /* Create alias, so I can be autoloaded. */
1903 #define MODULE_ALIAS_CHARDEV(major,minor) \
1904 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1905 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1906 MODULE_ALIAS("char-major-" __stringify(major) "-*")
1908 #ifdef CONFIG_SYSFS_DEPRECATED
1909 extern long sysfs_deprecated;
1911 #define sysfs_deprecated 0
1915 * module_driver() - Helper macro for drivers that don't do anything
1916 * special in module init/exit. This eliminates a lot of boilerplate.
1917 * Each module may only use this macro once, and calling it replaces
1918 * module_init() and module_exit().
1920 * @__driver: driver name
1921 * @__register: register function for this driver type
1922 * @__unregister: unregister function for this driver type
1923 * @...: Additional arguments to be passed to __register and __unregister.
1925 * Use this macro to construct bus specific macros for registering
1926 * drivers, and do not use it on its own.
1928 #define module_driver(__driver, __register, __unregister, ...) \
1929 static int __init __driver##_init(void) \
1931 return __register(&(__driver) , ##__VA_ARGS__); \
1933 module_init(__driver##_init); \
1934 static void __exit __driver##_exit(void) \
1936 __unregister(&(__driver) , ##__VA_ARGS__); \
1938 module_exit(__driver##_exit);
1941 * builtin_driver() - Helper macro for drivers that don't do anything
1942 * special in init and have no exit. This eliminates some boilerplate.
1943 * Each driver may only use this macro once, and calling it replaces
1944 * device_initcall (or in some cases, the legacy __initcall). This is
1945 * meant to be a direct parallel of module_driver() above but without
1946 * the __exit stuff that is not used for builtin cases.
1948 * @__driver: driver name
1949 * @__register: register function for this driver type
1950 * @...: Additional arguments to be passed to __register
1952 * Use this macro to construct bus specific macros for registering
1953 * drivers, and do not use it on its own.
1955 #define builtin_driver(__driver, __register, ...) \
1956 static int __init __driver##_init(void) \
1958 return __register(&(__driver) , ##__VA_ARGS__); \
1960 device_initcall(__driver##_init);
1962 #endif /* _DEVICE_H_ */