Commit | Line | Data |
---|---|---|
1da177e4 LT |
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. | |
6d66f5cd TH |
6 | * Copyright (c) 2007 SUSE Linux Products GmbH |
7 | * Copyright (c) 2007 Tejun Heo <teheo@suse.de> | |
1da177e4 LT |
8 | * |
9 | * Please see Documentation/filesystems/sysfs.txt for more information. | |
10 | */ | |
11 | ||
12 | #ifndef _SYSFS_H_ | |
13 | #define _SYSFS_H_ | |
14 | ||
4a7fb636 | 15 | #include <linux/compiler.h> |
5851fadc | 16 | #include <linux/errno.h> |
bf0acc33 | 17 | #include <linux/list.h> |
6992f533 | 18 | #include <linux/lockdep.h> |
8488a38f | 19 | #include <linux/kobject_ns.h> |
60063497 | 20 | #include <linux/atomic.h> |
1da177e4 LT |
21 | |
22 | struct kobject; | |
23 | struct module; | |
3ff195b0 | 24 | enum kobj_ns_type; |
1da177e4 LT |
25 | |
26 | struct attribute { | |
59f69015 | 27 | const char *name; |
9104e427 | 28 | umode_t mode; |
6992f533 EB |
29 | #ifdef CONFIG_DEBUG_LOCK_ALLOC |
30 | struct lock_class_key *key; | |
31 | struct lock_class_key skey; | |
32 | #endif | |
1da177e4 LT |
33 | }; |
34 | ||
35960258 EB |
35 | /** |
36 | * sysfs_attr_init - initialize a dynamically allocated sysfs attribute | |
37 | * @attr: struct attribute to initialize | |
38 | * | |
39 | * Initialize a dynamically allocated struct attribute so we can | |
40 | * make lockdep happy. This is a new requirement for attributes | |
41 | * and initially this is only needed when lockdep is enabled. | |
42 | * Lockdep gives a nice error when your attribute is added to | |
43 | * sysfs if you don't have this. | |
44 | */ | |
6992f533 EB |
45 | #ifdef CONFIG_DEBUG_LOCK_ALLOC |
46 | #define sysfs_attr_init(attr) \ | |
47 | do { \ | |
48 | static struct lock_class_key __key; \ | |
49 | \ | |
50 | (attr)->key = &__key; \ | |
51 | } while(0) | |
52 | #else | |
53 | #define sysfs_attr_init(attr) do {} while(0) | |
54 | #endif | |
55 | ||
1da177e4 | 56 | struct attribute_group { |
59f69015 | 57 | const char *name; |
587a1f16 | 58 | umode_t (*is_visible)(struct kobject *, |
d4acd722 | 59 | struct attribute *, int); |
59f69015 | 60 | struct attribute **attrs; |
1da177e4 LT |
61 | }; |
62 | ||
63 | ||
64 | ||
65 | /** | |
66 | * Use these macros to make defining attributes easier. See include/linux/device.h | |
67 | * for examples.. | |
68 | */ | |
69 | ||
70 | #define __ATTR(_name,_mode,_show,_store) { \ | |
7b595756 | 71 | .attr = {.name = __stringify(_name), .mode = _mode }, \ |
1da177e4 LT |
72 | .show = _show, \ |
73 | .store = _store, \ | |
74 | } | |
75 | ||
76 | #define __ATTR_RO(_name) { \ | |
7b595756 TH |
77 | .attr = { .name = __stringify(_name), .mode = 0444 }, \ |
78 | .show = _name##_show, \ | |
1da177e4 LT |
79 | } |
80 | ||
81 | #define __ATTR_NULL { .attr = { .name = NULL } } | |
82 | ||
83 | #define attr_name(_attr) (_attr).attr.name | |
84 | ||
2c3c8bea | 85 | struct file; |
1da177e4 LT |
86 | struct vm_area_struct; |
87 | ||
88 | struct bin_attribute { | |
89 | struct attribute attr; | |
90 | size_t size; | |
91 | void *private; | |
2c3c8bea | 92 | ssize_t (*read)(struct file *, struct kobject *, struct bin_attribute *, |
91a69029 | 93 | char *, loff_t, size_t); |
2c3c8bea | 94 | ssize_t (*write)(struct file *,struct kobject *, struct bin_attribute *, |
91a69029 | 95 | char *, loff_t, size_t); |
2c3c8bea | 96 | int (*mmap)(struct file *, struct kobject *, struct bin_attribute *attr, |
1da177e4 LT |
97 | struct vm_area_struct *vma); |
98 | }; | |
99 | ||
35960258 EB |
100 | /** |
101 | * sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute | |
102 | * @attr: struct bin_attribute to initialize | |
103 | * | |
104 | * Initialize a dynamically allocated struct bin_attribute so we | |
105 | * can make lockdep happy. This is a new requirement for | |
106 | * attributes and initially this is only needed when lockdep is | |
107 | * enabled. Lockdep gives a nice error when your attribute is | |
108 | * added to sysfs if you don't have this. | |
109 | */ | |
62e877b8 | 110 | #define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr) |
6992f533 | 111 | |
1da177e4 LT |
112 | struct sysfs_ops { |
113 | ssize_t (*show)(struct kobject *, struct attribute *,char *); | |
114 | ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t); | |
487505c2 | 115 | const void *(*namespace)(struct kobject *, const struct attribute *); |
1da177e4 LT |
116 | }; |
117 | ||
f1282c84 NB |
118 | struct sysfs_dirent; |
119 | ||
1da177e4 LT |
120 | #ifdef CONFIG_SYSFS |
121 | ||
59f69015 TH |
122 | int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *), |
123 | void *data, struct module *owner); | |
1da177e4 | 124 | |
59f69015 TH |
125 | int __must_check sysfs_create_dir(struct kobject *kobj); |
126 | void sysfs_remove_dir(struct kobject *kobj); | |
127 | int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name); | |
128 | int __must_check sysfs_move_dir(struct kobject *kobj, | |
129 | struct kobject *new_parent_kobj); | |
31e5abe9 | 130 | |
59f69015 TH |
131 | int __must_check sysfs_create_file(struct kobject *kobj, |
132 | const struct attribute *attr); | |
1c205ae1 AK |
133 | int __must_check sysfs_create_files(struct kobject *kobj, |
134 | const struct attribute **attr); | |
49c19400 | 135 | int __must_check sysfs_chmod_file(struct kobject *kobj, |
48176a97 | 136 | const struct attribute *attr, umode_t mode); |
59f69015 | 137 | void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr); |
1c205ae1 | 138 | void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr); |
1da177e4 | 139 | |
4a7fb636 | 140 | int __must_check sysfs_create_bin_file(struct kobject *kobj, |
66ecb92b PC |
141 | const struct bin_attribute *attr); |
142 | void sysfs_remove_bin_file(struct kobject *kobj, | |
143 | const struct bin_attribute *attr); | |
1da177e4 | 144 | |
59f69015 TH |
145 | int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target, |
146 | const char *name); | |
36ce6dad CH |
147 | int __must_check sysfs_create_link_nowarn(struct kobject *kobj, |
148 | struct kobject *target, | |
149 | const char *name); | |
59f69015 TH |
150 | void sysfs_remove_link(struct kobject *kobj, const char *name); |
151 | ||
7cb32942 EB |
152 | int sysfs_rename_link(struct kobject *kobj, struct kobject *target, |
153 | const char *old_name, const char *new_name); | |
154 | ||
746edb7a EB |
155 | void sysfs_delete_link(struct kobject *dir, struct kobject *targ, |
156 | const char *name); | |
157 | ||
59f69015 TH |
158 | int __must_check sysfs_create_group(struct kobject *kobj, |
159 | const struct attribute_group *grp); | |
0f423895 JB |
160 | int sysfs_update_group(struct kobject *kobj, |
161 | const struct attribute_group *grp); | |
59f69015 TH |
162 | void sysfs_remove_group(struct kobject *kobj, |
163 | const struct attribute_group *grp); | |
dfa87c82 | 164 | int sysfs_add_file_to_group(struct kobject *kobj, |
59f69015 | 165 | const struct attribute *attr, const char *group); |
dfa87c82 | 166 | void sysfs_remove_file_from_group(struct kobject *kobj, |
59f69015 | 167 | const struct attribute *attr, const char *group); |
69d44ffb AS |
168 | int sysfs_merge_group(struct kobject *kobj, |
169 | const struct attribute_group *grp); | |
170 | void sysfs_unmerge_group(struct kobject *kobj, | |
171 | const struct attribute_group *grp); | |
dfa87c82 | 172 | |
8c0e3998 | 173 | void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr); |
f1282c84 NB |
174 | void sysfs_notify_dirent(struct sysfs_dirent *sd); |
175 | struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd, | |
3ff195b0 | 176 | const void *ns, |
f1282c84 NB |
177 | const unsigned char *name); |
178 | struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd); | |
179 | void sysfs_put(struct sysfs_dirent *sd); | |
3ff195b0 | 180 | |
f1282c84 | 181 | int __must_check sysfs_init(void); |
f20a9ead | 182 | |
1da177e4 LT |
183 | #else /* CONFIG_SYSFS */ |
184 | ||
d9a9cdfb | 185 | static inline int sysfs_schedule_callback(struct kobject *kobj, |
523ded71 | 186 | void (*func)(void *), void *data, struct module *owner) |
d9a9cdfb AS |
187 | { |
188 | return -ENOSYS; | |
189 | } | |
190 | ||
59f69015 | 191 | static inline int sysfs_create_dir(struct kobject *kobj) |
1da177e4 LT |
192 | { |
193 | return 0; | |
194 | } | |
195 | ||
59f69015 | 196 | static inline void sysfs_remove_dir(struct kobject *kobj) |
1da177e4 | 197 | { |
1da177e4 LT |
198 | } |
199 | ||
59f69015 | 200 | static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name) |
1da177e4 | 201 | { |
0b4a4fea | 202 | return 0; |
1da177e4 LT |
203 | } |
204 | ||
59f69015 TH |
205 | static inline int sysfs_move_dir(struct kobject *kobj, |
206 | struct kobject *new_parent_kobj) | |
8a82472f CH |
207 | { |
208 | return 0; | |
209 | } | |
210 | ||
59f69015 TH |
211 | static inline int sysfs_create_file(struct kobject *kobj, |
212 | const struct attribute *attr) | |
1da177e4 LT |
213 | { |
214 | return 0; | |
215 | } | |
216 | ||
1c205ae1 AK |
217 | static inline int sysfs_create_files(struct kobject *kobj, |
218 | const struct attribute **attr) | |
219 | { | |
220 | return 0; | |
221 | } | |
222 | ||
59f69015 | 223 | static inline int sysfs_chmod_file(struct kobject *kobj, |
48176a97 | 224 | const struct attribute *attr, umode_t mode) |
31e5abe9 KS |
225 | { |
226 | return 0; | |
227 | } | |
1da177e4 | 228 | |
59f69015 TH |
229 | static inline void sysfs_remove_file(struct kobject *kobj, |
230 | const struct attribute *attr) | |
1da177e4 | 231 | { |
1da177e4 LT |
232 | } |
233 | ||
1c205ae1 AK |
234 | static inline void sysfs_remove_files(struct kobject *kobj, |
235 | const struct attribute **attr) | |
236 | { | |
237 | } | |
238 | ||
59f69015 | 239 | static inline int sysfs_create_bin_file(struct kobject *kobj, |
66ecb92b | 240 | const struct bin_attribute *attr) |
1da177e4 LT |
241 | { |
242 | return 0; | |
243 | } | |
244 | ||
3612e06b | 245 | static inline void sysfs_remove_bin_file(struct kobject *kobj, |
66ecb92b | 246 | const struct bin_attribute *attr) |
1da177e4 | 247 | { |
1da177e4 LT |
248 | } |
249 | ||
59f69015 TH |
250 | static inline int sysfs_create_link(struct kobject *kobj, |
251 | struct kobject *target, const char *name) | |
1da177e4 LT |
252 | { |
253 | return 0; | |
254 | } | |
255 | ||
36ce6dad CH |
256 | static inline int sysfs_create_link_nowarn(struct kobject *kobj, |
257 | struct kobject *target, | |
258 | const char *name) | |
259 | { | |
260 | return 0; | |
261 | } | |
262 | ||
59f69015 | 263 | static inline void sysfs_remove_link(struct kobject *kobj, const char *name) |
1da177e4 | 264 | { |
1da177e4 LT |
265 | } |
266 | ||
7cb32942 EB |
267 | static inline int sysfs_rename_link(struct kobject *k, struct kobject *t, |
268 | const char *old_name, const char *new_name) | |
269 | { | |
270 | return 0; | |
271 | } | |
272 | ||
746edb7a EB |
273 | static inline void sysfs_delete_link(struct kobject *k, struct kobject *t, |
274 | const char *name) | |
275 | { | |
276 | } | |
277 | ||
59f69015 TH |
278 | static inline int sysfs_create_group(struct kobject *kobj, |
279 | const struct attribute_group *grp) | |
1da177e4 LT |
280 | { |
281 | return 0; | |
282 | } | |
283 | ||
1cbfb7a5 RD |
284 | static inline int sysfs_update_group(struct kobject *kobj, |
285 | const struct attribute_group *grp) | |
286 | { | |
287 | return 0; | |
288 | } | |
289 | ||
59f69015 TH |
290 | static inline void sysfs_remove_group(struct kobject *kobj, |
291 | const struct attribute_group *grp) | |
1da177e4 | 292 | { |
1da177e4 LT |
293 | } |
294 | ||
dfa87c82 AS |
295 | static inline int sysfs_add_file_to_group(struct kobject *kobj, |
296 | const struct attribute *attr, const char *group) | |
297 | { | |
298 | return 0; | |
299 | } | |
300 | ||
301 | static inline void sysfs_remove_file_from_group(struct kobject *kobj, | |
d701d8a3 | 302 | const struct attribute *attr, const char *group) |
dfa87c82 | 303 | { |
dfa87c82 AS |
304 | } |
305 | ||
69d44ffb AS |
306 | static inline int sysfs_merge_group(struct kobject *kobj, |
307 | const struct attribute_group *grp) | |
308 | { | |
309 | return 0; | |
310 | } | |
311 | ||
312 | static inline void sysfs_unmerge_group(struct kobject *kobj, | |
313 | const struct attribute_group *grp) | |
314 | { | |
315 | } | |
316 | ||
8c0e3998 TP |
317 | static inline void sysfs_notify(struct kobject *kobj, const char *dir, |
318 | const char *attr) | |
4508a7a7 N |
319 | { |
320 | } | |
f1282c84 NB |
321 | static inline void sysfs_notify_dirent(struct sysfs_dirent *sd) |
322 | { | |
323 | } | |
324 | static inline | |
325 | struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd, | |
3ff195b0 | 326 | const void *ns, |
f1282c84 NB |
327 | const unsigned char *name) |
328 | { | |
329 | return NULL; | |
330 | } | |
331 | static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd) | |
332 | { | |
333 | return NULL; | |
334 | } | |
335 | static inline void sysfs_put(struct sysfs_dirent *sd) | |
336 | { | |
337 | } | |
4508a7a7 | 338 | |
f20a9ead AM |
339 | static inline int __must_check sysfs_init(void) |
340 | { | |
341 | return 0; | |
342 | } | |
343 | ||
1da177e4 LT |
344 | #endif /* CONFIG_SYSFS */ |
345 | ||
346 | #endif /* _SYSFS_H_ */ |