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. | |
6 | * | |
7 | * Please see Documentation/filesystems/sysfs.txt for more information. | |
8 | */ | |
9 | ||
10 | #ifndef _SYSFS_H_ | |
11 | #define _SYSFS_H_ | |
12 | ||
4a7fb636 | 13 | #include <linux/compiler.h> |
5851fadc | 14 | #include <linux/errno.h> |
bf0acc33 | 15 | #include <linux/list.h> |
1da177e4 LT |
16 | #include <asm/atomic.h> |
17 | ||
18 | struct kobject; | |
19 | struct module; | |
b592fcfe | 20 | struct nameidata; |
d56c3eae | 21 | struct dentry; |
608e266a | 22 | struct sysfs_dirent; |
1da177e4 | 23 | |
7b595756 TH |
24 | /* FIXME |
25 | * The *owner field is no longer used, but leave around | |
26 | * until the tree gets cleaned up fully. | |
27 | */ | |
1da177e4 | 28 | struct attribute { |
d48593bf | 29 | const char * name; |
7b595756 | 30 | struct module * owner; |
1da177e4 LT |
31 | mode_t mode; |
32 | }; | |
33 | ||
34 | struct attribute_group { | |
d48593bf | 35 | const char * name; |
1da177e4 LT |
36 | struct attribute ** attrs; |
37 | }; | |
38 | ||
39 | ||
40 | ||
41 | /** | |
42 | * Use these macros to make defining attributes easier. See include/linux/device.h | |
43 | * for examples.. | |
44 | */ | |
45 | ||
46 | #define __ATTR(_name,_mode,_show,_store) { \ | |
7b595756 | 47 | .attr = {.name = __stringify(_name), .mode = _mode }, \ |
1da177e4 LT |
48 | .show = _show, \ |
49 | .store = _store, \ | |
50 | } | |
51 | ||
52 | #define __ATTR_RO(_name) { \ | |
7b595756 TH |
53 | .attr = { .name = __stringify(_name), .mode = 0444 }, \ |
54 | .show = _name##_show, \ | |
1da177e4 LT |
55 | } |
56 | ||
57 | #define __ATTR_NULL { .attr = { .name = NULL } } | |
58 | ||
59 | #define attr_name(_attr) (_attr).attr.name | |
60 | ||
61 | struct vm_area_struct; | |
62 | ||
63 | struct bin_attribute { | |
64 | struct attribute attr; | |
65 | size_t size; | |
66 | void *private; | |
91a69029 ZR |
67 | ssize_t (*read)(struct kobject *, struct bin_attribute *, |
68 | char *, loff_t, size_t); | |
69 | ssize_t (*write)(struct kobject *, struct bin_attribute *, | |
70 | char *, loff_t, size_t); | |
1da177e4 LT |
71 | int (*mmap)(struct kobject *, struct bin_attribute *attr, |
72 | struct vm_area_struct *vma); | |
73 | }; | |
74 | ||
75 | struct sysfs_ops { | |
76 | ssize_t (*show)(struct kobject *, struct attribute *,char *); | |
77 | ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t); | |
78 | }; | |
79 | ||
b402d72c | 80 | #define SYSFS_TYPE_MASK 0x00ff |
1da177e4 LT |
81 | #define SYSFS_ROOT 0x0001 |
82 | #define SYSFS_DIR 0x0002 | |
83 | #define SYSFS_KOBJ_ATTR 0x0004 | |
84 | #define SYSFS_KOBJ_BIN_ATTR 0x0008 | |
85 | #define SYSFS_KOBJ_LINK 0x0020 | |
0c096b50 | 86 | #define SYSFS_COPY_NAME (SYSFS_DIR | SYSFS_KOBJ_LINK) |
1da177e4 | 87 | |
b402d72c | 88 | #define SYSFS_FLAG_MASK ~SYSFS_TYPE_MASK |
380e6fbb | 89 | #define SYSFS_FLAG_REMOVED 0x0100 |
b402d72c | 90 | |
1da177e4 LT |
91 | #ifdef CONFIG_SYSFS |
92 | ||
d9a9cdfb | 93 | extern int sysfs_schedule_callback(struct kobject *kobj, |
523ded71 | 94 | void (*func)(void *), void *data, struct module *owner); |
d9a9cdfb | 95 | |
4a7fb636 | 96 | extern int __must_check |
608e266a | 97 | sysfs_create_dir(struct kobject *kobj, struct sysfs_dirent *shadow_parent_sd); |
1da177e4 LT |
98 | |
99 | extern void | |
100 | sysfs_remove_dir(struct kobject *); | |
101 | ||
4a7fb636 | 102 | extern int __must_check |
608e266a TH |
103 | sysfs_rename_dir(struct kobject *kobj, struct sysfs_dirent *new_parent_sd, |
104 | const char *new_name); | |
1da177e4 | 105 | |
8a82472f CH |
106 | extern int __must_check |
107 | sysfs_move_dir(struct kobject *, struct kobject *); | |
108 | ||
4a7fb636 | 109 | extern int __must_check |
1da177e4 LT |
110 | sysfs_create_file(struct kobject *, const struct attribute *); |
111 | ||
4a7fb636 | 112 | extern int __must_check |
1da177e4 LT |
113 | sysfs_update_file(struct kobject *, const struct attribute *); |
114 | ||
4a7fb636 | 115 | extern int __must_check |
31e5abe9 KS |
116 | sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode); |
117 | ||
1da177e4 LT |
118 | extern void |
119 | sysfs_remove_file(struct kobject *, const struct attribute *); | |
120 | ||
4a7fb636 | 121 | extern int __must_check |
e3a15db2 | 122 | sysfs_create_link(struct kobject * kobj, struct kobject * target, const char * name); |
1da177e4 LT |
123 | |
124 | extern void | |
e3a15db2 | 125 | sysfs_remove_link(struct kobject *, const char * name); |
1da177e4 | 126 | |
4a7fb636 AM |
127 | int __must_check sysfs_create_bin_file(struct kobject *kobj, |
128 | struct bin_attribute *attr); | |
995982ca | 129 | void sysfs_remove_bin_file(struct kobject *kobj, struct bin_attribute *attr); |
1da177e4 | 130 | |
4a7fb636 AM |
131 | int __must_check sysfs_create_group(struct kobject *, |
132 | const struct attribute_group *); | |
1da177e4 | 133 | void sysfs_remove_group(struct kobject *, const struct attribute_group *); |
dfa87c82 AS |
134 | int sysfs_add_file_to_group(struct kobject *kobj, |
135 | const struct attribute *attr, const char *group); | |
136 | void sysfs_remove_file_from_group(struct kobject *kobj, | |
137 | const struct attribute *attr, const char *group); | |
138 | ||
4508a7a7 | 139 | void sysfs_notify(struct kobject * k, char *dir, char *attr); |
1da177e4 | 140 | |
b592fcfe EB |
141 | |
142 | extern int sysfs_make_shadowed_dir(struct kobject *kobj, | |
143 | void * (*follow_link)(struct dentry *, struct nameidata *)); | |
608e266a TH |
144 | extern struct sysfs_dirent *sysfs_create_shadow_dir(struct kobject *kobj); |
145 | extern void sysfs_remove_shadow_dir(struct sysfs_dirent *shadow_sd); | |
b592fcfe | 146 | |
f20a9ead AM |
147 | extern int __must_check sysfs_init(void); |
148 | ||
1da177e4 LT |
149 | #else /* CONFIG_SYSFS */ |
150 | ||
d9a9cdfb | 151 | static inline int sysfs_schedule_callback(struct kobject *kobj, |
523ded71 | 152 | void (*func)(void *), void *data, struct module *owner) |
d9a9cdfb AS |
153 | { |
154 | return -ENOSYS; | |
155 | } | |
156 | ||
608e266a TH |
157 | static inline int sysfs_create_dir(struct kobject *kobj, |
158 | struct sysfs_dirent *shadow_parent_sd) | |
1da177e4 LT |
159 | { |
160 | return 0; | |
161 | } | |
162 | ||
163 | static inline void sysfs_remove_dir(struct kobject * k) | |
164 | { | |
165 | ; | |
166 | } | |
167 | ||
608e266a TH |
168 | static inline int sysfs_rename_dir(struct kobject *kobj, |
169 | struct sysfs_dirent *new_parent_sd, | |
170 | const char *new_name) | |
1da177e4 LT |
171 | { |
172 | return 0; | |
173 | } | |
174 | ||
8a82472f CH |
175 | static inline int sysfs_move_dir(struct kobject * k, struct kobject * new_parent) |
176 | { | |
177 | return 0; | |
178 | } | |
179 | ||
1da177e4 LT |
180 | static inline int sysfs_create_file(struct kobject * k, const struct attribute * a) |
181 | { | |
182 | return 0; | |
183 | } | |
184 | ||
185 | static inline int sysfs_update_file(struct kobject * k, const struct attribute * a) | |
186 | { | |
187 | return 0; | |
188 | } | |
31e5abe9 KS |
189 | static inline int sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode) |
190 | { | |
191 | return 0; | |
192 | } | |
1da177e4 LT |
193 | |
194 | static inline void sysfs_remove_file(struct kobject * k, const struct attribute * a) | |
195 | { | |
196 | ; | |
197 | } | |
198 | ||
e3a15db2 | 199 | static inline int sysfs_create_link(struct kobject * k, struct kobject * t, const char * n) |
1da177e4 LT |
200 | { |
201 | return 0; | |
202 | } | |
203 | ||
e3a15db2 | 204 | static inline void sysfs_remove_link(struct kobject * k, const char * name) |
1da177e4 LT |
205 | { |
206 | ; | |
207 | } | |
208 | ||
209 | ||
210 | static inline int sysfs_create_bin_file(struct kobject * k, struct bin_attribute * a) | |
211 | { | |
212 | return 0; | |
213 | } | |
214 | ||
215 | static inline int sysfs_remove_bin_file(struct kobject * k, struct bin_attribute * a) | |
216 | { | |
217 | return 0; | |
218 | } | |
219 | ||
220 | static inline int sysfs_create_group(struct kobject * k, const struct attribute_group *g) | |
221 | { | |
222 | return 0; | |
223 | } | |
224 | ||
225 | static inline void sysfs_remove_group(struct kobject * k, const struct attribute_group * g) | |
226 | { | |
227 | ; | |
228 | } | |
229 | ||
dfa87c82 AS |
230 | static inline int sysfs_add_file_to_group(struct kobject *kobj, |
231 | const struct attribute *attr, const char *group) | |
232 | { | |
233 | return 0; | |
234 | } | |
235 | ||
236 | static inline void sysfs_remove_file_from_group(struct kobject *kobj, | |
d701d8a3 | 237 | const struct attribute *attr, const char *group) |
dfa87c82 | 238 | { |
dfa87c82 AS |
239 | } |
240 | ||
4508a7a7 N |
241 | static inline void sysfs_notify(struct kobject * k, char *dir, char *attr) |
242 | { | |
243 | } | |
244 | ||
b592fcfe EB |
245 | static inline int sysfs_make_shadowed_dir(struct kobject *kobj, |
246 | void * (*follow_link)(struct dentry *, struct nameidata *)) | |
247 | { | |
248 | return 0; | |
249 | } | |
250 | ||
f20a9ead AM |
251 | static inline int __must_check sysfs_init(void) |
252 | { | |
253 | return 0; | |
254 | } | |
255 | ||
1da177e4 LT |
256 | #endif /* CONFIG_SYSFS */ |
257 | ||
258 | #endif /* _SYSFS_H_ */ |