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 * @dev_attrs: Default attributes of the devices on the bus.
70 * @bus_groups: Default attributes of the bus.
71 * @dev_groups: Default attributes of the devices on the bus.
72 * @drv_groups: Default attributes of the device drivers on the bus.
73 * @match: Called, perhaps multiple times, whenever a new device or driver
74 * is added for this bus. It should return a positive value if the
75 * given device can be handled by the given driver and zero
76 * otherwise. It may also return error code if determining that
77 * the driver supports the device is not possible. In case of
78 * -EPROBE_DEFER it will queue the device for deferred probing.
79 * @uevent: Called when a device is added, removed, or a few other things
80 * that generate uevents to add the environment variables.
81 * @probe: Called when a new device or driver add to this bus, and callback
82 * the specific driver's probe to initial the matched device.
83 * @remove: Called when a device removed from this bus.
84 * @shutdown: Called at shut-down time to quiesce the device.
86 * @online: Called to put the device back online (after offlining it).
87 * @offline: Called to put the device offline for hot-removal. May fail.
89 * @suspend: Called when a device on this bus wants to go to sleep mode.
90 * @resume: Called to bring a device on this bus out of sleep mode.
91 * @pm: Power management operations of this bus, callback the specific
92 * device driver's pm-ops.
93 * @iommu_ops: IOMMU specific operations for this bus, used to attach IOMMU
94 * driver implementations to a bus and allow the driver to do
96 * @p: The private data of the driver core, only the driver core can
98 * @lock_key: Lock class key for use by the lock validator
100 * A bus is a channel between the processor and one or more devices. For the
101 * purposes of the device model, all devices are connected via a bus, even if
102 * it is an internal, virtual, "platform" bus. Buses can plug into each other.
103 * A USB controller is usually a PCI device, for example. The device model
104 * represents the actual connections between buses and the devices they control.
105 * A bus is represented by the bus_type structure. It contains the name, the
106 * default attributes, the bus' methods, PM operations, and the driver core's
111 const char *dev_name;
112 struct device *dev_root;
113 struct device_attribute *dev_attrs; /* use dev_groups instead */
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 const struct dev_pm_ops *pm;
132 const struct iommu_ops *iommu_ops;
134 struct subsys_private *p;
135 struct lock_class_key lock_key;
138 extern int __must_check bus_register(struct bus_type *bus);
140 extern void bus_unregister(struct bus_type *bus);
142 extern int __must_check bus_rescan_devices(struct bus_type *bus);
144 /* iterator helpers for buses */
145 struct subsys_dev_iter {
146 struct klist_iter ki;
147 const struct device_type *type;
149 void subsys_dev_iter_init(struct subsys_dev_iter *iter,
150 struct bus_type *subsys,
151 struct device *start,
152 const struct device_type *type);
153 struct device *subsys_dev_iter_next(struct subsys_dev_iter *iter);
154 void subsys_dev_iter_exit(struct subsys_dev_iter *iter);
156 int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
157 int (*fn)(struct device *dev, void *data));
158 struct device *bus_find_device(struct bus_type *bus, struct device *start,
160 int (*match)(struct device *dev, void *data));
161 struct device *bus_find_device_by_name(struct bus_type *bus,
162 struct device *start,
164 struct device *subsys_find_device_by_id(struct bus_type *bus, unsigned int id,
165 struct device *hint);
166 int bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
167 void *data, int (*fn)(struct device_driver *, void *));
168 void bus_sort_breadthfirst(struct bus_type *bus,
169 int (*compare)(const struct device *a,
170 const struct device *b));
172 * Bus notifiers: Get notified of addition/removal of devices
173 * and binding/unbinding of drivers to devices.
174 * In the long run, it should be a replacement for the platform
177 struct notifier_block;
179 extern int bus_register_notifier(struct bus_type *bus,
180 struct notifier_block *nb);
181 extern int bus_unregister_notifier(struct bus_type *bus,
182 struct notifier_block *nb);
184 /* All 4 notifers below get called with the target struct device *
185 * as an argument. Note that those functions are likely to be called
186 * with the device lock held in the core, so be careful.
188 #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
189 #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device to be removed */
190 #define BUS_NOTIFY_REMOVED_DEVICE 0x00000003 /* device removed */
191 #define BUS_NOTIFY_BIND_DRIVER 0x00000004 /* driver about to be
193 #define BUS_NOTIFY_BOUND_DRIVER 0x00000005 /* driver bound to device */
194 #define BUS_NOTIFY_UNBIND_DRIVER 0x00000006 /* driver about to be
196 #define BUS_NOTIFY_UNBOUND_DRIVER 0x00000007 /* driver is unbound
198 #define BUS_NOTIFY_DRIVER_NOT_BOUND 0x00000008 /* driver fails to be bound */
200 extern struct kset *bus_get_kset(struct bus_type *bus);
201 extern struct klist *bus_get_device_klist(struct bus_type *bus);
204 * enum probe_type - device driver probe type to try
205 * Device drivers may opt in for special handling of their
206 * respective probe routines. This tells the core what to
209 * @PROBE_DEFAULT_STRATEGY: Used by drivers that work equally well
210 * whether probed synchronously or asynchronously.
211 * @PROBE_PREFER_ASYNCHRONOUS: Drivers for "slow" devices which
212 * probing order is not essential for booting the system may
213 * opt into executing their probes asynchronously.
214 * @PROBE_FORCE_SYNCHRONOUS: Use this to annotate drivers that need
215 * their probe routines to run synchronously with driver and
216 * device registration (with the exception of -EPROBE_DEFER
217 * handling - re-probing always ends up being done asynchronously).
219 * Note that the end goal is to switch the kernel to use asynchronous
220 * probing by default, so annotating drivers with
221 * %PROBE_PREFER_ASYNCHRONOUS is a temporary measure that allows us
222 * to speed up boot process while we are validating the rest of the
226 PROBE_DEFAULT_STRATEGY,
227 PROBE_PREFER_ASYNCHRONOUS,
228 PROBE_FORCE_SYNCHRONOUS,
232 * struct device_driver - The basic device driver structure
233 * @name: Name of the device driver.
234 * @bus: The bus which the device of this driver belongs to.
235 * @owner: The module owner.
236 * @mod_name: Used for built-in modules.
237 * @suppress_bind_attrs: Disables bind/unbind via sysfs.
238 * @probe_type: Type of the probe (synchronous or asynchronous) to use.
239 * @of_match_table: The open firmware table.
240 * @acpi_match_table: The ACPI match table.
241 * @probe: Called to query the existence of a specific device,
242 * whether this driver can work with it, and bind the driver
243 * to a specific device.
244 * @remove: Called when the device is removed from the system to
245 * unbind a device from this driver.
246 * @shutdown: Called at shut-down time to quiesce the device.
247 * @suspend: Called to put the device to sleep mode. Usually to a
249 * @resume: Called to bring a device from sleep mode.
250 * @groups: Default attributes that get created by the driver core
252 * @pm: Power management operations of the device which matched
254 * @p: Driver core's private data, no one other than the driver
255 * core can touch this.
257 * The device driver-model tracks all of the drivers known to the system.
258 * The main reason for this tracking is to enable the driver core to match
259 * up drivers with new devices. Once drivers are known objects within the
260 * system, however, a number of other things become possible. Device drivers
261 * can export information and configuration variables that are independent
262 * of any specific device.
264 struct device_driver {
266 struct bus_type *bus;
268 struct module *owner;
269 const char *mod_name; /* used for built-in modules */
271 bool suppress_bind_attrs; /* disables bind/unbind via sysfs */
272 enum probe_type probe_type;
274 const struct of_device_id *of_match_table;
275 const struct acpi_device_id *acpi_match_table;
277 int (*probe) (struct device *dev);
278 int (*remove) (struct device *dev);
279 void (*shutdown) (struct device *dev);
280 int (*suspend) (struct device *dev, pm_message_t state);
281 int (*resume) (struct device *dev);
282 const struct attribute_group **groups;
284 const struct dev_pm_ops *pm;
286 struct driver_private *p;
290 extern int __must_check driver_register(struct device_driver *drv);
291 extern void driver_unregister(struct device_driver *drv);
293 extern struct device_driver *driver_find(const char *name,
294 struct bus_type *bus);
295 extern int driver_probe_done(void);
296 extern void wait_for_device_probe(void);
299 /* sysfs interface for exporting driver attributes */
301 struct driver_attribute {
302 struct attribute attr;
303 ssize_t (*show)(struct device_driver *driver, char *buf);
304 ssize_t (*store)(struct device_driver *driver, const char *buf,
308 #define DRIVER_ATTR(_name, _mode, _show, _store) \
309 struct driver_attribute driver_attr_##_name = __ATTR(_name, _mode, _show, _store)
310 #define DRIVER_ATTR_RW(_name) \
311 struct driver_attribute driver_attr_##_name = __ATTR_RW(_name)
312 #define DRIVER_ATTR_RO(_name) \
313 struct driver_attribute driver_attr_##_name = __ATTR_RO(_name)
314 #define DRIVER_ATTR_WO(_name) \
315 struct driver_attribute driver_attr_##_name = __ATTR_WO(_name)
317 extern int __must_check driver_create_file(struct device_driver *driver,
318 const struct driver_attribute *attr);
319 extern void driver_remove_file(struct device_driver *driver,
320 const struct driver_attribute *attr);
322 extern int __must_check driver_for_each_device(struct device_driver *drv,
323 struct device *start,
325 int (*fn)(struct device *dev,
327 struct device *driver_find_device(struct device_driver *drv,
328 struct device *start, void *data,
329 int (*match)(struct device *dev, void *data));
332 * struct subsys_interface - interfaces to device functions
333 * @name: name of the device function
334 * @subsys: subsytem of the devices to attach to
335 * @node: the list of functions registered at the subsystem
336 * @add_dev: device hookup to device function handler
337 * @remove_dev: device hookup to device function handler
339 * Simple interfaces attached to a subsystem. Multiple interfaces can
340 * attach to a subsystem and its devices. Unlike drivers, they do not
341 * exclusively claim or control devices. Interfaces usually represent
342 * a specific functionality of a subsystem/class of devices.
344 struct subsys_interface {
346 struct bus_type *subsys;
347 struct list_head node;
348 int (*add_dev)(struct device *dev, struct subsys_interface *sif);
349 void (*remove_dev)(struct device *dev, struct subsys_interface *sif);
352 int subsys_interface_register(struct subsys_interface *sif);
353 void subsys_interface_unregister(struct subsys_interface *sif);
355 int subsys_system_register(struct bus_type *subsys,
356 const struct attribute_group **groups);
357 int subsys_virtual_register(struct bus_type *subsys,
358 const struct attribute_group **groups);
361 * struct class - device classes
362 * @name: Name of the class.
363 * @owner: The module owner.
364 * @class_attrs: Default attributes of this class.
365 * @class_groups: Default attributes of this class.
366 * @dev_groups: Default attributes of the devices that belong to the class.
367 * @dev_kobj: The kobject that represents this class and links it into the hierarchy.
368 * @dev_uevent: Called when a device is added, removed from this class, or a
369 * few other things that generate uevents to add the environment
371 * @devnode: Callback to provide the devtmpfs.
372 * @class_release: Called to release this class.
373 * @dev_release: Called to release the device.
374 * @suspend: Used to put the device to sleep mode, usually to a low power
376 * @resume: Used to bring the device from the sleep mode.
377 * @ns_type: Callbacks so sysfs can detemine namespaces.
378 * @namespace: Namespace of the device belongs to this class.
379 * @pm: The default device power management operations of this class.
380 * @p: The private data of the driver core, no one other than the
381 * driver core can touch this.
383 * A class is a higher-level view of a device that abstracts out low-level
384 * implementation details. Drivers may see a SCSI disk or an ATA disk, but,
385 * at the class level, they are all simply disks. Classes allow user space
386 * to work with devices based on what they do, rather than how they are
387 * connected or how they work.
391 struct module *owner;
393 struct class_attribute *class_attrs;
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(_name, _mode, _show, _store) \
465 struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
466 #define CLASS_ATTR_RW(_name) \
467 struct class_attribute class_attr_##_name = __ATTR_RW(_name)
468 #define CLASS_ATTR_RO(_name) \
469 struct class_attribute class_attr_##_name = __ATTR_RO(_name)
470 #define CLASS_ATTR_WO(_name) \
471 struct class_attribute class_attr_##_name = __ATTR_WO(_name)
473 extern int __must_check class_create_file_ns(struct class *class,
474 const struct class_attribute *attr,
476 extern void class_remove_file_ns(struct class *class,
477 const struct class_attribute *attr,
480 static inline int __must_check class_create_file(struct class *class,
481 const struct class_attribute *attr)
483 return class_create_file_ns(class, attr, NULL);
486 static inline void class_remove_file(struct class *class,
487 const struct class_attribute *attr)
489 return class_remove_file_ns(class, attr, NULL);
492 /* Simple class attribute that is just a static string */
493 struct class_attribute_string {
494 struct class_attribute attr;
498 /* Currently read-only only */
499 #define _CLASS_ATTR_STRING(_name, _mode, _str) \
500 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
501 #define CLASS_ATTR_STRING(_name, _mode, _str) \
502 struct class_attribute_string class_attr_##_name = \
503 _CLASS_ATTR_STRING(_name, _mode, _str)
505 extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr,
508 struct class_interface {
509 struct list_head node;
512 int (*add_dev) (struct device *, struct class_interface *);
513 void (*remove_dev) (struct device *, struct class_interface *);
516 extern int __must_check class_interface_register(struct class_interface *);
517 extern void class_interface_unregister(struct class_interface *);
519 extern struct class * __must_check __class_create(struct module *owner,
521 struct lock_class_key *key);
522 extern void class_destroy(struct class *cls);
524 /* This is a #define to keep the compiler from merging different
525 * instances of the __key variable */
526 #define class_create(owner, name) \
528 static struct lock_class_key __key; \
529 __class_create(owner, name, &__key); \
533 * The type of device, "struct device" is embedded in. A class
534 * or bus can contain devices of different types
535 * like "partitions" and "disks", "mouse" and "event".
536 * This identifies the device type and carries type-specific
537 * information, equivalent to the kobj_type of a kobject.
538 * If "name" is specified, the uevent will contain it in
539 * the DEVTYPE variable.
543 const struct attribute_group **groups;
544 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
545 char *(*devnode)(struct device *dev, umode_t *mode,
546 kuid_t *uid, kgid_t *gid);
547 void (*release)(struct device *dev);
549 const struct dev_pm_ops *pm;
552 /* interface for exporting device attributes */
553 struct device_attribute {
554 struct attribute attr;
555 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
557 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
558 const char *buf, size_t count);
561 struct dev_ext_attribute {
562 struct device_attribute attr;
566 ssize_t device_show_ulong(struct device *dev, struct device_attribute *attr,
568 ssize_t device_store_ulong(struct device *dev, struct device_attribute *attr,
569 const char *buf, size_t count);
570 ssize_t device_show_int(struct device *dev, struct device_attribute *attr,
572 ssize_t device_store_int(struct device *dev, struct device_attribute *attr,
573 const char *buf, size_t count);
574 ssize_t device_show_bool(struct device *dev, struct device_attribute *attr,
576 ssize_t device_store_bool(struct device *dev, struct device_attribute *attr,
577 const char *buf, size_t count);
579 #define DEVICE_ATTR(_name, _mode, _show, _store) \
580 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
581 #define DEVICE_ATTR_RW(_name) \
582 struct device_attribute dev_attr_##_name = __ATTR_RW(_name)
583 #define DEVICE_ATTR_RO(_name) \
584 struct device_attribute dev_attr_##_name = __ATTR_RO(_name)
585 #define DEVICE_ATTR_WO(_name) \
586 struct device_attribute dev_attr_##_name = __ATTR_WO(_name)
587 #define DEVICE_ULONG_ATTR(_name, _mode, _var) \
588 struct dev_ext_attribute dev_attr_##_name = \
589 { __ATTR(_name, _mode, device_show_ulong, device_store_ulong), &(_var) }
590 #define DEVICE_INT_ATTR(_name, _mode, _var) \
591 struct dev_ext_attribute dev_attr_##_name = \
592 { __ATTR(_name, _mode, device_show_int, device_store_int), &(_var) }
593 #define DEVICE_BOOL_ATTR(_name, _mode, _var) \
594 struct dev_ext_attribute dev_attr_##_name = \
595 { __ATTR(_name, _mode, device_show_bool, device_store_bool), &(_var) }
596 #define DEVICE_ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) \
597 struct device_attribute dev_attr_##_name = \
598 __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store)
600 extern int device_create_file(struct device *device,
601 const struct device_attribute *entry);
602 extern void device_remove_file(struct device *dev,
603 const struct device_attribute *attr);
604 extern bool device_remove_file_self(struct device *dev,
605 const struct device_attribute *attr);
606 extern int __must_check device_create_bin_file(struct device *dev,
607 const struct bin_attribute *attr);
608 extern void device_remove_bin_file(struct device *dev,
609 const struct bin_attribute *attr);
611 /* device resource management */
612 typedef void (*dr_release_t)(struct device *dev, void *res);
613 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
615 #ifdef CONFIG_DEBUG_DEVRES
616 extern void *__devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
617 int nid, const char *name) __malloc;
618 #define devres_alloc(release, size, gfp) \
619 __devres_alloc_node(release, size, gfp, NUMA_NO_NODE, #release)
620 #define devres_alloc_node(release, size, gfp, nid) \
621 __devres_alloc_node(release, size, gfp, nid, #release)
623 extern void *devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp,
625 static inline void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp)
627 return devres_alloc_node(release, size, gfp, NUMA_NO_NODE);
631 extern void devres_for_each_res(struct device *dev, dr_release_t release,
632 dr_match_t match, void *match_data,
633 void (*fn)(struct device *, void *, void *),
635 extern void devres_free(void *res);
636 extern void devres_add(struct device *dev, void *res);
637 extern void *devres_find(struct device *dev, dr_release_t release,
638 dr_match_t match, void *match_data);
639 extern void *devres_get(struct device *dev, void *new_res,
640 dr_match_t match, void *match_data);
641 extern void *devres_remove(struct device *dev, dr_release_t release,
642 dr_match_t match, void *match_data);
643 extern int devres_destroy(struct device *dev, dr_release_t release,
644 dr_match_t match, void *match_data);
645 extern int devres_release(struct device *dev, dr_release_t release,
646 dr_match_t match, void *match_data);
649 extern void * __must_check devres_open_group(struct device *dev, void *id,
651 extern void devres_close_group(struct device *dev, void *id);
652 extern void devres_remove_group(struct device *dev, void *id);
653 extern int devres_release_group(struct device *dev, void *id);
655 /* managed devm_k.alloc/kfree for device drivers */
656 extern void *devm_kmalloc(struct device *dev, size_t size, gfp_t gfp) __malloc;
657 extern __printf(3, 0)
658 char *devm_kvasprintf(struct device *dev, gfp_t gfp, const char *fmt,
659 va_list ap) __malloc;
660 extern __printf(3, 4)
661 char *devm_kasprintf(struct device *dev, gfp_t gfp, const char *fmt, ...) __malloc;
662 static inline void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp)
664 return devm_kmalloc(dev, size, gfp | __GFP_ZERO);
666 static inline void *devm_kmalloc_array(struct device *dev,
667 size_t n, size_t size, gfp_t flags)
669 if (size != 0 && n > SIZE_MAX / size)
671 return devm_kmalloc(dev, n * size, flags);
673 static inline void *devm_kcalloc(struct device *dev,
674 size_t n, size_t size, gfp_t flags)
676 return devm_kmalloc_array(dev, n, size, flags | __GFP_ZERO);
678 extern void devm_kfree(struct device *dev, void *p);
679 extern char *devm_kstrdup(struct device *dev, const char *s, gfp_t gfp) __malloc;
680 extern void *devm_kmemdup(struct device *dev, const void *src, size_t len,
683 extern unsigned long devm_get_free_pages(struct device *dev,
684 gfp_t gfp_mask, unsigned int order);
685 extern void devm_free_pages(struct device *dev, unsigned long addr);
687 void __iomem *devm_ioremap_resource(struct device *dev, struct resource *res);
689 /* allows to add/remove a custom action to devres stack */
690 int devm_add_action(struct device *dev, void (*action)(void *), void *data);
691 void devm_remove_action(struct device *dev, void (*action)(void *), void *data);
693 static inline int devm_add_action_or_reset(struct device *dev,
694 void (*action)(void *), void *data)
698 ret = devm_add_action(dev, action, data);
705 struct device_dma_parameters {
707 * a low level driver may set these to teach IOMMU code about
710 unsigned int max_segment_size;
711 unsigned long segment_boundary_mask;
715 * enum device_link_state - Device link states.
716 * @DL_STATE_NONE: The presence of the drivers is not being tracked.
717 * @DL_STATE_DORMANT: None of the supplier/consumer drivers is present.
718 * @DL_STATE_AVAILABLE: The supplier driver is present, but the consumer is not.
719 * @DL_STATE_CONSUMER_PROBE: The consumer is probing (supplier driver present).
720 * @DL_STATE_ACTIVE: Both the supplier and consumer drivers are present.
721 * @DL_STATE_SUPPLIER_UNBIND: The supplier driver is unbinding.
723 enum device_link_state {
725 DL_STATE_DORMANT = 0,
727 DL_STATE_CONSUMER_PROBE,
729 DL_STATE_SUPPLIER_UNBIND,
735 * STATELESS: The core won't track the presence of supplier/consumer drivers.
736 * AUTOREMOVE: Remove this link automatically on consumer driver unbind.
737 * PM_RUNTIME: If set, the runtime PM framework will use this link.
738 * RPM_ACTIVE: Run pm_runtime_get_sync() on the supplier during link creation.
740 #define DL_FLAG_STATELESS BIT(0)
741 #define DL_FLAG_AUTOREMOVE BIT(1)
742 #define DL_FLAG_PM_RUNTIME BIT(2)
743 #define DL_FLAG_RPM_ACTIVE BIT(3)
746 * struct device_link - Device link representation.
747 * @supplier: The device on the supplier end of the link.
748 * @s_node: Hook to the supplier device's list of links to consumers.
749 * @consumer: The device on the consumer end of the link.
750 * @c_node: Hook to the consumer device's list of links to suppliers.
751 * @status: The state of the link (with respect to the presence of drivers).
752 * @flags: Link flags.
753 * @rpm_active: Whether or not the consumer device is runtime-PM-active.
754 * @rcu_head: An RCU head to use for deferred execution of SRCU callbacks.
757 struct device *supplier;
758 struct list_head s_node;
759 struct device *consumer;
760 struct list_head c_node;
761 enum device_link_state status;
765 struct rcu_head rcu_head;
770 * enum dl_dev_state - Device driver presence tracking information.
771 * @DL_DEV_NO_DRIVER: There is no driver attached to the device.
772 * @DL_DEV_PROBING: A driver is probing.
773 * @DL_DEV_DRIVER_BOUND: The driver has been bound to the device.
774 * @DL_DEV_UNBINDING: The driver is unbinding from the device.
777 DL_DEV_NO_DRIVER = 0,
784 * struct dev_links_info - Device data related to device links.
785 * @suppliers: List of links to supplier devices.
786 * @consumers: List of links to consumer devices.
787 * @status: Driver status information.
789 struct dev_links_info {
790 struct list_head suppliers;
791 struct list_head consumers;
792 enum dl_dev_state status;
796 * struct device - The basic device structure
797 * @parent: The device's "parent" device, the device to which it is attached.
798 * In most cases, a parent device is some sort of bus or host
799 * controller. If parent is NULL, the device, is a top-level device,
800 * which is not usually what you want.
801 * @p: Holds the private data of the driver core portions of the device.
802 * See the comment of the struct device_private for detail.
803 * @kobj: A top-level, abstract class from which other classes are derived.
804 * @init_name: Initial name of the device.
805 * @type: The type of device.
806 * This identifies the device type and carries type-specific
808 * @mutex: Mutex to synchronize calls to its driver.
809 * @bus: Type of bus device is on.
810 * @driver: Which driver has allocated this
811 * @platform_data: Platform data specific to the device.
812 * Example: For devices on custom boards, as typical of embedded
813 * and SOC based hardware, Linux often uses platform_data to point
814 * to board-specific structures describing devices and how they
815 * are wired. That can include what ports are available, chip
816 * variants, which GPIO pins act in what additional roles, and so
817 * on. This shrinks the "Board Support Packages" (BSPs) and
818 * minimizes board-specific #ifdefs in drivers.
819 * @driver_data: Private pointer for driver specific info.
820 * @power: For device power management.
821 * See Documentation/power/devices.txt for details.
822 * @pm_domain: Provide callbacks that are executed during system suspend,
823 * hibernation, system resume and during runtime PM transitions
824 * along with subsystem-level and driver-level callbacks.
825 * @pins: For device pin management.
826 * See Documentation/pinctrl.txt for details.
827 * @msi_list: Hosts MSI descriptors
828 * @msi_domain: The generic MSI domain this device is using.
829 * @numa_node: NUMA node this device is close to.
830 * @dma_mask: Dma mask (if dma'ble device).
831 * @coherent_dma_mask: Like dma_mask, but for alloc_coherent mapping as not all
832 * hardware supports 64-bit addresses for consistent allocations
834 * @dma_pfn_offset: offset of DMA memory range relatively of RAM
835 * @dma_parms: A low level driver may set these to teach IOMMU code about
836 * segment limitations.
837 * @dma_pools: Dma pools (if dma'ble device).
838 * @dma_mem: Internal for coherent mem override.
839 * @cma_area: Contiguous memory area for dma allocations
840 * @archdata: For arch-specific additions.
841 * @of_node: Associated device tree node.
842 * @fwnode: Associated device node supplied by platform firmware.
843 * @devt: For creating the sysfs "dev".
844 * @id: device instance
845 * @devres_lock: Spinlock to protect the resource of the device.
846 * @devres_head: The resources list of the device.
847 * @knode_class: The node used to add the device to the class list.
848 * @class: The class of the device.
849 * @groups: Optional attribute groups.
850 * @release: Callback to free the device after all references have
851 * gone away. This should be set by the allocator of the
852 * device (i.e. the bus driver that discovered the device).
853 * @iommu_group: IOMMU group the device belongs to.
854 * @iommu_fwspec: IOMMU-specific properties supplied by firmware.
856 * @offline_disabled: If set, the device is permanently online.
857 * @offline: Set after successful invocation of bus type's .offline().
859 * At the lowest level, every device in a Linux system is represented by an
860 * instance of struct device. The device structure contains the information
861 * that the device model core needs to model the system. Most subsystems,
862 * however, track additional information about the devices they host. As a
863 * result, it is rare for devices to be represented by bare device structures;
864 * instead, that structure, like kobject structures, is usually embedded within
865 * a higher-level representation of the device.
868 struct device *parent;
870 struct device_private *p;
873 const char *init_name; /* initial name of the device */
874 const struct device_type *type;
876 struct mutex mutex; /* mutex to synchronize calls to
880 struct bus_type *bus; /* type of bus device is on */
881 struct device_driver *driver; /* which driver has allocated this
883 void *platform_data; /* Platform specific data, device
884 core doesn't touch it */
885 void *driver_data; /* Driver data, set and get with
886 dev_set/get_drvdata */
887 struct dev_links_info links;
888 struct dev_pm_info power;
889 struct dev_pm_domain *pm_domain;
891 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
892 struct irq_domain *msi_domain;
894 #ifdef CONFIG_PINCTRL
895 struct dev_pin_info *pins;
897 #ifdef CONFIG_GENERIC_MSI_IRQ
898 struct list_head msi_list;
902 int numa_node; /* NUMA node this device is close to */
904 u64 *dma_mask; /* dma mask (if dma'able device) */
905 u64 coherent_dma_mask;/* Like dma_mask, but for
906 alloc_coherent mappings as
907 not all hardware supports
908 64 bit addresses for consistent
909 allocations such descriptors. */
910 unsigned long dma_pfn_offset;
912 struct device_dma_parameters *dma_parms;
914 struct list_head dma_pools; /* dma pools (if dma'ble) */
916 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
918 #ifdef CONFIG_DMA_CMA
919 struct cma *cma_area; /* contiguous memory area for dma
922 /* arch specific additions */
923 struct dev_archdata archdata;
925 struct device_node *of_node; /* associated device tree node */
926 struct fwnode_handle *fwnode; /* firmware device node */
928 dev_t devt; /* dev_t, creates the sysfs "dev" */
929 u32 id; /* device instance */
931 spinlock_t devres_lock;
932 struct list_head devres_head;
934 struct klist_node knode_class;
936 const struct attribute_group **groups; /* optional groups */
938 void (*release)(struct device *dev);
939 struct iommu_group *iommu_group;
940 struct iommu_fwspec *iommu_fwspec;
942 bool offline_disabled:1;
946 static inline struct device *kobj_to_dev(struct kobject *kobj)
948 return container_of(kobj, struct device, kobj);
951 /* Get the wakeup routines, which depend on struct device */
952 #include <linux/pm_wakeup.h>
954 static inline const char *dev_name(const struct device *dev)
956 /* Use the init name until the kobject becomes available */
958 return dev->init_name;
960 return kobject_name(&dev->kobj);
963 extern __printf(2, 3)
964 int dev_set_name(struct device *dev, const char *name, ...);
967 static inline int dev_to_node(struct device *dev)
969 return dev->numa_node;
971 static inline void set_dev_node(struct device *dev, int node)
973 dev->numa_node = node;
976 static inline int dev_to_node(struct device *dev)
980 static inline void set_dev_node(struct device *dev, int node)
985 static inline struct irq_domain *dev_get_msi_domain(const struct device *dev)
987 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
988 return dev->msi_domain;
994 static inline void dev_set_msi_domain(struct device *dev, struct irq_domain *d)
996 #ifdef CONFIG_GENERIC_MSI_IRQ_DOMAIN
1001 static inline void *dev_get_drvdata(const struct device *dev)
1003 return dev->driver_data;
1006 static inline void dev_set_drvdata(struct device *dev, void *data)
1008 dev->driver_data = data;
1011 static inline struct pm_subsys_data *dev_to_psd(struct device *dev)
1013 return dev ? dev->power.subsys_data : NULL;
1016 static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
1018 return dev->kobj.uevent_suppress;
1021 static inline void dev_set_uevent_suppress(struct device *dev, int val)
1023 dev->kobj.uevent_suppress = val;
1026 static inline int device_is_registered(struct device *dev)
1028 return dev->kobj.state_in_sysfs;
1031 static inline void device_enable_async_suspend(struct device *dev)
1033 if (!dev->power.is_prepared)
1034 dev->power.async_suspend = true;
1037 static inline void device_disable_async_suspend(struct device *dev)
1039 if (!dev->power.is_prepared)
1040 dev->power.async_suspend = false;
1043 static inline bool device_async_suspend_enabled(struct device *dev)
1045 return !!dev->power.async_suspend;
1048 static inline void dev_pm_syscore_device(struct device *dev, bool val)
1050 #ifdef CONFIG_PM_SLEEP
1051 dev->power.syscore = val;
1055 static inline void device_lock(struct device *dev)
1057 mutex_lock(&dev->mutex);
1060 static inline int device_lock_interruptible(struct device *dev)
1062 return mutex_lock_interruptible(&dev->mutex);
1065 static inline int device_trylock(struct device *dev)
1067 return mutex_trylock(&dev->mutex);
1070 static inline void device_unlock(struct device *dev)
1072 mutex_unlock(&dev->mutex);
1075 static inline void device_lock_assert(struct device *dev)
1077 lockdep_assert_held(&dev->mutex);
1080 static inline struct device_node *dev_of_node(struct device *dev)
1082 if (!IS_ENABLED(CONFIG_OF))
1084 return dev->of_node;
1087 void driver_init(void);
1090 * High level routines for use by the bus drivers
1092 extern int __must_check device_register(struct device *dev);
1093 extern void device_unregister(struct device *dev);
1094 extern void device_initialize(struct device *dev);
1095 extern int __must_check device_add(struct device *dev);
1096 extern void device_del(struct device *dev);
1097 extern int device_for_each_child(struct device *dev, void *data,
1098 int (*fn)(struct device *dev, void *data));
1099 extern int device_for_each_child_reverse(struct device *dev, void *data,
1100 int (*fn)(struct device *dev, void *data));
1101 extern struct device *device_find_child(struct device *dev, void *data,
1102 int (*match)(struct device *dev, void *data));
1103 extern int device_rename(struct device *dev, const char *new_name);
1104 extern int device_move(struct device *dev, struct device *new_parent,
1105 enum dpm_order dpm_order);
1106 extern const char *device_get_devnode(struct device *dev,
1107 umode_t *mode, kuid_t *uid, kgid_t *gid,
1110 static inline bool device_supports_offline(struct device *dev)
1112 return dev->bus && dev->bus->offline && dev->bus->online;
1115 extern void lock_device_hotplug(void);
1116 extern void unlock_device_hotplug(void);
1117 extern int lock_device_hotplug_sysfs(void);
1118 extern int device_offline(struct device *dev);
1119 extern int device_online(struct device *dev);
1120 extern void set_primary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1121 extern void set_secondary_fwnode(struct device *dev, struct fwnode_handle *fwnode);
1124 * Root device objects for grouping under /sys/devices
1126 extern struct device *__root_device_register(const char *name,
1127 struct module *owner);
1129 /* This is a macro to avoid include problems with THIS_MODULE */
1130 #define root_device_register(name) \
1131 __root_device_register(name, THIS_MODULE)
1133 extern void root_device_unregister(struct device *root);
1135 static inline void *dev_get_platdata(const struct device *dev)
1137 return dev->platform_data;
1141 * Manual binding of a device to driver. See drivers/base/bus.c
1142 * for information on use.
1144 extern int __must_check device_bind_driver(struct device *dev);
1145 extern void device_release_driver(struct device *dev);
1146 extern int __must_check device_attach(struct device *dev);
1147 extern int __must_check driver_attach(struct device_driver *drv);
1148 extern void device_initial_probe(struct device *dev);
1149 extern int __must_check device_reprobe(struct device *dev);
1151 extern bool device_is_bound(struct device *dev);
1154 * Easy functions for dynamically creating devices on the fly
1156 extern __printf(5, 0)
1157 struct device *device_create_vargs(struct class *cls, struct device *parent,
1158 dev_t devt, void *drvdata,
1159 const char *fmt, va_list vargs);
1160 extern __printf(5, 6)
1161 struct device *device_create(struct class *cls, struct device *parent,
1162 dev_t devt, void *drvdata,
1163 const char *fmt, ...);
1164 extern __printf(6, 7)
1165 struct device *device_create_with_groups(struct class *cls,
1166 struct device *parent, dev_t devt, void *drvdata,
1167 const struct attribute_group **groups,
1168 const char *fmt, ...);
1169 extern void device_destroy(struct class *cls, dev_t devt);
1172 * Platform "fixup" functions - allow the platform to have their say
1173 * about devices and actions that the general device layer doesn't
1176 /* Notify platform of device discovery */
1177 extern int (*platform_notify)(struct device *dev);
1179 extern int (*platform_notify_remove)(struct device *dev);
1183 * get_device - atomically increment the reference count for the device.
1186 extern struct device *get_device(struct device *dev);
1187 extern void put_device(struct device *dev);
1189 #ifdef CONFIG_DEVTMPFS
1190 extern int devtmpfs_create_node(struct device *dev);
1191 extern int devtmpfs_delete_node(struct device *dev);
1192 extern int devtmpfs_mount(const char *mntdir);
1194 static inline int devtmpfs_create_node(struct device *dev) { return 0; }
1195 static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
1196 static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
1199 /* drivers/base/power/shutdown.c */
1200 extern void device_shutdown(void);
1202 /* debugging and troubleshooting/diagnostic helpers. */
1203 extern const char *dev_driver_string(const struct device *dev);
1205 /* Device links interface. */
1206 struct device_link *device_link_add(struct device *consumer,
1207 struct device *supplier, u32 flags);
1208 void device_link_del(struct device_link *link);
1210 #ifdef CONFIG_PRINTK
1212 extern __printf(3, 0)
1213 int dev_vprintk_emit(int level, const struct device *dev,
1214 const char *fmt, va_list args);
1215 extern __printf(3, 4)
1216 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...);
1218 extern __printf(3, 4)
1219 void dev_printk(const char *level, const struct device *dev,
1220 const char *fmt, ...);
1221 extern __printf(2, 3)
1222 void dev_emerg(const struct device *dev, const char *fmt, ...);
1223 extern __printf(2, 3)
1224 void dev_alert(const struct device *dev, const char *fmt, ...);
1225 extern __printf(2, 3)
1226 void dev_crit(const struct device *dev, const char *fmt, ...);
1227 extern __printf(2, 3)
1228 void dev_err(const struct device *dev, const char *fmt, ...);
1229 extern __printf(2, 3)
1230 void dev_warn(const struct device *dev, const char *fmt, ...);
1231 extern __printf(2, 3)
1232 void dev_notice(const struct device *dev, const char *fmt, ...);
1233 extern __printf(2, 3)
1234 void _dev_info(const struct device *dev, const char *fmt, ...);
1238 static inline __printf(3, 0)
1239 int dev_vprintk_emit(int level, const struct device *dev,
1240 const char *fmt, va_list args)
1242 static inline __printf(3, 4)
1243 int dev_printk_emit(int level, const struct device *dev, const char *fmt, ...)
1246 static inline void __dev_printk(const char *level, const struct device *dev,
1247 struct va_format *vaf)
1249 static inline __printf(3, 4)
1250 void dev_printk(const char *level, const struct device *dev,
1251 const char *fmt, ...)
1254 static inline __printf(2, 3)
1255 void dev_emerg(const struct device *dev, const char *fmt, ...)
1257 static inline __printf(2, 3)
1258 void dev_crit(const struct device *dev, const char *fmt, ...)
1260 static inline __printf(2, 3)
1261 void dev_alert(const struct device *dev, const char *fmt, ...)
1263 static inline __printf(2, 3)
1264 void dev_err(const struct device *dev, const char *fmt, ...)
1266 static inline __printf(2, 3)
1267 void dev_warn(const struct device *dev, const char *fmt, ...)
1269 static inline __printf(2, 3)
1270 void dev_notice(const struct device *dev, const char *fmt, ...)
1272 static inline __printf(2, 3)
1273 void _dev_info(const struct device *dev, const char *fmt, ...)
1279 * Stupid hackaround for existing uses of non-printk uses dev_info
1281 * Note that the definition of dev_info below is actually _dev_info
1282 * and a macro is used to avoid redefining dev_info
1285 #define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
1287 #if defined(CONFIG_DYNAMIC_DEBUG)
1288 #define dev_dbg(dev, format, ...) \
1290 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
1292 #elif defined(DEBUG)
1293 #define dev_dbg(dev, format, arg...) \
1294 dev_printk(KERN_DEBUG, dev, format, ##arg)
1296 #define dev_dbg(dev, format, arg...) \
1299 dev_printk(KERN_DEBUG, dev, format, ##arg); \
1303 #ifdef CONFIG_PRINTK
1304 #define dev_level_once(dev_level, dev, fmt, ...) \
1306 static bool __print_once __read_mostly; \
1308 if (!__print_once) { \
1309 __print_once = true; \
1310 dev_level(dev, fmt, ##__VA_ARGS__); \
1314 #define dev_level_once(dev_level, dev, fmt, ...) \
1317 dev_level(dev, fmt, ##__VA_ARGS__); \
1321 #define dev_emerg_once(dev, fmt, ...) \
1322 dev_level_once(dev_emerg, dev, fmt, ##__VA_ARGS__)
1323 #define dev_alert_once(dev, fmt, ...) \
1324 dev_level_once(dev_alert, dev, fmt, ##__VA_ARGS__)
1325 #define dev_crit_once(dev, fmt, ...) \
1326 dev_level_once(dev_crit, dev, fmt, ##__VA_ARGS__)
1327 #define dev_err_once(dev, fmt, ...) \
1328 dev_level_once(dev_err, dev, fmt, ##__VA_ARGS__)
1329 #define dev_warn_once(dev, fmt, ...) \
1330 dev_level_once(dev_warn, dev, fmt, ##__VA_ARGS__)
1331 #define dev_notice_once(dev, fmt, ...) \
1332 dev_level_once(dev_notice, dev, fmt, ##__VA_ARGS__)
1333 #define dev_info_once(dev, fmt, ...) \
1334 dev_level_once(dev_info, dev, fmt, ##__VA_ARGS__)
1335 #define dev_dbg_once(dev, fmt, ...) \
1336 dev_level_once(dev_dbg, dev, fmt, ##__VA_ARGS__)
1338 #define dev_level_ratelimited(dev_level, dev, fmt, ...) \
1340 static DEFINE_RATELIMIT_STATE(_rs, \
1341 DEFAULT_RATELIMIT_INTERVAL, \
1342 DEFAULT_RATELIMIT_BURST); \
1343 if (__ratelimit(&_rs)) \
1344 dev_level(dev, fmt, ##__VA_ARGS__); \
1347 #define dev_emerg_ratelimited(dev, fmt, ...) \
1348 dev_level_ratelimited(dev_emerg, dev, fmt, ##__VA_ARGS__)
1349 #define dev_alert_ratelimited(dev, fmt, ...) \
1350 dev_level_ratelimited(dev_alert, dev, fmt, ##__VA_ARGS__)
1351 #define dev_crit_ratelimited(dev, fmt, ...) \
1352 dev_level_ratelimited(dev_crit, dev, fmt, ##__VA_ARGS__)
1353 #define dev_err_ratelimited(dev, fmt, ...) \
1354 dev_level_ratelimited(dev_err, dev, fmt, ##__VA_ARGS__)
1355 #define dev_warn_ratelimited(dev, fmt, ...) \
1356 dev_level_ratelimited(dev_warn, dev, fmt, ##__VA_ARGS__)
1357 #define dev_notice_ratelimited(dev, fmt, ...) \
1358 dev_level_ratelimited(dev_notice, dev, fmt, ##__VA_ARGS__)
1359 #define dev_info_ratelimited(dev, fmt, ...) \
1360 dev_level_ratelimited(dev_info, dev, fmt, ##__VA_ARGS__)
1361 #if defined(CONFIG_DYNAMIC_DEBUG)
1362 /* descriptor check is first to prevent flooding with "callbacks suppressed" */
1363 #define dev_dbg_ratelimited(dev, fmt, ...) \
1365 static DEFINE_RATELIMIT_STATE(_rs, \
1366 DEFAULT_RATELIMIT_INTERVAL, \
1367 DEFAULT_RATELIMIT_BURST); \
1368 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
1369 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT) && \
1370 __ratelimit(&_rs)) \
1371 __dynamic_dev_dbg(&descriptor, dev, fmt, \
1374 #elif defined(DEBUG)
1375 #define dev_dbg_ratelimited(dev, fmt, ...) \
1377 static DEFINE_RATELIMIT_STATE(_rs, \
1378 DEFAULT_RATELIMIT_INTERVAL, \
1379 DEFAULT_RATELIMIT_BURST); \
1380 if (__ratelimit(&_rs)) \
1381 dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); \
1384 #define dev_dbg_ratelimited(dev, fmt, ...) \
1387 dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); \
1391 #ifdef VERBOSE_DEBUG
1392 #define dev_vdbg dev_dbg
1394 #define dev_vdbg(dev, format, arg...) \
1397 dev_printk(KERN_DEBUG, dev, format, ##arg); \
1402 * dev_WARN*() acts like dev_printk(), but with the key difference of
1403 * using WARN/WARN_ONCE to include file/line information and a backtrace.
1405 #define dev_WARN(dev, format, arg...) \
1406 WARN(1, "%s %s: " format, dev_driver_string(dev), dev_name(dev), ## arg);
1408 #define dev_WARN_ONCE(dev, condition, format, arg...) \
1409 WARN_ONCE(condition, "%s %s: " format, \
1410 dev_driver_string(dev), dev_name(dev), ## arg)
1412 /* Create alias, so I can be autoloaded. */
1413 #define MODULE_ALIAS_CHARDEV(major,minor) \
1414 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
1415 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
1416 MODULE_ALIAS("char-major-" __stringify(major) "-*")
1418 #ifdef CONFIG_SYSFS_DEPRECATED
1419 extern long sysfs_deprecated;
1421 #define sysfs_deprecated 0
1425 * module_driver() - Helper macro for drivers that don't do anything
1426 * special in module init/exit. This eliminates a lot of boilerplate.
1427 * Each module may only use this macro once, and calling it replaces
1428 * module_init() and module_exit().
1430 * @__driver: driver name
1431 * @__register: register function for this driver type
1432 * @__unregister: unregister function for this driver type
1433 * @...: Additional arguments to be passed to __register and __unregister.
1435 * Use this macro to construct bus specific macros for registering
1436 * drivers, and do not use it on its own.
1438 #define module_driver(__driver, __register, __unregister, ...) \
1439 static int __init __driver##_init(void) \
1441 return __register(&(__driver) , ##__VA_ARGS__); \
1443 module_init(__driver##_init); \
1444 static void __exit __driver##_exit(void) \
1446 __unregister(&(__driver) , ##__VA_ARGS__); \
1448 module_exit(__driver##_exit);
1451 * builtin_driver() - Helper macro for drivers that don't do anything
1452 * special in init and have no exit. This eliminates some boilerplate.
1453 * Each driver may only use this macro once, and calling it replaces
1454 * device_initcall (or in some cases, the legacy __initcall). This is
1455 * meant to be a direct parallel of module_driver() above but without
1456 * the __exit stuff that is not used for builtin cases.
1458 * @__driver: driver name
1459 * @__register: register function for this driver type
1460 * @...: Additional arguments to be passed to __register
1462 * Use this macro to construct bus specific macros for registering
1463 * drivers, and do not use it on its own.
1465 #define builtin_driver(__driver, __register, ...) \
1466 static int __init __driver##_init(void) \
1468 return __register(&(__driver) , ##__VA_ARGS__); \
1470 device_initcall(__driver##_init);
1472 #endif /* _DEVICE_H_ */