[mirror_ubuntu-zesty-kernel.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"

/*
 * command-mode operation request block
 */
struct cmd_orb {
	u32 intparm;	/* interruption parameter */
	u32 key  : 4;	/* flags, like key, suspend control, etc. */
	u32 spnd : 1;	/* suspend control */
	u32 res1 : 1;	/* reserved */
	u32 mod  : 1;	/* modification control */
	u32 sync : 1;	/* synchronize control */
	u32 fmt  : 1;	/* format control */
	u32 pfch : 1;	/* prefetch control */
	u32 isic : 1;	/* initial-status-interruption control */
	u32 alcc : 1;	/* address-limit-checking control */
	u32 ssic : 1;	/* suppress-suspended-interr. control */
	u32 res2 : 1;	/* reserved */
	u32 c64  : 1;	/* IDAW/QDIO 64 bit control  */
	u32 i2k  : 1;	/* IDAW 2/4kB block size control */
	u32 lpm  : 8;	/* logical path mask */
	u32 ils  : 1;	/* incorrect length */
	u32 zero : 6;	/* reserved zeros */
	u32 orbx : 1;	/* ORB extension control */
	u32 cpa;	/* channel program address */
}  __attribute__ ((packed, aligned(4)));

/*
 * transport-mode operation request block
 */
struct tm_orb {
	u32 intparm;
	u32 key:4;
	u32 :9;
	u32 b:1;
	u32 :2;
	u32 lpm:8;
	u32 :7;
	u32 x:1;
	u32 tcw;
	u32 prio:8;
	u32 :8;
	u32 rsvpgm:8;
	u32 :8;
	u32 :32;
	u32 :32;
	u32 :32;
	u32 :32;
}  __attribute__ ((packed, aligned(4)));

union orb {
	struct cmd_orb cmd;
	struct tm_orb tm;
}  __attribute__ ((packed, aligned(4)));

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
 * @mask: current path mask
 * @retries: current number of retries
 * @drc: delayed return code
 * @cancel: non-zero if request was cancelled
 * @done: non-zero if request was finished
 */
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;
	/* These fields are used internally. */
	u8 mask;
	u16 retries;
	int drc;
	int cancel:1;
	int done:1;
} __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;
	unsigned long registered;
	struct ccw_dev_id dev_id;	/* device id */
	struct subchannel_id schid;	/* subchannel number */
	struct ccw_request req;		/* internal I/O request */
	u8 imask;		/* lpm mask for SNID/SID/SPGID */
	int iretry;		/* retry counter SNID/SID/SPGID */
	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 */
	} __attribute__ ((packed)) options;
	struct {
		unsigned int pgid_single:1; /* use single path for Set PGID */
		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 intretry:1;    /* retry internal operation */
		unsigned int resuming:1;    /* recognition while resume */
	} __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 ssch(struct subchannel_id schid, union orb *addr)
{
	register struct subchannel_id reg1 asm("1") = schid;
	int ccode = -EIO;

	asm volatile(
		"	ssch	0(%2)\n"
		"0:	ipm	%0\n"
		"	srl	%0,28\n"
		"1:\n"
		EX_TABLE(0b, 1b)
		: "+d" (ccode)
		: "d" (reg1), "a" (addr), "m" (*addr)
		: "cc", "memory");
	return ccode;
}

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 csch(struct subchannel_id schid)
{
	register struct subchannel_id reg1 asm("1") = schid;
	int ccode;

	asm volatile(
		"	csch\n"
		"	ipm	%0\n"
		"	srl	%0,28"
		: "=d" (ccode)
		: "d" (reg1)
		: "cc");
	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"
cd6b4f27 CH	8
cd6b4f27 CH	9	/*
83262d63	10	* command-mode operation request block
cd6b4f27	11	*/
83262d63	12	struct cmd_orb {
cd6b4f27 CH	13	u32 intparm; /* interruption parameter */
	14	u32 key : 4; /* flags, like key, suspend control, etc. */
	15	u32 spnd : 1; /* suspend control */
	16	u32 res1 : 1; /* reserved */
	17	u32 mod : 1; /* modification control */
	18	u32 sync : 1; /* synchronize control */
	19	u32 fmt : 1; /* format control */
	20	u32 pfch : 1; /* prefetch control */
	21	u32 isic : 1; /* initial-status-interruption control */
	22	u32 alcc : 1; /* address-limit-checking control */
	23	u32 ssic : 1; /* suppress-suspended-interr. control */
	24	u32 res2 : 1; /* reserved */
	25	u32 c64 : 1; /* IDAW/QDIO 64 bit control */
	26	u32 i2k : 1; /* IDAW 2/4kB block size control */
	27	u32 lpm : 8; /* logical path mask */
	28	u32 ils : 1; /* incorrect length */
	29	u32 zero : 6; /* reserved zeros */
	30	u32 orbx : 1; /* ORB extension control */
	31	u32 cpa; /* channel program address */
	32	} __attribute__ ((packed, aligned(4)));
	33
83262d63 PO	34	/*
	35	* transport-mode operation request block
	36	*/
	37	struct tm_orb {
	38	u32 intparm;
	39	u32 key:4;
	40	u32 :9;
	41	u32 b:1;
	42	u32 :2;
	43	u32 lpm:8;
	44	u32 :7;
	45	u32 x:1;
	46	u32 tcw;
	47	u32 prio:8;
	48	u32 :8;
	49	u32 rsvpgm:8;
	50	u32 :8;
	51	u32 :32;
	52	u32 :32;
	53	u32 :32;
	54	u32 :32;
	55	} __attribute__ ((packed, aligned(4)));
	56
	57	union orb {
	58	struct cmd_orb cmd;
	59	struct tm_orb tm;
	60	} __attribute__ ((packed, aligned(4)));
	61
cd6b4f27	62	struct io_subchannel_private {
83262d63	63	union orb orb; /* operation request block */
cd6b4f27 CH	64	struct ccw1 sense_ccw; /* static ccw for sense command */
	65	} __attribute__ ((aligned(8)));
	66
	67	#define to_io_private(n) ((struct io_subchannel_private *)n->private)
db6a6423 CH	68	#define sch_get_cdev(n) (dev_get_drvdata(&n->dev))
db6a6423 CH	69	#define sch_set_cdev(n, c) (dev_set_drvdata(&n->dev, c))
cd6b4f27 CH	70
	71	#define MAX_CIWS 8
	72
e1f0fbd6 PO	73	/*
	74	* Possible status values for a CCW request's I/O.
	75	*/
	76	enum io_status {
	77	IO_DONE,
	78	IO_RUNNING,
	79	IO_STATUS_ERROR,
	80	IO_PATH_ERROR,
	81	IO_REJECTED,
	82	IO_KILLED
	83	};
	84
	85	/**
	86	* ccw_request - Internal CCW request.
	87	* @cp: channel program to start
	88	* @timeout: maximum allowable time in jiffies between start I/O and interrupt
	89	* @maxretries: number of retries per I/O operation and path
	90	* @lpm: mask of paths to use
	91	* @check: optional callback that determines if results are final
	92	* @filter: optional callback to adjust request status based on IRB data
	93	* @callback: final callback
	94	* @data: user-defined pointer passed to all callbacks
	95	* @mask: current path mask
	96	* @retries: current number of retries
	97	* @drc: delayed return code
	98	* @cancel: non-zero if request was cancelled
	99	* @done: non-zero if request was finished
	100	*/
	101	struct ccw_request {
	102	struct ccw1 *cp;
	103	unsigned long timeout;
	104	u16 maxretries;
	105	u8 lpm;
	106	int (check)(struct ccw_device , void *);
	107	enum io_status (filter)(struct ccw_device , void , struct irb ,
	108	enum io_status);
	109	void (callback)(struct ccw_device , void *, int);
	110	void *data;
	111	/* These fields are used internally. */
	112	u8 mask;
	113	u16 retries;
	114	int drc;
	115	int cancel:1;
	116	int done:1;
	117	} __attribute__((packed));
	118
cd6b4f27 CH	119	/*
	120	* sense-id response buffer layout
	121	*/
	122	struct senseid {
	123	/* common part */
	124	u8 reserved; /* always 0x'FF' */
	125	u16 cu_type; /* control unit type */
	126	u8 cu_model; /* control unit model */
	127	u16 dev_type; /* device type */
	128	u8 dev_model; /* device model */
	129	u8 unused; /* padding byte */
	130	/* extended part */
	131	struct ciw ciw[MAX_CIWS]; /* variable # of CIWs */
	132	} __attribute__ ((packed, aligned(4)));
	133
37de53bb PO	134	enum cdev_todo {
	135	CDEV_TODO_NOTHING,
	136	CDEV_TODO_ENABLE_CMF,
	137	CDEV_TODO_REBIND,
	138	CDEV_TODO_REGISTER,
	139	CDEV_TODO_UNREG,
	140	CDEV_TODO_UNREG_EVAL,
	141	};
	142
cd6b4f27 CH	143	struct ccw_device_private {
	144	struct ccw_device *cdev;
	145	struct subchannel *sch;
	146	int state; /* device state */
	147	atomic_t onoff;
	148	unsigned long registered;
	149	struct ccw_dev_id dev_id; /* device id */
	150	struct subchannel_id schid; /* subchannel number */
e1f0fbd6	151	struct ccw_request req; /* internal I/O request */
cd6b4f27 CH	152	u8 imask; /* lpm mask for SNID/SID/SPGID */
	153	int iretry; /* retry counter SNID/SID/SPGID */
	154	struct {
	155	unsigned int fast:1; /* post with "channel end" */
	156	unsigned int repall:1; /* report every interrupt status */
	157	unsigned int pgroup:1; /* do path grouping */
	158	unsigned int force:1; /* allow forced online */
	159	} __attribute__ ((packed)) options;
	160	struct {
	161	unsigned int pgid_single:1; /* use single path for Set PGID */
	162	unsigned int esid:1; /* Ext. SenseID supported by HW */
	163	unsigned int dosense:1; /* delayed SENSE required */
	164	unsigned int doverify:1; /* delayed path verification */
	165	unsigned int donotify:1; /* call notify function */
	166	unsigned int recog_done:1; /* dev. recog. complete */
	167	unsigned int fake_irb:1; /* deliver faked irb */
	168	unsigned int intretry:1; /* retry internal operation */
823d494a	169	unsigned int resuming:1; /* recognition while resume */
cd6b4f27 CH	170	} __attribute__((packed)) flags;
	171	unsigned long intparm; /* user interruption parameter */
	172	struct qdio_irq *qdio_data;
	173	struct irb irb; /* device status */
	174	struct senseid senseid; /* SenseID info */
	175	struct pgid pgid[8]; /* path group IDs per chpid*/
	176	struct ccw1 iccws[2]; /* ccws for SNID/SID/SPGID commands */
37de53bb PO	177	struct work_struct todo_work;
37de53bb PO	178	enum cdev_todo todo;
cd6b4f27 CH	179	wait_queue_head_t wait_q;
	180	struct timer_list timer;
	181	void cmb; / measurement information */
	182	struct list_head cmb_list; /* list of measured devices */
	183	u64 cmb_start_time; /* clock value of cmb reset */
	184	void cmb_wait; / deferred cmb enable/disable */
	185	};
	186
f9c9fe3e	187	static inline int ssch(struct subchannel_id schid, union orb *addr)
cd6b4f27 CH	188	{
cd6b4f27 CH	189	register struct subchannel_id reg1 asm("1") = schid;
83262d63	190	int ccode = -EIO;
cd6b4f27 CH	191
	192	asm volatile(
	193	" ssch 0(%2)\n"
83262d63 PO	194	"0: ipm %0\n"
	195	" srl %0,28\n"
	196	"1:\n"
	197	EX_TABLE(0b, 1b)
f9c9fe3e PO	198	: "+d" (ccode)
	199	: "d" (reg1), "a" (addr), "m" (*addr)
	200	: "cc", "memory");
cd6b4f27 CH	201	return ccode;
	202	}
	203
	204	static inline int rsch(struct subchannel_id schid)
	205	{
	206	register struct subchannel_id reg1 asm("1") = schid;
	207	int ccode;
	208
	209	asm volatile(
	210	" rsch\n"
	211	" ipm %0\n"
	212	" srl %0,28"
f9c9fe3e PO	213	: "=d" (ccode)
	214	: "d" (reg1)
	215	: "cc", "memory");
cd6b4f27 CH	216	return ccode;
	217	}
	218
	219	static inline int csch(struct subchannel_id schid)
	220	{
	221	register struct subchannel_id reg1 asm("1") = schid;
	222	int ccode;
	223
	224	asm volatile(
	225	" csch\n"
	226	" ipm %0\n"
	227	" srl %0,28"
f9c9fe3e PO	228	: "=d" (ccode)
	229	: "d" (reg1)
	230	: "cc");
cd6b4f27 CH	231	return ccode;
	232	}
	233
	234	static inline int hsch(struct subchannel_id schid)
	235	{
	236	register struct subchannel_id reg1 asm("1") = schid;
	237	int ccode;
	238
	239	asm volatile(
	240	" hsch\n"
	241	" ipm %0\n"
	242	" srl %0,28"
f9c9fe3e PO	243	: "=d" (ccode)
	244	: "d" (reg1)
	245	: "cc");
cd6b4f27 CH	246	return ccode;
	247	}
	248
	249	static inline int xsch(struct subchannel_id schid)
	250	{
	251	register struct subchannel_id reg1 asm("1") = schid;
	252	int ccode;
	253
	254	asm volatile(
	255	" .insn rre,0xb2760000,%1,0\n"
	256	" ipm %0\n"
	257	" srl %0,28"
f9c9fe3e PO	258	: "=d" (ccode)
	259	: "d" (reg1)
	260	: "cc");
cd6b4f27 CH	261	return ccode;
	262	}
	263
	264	#endif