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;
83 unsigned int multithread_probe:1;
86 extern int __must_check bus_register(struct bus_type * bus);
87 extern void bus_unregister(struct bus_type * bus);
89 extern int __must_check bus_rescan_devices(struct bus_type * bus);
91 /* iterator helpers for buses */
93 int bus_for_each_dev(struct bus_type * bus, struct device * start, void * data,
94 int (*fn)(struct device *, void *));
95 struct device * bus_find_device(struct bus_type *bus, struct device *start,
96 void *data, int (*match)(struct device *, void *));
98 int __must_check bus_for_each_drv(struct bus_type *bus,
99 struct device_driver *start, void *data,
100 int (*fn)(struct device_driver *, void *));
103 * Bus notifiers: Get notified of addition/removal of devices
104 * and binding/unbinding of drivers to devices.
105 * In the long run, it should be a replacement for the platform
108 struct notifier_block;
110 extern int bus_register_notifier(struct bus_type *bus,
111 struct notifier_block *nb);
112 extern int bus_unregister_notifier(struct bus_type *bus,
113 struct notifier_block *nb);
115 /* All 4 notifers below get called with the target struct device *
116 * as an argument. Note that those functions are likely to be called
117 * with the device semaphore held in the core, so be careful.
119 #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
120 #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */
121 #define BUS_NOTIFY_BOUND_DRIVER 0x00000003 /* driver bound to device */
122 #define BUS_NOTIFY_UNBIND_DRIVER 0x00000004 /* driver about to be
125 struct device_driver {
127 struct bus_type * bus;
129 struct completion unloaded;
131 struct klist klist_devices;
132 struct klist_node knode_bus;
134 struct module * owner;
135 const char * mod_name; /* used for built-in modules */
136 struct module_kobject * mkobj;
138 int (*probe) (struct device * dev);
139 int (*remove) (struct device * dev);
140 void (*shutdown) (struct device * dev);
141 int (*suspend) (struct device * dev, pm_message_t state);
142 int (*resume) (struct device * dev);
146 extern int __must_check driver_register(struct device_driver * drv);
147 extern void driver_unregister(struct device_driver * drv);
149 extern struct device_driver * get_driver(struct device_driver * drv);
150 extern void put_driver(struct device_driver * drv);
151 extern struct device_driver *driver_find(const char *name, struct bus_type *bus);
152 extern int driver_probe_done(void);
154 /* sysfs interface for exporting driver attributes */
156 struct driver_attribute {
157 struct attribute attr;
158 ssize_t (*show)(struct device_driver *, char * buf);
159 ssize_t (*store)(struct device_driver *, const char * buf, size_t count);
162 #define DRIVER_ATTR(_name,_mode,_show,_store) \
163 struct driver_attribute driver_attr_##_name = __ATTR(_name,_mode,_show,_store)
165 extern int __must_check driver_create_file(struct device_driver *,
166 struct driver_attribute *);
167 extern void driver_remove_file(struct device_driver *, struct driver_attribute *);
169 extern int __must_check driver_for_each_device(struct device_driver * drv,
170 struct device *start, void *data,
171 int (*fn)(struct device *, void *));
172 struct device * driver_find_device(struct device_driver *drv,
173 struct device *start, void *data,
174 int (*match)(struct device *, void *));
181 struct module * owner;
183 struct subsystem subsys;
184 struct list_head children;
185 struct list_head devices;
186 struct list_head interfaces;
187 struct kset class_dirs;
188 struct semaphore sem; /* locks both the children and interfaces lists */
190 struct class_attribute * class_attrs;
191 struct class_device_attribute * class_dev_attrs;
192 struct device_attribute * dev_attrs;
194 int (*uevent)(struct class_device *dev, char **envp,
195 int num_envp, char *buffer, int buffer_size);
196 int (*dev_uevent)(struct device *dev, char **envp, int num_envp,
197 char *buffer, int buffer_size);
199 void (*release)(struct class_device *dev);
200 void (*class_release)(struct class *class);
201 void (*dev_release)(struct device *dev);
203 int (*suspend)(struct device *, pm_message_t state);
204 int (*resume)(struct device *);
207 extern int __must_check class_register(struct class *);
208 extern void class_unregister(struct class *);
211 struct class_attribute {
212 struct attribute attr;
213 ssize_t (*show)(struct class *, char * buf);
214 ssize_t (*store)(struct class *, const char * buf, size_t count);
217 #define CLASS_ATTR(_name,_mode,_show,_store) \
218 struct class_attribute class_attr_##_name = __ATTR(_name,_mode,_show,_store)
220 extern int __must_check class_create_file(struct class *,
221 const struct class_attribute *);
222 extern void class_remove_file(struct class *, const struct class_attribute *);
224 struct class_device_attribute {
225 struct attribute attr;
226 ssize_t (*show)(struct class_device *, char * buf);
227 ssize_t (*store)(struct class_device *, const char * buf, size_t count);
230 #define CLASS_DEVICE_ATTR(_name,_mode,_show,_store) \
231 struct class_device_attribute class_device_attr_##_name = \
232 __ATTR(_name,_mode,_show,_store)
234 extern int __must_check class_device_create_file(struct class_device *,
235 const struct class_device_attribute *);
238 * struct class_device - class devices
239 * @class: pointer to the parent class for this class device. This is required.
240 * @devt: for internal use by the driver core only.
241 * @node: for internal use by the driver core only.
242 * @kobj: for internal use by the driver core only.
243 * @devt_attr: for internal use by the driver core only.
244 * @groups: optional additional groups to be created
245 * @dev: if set, a symlink to the struct device is created in the sysfs
246 * directory for this struct class device.
247 * @class_data: pointer to whatever you want to store here for this struct
248 * class_device. Use class_get_devdata() and class_set_devdata() to get and
250 * @parent: pointer to a struct class_device that is the parent of this struct
251 * class_device. If NULL, this class_device will show up at the root of the
252 * struct class in sysfs (which is probably what you want to have happen.)
253 * @release: pointer to a release function for this struct class_device. If
254 * set, this will be called instead of the class specific release function.
255 * Only use this if you want to override the default release function, like
256 * when you are nesting class_device structures.
257 * @uevent: pointer to a uevent function for this struct class_device. If
258 * set, this will be called instead of the class specific uevent function.
259 * Only use this if you want to override the default uevent function, like
260 * when you are nesting class_device structures.
262 struct class_device {
263 struct list_head node;
266 struct class * class; /* required */
267 dev_t devt; /* dev_t, creates the sysfs "dev" */
268 struct class_device_attribute *devt_attr;
269 struct class_device_attribute uevent_attr;
270 struct device * dev; /* not necessary, but nice to have */
271 void * class_data; /* class-specific data */
272 struct class_device *parent; /* parent of this child device, if there is one */
273 struct attribute_group ** groups; /* optional groups */
275 void (*release)(struct class_device *dev);
276 int (*uevent)(struct class_device *dev, char **envp,
277 int num_envp, char *buffer, int buffer_size);
278 char class_id[BUS_ID_SIZE]; /* unique to this class */
282 class_get_devdata (struct class_device *dev)
284 return dev->class_data;
288 class_set_devdata (struct class_device *dev, void *data)
290 dev->class_data = data;
294 extern int __must_check class_device_register(struct class_device *);
295 extern void class_device_unregister(struct class_device *);
296 extern void class_device_initialize(struct class_device *);
297 extern int __must_check class_device_add(struct class_device *);
298 extern void class_device_del(struct class_device *);
300 extern struct class_device * class_device_get(struct class_device *);
301 extern void class_device_put(struct class_device *);
303 extern void class_device_remove_file(struct class_device *,
304 const struct class_device_attribute *);
305 extern int __must_check class_device_create_bin_file(struct class_device *,
306 struct bin_attribute *);
307 extern void class_device_remove_bin_file(struct class_device *,
308 struct bin_attribute *);
310 struct class_interface {
311 struct list_head node;
314 int (*add) (struct class_device *, struct class_interface *);
315 void (*remove) (struct class_device *, struct class_interface *);
316 int (*add_dev) (struct device *, struct class_interface *);
317 void (*remove_dev) (struct device *, struct class_interface *);
320 extern int __must_check class_interface_register(struct class_interface *);
321 extern void class_interface_unregister(struct class_interface *);
323 extern struct class *class_create(struct module *owner, const char *name);
324 extern void class_destroy(struct class *cls);
325 extern struct class_device *class_device_create(struct class *cls,
326 struct class_device *parent,
328 struct device *device,
329 const char *fmt, ...)
330 __attribute__((format(printf,5,6)));
331 extern void class_device_destroy(struct class *cls, dev_t devt);
334 * The type of device, "struct device" is embedded in. A class
335 * or bus can contain devices of different types
336 * like "partitions" and "disks", "mouse" and "event".
337 * This identifies the device type and carries type-specific
338 * information, equivalent to the kobj_type of a kobject.
339 * If "name" is specified, the uevent will contain it in
340 * the DEVTYPE variable.
344 struct attribute_group **groups;
345 int (*uevent)(struct device *dev, char **envp, int num_envp,
346 char *buffer, int buffer_size);
347 void (*release)(struct device *dev);
350 /* interface for exporting device attributes */
351 struct device_attribute {
352 struct attribute attr;
353 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
355 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
356 const char *buf, size_t count);
359 #define DEVICE_ATTR(_name,_mode,_show,_store) \
360 struct device_attribute dev_attr_##_name = __ATTR(_name,_mode,_show,_store)
362 extern int __must_check device_create_file(struct device *device,
363 struct device_attribute * entry);
364 extern void device_remove_file(struct device * dev, struct device_attribute * attr);
365 extern int __must_check device_create_bin_file(struct device *dev,
366 struct bin_attribute *attr);
367 extern void device_remove_bin_file(struct device *dev,
368 struct bin_attribute *attr);
369 extern int device_schedule_callback(struct device *dev,
370 void (*func)(struct device *));
372 /* device resource management */
373 typedef void (*dr_release_t)(struct device *dev, void *res);
374 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
376 #ifdef CONFIG_DEBUG_DEVRES
377 extern void * __devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
379 #define devres_alloc(release, size, gfp) \
380 __devres_alloc(release, size, gfp, #release)
382 extern void * devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
384 extern void devres_free(void *res);
385 extern void devres_add(struct device *dev, void *res);
386 extern void * devres_find(struct device *dev, dr_release_t release,
387 dr_match_t match, void *match_data);
388 extern void * devres_get(struct device *dev, void *new_res,
389 dr_match_t match, void *match_data);
390 extern void * devres_remove(struct device *dev, dr_release_t release,
391 dr_match_t match, void *match_data);
392 extern int devres_destroy(struct device *dev, dr_release_t release,
393 dr_match_t match, void *match_data);
396 extern void * __must_check devres_open_group(struct device *dev, void *id,
398 extern void devres_close_group(struct device *dev, void *id);
399 extern void devres_remove_group(struct device *dev, void *id);
400 extern int devres_release_group(struct device *dev, void *id);
402 /* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
403 extern void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp);
404 extern void devm_kfree(struct device *dev, void *p);
407 struct klist klist_children;
408 struct klist_node knode_parent; /* node in sibling list */
409 struct klist_node knode_driver;
410 struct klist_node knode_bus;
411 struct device * parent;
414 char bus_id[BUS_ID_SIZE]; /* position on parent bus */
415 struct device_type *type;
416 unsigned is_registered:1;
417 struct device_attribute uevent_attr;
418 struct device_attribute *devt_attr;
420 struct semaphore sem; /* semaphore to synchronize calls to
424 struct bus_type * bus; /* type of bus device is on */
425 struct device_driver *driver; /* which driver has allocated this
427 void *driver_data; /* data private to the driver */
428 void *platform_data; /* Platform specific data, device
429 core doesn't touch it */
430 struct dev_pm_info power;
433 int numa_node; /* NUMA node this device is close to */
435 u64 *dma_mask; /* dma mask (if dma'able device) */
436 u64 coherent_dma_mask;/* Like dma_mask, but for
437 alloc_coherent mappings as
438 not all hardware supports
439 64 bit addresses for consistent
440 allocations such descriptors. */
442 struct list_head dma_pools; /* dma pools (if dma'ble) */
444 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
446 /* arch specific additions */
447 struct dev_archdata archdata;
449 spinlock_t devres_lock;
450 struct list_head devres_head;
452 /* class_device migration path */
453 struct list_head node;
455 dev_t devt; /* dev_t, creates the sysfs "dev" */
456 struct attribute_group **groups; /* optional groups */
459 void (*release)(struct device * dev);
463 static inline int dev_to_node(struct device *dev)
465 return dev->numa_node;
467 static inline void set_dev_node(struct device *dev, int node)
469 dev->numa_node = node;
472 static inline int dev_to_node(struct device *dev)
476 static inline void set_dev_node(struct device *dev, int node)
482 dev_get_drvdata (struct device *dev)
484 return dev->driver_data;
488 dev_set_drvdata (struct device *dev, void *data)
490 dev->driver_data = data;
493 static inline int device_is_registered(struct device *dev)
495 return dev->is_registered;
498 void driver_init(void);
501 * High level routines for use by the bus drivers
503 extern int __must_check device_register(struct device * dev);
504 extern void device_unregister(struct device * dev);
505 extern void device_initialize(struct device * dev);
506 extern int __must_check device_add(struct device * dev);
507 extern void device_del(struct device * dev);
508 extern int device_for_each_child(struct device *, void *,
509 int (*fn)(struct device *, void *));
510 extern struct device *device_find_child(struct device *, void *data,
511 int (*match)(struct device *, void *));
512 extern int device_rename(struct device *dev, char *new_name);
513 extern int device_move(struct device *dev, struct device *new_parent);
516 * Manual binding of a device to driver. See drivers/base/bus.c
517 * for information on use.
519 extern int __must_check device_bind_driver(struct device *dev);
520 extern void device_release_driver(struct device * dev);
521 extern int __must_check device_attach(struct device * dev);
522 extern int __must_check driver_attach(struct device_driver *drv);
523 extern int __must_check device_reprobe(struct device *dev);
526 * Easy functions for dynamically creating devices on the fly
528 extern struct device *device_create(struct class *cls, struct device *parent,
529 dev_t devt, const char *fmt, ...)
530 __attribute__((format(printf,4,5)));
531 extern void device_destroy(struct class *cls, dev_t devt);
534 * Platform "fixup" functions - allow the platform to have their say
535 * about devices and actions that the general device layer doesn't
538 /* Notify platform of device discovery */
539 extern int (*platform_notify)(struct device * dev);
541 extern int (*platform_notify_remove)(struct device * dev);
545 * get_device - atomically increment the reference count for the device.
548 extern struct device * get_device(struct device * dev);
549 extern void put_device(struct device * dev);
552 /* drivers/base/power/shutdown.c */
553 extern void device_shutdown(void);
556 /* drivers/base/firmware.c */
557 extern int __must_check firmware_register(struct subsystem *);
558 extern void firmware_unregister(struct subsystem *);
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)
566 #define dev_dbg(dev, format, arg...) \
567 dev_printk(KERN_DEBUG , dev , format , ## arg)
569 #define dev_dbg(dev, format, arg...) do { (void)(dev); } while (0)
572 #define dev_err(dev, format, arg...) \
573 dev_printk(KERN_ERR , dev , format , ## arg)
574 #define dev_info(dev, format, arg...) \
575 dev_printk(KERN_INFO , dev , format , ## arg)
576 #define dev_warn(dev, format, arg...) \
577 dev_printk(KERN_WARNING , dev , format , ## arg)
578 #define dev_notice(dev, format, arg...) \
579 dev_printk(KERN_NOTICE , dev , format , ## arg)
581 /* Create alias, so I can be autoloaded. */
582 #define MODULE_ALIAS_CHARDEV(major,minor) \
583 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
584 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
585 MODULE_ALIAS("char-major-" __stringify(major) "-*")
586 #endif /* _DEVICE_H_ */