1 /* SPDX-License-Identifier: GPL-2.0 */
5 * Interface to the FSF support functions.
7 * Copyright IBM Corp. 2002, 2020
13 #include <linux/pfn.h>
14 #include <linux/scatterlist.h>
15 #include <scsi/libfc.h>
17 #define FSF_QTCB_CURRENT_VERSION 0x00000001
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
35 #define FSF_IO_COMMAND 0x00000001
36 #define FSF_SUPPORT_COMMAND 0x00000002
37 #define FSF_CONFIG_COMMAND 0x00000003
38 #define FSF_PORT_COMMAND 0x00000004
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
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_SECURITY_ERROR 0x00000090
82 #define FSF_ADAPTER_STATUS_AVAILABLE 0x000000AD
83 #define FSF_FCP_RSP_AVAILABLE 0x000000AF
84 #define FSF_UNKNOWN_COMMAND 0x000000E2
85 #define FSF_UNKNOWN_OP_SUBTYPE 0x000000E3
86 #define FSF_INVALID_COMMAND_OPTION 0x000000E5
88 #define FSF_PROT_STATUS_QUAL_SIZE 16
89 #define FSF_STATUS_QUALIFIER_SIZE 16
91 /* FSF status qualifier, recommendations */
92 #define FSF_SQ_NO_RECOM 0x00
93 #define FSF_SQ_FCP_RSP_AVAILABLE 0x01
94 #define FSF_SQ_RETRY_IF_POSSIBLE 0x02
95 #define FSF_SQ_ULP_DEPENDENT_ERP_REQUIRED 0x03
96 #define FSF_SQ_INVOKE_LINK_TEST_PROCEDURE 0x04
97 #define FSF_SQ_COMMAND_ABORTED 0x06
98 #define FSF_SQ_NO_RETRY_POSSIBLE 0x07
100 /* FSF status qualifier (most significant 4 bytes), local link down */
101 #define FSF_PSQ_LINK_NO_LIGHT 0x00000004
102 #define FSF_PSQ_LINK_WRAP_PLUG 0x00000008
103 #define FSF_PSQ_LINK_NO_FCP 0x00000010
104 #define FSF_PSQ_LINK_FIRMWARE_UPDATE 0x00000020
105 #define FSF_PSQ_LINK_INVALID_WWPN 0x00000100
106 #define FSF_PSQ_LINK_NO_NPIV_SUPPORT 0x00000200
107 #define FSF_PSQ_LINK_NO_FCP_RESOURCES 0x00000400
108 #define FSF_PSQ_LINK_NO_FABRIC_RESOURCES 0x00000800
109 #define FSF_PSQ_LINK_FABRIC_LOGIN_UNABLE 0x00001000
110 #define FSF_PSQ_LINK_WWPN_ASSIGNMENT_CORRUPTED 0x00002000
111 #define FSF_PSQ_LINK_MODE_TABLE_CURRUPTED 0x00004000
112 #define FSF_PSQ_LINK_NO_WWPN_ASSIGNMENT 0x00008000
114 /* FSF status qualifier, security error */
115 #define FSF_SQ_SECURITY_REQUIRED 0x00000001
116 #define FSF_SQ_SECURITY_TIMEOUT 0x00000002
117 #define FSF_SQ_SECURITY_KM_UNAVAILABLE 0x00000003
118 #define FSF_SQ_SECURITY_RKM_UNAVAILABLE 0x00000004
119 #define FSF_SQ_SECURITY_AUTH_FAILURE 0x00000005
120 #define FSF_SQ_SECURITY_ENC_FAILURE 0x00000010
122 /* payload size in status read buffer */
123 #define FSF_STATUS_READ_PAYLOAD_SIZE 4032
125 /* number of status read buffers that should be sent by ULP */
126 #define FSF_STATUS_READS_RECOM 16
128 /* status types in status read buffer */
129 #define FSF_STATUS_READ_PORT_CLOSED 0x00000001
130 #define FSF_STATUS_READ_INCOMING_ELS 0x00000002
131 #define FSF_STATUS_READ_SENSE_DATA_AVAIL 0x00000003
132 #define FSF_STATUS_READ_BIT_ERROR_THRESHOLD 0x00000004
133 #define FSF_STATUS_READ_LINK_DOWN 0x00000005
134 #define FSF_STATUS_READ_LINK_UP 0x00000006
135 #define FSF_STATUS_READ_NOTIFICATION_LOST 0x00000009
136 #define FSF_STATUS_READ_FEATURE_UPDATE_ALERT 0x0000000C
138 /* status subtypes for link down */
139 #define FSF_STATUS_READ_SUB_NO_PHYSICAL_LINK 0x00000000
140 #define FSF_STATUS_READ_SUB_FDISC_FAILED 0x00000001
141 #define FSF_STATUS_READ_SUB_FIRMWARE_UPDATE 0x00000002
143 /* status subtypes for unsolicited status notification lost */
144 #define FSF_STATUS_READ_SUB_INCOMING_ELS 0x00000001
146 /* topologie that is detected by the adapter */
147 #define FSF_TOPO_P2P 0x00000001
148 #define FSF_TOPO_FABRIC 0x00000002
149 #define FSF_TOPO_AL 0x00000003
151 /* data direction for FCP commands */
152 #define FSF_DATADIR_WRITE 0x00000001
153 #define FSF_DATADIR_READ 0x00000002
154 #define FSF_DATADIR_CMND 0x00000004
155 #define FSF_DATADIR_DIF_WRITE_INSERT 0x00000009
156 #define FSF_DATADIR_DIF_READ_STRIP 0x0000000a
157 #define FSF_DATADIR_DIF_WRITE_CONVERT 0x0000000b
158 #define FSF_DATADIR_DIF_READ_CONVERT 0X0000000c
160 /* data protection control flags */
161 #define FSF_APP_TAG_CHECK_ENABLE 0x10
163 /* fc service class */
164 #define FSF_CLASS_3 0x00000003
166 /* logging space behind QTCB */
167 #define FSF_QTCB_LOG_SIZE 1024
169 /* channel features */
170 #define FSF_FEATURE_NOTIFICATION_LOST 0x00000008
171 #define FSF_FEATURE_HBAAPI_MANAGEMENT 0x00000010
172 #define FSF_FEATURE_ELS_CT_CHAINED_SBALS 0x00000020
173 #define FSF_FEATURE_UPDATE_ALERT 0x00000100
174 #define FSF_FEATURE_MEASUREMENT_DATA 0x00000200
175 #define FSF_FEATURE_REQUEST_SFP_DATA 0x00000200
176 #define FSF_FEATURE_REPORT_SFP_DATA 0x00000800
177 #define FSF_FEATURE_FC_SECURITY 0x00001000
178 #define FSF_FEATURE_DIF_PROT_TYPE1 0x00010000
179 #define FSF_FEATURE_DIX_PROT_TCPIP 0x00020000
181 /* host connection features */
182 #define FSF_FEATURE_NPIV_MODE 0x00000001
185 #define FSF_OPEN_LUN_SUPPRESS_BOXING 0x00000001
187 /* FC security algorithms */
188 #define FSF_FC_SECURITY_AUTH 0x00000001
189 #define FSF_FC_SECURITY_ENC_FCSP2 0x00000002
190 #define FSF_FC_SECURITY_ENC_ERAS 0x00000004
192 struct fsf_queue_designator {
198 } __attribute__ ((packed));
200 struct fsf_bit_error_payload {
202 u32 link_failure_error_count;
203 u32 loss_of_sync_error_count;
204 u32 loss_of_signal_error_count;
205 u32 primitive_sequence_error_count;
206 u32 invalid_transmission_word_error_count;
208 u32 primitive_sequence_event_timeout_count;
209 u32 elastic_buffer_overrun_error_count;
210 u32 fcal_arbitration_timeout_count;
211 u32 advertised_receive_b2b_credit;
212 u32 current_receive_b2b_credit;
213 u32 advertised_transmit_b2b_credit;
214 u32 current_transmit_b2b_credit;
215 } __attribute__ ((packed));
217 struct fsf_link_down_info {
226 u8 vendor_specific_code;
227 } __attribute__ ((packed));
229 struct fsf_status_read_buffer {
234 struct fsf_queue_designator queue_designator;
241 u8 data[FSF_STATUS_READ_PAYLOAD_SIZE];
242 u32 word[FSF_STATUS_READ_PAYLOAD_SIZE/sizeof(u32)];
243 struct fsf_link_down_info link_down_info;
244 struct fsf_bit_error_payload bit_error;
246 } __attribute__ ((packed));
248 struct fsf_qual_version_error {
251 } __attribute__ ((packed));
253 struct fsf_qual_sequence_error {
256 } __attribute__ ((packed));
258 struct fsf_qual_latency_info {
262 } __attribute__ ((packed));
264 union fsf_prot_status_qual {
265 u32 word[FSF_PROT_STATUS_QUAL_SIZE / sizeof(u32)];
266 u64 doubleword[FSF_PROT_STATUS_QUAL_SIZE / sizeof(u64)];
267 struct fsf_qual_version_error version_error;
268 struct fsf_qual_sequence_error sequence_error;
269 struct fsf_link_down_info link_down_info;
270 struct fsf_qual_latency_info latency_info;
271 } __attribute__ ((packed));
273 struct fsf_qtcb_prefix {
280 union fsf_prot_status_qual prot_status_qual;
282 } __attribute__ ((packed));
284 struct fsf_statistics_info {
291 } __attribute__ ((packed));
293 union fsf_status_qual {
294 u8 byte[FSF_STATUS_QUALIFIER_SIZE];
295 u16 halfword[FSF_STATUS_QUALIFIER_SIZE / sizeof (u16)];
296 u32 word[FSF_STATUS_QUALIFIER_SIZE / sizeof (u32)];
297 u64 doubleword[FSF_STATUS_QUALIFIER_SIZE / sizeof(u64)];
298 struct fsf_queue_designator fsf_queue_designator;
299 struct fsf_link_down_info link_down_info;
300 } __attribute__ ((packed));
302 struct fsf_qtcb_header {
310 union fsf_status_qual fsf_status_qual;
315 } __attribute__ ((packed));
317 #define FSF_PLOGI_MIN_LEN 112
319 #define FSF_FCP_CMND_SIZE 288
320 #define FSF_FCP_RSP_SIZE 128
322 struct fsf_qtcb_bottom_io {
330 u32 data_block_length;
331 u32 prot_data_length;
334 u8 byte[FSF_FCP_CMND_SIZE];
338 u8 byte[FSF_FCP_RSP_SIZE];
339 struct fcp_resp_with_ext iu;
342 } __attribute__ ((packed));
344 struct fsf_qtcb_bottom_support {
345 u32 operation_subtype;
363 } __attribute__ ((packed));
365 #define ZFCP_FSF_TIMER_INT_MASK 0x3FFF
367 struct fsf_qtcb_bottom_config {
369 u32 feature_selection;
370 u32 high_qtcb_version;
371 u32 low_qtcb_version;
373 u32 max_data_transfer_size;
374 u32 adapter_features;
375 u32 connection_features;
377 u32 fc_link_speed; /* one of ZFCP_FSF_PORTSPEED_* */
381 u16 status_read_buf_num;
385 u8 nport_serv_param[128];
388 u32 hardware_version;
389 u8 serial_number[32];
390 u8 plogi_payload[112];
391 struct fsf_statistics_info stat_info;
393 } __attribute__ ((packed));
395 struct fsf_qtcb_bottom_port {
400 u32 class_of_service; /* should be 0x00000006 for class 2 and 3 */
401 u8 supported_fc4_types[32]; /* should be 0x00000100 for scsi fcp */
402 u8 active_fc4_types[32];
403 u32 supported_speed; /* any combination of ZFCP_FSF_PORTSPEED_* */
404 u32 maximum_frame_size; /* fixed value of 2112 */
405 u64 seconds_since_last_reset;
411 u64 nos; /* currently 0 */
412 u64 error_frames; /* currently 0 */
413 u64 dumped_frames; /* currently 0 */
417 u64 psp_error_counts;
418 u64 invalid_tx_words;
422 u64 control_requests;
423 u64 input_mb; /* where 1 MByte == 1.000.000 Bytes */
424 u64 output_mb; /* where 1 MByte == 1.000.000 Bytes */
439 u16 connector_type :2;
445 u32 fc_security_algorithms;
447 } __attribute__ ((packed));
449 union fsf_qtcb_bottom {
450 struct fsf_qtcb_bottom_io io;
451 struct fsf_qtcb_bottom_support support;
452 struct fsf_qtcb_bottom_config config;
453 struct fsf_qtcb_bottom_port port;
457 struct fsf_qtcb_prefix prefix;
458 struct fsf_qtcb_header header;
459 union fsf_qtcb_bottom bottom;
460 u8 log[FSF_QTCB_LOG_SIZE];
461 } __attribute__ ((packed));
463 struct zfcp_blk_drv_data {
464 #define ZFCP_BLK_DRV_DATA_MAGIC 0x1
466 #define ZFCP_BLK_LAT_VALID 0x1
467 #define ZFCP_BLK_REQ_ERROR 0x2
473 } __attribute__ ((packed));
476 * struct zfcp_fsf_ct_els - zfcp data for ct or els request
477 * @req: scatter-gather list for request, points to &zfcp_fc_req.sg_req or BSG
478 * @resp: scatter-gather list for response, points to &zfcp_fc_req.sg_rsp or BSG
479 * @handler: handler function (called for response to the request)
480 * @handler_data: data passed to handler function
481 * @port: Optional pointer to port for zfcp internal ELS (only test link ADISC)
482 * @status: used to pass error status to calling function
483 * @d_id: Destination ID of either open WKA port for CT or of D_ID for ELS
485 struct zfcp_fsf_ct_els {
486 struct scatterlist *req;
487 struct scatterlist *resp;
488 void (*handler)(void *);
490 struct zfcp_port *port;