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