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 | 23 | /* FIXME |
01e8ef11 PW |
24 | * The *owner field is no longer used. |
25 | * x86 tree has been cleaned up. The owner | |
26 | * attribute is still left for other arches. | |
7b595756 | 27 | */ |
1da177e4 | 28 | struct attribute { |
59f69015 TH |
29 | const char *name; |
30 | struct module *owner; | |
1da177e4 LT |
31 | mode_t mode; |
32 | }; | |
33 | ||
34 | struct attribute_group { | |
59f69015 | 35 | const char *name; |
0f423895 | 36 | mode_t (*is_visible)(struct kobject *, |
d4acd722 | 37 | struct attribute *, int); |
59f69015 | 38 | struct attribute **attrs; |
1da177e4 LT |
39 | }; |
40 | ||
41 | ||
42 | ||
43 | /** | |
44 | * Use these macros to make defining attributes easier. See include/linux/device.h | |
45 | * for examples.. | |
46 | */ | |
47 | ||
48 | #define __ATTR(_name,_mode,_show,_store) { \ | |
7b595756 | 49 | .attr = {.name = __stringify(_name), .mode = _mode }, \ |
1da177e4 LT |
50 | .show = _show, \ |
51 | .store = _store, \ | |
52 | } | |
53 | ||
54 | #define __ATTR_RO(_name) { \ | |
7b595756 TH |
55 | .attr = { .name = __stringify(_name), .mode = 0444 }, \ |
56 | .show = _name##_show, \ | |
1da177e4 LT |
57 | } |
58 | ||
59 | #define __ATTR_NULL { .attr = { .name = NULL } } | |
60 | ||
61 | #define attr_name(_attr) (_attr).attr.name | |
62 | ||
63 | struct vm_area_struct; | |
64 | ||
65 | struct bin_attribute { | |
66 | struct attribute attr; | |
67 | size_t size; | |
68 | void *private; | |
91a69029 ZR |
69 | ssize_t (*read)(struct kobject *, struct bin_attribute *, |
70 | char *, loff_t, size_t); | |
71 | ssize_t (*write)(struct kobject *, struct bin_attribute *, | |
72 | char *, loff_t, size_t); | |
1da177e4 LT |
73 | int (*mmap)(struct kobject *, struct bin_attribute *attr, |
74 | struct vm_area_struct *vma); | |
75 | }; | |
76 | ||
77 | struct sysfs_ops { | |
78 | ssize_t (*show)(struct kobject *, struct attribute *,char *); | |
79 | ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t); | |
80 | }; | |
81 | ||
f1282c84 NB |
82 | struct sysfs_dirent; |
83 | ||
1da177e4 LT |
84 | #ifdef CONFIG_SYSFS |
85 | ||
59f69015 TH |
86 | int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *), |
87 | void *data, struct module *owner); | |
1da177e4 | 88 | |
59f69015 TH |
89 | int __must_check sysfs_create_dir(struct kobject *kobj); |
90 | void sysfs_remove_dir(struct kobject *kobj); | |
91 | int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name); | |
92 | int __must_check sysfs_move_dir(struct kobject *kobj, | |
93 | struct kobject *new_parent_kobj); | |
31e5abe9 | 94 | |
59f69015 TH |
95 | int __must_check sysfs_create_file(struct kobject *kobj, |
96 | const struct attribute *attr); | |
59f69015 TH |
97 | int __must_check sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, |
98 | mode_t mode); | |
99 | void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr); | |
1da177e4 | 100 | |
4a7fb636 | 101 | int __must_check sysfs_create_bin_file(struct kobject *kobj, |
66ecb92b PC |
102 | const struct bin_attribute *attr); |
103 | void sysfs_remove_bin_file(struct kobject *kobj, | |
104 | const struct bin_attribute *attr); | |
1da177e4 | 105 | |
59f69015 TH |
106 | int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target, |
107 | const char *name); | |
36ce6dad CH |
108 | int __must_check sysfs_create_link_nowarn(struct kobject *kobj, |
109 | struct kobject *target, | |
110 | const char *name); | |
59f69015 TH |
111 | void sysfs_remove_link(struct kobject *kobj, const char *name); |
112 | ||
113 | int __must_check sysfs_create_group(struct kobject *kobj, | |
114 | const struct attribute_group *grp); | |
0f423895 JB |
115 | int sysfs_update_group(struct kobject *kobj, |
116 | const struct attribute_group *grp); | |
59f69015 TH |
117 | void sysfs_remove_group(struct kobject *kobj, |
118 | const struct attribute_group *grp); | |
dfa87c82 | 119 | int sysfs_add_file_to_group(struct kobject *kobj, |
59f69015 | 120 | const struct attribute *attr, const char *group); |
dfa87c82 | 121 | void sysfs_remove_file_from_group(struct kobject *kobj, |
59f69015 | 122 | const struct attribute *attr, const char *group); |
dfa87c82 | 123 | |
8c0e3998 | 124 | void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr); |
f1282c84 NB |
125 | void sysfs_notify_dirent(struct sysfs_dirent *sd); |
126 | struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd, | |
127 | const unsigned char *name); | |
128 | struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd); | |
129 | void sysfs_put(struct sysfs_dirent *sd); | |
ae87221d | 130 | void sysfs_printk_last_file(void); |
f1282c84 | 131 | int __must_check sysfs_init(void); |
f20a9ead | 132 | |
1da177e4 LT |
133 | #else /* CONFIG_SYSFS */ |
134 | ||
d9a9cdfb | 135 | static inline int sysfs_schedule_callback(struct kobject *kobj, |
523ded71 | 136 | void (*func)(void *), void *data, struct module *owner) |
d9a9cdfb AS |
137 | { |
138 | return -ENOSYS; | |
139 | } | |
140 | ||
59f69015 | 141 | static inline int sysfs_create_dir(struct kobject *kobj) |
1da177e4 LT |
142 | { |
143 | return 0; | |
144 | } | |
145 | ||
59f69015 | 146 | static inline void sysfs_remove_dir(struct kobject *kobj) |
1da177e4 | 147 | { |
1da177e4 LT |
148 | } |
149 | ||
59f69015 | 150 | static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name) |
1da177e4 | 151 | { |
0b4a4fea | 152 | return 0; |
1da177e4 LT |
153 | } |
154 | ||
59f69015 TH |
155 | static inline int sysfs_move_dir(struct kobject *kobj, |
156 | struct kobject *new_parent_kobj) | |
8a82472f CH |
157 | { |
158 | return 0; | |
159 | } | |
160 | ||
59f69015 TH |
161 | static inline int sysfs_create_file(struct kobject *kobj, |
162 | const struct attribute *attr) | |
1da177e4 LT |
163 | { |
164 | return 0; | |
165 | } | |
166 | ||
59f69015 TH |
167 | static inline int sysfs_chmod_file(struct kobject *kobj, |
168 | struct attribute *attr, mode_t mode) | |
31e5abe9 KS |
169 | { |
170 | return 0; | |
171 | } | |
1da177e4 | 172 | |
59f69015 TH |
173 | static inline void sysfs_remove_file(struct kobject *kobj, |
174 | const struct attribute *attr) | |
1da177e4 | 175 | { |
1da177e4 LT |
176 | } |
177 | ||
59f69015 | 178 | static inline int sysfs_create_bin_file(struct kobject *kobj, |
66ecb92b | 179 | const struct bin_attribute *attr) |
1da177e4 LT |
180 | { |
181 | return 0; | |
182 | } | |
183 | ||
3612e06b | 184 | static inline void sysfs_remove_bin_file(struct kobject *kobj, |
66ecb92b | 185 | const struct bin_attribute *attr) |
1da177e4 | 186 | { |
1da177e4 LT |
187 | } |
188 | ||
59f69015 TH |
189 | static inline int sysfs_create_link(struct kobject *kobj, |
190 | struct kobject *target, const char *name) | |
1da177e4 LT |
191 | { |
192 | return 0; | |
193 | } | |
194 | ||
36ce6dad CH |
195 | static inline int sysfs_create_link_nowarn(struct kobject *kobj, |
196 | struct kobject *target, | |
197 | const char *name) | |
198 | { | |
199 | return 0; | |
200 | } | |
201 | ||
59f69015 | 202 | static inline void sysfs_remove_link(struct kobject *kobj, const char *name) |
1da177e4 | 203 | { |
1da177e4 LT |
204 | } |
205 | ||
59f69015 TH |
206 | static inline int sysfs_create_group(struct kobject *kobj, |
207 | const struct attribute_group *grp) | |
1da177e4 LT |
208 | { |
209 | return 0; | |
210 | } | |
211 | ||
1cbfb7a5 RD |
212 | static inline int sysfs_update_group(struct kobject *kobj, |
213 | const struct attribute_group *grp) | |
214 | { | |
215 | return 0; | |
216 | } | |
217 | ||
59f69015 TH |
218 | static inline void sysfs_remove_group(struct kobject *kobj, |
219 | const struct attribute_group *grp) | |
1da177e4 | 220 | { |
1da177e4 LT |
221 | } |
222 | ||
dfa87c82 AS |
223 | static inline int sysfs_add_file_to_group(struct kobject *kobj, |
224 | const struct attribute *attr, const char *group) | |
225 | { | |
226 | return 0; | |
227 | } | |
228 | ||
229 | static inline void sysfs_remove_file_from_group(struct kobject *kobj, | |
d701d8a3 | 230 | const struct attribute *attr, const char *group) |
dfa87c82 | 231 | { |
dfa87c82 AS |
232 | } |
233 | ||
8c0e3998 TP |
234 | static inline void sysfs_notify(struct kobject *kobj, const char *dir, |
235 | const char *attr) | |
4508a7a7 N |
236 | { |
237 | } | |
f1282c84 NB |
238 | static inline void sysfs_notify_dirent(struct sysfs_dirent *sd) |
239 | { | |
240 | } | |
241 | static inline | |
242 | struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd, | |
243 | const unsigned char *name) | |
244 | { | |
245 | return NULL; | |
246 | } | |
247 | static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd) | |
248 | { | |
249 | return NULL; | |
250 | } | |
251 | static inline void sysfs_put(struct sysfs_dirent *sd) | |
252 | { | |
253 | } | |
4508a7a7 | 254 | |
f20a9ead AM |
255 | static inline int __must_check sysfs_init(void) |
256 | { | |
257 | return 0; | |
258 | } | |
259 | ||
ae87221d AM |
260 | static inline void sysfs_printk_last_file(void) |
261 | { | |
262 | } | |
263 | ||
1da177e4 LT |
264 | #endif /* CONFIG_SYSFS */ |
265 | ||
266 | #endif /* _SYSFS_H_ */ |