drivers/s390/scsi/zfcp_fsf.h

   1 /*
   2  *
   3  * linux/drivers/s390/scsi/zfcp_fsf.h
   4  *
   5  * FCP adapter driver for IBM eServer zSeries
   6  *
   7  * (C) Copyright IBM Corp. 2002, 2004
   8  *
   9  * Author(s): Martin Peschke <mpeschke@de.ibm.com>
  10  *            Raimund Schroeder <raimund.schroeder@de.ibm.com>
  11  *            Aron Zeh
  12  *            Wolfgang Taphorn
  13  *            Stefan Bader <stefan.bader@de.ibm.com>
  14  *            Heiko Carstens <heiko.carstens@de.ibm.com>
  15  *
  16  * This program is free software; you can redistribute it and/or modify
  17  * it under the terms of the GNU General Public License as published by
  18  * the Free Software Foundation; either version 2, or (at your option)
  19  * any later version.
  20  *
  21  * This program is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  * GNU General Public License for more details.
  25  *
  26  * You should have received a copy of the GNU General Public License
  27  * along with this program; if not, write to the Free Software
  28  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  29  */
  30
  31 #ifndef FSF_H
  32 #define FSF_H
  33
  34 #define FSF_QTCB_VERSION1                       0x00000001
  35 #define FSF_QTCB_CURRENT_VERSION                FSF_QTCB_VERSION1
  36
  37 /* FSF commands */
  38 #define FSF_QTCB_FCP_CMND                       0x00000001
  39 #define FSF_QTCB_ABORT_FCP_CMND                 0x00000002
  40 #define FSF_QTCB_OPEN_PORT_WITH_DID             0x00000005
  41 #define FSF_QTCB_OPEN_LUN                       0x00000006
  42 #define FSF_QTCB_CLOSE_LUN                      0x00000007
  43 #define FSF_QTCB_CLOSE_PORT                     0x00000008
  44 #define FSF_QTCB_CLOSE_PHYSICAL_PORT            0x00000009
  45 #define FSF_QTCB_SEND_ELS                       0x0000000B
  46 #define FSF_QTCB_SEND_GENERIC                   0x0000000C
  47 #define FSF_QTCB_EXCHANGE_CONFIG_DATA           0x0000000D
  48 #define FSF_QTCB_EXCHANGE_PORT_DATA             0x0000000E
  49 #define FSF_QTCB_DOWNLOAD_CONTROL_FILE          0x00000012
  50 #define FSF_QTCB_UPLOAD_CONTROL_FILE            0x00000013
  51
  52 /* FSF QTCB types */
  53 #define FSF_IO_COMMAND                          0x00000001
  54 #define FSF_SUPPORT_COMMAND                     0x00000002
  55 #define FSF_CONFIG_COMMAND                      0x00000003
  56 #define FSF_PORT_COMMAND                        0x00000004
  57
  58 /* FSF control file upload/download operations' subtype and options */
  59 #define FSF_CFDC_OPERATION_SUBTYPE              0x00020001
  60 #define FSF_CFDC_OPTION_NORMAL_MODE             0x00000000
  61 #define FSF_CFDC_OPTION_FORCE                   0x00000001
  62 #define FSF_CFDC_OPTION_FULL_ACCESS             0x00000002
  63 #define FSF_CFDC_OPTION_RESTRICTED_ACCESS       0x00000004
  64
  65 /* FSF protocol stati */
  66 #define FSF_PROT_GOOD                           0x00000001
  67 #define FSF_PROT_QTCB_VERSION_ERROR             0x00000010
  68 #define FSF_PROT_SEQ_NUMB_ERROR                 0x00000020
  69 #define FSF_PROT_UNSUPP_QTCB_TYPE               0x00000040
  70 #define FSF_PROT_HOST_CONNECTION_INITIALIZING   0x00000080
  71 #define FSF_PROT_FSF_STATUS_PRESENTED           0x00000100
  72 #define FSF_PROT_DUPLICATE_REQUEST_ID           0x00000200
  73 #define FSF_PROT_LINK_DOWN                      0x00000400
  74 #define FSF_PROT_REEST_QUEUE                    0x00000800
  75 #define FSF_PROT_ERROR_STATE                    0x01000000
  76
  77 /* FSF stati */
  78 #define FSF_GOOD                                0x00000000
  79 #define FSF_PORT_ALREADY_OPEN                   0x00000001
  80 #define FSF_LUN_ALREADY_OPEN                    0x00000002
  81 #define FSF_PORT_HANDLE_NOT_VALID               0x00000003
  82 #define FSF_LUN_HANDLE_NOT_VALID                0x00000004
  83 #define FSF_HANDLE_MISMATCH                     0x00000005
  84 #define FSF_SERVICE_CLASS_NOT_SUPPORTED         0x00000006
  85 #define FSF_FCPLUN_NOT_VALID                    0x00000009
  86 #define FSF_ACCESS_DENIED                       0x00000010
  87 #define FSF_LUN_SHARING_VIOLATION               0x00000012
  88 #define FSF_FCP_COMMAND_DOES_NOT_EXIST          0x00000022
  89 #define FSF_DIRECTION_INDICATOR_NOT_VALID       0x00000030
  90 #define FSF_CMND_LENGTH_NOT_VALID               0x00000033
  91 #define FSF_MAXIMUM_NUMBER_OF_PORTS_EXCEEDED    0x00000040
  92 #define FSF_MAXIMUM_NUMBER_OF_LUNS_EXCEEDED     0x00000041
  93 #define FSF_ELS_COMMAND_REJECTED                0x00000050
  94 #define FSF_GENERIC_COMMAND_REJECTED            0x00000051
  95 #define FSF_OPERATION_PARTIALLY_SUCCESSFUL      0x00000052
  96 #define FSF_AUTHORIZATION_FAILURE               0x00000053
  97 #define FSF_CFDC_ERROR_DETECTED                 0x00000054
  98 #define FSF_CONTROL_FILE_UPDATE_ERROR           0x00000055
  99 #define FSF_CONTROL_FILE_TOO_LARGE              0x00000056
 100 #define FSF_ACCESS_CONFLICT_DETECTED            0x00000057
 101 #define FSF_CONFLICTS_OVERRULED                 0x00000058
 102 #define FSF_PORT_BOXED                          0x00000059
 103 #define FSF_LUN_BOXED                           0x0000005A
 104 #define FSF_EXCHANGE_CONFIG_DATA_INCOMPLETE     0x0000005B
 105 #define FSF_PAYLOAD_SIZE_MISMATCH               0x00000060
 106 #define FSF_REQUEST_SIZE_TOO_LARGE              0x00000061
 107 #define FSF_RESPONSE_SIZE_TOO_LARGE             0x00000062
 108 #define FSF_ADAPTER_STATUS_AVAILABLE            0x000000AD
 109 #define FSF_FCP_RSP_AVAILABLE                   0x000000AF
 110 #define FSF_UNKNOWN_COMMAND                     0x000000E2
 111 #define FSF_UNKNOWN_OP_SUBTYPE                  0x000000E3
 112 #define FSF_INVALID_COMMAND_OPTION              0x000000E5
 113 /* #define FSF_ERROR                             0x000000FF  */
 114
 115 #define FSF_STATUS_QUALIFIER_SIZE               16
 116
 117 /* FSF status qualifier, recommendations */
 118 #define FSF_SQ_NO_RECOM                         0x00
 119 #define FSF_SQ_FCP_RSP_AVAILABLE                0x01
 120 #define FSF_SQ_RETRY_IF_POSSIBLE                0x02
 121 #define FSF_SQ_ULP_DEPENDENT_ERP_REQUIRED       0x03
 122 #define FSF_SQ_INVOKE_LINK_TEST_PROCEDURE       0x04
 123 #define FSF_SQ_ULP_PROGRAMMING_ERROR            0x05
 124 #define FSF_SQ_COMMAND_ABORTED                  0x06
 125 #define FSF_SQ_NO_RETRY_POSSIBLE                0x07
 126
 127 /* FSF status qualifier for CFDC commands */
 128 #define FSF_SQ_CFDC_COULD_NOT_HARDEN_ON_SE      0x00000001
 129 #define FSF_SQ_CFDC_COULD_NOT_HARDEN_ON_SE2     0x00000002
 130 /* CFDC subtable codes */
 131 #define FSF_SQ_CFDC_SUBTABLE_OS                 0x0001
 132 #define FSF_SQ_CFDC_SUBTABLE_PORT_WWPN          0x0002
 133 #define FSF_SQ_CFDC_SUBTABLE_PORT_DID           0x0003
 134 #define FSF_SQ_CFDC_SUBTABLE_LUN                0x0004
 135
 136 /* FSF status qualifier (most significant 4 bytes), local link down */
 137 #define FSF_PSQ_LINK_NOLIGHT                    0x00000004
 138 #define FSF_PSQ_LINK_WRAPPLUG                   0x00000008
 139 #define FSF_PSQ_LINK_NOFCP                      0x00000010
 140
 141 /* payload size in status read buffer */
 142 #define FSF_STATUS_READ_PAYLOAD_SIZE            4032
 143
 144 /* number of status read buffers that should be sent by ULP */
 145 #define FSF_STATUS_READS_RECOM                  16
 146
 147 /* status types in status read buffer */
 148 #define FSF_STATUS_READ_PORT_CLOSED             0x00000001
 149 #define FSF_STATUS_READ_INCOMING_ELS            0x00000002
 150 #define FSF_STATUS_READ_BIT_ERROR_THRESHOLD     0x00000004
 151 #define FSF_STATUS_READ_LINK_DOWN               0x00000005 /* FIXME: really? */
 152 #define FSF_STATUS_READ_LINK_UP                 0x00000006
 153 #define FSF_STATUS_READ_CFDC_UPDATED            0x0000000A
 154 #define FSF_STATUS_READ_CFDC_HARDENED           0x0000000B
 155
 156 /* status subtypes in status read buffer */
 157 #define FSF_STATUS_READ_SUB_CLOSE_PHYS_PORT     0x00000001
 158 #define FSF_STATUS_READ_SUB_ERROR_PORT          0x00000002
 159
 160 /* status subtypes for CFDC */
 161 #define FSF_STATUS_READ_SUB_CFDC_HARDENED_ON_SE 0x00000002
 162 #define FSF_STATUS_READ_SUB_CFDC_HARDENED_ON_SE2 0x0000000F
 163
 164 /* topologie that is detected by the adapter */
 165 #define FSF_TOPO_ERROR                          0x00000000
 166 #define FSF_TOPO_P2P                            0x00000001
 167 #define FSF_TOPO_FABRIC                         0x00000002
 168 #define FSF_TOPO_AL                             0x00000003
 169 #define FSF_TOPO_FABRIC_VIRT                    0x00000004
 170
 171 /* data direction for FCP commands */
 172 #define FSF_DATADIR_WRITE                       0x00000001
 173 #define FSF_DATADIR_READ                        0x00000002
 174 #define FSF_DATADIR_READ_WRITE                  0x00000003
 175 #define FSF_DATADIR_CMND                        0x00000004
 176
 177 /* fc service class */
 178 #define FSF_CLASS_1                             0x00000001
 179 #define FSF_CLASS_2                             0x00000002
 180 #define FSF_CLASS_3                             0x00000003
 181
 182 /* SBAL chaining */
 183 #define FSF_MAX_SBALS_PER_REQ                   36
 184 #define FSF_MAX_SBALS_PER_ELS_REQ               2
 185
 186 /* logging space behind QTCB */
 187 #define FSF_QTCB_LOG_SIZE                       1024
 188
 189 /* channel features */
 190 #define FSF_FEATURE_QTCB_SUPPRESSION            0x00000001
 191 #define FSF_FEATURE_CFDC                        0x00000002
 192 #define FSF_FEATURE_HBAAPI_MANAGEMENT           0x00000010
 193 #define FSF_FEATURE_ELS_CT_CHAINED_SBALS        0x00000020
 194
 195 /* option */
 196 #define FSF_OPEN_LUN_SUPPRESS_BOXING            0x00000001
 197
 198 /* adapter types */
 199 #define FSF_ADAPTER_TYPE_FICON                  0x00000001
 200 #define FSF_ADAPTER_TYPE_FICON_EXPRESS          0x00000002
 201
 202 /* port types */
 203 #define FSF_HBA_PORTTYPE_UNKNOWN                0x00000001
 204 #define FSF_HBA_PORTTYPE_NOTPRESENT             0x00000003
 205 #define FSF_HBA_PORTTYPE_NPORT                  0x00000005
 206 #define FSF_HBA_PORTTYPE_PTP                    0x00000021
 207 /* following are not defined and used by FSF Spec
 208    but are additionally defined by FC-HBA */
 209 #define FSF_HBA_PORTTYPE_OTHER                  0x00000002
 210 #define FSF_HBA_PORTTYPE_NOTPRESENT             0x00000003
 211 #define FSF_HBA_PORTTYPE_NLPORT                 0x00000006
 212 #define FSF_HBA_PORTTYPE_FLPORT                 0x00000007
 213 #define FSF_HBA_PORTTYPE_FPORT                  0x00000008
 214 #define FSF_HBA_PORTTYPE_LPORT                  0x00000020
 215
 216 /* port states */
 217 #define FSF_HBA_PORTSTATE_UNKNOWN               0x00000001
 218 #define FSF_HBA_PORTSTATE_ONLINE                0x00000002
 219 #define FSF_HBA_PORTSTATE_OFFLINE               0x00000003
 220 #define FSF_HBA_PORTSTATE_LINKDOWN              0x00000006
 221 #define FSF_HBA_PORTSTATE_ERROR                 0x00000007
 222
 223 /* IO states of adapter */
 224 #define FSF_IOSTAT_NPORT_RJT                    0x00000004
 225 #define FSF_IOSTAT_FABRIC_RJT                   0x00000005
 226 #define FSF_IOSTAT_LS_RJT                       0x00000009
 227
 228 struct fsf_queue_designator;
 229 struct fsf_status_read_buffer;
 230 struct fsf_port_closed_payload;
 231 struct fsf_bit_error_payload;
 232 union  fsf_prot_status_qual;
 233 struct fsf_qual_version_error;
 234 struct fsf_qual_sequence_error;
 235 struct fsf_qtcb_prefix;
 236 struct fsf_qtcb_header;
 237 struct fsf_qtcb_bottom_config;
 238 struct fsf_qtcb_bottom_support;
 239 struct fsf_qtcb_bottom_io;
 240 union  fsf_qtcb_bottom;
 241
 242 struct fsf_queue_designator {
 243         u8  cssid;
 244         u8  chpid;
 245         u8  hla;
 246         u8  ua;
 247         u32 res1;
 248 } __attribute__ ((packed));
 249
 250 struct fsf_port_closed_payload {
 251         struct fsf_queue_designator queue_designator;
 252         u32                         port_handle;
 253 } __attribute__ ((packed));
 254
 255 struct fsf_bit_error_payload {
 256         u32 res1;
 257         u32 link_failure_error_count;
 258         u32 loss_of_sync_error_count;
 259         u32 loss_of_signal_error_count;
 260         u32 primitive_sequence_error_count;
 261         u32 invalid_transmission_word_error_count;
 262         u32 crc_error_count;
 263         u32 primitive_sequence_event_timeout_count;
 264         u32 elastic_buffer_overrun_error_count;
 265         u32 fcal_arbitration_timeout_count;
 266         u32 advertised_receive_b2b_credit;
 267         u32 current_receive_b2b_credit;
 268         u32 advertised_transmit_b2b_credit;
 269         u32 current_transmit_b2b_credit;
 270 } __attribute__ ((packed));
 271
 272 struct fsf_status_read_buffer {
 273         u32 status_type;
 274         u32 status_subtype;
 275         u32 length;
 276         u32 res1;
 277         struct fsf_queue_designator queue_designator;
 278         u32 d_id;
 279         u32 class;
 280         u64 fcp_lun;
 281         u8  res3[24];
 282         u8  payload[FSF_STATUS_READ_PAYLOAD_SIZE];
 283 } __attribute__ ((packed));
 284
 285 struct fsf_qual_version_error {
 286         u32 fsf_version;
 287         u32 res1[3];
 288 } __attribute__ ((packed));
 289
 290 struct fsf_qual_sequence_error {
 291         u32 exp_req_seq_no;
 292         u32 res1[3];
 293 } __attribute__ ((packed));
 294
 295 struct fsf_qual_locallink_error {
 296         u32 code;
 297         u32 res1[3];
 298 } __attribute__ ((packed));
 299
 300 union fsf_prot_status_qual {
 301         struct fsf_qual_version_error   version_error;
 302         struct fsf_qual_sequence_error  sequence_error;
 303         struct fsf_qual_locallink_error locallink_error;
 304 } __attribute__ ((packed));
 305
 306 struct fsf_qtcb_prefix {
 307         u64 req_id;
 308         u32 qtcb_version;
 309         u32 ulp_info;
 310         u32 qtcb_type;
 311         u32 req_seq_no;
 312         u32 prot_status;
 313         union fsf_prot_status_qual prot_status_qual;
 314         u8  res1[20];
 315 } __attribute__ ((packed));
 316
 317 union fsf_status_qual {
 318         u8  byte[FSF_STATUS_QUALIFIER_SIZE];
 319         u16 halfword[FSF_STATUS_QUALIFIER_SIZE / sizeof (u16)];
 320         u32 word[FSF_STATUS_QUALIFIER_SIZE / sizeof (u32)];
 321         struct fsf_queue_designator fsf_queue_designator;
 322 } __attribute__ ((packed));
 323
 324 struct fsf_qtcb_header {
 325         u64 req_handle;
 326         u32 fsf_command;
 327         u32 res1;
 328         u32 port_handle;
 329         u32 lun_handle;
 330         u32 res2;
 331         u32 fsf_status;
 332         union fsf_status_qual fsf_status_qual;
 333         u8  res3[28];
 334         u16 log_start;
 335         u16 log_length;
 336         u8  res4[16];
 337 } __attribute__ ((packed));
 338
 339 struct fsf_nport_serv_param {
 340         u8  common_serv_param[16];
 341         u64 wwpn;
 342         u64 wwnn;
 343         u8  class1_serv_param[16];
 344         u8  class2_serv_param[16];
 345         u8  class3_serv_param[16];
 346         u8  class4_serv_param[16];
 347         u8  vendor_version_level[16];
 348         u8  res1[16];
 349 } __attribute__ ((packed));
 350
 351 struct fsf_plogi {
 352         u32    code;
 353         struct fsf_nport_serv_param serv_param;
 354 } __attribute__ ((packed));
 355
 356 #define FSF_FCP_CMND_SIZE       288
 357 #define FSF_FCP_RSP_SIZE        128
 358
 359 struct fsf_qtcb_bottom_io {
 360         u32 data_direction;
 361         u32 service_class;
 362         u8  res1[8];
 363         u32 fcp_cmnd_length;
 364         u8  res2[12];
 365         u8  fcp_cmnd[FSF_FCP_CMND_SIZE];
 366         u8  fcp_rsp[FSF_FCP_RSP_SIZE];
 367         u8  res3[64];
 368 } __attribute__ ((packed));
 369
 370 struct fsf_qtcb_bottom_support {
 371         u32 operation_subtype;
 372         u8  res1[12];
 373         u32 d_id;
 374         u32 option;
 375         u64 fcp_lun;
 376         u64 res2;
 377         u64 req_handle;
 378         u32 service_class;
 379         u8  res3[3];
 380         u8  timeout;
 381         u8  res4[184];
 382         u32 els1_length;
 383         u32 els2_length;
 384         u32 req_buf_length;
 385         u32 resp_buf_length;
 386         u8  els[256];
 387 } __attribute__ ((packed));
 388
 389 struct fsf_qtcb_bottom_config {
 390         u32 lic_version;
 391         u32 feature_selection;
 392         u32 high_qtcb_version;
 393         u32 low_qtcb_version;
 394         u32 max_qtcb_size;
 395         u32 max_data_transfer_size;
 396         u32 supported_features;
 397         u8  res1[4];
 398         u32 fc_topology;
 399         u32 fc_link_speed;
 400         u32 adapter_type;
 401         u32 peer_d_id;
 402         u8 res2[12];
 403         u32 s_id;
 404         struct fsf_nport_serv_param nport_serv_param;
 405         u8 res3[8];
 406         u32 adapter_ports;
 407         u32 hardware_version;
 408         u8 serial_number[32];
 409         u8 res4[272];
 410 } __attribute__ ((packed));
 411
 412 struct fsf_qtcb_bottom_port {
 413         u8 res1[8];
 414         u32 fc_port_id;
 415         u32 port_type;
 416         u32 port_state;
 417         u32 class_of_service;   /* should be 0x00000006 for class 2 and 3 */
 418         u8 supported_fc4_types[32]; /* should be 0x00000100 for scsi fcp */
 419         u8 active_fc4_types[32];
 420         u32 supported_speed;    /* 0x0001 for 1 GBit/s or 0x0002 for 2 GBit/s */
 421         u32 maximum_frame_size; /* fixed value of 2112 */
 422         u64 seconds_since_last_reset;
 423         u64 tx_frames;
 424         u64 tx_words;
 425         u64 rx_frames;
 426         u64 rx_words;
 427         u64 lip;                /* 0 */
 428         u64 nos;                /* currently 0 */
 429         u64 error_frames;       /* currently 0 */
 430         u64 dumped_frames;      /* currently 0 */
 431         u64 link_failure;
 432         u64 loss_of_sync;
 433         u64 loss_of_signal;
 434         u64 psp_error_counts;
 435         u64 invalid_tx_words;
 436         u64 invalid_crcs;
 437         u64 input_requests;
 438         u64 output_requests;
 439         u64 control_requests;
 440         u64 input_mb;           /* where 1 MByte == 1.000.000 Bytes */
 441         u64 output_mb;          /* where 1 MByte == 1.000.000 Bytes */
 442         u8 res2[256];
 443 } __attribute__ ((packed));
 444
 445 union fsf_qtcb_bottom {
 446         struct fsf_qtcb_bottom_io      io;
 447         struct fsf_qtcb_bottom_support support;
 448         struct fsf_qtcb_bottom_config  config;
 449         struct fsf_qtcb_bottom_port port;
 450 };
 451
 452 struct fsf_qtcb {
 453         struct fsf_qtcb_prefix prefix;
 454         struct fsf_qtcb_header header;
 455         union  fsf_qtcb_bottom bottom;
 456         u8 log[FSF_QTCB_LOG_SIZE];
 457 } __attribute__ ((packed));
 458
 459 #endif                          /* FSF_H */