[linux-2.6-block.git] / include / asm-s390 / ccwdev.h

/*
 *  include/asm-s390/ccwdev.h
 *  include/asm-s390x/ccwdev.h
 *
 *    Copyright (C) 2002 IBM Deutschland Entwicklung GmbH, IBM Corporation
 *    Author(s): Arnd Bergmann <arndb@de.ibm.com>
 *
 *  Interface for CCW device drivers
 */
#ifndef _S390_CCWDEV_H_
#define _S390_CCWDEV_H_

#include <linux/device.h>
#include <linux/mod_devicetable.h>

/* structs from asm/cio.h */
struct irb;
struct ccw1;
struct ccw_dev_id;

/* simplified initializers for struct ccw_device:
 * CCW_DEVICE and CCW_DEVICE_DEVTYPE initialize one
 * entry in your MODULE_DEVICE_TABLE and set the match_flag correctly */
#define CCW_DEVICE(cu, cum) 						\
	.cu_type=(cu), .cu_model=(cum),					\
	.match_flags=(CCW_DEVICE_ID_MATCH_CU_TYPE			\
		   | (cum ? CCW_DEVICE_ID_MATCH_CU_MODEL : 0))

#define CCW_DEVICE_DEVTYPE(cu, cum, dev, devm)				\
	.cu_type=(cu), .cu_model=(cum), .dev_type=(dev), .dev_model=(devm),\
	.match_flags=CCW_DEVICE_ID_MATCH_CU_TYPE			\
		   | ((cum) ? CCW_DEVICE_ID_MATCH_CU_MODEL : 0) 	\
		   | CCW_DEVICE_ID_MATCH_DEVICE_TYPE			\
		   | ((devm) ? CCW_DEVICE_ID_MATCH_DEVICE_MODEL : 0)

/* scan through an array of device ids and return the first
 * entry that matches the device.
 *
 * the array must end with an entry containing zero match_flags
 */
static inline const struct ccw_device_id *
ccw_device_id_match(const struct ccw_device_id *array,
			const struct ccw_device_id *match)
{
	const struct ccw_device_id *id = array;

	for (id = array; id->match_flags; id++) {
		if ((id->match_flags & CCW_DEVICE_ID_MATCH_CU_TYPE)
		    && (id->cu_type != match->cu_type))
			continue;

		if ((id->match_flags & CCW_DEVICE_ID_MATCH_CU_MODEL)
		    && (id->cu_model != match->cu_model))
			continue;

		if ((id->match_flags & CCW_DEVICE_ID_MATCH_DEVICE_TYPE)
		    && (id->dev_type != match->dev_type))
			continue;

		if ((id->match_flags & CCW_DEVICE_ID_MATCH_DEVICE_MODEL)
		    && (id->dev_model != match->dev_model))
			continue;

		return id;
	}

	return NULL;
}

/**
 * struct ccw_device - channel attached device
 * @ccwlock: pointer to device lock
 * @id: id of this device
 * @drv: ccw driver for this device
 * @dev: embedded device structure
 * @online: online status of device
 * @handler: interrupt handler
 *
 * @handler is a member of the device rather than the driver since a driver
 * can have different interrupt handlers for different ccw devices
 * (multi-subchannel drivers).
 */
struct ccw_device {
	spinlock_t *ccwlock;
/* private: */
	struct ccw_device_private *private;	/* cio private information */
/* public: */
	struct ccw_device_id id;
	struct ccw_driver *drv;
	struct device dev;
	int online;
	void (*handler) (struct ccw_device *, unsigned long, struct irb *);
};


/**
 * struct ccw driver - device driver for channel attached devices
 * @owner: owning module
 * @ids: ids supported by this driver
 * @probe: function called on probe
 * @remove: function called on remove
 * @set_online: called when setting device online
 * @set_offline: called when setting device offline
 * @notify: notify driver of device state changes
 * @shutdown: called at device shutdown
 * @driver: embedded device driver structure
 * @name: device driver name
 */
