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