1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * zfcp device driver
4  *
5  * Interface to the FSF support functions.
6  *
7  * Copyright IBM Corp. 2002, 2018
8  */
9 
10 #ifndef FSF_H
11 #define FSF_H
12 
13 #include <linux/pfn.h>
14 #include <linux/scatterlist.h>
15 #include <scsi/libfc.h>
16 
17 #define FSF_QTCB_CURRENT_VERSION		0x00000001
18 
19 /* FSF commands */
20 #define	FSF_QTCB_FCP_CMND			0x00000001
21 #define	FSF_QTCB_ABORT_FCP_CMND			0x00000002
22 #define	FSF_QTCB_OPEN_PORT_WITH_DID		0x00000005
23 #define	FSF_QTCB_OPEN_LUN			0x00000006
24 #define	FSF_QTCB_CLOSE_LUN			0x00000007
25 #define	FSF_QTCB_CLOSE_PORT			0x00000008
26 #define	FSF_QTCB_CLOSE_PHYSICAL_PORT		0x00000009
27 #define	FSF_QTCB_SEND_ELS			0x0000000B
28 #define	FSF_QTCB_SEND_GENERIC			0x0000000C
29 #define	FSF_QTCB_EXCHANGE_CONFIG_DATA		0x0000000D
30 #define	FSF_QTCB_EXCHANGE_PORT_DATA		0x0000000E
31 #define FSF_QTCB_DOWNLOAD_CONTROL_FILE		0x00000012
32 #define FSF_QTCB_UPLOAD_CONTROL_FILE		0x00000013
33 
34 /* FSF QTCB types */
35 #define FSF_IO_COMMAND				0x00000001
36 #define FSF_SUPPORT_COMMAND			0x00000002
37 #define FSF_CONFIG_COMMAND			0x00000003
38 #define FSF_PORT_COMMAND			0x00000004
39 
40 /* FSF protocol states */
41 #define FSF_PROT_GOOD				0x00000001
42 #define FSF_PROT_QTCB_VERSION_ERROR		0x00000010
43 #define FSF_PROT_SEQ_NUMB_ERROR			0x00000020
44 #define FSF_PROT_UNSUPP_QTCB_TYPE		0x00000040
45 #define FSF_PROT_HOST_CONNECTION_INITIALIZING	0x00000080
46 #define FSF_PROT_FSF_STATUS_PRESENTED		0x00000100
47 #define FSF_PROT_DUPLICATE_REQUEST_ID		0x00000200
48 #define FSF_PROT_LINK_DOWN                      0x00000400
49 #define FSF_PROT_REEST_QUEUE                    0x00000800
50 #define FSF_PROT_ERROR_STATE			0x01000000
51 
52 /* FSF states */
53 #define FSF_GOOD				0x00000000
54 #define FSF_PORT_ALREADY_OPEN			0x00000001
55 #define FSF_LUN_ALREADY_OPEN			0x00000002
56 #define FSF_PORT_HANDLE_NOT_VALID		0x00000003
57 #define FSF_LUN_HANDLE_NOT_VALID		0x00000004
58 #define FSF_HANDLE_MISMATCH			0x00000005
59 #define FSF_SERVICE_CLASS_NOT_SUPPORTED		0x00000006
60 #define FSF_FCPLUN_NOT_VALID			0x00000009
61 #define FSF_LUN_SHARING_VIOLATION               0x00000012
62 #define FSF_FCP_COMMAND_DOES_NOT_EXIST		0x00000022
63 #define FSF_DIRECTION_INDICATOR_NOT_VALID	0x00000030
64 #define FSF_CMND_LENGTH_NOT_VALID		0x00000033
65 #define FSF_MAXIMUM_NUMBER_OF_PORTS_EXCEEDED	0x00000040
66 #define FSF_MAXIMUM_NUMBER_OF_LUNS_EXCEEDED	0x00000041
67 #define FSF_ELS_COMMAND_REJECTED		0x00000050
68 #define FSF_GENERIC_COMMAND_REJECTED		0x00000051
69 #define FSF_PORT_BOXED				0x00000059
70 #define FSF_LUN_BOXED				0x0000005A
71 #define FSF_EXCHANGE_CONFIG_DATA_INCOMPLETE	0x0000005B
72 #define FSF_PAYLOAD_SIZE_MISMATCH		0x00000060
73 #define FSF_REQUEST_SIZE_TOO_LARGE		0x00000061
74 #define FSF_RESPONSE_SIZE_TOO_LARGE		0x00000062
75 #define FSF_SBAL_MISMATCH			0x00000063
76 #define FSF_INCONSISTENT_PROT_DATA		0x00000070
77 #define FSF_INVALID_PROT_PARM			0x00000071
78 #define FSF_BLOCK_GUARD_CHECK_FAILURE		0x00000081
79 #define FSF_APP_TAG_CHECK_FAILURE		0x00000082
80 #define FSF_REF_TAG_CHECK_FAILURE		0x00000083
81 #define FSF_ADAPTER_STATUS_AVAILABLE		0x000000AD
82 #define FSF_FCP_RSP_AVAILABLE			0x000000AF
83 #define FSF_UNKNOWN_COMMAND			0x000000E2
84 #define FSF_UNKNOWN_OP_SUBTYPE                  0x000000E3
85 #define FSF_INVALID_COMMAND_OPTION              0x000000E5
86 
87 #define FSF_PROT_STATUS_QUAL_SIZE		16
88 #define FSF_STATUS_QUALIFIER_SIZE		16
89 
90 /* FSF status qualifier, recommendations */
91 #define FSF_SQ_NO_RECOM				0x00
92 #define FSF_SQ_FCP_RSP_AVAILABLE		0x01
93 #define FSF_SQ_RETRY_IF_POSSIBLE		0x02
94 #define FSF_SQ_ULP_DEPENDENT_ERP_REQUIRED	0x03
95 #define FSF_SQ_INVOKE_LINK_TEST_PROCEDURE	0x04
96 #define FSF_SQ_COMMAND_ABORTED			0x06
97 #define FSF_SQ_NO_RETRY_POSSIBLE		0x07
98 
99 /* FSF status qualifier (most significant 4 bytes), local link down */
100 #define FSF_PSQ_LINK_NO_LIGHT			0x00000004
101 #define FSF_PSQ_LINK_WRAP_PLUG			0x00000008
102 #define FSF_PSQ_LINK_NO_FCP			0x00000010
103 #define FSF_PSQ_LINK_FIRMWARE_UPDATE		0x00000020
104 #define FSF_PSQ_LINK_INVALID_WWPN		0x00000100
105 #define FSF_PSQ_LINK_NO_NPIV_SUPPORT		0x00000200
106 #define FSF_PSQ_LINK_NO_FCP_RESOURCES		0x00000400
107 #define FSF_PSQ_LINK_NO_FABRIC_RESOURCES	0x00000800
108 #define FSF_PSQ_LINK_FABRIC_LOGIN_UNABLE	0x00001000
109 #define FSF_PSQ_LINK_WWPN_ASSIGNMENT_CORRUPTED	0x00002000
110 #define FSF_PSQ_LINK_MODE_TABLE_CURRUPTED	0x00004000
111 #define FSF_PSQ_LINK_NO_WWPN_ASSIGNMENT		0x00008000
112 
113 /* payload size in status read buffer */
114 #define FSF_STATUS_READ_PAYLOAD_SIZE		4032
115 
116 /* number of status read buffers that should be sent by ULP */
117 #define FSF_STATUS_READS_RECOM			16
118 
119 /* status types in status read buffer */
120 #define FSF_STATUS_READ_PORT_CLOSED		0x00000001
121 #define FSF_STATUS_READ_INCOMING_ELS		0x00000002
122 #define FSF_STATUS_READ_SENSE_DATA_AVAIL        0x00000003
123 #define FSF_STATUS_READ_BIT_ERROR_THRESHOLD	0x00000004
124 #define FSF_STATUS_READ_LINK_DOWN		0x00000005
125 #define FSF_STATUS_READ_LINK_UP          	0x00000006
126 #define FSF_STATUS_READ_NOTIFICATION_LOST	0x00000009
127 #define FSF_STATUS_READ_FEATURE_UPDATE_ALERT	0x0000000C
128 
129 /* status subtypes for link down */
130 #define FSF_STATUS_READ_SUB_NO_PHYSICAL_LINK	0x00000000
131 #define FSF_STATUS_READ_SUB_FDISC_FAILED	0x00000001
132 #define FSF_STATUS_READ_SUB_FIRMWARE_UPDATE	0x00000002
133 
134 /* status subtypes for unsolicited status notification lost */
135 #define FSF_STATUS_READ_SUB_INCOMING_ELS	0x00000001
136 
137 /* topologie that is detected by the adapter */
138 #define FSF_TOPO_P2P				0x00000001
139 #define FSF_TOPO_FABRIC				0x00000002
140 #define FSF_TOPO_AL				0x00000003
141 
142 /* data direction for FCP commands */
143 #define FSF_DATADIR_WRITE			0x00000001
144 #define FSF_DATADIR_READ			0x00000002
145 #define FSF_DATADIR_CMND			0x00000004
146 #define FSF_DATADIR_DIF_WRITE_INSERT		0x00000009
147 #define FSF_DATADIR_DIF_READ_STRIP		0x0000000a
148 #define FSF_DATADIR_DIF_WRITE_CONVERT		0x0000000b
149 #define FSF_DATADIR_DIF_READ_CONVERT		0X0000000c
150 
151 /* data protection control flags */
152 #define FSF_APP_TAG_CHECK_ENABLE		0x10
153 
154 /* fc service class */
155 #define FSF_CLASS_3				0x00000003
156 
157 /* logging space behind QTCB */
158 #define FSF_QTCB_LOG_SIZE			1024
159 
160 /* channel features */
161 #define FSF_FEATURE_NOTIFICATION_LOST		0x00000008
162 #define FSF_FEATURE_HBAAPI_MANAGEMENT           0x00000010
163 #define FSF_FEATURE_ELS_CT_CHAINED_SBALS	0x00000020
164 #define FSF_FEATURE_UPDATE_ALERT		0x00000100
165 #define FSF_FEATURE_MEASUREMENT_DATA		0x00000200
166 #define FSF_FEATURE_DIF_PROT_TYPE1		0x00010000
167 #define FSF_FEATURE_DIX_PROT_TCPIP		0x00020000
168 
169 /* host connection features */
170 #define FSF_FEATURE_NPIV_MODE			0x00000001
171 
172 /* option */
173 #define FSF_OPEN_LUN_SUPPRESS_BOXING		0x00000001
174 
175 struct fsf_queue_designator {
176 	u8  cssid;
177 	u8  chpid;
178 	u8  hla;
179 	u8  ua;
180 	u32 res1;
181 } __attribute__ ((packed));
182 
183 struct fsf_bit_error_payload {
184 	u32 res1;
185 	u32 link_failure_error_count;
186 	u32 loss_of_sync_error_count;
187 	u32 loss_of_signal_error_count;
188 	u32 primitive_sequence_error_count;
189 	u32 invalid_transmission_word_error_count;
190 	u32 crc_error_count;
191 	u32 primitive_sequence_event_timeout_count;
192 	u32 elastic_buffer_overrun_error_count;
193 	u32 fcal_arbitration_timeout_count;
194 	u32 advertised_receive_b2b_credit;
195 	u32 current_receive_b2b_credit;
196 	u32 advertised_transmit_b2b_credit;
197 	u32 current_transmit_b2b_credit;
198 } __attribute__ ((packed));
199 
200 struct fsf_link_down_info {
201 	u32 error_code;
202 	u32 res1;
203 	u8 res2[2];
204 	u8 primary_status;
205 	u8 ioerr_code;
206 	u8 action_code;
207 	u8 reason_code;
208 	u8 explanation_code;
209 	u8 vendor_specific_code;
210 } __attribute__ ((packed));
211 
212 struct fsf_status_read_buffer {
213 	u32 status_type;
214 	u32 status_subtype;
215 	u32 length;
216 	u32 res1;
217 	struct fsf_queue_designator queue_designator;
218 	u8 res2;
219 	u8 d_id[3];
220 	u32 class;
221 	u64 fcp_lun;
222 	u8  res3[24];
223 	union {
224 		u8  data[FSF_STATUS_READ_PAYLOAD_SIZE];
225 		u32 word[FSF_STATUS_READ_PAYLOAD_SIZE/sizeof(u32)];
226 		struct fsf_link_down_info link_down_info;
227 		struct fsf_bit_error_payload bit_error;
228 	} payload;
229 } __attribute__ ((packed));
230 
231 struct fsf_qual_version_error {
232 	u32 fsf_version;
233 	u32 res1[3];
234 } __attribute__ ((packed));
235 
236 struct fsf_qual_sequence_error {
237 	u32 exp_req_seq_no;
238 	u32 res1[3];
239 } __attribute__ ((packed));
240 
241 struct fsf_qual_latency_info {
242 	u32 channel_lat;
243 	u32 fabric_lat;
244 	u8 res1[8];
245 } __attribute__ ((packed));
246 
247 union fsf_prot_status_qual {
248 	u32 word[FSF_PROT_STATUS_QUAL_SIZE / sizeof(u32)];
249 	u64 doubleword[FSF_PROT_STATUS_QUAL_SIZE / sizeof(u64)];
250 	struct fsf_qual_version_error   version_error;
251 	struct fsf_qual_sequence_error  sequence_error;
252 	struct fsf_link_down_info link_down_info;
253 	struct fsf_qual_latency_info latency_info;
254 } __attribute__ ((packed));
255 
256 struct fsf_qtcb_prefix {
257 	u64 req_id;
258 	u32 qtcb_version;
259 	u32 ulp_info;
260 	u32 qtcb_type;
261 	u32 req_seq_no;
262 	u32 prot_status;
263 	union fsf_prot_status_qual prot_status_qual;
264 	u8  res1[20];
265 } __attribute__ ((packed));
266 
267 struct fsf_statistics_info {
268 	u64 input_req;
269 	u64 output_req;
270 	u64 control_req;
271 	u64 input_mb;
272 	u64 output_mb;
273 	u64 seconds_act;
274 } __attribute__ ((packed));
275 
276 union fsf_status_qual {
277 	u8  byte[FSF_STATUS_QUALIFIER_SIZE];
278 	u16 halfword[FSF_STATUS_QUALIFIER_SIZE / sizeof (u16)];
279 	u32 word[FSF_STATUS_QUALIFIER_SIZE / sizeof (u32)];
280 	u64 doubleword[FSF_STATUS_QUALIFIER_SIZE / sizeof(u64)];
281 	struct fsf_queue_designator fsf_queue_designator;
282 	struct fsf_link_down_info link_down_info;
283 } __attribute__ ((packed));
284 
285 struct fsf_qtcb_header {
286 	u64 req_handle;
287 	u32 fsf_command;
288 	u32 res1;
289 	u32 port_handle;
290 	u32 lun_handle;
291 	u32 res2;
292 	u32 fsf_status;
293 	union fsf_status_qual fsf_status_qual;
294 	u8  res3[28];
295 	u16 log_start;
296 	u16 log_length;
297 	u8  res4[16];
298 } __attribute__ ((packed));
299 
300 #define FSF_PLOGI_MIN_LEN	112
301 
302 #define FSF_FCP_CMND_SIZE	288
303 #define FSF_FCP_RSP_SIZE	128
304 
305 struct fsf_qtcb_bottom_io {
306 	u32 data_direction;
307 	u32 service_class;
308 	u8  res1;
309 	u8  data_prot_flags;
310 	u16 app_tag_value;
311 	u32 ref_tag_value;
312 	u32 fcp_cmnd_length;
313 	u32 data_block_length;
314 	u32 prot_data_length;
315 	u8  res2[4];
316 	union {
317 		u8		byte[FSF_FCP_CMND_SIZE];
318 		struct fcp_cmnd iu;
319 	}   fcp_cmnd;
320 	union {
321 		u8			 byte[FSF_FCP_RSP_SIZE];
322 		struct fcp_resp_with_ext iu;
323 	}   fcp_rsp;
324 	u8  res3[64];
325 } __attribute__ ((packed));
326 
327 struct fsf_qtcb_bottom_support {
328 	u32 operation_subtype;
329 	u8  res1[13];
330 	u8 d_id[3];
331 	u32 option;
332 	u64 fcp_lun;
333 	u64 res2;
334 	u64 req_handle;
335 	u32 service_class;
336 	u8  res3[3];
337 	u8  timeout;
338         u32 lun_access_info;
339         u8  res4[180];
340 	u32 els1_length;
341 	u32 els2_length;
342 	u32 req_buf_length;
343 	u32 resp_buf_length;
344 	u8  els[256];
345 } __attribute__ ((packed));
346 
347 #define ZFCP_FSF_TIMER_INT_MASK	0x3FFF
348 
349 struct fsf_qtcb_bottom_config {
350 	u32 lic_version;
351 	u32 feature_selection;
352 	u32 high_qtcb_version;
353 	u32 low_qtcb_version;
354 	u32 max_qtcb_size;
355 	u32 max_data_transfer_size;
356 	u32 adapter_features;
357 	u32 connection_features;
358 	u32 fc_topology;
359 	u32 fc_link_speed;	/* one of ZFCP_FSF_PORTSPEED_* */
360 	u32 adapter_type;
361 	u8 res0;
362 	u8 peer_d_id[3];
363 	u16 status_read_buf_num;
364 	u16 timer_interval;
365 	u8 res2[9];
366 	u8 s_id[3];
367 	u8 nport_serv_param[128];
368 	u8 res3[8];
369 	u32 adapter_ports;
370 	u32 hardware_version;
371 	u8 serial_number[32];
372 	u8 plogi_payload[112];
373 	struct fsf_statistics_info stat_info;
374 	u8 res4[112];
375 } __attribute__ ((packed));
376 
377 struct fsf_qtcb_bottom_port {
378 	u64 wwpn;
379 	u32 fc_port_id;
380 	u32 port_type;
381 	u32 port_state;
382 	u32 class_of_service;	/* should be 0x00000006 for class 2 and 3 */
383 	u8 supported_fc4_types[32]; /* should be 0x00000100 for scsi fcp */
384 	u8 active_fc4_types[32];
385 	u32 supported_speed;	/* any combination of ZFCP_FSF_PORTSPEED_* */
386 	u32 maximum_frame_size;	/* fixed value of 2112 */
387 	u64 seconds_since_last_reset;
388 	u64 tx_frames;
389 	u64 tx_words;
390 	u64 rx_frames;
391 	u64 rx_words;
392 	u64 lip;		/* 0 */
393 	u64 nos;		/* currently 0 */
394 	u64 error_frames;	/* currently 0 */
395 	u64 dumped_frames;	/* currently 0 */
396 	u64 link_failure;
397 	u64 loss_of_sync;
398 	u64 loss_of_signal;
399 	u64 psp_error_counts;
400 	u64 invalid_tx_words;
401 	u64 invalid_crcs;
402 	u64 input_requests;
403 	u64 output_requests;
404 	u64 control_requests;
405 	u64 input_mb;		/* where 1 MByte == 1.000.000 Bytes */
406 	u64 output_mb;		/* where 1 MByte == 1.000.000 Bytes */
407 	u8 cp_util;
408 	u8 cb_util;
409 	u8 a_util;
410 	u8 res2[253];
411 } __attribute__ ((packed));
412 
413 union fsf_qtcb_bottom {
414 	struct fsf_qtcb_bottom_io      io;
415 	struct fsf_qtcb_bottom_support support;
416 	struct fsf_qtcb_bottom_config  config;
417 	struct fsf_qtcb_bottom_port port;
418 };
419 
420 struct fsf_qtcb {
421 	struct fsf_qtcb_prefix prefix;
422 	struct fsf_qtcb_header header;
423 	union  fsf_qtcb_bottom bottom;
424 	u8 log[FSF_QTCB_LOG_SIZE];
425 } __attribute__ ((packed));
426 
427 struct zfcp_blk_drv_data {
428 #define ZFCP_BLK_DRV_DATA_MAGIC			0x1
429 	u32 magic;
430 #define ZFCP_BLK_LAT_VALID			0x1
431 #define ZFCP_BLK_REQ_ERROR			0x2
432 	u16 flags;
433 	u8 inb_usage;
434 	u8 outb_usage;
435 	u64 channel_lat;
436 	u64 fabric_lat;
437 } __attribute__ ((packed));
438 
439 /**
440  * struct zfcp_fsf_ct_els - zfcp data for ct or els request
441  * @req: scatter-gather list for request
442  * @resp: scatter-gather list for response
443  * @handler: handler function (called for response to the request)
444  * @handler_data: data passed to handler function
445  * @port: Optional pointer to port for zfcp internal ELS (only test link ADISC)
446  * @status: used to pass error status to calling function
447  * @d_id: Destination ID of either open WKA port for CT or of D_ID for ELS
448  */
449 struct zfcp_fsf_ct_els {
450 	struct scatterlist *req;
451 	struct scatterlist *resp;
452 	void (*handler)(void *);
453 	void *handler_data;
454 	struct zfcp_port *port;
455 	int status;
456 	u32 d_id;
457 };
458 
459 #endif				/* FSF_H */
460