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>
31 #ifdef CONFIG_DEBUG_LOCK_ALLOC
32 bool ignore_lockdep
:1;
33 struct lock_class_key
*key
;
34 struct lock_class_key skey
;
39 * sysfs_attr_init - initialize a dynamically allocated sysfs attribute
40 * @attr: struct attribute to initialize
42 * Initialize a dynamically allocated struct attribute so we can
43 * make lockdep happy. This is a new requirement for attributes
44 * and initially this is only needed when lockdep is enabled.
45 * Lockdep gives a nice error when your attribute is added to
46 * sysfs if you don't have this.
48 #ifdef CONFIG_DEBUG_LOCK_ALLOC
49 #define sysfs_attr_init(attr) \
51 static struct lock_class_key __key; \
53 (attr)->key = &__key; \
56 #define sysfs_attr_init(attr) do {} while (0)
59 struct attribute_group
{
61 umode_t (*is_visible
)(struct kobject
*,
62 struct attribute
*, int);
63 struct attribute
**attrs
;
64 struct bin_attribute
**bin_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)
117 struct vm_area_struct
;
119 struct bin_attribute
{
120 struct attribute attr
;
123 ssize_t (*read
)(struct file
*, struct kobject
*, struct bin_attribute
*,
124 char *, loff_t
, size_t);
125 ssize_t (*write
)(struct file
*, struct kobject
*, struct bin_attribute
*,
126 char *, loff_t
, size_t);
127 int (*mmap
)(struct file
*, struct kobject
*, struct bin_attribute
*attr
,
128 struct vm_area_struct
*vma
);
132 * sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
133 * @attr: struct bin_attribute to initialize
135 * Initialize a dynamically allocated struct bin_attribute so we
136 * can make lockdep happy. This is a new requirement for
137 * attributes and initially this is only needed when lockdep is
138 * enabled. Lockdep gives a nice error when your attribute is
139 * added to sysfs if you don't have this.
141 #define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr)
143 /* macros to create static binary attributes easier */
144 #define __BIN_ATTR(_name, _mode, _read, _write, _size) { \
145 .attr = { .name = __stringify(_name), .mode = _mode }, \
151 #define __BIN_ATTR_RO(_name, _size) { \
152 .attr = { .name = __stringify(_name), .mode = S_IRUGO }, \
153 .read = _name##_read, \
157 #define __BIN_ATTR_RW(_name, _size) __BIN_ATTR(_name, \
158 (S_IWUSR | S_IRUGO), _name##_read, \
159 _name##_write, _size)
161 #define __BIN_ATTR_NULL __ATTR_NULL
163 #define BIN_ATTR(_name, _mode, _read, _write, _size) \
164 struct bin_attribute bin_attr_##_name = __BIN_ATTR(_name, _mode, _read, \
167 #define BIN_ATTR_RO(_name, _size) \
168 struct bin_attribute bin_attr_##_name = __BIN_ATTR_RO(_name, _size)
170 #define BIN_ATTR_RW(_name, _size) \
171 struct bin_attribute bin_attr_##_name = __BIN_ATTR_RW(_name, _size)
174 ssize_t (*show
)(struct kobject
*, struct attribute
*, char *);
175 ssize_t (*store
)(struct kobject
*, struct attribute
*, const char *, size_t);
176 const void *(*namespace)(struct kobject
*, const struct attribute
*);
183 int sysfs_schedule_callback(struct kobject
*kobj
, void (*func
)(void *),
184 void *data
, struct module
*owner
);
186 int __must_check
sysfs_create_dir(struct kobject
*kobj
);
187 void sysfs_remove_dir(struct kobject
*kobj
);
188 int __must_check
sysfs_rename_dir(struct kobject
*kobj
, const char *new_name
);
189 int __must_check
sysfs_move_dir(struct kobject
*kobj
,
190 struct kobject
*new_parent_kobj
);
192 int __must_check
sysfs_create_file(struct kobject
*kobj
,
193 const struct attribute
*attr
);
194 int __must_check
sysfs_create_files(struct kobject
*kobj
,
195 const struct attribute
**attr
);
196 int __must_check
sysfs_chmod_file(struct kobject
*kobj
,
197 const struct attribute
*attr
, umode_t mode
);
198 void sysfs_remove_file(struct kobject
*kobj
, const struct attribute
*attr
);
199 void sysfs_remove_files(struct kobject
*kobj
, const struct attribute
**attr
);
201 int __must_check
sysfs_create_bin_file(struct kobject
*kobj
,
202 const struct bin_attribute
*attr
);
203 void sysfs_remove_bin_file(struct kobject
*kobj
,
204 const struct bin_attribute
*attr
);
206 int __must_check
sysfs_create_link(struct kobject
*kobj
, struct kobject
*target
,
208 int __must_check
sysfs_create_link_nowarn(struct kobject
*kobj
,
209 struct kobject
*target
,
211 void sysfs_remove_link(struct kobject
*kobj
, const char *name
);
213 int sysfs_rename_link(struct kobject
*kobj
, struct kobject
*target
,
214 const char *old_name
, const char *new_name
);
216 void sysfs_delete_link(struct kobject
*dir
, struct kobject
*targ
,
219 int __must_check
sysfs_create_group(struct kobject
*kobj
,
220 const struct attribute_group
*grp
);
221 int __must_check
sysfs_create_groups(struct kobject
*kobj
,
222 const struct attribute_group
**groups
);
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 void sysfs_remove_groups(struct kobject
*kobj
,
228 const struct attribute_group
**groups
);
229 int sysfs_add_file_to_group(struct kobject
*kobj
,
230 const struct attribute
*attr
, const char *group
);
231 void sysfs_remove_file_from_group(struct kobject
*kobj
,
232 const struct attribute
*attr
, const char *group
);
233 int sysfs_merge_group(struct kobject
*kobj
,
234 const struct attribute_group
*grp
);
235 void sysfs_unmerge_group(struct kobject
*kobj
,
236 const struct attribute_group
*grp
);
237 int sysfs_add_link_to_group(struct kobject
*kobj
, const char *group_name
,
238 struct kobject
*target
, const char *link_name
);
239 void sysfs_remove_link_from_group(struct kobject
*kobj
, const char *group_name
,
240 const char *link_name
);
242 void sysfs_notify(struct kobject
*kobj
, const char *dir
, const char *attr
);
243 void sysfs_notify_dirent(struct sysfs_dirent
*sd
);
244 struct sysfs_dirent
*sysfs_get_dirent(struct sysfs_dirent
*parent_sd
,
246 const unsigned char *name
);
247 struct sysfs_dirent
*sysfs_get(struct sysfs_dirent
*sd
);
248 void sysfs_put(struct sysfs_dirent
*sd
);
250 int __must_check
sysfs_init(void);
252 #else /* CONFIG_SYSFS */
254 static inline int sysfs_schedule_callback(struct kobject
*kobj
,
255 void (*func
)(void *), void *data
, struct module
*owner
)
260 static inline int sysfs_create_dir(struct kobject
*kobj
)
265 static inline void sysfs_remove_dir(struct kobject
*kobj
)
269 static inline int sysfs_rename_dir(struct kobject
*kobj
, const char *new_name
)
274 static inline int sysfs_move_dir(struct kobject
*kobj
,
275 struct kobject
*new_parent_kobj
)
280 static inline int sysfs_create_file(struct kobject
*kobj
,
281 const struct attribute
*attr
)
286 static inline int sysfs_create_files(struct kobject
*kobj
,
287 const struct attribute
**attr
)
292 static inline int sysfs_chmod_file(struct kobject
*kobj
,
293 const struct attribute
*attr
, umode_t mode
)
298 static inline void sysfs_remove_file(struct kobject
*kobj
,
299 const struct attribute
*attr
)
303 static inline void sysfs_remove_files(struct kobject
*kobj
,
304 const struct attribute
**attr
)
308 static inline int sysfs_create_bin_file(struct kobject
*kobj
,
309 const struct bin_attribute
*attr
)
314 static inline void sysfs_remove_bin_file(struct kobject
*kobj
,
315 const struct bin_attribute
*attr
)
319 static inline int sysfs_create_link(struct kobject
*kobj
,
320 struct kobject
*target
, const char *name
)
325 static inline int sysfs_create_link_nowarn(struct kobject
*kobj
,
326 struct kobject
*target
,
332 static inline void sysfs_remove_link(struct kobject
*kobj
, const char *name
)
336 static inline int sysfs_rename_link(struct kobject
*k
, struct kobject
*t
,
337 const char *old_name
, const char *new_name
)
342 static inline void sysfs_delete_link(struct kobject
*k
, struct kobject
*t
,
347 static inline int sysfs_create_group(struct kobject
*kobj
,
348 const struct attribute_group
*grp
)
353 static inline int sysfs_create_groups(struct kobject
*kobj
,
354 const struct attribute_group
**groups
)
359 static inline int sysfs_update_group(struct kobject
*kobj
,
360 const struct attribute_group
*grp
)
365 static inline void sysfs_remove_group(struct kobject
*kobj
,
366 const struct attribute_group
*grp
)
370 static inline void sysfs_remove_groups(struct kobject
*kobj
,
371 const struct attribute_group
**groups
)
375 static inline int sysfs_add_file_to_group(struct kobject
*kobj
,
376 const struct attribute
*attr
, const char *group
)
381 static inline void sysfs_remove_file_from_group(struct kobject
*kobj
,
382 const struct attribute
*attr
, const char *group
)
386 static inline int sysfs_merge_group(struct kobject
*kobj
,
387 const struct attribute_group
*grp
)
392 static inline void sysfs_unmerge_group(struct kobject
*kobj
,
393 const struct attribute_group
*grp
)
397 static inline int sysfs_add_link_to_group(struct kobject
*kobj
,
398 const char *group_name
, struct kobject
*target
,
399 const char *link_name
)
404 static inline void sysfs_remove_link_from_group(struct kobject
*kobj
,
405 const char *group_name
, const char *link_name
)
409 static inline void sysfs_notify(struct kobject
*kobj
, const char *dir
,
413 static inline void sysfs_notify_dirent(struct sysfs_dirent
*sd
)
417 struct sysfs_dirent
*sysfs_get_dirent(struct sysfs_dirent
*parent_sd
,
419 const unsigned char *name
)
423 static inline struct sysfs_dirent
*sysfs_get(struct sysfs_dirent
*sd
)
427 static inline void sysfs_put(struct sysfs_dirent
*sd
)
431 static inline int __must_check
sysfs_init(void)
436 #endif /* CONFIG_SYSFS */
438 #endif /* _SYSFS_H_ */
This page took 0.04011 seconds and 6 git commands to generate.