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. 6 * Copyright (c) 2007 SUSE Linux Products GmbH 7 * Copyright (c) 2007 Tejun Heo <[email protected]> 8 * 9 * Please see Documentation/filesystems/sysfs.txt for more information. 10 */ 11 12 #ifndef _SYSFS_H_ 13 #define _SYSFS_H_ 14 15 #include <linux/compiler.h> 16 #include <linux/errno.h> 17 #include <linux/list.h> 18 #include <asm/atomic.h> 19 20 struct kobject; 21 struct module; 22 23 /* FIXME 24 * The *owner field is no longer used, but leave around 25 * until the tree gets cleaned up fully. 26 */ 27 struct attribute { 28 const char *name; 29 struct module *owner; 30 mode_t mode; 31 }; 32 33 struct attribute_group { 34 const char *name; 35 mode_t (*is_visible)(struct kobject *, 36 struct attribute *, int); 37 struct attribute **attrs; 38 }; 39 40 41 42 /** 43 * Use these macros to make defining attributes easier. See include/linux/device.h 44 * for examples.. 45 */ 46 47 #define __ATTR(_name,_mode,_show,_store) { \ 48 .attr = {.name = __stringify(_name), .mode = _mode }, \ 49 .show = _show, \ 50 .store = _store, \ 51 } 52 53 #define __ATTR_RO(_name) { \ 54 .attr = { .name = __stringify(_name), .mode = 0444 }, \ 55 .show = _name##_show, \ 56 } 57 58 #define __ATTR_NULL { .attr = { .name = NULL } } 59 60 #define attr_name(_attr) (_attr).attr.name 61 62 struct vm_area_struct; 63 64 struct bin_attribute { 65 struct attribute attr; 66 size_t size; 67 void *private; 68 ssize_t (*read)(struct kobject *, struct bin_attribute *, 69 char *, loff_t, size_t); 70 ssize_t (*write)(struct kobject *, struct bin_attribute *, 71 char *, loff_t, size_t); 72 int (*mmap)(struct kobject *, struct bin_attribute *attr, 73 struct vm_area_struct *vma); 74 }; 75 76 struct sysfs_ops { 77 ssize_t (*show)(struct kobject *, struct attribute *,char *); 78 ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t); 79 }; 80 81 #ifdef CONFIG_SYSFS 82 83 int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *), 84 void *data, struct module *owner); 85 86 int __must_check sysfs_create_dir(struct kobject *kobj); 87 void sysfs_remove_dir(struct kobject *kobj); 88 int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name); 89 int __must_check sysfs_move_dir(struct kobject *kobj, 90 struct kobject *new_parent_kobj); 91 92 int __must_check sysfs_create_file(struct kobject *kobj, 93 const struct attribute *attr); 94 int __must_check sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, 95 mode_t mode); 96 void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr); 97 98 int __must_check sysfs_create_bin_file(struct kobject *kobj, 99 struct bin_attribute *attr); 100 void sysfs_remove_bin_file(struct kobject *kobj, struct bin_attribute *attr); 101 102 int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target, 103 const char *name); 104 int __must_check sysfs_create_link_nowarn(struct kobject *kobj, 105 struct kobject *target, 106 const char *name); 107 void sysfs_remove_link(struct kobject *kobj, const char *name); 108 109 int __must_check sysfs_create_group(struct kobject *kobj, 110 const struct attribute_group *grp); 111 int sysfs_update_group(struct kobject *kobj, 112 const struct attribute_group *grp); 113 void sysfs_remove_group(struct kobject *kobj, 114 const struct attribute_group *grp); 115 int sysfs_add_file_to_group(struct kobject *kobj, 116 const struct attribute *attr, const char *group); 117 void sysfs_remove_file_from_group(struct kobject *kobj, 118 const struct attribute *attr, const char *group); 119 120 void sysfs_notify(struct kobject *kobj, char *dir, char *attr); 121 122 extern int __must_check sysfs_init(void); 123 124 #else /* CONFIG_SYSFS */ 125 126 static inline int sysfs_schedule_callback(struct kobject *kobj, 127 void (*func)(void *), void *data, struct module *owner) 128 { 129 return -ENOSYS; 130 } 131 132 static inline int sysfs_create_dir(struct kobject *kobj) 133 { 134 return 0; 135 } 136 137 static inline void sysfs_remove_dir(struct kobject *kobj) 138 { 139 } 140 141 static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name) 142 { 143 return 0; 144 } 145 146 static inline int sysfs_move_dir(struct kobject *kobj, 147 struct kobject *new_parent_kobj) 148 { 149 return 0; 150 } 151 152 static inline int sysfs_create_file(struct kobject *kobj, 153 const struct attribute *attr) 154 { 155 return 0; 156 } 157 158 static inline int sysfs_chmod_file(struct kobject *kobj, 159 struct attribute *attr, mode_t mode) 160 { 161 return 0; 162 } 163 164 static inline void sysfs_remove_file(struct kobject *kobj, 165 const struct attribute *attr) 166 { 167 } 168 169 static inline int sysfs_create_bin_file(struct kobject *kobj, 170 struct bin_attribute *attr) 171 { 172 return 0; 173 } 174 175 static inline void sysfs_remove_bin_file(struct kobject *kobj, 176 struct bin_attribute *attr) 177 { 178 } 179 180 static inline int sysfs_create_link(struct kobject *kobj, 181 struct kobject *target, const char *name) 182 { 183 return 0; 184 } 185 186 static inline int sysfs_create_link_nowarn(struct kobject *kobj, 187 struct kobject *target, 188 const char *name) 189 { 190 return 0; 191 } 192 193 static inline void sysfs_remove_link(struct kobject *kobj, const char *name) 194 { 195 } 196 197 static inline int sysfs_create_group(struct kobject *kobj, 198 const struct attribute_group *grp) 199 { 200 return 0; 201 } 202 203 static inline int sysfs_update_group(struct kobject *kobj, 204 const struct attribute_group *grp) 205 { 206 return 0; 207 } 208 209 static inline void sysfs_remove_group(struct kobject *kobj, 210 const struct attribute_group *grp) 211 { 212 } 213 214 static inline int sysfs_add_file_to_group(struct kobject *kobj, 215 const struct attribute *attr, const char *group) 216 { 217 return 0; 218 } 219 220 static inline void sysfs_remove_file_from_group(struct kobject *kobj, 221 const struct attribute *attr, const char *group) 222 { 223 } 224 225 static inline void sysfs_notify(struct kobject *kobj, char *dir, char *attr) 226 { 227 } 228 229 static inline int __must_check sysfs_init(void) 230 { 231 return 0; 232 } 233 234 #endif /* CONFIG_SYSFS */ 235 236 #endif /* _SYSFS_H_ */ 237