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;
71 unsigned int state_initialized:1;
72 unsigned int state_name_set:1;
73 unsigned int state_in_sysfs:1;
74 unsigned int state_add_uevent_sent:1;
75 unsigned int state_remove_uevent_sent:1;
78 extern int kobject_set_name(struct kobject *, const char *, ...)
79 __attribute__((format(printf,2,3)));
81 static inline const char * kobject_name(const struct kobject * kobj)
86 extern void kobject_init(struct kobject *kobj, struct kobj_type *ktype);
87 extern int __must_check kobject_add(struct kobject *kobj,
88 struct kobject *parent,
89 const char *fmt, ...);
90 extern int __must_check kobject_init_and_add(struct kobject *kobj,
91 struct kobj_type *ktype,
92 struct kobject *parent,
93 const char *fmt, ...);
95 extern void kobject_del(struct kobject *);
97 extern struct kobject * __must_check kobject_create(void);
98 extern struct kobject * __must_check kobject_create_and_add(const char *name,
99 struct kobject *parent);
101 extern int __must_check kobject_rename(struct kobject *, const char *new_name);
102 extern int __must_check kobject_move(struct kobject *, struct kobject *);
104 extern struct kobject * kobject_get(struct kobject *);
105 extern void kobject_put(struct kobject *);
107 extern char * kobject_get_path(struct kobject *, gfp_t);
110 void (*release)(struct kobject *);
111 struct sysfs_ops * sysfs_ops;
112 struct attribute ** default_attrs;
115 struct kobj_uevent_env {
116 char *envp[UEVENT_NUM_ENVP];
118 char buf[UEVENT_BUFFER_SIZE];
122 struct kset_uevent_ops {
123 int (*filter)(struct kset *kset, struct kobject *kobj);
124 const char *(*name)(struct kset *kset, struct kobject *kobj);
125 int (*uevent)(struct kset *kset, struct kobject *kobj,
126 struct kobj_uevent_env *env);
129 struct kobj_attribute {
130 struct attribute attr;
131 ssize_t (*show)(struct kobject *kobj, struct kobj_attribute *attr,
133 ssize_t (*store)(struct kobject *kobj, struct kobj_attribute *attr,
134 const char *buf, size_t count);
137 extern struct sysfs_ops kobj_sysfs_ops;
140 * struct kset - a set of kobjects of a specific type, belonging to a specific subsystem.
142 * A kset defines a group of kobjects. They can be individually
143 * different "types" but overall these kobjects all want to be grouped
144 * together and operated on in the same manner. ksets are used to
145 * define the attribute callbacks and other common events that happen to
148 * @list: the list of all kobjects for this kset
149 * @list_lock: a lock for iterating over the kobjects
150 * @kobj: the embedded kobject for this kset (recursion, isn't it fun...)
151 * @uevent_ops: the set of uevent operations for this kset. These are
152 * called whenever a kobject has something happen to it so that the kset
153 * can add new environment variables, or filter out the uevents if so
157 struct list_head list;
158 spinlock_t list_lock;
160 struct kset_uevent_ops *uevent_ops;
163 extern void kset_init(struct kset * k);
164 extern int __must_check kset_register(struct kset * k);
165 extern void kset_unregister(struct kset * k);
166 extern struct kset * __must_check kset_create_and_add(const char *name,
167 struct kset_uevent_ops *u,
168 struct kobject *parent_kobj);
170 static inline struct kset * to_kset(struct kobject * kobj)
172 return kobj ? container_of(kobj,struct kset,kobj) : NULL;
175 static inline struct kset * kset_get(struct kset * k)
177 return k ? to_kset(kobject_get(&k->kobj)) : NULL;
180 static inline void kset_put(struct kset * k)
182 kobject_put(&k->kobj);
185 static inline struct kobj_type *get_ktype(struct kobject *kobj)
190 extern struct kobject * kset_find_obj(struct kset *, const char *);
194 * Use this when initializing an embedded kset with no other
195 * fields to initialize.
197 #define set_kset_name(str) .kset = { .kobj = { .k_name = str } }
200 /* The global /sys/kernel/ kobject for people to chain off of */
201 extern struct kobject *kernel_kobj;
202 /* The global /sys/hypervisor/ kobject for people to chain off of */
203 extern struct kobject *hypervisor_kobj;
204 /* The global /sys/power/ kobject for people to chain off of */
205 extern struct kobject *power_kobj;
206 /* The global /sys/firmware/ kobject for people to chain off of */
207 extern struct kobject *firmware_kobj;
209 #if defined(CONFIG_HOTPLUG)
210 int kobject_uevent(struct kobject *kobj, enum kobject_action action);
211 int kobject_uevent_env(struct kobject *kobj, enum kobject_action action,
214 int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...)
215 __attribute__((format (printf, 2, 3)));
217 int kobject_action_type(const char *buf, size_t count,
218 enum kobject_action *type);
220 static inline int kobject_uevent(struct kobject *kobj, enum kobject_action action)
222 static inline int kobject_uevent_env(struct kobject *kobj,
223 enum kobject_action action,
227 static inline int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...)
230 static inline int kobject_action_type(const char *buf, size_t count,
231 enum kobject_action *type)
235 #endif /* __KERNEL__ */
236 #endif /* _KOBJECT_H_ */