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