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