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/module.h>
25 #include <asm/atomic.h>
26 #include <asm/device.h>
29 struct device_private;
31 struct driver_private;
35 struct bus_type_private;
38 struct bus_attribute {
39 struct attribute attr;
40 ssize_t (*show)(struct bus_type *bus, char *buf);
41 ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
44 #define BUS_ATTR(_name, _mode, _show, _store) \
45 struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
47 extern int __must_check bus_create_file(struct bus_type *,
48 struct bus_attribute *);
49 extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
53 struct bus_attribute *bus_attrs;
54 struct device_attribute *dev_attrs;
55 struct driver_attribute *drv_attrs;
57 int (*match)(struct device *dev, struct device_driver *drv);
58 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
59 int (*probe)(struct device *dev);
60 int (*remove)(struct device *dev);
61 void (*shutdown)(struct device *dev);
63 int (*suspend)(struct device *dev, pm_message_t state);
64 int (*resume)(struct device *dev);
66 const struct dev_pm_ops *pm;
68 struct bus_type_private *p;
71 extern int __must_check bus_register(struct bus_type *bus);
72 extern void bus_unregister(struct bus_type *bus);
74 extern int __must_check bus_rescan_devices(struct bus_type *bus);
76 /* iterator helpers for buses */
78 int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
79 int (*fn)(struct device *dev, void *data));
80 struct device *bus_find_device(struct bus_type *bus, struct device *start,
82 int (*match)(struct device *dev, void *data));
83 struct device *bus_find_device_by_name(struct bus_type *bus,
87 int bus_for_each_drv(struct bus_type *bus, struct device_driver *start,
88 void *data, int (*fn)(struct device_driver *, void *));
90 void bus_sort_breadthfirst(struct bus_type *bus,
91 int (*compare)(const struct device *a,
92 const struct device *b));
94 * Bus notifiers: Get notified of addition/removal of devices
95 * and binding/unbinding of drivers to devices.
96 * In the long run, it should be a replacement for the platform
99 struct notifier_block;
101 extern int bus_register_notifier(struct bus_type *bus,
102 struct notifier_block *nb);
103 extern int bus_unregister_notifier(struct bus_type *bus,
104 struct notifier_block *nb);
106 /* All 4 notifers below get called with the target struct device *
107 * as an argument. Note that those functions are likely to be called
108 * with the device lock held in the core, so be careful.
110 #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
111 #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */
112 #define BUS_NOTIFY_BIND_DRIVER 0x00000003 /* driver about to be
114 #define BUS_NOTIFY_BOUND_DRIVER 0x00000004 /* driver bound to device */
115 #define BUS_NOTIFY_UNBIND_DRIVER 0x00000005 /* driver about to be
117 #define BUS_NOTIFY_UNBOUND_DRIVER 0x00000006 /* driver is unbound
120 extern struct kset *bus_get_kset(struct bus_type *bus);
121 extern struct klist *bus_get_device_klist(struct bus_type *bus);
123 struct device_driver {
125 struct bus_type *bus;
127 struct module *owner;
128 const char *mod_name; /* used for built-in modules */
130 bool suppress_bind_attrs; /* disables bind/unbind via sysfs */
132 #if defined(CONFIG_OF)
133 const struct of_device_id *of_match_table;
136 int (*probe) (struct device *dev);
137 int (*remove) (struct device *dev);
138 void (*shutdown) (struct device *dev);
139 int (*suspend) (struct device *dev, pm_message_t state);
140 int (*resume) (struct device *dev);
141 const struct attribute_group **groups;
143 const struct dev_pm_ops *pm;
145 struct driver_private *p;
149 extern int __must_check driver_register(struct device_driver *drv);
150 extern void driver_unregister(struct device_driver *drv);
152 extern struct device_driver *get_driver(struct device_driver *drv);
153 extern void put_driver(struct device_driver *drv);
154 extern struct device_driver *driver_find(const char *name,
155 struct bus_type *bus);
156 extern int driver_probe_done(void);
157 extern void wait_for_device_probe(void);
160 /* sysfs interface for exporting driver attributes */
162 struct driver_attribute {
163 struct attribute attr;
164 ssize_t (*show)(struct device_driver *driver, char *buf);
165 ssize_t (*store)(struct device_driver *driver, const char *buf,
169 #define DRIVER_ATTR(_name, _mode, _show, _store) \
170 struct driver_attribute driver_attr_##_name = \
171 __ATTR(_name, _mode, _show, _store)
173 extern int __must_check driver_create_file(struct device_driver *driver,
174 const struct driver_attribute *attr);
175 extern void driver_remove_file(struct device_driver *driver,
176 const struct driver_attribute *attr);
178 extern int __must_check driver_add_kobj(struct device_driver *drv,
179 struct kobject *kobj,
180 const char *fmt, ...);
182 extern int __must_check driver_for_each_device(struct device_driver *drv,
183 struct device *start,
185 int (*fn)(struct device *dev,
187 struct device *driver_find_device(struct device_driver *drv,
188 struct device *start, void *data,
189 int (*match)(struct device *dev, void *data));
196 struct module *owner;
198 struct class_attribute *class_attrs;
199 struct device_attribute *dev_attrs;
200 struct bin_attribute *dev_bin_attrs;
201 struct kobject *dev_kobj;
203 int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
204 char *(*devnode)(struct device *dev, mode_t *mode);
206 void (*class_release)(struct class *class);
207 void (*dev_release)(struct device *dev);
209 int (*suspend)(struct device *dev, pm_message_t state);
210 int (*resume)(struct device *dev);
212 const struct kobj_ns_type_operations *ns_type;
213 const void *(*namespace)(struct device *dev);
215 const struct dev_pm_ops *pm;
217 struct class_private *p;
220 struct class_dev_iter {
221 struct klist_iter ki;
222 const struct device_type *type;
225 extern struct kobject *sysfs_dev_block_kobj;
226 extern struct kobject *sysfs_dev_char_kobj;
227 extern int __must_check __class_register(struct class *class,
228 struct lock_class_key *key);
229 extern void class_unregister(struct class *class);
231 /* This is a #define to keep the compiler from merging different
232 * instances of the __key variable */
233 #define class_register(class) \
235 static struct lock_class_key __key; \
236 __class_register(class, &__key); \
240 struct class_compat *class_compat_register(const char *name);
241 void class_compat_unregister(struct class_compat *cls);
242 int class_compat_create_link(struct class_compat *cls, struct device *dev,
243 struct device *device_link);
244 void class_compat_remove_link(struct class_compat *cls, struct device *dev,
245 struct device *device_link);
247 extern void class_dev_iter_init(struct class_dev_iter *iter,
249 struct device *start,
250 const struct device_type *type);
251 extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
252 extern void class_dev_iter_exit(struct class_dev_iter *iter);
254 extern int class_for_each_device(struct class *class, struct device *start,
256 int (*fn)(struct device *dev, void *data));
257 extern struct device *class_find_device(struct class *class,
258 struct device *start, void *data,
259 int (*match)(struct device *, void *));
261 struct class_attribute {
262 struct attribute attr;
263 ssize_t (*show)(struct class *class, struct class_attribute *attr,
265 ssize_t (*store)(struct class *class, struct class_attribute *attr,
266 const char *buf, size_t count);
269 #define CLASS_ATTR(_name, _mode, _show, _store) \
270 struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
272 extern int __must_check class_create_file(struct class *class,
273 const struct class_attribute *attr);
274 extern void class_remove_file(struct class *class,
275 const struct class_attribute *attr);
277 /* Simple class attribute that is just a static string */
279 struct class_attribute_string {
280 struct class_attribute attr;
284 /* Currently read-only only */
285 #define _CLASS_ATTR_STRING(_name, _mode, _str) \
286 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
287 #define CLASS_ATTR_STRING(_name, _mode, _str) \
288 struct class_attribute_string class_attr_##_name = \
289 _CLASS_ATTR_STRING(_name, _mode, _str)
291 extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr,
294 struct class_interface {
295 struct list_head node;
298 int (*add_dev) (struct device *, struct class_interface *);
299 void (*remove_dev) (struct device *, struct class_interface *);
302 extern int __must_check class_interface_register(struct class_interface *);
303 extern void class_interface_unregister(struct class_interface *);
305 extern struct class * __must_check __class_create(struct module *owner,
307 struct lock_class_key *key);
308 extern void class_destroy(struct class *cls);
310 /* This is a #define to keep the compiler from merging different
311 * instances of the __key variable */
312 #define class_create(owner, name) \
314 static struct lock_class_key __key; \
315 __class_create(owner, name, &__key); \
319 * The type of device, "struct device" is embedded in. A class
320 * or bus can contain devices of different types
321 * like "partitions" and "disks", "mouse" and "event".
322 * This identifies the device type and carries type-specific
323 * information, equivalent to the kobj_type of a kobject.
324 * If "name" is specified, the uevent will contain it in
325 * the DEVTYPE variable.
329 const struct attribute_group **groups;
330 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
331 char *(*devnode)(struct device *dev, mode_t *mode);
332 void (*release)(struct device *dev);
334 const struct dev_pm_ops *pm;
337 /* interface for exporting device attributes */
338 struct device_attribute {
339 struct attribute attr;
340 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
342 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
343 const char *buf, size_t count);
346 #define DEVICE_ATTR(_name, _mode, _show, _store) \
347 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
349 extern int __must_check device_create_file(struct device *device,
350 const struct device_attribute *entry);
351 extern void device_remove_file(struct device *dev,
352 const struct device_attribute *attr);
353 extern int __must_check device_create_bin_file(struct device *dev,
354 const struct bin_attribute *attr);
355 extern void device_remove_bin_file(struct device *dev,
356 const struct bin_attribute *attr);
357 extern int device_schedule_callback_owner(struct device *dev,
358 void (*func)(struct device *dev), struct module *owner);
360 /* This is a macro to avoid include problems with THIS_MODULE */
361 #define device_schedule_callback(dev, func) \
362 device_schedule_callback_owner(dev, func, THIS_MODULE)
364 /* device resource management */
365 typedef void (*dr_release_t)(struct device *dev, void *res);
366 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
368 #ifdef CONFIG_DEBUG_DEVRES
369 extern void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
371 #define devres_alloc(release, size, gfp) \
372 __devres_alloc(release, size, gfp, #release)
374 extern void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
376 extern void devres_free(void *res);
377 extern void devres_add(struct device *dev, void *res);
378 extern void *devres_find(struct device *dev, dr_release_t release,
379 dr_match_t match, void *match_data);
380 extern void *devres_get(struct device *dev, void *new_res,
381 dr_match_t match, void *match_data);
382 extern void *devres_remove(struct device *dev, dr_release_t release,
383 dr_match_t match, void *match_data);
384 extern int devres_destroy(struct device *dev, dr_release_t release,
385 dr_match_t match, void *match_data);
388 extern void * __must_check devres_open_group(struct device *dev, void *id,
390 extern void devres_close_group(struct device *dev, void *id);
391 extern void devres_remove_group(struct device *dev, void *id);
392 extern int devres_release_group(struct device *dev, void *id);
394 /* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
395 extern void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp);
396 extern void devm_kfree(struct device *dev, void *p);
398 struct device_dma_parameters {
400 * a low level driver may set these to teach IOMMU code about
403 unsigned int max_segment_size;
404 unsigned long segment_boundary_mask;
408 struct device *parent;
410 struct device_private *p;
413 const char *init_name; /* initial name of the device */
414 struct device_type *type;
416 struct mutex mutex; /* mutex to synchronize calls to
420 struct bus_type *bus; /* type of bus device is on */
421 struct device_driver *driver; /* which driver has allocated this
423 void *platform_data; /* Platform specific data, device
424 core doesn't touch it */
425 struct dev_pm_info power;
428 int numa_node; /* NUMA node this device is close to */
430 u64 *dma_mask; /* dma mask (if dma'able device) */
431 u64 coherent_dma_mask;/* Like dma_mask, but for
432 alloc_coherent mappings as
433 not all hardware supports
434 64 bit addresses for consistent
435 allocations such descriptors. */
437 struct device_dma_parameters *dma_parms;
439 struct list_head dma_pools; /* dma pools (if dma'ble) */
441 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
443 /* arch specific additions */
444 struct dev_archdata archdata;
446 struct device_node *of_node;
449 dev_t devt; /* dev_t, creates the sysfs "dev" */
451 spinlock_t devres_lock;
452 struct list_head devres_head;
454 struct klist_node knode_class;
456 const struct attribute_group **groups; /* optional groups */
458 void (*release)(struct device *dev);
461 /* Get the wakeup routines, which depend on struct device */
462 #include <linux/pm_wakeup.h>
464 static inline const char *dev_name(const struct device *dev)
466 /* Use the init name until the kobject becomes available */
468 return dev->init_name;
470 return kobject_name(&dev->kobj);
473 extern int dev_set_name(struct device *dev, const char *name, ...)
474 __attribute__((format(printf, 2, 3)));
477 static inline int dev_to_node(struct device *dev)
479 return dev->numa_node;
481 static inline void set_dev_node(struct device *dev, int node)
483 dev->numa_node = node;
486 static inline int dev_to_node(struct device *dev)
490 static inline void set_dev_node(struct device *dev, int node)
495 static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
497 return dev->kobj.uevent_suppress;
500 static inline void dev_set_uevent_suppress(struct device *dev, int val)
502 dev->kobj.uevent_suppress = val;
505 static inline int device_is_registered(struct device *dev)
507 return dev->kobj.state_in_sysfs;
510 static inline void device_enable_async_suspend(struct device *dev)
512 if (!dev->power.in_suspend)
513 dev->power.async_suspend = true;
516 static inline void device_disable_async_suspend(struct device *dev)
518 if (!dev->power.in_suspend)
519 dev->power.async_suspend = false;
522 static inline bool device_async_suspend_enabled(struct device *dev)
524 return !!dev->power.async_suspend;
527 static inline void device_lock(struct device *dev)
529 mutex_lock(&dev->mutex);
532 static inline int device_trylock(struct device *dev)
534 return mutex_trylock(&dev->mutex);
537 static inline void device_unlock(struct device *dev)
539 mutex_unlock(&dev->mutex);
542 void driver_init(void);
545 * High level routines for use by the bus drivers
547 extern int __must_check device_register(struct device *dev);
548 extern void device_unregister(struct device *dev);
549 extern void device_initialize(struct device *dev);
550 extern int __must_check device_add(struct device *dev);
551 extern void device_del(struct device *dev);
552 extern int device_for_each_child(struct device *dev, void *data,
553 int (*fn)(struct device *dev, void *data));
554 extern struct device *device_find_child(struct device *dev, void *data,
555 int (*match)(struct device *dev, void *data));
556 extern int device_rename(struct device *dev, const char *new_name);
557 extern int device_move(struct device *dev, struct device *new_parent,
558 enum dpm_order dpm_order);
559 extern const char *device_get_devnode(struct device *dev,
560 mode_t *mode, const char **tmp);
561 extern void *dev_get_drvdata(const struct device *dev);
562 extern void dev_set_drvdata(struct device *dev, void *data);
565 * Root device objects for grouping under /sys/devices
567 extern struct device *__root_device_register(const char *name,
568 struct module *owner);
569 static inline struct device *root_device_register(const char *name)
571 return __root_device_register(name, THIS_MODULE);
573 extern void root_device_unregister(struct device *root);
575 static inline void *dev_get_platdata(const struct device *dev)
577 return dev->platform_data;
581 * Manual binding of a device to driver. See drivers/base/bus.c
582 * for information on use.
584 extern int __must_check device_bind_driver(struct device *dev);
585 extern void device_release_driver(struct device *dev);
586 extern int __must_check device_attach(struct device *dev);
587 extern int __must_check driver_attach(struct device_driver *drv);
588 extern int __must_check device_reprobe(struct device *dev);
591 * Easy functions for dynamically creating devices on the fly
593 extern struct device *device_create_vargs(struct class *cls,
594 struct device *parent,
599 extern struct device *device_create(struct class *cls, struct device *parent,
600 dev_t devt, void *drvdata,
601 const char *fmt, ...)
602 __attribute__((format(printf, 5, 6)));
603 extern void device_destroy(struct class *cls, dev_t devt);
606 * Platform "fixup" functions - allow the platform to have their say
607 * about devices and actions that the general device layer doesn't
610 /* Notify platform of device discovery */
611 extern int (*platform_notify)(struct device *dev);
613 extern int (*platform_notify_remove)(struct device *dev);
617 * get_device - atomically increment the reference count for the device.
620 extern struct device *get_device(struct device *dev);
621 extern void put_device(struct device *dev);
623 extern void wait_for_device_probe(void);
625 #ifdef CONFIG_DEVTMPFS
626 extern int devtmpfs_create_node(struct device *dev);
627 extern int devtmpfs_delete_node(struct device *dev);
628 extern int devtmpfs_mount(const char *mntdir);
630 static inline int devtmpfs_create_node(struct device *dev) { return 0; }
631 static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
632 static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
635 /* drivers/base/power/shutdown.c */
636 extern void device_shutdown(void);
638 /* drivers/base/sys.c */
639 extern void sysdev_shutdown(void);
641 /* debugging and troubleshooting/diagnostic helpers. */
642 extern const char *dev_driver_string(const struct device *dev);
647 extern int dev_printk(const char *level, const struct device *dev,
648 const char *fmt, ...)
649 __attribute__ ((format (printf, 3, 4)));
650 extern int dev_emerg(const struct device *dev, const char *fmt, ...)
651 __attribute__ ((format (printf, 2, 3)));
652 extern int dev_alert(const struct device *dev, const char *fmt, ...)
653 __attribute__ ((format (printf, 2, 3)));
654 extern int dev_crit(const struct device *dev, const char *fmt, ...)
655 __attribute__ ((format (printf, 2, 3)));
656 extern int dev_err(const struct device *dev, const char *fmt, ...)
657 __attribute__ ((format (printf, 2, 3)));
658 extern int dev_warn(const struct device *dev, const char *fmt, ...)
659 __attribute__ ((format (printf, 2, 3)));
660 extern int dev_notice(const struct device *dev, const char *fmt, ...)
661 __attribute__ ((format (printf, 2, 3)));
662 extern int _dev_info(const struct device *dev, const char *fmt, ...)
663 __attribute__ ((format (printf, 2, 3)));
667 static inline int dev_printk(const char *level, const struct device *dev,
668 const char *fmt, ...)
669 __attribute__ ((format (printf, 3, 4)));
670 static inline int dev_printk(const char *level, const struct device *dev,
671 const char *fmt, ...)
674 static inline int dev_emerg(const struct device *dev, const char *fmt, ...)
675 __attribute__ ((format (printf, 2, 3)));
676 static inline int dev_emerg(const struct device *dev, const char *fmt, ...)
678 static inline int dev_crit(const struct device *dev, const char *fmt, ...)
679 __attribute__ ((format (printf, 2, 3)));
680 static inline int dev_crit(const struct device *dev, const char *fmt, ...)
682 static inline int dev_alert(const struct device *dev, const char *fmt, ...)
683 __attribute__ ((format (printf, 2, 3)));
684 static inline int dev_alert(const struct device *dev, const char *fmt, ...)
686 static inline int dev_err(const struct device *dev, const char *fmt, ...)
687 __attribute__ ((format (printf, 2, 3)));
688 static inline int dev_err(const struct device *dev, const char *fmt, ...)
690 static inline int dev_warn(const struct device *dev, const char *fmt, ...)
691 __attribute__ ((format (printf, 2, 3)));
692 static inline int dev_warn(const struct device *dev, const char *fmt, ...)
694 static inline int dev_notice(const struct device *dev, const char *fmt, ...)
695 __attribute__ ((format (printf, 2, 3)));
696 static inline int dev_notice(const struct device *dev, const char *fmt, ...)
698 static inline int _dev_info(const struct device *dev, const char *fmt, ...)
699 __attribute__ ((format (printf, 2, 3)));
700 static inline int _dev_info(const struct device *dev, const char *fmt, ...)
706 * Stupid hackaround for existing uses of non-printk uses dev_info
708 * Note that the definition of dev_info below is actually _dev_info
709 * and a macro is used to avoid redefining dev_info
712 #define dev_info(dev, fmt, arg...) _dev_info(dev, fmt, ##arg)
715 #define dev_dbg(dev, format, arg...) \
716 dev_printk(KERN_DEBUG, dev, format, ##arg)
717 #elif defined(CONFIG_DYNAMIC_DEBUG)
718 #define dev_dbg(dev, format, ...) \
720 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
723 #define dev_dbg(dev, format, arg...) \
726 dev_printk(KERN_DEBUG, dev, format, ##arg); \
732 #define dev_vdbg dev_dbg
734 #define dev_vdbg(dev, format, arg...) \
737 dev_printk(KERN_DEBUG, dev, format, ##arg); \
743 * dev_WARN() acts like dev_printk(), but with the key difference
744 * of using a WARN/WARN_ON to get the message out, including the
745 * file/line information and a backtrace.
747 #define dev_WARN(dev, format, arg...) \
748 WARN(1, "Device: %s\n" format, dev_driver_string(dev), ## arg);
750 /* Create alias, so I can be autoloaded. */
751 #define MODULE_ALIAS_CHARDEV(major,minor) \
752 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
753 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
754 MODULE_ALIAS("char-major-" __stringify(major) "-*")
756 #ifdef CONFIG_SYSFS_DEPRECATED
757 extern long sysfs_deprecated;
759 #define sysfs_deprecated 0
762 #endif /* _DEVICE_H_ */