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