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
*);
56 struct kset
*drivers_kset
;
57 struct kset
*devices_kset
;
58 struct klist klist_devices
;
59 struct klist klist_drivers
;
61 struct blocking_notifier_head bus_notifier
;
63 struct bus_attribute
* bus_attrs
;
64 struct device_attribute
* dev_attrs
;
65 struct driver_attribute
* drv_attrs
;
67 int (*match
)(struct device
* dev
, struct device_driver
* drv
);
68 int (*uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
69 int (*probe
)(struct device
* dev
);
70 int (*remove
)(struct device
* dev
);
71 void (*shutdown
)(struct device
* dev
);
73 int (*suspend
)(struct device
* dev
, pm_message_t state
);
74 int (*suspend_late
)(struct device
* dev
, pm_message_t state
);
75 int (*resume_early
)(struct device
* dev
);
76 int (*resume
)(struct device
* dev
);
78 unsigned int drivers_autoprobe
:1;
81 extern int __must_check
bus_register(struct bus_type
* bus
);
82 extern void bus_unregister(struct bus_type
* bus
);
84 extern int __must_check
bus_rescan_devices(struct bus_type
* bus
);
86 /* iterator helpers for buses */
88 int bus_for_each_dev(struct bus_type
* bus
, struct device
* start
, void * data
,
89 int (*fn
)(struct device
*, void *));
90 struct device
* bus_find_device(struct bus_type
*bus
, struct device
*start
,
91 void *data
, int (*match
)(struct device
*, void *));
93 int __must_check
bus_for_each_drv(struct bus_type
*bus
,
94 struct device_driver
*start
, void *data
,
95 int (*fn
)(struct device_driver
*, void *));
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
);
122 struct device_driver
{
124 struct bus_type
* bus
;
127 struct klist klist_devices
;
128 struct klist_node knode_bus
;
130 struct module
* owner
;
131 const char * mod_name
; /* used for built-in modules */
132 struct module_kobject
* mkobj
;
134 int (*probe
) (struct device
* dev
);
135 int (*remove
) (struct device
* dev
);
136 void (*shutdown
) (struct device
* dev
);
137 int (*suspend
) (struct device
* dev
, pm_message_t state
);
138 int (*resume
) (struct device
* dev
);
142 extern int __must_check
driver_register(struct device_driver
* drv
);
143 extern void driver_unregister(struct device_driver
* drv
);
145 extern struct device_driver
* get_driver(struct device_driver
* drv
);
146 extern void put_driver(struct device_driver
* drv
);
147 extern struct device_driver
*driver_find(const char *name
, struct bus_type
*bus
);
148 extern int driver_probe_done(void);
150 /* sysfs interface for exporting driver attributes */
152 struct driver_attribute
{
153 struct attribute attr
;
154 ssize_t (*show
)(struct device_driver
*, char * buf
);
155 ssize_t (*store
)(struct device_driver
*, const char * buf
, size_t count
);
158 #define DRIVER_ATTR(_name,_mode,_show,_store) \
159 struct driver_attribute driver_attr_##_name = __ATTR(_name,_mode,_show,_store)
161 extern int __must_check
driver_create_file(struct device_driver
*,
162 struct driver_attribute
*);
163 extern void driver_remove_file(struct device_driver
*, struct driver_attribute
*);
165 extern int __must_check
driver_for_each_device(struct device_driver
* drv
,
166 struct device
*start
, void *data
,
167 int (*fn
)(struct device
*, void *));
168 struct device
* driver_find_device(struct device_driver
*drv
,
169 struct device
*start
, void *data
,
170 int (*match
)(struct device
*, void *));
177 struct module
* owner
;
180 struct list_head children
;
181 struct list_head devices
;
182 struct list_head interfaces
;
183 struct kset class_dirs
;
184 struct semaphore sem
; /* locks both the children and interfaces lists */
186 struct class_attribute
* class_attrs
;
187 struct class_device_attribute
* class_dev_attrs
;
188 struct device_attribute
* dev_attrs
;
190 int (*uevent
)(struct class_device
*dev
, struct kobj_uevent_env
*env
);
191 int (*dev_uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
193 void (*release
)(struct class_device
*dev
);
194 void (*class_release
)(struct class *class);
195 void (*dev_release
)(struct device
*dev
);
197 int (*suspend
)(struct device
*, pm_message_t state
);
198 int (*resume
)(struct device
*);
201 extern int __must_check
class_register(struct class *);
202 extern void class_unregister(struct class *);
205 struct class_attribute
{
206 struct attribute attr
;
207 ssize_t (*show
)(struct class *, char * buf
);
208 ssize_t (*store
)(struct class *, const char * buf
, size_t count
);
211 #define CLASS_ATTR(_name,_mode,_show,_store) \
212 struct class_attribute class_attr_##_name = __ATTR(_name,_mode,_show,_store)
214 extern int __must_check
class_create_file(struct class *,
215 const struct class_attribute
*);
216 extern void class_remove_file(struct class *, const struct class_attribute
*);
218 struct class_device_attribute
{
219 struct attribute attr
;
220 ssize_t (*show
)(struct class_device
*, char * buf
);
221 ssize_t (*store
)(struct class_device
*, const char * buf
, size_t count
);
224 #define CLASS_DEVICE_ATTR(_name,_mode,_show,_store) \
225 struct class_device_attribute class_device_attr_##_name = \
226 __ATTR(_name,_mode,_show,_store)
228 extern int __must_check
class_device_create_file(struct class_device
*,
229 const struct class_device_attribute
*);
232 * struct class_device - class devices
233 * @class: pointer to the parent class for this class device. This is required.
234 * @devt: for internal use by the driver core only.
235 * @node: for internal use by the driver core only.
236 * @kobj: for internal use by the driver core only.
237 * @groups: optional additional groups to be created
238 * @dev: if set, a symlink to the struct device is created in the sysfs
239 * directory for this struct class device.
240 * @class_data: pointer to whatever you want to store here for this struct
241 * class_device. Use class_get_devdata() and class_set_devdata() to get and
243 * @parent: pointer to a struct class_device that is the parent of this struct
244 * class_device. If NULL, this class_device will show up at the root of the
245 * struct class in sysfs (which is probably what you want to have happen.)
246 * @release: pointer to a release function for this struct class_device. If
247 * set, this will be called instead of the class specific release function.
248 * Only use this if you want to override the default release function, like
249 * when you are nesting class_device structures.
250 * @uevent: pointer to a uevent function for this struct class_device. If
251 * set, this will be called instead of the class specific uevent function.
252 * Only use this if you want to override the default uevent function, like
253 * when you are nesting class_device structures.
255 struct class_device
{
256 struct list_head node
;
259 struct class * class; /* required */
260 dev_t devt
; /* dev_t, creates the sysfs "dev" */
261 struct device
* dev
; /* not necessary, but nice to have */
262 void * class_data
; /* class-specific data */
263 struct class_device
*parent
; /* parent of this child device, if there is one */
264 struct attribute_group
** groups
; /* optional groups */
266 void (*release
)(struct class_device
*dev
);
267 int (*uevent
)(struct class_device
*dev
, struct kobj_uevent_env
*env
);
268 char class_id
[BUS_ID_SIZE
]; /* unique to this class */
272 class_get_devdata (struct class_device
*dev
)
274 return dev
->class_data
;
278 class_set_devdata (struct class_device
*dev
, void *data
)
280 dev
->class_data
= data
;
284 extern int __must_check
class_device_register(struct class_device
*);
285 extern void class_device_unregister(struct class_device
*);
286 extern void class_device_initialize(struct class_device
*);
287 extern int __must_check
class_device_add(struct class_device
*);
288 extern void class_device_del(struct class_device
*);
290 extern struct class_device
* class_device_get(struct class_device
*);
291 extern void class_device_put(struct class_device
*);
293 extern void class_device_remove_file(struct class_device
*,
294 const struct class_device_attribute
*);
295 extern int __must_check
class_device_create_bin_file(struct class_device
*,
296 struct bin_attribute
*);
297 extern void class_device_remove_bin_file(struct class_device
*,
298 struct bin_attribute
*);
300 struct class_interface
{
301 struct list_head node
;
304 int (*add
) (struct class_device
*, struct class_interface
*);
305 void (*remove
) (struct class_device
*, struct class_interface
*);
306 int (*add_dev
) (struct device
*, struct class_interface
*);
307 void (*remove_dev
) (struct device
*, struct class_interface
*);
310 extern int __must_check
class_interface_register(struct class_interface
*);
311 extern void class_interface_unregister(struct class_interface
*);
313 extern struct class *class_create(struct module
*owner
, const char *name
);
314 extern void class_destroy(struct class *cls
);
315 extern struct class_device
*class_device_create(struct class *cls
,
316 struct class_device
*parent
,
318 struct device
*device
,
319 const char *fmt
, ...)
320 __attribute__((format(printf
,5,6)));
321 extern void class_device_destroy(struct class *cls
, dev_t devt
);
324 * The type of device, "struct device" is embedded in. A class
325 * or bus can contain devices of different types
326 * like "partitions" and "disks", "mouse" and "event".
327 * This identifies the device type and carries type-specific
328 * information, equivalent to the kobj_type of a kobject.
329 * If "name" is specified, the uevent will contain it in
330 * the DEVTYPE variable.
334 struct attribute_group
**groups
;
335 int (*uevent
)(struct device
*dev
, struct kobj_uevent_env
*env
);
336 void (*release
)(struct device
*dev
);
337 int (*suspend
)(struct device
* dev
, pm_message_t state
);
338 int (*resume
)(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_owner(struct device
*dev
,
361 void (*func
)(struct device
*), struct module
*owner
);
363 /* This is a macro to avoid include problems with THIS_MODULE */
364 #define device_schedule_callback(dev, func) \
365 device_schedule_callback_owner(dev, func, THIS_MODULE)
367 /* device resource management */
368 typedef void (*dr_release_t
)(struct device
*dev
, void *res
);
369 typedef int (*dr_match_t
)(struct device
*dev
, void *res
, void *match_data
);
371 #ifdef CONFIG_DEBUG_DEVRES
372 extern void * __devres_alloc(dr_release_t release
, size_t size
, gfp_t gfp
,
374 #define devres_alloc(release, size, gfp) \
375 __devres_alloc(release, size, gfp, #release)
377 extern void * devres_alloc(dr_release_t release
, size_t size
, gfp_t gfp
);
379 extern void devres_free(void *res
);
380 extern void devres_add(struct device
*dev
, void *res
);
381 extern void * devres_find(struct device
*dev
, dr_release_t release
,
382 dr_match_t match
, void *match_data
);
383 extern void * devres_get(struct device
*dev
, void *new_res
,
384 dr_match_t match
, void *match_data
);
385 extern void * devres_remove(struct device
*dev
, dr_release_t release
,
386 dr_match_t match
, void *match_data
);
387 extern int devres_destroy(struct device
*dev
, dr_release_t release
,
388 dr_match_t match
, void *match_data
);
391 extern void * __must_check
devres_open_group(struct device
*dev
, void *id
,
393 extern void devres_close_group(struct device
*dev
, void *id
);
394 extern void devres_remove_group(struct device
*dev
, void *id
);
395 extern int devres_release_group(struct device
*dev
, void *id
);
397 /* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
398 extern void *devm_kzalloc(struct device
*dev
, size_t size
, gfp_t gfp
);
399 extern void devm_kfree(struct device
*dev
, void *p
);
402 struct klist klist_children
;
403 struct klist_node knode_parent
; /* node in sibling list */
404 struct klist_node knode_driver
;
405 struct klist_node knode_bus
;
406 struct device
*parent
;
409 char bus_id
[BUS_ID_SIZE
]; /* position on parent bus */
410 struct device_type
*type
;
411 unsigned is_registered
:1;
412 unsigned uevent_suppress
:1;
414 struct semaphore sem
; /* semaphore to synchronize calls to
418 struct bus_type
* bus
; /* type of bus device is on */
419 struct device_driver
*driver
; /* which driver has allocated this
421 void *driver_data
; /* data private to the driver */
422 void *platform_data
; /* Platform specific data, device
423 core doesn't touch it */
424 struct dev_pm_info power
;
427 int numa_node
; /* NUMA node this device is close to */
429 u64
*dma_mask
; /* dma mask (if dma'able device) */
430 u64 coherent_dma_mask
;/* Like dma_mask, but for
431 alloc_coherent mappings as
432 not all hardware supports
433 64 bit addresses for consistent
434 allocations such descriptors. */
436 struct list_head dma_pools
; /* dma pools (if dma'ble) */
438 struct dma_coherent_mem
*dma_mem
; /* internal for coherent mem
440 /* arch specific additions */
441 struct dev_archdata archdata
;
443 spinlock_t devres_lock
;
444 struct list_head devres_head
;
446 /* class_device migration path */
447 struct list_head node
;
449 dev_t devt
; /* dev_t, creates the sysfs "dev" */
450 struct attribute_group
**groups
; /* optional groups */
452 void (*release
)(struct device
* dev
);
456 static inline int dev_to_node(struct device
*dev
)
458 return dev
->numa_node
;
460 static inline void set_dev_node(struct device
*dev
, int node
)
462 dev
->numa_node
= node
;
465 static inline int dev_to_node(struct device
*dev
)
469 static inline void set_dev_node(struct device
*dev
, int node
)
475 dev_get_drvdata (struct device
*dev
)
477 return dev
->driver_data
;
481 dev_set_drvdata (struct device
*dev
, void *data
)
483 dev
->driver_data
= data
;
486 static inline int device_is_registered(struct device
*dev
)
488 return dev
->is_registered
;
491 void driver_init(void);
494 * High level routines for use by the bus drivers
496 extern int __must_check
device_register(struct device
* dev
);
497 extern void device_unregister(struct device
* dev
);
498 extern void device_initialize(struct device
* dev
);
499 extern int __must_check
device_add(struct device
* dev
);
500 extern void device_del(struct device
* dev
);
501 extern int device_for_each_child(struct device
*, void *,
502 int (*fn
)(struct device
*, void *));
503 extern struct device
*device_find_child(struct device
*, void *data
,
504 int (*match
)(struct device
*, void *));
505 extern int device_rename(struct device
*dev
, char *new_name
);
506 extern int device_move(struct device
*dev
, struct device
*new_parent
);
509 * Manual binding of a device to driver. See drivers/base/bus.c
510 * for information on use.
512 extern int __must_check
device_bind_driver(struct device
*dev
);
513 extern void device_release_driver(struct device
* dev
);
514 extern int __must_check
device_attach(struct device
* dev
);
515 extern int __must_check
driver_attach(struct device_driver
*drv
);
516 extern int __must_check
device_reprobe(struct device
*dev
);
519 * Easy functions for dynamically creating devices on the fly
521 extern struct device
*device_create(struct class *cls
, struct device
*parent
,
522 dev_t devt
, const char *fmt
, ...)
523 __attribute__((format(printf
,4,5)));
524 extern void device_destroy(struct class *cls
, dev_t devt
);
525 #ifdef CONFIG_PM_SLEEP
526 extern void destroy_suspended_device(struct class *cls
, dev_t devt
);
527 #else /* !CONFIG_PM_SLEEP */
528 static inline void destroy_suspended_device(struct class *cls
, dev_t devt
)
530 device_destroy(cls
, devt
);
532 #endif /* !CONFIG_PM_SLEEP */
535 * Platform "fixup" functions - allow the platform to have their say
536 * about devices and actions that the general device layer doesn't
539 /* Notify platform of device discovery */
540 extern int (*platform_notify
)(struct device
* dev
);
542 extern int (*platform_notify_remove
)(struct device
* dev
);
546 * get_device - atomically increment the reference count for the device.
549 extern struct device
* get_device(struct device
* dev
);
550 extern void put_device(struct device
* dev
);
553 /* drivers/base/power/shutdown.c */
554 extern void device_shutdown(void);
556 /* drivers/base/sys.c */
557 extern void sysdev_shutdown(void);
559 /* debugging and troubleshooting/diagnostic helpers. */
560 extern const char *dev_driver_string(struct device
*dev
);
561 #define dev_printk(level, dev, format, arg...) \
562 printk(level "%s %s: " format , dev_driver_string(dev) , (dev)->bus_id , ## arg)
564 #define dev_emerg(dev, format, arg...) \
565 dev_printk(KERN_EMERG , dev , format , ## arg)
566 #define dev_alert(dev, format, arg...) \
567 dev_printk(KERN_ALERT , dev , format , ## arg)
568 #define dev_crit(dev, format, arg...) \
569 dev_printk(KERN_CRIT , dev , format , ## arg)
570 #define dev_err(dev, format, arg...) \
571 dev_printk(KERN_ERR , dev , format , ## arg)
572 #define dev_warn(dev, format, arg...) \
573 dev_printk(KERN_WARNING , dev , format , ## arg)
574 #define dev_notice(dev, format, arg...) \
575 dev_printk(KERN_NOTICE , dev , format , ## arg)
576 #define dev_info(dev, format, arg...) \
577 dev_printk(KERN_INFO , dev , format , ## arg)
580 #define dev_dbg(dev, format, arg...) \
581 dev_printk(KERN_DEBUG , dev , format , ## arg)
583 static inline int __attribute__ ((format (printf
, 2, 3)))
584 dev_dbg(struct device
* dev
, const char * fmt
, ...)
591 #define dev_vdbg dev_dbg
593 static inline int __attribute__ ((format (printf
, 2, 3)))
594 dev_vdbg(struct device
* dev
, const char * fmt
, ...)
600 /* Create alias, so I can be autoloaded. */
601 #define MODULE_ALIAS_CHARDEV(major,minor) \
602 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
603 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
604 MODULE_ALIAS("char-major-" __stringify(major) "-*")
605 #endif /* _DEVICE_H_ */