[deliverable/linux.git] / include / linux / sysdev.h

/**
 * System devices follow a slightly different driver model. 
 * They don't need to do dynammic driver binding, can't be probed, 
 * and don't reside on any type of peripheral bus. 
 * So, we represent and treat them a little differently.
 * 
 * We still have a notion of a driver for a system device, because we still
 * want to perform basic operations on these devices. 
 *
 * We also support auxiliary drivers binding to devices of a certain class.
 * 
 * This allows configurable drivers to register themselves for devices of
 * a certain type. And, it allows class definitions to reside in generic
 * code while arch-specific code can register specific drivers.
 *
 * Auxiliary drivers registered with a NULL cls are registered as drivers
 * for all system devices, and get notification calls for each device. 
 */


#ifndef _SYSDEV_H_
#define _SYSDEV_H_

#include <linux/kobject.h>
#include <linux/pm.h>


struct sys_device;
struct sysdev_class_attribute;

struct sysdev_class {
	const char *name;
	struct list_head	drivers;
	struct sysdev_class_attribute **attrs;
	struct kset		kset;
};

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

#define _SYSDEV_CLASS_ATTR(_name,_mode,_show,_store) 		\
{					 			\
	.attr = {.name = __stringify(_name), .mode = _mode },	\
	.show	= _show,					\
	.store	= _store,					\
}

#define SYSDEV_CLASS_ATTR(_name,_mode,_show,_store) 		\
	struct sysdev_class_attribute attr_##_name = 		\
		_SYSDEV_CLASS_ATTR(_name,_mode,_show,_store)


extern int sysdev_class_register(struct sysdev_class *);
extern void sysdev_class_unregister(struct sysdev_class *);

extern int sysdev_class_create_file(struct sysdev_class *,
	struct sysdev_class_attribute *);
extern void sysdev_class_remove_file(struct sysdev_class *,
	struct sysdev_class_attribute *);
/**
 * Auxiliary system device drivers.
 */

struct sysdev_driver {
	struct list_head	entry;
	int	(*add)(struct sys_device *);
	int	(*remove)(struct sys_device *);
};


extern int sysdev_driver_register(struct sysdev_class *, struct sysdev_driver *);
extern void sysdev_driver_unregister(struct sysdev_class *, struct sysdev_driver *);


/**
 * sys_devices can be simplified a lot from regular devices, because they're
 * simply not as versatile. 
 */

struct sys_device {
	u32		id;
	struct sysdev_class	* cls;
	struct kobject		kobj;
};

extern int sysdev_register(struct sys_device *);
extern void sysdev_unregister(struct sys_device *);


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


#define _SYSDEV_ATTR(_name, _mode, _show, _store)		\
{								\
	.attr = { .name = __stringify(_name), .mode = _mode },	\
	.show	= _show,					\
	.store	= _store,					\
}

#define SYSDEV_ATTR(_name, _mode, _show, _store)		\
	struct sysdev_attribute attr_##_name =			\
		_SYSDEV_ATTR(_name, _mode, _show, _store);

extern int sysdev_create_file(struct sys_device *, struct sysdev_attribute *);
extern void sysdev_remove_file(struct sys_device *, struct sysdev_attribute *);

/* Create/remove NULL terminated attribute list */
static inline int
sysdev_create_files(struct sys_device *d, struct sysdev_attribute **a)
{
	return sysfs_create_files(&d->kobj, (const struct attribute **)a);
}

static inline void
sysdev_remove_files(struct sys_device *d, struct sysdev_attribute **a)
{
	return sysfs_remove_files(&d->kobj, (const struct attribute **)a);
}

struct sysdev_ext_attribute {
	struct sysdev_attribute attr;
	void *var;
};

/*
 * Support for simple variable sysdev attributes.
 * The pointer to the variable is stored in a sysdev_ext_attribute
 */

/* Add more types as needed */

extern ssize_t sysdev_show_ulong(struct sys_device *, struct sysdev_attribute *,
				char *);
extern ssize_t sysdev_store_ulong(struct sys_device *,
			struct sysdev_attribute *, const char *, size_t);
extern ssize_t sysdev_show_int(struct sys_device *, struct sysdev_attribute *,
				char *);
