SAFE public projects git trees. - safe/jmp/linux-2.6/blob - include/linux/sysfs.h

   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  * Copyright (c) 2007 SUSE Linux Products GmbH
   7  * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
   8  *
   9  * Please see Documentation/filesystems/sysfs.txt for more information.
  10  */
  11
  12 #ifndef _SYSFS_H_
  13 #define _SYSFS_H_
  14
  15 #include <linux/compiler.h>
  16 #include <linux/errno.h>
  17 #include <linux/list.h>
  18 #include <asm/atomic.h>
  19
  20 struct kobject;
  21 struct module;
  22
  23 /* FIXME
  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.
  27  */
  28 struct attribute {
  29         const char              *name;
  30         struct module           *owner;
  31         mode_t                  mode;
  32 };
  33
  34 struct attribute_group {
  35         const char              *name;
  36         mode_t                  (*is_visible)(struct kobject *,
  37                                               struct attribute *, int);
  38         struct attribute        **attrs;
  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) { \
  49         .attr = {.name = __stringify(_name), .mode = _mode },   \
  50         .show   = _show,                                        \
  51         .store  = _store,                                       \
  52 }
  53
  54 #define __ATTR_RO(_name) { \
  55         .attr   = { .name = __stringify(_name), .mode = 0444 }, \
  56         .show   = _name##_show,                                 \
  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;
  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);
  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
  82 struct sysfs_dirent;
  83
  84 #ifdef CONFIG_SYSFS
  85
  86 int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
  87                             void *data, struct module *owner);
  88
  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);
  94
  95 int __must_check sysfs_create_file(struct kobject *kobj,
  96                                    const struct attribute *attr);
  97 int __must_check sysfs_create_files(struct kobject *kobj,
  98                                    const struct attribute **attr);
  99 int __must_check sysfs_chmod_file(struct kobject *kobj, struct attribute *attr,
 100                                   mode_t mode);
 101 void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr);
 102 void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
 103
 104 int __must_check sysfs_create_bin_file(struct kobject *kobj,
 105                                        const struct bin_attribute *attr);
 106 void sysfs_remove_bin_file(struct kobject *kobj,
 107                            const struct bin_attribute *attr);
 108
 109 int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
 110                                    const char *name);
 111 int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
 112                                           struct kobject *target,
 113                                           const char *name);
 114 void sysfs_remove_link(struct kobject *kobj, const char *name);
 115
 116 int __must_check sysfs_create_group(struct kobject *kobj,
 117                                     const struct attribute_group *grp);
 118 int sysfs_update_group(struct kobject *kobj,
 119                        const struct attribute_group *grp);
 120 void sysfs_remove_group(struct kobject *kobj,
 121                         const struct attribute_group *grp);
 122 int sysfs_add_file_to_group(struct kobject *kobj,
 123                         const struct attribute *attr, const char *group);
 124 void sysfs_remove_file_from_group(struct kobject *kobj,
 125                         const struct attribute *attr, const char *group);
 126
 127 void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
 128 void sysfs_notify_dirent(struct sysfs_dirent *sd);
 129 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
 130                                       const unsigned char *name);
 131 struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd);
 132 void sysfs_put(struct sysfs_dirent *sd);
 133 void sysfs_printk_last_file(void);
 134 int __must_check sysfs_init(void);
 135
 136 #else /* CONFIG_SYSFS */
 137
 138 static inline int sysfs_schedule_callback(struct kobject *kobj,
 139                 void (*func)(void *), void *data, struct module *owner)
 140 {
 141         return -ENOSYS;
 142 }
 143
 144 static inline int sysfs_create_dir(struct kobject *kobj)
 145 {
 146         return 0;
 147 }
 148
 149 static inline void sysfs_remove_dir(struct kobject *kobj)
 150 {
 151 }
 152
 153 static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
 154 {
 155         return 0;
 156 }
 157
 158 static inline int sysfs_move_dir(struct kobject *kobj,
 159                                  struct kobject *new_parent_kobj)
 160 {
 161         return 0;
 162 }
 163
 164 static inline int sysfs_create_file(struct kobject *kobj,
 165                                     const struct attribute *attr)
 166 {
 167         return 0;
 168 }
 169
 170 static inline int sysfs_create_files(struct kobject *kobj,
 171                                     const struct attribute **attr)
 172 {
 173         return 0;
 174 }
 175
 176 static inline int sysfs_chmod_file(struct kobject *kobj,
 177                                    struct attribute *attr, mode_t mode)
 178 {
 179         return 0;
 180 }
 181
 182 static inline void sysfs_remove_file(struct kobject *kobj,
 183                                      const struct attribute *attr)
 184 {
 185 }
 186
 187 static inline void sysfs_remove_files(struct kobject *kobj,
 188                                      const struct attribute **attr)
 189 {
 190 }
 191
 192 static inline int sysfs_create_bin_file(struct kobject *kobj,
 193                                         const struct bin_attribute *attr)
 194 {
 195         return 0;
 196 }
 197
 198 static inline void sysfs_remove_bin_file(struct kobject *kobj,
 199                                          const struct bin_attribute *attr)
 200 {
 201 }
 202
 203 static inline int sysfs_create_link(struct kobject *kobj,
 204                                     struct kobject *target, const char *name)
 205 {
 206         return 0;
 207 }
 208
 209 static inline int sysfs_create_link_nowarn(struct kobject *kobj,
 210                                            struct kobject *target,
 211                                            const char *name)
 212 {
 213         return 0;
 214 }
 215
 216 static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
 217 {
 218 }
 219
 220 static inline int sysfs_create_group(struct kobject *kobj,
 221                                      const struct attribute_group *grp)
 222 {
 223         return 0;
 224 }
 225
 226 static inline int sysfs_update_group(struct kobject *kobj,
 227                                 const struct attribute_group *grp)
 228 {
 229         return 0;
 230 }
 231
 232 static inline void sysfs_remove_group(struct kobject *kobj,
 233                                       const struct attribute_group *grp)
 234 {
 235 }
 236
 237 static inline int sysfs_add_file_to_group(struct kobject *kobj,
 238                 const struct attribute *attr, const char *group)
 239 {
 240         return 0;
 241 }
 242
 243 static inline void sysfs_remove_file_from_group(struct kobject *kobj,
 244                 const struct attribute *attr, const char *group)
 245 {
 246 }
 247
 248 static inline void sysfs_notify(struct kobject *kobj, const char *dir,
 249                                 const char *attr)
 250 {
 251 }
 252 static inline void sysfs_notify_dirent(struct sysfs_dirent *sd)
 253 {
 254 }
 255 static inline
 256 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
 257                                       const unsigned char *name)
 258 {
 259         return NULL;
 260 }
 261 static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
 262 {
 263         return NULL;
 264 }
 265 static inline void sysfs_put(struct sysfs_dirent *sd)
 266 {
 267 }
 268
 269 static inline int __must_check sysfs_init(void)
 270 {
 271         return 0;
 272 }
 273
 274 static inline void sysfs_printk_last_file(void)
 275 {
 276 }
 277
 278 #endif /* CONFIG_SYSFS */
 279
 280 #endif /* _SYSFS_H_ */