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
  21 /* FIXME
  22  * The *owner field is no longer used, but leave around
  23  * until the tree gets cleaned up fully.
  24  */
  25 struct attribute {
  26         const char              * name;
  27         struct module           * owner;
  28         mode_t                  mode;
  29 };
  30
  31 struct attribute_group {
  32         const char              * name;
  33         struct attribute        ** attrs;
  34 };
  35
  36
  37
  38 /**
  39  * Use these macros to make defining attributes easier. See include/linux/device.h
  40  * for examples..
  41  */
  42
  43 #define __ATTR(_name,_mode,_show,_store) { \
  44         .attr = {.name = __stringify(_name), .mode = _mode },   \
  45         .show   = _show,                                        \
  46         .store  = _store,                                       \
  47 }
  48
  49 #define __ATTR_RO(_name) { \
  50         .attr   = { .name = __stringify(_name), .mode = 0444 }, \
  51         .show   = _name##_show,                                 \
  52 }
  53
  54 #define __ATTR_NULL { .attr = { .name = NULL } }
  55
  56 #define attr_name(_attr) (_attr).attr.name
  57
  58 struct vm_area_struct;
  59
  60 struct bin_attribute {
  61         struct attribute        attr;
  62         size_t                  size;
  63         void                    *private;
  64         ssize_t (*read)(struct kobject *, struct bin_attribute *,
  65                         char *, loff_t, size_t);
  66         ssize_t (*write)(struct kobject *, struct bin_attribute *,
  67                          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_COPY_NAME         (SYSFS_DIR | SYSFS_KOBJ_LINK)
  84
  85 #define SYSFS_FLAG_MASK         ~SYSFS_TYPE_MASK
  86 #define SYSFS_FLAG_REMOVED      0x0100
  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 *);
  95
  96 extern void
  97 sysfs_remove_dir(struct kobject *);
  98
  99 extern int __must_check
 100 sysfs_rename_dir(struct kobject *kobj, 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 extern int __must_check sysfs_init(void);
 138
 139 #else /* CONFIG_SYSFS */
 140
 141 static inline int sysfs_schedule_callback(struct kobject *kobj,
 142                 void (*func)(void *), void *data, struct module *owner)
 143 {
 144         return -ENOSYS;
 145 }
 146
 147 static inline int sysfs_create_dir(struct kobject * kobj)
 148 {
 149         return 0;
 150 }
 151
 152 static inline void sysfs_remove_dir(struct kobject * k)
 153 {
 154         ;
 155 }
 156
 157 static inline int sysfs_rename_dir(struct kobject * kobj, const char *new_name)
 158 {
 159         return 0;
 160 }
 161
 162 static inline int sysfs_move_dir(struct kobject * k, struct kobject * new_parent)
 163 {
 164         return 0;
 165 }
 166
 167 static inline int sysfs_create_file(struct kobject * k, const struct attribute * a)
 168 {
 169         return 0;
 170 }
 171
 172 static inline int sysfs_update_file(struct kobject * k, const struct attribute * a)
 173 {
 174         return 0;
 175 }
 176 static inline int sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode)
 177 {
 178         return 0;
 179 }
 180
 181 static inline void sysfs_remove_file(struct kobject * k, const struct attribute * a)
 182 {
 183         ;
 184 }
 185
 186 static inline int sysfs_create_link(struct kobject * k, struct kobject * t, const char * n)
 187 {
 188         return 0;
 189 }
 190
 191 static inline void sysfs_remove_link(struct kobject * k, const char * name)
 192 {
 193         ;
 194 }
 195
 196
 197 static inline int sysfs_create_bin_file(struct kobject * k, struct bin_attribute * a)
 198 {
 199         return 0;
 200 }
 201
 202 static inline int sysfs_remove_bin_file(struct kobject * k, struct bin_attribute * a)
 203 {
 204         return 0;
 205 }
 206
 207 static inline int sysfs_create_group(struct kobject * k, const struct attribute_group *g)
 208 {
 209         return 0;
 210 }
 211
 212 static inline void sysfs_remove_group(struct kobject * k, const struct attribute_group * g)
 213 {
 214         ;
 215 }
 216
 217 static inline int sysfs_add_file_to_group(struct kobject *kobj,
 218                 const struct attribute *attr, const char *group)
 219 {
 220         return 0;
 221 }
 222
 223 static inline void sysfs_remove_file_from_group(struct kobject *kobj,
 224                 const struct attribute *attr, const char *group)
 225 {
 226 }
 227
 228 static inline void sysfs_notify(struct kobject * k, char *dir, char *attr)
 229 {
 230 }
 231
 232 static inline int __must_check sysfs_init(void)
 233 {
 234         return 0;
 235 }
 236
 237 #endif /* CONFIG_SYSFS */
 238
 239 #endif /* _SYSFS_H_ */