drivers/scsi/lpfc/lpfc_disc.h

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