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
38 struct bus_type_private;
40 struct bus_attribute {
41 struct attribute attr;
42 ssize_t (*show)(struct bus_type *, char * buf);
43 ssize_t (*store)(struct bus_type *, const char * buf, size_t count);
46 #define BUS_ATTR(_name,_mode,_show,_store) \
47 struct bus_attribute bus_attr_##_name = __ATTR(_name,_mode,_show,_store)
49 extern int __must_check bus_create_file(struct bus_type *,
50 struct bus_attribute *);
51 extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
55 struct bus_attribute * bus_attrs;
56 struct device_attribute * dev_attrs;
57 struct driver_attribute * drv_attrs;
59 int (*match)(struct device * dev, struct device_driver * drv);
60 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
61 int (*probe)(struct device * dev);
62 int (*remove)(struct device * dev);
63 void (*shutdown)(struct device * dev);
65 int (*suspend)(struct device * dev, pm_message_t state);
66 int (*suspend_late)(struct device * dev, pm_message_t state);
67 int (*resume_early)(struct device * dev);
68 int (*resume)(struct device * dev);
70 struct bus_type_private *p;
73 extern int __must_check bus_register(struct bus_type * bus);
74 extern void bus_unregister(struct bus_type * bus);
76 extern int __must_check bus_rescan_devices(struct bus_type * bus);
78 /* iterator helpers for buses */
80 int bus_for_each_dev(struct bus_type * bus, struct device * start, void * data,
81 int (*fn)(struct device *, void *));
82 struct device * bus_find_device(struct bus_type *bus, struct device *start,
83 void *data, int (*match)(struct device *, void *));
85 int __must_check bus_for_each_drv(struct bus_type *bus,
86 struct device_driver *start, void *data,
87 int (*fn)(struct device_driver *, void *));
90 * Bus notifiers: Get notified of addition/removal of devices
91 * and binding/unbinding of drivers to devices.
92 * In the long run, it should be a replacement for the platform
95 struct notifier_block;
97 extern int bus_register_notifier(struct bus_type *bus,
98 struct notifier_block *nb);
99 extern int bus_unregister_notifier(struct bus_type *bus,
100 struct notifier_block *nb);
102 /* All 4 notifers below get called with the target struct device *
103 * as an argument. Note that those functions are likely to be called
104 * with the device semaphore held in the core, so be careful.
106 #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
107 #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */
108 #define BUS_NOTIFY_BOUND_DRIVER 0x00000003 /* driver bound to device */
109 #define BUS_NOTIFY_UNBIND_DRIVER 0x00000004 /* driver about to be
112 extern struct kset *bus_get_kset(struct bus_type *bus);
113 extern struct klist *bus_get_device_klist(struct bus_type *bus);
115 struct device_driver {
117 struct bus_type * bus;
120 struct klist klist_devices;
121 struct klist_node knode_bus;
123 struct module * owner;
124 const char * mod_name; /* used for built-in modules */
125 struct module_kobject * mkobj;
127 int (*probe) (struct device * dev);
128 int (*remove) (struct device * dev);
129 void (*shutdown) (struct device * dev);
130 int (*suspend) (struct device * dev, pm_message_t state);
131 int (*resume) (struct device * dev);
135 extern int __must_check driver_register(struct device_driver * drv);
136 extern void driver_unregister(struct device_driver * drv);
138 extern struct device_driver * get_driver(struct device_driver * drv);
139 extern void put_driver(struct device_driver * drv);
140 extern struct device_driver *driver_find(const char *name, struct bus_type *bus);
141 extern int driver_probe_done(void);
143 /* sysfs interface for exporting driver attributes */
145 struct driver_attribute {
146 struct attribute attr;
147 ssize_t (*show)(struct device_driver *, char * buf);
148 ssize_t (*store)(struct device_driver *, const char * buf, size_t count);
151 #define DRIVER_ATTR(_name,_mode,_show,_store) \
152 struct driver_attribute driver_attr_##_name = __ATTR(_name,_mode,_show,_store)
154 extern int __must_check driver_create_file(struct device_driver *,
155 struct driver_attribute *);
156 extern void driver_remove_file(struct device_driver *, struct driver_attribute *);
158 extern int __must_check driver_for_each_device(struct device_driver * drv,
159 struct device *start, void *data,
160 int (*fn)(struct device *, void *));
161 struct device * driver_find_device(struct device_driver *drv,
162 struct device *start, void *data,
163 int (*match)(struct device *, void *));
170 struct module * owner;
173 struct list_head children;
174 struct list_head devices;
175 struct list_head interfaces;
176 struct kset class_dirs;
177 struct semaphore sem; /* locks both the children and interfaces lists */
179 struct class_attribute * class_attrs;
180 struct class_device_attribute * class_dev_attrs;
181 struct device_attribute * dev_attrs;
183 int (*uevent)(struct class_device *dev, struct kobj_uevent_env *env);
184 int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
186 void (*release)(struct class_device *dev);
187 void (*class_release)(struct class *class);
188 void (*dev_release)(struct device *dev);
190 int (*suspend)(struct device *, pm_message_t state);
191 int (*resume)(struct device *);
194 extern int __must_check class_register(struct class *);
195 extern void class_unregister(struct class *);
198 struct class_attribute {
199 struct attribute attr;
200 ssize_t (*show)(struct class *, char * buf);
201 ssize_t (*store)(struct class *, const char * buf, size_t count);
204 #define CLASS_ATTR(_name,_mode,_show,_store) \
205 struct class_attribute class_attr_##_name = __ATTR(_name,_mode,_show,_store)
207 extern int __must_check class_create_file(struct class *,
208 const struct class_attribute *);
209 extern void class_remove_file(struct class *, const struct class_attribute *);
211 struct class_device_attribute {
212 struct attribute attr;
213 ssize_t (*show)(struct class_device *, char * buf);
214 ssize_t (*store)(struct class_device *, const char * buf, size_t count);
217 #define CLASS_DEVICE_ATTR(_name,_mode,_show,_store) \
218 struct class_device_attribute class_device_attr_##_name = \
219 __ATTR(_name,_mode,_show,_store)
221 extern int __must_check class_device_create_file(struct class_device *,
222 const struct class_device_attribute *);
225 * struct class_device - class devices
226 * @class: pointer to the parent class for this class device. This is required.
227 * @devt: for internal use by the driver core only.
228 * @node: for internal use by the driver core only.
229 * @kobj: for internal use by the driver core only.
230 * @groups: optional additional groups to be created
231 * @dev: if set, a symlink to the struct device is created in the sysfs
232 * directory for this struct class device.
233 * @class_data: pointer to whatever you want to store here for this struct
234 * class_device. Use class_get_devdata() and class_set_devdata() to get and
236 * @parent: pointer to a struct class_device that is the parent of this struct
237 * class_device. If NULL, this class_device will show up at the root of the
238 * struct class in sysfs (which is probably what you want to have happen.)
239 * @release: pointer to a release function for this struct class_device. If
240 * set, this will be called instead of the class specific release function.
241 * Only use this if you want to override the default release function, like
242 * when you are nesting class_device structures.
243 * @uevent: pointer to a uevent function for this struct class_device. If
244 * set, this will be called instead of the class specific uevent function.
245 * Only use this if you want to override the default uevent function, like
246 * when you are nesting class_device structures.
248 struct class_device {
249 struct list_head node;
252 struct class * class; /* required */
253 dev_t devt; /* dev_t, creates the sysfs "dev" */
254 struct device * dev; /* not necessary, but nice to have */
255 void * class_data; /* class-specific data */
256 struct class_device *parent; /* parent of this child device, if there is one */
257 struct attribute_group ** groups; /* optional groups */
259 void (*release)(struct class_device *dev);
260 int (*uevent)(struct class_device *dev, struct kobj_uevent_env *env);
261 char class_id[BUS_ID_SIZE]; /* unique to this class */
265 class_get_devdata (struct class_device *dev)
267 return dev->class_data;
271 class_set_devdata (struct class_device *dev, void *data)
273 dev->class_data = data;
277 extern int __must_check class_device_register(struct class_device *);
278 extern void class_device_unregister(struct class_device *);
279 extern void class_device_initialize(struct class_device *);
280 extern int __must_check class_device_add(struct class_device *);
281 extern void class_device_del(struct class_device *);
283 extern struct class_device * class_device_get(struct class_device *);
284 extern void class_device_put(struct class_device *);
286 extern void class_device_remove_file(struct class_device *,
287 const struct class_device_attribute *);
288 extern int __must_check class_device_create_bin_file(struct class_device *,
289 struct bin_attribute *);
290 extern void class_device_remove_bin_file(struct class_device *,
291 struct bin_attribute *);
293 struct class_interface {
294 struct list_head node;
297 int (*add) (struct class_device *, struct class_interface *);
298 void (*remove) (struct class_device *, struct class_interface *);
299 int (*add_dev) (struct device *, struct class_interface *);
300 void (*remove_dev) (struct device *, struct class_interface *);
303 extern int __must_check class_interface_register(struct class_interface *);
304 extern void class_interface_unregister(struct class_interface *);
306 extern struct class *class_create(struct module *owner, const char *name);
307 extern void class_destroy(struct class *cls);
308 extern struct class_device *class_device_create(struct class *cls,
309 struct class_device *parent,
311 struct device *device,
312 const char *fmt, ...)
313 __attribute__((format(printf,5,6)));
314 extern void class_device_destroy(struct class *cls, dev_t devt);
317 * The type of device, "struct device" is embedded in. A class
318 * or bus can contain devices of different types
319 * like "partitions" and "disks", "mouse" and "event".
320 * This identifies the device type and carries type-specific
321 * information, equivalent to the kobj_type of a kobject.
322 * If "name" is specified, the uevent will contain it in
323 * the DEVTYPE variable.
327 struct attribute_group **groups;
328 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
329 void (*release)(struct device *dev);
330 int (*suspend)(struct device * dev, pm_message_t state);
331 int (*resume)(struct device * dev);
334 /* interface for exporting device attributes */
335 struct device_attribute {
336 struct attribute attr;
337 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
339 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
340 const char *buf, size_t count);
343 #define DEVICE_ATTR(_name,_mode,_show,_store) \
344 struct device_attribute dev_attr_##_name = __ATTR(_name,_mode,_show,_store)
346 extern int __must_check device_create_file(struct device *device,
347 struct device_attribute * entry);
348 extern void device_remove_file(struct device * dev, struct device_attribute * attr);
349 extern int __must_check device_create_bin_file(struct device *dev,
350 struct bin_attribute *attr);
351 extern void device_remove_bin_file(struct device *dev,
352 struct bin_attribute *attr);
353 extern int device_schedule_callback_owner(struct device *dev,
354 void (*func)(struct device *), struct module *owner);
356 /* This is a macro to avoid include problems with THIS_MODULE */
357 #define device_schedule_callback(dev, func) \
358 device_schedule_callback_owner(dev, func, THIS_MODULE)
360 /* device resource management */
361 typedef void (*dr_release_t)(struct device *dev, void *res);
362 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
364 #ifdef CONFIG_DEBUG_DEVRES
365 extern void * __devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
367 #define devres_alloc(release, size, gfp) \
368 __devres_alloc(release, size, gfp, #release)
370 extern void * devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
372 extern void devres_free(void *res);
373 extern void devres_add(struct device *dev, void *res);
374 extern void * devres_find(struct device *dev, dr_release_t release,
375 dr_match_t match, void *match_data);
376 extern void * devres_get(struct device *dev, void *new_res,
377 dr_match_t match, void *match_data);
378 extern void * devres_remove(struct device *dev, dr_release_t release,
379 dr_match_t match, void *match_data);
380 extern int devres_destroy(struct device *dev, dr_release_t release,
381 dr_match_t match, void *match_data);
384 extern void * __must_check devres_open_group(struct device *dev, void *id,
386 extern void devres_close_group(struct device *dev, void *id);
387 extern void devres_remove_group(struct device *dev, void *id);
388 extern int devres_release_group(struct device *dev, void *id);
390 /* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
391 extern void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp);
392 extern void devm_kfree(struct device *dev, void *p);
395 struct klist klist_children;
396 struct klist_node knode_parent; /* node in sibling list */
397 struct klist_node knode_driver;
398 struct klist_node knode_bus;
399 struct device *parent;
402 char bus_id[BUS_ID_SIZE]; /* position on parent bus */
403 struct device_type *type;
404 unsigned is_registered:1;
405 unsigned uevent_suppress:1;
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 *driver_data; /* data private to the driver */
415 void *platform_data; /* Platform specific data, device
416 core doesn't touch it */
417 struct dev_pm_info power;
420 int numa_node; /* NUMA node this device is close to */
422 u64 *dma_mask; /* dma mask (if dma'able device) */
423 u64 coherent_dma_mask;/* Like dma_mask, but for
424 alloc_coherent mappings as
425 not all hardware supports
426 64 bit addresses for consistent
427 allocations such descriptors. */
429 struct list_head dma_pools; /* dma pools (if dma'ble) */
431 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
433 /* arch specific additions */
434 struct dev_archdata archdata;
436 spinlock_t devres_lock;
437 struct list_head devres_head;
439 /* class_device migration path */
440 struct list_head node;
442 dev_t devt; /* dev_t, creates the sysfs "dev" */
443 struct attribute_group **groups; /* optional groups */
445 void (*release)(struct device * dev);
449 static inline int dev_to_node(struct device *dev)
451 return dev->numa_node;
453 static inline void set_dev_node(struct device *dev, int node)
455 dev->numa_node = node;
458 static inline int dev_to_node(struct device *dev)
462 static inline void set_dev_node(struct device *dev, int node)
468 dev_get_drvdata (struct device *dev)
470 return dev->driver_data;
474 dev_set_drvdata (struct device *dev, void *data)
476 dev->driver_data = data;
479 static inline int device_is_registered(struct device *dev)
481 return dev->is_registered;
484 void driver_init(void);
487 * High level routines for use by the bus drivers
489 extern int __must_check device_register(struct device * dev);
490 extern void device_unregister(struct device * dev);
491 extern void device_initialize(struct device * dev);
492 extern int __must_check device_add(struct device * dev);
493 extern void device_del(struct device * dev);
494 extern int device_for_each_child(struct device *, void *,
495 int (*fn)(struct device *, void *));
496 extern struct device *device_find_child(struct device *, void *data,
497 int (*match)(struct device *, void *));
498 extern int device_rename(struct device *dev, char *new_name);
499 extern int device_move(struct device *dev, struct device *new_parent);
502 * Manual binding of a device to driver. See drivers/base/bus.c
503 * for information on use.
505 extern int __must_check device_bind_driver(struct device *dev);
506 extern void device_release_driver(struct device * dev);
507 extern int __must_check device_attach(struct device * dev);
508 extern int __must_check driver_attach(struct device_driver *drv);
509 extern int __must_check device_reprobe(struct device *dev);
512 * Easy functions for dynamically creating devices on the fly
514 extern struct device *device_create(struct class *cls, struct device *parent,
515 dev_t devt, const char *fmt, ...)
516 __attribute__((format(printf,4,5)));
517 extern void device_destroy(struct class *cls, dev_t devt);
518 #ifdef CONFIG_PM_SLEEP
519 extern void destroy_suspended_device(struct class *cls, dev_t devt);
520 #else /* !CONFIG_PM_SLEEP */
521 static inline void destroy_suspended_device(struct class *cls, dev_t devt)
523 device_destroy(cls, devt);
525 #endif /* !CONFIG_PM_SLEEP */
528 * Platform "fixup" functions - allow the platform to have their say
529 * about devices and actions that the general device layer doesn't
532 /* Notify platform of device discovery */
533 extern int (*platform_notify)(struct device * dev);
535 extern int (*platform_notify_remove)(struct device * dev);
539 * get_device - atomically increment the reference count for the device.
542 extern struct device * get_device(struct device * dev);
543 extern void put_device(struct device * dev);
546 /* drivers/base/power/shutdown.c */
547 extern void device_shutdown(void);
549 /* drivers/base/sys.c */
550 extern void sysdev_shutdown(void);
552 /* debugging and troubleshooting/diagnostic helpers. */
553 extern const char *dev_driver_string(struct device *dev);
554 #define dev_printk(level, dev, format, arg...) \
555 printk(level "%s %s: " format , dev_driver_string(dev) , (dev)->bus_id , ## arg)
557 #define dev_emerg(dev, format, arg...) \
558 dev_printk(KERN_EMERG , dev , format , ## arg)
559 #define dev_alert(dev, format, arg...) \
560 dev_printk(KERN_ALERT , dev , format , ## arg)
561 #define dev_crit(dev, format, arg...) \
562 dev_printk(KERN_CRIT , dev , format , ## arg)
563 #define dev_err(dev, format, arg...) \
564 dev_printk(KERN_ERR , dev , format , ## arg)
565 #define dev_warn(dev, format, arg...) \
566 dev_printk(KERN_WARNING , dev , format , ## arg)
567 #define dev_notice(dev, format, arg...) \
568 dev_printk(KERN_NOTICE , dev , format , ## arg)
569 #define dev_info(dev, format, arg...) \
570 dev_printk(KERN_INFO , dev , format , ## arg)
573 #define dev_dbg(dev, format, arg...) \
574 dev_printk(KERN_DEBUG , dev , format , ## arg)
576 static inline int __attribute__ ((format (printf, 2, 3)))
577 dev_dbg(struct device * dev, const char * fmt, ...)
584 #define dev_vdbg dev_dbg
586 static inline int __attribute__ ((format (printf, 2, 3)))
587 dev_vdbg(struct device * dev, const char * fmt, ...)
593 /* Create alias, so I can be autoloaded. */
594 #define MODULE_ALIAS_CHARDEV(major,minor) \
595 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
596 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
597 MODULE_ALIAS("char-major-" __stringify(major) "-*")
598 #endif /* _DEVICE_H_ */