[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / kobject.h

/*
 * kobject.h - generic kernel object infrastructure.
 *
 * Copyright (c) 2002-2003	Patrick Mochel
 * Copyright (c) 2002-2003	Open Source Development Labs
 *
 * This file is released under the GPLv2.
 *
 * 
 * Please read Documentation/kobject.txt before using the kobject
 * interface, ESPECIALLY the parts about reference counts and object
 * destructors. 
 */

#ifndef _KOBJECT_H_
#define _KOBJECT_H_

#ifdef __KERNEL__

#include <linux/types.h>
#include <linux/list.h>
#include <linux/sysfs.h>
#include <linux/compiler.h>
#include <linux/spinlock.h>
#include <linux/kref.h>
#include <linux/kernel.h>
#include <linux/wait.h>
#include <asm/atomic.h>

#define KOBJ_NAME_LEN			20
#define UEVENT_HELPER_PATH_LEN		256

/* path to the userspace helper executed on an event */
extern char uevent_helper[];

/* counter to tag the uevent, read only except for the kobject core */
extern u64 uevent_seqnum;

/* the actions here must match the proper string in lib/kobject_uevent.c */
typedef int __bitwise kobject_action_t;
enum kobject_action {
	KOBJ_ADD	= (__force kobject_action_t) 0x01,	/* exclusive to core */
	KOBJ_REMOVE	= (__force kobject_action_t) 0x02,	/* exclusive to core */
	KOBJ_CHANGE	= (__force kobject_action_t) 0x03,	/* device state change */
	KOBJ_OFFLINE	= (__force kobject_action_t) 0x04,	/* device offline */
	KOBJ_ONLINE	= (__force kobject_action_t) 0x05,	/* device online */
	KOBJ_MOVE	= (__force kobject_action_t) 0x06,	/* device move */
};

struct kobject {
	const char		* k_name;
	char			name[KOBJ_NAME_LEN];
	struct kref		kref;
	struct list_head	entry;
	struct kobject		* parent;
	struct kset		* kset;
	struct kobj_type	* ktype;
	struct sysfs_dirent	* sd;
	wait_queue_head_t	poll;
};

extern int kobject_set_name(struct kobject *, const char *, ...)
	__attribute__((format(printf,2,3)));

static inline const char * kobject_name(const struct kobject * kobj)
{
	return kobj->k_name;
}

extern void kobject_init(struct kobject *);
extern void kobject_cleanup(struct kobject *);

extern int __must_check kobject_add(struct kobject *);
extern int __must_check kobject_shadow_add(struct kobject *kobj,
					   struct sysfs_dirent *shadow_parent);
extern void kobject_del(struct kobject *);

extern int __must_check kobject_rename(struct kobject *, const char *new_name);
extern int __must_check kobject_shadow_rename(struct kobject *kobj,
					      struct sysfs_dirent *new_parent,
					      const char *new_name);
extern int __must_check kobject_move(struct kobject *, struct kobject *);

extern int __must_check kobject_register(struct kobject *);
extern void kobject_unregister(struct kobject *);

extern struct kobject * kobject_get(struct kobject *);
extern void kobject_put(struct kobject *);

extern struct kobject *kobject_kset_add_dir(struct kset *kset,
					    struct kobject *, const char *);
extern struct kobject *kobject_add_dir(struct kobject *, const char *);

extern char * kobject_get_path(struct kobject *, gfp_t);

struct kobj_type {
	void (*release)(struct kobject *);
	struct sysfs_ops	* sysfs_ops;
	struct attribute	** default_attrs;
};


/**
 *	kset - a set of kobjects of a specific type, belonging
 *	to a specific subsystem.
 *
 *	All kobjects of a kset should be embedded in an identical 
 *	type. This type may have a descriptor, which the kset points
 *	to. This allows there to exist sets of objects of the same
 *	type in different subsystems.
 *
 *	A subsystem does not have to be a list of only one type 
 *	of object; multiple ksets can belong to one subsystem. All 
 *	ksets of a subsystem share the subsystem's lock.
 *
 *	Each kset can support specific event variables; it can
 *	supress the event generation or add subsystem specific
 *	variables carried with the event.
 */
struct kset_uevent_ops {
	int (*filter)(struct kset *kset, struct kobject *kobj);
	const char *(*name)(struct kset *kset, struct kobject *kobj);
	int (*uevent)(struct kset *kset, struct kobject *kobj, char **envp,
			int num_envp, char *buffer, int buffer_size);
};

struct kset {
	struct kobj_type	* ktype;
	struct list_head	list;
	spinlock_t		list_lock;
	struct kobject		kobj;
	struct kset_uevent_ops	* uevent_ops;
};


extern void kset_init(struct kset * k);
extern int __must_check kset_add(struct kset * k);
extern int __must_check kset_register(struct kset * k);
extern void kset_unregister(struct kset * k);

static inline struct kset * to_kset(struct kobject * kobj)
{
	return kobj ? container_of(kobj,struct kset,kobj) : NULL;
}

static inline struct kset * kset_get(struct kset * k)
{
	return k ? to_kset(kobject_get(&k->kobj)) : NULL;
}

static inline void kset_put(struct kset * k)
{
	kobject_put(&k->kobj);
}

static inline struct kobj_type * get_ktype(struct kobject * k)
{
	if (k->kset && k->kset->ktype)
		return k->kset->ktype;
	else 
		return k->ktype;
}

extern struct kobject * kset_find_obj(struct kset *, const char *);


/**
 * Use this when initializing an embedded kset with no other 
 * fields to initialize.
 */
#define set_kset_name(str)	.kset = { .kobj = { .name = str } }


#define decl_subsys(_name,_type,_uevent_ops) \
struct kset _name##_subsys = { \
	.kobj = { .name = __stringify(_name) }, \
	.ktype = _type, \
	.uevent_ops =_uevent_ops, \
}
#define decl_subsys_name(_varname,_name,_type,_uevent_ops) \
struct kset _varname##_subsys = { \
	.kobj = { .name = __stringify(_name) }, \
	.ktype = _type, \
	.uevent_ops =_uevent_ops, \
}

