blob: c3acda60eee0819f9735e059b925ed739bf5831e [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <asm/atomic.h>
21
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;
Linus Torvalds1da177e2005-04-16 15:20:36 -070028 mode_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;
James Bottomley0f423892008-03-20 20:47:52 -050058 mode_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);
115};
116
Neil Brownf1282c82008-07-16 08:58:04 +1000117struct sysfs_dirent;
118
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119#ifdef CONFIG_SYSFS
120
Tejun Heo59f69012007-09-20 16:05:10 +0900121int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
122 void *data, struct module *owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400123
Tejun Heo59f69012007-09-20 16:05:10 +0900124int __must_check sysfs_create_dir(struct kobject *kobj);
125void sysfs_remove_dir(struct kobject *kobj);
126int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name);
127int __must_check sysfs_move_dir(struct kobject *kobj,
128 struct kobject *new_parent_kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
Tejun Heo59f69012007-09-20 16:05:10 +0900130int __must_check sysfs_create_file(struct kobject *kobj,
131 const struct attribute *attr);
Andi Kleen1c205ae2010-01-05 12:48:01 +0100132int __must_check sysfs_create_files(struct kobject *kobj,
133 const struct attribute **attr);
Jean Delvare49c19402010-07-02 16:54:05 +0200134int __must_check sysfs_chmod_file(struct kobject *kobj,
135 const struct attribute *attr, mode_t mode);
Tejun Heo59f69012007-09-20 16:05:10 +0900136void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr);
Andi Kleen1c205ae2010-01-05 12:48:01 +0100137void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
Andrew Morton4a7fb632006-08-14 22:43:17 -0700139int __must_check sysfs_create_bin_file(struct kobject *kobj,
Phil Carmody66ecb922009-12-18 15:34:20 +0200140 const struct bin_attribute *attr);
141void sysfs_remove_bin_file(struct kobject *kobj,
142 const struct bin_attribute *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
Tejun Heo59f69012007-09-20 16:05:10 +0900144int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
145 const char *name);
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200146int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
147 struct kobject *target,
148 const char *name);
Tejun Heo59f69012007-09-20 16:05:10 +0900149void sysfs_remove_link(struct kobject *kobj, const char *name);
Alan Sterndfa87c82007-02-20 15:02:44 -0500150
Eric W. Biederman7cb32942010-02-12 19:22:25 -0800151int sysfs_rename_link(struct kobject *kobj, struct kobject *target,
152 const char *old_name, const char *new_name);
153
Eric W. Biederman746edb72010-03-30 11:31:28 -0700154void sysfs_delete_link(struct kobject *dir, struct kobject *targ,
155 const char *name);
156
Tejun Heo59f69012007-09-20 16:05:10 +0900157int __must_check sysfs_create_group(struct kobject *kobj,
158 const struct attribute_group *grp);
James Bottomley0f423892008-03-20 20:47:52 -0500159int sysfs_update_group(struct kobject *kobj,
160 const struct attribute_group *grp);
Tejun Heo59f69012007-09-20 16:05:10 +0900161void sysfs_remove_group(struct kobject *kobj,
162 const struct attribute_group *grp);
163int sysfs_add_file_to_group(struct kobject *kobj,
164 const struct attribute *attr, const char *group);
165void sysfs_remove_file_from_group(struct kobject *kobj,
166 const struct attribute *attr, const char *group);
Alan Stern69d44ff2010-09-25 23:34:22 +0200167int sysfs_merge_group(struct kobject *kobj,
168 const struct attribute_group *grp);
169void sysfs_unmerge_group(struct kobject *kobj,
170 const struct attribute_group *grp);
Tejun Heo59f69012007-09-20 16:05:10 +0900171
Trent Piepho8c0e3992008-09-25 16:45:13 -0700172void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
Neil Brownf1282c82008-07-16 08:58:04 +1000173void sysfs_notify_dirent(struct sysfs_dirent *sd);
174struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700175 const void *ns,
Neil Brownf1282c82008-07-16 08:58:04 +1000176 const unsigned char *name);
177struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd);
178void sysfs_put(struct sysfs_dirent *sd);
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700179
Serge E. Hallynbe867b12010-05-03 16:23:15 -0500180/* Called to clear a ns tag when it is no longer valid */
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700181void sysfs_exit_ns(enum kobj_ns_type type, const void *tag);
182
Neil Brownf1282c82008-07-16 08:58:04 +1000183int __must_check sysfs_init(void);
Andrew Mortonf20a9ea2006-08-14 22:43:23 -0700184
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185#else /* CONFIG_SYSFS */
186
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400187static inline int sysfs_schedule_callback(struct kobject *kobj,
Alan Stern523ded72007-04-26 00:12:04 -0700188 void (*func)(void *), void *data, struct module *owner)
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400189{
190 return -ENOSYS;
191}
192
Tejun Heo59f69012007-09-20 16:05:10 +0900193static inline int sysfs_create_dir(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194{
195 return 0;
196}
197
Tejun Heo59f69012007-09-20 16:05:10 +0900198static inline void sysfs_remove_dir(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200}
201
Tejun Heo59f69012007-09-20 16:05:10 +0900202static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203{
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700204 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205}
206
Tejun Heo59f69012007-09-20 16:05:10 +0900207static inline int sysfs_move_dir(struct kobject *kobj,
208 struct kobject *new_parent_kobj)
Cornelia Huck8a824722006-11-20 17:07:51 +0100209{
210 return 0;
211}
212
Tejun Heo59f69012007-09-20 16:05:10 +0900213static inline int sysfs_create_file(struct kobject *kobj,
214 const struct attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215{
216 return 0;
217}
218
Andi Kleen1c205ae2010-01-05 12:48:01 +0100219static inline int sysfs_create_files(struct kobject *kobj,
220 const struct attribute **attr)
221{
222 return 0;
223}
224
Tejun Heo59f69012007-09-20 16:05:10 +0900225static inline int sysfs_chmod_file(struct kobject *kobj,
Jean Delvare49c19402010-07-02 16:54:05 +0200226 const struct attribute *attr, mode_t mode)
Kay Sievers31e5abe2005-04-18 21:57:32 -0700227{
228 return 0;
229}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
Tejun Heo59f69012007-09-20 16:05:10 +0900231static inline void sysfs_remove_file(struct kobject *kobj,
232 const struct attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234}
235
Andi Kleen1c205ae2010-01-05 12:48:01 +0100236static inline void sysfs_remove_files(struct kobject *kobj,
237 const struct attribute **attr)
238{
239}
240
Tejun Heo59f69012007-09-20 16:05:10 +0900241static inline int sysfs_create_bin_file(struct kobject *kobj,
Phil Carmody66ecb922009-12-18 15:34:20 +0200242 const struct bin_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243{
244 return 0;
245}
246
David Rientjes3612e062008-02-19 17:39:02 -0800247static inline void sysfs_remove_bin_file(struct kobject *kobj,
Phil Carmody66ecb922009-12-18 15:34:20 +0200248 const struct bin_attribute *attr)
Tejun Heo59f69012007-09-20 16:05:10 +0900249{
Tejun Heo59f69012007-09-20 16:05:10 +0900250}
251
252static inline int sysfs_create_link(struct kobject *kobj,
253 struct kobject *target, const char *name)
254{
255 return 0;
256}
257
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200258static inline int sysfs_create_link_nowarn(struct kobject *kobj,
259 struct kobject *target,
260 const char *name)
261{
262 return 0;
263}
264
Tejun Heo59f69012007-09-20 16:05:10 +0900265static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267}
268
Eric W. Biederman7cb32942010-02-12 19:22:25 -0800269static inline int sysfs_rename_link(struct kobject *k, struct kobject *t,
270 const char *old_name, const char *new_name)
271{
272 return 0;
273}
274
Eric W. Biederman746edb72010-03-30 11:31:28 -0700275static inline void sysfs_delete_link(struct kobject *k, struct kobject *t,
276 const char *name)
277{
278}
279
Tejun Heo59f69012007-09-20 16:05:10 +0900280static inline int sysfs_create_group(struct kobject *kobj,
281 const struct attribute_group *grp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282{
283 return 0;
284}
285
Randy Dunlap1cbfb7a2008-04-30 09:01:17 -0700286static inline int sysfs_update_group(struct kobject *kobj,
287 const struct attribute_group *grp)
288{
289 return 0;
290}
291
Tejun Heo59f69012007-09-20 16:05:10 +0900292static inline void sysfs_remove_group(struct kobject *kobj,
293 const struct attribute_group *grp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295}
296
Alan Sterndfa87c82007-02-20 15:02:44 -0500297static inline int sysfs_add_file_to_group(struct kobject *kobj,
298 const struct attribute *attr, const char *group)
299{
300 return 0;
301}
302
303static inline void sysfs_remove_file_from_group(struct kobject *kobj,
Ralf Baechled701d8a2007-03-01 12:40:21 +0000304 const struct attribute *attr, const char *group)
Alan Sterndfa87c82007-02-20 15:02:44 -0500305{
Alan Sterndfa87c82007-02-20 15:02:44 -0500306}
307
Alan Stern69d44ff2010-09-25 23:34:22 +0200308static inline int sysfs_merge_group(struct kobject *kobj,
309 const struct attribute_group *grp)
310{
311 return 0;
312}
313
314static inline void sysfs_unmerge_group(struct kobject *kobj,
315 const struct attribute_group *grp)
316{
317}
318
Trent Piepho8c0e3992008-09-25 16:45:13 -0700319static inline void sysfs_notify(struct kobject *kobj, const char *dir,
320 const char *attr)
NeilBrown4508a7a2006-03-20 17:53:53 +1100321{
322}
Neil Brownf1282c82008-07-16 08:58:04 +1000323static inline void sysfs_notify_dirent(struct sysfs_dirent *sd)
324{
325}
326static inline
327struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700328 const void *ns,
Neil Brownf1282c82008-07-16 08:58:04 +1000329 const unsigned char *name)
330{
331 return NULL;
332}
333static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
334{
335 return NULL;
336}
337static inline void sysfs_put(struct sysfs_dirent *sd)
338{
339}
NeilBrown4508a7a2006-03-20 17:53:53 +1100340
Eric W. Biederman27eabc72010-05-05 14:54:00 -0700341static inline void sysfs_exit_ns(int type, const void *tag)
Eric W. Biederman3ff195b2010-03-30 11:31:26 -0700342{
343}
344
Andrew Mortonf20a9ea2006-08-14 22:43:23 -0700345static inline int __must_check sysfs_init(void)
346{
347 return 0;
348}
349
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350#endif /* CONFIG_SYSFS */
351
352#endif /* _SYSFS_H_ */