igb: Simplify how we populate the RSS key
[linux-2.6/cjktty.git] / include / linux / sysfs.h
blob381f06db2fe508bd660dd6c10c247aa5aedb5dda
1 /*
2 * sysfs.h - definitions for the device driver filesystem
4 * Copyright (c) 2001,2002 Patrick Mochel
5 * Copyright (c) 2004 Silicon Graphics, Inc.
6 * Copyright (c) 2007 SUSE Linux Products GmbH
7 * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
9 * Please see Documentation/filesystems/sysfs.txt for more information.
12 #ifndef _SYSFS_H_
13 #define _SYSFS_H_
15 #include <linux/compiler.h>
16 #include <linux/errno.h>
17 #include <linux/list.h>
18 #include <linux/lockdep.h>
19 #include <linux/kobject_ns.h>
20 #include <linux/atomic.h>
22 struct kobject;
23 struct module;
24 enum kobj_ns_type;
26 struct attribute {
27 const char *name;
28 umode_t mode;
29 #ifdef CONFIG_DEBUG_LOCK_ALLOC
30 bool ignore_lockdep:1;
31 struct lock_class_key *key;
32 struct lock_class_key skey;
33 #endif
36 /**
37 * sysfs_attr_init - initialize a dynamically allocated sysfs attribute
38 * @attr: struct attribute to initialize
40 * Initialize a dynamically allocated struct attribute so we can
41 * make lockdep happy. This is a new requirement for attributes
42 * and initially this is only needed when lockdep is enabled.
43 * Lockdep gives a nice error when your attribute is added to
44 * sysfs if you don't have this.
46 #ifdef CONFIG_DEBUG_LOCK_ALLOC
47 #define sysfs_attr_init(attr) \
48 do { \
49 static struct lock_class_key __key; \
51 (attr)->key = &__key; \
52 } while(0)
53 #else
54 #define sysfs_attr_init(attr) do {} while(0)
55 #endif
57 struct attribute_group {
58 const char *name;
59 umode_t (*is_visible)(struct kobject *,
60 struct attribute *, int);
61 struct attribute **attrs;
66 /**
67 * Use these macros to make defining attributes easier. See include/linux/device.h
68 * for examples..
71 #define __ATTR(_name,_mode,_show,_store) { \
72 .attr = {.name = __stringify(_name), .mode = _mode }, \
73 .show = _show, \
74 .store = _store, \
77 #define __ATTR_RO(_name) { \
78 .attr = { .name = __stringify(_name), .mode = 0444 }, \
79 .show = _name##_show, \
82 #define __ATTR_NULL { .attr = { .name = NULL } }
84 #ifdef CONFIG_DEBUG_LOCK_ALLOC
85 #define __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) { \
86 .attr = {.name = __stringify(_name), .mode = _mode, \
87 .ignore_lockdep = true }, \
88 .show = _show, \
89 .store = _store, \
91 #else
92 #define __ATTR_IGNORE_LOCKDEP __ATTR
93 #endif
95 #define attr_name(_attr) (_attr).attr.name
97 struct file;
98 struct vm_area_struct;
100 struct bin_attribute {
101 struct attribute attr;
102 size_t size;
103 void *private;
104 ssize_t (*read)(struct file *, struct kobject *, struct bin_attribute *,
105 char *, loff_t, size_t);
106 ssize_t (*write)(struct file *,struct kobject *, struct bin_attribute *,
107 char *, loff_t, size_t);
108 int (*mmap)(struct file *, struct kobject *, struct bin_attribute *attr,
109 struct vm_area_struct *vma);
113 * sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
114 * @attr: struct bin_attribute to initialize
116 * Initialize a dynamically allocated struct bin_attribute so we
117 * can make lockdep happy. This is a new requirement for
118 * attributes and initially this is only needed when lockdep is
119 * enabled. Lockdep gives a nice error when your attribute is
120 * added to sysfs if you don't have this.
122 #define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr)
124 struct sysfs_ops {
125 ssize_t (*show)(struct kobject *, struct attribute *,char *);
126 ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t);
127 const void *(*namespace)(struct kobject *, const struct attribute *);
130 struct sysfs_dirent;
132 #ifdef CONFIG_SYSFS
134 int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
135 void *data, struct module *owner);
137 int __must_check sysfs_create_dir(struct kobject *kobj);
138 void sysfs_remove_dir(struct kobject *kobj);
139 int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name);
140 int __must_check sysfs_move_dir(struct kobject *kobj,
141 struct kobject *new_parent_kobj);
143 int __must_check sysfs_create_file(struct kobject *kobj,
144 const struct attribute *attr);
145 int __must_check sysfs_create_files(struct kobject *kobj,
146 const struct attribute **attr);
147 int __must_check sysfs_chmod_file(struct kobject *kobj,
148 const struct attribute *attr, umode_t mode);
149 void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr);
150 void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
152 int __must_check sysfs_create_bin_file(struct kobject *kobj,
153 const struct bin_attribute *attr);
154 void sysfs_remove_bin_file(struct kobject *kobj,
155 const struct bin_attribute *attr);
157 int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
158 const char *name);
159 int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
160 struct kobject *target,
161 const char *name);
162 void sysfs_remove_link(struct kobject *kobj, const char *name);
164 int sysfs_rename_link(struct kobject *kobj, struct kobject *target,
165 const char *old_name, const char *new_name);
167 void sysfs_delete_link(struct kobject *dir, struct kobject *targ,
168 const char *name);
170 int __must_check sysfs_create_group(struct kobject *kobj,
171 const struct attribute_group *grp);
172 int sysfs_update_group(struct kobject *kobj,
173 const struct attribute_group *grp);
174 void sysfs_remove_group(struct kobject *kobj,
175 const struct attribute_group *grp);
176 int sysfs_add_file_to_group(struct kobject *kobj,
177 const struct attribute *attr, const char *group);
178 void sysfs_remove_file_from_group(struct kobject *kobj,
179 const struct attribute *attr, const char *group);
180 int sysfs_merge_group(struct kobject *kobj,
181 const struct attribute_group *grp);
182 void sysfs_unmerge_group(struct kobject *kobj,
183 const struct attribute_group *grp);
185 void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
186 void sysfs_notify_dirent(struct sysfs_dirent *sd);
187 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
188 const void *ns,
189 const unsigned char *name);
190 struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd);
191 void sysfs_put(struct sysfs_dirent *sd);
193 int __must_check sysfs_init(void);
195 #else /* CONFIG_SYSFS */
197 static inline int sysfs_schedule_callback(struct kobject *kobj,
198 void (*func)(void *), void *data, struct module *owner)
200 return -ENOSYS;
203 static inline int sysfs_create_dir(struct kobject *kobj)
205 return 0;
208 static inline void sysfs_remove_dir(struct kobject *kobj)
212 static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
214 return 0;
217 static inline int sysfs_move_dir(struct kobject *kobj,
218 struct kobject *new_parent_kobj)
220 return 0;
223 static inline int sysfs_create_file(struct kobject *kobj,
224 const struct attribute *attr)
226 return 0;
229 static inline int sysfs_create_files(struct kobject *kobj,
230 const struct attribute **attr)
232 return 0;
235 static inline int sysfs_chmod_file(struct kobject *kobj,
236 const struct attribute *attr, umode_t mode)
238 return 0;
241 static inline void sysfs_remove_file(struct kobject *kobj,
242 const struct attribute *attr)
246 static inline void sysfs_remove_files(struct kobject *kobj,
247 const struct attribute **attr)
251 static inline int sysfs_create_bin_file(struct kobject *kobj,
252 const struct bin_attribute *attr)
254 return 0;
257 static inline void sysfs_remove_bin_file(struct kobject *kobj,
258 const struct bin_attribute *attr)
262 static inline int sysfs_create_link(struct kobject *kobj,
263 struct kobject *target, const char *name)
265 return 0;
268 static inline int sysfs_create_link_nowarn(struct kobject *kobj,
269 struct kobject *target,
270 const char *name)
272 return 0;
275 static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
279 static inline int sysfs_rename_link(struct kobject *k, struct kobject *t,
280 const char *old_name, const char *new_name)
282 return 0;
285 static inline void sysfs_delete_link(struct kobject *k, struct kobject *t,
286 const char *name)
290 static inline int sysfs_create_group(struct kobject *kobj,
291 const struct attribute_group *grp)
293 return 0;
296 static inline int sysfs_update_group(struct kobject *kobj,
297 const struct attribute_group *grp)
299 return 0;
302 static inline void sysfs_remove_group(struct kobject *kobj,
303 const struct attribute_group *grp)
307 static inline int sysfs_add_file_to_group(struct kobject *kobj,
308 const struct attribute *attr, const char *group)
310 return 0;
313 static inline void sysfs_remove_file_from_group(struct kobject *kobj,
314 const struct attribute *attr, const char *group)
318 static inline int sysfs_merge_group(struct kobject *kobj,
319 const struct attribute_group *grp)
321 return 0;
324 static inline void sysfs_unmerge_group(struct kobject *kobj,
325 const struct attribute_group *grp)
329 static inline void sysfs_notify(struct kobject *kobj, const char *dir,
330 const char *attr)
333 static inline void sysfs_notify_dirent(struct sysfs_dirent *sd)
336 static inline
337 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
338 const void *ns,
339 const unsigned char *name)
341 return NULL;
343 static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
345 return NULL;
347 static inline void sysfs_put(struct sysfs_dirent *sd)
351 static inline int __must_check sysfs_init(void)
353 return 0;
356 #endif /* CONFIG_SYSFS */
358 #endif /* _SYSFS_H_ */