3 * linux/drivers/s390/scsi/zfcp_fsf.h
5 * FCP adapter driver for IBM eServer zSeries
7 * (C) Copyright IBM Corp. 2002, 2004
9 * Author(s): Martin Peschke <mpeschke@de.ibm.com>
10 * Raimund Schroeder <raimund.schroeder@de.ibm.com>
13 * Stefan Bader <stefan.bader@de.ibm.com>
14 * Heiko Carstens <heiko.carstens@de.ibm.com>
15 * Andreas Herrmann <aherrman@de.ibm.com>
16 * Volker Sameske <sameske@de.ibm.com>
18 * This program is free software; you can redistribute it and/or modify
19 * it under the terms of the GNU General Public License as published by
20 * the Free Software Foundation; either version 2, or (at your option)
23 * This program is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
28 * You should have received a copy of the GNU General Public License
29 * along with this program; if not, write to the Free Software
30 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
36 #define FSF_QTCB_VERSION1 0x00000001
37 #define FSF_QTCB_CURRENT_VERSION FSF_QTCB_VERSION1
40 #define FSF_QTCB_FCP_CMND 0x00000001
41 #define FSF_QTCB_ABORT_FCP_CMND 0x00000002
42 #define FSF_QTCB_OPEN_PORT_WITH_DID 0x00000005
43 #define FSF_QTCB_OPEN_LUN 0x00000006
44 #define FSF_QTCB_CLOSE_LUN 0x00000007
45 #define FSF_QTCB_CLOSE_PORT 0x00000008
46 #define FSF_QTCB_CLOSE_PHYSICAL_PORT 0x00000009
47 #define FSF_QTCB_SEND_ELS 0x0000000B
48 #define FSF_QTCB_SEND_GENERIC 0x0000000C
49 #define FSF_QTCB_EXCHANGE_CONFIG_DATA 0x0000000D
50 #define FSF_QTCB_EXCHANGE_PORT_DATA 0x0000000E
51 #define FSF_QTCB_DOWNLOAD_CONTROL_FILE 0x00000012
52 #define FSF_QTCB_UPLOAD_CONTROL_FILE 0x00000013
55 #define FSF_IO_COMMAND 0x00000001
56 #define FSF_SUPPORT_COMMAND 0x00000002
57 #define FSF_CONFIG_COMMAND 0x00000003
58 #define FSF_PORT_COMMAND 0x00000004
60 /* FSF control file upload/download operations' subtype and options */
61 #define FSF_CFDC_OPERATION_SUBTYPE 0x00020001
62 #define FSF_CFDC_OPTION_NORMAL_MODE 0x00000000
63 #define FSF_CFDC_OPTION_FORCE 0x00000001
64 #define FSF_CFDC_OPTION_FULL_ACCESS 0x00000002
65 #define FSF_CFDC_OPTION_RESTRICTED_ACCESS 0x00000004
67 /* FSF protocol stati */
68 #define FSF_PROT_GOOD 0x00000001
69 #define FSF_PROT_QTCB_VERSION_ERROR 0x00000010
70 #define FSF_PROT_SEQ_NUMB_ERROR 0x00000020
71 #define FSF_PROT_UNSUPP_QTCB_TYPE 0x00000040
72 #define FSF_PROT_HOST_CONNECTION_INITIALIZING 0x00000080
73 #define FSF_PROT_FSF_STATUS_PRESENTED 0x00000100
74 #define FSF_PROT_DUPLICATE_REQUEST_ID 0x00000200
75 #define FSF_PROT_LINK_DOWN 0x00000400
76 #define FSF_PROT_REEST_QUEUE 0x00000800
77 #define FSF_PROT_ERROR_STATE 0x01000000
80 #define FSF_GOOD 0x00000000
81 #define FSF_PORT_ALREADY_OPEN 0x00000001
82 #define FSF_LUN_ALREADY_OPEN 0x00000002
83 #define FSF_PORT_HANDLE_NOT_VALID 0x00000003
84 #define FSF_LUN_HANDLE_NOT_VALID 0x00000004
85 #define FSF_HANDLE_MISMATCH 0x00000005
86 #define FSF_SERVICE_CLASS_NOT_SUPPORTED 0x00000006
87 #define FSF_FCPLUN_NOT_VALID 0x00000009
88 #define FSF_ACCESS_DENIED 0x00000010
89 #define FSF_LUN_SHARING_VIOLATION 0x00000012
90 #define FSF_FCP_COMMAND_DOES_NOT_EXIST 0x00000022
91 #define FSF_DIRECTION_INDICATOR_NOT_VALID 0x00000030
92 #define FSF_CMND_LENGTH_NOT_VALID 0x00000033
93 #define FSF_MAXIMUM_NUMBER_OF_PORTS_EXCEEDED 0x00000040
94 #define FSF_MAXIMUM_NUMBER_OF_LUNS_EXCEEDED 0x00000041
95 #define FSF_ELS_COMMAND_REJECTED 0x00000050
96 #define FSF_GENERIC_COMMAND_REJECTED 0x00000051
97 #define FSF_OPERATION_PARTIALLY_SUCCESSFUL 0x00000052
98 #define FSF_AUTHORIZATION_FAILURE 0x00000053
99 #define FSF_CFDC_ERROR_DETECTED 0x00000054
100 #define FSF_CONTROL_FILE_UPDATE_ERROR 0x00000055
101 #define FSF_CONTROL_FILE_TOO_LARGE 0x00000056
102 #define FSF_ACCESS_CONFLICT_DETECTED 0x00000057
103 #define FSF_CONFLICTS_OVERRULED 0x00000058
104 #define FSF_PORT_BOXED 0x00000059
105 #define FSF_LUN_BOXED 0x0000005A
106 #define FSF_EXCHANGE_CONFIG_DATA_INCOMPLETE 0x0000005B
107 #define FSF_PAYLOAD_SIZE_MISMATCH 0x00000060
108 #define FSF_REQUEST_SIZE_TOO_LARGE 0x00000061
109 #define FSF_RESPONSE_SIZE_TOO_LARGE 0x00000062
110 #define FSF_SBAL_MISMATCH 0x00000063
111 #define FSF_OPEN_PORT_WITHOUT_PRLI 0x00000064
112 #define FSF_ADAPTER_STATUS_AVAILABLE 0x000000AD
113 #define FSF_FCP_RSP_AVAILABLE 0x000000AF
114 #define FSF_UNKNOWN_COMMAND 0x000000E2
115 #define FSF_UNKNOWN_OP_SUBTYPE 0x000000E3
116 #define FSF_INVALID_COMMAND_OPTION 0x000000E5
117 /* #define FSF_ERROR 0x000000FF */
119 #define FSF_PROT_STATUS_QUAL_SIZE 16
120 #define FSF_STATUS_QUALIFIER_SIZE 16
122 /* FSF status qualifier, recommendations */
123 #define FSF_SQ_NO_RECOM 0x00
124 #define FSF_SQ_FCP_RSP_AVAILABLE 0x01
125 #define FSF_SQ_RETRY_IF_POSSIBLE 0x02
126 #define FSF_SQ_ULP_DEPENDENT_ERP_REQUIRED 0x03
127 #define FSF_SQ_INVOKE_LINK_TEST_PROCEDURE 0x04
128 #define FSF_SQ_ULP_PROGRAMMING_ERROR 0x05
129 #define FSF_SQ_COMMAND_ABORTED 0x06
130 #define FSF_SQ_NO_RETRY_POSSIBLE 0x07
132 /* FSF status qualifier for CFDC commands */
133 #define FSF_SQ_CFDC_HARDENED_ON_SE 0x00000000
134 #define FSF_SQ_CFDC_COULD_NOT_HARDEN_ON_SE 0x00000001
135 #define FSF_SQ_CFDC_COULD_NOT_HARDEN_ON_SE2 0x00000002
136 /* CFDC subtable codes */
137 #define FSF_SQ_CFDC_SUBTABLE_OS 0x0001
138 #define FSF_SQ_CFDC_SUBTABLE_PORT_WWPN 0x0002
139 #define FSF_SQ_CFDC_SUBTABLE_PORT_DID 0x0003
140 #define FSF_SQ_CFDC_SUBTABLE_LUN 0x0004
142 /* FSF status qualifier (most significant 4 bytes), local link down */
143 #define FSF_PSQ_LINK_NOLIGHT 0x00000004
144 #define FSF_PSQ_LINK_WRAPPLUG 0x00000008
145 #define FSF_PSQ_LINK_NOFCP 0x00000010
147 /* payload size in status read buffer */
148 #define FSF_STATUS_READ_PAYLOAD_SIZE 4032
150 /* number of status read buffers that should be sent by ULP */
151 #define FSF_STATUS_READS_RECOM 16
153 /* status types in status read buffer */
154 #define FSF_STATUS_READ_PORT_CLOSED 0x00000001
155 #define FSF_STATUS_READ_INCOMING_ELS 0x00000002
156 #define FSF_STATUS_READ_SENSE_DATA_AVAIL 0x00000003
157 #define FSF_STATUS_READ_BIT_ERROR_THRESHOLD 0x00000004
158 #define FSF_STATUS_READ_LINK_DOWN 0x00000005 /* FIXME: really? */
159 #define FSF_STATUS_READ_LINK_UP 0x00000006
160 #define FSF_STATUS_READ_CFDC_UPDATED 0x0000000A
161 #define FSF_STATUS_READ_CFDC_HARDENED 0x0000000B
163 /* status subtypes in status read buffer */
164 #define FSF_STATUS_READ_SUB_CLOSE_PHYS_PORT 0x00000001
165 #define FSF_STATUS_READ_SUB_ERROR_PORT 0x00000002
167 /* status subtypes for CFDC */
168 #define FSF_STATUS_READ_SUB_CFDC_HARDENED_ON_SE 0x00000002
169 #define FSF_STATUS_READ_SUB_CFDC_HARDENED_ON_SE2 0x0000000F
171 /* topologie that is detected by the adapter */
172 #define FSF_TOPO_ERROR 0x00000000
173 #define FSF_TOPO_P2P 0x00000001
174 #define FSF_TOPO_FABRIC 0x00000002
175 #define FSF_TOPO_AL 0x00000003
176 #define FSF_TOPO_FABRIC_VIRT 0x00000004
178 /* data direction for FCP commands */
179 #define FSF_DATADIR_WRITE 0x00000001
180 #define FSF_DATADIR_READ 0x00000002
181 #define FSF_DATADIR_READ_WRITE 0x00000003
182 #define FSF_DATADIR_CMND 0x00000004
184 /* fc service class */
185 #define FSF_CLASS_1 0x00000001
186 #define FSF_CLASS_2 0x00000002
187 #define FSF_CLASS_3 0x00000003
190 #define FSF_MAX_SBALS_PER_REQ 36
191 #define FSF_MAX_SBALS_PER_ELS_REQ 2
193 /* logging space behind QTCB */
194 #define FSF_QTCB_LOG_SIZE 1024
196 /* channel features */
197 #define FSF_FEATURE_QTCB_SUPPRESSION 0x00000001
198 #define FSF_FEATURE_CFDC 0x00000002
199 #define FSF_FEATURE_LUN_SHARING 0x00000004
200 #define FSF_FEATURE_HBAAPI_MANAGEMENT 0x00000010
201 #define FSF_FEATURE_ELS_CT_CHAINED_SBALS 0x00000020
204 #define FSF_OPEN_LUN_SUPPRESS_BOXING 0x00000001
205 #define FSF_OPEN_LUN_REPLICATE_SENSE 0x00000002
208 #define FSF_ADAPTER_TYPE_FICON 0x00000001
209 #define FSF_ADAPTER_TYPE_FICON_EXPRESS 0x00000002
212 #define FSF_HBA_PORTTYPE_UNKNOWN 0x00000001
213 #define FSF_HBA_PORTTYPE_NOTPRESENT 0x00000003
214 #define FSF_HBA_PORTTYPE_NPORT 0x00000005
215 #define FSF_HBA_PORTTYPE_PTP 0x00000021
216 /* following are not defined and used by FSF Spec
217 but are additionally defined by FC-HBA */
218 #define FSF_HBA_PORTTYPE_OTHER 0x00000002
219 #define FSF_HBA_PORTTYPE_NOTPRESENT 0x00000003
220 #define FSF_HBA_PORTTYPE_NLPORT 0x00000006
221 #define FSF_HBA_PORTTYPE_FLPORT 0x00000007
222 #define FSF_HBA_PORTTYPE_FPORT 0x00000008
223 #define FSF_HBA_PORTTYPE_LPORT 0x00000020
226 #define FSF_HBA_PORTSTATE_UNKNOWN 0x00000001
227 #define FSF_HBA_PORTSTATE_ONLINE 0x00000002
228 #define FSF_HBA_PORTSTATE_OFFLINE 0x00000003
229 #define FSF_HBA_PORTSTATE_LINKDOWN 0x00000006
230 #define FSF_HBA_PORTSTATE_ERROR 0x00000007
232 /* IO states of adapter */
233 #define FSF_IOSTAT_NPORT_RJT 0x00000004
234 #define FSF_IOSTAT_FABRIC_RJT 0x00000005
235 #define FSF_IOSTAT_LS_RJT 0x00000009
237 /* open LUN access flags*/
238 #define FSF_UNIT_ACCESS_OPEN_LUN_ALLOWED 0x01000000
239 #define FSF_UNIT_ACCESS_EXCLUSIVE 0x02000000
240 #define FSF_UNIT_ACCESS_OUTBOUND_TRANSFER 0x10000000
242 struct fsf_queue_designator;
243 struct fsf_status_read_buffer;
244 struct fsf_port_closed_payload;
245 struct fsf_bit_error_payload;
246 union fsf_prot_status_qual;
247 struct fsf_qual_version_error;
248 struct fsf_qual_sequence_error;
249 struct fsf_qtcb_prefix;
250 struct fsf_qtcb_header;
251 struct fsf_qtcb_bottom_config;
252 struct fsf_qtcb_bottom_support;
253 struct fsf_qtcb_bottom_io;
254 union fsf_qtcb_bottom;
256 struct fsf_queue_designator {
262 } __attribute__ ((packed));
264 struct fsf_port_closed_payload {
265 struct fsf_queue_designator queue_designator;
267 } __attribute__ ((packed));
269 struct fsf_bit_error_payload {
271 u32 link_failure_error_count;
272 u32 loss_of_sync_error_count;
273 u32 loss_of_signal_error_count;
274 u32 primitive_sequence_error_count;
275 u32 invalid_transmission_word_error_count;
277 u32 primitive_sequence_event_timeout_count;
278 u32 elastic_buffer_overrun_error_count;
279 u32 fcal_arbitration_timeout_count;
280 u32 advertised_receive_b2b_credit;
281 u32 current_receive_b2b_credit;
282 u32 advertised_transmit_b2b_credit;
283 u32 current_transmit_b2b_credit;
284 } __attribute__ ((packed));
286 struct fsf_status_read_buffer {
291 struct fsf_queue_designator queue_designator;
296 u8 payload[FSF_STATUS_READ_PAYLOAD_SIZE];
297 } __attribute__ ((packed));
299 struct fsf_qual_version_error {
302 } __attribute__ ((packed));
304 struct fsf_qual_sequence_error {
307 } __attribute__ ((packed));
309 struct fsf_qual_locallink_error {
312 } __attribute__ ((packed));
314 union fsf_prot_status_qual {
315 u64 doubleword[FSF_PROT_STATUS_QUAL_SIZE / sizeof(u64)];
316 struct fsf_qual_version_error version_error;
317 struct fsf_qual_sequence_error sequence_error;
318 struct fsf_qual_locallink_error locallink_error;
319 } __attribute__ ((packed));
321 struct fsf_qtcb_prefix {
328 union fsf_prot_status_qual prot_status_qual;
330 } __attribute__ ((packed));
332 union fsf_status_qual {
333 u8 byte[FSF_STATUS_QUALIFIER_SIZE];
334 u16 halfword[FSF_STATUS_QUALIFIER_SIZE / sizeof (u16)];
335 u32 word[FSF_STATUS_QUALIFIER_SIZE / sizeof (u32)];
336 u64 doubleword[FSF_STATUS_QUALIFIER_SIZE / sizeof(u64)];
337 struct fsf_queue_designator fsf_queue_designator;
338 } __attribute__ ((packed));
340 struct fsf_qtcb_header {
348 union fsf_status_qual fsf_status_qual;
353 } __attribute__ ((packed));
355 struct fsf_nport_serv_param {
356 u8 common_serv_param[16];
359 u8 class1_serv_param[16];
360 u8 class2_serv_param[16];
361 u8 class3_serv_param[16];
362 u8 class4_serv_param[16];
363 u8 vendor_version_level[16];
364 } __attribute__ ((packed));
368 struct fsf_nport_serv_param serv_param;
369 } __attribute__ ((packed));
371 #define FSF_FCP_CMND_SIZE 288
372 #define FSF_FCP_RSP_SIZE 128
374 struct fsf_qtcb_bottom_io {
380 u8 fcp_cmnd[FSF_FCP_CMND_SIZE];
381 u8 fcp_rsp[FSF_FCP_RSP_SIZE];
383 } __attribute__ ((packed));
385 struct fsf_qtcb_bottom_support {
386 u32 operation_subtype;
403 } __attribute__ ((packed));
405 struct fsf_qtcb_bottom_config {
407 u32 feature_selection;
408 u32 high_qtcb_version;
409 u32 low_qtcb_version;
411 u32 max_data_transfer_size;
412 u32 supported_features;
420 struct fsf_nport_serv_param nport_serv_param;
421 u8 reserved_nport_serv_param[16];
424 u32 hardware_version;
425 u8 serial_number[32];
426 struct fsf_nport_serv_param plogi_payload;
428 } __attribute__ ((packed));
430 struct fsf_qtcb_bottom_port {
435 u32 class_of_service; /* should be 0x00000006 for class 2 and 3 */
436 u8 supported_fc4_types[32]; /* should be 0x00000100 for scsi fcp */
437 u8 active_fc4_types[32];
438 u32 supported_speed; /* 0x0001 for 1 GBit/s or 0x0002 for 2 GBit/s */
439 u32 maximum_frame_size; /* fixed value of 2112 */
440 u64 seconds_since_last_reset;
446 u64 nos; /* currently 0 */
447 u64 error_frames; /* currently 0 */
448 u64 dumped_frames; /* currently 0 */
452 u64 psp_error_counts;
453 u64 invalid_tx_words;
457 u64 control_requests;
458 u64 input_mb; /* where 1 MByte == 1.000.000 Bytes */
459 u64 output_mb; /* where 1 MByte == 1.000.000 Bytes */
461 } __attribute__ ((packed));
463 union fsf_qtcb_bottom {
464 struct fsf_qtcb_bottom_io io;
465 struct fsf_qtcb_bottom_support support;
466 struct fsf_qtcb_bottom_config config;
467 struct fsf_qtcb_bottom_port port;
471 struct fsf_qtcb_prefix prefix;
472 struct fsf_qtcb_header header;
473 union fsf_qtcb_bottom bottom;
474 u8 log[FSF_QTCB_LOG_SIZE];
475 } __attribute__ ((packed));