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