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