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