2 * device.h - generic, centralized driver model
4 * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
5 * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de>
6 * Copyright (c) 2008-2009 Novell Inc.
8 * This file is released under the GPLv2
10 * See Documentation/driver-model/ for more information.
16 #include <linux/ioport.h>
17 #include <linux/kobject.h>
18 #include <linux/klist.h>
19 #include <linux/list.h>
20 #include <linux/lockdep.h>
21 #include <linux/compiler.h>
22 #include <linux/types.h>
23 #include <linux/mutex.h>
24 #include <linux/pinctrl/devinfo.h>
26 #include <linux/atomic.h>
27 #include <linux/ratelimit.h>
28 #include <linux/uidgid.h>
29 #include <linux/gfp.h>
30 #include <asm/device.h>
33 struct device_private
;
35 struct driver_private
;
38 struct subsys_private
;
46 struct bus_attribute
{
47 struct attribute attr
;
48 ssize_t (*show
)(struct bus_type
*bus
, char *buf
);
49 ssize_t (*store
)(struct bus_type
*bus
, const char *buf
, size_t count
);
52 #define BUS_ATTR(_name, _mode, _show, _store) \
53 struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
54 #define BUS_ATTR_RW(_name) \
55 struct bus_attribute bus_attr_##_name = __ATTR_RW(_name)
56 #define BUS_ATTR_RO(_name) \
57 struct bus_attribute bus_attr_##_name = __ATTR_RO(_name)
59 extern int __must_check
bus_create_file(struct bus_type
*,
60 struct bus_attribute
*);
61 extern void bus_remove_file(struct bus_type
*, struct bus_attribute
*);
64 * struct bus_type - The bus type of the device
66 * @name: The name of the bus.
67 * @dev_name: Used for subsystems to enumerate devices like ("foo%u", dev->id).
68 * @dev_root: Default device to use as the parent.
69 * @bus_groups: Default attributes of the bus.
70 * @dev_groups: Default attributes of the devices on the bus.
71 * @drv_groups: Default attributes of the device drivers on the bus.
72 * @match: Called, perhaps multiple times, whenever a new device or driver
73 * is added for this bus. It should return a positive value if the
74 * given device can be handled by the given driver and zero
75 * otherwise. It may also return error code if determining that
76 * the driver supports the device is not possible. In case of
77 * -EPROBE_DEFER it will queue the device for deferred probing.
78 * @uevent: Called when a device is added, removed, or a few other things
79 * that generate uevents to add the environment variables.
80 * @probe: Called when a new device or driver add to this bus, and callback
81 * the specific driver's probe to initial the matched device.
82 * @remove: Called when a device removed from this bus.
83 * @shutdown: Called at shut-down time to quiesce the device.
85 * @online: Called to put the device back online (after offlining it).
86 * @offline: Called to put the device offline for hot-removal. May fail.
88 * @suspend: Called when a device on this bus wants to go to sleep mode.
89 * @resume: Called to bring a device on this bus out of sleep mode.
90 * @num_vf: Called to find out how many virtual functions a device on this
92 * @pm: Power management operations of this bus, callback the specific
93 * device driver's pm-ops.
94 * @iommu_ops: IOMMU specific operations for this bus, used to attach IOMMU
95 * driver implementations to a bus and allow the driver to do
97 * @p: The private data of the driver core, only the driver core can
99 * @lock_key: Lock class key for use by the lock validator
100 * @force_dma: Assume devices on this bus should be set up by dma_configure()
101 * even if DMA capability is not explicitly described by firmware.
103 * A bus is a channel between the processor and one or more devices. For the
104 * purposes of the device model, all devices are connected via a bus, even if
105 * it is an internal, virtual, "platform" bus. Buses can plug into each other.
106 * A USB controller is usually a PCI device, for example. The device model
107 * represents the actual connections between buses and the devices they control.
108 * A bus is represented by the bus_type structure. It contains the name, the
109 * default attributes, the bus' methods, PM operations, and the driver core's
114 const char *dev_name
;
115 struct device
*dev_root
;
116 const struct attribute_group
**bus_groups
;
117 const struct attribute_group
**dev_groups
;
118 const struct attribute_group
**drv_groups
;
120 int (*match
)(struct device
*dev
, struct device_driver
*drv
);
121 int (*uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
122 int (*probe
)(struct device
*dev
);
123 int (*remove
)(struct device
*dev
);
124 void (*shutdown
)(struct device
*dev
);
126 int (*online
)(struct device
*dev
);
127 int (*offline
)(struct device
*dev
);
129 int (*suspend
)(struct device
*dev
, pm_message_t state
);
130 int (*resume
)(struct device
*dev
);
132 int (*num_vf
)(struct device
*dev
);
134 const struct dev_pm_ops
*pm
;
136 const struct iommu_ops
*iommu_ops
;
138 struct subsys_private
*p
;
139 struct lock_class_key lock_key
;
144 extern int __must_check
bus_register(struct bus_type
*bus
);
146 extern void bus_unregister(struct bus_type
*bus
);
148 extern int __must_check
bus_rescan_devices(struct bus_type
*bus
);
150 /* iterator helpers for buses */
151 struct subsys_dev_iter
{
152 struct klist_iter ki
;
153 const struct device_type
*type
;
155 void subsys_dev_iter_init(struct subsys_dev_iter
*iter
,
156 struct bus_type
*subsys
,
157 struct device
*start
,
158 const struct device_type
*type
);
159 struct device
*subsys_dev_iter_next(struct subsys_dev_iter
*iter
);
160 void subsys_dev_iter_exit(struct subsys_dev_iter
*iter
);
162 int bus_for_each_dev(struct bus_type
*bus
, struct device
*start
, void *data
,
163 int (*fn
)(struct device
*dev
, void *data
));
164 struct device
*bus_find_device(struct bus_type
*bus
, struct device
*start
,
166 int (*match
)(struct device
*dev
, void *data
));
167 struct device
*bus_find_device_by_name(struct bus_type
*bus
,
168 struct device
*start
,
170 struct device
*subsys_find_device_by_id(struct bus_type
*bus
, unsigned int id
,
171 struct device
*hint
);
172 int bus_for_each_drv(struct bus_type
*bus
, struct device_driver
*start
,
173 void *data
, int (*fn
)(struct device_driver
*, void *));
174 void bus_sort_breadthfirst(struct bus_type
*bus
,
175 int (*compare
)(const struct device
*a
,
176 const struct device
*b
));
178 * Bus notifiers: Get notified of addition/removal of devices
179 * and binding/unbinding of drivers to devices.
180 * In the long run, it should be a replacement for the platform
183 struct notifier_block
;
185 extern int bus_register_notifier(struct bus_type
*bus
,
186 struct notifier_block
*nb
);
187 extern int bus_unregister_notifier(struct bus_type
*bus
,
188 struct notifier_block
*nb
);
190 /* All 4 notifers below get called with the target struct device *
191 * as an argument. Note that those functions are likely to be called
192 * with the device lock held in the core, so be careful.
194 #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
195 #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device to be removed */
196 #define BUS_NOTIFY_REMOVED_DEVICE 0x00000003 /* device removed */
197 #define BUS_NOTIFY_BIND_DRIVER 0x00000004 /* driver about to be
199 #define BUS_NOTIFY_BOUND_DRIVER 0x00000005 /* driver bound to device */
200 #define BUS_NOTIFY_UNBIND_DRIVER 0x00000006 /* driver about to be
202 #define BUS_NOTIFY_UNBOUND_DRIVER 0x00000007 /* driver is unbound
204 #define BUS_NOTIFY_DRIVER_NOT_BOUND 0x00000008 /* driver fails to be bound */
206 extern struct kset
*bus_get_kset(struct bus_type
*bus
);
207 extern struct klist
*bus_get_device_klist(struct bus_type
*bus
);
210 * enum probe_type - device driver probe type to try
211 * Device drivers may opt in for special handling of their
212 * respective probe routines. This tells the core what to
215 * @PROBE_DEFAULT_STRATEGY: Used by drivers that work equally well
216 * whether probed synchronously or asynchronously.
217 * @PROBE_PREFER_ASYNCHRONOUS: Drivers for "slow" devices which
218 * probing order is not essential for booting the system may
219 * opt into executing their probes asynchronously.
220 * @PROBE_FORCE_SYNCHRONOUS: Use this to annotate drivers that need
221 * their probe routines to run synchronously with driver and
222 * device registration (with the exception of -EPROBE_DEFER
223 * handling - re-probing always ends up being done asynchronously).
225 * Note that the end goal is to switch the kernel to use asynchronous
226 * probing by default, so annotating drivers with
227 * %PROBE_PREFER_ASYNCHRONOUS is a temporary measure that allows us
228 * to speed up boot process while we are validating the rest of the
232 PROBE_DEFAULT_STRATEGY
,
233 PROBE_PREFER_ASYNCHRONOUS
,
234 PROBE_FORCE_SYNCHRONOUS
,
238 * struct device_driver - The basic device driver structure
239 * @name: Name of the device driver.
240 * @bus: The bus which the device of this driver belongs to.
241 * @owner: The module owner.
242 * @mod_name: Used for built-in modules.
243 * @suppress_bind_attrs: Disables bind/unbind via sysfs.
244 * @probe_type: Type of the probe (synchronous or asynchronous) to use.
245 * @of_match_table: The open firmware table.
246 * @acpi_match_table: The ACPI match table.
247 * @probe: Called to query the existence of a specific device,
248 * whether this driver can work with it, and bind the driver
249 * to a specific device.
250 * @remove: Called when the device is removed from the system to
251 * unbind a device from this driver.
252 * @shutdown: Called at shut-down time to quiesce the device.
253 * @suspend: Called to put the device to sleep mode. Usually to a
255 * @resume: Called to bring a device from sleep mode.
256 * @groups: Default attributes that get created by the driver core
258 * @pm: Power management operations of the device which matched
260 * @p: Driver core's private data, no one other than the driver
261 * core can touch this.
263 * The device driver-model tracks all of the drivers known to the system.
264 * The main reason for this tracking is to enable the driver core to match
265 * up drivers with new devices. Once drivers are known objects within the
266 * system, however, a number of other things become possible. Device drivers
267 * can export information and configuration variables that are independent
268 * of any specific device.
270 struct device_driver
{
272 struct bus_type
*bus
;
274 struct module
*owner
;
275 const char *mod_name
; /* used for built-in modules */
277 bool suppress_bind_attrs
; /* disables bind/unbind via sysfs */
278 enum probe_type probe_type
;
280 const struct of_device_id
*of_match_table
;
281 const struct acpi_device_id
*acpi_match_table
;
283 int (*probe
) (struct device
*dev
);
284 int (*remove
) (struct device
*dev
);
285 void (*shutdown
) (struct device
*dev
);
286 int (*suspend
) (struct device
*dev
, pm_message_t state
);
287 int (*resume
) (struct device
*dev
);
288 const struct attribute_group
**groups
;
290 const struct dev_pm_ops
*pm
;
292 struct driver_private
*p
;
296 extern int __must_check
driver_register(struct device_driver
*drv
);
297 extern void driver_unregister(struct device_driver
*drv
);
299 extern struct device_driver
*driver_find(const char *name
,
300 struct bus_type
*bus
);
301 extern int driver_probe_done(void);
302 extern void wait_for_device_probe(void);
305 /* sysfs interface for exporting driver attributes */
307 struct driver_attribute
{
308 struct attribute attr
;
309 ssize_t (*show
)(struct device_driver
*driver
, char *buf
);
310 ssize_t (*store
)(struct device_driver
*driver
, const char *buf
,
314 #define DRIVER_ATTR_RW(_name) \
315 struct driver_attribute driver_attr_##_name = __ATTR_RW(_name)
316 #define DRIVER_ATTR_RO(_name) \
317 struct driver_attribute driver_attr_##_name = __ATTR_RO(_name)
318 #define DRIVER_ATTR_WO(_name) \
319 struct driver_attribute driver_attr_##_name = __ATTR_WO(_name)
321 extern int __must_check
driver_create_file(struct device_driver
*driver
,
322 const struct driver_attribute
*attr
);
323 extern void driver_remove_file(struct device_driver
*driver
,
324 const struct driver_attribute
*attr
);
326 extern int __must_check
driver_for_each_device(struct device_driver
*drv
,
327 struct device
*start
,
329 int (*fn
)(struct device
*dev
,
331 struct device
*driver_find_device(struct device_driver
*drv
,
332 struct device
*start
, void *data
,
333 int (*match
)(struct device
*dev
, void *data
));
336 * struct subsys_interface - interfaces to device functions
337 * @name: name of the device function
338 * @subsys: subsytem of the devices to attach to
339 * @node: the list of functions registered at the subsystem
340 * @add_dev: device hookup to device function handler
341 * @remove_dev: device hookup to device function handler
343 * Simple interfaces attached to a subsystem. Multiple interfaces can
344 * attach to a subsystem and its devices. Unlike drivers, they do not
345 * exclusively claim or control devices. Interfaces usually represent
346 * a specific functionality of a subsystem/class of devices.
348 struct subsys_interface
{
350 struct bus_type
*subsys
;
351 struct list_head node
;
352 int (*add_dev
)(struct device
*dev
, struct subsys_interface
*sif
);
353 void (*remove_dev
)(struct device
*dev
, struct subsys_interface
*sif
);
356 int subsys_interface_register(struct subsys_interface
*sif
);
357 void subsys_interface_unregister(struct subsys_interface
*sif
);
359 int subsys_system_register(struct bus_type
*subsys
,
360 const struct attribute_group
**groups
);
361 int subsys_virtual_register(struct bus_type
*subsys
,
362 const struct attribute_group
**groups
);
365 * struct class - device classes
366 * @name: Name of the class.
367 * @owner: The module owner.
368 * @class_groups: Default attributes of this class.
369 * @dev_groups: Default attributes of the devices that belong to the class.
370 * @dev_kobj: The kobject that represents this class and links it into the hierarchy.
371 * @dev_uevent: Called when a device is added, removed from this class, or a
372 * few other things that generate uevents to add the environment
374 * @devnode: Callback to provide the devtmpfs.
375 * @class_release: Called to release this class.
376 * @dev_release: Called to release the device.
377 * @shutdown_pre: Called at shut-down time before driver shutdown.
378 * @ns_type: Callbacks so sysfs can detemine namespaces.
379 * @namespace: Namespace of the device belongs to this class.
380 * @get_ownership: Allows class to specify uid/gid of the sysfs directories
381 * for the devices belonging to the class. Usually tied to
382 * device's namespace.
383 * @pm: The default device power management operations of this class.
384 * @p: The private data of the driver core, no one other than the
385 * driver core can touch this.
387 * A class is a higher-level view of a device that abstracts out low-level
388 * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
389 * at the class level, they are all simply disks. Classes allow user space
390 * to work with devices based on what they do, rather than how they are
391 * connected or how they work.
395 struct module
*owner
;
397 const struct attribute_group
**class_groups
;
398 const struct attribute_group
**dev_groups
;
399 struct kobject
*dev_kobj
;
401 int (*dev_uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
402 char *(*devnode
)(struct device
*dev
, umode_t
*mode
);
404 void (*class_release
)(struct class *class);
405 void (*dev_release
)(struct device
*dev
);
407 int (*shutdown_pre
)(struct device
*dev
);
409 const struct kobj_ns_type_operations
*ns_type
;
410 const void *(*namespace)(struct device
*dev
);
412 void (*get_ownership
)(struct device
*dev
, kuid_t
*uid
, kgid_t
*gid
);
414 const struct dev_pm_ops
*pm
;
416 struct subsys_private
*p
;
419 struct class_dev_iter
{
420 struct klist_iter ki
;
421 const struct device_type
*type
;
424 extern struct kobject
*sysfs_dev_block_kobj
;
425 extern struct kobject
*sysfs_dev_char_kobj
;
426 extern int __must_check
__class_register(struct class *class,
427 struct lock_class_key
*key
);
428 extern void class_unregister(struct class *class);
430 /* This is a #define to keep the compiler from merging different
431 * instances of the __key variable */
432 #define class_register(class) \
434 static struct lock_class_key __key; \
435 __class_register(class, &__key); \
439 struct class_compat
*class_compat_register(const char *name
);
440 void class_compat_unregister(struct class_compat
*cls
);
441 int class_compat_create_link(struct class_compat
*cls
, struct device
*dev
,
442 struct device
*device_link
);
443 void class_compat_remove_link(struct class_compat
*cls
, struct device
*dev
,
444 struct device
*device_link
);
446 extern void class_dev_iter_init(struct class_dev_iter
*iter
,
448 struct device
*start
,
449 const struct device_type
*type
);
450 extern struct device
*class_dev_iter_next(struct class_dev_iter
*iter
);
451 extern void class_dev_iter_exit(struct class_dev_iter
*iter
);
453 extern int class_for_each_device(struct class *class, struct device
*start
,
455 int (*fn
)(struct device
*dev
, void *data
));
456 extern struct device
*class_find_device(struct class *class,
457 struct device
*start
, const void *data
,
458 int (*match
)(struct device
*, const void *));
460 struct class_attribute
{
461 struct attribute attr
;
462 ssize_t (*show
)(struct class *class, struct class_attribute
*attr
,
464 ssize_t (*store
)(struct class *class, struct class_attribute
*attr
,
465 const char *buf
, size_t count
);
468 #define CLASS_ATTR_RW(_name) \
469 struct class_attribute class_attr_##_name = __ATTR_RW(_name)
470 #define CLASS_ATTR_RO(_name) \
471 struct class_attribute class_attr_##_name = __ATTR_RO(_name)
472 #define CLASS_ATTR_WO(_name) \
473 struct class_attribute class_attr_##_name = __ATTR_WO(_name)
475 extern int __must_check
class_create_file_ns(struct class *class,
476 const struct class_attribute
*attr
,
478 extern void class_remove_file_ns(struct class *class,
479 const struct class_attribute
*attr
,
482 static inline int __must_check
class_create_file(struct class *class,
483 const struct class_attribute
*attr
)
485 return class_create_file_ns(class, attr
, NULL
);
488 static inline void class_remove_file(struct class *class,
489 const struct class_attribute
*attr
)
491 return class_remove_file_ns(class, attr
, NULL
);
494 /* Simple class attribute that is just a static string */
495 struct class_attribute_string
{
496 struct class_attribute attr
;
500 /* Currently read-only only */
501 #define _CLASS_ATTR_STRING(_name, _mode, _str) \
502 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
503 #define CLASS_ATTR_STRING(_name, _mode, _str) \
504 struct class_attribute_string class_attr_##_name = \
505 _CLASS_ATTR_STRING(_name, _mode, _str)
507 extern ssize_t
show_class_attr_string(struct class *class, struct class_attribute
*attr
,
510 struct class_interface
{
511 struct list_head node
;
514 int (*add_dev
) (struct device
*, struct class_interface
*);
515 void (*remove_dev
) (struct device
*, struct class_interface
*);
518 extern int __must_check
class_interface_register(struct class_interface
*);
519 extern void class_interface_unregister(struct class_interface
*);
521 extern struct class * __must_check
__class_create(struct module
*owner
,
523 struct lock_class_key
*key
);
524 extern void class_destroy(struct class *cls
);
526 /* This is a #define to keep the compiler from merging different
527 * instances of the __key variable */
528 #define class_create(owner, name) \
530 static struct lock_class_key __key; \
531 __class_create(owner, name, &__key); \
535 * The type of device, "struct device" is embedded in. A class
536 * or bus can contain devices of different types
537 * like "partitions" and "disks", "mouse" and "event".
538 * This identifies the device type and carries type-specific
539 * information, equivalent to the kobj_type of a kobject.
540 * If "name" is specified, the uevent will contain it in
541 * the DEVTYPE variable.
545 const struct attribute_group
**groups
;
546 int (*uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
547 char *(*devnode
)(struct device
*dev
, umode_t
*mode
,
548 kuid_t
*uid
, kgid_t
*gid
);
549 void (*release
)(struct device
*dev
);
551 const struct dev_pm_ops
*pm
;
554 /* interface for exporting device attributes */
555 struct device_attribute
{
556 struct attribute attr
;
557 ssize_t (*show
)(struct device
*dev
, struct device_attribute
*attr
,
559 ssize_t (*store
)(struct device
*dev
, struct device_attribute
*attr
,
560 const char *buf
, size_t count
);
563 struct dev_ext_attribute
{
564 struct device_attribute attr
;
568 ssize_t
device_show_ulong(struct device
*dev
, struct device_attribute
*attr
,
570 ssize_t
device_store_ulong(struct device
*dev
, struct device_attribute
*attr
,
571 const char *buf
, size_t count
);
572 ssize_t
device_show_int(struct device
*dev
, struct device_attribute
*attr
,
574 ssize_t
device_store_int(struct device
*dev
, struct device_attribute
*attr
,
575 const char *buf
, size_t count
);
576 ssize_t
device_show_bool(struct device
*dev
, struct device_attribute
*attr
,
578 ssize_t
device_store_bool(struct device
*dev
, struct device_attribute
*attr
,
579 const char *buf
, size_t count
);
581 #define DEVICE_ATTR(_name, _mode, _show, _store) \
582 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
583 #define DEVICE_ATTR_RW(_name) \
584 struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
585 #define DEVICE_ATTR_RO(_name) \
586 struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
587 #define DEVICE_ATTR_WO(_name) \
588 struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
589 #define DEVICE_ULONG_ATTR(_name, _mode, _var) \
590 struct dev_ext_attribute dev_attr_##_name = \
591 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
592 #define DEVICE_INT_ATTR(_name, _mode, _var) \
593 struct dev_ext_attribute dev_attr_##_name = \
594 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
595 #define DEVICE_BOOL_ATTR(_name, _mode, _var) \
596 struct dev_ext_attribute dev_attr_##_name = \
597 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
598 #define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
599 struct device_attribute dev_attr_##_name = \
600 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
602 extern int device_create_file(struct device
*device
,
603 const struct device_attribute
*entry
);
604 extern void device_remove_file(struct device
*dev
,
605 const struct device_attribute
*attr
);
606 extern bool device_remove_file_self(struct device
*dev
,
607 const struct device_attribute
*attr
);
608 extern int __must_check
device_create_bin_file(struct device
*dev
,
609 const struct bin_attribute
*attr
);
610 extern void device_remove_bin_file(struct device
*dev
,
611 const struct bin_attribute
*attr
);
613 /* device resource management */
614 typedef void (*dr_release_t
)(struct device
*dev
, void *res
);
615 typedef int (*dr_match_t
)(struct device
*dev
, void *res
, void *match_data
);
617 #ifdef CONFIG_DEBUG_DEVRES
618 extern void *__devres_alloc_node(dr_release_t release
, size_t size
, gfp_t gfp
,
619 int nid
, const char *name
) __malloc
;
620 #define devres_alloc(release, size, gfp) \
621 __devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release)
622 #define devres_alloc_node(release, size, gfp, nid) \
623 __devres_alloc_node(release, size, gfp, nid, #release)
625 extern void *devres_alloc_node(dr_release_t release
, size_t size
, gfp_t gfp
,
627 static inline void *devres_alloc(dr_release_t release
, size_t size
, gfp_t gfp
)
629 return devres_alloc_node(release
, size
, gfp
, NUMA_NO_NODE
);
633 extern void devres_for_each_res(struct device
*dev
, dr_release_t release
,
634 dr_match_t match
, void *match_data
,
635 void (*fn
)(struct device
*, void *, void *),
637 extern void devres_free(void *res
);
638 extern void devres_add(struct device
*dev
, void *res
);
639 extern void *devres_find(struct device
*dev
, dr_release_t release
,
640 dr_match_t match
, void *match_data
);
641 extern void *devres_get(struct device
*dev
, void *new_res
,
642 dr_match_t match
, void *match_data
);
643 extern void *devres_remove(struct device
*dev
, dr_release_t release
,
644 dr_match_t match
, void *match_data
);
645 extern int devres_destroy(struct device
*dev
, dr_release_t release
,
646 dr_match_t match
, void *match_data
);
647 extern int devres_release(struct device
*dev
, dr_release_t release
,
648 dr_match_t match
, void *match_data
);
651 extern void * __must_check
devres_open_group(struct device
*dev
, void *id
,
653 extern void devres_close_group(struct device
*dev
, void *id
);
654 extern void devres_remove_group(struct device
*dev
, void *id
);
655 extern int devres_release_group(struct device
*dev
, void *id
);
657 /* managed devm_k.alloc/kfree for device drivers */
658 extern void *devm_kmalloc(struct device
*dev
, size_t size
, gfp_t gfp
) __malloc
;
659 extern __printf(3, 0)
660 char *devm_kvasprintf(struct device
*dev
, gfp_t gfp
, const char *fmt
,
661 va_list ap
) __malloc
;
662 extern __printf(3, 4)
663 char *devm_kasprintf(struct device
*dev
, gfp_t gfp
, const char *fmt
, ...) __malloc
;
664 static inline void *devm_kzalloc(struct device
*dev
, size_t size
, gfp_t gfp
)
666 return devm_kmalloc(dev
, size
, gfp
| __GFP_ZERO
);
668 static inline void *devm_kmalloc_array(struct device
*dev
,
669 size_t n
, size_t size
, gfp_t flags
)
671 if (size
!= 0 && n
> SIZE_MAX
/ size
)
673 return devm_kmalloc(dev
, n
* size
, flags
);
675 static inline void *devm_kcalloc(struct device
*dev
,
676 size_t n
, size_t size
, gfp_t flags
)
678 return devm_kmalloc_array(dev
, n
, size
, flags
| __GFP_ZERO
);
680 extern void devm_kfree(struct device
*dev
, void *p
);
681 extern char *devm_kstrdup(struct device
*dev
, const char *s
, gfp_t gfp
) __malloc
;
682 extern void *devm_kmemdup(struct device
*dev
, const void *src
, size_t len
,
685 extern unsigned long devm_get_free_pages(struct device
*dev
,
686 gfp_t gfp_mask
, unsigned int order
);
687 extern void devm_free_pages(struct device
*dev
, unsigned long addr
);
689 void __iomem
*devm_ioremap_resource(struct device
*dev
, struct resource
*res
);
691 /* allows to add/remove a custom action to devres stack */
692 int devm_add_action(struct device
*dev
, void (*action
)(void *), void *data
);
693 void devm_remove_action(struct device
*dev
, void (*action
)(void *), void *data
);
695 static inline int devm_add_action_or_reset(struct device
*dev
,
696 void (*action
)(void *), void *data
)
700 ret
= devm_add_action(dev
, action
, data
);
708 * devm_alloc_percpu - Resource-managed alloc_percpu
709 * @dev: Device to allocate per-cpu memory for
710 * @type: Type to allocate per-cpu memory for
712 * Managed alloc_percpu. Per-cpu memory allocated with this function is
713 * automatically freed on driver detach.
716 * Pointer to allocated memory on success, NULL on failure.
718 #define devm_alloc_percpu(dev, type) \
719 ((typeof(type) __percpu *)__devm_alloc_percpu((dev), sizeof(type), \
722 void __percpu
*__devm_alloc_percpu(struct device
*dev
, size_t size
,
724 void devm_free_percpu(struct device
*dev
, void __percpu
*pdata
);
726 struct device_dma_parameters
{
728 * a low level driver may set these to teach IOMMU code about
731 unsigned int max_segment_size
;
732 unsigned long segment_boundary_mask
;
736 * enum device_link_state - Device link states.
737 * @DL_STATE_NONE: The presence of the drivers is not being tracked.
738 * @DL_STATE_DORMANT: None of the supplier/consumer drivers is present.
739 * @DL_STATE_AVAILABLE: The supplier driver is present, but the consumer is not.
740 * @DL_STATE_CONSUMER_PROBE: The consumer is probing (supplier driver present).
741 * @DL_STATE_ACTIVE: Both the supplier and consumer drivers are present.
742 * @DL_STATE_SUPPLIER_UNBIND: The supplier driver is unbinding.
744 enum device_link_state
{
746 DL_STATE_DORMANT
= 0,
748 DL_STATE_CONSUMER_PROBE
,
750 DL_STATE_SUPPLIER_UNBIND
,
756 * STATELESS: The core won't track the presence of supplier/consumer drivers.
757 * AUTOREMOVE: Remove this link automatically on consumer driver unbind.
758 * PM_RUNTIME: If set, the runtime PM framework will use this link.
759 * RPM_ACTIVE: Run pm_runtime_get_sync() on the supplier during link creation.
761 #define DL_FLAG_STATELESS BIT(0)
762 #define DL_FLAG_AUTOREMOVE BIT(1)
763 #define DL_FLAG_PM_RUNTIME BIT(2)
764 #define DL_FLAG_RPM_ACTIVE BIT(3)
767 * struct device_link - Device link representation.
768 * @supplier: The device on the supplier end of the link.
769 * @s_node: Hook to the supplier device's list of links to consumers.
770 * @consumer: The device on the consumer end of the link.
771 * @c_node: Hook to the consumer device's list of links to suppliers.
772 * @status: The state of the link (with respect to the presence of drivers).
773 * @flags: Link flags.
774 * @rpm_active: Whether or not the consumer device is runtime-PM-active.
775 * @rcu_head: An RCU head to use for deferred execution of SRCU callbacks.
778 struct device
*supplier
;
779 struct list_head s_node
;
780 struct device
*consumer
;
781 struct list_head c_node
;
782 enum device_link_state status
;
786 struct rcu_head rcu_head
;
791 * enum dl_dev_state - Device driver presence tracking information.
792 * @DL_DEV_NO_DRIVER: There is no driver attached to the device.
793 * @DL_DEV_PROBING: A driver is probing.
794 * @DL_DEV_DRIVER_BOUND: The driver has been bound to the device.
795 * @DL_DEV_UNBINDING: The driver is unbinding from the device.
798 DL_DEV_NO_DRIVER
= 0,
805 * struct dev_links_info - Device data related to device links.
806 * @suppliers: List of links to supplier devices.
807 * @consumers: List of links to consumer devices.
808 * @status: Driver status information.
810 struct dev_links_info
{
811 struct list_head suppliers
;
812 struct list_head consumers
;
813 enum dl_dev_state status
;
817 * struct device - The basic device structure
818 * @parent: The device's "parent" device, the device to which it is attached.
819 * In most cases, a parent device is some sort of bus or host
820 * controller. If parent is NULL, the device, is a top-level device,
821 * which is not usually what you want.
822 * @p: Holds the private data of the driver core portions of the device.
823 * See the comment of the struct device_private for detail.
824 * @kobj: A top-level, abstract class from which other classes are derived.
825 * @init_name: Initial name of the device.
826 * @type: The type of device.
827 * This identifies the device type and carries type-specific
829 * @mutex: Mutex to synchronize calls to its driver.
830 * @bus: Type of bus device is on.
831 * @driver: Which driver has allocated this
832 * @platform_data: Platform data specific to the device.
833 * Example: For devices on custom boards, as typical of embedded
834 * and SOC based hardware, Linux often uses platform_data to point
835 * to board-specific structures describing devices and how they
836 * are wired. That can include what ports are available, chip
837 * variants, which GPIO pins act in what additional roles, and so
838 * on. This shrinks the "Board Support Packages" (BSPs) and
839 * minimizes board-specific #ifdefs in drivers.
840 * @driver_data: Private pointer for driver specific info.
841 * @links: Links to suppliers and consumers of this device.
842 * @power: For device power management.
843 * See Documentation/driver-api/pm/devices.rst for details.
844 * @pm_domain: Provide callbacks that are executed during system suspend,
845 * hibernation, system resume and during runtime PM transitions
846 * along with subsystem-level and driver-level callbacks.
847 * @pins: For device pin management.
848 * See Documentation/driver-api/pinctl.rst for details.
849 * @msi_list: Hosts MSI descriptors
850 * @msi_domain: The generic MSI domain this device is using.
851 * @numa_node: NUMA node this device is close to.
852 * @dma_ops: DMA mapping operations for this device.
853 * @dma_mask: Dma mask (if dma'ble device).
854 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
855 * hardware supports 64-bit addresses for consistent allocations
857 * @dma_pfn_offset: offset of DMA memory range relatively of RAM
858 * @dma_parms: A low level driver may set these to teach IOMMU code about
859 * segment limitations.
860 * @dma_pools: Dma pools (if dma'ble device).
861 * @dma_mem: Internal for coherent mem override.
862 * @cma_area: Contiguous memory area for dma allocations
863 * @archdata: For arch-specific additions.
864 * @of_node: Associated device tree node.
865 * @fwnode: Associated device node supplied by platform firmware.
866 * @devt: For creating the sysfs "dev".
867 * @id: device instance
868 * @devres_lock: Spinlock to protect the resource of the device.
869 * @devres_head: The resources list of the device.
870 * @knode_class: The node used to add the device to the class list.
871 * @class: The class of the device.
872 * @groups: Optional attribute groups.
873 * @release: Callback to free the device after all references have
874 * gone away. This should be set by the allocator of the
875 * device (i.e. the bus driver that discovered the device).
876 * @iommu_group: IOMMU group the device belongs to.
877 * @iommu_fwspec: IOMMU-specific properties supplied by firmware.
879 * @offline_disabled: If set, the device is permanently online.
880 * @offline: Set after successful invocation of bus type's .offline().
881 * @of_node_reused: Set if the device-tree node is shared with an ancestor
884 * At the lowest level, every device in a Linux system is represented by an
885 * instance of struct device. The device structure contains the information
886 * that the device model core needs to model the system. Most subsystems,
887 * however, track additional information about the devices they host. As a
888 * result, it is rare for devices to be represented by bare device structures;
889 * instead, that structure, like kobject structures, is usually embedded within
890 * a higher-level representation of the device.
893 struct device
*parent
;
895 struct device_private
*p
;
898 const char *init_name
; /* initial name of the device */
899 const struct device_type
*type
;
901 struct mutex mutex
; /* mutex to synchronize calls to
905 struct bus_type
*bus
; /* type of bus device is on */
906 struct device_driver
*driver
; /* which driver has allocated this
908 void *platform_data
; /* Platform specific data, device
909 core doesn't touch it */
910 void *driver_data
; /* Driver data, set and get with
911 dev_set/get_drvdata */
912 struct dev_links_info links
;
913 struct dev_pm_info power
;
914 struct dev_pm_domain
*pm_domain
;
916 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
917 struct irq_domain
*msi_domain
;
919 #ifdef CONFIG_PINCTRL
920 struct dev_pin_info
*pins
;
922 #ifdef CONFIG_GENERIC_MSI_IRQ
923 struct list_head msi_list
;
927 int numa_node
; /* NUMA node this device is close to */
929 const struct dma_map_ops
*dma_ops
;
930 u64
*dma_mask
; /* dma mask (if dma'able device) */
931 u64 coherent_dma_mask
;/* Like dma_mask, but for
932 alloc_coherent mappings as
933 not all hardware supports
934 64 bit addresses for consistent
935 allocations such descriptors. */
936 unsigned long dma_pfn_offset
;
938 struct device_dma_parameters
*dma_parms
;
940 struct list_head dma_pools
; /* dma pools (if dma'ble) */
942 struct dma_coherent_mem
*dma_mem
; /* internal for coherent mem
944 #ifdef CONFIG_DMA_CMA
945 struct cma
*cma_area
; /* contiguous memory area for dma
948 /* arch specific additions */
949 struct dev_archdata archdata
;
951 struct device_node
*of_node
; /* associated device tree node */
952 struct fwnode_handle
*fwnode
; /* firmware device node */
954 dev_t devt
; /* dev_t, creates the sysfs "dev" */
955 u32 id
; /* device instance */
957 spinlock_t devres_lock
;
958 struct list_head devres_head
;
960 struct klist_node knode_class
;
962 const struct attribute_group
**groups
; /* optional groups */
964 void (*release
)(struct device
*dev
);
965 struct iommu_group
*iommu_group
;
966 struct iommu_fwspec
*iommu_fwspec
;
968 bool offline_disabled
:1;
970 bool of_node_reused
:1;
973 static inline struct device
*kobj_to_dev(struct kobject
*kobj
)
975 return container_of(kobj
, struct device
, kobj
);
978 /* Get the wakeup routines, which depend on struct device */
979 #include <linux/pm_wakeup.h>
981 static inline const char *dev_name(const struct device
*dev
)
983 /* Use the init name until the kobject becomes available */
985 return dev
->init_name
;
987 return kobject_name(&dev
->kobj
);
990 extern __printf(2, 3)
991 int dev_set_name(struct device
*dev
, const char *name
, ...);
994 static inline int dev_to_node(struct device
*dev
)
996 return dev
->numa_node
;
998 static inline void set_dev_node(struct device
*dev
, int node
)
1000 dev
->numa_node
= node
;
1003 static inline int dev_to_node(struct device
*dev
)
1007 static inline void set_dev_node(struct device
*dev
, int node
)
1012 static inline struct irq_domain
*dev_get_msi_domain(const struct device
*dev
)
1014 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
1015 return dev
->msi_domain
;
1021 static inline void dev_set_msi_domain(struct device
*dev
, struct irq_domain
*d
)
1023 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
1024 dev
->msi_domain
= d
;
1028 static inline void *dev_get_drvdata(const struct device
*dev
)
1030 return dev
->driver_data
;
1033 static inline void dev_set_drvdata(struct device
*dev
, void *data
)
1035 dev
->driver_data
= data
;
1038 static inline struct pm_subsys_data
*dev_to_psd(struct device
*dev
)
1040 return dev
? dev
->power
.subsys_data
: NULL
;
1043 static inline unsigned int dev_get_uevent_suppress(const struct device
*dev
)
1045 return dev
->kobj
.uevent_suppress
;
1048 static inline void dev_set_uevent_suppress(struct device
*dev
, int val
)
1050 dev
->kobj
.uevent_suppress
= val
;
1053 static inline int device_is_registered(struct device
*dev
)
1055 return dev
->kobj
.state_in_sysfs
;
1058 static inline void device_enable_async_suspend(struct device
*dev
)
1060 if (!dev
->power
.is_prepared
)
1061 dev
->power
.async_suspend
= true;
1064 static inline void device_disable_async_suspend(struct device
*dev
)
1066 if (!dev
->power
.is_prepared
)
1067 dev
->power
.async_suspend
= false;
1070 static inline bool device_async_suspend_enabled(struct device
*dev
)
1072 return !!dev
->power
.async_suspend
;
1075 static inline void dev_pm_syscore_device(struct device
*dev
, bool val
)
1077 #ifdef CONFIG_PM_SLEEP
1078 dev
->power
.syscore
= val
;
1082 static inline void dev_pm_set_driver_flags(struct device
*dev
, u32 flags
)
1084 dev
->power
.driver_flags
= flags
;
1087 static inline bool dev_pm_test_driver_flags(struct device
*dev
, u32 flags
)
1089 return !!(dev
->power
.driver_flags
& flags
);
1092 static inline void device_lock(struct device
*dev
)
1094 mutex_lock(&dev
->mutex
);
1097 static inline int device_lock_interruptible(struct device
*dev
)
1099 return mutex_lock_interruptible(&dev
->mutex
);
1102 static inline int device_trylock(struct device
*dev
)
1104 return mutex_trylock(&dev
->mutex
);
1107 static inline void device_unlock(struct device
*dev
)
1109 mutex_unlock(&dev
->mutex
);
1112 static inline void device_lock_assert(struct device
*dev
)
1114 lockdep_assert_held(&dev
->mutex
);
1117 static inline struct device_node
*dev_of_node(struct device
*dev
)
1119 if (!IS_ENABLED(CONFIG_OF
))
1121 return dev
->of_node
;
1124 void driver_init(void);
1127 * High level routines for use by the bus drivers
1129 extern int __must_check
device_register(struct device
*dev
);
1130 extern void device_unregister(struct device
*dev
);
1131 extern void device_initialize(struct device
*dev
);
1132 extern int __must_check
device_add(struct device
*dev
);
1133 extern void device_del(struct device
*dev
);
1134 extern int device_for_each_child(struct device
*dev
, void *data
,
1135 int (*fn
)(struct device
*dev
, void *data
));
1136 extern int device_for_each_child_reverse(struct device
*dev
, void *data
,
1137 int (*fn
)(struct device
*dev
, void *data
));
1138 extern struct device
*device_find_child(struct device
*dev
, void *data
,
1139 int (*match
)(struct device
*dev
, void *data
));
1140 extern int device_rename(struct device
*dev
, const char *new_name
);
1141 extern int device_move(struct device
*dev
, struct device
*new_parent
,
1142 enum dpm_order dpm_order
);
1143 extern const char *device_get_devnode(struct device
*dev
,
1144 umode_t
*mode
, kuid_t
*uid
, kgid_t
*gid
,
1147 static inline bool device_supports_offline(struct device
*dev
)
1149 return dev
->bus
&& dev
->bus
->offline
&& dev
->bus
->online
;
1152 extern void lock_device_hotplug(void);
1153 extern void unlock_device_hotplug(void);
1154 extern int lock_device_hotplug_sysfs(void);
1155 extern int device_offline(struct device
*dev
);
1156 extern int device_online(struct device
*dev
);
1157 extern void set_primary_fwnode(struct device
*dev
, struct fwnode_handle
*fwnode
);
1158 extern void set_secondary_fwnode(struct device
*dev
, struct fwnode_handle
*fwnode
);
1159 void device_set_of_node_from_dev(struct device
*dev
, const struct device
*dev2
);
1161 static inline int dev_num_vf(struct device
*dev
)
1163 if (dev
->bus
&& dev
->bus
->num_vf
)
1164 return dev
->bus
->num_vf(dev
);
1169 * Root device objects for grouping under /sys/devices
1171 extern struct device
*__root_device_register(const char *name
,
1172 struct module
*owner
);
1174 /* This is a macro to avoid include problems with THIS_MODULE */
1175 #define root_device_register(name) \
1176 __root_device_register(name, THIS_MODULE)
1178 extern void root_device_unregister(struct device
*root
);
1180 static inline void *dev_get_platdata(const struct device
*dev
)
1182 return dev
->platform_data
;
1186 * Manual binding of a device to driver. See drivers/base/bus.c
1187 * for information on use.
1189 extern int __must_check
device_bind_driver(struct device
*dev
);
1190 extern void device_release_driver(struct device
*dev
);
1191 extern int __must_check
device_attach(struct device
*dev
);
1192 extern int __must_check
driver_attach(struct device_driver
*drv
);
1193 extern void device_initial_probe(struct device
*dev
);
1194 extern int __must_check
device_reprobe(struct device
*dev
);
1196 extern bool device_is_bound(struct device
*dev
);
1199 * Easy functions for dynamically creating devices on the fly
1201 extern __printf(5, 0)
1202 struct device
*device_create_vargs(struct class *cls
, struct device
*parent
,
1203 dev_t devt
, void *drvdata
,
1204 const char *fmt
, va_list vargs
);
1205 extern __printf(5, 6)
1206 struct device
*device_create(struct class *cls
, struct device
*parent
,
1207 dev_t devt
, void *drvdata
,
1208 const char *fmt
, ...);
1209 extern __printf(6, 7)
1210 struct device
*device_create_with_groups(struct class *cls
,
1211 struct device
*parent
, dev_t devt
, void *drvdata
,
1212 const struct attribute_group
**groups
,
1213 const char *fmt
, ...);
1214 extern void device_destroy(struct class *cls
, dev_t devt
);
1216 extern int __must_check
device_add_groups(struct device
*dev
,
1217 const struct attribute_group
**groups
);
1218 extern void device_remove_groups(struct device
*dev
,
1219 const struct attribute_group
**groups
);
1221 static inline int __must_check
device_add_group(struct device
*dev
,
1222 const struct attribute_group
*grp
)
1224 const struct attribute_group
*groups
[] = { grp
, NULL
};
1226 return device_add_groups(dev
, groups
);
1229 static inline void device_remove_group(struct device
*dev
,
1230 const struct attribute_group
*grp
)
1232 const struct attribute_group
*groups
[] = { grp
, NULL
};
1234 return device_remove_groups(dev
, groups
);
1237 extern int __must_check
devm_device_add_groups(struct device
*dev
,
1238 const struct attribute_group
**groups
);
1239 extern void devm_device_remove_groups(struct device
*dev
,
1240 const struct attribute_group
**groups
);
1241 extern int __must_check
devm_device_add_group(struct device
*dev
,
1242 const struct attribute_group
*grp
);
1243 extern void devm_device_remove_group(struct device
*dev
,
1244 const struct attribute_group
*grp
);
1247 * Platform "fixup" functions - allow the platform to have their say
1248 * about devices and actions that the general device layer doesn't
1251 /* Notify platform of device discovery */
1252 extern int (*platform_notify
)(struct device
*dev
);
1254 extern int (*platform_notify_remove
)(struct device
*dev
);
1258 * get_device - atomically increment the reference count for the device.
1261 extern struct device
*get_device(struct device
*dev
);
1262 extern void put_device(struct device
*dev
);
1264 #ifdef CONFIG_DEVTMPFS
1265 extern int devtmpfs_create_node(struct device
*dev
);
1266 extern int devtmpfs_delete_node(struct device
*dev
);
1267 extern int devtmpfs_mount(const char *mntdir
);
1269 static inline int devtmpfs_create_node(struct device
*dev
) { return 0; }
1270 static inline int devtmpfs_delete_node(struct device
*dev
) { return 0; }
1271 static inline int devtmpfs_mount(const char *mountpoint
) { return 0; }
1274 /* drivers/base/power/shutdown.c */
1275 extern void device_shutdown(void);
1277 /* debugging and troubleshooting/diagnostic helpers. */
1278 extern const char *dev_driver_string(const struct device
*dev
);
1280 /* Device links interface. */
1281 struct device_link
*device_link_add(struct device
*consumer
,
1282 struct device
*supplier
, u32 flags
);
1283 void device_link_del(struct device_link
*link
);
1285 #ifdef CONFIG_PRINTK
1287 #if defined(__KMSG_CHECKER) && defined(KMSG_COMPONENT)
1289 /* generate magic string for scripts/kmsg-doc to parse */
1290 #define dev_emerg(dev, format, arg...) \
1291 __KMSG_DEV(KERN_EMERG _FMT_ format _ARGS_ dev, ## arg _END_)
1292 #define dev_alert(dev, format, arg...) \
1293 __KMSG_DEV(KERN_ALERT _FMT_ format _ARGS_ dev, ## arg _END_)
1294 #define dev_crit(dev, format, arg...) \
1295 __KMSG_DEV(KERN_CRIT _FMT_ format _ARGS_ dev, ## arg _END_)
1296 #define dev_err(dev, format, arg...) \
1297 __KMSG_DEV(KERN_ERR _FMT_ format _ARGS_ dev, ## arg _END_)
1298 #define dev_warn(dev, format, arg...) \
1299 __KMSG_DEV(KERN_WARNING _FMT_ format _ARGS_ dev, ## arg _END_)
1300 #define dev_notice(dev, format, arg...) \
1301 __KMSG_DEV(KERN_NOTICE _FMT_ format _ARGS_ dev, ## arg _END_)
1302 #define _dev_info(dev, format, arg...) \
1303 __KMSG_DEV(KERN_INFO _FMT_ format _ARGS_ dev, ## arg _END_)
1305 #elif defined(CONFIG_KMSG_IDS) && defined(KMSG_COMPONENT)
1307 extern int dev_printk_hash(const char *level
, const struct device
*dev
,
1308 const char *fmt
, ...);
1309 extern __printf(2,3)
1310 int dev_emerg_hash(const struct device
*dev
, const char *fmt
, ...);
1311 extern __printf(2,3)
1312 int dev_alert_hash(const struct device
*dev
, const char *fmt
, ...);
1313 extern __printf(2,3)
1314 int dev_crit_hash(const struct device
*dev
, const char *fmt
, ...);
1315 extern __printf(2,3)
1316 int dev_err_hash(const struct device
*dev
, const char *fmt
, ...);
1317 extern __printf(2,3)
1318 int dev_warn_hash(const struct device
*dev
, const char *fmt
, ...);
1319 extern __printf(2,3)
1320 int dev_notice_hash(const struct device
*dev
, const char *fmt
, ...);
1321 extern __printf(2,3)
1322 int _dev_info_hash(const struct device
*dev
, const char *fmt
, ...);
1324 #define dev_printk(level, dev, format, arg...) \
1325 dev_printk_hash(level, dev, "%s: " format, dev_name(dev), ## arg)
1326 #define dev_emerg(dev, format, arg...) \
1327 dev_emerg_hash(dev, "%s: " format, dev_name(dev), ## arg)
1328 #define dev_alert(dev, format, arg...) \
1329 dev_alert_hash(dev, "%s: " format, dev_name(dev), ## arg)
1330 #define dev_crit(dev, format, arg...) \
1331 dev_crit_hash(dev, "%s: " format, dev_name(dev), ## arg)
1332 #define dev_err(dev, format, arg...) \
1333 dev_err_hash(dev, "%s: " format, dev_name(dev), ## arg)
1334 #define dev_warn(dev, format, arg...) \
1335 dev_warn_hash(dev, "%s: " format, dev_name(dev), ## arg)
1336 #define dev_notice(dev, format, arg...) \
1337 dev_notice_hash(dev, "%s: " format, dev_name(dev), ## arg)
1338 #define _dev_info(dev, format, arg...) \
1339 _dev_info_hash(dev, "%s: " format, dev_name(dev), ## arg)
1341 #else /* !defined(CONFIG_KMSG_IDS) */
1343 extern __printf(3, 0)
1344 int dev_vprintk_emit(int level
, const struct device
*dev
,
1345 const char *fmt
, va_list args
);
1346 extern __printf(3, 4)
1347 int dev_printk_emit(int level
, const struct device
*dev
, const char *fmt
, ...);
1349 extern __printf(3, 4)
1350 void dev_printk(const char *level
, const struct device
*dev
,
1351 const char *fmt
, ...);
1352 extern __printf(2, 3)
1353 void dev_emerg(const struct device
*dev
, const char *fmt
, ...);
1354 extern __printf(2, 3)
1355 void dev_alert(const struct device
*dev
, const char *fmt
, ...);
1356 extern __printf(2, 3)
1357 void dev_crit(const struct device
*dev
, const char *fmt
, ...);
1358 extern __printf(2, 3)
1359 void dev_err(const struct device
*dev
, const char *fmt
, ...);
1360 extern __printf(2, 3)
1361 void dev_warn(const struct device
*dev
, const char *fmt
, ...);
1362 extern __printf(2, 3)
1363 void dev_notice(const struct device
*dev
, const char *fmt
, ...);
1364 extern __printf(2, 3)
1365 void _dev_info(const struct device
*dev
, const char *fmt
, ...);
1367 #endif /* !defined(CONFIG_KMSG_IDS) */
1369 #else /* !defined(CONFIG_PRINTK) */
1371 static inline __printf(3, 0)
1372 int dev_vprintk_emit(int level
, const struct device
*dev
,
1373 const char *fmt
, va_list args
)
1375 static inline __printf(3, 4)
1376 int dev_printk_emit(int level
, const struct device
*dev
, const char *fmt
, ...)
1379 static inline void __dev_printk(const char *level
, const struct device
*dev
,
1380 struct va_format
*vaf
)
1382 static inline __printf(3, 4)
1383 void dev_printk(const char *level
, const struct device
*dev
,
1384 const char *fmt
, ...)
1387 static inline __printf(2, 3)
1388 void dev_emerg(const struct device
*dev
, const char *fmt
, ...)
1390 static inline __printf(2, 3)
1391 void dev_crit(const struct device
*dev
, const char *fmt
, ...)
1393 static inline __printf(2, 3)
1394 void dev_alert(const struct device
*dev
, const char *fmt
, ...)
1396 static inline __printf(2, 3)
1397 void dev_err(const struct device
*dev
, const char *fmt
, ...)
1399 static inline __printf(2, 3)
1400 void dev_warn(const struct device
*dev
, const char *fmt
, ...)
1402 static inline __printf(2, 3)
1403 void dev_notice(const struct device
*dev
, const char *fmt
, ...)
1405 static inline __printf(2, 3)
1406 void _dev_info(const struct device
*dev
, const char *fmt
, ...)
1409 #endif /* !defined(CONFIG_PRINTK) */
1412 * Stupid hackaround for existing uses of non-printk uses dev_info
1414 * Note that the definition of dev_info below is actually _dev_info
1415 * and a macro is used to avoid redefining dev_info
1418 #define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
1420 #if defined(CONFIG_DYNAMIC_DEBUG)
1421 #define dev_dbg(dev, format, ...) \
1423 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
1425 #elif defined(DEBUG)
1426 #define dev_dbg(dev, format, arg...) \
1427 dev_printk(KERN_DEBUG, dev, format, ##arg)
1429 #define dev_dbg(dev, format, arg...) \
1432 dev_printk(KERN_DEBUG, dev, format, ##arg); \
1436 #ifdef CONFIG_PRINTK
1437 #define dev_level_once(dev_level, dev, fmt, ...) \
1439 static bool __print_once __read_mostly; \
1441 if (!__print_once) { \
1442 __print_once = true; \
1443 dev_level(dev, fmt, ##__VA_ARGS__); \
1447 #define dev_level_once(dev_level, dev, fmt, ...) \
1450 dev_level(dev, fmt, ##__VA_ARGS__); \
1454 #define dev_emerg_once(dev, fmt, ...) \
1455 dev_level_once(dev_emerg, dev, fmt, ##__VA_ARGS__)
1456 #define dev_alert_once(dev, fmt, ...) \
1457 dev_level_once(dev_alert, dev, fmt, ##__VA_ARGS__)
1458 #define dev_crit_once(dev, fmt, ...) \
1459 dev_level_once(dev_crit, dev, fmt, ##__VA_ARGS__)
1460 #define dev_err_once(dev, fmt, ...) \
1461 dev_level_once(dev_err, dev, fmt, ##__VA_ARGS__)
1462 #define dev_warn_once(dev, fmt, ...) \
1463 dev_level_once(dev_warn, dev, fmt, ##__VA_ARGS__)
1464 #define dev_notice_once(dev, fmt, ...) \
1465 dev_level_once(dev_notice, dev, fmt, ##__VA_ARGS__)
1466 #define dev_info_once(dev, fmt, ...) \
1467 dev_level_once(dev_info, dev, fmt, ##__VA_ARGS__)
1468 #define dev_dbg_once(dev, fmt, ...) \
1469 dev_level_once(dev_dbg, dev, fmt, ##__VA_ARGS__)
1471 #define dev_level_ratelimited(dev_level, dev, fmt, ...) \
1473 static DEFINE_RATELIMIT_STATE(_rs, \
1474 DEFAULT_RATELIMIT_INTERVAL, \
1475 DEFAULT_RATELIMIT_BURST); \
1476 if (__ratelimit(&_rs)) \
1477 dev_level(dev, fmt, ##__VA_ARGS__); \
1480 #define dev_emerg_ratelimited(dev, fmt, ...) \
1481 dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
1482 #define dev_alert_ratelimited(dev, fmt, ...) \
1483 dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
1484 #define dev_crit_ratelimited(dev, fmt, ...) \
1485 dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
1486 #define dev_err_ratelimited(dev, fmt, ...) \
1487 dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
1488 #define dev_warn_ratelimited(dev, fmt, ...) \
1489 dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
1490 #define dev_notice_ratelimited(dev, fmt, ...) \
1491 dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
1492 #define dev_info_ratelimited(dev, fmt, ...) \
1493 dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
1494 #if defined(CONFIG_DYNAMIC_DEBUG)
1495 /* descriptor check is first to prevent flooding with "callbacks suppressed" */
1496 #define dev_dbg_ratelimited(dev, fmt, ...) \
1498 static DEFINE_RATELIMIT_STATE(_rs, \
1499 DEFAULT_RATELIMIT_INTERVAL, \
1500 DEFAULT_RATELIMIT_BURST); \
1501 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
1502 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) && \
1503 __ratelimit(&_rs)) \
1504 __dynamic_dev_dbg(&descriptor, dev, fmt, \
1507 #elif defined(DEBUG)
1508 #define dev_dbg_ratelimited(dev, fmt, ...) \
1510 static DEFINE_RATELIMIT_STATE(_rs, \
1511 DEFAULT_RATELIMIT_INTERVAL, \
1512 DEFAULT_RATELIMIT_BURST); \
1513 if (__ratelimit(&_rs)) \
1514 dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); \
1517 #define dev_dbg_ratelimited(dev, fmt, ...) \
1520 dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); \
1524 #ifdef VERBOSE_DEBUG
1525 #define dev_vdbg dev_dbg
1527 #define dev_vdbg(dev, format, arg...) \
1530 dev_printk(KERN_DEBUG, dev, format, ##arg); \
1535 * dev_WARN*() acts like dev_printk(), but with the key difference of
1536 * using WARN/WARN_ONCE to include file/line information and a backtrace.
1538 #define dev_WARN(dev, format, arg...) \
1539 WARN(1, "%s %s: " format, dev_driver_string(dev), dev_name(dev), ## arg);
1541 #define dev_WARN_ONCE(dev, condition, format, arg...) \
1542 WARN_ONCE(condition, "%s %s: " format, \
1543 dev_driver_string(dev), dev_name(dev), ## arg)
1545 /* Create alias, so I can be autoloaded. */
1546 #define MODULE_ALIAS_CHARDEV(major,minor) \
1547 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1548 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1549 MODULE_ALIAS("char-major-" __stringify(major) "-*")
1551 #ifdef CONFIG_SYSFS_DEPRECATED
1552 extern long sysfs_deprecated
;
1554 #define sysfs_deprecated 0
1558 * module_driver() - Helper macro for drivers that don't do anything
1559 * special in module init/exit. This eliminates a lot of boilerplate.
1560 * Each module may only use this macro once, and calling it replaces
1561 * module_init() and module_exit().
1563 * @__driver: driver name
1564 * @__register: register function for this driver type
1565 * @__unregister: unregister function for this driver type
1566 * @...: Additional arguments to be passed to __register and __unregister.
1568 * Use this macro to construct bus specific macros for registering
1569 * drivers, and do not use it on its own.
1571 #define module_driver(__driver, __register, __unregister, ...) \
1572 static int __init __driver##_init(void) \
1574 return __register(&(__driver) , ##__VA_ARGS__); \
1576 module_init(__driver##_init); \
1577 static void __exit __driver##_exit(void) \
1579 __unregister(&(__driver) , ##__VA_ARGS__); \
1581 module_exit(__driver##_exit);
1584 * builtin_driver() - Helper macro for drivers that don't do anything
1585 * special in init and have no exit. This eliminates some boilerplate.
1586 * Each driver may only use this macro once, and calling it replaces
1587 * device_initcall (or in some cases, the legacy __initcall). This is
1588 * meant to be a direct parallel of module_driver() above but without
1589 * the __exit stuff that is not used for builtin cases.
1591 * @__driver: driver name
1592 * @__register: register function for this driver type
1593 * @...: Additional arguments to be passed to __register
1595 * Use this macro to construct bus specific macros for registering
1596 * drivers, and do not use it on its own.
1598 #define builtin_driver(__driver, __register, ...) \
1599 static int __init __driver##_init(void) \
1601 return __register(&(__driver) , ##__VA_ARGS__); \
1603 device_initcall(__driver##_init);
1605 #endif /* _DEVICE_H_ */