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