/* * Linux network driver for Brocade Converged Network Adapter. * * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License (GPL) Version 2 as * published by the Free Software Foundation * * This program is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * General Public License for more details. */ /* * Copyright (c) 2005-2010 Brocade Communications Systems, Inc. * All rights reserved * www.brocade.com */ #ifndef __BFI_H__ #define __BFI_H__ #include "bfa_defs.h" #pragma pack(1) /** * BFI FW image type */ #define BFI_FLASH_CHUNK_SZ 256 /*!< Flash chunk size */ #define BFI_FLASH_CHUNK_SZ_WORDS (BFI_FLASH_CHUNK_SZ/sizeof(u32)) enum { BFI_IMAGE_CB_FC, BFI_IMAGE_CT_FC, BFI_IMAGE_CT_CNA, BFI_IMAGE_MAX, }; /** * Msg header common to all msgs */ struct bfi_mhdr { u8 msg_class; /*!< @ref enum bfi_mclass */ u8 msg_id; /*!< msg opcode with in the class */ union { struct { u8 rsvd; u8 lpu_id; /*!< msg destination */ } h2i; u16 i2htok; /*!< token in msgs to host */ } mtag; }; #define bfi_h2i_set(_mh, _mc, _op, _lpuid) do { \ (_mh).msg_class = (_mc); \ (_mh).msg_id = (_op); \ (_mh).mtag.h2i.lpu_id = (_lpuid); \ } while (0) #define bfi_i2h_set(_mh, _mc, _op, _i2htok) do { \ (_mh).msg_class = (_mc); \ (_mh).msg_id = (_op); \ (_mh).mtag.i2htok = (_i2htok); \ } while (0) /* * Message opcodes: 0-127 to firmware, 128-255 to host */ #define BFI_I2H_OPCODE_BASE 128 #define BFA_I2HM(_x) ((_x) + BFI_I2H_OPCODE_BASE) /** **************************************************************************** * * Scatter Gather Element and Page definition * **************************************************************************** */ #define BFI_SGE_INLINE 1 #define BFI_SGE_INLINE_MAX (BFI_SGE_INLINE + 1) /** * SG Flags */ enum { BFI_SGE_DATA = 0, /*!< data address, not last */ BFI_SGE_DATA_CPL = 1, /*!< data addr, last in current page */ BFI_SGE_DATA_LAST = 3, /*!< data address, last */ BFI_SGE_LINK = 2, /*!< link address */ BFI_SGE_PGDLEN = 2, /*!< cumulative data length for page */ }; /** * DMA addresses */ union bfi_addr_u { struct { u32 addr_lo; u32 addr_hi; } a32; }; /** * Scatter Gather Element */ struct bfi_sge { #ifdef __BIGENDIAN u32 flags:2, rsvd:2, sg_len:28; #else u32 sg_len:28, rsvd:2, flags:2; #endif union bfi_addr_u sga; }; /** * Scatter Gather Page */ #define BFI_SGPG_DATA_SGES 7 #define BFI_SGPG_SGES_MAX (BFI_SGPG_DATA_SGES + 1) #define BFI_SGPG_RSVD_WD_LEN 8 struct bfi_sgpg { struct bfi_sge sges[BFI_SGPG_SGES_MAX]; u32 rsvd[BFI_SGPG_RSVD_WD_LEN]; }; /* * Large Message structure - 128 Bytes size Msgs */ #define BFI_LMSG_SZ 128 #define BFI_LMSG_PL_WSZ \ ((BFI_LMSG_SZ - sizeof(struct bfi_mhdr)) / 4) struct bfi_msg { struct bfi_mhdr mhdr; u32 pl[BFI_LMSG_PL_WSZ]; }; /** * Mailbox message structure */ #define BFI_MBMSG_SZ 7 struct bfi_mbmsg { struct bfi_mhdr mh; u32 pl[BFI_MBMSG_SZ]; }; /** * Message Classes */ enum bfi_mclass { BFI_MC_IOC = 1, /*!< IO Controller (IOC) */ BFI_MC_DIAG = 2, /*!< Diagnostic Msgs */ BFI_MC_FLASH = 3, /*!< Flash message class */ BFI_MC_CEE = 4, /*!< CEE */ BFI_MC_FCPORT = 5, /*!< FC port */ BFI_MC_IOCFC = 6, /*!< FC - IO Controller (IOC) */ BFI_MC_LL = 7, /*!< Link Layer */ BFI_MC_UF = 8, /*!< Unsolicited frame receive */ BFI_MC_FCXP = 9, /*!< FC Transport */ BFI_MC_LPS = 10, /*!< lport fc login services */ BFI_MC_RPORT = 11, /*!< Remote port */ BFI_MC_ITNIM = 12, /*!< I-T nexus (Initiator mode) */ BFI_MC_IOIM_READ = 13, /*!< read IO (Initiator mode) */ BFI_MC_IOIM_WRITE = 14, /*!< write IO (Initiator mode) */ BFI_MC_IOIM_IO = 15, /*!< IO (Initiator mode) */ BFI_MC_IOIM = 16, /*!< IO (Initiator mode) */ BFI_MC_IOIM_IOCOM = 17, /*!< good IO completion */ BFI_MC_TSKIM = 18, /*!< Initiator Task management */ BFI_MC_SBOOT = 19, /*!< SAN boot services */ BFI_MC_IPFC = 20, /*!< IP over FC Msgs */ BFI_MC_PORT = 21, /*!< Physical port */ BFI_MC_SFP = 22, /*!< SFP module */ BFI_MC_MSGQ = 23, /*!< MSGQ */ BFI_MC_ENET = 24, /*!< ENET commands/responses */ BFI_MC_MAX = 32 }; #define BFI_IOC_MAX_CQS 4 #define BFI_IOC_MAX_CQS_ASIC 8 #define BFI_IOC_MSGLEN_MAX 32 /* 32 bytes */ #define BFI_BOOT_TYPE_OFF 8 #define BFI_BOOT_LOADER_OFF 12 #define BFI_BOOT_TYPE_NORMAL 0 #define BFI_BOOT_TYPE_FLASH 1 #define BFI_BOOT_TYPE_MEMTEST 2 #define BFI_BOOT_LOADER_OS 0 #define BFI_FWBOOT_ENV_OS 0 #define BFI_BOOT_MEMTEST_RES_ADDR 0x900 #define BFI_BOOT_MEMTEST_RES_SIG 0xA0A1A2A3 /** *---------------------------------------------------------------------- * IOC *---------------------------------------------------------------------- */ enum bfi_ioc_h2i_msgs { BFI_IOC_H2I_ENABLE_REQ = 1, BFI_IOC_H2I_DISABLE_REQ = 2, BFI_IOC_H2I_GETATTR_REQ = 3, BFI_IOC_H2I_DBG_SYNC = 4, BFI_IOC_H2I_DBG_DUMP = 5, }; enum bfi_ioc_i2h_msgs { BFI_IOC_I2H_ENABLE_REPLY = BFA_I2HM(1), BFI_IOC_I2H_DISABLE_REPLY = BFA_I2HM(2), BFI_IOC_I2H_GETATTR_REPLY = BFA_I2HM(3), BFI_IOC_I2H_READY_EVENT = BFA_I2HM(4), BFI_IOC_I2H_HBEAT = BFA_I2HM(5), }; /** * BFI_IOC_H2I_GETATTR_REQ message */ struct bfi_ioc_getattr_req { struct bfi_mhdr mh; union bfi_addr_u attr_addr; }; struct bfi_ioc_attr { u64 mfg_pwwn; /*!< Mfg port wwn */ u64 mfg_nwwn; /*!< Mfg node wwn */ mac_t mfg_mac; /*!< Mfg mac */ u16 rsvd_a; u64 pwwn; u64 nwwn; mac_t mac; /*!< PBC or Mfg mac */ u16 rsvd_b; mac_t fcoe_mac; u16 rsvd_c; char brcd_serialnum[STRSZ(BFA_MFG_SERIALNUM_SIZE)]; u8 pcie_gen; u8 pcie_lanes_orig; u8 pcie_lanes; u8 rx_bbcredit; /*!< receive buffer credits */ u32 adapter_prop; /*!< adapter properties */ u16 maxfrsize; /*!< max receive frame size */ char asic_rev; u8 rsvd_d; char fw_version[BFA_VERSION_LEN]; char optrom_version[BFA_VERSION_LEN]; struct bfa_mfg_vpd vpd; u32 card_type; /*!< card type */ }; /** * BFI_IOC_I2H_GETATTR_REPLY message */ struct bfi_ioc_getattr_reply { struct bfi_mhdr mh; /*!< Common msg header */ u8 status; /*!< cfg reply status */ u8 rsvd[3]; }; /** * Firmware memory page offsets */ #define BFI_IOC_SMEM_PG0_CB (0x40) #define BFI_IOC_SMEM_PG0_CT (0x180) /** * Firmware statistic offset */ #define BFI_IOC_FWSTATS_OFF (0x6B40) #define BFI_IOC_FWSTATS_SZ (4096) /** * Firmware trace offset */ #define BFI_IOC_TRC_OFF (0x4b00) #define BFI_IOC_TRC_ENTS 256 #define BFI_IOC_FW_SIGNATURE (0xbfadbfad) #define BFI_IOC_MD5SUM_SZ 4 struct bfi_ioc_image_hdr { u32 signature; /*!< constant signature */ u32 rsvd_a; u32 exec; /*!< exec vector */ u32 param; /*!< parameters */ u32 rsvd_b[4]; u32 md5sum[BFI_IOC_MD5SUM_SZ]; }; enum bfi_fwboot_type { BFI_FWBOOT_TYPE_NORMAL = 0, BFI_FWBOOT_TYPE_FLASH = 1, BFI_FWBOOT_TYPE_MEMTEST = 2, }; /** * BFI_IOC_I2H_READY_EVENT message */ struct bfi_ioc_rdy_event { struct bfi_mhdr mh; /*!< common msg header */ u8 init_status; /*!< init event status */ u8 rsvd[3]; }; struct bfi_ioc_hbeat { struct bfi_mhdr mh; /*!< common msg header */ u32 hb_count; /*!< current heart beat count */ }; /** * IOC hardware/firmware state */ enum bfi_ioc_state { BFI_IOC_UNINIT = 0, /*!< not initialized */ BFI_IOC_INITING = 1, /*!< h/w is being initialized */ BFI_IOC_HWINIT = 2, /*!< h/w is initialized */ BFI_IOC_CFG = 3, /*!< IOC configuration in progress */ BFI_IOC_OP = 4, /*!< IOC is operational */ BFI_IOC_DISABLING = 5, /*!< IOC is being disabled */ BFI_IOC_DISABLED = 6, /*!< IOC is disabled */ BFI_IOC_CFG_DISABLED = 7, /*!< IOC is being disabled;transient */ BFI_IOC_FAIL = 8, /*!< IOC heart-beat failure */ BFI_IOC_MEMTEST = 9, /*!< IOC is doing memtest */ }; #define BFI_IOC_ENDIAN_SIG 0x12345678 enum { BFI_ADAPTER_TYPE_FC = 0x01, /*!< FC adapters */ BFI_ADAPTER_TYPE_MK = 0x0f0000, /*!< adapter type mask */ BFI_ADAPTER_TYPE_SH = 16, /*!< adapter type shift */ BFI_ADAPTER_NPORTS_MK = 0xff00, /*!< number of ports mask */ BFI_ADAPTER_NPORTS_SH = 8, /*!< number of ports shift */ BFI_ADAPTER_SPEED_MK = 0xff, /*!< adapter speed mask */ BFI_ADAPTER_SPEED_SH = 0, /*!< adapter speed shift */ BFI_ADAPTER_PROTO = 0x100000, /*!< prototype adapaters */ BFI_ADAPTER_TTV = 0x200000, /*!< TTV debug capable */ BFI_ADAPTER_UNSUPP = 0x400000, /*!< unknown adapter type */ }; #define BFI_ADAPTER_GETP(__prop, __adap_prop) \ (((__adap_prop) & BFI_ADAPTER_ ## __prop ## _MK) >> \ BFI_ADAPTER_ ## __prop ## _SH) #define BFI_ADAPTER_SETP(__prop, __val) \ ((__val) << BFI_ADAPTER_ ## __prop ## _SH) #define BFI_ADAPTER_IS_PROTO(__adap_type) \ ((__adap_type) & BFI_ADAPTER_PROTO) #define BFI_ADAPTER_IS_TTV(__adap_type) \ ((__adap_type) & BFI_ADAPTER_TTV) #define BFI_ADAPTER_IS_UNSUPP(__adap_type) \ ((__adap_type) & BFI_ADAPTER_UNSUPP) #define BFI_ADAPTER_IS_SPECIAL(__adap_type) \ ((__adap_type) & (BFI_ADAPTER_TTV | BFI_ADAPTER_PROTO | \ BFI_ADAPTER_UNSUPP)) /** * BFI_IOC_H2I_ENABLE_REQ & BFI_IOC_H2I_DISABLE_REQ messages */ struct bfi_ioc_ctrl_req { struct bfi_mhdr mh; u8 ioc_class; u8 rsvd[3]; u32 tv_sec; }; /** * BFI_IOC_I2H_ENABLE_REPLY & BFI_IOC_I2H_DISABLE_REPLY messages */ struct bfi_ioc_ctrl_reply { struct bfi_mhdr mh; /*!< Common msg header */ u8 status; /*!< enable/disable status */ u8 rsvd[3]; }; #define BFI_IOC_MSGSZ 8 /** * H2I Messages */ union bfi_ioc_h2i_msg_u { struct bfi_mhdr mh; struct bfi_ioc_ctrl_req enable_req; struct bfi_ioc_ctrl_req disable_req; struct bfi_ioc_getattr_req getattr_req; u32 mboxmsg[BFI_IOC_MSGSZ]; }; /** * I2H Messages */ union bfi_ioc_i2h_msg_u { struct bfi_mhdr mh; struct bfi_ioc_rdy_event rdy_event; u32 mboxmsg[BFI_IOC_MSGSZ]; }; /** *---------------------------------------------------------------------- * MSGQ *---------------------------------------------------------------------- */ enum bfi_msgq_h2i_msgs { BFI_MSGQ_H2I_INIT_REQ = 1, BFI_MSGQ_H2I_DOORBELL_PI = 2, BFI_MSGQ_H2I_DOORBELL_CI = 3, BFI_MSGQ_H2I_CMDQ_COPY_RSP = 4, }; enum bfi_msgq_i2h_msgs { BFI_MSGQ_I2H_INIT_RSP = BFA_I2HM(BFI_MSGQ_H2I_INIT_REQ), BFI_MSGQ_I2H_DOORBELL_PI = BFA_I2HM(BFI_MSGQ_H2I_DOORBELL_PI), BFI_MSGQ_I2H_DOORBELL_CI = BFA_I2HM(BFI_MSGQ_H2I_DOORBELL_CI), BFI_MSGQ_I2H_CMDQ_COPY_REQ = BFA_I2HM(BFI_MSGQ_H2I_CMDQ_COPY_RSP), }; /* Messages(commands/responsed/AENS will have the following header */ struct bfi_msgq_mhdr { u8 msg_class; u8 msg_id; u16 msg_token; u16 num_entries; u8 enet_id; u8 rsvd[1]; }; #define bfi_msgq_mhdr_set(_mh, _mc, _mid, _tok, _enet_id) do { \ (_mh).msg_class = (_mc); \ (_mh).msg_id = (_mid); \ (_mh).msg_token = (_tok); \ (_mh).enet_id = (_enet_id); \ } while (0) /* * Mailbox for messaging interface */ #define BFI_MSGQ_CMD_ENTRY_SIZE (64) /* TBD */ #define BFI_MSGQ_RSP_ENTRY_SIZE (64) /* TBD */ #define bfi_msgq_num_cmd_entries(_size) \ (((_size) + BFI_MSGQ_CMD_ENTRY_SIZE - 1) / BFI_MSGQ_CMD_ENTRY_SIZE) struct bfi_msgq { union bfi_addr_u addr; u16 q_depth; /* Total num of entries in the queue */ u8 rsvd[2]; }; /* BFI_ENET_MSGQ_CFG_REQ TBD init or cfg? */ struct bfi_msgq_cfg_req { struct bfi_mhdr mh; struct bfi_msgq cmdq; struct bfi_msgq rspq; }; /* BFI_ENET_MSGQ_CFG_RSP */ struct bfi_msgq_cfg_rsp { struct bfi_mhdr mh; u8 cmd_status; u8 rsvd[3]; }; /* BFI_MSGQ_H2I_DOORBELL */ struct bfi_msgq_h2i_db { struct bfi_mhdr mh; union { u16 cmdq_pi; u16 rspq_ci; } idx; }; /* BFI_MSGQ_I2H_DOORBELL */ struct bfi_msgq_i2h_db { struct bfi_mhdr mh; union { u16 rspq_pi; u16 cmdq_ci; } idx; }; #define BFI_CMD_COPY_SZ 28 /* BFI_MSGQ_H2I_CMD_COPY_RSP */ struct bfi_msgq_h2i_cmdq_copy_rsp { struct bfi_mhdr mh; u8 data[BFI_CMD_COPY_SZ]; }; /* BFI_MSGQ_I2H_CMD_COPY_REQ */ struct bfi_msgq_i2h_cmdq_copy_req { struct bfi_mhdr mh; u16 offset; u16 len; }; #pragma pack() #endif /* __BFI_H__ */