linux/drivers/scsi/lpfc/lpfc_disc.h

/*******************************************************************
 * This file is part of the Emulex Linux Device Driver for         *
 * Fibre Channel Host Bus Adapters.                                *
 * Copyright (C) 2017-2022 Broadcom. All Rights Reserved. The term *
 * “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.     *
 * Copyright (C) 2004-2013 Emulex.  All rights reserved.           *
 * EMULEX and SLI are trademarks of Emulex.                        *
 * www.broadcom.com                                                *
 *                                                                 *
 * This program is free software; you can redistribute it and/or   *
 * modify it under the terms of version 2 of the GNU General       *
 * Public License as published by the Free Software Foundation.    *
 * This program is distributed in the hope that it will be useful. *
 * ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND          *
 * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,  *
 * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT, ARE      *
 * DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD *
 * TO BE LEGALLY INVALID.  See the GNU General Public License for  *
 * more details, a copy of which can be found in the file COPYING  *
 * included with this package.                                     *
 *******************************************************************/

#define FC_MAX_HOLD_RSCN
#define FC_MAX_NS_RSP
#define FC_MAXLOOP
#define LPFC_DISC_FLOGI_TMO


/* This is the protocol dependent definition for a Node List Entry.
 * This is used by Fibre Channel protocol to support FCP.
 */

/* worker thread events */
enum lpfc_work_type {};

/* structure used to queue event to the discovery tasklet */
struct lpfc_work_evt {};

struct lpfc_scsi_check_condition_event;
struct lpfc_scsi_varqueuedepth_event;
struct lpfc_scsi_event_header;
struct lpfc_fabric_event_header;
struct lpfc_fcprdchkerr_event;

/* structure used for sending events from fast path */
struct lpfc_fast_path_event {};

#define LPFC_SLI4_MAX_XRI
#define XRI_BITMAP_ULONGS
struct lpfc_node_rrqs {};

enum lpfc_fc4_xpt_flags {};

enum lpfc_nlp_save_flags {};

struct lpfc_nodelist {};

struct lpfc_node_rrq {};

#define lpfc_ndlp_check_qdepth(phba, ndlp)

/* Defines for nlp_flag (uint32) */
#define NLP_IGNR_REG_CMPL
#define NLP_REG_LOGIN_SEND
#define NLP_RELEASE_RPI
#define NLP_SUPPRESS_RSP
#define NLP_PLOGI_SND
#define NLP_PRLI_SND
#define NLP_ADISC_SND
#define NLP_LOGO_SND
#define NLP_RNID_SND
#define NLP_ELS_SND_MASK
#define NLP_NVMET_RECOV
#define NLP_UNREG_INP
#define NLP_DROPPED
#define NLP_DELAY_TMO
#define NLP_NPR_2B_DISC
#define NLP_RCV_PLOGI
#define NLP_LOGO_ACC
#define NLP_TGT_NO_SCSIID
#define NLP_ISSUE_LOGO
#define NLP_IN_DEV_LOSS
#define NLP_ACC_REGLOGIN
#define NLP_NPR_ADISC
#define NLP_RM_DFLT_RPI
#define NLP_NODEV_REMOVE
#define NLP_TARGET_REMOVE
#define NLP_SC_REQ
#define NLP_FIRSTBURST
#define NLP_RPI_REGISTERED

/* There are 4 different double linked lists nodelist entries can reside on.
 * The Port Login (PLOGI) list and Address Discovery (ADISC) list are used
 * when Link Up discovery or Registered State Change Notification (RSCN)
 * processing is needed.  Each list holds the nodes that require a PLOGI or
 * ADISC Extended Link Service (ELS) request.  These lists keep track of the
 * nodes affected by an RSCN, or a Link Up (Typically, all nodes are effected
 * by Link Up) event.  The unmapped_list contains all nodes that have
 * successfully logged into at the Fibre Channel level.  The
 * mapped_list will contain all nodes that are mapped FCP targets.
 *
 * The bind list is a list of undiscovered (potentially non-existent) nodes
 * that we have saved binding information on. This information is used when
 * nodes transition from the unmapped to the mapped list.
 */

