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 <linux/semaphore.h>
24 #include <asm/atomic.h>
25 #include <asm/device.h>
27 #define DEVICE_NAME_SIZE 50
28 /* DEVICE_NAME_HALF is really less than half to accommodate slop */
29 #define DEVICE_NAME_HALF __stringify(20)
30 #define DEVICE_ID_SIZE 32
31 #define BUS_ID_SIZE KOBJ_NAME_LEN
36 struct driver_private;
39 struct bus_type_private;
41 struct bus_attribute {
42 struct attribute attr;
43 ssize_t (*show)(struct bus_type *bus, char *buf);
44 ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
47 #define BUS_ATTR(_name, _mode, _show, _store) \
48 struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
50 extern int __must_check bus_create_file(struct bus_type *,
51 struct bus_attribute *);
52 extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
56 struct bus_attribute *bus_attrs;
57 struct device_attribute *dev_attrs;
58 struct driver_attribute *drv_attrs;
60 int (*match)(struct device *dev, struct device_driver *drv);
61 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
62 int (*probe)(struct device *dev);
63 int (*remove)(struct device *dev);
64 void (*shutdown)(struct device *dev);
66 int (*suspend)(struct device *dev, pm_message_t state);
67 int (*suspend_late)(struct device *dev, pm_message_t state);
68 int (*resume_early)(struct device *dev);
69 int (*resume)(struct device *dev);
71 struct pm_ext_ops *pm;
73 struct bus_type_private *p;
76 extern int __must_check bus_register(struct bus_type *bus);
77 extern void bus_unregister(struct bus_type *bus);
79 extern int __must_check bus_rescan_devices(struct bus_type *bus);
81 /* iterator helpers for buses */
83 int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
84 int (*fn)(struct device *dev, void *data));
85 struct device *bus_find_device(struct bus_type *bus, struct device *start,
87 int (*match)(struct device *dev, void *data));
88 struct device *bus_find_device_by_name(struct bus_type *bus,
92 int __must_check bus_for_each_drv(struct bus_type *bus,
93 struct device_driver *start, void *data,
94 int (*fn)(struct device_driver *, void *));
97 * Bus notifiers: Get notified of addition/removal of devices
98 * and binding/unbinding of drivers to devices.
99 * In the long run, it should be a replacement for the platform
102 struct notifier_block;
104 extern int bus_register_notifier(struct bus_type *bus,
105 struct notifier_block *nb);
106 extern int bus_unregister_notifier(struct bus_type *bus,
107 struct notifier_block *nb);
109 /* All 4 notifers below get called with the target struct device *
110 * as an argument. Note that those functions are likely to be called
111 * with the device semaphore held in the core, so be careful.
113 #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
114 #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */
115 #define BUS_NOTIFY_BOUND_DRIVER 0x00000003 /* driver bound to device */
116 #define BUS_NOTIFY_UNBIND_DRIVER 0x00000004 /* driver about to be
119 extern struct kset *bus_get_kset(struct bus_type *bus);
120 extern struct klist *bus_get_device_klist(struct bus_type *bus);
122 struct device_driver {
124 struct bus_type *bus;
126 struct module *owner;
127 const char *mod_name; /* used for built-in modules */
129 int (*probe) (struct device *dev);
130 int (*remove) (struct device *dev);
131 void (*shutdown) (struct device *dev);
132 int (*suspend) (struct device *dev, pm_message_t state);
133 int (*resume) (struct device *dev);
134 struct attribute_group **groups;
138 struct driver_private *p;
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,
148 struct bus_type *bus);
149 extern int driver_probe_done(void);
151 /* sysfs interface for exporting driver attributes */
153 struct driver_attribute {
154 struct attribute attr;
155 ssize_t (*show)(struct device_driver *driver, char *buf);
156 ssize_t (*store)(struct device_driver *driver, const char *buf,
160 #define DRIVER_ATTR(_name, _mode, _show, _store) \
161 struct driver_attribute driver_attr_##_name = \
162 __ATTR(_name, _mode, _show, _store)
164 extern int __must_check driver_create_file(struct device_driver *driver,
165 struct driver_attribute *attr);
166 extern void driver_remove_file(struct device_driver *driver,
167 struct driver_attribute *attr);
169 extern int __must_check driver_add_kobj(struct device_driver *drv,
170 struct kobject *kobj,
171 const char *fmt, ...);
173 extern int __must_check driver_for_each_device(struct device_driver *drv,
174 struct device *start,
176 int (*fn)(struct device *dev,
178 struct device *driver_find_device(struct device_driver *drv,
179 struct device *start, void *data,
180 int (*match)(struct device *dev, void *data));
187 struct module *owner;
190 struct list_head devices;
191 struct list_head interfaces;
192 struct kset class_dirs;
193 struct semaphore sem; /* locks children, devices, interfaces */
194 struct class_attribute *class_attrs;
195 struct device_attribute *dev_attrs;
196 struct kobject *dev_kobj;
198 int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
200 void (*class_release)(struct class *class);
201 void (*dev_release)(struct device *dev);
203 int (*suspend)(struct device *dev, pm_message_t state);
204 int (*resume)(struct device *dev);
209 extern struct kobject *sysfs_dev_block_kobj;
210 extern struct kobject *sysfs_dev_char_kobj;
211 extern int __must_check class_register(struct class *class);
212 extern void class_unregister(struct class *class);
213 extern int class_for_each_device(struct class *class, struct device *start,
215 int (*fn)(struct device *dev, void *data));
216 extern struct device *class_find_device(struct class *class,
217 struct device *start, void *data,
218 int (*match)(struct device *, void *));
220 struct class_attribute {
221 struct attribute attr;
222 ssize_t (*show)(struct class *class, char *buf);
223 ssize_t (*store)(struct class *class, const char *buf, size_t count);
226 #define CLASS_ATTR(_name, _mode, _show, _store) \
227 struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
229 extern int __must_check class_create_file(struct class *class,
230 const struct class_attribute *attr);
231 extern void class_remove_file(struct class *class,
232 const struct class_attribute *attr);
234 struct class_interface {
235 struct list_head node;
238 int (*add_dev) (struct device *, struct class_interface *);
239 void (*remove_dev) (struct device *, struct class_interface *);
242 extern int __must_check class_interface_register(struct class_interface *);
243 extern void class_interface_unregister(struct class_interface *);
245 extern struct class *class_create(struct module *owner, const char *name);
246 extern void class_destroy(struct class *cls);
249 * The type of device, "struct device" is embedded in. A class
250 * or bus can contain devices of different types
251 * like "partitions" and "disks", "mouse" and "event".
252 * This identifies the device type and carries type-specific
253 * information, equivalent to the kobj_type of a kobject.
254 * If "name" is specified, the uevent will contain it in
255 * the DEVTYPE variable.
259 struct attribute_group **groups;
260 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
261 void (*release)(struct device *dev);
263 int (*suspend)(struct device *dev, pm_message_t state);
264 int (*resume)(struct device *dev);
269 /* interface for exporting device attributes */
270 struct device_attribute {
271 struct attribute attr;
272 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
274 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
275 const char *buf, size_t count);
278 #define DEVICE_ATTR(_name, _mode, _show, _store) \
279 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
281 extern int __must_check device_create_file(struct device *device,
282 struct device_attribute *entry);
283 extern void device_remove_file(struct device *dev,
284 struct device_attribute *attr);
285 extern int __must_check device_create_bin_file(struct device *dev,
286 struct bin_attribute *attr);
287 extern void device_remove_bin_file(struct device *dev,
288 struct bin_attribute *attr);
289 extern int device_schedule_callback_owner(struct device *dev,
290 void (*func)(struct device *dev), struct module *owner);
292 /* This is a macro to avoid include problems with THIS_MODULE */
293 #define device_schedule_callback(dev, func) \
294 device_schedule_callback_owner(dev, func, THIS_MODULE)
296 /* device resource management */
297 typedef void (*dr_release_t)(struct device *dev, void *res);
298 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
300 #ifdef CONFIG_DEBUG_DEVRES
301 extern void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
303 #define devres_alloc(release, size, gfp) \
304 __devres_alloc(release, size, gfp, #release)
306 extern void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
308 extern void devres_free(void *res);
309 extern void devres_add(struct device *dev, void *res);
310 extern void *devres_find(struct device *dev, dr_release_t release,
311 dr_match_t match, void *match_data);
312 extern void *devres_get(struct device *dev, void *new_res,
313 dr_match_t match, void *match_data);
314 extern void *devres_remove(struct device *dev, dr_release_t release,
315 dr_match_t match, void *match_data);
316 extern int devres_destroy(struct device *dev, dr_release_t release,
317 dr_match_t match, void *match_data);
320 extern void * __must_check devres_open_group(struct device *dev, void *id,
322 extern void devres_close_group(struct device *dev, void *id);
323 extern void devres_remove_group(struct device *dev, void *id);
324 extern int devres_release_group(struct device *dev, void *id);
326 /* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
327 extern void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp);
328 extern void devm_kfree(struct device *dev, void *p);
330 struct device_dma_parameters {
332 * a low level driver may set these to teach IOMMU code about
335 unsigned int max_segment_size;
336 unsigned long segment_boundary_mask;
340 struct klist klist_children;
341 struct klist_node knode_parent; /* node in sibling list */
342 struct klist_node knode_driver;
343 struct klist_node knode_bus;
344 struct device *parent;
347 char bus_id[BUS_ID_SIZE]; /* position on parent bus */
348 struct device_type *type;
349 unsigned uevent_suppress:1;
351 struct semaphore sem; /* semaphore to synchronize calls to
355 struct bus_type *bus; /* type of bus device is on */
356 struct device_driver *driver; /* which driver has allocated this
358 void *driver_data; /* data private to the driver */
359 void *platform_data; /* Platform specific data, device
360 core doesn't touch it */
361 struct dev_pm_info power;
364 int numa_node; /* NUMA node this device is close to */
366 u64 *dma_mask; /* dma mask (if dma'able device) */
367 u64 coherent_dma_mask;/* Like dma_mask, but for
368 alloc_coherent mappings as
369 not all hardware supports
370 64 bit addresses for consistent
371 allocations such descriptors. */
373 struct device_dma_parameters *dma_parms;
375 struct list_head dma_pools; /* dma pools (if dma'ble) */
377 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
379 /* arch specific additions */
380 struct dev_archdata archdata;
382 spinlock_t devres_lock;
383 struct list_head devres_head;
385 struct list_head node;
387 dev_t devt; /* dev_t, creates the sysfs "dev" */
388 struct attribute_group **groups; /* optional groups */
390 void (*release)(struct device *dev);
393 /* Get the wakeup routines, which depend on struct device */
394 #include <linux/pm_wakeup.h>
396 static inline const char *dev_name(struct device *dev)
398 /* will be changed into kobject_name(&dev->kobj) in the near future */
402 extern int dev_set_name(struct device *dev, const char *name, ...)
403 __attribute__((format(printf, 2, 3)));
406 static inline int dev_to_node(struct device *dev)
408 return dev->numa_node;
410 static inline void set_dev_node(struct device *dev, int node)
412 dev->numa_node = node;
415 static inline int dev_to_node(struct device *dev)
419 static inline void set_dev_node(struct device *dev, int node)
424 static inline void *dev_get_drvdata(struct device *dev)
426 return dev->driver_data;
429 static inline void dev_set_drvdata(struct device *dev, void *data)
431 dev->driver_data = data;
434 static inline int device_is_registered(struct device *dev)
436 return dev->kobj.state_in_sysfs;
439 void driver_init(void);
442 * High level routines for use by the bus drivers
444 extern int __must_check device_register(struct device *dev);
445 extern void device_unregister(struct device *dev);
446 extern void device_initialize(struct device *dev);
447 extern int __must_check device_add(struct device *dev);
448 extern void device_del(struct device *dev);
449 extern int device_for_each_child(struct device *dev, void *data,
450 int (*fn)(struct device *dev, void *data));
451 extern struct device *device_find_child(struct device *dev, void *data,
452 int (*match)(struct device *dev, void *data));
453 extern int device_rename(struct device *dev, char *new_name);
454 extern int device_move(struct device *dev, struct device *new_parent);
457 * Manual binding of a device to driver. See drivers/base/bus.c
458 * for information on use.
460 extern int __must_check device_bind_driver(struct device *dev);
461 extern void device_release_driver(struct device *dev);
462 extern int __must_check device_attach(struct device *dev);
463 extern int __must_check driver_attach(struct device_driver *drv);
464 extern int __must_check device_reprobe(struct device *dev);
467 * Easy functions for dynamically creating devices on the fly
469 extern struct device *device_create_vargs(struct class *cls,
470 struct device *parent,
475 extern struct device *device_create(struct class *cls, struct device *parent,
476 dev_t devt, void *drvdata,
477 const char *fmt, ...)
478 __attribute__((format(printf, 5, 6)));
479 #define device_create_drvdata device_create
480 extern void device_destroy(struct class *cls, dev_t devt);
483 * Platform "fixup" functions - allow the platform to have their say
484 * about devices and actions that the general device layer doesn't
487 /* Notify platform of device discovery */
488 extern int (*platform_notify)(struct device *dev);
490 extern int (*platform_notify_remove)(struct device *dev);
494 * get_device - atomically increment the reference count for the device.
497 extern struct device *get_device(struct device *dev);
498 extern void put_device(struct device *dev);
501 /* drivers/base/power/shutdown.c */
502 extern void device_shutdown(void);
504 /* drivers/base/sys.c */
505 extern void sysdev_shutdown(void);
507 /* debugging and troubleshooting/diagnostic helpers. */
508 extern const char *dev_driver_string(struct device *dev);
509 #define dev_printk(level, dev, format, arg...) \
510 printk(level "%s %s: " format , dev_driver_string(dev) , \
511 dev_name(dev) , ## arg)
513 #define dev_emerg(dev, format, arg...) \
514 dev_printk(KERN_EMERG , dev , format , ## arg)
515 #define dev_alert(dev, format, arg...) \
516 dev_printk(KERN_ALERT , dev , format , ## arg)
517 #define dev_crit(dev, format, arg...) \
518 dev_printk(KERN_CRIT , dev , format , ## arg)
519 #define dev_err(dev, format, arg...) \
520 dev_printk(KERN_ERR , dev , format , ## arg)
521 #define dev_warn(dev, format, arg...) \
522 dev_printk(KERN_WARNING , dev , format , ## arg)
523 #define dev_notice(dev, format, arg...) \
524 dev_printk(KERN_NOTICE , dev , format , ## arg)
525 #define dev_info(dev, format, arg...) \
526 dev_printk(KERN_INFO , dev , format , ## arg)
529 #define dev_dbg(dev, format, arg...) \
530 dev_printk(KERN_DEBUG , dev , format , ## arg)
532 #define dev_dbg(dev, format, arg...) \
533 ({ if (0) dev_printk(KERN_DEBUG, dev, format, ##arg); 0; })
537 #define dev_vdbg dev_dbg
540 #define dev_vdbg(dev, format, arg...) \
541 ({ if (0) dev_printk(KERN_DEBUG, dev, format, ##arg); 0; })
544 /* Create alias, so I can be autoloaded. */
545 #define MODULE_ALIAS_CHARDEV(major,minor) \
546 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
547 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
548 MODULE_ALIAS("char-major-" __stringify(major) "-*")
549 #endif /* _DEVICE_H_ */