2 * device.h - generic, centralized driver model
4 * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
5 * Copyright (c) 2004-2007 Greg Kroah-Hartman <gregkh@suse.de>
7 * This file is released under the GPLv2
9 * See Documentation/driver-model/ for more information.
15 #include <linux/ioport.h>
16 #include <linux/kobject.h>
17 #include <linux/klist.h>
18 #include <linux/list.h>
19 #include <linux/lockdep.h>
20 #include <linux/compiler.h>
21 #include <linux/types.h>
22 #include <linux/module.h>
24 #include <linux/semaphore.h>
25 #include <asm/atomic.h>
26 #include <asm/device.h>
28 #define BUS_ID_SIZE 20
31 struct device_private;
33 struct driver_private;
37 struct bus_type_private;
39 struct bus_attribute {
40 struct attribute attr;
41 ssize_t (*show)(struct bus_type *bus, char *buf);
42 ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
45 #define BUS_ATTR(_name, _mode, _show, _store) \
46 struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
48 extern int __must_check bus_create_file(struct bus_type *,
49 struct bus_attribute *);
50 extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
54 struct bus_attribute *bus_attrs;
55 struct device_attribute *dev_attrs;
56 struct driver_attribute *drv_attrs;
58 int (*match)(struct device *dev, struct device_driver *drv);
59 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
60 int (*probe)(struct device *dev);
61 int (*remove)(struct device *dev);
62 void (*shutdown)(struct device *dev);
64 int (*suspend)(struct device *dev, pm_message_t state);
65 int (*suspend_late)(struct device *dev, pm_message_t state);
66 int (*resume_early)(struct device *dev);
67 int (*resume)(struct device *dev);
69 struct dev_pm_ops *pm;
71 struct bus_type_private *p;
74 extern int __must_check bus_register(struct bus_type *bus);
75 extern void bus_unregister(struct bus_type *bus);
77 extern int __must_check bus_rescan_devices(struct bus_type *bus);
79 /* iterator helpers for buses */
81 int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
82 int (*fn)(struct device *dev, void *data));
83 struct device *bus_find_device(struct bus_type *bus, struct device *start,
85 int (*match)(struct device *dev, void *data));
86 struct device *bus_find_device_by_name(struct bus_type *bus,
90 int __must_check bus_for_each_drv(struct bus_type *bus,
91 struct device_driver *start, void *data,
92 int (*fn)(struct device_driver *, void *));
94 void bus_sort_breadthfirst(struct bus_type *bus,
95 int (*compare)(const struct device *a,
96 const struct device *b));
98 * Bus notifiers: Get notified of addition/removal of devices
99 * and binding/unbinding of drivers to devices.
100 * In the long run, it should be a replacement for the platform
103 struct notifier_block;
105 extern int bus_register_notifier(struct bus_type *bus,
106 struct notifier_block *nb);
107 extern int bus_unregister_notifier(struct bus_type *bus,
108 struct notifier_block *nb);
110 /* All 4 notifers below get called with the target struct device *
111 * as an argument. Note that those functions are likely to be called
112 * with the device semaphore held in the core, so be careful.
114 #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
115 #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */
116 #define BUS_NOTIFY_BOUND_DRIVER 0x00000003 /* driver bound to device */
117 #define BUS_NOTIFY_UNBIND_DRIVER 0x00000004 /* driver about to be
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 int (*probe) (struct device *dev);
131 int (*remove) (struct device *dev);
132 void (*shutdown) (struct device *dev);
133 int (*suspend) (struct device *dev, pm_message_t state);
134 int (*resume) (struct device *dev);
135 struct attribute_group **groups;
137 struct dev_pm_ops *pm;
139 struct driver_private *p;
143 extern int __must_check driver_register(struct device_driver *drv);
144 extern void driver_unregister(struct device_driver *drv);
146 extern struct device_driver *get_driver(struct device_driver *drv);
147 extern void put_driver(struct device_driver *drv);
148 extern struct device_driver *driver_find(const char *name,
149 struct bus_type *bus);
150 extern int driver_probe_done(void);
151 extern void wait_for_device_probe(void);
154 /* sysfs interface for exporting driver attributes */
156 struct driver_attribute {
157 struct attribute attr;
158 ssize_t (*show)(struct device_driver *driver, char *buf);
159 ssize_t (*store)(struct device_driver *driver, const char *buf,
163 #define DRIVER_ATTR(_name, _mode, _show, _store) \
164 struct driver_attribute driver_attr_##_name = \
165 __ATTR(_name, _mode, _show, _store)
167 extern int __must_check driver_create_file(struct device_driver *driver,
168 struct driver_attribute *attr);
169 extern void driver_remove_file(struct device_driver *driver,
170 struct driver_attribute *attr);
172 extern int __must_check driver_add_kobj(struct device_driver *drv,
173 struct kobject *kobj,
174 const char *fmt, ...);
176 extern int __must_check driver_for_each_device(struct device_driver *drv,
177 struct device *start,
179 int (*fn)(struct device *dev,
181 struct device *driver_find_device(struct device_driver *drv,
182 struct device *start, void *data,
183 int (*match)(struct device *dev, void *data));
190 struct module *owner;
192 struct class_attribute *class_attrs;
193 struct device_attribute *dev_attrs;
194 struct kobject *dev_kobj;
196 int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
198 void (*class_release)(struct class *class);
199 void (*dev_release)(struct device *dev);
201 int (*suspend)(struct device *dev, pm_message_t state);
202 int (*resume)(struct device *dev);
204 struct dev_pm_ops *pm;
205 struct class_private *p;
208 struct class_dev_iter {
209 struct klist_iter ki;
210 const struct device_type *type;
213 extern struct kobject *sysfs_dev_block_kobj;
214 extern struct kobject *sysfs_dev_char_kobj;
215 extern int __must_check __class_register(struct class *class,
216 struct lock_class_key *key);
217 extern void class_unregister(struct class *class);
219 /* This is a #define to keep the compiler from merging different
220 * instances of the __key variable */
221 #define class_register(class) \
223 static struct lock_class_key __key; \
224 __class_register(class, &__key); \
227 extern void class_dev_iter_init(struct class_dev_iter *iter,
229 struct device *start,
230 const struct device_type *type);
231 extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
232 extern void class_dev_iter_exit(struct class_dev_iter *iter);
234 extern int class_for_each_device(struct class *class, struct device *start,
236 int (*fn)(struct device *dev, void *data));
237 extern struct device *class_find_device(struct class *class,
238 struct device *start, void *data,
239 int (*match)(struct device *, void *));
241 struct class_attribute {
242 struct attribute attr;
243 ssize_t (*show)(struct class *class, char *buf);
244 ssize_t (*store)(struct class *class, const char *buf, size_t count);
247 #define CLASS_ATTR(_name, _mode, _show, _store) \
248 struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
250 extern int __must_check class_create_file(struct class *class,
251 const struct class_attribute *attr);
252 extern void class_remove_file(struct class *class,
253 const struct class_attribute *attr);
255 struct class_interface {
256 struct list_head node;
259 int (*add_dev) (struct device *, struct class_interface *);
260 void (*remove_dev) (struct device *, struct class_interface *);
263 extern int __must_check class_interface_register(struct class_interface *);
264 extern void class_interface_unregister(struct class_interface *);
266 extern struct class * __must_check __class_create(struct module *owner,
268 struct lock_class_key *key);
269 extern void class_destroy(struct class *cls);
271 /* This is a #define to keep the compiler from merging different
272 * instances of the __key variable */
273 #define class_create(owner, name) \
275 static struct lock_class_key __key; \
276 __class_create(owner, name, &__key); \
280 * The type of device, "struct device" is embedded in. A class
281 * or bus can contain devices of different types
282 * like "partitions" and "disks", "mouse" and "event".
283 * This identifies the device type and carries type-specific
284 * information, equivalent to the kobj_type of a kobject.
285 * If "name" is specified, the uevent will contain it in
286 * the DEVTYPE variable.
290 struct attribute_group **groups;
291 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
292 void (*release)(struct device *dev);
294 int (*suspend)(struct device *dev, pm_message_t state);
295 int (*resume)(struct device *dev);
297 struct dev_pm_ops *pm;
300 /* interface for exporting device attributes */
301 struct device_attribute {
302 struct attribute attr;
303 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
305 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
306 const char *buf, size_t count);
309 #define DEVICE_ATTR(_name, _mode, _show, _store) \
310 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
312 extern int __must_check device_create_file(struct device *device,
313 struct device_attribute *entry);
314 extern void device_remove_file(struct device *dev,
315 struct device_attribute *attr);
316 extern int __must_check device_create_bin_file(struct device *dev,
317 struct bin_attribute *attr);
318 extern void device_remove_bin_file(struct device *dev,
319 struct bin_attribute *attr);
320 extern int device_schedule_callback_owner(struct device *dev,
321 void (*func)(struct device *dev), struct module *owner);
323 /* This is a macro to avoid include problems with THIS_MODULE */
324 #define device_schedule_callback(dev, func) \
325 device_schedule_callback_owner(dev, func, THIS_MODULE)
327 /* device resource management */
328 typedef void (*dr_release_t)(struct device *dev, void *res);
329 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
331 #ifdef CONFIG_DEBUG_DEVRES
332 extern void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
334 #define devres_alloc(release, size, gfp) \
335 __devres_alloc(release, size, gfp, #release)
337 extern void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
339 extern void devres_free(void *res);
340 extern void devres_add(struct device *dev, void *res);
341 extern void *devres_find(struct device *dev, dr_release_t release,
342 dr_match_t match, void *match_data);
343 extern void *devres_get(struct device *dev, void *new_res,
344 dr_match_t match, void *match_data);
345 extern void *devres_remove(struct device *dev, dr_release_t release,
346 dr_match_t match, void *match_data);
347 extern int devres_destroy(struct device *dev, dr_release_t release,
348 dr_match_t match, void *match_data);
351 extern void * __must_check devres_open_group(struct device *dev, void *id,
353 extern void devres_close_group(struct device *dev, void *id);
354 extern void devres_remove_group(struct device *dev, void *id);
355 extern int devres_release_group(struct device *dev, void *id);
357 /* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
358 extern void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp);
359 extern void devm_kfree(struct device *dev, void *p);
361 struct device_dma_parameters {
363 * a low level driver may set these to teach IOMMU code about
366 unsigned int max_segment_size;
367 unsigned long segment_boundary_mask;
371 struct klist klist_children;
372 struct klist_node knode_parent; /* node in sibling list */
373 struct klist_node knode_driver;
374 struct klist_node knode_bus;
375 struct device *parent;
377 struct device_private *p;
380 unsigned uevent_suppress:1;
381 const char *init_name; /* initial name of the device */
382 struct device_type *type;
384 struct semaphore sem; /* semaphore to synchronize calls to
388 struct bus_type *bus; /* type of bus device is on */
389 struct device_driver *driver; /* which driver has allocated this
391 void *driver_data; /* data private to the driver */
392 void *platform_data; /* Platform specific data, device
393 core doesn't touch it */
394 struct dev_pm_info power;
397 int numa_node; /* NUMA node this device is close to */
399 u64 *dma_mask; /* dma mask (if dma'able device) */
400 u64 coherent_dma_mask;/* Like dma_mask, but for
401 alloc_coherent mappings as
402 not all hardware supports
403 64 bit addresses for consistent
404 allocations such descriptors. */
406 struct device_dma_parameters *dma_parms;
408 struct list_head dma_pools; /* dma pools (if dma'ble) */
410 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
412 /* arch specific additions */
413 struct dev_archdata archdata;
415 dev_t devt; /* dev_t, creates the sysfs "dev" */
417 spinlock_t devres_lock;
418 struct list_head devres_head;
420 struct klist_node knode_class;
422 struct attribute_group **groups; /* optional groups */
424 void (*release)(struct device *dev);
427 /* Get the wakeup routines, which depend on struct device */
428 #include <linux/pm_wakeup.h>
430 static inline const char *dev_name(const struct device *dev)
432 return kobject_name(&dev->kobj);
435 extern int dev_set_name(struct device *dev, const char *name, ...)
436 __attribute__((format(printf, 2, 3)));
439 static inline int dev_to_node(struct device *dev)
441 return dev->numa_node;
443 static inline void set_dev_node(struct device *dev, int node)
445 dev->numa_node = node;
448 static inline int dev_to_node(struct device *dev)
452 static inline void set_dev_node(struct device *dev, int node)
457 static inline void *dev_get_drvdata(const struct device *dev)
459 return dev->driver_data;
462 static inline void dev_set_drvdata(struct device *dev, void *data)
464 dev->driver_data = data;
467 static inline int device_is_registered(struct device *dev)
469 return dev->kobj.state_in_sysfs;
472 void driver_init(void);
475 * High level routines for use by the bus drivers
477 extern int __must_check device_register(struct device *dev);
478 extern void device_unregister(struct device *dev);
479 extern void device_initialize(struct device *dev);
480 extern int __must_check device_add(struct device *dev);
481 extern void device_del(struct device *dev);
482 extern int device_for_each_child(struct device *dev, void *data,
483 int (*fn)(struct device *dev, void *data));
484 extern struct device *device_find_child(struct device *dev, void *data,
485 int (*match)(struct device *dev, void *data));
486 extern int device_rename(struct device *dev, char *new_name);
487 extern int device_move(struct device *dev, struct device *new_parent);
490 * Root device objects for grouping under /sys/devices
492 extern struct device *__root_device_register(const char *name,
493 struct module *owner);
494 static inline struct device *root_device_register(const char *name)
496 return __root_device_register(name, THIS_MODULE);
498 extern void root_device_unregister(struct device *root);
501 * Manual binding of a device to driver. See drivers/base/bus.c
502 * for information on use.
504 extern int __must_check device_bind_driver(struct device *dev);
505 extern void device_release_driver(struct device *dev);
506 extern int __must_check device_attach(struct device *dev);
507 extern int __must_check driver_attach(struct device_driver *drv);
508 extern int __must_check device_reprobe(struct device *dev);
511 * Easy functions for dynamically creating devices on the fly
513 extern struct device *device_create_vargs(struct class *cls,
514 struct device *parent,
519 extern struct device *device_create(struct class *cls, struct device *parent,
520 dev_t devt, void *drvdata,
521 const char *fmt, ...)
522 __attribute__((format(printf, 5, 6)));
523 extern void device_destroy(struct class *cls, dev_t devt);
526 * Platform "fixup" functions - allow the platform to have their say
527 * about devices and actions that the general device layer doesn't
530 /* Notify platform of device discovery */
531 extern int (*platform_notify)(struct device *dev);
533 extern int (*platform_notify_remove)(struct device *dev);
537 * get_device - atomically increment the reference count for the device.
540 extern struct device *get_device(struct device *dev);
541 extern void put_device(struct device *dev);
544 /* drivers/base/power/shutdown.c */
545 extern void device_shutdown(void);
547 /* drivers/base/sys.c */
548 extern void sysdev_shutdown(void);
550 /* debugging and troubleshooting/diagnostic helpers. */
551 extern const char *dev_driver_string(const struct device *dev);
552 #define dev_printk(level, dev, format, arg...) \
553 printk(level "%s %s: " format , dev_driver_string(dev) , \
554 dev_name(dev) , ## arg)
556 #define dev_emerg(dev, format, arg...) \
557 dev_printk(KERN_EMERG , dev , format , ## arg)
558 #define dev_alert(dev, format, arg...) \
559 dev_printk(KERN_ALERT , dev , format , ## arg)
560 #define dev_crit(dev, format, arg...) \
561 dev_printk(KERN_CRIT , dev , format , ## arg)
562 #define dev_err(dev, format, arg...) \
563 dev_printk(KERN_ERR , dev , format , ## arg)
564 #define dev_warn(dev, format, arg...) \
565 dev_printk(KERN_WARNING , dev , format , ## arg)
566 #define dev_notice(dev, format, arg...) \
567 dev_printk(KERN_NOTICE , dev , format , ## arg)
568 #define dev_info(dev, format, arg...) \
569 dev_printk(KERN_INFO , dev , format , ## arg)
572 #define dev_dbg(dev, format, arg...) \
573 dev_printk(KERN_DEBUG , dev , format , ## arg)
574 #elif defined(CONFIG_DYNAMIC_PRINTK_DEBUG)
575 #define dev_dbg(dev, format, ...) do { \
576 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
579 #define dev_dbg(dev, format, arg...) \
580 ({ if (0) dev_printk(KERN_DEBUG, dev, format, ##arg); 0; })
584 #define dev_vdbg dev_dbg
587 #define dev_vdbg(dev, format, arg...) \
588 ({ if (0) dev_printk(KERN_DEBUG, dev, format, ##arg); 0; })
592 * dev_WARN() acts like dev_printk(), but with the key difference
593 * of using a WARN/WARN_ON to get the message out, including the
594 * file/line information and a backtrace.
596 #define dev_WARN(dev, format, arg...) \
597 WARN(1, "Device: %s\n" format, dev_driver_string(dev), ## arg);
599 /* Create alias, so I can be autoloaded. */
600 #define MODULE_ALIAS_CHARDEV(major,minor) \
601 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
602 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
603 MODULE_ALIAS("char-major-" __stringify(major) "-*")
604 #endif /* _DEVICE_H_ */