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 <linux/lockdep.h>
  19 #include <asm/atomic.h>
  20
  21 struct kobject;
  22 struct module;
  23 enum kobj_ns_type;
  24
  25 /* FIXME
  26  * The *owner field is no longer used.
  27  * x86 tree has been cleaned up. The owner
  28  * attribute is still left for other arches.
  29  */
  30 struct attribute {
  31         const char              *name;
  32         struct module           *owner;
  33         mode_t                  mode;
  34 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  35         struct lock_class_key   *key;
  36         struct lock_class_key   skey;
  37 #endif
  38 };
  39
  40 /**
  41  *      sysfs_attr_init - initialize a dynamically allocated sysfs attribute
  42  *      @attr: struct attribute to initialize
  43  *
  44  *      Initialize a dynamically allocated struct attribute so we can
  45  *      make lockdep happy.  This is a new requirement for attributes
  46  *      and initially this is only needed when lockdep is enabled.
  47  *      Lockdep gives a nice error when your attribute is added to
  48  *      sysfs if you don't have this.
  49  */
  50 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  51 #define sysfs_attr_init(attr)                           \
  52 do {                                                    \
  53         static struct lock_class_key __key;             \
  54                                                         \
  55         (attr)->key = &__key;                           \
  56 } while(0)
  57 #else
  58 #define sysfs_attr_init(attr) do {} while(0)
  59 #endif
  60
  61 struct attribute_group {
  62         const char              *name;
  63         mode_t                  (*is_visible)(struct kobject *,
  64                                               struct attribute *, int);
  65         struct attribute        **attrs;
  66 };
  67
  68
  69
  70 /**
  71  * Use these macros to make defining attributes easier. See include/linux/device.h
  72  * for examples..
  73  */
  74
  75 #define __ATTR(_name,_mode,_show,_store) { \
  76         .attr = {.name = __stringify(_name), .mode = _mode },   \
  77         .show   = _show,                                        \
  78         .store  = _store,                                       \
  79 }
  80
  81 #define __ATTR_RO(_name) { \
  82         .attr   = { .name = __stringify(_name), .mode = 0444 }, \
  83         .show   = _name##_show,                                 \
  84 }
  85
  86 #define __ATTR_NULL { .attr = { .name = NULL } }
  87
  88 #define attr_name(_attr) (_attr).attr.name
  89
  90 struct vm_area_struct;
  91
  92 struct bin_attribute {
  93         struct attribute        attr;
  94         size_t                  size;
  95         void                    *private;
  96         ssize_t (*read)(struct kobject *, struct bin_attribute *,
  97                         char *, loff_t, size_t);
  98         ssize_t (*write)(struct kobject *, struct bin_attribute *,
  99                          char *, loff_t, size_t);
 100         int (*mmap)(struct kobject *, struct bin_attribute *attr,
 101                     struct vm_area_struct *vma);
 102 };
 103
 104 /**
 105  *      sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
 106  *      @attr: struct bin_attribute to initialize
 107  *
 108  *      Initialize a dynamically allocated struct bin_attribute so we
 109  *      can make lockdep happy.  This is a new requirement for
 110  *      attributes and initially this is only needed when lockdep is
 111  *      enabled.  Lockdep gives a nice error when your attribute is
 112  *      added to sysfs if you don't have this.
 113  */
 114 #define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr)
 115
 116 struct sysfs_ops {
 117         ssize_t (*show)(struct kobject *, struct attribute *,char *);
 118         ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t);
 119 };
 120
 121 struct sysfs_dirent;
 122
 123 #ifdef CONFIG_SYSFS
 124
 125 int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
 126                             void *data, struct module *owner);
 127
 128 int __must_check sysfs_create_dir(struct kobject *kobj);
 129 void sysfs_remove_dir(struct kobject *kobj);
 130 int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name);
 131 int __must_check sysfs_move_dir(struct kobject *kobj,
 132                                 struct kobject *new_parent_kobj);
 133
 134 int __must_check sysfs_create_file(struct kobject *kobj,
 135                                    const struct attribute *attr);
 136 int __must_check sysfs_create_files(struct kobject *kobj,
 137                                    const struct attribute **attr);
 138 int __must_check sysfs_chmod_file(struct kobject *kobj, struct attribute *attr,
 139                                   mode_t mode);
 140 void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr);
 141 void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
 142
 143 int __must_check sysfs_create_bin_file(struct kobject *kobj,
 144                                        const struct bin_attribute *attr);
 145 void sysfs_remove_bin_file(struct kobject *kobj,
 146                            const struct bin_attribute *attr);
 147
 148 int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
 149                                    const char *name);
 150 int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
 151                                           struct kobject *target,
 152                                           const char *name);
 153 void sysfs_remove_link(struct kobject *kobj, const char *name);
 154
 155 int sysfs_rename_link(struct kobject *kobj, struct kobject *target,
 156                         const char *old_name, const char *new_name);
 157
 158 void sysfs_delete_link(struct kobject *dir, struct kobject *targ,
 159                         const char *name);
 160
 161 int __must_check sysfs_create_group(struct kobject *kobj,
 162                                     const struct attribute_group *grp);
 163 int sysfs_update_group(struct kobject *kobj,
 164                        const struct attribute_group *grp);
 165 void sysfs_remove_group(struct kobject *kobj,
 166                         const struct attribute_group *grp);
 167 int sysfs_add_file_to_group(struct kobject *kobj,
 168                         const struct attribute *attr, const char *group);
 169 void sysfs_remove_file_from_group(struct kobject *kobj,
 170                         const struct attribute *attr, const char *group);
 171
 172 void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
 173 void sysfs_notify_dirent(struct sysfs_dirent *sd);
 174 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
 175                                       const void *ns,
 176                                       const unsigned char *name);
 177 struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd);
 178 void sysfs_put(struct sysfs_dirent *sd);
 179 void sysfs_printk_last_file(void);
 180
 181 void sysfs_exit_ns(enum kobj_ns_type type, const void *tag);
 182
 183 int __must_check sysfs_init(void);
 184
 185 #else /* CONFIG_SYSFS */
 186
 187 static inline int sysfs_schedule_callback(struct kobject *kobj,
 188                 void (*func)(void *), void *data, struct module *owner)
 189 {
 190         return -ENOSYS;
 191 }
 192
 193 static inline int sysfs_create_dir(struct kobject *kobj)
 194 {
 195         return 0;
 196 }
 197
 198 static inline void sysfs_remove_dir(struct kobject *kobj)
 199 {
 200 }
 201
 202 static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
 203 {
 204         return 0;
 205 }
 206
 207 static inline int sysfs_move_dir(struct kobject *kobj,
 208                                  struct kobject *new_parent_kobj)
 209 {
 210         return 0;
 211 }
 212
 213 static inline int sysfs_create_file(struct kobject *kobj,
 214                                     const struct attribute *attr)
 215 {
 216         return 0;
 217 }
 218
 219 static inline int sysfs_create_files(struct kobject *kobj,
 220                                     const struct attribute **attr)
 221 {
 222         return 0;
 223 }
 224
 225 static inline int sysfs_chmod_file(struct kobject *kobj,
 226                                    struct attribute *attr, mode_t mode)
 227 {
 228         return 0;
 229 }
 230
 231 static inline void sysfs_remove_file(struct kobject *kobj,
 232                                      const struct attribute *attr)
 233 {
 234 }
 235
 236 static inline void sysfs_remove_files(struct kobject *kobj,
 237                                      const struct attribute **attr)
 238 {
 239 }
 240
 241 static inline int sysfs_create_bin_file(struct kobject *kobj,
 242                                         const struct bin_attribute *attr)
 243 {
 244         return 0;
 245 }
 246
 247 static inline void sysfs_remove_bin_file(struct kobject *kobj,
 248                                          const struct bin_attribute *attr)
 249 {
 250 }
 251
 252 static inline int sysfs_create_link(struct kobject *kobj,
 253                                     struct kobject *target, const char *name)
 254 {
 255         return 0;
 256 }
 257
 258 static inline int sysfs_create_link_nowarn(struct kobject *kobj,
 259                                            struct kobject *target,
 260                                            const char *name)
 261 {
 262         return 0;
 263 }
 264
 265 static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
 266 {
 267 }
 268
 269 static inline int sysfs_rename_link(struct kobject *k, struct kobject *t,
 270                                     const char *old_name, const char *new_name)
 271 {
 272         return 0;
 273 }
 274
 275 static inline void sysfs_delete_link(struct kobject *k, struct kobject *t,
 276                                      const char *name)
 277 {
 278 }
 279
 280 static inline int sysfs_create_group(struct kobject *kobj,
 281                                      const struct attribute_group *grp)
 282 {
 283         return 0;
 284 }
 285
 286 static inline int sysfs_update_group(struct kobject *kobj,
 287                                 const struct attribute_group *grp)
 288 {
 289         return 0;
 290 }
 291
 292 static inline void sysfs_remove_group(struct kobject *kobj,
 293                                       const struct attribute_group *grp)
 294 {
 295 }
 296
 297 static inline int sysfs_add_file_to_group(struct kobject *kobj,
 298                 const struct attribute *attr, const char *group)
 299 {
 300         return 0;
 301 }
 302
 303 static inline void sysfs_remove_file_from_group(struct kobject *kobj,
 304                 const struct attribute *attr, const char *group)
 305 {
 306 }
 307
 308 static inline void sysfs_notify(struct kobject *kobj, const char *dir,
 309                                 const char *attr)
 310 {
 311 }
 312 static inline void sysfs_notify_dirent(struct sysfs_dirent *sd)
 313 {
 314 }
 315 static inline
 316 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
 317                                       const void *ns,
 318                                       const unsigned char *name)
 319 {
 320         return NULL;
 321 }
 322 static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
 323 {
 324         return NULL;
 325 }
 326 static inline void sysfs_put(struct sysfs_dirent *sd)
 327 {
 328 }
 329
 330 static inline void sysfs_exit_ns(enum kobj_ns_type type, const void *tag)
 331 {
 332 }
 333
 334 static inline int __must_check sysfs_init(void)
 335 {
 336         return 0;
 337 }
 338
 339 static inline void sysfs_printk_last_file(void)
 340 {
 341 }
 342
 343 #endif /* CONFIG_SYSFS */
 344
 345 #endif /* _SYSFS_H_ */