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
39 struct bus_attribute {
40 struct attribute attr;
41 ssize_t (*show)(struct bus_type *, char * buf);
42 ssize_t (*store)(struct bus_type *, 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 module * owner;
56 struct subsystem subsys;
59 struct klist klist_devices;
60 struct klist klist_drivers;
62 struct blocking_notifier_head bus_notifier;
64 struct bus_attribute * bus_attrs;
65 struct device_attribute * dev_attrs;
66 struct driver_attribute * drv_attrs;
67 struct bus_attribute drivers_autoprobe_attr;
68 struct bus_attribute drivers_probe_attr;
70 int (*match)(struct device * dev, struct device_driver * drv);
71 int (*uevent)(struct device *dev, char **envp,
72 int num_envp, char *buffer, int buffer_size);
73 int (*probe)(struct device * dev);
74 int (*remove)(struct device * dev);
75 void (*shutdown)(struct device * dev);
77 int (*suspend)(struct device * dev, pm_message_t state);
78 int (*suspend_late)(struct device * dev, pm_message_t state);
79 int (*resume_early)(struct device * dev);
80 int (*resume)(struct device * dev);
82 unsigned int drivers_autoprobe:1;
85 extern int __must_check bus_register(struct bus_type * bus);
86 extern void bus_unregister(struct bus_type * bus);
88 extern int __must_check bus_rescan_devices(struct bus_type * bus);
90 /* iterator helpers for buses */
92 int bus_for_each_dev(struct bus_type * bus, struct device * start, void * data,
93 int (*fn)(struct device *, void *));
94 struct device * bus_find_device(struct bus_type *bus, struct device *start,
95 void *data, int (*match)(struct device *, void *));
97 int __must_check bus_for_each_drv(struct bus_type *bus,
98 struct device_driver *start, void *data,
99 int (*fn)(struct device_driver *, void *));
102 * Bus notifiers: Get notified of addition/removal of devices
103 * and binding/unbinding of drivers to devices.
104 * In the long run, it should be a replacement for the platform
107 struct notifier_block;
109 extern int bus_register_notifier(struct bus_type *bus,
110 struct notifier_block *nb);
111 extern int bus_unregister_notifier(struct bus_type *bus,
112 struct notifier_block *nb);
114 /* All 4 notifers below get called with the target struct device *
115 * as an argument. Note that those functions are likely to be called
116 * with the device semaphore held in the core, so be careful.
118 #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
119 #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */
120 #define BUS_NOTIFY_BOUND_DRIVER 0x00000003 /* driver bound to device */
121 #define BUS_NOTIFY_UNBIND_DRIVER 0x00000004 /* driver about to be
124 struct device_driver {
126 struct bus_type * bus;
128 struct completion unloaded;
130 struct klist klist_devices;
131 struct klist_node knode_bus;
133 struct module * owner;
134 const char * mod_name; /* used for built-in modules */
135 struct module_kobject * mkobj;
137 int (*probe) (struct device * dev);
138 int (*remove) (struct device * dev);
139 void (*shutdown) (struct device * dev);
140 int (*suspend) (struct device * dev, pm_message_t state);
141 int (*resume) (struct device * dev);
143 unsigned int multithread_probe:1;
147 extern int __must_check driver_register(struct device_driver * drv);
148 extern void driver_unregister(struct device_driver * drv);
150 extern struct device_driver * get_driver(struct device_driver * drv);
151 extern void put_driver(struct device_driver * drv);
152 extern struct device_driver *driver_find(const char *name, struct bus_type *bus);
153 extern int driver_probe_done(void);
155 /* sysfs interface for exporting driver attributes */
157 struct driver_attribute {
158 struct attribute attr;
159 ssize_t (*show)(struct device_driver *, char * buf);
160 ssize_t (*store)(struct device_driver *, const char * buf, size_t count);
163 #define DRIVER_ATTR(_name,_mode,_show,_store) \
164 struct driver_attribute driver_attr_##_name = __ATTR(_name,_mode,_show,_store)
166 extern int __must_check driver_create_file(struct device_driver *,
167 struct driver_attribute *);
168 extern void driver_remove_file(struct device_driver *, struct driver_attribute *);
170 extern int __must_check driver_for_each_device(struct device_driver * drv,
171 struct device *start, void *data,
172 int (*fn)(struct device *, void *));
173 struct device * driver_find_device(struct device_driver *drv,
174 struct device *start, void *data,
175 int (*match)(struct device *, void *));
182 struct module * owner;
184 struct subsystem subsys;
185 struct list_head children;
186 struct list_head devices;
187 struct list_head interfaces;
188 struct kset class_dirs;
189 struct semaphore sem; /* locks both the children and interfaces lists */
191 struct class_attribute * class_attrs;
192 struct class_device_attribute * class_dev_attrs;
193 struct device_attribute * dev_attrs;
195 int (*uevent)(struct class_device *dev, char **envp,
196 int num_envp, char *buffer, int buffer_size);
197 int (*dev_uevent)(struct device *dev, char **envp, int num_envp,
198 char *buffer, int buffer_size);
200 void (*release)(struct class_device *dev);
201 void (*class_release)(struct class *class);
202 void (*dev_release)(struct device *dev);
204 int (*suspend)(struct device *, pm_message_t state);
205 int (*resume)(struct device *);
208 extern int __must_check class_register(struct class *);
209 extern void class_unregister(struct class *);
212 struct class_attribute {
213 struct attribute attr;
214 ssize_t (*show)(struct class *, char * buf);
215 ssize_t (*store)(struct class *, const char * buf, size_t count);
218 #define CLASS_ATTR(_name,_mode,_show,_store) \
219 struct class_attribute class_attr_##_name = __ATTR(_name,_mode,_show,_store)
221 extern int __must_check class_create_file(struct class *,
222 const struct class_attribute *);
223 extern void class_remove_file(struct class *, const struct class_attribute *);
225 struct class_device_attribute {
226 struct attribute attr;
227 ssize_t (*show)(struct class_device *, char * buf);
228 ssize_t (*store)(struct class_device *, const char * buf, size_t count);
231 #define CLASS_DEVICE_ATTR(_name,_mode,_show,_store) \
232 struct class_device_attribute class_device_attr_##_name = \
233 __ATTR(_name,_mode,_show,_store)
235 extern int __must_check class_device_create_file(struct class_device *,
236 const struct class_device_attribute *);
239 * struct class_device - class devices
240 * @class: pointer to the parent class for this class device. This is required.
241 * @devt: for internal use by the driver core only.
242 * @node: for internal use by the driver core only.
243 * @kobj: for internal use by the driver core only.
244 * @devt_attr: for internal use by the driver core only.
245 * @groups: optional additional groups to be created
246 * @dev: if set, a symlink to the struct device is created in the sysfs
247 * directory for this struct class device.
248 * @class_data: pointer to whatever you want to store here for this struct
249 * class_device. Use class_get_devdata() and class_set_devdata() to get and
251 * @parent: pointer to a struct class_device that is the parent of this struct
252 * class_device. If NULL, this class_device will show up at the root of the
253 * struct class in sysfs (which is probably what you want to have happen.)
254 * @release: pointer to a release function for this struct class_device. If
255 * set, this will be called instead of the class specific release function.
256 * Only use this if you want to override the default release function, like
257 * when you are nesting class_device structures.
258 * @uevent: pointer to a uevent function for this struct class_device. If
259 * set, this will be called instead of the class specific uevent function.
260 * Only use this if you want to override the default uevent function, like
261 * when you are nesting class_device structures.
263 struct class_device {
264 struct list_head node;
267 struct class * class; /* required */
268 dev_t devt; /* dev_t, creates the sysfs "dev" */
269 struct class_device_attribute *devt_attr;
270 struct class_device_attribute uevent_attr;
271 struct device * dev; /* not necessary, but nice to have */
272 void * class_data; /* class-specific data */
273 struct class_device *parent; /* parent of this child device, if there is one */
274 struct attribute_group ** groups; /* optional groups */
276 void (*release)(struct class_device *dev);
277 int (*uevent)(struct class_device *dev, char **envp,
278 int num_envp, char *buffer, int buffer_size);
279 char class_id[BUS_ID_SIZE]; /* unique to this class */
283 class_get_devdata (struct class_device *dev)
285 return dev->class_data;
289 class_set_devdata (struct class_device *dev, void *data)
291 dev->class_data = data;
295 extern int __must_check class_device_register(struct class_device *);
296 extern void class_device_unregister(struct class_device *);
297 extern void class_device_initialize(struct class_device *);
298 extern int __must_check class_device_add(struct class_device *);
299 extern void class_device_del(struct class_device *);
301 extern struct class_device * class_device_get(struct class_device *);
302 extern void class_device_put(struct class_device *);
304 extern void class_device_remove_file(struct class_device *,
305 const struct class_device_attribute *);
306 extern int __must_check class_device_create_bin_file(struct class_device *,
307 struct bin_attribute *);
308 extern void class_device_remove_bin_file(struct class_device *,
309 struct bin_attribute *);
311 struct class_interface {
312 struct list_head node;
315 int (*add) (struct class_device *, struct class_interface *);
316 void (*remove) (struct class_device *, struct class_interface *);
317 int (*add_dev) (struct device *, struct class_interface *);
318 void (*remove_dev) (struct device *, struct class_interface *);
321 extern int __must_check class_interface_register(struct class_interface *);
322 extern void class_interface_unregister(struct class_interface *);
324 extern struct class *class_create(struct module *owner, const char *name);
325 extern void class_destroy(struct class *cls);
326 extern struct class_device *class_device_create(struct class *cls,
327 struct class_device *parent,
329 struct device *device,
330 const char *fmt, ...)
331 __attribute__((format(printf,5,6)));
332 extern void class_device_destroy(struct class *cls, dev_t devt);
335 struct attribute_group **groups;
336 int (*uevent)(struct device *dev, char **envp, int num_envp,
337 char *buffer, int buffer_size);
338 void (*release)(struct device *dev);
341 /* interface for exporting device attributes */
342 struct device_attribute {
343 struct attribute attr;
344 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
346 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
347 const char *buf, size_t count);
350 #define DEVICE_ATTR(_name,_mode,_show,_store) \
351 struct device_attribute dev_attr_##_name = __ATTR(_name,_mode,_show,_store)
353 extern int __must_check device_create_file(struct device *device,
354 struct device_attribute * entry);
355 extern void device_remove_file(struct device * dev, struct device_attribute * attr);
356 extern int __must_check device_create_bin_file(struct device *dev,
357 struct bin_attribute *attr);
358 extern void device_remove_bin_file(struct device *dev,
359 struct bin_attribute *attr);
360 extern int device_schedule_callback(struct device *dev,
361 void (*func)(struct device *));
363 /* device resource management */
364 typedef void (*dr_release_t)(struct device *dev, void *res);
365 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
367 #ifdef CONFIG_DEBUG_DEVRES
368 extern void * __devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
370 #define devres_alloc(release, size, gfp) \
371 __devres_alloc(release, size, gfp, #release)
373 extern void * devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
375 extern void devres_free(void *res);
376 extern void devres_add(struct device *dev, void *res);
377 extern void * devres_find(struct device *dev, dr_release_t release,
378 dr_match_t match, void *match_data);
379 extern void * devres_get(struct device *dev, void *new_res,
380 dr_match_t match, void *match_data);
381 extern void * devres_remove(struct device *dev, dr_release_t release,
382 dr_match_t match, void *match_data);
383 extern int devres_destroy(struct device *dev, dr_release_t release,
384 dr_match_t match, void *match_data);
387 extern void * __must_check devres_open_group(struct device *dev, void *id,
389 extern void devres_close_group(struct device *dev, void *id);
390 extern void devres_remove_group(struct device *dev, void *id);
391 extern int devres_release_group(struct device *dev, void *id);
393 /* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
394 extern void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp);
395 extern void devm_kfree(struct device *dev, void *p);
398 struct klist klist_children;
399 struct klist_node knode_parent; /* node in sibling list */
400 struct klist_node knode_driver;
401 struct klist_node knode_bus;
402 struct device * parent;
405 char bus_id[BUS_ID_SIZE]; /* position on parent bus */
406 struct device_type *type;
407 unsigned is_registered:1;
408 struct device_attribute uevent_attr;
409 struct device_attribute *devt_attr;
411 struct semaphore sem; /* semaphore to synchronize calls to
415 struct bus_type * bus; /* type of bus device is on */
416 struct device_driver *driver; /* which driver has allocated this
418 void *driver_data; /* data private to the driver */
419 void *platform_data; /* Platform specific data, device
420 core doesn't touch it */
421 struct dev_pm_info power;
424 int numa_node; /* NUMA node this device is close to */
426 u64 *dma_mask; /* dma mask (if dma'able device) */
427 u64 coherent_dma_mask;/* Like dma_mask, but for
428 alloc_coherent mappings as
429 not all hardware supports
430 64 bit addresses for consistent
431 allocations such descriptors. */
433 struct list_head dma_pools; /* dma pools (if dma'ble) */
435 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
437 /* arch specific additions */
438 struct dev_archdata archdata;
440 spinlock_t devres_lock;
441 struct list_head devres_head;
443 /* class_device migration path */
444 struct list_head node;
446 dev_t devt; /* dev_t, creates the sysfs "dev" */
447 struct attribute_group **groups; /* optional groups */
450 void (*release)(struct device * dev);
454 static inline int dev_to_node(struct device *dev)
456 return dev->numa_node;
458 static inline void set_dev_node(struct device *dev, int node)
460 dev->numa_node = node;
463 static inline int dev_to_node(struct device *dev)
467 static inline void set_dev_node(struct device *dev, int node)
473 dev_get_drvdata (struct device *dev)
475 return dev->driver_data;
479 dev_set_drvdata (struct device *dev, void *data)
481 dev->driver_data = data;
484 static inline int device_is_registered(struct device *dev)
486 return dev->is_registered;
489 void driver_init(void);
492 * High level routines for use by the bus drivers
494 extern int __must_check device_register(struct device * dev);
495 extern void device_unregister(struct device * dev);
496 extern void device_initialize(struct device * dev);
497 extern int __must_check device_add(struct device * dev);
498 extern void device_del(struct device * dev);
499 extern int device_for_each_child(struct device *, void *,
500 int (*fn)(struct device *, void *));
501 extern struct device *device_find_child(struct device *, void *data,
502 int (*match)(struct device *, void *));
503 extern int device_rename(struct device *dev, char *new_name);
504 extern int device_move(struct device *dev, struct device *new_parent);
507 * Manual binding of a device to driver. See drivers/base/bus.c
508 * for information on use.
510 extern int __must_check device_bind_driver(struct device *dev);
511 extern void device_release_driver(struct device * dev);
512 extern int __must_check device_attach(struct device * dev);
513 extern int __must_check driver_attach(struct device_driver *drv);
514 extern int __must_check device_reprobe(struct device *dev);
517 * Easy functions for dynamically creating devices on the fly
519 extern struct device *device_create(struct class *cls, struct device *parent,
520 dev_t devt, const char *fmt, ...)
521 __attribute__((format(printf,4,5)));
522 extern void device_destroy(struct class *cls, dev_t devt);
525 * Platform "fixup" functions - allow the platform to have their say
526 * about devices and actions that the general device layer doesn't
529 /* Notify platform of device discovery */
530 extern int (*platform_notify)(struct device * dev);
532 extern int (*platform_notify_remove)(struct device * dev);
536 * get_device - atomically increment the reference count for the device.
539 extern struct device * get_device(struct device * dev);
540 extern void put_device(struct device * dev);
543 /* drivers/base/power/shutdown.c */
544 extern void device_shutdown(void);
547 /* drivers/base/firmware.c */
548 extern int __must_check firmware_register(struct subsystem *);
549 extern void firmware_unregister(struct subsystem *);
551 /* debugging and troubleshooting/diagnostic helpers. */
552 extern const char *dev_driver_string(struct device *dev);
553 #define dev_printk(level, dev, format, arg...) \
554 printk(level "%s %s: " format , dev_driver_string(dev) , (dev)->bus_id , ## arg)
557 #define dev_dbg(dev, format, arg...) \
558 dev_printk(KERN_DEBUG , dev , format , ## arg)
560 #define dev_dbg(dev, format, arg...) do { (void)(dev); } while (0)
563 #define dev_err(dev, format, arg...) \
564 dev_printk(KERN_ERR , dev , format , ## arg)
565 #define dev_info(dev, format, arg...) \
566 dev_printk(KERN_INFO , dev , format , ## arg)
567 #define dev_warn(dev, format, arg...) \
568 dev_printk(KERN_WARNING , dev , format , ## arg)
569 #define dev_notice(dev, format, arg...) \
570 dev_printk(KERN_NOTICE , dev , format , ## arg)
572 /* Create alias, so I can be autoloaded. */
573 #define MODULE_ALIAS_CHARDEV(major,minor) \
574 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
575 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
576 MODULE_ALIAS("char-major-" __stringify(major) "-*")
577 #endif /* _DEVICE_H_ */