drivers/scsi/bfa/bfa_fc.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_FC_H__
  19 #define __BFA_FC_H__
  20
  21 #include "bfad_drv.h"
  22
  23 typedef u64 wwn_t;
  24
  25 #define WWN_NULL        (0)
  26 #define FC_SYMNAME_MAX  256     /*  max name server symbolic name size */
  27
  28 #pragma pack(1)
  29
  30 #define MAC_ADDRLEN     (6)
  31 struct mac_s { u8 mac[MAC_ADDRLEN]; };
  32 #define mac_t struct mac_s
  33
  34 /*
  35  * generic SCSI cdb definition
  36  */
  37 #define SCSI_MAX_CDBLEN     16
  38 struct scsi_cdb_s {
  39         u8         scsi_cdb[SCSI_MAX_CDBLEN];
  40 };
  41
  42 /* ------------------------------------------------------------
  43  * SCSI status byte values
  44  * ------------------------------------------------------------
  45  */
  46 #define SCSI_STATUS_GOOD                   0x00
  47 #define SCSI_STATUS_CHECK_CONDITION        0x02
  48 #define SCSI_STATUS_CONDITION_MET          0x04
  49 #define SCSI_STATUS_BUSY                   0x08
  50 #define SCSI_STATUS_INTERMEDIATE           0x10
  51 #define SCSI_STATUS_ICM                    0x14 /* intermediate condition met */
  52 #define SCSI_STATUS_RESERVATION_CONFLICT   0x18
  53 #define SCSI_STATUS_COMMAND_TERMINATED     0x22
  54 #define SCSI_STATUS_QUEUE_FULL             0x28
  55 #define SCSI_STATUS_ACA_ACTIVE             0x30
  56
  57 #define SCSI_MAX_ALLOC_LEN      0xFF    /* maximum allocarion length */
  58
  59 #define SCSI_SENSE_CUR_ERR      0x70
  60 #define SCSI_SENSE_DEF_ERR      0x71
  61
  62 /*
  63  * SCSI additional sense codes
  64  */
  65 #define SCSI_ASC_LUN_NOT_READY          0x04
  66 #define SCSI_ASC_LUN_NOT_SUPPORTED      0x25
  67 #define SCSI_ASC_TOCC                   0x3F
  68
  69 /*
  70  * SCSI additional sense code qualifiers
  71  */
  72 #define SCSI_ASCQ_MAN_INTR_REQ          0x03    /* manual intervention req */
  73 #define SCSI_ASCQ_RL_DATA_CHANGED       0x0E    /* report luns data changed */
  74
  75 /*
  76  * Methods of reporting informational exceptions
  77  */
  78 #define SCSI_MP_IEC_UNIT_ATTN           0x2     /* generate unit attention */
  79
  80 struct scsi_report_luns_data_s {
  81         u32             lun_list_length;        /* length of LUN list length */
  82         u32             reserved;
  83         struct scsi_lun lun[1];                 /* first LUN in lun list */
  84 };
  85
  86 struct scsi_inquiry_vendor_s {
  87         u8      vendor_id[8];
  88 };
  89
  90 struct scsi_inquiry_prodid_s {
  91         u8      product_id[16];
  92 };
  93
  94 struct scsi_inquiry_prodrev_s {
  95         u8      product_rev[4];
  96 };
  97
  98 struct scsi_inquiry_data_s {
  99 #ifdef __BIG_ENDIAN
 100         u8              peripheral_qual:3;      /* peripheral qualifier */
 101         u8              device_type:5;          /* peripheral device type */
 102         u8              rmb:1;                  /* removable medium bit */
 103         u8              device_type_mod:7;      /* device type modifier */
 104         u8              version;
 105         u8              aenc:1;         /* async evt notification capability */
 106         u8              trm_iop:1;      /* terminate I/O process */
 107         u8              norm_aca:1;     /* normal ACA supported */
 108         u8              hi_support:1;   /* SCSI-3: supports REPORT LUNS */
 109         u8              rsp_data_format:4;
 110         u8              additional_len;
 111         u8              sccs:1;
 112         u8              reserved1:7;
 113         u8              reserved2:1;
 114         u8              enc_serv:1;     /* enclosure service component */
 115         u8              reserved3:1;
 116         u8              multi_port:1;   /* multi-port device */
 117         u8              m_chngr:1;      /* device in medium transport element */
 118         u8              ack_req_q:1;    /* SIP specific bit */
 119         u8              addr32:1;       /* SIP specific bit */
 120         u8              addr16:1;       /* SIP specific bit */
 121         u8              rel_adr:1;      /* relative address */
 122         u8              w_bus32:1;
 123         u8              w_bus16:1;
 124         u8              synchronous:1;
 125         u8              linked_commands:1;
 126         u8              trans_dis:1;
 127         u8              cmd_queue:1;    /* command queueing supported */
 128         u8              soft_reset:1;   /* soft reset alternative (VS) */
 129 #else
 130         u8              device_type:5;  /* peripheral device type */
 131         u8              peripheral_qual:3; /* peripheral qualifier */
 132         u8              device_type_mod:7; /* device type modifier */
 133         u8              rmb:1;          /* removable medium bit */
 134         u8              version;
 135         u8              rsp_data_format:4;
 136         u8              hi_support:1;   /* SCSI-3: supports REPORT LUNS */
 137         u8              norm_aca:1;     /* normal ACA supported */
 138         u8              terminate_iop:1;/* terminate I/O process */
 139         u8              aenc:1;         /* async evt notification capability */
 140         u8              additional_len;
 141         u8              reserved1:7;
 142         u8              sccs:1;
 143         u8              addr16:1;       /* SIP specific bit */
 144         u8              addr32:1;       /* SIP specific bit */
 145         u8              ack_req_q:1;    /* SIP specific bit */
 146         u8              m_chngr:1;      /* device in medium transport element */
 147         u8              multi_port:1;   /* multi-port device */
 148         u8              reserved3:1;    /* TBD - Vendor Specific */
 149         u8              enc_serv:1;     /* enclosure service component */
 150         u8              reserved2:1;
 151         u8              soft_seset:1;   /* soft reset alternative (VS) */
 152         u8              cmd_queue:1;    /* command queueing supported */
 153         u8              trans_dis:1;
 154         u8              linked_commands:1;
 155         u8              synchronous:1;
 156         u8              w_bus16:1;
 157         u8              w_bus32:1;
 158         u8              rel_adr:1;      /* relative address */
 159 #endif
 160         struct scsi_inquiry_vendor_s    vendor_id;
 161         struct scsi_inquiry_prodid_s    product_id;
 162         struct scsi_inquiry_prodrev_s   product_rev;
 163         u8              vendor_specific[20];
 164         u8              reserved4[40];
 165 };
 166
 167 /*
 168  *      SCSI sense data format
 169  */
 170 struct scsi_sense_s {
 171 #ifdef __BIG_ENDIAN
 172         u8              valid:1;
 173         u8              rsp_code:7;
 174 #else
 175         u8              rsp_code:7;
 176         u8              valid:1;
 177 #endif
 178         u8              seg_num;
 179 #ifdef __BIG_ENDIAN
 180         u8              file_mark:1;
 181         u8              eom:1;          /* end of media */
 182         u8              ili:1;          /* incorrect length indicator */
 183         u8              reserved:1;
 184         u8              sense_key:4;
 185 #else
 186         u8              sense_key:4;
 187         u8              reserved:1;
 188         u8              ili:1;          /* incorrect length indicator */
 189         u8              eom:1;          /* end of media */
 190         u8              file_mark:1;
 191 #endif
 192         u8              information[4]; /* device-type or cmd specific info */
 193         u8              add_sense_length; /* additional sense length */
 194         u8              command_info[4];/* command specific information */
 195         u8              asc;            /* additional sense code */
 196         u8              ascq;           /* additional sense code qualifier */
 197         u8              fru_code;       /* field replaceable unit code */
 198 #ifdef __BIG_ENDIAN
 199         u8              sksv:1;         /* sense key specific valid */
 200         u8              c_d:1;          /* command/data bit */
 201         u8              res1:2;
 202         u8              bpv:1;          /* bit pointer valid */
 203         u8              bpointer:3;     /* bit pointer */
 204 #else
 205         u8              bpointer:3;     /* bit pointer */
 206         u8              bpv:1;          /* bit pointer valid */
 207         u8              res1:2;
 208         u8              c_d:1;          /* command/data bit */
 209         u8              sksv:1;         /* sense key specific valid */
 210 #endif
 211         u8              fpointer[2];    /* field pointer */
 212 };
 213
 214 /*
 215  * Fibre Channel Header Structure (FCHS) definition
 216  */
 217 struct fchs_s {
 218 #ifdef __BIG_ENDIAN
 219         u32        routing:4;   /* routing bits */
 220         u32        cat_info:4;  /* category info */
 221 #else
 222         u32        cat_info:4;  /* category info */
 223         u32        routing:4;   /* routing bits */
 224 #endif
 225         u32        d_id:24;     /* destination identifier */
 226
 227         u32        cs_ctl:8;    /* class specific control */
 228         u32        s_id:24;     /* source identifier */
 229
 230         u32        type:8;      /* data structure type */
 231         u32        f_ctl:24;    /* initial frame control */
 232
 233         u8         seq_id;      /* sequence identifier */
 234         u8         df_ctl;      /* data field control */
 235         u16        seq_cnt;     /* sequence count */
 236
 237         __be16     ox_id;       /* originator exchange ID */
 238         u16        rx_id;       /* responder exchange ID */
 239
 240         u32        ro;          /* relative offset */
 241 };
 242
 243 /*
 244  * routing bit definitions
 245  */
 246 enum {
 247         FC_RTG_FC4_DEV_DATA     = 0x0,  /* FC-4 Device Data */
 248         FC_RTG_EXT_LINK         = 0x2,  /* Extended Link Data */
 249         FC_RTG_FC4_LINK_DATA    = 0x3,  /* FC-4 Link Data */
 250         FC_RTG_VIDEO_DATA       = 0x4,  /* Video Data */
 251         FC_RTG_EXT_HDR          = 0x5,  /* VFT, IFR or Encapsuled */
 252         FC_RTG_BASIC_LINK       = 0x8,  /* Basic Link data */
 253         FC_RTG_LINK_CTRL        = 0xC,  /* Link Control */
 254 };
 255
 256 /*
 257  * information category for extended link data and FC-4 Link Data
 258  */
 259 enum {
 260         FC_CAT_LD_REQUEST       = 0x2,  /* Request */
 261         FC_CAT_LD_REPLY         = 0x3,  /* Reply */
 262         FC_CAT_LD_DIAG          = 0xF,  /* for DIAG use only */
 263 };
 264
 265 /*
 266  * information category for extended headers (VFT, IFR or encapsulation)
 267  */
 268 enum {
 269         FC_CAT_VFT_HDR = 0x0,   /* Virtual fabric tagging header */
 270         FC_CAT_IFR_HDR = 0x1,   /* Inter-Fabric routing header */
 271         FC_CAT_ENC_HDR = 0x2,   /* Encapsulation header */
 272 };
 273
 274 /*
 275  * information category for FC-4 device data
 276  */
 277 enum {
 278         FC_CAT_UNCATEG_INFO     = 0x0,  /* Uncategorized information */
 279         FC_CAT_SOLICIT_DATA     = 0x1,  /* Solicited Data */
 280         FC_CAT_UNSOLICIT_CTRL   = 0x2,  /* Unsolicited Control */
 281         FC_CAT_SOLICIT_CTRL     = 0x3,  /* Solicited Control */
 282         FC_CAT_UNSOLICIT_DATA   = 0x4,  /* Unsolicited Data */
 283         FC_CAT_DATA_DESC        = 0x5,  /* Data Descriptor */
 284         FC_CAT_UNSOLICIT_CMD    = 0x6,  /* Unsolicited Command */
 285         FC_CAT_CMD_STATUS       = 0x7,  /* Command Status */
 286 };
 287
 288 /*
 289  * Type Field Definitions. FC-PH Section 18.5 pg. 165
 290  */
 291 enum {
 292         FC_TYPE_BLS             = 0x0,  /* Basic Link Service */
 293         FC_TYPE_ELS             = 0x1,  /* Extended Link Service */
 294         FC_TYPE_IP              = 0x5,  /* IP */
 295         FC_TYPE_FCP             = 0x8,  /* SCSI-FCP */
 296         FC_TYPE_GPP             = 0x9,  /* SCSI_GPP */
 297         FC_TYPE_SERVICES        = 0x20, /* Fibre Channel Services */
 298         FC_TYPE_FC_FSS          = 0x22, /* Fabric Switch Services */
 299         FC_TYPE_FC_AL           = 0x23, /* FC-AL */
 300         FC_TYPE_FC_SNMP         = 0x24, /* FC-SNMP */
 301         FC_TYPE_FC_SPINFAB      = 0xEE, /* SPINFAB */
 302         FC_TYPE_FC_DIAG         = 0xEF, /* DIAG */
 303         FC_TYPE_MAX             = 256,  /* 256 FC-4 types */
 304 };
 305
 306 /*
 307  * Frame Control Definitions. FC-PH Table-45. pg. 168
 308  */
 309 enum {
 310         FCTL_EC_ORIG = 0x000000,        /* exchange originator */
 311         FCTL_EC_RESP = 0x800000,        /* exchange responder */
 312         FCTL_SEQ_INI = 0x000000,        /* sequence initiator */
 313         FCTL_SEQ_REC = 0x400000,        /* sequence recipient */
 314         FCTL_FS_EXCH = 0x200000,        /* first sequence of xchg */
 315         FCTL_LS_EXCH = 0x100000,        /* last sequence of xchg */
 316         FCTL_END_SEQ = 0x080000,        /* last frame of sequence */
 317         FCTL_SI_XFER = 0x010000,        /* seq initiative transfer */
 318         FCTL_RO_PRESENT = 0x000008,     /* relative offset present */
 319         FCTL_FILLBYTE_MASK = 0x000003   /* , fill byte mask */
 320 };
 321
 322 /*
 323  * Fabric Well Known Addresses
 324  */
 325 enum {
 326         FC_MIN_WELL_KNOWN_ADDR          = 0xFFFFF0,
 327         FC_DOMAIN_CONTROLLER_MASK       = 0xFFFC00,
 328         FC_ALIAS_SERVER                 = 0xFFFFF8,
 329         FC_MGMT_SERVER                  = 0xFFFFFA,
 330         FC_TIME_SERVER                  = 0xFFFFFB,
 331         FC_NAME_SERVER                  = 0xFFFFFC,
 332         FC_FABRIC_CONTROLLER            = 0xFFFFFD,
 333         FC_FABRIC_PORT                  = 0xFFFFFE,
 334         FC_BROADCAST_SERVER             = 0xFFFFFF
 335 };
 336
 337 /*
 338  * domain/area/port defines
 339  */
 340 #define FC_DOMAIN_MASK  0xFF0000
 341 #define FC_DOMAIN_SHIFT 16
 342 #define FC_AREA_MASK    0x00FF00
 343 #define FC_AREA_SHIFT   8
 344 #define FC_PORT_MASK    0x0000FF
 345 #define FC_PORT_SHIFT   0
 346
 347 #define FC_GET_DOMAIN(p)        (((p) & FC_DOMAIN_MASK) >> FC_DOMAIN_SHIFT)
 348 #define FC_GET_AREA(p)          (((p) & FC_AREA_MASK) >> FC_AREA_SHIFT)
 349 #define FC_GET_PORT(p)          (((p) & FC_PORT_MASK) >> FC_PORT_SHIFT)
 350
 351 #define FC_DOMAIN_CTRLR(p)      (FC_DOMAIN_CONTROLLER_MASK | (FC_GET_DOMAIN(p)))
 352
 353 enum {
 354         FC_RXID_ANY = 0xFFFFU,
 355 };
 356
 357 /*
 358  * generic ELS command
 359  */
 360 struct fc_els_cmd_s {
 361         u32        els_code:8;  /* ELS Command Code */
 362         u32        reserved:24;
 363 };
 364
 365 /*
 366  * ELS Command Codes. FC-PH Table-75. pg. 223
 367  */
 368 enum {
 369         FC_ELS_LS_RJT = 0x1,    /* Link Service Reject. */
 370         FC_ELS_ACC = 0x02,      /* Accept */
 371         FC_ELS_PLOGI = 0x03,    /* N_Port Login. */
 372         FC_ELS_FLOGI = 0x04,    /* F_Port Login. */
 373         FC_ELS_LOGO = 0x05,     /* Logout. */
 374         FC_ELS_ABTX = 0x06,     /* Abort Exchange */
 375         FC_ELS_RES = 0x08,      /* Read Exchange status */
 376         FC_ELS_RSS = 0x09,      /* Read sequence status block */
 377         FC_ELS_RSI = 0x0A,      /* Request Sequence Initiative */
 378         FC_ELS_ESTC = 0x0C,     /* Estimate Credit. */
 379         FC_ELS_RTV = 0x0E,      /* Read Timeout Value. */
 380         FC_ELS_RLS = 0x0F,      /* Read Link Status. */
 381         FC_ELS_ECHO = 0x10,     /* Echo */
 382         FC_ELS_TEST = 0x11,     /* Test */
 383         FC_ELS_RRQ = 0x12,      /* Reinstate Recovery Qualifier. */
 384         FC_ELS_REC = 0x13,      /* Add this for TAPE support in FCR */
 385         FC_ELS_PRLI = 0x20,     /* Process Login */
 386         FC_ELS_PRLO = 0x21,     /* Process Logout. */
 387         FC_ELS_SCN = 0x22,      /* State Change Notification. */
 388         FC_ELS_TPRLO = 0x24,    /* Third Party Process Logout. */
 389         FC_ELS_PDISC = 0x50,    /* Discover N_Port Parameters. */
 390         FC_ELS_FDISC = 0x51,    /* Discover F_Port Parameters. */
 391         FC_ELS_ADISC = 0x52,    /* Discover Address. */
 392         FC_ELS_FARP_REQ = 0x54, /* FARP Request. */
 393         FC_ELS_FARP_REP = 0x55, /* FARP Reply. */
 394         FC_ELS_FAN = 0x60,      /* Fabric Address Notification */
 395         FC_ELS_RSCN = 0x61,     /* Reg State Change Notification */
 396         FC_ELS_SCR = 0x62,      /* State Change Registration. */
 397         FC_ELS_RTIN = 0x77,     /* Mangement server request */
 398         FC_ELS_RNID = 0x78,     /* Mangement server request */
 399         FC_ELS_RLIR = 0x79,     /* Registered Link Incident Record */
 400
 401         FC_ELS_RPSC = 0x7D,     /* Report Port Speed Capabilities */
 402         FC_ELS_QSA = 0x7E,      /* Query Security Attributes. Ref FC-SP */
 403         FC_ELS_E2E_LBEACON = 0x81,
 404                                 /* End-to-End Link Beacon */
 405         FC_ELS_AUTH = 0x90,     /* Authentication. Ref FC-SP */
 406         FC_ELS_RFCN = 0x97,     /* Request Fabric Change Notification. Ref
 407                                  *FC-SP */
 408 };
 409
 410 /*
 411  *  Version numbers for FC-PH standards,
 412  *  used in login to indicate what port
 413  *  supports. See FC-PH-X table 158.
 414  */
 415 enum {
 416         FC_PH_VER_4_3 = 0x09,
 417         FC_PH_VER_PH_3 = 0x20,
 418 };
 419
 420 /*
 421  * PDU size defines
 422  */
 423 enum {
 424         FC_MIN_PDUSZ = 512,
 425         FC_MAX_PDUSZ = 2112,
 426 };
 427
 428 /*
 429  * N_Port PLOGI Common Service Parameters.
 430  * FC-PH-x. Figure-76. pg. 308.
 431  */
 432 struct fc_plogi_csp_s {
 433         u8              verhi;          /* FC-PH high version */
 434         u8              verlo;          /* FC-PH low version */
 435         __be16          bbcred;         /* BB_Credit */
 436
 437 #ifdef __BIG_ENDIAN
 438         u8              ciro:1,         /* continuously increasing RO */
 439                         rro:1,          /* random relative offset */
 440                         npiv_supp:1,    /* NPIV supported */
 441                         port_type:1,    /* N_Port/F_port */
 442                         altbbcred:1,    /* alternate BB_Credit */
 443                         resolution:1,   /* ms/ns ED_TOV resolution */
 444                         vvl_info:1,     /* VVL Info included */
 445                         reserved1:1;
 446
 447         u8              hg_supp:1,
 448                         query_dbc:1,
 449                         security:1,
 450                         sync_cap:1,
 451                         r_t_tov:1,
 452                         dh_dup_supp:1,
 453                         cisc:1,         /* continuously increasing seq count */
 454                         payload:1;
 455 #else
 456         u8              reserved2:2,
 457                         resolution:1,   /* ms/ns ED_TOV resolution */
 458                         altbbcred:1,    /* alternate BB_Credit */
 459                         port_type:1,    /* N_Port/F_port */
 460                         npiv_supp:1,    /* NPIV supported */
 461                         rro:1,          /* random relative offset */
 462                         ciro:1;         /* continuously increasing RO */
 463
 464         u8              payload:1,
 465                         cisc:1,         /* continuously increasing seq count */
 466                         dh_dup_supp:1,
 467                         r_t_tov:1,
 468                         sync_cap:1,
 469                         security:1,
 470                         query_dbc:1,
 471                         hg_supp:1;
 472 #endif
 473         __be16          rxsz;           /* receive data_field size */
 474         __be16          conseq;
 475         __be16          ro_bitmap;
 476         __be32          e_d_tov;
 477 };
 478
 479 /*
 480  * N_Port PLOGI Class Specific Parameters.
 481  * FC-PH-x. Figure 78. pg. 318.
 482  */
 483 struct fc_plogi_clp_s {
 484 #ifdef __BIG_ENDIAN
 485         u32        class_valid:1;
 486         u32        intermix:1;  /* class intermix supported if set =1.
 487                                  * valid only for class1. Reserved for
 488                                  * class2 & class3 */
 489         u32        reserved1:2;
 490         u32        sequential:1;
 491         u32        reserved2:3;
 492 #else
 493         u32        reserved2:3;
 494         u32        sequential:1;
 495         u32        reserved1:2;
 496         u32        intermix:1;  /* class intermix supported if set =1.
 497                                  * valid only for class1. Reserved for
 498                                  * class2 & class3 */
 499         u32        class_valid:1;
 500 #endif
 501         u32        reserved3:24;
 502
 503         u32        reserved4:16;
 504         u32        rxsz:16;     /* Receive data_field size */
 505
 506         u32        reserved5:8;
 507         u32        conseq:8;
 508         u32        e2e_credit:16; /* end to end credit */
 509
 510         u32        reserved7:8;
 511         u32        ospx:8;
 512         u32        reserved8:16;
 513 };
 514
 515 /* ASCII value for each character in string "BRCD" */
 516 #define FLOGI_VVL_BRCD    0x42524344
 517
 518 /*
 519  * PLOGI els command and reply payload
 520  */
 521 struct fc_logi_s {
 522         struct fc_els_cmd_s     els_cmd;        /* ELS command code */
 523         struct fc_plogi_csp_s   csp;            /* common service params */
 524         wwn_t                   port_name;
 525         wwn_t                   node_name;
 526         struct fc_plogi_clp_s   class1;         /* class 1 service parameters */
 527         struct fc_plogi_clp_s   class2;         /* class 2 service parameters */
 528         struct fc_plogi_clp_s   class3;         /* class 3 service parameters */
 529         struct fc_plogi_clp_s   class4;         /* class 4 service parameters */
 530         u8                      vvl[16];        /* vendor version level */
 531 };
 532
 533 /*
 534  * LOGO els command payload
 535  */
 536 struct fc_logo_s {
 537         struct fc_els_cmd_s     els_cmd;        /* ELS command code */
 538         u32                     res1:8;
 539         u32             nport_id:24;    /* N_Port identifier of source */
 540         wwn_t           orig_port_name; /* Port name of the LOGO originator */
 541 };
 542
 543 /*
 544  * ADISC els command payload
 545  */
 546 struct fc_adisc_s {
 547         struct fc_els_cmd_s els_cmd;    /* ELS command code */
 548         u32             res1:8;
 549         u32             orig_HA:24;     /* originator hard address */
 550         wwn_t           orig_port_name; /* originator port name */
 551         wwn_t           orig_node_name; /* originator node name */
 552         u32             res2:8;
 553         u32             nport_id:24;    /* originator NPortID */
 554 };
 555
 556 /*
 557  * Exchange status block
 558  */
 559 struct fc_exch_status_blk_s {
 560         u32        oxid:16;
 561         u32        rxid:16;
 562         u32        res1:8;
 563         u32        orig_np:24;  /* originator NPortID */
 564         u32        res2:8;
 565         u32        resp_np:24;  /* responder NPortID */
 566         u32        es_bits;
 567         u32        res3;
 568         /*
 569          * un modified section of the fields
 570          */
 571 };
 572
 573 /*
 574  * RES els command payload
 575  */
 576 struct fc_res_s {
 577         struct fc_els_cmd_s els_cmd;    /* ELS command code */
 578         u32        res1:8;
 579         u32        nport_id:24;         /* N_Port identifier of source */
 580         u32        oxid:16;
 581         u32        rxid:16;
 582         u8         assoc_hdr[32];
 583 };
 584
 585 /*
 586  * RES els accept payload
 587  */
 588 struct fc_res_acc_s {
 589         struct fc_els_cmd_s             els_cmd;        /* ELS command code */
 590         struct fc_exch_status_blk_s     fc_exch_blk; /* Exchange status block */
 591 };
 592
 593 /*
 594  * REC els command payload
 595  */
 596 struct fc_rec_s {
 597         struct fc_els_cmd_s els_cmd;    /* ELS command code */
 598         u32        res1:8;
 599         u32        nport_id:24; /* N_Port identifier of source */
 600         u32        oxid:16;
 601         u32        rxid:16;
 602 };
 603
 604 #define FC_REC_ESB_OWN_RSP      0x80000000      /* responder owns */
 605 #define FC_REC_ESB_SI           0x40000000      /* SI is owned  */
 606 #define FC_REC_ESB_COMP         0x20000000      /* exchange is complete */
 607 #define FC_REC_ESB_ENDCOND_ABN  0x10000000      /* abnormal ending      */
 608 #define FC_REC_ESB_RQACT        0x04000000      /* recovery qual active */
 609 #define FC_REC_ESB_ERRP_MSK     0x03000000
 610 #define FC_REC_ESB_OXID_INV     0x00800000      /* invalid OXID         */
 611 #define FC_REC_ESB_RXID_INV     0x00400000      /* invalid RXID         */
 612 #define FC_REC_ESB_PRIO_INUSE   0x00200000
 613
 614 /*
 615  * REC els accept payload
 616  */
 617 struct fc_rec_acc_s {
 618         struct fc_els_cmd_s els_cmd;    /* ELS command code */
 619         u32        oxid:16;
 620         u32        rxid:16;
 621         u32        res1:8;
 622         u32        orig_id:24;  /* N_Port id of exchange originator */
 623         u32        res2:8;
 624         u32        resp_id:24;  /* N_Port id of exchange responder */
 625         u32        count;       /* data transfer count */
 626         u32        e_stat;      /* exchange status */
 627 };
 628
 629 /*
 630  * RSI els payload
 631  */
 632 struct fc_rsi_s {
 633         struct fc_els_cmd_s els_cmd;
 634         u32        res1:8;
 635         u32        orig_sid:24;
 636         u32        oxid:16;
 637         u32        rxid:16;
 638 };
 639
 640 /*
 641  * structure for PRLI paramater pages, both request & response
 642  * see FC-PH-X table 113 & 115 for explanation also FCP table 8
 643  */
 644 struct fc_prli_params_s {
 645         u32        reserved:16;
 646 #ifdef __BIG_ENDIAN
 647         u32        reserved1:5;
 648         u32        rec_support:1;
 649         u32        task_retry_id:1;
 650         u32        retry:1;
 651
 652         u32        confirm:1;
 653         u32        doverlay:1;
 654         u32        initiator:1;
 655         u32        target:1;
 656         u32        cdmix:1;
 657         u32        drmix:1;
 658         u32        rxrdisab:1;
 659         u32        wxrdisab:1;
 660 #else
 661         u32        retry:1;
 662         u32        task_retry_id:1;
 663         u32        rec_support:1;
 664         u32        reserved1:5;
 665
 666         u32        wxrdisab:1;
 667         u32        rxrdisab:1;
 668         u32        drmix:1;
 669         u32        cdmix:1;
 670         u32        target:1;
 671         u32        initiator:1;
 672         u32        doverlay:1;
 673         u32        confirm:1;
 674 #endif
 675 };
 676
 677 /*
 678  * valid values for rspcode in PRLI ACC payload
 679  */
 680 enum {
 681         FC_PRLI_ACC_XQTD = 0x1,         /* request executed */
 682         FC_PRLI_ACC_PREDEF_IMG = 0x5,   /* predefined image - no prli needed */
 683 };
 684
 685 struct fc_prli_params_page_s {
 686         u32        type:8;
 687         u32        codext:8;
 688 #ifdef __BIG_ENDIAN
 689         u32        origprocasv:1;
 690         u32        rsppav:1;
 691         u32        imagepair:1;
 692         u32        reserved1:1;
 693         u32        rspcode:4;
 694 #else
 695         u32        rspcode:4;
 696         u32        reserved1:1;
 697         u32        imagepair:1;
 698         u32        rsppav:1;
 699         u32        origprocasv:1;
 700 #endif
 701         u32        reserved2:8;
 702
 703         u32        origprocas;
 704         u32        rspprocas;
 705         struct fc_prli_params_s servparams;
 706 };
 707
 708 /*
 709  * PRLI request and accept payload, FC-PH-X tables 112 & 114
 710  */
 711 struct fc_prli_s {
 712         u32        command:8;
 713         u32        pglen:8;
 714         u32        pagebytes:16;
 715         struct fc_prli_params_page_s parampage;
 716 };
 717
 718 /*
 719  * PRLO logout params page
 720  */
 721 struct fc_prlo_params_page_s {
 722         u32        type:8;
 723         u32        type_ext:8;
 724 #ifdef __BIG_ENDIAN
 725         u32        opa_valid:1; /* originator process associator valid */
 726         u32        rpa_valid:1; /* responder process associator valid */
 727         u32        res1:14;
 728 #else
 729         u32        res1:14;
 730         u32        rpa_valid:1; /* responder process associator valid */
 731         u32        opa_valid:1; /* originator process associator valid */
 732 #endif
 733         u32        orig_process_assc;
 734         u32        resp_process_assc;
 735
 736         u32        res2;
 737 };
 738
 739 /*
 740  * PRLO els command payload
 741  */
 742 struct fc_prlo_s {
 743         u32     command:8;
 744         u32     page_len:8;
 745         u32     payload_len:16;
 746         struct fc_prlo_params_page_s    prlo_params[1];
 747 };
 748
 749 /*
 750  * PRLO Logout response parameter page
 751  */
 752 struct fc_prlo_acc_params_page_s {
 753         u32        type:8;
 754         u32        type_ext:8;
 755
 756 #ifdef __BIG_ENDIAN
 757         u32        opa_valid:1; /* originator process associator valid */
 758         u32        rpa_valid:1; /* responder process associator valid */
 759         u32        res1:14;
 760 #else
 761         u32        res1:14;
 762         u32        rpa_valid:1; /* responder process associator valid */
 763         u32        opa_valid:1; /* originator process associator valid */
 764 #endif
 765         u32        orig_process_assc;
 766         u32        resp_process_assc;
 767
 768         u32        fc4type_csp;
 769 };
 770
 771 /*
 772  * PRLO els command ACC payload
 773  */
 774 struct fc_prlo_acc_s {
 775         u32        command:8;
 776         u32        page_len:8;
 777         u32        payload_len:16;
 778         struct fc_prlo_acc_params_page_s prlo_acc_params[1];
 779 };
 780
 781 /*
 782  * SCR els command payload
 783  */
 784 enum {
 785         FC_SCR_REG_FUNC_FABRIC_DETECTED = 0x01,
 786         FC_SCR_REG_FUNC_N_PORT_DETECTED = 0x02,
 787         FC_SCR_REG_FUNC_FULL = 0x03,
 788         FC_SCR_REG_FUNC_CLEAR_REG = 0xFF,
 789 };
 790
 791 /* SCR VU registrations */
 792 enum {
 793         FC_VU_SCR_REG_FUNC_FABRIC_NAME_CHANGE = 0x01
 794 };
 795
 796 struct fc_scr_s {
 797         u32 command:8;
 798         u32 res:24;
 799         u32 vu_reg_func:8; /* Vendor Unique Registrations */
 800         u32 res1:16;
 801         u32 reg_func:8;
 802 };
 803
 804 /*
 805  * Information category for Basic link data
 806  */
 807 enum {
 808         FC_CAT_NOP      = 0x0,
 809         FC_CAT_ABTS     = 0x1,
 810         FC_CAT_RMC      = 0x2,
 811         FC_CAT_BA_ACC   = 0x4,
 812         FC_CAT_BA_RJT   = 0x5,
 813         FC_CAT_PRMT     = 0x6,
 814 };
 815
 816 /*
 817  * LS_RJT els reply payload
 818  */
 819 struct fc_ls_rjt_s {
 820         struct fc_els_cmd_s els_cmd;    /* ELS command code */
 821         u32        res1:8;
 822         u32        reason_code:8;       /* Reason code for reject */
 823         u32        reason_code_expl:8;  /* Reason code explanation */
 824         u32        vendor_unique:8;     /* Vendor specific */
 825 };
 826
 827 /*
 828  * LS_RJT reason codes
 829  */
 830 enum {
 831         FC_LS_RJT_RSN_INV_CMD_CODE      = 0x01,
 832         FC_LS_RJT_RSN_LOGICAL_ERROR     = 0x03,
 833         FC_LS_RJT_RSN_LOGICAL_BUSY      = 0x05,
 834         FC_LS_RJT_RSN_PROTOCOL_ERROR    = 0x07,
 835         FC_LS_RJT_RSN_UNABLE_TO_PERF_CMD = 0x09,
 836         FC_LS_RJT_RSN_CMD_NOT_SUPP      = 0x0B,
 837 };
 838
 839 /*
 840  * LS_RJT reason code explanation
 841  */
 842 enum {
 843         FC_LS_RJT_EXP_NO_ADDL_INFO              = 0x00,
 844         FC_LS_RJT_EXP_SPARMS_ERR_OPTIONS        = 0x01,
 845         FC_LS_RJT_EXP_SPARMS_ERR_INI_CTL        = 0x03,
 846         FC_LS_RJT_EXP_SPARMS_ERR_REC_CTL        = 0x05,
 847         FC_LS_RJT_EXP_SPARMS_ERR_RXSZ           = 0x07,
 848         FC_LS_RJT_EXP_SPARMS_ERR_CONSEQ         = 0x09,
 849         FC_LS_RJT_EXP_SPARMS_ERR_CREDIT         = 0x0B,
 850         FC_LS_RJT_EXP_INV_PORT_NAME             = 0x0D,
 851         FC_LS_RJT_EXP_INV_NODE_FABRIC_NAME      = 0x0E,
 852         FC_LS_RJT_EXP_INV_CSP                   = 0x0F,
 853         FC_LS_RJT_EXP_INV_ASSOC_HDR             = 0x11,
 854         FC_LS_RJT_EXP_ASSOC_HDR_REQD            = 0x13,
 855         FC_LS_RJT_EXP_INV_ORIG_S_ID             = 0x15,
 856         FC_LS_RJT_EXP_INV_OXID_RXID_COMB        = 0x17,
 857         FC_LS_RJT_EXP_CMD_ALREADY_IN_PROG       = 0x19,
 858         FC_LS_RJT_EXP_LOGIN_REQUIRED            = 0x1E,
 859         FC_LS_RJT_EXP_INVALID_NPORT_ID          = 0x1F,
 860         FC_LS_RJT_EXP_INSUFF_RES                = 0x29,
 861         FC_LS_RJT_EXP_CMD_NOT_SUPP              = 0x2C,
 862         FC_LS_RJT_EXP_INV_PAYLOAD_LEN           = 0x2D,
 863 };
 864
 865 /*
 866  * RRQ els command payload
 867  */
 868 struct fc_rrq_s {
 869         struct fc_els_cmd_s els_cmd;    /* ELS command code */
 870         u32        res1:8;
 871         u32        s_id:24;     /* exchange originator S_ID */
 872
 873         u32        ox_id:16;    /* originator exchange ID */
 874         u32        rx_id:16;    /* responder exchange ID */
 875
 876         u32        res2[8];     /* optional association header */
 877 };
 878
 879 /*
 880  * ABTS BA_ACC reply payload
 881  */
 882 struct fc_ba_acc_s {
 883         u32        seq_id_valid:8;      /* set to 0x00 for Abort Exchange */
 884         u32        seq_id:8;            /* invalid for Abort Exchange */
 885         u32        res2:16;
 886         u32        ox_id:16;            /* OX_ID from ABTS frame */
 887         u32        rx_id:16;            /* RX_ID from ABTS frame */
 888         u32        low_seq_cnt:16;      /* set to 0x0000 for Abort Exchange */
 889         u32        high_seq_cnt:16;     /* set to 0xFFFF for Abort Exchange */
 890 };
 891
 892 /*
 893  * ABTS BA_RJT reject payload
 894  */
 895 struct fc_ba_rjt_s {
 896         u32        res1:8;              /* Reserved */
 897         u32        reason_code:8;       /* reason code for reject */
 898         u32        reason_expl:8;       /* reason code explanation */
 899         u32        vendor_unique:8; /* vendor unique reason code,set to 0 */
 900 };
 901
 902 /*
 903  * TPRLO logout parameter page
 904  */
 905 struct fc_tprlo_params_page_s {
 906         u32        type:8;
 907         u32        type_ext:8;
 908
 909 #ifdef __BIG_ENDIAN
 910         u32        opa_valid:1;
 911         u32        rpa_valid:1;
 912         u32        tpo_nport_valid:1;
 913         u32        global_process_logout:1;
 914         u32        res1:12;
 915 #else
 916         u32        res1:12;
 917         u32        global_process_logout:1;
 918         u32        tpo_nport_valid:1;
 919         u32        rpa_valid:1;
 920         u32        opa_valid:1;
 921 #endif
 922
 923         u32        orig_process_assc;
 924         u32        resp_process_assc;
 925
 926         u32        res2:8;
 927         u32        tpo_nport_id;
 928 };
 929
 930 /*
 931  * TPRLO ELS command payload
 932  */
 933 struct fc_tprlo_s {
 934         u32        command:8;
 935         u32        page_len:8;
 936         u32        payload_len:16;
 937
 938         struct fc_tprlo_params_page_s tprlo_params[1];
 939 };
 940
 941 enum fc_tprlo_type {
 942         FC_GLOBAL_LOGO = 1,
 943         FC_TPR_LOGO
 944 };
 945
 946 /*
 947  * TPRLO els command ACC payload
 948  */
 949 struct fc_tprlo_acc_s {
 950         u32     command:8;
 951         u32     page_len:8;
 952         u32     payload_len:16;
 953         struct fc_prlo_acc_params_page_s tprlo_acc_params[1];
 954 };
 955
 956 /*
 957  * RSCN els command req payload
 958  */
 959 #define FC_RSCN_PGLEN   0x4
 960
 961 enum fc_rscn_format {
 962         FC_RSCN_FORMAT_PORTID   = 0x0,
 963         FC_RSCN_FORMAT_AREA     = 0x1,
 964         FC_RSCN_FORMAT_DOMAIN   = 0x2,
 965         FC_RSCN_FORMAT_FABRIC   = 0x3,
 966 };
 967
 968 struct fc_rscn_event_s {
 969         u32     format:2;
 970         u32     qualifier:4;
 971         u32     resvd:2;
 972         u32     portid:24;
 973 };
 974
 975 struct fc_rscn_pl_s {
 976         u8      command;
 977         u8      pagelen;
 978         __be16  payldlen;
 979         struct fc_rscn_event_s event[1];
 980 };
 981
 982 /*
 983  * ECHO els command req payload
 984  */
 985 struct fc_echo_s {
 986         struct fc_els_cmd_s els_cmd;
 987 };
 988
 989 /*
 990  * RNID els command
 991  */
 992 #define RNID_NODEID_DATA_FORMAT_COMMON                  0x00
 993 #define RNID_NODEID_DATA_FORMAT_FCP3                    0x08
 994 #define RNID_NODEID_DATA_FORMAT_DISCOVERY               0xDF
 995
 996 #define RNID_ASSOCIATED_TYPE_UNKNOWN                    0x00000001
 997 #define RNID_ASSOCIATED_TYPE_OTHER                      0x00000002
 998 #define RNID_ASSOCIATED_TYPE_HUB                        0x00000003
 999 #define RNID_ASSOCIATED_TYPE_SWITCH                     0x00000004
