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 void sysfs_remove_link(struct kobject *kobj, const char *name); 105 106 int __must_check sysfs_create_group(struct kobject *kobj, 107 const struct attribute_group *grp); 108 int sysfs_update_group(struct kobject *kobj, 109 const struct attribute_group *grp); 110 void sysfs_remove_group(struct kobject *kobj, 111 const struct attribute_group *grp); 112 int sysfs_add_file_to_group(struct kobject *kobj, 113 const struct attribute *attr, const char *group); 114 void sysfs_remove_file_from_group(struct kobject *kobj, 115 const struct attribute *attr, const char *group); 116 117 void sysfs_notify(struct kobject *kobj, char *dir, char *attr); 118 119 extern int __must_check sysfs_init(void); 120 121 #else /* CONFIG_SYSFS */ 122 123 static inline int sysfs_schedule_callback(struct kobject *kobj, 124 void (*func)(void *), void *data, struct module *owner) 125 { 126 return -ENOSYS; 127 } 128 129 static inline int sysfs_create_dir(struct kobject *kobj) 130 { 131 return 0; 132 } 133 134 static inline void sysfs_remove_dir(struct kobject *kobj) 135 { 136 } 137 138 static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name) 139 { 140 return 0; 141 } 142 143 static inline int sysfs_move_dir(struct kobject *kobj, 144 struct kobject *new_parent_kobj) 145 { 146 return 0; 147 } 148 149 static inline int sysfs_create_file(struct kobject *kobj, 150 const struct attribute *attr) 151 { 152 return 0; 153 } 154 155 static inline int sysfs_chmod_file(struct kobject *kobj, 156 struct attribute *attr, mode_t mode) 157 { 158 return 0; 159 } 160 161 static inline void sysfs_remove_file(struct kobject *kobj, 162 const struct attribute *attr) 163 { 164 } 165 166 static inline int sysfs_create_bin_file(struct kobject *kobj, 167 struct bin_attribute *attr) 168 { 169 return 0; 170 } 171 172 static inline void sysfs_remove_bin_file(struct kobject *kobj, 173 struct bin_attribute *attr) 174 { 175 } 176 177 static inline int sysfs_create_link(struct kobject *kobj, 178 struct kobject *target, const char *name) 179 { 180 return 0; 181 } 182 183 static inline void sysfs_remove_link(struct kobject *kobj, const char *name) 184 { 185 } 186 187 static inline int sysfs_create_group(struct kobject *kobj, 188 const struct attribute_group *grp) 189 { 190 return 0; 191 } 192 193 static inline int sysfs_update_group(struct kobject *kobj, 194 const struct attribute_group *grp) 195 { 196 return 0; 197 } 198 199 static inline void sysfs_remove_group(struct kobject *kobj, 200 const struct attribute_group *grp) 201 { 202 } 203 204 static inline int sysfs_add_file_to_group(struct kobject *kobj, 205 const struct attribute *attr, const char *group) 206 { 207 return 0; 208 } 209 210 static inline void sysfs_remove_file_from_group(struct kobject *kobj, 211 const struct attribute *attr, const char *group) 212 { 213 } 214 215 static inline void sysfs_notify(struct kobject *kobj, char *dir, char *attr) 216 { 217 } 218 219 static inline int __must_check sysfs_init(void) 220 { 221 return 0; 222 } 223 224 #endif /* CONFIG_SYSFS */ 225 226 #endif /* _SYSFS_H_ */ 227