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
;
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
);
145 extern int __must_check
driver_register(struct device_driver
* drv
);
146 extern void driver_unregister(struct device_driver
* drv
);
148 extern struct device_driver
* get_driver(struct device_driver
* drv
);
149 extern void put_driver(struct device_driver
* drv
);
150 extern struct device_driver
*driver_find(const char *name
, struct bus_type
*bus
);
151 extern int driver_probe_done(void);
153 /* sysfs interface for exporting driver attributes */
155 struct driver_attribute
{
156 struct attribute attr
;
157 ssize_t (*show
)(struct device_driver
*, char * buf
);
158 ssize_t (*store
)(struct device_driver
*, const char * buf
, size_t count
);
161 #define DRIVER_ATTR(_name,_mode,_show,_store) \
162 struct driver_attribute driver_attr_##_name = __ATTR(_name,_mode,_show,_store)
164 extern int __must_check
driver_create_file(struct device_driver
*,
165 struct driver_attribute
*);
166 extern void driver_remove_file(struct device_driver
*, struct driver_attribute
*);
168 extern int __must_check
driver_for_each_device(struct device_driver
* drv
,
169 struct device
*start
, void *data
,
170 int (*fn
)(struct device
*, void *));
171 struct device
* driver_find_device(struct device_driver
*drv
,
172 struct device
*start
, void *data
,
173 int (*match
)(struct device
*, void *));
180 struct module
* owner
;
182 struct subsystem subsys
;
183 struct list_head children
;
184 struct list_head devices
;
185 struct list_head interfaces
;
186 struct kset class_dirs
;
187 struct semaphore sem
; /* locks both the children and interfaces lists */
189 struct class_attribute
* class_attrs
;
190 struct class_device_attribute
* class_dev_attrs
;
191 struct device_attribute
* dev_attrs
;
193 int (*uevent
)(struct class_device
*dev
, char **envp
,
194 int num_envp
, char *buffer
, int buffer_size
);
195 int (*dev_uevent
)(struct device
*dev
, char **envp
, int num_envp
,
196 char *buffer
, int buffer_size
);
198 void (*release
)(struct class_device
*dev
);
199 void (*class_release
)(struct class *class);
200 void (*dev_release
)(struct device
*dev
);
202 int (*suspend
)(struct device
*, pm_message_t state
);
203 int (*resume
)(struct device
*);
206 extern int __must_check
class_register(struct class *);
207 extern void class_unregister(struct class *);
210 struct class_attribute
{
211 struct attribute attr
;
212 ssize_t (*show
)(struct class *, char * buf
);
213 ssize_t (*store
)(struct class *, const char * buf
, size_t count
);
216 #define CLASS_ATTR(_name,_mode,_show,_store) \
217 struct class_attribute class_attr_##_name = __ATTR(_name,_mode,_show,_store)
219 extern int __must_check
class_create_file(struct class *,
220 const struct class_attribute
*);
221 extern void class_remove_file(struct class *, const struct class_attribute
*);
223 struct class_device_attribute
{
224 struct attribute attr
;
225 ssize_t (*show
)(struct class_device
*, char * buf
);
226 ssize_t (*store
)(struct class_device
*, const char * buf
, size_t count
);
229 #define CLASS_DEVICE_ATTR(_name,_mode,_show,_store) \
230 struct class_device_attribute class_device_attr_##_name = \
231 __ATTR(_name,_mode,_show,_store)
233 extern int __must_check
class_device_create_file(struct class_device
*,
234 const struct class_device_attribute
*);
237 * struct class_device - class devices
238 * @class: pointer to the parent class for this class device. This is required.
239 * @devt: for internal use by the driver core only.
240 * @node: for internal use by the driver core only.
241 * @kobj: for internal use by the driver core only.
242 * @devt_attr: for internal use by the driver core only.
243 * @groups: optional additional groups to be created
244 * @dev: if set, a symlink to the struct device is created in the sysfs
245 * directory for this struct class device.
246 * @class_data: pointer to whatever you want to store here for this struct
247 * class_device. Use class_get_devdata() and class_set_devdata() to get and
249 * @parent: pointer to a struct class_device that is the parent of this struct
250 * class_device. If NULL, this class_device will show up at the root of the
251 * struct class in sysfs (which is probably what you want to have happen.)
252 * @release: pointer to a release function for this struct class_device. If
253 * set, this will be called instead of the class specific release function.
254 * Only use this if you want to override the default release function, like
255 * when you are nesting class_device structures.
256 * @uevent: pointer to a uevent function for this struct class_device. If
257 * set, this will be called instead of the class specific uevent function.
258 * Only use this if you want to override the default uevent function, like
259 * when you are nesting class_device structures.
261 struct class_device
{
262 struct list_head node
;
265 struct class * class; /* required */
266 dev_t devt
; /* dev_t, creates the sysfs "dev" */
267 struct class_device_attribute
*devt_attr
;
268 struct class_device_attribute uevent_attr
;
269 struct device
* dev
; /* not necessary, but nice to have */
270 void * class_data
; /* class-specific data */
271 struct class_device
*parent
; /* parent of this child device, if there is one */
272 struct attribute_group
** groups
; /* optional groups */
274 void (*release
)(struct class_device
*dev
);
275 int (*uevent
)(struct class_device
*dev
, char **envp
,
276 int num_envp
, char *buffer
, int buffer_size
);
277 char class_id
[BUS_ID_SIZE
]; /* unique to this class */
281 class_get_devdata (struct class_device
*dev
)
283 return dev
->class_data
;
287 class_set_devdata (struct class_device
*dev
, void *data
)
289 dev
->class_data
= data
;
293 extern int __must_check
class_device_register(struct class_device
*);
294 extern void class_device_unregister(struct class_device
*);
295 extern void class_device_initialize(struct class_device
*);
296 extern int __must_check
class_device_add(struct class_device
*);
297 extern void class_device_del(struct class_device
*);
299 extern struct class_device
* class_device_get(struct class_device
*);
300 extern void class_device_put(struct class_device
*);
302 extern void class_device_remove_file(struct class_device
*,
303 const struct class_device_attribute
*);
304 extern int __must_check
class_device_create_bin_file(struct class_device
*,
305 struct bin_attribute
*);
306 extern void class_device_remove_bin_file(struct class_device
*,
307 struct bin_attribute
*);
309 struct class_interface
{
310 struct list_head node
;
313 int (*add
) (struct class_device
*, struct class_interface
*);
314 void (*remove
) (struct class_device
*, struct class_interface
*);
315 int (*add_dev
) (struct device
*, struct class_interface
*);
316 void (*remove_dev
) (struct device
*, struct class_interface
*);
319 extern int __must_check
class_interface_register(struct class_interface
*);
320 extern void class_interface_unregister(struct class_interface
*);
322 extern struct class *class_create(struct module
*owner
, const char *name
);
323 extern void class_destroy(struct class *cls
);
324 extern struct class_device
*class_device_create(struct class *cls
,
325 struct class_device
*parent
,
327 struct device
*device
,
328 const char *fmt
, ...)
329 __attribute__((format(printf
,5,6)));
330 extern void class_device_destroy(struct class *cls
, dev_t devt
);
333 * The type of device, "struct device" is embedded in. A class
334 * or bus can contain devices of different types
335 * like "partitions" and "disks", "mouse" and "event".
336 * This identifies the device type and carries type-specific
337 * information, equivalent to the kobj_type of a kobject.
338 * If "name" is specified, the uevent will contain it in
339 * the DEVTYPE variable.
343 struct attribute_group
**groups
;
344 int (*uevent
)(struct device
*dev
, char **envp
, int num_envp
,
345 char *buffer
, int buffer_size
);
346 void (*release
)(struct device
*dev
);
347 int (*suspend
)(struct device
* dev
, pm_message_t state
);
348 int (*resume
)(struct device
* dev
);
351 /* interface for exporting device attributes */
352 struct device_attribute
{
353 struct attribute attr
;
354 ssize_t (*show
)(struct device
*dev
, struct device_attribute
*attr
,
356 ssize_t (*store
)(struct device
*dev
, struct device_attribute
*attr
,
357 const char *buf
, size_t count
);
360 #define DEVICE_ATTR(_name,_mode,_show,_store) \
361 struct device_attribute dev_attr_##_name = __ATTR(_name,_mode,_show,_store)
363 extern int __must_check
device_create_file(struct device
*device
,
364 struct device_attribute
* entry
);
365 extern void device_remove_file(struct device
* dev
, struct device_attribute
* attr
);
366 extern int __must_check
device_create_bin_file(struct device
*dev
,
367 struct bin_attribute
*attr
);
368 extern void device_remove_bin_file(struct device
*dev
,
369 struct bin_attribute
*attr
);
370 extern int device_schedule_callback_owner(struct device
*dev
,
371 void (*func
)(struct device
*), struct module
*owner
);
373 /* This is a macro to avoid include problems with THIS_MODULE */
374 #define device_schedule_callback(dev, func) \
375 device_schedule_callback_owner(dev, func, THIS_MODULE)
377 /* device resource management */
378 typedef void (*dr_release_t
)(struct device
*dev
, void *res
);
379 typedef int (*dr_match_t
)(struct device
*dev
, void *res
, void *match_data
);
381 #ifdef CONFIG_DEBUG_DEVRES
382 extern void * __devres_alloc(dr_release_t release
, size_t size
, gfp_t gfp
,
384 #define devres_alloc(release, size, gfp) \
385 __devres_alloc(release, size, gfp, #release)
387 extern void * devres_alloc(dr_release_t release
, size_t size
, gfp_t gfp
);
389 extern void devres_free(void *res
);
390 extern void devres_add(struct device
*dev
, void *res
);
391 extern void * devres_find(struct device
*dev
, dr_release_t release
,
392 dr_match_t match
, void *match_data
);
393 extern void * devres_get(struct device
*dev
, void *new_res
,
394 dr_match_t match
, void *match_data
);
395 extern void * devres_remove(struct device
*dev
, dr_release_t release
,
396 dr_match_t match
, void *match_data
);
397 extern int devres_destroy(struct device
*dev
, dr_release_t release
,
398 dr_match_t match
, void *match_data
);
401 extern void * __must_check
devres_open_group(struct device
*dev
, void *id
,
403 extern void devres_close_group(struct device
*dev
, void *id
);
404 extern void devres_remove_group(struct device
*dev
, void *id
);
405 extern int devres_release_group(struct device
*dev
, void *id
);
407 /* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
408 extern void *devm_kzalloc(struct device
*dev
, size_t size
, gfp_t gfp
);
409 extern void devm_kfree(struct device
*dev
, void *p
);
412 struct klist klist_children
;
413 struct klist_node knode_parent
; /* node in sibling list */
414 struct klist_node knode_driver
;
415 struct klist_node knode_bus
;
416 struct device
* parent
;
419 char bus_id
[BUS_ID_SIZE
]; /* position on parent bus */
420 struct device_type
*type
;
421 unsigned is_registered
:1;
422 struct device_attribute uevent_attr
;
423 struct device_attribute
*devt_attr
;
425 struct semaphore sem
; /* semaphore to synchronize calls to
429 struct bus_type
* bus
; /* type of bus device is on */
430 struct device_driver
*driver
; /* which driver has allocated this
432 void *driver_data
; /* data private to the driver */
433 void *platform_data
; /* Platform specific data, device
434 core doesn't touch it */
435 struct dev_pm_info power
;
438 int numa_node
; /* NUMA node this device is close to */
440 u64
*dma_mask
; /* dma mask (if dma'able device) */
441 u64 coherent_dma_mask
;/* Like dma_mask, but for
442 alloc_coherent mappings as
443 not all hardware supports
444 64 bit addresses for consistent
445 allocations such descriptors. */
447 struct list_head dma_pools
; /* dma pools (if dma'ble) */
449 struct dma_coherent_mem
*dma_mem
; /* internal for coherent mem
451 /* arch specific additions */
452 struct dev_archdata archdata
;
454 spinlock_t devres_lock
;
455 struct list_head devres_head
;
457 /* class_device migration path */
458 struct list_head node
;
460 dev_t devt
; /* dev_t, creates the sysfs "dev" */
461 struct attribute_group
**groups
; /* optional groups */
464 void (*release
)(struct device
* dev
);
468 static inline int dev_to_node(struct device
*dev
)
470 return dev
->numa_node
;
472 static inline void set_dev_node(struct device
*dev
, int node
)
474 dev
->numa_node
= node
;
477 static inline int dev_to_node(struct device
*dev
)
481 static inline void set_dev_node(struct device
*dev
, int node
)
487 dev_get_drvdata (struct device
*dev
)
489 return dev
->driver_data
;
493 dev_set_drvdata (struct device
*dev
, void *data
)
495 dev
->driver_data
= data
;
498 static inline int device_is_registered(struct device
*dev
)
500 return dev
->is_registered
;
503 void driver_init(void);
506 * High level routines for use by the bus drivers
508 extern int __must_check
device_register(struct device
* dev
);
509 extern void device_unregister(struct device
* dev
);
510 extern void device_initialize(struct device
* dev
);
511 extern int __must_check
device_add(struct device
* dev
);
512 extern void device_del(struct device
* dev
);
513 extern int device_for_each_child(struct device
*, void *,
514 int (*fn
)(struct device
*, void *));
515 extern struct device
*device_find_child(struct device
*, void *data
,
516 int (*match
)(struct device
*, void *));
517 extern int device_rename(struct device
*dev
, char *new_name
);
518 extern int device_move(struct device
*dev
, struct device
*new_parent
);
521 * Manual binding of a device to driver. See drivers/base/bus.c
522 * for information on use.
524 extern int __must_check
device_bind_driver(struct device
*dev
);
525 extern void device_release_driver(struct device
* dev
);
526 extern int __must_check
device_attach(struct device
* dev
);
527 extern int __must_check
driver_attach(struct device_driver
*drv
);
528 extern int __must_check
device_reprobe(struct device
*dev
);
531 * Easy functions for dynamically creating devices on the fly
533 extern struct device
*device_create(struct class *cls
, struct device
*parent
,
534 dev_t devt
, const char *fmt
, ...)
535 __attribute__((format(printf
,4,5)));
536 extern void device_destroy(struct class *cls
, dev_t devt
);
539 * Platform "fixup" functions - allow the platform to have their say
540 * about devices and actions that the general device layer doesn't
543 /* Notify platform of device discovery */
544 extern int (*platform_notify
)(struct device
* dev
);
546 extern int (*platform_notify_remove
)(struct device
* dev
);
550 * get_device - atomically increment the reference count for the device.
553 extern struct device
* get_device(struct device
* dev
);
554 extern void put_device(struct device
* dev
);
557 /* drivers/base/power/shutdown.c */
558 extern void device_shutdown(void);
561 /* drivers/base/firmware.c */
562 extern int __must_check
firmware_register(struct subsystem
*);
563 extern void firmware_unregister(struct subsystem
*);
565 /* debugging and troubleshooting/diagnostic helpers. */
566 extern const char *dev_driver_string(struct device
*dev
);
567 #define dev_printk(level, dev, format, arg...) \
568 printk(level "%s %s: " format , dev_driver_string(dev) , (dev)->bus_id , ## arg)
571 #define dev_dbg(dev, format, arg...) \
572 dev_printk(KERN_DEBUG , dev , format , ## arg)
574 static inline int __attribute__ ((format (printf
, 2, 3)))
575 dev_dbg(struct device
* dev
, const char * fmt
, ...)
581 #define dev_err(dev, format, arg...) \
582 dev_printk(KERN_ERR , dev , format , ## arg)
583 #define dev_info(dev, format, arg...) \
584 dev_printk(KERN_INFO , dev , format , ## arg)
585 #define dev_warn(dev, format, arg...) \
586 dev_printk(KERN_WARNING , dev , format , ## arg)
587 #define dev_notice(dev, format, arg...) \
588 dev_printk(KERN_NOTICE , dev , format , ## arg)
590 /* Create alias, so I can be autoloaded. */
591 #define MODULE_ALIAS_CHARDEV(major,minor) \
592 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
593 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
594 MODULE_ALIAS("char-major-" __stringify(major) "-*")
595 #endif /* _DEVICE_H_ */