Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1/*******************************************************************
2 * This file is part of the Emulex Linux Device Driver for *
3 * Fibre Channel Host Bus Adapters. *
4 * Copyright (C) 2017-2026 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
80struct lpfc_enc_info {
81 u8 status; /* encryption status for session */
82 u8 level; /* CNSA encryption level */
83};
84
85enum lpfc_fc4_xpt_flags {
86 NLP_XPT_REGD = 0x1,
87 SCSI_XPT_REGD = 0x2,
88 NVME_XPT_REGD = 0x4,
89 NVME_XPT_UNREG_WAIT = 0x8,
90 NLP_XPT_HAS_HH = 0x10
91};
92
93enum lpfc_nlp_save_flags { /* mask bits */
94 /* devloss occurred during recovery */
95 NLP_IN_RECOV_POST_DEV_LOSS,
96 /* wait for outstanding LOGO to cmpl */
97 NLP_WAIT_FOR_LOGO,
98 /* wait for outstanding DA_ID to finish */
99 NLP_WAIT_FOR_DA_ID
100};
101
102struct lpfc_nodelist {
103 struct list_head nlp_listp;
104 struct serv_parm fc_sparam; /* buffer for service params */
105 struct lpfc_name nlp_portname;
106 struct lpfc_name nlp_nodename;
107
108 spinlock_t lock; /* Node management lock */
109
110 unsigned long nlp_flag; /* entry flags */
111 uint32_t nlp_DID; /* FC D_ID of entry */
112 uint32_t nlp_last_elscmd; /* Last ELS cmd sent */
113 uint16_t nlp_type;
114#define NLP_FC_NODE 0x1 /* entry is an FC node */
115#define NLP_FABRIC 0x4 /* entry rep a Fabric entity */
116#define NLP_FCP_TARGET 0x8 /* entry is an FCP target */
117#define NLP_FCP_INITIATOR 0x10 /* entry is an FCP Initiator */
118#define NLP_NVME_TARGET 0x20 /* entry is a NVME Target */
119#define NLP_NVME_INITIATOR 0x40 /* entry is a NVME Initiator */
120#define NLP_NVME_DISCOVERY 0x80 /* entry has NVME disc srvc */
121
122 uint16_t nlp_fc4_type; /* FC types node supports. */
123 /* Assigned from GID_FF, only
124 * FCP (0x8) and NVME (0x28)
125 * supported.
126 */
127#define NLP_FC4_NONE 0x0
128#define NLP_FC4_FCP 0x1 /* FC4 Type FCP (value x8)) */
129#define NLP_FC4_NVME 0x2 /* FC4 TYPE NVME (value x28) */
130
131 uint16_t nlp_rpi;
132 uint16_t nlp_state; /* state transition indicator */
133 uint16_t nlp_prev_state; /* state transition indicator */
134 uint16_t nlp_xri; /* output exchange id for RPI */
135 uint16_t nlp_sid; /* scsi id */
136#define NLP_NO_SID 0xffff
137 uint16_t nlp_maxframe; /* Max RCV frame size */
138 uint8_t nlp_class_sup; /* Supported Classes */
139 uint8_t nlp_retry; /* used for ELS retries */
140 uint8_t nlp_fcp_info; /* class info, bits 0-2 */
141#define NLP_FCP_CLASS_MASK 0x07 /* class info bitmask */
142#define NLP_FCP_2_DEVICE 0x10 /* FCP-2 device */
143 u8 nlp_nvme_info; /* NVME NSLER Support */
144 uint8_t vmid_support; /* destination VMID support */
145#define NLP_NVME_NSLER 0x1 /* NVME NSLER device */
146
147 struct lpfc_enc_info nlp_enc_info; /* Encryption information struct */
148
149 struct timer_list nlp_delayfunc; /* Used for delayed ELS cmds */
150 struct lpfc_hba *phba;
151 struct fc_rport *rport; /* scsi_transport_fc port structure */
152 struct lpfc_nvme_rport *nrport; /* nvme transport rport struct. */
153 struct lpfc_vport *vport;
154 struct lpfc_work_evt els_retry_evt;
155 struct lpfc_work_evt dev_loss_evt;
156 struct lpfc_work_evt recovery_evt;
157 struct kref kref;
158 atomic_t cmd_pending;
159 uint32_t cmd_qdepth;
160 unsigned long last_change_time;
161 unsigned long *active_rrqs_xri_bitmap;
162 uint32_t fc4_prli_sent;
163
164 /* flags to keep ndlp alive until special conditions are met */
165 unsigned long save_flags;
166
167 enum lpfc_fc4_xpt_flags fc4_xpt_flags;
168
169 uint32_t nvme_fb_size; /* NVME target's supported byte cnt */
170#define NVME_FB_BIT_SHIFT 9 /* PRLI Rsp first burst in 512B units. */
171 uint32_t nlp_defer_did;
172
173 /* These wait objects are NPIV specific. These IOs must complete
174 * synchronously.
175 */
176 wait_queue_head_t *logo_waitq;
177 wait_queue_head_t *da_id_waitq;
178};
179
180struct lpfc_node_rrq {
181 struct list_head list;
182 uint16_t xritag;
183 uint16_t send_rrq;
184 uint16_t rxid;
185 uint32_t nlp_DID; /* FC D_ID of entry */
186 struct lpfc_vport *vport;
187 unsigned long rrq_stop_time;
188};
189
190#define lpfc_ndlp_check_qdepth(phba, ndlp) \
191 (ndlp->cmd_qdepth < phba->sli4_hba.max_cfg_param.max_xri)
192
193/* nlp_flag mask bits */
194enum lpfc_nlp_flag {
195 NLP_IGNR_REG_CMPL = 0, /* Rcvd rscn before we cmpl reg login */
196 NLP_REG_LOGIN_SEND = 1, /* sent reglogin to adapter */
197 NLP_SUPPRESS_RSP = 4, /* Remote NPort supports suppress rsp */
198 NLP_PLOGI_SND = 5, /* sent PLOGI request for this entry */
199 NLP_PRLI_SND = 6, /* sent PRLI request for this entry */
200 NLP_ADISC_SND = 7, /* sent ADISC request for this entry */
201 NLP_LOGO_SND = 8, /* sent LOGO request for this entry */
202 NLP_RNID_SND = 10, /* sent RNID request for this entry */
203 NLP_NVMET_RECOV = 12, /* NVMET auditing node for recovery. */
204 NLP_UNREG_INP = 15, /* UNREG_RPI cmd is in progress */
205 NLP_DROPPED = 16, /* Init ref count has been dropped */
206 NLP_DELAY_TMO = 17, /* delay timeout is running for node */
207 NLP_NPR_2B_DISC = 18, /* node is included in num_disc_nodes */
208 NLP_RCV_PLOGI = 19, /* Rcv'ed PLOGI from remote system */
209 NLP_LOGO_ACC = 20, /* Process LOGO after ACC completes */
210 NLP_TGT_NO_SCSIID = 21, /* good PRLI but no binding for scsid */
211 NLP_ISSUE_LOGO = 22, /* waiting to issue a LOGO */
212 NLP_IN_DEV_LOSS = 23, /* devloss in progress */
213 NLP_ACC_REGLOGIN = 24, /* Issue Reg Login after successful
214 ACC */
215 NLP_NPR_ADISC = 25, /* Issue ADISC when dq'ed from
216 NPR list */
217 NLP_RM_DFLT_RPI = 26, /* need to remove leftover dflt RPI */
218 NLP_NODEV_REMOVE = 27, /* Defer removal till discovery ends */
219 NLP_FLOGI_DFR_ACC = 28, /* FLOGI LS_ACC was Deferred */
220 NLP_SC_REQ = 29, /* Target requires authentication */
221 NLP_FIRSTBURST = 30, /* Target supports FirstBurst */
222 NLP_RPI_REGISTERED = 31 /* nlp_rpi is valid */
223};
224
225/* There are 4 different double linked lists nodelist entries can reside on.
226 * The Port Login (PLOGI) list and Address Discovery (ADISC) list are used
227 * when Link Up discovery or Registered State Change Notification (RSCN)
228 * processing is needed. Each list holds the nodes that require a PLOGI or
229 * ADISC Extended Link Service (ELS) request. These lists keep track of the
230 * nodes affected by an RSCN, or a Link Up (Typically, all nodes are effected
231 * by Link Up) event. The unmapped_list contains all nodes that have
232 * successfully logged into at the Fibre Channel level. The
233 * mapped_list will contain all nodes that are mapped FCP targets.
234 *
235 * The bind list is a list of undiscovered (potentially non-existent) nodes
236 * that we have saved binding information on. This information is used when
237 * nodes transition from the unmapped to the mapped list.
238 */
239
240/* Defines for nlp_state */
241#define NLP_STE_UNUSED_NODE 0x0 /* node is just allocated */
242#define NLP_STE_PLOGI_ISSUE 0x1 /* PLOGI was sent to NL_PORT */
243#define NLP_STE_ADISC_ISSUE 0x2 /* ADISC was sent to NL_PORT */
244#define NLP_STE_REG_LOGIN_ISSUE 0x3 /* REG_LOGIN was issued for NL_PORT */
245#define NLP_STE_PRLI_ISSUE 0x4 /* PRLI was sent to NL_PORT */
246#define NLP_STE_LOGO_ISSUE 0x5 /* LOGO was sent to NL_PORT */
247#define NLP_STE_UNMAPPED_NODE 0x6 /* PRLI completed from NL_PORT */
248#define NLP_STE_MAPPED_NODE 0x7 /* Identified as a FCP Target */
249#define NLP_STE_NPR_NODE 0x8 /* NPort disappeared */
250#define NLP_STE_MAX_STATE 0x9
251#define NLP_STE_FREED_NODE 0xff /* node entry was freed to MEM_NLP */
252
253/* For UNUSED_NODE state, the node has just been allocated.
254 * For PLOGI_ISSUE and REG_LOGIN_ISSUE, the node is on
255 * the PLOGI list. For REG_LOGIN_COMPL, the node is taken off the PLOGI list
256 * and put on the unmapped list. For ADISC processing, the node is taken off
257 * the ADISC list and placed on either the mapped or unmapped list (depending
258 * on its previous state). Once on the unmapped list, a PRLI is issued and the
259 * state changed to PRLI_ISSUE. When the PRLI completion occurs, the state is
260 * changed to PRLI_COMPL. If the completion indicates a mapped
261 * node, the node is taken off the unmapped list. The binding list is checked
262 * for a valid binding, or a binding is automatically assigned. If binding
263 * assignment is unsuccessful, the node is left on the unmapped list. If
264 * binding assignment is successful, the associated binding list entry (if
265 * any) is removed, and the node is placed on the mapped list.
266 */
267/*
268 * For a Link Down, all nodes on the ADISC, PLOGI, unmapped or mapped
269 * lists will receive a DEVICE_RECOVERY event. If the linkdown or devloss timers
270 * expire, all effected nodes will receive a DEVICE_RM event.
271 */
272/*
273 * For a Link Up or RSCN, all nodes will move from the mapped / unmapped lists
274 * to either the ADISC or PLOGI list. After a Nameserver query or ALPA loopmap
275 * check, additional nodes may be added (DEVICE_ADD) or removed (DEVICE_RM) to /
276 * from the PLOGI or ADISC lists. Once the PLOGI and ADISC lists are populated,
277 * we will first process the ADISC list. 32 entries are processed initially and
278 * ADISC is initited for each one. Completions / Events for each node are
279 * funnelled thru the state machine. As each node finishes ADISC processing, it
280 * starts ADISC for any nodes waiting for ADISC processing. If no nodes are
281 * waiting, and the ADISC list count is identically 0, then we are done. For
282 * Link Up discovery, since all nodes on the PLOGI list are UNREG_LOGIN'ed, we
283 * can issue a CLEAR_LA and reenable Link Events. Next we will process the PLOGI
284 * list. 32 entries are processed initially and PLOGI is initited for each one.
285 * Completions / Events for each node are funnelled thru the state machine. As
286 * each node finishes PLOGI processing, it starts PLOGI for any nodes waiting
287 * for PLOGI processing. If no nodes are waiting, and the PLOGI list count is
288 * identically 0, then we are done. We have now completed discovery / RSCN
289 * handling. Upon completion, ALL nodes should be on either the mapped or
290 * unmapped lists.
291 */
292
293/* Defines for Node List Entry Events that could happen */
294#define NLP_EVT_RCV_PLOGI 0x0 /* Rcv'd an ELS PLOGI command */
295#define NLP_EVT_RCV_PRLI 0x1 /* Rcv'd an ELS PRLI command */
296#define NLP_EVT_RCV_LOGO 0x2 /* Rcv'd an ELS LOGO command */
297#define NLP_EVT_RCV_ADISC 0x3 /* Rcv'd an ELS ADISC command */
298#define NLP_EVT_RCV_PDISC 0x4 /* Rcv'd an ELS PDISC command */
299#define NLP_EVT_RCV_PRLO 0x5 /* Rcv'd an ELS PRLO command */
300#define NLP_EVT_CMPL_PLOGI 0x6 /* Sent an ELS PLOGI command */
301#define NLP_EVT_CMPL_PRLI 0x7 /* Sent an ELS PRLI command */
302#define NLP_EVT_CMPL_LOGO 0x8 /* Sent an ELS LOGO command */
303#define NLP_EVT_CMPL_ADISC 0x9 /* Sent an ELS ADISC command */
304#define NLP_EVT_CMPL_REG_LOGIN 0xa /* REG_LOGIN mbox cmd completed */
305#define NLP_EVT_DEVICE_RM 0xb /* Device not found in NS / ALPAmap */
306#define NLP_EVT_DEVICE_RECOVERY 0xc /* Device existence unknown */
307#define NLP_EVT_MAX_EVENT 0xd
308#define NLP_EVT_NOTHING_PENDING 0xff