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> |
3493f69f | 20 | #include <linux/stat.h> |
60063497 | 21 | #include <linux/atomic.h> |
1da177e4 LT |
22 | |
23 | struct kobject; | |
24 | struct module; | |
6ab9cea1 | 25 | struct bin_attribute; |
3ff195b0 | 26 | enum kobj_ns_type; |
1da177e4 LT |
27 | |
28 | struct attribute { | |
59f69015 | 29 | const char *name; |
9104e427 | 30 | umode_t mode; |
6992f533 | 31 | #ifdef CONFIG_DEBUG_LOCK_ALLOC |
356c05d5 | 32 | bool ignore_lockdep:1; |
6992f533 EB |
33 | struct lock_class_key *key; |
34 | struct lock_class_key skey; | |
35 | #endif | |
1da177e4 LT |
36 | }; |
37 | ||
35960258 EB |
38 | /** |
39 | * sysfs_attr_init - initialize a dynamically allocated sysfs attribute | |
40 | * @attr: struct attribute to initialize | |
41 | * | |
42 | * Initialize a dynamically allocated struct attribute so we can | |
43 | * make lockdep happy. This is a new requirement for attributes | |
44 | * and initially this is only needed when lockdep is enabled. | |
45 | * Lockdep gives a nice error when your attribute is added to | |
46 | * sysfs if you don't have this. | |
47 | */ | |
6992f533 EB |
48 | #ifdef CONFIG_DEBUG_LOCK_ALLOC |
49 | #define sysfs_attr_init(attr) \ | |
50 | do { \ | |
51 | static struct lock_class_key __key; \ | |
52 | \ | |
53 | (attr)->key = &__key; \ | |
5da5c9c8 | 54 | } while (0) |
6992f533 | 55 | #else |
5da5c9c8 | 56 | #define sysfs_attr_init(attr) do {} while (0) |
6992f533 EB |
57 | #endif |
58 | ||
1da177e4 | 59 | struct attribute_group { |
59f69015 | 60 | const char *name; |
587a1f16 | 61 | umode_t (*is_visible)(struct kobject *, |
d4acd722 | 62 | struct attribute *, int); |
59f69015 | 63 | struct attribute **attrs; |
6ab9cea1 | 64 | struct bin_attribute **bin_attrs; |
1da177e4 LT |
65 | }; |
66 | ||
1da177e4 LT |
67 | /** |
68 | * Use these macros to make defining attributes easier. See include/linux/device.h | |
69 | * for examples.. | |
70 | */ | |
71 | ||
5da5c9c8 | 72 | #define __ATTR(_name, _mode, _show, _store) { \ |
aa01aa3c OS |
73 | .attr = {.name = __stringify(_name), .mode = _mode }, \ |
74 | .show = _show, \ | |
75 | .store = _store, \ | |
1da177e4 LT |
76 | } |
77 | ||
aa01aa3c OS |
78 | #define __ATTR_RO(_name) { \ |
79 | .attr = { .name = __stringify(_name), .mode = S_IRUGO }, \ | |
80 | .show = _name##_show, \ | |
1da177e4 LT |
81 | } |
82 | ||
a65fcce7 GKH |
83 | #define __ATTR_WO(_name) { \ |
84 | .attr = { .name = __stringify(_name), .mode = S_IWUSR }, \ | |
85 | .store = _name##_store, \ | |
86 | } | |
87 | ||
aa01aa3c OS |
88 | #define __ATTR_RW(_name) __ATTR(_name, (S_IWUSR | S_IRUGO), \ |
89 | _name##_show, _name##_store) | |
b9b32597 | 90 | |
1da177e4 | 91 | #define __ATTR_NULL { .attr = { .name = NULL } } |
356c05d5 AS |
92 | |
93 | #ifdef CONFIG_DEBUG_LOCK_ALLOC | |
94 | #define __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) { \ | |
95 | .attr = {.name = __stringify(_name), .mode = _mode, \ | |
96 | .ignore_lockdep = true }, \ | |
97 | .show = _show, \ | |
98 | .store = _store, \ | |
99 | } | |
100 | #else | |
101 | #define __ATTR_IGNORE_LOCKDEP __ATTR | |
102 | #endif | |
1da177e4 | 103 | |
3493f69f OS |
104 | #define __ATTRIBUTE_GROUPS(_name) \ |
105 | static const struct attribute_group *_name##_groups[] = { \ | |
106 | &_name##_group, \ | |
f2f37f58 GKH |
107 | NULL, \ |
108 | } | |
109 | ||
3493f69f OS |
110 | #define ATTRIBUTE_GROUPS(_name) \ |
111 | static const struct attribute_group _name##_group = { \ | |
112 | .attrs = _name##_attrs, \ | |
113 | }; \ | |
114 | __ATTRIBUTE_GROUPS(_name) | |
115 | ||
2c3c8bea | 116 | struct file; |
1da177e4 LT |
117 | struct vm_area_struct; |
118 | ||
119 | struct bin_attribute { | |
120 | struct attribute attr; | |
121 | size_t size; | |
122 | void *private; | |
2c3c8bea | 123 | ssize_t (*read)(struct file *, struct kobject *, struct bin_attribute *, |
91a69029 | 124 | char *, loff_t, size_t); |
5da5c9c8 | 125 | ssize_t (*write)(struct file *, struct kobject *, struct bin_attribute *, |
91a69029 | 126 | char *, loff_t, size_t); |
2c3c8bea | 127 | int (*mmap)(struct file *, struct kobject *, struct bin_attribute *attr, |
1da177e4 LT |
128 | struct vm_area_struct *vma); |
129 | }; | |
130 | ||
35960258 EB |
131 | /** |
132 | * sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute | |
133 | * @attr: struct bin_attribute to initialize | |
134 | * | |
135 | * Initialize a dynamically allocated struct bin_attribute so we | |
136 | * can make lockdep happy. This is a new requirement for | |
137 | * attributes and initially this is only needed when lockdep is | |
138 | * enabled. Lockdep gives a nice error when your attribute is | |
139 | * added to sysfs if you don't have this. | |
140 | */ | |
62e877b8 | 141 | #define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr) |
6992f533 | 142 | |
3493f69f OS |
143 | /* macros to create static binary attributes easier */ |
144 | #define __BIN_ATTR(_name, _mode, _read, _write, _size) { \ | |
145 | .attr = { .name = __stringify(_name), .mode = _mode }, \ | |
146 | .read = _read, \ | |
147 | .write = _write, \ | |
148 | .size = _size, \ | |
149 | } | |
150 | ||
151 | #define __BIN_ATTR_RO(_name, _size) { \ | |
152 | .attr = { .name = __stringify(_name), .mode = S_IRUGO }, \ | |
153 | .read = _name##_read, \ | |
154 | .size = _size, \ | |
e4b63603 GKH |
155 | } |
156 | ||
3493f69f OS |
157 | #define __BIN_ATTR_RW(_name, _size) __BIN_ATTR(_name, \ |
158 | (S_IWUSR | S_IRUGO), _name##_read, \ | |
68531526 | 159 | _name##_write, _size) |
3493f69f OS |
160 | |
161 | #define __BIN_ATTR_NULL __ATTR_NULL | |
162 | ||
163 | #define BIN_ATTR(_name, _mode, _read, _write, _size) \ | |
164 | struct bin_attribute bin_attr_##_name = __BIN_ATTR(_name, _mode, _read, \ | |
165 | _write, _size) | |
166 | ||
167 | #define BIN_ATTR_RO(_name, _size) \ | |
168 | struct bin_attribute bin_attr_##_name = __BIN_ATTR_RO(_name, _size) | |
169 | ||
170 | #define BIN_ATTR_RW(_name, _size) \ | |
171 | struct bin_attribute bin_attr_##_name = __BIN_ATTR_RW(_name, _size) | |
172 | ||
1da177e4 | 173 | struct sysfs_ops { |
5da5c9c8 GKH |
174 | ssize_t (*show)(struct kobject *, struct attribute *, char *); |
175 | ssize_t (*store)(struct kobject *, struct attribute *, const char *, size_t); | |
1da177e4 LT |
176 | }; |
177 | ||
f1282c84 NB |
178 | struct sysfs_dirent; |
179 | ||
1da177e4 LT |
180 | #ifdef CONFIG_SYSFS |
181 | ||
59f69015 TH |
182 | int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *), |
183 | void *data, struct module *owner); | |
1da177e4 | 184 | |
e34ff490 | 185 | int __must_check sysfs_create_dir_ns(struct kobject *kobj, const void *ns); |
59f69015 | 186 | void sysfs_remove_dir(struct kobject *kobj); |
e34ff490 TH |
187 | int __must_check sysfs_rename_dir_ns(struct kobject *kobj, const char *new_name, |
188 | const void *new_ns); | |
189 | int __must_check sysfs_move_dir_ns(struct kobject *kobj, | |
190 | struct kobject *new_parent_kobj, | |
191 | const void *new_ns); | |
31e5abe9 | 192 | |
58292cbe TH |
193 | int __must_check sysfs_create_file_ns(struct kobject *kobj, |
194 | const struct attribute *attr, | |
195 | const void *ns); | |
1c205ae1 AK |
196 | int __must_check sysfs_create_files(struct kobject *kobj, |
197 | const struct attribute **attr); | |
49c19400 | 198 | int __must_check sysfs_chmod_file(struct kobject *kobj, |
48176a97 | 199 | const struct attribute *attr, umode_t mode); |
58292cbe TH |
200 | void sysfs_remove_file_ns(struct kobject *kobj, const struct attribute *attr, |
201 | const void *ns); | |
1c205ae1 | 202 | void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr); |
1da177e4 | 203 | |
4a7fb636 | 204 | int __must_check sysfs_create_bin_file(struct kobject *kobj, |
66ecb92b PC |
205 | const struct bin_attribute *attr); |
206 | void sysfs_remove_bin_file(struct kobject *kobj, | |
207 | const struct bin_attribute *attr); | |
1da177e4 | 208 | |
59f69015 TH |
209 | int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target, |
210 | const char *name); | |
36ce6dad CH |
211 | int __must_check sysfs_create_link_nowarn(struct kobject *kobj, |
212 | struct kobject *target, | |
213 | const char *name); | |
59f69015 TH |
214 | void sysfs_remove_link(struct kobject *kobj, const char *name); |
215 | ||
4b30ee58 TH |
216 | int sysfs_rename_link_ns(struct kobject *kobj, struct kobject *target, |
217 | const char *old_name, const char *new_name, | |
218 | const void *new_ns); | |
7cb32942 | 219 | |
746edb7a EB |
220 | void sysfs_delete_link(struct kobject *dir, struct kobject *targ, |
221 | const char *name); | |
222 | ||
59f69015 TH |
223 | int __must_check sysfs_create_group(struct kobject *kobj, |
224 | const struct attribute_group *grp); | |
3e9b2bae GKH |
225 | int __must_check sysfs_create_groups(struct kobject *kobj, |
226 | const struct attribute_group **groups); | |
0f423895 JB |
227 | int sysfs_update_group(struct kobject *kobj, |
228 | const struct attribute_group *grp); | |
59f69015 TH |
229 | void sysfs_remove_group(struct kobject *kobj, |
230 | const struct attribute_group *grp); | |
3e9b2bae GKH |
231 | void sysfs_remove_groups(struct kobject *kobj, |
232 | const struct attribute_group **groups); | |
dfa87c82 | 233 | int sysfs_add_file_to_group(struct kobject *kobj, |
59f69015 | 234 | const struct attribute *attr, const char *group); |
dfa87c82 | 235 | void sysfs_remove_file_from_group(struct kobject *kobj, |
59f69015 | 236 | const struct attribute *attr, const char *group); |
69d44ffb AS |
237 | int sysfs_merge_group(struct kobject *kobj, |
238 | const struct attribute_group *grp); | |
239 | void sysfs_unmerge_group(struct kobject *kobj, | |
240 | const struct attribute_group *grp); | |
0bb8f3d6 RW |
241 | int sysfs_add_link_to_group(struct kobject *kobj, const char *group_name, |
242 | struct kobject *target, const char *link_name); | |
243 | void sysfs_remove_link_from_group(struct kobject *kobj, const char *group_name, | |
244 | const char *link_name); | |
dfa87c82 | 245 | |
8c0e3998 | 246 | void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr); |
f1282c84 | 247 | void sysfs_notify_dirent(struct sysfs_dirent *sd); |
388975cc TH |
248 | struct sysfs_dirent *sysfs_get_dirent_ns(struct sysfs_dirent *parent_sd, |
249 | const unsigned char *name, | |
250 | const void *ns); | |
f1282c84 NB |
251 | struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd); |
252 | void sysfs_put(struct sysfs_dirent *sd); | |
3ff195b0 | 253 | |
f1282c84 | 254 | int __must_check sysfs_init(void); |
f20a9ead | 255 | |
1da177e4 LT |
256 | #else /* CONFIG_SYSFS */ |
257 | ||
d9a9cdfb | 258 | static inline int sysfs_schedule_callback(struct kobject *kobj, |
523ded71 | 259 | void (*func)(void *), void *data, struct module *owner) |
d9a9cdfb AS |
260 | { |
261 | return -ENOSYS; | |
262 | } | |
263 | ||
e34ff490 | 264 | static inline int sysfs_create_dir_ns(struct kobject *kobj, const void *ns) |
1da177e4 LT |
265 | { |
266 | return 0; | |
267 | } | |
268 | ||
59f69015 | 269 | static inline void sysfs_remove_dir(struct kobject *kobj) |
1da177e4 | 270 | { |
1da177e4 LT |
271 | } |
272 | ||
e34ff490 TH |
273 | static inline int sysfs_rename_dir_ns(struct kobject *kobj, |
274 | const char *new_name, const void *new_ns) | |
1da177e4 | 275 | { |
0b4a4fea | 276 | return 0; |
1da177e4 LT |
277 | } |
278 | ||
e34ff490 TH |
279 | static inline int sysfs_move_dir_ns(struct kobject *kobj, |
280 | struct kobject *new_parent_kobj, | |
281 | const void *new_ns) | |
8a82472f CH |
282 | { |
283 | return 0; | |
284 | } | |
285 | ||
58292cbe TH |
286 | static inline int sysfs_create_file_ns(struct kobject *kobj, |
287 | const struct attribute *attr, | |
288 | const void *ns) | |
1da177e4 LT |
289 | { |
290 | return 0; | |
291 | } | |
292 | ||
1c205ae1 AK |
293 | static inline int sysfs_create_files(struct kobject *kobj, |
294 | const struct attribute **attr) | |
295 | { | |
296 | return 0; | |
297 | } | |
298 | ||
59f69015 | 299 | static inline int sysfs_chmod_file(struct kobject *kobj, |
48176a97 | 300 | const struct attribute *attr, umode_t mode) |
31e5abe9 KS |
301 | { |
302 | return 0; | |
303 | } | |
1da177e4 | 304 | |
58292cbe TH |
305 | static inline void sysfs_remove_file_ns(struct kobject *kobj, |
306 | const struct attribute *attr, | |
307 | const void *ns) | |
1da177e4 | 308 | { |
1da177e4 LT |
309 | } |
310 | ||
1c205ae1 AK |
311 | static inline void sysfs_remove_files(struct kobject *kobj, |
312 | const struct attribute **attr) | |
313 | { | |
314 | } | |
315 | ||
59f69015 | 316 | static inline int sysfs_create_bin_file(struct kobject *kobj, |
66ecb92b | 317 | const struct bin_attribute *attr) |
1da177e4 LT |
318 | { |
319 | return 0; | |
320 | } | |
321 | ||
3612e06b | 322 | static inline void sysfs_remove_bin_file(struct kobject *kobj, |
66ecb92b | 323 | const struct bin_attribute *attr) |
1da177e4 | 324 | { |
1da177e4 LT |
325 | } |
326 | ||
59f69015 TH |
327 | static inline int sysfs_create_link(struct kobject *kobj, |
328 | struct kobject *target, const char *name) | |
1da177e4 LT |
329 | { |
330 | return 0; | |
331 | } | |
332 | ||
36ce6dad CH |
333 | static inline int sysfs_create_link_nowarn(struct kobject *kobj, |
334 | struct kobject *target, | |
335 | const char *name) | |
336 | { | |
337 | return 0; | |
338 | } | |
339 | ||
59f69015 | 340 | static inline void sysfs_remove_link(struct kobject *kobj, const char *name) |
1da177e4 | 341 | { |
1da177e4 LT |
342 | } |
343 | ||
4b30ee58 TH |
344 | static inline int sysfs_rename_link_ns(struct kobject *k, struct kobject *t, |
345 | const char *old_name, | |
346 | const char *new_name, const void *ns) | |
7cb32942 EB |
347 | { |
348 | return 0; | |
349 | } | |
350 | ||
746edb7a EB |
351 | static inline void sysfs_delete_link(struct kobject *k, struct kobject *t, |
352 | const char *name) | |
353 | { | |
354 | } | |
355 | ||
59f69015 TH |
356 | static inline int sysfs_create_group(struct kobject *kobj, |
357 | const struct attribute_group *grp) | |
1da177e4 LT |
358 | { |
359 | return 0; | |
360 | } | |
361 | ||
f7998780 GKH |
362 | static inline int sysfs_create_groups(struct kobject *kobj, |
363 | const struct attribute_group **groups) | |
364 | { | |
574979c6 | 365 | return 0; |
f7998780 GKH |
366 | } |
367 | ||
1cbfb7a5 RD |
368 | static inline int sysfs_update_group(struct kobject *kobj, |
369 | const struct attribute_group *grp) | |
370 | { | |
371 | return 0; | |
372 | } | |
373 | ||
59f69015 TH |
374 | static inline void sysfs_remove_group(struct kobject *kobj, |
375 | const struct attribute_group *grp) | |
1da177e4 | 376 | { |
1da177e4 LT |
377 | } |
378 | ||
f7998780 GKH |
379 | static inline void sysfs_remove_groups(struct kobject *kobj, |
380 | const struct attribute_group **groups) | |
381 | { | |
382 | } | |
383 | ||
dfa87c82 AS |
384 | static inline int sysfs_add_file_to_group(struct kobject *kobj, |
385 | const struct attribute *attr, const char *group) | |
386 | { | |
387 | return 0; | |
388 | } | |
389 | ||
390 | static inline void sysfs_remove_file_from_group(struct kobject *kobj, | |
d701d8a3 | 391 | const struct attribute *attr, const char *group) |
dfa87c82 | 392 | { |
dfa87c82 AS |
393 | } |
394 | ||
69d44ffb AS |
395 | static inline int sysfs_merge_group(struct kobject *kobj, |
396 | const struct attribute_group *grp) | |
397 | { | |
398 | return 0; | |
399 | } | |
400 | ||
401 | static inline void sysfs_unmerge_group(struct kobject *kobj, | |
402 | const struct attribute_group *grp) | |
403 | { | |
404 | } | |
405 | ||
0bb8f3d6 RW |
406 | static inline int sysfs_add_link_to_group(struct kobject *kobj, |
407 | const char *group_name, struct kobject *target, | |
408 | const char *link_name) | |
409 | { | |
410 | return 0; | |
411 | } | |
412 | ||
413 | static inline void sysfs_remove_link_from_group(struct kobject *kobj, | |
414 | const char *group_name, const char *link_name) | |
415 | { | |
416 | } | |
417 | ||
8c0e3998 TP |
418 | static inline void sysfs_notify(struct kobject *kobj, const char *dir, |
419 | const char *attr) | |
4508a7a7 N |
420 | { |
421 | } | |
f1282c84 NB |
422 | static inline void sysfs_notify_dirent(struct sysfs_dirent *sd) |
423 | { | |
424 | } | |
388975cc TH |
425 | static inline struct sysfs_dirent * |
426 | sysfs_get_dirent_ns(struct sysfs_dirent *parent_sd, const unsigned char *name, | |
427 | const void *ns) | |
f1282c84 NB |
428 | { |
429 | return NULL; | |
430 | } | |
431 | static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd) | |
432 | { | |
433 | return NULL; | |
434 | } | |
435 | static inline void sysfs_put(struct sysfs_dirent *sd) | |
436 | { | |
437 | } | |
4508a7a7 | 438 | |
f20a9ead AM |
439 | static inline int __must_check sysfs_init(void) |
440 | { | |
441 | return 0; | |
442 | } | |
443 | ||
1da177e4 LT |
444 | #endif /* CONFIG_SYSFS */ |
445 | ||
58292cbe TH |
446 | static inline int __must_check sysfs_create_file(struct kobject *kobj, |
447 | const struct attribute *attr) | |
448 | { | |
449 | return sysfs_create_file_ns(kobj, attr, NULL); | |
450 | } | |
451 | ||
452 | static inline void sysfs_remove_file(struct kobject *kobj, | |
453 | const struct attribute *attr) | |
454 | { | |
455 | return sysfs_remove_file_ns(kobj, attr, NULL); | |
456 | } | |
457 | ||
4b30ee58 TH |
458 | static inline int sysfs_rename_link(struct kobject *kobj, struct kobject *target, |
459 | const char *old_name, const char *new_name) | |
460 | { | |
461 | return sysfs_rename_link_ns(kobj, target, old_name, new_name, NULL); | |
462 | } | |
463 | ||
388975cc TH |
464 | static inline struct sysfs_dirent * |
465 | sysfs_get_dirent(struct sysfs_dirent *parent_sd, const unsigned char *name) | |
466 | { | |
467 | return sysfs_get_dirent_ns(parent_sd, name, NULL); | |
468 | } | |
469 | ||
1da177e4 | 470 | #endif /* _SYSFS_H_ */ |