blob: 098b8b45c7f1be964515812a56e2cebaddae024c [file] [log] [blame]
dea31012005-04-17 16:05:31 -05001/*******************************************************************
2 * This file is part of the Emulex Linux Device Driver for *
James.Smart@Emulex.Comc44ce172005-06-25 10:34:39 -04003 * Fibre Channel Host Bus Adapters. *
4 * Copyright (C) 2004-2005 Emulex. All rights reserved. *
5 * EMULEX and SLI are trademarks of Emulex. *
dea31012005-04-17 16:05:31 -05006 * www.emulex.com *
7 * *
8 * This program is free software; you can redistribute it and/or *
James.Smart@Emulex.Comc44ce172005-06-25 10:34:39 -04009 * 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. *
dea31012005-04-17 16:05:31 -050019 *******************************************************************/
20
dea31012005-04-17 16:05:31 -050021#define FC_MAX_HOLD_RSCN 32 /* max number of deferred RSCNs */
22#define FC_MAX_NS_RSP 65536 /* 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/* structure used to queue event to the discovery tasklet */
32struct lpfc_work_evt {
33 struct list_head evt_listp;
34 void * evt_arg1;
35 void * evt_arg2;
36 uint32_t evt;
37};
38
39#define LPFC_EVT_NODEV_TMO 0x1
40#define LPFC_EVT_ONLINE 0x2
41#define LPFC_EVT_OFFLINE 0x3
42#define LPFC_EVT_ELS_RETRY 0x4
43
44struct lpfc_nodelist {
45 struct list_head nlp_listp;
46 struct lpfc_name nlp_portname; /* port name */
47 struct lpfc_name nlp_nodename; /* node name */
48 uint32_t nlp_flag; /* entry flags */
49 uint32_t nlp_DID; /* FC D_ID of entry */
50 uint32_t nlp_last_elscmd; /* Last ELS cmd sent */
51 uint16_t nlp_type;
52#define NLP_FC_NODE 0x1 /* entry is an FC node */
53#define NLP_FABRIC 0x4 /* entry rep a Fabric entity */
54#define NLP_FCP_TARGET 0x8 /* entry is an FCP target */
55#define NLP_FCP_INITIATOR 0x10 /* entry is an FCP Initiator */
56
57 uint16_t nlp_rpi;
58 uint16_t nlp_state; /* state transition indicator */
59 uint16_t nlp_xri; /* output exchange id for RPI */
60 uint16_t nlp_sid; /* scsi id */
61#define NLP_NO_SID 0xffff
62 uint16_t nlp_maxframe; /* Max RCV frame size */
63 uint8_t nlp_class_sup; /* Supported Classes */
64 uint8_t nlp_retry; /* used for ELS retries */
65 uint8_t nlp_disc_refcnt; /* used for DSM */
66 uint8_t nlp_fcp_info; /* class info, bits 0-3 */
67#define NLP_FCP_2_DEVICE 0x10 /* FCP-2 device */
68
69 struct timer_list nlp_delayfunc; /* Used for delayed ELS cmds */
70 struct timer_list nlp_tmofunc; /* Used for nodev tmo */
71 struct fc_rport *rport; /* Corresponding FC transport
72 port structure */
73 struct lpfc_nodelist *nlp_rpi_hash_next;
74 struct lpfc_hba *nlp_phba;
75 struct lpfc_work_evt nodev_timeout_evt;
76 struct lpfc_work_evt els_retry_evt;
77};
78
79/* Defines for nlp_flag (uint32) */
80#define NLP_NO_LIST 0x0 /* Indicates immediately free node */
81#define NLP_UNUSED_LIST 0x1 /* Flg to indicate node will be freed */
82#define NLP_PLOGI_LIST 0x2 /* Flg to indicate sent PLOGI */
83#define NLP_ADISC_LIST 0x3 /* Flg to indicate sent ADISC */
84#define NLP_REGLOGIN_LIST 0x4 /* Flg to indicate sent REG_LOGIN */
85#define NLP_PRLI_LIST 0x5 /* Flg to indicate sent PRLI */
86#define NLP_UNMAPPED_LIST 0x6 /* Node is now unmapped */
87#define NLP_MAPPED_LIST 0x7 /* Node is now mapped */
88#define NLP_NPR_LIST 0x8 /* Node is in NPort Recovery state */
89#define NLP_JUST_DQ 0x9 /* just deque ndlp in lpfc_nlp_list */
90#define NLP_LIST_MASK 0xf /* mask to see what list node is on */
91#define NLP_PLOGI_SND 0x20 /* sent PLOGI request for this entry */
92#define NLP_PRLI_SND 0x40 /* sent PRLI request for this entry */
93#define NLP_ADISC_SND 0x80 /* sent ADISC request for this entry */
94#define NLP_LOGO_SND 0x100 /* sent LOGO request for this entry */
95#define NLP_RNID_SND 0x400 /* sent RNID request for this entry */
96#define NLP_ELS_SND_MASK 0x7e0 /* sent ELS request for this entry */
97#define NLP_NODEV_TMO 0x10000 /* nodev timeout is running for node */
98#define NLP_DELAY_TMO 0x20000 /* delay timeout is running for node */
99#define NLP_NPR_2B_DISC 0x40000 /* node is included in num_disc_nodes */
100#define NLP_RCV_PLOGI 0x80000 /* Rcv'ed PLOGI from remote system */
101#define NLP_LOGO_ACC 0x100000 /* Process LOGO after ACC completes */
102#define NLP_TGT_NO_SCSIID 0x200000 /* good PRLI but no binding for scsid */
103#define NLP_ACC_REGLOGIN 0x1000000 /* Issue Reg Login after successful
104 ACC */
105#define NLP_NPR_ADISC 0x2000000 /* Issue ADISC when dq'ed from
106 NPR list */
107#define NLP_DELAY_REMOVE 0x4000000 /* Defer removal till end of DSM */
108
109/* Defines for list searchs */
110#define NLP_SEARCH_MAPPED 0x1 /* search mapped */
111#define NLP_SEARCH_UNMAPPED 0x2 /* search unmapped */
112#define NLP_SEARCH_PLOGI 0x4 /* search plogi */
113#define NLP_SEARCH_ADISC 0x8 /* search adisc */
114#define NLP_SEARCH_REGLOGIN 0x10 /* search reglogin */
115#define NLP_SEARCH_PRLI 0x20 /* search prli */
116#define NLP_SEARCH_NPR 0x40 /* search npr */
117#define NLP_SEARCH_UNUSED 0x80 /* search mapped */
118#define NLP_SEARCH_ALL 0xff /* search all lists */
119
120/* There are 4 different double linked lists nodelist entries can reside on.
121 * The Port Login (PLOGI) list and Address Discovery (ADISC) list are used
122 * when Link Up discovery or Registered State Change Notification (RSCN)
123 * processing is needed. Each list holds the nodes that require a PLOGI or
124 * ADISC Extended Link Service (ELS) request. These lists keep track of the
125 * nodes affected by an RSCN, or a Link Up (Typically, all nodes are effected
126 * by Link Up) event. The unmapped_list contains all nodes that have
127 * successfully logged into at the Fibre Channel level. The
128 * mapped_list will contain all nodes that are mapped FCP targets.
129 *
130 * The bind list is a list of undiscovered (potentially non-existent) nodes
131 * that we have saved binding information on. This information is used when
132 * nodes transition from the unmapped to the mapped list.
133 */
134
135/* Defines for nlp_state */
136#define NLP_STE_UNUSED_NODE 0x0 /* node is just allocated */
137#define NLP_STE_PLOGI_ISSUE 0x1 /* PLOGI was sent to NL_PORT */
138#define NLP_STE_ADISC_ISSUE 0x2 /* ADISC was sent to NL_PORT */
139#define NLP_STE_REG_LOGIN_ISSUE 0x3 /* REG_LOGIN was issued for NL_PORT */
140#define NLP_STE_PRLI_ISSUE 0x4 /* PRLI was sent to NL_PORT */
141#define NLP_STE_UNMAPPED_NODE 0x5 /* PRLI completed from NL_PORT */
142#define NLP_STE_MAPPED_NODE 0x6 /* Identified as a FCP Target */
143#define NLP_STE_NPR_NODE 0x7 /* NPort disappeared */
144#define NLP_STE_MAX_STATE 0x8
145#define NLP_STE_FREED_NODE 0xff /* node entry was freed to MEM_NLP */
146
147/* For UNUSED_NODE state, the node has just been allocated.
148 * For PLOGI_ISSUE and REG_LOGIN_ISSUE, the node is on
149 * the PLOGI list. For REG_LOGIN_COMPL, the node is taken off the PLOGI list
150 * and put on the unmapped list. For ADISC processing, the node is taken off
151 * the ADISC list and placed on either the mapped or unmapped list (depending
152 * on its previous state). Once on the unmapped list, a PRLI is issued and the
153 * state changed to PRLI_ISSUE. When the PRLI completion occurs, the state is
154 * changed to PRLI_COMPL. If the completion indicates a mapped
155 * node, the node is taken off the unmapped list. The binding list is checked
156 * for a valid binding, or a binding is automatically assigned. If binding
157 * assignment is unsuccessful, the node is left on the unmapped list. If
158 * binding assignment is successful, the associated binding list entry (if
159 * any) is removed, and the node is placed on the mapped list.
160 */
161/*
162 * For a Link Down, all nodes on the ADISC, PLOGI, unmapped or mapped
163 * lists will receive a DEVICE_RECOVERY event. If the linkdown or nodev timers
164 * expire, all effected nodes will receive a DEVICE_RM event.
165 */
166/*
167 * For a Link Up or RSCN, all nodes will move from the mapped / unmapped lists
168 * to either the ADISC or PLOGI list. After a Nameserver query or ALPA loopmap
169 * check, additional nodes may be added (DEVICE_ADD) or removed (DEVICE_RM) to /
170 * from the PLOGI or ADISC lists. Once the PLOGI and ADISC lists are populated,
171 * we will first process the ADISC list. 32 entries are processed initially and
172 * ADISC is initited for each one. Completions / Events for each node are
173 * funnelled thru the state machine. As each node finishes ADISC processing, it
174 * starts ADISC for any nodes waiting for ADISC processing. If no nodes are
175 * waiting, and the ADISC list count is identically 0, then we are done. For
176 * Link Up discovery, since all nodes on the PLOGI list are UNREG_LOGIN'ed, we
177 * can issue a CLEAR_LA and reenable Link Events. Next we will process the PLOGI
178 * list. 32 entries are processed initially and PLOGI is initited for each one.
179 * Completions / Events for each node are funnelled thru the state machine. As
180 * each node finishes PLOGI processing, it starts PLOGI for any nodes waiting
181 * for PLOGI processing. If no nodes are waiting, and the PLOGI list count is
182 * identically 0, then we are done. We have now completed discovery / RSCN
183 * handling. Upon completion, ALL nodes should be on either the mapped or
184 * unmapped lists.
185 */
186
187/* Defines for Node List Entry Events that could happen */
188#define NLP_EVT_RCV_PLOGI 0x0 /* Rcv'd an ELS PLOGI command */
189#define NLP_EVT_RCV_PRLI 0x1 /* Rcv'd an ELS PRLI command */
190#define NLP_EVT_RCV_LOGO 0x2 /* Rcv'd an ELS LOGO command */
191#define NLP_EVT_RCV_ADISC 0x3 /* Rcv'd an ELS ADISC command */
192#define NLP_EVT_RCV_PDISC 0x4 /* Rcv'd an ELS PDISC command */
193#define NLP_EVT_RCV_PRLO 0x5 /* Rcv'd an ELS PRLO command */
194#define NLP_EVT_CMPL_PLOGI 0x6 /* Sent an ELS PLOGI command */
195#define NLP_EVT_CMPL_PRLI 0x7 /* Sent an ELS PRLI command */
196#define NLP_EVT_CMPL_LOGO 0x8 /* Sent an ELS LOGO command */
197#define NLP_EVT_CMPL_ADISC 0x9 /* Sent an ELS ADISC command */
198#define NLP_EVT_CMPL_REG_LOGIN 0xa /* REG_LOGIN mbox cmd completed */
199#define NLP_EVT_DEVICE_RM 0xb /* Device not found in NS / ALPAmap */
200#define NLP_EVT_DEVICE_RECOVERY 0xc /* Device existence unknown */
201#define NLP_EVT_MAX_EVENT 0xd
202