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

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef S390_IO_SCH_H
#define S390_IO_SCH_H

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

struct io_subchannel_dma_area {
	struct ccw1 sense_ccw;	/* static ccw for sense command */
};

struct io_subchannel_private {
	union orb orb;		/* operation request block */
	struct ccw_device *cdev;/* pointer to the child ccw device */
	struct {
		unsigned int suspend:1;	/* allow suspend */
		unsigned int prefetch:1;/* deny prefetch */
		unsigned int inter:1;	/* suppress intermediate interrupts */
	} __packed options;
	struct io_subchannel_dma_area *dma_area;
	dma_addr_t dma_area_dma;
} __aligned(8);

#define to_io_private(n) ((struct io_subchannel_private *) \
			  dev_get_drvdata(&(n)->dev))
#define set_io_private(n, p) (dev_set_drvdata(&(n)->dev, p))

static inline struct ccw_device *sch_get_cdev(struct subchannel *sch)
{
	struct io_subchannel_private *priv = to_io_private(sch);
	return priv ? priv->cdev : NULL;
}

static inline void sch_set_cdev(struct subchannel *sch,
				struct ccw_device *cdev)
{
	struct io_subchannel_private *priv = to_io_private(sch);
	if (priv)
		priv->cdev = cdev;
}

#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,
};

#define FAKE_CMD_IRB	1
#define FAKE_TM_IRB	2

struct ccw_device_dma_area {
	struct senseid senseid;	/* SenseID info */
	struct ccw1 iccws[2];	/* ccws for SNID/SID/SPGID commands */
	struct irb irb;		/* device status */
	struct pgid pgid[8];	/* path group IDs per chpid*/
};

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 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_noirq_mask;	/* mask of paths for which no irq was
				   received */
	u8 path_notoper_mask;	/* mask of paths which were found
				   not operable */
	u8 path_gone_mask;	/* mask of paths, that became unavailable */
	u8 path_new_mask;	/* mask of paths, that became available */
	u8 path_broken_mask;	/* mask of paths, which were found to be
				   unusable */
	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:2;    /* deliver faked irb */
		unsigned int pgroup:1;	    /* pathgroup is set up */
		unsigned int mpath:1;	    /* multipathing is set up */
		unsigned int pgid_unknown:1;/* unknown pgid state */
		unsigned int initialized:1; /* set if initial reference held */
	} __attribute__((packed)) flags;
	unsigned long intparm;	/* user interruption parameter */
	struct qdio_irq *qdio_data;
	int async_kill_io_rc;
	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 */
	struct gen_pool *dma_pool;
	struct ccw_device_dma_area *dma_area;
	enum interruption_class int_class;
};

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