drivers/s390/scsi/zfcp_fsf.h

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