[linux-block.git] / drivers / s390 / cio / io_sch.h

#ifndef S390_IO_SCH_H
#define S390_IO_SCH_H

#include <linux/types.h>
#include <asm/schid.h>
#include <asm/ccwdev.h>
#include "css.h"
#include "orb.h"

struct io_subchannel_private {
	union orb orb;		/* operation request block */
	struct ccw1 sense_ccw;	/* static ccw for sense command */
} __attribute__ ((aligned(8)));

#define to_io_private(n) ((struct io_subchannel_private *)n->private)
#define sch_get_cdev(n) (dev_get_drvdata(&n->dev))
#define sch_set_cdev(n, c) (dev_set_drvdata(&n->dev, c))

#define MAX_CIWS 8

/*
 * Possible status values for a CCW request's I/O.
 */
enum io_status {
	IO_DONE,
	IO_RUNNING,
	IO_STATUS_ERROR,
	IO_PATH_ERROR,
	IO_REJECTED,
	IO_KILLED
};

/**
 * ccw_request - Internal CCW request.
 * @cp: channel program to start
 * @timeout: maximum allowable time in jiffies between start I/O and interrupt
 * @maxretries: number of retries per I/O operation and path
 * @lpm: mask of paths to use
 * @check: optional callback that determines if results are final
 * @filter: optional callback to adjust request status based on IRB data
 * @callback: final callback
 * @data: user-defined pointer passed to all callbacks
 * @singlepath: if set, use only one path from @lpm per start I/O
 * @cancel: non-zero if request was cancelled
 * @done: non-zero if request was finished
 * @mask: current path mask
 * @retries: current number of retries
 * @drc: delayed return code
 */
struct ccw_request {
	struct ccw1 *cp;
	unsigned long timeout;
	u16 maxretries;
	u8 lpm;
	int (*check)(struct ccw_device *, void *);
	enum io_status (*filter)(struct ccw_device *, void *, struct irb *,
				 enum io_status);
	void (*callback)(struct ccw_device *, void *, int);
	void *data;
	unsigned int singlepath:1;
	/* These fields are used internally. */
	unsigned int cancel:1;
	unsigned int done:1;
	u16 mask;
	u16 retries;
	int drc;
} __attribute__((packed));

/*
 * sense-id response buffer layout
 */
struct senseid {
	/* common part */
	u8  reserved;	/* always 0x'FF' */
	u16 cu_type;	/* control unit type */
	u8  cu_model;	/* control unit model */
	u16 dev_type;	/* device type */
	u8  dev_model;	/* device model */
	u8  unused;	/* padding byte */
	/* extended part */
	struct ciw ciw[MAX_CIWS];	/* variable # of CIWs */
}  __attribute__ ((packed, aligned(4)));

enum cdev_todo {
	CDEV_TODO_NOTHING,
	CDEV_TODO_ENABLE_CMF,
	CDEV_TODO_REBIND,
	CDEV_TODO_REGISTER,
	CDEV_TODO_UNREG,
	CDEV_TODO_UNREG_EVAL,
};

struct ccw_device_private {
	struct ccw_device *cdev;
	struct subchannel *sch;
	int state;		/* device state */
	atomic_t onoff;
	struct ccw_dev_id dev_id;	/* device id */
	struct subchannel_id schid;	/* subchannel number */
	struct ccw_request req;		/* internal I/O request */
	int iretry;
	u8 pgid_valid_mask;	/* mask of valid PGIDs */
	u8 pgid_todo_mask;	/* mask of PGIDs to be adjusted */
	u8 pgid_reset_mask;	/* mask of PGIDs which were reset */
	u8 path_gone_mask;	/* mask of paths, that became unavailable */
	u8 path_new_mask;	/* mask of paths, that became available */
	struct {
		unsigned int fast:1;	/* post with "channel end" */
		unsigned int repall:1;	/* report every interrupt status */
		unsigned int pgroup:1;	/* do path grouping */
		unsigned int force:1;	/* allow forced online */
		unsigned int mpath:1;	/* do multipathing */
	} __attribute__ ((packed)) options;
	struct {
		unsigned int esid:1;	    /* Ext. SenseID supported by HW */
		unsigned int dosense:1;	    /* delayed SENSE required */
		unsigned int doverify:1;    /* delayed path verification */
		unsigned int donotify:1;    /* call notify function */
		unsigned int recog_done:1;  /* dev. recog. complete */
		unsigned int fake_irb:1;    /* deliver faked irb */
		unsigned int resuming:1;    /* recognition while resume */
		unsigned int pgroup:1;	    /* pathgroup is set up */
		unsigned int mpath:1;	    /* multipathing is set up */
		unsigned int initialized:1; /* set if initial reference held */
	} __attribute__((packed)) flags;
	unsigned long intparm;	/* user interruption parameter */
	struct qdio_irq *qdio_data;
	struct irb irb;		/* device status */
	struct senseid senseid;	/* SenseID info */
	struct pgid pgid[8];	/* path group IDs per chpid*/
	struct ccw1 iccws[2];	/* ccws for SNID/SID/SPGID commands */
	struct work_struct todo_work;
	enum cdev_todo todo;
	wait_queue_head_t wait_q;
	struct timer_list timer;
	void *cmb;			/* measurement information */
	struct list_head cmb_list;	/* list of measured devices */
	u64 cmb_start_time;		/* clock value of cmb reset */
	void *cmb_wait;			/* deferred cmb enable/disable */
};

