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