xref: /openbmc/linux/drivers/scsi/lpfc/lpfc_disc.h (revision 5bd8e16d)
1 /*******************************************************************
2  * This file is part of the Emulex Linux Device Driver for         *
3  * Fibre Channel Host Bus Adapters.                                *
4  * Copyright (C) 2004-2013 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 	LPFC_EVT_RESET_HBA,
42 };
43 
44 /* structure used to queue event to the discovery tasklet */
45 struct lpfc_work_evt {
46 	struct list_head      evt_listp;
47 	void                 *evt_arg1;
48 	void                 *evt_arg2;
49 	enum lpfc_work_type   evt;
50 };
51 
52 struct lpfc_scsi_check_condition_event;
53 struct lpfc_scsi_varqueuedepth_event;
54 struct lpfc_scsi_event_header;
55 struct lpfc_fabric_event_header;
56 struct lpfc_fcprdchkerr_event;
57 
58 /* structure used for sending events from fast path */
59 struct lpfc_fast_path_event {
60 	struct lpfc_work_evt work_evt;
61 	struct lpfc_vport     *vport;
62 	union {
63 		struct lpfc_scsi_check_condition_event check_cond_evt;
64 		struct lpfc_scsi_varqueuedepth_event queue_depth_evt;
65 		struct lpfc_scsi_event_header scsi_evt;
66 		struct lpfc_fabric_event_header fabric_evt;
67 		struct lpfc_fcprdchkerr_event read_check_error;
68 	} un;
69 };
70 
71 #define LPFC_SLI4_MAX_XRI	1024	/* Used to make the ndlp's xri_bitmap */
72 #define XRI_BITMAP_ULONGS (LPFC_SLI4_MAX_XRI / BITS_PER_LONG)
73 struct lpfc_node_rrqs {
74 	unsigned long xri_bitmap[XRI_BITMAP_ULONGS];
75 };
76 
77 struct lpfc_nodelist {
78 	struct list_head nlp_listp;
79 	struct lpfc_name nlp_portname;
80 	struct lpfc_name nlp_nodename;
81 	uint32_t         nlp_flag;		/* entry  flags */
82 	uint32_t         nlp_DID;		/* FC D_ID of entry */
83 	uint32_t         nlp_last_elscmd;	/* Last ELS cmd sent */
84 	uint16_t         nlp_type;
85 #define NLP_FC_NODE        0x1			/* entry is an FC node */
86 #define NLP_FABRIC         0x4			/* entry rep a Fabric entity */
87 #define NLP_FCP_TARGET     0x8			/* entry is an FCP target */
88 #define NLP_FCP_INITIATOR  0x10			/* entry is an FCP Initiator */
89 
90 	uint16_t        nlp_rpi;
91 	uint16_t        nlp_state;		/* state transition indicator */
92 	uint16_t        nlp_prev_state;		/* state transition indicator */
93 	uint16_t        nlp_xri;		/* output exchange id for RPI */
94 	uint16_t        nlp_sid;		/* scsi id */
95 #define NLP_NO_SID		0xffff
96 	uint16_t	nlp_maxframe;		/* Max RCV frame size */
97 	uint8_t		nlp_class_sup;		/* Supported Classes */
98 	uint8_t         nlp_retry;		/* used for ELS retries */
99 	uint8_t         nlp_fcp_info;	        /* class info, bits 0-3 */
100 #define NLP_FCP_2_DEVICE   0x10			/* FCP-2 device */
101 
102 	uint16_t        nlp_usg_map;	/* ndlp management usage bitmap */
103 #define NLP_USG_NODE_ACT_BIT	0x1	/* Indicate ndlp is actively used */
104 #define NLP_USG_IACT_REQ_BIT	0x2	/* Request to inactivate ndlp */
105 #define NLP_USG_FREE_REQ_BIT	0x4	/* Request to invoke ndlp memory free */
106 #define NLP_USG_FREE_ACK_BIT	0x8	/* Indicate ndlp memory free invoked */
107 
108 	struct timer_list   nlp_delayfunc;	/* Used for delayed ELS cmds */
109 	struct lpfc_hba *phba;
110 	struct fc_rport *rport;			/* Corresponding FC transport
111 						   port structure */
112 	struct lpfc_vport *vport;
113 	struct lpfc_work_evt els_retry_evt;
114 	struct lpfc_work_evt dev_loss_evt;
115 	struct kref     kref;
116 	atomic_t cmd_pending;
117 	uint32_t cmd_qdepth;
118 	unsigned long last_change_time;
119 	struct lpfc_node_rrqs active_rrqs;
120 	struct lpfc_scsicmd_bkt *lat_data;	/* Latency data */
121 };
122 struct lpfc_node_rrq {
123 	struct list_head list;
124 	uint16_t xritag;
125 	uint16_t send_rrq;
126 	uint16_t rxid;
127 	uint32_t         nlp_DID;		/* FC D_ID of entry */
128 	struct lpfc_vport *vport;
129 	struct lpfc_nodelist *ndlp;
130 	unsigned long rrq_stop_time;
131 };
132 
133 /* Defines for nlp_flag (uint32) */
134 #define NLP_IGNR_REG_CMPL  0x00000001 /* Rcvd rscn before we cmpl reg login */
135 #define NLP_REG_LOGIN_SEND 0x00000002   /* sent reglogin to adapter */
136 #define NLP_PLOGI_SND      0x00000020	/* sent PLOGI request for this entry */
137 #define NLP_PRLI_SND       0x00000040	/* sent PRLI request for this entry */
138 #define NLP_ADISC_SND      0x00000080	/* sent ADISC request for this entry */
139 #define NLP_LOGO_SND       0x00000100	/* sent LOGO request for this entry */
140 #define NLP_RNID_SND       0x00000400	/* sent RNID request for this entry */
141 #define NLP_ELS_SND_MASK   0x000007e0	/* sent ELS request for this entry */
142 #define NLP_DEFER_RM       0x00010000	/* Remove this ndlp if no longer used */
143 #define NLP_DELAY_TMO      0x00020000	/* delay timeout is running for node */
144 #define NLP_NPR_2B_DISC    0x00040000	/* node is included in num_disc_nodes */
145 #define NLP_RCV_PLOGI      0x00080000	/* Rcv'ed PLOGI from remote system */
146 #define NLP_LOGO_ACC       0x00100000	/* Process LOGO after ACC completes */
147 #define NLP_TGT_NO_SCSIID  0x00200000	/* good PRLI but no binding for scsid */
148 #define NLP_ISSUE_LOGO     0x00400000	/* waiting to issue a LOGO */
149 #define NLP_ACC_REGLOGIN   0x01000000	/* Issue Reg Login after successful
150 					   ACC */
151 #define NLP_NPR_ADISC      0x02000000	/* Issue ADISC when dq'ed from
152 					   NPR list */
153 #define NLP_RM_DFLT_RPI    0x04000000	/* need to remove leftover dflt RPI */
154 #define NLP_NODEV_REMOVE   0x08000000	/* Defer removal till discovery ends */
155 #define NLP_TARGET_REMOVE  0x10000000   /* Target remove in process */
156 #define NLP_SC_REQ         0x20000000	/* Target requires authentication */
157 #define NLP_FIRSTBURST     0x40000000	/* Target supports FirstBurst */
158 #define NLP_RPI_REGISTERED 0x80000000	/* nlp_rpi is valid */
159 
160 /* ndlp usage management macros */
161 #define NLP_CHK_NODE_ACT(ndlp)		(((ndlp)->nlp_usg_map \
162 						& NLP_USG_NODE_ACT_BIT) \
163 					&& \
164 					!((ndlp)->nlp_usg_map \
165 						& NLP_USG_FREE_ACK_BIT))
166 #define NLP_SET_NODE_ACT(ndlp)		((ndlp)->nlp_usg_map \
167 						|= NLP_USG_NODE_ACT_BIT)
168 #define NLP_INT_NODE_ACT(ndlp)		((ndlp)->nlp_usg_map \
169 						= NLP_USG_NODE_ACT_BIT)
170 #define NLP_CLR_NODE_ACT(ndlp)		((ndlp)->nlp_usg_map \
171 						&= ~NLP_USG_NODE_ACT_BIT)
172 #define NLP_CHK_IACT_REQ(ndlp)          ((ndlp)->nlp_usg_map \
173 						& NLP_USG_IACT_REQ_BIT)
174 #define NLP_SET_IACT_REQ(ndlp)          ((ndlp)->nlp_usg_map \
175 						|= NLP_USG_IACT_REQ_BIT)
176 #define NLP_CHK_FREE_REQ(ndlp)		((ndlp)->nlp_usg_map \
177 						& NLP_USG_FREE_REQ_BIT)
178 #define NLP_SET_FREE_REQ(ndlp)		((ndlp)->nlp_usg_map \
179 						|= NLP_USG_FREE_REQ_BIT)
180 #define NLP_CHK_FREE_ACK(ndlp)		((ndlp)->nlp_usg_map \
181 						& NLP_USG_FREE_ACK_BIT)
182 #define NLP_SET_FREE_ACK(ndlp)		((ndlp)->nlp_usg_map \
183 						|= NLP_USG_FREE_ACK_BIT)
184 
185 /* There are 4 different double linked lists nodelist entries can reside on.
186  * The Port Login (PLOGI) list and Address Discovery (ADISC) list are used
187  * when Link Up discovery or Registered State Change Notification (RSCN)
188  * processing is needed.  Each list holds the nodes that require a PLOGI or
189  * ADISC Extended Link Service (ELS) request.  These lists keep track of the
190  * nodes affected by an RSCN, or a Link Up (Typically, all nodes are effected
191  * by Link Up) event.  The unmapped_list contains all nodes that have
192  * successfully logged into at the Fibre Channel level.  The
193  * mapped_list will contain all nodes that are mapped FCP targets.
194  *
195  * The bind list is a list of undiscovered (potentially non-existent) nodes
196  * that we have saved binding information on. This information is used when
197  * nodes transition from the unmapped to the mapped list.
198  */
199 
200 /* Defines for nlp_state */
201 #define NLP_STE_UNUSED_NODE       0x0	/* node is just allocated */
202 #define NLP_STE_PLOGI_ISSUE       0x1	/* PLOGI was sent to NL_PORT */
203 #define NLP_STE_ADISC_ISSUE       0x2	/* ADISC was sent to NL_PORT */
204 #define NLP_STE_REG_LOGIN_ISSUE   0x3	/* REG_LOGIN was issued for NL_PORT */
205 #define NLP_STE_PRLI_ISSUE        0x4	/* PRLI was sent to NL_PORT */
206 #define NLP_STE_LOGO_ISSUE	  0x5	/* LOGO was sent to NL_PORT */
207 #define NLP_STE_UNMAPPED_NODE     0x6	/* PRLI completed from NL_PORT */
208 #define NLP_STE_MAPPED_NODE       0x7	/* Identified as a FCP Target */
209 #define NLP_STE_NPR_NODE          0x8	/* NPort disappeared */
210 #define NLP_STE_MAX_STATE         0x9
211 #define NLP_STE_FREED_NODE        0xff	/* node entry was freed to MEM_NLP */
212 
213 /* For UNUSED_NODE state, the node has just been allocated.
214  * For PLOGI_ISSUE and REG_LOGIN_ISSUE, the node is on
215  * the PLOGI list. For REG_LOGIN_COMPL, the node is taken off the PLOGI list
216  * and put on the unmapped list. For ADISC processing, the node is taken off
217  * the ADISC list and placed on either the mapped or unmapped list (depending
218  * on its previous state). Once on the unmapped list, a PRLI is issued and the
219  * state changed to PRLI_ISSUE. When the PRLI completion occurs, the state is
220  * changed to PRLI_COMPL. If the completion indicates a mapped
221  * node, the node is taken off the unmapped list. The binding list is checked
222  * for a valid binding, or a binding is automatically assigned. If binding
223  * assignment is unsuccessful, the node is left on the unmapped list. If
224  * binding assignment is successful, the associated binding list entry (if
225  * any) is removed, and the node is placed on the mapped list.
226  */
227 /*
228  * For a Link Down, all nodes on the ADISC, PLOGI, unmapped or mapped
229  * lists will receive a DEVICE_RECOVERY event. If the linkdown or devloss timers
230  * expire, all effected nodes will receive a DEVICE_RM event.
231  */
232 /*
233  * For a Link Up or RSCN, all nodes will move from the mapped / unmapped lists
234  * to either the ADISC or PLOGI list.  After a Nameserver query or ALPA loopmap
235  * check, additional nodes may be added (DEVICE_ADD) or removed (DEVICE_RM) to /
236  * from the PLOGI or ADISC lists. Once the PLOGI and ADISC lists are populated,
237  * we will first process the ADISC list.  32 entries are processed initially and
238  * ADISC is initited for each one.  Completions / Events for each node are
239  * funnelled thru the state machine.  As each node finishes ADISC processing, it
240  * starts ADISC for any nodes waiting for ADISC processing. If no nodes are
241  * waiting, and the ADISC list count is identically 0, then we are done. For
242  * Link Up discovery, since all nodes on the PLOGI list are UNREG_LOGIN'ed, we
243  * can issue a CLEAR_LA and reenable Link Events. Next we will process the PLOGI
244  * list.  32 entries are processed initially and PLOGI is initited for each one.
245  * Completions / Events for each node are funnelled thru the state machine.  As
246  * each node finishes PLOGI processing, it starts PLOGI for any nodes waiting
247  * for PLOGI processing. If no nodes are waiting, and the PLOGI list count is
248  * identically 0, then we are done. We have now completed discovery / RSCN
249  * handling. Upon completion, ALL nodes should be on either the mapped or
250  * unmapped lists.
251  */
252 
253 /* Defines for Node List Entry Events that could happen */
254 #define NLP_EVT_RCV_PLOGI         0x0	/* Rcv'd an ELS PLOGI command */
255 #define NLP_EVT_RCV_PRLI          0x1	/* Rcv'd an ELS PRLI  command */
256 #define NLP_EVT_RCV_LOGO          0x2	/* Rcv'd an ELS LOGO  command */
257 #define NLP_EVT_RCV_ADISC         0x3	/* Rcv'd an ELS ADISC command */
258 #define NLP_EVT_RCV_PDISC         0x4	/* Rcv'd an ELS PDISC command */
259 #define NLP_EVT_RCV_PRLO          0x5	/* Rcv'd an ELS PRLO  command */
260 #define NLP_EVT_CMPL_PLOGI        0x6	/* Sent an ELS PLOGI command */
261 #define NLP_EVT_CMPL_PRLI         0x7	/* Sent an ELS PRLI  command */
262 #define NLP_EVT_CMPL_LOGO         0x8	/* Sent an ELS LOGO  command */
263 #define NLP_EVT_CMPL_ADISC        0x9	/* Sent an ELS ADISC command */
264 #define NLP_EVT_CMPL_REG_LOGIN    0xa	/* REG_LOGIN mbox cmd completed */
265 #define NLP_EVT_DEVICE_RM         0xb	/* Device not found in NS / ALPAmap */
266 #define NLP_EVT_DEVICE_RECOVERY   0xc	/* Device existence unknown */
267 #define NLP_EVT_MAX_EVENT         0xd
268 
269