xref: /openbmc/linux/drivers/scsi/lpfc/lpfc_disc.h (revision b6dcefde)
1 /*******************************************************************
2  * This file is part of the Emulex Linux Device Driver for         *
3  * Fibre Channel Host Bus Adapters.                                *
4  * Copyright (C) 2004-2008 Emulex.  All rights reserved.           *
5  * EMULEX and SLI are trademarks of Emulex.                        *
6  * www.emulex.com                                                  *
7  *                                                                 *
8  * This program is free software; you can redistribute it and/or   *
9  * modify it under the terms of version 2 of the GNU General       *
10  * Public License as published by the Free Software Foundation.    *
11  * This program is distributed in the hope that it will be useful. *
12  * ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND          *
13  * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,  *
14  * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT, ARE      *
15  * DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD *
16  * TO BE LEGALLY INVALID.  See the GNU General Public License for  *
17  * more details, a copy of which can be found in the file COPYING  *
18  * included with this package.                                     *
19  *******************************************************************/
20 
21 #define FC_MAX_HOLD_RSCN     32	      /* max number of deferred RSCNs */
22 #define FC_MAX_NS_RSP        64512    /* max size NameServer rsp */
23 #define FC_MAXLOOP           126      /* max devices supported on a fc loop */
24 #define LPFC_DISC_FLOGI_TMO  10	      /* Discovery FLOGI ratov */
25 
26 
27 /* This is the protocol dependent definition for a Node List Entry.
28  * This is used by Fibre Channel protocol to support FCP.
29  */
30 
31 /* worker thread events */
32 enum lpfc_work_type {
33 	LPFC_EVT_ONLINE,
34 	LPFC_EVT_OFFLINE_PREP,
35 	LPFC_EVT_OFFLINE,
36 	LPFC_EVT_WARM_START,
37 	LPFC_EVT_KILL,
38 	LPFC_EVT_ELS_RETRY,
39 	LPFC_EVT_DEV_LOSS,
40 	LPFC_EVT_FASTPATH_MGMT_EVT,
41 };
42 
43 /* structure used to queue event to the discovery tasklet */
44 struct lpfc_work_evt {
45 	struct list_head      evt_listp;
46 	void                 *evt_arg1;
47 	void                 *evt_arg2;
48 	enum lpfc_work_type   evt;
49 };
50 
51 struct lpfc_scsi_check_condition_event;
52 struct lpfc_scsi_varqueuedepth_event;
53 struct lpfc_scsi_event_header;
54 struct lpfc_fabric_event_header;
55 struct lpfc_fcprdchkerr_event;
56 
57 /* structure used for sending events from fast path */
58 struct lpfc_fast_path_event {
59 	struct lpfc_work_evt work_evt;
60 	struct lpfc_vport     *vport;
61 	union {
62 		struct lpfc_scsi_check_condition_event check_cond_evt;
63 		struct lpfc_scsi_varqueuedepth_event queue_depth_evt;
64 		struct lpfc_scsi_event_header scsi_evt;
65 		struct lpfc_fabric_event_header fabric_evt;
66 		struct lpfc_fcprdchkerr_event read_check_error;
67 	} un;
68 };
69 
70 struct lpfc_nodelist {
71 	struct list_head nlp_listp;
72 	struct lpfc_name nlp_portname;
73 	struct lpfc_name nlp_nodename;
74 	uint32_t         nlp_flag;		/* entry  flags */
75 	uint32_t         nlp_DID;		/* FC D_ID of entry */
76 	uint32_t         nlp_last_elscmd;	/* Last ELS cmd sent */
77 	uint16_t         nlp_type;
78 #define NLP_FC_NODE        0x1			/* entry is an FC node */
79 #define NLP_FABRIC         0x4			/* entry rep a Fabric entity */
80 #define NLP_FCP_TARGET     0x8			/* entry is an FCP target */
81 #define NLP_FCP_INITIATOR  0x10			/* entry is an FCP Initiator */
82 
83 	uint16_t        nlp_rpi;
84 	uint16_t        nlp_state;		/* state transition indicator */
85 	uint16_t        nlp_prev_state;		/* state transition indicator */
86 	uint16_t        nlp_xri;		/* output exchange id for RPI */
87 	uint16_t        nlp_sid;		/* scsi id */
88 #define NLP_NO_SID		0xffff
89 	uint16_t	nlp_maxframe;		/* Max RCV frame size */
90 	uint8_t		nlp_class_sup;		/* Supported Classes */
91 	uint8_t         nlp_retry;		/* used for ELS retries */
92 	uint8_t         nlp_fcp_info;	        /* class info, bits 0-3 */
93 #define NLP_FCP_2_DEVICE   0x10			/* FCP-2 device */
94 
95 	uint16_t        nlp_usg_map;	/* ndlp management usage bitmap */
96 #define NLP_USG_NODE_ACT_BIT	0x1	/* Indicate ndlp is actively used */
97 #define NLP_USG_IACT_REQ_BIT	0x2	/* Request to inactivate ndlp */
98 #define NLP_USG_FREE_REQ_BIT	0x4	/* Request to invoke ndlp memory free */
99 #define NLP_USG_FREE_ACK_BIT	0x8	/* Indicate ndlp memory free invoked */
100 
101 	struct timer_list   nlp_delayfunc;	/* Used for delayed ELS cmds */
102 	struct lpfc_hba *phba;
103 	struct fc_rport *rport;			/* Corresponding FC transport
104 						   port structure */
105 	struct lpfc_vport *vport;
106 	struct lpfc_work_evt els_retry_evt;
107 	struct lpfc_work_evt dev_loss_evt;
108 	struct kref     kref;
109 	atomic_t cmd_pending;
110 	uint32_t cmd_qdepth;
111 	unsigned long last_change_time;
112 	struct lpfc_scsicmd_bkt *lat_data;	/* Latency data */
113 };
114 
115 /* Defines for nlp_flag (uint32) */
116 #define NLP_PLOGI_SND      0x00000020	/* sent PLOGI request for this entry */
117 #define NLP_PRLI_SND       0x00000040	/* sent PRLI request for this entry */
118 #define NLP_ADISC_SND      0x00000080	/* sent ADISC request for this entry */
119 #define NLP_LOGO_SND       0x00000100	/* sent LOGO request for this entry */
120 #define NLP_RNID_SND       0x00000400	/* sent RNID request for this entry */
121 #define NLP_ELS_SND_MASK   0x000007e0	/* sent ELS request for this entry */
122 #define NLP_DEFER_RM       0x00010000	/* Remove this ndlp if no longer used */
123 #define NLP_DELAY_TMO      0x00020000	/* delay timeout is running for node */
124 #define NLP_NPR_2B_DISC    0x00040000	/* node is included in num_disc_nodes */
125 #define NLP_RCV_PLOGI      0x00080000	/* Rcv'ed PLOGI from remote system */
126 #define NLP_LOGO_ACC       0x00100000	/* Process LOGO after ACC completes */
127 #define NLP_TGT_NO_SCSIID  0x00200000	/* good PRLI but no binding for scsid */
128 #define NLP_ACC_REGLOGIN   0x01000000	/* Issue Reg Login after successful
129 					   ACC */
130 #define NLP_NPR_ADISC      0x02000000	/* Issue ADISC when dq'ed from
131 					   NPR list */
132 #define NLP_RM_DFLT_RPI    0x04000000	/* need to remove leftover dflt RPI */
133 #define NLP_NODEV_REMOVE   0x08000000	/* Defer removal till discovery ends */
134 #define NLP_TARGET_REMOVE  0x10000000   /* Target remove in process */
135 #define NLP_SC_REQ         0x20000000	/* Target requires authentication */
136 #define NLP_RPI_VALID      0x80000000	/* nlp_rpi is valid */
137 
138 /* ndlp usage management macros */
139 #define NLP_CHK_NODE_ACT(ndlp)		(((ndlp)->nlp_usg_map \
140 						& NLP_USG_NODE_ACT_BIT) \
141 					&& \
142 					!((ndlp)->nlp_usg_map \
143 						& NLP_USG_FREE_ACK_BIT))
144 #define NLP_SET_NODE_ACT(ndlp)		((ndlp)->nlp_usg_map \
145 						|= NLP_USG_NODE_ACT_BIT)
146 #define NLP_INT_NODE_ACT(ndlp)		((ndlp)->nlp_usg_map \
147 						= NLP_USG_NODE_ACT_BIT)
148 #define NLP_CLR_NODE_ACT(ndlp)		((ndlp)->nlp_usg_map \
149 						&= ~NLP_USG_NODE_ACT_BIT)
150 #define NLP_CHK_IACT_REQ(ndlp)          ((ndlp)->nlp_usg_map \
151 						& NLP_USG_IACT_REQ_BIT)
152 #define NLP_SET_IACT_REQ(ndlp)          ((ndlp)->nlp_usg_map \
153 						|= NLP_USG_IACT_REQ_BIT)
154 #define NLP_CHK_FREE_REQ(ndlp)		((ndlp)->nlp_usg_map \
155 						& NLP_USG_FREE_REQ_BIT)
156 #define NLP_SET_FREE_REQ(ndlp)		((ndlp)->nlp_usg_map \
157 						|= NLP_USG_FREE_REQ_BIT)
158 #define NLP_CHK_FREE_ACK(ndlp)		((ndlp)->nlp_usg_map \
159 						& NLP_USG_FREE_ACK_BIT)
160 #define NLP_SET_FREE_ACK(ndlp)		((ndlp)->nlp_usg_map \
161 						|= NLP_USG_FREE_ACK_BIT)
162 
163 /* There are 4 different double linked lists nodelist entries can reside on.
164  * The Port Login (PLOGI) list and Address Discovery (ADISC) list are used
165  * when Link Up discovery or Registered State Change Notification (RSCN)
166  * processing is needed.  Each list holds the nodes that require a PLOGI or
167  * ADISC Extended Link Service (ELS) request.  These lists keep track of the
168  * nodes affected by an RSCN, or a Link Up (Typically, all nodes are effected
169  * by Link Up) event.  The unmapped_list contains all nodes that have
170  * successfully logged into at the Fibre Channel level.  The
171  * mapped_list will contain all nodes that are mapped FCP targets.
172  *
173  * The bind list is a list of undiscovered (potentially non-existent) nodes
174  * that we have saved binding information on. This information is used when
175  * nodes transition from the unmapped to the mapped list.
176  */
177 
178 /* Defines for nlp_state */
179 #define NLP_STE_UNUSED_NODE       0x0	/* node is just allocated */
180 #define NLP_STE_PLOGI_ISSUE       0x1	/* PLOGI was sent to NL_PORT */
181 #define NLP_STE_ADISC_ISSUE       0x2	/* ADISC was sent to NL_PORT */
182 #define NLP_STE_REG_LOGIN_ISSUE   0x3	/* REG_LOGIN was issued for NL_PORT */
183 #define NLP_STE_PRLI_ISSUE        0x4	/* PRLI was sent to NL_PORT */
184 #define NLP_STE_UNMAPPED_NODE     0x5	/* PRLI completed from NL_PORT */
185 #define NLP_STE_MAPPED_NODE       0x6	/* Identified as a FCP Target */
186 #define NLP_STE_NPR_NODE          0x7	/* NPort disappeared */
187 #define NLP_STE_MAX_STATE         0x8
188 #define NLP_STE_FREED_NODE        0xff	/* node entry was freed to MEM_NLP */
189 
190 /* For UNUSED_NODE state, the node has just been allocated.
191  * For PLOGI_ISSUE and REG_LOGIN_ISSUE, the node is on
192  * the PLOGI list. For REG_LOGIN_COMPL, the node is taken off the PLOGI list
193  * and put on the unmapped list. For ADISC processing, the node is taken off
194  * the ADISC list and placed on either the mapped or unmapped list (depending
195  * on its previous state). Once on the unmapped list, a PRLI is issued and the
196  * state changed to PRLI_ISSUE. When the PRLI completion occurs, the state is
197  * changed to PRLI_COMPL. If the completion indicates a mapped
198  * node, the node is taken off the unmapped list. The binding list is checked
199  * for a valid binding, or a binding is automatically assigned. If binding
200  * assignment is unsuccessful, the node is left on the unmapped list. If
201  * binding assignment is successful, the associated binding list entry (if
202  * any) is removed, and the node is placed on the mapped list.
203  */
204 /*
205  * For a Link Down, all nodes on the ADISC, PLOGI, unmapped or mapped
206  * lists will receive a DEVICE_RECOVERY event. If the linkdown or devloss timers
207  * expire, all effected nodes will receive a DEVICE_RM event.
208  */
209 /*
210  * For a Link Up or RSCN, all nodes will move from the mapped / unmapped lists
211  * to either the ADISC or PLOGI list.  After a Nameserver query or ALPA loopmap
212  * check, additional nodes may be added (DEVICE_ADD) or removed (DEVICE_RM) to /
213  * from the PLOGI or ADISC lists. Once the PLOGI and ADISC lists are populated,
214  * we will first process the ADISC list.  32 entries are processed initially and
215  * ADISC is initited for each one.  Completions / Events for each node are
216  * funnelled thru the state machine.  As each node finishes ADISC processing, it
217  * starts ADISC for any nodes waiting for ADISC processing. If no nodes are
218  * waiting, and the ADISC list count is identically 0, then we are done. For
219  * Link Up discovery, since all nodes on the PLOGI list are UNREG_LOGIN'ed, we
220  * can issue a CLEAR_LA and reenable Link Events. Next we will process the PLOGI
221  * list.  32 entries are processed initially and PLOGI is initited for each one.
222  * Completions / Events for each node are funnelled thru the state machine.  As
223  * each node finishes PLOGI processing, it starts PLOGI for any nodes waiting
224  * for PLOGI processing. If no nodes are waiting, and the PLOGI list count is
225  * identically 0, then we are done. We have now completed discovery / RSCN
226  * handling. Upon completion, ALL nodes should be on either the mapped or
227  * unmapped lists.
228  */
229 
230 /* Defines for Node List Entry Events that could happen */
231 #define NLP_EVT_RCV_PLOGI         0x0	/* Rcv'd an ELS PLOGI command */
232 #define NLP_EVT_RCV_PRLI          0x1	/* Rcv'd an ELS PRLI  command */
233 #define NLP_EVT_RCV_LOGO          0x2	/* Rcv'd an ELS LOGO  command */
234 #define NLP_EVT_RCV_ADISC         0x3	/* Rcv'd an ELS ADISC command */
235 #define NLP_EVT_RCV_PDISC         0x4	/* Rcv'd an ELS PDISC command */
236 #define NLP_EVT_RCV_PRLO          0x5	/* Rcv'd an ELS PRLO  command */
237 #define NLP_EVT_CMPL_PLOGI        0x6	/* Sent an ELS PLOGI command */
238 #define NLP_EVT_CMPL_PRLI         0x7	/* Sent an ELS PRLI  command */
239 #define NLP_EVT_CMPL_LOGO         0x8	/* Sent an ELS LOGO  command */
240 #define NLP_EVT_CMPL_ADISC        0x9	/* Sent an ELS ADISC command */
241 #define NLP_EVT_CMPL_REG_LOGIN    0xa	/* REG_LOGIN mbox cmd completed */
242 #define NLP_EVT_DEVICE_RM         0xb	/* Device not found in NS / ALPAmap */
243 #define NLP_EVT_DEVICE_RECOVERY   0xc	/* Device existence unknown */
244 #define NLP_EVT_MAX_EVENT         0xd
245 
246