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  * Copyright (c) 2007 SUSE Linux Products GmbH
   7  * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
   8  *
   9  * Please see Documentation/filesystems/sysfs.txt for more information.
  10  */
  11
  12 #ifndef _SYSFS_H_
  13 #define _SYSFS_H_
  14
  15 #include <linux/compiler.h>
  16 #include <linux/errno.h>
  17 #include <linux/list.h>
  18 #include <asm/atomic.h>
  19
  20 struct kobject;
  21 struct module;
  22
  23 /* FIXME
  24  * The *owner field is no longer used, but leave around
  25  * until the tree gets cleaned up fully.
  26  */
  27 struct attribute {
  28         const char              *name;
  29         struct module           *owner;
  30         mode_t                  mode;
  31 };
  32
  33 struct attribute_group {
  34         const char              *name;
  35         mode_t                  (*is_visible)(struct kobject *,
  36                                               struct attribute *, int);
  37         struct attribute        **attrs;
  38 };
  39
  40
  41
  42 /**
  43  * Use these macros to make defining attributes easier. See include/linux/device.h
  44  * for examples..
  45  */
  46
  47 #define __ATTR(_name,_mode,_show,_store) { \
  48         .attr = {.name = __stringify(_name), .mode = _mode },   \
  49         .show   = _show,                                        \
  50         .store  = _store,                                       \
  51 }
  52
  53 #define __ATTR_RO(_name) { \
  54         .attr   = { .name = __stringify(_name), .mode = 0444 }, \
  55         .show   = _name##_show,                                 \
  56 }
  57
  58 #define __ATTR_NULL { .attr = { .name = NULL } }
  59
  60 #define attr_name(_attr) (_attr).attr.name
  61
  62 struct vm_area_struct;
  63
  64 struct bin_attribute {
  65         struct attribute        attr;
  66         size_t                  size;
  67         void                    *private;
  68         ssize_t (*read)(struct kobject *, struct bin_attribute *,
  69                         char *, loff_t, size_t);
  70         ssize_t (*write)(struct kobject *, struct bin_attribute *,
  71                          char *, loff_t, size_t);
  72         int (*mmap)(struct kobject *, struct bin_attribute *attr,
  73                     struct vm_area_struct *vma);
  74 };
  75
  76 struct sysfs_ops {
  77         ssize_t (*show)(struct kobject *, struct attribute *,char *);
  78         ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t);
  79 };
  80
  81 struct sysfs_dirent;
  82
  83 #ifdef CONFIG_SYSFS
  84
  85 int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
  86                             void *data, struct module *owner);
  87
  88 int __must_check sysfs_create_dir(struct kobject *kobj);
  89 void sysfs_remove_dir(struct kobject *kobj);
  90 int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name);
  91 int __must_check sysfs_move_dir(struct kobject *kobj,
  92                                 struct kobject *new_parent_kobj);
  93
  94 int __must_check sysfs_create_file(struct kobject *kobj,
  95                                    const struct attribute *attr);
  96 int __must_check sysfs_chmod_file(struct kobject *kobj, struct attribute *attr,
  97                                   mode_t mode);
  98 void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr);
  99
 100 int __must_check sysfs_create_bin_file(struct kobject *kobj,
 101                                        struct bin_attribute *attr);
 102 void sysfs_remove_bin_file(struct kobject *kobj, struct bin_attribute *attr);
 103
 104 int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
 105                                    const char *name);
 106 int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
 107                                           struct kobject *target,
 108                                           const char *name);
 109 void sysfs_remove_link(struct kobject *kobj, const char *name);
 110
 111 int __must_check sysfs_create_group(struct kobject *kobj,
 112                                     const struct attribute_group *grp);
 113 int sysfs_update_group(struct kobject *kobj,
 114                        const struct attribute_group *grp);
 115 void sysfs_remove_group(struct kobject *kobj,
 116                         const struct attribute_group *grp);
 117 int sysfs_add_file_to_group(struct kobject *kobj,
 118                         const struct attribute *attr, const char *group);
 119 void sysfs_remove_file_from_group(struct kobject *kobj,
 120                         const struct attribute *attr, const char *group);
 121
 122 void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
 123 void sysfs_notify_dirent(struct sysfs_dirent *sd);
 124 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
 125                                       const unsigned char *name);
 126 struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd);
 127 void sysfs_put(struct sysfs_dirent *sd);
 128 void sysfs_printk_last_file(void);
 129 int __must_check sysfs_init(void);
 130
 131 #else /* CONFIG_SYSFS */
 132
 133 static inline int sysfs_schedule_callback(struct kobject *kobj,
 134                 void (*func)(void *), void *data, struct module *owner)
 135 {
 136         return -ENOSYS;
 137 }
 138
 139 static inline int sysfs_create_dir(struct kobject *kobj)
 140 {
 141         return 0;
 142 }
 143
 144 static inline void sysfs_remove_dir(struct kobject *kobj)
 145 {
 146 }
 147
 148 static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
 149 {
 150         return 0;
 151 }
 152
 153 static inline int sysfs_move_dir(struct kobject *kobj,
 154                                  struct kobject *new_parent_kobj)
 155 {
 156         return 0;
 157 }
 158
 159 static inline int sysfs_create_file(struct kobject *kobj,
 160                                     const struct attribute *attr)
 161 {
 162         return 0;
 163 }
 164
 165 static inline int sysfs_chmod_file(struct kobject *kobj,
 166                                    struct attribute *attr, mode_t mode)
 167 {
 168         return 0;
 169 }
 170
 171 static inline void sysfs_remove_file(struct kobject *kobj,
 172                                      const struct attribute *attr)
 173 {
 174 }
 175
 176 static inline int sysfs_create_bin_file(struct kobject *kobj,
 177                                         struct bin_attribute *attr)
 178 {
 179         return 0;
 180 }
 181
 182 static inline void sysfs_remove_bin_file(struct kobject *kobj,
 183                                          struct bin_attribute *attr)
 184 {
 185 }
 186
 187 static inline int sysfs_create_link(struct kobject *kobj,
 188                                     struct kobject *target, const char *name)
 189 {
 190         return 0;
 191 }
 192
 193 static inline int sysfs_create_link_nowarn(struct kobject *kobj,
 194                                            struct kobject *target,
 195                                            const char *name)
 196 {
 197         return 0;
 198 }
 199
 200 static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
 201 {
 202 }
 203
 204 static inline int sysfs_create_group(struct kobject *kobj,
 205                                      const struct attribute_group *grp)
 206 {
 207         return 0;
 208 }
 209
 210 static inline int sysfs_update_group(struct kobject *kobj,
 211                                 const struct attribute_group *grp)
 212 {
 213         return 0;
 214 }
 215
 216 static inline void sysfs_remove_group(struct kobject *kobj,
 217                                       const struct attribute_group *grp)
 218 {
 219 }
 220
 221 static inline int sysfs_add_file_to_group(struct kobject *kobj,
 222                 const struct attribute *attr, const char *group)
 223 {
 224         return 0;
 225 }
 226
 227 static inline void sysfs_remove_file_from_group(struct kobject *kobj,
 228                 const struct attribute *attr, const char *group)
 229 {
 230 }
 231
 232 static inline void sysfs_notify(struct kobject *kobj, const char *dir,
 233                                 const char *attr)
 234 {
 235 }
 236 static inline void sysfs_notify_dirent(struct sysfs_dirent *sd)
 237 {
 238 }
 239 static inline
 240 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
 241                                       const unsigned char *name)
 242 {
 243         return NULL;
 244 }
 245 static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
 246 {
 247         return NULL;
 248 }
 249 static inline void sysfs_put(struct sysfs_dirent *sd)
 250 {
 251 }
 252
 253 static inline int __must_check sysfs_init(void)
 254 {
 255         return 0;
 256 }
 257
 258 static inline void sysfs_printk_last_file(void)
 259 {
 260 }
 261
 262 #endif /* CONFIG_SYSFS */
 263
 264 #endif /* _SYSFS_H_ */