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