Back to home page

OSCL-LXR

 
 

    


0001 /*******************************************************************
0002  * This file is part of the Emulex Linux Device Driver for         *
0003  * Fibre Channel Host Bus Adapters.                                *
0004  * Copyright (C) 2017-2021 Broadcom. All Rights Reserved. The term *
0005  * “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.     *
0006  * Copyright (C) 2004-2013 Emulex.  All rights reserved.           *
0007  * EMULEX and SLI are trademarks of Emulex.                        *
0008  * www.broadcom.com                                                *
0009  *                                                                 *
0010  * This program is free software; you can redistribute it and/or   *
0011  * modify it under the terms of version 2 of the GNU General       *
0012  * Public License as published by the Free Software Foundation.    *
0013  * This program is distributed in the hope that it will be useful. *
0014  * ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND          *
0015  * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,  *
0016  * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT, ARE      *
0017  * DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD *
0018  * TO BE LEGALLY INVALID.  See the GNU General Public License for  *
0019  * more details, a copy of which can be found in the file COPYING  *
0020  * included with this package.                                     *
0021  *******************************************************************/
0022 
0023 #define FC_MAX_HOLD_RSCN     32       /* max number of deferred RSCNs */
0024 #define FC_MAX_NS_RSP        64512    /* max size NameServer rsp */
0025 #define FC_MAXLOOP           126      /* max devices supported on a fc loop */
0026 #define LPFC_DISC_FLOGI_TMO  10       /* Discovery FLOGI ratov */
0027 
0028 
0029 /* This is the protocol dependent definition for a Node List Entry.
0030  * This is used by Fibre Channel protocol to support FCP.
0031  */
0032 
0033 /* worker thread events */
0034 enum lpfc_work_type {
0035     LPFC_EVT_ONLINE,
0036     LPFC_EVT_OFFLINE_PREP,
0037     LPFC_EVT_OFFLINE,
0038     LPFC_EVT_WARM_START,
0039     LPFC_EVT_KILL,
0040     LPFC_EVT_ELS_RETRY,
0041     LPFC_EVT_DEV_LOSS,
0042     LPFC_EVT_FASTPATH_MGMT_EVT,
0043     LPFC_EVT_RESET_HBA,
0044     LPFC_EVT_RECOVER_PORT
0045 };
0046 
0047 /* structure used to queue event to the discovery tasklet */
0048 struct lpfc_work_evt {
0049     struct list_head      evt_listp;
0050     void                 *evt_arg1;
0051     void                 *evt_arg2;
0052     enum lpfc_work_type   evt;
0053 };
0054 
0055 struct lpfc_scsi_check_condition_event;
0056 struct lpfc_scsi_varqueuedepth_event;
0057 struct lpfc_scsi_event_header;
0058 struct lpfc_fabric_event_header;
0059 struct lpfc_fcprdchkerr_event;
0060 
0061 /* structure used for sending events from fast path */
0062 struct lpfc_fast_path_event {
0063     struct lpfc_work_evt work_evt;
0064     struct lpfc_vport     *vport;
0065     union {
0066         struct lpfc_scsi_check_condition_event check_cond_evt;
0067         struct lpfc_scsi_varqueuedepth_event queue_depth_evt;
0068         struct lpfc_scsi_event_header scsi_evt;
0069         struct lpfc_fabric_event_header fabric_evt;
0070         struct lpfc_fcprdchkerr_event read_check_error;
0071     } un;
0072 };
0073 
0074 #define LPFC_SLI4_MAX_XRI   1024    /* Used to make the ndlp's xri_bitmap */
0075 #define XRI_BITMAP_ULONGS (LPFC_SLI4_MAX_XRI / BITS_PER_LONG)
0076 struct lpfc_node_rrqs {
0077     unsigned long xri_bitmap[XRI_BITMAP_ULONGS];
0078 };
0079 
0080 enum lpfc_fc4_xpt_flags {
0081     NLP_XPT_REGD        = 0x1,
0082     SCSI_XPT_REGD       = 0x2,
0083     NVME_XPT_REGD       = 0x4,
0084     NVME_XPT_UNREG_WAIT = 0x8,
0085     NLP_XPT_HAS_HH      = 0x10
0086 };
0087 
0088 enum lpfc_nlp_save_flags {
0089     /* devloss occurred during recovery */
0090     NLP_IN_RECOV_POST_DEV_LOSS  = 0x1,
0091     /* wait for outstanding LOGO to cmpl */
0092     NLP_WAIT_FOR_LOGO       = 0x2,
0093 };
0094 
0095 struct lpfc_nodelist {
0096     struct list_head nlp_listp;
0097     struct serv_parm fc_sparam;     /* buffer for service params */
0098     struct lpfc_name nlp_portname;
0099     struct lpfc_name nlp_nodename;
0100 
0101     spinlock_t  lock;           /* Node management lock */
0102 
0103     uint32_t         nlp_flag;      /* entry flags */
0104     uint32_t         nlp_DID;       /* FC D_ID of entry */
0105     uint32_t         nlp_last_elscmd;   /* Last ELS cmd sent */
0106     uint16_t         nlp_type;
0107 #define NLP_FC_NODE        0x1          /* entry is an FC node */
0108 #define NLP_FABRIC         0x4          /* entry rep a Fabric entity */
0109 #define NLP_FCP_TARGET     0x8          /* entry is an FCP target */
0110 #define NLP_FCP_INITIATOR  0x10         /* entry is an FCP Initiator */
0111 #define NLP_NVME_TARGET    0x20         /* entry is a NVME Target */
0112 #define NLP_NVME_INITIATOR 0x40         /* entry is a NVME Initiator */
0113 #define NLP_NVME_DISCOVERY 0x80                 /* entry has NVME disc srvc */
0114 
0115     uint16_t    nlp_fc4_type;       /* FC types node supports. */
0116                         /* Assigned from GID_FF, only
0117                          * FCP (0x8) and NVME (0x28)
0118                          * supported.
0119                          */
0120 #define NLP_FC4_NONE    0x0
0121 #define NLP_FC4_FCP 0x1         /* FC4 Type FCP (value x8)) */
0122 #define NLP_FC4_NVME    0x2         /* FC4 TYPE NVME (value x28) */
0123 
0124     uint16_t        nlp_rpi;
0125     uint16_t        nlp_state;      /* state transition indicator */
0126     uint16_t        nlp_prev_state;     /* state transition indicator */
0127     uint16_t        nlp_xri;        /* output exchange id for RPI */
0128     uint16_t        nlp_sid;        /* scsi id */
0129 #define NLP_NO_SID      0xffff
0130     uint16_t    nlp_maxframe;       /* Max RCV frame size */
0131     uint8_t     nlp_class_sup;      /* Supported Classes */
0132     uint8_t         nlp_retry;      /* used for ELS retries */
0133     uint8_t         nlp_fcp_info;           /* class info, bits 0-3 */
0134 #define NLP_FCP_2_DEVICE   0x10         /* FCP-2 device */
0135     u8      nlp_nvme_info;          /* NVME NSLER Support */
0136     uint8_t     vmid_support;       /* destination VMID support */
0137 #define NLP_NVME_NSLER     0x1          /* NVME NSLER device */
0138 
0139     struct timer_list   nlp_delayfunc;  /* Used for delayed ELS cmds */
0140     struct lpfc_hba *phba;
0141     struct fc_rport *rport;     /* scsi_transport_fc port structure */
0142     struct lpfc_nvme_rport *nrport; /* nvme transport rport struct. */
0143     struct lpfc_vport *vport;
0144     struct lpfc_work_evt els_retry_evt;
0145     struct lpfc_work_evt dev_loss_evt;
0146     struct lpfc_work_evt recovery_evt;
0147     struct kref     kref;
0148     atomic_t cmd_pending;
0149     uint32_t cmd_qdepth;
0150     unsigned long last_change_time;
0151     unsigned long *active_rrqs_xri_bitmap;
0152     struct lpfc_scsicmd_bkt *lat_data;  /* Latency data */
0153     uint32_t fc4_prli_sent;
0154 
0155     /* flags to keep ndlp alive until special conditions are met */
0156     enum lpfc_nlp_save_flags save_flags;
0157 
0158     enum lpfc_fc4_xpt_flags fc4_xpt_flags;
0159 
0160     uint32_t nvme_fb_size; /* NVME target's supported byte cnt */
0161 #define NVME_FB_BIT_SHIFT 9    /* PRLI Rsp first burst in 512B units. */
0162     uint32_t nlp_defer_did;
0163     wait_queue_head_t *logo_waitq;
0164 };
0165 
0166 struct lpfc_node_rrq {
0167     struct list_head list;
0168     uint16_t xritag;
0169     uint16_t send_rrq;
0170     uint16_t rxid;
0171     uint32_t         nlp_DID;       /* FC D_ID of entry */
0172     struct lpfc_vport *vport;
0173     unsigned long rrq_stop_time;
0174 };
0175 
0176 #define lpfc_ndlp_check_qdepth(phba, ndlp) \
0177     (ndlp->cmd_qdepth < phba->sli4_hba.max_cfg_param.max_xri)
0178 
0179 /* Defines for nlp_flag (uint32) */
0180 #define NLP_IGNR_REG_CMPL  0x00000001 /* Rcvd rscn before we cmpl reg login */
0181 #define NLP_REG_LOGIN_SEND 0x00000002   /* sent reglogin to adapter */
0182 #define NLP_RELEASE_RPI    0x00000004   /* Release RPI to free pool */
0183 #define NLP_SUPPRESS_RSP   0x00000010   /* Remote NPort supports suppress rsp */
0184 #define NLP_PLOGI_SND      0x00000020   /* sent PLOGI request for this entry */
0185 #define NLP_PRLI_SND       0x00000040   /* sent PRLI request for this entry */
0186 #define NLP_ADISC_SND      0x00000080   /* sent ADISC request for this entry */
0187 #define NLP_LOGO_SND       0x00000100   /* sent LOGO request for this entry */
0188 #define NLP_RNID_SND       0x00000400   /* sent RNID request for this entry */
0189 #define NLP_ELS_SND_MASK   0x000007e0   /* sent ELS request for this entry */
0190 #define NLP_NVMET_RECOV    0x00001000   /* NVMET auditing node for recovery. */
0191 #define NLP_FCP_PRLI_RJT   0x00002000   /* Rport does not support FCP PRLI. */
0192 #define NLP_UNREG_INP      0x00008000   /* UNREG_RPI cmd is in progress */
0193 #define NLP_DROPPED        0x00010000   /* Init ref count has been dropped */
0194 #define NLP_DELAY_TMO      0x00020000   /* delay timeout is running for node */
0195 #define NLP_NPR_2B_DISC    0x00040000   /* node is included in num_disc_nodes */
0196 #define NLP_RCV_PLOGI      0x00080000   /* Rcv'ed PLOGI from remote system */
0197 #define NLP_LOGO_ACC       0x00100000   /* Process LOGO after ACC completes */
0198 #define NLP_TGT_NO_SCSIID  0x00200000   /* good PRLI but no binding for scsid */
0199 #define NLP_ISSUE_LOGO     0x00400000   /* waiting to issue a LOGO */
0200 #define NLP_IN_DEV_LOSS    0x00800000   /* devloss in progress */
0201 #define NLP_ACC_REGLOGIN   0x01000000   /* Issue Reg Login after successful
0202                        ACC */
0203 #define NLP_NPR_ADISC      0x02000000   /* Issue ADISC when dq'ed from
0204                        NPR list */
0205 #define NLP_RM_DFLT_RPI    0x04000000   /* need to remove leftover dflt RPI */
0206 #define NLP_NODEV_REMOVE   0x08000000   /* Defer removal till discovery ends */
0207 #define NLP_TARGET_REMOVE  0x10000000   /* Target remove in process */
0208 #define NLP_SC_REQ         0x20000000   /* Target requires authentication */
0209 #define NLP_FIRSTBURST     0x40000000   /* Target supports FirstBurst */
0210 #define NLP_RPI_REGISTERED 0x80000000   /* nlp_rpi is valid */
0211 
0212 /* There are 4 different double linked lists nodelist entries can reside on.
0213  * The Port Login (PLOGI) list and Address Discovery (ADISC) list are used
0214  * when Link Up discovery or Registered State Change Notification (RSCN)
0215  * processing is needed.  Each list holds the nodes that require a PLOGI or
0216  * ADISC Extended Link Service (ELS) request.  These lists keep track of the
0217  * nodes affected by an RSCN, or a Link Up (Typically, all nodes are effected
0218  * by Link Up) event.  The unmapped_list contains all nodes that have
0219  * successfully logged into at the Fibre Channel level.  The
0220  * mapped_list will contain all nodes that are mapped FCP targets.
0221  *
0222  * The bind list is a list of undiscovered (potentially non-existent) nodes
0223  * that we have saved binding information on. This information is used when
0224  * nodes transition from the unmapped to the mapped list.
0225  */
0226 
0227 /* Defines for nlp_state */
0228 #define NLP_STE_UNUSED_NODE       0x0   /* node is just allocated */
0229 #define NLP_STE_PLOGI_ISSUE       0x1   /* PLOGI was sent to NL_PORT */
0230 #define NLP_STE_ADISC_ISSUE       0x2   /* ADISC was sent to NL_PORT */
0231 #define NLP_STE_REG_LOGIN_ISSUE   0x3   /* REG_LOGIN was issued for NL_PORT */
0232 #define NLP_STE_PRLI_ISSUE        0x4   /* PRLI was sent to NL_PORT */
0233 #define NLP_STE_LOGO_ISSUE    0x5   /* LOGO was sent to NL_PORT */
0234 #define NLP_STE_UNMAPPED_NODE     0x6   /* PRLI completed from NL_PORT */
0235 #define NLP_STE_MAPPED_NODE       0x7   /* Identified as a FCP Target */
0236 #define NLP_STE_NPR_NODE          0x8   /* NPort disappeared */
0237 #define NLP_STE_MAX_STATE         0x9
0238 #define NLP_STE_FREED_NODE        0xff  /* node entry was freed to MEM_NLP */
0239 
0240 /* For UNUSED_NODE state, the node has just been allocated.
0241  * For PLOGI_ISSUE and REG_LOGIN_ISSUE, the node is on
0242  * the PLOGI list. For REG_LOGIN_COMPL, the node is taken off the PLOGI list
0243  * and put on the unmapped list. For ADISC processing, the node is taken off
0244  * the ADISC list and placed on either the mapped or unmapped list (depending
0245  * on its previous state). Once on the unmapped list, a PRLI is issued and the
0246  * state changed to PRLI_ISSUE. When the PRLI completion occurs, the state is
0247  * changed to PRLI_COMPL. If the completion indicates a mapped
0248  * node, the node is taken off the unmapped list. The binding list is checked
0249  * for a valid binding, or a binding is automatically assigned. If binding
0250  * assignment is unsuccessful, the node is left on the unmapped list. If
0251  * binding assignment is successful, the associated binding list entry (if
0252  * any) is removed, and the node is placed on the mapped list.
0253  */
0254 /*
0255  * For a Link Down, all nodes on the ADISC, PLOGI, unmapped or mapped
0256  * lists will receive a DEVICE_RECOVERY event. If the linkdown or devloss timers
0257  * expire, all effected nodes will receive a DEVICE_RM event.
0258  */
0259 /*
0260  * For a Link Up or RSCN, all nodes will move from the mapped / unmapped lists
0261  * to either the ADISC or PLOGI list.  After a Nameserver query or ALPA loopmap
0262  * check, additional nodes may be added (DEVICE_ADD) or removed (DEVICE_RM) to /
0263  * from the PLOGI or ADISC lists. Once the PLOGI and ADISC lists are populated,
0264  * we will first process the ADISC list.  32 entries are processed initially and
0265  * ADISC is initited for each one.  Completions / Events for each node are
0266  * funnelled thru the state machine.  As each node finishes ADISC processing, it
0267  * starts ADISC for any nodes waiting for ADISC processing. If no nodes are
0268  * waiting, and the ADISC list count is identically 0, then we are done. For
0269  * Link Up discovery, since all nodes on the PLOGI list are UNREG_LOGIN'ed, we
0270  * can issue a CLEAR_LA and reenable Link Events. Next we will process the PLOGI
0271  * list.  32 entries are processed initially and PLOGI is initited for each one.
0272  * Completions / Events for each node are funnelled thru the state machine.  As
0273  * each node finishes PLOGI processing, it starts PLOGI for any nodes waiting
0274  * for PLOGI processing. If no nodes are waiting, and the PLOGI list count is
0275  * identically 0, then we are done. We have now completed discovery / RSCN
0276  * handling. Upon completion, ALL nodes should be on either the mapped or
0277  * unmapped lists.
0278  */
0279 
0280 /* Defines for Node List Entry Events that could happen */
0281 #define NLP_EVT_RCV_PLOGI         0x0   /* Rcv'd an ELS PLOGI command */
0282 #define NLP_EVT_RCV_PRLI          0x1   /* Rcv'd an ELS PRLI  command */
0283 #define NLP_EVT_RCV_LOGO          0x2   /* Rcv'd an ELS LOGO  command */
0284 #define NLP_EVT_RCV_ADISC         0x3   /* Rcv'd an ELS ADISC command */
0285 #define NLP_EVT_RCV_PDISC         0x4   /* Rcv'd an ELS PDISC command */
0286 #define NLP_EVT_RCV_PRLO          0x5   /* Rcv'd an ELS PRLO  command */
0287 #define NLP_EVT_CMPL_PLOGI        0x6   /* Sent an ELS PLOGI command */
0288 #define NLP_EVT_CMPL_PRLI         0x7   /* Sent an ELS PRLI  command */
0289 #define NLP_EVT_CMPL_LOGO         0x8   /* Sent an ELS LOGO  command */
0290 #define NLP_EVT_CMPL_ADISC        0x9   /* Sent an ELS ADISC command */
0291 #define NLP_EVT_CMPL_REG_LOGIN    0xa   /* REG_LOGIN mbox cmd completed */
0292 #define NLP_EVT_DEVICE_RM         0xb   /* Device not found in NS / ALPAmap */
0293 #define NLP_EVT_DEVICE_RECOVERY   0xc   /* Device existence unknown */
0294 #define NLP_EVT_MAX_EVENT         0xd
0295 #define NLP_EVT_NOTHING_PENDING   0xff