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