1 /* 2 * zfcp device driver 3 * 4 * Interface to the FSF support functions. 5 * 6 * Copyright IBM Corp. 2002, 2017 7 */ 8 9 #ifndef FSF_H 10 #define FSF_H 11 12 #include <linux/pfn.h> 13 #include <linux/scatterlist.h> 14 #include <scsi/libfc.h> 15 16 #define FSF_QTCB_CURRENT_VERSION 0x00000001 17 18 /* FSF commands */ 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 32 33 /* FSF QTCB types */ 34 #define FSF_IO_COMMAND 0x00000001 35 #define FSF_SUPPORT_COMMAND 0x00000002 36 #define FSF_CONFIG_COMMAND 0x00000003 37 #define FSF_PORT_COMMAND 0x00000004 38 39 /* FSF protocol states */ 40 #define FSF_PROT_GOOD 0x00000001 41 #define FSF_PROT_QTCB_VERSION_ERROR 0x00000010 42 #define FSF_PROT_SEQ_NUMB_ERROR 0x00000020 43 #define FSF_PROT_UNSUPP_QTCB_TYPE 0x00000040 44 #define FSF_PROT_HOST_CONNECTION_INITIALIZING 0x00000080 45 #define FSF_PROT_FSF_STATUS_PRESENTED 0x00000100 46 #define FSF_PROT_DUPLICATE_REQUEST_ID 0x00000200 47 #define FSF_PROT_LINK_DOWN 0x00000400 48 #define FSF_PROT_REEST_QUEUE 0x00000800 49 #define FSF_PROT_ERROR_STATE 0x01000000 50 51 /* FSF states */ 52 #define FSF_GOOD 0x00000000 53 #define FSF_PORT_ALREADY_OPEN 0x00000001 54 #define FSF_LUN_ALREADY_OPEN 0x00000002 55 #define FSF_PORT_HANDLE_NOT_VALID 0x00000003 56 #define FSF_LUN_HANDLE_NOT_VALID 0x00000004 57 #define FSF_HANDLE_MISMATCH 0x00000005 58 #define FSF_SERVICE_CLASS_NOT_SUPPORTED 0x00000006 59 #define FSF_FCPLUN_NOT_VALID 0x00000009 60 #define FSF_LUN_SHARING_VIOLATION 0x00000012 61 #define FSF_FCP_COMMAND_DOES_NOT_EXIST 0x00000022 62 #define FSF_DIRECTION_INDICATOR_NOT_VALID 0x00000030 63 #define FSF_CMND_LENGTH_NOT_VALID 0x00000033 64 #define FSF_MAXIMUM_NUMBER_OF_PORTS_EXCEEDED 0x00000040 65 #define FSF_MAXIMUM_NUMBER_OF_LUNS_EXCEEDED 0x00000041 66 #define FSF_ELS_COMMAND_REJECTED 0x00000050 67 #define FSF_GENERIC_COMMAND_REJECTED 0x00000051 68 #define FSF_PORT_BOXED 0x00000059 69 #define FSF_LUN_BOXED 0x0000005A 70 #define FSF_EXCHANGE_CONFIG_DATA_INCOMPLETE 0x0000005B 71 #define FSF_PAYLOAD_SIZE_MISMATCH 0x00000060 72 #define FSF_REQUEST_SIZE_TOO_LARGE 0x00000061 73 #define FSF_RESPONSE_SIZE_TOO_LARGE 0x00000062 74 #define FSF_SBAL_MISMATCH 0x00000063 75 #define FSF_INCONSISTENT_PROT_DATA 0x00000070 76 #define FSF_INVALID_PROT_PARM 0x00000071 77 #define FSF_BLOCK_GUARD_CHECK_FAILURE 0x00000081 78 #define FSF_APP_TAG_CHECK_FAILURE 0x00000082 79 #define FSF_REF_TAG_CHECK_FAILURE 0x00000083 80 #define FSF_ADAPTER_STATUS_AVAILABLE 0x000000AD 81 #define FSF_FCP_RSP_AVAILABLE 0x000000AF 82 #define FSF_UNKNOWN_COMMAND 0x000000E2 83 #define FSF_UNKNOWN_OP_SUBTYPE 0x000000E3 84 #define FSF_INVALID_COMMAND_OPTION 0x000000E5 85 86 #define FSF_PROT_STATUS_QUAL_SIZE 16 87 #define FSF_STATUS_QUALIFIER_SIZE 16 88 89 /* FSF status qualifier, recommendations */ 90 #define FSF_SQ_NO_RECOM 0x00 91 #define FSF_SQ_FCP_RSP_AVAILABLE 0x01 92 #define FSF_SQ_RETRY_IF_POSSIBLE 0x02 93 #define FSF_SQ_ULP_DEPENDENT_ERP_REQUIRED 0x03 94 #define FSF_SQ_INVOKE_LINK_TEST_PROCEDURE 0x04 95 #define FSF_SQ_COMMAND_ABORTED 0x06 96 #define FSF_SQ_NO_RETRY_POSSIBLE 0x07 97 98 /* FSF status qualifier (most significant 4 bytes), local link down */ 99 #define FSF_PSQ_LINK_NO_LIGHT 0x00000004 100 #define FSF_PSQ_LINK_WRAP_PLUG 0x00000008 101 #define FSF_PSQ_LINK_NO_FCP 0x00000010 102 #define FSF_PSQ_LINK_FIRMWARE_UPDATE 0x00000020 103 #define FSF_PSQ_LINK_INVALID_WWPN 0x00000100 104 #define FSF_PSQ_LINK_NO_NPIV_SUPPORT 0x00000200 105 #define FSF_PSQ_LINK_NO_FCP_RESOURCES 0x00000400 106 #define FSF_PSQ_LINK_NO_FABRIC_RESOURCES 0x00000800 107 #define FSF_PSQ_LINK_FABRIC_LOGIN_UNABLE 0x00001000 108 #define FSF_PSQ_LINK_WWPN_ASSIGNMENT_CORRUPTED 0x00002000 109 #define FSF_PSQ_LINK_MODE_TABLE_CURRUPTED 0x00004000 110 #define FSF_PSQ_LINK_NO_WWPN_ASSIGNMENT 0x00008000 111 112 /* payload size in status read buffer */ 113 #define FSF_STATUS_READ_PAYLOAD_SIZE 4032 114 115 /* number of status read buffers that should be sent by ULP */ 116 #define FSF_STATUS_READS_RECOM 16 117 118 /* status types in status read buffer */ 119 #define FSF_STATUS_READ_PORT_CLOSED 0x00000001 120 #define FSF_STATUS_READ_INCOMING_ELS 0x00000002 121 #define FSF_STATUS_READ_SENSE_DATA_AVAIL 0x00000003 122 #define FSF_STATUS_READ_BIT_ERROR_THRESHOLD 0x00000004 123 #define FSF_STATUS_READ_LINK_DOWN 0x00000005 124 #define FSF_STATUS_READ_LINK_UP 0x00000006 125 #define FSF_STATUS_READ_NOTIFICATION_LOST 0x00000009 126 #define FSF_STATUS_READ_FEATURE_UPDATE_ALERT 0x0000000C 127 128 /* status subtypes for link down */ 129 #define FSF_STATUS_READ_SUB_NO_PHYSICAL_LINK 0x00000000 130 #define FSF_STATUS_READ_SUB_FDISC_FAILED 0x00000001 131 #define FSF_STATUS_READ_SUB_FIRMWARE_UPDATE 0x00000002 132 133 /* status subtypes for unsolicited status notification lost */ 134 #define FSF_STATUS_READ_SUB_INCOMING_ELS 0x00000001 135 136 /* topologie that is detected by the adapter */ 137 #define FSF_TOPO_P2P 0x00000001 138 #define FSF_TOPO_FABRIC 0x00000002 139 #define FSF_TOPO_AL 0x00000003 140 141 /* data direction for FCP commands */ 142 #define FSF_DATADIR_WRITE 0x00000001 143 #define FSF_DATADIR_READ 0x00000002 144 #define FSF_DATADIR_CMND 0x00000004 145 #define FSF_DATADIR_DIF_WRITE_INSERT 0x00000009 146 #define FSF_DATADIR_DIF_READ_STRIP 0x0000000a 147 #define FSF_DATADIR_DIF_WRITE_CONVERT 0x0000000b 148 #define FSF_DATADIR_DIF_READ_CONVERT 0X0000000c 149 150 /* data protection control flags */ 151 #define FSF_APP_TAG_CHECK_ENABLE 0x10 152 153 /* fc service class */ 154 #define FSF_CLASS_3 0x00000003 155 156 /* logging space behind QTCB */ 157 #define FSF_QTCB_LOG_SIZE 1024 158 159 /* channel features */ 160 #define FSF_FEATURE_NOTIFICATION_LOST 0x00000008 161 #define FSF_FEATURE_HBAAPI_MANAGEMENT 0x00000010 162 #define FSF_FEATURE_ELS_CT_CHAINED_SBALS 0x00000020 163 #define FSF_FEATURE_UPDATE_ALERT 0x00000100 164 #define FSF_FEATURE_MEASUREMENT_DATA 0x00000200 165 #define FSF_FEATURE_DIF_PROT_TYPE1 0x00010000 166 #define FSF_FEATURE_DIX_PROT_TCPIP 0x00020000 167 168 /* host connection features */ 169 #define FSF_FEATURE_NPIV_MODE 0x00000001 170 171 /* option */ 172 #define FSF_OPEN_LUN_SUPPRESS_BOXING 0x00000001 173 174 struct fsf_queue_designator { 175 u8 cssid; 176 u8 chpid; 177 u8 hla; 178 u8 ua; 179 u32 res1; 180 } __attribute__ ((packed)); 181 182 struct fsf_bit_error_payload { 183 u32 res1; 184 u32 link_failure_error_count; 185 u32 loss_of_sync_error_count; 186 u32 loss_of_signal_error_count; 187 u32 primitive_sequence_error_count; 188 u32 invalid_transmission_word_error_count; 189 u32 crc_error_count; 190 u32 primitive_sequence_event_timeout_count; 191 u32 elastic_buffer_overrun_error_count; 192 u32 fcal_arbitration_timeout_count; 193 u32 advertised_receive_b2b_credit; 194 u32 current_receive_b2b_credit; 195 u32 advertised_transmit_b2b_credit; 196 u32 current_transmit_b2b_credit; 197 } __attribute__ ((packed)); 198 199 struct fsf_link_down_info { 200 u32 error_code; 201 u32 res1; 202 u8 res2[2]; 203 u8 primary_status; 204 u8 ioerr_code; 205 u8 action_code; 206 u8 reason_code; 207 u8 explanation_code; 208 u8 vendor_specific_code; 209 } __attribute__ ((packed)); 210 211 struct fsf_status_read_buffer { 212 u32 status_type; 213 u32 status_subtype; 214 u32 length; 215 u32 res1; 216 struct fsf_queue_designator queue_designator; 217 u8 res2; 218 u8 d_id[3]; 219 u32 class; 220 u64 fcp_lun; 221 u8 res3[24]; 222 union { 223 u8 data[FSF_STATUS_READ_PAYLOAD_SIZE]; 224 u32 word[FSF_STATUS_READ_PAYLOAD_SIZE/sizeof(u32)]; 225 struct fsf_link_down_info link_down_info; 226 struct fsf_bit_error_payload bit_error; 227 } payload; 228 } __attribute__ ((packed)); 229 230 struct fsf_qual_version_error { 231 u32 fsf_version; 232 u32 res1[3]; 233 } __attribute__ ((packed)); 234 235 struct fsf_qual_sequence_error { 236 u32 exp_req_seq_no; 237 u32 res1[3]; 238 } __attribute__ ((packed)); 239 240 struct fsf_qual_latency_info { 241 u32 channel_lat; 242 u32 fabric_lat; 243 u8 res1[8]; 244 } __attribute__ ((packed)); 245 246 union fsf_prot_status_qual { 247 u32 word[FSF_PROT_STATUS_QUAL_SIZE / sizeof(u32)]; 248 u64 doubleword[FSF_PROT_STATUS_QUAL_SIZE / sizeof(u64)]; 249 struct fsf_qual_version_error version_error; 250 struct fsf_qual_sequence_error sequence_error; 251 struct fsf_link_down_info link_down_info; 252 struct fsf_qual_latency_info latency_info; 253 } __attribute__ ((packed)); 254 255 struct fsf_qtcb_prefix { 256 u64 req_id; 257 u32 qtcb_version; 258 u32 ulp_info; 259 u32 qtcb_type; 260 u32 req_seq_no; 261 u32 prot_status; 262 union fsf_prot_status_qual prot_status_qual; 263 u8 res1[20]; 264 } __attribute__ ((packed)); 265 266 struct fsf_statistics_info { 267 u64 input_req; 268 u64 output_req; 269 u64 control_req; 270 u64 input_mb; 271 u64 output_mb; 272 u64 seconds_act; 273 } __attribute__ ((packed)); 274 275 union fsf_status_qual { 276 u8 byte[FSF_STATUS_QUALIFIER_SIZE]; 277 u16 halfword[FSF_STATUS_QUALIFIER_SIZE / sizeof (u16)]; 278 u32 word[FSF_STATUS_QUALIFIER_SIZE / sizeof (u32)]; 279 u64 doubleword[FSF_STATUS_QUALIFIER_SIZE / sizeof(u64)]; 280 struct fsf_queue_designator fsf_queue_designator; 281 struct fsf_link_down_info link_down_info; 282 } __attribute__ ((packed)); 283 284 struct fsf_qtcb_header { 285 u64 req_handle; 286 u32 fsf_command; 287 u32 res1; 288 u32 port_handle; 289 u32 lun_handle; 290 u32 res2; 291 u32 fsf_status; 292 union fsf_status_qual fsf_status_qual; 293 u8 res3[28]; 294 u16 log_start; 295 u16 log_length; 296 u8 res4[16]; 297 } __attribute__ ((packed)); 298 299 #define FSF_PLOGI_MIN_LEN 112 300 301 #define FSF_FCP_CMND_SIZE 288 302 #define FSF_FCP_RSP_SIZE 128 303 304 struct fsf_qtcb_bottom_io { 305 u32 data_direction; 306 u32 service_class; 307 u8 res1; 308 u8 data_prot_flags; 309 u16 app_tag_value; 310 u32 ref_tag_value; 311 u32 fcp_cmnd_length; 312 u32 data_block_length; 313 u32 prot_data_length; 314 u8 res2[4]; 315 union { 316 u8 byte[FSF_FCP_CMND_SIZE]; 317 struct fcp_cmnd iu; 318 } fcp_cmnd; 319 union { 320 u8 byte[FSF_FCP_RSP_SIZE]; 321 struct fcp_resp_with_ext iu; 322 } fcp_rsp; 323 u8 res3[64]; 324 } __attribute__ ((packed)); 325 326 struct fsf_qtcb_bottom_support { 327 u32 operation_subtype; 328 u8 res1[13]; 329 u8 d_id[3]; 330 u32 option; 331 u64 fcp_lun; 332 u64 res2; 333 u64 req_handle; 334 u32 service_class; 335 u8 res3[3]; 336 u8 timeout; 337 u32 lun_access_info; 338 u8 res4[180]; 339 u32 els1_length; 340 u32 els2_length; 341 u32 req_buf_length; 342 u32 resp_buf_length; 343 u8 els[256]; 344 } __attribute__ ((packed)); 345 346 #define ZFCP_FSF_TIMER_INT_MASK 0x3FFF 347 348 struct fsf_qtcb_bottom_config { 349 u32 lic_version; 350 u32 feature_selection; 351 u32 high_qtcb_version; 352 u32 low_qtcb_version; 353 u32 max_qtcb_size; 354 u32 max_data_transfer_size; 355 u32 adapter_features; 356 u32 connection_features; 357 u32 fc_topology; 358 u32 fc_link_speed; 359 u32 adapter_type; 360 u8 res0; 361 u8 peer_d_id[3]; 362 u16 status_read_buf_num; 363 u16 timer_interval; 364 u8 res2[9]; 365 u8 s_id[3]; 366 u8 nport_serv_param[128]; 367 u8 res3[8]; 368 u32 adapter_ports; 369 u32 hardware_version; 370 u8 serial_number[32]; 371 u8 plogi_payload[112]; 372 struct fsf_statistics_info stat_info; 373 u8 res4[112]; 374 } __attribute__ ((packed)); 375 376 struct fsf_qtcb_bottom_port { 377 u64 wwpn; 378 u32 fc_port_id; 379 u32 port_type; 380 u32 port_state; 381 u32 class_of_service; /* should be 0x00000006 for class 2 and 3 */ 382 u8 supported_fc4_types[32]; /* should be 0x00000100 for scsi fcp */ 383 u8 active_fc4_types[32]; 384 u32 supported_speed; /* 0x0001 for 1 GBit/s or 0x0002 for 2 GBit/s */ 385 u32 maximum_frame_size; /* fixed value of 2112 */ 386 u64 seconds_since_last_reset; 387 u64 tx_frames; 388 u64 tx_words; 389 u64 rx_frames; 390 u64 rx_words; 391 u64 lip; /* 0 */ 392 u64 nos; /* currently 0 */ 393 u64 error_frames; /* currently 0 */ 394 u64 dumped_frames; /* currently 0 */ 395 u64 link_failure; 396 u64 loss_of_sync; 397 u64 loss_of_signal; 398 u64 psp_error_counts; 399 u64 invalid_tx_words; 400 u64 invalid_crcs; 401 u64 input_requests; 402 u64 output_requests; 403 u64 control_requests; 404 u64 input_mb; /* where 1 MByte == 1.000.000 Bytes */ 405 u64 output_mb; /* where 1 MByte == 1.000.000 Bytes */ 406 u8 cp_util; 407 u8 cb_util; 408 u8 a_util; 409 u8 res2[253]; 410 } __attribute__ ((packed)); 411 412 union fsf_qtcb_bottom { 413 struct fsf_qtcb_bottom_io io; 414 struct fsf_qtcb_bottom_support support; 415 struct fsf_qtcb_bottom_config config; 416 struct fsf_qtcb_bottom_port port; 417 }; 418 419 struct fsf_qtcb { 420 struct fsf_qtcb_prefix prefix; 421 struct fsf_qtcb_header header; 422 union fsf_qtcb_bottom bottom; 423 u8 log[FSF_QTCB_LOG_SIZE]; 424 } __attribute__ ((packed)); 425 426 struct zfcp_blk_drv_data { 427 #define ZFCP_BLK_DRV_DATA_MAGIC 0x1 428 u32 magic; 429 #define ZFCP_BLK_LAT_VALID 0x1 430 #define ZFCP_BLK_REQ_ERROR 0x2 431 u16 flags; 432 u8 inb_usage; 433 u8 outb_usage; 434 u64 channel_lat; 435 u64 fabric_lat; 436 } __attribute__ ((packed)); 437 438 /** 439 * struct zfcp_fsf_ct_els - zfcp data for ct or els request 440 * @req: scatter-gather list for request 441 * @resp: scatter-gather list for response 442 * @handler: handler function (called for response to the request) 443 * @handler_data: data passed to handler function 444 * @port: Optional pointer to port for zfcp internal ELS (only test link ADISC) 445 * @status: used to pass error status to calling function 446 * @d_id: Destination ID of either open WKA port for CT or of D_ID for ELS 447 */ 448 struct zfcp_fsf_ct_els { 449 struct scatterlist *req; 450 struct scatterlist *resp; 451 void (*handler)(void *); 452 void *handler_data; 453 struct zfcp_port *port; 454 int status; 455 u32 d_id; 456 }; 457 458 #endif /* FSF_H */ 459