blob: 1ea5d3cda6ae2374056769173d6bd56fa9fd4128 [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.
6 *
7 * Please see Documentation/filesystems/sysfs.txt for more information.
8 */
9
10#ifndef _SYSFS_H_
11#define _SYSFS_H_
12
13#include <asm/atomic.h>
14
15struct kobject;
16struct module;
17
18struct attribute {
Dmitry Torokhovd48593b2005-04-29 00:58:46 -050019 const char * name;
Linus Torvalds1da177e2005-04-16 15:20:36 -070020 struct module * owner;
21 mode_t mode;
22};
23
24struct attribute_group {
Dmitry Torokhovd48593b2005-04-29 00:58:46 -050025 const char * name;
Linus Torvalds1da177e2005-04-16 15:20:36 -070026 struct attribute ** attrs;
27};
28
29
30
31/**
32 * Use these macros to make defining attributes easier. See include/linux/device.h
33 * for examples..
34 */
35
36#define __ATTR(_name,_mode,_show,_store) { \
37 .attr = {.name = __stringify(_name), .mode = _mode, .owner = THIS_MODULE }, \
38 .show = _show, \
39 .store = _store, \
40}
41
42#define __ATTR_RO(_name) { \
43 .attr = { .name = __stringify(_name), .mode = 0444, .owner = THIS_MODULE }, \
44 .show = _name##_show, \
45}
46
47#define __ATTR_NULL { .attr = { .name = NULL } }
48
49#define attr_name(_attr) (_attr).attr.name
50
51struct vm_area_struct;
52
53struct bin_attribute {
54 struct attribute attr;
55 size_t size;
56 void *private;
57 ssize_t (*read)(struct kobject *, char *, loff_t, size_t);
58 ssize_t (*write)(struct kobject *, char *, loff_t, size_t);
59 int (*mmap)(struct kobject *, struct bin_attribute *attr,
60 struct vm_area_struct *vma);
61};
62
63struct sysfs_ops {
64 ssize_t (*show)(struct kobject *, struct attribute *,char *);
65 ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t);
66};
67
68struct sysfs_dirent {
69 atomic_t s_count;
70 struct list_head s_sibling;
71 struct list_head s_children;
72 void * s_element;
73 int s_type;
74 umode_t s_mode;
75 struct dentry * s_dentry;
Maneesh Soni988d1862005-05-31 10:39:14 +053076 struct iattr * s_iattr;
NeilBrown4508a7a2006-03-20 17:53:53 +110077 atomic_t s_event;
Linus Torvalds1da177e2005-04-16 15:20:36 -070078};
79
80#define SYSFS_ROOT 0x0001
81#define SYSFS_DIR 0x0002
82#define SYSFS_KOBJ_ATTR 0x0004
83#define SYSFS_KOBJ_BIN_ATTR 0x0008
84#define SYSFS_KOBJ_LINK 0x0020
85#define SYSFS_NOT_PINNED (SYSFS_KOBJ_ATTR | SYSFS_KOBJ_BIN_ATTR | SYSFS_KOBJ_LINK)
86
87#ifdef CONFIG_SYSFS
88
89extern int
90sysfs_create_dir(struct kobject *);
91
92extern void
93sysfs_remove_dir(struct kobject *);
94
95extern int
96sysfs_rename_dir(struct kobject *, const char *new_name);
97
98extern int
99sysfs_create_file(struct kobject *, const struct attribute *);
100
101extern int
102sysfs_update_file(struct kobject *, const struct attribute *);
103
Kay Sievers31e5abe2005-04-18 21:57:32 -0700104extern int
105sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode);
106
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107extern void
108sysfs_remove_file(struct kobject *, const struct attribute *);
109
Dmitry Torokhove3a15db2005-04-26 02:31:08 -0500110extern int
111sysfs_create_link(struct kobject * kobj, struct kobject * target, const char * name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
113extern void
Dmitry Torokhove3a15db2005-04-26 02:31:08 -0500114sysfs_remove_link(struct kobject *, const char * name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115
116int sysfs_create_bin_file(struct kobject * kobj, struct bin_attribute * attr);
117int sysfs_remove_bin_file(struct kobject * kobj, struct bin_attribute * attr);
118
119int sysfs_create_group(struct kobject *, const struct attribute_group *);
120void sysfs_remove_group(struct kobject *, const struct attribute_group *);
NeilBrown4508a7a2006-03-20 17:53:53 +1100121void sysfs_notify(struct kobject * k, char *dir, char *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
123#else /* CONFIG_SYSFS */
124
125static inline int sysfs_create_dir(struct kobject * k)
126{
127 return 0;
128}
129
130static inline void sysfs_remove_dir(struct kobject * k)
131{
132 ;
133}
134
135static inline int sysfs_rename_dir(struct kobject * k, const char *new_name)
136{
137 return 0;
138}
139
140static inline int sysfs_create_file(struct kobject * k, const struct attribute * a)
141{
142 return 0;
143}
144
145static inline int sysfs_update_file(struct kobject * k, const struct attribute * a)
146{
147 return 0;
148}
Kay Sievers31e5abe2005-04-18 21:57:32 -0700149static inline int sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode)
150{
151 return 0;
152}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153
154static inline void sysfs_remove_file(struct kobject * k, const struct attribute * a)
155{
156 ;
157}
158
Dmitry Torokhove3a15db2005-04-26 02:31:08 -0500159static inline int sysfs_create_link(struct kobject * k, struct kobject * t, const char * n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160{
161 return 0;
162}
163
Dmitry Torokhove3a15db2005-04-26 02:31:08 -0500164static inline void sysfs_remove_link(struct kobject * k, const char * name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165{
166 ;
167}
168
169
170static inline int sysfs_create_bin_file(struct kobject * k, struct bin_attribute * a)
171{
172 return 0;
173}
174
175static inline int sysfs_remove_bin_file(struct kobject * k, struct bin_attribute * a)
176{
177 return 0;
178}
179
180static inline int sysfs_create_group(struct kobject * k, const struct attribute_group *g)
181{
182 return 0;
183}
184
185static inline void sysfs_remove_group(struct kobject * k, const struct attribute_group * g)
186{
187 ;
188}
189
NeilBrown4508a7a2006-03-20 17:53:53 +1100190static inline void sysfs_notify(struct kobject * k, char *dir, char *attr)
191{
192}
193
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194#endif /* CONFIG_SYSFS */
195
196#endif /* _SYSFS_H_ */