[linux.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 <[email protected]>
 *
 *  Interface for CCW device drivers
 */
#ifndef _S390_CCWDEV_H_
#define _S390_CCWDEV_H_

#include <linux/device.h>
#include <linux/mod_devicetable.h>
#include <asm/fcx.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);
int ccw_device_tm_start_key(struct ccw_device *cdev, struct tcw *tcw,
			    unsigned long intparm, u8 lpm, u8 key);
int ccw_device_tm_start_key(struct ccw_device *, struct tcw *,
			    unsigned long, u8, u8);
int ccw_device_tm_start_timeout_key(struct ccw_device *, struct tcw *,
			    unsigned long, u8, u8, int);
int ccw_device_tm_start(struct ccw_device *, struct tcw *,
			    unsigned long, u8);
int ccw_device_tm_start_timeout(struct ccw_device *, struct tcw *,
			    unsigned long, u8, int);
int ccw_device_tm_intrg(struct ccw_device *cdev);

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