drivers/scsi/bfa/bfa_fcs.h

   1 /*
   2  * Copyright (c) 2005-2010 Brocade Communications Systems, Inc.
   3  * All rights reserved
   4  * www.brocade.com
   5  *
   6  * Linux driver for Brocade Fibre Channel Host Bus Adapter.
   7  *
   8  * This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU General Public License (GPL) Version 2 as
  10  * published by the Free Software Foundation
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  */
  17
  18 #ifndef __BFA_FCS_H__
  19 #define __BFA_FCS_H__
  20
  21 #include "bfa_cs.h"
  22 #include "bfa_defs.h"
  23 #include "bfa_defs_fcs.h"
  24 #include "bfa_modules.h"
  25 #include "bfa_fc.h"
  26
  27 #define BFA_FCS_OS_STR_LEN              64
  28
  29 /*
  30  *  lps_pvt BFA LPS private functions
  31  */
  32
  33 enum bfa_lps_event {
  34         BFA_LPS_SM_LOGIN        = 1,    /* login request from user      */
  35         BFA_LPS_SM_LOGOUT       = 2,    /* logout request from user     */
  36         BFA_LPS_SM_FWRSP        = 3,    /* f/w response to login/logout */
  37         BFA_LPS_SM_RESUME       = 4,    /* space present in reqq queue  */
  38         BFA_LPS_SM_DELETE       = 5,    /* lps delete from user         */
  39         BFA_LPS_SM_OFFLINE      = 6,    /* Link is offline              */
  40         BFA_LPS_SM_RX_CVL       = 7,    /* Rx clear virtual link        */
  41         BFA_LPS_SM_SET_N2N_PID  = 8,    /* Set assigned PID for n2n */
  42 };
  43
  44
  45 /*
  46  * !!! Only append to the enums defined here to avoid any versioning
  47  * !!! needed between trace utility and driver version
  48  */
  49 enum {
  50         BFA_TRC_FCS_FCS         = 1,
  51         BFA_TRC_FCS_PORT        = 2,
  52         BFA_TRC_FCS_RPORT       = 3,
  53         BFA_TRC_FCS_FCPIM       = 4,
  54 };
  55
  56
  57 struct bfa_fcs_s;
  58
  59 #define __fcs_min_cfg(__fcs)       ((__fcs)->min_cfg)
  60
  61 #define BFA_FCS_BRCD_SWITCH_OUI  0x051e
  62 #define N2N_LOCAL_PID       0x010000
  63 #define N2N_REMOTE_PID          0x020000
  64 #define BFA_FCS_RETRY_TIMEOUT 2000
  65 #define BFA_FCS_PID_IS_WKA(pid)  ((bfa_ntoh3b(pid) > 0xFFF000) ?  1 : 0)
  66
  67
  68
  69 struct bfa_fcs_lport_ns_s {
  70         bfa_sm_t        sm;             /*  state machine */
  71         struct bfa_timer_s timer;
  72         struct bfa_fcs_lport_s *port;   /*  parent port */
  73         struct bfa_fcxp_s *fcxp;
  74         struct bfa_fcxp_wqe_s fcxp_wqe;
  75 };
  76
  77
  78 struct bfa_fcs_lport_scn_s {
  79         bfa_sm_t        sm;             /*  state machine */
  80         struct bfa_timer_s timer;
  81         struct bfa_fcs_lport_s *port;   /*  parent port */
  82         struct bfa_fcxp_s *fcxp;
  83         struct bfa_fcxp_wqe_s fcxp_wqe;
  84 };
  85
  86
  87 struct bfa_fcs_lport_fdmi_s {
  88         bfa_sm_t        sm;             /*  state machine */
  89         struct bfa_timer_s timer;
  90         struct bfa_fcs_lport_ms_s *ms;  /*  parent ms */
  91         struct bfa_fcxp_s *fcxp;
  92         struct bfa_fcxp_wqe_s fcxp_wqe;
  93         u8      retry_cnt;      /*  retry count */
  94         u8      rsvd[3];
  95 };
  96
  97
  98 struct bfa_fcs_lport_ms_s {
  99         bfa_sm_t        sm;             /*  state machine */
 100         struct bfa_timer_s timer;
 101         struct bfa_fcs_lport_s *port;   /*  parent port */
 102         struct bfa_fcxp_s *fcxp;
 103         struct bfa_fcxp_wqe_s fcxp_wqe;
 104         struct bfa_fcs_lport_fdmi_s fdmi;       /*  FDMI component of MS */
 105         u8         retry_cnt;   /*  retry count */
 106         u8      rsvd[3];
 107 };
 108
 109
 110 struct bfa_fcs_lport_fab_s {
 111         struct bfa_fcs_lport_ns_s ns;   /*  NS component of port */
 112         struct bfa_fcs_lport_scn_s scn; /*  scn component of port */
 113         struct bfa_fcs_lport_ms_s ms;   /*  MS component of port */
 114 };
 115
 116 #define MAX_ALPA_COUNT  127
 117
 118 struct bfa_fcs_lport_loop_s {
 119         u8         num_alpa;    /*  Num of ALPA entries in the map */
 120         u8         alpa_pos_map[MAX_ALPA_COUNT];        /*  ALPA Positional
 121                                                          *Map */
 122         struct bfa_fcs_lport_s *port;   /*  parent port */
 123 };
 124
 125 struct bfa_fcs_lport_n2n_s {
 126         u32        rsvd;
 127         __be16     reply_oxid;  /*  ox_id from the req flogi to be
 128                                          *used in flogi acc */
 129         wwn_t           rem_port_wwn;   /*  Attached port's wwn */
 130 };
 131
 132
 133 union bfa_fcs_lport_topo_u {
 134         struct bfa_fcs_lport_fab_s pfab;
 135         struct bfa_fcs_lport_loop_s ploop;
 136         struct bfa_fcs_lport_n2n_s pn2n;
 137 };
 138
 139
 140 struct bfa_fcs_lport_s {
 141         struct list_head         qe;    /*  used by port/vport */
 142         bfa_sm_t               sm;      /*  state machine */
 143         struct bfa_fcs_fabric_s *fabric;        /*  parent fabric */
 144         struct bfa_lport_cfg_s  port_cfg;       /*  port configuration */
 145         struct bfa_timer_s link_timer;  /*  timer for link offline */
 146         u32        pid:24;      /*  FC address */
 147         u8         lp_tag;              /*  lport tag */
 148         u16        num_rports;  /*  Num of r-ports */
 149         struct list_head         rport_q; /*  queue of discovered r-ports */
 150         struct bfa_fcs_s *fcs;  /*  FCS instance */
 151         union bfa_fcs_lport_topo_u port_topo;   /*  fabric/loop/n2n details */
 152         struct bfad_port_s *bfad_port;  /*  driver peer instance */
 153         struct bfa_fcs_vport_s *vport;  /*  NULL for base ports */
 154         struct bfa_fcxp_s *fcxp;
 155         struct bfa_fcxp_wqe_s fcxp_wqe;
 156         struct bfa_lport_stats_s stats;
 157         struct bfa_wc_s        wc;      /*  waiting counter for events */
 158 };
 159 #define BFA_FCS_GET_HAL_FROM_PORT(port)  (port->fcs->bfa)
 160 #define BFA_FCS_GET_NS_FROM_PORT(port)  (&port->port_topo.pfab.ns)
 161 #define BFA_FCS_GET_SCN_FROM_PORT(port)  (&port->port_topo.pfab.scn)
 162 #define BFA_FCS_GET_MS_FROM_PORT(port)  (&port->port_topo.pfab.ms)
 163 #define BFA_FCS_GET_FDMI_FROM_PORT(port)  (&port->port_topo.pfab.ms.fdmi)
 164 #define BFA_FCS_VPORT_IS_INITIATOR_MODE(port) \
 165                 (port->port_cfg.roles & BFA_LPORT_ROLE_FCP_IM)
 166
 167 /*
 168  * forward declaration
 169  */
 170 struct bfad_vf_s;
 171
 172 enum bfa_fcs_fabric_type {
 173         BFA_FCS_FABRIC_UNKNOWN = 0,
 174         BFA_FCS_FABRIC_SWITCHED = 1,
 175         BFA_FCS_FABRIC_N2N = 2,
 176 };
 177
 178
 179 struct bfa_fcs_fabric_s {
 180         struct list_head   qe;          /*  queue element */
 181         bfa_sm_t         sm;            /*  state machine */
 182         struct bfa_fcs_s *fcs;          /*  FCS instance */
 183         struct bfa_fcs_lport_s  bport;  /*  base logical port */
 184         enum bfa_fcs_fabric_type fab_type; /*  fabric type */
 185         enum bfa_port_type oper_type;   /*  current link topology */
 186         u8         is_vf;               /*  is virtual fabric? */
 187         u8         is_npiv;     /*  is NPIV supported ? */
 188         u8         is_auth;     /*  is Security/Auth supported ? */
 189         u16        bb_credit;   /*  BB credit from fabric */
 190         u16        vf_id;               /*  virtual fabric ID */
 191         u16        num_vports;  /*  num vports */
 192         u16        rsvd;
 193         struct list_head         vport_q;       /*  queue of virtual ports */
 194         struct list_head         vf_q;  /*  queue of virtual fabrics */
 195         struct bfad_vf_s      *vf_drv;  /*  driver vf structure */
 196         struct bfa_timer_s link_timer;  /*  Link Failure timer. Vport */
 197         wwn_t           fabric_name;    /*  attached fabric name */
 198         bfa_boolean_t   auth_reqd;      /*  authentication required     */
 199         struct bfa_timer_s delay_timer; /*  delay timer         */
 200         union {
 201                 u16        swp_vfid;/*  switch port VF id               */
 202         } event_arg;
 203         struct bfa_wc_s        wc;      /*  wait counter for delete     */
 204         struct bfa_vf_stats_s   stats;  /*  fabric/vf stats             */
 205         struct bfa_lps_s        *lps;   /*  lport login services        */
 206         u8      fabric_ip_addr[BFA_FCS_FABRIC_IPADDR_SZ];
 207                                         /*  attached fabric's ip addr  */
 208 };
 209
 210 #define bfa_fcs_fabric_npiv_capable(__f)    ((__f)->is_npiv)
 211 #define bfa_fcs_fabric_is_switched(__f)                 \
 212         ((__f)->fab_type == BFA_FCS_FABRIC_SWITCHED)
 213
 214 /*
 215  *   The design calls for a single implementation of base fabric and vf.
 216  */
 217 #define bfa_fcs_vf_t struct bfa_fcs_fabric_s
 218
 219 struct bfa_vf_event_s {
 220         u32        undefined;
 221 };
 222
 223 struct bfa_fcs_s;
 224 struct bfa_fcs_fabric_s;
 225
 226 /*
 227  * @todo : need to move to a global config file.
 228  * Maximum Rports supported per port (physical/logical).
 229  */
 230 #define BFA_FCS_MAX_RPORTS_SUPP  256    /* @todo : tentative value */
 231
 232 #define bfa_fcs_lport_t struct bfa_fcs_lport_s
 233
 234 /*
 235  * Symbolic Name related defines
 236  *  Total bytes 255.
 237  *  Physical Port's symbolic name 128 bytes.
 238  *  For Vports, Vport's symbolic name is appended to the Physical port's
 239  *  Symbolic Name.
 240  *
 241  *  Physical Port's symbolic name Format : (Total 128 bytes)
 242  *  Adapter Model number/name : 12 bytes
 243  *  Driver Version     : 10 bytes
 244  *  Host Machine Name  : 30 bytes
 245  *  Host OS Info           : 48 bytes
 246  *  Host OS PATCH Info : 16 bytes
 247  *  ( remaining 12 bytes reserved to be used for separator)
 248  */
 249 #define BFA_FCS_PORT_SYMBNAME_SEPARATOR                 " | "
 250
 251 #define BFA_FCS_PORT_SYMBNAME_MODEL_SZ                  12
 252 #define BFA_FCS_PORT_SYMBNAME_VERSION_SZ                10
 253 #define BFA_FCS_PORT_SYMBNAME_MACHINENAME_SZ            30
 254 #define BFA_FCS_PORT_SYMBNAME_OSINFO_SZ                 48
 255 #define BFA_FCS_PORT_SYMBNAME_OSPATCH_SZ                16
 256
 257 /*
 258  * Get FC port ID for a logical port.
 259  */
 260 #define bfa_fcs_lport_get_fcid(_lport)  ((_lport)->pid)
 261 #define bfa_fcs_lport_get_pwwn(_lport)  ((_lport)->port_cfg.pwwn)
 262 #define bfa_fcs_lport_get_nwwn(_lport)  ((_lport)->port_cfg.nwwn)
 263 #define bfa_fcs_lport_get_psym_name(_lport)     ((_lport)->port_cfg.sym_name)
 264 #define bfa_fcs_lport_is_initiator(_lport)                      \
 265         ((_lport)->port_cfg.roles & BFA_LPORT_ROLE_FCP_IM)
 266 #define bfa_fcs_lport_get_nrports(_lport)       \
 267         ((_lport) ? (_lport)->num_rports : 0)
 268
 269 static inline struct bfad_port_s *
 270 bfa_fcs_lport_get_drvport(struct bfa_fcs_lport_s *port)
 271 {
 272         return port->bfad_port;
 273 }
 274
 275 #define bfa_fcs_lport_get_opertype(_lport)      ((_lport)->fabric->oper_type)
 276 #define bfa_fcs_lport_get_fabric_name(_lport)   ((_lport)->fabric->fabric_name)
 277 #define bfa_fcs_lport_get_fabric_ipaddr(_lport)         \
 278                 ((_lport)->fabric->fabric_ip_addr)
 279
 280 /*
 281  * bfa fcs port public functions
 282  */
 283
 284 bfa_boolean_t   bfa_fcs_lport_is_online(struct bfa_fcs_lport_s *port);
 285 struct bfa_fcs_lport_s *bfa_fcs_get_base_port(struct bfa_fcs_s *fcs);
 286 void bfa_fcs_lport_get_rports(struct bfa_fcs_lport_s *port,
 287                               wwn_t rport_wwns[], int *nrports);
 288
 289 wwn_t bfa_fcs_lport_get_rport(struct bfa_fcs_lport_s *port, wwn_t wwn,
 290                               int index, int nrports, bfa_boolean_t bwwn);
 291
 292 struct bfa_fcs_lport_s *bfa_fcs_lookup_port(struct bfa_fcs_s *fcs,
 293                                             u16 vf_id, wwn_t lpwwn);
 294
 295 void bfa_fcs_lport_get_info(struct bfa_fcs_lport_s *port,
 296                             struct bfa_lport_info_s *port_info);
 297 void bfa_fcs_lport_get_attr(struct bfa_fcs_lport_s *port,
 298                             struct bfa_lport_attr_s *port_attr);
 299 void bfa_fcs_lport_get_stats(struct bfa_fcs_lport_s *fcs_port,
 300                              struct bfa_lport_stats_s *port_stats);
 301 void bfa_fcs_lport_clear_stats(struct bfa_fcs_lport_s *fcs_port);
 302 enum bfa_port_speed bfa_fcs_lport_get_rport_max_speed(
 303                         struct bfa_fcs_lport_s *port);
 304
 305 /* MS FCS routines */
 306 void bfa_fcs_lport_ms_init(struct bfa_fcs_lport_s *port);
 307 void bfa_fcs_lport_ms_offline(struct bfa_fcs_lport_s *port);
 308 void bfa_fcs_lport_ms_online(struct bfa_fcs_lport_s *port);
 309 void bfa_fcs_lport_ms_fabric_rscn(struct bfa_fcs_lport_s *port);
 310
 311 /* FDMI FCS routines */
 312 void bfa_fcs_lport_fdmi_init(struct bfa_fcs_lport_ms_s *ms);
 313 void bfa_fcs_lport_fdmi_offline(struct bfa_fcs_lport_ms_s *ms);
 314 void bfa_fcs_lport_fdmi_online(struct bfa_fcs_lport_ms_s *ms);
 315 void bfa_fcs_lport_uf_recv(struct bfa_fcs_lport_s *lport, struct fchs_s *fchs,
 316                                      u16 len);
 317 void bfa_fcs_lport_attach(struct bfa_fcs_lport_s *lport, struct bfa_fcs_s *fcs,
 318                         u16 vf_id, struct bfa_fcs_vport_s *vport);
 319 void bfa_fcs_lport_init(struct bfa_fcs_lport_s *lport,
 320                                 struct bfa_lport_cfg_s *port_cfg);
 321 void            bfa_fcs_lport_online(struct bfa_fcs_lport_s *port);
 322 void            bfa_fcs_lport_offline(struct bfa_fcs_lport_s *port);
 323 void            bfa_fcs_lport_delete(struct bfa_fcs_lport_s *port);
 324 struct bfa_fcs_rport_s *bfa_fcs_lport_get_rport_by_pid(
 325                 struct bfa_fcs_lport_s *port, u32 pid);
 326 struct bfa_fcs_rport_s *bfa_fcs_lport_get_rport_by_pwwn(
 327                 struct bfa_fcs_lport_s *port, wwn_t pwwn);
 328 struct bfa_fcs_rport_s *bfa_fcs_lport_get_rport_by_nwwn(
 329                 struct bfa_fcs_lport_s *port, wwn_t nwwn);
 330 void            bfa_fcs_lport_add_rport(struct bfa_fcs_lport_s *port,
 331                                        struct bfa_fcs_rport_s *rport);
 332 void            bfa_fcs_lport_del_rport(struct bfa_fcs_lport_s *port,
 333                                        struct bfa_fcs_rport_s *rport);
 334 void            bfa_fcs_lport_ns_init(struct bfa_fcs_lport_s *vport);
 335 void            bfa_fcs_lport_ns_offline(struct bfa_fcs_lport_s *vport);
 336 void            bfa_fcs_lport_ns_online(struct bfa_fcs_lport_s *vport);
 337 void            bfa_fcs_lport_ns_query(struct bfa_fcs_lport_s *port);
 338 void            bfa_fcs_lport_scn_init(struct bfa_fcs_lport_s *vport);
 339 void            bfa_fcs_lport_scn_offline(struct bfa_fcs_lport_s *vport);
 340 void            bfa_fcs_lport_scn_online(struct bfa_fcs_lport_s *vport);
 341 void            bfa_fcs_lport_scn_process_rscn(struct bfa_fcs_lport_s *port,
 342                                               struct fchs_s *rx_frame, u32 len);
 343
 344 struct bfa_fcs_vport_s {
 345         struct list_head                qe;             /*  queue elem  */
 346         bfa_sm_t                sm;             /*  state machine       */
 347         bfa_fcs_lport_t         lport;          /*  logical port        */
 348         struct bfa_timer_s      timer;
 349         struct bfad_vport_s     *vport_drv;     /*  Driver private      */
 350         struct bfa_vport_stats_s vport_stats;   /*  vport statistics    */
 351         struct bfa_lps_s        *lps;           /*  Lport login service*/
 352         int                     fdisc_retries;
 353 };
 354
 355 #define bfa_fcs_vport_get_port(vport)                   \
 356         ((struct bfa_fcs_lport_s  *)(&vport->port))
 357
 358 /*
 359  * bfa fcs vport public functions
 360  */
 361 bfa_status_t bfa_fcs_vport_create(struct bfa_fcs_vport_s *vport,
 362                                   struct bfa_fcs_s *fcs, u16 vf_id,
 363                                   struct bfa_lport_cfg_s *port_cfg,
 364                                   struct bfad_vport_s *vport_drv);
 365 bfa_status_t bfa_fcs_pbc_vport_create(struct bfa_fcs_vport_s *vport,
 366                                       struct bfa_fcs_s *fcs, u16 vf_id,
 367                                       struct bfa_lport_cfg_s *port_cfg,
 368                                       struct bfad_vport_s *vport_drv);
 369 bfa_boolean_t bfa_fcs_is_pbc_vport(struct bfa_fcs_vport_s *vport);
 370 bfa_status_t bfa_fcs_vport_delete(struct bfa_fcs_vport_s *vport);
 371 bfa_status_t bfa_fcs_vport_start(struct bfa_fcs_vport_s *vport);
 372 bfa_status_t bfa_fcs_vport_stop(struct bfa_fcs_vport_s *vport);
 373 void bfa_fcs_vport_get_attr(struct bfa_fcs_vport_s *vport,
 374                             struct bfa_vport_attr_s *vport_attr);
 375 struct bfa_fcs_vport_s *bfa_fcs_vport_lookup(struct bfa_fcs_s *fcs,
 376                                              u16 vf_id, wwn_t vpwwn);
 377 void bfa_fcs_vport_cleanup(struct bfa_fcs_vport_s *vport);
 378 void bfa_fcs_vport_online(struct bfa_fcs_vport_s *vport);
 379 void bfa_fcs_vport_offline(struct bfa_fcs_vport_s *vport);
 380 void bfa_fcs_vport_delete_comp(struct bfa_fcs_vport_s *vport);
 381 void bfa_fcs_vport_fcs_delete(struct bfa_fcs_vport_s *vport);
 382
 383 #define BFA_FCS_RPORT_DEF_DEL_TIMEOUT   90      /* in secs */
 384 #define BFA_FCS_RPORT_MAX_RETRIES       (5)
 385
 386 /*
 387  * forward declarations
 388  */
 389 struct bfad_rport_s;
 390
 391 struct bfa_fcs_itnim_s;
 392 struct bfa_fcs_tin_s;
 393 struct bfa_fcs_iprp_s;
 394
 395 /* Rport Features (RPF) */
 396 struct bfa_fcs_rpf_s {
 397         bfa_sm_t        sm;     /*  state machine */
 398         struct bfa_fcs_rport_s *rport;  /*  parent rport */
 399         struct bfa_timer_s      timer;  /*  general purpose timer */
 400         struct bfa_fcxp_s       *fcxp;  /*  FCXP needed for discarding */
 401         struct bfa_fcxp_wqe_s   fcxp_wqe; /*  fcxp wait queue element */
 402         int     rpsc_retries;   /*  max RPSC retry attempts */
 403         enum bfa_port_speed     rpsc_speed;
 404         /*  Current Speed from RPSC. O if RPSC fails */
 405         enum bfa_port_speed     assigned_speed;
 406         /*
 407          * Speed assigned by the user.  will be used if RPSC is
 408          * not supported by the rport.
 409          */
 410 };
 411
 412 struct bfa_fcs_rport_s {
 413         struct list_head        qe;     /*  used by port/vport */
 414         struct bfa_fcs_lport_s *port;   /*  parent FCS port */
 415         struct bfa_fcs_s        *fcs;   /*  fcs instance */
 416         struct bfad_rport_s     *rp_drv;        /*  driver peer instance */
 417         u32     pid;    /*  port ID of rport */
 418         u16     maxfrsize;      /*  maximum frame size */
 419         __be16  reply_oxid;     /*  OX_ID of inbound requests */
 420         enum fc_cos     fc_cos; /*  FC classes of service supp */
 421         bfa_boolean_t   cisc;   /*  CISC capable device */
 422         bfa_boolean_t   prlo;   /*  processing prlo or LOGO */
 423         wwn_t   pwwn;   /*  port wwn of rport */
 424         wwn_t   nwwn;   /*  node wwn of rport */
 425         struct bfa_rport_symname_s psym_name; /*  port symbolic name  */
 426         bfa_sm_t        sm;             /*  state machine */
 427         struct bfa_timer_s timer;       /*  general purpose timer */
 428         struct bfa_fcs_itnim_s *itnim;  /*  ITN initiator mode role */
 429         struct bfa_fcs_tin_s *tin;      /*  ITN initiator mode role */
 430         struct bfa_fcs_iprp_s *iprp;    /*  IP/FC role */
 431         struct bfa_rport_s *bfa_rport;  /*  BFA Rport */
 432         struct bfa_fcxp_s *fcxp;        /*  FCXP needed for discarding */
 433         int     plogi_retries;  /*  max plogi retry attempts */
 434         int     ns_retries;     /*  max NS query retry attempts */
 435         struct bfa_fcxp_wqe_s   fcxp_wqe; /*  fcxp wait queue element */
 436         struct bfa_rport_stats_s stats; /*  rport stats */
 437         enum bfa_rport_function scsi_function;  /*  Initiator/Target */
 438         struct bfa_fcs_rpf_s rpf;       /* Rport features module */
 439 };
 440
 441 static inline struct bfa_rport_s *
 442 bfa_fcs_rport_get_halrport(struct bfa_fcs_rport_s *rport)
 443 {
 444         return rport->bfa_rport;
 445 }
 446
 447 /*
 448  * bfa fcs rport API functions
 449  */
 450 struct bfa_fcs_rport_s *bfa_fcs_rport_lookup(struct bfa_fcs_lport_s *port,
 451                                              wwn_t rpwwn);
 452 struct bfa_fcs_rport_s *bfa_fcs_rport_lookup_by_nwwn(
 453         struct bfa_fcs_lport_s *port, wwn_t rnwwn);
 454 void bfa_fcs_rport_set_del_timeout(u8 rport_tmo);
 455
 456 void bfa_fcs_rport_uf_recv(struct bfa_fcs_rport_s *rport,
 457          struct fchs_s *fchs, u16 len);
 458 void bfa_fcs_rport_scn(struct bfa_fcs_rport_s *rport);
 459
 460 struct bfa_fcs_rport_s *bfa_fcs_rport_create(struct bfa_fcs_lport_s *port,
 461          u32 pid);
 462 void bfa_fcs_rport_start(struct bfa_fcs_lport_s *port, struct fchs_s *rx_fchs,
 463                          struct fc_logi_s *plogi_rsp);
 464 void bfa_fcs_rport_plogi_create(struct bfa_fcs_lport_s *port,
 465                                 struct fchs_s *rx_fchs,
 466                                 struct fc_logi_s *plogi);
 467 void bfa_fcs_rport_plogi(struct bfa_fcs_rport_s *rport, struct fchs_s *fchs,
 468                          struct fc_logi_s *plogi);
 469 void bfa_fcs_rport_prlo(struct bfa_fcs_rport_s *rport, __be16 ox_id);
 470
 471 void bfa_fcs_rport_itntm_ack(struct bfa_fcs_rport_s *rport);
 472 void bfa_fcs_rport_fcptm_offline_done(struct bfa_fcs_rport_s *rport);
 473 int  bfa_fcs_rport_get_state(struct bfa_fcs_rport_s *rport);
 474 struct bfa_fcs_rport_s *bfa_fcs_rport_create_by_wwn(
 475                         struct bfa_fcs_lport_s *port, wwn_t wwn);
 476 void  bfa_fcs_rpf_init(struct bfa_fcs_rport_s *rport);
 477 void  bfa_fcs_rpf_rport_online(struct bfa_fcs_rport_s *rport);
 478 void  bfa_fcs_rpf_rport_offline(struct bfa_fcs_rport_s *rport);
 479
 480 /*
 481  * forward declarations
 482  */
 483 struct bfad_itnim_s;
 484
 485 struct bfa_fcs_itnim_s {
 486         bfa_sm_t                sm;             /*  state machine */
 487         struct bfa_fcs_rport_s  *rport;         /*  parent remote rport  */
 488         struct bfad_itnim_s     *itnim_drv;     /*  driver peer instance */
 489         struct bfa_fcs_s        *fcs;           /*  fcs instance        */
 490         struct bfa_timer_s      timer;          /*  timer functions     */
 491         struct bfa_itnim_s      *bfa_itnim;     /*  BFA itnim struct    */
 492         u32             prli_retries;   /*  max prli retry attempts */
 493         bfa_boolean_t           seq_rec;        /*  seq recovery support */
 494         bfa_boolean_t           rec_support;    /*  REC supported       */
 495         bfa_boolean_t           conf_comp;      /*  FCP_CONF    support */
 496         bfa_boolean_t           task_retry_id;  /*  task retry id supp  */
 497         struct bfa_fcxp_wqe_s   fcxp_wqe;       /*  wait qelem for fcxp  */
 498         struct bfa_fcxp_s       *fcxp;          /*  FCXP in use */
 499         struct bfa_itnim_stats_s        stats;  /*  itn statistics      */
 500 };
 501 #define bfa_fcs_fcxp_alloc(__fcs)       \
 502         bfa_fcxp_alloc(NULL, (__fcs)->bfa, 0, 0, NULL, NULL, NULL, NULL)
 503
 504 #define bfa_fcs_fcxp_alloc_wait(__bfa, __wqe, __alloc_cbfn, __alloc_cbarg) \
 505         bfa_fcxp_alloc_wait(__bfa, __wqe, __alloc_cbfn, __alloc_cbarg, \
 506                                         NULL, 0, 0, NULL, NULL, NULL, NULL)
 507
 508 static inline struct bfad_port_s *
 509 bfa_fcs_itnim_get_drvport(struct bfa_fcs_itnim_s *itnim)
 510 {
 511         return itnim->rport->port->bfad_port;
 512 }
 513
 514
 515 static inline struct bfa_fcs_lport_s *
 516 bfa_fcs_itnim_get_port(struct bfa_fcs_itnim_s *itnim)
 517 {
 518         return itnim->rport->port;
 519 }
 520
 521
 522 static inline wwn_t
 523 bfa_fcs_itnim_get_nwwn(struct bfa_fcs_itnim_s *itnim)
 524 {
 525         return itnim->rport->nwwn;
 526 }
 527
 528
 529 static inline wwn_t
 530 bfa_fcs_itnim_get_pwwn(struct bfa_fcs_itnim_s *itnim)
 531 {
 532         return itnim->rport->pwwn;
 533 }
 534
 535
 536 static inline u32
 537 bfa_fcs_itnim_get_fcid(struct bfa_fcs_itnim_s *itnim)
 538 {
 539         return itnim->rport->pid;
 540 }
 541
 542
 543 static inline   u32
 544 bfa_fcs_itnim_get_maxfrsize(struct bfa_fcs_itnim_s *itnim)
 545 {
 546         return itnim->rport->maxfrsize;
 547 }
 548
 549
 550 static inline   enum fc_cos
 551 bfa_fcs_itnim_get_cos(struct bfa_fcs_itnim_s *itnim)
 552 {
 553         return itnim->rport->fc_cos;
 554 }
 555
 556
 557 static inline struct bfad_itnim_s *
 558 bfa_fcs_itnim_get_drvitn(struct bfa_fcs_itnim_s *itnim)
 559 {
 560         return itnim->itnim_drv;
 561 }
 562
 563
 564 static inline struct bfa_itnim_s *
 565 bfa_fcs_itnim_get_halitn(struct bfa_fcs_itnim_s *itnim)
 566 {
 567         return itnim->bfa_itnim;
 568 }
 569
 570 /*
 571  * bfa fcs FCP Initiator mode API functions
 572  */
 573 void bfa_fcs_itnim_get_attr(struct bfa_fcs_itnim_s *itnim,
 574                             struct bfa_itnim_attr_s *attr);
 575 void bfa_fcs_itnim_get_stats(struct bfa_fcs_itnim_s *itnim,
 576                              struct bfa_itnim_stats_s *stats);
 577 struct bfa_fcs_itnim_s *bfa_fcs_itnim_lookup(struct bfa_fcs_lport_s *port,
 578                                              wwn_t rpwwn);
 579 bfa_status_t bfa_fcs_itnim_attr_get(struct bfa_fcs_lport_s *port, wwn_t rpwwn,
 580                                     struct bfa_itnim_attr_s *attr);
 581 bfa_status_t bfa_fcs_itnim_stats_get(struct bfa_fcs_lport_s *port, wwn_t rpwwn,
 582                                      struct bfa_itnim_stats_s *stats);
 583 bfa_status_t bfa_fcs_itnim_stats_clear(struct bfa_fcs_lport_s *port,
 584                                        wwn_t rpwwn);
 585 struct bfa_fcs_itnim_s *bfa_fcs_itnim_create(struct bfa_fcs_rport_s *rport);
 586 void bfa_fcs_itnim_delete(struct bfa_fcs_itnim_s *itnim);
 587 void bfa_fcs_itnim_rport_offline(struct bfa_fcs_itnim_s *itnim);
 588 void bfa_fcs_itnim_rport_online(struct bfa_fcs_itnim_s *itnim);
 589 bfa_status_t bfa_fcs_itnim_get_online_state(struct bfa_fcs_itnim_s *itnim);
 590 void bfa_fcs_itnim_is_initiator(struct bfa_fcs_itnim_s *itnim);
 591 void bfa_fcs_fcpim_uf_recv(struct bfa_fcs_itnim_s *itnim,
 592                         struct fchs_s *fchs, u16 len);
 593
 594 #define BFA_FCS_FDMI_SUPORTED_SPEEDS  (FDMI_TRANS_SPEED_1G  |   \
 595                                        FDMI_TRANS_SPEED_2G |    \
 596                                        FDMI_TRANS_SPEED_4G |    \
 597                                        FDMI_TRANS_SPEED_8G)
 598
 599 /*
 600  * HBA Attribute Block : BFA internal representation. Note : Some variable
 601  * sizes have been trimmed to suit BFA For Ex : Model will be "Brocade". Based
 602  * on this the size has been reduced to 16 bytes from the standard's 64 bytes.
 603  */
 604 struct bfa_fcs_fdmi_hba_attr_s {
 605         wwn_t           node_name;
 606         u8         manufacturer[64];
 607         u8         serial_num[64];
 608         u8         model[16];
 609         u8         model_desc[256];
 610         u8         hw_version[8];
 611         u8         driver_version[8];
 612         u8         option_rom_ver[BFA_VERSION_LEN];
 613         u8         fw_version[8];
 614         u8         os_name[256];
 615         __be32        max_ct_pyld;
 616 };
 617
 618 /*
 619  * Port Attribute Block
 620  */
 621 struct bfa_fcs_fdmi_port_attr_s {
 622         u8         supp_fc4_types[32];  /* supported FC4 types */
 623         __be32        supp_speed;       /* supported speed */
 624         __be32        curr_speed;       /* current Speed */
 625         __be32        max_frm_size;     /* max frame size */
 626         u8         os_device_name[256]; /* OS device Name */
 627         u8         host_name[256];      /* host name */
 628 };
 629
 630 struct bfa_fcs_stats_s {
 631         struct {
 632                 u32     untagged; /*  untagged receive frames */
 633                 u32     tagged; /*  tagged receive frames */
 634                 u32     vfid_unknown;   /*  VF id is unknown */
 635         } uf;
 636 };
 637
 638 struct bfa_fcs_driver_info_s {
 639         u8       version[BFA_VERSION_LEN];              /* Driver Version */
 640         u8       host_machine_name[BFA_FCS_OS_STR_LEN];
 641         u8       host_os_name[BFA_FCS_OS_STR_LEN]; /* OS name and version */
 642         u8       host_os_patch[BFA_FCS_OS_STR_LEN]; /* patch or service pack */
 643         u8       os_device_name[BFA_FCS_OS_STR_LEN]; /* Driver Device Name */
 644 };
 645
 646 struct bfa_fcs_s {
 647         struct bfa_s      *bfa; /*  corresponding BFA bfa instance */
 648         struct bfad_s         *bfad; /*  corresponding BDA driver instance */
 649         struct bfa_trc_mod_s  *trcmod;  /*  tracing module */
 650         bfa_boolean_t   vf_enabled;     /*  VF mode is enabled */
 651         bfa_boolean_t   fdmi_enabled;   /*  FDMI is enabled */
 652         bfa_boolean_t min_cfg;          /* min cfg enabled/disabled */
 653         u16     port_vfid;      /*  port default VF ID */
 654         struct bfa_fcs_driver_info_s driver_info;
 655         struct bfa_fcs_fabric_s fabric; /*  base fabric state machine */
 656         struct bfa_fcs_stats_s  stats;  /*  FCS statistics */
 657         struct bfa_wc_s         wc;     /*  waiting counter */
 658 };
 659
 660 /*
 661  *  fcs_fabric_sm fabric state machine functions
 662  */
 663
 664 /*
 665  * Fabric state machine events
 666  */
 667 enum bfa_fcs_fabric_event {
 668         BFA_FCS_FABRIC_SM_CREATE        = 1,    /*  create from driver        */
 669         BFA_FCS_FABRIC_SM_DELETE        = 2,    /*  delete from driver        */
 670         BFA_FCS_FABRIC_SM_LINK_DOWN     = 3,    /*  link down from port      */
 671         BFA_FCS_FABRIC_SM_LINK_UP       = 4,    /*  link up from port         */
 672         BFA_FCS_FABRIC_SM_CONT_OP       = 5,    /*  flogi/auth continue op   */
 673         BFA_FCS_FABRIC_SM_RETRY_OP      = 6,    /*  flogi/auth retry op      */
 674         BFA_FCS_FABRIC_SM_NO_FABRIC     = 7,    /*  from flogi/auth           */
 675         BFA_FCS_FABRIC_SM_PERF_EVFP     = 8,    /*  from flogi/auth           */
 676         BFA_FCS_FABRIC_SM_ISOLATE       = 9,    /*  from EVFP processing     */
 677         BFA_FCS_FABRIC_SM_NO_TAGGING    = 10,   /*  no VFT tagging from EVFP */
 678         BFA_FCS_FABRIC_SM_DELAYED       = 11,   /*  timeout delay event      */
 679         BFA_FCS_FABRIC_SM_AUTH_FAILED   = 12,   /*  auth failed       */
 680         BFA_FCS_FABRIC_SM_AUTH_SUCCESS  = 13,   /*  auth successful           */
 681         BFA_FCS_FABRIC_SM_DELCOMP       = 14,   /*  all vports deleted event */
 682         BFA_FCS_FABRIC_SM_LOOPBACK      = 15,   /*  Received our own FLOGI   */
 683         BFA_FCS_FABRIC_SM_START         = 16,   /*  from driver       */
 684 };
 685
 686 /*
 687  *  fcs_rport_sm FCS rport state machine events
 688  */
 689
 690 enum rport_event {
 691         RPSM_EVENT_PLOGI_SEND   = 1,    /*  new rport; start with PLOGI */
 692         RPSM_EVENT_PLOGI_RCVD   = 2,    /*  Inbound PLOGI from remote port */
 693         RPSM_EVENT_PLOGI_COMP   = 3,    /*  PLOGI completed to rport    */
 694         RPSM_EVENT_LOGO_RCVD    = 4,    /*  LOGO from remote device     */
 695         RPSM_EVENT_LOGO_IMP     = 5,    /*  implicit logo for SLER      */
 696         RPSM_EVENT_FCXP_SENT    = 6,    /*  Frame from has been sent    */
 697         RPSM_EVENT_DELETE       = 7,    /*  RPORT delete request        */
 698         RPSM_EVENT_SCN          = 8,    /*  state change notification   */
 699         RPSM_EVENT_ACCEPTED     = 9,    /*  Good response from remote device */
 700         RPSM_EVENT_FAILED       = 10,   /*  Request to rport failed.    */
 701         RPSM_EVENT_TIMEOUT      = 11,   /*  Rport SM timeout event      */
 702         RPSM_EVENT_HCB_ONLINE  = 12,    /*  BFA rport online callback   */
 703         RPSM_EVENT_HCB_OFFLINE = 13,    /*  BFA rport offline callback  */
 704         RPSM_EVENT_FC4_OFFLINE = 14,    /*  FC-4 offline complete       */
 705         RPSM_EVENT_ADDRESS_CHANGE = 15, /*  Rport's PID has changed     */
 706         RPSM_EVENT_ADDRESS_DISC = 16,   /*  Need to Discover rport's PID */
 707         RPSM_EVENT_PRLO_RCVD   = 17,    /*  PRLO from remote device     */
 708         RPSM_EVENT_PLOGI_RETRY = 18,    /*  Retry PLOGI continuously */
 709 };
 710
 711 /*
 712  * bfa fcs API functions
 713  */
 714 void bfa_fcs_attach(struct bfa_fcs_s *fcs, struct bfa_s *bfa,
 715                     struct bfad_s *bfad,
 716                     bfa_boolean_t min_cfg);
 717 void bfa_fcs_init(struct bfa_fcs_s *fcs);
 718 void bfa_fcs_driver_info_init(struct bfa_fcs_s *fcs,
 719                               struct bfa_fcs_driver_info_s *driver_info);
 720 void bfa_fcs_exit(struct bfa_fcs_s *fcs);
 721
 722 /*
 723  * bfa fcs vf public functions
 724  */
 725 bfa_fcs_vf_t *bfa_fcs_vf_lookup(struct bfa_fcs_s *fcs, u16 vf_id);
 726
 727 /*
 728  * fabric protected interface functions
 729  */
 730 void bfa_fcs_fabric_attach(struct bfa_fcs_s *fcs);
 731 void bfa_fcs_fabric_modinit(struct bfa_fcs_s *fcs);
 732 void bfa_fcs_fabric_modexit(struct bfa_fcs_s *fcs);
 733 void bfa_fcs_fabric_link_up(struct bfa_fcs_fabric_s *fabric);
 734 void bfa_fcs_fabric_link_down(struct bfa_fcs_fabric_s *fabric);
 735 void bfa_fcs_fabric_addvport(struct bfa_fcs_fabric_s *fabric,
 736         struct bfa_fcs_vport_s *vport);
 737 void bfa_fcs_fabric_delvport(struct bfa_fcs_fabric_s *fabric,
 738         struct bfa_fcs_vport_s *vport);
 739 struct bfa_fcs_vport_s *bfa_fcs_fabric_vport_lookup(
 740                 struct bfa_fcs_fabric_s *fabric, wwn_t pwwn);
 741 void bfa_fcs_fabric_modstart(struct bfa_fcs_s *fcs);
 742 void bfa_fcs_fabric_uf_recv(struct bfa_fcs_fabric_s *fabric,
 743                 struct fchs_s *fchs, u16 len);
 744 void    bfa_fcs_fabric_psymb_init(struct bfa_fcs_fabric_s *fabric);
 745 void bfa_fcs_fabric_set_fabric_name(struct bfa_fcs_fabric_s *fabric,
 746                wwn_t fabric_name);
 747 u16 bfa_fcs_fabric_get_switch_oui(struct bfa_fcs_fabric_s *fabric);
 748 void bfa_fcs_uf_attach(struct bfa_fcs_s *fcs);
 749 void bfa_fcs_port_attach(struct bfa_fcs_s *fcs);
 750 void bfa_fcs_fabric_sm_online(struct bfa_fcs_fabric_s *fabric,
 751                         enum bfa_fcs_fabric_event event);
 752 void bfa_fcs_fabric_sm_loopback(struct bfa_fcs_fabric_s *fabric,
 753                         enum bfa_fcs_fabric_event event);
 754 void bfa_fcs_fabric_sm_auth_failed(struct bfa_fcs_fabric_s *fabric,
 755                         enum bfa_fcs_fabric_event event);
 756
 757 /*
 758  * BFA FCS callback interfaces
 759  */
 760
 761 /*
 762  * fcb Main fcs callbacks
 763  */
 764
 765 struct bfad_port_s;
 766 struct bfad_vf_s;
 767 struct bfad_vport_s;
 768 struct bfad_rport_s;
 769
 770 /*
 771  * lport callbacks
 772  */
 773 struct bfad_port_s *bfa_fcb_lport_new(struct bfad_s *bfad,
 774                                       struct bfa_fcs_lport_s *port,
 775                                       enum bfa_lport_role roles,
 776                                       struct bfad_vf_s *vf_drv,
 777                                       struct bfad_vport_s *vp_drv);
 778 void bfa_fcb_lport_delete(struct bfad_s *bfad, enum bfa_lport_role roles,
 779                           struct bfad_vf_s *vf_drv,
 780                           struct bfad_vport_s *vp_drv);
 781
 782 /*
 783  * vport callbacks
 784  */
 785 void bfa_fcb_pbc_vport_create(struct bfad_s *bfad, struct bfi_pbc_vport_s);
 786
 787 /*
 788  * rport callbacks
 789  */
 790 bfa_status_t bfa_fcb_rport_alloc(struct bfad_s *bfad,
 791                                  struct bfa_fcs_rport_s **rport,
 792                                  struct bfad_rport_s **rport_drv);
 793
 794 /*
 795  * itnim callbacks
 796  */
 797 void bfa_fcb_itnim_alloc(struct bfad_s *bfad, struct bfa_fcs_itnim_s **itnim,
 798                          struct bfad_itnim_s **itnim_drv);
 799 void bfa_fcb_itnim_free(struct bfad_s *bfad,
 800                         struct bfad_itnim_s *itnim_drv);
 801 void bfa_fcb_itnim_online(struct bfad_itnim_s *itnim_drv);
 802 void bfa_fcb_itnim_offline(struct bfad_itnim_s *itnim_drv);
 803
 804 #endif /* __BFA_FCS_H__ */