[linux-block.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 auxillary 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.
 *
 * Auxillary 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/module.h>
#include <linux/pm.h>


struct sys_device;

struct sysdev_class {
	const char *name;
	struct list_head	drivers;

	/* Default operations for these types of devices */
	int	(*shutdown)(struct sys_device *);
	int	(*suspend)(struct sys_device *, pm_message_t state);
	int	(*resume)(struct sys_device *);
	struct kset		kset;
};

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

#define SYSDEV_CLASS_ATTR(_name,_mode,_show,_store) 		\
struct sysdev_class_attribute attr_##_name = { 			\
	.attr = {.name = __stringify(_name), .mode = _mode },	\
	.show	= _show,					\
	.store	= _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 *);
/**
 * Auxillary system device drivers.
 */

struct sysdev_driver {
	struct list_head	entry;
	int	(*add)(struct sys_device *);
	int	(*remove)(struct sys_device *);
	int	(*shutdown)(struct sys_device *);
	int	(*suspend)(struct sys_device *, pm_message_t state);
	int	(*resume)(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 *, char *);
	ssize_t (*store)(struct sys_device *, 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 *);

#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	*
	10	* We also support auxillary drivers binding to devices of a certain class.
	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	*
	16	* Auxillary drivers registered with a NULL cls are registered as drivers
	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>
3367b994	25	#include <linux/module.h>
438510f6	26	#include <linux/pm.h>
1da177e4 LT	27
	28
	29	struct sys_device;
	30
	31	struct sysdev_class {
af5ca3f4	32	const char *name;
1da177e4 LT	33	struct list_head drivers;
	34
	35	/* Default operations for these types of devices */
	36	int (shutdown)(struct sys_device );
438510f6	37	int (suspend)(struct sys_device , pm_message_t state);
1da177e4 LT	38	int (resume)(struct sys_device );
	39	struct kset kset;
	40	};
	41
670dd90d SL	42	struct sysdev_class_attribute {
	43	struct attribute attr;
	44	ssize_t (show)(struct sysdev_class , char *);
	45	ssize_t (store)(struct sysdev_class , const char *, size_t);
	46	};
	47
	48	#define SYSDEV_CLASS_ATTR(_name,_mode,_show,_store) \
	49	struct sysdev_class_attribute attr_##_name = { \
	50	.attr = {.name = __stringify(_name), .mode = _mode }, \
	51	.show = _show, \
	52	.store = _store, \
	53	};
	54
1da177e4 LT	55
	56	extern int sysdev_class_register(struct sysdev_class *);
	57	extern void sysdev_class_unregister(struct sysdev_class *);
	58
670dd90d SL	59	extern int sysdev_class_create_file(struct sysdev_class *,
	60	struct sysdev_class_attribute *);
	61	extern void sysdev_class_remove_file(struct sysdev_class *,
	62	struct sysdev_class_attribute *);
1da177e4 LT	63	/**
	64	* Auxillary system device drivers.
	65	*/
	66
	67	struct sysdev_driver {
	68	struct list_head entry;
	69	int (add)(struct sys_device );
	70	int (remove)(struct sys_device );
	71	int (shutdown)(struct sys_device );
438510f6	72	int (suspend)(struct sys_device , pm_message_t state);
1da177e4 LT	73	int (resume)(struct sys_device );
	74	};
	75
	76
	77	extern int sysdev_driver_register(struct sysdev_class , struct sysdev_driver );
	78	extern void sysdev_driver_unregister(struct sysdev_class , struct sysdev_driver );
	79
	80
	81	/**
	82	* sys_devices can be simplified a lot from regular devices, because they're
	83	* simply not as versatile.
	84	*/
	85
	86	struct sys_device {
	87	u32 id;
	88	struct sysdev_class * cls;
	89	struct kobject kobj;
	90	};
	91
	92	extern int sysdev_register(struct sys_device *);
	93	extern void sysdev_unregister(struct sys_device *);
	94
	95
	96	struct sysdev_attribute {
	97	struct attribute attr;
	98	ssize_t (show)(struct sys_device , char *);
	99	ssize_t (store)(struct sys_device , const char *, size_t);
	100	};
	101
	102
7583b6e4 OJ	103	#define _SYSDEV_ATTR(_name,_mode,_show,_store) \
7583b6e4 OJ	104	{ \
7b595756	105	.attr = { .name = __stringify(_name), .mode = _mode }, \
1da177e4 LT	106	.show = _show, \
1da177e4 LT	107	.store = _store, \
7583b6e4 OJ	108	}
	109
	110	#define SYSDEV_ATTR(_name,_mode,_show,_store) \
	111	struct sysdev_attribute attr_##_name = _SYSDEV_ATTR(_name,_mode,_show,_store);
1da177e4 LT	112
	113	extern int sysdev_create_file(struct sys_device , struct sysdev_attribute );
	114	extern void sysdev_remove_file(struct sys_device , struct sysdev_attribute );
	115
	116	#endif /* _SYSDEV_H_ */