2 * sysfs.h - definitions for the device driver filesystem
4 * Copyright (c) 2001,2002 Patrick Mochel
5 * Copyright (c) 2004 Silicon Graphics, Inc.
7 * Please see Documentation/filesystems/sysfs.txt for more information.
13 #include <linux/compiler.h>
14 #include <linux/errno.h>
15 #include <linux/list.h>
16 #include <asm/atomic.h>
25 * The *owner field is no longer used, but leave around
26 * until the tree gets cleaned up fully.
30 struct module * owner;
34 struct attribute_group {
36 struct attribute ** attrs;
42 * Use these macros to make defining attributes easier. See include/linux/device.h
46 #define __ATTR(_name,_mode,_show,_store) { \
47 .attr = {.name = __stringify(_name), .mode = _mode }, \
52 #define __ATTR_RO(_name) { \
53 .attr = { .name = __stringify(_name), .mode = 0444 }, \
54 .show = _name##_show, \
57 #define __ATTR_NULL { .attr = { .name = NULL } }
59 #define attr_name(_attr) (_attr).attr.name
61 struct vm_area_struct;
63 struct bin_attribute {
64 struct attribute attr;
67 ssize_t (*read)(struct kobject *, char *, loff_t, size_t);
68 ssize_t (*write)(struct kobject *, char *, loff_t, size_t);
69 int (*mmap)(struct kobject *, struct bin_attribute *attr,
70 struct vm_area_struct *vma);
74 ssize_t (*show)(struct kobject *, struct attribute *,char *);
75 ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t);
78 #define SYSFS_TYPE_MASK 0x00ff
79 #define SYSFS_ROOT 0x0001
80 #define SYSFS_DIR 0x0002
81 #define SYSFS_KOBJ_ATTR 0x0004
82 #define SYSFS_KOBJ_BIN_ATTR 0x0008
83 #define SYSFS_KOBJ_LINK 0x0020
84 #define SYSFS_NOT_PINNED (SYSFS_KOBJ_ATTR | SYSFS_KOBJ_BIN_ATTR | SYSFS_KOBJ_LINK)
85 #define SYSFS_COPY_NAME (SYSFS_DIR | SYSFS_KOBJ_LINK)
87 #define SYSFS_FLAG_MASK ~SYSFS_TYPE_MASK
88 #define SYSFS_FLAG_REMOVED 0x0100
92 extern int sysfs_schedule_callback(struct kobject *kobj,
93 void (*func)(void *), void *data, struct module *owner);
95 extern int __must_check
96 sysfs_create_dir(struct kobject *kobj, struct sysfs_dirent *shadow_parent_sd);
99 sysfs_remove_dir(struct kobject *);
101 extern int __must_check
102 sysfs_rename_dir(struct kobject *kobj, struct sysfs_dirent *new_parent_sd,
103 const char *new_name);
105 extern int __must_check
106 sysfs_move_dir(struct kobject *, struct kobject *);
108 extern int __must_check
109 sysfs_create_file(struct kobject *, const struct attribute *);
111 extern int __must_check
112 sysfs_update_file(struct kobject *, const struct attribute *);
114 extern int __must_check
115 sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode);
118 sysfs_remove_file(struct kobject *, const struct attribute *);
120 extern int __must_check
121 sysfs_create_link(struct kobject * kobj, struct kobject * target, const char * name);
124 sysfs_remove_link(struct kobject *, const char * name);
126 int __must_check sysfs_create_bin_file(struct kobject *kobj,
127 struct bin_attribute *attr);
128 void sysfs_remove_bin_file(struct kobject *kobj, struct bin_attribute *attr);
130 int __must_check sysfs_create_group(struct kobject *,
131 const struct attribute_group *);
132 void sysfs_remove_group(struct kobject *, const struct attribute_group *);
133 int sysfs_add_file_to_group(struct kobject *kobj,
134 const struct attribute *attr, const char *group);
135 void sysfs_remove_file_from_group(struct kobject *kobj,
136 const struct attribute *attr, const char *group);
138 void sysfs_notify(struct kobject * k, char *dir, char *attr);
141 extern int sysfs_make_shadowed_dir(struct kobject *kobj,
142 void * (*follow_link)(struct dentry *, struct nameidata *));
143 extern struct sysfs_dirent *sysfs_create_shadow_dir(struct kobject *kobj);
144 extern void sysfs_remove_shadow_dir(struct sysfs_dirent *shadow_sd);
146 extern int __must_check sysfs_init(void);
148 #else /* CONFIG_SYSFS */
150 static inline int sysfs_schedule_callback(struct kobject *kobj,
151 void (*func)(void *), void *data, struct module *owner)
156 static inline int sysfs_create_dir(struct kobject *kobj,
157 struct sysfs_dirent *shadow_parent_sd)
162 static inline void sysfs_remove_dir(struct kobject * k)
167 static inline int sysfs_rename_dir(struct kobject *kobj,
168 struct sysfs_dirent *new_parent_sd,
169 const char *new_name)
174 static inline int sysfs_move_dir(struct kobject * k, struct kobject * new_parent)
179 static inline int sysfs_create_file(struct kobject * k, const struct attribute * a)
184 static inline int sysfs_update_file(struct kobject * k, const struct attribute * a)
188 static inline int sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode)
193 static inline void sysfs_remove_file(struct kobject * k, const struct attribute * a)
198 static inline int sysfs_create_link(struct kobject * k, struct kobject * t, const char * n)
203 static inline void sysfs_remove_link(struct kobject * k, const char * name)
209 static inline int sysfs_create_bin_file(struct kobject * k, struct bin_attribute * a)
214 static inline int sysfs_remove_bin_file(struct kobject * k, struct bin_attribute * a)
219 static inline int sysfs_create_group(struct kobject * k, const struct attribute_group *g)
224 static inline void sysfs_remove_group(struct kobject * k, const struct attribute_group * g)
229 static inline int sysfs_add_file_to_group(struct kobject *kobj,
230 const struct attribute *attr, const char *group)
235 static inline void sysfs_remove_file_from_group(struct kobject *kobj,
236 const struct attribute *attr, const char *group)
240 static inline void sysfs_notify(struct kobject * k, char *dir, char *attr)
244 static inline int sysfs_make_shadowed_dir(struct kobject *kobj,
245 void * (*follow_link)(struct dentry *, struct nameidata *))
250 static inline int __must_check sysfs_init(void)
255 #endif /* CONFIG_SYSFS */
257 #endif /* _SYSFS_H_ */