]>
git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blob - include/linux/sysfs.h
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.
15 #include <linux/compiler.h>
16 #include <linux/errno.h>
17 #include <linux/list.h>
18 #include <linux/lockdep.h>
19 #include <asm/atomic.h>
26 * The *owner field is no longer used.
27 * x86 tree has been cleaned up. The owner
28 * attribute is still left for other arches.
34 #ifdef CONFIG_DEBUG_LOCK_ALLOC
35 struct lock_class_key
*key
;
36 struct lock_class_key skey
;
41 * sysfs_attr_init - initialize a dynamically allocated sysfs attribute
42 * @attr: struct attribute to initialize
44 * Initialize a dynamically allocated struct attribute so we can
45 * make lockdep happy. This is a new requirement for attributes
46 * and initially this is only needed when lockdep is enabled.
47 * Lockdep gives a nice error when your attribute is added to
48 * sysfs if you don't have this.
50 #ifdef CONFIG_DEBUG_LOCK_ALLOC
51 #define sysfs_attr_init(attr) \
53 static struct lock_class_key __key; \
55 (attr)->key = &__key; \
58 #define sysfs_attr_init(attr) do {} while(0)
61 struct attribute_group
{
63 mode_t (*is_visible
)(struct kobject
*,
64 struct attribute
*, int);
65 struct attribute
**attrs
;
71 * Use these macros to make defining attributes easier. See include/linux/device.h
75 #define __ATTR(_name,_mode,_show,_store) { \
76 .attr = {.name = __stringify(_name), .mode = _mode }, \
81 #define __ATTR_RO(_name) { \
82 .attr = { .name = __stringify(_name), .mode = 0444 }, \
83 .show = _name##_show, \
86 #define __ATTR_NULL { .attr = { .name = NULL } }
88 #define attr_name(_attr) (_attr).attr.name
91 struct vm_area_struct
;
93 struct bin_attribute
{
94 struct attribute attr
;
97 ssize_t (*read
)(struct file
*, struct kobject
*, struct bin_attribute
*,
98 char *, loff_t
, size_t);
99 ssize_t (*write
)(struct file
*,struct kobject
*, struct bin_attribute
*,
100 char *, loff_t
, size_t);
101 int (*mmap
)(struct file
*, struct kobject
*, struct bin_attribute
*attr
,
102 struct vm_area_struct
*vma
);
106 * sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
107 * @attr: struct bin_attribute to initialize
109 * Initialize a dynamically allocated struct bin_attribute so we
110 * can make lockdep happy. This is a new requirement for
111 * attributes and initially this is only needed when lockdep is
112 * enabled. Lockdep gives a nice error when your attribute is
113 * added to sysfs if you don't have this.
115 #define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr)
118 ssize_t (*show
)(struct kobject
*, struct attribute
*,char *);
119 ssize_t (*store
)(struct kobject
*,struct attribute
*,const char *, size_t);
126 int sysfs_schedule_callback(struct kobject
*kobj
, void (*func
)(void *),
127 void *data
, struct module
*owner
);
129 int __must_check
sysfs_create_dir(struct kobject
*kobj
);
130 void sysfs_remove_dir(struct kobject
*kobj
);
131 int __must_check
sysfs_rename_dir(struct kobject
*kobj
, const char *new_name
);
132 int __must_check
sysfs_move_dir(struct kobject
*kobj
,
133 struct kobject
*new_parent_kobj
);
135 int __must_check
sysfs_create_file(struct kobject
*kobj
,
136 const struct attribute
*attr
);
137 int __must_check
sysfs_create_files(struct kobject
*kobj
,
138 const struct attribute
**attr
);
139 int __must_check
sysfs_chmod_file(struct kobject
*kobj
, struct attribute
*attr
,
141 void sysfs_remove_file(struct kobject
*kobj
, const struct attribute
*attr
);
142 void sysfs_remove_files(struct kobject
*kobj
, const struct attribute
**attr
);
144 int __must_check
sysfs_create_bin_file(struct kobject
*kobj
,
145 const struct bin_attribute
*attr
);
146 void sysfs_remove_bin_file(struct kobject
*kobj
,
147 const struct bin_attribute
*attr
);
149 int __must_check
sysfs_create_link(struct kobject
*kobj
, struct kobject
*target
,
151 int __must_check
sysfs_create_link_nowarn(struct kobject
*kobj
,
152 struct kobject
*target
,
154 void sysfs_remove_link(struct kobject
*kobj
, const char *name
);
156 int sysfs_rename_link(struct kobject
*kobj
, struct kobject
*target
,
157 const char *old_name
, const char *new_name
);
159 void sysfs_delete_link(struct kobject
*dir
, struct kobject
*targ
,
162 int __must_check
sysfs_create_group(struct kobject
*kobj
,
163 const struct attribute_group
*grp
);
164 int sysfs_update_group(struct kobject
*kobj
,
165 const struct attribute_group
*grp
);
166 void sysfs_remove_group(struct kobject
*kobj
,
167 const struct attribute_group
*grp
);
168 int sysfs_add_file_to_group(struct kobject
*kobj
,
169 const struct attribute
*attr
, const char *group
);
170 void sysfs_remove_file_from_group(struct kobject
*kobj
,
171 const struct attribute
*attr
, const char *group
);
173 void sysfs_notify(struct kobject
*kobj
, const char *dir
, const char *attr
);
174 void sysfs_notify_dirent(struct sysfs_dirent
*sd
);
175 struct sysfs_dirent
*sysfs_get_dirent(struct sysfs_dirent
*parent_sd
,
177 const unsigned char *name
);
178 struct sysfs_dirent
*sysfs_get(struct sysfs_dirent
*sd
);
179 void sysfs_put(struct sysfs_dirent
*sd
);
180 void sysfs_printk_last_file(void);
182 /* Called to clear a ns tag when it is no longer valid */
183 void sysfs_exit_ns(enum kobj_ns_type type
, const void *tag
);
185 int __must_check
sysfs_init(void);
187 #else /* CONFIG_SYSFS */
189 static inline int sysfs_schedule_callback(struct kobject
*kobj
,
190 void (*func
)(void *), void *data
, struct module
*owner
)
195 static inline int sysfs_create_dir(struct kobject
*kobj
)
200 static inline void sysfs_remove_dir(struct kobject
*kobj
)
204 static inline int sysfs_rename_dir(struct kobject
*kobj
, const char *new_name
)
209 static inline int sysfs_move_dir(struct kobject
*kobj
,
210 struct kobject
*new_parent_kobj
)
215 static inline int sysfs_create_file(struct kobject
*kobj
,
216 const struct attribute
*attr
)
221 static inline int sysfs_create_files(struct kobject
*kobj
,
222 const struct attribute
**attr
)
227 static inline int sysfs_chmod_file(struct kobject
*kobj
,
228 struct attribute
*attr
, mode_t mode
)
233 static inline void sysfs_remove_file(struct kobject
*kobj
,
234 const struct attribute
*attr
)
238 static inline void sysfs_remove_files(struct kobject
*kobj
,
239 const struct attribute
**attr
)
243 static inline int sysfs_create_bin_file(struct kobject
*kobj
,
244 const struct bin_attribute
*attr
)
249 static inline void sysfs_remove_bin_file(struct kobject
*kobj
,
250 const struct bin_attribute
*attr
)
254 static inline int sysfs_create_link(struct kobject
*kobj
,
255 struct kobject
*target
, const char *name
)
260 static inline int sysfs_create_link_nowarn(struct kobject
*kobj
,
261 struct kobject
*target
,
267 static inline void sysfs_remove_link(struct kobject
*kobj
, const char *name
)
271 static inline int sysfs_rename_link(struct kobject
*k
, struct kobject
*t
,
272 const char *old_name
, const char *new_name
)
277 static inline void sysfs_delete_link(struct kobject
*k
, struct kobject
*t
,
282 static inline int sysfs_create_group(struct kobject
*kobj
,
283 const struct attribute_group
*grp
)
288 static inline int sysfs_update_group(struct kobject
*kobj
,
289 const struct attribute_group
*grp
)
294 static inline void sysfs_remove_group(struct kobject
*kobj
,
295 const struct attribute_group
*grp
)
299 static inline int sysfs_add_file_to_group(struct kobject
*kobj
,
300 const struct attribute
*attr
, const char *group
)
305 static inline void sysfs_remove_file_from_group(struct kobject
*kobj
,
306 const struct attribute
*attr
, const char *group
)
310 static inline void sysfs_notify(struct kobject
*kobj
, const char *dir
,
314 static inline void sysfs_notify_dirent(struct sysfs_dirent
*sd
)
318 struct sysfs_dirent
*sysfs_get_dirent(struct sysfs_dirent
*parent_sd
,
320 const unsigned char *name
)
324 static inline struct sysfs_dirent
*sysfs_get(struct sysfs_dirent
*sd
)
328 static inline void sysfs_put(struct sysfs_dirent
*sd
)
332 static inline void sysfs_exit_ns(int type
, const void *tag
)
336 static inline int __must_check
sysfs_init(void)
341 static inline void sysfs_printk_last_file(void)
345 #endif /* CONFIG_SYSFS */
347 #endif /* _SYSFS_H_ */