struct ccw_driver {
	struct module *owner;
	struct ccw_device_id *ids;
	int (*probe) (struct ccw_device *);
	void (*remove) (struct ccw_device *);
	int (*set_online) (struct ccw_device *);
	int (*set_offline) (struct ccw_device *);
	int (*notify) (struct ccw_device *, int);
	void (*shutdown) (struct ccw_device *);
	struct device_driver driver;
	char *name;
};

extern struct ccw_device *get_ccwdev_by_busid(struct ccw_driver *cdrv,
					      const char *bus_id);

/* devices drivers call these during module load and unload.
 * When a driver is registered, its probe method is called
 * when new devices for its type pop up */
extern int  ccw_driver_register   (struct ccw_driver *driver);
extern void ccw_driver_unregister (struct ccw_driver *driver);

struct ccw1;

extern int ccw_device_set_options_mask(struct ccw_device *, unsigned long);
extern int ccw_device_set_options(struct ccw_device *, unsigned long);
extern void ccw_device_clear_options(struct ccw_device *, unsigned long);

/* Allow for i/o completion notification after primary interrupt status. */
#define CCWDEV_EARLY_NOTIFICATION	0x0001
/* Report all interrupt conditions. */
#define CCWDEV_REPORT_ALL	 	0x0002
/* Try to perform path grouping. */
#define CCWDEV_DO_PATHGROUP             0x0004
/* Allow forced onlining of boxed devices. */
#define CCWDEV_ALLOW_FORCE              0x0008

extern int ccw_device_start(struct ccw_device *, struct ccw1 *,
			    unsigned long, __u8, unsigned long);
extern int ccw_device_start_timeout(struct ccw_device *, struct ccw1 *,
				    unsigned long, __u8, unsigned long, int);
extern int ccw_device_start_key(struct ccw_device *, struct ccw1 *,
				unsigned long, __u8, __u8, unsigned long);
extern int ccw_device_start_timeout_key(struct ccw_device *, struct ccw1 *,
					unsigned long, __u8, __u8,
					unsigned long, int);


extern int ccw_device_resume(struct ccw_device *);
extern int ccw_device_halt(struct ccw_device *, unsigned long);
extern int ccw_device_clear(struct ccw_device *, unsigned long);

extern int ccw_device_set_online(struct ccw_device *cdev);
extern int ccw_device_set_offline(struct ccw_device *cdev);


extern struct ciw *ccw_device_get_ciw(struct ccw_device *, __u32 cmd);
extern __u8 ccw_device_get_path_mask(struct ccw_device *);
extern void ccw_device_get_id(struct ccw_device *, struct ccw_dev_id *);

#define get_ccwdev_lock(x) (x)->ccwlock

#define to_ccwdev(n) container_of(n, struct ccw_device, dev)
#define to_ccwdrv(n) container_of(n, struct ccw_driver, driver)

extern struct ccw_device *ccw_device_probe_console(void);

// FIXME: these have to go
extern int _ccw_device_get_subchannel_number(struct ccw_device *);

extern void *ccw_device_get_chp_desc(struct ccw_device *, int);
#endif /* _S390_CCWDEV_H_ */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* include/asm-s390/ccwdev.h
	3	* include/asm-s390x/ccwdev.h
	4	*
	5	* Copyright (C) 2002 IBM Deutschland Entwicklung GmbH, IBM Corporation
	6	* Author(s): Arnd Bergmann <arndb@de.ibm.com>
	7	*
	8	* Interface for CCW device drivers
	9	*/
	10	#ifndef _S390_CCWDEV_H_
	11	#define _S390_CCWDEV_H_
	12
	13	#include <linux/device.h>
	14	#include <linux/mod_devicetable.h>
	15
	16	/* structs from asm/cio.h */
	17	struct irb;
	18	struct ccw1;
