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