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
101 * A bus is a channel between the processor and one or more devices. For the
102 * purposes of the device model, all devices are connected via a bus, even if
103 * it is an internal, virtual, "platform" bus. Buses can plug into each other.
104 * A USB controller is usually a PCI device, for example. The device model
105 * represents the actual connections between buses and the devices they control.
106 * A bus is represented by the bus_type structure. It contains the name, the
107 * default attributes, the bus' methods, PM operations, and the driver core's
112 const char *dev_name;
113 struct device *dev_root;
114 const struct attribute_group **bus_groups;
115 const struct attribute_group **dev_groups;
116 const struct attribute_group **drv_groups;
118 int (*match)(struct device *dev, struct device_driver *drv);
119 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
120 int (*probe)(struct device *dev);
121 int (*remove)(struct device *dev);
122 void (*shutdown)(struct device *dev);
124 int (*online)(struct device *dev);
125 int (*offline)(struct device *dev);
127 int (*suspend)(struct device *dev, pm_message_t state);
128 int (*resume)(struct device *dev);
130 int (*num_vf)(struct device *dev);
132 const struct dev_pm_ops *pm;
134 const struct iommu_ops *iommu_ops;
136 struct subsys_private *p;
137 struct lock_class_key lock_key;
140 extern int __must_check bus_register(struct bus_type *bus);
142 extern void bus_unregister(struct bus_type *bus);
144 extern int __must_check bus_rescan_devices(struct bus_type *bus);
146 /* iterator helpers for buses */
147 struct subsys_dev_iter {
148 struct klist_iter ki;
149 const struct device_type *type;
151 void subsys_dev_iter_init(struct subsys_dev_iter *iter,
152 struct bus_type *subsys,
153 struct device *start,
154 const struct device_type *type);
155 struct device *subsys_dev_iter_next(struct subsys_dev_iter *iter);
156 void subsys_dev_iter_exit(struct subsys_dev_iter *iter);
158 int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
159 int (*fn)(struct device *dev, void *data));
160 struct device *bus_find_device(struct bus_type *bus, struct device *start,
162 int (*match)(struct device *dev, void *data));
163 struct device *bus_find_device_by_name(struct bus_type *bus,
164 struct device *start,
166 struct device *subsys_find_device_by_id(struct bus_type *bus, unsigned int id,
167 struct device *hint);
168 int bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
169 void *data, int (*fn)(struct device_driver *, void *));
170 void bus_sort_breadthfirst(struct bus_type *bus,
171 int (*compare)(const struct device *a,
172 const struct device *b));
174 * Bus notifiers: Get notified of addition/removal of devices
175 * and binding/unbinding of drivers to devices.
176 * In the long run, it should be a replacement for the platform
179 struct notifier_block;
181 extern int bus_register_notifier(struct bus_type *bus,
182 struct notifier_block *nb);
183 extern int bus_unregister_notifier(struct bus_type *bus,
184 struct notifier_block *nb);
186 /* All 4 notifers below get called with the target struct device *
187 * as an argument. Note that those functions are likely to be called
188 * with the device lock held in the core, so be careful.
190 #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
191 #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device to be removed */
192 #define BUS_NOTIFY_REMOVED_DEVICE 0x00000003 /* device removed */
193 #define BUS_NOTIFY_BIND_DRIVER 0x00000004 /* driver about to be
195 #define BUS_NOTIFY_BOUND_DRIVER 0x00000005 /* driver bound to device */
196 #define BUS_NOTIFY_UNBIND_DRIVER 0x00000006 /* driver about to be
198 #define BUS_NOTIFY_UNBOUND_DRIVER 0x00000007 /* driver is unbound
200 #define BUS_NOTIFY_DRIVER_NOT_BOUND 0x00000008 /* driver fails to be bound */
202 extern struct kset *bus_get_kset(struct bus_type *bus);
203 extern struct klist *bus_get_device_klist(struct bus_type *bus);
206 * enum probe_type - device driver probe type to try
207 * Device drivers may opt in for special handling of their
208 * respective probe routines. This tells the core what to
211 * @PROBE_DEFAULT_STRATEGY: Used by drivers that work equally well
212 * whether probed synchronously or asynchronously.
213 * @PROBE_PREFER_ASYNCHRONOUS: Drivers for "slow" devices which
214 * probing order is not essential for booting the system may
215 * opt into executing their probes asynchronously.
216 * @PROBE_FORCE_SYNCHRONOUS: Use this to annotate drivers that need
217 * their probe routines to run synchronously with driver and
218 * device registration (with the exception of -EPROBE_DEFER
219 * handling - re-probing always ends up being done asynchronously).
221 * Note that the end goal is to switch the kernel to use asynchronous
222 * probing by default, so annotating drivers with
223 * %PROBE_PREFER_ASYNCHRONOUS is a temporary measure that allows us
224 * to speed up boot process while we are validating the rest of the
228 PROBE_DEFAULT_STRATEGY,
229 PROBE_PREFER_ASYNCHRONOUS,
230 PROBE_FORCE_SYNCHRONOUS,
234 * struct device_driver - The basic device driver structure
235 * @name: Name of the device driver.
236 * @bus: The bus which the device of this driver belongs to.
237 * @owner: The module owner.
238 * @mod_name: Used for built-in modules.
239 * @suppress_bind_attrs: Disables bind/unbind via sysfs.
240 * @probe_type: Type of the probe (synchronous or asynchronous) to use.
241 * @of_match_table: The open firmware table.
242 * @acpi_match_table: The ACPI match table.
243 * @probe: Called to query the existence of a specific device,
244 * whether this driver can work with it, and bind the driver
245 * to a specific device.
246 * @remove: Called when the device is removed from the system to
247 * unbind a device from this driver.
248 * @shutdown: Called at shut-down time to quiesce the device.
249 * @suspend: Called to put the device to sleep mode. Usually to a
251 * @resume: Called to bring a device from sleep mode.
252 * @groups: Default attributes that get created by the driver core
254 * @pm: Power management operations of the device which matched
256 * @p: Driver core's private data, no one other than the driver
257 * core can touch this.
259 * The device driver-model tracks all of the drivers known to the system.
260 * The main reason for this tracking is to enable the driver core to match
261 * up drivers with new devices. Once drivers are known objects within the
262 * system, however, a number of other things become possible. Device drivers
263 * can export information and configuration variables that are independent
264 * of any specific device.
266 struct device_driver {
268 struct bus_type *bus;
270 struct module *owner;
271 const char *mod_name; /* used for built-in modules */
273 bool suppress_bind_attrs; /* disables bind/unbind via sysfs */
274 enum probe_type probe_type;
276 const struct of_device_id *of_match_table;
277 const struct acpi_device_id *acpi_match_table;
279 int (*probe) (struct device *dev);
280 int (*remove) (struct device *dev);
281 void (*shutdown) (struct device *dev);
282 int (*suspend) (struct device *dev, pm_message_t state);
283 int (*resume) (struct device *dev);
284 const struct attribute_group **groups;
286 const struct dev_pm_ops *pm;
288 struct driver_private *p;
292 extern int __must_check driver_register(struct device_driver *drv);
293 extern void driver_unregister(struct device_driver *drv);
295 extern struct device_driver *driver_find(const char *name,
296 struct bus_type *bus);
297 extern int driver_probe_done(void);
298 extern void wait_for_device_probe(void);
301 /* sysfs interface for exporting driver attributes */
303 struct driver_attribute {
304 struct attribute attr;
305 ssize_t (*show)(struct device_driver *driver, char *buf);
306 ssize_t (*store)(struct device_driver *driver, const char *buf,
310 #define DRIVER_ATTR(_name, _mode, _show, _store) \
311 struct driver_attribute driver_attr_##_name = __ATTR(_name, _mode, _show, _store)
312 #define DRIVER_ATTR_RW(_name) \
313 struct driver_attribute driver_attr_##_name = __ATTR_RW(_name)
314 #define DRIVER_ATTR_RO(_name) \
315 struct driver_attribute driver_attr_##_name = __ATTR_RO(_name)
316 #define DRIVER_ATTR_WO(_name) \
317 struct driver_attribute driver_attr_##_name = __ATTR_WO(_name)
319 extern int __must_check driver_create_file(struct device_driver *driver,
320 const struct driver_attribute *attr);
321 extern void driver_remove_file(struct device_driver *driver,
322 const struct driver_attribute *attr);
324 extern int __must_check driver_for_each_device(struct device_driver *drv,
325 struct device *start,
327 int (*fn)(struct device *dev,
329 struct device *driver_find_device(struct device_driver *drv,
330 struct device *start, void *data,
331 int (*match)(struct device *dev, void *data));
334 * struct subsys_interface - interfaces to device functions
335 * @name: name of the device function
336 * @subsys: subsytem of the devices to attach to
337 * @node: the list of functions registered at the subsystem
338 * @add_dev: device hookup to device function handler
339 * @remove_dev: device hookup to device function handler
341 * Simple interfaces attached to a subsystem. Multiple interfaces can
342 * attach to a subsystem and its devices. Unlike drivers, they do not
343 * exclusively claim or control devices. Interfaces usually represent
344 * a specific functionality of a subsystem/class of devices.
346 struct subsys_interface {
348 struct bus_type *subsys;
349 struct list_head node;
350 int (*add_dev)(struct device *dev, struct subsys_interface *sif);
351 void (*remove_dev)(struct device *dev, struct subsys_interface *sif);
354 int subsys_interface_register(struct subsys_interface *sif);
355 void subsys_interface_unregister(struct subsys_interface *sif);
357 int subsys_system_register(struct bus_type *subsys,
358 const struct attribute_group **groups);
359 int subsys_virtual_register(struct bus_type *subsys,
360 const struct attribute_group **groups);
363 * struct class - device classes
364 * @name: Name of the class.
365 * @owner: The module owner.
366 * @class_groups: Default attributes of this class.
367 * @dev_groups: Default attributes of the devices that belong to the class.
368 * @dev_kobj: The kobject that represents this class and links it into the hierarchy.
369 * @dev_uevent: Called when a device is added, removed from this class, or a
370 * few other things that generate uevents to add the environment
372 * @devnode: Callback to provide the devtmpfs.
373 * @class_release: Called to release this class.
374 * @dev_release: Called to release the device.
375 * @suspend: Used to put the device to sleep mode, usually to a low power
377 * @resume: Used to bring the device from the sleep mode.
378 * @ns_type: Callbacks so sysfs can detemine namespaces.
379 * @namespace: Namespace of the device belongs to this class.
380 * @pm: The default device power management operations of this class.
381 * @p: The private data of the driver core, no one other than the
382 * driver core can touch this.
384 * A class is a higher-level view of a device that abstracts out low-level
385 * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
386 * at the class level, they are all simply disks. Classes allow user space
387 * to work with devices based on what they do, rather than how they are
388 * connected or how they work.
392 struct module *owner;
394 const struct attribute_group **class_groups;
395 const struct attribute_group **dev_groups;
396 struct kobject *dev_kobj;
398 int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
399 char *(*devnode)(struct device *dev, umode_t *mode);
401 void (*class_release)(struct class *class);
402 void (*dev_release)(struct device *dev);
404 int (*suspend)(struct device *dev, pm_message_t state);
405 int (*resume)(struct device *dev);
407 const struct kobj_ns_type_operations *ns_type;
408 const void *(*namespace)(struct device *dev);
410 const struct dev_pm_ops *pm;
412 struct subsys_private *p;
415 struct class_dev_iter {
416 struct klist_iter ki;
417 const struct device_type *type;
420 extern struct kobject *sysfs_dev_block_kobj;
421 extern struct kobject *sysfs_dev_char_kobj;
422 extern int __must_check __class_register(struct class *class,
423 struct lock_class_key *key);
424 extern void class_unregister(struct class *class);
426 /* This is a #define to keep the compiler from merging different
427 * instances of the __key variable */
428 #define class_register(class) \
430 static struct lock_class_key __key; \
431 __class_register(class, &__key); \
435 struct class_compat *class_compat_register(const char *name);
436 void class_compat_unregister(struct class_compat *cls);
437 int class_compat_create_link(struct class_compat *cls, struct device *dev,
438 struct device *device_link);
439 void class_compat_remove_link(struct class_compat *cls, struct device *dev,
440 struct device *device_link);
442 extern void class_dev_iter_init(struct class_dev_iter *iter,
444 struct device *start,
445 const struct device_type *type);
446 extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
447 extern void class_dev_iter_exit(struct class_dev_iter *iter);
449 extern int class_for_each_device(struct class *class, struct device *start,
451 int (*fn)(struct device *dev, void *data));
452 extern struct device *class_find_device(struct class *class,
453 struct device *start, const void *data,
454 int (*match)(struct device *, const void *));
456 struct class_attribute {
457 struct attribute attr;
458 ssize_t (*show)(struct class *class, struct class_attribute *attr,
460 ssize_t (*store)(struct class *class, struct class_attribute *attr,
461 const char *buf, size_t count);
464 #define CLASS_ATTR_RW(_name) \
465 struct class_attribute class_attr_##_name = __ATTR_RW(_name)
466 #define CLASS_ATTR_RO(_name) \
467 struct class_attribute class_attr_##_name = __ATTR_RO(_name)
468 #define CLASS_ATTR_WO(_name) \
469 struct class_attribute class_attr_##_name = __ATTR_WO(_name)
471 extern int __must_check class_create_file_ns(struct class *class,
472 const struct class_attribute *attr,
474 extern void class_remove_file_ns(struct class *class,
475 const struct class_attribute *attr,
478 static inline int __must_check class_create_file(struct class *class,
479 const struct class_attribute *attr)
481 return class_create_file_ns(class, attr, NULL);
484 static inline void class_remove_file(struct class *class,
485 const struct class_attribute *attr)
487 return class_remove_file_ns(class, attr, NULL);
490 /* Simple class attribute that is just a static string */
491 struct class_attribute_string {
492 struct class_attribute attr;
496 /* Currently read-only only */
497 #define _CLASS_ATTR_STRING(_name, _mode, _str) \
498 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
499 #define CLASS_ATTR_STRING(_name, _mode, _str) \
500 struct class_attribute_string class_attr_##_name = \
501 _CLASS_ATTR_STRING(_name, _mode, _str)
503 extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr,
506 struct class_interface {
507 struct list_head node;
510 int (*add_dev) (struct device *, struct class_interface *);
511 void (*remove_dev) (struct device *, struct class_interface *);
514 extern int __must_check class_interface_register(struct class_interface *);
515 extern void class_interface_unregister(struct class_interface *);
517 extern struct class * __must_check __class_create(struct module *owner,
519 struct lock_class_key *key);
520 extern void class_destroy(struct class *cls);
522 /* This is a #define to keep the compiler from merging different
523 * instances of the __key variable */
524 #define class_create(owner, name) \
526 static struct lock_class_key __key; \
527 __class_create(owner, name, &__key); \
531 * The type of device, "struct device" is embedded in. A class
532 * or bus can contain devices of different types
533 * like "partitions" and "disks", "mouse" and "event".
534 * This identifies the device type and carries type-specific
535 * information, equivalent to the kobj_type of a kobject.
536 * If "name" is specified, the uevent will contain it in
537 * the DEVTYPE variable.
541 const struct attribute_group **groups;
542 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
543 char *(*devnode)(struct device *dev, umode_t *mode,
544 kuid_t *uid, kgid_t *gid);
545 void (*release)(struct device *dev);
547 const struct dev_pm_ops *pm;
550 /* interface for exporting device attributes */
551 struct device_attribute {
552 struct attribute attr;
553 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
555 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
556 const char *buf, size_t count);
559 struct dev_ext_attribute {
560 struct device_attribute attr;
564 ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
566 ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
567 const char *buf, size_t count);
568 ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
570 ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
571 const char *buf, size_t count);
572 ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
574 ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
575 const char *buf, size_t count);
577 #define DEVICE_ATTR(_name, _mode, _show, _store) \
578 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
579 #define DEVICE_ATTR_RW(_name) \
580 struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
581 #define DEVICE_ATTR_RO(_name) \
582 struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
583 #define DEVICE_ATTR_WO(_name) \
584 struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
585 #define DEVICE_ULONG_ATTR(_name, _mode, _var) \
586 struct dev_ext_attribute dev_attr_##_name = \
587 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
588 #define DEVICE_INT_ATTR(_name, _mode, _var) \
589 struct dev_ext_attribute dev_attr_##_name = \
590 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
591 #define DEVICE_BOOL_ATTR(_name, _mode, _var) \
592 struct dev_ext_attribute dev_attr_##_name = \
593 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
594 #define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
595 struct device_attribute dev_attr_##_name = \
596 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
598 extern int device_create_file(struct device *device,
599 const struct device_attribute *entry);
600 extern void device_remove_file(struct device *dev,
601 const struct device_attribute *attr);
602 extern bool device_remove_file_self(struct device *dev,
603 const struct device_attribute *attr);
604 extern int __must_check device_create_bin_file(struct device *dev,
605 const struct bin_attribute *attr);
606 extern void device_remove_bin_file(struct device *dev,
607 const struct bin_attribute *attr);
609 /* device resource management */
610 typedef void (*dr_release_t)(struct device *dev, void *res);
611 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
613 #ifdef CONFIG_DEBUG_DEVRES
614 extern void *__devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
615 int nid, const char *name) __malloc;
616 #define devres_alloc(release, size, gfp) \
617 __devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release)
618 #define devres_alloc_node(release, size, gfp, nid) \
619 __devres_alloc_node(release, size, gfp, nid, #release)
621 extern void *devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
623 static inline void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp)
625 return devres_alloc_node(release, size, gfp, NUMA_NO_NODE);
629 extern void devres_for_each_res(struct device *dev, dr_release_t release,
630 dr_match_t match, void *match_data,
631 void (*fn)(struct device *, void *, void *),
633 extern void devres_free(void *res);
634 extern void devres_add(struct device *dev, void *res);
635 extern void *devres_find(struct device *dev, dr_release_t release,
636 dr_match_t match, void *match_data);
637 extern void *devres_get(struct device *dev, void *new_res,
638 dr_match_t match, void *match_data);
639 extern void *devres_remove(struct device *dev, dr_release_t release,
640 dr_match_t match, void *match_data);
641 extern int devres_destroy(struct device *dev, dr_release_t release,
642 dr_match_t match, void *match_data);
643 extern int devres_release(struct device *dev, dr_release_t release,
644 dr_match_t match, void *match_data);
647 extern void * __must_check devres_open_group(struct device *dev, void *id,
649 extern void devres_close_group(struct device *dev, void *id);
650 extern void devres_remove_group(struct device *dev, void *id);
651 extern int devres_release_group(struct device *dev, void *id);
653 /* managed devm_k.alloc/kfree for device drivers */
654 extern void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp) __malloc;
655 extern __printf(3, 0)
656 char *devm_kvasprintf(struct device *dev, gfp_t gfp, const char *fmt,
657 va_list ap) __malloc;
658 extern __printf(3, 4)
659 char *devm_kasprintf(struct device *dev, gfp_t gfp, const char *fmt, ...) __malloc;
660 static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp)
662 return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
664 static inline void *devm_kmalloc_array(struct device *dev,
665 size_t n, size_t size, gfp_t flags)
667 if (size != 0 && n > SIZE_MAX / size)
669 return devm_kmalloc(dev, n * size, flags);
671 static inline void *devm_kcalloc(struct device *dev,
672 size_t n, size_t size, gfp_t flags)
674 return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
676 extern void devm_kfree(struct device *dev, void *p);
677 extern char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp) __malloc;
678 extern void *devm_kmemdup(struct device *dev, const void *src, size_t len,
681 extern unsigned long devm_get_free_pages(struct device *dev,
682 gfp_t gfp_mask, unsigned int order);
683 extern void devm_free_pages(struct device *dev, unsigned long addr);
685 void __iomem *devm_ioremap_resource(struct device *dev, struct resource *res);
687 /* allows to add/remove a custom action to devres stack */
688 int devm_add_action(struct device *dev, void (*action)(void *), void *data);
689 void devm_remove_action(struct device *dev, void (*action)(void *), void *data);
691 static inline int devm_add_action_or_reset(struct device *dev,
692 void (*action)(void *), void *data)
696 ret = devm_add_action(dev, action, data);
704 * devm_alloc_percpu - Resource-managed alloc_percpu
705 * @dev: Device to allocate per-cpu memory for
706 * @type: Type to allocate per-cpu memory for
708 * Managed alloc_percpu. Per-cpu memory allocated with this function is
709 * automatically freed on driver detach.
712 * Pointer to allocated memory on success, NULL on failure.
714 #define devm_alloc_percpu(dev, type) \
715 ((typeof(type) __percpu *)__devm_alloc_percpu((dev), sizeof(type), \
718 void __percpu *__devm_alloc_percpu(struct device *dev, size_t size,
720 void devm_free_percpu(struct device *dev, void __percpu *pdata);
722 struct device_dma_parameters {
724 * a low level driver may set these to teach IOMMU code about
727 unsigned int max_segment_size;
728 unsigned long segment_boundary_mask;
732 * enum device_link_state - Device link states.
733 * @DL_STATE_NONE: The presence of the drivers is not being tracked.
734 * @DL_STATE_DORMANT: None of the supplier/consumer drivers is present.
735 * @DL_STATE_AVAILABLE: The supplier driver is present, but the consumer is not.
736 * @DL_STATE_CONSUMER_PROBE: The consumer is probing (supplier driver present).
737 * @DL_STATE_ACTIVE: Both the supplier and consumer drivers are present.
738 * @DL_STATE_SUPPLIER_UNBIND: The supplier driver is unbinding.
740 enum device_link_state {
742 DL_STATE_DORMANT = 0,
744 DL_STATE_CONSUMER_PROBE,
746 DL_STATE_SUPPLIER_UNBIND,
752 * STATELESS: The core won't track the presence of supplier/consumer drivers.
753 * AUTOREMOVE: Remove this link automatically on consumer driver unbind.
754 * PM_RUNTIME: If set, the runtime PM framework will use this link.
755 * RPM_ACTIVE: Run pm_runtime_get_sync() on the supplier during link creation.
757 #define DL_FLAG_STATELESS BIT(0)
758 #define DL_FLAG_AUTOREMOVE BIT(1)
759 #define DL_FLAG_PM_RUNTIME BIT(2)
760 #define DL_FLAG_RPM_ACTIVE BIT(3)
763 * struct device_link - Device link representation.
764 * @supplier: The device on the supplier end of the link.
765 * @s_node: Hook to the supplier device's list of links to consumers.
766 * @consumer: The device on the consumer end of the link.
767 * @c_node: Hook to the consumer device's list of links to suppliers.
768 * @status: The state of the link (with respect to the presence of drivers).
769 * @flags: Link flags.
770 * @rpm_active: Whether or not the consumer device is runtime-PM-active.
771 * @rcu_head: An RCU head to use for deferred execution of SRCU callbacks.
774 struct device *supplier;
775 struct list_head s_node;
776 struct device *consumer;
777 struct list_head c_node;
778 enum device_link_state status;
782 struct rcu_head rcu_head;
787 * enum dl_dev_state - Device driver presence tracking information.
788 * @DL_DEV_NO_DRIVER: There is no driver attached to the device.
789 * @DL_DEV_PROBING: A driver is probing.
790 * @DL_DEV_DRIVER_BOUND: The driver has been bound to the device.
791 * @DL_DEV_UNBINDING: The driver is unbinding from the device.
794 DL_DEV_NO_DRIVER = 0,
801 * struct dev_links_info - Device data related to device links.
802 * @suppliers: List of links to supplier devices.
803 * @consumers: List of links to consumer devices.
804 * @status: Driver status information.
806 struct dev_links_info {
807 struct list_head suppliers;
808 struct list_head consumers;
809 enum dl_dev_state status;
813 * struct device - The basic device structure
814 * @parent: The device's "parent" device, the device to which it is attached.
815 * In most cases, a parent device is some sort of bus or host
816 * controller. If parent is NULL, the device, is a top-level device,
817 * which is not usually what you want.
818 * @p: Holds the private data of the driver core portions of the device.
819 * See the comment of the struct device_private for detail.
820 * @kobj: A top-level, abstract class from which other classes are derived.
821 * @init_name: Initial name of the device.
822 * @type: The type of device.
823 * This identifies the device type and carries type-specific
825 * @mutex: Mutex to synchronize calls to its driver.
826 * @bus: Type of bus device is on.
827 * @driver: Which driver has allocated this
828 * @platform_data: Platform data specific to the device.
829 * Example: For devices on custom boards, as typical of embedded
830 * and SOC based hardware, Linux often uses platform_data to point
831 * to board-specific structures describing devices and how they
832 * are wired. That can include what ports are available, chip
833 * variants, which GPIO pins act in what additional roles, and so
834 * on. This shrinks the "Board Support Packages" (BSPs) and
835 * minimizes board-specific #ifdefs in drivers.
836 * @driver_data: Private pointer for driver specific info.
837 * @links: Links to suppliers and consumers of this device.
838 * @power: For device power management.
839 * See Documentation/power/admin-guide/devices.rst for details.
840 * @pm_domain: Provide callbacks that are executed during system suspend,
841 * hibernation, system resume and during runtime PM transitions
842 * along with subsystem-level and driver-level callbacks.
843 * @pins: For device pin management.
844 * See Documentation/pinctrl.txt for details.
845 * @msi_list: Hosts MSI descriptors
846 * @msi_domain: The generic MSI domain this device is using.
847 * @numa_node: NUMA node this device is close to.
848 * @dma_mask: Dma mask (if dma'ble device).
849 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
850 * hardware supports 64-bit addresses for consistent allocations
852 * @dma_pfn_offset: offset of DMA memory range relatively of RAM
853 * @dma_parms: A low level driver may set these to teach IOMMU code about
854 * segment limitations.
855 * @dma_pools: Dma pools (if dma'ble device).
856 * @dma_mem: Internal for coherent mem override.
857 * @cma_area: Contiguous memory area for dma allocations
858 * @archdata: For arch-specific additions.
859 * @of_node: Associated device tree node.
860 * @fwnode: Associated device node supplied by platform firmware.
861 * @devt: For creating the sysfs "dev".
862 * @id: device instance
863 * @devres_lock: Spinlock to protect the resource of the device.
864 * @devres_head: The resources list of the device.
865 * @knode_class: The node used to add the device to the class list.
866 * @class: The class of the device.
867 * @groups: Optional attribute groups.
868 * @release: Callback to free the device after all references have
869 * gone away. This should be set by the allocator of the
870 * device (i.e. the bus driver that discovered the device).
871 * @iommu_group: IOMMU group the device belongs to.
872 * @iommu_fwspec: IOMMU-specific properties supplied by firmware.
874 * @offline_disabled: If set, the device is permanently online.
875 * @offline: Set after successful invocation of bus type's .offline().
877 * At the lowest level, every device in a Linux system is represented by an
878 * instance of struct device. The device structure contains the information
879 * that the device model core needs to model the system. Most subsystems,
880 * however, track additional information about the devices they host. As a
881 * result, it is rare for devices to be represented by bare device structures;
882 * instead, that structure, like kobject structures, is usually embedded within
883 * a higher-level representation of the device.
886 struct device *parent;
888 struct device_private *p;
891 const char *init_name; /* initial name of the device */
892 const struct device_type *type;
894 struct mutex mutex; /* mutex to synchronize calls to
898 struct bus_type *bus; /* type of bus device is on */
899 struct device_driver *driver; /* which driver has allocated this
901 void *platform_data; /* Platform specific data, device
902 core doesn't touch it */
903 void *driver_data; /* Driver data, set and get with
904 dev_set/get_drvdata */
905 struct dev_links_info links;
906 struct dev_pm_info power;
907 struct dev_pm_domain *pm_domain;
909 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
910 struct irq_domain *msi_domain;
912 #ifdef CONFIG_PINCTRL
913 struct dev_pin_info *pins;
915 #ifdef CONFIG_GENERIC_MSI_IRQ
916 struct list_head msi_list;
920 int numa_node; /* NUMA node this device is close to */
922 const struct dma_map_ops *dma_ops;
923 u64 *dma_mask; /* dma mask (if dma'able device) */
924 u64 coherent_dma_mask;/* Like dma_mask, but for
925 alloc_coherent mappings as
926 not all hardware supports
927 64 bit addresses for consistent
928 allocations such descriptors. */
929 unsigned long dma_pfn_offset;
931 struct device_dma_parameters *dma_parms;
933 struct list_head dma_pools; /* dma pools (if dma'ble) */
935 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
937 #ifdef CONFIG_DMA_CMA
938 struct cma *cma_area; /* contiguous memory area for dma
941 /* arch specific additions */
942 struct dev_archdata archdata;
944 struct device_node *of_node; /* associated device tree node */
945 struct fwnode_handle *fwnode; /* firmware device node */
947 dev_t devt; /* dev_t, creates the sysfs "dev" */
948 u32 id; /* device instance */
950 spinlock_t devres_lock;
951 struct list_head devres_head;
953 struct klist_node knode_class;
955 const struct attribute_group **groups; /* optional groups */
957 void (*release)(struct device *dev);
958 struct iommu_group *iommu_group;
959 struct iommu_fwspec *iommu_fwspec;
961 bool offline_disabled:1;
965 static inline struct device *kobj_to_dev(struct kobject *kobj)
967 return container_of(kobj, struct device, kobj);
970 /* Get the wakeup routines, which depend on struct device */
971 #include <linux/pm_wakeup.h>
973 static inline const char *dev_name(const struct device *dev)
975 /* Use the init name until the kobject becomes available */
977 return dev->init_name;
979 return kobject_name(&dev->kobj);
982 extern __printf(2, 3)
983 int dev_set_name(struct device *dev, const char *name, ...);
986 static inline int dev_to_node(struct device *dev)
988 return dev->numa_node;
990 static inline void set_dev_node(struct device *dev, int node)
992 dev->numa_node = node;
995 static inline int dev_to_node(struct device *dev)
999 static inline void set_dev_node(struct device *dev, int node)
1004 static inline struct irq_domain *dev_get_msi_domain(const struct device *dev)
1006 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
1007 return dev->msi_domain;
1013 static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d)
1015 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
1016 dev->msi_domain = d;
1020 static inline void *dev_get_drvdata(const struct device *dev)
1022 return dev->driver_data;
1025 static inline void dev_set_drvdata(struct device *dev, void *data)
1027 dev->driver_data = data;
1030 static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
1032 return dev ? dev->power.subsys_data : NULL;
1035 static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
1037 return dev->kobj.uevent_suppress;
1040 static inline void dev_set_uevent_suppress(struct device *dev, int val)
1042 dev->kobj.uevent_suppress = val;
1045 static inline int device_is_registered(struct device *dev)
1047 return dev->kobj.state_in_sysfs;
1050 static inline void device_enable_async_suspend(struct device *dev)
1052 if (!dev->power.is_prepared)
1053 dev->power.async_suspend = true;
1056 static inline void device_disable_async_suspend(struct device *dev)
1058 if (!dev->power.is_prepared)
1059 dev->power.async_suspend = false;
1062 static inline bool device_async_suspend_enabled(struct device *dev)
1064 return !!dev->power.async_suspend;
1067 static inline void dev_pm_syscore_device(struct device *dev, bool val)
1069 #ifdef CONFIG_PM_SLEEP
1070 dev->power.syscore = val;
1074 static inline void device_lock(struct device *dev)
1076 mutex_lock(&dev->mutex);
1079 static inline int device_lock_interruptible(struct device *dev)
1081 return mutex_lock_interruptible(&dev->mutex);
1084 static inline int device_trylock(struct device *dev)
1086 return mutex_trylock(&dev->mutex);
1089 static inline void device_unlock(struct device *dev)
1091 mutex_unlock(&dev->mutex);
1094 static inline void device_lock_assert(struct device *dev)
1096 lockdep_assert_held(&dev->mutex);
1099 static inline struct device_node *dev_of_node(struct device *dev)
1101 if (!IS_ENABLED(CONFIG_OF))
1103 return dev->of_node;
1106 void driver_init(void);
1109 * High level routines for use by the bus drivers
1111 extern int __must_check device_register(struct device *dev);
1112 extern void device_unregister(struct device *dev);
1113 extern void device_initialize(struct device *dev);
1114 extern int __must_check device_add(struct device *dev);
1115 extern void device_del(struct device *dev);
1116 extern int device_for_each_child(struct device *dev, void *data,
1117 int (*fn)(struct device *dev, void *data));
1118 extern int device_for_each_child_reverse(struct device *dev, void *data,
1119 int (*fn)(struct device *dev, void *data));
1120 extern struct device *device_find_child(struct device *dev, void *data,
1121 int (*match)(struct device *dev, void *data));
1122 extern int device_rename(struct device *dev, const char *new_name);
1123 extern int device_move(struct device *dev, struct device *new_parent,
1124 enum dpm_order dpm_order);
1125 extern const char *device_get_devnode(struct device *dev,
1126 umode_t *mode, kuid_t *uid, kgid_t *gid,
1129 static inline bool device_supports_offline(struct device *dev)
1131 return dev->bus && dev->bus->offline && dev->bus->online;
1134 extern void lock_device_hotplug(void);
1135 extern void unlock_device_hotplug(void);
1136 extern int lock_device_hotplug_sysfs(void);
1137 extern int device_offline(struct device *dev);
1138 extern int device_online(struct device *dev);
1139 extern void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1140 extern void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1142 static inline int dev_num_vf(struct device *dev)
1144 if (dev->bus && dev->bus->num_vf)
1145 return dev->bus->num_vf(dev);
1150 * Root device objects for grouping under /sys/devices
1152 extern struct device *__root_device_register(const char *name,
1153 struct module *owner);
1155 /* This is a macro to avoid include problems with THIS_MODULE */
1156 #define root_device_register(name) \
1157 __root_device_register(name, THIS_MODULE)
1159 extern void root_device_unregister(struct device *root);
1161 static inline void *dev_get_platdata(const struct device *dev)
1163 return dev->platform_data;
1167 * Manual binding of a device to driver. See drivers/base/bus.c
1168 * for information on use.
1170 extern int __must_check device_bind_driver(struct device *dev);
1171 extern void device_release_driver(struct device *dev);
1172 extern int __must_check device_attach(struct device *dev);
1173 extern int __must_check driver_attach(struct device_driver *drv);
1174 extern void device_initial_probe(struct device *dev);
1175 extern int __must_check device_reprobe(struct device *dev);
1177 extern bool device_is_bound(struct device *dev);
1180 * Easy functions for dynamically creating devices on the fly
1182 extern __printf(5, 0)
1183 struct device *device_create_vargs(struct class *cls, struct device *parent,
1184 dev_t devt, void *drvdata,
1185 const char *fmt, va_list vargs);
1186 extern __printf(5, 6)
1187 struct device *device_create(struct class *cls, struct device *parent,
1188 dev_t devt, void *drvdata,
1189 const char *fmt, ...);
1190 extern __printf(6, 7)
1191 struct device *device_create_with_groups(struct class *cls,
1192 struct device *parent, dev_t devt, void *drvdata,
1193 const struct attribute_group **groups,
1194 const char *fmt, ...);
1195 extern void device_destroy(struct class *cls, dev_t devt);
1198 * Platform "fixup" functions - allow the platform to have their say
1199 * about devices and actions that the general device layer doesn't
1202 /* Notify platform of device discovery */
1203 extern int (*platform_notify)(struct device *dev);
1205 extern int (*platform_notify_remove)(struct device *dev);
1209 * get_device - atomically increment the reference count for the device.
1212 extern struct device *get_device(struct device *dev);
1213 extern void put_device(struct device *dev);
1215 #ifdef CONFIG_DEVTMPFS
1216 extern int devtmpfs_create_node(struct device *dev);
1217 extern int devtmpfs_delete_node(struct device *dev);
1218 extern int devtmpfs_mount(const char *mntdir);
1220 static inline int devtmpfs_create_node(struct device *dev) { return 0; }
1221 static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
1222 static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
1225 /* drivers/base/power/shutdown.c */
1226 extern void device_shutdown(void);
1228 /* debugging and troubleshooting/diagnostic helpers. */
1229 extern const char *dev_driver_string(const struct device *dev);
1231 /* Device links interface. */
1232 struct device_link *device_link_add(struct device *consumer,
1233 struct device *supplier, u32 flags);
1234 void device_link_del(struct device_link *link);
1236 #ifdef CONFIG_PRINTK
1238 extern __printf(3, 0)
1239 int dev_vprintk_emit(int level, const struct device *dev,
1240 const char *fmt, va_list args);
1241 extern __printf(3, 4)
1242 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...);
1244 extern __printf(3, 4)
1245 void dev_printk(const char *level, const struct device *dev,
1246 const char *fmt, ...);
1247 extern __printf(2, 3)
1248 void dev_emerg(const struct device *dev, const char *fmt, ...);
1249 extern __printf(2, 3)
1250 void dev_alert(const struct device *dev, const char *fmt, ...);
1251 extern __printf(2, 3)
1252 void dev_crit(const struct device *dev, const char *fmt, ...);
1253 extern __printf(2, 3)
1254 void dev_err(const struct device *dev, const char *fmt, ...);
1255 extern __printf(2, 3)
1256 void dev_warn(const struct device *dev, const char *fmt, ...);
1257 extern __printf(2, 3)
1258 void dev_notice(const struct device *dev, const char *fmt, ...);
1259 extern __printf(2, 3)
1260 void _dev_info(const struct device *dev, const char *fmt, ...);
1264 static inline __printf(3, 0)
1265 int dev_vprintk_emit(int level, const struct device *dev,
1266 const char *fmt, va_list args)
1268 static inline __printf(3, 4)
1269 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
1272 static inline void __dev_printk(const char *level, const struct device *dev,
1273 struct va_format *vaf)
1275 static inline __printf(3, 4)
1276 void dev_printk(const char *level, const struct device *dev,
1277 const char *fmt, ...)
1280 static inline __printf(2, 3)
1281 void dev_emerg(const struct device *dev, const char *fmt, ...)
1283 static inline __printf(2, 3)
1284 void dev_crit(const struct device *dev, const char *fmt, ...)
1286 static inline __printf(2, 3)
1287 void dev_alert(const struct device *dev, const char *fmt, ...)
1289 static inline __printf(2, 3)
1290 void dev_err(const struct device *dev, const char *fmt, ...)
1292 static inline __printf(2, 3)
1293 void dev_warn(const struct device *dev, const char *fmt, ...)
1295 static inline __printf(2, 3)
1296 void dev_notice(const struct device *dev, const char *fmt, ...)
1298 static inline __printf(2, 3)
1299 void _dev_info(const struct device *dev, const char *fmt, ...)
1305 * Stupid hackaround for existing uses of non-printk uses dev_info
1307 * Note that the definition of dev_info below is actually _dev_info
1308 * and a macro is used to avoid redefining dev_info
1311 #define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
1313 #if defined(CONFIG_DYNAMIC_DEBUG)
1314 #define dev_dbg(dev, format, ...) \
1316 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
1318 #elif defined(DEBUG)
1319 #define dev_dbg(dev, format, arg...) \
1320 dev_printk(KERN_DEBUG, dev, format, ##arg)
1322 #define dev_dbg(dev, format, arg...) \
1325 dev_printk(KERN_DEBUG, dev, format, ##arg); \
1329 #ifdef CONFIG_PRINTK
1330 #define dev_level_once(dev_level, dev, fmt, ...) \
1332 static bool __print_once __read_mostly; \
1334 if (!__print_once) { \
1335 __print_once = true; \
1336 dev_level(dev, fmt, ##__VA_ARGS__); \
1340 #define dev_level_once(dev_level, dev, fmt, ...) \
1343 dev_level(dev, fmt, ##__VA_ARGS__); \
1347 #define dev_emerg_once(dev, fmt, ...) \
1348 dev_level_once(dev_emerg, dev, fmt, ##__VA_ARGS__)
1349 #define dev_alert_once(dev, fmt, ...) \
1350 dev_level_once(dev_alert, dev, fmt, ##__VA_ARGS__)
1351 #define dev_crit_once(dev, fmt, ...) \
1352 dev_level_once(dev_crit, dev, fmt, ##__VA_ARGS__)
1353 #define dev_err_once(dev, fmt, ...) \
1354 dev_level_once(dev_err, dev, fmt, ##__VA_ARGS__)
1355 #define dev_warn_once(dev, fmt, ...) \
1356 dev_level_once(dev_warn, dev, fmt, ##__VA_ARGS__)
1357 #define dev_notice_once(dev, fmt, ...) \
1358 dev_level_once(dev_notice, dev, fmt, ##__VA_ARGS__)
1359 #define dev_info_once(dev, fmt, ...) \
1360 dev_level_once(dev_info, dev, fmt, ##__VA_ARGS__)
1361 #define dev_dbg_once(dev, fmt, ...) \
1362 dev_level_once(dev_dbg, dev, fmt, ##__VA_ARGS__)
1364 #define dev_level_ratelimited(dev_level, dev, fmt, ...) \
1366 static DEFINE_RATELIMIT_STATE(_rs, \
1367 DEFAULT_RATELIMIT_INTERVAL, \
1368 DEFAULT_RATELIMIT_BURST); \
1369 if (__ratelimit(&_rs)) \
1370 dev_level(dev, fmt, ##__VA_ARGS__); \
1373 #define dev_emerg_ratelimited(dev, fmt, ...) \
1374 dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
1375 #define dev_alert_ratelimited(dev, fmt, ...) \
1376 dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
1377 #define dev_crit_ratelimited(dev, fmt, ...) \
1378 dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
1379 #define dev_err_ratelimited(dev, fmt, ...) \
1380 dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
1381 #define dev_warn_ratelimited(dev, fmt, ...) \
1382 dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
1383 #define dev_notice_ratelimited(dev, fmt, ...) \
1384 dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
1385 #define dev_info_ratelimited(dev, fmt, ...) \
1386 dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
1387 #if defined(CONFIG_DYNAMIC_DEBUG)
1388 /* descriptor check is first to prevent flooding with "callbacks suppressed" */
1389 #define dev_dbg_ratelimited(dev, fmt, ...) \
1391 static DEFINE_RATELIMIT_STATE(_rs, \
1392 DEFAULT_RATELIMIT_INTERVAL, \
1393 DEFAULT_RATELIMIT_BURST); \
1394 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
1395 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) && \
1396 __ratelimit(&_rs)) \
1397 __dynamic_dev_dbg(&descriptor, dev, fmt, \
1400 #elif defined(DEBUG)
1401 #define dev_dbg_ratelimited(dev, fmt, ...) \
1403 static DEFINE_RATELIMIT_STATE(_rs, \
1404 DEFAULT_RATELIMIT_INTERVAL, \
1405 DEFAULT_RATELIMIT_BURST); \
1406 if (__ratelimit(&_rs)) \
1407 dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); \
1410 #define dev_dbg_ratelimited(dev, fmt, ...) \
1413 dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); \
1417 #ifdef VERBOSE_DEBUG
1418 #define dev_vdbg dev_dbg
1420 #define dev_vdbg(dev, format, arg...) \
1423 dev_printk(KERN_DEBUG, dev, format, ##arg); \
1428 * dev_WARN*() acts like dev_printk(), but with the key difference of
1429 * using WARN/WARN_ONCE to include file/line information and a backtrace.
1431 #define dev_WARN(dev, format, arg...) \
1432 WARN(1, "%s %s: " format, dev_driver_string(dev), dev_name(dev), ## arg);
1434 #define dev_WARN_ONCE(dev, condition, format, arg...) \
1435 WARN_ONCE(condition, "%s %s: " format, \
1436 dev_driver_string(dev), dev_name(dev), ## arg)
1438 /* Create alias, so I can be autoloaded. */
1439 #define MODULE_ALIAS_CHARDEV(major,minor) \
1440 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1441 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1442 MODULE_ALIAS("char-major-" __stringify(major) "-*")
1444 #ifdef CONFIG_SYSFS_DEPRECATED
1445 extern long sysfs_deprecated;
1447 #define sysfs_deprecated 0
1451 * module_driver() - Helper macro for drivers that don't do anything
1452 * special in module init/exit. This eliminates a lot of boilerplate.
1453 * Each module may only use this macro once, and calling it replaces
1454 * module_init() and module_exit().
1456 * @__driver: driver name
1457 * @__register: register function for this driver type
1458 * @__unregister: unregister function for this driver type
1459 * @...: Additional arguments to be passed to __register and __unregister.
1461 * Use this macro to construct bus specific macros for registering
1462 * drivers, and do not use it on its own.
1464 #define module_driver(__driver, __register, __unregister, ...) \
1465 static int __init __driver##_init(void) \
1467 return __register(&(__driver) , ##__VA_ARGS__); \
1469 module_init(__driver##_init); \
1470 static void __exit __driver##_exit(void) \
1472 __unregister(&(__driver) , ##__VA_ARGS__); \
1474 module_exit(__driver##_exit);
1477 * builtin_driver() - Helper macro for drivers that don't do anything
1478 * special in init and have no exit. This eliminates some boilerplate.
1479 * Each driver may only use this macro once, and calling it replaces
1480 * device_initcall (or in some cases, the legacy __initcall). This is
1481 * meant to be a direct parallel of module_driver() above but without
1482 * the __exit stuff that is not used for builtin cases.
1484 * @__driver: driver name
1485 * @__register: register function for this driver type
1486 * @...: Additional arguments to be passed to __register
1488 * Use this macro to construct bus specific macros for registering
1489 * drivers, and do not use it on its own.
1491 #define builtin_driver(__driver, __register, ...) \
1492 static int __init __driver##_init(void) \
1494 return __register(&(__driver) , ##__VA_ARGS__); \
1496 device_initcall(__driver##_init);
1498 #endif /* _DEVICE_H_ */