[mirror_ubuntu-bionic-kernel.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/module.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>
3367b994	25	#include <linux/module.h>
438510f6	26	#include <linux/pm.h>
1da177e4 LT	27
	28
	29	struct sys_device;
38457ab3	30	struct sysdev_class_attribute;
1da177e4 LT	31
1da177e4 LT	32	struct sysdev_class {
af5ca3f4	33	const char *name;
1da177e4	34	struct list_head drivers;
38457ab3	35	struct sysdev_class_attribute **attrs;
d47d81c0	36	struct kset kset;
1da177e4 LT	37	};
1da177e4 LT	38
670dd90d SL	39	struct sysdev_class_attribute {
670dd90d SL	40	struct attribute attr;
c9be0a36 AK	41	ssize_t (show)(struct sysdev_class , struct sysdev_class_attribute *,
	42	char *);
	43	ssize_t (store)(struct sysdev_class , struct sysdev_class_attribute *,
	44	const char *, size_t);
670dd90d SL	45	};
670dd90d SL	46
9d1fe323 MT	47	#define _SYSDEV_CLASS_ATTR(_name,_mode,_show,_store) \
9d1fe323 MT	48	{ \
670dd90d SL	49	.attr = {.name = __stringify(_name), .mode = _mode }, \
	50	.show = _show, \
	51	.store = _store, \
9d1fe323 MT	52	}
	53
	54	#define SYSDEV_CLASS_ATTR(_name,_mode,_show,_store) \
	55	struct sysdev_class_attribute attr_##_name = \
	56	_SYSDEV_CLASS_ATTR(_name,_mode,_show,_store)
670dd90d	57
1da177e4 LT	58
	59	extern int sysdev_class_register(struct sysdev_class *);
	60	extern void sysdev_class_unregister(struct sysdev_class *);
	61
670dd90d SL	62	extern int sysdev_class_create_file(struct sysdev_class *,
	63	struct sysdev_class_attribute *);
	64	extern void sysdev_class_remove_file(struct sysdev_class *,
	65	struct sysdev_class_attribute *);
1da177e4	66	/**
25985edc	67	* Auxiliary system device drivers.
1da177e4 LT	68	*/
	69
	70	struct sysdev_driver {
	71	struct list_head entry;
	72	int (add)(struct sys_device );
	73	int (remove)(struct sys_device );
1da177e4 LT	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;
4a0b2b4d AK	98	ssize_t (show)(struct sys_device , struct sysdev_attribute , char );
	99	ssize_t (store)(struct sys_device , struct sysdev_attribute *,
	100	const char *, size_t);
1da177e4 LT	101	};
	102
	103
9d1fe323	104	#define _SYSDEV_ATTR(_name, _mode, _show, _store) \
7583b6e4	105	{ \
7b595756	106	.attr = { .name = __stringify(_name), .mode = _mode }, \
1da177e4 LT	107	.show = _show, \
1da177e4 LT	108	.store = _store, \
7583b6e4 OJ	109	}
7583b6e4 OJ	110
9d1fe323 MT	111	#define SYSDEV_ATTR(_name, _mode, _show, _store) \
	112	struct sysdev_attribute attr_##_name = \
	113	_SYSDEV_ATTR(_name, _mode, _show, _store);
1da177e4 LT	114
	115	extern int sysdev_create_file(struct sys_device , struct sysdev_attribute );
	116	extern void sysdev_remove_file(struct sys_device , struct sysdev_attribute );
	117
1e395ab3 AK	118	/* Create/remove NULL terminated attribute list */
	119	static inline int
	120	sysdev_create_files(struct sys_device d, struct sysdev_attribute *a)
	121	{
	122	return sysfs_create_files(&d->kobj, (const struct attribute **)a);
	123	}
	124
	125	static inline void
	126	sysdev_remove_files(struct sys_device d, struct sysdev_attribute *a)
	127	{
	128	return sysfs_remove_files(&d->kobj, (const struct attribute **)a);
	129	}
	130
9800794a AK	131	struct sysdev_ext_attribute {
	132	struct sysdev_attribute attr;
	133	void *var;
	134	};
	135
	136	/*
	137	* Support for simple variable sysdev attributes.
	138	* The pointer to the variable is stored in a sysdev_ext_attribute
	139	*/
	140
	141	/* Add more types as needed */
	142
	143	extern ssize_t sysdev_show_ulong(struct sys_device , struct sysdev_attribute ,
	144	char *);
	145	extern ssize_t sysdev_store_ulong(struct sys_device *,
	146	struct sysdev_attribute , const char , size_t);
	147	extern ssize_t sysdev_show_int(struct sys_device , struct sysdev_attribute ,
	148	char *);
	149	extern ssize_t sysdev_store_int(struct sys_device *,
	150	struct sysdev_attribute , const char , size_t);
	151
	152	#define _SYSDEV_ULONG_ATTR(_name, _mode, _var) \
	153	{ _SYSDEV_ATTR(_name, _mode, sysdev_show_ulong, sysdev_store_ulong), \
	154	&(_var) }
	155	#define SYSDEV_ULONG_ATTR(_name, _mode, _var) \
	156	struct sysdev_ext_attribute attr_##_name = \
	157	_SYSDEV_ULONG_ATTR(_name, _mode, _var);
	158	#define _SYSDEV_INT_ATTR(_name, _mode, _var) \
	159	{ _SYSDEV_ATTR(_name, _mode, sysdev_show_int, sysdev_store_int), \
	160	&(_var) }
	161	#define SYSDEV_INT_ATTR(_name, _mode, _var) \
	162	struct sysdev_ext_attribute attr_##_name = \
	163	_SYSDEV_INT_ATTR(_name, _mode, _var);
	164
1da177e4	165	#endif /* _SYSDEV_H_ */