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_PORT_BOXED 0x00000059
75 #define FSF_LUN_BOXED 0x0000005A
76 #define FSF_EXCHANGE_CONFIG_DATA_INCOMPLETE 0x0000005B
77 #define FSF_PAYLOAD_SIZE_MISMATCH 0x00000060
78 #define FSF_REQUEST_SIZE_TOO_LARGE 0x00000061
79 #define FSF_RESPONSE_SIZE_TOO_LARGE 0x00000062
80 #define FSF_SBAL_MISMATCH 0x00000063
81 #define FSF_ADAPTER_STATUS_AVAILABLE 0x000000AD
82 #define FSF_UNKNOWN_COMMAND 0x000000E2
83 #define FSF_UNKNOWN_OP_SUBTYPE 0x000000E3
84 #define FSF_INVALID_COMMAND_OPTION 0x000000E5
85 /* #define FSF_ERROR 0x000000FF */
87 #define FSF_PROT_STATUS_QUAL_SIZE 16
88 #define FSF_STATUS_QUALIFIER_SIZE 16
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
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
113 /* payload size in status read buffer */
114 #define FSF_STATUS_READ_PAYLOAD_SIZE 4032
116 /* number of status read buffers that should be sent by ULP */
117 #define FSF_STATUS_READS_RECOM 16
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_CFDC_UPDATED 0x0000000A
128 #define FSF_STATUS_READ_FEATURE_UPDATE_ALERT 0x0000000C
130 /* status subtypes in status read buffer */
131 #define FSF_STATUS_READ_SUB_CLOSE_PHYS_PORT 0x00000001
132 #define FSF_STATUS_READ_SUB_ERROR_PORT 0x00000002
134 /* status subtypes for link down */
135 #define FSF_STATUS_READ_SUB_NO_PHYSICAL_LINK 0x00000000
136 #define FSF_STATUS_READ_SUB_FDISC_FAILED 0x00000001
137 #define FSF_STATUS_READ_SUB_FIRMWARE_UPDATE 0x00000002
139 /* status subtypes for unsolicited status notification lost */
140 #define FSF_STATUS_READ_SUB_INCOMING_ELS 0x00000001
141 #define FSF_STATUS_READ_SUB_ACT_UPDATED 0x00000020
143 /* topologie that is detected by the adapter */
144 #define FSF_TOPO_P2P 0x00000001
145 #define FSF_TOPO_FABRIC 0x00000002
146 #define FSF_TOPO_AL 0x00000003
148 /* data direction for FCP commands */
149 #define FSF_DATADIR_WRITE 0x00000001
150 #define FSF_DATADIR_READ 0x00000002
151 #define FSF_DATADIR_CMND 0x00000004
153 /* fc service class */
154 #define FSF_CLASS_3 0x00000003
157 #define FSF_MAX_SBALS_PER_REQ 36
159 /* logging space behind QTCB */
160 #define FSF_QTCB_LOG_SIZE 1024
162 /* channel features */
163 #define FSF_FEATURE_CFDC 0x00000002
164 #define FSF_FEATURE_LUN_SHARING 0x00000004
165 #define FSF_FEATURE_NOTIFICATION_LOST 0x00000008
166 #define FSF_FEATURE_HBAAPI_MANAGEMENT 0x00000010
167 #define FSF_FEATURE_UPDATE_ALERT 0x00000100
168 #define FSF_FEATURE_MEASUREMENT_DATA 0x00000200
170 /* host connection features */
171 #define FSF_FEATURE_NPIV_MODE 0x00000001
174 #define FSF_OPEN_LUN_SUPPRESS_BOXING 0x00000001
176 /* open LUN access flags*/
177 #define FSF_UNIT_ACCESS_EXCLUSIVE 0x02000000
178 #define FSF_UNIT_ACCESS_OUTBOUND_TRANSFER 0x10000000
180 /* FSF interface for CFDC */
181 #define ZFCP_CFDC_MAX_SIZE 127 * 1024
182 #define ZFCP_CFDC_PAGES PFN_UP(ZFCP_CFDC_MAX_SIZE)
184 struct zfcp_fsf_cfdc {
185 struct scatterlist sg[ZFCP_CFDC_PAGES];
190 struct fsf_queue_designator {
196 } __attribute__ ((packed));
198 struct fsf_bit_error_payload {
200 u32 link_failure_error_count;
201 u32 loss_of_sync_error_count;
202 u32 loss_of_signal_error_count;
203 u32 primitive_sequence_error_count;
204 u32 invalid_transmission_word_error_count;
206 u32 primitive_sequence_event_timeout_count;
207 u32 elastic_buffer_overrun_error_count;
208 u32 fcal_arbitration_timeout_count;
209 u32 advertised_receive_b2b_credit;
210 u32 current_receive_b2b_credit;
211 u32 advertised_transmit_b2b_credit;
212 u32 current_transmit_b2b_credit;
213 } __attribute__ ((packed));
215 struct fsf_link_down_info {
224 u8 vendor_specific_code;
225 } __attribute__ ((packed));
227 struct fsf_status_read_buffer {
232 struct fsf_queue_designator queue_designator;
238 u8 data[FSF_STATUS_READ_PAYLOAD_SIZE];
239 u32 word[FSF_STATUS_READ_PAYLOAD_SIZE/sizeof(u32)];
240 struct fsf_link_down_info link_down_info;
241 struct fsf_bit_error_payload bit_error;
243 } __attribute__ ((packed));
245 struct fsf_qual_version_error {
248 } __attribute__ ((packed));
250 struct fsf_qual_sequence_error {
253 } __attribute__ ((packed));
255 struct fsf_qual_latency_info {
259 } __attribute__ ((packed));
261 union fsf_prot_status_qual {
262 u32 word[FSF_PROT_STATUS_QUAL_SIZE / sizeof(u32)];
263 u64 doubleword[FSF_PROT_STATUS_QUAL_SIZE / sizeof(u64)];
264 struct fsf_qual_version_error version_error;
265 struct fsf_qual_sequence_error sequence_error;
266 struct fsf_link_down_info link_down_info;
267 struct fsf_qual_latency_info latency_info;
268 } __attribute__ ((packed));
270 struct fsf_qtcb_prefix {
277 union fsf_prot_status_qual prot_status_qual;
279 } __attribute__ ((packed));
281 struct fsf_statistics_info {
288 } __attribute__ ((packed));
290 union fsf_status_qual {
291 u8 byte[FSF_STATUS_QUALIFIER_SIZE];
292 u16 halfword[FSF_STATUS_QUALIFIER_SIZE / sizeof (u16)];
293 u32 word[FSF_STATUS_QUALIFIER_SIZE / sizeof (u32)];
294 u64 doubleword[FSF_STATUS_QUALIFIER_SIZE / sizeof(u64)];
295 struct fsf_queue_designator fsf_queue_designator;
296 struct fsf_link_down_info link_down_info;
297 } __attribute__ ((packed));
299 struct fsf_qtcb_header {
307 union fsf_status_qual fsf_status_qual;
312 } __attribute__ ((packed));
314 struct fsf_nport_serv_param {
315 u8 common_serv_param[16];
318 u8 class1_serv_param[16];
319 u8 class2_serv_param[16];
320 u8 class3_serv_param[16];
321 u8 class4_serv_param[16];
322 u8 vendor_version_level[16];
323 } __attribute__ ((packed));
327 struct fsf_nport_serv_param serv_param;
328 } __attribute__ ((packed));
330 #define FSF_FCP_CMND_SIZE 288
331 #define FSF_FCP_RSP_SIZE 128
333 struct fsf_qtcb_bottom_io {
339 u8 fcp_cmnd[FSF_FCP_CMND_SIZE];
340 u8 fcp_rsp[FSF_FCP_RSP_SIZE];
342 } __attribute__ ((packed));
344 struct fsf_qtcb_bottom_support {
345 u32 operation_subtype;
362 } __attribute__ ((packed));
364 struct fsf_qtcb_bottom_config {
366 u32 feature_selection;
367 u32 high_qtcb_version;
368 u32 low_qtcb_version;
370 u32 max_data_transfer_size;
371 u32 adapter_features;
372 u32 connection_features;
381 struct fsf_nport_serv_param nport_serv_param;
382 u8 reserved_nport_serv_param[16];
385 u32 hardware_version;
386 u8 serial_number[32];
387 struct fsf_nport_serv_param plogi_payload;
388 struct fsf_statistics_info stat_info;
390 } __attribute__ ((packed));
392 struct fsf_qtcb_bottom_port {
397 u32 class_of_service; /* should be 0x00000006 for class 2 and 3 */
398 u8 supported_fc4_types[32]; /* should be 0x00000100 for scsi fcp */
399 u8 active_fc4_types[32];
400 u32 supported_speed; /* 0x0001 for 1 GBit/s or 0x0002 for 2 GBit/s */
401 u32 maximum_frame_size; /* fixed value of 2112 */
402 u64 seconds_since_last_reset;
408 u64 nos; /* currently 0 */
409 u64 error_frames; /* currently 0 */
410 u64 dumped_frames; /* currently 0 */
414 u64 psp_error_counts;
415 u64 invalid_tx_words;
419 u64 control_requests;
420 u64 input_mb; /* where 1 MByte == 1.000.000 Bytes */
421 u64 output_mb; /* where 1 MByte == 1.000.000 Bytes */
426 } __attribute__ ((packed));
428 union fsf_qtcb_bottom {
429 struct fsf_qtcb_bottom_io io;
430 struct fsf_qtcb_bottom_support support;
431 struct fsf_qtcb_bottom_config config;
432 struct fsf_qtcb_bottom_port port;
436 struct fsf_qtcb_prefix prefix;
437 struct fsf_qtcb_header header;
438 union fsf_qtcb_bottom bottom;
439 u8 log[FSF_QTCB_LOG_SIZE];
440 } __attribute__ ((packed));