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