]>
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> |
1da177e4 LT |
19 | #include <asm/atomic.h> |
20 | ||
21 | struct kobject; | |
22 | struct module; | |
3ff195b0 | 23 | enum kobj_ns_type; |
1da177e4 | 24 | |
7b595756 | 25 | /* FIXME |
01e8ef11 PW |
26 | * The *owner field is no longer used. |
27 | * x86 tree has been cleaned up. The owner | |
28 | * attribute is still left for other arches. | |
7b595756 | 29 | */ |
1da177e4 | 30 | struct attribute { |
59f69015 TH |
31 | const char *name; |
32 | struct module *owner; | |
1da177e4 | 33 | mode_t mode; |
6992f533 EB |
34 | #ifdef CONFIG_DEBUG_LOCK_ALLOC |
35 | struct lock_class_key *key; | |
36 | struct lock_class_key skey; | |
37 | #endif | |
1da177e4 LT |
38 | }; |
39 | ||
35960258 EB |
40 | /** |
41 | * sysfs_attr_init - initialize a dynamically allocated sysfs attribute | |
42 | * @attr: struct attribute to initialize | |
43 | * | |
44 | * Initialize a dynamically allocated struct attribute so we can | |
45 | * make lockdep happy. This is a new requirement for attributes | |
46 | * and initially this is only needed when lockdep is enabled. | |
47 | * Lockdep gives a nice error when your attribute is added to | |
48 | * sysfs if you don't have this. | |
49 | */ | |
6992f533 EB |
50 | #ifdef CONFIG_DEBUG_LOCK_ALLOC |
51 | #define sysfs_attr_init(attr) \ | |
52 | do { \ | |
53 | static struct lock_class_key __key; \ | |
54 | \ | |
55 | (attr)->key = &__key; \ | |
56 | } while(0) | |
57 | #else | |
58 | #define sysfs_attr_init(attr) do {} while(0) | |
59 | #endif | |
60 | ||
1da177e4 | 61 | struct attribute_group { |
59f69015 | 62 | const char *name; |
0f423895 | 63 | mode_t (*is_visible)(struct kobject *, |
d4acd722 | 64 | struct attribute *, int); |
59f69015 | 65 | struct attribute **attrs; |
1da177e4 LT |
66 | }; |
67 | ||
68 | ||
69 | ||
70 | /** | |
71 | * Use these macros to make defining attributes easier. See include/linux/device.h | |
72 | * for examples.. | |
73 | */ | |
74 | ||
75 | #define __ATTR(_name,_mode,_show,_store) { \ | |
7b595756 | 76 | .attr = {.name = __stringify(_name), .mode = _mode }, \ |
1da177e4 LT |
77 | .show = _show, \ |
78 | .store = _store, \ | |
79 | } | |
80 | ||
81 | #define __ATTR_RO(_name) { \ | |
7b595756 TH |
82 | .attr = { .name = __stringify(_name), .mode = 0444 }, \ |
83 | .show = _name##_show, \ | |
1da177e4 LT |
84 | } |
85 | ||
86 | #define __ATTR_NULL { .attr = { .name = NULL } } | |
87 | ||
88 | #define attr_name(_attr) (_attr).attr.name | |
89 | ||
2c3c8bea | 90 | struct file; |
1da177e4 LT |
91 | struct vm_area_struct; |
92 | ||
93 | struct bin_attribute { | |
94 | struct attribute attr; | |
95 | size_t size; | |
96 | void *private; | |
2c3c8bea | 97 | ssize_t (*read)(struct file *, struct kobject *, struct bin_attribute *, |
91a69029 | 98 | char *, loff_t, size_t); |
2c3c8bea | 99 | ssize_t (*write)(struct file *,struct kobject *, struct bin_attribute *, |
91a69029 | 100 | char *, loff_t, size_t); |
2c3c8bea | 101 | int (*mmap)(struct file *, struct kobject *, struct bin_attribute *attr, |
1da177e4 LT |
102 | struct vm_area_struct *vma); |
103 | }; | |
104 | ||
35960258 EB |
105 | /** |
106 | * sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute | |
107 | * @attr: struct bin_attribute to initialize | |
108 | * | |
109 | * Initialize a dynamically allocated struct bin_attribute so we | |
110 | * can make lockdep happy. This is a new requirement for | |
111 | * attributes and initially this is only needed when lockdep is | |
112 | * enabled. Lockdep gives a nice error when your attribute is | |
113 | * added to sysfs if you don't have this. | |
114 | */ | |
62e877b8 | 115 | #define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr) |
6992f533 | 116 | |
1da177e4 LT |
117 | struct sysfs_ops { |
118 | ssize_t (*show)(struct kobject *, struct attribute *,char *); | |
119 | ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t); | |
120 | }; | |
121 | ||
f1282c84 NB |
122 | struct sysfs_dirent; |
123 | ||
1da177e4 LT |
124 | #ifdef CONFIG_SYSFS |
125 | ||
59f69015 TH |
126 | int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *), |
127 | void *data, struct module *owner); | |
1da177e4 | 128 | |
59f69015 TH |
129 | int __must_check sysfs_create_dir(struct kobject *kobj); |
130 | void sysfs_remove_dir(struct kobject *kobj); | |
131 | int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name); | |
132 | int __must_check sysfs_move_dir(struct kobject *kobj, | |
133 | struct kobject *new_parent_kobj); | |
31e5abe9 | 134 | |
59f69015 TH |
135 | int __must_check sysfs_create_file(struct kobject *kobj, |
136 | const struct attribute *attr); | |
1c205ae1 AK |
137 | int __must_check sysfs_create_files(struct kobject *kobj, |
138 | const struct attribute **attr); | |
49c19400 JD |
139 | int __must_check sysfs_chmod_file(struct kobject *kobj, |
140 | const struct attribute *attr, mode_t mode); | |
59f69015 | 141 | void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr); |
1c205ae1 | 142 | void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr); |
1da177e4 | 143 | |
4a7fb636 | 144 | int __must_check sysfs_create_bin_file(struct kobject *kobj, |
66ecb92b PC |
145 | const struct bin_attribute *attr); |
146 | void sysfs_remove_bin_file(struct kobject *kobj, | |
147 | const struct bin_attribute *attr); | |
1da177e4 | 148 | |
59f69015 TH |
149 | int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target, |
150 | const char *name); | |
36ce6dad CH |
151 | int __must_check sysfs_create_link_nowarn(struct kobject *kobj, |
152 | struct kobject *target, | |
153 | const char *name); | |
59f69015 TH |
154 | void sysfs_remove_link(struct kobject *kobj, const char *name); |
155 | ||
7cb32942 EB |
156 | int sysfs_rename_link(struct kobject *kobj, struct kobject *target, |
157 | const char *old_name, const char *new_name); | |
158 | ||
746edb7a EB |
159 | void sysfs_delete_link(struct kobject *dir, struct kobject *targ, |
160 | const char *name); | |
161 | ||
59f69015 TH |
162 | int __must_check sysfs_create_group(struct kobject *kobj, |
163 | const struct attribute_group *grp); | |
0f423895 JB |
164 | int sysfs_update_group(struct kobject *kobj, |
165 | const struct attribute_group *grp); | |
59f69015 TH |
166 | void sysfs_remove_group(struct kobject *kobj, |
167 | const struct attribute_group *grp); | |
dfa87c82 | 168 | int sysfs_add_file_to_group(struct kobject *kobj, |
59f69015 | 169 | const struct attribute *attr, const char *group); |
dfa87c82 | 170 | void sysfs_remove_file_from_group(struct kobject *kobj, |
59f69015 | 171 | const struct attribute *attr, const char *group); |
dfa87c82 | 172 | |
8c0e3998 | 173 | void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr); |
f1282c84 NB |
174 | void sysfs_notify_dirent(struct sysfs_dirent *sd); |
175 | struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd, | |
3ff195b0 | 176 | const void *ns, |
f1282c84 NB |
177 | const unsigned char *name); |
178 | struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd); | |
179 | void sysfs_put(struct sysfs_dirent *sd); | |
ae87221d | 180 | void sysfs_printk_last_file(void); |
3ff195b0 | 181 | |
be867b19 | 182 | /* Called to clear a ns tag when it is no longer valid */ |
3ff195b0 EB |
183 | void sysfs_exit_ns(enum kobj_ns_type type, const void *tag); |
184 | ||
f1282c84 | 185 | int __must_check sysfs_init(void); |
f20a9ead | 186 | |
1da177e4 LT |
187 | #else /* CONFIG_SYSFS */ |
188 | ||
d9a9cdfb | 189 | static inline int sysfs_schedule_callback(struct kobject *kobj, |
523ded71 | 190 | void (*func)(void *), void *data, struct module *owner) |
d9a9cdfb AS |
191 | { |
192 | return -ENOSYS; | |
193 | } | |
194 | ||
59f69015 | 195 | static inline int sysfs_create_dir(struct kobject *kobj) |
1da177e4 LT |
196 | { |
197 | return 0; | |
198 | } | |
199 | ||
59f69015 | 200 | static inline void sysfs_remove_dir(struct kobject *kobj) |
1da177e4 | 201 | { |
1da177e4 LT |
202 | } |
203 | ||
59f69015 | 204 | static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name) |
1da177e4 | 205 | { |
0b4a4fea | 206 | return 0; |
1da177e4 LT |
207 | } |
208 | ||
59f69015 TH |
209 | static inline int sysfs_move_dir(struct kobject *kobj, |
210 | struct kobject *new_parent_kobj) | |
8a82472f CH |
211 | { |
212 | return 0; | |
213 | } | |
214 | ||
59f69015 TH |
215 | static inline int sysfs_create_file(struct kobject *kobj, |
216 | const struct attribute *attr) | |
1da177e4 LT |
217 | { |
218 | return 0; | |
219 | } | |
220 | ||
1c205ae1 AK |
221 | static inline int sysfs_create_files(struct kobject *kobj, |
222 | const struct attribute **attr) | |
223 | { | |
224 | return 0; | |
225 | } | |
226 | ||
59f69015 | 227 | static inline int sysfs_chmod_file(struct kobject *kobj, |
49c19400 | 228 | const struct attribute *attr, mode_t mode) |
31e5abe9 KS |
229 | { |
230 | return 0; | |
231 | } | |
1da177e4 | 232 | |
59f69015 TH |
233 | static inline void sysfs_remove_file(struct kobject *kobj, |
234 | const struct attribute *attr) | |
1da177e4 | 235 | { |
1da177e4 LT |
236 | } |
237 | ||
1c205ae1 AK |
238 | static inline void sysfs_remove_files(struct kobject *kobj, |
239 | const struct attribute **attr) | |
240 | { | |
241 | } | |
242 | ||
59f69015 | 243 | static inline int sysfs_create_bin_file(struct kobject *kobj, |
66ecb92b | 244 | const struct bin_attribute *attr) |
1da177e4 LT |
245 | { |
246 | return 0; | |
247 | } | |
248 | ||
3612e06b | 249 | static inline void sysfs_remove_bin_file(struct kobject *kobj, |
66ecb92b | 250 | const struct bin_attribute *attr) |
1da177e4 | 251 | { |
1da177e4 LT |
252 | } |
253 | ||
59f69015 TH |
254 | static inline int sysfs_create_link(struct kobject *kobj, |
255 | struct kobject *target, const char *name) | |
1da177e4 LT |
256 | { |
257 | return 0; | |
258 | } | |
259 | ||
36ce6dad CH |
260 | static inline int sysfs_create_link_nowarn(struct kobject *kobj, |
261 | struct kobject *target, | |
262 | const char *name) | |
263 | { | |
264 | return 0; | |
265 | } | |
266 | ||
59f69015 | 267 | static inline void sysfs_remove_link(struct kobject *kobj, const char *name) |
1da177e4 | 268 | { |
1da177e4 LT |
269 | } |
270 | ||
7cb32942 EB |
271 | static inline int sysfs_rename_link(struct kobject *k, struct kobject *t, |
272 | const char *old_name, const char *new_name) | |
273 | { | |
274 | return 0; | |
275 | } | |
276 | ||
746edb7a EB |
277 | static inline void sysfs_delete_link(struct kobject *k, struct kobject *t, |
278 | const char *name) | |
279 | { | |
280 | } | |
281 | ||
59f69015 TH |
282 | static inline int sysfs_create_group(struct kobject *kobj, |
283 | const struct attribute_group *grp) | |
1da177e4 LT |
284 | { |
285 | return 0; | |
286 | } | |
287 | ||
1cbfb7a5 RD |
288 | static inline int sysfs_update_group(struct kobject *kobj, |
289 | const struct attribute_group *grp) | |
290 | { | |
291 | return 0; | |
292 | } | |
293 | ||
59f69015 TH |
294 | static inline void sysfs_remove_group(struct kobject *kobj, |
295 | const struct attribute_group *grp) | |
1da177e4 | 296 | { |
1da177e4 LT |
297 | } |
298 | ||
dfa87c82 AS |
299 | static inline int sysfs_add_file_to_group(struct kobject *kobj, |
300 | const struct attribute *attr, const char *group) | |
301 | { | |
302 | return 0; | |
303 | } | |
304 | ||
305 | static inline void sysfs_remove_file_from_group(struct kobject *kobj, | |
d701d8a3 | 306 | const struct attribute *attr, const char *group) |
dfa87c82 | 307 | { |
dfa87c82 AS |
308 | } |
309 | ||
8c0e3998 TP |
310 | static inline void sysfs_notify(struct kobject *kobj, const char *dir, |
311 | const char *attr) | |
4508a7a7 N |
312 | { |
313 | } | |
f1282c84 NB |
314 | static inline void sysfs_notify_dirent(struct sysfs_dirent *sd) |
315 | { | |
316 | } | |
317 | static inline | |
318 | struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd, | |
3ff195b0 | 319 | const void *ns, |
f1282c84 NB |
320 | const unsigned char *name) |
321 | { | |
322 | return NULL; | |
323 | } | |
324 | static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd) | |
325 | { | |
326 | return NULL; | |
327 | } | |
328 | static inline void sysfs_put(struct sysfs_dirent *sd) | |
329 | { | |
330 | } | |
4508a7a7 | 331 | |
27eabc7c | 332 | static inline void sysfs_exit_ns(int type, const void *tag) |
3ff195b0 EB |
333 | { |
334 | } | |
335 | ||
f20a9ead AM |
336 | static inline int __must_check sysfs_init(void) |
337 | { | |
338 | return 0; | |
339 | } | |
340 | ||
ae87221d AM |
341 | static inline void sysfs_printk_last_file(void) |
342 | { | |
343 | } | |
344 | ||
1da177e4 LT |
345 | #endif /* CONFIG_SYSFS */ |
346 | ||
347 | #endif /* _SYSFS_H_ */ |