2 * This file is part of the zfcp device driver for
3 * FCP adapters for IBM System z9 and zSeries.
5 * (C) Copyright IBM Corp. 2002, 2006
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2, or (at your option)
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 #include <linux/pfn.h>
27 #define FSF_QTCB_CURRENT_VERSION 0x00000001
30 #define FSF_QTCB_FCP_CMND 0x00000001
31 #define FSF_QTCB_ABORT_FCP_CMND 0x00000002
32 #define FSF_QTCB_OPEN_PORT_WITH_DID 0x00000005
33 #define FSF_QTCB_OPEN_LUN 0x00000006
34 #define FSF_QTCB_CLOSE_LUN 0x00000007
35 #define FSF_QTCB_CLOSE_PORT 0x00000008
36 #define FSF_QTCB_CLOSE_PHYSICAL_PORT 0x00000009
37 #define FSF_QTCB_SEND_ELS 0x0000000B
38 #define FSF_QTCB_SEND_GENERIC 0x0000000C
39 #define FSF_QTCB_EXCHANGE_CONFIG_DATA 0x0000000D
40 #define FSF_QTCB_EXCHANGE_PORT_DATA 0x0000000E
41 #define FSF_QTCB_DOWNLOAD_CONTROL_FILE 0x00000012
42 #define FSF_QTCB_UPLOAD_CONTROL_FILE 0x00000013
45 #define FSF_IO_COMMAND 0x00000001
46 #define FSF_SUPPORT_COMMAND 0x00000002
47 #define FSF_CONFIG_COMMAND 0x00000003
48 #define FSF_PORT_COMMAND 0x00000004
50 /* FSF control file upload/download operations' subtype and options */
51 #define FSF_CFDC_OPERATION_SUBTYPE 0x00020001
52 #define FSF_CFDC_OPTION_NORMAL_MODE 0x00000000
53 #define FSF_CFDC_OPTION_FORCE 0x00000001
54 #define FSF_CFDC_OPTION_FULL_ACCESS 0x00000002
55 #define FSF_CFDC_OPTION_RESTRICTED_ACCESS 0x00000004
57 /* FSF protocol states */
58 #define FSF_PROT_GOOD 0x00000001
59 #define FSF_PROT_QTCB_VERSION_ERROR 0x00000010
60 #define FSF_PROT_SEQ_NUMB_ERROR 0x00000020
61 #define FSF_PROT_UNSUPP_QTCB_TYPE 0x00000040
62 #define FSF_PROT_HOST_CONNECTION_INITIALIZING 0x00000080
63 #define FSF_PROT_FSF_STATUS_PRESENTED 0x00000100
64 #define FSF_PROT_DUPLICATE_REQUEST_ID 0x00000200
65 #define FSF_PROT_LINK_DOWN 0x00000400
66 #define FSF_PROT_REEST_QUEUE 0x00000800
67 #define FSF_PROT_ERROR_STATE 0x01000000
70 #define FSF_GOOD 0x00000000
71 #define FSF_PORT_ALREADY_OPEN 0x00000001
72 #define FSF_LUN_ALREADY_OPEN 0x00000002
73 #define FSF_PORT_HANDLE_NOT_VALID 0x00000003
74 #define FSF_LUN_HANDLE_NOT_VALID 0x00000004
75 #define FSF_HANDLE_MISMATCH 0x00000005
76 #define FSF_SERVICE_CLASS_NOT_SUPPORTED 0x00000006
77 #define FSF_FCPLUN_NOT_VALID 0x00000009
78 #define FSF_ACCESS_DENIED 0x00000010
79 #define FSF_LUN_SHARING_VIOLATION 0x00000012
80 #define FSF_FCP_COMMAND_DOES_NOT_EXIST 0x00000022
81 #define FSF_DIRECTION_INDICATOR_NOT_VALID 0x00000030
82 #define FSF_CMND_LENGTH_NOT_VALID 0x00000033
83 #define FSF_MAXIMUM_NUMBER_OF_PORTS_EXCEEDED 0x00000040
84 #define FSF_MAXIMUM_NUMBER_OF_LUNS_EXCEEDED 0x00000041
85 #define FSF_ELS_COMMAND_REJECTED 0x00000050
86 #define FSF_GENERIC_COMMAND_REJECTED 0x00000051
87 #define FSF_OPERATION_PARTIALLY_SUCCESSFUL 0x00000052
88 #define FSF_AUTHORIZATION_FAILURE 0x00000053
89 #define FSF_CFDC_ERROR_DETECTED 0x00000054
90 #define FSF_CONTROL_FILE_UPDATE_ERROR 0x00000055
91 #define FSF_CONTROL_FILE_TOO_LARGE 0x00000056
92 #define FSF_ACCESS_CONFLICT_DETECTED 0x00000057
93 #define FSF_CONFLICTS_OVERRULED 0x00000058
94 #define FSF_PORT_BOXED 0x00000059
95 #define FSF_LUN_BOXED 0x0000005A
96 #define FSF_EXCHANGE_CONFIG_DATA_INCOMPLETE 0x0000005B
97 #define FSF_PAYLOAD_SIZE_MISMATCH 0x00000060
98 #define FSF_REQUEST_SIZE_TOO_LARGE 0x00000061
99 #define FSF_RESPONSE_SIZE_TOO_LARGE 0x00000062
100 #define FSF_SBAL_MISMATCH 0x00000063
101 #define FSF_OPEN_PORT_WITHOUT_PRLI 0x00000064
102 #define FSF_ADAPTER_STATUS_AVAILABLE 0x000000AD
103 #define FSF_FCP_RSP_AVAILABLE 0x000000AF
104 #define FSF_UNKNOWN_COMMAND 0x000000E2
105 #define FSF_UNKNOWN_OP_SUBTYPE 0x000000E3
106 #define FSF_INVALID_COMMAND_OPTION 0x000000E5
107 /* #define FSF_ERROR 0x000000FF */
109 #define FSF_PROT_STATUS_QUAL_SIZE 16
110 #define FSF_STATUS_QUALIFIER_SIZE 16
112 /* FSF status qualifier, recommendations */
113 #define FSF_SQ_NO_RECOM 0x00
114 #define FSF_SQ_FCP_RSP_AVAILABLE 0x01
115 #define FSF_SQ_RETRY_IF_POSSIBLE 0x02
116 #define FSF_SQ_ULP_DEPENDENT_ERP_REQUIRED 0x03
117 #define FSF_SQ_INVOKE_LINK_TEST_PROCEDURE 0x04
118 #define FSF_SQ_ULP_PROGRAMMING_ERROR 0x05
119 #define FSF_SQ_COMMAND_ABORTED 0x06
120 #define FSF_SQ_NO_RETRY_POSSIBLE 0x07
122 /* FSF status qualifier for CFDC commands */
123 #define FSF_SQ_CFDC_HARDENED_ON_SE 0x00000000
124 #define FSF_SQ_CFDC_COULD_NOT_HARDEN_ON_SE 0x00000001
125 #define FSF_SQ_CFDC_COULD_NOT_HARDEN_ON_SE2 0x00000002
126 /* CFDC subtable codes */
127 #define FSF_SQ_CFDC_SUBTABLE_OS 0x0001
128 #define FSF_SQ_CFDC_SUBTABLE_PORT_WWPN 0x0002
129 #define FSF_SQ_CFDC_SUBTABLE_PORT_DID 0x0003
130 #define FSF_SQ_CFDC_SUBTABLE_LUN 0x0004
132 /* FSF status qualifier (most significant 4 bytes), local link down */
133 #define FSF_PSQ_LINK_NO_LIGHT 0x00000004
134 #define FSF_PSQ_LINK_WRAP_PLUG 0x00000008
135 #define FSF_PSQ_LINK_NO_FCP 0x00000010
136 #define FSF_PSQ_LINK_FIRMWARE_UPDATE 0x00000020
137 #define FSF_PSQ_LINK_INVALID_WWPN 0x00000100
138 #define FSF_PSQ_LINK_NO_NPIV_SUPPORT 0x00000200
139 #define FSF_PSQ_LINK_NO_FCP_RESOURCES 0x00000400
140 #define FSF_PSQ_LINK_NO_FABRIC_RESOURCES 0x00000800
141 #define FSF_PSQ_LINK_FABRIC_LOGIN_UNABLE 0x00001000
142 #define FSF_PSQ_LINK_WWPN_ASSIGNMENT_CORRUPTED 0x00002000
143 #define FSF_PSQ_LINK_MODE_TABLE_CURRUPTED 0x00004000
144 #define FSF_PSQ_LINK_NO_WWPN_ASSIGNMENT 0x00008000
146 /* payload size in status read buffer */
147 #define FSF_STATUS_READ_PAYLOAD_SIZE 4032
149 /* number of status read buffers that should be sent by ULP */
150 #define FSF_STATUS_READS_RECOM 16
152 /* status types in status read buffer */
153 #define FSF_STATUS_READ_PORT_CLOSED 0x00000001
154 #define FSF_STATUS_READ_INCOMING_ELS 0x00000002
155 #define FSF_STATUS_READ_SENSE_DATA_AVAIL 0x00000003
156 #define FSF_STATUS_READ_BIT_ERROR_THRESHOLD 0x00000004
157 #define FSF_STATUS_READ_LINK_DOWN 0x00000005
158 #define FSF_STATUS_READ_LINK_UP 0x00000006
159 #define FSF_STATUS_READ_NOTIFICATION_LOST 0x00000009
160 #define FSF_STATUS_READ_CFDC_UPDATED 0x0000000A
161 #define FSF_STATUS_READ_CFDC_HARDENED 0x0000000B
162 #define FSF_STATUS_READ_FEATURE_UPDATE_ALERT 0x0000000C
164 /* status subtypes in status read buffer */
165 #define FSF_STATUS_READ_SUB_CLOSE_PHYS_PORT 0x00000001
166 #define FSF_STATUS_READ_SUB_ERROR_PORT 0x00000002
168 /* status subtypes for link down */
169 #define FSF_STATUS_READ_SUB_NO_PHYSICAL_LINK 0x00000000
170 #define FSF_STATUS_READ_SUB_FDISC_FAILED 0x00000001
171 #define FSF_STATUS_READ_SUB_FIRMWARE_UPDATE 0x00000002
173 /* status subtypes for unsolicited status notification lost */
174 #define FSF_STATUS_READ_SUB_INCOMING_ELS 0x00000001
175 #define FSF_STATUS_READ_SUB_SENSE_DATA 0x00000002
176 #define FSF_STATUS_READ_SUB_LINK_STATUS 0x00000004
177 #define FSF_STATUS_READ_SUB_PORT_CLOSED 0x00000008
178 #define FSF_STATUS_READ_SUB_BIT_ERROR_THRESHOLD 0x00000010
179 #define FSF_STATUS_READ_SUB_ACT_UPDATED 0x00000020
180 #define FSF_STATUS_READ_SUB_ACT_HARDENED 0x00000040
181 #define FSF_STATUS_READ_SUB_FEATURE_UPDATE_ALERT 0x00000080
183 /* status subtypes for CFDC */
184 #define FSF_STATUS_READ_SUB_CFDC_HARDENED_ON_SE 0x00000002
185 #define FSF_STATUS_READ_SUB_CFDC_HARDENED_ON_SE2 0x0000000F
187 /* topologie that is detected by the adapter */
188 #define FSF_TOPO_ERROR 0x00000000
189 #define FSF_TOPO_P2P 0x00000001
190 #define FSF_TOPO_FABRIC 0x00000002
191 #define FSF_TOPO_AL 0x00000003
193 /* data direction for FCP commands */
194 #define FSF_DATADIR_WRITE 0x00000001
195 #define FSF_DATADIR_READ 0x00000002
196 #define FSF_DATADIR_READ_WRITE 0x00000003
197 #define FSF_DATADIR_CMND 0x00000004
199 /* fc service class */
200 #define FSF_CLASS_1 0x00000001
201 #define FSF_CLASS_2 0x00000002
202 #define FSF_CLASS_3 0x00000003
205 #define FSF_MAX_SBALS_PER_REQ 36
206 #define FSF_MAX_SBALS_PER_ELS_REQ 2
208 /* logging space behind QTCB */
209 #define FSF_QTCB_LOG_SIZE 1024
211 /* channel features */
212 #define FSF_FEATURE_CFDC 0x00000002
213 #define FSF_FEATURE_LUN_SHARING 0x00000004
214 #define FSF_FEATURE_NOTIFICATION_LOST 0x00000008
215 #define FSF_FEATURE_HBAAPI_MANAGEMENT 0x00000010
216 #define FSF_FEATURE_ELS_CT_CHAINED_SBALS 0x00000020
217 #define FSF_FEATURE_UPDATE_ALERT 0x00000100
218 #define FSF_FEATURE_MEASUREMENT_DATA 0x00000200
220 /* host connection features */
221 #define FSF_FEATURE_NPIV_MODE 0x00000001
222 #define FSF_FEATURE_VM_ASSIGNED_WWPN 0x00000002
225 #define FSF_OPEN_LUN_SUPPRESS_BOXING 0x00000001
226 #define FSF_OPEN_LUN_REPLICATE_SENSE 0x00000002
229 #define FSF_ADAPTER_TYPE_FICON 0x00000001
230 #define FSF_ADAPTER_TYPE_FICON_EXPRESS 0x00000002
233 #define FSF_HBA_PORTTYPE_UNKNOWN 0x00000001
234 #define FSF_HBA_PORTTYPE_NOTPRESENT 0x00000003
235 #define FSF_HBA_PORTTYPE_NPORT 0x00000005
236 #define FSF_HBA_PORTTYPE_PTP 0x00000021
237 /* following are not defined and used by FSF Spec
238 but are additionally defined by FC-HBA */
239 #define FSF_HBA_PORTTYPE_OTHER 0x00000002
240 #define FSF_HBA_PORTTYPE_NOTPRESENT 0x00000003
241 #define FSF_HBA_PORTTYPE_NLPORT 0x00000006
242 #define FSF_HBA_PORTTYPE_FLPORT 0x00000007
243 #define FSF_HBA_PORTTYPE_FPORT 0x00000008
244 #define FSF_HBA_PORTTYPE_LPORT 0x00000020
247 #define FSF_HBA_PORTSTATE_UNKNOWN 0x00000001
248 #define FSF_HBA_PORTSTATE_ONLINE 0x00000002
249 #define FSF_HBA_PORTSTATE_OFFLINE 0x00000003
250 #define FSF_HBA_PORTSTATE_LINKDOWN 0x00000006
251 #define FSF_HBA_PORTSTATE_ERROR 0x00000007
253 /* IO states of adapter */
254 #define FSF_IOSTAT_NPORT_RJT 0x00000004
255 #define FSF_IOSTAT_FABRIC_RJT 0x00000005
256 #define FSF_IOSTAT_LS_RJT 0x00000009
258 /* open LUN access flags*/
259 #define FSF_UNIT_ACCESS_OPEN_LUN_ALLOWED 0x01000000
260 #define FSF_UNIT_ACCESS_EXCLUSIVE 0x02000000
261 #define FSF_UNIT_ACCESS_OUTBOUND_TRANSFER 0x10000000
263 /* FSF interface for CFDC */
264 #define ZFCP_CFDC_MAX_SIZE 127 * 1024
265 #define ZFCP_CFDC_PAGES PFN_UP(ZFCP_CFDC_MAX_SIZE)
267 struct zfcp_fsf_cfdc {
268 struct scatterlist sg[ZFCP_CFDC_PAGES];
273 struct fsf_queue_designator {
279 } __attribute__ ((packed));
281 struct fsf_port_closed_payload {
282 struct fsf_queue_designator queue_designator;
284 } __attribute__ ((packed));
286 struct fsf_bit_error_payload {
288 u32 link_failure_error_count;
289 u32 loss_of_sync_error_count;
290 u32 loss_of_signal_error_count;
291 u32 primitive_sequence_error_count;
292 u32 invalid_transmission_word_error_count;
294 u32 primitive_sequence_event_timeout_count;
295 u32 elastic_buffer_overrun_error_count;
296 u32 fcal_arbitration_timeout_count;
297 u32 advertised_receive_b2b_credit;
298 u32 current_receive_b2b_credit;
299 u32 advertised_transmit_b2b_credit;
300 u32 current_transmit_b2b_credit;
301 } __attribute__ ((packed));
303 struct fsf_status_read_buffer {
308 struct fsf_queue_designator queue_designator;
313 u8 payload[FSF_STATUS_READ_PAYLOAD_SIZE];
314 } __attribute__ ((packed));
316 struct fsf_qual_version_error {
319 } __attribute__ ((packed));
321 struct fsf_qual_sequence_error {
324 } __attribute__ ((packed));
326 struct fsf_link_down_info {
335 u8 vendor_specific_code;
336 } __attribute__ ((packed));
338 struct fsf_qual_latency_info {
342 } __attribute__ ((packed));
344 union fsf_prot_status_qual {
345 u64 doubleword[FSF_PROT_STATUS_QUAL_SIZE / sizeof(u64)];
346 struct fsf_qual_version_error version_error;
347 struct fsf_qual_sequence_error sequence_error;
348 struct fsf_link_down_info link_down_info;
349 struct fsf_qual_latency_info latency_info;
350 } __attribute__ ((packed));
352 struct fsf_qtcb_prefix {
359 union fsf_prot_status_qual prot_status_qual;
361 } __attribute__ ((packed));
363 struct fsf_statistics_info {
370 } __attribute__ ((packed));
372 union fsf_status_qual {
373 u8 byte[FSF_STATUS_QUALIFIER_SIZE];
374 u16 halfword[FSF_STATUS_QUALIFIER_SIZE / sizeof (u16)];
375 u32 word[FSF_STATUS_QUALIFIER_SIZE / sizeof (u32)];
376 u64 doubleword[FSF_STATUS_QUALIFIER_SIZE / sizeof(u64)];
377 struct fsf_queue_designator fsf_queue_designator;
378 struct fsf_link_down_info link_down_info;
379 } __attribute__ ((packed));
381 struct fsf_qtcb_header {
389 union fsf_status_qual fsf_status_qual;
394 } __attribute__ ((packed));
396 struct fsf_nport_serv_param {
397 u8 common_serv_param[16];
400 u8 class1_serv_param[16];
401 u8 class2_serv_param[16];
402 u8 class3_serv_param[16];
403 u8 class4_serv_param[16];
404 u8 vendor_version_level[16];
405 } __attribute__ ((packed));
409 struct fsf_nport_serv_param serv_param;
410 } __attribute__ ((packed));
412 #define FSF_FCP_CMND_SIZE 288
413 #define FSF_FCP_RSP_SIZE 128
415 struct fsf_qtcb_bottom_io {
421 u8 fcp_cmnd[FSF_FCP_CMND_SIZE];
422 u8 fcp_rsp[FSF_FCP_RSP_SIZE];
424 } __attribute__ ((packed));
426 struct fsf_qtcb_bottom_support {
427 u32 operation_subtype;
444 } __attribute__ ((packed));
446 struct fsf_qtcb_bottom_config {
448 u32 feature_selection;
449 u32 high_qtcb_version;
450 u32 low_qtcb_version;
452 u32 max_data_transfer_size;
453 u32 adapter_features;
454 u32 connection_features;
463 struct fsf_nport_serv_param nport_serv_param;
464 u8 reserved_nport_serv_param[16];
467 u32 hardware_version;
468 u8 serial_number[32];
469 struct fsf_nport_serv_param plogi_payload;
470 struct fsf_statistics_info stat_info;
472 } __attribute__ ((packed));
474 struct fsf_qtcb_bottom_port {
479 u32 class_of_service; /* should be 0x00000006 for class 2 and 3 */
480 u8 supported_fc4_types[32]; /* should be 0x00000100 for scsi fcp */
481 u8 active_fc4_types[32];
482 u32 supported_speed; /* 0x0001 for 1 GBit/s or 0x0002 for 2 GBit/s */
483 u32 maximum_frame_size; /* fixed value of 2112 */
484 u64 seconds_since_last_reset;
490 u64 nos; /* currently 0 */
491 u64 error_frames; /* currently 0 */
492 u64 dumped_frames; /* currently 0 */
496 u64 psp_error_counts;
497 u64 invalid_tx_words;
501 u64 control_requests;
502 u64 input_mb; /* where 1 MByte == 1.000.000 Bytes */
503 u64 output_mb; /* where 1 MByte == 1.000.000 Bytes */
508 } __attribute__ ((packed));
510 union fsf_qtcb_bottom {
511 struct fsf_qtcb_bottom_io io;
512 struct fsf_qtcb_bottom_support support;
513 struct fsf_qtcb_bottom_config config;
514 struct fsf_qtcb_bottom_port port;
518 struct fsf_qtcb_prefix prefix;
519 struct fsf_qtcb_header header;
520 union fsf_qtcb_bottom bottom;
521 u8 log[FSF_QTCB_LOG_SIZE];
522 } __attribute__ ((packed));