blob: 0010009b2f00148ecd82e2b7d5deb7667c98cf64 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * sysfs.h - definitions for the device driver filesystem
3 *
4 * Copyright (c) 2001,2002 Patrick Mochel
5 * Copyright (c) 2004 Silicon Graphics, Inc.
Tejun Heo6d66f5c2007-09-20 17:31:38 +09006 * Copyright (c) 2007 SUSE Linux Products GmbH
7 * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
9 * Please see Documentation/filesystems/sysfs.txt for more information.
10 */
11
12#ifndef _SYSFS_H_
13#define _SYSFS_H_
14
Andrew Morton4a7fb632006-08-14 22:43:17 -070015#include <linux/compiler.h>
Ralf Baechle5851fad2007-03-18 12:58:08 +000016#include <linux/errno.h>
Frank Haverkampbf0acc32007-01-17 17:51:18 +010017#include <linux/list.h>
Eric W. Biederman6992f532010-02-11 15:21:53 -080018#include <linux/lockdep.h>
David Howells8488a382010-08-11 15:01:02 +010019#include <linux/kobject_ns.h>
Arun Sharma600634972011-07-26 16:09:06 -070020#include <linux/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
22struct kobject;
23struct module;
Eric W. Biederman3ff195b2010-03-30 11:31:26 -070024enum kobj_ns_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
26struct attribute {
Tejun Heo59f69012007-09-20 16:05:10 +090027 const char *name;
Al Viro9104e422011-07-23 23:10:46 -040028 umode_t mode;
Eric W. Biederman6992f532010-02-11 15:21:53 -080029#ifdef CONFIG_DEBUG_LOCK_ALLOC
30 struct lock_class_key *key;
31 struct lock_class_key skey;
32#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070033};
34
Eric W. Biederman35960252010-02-12 04:35:32 -080035/**
36 * sysfs_attr_init - initialize a dynamically allocated sysfs attribute
37 * @attr: struct attribute to initialize
38 *
39 * Initialize a dynamically allocated struct attribute so we can
40 * make lockdep happy. This is a new requirement for attributes
41 * and initially this is only needed when lockdep is enabled.
42 * Lockdep gives a nice error when your attribute is added to
43 * sysfs if you don't have this.
44 */
Eric W. Biederman6992f532010-02-11 15:21:53 -080045#ifdef CONFIG_DEBUG_LOCK_ALLOC
46#define sysfs_attr_init(attr) \
47do { \
48 static struct lock_class_key __key; \
49 \
50 (attr)->key = &__key; \
51} while(0)
52#else
53#define sysfs_attr_init(attr) do {} while(0)
54#endif
55
Linus Torvalds1da177e2005-04-16 15:20:36 -070056struct attribute_group {
Tejun Heo59f69012007-09-20 16:05:10 +090057 const char *name;
Al Viro587a1f12011-07-23 23:11:19 -040058 umode_t (*is_visible)(struct kobject *,
James Bottomleyd4acd722007-10-31 09:38:04 -050059 struct attribute *, int);
Tejun Heo59f69012007-09-20 16:05:10 +090060 struct attribute **attrs;
Linus Torvalds1da177e2005-04-16 15:20:36 -070061};
62
63
64
65/**
66 * Use these macros to make defining attributes easier. See include/linux/device.h
67 * for examples..
68 */
69
70#define __ATTR(_name,_mode,_show,_store) { \
Tejun Heo7b595752007-06-14 03:45:17 +090071 .attr = {.name = __stringify(_name), .mode = _mode }, \
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 .show = _show, \
73 .store = _store, \
74}
75
76#define __ATTR_RO(_name) { \
Tejun Heo7b595752007-06-14 03:45:17 +090077 .attr = { .name = __stringify(_name), .mode = 0444 }, \
78 .show = _name##_show, \
Linus Torvalds1da177e2005-04-16 15:20:36 -070079}
80
81#define __ATTR_NULL { .attr = { .name = NULL } }
82
83#define attr_name(_attr) (_attr).attr.name
84
Chris Wright2c3c8be2010-05-12 18:28:57 -070085struct file;
Linus Torvalds1da177e2005-04-16 15:20:36 -070086struct vm_area_struct;
87
88struct bin_attribute {
89 struct attribute attr;
90 size_t size;
91 void *private;
Chris Wright2c3c8be2010-05-12 18:28:57 -070092 ssize_t (*read)(struct file *, struct kobject *, struct bin_attribute *,
Zhang Rui91a69022007-06-09 13:57:22 +080093 char *, loff_t, size_t);
Chris Wright2c3c8be2010-05-12 18:28:57 -070094 ssize_t (*write)(struct file *,struct kobject *, struct bin_attribute *,
Zhang Rui91a69022007-06-09 13:57:22 +080095 char *, loff_t, size_t);
Chris Wright2c3c8be2010-05-12 18:28:57 -070096 int (*mmap)(struct file *, struct kobject *, struct bin_attribute *attr,
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 struct vm_area_struct *vma);
98};
99
Eric W. Biederman35960252010-02-12 04:35:32 -0800100/**
101 * sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
102 * @attr: struct bin_attribute to initialize
103 *
104 * Initialize a dynamically allocated struct bin_attribute so we
105 * can make lockdep happy. This is a new requirement for
106 * attributes and initially this is only needed when lockdep is
107 * enabled. Lockdep gives a nice error when your attribute is
108 * added to sysfs if you don't have this.
109 */
Stephen Rothwell62e877b82010-03-01 20:38:36 +1100110#define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr)
Eric W. Biederman6992f532010-02-11 15:21:53 -0800111
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112struct sysfs_ops {
113 ssize_t (*show)(struct kobject *, struct attribute *,char *);
114 ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t);
Eric W. Biederman487505c2011-10-12 21:53:38 +0000115 const void *(*namespace)(struct kobject *, const struct attribute *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116};
117
Neil Brownf1282c82008-07-16 08:58:04 +1000118struct sysfs_dirent;
119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120#ifdef CONFIG_SYSFS
121
Tejun Heo59f69012007-09-20 16:05:10 +0900122int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
123 void *data, struct module *owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400124
Tejun Heo59f69012007-09-20 16:05:10 +0900125int __must_check sysfs_create_dir(struct kobject *kobj);
126void sysfs_remove_dir(struct kobject *kobj);
127int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name);
128int __must_check sysfs_move_dir(struct kobject *kobj,
129 struct kobject *new_parent_kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
Tejun Heo59f69012007-09-20 16:05:10 +0900131int __must_check sysfs_create_file(struct kobject *kobj,
132 const struct attribute *attr);
Andi Kleen1c205ae2010-01-05 12:48:01 +0100133int __must_check sysfs_create_files(struct kobject *kobj,
134 const struct attribute **attr);
Jean Delvare49c19402010-07-02 16:54:05 +0200135int __must_check sysfs_chmod_file(struct kobject *kobj,
Al Viro48176a92011-07-24 03:40:40 -0400136 const struct attribute *attr, umode_t mode);
Tejun Heo59f69012007-09-20 16:05:10 +0900137void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr);
Andi Kleen1c205ae2010-01-05 12:48:01 +0100138void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
Andrew Morton4a7fb632006-08-14 22:43:17 -0700140int __must_check sysfs_create_bin_file(struct kobject *kobj,
Phil Carmody66ecb922009-12-18 15:34:20 +0200141 const struct bin_attribute *attr);
142void sysfs_remove_bin_file(struct kobject *kobj,
143 const struct bin_attribute *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
Tejun Heo59f69012007-09-20 16:05:10 +0900145int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
146 const char *name);
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200147int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
148 struct kobject *target,
149 const char *name);
Tejun Heo59f69012007-09-20 16:05:10 +0900150void sysfs_remove_link(struct kobject *kobj, const char *name);
Alan Sterndfa87c82007-02-20 15:02:44 -0500151
Eric W. Biederman7cb32942010-02-12 19:22:25 -0800152int sysfs_rename_link(struct kobject *kobj, struct kobject *target,
153 const char *old_name, const char *new_name);
154
Eric W. Biederman746edb72010-03-30 11:31:28 -0700155void sysfs_delete_link(struct kobject *dir, struct kobject *targ,
156 const char *name);
157
Tejun Heo59f69012007-09-20 16:05:10 +0900158int __must_check sysfs_create_group(struct kobject *kobj,
159 const struct attribute_group *grp);
James Bottomley0f423892008-03-20 20:47:52 -0500160int sysfs_update_group(struct kobject *kobj,
161 const struct attribute_group *grp);
Tejun Heo59f69012007-09-20 16:05:10 +0900162void sysfs_remove_group(struct kobject *kobj,
163 const struct attribute_group *grp);
164int sysfs_add_file_to_group(struct kobject *kobj,
165 const struct attribute *attr, const char *group);
166void sysfs_remove_file_from_group(struct kobject *kobj,
167 const struct attribute *attr, const char *group);
Alan Stern69d44ff2010-09-25 23:34:22 +0200168int sysfs_merge_group(struct kobject *kobj,
169 const struct attribute_group *grp);
170void sysfs_unmerge_group(struct kobject *kobj,
171 const struct attribute_group *grp);
Tejun Heo59f69012007-09-20 16:05:10 +0900172
Trent Piepho8c0e3992008-09-25 16:45:13 -0700173void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
Neil Brownf1282c82008-07-16 08:58:04 +1000174void sysfs_notify_dirent(struct sysfs_dirent *sd);
175struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700176 const void *ns,
Neil Brownf1282c82008-07-16 08:58:04 +1000177 const unsigned char *name);
178struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd);
179void sysfs_put(struct sysfs_dirent *sd);
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700180
Neil Brownf1282c82008-07-16 08:58:04 +1000181int __must_check sysfs_init(void);
Andrew Mortonf20a9ea2006-08-14 22:43:23 -0700182
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183#else /* CONFIG_SYSFS */
184
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400185static inline int sysfs_schedule_callback(struct kobject *kobj,
Alan Stern523ded72007-04-26 00:12:04 -0700186 void (*func)(void *), void *data, struct module *owner)
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400187{
188 return -ENOSYS;
189}
190
Tejun Heo59f69012007-09-20 16:05:10 +0900191static inline int sysfs_create_dir(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192{
193 return 0;
194}
195
Tejun Heo59f69012007-09-20 16:05:10 +0900196static inline void sysfs_remove_dir(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198}
199
Tejun Heo59f69012007-09-20 16:05:10 +0900200static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201{
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700202 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203}
204
Tejun Heo59f69012007-09-20 16:05:10 +0900205static inline int sysfs_move_dir(struct kobject *kobj,
206 struct kobject *new_parent_kobj)
Cornelia Huck8a824722006-11-20 17:07:51 +0100207{
208 return 0;
209}
210
Tejun Heo59f69012007-09-20 16:05:10 +0900211static inline int sysfs_create_file(struct kobject *kobj,
212 const struct attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213{
214 return 0;
215}
216
Andi Kleen1c205ae2010-01-05 12:48:01 +0100217static inline int sysfs_create_files(struct kobject *kobj,
218 const struct attribute **attr)
219{
220 return 0;
221}
222
Tejun Heo59f69012007-09-20 16:05:10 +0900223static inline int sysfs_chmod_file(struct kobject *kobj,
Al Viro48176a92011-07-24 03:40:40 -0400224 const struct attribute *attr, umode_t mode)
Kay Sievers31e5abe2005-04-18 21:57:32 -0700225{
226 return 0;
227}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
Tejun Heo59f69012007-09-20 16:05:10 +0900229static inline void sysfs_remove_file(struct kobject *kobj,
230 const struct attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232}
233
Andi Kleen1c205ae2010-01-05 12:48:01 +0100234static inline void sysfs_remove_files(struct kobject *kobj,
235 const struct attribute **attr)
236{
237}
238
Tejun Heo59f69012007-09-20 16:05:10 +0900239static inline int sysfs_create_bin_file(struct kobject *kobj,
Phil Carmody66ecb922009-12-18 15:34:20 +0200240 const struct bin_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241{
242 return 0;
243}
244
David Rientjes3612e062008-02-19 17:39:02 -0800245static inline void sysfs_remove_bin_file(struct kobject *kobj,
Phil Carmody66ecb922009-12-18 15:34:20 +0200246 const struct bin_attribute *attr)
Tejun Heo59f69012007-09-20 16:05:10 +0900247{
Tejun Heo59f69012007-09-20 16:05:10 +0900248}
249
250static inline int sysfs_create_link(struct kobject *kobj,
251 struct kobject *target, const char *name)
252{
253 return 0;
254}
255
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200256static inline int sysfs_create_link_nowarn(struct kobject *kobj,
257 struct kobject *target,
258 const char *name)
259{
260 return 0;
261}
262
Tejun Heo59f69012007-09-20 16:05:10 +0900263static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265}
266
Eric W. Biederman7cb32942010-02-12 19:22:25 -0800267static inline int sysfs_rename_link(struct kobject *k, struct kobject *t,
268 const char *old_name, const char *new_name)
269{
270 return 0;
271}
272
Eric W. Biederman746edb72010-03-30 11:31:28 -0700273static inline void sysfs_delete_link(struct kobject *k, struct kobject *t,
274 const char *name)
275{
276}
277
Tejun Heo59f69012007-09-20 16:05:10 +0900278static inline int sysfs_create_group(struct kobject *kobj,
279 const struct attribute_group *grp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280{
281 return 0;
282}
283
Randy Dunlap1cbfb7a2008-04-30 09:01:17 -0700284static inline int sysfs_update_group(struct kobject *kobj,
285 const struct attribute_group *grp)
286{
287 return 0;
288}
289
Tejun Heo59f69012007-09-20 16:05:10 +0900290static inline void sysfs_remove_group(struct kobject *kobj,
291 const struct attribute_group *grp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293}
294
Alan Sterndfa87c82007-02-20 15:02:44 -0500295static inline int sysfs_add_file_to_group(struct kobject *kobj,
296 const struct attribute *attr, const char *group)
297{
298 return 0;
299}
300
301static inline void sysfs_remove_file_from_group(struct kobject *kobj,
Ralf Baechled701d8a2007-03-01 12:40:21 +0000302 const struct attribute *attr, const char *group)
Alan Sterndfa87c82007-02-20 15:02:44 -0500303{
Alan Sterndfa87c82007-02-20 15:02:44 -0500304}
305
Alan Stern69d44ff2010-09-25 23:34:22 +0200306static inline int sysfs_merge_group(struct kobject *kobj,
307 const struct attribute_group *grp)
308{
309 return 0;
310}
311
312static inline void sysfs_unmerge_group(struct kobject *kobj,
313 const struct attribute_group *grp)
314{
315}
316
Trent Piepho8c0e3992008-09-25 16:45:13 -0700317static inline void sysfs_notify(struct kobject *kobj, const char *dir,
318 const char *attr)
NeilBrown4508a7a2006-03-20 17:53:53 +1100319{
320}
Neil Brownf1282c82008-07-16 08:58:04 +1000321static inline void sysfs_notify_dirent(struct sysfs_dirent *sd)
322{
323}
324static inline
325struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700326 const void *ns,
Neil Brownf1282c82008-07-16 08:58:04 +1000327 const unsigned char *name)
328{
329 return NULL;
330}
331static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
332{
333 return NULL;
334}
335static inline void sysfs_put(struct sysfs_dirent *sd)
336{
337}
NeilBrown4508a7a2006-03-20 17:53:53 +1100338
Andrew Mortonf20a9ea2006-08-14 22:43:23 -0700339static inline int __must_check sysfs_init(void)
340{
341 return 0;
342}
343
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344#endif /* CONFIG_SYSFS */
345
346#endif /* _SYSFS_H_ */