9a92fe48	19	struct ccw_dev_id;
1da177e4 LT	20
	21	/* simplified initializers for struct ccw_device:
	22	* CCW_DEVICE and CCW_DEVICE_DEVTYPE initialize one
	23	* entry in your MODULE_DEVICE_TABLE and set the match_flag correctly */
	24	#define CCW_DEVICE(cu, cum) \
	25	.cu_type=(cu), .cu_model=(cum), \
	26	.match_flags=(CCW_DEVICE_ID_MATCH_CU_TYPE \
	27	\| (cum ? CCW_DEVICE_ID_MATCH_CU_MODEL : 0))
	28
	29	#define CCW_DEVICE_DEVTYPE(cu, cum, dev, devm) \
	30	.cu_type=(cu), .cu_model=(cum), .dev_type=(dev), .dev_model=(devm),\
	31	.match_flags=CCW_DEVICE_ID_MATCH_CU_TYPE \
	32	\| ((cum) ? CCW_DEVICE_ID_MATCH_CU_MODEL : 0) \
	33	\| CCW_DEVICE_ID_MATCH_DEVICE_TYPE \
	34	\| ((devm) ? CCW_DEVICE_ID_MATCH_DEVICE_MODEL : 0)
	35
	36	/* scan through an array of device ids and return the first
	37	* entry that matches the device.
	38	*
	39	* the array must end with an entry containing zero match_flags
	40	*/
	41	static inline const struct ccw_device_id *
	42	ccw_device_id_match(const struct ccw_device_id *array,
	43	const struct ccw_device_id *match)
	44	{
	45	const struct ccw_device_id *id = array;
	46
	47	for (id = array; id->match_flags; id++) {
	48	if ((id->match_flags & CCW_DEVICE_ID_MATCH_CU_TYPE)
	49	&& (id->cu_type != match->cu_type))
	50	continue;
	51
	52	if ((id->match_flags & CCW_DEVICE_ID_MATCH_CU_MODEL)
	53	&& (id->cu_model != match->cu_model))
	54	continue;
	55
	56	if ((id->match_flags & CCW_DEVICE_ID_MATCH_DEVICE_TYPE)
	57	&& (id->dev_type != match->dev_type))
	58	continue;
	59
	60	if ((id->match_flags & CCW_DEVICE_ID_MATCH_DEVICE_MODEL)
	61	&& (id->dev_model != match->dev_model))
	62	continue;
	63
	64	return id;
	65	}
	66
d2c993d8	67	return NULL;
1da177e4 LT	68	}
1da177e4 LT	69
b2ffd8e9 CH	70	/**
	71	* struct ccw_device - channel attached device
	72	* @ccwlock: pointer to device lock
	73	* @id: id of this device
	74	* @drv: ccw driver for this device
	75	* @dev: embedded device structure
	76	* @online: online status of device
	77	* @handler: interrupt handler
1da177e4	78	*
b2ffd8e9 CH	79	* @handler is a member of the device rather than the driver since a driver
	80	* can have different interrupt handlers for different ccw devices
	81	* (multi-subchannel drivers).
	82	*/
1da177e4 LT	83	struct ccw_device {
1da177e4 LT	84	spinlock_t *ccwlock;
b2ffd8e9	85	/* private: */
1da177e4	86	struct ccw_device_private private; / cio private information */
b2ffd8e9 CH	87	/* public: */
	88	struct ccw_device_id id;
	89	struct ccw_driver *drv;
	90	struct device dev;
1da177e4	91	int online;
1da177e4 LT	92	void (handler) (struct ccw_device , unsigned long, struct irb *);
	93	};
	94
	95
b2ffd8e9 CH	96	/**
	97	* struct ccw driver - device driver for channel attached devices
	98	* @owner: owning module
	99	* @ids: ids supported by this driver
	100	* @probe: function called on probe
	101	* @remove: function called on remove
	102	* @set_online: called when setting device online
	103	* @set_offline: called when setting device offline
	104	* @notify: notify driver of device state changes
958974fb	105	* @shutdown: called at device shutdown
b2ffd8e9 CH	106	* @driver: embedded device driver structure
	107	* @name: device driver name
	108	*/