extern ssize_t sysdev_store_int(struct sys_device *,
			struct sysdev_attribute *, const char *, size_t);

#define _SYSDEV_ULONG_ATTR(_name, _mode, _var)				\
	{ _SYSDEV_ATTR(_name, _mode, sysdev_show_ulong, sysdev_store_ulong), \
	  &(_var) }
#define SYSDEV_ULONG_ATTR(_name, _mode, _var)			\
	struct sysdev_ext_attribute attr_##_name = 		\
		_SYSDEV_ULONG_ATTR(_name, _mode, _var);
#define _SYSDEV_INT_ATTR(_name, _mode, _var)				\
	{ _SYSDEV_ATTR(_name, _mode, sysdev_show_int, sysdev_store_int), \
	  &(_var) }
#define SYSDEV_INT_ATTR(_name, _mode, _var)			\
	struct sysdev_ext_attribute attr_##_name = 		\
		_SYSDEV_INT_ATTR(_name, _mode, _var);

#endif /* _SYSDEV_H_ */
Commit	Line	Data
1da177e4 LT	1	/**
	2	* System devices follow a slightly different driver model.
	3	* They don't need to do dynammic driver binding, can't be probed,
	4	* and don't reside on any type of peripheral bus.
	5	* So, we represent and treat them a little differently.
	6	*
	7	* We still have a notion of a driver for a system device, because we still
	8	* want to perform basic operations on these devices.
	9	*
25985edc	10	* We also support auxiliary drivers binding to devices of a certain class.
1da177e4 LT	11	*
	12	* This allows configurable drivers to register themselves for devices of
	13	* a certain type. And, it allows class definitions to reside in generic
	14	* code while arch-specific code can register specific drivers.
	15	*
25985edc	16	* Auxiliary drivers registered with a NULL cls are registered as drivers
1da177e4 LT	17	* for all system devices, and get notification calls for each device.
	18	*/
	19
	20
	21	#ifndef _SYSDEV_H_
	22	#define _SYSDEV_H_
	23
	24	#include <linux/kobject.h>
438510f6	25	#include <linux/pm.h>
1da177e4 LT	26
	27
	28	struct sys_device;
38457ab3	29	struct sysdev_class_attribute;
1da177e4 LT	30
1da177e4 LT	31	struct sysdev_class {
af5ca3f4	32	const char *name;
1da177e4	33	struct list_head drivers;
38457ab3	34	struct sysdev_class_attribute **attrs;
d47d81c0	35	struct kset kset;
1da177e4 LT	36	};
1da177e4 LT	37
670dd90d SL	38	struct sysdev_class_attribute {
670dd90d SL	39	struct attribute attr;
c9be0a36 AK	40	ssize_t (show)(struct sysdev_class , struct sysdev_class_attribute *,
	41	char *);
	42	ssize_t (store)(struct sysdev_class , struct sysdev_class_attribute *,
	43	const char *, size_t);
670dd90d SL	44	};
670dd90d SL	45
9d1fe323 MT	46	#define _SYSDEV_CLASS_ATTR(_name,_mode,_show,_store) \
9d1fe323 MT	47	{ \
670dd90d SL	48	.attr = {.name = __stringify(_name), .mode = _mode }, \
	49	.show = _show, \
	50	.store = _store, \
9d1fe323 MT	51	}
	52
	53	#define SYSDEV_CLASS_ATTR(_name,_mode,_show,_store) \
	54	struct sysdev_class_attribute attr_##_name = \
	55	_SYSDEV_CLASS_ATTR(_name,_mode,_show,_store)
670dd90d	56
1da177e4 LT	57
	58	extern int sysdev_class_register(struct sysdev_class *);
	59	extern void sysdev_class_unregister(struct sysdev_class *);
	60
670dd90d SL	61	extern int sysdev_class_create_file(struct sysdev_class *,
	62	struct sysdev_class_attribute *);
	63	extern void sysdev_class_remove_file(struct sysdev_class *,
	64	struct sysdev_class_attribute *);
