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/list.h>
  15 #include <asm/atomic.h>
  16
  17 struct kobject;
  18 struct module;
  19
  20 struct attribute {
  21         const char              * name;
  22         struct module           * owner;
  23         mode_t                  mode;
  24 };
  25
  26 struct attribute_group {
  27         const char              * name;
  28         struct attribute        ** attrs;
  29 };
  30
  31
  32
  33 /**
  34  * Use these macros to make defining attributes easier. See include/linux/device.h
  35  * for examples..
  36  */
  37
  38 #define __ATTR(_name,_mode,_show,_store) { \
  39         .attr = {.name = __stringify(_name), .mode = _mode, .owner = THIS_MODULE },     \
  40         .show   = _show,                                        \
  41         .store  = _store,                                       \
  42 }
  43
  44 #define __ATTR_RO(_name) { \
  45         .attr   = { .name = __stringify(_name), .mode = 0444, .owner = THIS_MODULE },   \
  46         .show   = _name##_show, \
  47 }
  48
  49 #define __ATTR_NULL { .attr = { .name = NULL } }
  50
  51 #define attr_name(_attr) (_attr).attr.name
  52
  53 struct vm_area_struct;
  54
  55 struct bin_attribute {
  56         struct attribute        attr;
  57         size_t                  size;
  58         void                    *private;
  59         ssize_t (*read)(struct kobject *, char *, loff_t, size_t);
  60         ssize_t (*write)(struct kobject *, char *, loff_t, size_t);
  61         int (*mmap)(struct kobject *, struct bin_attribute *attr,
  62                     struct vm_area_struct *vma);
  63 };
  64
  65 struct sysfs_ops {
  66         ssize_t (*show)(struct kobject *, struct attribute *,char *);
  67         ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t);
  68 };
  69
  70 struct sysfs_dirent {
  71         atomic_t                s_count;
  72         struct list_head        s_sibling;
  73         struct list_head        s_children;
  74         void                    * s_element;
  75         int                     s_type;
  76         umode_t                 s_mode;
  77         struct dentry           * s_dentry;
  78         struct iattr            * s_iattr;
  79         atomic_t                s_event;
  80 };
  81
  82 #define SYSFS_ROOT              0x0001
  83 #define SYSFS_DIR               0x0002
  84 #define SYSFS_KOBJ_ATTR         0x0004
  85 #define SYSFS_KOBJ_BIN_ATTR     0x0008
  86 #define SYSFS_KOBJ_LINK         0x0020
  87 #define SYSFS_NOT_PINNED        (SYSFS_KOBJ_ATTR | SYSFS_KOBJ_BIN_ATTR | SYSFS_KOBJ_LINK)
  88
  89 #ifdef CONFIG_SYSFS
  90
  91 extern int __must_check
  92 sysfs_create_dir(struct kobject *);
  93
  94 extern void
  95 sysfs_remove_dir(struct kobject *);
  96
  97 extern int __must_check
  98 sysfs_rename_dir(struct kobject *, const char *new_name);
  99
 100 extern int __must_check
 101 sysfs_move_dir(struct kobject *, struct kobject *);
 102
 103 extern int __must_check
 104 sysfs_create_file(struct kobject *, const struct attribute *);
 105
 106 extern int __must_check
 107 sysfs_update_file(struct kobject *, const struct attribute *);
 108
 109 extern int __must_check
 110 sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode);
 111
 112 extern void
 113 sysfs_remove_file(struct kobject *, const struct attribute *);
 114
 115 extern int __must_check
 116 sysfs_create_link(struct kobject * kobj, struct kobject * target, const char * name);
 117
 118 extern void
 119 sysfs_remove_link(struct kobject *, const char * name);
 120
 121 int __must_check sysfs_create_bin_file(struct kobject *kobj,
 122                                         struct bin_attribute *attr);
 123 void sysfs_remove_bin_file(struct kobject *kobj, struct bin_attribute *attr);
 124
 125 int __must_check sysfs_create_group(struct kobject *,
 126                                         const struct attribute_group *);
 127 void sysfs_remove_group(struct kobject *, const struct attribute_group *);
 128 void sysfs_notify(struct kobject * k, char *dir, char *attr);
 129
 130 extern int __must_check sysfs_init(void);
 131
 132 #else /* CONFIG_SYSFS */
 133
 134 static inline int sysfs_create_dir(struct kobject * k)
 135 {
 136         return 0;
 137 }
 138
 139 static inline void sysfs_remove_dir(struct kobject * k)
 140 {
 141         ;
 142 }
 143
 144 static inline int sysfs_rename_dir(struct kobject * k, const char *new_name)
 145 {
 146         return 0;
 147 }
 148
 149 static inline int sysfs_move_dir(struct kobject * k, struct kobject * new_parent)
 150 {
 151         return 0;
 152 }
 153
 154 static inline int sysfs_create_file(struct kobject * k, const struct attribute * a)
 155 {
 156         return 0;
 157 }
 158
 159 static inline int sysfs_update_file(struct kobject * k, const struct attribute * a)
 160 {
 161         return 0;
 162 }
 163 static inline int sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode)
 164 {
 165         return 0;
 166 }
 167
 168 static inline void sysfs_remove_file(struct kobject * k, const struct attribute * a)
 169 {
 170         ;
 171 }
 172
 173 static inline int sysfs_create_link(struct kobject * k, struct kobject * t, const char * n)
 174 {
 175         return 0;
 176 }
 177
 178 static inline void sysfs_remove_link(struct kobject * k, const char * name)
 179 {
 180         ;
 181 }
 182
 183
 184 static inline int sysfs_create_bin_file(struct kobject * k, struct bin_attribute * a)
 185 {
 186         return 0;
 187 }
 188
 189 static inline int sysfs_remove_bin_file(struct kobject * k, struct bin_attribute * a)
 190 {
 191         return 0;
 192 }
 193
 194 static inline int sysfs_create_group(struct kobject * k, const struct attribute_group *g)
 195 {
 196         return 0;
 197 }
 198
 199 static inline void sysfs_remove_group(struct kobject * k, const struct attribute_group * g)
 200 {
 201         ;
 202 }
 203
 204 static inline void sysfs_notify(struct kobject * k, char *dir, char *attr)
 205 {
 206 }
 207
 208 static inline int __must_check sysfs_init(void)
 209 {
 210         return 0;
 211 }
 212
 213 #endif /* CONFIG_SYSFS */
 214
 215 #endif /* _SYSFS_H_ */