driver-core: platform: convert bus code to use dev_groups
[linux-2.6-block.git] / include / linux / sysfs.h
CommitLineData
1da177e4
LT
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.
6d66f5cd
TH
6 * Copyright (c) 2007 SUSE Linux Products GmbH
7 * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
1da177e4
LT
8 *
9 * Please see Documentation/filesystems/sysfs.txt for more information.
10 */
11
12#ifndef _SYSFS_H_
13#define _SYSFS_H_
14
4a7fb636 15#include <linux/compiler.h>
5851fadc 16#include <linux/errno.h>
bf0acc33 17#include <linux/list.h>
6992f533 18#include <linux/lockdep.h>
8488a38f 19#include <linux/kobject_ns.h>
3493f69f 20#include <linux/stat.h>
60063497 21#include <linux/atomic.h>
1da177e4
LT
22
23struct kobject;
24struct module;
6ab9cea1 25struct bin_attribute;
3ff195b0 26enum kobj_ns_type;
1da177e4
LT
27
28struct attribute {
59f69015 29 const char *name;
9104e427 30 umode_t mode;
6992f533 31#ifdef CONFIG_DEBUG_LOCK_ALLOC
356c05d5 32 bool ignore_lockdep:1;
6992f533
EB
33 struct lock_class_key *key;
34 struct lock_class_key skey;
35#endif
1da177e4
LT
36};
37
35960258
EB
38/**
39 * sysfs_attr_init - initialize a dynamically allocated sysfs attribute
40 * @attr: struct attribute to initialize
41 *
42 * Initialize a dynamically allocated struct attribute so we can
43 * make lockdep happy. This is a new requirement for attributes
44 * and initially this is only needed when lockdep is enabled.
45 * Lockdep gives a nice error when your attribute is added to
46 * sysfs if you don't have this.
47 */
6992f533
EB
48#ifdef CONFIG_DEBUG_LOCK_ALLOC
49#define sysfs_attr_init(attr) \
50do { \
51 static struct lock_class_key __key; \
52 \
53 (attr)->key = &__key; \
5da5c9c8 54} while (0)
6992f533 55#else
5da5c9c8 56#define sysfs_attr_init(attr) do {} while (0)
6992f533
EB
57#endif
58
1da177e4 59struct attribute_group {
59f69015 60 const char *name;
587a1f16 61 umode_t (*is_visible)(struct kobject *,
d4acd722 62 struct attribute *, int);
59f69015 63 struct attribute **attrs;
6ab9cea1 64 struct bin_attribute **bin_attrs;
1da177e4
LT
65};
66
1da177e4
LT
67/**
68 * Use these macros to make defining attributes easier. See include/linux/device.h
69 * for examples..
70 */
71
5da5c9c8 72#define __ATTR(_name, _mode, _show, _store) { \
aa01aa3c
OS
73 .attr = {.name = __stringify(_name), .mode = _mode }, \
74 .show = _show, \
75 .store = _store, \
1da177e4
LT
76}
77
aa01aa3c
OS
78#define __ATTR_RO(_name) { \
79 .attr = { .name = __stringify(_name), .mode = S_IRUGO }, \
80 .show = _name##_show, \
1da177e4
LT
81}
82
aa01aa3c
OS
83#define __ATTR_RW(_name) __ATTR(_name, (S_IWUSR | S_IRUGO), \
84 _name##_show, _name##_store)
b9b32597 85
1da177e4 86#define __ATTR_NULL { .attr = { .name = NULL } }
356c05d5
AS
87
88#ifdef CONFIG_DEBUG_LOCK_ALLOC
89#define __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) { \
90 .attr = {.name = __stringify(_name), .mode = _mode, \
91 .ignore_lockdep = true }, \
92 .show = _show, \
93 .store = _store, \
94}
95#else
96#define __ATTR_IGNORE_LOCKDEP __ATTR
97#endif
1da177e4 98
3493f69f
OS
99#define __ATTRIBUTE_GROUPS(_name) \
100static const struct attribute_group *_name##_groups[] = { \
101 &_name##_group, \
f2f37f58
GKH
102 NULL, \
103}
104
3493f69f
OS
105#define ATTRIBUTE_GROUPS(_name) \
106static const struct attribute_group _name##_group = { \
107 .attrs = _name##_attrs, \
108}; \
109__ATTRIBUTE_GROUPS(_name)
110
2c3c8bea 111struct file;
1da177e4
LT
112struct vm_area_struct;
113
114struct bin_attribute {
115 struct attribute attr;
116 size_t size;
117 void *private;
2c3c8bea 118 ssize_t (*read)(struct file *, struct kobject *, struct bin_attribute *,
91a69029 119 char *, loff_t, size_t);
5da5c9c8 120 ssize_t (*write)(struct file *, struct kobject *, struct bin_attribute *,
91a69029 121 char *, loff_t, size_t);
2c3c8bea 122 int (*mmap)(struct file *, struct kobject *, struct bin_attribute *attr,
1da177e4
LT
123 struct vm_area_struct *vma);
124};
125
35960258
EB
126/**
127 * sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
128 * @attr: struct bin_attribute to initialize
129 *
130 * Initialize a dynamically allocated struct bin_attribute so we
131 * can make lockdep happy. This is a new requirement for
132 * attributes and initially this is only needed when lockdep is
133 * enabled. Lockdep gives a nice error when your attribute is
134 * added to sysfs if you don't have this.
135 */
62e877b8 136#define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr)
6992f533 137
3493f69f
OS
138/* macros to create static binary attributes easier */
139#define __BIN_ATTR(_name, _mode, _read, _write, _size) { \
140 .attr = { .name = __stringify(_name), .mode = _mode }, \
141 .read = _read, \
142 .write = _write, \
143 .size = _size, \
144}
145
146#define __BIN_ATTR_RO(_name, _size) { \
147 .attr = { .name = __stringify(_name), .mode = S_IRUGO }, \
148 .read = _name##_read, \
149 .size = _size, \
e4b63603
GKH
150}
151
3493f69f
OS
152#define __BIN_ATTR_RW(_name, _size) __BIN_ATTR(_name, \
153 (S_IWUSR | S_IRUGO), _name##_read, \
68531526 154 _name##_write, _size)
3493f69f
OS
155
156#define __BIN_ATTR_NULL __ATTR_NULL
157
158#define BIN_ATTR(_name, _mode, _read, _write, _size) \
159struct bin_attribute bin_attr_##_name = __BIN_ATTR(_name, _mode, _read, \
160 _write, _size)
161
162#define BIN_ATTR_RO(_name, _size) \
163struct bin_attribute bin_attr_##_name = __BIN_ATTR_RO(_name, _size)
164
165#define BIN_ATTR_RW(_name, _size) \
166struct bin_attribute bin_attr_##_name = __BIN_ATTR_RW(_name, _size)
167
1da177e4 168struct sysfs_ops {
5da5c9c8
GKH
169 ssize_t (*show)(struct kobject *, struct attribute *, char *);
170 ssize_t (*store)(struct kobject *, struct attribute *, const char *, size_t);
487505c2 171 const void *(*namespace)(struct kobject *, const struct attribute *);
1da177e4
LT
172};
173
f1282c84
NB
174struct sysfs_dirent;
175
1da177e4
LT
176#ifdef CONFIG_SYSFS
177
59f69015
TH
178int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
179 void *data, struct module *owner);
1da177e4 180
59f69015
TH
181int __must_check sysfs_create_dir(struct kobject *kobj);
182void sysfs_remove_dir(struct kobject *kobj);
183int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name);
184int __must_check sysfs_move_dir(struct kobject *kobj,
185 struct kobject *new_parent_kobj);
31e5abe9 186
59f69015
TH
187int __must_check sysfs_create_file(struct kobject *kobj,
188 const struct attribute *attr);
1c205ae1
AK
189int __must_check sysfs_create_files(struct kobject *kobj,
190 const struct attribute **attr);
49c19400 191int __must_check sysfs_chmod_file(struct kobject *kobj,
48176a97 192 const struct attribute *attr, umode_t mode);
59f69015 193void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr);
1c205ae1 194void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
1da177e4 195
4a7fb636 196int __must_check sysfs_create_bin_file(struct kobject *kobj,
66ecb92b
PC
197 const struct bin_attribute *attr);
198void sysfs_remove_bin_file(struct kobject *kobj,
199 const struct bin_attribute *attr);
1da177e4 200
59f69015
TH
201int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
202 const char *name);
36ce6dad
CH
203int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
204 struct kobject *target,
205 const char *name);
59f69015
TH
206void sysfs_remove_link(struct kobject *kobj, const char *name);
207
7cb32942
EB
208int sysfs_rename_link(struct kobject *kobj, struct kobject *target,
209 const char *old_name, const char *new_name);
210
746edb7a
EB
211void sysfs_delete_link(struct kobject *dir, struct kobject *targ,
212 const char *name);
213
59f69015
TH
214int __must_check sysfs_create_group(struct kobject *kobj,
215 const struct attribute_group *grp);
3e9b2bae
GKH
216int __must_check sysfs_create_groups(struct kobject *kobj,
217 const struct attribute_group **groups);
0f423895
JB
218int sysfs_update_group(struct kobject *kobj,
219 const struct attribute_group *grp);
59f69015
TH
220void sysfs_remove_group(struct kobject *kobj,
221 const struct attribute_group *grp);
3e9b2bae
GKH
222void sysfs_remove_groups(struct kobject *kobj,
223 const struct attribute_group **groups);
dfa87c82 224int sysfs_add_file_to_group(struct kobject *kobj,
59f69015 225 const struct attribute *attr, const char *group);
dfa87c82 226void sysfs_remove_file_from_group(struct kobject *kobj,
59f69015 227 const struct attribute *attr, const char *group);
69d44ffb
AS
228int sysfs_merge_group(struct kobject *kobj,
229 const struct attribute_group *grp);
230void sysfs_unmerge_group(struct kobject *kobj,
231 const struct attribute_group *grp);
0bb8f3d6
RW
232int sysfs_add_link_to_group(struct kobject *kobj, const char *group_name,
233 struct kobject *target, const char *link_name);
234void sysfs_remove_link_from_group(struct kobject *kobj, const char *group_name,
235 const char *link_name);
dfa87c82 236
8c0e3998 237void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
f1282c84
NB
238void sysfs_notify_dirent(struct sysfs_dirent *sd);
239struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
3ff195b0 240 const void *ns,
f1282c84
NB
241 const unsigned char *name);
242struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd);
243void sysfs_put(struct sysfs_dirent *sd);
3ff195b0 244
f1282c84 245int __must_check sysfs_init(void);
f20a9ead 246
1da177e4
LT
247#else /* CONFIG_SYSFS */
248
d9a9cdfb 249static inline int sysfs_schedule_callback(struct kobject *kobj,
523ded71 250 void (*func)(void *), void *data, struct module *owner)
d9a9cdfb
AS
251{
252 return -ENOSYS;
253}
254
59f69015 255static inline int sysfs_create_dir(struct kobject *kobj)
1da177e4
LT
256{
257 return 0;
258}
259
59f69015 260static inline void sysfs_remove_dir(struct kobject *kobj)
1da177e4 261{
1da177e4
LT
262}
263
59f69015 264static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
1da177e4 265{
0b4a4fea 266 return 0;
1da177e4
LT
267}
268
59f69015
TH
269static inline int sysfs_move_dir(struct kobject *kobj,
270 struct kobject *new_parent_kobj)
8a82472f
CH
271{
272 return 0;
273}
274
59f69015
TH
275static inline int sysfs_create_file(struct kobject *kobj,
276 const struct attribute *attr)
1da177e4
LT
277{
278 return 0;
279}
280
1c205ae1
AK
281static inline int sysfs_create_files(struct kobject *kobj,
282 const struct attribute **attr)
283{
284 return 0;
285}
286
59f69015 287static inline int sysfs_chmod_file(struct kobject *kobj,
48176a97 288 const struct attribute *attr, umode_t mode)
31e5abe9
KS
289{
290 return 0;
291}
1da177e4 292
59f69015
TH
293static inline void sysfs_remove_file(struct kobject *kobj,
294 const struct attribute *attr)
1da177e4 295{
1da177e4
LT
296}
297
1c205ae1
AK
298static inline void sysfs_remove_files(struct kobject *kobj,
299 const struct attribute **attr)
300{
301}
302
59f69015 303static inline int sysfs_create_bin_file(struct kobject *kobj,
66ecb92b 304 const struct bin_attribute *attr)
1da177e4
LT
305{
306 return 0;
307}
308
3612e06b 309static inline void sysfs_remove_bin_file(struct kobject *kobj,
66ecb92b 310 const struct bin_attribute *attr)
1da177e4 311{
1da177e4
LT
312}
313
59f69015
TH
314static inline int sysfs_create_link(struct kobject *kobj,
315 struct kobject *target, const char *name)
1da177e4
LT
316{
317 return 0;
318}
319
36ce6dad
CH
320static inline int sysfs_create_link_nowarn(struct kobject *kobj,
321 struct kobject *target,
322 const char *name)
323{
324 return 0;
325}
326
59f69015 327static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
1da177e4 328{
1da177e4
LT
329}
330
7cb32942
EB
331static inline int sysfs_rename_link(struct kobject *k, struct kobject *t,
332 const char *old_name, const char *new_name)
333{
334 return 0;
335}
336
746edb7a
EB
337static inline void sysfs_delete_link(struct kobject *k, struct kobject *t,
338 const char *name)
339{
340}
341
59f69015
TH
342static inline int sysfs_create_group(struct kobject *kobj,
343 const struct attribute_group *grp)
1da177e4
LT
344{
345 return 0;
346}
347
1cbfb7a5
RD
348static inline int sysfs_update_group(struct kobject *kobj,
349 const struct attribute_group *grp)
350{
351 return 0;
352}
353
59f69015
TH
354static inline void sysfs_remove_group(struct kobject *kobj,
355 const struct attribute_group *grp)
1da177e4 356{
1da177e4
LT
357}
358
dfa87c82
AS
359static inline int sysfs_add_file_to_group(struct kobject *kobj,
360 const struct attribute *attr, const char *group)
361{
362 return 0;
363}
364
365static inline void sysfs_remove_file_from_group(struct kobject *kobj,
d701d8a3 366 const struct attribute *attr, const char *group)
dfa87c82 367{
dfa87c82
AS
368}
369
69d44ffb
AS
370static inline int sysfs_merge_group(struct kobject *kobj,
371 const struct attribute_group *grp)
372{
373 return 0;
374}
375
376static inline void sysfs_unmerge_group(struct kobject *kobj,
377 const struct attribute_group *grp)
378{
379}
380
0bb8f3d6
RW
381static inline int sysfs_add_link_to_group(struct kobject *kobj,
382 const char *group_name, struct kobject *target,
383 const char *link_name)
384{
385 return 0;
386}
387
388static inline void sysfs_remove_link_from_group(struct kobject *kobj,
389 const char *group_name, const char *link_name)
390{
391}
392
8c0e3998
TP
393static inline void sysfs_notify(struct kobject *kobj, const char *dir,
394 const char *attr)
4508a7a7
N
395{
396}
f1282c84
NB
397static inline void sysfs_notify_dirent(struct sysfs_dirent *sd)
398{
399}
400static inline
401struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
3ff195b0 402 const void *ns,
f1282c84
NB
403 const unsigned char *name)
404{
405 return NULL;
406}
407static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
408{
409 return NULL;
410}
411static inline void sysfs_put(struct sysfs_dirent *sd)
412{
413}
4508a7a7 414
f20a9ead
AM
415static inline int __must_check sysfs_init(void)
416{
417 return 0;
418}
419
1da177e4
LT
420#endif /* CONFIG_SYSFS */
421
422#endif /* _SYSFS_H_ */