static inline int rsch(struct subchannel_id schid)
{
	register struct subchannel_id reg1 asm("1") = schid;
	int ccode;

	asm volatile(
		"	rsch\n"
		"	ipm	%0\n"
		"	srl	%0,28"
		: "=d" (ccode)
		: "d" (reg1)
		: "cc", "memory");
	return ccode;
}

static inline int hsch(struct subchannel_id schid)
{
	register struct subchannel_id reg1 asm("1") = schid;
	int ccode;

	asm volatile(
		"	hsch\n"
		"	ipm	%0\n"
		"	srl	%0,28"
		: "=d" (ccode)
		: "d" (reg1)
		: "cc");
	return ccode;
}

static inline int xsch(struct subchannel_id schid)
{
	register struct subchannel_id reg1 asm("1") = schid;
	int ccode;

	asm volatile(
		"	.insn	rre,0xb2760000,%1,0\n"
		"	ipm	%0\n"
		"	srl	%0,28"
		: "=d" (ccode)
		: "d" (reg1)
		: "cc");
	return ccode;
}

#endif
Commit	Line	Data
cd6b4f27 CH	1	#ifndef S390_IO_SCH_H
	2	#define S390_IO_SCH_H
	3
e1f0fbd6	4	#include <linux/types.h>
9d92a7e1	5	#include <asm/schid.h>
e1f0fbd6 PO	6	#include <asm/ccwdev.h>
e1f0fbd6 PO	7	#include "css.h"
9e6f9f85	8	#include "orb.h"
83262d63	9
cd6b4f27	10	struct io_subchannel_private {
83262d63	11	union orb orb; /* operation request block */
cd6b4f27 CH	12	struct ccw1 sense_ccw; /* static ccw for sense command */
	13	} __attribute__ ((aligned(8)));
	14
	15	#define to_io_private(n) ((struct io_subchannel_private *)n->private)
db6a6423 CH	16	#define sch_get_cdev(n) (dev_get_drvdata(&n->dev))
db6a6423 CH	17	#define sch_set_cdev(n, c) (dev_set_drvdata(&n->dev, c))
cd6b4f27 CH	18
	19	#define MAX_CIWS 8
	20
e1f0fbd6 PO	21	/*
	22	* Possible status values for a CCW request's I/O.
	23	*/
	24	enum io_status {
	25	IO_DONE,
	26	IO_RUNNING,
	27	IO_STATUS_ERROR,
	28	IO_PATH_ERROR,
	29	IO_REJECTED,
	30	IO_KILLED
	31	};
	32
	33	/**
	34	* ccw_request - Internal CCW request.
	35	* @cp: channel program to start
	36	* @timeout: maximum allowable time in jiffies between start I/O and interrupt
	37	* @maxretries: number of retries per I/O operation and path
	38	* @lpm: mask of paths to use
	39	* @check: optional callback that determines if results are final
	40	* @filter: optional callback to adjust request status based on IRB data
	41	* @callback: final callback
	42	* @data: user-defined pointer passed to all callbacks
982bdf81 SO	43	* @singlepath: if set, use only one path from @lpm per start I/O
	44	* @cancel: non-zero if request was cancelled
	45	* @done: non-zero if request was finished
e1f0fbd6 PO	46	* @mask: current path mask
	47	* @retries: current number of retries
	48	* @drc: delayed return code
e1f0fbd6 PO	49	*/
	50	struct ccw_request {
	51	struct ccw1 *cp;
	52	unsigned long timeout;
	53	u16 maxretries;
	54	u8 lpm;
	55	int (check)(struct ccw_device , void *);
	56	enum io_status (filter)(struct ccw_device , void , struct irb ,
	57	enum io_status);
	58	void (callback)(struct ccw_device , void *, int);
	59	void *data;
982bdf81	60	unsigned int singlepath:1;
e1f0fbd6	61	/* These fields are used internally. */
982bdf81 SO	62	unsigned int cancel:1;
982bdf81 SO	63	unsigned int done:1;
de1b0438	64	u16 mask;
e1f0fbd6 PO	65	u16 retries;
e1f0fbd6 PO	66	int drc;
e1f0fbd6 PO	67	} __attribute__((packed));
e1f0fbd6 PO	68
cd6b4f27 CH	69	/*
	70	* sense-id response buffer layout
	71	*/
	72	struct senseid {
	73	/* common part */
	74	u8 reserved; /* always 0x'FF' */
	75	u16 cu_type; /* control unit type */
	76	u8 cu_model; /* control unit model */
	77	u16 dev_type; /* device type */
	78	u8 dev_model; /* device model */
	79	u8 unused; /* padding byte */
	80	/* extended part */
	81	struct ciw ciw[MAX_CIWS]; /* variable # of CIWs */
	82	} __attribute__ ((packed, aligned(4)));
	83
