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 <linux/semaphore.h>
26 #include <asm/atomic.h>
27 #include <asm/device.h>
30 struct device_private
;
32 struct driver_private
;
36 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 __must_check
bus_for_each_drv(struct bus_type
*bus
,
88 struct device_driver
*start
, void *data
,
89 int (*fn
)(struct device_driver
*, void *));
91 void bus_sort_breadthfirst(struct bus_type
*bus
,
92 int (*compare
)(const struct device
*a
,
93 const struct device
*b
));
95 * Bus notifiers: Get notified of addition/removal of devices
96 * and binding/unbinding of drivers to devices.
97 * In the long run, it should be a replacement for the platform
100 struct notifier_block
;
102 extern int bus_register_notifier(struct bus_type
*bus
,
103 struct notifier_block
*nb
);
104 extern int bus_unregister_notifier(struct bus_type
*bus
,
105 struct notifier_block
*nb
);
107 /* All 4 notifers below get called with the target struct device *
108 * as an argument. Note that those functions are likely to be called
109 * with the device lock held in the core, so be careful.
111 #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
112 #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */
113 #define BUS_NOTIFY_BOUND_DRIVER 0x00000003 /* driver bound to device */
114 #define BUS_NOTIFY_UNBIND_DRIVER 0x00000004 /* driver about to be
116 #define BUS_NOTIFY_UNBOUND_DRIVER 0x00000005 /* driver is unbound
119 extern struct kset
*bus_get_kset(struct bus_type
*bus
);
120 extern struct klist
*bus_get_device_klist(struct bus_type
*bus
);
122 struct device_driver
{
124 struct bus_type
*bus
;
126 struct module
*owner
;
127 const char *mod_name
; /* used for built-in modules */
129 bool suppress_bind_attrs
; /* disables bind/unbind via sysfs */
131 int (*probe
) (struct device
*dev
);
132 int (*remove
) (struct device
*dev
);
133 void (*shutdown
) (struct device
*dev
);
134 int (*suspend
) (struct device
*dev
, pm_message_t state
);
135 int (*resume
) (struct device
*dev
);
136 const struct attribute_group
**groups
;
138 const struct dev_pm_ops
*pm
;
140 struct driver_private
*p
;
144 extern int __must_check
driver_register(struct device_driver
*drv
);
145 extern void driver_unregister(struct device_driver
*drv
);
147 extern struct device_driver
*get_driver(struct device_driver
*drv
);
148 extern void put_driver(struct device_driver
*drv
);
149 extern struct device_driver
*driver_find(const char *name
,
150 struct bus_type
*bus
);
151 extern int driver_probe_done(void);
152 extern void wait_for_device_probe(void);
155 /* sysfs interface for exporting driver attributes */
157 struct driver_attribute
{
158 struct attribute attr
;
159 ssize_t (*show
)(struct device_driver
*driver
, char *buf
);
160 ssize_t (*store
)(struct device_driver
*driver
, const char *buf
,
164 #define DRIVER_ATTR(_name, _mode, _show, _store) \
165 struct driver_attribute driver_attr_##_name = \
166 __ATTR(_name, _mode, _show, _store)
168 extern int __must_check
driver_create_file(struct device_driver
*driver
,
169 const struct driver_attribute
*attr
);
170 extern void driver_remove_file(struct device_driver
*driver
,
171 const struct driver_attribute
*attr
);
173 extern int __must_check
driver_add_kobj(struct device_driver
*drv
,
174 struct kobject
*kobj
,
175 const char *fmt
, ...);
177 extern int __must_check
driver_for_each_device(struct device_driver
*drv
,
178 struct device
*start
,
180 int (*fn
)(struct device
*dev
,
182 struct device
*driver_find_device(struct device_driver
*drv
,
183 struct device
*start
, void *data
,
184 int (*match
)(struct device
*dev
, void *data
));
191 struct module
*owner
;
193 struct class_attribute
*class_attrs
;
194 struct device_attribute
*dev_attrs
;
195 struct kobject
*dev_kobj
;
197 int (*dev_uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
198 char *(*devnode
)(struct device
*dev
, mode_t
*mode
);
200 void (*class_release
)(struct class *class);
201 void (*dev_release
)(struct device
*dev
);
203 int (*suspend
)(struct device
*dev
, pm_message_t state
);
204 int (*resume
)(struct device
*dev
);
206 const struct dev_pm_ops
*pm
;
208 struct class_private
*p
;
211 struct class_dev_iter
{
212 struct klist_iter ki
;
213 const struct device_type
*type
;
216 extern struct kobject
*sysfs_dev_block_kobj
;
217 extern struct kobject
*sysfs_dev_char_kobj
;
218 extern int __must_check
__class_register(struct class *class,
219 struct lock_class_key
*key
);
220 extern void class_unregister(struct class *class);
222 /* This is a #define to keep the compiler from merging different
223 * instances of the __key variable */
224 #define class_register(class) \
226 static struct lock_class_key __key; \
227 __class_register(class, &__key); \
231 struct class_compat
*class_compat_register(const char *name
);
232 void class_compat_unregister(struct class_compat
*cls
);
233 int class_compat_create_link(struct class_compat
*cls
, struct device
*dev
,
234 struct device
*device_link
);
235 void class_compat_remove_link(struct class_compat
*cls
, struct device
*dev
,
236 struct device
*device_link
);
238 extern void class_dev_iter_init(struct class_dev_iter
*iter
,
240 struct device
*start
,
241 const struct device_type
*type
);
242 extern struct device
*class_dev_iter_next(struct class_dev_iter
*iter
);
243 extern void class_dev_iter_exit(struct class_dev_iter
*iter
);
245 extern int class_for_each_device(struct class *class, struct device
*start
,
247 int (*fn
)(struct device
*dev
, void *data
));
248 extern struct device
*class_find_device(struct class *class,
249 struct device
*start
, void *data
,
250 int (*match
)(struct device
*, void *));
252 struct class_attribute
{
253 struct attribute attr
;
254 ssize_t (*show
)(struct class *class, struct class_attribute
*attr
,
256 ssize_t (*store
)(struct class *class, struct class_attribute
*attr
,
257 const char *buf
, size_t count
);
260 #define CLASS_ATTR(_name, _mode, _show, _store) \
261 struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
263 extern int __must_check
class_create_file(struct class *class,
264 const struct class_attribute
*attr
);
265 extern void class_remove_file(struct class *class,
266 const struct class_attribute
*attr
);
268 /* Simple class attribute that is just a static string */
270 struct class_attribute_string
{
271 struct class_attribute attr
;
275 /* Currently read-only only */
276 #define _CLASS_ATTR_STRING(_name, _mode, _str) \
277 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
278 #define CLASS_ATTR_STRING(_name, _mode, _str) \
279 struct class_attribute_string class_attr_##_name = \
280 _CLASS_ATTR_STRING(_name, _mode, _str)
282 extern ssize_t
show_class_attr_string(struct class *class, struct class_attribute
*attr
,
285 struct class_interface
{
286 struct list_head node
;
289 int (*add_dev
) (struct device
*, struct class_interface
*);
290 void (*remove_dev
) (struct device
*, struct class_interface
*);
293 extern int __must_check
class_interface_register(struct class_interface
*);
294 extern void class_interface_unregister(struct class_interface
*);
296 extern struct class * __must_check
__class_create(struct module
*owner
,
298 struct lock_class_key
*key
);
299 extern void class_destroy(struct class *cls
);
301 /* This is a #define to keep the compiler from merging different
302 * instances of the __key variable */
303 #define class_create(owner, name) \
305 static struct lock_class_key __key; \
306 __class_create(owner, name, &__key); \
310 * The type of device, "struct device" is embedded in. A class
311 * or bus can contain devices of different types
312 * like "partitions" and "disks", "mouse" and "event".
313 * This identifies the device type and carries type-specific
314 * information, equivalent to the kobj_type of a kobject.
315 * If "name" is specified, the uevent will contain it in
316 * the DEVTYPE variable.
320 const struct attribute_group
**groups
;
321 int (*uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
322 char *(*devnode
)(struct device
*dev
, mode_t
*mode
);
323 void (*release
)(struct device
*dev
);
325 const struct dev_pm_ops
*pm
;
328 /* interface for exporting device attributes */
329 struct device_attribute
{
330 struct attribute attr
;
331 ssize_t (*show
)(struct device
*dev
, struct device_attribute
*attr
,
333 ssize_t (*store
)(struct device
*dev
, struct device_attribute
*attr
,
334 const char *buf
, size_t count
);
337 #define DEVICE_ATTR(_name, _mode, _show, _store) \
338 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
340 extern int __must_check
device_create_file(struct device
*device
,
341 const struct device_attribute
*entry
);
342 extern void device_remove_file(struct device
*dev
,
343 const struct device_attribute
*attr
);
344 extern int __must_check
device_create_bin_file(struct device
*dev
,
345 const struct bin_attribute
*attr
);
346 extern void device_remove_bin_file(struct device
*dev
,
347 const struct bin_attribute
*attr
);
348 extern int device_schedule_callback_owner(struct device
*dev
,
349 void (*func
)(struct device
*dev
), struct module
*owner
);
351 /* This is a macro to avoid include problems with THIS_MODULE */
352 #define device_schedule_callback(dev, func) \
353 device_schedule_callback_owner(dev, func, THIS_MODULE)
355 /* device resource management */
356 typedef void (*dr_release_t
)(struct device
*dev
, void *res
);
357 typedef int (*dr_match_t
)(struct device
*dev
, void *res
, void *match_data
);
359 #ifdef CONFIG_DEBUG_DEVRES
360 extern void *__devres_alloc(dr_release_t release
, size_t size
, gfp_t gfp
,
362 #define devres_alloc(release, size, gfp) \
363 __devres_alloc(release, size, gfp, #release)
365 extern void *devres_alloc(dr_release_t release
, size_t size
, gfp_t gfp
);
367 extern void devres_free(void *res
);
368 extern void devres_add(struct device
*dev
, void *res
);
369 extern void *devres_find(struct device
*dev
, dr_release_t release
,
370 dr_match_t match
, void *match_data
);
371 extern void *devres_get(struct device
*dev
, void *new_res
,
372 dr_match_t match
, void *match_data
);
373 extern void *devres_remove(struct device
*dev
, dr_release_t release
,
374 dr_match_t match
, void *match_data
);
375 extern int devres_destroy(struct device
*dev
, dr_release_t release
,
376 dr_match_t match
, void *match_data
);
379 extern void * __must_check
devres_open_group(struct device
*dev
, void *id
,
381 extern void devres_close_group(struct device
*dev
, void *id
);
382 extern void devres_remove_group(struct device
*dev
, void *id
);
383 extern int devres_release_group(struct device
*dev
, void *id
);
385 /* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
386 extern void *devm_kzalloc(struct device
*dev
, size_t size
, gfp_t gfp
);
387 extern void devm_kfree(struct device
*dev
, void *p
);
389 struct device_dma_parameters
{
391 * a low level driver may set these to teach IOMMU code about
394 unsigned int max_segment_size
;
395 unsigned long segment_boundary_mask
;
399 struct device
*parent
;
401 struct device_private
*p
;
404 const char *init_name
; /* initial name of the device */
405 struct device_type
*type
;
407 struct semaphore sem
; /* semaphore to synchronize calls to
411 struct bus_type
*bus
; /* type of bus device is on */
412 struct device_driver
*driver
; /* which driver has allocated this
414 void *platform_data
; /* Platform specific data, device
415 core doesn't touch it */
416 struct dev_pm_info power
;
419 int numa_node
; /* NUMA node this device is close to */
421 u64
*dma_mask
; /* dma mask (if dma'able device) */
422 u64 coherent_dma_mask
;/* Like dma_mask, but for
423 alloc_coherent mappings as
424 not all hardware supports
425 64 bit addresses for consistent
426 allocations such descriptors. */
428 struct device_dma_parameters
*dma_parms
;
430 struct list_head dma_pools
; /* dma pools (if dma'ble) */
432 struct dma_coherent_mem
*dma_mem
; /* internal for coherent mem
434 /* arch specific additions */
435 struct dev_archdata archdata
;
437 dev_t devt
; /* dev_t, creates the sysfs "dev" */
439 spinlock_t devres_lock
;
440 struct list_head devres_head
;
442 struct klist_node knode_class
;
444 const struct attribute_group
**groups
; /* optional groups */
446 void (*release
)(struct device
*dev
);
449 /* Get the wakeup routines, which depend on struct device */
450 #include <linux/pm_wakeup.h>
452 static inline const char *dev_name(const struct device
*dev
)
454 /* Use the init name until the kobject becomes available */
456 return dev
->init_name
;
458 return kobject_name(&dev
->kobj
);
461 extern int dev_set_name(struct device
*dev
, const char *name
, ...)
462 __attribute__((format(printf
, 2, 3)));
465 static inline int dev_to_node(struct device
*dev
)
467 return dev
->numa_node
;
469 static inline void set_dev_node(struct device
*dev
, int node
)
471 dev
->numa_node
= node
;
474 static inline int dev_to_node(struct device
*dev
)
478 static inline void set_dev_node(struct device
*dev
, int node
)
483 static inline unsigned int dev_get_uevent_suppress(const struct device
*dev
)
485 return dev
->kobj
.uevent_suppress
;
488 static inline void dev_set_uevent_suppress(struct device
*dev
, int val
)
490 dev
->kobj
.uevent_suppress
= val
;
493 static inline int device_is_registered(struct device
*dev
)
495 return dev
->kobj
.state_in_sysfs
;
498 static inline void device_enable_async_suspend(struct device
*dev
)
500 if (dev
->power
.status
== DPM_ON
)
501 dev
->power
.async_suspend
= true;
504 static inline void device_disable_async_suspend(struct device
*dev
)
506 if (dev
->power
.status
== DPM_ON
)
507 dev
->power
.async_suspend
= false;
510 static inline bool device_async_suspend_enabled(struct device
*dev
)
512 return !!dev
->power
.async_suspend
;
515 static inline void device_lock(struct device
*dev
)
520 static inline int device_trylock(struct device
*dev
)
522 return down_trylock(&dev
->sem
);
525 static inline void device_unlock(struct device
*dev
)
530 void driver_init(void);
533 * High level routines for use by the bus drivers
535 extern int __must_check
device_register(struct device
*dev
);
536 extern void device_unregister(struct device
*dev
);
537 extern void device_initialize(struct device
*dev
);
538 extern int __must_check
device_add(struct device
*dev
);
539 extern void device_del(struct device
*dev
);
540 extern int device_for_each_child(struct device
*dev
, void *data
,
541 int (*fn
)(struct device
*dev
, void *data
));
542 extern struct device
*device_find_child(struct device
*dev
, void *data
,
543 int (*match
)(struct device
*dev
, void *data
));
544 extern int device_rename(struct device
*dev
, char *new_name
);
545 extern int device_move(struct device
*dev
, struct device
*new_parent
,
546 enum dpm_order dpm_order
);
547 extern const char *device_get_devnode(struct device
*dev
,
548 mode_t
*mode
, const char **tmp
);
549 extern void *dev_get_drvdata(const struct device
*dev
);
550 extern void dev_set_drvdata(struct device
*dev
, void *data
);
553 * Root device objects for grouping under /sys/devices
555 extern struct device
*__root_device_register(const char *name
,
556 struct module
*owner
);
557 static inline struct device
*root_device_register(const char *name
)
559 return __root_device_register(name
, THIS_MODULE
);
561 extern void root_device_unregister(struct device
*root
);
563 static inline void *dev_get_platdata(const struct device
*dev
)
565 return dev
->platform_data
;
569 * Manual binding of a device to driver. See drivers/base/bus.c
570 * for information on use.
572 extern int __must_check
device_bind_driver(struct device
*dev
);
573 extern void device_release_driver(struct device
*dev
);
574 extern int __must_check
device_attach(struct device
*dev
);
575 extern int __must_check
driver_attach(struct device_driver
*drv
);
576 extern int __must_check
device_reprobe(struct device
*dev
);
579 * Easy functions for dynamically creating devices on the fly
581 extern struct device
*device_create_vargs(struct class *cls
,
582 struct device
*parent
,
587 extern struct device
*device_create(struct class *cls
, struct device
*parent
,
588 dev_t devt
, void *drvdata
,
589 const char *fmt
, ...)
590 __attribute__((format(printf
, 5, 6)));
591 extern void device_destroy(struct class *cls
, dev_t devt
);
594 * Platform "fixup" functions - allow the platform to have their say
595 * about devices and actions that the general device layer doesn't
598 /* Notify platform of device discovery */
599 extern int (*platform_notify
)(struct device
*dev
);
601 extern int (*platform_notify_remove
)(struct device
*dev
);
605 * get_device - atomically increment the reference count for the device.
608 extern struct device
*get_device(struct device
*dev
);
609 extern void put_device(struct device
*dev
);
611 extern void wait_for_device_probe(void);
613 #ifdef CONFIG_DEVTMPFS
614 extern int devtmpfs_create_node(struct device
*dev
);
615 extern int devtmpfs_delete_node(struct device
*dev
);
616 extern int devtmpfs_mount(const char *mntdir
);
618 static inline int devtmpfs_create_node(struct device
*dev
) { return 0; }
619 static inline int devtmpfs_delete_node(struct device
*dev
) { return 0; }
620 static inline int devtmpfs_mount(const char *mountpoint
) { return 0; }
623 /* drivers/base/power/shutdown.c */
624 extern void device_shutdown(void);
626 /* drivers/base/sys.c */
627 extern void sysdev_shutdown(void);
629 /* debugging and troubleshooting/diagnostic helpers. */
630 extern const char *dev_driver_string(const struct device
*dev
);
631 #define dev_printk(level, dev, format, arg...) \
632 printk(level "%s %s: " format , dev_driver_string(dev) , \
633 dev_name(dev) , ## arg)
635 #define dev_emerg(dev, format, arg...) \
636 dev_printk(KERN_EMERG , dev , format , ## arg)
637 #define dev_alert(dev, format, arg...) \
638 dev_printk(KERN_ALERT , dev , format , ## arg)
639 #define dev_crit(dev, format, arg...) \
640 dev_printk(KERN_CRIT , dev , format , ## arg)
641 #define dev_err(dev, format, arg...) \
642 dev_printk(KERN_ERR , dev , format , ## arg)
643 #define dev_warn(dev, format, arg...) \
644 dev_printk(KERN_WARNING , dev , format , ## arg)
645 #define dev_notice(dev, format, arg...) \
646 dev_printk(KERN_NOTICE , dev , format , ## arg)
647 #define dev_info(dev, format, arg...) \
648 dev_printk(KERN_INFO , dev , format , ## arg)
651 #define dev_dbg(dev, format, arg...) \
652 dev_printk(KERN_DEBUG , dev , format , ## arg)
653 #elif defined(CONFIG_DYNAMIC_DEBUG)
654 #define dev_dbg(dev, format, ...) do { \
655 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
658 #define dev_dbg(dev, format, arg...) \
659 ({ if (0) dev_printk(KERN_DEBUG, dev, format, ##arg); 0; })
663 #define dev_vdbg dev_dbg
666 #define dev_vdbg(dev, format, arg...) \
667 ({ if (0) dev_printk(KERN_DEBUG, dev, format, ##arg); 0; })
671 * dev_WARN() acts like dev_printk(), but with the key difference
672 * of using a WARN/WARN_ON to get the message out, including the
673 * file/line information and a backtrace.
675 #define dev_WARN(dev, format, arg...) \
676 WARN(1, "Device: %s\n" format, dev_driver_string(dev), ## arg);
678 /* Create alias, so I can be autoloaded. */
679 #define MODULE_ALIAS_CHARDEV(major,minor) \
680 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
681 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
682 MODULE_ALIAS("char-major-" __stringify(major) "-*")
683 #endif /* _DEVICE_H_ */