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> |
1da177e4 LT |
18 | #include <asm/atomic.h> |
19 | ||
20 | struct kobject; | |
21 | struct module; | |
22 | ||
7b595756 TH |
23 | /* FIXME |
24 | * The *owner field is no longer used, but leave around | |
25 | * until the tree gets cleaned up fully. | |
26 | */ | |
1da177e4 | 27 | struct attribute { |
59f69015 TH |
28 | const char *name; |
29 | struct module *owner; | |
1da177e4 LT |
30 | mode_t mode; |
31 | }; | |
32 | ||
33 | struct attribute_group { | |
59f69015 | 34 | const char *name; |
d4acd722 JB |
35 | int (*is_visible)(struct kobject *, |
36 | struct attribute *, int); | |
59f69015 | 37 | struct attribute **attrs; |
1da177e4 LT |
38 | }; |
39 | ||
40 | ||
41 | ||
42 | /** | |
43 | * Use these macros to make defining attributes easier. See include/linux/device.h | |
44 | * for examples.. | |
45 | */ | |
46 | ||
47 | #define __ATTR(_name,_mode,_show,_store) { \ | |
7b595756 | 48 | .attr = {.name = __stringify(_name), .mode = _mode }, \ |
1da177e4 LT |
49 | .show = _show, \ |
50 | .store = _store, \ | |
51 | } | |
52 | ||
53 | #define __ATTR_RO(_name) { \ | |
7b595756 TH |
54 | .attr = { .name = __stringify(_name), .mode = 0444 }, \ |
55 | .show = _name##_show, \ | |
1da177e4 LT |
56 | } |
57 | ||
58 | #define __ATTR_NULL { .attr = { .name = NULL } } | |
59 | ||
60 | #define attr_name(_attr) (_attr).attr.name | |
61 | ||
62 | struct vm_area_struct; | |
63 | ||
64 | struct bin_attribute { | |
65 | struct attribute attr; | |
66 | size_t size; | |
67 | void *private; | |
91a69029 ZR |
68 | ssize_t (*read)(struct kobject *, struct bin_attribute *, |
69 | char *, loff_t, size_t); | |
70 | ssize_t (*write)(struct kobject *, struct bin_attribute *, | |
71 | char *, loff_t, size_t); | |
1da177e4 LT |
72 | int (*mmap)(struct kobject *, struct bin_attribute *attr, |
73 | struct vm_area_struct *vma); | |
74 | }; | |
75 | ||
76 | struct sysfs_ops { | |
77 | ssize_t (*show)(struct kobject *, struct attribute *,char *); | |
78 | ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t); | |
79 | }; | |
80 | ||
1da177e4 LT |
81 | #ifdef CONFIG_SYSFS |
82 | ||
59f69015 TH |
83 | int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *), |
84 | void *data, struct module *owner); | |
1da177e4 | 85 | |
59f69015 TH |
86 | int __must_check sysfs_create_dir(struct kobject *kobj); |
87 | void sysfs_remove_dir(struct kobject *kobj); | |
88 | int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name); | |
89 | int __must_check sysfs_move_dir(struct kobject *kobj, | |
90 | struct kobject *new_parent_kobj); | |
31e5abe9 | 91 | |
59f69015 TH |
92 | int __must_check sysfs_create_file(struct kobject *kobj, |
93 | const struct attribute *attr); | |
59f69015 TH |
94 | int __must_check sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, |
95 | mode_t mode); | |
96 | void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr); | |
1da177e4 | 97 | |
4a7fb636 | 98 | int __must_check sysfs_create_bin_file(struct kobject *kobj, |
59f69015 | 99 | struct bin_attribute *attr); |
995982ca | 100 | void sysfs_remove_bin_file(struct kobject *kobj, struct bin_attribute *attr); |
1da177e4 | 101 | |
59f69015 TH |
102 | int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target, |
103 | const char *name); | |
104 | void sysfs_remove_link(struct kobject *kobj, const char *name); | |
105 | ||
106 | int __must_check sysfs_create_group(struct kobject *kobj, | |
107 | const struct attribute_group *grp); | |
108 | void sysfs_remove_group(struct kobject *kobj, | |
109 | const struct attribute_group *grp); | |
dfa87c82 | 110 | int sysfs_add_file_to_group(struct kobject *kobj, |
59f69015 | 111 | const struct attribute *attr, const char *group); |
dfa87c82 | 112 | void sysfs_remove_file_from_group(struct kobject *kobj, |
59f69015 | 113 | const struct attribute *attr, const char *group); |
dfa87c82 | 114 | |
59f69015 | 115 | void sysfs_notify(struct kobject *kobj, char *dir, char *attr); |
1da177e4 | 116 | |
f20a9ead AM |
117 | extern int __must_check sysfs_init(void); |
118 | ||
1da177e4 LT |
119 | #else /* CONFIG_SYSFS */ |
120 | ||
d9a9cdfb | 121 | static inline int sysfs_schedule_callback(struct kobject *kobj, |
523ded71 | 122 | void (*func)(void *), void *data, struct module *owner) |
d9a9cdfb AS |
123 | { |
124 | return -ENOSYS; | |
125 | } | |
126 | ||
59f69015 | 127 | static inline int sysfs_create_dir(struct kobject *kobj) |
1da177e4 LT |
128 | { |
129 | return 0; | |
130 | } | |
131 | ||
59f69015 | 132 | static inline void sysfs_remove_dir(struct kobject *kobj) |
1da177e4 LT |
133 | { |
134 | ; | |
135 | } | |
136 | ||
59f69015 | 137 | static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name) |
1da177e4 LT |
138 | { |
139 | return 0; | |
140 | } | |
141 | ||
59f69015 TH |
142 | static inline int sysfs_move_dir(struct kobject *kobj, |
143 | struct kobject *new_parent_kobj) | |
8a82472f CH |
144 | { |
145 | return 0; | |
146 | } | |
147 | ||
59f69015 TH |
148 | static inline int sysfs_create_file(struct kobject *kobj, |
149 | const struct attribute *attr) | |
1da177e4 LT |
150 | { |
151 | return 0; | |
152 | } | |
153 | ||
59f69015 TH |
154 | static inline int sysfs_chmod_file(struct kobject *kobj, |
155 | struct attribute *attr, mode_t mode) | |
31e5abe9 KS |
156 | { |
157 | return 0; | |
158 | } | |
1da177e4 | 159 | |
59f69015 TH |
160 | static inline void sysfs_remove_file(struct kobject *kobj, |
161 | const struct attribute *attr) | |
1da177e4 LT |
162 | { |
163 | ; | |
164 | } | |
165 | ||
59f69015 TH |
166 | static inline int sysfs_create_bin_file(struct kobject *kobj, |
167 | struct bin_attribute *attr) | |
1da177e4 LT |
168 | { |
169 | return 0; | |
170 | } | |
171 | ||
59f69015 TH |
172 | static inline int sysfs_remove_bin_file(struct kobject *kobj, |
173 | struct bin_attribute *attr) | |
1da177e4 | 174 | { |
59f69015 | 175 | return 0; |
1da177e4 LT |
176 | } |
177 | ||
59f69015 TH |
178 | static inline int sysfs_create_link(struct kobject *kobj, |
179 | struct kobject *target, const char *name) | |
1da177e4 LT |
180 | { |
181 | return 0; | |
182 | } | |
183 | ||
59f69015 | 184 | static inline void sysfs_remove_link(struct kobject *kobj, const char *name) |
1da177e4 | 185 | { |
59f69015 | 186 | ; |
1da177e4 LT |
187 | } |
188 | ||
59f69015 TH |
189 | static inline int sysfs_create_group(struct kobject *kobj, |
190 | const struct attribute_group *grp) | |
1da177e4 LT |
191 | { |
192 | return 0; | |
193 | } | |
194 | ||
59f69015 TH |
195 | static inline void sysfs_remove_group(struct kobject *kobj, |
196 | const struct attribute_group *grp) | |
1da177e4 LT |
197 | { |
198 | ; | |
199 | } | |
200 | ||
dfa87c82 AS |
201 | static inline int sysfs_add_file_to_group(struct kobject *kobj, |
202 | const struct attribute *attr, const char *group) | |
203 | { | |
204 | return 0; | |
205 | } | |
206 | ||
207 | static inline void sysfs_remove_file_from_group(struct kobject *kobj, | |
d701d8a3 | 208 | const struct attribute *attr, const char *group) |
dfa87c82 | 209 | { |
dfa87c82 AS |
210 | } |
211 | ||
59f69015 | 212 | static inline void sysfs_notify(struct kobject *kobj, char *dir, char *attr) |
4508a7a7 N |
213 | { |
214 | } | |
215 | ||
f20a9ead AM |
216 | static inline int __must_check sysfs_init(void) |
217 | { | |
218 | return 0; | |
219 | } | |
220 | ||
1da177e4 LT |
221 | #endif /* CONFIG_SYSFS */ |
222 | ||
223 | #endif /* _SYSFS_H_ */ |