37de53bb PO	84	enum cdev_todo {
	85	CDEV_TODO_NOTHING,
	86	CDEV_TODO_ENABLE_CMF,
	87	CDEV_TODO_REBIND,
	88	CDEV_TODO_REGISTER,
	89	CDEV_TODO_UNREG,
	90	CDEV_TODO_UNREG_EVAL,
	91	};
	92
cd6b4f27 CH	93	struct ccw_device_private {
	94	struct ccw_device *cdev;
	95	struct subchannel *sch;
	96	int state; /* device state */
	97	atomic_t onoff;
cd6b4f27 CH	98	struct ccw_dev_id dev_id; /* device id */
cd6b4f27 CH	99	struct subchannel_id schid; /* subchannel number */
e1f0fbd6	100	struct ccw_request req; /* internal I/O request */
9679baaf	101	int iretry;
585b954e SO	102	u8 pgid_valid_mask; /* mask of valid PGIDs */
	103	u8 pgid_todo_mask; /* mask of PGIDs to be adjusted */
	104	u8 pgid_reset_mask; /* mask of PGIDs which were reset */
	105	u8 path_gone_mask; /* mask of paths, that became unavailable */
	106	u8 path_new_mask; /* mask of paths, that became available */
cd6b4f27 CH	107	struct {
	108	unsigned int fast:1; /* post with "channel end" */
	109	unsigned int repall:1; /* report every interrupt status */
	110	unsigned int pgroup:1; /* do path grouping */
	111	unsigned int force:1; /* allow forced online */
454e1fa1	112	unsigned int mpath:1; /* do multipathing */
cd6b4f27 CH	113	} __attribute__ ((packed)) options;
cd6b4f27 CH	114	struct {
cd6b4f27 CH	115	unsigned int esid:1; /* Ext. SenseID supported by HW */
	116	unsigned int dosense:1; /* delayed SENSE required */
	117	unsigned int doverify:1; /* delayed path verification */
	118	unsigned int donotify:1; /* call notify function */
	119	unsigned int recog_done:1; /* dev. recog. complete */
	120	unsigned int fake_irb:1; /* deliver faked irb */
823d494a	121	unsigned int resuming:1; /* recognition while resume */
454e1fa1 PO	122	unsigned int pgroup:1; /* pathgroup is set up */
454e1fa1 PO	123	unsigned int mpath:1; /* multipathing is set up */
24a1872d	124	unsigned int initialized:1; /* set if initial reference held */
cd6b4f27 CH	125	} __attribute__((packed)) flags;
	126	unsigned long intparm; /* user interruption parameter */
	127	struct qdio_irq *qdio_data;
	128	struct irb irb; /* device status */
	129	struct senseid senseid; /* SenseID info */
	130	struct pgid pgid[8]; /* path group IDs per chpid*/
	131	struct ccw1 iccws[2]; /* ccws for SNID/SID/SPGID commands */
37de53bb PO	132	struct work_struct todo_work;
37de53bb PO	133	enum cdev_todo todo;
cd6b4f27 CH	134	wait_queue_head_t wait_q;
	135	struct timer_list timer;
	136	void cmb; / measurement information */
	137	struct list_head cmb_list; /* list of measured devices */
	138	u64 cmb_start_time; /* clock value of cmb reset */
	139	void cmb_wait; / deferred cmb enable/disable */
	140	};
	141
cd6b4f27 CH	142	static inline int rsch(struct subchannel_id schid)
	143	{
	144	register struct subchannel_id reg1 asm("1") = schid;
	145	int ccode;
	146
	147	asm volatile(
	148	" rsch\n"
	149	" ipm %0\n"
	150	" srl %0,28"
f9c9fe3e PO	151	: "=d" (ccode)
	152	: "d" (reg1)
	153	: "cc", "memory");
cd6b4f27 CH	154	return ccode;
	155	}
	156
cd6b4f27 CH	157	static inline int hsch(struct subchannel_id schid)
	158	{
	159	register struct subchannel_id reg1 asm("1") = schid;
	160	int ccode;
	161
	162	asm volatile(
	163	" hsch\n"
	164	" ipm %0\n"
	165	" srl %0,28"
f9c9fe3e PO	166	: "=d" (ccode)
	167	: "d" (reg1)
	168	: "cc");
cd6b4f27 CH	169	return ccode;
	170	}
	171
	172	static inline int xsch(struct subchannel_id schid)
	173	{
	174	register struct subchannel_id reg1 asm("1") = schid;
	175	int ccode;
	176
	177	asm volatile(
	178	" .insn rre,0xb2760000,%1,0\n"
	179	" ipm %0\n"
	180	" srl %0,28"
f9c9fe3e PO	181	: "=d" (ccode)
	182	: "d" (reg1)
	183	: "cc");
cd6b4f27 CH	184	return ccode;
	185	}
	186
	187	#endif