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
  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 #ifdef CONFIG_SYSFS
  78
  79 int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
  80                             void *data, struct module *owner);
  81
  82 int __must_check sysfs_create_dir(struct kobject *kobj);
  83 void sysfs_remove_dir(struct kobject *kobj);
  84 int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name);
  85 int __must_check sysfs_move_dir(struct kobject *kobj,
  86                                 struct kobject *new_parent_kobj);
  87
  88 int __must_check sysfs_create_file(struct kobject *kobj,
  89                                    const struct attribute *attr);
  90 int __must_check sysfs_chmod_file(struct kobject *kobj, struct attribute *attr,
  91                                   mode_t mode);
  92 void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr);
  93
  94 int __must_check sysfs_create_bin_file(struct kobject *kobj,
  95                                        struct bin_attribute *attr);
  96 void sysfs_remove_bin_file(struct kobject *kobj, struct bin_attribute *attr);
  97
  98 int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
  99                                    const char *name);
 100 void sysfs_remove_link(struct kobject *kobj, const char *name);
 101
 102 int __must_check sysfs_create_group(struct kobject *kobj,
 103                                     const struct attribute_group *grp);
 104 void sysfs_remove_group(struct kobject *kobj,
 105                         const struct attribute_group *grp);
 106 int sysfs_add_file_to_group(struct kobject *kobj,
 107                         const struct attribute *attr, const char *group);
 108 void sysfs_remove_file_from_group(struct kobject *kobj,
 109                         const struct attribute *attr, const char *group);
 110
 111 void sysfs_notify(struct kobject *kobj, char *dir, char *attr);
 112
 113 extern int __must_check sysfs_init(void);
 114
 115 #else /* CONFIG_SYSFS */
 116
 117 static inline int sysfs_schedule_callback(struct kobject *kobj,
 118                 void (*func)(void *), void *data, struct module *owner)
 119 {
 120         return -ENOSYS;
 121 }
 122
 123 static inline int sysfs_create_dir(struct kobject *kobj)
 124 {
 125         return 0;
 126 }
 127
 128 static inline void sysfs_remove_dir(struct kobject *kobj)
 129 {
 130         ;
 131 }
 132
 133 static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
 134 {
 135         return 0;
 136 }
 137
 138 static inline int sysfs_move_dir(struct kobject *kobj,
 139                                  struct kobject *new_parent_kobj)
 140 {
 141         return 0;
 142 }
 143
 144 static inline int sysfs_create_file(struct kobject *kobj,
 145                                     const struct attribute *attr)
 146 {
 147         return 0;
 148 }
 149
 150 static inline int sysfs_chmod_file(struct kobject *kobj,
 151                                    struct attribute *attr, mode_t mode)
 152 {
 153         return 0;
 154 }
 155
 156 static inline void sysfs_remove_file(struct kobject *kobj,
 157                                      const struct attribute *attr)
 158 {
 159         ;
 160 }
 161
 162 static inline int sysfs_create_bin_file(struct kobject *kobj,
 163                                         struct bin_attribute *attr)
 164 {
 165         return 0;
 166 }
 167
 168 static inline int sysfs_remove_bin_file(struct kobject *kobj,
 169                                         struct bin_attribute *attr)
 170 {
 171         return 0;
 172 }
 173
 174 static inline int sysfs_create_link(struct kobject *kobj,
 175                                     struct kobject *target, const char *name)
 176 {
 177         return 0;
 178 }
 179
 180 static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
 181 {
 182         ;
 183 }
 184
 185 static inline int sysfs_create_group(struct kobject *kobj,
 186                                      const struct attribute_group *grp)
 187 {
 188         return 0;
 189 }
 190
 191 static inline void sysfs_remove_group(struct kobject *kobj,
 192                                       const struct attribute_group *grp)
 193 {
 194         ;
 195 }
 196
 197 static inline int sysfs_add_file_to_group(struct kobject *kobj,
 198                 const struct attribute *attr, const char *group)
 199 {
 200         return 0;
 201 }
 202
 203 static inline void sysfs_remove_file_from_group(struct kobject *kobj,
 204                 const struct attribute *attr, const char *group)
 205 {
 206 }
 207
 208 static inline void sysfs_notify(struct kobject *kobj, char *dir, char *attr)
 209 {
 210 }
 211
 212 static inline int __must_check sysfs_init(void)
 213 {
 214         return 0;
 215 }
 216
 217 #endif /* CONFIG_SYSFS */
 218
 219 #endif /* _SYSFS_H_ */