006c359e63c02466532544b4bc1e23be55405691
[linux-2.6.git] / include / linux / sysfs.h
1 /*
2  * sysfs.h - definitions for the device driver filesystem
3  *
4  * Copyright (c) 2001,2002 Patrick Mochel
5  * Copyright (c) 2004 Silicon Graphics, Inc.
6  * Copyright (c) 2007 SUSE Linux Products GmbH
7  * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
8  *
9  * Please see Documentation/filesystems/sysfs.txt for more information.
10  */
11
12 #ifndef _SYSFS_H_
13 #define _SYSFS_H_
14
15 #include <linux/compiler.h>
16 #include <linux/errno.h>
17 #include <linux/list.h>
18 #include <linux/lockdep.h>
19 #include <asm/atomic.h>
20
21 struct kobject;
22 struct module;
23
24 /* FIXME
25  * The *owner field is no longer used.
26  * x86 tree has been cleaned up. The owner
27  * attribute is still left for other arches.
28  */
29 struct attribute {
30         const char              *name;
31         struct module           *owner;
32         mode_t                  mode;
33 #ifdef CONFIG_DEBUG_LOCK_ALLOC
34         struct lock_class_key   *key;
35         struct lock_class_key   skey;
36 #endif
37 };
38
39 #ifdef CONFIG_DEBUG_LOCK_ALLOC
40 #define sysfs_attr_init(attr)                           \
41 do {                                                    \
42         static struct lock_class_key __key;             \
43                                                         \
44         (attr)->key = &__key;                           \
45 } while(0)
46 #else
47 #define sysfs_attr_init(attr) do {} while(0)
48 #endif
49
50 struct attribute_group {
51         const char              *name;
52         mode_t                  (*is_visible)(struct kobject *,
53                                               struct attribute *, int);
54         struct attribute        **attrs;
55 };
56
57
58
59 /**
60  * Use these macros to make defining attributes easier. See include/linux/device.h
61  * for examples..
62  */
63
64 #define __ATTR(_name,_mode,_show,_store) { \
65         .attr = {.name = __stringify(_name), .mode = _mode },   \
66         .show   = _show,                                        \
67         .store  = _store,                                       \
68 }
69
70 #define __ATTR_RO(_name) { \
71         .attr   = { .name = __stringify(_name), .mode = 0444 }, \
72         .show   = _name##_show,                                 \
73 }
74
75 #define __ATTR_NULL { .attr = { .name = NULL } }
76
77 #define attr_name(_attr) (_attr).attr.name
78
79 struct vm_area_struct;
80
81 struct bin_attribute {
82         struct attribute        attr;
83         size_t                  size;
84         void                    *private;
85         ssize_t (*read)(struct kobject *, struct bin_attribute *,
86                         char *, loff_t, size_t);
87         ssize_t (*write)(struct kobject *, struct bin_attribute *,
88                          char *, loff_t, size_t);
89         int (*mmap)(struct kobject *, struct bin_attribute *attr,
90                     struct vm_area_struct *vma);
91 };
92
93 #define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&bin_attr->attr)
94
95 struct sysfs_ops {
96         ssize_t (*show)(struct kobject *, struct attribute *,char *);
97         ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t);
98 };
99
100 struct sysfs_dirent;
101
102 #ifdef CONFIG_SYSFS
103
104 int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
105                             void *data, struct module *owner);
106
107 int __must_check sysfs_create_dir(struct kobject *kobj);
108 void sysfs_remove_dir(struct kobject *kobj);
109 int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name);
110 int __must_check sysfs_move_dir(struct kobject *kobj,
111                                 struct kobject *new_parent_kobj);
112
113 int __must_check sysfs_create_file(struct kobject *kobj,
114                                    const struct attribute *attr);
115 int __must_check sysfs_create_files(struct kobject *kobj,
116                                    const struct attribute **attr);
117 int __must_check sysfs_chmod_file(struct kobject *kobj, struct attribute *attr,
118                                   mode_t mode);
119 void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr);
120 void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
121
122 int __must_check sysfs_create_bin_file(struct kobject *kobj,
123                                        const struct bin_attribute *attr);
124 void sysfs_remove_bin_file(struct kobject *kobj,
125                            const struct bin_attribute *attr);
126
127 int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
128                                    const char *name);
129 int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
130                                           struct kobject *target,
131                                           const char *name);
132 void sysfs_remove_link(struct kobject *kobj, const char *name);
133
134 int __must_check sysfs_create_group(struct kobject *kobj,
135                                     const struct attribute_group *grp);
136 int sysfs_update_group(struct kobject *kobj,
137                        const struct attribute_group *grp);
138 void sysfs_remove_group(struct kobject *kobj,
139                         const struct attribute_group *grp);
140 int sysfs_add_file_to_group(struct kobject *kobj,
141                         const struct attribute *attr, const char *group);
142 void sysfs_remove_file_from_group(struct kobject *kobj,
143                         const struct attribute *attr, const char *group);
144
145 void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
146 void sysfs_notify_dirent(struct sysfs_dirent *sd);
147 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
148                                       const unsigned char *name);
149 struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd);
150 void sysfs_put(struct sysfs_dirent *sd);
151 void sysfs_printk_last_file(void);
152 int __must_check sysfs_init(void);
153
154 #else /* CONFIG_SYSFS */
155
156 static inline int sysfs_schedule_callback(struct kobject *kobj,
157                 void (*func)(void *), void *data, struct module *owner)
158 {
159         return -ENOSYS;
160 }
161
162 static inline int sysfs_create_dir(struct kobject *kobj)
163 {
164         return 0;
165 }
166
167 static inline void sysfs_remove_dir(struct kobject *kobj)
168 {
169 }
170
171 static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
172 {
173         return 0;
174 }
175
176 static inline int sysfs_move_dir(struct kobject *kobj,
177                                  struct kobject *new_parent_kobj)
178 {
179         return 0;
180 }
181
182 static inline int sysfs_create_file(struct kobject *kobj,
183                                     const struct attribute *attr)
184 {
185         return 0;
186 }
187
188 static inline int sysfs_create_files(struct kobject *kobj,
189                                     const struct attribute **attr)
190 {
191         return 0;
192 }
193
194 static inline int sysfs_chmod_file(struct kobject *kobj,
195                                    struct attribute *attr, mode_t mode)
196 {
197         return 0;
198 }
199
200 static inline void sysfs_remove_file(struct kobject *kobj,
201                                      const struct attribute *attr)
202 {
203 }
204
205 static inline void sysfs_remove_files(struct kobject *kobj,
206                                      const struct attribute **attr)
207 {
208 }
209
210 static inline int sysfs_create_bin_file(struct kobject *kobj,
211                                         const struct bin_attribute *attr)
212 {
213         return 0;
214 }
215
216 static inline void sysfs_remove_bin_file(struct kobject *kobj,
217                                          const struct bin_attribute *attr)
218 {
219 }
220
221 static inline int sysfs_create_link(struct kobject *kobj,
222                                     struct kobject *target, const char *name)
223 {
224         return 0;
225 }
226
227 static inline int sysfs_create_link_nowarn(struct kobject *kobj,
228                                            struct kobject *target,
229                                            const char *name)
230 {
231         return 0;
232 }
233
234 static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
235 {
236 }
237
238 static inline int sysfs_create_group(struct kobject *kobj,
239                                      const struct attribute_group *grp)
240 {
241         return 0;
242 }
243
244 static inline int sysfs_update_group(struct kobject *kobj,
245                                 const struct attribute_group *grp)
246 {
247         return 0;
248 }
249
250 static inline void sysfs_remove_group(struct kobject *kobj,
251                                       const struct attribute_group *grp)
252 {
253 }
254
255 static inline int sysfs_add_file_to_group(struct kobject *kobj,
256                 const struct attribute *attr, const char *group)
257 {
258         return 0;
259 }
260
261 static inline void sysfs_remove_file_from_group(struct kobject *kobj,
262                 const struct attribute *attr, const char *group)
263 {
264 }
265
266 static inline void sysfs_notify(struct kobject *kobj, const char *dir,
267                                 const char *attr)
268 {
269 }
270 static inline void sysfs_notify_dirent(struct sysfs_dirent *sd)
271 {
272 }
273 static inline
274 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
275                                       const unsigned char *name)
276 {
277         return NULL;
278 }
279 static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
280 {
281         return NULL;
282 }
283 static inline void sysfs_put(struct sysfs_dirent *sd)
284 {
285 }
286
287 static inline int __must_check sysfs_init(void)
288 {
289         return 0;
290 }
291
292 static inline void sysfs_printk_last_file(void)
293 {
294 }
295
296 #endif /* CONFIG_SYSFS */
297
298 #endif /* _SYSFS_H_ */