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