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 * @probe: Called when a new device or driver add to this bus, and callback
82 * the specific driver's probe to initial the matched device.
83 * @remove: Called when a device removed from this bus.
84 * @shutdown: Called at shut-down time to quiesce the device.
86 * @online: Called to put the device back online (after offlining it).
87 * @offline: Called to put the device offline for hot-removal. May fail.
89 * @suspend: Called when a device on this bus wants to go to sleep mode.
90 * @resume: Called to bring a device on this bus out of sleep mode.
91 * @num_vf: Called to find out how many virtual functions a device on this
93 * @dma_configure: Called to setup DMA configuration on a device on
95 * @pm: Power management operations of this bus, callback the specific
96 * device driver's pm-ops.
97 * @iommu_ops: IOMMU specific operations for this bus, used to attach IOMMU
98 * driver implementations to a bus and allow the driver to do
100 * @p: The private data of the driver core, only the driver core can
102 * @lock_key: Lock class key for use by the lock validator
103 * @need_parent_lock: When probing or removing a device on this bus, the
104 * device core should lock the device's parent.
106 * A bus is a channel between the processor and one or more devices. For the
107 * purposes of the device model, all devices are connected via a bus, even if
108 * it is an internal, virtual, "platform" bus. Buses can plug into each other.
109 * A USB controller is usually a PCI device, for example. The device model
110 * represents the actual connections between buses and the devices they control.
111 * A bus is represented by the bus_type structure. It contains the name, the
112 * default attributes, the bus' methods, PM operations, and the driver core's
117 const char *dev_name
;
118 struct device
*dev_root
;
119 const struct attribute_group
**bus_groups
;
120 const struct attribute_group
**dev_groups
;
121 const struct attribute_group
**drv_groups
;
123 int (*match
)(struct device
*dev
, struct device_driver
*drv
);
124 int (*uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
125 int (*probe
)(struct device
*dev
);
126 int (*remove
)(struct device
*dev
);
127 void (*shutdown
)(struct device
*dev
);
129 int (*online
)(struct device
*dev
);
130 int (*offline
)(struct device
*dev
);
132 int (*suspend
)(struct device
*dev
, pm_message_t state
);
133 int (*resume
)(struct device
*dev
);
135 int (*num_vf
)(struct device
*dev
);
137 int (*dma_configure
)(struct device
*dev
);
139 const struct dev_pm_ops
*pm
;
141 const struct iommu_ops
*iommu_ops
;
143 struct subsys_private
*p
;
144 struct lock_class_key lock_key
;
146 bool need_parent_lock
;
149 extern int __must_check
bus_register(struct bus_type
*bus
);
151 extern void bus_unregister(struct bus_type
*bus
);
153 extern int __must_check
bus_rescan_devices(struct bus_type
*bus
);
155 /* iterator helpers for buses */
156 struct subsys_dev_iter
{
157 struct klist_iter ki
;
158 const struct device_type
*type
;
160 void subsys_dev_iter_init(struct subsys_dev_iter
*iter
,
161 struct bus_type
*subsys
,
162 struct device
*start
,
163 const struct device_type
*type
);
164 struct device
*subsys_dev_iter_next(struct subsys_dev_iter
*iter
);
165 void subsys_dev_iter_exit(struct subsys_dev_iter
*iter
);
167 int device_match_of_node(struct device
*dev
, const void *np
);
169 int bus_for_each_dev(struct bus_type
*bus
, struct device
*start
, void *data
,
170 int (*fn
)(struct device
*dev
, void *data
));
171 struct device
*bus_find_device(struct bus_type
*bus
, struct device
*start
,
173 int (*match
)(struct device
*dev
, const void *data
));
174 struct device
*bus_find_device_by_name(struct bus_type
*bus
,
175 struct device
*start
,
177 struct device
*subsys_find_device_by_id(struct bus_type
*bus
, unsigned int id
,
178 struct device
*hint
);
179 int bus_for_each_drv(struct bus_type
*bus
, struct device_driver
*start
,
180 void *data
, int (*fn
)(struct device_driver
*, void *));
181 void bus_sort_breadthfirst(struct bus_type
*bus
,
182 int (*compare
)(const struct device
*a
,
183 const struct device
*b
));
185 * Bus notifiers: Get notified of addition/removal of devices
186 * and binding/unbinding of drivers to devices.
187 * In the long run, it should be a replacement for the platform
190 struct notifier_block
;
192 extern int bus_register_notifier(struct bus_type
*bus
,
193 struct notifier_block
*nb
);
194 extern int bus_unregister_notifier(struct bus_type
*bus
,
195 struct notifier_block
*nb
);
197 /* All 4 notifers below get called with the target struct device *
198 * as an argument. Note that those functions are likely to be called
199 * with the device lock held in the core, so be careful.
201 #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
202 #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device to be removed */
203 #define BUS_NOTIFY_REMOVED_DEVICE 0x00000003 /* device removed */
204 #define BUS_NOTIFY_BIND_DRIVER 0x00000004 /* driver about to be
206 #define BUS_NOTIFY_BOUND_DRIVER 0x00000005 /* driver bound to device */
207 #define BUS_NOTIFY_UNBIND_DRIVER 0x00000006 /* driver about to be
209 #define BUS_NOTIFY_UNBOUND_DRIVER 0x00000007 /* driver is unbound
211 #define BUS_NOTIFY_DRIVER_NOT_BOUND 0x00000008 /* driver fails to be bound */
213 extern struct kset
*bus_get_kset(struct bus_type
*bus
);
214 extern struct klist
*bus_get_device_klist(struct bus_type
*bus
);
217 * enum probe_type - device driver probe type to try
218 * Device drivers may opt in for special handling of their
219 * respective probe routines. This tells the core what to
222 * @PROBE_DEFAULT_STRATEGY: Used by drivers that work equally well
223 * whether probed synchronously or asynchronously.
224 * @PROBE_PREFER_ASYNCHRONOUS: Drivers for "slow" devices which
225 * probing order is not essential for booting the system may
226 * opt into executing their probes asynchronously.
227 * @PROBE_FORCE_SYNCHRONOUS: Use this to annotate drivers that need
228 * their probe routines to run synchronously with driver and
229 * device registration (with the exception of -EPROBE_DEFER
230 * handling - re-probing always ends up being done asynchronously).
232 * Note that the end goal is to switch the kernel to use asynchronous
233 * probing by default, so annotating drivers with
234 * %PROBE_PREFER_ASYNCHRONOUS is a temporary measure that allows us
235 * to speed up boot process while we are validating the rest of the
239 PROBE_DEFAULT_STRATEGY
,
240 PROBE_PREFER_ASYNCHRONOUS
,
241 PROBE_FORCE_SYNCHRONOUS
,
245 * struct device_driver - The basic device driver structure
246 * @name: Name of the device driver.
247 * @bus: The bus which the device of this driver belongs to.
248 * @owner: The module owner.
249 * @mod_name: Used for built-in modules.
250 * @suppress_bind_attrs: Disables bind/unbind via sysfs.
251 * @probe_type: Type of the probe (synchronous or asynchronous) to use.
252 * @of_match_table: The open firmware table.
253 * @acpi_match_table: The ACPI match table.
254 * @probe: Called to query the existence of a specific device,
255 * whether this driver can work with it, and bind the driver
256 * to a specific device.
257 * @remove: Called when the device is removed from the system to
258 * unbind a device from this driver.
259 * @shutdown: Called at shut-down time to quiesce the device.
260 * @suspend: Called to put the device to sleep mode. Usually to a
262 * @resume: Called to bring a device from sleep mode.
263 * @groups: Default attributes that get created by the driver core
265 * @pm: Power management operations of the device which matched
267 * @coredump: Called when sysfs entry is written to. The device driver
268 * is expected to call the dev_coredump API resulting in a
270 * @p: Driver core's private data, no one other than the driver
271 * core can touch this.
273 * The device driver-model tracks all of the drivers known to the system.
274 * The main reason for this tracking is to enable the driver core to match
275 * up drivers with new devices. Once drivers are known objects within the
276 * system, however, a number of other things become possible. Device drivers
277 * can export information and configuration variables that are independent
278 * of any specific device.
280 struct device_driver
{
282 struct bus_type
*bus
;
284 struct module
*owner
;
285 const char *mod_name
; /* used for built-in modules */
287 bool suppress_bind_attrs
; /* disables bind/unbind via sysfs */
288 enum probe_type probe_type
;
290 const struct of_device_id
*of_match_table
;
291 const struct acpi_device_id
*acpi_match_table
;
293 int (*probe
) (struct device
*dev
);
294 int (*remove
) (struct device
*dev
);
295 void (*shutdown
) (struct device
*dev
);
296 int (*suspend
) (struct device
*dev
, pm_message_t state
);
297 int (*resume
) (struct device
*dev
);
298 const struct attribute_group
**groups
;
300 const struct dev_pm_ops
*pm
;
301 void (*coredump
) (struct device
*dev
);
303 struct driver_private
*p
;
307 extern int __must_check
driver_register(struct device_driver
*drv
);
308 extern void driver_unregister(struct device_driver
*drv
);
310 extern struct device_driver
*driver_find(const char *name
,
311 struct bus_type
*bus
);
312 extern int driver_probe_done(void);
313 extern void wait_for_device_probe(void);
315 /* sysfs interface for exporting driver attributes */
317 struct driver_attribute
{
318 struct attribute attr
;
319 ssize_t (*show
)(struct device_driver
*driver
, char *buf
);
320 ssize_t (*store
)(struct device_driver
*driver
, const char *buf
,
324 #define DRIVER_ATTR_RW(_name) \
325 struct driver_attribute driver_attr_##_name = __ATTR_RW(_name)
326 #define DRIVER_ATTR_RO(_name) \
327 struct driver_attribute driver_attr_##_name = __ATTR_RO(_name)
328 #define DRIVER_ATTR_WO(_name) \
329 struct driver_attribute driver_attr_##_name = __ATTR_WO(_name)
331 extern int __must_check
driver_create_file(struct device_driver
*driver
,
332 const struct driver_attribute
*attr
);
333 extern void driver_remove_file(struct device_driver
*driver
,
334 const struct driver_attribute
*attr
);
336 extern int __must_check
driver_for_each_device(struct device_driver
*drv
,
337 struct device
*start
,
339 int (*fn
)(struct device
*dev
,
341 struct device
*driver_find_device(struct device_driver
*drv
,
342 struct device
*start
, const void *data
,
343 int (*match
)(struct device
*dev
, const void *data
));
345 void driver_deferred_probe_add(struct device
*dev
);
346 int driver_deferred_probe_check_state(struct device
*dev
);
347 int driver_deferred_probe_check_state_continue(struct device
*dev
);
350 * struct subsys_interface - interfaces to device functions
351 * @name: name of the device function
352 * @subsys: subsytem of the devices to attach to
353 * @node: the list of functions registered at the subsystem
354 * @add_dev: device hookup to device function handler
355 * @remove_dev: device hookup to device function handler
357 * Simple interfaces attached to a subsystem. Multiple interfaces can
358 * attach to a subsystem and its devices. Unlike drivers, they do not
359 * exclusively claim or control devices. Interfaces usually represent
360 * a specific functionality of a subsystem/class of devices.
362 struct subsys_interface
{
364 struct bus_type
*subsys
;
365 struct list_head node
;
366 int (*add_dev
)(struct device
*dev
, struct subsys_interface
*sif
);
367 void (*remove_dev
)(struct device
*dev
, struct subsys_interface
*sif
);
370 int subsys_interface_register(struct subsys_interface
*sif
);
371 void subsys_interface_unregister(struct subsys_interface
*sif
);
373 int subsys_system_register(struct bus_type
*subsys
,
374 const struct attribute_group
**groups
);
375 int subsys_virtual_register(struct bus_type
*subsys
,
376 const struct attribute_group
**groups
);
379 * struct class - device classes
380 * @name: Name of the class.
381 * @owner: The module owner.
382 * @class_groups: Default attributes of this class.
383 * @dev_groups: Default attributes of the devices that belong to the class.
384 * @dev_kobj: The kobject that represents this class and links it into the hierarchy.
385 * @dev_uevent: Called when a device is added, removed from this class, or a
386 * few other things that generate uevents to add the environment
388 * @devnode: Callback to provide the devtmpfs.
389 * @class_release: Called to release this class.
390 * @dev_release: Called to release the device.
391 * @shutdown_pre: Called at shut-down time before driver shutdown.
392 * @ns_type: Callbacks so sysfs can detemine namespaces.
393 * @namespace: Namespace of the device belongs to this class.
394 * @get_ownership: Allows class to specify uid/gid of the sysfs directories
395 * for the devices belonging to the class. Usually tied to
396 * device's namespace.
397 * @pm: The default device power management operations of this class.
398 * @p: The private data of the driver core, no one other than the
399 * driver core can touch this.
401 * A class is a higher-level view of a device that abstracts out low-level
402 * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
403 * at the class level, they are all simply disks. Classes allow user space
404 * to work with devices based on what they do, rather than how they are
405 * connected or how they work.
409 struct module
*owner
;
411 const struct attribute_group
**class_groups
;
412 const struct attribute_group
**dev_groups
;
413 struct kobject
*dev_kobj
;
415 int (*dev_uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
416 char *(*devnode
)(struct device
*dev
, umode_t
*mode
);
418 void (*class_release
)(struct class *class);
419 void (*dev_release
)(struct device
*dev
);
421 int (*shutdown_pre
)(struct device
*dev
);
423 const struct kobj_ns_type_operations
*ns_type
;
424 const void *(*namespace)(struct device
*dev
);
426 void (*get_ownership
)(struct device
*dev
, kuid_t
*uid
, kgid_t
*gid
);
428 const struct dev_pm_ops
*pm
;
430 struct subsys_private
*p
;
433 struct class_dev_iter
{
434 struct klist_iter ki
;
435 const struct device_type
*type
;
438 extern struct kobject
*sysfs_dev_block_kobj
;
439 extern struct kobject
*sysfs_dev_char_kobj
;
440 extern int __must_check
__class_register(struct class *class,
441 struct lock_class_key
*key
);
442 extern void class_unregister(struct class *class);
444 /* This is a #define to keep the compiler from merging different
445 * instances of the __key variable */
446 #define class_register(class) \
448 static struct lock_class_key __key; \
449 __class_register(class, &__key); \
453 struct class_compat
*class_compat_register(const char *name
);
454 void class_compat_unregister(struct class_compat
*cls
);
455 int class_compat_create_link(struct class_compat
*cls
, struct device
*dev
,
456 struct device
*device_link
);
457 void class_compat_remove_link(struct class_compat
*cls
, struct device
*dev
,
458 struct device
*device_link
);
460 extern void class_dev_iter_init(struct class_dev_iter
*iter
,
462 struct device
*start
,
463 const struct device_type
*type
);
464 extern struct device
*class_dev_iter_next(struct class_dev_iter
*iter
);
465 extern void class_dev_iter_exit(struct class_dev_iter
*iter
);
467 extern int class_for_each_device(struct class *class, struct device
*start
,
469 int (*fn
)(struct device
*dev
, void *data
));
470 extern struct device
*class_find_device(struct class *class,
471 struct device
*start
, const void *data
,
472 int (*match
)(struct device
*, const void *));
474 struct class_attribute
{
475 struct attribute attr
;
476 ssize_t (*show
)(struct class *class, struct class_attribute
*attr
,
478 ssize_t (*store
)(struct class *class, struct class_attribute
*attr
,
479 const char *buf
, size_t count
);
482 #define CLASS_ATTR_RW(_name) \
483 struct class_attribute class_attr_##_name = __ATTR_RW(_name)
484 #define CLASS_ATTR_RO(_name) \
485 struct class_attribute class_attr_##_name = __ATTR_RO(_name)
486 #define CLASS_ATTR_WO(_name) \
487 struct class_attribute class_attr_##_name = __ATTR_WO(_name)
489 extern int __must_check
class_create_file_ns(struct class *class,
490 const struct class_attribute
*attr
,
492 extern void class_remove_file_ns(struct class *class,
493 const struct class_attribute
*attr
,
496 static inline int __must_check
class_create_file(struct class *class,
497 const struct class_attribute
*attr
)
499 return class_create_file_ns(class, attr
, NULL
);
502 static inline void class_remove_file(struct class *class,
503 const struct class_attribute
*attr
)
505 return class_remove_file_ns(class, attr
, NULL
);
508 /* Simple class attribute that is just a static string */
509 struct class_attribute_string
{
510 struct class_attribute attr
;
514 /* Currently read-only only */
515 #define _CLASS_ATTR_STRING(_name, _mode, _str) \
516 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
517 #define CLASS_ATTR_STRING(_name, _mode, _str) \
518 struct class_attribute_string class_attr_##_name = \
519 _CLASS_ATTR_STRING(_name, _mode, _str)
521 extern ssize_t
show_class_attr_string(struct class *class, struct class_attribute
*attr
,
524 struct class_interface
{
525 struct list_head node
;
528 int (*add_dev
) (struct device
*, struct class_interface
*);
529 void (*remove_dev
) (struct device
*, struct class_interface
*);
532 extern int __must_check
class_interface_register(struct class_interface
*);
533 extern void class_interface_unregister(struct class_interface
*);
535 extern struct class * __must_check
__class_create(struct module
*owner
,
537 struct lock_class_key
*key
);
538 extern void class_destroy(struct class *cls
);
540 /* This is a #define to keep the compiler from merging different
541 * instances of the __key variable */
542 #define class_create(owner, name) \
544 static struct lock_class_key __key; \
545 __class_create(owner, name, &__key); \
549 * The type of device, "struct device" is embedded in. A class
550 * or bus can contain devices of different types
551 * like "partitions" and "disks", "mouse" and "event".
552 * This identifies the device type and carries type-specific
553 * information, equivalent to the kobj_type of a kobject.
554 * If "name" is specified, the uevent will contain it in
555 * the DEVTYPE variable.
559 const struct attribute_group
**groups
;
560 int (*uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
561 char *(*devnode
)(struct device
*dev
, umode_t
*mode
,
562 kuid_t
*uid
, kgid_t
*gid
);
563 void (*release
)(struct device
*dev
);
565 const struct dev_pm_ops
*pm
;
568 /* interface for exporting device attributes */
569 struct device_attribute
{
570 struct attribute attr
;
571 ssize_t (*show
)(struct device
*dev
, struct device_attribute
*attr
,
573 ssize_t (*store
)(struct device
*dev
, struct device_attribute
*attr
,
574 const char *buf
, size_t count
);
577 struct dev_ext_attribute
{
578 struct device_attribute attr
;
582 ssize_t
device_show_ulong(struct device
*dev
, struct device_attribute
*attr
,
584 ssize_t
device_store_ulong(struct device
*dev
, struct device_attribute
*attr
,
585 const char *buf
, size_t count
);
586 ssize_t
device_show_int(struct device
*dev
, struct device_attribute
*attr
,
588 ssize_t
device_store_int(struct device
*dev
, struct device_attribute
*attr
,
589 const char *buf
, size_t count
);
590 ssize_t
device_show_bool(struct device
*dev
, struct device_attribute
*attr
,
592 ssize_t
device_store_bool(struct device
*dev
, struct device_attribute
*attr
,
593 const char *buf
, size_t count
);
595 #define DEVICE_ATTR(_name, _mode, _show, _store) \
596 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
597 #define DEVICE_ATTR_PREALLOC(_name, _mode, _show, _store) \
598 struct device_attribute dev_attr_##_name = \
599 __ATTR_PREALLOC(_name, _mode, _show, _store)
600 #define DEVICE_ATTR_RW(_name) \
601 struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
602 #define DEVICE_ATTR_RO(_name) \
603 struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
604 #define DEVICE_ATTR_WO(_name) \
605 struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
606 #define DEVICE_ULONG_ATTR(_name, _mode, _var) \
607 struct dev_ext_attribute dev_attr_##_name = \
608 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
609 #define DEVICE_INT_ATTR(_name, _mode, _var) \
610 struct dev_ext_attribute dev_attr_##_name = \
611 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
612 #define DEVICE_BOOL_ATTR(_name, _mode, _var) \
613 struct dev_ext_attribute dev_attr_##_name = \
614 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
615 #define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
616 struct device_attribute dev_attr_##_name = \
617 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
619 extern int device_create_file(struct device
*device
,
620 const struct device_attribute
*entry
);
621 extern void device_remove_file(struct device
*dev
,
622 const struct device_attribute
*attr
);
623 extern bool device_remove_file_self(struct device
*dev
,
624 const struct device_attribute
*attr
);
625 extern int __must_check
device_create_bin_file(struct device
*dev
,
626 const struct bin_attribute
*attr
);
627 extern void device_remove_bin_file(struct device
*dev
,
628 const struct bin_attribute
*attr
);
630 /* device resource management */
631 typedef void (*dr_release_t
)(struct device
*dev
, void *res
);
632 typedef int (*dr_match_t
)(struct device
*dev
, void *res
, void *match_data
);
634 #ifdef CONFIG_DEBUG_DEVRES
635 extern void *__devres_alloc_node(dr_release_t release
, size_t size
, gfp_t gfp
,
636 int nid
, const char *name
) __malloc
;
637 #define devres_alloc(release, size, gfp) \
638 __devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release)
639 #define devres_alloc_node(release, size, gfp, nid) \
640 __devres_alloc_node(release, size, gfp, nid, #release)
642 extern void *devres_alloc_node(dr_release_t release
, size_t size
, gfp_t gfp
,
644 static inline void *devres_alloc(dr_release_t release
, size_t size
, gfp_t gfp
)
646 return devres_alloc_node(release
, size
, gfp
, NUMA_NO_NODE
);
650 extern void devres_for_each_res(struct device
*dev
, dr_release_t release
,
651 dr_match_t match
, void *match_data
,
652 void (*fn
)(struct device
*, void *, void *),
654 extern void devres_free(void *res
);
655 extern void devres_add(struct device
*dev
, void *res
);
656 extern void *devres_find(struct device
*dev
, dr_release_t release
,
657 dr_match_t match
, void *match_data
);
658 extern void *devres_get(struct device
*dev
, void *new_res
,
659 dr_match_t match
, void *match_data
);
660 extern void *devres_remove(struct device
*dev
, dr_release_t release
,
661 dr_match_t match
, void *match_data
);
662 extern int devres_destroy(struct device
*dev
, dr_release_t release
,
663 dr_match_t match
, void *match_data
);
664 extern int devres_release(struct device
*dev
, dr_release_t release
,
665 dr_match_t match
, void *match_data
);
668 extern void * __must_check
devres_open_group(struct device
*dev
, void *id
,
670 extern void devres_close_group(struct device
*dev
, void *id
);
671 extern void devres_remove_group(struct device
*dev
, void *id
);
672 extern int devres_release_group(struct device
*dev
, void *id
);
674 /* managed devm_k.alloc/kfree for device drivers */
675 extern void *devm_kmalloc(struct device
*dev
, size_t size
, gfp_t gfp
) __malloc
;
676 extern __printf(3, 0)
677 char *devm_kvasprintf(struct device
*dev
, gfp_t gfp
, const char *fmt
,
678 va_list ap
) __malloc
;
679 extern __printf(3, 4)
680 char *devm_kasprintf(struct device
*dev
, gfp_t gfp
, const char *fmt
, ...) __malloc
;
681 static inline void *devm_kzalloc(struct device
*dev
, size_t size
, gfp_t gfp
)
683 return devm_kmalloc(dev
, size
, gfp
| __GFP_ZERO
);
685 static inline void *devm_kmalloc_array(struct device
*dev
,
686 size_t n
, size_t size
, gfp_t flags
)
690 if (unlikely(check_mul_overflow(n
, size
, &bytes
)))
693 return devm_kmalloc(dev
, bytes
, flags
);
695 static inline void *devm_kcalloc(struct device
*dev
,
696 size_t n
, size_t size
, gfp_t flags
)
698 return devm_kmalloc_array(dev
, n
, size
, flags
| __GFP_ZERO
);
700 extern void devm_kfree(struct device
*dev
, const void *p
);
701 extern char *devm_kstrdup(struct device
*dev
, const char *s
, gfp_t gfp
) __malloc
;
702 extern const char *devm_kstrdup_const(struct device
*dev
,
703 const char *s
, gfp_t gfp
);
704 extern void *devm_kmemdup(struct device
*dev
, const void *src
, size_t len
,
707 extern unsigned long devm_get_free_pages(struct device
*dev
,
708 gfp_t gfp_mask
, unsigned int order
);
709 extern void devm_free_pages(struct device
*dev
, unsigned long addr
);
711 void __iomem
*devm_ioremap_resource(struct device
*dev
,
712 const struct resource
*res
);
714 void __iomem
*devm_of_iomap(struct device
*dev
,
715 struct device_node
*node
, int index
,
716 resource_size_t
*size
);
718 /* allows to add/remove a custom action to devres stack */
719 int devm_add_action(struct device
*dev
, void (*action
)(void *), void *data
);
720 void devm_remove_action(struct device
*dev
, void (*action
)(void *), void *data
);
721 void devm_release_action(struct device
*dev
, void (*action
)(void *), void *data
);
723 static inline int devm_add_action_or_reset(struct device
*dev
,
724 void (*action
)(void *), void *data
)
728 ret
= devm_add_action(dev
, action
, data
);
736 * devm_alloc_percpu - Resource-managed alloc_percpu
737 * @dev: Device to allocate per-cpu memory for
738 * @type: Type to allocate per-cpu memory for
740 * Managed alloc_percpu. Per-cpu memory allocated with this function is
741 * automatically freed on driver detach.
744 * Pointer to allocated memory on success, NULL on failure.
746 #define devm_alloc_percpu(dev, type) \
747 ((typeof(type) __percpu *)__devm_alloc_percpu((dev), sizeof(type), \
750 void __percpu
*__devm_alloc_percpu(struct device
*dev
, size_t size
,
752 void devm_free_percpu(struct device
*dev
, void __percpu
*pdata
);
754 struct device_dma_parameters
{
756 * a low level driver may set these to teach IOMMU code about
759 unsigned int max_segment_size
;
760 unsigned long segment_boundary_mask
;
764 * struct device_connection - Device Connection Descriptor
765 * @fwnode: The device node of the connected device
766 * @endpoint: The names of the two devices connected together
767 * @id: Unique identifier for the connection
768 * @list: List head, private, for internal use only
770 * NOTE: @fwnode is not used together with @endpoint. @fwnode is used when
771 * platform firmware defines the connection. When the connection is registered
772 * with device_connection_add() @endpoint is used instead.
774 struct device_connection
{
775 struct fwnode_handle
*fwnode
;
776 const char *endpoint
[2];
778 struct list_head list
;
781 void *device_connection_find_match(struct device
*dev
, const char *con_id
,
783 void *(*match
)(struct device_connection
*con
,
784 int ep
, void *data
));
786 struct device
*device_connection_find(struct device
*dev
, const char *con_id
);
788 void device_connection_add(struct device_connection
*con
);
789 void device_connection_remove(struct device_connection
*con
);
792 * device_connections_add - Add multiple device connections at once
793 * @cons: Zero terminated array of device connection descriptors
795 static inline void device_connections_add(struct device_connection
*cons
)
797 struct device_connection
*c
;
799 for (c
= cons
; c
->endpoint
[0]; c
++)
800 device_connection_add(c
);
804 * device_connections_remove - Remove multiple device connections at once
805 * @cons: Zero terminated array of device connection descriptors
807 static inline void device_connections_remove(struct device_connection
*cons
)
809 struct device_connection
*c
;
811 for (c
= cons
; c
->endpoint
[0]; c
++)
812 device_connection_remove(c
);
816 * enum device_link_state - Device link states.
817 * @DL_STATE_NONE: The presence of the drivers is not being tracked.
818 * @DL_STATE_DORMANT: None of the supplier/consumer drivers is present.
819 * @DL_STATE_AVAILABLE: The supplier driver is present, but the consumer is not.
820 * @DL_STATE_CONSUMER_PROBE: The consumer is probing (supplier driver present).
821 * @DL_STATE_ACTIVE: Both the supplier and consumer drivers are present.
822 * @DL_STATE_SUPPLIER_UNBIND: The supplier driver is unbinding.
824 enum device_link_state
{
826 DL_STATE_DORMANT
= 0,
828 DL_STATE_CONSUMER_PROBE
,
830 DL_STATE_SUPPLIER_UNBIND
,
836 * STATELESS: The core won't track the presence of supplier/consumer drivers.
837 * AUTOREMOVE_CONSUMER: Remove the link automatically on consumer driver unbind.
838 * PM_RUNTIME: If set, the runtime PM framework will use this link.
839 * RPM_ACTIVE: Run pm_runtime_get_sync() on the supplier during link creation.
840 * AUTOREMOVE_SUPPLIER: Remove the link automatically on supplier driver unbind.
841 * AUTOPROBE_CONSUMER: Probe consumer driver automatically after supplier binds.
843 #define DL_FLAG_STATELESS BIT(0)
844 #define DL_FLAG_AUTOREMOVE_CONSUMER BIT(1)
845 #define DL_FLAG_PM_RUNTIME BIT(2)
846 #define DL_FLAG_RPM_ACTIVE BIT(3)
847 #define DL_FLAG_AUTOREMOVE_SUPPLIER BIT(4)
848 #define DL_FLAG_AUTOPROBE_CONSUMER BIT(5)
851 * struct device_link - Device link representation.
852 * @supplier: The device on the supplier end of the link.
853 * @s_node: Hook to the supplier device's list of links to consumers.
854 * @consumer: The device on the consumer end of the link.
855 * @c_node: Hook to the consumer device's list of links to suppliers.
856 * @status: The state of the link (with respect to the presence of drivers).
857 * @flags: Link flags.
858 * @rpm_active: Whether or not the consumer device is runtime-PM-active.
859 * @kref: Count repeated addition of the same link.
860 * @rcu_head: An RCU head to use for deferred execution of SRCU callbacks.
861 * @supplier_preactivated: Supplier has been made active before consumer probe.
864 struct device
*supplier
;
865 struct list_head s_node
;
866 struct device
*consumer
;
867 struct list_head c_node
;
868 enum device_link_state status
;
870 refcount_t rpm_active
;
873 struct rcu_head rcu_head
;
875 bool supplier_preactivated
; /* Owned by consumer probe. */
879 * enum dl_dev_state - Device driver presence tracking information.
880 * @DL_DEV_NO_DRIVER: There is no driver attached to the device.
881 * @DL_DEV_PROBING: A driver is probing.
882 * @DL_DEV_DRIVER_BOUND: The driver has been bound to the device.
883 * @DL_DEV_UNBINDING: The driver is unbinding from the device.
886 DL_DEV_NO_DRIVER
= 0,
893 * struct dev_links_info - Device data related to device links.
894 * @suppliers: List of links to supplier devices.
895 * @consumers: List of links to consumer devices.
896 * @status: Driver status information.
898 struct dev_links_info
{
899 struct list_head suppliers
;
900 struct list_head consumers
;
901 enum dl_dev_state status
;
905 * struct device - The basic device structure
906 * @parent: The device's "parent" device, the device to which it is attached.
907 * In most cases, a parent device is some sort of bus or host
908 * controller. If parent is NULL, the device, is a top-level device,
909 * which is not usually what you want.
910 * @p: Holds the private data of the driver core portions of the device.
911 * See the comment of the struct device_private for detail.
912 * @kobj: A top-level, abstract class from which other classes are derived.
913 * @init_name: Initial name of the device.
914 * @type: The type of device.
915 * This identifies the device type and carries type-specific
917 * @mutex: Mutex to synchronize calls to its driver.
918 * @lockdep_mutex: An optional debug lock that a subsystem can use as a
919 * peer lock to gain localized lockdep coverage of the device_lock.
920 * @bus: Type of bus device is on.
921 * @driver: Which driver has allocated this
922 * @platform_data: Platform data specific to the device.
923 * Example: For devices on custom boards, as typical of embedded
924 * and SOC based hardware, Linux often uses platform_data to point
925 * to board-specific structures describing devices and how they
926 * are wired. That can include what ports are available, chip
927 * variants, which GPIO pins act in what additional roles, and so
928 * on. This shrinks the "Board Support Packages" (BSPs) and
929 * minimizes board-specific #ifdefs in drivers.
930 * @driver_data: Private pointer for driver specific info.
931 * @links: Links to suppliers and consumers of this device.
932 * @power: For device power management.
933 * See Documentation/driver-api/pm/devices.rst for details.
934 * @pm_domain: Provide callbacks that are executed during system suspend,
935 * hibernation, system resume and during runtime PM transitions
936 * along with subsystem-level and driver-level callbacks.
937 * @pins: For device pin management.
938 * See Documentation/driver-api/pinctl.rst for details.
939 * @msi_list: Hosts MSI descriptors
940 * @msi_domain: The generic MSI domain this device is using.
941 * @numa_node: NUMA node this device is close to.
942 * @dma_ops: DMA mapping operations for this device.
943 * @dma_mask: Dma mask (if dma'ble device).
944 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
945 * hardware supports 64-bit addresses for consistent allocations
947 * @bus_dma_mask: Mask of an upstream bridge or bus which imposes a smaller DMA
948 * limit than the device itself supports.
949 * @dma_pfn_offset: offset of DMA memory range relatively of RAM
950 * @dma_parms: A low level driver may set these to teach IOMMU code about
951 * segment limitations.
952 * @dma_pools: Dma pools (if dma'ble device).
953 * @dma_mem: Internal for coherent mem override.
954 * @cma_area: Contiguous memory area for dma allocations
955 * @archdata: For arch-specific additions.
956 * @of_node: Associated device tree node.
957 * @fwnode: Associated device node supplied by platform firmware.
958 * @devt: For creating the sysfs "dev".
959 * @id: device instance
960 * @devres_lock: Spinlock to protect the resource of the device.
961 * @devres_head: The resources list of the device.
962 * @knode_class: The node used to add the device to the class list.
963 * @class: The class of the device.
964 * @groups: Optional attribute groups.
965 * @release: Callback to free the device after all references have
966 * gone away. This should be set by the allocator of the
967 * device (i.e. the bus driver that discovered the device).
968 * @iommu_group: IOMMU group the device belongs to.
969 * @iommu_fwspec: IOMMU-specific properties supplied by firmware.
970 * @iommu_param: Per device generic IOMMU runtime data
972 * @offline_disabled: If set, the device is permanently online.
973 * @offline: Set after successful invocation of bus type's .offline().
974 * @of_node_reused: Set if the device-tree node is shared with an ancestor
976 * @dma_coherent: this particular device is dma coherent, even if the
977 * architecture supports non-coherent devices.
979 * At the lowest level, every device in a Linux system is represented by an
980 * instance of struct device. The device structure contains the information
981 * that the device model core needs to model the system. Most subsystems,
982 * however, track additional information about the devices they host. As a
983 * result, it is rare for devices to be represented by bare device structures;
984 * instead, that structure, like kobject structures, is usually embedded within
985 * a higher-level representation of the device.
989 struct device
*parent
;
991 struct device_private
*p
;
993 const char *init_name
; /* initial name of the device */
994 const struct device_type
*type
;
996 struct bus_type
*bus
; /* type of bus device is on */
997 struct device_driver
*driver
; /* which driver has allocated this
999 void *platform_data
; /* Platform specific data, device
1000 core doesn't touch it */
1001 void *driver_data
; /* Driver data, set and get with
1002 dev_set_drvdata/dev_get_drvdata */
1003 #ifdef CONFIG_PROVE_LOCKING
1004 struct mutex lockdep_mutex
;
1006 struct mutex mutex
; /* mutex to synchronize calls to
1010 struct dev_links_info links
;
1011 struct dev_pm_info power
;
1012 struct dev_pm_domain
*pm_domain
;
1014 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
1015 struct irq_domain
*msi_domain
;
1017 #ifdef CONFIG_PINCTRL
1018 struct dev_pin_info
*pins
;
1020 #ifdef CONFIG_GENERIC_MSI_IRQ
1021 struct list_head msi_list
;
1024 const struct dma_map_ops
*dma_ops
;
1025 u64
*dma_mask
; /* dma mask (if dma'able device) */
1026 u64 coherent_dma_mask
;/* Like dma_mask, but for
1027 alloc_coherent mappings as
1028 not all hardware supports
1029 64 bit addresses for consistent
1030 allocations such descriptors. */
1031 u64 bus_dma_mask
; /* upstream dma_mask constraint */
1032 unsigned long dma_pfn_offset
;
1034 struct device_dma_parameters
*dma_parms
;
1036 struct list_head dma_pools
; /* dma pools (if dma'ble) */
1038 #ifdef CONFIG_DMA_DECLARE_COHERENT
1039 struct dma_coherent_mem
*dma_mem
; /* internal for coherent mem
1042 #ifdef CONFIG_DMA_CMA
1043 struct cma
*cma_area
; /* contiguous memory area for dma
1046 /* arch specific additions */
1047 struct dev_archdata archdata
;
1049 struct device_node
*of_node
; /* associated device tree node */
1050 struct fwnode_handle
*fwnode
; /* firmware device node */
1053 int numa_node
; /* NUMA node this device is close to */
1055 dev_t devt
; /* dev_t, creates the sysfs "dev" */
1056 u32 id
; /* device instance */
1058 spinlock_t devres_lock
;
1059 struct list_head devres_head
;
1061 struct class *class;
1062 const struct attribute_group
**groups
; /* optional groups */
1064 void (*release
)(struct device
*dev
);
1065 struct iommu_group
*iommu_group
;
1066 struct iommu_fwspec
*iommu_fwspec
;
1067 struct iommu_param
*iommu_param
;
1069 bool offline_disabled
:1;
1071 bool of_node_reused
:1;
1072 #if defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_DEVICE) || \
1073 defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU) || \
1074 defined(CONFIG_ARCH_HAS_SYNC_DMA_FOR_CPU_ALL)
1075 bool dma_coherent
:1;
1079 static inline struct device
*kobj_to_dev(struct kobject
*kobj
)
1081 return container_of(kobj
, struct device
, kobj
);
1085 * device_iommu_mapped - Returns true when the device DMA is translated
1087 * @dev: Device to perform the check on
1089 static inline bool device_iommu_mapped(struct device
*dev
)
1091 return (dev
->iommu_group
!= NULL
);
1094 /* Get the wakeup routines, which depend on struct device */
1095 #include <linux/pm_wakeup.h>
1097 static inline const char *dev_name(const struct device
*dev
)
1099 /* Use the init name until the kobject becomes available */
1101 return dev
->init_name
;
1103 return kobject_name(&dev
->kobj
);
1106 extern __printf(2, 3)
1107 int dev_set_name(struct device
*dev
, const char *name
, ...);
1110 static inline int dev_to_node(struct device
*dev
)
1112 return dev
->numa_node
;
1114 static inline void set_dev_node(struct device
*dev
, int node
)
1116 dev
->numa_node
= node
;
1119 static inline int dev_to_node(struct device
*dev
)
1121 return NUMA_NO_NODE
;
1123 static inline void set_dev_node(struct device
*dev
, int node
)
1128 static inline struct irq_domain
*dev_get_msi_domain(const struct device
*dev
)
1130 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
1131 return dev
->msi_domain
;
1137 static inline void dev_set_msi_domain(struct device
*dev
, struct irq_domain
*d
)
1139 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
1140 dev
->msi_domain
= d
;
1144 static inline void *dev_get_drvdata(const struct device
*dev
)
1146 return dev
->driver_data
;
1149 static inline void dev_set_drvdata(struct device
*dev
, void *data
)
1151 dev
->driver_data
= data
;
1154 static inline struct pm_subsys_data
*dev_to_psd(struct device
*dev
)
1156 return dev
? dev
->power
.subsys_data
: NULL
;
1159 static inline unsigned int dev_get_uevent_suppress(const struct device
*dev
)
1161 return dev
->kobj
.uevent_suppress
;
1164 static inline void dev_set_uevent_suppress(struct device
*dev
, int val
)
1166 dev
->kobj
.uevent_suppress
= val
;
1169 static inline int device_is_registered(struct device
*dev
)
1171 return dev
->kobj
.state_in_sysfs
;
1174 static inline void device_enable_async_suspend(struct device
*dev
)
1176 if (!dev
->power
.is_prepared
)
1177 dev
->power
.async_suspend
= true;
1180 static inline void device_disable_async_suspend(struct device
*dev
)
1182 if (!dev
->power
.is_prepared
)
1183 dev
->power
.async_suspend
= false;
1186 static inline bool device_async_suspend_enabled(struct device
*dev
)
1188 return !!dev
->power
.async_suspend
;
1191 static inline bool device_pm_not_required(struct device
*dev
)
1193 return dev
->power
.no_pm
;
1196 static inline void device_set_pm_not_required(struct device
*dev
)
1198 dev
->power
.no_pm
= true;
1201 static inline void dev_pm_syscore_device(struct device
*dev
, bool val
)
1203 #ifdef CONFIG_PM_SLEEP
1204 dev
->power
.syscore
= val
;
1208 static inline void dev_pm_set_driver_flags(struct device
*dev
, u32 flags
)
1210 dev
->power
.driver_flags
= flags
;
1213 static inline bool dev_pm_test_driver_flags(struct device
*dev
, u32 flags
)
1215 return !!(dev
->power
.driver_flags
& flags
);
1218 static inline void device_lock(struct device
*dev
)
1220 mutex_lock(&dev
->mutex
);
1223 static inline int device_lock_interruptible(struct device
*dev
)
1225 return mutex_lock_interruptible(&dev
->mutex
);
1228 static inline int device_trylock(struct device
*dev
)
1230 return mutex_trylock(&dev
->mutex
);
1233 static inline void device_unlock(struct device
*dev
)
1235 mutex_unlock(&dev
->mutex
);
1238 static inline void device_lock_assert(struct device
*dev
)
1240 lockdep_assert_held(&dev
->mutex
);
1243 static inline struct device_node
*dev_of_node(struct device
*dev
)
1245 if (!IS_ENABLED(CONFIG_OF
) || !dev
)
1247 return dev
->of_node
;
1250 void driver_init(void);
1253 * High level routines for use by the bus drivers
1255 extern int __must_check
device_register(struct device
*dev
);
1256 extern void device_unregister(struct device
*dev
);
1257 extern void device_initialize(struct device
*dev
);
1258 extern int __must_check
device_add(struct device
*dev
);
1259 extern void device_del(struct device
*dev
);
1260 extern int device_for_each_child(struct device
*dev
, void *data
,
1261 int (*fn
)(struct device
*dev
, void *data
));
1262 extern int device_for_each_child_reverse(struct device
*dev
, void *data
,
1263 int (*fn
)(struct device
*dev
, void *data
));
1264 extern struct device
*device_find_child(struct device
*dev
, void *data
,
1265 int (*match
)(struct device
*dev
, void *data
));
1266 extern struct device
*device_find_child_by_name(struct device
*parent
,
1268 extern int device_rename(struct device
*dev
, const char *new_name
);
1269 extern int device_move(struct device
*dev
, struct device
*new_parent
,
1270 enum dpm_order dpm_order
);
1271 extern const char *device_get_devnode(struct device
*dev
,
1272 umode_t
*mode
, kuid_t
*uid
, kgid_t
*gid
,
1275 static inline bool device_supports_offline(struct device
*dev
)
1277 return dev
->bus
&& dev
->bus
->offline
&& dev
->bus
->online
;
1280 extern void lock_device_hotplug(void);
1281 extern void unlock_device_hotplug(void);
1282 extern int lock_device_hotplug_sysfs(void);
1283 extern int device_offline(struct device
*dev
);
1284 extern int device_online(struct device
*dev
);
1285 extern void set_primary_fwnode(struct device
*dev
, struct fwnode_handle
*fwnode
);
1286 extern void set_secondary_fwnode(struct device
*dev
, struct fwnode_handle
*fwnode
);
1287 void device_set_of_node_from_dev(struct device
*dev
, const struct device
*dev2
);
1289 static inline int dev_num_vf(struct device
*dev
)
1291 if (dev
->bus
&& dev
->bus
->num_vf
)
1292 return dev
->bus
->num_vf(dev
);
1297 * Root device objects for grouping under /sys/devices
1299 extern struct device
*__root_device_register(const char *name
,
1300 struct module
*owner
);
1302 /* This is a macro to avoid include problems with THIS_MODULE */
1303 #define root_device_register(name) \
1304 __root_device_register(name, THIS_MODULE)
1306 extern void root_device_unregister(struct device
*root
);
1308 static inline void *dev_get_platdata(const struct device
*dev
)
1310 return dev
->platform_data
;
1314 * Manual binding of a device to driver. See drivers/base/bus.c
1315 * for information on use.
1317 extern int __must_check
device_bind_driver(struct device
*dev
);
1318 extern void device_release_driver(struct device
*dev
);
1319 extern int __must_check
device_attach(struct device
*dev
);
1320 extern int __must_check
driver_attach(struct device_driver
*drv
);
1321 extern void device_initial_probe(struct device
*dev
);
1322 extern int __must_check
device_reprobe(struct device
*dev
);
1324 extern bool device_is_bound(struct device
*dev
);
1327 * Easy functions for dynamically creating devices on the fly
1329 extern __printf(5, 0)
1330 struct device
*device_create_vargs(struct class *cls
, struct device
*parent
,
1331 dev_t devt
, void *drvdata
,
1332 const char *fmt
, va_list vargs
);
1333 extern __printf(5, 6)
1334 struct device
*device_create(struct class *cls
, struct device
*parent
,
1335 dev_t devt
, void *drvdata
,
1336 const char *fmt
, ...);
1337 extern __printf(6, 7)
1338 struct device
*device_create_with_groups(struct class *cls
,
1339 struct device
*parent
, dev_t devt
, void *drvdata
,
1340 const struct attribute_group
**groups
,
1341 const char *fmt
, ...);
1342 extern void device_destroy(struct class *cls
, dev_t devt
);
1344 extern int __must_check
device_add_groups(struct device
*dev
,
1345 const struct attribute_group
**groups
);
1346 extern void device_remove_groups(struct device
*dev
,
1347 const struct attribute_group
**groups
);
1349 static inline int __must_check
device_add_group(struct device
*dev
,
1350 const struct attribute_group
*grp
)
1352 const struct attribute_group
*groups
[] = { grp
, NULL
};
1354 return device_add_groups(dev
, groups
);
1357 static inline void device_remove_group(struct device
*dev
,
1358 const struct attribute_group
*grp
)
1360 const struct attribute_group
*groups
[] = { grp
, NULL
};
1362 return device_remove_groups(dev
, groups
);
1365 extern int __must_check
devm_device_add_groups(struct device
*dev
,
1366 const struct attribute_group
**groups
);
1367 extern void devm_device_remove_groups(struct device
*dev
,
1368 const struct attribute_group
**groups
);
1369 extern int __must_check
devm_device_add_group(struct device
*dev
,
1370 const struct attribute_group
*grp
);
1371 extern void devm_device_remove_group(struct device
*dev
,
1372 const struct attribute_group
*grp
);
1375 * Platform "fixup" functions - allow the platform to have their say
1376 * about devices and actions that the general device layer doesn't
1379 /* Notify platform of device discovery */
1380 extern int (*platform_notify
)(struct device
*dev
);
1382 extern int (*platform_notify_remove
)(struct device
*dev
);
1386 * get_device - atomically increment the reference count for the device.
1389 extern struct device
*get_device(struct device
*dev
);
1390 extern void put_device(struct device
*dev
);
1391 extern bool kill_device(struct device
*dev
);
1393 #ifdef CONFIG_DEVTMPFS
1394 extern int devtmpfs_create_node(struct device
*dev
);
1395 extern int devtmpfs_delete_node(struct device
*dev
);
1396 extern int devtmpfs_mount(const char *mntdir
);
1398 static inline int devtmpfs_create_node(struct device
*dev
) { return 0; }
1399 static inline int devtmpfs_delete_node(struct device
*dev
) { return 0; }
1400 static inline int devtmpfs_mount(const char *mountpoint
) { return 0; }
1403 /* drivers/base/power/shutdown.c */
1404 extern void device_shutdown(void);
1406 /* debugging and troubleshooting/diagnostic helpers. */
1407 extern const char *dev_driver_string(const struct device
*dev
);
1409 /* Device links interface. */
1410 struct device_link
*device_link_add(struct device
*consumer
,
1411 struct device
*supplier
, u32 flags
);
1412 void device_link_del(struct device_link
*link
);
1413 void device_link_remove(void *consumer
, struct device
*supplier
);
1416 #define dev_fmt(fmt) fmt
1419 #ifdef CONFIG_PRINTK
1421 __printf(3, 0) __cold
1422 int dev_vprintk_emit(int level
, const struct device
*dev
,
1423 const char *fmt
, va_list args
);
1424 __printf(3, 4) __cold
1425 int dev_printk_emit(int level
, const struct device
*dev
, const char *fmt
, ...);
1427 __printf(3, 4) __cold
1428 void dev_printk(const char *level
, const struct device
*dev
,
1429 const char *fmt
, ...);
1430 __printf(2, 3) __cold
1431 void _dev_emerg(const struct device
*dev
, const char *fmt
, ...);
1432 __printf(2, 3) __cold
1433 void _dev_alert(const struct device
*dev
, const char *fmt
, ...);
1434 __printf(2, 3) __cold
1435 void _dev_crit(const struct device
*dev
, const char *fmt
, ...);
1436 __printf(2, 3) __cold
1437 void _dev_err(const struct device
*dev
, const char *fmt
, ...);
1438 __printf(2, 3) __cold
1439 void _dev_warn(const struct device
*dev
, const char *fmt
, ...);
1440 __printf(2, 3) __cold
1441 void _dev_notice(const struct device
*dev
, const char *fmt
, ...);
1442 __printf(2, 3) __cold
1443 void _dev_info(const struct device
*dev
, const char *fmt
, ...);
1447 static inline __printf(3, 0)
1448 int dev_vprintk_emit(int level
, const struct device
*dev
,
1449 const char *fmt
, va_list args
)
1451 static inline __printf(3, 4)
1452 int dev_printk_emit(int level
, const struct device
*dev
, const char *fmt
, ...)
1455 static inline void __dev_printk(const char *level
, const struct device
*dev
,
1456 struct va_format
*vaf
)
1458 static inline __printf(3, 4)
1459 void dev_printk(const char *level
, const struct device
*dev
,
1460 const char *fmt
, ...)
1463 static inline __printf(2, 3)
1464 void _dev_emerg(const struct device
*dev
, const char *fmt
, ...)
1466 static inline __printf(2, 3)
1467 void _dev_crit(const struct device
*dev
, const char *fmt
, ...)
1469 static inline __printf(2, 3)
1470 void _dev_alert(const struct device
*dev
, const char *fmt
, ...)
1472 static inline __printf(2, 3)
1473 void _dev_err(const struct device
*dev
, const char *fmt
, ...)
1475 static inline __printf(2, 3)
1476 void _dev_warn(const struct device
*dev
, const char *fmt
, ...)
1478 static inline __printf(2, 3)
1479 void _dev_notice(const struct device
*dev
, const char *fmt
, ...)
1481 static inline __printf(2, 3)
1482 void _dev_info(const struct device
*dev
, const char *fmt
, ...)
1488 * #defines for all the dev_<level> macros to prefix with whatever
1489 * possible use of #define dev_fmt(fmt) ...
1492 #define dev_emerg(dev, fmt, ...) \
1493 _dev_emerg(dev, dev_fmt(fmt), ##__VA_ARGS__)
1494 #define dev_crit(dev, fmt, ...) \
1495 _dev_crit(dev, dev_fmt(fmt), ##__VA_ARGS__)
1496 #define dev_alert(dev, fmt, ...) \
1497 _dev_alert(dev, dev_fmt(fmt), ##__VA_ARGS__)
1498 #define dev_err(dev, fmt, ...) \
1499 _dev_err(dev, dev_fmt(fmt), ##__VA_ARGS__)
1500 #define dev_warn(dev, fmt, ...) \
1501 _dev_warn(dev, dev_fmt(fmt), ##__VA_ARGS__)
1502 #define dev_notice(dev, fmt, ...) \
1503 _dev_notice(dev, dev_fmt(fmt), ##__VA_ARGS__)
1504 #define dev_info(dev, fmt, ...) \
1505 _dev_info(dev, dev_fmt(fmt), ##__VA_ARGS__)
1507 #if defined(CONFIG_DYNAMIC_DEBUG)
1508 #define dev_dbg(dev, fmt, ...) \
1509 dynamic_dev_dbg(dev, dev_fmt(fmt), ##__VA_ARGS__)
1510 #elif defined(DEBUG)
1511 #define dev_dbg(dev, fmt, ...) \
1512 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__)
1514 #define dev_dbg(dev, fmt, ...) \
1517 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \
1521 #ifdef CONFIG_PRINTK
1522 #define dev_level_once(dev_level, dev, fmt, ...) \
1524 static bool __print_once __read_mostly; \
1526 if (!__print_once) { \
1527 __print_once = true; \
1528 dev_level(dev, fmt, ##__VA_ARGS__); \
1532 #define dev_level_once(dev_level, dev, fmt, ...) \
1535 dev_level(dev, fmt, ##__VA_ARGS__); \
1539 #define dev_emerg_once(dev, fmt, ...) \
1540 dev_level_once(dev_emerg, dev, fmt, ##__VA_ARGS__)
1541 #define dev_alert_once(dev, fmt, ...) \
1542 dev_level_once(dev_alert, dev, fmt, ##__VA_ARGS__)
1543 #define dev_crit_once(dev, fmt, ...) \
1544 dev_level_once(dev_crit, dev, fmt, ##__VA_ARGS__)
1545 #define dev_err_once(dev, fmt, ...) \
1546 dev_level_once(dev_err, dev, fmt, ##__VA_ARGS__)
1547 #define dev_warn_once(dev, fmt, ...) \
1548 dev_level_once(dev_warn, dev, fmt, ##__VA_ARGS__)
1549 #define dev_notice_once(dev, fmt, ...) \
1550 dev_level_once(dev_notice, dev, fmt, ##__VA_ARGS__)
1551 #define dev_info_once(dev, fmt, ...) \
1552 dev_level_once(dev_info, dev, fmt, ##__VA_ARGS__)
1553 #define dev_dbg_once(dev, fmt, ...) \
1554 dev_level_once(dev_dbg, dev, fmt, ##__VA_ARGS__)
1556 #define dev_level_ratelimited(dev_level, dev, fmt, ...) \
1558 static DEFINE_RATELIMIT_STATE(_rs, \
1559 DEFAULT_RATELIMIT_INTERVAL, \
1560 DEFAULT_RATELIMIT_BURST); \
1561 if (__ratelimit(&_rs)) \
1562 dev_level(dev, fmt, ##__VA_ARGS__); \
1565 #define dev_emerg_ratelimited(dev, fmt, ...) \
1566 dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
1567 #define dev_alert_ratelimited(dev, fmt, ...) \
1568 dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
1569 #define dev_crit_ratelimited(dev, fmt, ...) \
1570 dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
1571 #define dev_err_ratelimited(dev, fmt, ...) \
1572 dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
1573 #define dev_warn_ratelimited(dev, fmt, ...) \
1574 dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
1575 #define dev_notice_ratelimited(dev, fmt, ...) \
1576 dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
1577 #define dev_info_ratelimited(dev, fmt, ...) \
1578 dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
1579 #if defined(CONFIG_DYNAMIC_DEBUG)
1580 /* descriptor check is first to prevent flooding with "callbacks suppressed" */
1581 #define dev_dbg_ratelimited(dev, fmt, ...) \
1583 static DEFINE_RATELIMIT_STATE(_rs, \
1584 DEFAULT_RATELIMIT_INTERVAL, \
1585 DEFAULT_RATELIMIT_BURST); \
1586 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
1587 if (DYNAMIC_DEBUG_BRANCH(descriptor) && \
1588 __ratelimit(&_rs)) \
1589 __dynamic_dev_dbg(&descriptor, dev, dev_fmt(fmt), \
1592 #elif defined(DEBUG)
1593 #define dev_dbg_ratelimited(dev, fmt, ...) \
1595 static DEFINE_RATELIMIT_STATE(_rs, \
1596 DEFAULT_RATELIMIT_INTERVAL, \
1597 DEFAULT_RATELIMIT_BURST); \
1598 if (__ratelimit(&_rs)) \
1599 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \
1602 #define dev_dbg_ratelimited(dev, fmt, ...) \
1605 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \
1609 #ifdef VERBOSE_DEBUG
1610 #define dev_vdbg dev_dbg
1612 #define dev_vdbg(dev, fmt, ...) \
1615 dev_printk(KERN_DEBUG, dev, dev_fmt(fmt), ##__VA_ARGS__); \
1620 * dev_WARN*() acts like dev_printk(), but with the key difference of
1621 * using WARN/WARN_ONCE to include file/line information and a backtrace.
1623 #define dev_WARN(dev, format, arg...) \
1624 WARN(1, "%s %s: " format, dev_driver_string(dev), dev_name(dev), ## arg);
1626 #define dev_WARN_ONCE(dev, condition, format, arg...) \
1627 WARN_ONCE(condition, "%s %s: " format, \
1628 dev_driver_string(dev), dev_name(dev), ## arg)
1630 /* Create alias, so I can be autoloaded. */
1631 #define MODULE_ALIAS_CHARDEV(major,minor) \
1632 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1633 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1634 MODULE_ALIAS("char-major-" __stringify(major) "-*")
1636 #ifdef CONFIG_SYSFS_DEPRECATED
1637 extern long sysfs_deprecated
;
1639 #define sysfs_deprecated 0
1643 * module_driver() - Helper macro for drivers that don't do anything
1644 * special in module init/exit. This eliminates a lot of boilerplate.
1645 * Each module may only use this macro once, and calling it replaces
1646 * module_init() and module_exit().
1648 * @__driver: driver name
1649 * @__register: register function for this driver type
1650 * @__unregister: unregister function for this driver type
1651 * @...: Additional arguments to be passed to __register and __unregister.
1653 * Use this macro to construct bus specific macros for registering
1654 * drivers, and do not use it on its own.
1656 #define module_driver(__driver, __register, __unregister, ...) \
1657 static int __init __driver##_init(void) \
1659 return __register(&(__driver) , ##__VA_ARGS__); \
1661 module_init(__driver##_init); \
1662 static void __exit __driver##_exit(void) \
1664 __unregister(&(__driver) , ##__VA_ARGS__); \
1666 module_exit(__driver##_exit);
1669 * builtin_driver() - Helper macro for drivers that don't do anything
1670 * special in init and have no exit. This eliminates some boilerplate.
1671 * Each driver may only use this macro once, and calling it replaces
1672 * device_initcall (or in some cases, the legacy __initcall). This is
1673 * meant to be a direct parallel of module_driver() above but without
1674 * the __exit stuff that is not used for builtin cases.
1676 * @__driver: driver name
1677 * @__register: register function for this driver type
1678 * @...: Additional arguments to be passed to __register
1680 * Use this macro to construct bus specific macros for registering
1681 * drivers, and do not use it on its own.
1683 #define builtin_driver(__driver, __register, ...) \
1684 static int __init __driver##_init(void) \
1686 return __register(&(__driver) , ##__VA_ARGS__); \
1688 device_initcall(__driver##_init);
1690 #endif /* _DEVICE_H_ */