drivers/scsi/bfa/bfa_defs_fcs.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * Copyright (c) 2005-2014 Brocade Communications Systems, Inc.
   4  * Copyright (c) 2014- QLogic Corporation.
   5  * All rights reserved
   6  * www.qlogic.com
   7  *
   8  * Linux driver for QLogic BR-series Fibre Channel Host Bus Adapter.
   9  */
  10
  11 #ifndef __BFA_DEFS_FCS_H__
  12 #define __BFA_DEFS_FCS_H__
  13
  14 #include "bfa_fc.h"
  15 #include "bfa_defs_svc.h"
  16
  17 /*
  18  * VF states
  19  */
  20 enum bfa_vf_state {
  21         BFA_VF_UNINIT    = 0,   /*  fabric is not yet initialized */
  22         BFA_VF_LINK_DOWN = 1,   /*  link is down */
  23         BFA_VF_FLOGI     = 2,   /*  flogi is in progress */
  24         BFA_VF_AUTH      = 3,   /*  authentication in progress */
  25         BFA_VF_NOFABRIC  = 4,   /*  fabric is not present */
  26         BFA_VF_ONLINE    = 5,   /*  login to fabric is complete */
  27         BFA_VF_EVFP      = 6,   /*  EVFP is in progress */
  28         BFA_VF_ISOLATED  = 7,   /*  port isolated due to vf_id mismatch */
  29 };
  30
  31 /*
  32  * VF statistics
  33  */
  34 struct bfa_vf_stats_s {
  35         u32     flogi_sent;     /*  Num FLOGIs sent */
  36         u32     flogi_rsp_err;  /*  FLOGI response errors */
  37         u32     flogi_acc_err;  /*  FLOGI accept errors */
  38         u32     flogi_accepts;  /*  FLOGI accepts received */
  39         u32     flogi_rejects;  /*  FLOGI rejects received */
  40         u32     flogi_unknown_rsp; /*  Unknown responses for FLOGI */
  41         u32     flogi_alloc_wait; /*  Allocation waits prior to sending FLOGI */
  42         u32     flogi_rcvd;     /*  FLOGIs received */
  43         u32     flogi_rejected; /*  Incoming FLOGIs rejected */
  44         u32     fabric_onlines; /*  Internal fabric online notification sent
  45                                  *  to other modules */
  46         u32     fabric_offlines; /* Internal fabric offline notification sent
  47                                   * to other modules */
  48         u32     resvd; /*  padding for 64 bit alignment */
  49 };
  50
  51 /*
  52  * VF attributes returned in queries
  53  */
  54 struct bfa_vf_attr_s {
  55         enum bfa_vf_state  state;               /*  VF state */
  56         u32        rsvd;
  57         wwn_t           fabric_name;    /*  fabric name */
  58 };
  59
  60 #define BFA_FCS_MAX_LPORTS 256
  61 #define BFA_FCS_FABRIC_IPADDR_SZ  16
  62
  63 /*
  64  * symbolic names for base port/virtual port
  65  */
  66 #define BFA_SYMNAME_MAXLEN      128     /* 128 bytes */
  67 struct bfa_lport_symname_s {
  68         char        symname[BFA_SYMNAME_MAXLEN];
  69 };
  70
  71 /*
  72 * Roles of FCS port:
  73  *     - FCP IM and FCP TM roles cannot be enabled together for a FCS port
  74  *     - Create multiple ports if both IM and TM functions required.
  75  *     - Atleast one role must be specified.
  76  */
  77 enum bfa_lport_role {
  78         BFA_LPORT_ROLE_FCP_IM   = 0x01, /*  FCP initiator role */
  79         BFA_LPORT_ROLE_FCP_MAX  = BFA_LPORT_ROLE_FCP_IM,
  80 };
  81
  82 /*
  83  * FCS port configuration.
  84  */
  85 struct bfa_lport_cfg_s {
  86         wwn_t          pwwn;       /*  port wwn */
  87         wwn_t          nwwn;       /*  node wwn */
  88         struct bfa_lport_symname_s  sym_name;   /*  vm port symbolic name */
  89         struct bfa_lport_symname_s node_sym_name; /* Node symbolic name */
  90         enum bfa_lport_role roles;      /* FCS port roles */
  91         u32     rsvd;
  92         bfa_boolean_t   preboot_vp;  /*  vport created from PBC */
  93         u8      tag[16];        /* opaque tag from application */
  94         u8      padding[4];
  95 };
  96
  97 /*
  98  * FCS port states
  99  */
 100 enum bfa_lport_state {
 101         BFA_LPORT_UNINIT  = 0,  /*  PORT is not yet initialized */
 102         BFA_LPORT_FDISC   = 1,  /*  FDISC is in progress */
 103         BFA_LPORT_ONLINE  = 2,  /*  login to fabric is complete */
 104         BFA_LPORT_OFFLINE = 3,  /*  No login to fabric */
 105 };
 106
 107 /*
 108  * FCS port type.
 109  */
 110 enum bfa_lport_type {
 111         BFA_LPORT_TYPE_PHYSICAL = 0,
 112         BFA_LPORT_TYPE_VIRTUAL,
 113 };
 114
 115 /*
 116  * FCS port offline reason.
 117  */
 118 enum bfa_lport_offline_reason {
 119         BFA_LPORT_OFFLINE_UNKNOWN = 0,
 120         BFA_LPORT_OFFLINE_LINKDOWN,
 121         BFA_LPORT_OFFLINE_FAB_UNSUPPORTED,      /*  NPIV not supported by the
 122          *    fabric */
 123         BFA_LPORT_OFFLINE_FAB_NORESOURCES,
 124         BFA_LPORT_OFFLINE_FAB_LOGOUT,
 125 };
 126
 127 /*
 128  * FCS lport info.
 129  */
 130 struct bfa_lport_info_s {
 131         u8       port_type;     /* bfa_lport_type_t : physical or
 132          * virtual */
 133         u8       port_state;    /* one of bfa_lport_state values */
 134         u8       offline_reason;        /* one of bfa_lport_offline_reason_t
 135          * values */
 136         wwn_t      port_wwn;
 137         wwn_t      node_wwn;
 138
 139         /*
 140          * following 4 feilds are valid for Physical Ports only
 141          */
 142         u32     max_vports_supp;        /* Max supported vports */
 143         u32     num_vports_inuse;       /* Num of in use vports */
 144         u32     max_rports_supp;        /* Max supported rports */
 145         u32     num_rports_inuse;       /* Num of doscovered rports */
 146
 147 };
 148
 149 /*
 150  * FCS port statistics
 151  */
 152 struct bfa_lport_stats_s {
 153         u32     ns_plogi_sent;
 154         u32     ns_plogi_rsp_err;
 155         u32     ns_plogi_acc_err;
 156         u32     ns_plogi_accepts;
 157         u32     ns_rejects;     /* NS command rejects */
 158         u32     ns_plogi_unknown_rsp;
 159         u32     ns_plogi_alloc_wait;
 160
 161         u32     ns_retries;     /* NS command retries */
 162         u32     ns_timeouts;    /* NS command timeouts */
 163
 164         u32     ns_rspnid_sent;
 165         u32     ns_rspnid_accepts;
 166         u32     ns_rspnid_rsp_err;
 167         u32     ns_rspnid_rejects;
 168         u32     ns_rspnid_alloc_wait;
 169
 170         u32     ns_rftid_sent;
 171         u32     ns_rftid_accepts;
 172         u32     ns_rftid_rsp_err;
 173         u32     ns_rftid_rejects;
 174         u32     ns_rftid_alloc_wait;
 175
 176         u32     ns_rffid_sent;
 177         u32     ns_rffid_accepts;
 178         u32     ns_rffid_rsp_err;
 179         u32     ns_rffid_rejects;
 180         u32     ns_rffid_alloc_wait;
 181
 182         u32     ns_gidft_sent;
 183         u32     ns_gidft_accepts;
 184         u32     ns_gidft_rsp_err;
 185         u32     ns_gidft_rejects;
 186         u32     ns_gidft_unknown_rsp;
 187         u32     ns_gidft_alloc_wait;
 188
 189         u32     ns_rnnid_sent;
 190         u32     ns_rnnid_accepts;
 191         u32     ns_rnnid_rsp_err;
 192         u32     ns_rnnid_rejects;
 193         u32     ns_rnnid_alloc_wait;
 194
 195         u32     ns_rsnn_nn_sent;
 196         u32     ns_rsnn_nn_accepts;
 197         u32     ns_rsnn_nn_rsp_err;
 198         u32     ns_rsnn_nn_rejects;
 199         u32     ns_rsnn_nn_alloc_wait;
 200
 201         /*
 202          * Mgmt Server stats
 203          */
 204         u32     ms_retries;     /* MS command retries */
 205         u32     ms_timeouts;    /* MS command timeouts */
 206         u32     ms_plogi_sent;
 207         u32     ms_plogi_rsp_err;
 208         u32     ms_plogi_acc_err;
 209         u32     ms_plogi_accepts;
 210         u32     ms_rejects;     /* MS command rejects */
 211         u32     ms_plogi_unknown_rsp;
 212         u32     ms_plogi_alloc_wait;
 213
 214         u32     num_rscn;       /* Num of RSCN received */
 215         u32     num_portid_rscn;/* Num portid format RSCN
 216         * received */
 217
 218         u32     uf_recvs;       /* Unsolicited recv frames      */
 219         u32     uf_recv_drops;  /* Dropped received frames      */
 220
 221         u32     plogi_rcvd;     /* Received plogi       */
 222         u32     prli_rcvd;      /* Received prli        */
 223         u32     adisc_rcvd;     /* Received adisc       */
 224         u32     prlo_rcvd;      /* Received prlo        */
 225         u32     logo_rcvd;      /* Received logo        */
 226         u32     rpsc_rcvd;      /* Received rpsc        */
 227         u32     un_handled_els_rcvd;    /* Received unhandled ELS       */
 228         u32     rport_plogi_timeouts; /* Rport plogi retry timeout count */
 229         u32     rport_del_max_plogi_retry; /* Deleted rport
 230                                             * (max retry of plogi) */
 231 };
 232
 233 /*
 234  * BFA port attribute returned in queries
 235  */
 236 struct bfa_lport_attr_s {
 237         enum bfa_lport_state state;     /*  port state */
 238         u32      pid;   /*  port ID */
 239         struct bfa_lport_cfg_s   port_cfg;      /*  port configuration */
 240         enum bfa_port_type port_type;   /*  current topology */
 241         u32      loopback;      /*  cable is externally looped back */
 242         wwn_t   fabric_name; /*  attached switch's nwwn */
 243         u8      fabric_ip_addr[BFA_FCS_FABRIC_IPADDR_SZ]; /*  attached
 244         * fabric's ip addr */
 245         mac_t      fpma_mac;    /*  Lport's FPMA Mac address */
 246         u16     authfail;       /*  auth failed state */
 247 };
 248
 249
 250 /*
 251  * VPORT states
 252  */
 253 enum bfa_vport_state {
 254         BFA_FCS_VPORT_UNINIT            = 0,
 255         BFA_FCS_VPORT_CREATED           = 1,
 256         BFA_FCS_VPORT_OFFLINE           = 1,
 257         BFA_FCS_VPORT_FDISC_SEND        = 2,
 258         BFA_FCS_VPORT_FDISC             = 3,
 259         BFA_FCS_VPORT_FDISC_RETRY       = 4,
 260         BFA_FCS_VPORT_FDISC_RSP_WAIT    = 5,
 261         BFA_FCS_VPORT_ONLINE            = 6,
 262         BFA_FCS_VPORT_DELETING          = 7,
 263         BFA_FCS_VPORT_CLEANUP           = 8,
 264         BFA_FCS_VPORT_LOGO_SEND         = 9,
 265         BFA_FCS_VPORT_LOGO              = 10,
 266         BFA_FCS_VPORT_ERROR             = 11,
 267         BFA_FCS_VPORT_MAX_STATE,
 268 };
 269
 270 /*
 271  * vport statistics
 272  */
 273 struct bfa_vport_stats_s {
 274         struct bfa_lport_stats_s port_stats;    /*  base class (port) stats */
 275         /*
 276          * TODO - remove
 277          */
 278
 279         u32        fdisc_sent;  /*  num fdisc sent */
 280         u32        fdisc_accepts;       /*  fdisc accepts */
 281         u32        fdisc_retries;       /*  fdisc retries */
 282         u32        fdisc_timeouts;      /*  fdisc timeouts */
 283         u32        fdisc_rsp_err;       /*  fdisc response error */
 284         u32        fdisc_acc_bad;       /*  bad fdisc accepts */
 285         u32        fdisc_rejects;       /*  fdisc rejects */
 286         u32        fdisc_unknown_rsp;
 287         /*
 288          *!< fdisc rsp unknown error
 289          */
 290         u32        fdisc_alloc_wait;/*  fdisc req (fcxp)alloc wait */
 291
 292         u32        logo_alloc_wait;/*  logo req (fcxp) alloc wait */
 293         u32        logo_sent;   /*  logo sent */
 294         u32        logo_accepts;        /*  logo accepts */
 295         u32        logo_rejects;        /*  logo rejects */
 296         u32        logo_rsp_err;        /*  logo rsp errors */
 297         u32        logo_unknown_rsp;
 298                         /*  logo rsp unknown errors */
 299
 300         u32        fab_no_npiv; /*  fabric does not support npiv */
 301
 302         u32        fab_offline; /*  offline events from fab SM */
 303         u32        fab_online;  /*  online events from fab SM */
 304         u32        fab_cleanup; /*  cleanup request from fab SM */
 305         u32        rsvd;
 306 };
 307
 308 /*
 309  * BFA vport attribute returned in queries
 310  */
 311 struct bfa_vport_attr_s {
 312         struct bfa_lport_attr_s   port_attr; /*  base class (port) attributes */
 313         enum bfa_vport_state vport_state; /*  vport state */
 314         u32          rsvd;
 315 };
 316
 317 /*
 318  * FCS remote port states
 319  */
 320 enum bfa_rport_state {
 321         BFA_RPORT_UNINIT        = 0,    /*  PORT is not yet initialized */
 322         BFA_RPORT_OFFLINE       = 1,    /*  rport is offline */
 323         BFA_RPORT_PLOGI         = 2,    /*  PLOGI to rport is in progress */
 324         BFA_RPORT_ONLINE        = 3,    /*  login to rport is complete */
 325         BFA_RPORT_PLOGI_RETRY   = 4,    /*  retrying login to rport */
 326         BFA_RPORT_NSQUERY       = 5,    /*  nameserver query */
 327         BFA_RPORT_ADISC         = 6,    /*  ADISC authentication */
 328         BFA_RPORT_LOGO          = 7,    /*  logging out with rport */
 329         BFA_RPORT_LOGORCV       = 8,    /*  handling LOGO from rport */
 330         BFA_RPORT_NSDISC        = 9,    /*  re-discover rport */
 331 };
 332
 333 /*
 334  *  Rport Scsi Function : Initiator/Target.
 335  */
 336 enum bfa_rport_function {
 337         BFA_RPORT_INITIATOR     = 0x01, /*  SCSI Initiator      */
 338         BFA_RPORT_TARGET        = 0x02, /*  SCSI Target */
 339 };
 340
 341 /*
 342  * port/node symbolic names for rport
 343  */
 344 #define BFA_RPORT_SYMNAME_MAXLEN        255
 345 struct bfa_rport_symname_s {
 346         char            symname[BFA_RPORT_SYMNAME_MAXLEN];
 347 };
 348
 349 /*
 350  * FCS remote port statistics
 351  */
 352 struct bfa_rport_stats_s {
 353         u32        offlines;           /*  remote port offline count  */
 354         u32        onlines;            /*  remote port online count   */
 355         u32        rscns;              /*  RSCN affecting rport       */
 356         u32        plogis;                  /*  plogis sent                */
 357         u32        plogi_accs;      /*  plogi accepts              */
 358         u32        plogi_timeouts;          /*  plogi timeouts             */
 359         u32        plogi_rejects;           /*  rcvd plogi rejects         */
 360         u32        plogi_failed;            /*  local failure              */
 361         u32        plogi_rcvd;      /*  plogis rcvd                */
 362         u32        prli_rcvd;          /*  inbound PRLIs              */
 363         u32        adisc_rcvd;         /*  ADISCs received            */
 364         u32        adisc_rejects;      /*  recvd  ADISC rejects       */
 365         u32        adisc_sent;         /*  ADISC requests sent        */
 366         u32        adisc_accs;         /*  ADISC accepted by rport    */
 367         u32        adisc_failed;       /*  ADISC failed (no response) */
 368         u32        adisc_rejected;     /*  ADISC rejected by us    */
 369         u32        logos;              /*  logos sent                 */
 370         u32        logo_accs;          /*  LOGO accepts from rport    */
 371         u32        logo_failed;        /*  LOGO failures              */
 372         u32        logo_rejected;      /*  LOGO rejects from rport    */
 373         u32        logo_rcvd;          /*  LOGO from remote port      */
 374
 375         u32        rpsc_rcvd;         /*  RPSC received            */
 376         u32        rpsc_rejects;      /*  recvd  RPSC rejects       */
 377         u32        rpsc_sent;         /*  RPSC requests sent        */
 378         u32        rpsc_accs;         /*  RPSC accepted by rport    */
 379         u32        rpsc_failed;       /*  RPSC failed (no response) */
 380         u32        rpsc_rejected;     /*  RPSC rejected by us    */
 381
 382         u32     rjt_insuff_res; /*  LS RJT with insuff resources */
 383         struct bfa_rport_hal_stats_s    hal_stats;  /*  BFA rport stats    */
 384 };
 385
 386 /*
 387  * FCS remote port attributes returned in queries
 388  */
 389 struct bfa_rport_attr_s {
 390         wwn_t           nwwn;   /*  node wwn */
 391         wwn_t           pwwn;   /*  port wwn */
 392         enum fc_cos cos_supported;      /*  supported class of services */
 393         u32             pid;    /*  port ID */
 394         u32             df_sz;  /*  Max payload size */
 395         enum bfa_rport_state    state;  /*  Rport State machine state */
 396         enum fc_cos     fc_cos; /*  FC classes of services */
 397         bfa_boolean_t   cisc;   /*  CISC capable device */
 398         struct bfa_rport_symname_s symname; /*  Symbolic Name */
 399         enum bfa_rport_function scsi_function; /*  Initiator/Target */
 400         struct bfa_rport_qos_attr_s qos_attr; /*  qos attributes  */
 401         enum bfa_port_speed curr_speed;   /*  operating speed got from
 402                                             * RPSC ELS. UNKNOWN, if RPSC
 403                                             * is not supported */
 404         bfa_boolean_t   trl_enforced;   /*  TRL enforced ? TRUE/FALSE */
 405         enum bfa_port_speed     assigned_speed; /* Speed assigned by the user.
 406                                                  * will be used if RPSC is not
 407                                                  * supported by the rport */
 408 };
 409
 410 struct bfa_rport_remote_link_stats_s {
 411         u32 lfc; /*  Link Failure Count */
 412         u32 lsyc; /*  Loss of Synchronization Count */
 413         u32 lsic; /*  Loss of Signal Count */
 414         u32 pspec; /*  Primitive Sequence Protocol Error Count */
 415         u32 itwc; /*  Invalid Transmission Word Count */
 416         u32 icc; /*  Invalid CRC Count */
 417 };
 418
 419 struct bfa_rport_qualifier_s {
 420         wwn_t   pwwn;   /* Port WWN */
 421         u32     pid;    /* port ID */
 422         u32     rsvd;
 423 };
 424
 425 #define BFA_MAX_IO_INDEX 7
 426 #define BFA_NO_IO_INDEX 9
 427
 428 /*
 429  * FCS itnim states
 430  */
 431 enum bfa_itnim_state {
 432         BFA_ITNIM_OFFLINE       = 0,    /*  offline */
 433         BFA_ITNIM_PRLI_SEND     = 1,    /*  prli send */
 434         BFA_ITNIM_PRLI_SENT     = 2,    /*  prli sent */
 435         BFA_ITNIM_PRLI_RETRY    = 3,    /*  prli retry */
 436         BFA_ITNIM_HCB_ONLINE    = 4,    /*  online callback */
 437         BFA_ITNIM_ONLINE        = 5,    /*  online */
 438         BFA_ITNIM_HCB_OFFLINE   = 6,    /*  offline callback */
 439         BFA_ITNIM_INITIATIOR    = 7,    /*  initiator */
 440 };
 441
 442 /*
 443  * FCS remote port statistics
 444  */
 445 struct bfa_itnim_stats_s {
 446         u32        onlines;     /*  num rport online */
 447         u32        offlines;    /*  num rport offline */
 448         u32        prli_sent;   /*  num prli sent out */
 449         u32        fcxp_alloc_wait;/*  num fcxp alloc waits */
 450         u32        prli_rsp_err;        /*  num prli rsp errors */
 451         u32        prli_rsp_acc;        /*  num prli rsp accepts */
 452         u32        initiator;   /*  rport is an initiator */
 453         u32        prli_rsp_parse_err;  /*  prli rsp parsing errors */
 454         u32        prli_rsp_rjt;        /*  num prli rsp rejects */
 455         u32        timeout;     /*  num timeouts detected */
 456         u32        sler;                /*  num sler notification from BFA */
 457         u32     rsvd;           /* padding for 64 bit alignment */
 458 };
 459
 460 /*
 461  * FCS itnim attributes returned in queries
 462  */
 463 struct bfa_itnim_attr_s {
 464         enum bfa_itnim_state state; /*  FCS itnim state        */
 465         u8 retry;               /*  data retransmision support */
 466         u8      task_retry_id;  /*  task retry ident support   */
 467         u8 rec_support;    /*  REC supported              */
 468         u8 conf_comp;      /*  confirmed completion supp  */
 469 };
 470
 471 #endif /* __BFA_DEFS_FCS_H__ */