1 /* 2 * zfcp device driver 3 * 4 * Interface to the FSF support functions. 5 * 6 * Copyright IBM Corporation 2002, 2009 7 */ 8 9 #ifndef FSF_H 10 #define FSF_H 11 12 #include <linux/pfn.h> 13 #include <linux/scatterlist.h> 14 15 #define FSF_QTCB_CURRENT_VERSION 0x00000001 16 17 /* FSF commands */ 18 #define FSF_QTCB_FCP_CMND 0x00000001 19 #define FSF_QTCB_ABORT_FCP_CMND 0x00000002 20 #define FSF_QTCB_OPEN_PORT_WITH_DID 0x00000005 21 #define FSF_QTCB_OPEN_LUN 0x00000006 22 #define FSF_QTCB_CLOSE_LUN 0x00000007 23 #define FSF_QTCB_CLOSE_PORT 0x00000008 24 #define FSF_QTCB_CLOSE_PHYSICAL_PORT 0x00000009 25 #define FSF_QTCB_SEND_ELS 0x0000000B 26 #define FSF_QTCB_SEND_GENERIC 0x0000000C 27 #define FSF_QTCB_EXCHANGE_CONFIG_DATA 0x0000000D 28 #define FSF_QTCB_EXCHANGE_PORT_DATA 0x0000000E 29 #define FSF_QTCB_DOWNLOAD_CONTROL_FILE 0x00000012 30 #define FSF_QTCB_UPLOAD_CONTROL_FILE 0x00000013 31 32 /* FSF QTCB types */ 33 #define FSF_IO_COMMAND 0x00000001 34 #define FSF_SUPPORT_COMMAND 0x00000002 35 #define FSF_CONFIG_COMMAND 0x00000003 36 #define FSF_PORT_COMMAND 0x00000004 37 38 /* FSF control file upload/download operations' subtype and options */ 39 #define FSF_CFDC_OPERATION_SUBTYPE 0x00020001 40 #define FSF_CFDC_OPTION_NORMAL_MODE 0x00000000 41 #define FSF_CFDC_OPTION_FORCE 0x00000001 42 #define FSF_CFDC_OPTION_FULL_ACCESS 0x00000002 43 #define FSF_CFDC_OPTION_RESTRICTED_ACCESS 0x00000004 44 45 /* FSF protocol states */ 46 #define FSF_PROT_GOOD 0x00000001 47 #define FSF_PROT_QTCB_VERSION_ERROR 0x00000010 48 #define FSF_PROT_SEQ_NUMB_ERROR 0x00000020 49 #define FSF_PROT_UNSUPP_QTCB_TYPE 0x00000040 50 #define FSF_PROT_HOST_CONNECTION_INITIALIZING 0x00000080 51 #define FSF_PROT_FSF_STATUS_PRESENTED 0x00000100 52 #define FSF_PROT_DUPLICATE_REQUEST_ID 0x00000200 53 #define FSF_PROT_LINK_DOWN 0x00000400 54 #define FSF_PROT_REEST_QUEUE 0x00000800 55 #define FSF_PROT_ERROR_STATE 0x01000000 56 57 /* FSF states */ 58 #define FSF_GOOD 0x00000000 59 #define FSF_PORT_ALREADY_OPEN 0x00000001 60 #define FSF_LUN_ALREADY_OPEN 0x00000002 61 #define FSF_PORT_HANDLE_NOT_VALID 0x00000003 62 #define FSF_LUN_HANDLE_NOT_VALID 0x00000004 63 #define FSF_HANDLE_MISMATCH 0x00000005 64 #define FSF_SERVICE_CLASS_NOT_SUPPORTED 0x00000006 65 #define FSF_FCPLUN_NOT_VALID 0x00000009 66 #define FSF_ACCESS_DENIED 0x00000010 67 #define FSF_LUN_SHARING_VIOLATION 0x00000012 68 #define FSF_FCP_COMMAND_DOES_NOT_EXIST 0x00000022 69 #define FSF_DIRECTION_INDICATOR_NOT_VALID 0x00000030 70 #define FSF_CMND_LENGTH_NOT_VALID 0x00000033 71 #define FSF_MAXIMUM_NUMBER_OF_PORTS_EXCEEDED 0x00000040 72 #define FSF_MAXIMUM_NUMBER_OF_LUNS_EXCEEDED 0x00000041 73 #define FSF_ELS_COMMAND_REJECTED 0x00000050 74 #define FSF_GENERIC_COMMAND_REJECTED 0x00000051 75 #define FSF_PORT_BOXED 0x00000059 76 #define FSF_LUN_BOXED 0x0000005A 77 #define FSF_EXCHANGE_CONFIG_DATA_INCOMPLETE 0x0000005B 78 #define FSF_PAYLOAD_SIZE_MISMATCH 0x00000060 79 #define FSF_REQUEST_SIZE_TOO_LARGE 0x00000061 80 #define FSF_RESPONSE_SIZE_TOO_LARGE 0x00000062 81 #define FSF_SBAL_MISMATCH 0x00000063 82 #define FSF_ADAPTER_STATUS_AVAILABLE 0x000000AD 83 #define FSF_UNKNOWN_COMMAND 0x000000E2 84 #define FSF_UNKNOWN_OP_SUBTYPE 0x000000E3 85 #define FSF_INVALID_COMMAND_OPTION 0x000000E5 86 /* #define FSF_ERROR 0x000000FF */ 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 /* payload size in status read buffer */ 115 #define FSF_STATUS_READ_PAYLOAD_SIZE 4032 116 117 /* number of status read buffers that should be sent by ULP */ 118 #define FSF_STATUS_READS_RECOM 16 119 120 /* status types in status read buffer */ 121 #define FSF_STATUS_READ_PORT_CLOSED 0x00000001 122 #define FSF_STATUS_READ_INCOMING_ELS 0x00000002 123 #define FSF_STATUS_READ_SENSE_DATA_AVAIL 0x00000003 124 #define FSF_STATUS_READ_BIT_ERROR_THRESHOLD 0x00000004 125 #define FSF_STATUS_READ_LINK_DOWN 0x00000005 126 #define FSF_STATUS_READ_LINK_UP 0x00000006 127 #define FSF_STATUS_READ_NOTIFICATION_LOST 0x00000009 128 #define FSF_STATUS_READ_CFDC_UPDATED 0x0000000A 129 #define FSF_STATUS_READ_FEATURE_UPDATE_ALERT 0x0000000C 130 131 /* status subtypes for link down */ 132 #define FSF_STATUS_READ_SUB_NO_PHYSICAL_LINK 0x00000000 133 #define FSF_STATUS_READ_SUB_FDISC_FAILED 0x00000001 134 #define FSF_STATUS_READ_SUB_FIRMWARE_UPDATE 0x00000002 135 136 /* status subtypes for unsolicited status notification lost */ 137 #define FSF_STATUS_READ_SUB_INCOMING_ELS 0x00000001 138 #define FSF_STATUS_READ_SUB_ACT_UPDATED 0x00000020 139 140 /* topologie that is detected by the adapter */ 141 #define FSF_TOPO_P2P 0x00000001 142 #define FSF_TOPO_FABRIC 0x00000002 143 #define FSF_TOPO_AL 0x00000003 144 145 /* data direction for FCP commands */ 146 #define FSF_DATADIR_WRITE 0x00000001 147 #define FSF_DATADIR_READ 0x00000002 148 #define FSF_DATADIR_CMND 0x00000004 149 150 /* fc service class */ 151 #define FSF_CLASS_3 0x00000003 152 153 /* SBAL chaining */ 154 #define FSF_MAX_SBALS_PER_REQ 36 155 156 /* logging space behind QTCB */ 157 #define FSF_QTCB_LOG_SIZE 1024 158 159 /* channel features */ 160 #define FSF_FEATURE_CFDC 0x00000002 161 #define FSF_FEATURE_LUN_SHARING 0x00000004 162 #define FSF_FEATURE_NOTIFICATION_LOST 0x00000008 163 #define FSF_FEATURE_HBAAPI_MANAGEMENT 0x00000010 164 #define FSF_FEATURE_ELS_CT_CHAINED_SBALS 0x00000020 165 #define FSF_FEATURE_UPDATE_ALERT 0x00000100 166 #define FSF_FEATURE_MEASUREMENT_DATA 0x00000200 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 /* open LUN access flags*/ 175 #define FSF_UNIT_ACCESS_EXCLUSIVE 0x02000000 176 #define FSF_UNIT_ACCESS_OUTBOUND_TRANSFER 0x10000000 177 178 /* FSF interface for CFDC */ 179 #define ZFCP_CFDC_MAX_SIZE 127 * 1024 180 #define ZFCP_CFDC_PAGES PFN_UP(ZFCP_CFDC_MAX_SIZE) 181 182 struct zfcp_fsf_cfdc { 183 struct scatterlist sg[ZFCP_CFDC_PAGES]; 184 u32 command; 185 u32 option; 186 }; 187 188 struct fsf_queue_designator { 189 u8 cssid; 190 u8 chpid; 191 u8 hla; 192 u8 ua; 193 u32 res1; 194 } __attribute__ ((packed)); 195 196 struct fsf_bit_error_payload { 197 u32 res1; 198 u32 link_failure_error_count; 199 u32 loss_of_sync_error_count; 200 u32 loss_of_signal_error_count; 201 u32 primitive_sequence_error_count; 202 u32 invalid_transmission_word_error_count; 203 u32 crc_error_count; 204 u32 primitive_sequence_event_timeout_count; 205 u32 elastic_buffer_overrun_error_count; 206 u32 fcal_arbitration_timeout_count; 207 u32 advertised_receive_b2b_credit; 208 u32 current_receive_b2b_credit; 209 u32 advertised_transmit_b2b_credit; 210 u32 current_transmit_b2b_credit; 211 } __attribute__ ((packed)); 212 213 struct fsf_link_down_info { 214 u32 error_code; 215 u32 res1; 216 u8 res2[2]; 217 u8 primary_status; 218 u8 ioerr_code; 219 u8 action_code; 220 u8 reason_code; 221 u8 explanation_code; 222 u8 vendor_specific_code; 223 } __attribute__ ((packed)); 224 225 struct fsf_status_read_buffer { 226 u32 status_type; 227 u32 status_subtype; 228 u32 length; 229 u32 res1; 230 struct fsf_queue_designator queue_designator; 231 u32 d_id; 232 u32 class; 233 u64 fcp_lun; 234 u8 res3[24]; 235 union { 236 u8 data[FSF_STATUS_READ_PAYLOAD_SIZE]; 237 u32 word[FSF_STATUS_READ_PAYLOAD_SIZE/sizeof(u32)]; 238 struct fsf_link_down_info link_down_info; 239 struct fsf_bit_error_payload bit_error; 240 } payload; 241 } __attribute__ ((packed)); 242 243 struct fsf_qual_version_error { 244 u32 fsf_version; 245 u32 res1[3]; 246 } __attribute__ ((packed)); 247 248 struct fsf_qual_sequence_error { 249 u32 exp_req_seq_no; 250 u32 res1[3]; 251 } __attribute__ ((packed)); 252 253 struct fsf_qual_latency_info { 254 u32 channel_lat; 255 u32 fabric_lat; 256 u8 res1[8]; 257 } __attribute__ ((packed)); 258 259 union fsf_prot_status_qual { 260 u32 word[FSF_PROT_STATUS_QUAL_SIZE / sizeof(u32)]; 261 u64 doubleword[FSF_PROT_STATUS_QUAL_SIZE / sizeof(u64)]; 262 struct fsf_qual_version_error version_error; 263 struct fsf_qual_sequence_error sequence_error; 264 struct fsf_link_down_info link_down_info; 265 struct fsf_qual_latency_info latency_info; 266 } __attribute__ ((packed)); 267 268 struct fsf_qtcb_prefix { 269 u64 req_id; 270 u32 qtcb_version; 271 u32 ulp_info; 272 u32 qtcb_type; 273 u32 req_seq_no; 274 u32 prot_status; 275 union fsf_prot_status_qual prot_status_qual; 276 u8 res1[20]; 277 } __attribute__ ((packed)); 278 279 struct fsf_statistics_info { 280 u64 input_req; 281 u64 output_req; 282 u64 control_req; 283 u64 input_mb; 284 u64 output_mb; 285 u64 seconds_act; 286 } __attribute__ ((packed)); 287 288 union fsf_status_qual { 289 u8 byte[FSF_STATUS_QUALIFIER_SIZE]; 290 u16 halfword[FSF_STATUS_QUALIFIER_SIZE / sizeof (u16)]; 291 u32 word[FSF_STATUS_QUALIFIER_SIZE / sizeof (u32)]; 292 u64 doubleword[FSF_STATUS_QUALIFIER_SIZE / sizeof(u64)]; 293 struct fsf_queue_designator fsf_queue_designator; 294 struct fsf_link_down_info link_down_info; 295 } __attribute__ ((packed)); 296 297 struct fsf_qtcb_header { 298 u64 req_handle; 299 u32 fsf_command; 300 u32 res1; 301 u32 port_handle; 302 u32 lun_handle; 303 u32 res2; 304 u32 fsf_status; 305 union fsf_status_qual fsf_status_qual; 306 u8 res3[28]; 307 u16 log_start; 308 u16 log_length; 309 u8 res4[16]; 310 } __attribute__ ((packed)); 311 312 struct fsf_nport_serv_param { 313 u8 common_serv_param[16]; 314 u64 wwpn; 315 u64 wwnn; 316 u8 class1_serv_param[16]; 317 u8 class2_serv_param[16]; 318 u8 class3_serv_param[16]; 319 u8 class4_serv_param[16]; 320 u8 vendor_version_level[16]; 321 } __attribute__ ((packed)); 322 323 #define FSF_PLOGI_MIN_LEN 112 324 struct fsf_plogi { 325 u32 code; 326 struct fsf_nport_serv_param serv_param; 327 } __attribute__ ((packed)); 328 329 #define FSF_FCP_CMND_SIZE 288 330 #define FSF_FCP_RSP_SIZE 128 331 332 struct fsf_qtcb_bottom_io { 333 u32 data_direction; 334 u32 service_class; 335 u8 res1[8]; 336 u32 fcp_cmnd_length; 337 u8 res2[12]; 338 u8 fcp_cmnd[FSF_FCP_CMND_SIZE]; 339 u8 fcp_rsp[FSF_FCP_RSP_SIZE]; 340 u8 res3[64]; 341 } __attribute__ ((packed)); 342 343 struct fsf_qtcb_bottom_support { 344 u32 operation_subtype; 345 u8 res1[12]; 346 u32 d_id; 347 u32 option; 348 u64 fcp_lun; 349 u64 res2; 350 u64 req_handle; 351 u32 service_class; 352 u8 res3[3]; 353 u8 timeout; 354 u32 lun_access_info; 355 u8 res4[180]; 356 u32 els1_length; 357 u32 els2_length; 358 u32 req_buf_length; 359 u32 resp_buf_length; 360 u8 els[256]; 361 } __attribute__ ((packed)); 362 363 struct fsf_qtcb_bottom_config { 364 u32 lic_version; 365 u32 feature_selection; 366 u32 high_qtcb_version; 367 u32 low_qtcb_version; 368 u32 max_qtcb_size; 369 u32 max_data_transfer_size; 370 u32 adapter_features; 371 u32 connection_features; 372 u32 fc_topology; 373 u32 fc_link_speed; 374 u32 adapter_type; 375 u32 peer_d_id; 376 u8 res1[2]; 377 u16 timer_interval; 378 u8 res2[8]; 379 u32 s_id; 380 struct fsf_nport_serv_param nport_serv_param; 381 u8 reserved_nport_serv_param[16]; 382 u8 res3[8]; 383 u32 adapter_ports; 384 u32 hardware_version; 385 u8 serial_number[32]; 386 struct fsf_nport_serv_param plogi_payload; 387 struct fsf_statistics_info stat_info; 388 u8 res4[112]; 389 } __attribute__ ((packed)); 390 391 struct fsf_qtcb_bottom_port { 392 u64 wwpn; 393 u32 fc_port_id; 394 u32 port_type; 395 u32 port_state; 396 u32 class_of_service; /* should be 0x00000006 for class 2 and 3 */ 397 u8 supported_fc4_types[32]; /* should be 0x00000100 for scsi fcp */ 398 u8 active_fc4_types[32]; 399 u32 supported_speed; /* 0x0001 for 1 GBit/s or 0x0002 for 2 GBit/s */ 400 u32 maximum_frame_size; /* fixed value of 2112 */ 401 u64 seconds_since_last_reset; 402 u64 tx_frames; 403 u64 tx_words; 404 u64 rx_frames; 405 u64 rx_words; 406 u64 lip; /* 0 */ 407 u64 nos; /* currently 0 */ 408 u64 error_frames; /* currently 0 */ 409 u64 dumped_frames; /* currently 0 */ 410 u64 link_failure; 411 u64 loss_of_sync; 412 u64 loss_of_signal; 413 u64 psp_error_counts; 414 u64 invalid_tx_words; 415 u64 invalid_crcs; 416 u64 input_requests; 417 u64 output_requests; 418 u64 control_requests; 419 u64 input_mb; /* where 1 MByte == 1.000.000 Bytes */ 420 u64 output_mb; /* where 1 MByte == 1.000.000 Bytes */ 421 u8 cp_util; 422 u8 cb_util; 423 u8 a_util; 424 u8 res2[253]; 425 } __attribute__ ((packed)); 426 427 union fsf_qtcb_bottom { 428 struct fsf_qtcb_bottom_io io; 429 struct fsf_qtcb_bottom_support support; 430 struct fsf_qtcb_bottom_config config; 431 struct fsf_qtcb_bottom_port port; 432 }; 433 434 struct fsf_qtcb { 435 struct fsf_qtcb_prefix prefix; 436 struct fsf_qtcb_header header; 437 union fsf_qtcb_bottom bottom; 438 u8 log[FSF_QTCB_LOG_SIZE]; 439 } __attribute__ ((packed)); 440 441 struct zfcp_blk_drv_data { 442 #define ZFCP_BLK_DRV_DATA_MAGIC 0x1 443 u32 magic; 444 #define ZFCP_BLK_LAT_VALID 0x1 445 #define ZFCP_BLK_REQ_ERROR 0x2 446 u16 flags; 447 u8 inb_usage; 448 u8 outb_usage; 449 u64 channel_lat; 450 u64 fabric_lat; 451 } __attribute__ ((packed)); 452 453 #endif /* FSF_H */ 454