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