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 | |
| 13 | #include <asm/atomic.h> |
| 14 | |
| 15 | struct kobject; |
| 16 | struct module; |
| 17 | |
| 18 | struct attribute { |
Dmitry Torokhov | d48593b | 2005-04-29 00:58:46 -0500 | [diff] [blame] | 19 | const char * name; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 20 | struct module * owner; |
| 21 | mode_t mode; |
| 22 | }; |
| 23 | |
| 24 | struct attribute_group { |
Dmitry Torokhov | d48593b | 2005-04-29 00:58:46 -0500 | [diff] [blame] | 25 | const char * name; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 26 | struct attribute ** attrs; |
| 27 | }; |
| 28 | |
| 29 | |
| 30 | |
| 31 | /** |
| 32 | * Use these macros to make defining attributes easier. See include/linux/device.h |
| 33 | * for examples.. |
| 34 | */ |
| 35 | |
| 36 | #define __ATTR(_name,_mode,_show,_store) { \ |
| 37 | .attr = {.name = __stringify(_name), .mode = _mode, .owner = THIS_MODULE }, \ |
| 38 | .show = _show, \ |
| 39 | .store = _store, \ |
| 40 | } |
| 41 | |
| 42 | #define __ATTR_RO(_name) { \ |
| 43 | .attr = { .name = __stringify(_name), .mode = 0444, .owner = THIS_MODULE }, \ |
| 44 | .show = _name##_show, \ |
| 45 | } |
| 46 | |
| 47 | #define __ATTR_NULL { .attr = { .name = NULL } } |
| 48 | |
| 49 | #define attr_name(_attr) (_attr).attr.name |
| 50 | |
| 51 | struct vm_area_struct; |
| 52 | |
| 53 | struct bin_attribute { |
| 54 | struct attribute attr; |
| 55 | size_t size; |
| 56 | void *private; |
| 57 | ssize_t (*read)(struct kobject *, char *, loff_t, size_t); |
| 58 | ssize_t (*write)(struct kobject *, char *, loff_t, size_t); |
| 59 | int (*mmap)(struct kobject *, struct bin_attribute *attr, |
| 60 | struct vm_area_struct *vma); |
| 61 | }; |
| 62 | |
| 63 | struct sysfs_ops { |
| 64 | ssize_t (*show)(struct kobject *, struct attribute *,char *); |
| 65 | ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t); |
| 66 | }; |
| 67 | |
| 68 | struct sysfs_dirent { |
| 69 | atomic_t s_count; |
| 70 | struct list_head s_sibling; |
| 71 | struct list_head s_children; |
| 72 | void * s_element; |
| 73 | int s_type; |
| 74 | umode_t s_mode; |
| 75 | struct dentry * s_dentry; |
Maneesh Soni | 988d186 | 2005-05-31 10:39:14 +0530 | [diff] [blame] | 76 | struct iattr * s_iattr; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 77 | }; |
| 78 | |
| 79 | #define SYSFS_ROOT 0x0001 |
| 80 | #define SYSFS_DIR 0x0002 |
| 81 | #define SYSFS_KOBJ_ATTR 0x0004 |
| 82 | #define SYSFS_KOBJ_BIN_ATTR 0x0008 |
| 83 | #define SYSFS_KOBJ_LINK 0x0020 |
| 84 | #define SYSFS_NOT_PINNED (SYSFS_KOBJ_ATTR | SYSFS_KOBJ_BIN_ATTR | SYSFS_KOBJ_LINK) |
| 85 | |
| 86 | #ifdef CONFIG_SYSFS |
| 87 | |
| 88 | extern int |
| 89 | sysfs_create_dir(struct kobject *); |
| 90 | |
| 91 | extern void |
| 92 | sysfs_remove_dir(struct kobject *); |
| 93 | |
| 94 | extern int |
| 95 | sysfs_rename_dir(struct kobject *, const char *new_name); |
| 96 | |
| 97 | extern int |
| 98 | sysfs_create_file(struct kobject *, const struct attribute *); |
| 99 | |
| 100 | extern int |
| 101 | sysfs_update_file(struct kobject *, const struct attribute *); |
| 102 | |
Kay Sievers | 31e5abe | 2005-04-18 21:57:32 -0700 | [diff] [blame] | 103 | extern int |
| 104 | sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode); |
| 105 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 106 | extern void |
| 107 | sysfs_remove_file(struct kobject *, const struct attribute *); |
| 108 | |
Dmitry Torokhov | e3a15db | 2005-04-26 02:31:08 -0500 | [diff] [blame] | 109 | extern int |
| 110 | sysfs_create_link(struct kobject * kobj, struct kobject * target, const char * name); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 111 | |
| 112 | extern void |
Dmitry Torokhov | e3a15db | 2005-04-26 02:31:08 -0500 | [diff] [blame] | 113 | sysfs_remove_link(struct kobject *, const char * name); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 114 | |
| 115 | int sysfs_create_bin_file(struct kobject * kobj, struct bin_attribute * attr); |
| 116 | int sysfs_remove_bin_file(struct kobject * kobj, struct bin_attribute * attr); |
| 117 | |
| 118 | int sysfs_create_group(struct kobject *, const struct attribute_group *); |
| 119 | void sysfs_remove_group(struct kobject *, const struct attribute_group *); |
| 120 | |
| 121 | #else /* CONFIG_SYSFS */ |
| 122 | |
| 123 | static inline int sysfs_create_dir(struct kobject * k) |
| 124 | { |
| 125 | return 0; |
| 126 | } |
| 127 | |
| 128 | static inline void sysfs_remove_dir(struct kobject * k) |
| 129 | { |
| 130 | ; |
| 131 | } |
| 132 | |
| 133 | static inline int sysfs_rename_dir(struct kobject * k, const char *new_name) |
| 134 | { |
| 135 | return 0; |
| 136 | } |
| 137 | |
| 138 | static inline int sysfs_create_file(struct kobject * k, const struct attribute * a) |
| 139 | { |
| 140 | return 0; |
| 141 | } |
| 142 | |
| 143 | static inline int sysfs_update_file(struct kobject * k, const struct attribute * a) |
| 144 | { |
| 145 | return 0; |
| 146 | } |
Kay Sievers | 31e5abe | 2005-04-18 21:57:32 -0700 | [diff] [blame] | 147 | static inline int sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode) |
| 148 | { |
| 149 | return 0; |
| 150 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 151 | |
| 152 | static inline void sysfs_remove_file(struct kobject * k, const struct attribute * a) |
| 153 | { |
| 154 | ; |
| 155 | } |
| 156 | |
Dmitry Torokhov | e3a15db | 2005-04-26 02:31:08 -0500 | [diff] [blame] | 157 | static inline int sysfs_create_link(struct kobject * k, struct kobject * t, const char * n) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 158 | { |
| 159 | return 0; |
| 160 | } |
| 161 | |
Dmitry Torokhov | e3a15db | 2005-04-26 02:31:08 -0500 | [diff] [blame] | 162 | static inline void sysfs_remove_link(struct kobject * k, const char * name) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 163 | { |
| 164 | ; |
| 165 | } |
| 166 | |
| 167 | |
| 168 | static inline int sysfs_create_bin_file(struct kobject * k, struct bin_attribute * a) |
| 169 | { |
| 170 | return 0; |
| 171 | } |
| 172 | |
| 173 | static inline int sysfs_remove_bin_file(struct kobject * k, struct bin_attribute * a) |
| 174 | { |
| 175 | return 0; |
| 176 | } |
| 177 | |
| 178 | static inline int sysfs_create_group(struct kobject * k, const struct attribute_group *g) |
| 179 | { |
| 180 | return 0; |
| 181 | } |
| 182 | |
| 183 | static inline void sysfs_remove_group(struct kobject * k, const struct attribute_group * g) |
| 184 | { |
| 185 | ; |
| 186 | } |
| 187 | |
| 188 | #endif /* CONFIG_SYSFS */ |
| 189 | |
| 190 | #endif /* _SYSFS_H_ */ |