/* The global /sys/kernel/ subsystem for people to chain off of */
extern struct kset kernel_subsys;
/* The global /sys/hypervisor/ subsystem  */
extern struct kset hypervisor_subsys;

/**
 * Helpers for setting the kset of registered objects.
 * Often, a registered object belongs to a kset embedded in a 
 * subsystem. These do no magic, just make the resulting code
 * easier to follow. 
 */

/**
 *	kobj_set_kset_s(obj,subsys) - set kset for embedded kobject.
 *	@obj:		ptr to some object type.
 *	@subsys:	a subsystem object (not a ptr).
 *
 *	Can be used for any object type with an embedded ->kobj.
 */

#define kobj_set_kset_s(obj,subsys) \
	(obj)->kobj.kset = &(subsys)

/**
 *	kset_set_kset_s(obj,subsys) - set kset for embedded kset.
 *	@obj:		ptr to some object type.
 *	@subsys:	a subsystem object (not a ptr).
 *
 *	Can be used for any object type with an embedded ->kset.
 *	Sets the kset of @obj's  embedded kobject (via its embedded
 *	kset) to @subsys.kset. This makes @obj a member of that 
 *	kset.
 */

#define kset_set_kset_s(obj,subsys) \
	(obj)->kset.kobj.kset = &(subsys)

/**
 *	subsys_set_kset(obj,subsys) - set kset for subsystem
 *	@obj:		ptr to some object type.
 *	@subsys:	a subsystem object (not a ptr).
 *
 *	Can be used for any object type with an embedded ->subsys.
 *	Sets the kset of @obj's kobject to @subsys.kset. This makes
 *	the object a member of that kset.
 */

#define subsys_set_kset(obj,_subsys) \
	(obj)->subsys.kobj.kset = &(_subsys)

extern void subsystem_init(struct kset *);
extern int __must_check subsystem_register(struct kset *);
extern void subsystem_unregister(struct kset *);

static inline struct kset *subsys_get(struct kset *s)
{
	if (s)
		return kset_get(s);
	return NULL;
}

static inline void subsys_put(struct kset *s)
{
	kset_put(s);
}

struct subsys_attribute {
	struct attribute attr;
	ssize_t (*show)(struct kset *, char *);
	ssize_t (*store)(struct kset *, const char *, size_t);
};

extern int __must_check subsys_create_file(struct kset *,
					struct subsys_attribute *);

#if defined(CONFIG_HOTPLUG)
int kobject_uevent(struct kobject *kobj, enum kobject_action action);
int kobject_uevent_env(struct kobject *kobj, enum kobject_action action,
			char *envp[]);

int add_uevent_var(char **envp, int num_envp, int *cur_index,
			char *buffer, int buffer_size, int *cur_len,
			const char *format, ...)
	__attribute__((format (printf, 7, 8)));
