driver-core: Add device node pointer to struct device
[deliverable/linux.git] / include / linux / device.h
1 /*
2 * device.h - generic, centralized driver model
3 *
4 * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
5 * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de>
6 * Copyright (c) 2008-2009 Novell Inc.
7 *
8 * This file is released under the GPLv2
9 *
10 * See Documentation/driver-model/ for more information.
11 */
12
13 #ifndef _DEVICE_H_
14 #define _DEVICE_H_
15
16 #include <linux/ioport.h>
17 #include <linux/kobject.h>
18 #include <linux/klist.h>
19 #include <linux/list.h>
20 #include <linux/lockdep.h>
21 #include <linux/compiler.h>
22 #include <linux/types.h>
23 #include <linux/module.h>
24 #include <linux/pm.h>
25 #include <linux/semaphore.h>
26 #include <asm/atomic.h>
27 #include <asm/device.h>
28
29 struct device;
30 struct device_private;
31 struct device_driver;
32 struct driver_private;
33 struct class;
34 struct class_private;
35 struct bus_type;
36 struct bus_type_private;
37 struct device_node;
38
39 struct bus_attribute {
40 struct attribute attr;
41 ssize_t (*show)(struct bus_type *bus, char *buf);
42 ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
43 };
44
45 #define BUS_ATTR(_name, _mode, _show, _store) \
46 struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
47
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 *);
51
52 struct bus_type {
53 const char *name;
54 struct bus_attribute *bus_attrs;
55 struct device_attribute *dev_attrs;
56 struct driver_attribute *drv_attrs;
57
58 int (*match)(struct device *dev, struct device_driver *drv);
59 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
60 int (*probe)(struct device *dev);
61 int (*remove)(struct device *dev);
62 void (*shutdown)(struct device *dev);
63
64 int (*suspend)(struct device *dev, pm_message_t state);
65 int (*resume)(struct device *dev);
66
67 const struct dev_pm_ops *pm;
68
69 struct bus_type_private *p;
70 };
71
72 extern int __must_check bus_register(struct bus_type *bus);
73 extern void bus_unregister(struct bus_type *bus);
74
75 extern int __must_check bus_rescan_devices(struct bus_type *bus);
76
77 /* iterator helpers for buses */
78
79 int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
80 int (*fn)(struct device *dev, void *data));
81 struct device *bus_find_device(struct bus_type *bus, struct device *start,
82 void *data,
83 int (*match)(struct device *dev, void *data));
84 struct device *bus_find_device_by_name(struct bus_type *bus,
85 struct device *start,
86 const char *name);
87
88 int __must_check bus_for_each_drv(struct bus_type *bus,
89 struct device_driver *start, void *data,
90 int (*fn)(struct device_driver *, void *));
91
92 void bus_sort_breadthfirst(struct bus_type *bus,
93 int (*compare)(const struct device *a,
94 const struct device *b));
95 /*
96 * Bus notifiers: Get notified of addition/removal of devices
97 * and binding/unbinding of drivers to devices.
98 * In the long run, it should be a replacement for the platform
99 * notify hooks.
100 */
101 struct notifier_block;
102
103 extern int bus_register_notifier(struct bus_type *bus,
104 struct notifier_block *nb);
105 extern int bus_unregister_notifier(struct bus_type *bus,
106 struct notifier_block *nb);
107
108 /* All 4 notifers below get called with the target struct device *
109 * as an argument. Note that those functions are likely to be called
110 * with the device lock held in the core, so be careful.
111 */
112 #define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
113 #define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */
114 #define BUS_NOTIFY_BOUND_DRIVER 0x00000003 /* driver bound to device */
115 #define BUS_NOTIFY_UNBIND_DRIVER 0x00000004 /* driver about to be
116 unbound */
117 #define BUS_NOTIFY_UNBOUND_DRIVER 0x00000005 /* driver is unbound
118 from the device */
119
120 extern struct kset *bus_get_kset(struct bus_type *bus);
121 extern struct klist *bus_get_device_klist(struct bus_type *bus);
122
123 struct device_driver {
124 const char *name;
125 struct bus_type *bus;
126
127 struct module *owner;
128 const char *mod_name; /* used for built-in modules */
129
130 bool suppress_bind_attrs; /* disables bind/unbind via sysfs */
131
132 int (*probe) (struct device *dev);
133 int (*remove) (struct device *dev);
134 void (*shutdown) (struct device *dev);
135 int (*suspend) (struct device *dev, pm_message_t state);
136 int (*resume) (struct device *dev);
137 const struct attribute_group **groups;
138
139 const struct dev_pm_ops *pm;
140
141 struct driver_private *p;
142 };
143
144
145 extern int __must_check driver_register(struct device_driver *drv);
146 extern void driver_unregister(struct device_driver *drv);
147
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,
151 struct bus_type *bus);
152 extern int driver_probe_done(void);
153 extern void wait_for_device_probe(void);
154
155
156 /* sysfs interface for exporting driver attributes */
157
158 struct driver_attribute {
159 struct attribute attr;
160 ssize_t (*show)(struct device_driver *driver, char *buf);
161 ssize_t (*store)(struct device_driver *driver, const char *buf,
162 size_t count);
163 };
164
165 #define DRIVER_ATTR(_name, _mode, _show, _store) \
166 struct driver_attribute driver_attr_##_name = \
167 __ATTR(_name, _mode, _show, _store)
168
169 extern int __must_check driver_create_file(struct device_driver *driver,
170 const struct driver_attribute *attr);
171 extern void driver_remove_file(struct device_driver *driver,
172 const struct driver_attribute *attr);
173
174 extern int __must_check driver_add_kobj(struct device_driver *drv,
175 struct kobject *kobj,
176 const char *fmt, ...);
177
178 extern int __must_check driver_for_each_device(struct device_driver *drv,
179 struct device *start,
180 void *data,
181 int (*fn)(struct device *dev,
182 void *));
183 struct device *driver_find_device(struct device_driver *drv,
184 struct device *start, void *data,
185 int (*match)(struct device *dev, void *data));
186
187 /*
188 * device classes
189 */
190 struct class {
191 const char *name;
192 struct module *owner;
193
194 struct class_attribute *class_attrs;
195 struct device_attribute *dev_attrs;
196 struct kobject *dev_kobj;
197
198 int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
199 char *(*devnode)(struct device *dev, mode_t *mode);
200
201 void (*class_release)(struct class *class);
202 void (*dev_release)(struct device *dev);
203
204 int (*suspend)(struct device *dev, pm_message_t state);
205 int (*resume)(struct device *dev);
206
207 const struct dev_pm_ops *pm;
208
209 struct class_private *p;
210 };
211
212 struct class_dev_iter {
213 struct klist_iter ki;
214 const struct device_type *type;
215 };
216
217 extern struct kobject *sysfs_dev_block_kobj;
218 extern struct kobject *sysfs_dev_char_kobj;
219 extern int __must_check __class_register(struct class *class,
220 struct lock_class_key *key);
221 extern void class_unregister(struct class *class);
222
223 /* This is a #define to keep the compiler from merging different
224 * instances of the __key variable */
225 #define class_register(class) \
226 ({ \
227 static struct lock_class_key __key; \
228 __class_register(class, &__key); \
229 })
230
231 struct class_compat;
232 struct class_compat *class_compat_register(const char *name);
233 void class_compat_unregister(struct class_compat *cls);
234 int class_compat_create_link(struct class_compat *cls, struct device *dev,
235 struct device *device_link);
236 void class_compat_remove_link(struct class_compat *cls, struct device *dev,
237 struct device *device_link);
238
239 extern void class_dev_iter_init(struct class_dev_iter *iter,
240 struct class *class,
241 struct device *start,
242 const struct device_type *type);
243 extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
244 extern void class_dev_iter_exit(struct class_dev_iter *iter);
245
246 extern int class_for_each_device(struct class *class, struct device *start,
247 void *data,
248 int (*fn)(struct device *dev, void *data));
249 extern struct device *class_find_device(struct class *class,
250 struct device *start, void *data,
251 int (*match)(struct device *, void *));
252
253 struct class_attribute {
254 struct attribute attr;
255 ssize_t (*show)(struct class *class, struct class_attribute *attr,
256 char *buf);
257 ssize_t (*store)(struct class *class, struct class_attribute *attr,
258 const char *buf, size_t count);
259 };
260
261 #define CLASS_ATTR(_name, _mode, _show, _store) \
262 struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
263
264 extern int __must_check class_create_file(struct class *class,
265 const struct class_attribute *attr);
266 extern void class_remove_file(struct class *class,
267 const struct class_attribute *attr);
268
269 /* Simple class attribute that is just a static string */
270
271 struct class_attribute_string {
272 struct class_attribute attr;
273 char *str;
274 };
275
276 /* Currently read-only only */
277 #define _CLASS_ATTR_STRING(_name, _mode, _str) \
278 { __ATTR(_name, _mode, show_class_attr_string, NULL), _str }
279 #define CLASS_ATTR_STRING(_name, _mode, _str) \
280 struct class_attribute_string class_attr_##_name = \
281 _CLASS_ATTR_STRING(_name, _mode, _str)
282
283 extern ssize_t show_class_attr_string(struct class *class, struct class_attribute *attr,
284 char *buf);
285
286 struct class_interface {
287 struct list_head node;
288 struct class *class;
289
290 int (*add_dev) (struct device *, struct class_interface *);
291 void (*remove_dev) (struct device *, struct class_interface *);
292 };
293
294 extern int __must_check class_interface_register(struct class_interface *);
295 extern void class_interface_unregister(struct class_interface *);
296
297 extern struct class * __must_check __class_create(struct module *owner,
298 const char *name,
299 struct lock_class_key *key);
300 extern void class_destroy(struct class *cls);
301
302 /* This is a #define to keep the compiler from merging different
303 * instances of the __key variable */
304 #define class_create(owner, name) \
305 ({ \
306 static struct lock_class_key __key; \
307 __class_create(owner, name, &__key); \
308 })
309
310 /*
311 * The type of device, "struct device" is embedded in. A class
312 * or bus can contain devices of different types
313 * like "partitions" and "disks", "mouse" and "event".
314 * This identifies the device type and carries type-specific
315 * information, equivalent to the kobj_type of a kobject.
316 * If "name" is specified, the uevent will contain it in
317 * the DEVTYPE variable.
318 */
319 struct device_type {
320 const char *name;
321 const struct attribute_group **groups;
322 int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
323 char *(*devnode)(struct device *dev, mode_t *mode);
324 void (*release)(struct device *dev);
325
326 const struct dev_pm_ops *pm;
327 };
328
329 /* interface for exporting device attributes */
330 struct device_attribute {
331 struct attribute attr;
332 ssize_t (*show)(struct device *dev, struct device_attribute *attr,
333 char *buf);
334 ssize_t (*store)(struct device *dev, struct device_attribute *attr,
335 const char *buf, size_t count);
336 };
337
338 #define DEVICE_ATTR(_name, _mode, _show, _store) \
339 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
340
341 extern int __must_check device_create_file(struct device *device,
342 const struct device_attribute *entry);
343 extern void device_remove_file(struct device *dev,
344 const struct device_attribute *attr);
345 extern int __must_check device_create_bin_file(struct device *dev,
346 const struct bin_attribute *attr);
347 extern void device_remove_bin_file(struct device *dev,
348 const struct bin_attribute *attr);
349 extern int device_schedule_callback_owner(struct device *dev,
350 void (*func)(struct device *dev), struct module *owner);
351
352 /* This is a macro to avoid include problems with THIS_MODULE */
353 #define device_schedule_callback(dev, func) \
354 device_schedule_callback_owner(dev, func, THIS_MODULE)
355
356 /* device resource management */
357 typedef void (*dr_release_t)(struct device *dev, void *res);
358 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
359
360 #ifdef CONFIG_DEBUG_DEVRES
361 extern void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
362 const char *name);
363 #define devres_alloc(release, size, gfp) \
364 __devres_alloc(release, size, gfp, #release)
365 #else
366 extern void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
367 #endif
368 extern void devres_free(void *res);
369 extern void devres_add(struct device *dev, void *res);
370 extern void *devres_find(struct device *dev, dr_release_t release,
371 dr_match_t match, void *match_data);
372 extern void *devres_get(struct device *dev, void *new_res,
373 dr_match_t match, void *match_data);
374 extern void *devres_remove(struct device *dev, dr_release_t release,
375 dr_match_t match, void *match_data);
376 extern int devres_destroy(struct device *dev, dr_release_t release,
377 dr_match_t match, void *match_data);
378
379 /* devres group */
380 extern void * __must_check devres_open_group(struct device *dev, void *id,
381 gfp_t gfp);
382 extern void devres_close_group(struct device *dev, void *id);
383 extern void devres_remove_group(struct device *dev, void *id);
384 extern int devres_release_group(struct device *dev, void *id);
385
386 /* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
387 extern void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp);
388 extern void devm_kfree(struct device *dev, void *p);
389
390 struct device_dma_parameters {
391 /*
392 * a low level driver may set these to teach IOMMU code about
393 * sg limitations.
394 */
395 unsigned int max_segment_size;
396 unsigned long segment_boundary_mask;
397 };
398
399 struct device {
400 struct device *parent;
401
402 struct device_private *p;
403
404 struct kobject kobj;
405 const char *init_name; /* initial name of the device */
406 struct device_type *type;
407
408 struct semaphore sem; /* semaphore to synchronize calls to
409 * its driver.
410 */
411
412 struct bus_type *bus; /* type of bus device is on */
413 struct device_driver *driver; /* which driver has allocated this
414 device */
415 void *platform_data; /* Platform specific data, device
416 core doesn't touch it */
417 struct dev_pm_info power;
418
419 #ifdef CONFIG_NUMA
420 int numa_node; /* NUMA node this device is close to */
421 #endif
422 u64 *dma_mask; /* dma mask (if dma'able device) */
423 u64 coherent_dma_mask;/* Like dma_mask, but for
424 alloc_coherent mappings as
425 not all hardware supports
426 64 bit addresses for consistent
427 allocations such descriptors. */
428
429 struct device_dma_parameters *dma_parms;
430
431 struct list_head dma_pools; /* dma pools (if dma'ble) */
432
433 struct dma_coherent_mem *dma_mem; /* internal for coherent mem
434 override */
435 /* arch specific additions */
436 struct dev_archdata archdata;
437 #ifdef CONFIG_OF
438 struct device_node *of_node;
439 #endif
440
441 dev_t devt; /* dev_t, creates the sysfs "dev" */
442
443 spinlock_t devres_lock;
444 struct list_head devres_head;
445
446 struct klist_node knode_class;
447 struct class *class;
448 const struct attribute_group **groups; /* optional groups */
449
450 void (*release)(struct device *dev);
451 };
452
453 /* Get the wakeup routines, which depend on struct device */
454 #include <linux/pm_wakeup.h>
455
456 static inline const char *dev_name(const struct device *dev)
457 {
458 return kobject_name(&dev->kobj);
459 }
460
461 extern int dev_set_name(struct device *dev, const char *name, ...)
462 __attribute__((format(printf, 2, 3)));
463
464 #ifdef CONFIG_NUMA
465 static inline int dev_to_node(struct device *dev)
466 {
467 return dev->numa_node;
468 }
469 static inline void set_dev_node(struct device *dev, int node)
470 {
471 dev->numa_node = node;
472 }
473 #else
474 static inline int dev_to_node(struct device *dev)
475 {
476 return -1;
477 }
478 static inline void set_dev_node(struct device *dev, int node)
479 {
480 }
481 #endif
482
483 static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
484 {
485 return dev->kobj.uevent_suppress;
486 }
487
488 static inline void dev_set_uevent_suppress(struct device *dev, int val)
489 {
490 dev->kobj.uevent_suppress = val;
491 }
492
493 static inline int device_is_registered(struct device *dev)
494 {
495 return dev->kobj.state_in_sysfs;
496 }
497
498 static inline void device_enable_async_suspend(struct device *dev)
499 {
500 if (dev->power.status == DPM_ON)
501 dev->power.async_suspend = true;
502 }
503
504 static inline void device_disable_async_suspend(struct device *dev)
505 {
506 if (dev->power.status == DPM_ON)
507 dev->power.async_suspend = false;
508 }
509
510 static inline bool device_async_suspend_enabled(struct device *dev)
511 {
512 return !!dev->power.async_suspend;
513 }
514
515 static inline void device_lock(struct device *dev)
516 {
517 down(&dev->sem);
518 }
519
520 static inline int device_trylock(struct device *dev)
521 {
522 return down_trylock(&dev->sem);
523 }
524
525 static inline void device_unlock(struct device *dev)
526 {
527 up(&dev->sem);
528 }
529
530 void driver_init(void);
531
532 /*
533 * High level routines for use by the bus drivers
534 */
535 extern int __must_check device_register(struct device *dev);
536 extern void device_unregister(struct device *dev);
537 extern void device_initialize(struct device *dev);
538 extern int __must_check device_add(struct device *dev);
539 extern void device_del(struct device *dev);
540 extern int device_for_each_child(struct device *dev, void *data,
541 int (*fn)(struct device *dev, void *data));
542 extern struct device *device_find_child(struct device *dev, void *data,
543 int (*match)(struct device *dev, void *data));
544 extern int device_rename(struct device *dev, char *new_name);
545 extern int device_move(struct device *dev, struct device *new_parent,
546 enum dpm_order dpm_order);
547 extern const char *device_get_devnode(struct device *dev,
548 mode_t *mode, const char **tmp);
549 extern void *dev_get_drvdata(const struct device *dev);
550 extern void dev_set_drvdata(struct device *dev, void *data);
551
552 /*
553 * Root device objects for grouping under /sys/devices
554 */
555 extern struct device *__root_device_register(const char *name,
556 struct module *owner);
557 static inline struct device *root_device_register(const char *name)
558 {
559 return __root_device_register(name, THIS_MODULE);
560 }
561 extern void root_device_unregister(struct device *root);
562
563 static inline void *dev_get_platdata(const struct device *dev)
564 {
565 return dev->platform_data;
566 }
567
568 /*
569 * Manual binding of a device to driver. See drivers/base/bus.c
570 * for information on use.
571 */
572 extern int __must_check device_bind_driver(struct device *dev);
573 extern void device_release_driver(struct device *dev);
574 extern int __must_check device_attach(struct device *dev);
575 extern int __must_check driver_attach(struct device_driver *drv);
576 extern int __must_check device_reprobe(struct device *dev);
577
578 /*
579 * Easy functions for dynamically creating devices on the fly
580 */
581 extern struct device *device_create_vargs(struct class *cls,
582 struct device *parent,
583 dev_t devt,
584 void *drvdata,
585 const char *fmt,
586 va_list vargs);
587 extern struct device *device_create(struct class *cls, struct device *parent,
588 dev_t devt, void *drvdata,
589 const char *fmt, ...)
590 __attribute__((format(printf, 5, 6)));
591 extern void device_destroy(struct class *cls, dev_t devt);
592
593 /*
594 * Platform "fixup" functions - allow the platform to have their say
595 * about devices and actions that the general device layer doesn't
596 * know about.
597 */
598 /* Notify platform of device discovery */
599 extern int (*platform_notify)(struct device *dev);
600
601 extern int (*platform_notify_remove)(struct device *dev);
602
603
604 /**
605 * get_device - atomically increment the reference count for the device.
606 *
607 */
608 extern struct device *get_device(struct device *dev);
609 extern void put_device(struct device *dev);
610
611 extern void wait_for_device_probe(void);
612
613 #ifdef CONFIG_DEVTMPFS
614 extern int devtmpfs_create_node(struct device *dev);
615 extern int devtmpfs_delete_node(struct device *dev);
616 extern int devtmpfs_mount(const char *mntdir);
617 #else
618 static inline int devtmpfs_create_node(struct device *dev) { return 0; }
619 static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
620 static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
621 #endif
622
623 /* drivers/base/power/shutdown.c */
624 extern void device_shutdown(void);
625
626 /* drivers/base/sys.c */
627 extern void sysdev_shutdown(void);
628
629 /* debugging and troubleshooting/diagnostic helpers. */
630 extern const char *dev_driver_string(const struct device *dev);
631 #define dev_printk(level, dev, format, arg...) \
632 printk(level "%s %s: " format , dev_driver_string(dev) , \
633 dev_name(dev) , ## arg)
634
635 #define dev_emerg(dev, format, arg...) \
636 dev_printk(KERN_EMERG , dev , format , ## arg)
637 #define dev_alert(dev, format, arg...) \
638 dev_printk(KERN_ALERT , dev , format , ## arg)
639 #define dev_crit(dev, format, arg...) \
640 dev_printk(KERN_CRIT , dev , format , ## arg)
641 #define dev_err(dev, format, arg...) \
642 dev_printk(KERN_ERR , dev , format , ## arg)
643 #define dev_warn(dev, format, arg...) \
644 dev_printk(KERN_WARNING , dev , format , ## arg)
645 #define dev_notice(dev, format, arg...) \
646 dev_printk(KERN_NOTICE , dev , format , ## arg)
647 #define dev_info(dev, format, arg...) \
648 dev_printk(KERN_INFO , dev , format , ## arg)
649
650 #if defined(DEBUG)
651 #define dev_dbg(dev, format, arg...) \
652 dev_printk(KERN_DEBUG , dev , format , ## arg)
653 #elif defined(CONFIG_DYNAMIC_DEBUG)
654 #define dev_dbg(dev, format, ...) do { \
655 dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
656 } while (0)
657 #else
658 #define dev_dbg(dev, format, arg...) \
659 ({ if (0) dev_printk(KERN_DEBUG, dev, format, ##arg); 0; })
660 #endif
661
662 #ifdef VERBOSE_DEBUG
663 #define dev_vdbg dev_dbg
664 #else
665
666 #define dev_vdbg(dev, format, arg...) \
667 ({ if (0) dev_printk(KERN_DEBUG, dev, format, ##arg); 0; })
668 #endif
669
670 /*
671 * dev_WARN() acts like dev_printk(), but with the key difference
672 * of using a WARN/WARN_ON to get the message out, including the
673 * file/line information and a backtrace.
674 */
675 #define dev_WARN(dev, format, arg...) \
676 WARN(1, "Device: %s\n" format, dev_driver_string(dev), ## arg);
677
678 /* Create alias, so I can be autoloaded. */
679 #define MODULE_ALIAS_CHARDEV(major,minor) \
680 MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
681 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
682 MODULE_ALIAS("char-major-" __stringify(major) "-*")
683 #endif /* _DEVICE_H_ */
This page took 0.046465 seconds and 5 git commands to generate.