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