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 struct nameidata;
  21 struct dentry;
  22 struct sysfs_dirent;
  23
  24 /* FIXME
  25  * The *owner field is no longer used, but leave around
  26  * until the tree gets cleaned up fully.
  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         struct attribute        ** attrs;
  37 };
  38
  39
  40
  41 /**
  42  * Use these macros to make defining attributes easier. See include/linux/device.h
  43  * for examples..
  44  */
  45
  46 #define __ATTR(_name,_mode,_show,_store) { \
  47         .attr = {.name = __stringify(_name), .mode = _mode },   \
  48         .show   = _show,                                        \
  49         .store  = _store,                                       \
  50 }
  51
  52 #define __ATTR_RO(_name) { \
  53         .attr   = { .name = __stringify(_name), .mode = 0444 }, \
  54         .show   = _name##_show,                                 \
  55 }
  56
  57 #define __ATTR_NULL { .attr = { .name = NULL } }
  58
  59 #define attr_name(_attr) (_attr).attr.name
  60
  61 struct vm_area_struct;
  62
  63 struct bin_attribute {
  64         struct attribute        attr;
  65         size_t                  size;
  66         void                    *private;
  67         ssize_t (*read)(struct kobject *, char *, loff_t, size_t);
  68         ssize_t (*write)(struct kobject *, char *, loff_t, size_t);
  69         int (*mmap)(struct kobject *, struct bin_attribute *attr,
  70                     struct vm_area_struct *vma);
  71 };
  72
  73 struct sysfs_ops {
  74         ssize_t (*show)(struct kobject *, struct attribute *,char *);
  75         ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t);
  76 };
  77
  78 #define SYSFS_TYPE_MASK         0x00ff
  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_COPY_NAME         (SYSFS_DIR | SYSFS_KOBJ_LINK)
  85
  86 #define SYSFS_FLAG_MASK         ~SYSFS_TYPE_MASK
  87 #define SYSFS_FLAG_REMOVED      0x0100
  88
  89 #ifdef CONFIG_SYSFS
  90
  91 extern int sysfs_schedule_callback(struct kobject *kobj,
  92                 void (*func)(void *), void *data, struct module *owner);
  93
  94 extern int __must_check
  95 sysfs_create_dir(struct kobject *kobj, struct sysfs_dirent *shadow_parent_sd);
  96
  97 extern void
  98 sysfs_remove_dir(struct kobject *);
  99
 100 extern int __must_check
 101 sysfs_rename_dir(struct kobject *kobj, struct sysfs_dirent *new_parent_sd,
 102                  const char *new_name);
 103
 104 extern int __must_check
 105 sysfs_move_dir(struct kobject *, struct kobject *);
 106
 107 extern int __must_check
 108 sysfs_create_file(struct kobject *, const struct attribute *);
 109
 110 extern int __must_check
 111 sysfs_update_file(struct kobject *, const struct attribute *);
 112
 113 extern int __must_check
 114 sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode);
 115
 116 extern void
 117 sysfs_remove_file(struct kobject *, const struct attribute *);
 118
 119 extern int __must_check
 120 sysfs_create_link(struct kobject * kobj, struct kobject * target, const char * name);
 121
 122 extern void
 123 sysfs_remove_link(struct kobject *, const char * name);
 124
 125 int __must_check sysfs_create_bin_file(struct kobject *kobj,
 126                                         struct bin_attribute *attr);
 127 void sysfs_remove_bin_file(struct kobject *kobj, struct bin_attribute *attr);
 128
 129 int __must_check sysfs_create_group(struct kobject *,
 130                                         const struct attribute_group *);
 131 void sysfs_remove_group(struct kobject *, const struct attribute_group *);
 132 int sysfs_add_file_to_group(struct kobject *kobj,
 133                 const struct attribute *attr, const char *group);
 134 void sysfs_remove_file_from_group(struct kobject *kobj,
 135                 const struct attribute *attr, const char *group);
 136
 137 void sysfs_notify(struct kobject * k, char *dir, char *attr);
 138
 139
 140 extern int sysfs_make_shadowed_dir(struct kobject *kobj,
 141         void * (*follow_link)(struct dentry *, struct nameidata *));
 142 extern struct sysfs_dirent *sysfs_create_shadow_dir(struct kobject *kobj);
 143 extern void sysfs_remove_shadow_dir(struct sysfs_dirent *shadow_sd);
 144
 145 extern int __must_check sysfs_init(void);
 146
 147 #else /* CONFIG_SYSFS */
 148
 149 static inline int sysfs_schedule_callback(struct kobject *kobj,
 150                 void (*func)(void *), void *data, struct module *owner)
 151 {
 152         return -ENOSYS;
 153 }
 154
 155 static inline int sysfs_create_dir(struct kobject *kobj,
 156                                    struct sysfs_dirent *shadow_parent_sd)
 157 {
 158         return 0;
 159 }
 160
 161 static inline void sysfs_remove_dir(struct kobject * k)
 162 {
 163         ;
 164 }
 165
 166 static inline int sysfs_rename_dir(struct kobject *kobj,
 167                                    struct sysfs_dirent *new_parent_sd,
 168                                    const char *new_name)
 169 {
 170         return 0;
 171 }
 172
 173 static inline int sysfs_move_dir(struct kobject * k, struct kobject * new_parent)
 174 {
 175         return 0;
 176 }
 177
 178 static inline int sysfs_create_file(struct kobject * k, const struct attribute * a)
 179 {
 180         return 0;
 181 }
 182
 183 static inline int sysfs_update_file(struct kobject * k, const struct attribute * a)
 184 {
 185         return 0;
 186 }
 187 static inline int sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode)
 188 {
 189         return 0;
 190 }
 191
 192 static inline void sysfs_remove_file(struct kobject * k, const struct attribute * a)
 193 {
 194         ;
 195 }
 196
 197 static inline int sysfs_create_link(struct kobject * k, struct kobject * t, const char * n)
 198 {
 199         return 0;
 200 }
 201
 202 static inline void sysfs_remove_link(struct kobject * k, const char * name)
 203 {
 204         ;
 205 }
 206
 207
 208 static inline int sysfs_create_bin_file(struct kobject * k, struct bin_attribute * a)
 209 {
 210         return 0;
 211 }
 212
 213 static inline int sysfs_remove_bin_file(struct kobject * k, struct bin_attribute * a)
 214 {
 215         return 0;
 216 }
 217
 218 static inline int sysfs_create_group(struct kobject * k, const struct attribute_group *g)
 219 {
 220         return 0;
 221 }
 222
 223 static inline void sysfs_remove_group(struct kobject * k, const struct attribute_group * g)
 224 {
 225         ;
 226 }
 227
 228 static inline int sysfs_add_file_to_group(struct kobject *kobj,
 229                 const struct attribute *attr, const char *group)
 230 {
 231         return 0;
 232 }
 233
 234 static inline void sysfs_remove_file_from_group(struct kobject *kobj,
 235                 const struct attribute *attr, const char *group)
 236 {
 237 }
 238
 239 static inline void sysfs_notify(struct kobject * k, char *dir, char *attr)
 240 {
 241 }
 242
 243 static inline int sysfs_make_shadowed_dir(struct kobject *kobj,
 244         void * (*follow_link)(struct dentry *, struct nameidata *))
 245 {
 246         return 0;
 247 }
 248
 249 static inline int __must_check sysfs_init(void)
 250 {
 251         return 0;
 252 }
 253
 254 #endif /* CONFIG_SYSFS */
 255
 256 #endif /* _SYSFS_H_ */