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 <asm/atomic.h>
  14
  15 #define SYSFS_SUPER_MAGIC       0x62656572
  16
  17 struct kobject;
  18 struct module;
  19
  20 struct attribute {
  21         char                    * name;
  22         struct module           * owner;
  23         mode_t                  mode;
  24 };
  25
  26 struct attribute_group {
  27         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 };
  79
  80 #define SYSFS_ROOT              0x0001
  81 #define SYSFS_DIR               0x0002
  82 #define SYSFS_KOBJ_ATTR         0x0004
  83 #define SYSFS_KOBJ_BIN_ATTR     0x0008
  84 #define SYSFS_KOBJ_LINK         0x0020
  85 #define SYSFS_NOT_PINNED        (SYSFS_KOBJ_ATTR | SYSFS_KOBJ_BIN_ATTR | SYSFS_KOBJ_LINK)
  86
  87 #ifdef CONFIG_SYSFS
  88
  89 extern int
  90 sysfs_create_dir(struct kobject *);
  91
  92 extern void
  93 sysfs_remove_dir(struct kobject *);
  94
  95 extern int
  96 sysfs_rename_dir(struct kobject *, const char *new_name);
  97
  98 extern int
  99 sysfs_create_file(struct kobject *, const struct attribute *);
 100
 101 extern int
 102 sysfs_update_file(struct kobject *, const struct attribute *);
 103
 104 extern int
 105 sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode);
 106
 107 extern void
 108 sysfs_remove_file(struct kobject *, const struct attribute *);
 109
 110 extern int
 111 sysfs_create_link(struct kobject * kobj, struct kobject * target, char * name);
 112
 113 extern void
 114 sysfs_remove_link(struct kobject *, char * name);
 115
 116 int sysfs_create_bin_file(struct kobject * kobj, struct bin_attribute * attr);
 117 int sysfs_remove_bin_file(struct kobject * kobj, struct bin_attribute * attr);
 118
 119 int sysfs_create_group(struct kobject *, const struct attribute_group *);
 120 void sysfs_remove_group(struct kobject *, const struct attribute_group *);
 121
 122 #else /* CONFIG_SYSFS */
 123
 124 static inline int sysfs_create_dir(struct kobject * k)
 125 {
 126         return 0;
 127 }
 128
 129 static inline void sysfs_remove_dir(struct kobject * k)
 130 {
 131         ;
 132 }
 133
 134 static inline int sysfs_rename_dir(struct kobject * k, const char *new_name)
 135 {
 136         return 0;
 137 }
 138
 139 static inline int sysfs_create_file(struct kobject * k, const struct attribute * a)
 140 {
 141         return 0;
 142 }
 143
 144 static inline int sysfs_update_file(struct kobject * k, const struct attribute * a)
 145 {
 146         return 0;
 147 }
 148 static inline int sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode)
 149 {
 150         return 0;
 151 }
 152
 153 static inline void sysfs_remove_file(struct kobject * k, const struct attribute * a)
 154 {
 155         ;
 156 }
 157
 158 static inline int sysfs_create_link(struct kobject * k, struct kobject * t, char * n)
 159 {
 160         return 0;
 161 }
 162
 163 static inline void sysfs_remove_link(struct kobject * k, char * name)
 164 {
 165         ;
 166 }
 167
 168
 169 static inline int sysfs_create_bin_file(struct kobject * k, struct bin_attribute * a)
 170 {
 171         return 0;
 172 }
 173
 174 static inline int sysfs_remove_bin_file(struct kobject * k, struct bin_attribute * a)
 175 {
 176         return 0;
 177 }
 178
 179 static inline int sysfs_create_group(struct kobject * k, const struct attribute_group *g)
 180 {
 181         return 0;
 182 }
 183
 184 static inline void sysfs_remove_group(struct kobject * k, const struct attribute_group * g)
 185 {
 186         ;
 187 }
 188
 189 #endif /* CONFIG_SYSFS */
 190
 191 #endif /* _SYSFS_H_ */