drivers/scsi/lpfc/lpfc_sli.h

   1 /*******************************************************************
   2  * This file is part of the Emulex Linux Device Driver for         *
   3  * Fibre Channel Host Bus Adapters.                                *
   4  * Copyright (C) 2017-2021 Broadcom. All Rights Reserved. The term *
   5  * “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.     *
   6  * Copyright (C) 2004-2016 Emulex.  All rights reserved.           *
   7  * EMULEX and SLI are trademarks of Emulex.                        *
   8  * www.broadcom.com                                                *
   9  *                                                                 *
  10  * This program is free software; you can redistribute it and/or   *
  11  * modify it under the terms of version 2 of the GNU General       *
  12  * Public License as published by the Free Software Foundation.    *
  13  * This program is distributed in the hope that it will be useful. *
  14  * ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND          *
  15  * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,  *
  16  * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT, ARE      *
  17  * DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD *
  18  * TO BE LEGALLY INVALID.  See the GNU General Public License for  *
  19  * more details, a copy of which can be found in the file COPYING  *
  20  * included with this package.                                     *
  21  *******************************************************************/
  22
  23 #if defined(CONFIG_DEBUG_FS) && !defined(CONFIG_SCSI_LPFC_DEBUG_FS)
  24 #define CONFIG_SCSI_LPFC_DEBUG_FS
  25 #endif
  26
  27 /* forward declaration for LPFC_IOCB_t's use */
  28 struct lpfc_hba;
  29 struct lpfc_vport;
  30
  31 /* Define the context types that SLI handles for abort and sums. */
  32 typedef enum _lpfc_ctx_cmd {
  33         LPFC_CTX_LUN,
  34         LPFC_CTX_TGT,
  35         LPFC_CTX_HOST
  36 } lpfc_ctx_cmd;
  37
  38 union lpfc_vmid_iocb_tag {
  39         uint32_t app_id;
  40         uint8_t cs_ctl_vmid;
  41         struct lpfc_vmid_context *vmid_context; /* UVEM context information */
  42 };
  43
  44 struct lpfc_cq_event {
  45         struct list_head list;
  46         uint16_t hdwq;
  47         union {
  48                 struct lpfc_mcqe                mcqe_cmpl;
  49                 struct lpfc_acqe_link           acqe_link;
  50                 struct lpfc_acqe_fip            acqe_fip;
  51                 struct lpfc_acqe_dcbx           acqe_dcbx;
  52                 struct lpfc_acqe_grp5           acqe_grp5;
  53                 struct lpfc_acqe_fc_la          acqe_fc;
  54                 struct lpfc_acqe_sli            acqe_sli;
  55                 struct lpfc_rcqe                rcqe_cmpl;
  56                 struct sli4_wcqe_xri_aborted    wcqe_axri;
  57                 struct lpfc_wcqe_complete       wcqe_cmpl;
  58         } cqe;
  59 };
  60
  61 /* This structure is used to handle IOCB requests / responses */
  62 struct lpfc_iocbq {
  63         /* lpfc_iocbqs are used in double linked lists */
  64         struct list_head list;
  65         struct list_head clist;
  66         struct list_head dlist;
  67         uint16_t iotag;         /* pre-assigned IO tag */
  68         uint16_t sli4_lxritag;  /* logical pre-assigned XRI. */
  69         uint16_t sli4_xritag;   /* pre-assigned XRI, (OXID) tag. */
  70         uint16_t hba_wqidx;     /* index to HBA work queue */
  71         struct lpfc_cq_event cq_event;
  72         struct lpfc_wcqe_complete wcqe_cmpl;    /* WQE cmpl */
  73         uint64_t isr_timestamp;
  74
  75         union lpfc_wqe128 wqe;  /* SLI-4 */
  76         IOCB_t iocb;            /* SLI-3 */
  77
  78         uint8_t rsvd2;
  79         uint8_t priority;       /* OAS priority */
  80         uint8_t retry;          /* retry counter for IOCB cmd - if needed */
  81         uint32_t iocb_flag;
  82 #define LPFC_IO_LIBDFC          1       /* libdfc iocb */
  83 #define LPFC_IO_WAKE            2       /* Synchronous I/O completed */
  84 #define LPFC_IO_WAKE_TMO        LPFC_IO_WAKE /* Synchronous I/O timed out */
  85 #define LPFC_IO_FCP             4       /* FCP command -- iocbq in scsi_buf */
  86 #define LPFC_DRIVER_ABORTED     8       /* driver aborted this request */
  87 #define LPFC_IO_FABRIC          0x10    /* Iocb send using fabric scheduler */
  88 #define LPFC_DELAY_MEM_FREE     0x20    /* Defer free'ing of FC data */
  89 #define LPFC_EXCHANGE_BUSY      0x40    /* SLI4 hba reported XB in response */
  90 #define LPFC_USE_FCPWQIDX       0x80    /* Submit to specified FCPWQ index */
  91 #define DSS_SECURITY_OP         0x100   /* security IO */
  92 #define LPFC_IO_ON_TXCMPLQ      0x200   /* The IO is still on the TXCMPLQ */
  93 #define LPFC_IO_DIF_PASS        0x400   /* T10 DIF IO pass-thru prot */
  94 #define LPFC_IO_DIF_STRIP       0x800   /* T10 DIF IO strip prot */
  95 #define LPFC_IO_DIF_INSERT      0x1000  /* T10 DIF IO insert prot */
  96 #define LPFC_IO_CMD_OUTSTANDING 0x2000 /* timeout handler abort window */
  97
  98 #define LPFC_FIP_ELS_ID_MASK    0xc000  /* ELS_ID range 0-3, non-shifted mask */
  99 #define LPFC_FIP_ELS_ID_SHIFT   14
 100
 101 #define LPFC_IO_OAS             0x10000 /* OAS FCP IO */
 102 #define LPFC_IO_FOF             0x20000 /* FOF FCP IO */
 103 #define LPFC_IO_LOOPBACK        0x40000 /* Loopback IO */
 104 #define LPFC_PRLI_NVME_REQ      0x80000 /* This is an NVME PRLI. */
 105 #define LPFC_PRLI_FCP_REQ       0x100000 /* This is an NVME PRLI. */
 106 #define LPFC_IO_NVME            0x200000 /* NVME FCP command */
 107 #define LPFC_IO_NVME_LS         0x400000 /* NVME LS command */
 108 #define LPFC_IO_NVMET           0x800000 /* NVMET command */
 109 #define LPFC_IO_VMID            0x1000000 /* VMID tagged IO */
 110
 111         uint32_t drvrTimeout;   /* driver timeout in seconds */
 112         struct lpfc_vport *vport;/* virtual port pointer */
 113         void *context1;         /* caller context information */
 114         void *context2;         /* caller context information */
 115         void *context3;         /* caller context information */
 116         uint32_t event_tag;     /* LA Event tag */
 117         union {
 118                 wait_queue_head_t    *wait_queue;
 119                 struct lpfc_iocbq    *rsp_iocb;
 120                 struct lpfcMboxq     *mbox;
 121                 struct lpfc_nodelist *ndlp;
 122                 struct lpfc_node_rrq *rrq;
 123         } context_un;
 124
 125         union lpfc_vmid_iocb_tag vmid_tag;
 126         void (*fabric_iocb_cmpl)(struct lpfc_hba *, struct lpfc_iocbq *,
 127                            struct lpfc_iocbq *);
 128         void (*wait_iocb_cmpl)(struct lpfc_hba *, struct lpfc_iocbq *,
 129                            struct lpfc_iocbq *);
 130         void (*iocb_cmpl)(struct lpfc_hba *, struct lpfc_iocbq *,
 131                            struct lpfc_iocbq *);
 132         void (*wqe_cmpl)(struct lpfc_hba *, struct lpfc_iocbq *,
 133                           struct lpfc_wcqe_complete *);
 134 };
 135
 136 #define SLI_IOCB_RET_IOCB      1        /* Return IOCB if cmd ring full */
 137
 138 #define IOCB_SUCCESS        0
 139 #define IOCB_BUSY           1
 140 #define IOCB_ERROR          2
 141 #define IOCB_TIMEDOUT       3
 142 #define IOCB_ABORTED        4
 143 #define IOCB_ABORTING       5
 144 #define IOCB_NORESOURCE     6
 145
 146 #define SLI_WQE_RET_WQE    1    /* Return WQE if cmd ring full */
 147
 148 #define WQE_SUCCESS        0
 149 #define WQE_BUSY           1
 150 #define WQE_ERROR          2
 151 #define WQE_TIMEDOUT       3
 152 #define WQE_ABORTED        4
 153 #define WQE_ABORTING       5
 154 #define WQE_NORESOURCE     6
 155
 156 #define LPFC_MBX_WAKE           1
 157 #define LPFC_MBX_IMED_UNREG     2
 158
 159 typedef struct lpfcMboxq {
 160         /* MBOXQs are used in single linked lists */
 161         struct list_head list;  /* ptr to next mailbox command */
 162         union {
 163                 MAILBOX_t mb;           /* Mailbox cmd */
 164                 struct lpfc_mqe mqe;
 165         } u;
 166         struct lpfc_vport *vport; /* virtual port pointer */
 167         void *ctx_ndlp;           /* caller ndlp information */
 168         void *ctx_buf;            /* caller buffer information */
 169         void *context3;
 170
 171         void (*mbox_cmpl) (struct lpfc_hba *, struct lpfcMboxq *);
 172         uint8_t mbox_flag;
 173         uint16_t in_ext_byte_len;
 174         uint16_t out_ext_byte_len;
 175         uint8_t  mbox_offset_word;
 176         struct lpfc_mcqe mcqe;
 177         struct lpfc_mbx_nembed_sge_virt *sge_array;
 178 } LPFC_MBOXQ_t;
 179
 180 #define MBX_POLL        1       /* poll mailbox till command done, then
 181                                    return */
 182 #define MBX_NOWAIT      2       /* issue command then return immediately */
 183
 184 #define LPFC_MAX_RING_MASK  5   /* max num of rctl/type masks allowed per
 185                                    ring */
 186 #define LPFC_SLI3_MAX_RING  4   /* Max num of SLI3 rings used by driver.
 187                                    For SLI4, an additional ring for each
 188                                    FCP WQ will be allocated.  */
 189
 190 struct lpfc_sli_ring;
 191
 192 struct lpfc_sli_ring_mask {
 193         uint8_t profile;        /* profile associated with ring */
 194         uint8_t rctl;   /* rctl / type pair configured for ring */
 195         uint8_t type;   /* rctl / type pair configured for ring */
 196         uint8_t rsvd;
 197         /* rcv'd unsol event */
 198         void (*lpfc_sli_rcv_unsol_event) (struct lpfc_hba *,
 199                                          struct lpfc_sli_ring *,
 200                                          struct lpfc_iocbq *);
 201 };
 202
 203
 204 /* Structure used to hold SLI statistical counters and info */
 205 struct lpfc_sli_ring_stat {
 206         uint64_t iocb_event;     /* IOCB event counters */
 207         uint64_t iocb_cmd;       /* IOCB cmd issued */
 208         uint64_t iocb_rsp;       /* IOCB rsp received */
 209         uint64_t iocb_cmd_delay; /* IOCB cmd ring delay */
 210         uint64_t iocb_cmd_full;  /* IOCB cmd ring full */
 211         uint64_t iocb_cmd_empty; /* IOCB cmd ring is now empty */
 212         uint64_t iocb_rsp_full;  /* IOCB rsp ring full */
 213 };
 214
 215 struct lpfc_sli3_ring {
 216         uint32_t local_getidx;  /* last available cmd index (from cmdGetInx) */
 217         uint32_t next_cmdidx;   /* next_cmd index */
 218         uint32_t rspidx;        /* current index in response ring */
 219         uint32_t cmdidx;        /* current index in command ring */
 220         uint16_t numCiocb;      /* number of command iocb's per ring */
 221         uint16_t numRiocb;      /* number of rsp iocb's per ring */
 222         uint16_t sizeCiocb;     /* Size of command iocb's in this ring */
 223         uint16_t sizeRiocb;     /* Size of response iocb's in this ring */
 224         uint32_t *cmdringaddr;  /* virtual address for cmd rings */
 225         uint32_t *rspringaddr;  /* virtual address for rsp rings */
 226 };
 227
 228 struct lpfc_sli4_ring {
 229         struct lpfc_queue *wqp; /* Pointer to associated WQ */
 230 };
 231
 232
 233 /* Structure used to hold SLI ring information */
 234 struct lpfc_sli_ring {
 235         uint16_t flag;          /* ring flags */
 236 #define LPFC_DEFERRED_RING_EVENT 0x001  /* Deferred processing a ring event */
 237 #define LPFC_CALL_RING_AVAILABLE 0x002  /* indicates cmd was full */
 238 #define LPFC_STOP_IOCB_EVENT     0x020  /* Stop processing IOCB cmds event */
 239         uint16_t abtsiotag;     /* tracks next iotag to use for ABTS */
 240
 241         uint8_t rsvd;
 242         uint8_t ringno;         /* ring number */
 243
 244         spinlock_t ring_lock;   /* lock for issuing commands */
 245
 246         uint32_t fast_iotag;    /* max fastlookup based iotag           */
 247         uint32_t iotag_ctr;     /* keeps track of the next iotag to use */
 248         uint32_t iotag_max;     /* max iotag value to use               */
 249         struct list_head txq;
 250         uint16_t txq_cnt;       /* current length of queue */
 251         uint16_t txq_max;       /* max length */
 252         struct list_head txcmplq;
 253         uint16_t txcmplq_cnt;   /* current length of queue */
 254         uint16_t txcmplq_max;   /* max length */
 255         uint32_t missbufcnt;    /* keep track of buffers to post */
 256         struct list_head postbufq;
 257         uint16_t postbufq_cnt;  /* current length of queue */
 258         uint16_t postbufq_max;  /* max length */
 259         struct list_head iocb_continueq;
 260         uint16_t iocb_continueq_cnt;    /* current length of queue */
 261         uint16_t iocb_continueq_max;    /* max length */
 262         struct list_head iocb_continue_saveq;
 263
 264         struct lpfc_sli_ring_mask prt[LPFC_MAX_RING_MASK];
 265         uint32_t num_mask;      /* number of mask entries in prt array */
 266         void (*lpfc_sli_rcv_async_status) (struct lpfc_hba *,
 267                 struct lpfc_sli_ring *, struct lpfc_iocbq *);
 268
 269         struct lpfc_sli_ring_stat stats;        /* SLI statistical info */
 270
 271         /* cmd ring available */
 272         void (*lpfc_sli_cmd_available) (struct lpfc_hba *,
 273                                         struct lpfc_sli_ring *);
 274         union {
 275                 struct lpfc_sli3_ring sli3;
 276                 struct lpfc_sli4_ring sli4;
 277         } sli;
 278 };
 279
 280 /* Structure used for configuring rings to a specific profile or rctl / type */
 281 struct lpfc_hbq_init {
 282         uint32_t rn;            /* Receive buffer notification */
 283         uint32_t entry_count;   /* max # of entries in HBQ */
 284         uint32_t headerLen;     /* 0 if not profile 4 or 5 */
 285         uint32_t logEntry;      /* Set to 1 if this HBQ used for LogEntry */
 286         uint32_t profile;       /* Selection profile 0=all, 7=logentry */
 287         uint32_t ring_mask;     /* Binds HBQ to a ring e.g. Ring0=b0001,
 288                                  * ring2=b0100 */
 289         uint32_t hbq_index;     /* index of this hbq in ring .HBQs[] */
 290
 291         uint32_t seqlenoff;
 292         uint32_t maxlen;
 293         uint32_t seqlenbcnt;
 294         uint32_t cmdcodeoff;
 295         uint32_t cmdmatch[8];
 296         uint32_t mask_count;    /* number of mask entries in prt array */
 297         struct hbq_mask hbqMasks[6];
 298
 299         /* Non-config rings fields to keep track of buffer allocations */
 300         uint32_t buffer_count;  /* number of buffers allocated */
 301         uint32_t init_count;    /* number to allocate when initialized */
 302         uint32_t add_count;     /* number to allocate when starved */
 303 } ;
 304
 305 /* Structure used to hold SLI statistical counters and info */
 306 struct lpfc_sli_stat {
 307         uint64_t mbox_stat_err;  /* Mbox cmds completed status error */
 308         uint64_t mbox_cmd;       /* Mailbox commands issued */
 309         uint64_t sli_intr;       /* Count of Host Attention interrupts */
 310         uint64_t sli_prev_intr;  /* Previous cnt of Host Attention interrupts */
 311         uint64_t sli_ips;        /* Host Attention interrupts per sec */
 312         uint32_t err_attn_event; /* Error Attn event counters */
 313         uint32_t link_event;     /* Link event counters */
 314         uint32_t mbox_event;     /* Mailbox event counters */
 315         uint32_t mbox_busy;      /* Mailbox cmd busy */
 316 };
 317
 318 /* Structure to store link status values when port stats are reset */
 319 struct lpfc_lnk_stat {
 320         uint32_t link_failure_count;
 321         uint32_t loss_of_sync_count;
 322         uint32_t loss_of_signal_count;
 323         uint32_t prim_seq_protocol_err_count;
 324         uint32_t invalid_tx_word_count;
 325         uint32_t invalid_crc_count;
 326         uint32_t error_frames;
 327         uint32_t link_events;
 328 };
 329
 330 /* Structure used to hold SLI information */
 331 struct lpfc_sli {
 332         uint32_t num_rings;
 333         uint32_t sli_flag;
 334
 335         /* Additional sli_flags */
 336 #define LPFC_SLI_MBOX_ACTIVE      0x100 /* HBA mailbox is currently active */
 337 #define LPFC_SLI_ACTIVE           0x200 /* SLI in firmware is active */
 338 #define LPFC_PROCESS_LA           0x400 /* Able to process link attention */
 339 #define LPFC_BLOCK_MGMT_IO        0x800 /* Don't allow mgmt mbx or iocb cmds */
 340 #define LPFC_MENLO_MAINT          0x1000 /* need for menl fw download */
 341 #define LPFC_SLI_ASYNC_MBX_BLK    0x2000 /* Async mailbox is blocked */
 342 #define LPFC_SLI_SUPPRESS_RSP     0x4000 /* Suppress RSP feature is supported */
 343 #define LPFC_SLI_USE_EQDR         0x8000 /* EQ Delay Register is supported */
 344 #define LPFC_QUEUE_FREE_INIT      0x10000 /* Queue freeing is in progress */
 345 #define LPFC_QUEUE_FREE_WAIT      0x20000 /* Hold Queue free as it is being
 346                                            * used outside worker thread
 347                                            */
 348
 349         struct lpfc_sli_ring *sli3_ring;
 350
 351         struct lpfc_sli_stat slistat;   /* SLI statistical info */
 352         struct list_head mboxq;
 353         uint16_t mboxq_cnt;     /* current length of queue */
 354         uint16_t mboxq_max;     /* max length */
 355         LPFC_MBOXQ_t *mbox_active;      /* active mboxq information */
 356         struct list_head mboxq_cmpl;
 357
 358         struct timer_list mbox_tmo;     /* Hold clk to timeout active mbox
 359                                            cmd */
 360
 361 #define LPFC_IOCBQ_LOOKUP_INCREMENT  1024
 362         struct lpfc_iocbq ** iocbq_lookup; /* array to lookup IOCB by IOTAG */
 363         size_t iocbq_lookup_len;           /* current lengs of the array */
 364         uint16_t  last_iotag;              /* last allocated IOTAG */
 365         time64_t  stats_start;             /* in seconds */
 366         struct lpfc_lnk_stat lnk_stat_offsets;
 367 };
 368
 369 /* Timeout for normal outstanding mbox command (Seconds) */
 370 #define LPFC_MBOX_TMO                           30
 371 /* Timeout for non-flash-based outstanding sli_config mbox command (Seconds) */
 372 #define LPFC_MBOX_SLI4_CONFIG_TMO               60
 373 /* Timeout for flash-based outstanding sli_config mbox command (Seconds) */
 374 #define LPFC_MBOX_SLI4_CONFIG_EXTENDED_TMO      300
 375 /* Timeout for other flash-based outstanding mbox command (Seconds) */
 376 #define LPFC_MBOX_TMO_FLASH_CMD                 300
 377
 378 struct lpfc_io_buf {
 379         /* Common fields */
 380         struct list_head list;
 381         void *data;
 382
 383         dma_addr_t dma_handle;
 384         dma_addr_t dma_phys_sgl;
 385
 386         struct sli4_sge *dma_sgl; /* initial segment chunk */
 387
 388         /* linked list of extra sli4_hybrid_sge */
 389         struct list_head dma_sgl_xtra_list;
 390
 391         /* list head for fcp_cmd_rsp buf */
 392         struct list_head dma_cmd_rsp_list;
 393
 394         struct lpfc_iocbq cur_iocbq;
 395         struct lpfc_sli4_hdw_queue *hdwq;
 396         uint16_t hdwq_no;
 397         uint16_t cpu;
 398
 399         struct lpfc_nodelist *ndlp;
 400         uint32_t timeout;
 401         uint16_t flags;
 402 #define LPFC_SBUF_XBUSY         0x1     /* SLI4 hba reported XB on WCQE cmpl */
 403 #define LPFC_SBUF_BUMP_QDEPTH   0x2     /* bumped queue depth counter */
 404                                         /* External DIF device IO conversions */
 405 #define LPFC_SBUF_NORMAL_DIF    0x4     /* normal mode to insert/strip */
 406 #define LPFC_SBUF_PASS_DIF      0x8     /* insert/strip mode to passthru */
 407 #define LPFC_SBUF_NOT_POSTED    0x10    /* SGL failed post to FW. */
 408         uint16_t status;        /* From IOCB Word 7- ulpStatus */
 409         uint32_t result;        /* From IOCB Word 4. */
 410
 411         uint32_t   seg_cnt;     /* Number of scatter-gather segments returned by
 412                                  * dma_map_sg.  The driver needs this for calls
 413                                  * to dma_unmap_sg.
 414                                  */
 415         unsigned long start_time;
 416         spinlock_t buf_lock;    /* lock used in case of simultaneous abort */
 417         bool expedite;          /* this is an expedite io_buf */
 418
 419         union {
 420                 /* SCSI specific fields */
 421                 struct {
 422                         struct scsi_cmnd *pCmd;
 423                         struct lpfc_rport_data *rdata;
 424                         uint32_t prot_seg_cnt;  /* seg_cnt's counterpart for
 425                                                  * protection data
 426                                                  */
 427
 428                         /*
 429                          * data and dma_handle are the kernel virtual and bus
 430                          * address of the dma-able buffer containing the
 431                          * fcp_cmd, fcp_rsp and a scatter gather bde list that
 432                          * supports the sg_tablesize value.
 433                          */
 434                         struct fcp_cmnd *fcp_cmnd;
 435                         struct fcp_rsp *fcp_rsp;
 436
 437                         wait_queue_head_t *waitq;
 438
 439 #ifdef CONFIG_SCSI_LPFC_DEBUG_FS
 440                         /* Used to restore any changes to protection data for
 441                          * error injection
 442                          */
 443                         void *prot_data_segment;
 444                         uint32_t prot_data;
 445                         uint32_t prot_data_type;
 446 #define LPFC_INJERR_REFTAG      1
 447 #define LPFC_INJERR_APPTAG      2
 448 #define LPFC_INJERR_GUARD       3
 449 #endif
 450                 };
 451
 452                 /* NVME specific fields */
 453                 struct {
 454                         struct nvmefc_fcp_req *nvmeCmd;
 455                         uint16_t qidx;
 456                 };
 457         };
 458 #ifdef CONFIG_SCSI_LPFC_DEBUG_FS
 459         uint64_t ts_cmd_start;
 460         uint64_t ts_last_cmd;
 461         uint64_t ts_cmd_wqput;
 462         uint64_t ts_isr_cmpl;
 463         uint64_t ts_data_io;
 464 #endif
 465 };