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