drivers/s390/scsi/zfcp_fsf.h

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