#else
static inline int kobject_uevent(struct kobject *kobj, enum kobject_action action)
{ return 0; }
static inline int kobject_uevent_env(struct kobject *kobj,
				      enum kobject_action action,
				      char *envp[])
{ return 0; }

static inline int add_uevent_var(char **envp, int num_envp, int *cur_index,
				      char *buffer, int buffer_size, int *cur_len, 
				      const char *format, ...)
{ return 0; }
#endif

#endif /* __KERNEL__ */
#endif /* _KOBJECT_H_ */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* kobject.h - generic kernel object infrastructure.
	3	*
	4	* Copyright (c) 2002-2003 Patrick Mochel
	5	* Copyright (c) 2002-2003 Open Source Development Labs
	6	*
	7	* This file is released under the GPLv2.
	8	*
	9	*
	10	* Please read Documentation/kobject.txt before using the kobject
	11	* interface, ESPECIALLY the parts about reference counts and object
	12	* destructors.
	13	*/
	14
	15	#ifndef _KOBJECT_H_
	16	#define _KOBJECT_H_
	17
	18	#ifdef __KERNEL__
	19
	20	#include <linux/types.h>
	21	#include <linux/list.h>
	22	#include <linux/sysfs.h>
4a7fb636	23	#include <linux/compiler.h>
1da177e4	24	#include <linux/spinlock.h>
1da177e4	25	#include <linux/kref.h>
1da177e4	26	#include <linux/kernel.h>
4508a7a7	27	#include <linux/wait.h>
1da177e4 LT	28	#include <asm/atomic.h>
1da177e4 LT	29
312c004d KS	30	#define KOBJ_NAME_LEN 20
312c004d KS	31	#define UEVENT_HELPER_PATH_LEN 256
0296b228 KS	32
0296b228 KS	33	/* path to the userspace helper executed on an event */
312c004d	34	extern char uevent_helper[];
0296b228	35
312c004d KS	36	/* counter to tag the uevent, read only except for the kobject core */
312c004d KS	37	extern u64 uevent_seqnum;
1da177e4	38
0296b228 KS	39	/* the actions here must match the proper string in lib/kobject_uevent.c */
	40	typedef int __bitwise kobject_action_t;
	41	enum kobject_action {
5f123fbd KS	42	KOBJ_ADD = (__force kobject_action_t) 0x01, /* exclusive to core */
	43	KOBJ_REMOVE = (__force kobject_action_t) 0x02, /* exclusive to core */
	44	KOBJ_CHANGE = (__force kobject_action_t) 0x03, /* device state change */
3106d46f AB	45	KOBJ_OFFLINE = (__force kobject_action_t) 0x04, /* device offline */
	46	KOBJ_ONLINE = (__force kobject_action_t) 0x05, /* device online */
	47	KOBJ_MOVE = (__force kobject_action_t) 0x06, /* device move */
0296b228 KS	48	};
0296b228 KS	49
1da177e4	50	struct kobject {
f3b4f3c6	51	const char * k_name;
1da177e4 LT	52	char name[KOBJ_NAME_LEN];
	53	struct kref kref;
	54	struct list_head entry;
	55	struct kobject * parent;
	56	struct kset * kset;
	57	struct kobj_type * ktype;
608e266a	58	struct sysfs_dirent * sd;
4508a7a7	59	wait_queue_head_t poll;
1da177e4 LT	60	};
	61
	62	extern int kobject_set_name(struct kobject , const char , ...)
	63	__attribute__((format(printf,2,3)));
	64
f3b4f3c6	65	static inline const char * kobject_name(const struct kobject * kobj)
1da177e4 LT	66	{
	67	return kobj->k_name;
	68	}
	69
	70	extern void kobject_init(struct kobject *);
	71	extern void kobject_cleanup(struct kobject *);
	72
4a7fb636	73	extern int __must_check kobject_add(struct kobject *);
608e266a TH	74	extern int __must_check kobject_shadow_add(struct kobject *kobj,
608e266a TH	75	struct sysfs_dirent *shadow_parent);
1da177e4 LT	76	extern void kobject_del(struct kobject *);
1da177e4 LT	77
4a7fb636	78	extern int __must_check kobject_rename(struct kobject , const char new_name);
b592fcfe	79	extern int __must_check kobject_shadow_rename(struct kobject *kobj,
608e266a TH	80	struct sysfs_dirent *new_parent,
608e266a TH	81	const char *new_name);
8a82472f	82	extern int __must_check kobject_move(struct kobject , struct kobject );
1da177e4	83
4a7fb636	84	extern int __must_check kobject_register(struct kobject *);
1da177e4 LT	85	extern void kobject_unregister(struct kobject *);
	86
	87	extern struct kobject * kobject_get(struct kobject *);
	88	extern void kobject_put(struct kobject *);
	89
