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  *
   7  * Please see Documentation/filesystems/sysfs.txt for more information.
   8  */
   9
  10 #ifndef _SYSFS_H_
  11 #define _SYSFS_H_
  12
  13 #include <linux/compiler.h>
  14 #include <linux/errno.h>
  15 #include <linux/list.h>
  16 #include <asm/atomic.h>
  17
  18 struct kobject;
  19 struct module;
  20
  21 /* FIXME
  22  * The *owner field is no longer used, but leave around
  23  * until the tree gets cleaned up fully.
  24  */
  25 struct attribute {
  26         const char              *name;
  27         struct module           *owner;
  28         mode_t                  mode;
  29 };
  30
  31 struct attribute_group {
  32         const char              *name;
  33         struct attribute        **attrs;
  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) { \
  44         .attr = {.name = __stringify(_name), .mode = _mode },   \
  45         .show   = _show,                                        \
  46         .store  = _store,                                       \
  47 }
  48
  49 #define __ATTR_RO(_name) { \
  50         .attr   = { .name = __stringify(_name), .mode = 0444 }, \
  51         .show   = _name##_show,                                 \
  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;
  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);
  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
  77 #ifdef CONFIG_SYSFS
  78
  79 int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
  80                             void *data, struct module *owner);
  81
  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);
  87
  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);
  95
  96 int __must_check sysfs_create_bin_file(struct kobject *kobj,
  97                                        struct bin_attribute *attr);
  98 void sysfs_remove_bin_file(struct kobject *kobj, struct bin_attribute *attr);
  99
 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);
 103
 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);
 114
 115 extern int __must_check sysfs_init(void);
 116
 117 #else /* CONFIG_SYSFS */
 118
 119 static inline int sysfs_schedule_callback(struct kobject *kobj,
 120                 void (*func)(void *), void *data, struct module *owner)
 121 {
 122         return -ENOSYS;
 123 }
 124
 125 static inline int sysfs_create_dir(struct kobject *kobj)
 126 {
 127         return 0;
 128 }
 129
 130 static inline void sysfs_remove_dir(struct kobject *kobj)
 131 {
 132         ;
 133 }
 134
 135 static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
 136 {
 137         return 0;
 138 }
 139
 140 static inline int sysfs_move_dir(struct kobject *kobj,
 141                                  struct kobject *new_parent_kobj)
 142 {
 143         return 0;
 144 }
 145
 146 static inline int sysfs_create_file(struct kobject *kobj,
 147                                     const struct attribute *attr)
 148 {
 149         return 0;
 150 }
 151
 152 static inline int sysfs_update_file(struct kobject *kobj,
 153                                     const struct attribute *attr)
 154 {
 155         return 0;
 156 }
 157 static inline int sysfs_chmod_file(struct kobject *kobj,
 158                                    struct attribute *attr, mode_t mode)
 159 {
 160         return 0;
 161 }
 162
 163 static inline void sysfs_remove_file(struct kobject *kobj,
 164                                      const struct attribute *attr)
 165 {
 166         ;
 167 }
 168
 169 static inline int sysfs_create_bin_file(struct kobject *kobj,
 170                                         struct bin_attribute *attr)
 171 {
 172         return 0;
 173 }
 174
 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)
 188 {
 189         ;
 190 }
 191
 192 static inline int sysfs_create_group(struct kobject *kobj,
 193                                      const struct attribute_group *grp)
 194 {
 195         return 0;
 196 }
 197
 198 static inline void sysfs_remove_group(struct kobject *kobj,
 199                                       const struct attribute_group *grp)
 200 {
 201         ;
 202 }
 203
 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,
 211                 const struct attribute *attr, const char *group)
 212 {
 213 }
 214
 215 static inline void sysfs_notify(struct kobject *kobj, char *dir, char *attr)
 216 {
 217 }
 218
 219 static inline int __must_check sysfs_init(void)
 220 {
 221         return 0;
 222 }
 223
 224 #endif /* CONFIG_SYSFS */
 225
 226 #endif /* _SYSFS_H_ */