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