86406245 KS	90	extern struct kobject kobject_kset_add_dir(struct kset kset,
86406245 KS	91	struct kobject , const char );
7423172a JN	92	extern struct kobject kobject_add_dir(struct kobject , const char *);
7423172a JN	93
fd4f2df2	94	extern char * kobject_get_path(struct kobject *, gfp_t);
1da177e4 LT	95
	96	struct kobj_type {
	97	void (release)(struct kobject );
	98	struct sysfs_ops * sysfs_ops;
	99	struct attribute ** default_attrs;
	100	};
	101
	102
	103	/**
	104	* kset - a set of kobjects of a specific type, belonging
	105	* to a specific subsystem.
	106	*
	107	* All kobjects of a kset should be embedded in an identical
	108	* type. This type may have a descriptor, which the kset points
	109	* to. This allows there to exist sets of objects of the same
	110	* type in different subsystems.
	111	*
	112	* A subsystem does not have to be a list of only one type
	113	* of object; multiple ksets can belong to one subsystem. All
	114	* ksets of a subsystem share the subsystem's lock.
	115	*
312c004d KS	116	* Each kset can support specific event variables; it can
	117	* supress the event generation or add subsystem specific
	118	* variables carried with the event.
1da177e4	119	*/
312c004d	120	struct kset_uevent_ops {
1da177e4	121	int (filter)(struct kset kset, struct kobject *kobj);
419cab3f	122	const char (name)(struct kset kset, struct kobject kobj);
312c004d	123	int (uevent)(struct kset kset, struct kobject kobj, char *envp,
1da177e4 LT	124	int num_envp, char *buffer, int buffer_size);
	125	};
	126
	127	struct kset {
1da177e4 LT	128	struct kobj_type * ktype;
	129	struct list_head list;
	130	spinlock_t list_lock;
	131	struct kobject kobj;
312c004d	132	struct kset_uevent_ops * uevent_ops;
1da177e4 LT	133	};
	134
	135
	136	extern void kset_init(struct kset * k);
4a7fb636 AM	137	extern int __must_check kset_add(struct kset * k);
4a7fb636 AM	138	extern int __must_check kset_register(struct kset * k);
1da177e4 LT	139	extern void kset_unregister(struct kset * k);
	140
	141	static inline struct kset * to_kset(struct kobject * kobj)
	142	{
	143	return kobj ? container_of(kobj,struct kset,kobj) : NULL;
	144	}
	145
	146	static inline struct kset * kset_get(struct kset * k)
	147	{
	148	return k ? to_kset(kobject_get(&k->kobj)) : NULL;
	149	}
	150
	151	static inline void kset_put(struct kset * k)
	152	{
	153	kobject_put(&k->kobj);
	154	}
	155
	156	static inline struct kobj_type * get_ktype(struct kobject * k)
	157	{
	158	if (k->kset && k->kset->ktype)
	159	return k->kset->ktype;
	160	else
	161	return k->ktype;
	162	}
	163
	164	extern struct kobject * kset_find_obj(struct kset , const char );
	165
	166
	167	/**
	168	* Use this when initializing an embedded kset with no other
	169	* fields to initialize.
	170	*/
	171	#define set_kset_name(str) .kset = { .kobj = { .name = str } }
	172
	173
312c004d	174	#define decl_subsys(_name,_type,_uevent_ops) \
823bccfc GKH	175	struct kset _name##_subsys = { \
	176	.kobj = { .name = __stringify(_name) }, \
	177	.ktype = _type, \
	178	.uevent_ops =_uevent_ops, \
1da177e4	179	}
312c004d	180	#define decl_subsys_name(_varname,_name,_type,_uevent_ops) \
823bccfc GKH	181	struct kset _varname##_subsys = { \
	182	.kobj = { .name = __stringify(_name) }, \
	183	.ktype = _type, \
	184	.uevent_ops =_uevent_ops, \
1da177e4 LT	185	}
	186
	187	/* The global /sys/kernel/ subsystem for people to chain off of */
