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. |
| 6 | * |
| 7 | * Please see Documentation/filesystems/sysfs.txt for more information. |
| 8 | */ |
| 9 | |
| 10 | #ifndef _SYSFS_H_ |
| 11 | #define _SYSFS_H_ |
| 12 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame] | 13 | #include <linux/compiler.h> |
Ralf Baechle | 5851fad | 2007-03-18 12:58:08 +0000 | [diff] [blame] | 14 | #include <linux/errno.h> |
Frank Haverkamp | bf0acc3 | 2007-01-17 17:51:18 +0100 | [diff] [blame] | 15 | #include <linux/list.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 16 | #include <asm/atomic.h> |
| 17 | |
| 18 | struct kobject; |
| 19 | struct module; |
| 20 | |
Tejun Heo | 7b59575 | 2007-06-14 03:45:17 +0900 | [diff] [blame] | 21 | /* FIXME |
| 22 | * The *owner field is no longer used, but leave around |
| 23 | * until the tree gets cleaned up fully. |
| 24 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 25 | struct attribute { |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame^] | 26 | const char *name; |
| 27 | struct module *owner; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 28 | mode_t mode; |
| 29 | }; |
| 30 | |
| 31 | struct attribute_group { |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame^] | 32 | const char *name; |
| 33 | struct attribute **attrs; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 34 | }; |
| 35 | |
| 36 | |
| 37 | |
| 38 | /** |
| 39 | * Use these macros to make defining attributes easier. See include/linux/device.h |
| 40 | * for examples.. |
| 41 | */ |
| 42 | |
| 43 | #define __ATTR(_name,_mode,_show,_store) { \ |
Tejun Heo | 7b59575 | 2007-06-14 03:45:17 +0900 | [diff] [blame] | 44 | .attr = {.name = __stringify(_name), .mode = _mode }, \ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 45 | .show = _show, \ |
| 46 | .store = _store, \ |
| 47 | } |
| 48 | |
| 49 | #define __ATTR_RO(_name) { \ |
Tejun Heo | 7b59575 | 2007-06-14 03:45:17 +0900 | [diff] [blame] | 50 | .attr = { .name = __stringify(_name), .mode = 0444 }, \ |
| 51 | .show = _name##_show, \ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 52 | } |
| 53 | |
| 54 | #define __ATTR_NULL { .attr = { .name = NULL } } |
| 55 | |
| 56 | #define attr_name(_attr) (_attr).attr.name |
| 57 | |
| 58 | struct vm_area_struct; |
| 59 | |
| 60 | struct bin_attribute { |
| 61 | struct attribute attr; |
| 62 | size_t size; |
| 63 | void *private; |
Zhang Rui | 91a6902 | 2007-06-09 13:57:22 +0800 | [diff] [blame] | 64 | ssize_t (*read)(struct kobject *, struct bin_attribute *, |
| 65 | char *, loff_t, size_t); |
| 66 | ssize_t (*write)(struct kobject *, struct bin_attribute *, |
| 67 | char *, loff_t, size_t); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 68 | int (*mmap)(struct kobject *, struct bin_attribute *attr, |
| 69 | struct vm_area_struct *vma); |
| 70 | }; |
| 71 | |
| 72 | struct sysfs_ops { |
| 73 | ssize_t (*show)(struct kobject *, struct attribute *,char *); |
| 74 | ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t); |
| 75 | }; |
| 76 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 77 | #ifdef CONFIG_SYSFS |
| 78 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame^] | 79 | int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *), |
| 80 | void *data, struct module *owner); |
Alan Stern | d9a9cdf | 2007-03-15 15:50:34 -0400 | [diff] [blame] | 81 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame^] | 82 | int __must_check sysfs_create_dir(struct kobject *kobj); |
| 83 | void sysfs_remove_dir(struct kobject *kobj); |
| 84 | int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name); |
| 85 | int __must_check sysfs_move_dir(struct kobject *kobj, |
| 86 | struct kobject *new_parent_kobj); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 87 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame^] | 88 | int __must_check sysfs_create_file(struct kobject *kobj, |
| 89 | const struct attribute *attr); |
| 90 | int __must_check sysfs_update_file(struct kobject *kobj, |
| 91 | const struct attribute *attr); |
| 92 | int __must_check sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, |
| 93 | mode_t mode); |
| 94 | void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 95 | |
Andrew Morton | 4a7fb63 | 2006-08-14 22:43:17 -0700 | [diff] [blame] | 96 | int __must_check sysfs_create_bin_file(struct kobject *kobj, |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame^] | 97 | struct bin_attribute *attr); |
Randy.Dunlap | 995982c | 2006-07-10 23:05:25 -0700 | [diff] [blame] | 98 | void sysfs_remove_bin_file(struct kobject *kobj, struct bin_attribute *attr); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 99 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame^] | 100 | int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target, |
| 101 | const char *name); |
| 102 | void sysfs_remove_link(struct kobject *kobj, const char *name); |
Alan Stern | dfa87c8 | 2007-02-20 15:02:44 -0500 | [diff] [blame] | 103 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame^] | 104 | int __must_check sysfs_create_group(struct kobject *kobj, |
| 105 | const struct attribute_group *grp); |
| 106 | void sysfs_remove_group(struct kobject *kobj, |
| 107 | const struct attribute_group *grp); |
| 108 | int sysfs_add_file_to_group(struct kobject *kobj, |
| 109 | const struct attribute *attr, const char *group); |
| 110 | void sysfs_remove_file_from_group(struct kobject *kobj, |
| 111 | const struct attribute *attr, const char *group); |
| 112 | |
| 113 | void sysfs_notify(struct kobject *kobj, char *dir, char *attr); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 114 | |
Andrew Morton | f20a9ea | 2006-08-14 22:43:23 -0700 | [diff] [blame] | 115 | extern int __must_check sysfs_init(void); |
| 116 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 117 | #else /* CONFIG_SYSFS */ |
| 118 | |
Alan Stern | d9a9cdf | 2007-03-15 15:50:34 -0400 | [diff] [blame] | 119 | static inline int sysfs_schedule_callback(struct kobject *kobj, |
Alan Stern | 523ded7 | 2007-04-26 00:12:04 -0700 | [diff] [blame] | 120 | void (*func)(void *), void *data, struct module *owner) |
Alan Stern | d9a9cdf | 2007-03-15 15:50:34 -0400 | [diff] [blame] | 121 | { |
| 122 | return -ENOSYS; |
| 123 | } |
| 124 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame^] | 125 | static inline int sysfs_create_dir(struct kobject *kobj) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 126 | { |
| 127 | return 0; |
| 128 | } |
| 129 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame^] | 130 | static inline void sysfs_remove_dir(struct kobject *kobj) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 131 | { |
| 132 | ; |
| 133 | } |
| 134 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame^] | 135 | 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] | 136 | { |
| 137 | return 0; |
| 138 | } |
| 139 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame^] | 140 | static inline int sysfs_move_dir(struct kobject *kobj, |
| 141 | struct kobject *new_parent_kobj) |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 142 | { |
| 143 | return 0; |
| 144 | } |
| 145 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame^] | 146 | static inline int sysfs_create_file(struct kobject *kobj, |
| 147 | const struct attribute *attr) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 148 | { |
| 149 | return 0; |
| 150 | } |
| 151 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame^] | 152 | static inline int sysfs_update_file(struct kobject *kobj, |
| 153 | const struct attribute *attr) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 154 | { |
| 155 | return 0; |
| 156 | } |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame^] | 157 | static inline int sysfs_chmod_file(struct kobject *kobj, |
| 158 | struct attribute *attr, mode_t mode) |
Kay Sievers | 31e5abe | 2005-04-18 21:57:32 -0700 | [diff] [blame] | 159 | { |
| 160 | return 0; |
| 161 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 162 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame^] | 163 | static inline void sysfs_remove_file(struct kobject *kobj, |
| 164 | const struct attribute *attr) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 165 | { |
| 166 | ; |
| 167 | } |
| 168 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame^] | 169 | static inline int sysfs_create_bin_file(struct kobject *kobj, |
| 170 | struct bin_attribute *attr) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 171 | { |
| 172 | return 0; |
| 173 | } |
| 174 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame^] | 175 | static inline int sysfs_remove_bin_file(struct kobject *kobj, |
| 176 | struct bin_attribute *attr) |
| 177 | { |
| 178 | return 0; |
| 179 | } |
| 180 | |
| 181 | static inline int sysfs_create_link(struct kobject *kobj, |
| 182 | struct kobject *target, const char *name) |
| 183 | { |
| 184 | return 0; |
| 185 | } |
| 186 | |
| 187 | static inline void sysfs_remove_link(struct kobject *kobj, const char *name) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 188 | { |
| 189 | ; |
| 190 | } |
| 191 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame^] | 192 | static inline int sysfs_create_group(struct kobject *kobj, |
| 193 | const struct attribute_group *grp) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 194 | { |
| 195 | return 0; |
| 196 | } |
| 197 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame^] | 198 | static inline void sysfs_remove_group(struct kobject *kobj, |
| 199 | const struct attribute_group *grp) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 200 | { |
| 201 | ; |
| 202 | } |
| 203 | |
Alan Stern | dfa87c8 | 2007-02-20 15:02:44 -0500 | [diff] [blame] | 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, |
Ralf Baechle | d701d8a | 2007-03-01 12:40:21 +0000 | [diff] [blame] | 211 | const struct attribute *attr, const char *group) |
Alan Stern | dfa87c8 | 2007-02-20 15:02:44 -0500 | [diff] [blame] | 212 | { |
Alan Stern | dfa87c8 | 2007-02-20 15:02:44 -0500 | [diff] [blame] | 213 | } |
| 214 | |
Tejun Heo | 59f6901 | 2007-09-20 16:05:10 +0900 | [diff] [blame^] | 215 | static inline void sysfs_notify(struct kobject *kobj, char *dir, char *attr) |
NeilBrown | 4508a7a | 2006-03-20 17:53:53 +1100 | [diff] [blame] | 216 | { |
| 217 | } |
| 218 | |
Andrew Morton | f20a9ea | 2006-08-14 22:43:23 -0700 | [diff] [blame] | 219 | static inline int __must_check sysfs_init(void) |
| 220 | { |
| 221 | return 0; |
| 222 | } |
| 223 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 224 | #endif /* CONFIG_SYSFS */ |
| 225 | |
| 226 | #endif /* _SYSFS_H_ */ |