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/compiler.h>
20 #include <linux/types.h>
21 #include <linux/module.h>
23 #include <asm/semaphore.h>
24 #include <asm/atomic.h>
25 #include <asm/device.h>
27 #define DEVICE_NAME_SIZE 50
28 #define DEVICE_NAME_HALF __stringify(20) /* Less than half to accommodate slop */
29 #define DEVICE_ID_SIZE 32
30 #define BUS_ID_SIZE KOBJ_NAME_LEN
35 struct driver_private;
39 struct bus_type_private;
41 struct bus_attribute {
42 struct attribute attr;
43 ssize_t (*show)(struct bus_type *, char * buf);
44 ssize_t (*store)(struct bus_type *, const char * buf, size_t count);
47 #define BUS_ATTR(_name,_mode,_show,_store) \
48 struct bus_attribute bus_attr_##_name = __ATTR(_name,_mode,_show,_store)
50 extern int __must_check bus_create_file(struct bus_type *,
51 struct bus_attribute *);
52 extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
56 struct bus_attribute * bus_attrs;
57 struct device_attribute * dev_attrs;
58 struct driver_attribute * drv_attrs;
60 int (*match)(struct device * dev, struct device_driver * drv);
61 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
62 int (*probe)(struct device * dev);
63 int (*remove)(struct device * dev);
64 void (*shutdown)(struct device * dev);
66 int (*suspend)(struct device * dev, pm_message_t state);
67 int (*suspend_late)(struct device * dev, pm_message_t state);
68 int (*resume_early)(struct device * dev);
69 int (*resume)(struct device * dev);
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 *, void *));
83 struct device * bus_find_device(struct bus_type *bus, struct device *start,
84 void *data, int (*match)(struct device *, void *));
86 int __must_check bus_for_each_drv(struct bus_type *bus,
87 struct device_driver *start, void *data,
88 int (*fn)(struct device_driver *, void *));
91 * Bus notifiers: Get notified of addition/removal of devices
92 * and binding/unbinding of drivers to devices.
93 * In the long run, it should be a replacement for the platform
96 struct notifier_block;
98 extern int bus_register_notifier(struct bus_type *bus,
99 struct notifier_block *nb);
100 extern int bus_unregister_notifier(struct bus_type *bus,
101 struct notifier_block *nb);
103 /* All 4 notifers below get called with the target struct device *
104 * as an argument. Note that those functions are likely to be called
105 * with the device semaphore held in the core, so be careful.
107 #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
108 #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */
109 #define BUS_NOTIFY_BOUND_DRIVER 0x00000003 /* driver bound to device */
110 #define BUS_NOTIFY_UNBIND_DRIVER 0x00000004 /* driver about to be
113 extern struct kset *bus_get_kset(struct bus_type *bus);
114 extern struct klist *bus_get_device_klist(struct bus_type *bus);
116 struct device_driver {
118 struct bus_type *bus;
120 struct module *owner;
121 const char *mod_name; /* used for built-in modules */
123 int (*probe) (struct device * dev);
124 int (*remove) (struct device * dev);
125 void (*shutdown) (struct device * dev);
126 int (*suspend) (struct device * dev, pm_message_t state);
127 int (*resume) (struct device * dev);
128 struct attribute_group **groups;
130 struct driver_private *p;
134 extern int __must_check driver_register(struct device_driver * drv);
135 extern void driver_unregister(struct device_driver * drv);
137 extern struct device_driver * get_driver(struct device_driver * drv);
138 extern void put_driver(struct device_driver * drv);
139 extern struct device_driver *driver_find(const char *name, struct bus_type *bus);
140 extern int driver_probe_done(void);
142 /* sysfs interface for exporting driver attributes */
144 struct driver_attribute {
145 struct attribute attr;
146 ssize_t (*show)(struct device_driver *, char * buf);
147 ssize_t (*store)(struct device_driver *, const char * buf, size_t count);
150 #define DRIVER_ATTR(_name,_mode,_show,_store) \
151 struct driver_attribute driver_attr_##_name = __ATTR(_name,_mode,_show,_store)
153 extern int __must_check driver_create_file(struct device_driver *,
154 struct driver_attribute *);
155 extern void driver_remove_file(struct device_driver *, struct driver_attribute *);
157 extern int __must_check driver_add_kobj(struct device_driver *drv,
158 struct kobject *kobj,
159 const char *fmt, ...);
161 extern int __must_check driver_for_each_device(struct device_driver * drv,
162 struct device *start, void *data,
163 int (*fn)(struct device *, void *));
164 struct device * driver_find_device(struct device_driver *drv,
165 struct device *start, void *data,
166 int (*match)(struct device *, void *));
173 struct module * owner;
176 struct list_head children;
177 struct list_head devices;
178 struct list_head interfaces;
179 struct kset class_dirs;
180 struct semaphore sem; /* locks children, devices, interfaces */
181 struct class_attribute * class_attrs;
182 struct class_device_attribute * class_dev_attrs;
183 struct device_attribute * dev_attrs;
185 int (*uevent)(struct class_device *dev, struct kobj_uevent_env *env);
186 int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
188 void (*release)(struct class_device *dev);
189 void (*class_release)(struct class *class);
190 void (*dev_release)(struct device *dev);
192 int (*suspend)(struct device *, pm_message_t state);
193 int (*resume)(struct device *);
196 extern int __must_check class_register(struct class *);
197 extern void class_unregister(struct class *);
198 extern int class_for_each_device(struct class *class, void *data,
199 int (*fn)(struct device *dev, void *data));
200 extern struct device *class_find_device(struct class *class, void *data,
201 int (*match)(struct device *, void *));
202 extern struct class_device *class_find_child(struct class *class, void *data,
203 int (*match)(struct class_device *, void *));
206 struct class_attribute {
207 struct attribute attr;
208 ssize_t (*show)(struct class *, char * buf);
209 ssize_t (*store)(struct class *, const char * buf, size_t count);
212 #define CLASS_ATTR(_name,_mode,_show,_store) \
213 struct class_attribute class_attr_##_name = __ATTR(_name,_mode,_show,_store)
215 extern int __must_check class_create_file(struct class *,
216 const struct class_attribute *);
217 extern void class_remove_file(struct class *, const struct class_attribute *);
219 struct class_device_attribute {
220 struct attribute attr;
221 ssize_t (*show)(struct class_device *, char * buf);
222 ssize_t (*store)(struct class_device *, const char * buf, size_t count);
225 #define CLASS_DEVICE_ATTR(_name,_mode,_show,_store) \
226 struct class_device_attribute class_device_attr_##_name = \
227 __ATTR(_name,_mode,_show,_store)
229 extern int __must_check class_device_create_file(struct class_device *,
230 const struct class_device_attribute *);
233 * struct class_device - class devices
234 * @class: pointer to the parent class for this class device. This is required.
235 * @devt: for internal use by the driver core only.
236 * @node: for internal use by the driver core only.
237 * @kobj: for internal use by the driver core only.
238 * @groups: optional additional groups to be created
239 * @dev: if set, a symlink to the struct device is created in the sysfs
240 * directory for this struct class device.
241 * @class_data: pointer to whatever you want to store here for this struct
242 * class_device. Use class_get_devdata() and class_set_devdata() to get and
244 * @parent: pointer to a struct class_device that is the parent of this struct
245 * class_device. If NULL, this class_device will show up at the root of the
246 * struct class in sysfs (which is probably what you want to have happen.)
247 * @release: pointer to a release function for this struct class_device. If
248 * set, this will be called instead of the class specific release function.
249 * Only use this if you want to override the default release function, like
250 * when you are nesting class_device structures.
251 * @uevent: pointer to a uevent function for this struct class_device. If
252 * set, this will be called instead of the class specific uevent function.
253 * Only use this if you want to override the default uevent function, like
254 * when you are nesting class_device structures.
256 struct class_device {
257 struct list_head node;
260 struct class * class; /* required */
261 dev_t devt; /* dev_t, creates the sysfs "dev" */
262 struct device * dev; /* not necessary, but nice to have */
263 void * class_data; /* class-specific data */
264 struct class_device *parent; /* parent of this child device, if there is one */
265 struct attribute_group ** groups; /* optional groups */
267 void (*release)(struct class_device *dev);
268 int (*uevent)(struct class_device *dev, struct kobj_uevent_env *env);
269 char class_id[BUS_ID_SIZE]; /* unique to this class */
273 class_get_devdata (struct class_device *dev)
275 return dev->class_data;
279 class_set_devdata (struct class_device *dev, void *data)
281 dev->class_data = data;
285 extern int __must_check class_device_register(struct class_device *);
286 extern void class_device_unregister(struct class_device *);
287 extern void class_device_initialize(struct class_device *);
288 extern int __must_check class_device_add(struct class_device *);
289 extern void class_device_del(struct class_device *);
291 extern struct class_device * class_device_get(struct class_device *);
292 extern void class_device_put(struct class_device *);
294 extern void class_device_remove_file(struct class_device *,
295 const struct class_device_attribute *);
296 extern int __must_check class_device_create_bin_file(struct class_device *,
297 struct bin_attribute *);
298 extern void class_device_remove_bin_file(struct class_device *,
299 struct bin_attribute *);
301 struct class_interface {
302 struct list_head node;
305 int (*add) (struct class_device *, struct class_interface *);
306 void (*remove) (struct class_device *, struct class_interface *);
307 int (*add_dev) (struct device *, struct class_interface *);
308 void (*remove_dev) (struct device *, struct class_interface *);
311 extern int __must_check class_interface_register(struct class_interface *);
312 extern void class_interface_unregister(struct class_interface *);
314 extern struct class *class_create(struct module *owner, const char *name);
315 extern void class_destroy(struct class *cls);
316 extern struct class_device *class_device_create(struct class *cls,
317 struct class_device *parent,
319 struct device *device,
320 const char *fmt, ...)
321 __attribute__((format(printf,5,6)));
322 extern void class_device_destroy(struct class *cls, dev_t devt);
325 * The type of device, "struct device" is embedded in. A class
326 * or bus can contain devices of different types
327 * like "partitions" and "disks", "mouse" and "event".
328 * This identifies the device type and carries type-specific
329 * information, equivalent to the kobj_type of a kobject.
330 * If "name" is specified, the uevent will contain it in
331 * the DEVTYPE variable.
335 struct attribute_group **groups;
336 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
337 void (*release)(struct device *dev);
338 int (*suspend)(struct device * dev, pm_message_t state);
339 int (*resume)(struct device * dev);
342 /* interface for exporting device attributes */
343 struct device_attribute {
344 struct attribute attr;
345 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
347 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
348 const char *buf, size_t count);
351 #define DEVICE_ATTR(_name,_mode,_show,_store) \
352 struct device_attribute dev_attr_##_name = __ATTR(_name,_mode,_show,_store)
354 extern int __must_check device_create_file(struct device *device,
355 struct device_attribute * entry);
356 extern void device_remove_file(struct device * dev, struct device_attribute * attr);
357 extern int __must_check device_create_bin_file(struct device *dev,
358 struct bin_attribute *attr);
359 extern void device_remove_bin_file(struct device *dev,
360 struct bin_attribute *attr);
361 extern int device_schedule_callback_owner(struct device *dev,
362 void (*func)(struct device *), struct module *owner);
364 /* This is a macro to avoid include problems with THIS_MODULE */
365 #define device_schedule_callback(dev, func) \
366 device_schedule_callback_owner(dev, func, THIS_MODULE)
368 /* device resource management */
369 typedef void (*dr_release_t)(struct device *dev, void *res);
370 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
372 #ifdef CONFIG_DEBUG_DEVRES
373 extern void * __devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
375 #define devres_alloc(release, size, gfp) \
376 __devres_alloc(release, size, gfp, #release)
378 extern void * devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
380 extern void devres_free(void *res);
381 extern void devres_add(struct device *dev, void *res);
382 extern void * devres_find(struct device *dev, dr_release_t release,
383 dr_match_t match, void *match_data);
384 extern void * devres_get(struct device *dev, void *new_res,
385 dr_match_t match, void *match_data);
386 extern void * devres_remove(struct device *dev, dr_release_t release,
387 dr_match_t match, void *match_data);
388 extern int devres_destroy(struct device *dev, dr_release_t release,
389 dr_match_t match, void *match_data);
392 extern void * __must_check devres_open_group(struct device *dev, void *id,
394 extern void devres_close_group(struct device *dev, void *id);
395 extern void devres_remove_group(struct device *dev, void *id);
396 extern int devres_release_group(struct device *dev, void *id);
398 /* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
399 extern void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp);
400 extern void devm_kfree(struct device *dev, void *p);
403 struct klist klist_children;
404 struct klist_node knode_parent; /* node in sibling list */
405 struct klist_node knode_driver;
406 struct klist_node knode_bus;
407 struct device *parent;
410 char bus_id[BUS_ID_SIZE]; /* position on parent bus */
411 struct device_type *type;
412 unsigned is_registered:1;
413 unsigned uevent_suppress:1;
415 struct semaphore sem; /* semaphore to synchronize calls to
419 struct bus_type * bus; /* type of bus device is on */
420 struct device_driver *driver; /* which driver has allocated this
422 void *driver_data; /* data private to the driver */
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 list_head dma_pools; /* dma pools (if dma'ble) */
439 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
441 /* arch specific additions */
442 struct dev_archdata archdata;
444 spinlock_t devres_lock;
445 struct list_head devres_head;
447 /* class_device migration path */
448 struct list_head node;
450 dev_t devt; /* dev_t, creates the sysfs "dev" */
451 struct attribute_group **groups; /* optional groups */
453 void (*release)(struct device * dev);
457 static inline int dev_to_node(struct device *dev)
459 return dev->numa_node;
461 static inline void set_dev_node(struct device *dev, int node)
463 dev->numa_node = node;
466 static inline int dev_to_node(struct device *dev)
470 static inline void set_dev_node(struct device *dev, int node)
476 dev_get_drvdata (struct device *dev)
478 return dev->driver_data;
482 dev_set_drvdata (struct device *dev, void *data)
484 dev->driver_data = data;
487 static inline int device_is_registered(struct device *dev)
489 return dev->is_registered;
492 void driver_init(void);
495 * High level routines for use by the bus drivers
497 extern int __must_check device_register(struct device * dev);
498 extern void device_unregister(struct device * dev);
499 extern void device_initialize(struct device * dev);
500 extern int __must_check device_add(struct device * dev);
501 extern void device_del(struct device * dev);
502 extern int device_for_each_child(struct device *, void *,
503 int (*fn)(struct device *, void *));
504 extern struct device *device_find_child(struct device *, void *data,
505 int (*match)(struct device *, void *));
506 extern int device_rename(struct device *dev, char *new_name);
507 extern int device_move(struct device *dev, struct device *new_parent);
510 * Manual binding of a device to driver. See drivers/base/bus.c
511 * for information on use.
513 extern int __must_check device_bind_driver(struct device *dev);
514 extern void device_release_driver(struct device * dev);
515 extern int __must_check device_attach(struct device * dev);
516 extern int __must_check driver_attach(struct device_driver *drv);
517 extern int __must_check device_reprobe(struct device *dev);
520 * Easy functions for dynamically creating devices on the fly
522 extern struct device *device_create(struct class *cls, struct device *parent,
523 dev_t devt, const char *fmt, ...)
524 __attribute__((format(printf,4,5)));
525 extern void device_destroy(struct class *cls, dev_t devt);
526 #ifdef CONFIG_PM_SLEEP
527 extern void destroy_suspended_device(struct class *cls, dev_t devt);
528 #else /* !CONFIG_PM_SLEEP */
529 static inline void destroy_suspended_device(struct class *cls, dev_t devt)
531 device_destroy(cls, devt);
533 #endif /* !CONFIG_PM_SLEEP */
536 * Platform "fixup" functions - allow the platform to have their say
537 * about devices and actions that the general device layer doesn't
540 /* Notify platform of device discovery */
541 extern int (*platform_notify)(struct device * dev);
543 extern int (*platform_notify_remove)(struct device * dev);
547 * get_device - atomically increment the reference count for the device.
550 extern struct device * get_device(struct device * dev);
551 extern void put_device(struct device * dev);
554 /* drivers/base/power/shutdown.c */
555 extern void device_shutdown(void);
557 /* drivers/base/sys.c */
558 extern void sysdev_shutdown(void);
560 /* debugging and troubleshooting/diagnostic helpers. */
561 extern const char *dev_driver_string(struct device *dev);
562 #define dev_printk(level, dev, format, arg...) \
563 printk(level "%s %s: " format , dev_driver_string(dev) , (dev)->bus_id , ## arg)
565 #define dev_emerg(dev, format, arg...) \
566 dev_printk(KERN_EMERG , dev , format , ## arg)
567 #define dev_alert(dev, format, arg...) \
568 dev_printk(KERN_ALERT , dev , format , ## arg)
569 #define dev_crit(dev, format, arg...) \
570 dev_printk(KERN_CRIT , dev , format , ## arg)
571 #define dev_err(dev, format, arg...) \
572 dev_printk(KERN_ERR , dev , format , ## arg)
573 #define dev_warn(dev, format, arg...) \
574 dev_printk(KERN_WARNING , dev , format , ## arg)
575 #define dev_notice(dev, format, arg...) \
576 dev_printk(KERN_NOTICE , dev , format , ## arg)
577 #define dev_info(dev, format, arg...) \
578 dev_printk(KERN_INFO , dev , format , ## arg)
581 #define dev_dbg(dev, format, arg...) \
582 dev_printk(KERN_DEBUG , dev , format , ## arg)
584 static inline int __attribute__ ((format (printf, 2, 3)))
585 dev_dbg(struct device * dev, const char * fmt, ...)
592 #define dev_vdbg dev_dbg
594 static inline int __attribute__ ((format (printf, 2, 3)))
595 dev_vdbg(struct device * dev, const char * fmt, ...)
601 /* Create alias, so I can be autoloaded. */
602 #define MODULE_ALIAS_CHARDEV(major,minor) \
603 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
604 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
605 MODULE_ALIAS("char-major-" __stringify(major) "-*")
606 #endif /* _DEVICE_H_ */