Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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.
6 *
7 * Please see Documentation/filesystems/sysfs.txt for more information.
8 */
9
10#ifndef _SYSFS_H_
11#define _SYSFS_H_
12
13#include <linux/compiler.h>
14#include <linux/list.h>
15#include <asm/atomic.h>
16
17struct kobject;
18struct module;
19struct nameidata;
20struct dentry;
21
22struct attribute {
23 const char * name;
24 struct module * owner;
25 mode_t mode;
26};
27
28struct attribute_group {
29 const char * name;
30 struct attribute ** attrs;
31};
32
33
34
35/**
36 * Use these macros to make defining attributes easier. See include/linux/device.h
37 * for examples..
38 */
39
40#define __ATTR(_name,_mode,_show,_store) { \
41 .attr = {.name = __stringify(_name), .mode = _mode, .owner = THIS_MODULE }, \
42 .show = _show, \
43 .store = _store, \
44}
45
46#define __ATTR_RO(_name) { \
47 .attr = { .name = __stringify(_name), .mode = 0444, .owner = THIS_MODULE }, \
48 .show = _name##_show, \
49}
50
51#define __ATTR_NULL { .attr = { .name = NULL } }
52
53#define attr_name(_attr) (_attr).attr.name
54
55struct vm_area_struct;
56
57struct bin_attribute {
58 struct attribute attr;
59 size_t size;
60 void *private;
61 ssize_t (*read)(struct kobject *, char *, loff_t, size_t);
62 ssize_t (*write)(struct kobject *, char *, loff_t, size_t);
63 int (*mmap)(struct kobject *, struct bin_attribute *attr,
64 struct vm_area_struct *vma);
65};
66
67struct sysfs_ops {
68 ssize_t (*show)(struct kobject *, struct attribute *,char *);
69 ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t);
70};
71
72#define SYSFS_ROOT 0x0001
73#define SYSFS_DIR 0x0002
74#define SYSFS_KOBJ_ATTR 0x0004
75#define SYSFS_KOBJ_BIN_ATTR 0x0008
76#define SYSFS_KOBJ_LINK 0x0020
77#define SYSFS_NOT_PINNED (SYSFS_KOBJ_ATTR | SYSFS_KOBJ_BIN_ATTR | SYSFS_KOBJ_LINK)
78
79#ifdef CONFIG_SYSFS
80
81extern int sysfs_schedule_callback(struct kobject *kobj,
82 void (*func)(void *), void *data);
83
84extern int __must_check
85sysfs_create_dir(struct kobject *, struct dentry *);
86
87extern void
88sysfs_remove_dir(struct kobject *);
89
90extern int __must_check
91sysfs_rename_dir(struct kobject *, struct dentry *, const char *new_name);
92
93extern int __must_check
94sysfs_move_dir(struct kobject *, struct kobject *);
95
96extern int __must_check
97sysfs_create_file(struct kobject *, const struct attribute *);
98
99extern int __must_check
100sysfs_update_file(struct kobject *, const struct attribute *);
101
102extern int __must_check
103sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode);
104
105extern void
106sysfs_remove_file(struct kobject *, const struct attribute *);
107
108extern int __must_check
109sysfs_create_link(struct kobject * kobj, struct kobject * target, const char * name);
110
111extern void
112sysfs_remove_link(struct kobject *, const char * name);
113
114int __must_check sysfs_create_bin_file(struct kobject *kobj,
115 struct bin_attribute *attr);
116void sysfs_remove_bin_file(struct kobject *kobj, struct bin_attribute *attr);
117
118int __must_check sysfs_create_group(struct kobject *,
119 const struct attribute_group *);
120void sysfs_remove_group(struct kobject *, const struct attribute_group *);
121int sysfs_add_file_to_group(struct kobject *kobj,
122 const struct attribute *attr, const char *group);
123void sysfs_remove_file_from_group(struct kobject *kobj,
124 const struct attribute *attr, const char *group);
125
126void sysfs_notify(struct kobject * k, char *dir, char *attr);
127
128
129extern int sysfs_make_shadowed_dir(struct kobject *kobj,
130 void * (*follow_link)(struct dentry *, struct nameidata *));
131extern struct dentry *sysfs_create_shadow_dir(struct kobject *kobj);
132extern void sysfs_remove_shadow_dir(struct dentry *dir);
133
134extern int __must_check sysfs_init(void);
135
136#else /* CONFIG_SYSFS */
137
138static inline int sysfs_schedule_callback(struct kobject *kobj,
139 void (*func)(void *), void *data)
140{
141 return -ENOSYS;
142}
143
144static inline int sysfs_create_dir(struct kobject * k, struct dentry *shadow)
145{
146 return 0;
147}
148
149static inline void sysfs_remove_dir(struct kobject * k)
150{
151 ;
152}
153
154static inline int sysfs_rename_dir(struct kobject * k,
155 struct dentry *new_parent,
156 const char *new_name)
157{
158 return 0;
159}
160
161static inline int sysfs_move_dir(struct kobject * k, struct kobject * new_parent)
162{
163 return 0;
164}
165
166static inline int sysfs_create_file(struct kobject * k, const struct attribute * a)
167{
168 return 0;
169}
170
171static inline int sysfs_update_file(struct kobject * k, const struct attribute * a)
172{
173 return 0;
174}
175static inline int sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode)
176{
177 return 0;
178}
179
180static inline void sysfs_remove_file(struct kobject * k, const struct attribute * a)
181{
182 ;
183}
184
185static inline int sysfs_create_link(struct kobject * k, struct kobject * t, const char * n)
186{
187 return 0;
188}
189
190static inline void sysfs_remove_link(struct kobject * k, const char * name)
191{
192 ;
193}
194
195
196static inline int sysfs_create_bin_file(struct kobject * k, struct bin_attribute * a)
197{
198 return 0;
199}
200
201static inline int sysfs_remove_bin_file(struct kobject * k, struct bin_attribute * a)
202{
203 return 0;
204}
205
206static inline int sysfs_create_group(struct kobject * k, const struct attribute_group *g)
207{
208 return 0;
209}
210
211static inline void sysfs_remove_group(struct kobject * k, const struct attribute_group * g)
212{
213 ;
214}
215
216static inline int sysfs_add_file_to_group(struct kobject *kobj,
217 const struct attribute *attr, const char *group)
218{
219 return 0;
220}
221
222static inline void sysfs_remove_file_from_group(struct kobject *kobj,
223 const struct attribute *attr, const char *group)
224{
225}
226
227static inline void sysfs_notify(struct kobject * k, char *dir, char *attr)
228{
229}
230
231static inline int sysfs_make_shadowed_dir(struct kobject *kobj,
232 void * (*follow_link)(struct dentry *, struct nameidata *))
233{
234 return 0;
235}
236
237static inline int __must_check sysfs_init(void)
238{
239 return 0;
240}
241
242#endif /* CONFIG_SYSFS */
243
244#endif /* _SYSFS_H_ */