Back to home page

OSCL-LXR

 
 

    


0001 /* SPDX-License-Identifier: GPL-2.0-only */
0002 /*
0003  * Copyright (c) 2005-2014 Brocade Communications Systems, Inc.
0004  * Copyright (c) 2014- QLogic Corporation.
0005  * All rights reserved
0006  * www.qlogic.com
0007  *
0008  * Linux driver for QLogic BR-series Fibre Channel Host Bus Adapter.
0009  */
0010 
0011 #ifndef __BFA_FC_H__
0012 #define __BFA_FC_H__
0013 
0014 #include "bfad_drv.h"
0015 
0016 typedef u64 wwn_t;
0017 
0018 #define WWN_NULL    (0)
0019 #define FC_SYMNAME_MAX  256 /*  max name server symbolic name size */
0020 #define FC_ALPA_MAX 128
0021 
0022 #pragma pack(1)
0023 
0024 #define MAC_ADDRLEN (6)
0025 struct mac_s { u8 mac[MAC_ADDRLEN]; };
0026 #define mac_t struct mac_s
0027 
0028 /*
0029  * generic SCSI cdb definition
0030  */
0031 #define SCSI_MAX_CDBLEN     16
0032 struct scsi_cdb_s {
0033     u8         scsi_cdb[SCSI_MAX_CDBLEN];
0034 };
0035 
0036 #define SCSI_MAX_ALLOC_LEN      0xFF    /* maximum allocarion length */
0037 
0038 /*
0039  * Fibre Channel Header Structure (FCHS) definition
0040  */
0041 struct fchs_s {
0042 #ifdef __BIG_ENDIAN
0043     u32        routing:4;   /* routing bits */
0044     u32        cat_info:4;  /* category info */
0045 #else
0046     u32        cat_info:4;  /* category info */
0047     u32        routing:4;   /* routing bits */
0048 #endif
0049     u32        d_id:24; /* destination identifier */
0050 
0051     u32        cs_ctl:8;    /* class specific control */
0052     u32        s_id:24; /* source identifier */
0053 
0054     u32        type:8;  /* data structure type */
0055     u32        f_ctl:24;    /* initial frame control */
0056 
0057     u8         seq_id;  /* sequence identifier */
0058     u8         df_ctl;  /* data field control */
0059     u16        seq_cnt; /* sequence count */
0060 
0061     __be16     ox_id;   /* originator exchange ID */
0062     u16        rx_id;   /* responder exchange ID */
0063 
0064     u32        ro;      /* relative offset */
0065 };
0066 
0067 /*
0068  * routing bit definitions
0069  */
0070 enum {
0071     FC_RTG_FC4_DEV_DATA = 0x0,  /* FC-4 Device Data */
0072     FC_RTG_EXT_LINK     = 0x2,  /* Extended Link Data */
0073     FC_RTG_FC4_LINK_DATA    = 0x3,  /* FC-4 Link Data */
0074     FC_RTG_VIDEO_DATA   = 0x4,  /* Video Data */
0075     FC_RTG_EXT_HDR      = 0x5,  /* VFT, IFR or Encapsuled */
0076     FC_RTG_BASIC_LINK   = 0x8,  /* Basic Link data */
0077     FC_RTG_LINK_CTRL    = 0xC,  /* Link Control */
0078 };
0079 
0080 /*
0081  * information category for extended link data and FC-4 Link Data
0082  */
0083 enum {
0084     FC_CAT_LD_REQUEST   = 0x2,  /* Request */
0085     FC_CAT_LD_REPLY     = 0x3,  /* Reply */
0086     FC_CAT_LD_DIAG      = 0xF,  /* for DIAG use only */
0087 };
0088 
0089 /*
0090  * information category for extended headers (VFT, IFR or encapsulation)
0091  */
0092 enum {
0093     FC_CAT_VFT_HDR = 0x0,   /* Virtual fabric tagging header */
0094     FC_CAT_IFR_HDR = 0x1,   /* Inter-Fabric routing header */
0095     FC_CAT_ENC_HDR = 0x2,   /* Encapsulation header */
0096 };
0097 
0098 /*
0099  * information category for FC-4 device data
0100  */
0101 enum {
0102     FC_CAT_UNCATEG_INFO = 0x0,  /* Uncategorized information */
0103     FC_CAT_SOLICIT_DATA = 0x1,  /* Solicited Data */
0104     FC_CAT_UNSOLICIT_CTRL   = 0x2,  /* Unsolicited Control */
0105     FC_CAT_SOLICIT_CTRL = 0x3,  /* Solicited Control */
0106     FC_CAT_UNSOLICIT_DATA   = 0x4,  /* Unsolicited Data */
0107     FC_CAT_DATA_DESC    = 0x5,  /* Data Descriptor */
0108     FC_CAT_UNSOLICIT_CMD    = 0x6,  /* Unsolicited Command */
0109     FC_CAT_CMD_STATUS   = 0x7,  /* Command Status */
0110 };
0111 
0112 /*
0113  * Type Field Definitions. FC-PH Section 18.5 pg. 165
0114  */
0115 enum {
0116     FC_TYPE_BLS     = 0x0,  /* Basic Link Service */
0117     FC_TYPE_ELS     = 0x1,  /* Extended Link Service */
0118     FC_TYPE_IP      = 0x5,  /* IP */
0119     FC_TYPE_FCP     = 0x8,  /* SCSI-FCP */
0120     FC_TYPE_GPP     = 0x9,  /* SCSI_GPP */
0121     FC_TYPE_SERVICES    = 0x20, /* Fibre Channel Services */
0122     FC_TYPE_FC_FSS      = 0x22, /* Fabric Switch Services */
0123     FC_TYPE_FC_AL       = 0x23, /* FC-AL */
0124     FC_TYPE_FC_SNMP     = 0x24, /* FC-SNMP */
0125     FC_TYPE_FC_SPINFAB  = 0xEE, /* SPINFAB */
0126     FC_TYPE_FC_DIAG     = 0xEF, /* DIAG */
0127     FC_TYPE_MAX     = 256,  /* 256 FC-4 types */
0128 };
0129 
0130 /*
0131  * Frame Control Definitions. FC-PH Table-45. pg. 168
0132  */
0133 enum {
0134     FCTL_EC_ORIG = 0x000000,    /* exchange originator */
0135     FCTL_EC_RESP = 0x800000,    /* exchange responder */
0136     FCTL_SEQ_INI = 0x000000,    /* sequence initiator */
0137     FCTL_SEQ_REC = 0x400000,    /* sequence recipient */
0138     FCTL_FS_EXCH = 0x200000,    /* first sequence of xchg */
0139     FCTL_LS_EXCH = 0x100000,    /* last sequence of xchg */
0140     FCTL_END_SEQ = 0x080000,    /* last frame of sequence */
0141     FCTL_SI_XFER = 0x010000,    /* seq initiative transfer */
0142     FCTL_RO_PRESENT = 0x000008, /* relative offset present */
0143     FCTL_FILLBYTE_MASK = 0x000003   /* , fill byte mask */
0144 };
0145 
0146 /*
0147  * Fabric Well Known Addresses
0148  */
0149 enum {
0150     FC_MIN_WELL_KNOWN_ADDR      = 0xFFFFF0,
0151     FC_DOMAIN_CONTROLLER_MASK   = 0xFFFC00,
0152     FC_ALIAS_SERVER         = 0xFFFFF8,
0153     FC_MGMT_SERVER          = 0xFFFFFA,
0154     FC_TIME_SERVER          = 0xFFFFFB,
0155     FC_NAME_SERVER          = 0xFFFFFC,
0156     FC_FABRIC_CONTROLLER        = 0xFFFFFD,
0157     FC_FABRIC_PORT          = 0xFFFFFE,
0158     FC_BROADCAST_SERVER     = 0xFFFFFF
0159 };
0160 
0161 /*
0162  * domain/area/port defines
0163  */
0164 #define FC_DOMAIN_MASK  0xFF0000
0165 #define FC_DOMAIN_SHIFT 16
0166 #define FC_AREA_MASK    0x00FF00
0167 #define FC_AREA_SHIFT   8
0168 #define FC_PORT_MASK    0x0000FF
0169 #define FC_PORT_SHIFT   0
0170 
0171 #define FC_GET_DOMAIN(p)    (((p) & FC_DOMAIN_MASK) >> FC_DOMAIN_SHIFT)
0172 #define FC_GET_AREA(p)      (((p) & FC_AREA_MASK) >> FC_AREA_SHIFT)
0173 #define FC_GET_PORT(p)      (((p) & FC_PORT_MASK) >> FC_PORT_SHIFT)
0174 
0175 #define FC_DOMAIN_CTRLR(p)  (FC_DOMAIN_CONTROLLER_MASK | (FC_GET_DOMAIN(p)))
0176 
0177 enum {
0178     FC_RXID_ANY = 0xFFFFU,
0179 };
0180 
0181 /*
0182  * generic ELS command
0183  */
0184 struct fc_els_cmd_s {
0185     u32        els_code:8;  /* ELS Command Code */
0186     u32        reserved:24;
0187 };
0188 
0189 /*
0190  * ELS Command Codes. FC-PH Table-75. pg. 223
0191  */
0192 enum {
0193     FC_ELS_LS_RJT = 0x1,    /* Link Service Reject. */
0194     FC_ELS_ACC = 0x02,  /* Accept */
0195     FC_ELS_PLOGI = 0x03,    /* N_Port Login. */
0196     FC_ELS_FLOGI = 0x04,    /* F_Port Login. */
0197     FC_ELS_LOGO = 0x05, /* Logout. */
0198     FC_ELS_ABTX = 0x06, /* Abort Exchange */
0199     FC_ELS_RES = 0x08,  /* Read Exchange status */
0200     FC_ELS_RSS = 0x09,  /* Read sequence status block */
0201     FC_ELS_RSI = 0x0A,  /* Request Sequence Initiative */
0202     FC_ELS_ESTC = 0x0C, /* Estimate Credit. */
0203     FC_ELS_RTV = 0x0E,  /* Read Timeout Value. */
0204     FC_ELS_RLS = 0x0F,  /* Read Link Status. */
0205     FC_ELS_ECHO = 0x10, /* Echo */
0206     FC_ELS_TEST = 0x11, /* Test */
0207     FC_ELS_RRQ = 0x12,  /* Reinstate Recovery Qualifier. */
0208     FC_ELS_REC = 0x13,  /* Add this for TAPE support in FCR */
0209     FC_ELS_PRLI = 0x20, /* Process Login */
0210     FC_ELS_PRLO = 0x21, /* Process Logout. */
0211     FC_ELS_SCN = 0x22,  /* State Change Notification. */
0212     FC_ELS_TPRLO = 0x24,    /* Third Party Process Logout. */
0213     FC_ELS_PDISC = 0x50,    /* Discover N_Port Parameters. */
0214     FC_ELS_FDISC = 0x51,    /* Discover F_Port Parameters. */
0215     FC_ELS_ADISC = 0x52,    /* Discover Address. */
0216     FC_ELS_FARP_REQ = 0x54, /* FARP Request. */
0217     FC_ELS_FARP_REP = 0x55, /* FARP Reply. */
0218     FC_ELS_FAN = 0x60,  /* Fabric Address Notification */
0219     FC_ELS_RSCN = 0x61, /* Reg State Change Notification */
0220     FC_ELS_SCR = 0x62,  /* State Change Registration. */
0221     FC_ELS_RTIN = 0x77, /* Mangement server request */
0222     FC_ELS_RNID = 0x78, /* Mangement server request */
0223     FC_ELS_RLIR = 0x79, /* Registered Link Incident Record */
0224 
0225     FC_ELS_RPSC = 0x7D, /* Report Port Speed Capabilities */
0226     FC_ELS_QSA = 0x7E,  /* Query Security Attributes. Ref FC-SP */
0227     FC_ELS_E2E_LBEACON = 0x81,
0228                 /* End-to-End Link Beacon */
0229     FC_ELS_AUTH = 0x90, /* Authentication. Ref FC-SP */
0230     FC_ELS_RFCN = 0x97, /* Request Fabric Change Notification. Ref
0231                  *FC-SP */
0232 };
0233 
0234 /*
0235  *  Version numbers for FC-PH standards,
0236  *  used in login to indicate what port
0237  *  supports. See FC-PH-X table 158.
0238  */
0239 enum {
0240     FC_PH_VER_4_3 = 0x09,
0241     FC_PH_VER_PH_3 = 0x20,
0242 };
0243 
0244 /*
0245  * PDU size defines
0246  */
0247 enum {
0248     FC_MIN_PDUSZ = 512,
0249     FC_MAX_PDUSZ = 2112,
0250 };
0251 
0252 /*
0253  * N_Port PLOGI Common Service Parameters.
0254  * FC-PH-x. Figure-76. pg. 308.
0255  */
0256 struct fc_plogi_csp_s {
0257     u8      verhi;      /* FC-PH high version */
0258     u8      verlo;      /* FC-PH low version */
0259     __be16      bbcred;     /* BB_Credit */
0260 
0261 #ifdef __BIG_ENDIAN
0262     u8      ciro:1,     /* continuously increasing RO */
0263             rro:1,      /* random relative offset */
0264             npiv_supp:1,    /* NPIV supported */
0265             port_type:1,    /* N_Port/F_port */
0266             altbbcred:1,    /* alternate BB_Credit */
0267             resolution:1,   /* ms/ns ED_TOV resolution */
0268             vvl_info:1, /* VVL Info included */
0269             reserved1:1;
0270 
0271     u8      hg_supp:1,
0272             query_dbc:1,
0273             security:1,
0274             sync_cap:1,
0275             r_t_tov:1,
0276             dh_dup_supp:1,
0277             cisc:1,     /* continuously increasing seq count */
0278             payload:1;
0279 #else
0280     u8      reserved2:2,
0281             resolution:1,   /* ms/ns ED_TOV resolution */
0282             altbbcred:1,    /* alternate BB_Credit */
0283             port_type:1,    /* N_Port/F_port */
0284             npiv_supp:1,    /* NPIV supported */
0285             rro:1,      /* random relative offset */
0286             ciro:1;     /* continuously increasing RO */
0287 
0288     u8      payload:1,
0289             cisc:1,     /* continuously increasing seq count */
0290             dh_dup_supp:1,
0291             r_t_tov:1,
0292             sync_cap:1,
0293             security:1,
0294             query_dbc:1,
0295             hg_supp:1;
0296 #endif
0297     __be16      rxsz;       /* receive data_field size */
0298     __be16      conseq;
0299     __be16      ro_bitmap;
0300     __be32      e_d_tov;
0301 };
0302 
0303 /*
0304  * N_Port PLOGI Class Specific Parameters.
0305  * FC-PH-x. Figure 78. pg. 318.
0306  */
0307 struct fc_plogi_clp_s {
0308 #ifdef __BIG_ENDIAN
0309     u32        class_valid:1;
0310     u32        intermix:1;  /* class intermix supported if set =1.
0311                  * valid only for class1. Reserved for
0312                  * class2 & class3 */
0313     u32        reserved1:2;
0314     u32        sequential:1;
0315     u32        reserved2:3;
0316 #else
0317     u32        reserved2:3;
0318     u32        sequential:1;
0319     u32        reserved1:2;
0320     u32        intermix:1;  /* class intermix supported if set =1.
0321                  * valid only for class1. Reserved for
0322                  * class2 & class3 */
0323     u32        class_valid:1;
0324 #endif
0325     u32        reserved3:24;
0326 
0327     u32        reserved4:16;
0328     u32        rxsz:16; /* Receive data_field size */
0329 
0330     u32        reserved5:8;
0331     u32        conseq:8;
0332     u32        e2e_credit:16; /* end to end credit */
0333 
0334     u32        reserved7:8;
0335     u32        ospx:8;
0336     u32        reserved8:16;
0337 };
0338 
0339 /* ASCII value for each character in string "BRCD" */
0340 #define FLOGI_VVL_BRCD    0x42524344
0341 
0342 /*
0343  * PLOGI els command and reply payload
0344  */
0345 struct fc_logi_s {
0346     struct fc_els_cmd_s els_cmd;    /* ELS command code */
0347     struct fc_plogi_csp_s   csp;        /* common service params */
0348     wwn_t           port_name;
0349     wwn_t           node_name;
0350     struct fc_plogi_clp_s   class1;     /* class 1 service parameters */
0351     struct fc_plogi_clp_s   class2;     /* class 2 service parameters */
0352     struct fc_plogi_clp_s   class3;     /* class 3 service parameters */
0353     struct fc_plogi_clp_s   class4;     /* class 4 service parameters */
0354     u8          vvl[16];    /* vendor version level */
0355 };
0356 
0357 /*
0358  * LOGO els command payload
0359  */
0360 struct fc_logo_s {
0361     struct fc_els_cmd_s els_cmd;    /* ELS command code */
0362     u32         res1:8;
0363     u32     nport_id:24;    /* N_Port identifier of source */
0364     wwn_t           orig_port_name; /* Port name of the LOGO originator */
0365 };
0366 
0367 /*
0368  * ADISC els command payload
0369  */
0370 struct fc_adisc_s {
0371     struct fc_els_cmd_s els_cmd;    /* ELS command code */
0372     u32     res1:8;
0373     u32     orig_HA:24; /* originator hard address */
0374     wwn_t       orig_port_name; /* originator port name */
0375     wwn_t       orig_node_name; /* originator node name */
0376     u32     res2:8;
0377     u32     nport_id:24;    /* originator NPortID */
0378 };
0379 
0380 /*
0381  * Exchange status block
0382  */
0383 struct fc_exch_status_blk_s {
0384     u32        oxid:16;
0385     u32        rxid:16;
0386     u32        res1:8;
0387     u32        orig_np:24;  /* originator NPortID */
0388     u32        res2:8;
0389     u32        resp_np:24;  /* responder NPortID */
0390     u32        es_bits;
0391     u32        res3;
0392     /*
0393      * un modified section of the fields
0394      */
0395 };
0396 
0397 /*
0398  * RES els command payload
0399  */
0400 struct fc_res_s {
0401     struct fc_els_cmd_s els_cmd;    /* ELS command code */
0402     u32        res1:8;
0403     u32        nport_id:24;     /* N_Port identifier of source */
0404     u32        oxid:16;
0405     u32        rxid:16;
0406     u8         assoc_hdr[32];
0407 };
0408 
0409 /*
0410  * RES els accept payload
0411  */
0412 struct fc_res_acc_s {
0413     struct fc_els_cmd_s     els_cmd;    /* ELS command code */
0414     struct fc_exch_status_blk_s fc_exch_blk; /* Exchange status block */
0415 };
0416 
0417 /*
0418  * REC els command payload
0419  */
0420 struct fc_rec_s {
0421     struct fc_els_cmd_s els_cmd;    /* ELS command code */
0422     u32        res1:8;
0423     u32        nport_id:24; /* N_Port identifier of source */
0424     u32        oxid:16;
0425     u32        rxid:16;
0426 };
0427 
0428 #define FC_REC_ESB_OWN_RSP  0x80000000  /* responder owns */
0429 #define FC_REC_ESB_SI       0x40000000  /* SI is owned  */
0430 #define FC_REC_ESB_COMP     0x20000000  /* exchange is complete */
0431 #define FC_REC_ESB_ENDCOND_ABN  0x10000000  /* abnormal ending  */
0432 #define FC_REC_ESB_RQACT    0x04000000  /* recovery qual active */
0433 #define FC_REC_ESB_ERRP_MSK 0x03000000
0434 #define FC_REC_ESB_OXID_INV 0x00800000  /* invalid OXID     */
0435 #define FC_REC_ESB_RXID_INV 0x00400000  /* invalid RXID     */
0436 #define FC_REC_ESB_PRIO_INUSE   0x00200000
0437 
0438 /*
0439  * REC els accept payload
0440  */
0441 struct fc_rec_acc_s {
0442     struct fc_els_cmd_s els_cmd;    /* ELS command code */
0443     u32        oxid:16;
0444     u32        rxid:16;
0445     u32        res1:8;
0446     u32        orig_id:24;  /* N_Port id of exchange originator */
0447     u32        res2:8;
0448     u32        resp_id:24;  /* N_Port id of exchange responder */
0449     u32        count;   /* data transfer count */
0450     u32        e_stat;  /* exchange status */
0451 };
0452 
0453 /*
0454  * RSI els payload
0455  */
0456 struct fc_rsi_s {
0457     struct fc_els_cmd_s els_cmd;
0458     u32        res1:8;
0459     u32        orig_sid:24;
0460     u32        oxid:16;
0461     u32        rxid:16;
0462 };
0463 
0464 /*
0465  * structure for PRLI paramater pages, both request & response
0466  * see FC-PH-X table 113 & 115 for explanation also FCP table 8
0467  */
0468 struct fc_prli_params_s {
0469     u32        reserved:16;
0470 #ifdef __BIG_ENDIAN
0471     u32        reserved1:5;
0472     u32        rec_support:1;
0473     u32        task_retry_id:1;
0474     u32        retry:1;
0475 
0476     u32        confirm:1;
0477     u32        doverlay:1;
0478     u32        initiator:1;
0479     u32        target:1;
0480     u32        cdmix:1;
0481     u32        drmix:1;
0482     u32        rxrdisab:1;
0483     u32        wxrdisab:1;
0484 #else
0485     u32        retry:1;
0486     u32        task_retry_id:1;
0487     u32        rec_support:1;
0488     u32        reserved1:5;
0489 
0490     u32        wxrdisab:1;
0491     u32        rxrdisab:1;
0492     u32        drmix:1;
0493     u32        cdmix:1;
0494     u32        target:1;
0495     u32        initiator:1;
0496     u32        doverlay:1;
0497     u32        confirm:1;
0498 #endif
0499 };
0500 
0501 /*
0502  * valid values for rspcode in PRLI ACC payload
0503  */
0504 enum {
0505     FC_PRLI_ACC_XQTD = 0x1,     /* request executed */
0506     FC_PRLI_ACC_PREDEF_IMG = 0x5,   /* predefined image - no prli needed */
0507 };
0508 
0509 struct fc_prli_params_page_s {
0510     u32        type:8;
0511     u32        codext:8;
0512 #ifdef __BIG_ENDIAN
0513     u32        origprocasv:1;
0514     u32        rsppav:1;
0515     u32        imagepair:1;
0516     u32        reserved1:1;
0517     u32        rspcode:4;
0518 #else
0519     u32        rspcode:4;
0520     u32        reserved1:1;
0521     u32        imagepair:1;
0522     u32        rsppav:1;
0523     u32        origprocasv:1;
0524 #endif
0525     u32        reserved2:8;
0526 
0527     u32        origprocas;
0528     u32        rspprocas;
0529     struct fc_prli_params_s servparams;
0530 };
0531 
0532 /*
0533  * PRLI request and accept payload, FC-PH-X tables 112 & 114
0534  */
0535 struct fc_prli_s {
0536     u32        command:8;
0537     u32        pglen:8;
0538     u32        pagebytes:16;
0539     struct fc_prli_params_page_s parampage;
0540 };
0541 
0542 /*
0543  * PRLO logout params page
0544  */
0545 struct fc_prlo_params_page_s {
0546     u32        type:8;
0547     u32        type_ext:8;
0548 #ifdef __BIG_ENDIAN
0549     u32        opa_valid:1; /* originator process associator valid */
0550     u32        rpa_valid:1; /* responder process associator valid */
0551     u32        res1:14;
0552 #else
0553     u32        res1:14;
0554     u32        rpa_valid:1; /* responder process associator valid */
0555     u32        opa_valid:1; /* originator process associator valid */
0556 #endif
0557     u32        orig_process_assc;
0558     u32        resp_process_assc;
0559 
0560     u32        res2;
0561 };
0562 
0563 /*
0564  * PRLO els command payload
0565  */
0566 struct fc_prlo_s {
0567     u32 command:8;
0568     u32 page_len:8;
0569     u32 payload_len:16;
0570     struct fc_prlo_params_page_s    prlo_params[1];
0571 };
0572 
0573 /*
0574  * PRLO Logout response parameter page
0575  */
0576 struct fc_prlo_acc_params_page_s {
0577     u32        type:8;
0578     u32        type_ext:8;
0579 
0580 #ifdef __BIG_ENDIAN
0581     u32        opa_valid:1; /* originator process associator valid */
0582     u32        rpa_valid:1; /* responder process associator valid */
0583     u32        res1:14;
0584 #else
0585     u32        res1:14;
0586     u32        rpa_valid:1; /* responder process associator valid */
0587     u32        opa_valid:1; /* originator process associator valid */
0588 #endif
0589     u32        orig_process_assc;
0590     u32        resp_process_assc;
0591 
0592     u32        fc4type_csp;
0593 };
0594 
0595 /*
0596  * PRLO els command ACC payload
0597  */
0598 struct fc_prlo_acc_s {
0599     u32        command:8;
0600     u32        page_len:8;
0601     u32        payload_len:16;
0602     struct fc_prlo_acc_params_page_s prlo_acc_params[1];
0603 };
0604 
0605 /*
0606  * SCR els command payload
0607  */
0608 enum {
0609     FC_SCR_REG_FUNC_FABRIC_DETECTED = 0x01,
0610     FC_SCR_REG_FUNC_N_PORT_DETECTED = 0x02,
0611     FC_SCR_REG_FUNC_FULL = 0x03,
0612     FC_SCR_REG_FUNC_CLEAR_REG = 0xFF,
0613 };
0614 
0615 /* SCR VU registrations */
0616 enum {
0617     FC_VU_SCR_REG_FUNC_FABRIC_NAME_CHANGE = 0x01
0618 };
0619 
0620 struct fc_scr_s {
0621     u32 command:8;
0622     u32 res:24;
0623     u32 vu_reg_func:8; /* Vendor Unique Registrations */
0624     u32 res1:16;
0625     u32 reg_func:8;
0626 };
0627 
0628 /*
0629  * Information category for Basic link data
0630  */
0631 enum {
0632     FC_CAT_NOP  = 0x0,
0633     FC_CAT_ABTS = 0x1,
0634     FC_CAT_RMC  = 0x2,
0635     FC_CAT_BA_ACC   = 0x4,
0636     FC_CAT_BA_RJT   = 0x5,
0637     FC_CAT_PRMT = 0x6,
0638 };
0639 
0640 /*
0641  * LS_RJT els reply payload
0642  */
0643 struct fc_ls_rjt_s {
0644     struct fc_els_cmd_s els_cmd;    /* ELS command code */
0645     u32        res1:8;
0646     u32        reason_code:8;   /* Reason code for reject */
0647     u32        reason_code_expl:8;  /* Reason code explanation */
0648     u32        vendor_unique:8; /* Vendor specific */
0649 };
0650 
0651 /*
0652  * LS_RJT reason codes
0653  */
0654 enum {
0655     FC_LS_RJT_RSN_INV_CMD_CODE  = 0x01,
0656     FC_LS_RJT_RSN_LOGICAL_ERROR = 0x03,
0657     FC_LS_RJT_RSN_LOGICAL_BUSY  = 0x05,
0658     FC_LS_RJT_RSN_PROTOCOL_ERROR    = 0x07,
0659     FC_LS_RJT_RSN_UNABLE_TO_PERF_CMD = 0x09,
0660     FC_LS_RJT_RSN_CMD_NOT_SUPP  = 0x0B,
0661 };
0662 
0663 /*
0664  * LS_RJT reason code explanation
0665  */
0666 enum {
0667     FC_LS_RJT_EXP_NO_ADDL_INFO      = 0x00,
0668     FC_LS_RJT_EXP_SPARMS_ERR_OPTIONS    = 0x01,
0669     FC_LS_RJT_EXP_SPARMS_ERR_INI_CTL    = 0x03,
0670     FC_LS_RJT_EXP_SPARMS_ERR_REC_CTL    = 0x05,
0671     FC_LS_RJT_EXP_SPARMS_ERR_RXSZ       = 0x07,
0672     FC_LS_RJT_EXP_SPARMS_ERR_CONSEQ     = 0x09,
0673     FC_LS_RJT_EXP_SPARMS_ERR_CREDIT     = 0x0B,
0674     FC_LS_RJT_EXP_INV_PORT_NAME     = 0x0D,
0675     FC_LS_RJT_EXP_INV_NODE_FABRIC_NAME  = 0x0E,
0676     FC_LS_RJT_EXP_INV_CSP           = 0x0F,
0677     FC_LS_RJT_EXP_INV_ASSOC_HDR     = 0x11,
0678     FC_LS_RJT_EXP_ASSOC_HDR_REQD        = 0x13,
0679     FC_LS_RJT_EXP_INV_ORIG_S_ID     = 0x15,
0680     FC_LS_RJT_EXP_INV_OXID_RXID_COMB    = 0x17,
0681     FC_LS_RJT_EXP_CMD_ALREADY_IN_PROG   = 0x19,
0682     FC_LS_RJT_EXP_LOGIN_REQUIRED        = 0x1E,
0683     FC_LS_RJT_EXP_INVALID_NPORT_ID      = 0x1F,
0684     FC_LS_RJT_EXP_INSUFF_RES        = 0x29,
0685     FC_LS_RJT_EXP_CMD_NOT_SUPP      = 0x2C,
0686     FC_LS_RJT_EXP_INV_PAYLOAD_LEN       = 0x2D,
0687 };
0688 
0689 /*
0690  * RRQ els command payload
0691  */
0692 struct fc_rrq_s {
0693     struct fc_els_cmd_s els_cmd;    /* ELS command code */
0694     u32        res1:8;
0695     u32        s_id:24; /* exchange originator S_ID */
0696 
0697     u32        ox_id:16;    /* originator exchange ID */
0698     u32        rx_id:16;    /* responder exchange ID */
0699 
0700     u32        res2[8]; /* optional association header */
0701 };
0702 
0703 /*
0704  * ABTS BA_ACC reply payload
0705  */
0706 struct fc_ba_acc_s {
0707     u32        seq_id_valid:8;  /* set to 0x00 for Abort Exchange */
0708     u32        seq_id:8;        /* invalid for Abort Exchange */
0709     u32        res2:16;
0710     u32        ox_id:16;        /* OX_ID from ABTS frame */
0711     u32        rx_id:16;        /* RX_ID from ABTS frame */
0712     u32        low_seq_cnt:16;  /* set to 0x0000 for Abort Exchange */
0713     u32        high_seq_cnt:16; /* set to 0xFFFF for Abort Exchange */
0714 };
0715 
0716 /*
0717  * ABTS BA_RJT reject payload
0718  */
0719 struct fc_ba_rjt_s {
0720     u32        res1:8;      /* Reserved */
0721     u32        reason_code:8;   /* reason code for reject */
0722     u32        reason_expl:8;   /* reason code explanation */
0723     u32        vendor_unique:8; /* vendor unique reason code,set to 0 */
0724 };
0725 
0726 /*
0727  * TPRLO logout parameter page
0728  */
0729 struct fc_tprlo_params_page_s {
0730     u32        type:8;
0731     u32        type_ext:8;
0732 
0733 #ifdef __BIG_ENDIAN
0734     u32        opa_valid:1;
0735     u32        rpa_valid:1;
0736     u32        tpo_nport_valid:1;
0737     u32        global_process_logout:1;
0738     u32        res1:12;
0739 #else
0740     u32        res1:12;
0741     u32        global_process_logout:1;
0742     u32        tpo_nport_valid:1;
0743     u32        rpa_valid:1;
0744     u32        opa_valid:1;
0745 #endif
0746 
0747     u32        orig_process_assc;
0748     u32        resp_process_assc;
0749 
0750     u32        res2:8;
0751     u32        tpo_nport_id;
0752 };
0753 
0754 /*
0755  * TPRLO ELS command payload
0756  */
0757 struct fc_tprlo_s {
0758     u32        command:8;
0759     u32        page_len:8;
0760     u32        payload_len:16;
0761 
0762     struct fc_tprlo_params_page_s tprlo_params[1];
0763 };
0764 
0765 enum fc_tprlo_type {
0766     FC_GLOBAL_LOGO = 1,
0767     FC_TPR_LOGO
0768 };
0769 
0770 /*
0771  * TPRLO els command ACC payload
0772  */
0773 struct fc_tprlo_acc_s {
0774     u32 command:8;
0775     u32 page_len:8;
0776     u32 payload_len:16;
0777     struct fc_prlo_acc_params_page_s tprlo_acc_params[1];
0778 };
0779 
0780 /*
0781  * RSCN els command req payload
0782  */
0783 #define FC_RSCN_PGLEN   0x4
0784 
0785 enum fc_rscn_format {
0786     FC_RSCN_FORMAT_PORTID   = 0x0,
0787     FC_RSCN_FORMAT_AREA = 0x1,
0788     FC_RSCN_FORMAT_DOMAIN   = 0x2,
0789     FC_RSCN_FORMAT_FABRIC   = 0x3,
0790 };
0791 
0792 struct fc_rscn_event_s {
0793     u32 format:2;
0794     u32 qualifier:4;
0795     u32 resvd:2;
0796     u32 portid:24;
0797 };
0798 
0799 struct fc_rscn_pl_s {
0800     u8  command;
0801     u8  pagelen;
0802     __be16  payldlen;
0803     struct fc_rscn_event_s event[1];
0804 };
0805 
0806 /*
0807  * ECHO els command req payload
0808  */
0809 struct fc_echo_s {
0810     struct fc_els_cmd_s els_cmd;
0811 };
0812 
0813 /*
0814  * RNID els command
0815  */
0816 #define RNID_NODEID_DATA_FORMAT_COMMON          0x00
0817 #define RNID_NODEID_DATA_FORMAT_FCP3            0x08
0818 #define RNID_NODEID_DATA_FORMAT_DISCOVERY       0xDF
0819 
0820 #define RNID_ASSOCIATED_TYPE_UNKNOWN            0x00000001
0821 #define RNID_ASSOCIATED_TYPE_OTHER                      0x00000002
0822 #define RNID_ASSOCIATED_TYPE_HUB                        0x00000003
0823 #define RNID_ASSOCIATED_TYPE_SWITCH                     0x00000004
0824 #define RNID_ASSOCIATED_TYPE_GATEWAY                    0x00000005
0825 #define RNID_ASSOCIATED_TYPE_STORAGE_DEVICE             0x00000009
0826 #define RNID_ASSOCIATED_TYPE_HOST                       0x0000000A
0827 #define RNID_ASSOCIATED_TYPE_STORAGE_SUBSYSTEM          0x0000000B
0828 #define RNID_ASSOCIATED_TYPE_STORAGE_ACCESS_DEVICE      0x0000000E
0829 #define RNID_ASSOCIATED_TYPE_NAS_SERVER                 0x00000011
0830 #define RNID_ASSOCIATED_TYPE_BRIDGE                     0x00000002
0831 #define RNID_ASSOCIATED_TYPE_VIRTUALIZATION_DEVICE      0x00000003
0832 #define RNID_ASSOCIATED_TYPE_MULTI_FUNCTION_DEVICE      0x000000FF
0833 
0834 /*
0835  * RNID els command payload
0836  */
0837 struct fc_rnid_cmd_s {
0838     struct fc_els_cmd_s els_cmd;
0839     u32        node_id_data_format:8;
0840     u32        reserved:24;
0841 };
0842 
0843 /*
0844  * RNID els response payload
0845  */
0846 
0847 struct fc_rnid_common_id_data_s {
0848     wwn_t       port_name;
0849     wwn_t           node_name;
0850 };
0851 
0852 struct fc_rnid_general_topology_data_s {
0853     u32        vendor_unique[4];
0854     __be32     asso_type;
0855     u32        phy_port_num;
0856     __be32     num_attached_nodes;
0857     u32        node_mgmt:8;
0858     u32        ip_version:8;
0859     u32        udp_tcp_port_num:16;
0860     u32        ip_address[4];
0861     u32        reserved:16;
0862     u32        vendor_specific:16;
0863 };
0864 
0865 struct fc_rnid_acc_s {
0866     struct fc_els_cmd_s els_cmd;
0867     u32        node_id_data_format:8;
0868     u32        common_id_data_length:8;
0869     u32        reserved:8;
0870     u32        specific_id_data_length:8;
0871     struct fc_rnid_common_id_data_s common_id_data;
0872     struct fc_rnid_general_topology_data_s gen_topology_data;
0873 };
0874 
0875 #define RNID_ASSOCIATED_TYPE_UNKNOWN                    0x00000001
0876 #define RNID_ASSOCIATED_TYPE_OTHER                      0x00000002
0877 #define RNID_ASSOCIATED_TYPE_HUB                        0x00000003
0878 #define RNID_ASSOCIATED_TYPE_SWITCH                     0x00000004
0879 #define RNID_ASSOCIATED_TYPE_GATEWAY                    0x00000005
0880 #define RNID_ASSOCIATED_TYPE_STORAGE_DEVICE             0x00000009
0881 #define RNID_ASSOCIATED_TYPE_HOST                       0x0000000A
0882 #define RNID_ASSOCIATED_TYPE_STORAGE_SUBSYSTEM          0x0000000B
0883 #define RNID_ASSOCIATED_TYPE_STORAGE_ACCESS_DEVICE      0x0000000E
0884 #define RNID_ASSOCIATED_TYPE_NAS_SERVER                 0x00000011
0885 #define RNID_ASSOCIATED_TYPE_BRIDGE                     0x00000002
0886 #define RNID_ASSOCIATED_TYPE_VIRTUALIZATION_DEVICE      0x00000003
0887 #define RNID_ASSOCIATED_TYPE_MULTI_FUNCTION_DEVICE      0x000000FF
0888 
0889 enum fc_rpsc_speed_cap {
0890     RPSC_SPEED_CAP_1G = 0x8000,
0891     RPSC_SPEED_CAP_2G = 0x4000,
0892     RPSC_SPEED_CAP_4G = 0x2000,
0893     RPSC_SPEED_CAP_10G = 0x1000,
0894     RPSC_SPEED_CAP_8G = 0x0800,
0895     RPSC_SPEED_CAP_16G = 0x0400,
0896 
0897     RPSC_SPEED_CAP_UNKNOWN = 0x0001,
0898 };
0899 
0900 enum fc_rpsc_op_speed {
0901     RPSC_OP_SPEED_1G = 0x8000,
0902     RPSC_OP_SPEED_2G = 0x4000,
0903     RPSC_OP_SPEED_4G = 0x2000,
0904     RPSC_OP_SPEED_10G = 0x1000,
0905     RPSC_OP_SPEED_8G = 0x0800,
0906     RPSC_OP_SPEED_16G = 0x0400,
0907 
0908     RPSC_OP_SPEED_NOT_EST = 0x0001, /* speed not established */
0909 };
0910 
0911 struct fc_rpsc_speed_info_s {
0912     __be16        port_speed_cap;   /* see enum fc_rpsc_speed_cap */
0913     __be16        port_op_speed;    /* see enum fc_rpsc_op_speed */
0914 };
0915 
0916 /*
0917  * If RPSC request is sent to the Domain Controller, the request is for
0918  * all the ports within that domain.
0919  */
0920 struct fc_rpsc_cmd_s {
0921     struct fc_els_cmd_s els_cmd;
0922 };
0923 
0924 /*
0925  * RPSC Acc
0926  */
0927 struct fc_rpsc_acc_s {
0928     u32        command:8;
0929     u32        rsvd:8;
0930     u32        num_entries:16;
0931 
0932     struct fc_rpsc_speed_info_s speed_info[1];
0933 };
0934 
0935 /*
0936  * If RPSC2 request is sent to the Domain Controller,
0937  */
0938 #define FC_BRCD_TOKEN    0x42524344
0939 
0940 struct fc_rpsc2_cmd_s {
0941     struct fc_els_cmd_s els_cmd;
0942     __be32  token;
0943     u16 resvd;
0944     __be16  num_pids;       /* Number of pids in the request */
0945     struct  {
0946         u32 rsvd1:8;
0947         u32 pid:24;     /* port identifier */
0948     } pid_list[1];
0949 };
0950 
0951 enum fc_rpsc2_port_type {
0952     RPSC2_PORT_TYPE_UNKNOWN = 0,
0953     RPSC2_PORT_TYPE_NPORT   = 1,
0954     RPSC2_PORT_TYPE_NLPORT  = 2,
0955     RPSC2_PORT_TYPE_NPIV_PORT  = 0x5f,
0956     RPSC2_PORT_TYPE_NPORT_TRUNK  = 0x6f,
0957 };
0958 
0959 /*
0960  * RPSC2 portInfo entry structure
0961  */
0962 struct fc_rpsc2_port_info_s {
0963     __be32  pid;        /* PID */
0964     u16 resvd1;
0965     __be16  index;      /* port number / index */
0966     u8  resvd2;
0967     u8  type;       /* port type N/NL/... */
0968     __be16  speed;      /* port Operating Speed */
0969 };
0970 
0971 /*
0972  * RPSC2 Accept payload
0973  */
0974 struct fc_rpsc2_acc_s {
0975     u8        els_cmd;
0976     u8        resvd;
0977     __be16    num_pids; /* Number of pids in the request */
0978     struct fc_rpsc2_port_info_s port_info[1]; /* port information */
0979 };
0980 
0981 /*
0982  * bit fields so that multiple classes can be specified
0983  */
0984 enum fc_cos {
0985     FC_CLASS_2  = 0x04,
0986     FC_CLASS_3  = 0x08,
0987     FC_CLASS_2_3    = 0x0C,
0988 };
0989 
0990 /*
0991  * symbolic name
0992  */
0993 struct fc_symname_s {
0994     u8         symname[FC_SYMNAME_MAX];
0995 };
0996 
0997 struct fc_alpabm_s {
0998     u8  alpa_bm[FC_ALPA_MAX / 8];
0999 };
1000 
1001 /*
1002  * protocol default timeout values
1003  */
1004 #define FC_ED_TOV   2
1005 #define FC_REC_TOV  (FC_ED_TOV + 1)
1006 #define FC_RA_TOV   10
1007 #define FC_ELS_TOV  (2 * FC_RA_TOV)
1008 #define FC_FCCT_TOV (3 * FC_RA_TOV)
1009 
1010 /*
1011  * virtual fabric related defines
1012  */
1013 #define FC_VF_ID_NULL    0  /*  must not be used as VF_ID */
1014 #define FC_VF_ID_MIN     1
1015 #define FC_VF_ID_MAX     0xEFF
1016 #define FC_VF_ID_CTL     0xFEF  /*  control VF_ID */
1017 
1018 /*
1019  * Virtual Fabric Tagging header format
1020  * @caution This is defined only in BIG ENDIAN format.
1021  */
1022 struct fc_vft_s {
1023     u32        r_ctl:8;
1024     u32        ver:2;
1025     u32        type:4;
1026     u32        res_a:2;
1027     u32        priority:3;
1028     u32        vf_id:12;
1029     u32        res_b:1;
1030     u32        hopct:8;
1031     u32        res_c:24;
1032 };
1033 
1034 /*
1035  * FCP_CMND definitions
1036  */
1037 #define FCP_CMND_CDB_LEN    16
1038 #define FCP_CMND_LUN_LEN    8
1039 
1040 struct fcp_cmnd_s {
1041     struct scsi_lun lun;        /* 64-bit LU number */
1042     u8      crn;        /* command reference number */
1043 #ifdef __BIG_ENDIAN
1044     u8      resvd:1,
1045             priority:4, /* FCP-3: SAM-3 priority */
1046             taskattr:3; /* scsi task attribute */
1047 #else
1048     u8      taskattr:3, /* scsi task attribute */
1049             priority:4, /* FCP-3: SAM-3 priority */
1050             resvd:1;
1051 #endif
1052     u8      tm_flags;   /* task management flags */
1053 #ifdef __BIG_ENDIAN
1054     u8      addl_cdb_len:6, /* additional CDB length words */
1055             iodir:2;    /* read/write FCP_DATA IUs */
1056 #else
1057     u8      iodir:2,    /* read/write FCP_DATA IUs */
1058             addl_cdb_len:6; /* additional CDB length */
1059 #endif
1060     struct scsi_cdb_s      cdb;
1061 
1062     __be32        fcp_dl;   /* bytes to be transferred */
1063 };
1064 
1065 #define fcp_cmnd_cdb_len(_cmnd) ((_cmnd)->addl_cdb_len * 4 + FCP_CMND_CDB_LEN)
1066 #define fcp_cmnd_fcpdl(_cmnd)   ((&(_cmnd)->fcp_dl)[(_cmnd)->addl_cdb_len])
1067 
1068 /*
1069  * struct fcp_cmnd_s .iodir field values
1070  */
1071 enum fcp_iodir {
1072     FCP_IODIR_NONE  = 0,
1073     FCP_IODIR_WRITE = 1,
1074     FCP_IODIR_READ  = 2,
1075     FCP_IODIR_RW    = 3,
1076 };
1077 
1078 /*
1079  * Task management flags field - only one bit shall be set
1080  */
1081 enum fcp_tm_cmnd {
1082     FCP_TM_ABORT_TASK_SET   = BIT(1),
1083     FCP_TM_CLEAR_TASK_SET   = BIT(2),
1084     FCP_TM_LUN_RESET    = BIT(4),
1085     FCP_TM_TARGET_RESET = BIT(5),   /* obsolete in FCP-3 */
1086     FCP_TM_CLEAR_ACA    = BIT(6),
1087 };
1088 
1089 /*
1090  * FCP_RSP residue flags
1091  */
1092 enum fcp_residue {
1093     FCP_NO_RESIDUE = 0,     /* no residue */
1094     FCP_RESID_OVER = 1,     /* more data left that was not sent */
1095     FCP_RESID_UNDER = 2,    /* less data than requested */
1096 };
1097 
1098 struct fcp_rspinfo_s {
1099     u32        res0:24;
1100     u32        rsp_code:8;      /* response code (as above) */
1101     u32        res1;
1102 };
1103 
1104 struct fcp_resp_s {
1105     u32        reserved[2];     /* 2 words reserved */
1106     u16        reserved2;
1107 #ifdef __BIG_ENDIAN
1108     u8         reserved3:3;
1109     u8         fcp_conf_req:1;  /* FCP_CONF is requested */
1110     u8         resid_flags:2;   /* underflow/overflow */
1111     u8         sns_len_valid:1; /* sense len is valid */
1112     u8         rsp_len_valid:1; /* response len is valid */
1113 #else
1114     u8         rsp_len_valid:1; /* response len is valid */
1115     u8         sns_len_valid:1; /* sense len is valid */
1116     u8         resid_flags:2;   /* underflow/overflow */
1117     u8         fcp_conf_req:1;  /* FCP_CONF is requested */
1118     u8         reserved3:3;
1119 #endif
1120     u8         scsi_status;     /* one byte SCSI status */
1121     u32        residue;     /* residual data bytes */
1122     u32        sns_len;     /* length od sense info */
1123     u32        rsp_len;     /* length of response info */
1124 };
1125 
1126 #define fcp_snslen(__fcprsp)    ((__fcprsp)->sns_len_valid ?        \
1127                     (__fcprsp)->sns_len : 0)
1128 #define fcp_rsplen(__fcprsp)    ((__fcprsp)->rsp_len_valid ?        \
1129                     (__fcprsp)->rsp_len : 0)
1130 #define fcp_rspinfo(__fcprsp)   ((struct fcp_rspinfo_s *)((__fcprsp) + 1))
1131 #define fcp_snsinfo(__fcprsp)   (((u8 *)fcp_rspinfo(__fcprsp)) +    \
1132                         fcp_rsplen(__fcprsp))
1133 /*
1134  * CT
1135  */
1136 struct ct_hdr_s {
1137     u32 rev_id:8;   /* Revision of the CT */
1138     u32 in_id:24;   /* Initiator Id */
1139     u32 gs_type:8;  /* Generic service Type */
1140     u32 gs_sub_type:8;  /* Generic service sub type */
1141     u32 options:8;  /* options */
1142     u32 rsvrd:8;    /* reserved */
1143     u32 cmd_rsp_code:16;/* ct command/response code */
1144     u32 max_res_size:16;/* maximum/residual size */
1145     u32 frag_id:8;  /* fragment ID */
1146     u32 reason_code:8;  /* reason code */
1147     u32 exp_code:8; /* explanation code */
1148     u32 vendor_unq:8;   /* vendor unique */
1149 };
1150 
1151 /*
1152  * defines for the Revision
1153  */
1154 enum {
1155     CT_GS3_REVISION = 0x01,
1156 };
1157 
1158 /*
1159  * defines for gs_type
1160  */
1161 enum {
1162     CT_GSTYPE_KEYSERVICE    = 0xF7,
1163     CT_GSTYPE_ALIASSERVICE  = 0xF8,
1164     CT_GSTYPE_MGMTSERVICE   = 0xFA,
1165     CT_GSTYPE_TIMESERVICE   = 0xFB,
1166     CT_GSTYPE_DIRSERVICE    = 0xFC,
1167 };
1168 
1169 /*
1170  * defines for gs_sub_type for gs type directory service
1171  */
1172 enum {
1173     CT_GSSUBTYPE_NAMESERVER = 0x02,
1174 };
1175 
1176 /*
1177  * defines for gs_sub_type for gs type management service
1178  */
1179 enum {
1180     CT_GSSUBTYPE_CFGSERVER  = 0x01,
1181     CT_GSSUBTYPE_UNZONED_NS = 0x02,
1182     CT_GSSUBTYPE_ZONESERVER = 0x03,
1183     CT_GSSUBTYPE_LOCKSERVER = 0x04,
1184     CT_GSSUBTYPE_HBA_MGMTSERVER = 0x10, /* for FDMI */
1185 };
1186 
1187 /*
1188  * defines for CT response code field
1189  */
1190 enum {
1191     CT_RSP_REJECT = 0x8001,
1192     CT_RSP_ACCEPT = 0x8002,
1193 };
1194 
1195 /*
1196  * definitions for CT reason code
1197  */
1198 enum {
1199     CT_RSN_INV_CMD      = 0x01,
1200     CT_RSN_INV_VER      = 0x02,
1201     CT_RSN_LOGIC_ERR    = 0x03,
1202     CT_RSN_INV_SIZE     = 0x04,
1203     CT_RSN_LOGICAL_BUSY = 0x05,
1204     CT_RSN_PROTO_ERR    = 0x07,
1205     CT_RSN_UNABLE_TO_PERF   = 0x09,
1206     CT_RSN_NOT_SUPP     = 0x0B,
1207     CT_RSN_SERVER_NOT_AVBL  = 0x0D,
1208     CT_RSN_SESSION_COULD_NOT_BE_ESTBD = 0x0E,
1209     CT_RSN_VENDOR_SPECIFIC  = 0xFF,
1210 
1211 };
1212 
1213 /*
1214  * definitions for explanations code for Name server
1215  */
1216 enum {
1217     CT_NS_EXP_NOADDITIONAL  = 0x00,
1218     CT_NS_EXP_ID_NOT_REG    = 0x01,
1219     CT_NS_EXP_PN_NOT_REG    = 0x02,
1220     CT_NS_EXP_NN_NOT_REG    = 0x03,
1221     CT_NS_EXP_CS_NOT_REG    = 0x04,
1222     CT_NS_EXP_IPN_NOT_REG   = 0x05,
1223     CT_NS_EXP_IPA_NOT_REG   = 0x06,
1224     CT_NS_EXP_FT_NOT_REG    = 0x07,
1225     CT_NS_EXP_SPN_NOT_REG   = 0x08,
1226     CT_NS_EXP_SNN_NOT_REG   = 0x09,
1227     CT_NS_EXP_PT_NOT_REG    = 0x0A,
1228     CT_NS_EXP_IPP_NOT_REG   = 0x0B,
1229     CT_NS_EXP_FPN_NOT_REG   = 0x0C,
1230     CT_NS_EXP_HA_NOT_REG    = 0x0D,
1231     CT_NS_EXP_FD_NOT_REG    = 0x0E,
1232     CT_NS_EXP_FF_NOT_REG    = 0x0F,
1233     CT_NS_EXP_ACCESSDENIED  = 0x10,
1234     CT_NS_EXP_UNACCEPTABLE_ID = 0x11,
1235     CT_NS_EXP_DATABASEEMPTY     = 0x12,
1236     CT_NS_EXP_NOT_REG_IN_SCOPE  = 0x13,
1237     CT_NS_EXP_DOM_ID_NOT_PRESENT    = 0x14,
1238     CT_NS_EXP_PORT_NUM_NOT_PRESENT  = 0x15,
1239     CT_NS_EXP_NO_DEVICE_ATTACHED    = 0x16
1240 };
1241 
1242 /*
1243  * definitions for the explanation code for all servers
1244  */
1245 enum {
1246     CT_EXP_AUTH_EXCEPTION       = 0xF1,
1247     CT_EXP_DB_FULL          = 0xF2,
1248     CT_EXP_DB_EMPTY         = 0xF3,
1249     CT_EXP_PROCESSING_REQ       = 0xF4,
1250     CT_EXP_UNABLE_TO_VERIFY_CONN    = 0xF5,
1251     CT_EXP_DEVICES_NOT_IN_CMN_ZONE  = 0xF6
1252 };
1253 
1254 /*
1255  * Command codes for Name server
1256  */
1257 enum {
1258     GS_GID_PN   = 0x0121,   /* Get Id on port name */
1259     GS_GPN_ID   = 0x0112,   /* Get port name on ID */
1260     GS_GNN_ID   = 0x0113,   /* Get node name on ID */
1261     GS_GID_FT   = 0x0171,   /* Get Id on FC4 type */
1262     GS_GSPN_ID  = 0x0118,   /* Get symbolic PN on ID */
1263     GS_RFT_ID   = 0x0217,   /* Register fc4type on ID */
1264     GS_RSPN_ID  = 0x0218,   /* Register symbolic PN on ID */
1265     GS_RSNN_NN  = 0x0239,   /* Register symbolic NN on NN */
1266     GS_RPN_ID   = 0x0212,   /* Register port name */
1267     GS_RNN_ID   = 0x0213,   /* Register node name */
1268     GS_RCS_ID   = 0x0214,   /* Register class of service */
1269     GS_RPT_ID   = 0x021A,   /* Register port type */
1270     GS_GA_NXT   = 0x0100,   /* Get all next */
1271     GS_RFF_ID   = 0x021F,   /* Register FC4 Feature     */
1272 };
1273 
1274 struct fcgs_id_req_s {
1275     u32 rsvd:8;
1276     u32 dap:24; /* port identifier */
1277 };
1278 #define fcgs_gpnid_req_t struct fcgs_id_req_s
1279 #define fcgs_gnnid_req_t struct fcgs_id_req_s
1280 #define fcgs_gspnid_req_t struct fcgs_id_req_s
1281 
1282 struct fcgs_gidpn_req_s {
1283     wwn_t   port_name;  /* port wwn */
1284 };
1285 
1286 struct fcgs_gidpn_resp_s {
1287     u32 rsvd:8;
1288     u32 dap:24;     /* port identifier */
1289 };
1290 
1291 /*
1292  * RFT_ID
1293  */
1294 struct fcgs_rftid_req_s {
1295     u32 rsvd:8;
1296     u32 dap:24;     /* port identifier */
1297     __be32  fc4_type[8];    /* fc4 types */
1298 };
1299 
1300 /*
1301  * RFF_ID : Register FC4 features.
1302  */
1303 #define FC_GS_FCP_FC4_FEATURE_INITIATOR  0x02
1304 #define FC_GS_FCP_FC4_FEATURE_TARGET     0x01
1305 
1306 struct fcgs_rffid_req_s {
1307     u32 rsvd:8;
1308     u32 dap:24;     /* port identifier */
1309     u32 rsvd1:16;
1310     u32 fc4ftr_bits:8;  /* fc4 feature bits */
1311     u32 fc4_type:8;     /* corresponding FC4 Type */
1312 };
1313 
1314 /*
1315  * GID_FT Request
1316  */
1317 struct fcgs_gidft_req_s {
1318     u8  reserved;
1319     u8  domain_id;  /* domain, 0 - all fabric */
1320     u8  area_id;    /* area, 0 - whole domain */
1321     u8  fc4_type;   /* FC_TYPE_FCP for SCSI devices */
1322 };
1323 
1324 /*
1325  * GID_FT Response
1326  */
1327 struct fcgs_gidft_resp_s {
1328     u8  last:1;     /* last port identifier flag */
1329     u8  reserved:7;
1330     u32 pid:24;     /* port identifier */
1331 };
1332 
1333 /*
1334  * RSPN_ID
1335  */
1336 struct fcgs_rspnid_req_s {
1337     u32 rsvd:8;
1338     u32 dap:24;     /* port identifier */
1339     u8  spn_len;    /* symbolic port name length */
1340     u8  spn[256];   /* symbolic port name */
1341 };
1342 
1343 /*
1344  * RSNN_NN
1345  */
1346 struct fcgs_rsnn_nn_req_s {
1347     wwn_t   node_name;  /* Node name */
1348     u8  snn_len;    /* symbolic node name length */
1349     u8  snn[256];   /* symbolic node name */
1350 };
1351 
1352 /*
1353  * RPN_ID
1354  */
1355 struct fcgs_rpnid_req_s {
1356     u32 rsvd:8;
1357     u32 port_id:24;
1358     wwn_t   port_name;
1359 };
1360 
1361 /*
1362  * RNN_ID
1363  */
1364 struct fcgs_rnnid_req_s {
1365     u32 rsvd:8;
1366     u32 port_id:24;
1367     wwn_t   node_name;
1368 };
1369 
1370 /*
1371  * RCS_ID
1372  */
1373 struct fcgs_rcsid_req_s {
1374     u32 rsvd:8;
1375     u32 port_id:24;
1376     u32 cos;
1377 };
1378 
1379 /*
1380  * RPT_ID
1381  */
1382 struct fcgs_rptid_req_s {
1383     u32 rsvd:8;
1384     u32 port_id:24;
1385     u32 port_type:8;
1386     u32 rsvd1:24;
1387 };
1388 
1389 /*
1390  * GA_NXT Request
1391  */
1392 struct fcgs_ganxt_req_s {
1393     u32 rsvd:8;
1394     u32 port_id:24;
1395 };
1396 
1397 /*
1398  * GA_NXT Response
1399  */
1400 struct fcgs_ganxt_rsp_s {
1401     u32     port_type:8;    /* Port Type */
1402     u32     port_id:24; /* Port Identifier */
1403     wwn_t       port_name;  /* Port Name */
1404     u8      spn_len;    /* Length of Symbolic Port Name */
1405     char        spn[255];   /* Symbolic Port Name */
1406     wwn_t       node_name;  /* Node Name */
1407     u8      snn_len;    /* Length of Symbolic Node Name */
1408     char        snn[255];   /* Symbolic Node Name */
1409     u8      ipa[8];     /* Initial Process Associator */
1410     u8      ip[16];     /* IP Address */
1411     u32     cos;        /* Class of Service */
1412     u32     fc4types[8];    /* FC-4 TYPEs */
1413     wwn_t       fabric_port_name; /* Fabric Port Name */
1414     u32     rsvd:8;     /* Reserved */
1415     u32     hard_addr:24;   /* Hard Address */
1416 };
1417 
1418 /*
1419  * Command codes for Fabric Configuration Server
1420  */
1421 enum {
1422     GS_FC_GFN_CMD   = 0x0114,   /* GS FC Get Fabric Name  */
1423     GS_FC_GMAL_CMD  = 0x0116,   /* GS FC GMAL  */
1424     GS_FC_TRACE_CMD = 0x0400,   /* GS FC Trace Route */
1425     GS_FC_PING_CMD  = 0x0401,   /* GS FC Ping */
1426 };
1427 
1428 /*
1429  * GMAL Command ( Get ( interconnect Element) Management Address List)
1430  * To retrieve the IP Address of a Switch.
1431  */
1432 #define CT_GMAL_RESP_PREFIX_TELNET   "telnet://"
1433 #define CT_GMAL_RESP_PREFIX_HTTP     "http://"
1434 
1435 /*  GMAL/GFN request */
1436 struct fcgs_req_s {
1437     wwn_t    wwn;   /* PWWN/NWWN */
1438 };
1439 
1440 #define fcgs_gmal_req_t struct fcgs_req_s
1441 #define fcgs_gfn_req_t struct fcgs_req_s
1442 
1443 /* Accept Response to GMAL */
1444 struct fcgs_gmal_resp_s {
1445     __be32  ms_len;   /* Num of entries */
1446     u8  ms_ma[256];
1447 };
1448 
1449 struct fcgs_gmal_entry_s {
1450     u8  len;
1451     u8  prefix[7]; /* like "http://" */
1452     u8  ip_addr[248];
1453 };
1454 
1455 /*
1456  * FDMI Command Codes
1457  */
1458 #define FDMI_GRHL       0x0100
1459 #define FDMI_GHAT       0x0101
1460 #define FDMI_GRPL       0x0102
1461 #define FDMI_GPAT       0x0110
1462 #define FDMI_RHBA       0x0200
1463 #define FDMI_RHAT       0x0201
1464 #define FDMI_RPRT       0x0210
1465 #define FDMI_RPA        0x0211
1466 #define FDMI_DHBA       0x0300
1467 #define FDMI_DPRT       0x0310
1468 
1469 /*
1470  * FDMI reason codes
1471  */
1472 #define FDMI_NO_ADDITIONAL_EXP      0x00
1473 #define FDMI_HBA_ALREADY_REG        0x10
1474 #define FDMI_HBA_ATTRIB_NOT_REG     0x11
1475 #define FDMI_HBA_ATTRIB_MULTIPLE    0x12
1476 #define FDMI_HBA_ATTRIB_LENGTH_INVALID  0x13
1477 #define FDMI_HBA_ATTRIB_NOT_PRESENT 0x14
1478 #define FDMI_PORT_ORIG_NOT_IN_LIST  0x15
1479 #define FDMI_PORT_HBA_NOT_IN_LIST   0x16
1480 #define FDMI_PORT_ATTRIB_NOT_REG    0x20
1481 #define FDMI_PORT_NOT_REG       0x21
1482 #define FDMI_PORT_ATTRIB_MULTIPLE   0x22
1483 #define FDMI_PORT_ATTRIB_LENGTH_INVALID 0x23
1484 #define FDMI_PORT_ALREADY_REGISTEREED   0x24
1485 
1486 /*
1487  * FDMI Transmission Speed Mask values
1488  */
1489 #define FDMI_TRANS_SPEED_1G     0x00000001
1490 #define FDMI_TRANS_SPEED_2G     0x00000002
1491 #define FDMI_TRANS_SPEED_10G        0x00000004
1492 #define FDMI_TRANS_SPEED_4G     0x00000008
1493 #define FDMI_TRANS_SPEED_8G     0x00000010
1494 #define FDMI_TRANS_SPEED_16G        0x00000020
1495 #define FDMI_TRANS_SPEED_UNKNOWN    0x00008000
1496 
1497 /*
1498  * FDMI HBA attribute types
1499  */
1500 enum fdmi_hba_attribute_type {
1501     FDMI_HBA_ATTRIB_NODENAME = 1,   /* 0x0001 */
1502     FDMI_HBA_ATTRIB_MANUFACTURER,   /* 0x0002 */
1503     FDMI_HBA_ATTRIB_SERIALNUM,  /* 0x0003 */
1504     FDMI_HBA_ATTRIB_MODEL,      /* 0x0004 */
1505     FDMI_HBA_ATTRIB_MODEL_DESC, /* 0x0005 */
1506     FDMI_HBA_ATTRIB_HW_VERSION, /* 0x0006 */
1507     FDMI_HBA_ATTRIB_DRIVER_VERSION, /* 0x0007 */
1508     FDMI_HBA_ATTRIB_ROM_VERSION,    /* 0x0008 */
1509     FDMI_HBA_ATTRIB_FW_VERSION, /* 0x0009 */
1510     FDMI_HBA_ATTRIB_OS_NAME,    /* 0x000A */
1511     FDMI_HBA_ATTRIB_MAX_CT,     /* 0x000B */
1512     FDMI_HBA_ATTRIB_NODE_SYM_NAME,  /* 0x000C */
1513     FDMI_HBA_ATTRIB_VENDOR_INFO,    /* 0x000D */
1514     FDMI_HBA_ATTRIB_NUM_PORTS,  /* 0x000E */
1515     FDMI_HBA_ATTRIB_FABRIC_NAME,    /* 0x000F */
1516     FDMI_HBA_ATTRIB_BIOS_VER,   /* 0x0010 */
1517     FDMI_HBA_ATTRIB_VENDOR_ID = 0x00E0,
1518 
1519     FDMI_HBA_ATTRIB_MAX_TYPE
1520 };
1521 
1522 /*
1523  * FDMI Port attribute types
1524  */
1525 enum fdmi_port_attribute_type {
1526     FDMI_PORT_ATTRIB_FC4_TYPES = 1, /* 0x0001 */
1527     FDMI_PORT_ATTRIB_SUPP_SPEED,    /* 0x0002 */
1528     FDMI_PORT_ATTRIB_PORT_SPEED,    /* 0x0003 */
1529     FDMI_PORT_ATTRIB_FRAME_SIZE,    /* 0x0004 */
1530     FDMI_PORT_ATTRIB_DEV_NAME,  /* 0x0005 */
1531     FDMI_PORT_ATTRIB_HOST_NAME, /* 0x0006 */
1532     FDMI_PORT_ATTRIB_NODE_NAME,     /* 0x0007 */
1533     FDMI_PORT_ATTRIB_PORT_NAME,     /* 0x0008 */
1534     FDMI_PORT_ATTRIB_PORT_SYM_NAME, /* 0x0009 */
1535     FDMI_PORT_ATTRIB_PORT_TYPE,     /* 0x000A */
1536     FDMI_PORT_ATTRIB_SUPP_COS,      /* 0x000B */
1537     FDMI_PORT_ATTRIB_PORT_FAB_NAME, /* 0x000C */
1538     FDMI_PORT_ATTRIB_PORT_FC4_TYPE, /* 0x000D */
1539     FDMI_PORT_ATTRIB_PORT_STATE = 0x101,    /* 0x0101 */
1540     FDMI_PORT_ATTRIB_PORT_NUM_RPRT = 0x102, /* 0x0102 */
1541 
1542     FDMI_PORT_ATTR_MAX_TYPE
1543 };
1544 
1545 /*
1546  * FDMI attribute
1547  */
1548 struct fdmi_attr_s {
1549     __be16        type;
1550     __be16        len;
1551     u8         value[1];
1552 };
1553 
1554 /*
1555  * HBA Attribute Block
1556  */
1557 struct fdmi_hba_attr_s {
1558     __be32        attr_count;   /* # of attributes */
1559     struct fdmi_attr_s hba_attr;    /* n attributes */
1560 };
1561 
1562 /*
1563  * Registered Port List
1564  */
1565 struct fdmi_port_list_s {
1566     __be32      num_ports;  /* number Of Port Entries */
1567     wwn_t       port_entry; /* one or more */
1568 };
1569 
1570 /*
1571  * Port Attribute Block
1572  */
1573 struct fdmi_port_attr_s {
1574     __be32        attr_count;   /* # of attributes */
1575     struct fdmi_attr_s port_attr;   /* n attributes */
1576 };
1577 
1578 /*
1579  * FDMI Register HBA Attributes
1580  */
1581 struct fdmi_rhba_s {
1582     wwn_t           hba_id;     /* HBA Identifier */
1583     struct fdmi_port_list_s port_list;  /* Registered Port List */
1584     struct fdmi_hba_attr_s hba_attr_blk;    /* HBA attribute block */
1585 };
1586 
1587 /*
1588  * FDMI Register Port
1589  */
1590 struct fdmi_rprt_s {
1591     wwn_t           hba_id;     /* HBA Identifier */
1592     wwn_t           port_name;  /* Port wwn */
1593     struct fdmi_port_attr_s port_attr_blk;  /* Port Attr Block */
1594 };
1595 
1596 /*
1597  * FDMI Register Port Attributes
1598  */
1599 struct fdmi_rpa_s {
1600     wwn_t           port_name;  /* port wwn */
1601     struct fdmi_port_attr_s port_attr_blk;  /* Port Attr Block */
1602 };
1603 
1604 #pragma pack()
1605 
1606 #endif  /* __BFA_FC_H__ */