1da177e4	109	struct ccw_driver {
b2ffd8e9 CH	110	struct module *owner;
	111	struct ccw_device_id *ids;
	112	int (probe) (struct ccw_device );
1da177e4	113	void (remove) (struct ccw_device );
1da177e4 LT	114	int (set_online) (struct ccw_device );
	115	int (set_offline) (struct ccw_device );
	116	int (notify) (struct ccw_device , int);
958974fb	117	void (shutdown) (struct ccw_device );
b2ffd8e9	118	struct device_driver driver;
1da177e4 LT	119	char *name;
	120	};
	121
	122	extern struct ccw_device get_ccwdev_by_busid(struct ccw_driver cdrv,
	123	const char *bus_id);
	124
	125	/* devices drivers call these during module load and unload.
	126	* When a driver is registered, its probe method is called
	127	* when new devices for its type pop up */
	128	extern int ccw_driver_register (struct ccw_driver *driver);
	129	extern void ccw_driver_unregister (struct ccw_driver *driver);
	130
	131	struct ccw1;
	132
4dd3cc5c	133	extern int ccw_device_set_options_mask(struct ccw_device *, unsigned long);
1da177e4	134	extern int ccw_device_set_options(struct ccw_device *, unsigned long);
4dd3cc5c	135	extern void ccw_device_clear_options(struct ccw_device *, unsigned long);
1da177e4 LT	136
	137	/* Allow for i/o completion notification after primary interrupt status. */
	138	#define CCWDEV_EARLY_NOTIFICATION 0x0001
	139	/* Report all interrupt conditions. */
	140	#define CCWDEV_REPORT_ALL 0x0002
	141	/* Try to perform path grouping. */
	142	#define CCWDEV_DO_PATHGROUP 0x0004
	143	/* Allow forced onlining of boxed devices. */
	144	#define CCWDEV_ALLOW_FORCE 0x0008
	145
1da177e4 LT	146	extern int ccw_device_start(struct ccw_device , struct ccw1 ,
1da177e4 LT	147	unsigned long, __u8, unsigned long);
1da177e4 LT	148	extern int ccw_device_start_timeout(struct ccw_device , struct ccw1 ,
1da177e4 LT	149	unsigned long, __u8, unsigned long, int);
1da177e4 LT	150	extern int ccw_device_start_key(struct ccw_device , struct ccw1 ,
	151	unsigned long, __u8, __u8, unsigned long);
	152	extern int ccw_device_start_timeout_key(struct ccw_device , struct ccw1 ,
	153	unsigned long, __u8, __u8,
	154	unsigned long, int);
	155
	156
	157	extern int ccw_device_resume(struct ccw_device *);
	158	extern int ccw_device_halt(struct ccw_device *, unsigned long);
	159	extern int ccw_device_clear(struct ccw_device *, unsigned long);
	160
1da177e4 LT	161	extern int ccw_device_set_online(struct ccw_device *cdev);
	162	extern int ccw_device_set_offline(struct ccw_device *cdev);
	163
	164
	165	extern struct ciw ccw_device_get_ciw(struct ccw_device , __u32 cmd);
	166	extern __u8 ccw_device_get_path_mask(struct ccw_device *);
9a92fe48	167	extern void ccw_device_get_id(struct ccw_device , struct ccw_dev_id );
1da177e4 LT	168
	169	#define get_ccwdev_lock(x) (x)->ccwlock
	170
	171	#define to_ccwdev(n) container_of(n, struct ccw_device, dev)
	172	#define to_ccwdrv(n) container_of(n, struct ccw_driver, driver)
	173
	174	extern struct ccw_device *ccw_device_probe_console(void);
	175
	176	// FIXME: these have to go
1da177e4 LT	177	extern int _ccw_device_get_subchannel_number(struct ccw_device *);
1da177e4 LT	178
1da177e4 LT	179	extern void ccw_device_get_chp_desc(struct ccw_device , int);
1da177e4 LT	180	#endif /* _S390_CCWDEV_H_ */