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
  88 #ifdef CONFIG_SYSFS
  89
  90 extern int sysfs_schedule_callback(struct kobject *kobj,
  91                 void (*func)(void *), void *data, struct module *owner);
  92
  93 extern int __must_check
  94 sysfs_create_dir(struct kobject *, struct dentry *);
  95
  96 extern void
  97 sysfs_remove_dir(struct kobject *);
  98
  99 extern int __must_check
 100 sysfs_rename_dir(struct kobject *, struct dentry *, const char *new_name);
 101
 102 extern int __must_check
 103 sysfs_move_dir(struct kobject *, struct kobject *);
 104
 105 extern int __must_check
 106 sysfs_create_file(struct kobject *, const struct attribute *);
 107
 108 extern int __must_check
 109 sysfs_update_file(struct kobject *, const struct attribute *);
 110
 111 extern int __must_check
 112 sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode);
 113
 114 extern void
 115 sysfs_remove_file(struct kobject *, const struct attribute *);
 116
 117 extern int __must_check
 118 sysfs_create_link(struct kobject * kobj, struct kobject * target, const char * name);
 119
 120 extern void
 121 sysfs_remove_link(struct kobject *, const char * name);
 122
 123 int __must_check sysfs_create_bin_file(struct kobject *kobj,
 124                                         struct bin_attribute *attr);
 125 void sysfs_remove_bin_file(struct kobject *kobj, struct bin_attribute *attr);
 126
 127 int __must_check sysfs_create_group(struct kobject *,
 128                                         const struct attribute_group *);
 129 void sysfs_remove_group(struct kobject *, const struct attribute_group *);
 130 int sysfs_add_file_to_group(struct kobject *kobj,
 131                 const struct attribute *attr, const char *group);
 132 void sysfs_remove_file_from_group(struct kobject *kobj,
 133                 const struct attribute *attr, const char *group);
 134
 135 void sysfs_notify(struct kobject * k, char *dir, char *attr);
 136
 137
 138 extern int sysfs_make_shadowed_dir(struct kobject *kobj,
 139         void * (*follow_link)(struct dentry *, struct nameidata *));
 140 extern struct dentry *sysfs_create_shadow_dir(struct kobject *kobj);
 141 extern void sysfs_remove_shadow_dir(struct dentry *dir);
 142
 143 extern int __must_check sysfs_init(void);
 144
 145 #else /* CONFIG_SYSFS */
 146
 147 static inline int sysfs_schedule_callback(struct kobject *kobj,
 148                 void (*func)(void *), void *data, struct module *owner)
 149 {
 150         return -ENOSYS;
 151 }
 152
 153 static inline int sysfs_create_dir(struct kobject * k, struct dentry *shadow)
 154 {
 155         return 0;
 156 }
 157
 158 static inline void sysfs_remove_dir(struct kobject * k)
 159 {
 160         ;
 161 }
 162
 163 static inline int sysfs_rename_dir(struct kobject * k,
 164                                         struct dentry *new_parent,
 165                                         const char *new_name)
 166 {
 167         return 0;
 168 }
 169
 170 static inline int sysfs_move_dir(struct kobject * k, struct kobject * new_parent)
 171 {
 172         return 0;
 173 }
 174
 175 static inline int sysfs_create_file(struct kobject * k, const struct attribute * a)
 176 {
 177         return 0;
 178 }
 179
 180 static inline int sysfs_update_file(struct kobject * k, const struct attribute * a)
 181 {
 182         return 0;
 183 }
 184 static inline int sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode)
 185 {
 186         return 0;
 187 }
 188
 189 static inline void sysfs_remove_file(struct kobject * k, const struct attribute * a)
 190 {
 191         ;
 192 }
 193
 194 static inline int sysfs_create_link(struct kobject * k, struct kobject * t, const char * n)
 195 {
 196         return 0;
 197 }
 198
 199 static inline void sysfs_remove_link(struct kobject * k, const char * name)
 200 {
 201         ;
 202 }
 203
 204
 205 static inline int sysfs_create_bin_file(struct kobject * k, struct bin_attribute * a)
 206 {
 207         return 0;
 208 }
 209
 210 static inline int sysfs_remove_bin_file(struct kobject * k, struct bin_attribute * a)
 211 {
 212         return 0;
 213 }
 214
 215 static inline int sysfs_create_group(struct kobject * k, const struct attribute_group *g)
 216 {
 217         return 0;
 218 }
 219
 220 static inline void sysfs_remove_group(struct kobject * k, const struct attribute_group * g)
 221 {
 222         ;
 223 }
 224
 225 static inline int sysfs_add_file_to_group(struct kobject *kobj,
 226                 const struct attribute *attr, const char *group)
 227 {
 228         return 0;
 229 }
 230
 231 static inline void sysfs_remove_file_from_group(struct kobject *kobj,
 232                 const struct attribute *attr, const char *group)
 233 {
 234 }
 235
 236 static inline void sysfs_notify(struct kobject * k, char *dir, char *attr)
 237 {
 238 }
 239
 240 static inline int sysfs_make_shadowed_dir(struct kobject *kobj,
 241         void * (*follow_link)(struct dentry *, struct nameidata *))
 242 {
 243         return 0;
 244 }
 245
 246 static inline int __must_check sysfs_init(void)
 247 {
 248         return 0;
 249 }
 250
 251 #endif /* CONFIG_SYSFS */
 252
 253 #endif /* _SYSFS_H_ */