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 <asm/atomic.h>
25 * The *owner field is no longer used.
26 * x86 tree has been cleaned up. The owner
27 * attribute is still left for other arches.
33 #ifdef CONFIG_DEBUG_LOCK_ALLOC
34 struct lock_class_key *key;
35 struct lock_class_key skey;
40 * sysfs_attr_init - initialize a dynamically allocated sysfs attribute
41 * @attr: struct attribute to initialize
43 * Initialize a dynamically allocated struct attribute so we can
44 * make lockdep happy. This is a new requirement for attributes
45 * and initially this is only needed when lockdep is enabled.
46 * Lockdep gives a nice error when your attribute is added to
47 * sysfs if you don't have this.
49 #ifdef CONFIG_DEBUG_LOCK_ALLOC
50 #define sysfs_attr_init(attr) \
52 static struct lock_class_key __key; \
54 (attr)->key = &__key; \
57 #define sysfs_attr_init(attr) do {} while(0)
60 struct attribute_group {
62 mode_t (*is_visible)(struct kobject *,
63 struct attribute *, int);
64 struct attribute **attrs;
70 * Use these macros to make defining attributes easier. See include/linux/device.h
74 #define __ATTR(_name,_mode,_show,_store) { \
75 .attr = {.name = __stringify(_name), .mode = _mode }, \
80 #define __ATTR_RO(_name) { \
81 .attr = { .name = __stringify(_name), .mode = 0444 }, \
82 .show = _name##_show, \
85 #define __ATTR_NULL { .attr = { .name = NULL } }
87 #define attr_name(_attr) (_attr).attr.name
89 struct vm_area_struct;
91 struct bin_attribute {
92 struct attribute attr;
95 ssize_t (*read)(struct kobject *, struct bin_attribute *,
96 char *, loff_t, size_t);
97 ssize_t (*write)(struct kobject *, struct bin_attribute *,
98 char *, loff_t, size_t);
99 int (*mmap)(struct kobject *, struct bin_attribute *attr,
100 struct vm_area_struct *vma);
104 * sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
105 * @attr: struct bin_attribute to initialize
107 * Initialize a dynamically allocated struct bin_attribute so we
108 * can make lockdep happy. This is a new requirement for
109 * attributes and initially this is only needed when lockdep is
110 * enabled. Lockdep gives a nice error when your attribute is
111 * added to sysfs if you don't have this.
113 #define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&bin_attr->attr)
116 ssize_t (*show)(struct kobject *, struct attribute *,char *);
117 ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t);
124 int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
125 void *data, struct module *owner);
127 int __must_check sysfs_create_dir(struct kobject *kobj);
128 void sysfs_remove_dir(struct kobject *kobj);
129 int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name);
130 int __must_check sysfs_move_dir(struct kobject *kobj,
131 struct kobject *new_parent_kobj);
133 int __must_check sysfs_create_file(struct kobject *kobj,
134 const struct attribute *attr);
135 int __must_check sysfs_create_files(struct kobject *kobj,
136 const struct attribute **attr);
137 int __must_check sysfs_chmod_file(struct kobject *kobj, struct attribute *attr,
139 void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr);
140 void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
142 int __must_check sysfs_create_bin_file(struct kobject *kobj,
143 const struct bin_attribute *attr);
144 void sysfs_remove_bin_file(struct kobject *kobj,
145 const struct bin_attribute *attr);
147 int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
149 int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
150 struct kobject *target,
152 void sysfs_remove_link(struct kobject *kobj, const char *name);
154 int __must_check sysfs_create_group(struct kobject *kobj,
155 const struct attribute_group *grp);
156 int sysfs_update_group(struct kobject *kobj,
157 const struct attribute_group *grp);
158 void sysfs_remove_group(struct kobject *kobj,
159 const struct attribute_group *grp);
160 int sysfs_add_file_to_group(struct kobject *kobj,
161 const struct attribute *attr, const char *group);
162 void sysfs_remove_file_from_group(struct kobject *kobj,
163 const struct attribute *attr, const char *group);
165 void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
166 void sysfs_notify_dirent(struct sysfs_dirent *sd);
167 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
168 const unsigned char *name);
169 struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd);
170 void sysfs_put(struct sysfs_dirent *sd);
171 void sysfs_printk_last_file(void);
172 int __must_check sysfs_init(void);
174 #else /* CONFIG_SYSFS */
176 static inline int sysfs_schedule_callback(struct kobject *kobj,
177 void (*func)(void *), void *data, struct module *owner)
182 static inline int sysfs_create_dir(struct kobject *kobj)
187 static inline void sysfs_remove_dir(struct kobject *kobj)
191 static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
196 static inline int sysfs_move_dir(struct kobject *kobj,
197 struct kobject *new_parent_kobj)
202 static inline int sysfs_create_file(struct kobject *kobj,
203 const struct attribute *attr)
208 static inline int sysfs_create_files(struct kobject *kobj,
209 const struct attribute **attr)
214 static inline int sysfs_chmod_file(struct kobject *kobj,
215 struct attribute *attr, mode_t mode)
220 static inline void sysfs_remove_file(struct kobject *kobj,
221 const struct attribute *attr)
225 static inline void sysfs_remove_files(struct kobject *kobj,
226 const struct attribute **attr)
230 static inline int sysfs_create_bin_file(struct kobject *kobj,
231 const struct bin_attribute *attr)
236 static inline void sysfs_remove_bin_file(struct kobject *kobj,
237 const struct bin_attribute *attr)
241 static inline int sysfs_create_link(struct kobject *kobj,
242 struct kobject *target, const char *name)
247 static inline int sysfs_create_link_nowarn(struct kobject *kobj,
248 struct kobject *target,
254 static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
258 static inline int sysfs_create_group(struct kobject *kobj,
259 const struct attribute_group *grp)
264 static inline int sysfs_update_group(struct kobject *kobj,
265 const struct attribute_group *grp)
270 static inline void sysfs_remove_group(struct kobject *kobj,
271 const struct attribute_group *grp)
275 static inline int sysfs_add_file_to_group(struct kobject *kobj,
276 const struct attribute *attr, const char *group)
281 static inline void sysfs_remove_file_from_group(struct kobject *kobj,
282 const struct attribute *attr, const char *group)
286 static inline void sysfs_notify(struct kobject *kobj, const char *dir,
290 static inline void sysfs_notify_dirent(struct sysfs_dirent *sd)
294 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
295 const unsigned char *name)
299 static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
303 static inline void sysfs_put(struct sysfs_dirent *sd)
307 static inline int __must_check sysfs_init(void)
312 static inline void sysfs_printk_last_file(void)
316 #endif /* CONFIG_SYSFS */
318 #endif /* _SYSFS_H_ */