blob: 7858eac40aa7be8e27f9091806f2b194eabedd61 [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
24 * The *owner field is no longer used, but leave around
25 * until the tree gets cleaned up fully.
26 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070027struct attribute {
Tejun Heo59f69012007-09-20 16:05:10 +090028 const char *name;
29 struct module *owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -070030 mode_t mode;
31};
32
33struct attribute_group {
Tejun Heo59f69012007-09-20 16:05:10 +090034 const char *name;
James Bottomley0f423892008-03-20 20:47:52 -050035 mode_t (*is_visible)(struct kobject *,
James Bottomleyd4acd722007-10-31 09:38:04 -050036 struct attribute *, int);
Tejun Heo59f69012007-09-20 16:05:10 +090037 struct attribute **attrs;
Linus Torvalds1da177e2005-04-16 15:20:36 -070038};
39
40
41
42/**
43 * Use these macros to make defining attributes easier. See include/linux/device.h
44 * for examples..
45 */
46
47#define __ATTR(_name,_mode,_show,_store) { \
Tejun Heo7b595752007-06-14 03:45:17 +090048 .attr = {.name = __stringify(_name), .mode = _mode }, \
Linus Torvalds1da177e2005-04-16 15:20:36 -070049 .show = _show, \
50 .store = _store, \
51}
52
53#define __ATTR_RO(_name) { \
Tejun Heo7b595752007-06-14 03:45:17 +090054 .attr = { .name = __stringify(_name), .mode = 0444 }, \
55 .show = _name##_show, \
Linus Torvalds1da177e2005-04-16 15:20:36 -070056}
57
58#define __ATTR_NULL { .attr = { .name = NULL } }
59
60#define attr_name(_attr) (_attr).attr.name
61
62struct vm_area_struct;
63
64struct bin_attribute {
65 struct attribute attr;
66 size_t size;
67 void *private;
Zhang Rui91a69022007-06-09 13:57:22 +080068 ssize_t (*read)(struct kobject *, struct bin_attribute *,
69 char *, loff_t, size_t);
70 ssize_t (*write)(struct kobject *, struct bin_attribute *,
71 char *, loff_t, size_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 int (*mmap)(struct kobject *, struct bin_attribute *attr,
73 struct vm_area_struct *vma);
74};
75
76struct sysfs_ops {
77 ssize_t (*show)(struct kobject *, struct attribute *,char *);
78 ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t);
79};
80
Linus Torvalds1da177e2005-04-16 15:20:36 -070081#ifdef CONFIG_SYSFS
82
Tejun Heo59f69012007-09-20 16:05:10 +090083int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
84 void *data, struct module *owner);
Alan Sternd9a9cdf2007-03-15 15:50:34 -040085
Tejun Heo59f69012007-09-20 16:05:10 +090086int __must_check sysfs_create_dir(struct kobject *kobj);
87void sysfs_remove_dir(struct kobject *kobj);
88int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name);
89int __must_check sysfs_move_dir(struct kobject *kobj,
90 struct kobject *new_parent_kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
Tejun Heo59f69012007-09-20 16:05:10 +090092int __must_check sysfs_create_file(struct kobject *kobj,
93 const struct attribute *attr);
Tejun Heo59f69012007-09-20 16:05:10 +090094int __must_check sysfs_chmod_file(struct kobject *kobj, struct attribute *attr,
95 mode_t mode);
96void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
Andrew Morton4a7fb632006-08-14 22:43:17 -070098int __must_check sysfs_create_bin_file(struct kobject *kobj,
Tejun Heo59f69012007-09-20 16:05:10 +090099 struct bin_attribute *attr);
Randy.Dunlap995982c2006-07-10 23:05:25 -0700100void sysfs_remove_bin_file(struct kobject *kobj, struct bin_attribute *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
Tejun Heo59f69012007-09-20 16:05:10 +0900102int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
103 const char *name);
104void sysfs_remove_link(struct kobject *kobj, const char *name);
Alan Sterndfa87c82007-02-20 15:02:44 -0500105
Tejun Heo59f69012007-09-20 16:05:10 +0900106int __must_check sysfs_create_group(struct kobject *kobj,
107 const struct attribute_group *grp);
James Bottomley0f423892008-03-20 20:47:52 -0500108int sysfs_update_group(struct kobject *kobj,
109 const struct attribute_group *grp);
Tejun Heo59f69012007-09-20 16:05:10 +0900110void sysfs_remove_group(struct kobject *kobj,
111 const struct attribute_group *grp);
112int sysfs_add_file_to_group(struct kobject *kobj,
113 const struct attribute *attr, const char *group);
114void sysfs_remove_file_from_group(struct kobject *kobj,
115 const struct attribute *attr, const char *group);
116
117void sysfs_notify(struct kobject *kobj, char *dir, char *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
Andrew Mortonf20a9ea2006-08-14 22:43:23 -0700119extern int __must_check sysfs_init(void);
120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121#else /* CONFIG_SYSFS */
122
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400123static inline int sysfs_schedule_callback(struct kobject *kobj,
Alan Stern523ded72007-04-26 00:12:04 -0700124 void (*func)(void *), void *data, struct module *owner)
Alan Sternd9a9cdf2007-03-15 15:50:34 -0400125{
126 return -ENOSYS;
127}
128
Tejun Heo59f69012007-09-20 16:05:10 +0900129static inline int sysfs_create_dir(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130{
131 return 0;
132}
133
Tejun Heo59f69012007-09-20 16:05:10 +0900134static inline void sysfs_remove_dir(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136}
137
Tejun Heo59f69012007-09-20 16:05:10 +0900138static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139{
140 return 0;
141}
142
Tejun Heo59f69012007-09-20 16:05:10 +0900143static inline int sysfs_move_dir(struct kobject *kobj,
144 struct kobject *new_parent_kobj)
Cornelia Huck8a824722006-11-20 17:07:51 +0100145{
146 return 0;
147}
148
Tejun Heo59f69012007-09-20 16:05:10 +0900149static inline int sysfs_create_file(struct kobject *kobj,
150 const struct attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151{
152 return 0;
153}
154
Tejun Heo59f69012007-09-20 16:05:10 +0900155static inline int sysfs_chmod_file(struct kobject *kobj,
156 struct attribute *attr, mode_t mode)
Kay Sievers31e5abe2005-04-18 21:57:32 -0700157{
158 return 0;
159}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
Tejun Heo59f69012007-09-20 16:05:10 +0900161static inline void sysfs_remove_file(struct kobject *kobj,
162 const struct attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164}
165
Tejun Heo59f69012007-09-20 16:05:10 +0900166static inline int sysfs_create_bin_file(struct kobject *kobj,
167 struct bin_attribute *attr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168{
169 return 0;
170}
171
David Rientjes3612e062008-02-19 17:39:02 -0800172static inline void sysfs_remove_bin_file(struct kobject *kobj,
173 struct bin_attribute *attr)
Tejun Heo59f69012007-09-20 16:05:10 +0900174{
Tejun Heo59f69012007-09-20 16:05:10 +0900175}
176
177static inline int sysfs_create_link(struct kobject *kobj,
178 struct kobject *target, const char *name)
179{
180 return 0;
181}
182
183static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185}
186
Tejun Heo59f69012007-09-20 16:05:10 +0900187static inline int sysfs_create_group(struct kobject *kobj,
188 const struct attribute_group *grp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189{
190 return 0;
191}
192
Randy Dunlap1cbfb7a2008-04-30 09:01:17 -0700193static inline int sysfs_update_group(struct kobject *kobj,
194 const struct attribute_group *grp)
195{
196 return 0;
197}
198
Tejun Heo59f69012007-09-20 16:05:10 +0900199static inline void sysfs_remove_group(struct kobject *kobj,
200 const struct attribute_group *grp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202}
203
Alan Sterndfa87c82007-02-20 15:02:44 -0500204static inline int sysfs_add_file_to_group(struct kobject *kobj,
205 const struct attribute *attr, const char *group)
206{
207 return 0;
208}
209
210static inline void sysfs_remove_file_from_group(struct kobject *kobj,
Ralf Baechled701d8a2007-03-01 12:40:21 +0000211 const struct attribute *attr, const char *group)
Alan Sterndfa87c82007-02-20 15:02:44 -0500212{
Alan Sterndfa87c82007-02-20 15:02:44 -0500213}
214
Tejun Heo59f69012007-09-20 16:05:10 +0900215static inline void sysfs_notify(struct kobject *kobj, char *dir, char *attr)
NeilBrown4508a7a2006-03-20 17:53:53 +1100216{
217}
218
Andrew Mortonf20a9ea2006-08-14 22:43:23 -0700219static inline int __must_check sysfs_init(void)
220{
221 return 0;
222}
223
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224#endif /* CONFIG_SYSFS */
225
226#endif /* _SYSFS_H_ */