1da177e4	65	/**
25985edc	66	* Auxiliary system device drivers.
1da177e4 LT	67	*/
	68
	69	struct sysdev_driver {
	70	struct list_head entry;
	71	int (add)(struct sys_device );
	72	int (remove)(struct sys_device );
1da177e4 LT	73	};
	74
	75
	76	extern int sysdev_driver_register(struct sysdev_class , struct sysdev_driver );
	77	extern void sysdev_driver_unregister(struct sysdev_class , struct sysdev_driver );
	78
	79
	80	/**
	81	* sys_devices can be simplified a lot from regular devices, because they're
	82	* simply not as versatile.
	83	*/
	84
	85	struct sys_device {
	86	u32 id;
	87	struct sysdev_class * cls;
	88	struct kobject kobj;
	89	};
	90
	91	extern int sysdev_register(struct sys_device *);
	92	extern void sysdev_unregister(struct sys_device *);
	93
	94
	95	struct sysdev_attribute {
	96	struct attribute attr;
4a0b2b4d AK	97	ssize_t (show)(struct sys_device , struct sysdev_attribute , char );
	98	ssize_t (store)(struct sys_device , struct sysdev_attribute *,
	99	const char *, size_t);
1da177e4 LT	100	};
	101
	102
9d1fe323	103	#define _SYSDEV_ATTR(_name, _mode, _show, _store) \
7583b6e4	104	{ \
7b595756	105	.attr = { .name = __stringify(_name), .mode = _mode }, \
1da177e4 LT	106	.show = _show, \
1da177e4 LT	107	.store = _store, \
7583b6e4 OJ	108	}
7583b6e4 OJ	109
9d1fe323 MT	110	#define SYSDEV_ATTR(_name, _mode, _show, _store) \
	111	struct sysdev_attribute attr_##_name = \
	112	_SYSDEV_ATTR(_name, _mode, _show, _store);
1da177e4 LT	113
	114	extern int sysdev_create_file(struct sys_device , struct sysdev_attribute );
	115	extern void sysdev_remove_file(struct sys_device , struct sysdev_attribute );
	116
1e395ab3 AK	117	/* Create/remove NULL terminated attribute list */
	118	static inline int
	119	sysdev_create_files(struct sys_device d, struct sysdev_attribute *a)
	120	{
	121	return sysfs_create_files(&d->kobj, (const struct attribute **)a);
	122	}
	123
	124	static inline void
	125	sysdev_remove_files(struct sys_device d, struct sysdev_attribute *a)
	126	{
	127	return sysfs_remove_files(&d->kobj, (const struct attribute **)a);
	128	}
	129
9800794a AK	130	struct sysdev_ext_attribute {
	131	struct sysdev_attribute attr;
	132	void *var;
	133	};
	134
	135	/*
	136	* Support for simple variable sysdev attributes.
	137	* The pointer to the variable is stored in a sysdev_ext_attribute
	138	*/
	139
	140	/* Add more types as needed */
	141
	142	extern ssize_t sysdev_show_ulong(struct sys_device , struct sysdev_attribute ,
	143	char *);
	144	extern ssize_t sysdev_store_ulong(struct sys_device *,
	145	struct sysdev_attribute , const char , size_t);
	146	extern ssize_t sysdev_show_int(struct sys_device , struct sysdev_attribute ,
	147	char *);
	148	extern ssize_t sysdev_store_int(struct sys_device *,
	149	struct sysdev_attribute , const char , size_t);
	150
	151	#define _SYSDEV_ULONG_ATTR(_name, _mode, _var) \
	152	{ _SYSDEV_ATTR(_name, _mode, sysdev_show_ulong, sysdev_store_ulong), \
	153	&(_var) }
	154	#define SYSDEV_ULONG_ATTR(_name, _mode, _var) \
	155	struct sysdev_ext_attribute attr_##_name = \
	156	_SYSDEV_ULONG_ATTR(_name, _mode, _var);
	157	#define _SYSDEV_INT_ATTR(_name, _mode, _var) \
	158	{ _SYSDEV_ATTR(_name, _mode, sysdev_show_int, sysdev_store_int), \
	159	&(_var) }
	160	#define SYSDEV_INT_ATTR(_name, _mode, _var) \
	161	struct sysdev_ext_attribute attr_##_name = \
	162	_SYSDEV_INT_ATTR(_name, _mode, _var);
	163
1da177e4	164	#endif /* _SYSDEV_H_ */