2 * kobject.h - generic kernel object infrastructure.
4 * Copyright (c) 2002-2003 Patrick Mochel
5 * Copyright (c) 2002-2003 Open Source Development Labs
6 * Copyright (c) 2006-2007 Greg Kroah-Hartman <greg@kroah.com>
7 * Copyright (c) 2006-2007 Novell Inc.
9 * This file is released under the GPLv2.
12 * Please read Documentation/kobject.txt before using the kobject
13 * interface, ESPECIALLY the parts about reference counts and object
22 #include <linux/types.h>
23 #include <linux/list.h>
24 #include <linux/sysfs.h>
25 #include <linux/compiler.h>
26 #include <linux/spinlock.h>
27 #include <linux/kref.h>
28 #include <linux/kernel.h>
29 #include <linux/wait.h>
30 #include <asm/atomic.h>
32 #define KOBJ_NAME_LEN 20
33 #define UEVENT_HELPER_PATH_LEN 256
34 #define UEVENT_NUM_ENVP 32 /* number of env pointers */
35 #define UEVENT_BUFFER_SIZE 2048 /* buffer for the variables */
37 /* path to the userspace helper executed on an event */
38 extern char uevent_helper
[];
40 /* counter to tag the uevent, read only except for the kobject core */
41 extern u64 uevent_seqnum
;
44 * The actions here must match the index to the string array
45 * in lib/kobject_uevent.c
47 * Do not add new actions here without checking with the driver-core
48 * maintainers. Action strings are not meant to express subsystem
49 * or device specific properties. In most cases you want to send a
50 * kobject_uevent_env(kobj, KOBJ_CHANGE, env) with additional event
51 * specific variables added to the event environment.
66 struct list_head entry
;
67 struct kobject
* parent
;
69 struct kobj_type
* ktype
;
70 struct sysfs_dirent
* sd
;
73 extern int kobject_set_name(struct kobject
*, const char *, ...)
74 __attribute__((format(printf
,2,3)));
76 static inline const char * kobject_name(const struct kobject
* kobj
)
81 extern void kobject_init_ng(struct kobject
*kobj
, struct kobj_type
*ktype
);
82 extern int __must_check
kobject_add(struct kobject
*kobj
,
83 struct kobject
*parent
,
84 const char *fmt
, ...);
85 extern int __must_check
kobject_init_and_add(struct kobject
*kobj
,
86 struct kobj_type
*ktype
,
87 struct kobject
*parent
,
88 const char *fmt
, ...);
90 extern void kobject_del(struct kobject
*);
92 extern struct kobject
* __must_check
kobject_create(void);
93 extern struct kobject
* __must_check
kobject_create_and_add(const char *name
,
94 struct kobject
*parent
);
96 extern int __must_check
kobject_rename(struct kobject
*, const char *new_name
);
97 extern int __must_check
kobject_move(struct kobject
*, struct kobject
*);
99 extern int __must_check
kobject_register(struct kobject
*);
100 extern void kobject_unregister(struct kobject
*);
102 extern struct kobject
* kobject_get(struct kobject
*);
103 extern void kobject_put(struct kobject
*);
105 extern char * kobject_get_path(struct kobject
*, gfp_t
);
108 void (*release
)(struct kobject
*);
109 struct sysfs_ops
* sysfs_ops
;
110 struct attribute
** default_attrs
;
113 struct kobj_uevent_env
{
114 char *envp
[UEVENT_NUM_ENVP
];
116 char buf
[UEVENT_BUFFER_SIZE
];
120 struct kset_uevent_ops
{
121 int (*filter
)(struct kset
*kset
, struct kobject
*kobj
);
122 const char *(*name
)(struct kset
*kset
, struct kobject
*kobj
);
123 int (*uevent
)(struct kset
*kset
, struct kobject
*kobj
,
124 struct kobj_uevent_env
*env
);
127 struct kobj_attribute
{
128 struct attribute attr
;
129 ssize_t (*show
)(struct kobject
*kobj
, struct kobj_attribute
*attr
,
131 ssize_t (*store
)(struct kobject
*kobj
, struct kobj_attribute
*attr
,
132 const char *buf
, size_t count
);
135 extern struct sysfs_ops kobj_sysfs_ops
;
138 * struct kset - a set of kobjects of a specific type, belonging to a specific subsystem.
140 * A kset defines a group of kobjects. They can be individually
141 * different "types" but overall these kobjects all want to be grouped
142 * together and operated on in the same manner. ksets are used to
143 * define the attribute callbacks and other common events that happen to
146 * @list: the list of all kobjects for this kset
147 * @list_lock: a lock for iterating over the kobjects
148 * @kobj: the embedded kobject for this kset (recursion, isn't it fun...)
149 * @uevent_ops: the set of uevent operations for this kset. These are
150 * called whenever a kobject has something happen to it so that the kset
151 * can add new environment variables, or filter out the uevents if so
155 struct list_head list
;
156 spinlock_t list_lock
;
158 struct kset_uevent_ops
*uevent_ops
;
161 extern void kset_init(struct kset
* k
);
162 extern int __must_check
kset_add(struct kset
* k
);
163 extern int __must_check
kset_register(struct kset
* k
);
164 extern void kset_unregister(struct kset
* k
);
165 extern struct kset
* __must_check
kset_create_and_add(const char *name
,
166 struct kset_uevent_ops
*u
,
167 struct kobject
*parent_kobj
);
169 static inline struct kset
* to_kset(struct kobject
* kobj
)
171 return kobj
? container_of(kobj
,struct kset
,kobj
) : NULL
;
174 static inline struct kset
* kset_get(struct kset
* k
)
176 return k
? to_kset(kobject_get(&k
->kobj
)) : NULL
;
179 static inline void kset_put(struct kset
* k
)
181 kobject_put(&k
->kobj
);
184 static inline struct kobj_type
*get_ktype(struct kobject
*kobj
)
189 extern struct kobject
* kset_find_obj(struct kset
*, const char *);
193 * Use this when initializing an embedded kset with no other
194 * fields to initialize.
196 #define set_kset_name(str) .kset = { .kobj = { .k_name = str } }
199 /* The global /sys/kernel/ kobject for people to chain off of */
200 extern struct kobject
*kernel_kobj
;
201 /* The global /sys/hypervisor/ kobject for people to chain off of */
202 extern struct kobject
*hypervisor_kobj
;
203 /* The global /sys/power/ kobject for people to chain off of */
204 extern struct kobject
*power_kobj
;
205 /* The global /sys/firmware/ kobject for people to chain off of */
206 extern struct kobject
*firmware_kobj
;
208 #if defined(CONFIG_HOTPLUG)
209 int kobject_uevent(struct kobject
*kobj
, enum kobject_action action
);
210 int kobject_uevent_env(struct kobject
*kobj
, enum kobject_action action
,
213 int add_uevent_var(struct kobj_uevent_env
*env
, const char *format
, ...)
214 __attribute__((format (printf
, 2, 3)));
216 int kobject_action_type(const char *buf
, size_t count
,
217 enum kobject_action
*type
);
219 static inline int kobject_uevent(struct kobject
*kobj
, enum kobject_action action
)
221 static inline int kobject_uevent_env(struct kobject
*kobj
,
222 enum kobject_action action
,
226 static inline int add_uevent_var(struct kobj_uevent_env
*env
, const char *format
, ...)
229 static inline int kobject_action_type(const char *buf
, size_t count
,
230 enum kobject_action
*type
)
234 #endif /* __KERNEL__ */
235 #endif /* _KOBJECT_H_ */