]> git.karo-electronics.de Git - mv-sheeva.git/blobdiff - drivers/scsi/bfa/bfa_fcs.h
Merge tag 'v2.6.37' of git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6
[mv-sheeva.git] / drivers / scsi / bfa / bfa_fcs.h
diff --git a/drivers/scsi/bfa/bfa_fcs.h b/drivers/scsi/bfa/bfa_fcs.h
new file mode 100644 (file)
index 0000000..9cb6a55
--- /dev/null
@@ -0,0 +1,766 @@
+/*
+ * Copyright (c) 2005-2010 Brocade Communications Systems, Inc.
+ * All rights reserved
+ * www.brocade.com
+ *
+ * Linux driver for Brocade Fibre Channel Host Bus Adapter.
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License (GPL) Version 2 as
+ * published by the Free Software Foundation
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ */
+
+#ifndef __BFA_FCS_H__
+#define __BFA_FCS_H__
+
+#include "bfa_cs.h"
+#include "bfa_defs.h"
+#include "bfa_defs_fcs.h"
+#include "bfa_modules.h"
+#include "bfa_fc.h"
+
+#define BFA_FCS_OS_STR_LEN             64
+
+/*
+ * !!! Only append to the enums defined here to avoid any versioning
+ * !!! needed between trace utility and driver version
+ */
+enum {
+       BFA_TRC_FCS_FCS         = 1,
+       BFA_TRC_FCS_PORT        = 2,
+       BFA_TRC_FCS_RPORT       = 3,
+       BFA_TRC_FCS_FCPIM       = 4,
+};
+
+
+struct bfa_fcs_s;
+
+#define __fcs_min_cfg(__fcs)       ((__fcs)->min_cfg)
+void bfa_fcs_modexit_comp(struct bfa_fcs_s *fcs);
+
+#define BFA_FCS_BRCD_SWITCH_OUI  0x051e
+#define N2N_LOCAL_PID      0x010000
+#define N2N_REMOTE_PID         0x020000
+#define        BFA_FCS_RETRY_TIMEOUT 2000
+#define BFA_FCS_PID_IS_WKA(pid)  ((bfa_os_ntoh3b(pid) > 0xFFF000) ?  1 : 0)
+
+
+
+struct bfa_fcs_lport_ns_s {
+       bfa_sm_t        sm;             /*  state machine */
+       struct bfa_timer_s timer;
+       struct bfa_fcs_lport_s *port;   /*  parent port */
+       struct bfa_fcxp_s *fcxp;
+       struct bfa_fcxp_wqe_s fcxp_wqe;
+};
+
+
+struct bfa_fcs_lport_scn_s {
+       bfa_sm_t        sm;             /*  state machine */
+       struct bfa_timer_s timer;
+       struct bfa_fcs_lport_s *port;   /*  parent port */
+       struct bfa_fcxp_s *fcxp;
+       struct bfa_fcxp_wqe_s fcxp_wqe;
+};
+
+
+struct bfa_fcs_lport_fdmi_s {
+       bfa_sm_t        sm;             /*  state machine */
+       struct bfa_timer_s timer;
+       struct bfa_fcs_lport_ms_s *ms;  /*  parent ms */
+       struct bfa_fcxp_s *fcxp;
+       struct bfa_fcxp_wqe_s fcxp_wqe;
+       u8      retry_cnt;      /*  retry count */
+       u8      rsvd[3];
+};
+
+
+struct bfa_fcs_lport_ms_s {
+       bfa_sm_t        sm;             /*  state machine */
+       struct bfa_timer_s timer;
+       struct bfa_fcs_lport_s *port;   /*  parent port */
+       struct bfa_fcxp_s *fcxp;
+       struct bfa_fcxp_wqe_s fcxp_wqe;
+       struct bfa_fcs_lport_fdmi_s fdmi;       /*  FDMI component of MS */
+       u8         retry_cnt;   /*  retry count */
+       u8      rsvd[3];
+};
+
+
+struct bfa_fcs_lport_fab_s {
+       struct bfa_fcs_lport_ns_s ns;   /*  NS component of port */
+       struct bfa_fcs_lport_scn_s scn; /*  scn component of port */
+       struct bfa_fcs_lport_ms_s ms;   /*  MS component of port */
+};
+
+#define        MAX_ALPA_COUNT  127
+
+struct bfa_fcs_lport_loop_s {
+       u8         num_alpa;    /*  Num of ALPA entries in the map */
+       u8         alpa_pos_map[MAX_ALPA_COUNT];        /*  ALPA Positional
+                                                        *Map */
+       struct bfa_fcs_lport_s *port;   /*  parent port */
+};
+
+struct bfa_fcs_lport_n2n_s {
+       u32        rsvd;
+       u16        reply_oxid;  /*  ox_id from the req flogi to be
+                                        *used in flogi acc */
+       wwn_t           rem_port_wwn;   /*  Attached port's wwn */
+};
+
+
+union bfa_fcs_lport_topo_u {
+       struct bfa_fcs_lport_fab_s pfab;
+       struct bfa_fcs_lport_loop_s ploop;
+       struct bfa_fcs_lport_n2n_s pn2n;
+};
+
+
+struct bfa_fcs_lport_s {
+       struct list_head         qe;    /*  used by port/vport */
+       bfa_sm_t               sm;      /*  state machine */
+       struct bfa_fcs_fabric_s *fabric;        /*  parent fabric */
+       struct bfa_lport_cfg_s  port_cfg;       /*  port configuration */
+       struct bfa_timer_s link_timer;  /*  timer for link offline */
+       u32        pid:24;      /*  FC address */
+       u8         lp_tag;              /*  lport tag */
+       u16        num_rports;  /*  Num of r-ports */
+       struct list_head         rport_q; /*  queue of discovered r-ports */
+       struct bfa_fcs_s *fcs;  /*  FCS instance */
+       union bfa_fcs_lport_topo_u port_topo;   /*  fabric/loop/n2n details */
+       struct bfad_port_s *bfad_port;  /*  driver peer instance */
+       struct bfa_fcs_vport_s *vport;  /*  NULL for base ports */
+       struct bfa_fcxp_s *fcxp;
+       struct bfa_fcxp_wqe_s fcxp_wqe;
+       struct bfa_lport_stats_s stats;
+       struct bfa_wc_s        wc;      /*  waiting counter for events */
+};
+#define BFA_FCS_GET_HAL_FROM_PORT(port)  (port->fcs->bfa)
+#define BFA_FCS_GET_NS_FROM_PORT(port)  (&port->port_topo.pfab.ns)
+#define BFA_FCS_GET_SCN_FROM_PORT(port)  (&port->port_topo.pfab.scn)
+#define BFA_FCS_GET_MS_FROM_PORT(port)  (&port->port_topo.pfab.ms)
+#define BFA_FCS_GET_FDMI_FROM_PORT(port)  (&port->port_topo.pfab.ms.fdmi)
+#define        BFA_FCS_VPORT_IS_INITIATOR_MODE(port) \
+               (port->port_cfg.roles & BFA_LPORT_ROLE_FCP_IM)
+
+/*
+ * forward declaration
+ */
+struct bfad_vf_s;
+
+enum bfa_fcs_fabric_type {
+       BFA_FCS_FABRIC_UNKNOWN = 0,
+       BFA_FCS_FABRIC_SWITCHED = 1,
+       BFA_FCS_FABRIC_N2N = 2,
+};
+
+
+struct bfa_fcs_fabric_s {
+       struct list_head   qe;          /*  queue element */
+       bfa_sm_t         sm;            /*  state machine */
+       struct bfa_fcs_s *fcs;          /*  FCS instance */
+       struct bfa_fcs_lport_s  bport;  /*  base logical port */
+       enum bfa_fcs_fabric_type fab_type; /*  fabric type */
+       enum bfa_port_type oper_type;   /*  current link topology */
+       u8         is_vf;               /*  is virtual fabric? */
+       u8         is_npiv;     /*  is NPIV supported ? */
+       u8         is_auth;     /*  is Security/Auth supported ? */
+       u16        bb_credit;   /*  BB credit from fabric */
+       u16        vf_id;               /*  virtual fabric ID */
+       u16        num_vports;  /*  num vports */
+       u16        rsvd;
+       struct list_head         vport_q;       /*  queue of virtual ports */
+       struct list_head         vf_q;  /*  queue of virtual fabrics */
+       struct bfad_vf_s      *vf_drv;  /*  driver vf structure */
+       struct bfa_timer_s link_timer;  /*  Link Failure timer. Vport */
+       wwn_t           fabric_name;    /*  attached fabric name */
+       bfa_boolean_t   auth_reqd;      /*  authentication required     */
+       struct bfa_timer_s delay_timer; /*  delay timer         */
+       union {
+               u16        swp_vfid;/*  switch port VF id               */
+       } event_arg;
+       struct bfa_wc_s        wc;      /*  wait counter for delete     */
+       struct bfa_vf_stats_s   stats;  /*  fabric/vf stats             */
+       struct bfa_lps_s        *lps;   /*  lport login services        */
+       u8      fabric_ip_addr[BFA_FCS_FABRIC_IPADDR_SZ];
+                                       /*  attached fabric's ip addr  */
+};
+
+#define bfa_fcs_fabric_npiv_capable(__f)    ((__f)->is_npiv)
+#define bfa_fcs_fabric_is_switched(__f)                        \
+       ((__f)->fab_type == BFA_FCS_FABRIC_SWITCHED)
+
+/*
+ *   The design calls for a single implementation of base fabric and vf.
+ */
+#define bfa_fcs_vf_t struct bfa_fcs_fabric_s
+
+struct bfa_vf_event_s {
+       u32        undefined;
+};
+
+struct bfa_fcs_s;
+struct bfa_fcs_fabric_s;
+
+/*
+ * @todo : need to move to a global config file.
+ * Maximum Rports supported per port (physical/logical).
+ */
+#define BFA_FCS_MAX_RPORTS_SUPP  256   /* @todo : tentative value */
+
+#define bfa_fcs_lport_t struct bfa_fcs_lport_s
+
+/*
+ * Symbolic Name related defines
+ *  Total bytes 255.
+ *  Physical Port's symbolic name 128 bytes.
+ *  For Vports, Vport's symbolic name is appended to the Physical port's
+ *  Symbolic Name.
+ *
+ *  Physical Port's symbolic name Format : (Total 128 bytes)
+ *  Adapter Model number/name : 12 bytes
+ *  Driver Version     : 10 bytes
+ *  Host Machine Name  : 30 bytes
+ *  Host OS Info          : 48 bytes
+ *  Host OS PATCH Info : 16 bytes
+ *  ( remaining 12 bytes reserved to be used for separator)
+ */
+#define BFA_FCS_PORT_SYMBNAME_SEPARATOR                        " | "
+
+#define BFA_FCS_PORT_SYMBNAME_MODEL_SZ                 12
+#define BFA_FCS_PORT_SYMBNAME_VERSION_SZ               10
+#define BFA_FCS_PORT_SYMBNAME_MACHINENAME_SZ           30
+#define BFA_FCS_PORT_SYMBNAME_OSINFO_SZ                        48
+#define BFA_FCS_PORT_SYMBNAME_OSPATCH_SZ               16
+
+/*
+ * Get FC port ID for a logical port.
+ */
+#define bfa_fcs_lport_get_fcid(_lport) ((_lport)->pid)
+#define bfa_fcs_lport_get_pwwn(_lport) ((_lport)->port_cfg.pwwn)
+#define bfa_fcs_lport_get_nwwn(_lport) ((_lport)->port_cfg.nwwn)
+#define bfa_fcs_lport_get_psym_name(_lport)    ((_lport)->port_cfg.sym_name)
+#define bfa_fcs_lport_is_initiator(_lport)                     \
+       ((_lport)->port_cfg.roles & BFA_LPORT_ROLE_FCP_IM)
+#define bfa_fcs_lport_get_nrports(_lport)      \
+       ((_lport) ? (_lport)->num_rports : 0)
+
+static inline struct bfad_port_s *
+bfa_fcs_lport_get_drvport(struct bfa_fcs_lport_s *port)
+{
+       return port->bfad_port;
+}
+
+#define bfa_fcs_lport_get_opertype(_lport)     ((_lport)->fabric->oper_type)
+#define bfa_fcs_lport_get_fabric_name(_lport)  ((_lport)->fabric->fabric_name)
+#define bfa_fcs_lport_get_fabric_ipaddr(_lport)                \
+               ((_lport)->fabric->fabric_ip_addr)
+
+/*
+ * bfa fcs port public functions
+ */
+
+bfa_boolean_t   bfa_fcs_lport_is_online(struct bfa_fcs_lport_s *port);
+struct bfa_fcs_lport_s *bfa_fcs_get_base_port(struct bfa_fcs_s *fcs);
+void bfa_fcs_lport_get_rports(struct bfa_fcs_lport_s *port,
+                             wwn_t rport_wwns[], int *nrports);
+
+wwn_t bfa_fcs_lport_get_rport(struct bfa_fcs_lport_s *port, wwn_t wwn,
+                             int index, int nrports, bfa_boolean_t bwwn);
+
+struct bfa_fcs_lport_s *bfa_fcs_lookup_port(struct bfa_fcs_s *fcs,
+                                           u16 vf_id, wwn_t lpwwn);
+
+void bfa_fcs_lport_get_info(struct bfa_fcs_lport_s *port,
+                           struct bfa_lport_info_s *port_info);
+void bfa_fcs_lport_get_attr(struct bfa_fcs_lport_s *port,
+                           struct bfa_lport_attr_s *port_attr);
+void bfa_fcs_lport_get_stats(struct bfa_fcs_lport_s *fcs_port,
+                            struct bfa_lport_stats_s *port_stats);
+void bfa_fcs_lport_clear_stats(struct bfa_fcs_lport_s *fcs_port);
+enum bfa_port_speed bfa_fcs_lport_get_rport_max_speed(
+                       struct bfa_fcs_lport_s *port);
+
+/* MS FCS routines */
+void bfa_fcs_lport_ms_init(struct bfa_fcs_lport_s *port);
+void bfa_fcs_lport_ms_offline(struct bfa_fcs_lport_s *port);
+void bfa_fcs_lport_ms_online(struct bfa_fcs_lport_s *port);
+void bfa_fcs_lport_ms_fabric_rscn(struct bfa_fcs_lport_s *port);
+
+/* FDMI FCS routines */
+void bfa_fcs_lport_fdmi_init(struct bfa_fcs_lport_ms_s *ms);
+void bfa_fcs_lport_fdmi_offline(struct bfa_fcs_lport_ms_s *ms);
+void bfa_fcs_lport_fdmi_online(struct bfa_fcs_lport_ms_s *ms);
+void bfa_fcs_lport_uf_recv(struct bfa_fcs_lport_s *lport, struct fchs_s *fchs,
+                                    u16 len);
+void bfa_fcs_lport_attach(struct bfa_fcs_lport_s *lport, struct bfa_fcs_s *fcs,
+                       u16 vf_id, struct bfa_fcs_vport_s *vport);
+void bfa_fcs_lport_init(struct bfa_fcs_lport_s *lport,
+                               struct bfa_lport_cfg_s *port_cfg);
+void            bfa_fcs_lport_online(struct bfa_fcs_lport_s *port);
+void            bfa_fcs_lport_offline(struct bfa_fcs_lport_s *port);
+void            bfa_fcs_lport_delete(struct bfa_fcs_lport_s *port);
+struct bfa_fcs_rport_s *bfa_fcs_lport_get_rport_by_pid(
+               struct bfa_fcs_lport_s *port, u32 pid);
+struct bfa_fcs_rport_s *bfa_fcs_lport_get_rport_by_pwwn(
+               struct bfa_fcs_lport_s *port, wwn_t pwwn);
+struct bfa_fcs_rport_s *bfa_fcs_lport_get_rport_by_nwwn(
+               struct bfa_fcs_lport_s *port, wwn_t nwwn);
+void            bfa_fcs_lport_add_rport(struct bfa_fcs_lport_s *port,
+                                      struct bfa_fcs_rport_s *rport);
+void            bfa_fcs_lport_del_rport(struct bfa_fcs_lport_s *port,
+                                      struct bfa_fcs_rport_s *rport);
+void bfa_fcs_lport_modinit(struct bfa_fcs_s *fcs);
+void bfa_fcs_lport_modexit(struct bfa_fcs_s *fcs);
+void            bfa_fcs_lport_ns_init(struct bfa_fcs_lport_s *vport);
+void            bfa_fcs_lport_ns_offline(struct bfa_fcs_lport_s *vport);
+void            bfa_fcs_lport_ns_online(struct bfa_fcs_lport_s *vport);
+void            bfa_fcs_lport_ns_query(struct bfa_fcs_lport_s *port);
+void            bfa_fcs_lport_scn_init(struct bfa_fcs_lport_s *vport);
+void            bfa_fcs_lport_scn_offline(struct bfa_fcs_lport_s *vport);
+void            bfa_fcs_lport_scn_online(struct bfa_fcs_lport_s *vport);
+void            bfa_fcs_lport_scn_process_rscn(struct bfa_fcs_lport_s *port,
+                                             struct fchs_s *rx_frame, u32 len);
+
+struct bfa_fcs_vport_s {
+       struct list_head                qe;             /*  queue elem  */
+       bfa_sm_t                sm;             /*  state machine       */
+       bfa_fcs_lport_t         lport;          /*  logical port        */
+       struct bfa_timer_s      timer;
+       struct bfad_vport_s     *vport_drv;     /*  Driver private      */
+       struct bfa_vport_stats_s vport_stats;   /*  vport statistics    */
+       struct bfa_lps_s        *lps;           /*  Lport login service*/
+       int                     fdisc_retries;
+};
+
+#define bfa_fcs_vport_get_port(vport)                  \
+       ((struct bfa_fcs_lport_s  *)(&vport->port))
+
+/*
+ * bfa fcs vport public functions
+ */
+bfa_status_t bfa_fcs_vport_create(struct bfa_fcs_vport_s *vport,
+                                 struct bfa_fcs_s *fcs, u16 vf_id,
+                                 struct bfa_lport_cfg_s *port_cfg,
+                                 struct bfad_vport_s *vport_drv);
+bfa_status_t bfa_fcs_pbc_vport_create(struct bfa_fcs_vport_s *vport,
+                                     struct bfa_fcs_s *fcs, u16 vf_id,
+                                     struct bfa_lport_cfg_s *port_cfg,
+                                     struct bfad_vport_s *vport_drv);
+bfa_boolean_t bfa_fcs_is_pbc_vport(struct bfa_fcs_vport_s *vport);
+bfa_status_t bfa_fcs_vport_delete(struct bfa_fcs_vport_s *vport);
+bfa_status_t bfa_fcs_vport_start(struct bfa_fcs_vport_s *vport);
+bfa_status_t bfa_fcs_vport_stop(struct bfa_fcs_vport_s *vport);
+void bfa_fcs_vport_get_attr(struct bfa_fcs_vport_s *vport,
+                           struct bfa_vport_attr_s *vport_attr);
+void bfa_fcs_vport_get_stats(struct bfa_fcs_vport_s *vport,
+                            struct bfa_vport_stats_s *vport_stats);
+void bfa_fcs_vport_clr_stats(struct bfa_fcs_vport_s *vport);
+struct bfa_fcs_vport_s *bfa_fcs_vport_lookup(struct bfa_fcs_s *fcs,
+                                            u16 vf_id, wwn_t vpwwn);
+void bfa_fcs_vport_cleanup(struct bfa_fcs_vport_s *vport);
+void bfa_fcs_vport_online(struct bfa_fcs_vport_s *vport);
+void bfa_fcs_vport_offline(struct bfa_fcs_vport_s *vport);
+void bfa_fcs_vport_delete_comp(struct bfa_fcs_vport_s *vport);
+void bfa_fcs_vport_fcs_delete(struct bfa_fcs_vport_s *vport);
+
+#define BFA_FCS_RPORT_DEF_DEL_TIMEOUT  90      /* in secs */
+#define BFA_FCS_RPORT_MAX_RETRIES      (5)
+
+/*
+ * forward declarations
+ */
+struct bfad_rport_s;
+
+struct bfa_fcs_itnim_s;
+struct bfa_fcs_tin_s;
+struct bfa_fcs_iprp_s;
+
+/* Rport Features (RPF) */
+struct bfa_fcs_rpf_s {
+       bfa_sm_t        sm;     /*  state machine */
+       struct bfa_fcs_rport_s *rport;  /*  parent rport */
+       struct bfa_timer_s      timer;  /*  general purpose timer */
+       struct bfa_fcxp_s       *fcxp;  /*  FCXP needed for discarding */
+       struct bfa_fcxp_wqe_s   fcxp_wqe; /*  fcxp wait queue element */
+       int     rpsc_retries;   /*  max RPSC retry attempts */
+       enum bfa_port_speed     rpsc_speed;
+       /*  Current Speed from RPSC. O if RPSC fails */
+       enum bfa_port_speed     assigned_speed;
+       /*
+        * Speed assigned by the user.  will be used if RPSC is
+        * not supported by the rport.
+        */
+};
+
+struct bfa_fcs_rport_s {
+       struct list_head        qe;     /*  used by port/vport */
+       struct bfa_fcs_lport_s *port;   /*  parent FCS port */
+       struct bfa_fcs_s        *fcs;   /*  fcs instance */
+       struct bfad_rport_s     *rp_drv;        /*  driver peer instance */
+       u32     pid;    /*  port ID of rport */
+       u16     maxfrsize;      /*  maximum frame size */
+       u16     reply_oxid;     /*  OX_ID of inbound requests */
+       enum fc_cos     fc_cos; /*  FC classes of service supp */
+       bfa_boolean_t   cisc;   /*  CISC capable device */
+       bfa_boolean_t   prlo;   /*  processing prlo or LOGO */
+       wwn_t   pwwn;   /*  port wwn of rport */
+       wwn_t   nwwn;   /*  node wwn of rport */
+       struct bfa_rport_symname_s psym_name; /*  port symbolic name  */
+       bfa_sm_t        sm;             /*  state machine */
+       struct bfa_timer_s timer;       /*  general purpose timer */
+       struct bfa_fcs_itnim_s *itnim;  /*  ITN initiator mode role */
+       struct bfa_fcs_tin_s *tin;      /*  ITN initiator mode role */
+       struct bfa_fcs_iprp_s *iprp;    /*  IP/FC role */
+       struct bfa_rport_s *bfa_rport;  /*  BFA Rport */
+       struct bfa_fcxp_s *fcxp;        /*  FCXP needed for discarding */
+       int     plogi_retries;  /*  max plogi retry attempts */
+       int     ns_retries;     /*  max NS query retry attempts */
+       struct bfa_fcxp_wqe_s   fcxp_wqe; /*  fcxp wait queue element */
+       struct bfa_rport_stats_s stats; /*  rport stats */
+       enum bfa_rport_function scsi_function;  /*  Initiator/Target */
+       struct bfa_fcs_rpf_s rpf;       /* Rport features module */
+};
+
+static inline struct bfa_rport_s *
+bfa_fcs_rport_get_halrport(struct bfa_fcs_rport_s *rport)
+{
+       return rport->bfa_rport;
+}
+
+/*
+ * bfa fcs rport API functions
+ */
+bfa_status_t bfa_fcs_rport_add(struct bfa_fcs_lport_s *port, wwn_t *pwwn,
+                              struct bfa_fcs_rport_s *rport,
+                              struct bfad_rport_s *rport_drv);
+bfa_status_t bfa_fcs_rport_remove(struct bfa_fcs_rport_s *rport);
+void bfa_fcs_rport_get_attr(struct bfa_fcs_rport_s *rport,
+                           struct bfa_rport_attr_s *attr);
+void bfa_fcs_rport_get_stats(struct bfa_fcs_rport_s *rport,
+                            struct bfa_rport_stats_s *stats);
+void bfa_fcs_rport_clear_stats(struct bfa_fcs_rport_s *rport);
+struct bfa_fcs_rport_s *bfa_fcs_rport_lookup(struct bfa_fcs_lport_s *port,
+                                            wwn_t rpwwn);
+struct bfa_fcs_rport_s *bfa_fcs_rport_lookup_by_nwwn(
+       struct bfa_fcs_lport_s *port, wwn_t rnwwn);
+void bfa_fcs_rport_set_del_timeout(u8 rport_tmo);
+
+void bfa_fcs_rport_set_speed(struct bfa_fcs_rport_s *rport,
+                            enum bfa_port_speed speed);
+void bfa_fcs_rport_uf_recv(struct bfa_fcs_rport_s *rport,
+        struct fchs_s *fchs, u16 len);
+void bfa_fcs_rport_scn(struct bfa_fcs_rport_s *rport);
+
+struct bfa_fcs_rport_s *bfa_fcs_rport_create(struct bfa_fcs_lport_s *port,
+        u32 pid);
+void bfa_fcs_rport_delete(struct bfa_fcs_rport_s *rport);
+void bfa_fcs_rport_online(struct bfa_fcs_rport_s *rport);
+void bfa_fcs_rport_offline(struct bfa_fcs_rport_s *rport);
+void bfa_fcs_rport_start(struct bfa_fcs_lport_s *port, struct fchs_s *rx_fchs,
+                        struct fc_logi_s *plogi_rsp);
+void bfa_fcs_rport_plogi_create(struct bfa_fcs_lport_s *port,
+                               struct fchs_s *rx_fchs,
+                               struct fc_logi_s *plogi);
+void bfa_fcs_rport_plogi(struct bfa_fcs_rport_s *rport, struct fchs_s *fchs,
+                        struct fc_logi_s *plogi);
+void bfa_fcs_rport_logo_imp(struct bfa_fcs_rport_s *rport);
+void bfa_fcs_rport_prlo(struct bfa_fcs_rport_s *rport, u16 ox_id);
+
+void bfa_fcs_rport_itnim_ack(struct bfa_fcs_rport_s *rport);
+void bfa_fcs_rport_itntm_ack(struct bfa_fcs_rport_s *rport);
+void bfa_fcs_rport_fcptm_offline_done(struct bfa_fcs_rport_s *rport);
+int  bfa_fcs_rport_get_state(struct bfa_fcs_rport_s *rport);
+struct bfa_fcs_rport_s *bfa_fcs_rport_create_by_wwn(
+                       struct bfa_fcs_lport_s *port, wwn_t wwn);
+void  bfa_fcs_rpf_init(struct bfa_fcs_rport_s *rport);
+void  bfa_fcs_rpf_rport_online(struct bfa_fcs_rport_s *rport);
+void  bfa_fcs_rpf_rport_offline(struct bfa_fcs_rport_s *rport);
+
+/*
+ * forward declarations
+ */
+struct bfad_itnim_s;
+
+struct bfa_fcs_itnim_s {
+       bfa_sm_t                sm;             /*  state machine */
+       struct bfa_fcs_rport_s  *rport;         /*  parent remote rport  */
+       struct bfad_itnim_s     *itnim_drv;     /*  driver peer instance */
+       struct bfa_fcs_s        *fcs;           /*  fcs instance        */
+       struct bfa_timer_s      timer;          /*  timer functions     */
+       struct bfa_itnim_s      *bfa_itnim;     /*  BFA itnim struct    */
+       u32             prli_retries;   /*  max prli retry attempts */
+       bfa_boolean_t           seq_rec;        /*  seq recovery support */
+       bfa_boolean_t           rec_support;    /*  REC supported       */
+       bfa_boolean_t           conf_comp;      /*  FCP_CONF    support */
+       bfa_boolean_t           task_retry_id;  /*  task retry id supp  */
+       struct bfa_fcxp_wqe_s   fcxp_wqe;       /*  wait qelem for fcxp  */
+       struct bfa_fcxp_s       *fcxp;          /*  FCXP in use */
+       struct bfa_itnim_stats_s        stats;  /*  itn statistics      */
+};
+#define bfa_fcs_fcxp_alloc(__fcs)      \
+       bfa_fcxp_alloc(NULL, (__fcs)->bfa, 0, 0, NULL, NULL, NULL, NULL)
+
+#define bfa_fcs_fcxp_alloc_wait(__bfa, __wqe, __alloc_cbfn, __alloc_cbarg) \
+       bfa_fcxp_alloc_wait(__bfa, __wqe, __alloc_cbfn, __alloc_cbarg, \
+                                       NULL, 0, 0, NULL, NULL, NULL, NULL)
+
+static inline struct bfad_port_s *
+bfa_fcs_itnim_get_drvport(struct bfa_fcs_itnim_s *itnim)
+{
+       return itnim->rport->port->bfad_port;
+}
+
+
+static inline struct bfa_fcs_lport_s *
+bfa_fcs_itnim_get_port(struct bfa_fcs_itnim_s *itnim)
+{
+       return itnim->rport->port;
+}
+
+
+static inline wwn_t
+bfa_fcs_itnim_get_nwwn(struct bfa_fcs_itnim_s *itnim)
+{
+       return itnim->rport->nwwn;
+}
+
+
+static inline wwn_t
+bfa_fcs_itnim_get_pwwn(struct bfa_fcs_itnim_s *itnim)
+{
+       return itnim->rport->pwwn;
+}
+
+
+static inline u32
+bfa_fcs_itnim_get_fcid(struct bfa_fcs_itnim_s *itnim)
+{
+       return itnim->rport->pid;
+}
+
+
+static inline  u32
+bfa_fcs_itnim_get_maxfrsize(struct bfa_fcs_itnim_s *itnim)
+{
+       return itnim->rport->maxfrsize;
+}
+
+
+static inline  enum fc_cos
+bfa_fcs_itnim_get_cos(struct bfa_fcs_itnim_s *itnim)
+{
+       return itnim->rport->fc_cos;
+}
+
+
+static inline struct bfad_itnim_s *
+bfa_fcs_itnim_get_drvitn(struct bfa_fcs_itnim_s *itnim)
+{
+       return itnim->itnim_drv;
+}
+
+
+static inline struct bfa_itnim_s *
+bfa_fcs_itnim_get_halitn(struct bfa_fcs_itnim_s *itnim)
+{
+       return itnim->bfa_itnim;
+}
+
+/*
+ * bfa fcs FCP Initiator mode API functions
+ */
+void bfa_fcs_itnim_get_attr(struct bfa_fcs_itnim_s *itnim,
+                           struct bfa_itnim_attr_s *attr);
+void bfa_fcs_itnim_get_stats(struct bfa_fcs_itnim_s *itnim,
+                            struct bfa_itnim_stats_s *stats);
+struct bfa_fcs_itnim_s *bfa_fcs_itnim_lookup(struct bfa_fcs_lport_s *port,
+                                            wwn_t rpwwn);
+bfa_status_t bfa_fcs_itnim_attr_get(struct bfa_fcs_lport_s *port, wwn_t rpwwn,
+                                   struct bfa_itnim_attr_s *attr);
+bfa_status_t bfa_fcs_itnim_stats_get(struct bfa_fcs_lport_s *port, wwn_t rpwwn,
+                                    struct bfa_itnim_stats_s *stats);
+bfa_status_t bfa_fcs_itnim_stats_clear(struct bfa_fcs_lport_s *port,
+                                      wwn_t rpwwn);
+struct bfa_fcs_itnim_s *bfa_fcs_itnim_create(struct bfa_fcs_rport_s *rport);
+void bfa_fcs_itnim_delete(struct bfa_fcs_itnim_s *itnim);
+void bfa_fcs_itnim_rport_offline(struct bfa_fcs_itnim_s *itnim);
+void bfa_fcs_itnim_rport_online(struct bfa_fcs_itnim_s *itnim);
+bfa_status_t bfa_fcs_itnim_get_online_state(struct bfa_fcs_itnim_s *itnim);
+void bfa_fcs_itnim_is_initiator(struct bfa_fcs_itnim_s *itnim);
+void bfa_fcs_fcpim_uf_recv(struct bfa_fcs_itnim_s *itnim,
+                       struct fchs_s *fchs, u16 len);
+
+#define        BFA_FCS_FDMI_SUPORTED_SPEEDS  (FDMI_TRANS_SPEED_1G  |   \
+                                      FDMI_TRANS_SPEED_2G |    \
+                                      FDMI_TRANS_SPEED_4G |    \
+                                      FDMI_TRANS_SPEED_8G)
+
+/*
+ * HBA Attribute Block : BFA internal representation. Note : Some variable
+ * sizes have been trimmed to suit BFA For Ex : Model will be "Brocade". Based
+ * on this the size has been reduced to 16 bytes from the standard's 64 bytes.
+ */
+struct bfa_fcs_fdmi_hba_attr_s {
+       wwn_t           node_name;
+       u8         manufacturer[64];
+       u8         serial_num[64];
+       u8         model[16];
+       u8         model_desc[256];
+       u8         hw_version[8];
+       u8         driver_version[8];
+       u8         option_rom_ver[BFA_VERSION_LEN];
+       u8         fw_version[8];
+       u8         os_name[256];
+       u32        max_ct_pyld;
+};
+
+/*
+ * Port Attribute Block
+ */
+struct bfa_fcs_fdmi_port_attr_s {
+       u8         supp_fc4_types[32];  /* supported FC4 types */
+       u32        supp_speed;  /* supported speed */
+       u32        curr_speed;  /* current Speed */
+       u32        max_frm_size;        /* max frame size */
+       u8         os_device_name[256]; /* OS device Name */
+       u8         host_name[256];      /* host name */
+};
+
+struct bfa_fcs_stats_s {
+       struct {
+               u32     untagged; /*  untagged receive frames */
+               u32     tagged; /*  tagged receive frames */
+               u32     vfid_unknown;   /*  VF id is unknown */
+       } uf;
+};
+
+struct bfa_fcs_driver_info_s {
+       u8       version[BFA_VERSION_LEN];              /* Driver Version */
+       u8       host_machine_name[BFA_FCS_OS_STR_LEN];
+       u8       host_os_name[BFA_FCS_OS_STR_LEN]; /* OS name and version */
+       u8       host_os_patch[BFA_FCS_OS_STR_LEN]; /* patch or service pack */
+       u8       os_device_name[BFA_FCS_OS_STR_LEN]; /* Driver Device Name */
+};
+
+struct bfa_fcs_s {
+       struct bfa_s      *bfa; /*  corresponding BFA bfa instance */
+       struct bfad_s         *bfad; /*  corresponding BDA driver instance */
+       struct bfa_trc_mod_s  *trcmod;  /*  tracing module */
+       bfa_boolean_t   vf_enabled;     /*  VF mode is enabled */
+       bfa_boolean_t   fdmi_enabled;   /*  FDMI is enabled */
+       bfa_boolean_t min_cfg;          /* min cfg enabled/disabled */
+       u16     port_vfid;      /*  port default VF ID */
+       struct bfa_fcs_driver_info_s driver_info;
+       struct bfa_fcs_fabric_s fabric; /*  base fabric state machine */
+       struct bfa_fcs_stats_s  stats;  /*  FCS statistics */
+       struct bfa_wc_s         wc;     /*  waiting counter */
+};
+
+/*
+ * bfa fcs API functions
+ */
+void bfa_fcs_attach(struct bfa_fcs_s *fcs, struct bfa_s *bfa,
+                   struct bfad_s *bfad,
+                   bfa_boolean_t min_cfg);
+void bfa_fcs_init(struct bfa_fcs_s *fcs);
+void bfa_fcs_driver_info_init(struct bfa_fcs_s *fcs,
+                             struct bfa_fcs_driver_info_s *driver_info);
+void bfa_fcs_set_fdmi_param(struct bfa_fcs_s *fcs, bfa_boolean_t fdmi_enable);
+void bfa_fcs_exit(struct bfa_fcs_s *fcs);
+void bfa_fcs_trc_init(struct bfa_fcs_s *fcs, struct bfa_trc_mod_s *trcmod);
+void           bfa_fcs_start(struct bfa_fcs_s *fcs);
+
+/*
+ * bfa fcs vf public functions
+ */
+bfa_fcs_vf_t *bfa_fcs_vf_lookup(struct bfa_fcs_s *fcs, u16 vf_id);
+u16 bfa_fcs_fabric_vport_count(struct bfa_fcs_fabric_s *fabric);
+
+/*
+ * fabric protected interface functions
+ */
+void bfa_fcs_fabric_attach(struct bfa_fcs_s *fcs);
+void bfa_fcs_fabric_modinit(struct bfa_fcs_s *fcs);
+void bfa_fcs_fabric_modexit(struct bfa_fcs_s *fcs);
+void bfa_fcs_fabric_modsusp(struct bfa_fcs_s *fcs);
+void bfa_fcs_fabric_link_up(struct bfa_fcs_fabric_s *fabric);
+void bfa_fcs_fabric_link_down(struct bfa_fcs_fabric_s *fabric);
+void bfa_fcs_fabric_addvport(struct bfa_fcs_fabric_s *fabric,
+       struct bfa_fcs_vport_s *vport);
+void bfa_fcs_fabric_delvport(struct bfa_fcs_fabric_s *fabric,
+       struct bfa_fcs_vport_s *vport);
+int bfa_fcs_fabric_is_online(struct bfa_fcs_fabric_s *fabric);
+struct bfa_fcs_vport_s *bfa_fcs_fabric_vport_lookup(
+               struct bfa_fcs_fabric_s *fabric, wwn_t pwwn);
+void bfa_fcs_fabric_modstart(struct bfa_fcs_s *fcs);
+void bfa_fcs_fabric_uf_recv(struct bfa_fcs_fabric_s *fabric,
+               struct fchs_s *fchs, u16 len);
+bfa_boolean_t  bfa_fcs_fabric_is_loopback(struct bfa_fcs_fabric_s *fabric);
+bfa_boolean_t  bfa_fcs_fabric_is_auth_failed(struct bfa_fcs_fabric_s *fabric);
+enum bfa_port_type bfa_fcs_fabric_port_type(struct bfa_fcs_fabric_s *fabric);
+void   bfa_fcs_fabric_psymb_init(struct bfa_fcs_fabric_s *fabric);
+void   bfa_fcs_fabric_port_delete_comp(struct bfa_fcs_fabric_s *fabric);
+bfa_status_t   bfa_fcs_fabric_addvf(struct bfa_fcs_fabric_s *vf,
+                       struct bfa_fcs_s *fcs, struct bfa_lport_cfg_s *port_cfg,
+                       struct bfad_vf_s *vf_drv);
+void bfa_fcs_fabric_set_fabric_name(struct bfa_fcs_fabric_s *fabric,
+              wwn_t fabric_name);
+u16 bfa_fcs_fabric_get_switch_oui(struct bfa_fcs_fabric_s *fabric);
+void bfa_fcs_uf_attach(struct bfa_fcs_s *fcs);
+void bfa_fcs_port_attach(struct bfa_fcs_s *fcs);
+
+/*
+ * BFA FCS callback interfaces
+ */
+
+/*
+ * fcb Main fcs callbacks
+ */
+
+struct bfad_port_s;
+struct bfad_vf_s;
+struct bfad_vport_s;
+struct bfad_rport_s;
+
+/*
+ * lport callbacks
+ */
+struct bfad_port_s *bfa_fcb_lport_new(struct bfad_s *bfad,
+                                     struct bfa_fcs_lport_s *port,
+                                     enum bfa_lport_role roles,
+                                     struct bfad_vf_s *vf_drv,
+                                     struct bfad_vport_s *vp_drv);
+void bfa_fcb_lport_delete(struct bfad_s *bfad, enum bfa_lport_role roles,
+                         struct bfad_vf_s *vf_drv,
+                         struct bfad_vport_s *vp_drv);
+
+/*
+ * vport callbacks
+ */
+void bfa_fcb_pbc_vport_create(struct bfad_s *bfad, struct bfi_pbc_vport_s);
+
+/*
+ * rport callbacks
+ */
+bfa_status_t bfa_fcb_rport_alloc(struct bfad_s *bfad,
+                                struct bfa_fcs_rport_s **rport,
+                                struct bfad_rport_s **rport_drv);
+
+/*
+ * itnim callbacks
+ */
+void bfa_fcb_itnim_alloc(struct bfad_s *bfad, struct bfa_fcs_itnim_s **itnim,
+                        struct bfad_itnim_s **itnim_drv);
+void bfa_fcb_itnim_free(struct bfad_s *bfad,
+                       struct bfad_itnim_s *itnim_drv);
+void bfa_fcb_itnim_online(struct bfad_itnim_s *itnim_drv);
+void bfa_fcb_itnim_offline(struct bfad_itnim_s *itnim_drv);
+
+#endif /* __BFA_FCS_H__ */