823bccfc	188	extern struct kset kernel_subsys;
4039483f	189	/* The global /sys/hypervisor/ subsystem */
823bccfc	190	extern struct kset hypervisor_subsys;
1da177e4 LT	191
	192	/**
	193	* Helpers for setting the kset of registered objects.
	194	* Often, a registered object belongs to a kset embedded in a
	195	* subsystem. These do no magic, just make the resulting code
	196	* easier to follow.
	197	*/
	198
	199	/**
	200	* kobj_set_kset_s(obj,subsys) - set kset for embedded kobject.
	201	* @obj: ptr to some object type.
	202	* @subsys: a subsystem object (not a ptr).
	203	*
	204	* Can be used for any object type with an embedded ->kobj.
	205	*/
	206
	207	#define kobj_set_kset_s(obj,subsys) \
823bccfc	208	(obj)->kobj.kset = &(subsys)
1da177e4 LT	209
	210	/**
	211	* kset_set_kset_s(obj,subsys) - set kset for embedded kset.
	212	* @obj: ptr to some object type.
	213	* @subsys: a subsystem object (not a ptr).
	214	*
	215	* Can be used for any object type with an embedded ->kset.
	216	* Sets the kset of @obj's embedded kobject (via its embedded
	217	* kset) to @subsys.kset. This makes @obj a member of that
	218	* kset.
	219	*/
	220
	221	#define kset_set_kset_s(obj,subsys) \
823bccfc	222	(obj)->kset.kobj.kset = &(subsys)
1da177e4 LT	223
	224	/**
	225	* subsys_set_kset(obj,subsys) - set kset for subsystem
	226	* @obj: ptr to some object type.
	227	* @subsys: a subsystem object (not a ptr).
	228	*
	229	* Can be used for any object type with an embedded ->subsys.
	230	* Sets the kset of @obj's kobject to @subsys.kset. This makes
	231	* the object a member of that kset.
	232	*/
	233
	234	#define subsys_set_kset(obj,_subsys) \
823bccfc	235	(obj)->subsys.kobj.kset = &(_subsys)
1da177e4	236
823bccfc GKH	237	extern void subsystem_init(struct kset *);
	238	extern int __must_check subsystem_register(struct kset *);
	239	extern void subsystem_unregister(struct kset *);
1da177e4	240
823bccfc	241	static inline struct kset subsys_get(struct kset s)
1da177e4	242	{
823bccfc GKH	243	if (s)
	244	return kset_get(s);
	245	return NULL;
1da177e4 LT	246	}
1da177e4 LT	247
823bccfc	248	static inline void subsys_put(struct kset *s)
1da177e4	249	{
823bccfc	250	kset_put(s);
1da177e4 LT	251	}
	252
	253	struct subsys_attribute {
	254	struct attribute attr;
823bccfc GKH	255	ssize_t (show)(struct kset , char *);
823bccfc GKH	256	ssize_t (store)(struct kset , const char *, size_t);
1da177e4 LT	257	};
1da177e4 LT	258
823bccfc	259	extern int __must_check subsys_create_file(struct kset *,
4a7fb636	260	struct subsys_attribute *);
1da177e4	261
4d17ffda	262	#if defined(CONFIG_HOTPLUG)
542cfce6 AK	263	int kobject_uevent(struct kobject *kobj, enum kobject_action action);
542cfce6 AK	264	int kobject_uevent_env(struct kobject *kobj, enum kobject_action action,
8a82472f	265	char *envp[]);
0296b228	266
312c004d	267	int add_uevent_var(char *envp, int num_envp, int cur_index,
1da177e4 LT	268	char buffer, int buffer_size, int cur_len,
	269	const char *format, ...)
	270	__attribute__((format (printf, 7, 8)));
	271	#else
542cfce6 AK	272	static inline int kobject_uevent(struct kobject *kobj, enum kobject_action action)
	273	{ return 0; }
	274	static inline int kobject_uevent_env(struct kobject *kobj,
8a82472f CH	275	enum kobject_action action,
8a82472f CH	276	char *envp[])
542cfce6	277	{ return 0; }
5f123fbd	278
312c004d	279	static inline int add_uevent_var(char *envp, int num_envp, int cur_index,
1da177e4 LT	280	char buffer, int buffer_size, int cur_len,
	281	const char *format, ...)
	282	{ return 0; }
	283	#endif
	284
	285	#endif /* __KERNEL__ */
	286	#endif /* _KOBJECT_H_ */