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 |
| 24 | * The *owner field is no longer used, but leave around |
| 25 | * until the tree gets cleaned up fully. |
| 26 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 27 | struct attribute { |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 28 | const char *name; |
| 29 | struct module *owner; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 30 | mode_t mode; |
| 31 | }; |
| 32 | |
| 33 | struct attribute_group { |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 34 | const char *name; |
James Bottomley | 0f42389 | 2008-03-20 20:47:52 -0500 | [diff] [blame] | 35 | mode_t (*is_visible)(struct kobject *, |
James Bottomley | d4acd72 | 2007-10-31 09:38:04 -0500 | [diff] [blame] | 36 | struct attribute *, int); |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 37 | struct attribute **attrs; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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) { \ |
Tejun Heo | 7b59575 | 2007-06-14 03:45:17 +0900 | [diff] [blame] | 48 | .attr = {.name = __stringify(_name), .mode = _mode }, \ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 49 | .show = _show, \ |
| 50 | .store = _store, \ |
| 51 | } |
| 52 | |
| 53 | #define __ATTR_RO(_name) { \ |
Tejun Heo | 7b59575 | 2007-06-14 03:45:17 +0900 | [diff] [blame] | 54 | .attr = { .name = __stringify(_name), .mode = 0444 }, \ |
| 55 | .show = _name##_show, \ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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; |
Zhang Rui | 91a6902 | 2007-06-09 13:57:22 +0800 | [diff] [blame] | 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); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 81 | #ifdef CONFIG_SYSFS |
| 82 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 83 | int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *), |
| 84 | void *data, struct module *owner); |
Alan Stern | d9a9cdf | 2007-03-15 15:50:34 -0400 | [diff] [blame] | 85 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 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); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 91 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 92 | int __must_check sysfs_create_file(struct kobject *kobj, |
| 93 | const struct attribute *attr); |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 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); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 97 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame] | 98 | int __must_check sysfs_create_bin_file(struct kobject *kobj, |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 99 | struct bin_attribute *attr); |
Randy.Dunlap | 995982c | 2006-07-10 23:05:25 -0700 | [diff] [blame] | 100 | void sysfs_remove_bin_file(struct kobject *kobj, struct bin_attribute *attr); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 101 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 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); |
Alan Stern | dfa87c8 | 2007-02-20 15:02:44 -0500 | [diff] [blame] | 105 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 106 | int __must_check sysfs_create_group(struct kobject *kobj, |
| 107 | const struct attribute_group *grp); |
James Bottomley | 0f42389 | 2008-03-20 20:47:52 -0500 | [diff] [blame] | 108 | int sysfs_update_group(struct kobject *kobj, |
| 109 | const struct attribute_group *grp); |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 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); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 118 | |
Andrew Morton | f20a9ea | 2006-08-14 22:43:23 -0700 | [diff] [blame] | 119 | extern int __must_check sysfs_init(void); |
| 120 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 121 | #else /* CONFIG_SYSFS */ |
| 122 | |
Alan Stern | d9a9cdf | 2007-03-15 15:50:34 -0400 | [diff] [blame] | 123 | static inline int sysfs_schedule_callback(struct kobject *kobj, |
Alan Stern | 523ded7 | 2007-04-26 00:12:04 -0700 | [diff] [blame] | 124 | void (*func)(void *), void *data, struct module *owner) |
Alan Stern | d9a9cdf | 2007-03-15 15:50:34 -0400 | [diff] [blame] | 125 | { |
| 126 | return -ENOSYS; |
| 127 | } |
| 128 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 129 | static inline int sysfs_create_dir(struct kobject *kobj) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 130 | { |
| 131 | return 0; |
| 132 | } |
| 133 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 134 | static inline void sysfs_remove_dir(struct kobject *kobj) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 135 | { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 136 | } |
| 137 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 138 | 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] | 139 | { |
| 140 | return 0; |
| 141 | } |
| 142 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 143 | static inline int sysfs_move_dir(struct kobject *kobj, |
| 144 | struct kobject *new_parent_kobj) |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 145 | { |
| 146 | return 0; |
| 147 | } |
| 148 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 149 | static inline int sysfs_create_file(struct kobject *kobj, |
| 150 | const struct attribute *attr) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 151 | { |
| 152 | return 0; |
| 153 | } |
| 154 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 155 | static inline int sysfs_chmod_file(struct kobject *kobj, |
| 156 | struct attribute *attr, mode_t mode) |
Kay Sievers | 31e5abe | 2005-04-18 21:57:32 -0700 | [diff] [blame] | 157 | { |
| 158 | return 0; |
| 159 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 160 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 161 | static inline void sysfs_remove_file(struct kobject *kobj, |
| 162 | const struct attribute *attr) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 163 | { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 164 | } |
| 165 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 166 | static inline int sysfs_create_bin_file(struct kobject *kobj, |
| 167 | struct bin_attribute *attr) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 168 | { |
| 169 | return 0; |
| 170 | } |
| 171 | |
David Rientjes | 3612e06 | 2008-02-19 17:39:02 -0800 | [diff] [blame] | 172 | static inline void sysfs_remove_bin_file(struct kobject *kobj, |
| 173 | struct bin_attribute *attr) |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 174 | { |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 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) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 184 | { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 185 | } |
| 186 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 187 | static inline int sysfs_create_group(struct kobject *kobj, |
| 188 | const struct attribute_group *grp) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 189 | { |
| 190 | return 0; |
| 191 | } |
| 192 | |
Randy Dunlap | 1cbfb7a | 2008-04-30 09:01:17 -0700 | [diff] [blame] | 193 | static inline int sysfs_update_group(struct kobject *kobj, |
| 194 | const struct attribute_group *grp) |
| 195 | { |
| 196 | return 0; |
| 197 | } |
| 198 | |
Randy Dunlap | 2850699 | 2008-05-01 04:34:43 -0700 | [diff] [blame] | 199 | static inline int sysfs_update_group(struct kobject *kobj, |
| 200 | const struct attribute_group *grp) |
| 201 | { |
| 202 | return 0; |
| 203 | } |
| 204 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 205 | static inline void sysfs_remove_group(struct kobject *kobj, |
| 206 | const struct attribute_group *grp) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 207 | { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 208 | } |
| 209 | |
Alan Stern | dfa87c8 | 2007-02-20 15:02:44 -0500 | [diff] [blame] | 210 | static inline int sysfs_add_file_to_group(struct kobject *kobj, |
| 211 | const struct attribute *attr, const char *group) |
| 212 | { |
| 213 | return 0; |
| 214 | } |
| 215 | |
| 216 | static inline void sysfs_remove_file_from_group(struct kobject *kobj, |
Ralf Baechle | d701d8a | 2007-03-01 12:40:21 +0000 | [diff] [blame] | 217 | const struct attribute *attr, const char *group) |
Alan Stern | dfa87c8 | 2007-02-20 15:02:44 -0500 | [diff] [blame] | 218 | { |
Alan Stern | dfa87c8 | 2007-02-20 15:02:44 -0500 | [diff] [blame] | 219 | } |
| 220 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 221 | static inline void sysfs_notify(struct kobject *kobj, char *dir, char *attr) |
NeilBrown | 4508a7a | 2006-03-20 17:53:53 +1100 | [diff] [blame] | 222 | { |
| 223 | } |
| 224 | |
Andrew Morton | f20a9ea | 2006-08-14 22:43:23 -0700 | [diff] [blame] | 225 | static inline int __must_check sysfs_init(void) |
| 226 | { |
| 227 | return 0; |
| 228 | } |
| 229 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 230 | #endif /* CONFIG_SYSFS */ |
| 231 | |
| 232 | #endif /* _SYSFS_H_ */ |