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