2 * sysfs.h - definitions for the device driver filesystem
4 * Copyright (c) 2001,2002 Patrick Mochel
5 * Copyright (c) 2004 Silicon Graphics, Inc.
6 * Copyright (c) 2007 SUSE Linux Products GmbH
7 * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
9 * Please see Documentation/filesystems/sysfs.txt for more information.
15 #include <linux/compiler.h>
16 #include <linux/errno.h>
17 #include <linux/list.h>
18 #include <linux/lockdep.h>
19 #include <linux/kobject_ns.h>
20 #include <linux/stat.h>
21 #include <linux/atomic.h>
30 #ifdef CONFIG_DEBUG_LOCK_ALLOC
31 bool ignore_lockdep:1;
32 struct lock_class_key *key;
33 struct lock_class_key skey;
38 * sysfs_attr_init - initialize a dynamically allocated sysfs attribute
39 * @attr: struct attribute to initialize
41 * Initialize a dynamically allocated struct attribute so we can
42 * make lockdep happy. This is a new requirement for attributes
43 * and initially this is only needed when lockdep is enabled.
44 * Lockdep gives a nice error when your attribute is added to
45 * sysfs if you don't have this.
47 #ifdef CONFIG_DEBUG_LOCK_ALLOC
48 #define sysfs_attr_init(attr) \
50 static struct lock_class_key __key; \
52 (attr)->key = &__key; \
55 #define sysfs_attr_init(attr) do {} while(0)
58 struct attribute_group {
60 umode_t (*is_visible)(struct kobject *,
61 struct attribute *, int);
62 struct attribute **attrs;
68 * Use these macros to make defining attributes easier. See include/linux/device.h
72 #define __ATTR(_name,_mode,_show,_store) { \
73 .attr = {.name = __stringify(_name), .mode = _mode }, \
78 #define __ATTR_RO(_name) { \
79 .attr = { .name = __stringify(_name), .mode = S_IRUGO }, \
80 .show = _name##_show, \
83 #define __ATTR_WO(_name) { \
84 .attr = { .name = __stringify(_name), .mode = S_IWUSR }, \
85 .store = _name##_store, \
88 #define __ATTR_RW(_name) __ATTR(_name, (S_IWUSR | S_IRUGO), \
89 _name##_show, _name##_store)
91 #define __ATTR_NULL { .attr = { .name = NULL } }
93 #ifdef CONFIG_DEBUG_LOCK_ALLOC
94 #define __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) { \
95 .attr = {.name = __stringify(_name), .mode = _mode, \
96 .ignore_lockdep = true }, \
101 #define __ATTR_IGNORE_LOCKDEP __ATTR
104 #define __ATTRIBUTE_GROUPS(_name) \
105 static const struct attribute_group *_name##_groups[] = { \
110 #define ATTRIBUTE_GROUPS(_name) \
111 static const struct attribute_group _name##_group = { \
112 .attrs = _name##_attrs, \
114 __ATTRIBUTE_GROUPS(_name)
116 #define attr_name(_attr) (_attr).attr.name
119 struct vm_area_struct;
121 struct bin_attribute {
122 struct attribute attr;
125 ssize_t (*read)(struct file *, struct kobject *, struct bin_attribute *,
126 char *, loff_t, size_t);
127 ssize_t (*write)(struct file *,struct kobject *, struct bin_attribute *,
128 char *, loff_t, size_t);
129 int (*mmap)(struct file *, struct kobject *, struct bin_attribute *attr,
130 struct vm_area_struct *vma);
134 * sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
135 * @attr: struct bin_attribute to initialize
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.
143 #define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr)
145 /* macros to create static binary attributes easier */
146 #define __BIN_ATTR(_name, _mode, _read, _write, _size) { \
147 .attr = { .name = __stringify(_name), .mode = _mode }, \
153 #define __BIN_ATTR_RO(_name, _size) { \
154 .attr = { .name = __stringify(_name), .mode = S_IRUGO }, \
155 .read = _name##_read, \
159 #define __BIN_ATTR_RW(_name, _size) __BIN_ATTR(_name, \
160 (S_IWUSR | S_IRUGO), _name##_read, \
163 #define __BIN_ATTR_NULL __ATTR_NULL
165 #define BIN_ATTR(_name, _mode, _read, _write, _size) \
166 struct bin_attribute bin_attr_##_name = __BIN_ATTR(_name, _mode, _read, \
169 #define BIN_ATTR_RO(_name, _size) \
170 struct bin_attribute bin_attr_##_name = __BIN_ATTR_RO(_name, _size)
172 #define BIN_ATTR_RW(_name, _size) \
173 struct bin_attribute bin_attr_##_name = __BIN_ATTR_RW(_name, _size)
176 ssize_t (*show)(struct kobject *, struct attribute *,char *);
177 ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t);
178 const void *(*namespace)(struct kobject *, const struct attribute *);
185 int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
186 void *data, struct module *owner);
188 int __must_check sysfs_create_dir(struct kobject *kobj);
189 void sysfs_remove_dir(struct kobject *kobj);
190 int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name);
191 int __must_check sysfs_move_dir(struct kobject *kobj,
192 struct kobject *new_parent_kobj);
194 int __must_check sysfs_create_file(struct kobject *kobj,
195 const struct attribute *attr);
196 int __must_check sysfs_create_files(struct kobject *kobj,
197 const struct attribute **attr);
198 int __must_check sysfs_chmod_file(struct kobject *kobj,
199 const struct attribute *attr, umode_t mode);
200 void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr);
201 void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
203 int __must_check sysfs_create_bin_file(struct kobject *kobj,
204 const struct bin_attribute *attr);
205 void sysfs_remove_bin_file(struct kobject *kobj,
206 const struct bin_attribute *attr);
208 int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
210 int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
211 struct kobject *target,
213 void sysfs_remove_link(struct kobject *kobj, const char *name);
215 int sysfs_rename_link(struct kobject *kobj, struct kobject *target,
216 const char *old_name, const char *new_name);
218 void sysfs_delete_link(struct kobject *dir, struct kobject *targ,
221 int __must_check sysfs_create_group(struct kobject *kobj,
222 const struct attribute_group *grp);
223 int sysfs_update_group(struct kobject *kobj,
224 const struct attribute_group *grp);
225 void sysfs_remove_group(struct kobject *kobj,
226 const struct attribute_group *grp);
227 int sysfs_add_file_to_group(struct kobject *kobj,
228 const struct attribute *attr, const char *group);
229 void sysfs_remove_file_from_group(struct kobject *kobj,
230 const struct attribute *attr, const char *group);
231 int sysfs_merge_group(struct kobject *kobj,
232 const struct attribute_group *grp);
233 void sysfs_unmerge_group(struct kobject *kobj,
234 const struct attribute_group *grp);
235 int sysfs_add_link_to_group(struct kobject *kobj, const char *group_name,
236 struct kobject *target, const char *link_name);
237 void sysfs_remove_link_from_group(struct kobject *kobj, const char *group_name,
238 const char *link_name);
240 void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
241 void sysfs_notify_dirent(struct sysfs_dirent *sd);
242 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
244 const unsigned char *name);
245 struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd);
246 void sysfs_put(struct sysfs_dirent *sd);
248 int __must_check sysfs_init(void);
250 #else /* CONFIG_SYSFS */
252 static inline int sysfs_schedule_callback(struct kobject *kobj,
253 void (*func)(void *), void *data, struct module *owner)
258 static inline int sysfs_create_dir(struct kobject *kobj)
263 static inline void sysfs_remove_dir(struct kobject *kobj)
267 static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
272 static inline int sysfs_move_dir(struct kobject *kobj,
273 struct kobject *new_parent_kobj)
278 static inline int sysfs_create_file(struct kobject *kobj,
279 const struct attribute *attr)
284 static inline int sysfs_create_files(struct kobject *kobj,
285 const struct attribute **attr)
290 static inline int sysfs_chmod_file(struct kobject *kobj,
291 const struct attribute *attr, umode_t mode)
296 static inline void sysfs_remove_file(struct kobject *kobj,
297 const struct attribute *attr)
301 static inline void sysfs_remove_files(struct kobject *kobj,
302 const struct attribute **attr)
306 static inline int sysfs_create_bin_file(struct kobject *kobj,
307 const struct bin_attribute *attr)
312 static inline void sysfs_remove_bin_file(struct kobject *kobj,
313 const struct bin_attribute *attr)
317 static inline int sysfs_create_link(struct kobject *kobj,
318 struct kobject *target, const char *name)
323 static inline int sysfs_create_link_nowarn(struct kobject *kobj,
324 struct kobject *target,
330 static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
334 static inline int sysfs_rename_link(struct kobject *k, struct kobject *t,
335 const char *old_name, const char *new_name)
340 static inline void sysfs_delete_link(struct kobject *k, struct kobject *t,
345 static inline int sysfs_create_group(struct kobject *kobj,
346 const struct attribute_group *grp)
351 static inline int sysfs_update_group(struct kobject *kobj,
352 const struct attribute_group *grp)
357 static inline void sysfs_remove_group(struct kobject *kobj,
358 const struct attribute_group *grp)
362 static inline int sysfs_add_file_to_group(struct kobject *kobj,
363 const struct attribute *attr, const char *group)
368 static inline void sysfs_remove_file_from_group(struct kobject *kobj,
369 const struct attribute *attr, const char *group)
373 static inline int sysfs_merge_group(struct kobject *kobj,
374 const struct attribute_group *grp)
379 static inline void sysfs_unmerge_group(struct kobject *kobj,
380 const struct attribute_group *grp)
384 static inline int sysfs_add_link_to_group(struct kobject *kobj,
385 const char *group_name, struct kobject *target,
386 const char *link_name)
391 static inline void sysfs_remove_link_from_group(struct kobject *kobj,
392 const char *group_name, const char *link_name)
396 static inline void sysfs_notify(struct kobject *kobj, const char *dir,
400 static inline void sysfs_notify_dirent(struct sysfs_dirent *sd)
404 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
406 const unsigned char *name)
410 static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
414 static inline void sysfs_put(struct sysfs_dirent *sd)
418 static inline int __must_check sysfs_init(void)
423 #endif /* CONFIG_SYSFS */
425 #endif /* _SYSFS_H_ */