4 * Interface to the FSF support functions.
6 * Copyright IBM Corporation 2002, 2008
12 #include <linux/pfn.h>
14 #define FSF_QTCB_CURRENT_VERSION 0x00000001
17 #define FSF_QTCB_FCP_CMND 0x00000001
18 #define FSF_QTCB_ABORT_FCP_CMND 0x00000002
19 #define FSF_QTCB_OPEN_PORT_WITH_DID 0x00000005
20 #define FSF_QTCB_OPEN_LUN 0x00000006
21 #define FSF_QTCB_CLOSE_LUN 0x00000007
22 #define FSF_QTCB_CLOSE_PORT 0x00000008
23 #define FSF_QTCB_CLOSE_PHYSICAL_PORT 0x00000009
24 #define FSF_QTCB_SEND_ELS 0x0000000B
25 #define FSF_QTCB_SEND_GENERIC 0x0000000C
26 #define FSF_QTCB_EXCHANGE_CONFIG_DATA 0x0000000D
27 #define FSF_QTCB_EXCHANGE_PORT_DATA 0x0000000E
28 #define FSF_QTCB_DOWNLOAD_CONTROL_FILE 0x00000012
29 #define FSF_QTCB_UPLOAD_CONTROL_FILE 0x00000013
32 #define FSF_IO_COMMAND 0x00000001
33 #define FSF_SUPPORT_COMMAND 0x00000002
34 #define FSF_CONFIG_COMMAND 0x00000003
35 #define FSF_PORT_COMMAND 0x00000004
37 /* FSF control file upload/download operations' subtype and options */
38 #define FSF_CFDC_OPERATION_SUBTYPE 0x00020001
39 #define FSF_CFDC_OPTION_NORMAL_MODE 0x00000000
40 #define FSF_CFDC_OPTION_FORCE 0x00000001
41 #define FSF_CFDC_OPTION_FULL_ACCESS 0x00000002
42 #define FSF_CFDC_OPTION_RESTRICTED_ACCESS 0x00000004
44 /* FSF protocol states */
45 #define FSF_PROT_GOOD 0x00000001
46 #define FSF_PROT_QTCB_VERSION_ERROR 0x00000010
47 #define FSF_PROT_SEQ_NUMB_ERROR 0x00000020
48 #define FSF_PROT_UNSUPP_QTCB_TYPE 0x00000040
49 #define FSF_PROT_HOST_CONNECTION_INITIALIZING 0x00000080
50 #define FSF_PROT_FSF_STATUS_PRESENTED 0x00000100
51 #define FSF_PROT_DUPLICATE_REQUEST_ID 0x00000200
52 #define FSF_PROT_LINK_DOWN 0x00000400
53 #define FSF_PROT_REEST_QUEUE 0x00000800
54 #define FSF_PROT_ERROR_STATE 0x01000000
57 #define FSF_GOOD 0x00000000
58 #define FSF_PORT_ALREADY_OPEN 0x00000001
59 #define FSF_LUN_ALREADY_OPEN 0x00000002
60 #define FSF_PORT_HANDLE_NOT_VALID 0x00000003
61 #define FSF_LUN_HANDLE_NOT_VALID 0x00000004
62 #define FSF_HANDLE_MISMATCH 0x00000005
63 #define FSF_SERVICE_CLASS_NOT_SUPPORTED 0x00000006
64 #define FSF_FCPLUN_NOT_VALID 0x00000009
65 #define FSF_ACCESS_DENIED 0x00000010
66 #define FSF_LUN_SHARING_VIOLATION 0x00000012
67 #define FSF_FCP_COMMAND_DOES_NOT_EXIST 0x00000022
68 #define FSF_DIRECTION_INDICATOR_NOT_VALID 0x00000030
69 #define FSF_CMND_LENGTH_NOT_VALID 0x00000033
70 #define FSF_MAXIMUM_NUMBER_OF_PORTS_EXCEEDED 0x00000040
71 #define FSF_MAXIMUM_NUMBER_OF_LUNS_EXCEEDED 0x00000041
72 #define FSF_ELS_COMMAND_REJECTED 0x00000050
73 #define FSF_GENERIC_COMMAND_REJECTED 0x00000051
74 #define FSF_OPERATION_PARTIALLY_SUCCESSFUL 0x00000052
75 #define FSF_AUTHORIZATION_FAILURE 0x00000053
76 #define FSF_CFDC_ERROR_DETECTED 0x00000054
77 #define FSF_CONTROL_FILE_UPDATE_ERROR 0x00000055
78 #define FSF_CONTROL_FILE_TOO_LARGE 0x00000056
79 #define FSF_ACCESS_CONFLICT_DETECTED 0x00000057
80 #define FSF_CONFLICTS_OVERRULED 0x00000058
81 #define FSF_PORT_BOXED 0x00000059
82 #define FSF_LUN_BOXED 0x0000005A
83 #define FSF_EXCHANGE_CONFIG_DATA_INCOMPLETE 0x0000005B
84 #define FSF_PAYLOAD_SIZE_MISMATCH 0x00000060
85 #define FSF_REQUEST_SIZE_TOO_LARGE 0x00000061
86 #define FSF_RESPONSE_SIZE_TOO_LARGE 0x00000062
87 #define FSF_SBAL_MISMATCH 0x00000063
88 #define FSF_OPEN_PORT_WITHOUT_PRLI 0x00000064
89 #define FSF_ADAPTER_STATUS_AVAILABLE 0x000000AD
90 #define FSF_FCP_RSP_AVAILABLE 0x000000AF
91 #define FSF_UNKNOWN_COMMAND 0x000000E2
92 #define FSF_UNKNOWN_OP_SUBTYPE 0x000000E3
93 #define FSF_INVALID_COMMAND_OPTION 0x000000E5
94 /* #define FSF_ERROR 0x000000FF */
96 #define FSF_PROT_STATUS_QUAL_SIZE 16
97 #define FSF_STATUS_QUALIFIER_SIZE 16
99 /* FSF status qualifier, recommendations */
100 #define FSF_SQ_NO_RECOM 0x00
101 #define FSF_SQ_FCP_RSP_AVAILABLE 0x01
102 #define FSF_SQ_RETRY_IF_POSSIBLE 0x02
103 #define FSF_SQ_ULP_DEPENDENT_ERP_REQUIRED 0x03
104 #define FSF_SQ_INVOKE_LINK_TEST_PROCEDURE 0x04
105 #define FSF_SQ_ULP_PROGRAMMING_ERROR 0x05
106 #define FSF_SQ_COMMAND_ABORTED 0x06
107 #define FSF_SQ_NO_RETRY_POSSIBLE 0x07
109 /* FSF status qualifier for CFDC commands */
110 #define FSF_SQ_CFDC_HARDENED_ON_SE 0x00000000
111 #define FSF_SQ_CFDC_COULD_NOT_HARDEN_ON_SE 0x00000001
112 #define FSF_SQ_CFDC_COULD_NOT_HARDEN_ON_SE2 0x00000002
113 /* CFDC subtable codes */
114 #define FSF_SQ_CFDC_SUBTABLE_OS 0x0001
115 #define FSF_SQ_CFDC_SUBTABLE_PORT_WWPN 0x0002
116 #define FSF_SQ_CFDC_SUBTABLE_PORT_DID 0x0003
117 #define FSF_SQ_CFDC_SUBTABLE_LUN 0x0004
119 /* FSF status qualifier (most significant 4 bytes), local link down */
120 #define FSF_PSQ_LINK_NO_LIGHT 0x00000004
121 #define FSF_PSQ_LINK_WRAP_PLUG 0x00000008
122 #define FSF_PSQ_LINK_NO_FCP 0x00000010
123 #define FSF_PSQ_LINK_FIRMWARE_UPDATE 0x00000020
124 #define FSF_PSQ_LINK_INVALID_WWPN 0x00000100
125 #define FSF_PSQ_LINK_NO_NPIV_SUPPORT 0x00000200
126 #define FSF_PSQ_LINK_NO_FCP_RESOURCES 0x00000400
127 #define FSF_PSQ_LINK_NO_FABRIC_RESOURCES 0x00000800
128 #define FSF_PSQ_LINK_FABRIC_LOGIN_UNABLE 0x00001000
129 #define FSF_PSQ_LINK_WWPN_ASSIGNMENT_CORRUPTED 0x00002000
130 #define FSF_PSQ_LINK_MODE_TABLE_CURRUPTED 0x00004000
131 #define FSF_PSQ_LINK_NO_WWPN_ASSIGNMENT 0x00008000
133 /* payload size in status read buffer */
134 #define FSF_STATUS_READ_PAYLOAD_SIZE 4032
136 /* number of status read buffers that should be sent by ULP */
137 #define FSF_STATUS_READS_RECOM 16
139 /* status types in status read buffer */
140 #define FSF_STATUS_READ_PORT_CLOSED 0x00000001
141 #define FSF_STATUS_READ_INCOMING_ELS 0x00000002
142 #define FSF_STATUS_READ_SENSE_DATA_AVAIL 0x00000003
143 #define FSF_STATUS_READ_BIT_ERROR_THRESHOLD 0x00000004
144 #define FSF_STATUS_READ_LINK_DOWN 0x00000005
145 #define FSF_STATUS_READ_LINK_UP 0x00000006
146 #define FSF_STATUS_READ_NOTIFICATION_LOST 0x00000009
147 #define FSF_STATUS_READ_CFDC_UPDATED 0x0000000A
148 #define FSF_STATUS_READ_CFDC_HARDENED 0x0000000B
149 #define FSF_STATUS_READ_FEATURE_UPDATE_ALERT 0x0000000C
151 /* status subtypes in status read buffer */
152 #define FSF_STATUS_READ_SUB_CLOSE_PHYS_PORT 0x00000001
153 #define FSF_STATUS_READ_SUB_ERROR_PORT 0x00000002
155 /* status subtypes for link down */
156 #define FSF_STATUS_READ_SUB_NO_PHYSICAL_LINK 0x00000000
157 #define FSF_STATUS_READ_SUB_FDISC_FAILED 0x00000001
158 #define FSF_STATUS_READ_SUB_FIRMWARE_UPDATE 0x00000002
160 /* status subtypes for unsolicited status notification lost */
161 #define FSF_STATUS_READ_SUB_INCOMING_ELS 0x00000001
162 #define FSF_STATUS_READ_SUB_SENSE_DATA 0x00000002
163 #define FSF_STATUS_READ_SUB_LINK_STATUS 0x00000004
164 #define FSF_STATUS_READ_SUB_PORT_CLOSED 0x00000008
165 #define FSF_STATUS_READ_SUB_BIT_ERROR_THRESHOLD 0x00000010
166 #define FSF_STATUS_READ_SUB_ACT_UPDATED 0x00000020
167 #define FSF_STATUS_READ_SUB_ACT_HARDENED 0x00000040
168 #define FSF_STATUS_READ_SUB_FEATURE_UPDATE_ALERT 0x00000080
170 /* status subtypes for CFDC */
171 #define FSF_STATUS_READ_SUB_CFDC_HARDENED_ON_SE 0x00000002
172 #define FSF_STATUS_READ_SUB_CFDC_HARDENED_ON_SE2 0x0000000F
174 /* topologie that is detected by the adapter */
175 #define FSF_TOPO_ERROR 0x00000000
176 #define FSF_TOPO_P2P 0x00000001
177 #define FSF_TOPO_FABRIC 0x00000002
178 #define FSF_TOPO_AL 0x00000003
180 /* data direction for FCP commands */
181 #define FSF_DATADIR_WRITE 0x00000001
182 #define FSF_DATADIR_READ 0x00000002
183 #define FSF_DATADIR_READ_WRITE 0x00000003
184 #define FSF_DATADIR_CMND 0x00000004
186 /* fc service class */
187 #define FSF_CLASS_1 0x00000001
188 #define FSF_CLASS_2 0x00000002
189 #define FSF_CLASS_3 0x00000003
192 #define FSF_MAX_SBALS_PER_REQ 36
193 #define FSF_MAX_SBALS_PER_ELS_REQ 2
195 /* logging space behind QTCB */
196 #define FSF_QTCB_LOG_SIZE 1024
198 /* channel features */
199 #define FSF_FEATURE_CFDC 0x00000002
200 #define FSF_FEATURE_LUN_SHARING 0x00000004
201 #define FSF_FEATURE_NOTIFICATION_LOST 0x00000008
202 #define FSF_FEATURE_HBAAPI_MANAGEMENT 0x00000010
203 #define FSF_FEATURE_ELS_CT_CHAINED_SBALS 0x00000020
204 #define FSF_FEATURE_UPDATE_ALERT 0x00000100
205 #define FSF_FEATURE_MEASUREMENT_DATA 0x00000200
207 /* host connection features */
208 #define FSF_FEATURE_NPIV_MODE 0x00000001
209 #define FSF_FEATURE_VM_ASSIGNED_WWPN 0x00000002
212 #define FSF_OPEN_LUN_SUPPRESS_BOXING 0x00000001
213 #define FSF_OPEN_LUN_REPLICATE_SENSE 0x00000002
216 #define FSF_ADAPTER_TYPE_FICON 0x00000001
217 #define FSF_ADAPTER_TYPE_FICON_EXPRESS 0x00000002
220 #define FSF_HBA_PORTTYPE_UNKNOWN 0x00000001
221 #define FSF_HBA_PORTTYPE_NOTPRESENT 0x00000003
222 #define FSF_HBA_PORTTYPE_NPORT 0x00000005
223 #define FSF_HBA_PORTTYPE_PTP 0x00000021
224 /* following are not defined and used by FSF Spec
225 but are additionally defined by FC-HBA */
226 #define FSF_HBA_PORTTYPE_OTHER 0x00000002
227 #define FSF_HBA_PORTTYPE_NOTPRESENT 0x00000003
228 #define FSF_HBA_PORTTYPE_NLPORT 0x00000006
229 #define FSF_HBA_PORTTYPE_FLPORT 0x00000007
230 #define FSF_HBA_PORTTYPE_FPORT 0x00000008
231 #define FSF_HBA_PORTTYPE_LPORT 0x00000020
234 #define FSF_HBA_PORTSTATE_UNKNOWN 0x00000001
235 #define FSF_HBA_PORTSTATE_ONLINE 0x00000002
236 #define FSF_HBA_PORTSTATE_OFFLINE 0x00000003
237 #define FSF_HBA_PORTSTATE_LINKDOWN 0x00000006
238 #define FSF_HBA_PORTSTATE_ERROR 0x00000007
240 /* IO states of adapter */
241 #define FSF_IOSTAT_NPORT_RJT 0x00000004
242 #define FSF_IOSTAT_FABRIC_RJT 0x00000005
243 #define FSF_IOSTAT_LS_RJT 0x00000009
245 /* open LUN access flags*/
246 #define FSF_UNIT_ACCESS_OPEN_LUN_ALLOWED 0x01000000
247 #define FSF_UNIT_ACCESS_EXCLUSIVE 0x02000000
248 #define FSF_UNIT_ACCESS_OUTBOUND_TRANSFER 0x10000000
250 /* FSF interface for CFDC */
251 #define ZFCP_CFDC_MAX_SIZE 127 * 1024
252 #define ZFCP_CFDC_PAGES PFN_UP(ZFCP_CFDC_MAX_SIZE)
254 struct zfcp_fsf_cfdc {
255 struct scatterlist sg[ZFCP_CFDC_PAGES];
260 struct fsf_queue_designator {
266 } __attribute__ ((packed));
268 struct fsf_port_closed_payload {
269 struct fsf_queue_designator queue_designator;
271 } __attribute__ ((packed));
273 struct fsf_bit_error_payload {
275 u32 link_failure_error_count;
276 u32 loss_of_sync_error_count;
277 u32 loss_of_signal_error_count;
278 u32 primitive_sequence_error_count;
279 u32 invalid_transmission_word_error_count;
281 u32 primitive_sequence_event_timeout_count;
282 u32 elastic_buffer_overrun_error_count;
283 u32 fcal_arbitration_timeout_count;
284 u32 advertised_receive_b2b_credit;
285 u32 current_receive_b2b_credit;
286 u32 advertised_transmit_b2b_credit;
287 u32 current_transmit_b2b_credit;
288 } __attribute__ ((packed));
290 struct fsf_link_down_info {
299 u8 vendor_specific_code;
300 } __attribute__ ((packed));
302 struct fsf_status_read_buffer {
307 struct fsf_queue_designator queue_designator;
313 u8 data[FSF_STATUS_READ_PAYLOAD_SIZE];
314 u32 word[FSF_STATUS_READ_PAYLOAD_SIZE/sizeof(u32)];
315 struct fsf_link_down_info link_down_info;
316 struct fsf_bit_error_payload bit_error;
318 } __attribute__ ((packed));
320 struct fsf_qual_version_error {
323 } __attribute__ ((packed));
325 struct fsf_qual_sequence_error {
328 } __attribute__ ((packed));
330 struct fsf_qual_latency_info {
334 } __attribute__ ((packed));
336 union fsf_prot_status_qual {
337 u32 word[FSF_PROT_STATUS_QUAL_SIZE / sizeof(u32)];
338 u64 doubleword[FSF_PROT_STATUS_QUAL_SIZE / sizeof(u64)];
339 struct fsf_qual_version_error version_error;
340 struct fsf_qual_sequence_error sequence_error;
341 struct fsf_link_down_info link_down_info;
342 struct fsf_qual_latency_info latency_info;
343 } __attribute__ ((packed));
345 struct fsf_qtcb_prefix {
352 union fsf_prot_status_qual prot_status_qual;
354 } __attribute__ ((packed));
356 struct fsf_statistics_info {
363 } __attribute__ ((packed));
365 union fsf_status_qual {
366 u8 byte[FSF_STATUS_QUALIFIER_SIZE];
367 u16 halfword[FSF_STATUS_QUALIFIER_SIZE / sizeof (u16)];
368 u32 word[FSF_STATUS_QUALIFIER_SIZE / sizeof (u32)];
369 u64 doubleword[FSF_STATUS_QUALIFIER_SIZE / sizeof(u64)];
370 struct fsf_queue_designator fsf_queue_designator;
371 struct fsf_link_down_info link_down_info;
372 } __attribute__ ((packed));
374 struct fsf_qtcb_header {
382 union fsf_status_qual fsf_status_qual;
387 } __attribute__ ((packed));
389 struct fsf_nport_serv_param {
390 u8 common_serv_param[16];
393 u8 class1_serv_param[16];
394 u8 class2_serv_param[16];
395 u8 class3_serv_param[16];
396 u8 class4_serv_param[16];
397 u8 vendor_version_level[16];
398 } __attribute__ ((packed));
402 struct fsf_nport_serv_param serv_param;
403 } __attribute__ ((packed));
405 #define FSF_FCP_CMND_SIZE 288
406 #define FSF_FCP_RSP_SIZE 128
408 struct fsf_qtcb_bottom_io {
414 u8 fcp_cmnd[FSF_FCP_CMND_SIZE];
415 u8 fcp_rsp[FSF_FCP_RSP_SIZE];
417 } __attribute__ ((packed));
419 struct fsf_qtcb_bottom_support {
420 u32 operation_subtype;
437 } __attribute__ ((packed));
439 struct fsf_qtcb_bottom_config {
441 u32 feature_selection;
442 u32 high_qtcb_version;
443 u32 low_qtcb_version;
445 u32 max_data_transfer_size;
446 u32 adapter_features;
447 u32 connection_features;
456 struct fsf_nport_serv_param nport_serv_param;
457 u8 reserved_nport_serv_param[16];
460 u32 hardware_version;
461 u8 serial_number[32];
462 struct fsf_nport_serv_param plogi_payload;
463 struct fsf_statistics_info stat_info;
465 } __attribute__ ((packed));
467 struct fsf_qtcb_bottom_port {
472 u32 class_of_service; /* should be 0x00000006 for class 2 and 3 */
473 u8 supported_fc4_types[32]; /* should be 0x00000100 for scsi fcp */
474 u8 active_fc4_types[32];
475 u32 supported_speed; /* 0x0001 for 1 GBit/s or 0x0002 for 2 GBit/s */
476 u32 maximum_frame_size; /* fixed value of 2112 */
477 u64 seconds_since_last_reset;
483 u64 nos; /* currently 0 */
484 u64 error_frames; /* currently 0 */
485 u64 dumped_frames; /* currently 0 */
489 u64 psp_error_counts;
490 u64 invalid_tx_words;
494 u64 control_requests;
495 u64 input_mb; /* where 1 MByte == 1.000.000 Bytes */
496 u64 output_mb; /* where 1 MByte == 1.000.000 Bytes */
501 } __attribute__ ((packed));
503 union fsf_qtcb_bottom {
504 struct fsf_qtcb_bottom_io io;
505 struct fsf_qtcb_bottom_support support;
506 struct fsf_qtcb_bottom_config config;
507 struct fsf_qtcb_bottom_port port;
511 struct fsf_qtcb_prefix prefix;
512 struct fsf_qtcb_header header;
513 union fsf_qtcb_bottom bottom;
514 u8 log[FSF_QTCB_LOG_SIZE];
515 } __attribute__ ((packed));