Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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. |
Tejun Heo | 6d66f5c | 2007-09-20 17:31:38 +0900 | [diff] [blame] | 6 | * Copyright (c) 2007 SUSE Linux Products GmbH |
| 7 | * Copyright (c) 2007 Tejun Heo <teheo@suse.de> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 8 | * |
| 9 | * Please see Documentation/filesystems/sysfs.txt for more information. |
| 10 | */ |
| 11 | |
| 12 | #ifndef _SYSFS_H_ |
| 13 | #define _SYSFS_H_ |
| 14 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame] | 15 | #include <linux/compiler.h> |
Ralf Baechle | 5851fad | 2007-03-18 12:58:08 +0000 | [diff] [blame] | 16 | #include <linux/errno.h> |
Frank Haverkamp | bf0acc3 | 2007-01-17 17:51:18 +0100 | [diff] [blame] | 17 | #include <linux/list.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 18 | #include <asm/atomic.h> |
| 19 | |
| 20 | struct kobject; |
| 21 | struct module; |
| 22 | |
Tejun Heo | 7b59575 | 2007-06-14 03:45:17 +0900 | [diff] [blame] | 23 | /* FIXME |
Parag Warudkar | 01e8ef1 | 2008-10-18 20:28:50 -0700 | [diff] [blame] | 24 | * The *owner field is no longer used. |
| 25 | * x86 tree has been cleaned up. The owner |
| 26 | * attribute is still left for other arches. |
Tejun Heo | 7b59575 | 2007-06-14 03:45:17 +0900 | [diff] [blame] | 27 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 28 | struct attribute { |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 29 | const char *name; |
| 30 | struct module *owner; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 31 | mode_t mode; |
| 32 | }; |
| 33 | |
| 34 | struct attribute_group { |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 35 | const char *name; |
James Bottomley | 0f42389 | 2008-03-20 20:47:52 -0500 | [diff] [blame] | 36 | mode_t (*is_visible)(struct kobject *, |
James Bottomley | d4acd72 | 2007-10-31 09:38:04 -0500 | [diff] [blame] | 37 | struct attribute *, int); |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 38 | struct attribute **attrs; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 39 | }; |
| 40 | |
| 41 | |
| 42 | |
| 43 | /** |
| 44 | * Use these macros to make defining attributes easier. See include/linux/device.h |
| 45 | * for examples.. |
| 46 | */ |
| 47 | |
| 48 | #define __ATTR(_name,_mode,_show,_store) { \ |
Tejun Heo | 7b59575 | 2007-06-14 03:45:17 +0900 | [diff] [blame] | 49 | .attr = {.name = __stringify(_name), .mode = _mode }, \ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 50 | .show = _show, \ |
| 51 | .store = _store, \ |
| 52 | } |
| 53 | |
| 54 | #define __ATTR_RO(_name) { \ |
Tejun Heo | 7b59575 | 2007-06-14 03:45:17 +0900 | [diff] [blame] | 55 | .attr = { .name = __stringify(_name), .mode = 0444 }, \ |
| 56 | .show = _name##_show, \ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 57 | } |
| 58 | |
| 59 | #define __ATTR_NULL { .attr = { .name = NULL } } |
| 60 | |
| 61 | #define attr_name(_attr) (_attr).attr.name |
| 62 | |
| 63 | struct vm_area_struct; |
| 64 | |
| 65 | struct bin_attribute { |
| 66 | struct attribute attr; |
| 67 | size_t size; |
| 68 | void *private; |
Zhang Rui | 91a6902 | 2007-06-09 13:57:22 +0800 | [diff] [blame] | 69 | ssize_t (*read)(struct kobject *, struct bin_attribute *, |
| 70 | char *, loff_t, size_t); |
| 71 | ssize_t (*write)(struct kobject *, struct bin_attribute *, |
| 72 | char *, loff_t, size_t); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 73 | int (*mmap)(struct kobject *, struct bin_attribute *attr, |
| 74 | struct vm_area_struct *vma); |
| 75 | }; |
| 76 | |
| 77 | struct sysfs_ops { |
| 78 | ssize_t (*show)(struct kobject *, struct attribute *,char *); |
| 79 | ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t); |
| 80 | }; |
| 81 | |
Neil Brown | f1282c8 | 2008-07-16 08:58:04 +1000 | [diff] [blame] | 82 | struct sysfs_dirent; |
| 83 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 84 | #ifdef CONFIG_SYSFS |
| 85 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 86 | int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *), |
| 87 | void *data, struct module *owner); |
Alan Stern | d9a9cdf | 2007-03-15 15:50:34 -0400 | [diff] [blame] | 88 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 89 | int __must_check sysfs_create_dir(struct kobject *kobj); |
| 90 | void sysfs_remove_dir(struct kobject *kobj); |
| 91 | int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name); |
| 92 | int __must_check sysfs_move_dir(struct kobject *kobj, |
| 93 | struct kobject *new_parent_kobj); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 94 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 95 | int __must_check sysfs_create_file(struct kobject *kobj, |
| 96 | const struct attribute *attr); |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 97 | int __must_check sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, |
| 98 | mode_t mode); |
| 99 | void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 100 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame] | 101 | int __must_check sysfs_create_bin_file(struct kobject *kobj, |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 102 | struct bin_attribute *attr); |
Randy.Dunlap | 995982c | 2006-07-10 23:05:25 -0700 | [diff] [blame] | 103 | void sysfs_remove_bin_file(struct kobject *kobj, struct bin_attribute *attr); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 104 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 105 | int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target, |
| 106 | const char *name); |
Cornelia Huck | 36ce6da | 2008-06-10 11:09:08 +0200 | [diff] [blame] | 107 | int __must_check sysfs_create_link_nowarn(struct kobject *kobj, |
| 108 | struct kobject *target, |
| 109 | const char *name); |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 110 | void sysfs_remove_link(struct kobject *kobj, const char *name); |
Alan Stern | dfa87c8 | 2007-02-20 15:02:44 -0500 | [diff] [blame] | 111 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 112 | int __must_check sysfs_create_group(struct kobject *kobj, |
| 113 | const struct attribute_group *grp); |
James Bottomley | 0f42389 | 2008-03-20 20:47:52 -0500 | [diff] [blame] | 114 | int sysfs_update_group(struct kobject *kobj, |
| 115 | const struct attribute_group *grp); |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 116 | void sysfs_remove_group(struct kobject *kobj, |
| 117 | const struct attribute_group *grp); |
| 118 | int sysfs_add_file_to_group(struct kobject *kobj, |
| 119 | const struct attribute *attr, const char *group); |
| 120 | void sysfs_remove_file_from_group(struct kobject *kobj, |
| 121 | const struct attribute *attr, const char *group); |
| 122 | |
Trent Piepho | 8c0e399 | 2008-09-25 16:45:13 -0700 | [diff] [blame] | 123 | void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr); |
Neil Brown | f1282c8 | 2008-07-16 08:58:04 +1000 | [diff] [blame] | 124 | void sysfs_notify_dirent(struct sysfs_dirent *sd); |
| 125 | struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd, |
| 126 | const unsigned char *name); |
| 127 | struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd); |
| 128 | void sysfs_put(struct sysfs_dirent *sd); |
Andrew Morton | ae87221d | 2007-08-24 16:11:54 -0700 | [diff] [blame] | 129 | void sysfs_printk_last_file(void); |
Neil Brown | f1282c8 | 2008-07-16 08:58:04 +1000 | [diff] [blame] | 130 | int __must_check sysfs_init(void); |
Andrew Morton | f20a9ea | 2006-08-14 22:43:23 -0700 | [diff] [blame] | 131 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 132 | #else /* CONFIG_SYSFS */ |
| 133 | |
Alan Stern | d9a9cdf | 2007-03-15 15:50:34 -0400 | [diff] [blame] | 134 | static inline int sysfs_schedule_callback(struct kobject *kobj, |
Alan Stern | 523ded7 | 2007-04-26 00:12:04 -0700 | [diff] [blame] | 135 | void (*func)(void *), void *data, struct module *owner) |
Alan Stern | d9a9cdf | 2007-03-15 15:50:34 -0400 | [diff] [blame] | 136 | { |
| 137 | return -ENOSYS; |
| 138 | } |
| 139 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 140 | static inline int sysfs_create_dir(struct kobject *kobj) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 141 | { |
| 142 | return 0; |
| 143 | } |
| 144 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 145 | static inline void sysfs_remove_dir(struct kobject *kobj) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 146 | { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 147 | } |
| 148 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 149 | static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 150 | { |
Eric W. Biederman | 0b4a4fe | 2008-07-03 18:05:28 -0700 | [diff] [blame] | 151 | return 0; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 152 | } |
| 153 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 154 | static inline int sysfs_move_dir(struct kobject *kobj, |
| 155 | struct kobject *new_parent_kobj) |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 156 | { |
| 157 | return 0; |
| 158 | } |
| 159 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 160 | static inline int sysfs_create_file(struct kobject *kobj, |
| 161 | const struct attribute *attr) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 162 | { |
| 163 | return 0; |
| 164 | } |
| 165 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 166 | static inline int sysfs_chmod_file(struct kobject *kobj, |
| 167 | struct attribute *attr, mode_t mode) |
Kay Sievers | 31e5abe | 2005-04-18 21:57:32 -0700 | [diff] [blame] | 168 | { |
| 169 | return 0; |
| 170 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 171 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 172 | static inline void sysfs_remove_file(struct kobject *kobj, |
| 173 | const struct attribute *attr) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 174 | { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 175 | } |
| 176 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 177 | static inline int sysfs_create_bin_file(struct kobject *kobj, |
| 178 | struct bin_attribute *attr) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 179 | { |
| 180 | return 0; |
| 181 | } |
| 182 | |
David Rientjes | 3612e06 | 2008-02-19 17:39:02 -0800 | [diff] [blame] | 183 | static inline void sysfs_remove_bin_file(struct kobject *kobj, |
| 184 | struct bin_attribute *attr) |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 185 | { |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 186 | } |
| 187 | |
| 188 | static inline int sysfs_create_link(struct kobject *kobj, |
| 189 | struct kobject *target, const char *name) |
| 190 | { |
| 191 | return 0; |
| 192 | } |
| 193 | |
Cornelia Huck | 36ce6da | 2008-06-10 11:09:08 +0200 | [diff] [blame] | 194 | static inline int sysfs_create_link_nowarn(struct kobject *kobj, |
| 195 | struct kobject *target, |
| 196 | const char *name) |
| 197 | { |
| 198 | return 0; |
| 199 | } |
| 200 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 201 | static inline void sysfs_remove_link(struct kobject *kobj, const char *name) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 202 | { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 203 | } |
| 204 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 205 | static inline int sysfs_create_group(struct kobject *kobj, |
| 206 | const struct attribute_group *grp) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 207 | { |
| 208 | return 0; |
| 209 | } |
| 210 | |
Randy Dunlap | 1cbfb7a | 2008-04-30 09:01:17 -0700 | [diff] [blame] | 211 | static inline int sysfs_update_group(struct kobject *kobj, |
| 212 | const struct attribute_group *grp) |
| 213 | { |
| 214 | return 0; |
| 215 | } |
| 216 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 217 | static inline void sysfs_remove_group(struct kobject *kobj, |
| 218 | const struct attribute_group *grp) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 219 | { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 220 | } |
| 221 | |
Alan Stern | dfa87c8 | 2007-02-20 15:02:44 -0500 | [diff] [blame] | 222 | static inline int sysfs_add_file_to_group(struct kobject *kobj, |
| 223 | const struct attribute *attr, const char *group) |
| 224 | { |
| 225 | return 0; |
| 226 | } |
| 227 | |
| 228 | static inline void sysfs_remove_file_from_group(struct kobject *kobj, |
Ralf Baechle | d701d8a | 2007-03-01 12:40:21 +0000 | [diff] [blame] | 229 | const struct attribute *attr, const char *group) |
Alan Stern | dfa87c8 | 2007-02-20 15:02:44 -0500 | [diff] [blame] | 230 | { |
Alan Stern | dfa87c8 | 2007-02-20 15:02:44 -0500 | [diff] [blame] | 231 | } |
| 232 | |
Trent Piepho | 8c0e399 | 2008-09-25 16:45:13 -0700 | [diff] [blame] | 233 | static inline void sysfs_notify(struct kobject *kobj, const char *dir, |
| 234 | const char *attr) |
NeilBrown | 4508a7a | 2006-03-20 17:53:53 +1100 | [diff] [blame] | 235 | { |
| 236 | } |
Neil Brown | f1282c8 | 2008-07-16 08:58:04 +1000 | [diff] [blame] | 237 | static inline void sysfs_notify_dirent(struct sysfs_dirent *sd) |
| 238 | { |
| 239 | } |
| 240 | static inline |
| 241 | struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd, |
| 242 | const unsigned char *name) |
| 243 | { |
| 244 | return NULL; |
| 245 | } |
| 246 | static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd) |
| 247 | { |
| 248 | return NULL; |
| 249 | } |
| 250 | static inline void sysfs_put(struct sysfs_dirent *sd) |
| 251 | { |
| 252 | } |
NeilBrown | 4508a7a | 2006-03-20 17:53:53 +1100 | [diff] [blame] | 253 | |
Andrew Morton | f20a9ea | 2006-08-14 22:43:23 -0700 | [diff] [blame] | 254 | static inline int __must_check sysfs_init(void) |
| 255 | { |
| 256 | return 0; |
| 257 | } |
| 258 | |
Andrew Morton | ae87221d | 2007-08-24 16:11:54 -0700 | [diff] [blame] | 259 | static inline void sysfs_printk_last_file(void) |
| 260 | { |
| 261 | } |
| 262 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 263 | #endif /* CONFIG_SYSFS */ |
| 264 | |
| 265 | #endif /* _SYSFS_H_ */ |