1000 #define RNID_ASSOCIATED_TYPE_GATEWAY                    0x00000005
1001 #define RNID_ASSOCIATED_TYPE_STORAGE_DEVICE             0x00000009
1002 #define RNID_ASSOCIATED_TYPE_HOST                       0x0000000A
1003 #define RNID_ASSOCIATED_TYPE_STORAGE_SUBSYSTEM          0x0000000B
1004 #define RNID_ASSOCIATED_TYPE_STORAGE_ACCESS_DEVICE      0x0000000E
1005 #define RNID_ASSOCIATED_TYPE_NAS_SERVER                 0x00000011
1006 #define RNID_ASSOCIATED_TYPE_BRIDGE                     0x00000002
1007 #define RNID_ASSOCIATED_TYPE_VIRTUALIZATION_DEVICE      0x00000003
1008 #define RNID_ASSOCIATED_TYPE_MULTI_FUNCTION_DEVICE      0x000000FF
1009
1010 /*
1011  * RNID els command payload
1012  */
1013 struct fc_rnid_cmd_s {
1014         struct fc_els_cmd_s els_cmd;
1015         u32        node_id_data_format:8;
1016         u32        reserved:24;
1017 };
1018
1019 /*
1020  * RNID els response payload
1021  */
1022
1023 struct fc_rnid_common_id_data_s {
1024         wwn_t           port_name;
1025         wwn_t           node_name;
1026 };
1027
1028 struct fc_rnid_general_topology_data_s {
1029         u32        vendor_unique[4];
1030         __be32     asso_type;
1031         u32        phy_port_num;
1032         __be32     num_attached_nodes;
1033         u32        node_mgmt:8;
1034         u32        ip_version:8;
1035         u32        udp_tcp_port_num:16;
1036         u32        ip_address[4];
1037         u32        reserved:16;
1038         u32        vendor_specific:16;
1039 };
1040
1041 struct fc_rnid_acc_s {
1042         struct fc_els_cmd_s els_cmd;
1043         u32        node_id_data_format:8;
1044         u32        common_id_data_length:8;
1045         u32        reserved:8;
1046         u32        specific_id_data_length:8;
1047         struct fc_rnid_common_id_data_s common_id_data;
1048         struct fc_rnid_general_topology_data_s gen_topology_data;
1049 };
1050
1051 #define RNID_ASSOCIATED_TYPE_UNKNOWN                    0x00000001
1052 #define RNID_ASSOCIATED_TYPE_OTHER                      0x00000002
1053 #define RNID_ASSOCIATED_TYPE_HUB                        0x00000003
1054 #define RNID_ASSOCIATED_TYPE_SWITCH                     0x00000004
1055 #define RNID_ASSOCIATED_TYPE_GATEWAY                    0x00000005
1056 #define RNID_ASSOCIATED_TYPE_STORAGE_DEVICE             0x00000009
1057 #define RNID_ASSOCIATED_TYPE_HOST                       0x0000000A
1058 #define RNID_ASSOCIATED_TYPE_STORAGE_SUBSYSTEM          0x0000000B
1059 #define RNID_ASSOCIATED_TYPE_STORAGE_ACCESS_DEVICE      0x0000000E
1060 #define RNID_ASSOCIATED_TYPE_NAS_SERVER                 0x00000011
1061 #define RNID_ASSOCIATED_TYPE_BRIDGE                     0x00000002
1062 #define RNID_ASSOCIATED_TYPE_VIRTUALIZATION_DEVICE      0x00000003
1063 #define RNID_ASSOCIATED_TYPE_MULTI_FUNCTION_DEVICE      0x000000FF
1064
1065 enum fc_rpsc_speed_cap {
1066         RPSC_SPEED_CAP_1G = 0x8000,
1067         RPSC_SPEED_CAP_2G = 0x4000,
1068         RPSC_SPEED_CAP_4G = 0x2000,
1069         RPSC_SPEED_CAP_10G = 0x1000,
1070         RPSC_SPEED_CAP_8G = 0x0800,
1071         RPSC_SPEED_CAP_16G = 0x0400,
1072
1073         RPSC_SPEED_CAP_UNKNOWN = 0x0001,
1074 };
1075
1076 enum fc_rpsc_op_speed {
1077         RPSC_OP_SPEED_1G = 0x8000,
1078         RPSC_OP_SPEED_2G = 0x4000,
1079         RPSC_OP_SPEED_4G = 0x2000,
1080         RPSC_OP_SPEED_10G = 0x1000,
1081         RPSC_OP_SPEED_8G = 0x0800,
1082         RPSC_OP_SPEED_16G = 0x0400,
1083
1084         RPSC_OP_SPEED_NOT_EST = 0x0001, /* speed not established */
1085 };
1086
1087 struct fc_rpsc_speed_info_s {
1088         __be16        port_speed_cap;   /* see enum fc_rpsc_speed_cap */
1089         __be16        port_op_speed;    /* see enum fc_rpsc_op_speed */
1090 };
1091
1092 /*
1093  * If RPSC request is sent to the Domain Controller, the request is for
1094  * all the ports within that domain.
1095  */
1096 struct fc_rpsc_cmd_s {
1097         struct fc_els_cmd_s els_cmd;
1098 };
1099
1100 /*
1101  * RPSC Acc
1102  */
1103 struct fc_rpsc_acc_s {
1104         u32        command:8;
1105         u32        rsvd:8;
1106         u32        num_entries:16;
1107
1108         struct fc_rpsc_speed_info_s speed_info[1];
1109 };
1110
1111 /*
1112  * If RPSC2 request is sent to the Domain Controller,
1113  */
1114 #define FC_BRCD_TOKEN    0x42524344
1115
1116 struct fc_rpsc2_cmd_s {
1117         struct fc_els_cmd_s els_cmd;
1118         __be32  token;
1119         u16     resvd;
1120         __be16  num_pids;               /* Number of pids in the request */
1121         struct  {
1122                 u32     rsvd1:8;
1123                 u32     pid:24;         /* port identifier */
1124         } pid_list[1];
1125 };
1126
1127 enum fc_rpsc2_port_type {
1128         RPSC2_PORT_TYPE_UNKNOWN = 0,
1129         RPSC2_PORT_TYPE_NPORT   = 1,
1130         RPSC2_PORT_TYPE_NLPORT  = 2,
1131         RPSC2_PORT_TYPE_NPIV_PORT  = 0x5f,
1132         RPSC2_PORT_TYPE_NPORT_TRUNK  = 0x6f,
1133 };
1134
1135 /*
1136  * RPSC2 portInfo entry structure
1137  */
1138 struct fc_rpsc2_port_info_s {
1139         __be32  pid;            /* PID */
1140         u16     resvd1;
1141         __be16  index;          /* port number / index */
1142         u8      resvd2;
1143         u8      type;           /* port type N/NL/... */
1144         __be16  speed;          /* port Operating Speed */
1145 };
1146
1147 /*
1148  * RPSC2 Accept payload
1149  */
1150 struct fc_rpsc2_acc_s {
1151         u8        els_cmd;
1152         u8        resvd;
1153         __be16    num_pids; /* Number of pids in the request */
1154         struct fc_rpsc2_port_info_s port_info[1]; /* port information */
1155 };
1156
1157 /*
1158  * bit fields so that multiple classes can be specified
1159  */
1160 enum fc_cos {
1161         FC_CLASS_2      = 0x04,
1162         FC_CLASS_3      = 0x08,
1163         FC_CLASS_2_3    = 0x0C,
1164 };
1165
1166 /*
1167  * symbolic name
1168  */
1169 struct fc_symname_s {
1170         u8         symname[FC_SYMNAME_MAX];
1171 };
1172
1173 /*
1174  * protocol default timeout values
1175  */
1176 #define FC_ED_TOV       2
1177 #define FC_REC_TOV      (FC_ED_TOV + 1)
1178 #define FC_RA_TOV       10
1179 #define FC_ELS_TOV      ((2 * FC_RA_TOV) + 1)
1180 #define FC_FCCT_TOV     (3 * FC_RA_TOV)
1181
1182 /*
1183  * virtual fabric related defines
1184  */
1185 #define FC_VF_ID_NULL    0      /*  must not be used as VF_ID */
1186 #define FC_VF_ID_MIN     1
1187 #define FC_VF_ID_MAX     0xEFF
1188 #define FC_VF_ID_CTL     0xFEF  /*  control VF_ID */
1189
1190 /*
1191  * Virtual Fabric Tagging header format
1192  * @caution This is defined only in BIG ENDIAN format.
1193  */
1194 struct fc_vft_s {
1195         u32        r_ctl:8;
1196         u32        ver:2;
1197         u32        type:4;
1198         u32        res_a:2;
1199         u32        priority:3;
1200         u32        vf_id:12;
1201         u32        res_b:1;
1202         u32        hopct:8;
1203         u32        res_c:24;
1204 };
1205
1206 /*
1207  * FCP_CMND definitions
1208  */
1209 #define FCP_CMND_CDB_LEN    16
1210 #define FCP_CMND_LUN_LEN    8
1211
1212 struct fcp_cmnd_s {
1213         struct scsi_lun lun;            /* 64-bit LU number */
1214         u8              crn;            /* command reference number */
1215 #ifdef __BIG_ENDIAN
1216         u8              resvd:1,
1217                         priority:4,     /* FCP-3: SAM-3 priority */
1218                         taskattr:3;     /* scsi task attribute */
1219 #else
1220         u8              taskattr:3,     /* scsi task attribute */
1221                         priority:4,     /* FCP-3: SAM-3 priority */
1222                         resvd:1;
1223 #endif
1224         u8              tm_flags;       /* task management flags */
1225 #ifdef __BIG_ENDIAN
1226         u8              addl_cdb_len:6, /* additional CDB length words */
1227                         iodir:2;        /* read/write FCP_DATA IUs */
1228 #else
1229         u8              iodir:2,        /* read/write FCP_DATA IUs */
1230                         addl_cdb_len:6; /* additional CDB length */
1231 #endif
1232         struct scsi_cdb_s      cdb;
1233
1234         __be32        fcp_dl;   /* bytes to be transferred */
1235 };
1236
1237 #define fcp_cmnd_cdb_len(_cmnd) ((_cmnd)->addl_cdb_len * 4 + FCP_CMND_CDB_LEN)
1238 #define fcp_cmnd_fcpdl(_cmnd)   ((&(_cmnd)->fcp_dl)[(_cmnd)->addl_cdb_len])
1239
1240 /*
1241  * struct fcp_cmnd_s .iodir field values
1242  */
1243 enum fcp_iodir {
1244         FCP_IODIR_NONE  = 0,
1245         FCP_IODIR_WRITE = 1,
1246         FCP_IODIR_READ  = 2,
1247         FCP_IODIR_RW    = 3,
1248 };
1249
1250 /*
1251  * Task management flags field - only one bit shall be set
1252  */
1253 enum fcp_tm_cmnd {
1254         FCP_TM_ABORT_TASK_SET   = BIT(1),
1255         FCP_TM_CLEAR_TASK_SET   = BIT(2),
1256         FCP_TM_LUN_RESET        = BIT(4),
1257         FCP_TM_TARGET_RESET     = BIT(5),       /* obsolete in FCP-3 */
1258         FCP_TM_CLEAR_ACA        = BIT(6),
1259 };
1260
1261 /*
1262  * FCP_RSP residue flags
1263  */
1264 enum fcp_residue {
1265         FCP_NO_RESIDUE = 0,     /* no residue */
1266         FCP_RESID_OVER = 1,     /* more data left that was not sent */
1267         FCP_RESID_UNDER = 2,    /* less data than requested */
1268 };
1269
1270 struct fcp_rspinfo_s {
1271         u32        res0:24;
1272         u32        rsp_code:8;          /* response code (as above) */
1273         u32        res1;
1274 };
1275
1276 struct fcp_resp_s {
1277         u32        reserved[2];         /* 2 words reserved */
1278         u16        reserved2;
1279 #ifdef __BIG_ENDIAN
1280         u8         reserved3:3;
1281         u8         fcp_conf_req:1;      /* FCP_CONF is requested */
1282         u8         resid_flags:2;       /* underflow/overflow */
1283         u8         sns_len_valid:1;     /* sense len is valid */
1284         u8         rsp_len_valid:1;     /* response len is valid */
1285 #else
1286         u8         rsp_len_valid:1;     /* response len is valid */
1287         u8         sns_len_valid:1;     /* sense len is valid */
1288         u8         resid_flags:2;       /* underflow/overflow */
1289         u8         fcp_conf_req:1;      /* FCP_CONF is requested */
1290         u8         reserved3:3;
1291 #endif
1292         u8         scsi_status;         /* one byte SCSI status */
1293         u32        residue;             /* residual data bytes */
1294         u32        sns_len;             /* length od sense info */
1295         u32        rsp_len;             /* length of response info */
1296 };
1297
1298 #define fcp_snslen(__fcprsp)    ((__fcprsp)->sns_len_valid ?            \
1299                                         (__fcprsp)->sns_len : 0)
1300 #define fcp_rsplen(__fcprsp)    ((__fcprsp)->rsp_len_valid ?            \
1301                                         (__fcprsp)->rsp_len : 0)
1302 #define fcp_rspinfo(__fcprsp)   ((struct fcp_rspinfo_s *)((__fcprsp) + 1))
1303 #define fcp_snsinfo(__fcprsp)   (((u8 *)fcp_rspinfo(__fcprsp)) +        \
1304                                                 fcp_rsplen(__fcprsp))
1305 /*
1306  * CT
1307  */
1308 struct ct_hdr_s {
1309         u32     rev_id:8;       /* Revision of the CT */
1310         u32     in_id:24;       /* Initiator Id */
1311         u32     gs_type:8;      /* Generic service Type */
1312         u32     gs_sub_type:8;  /* Generic service sub type */
1313         u32     options:8;      /* options */
1314         u32     rsvrd:8;        /* reserved */
1315         u32     cmd_rsp_code:16;/* ct command/response code */
1316         u32     max_res_size:16;/* maximum/residual size */
1317         u32     frag_id:8;      /* fragment ID */
1318         u32     reason_code:8;  /* reason code */
1319         u32     exp_code:8;     /* explanation code */
1320         u32     vendor_unq:8;   /* vendor unique */
1321 };
1322
1323 /*
1324  * defines for the Revision
1325  */
1326 enum {
1327         CT_GS3_REVISION = 0x01,
1328 };
1329
1330 /*
1331  * defines for gs_type
1332  */
1333 enum {
1334         CT_GSTYPE_KEYSERVICE    = 0xF7,
1335         CT_GSTYPE_ALIASSERVICE  = 0xF8,
1336         CT_GSTYPE_MGMTSERVICE   = 0xFA,
1337         CT_GSTYPE_TIMESERVICE   = 0xFB,
1338         CT_GSTYPE_DIRSERVICE    = 0xFC,
1339 };
1340
1341 /*
1342  * defines for gs_sub_type for gs type directory service
1343  */
1344 enum {
1345         CT_GSSUBTYPE_NAMESERVER = 0x02,
1346 };
1347
1348 /*
1349  * defines for gs_sub_type for gs type management service
1350  */
1351 enum {
1352         CT_GSSUBTYPE_CFGSERVER  = 0x01,
1353         CT_GSSUBTYPE_UNZONED_NS = 0x02,
1354         CT_GSSUBTYPE_ZONESERVER = 0x03,
1355         CT_GSSUBTYPE_LOCKSERVER = 0x04,
1356         CT_GSSUBTYPE_HBA_MGMTSERVER = 0x10,     /* for FDMI */
1357 };
1358
1359 /*
1360  * defines for CT response code field
1361  */
1362 enum {
1363         CT_RSP_REJECT = 0x8001,
1364         CT_RSP_ACCEPT = 0x8002,
1365 };
1366
1367 /*
1368  * defintions for CT reason code
1369  */
1370 enum {
1371         CT_RSN_INV_CMD          = 0x01,
1372         CT_RSN_INV_VER          = 0x02,
1373         CT_RSN_LOGIC_ERR        = 0x03,
1374         CT_RSN_INV_SIZE         = 0x04,
1375         CT_RSN_LOGICAL_BUSY     = 0x05,
1376         CT_RSN_PROTO_ERR        = 0x07,
1377         CT_RSN_UNABLE_TO_PERF   = 0x09,
1378         CT_RSN_NOT_SUPP         = 0x0B,
1379         CT_RSN_SERVER_NOT_AVBL  = 0x0D,
1380         CT_RSN_SESSION_COULD_NOT_BE_ESTBD = 0x0E,
1381         CT_RSN_VENDOR_SPECIFIC  = 0xFF,
1382
1383 };
1384
1385 /*
1386  * definitions for explanations code for Name server
1387  */
1388 enum {
1389         CT_NS_EXP_NOADDITIONAL  = 0x00,
1390         CT_NS_EXP_ID_NOT_REG    = 0x01,
1391         CT_NS_EXP_PN_NOT_REG    = 0x02,
1392         CT_NS_EXP_NN_NOT_REG    = 0x03,
1393         CT_NS_EXP_CS_NOT_REG    = 0x04,
1394         CT_NS_EXP_IPN_NOT_REG   = 0x05,
1395         CT_NS_EXP_IPA_NOT_REG   = 0x06,
1396         CT_NS_EXP_FT_NOT_REG    = 0x07,
1397         CT_NS_EXP_SPN_NOT_REG   = 0x08,
1398         CT_NS_EXP_SNN_NOT_REG   = 0x09,
1399         CT_NS_EXP_PT_NOT_REG    = 0x0A,
1400         CT_NS_EXP_IPP_NOT_REG   = 0x0B,
1401         CT_NS_EXP_FPN_NOT_REG   = 0x0C,
1402         CT_NS_EXP_HA_NOT_REG    = 0x0D,
1403         CT_NS_EXP_FD_NOT_REG    = 0x0E,
1404         CT_NS_EXP_FF_NOT_REG    = 0x0F,
1405         CT_NS_EXP_ACCESSDENIED  = 0x10,
1406         CT_NS_EXP_UNACCEPTABLE_ID = 0x11,
1407         CT_NS_EXP_DATABASEEMPTY         = 0x12,
1408         CT_NS_EXP_NOT_REG_IN_SCOPE      = 0x13,
1409         CT_NS_EXP_DOM_ID_NOT_PRESENT    = 0x14,
1410         CT_NS_EXP_PORT_NUM_NOT_PRESENT  = 0x15,
1411         CT_NS_EXP_NO_DEVICE_ATTACHED    = 0x16
1412 };
1413
1414 /*
1415  * defintions for the explanation code for all servers
1416  */
1417 enum {
1418         CT_EXP_AUTH_EXCEPTION           = 0xF1,
1419         CT_EXP_DB_FULL                  = 0xF2,
1420         CT_EXP_DB_EMPTY                 = 0xF3,
1421         CT_EXP_PROCESSING_REQ           = 0xF4,
1422         CT_EXP_UNABLE_TO_VERIFY_CONN    = 0xF5,
1423         CT_EXP_DEVICES_NOT_IN_CMN_ZONE  = 0xF6
1424 };
1425
1426 /*
1427  * Command codes for Name server
1428  */
1429 enum {
1430         GS_GID_PN       = 0x0121,       /* Get Id on port name */
1431         GS_GPN_ID       = 0x0112,       /* Get port name on ID */
1432         GS_GNN_ID       = 0x0113,       /* Get node name on ID */
1433         GS_GID_FT       = 0x0171,       /* Get Id on FC4 type */
1434         GS_GSPN_ID      = 0x0118,       /* Get symbolic PN on ID */
1435         GS_RFT_ID       = 0x0217,       /* Register fc4type on ID */
1436         GS_RSPN_ID      = 0x0218,       /* Register symbolic PN on ID */
1437         GS_RPN_ID       = 0x0212,       /* Register port name */
1438         GS_RNN_ID       = 0x0213,       /* Register node name */
1439         GS_RCS_ID       = 0x0214,       /* Register class of service */
1440         GS_RPT_ID       = 0x021A,       /* Register port type */
1441         GS_GA_NXT       = 0x0100,       /* Get all next */
1442         GS_RFF_ID       = 0x021F,       /* Register FC4 Feature         */
1443 };
1444
1445 struct fcgs_id_req_s {
1446         u32 rsvd:8;
1447         u32 dap:24; /* port identifier */
1448 };
1449 #define fcgs_gpnid_req_t struct fcgs_id_req_s
1450 #define fcgs_gnnid_req_t struct fcgs_id_req_s
1451 #define fcgs_gspnid_req_t struct fcgs_id_req_s
1452
1453 struct fcgs_gidpn_req_s {
1454         wwn_t   port_name;      /* port wwn */
1455 };
1456
1457 struct fcgs_gidpn_resp_s {
1458         u32     rsvd:8;
1459         u32     dap:24;         /* port identifier */
1460 };
1461
1462 /*
1463  * RFT_ID
1464  */
1465 struct fcgs_rftid_req_s {
1466         u32     rsvd:8;
1467         u32     dap:24;         /* port identifier */
1468         __be32  fc4_type[8];    /* fc4 types */
1469 };
1470
1471 /*
1472  * RFF_ID : Register FC4 features.
1473  */
1474 #define FC_GS_FCP_FC4_FEATURE_INITIATOR  0x02
1475 #define FC_GS_FCP_FC4_FEATURE_TARGET     0x01
1476
1477 struct fcgs_rffid_req_s {
1478         u32     rsvd:8;
1479         u32     dap:24;         /* port identifier */
1480         u32     rsvd1:16;
1481         u32     fc4ftr_bits:8;  /* fc4 feature bits */
1482         u32     fc4_type:8;             /* corresponding FC4 Type */
1483 };
1484
1485 /*
1486  * GID_FT Request
1487  */
1488 struct fcgs_gidft_req_s {
1489         u8      reserved;
1490         u8      domain_id;      /* domain, 0 - all fabric */
1491         u8      area_id;        /* area, 0 - whole domain */
1492         u8      fc4_type;       /* FC_TYPE_FCP for SCSI devices */
1493 };
1494
1495 /*
1496  * GID_FT Response
1497  */
1498 struct fcgs_gidft_resp_s {
1499         u8      last:1;         /* last port identifier flag */
1500         u8      reserved:7;
1501         u32     pid:24;         /* port identifier */
1502 };
1503
1504 /*
1505  * RSPN_ID
1506  */
1507 struct fcgs_rspnid_req_s {
1508         u32     rsvd:8;
1509         u32     dap:24;         /* port identifier */
1510         u8      spn_len;        /* symbolic port name length */
1511         u8      spn[256];       /* symbolic port name */
1512 };
1513
1514 /*
1515  * RPN_ID
1516  */
1517 struct fcgs_rpnid_req_s {
1518         u32     rsvd:8;
1519         u32     port_id:24;
1520         wwn_t   port_name;
1521 };
1522
1523 /*
1524  * RNN_ID
1525  */
1526 struct fcgs_rnnid_req_s {
1527         u32     rsvd:8;
1528         u32     port_id:24;
1529         wwn_t   node_name;
1530 };
1531
1532 /*
1533  * RCS_ID
1534  */
1535 struct fcgs_rcsid_req_s {
1536         u32     rsvd:8;
1537         u32     port_id:24;
1538         u32     cos;
1539 };
1540
1541 /*
1542  * RPT_ID
1543  */
1544 struct fcgs_rptid_req_s {
1545         u32     rsvd:8;
1546         u32     port_id:24;
1547         u32     port_type:8;
1548         u32     rsvd1:24;
1549 };
1550
1551 /*
1552  * GA_NXT Request
1553  */
1554 struct fcgs_ganxt_req_s {
1555         u32     rsvd:8;
1556         u32     port_id:24;
1557 };
1558
1559 /*
1560  * GA_NXT Response
1561  */
1562 struct fcgs_ganxt_rsp_s {
1563         u32             port_type:8;    /* Port Type */
1564         u32             port_id:24;     /* Port Identifier */
1565         wwn_t           port_name;      /* Port Name */
1566         u8              spn_len;        /* Length of Symbolic Port Name */
1567         char            spn[255];       /* Symbolic Port Name */
1568         wwn_t           node_name;      /* Node Name */
1569         u8              snn_len;        /* Length of Symbolic Node Name */
1570         char            snn[255];       /* Symbolic Node Name */
1571         u8              ipa[8];         /* Initial Process Associator */
1572         u8              ip[16];         /* IP Address */
1573         u32             cos;            /* Class of Service */
1574         u32             fc4types[8];    /* FC-4 TYPEs */
1575         wwn_t           fabric_port_name; /* Fabric Port Name */
1576         u32             rsvd:8;         /* Reserved */
1577         u32             hard_addr:24;   /* Hard Address */
1578 };
1579
1580 /*
1581  * Command codes for Fabric Configuration Server
1582  */
1583 enum {
1584         GS_FC_GFN_CMD   = 0x0114,       /* GS FC Get Fabric Name  */
1585         GS_FC_GMAL_CMD  = 0x0116,       /* GS FC GMAL  */
1586         GS_FC_TRACE_CMD = 0x0400,       /* GS FC Trace Route */
1587         GS_FC_PING_CMD  = 0x0401,       /* GS FC Ping */
1588 };
1589
1590 /*
1591  * GMAL Command ( Get ( interconnect Element) Management Address List)
1592  * To retrieve the IP Address of a Switch.
1593  */
1594 #define CT_GMAL_RESP_PREFIX_TELNET       "telnet://"
1595 #define CT_GMAL_RESP_PREFIX_HTTP         "http://"
1596
1597 /*  GMAL/GFN request */
1598 struct fcgs_req_s {
1599         wwn_t    wwn;   /* PWWN/NWWN */
1600 };
1601
1602 #define fcgs_gmal_req_t struct fcgs_req_s
1603 #define fcgs_gfn_req_t struct fcgs_req_s
1604
1605 /* Accept Response to GMAL */
1606 struct fcgs_gmal_resp_s {
1607         __be32  ms_len;   /* Num of entries */
1608         u8      ms_ma[256];
1609 };
1610
1611 struct fcgs_gmal_entry_s {
1612         u8  len;
1613         u8  prefix[7]; /* like "http://" */
1614         u8  ip_addr[248];
1615 };
1616
1617 /*
1618  * FDMI Command Codes
1619  */
1620 #define FDMI_GRHL               0x0100
1621 #define FDMI_GHAT               0x0101
1622 #define FDMI_GRPL               0x0102
1623 #define FDMI_GPAT               0x0110
1624 #define FDMI_RHBA               0x0200
1625 #define FDMI_RHAT               0x0201
1626 #define FDMI_RPRT               0x0210
1627 #define FDMI_RPA                0x0211
1628 #define FDMI_DHBA               0x0300
1629 #define FDMI_DPRT               0x0310
1630
1631 /*
1632  * FDMI reason codes
1633  */
1634 #define FDMI_NO_ADDITIONAL_EXP          0x00
1635 #define FDMI_HBA_ALREADY_REG            0x10
1636 #define FDMI_HBA_ATTRIB_NOT_REG         0x11
1637 #define FDMI_HBA_ATTRIB_MULTIPLE        0x12
1638 #define FDMI_HBA_ATTRIB_LENGTH_INVALID  0x13
1639 #define FDMI_HBA_ATTRIB_NOT_PRESENT     0x14
1640 #define FDMI_PORT_ORIG_NOT_IN_LIST      0x15
1641 #define FDMI_PORT_HBA_NOT_IN_LIST       0x16
1642 #define FDMI_PORT_ATTRIB_NOT_REG        0x20
1643 #define FDMI_PORT_NOT_REG               0x21
1644 #define FDMI_PORT_ATTRIB_MULTIPLE       0x22
1645 #define FDMI_PORT_ATTRIB_LENGTH_INVALID 0x23
1646 #define FDMI_PORT_ALREADY_REGISTEREED   0x24
1647
1648 /*
1649  * FDMI Transmission Speed Mask values
1650  */
1651 #define FDMI_TRANS_SPEED_1G             0x00000001
1652 #define FDMI_TRANS_SPEED_2G             0x00000002
1653 #define FDMI_TRANS_SPEED_10G            0x00000004
1654 #define FDMI_TRANS_SPEED_4G             0x00000008
1655 #define FDMI_TRANS_SPEED_8G             0x00000010
1656 #define FDMI_TRANS_SPEED_16G            0x00000020
1657 #define FDMI_TRANS_SPEED_UNKNOWN        0x00008000
1658
1659 /*
1660  * FDMI HBA attribute types
1661  */
1662 enum fdmi_hba_attribute_type {
1663         FDMI_HBA_ATTRIB_NODENAME = 1,   /* 0x0001 */
1664         FDMI_HBA_ATTRIB_MANUFACTURER,   /* 0x0002 */
1665         FDMI_HBA_ATTRIB_SERIALNUM,      /* 0x0003 */
1666         FDMI_HBA_ATTRIB_MODEL,          /* 0x0004 */
1667         FDMI_HBA_ATTRIB_MODEL_DESC,     /* 0x0005 */
1668         FDMI_HBA_ATTRIB_HW_VERSION,     /* 0x0006 */
1669         FDMI_HBA_ATTRIB_DRIVER_VERSION, /* 0x0007 */
1670         FDMI_HBA_ATTRIB_ROM_VERSION,    /* 0x0008 */
1671         FDMI_HBA_ATTRIB_FW_VERSION,     /* 0x0009 */
1672         FDMI_HBA_ATTRIB_OS_NAME,        /* 0x000A */
1673         FDMI_HBA_ATTRIB_MAX_CT,         /* 0x000B */
1674
1675         FDMI_HBA_ATTRIB_MAX_TYPE
1676 };
1677
1678 /*
1679  * FDMI Port attribute types
1680  */
1681 enum fdmi_port_attribute_type {
1682         FDMI_PORT_ATTRIB_FC4_TYPES = 1, /* 0x0001 */
1683         FDMI_PORT_ATTRIB_SUPP_SPEED,    /* 0x0002 */
1684         FDMI_PORT_ATTRIB_PORT_SPEED,    /* 0x0003 */
1685         FDMI_PORT_ATTRIB_FRAME_SIZE,    /* 0x0004 */
1686         FDMI_PORT_ATTRIB_DEV_NAME,      /* 0x0005 */
1687         FDMI_PORT_ATTRIB_HOST_NAME,     /* 0x0006 */
1688
1689         FDMI_PORT_ATTR_MAX_TYPE
1690 };
1691
1692 /*
1693  * FDMI attribute
1694  */
1695 struct fdmi_attr_s {
1696         __be16        type;
1697         __be16        len;
1698         u8         value[1];
1699 };
1700
1701 /*
1702  * HBA Attribute Block
1703  */
1704 struct fdmi_hba_attr_s {
1705         __be32        attr_count;       /* # of attributes */
1706         struct fdmi_attr_s hba_attr;    /* n attributes */
1707 };
1708
1709 /*
1710  * Registered Port List
1711  */
1712 struct fdmi_port_list_s {
1713         __be32          num_ports;      /* number Of Port Entries */
1714         wwn_t           port_entry;     /* one or more */
1715 };
1716
1717 /*
1718  * Port Attribute Block
1719  */
1720 struct fdmi_port_attr_s {
1721         __be32        attr_count;       /* # of attributes */
1722         struct fdmi_attr_s port_attr;   /* n attributes */
1723 };
1724
1725 /*
1726  * FDMI Register HBA Attributes
1727  */
1728 struct fdmi_rhba_s {
1729         wwn_t                   hba_id;         /* HBA Identifier */
1730         struct fdmi_port_list_s port_list;      /* Registered Port List */
1731         struct fdmi_hba_attr_s hba_attr_blk;    /* HBA attribute block */
1732 };
1733
1734 /*
1735  * FDMI Register Port
1736  */
1737 struct fdmi_rprt_s {
1738         wwn_t                   hba_id;         /* HBA Identifier */
1739         wwn_t                   port_name;      /* Port wwn */
1740         struct fdmi_port_attr_s port_attr_blk;  /* Port Attr Block */
1741 };
1742
1743 /*
1744  * FDMI Register Port Attributes
1745  */
1746 struct fdmi_rpa_s {
1747         wwn_t                   port_name;      /* port wwn */
1748         struct fdmi_port_attr_s port_attr_blk;  /* Port Attr Block */
1749 };
1750
1751 #pragma pack()
1752
1753 #endif  /* __BFA_FC_H__ */