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-2013 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#define FC_MAX_HOLD_RSCN 32 /* max number of deferred RSCNs */ 24#define FC_MAX_NS_RSP 64512 /* max size NameServer rsp */ 25#define FC_MAXLOOP 126 /* max devices supported on a fc loop */ 26#define LPFC_DISC_FLOGI_TMO 10 /* Discovery FLOGI ratov */ 27 28 29/* This is the protocol dependent definition for a Node List Entry. 30 * This is used by Fibre Channel protocol to support FCP. 31 */ 32 33/* worker thread events */ 34enum lpfc_work_type { 35 LPFC_EVT_ONLINE, 36 LPFC_EVT_OFFLINE_PREP, 37 LPFC_EVT_OFFLINE, 38 LPFC_EVT_WARM_START, 39 LPFC_EVT_KILL, 40 LPFC_EVT_ELS_RETRY, 41 LPFC_EVT_DEV_LOSS, 42 LPFC_EVT_FASTPATH_MGMT_EVT, 43 LPFC_EVT_RESET_HBA, 44 LPFC_EVT_RECOVER_PORT 45}; 46 47/* structure used to queue event to the discovery tasklet */ 48struct lpfc_work_evt { 49 struct list_head evt_listp; 50 void *evt_arg1; 51 void *evt_arg2; 52 enum lpfc_work_type evt; 53}; 54 55struct lpfc_scsi_check_condition_event; 56struct lpfc_scsi_varqueuedepth_event; 57struct lpfc_scsi_event_header; 58struct lpfc_fabric_event_header; 59struct lpfc_fcprdchkerr_event; 60 61/* structure used for sending events from fast path */ 62struct lpfc_fast_path_event { 63 struct lpfc_work_evt work_evt; 64 struct lpfc_vport *vport; 65 union { 66 struct lpfc_scsi_check_condition_event check_cond_evt; 67 struct lpfc_scsi_varqueuedepth_event queue_depth_evt; 68 struct lpfc_scsi_event_header scsi_evt; 69 struct lpfc_fabric_event_header fabric_evt; 70 struct lpfc_fcprdchkerr_event read_check_error; 71 } un; 72}; 73 74#define LPFC_SLI4_MAX_XRI 1024 /* Used to make the ndlp's xri_bitmap */ 75#define XRI_BITMAP_ULONGS (LPFC_SLI4_MAX_XRI / BITS_PER_LONG) 76struct lpfc_node_rrqs { 77 unsigned long xri_bitmap[XRI_BITMAP_ULONGS]; 78}; 79 80enum lpfc_fc4_xpt_flags { 81 NLP_XPT_REGD = 0x1, 82 SCSI_XPT_REGD = 0x2, 83 NVME_XPT_REGD = 0x4, 84 NVME_XPT_UNREG_WAIT = 0x8, 85 NLP_XPT_HAS_HH = 0x10 86}; 87 88struct lpfc_nodelist { 89 struct list_head nlp_listp; 90 struct serv_parm fc_sparam; /* buffer for service params */ 91 struct lpfc_name nlp_portname; 92 struct lpfc_name nlp_nodename; 93 94 spinlock_t lock; /* Node management lock */ 95 96 uint32_t nlp_flag; /* entry flags */ 97 uint32_t nlp_DID; /* FC D_ID of entry */ 98 uint32_t nlp_last_elscmd; /* Last ELS cmd sent */ 99 uint16_t nlp_type; 100#define NLP_FC_NODE 0x1 /* entry is an FC node */ 101#define NLP_FABRIC 0x4 /* entry rep a Fabric entity */ 102#define NLP_FCP_TARGET 0x8 /* entry is an FCP target */ 103#define NLP_FCP_INITIATOR 0x10 /* entry is an FCP Initiator */ 104#define NLP_NVME_TARGET 0x20 /* entry is a NVME Target */ 105#define NLP_NVME_INITIATOR 0x40 /* entry is a NVME Initiator */ 106#define NLP_NVME_DISCOVERY 0x80 /* entry has NVME disc srvc */ 107 108 uint16_t nlp_fc4_type; /* FC types node supports. */ 109 /* Assigned from GID_FF, only 110 * FCP (0x8) and NVME (0x28) 111 * supported. 112 */ 113#define NLP_FC4_NONE 0x0 114#define NLP_FC4_FCP 0x1 /* FC4 Type FCP (value x8)) */ 115#define NLP_FC4_NVME 0x2 /* FC4 TYPE NVME (value x28) */ 116 117 uint16_t nlp_rpi; 118 uint16_t nlp_state; /* state transition indicator */ 119 uint16_t nlp_prev_state; /* state transition indicator */ 120 uint16_t nlp_xri; /* output exchange id for RPI */ 121 uint16_t nlp_sid; /* scsi id */ 122#define NLP_NO_SID 0xffff 123 uint16_t nlp_maxframe; /* Max RCV frame size */ 124 uint8_t nlp_class_sup; /* Supported Classes */ 125 uint8_t nlp_retry; /* used for ELS retries */ 126 uint8_t nlp_fcp_info; /* class info, bits 0-3 */ 127#define NLP_FCP_2_DEVICE 0x10 /* FCP-2 device */ 128 u8 nlp_nvme_info; /* NVME NSLER Support */ 129 uint8_t vmid_support; /* destination VMID support */ 130#define NLP_NVME_NSLER 0x1 /* NVME NSLER device */ 131 132 struct timer_list nlp_delayfunc; /* Used for delayed ELS cmds */ 133 struct lpfc_hba *phba; 134 struct fc_rport *rport; /* scsi_transport_fc port structure */ 135 struct lpfc_nvme_rport *nrport; /* nvme transport rport struct. */ 136 struct lpfc_vport *vport; 137 struct lpfc_work_evt els_retry_evt; 138 struct lpfc_work_evt dev_loss_evt; 139 struct lpfc_work_evt recovery_evt; 140 struct kref kref; 141 atomic_t cmd_pending; 142 uint32_t cmd_qdepth; 143 unsigned long last_change_time; 144 unsigned long *active_rrqs_xri_bitmap; 145 struct lpfc_scsicmd_bkt *lat_data; /* Latency data */ 146 uint32_t fc4_prli_sent; 147 u32 upcall_flags; 148#define NLP_WAIT_FOR_LOGO 0x2 149 150 enum lpfc_fc4_xpt_flags fc4_xpt_flags; 151 152 uint32_t nvme_fb_size; /* NVME target's supported byte cnt */ 153#define NVME_FB_BIT_SHIFT 9 /* PRLI Rsp first burst in 512B units. */ 154 uint32_t nlp_defer_did; 155 wait_queue_head_t *logo_waitq; 156}; 157 158struct lpfc_node_rrq { 159 struct list_head list; 160 uint16_t xritag; 161 uint16_t send_rrq; 162 uint16_t rxid; 163 uint32_t nlp_DID; /* FC D_ID of entry */ 164 struct lpfc_vport *vport; 165 unsigned long rrq_stop_time; 166}; 167 168#define lpfc_ndlp_check_qdepth(phba, ndlp) \ 169 (ndlp->cmd_qdepth < phba->sli4_hba.max_cfg_param.max_xri) 170 171/* Defines for nlp_flag (uint32) */ 172#define NLP_IGNR_REG_CMPL 0x00000001 /* Rcvd rscn before we cmpl reg login */ 173#define NLP_REG_LOGIN_SEND 0x00000002 /* sent reglogin to adapter */ 174#define NLP_RELEASE_RPI 0x00000004 /* Release RPI to free pool */ 175#define NLP_SUPPRESS_RSP 0x00000010 /* Remote NPort supports suppress rsp */ 176#define NLP_PLOGI_SND 0x00000020 /* sent PLOGI request for this entry */ 177#define NLP_PRLI_SND 0x00000040 /* sent PRLI request for this entry */ 178#define NLP_ADISC_SND 0x00000080 /* sent ADISC request for this entry */ 179#define NLP_LOGO_SND 0x00000100 /* sent LOGO request for this entry */ 180#define NLP_RNID_SND 0x00000400 /* sent RNID request for this entry */ 181#define NLP_ELS_SND_MASK 0x000007e0 /* sent ELS request for this entry */ 182#define NLP_NVMET_RECOV 0x00001000 /* NVMET auditing node for recovery. */ 183#define NLP_FCP_PRLI_RJT 0x00002000 /* Rport does not support FCP PRLI. */ 184#define NLP_UNREG_INP 0x00008000 /* UNREG_RPI cmd is in progress */ 185#define NLP_DROPPED 0x00010000 /* Init ref count has been dropped */ 186#define NLP_DELAY_TMO 0x00020000 /* delay timeout is running for node */ 187#define NLP_NPR_2B_DISC 0x00040000 /* node is included in num_disc_nodes */ 188#define NLP_RCV_PLOGI 0x00080000 /* Rcv'ed PLOGI from remote system */ 189#define NLP_LOGO_ACC 0x00100000 /* Process LOGO after ACC completes */ 190#define NLP_TGT_NO_SCSIID 0x00200000 /* good PRLI but no binding for scsid */ 191#define NLP_ISSUE_LOGO 0x00400000 /* waiting to issue a LOGO */ 192#define NLP_IN_DEV_LOSS 0x00800000 /* devloss in progress */ 193#define NLP_ACC_REGLOGIN 0x01000000 /* Issue Reg Login after successful 194 ACC */ 195#define NLP_NPR_ADISC 0x02000000 /* Issue ADISC when dq'ed from 196 NPR list */ 197#define NLP_RM_DFLT_RPI 0x04000000 /* need to remove leftover dflt RPI */ 198#define NLP_NODEV_REMOVE 0x08000000 /* Defer removal till discovery ends */ 199#define NLP_TARGET_REMOVE 0x10000000 /* Target remove in process */ 200#define NLP_SC_REQ 0x20000000 /* Target requires authentication */ 201#define NLP_FIRSTBURST 0x40000000 /* Target supports FirstBurst */ 202#define NLP_RPI_REGISTERED 0x80000000 /* nlp_rpi is valid */ 203 204/* There are 4 different double linked lists nodelist entries can reside on. 205 * The Port Login (PLOGI) list and Address Discovery (ADISC) list are used 206 * when Link Up discovery or Registered State Change Notification (RSCN) 207 * processing is needed. Each list holds the nodes that require a PLOGI or 208 * ADISC Extended Link Service (ELS) request. These lists keep track of the 209 * nodes affected by an RSCN, or a Link Up (Typically, all nodes are effected 210 * by Link Up) event. The unmapped_list contains all nodes that have 211 * successfully logged into at the Fibre Channel level. The 212 * mapped_list will contain all nodes that are mapped FCP targets. 213 * 214 * The bind list is a list of undiscovered (potentially non-existent) nodes 215 * that we have saved binding information on. This information is used when 216 * nodes transition from the unmapped to the mapped list. 217 */ 218 219/* Defines for nlp_state */ 220#define NLP_STE_UNUSED_NODE 0x0 /* node is just allocated */ 221#define NLP_STE_PLOGI_ISSUE 0x1 /* PLOGI was sent to NL_PORT */ 222#define NLP_STE_ADISC_ISSUE 0x2 /* ADISC was sent to NL_PORT */ 223#define NLP_STE_REG_LOGIN_ISSUE 0x3 /* REG_LOGIN was issued for NL_PORT */ 224#define NLP_STE_PRLI_ISSUE 0x4 /* PRLI was sent to NL_PORT */ 225#define NLP_STE_LOGO_ISSUE 0x5 /* LOGO was sent to NL_PORT */ 226#define NLP_STE_UNMAPPED_NODE 0x6 /* PRLI completed from NL_PORT */ 227#define NLP_STE_MAPPED_NODE 0x7 /* Identified as a FCP Target */ 228#define NLP_STE_NPR_NODE 0x8 /* NPort disappeared */ 229#define NLP_STE_MAX_STATE 0x9 230#define NLP_STE_FREED_NODE 0xff /* node entry was freed to MEM_NLP */ 231 232/* For UNUSED_NODE state, the node has just been allocated. 233 * For PLOGI_ISSUE and REG_LOGIN_ISSUE, the node is on 234 * the PLOGI list. For REG_LOGIN_COMPL, the node is taken off the PLOGI list 235 * and put on the unmapped list. For ADISC processing, the node is taken off 236 * the ADISC list and placed on either the mapped or unmapped list (depending 237 * on its previous state). Once on the unmapped list, a PRLI is issued and the 238 * state changed to PRLI_ISSUE. When the PRLI completion occurs, the state is 239 * changed to PRLI_COMPL. If the completion indicates a mapped 240 * node, the node is taken off the unmapped list. The binding list is checked 241 * for a valid binding, or a binding is automatically assigned. If binding 242 * assignment is unsuccessful, the node is left on the unmapped list. If 243 * binding assignment is successful, the associated binding list entry (if 244 * any) is removed, and the node is placed on the mapped list. 245 */ 246/* 247 * For a Link Down, all nodes on the ADISC, PLOGI, unmapped or mapped 248 * lists will receive a DEVICE_RECOVERY event. If the linkdown or devloss timers 249 * expire, all effected nodes will receive a DEVICE_RM event. 250 */ 251/* 252 * For a Link Up or RSCN, all nodes will move from the mapped / unmapped lists 253 * to either the ADISC or PLOGI list. After a Nameserver query or ALPA loopmap 254 * check, additional nodes may be added (DEVICE_ADD) or removed (DEVICE_RM) to / 255 * from the PLOGI or ADISC lists. Once the PLOGI and ADISC lists are populated, 256 * we will first process the ADISC list. 32 entries are processed initially and 257 * ADISC is initited for each one. Completions / Events for each node are 258 * funnelled thru the state machine. As each node finishes ADISC processing, it 259 * starts ADISC for any nodes waiting for ADISC processing. If no nodes are 260 * waiting, and the ADISC list count is identically 0, then we are done. For 261 * Link Up discovery, since all nodes on the PLOGI list are UNREG_LOGIN'ed, we 262 * can issue a CLEAR_LA and reenable Link Events. Next we will process the PLOGI 263 * list. 32 entries are processed initially and PLOGI is initited for each one. 264 * Completions / Events for each node are funnelled thru the state machine. As 265 * each node finishes PLOGI processing, it starts PLOGI for any nodes waiting 266 * for PLOGI processing. If no nodes are waiting, and the PLOGI list count is 267 * identically 0, then we are done. We have now completed discovery / RSCN 268 * handling. Upon completion, ALL nodes should be on either the mapped or 269 * unmapped lists. 270 */ 271 272/* Defines for Node List Entry Events that could happen */ 273#define NLP_EVT_RCV_PLOGI 0x0 /* Rcv'd an ELS PLOGI command */ 274#define NLP_EVT_RCV_PRLI 0x1 /* Rcv'd an ELS PRLI command */ 275#define NLP_EVT_RCV_LOGO 0x2 /* Rcv'd an ELS LOGO command */ 276#define NLP_EVT_RCV_ADISC 0x3 /* Rcv'd an ELS ADISC command */ 277#define NLP_EVT_RCV_PDISC 0x4 /* Rcv'd an ELS PDISC command */ 278#define NLP_EVT_RCV_PRLO 0x5 /* Rcv'd an ELS PRLO command */ 279#define NLP_EVT_CMPL_PLOGI 0x6 /* Sent an ELS PLOGI command */ 280#define NLP_EVT_CMPL_PRLI 0x7 /* Sent an ELS PRLI command */ 281#define NLP_EVT_CMPL_LOGO 0x8 /* Sent an ELS LOGO command */ 282#define NLP_EVT_CMPL_ADISC 0x9 /* Sent an ELS ADISC command */ 283#define NLP_EVT_CMPL_REG_LOGIN 0xa /* REG_LOGIN mbox cmd completed */ 284#define NLP_EVT_DEVICE_RM 0xb /* Device not found in NS / ALPAmap */ 285#define NLP_EVT_DEVICE_RECOVERY 0xc /* Device existence unknown */ 286#define NLP_EVT_MAX_EVENT 0xd 287#define NLP_EVT_NOTHING_PENDING 0xff 288