4 * Interface to the FSF support functions.
6 * Copyright IBM Corporation 2002, 2009
12 #include <linux/pfn.h>
13 #include <linux/scatterlist.h>
14 #include <scsi/libfc.h>
16 #define FSF_QTCB_CURRENT_VERSION 0x00000001
19 #define FSF_QTCB_FCP_CMND 0x00000001
20 #define FSF_QTCB_ABORT_FCP_CMND 0x00000002
21 #define FSF_QTCB_OPEN_PORT_WITH_DID 0x00000005
22 #define FSF_QTCB_OPEN_LUN 0x00000006
23 #define FSF_QTCB_CLOSE_LUN 0x00000007
24 #define FSF_QTCB_CLOSE_PORT 0x00000008
25 #define FSF_QTCB_CLOSE_PHYSICAL_PORT 0x00000009
26 #define FSF_QTCB_SEND_ELS 0x0000000B
27 #define FSF_QTCB_SEND_GENERIC 0x0000000C
28 #define FSF_QTCB_EXCHANGE_CONFIG_DATA 0x0000000D
29 #define FSF_QTCB_EXCHANGE_PORT_DATA 0x0000000E
30 #define FSF_QTCB_DOWNLOAD_CONTROL_FILE 0x00000012
31 #define FSF_QTCB_UPLOAD_CONTROL_FILE 0x00000013
34 #define FSF_IO_COMMAND 0x00000001
35 #define FSF_SUPPORT_COMMAND 0x00000002
36 #define FSF_CONFIG_COMMAND 0x00000003
37 #define FSF_PORT_COMMAND 0x00000004
39 /* FSF control file upload/download operations' subtype and options */
40 #define FSF_CFDC_OPERATION_SUBTYPE 0x00020001
41 #define FSF_CFDC_OPTION_NORMAL_MODE 0x00000000
42 #define FSF_CFDC_OPTION_FORCE 0x00000001
43 #define FSF_CFDC_OPTION_FULL_ACCESS 0x00000002
44 #define FSF_CFDC_OPTION_RESTRICTED_ACCESS 0x00000004
46 /* FSF protocol states */
47 #define FSF_PROT_GOOD 0x00000001
48 #define FSF_PROT_QTCB_VERSION_ERROR 0x00000010
49 #define FSF_PROT_SEQ_NUMB_ERROR 0x00000020
50 #define FSF_PROT_UNSUPP_QTCB_TYPE 0x00000040
51 #define FSF_PROT_HOST_CONNECTION_INITIALIZING 0x00000080
52 #define FSF_PROT_FSF_STATUS_PRESENTED 0x00000100
53 #define FSF_PROT_DUPLICATE_REQUEST_ID 0x00000200
54 #define FSF_PROT_LINK_DOWN 0x00000400
55 #define FSF_PROT_REEST_QUEUE 0x00000800
56 #define FSF_PROT_ERROR_STATE 0x01000000
59 #define FSF_GOOD 0x00000000
60 #define FSF_PORT_ALREADY_OPEN 0x00000001
61 #define FSF_LUN_ALREADY_OPEN 0x00000002
62 #define FSF_PORT_HANDLE_NOT_VALID 0x00000003
63 #define FSF_LUN_HANDLE_NOT_VALID 0x00000004
64 #define FSF_HANDLE_MISMATCH 0x00000005
65 #define FSF_SERVICE_CLASS_NOT_SUPPORTED 0x00000006
66 #define FSF_FCPLUN_NOT_VALID 0x00000009
67 #define FSF_ACCESS_DENIED 0x00000010
68 #define FSF_LUN_SHARING_VIOLATION 0x00000012
69 #define FSF_FCP_COMMAND_DOES_NOT_EXIST 0x00000022
70 #define FSF_DIRECTION_INDICATOR_NOT_VALID 0x00000030
71 #define FSF_CMND_LENGTH_NOT_VALID 0x00000033
72 #define FSF_MAXIMUM_NUMBER_OF_PORTS_EXCEEDED 0x00000040
73 #define FSF_MAXIMUM_NUMBER_OF_LUNS_EXCEEDED 0x00000041
74 #define FSF_ELS_COMMAND_REJECTED 0x00000050
75 #define FSF_GENERIC_COMMAND_REJECTED 0x00000051
76 #define FSF_PORT_BOXED 0x00000059
77 #define FSF_LUN_BOXED 0x0000005A
78 #define FSF_EXCHANGE_CONFIG_DATA_INCOMPLETE 0x0000005B
79 #define FSF_PAYLOAD_SIZE_MISMATCH 0x00000060
80 #define FSF_REQUEST_SIZE_TOO_LARGE 0x00000061
81 #define FSF_RESPONSE_SIZE_TOO_LARGE 0x00000062
82 #define FSF_SBAL_MISMATCH 0x00000063
83 #define FSF_ADAPTER_STATUS_AVAILABLE 0x000000AD
84 #define FSF_UNKNOWN_COMMAND 0x000000E2
85 #define FSF_UNKNOWN_OP_SUBTYPE 0x000000E3
86 #define FSF_INVALID_COMMAND_OPTION 0x000000E5
87 /* #define FSF_ERROR 0x000000FF */
89 #define FSF_PROT_STATUS_QUAL_SIZE 16
90 #define FSF_STATUS_QUALIFIER_SIZE 16
92 /* FSF status qualifier, recommendations */
93 #define FSF_SQ_NO_RECOM 0x00
94 #define FSF_SQ_FCP_RSP_AVAILABLE 0x01
95 #define FSF_SQ_RETRY_IF_POSSIBLE 0x02
96 #define FSF_SQ_ULP_DEPENDENT_ERP_REQUIRED 0x03
97 #define FSF_SQ_INVOKE_LINK_TEST_PROCEDURE 0x04
98 #define FSF_SQ_COMMAND_ABORTED 0x06
99 #define FSF_SQ_NO_RETRY_POSSIBLE 0x07
101 /* FSF status qualifier (most significant 4 bytes), local link down */
102 #define FSF_PSQ_LINK_NO_LIGHT 0x00000004
103 #define FSF_PSQ_LINK_WRAP_PLUG 0x00000008
104 #define FSF_PSQ_LINK_NO_FCP 0x00000010
105 #define FSF_PSQ_LINK_FIRMWARE_UPDATE 0x00000020
106 #define FSF_PSQ_LINK_INVALID_WWPN 0x00000100
107 #define FSF_PSQ_LINK_NO_NPIV_SUPPORT 0x00000200
108 #define FSF_PSQ_LINK_NO_FCP_RESOURCES 0x00000400
109 #define FSF_PSQ_LINK_NO_FABRIC_RESOURCES 0x00000800
110 #define FSF_PSQ_LINK_FABRIC_LOGIN_UNABLE 0x00001000
111 #define FSF_PSQ_LINK_WWPN_ASSIGNMENT_CORRUPTED 0x00002000
112 #define FSF_PSQ_LINK_MODE_TABLE_CURRUPTED 0x00004000
113 #define FSF_PSQ_LINK_NO_WWPN_ASSIGNMENT 0x00008000
115 /* payload size in status read buffer */
116 #define FSF_STATUS_READ_PAYLOAD_SIZE 4032
118 /* number of status read buffers that should be sent by ULP */
119 #define FSF_STATUS_READS_RECOM 16
121 /* status types in status read buffer */
122 #define FSF_STATUS_READ_PORT_CLOSED 0x00000001
123 #define FSF_STATUS_READ_INCOMING_ELS 0x00000002
124 #define FSF_STATUS_READ_SENSE_DATA_AVAIL 0x00000003
125 #define FSF_STATUS_READ_BIT_ERROR_THRESHOLD 0x00000004
126 #define FSF_STATUS_READ_LINK_DOWN 0x00000005
127 #define FSF_STATUS_READ_LINK_UP 0x00000006
128 #define FSF_STATUS_READ_NOTIFICATION_LOST 0x00000009
129 #define FSF_STATUS_READ_CFDC_UPDATED 0x0000000A
130 #define FSF_STATUS_READ_FEATURE_UPDATE_ALERT 0x0000000C
132 /* status subtypes for link down */
133 #define FSF_STATUS_READ_SUB_NO_PHYSICAL_LINK 0x00000000
134 #define FSF_STATUS_READ_SUB_FDISC_FAILED 0x00000001
135 #define FSF_STATUS_READ_SUB_FIRMWARE_UPDATE 0x00000002
137 /* status subtypes for unsolicited status notification lost */
138 #define FSF_STATUS_READ_SUB_INCOMING_ELS 0x00000001
139 #define FSF_STATUS_READ_SUB_ACT_UPDATED 0x00000020
141 /* topologie that is detected by the adapter */
142 #define FSF_TOPO_P2P 0x00000001
143 #define FSF_TOPO_FABRIC 0x00000002
144 #define FSF_TOPO_AL 0x00000003
146 /* data direction for FCP commands */
147 #define FSF_DATADIR_WRITE 0x00000001
148 #define FSF_DATADIR_READ 0x00000002
149 #define FSF_DATADIR_CMND 0x00000004
151 /* fc service class */
152 #define FSF_CLASS_3 0x00000003
155 #define FSF_MAX_SBALS_PER_REQ 36
157 /* logging space behind QTCB */
158 #define FSF_QTCB_LOG_SIZE 1024
160 /* channel features */
161 #define FSF_FEATURE_CFDC 0x00000002
162 #define FSF_FEATURE_LUN_SHARING 0x00000004
163 #define FSF_FEATURE_NOTIFICATION_LOST 0x00000008
164 #define FSF_FEATURE_HBAAPI_MANAGEMENT 0x00000010
165 #define FSF_FEATURE_ELS_CT_CHAINED_SBALS 0x00000020
166 #define FSF_FEATURE_UPDATE_ALERT 0x00000100
167 #define FSF_FEATURE_MEASUREMENT_DATA 0x00000200
169 /* host connection features */
170 #define FSF_FEATURE_NPIV_MODE 0x00000001
173 #define FSF_OPEN_LUN_SUPPRESS_BOXING 0x00000001
175 /* open LUN access flags*/
176 #define FSF_UNIT_ACCESS_EXCLUSIVE 0x02000000
177 #define FSF_UNIT_ACCESS_OUTBOUND_TRANSFER 0x10000000
179 /* FSF interface for CFDC */
180 #define ZFCP_CFDC_MAX_SIZE 127 * 1024
181 #define ZFCP_CFDC_PAGES PFN_UP(ZFCP_CFDC_MAX_SIZE)
183 struct zfcp_fsf_cfdc {
184 struct scatterlist sg[ZFCP_CFDC_PAGES];
189 struct fsf_queue_designator {
195 } __attribute__ ((packed));
197 struct fsf_bit_error_payload {
199 u32 link_failure_error_count;
200 u32 loss_of_sync_error_count;
201 u32 loss_of_signal_error_count;
202 u32 primitive_sequence_error_count;
203 u32 invalid_transmission_word_error_count;
205 u32 primitive_sequence_event_timeout_count;
206 u32 elastic_buffer_overrun_error_count;
207 u32 fcal_arbitration_timeout_count;
208 u32 advertised_receive_b2b_credit;
209 u32 current_receive_b2b_credit;
210 u32 advertised_transmit_b2b_credit;
211 u32 current_transmit_b2b_credit;
212 } __attribute__ ((packed));
214 struct fsf_link_down_info {
223 u8 vendor_specific_code;
224 } __attribute__ ((packed));
226 struct fsf_status_read_buffer {
231 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 #define FSF_PLOGI_MIN_LEN 112
316 #define FSF_FCP_CMND_SIZE 288
317 #define FSF_FCP_RSP_SIZE 128
319 struct fsf_qtcb_bottom_io {
325 u8 fcp_cmnd[FSF_FCP_CMND_SIZE];
326 u8 fcp_rsp[FSF_FCP_RSP_SIZE];
328 } __attribute__ ((packed));
330 struct fsf_qtcb_bottom_support {
331 u32 operation_subtype;
348 } __attribute__ ((packed));
350 struct fsf_qtcb_bottom_config {
352 u32 feature_selection;
353 u32 high_qtcb_version;
354 u32 low_qtcb_version;
356 u32 max_data_transfer_size;
357 u32 adapter_features;
358 u32 connection_features;
368 u8 nport_serv_param[128];
371 u32 hardware_version;
372 u8 serial_number[32];
373 u8 plogi_payload[112];
374 struct fsf_statistics_info stat_info;
376 } __attribute__ ((packed));
378 struct fsf_qtcb_bottom_port {
383 u32 class_of_service; /* should be 0x00000006 for class 2 and 3 */
384 u8 supported_fc4_types[32]; /* should be 0x00000100 for scsi fcp */
385 u8 active_fc4_types[32];
386 u32 supported_speed; /* 0x0001 for 1 GBit/s or 0x0002 for 2 GBit/s */
387 u32 maximum_frame_size; /* fixed value of 2112 */
388 u64 seconds_since_last_reset;
394 u64 nos; /* currently 0 */
395 u64 error_frames; /* currently 0 */
396 u64 dumped_frames; /* currently 0 */
400 u64 psp_error_counts;
401 u64 invalid_tx_words;
405 u64 control_requests;
406 u64 input_mb; /* where 1 MByte == 1.000.000 Bytes */
407 u64 output_mb; /* where 1 MByte == 1.000.000 Bytes */
412 } __attribute__ ((packed));
414 union fsf_qtcb_bottom {
415 struct fsf_qtcb_bottom_io io;
416 struct fsf_qtcb_bottom_support support;
417 struct fsf_qtcb_bottom_config config;
418 struct fsf_qtcb_bottom_port port;
422 struct fsf_qtcb_prefix prefix;
423 struct fsf_qtcb_header header;
424 union fsf_qtcb_bottom bottom;
425 u8 log[FSF_QTCB_LOG_SIZE];
426 } __attribute__ ((packed));
428 struct zfcp_blk_drv_data {
429 #define ZFCP_BLK_DRV_DATA_MAGIC 0x1
431 #define ZFCP_BLK_LAT_VALID 0x1
432 #define ZFCP_BLK_REQ_ERROR 0x2
438 } __attribute__ ((packed));
441 * struct zfcp_fsf_ct_els - zfcp data for ct or els request
442 * @req: scatter-gather list for request
443 * @resp: scatter-gather list for response
444 * @handler: handler function (called for response to the request)
445 * @handler_data: data passed to handler function
446 * @port: Optional pointer to port for zfcp internal ELS (only test link ADISC)
447 * @status: used to pass error status to calling function
449 struct zfcp_fsf_ct_els {
450 struct scatterlist *req;
451 struct scatterlist *resp;
452 void (*handler)(void *);
454 struct zfcp_port *port;