]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - include/linux/sysfs.h
Merge branch 'master' of git://git.kernel.org/pub/scm/linux/kernel/git/iwlwifi/iwlwif...
[mirror_ubuntu-zesty-kernel.git] / include / linux / sysfs.h
CommitLineData
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
24struct kobject;
25struct module;
6ab9cea1 26struct bin_attribute;
3ff195b0 27enum kobj_ns_type;
1da177e4
LT
28
29struct 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) \
51do { \
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 60struct 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) \
107static const struct attribute_group *_name##_groups[] = { \
108 &_name##_group, \
f2f37f58
GKH
109 NULL, \
110}
111
3493f69f
OS
112#define ATTRIBUTE_GROUPS(_name) \
113static const struct attribute_group _name##_group = { \
114 .attrs = _name##_attrs, \
115}; \
116__ATTRIBUTE_GROUPS(_name)
117
2c3c8bea 118struct file;
1da177e4
LT
119struct vm_area_struct;
120
121struct 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) \
166struct bin_attribute bin_attr_##_name = __BIN_ATTR(_name, _mode, _read, \
167 _write, _size)
168
169#define BIN_ATTR_RO(_name, _size) \
170struct bin_attribute bin_attr_##_name = __BIN_ATTR_RO(_name, _size)
171
172#define BIN_ATTR_RW(_name, _size) \
173struct bin_attribute bin_attr_##_name = __BIN_ATTR_RW(_name, _size)
174
1da177e4 175struct 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
72099304
GKH
182int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
183 void *data, struct module *owner);
184
e34ff490 185int __must_check sysfs_create_dir_ns(struct kobject *kobj, const void *ns);
59f69015 186void sysfs_remove_dir(struct kobject *kobj);
e34ff490
TH
187int __must_check sysfs_rename_dir_ns(struct kobject *kobj, const char *new_name,
188 const void *new_ns);
189int __must_check sysfs_move_dir_ns(struct kobject *kobj,
190 struct kobject *new_parent_kobj,
191 const void *new_ns);
31e5abe9 192
58292cbe
TH
193int __must_check sysfs_create_file_ns(struct kobject *kobj,
194 const struct attribute *attr,
195 const void *ns);
1c205ae1
AK
196int __must_check sysfs_create_files(struct kobject *kobj,
197 const struct attribute **attr);
49c19400 198int __must_check sysfs_chmod_file(struct kobject *kobj,
48176a97 199 const struct attribute *attr, umode_t mode);
58292cbe
TH
200void sysfs_remove_file_ns(struct kobject *kobj, const struct attribute *attr,
201 const void *ns);
6b0afc2a 202bool sysfs_remove_file_self(struct kobject *kobj, const struct attribute *attr);
1c205ae1 203void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
1da177e4 204
4a7fb636 205int __must_check sysfs_create_bin_file(struct kobject *kobj,
66ecb92b
PC
206 const struct bin_attribute *attr);
207void sysfs_remove_bin_file(struct kobject *kobj,
208 const struct bin_attribute *attr);
1da177e4 209
59f69015
TH
210int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
211 const char *name);
36ce6dad
CH
212int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
213 struct kobject *target,
214 const char *name);
59f69015
TH
215void sysfs_remove_link(struct kobject *kobj, const char *name);
216
4b30ee58
TH
217int sysfs_rename_link_ns(struct kobject *kobj, struct kobject *target,
218 const char *old_name, const char *new_name,
219 const void *new_ns);
7cb32942 220
746edb7a
EB
221void sysfs_delete_link(struct kobject *dir, struct kobject *targ,
222 const char *name);
223
59f69015
TH
224int __must_check sysfs_create_group(struct kobject *kobj,
225 const struct attribute_group *grp);
3e9b2bae
GKH
226int __must_check sysfs_create_groups(struct kobject *kobj,
227 const struct attribute_group **groups);
0f423895
JB
228int sysfs_update_group(struct kobject *kobj,
229 const struct attribute_group *grp);
59f69015
TH
230void sysfs_remove_group(struct kobject *kobj,
231 const struct attribute_group *grp);
3e9b2bae
GKH
232void sysfs_remove_groups(struct kobject *kobj,
233 const struct attribute_group **groups);
dfa87c82 234int sysfs_add_file_to_group(struct kobject *kobj,
59f69015 235 const struct attribute *attr, const char *group);
dfa87c82 236void sysfs_remove_file_from_group(struct kobject *kobj,
59f69015 237 const struct attribute *attr, const char *group);
69d44ffb
AS
238int sysfs_merge_group(struct kobject *kobj,
239 const struct attribute_group *grp);
240void sysfs_unmerge_group(struct kobject *kobj,
241 const struct attribute_group *grp);
0bb8f3d6
RW
242int sysfs_add_link_to_group(struct kobject *kobj, const char *group_name,
243 struct kobject *target, const char *link_name);
244void sysfs_remove_link_from_group(struct kobject *kobj, const char *group_name,
245 const char *link_name);
dfa87c82 246
8c0e3998 247void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
3ff195b0 248
f1282c84 249int __must_check sysfs_init(void);
f20a9ead 250
fa4cd451
TH
251static inline void sysfs_enable_ns(struct kernfs_node *kn)
252{
253 return kernfs_enable_ns(kn);
254}
255
1da177e4
LT
256#else /* CONFIG_SYSFS */
257
72099304
GKH
258static inline int sysfs_schedule_callback(struct kobject *kobj,
259 void (*func)(void *), void *data, struct module *owner)
260{
261 return -ENOSYS;
262}
263
e34ff490 264static inline int sysfs_create_dir_ns(struct kobject *kobj, const void *ns)
1da177e4
LT
265{
266 return 0;
267}
268
59f69015 269static inline void sysfs_remove_dir(struct kobject *kobj)
1da177e4 270{
1da177e4
LT
271}
272
e34ff490
TH
273static 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
279static 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
286static 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
293static inline int sysfs_create_files(struct kobject *kobj,
294 const struct attribute **attr)
295{
296 return 0;
297}
298
59f69015 299static 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
305static inline void sysfs_remove_file_ns(struct kobject *kobj,
306 const struct attribute *attr,
307 const void *ns)
1da177e4 308{
1da177e4
LT
309}
310
6b0afc2a
TH
311static inline bool sysfs_remove_file_self(struct kobject *kobj,
312 const struct attribute *attr)
313{
314 return false;
315}
316
1c205ae1
AK
317static inline void sysfs_remove_files(struct kobject *kobj,
318 const struct attribute **attr)
319{
320}
321
59f69015 322static inline int sysfs_create_bin_file(struct kobject *kobj,
66ecb92b 323 const struct bin_attribute *attr)
1da177e4
LT
324{
325 return 0;
326}
327
3612e06b 328static inline void sysfs_remove_bin_file(struct kobject *kobj,
66ecb92b 329 const struct bin_attribute *attr)
1da177e4 330{
1da177e4
LT
331}
332
59f69015
TH
333static inline int sysfs_create_link(struct kobject *kobj,
334 struct kobject *target, const char *name)
1da177e4
LT
335{
336 return 0;
337}
338
36ce6dad
CH
339static inline int sysfs_create_link_nowarn(struct kobject *kobj,
340 struct kobject *target,
341 const char *name)
342{
343 return 0;
344}
345
59f69015 346static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
1da177e4 347{
1da177e4
LT
348}
349
4b30ee58
TH
350static inline int sysfs_rename_link_ns(struct kobject *k, struct kobject *t,
351 const char *old_name,
352 const char *new_name, const void *ns)
7cb32942
EB
353{
354 return 0;
355}
356
746edb7a
EB
357static inline void sysfs_delete_link(struct kobject *k, struct kobject *t,
358 const char *name)
359{
360}
361
59f69015
TH
362static inline int sysfs_create_group(struct kobject *kobj,
363 const struct attribute_group *grp)
1da177e4
LT
364{
365 return 0;
366}
367
f7998780
GKH
368static inline int sysfs_create_groups(struct kobject *kobj,
369 const struct attribute_group **groups)
370{
574979c6 371 return 0;
f7998780
GKH
372}
373
1cbfb7a5
RD
374static inline int sysfs_update_group(struct kobject *kobj,
375 const struct attribute_group *grp)
376{
377 return 0;
378}
379
59f69015
TH
380static inline void sysfs_remove_group(struct kobject *kobj,
381 const struct attribute_group *grp)
1da177e4 382{
1da177e4
LT
383}
384
f7998780
GKH
385static inline void sysfs_remove_groups(struct kobject *kobj,
386 const struct attribute_group **groups)
387{
388}
389
dfa87c82
AS
390static inline int sysfs_add_file_to_group(struct kobject *kobj,
391 const struct attribute *attr, const char *group)
392{
393 return 0;
394}
395
396static inline void sysfs_remove_file_from_group(struct kobject *kobj,
d701d8a3 397 const struct attribute *attr, const char *group)
dfa87c82 398{
dfa87c82
AS
399}
400
69d44ffb
AS
401static inline int sysfs_merge_group(struct kobject *kobj,
402 const struct attribute_group *grp)
403{
404 return 0;
405}
406
407static inline void sysfs_unmerge_group(struct kobject *kobj,
408 const struct attribute_group *grp)
409{
410}
411
0bb8f3d6
RW
412static inline int sysfs_add_link_to_group(struct kobject *kobj,
413 const char *group_name, struct kobject *target,
414 const char *link_name)
415{
416 return 0;
417}
418
419static inline void sysfs_remove_link_from_group(struct kobject *kobj,
420 const char *group_name, const char *link_name)
421{
422}
423
8c0e3998
TP
424static inline void sysfs_notify(struct kobject *kobj, const char *dir,
425 const char *attr)
4508a7a7
N
426{
427}
428
f20a9ead
AM
429static inline int __must_check sysfs_init(void)
430{
431 return 0;
432}
433
fa4cd451
TH
434static inline void sysfs_enable_ns(struct kernfs_node *kn)
435{
436}
437
1da177e4
LT
438#endif /* CONFIG_SYSFS */
439
58292cbe
TH
440static inline int __must_check sysfs_create_file(struct kobject *kobj,
441 const struct attribute *attr)
442{
443 return sysfs_create_file_ns(kobj, attr, NULL);
444}
445
446static inline void sysfs_remove_file(struct kobject *kobj,
447 const struct attribute *attr)
448{
449 return sysfs_remove_file_ns(kobj, attr, NULL);
450}
451
4b30ee58
TH
452static inline int sysfs_rename_link(struct kobject *kobj, struct kobject *target,
453 const char *old_name, const char *new_name)
454{
455 return sysfs_rename_link_ns(kobj, target, old_name, new_name, NULL);
456}
457
324a56e1 458static inline void sysfs_notify_dirent(struct kernfs_node *kn)
ccf73cf3 459{
324a56e1 460 kernfs_notify(kn);
ccf73cf3
TH
461}
462
324a56e1
TH
463static inline struct kernfs_node *sysfs_get_dirent(struct kernfs_node *parent,
464 const unsigned char *name)
388975cc 465{
324a56e1 466 return kernfs_find_and_get(parent, name);
388975cc
TH
467}
468
324a56e1 469static inline struct kernfs_node *sysfs_get(struct kernfs_node *kn)
024f6471 470{
324a56e1
TH
471 kernfs_get(kn);
472 return kn;
ccf73cf3
TH
473}
474
324a56e1 475static inline void sysfs_put(struct kernfs_node *kn)
ccf73cf3 476{
324a56e1 477 kernfs_put(kn);
024f6471
TH
478}
479
1da177e4 480#endif /* _SYSFS_H_ */