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 * 7 * Please see Documentation/filesystems/sysfs.txt for more information. 8 */ 9 10 #ifndef _SYSFS_H_ 11 #define _SYSFS_H_ 12 13 #include <linux/compiler.h> 14 #include <linux/list.h> 15 #include <asm/atomic.h> 16 17 struct kobject; 18 struct module; 19 struct nameidata; 20 21 struct attribute { 22 const char * name; 23 struct module * owner; 24 mode_t mode; 25 }; 26 27 struct attribute_group { 28 const char * name; 29 struct attribute ** attrs; 30 }; 31 32 33 34 /** 35 * Use these macros to make defining attributes easier. See include/linux/device.h 36 * for examples.. 37 */ 38 39 #define __ATTR(_name,_mode,_show,_store) { \ 40 .attr = {.name = __stringify(_name), .mode = _mode, .owner = THIS_MODULE }, \ 41 .show = _show, \ 42 .store = _store, \ 43 } 44 45 #define __ATTR_RO(_name) { \ 46 .attr = { .name = __stringify(_name), .mode = 0444, .owner = THIS_MODULE }, \ 47 .show = _name##_show, \ 48 } 49 50 #define __ATTR_NULL { .attr = { .name = NULL } } 51 52 #define attr_name(_attr) (_attr).attr.name 53 54 struct vm_area_struct; 55 56 struct bin_attribute { 57 struct attribute attr; 58 size_t size; 59 void *private; 60 ssize_t (*read)(struct kobject *, char *, loff_t, size_t); 61 ssize_t (*write)(struct kobject *, char *, loff_t, size_t); 62 int (*mmap)(struct kobject *, struct bin_attribute *attr, 63 struct vm_area_struct *vma); 64 }; 65 66 struct sysfs_ops { 67 ssize_t (*show)(struct kobject *, struct attribute *,char *); 68 ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t); 69 }; 70 71 struct sysfs_dirent { 72 atomic_t s_count; 73 struct list_head s_sibling; 74 struct list_head s_children; 75 void * s_element; 76 int s_type; 77 umode_t s_mode; 78 struct dentry * s_dentry; 79 struct iattr * s_iattr; 80 atomic_t s_event; 81 }; 82 83 #define SYSFS_ROOT 0x0001 84 #define SYSFS_DIR 0x0002 85 #define SYSFS_KOBJ_ATTR 0x0004 86 #define SYSFS_KOBJ_BIN_ATTR 0x0008 87 #define SYSFS_KOBJ_LINK 0x0020 88 #define SYSFS_NOT_PINNED (SYSFS_KOBJ_ATTR | SYSFS_KOBJ_BIN_ATTR | SYSFS_KOBJ_LINK) 89 90 #ifdef CONFIG_SYSFS 91 92 extern int __must_check 93 sysfs_create_dir(struct kobject *, struct dentry *); 94 95 extern void 96 sysfs_remove_dir(struct kobject *); 97 98 extern int __must_check 99 sysfs_rename_dir(struct kobject *, struct dentry *, const char *new_name); 100 101 extern int __must_check 102 sysfs_move_dir(struct kobject *, struct kobject *); 103 104 extern int __must_check 105 sysfs_create_file(struct kobject *, const struct attribute *); 106 107 extern int __must_check 108 sysfs_update_file(struct kobject *, const struct attribute *); 109 110 extern int __must_check 111 sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode); 112 113 extern void 114 sysfs_remove_file(struct kobject *, const struct attribute *); 115 116 extern int __must_check 117 sysfs_create_link(struct kobject * kobj, struct kobject * target, const char * name); 118 119 extern void 120 sysfs_remove_link(struct kobject *, const char * name); 121 122 int __must_check sysfs_create_bin_file(struct kobject *kobj, 123 struct bin_attribute *attr); 124 void sysfs_remove_bin_file(struct kobject *kobj, struct bin_attribute *attr); 125 126 int __must_check sysfs_create_group(struct kobject *, 127 const struct attribute_group *); 128 void sysfs_remove_group(struct kobject *, const struct attribute_group *); 129 void sysfs_notify(struct kobject * k, char *dir, char *attr); 130 131 132 extern int sysfs_make_shadowed_dir(struct kobject *kobj, 133 void * (*follow_link)(struct dentry *, struct nameidata *)); 134 extern struct dentry *sysfs_create_shadow_dir(struct kobject *kobj); 135 extern void sysfs_remove_shadow_dir(struct dentry *dir); 136 137 extern int __must_check sysfs_init(void); 138 139 #else /* CONFIG_SYSFS */ 140 141 static inline int sysfs_create_dir(struct kobject * k, struct dentry *shadow) 142 { 143 return 0; 144 } 145 146 static inline void sysfs_remove_dir(struct kobject * k) 147 { 148 ; 149 } 150 151 static inline int sysfs_rename_dir(struct kobject * k, 152 struct dentry *new_parent, 153 const char *new_name) 154 { 155 return 0; 156 } 157 158 static inline int sysfs_move_dir(struct kobject * k, struct kobject * new_parent) 159 { 160 return 0; 161 } 162 163 static inline int sysfs_create_file(struct kobject * k, const struct attribute * a) 164 { 165 return 0; 166 } 167 168 static inline int sysfs_update_file(struct kobject * k, const struct attribute * a) 169 { 170 return 0; 171 } 172 static inline int sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode) 173 { 174 return 0; 175 } 176 177 static inline void sysfs_remove_file(struct kobject * k, const struct attribute * a) 178 { 179 ; 180 } 181 182 static inline int sysfs_create_link(struct kobject * k, struct kobject * t, const char * n) 183 { 184 return 0; 185 } 186 187 static inline void sysfs_remove_link(struct kobject * k, const char * name) 188 { 189 ; 190 } 191 192 193 static inline int sysfs_create_bin_file(struct kobject * k, struct bin_attribute * a) 194 { 195 return 0; 196 } 197 198 static inline int sysfs_remove_bin_file(struct kobject * k, struct bin_attribute * a) 199 { 200 return 0; 201 } 202 203 static inline int sysfs_create_group(struct kobject * k, const struct attribute_group *g) 204 { 205 return 0; 206 } 207 208 static inline void sysfs_remove_group(struct kobject * k, const struct attribute_group * g) 209 { 210 ; 211 } 212 213 static inline void sysfs_notify(struct kobject * k, char *dir, char *attr) 214 { 215 } 216 217 static inline int sysfs_make_shadowed_dir(struct kobject *kobj, 218 void * (*follow_link)(struct dentry *, struct nameidata *)) 219 { 220 return 0; 221 } 222 223 static inline int __must_check sysfs_init(void) 224 { 225 return 0; 226 } 227 228 #endif /* CONFIG_SYSFS */ 229 230 #endif /* _SYSFS_H_ */ 231