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