driver model: constify attribute groups
[linux-2.6.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
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         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         const struct attribute_group **groups;
135
136         const struct dev_pm_ops *pm;
137
138         struct driver_private *p;
139 };
140
141
142 extern int __must_check driver_register(struct device_driver *drv);
143 extern void driver_unregister(struct device_driver *drv);
144
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);
150 extern void wait_for_device_probe(void);
151
152
153 /* sysfs interface for exporting driver attributes */
154
155 struct driver_attribute {
156         struct attribute attr;
157         ssize_t (*show)(struct device_driver *driver, char *buf);
158         ssize_t (*store)(struct device_driver *driver, const char *buf,
159                          size_t count);
160 };
161
162 #define DRIVER_ATTR(_name, _mode, _show, _store)        \
163 struct driver_attribute driver_attr_##_name =           \
164         __ATTR(_name, _mode, _show, _store)
165
166 extern int __must_check driver_create_file(struct device_driver *driver,
167                                            struct driver_attribute *attr);
168 extern void driver_remove_file(struct device_driver *driver,
169                                struct driver_attribute *attr);
170
171 extern int __must_check driver_add_kobj(struct device_driver *drv,
172                                         struct kobject *kobj,
173                                         const char *fmt, ...);
174
175 extern int __must_check driver_for_each_device(struct device_driver *drv,
176                                                struct device *start,
177                                                void *data,
178                                                int (*fn)(struct device *dev,
179                                                          void *));
180 struct device *driver_find_device(struct device_driver *drv,
181                                   struct device *start, void *data,
182                                   int (*match)(struct device *dev, void *data));
183
184 /*
185  * device classes
186  */
187 struct class {
188         const char              *name;
189         struct module           *owner;
190
191         struct class_attribute          *class_attrs;
192         struct device_attribute         *dev_attrs;
193         struct kobject                  *dev_kobj;
194
195         int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
196         char *(*nodename)(struct device *dev);
197
198         void (*class_release)(struct class *class);
199         void (*dev_release)(struct device *dev);
200
201         int (*suspend)(struct device *dev, pm_message_t state);
202         int (*resume)(struct device *dev);
203
204         const struct dev_pm_ops *pm;
205
206         struct class_private *p;
207 };
208
209 struct class_dev_iter {
210         struct klist_iter               ki;
211         const struct device_type        *type;
212 };
213
214 extern struct kobject *sysfs_dev_block_kobj;
215 extern struct kobject *sysfs_dev_char_kobj;
216 extern int __must_check __class_register(struct class *class,
217                                          struct lock_class_key *key);
218 extern void class_unregister(struct class *class);
219
220 /* This is a #define to keep the compiler from merging different
221  * instances of the __key variable */
222 #define class_register(class)                   \
223 ({                                              \
224         static struct lock_class_key __key;     \
225         __class_register(class, &__key);        \
226 })
227
228 extern void class_dev_iter_init(struct class_dev_iter *iter,
229                                 struct class *class,
230                                 struct device *start,
231                                 const struct device_type *type);
232 extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
233 extern void class_dev_iter_exit(struct class_dev_iter *iter);
234
235 extern int class_for_each_device(struct class *class, struct device *start,
236                                  void *data,
237                                  int (*fn)(struct device *dev, void *data));
238 extern struct device *class_find_device(struct class *class,
239                                         struct device *start, void *data,
240                                         int (*match)(struct device *, void *));
241
242 struct class_attribute {
243         struct attribute attr;
244         ssize_t (*show)(struct class *class, char *buf);
245         ssize_t (*store)(struct class *class, const char *buf, size_t count);
246 };
247
248 #define CLASS_ATTR(_name, _mode, _show, _store)                 \
249 struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
250
251 extern int __must_check class_create_file(struct class *class,
252                                           const struct class_attribute *attr);
253 extern void class_remove_file(struct class *class,
254                               const struct class_attribute *attr);
255
256 struct class_interface {
257         struct list_head        node;
258         struct class            *class;
259
260         int (*add_dev)          (struct device *, struct class_interface *);
261         void (*remove_dev)      (struct device *, struct class_interface *);
262 };
263
264 extern int __must_check class_interface_register(struct class_interface *);
265 extern void class_interface_unregister(struct class_interface *);
266
267 extern struct class * __must_check __class_create(struct module *owner,
268                                                   const char *name,
269                                                   struct lock_class_key *key);
270 extern void class_destroy(struct class *cls);
271
272 /* This is a #define to keep the compiler from merging different
273  * instances of the __key variable */
274 #define class_create(owner, name)               \
275 ({                                              \
276         static struct lock_class_key __key;     \
277         __class_create(owner, name, &__key);    \
278 })
279
280 /*
281  * The type of device, "struct device" is embedded in. A class
282  * or bus can contain devices of different types
283  * like "partitions" and "disks", "mouse" and "event".
284  * This identifies the device type and carries type-specific
285  * information, equivalent to the kobj_type of a kobject.
286  * If "name" is specified, the uevent will contain it in
287  * the DEVTYPE variable.
288  */
289 struct device_type {
290         const char *name;
291         const struct attribute_group **groups;
292         int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
293         char *(*nodename)(struct device *dev);
294         void (*release)(struct device *dev);
295
296         const struct dev_pm_ops *pm;
297 };
298
299 /* interface for exporting device attributes */
300 struct device_attribute {
301         struct attribute        attr;
302         ssize_t (*show)(struct device *dev, struct device_attribute *attr,
303                         char *buf);
304         ssize_t (*store)(struct device *dev, struct device_attribute *attr,
305                          const char *buf, size_t count);
306 };
307
308 #define DEVICE_ATTR(_name, _mode, _show, _store) \
309 struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
310
311 extern int __must_check device_create_file(struct device *device,
312                                            struct device_attribute *entry);
313 extern void device_remove_file(struct device *dev,
314                                struct device_attribute *attr);
315 extern int __must_check device_create_bin_file(struct device *dev,
316                                                struct bin_attribute *attr);
317 extern void device_remove_bin_file(struct device *dev,
318                                    struct bin_attribute *attr);
319 extern int device_schedule_callback_owner(struct device *dev,
320                 void (*func)(struct device *dev), struct module *owner);
321
322 /* This is a macro to avoid include problems with THIS_MODULE */
323 #define device_schedule_callback(dev, func)                     \
324         device_schedule_callback_owner(dev, func, THIS_MODULE)
325
326 /* device resource management */
327 typedef void (*dr_release_t)(struct device *dev, void *res);
328 typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
329
330 #ifdef CONFIG_DEBUG_DEVRES
331 extern void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
332                              const char *name);
333 #define devres_alloc(release, size, gfp) \
334         __devres_alloc(release, size, gfp, #release)
335 #else
336 extern void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
337 #endif
338 extern void devres_free(void *res);
339 extern void devres_add(struct device *dev, void *res);
340 extern void *devres_find(struct device *dev, dr_release_t release,
341                          dr_match_t match, void *match_data);
342 extern void *devres_get(struct device *dev, void *new_res,
343                         dr_match_t match, void *match_data);
344 extern void *devres_remove(struct device *dev, dr_release_t release,
345                            dr_match_t match, void *match_data);
346 extern int devres_destroy(struct device *dev, dr_release_t release,
347                           dr_match_t match, void *match_data);
348
349 /* devres group */
350 extern void * __must_check devres_open_group(struct device *dev, void *id,
351                                              gfp_t gfp);
352 extern void devres_close_group(struct device *dev, void *id);
353 extern void devres_remove_group(struct device *dev, void *id);
354 extern int devres_release_group(struct device *dev, void *id);
355
356 /* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
357 extern void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp);
358 extern void devm_kfree(struct device *dev, void *p);
359
360 struct device_dma_parameters {
361         /*
362          * a low level driver may set these to teach IOMMU code about
363          * sg limitations.
364          */
365         unsigned int max_segment_size;
366         unsigned long segment_boundary_mask;
367 };
368
369 struct device {
370         struct device           *parent;
371
372         struct device_private   *p;
373
374         struct kobject kobj;
375         const char              *init_name; /* initial name of the device */
376         struct device_type      *type;
377
378         struct semaphore        sem;    /* semaphore to synchronize calls to
379                                          * its driver.
380                                          */
381
382         struct bus_type *bus;           /* type of bus device is on */
383         struct device_driver *driver;   /* which driver has allocated this
384                                            device */
385         void            *platform_data; /* Platform specific data, device
386                                            core doesn't touch it */
387         struct dev_pm_info      power;
388
389 #ifdef CONFIG_NUMA
390         int             numa_node;      /* NUMA node this device is close to */
391 #endif
392         u64             *dma_mask;      /* dma mask (if dma'able device) */
393         u64             coherent_dma_mask;/* Like dma_mask, but for
394                                              alloc_coherent mappings as
395                                              not all hardware supports
396                                              64 bit addresses for consistent
397                                              allocations such descriptors. */
398
399         struct device_dma_parameters *dma_parms;
400
401         struct list_head        dma_pools;      /* dma pools (if dma'ble) */
402
403         struct dma_coherent_mem *dma_mem; /* internal for coherent mem
404                                              override */
405         /* arch specific additions */
406         struct dev_archdata     archdata;
407
408         dev_t                   devt;   /* dev_t, creates the sysfs "dev" */
409
410         spinlock_t              devres_lock;
411         struct list_head        devres_head;
412
413         struct klist_node       knode_class;
414         struct class            *class;
415         const struct attribute_group **groups;  /* optional groups */
416
417         void    (*release)(struct device *dev);
418 };
419
420 /* Get the wakeup routines, which depend on struct device */
421 #include <linux/pm_wakeup.h>
422
423 static inline const char *dev_name(const struct device *dev)
424 {
425         return kobject_name(&dev->kobj);
426 }
427
428 extern int dev_set_name(struct device *dev, const char *name, ...)
429                         __attribute__((format(printf, 2, 3)));
430
431 #ifdef CONFIG_NUMA
432 static inline int dev_to_node(struct device *dev)
433 {
434         return dev->numa_node;
435 }
436 static inline void set_dev_node(struct device *dev, int node)
437 {
438         dev->numa_node = node;
439 }
440 #else
441 static inline int dev_to_node(struct device *dev)
442 {
443         return -1;
444 }
445 static inline void set_dev_node(struct device *dev, int node)
446 {
447 }
448 #endif
449
450 static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
451 {
452         return dev->kobj.uevent_suppress;
453 }
454
455 static inline void dev_set_uevent_suppress(struct device *dev, int val)
456 {
457         dev->kobj.uevent_suppress = val;
458 }
459
460 static inline int device_is_registered(struct device *dev)
461 {
462         return dev->kobj.state_in_sysfs;
463 }
464
465 void driver_init(void);
466
467 /*
468  * High level routines for use by the bus drivers
469  */
470 extern int __must_check device_register(struct device *dev);
471 extern void device_unregister(struct device *dev);
472 extern void device_initialize(struct device *dev);
473 extern int __must_check device_add(struct device *dev);
474 extern void device_del(struct device *dev);
475 extern int device_for_each_child(struct device *dev, void *data,
476                      int (*fn)(struct device *dev, void *data));
477 extern struct device *device_find_child(struct device *dev, void *data,
478                                 int (*match)(struct device *dev, void *data));
479 extern int device_rename(struct device *dev, char *new_name);
480 extern int device_move(struct device *dev, struct device *new_parent,
481                        enum dpm_order dpm_order);
482 extern const char *device_get_nodename(struct device *dev, const char **tmp);
483 extern void *dev_get_drvdata(const struct device *dev);
484 extern void dev_set_drvdata(struct device *dev, void *data);
485
486 /*
487  * Root device objects for grouping under /sys/devices
488  */
489 extern struct device *__root_device_register(const char *name,
490                                              struct module *owner);
491 static inline struct device *root_device_register(const char *name)
492 {
493         return __root_device_register(name, THIS_MODULE);
494 }
495 extern void root_device_unregister(struct device *root);
496
497 static inline void *dev_get_platdata(const struct device *dev)
498 {
499         return dev->platform_data;
500 }
501
502 /*
503  * Manual binding of a device to driver. See drivers/base/bus.c
504  * for information on use.
505  */
506 extern int __must_check device_bind_driver(struct device *dev);
507 extern void device_release_driver(struct device *dev);
508 extern int  __must_check device_attach(struct device *dev);
509 extern int __must_check driver_attach(struct device_driver *drv);
510 extern int __must_check device_reprobe(struct device *dev);
511
512 /*
513  * Easy functions for dynamically creating devices on the fly
514  */
515 extern struct device *device_create_vargs(struct class *cls,
516                                           struct device *parent,
517                                           dev_t devt,
518                                           void *drvdata,
519                                           const char *fmt,
520                                           va_list vargs);
521 extern struct device *device_create(struct class *cls, struct device *parent,
522                                     dev_t devt, void *drvdata,
523                                     const char *fmt, ...)
524                                     __attribute__((format(printf, 5, 6)));
525 extern void device_destroy(struct class *cls, dev_t devt);
526
527 /*
528  * Platform "fixup" functions - allow the platform to have their say
529  * about devices and actions that the general device layer doesn't
530  * know about.
531  */
532 /* Notify platform of device discovery */
533 extern int (*platform_notify)(struct device *dev);
534
535 extern int (*platform_notify_remove)(struct device *dev);
536
537
538 /**
539  * get_device - atomically increment the reference count for the device.
540  *
541  */
542 extern struct device *get_device(struct device *dev);
543 extern void put_device(struct device *dev);
544
545 extern void wait_for_device_probe(void);
546
547 /* drivers/base/power/shutdown.c */
548 extern void device_shutdown(void);
549
550 /* drivers/base/sys.c */
551 extern void sysdev_shutdown(void);
552
553 /* debugging and troubleshooting/diagnostic helpers. */
554 extern const char *dev_driver_string(const struct device *dev);
555 #define dev_printk(level, dev, format, arg...)  \
556         printk(level "%s %s: " format , dev_driver_string(dev) , \
557                dev_name(dev) , ## arg)
558
559 #define dev_emerg(dev, format, arg...)          \
560         dev_printk(KERN_EMERG , dev , format , ## arg)
561 #define dev_alert(dev, format, arg...)          \
562         dev_printk(KERN_ALERT , dev , format , ## arg)
563 #define dev_crit(dev, format, arg...)           \
564         dev_printk(KERN_CRIT , dev , format , ## arg)
565 #define dev_err(dev, format, arg...)            \
566         dev_printk(KERN_ERR , dev , format , ## arg)
567 #define dev_warn(dev, format, arg...)           \
568         dev_printk(KERN_WARNING , dev , format , ## arg)
569 #define dev_notice(dev, format, arg...)         \
570         dev_printk(KERN_NOTICE , dev , format , ## arg)
571 #define dev_info(dev, format, arg...)           \
572         dev_printk(KERN_INFO , dev , format , ## arg)
573
574 #if defined(DEBUG)
575 #define dev_dbg(dev, format, arg...)            \
576         dev_printk(KERN_DEBUG , dev , format , ## arg)
577 #elif defined(CONFIG_DYNAMIC_DEBUG)
578 #define dev_dbg(dev, format, ...) do { \
579         dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
580         } while (0)
581 #else
582 #define dev_dbg(dev, format, arg...)            \
583         ({ if (0) dev_printk(KERN_DEBUG, dev, format, ##arg); 0; })
584 #endif
585
586 #ifdef VERBOSE_DEBUG
587 #define dev_vdbg        dev_dbg
588 #else
589
590 #define dev_vdbg(dev, format, arg...)           \
591         ({ if (0) dev_printk(KERN_DEBUG, dev, format, ##arg); 0; })
592 #endif
593
594 /*
595  * dev_WARN() acts like dev_printk(), but with the key difference
596  * of using a WARN/WARN_ON to get the message out, including the
597  * file/line information and a backtrace.
598  */
599 #define dev_WARN(dev, format, arg...) \
600         WARN(1, "Device: %s\n" format, dev_driver_string(dev), ## arg);
601
602 /* Create alias, so I can be autoloaded. */
603 #define MODULE_ALIAS_CHARDEV(major,minor) \
604         MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
605 #define MODULE_ALIAS_CHARDEV_MAJOR(major) \
606         MODULE_ALIAS("char-major-" __stringify(major) "-*")
607 #endif /* _DEVICE_H_ */