blob: 9d68fed50f119423904db7d7f608fd4baede5a82 [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <asm/atomic.h>
19
20struct kobject;
21struct module;
22
Tejun Heo7b595752007-06-14 03:45:17 +090023/* FIXME
Parag Warudkar01e8ef12008-10-18 20:28:50 -070024 * The *owner field is no longer used.
25 * x86 tree has been cleaned up. The owner
26 * attribute is still left for other arches.
Tejun Heo7b595752007-06-14 03:45:17 +090027 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070028struct attribute {
Tejun Heo59f69012007-09-20 16:05:10 +090029 const char *name;
30 struct module *owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -070031 mode_t mode;
32};
33
34struct attribute_group {
Tejun Heo59f69012007-09-20 16:05:10 +090035 const char *name;
James Bottomley0f423892008-03-20 20:47:52 -050036 mode_t (*is_visible)(struct kobject *,
James Bottomleyd4acd722007-10-31 09:38:04 -050037 struct attribute *, int);
Tejun Heo59f69012007-09-20 16:05:10 +090038 struct attribute **attrs;
Linus Torvalds1da177e2005-04-16 15:20:36 -070039};
40
41
42
43/**
44 * Use these macros to make defining attributes easier. See include/linux/device.h
45 * for examples..
46 */
47
48#define __ATTR(_name,_mode,_show,_store) { \
Tejun Heo7b595752007-06-14 03:45:17 +090049 .attr = {.name = __stringify(_name), .mode = _mode }, \
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 .show = _show, \
51 .store = _store, \
52}
53
54#define __ATTR_RO(_name) { \
Tejun Heo7b595752007-06-14 03:45:17 +090055 .attr = { .name = __stringify(_name), .mode = 0444 }, \
56 .show = _name##_show, \
Linus Torvalds1da177e2005-04-16 15:20:36 -070057}
58
59#define __ATTR_NULL { .attr = { .name = NULL } }
60
61#define attr_name(_attr) (_attr).attr.name
62
63struct vm_area_struct;
64
65struct bin_attribute {
66 struct attribute attr;
67 size_t size;
68 void *private;
Zhang Rui91a69022007-06-09 13:57:22 +080069 ssize_t (*read)(struct kobject *, struct bin_attribute *,
70 char *, loff_t, size_t);
71 ssize_t (*write)(struct kobject *, struct bin_attribute *,
72 char *, loff_t, size_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 int (*mmap)(struct kobject *, struct bin_attribute *attr,
74 struct vm_area_struct *vma);
75};
76
77struct sysfs_ops {
78 ssize_t (*show)(struct kobject *, struct attribute *,char *);
79 ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t);
80};
81
Neil Brownf1282c82008-07-16 08:58:04 +100082struct sysfs_dirent;
83
Linus Torvalds1da177e2005-04-16 15:20:36 -070084#ifdef CONFIG_SYSFS
85
Tejun Heo59f69012007-09-20 16:05:10 +090086int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
87 void *data, struct module *owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -040088
Tejun Heo59f69012007-09-20 16:05:10 +090089int __must_check sysfs_create_dir(struct kobject *kobj);
90void sysfs_remove_dir(struct kobject *kobj);
91int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name);
92int __must_check sysfs_move_dir(struct kobject *kobj,
93 struct kobject *new_parent_kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
Tejun Heo59f69012007-09-20 16:05:10 +090095int __must_check sysfs_create_file(struct kobject *kobj,
96 const struct attribute *attr);
Tejun Heo59f69012007-09-20 16:05:10 +090097int __must_check sysfs_chmod_file(struct kobject *kobj, struct attribute *attr,
98 mode_t mode);
99void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
Andrew Morton4a7fb632006-08-14 22:43:17 -0700101int __must_check sysfs_create_bin_file(struct kobject *kobj,
Tejun Heo59f69012007-09-20 16:05:10 +0900102 struct bin_attribute *attr);
Randy.Dunlap995982c2006-07-10 23:05:25 -0700103void sysfs_remove_bin_file(struct kobject *kobj, struct bin_attribute *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
Tejun Heo59f69012007-09-20 16:05:10 +0900105int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
106 const char *name);
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200107int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
108 struct kobject *target,
109 const char *name);
Tejun Heo59f69012007-09-20 16:05:10 +0900110void sysfs_remove_link(struct kobject *kobj, const char *name);
Alan Sterndfa87c82007-02-20 15:02:44 -0500111
Tejun Heo59f69012007-09-20 16:05:10 +0900112int __must_check sysfs_create_group(struct kobject *kobj,
113 const struct attribute_group *grp);
James Bottomley0f423892008-03-20 20:47:52 -0500114int sysfs_update_group(struct kobject *kobj,
115 const struct attribute_group *grp);
Tejun Heo59f69012007-09-20 16:05:10 +0900116void sysfs_remove_group(struct kobject *kobj,
117 const struct attribute_group *grp);
118int sysfs_add_file_to_group(struct kobject *kobj,
119 const struct attribute *attr, const char *group);
120void sysfs_remove_file_from_group(struct kobject *kobj,
121 const struct attribute *attr, const char *group);
122
Trent Piepho8c0e3992008-09-25 16:45:13 -0700123void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
Neil Brownf1282c82008-07-16 08:58:04 +1000124void sysfs_notify_dirent(struct sysfs_dirent *sd);
125struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
126 const unsigned char *name);
127struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd);
128void sysfs_put(struct sysfs_dirent *sd);
Andrew Mortonae872212007-08-24 16:11:54 -0700129void sysfs_printk_last_file(void);
Neil Brownf1282c82008-07-16 08:58:04 +1000130int __must_check sysfs_init(void);
Andrew Mortonf20a9ea2006-08-14 22:43:23 -0700131
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132#else /* CONFIG_SYSFS */
133
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400134static inline int sysfs_schedule_callback(struct kobject *kobj,
Alan Stern523ded72007-04-26 00:12:04 -0700135 void (*func)(void *), void *data, struct module *owner)
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400136{
137 return -ENOSYS;
138}
139
Tejun Heo59f69012007-09-20 16:05:10 +0900140static inline int sysfs_create_dir(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141{
142 return 0;
143}
144
Tejun Heo59f69012007-09-20 16:05:10 +0900145static inline void sysfs_remove_dir(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147}
148
Tejun Heo59f69012007-09-20 16:05:10 +0900149static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150{
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700151 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152}
153
Tejun Heo59f69012007-09-20 16:05:10 +0900154static inline int sysfs_move_dir(struct kobject *kobj,
155 struct kobject *new_parent_kobj)
Cornelia Huck8a824722006-11-20 17:07:51 +0100156{
157 return 0;
158}
159
Tejun Heo59f69012007-09-20 16:05:10 +0900160static inline int sysfs_create_file(struct kobject *kobj,
161 const struct attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162{
163 return 0;
164}
165
Tejun Heo59f69012007-09-20 16:05:10 +0900166static inline int sysfs_chmod_file(struct kobject *kobj,
167 struct attribute *attr, mode_t mode)
Kay Sievers31e5abe2005-04-18 21:57:32 -0700168{
169 return 0;
170}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
Tejun Heo59f69012007-09-20 16:05:10 +0900172static inline void sysfs_remove_file(struct kobject *kobj,
173 const struct attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175}
176
Tejun Heo59f69012007-09-20 16:05:10 +0900177static inline int sysfs_create_bin_file(struct kobject *kobj,
178 struct bin_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179{
180 return 0;
181}
182
David Rientjes3612e062008-02-19 17:39:02 -0800183static inline void sysfs_remove_bin_file(struct kobject *kobj,
184 struct bin_attribute *attr)
Tejun Heo59f69012007-09-20 16:05:10 +0900185{
Tejun Heo59f69012007-09-20 16:05:10 +0900186}
187
188static inline int sysfs_create_link(struct kobject *kobj,
189 struct kobject *target, const char *name)
190{
191 return 0;
192}
193
Cornelia Huck36ce6da2008-06-10 11:09:08 +0200194static inline int sysfs_create_link_nowarn(struct kobject *kobj,
195 struct kobject *target,
196 const char *name)
197{
198 return 0;
199}
200
Tejun Heo59f69012007-09-20 16:05:10 +0900201static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203}
204
Tejun Heo59f69012007-09-20 16:05:10 +0900205static inline int sysfs_create_group(struct kobject *kobj,
206 const struct attribute_group *grp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207{
208 return 0;
209}
210
Randy Dunlap1cbfb7a2008-04-30 09:01:17 -0700211static inline int sysfs_update_group(struct kobject *kobj,
212 const struct attribute_group *grp)
213{
214 return 0;
215}
216
Tejun Heo59f69012007-09-20 16:05:10 +0900217static inline void sysfs_remove_group(struct kobject *kobj,
218 const struct attribute_group *grp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220}
221
Alan Sterndfa87c82007-02-20 15:02:44 -0500222static inline int sysfs_add_file_to_group(struct kobject *kobj,
223 const struct attribute *attr, const char *group)
224{
225 return 0;
226}
227
228static inline void sysfs_remove_file_from_group(struct kobject *kobj,
Ralf Baechled701d8a2007-03-01 12:40:21 +0000229 const struct attribute *attr, const char *group)
Alan Sterndfa87c82007-02-20 15:02:44 -0500230{
Alan Sterndfa87c82007-02-20 15:02:44 -0500231}
232
Trent Piepho8c0e3992008-09-25 16:45:13 -0700233static inline void sysfs_notify(struct kobject *kobj, const char *dir,
234 const char *attr)
NeilBrown4508a7a2006-03-20 17:53:53 +1100235{
236}
Neil Brownf1282c82008-07-16 08:58:04 +1000237static inline void sysfs_notify_dirent(struct sysfs_dirent *sd)
238{
239}
240static inline
241struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
242 const unsigned char *name)
243{
244 return NULL;
245}
246static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
247{
248 return NULL;
249}
250static inline void sysfs_put(struct sysfs_dirent *sd)
251{
252}
NeilBrown4508a7a2006-03-20 17:53:53 +1100253
Andrew Mortonf20a9ea2006-08-14 22:43:23 -0700254static inline int __must_check sysfs_init(void)
255{
256 return 0;
257}
258
Andrew Mortonae872212007-08-24 16:11:54 -0700259static inline void sysfs_printk_last_file(void)
260{
261}
262
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263#endif /* CONFIG_SYSFS */
264
265#endif /* _SYSFS_H_ */