/* Defines for nlp_state */
#define NLP_STE_UNUSED_NODE
#define NLP_STE_PLOGI_ISSUE
#define NLP_STE_ADISC_ISSUE
#define NLP_STE_REG_LOGIN_ISSUE
#define NLP_STE_PRLI_ISSUE
#define NLP_STE_LOGO_ISSUE
#define NLP_STE_UNMAPPED_NODE
#define NLP_STE_MAPPED_NODE
#define NLP_STE_NPR_NODE
#define NLP_STE_MAX_STATE
#define NLP_STE_FREED_NODE

/* For UNUSED_NODE state, the node has just been allocated.
 * For PLOGI_ISSUE and REG_LOGIN_ISSUE, the node is on
 * the PLOGI list. For REG_LOGIN_COMPL, the node is taken off the PLOGI list
 * and put on the unmapped list. For ADISC processing, the node is taken off
 * the ADISC list and placed on either the mapped or unmapped list (depending
 * on its previous state). Once on the unmapped list, a PRLI is issued and the
 * state changed to PRLI_ISSUE. When the PRLI completion occurs, the state is
 * changed to PRLI_COMPL. If the completion indicates a mapped
 * node, the node is taken off the unmapped list. The binding list is checked
 * for a valid binding, or a binding is automatically assigned. If binding
 * assignment is unsuccessful, the node is left on the unmapped list. If
 * binding assignment is successful, the associated binding list entry (if
 * any) is removed, and the node is placed on the mapped list.
 */
/*
 * For a Link Down, all nodes on the ADISC, PLOGI, unmapped or mapped
 * lists will receive a DEVICE_RECOVERY event. If the linkdown or devloss timers
 * expire, all effected nodes will receive a DEVICE_RM event.
 */
/*
 * For a Link Up or RSCN, all nodes will move from the mapped / unmapped lists
 * to either the ADISC or PLOGI list.  After a Nameserver query or ALPA loopmap
 * check, additional nodes may be added (DEVICE_ADD) or removed (DEVICE_RM) to /
 * from the PLOGI or ADISC lists. Once the PLOGI and ADISC lists are populated,
 * we will first process the ADISC list.  32 entries are processed initially and
 * ADISC is initited for each one.  Completions / Events for each node are
 * funnelled thru the state machine.  As each node finishes ADISC processing, it
 * starts ADISC for any nodes waiting for ADISC processing. If no nodes are
 * waiting, and the ADISC list count is identically 0, then we are done. For
 * Link Up discovery, since all nodes on the PLOGI list are UNREG_LOGIN'ed, we
 * can issue a CLEAR_LA and reenable Link Events. Next we will process the PLOGI
 * list.  32 entries are processed initially and PLOGI is initited for each one.
 * Completions / Events for each node are funnelled thru the state machine.  As
 * each node finishes PLOGI processing, it starts PLOGI for any nodes waiting
 * for PLOGI processing. If no nodes are waiting, and the PLOGI list count is
 * identically 0, then we are done. We have now completed discovery / RSCN
 * handling. Upon completion, ALL nodes should be on either the mapped or
 * unmapped lists.
 */

/* Defines for Node List Entry Events that could happen */
#define NLP_EVT_RCV_PLOGI
#define NLP_EVT_RCV_PRLI
#define NLP_EVT_RCV_LOGO
#define NLP_EVT_RCV_ADISC
#define NLP_EVT_RCV_PDISC
#define NLP_EVT_RCV_PRLO
#define NLP_EVT_CMPL_PLOGI
#define NLP_EVT_CMPL_PRLI
#define NLP_EVT_CMPL_LOGO
#define NLP_EVT_CMPL_ADISC
#define NLP_EVT_CMPL_REG_LOGIN
#define NLP_EVT_DEVICE_RM
#define NLP_EVT_DEVICE_RECOVERY
#define NLP_EVT_MAX_EVENT
#define NLP_EVT_NOTHING_PENDING