path: root/sys/dev/bxe/bxe_hsi.h

/*-
 * Copyright (c) 2007-2011 Broadcom Corporation. All rights reserved.
 *
 *    Gary Zambrano <zambrano@broadcom.com>
 *    David Christensen <davidch@broadcom.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of Broadcom Corporation nor the name of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written consent.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS'
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

 /*$FreeBSD$*/

struct license_key {
	uint32_t reserved[6];

#if defined(__BIG_ENDIAN)
	uint16_t max_iscsi_init_conn;
	uint16_t max_iscsi_trgt_conn;
#elif defined(__LITTLE_ENDIAN)
	uint16_t max_iscsi_trgt_conn;
	uint16_t max_iscsi_init_conn;
#endif

	uint32_t reserved_a[6];
};

#define	PORT_0				0
#define	PORT_1				1
#define	PORT_MAX			2

/*
 * Shared HW configuration
 */
struct shared_hw_cfg {					/* NVRAM Offset */
	/* Up to 16 bytes of NULL-terminated string */
	uint8_t  part_num[16];				/* 0x104 */

	uint32_t config;				/* 0x114 */
#define	SHARED_HW_CFG_MDIO_VOLTAGE_MASK			0x00000001
#define	SHARED_HW_CFG_MDIO_VOLTAGE_SHIFT		0
#define	SHARED_HW_CFG_MDIO_VOLTAGE_1_2V			0x00000000
#define	SHARED_HW_CFG_MDIO_VOLTAGE_2_5V			0x00000001
#define	SHARED_HW_CFG_MCP_RST_ON_CORE_RST_EN		0x00000002

#define	SHARED_HW_CFG_PORT_SWAP				0x00000004

#define	SHARED_HW_CFG_BEACON_WOL_EN			0x00000008

#define	SHARED_HW_CFG_MFW_SELECT_MASK			0x00000700
#define	SHARED_HW_CFG_MFW_SELECT_SHIFT			8
	/*
	 * Whatever MFW found in NVM
	 * (if multiple found, priority order is: NC-SI, UMP, IPMI)
	 */
#define	SHARED_HW_CFG_MFW_SELECT_DEFAULT		0x00000000
#define	SHARED_HW_CFG_MFW_SELECT_NC_SI			0x00000100
#define	SHARED_HW_CFG_MFW_SELECT_UMP			0x00000200
#define	SHARED_HW_CFG_MFW_SELECT_IPMI			0x00000300
	/*
	 * Use SPIO4 as an arbiter between: 0-NC_SI, 1-IPMI
	 * (can only be used when an add-in board, not BMC, pulls-down SPIO4).
	 */
#define	SHARED_HW_CFG_MFW_SELECT_SPIO4_NC_SI_IPMI	0x00000400
	/*
	 * Use SPIO4 as an arbiter between: 0-UMP, 1-IPMI
	 * (can only be used when an add-in board, not BMC, pulls-down SPIO4).
	 */
#define	SHARED_HW_CFG_MFW_SELECT_SPIO4_UMP_IPMI		0x00000500
	/*
	 * Use SPIO4 as an arbiter between: 0-NC-SI, 1-UMP
	 * (can only be used when an add-in board, not BMC, pulls-down SPIO4).
	 */
#define	SHARED_HW_CFG_MFW_SELECT_SPIO4_NC_SI_UMP	0x00000600

#define	SHARED_HW_CFG_LED_MODE_MASK			0x000f0000
#define	SHARED_HW_CFG_LED_MODE_SHIFT			16
#define	SHARED_HW_CFG_LED_MAC1				0x00000000
#define	SHARED_HW_CFG_LED_PHY1				0x00010000
#define	SHARED_HW_CFG_LED_PHY2				0x00020000
#define	SHARED_HW_CFG_LED_PHY3				0x00030000
#define	SHARED_HW_CFG_LED_MAC2				0x00040000
#define	SHARED_HW_CFG_LED_PHY4				0x00050000
#define	SHARED_HW_CFG_LED_PHY5				0x00060000
#define	SHARED_HW_CFG_LED_PHY6				0x00070000
#define	SHARED_HW_CFG_LED_MAC3				0x00080000
#define	SHARED_HW_CFG_LED_PHY7				0x00090000
#define	SHARED_HW_CFG_LED_PHY9				0x000a0000
#define	SHARED_HW_CFG_LED_PHY11				0x000b0000
#define	SHARED_HW_CFG_LED_MAC4				0x000c0000
#define	SHARED_HW_CFG_LED_PHY8				0x000d0000

#define	SHARED_HW_CFG_AN_ENABLE_MASK			0x3f000000
#define	SHARED_HW_CFG_AN_ENABLE_SHIFT			24
#define	SHARED_HW_CFG_AN_ENABLE_CL37			0x01000000
#define	SHARED_HW_CFG_AN_ENABLE_CL73			0x02000000
#define	SHARED_HW_CFG_AN_ENABLE_BAM			0x04000000
#define	SHARED_HW_CFG_AN_ENABLE_PARALLEL_DETECTION	0x08000000
#define	SHARED_HW_CFG_AN_EN_SGMII_FIBER_AUTO_DETECT	0x10000000
#define	SHARED_HW_CFG_AN_ENABLE_REMOTE_PHY		0x20000000

	uint32_t config2;				/* 0x118 */
	/* one time auto detect grace period (in sec) */
#define	SHARED_HW_CFG_GRACE_PERIOD_MASK			0x000000ff
#define	SHARED_HW_CFG_GRACE_PERIOD_SHIFT		0

#define	SHARED_HW_CFG_PCIE_GEN2_ENABLED			0x00000100

	/*
	 * The default value for the core clock is 250MHz and it is
	 * achieved by setting the clock change to 4.
	 */
#define	SHARED_HW_CFG_CLOCK_CHANGE_MASK			0x00000e00
#define	SHARED_HW_CFG_CLOCK_CHANGE_SHIFT		9

#define	SHARED_HW_CFG_SMBUS_TIMING_100KHZ		0x00000000
#define	SHARED_HW_CFG_SMBUS_TIMING_400KHZ		0x00001000

#define	SHARED_HW_CFG_HIDE_PORT1			0x00002000

#define	SHARED_HW_CFG_WOL_CAPABLE_DISABLED		0x00000000
#define	SHARED_HW_CFG_WOL_CAPABLE_ENABLED		0x00004000

	/* Output low when PERST is asserted. */
#define	SHARED_HW_CFG_SPIO4_FOLLOW_PERST_DISABLED	0x00000000
#define	SHARED_HW_CFG_SPIO4_FOLLOW_PERST_ENABLED	0x00008000

#define	SHARED_HW_CFG_PCIE_GEN2_PREEMPHASIS_MASK	0x00070000
#define	SHARED_HW_CFG_PCIE_GEN2_PREEMPHASIS_SHIFT	16
#define	SHARED_HW_CFG_PCIE_GEN2_PREEMPHASIS_HW		0x00000000
#define	SHARED_HW_CFG_PCIE_GEN2_PREEMPHASIS_0DB		0x00010000 /*    0dB */
#define	SHARED_HW_CFG_PCIE_GEN2_PREEMPHASIS_3_5DB	0x00020000 /* -3.5dB */
#define	SHARED_HW_CFG_PCIE_GEN2_PREEMPHASIS_6_0DB	0x00030000 /* -6.0dB */

	/*
	 * The fan failure mechanism is usually related to the PHY type
	 * since the power consumption of the board is determined by the PHY.
	 * Currently, fan is required for most designs with SFX7101, BCM8727
	 * and BCM8481. If a fan is not required for a board which uses one
	 * of those PHYs, this field should be set to "Disabled". If a fan is
	 * required for a different PHY type, this option should be set to
	 * "Enabled".
	 * The fan failure indication is expected on
	 * SPIO5.
	 */
#define	SHARED_HW_CFG_FAN_FAILURE_MASK			0x00180000
#define	SHARED_HW_CFG_FAN_FAILURE_SHIFT			19
#define	SHARED_HW_CFG_FAN_FAILURE_PHY_TYPE		0x00000000
#define	SHARED_HW_CFG_FAN_FAILURE_DISABLED		0x00080000
#define	SHARED_HW_CFG_FAN_FAILURE_ENABLED		0x00100000

	/*  ASPM Power Management support */
#define	SHARED_HW_CFG_ASPM_SUPPORT_MASK			0x00600000
#define	SHARED_HW_CFG_ASPM_SUPPORT_SHIFT		21
#define	SHARED_HW_CFG_ASPM_SUPPORT_L0S_L1_ENABLED	0x00000000
#define	SHARED_HW_CFG_ASPM_SUPPORT_L0S_DISABLED		0x00200000
#define	SHARED_HW_CFG_ASPM_SUPPORT_L1_DISABLED		0x00400000
#define	SHARED_HW_CFG_ASPM_SUPPORT_L0S_L1_DISABLED	0x00600000

	/*
	 * The value of PM_TL_IGNORE_REQS (bit0) in PCI register
	 * tl_control_0 (register 0x2800).
	 */
#define	SHARED_HW_CFG_PREVENT_L1_ENTRY_DISABLED		0x00000000
#define	SHARED_HW_CFG_PREVENT_L1_ENTRY_ENABLED		0x00800000


	uint32_t power_dissipated;			/* 0x11c */
#define	SHARED_HW_CFG_POWER_DIS_CMN_MASK		0xff000000
#define	SHARED_HW_CFG_POWER_DIS_CMN_SHIFT		24

#define	SHARED_HW_CFG_POWER_MGNT_SCALE_MASK		0x00ff0000
#define	SHARED_HW_CFG_POWER_MGNT_SCALE_SHIFT		16
#define	SHARED_HW_CFG_POWER_MGNT_UNKNOWN_SCALE		0x00000000
#define	SHARED_HW_CFG_POWER_MGNT_DOT_1_WATT		0x00010000
#define	SHARED_HW_CFG_POWER_MGNT_DOT_01_WATT		0x00020000
#define	SHARED_HW_CFG_POWER_MGNT_DOT_001_WATT		0x00030000

	uint32_t ump_nc_si_config;			/* 0x120 */
#define	SHARED_HW_CFG_UMP_NC_SI_MII_MODE_MASK		0x00000003
#define	SHARED_HW_CFG_UMP_NC_SI_MII_MODE_SHIFT		0
#define	SHARED_HW_CFG_UMP_NC_SI_MII_MODE_MAC		0x00000000
#define	SHARED_HW_CFG_UMP_NC_SI_MII_MODE_PHY		0x00000001
#define	SHARED_HW_CFG_UMP_NC_SI_MII_MODE_MII		0x00000000
#define	SHARED_HW_CFG_UMP_NC_SI_MII_MODE_RMII		0x00000002

#define	SHARED_HW_CFG_UMP_NC_SI_NUM_DEVS_MASK		0x00000f00
#define	SHARED_HW_CFG_UMP_NC_SI_NUM_DEVS_SHIFT		8

#define	SHARED_HW_CFG_UMP_NC_SI_EXT_PHY_TYPE_MASK	0x00ff0000
#define	SHARED_HW_CFG_UMP_NC_SI_EXT_PHY_TYPE_SHIFT	16
#define	SHARED_HW_CFG_UMP_NC_SI_EXT_PHY_TYPE_NONE	0x00000000
#define	SHARED_HW_CFG_UMP_NC_SI_EXT_PHY_TYPE_BCM5221	0x00010000

	uint32_t board;					/* 0x124 */
#define	SHARED_HW_CFG_BOARD_REV_MASK			0x00ff0000
#define	SHARED_HW_CFG_BOARD_REV_SHIFT			16

#define	SHARED_HW_CFG_BOARD_MAJOR_VER_MASK		0x0f000000
#define	SHARED_HW_CFG_BOARD_MAJOR_VER_SHIFT		24

#define	SHARED_HW_CFG_BOARD_MINOR_VER_MASK		0xf0000000
#define	SHARED_HW_CFG_BOARD_MINOR_VER_SHIFT		28

	uint32_t reserved;				/* 0x128 */
};

/*
 * Port HW configuration
 */
struct port_hw_cfg {			/* port 0: 0x12c  port 1: 0x2bc */
	uint32_t pci_id;
#define	PORT_HW_CFG_PCI_VENDOR_ID_MASK			0xffff0000
#define	PORT_HW_CFG_PCI_DEVICE_ID_MASK			0x0000ffff

	uint32_t pci_sub_id;
#define	PORT_HW_CFG_PCI_SUBSYS_DEVICE_ID_MASK		0xffff0000
#define	PORT_HW_CFG_PCI_SUBSYS_VENDOR_ID_MASK		0x0000ffff

	uint32_t power_dissipated;
#define	PORT_HW_CFG_POWER_DIS_D3_MASK			0xff000000
#define	PORT_HW_CFG_POWER_DIS_D3_SHIFT			24
#define	PORT_HW_CFG_POWER_DIS_D2_MASK			0x00ff0000
#define	PORT_HW_CFG_POWER_DIS_D2_SHIFT			16
#define	PORT_HW_CFG_POWER_DIS_D1_MASK			0x0000ff00
#define	PORT_HW_CFG_POWER_DIS_D1_SHIFT			8
#define	PORT_HW_CFG_POWER_DIS_D0_MASK			0x000000ff
#define	PORT_HW_CFG_POWER_DIS_D0_SHIFT			0

	uint32_t power_consumed;
#define	PORT_HW_CFG_POWER_CONS_D3_MASK			0xff000000
#define	PORT_HW_CFG_POWER_CONS_D3_SHIFT			24
#define	PORT_HW_CFG_POWER_CONS_D2_MASK			0x00ff0000
#define	PORT_HW_CFG_POWER_CONS_D2_SHIFT			16
#define	PORT_HW_CFG_POWER_CONS_D1_MASK			0x0000ff00
#define	PORT_HW_CFG_POWER_CONS_D1_SHIFT			8
#define	PORT_HW_CFG_POWER_CONS_D0_MASK			0x000000ff
#define	PORT_HW_CFG_POWER_CONS_D0_SHIFT			0

	uint32_t mac_upper;
#define	PORT_HW_CFG_UPPERMAC_MASK			0x0000ffff
#define	PORT_HW_CFG_UPPERMAC_SHIFT			0
	uint32_t mac_lower;

	uint32_t iscsi_mac_upper;	/* Upper 16 bits are always zeroes */
	uint32_t iscsi_mac_lower;

	uint32_t rdma_mac_upper;	/* Upper 16 bits are always zeroes */
	uint32_t rdma_mac_lower;

	uint32_t serdes_config;
#define	PORT_HW_CFG_SERDES_TX_DRV_PRE_EMPHASIS_MASK	0x0000ffff
#define	PORT_HW_CFG_SERDES_TX_DRV_PRE_EMPHASIS_SHIFT	0

#define	PORT_HW_CFG_SERDES_RX_DRV_EQUALIZER_MASK	0xffff0000
#define	PORT_HW_CFG_SERDES_RX_DRV_EQUALIZER_SHIFT	16

	uint32_t reserved0[16];				/* 0x158 */

	/*
	 * 4 times 16 bits for all 4 lanes. In case external PHY is present
	 * (not direct mode), those values will not take effect on the 4 XGXS
	 * lanes. For some external PHYs (such as 8706 and 8726) the values
	 * will be used to configure the external PHY – in those cases, not
	 * all 4 values are needed.
	 */
	uint16_t xgxs_config_rx[4];			/* 0x198 */
	uint16_t xgxs_config_tx[4];			/* 0x1A0 */

	uint32_t reserved1[64];				/* 0x1A8 */

	uint32_t lane_config;
#define	PORT_HW_CFG_LANE_SWAP_CFG_MASK			0x0000ffff
#define	PORT_HW_CFG_LANE_SWAP_CFG_SHIFT			0
#define	PORT_HW_CFG_LANE_SWAP_CFG_TX_MASK		0x000000ff
#define	PORT_HW_CFG_LANE_SWAP_CFG_TX_SHIFT		0
#define	PORT_HW_CFG_LANE_SWAP_CFG_RX_MASK		0x0000ff00
#define	PORT_HW_CFG_LANE_SWAP_CFG_RX_SHIFT		8
#define	PORT_HW_CFG_LANE_SWAP_CFG_MASTER_MASK		0x0000c000
#define	PORT_HW_CFG_LANE_SWAP_CFG_MASTER_SHIFT		14
	/* AN and forced */
#define	PORT_HW_CFG_LANE_SWAP_CFG_01230123		0x00001b1b
	/* forced only */
#define	PORT_HW_CFG_LANE_SWAP_CFG_01233210		0x00001be4
	/* forced only */
#define	PORT_HW_CFG_LANE_SWAP_CFG_31203120		0x0000d8d8
	/* forced only */
#define	PORT_HW_CFG_LANE_SWAP_CFG_32103210		0x0000e4e4

	uint32_t external_phy_config;
#define	PORT_HW_CFG_SERDES_EXT_PHY_TYPE_MASK		0xff000000
#define	PORT_HW_CFG_SERDES_EXT_PHY_TYPE_SHIFT		24
#define	PORT_HW_CFG_SERDES_EXT_PHY_TYPE_DIRECT		0x00000000
#define	PORT_HW_CFG_SERDES_EXT_PHY_TYPE_BCM5482		0x01000000
#define	PORT_HW_CFG_SERDES_EXT_PHY_TYPE_NOT_CONN	0xff000000

#define	PORT_HW_CFG_SERDES_EXT_PHY_ADDR_MASK		0x00ff0000
#define	PORT_HW_CFG_SERDES_EXT_PHY_ADDR_SHIFT		16

#define	PORT_HW_CFG_XGXS_EXT_PHY_TYPE_MASK		0x0000ff00
#define	PORT_HW_CFG_XGXS_EXT_PHY_TYPE_SHIFT		8
#define	PORT_HW_CFG_XGXS_EXT_PHY_TYPE_DIRECT		0x00000000
#define	PORT_HW_CFG_XGXS_EXT_PHY_TYPE_BCM8071		0x00000100
#define	PORT_HW_CFG_XGXS_EXT_PHY_TYPE_BCM8072		0x00000200
#define	PORT_HW_CFG_XGXS_EXT_PHY_TYPE_BCM8073		0x00000300
#define	PORT_HW_CFG_XGXS_EXT_PHY_TYPE_BCM8705		0x00000400
#define	PORT_HW_CFG_XGXS_EXT_PHY_TYPE_BCM8706		0x00000500
#define	PORT_HW_CFG_XGXS_EXT_PHY_TYPE_BCM8726		0x00000600
#define	PORT_HW_CFG_XGXS_EXT_PHY_TYPE_BCM8481		0x00000700
#define	PORT_HW_CFG_XGXS_EXT_PHY_TYPE_SFX7101		0x00000800
#define	PORT_HW_CFG_XGXS_EXT_PHY_TYPE_BCM8727		0x00000900
#define	PORT_HW_CFG_XGXS_EXT_PHY_TYPE_BCM8727_NOC	0x00000a00
#define	PORT_HW_CFG_XGXS_EXT_PHY_TYPE_BCM84823		0x00000b00
#define	PORT_HW_CFG_XGXS_EXT_PHY_TYPE_FAILURE		0x0000fd00
#define	PORT_HW_CFG_XGXS_EXT_PHY_TYPE_NOT_CONN		0x0000ff00

#define	PORT_HW_CFG_XGXS_EXT_PHY_ADDR_MASK		0x000000ff
#define	PORT_HW_CFG_XGXS_EXT_PHY_ADDR_SHIFT		0

	uint32_t speed_capability_mask;
#define	PORT_HW_CFG_SPEED_CAPABILITY_D0_MASK		0xffff0000
#define	PORT_HW_CFG_SPEED_CAPABILITY_D0_SHIFT		16
#define	PORT_HW_CFG_SPEED_CAPABILITY_D0_10M_FULL	0x00010000
#define	PORT_HW_CFG_SPEED_CAPABILITY_D0_10M_HALF	0x00020000
#define	PORT_HW_CFG_SPEED_CAPABILITY_D0_100M_HALF	0x00040000
#define	PORT_HW_CFG_SPEED_CAPABILITY_D0_100M_FULL	0x00080000
#define	PORT_HW_CFG_SPEED_CAPABILITY_D0_1G		0x00100000
#define	PORT_HW_CFG_SPEED_CAPABILITY_D0_2_5G		0x00200000
#define	PORT_HW_CFG_SPEED_CAPABILITY_D0_10G		0x00400000
#define	PORT_HW_CFG_SPEED_CAPABILITY_D0_12G		0x00800000
#define	PORT_HW_CFG_SPEED_CAPABILITY_D0_12_5G		0x01000000
#define	PORT_HW_CFG_SPEED_CAPABILITY_D0_13G		0x02000000
#define	PORT_HW_CFG_SPEED_CAPABILITY_D0_15G		0x04000000
#define	PORT_HW_CFG_SPEED_CAPABILITY_D0_16G		0x08000000
#define	PORT_HW_CFG_SPEED_CAPABILITY_D0_RESERVED	0xf0000000

#define	PORT_HW_CFG_SPEED_CAPABILITY_D3_MASK		0x0000ffff
#define	PORT_HW_CFG_SPEED_CAPABILITY_D3_SHIFT		0
#define	PORT_HW_CFG_SPEED_CAPABILITY_D3_10M_FULL	0x00000001
#define	PORT_HW_CFG_SPEED_CAPABILITY_D3_10M_HALF	0x00000002
#define	PORT_HW_CFG_SPEED_CAPABILITY_D3_100M_HALF	0x00000004
#define	PORT_HW_CFG_SPEED_CAPABILITY_D3_100M_FULL	0x00000008
#define	PORT_HW_CFG_SPEED_CAPABILITY_D3_1G		0x00000010
#define	PORT_HW_CFG_SPEED_CAPABILITY_D3_2_5G		0x00000020
#define	PORT_HW_CFG_SPEED_CAPABILITY_D3_10G		0x00000040
#define	PORT_HW_CFG_SPEED_CAPABILITY_D3_12G		0x00000080
#define	PORT_HW_CFG_SPEED_CAPABILITY_D3_12_5G		0x00000100
#define	PORT_HW_CFG_SPEED_CAPABILITY_D3_13G		0x00000200
#define	PORT_HW_CFG_SPEED_CAPABILITY_D3_15G		0x00000400
#define	PORT_HW_CFG_SPEED_CAPABILITY_D3_16G		0x00000800
#define	PORT_HW_CFG_SPEED_CAPABILITY_D3_RESERVED	0x0000f000

	/* A place to hold the original MAC address as a backup. */
	uint32_t backup_mac_upper;			/* 0x2B4 */
	uint32_t backup_mac_lower;			/* 0x2B8 */
};

/*
 * Shared Feature configuration
 */
struct shared_feat_cfg {				/* NVRAM Offset */
	uint32_t config;				/* 0x450 */
#define	SHARED_FEATURE_BMC_ECHO_MODE_EN			0x00000001

	/*
	 * Use the values from options 47 and 48 instead of the HW default
	 * values.
	 */
#define	SHARED_FEAT_CFG_OVERRIDE_PREEMPHASIS_CFG_DISABLED	0x00000000
#define	SHARED_FEAT_CFG_OVERRIDE_PREEMPHASIS_CFG_ENABLED	0x00000002

#define	SHARED_FEAT_CFG_NCSI_ID_METHOD_SPIO		0x00000000
#define	SHARED_FEAT_CFG_NCSI_ID_METHOD_NVRAM		0x00000008

#define	SHARED_FEAT_CFG_NCSI_ID_MASK			0x00000030
#define	SHARED_FEAT_CFG_NCSI_ID_SHIFT			4

	/*
	 * Override the OTP back to single function mode. When using GPIO,
	 * high means only SF, 0 is according to CLP configuration.
	 */
#define	SHARED_FEAT_CFG_FORCE_SF_MODE_MASK		0x00000700
#define	SHARED_FEAT_CFG_FORCE_SF_MODE_SHIFT		8
#define	SHARED_FEAT_CFG_FORCE_SF_MODE_MF_ALLOWED	0x00000000
#define	SHARED_FEAT_CFG_FORCE_SF_MODE_FORCED_SF		0x00000100
#define	SHARED_FEAT_CFG_FORCE_SF_MODE_SPIO4		0x00000200

	/*
	 * The interval in seconds between sending LLDP packets. Set to zero
	 * to disable the feature.
	 */
#define	SHARED_FEAT_CFG_LLDP_XMIT_INTERVAL_MASK		0x00FF0000
#define	SHARED_FEAT_CFG_LLDP_XMIT_INTERVAL_SHIFT	16

	/* The assigned device type ID for LLDP usage. */
#define	SHARED_FEAT_CFG_LLDP_DEVICE_TYPE_ID_MASK	0xFF000000
#define	SHARED_FEAT_CFG_LLDP_DEVICE_TYPE_ID_SHIFT	24
};

/*
 * Port Feature configuration
 */
struct port_feat_cfg {			/* port 0: 0x454  port 1: 0x4c8 */
	uint32_t config;
#define	PORT_FEATURE_BAR1_SIZE_MASK			0x0000000f
#define	PORT_FEATURE_BAR1_SIZE_SHIFT			0
#define	PORT_FEATURE_BAR1_SIZE_DISABLED			0x00000000
#define	PORT_FEATURE_BAR1_SIZE_64K			0x00000001
#define	PORT_FEATURE_BAR1_SIZE_128K			0x00000002
#define	PORT_FEATURE_BAR1_SIZE_256K			0x00000003
#define	PORT_FEATURE_BAR1_SIZE_512K			0x00000004
#define	PORT_FEATURE_BAR1_SIZE_1M			0x00000005
#define	PORT_FEATURE_BAR1_SIZE_2M			0x00000006
#define	PORT_FEATURE_BAR1_SIZE_4M			0x00000007
#define	PORT_FEATURE_BAR1_SIZE_8M			0x00000008
#define	PORT_FEATURE_BAR1_SIZE_16M			0x00000009
#define	PORT_FEATURE_BAR1_SIZE_32M			0x0000000a
#define	PORT_FEATURE_BAR1_SIZE_64M			0x0000000b
#define	PORT_FEATURE_BAR1_SIZE_128M			0x0000000c
#define	PORT_FEATURE_BAR1_SIZE_256M			0x0000000d
#define	PORT_FEATURE_BAR1_SIZE_512M			0x0000000e
#define	PORT_FEATURE_BAR1_SIZE_1G			0x0000000f
#define	PORT_FEATURE_BAR2_SIZE_MASK			0x000000f0
#define	PORT_FEATURE_BAR2_SIZE_SHIFT			4
#define	PORT_FEATURE_BAR2_SIZE_DISABLED			0x00000000
#define	PORT_FEATURE_BAR2_SIZE_64K			0x00000010
#define	PORT_FEATURE_BAR2_SIZE_128K			0x00000020
#define	PORT_FEATURE_BAR2_SIZE_256K			0x00000030
#define	PORT_FEATURE_BAR2_SIZE_512K			0x00000040
#define	PORT_FEATURE_BAR2_SIZE_1M			0x00000050
#define	PORT_FEATURE_BAR2_SIZE_2M			0x00000060
#define	PORT_FEATURE_BAR2_SIZE_4M			0x00000070
#define	PORT_FEATURE_BAR2_SIZE_8M			0x00000080
#define	PORT_FEATURE_BAR2_SIZE_16M			0x00000090
#define	PORT_FEATURE_BAR2_SIZE_32M			0x000000a0
#define	PORT_FEATURE_BAR2_SIZE_64M			0x000000b0
#define	PORT_FEATURE_BAR2_SIZE_128M			0x000000c0
#define	PORT_FEATURE_BAR2_SIZE_256M			0x000000d0
#define	PORT_FEATURE_BAR2_SIZE_512M			0x000000e0
#define	PORT_FEATURE_BAR2_SIZE_1G			0x000000f0
#define	PORT_FEATURE_EN_SIZE_MASK			0x07000000
#define	PORT_FEATURE_EN_SIZE_SHIFT			24
#define	PORT_FEATURE_WOL_ENABLED			0x01000000
#define	PORT_FEATURE_MBA_ENABLED			0x02000000
#define	PORT_FEATURE_MFW_ENABLED			0x04000000

	/* Advertise expansion ROM even if MBA is disabled. */
#define	PORT_FEAT_CFG_FORCE_EXP_ROM_ADV_DISABLED	0x00000000
#define	PORT_FEAT_CFG_FORCE_EXP_ROM_ADV_ENABLED		0x08000000

	/* Reserved bits: 28-29 */
	/*
	 * Check the optic vendor via i2c against a list of approved modules
	 * in a separate nvram image.
	 */
#define	PORT_FEAT_CFG_OPT_MDL_ENFRCMNT_MASK		0xE0000000
#define	PORT_FEAT_CFG_OPT_MDL_ENFRCMNT_SHIFT		29
#define	PORT_FEAT_CFG_OPT_MDL_ENFRCMNT_NO_ENFORCEMENT	0x00000000
#define	PORT_FEAT_CFG_OPT_MDL_ENFRCMNT_DISABLE_TX_LASER	0x20000000
#define	PORT_FEAT_CFG_OPT_MDL_ENFRCMNT_WARNING_MSG	0x40000000
#define	PORT_FEAT_CFG_OPT_MDL_ENFRCMNT_POWER_DOWN	0x60000000

	uint32_t wol_config;
	/* Default is used when driver sets to "auto" mode. */
#define	PORT_FEATURE_WOL_DEFAULT_MASK			0x00000003
#define	PORT_FEATURE_WOL_DEFAULT_SHIFT			0
#define	PORT_FEATURE_WOL_DEFAULT_DISABLE		0x00000000
#define	PORT_FEATURE_WOL_DEFAULT_MAGIC			0x00000001
#define	PORT_FEATURE_WOL_DEFAULT_ACPI			0x00000002
#define	PORT_FEATURE_WOL_DEFAULT_MAGIC_AND_ACPI		0x00000003
#define	PORT_FEATURE_WOL_RES_PAUSE_CAP			0x00000004
#define	PORT_FEATURE_WOL_RES_ASYM_PAUSE_CAP		0x00000008
#define	PORT_FEATURE_WOL_ACPI_UPON_MGMT			0x00000010

	uint32_t mba_config;
#define	PORT_FEATURE_MBA_BOOT_AGENT_TYPE_MASK		0x00000007
#define	PORT_FEATURE_MBA_BOOT_AGENT_TYPE_SHIFT		0
#define	PORT_FEATURE_MBA_BOOT_AGENT_TYPE_PXE		0x00000000
#define	PORT_FEATURE_MBA_BOOT_AGENT_TYPE_RPL		0x00000001
#define	PORT_FEATURE_MBA_BOOT_AGENT_TYPE_BOOTP		0x00000002
#define	PORT_FEATURE_MBA_BOOT_AGENT_TYPE_ISCSIB		0x00000003
#define	PORT_FEATURE_MBA_BOOT_AGENT_TYPE_NONE		0x00000007
#define	PORT_FEATURE_MBA_RES_PAUSE_CAP			0x00000100
#define	PORT_FEATURE_MBA_RES_ASYM_PAUSE_CAP		0x00000200
#define	PORT_FEATURE_MBA_SETUP_PROMPT_ENABLE		0x00000400
#define	PORT_FEATURE_MBA_HOTKEY_CTRL_S			0x00000000
#define	PORT_FEATURE_MBA_HOTKEY_CTRL_B			0x00000800
#define	PORT_FEATURE_MBA_EXP_ROM_SIZE_MASK		0x000ff000
#define	PORT_FEATURE_MBA_EXP_ROM_SIZE_SHIFT		12
#define	PORT_FEATURE_MBA_EXP_ROM_SIZE_DISABLED		0x00000000
#define	PORT_FEATURE_MBA_EXP_ROM_SIZE_2K		0x00001000
#define	PORT_FEATURE_MBA_EXP_ROM_SIZE_4K		0x00002000
#define	PORT_FEATURE_MBA_EXP_ROM_SIZE_8K		0x00003000
#define	PORT_FEATURE_MBA_EXP_ROM_SIZE_16K		0x00004000
#define	PORT_FEATURE_MBA_EXP_ROM_SIZE_32K		0x00005000
#define	PORT_FEATURE_MBA_EXP_ROM_SIZE_64K		0x00006000
#define	PORT_FEATURE_MBA_EXP_ROM_SIZE_128K		0x00007000
#define	PORT_FEATURE_MBA_EXP_ROM_SIZE_256K		0x00008000
#define	PORT_FEATURE_MBA_EXP_ROM_SIZE_512K		0x00009000
#define	PORT_FEATURE_MBA_EXP_ROM_SIZE_1M		0x0000a000
#define	PORT_FEATURE_MBA_EXP_ROM_SIZE_2M		0x0000b000
#define	PORT_FEATURE_MBA_EXP_ROM_SIZE_4M		0x0000c000
#define	PORT_FEATURE_MBA_EXP_ROM_SIZE_8M		0x0000d000
#define	PORT_FEATURE_MBA_EXP_ROM_SIZE_16M		0x0000e000
#define	PORT_FEATURE_MBA_EXP_ROM_SIZE_32M		0x0000f000
#define	PORT_FEATURE_MBA_MSG_TIMEOUT_MASK		0x00f00000
#define	PORT_FEATURE_MBA_MSG_TIMEOUT_SHIFT		20
#define	PORT_FEATURE_MBA_BIOS_BOOTSTRAP_MASK		0x03000000
#define	PORT_FEATURE_MBA_BIOS_BOOTSTRAP_SHIFT		24
#define	PORT_FEATURE_MBA_BIOS_BOOTSTRAP_AUTO		0x00000000
#define	PORT_FEATURE_MBA_BIOS_BOOTSTRAP_BBS		0x01000000
#define	PORT_FEATURE_MBA_BIOS_BOOTSTRAP_INT18H		0x02000000
#define	PORT_FEATURE_MBA_BIOS_BOOTSTRAP_INT19H		0x03000000
#define	PORT_FEATURE_MBA_LINK_SPEED_MASK		0x3c000000
#define	PORT_FEATURE_MBA_LINK_SPEED_SHIFT		26
#define	PORT_FEATURE_MBA_LINK_SPEED_AUTO		0x00000000
#define	PORT_FEATURE_MBA_LINK_SPEED_10HD		0x04000000
#define	PORT_FEATURE_MBA_LINK_SPEED_10FD		0x08000000
#define	PORT_FEATURE_MBA_LINK_SPEED_100HD		0x0c000000
#define	PORT_FEATURE_MBA_LINK_SPEED_100FD		0x10000000
#define	PORT_FEATURE_MBA_LINK_SPEED_1GBPS		0x14000000
#define	PORT_FEATURE_MBA_LINK_SPEED_2_5GBPS		0x18000000
#define	PORT_FEATURE_MBA_LINK_SPEED_10GBPS_CX4		0x1c000000
#define	PORT_FEATURE_MBA_LINK_SPEED_10GBPS_KX4		0x20000000
#define	PORT_FEATURE_MBA_LINK_SPEED_10GBPS_KR		0x24000000
#define	PORT_FEATURE_MBA_LINK_SPEED_12GBPS		0x28000000
#define	PORT_FEATURE_MBA_LINK_SPEED_12_5GBPS		0x2c000000
#define	PORT_FEATURE_MBA_LINK_SPEED_13GBPS		0x30000000
#define	PORT_FEATURE_MBA_LINK_SPEED_15GBPS		0x34000000
#define	PORT_FEATURE_MBA_LINK_SPEED_16GBPS		0x38000000

	uint32_t bmc_config;
#define	PORT_FEATURE_BMC_LINK_OVERRIDE_DEFAULT		0x00000000
#define	PORT_FEATURE_BMC_LINK_OVERRIDE_EN		0x00000001

	uint32_t mba_vlan_cfg;
#define	PORT_FEATURE_MBA_VLAN_TAG_MASK			0x0000ffff
#define	PORT_FEATURE_MBA_VLAN_TAG_SHIFT			0
#define	PORT_FEATURE_MBA_VLAN_EN			0x00010000

	uint32_t resource_cfg;
#define	PORT_FEATURE_RESOURCE_CFG_VALID			0x00000001
#define	PORT_FEATURE_RESOURCE_CFG_DIAG			0x00000002
#define	PORT_FEATURE_RESOURCE_CFG_L2			0x00000004
#define	PORT_FEATURE_RESOURCE_CFG_ISCSI			0x00000008
#define	PORT_FEATURE_RESOURCE_CFG_RDMA			0x00000010

	uint32_t smbus_config;
	/* Obsolete */
#define	PORT_FEATURE_SMBUS_EN				0x00000001
#define	PORT_FEATURE_SMBUS_ADDR_MASK			0x000000fe
#define	PORT_FEATURE_SMBUS_ADDR_SHIFT			1

	uint32_t reserved1;

	uint32_t link_config;    /* Used as HW defaults for the driver */
#define	PORT_FEATURE_CONNECTED_SWITCH_MASK		0x03000000
#define	PORT_FEATURE_CONNECTED_SWITCH_SHIFT		24
	/* (forced) low speed switch (< 10G) */
#define	PORT_FEATURE_CON_SWITCH_1G_SWITCH		0x00000000
	/* (forced) high speed switch (>= 10G) */
#define	PORT_FEATURE_CON_SWITCH_10G_SWITCH		0x01000000
#define	PORT_FEATURE_CON_SWITCH_AUTO_DETECT		0x02000000
#define	PORT_FEATURE_CON_SWITCH_ONE_TIME_DETECT		0x03000000

#define	PORT_FEATURE_LINK_SPEED_MASK			0x000f0000
#define	PORT_FEATURE_LINK_SPEED_SHIFT			16
#define	PORT_FEATURE_LINK_SPEED_AUTO			0x00000000
#define	PORT_FEATURE_LINK_SPEED_10M_FULL		0x00010000
#define	PORT_FEATURE_LINK_SPEED_10M_HALF		0x00020000
#define	PORT_FEATURE_LINK_SPEED_100M_HALF		0x00030000
#define	PORT_FEATURE_LINK_SPEED_100M_FULL		0x00040000
#define	PORT_FEATURE_LINK_SPEED_1G			0x00050000
#define	PORT_FEATURE_LINK_SPEED_2_5G			0x00060000
#define	PORT_FEATURE_LINK_SPEED_10G_CX4			0x00070000
#define	PORT_FEATURE_LINK_SPEED_10G_KX4			0x00080000
#define	PORT_FEATURE_LINK_SPEED_10G_KR			0x00090000
#define	PORT_FEATURE_LINK_SPEED_12G			0x000a0000
#define	PORT_FEATURE_LINK_SPEED_12_5G			0x000b0000
#define	PORT_FEATURE_LINK_SPEED_13G			0x000c0000
#define	PORT_FEATURE_LINK_SPEED_15G			0x000d0000
#define	PORT_FEATURE_LINK_SPEED_16G			0x000e0000

#define	PORT_FEATURE_FLOW_CONTROL_MASK			0x00000700
#define	PORT_FEATURE_FLOW_CONTROL_SHIFT			8
#define	PORT_FEATURE_FLOW_CONTROL_AUTO			0x00000000
#define	PORT_FEATURE_FLOW_CONTROL_TX			0x00000100
#define	PORT_FEATURE_FLOW_CONTROL_RX			0x00000200
#define	PORT_FEATURE_FLOW_CONTROL_BOTH			0x00000300
#define	PORT_FEATURE_FLOW_CONTROL_NONE			0x00000400

	/*
	 * The default for MCP link configuration,
	 * uses the same defines as link_config.
	 */
	uint32_t mfw_wol_link_cfg;

	uint32_t reserved[19];
};

/*
 * Device Information
 */
struct shm_dev_info {						/* size */
	uint32_t    bc_rev; /* 8 bits each: major, minor, build */ /* 4 */

	struct shared_hw_cfg	shared_hw_config;		/* 40 */

	struct port_hw_cfg	port_hw_config[PORT_MAX];	/* 400*2=800 */

	struct shared_feat_cfg	shared_feature_config; 		/* 4 */

	struct port_feat_cfg	port_feature_config[PORT_MAX];	/* 116*2=232 */
};

#define	FUNC_0				0
#define	FUNC_1				1
#define	FUNC_2				2
#define	FUNC_3				3
#define	FUNC_4				4
#define	FUNC_5				5
#define	FUNC_6				6
#define	FUNC_7				7
#define	E1_FUNC_MAX			2
#define	E1H_FUNC_MAX			8

#define	VN_0				0
#define	VN_1				1
#define	VN_2				2
#define	VN_3				3
#define	E1VN_MAX			1
#define	E1HVN_MAX			4

/*
 * This value (in milliseconds) determines the frequency of the driver
 * issuing the PULSE message code.  The firmware monitors this periodic
 * pulse to determine when to switch to an OS-absent mode.
 */
#define	DRV_PULSE_PERIOD_MS		250

/*
 * This value (in milliseconds) determines how long the driver should
 * wait for an acknowledgement from the firmware before timing out.  Once
 * the firmware has timed out, the driver will assume there is no firmware
 * running and there won't be any firmware-driver synchronization during a
 * driver reset.
 */
#define	FW_ACK_TIME_OUT_MS		5000

#define	FW_ACK_POLL_TIME_MS		1

#define	FW_ACK_NUM_OF_POLL		(FW_ACK_TIME_OUT_MS/FW_ACK_POLL_TIME_MS)

/* LED Blink rate that will achieve ~15.9Hz. */
#define	LED_BLINK_RATE_VAL		480

/*
 * Driver <-> FW Mailbox
 */
struct drv_port_mb {
	uint32_t link_status;
	/* Driver should update this field on any link change event. */

#define	LINK_STATUS_LINK_FLAG_MASK			0x00000001
#define	LINK_STATUS_LINK_UP				0x00000001
#define	LINK_STATUS_SPEED_AND_DUPLEX_MASK		0x0000001E
#define	LINK_STATUS_SPEED_AND_DUPLEX_AN_NOT_COMPLETE	(0 << 1)
#define	LINK_STATUS_SPEED_AND_DUPLEX_10THD		(1 << 1)
#define	LINK_STATUS_SPEED_AND_DUPLEX_10TFD		(2 << 1)
#define	LINK_STATUS_SPEED_AND_DUPLEX_100TXHD		(3 << 1)
#define	LINK_STATUS_SPEED_AND_DUPLEX_100T4		(4 << 1)
#define	LINK_STATUS_SPEED_AND_DUPLEX_100TXFD		(5 << 1)
#define	LINK_STATUS_SPEED_AND_DUPLEX_1000THD		(6 << 1)
#define	LINK_STATUS_SPEED_AND_DUPLEX_1000TFD		(7 << 1)
#define	LINK_STATUS_SPEED_AND_DUPLEX_1000XFD		(7 << 1)
#define	LINK_STATUS_SPEED_AND_DUPLEX_2500THD		(8 << 1)
#define	LINK_STATUS_SPEED_AND_DUPLEX_2500TFD		(9 << 1)
#define	LINK_STATUS_SPEED_AND_DUPLEX_2500XFD		(9 << 1)
#define	LINK_STATUS_SPEED_AND_DUPLEX_10GTFD		(10 << 1)
#define	LINK_STATUS_SPEED_AND_DUPLEX_10GXFD		(10 << 1)
#define	LINK_STATUS_SPEED_AND_DUPLEX_12GTFD		(11 << 1)
#define	LINK_STATUS_SPEED_AND_DUPLEX_12GXFD		(11 << 1)
#define	LINK_STATUS_SPEED_AND_DUPLEX_12_5GTFD		(12 << 1)
#define	LINK_STATUS_SPEED_AND_DUPLEX_12_5GXFD		(12 << 1)
#define	LINK_STATUS_SPEED_AND_DUPLEX_13GTFD		(13 << 1)
#define	LINK_STATUS_SPEED_AND_DUPLEX_13GXFD		(13 << 1)
#define	LINK_STATUS_SPEED_AND_DUPLEX_15GTFD		(14 << 1)
#define	LINK_STATUS_SPEED_AND_DUPLEX_15GXFD		(14 << 1)
#define	LINK_STATUS_SPEED_AND_DUPLEX_16GTFD		(15 << 1)
#define	LINK_STATUS_SPEED_AND_DUPLEX_16GXFD		(15 << 1)

#define	LINK_STATUS_AUTO_NEGOTIATE_FLAG_MASK		0x00000020
#define	LINK_STATUS_AUTO_NEGOTIATE_ENABLED		0x00000020

#define	LINK_STATUS_AUTO_NEGOTIATE_COMPLETE		0x00000040
#define	LINK_STATUS_PARALLEL_DETECTION_FLAG_MASK	0x00000080
#define	LINK_STATUS_PARALLEL_DETECTION_USED		0x00000080

#define	LINK_STATUS_LINK_PARTNER_1000TFD_CAPABLE	0x00000200
#define	LINK_STATUS_LINK_PARTNER_1000THD_CAPABLE	0x00000400
#define	LINK_STATUS_LINK_PARTNER_100T4_CAPABLE		0x00000800
#define	LINK_STATUS_LINK_PARTNER_100TXFD_CAPABLE	0x00001000
#define	LINK_STATUS_LINK_PARTNER_100TXHD_CAPABLE	0x00002000
#define	LINK_STATUS_LINK_PARTNER_10TFD_CAPABLE		0x00004000
#define	LINK_STATUS_LINK_PARTNER_10THD_CAPABLE		0x00008000

#define	LINK_STATUS_TX_FLOW_CONTROL_FLAG_MASK		0x00010000
#define	LINK_STATUS_TX_FLOW_CONTROL_ENABLED		0x00010000

#define	LINK_STATUS_RX_FLOW_CONTROL_FLAG_MASK		0x00020000
#define	LINK_STATUS_RX_FLOW_CONTROL_ENABLED		0x00020000

#define	LINK_STATUS_LINK_PARTNER_FLOW_CONTROL_MASK	0x000C0000
#define	LINK_STATUS_LINK_PARTNER_NOT_PAUSE_CAPABLE	(0 << 18)
#define	LINK_STATUS_LINK_PARTNER_SYMMETRIC_PAUSE	(1 << 18)
#define	LINK_STATUS_LINK_PARTNER_ASYMMETRIC_PAUSE	(2 << 18)
#define	LINK_STATUS_LINK_PARTNER_BOTH_PAUSE		(3 << 18)

#define	LINK_STATUS_SERDES_LINK				0x00100000

#define	LINK_STATUS_LINK_PARTNER_2500XFD_CAPABLE	0x00200000
#define	LINK_STATUS_LINK_PARTNER_2500XHD_CAPABLE	0x00400000
#define	LINK_STATUS_LINK_PARTNER_10GXFD_CAPABLE		0x00800000
#define	LINK_STATUS_LINK_PARTNER_12GXFD_CAPABLE		0x01000000
#define	LINK_STATUS_LINK_PARTNER_12_5GXFD_CAPABLE	0x02000000
#define	LINK_STATUS_LINK_PARTNER_13GXFD_CAPABLE		0x04000000
#define	LINK_STATUS_LINK_PARTNER_15GXFD_CAPABLE		0x08000000
#define	LINK_STATUS_LINK_PARTNER_16GXFD_CAPABLE		0x10000000

	uint32_t port_stx;

	uint32_t stat_nig_timer;

	/* MCP firmware does not use this field. */
	uint32_t ext_phy_fw_version;
};

struct drv_func_mb {
	uint32_t drv_mb_header;
#define	DRV_MSG_CODE_MASK				0xffff0000
#define	DRV_MSG_CODE_LOAD_REQ				0x10000000
#define	DRV_MSG_CODE_LOAD_DONE				0x11000000
#define	DRV_MSG_CODE_UNLOAD_REQ_WOL_EN			0x20000000
#define	DRV_MSG_CODE_UNLOAD_REQ_WOL_DIS			0x20010000
#define	DRV_MSG_CODE_UNLOAD_REQ_WOL_MCP			0x20020000
#define	DRV_MSG_CODE_UNLOAD_DONE			0x21000000
#define	DRV_MSG_CODE_DCC_OK				0x30000000
#define	DRV_MSG_CODE_DCC_FAILURE			0x31000000
#define	DRV_MSG_CODE_DIAG_ENTER_REQ			0x50000000
#define	DRV_MSG_CODE_DIAG_EXIT_REQ			0x60000000
#define	DRV_MSG_CODE_VALIDATE_KEY			0x70000000
#define	DRV_MSG_CODE_GET_CURR_KEY			0x80000000
#define	DRV_MSG_CODE_GET_UPGRADE_KEY			0x81000000
#define	DRV_MSG_CODE_GET_MANUF_KEY			0x82000000
#define	DRV_MSG_CODE_LOAD_L2B_PRAM			0x90000000
	/*
	 * The optic module verification commands requris bootcode
	 * v5.0.6 or later.
	 */
#define	DRV_MSG_CODE_VRFY_OPT_MDL			0xa0000000
#define	REQ_BC_VER_4_VRFY_OPT_MDL			0x00050006

#define	BIOS_MSG_CODE_LIC_CHALLENGE			0xff010000
#define	BIOS_MSG_CODE_LIC_RESPONSE			0xff020000
#define	BIOS_MSG_CODE_VIRT_MAC_PRIM			0xff030000
#define	BIOS_MSG_CODE_VIRT_MAC_ISCSI			0xff040000

#define	DRV_MSG_SEQ_NUMBER_MASK				0x0000ffff

	uint32_t drv_mb_param;

	uint32_t fw_mb_header;
#define	FW_MSG_CODE_MASK				0xffff0000
#define	FW_MSG_CODE_DRV_LOAD_COMMON			0x10100000
#define	FW_MSG_CODE_DRV_LOAD_PORT			0x10110000
#define	FW_MSG_CODE_DRV_LOAD_FUNCTION			0x10120000
#define	FW_MSG_CODE_DRV_LOAD_REFUSED			0x10200000
#define	FW_MSG_CODE_DRV_LOAD_DONE			0x11100000
#define	FW_MSG_CODE_DRV_UNLOAD_COMMON			0x20100000
#define	FW_MSG_CODE_DRV_UNLOAD_PORT			0x20110000
#define	FW_MSG_CODE_DRV_UNLOAD_FUNCTION			0x20120000
#define	FW_MSG_CODE_DRV_UNLOAD_DONE			0x21100000
#define	FW_MSG_CODE_DCC_DONE				0x30100000
#define	FW_MSG_CODE_DIAG_ENTER_DONE			0x50100000
#define	FW_MSG_CODE_DIAG_REFUSE				0x50200000
#define	FW_MSG_CODE_DIAG_EXIT_DONE			0x60100000
#define	FW_MSG_CODE_VALIDATE_KEY_SUCCESS		0x70100000
#define	FW_MSG_CODE_VALIDATE_KEY_FAILURE		0x70200000
#define	FW_MSG_CODE_GET_KEY_DONE			0x80100000
#define	FW_MSG_CODE_NO_KEY				0x80f00000
#define	FW_MSG_CODE_LIC_INFO_NOT_READY			0x80f80000
#define	FW_MSG_CODE_L2B_PRAM_LOADED			0x90100000
#define	FW_MSG_CODE_L2B_PRAM_T_LOAD_FAILURE		0x90210000
#define	FW_MSG_CODE_L2B_PRAM_C_LOAD_FAILURE		0x90220000
#define	FW_MSG_CODE_L2B_PRAM_X_LOAD_FAILURE		0x90230000
#define	FW_MSG_CODE_L2B_PRAM_U_LOAD_FAILURE		0x90240000
#define	FW_MSG_CODE_VRFY_OPT_MDL_SUCCESS		0xa0100000
#define	FW_MSG_CODE_VRFY_OPT_MDL_INVLD_IMG		0xa0200000
#define	FW_MSG_CODE_VRFY_OPT_MDL_UNAPPROVED		0xa0300000

#define	FW_MSG_CODE_LIC_CHALLENGE			0xff010000
#define	FW_MSG_CODE_LIC_RESPONSE			0xff020000
#define	FW_MSG_CODE_VIRT_MAC_PRIM			0xff030000
#define	FW_MSG_CODE_VIRT_MAC_ISCSI			0xff040000

#define	FW_MSG_SEQ_NUMBER_MASK				0x0000ffff

	uint32_t fw_mb_param;

	uint32_t drv_pulse_mb;
#define	DRV_PULSE_SEQ_MASK				0x00007fff
#define	DRV_PULSE_SYSTEM_TIME_MASK			0xffff0000
	/*
	 * The system time is in the format of
	 * (year-2001)*12*32 + month*32 + day.
	 */
#define	DRV_PULSE_ALWAYS_ALIVE				0x00008000
	/*
	 * Indicate to the firmware not to go into the
	 * OS-absent when it is not getting driver pulse.
	 * This is used for debugging as well for PXE(MBA).
	 */

	uint32_t mcp_pulse_mb;
#define	MCP_PULSE_SEQ_MASK				0x00007fff
#define	MCP_PULSE_ALWAYS_ALIVE				0x00008000
	/*
	 * Indicates to the driver not to assert due to lack
	 * of MCP response.
	 */
#define	MCP_EVENT_MASK					0xffff0000
#define	MCP_EVENT_OTHER_DRIVER_RESET_REQ		0x00010000

	uint32_t iscsi_boot_signature;
	uint32_t iscsi_boot_block_offset;

	uint32_t drv_status;
#define	DRV_STATUS_PMF					0x00000001

#define	DRV_STATUS_DCC_EVENT_MASK			0x0000ff00
#define	DRV_STATUS_DCC_DISABLE_ENABLE_PF		0x00000100
#define	DRV_STATUS_DCC_BANDWIDTH_ALLOCATION		0x00000200
#define	DRV_STATUS_DCC_CHANGE_MAC_ADDRESS		0x00000400
#define	DRV_STATUS_DCC_RESERVED1			0x00000800
#define	DRV_STATUS_DCC_SET_PROTOCOL			0x00001000
#define	DRV_STATUS_DCC_SET_PRIORITY			0x00002000

	uint32_t virt_mac_upper;
#define	VIRT_MAC_SIGN_MASK				0xffff0000
#define	VIRT_MAC_SIGNATURE				0x564d0000
	uint32_t virt_mac_lower;
};

/*
 * Management firmware state
 */
/* Allocate 440 bytes for management firmware. */
#define	MGMTFW_STATE_WORD_SIZE				110

struct mgmtfw_state {
	uint32_t opaque[MGMTFW_STATE_WORD_SIZE];
};

/*
 * Multi-Function configuration
 */
struct shared_mf_cfg {
	uint32_t clp_mb;
#define	SHARED_MF_CLP_SET_DEFAULT			0x00000000
	/* set by CLP */
#define	SHARED_MF_CLP_EXIT				0x00000001
	/* set by MCP */
#define	SHARED_MF_CLP_EXIT_DONE				0x00010000
};

struct port_mf_cfg {
	uint32_t dynamic_cfg;			/* device control channel */
#define	PORT_MF_CFG_E1HOV_TAG_MASK		0x0000ffff
#define	PORT_MF_CFG_E1HOV_TAG_SHIFT		0
#define	PORT_MF_CFG_E1HOV_TAG_DEFAULT		PORT_MF_CFG_E1HOV_TAG_MASK

	uint32_t reserved[3];
};

struct func_mf_cfg {
	uint32_t config;
	/* E/R/I/D */
	/* function 0 of each port cannot be hidden. */
#define	FUNC_MF_CFG_FUNC_HIDE				0x00000001

#define	FUNC_MF_CFG_PROTOCOL_MASK			0x00000007
#define	FUNC_MF_CFG_PROTOCOL_ETHERNET			0x00000002
#define	FUNC_MF_CFG_PROTOCOL_ETHERNET_WITH_RDMA		0x00000004
#define	FUNC_MF_CFG_PROTOCOL_ISCSI			0x00000006
#define	FUNC_MF_CFG_PROTOCOL_DEFAULT					\
	FUNC_MF_CFG_PROTOCOL_ETHERNET_WITH_RDMA

#define	FUNC_MF_CFG_FUNC_DISABLED			0x00000008

	/* PRI */
	/* 0 - low priority, 3 - high priority */
#define	FUNC_MF_CFG_TRANSMIT_PRIORITY_MASK		0x00000300
#define	FUNC_MF_CFG_TRANSMIT_PRIORITY_SHIFT		8
#define	FUNC_MF_CFG_TRANSMIT_PRIORITY_DEFAULT		0x00000000

	/* MINBW, MAXBW */
	/* value range - 0..100, increments in 100Mbps */
#define	FUNC_MF_CFG_MIN_BW_MASK				0x00ff0000
#define	FUNC_MF_CFG_MIN_BW_SHIFT			16
#define	FUNC_MF_CFG_MIN_BW_DEFAULT			0x00000000
#define	FUNC_MF_CFG_MAX_BW_MASK				0xff000000
#define	FUNC_MF_CFG_MAX_BW_SHIFT			24
#define	FUNC_MF_CFG_MAX_BW_DEFAULT			0x64000000

	uint32_t mac_upper;				/* MAC */
#define	FUNC_MF_CFG_UPPERMAC_MASK			0x0000ffff
#define	FUNC_MF_CFG_UPPERMAC_SHIFT			0
#define	FUNC_MF_CFG_UPPERMAC_DEFAULT		FUNC_MF_CFG_UPPERMAC_MASK
	uint32_t mac_lower;
#define	FUNC_MF_CFG_LOWERMAC_DEFAULT			0xffffffff

	uint32_t e1hov_tag;				/* VNI */
#define	FUNC_MF_CFG_E1HOV_TAG_MASK			0x0000ffff
#define	FUNC_MF_CFG_E1HOV_TAG_SHIFT			0
#define	FUNC_MF_CFG_E1HOV_TAG_DEFAULT		FUNC_MF_CFG_E1HOV_TAG_MASK

	uint32_t reserved[2];
};

struct mf_cfg {
	struct shared_mf_cfg	shared_mf_config;
	struct port_mf_cfg	port_mf_config[PORT_MAX];
	struct func_mf_cfg	func_mf_config[E1H_FUNC_MAX];
};

/*
 * Shared Memory Region
 */
struct shmem_region {				/*   SharedMem Offset (size) */
	uint32_t		validity_map[PORT_MAX];	/* 0x0 (4*2 = 0x8) */
#define	SHR_MEM_FORMAT_REV_ID				('A' << 24)
#define	SHR_MEM_FORMAT_REV_MASK				0xff000000
	/* validity bits */
#define	SHR_MEM_VALIDITY_PCI_CFG			0x00100000
#define	SHR_MEM_VALIDITY_MB				0x00200000
#define	SHR_MEM_VALIDITY_DEV_INFO			0x00400000
#define	SHR_MEM_VALIDITY_RESERVED			0x00000007
	/* One licensing bit should be set */
#define	SHR_MEM_VALIDITY_LIC_KEY_IN_EFFECT_MASK		0x00000038
#define	SHR_MEM_VALIDITY_LIC_MANUF_KEY_IN_EFFECT	0x00000008
#define	SHR_MEM_VALIDITY_LIC_UPGRADE_KEY_IN_EFFECT	0x00000010
#define	SHR_MEM_VALIDITY_LIC_NO_KEY_IN_EFFECT		0x00000020
	/* Active MFW */
#define	SHR_MEM_VALIDITY_ACTIVE_MFW_UNKNOWN		0x00000000
#define	SHR_MEM_VALIDITY_ACTIVE_MFW_IPMI		0x00000040
#define	SHR_MEM_VALIDITY_ACTIVE_MFW_UMP			0x00000080
#define	SHR_MEM_VALIDITY_ACTIVE_MFW_NCSI		0x000000c0
#define	SHR_MEM_VALIDITY_ACTIVE_MFW_NONE		0x000001c0
#define	SHR_MEM_VALIDITY_ACTIVE_MFW_MASK		0x000001c0

	struct shm_dev_info	dev_info;		/* 0x8     (0x438) */

	struct license_key	drv_lic_key[PORT_MAX];	/* 0x440 (52*2=0x68) */

	/* FW information (for internal FW use) */
	uint32_t		fw_info_fio_offset;	/* 0x4a8       (0x4) */
	struct mgmtfw_state	mgmtfw_state;		/* 0x4ac     (0x1b8) */

	struct drv_port_mb	port_mb[PORT_MAX];	/* 0x664 (16*2=0x20) */
#if !defined(b710) /* BXE_UPSTREAM */
	struct drv_func_mb	func_mb[E1H_FUNC_MAX];
#else
	struct drv_func_mb	func_mb[E1_FUNC_MAX];	/* 0x684 (44*2=0x58) */
#endif

#if !defined(b710) /* BXE_UPSTREAM */
	struct mf_cfg		mf_cfg;
#endif
};							/* 0x6dc */

struct shmem2_region {
	uint32_t		size;

	uint32_t		dcc_support;
#define	SHMEM_DCC_SUPPORT_NONE				0x00000000
#define	SHMEM_DCC_SUPPORT_DISABLE_ENABLE_PF_TLV		0x00000001
#define	SHMEM_DCC_SUPPORT_BANDWIDTH_ALLOCATION_TLV	0x00000004
#define	SHMEM_DCC_SUPPORT_CHANGE_MAC_ADDRESS_TLV	0x00000008
#define	SHMEM_DCC_SUPPORT_SET_PROTOCOL_TLV		0x00000040
#define	SHMEM_DCC_SUPPORT_SET_PRIORITY_TLV		0x00000080
#define	SHMEM_DCC_SUPPORT_DEFAULT			SHMEM_DCC_SUPPORT_NONE
};

struct emac_stats {
	uint32_t	rx_stat_ifhcinoctets;
	uint32_t	rx_stat_ifhcinbadoctets;
	uint32_t	rx_stat_etherstatsfragments;
	uint32_t	rx_stat_ifhcinucastpkts;
	uint32_t	rx_stat_ifhcinmulticastpkts;
	uint32_t	rx_stat_ifhcinbroadcastpkts;
	uint32_t	rx_stat_dot3statsfcserrors;
	uint32_t	rx_stat_dot3statsalignmenterrors;
	uint32_t	rx_stat_dot3statscarriersenseerrors;
	uint32_t	rx_stat_xonpauseframesreceived;
	uint32_t	rx_stat_xoffpauseframesreceived;
	uint32_t	rx_stat_maccontrolframesreceived;
	uint32_t	rx_stat_xoffstateentered;
	uint32_t	rx_stat_dot3statsframestoolong;
	uint32_t	rx_stat_etherstatsjabbers;
	uint32_t	rx_stat_etherstatsundersizepkts;
	uint32_t	rx_stat_etherstatspkts64octets;
	uint32_t	rx_stat_etherstatspkts65octetsto127octets;
	uint32_t	rx_stat_etherstatspkts128octetsto255octets;
	uint32_t	rx_stat_etherstatspkts256octetsto511octets;
	uint32_t	rx_stat_etherstatspkts512octetsto1023octets;
	uint32_t	rx_stat_etherstatspkts1024octetsto1522octets;
	uint32_t	rx_stat_etherstatspktsover1522octets;

	uint32_t	rx_stat_falsecarriererrors;

	uint32_t	tx_stat_ifhcoutoctets;
	uint32_t	tx_stat_ifhcoutbadoctets;
	uint32_t	tx_stat_etherstatscollisions;
	uint32_t	tx_stat_outxonsent;
	uint32_t	tx_stat_outxoffsent;
	uint32_t	tx_stat_flowcontroldone;
	uint32_t	tx_stat_dot3statssinglecollisionframes;
	uint32_t	tx_stat_dot3statsmultiplecollisionframes;
	uint32_t	tx_stat_dot3statsdeferredtransmissions;
	uint32_t	tx_stat_dot3statsexcessivecollisions;
	uint32_t	tx_stat_dot3statslatecollisions;
	uint32_t	tx_stat_ifhcoutucastpkts;
	uint32_t	tx_stat_ifhcoutmulticastpkts;
	uint32_t	tx_stat_ifhcoutbroadcastpkts;
	uint32_t	tx_stat_etherstatspkts64octets;
	uint32_t	tx_stat_etherstatspkts65octetsto127octets;
	uint32_t	tx_stat_etherstatspkts128octetsto255octets;
	uint32_t	tx_stat_etherstatspkts256octetsto511octets;
	uint32_t	tx_stat_etherstatspkts512octetsto1023octets;
	uint32_t	tx_stat_etherstatspkts1024octetsto1522octets;
	uint32_t	tx_stat_etherstatspktsover1522octets;
	uint32_t	tx_stat_dot3statsinternalmactransmiterrors;
};

struct bmac_stats {
	uint32_t	tx_stat_gtpkt_lo;
	uint32_t	tx_stat_gtpkt_hi;
	uint32_t	tx_stat_gtxpf_lo;
	uint32_t	tx_stat_gtxpf_hi;
	uint32_t	tx_stat_gtfcs_lo;
	uint32_t	tx_stat_gtfcs_hi;
	uint32_t	tx_stat_gtmca_lo;
	uint32_t	tx_stat_gtmca_hi;
	uint32_t	tx_stat_gtbca_lo;
	uint32_t	tx_stat_gtbca_hi;
	uint32_t	tx_stat_gtfrg_lo;
	uint32_t	tx_stat_gtfrg_hi;
	uint32_t	tx_stat_gtovr_lo;
	uint32_t	tx_stat_gtovr_hi;
	uint32_t	tx_stat_gt64_lo;
	uint32_t	tx_stat_gt64_hi;
	uint32_t	tx_stat_gt127_lo;
	uint32_t	tx_stat_gt127_hi;
	uint32_t	tx_stat_gt255_lo;
	uint32_t	tx_stat_gt255_hi;
	uint32_t	tx_stat_gt511_lo;
	uint32_t	tx_stat_gt511_hi;
	uint32_t	tx_stat_gt1023_lo;
	uint32_t	tx_stat_gt1023_hi;
	uint32_t	tx_stat_gt1518_lo;
	uint32_t	tx_stat_gt1518_hi;
	uint32_t	tx_stat_gt2047_lo;
	uint32_t	tx_stat_gt2047_hi;
	uint32_t	tx_stat_gt4095_lo;
	uint32_t	tx_stat_gt4095_hi;
	uint32_t	tx_stat_gt9216_lo;
	uint32_t	tx_stat_gt9216_hi;
	uint32_t	tx_stat_gt16383_lo;
	uint32_t	tx_stat_gt16383_hi;
	uint32_t	tx_stat_gtmax_lo;
	uint32_t	tx_stat_gtmax_hi;
	uint32_t	tx_stat_gtufl_lo;
	uint32_t	tx_stat_gtufl_hi;
	uint32_t	tx_stat_gterr_lo;
	uint32_t	tx_stat_gterr_hi;
	uint32_t	tx_stat_gtbyt_lo;
	uint32_t	tx_stat_gtbyt_hi;

	uint32_t	rx_stat_gr64_lo;
	uint32_t	rx_stat_gr64_hi;
	uint32_t	rx_stat_gr127_lo;
	uint32_t	rx_stat_gr127_hi;
	uint32_t	rx_stat_gr255_lo;
	uint32_t	rx_stat_gr255_hi;
	uint32_t	rx_stat_gr511_lo;
	uint32_t	rx_stat_gr511_hi;
	uint32_t	rx_stat_gr1023_lo;
	uint32_t	rx_stat_gr1023_hi;
	uint32_t	rx_stat_gr1518_lo;
	uint32_t	rx_stat_gr1518_hi;
	uint32_t	rx_stat_gr2047_lo;
	uint32_t	rx_stat_gr2047_hi;
	uint32_t	rx_stat_gr4095_lo;
	uint32_t	rx_stat_gr4095_hi;
	uint32_t	rx_stat_gr9216_lo;
	uint32_t	rx_stat_gr9216_hi;
	uint32_t	rx_stat_gr16383_lo;
	uint32_t	rx_stat_gr16383_hi;
	uint32_t	rx_stat_grmax_lo;
	uint32_t	rx_stat_grmax_hi;
	uint32_t	rx_stat_grpkt_lo;
	uint32_t	rx_stat_grpkt_hi;
	uint32_t	rx_stat_grfcs_lo;
	uint32_t	rx_stat_grfcs_hi;
	uint32_t	rx_stat_grmca_lo;
	uint32_t	rx_stat_grmca_hi;
	uint32_t	rx_stat_grbca_lo;
	uint32_t	rx_stat_grbca_hi;
	uint32_t	rx_stat_grxcf_lo;
	uint32_t	rx_stat_grxcf_hi;
	uint32_t	rx_stat_grxpf_lo;
	uint32_t	rx_stat_grxpf_hi;
	uint32_t	rx_stat_grxuo_lo;
	uint32_t	rx_stat_grxuo_hi;
	uint32_t	rx_stat_grjbr_lo;
	uint32_t	rx_stat_grjbr_hi;
	uint32_t	rx_stat_grovr_lo;
	uint32_t	rx_stat_grovr_hi;
	uint32_t	rx_stat_grflr_lo;
	uint32_t	rx_stat_grflr_hi;
	uint32_t	rx_stat_grmeg_lo;
	uint32_t	rx_stat_grmeg_hi;
	uint32_t	rx_stat_grmeb_lo;
	uint32_t	rx_stat_grmeb_hi;
	uint32_t	rx_stat_grbyt_lo;
	uint32_t	rx_stat_grbyt_hi;
	uint32_t	rx_stat_grund_lo;
	uint32_t	rx_stat_grund_hi;
	uint32_t	rx_stat_grfrg_lo;
	uint32_t	rx_stat_grfrg_hi;
	uint32_t	rx_stat_grerb_lo;
	uint32_t	rx_stat_grerb_hi;
	uint32_t	rx_stat_grfre_lo;
	uint32_t	rx_stat_grfre_hi;
	uint32_t	rx_stat_gripj_lo;
	uint32_t	rx_stat_gripj_hi;
};

union mac_stats {
    struct emac_stats	emac_stats;
    struct bmac_stats	bmac_stats;
};

struct mac_stx {
	/* in_bad_octets */
	uint32_t	rx_stat_ifhcinbadoctets_hi;
	uint32_t	rx_stat_ifhcinbadoctets_lo;

	/* out_bad_octets */
	uint32_t	tx_stat_ifhcoutbadoctets_hi;
	uint32_t	tx_stat_ifhcoutbadoctets_lo;

	/* crc_receive_errors */
	uint32_t	rx_stat_dot3statsfcserrors_hi;
	uint32_t	rx_stat_dot3statsfcserrors_lo;
	/* alignment_errors */
	uint32_t	rx_stat_dot3statsalignmenterrors_hi;
	uint32_t	rx_stat_dot3statsalignmenterrors_lo;
	/* carrier_sense_errors */
	uint32_t	rx_stat_dot3statscarriersenseerrors_hi;
	uint32_t	rx_stat_dot3statscarriersenseerrors_lo;
	/* false_carrier_detections */
	uint32_t	rx_stat_falsecarriererrors_hi;
	uint32_t	rx_stat_falsecarriererrors_lo;

	/* runt_packets_received */
	uint32_t	rx_stat_etherstatsundersizepkts_hi;
	uint32_t	rx_stat_etherstatsundersizepkts_lo;
	/* jabber_packets_received */
	uint32_t	rx_stat_dot3statsframestoolong_hi;
	uint32_t	rx_stat_dot3statsframestoolong_lo;

	/* error_runt_packets_received */
	uint32_t	rx_stat_etherstatsfragments_hi;
	uint32_t	rx_stat_etherstatsfragments_lo;
	/* error_jabber_packets_received */
	uint32_t	rx_stat_etherstatsjabbers_hi;
	uint32_t	rx_stat_etherstatsjabbers_lo;

	/* control_frames_received */
	uint32_t	rx_stat_maccontrolframesreceived_hi;
	uint32_t	rx_stat_maccontrolframesreceived_lo;
	uint32_t	rx_stat_bmac_xpf_hi;
	uint32_t	rx_stat_bmac_xpf_lo;
	uint32_t	rx_stat_bmac_xcf_hi;
	uint32_t	rx_stat_bmac_xcf_lo;

	/* xoff_state_entered */
	uint32_t	rx_stat_xoffstateentered_hi;
	uint32_t	rx_stat_xoffstateentered_lo;
	/* pause_xon_frames_received */
	uint32_t	rx_stat_xonpauseframesreceived_hi;
	uint32_t	rx_stat_xonpauseframesreceived_lo;
	/* pause_xoff_frames_received */
	uint32_t	rx_stat_xoffpauseframesreceived_hi;
	uint32_t	rx_stat_xoffpauseframesreceived_lo;
	/* pause_xon_frames_transmitted */
	uint32_t	tx_stat_outxonsent_hi;
	uint32_t	tx_stat_outxonsent_lo;
	/* pause_xoff_frames_transmitted */
	uint32_t	tx_stat_outxoffsent_hi;
	uint32_t	tx_stat_outxoffsent_lo;
	/* flow_control_done */
	uint32_t	tx_stat_flowcontroldone_hi;
	uint32_t	tx_stat_flowcontroldone_lo;

	/* ether_stats_collisions */
	uint32_t	tx_stat_etherstatscollisions_hi;
	uint32_t	tx_stat_etherstatscollisions_lo;
	/* single_collision_transmit_frames */
	uint32_t	tx_stat_dot3statssinglecollisionframes_hi;
	uint32_t	tx_stat_dot3statssinglecollisionframes_lo;
	/* multiple_collision_transmit_frames */
	uint32_t	tx_stat_dot3statsmultiplecollisionframes_hi;
	uint32_t	tx_stat_dot3statsmultiplecollisionframes_lo;
	/* deferred_transmissions */
	uint32_t	tx_stat_dot3statsdeferredtransmissions_hi;
	uint32_t	tx_stat_dot3statsdeferredtransmissions_lo;
	/* excessive_collision_frames */
	uint32_t	tx_stat_dot3statsexcessivecollisions_hi;
	uint32_t	tx_stat_dot3statsexcessivecollisions_lo;
	/* late_collision_frames */
	uint32_t	tx_stat_dot3statslatecollisions_hi;
	uint32_t	tx_stat_dot3statslatecollisions_lo;

	/* frames_transmitted_64_bytes */
	uint32_t	tx_stat_etherstatspkts64octets_hi;
	uint32_t	tx_stat_etherstatspkts64octets_lo;
	/* frames_transmitted_65_127_bytes */
	uint32_t	tx_stat_etherstatspkts65octetsto127octets_hi;
	uint32_t	tx_stat_etherstatspkts65octetsto127octets_lo;
	/* frames_transmitted_128_255_bytes */
	uint32_t	tx_stat_etherstatspkts128octetsto255octets_hi;
	uint32_t	tx_stat_etherstatspkts128octetsto255octets_lo;
	/* frames_transmitted_256_511_bytes */
	uint32_t	tx_stat_etherstatspkts256octetsto511octets_hi;
	uint32_t	tx_stat_etherstatspkts256octetsto511octets_lo;
	/* frames_transmitted_512_1023_bytes */
	uint32_t	tx_stat_etherstatspkts512octetsto1023octets_hi;
	uint32_t	tx_stat_etherstatspkts512octetsto1023octets_lo;
	/* frames_transmitted_1024_1522_bytes */
	uint32_t	tx_stat_etherstatspkts1024octetsto1522octets_hi;
	uint32_t	tx_stat_etherstatspkts1024octetsto1522octets_lo;
	/* frames_transmitted_1523_9022_bytes */
	uint32_t	tx_stat_etherstatspktsover1522octets_hi;
	uint32_t	tx_stat_etherstatspktsover1522octets_lo;
	uint32_t	tx_stat_bmac_2047_hi;
	uint32_t	tx_stat_bmac_2047_lo;
	uint32_t	tx_stat_bmac_4095_hi;
	uint32_t	tx_stat_bmac_4095_lo;
	uint32_t	tx_stat_bmac_9216_hi;
	uint32_t	tx_stat_bmac_9216_lo;
	uint32_t	tx_stat_bmac_16383_hi;
	uint32_t	tx_stat_bmac_16383_lo;

	/* internal_mac_transmit_errors */
	uint32_t	tx_stat_dot3statsinternalmactransmiterrors_hi;
	uint32_t	tx_stat_dot3statsinternalmactransmiterrors_lo;

	/* if_out_discards */
	uint32_t	tx_stat_bmac_ufl_hi;
	uint32_t	tx_stat_bmac_ufl_lo;
};


#define	MAC_STX_IDX_MAX			2

struct host_port_stats {
    uint32_t		host_port_stats_start;

    struct mac_stx	mac_stx[MAC_STX_IDX_MAX];

    uint32_t		brb_drop_hi;
    uint32_t		brb_drop_lo;

    uint32_t		host_port_stats_end;
};

struct host_func_stats {
	uint32_t	host_func_stats_start;

	uint32_t	total_bytes_received_hi;
	uint32_t	total_bytes_received_lo;

	uint32_t	total_bytes_transmitted_hi;
	uint32_t	total_bytes_transmitted_lo;

	uint32_t	total_unicast_packets_received_hi;
	uint32_t	total_unicast_packets_received_lo;

	uint32_t	total_multicast_packets_received_hi;
	uint32_t	total_multicast_packets_received_lo;

	uint32_t	total_broadcast_packets_received_hi;
	uint32_t	total_broadcast_packets_received_lo;

	uint32_t	total_unicast_packets_transmitted_hi;
	uint32_t	total_unicast_packets_transmitted_lo;

	uint32_t	total_multicast_packets_transmitted_hi;
	uint32_t	total_multicast_packets_transmitted_lo;

	uint32_t	total_broadcast_packets_transmitted_hi;
	uint32_t	total_broadcast_packets_transmitted_lo;

	uint32_t	valid_bytes_received_hi;
	uint32_t	valid_bytes_received_lo;

	uint32_t	host_func_stats_end;
};

#define	BCM_5710_FW_MAJOR_VERSION		5
#define	BCM_5710_FW_MINOR_VERSION		2
#define	BCM_5710_FW_REVISION_VERSION		13
#define	BCM_5710_FW_ENGINEERING_VERSION		0
#define	BCM_5710_FW_COMPILE_FLAGS		1

/*
 * Attention bits
 */
struct atten_def_status_block {
	uint32_t	attn_bits;
	uint32_t	attn_bits_ack;
	uint8_t		status_block_id;
	uint8_t		reserved0;
	uint16_t	attn_bits_index;
	uint32_t	reserved1;
};

/*
 * Common data for all protocols.
 */
struct doorbell_hdr {
	uint8_t		header;
#define	DOORBELL_HDR_RX			(0x1 << 0)
#define	DOORBELL_HDR_RX_SHIFT		0
#define	DOORBELL_HDR_DB_TYPE		(0x1 << 1)
#define	DOORBELL_HDR_DB_TYPE_SHIFT	1
#define	DOORBELL_HDR_DPM_SIZE		(0x3 << 2)
#define	DOORBELL_HDR_DPM_SIZE_SHIFT	2
#define	DOORBELL_HDR_CONN_TYPE		(0xF << 4)
#define	DOORBELL_HDR_CONN_TYPE_SHIFT	4
};

/*
 * Doorbell message sent to the chip.
 */
struct doorbell {
#if defined(__BIG_ENDIAN)
	uint16_t	zero_fill2;
	uint8_t		zero_fill1;
	struct doorbell_hdr	header;
#elif defined(__LITTLE_ENDIAN)
	struct doorbell_hdr	header;
	uint8_t		zero_fill1;
	uint16_t	zero_fill2;
#endif
};

/*
 * Doorbell message sent to the chip.
 */
struct doorbell_set_prod {
#if defined(__BIG_ENDIAN)
	uint16_t	prod;
	uint8_t		zero_fill1;
	struct doorbell_hdr	header;
#elif defined(__LITTLE_ENDIAN)
	struct doorbell_hdr	header;
	uint8_t		zero_fill1;
	uint16_t	prod;
#endif
};

/*
 * IGU driver acknowledgement register.
 */
struct igu_ack_register {
#if defined(__BIG_ENDIAN)
	uint16_t	sb_id_and_flags;
#define	IGU_ACK_REGISTER_STATUS_BLOCK_ID	(0x1F << 0)
#define	IGU_ACK_REGISTER_STATUS_BLOCK_ID_SHIFT	0
#define	IGU_ACK_REGISTER_STORM_ID		(0x7 << 5)
#define	IGU_ACK_REGISTER_STORM_ID_SHIFT		5
#define	IGU_ACK_REGISTER_UPDATE_INDEX		(0x1 << 8)
#define	IGU_ACK_REGISTER_UPDATE_INDEX_SHIFT	8
#define	IGU_ACK_REGISTER_INTERRUPT_MODE		(0x3 << 9)
#define	IGU_ACK_REGISTER_INTERRUPT_MODE_SHIFT	9
#define	IGU_ACK_REGISTER_RESERVED		(0x1F << 11)
#define	IGU_ACK_REGISTER_RESERVED_SHIFT		11
	uint16_t	status_block_index;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	status_block_index;
	uint16_t	sb_id_and_flags;
#define	IGU_ACK_REGISTER_STATUS_BLOCK_ID	(0x1F << 0)
#define	IGU_ACK_REGISTER_STATUS_BLOCK_ID_SHIFT	0
#define	IGU_ACK_REGISTER_STORM_ID		(0x7 << 5)
#define	IGU_ACK_REGISTER_STORM_ID_SHIFT		5
#define	IGU_ACK_REGISTER_UPDATE_INDEX		(0x1 << 8)
#define	IGU_ACK_REGISTER_UPDATE_INDEX_SHIFT	8
#define	IGU_ACK_REGISTER_INTERRUPT_MODE		(0x3 << 9)
#define	IGU_ACK_REGISTER_INTERRUPT_MODE_SHIFT	9
#define	IGU_ACK_REGISTER_RESERVED		(0x1F << 11)
#define	IGU_ACK_REGISTER_RESERVED_SHIFT		11
#endif
};

/*
 * IGU driver acknowledgement register.
 */
struct igu_backward_compatible {
	uint32_t	sb_id_and_flags;
#define	IGU_BACKWARD_COMPATIBLE_SB_INDEX		(0xFFFF << 0)
#define	IGU_BACKWARD_COMPATIBLE_SB_INDEX_SHIFT		0
#define	IGU_BACKWARD_COMPATIBLE_SB_SELECT		(0x1F << 16)
#define	IGU_BACKWARD_COMPATIBLE_SB_SELECT_SHIFT		16
#define	IGU_BACKWARD_COMPATIBLE_SEGMENT_ACCESS		(0x7 << 21)
#define	IGU_BACKWARD_COMPATIBLE_SEGMENT_ACCESS_SHIFT	21
#define	IGU_BACKWARD_COMPATIBLE_BUPDATE			(0x1 << 24)
#define	IGU_BACKWARD_COMPATIBLE_BUPDATE_SHIFT		24
#define	IGU_BACKWARD_COMPATIBLE_ENABLE_INT		(0x3 << 25)
#define	IGU_BACKWARD_COMPATIBLE_ENABLE_INT_SHIFT	25
#define	IGU_BACKWARD_COMPATIBLE_RESERVED_0		(0x1F << 27)
#define	IGU_BACKWARD_COMPATIBLE_RESERVED_0_SHIFT	27
	uint32_t	reserved_2;
};

/*
 * IGU driver acknowledgement register.
 */
struct igu_regular {
	uint32_t	sb_id_and_flags;
#define	IGU_REGULAR_SB_INDEX			(0xFFFFF << 0)
#define	IGU_REGULAR_SB_INDEX_SHIFT		0
#define	IGU_REGULAR_RESERVED0			(0x1 << 20)
#define	IGU_REGULAR_RESERVED0_SHIFT		20
#define	IGU_REGULAR_SEGMENT_ACCESS		(0x7 << 21)
#define	IGU_REGULAR_SEGMENT_ACCESS_SHIFT	21
#define	IGU_REGULAR_BUPDATE			(0x1 << 24)
#define	IGU_REGULAR_BUPDATE_SHIFT		24
#define	IGU_REGULAR_ENABLE_INT			(0x3 << 25)
#define	IGU_REGULAR_ENABLE_INT_SHIFT		25
#define	IGU_REGULAR_RESERVED_1			(0x1 << 27)
#define	IGU_REGULAR_RESERVED_1_SHIFT		27
#define	IGU_REGULAR_CLEANUP_TYPE		(0x3 << 28)
#define	IGU_REGULAR_CLEANUP_TYPE_SHIFT		28
#define	IGU_REGULAR_CLEANUP_SET			(0x1 << 30)
#define	IGU_REGULAR_CLEANUP_SET_SHIFT		30
#define	IGU_REGULAR_BCLEANUP			(0x1 << 31)
#define	IGU_REGULAR_BCLEANUP_SHIFT		31
	uint32_t	reserved_2;
};

/*
 * IGU driver acknowledgement register.
 */
union igu_consprod_reg {
	struct igu_regular	regular;
	struct igu_backward_compatible	backward_compatible;
};

/*
 * Parser parsing flags field.
 */
struct parsing_flags {
	uint16_t	flags;
#define	PARSING_FLAGS_ETHERNET_ADDRESS_TYPE		(0x1 << 0)
#define	PARSING_FLAGS_ETHERNET_ADDRESS_TYPE_SHIFT	0
#define	PARSING_FLAGS_VLAN				(0x1 << 1)
#define	PARSING_FLAGS_VLAN_SHIFT			1
#define	PARSING_FLAGS_EXTRA_VLAN			(0x1 << 2)
#define	PARSING_FLAGS_EXTRA_VLAN_SHIFT			2
#define	PARSING_FLAGS_OVER_ETHERNET_PROTOCOL		(0x3 << 3)
#define	PARSING_FLAGS_OVER_ETHERNET_PROTOCOL_SHIFT	3
#define	PARSING_FLAGS_IP_OPTIONS			(0x1 << 5)
#define	PARSING_FLAGS_IP_OPTIONS_SHIFT			5
#define	PARSING_FLAGS_FRAGMENTATION_STATUS		(0x1 << 6)
#define	PARSING_FLAGS_FRAGMENTATION_STATUS_SHIFT	6
#define	PARSING_FLAGS_OVER_IP_PROTOCOL			(0x3 << 7)
#define	PARSING_FLAGS_OVER_IP_PROTOCOL_SHIFT		7
#define	PARSING_FLAGS_PURE_ACK_INDICATION		(0x1 << 9)
#define	PARSING_FLAGS_PURE_ACK_INDICATION_SHIFT		9
#define	PARSING_FLAGS_TCP_OPTIONS_EXIST			(0x1 << 10)
#define	PARSING_FLAGS_TCP_OPTIONS_EXIST_SHIFT		10
#define	PARSING_FLAGS_TIME_STAMP_EXIST_FLAG		(0x1 << 11)
#define	PARSING_FLAGS_TIME_STAMP_EXIST_FLAG_SHIFT	11
#define	PARSING_FLAGS_CONNECTION_MATCH			(0x1 << 12)
#define	PARSING_FLAGS_CONNECTION_MATCH_SHIFT		12
#define	PARSING_FLAGS_LLC_SNAP				(0x1 << 13)
#define	PARSING_FLAGS_LLC_SNAP_SHIFT			13
#define	PARSING_FLAGS_RESERVED0				(0x3 << 14)
#define	PARSING_FLAGS_RESERVED0_SHIFT			14
};

struct regpair {
	uint32_t	lo;
	uint32_t	hi;
};

/*
 * dmae command structure
 */
struct dmae_command {
	uint32_t	opcode;
#define	DMAE_COMMAND_SRC			(0x1 << 0)
#define	DMAE_COMMAND_SRC_SHIFT			0
#define	DMAE_COMMAND_DST			(0x3 << 1)
#define	DMAE_COMMAND_DST_SHIFT			1
#define	DMAE_COMMAND_C_DST			(0x1 << 3)
#define	DMAE_COMMAND_C_DST_SHIFT		3
#define	DMAE_COMMAND_C_TYPE_ENABLE		(0x1 << 4)
#define	DMAE_COMMAND_C_TYPE_ENABLE_SHIFT	4
#define	DMAE_COMMAND_C_TYPE_CRC_ENABLE		(0x1 << 5)
#define	DMAE_COMMAND_C_TYPE_CRC_ENABLE_SHIFT	5
#define	DMAE_COMMAND_C_TYPE_CRC_OFFSET		(0x7 << 6)
#define	DMAE_COMMAND_C_TYPE_CRC_OFFSET_SHIFT	6
#define	DMAE_COMMAND_ENDIANITY			(0x3 << 9)
#define	DMAE_COMMAND_ENDIANITY_SHIFT		9
#define	DMAE_COMMAND_PORT			(0x1 << 11)
#define	DMAE_COMMAND_PORT_SHIFT			11
#define	DMAE_COMMAND_CRC_RESET			(0x1 << 12)
#define	DMAE_COMMAND_CRC_RESET_SHIFT		12
#define	DMAE_COMMAND_SRC_RESET			(0x1 << 13)
#define	DMAE_COMMAND_SRC_RESET_SHIFT		13
#define	DMAE_COMMAND_DST_RESET			(0x1 << 14)
#define	DMAE_COMMAND_DST_RESET_SHIFT		14
#define	DMAE_COMMAND_E1HVN			(0x3 << 15)
#define	DMAE_COMMAND_E1HVN_SHIFT		15
#define	DMAE_COMMAND_RESERVED0			(0x7FFF << 17)
#define	DMAE_COMMAND_RESERVED0_SHIFT		17
	uint32_t	src_addr_lo;
	uint32_t	src_addr_hi;
	uint32_t	dst_addr_lo;
	uint32_t	dst_addr_hi;
#if defined(__BIG_ENDIAN)
	uint16_t	reserved1;
	uint16_t	len;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	len;
	uint16_t	reserved1;
#endif
	uint32_t	comp_addr_lo;
	uint32_t	comp_addr_hi;
	uint32_t	comp_val;
	uint32_t	crc32;
	uint32_t	crc32_c;
#if defined(__BIG_ENDIAN)
	uint16_t	crc16_c;
	uint16_t	crc16;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	crc16;
	uint16_t	crc16_c;
#endif
#if defined(__BIG_ENDIAN)
	uint16_t	reserved2;
	uint16_t	crc_t10;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	crc_t10;
	uint16_t	reserved2;
#endif
#if defined(__BIG_ENDIAN)
	uint16_t	xsum8;
	uint16_t	xsum16;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	xsum16;
	uint16_t	xsum8;
#endif
};

struct double_regpair {
	uint32_t	regpair0_lo;
	uint32_t	regpair0_hi;
	uint32_t	regpair1_lo;
	uint32_t	regpair1_hi;
};

/*
 * The eth storm context of Ustorm (configuration part).
 */
struct ustorm_eth_st_context_config {
#if defined(__BIG_ENDIAN)
	uint8_t		flags;
#define	USTORM_ETH_ST_CONTEXT_CONFIG_ENABLE_MC_ALIGNMENT	(0x1 << 0)
#define	USTORM_ETH_ST_CONTEXT_CONFIG_ENABLE_MC_ALIGNMENT_SHIFT	0
#define	USTORM_ETH_ST_CONTEXT_CONFIG_ENABLE_DYNAMIC_HC		(0x1 << 1)
#define	USTORM_ETH_ST_CONTEXT_CONFIG_ENABLE_DYNAMIC_HC_SHIFT	1
#define	USTORM_ETH_ST_CONTEXT_CONFIG_ENABLE_TPA			(0x1 << 2)
#define	USTORM_ETH_ST_CONTEXT_CONFIG_ENABLE_TPA_SHIFT		2
#define	USTORM_ETH_ST_CONTEXT_CONFIG_ENABLE_STATISTICS		(0x1 << 3)
#define	USTORM_ETH_ST_CONTEXT_CONFIG_ENABLE_STATISTICS_SHIFT	3
#define	__USTORM_ETH_ST_CONTEXT_CONFIG_RESERVED0		(0xF << 4)
#define	__USTORM_ETH_ST_CONTEXT_CONFIG_RESERVED0_SHIFT		4
	uint8_t		status_block_id;
	uint8_t		clientId;
	uint8_t		sb_index_numbers;
#define	USTORM_ETH_ST_CONTEXT_CONFIG_CQE_SB_INDEX_NUMBER	(0xF << 0)
#define	USTORM_ETH_ST_CONTEXT_CONFIG_CQE_SB_INDEX_NUMBER_SHIFT	0
#define	USTORM_ETH_ST_CONTEXT_CONFIG_BD_SB_INDEX_NUMBER		(0xF << 4)
#define	USTORM_ETH_ST_CONTEXT_CONFIG_BD_SB_INDEX_NUMBER_SHIFT	4
#elif defined(__LITTLE_ENDIAN)
	uint8_t		sb_index_numbers;
#define	USTORM_ETH_ST_CONTEXT_CONFIG_CQE_SB_INDEX_NUMBER	(0xF << 0)
#define	USTORM_ETH_ST_CONTEXT_CONFIG_CQE_SB_INDEX_NUMBER_SHIFT	0
#define	USTORM_ETH_ST_CONTEXT_CONFIG_BD_SB_INDEX_NUMBER		(0xF << 4)
#define	USTORM_ETH_ST_CONTEXT_CONFIG_BD_SB_INDEX_NUMBER_SHIFT	4
	uint8_t		clientId;
	uint8_t		status_block_id;
	uint8_t		flags;
#define	USTORM_ETH_ST_CONTEXT_CONFIG_ENABLE_MC_ALIGNMENT	(0x1 << 0)
#define	USTORM_ETH_ST_CONTEXT_CONFIG_ENABLE_MC_ALIGNMENT_SHIFT	0
#define	USTORM_ETH_ST_CONTEXT_CONFIG_ENABLE_DYNAMIC_HC		(0x1 << 1)
#define	USTORM_ETH_ST_CONTEXT_CONFIG_ENABLE_DYNAMIC_HC_SHIFT	1
#define	USTORM_ETH_ST_CONTEXT_CONFIG_ENABLE_TPA			(0x1 << 2)
#define	USTORM_ETH_ST_CONTEXT_CONFIG_ENABLE_TPA_SHIFT		2
#define	USTORM_ETH_ST_CONTEXT_CONFIG_ENABLE_STATISTICS		(0x1 << 3)
#define	USTORM_ETH_ST_CONTEXT_CONFIG_ENABLE_STATISTICS_SHIFT	3
#define	__USTORM_ETH_ST_CONTEXT_CONFIG_RESERVED0		(0xF << 4)
#define	__USTORM_ETH_ST_CONTEXT_CONFIG_RESERVED0_SHIFT		4
#endif
#if defined(__BIG_ENDIAN)
	uint16_t	bd_buff_size;
	uint8_t		statistics_counter_id;
	uint8_t		mc_alignment_log_size;
#elif defined(__LITTLE_ENDIAN)
	uint8_t		mc_alignment_log_size;
	uint8_t		statistics_counter_id;
	uint16_t	bd_buff_size;
#endif
#if defined(__BIG_ENDIAN)
	uint8_t		__local_sge_prod;
	uint8_t		__local_bd_prod;
	uint16_t	sge_buff_size;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	sge_buff_size;
	uint8_t		__local_bd_prod;
	uint8_t		__local_sge_prod;
#endif
#if defined(__BIG_ENDIAN)
	uint16_t	__sdm_bd_expected_counter;
	uint8_t		cstorm_agg_int;
	uint8_t		__expected_bds_on_ram;
#elif defined(__LITTLE_ENDIAN)
	uint8_t		__expected_bds_on_ram;
	uint8_t		cstorm_agg_int;
	uint16_t	__sdm_bd_expected_counter;
#endif
#if defined(__BIG_ENDIAN)
	uint16_t	__ring_data_ram_addr;
	uint16_t	__hc_cstorm_ram_addr;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__hc_cstorm_ram_addr;
	uint16_t	__ring_data_ram_addr;
#endif
#if defined(__BIG_ENDIAN)
	uint8_t		reserved1;
	uint8_t		max_sges_for_packet;
	uint16_t	__bd_ring_ram_addr;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__bd_ring_ram_addr;
	uint8_t		max_sges_for_packet;
	uint8_t		reserved1;
#endif
	uint32_t	bd_page_base_lo;
	uint32_t	bd_page_base_hi;
	uint32_t	sge_page_base_lo;
	uint32_t	sge_page_base_hi;
	struct regpair	reserved2;
};

/*
 * The eth Rx Buffer Descriptor.
 */
struct eth_rx_bd {
	uint32_t	addr_lo;
	uint32_t	addr_hi;
};

/*
 * The eth Rx SGE Descriptor.
 */
struct eth_rx_sge {
	uint32_t	addr_lo;
	uint32_t	addr_hi;
};

/*
 * Local BDs and SGEs rings (in ETH).
 */
struct eth_local_rx_rings {
	struct eth_rx_bd	__local_bd_ring[8];
	struct eth_rx_sge	__local_sge_ring[10];
};

/*
 * The eth storm context of Ustorm.
 */
struct ustorm_eth_st_context {
	struct ustorm_eth_st_context_config	common;
	struct eth_local_rx_rings		__rings;
};

/*
 * The eth storm context of Tstorm.
 */
struct tstorm_eth_st_context {
	uint32_t	__reserved0[28];
};

/*
 * The eth aggregative context section of Xstorm.
 */
struct xstorm_eth_extra_ag_context_section {
#if defined(__BIG_ENDIAN)
	uint8_t		__tcp_agg_vars1;
	uint8_t		__reserved50;
	uint16_t	__mss;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__mss;
	uint8_t		__reserved50;
	uint8_t		__tcp_agg_vars1;
#endif
	uint32_t	__snd_nxt;
	uint32_t	__tx_wnd;
	uint32_t	__snd_una;
	uint32_t	__reserved53;
#if defined(__BIG_ENDIAN)
	uint8_t		__agg_val8_th;
	uint8_t		__agg_val8;
	uint16_t	__tcp_agg_vars2;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__tcp_agg_vars2;
	uint8_t		__agg_val8;
	uint8_t		__agg_val8_th;
#endif
	uint32_t	__reserved58;
	uint32_t	__reserved59;
	uint32_t	__reserved60;
	uint32_t	__reserved61;
#if defined(__BIG_ENDIAN)
	uint16_t	__agg_val7_th;
	uint16_t	__agg_val7;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__agg_val7;
	uint16_t	__agg_val7_th;
#endif
#if defined(__BIG_ENDIAN)
	uint8_t		__tcp_agg_vars5;
	uint8_t		__tcp_agg_vars4;
	uint8_t		__tcp_agg_vars3;
	uint8_t		__reserved62;
#elif defined(__LITTLE_ENDIAN)
	uint8_t		__reserved62;
	uint8_t		__tcp_agg_vars3;
	uint8_t		__tcp_agg_vars4;
	uint8_t		__tcp_agg_vars5;
#endif
	uint32_t	__tcp_agg_vars6;
#if defined(__BIG_ENDIAN)
	uint16_t	__agg_misc6;
	uint16_t	__tcp_agg_vars7;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__tcp_agg_vars7;
	uint16_t	__agg_misc6;
#endif
	uint32_t	__agg_val10;
	uint32_t	__agg_val10_th;
#if defined(__BIG_ENDIAN)
	uint16_t	__reserved3;
	uint8_t		__reserved2;
	uint8_t		__da_only_cnt;
#elif defined(__LITTLE_ENDIAN)
	uint8_t		__da_only_cnt;
	uint8_t		__reserved2;
	uint16_t	__reserved3;
#endif
};

/*
 * The eth aggregative context of Xstorm.
 */
struct xstorm_eth_ag_context {
#if defined(__BIG_ENDIAN)
	uint16_t	agg_val1;
	uint8_t		__agg_vars1;
	uint8_t		__state;
#elif defined(__LITTLE_ENDIAN)
	uint8_t		__state;
	uint8_t		__agg_vars1;
	uint16_t	agg_val1;
#endif
#if defined(__BIG_ENDIAN)
	uint8_t		cdu_reserved;
	uint8_t		__agg_vars4;
	uint8_t		__agg_vars3;
	uint8_t		__agg_vars2;
#elif defined(__LITTLE_ENDIAN)
	uint8_t		__agg_vars2;
	uint8_t		__agg_vars3;
	uint8_t		__agg_vars4;
	uint8_t		cdu_reserved;
#endif
	uint32_t	__bd_prod;
#if defined(__BIG_ENDIAN)
	uint16_t	__agg_vars5;
	uint16_t	__agg_val4_th;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__agg_val4_th;
	uint16_t	__agg_vars5;
#endif
	struct xstorm_eth_extra_ag_context_section __extra_section;
#if defined(__BIG_ENDIAN)
	uint16_t	__agg_vars7;
	uint8_t		__agg_val3_th;
	uint8_t		__agg_vars6;
#elif defined(__LITTLE_ENDIAN)
	uint8_t		__agg_vars6;
	uint8_t		__agg_val3_th;
	uint16_t	__agg_vars7;
#endif
#if defined(__BIG_ENDIAN)
	uint16_t	__agg_val11_th;
	uint16_t	__agg_val11;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__agg_val11;
	uint16_t	__agg_val11_th;
#endif
#if defined(__BIG_ENDIAN)
	uint8_t		__reserved1;
	uint8_t		__agg_val6_th;
	uint16_t	__agg_val9;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__agg_val9;
	uint8_t		__agg_val6_th;
	uint8_t		__reserved1;
#endif
#if defined(__BIG_ENDIAN)
	uint16_t	__agg_val2_th;
	uint16_t	__agg_val2;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__agg_val2;
	uint16_t	__agg_val2_th;
#endif
	uint32_t	__agg_vars8;
#if defined(__BIG_ENDIAN)
	uint16_t	__agg_misc0;
	uint16_t	__agg_val4;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__agg_val4;
	uint16_t	__agg_misc0;
#endif
#if defined(__BIG_ENDIAN)
	uint8_t		__agg_val3;
	uint8_t		__agg_val6;
	uint8_t		__agg_val5_th;
	uint8_t		__agg_val5;
#elif defined(__LITTLE_ENDIAN)
	uint8_t		__agg_val5;
	uint8_t		__agg_val5_th;
	uint8_t		__agg_val6;
	uint8_t		__agg_val3;
#endif
#if defined(__BIG_ENDIAN)
	uint16_t	__agg_misc1;
	uint16_t	__bd_ind_max_val;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__bd_ind_max_val;
	uint16_t	__agg_misc1;
#endif
	uint32_t	__reserved57;
	uint32_t	__agg_misc4;
	uint32_t	__agg_misc5;
};

/*
 * The eth extra aggregative context section of Tstorm.
 */
struct tstorm_eth_extra_ag_context_section {
	uint32_t	__agg_val1;
#if defined(__BIG_ENDIAN)
	uint8_t		__tcp_agg_vars2;
	uint8_t		__agg_val3;
	uint16_t	__agg_val2;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__agg_val2;
	uint8_t		__agg_val3;
	uint8_t		__tcp_agg_vars2;
#endif
#if defined(__BIG_ENDIAN)
	uint16_t	__agg_val5;
	uint8_t		__agg_val6;
	uint8_t		__tcp_agg_vars3;
#elif defined(__LITTLE_ENDIAN)
	uint8_t		__tcp_agg_vars3;
	uint8_t		__agg_val6;
	uint16_t	__agg_val5;
#endif
	uint32_t	__reserved63;
	uint32_t	__reserved64;
	uint32_t	__reserved65;
	uint32_t	__reserved66;
	uint32_t	__reserved67;
	uint32_t	__tcp_agg_vars1;
	uint32_t	__reserved61;
	uint32_t	__reserved62;
	uint32_t	__reserved2;
};

/*
 * The eth aggregative context of Tstorm.
 */
struct tstorm_eth_ag_context {
#if defined(__BIG_ENDIAN)
	uint16_t	__reserved54;
	uint8_t		__agg_vars1;
	uint8_t		__state;
#elif defined(__LITTLE_ENDIAN)
	uint8_t		__state;
	uint8_t		__agg_vars1;
	uint16_t	__reserved54;
#endif
#if defined(__BIG_ENDIAN)
	uint16_t	__agg_val4;
	uint16_t	__agg_vars2;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__agg_vars2;
	uint16_t	__agg_val4;
#endif
	struct tstorm_eth_extra_ag_context_section	__extra_section;
};

/*
 * The eth aggregative context of Cstorm.
 */
struct cstorm_eth_ag_context {
	uint32_t	__agg_vars1;
#if defined(__BIG_ENDIAN)
	uint8_t		__aux1_th;
	uint8_t		__aux1_val;
	uint16_t	__agg_vars2;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__agg_vars2;
	uint8_t		__aux1_val;
	uint8_t		__aux1_th;
#endif
	uint32_t	__num_of_treated_packet;
	uint32_t	__last_packet_treated;
#if defined(__BIG_ENDIAN)
	uint16_t	__reserved58;
	uint16_t	__reserved57;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__reserved57;
	uint16_t	__reserved58;
#endif
#if defined(__BIG_ENDIAN)
	uint8_t		__reserved62;
	uint8_t		__reserved61;
	uint8_t		__reserved60;
	uint8_t		__reserved59;
#elif defined(__LITTLE_ENDIAN)
	uint8_t		__reserved59;
	uint8_t		__reserved60;
	uint8_t		__reserved61;
	uint8_t		__reserved62;
#endif
#if defined(__BIG_ENDIAN)
	uint16_t	__reserved64;
	uint16_t	__reserved63;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__reserved63;
	uint16_t	__reserved64;
#endif
	uint32_t	__reserved65;
#if defined(__BIG_ENDIAN)
	uint16_t	__agg_vars3;
	uint16_t	__rq_inv_cnt;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__rq_inv_cnt;
	uint16_t	__agg_vars3;
#endif
#if defined(__BIG_ENDIAN)
	uint16_t	__packet_index_th;
	uint16_t	__packet_index;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__packet_index;
	uint16_t	__packet_index_th;
#endif
};

/*
 * The eth aggregative context of Ustorm.
 */
struct ustorm_eth_ag_context {
#if defined(__BIG_ENDIAN)
	uint8_t		__aux_counter_flags;
	uint8_t		__agg_vars2;
	uint8_t		__agg_vars1;
	uint8_t		__state;
#elif defined(__LITTLE_ENDIAN)
	uint8_t		__state;
	uint8_t		__agg_vars1;
	uint8_t		__agg_vars2;
	uint8_t		__aux_counter_flags;
#endif
#if defined(__BIG_ENDIAN)
	uint8_t		cdu_usage;
	uint8_t		__agg_misc2;
	uint16_t	__agg_misc1;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__agg_misc1;
	uint8_t		__agg_misc2;
	uint8_t		cdu_usage;
#endif
	uint32_t	__agg_misc4;
#if defined(__BIG_ENDIAN)
	uint8_t		__agg_val3_th;
	uint8_t		__agg_val3;
	uint16_t	__agg_misc3;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__agg_misc3;
	uint8_t		__agg_val3;
	uint8_t		__agg_val3_th;
#endif
	uint32_t	__agg_val1;
	uint32_t	__agg_misc4_th;
#if defined(__BIG_ENDIAN)
	uint16_t	__agg_val2_th;
	uint16_t	__agg_val2;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__agg_val2;
	uint16_t	__agg_val2_th;
#endif
#if defined(__BIG_ENDIAN)
	uint16_t	__reserved2;
	uint8_t		__decision_rules;
	uint8_t		__decision_rule_enable_bits;
#elif defined(__LITTLE_ENDIAN)
	uint8_t		__decision_rule_enable_bits;
	uint8_t		__decision_rules;
	uint16_t	__reserved2;
#endif
};

/*
 * Timers connection context.
 */
struct timers_block_context {
	uint32_t	__reserved_0;
	uint32_t	__reserved_1;
	uint32_t	__reserved_2;
	uint32_t	flags;
#define	__TIMERS_BLOCK_CONTEXT_NUM_OF_ACTIVE_TIMERS	(0x3 << 0)
#define	__TIMERS_BLOCK_CONTEXT_NUM_OF_ACTIVE_TIMERS_SHIFT 0
#define	TIMERS_BLOCK_CONTEXT_CONN_VALID_FLG		(0x1 << 2)
#define	TIMERS_BLOCK_CONTEXT_CONN_VALID_FLG_SHIFT	2
#define	__TIMERS_BLOCK_CONTEXT_RESERVED0		(0x1FFFFFFF << 3)
#define	__TIMERS_BLOCK_CONTEXT_RESERVED0_SHIFT		3
};

/*
 * Structure for easy accessibility to assembler.
 */
struct eth_tx_bd_flags {
	uint8_t	as_bitfield;
#define	ETH_TX_BD_FLAGS_VLAN_TAG		(0x1 << 0)
#define	ETH_TX_BD_FLAGS_VLAN_TAG_SHIFT		0
#define	ETH_TX_BD_FLAGS_IP_CSUM			(0x1 << 1)
#define	ETH_TX_BD_FLAGS_IP_CSUM_SHIFT		1
#define	ETH_TX_BD_FLAGS_L4_CSUM			(0x1 << 2)
#define	ETH_TX_BD_FLAGS_L4_CSUM_SHIFT		2
#define	ETH_TX_BD_FLAGS_END_BD			(0x1 << 3)
#define	ETH_TX_BD_FLAGS_END_BD_SHIFT		3
#define	ETH_TX_BD_FLAGS_START_BD		(0x1 << 4)
#define	ETH_TX_BD_FLAGS_START_BD_SHIFT		4
#define	ETH_TX_BD_FLAGS_HDR_POOL		(0x1 << 5)
#define	ETH_TX_BD_FLAGS_HDR_POOL_SHIFT		5
#define	ETH_TX_BD_FLAGS_SW_LSO			(0x1 << 6)
#define	ETH_TX_BD_FLAGS_SW_LSO_SHIFT		6
#define	ETH_TX_BD_FLAGS_IPV6			(0x1 << 7)
#define	ETH_TX_BD_FLAGS_IPV6_SHIFT		7
};

/*
 * The eth Tx Buffer Descriptor.
 */
struct eth_tx_start_bd {
	uint32_t	addr_lo;
	uint32_t	addr_hi;
	uint16_t	nbd;
	uint16_t	nbytes;
	uint16_t	vlan;
	struct eth_tx_bd_flags	bd_flags;
	uint8_t		general_data;
#define	ETH_TX_START_BD_HDR_NBDS		(0x3F << 0)
#define	ETH_TX_START_BD_HDR_NBDS_SHIFT		0
#define	ETH_TX_START_BD_ETH_ADDR_TYPE		(0x3 << 6)
#define	ETH_TX_START_BD_ETH_ADDR_TYPE_SHIFT	6
};

/*
 * Tx regular BD structure.
 */
struct eth_tx_bd {
	uint32_t	addr_lo;
	uint32_t	addr_hi;
	uint16_t	total_pkt_bytes;
	uint16_t	nbytes;
	uint8_t		reserved[4];
};

/*
 * Tx parsing BD structure for ETH,Relevant in START.
 */
struct eth_tx_parse_bd {
	uint8_t		global_data;
#define	ETH_TX_PARSE_BD_IP_HDR_START_OFFSET		(0xF << 0)
#define	ETH_TX_PARSE_BD_IP_HDR_START_OFFSET_SHIFT	0
#define	ETH_TX_PARSE_BD_UDP_CS_FLG			(0x1 << 4)
#define	ETH_TX_PARSE_BD_UDP_CS_FLG_SHIFT		4
#define	ETH_TX_PARSE_BD_PSEUDO_CS_WITHOUT_LEN		(0x1 << 5)
#define	ETH_TX_PARSE_BD_PSEUDO_CS_WITHOUT_LEN_SHIFT	5
#define	ETH_TX_PARSE_BD_LLC_SNAP_EN			(0x1 << 6)
#define	ETH_TX_PARSE_BD_LLC_SNAP_EN_SHIFT		6
#define	ETH_TX_PARSE_BD_NS_FLG				(0x1 << 7)
#define	ETH_TX_PARSE_BD_NS_FLG_SHIFT			7
	uint8_t		tcp_flags;
#define	ETH_TX_PARSE_BD_FIN_FLG				(0x1 << 0)
#define	ETH_TX_PARSE_BD_FIN_FLG_SHIFT			0
#define	ETH_TX_PARSE_BD_SYN_FLG				(0x1 << 1)
#define	ETH_TX_PARSE_BD_SYN_FLG_SHIFT			1
#define	ETH_TX_PARSE_BD_RST_FLG				(0x1 << 2)
#define	ETH_TX_PARSE_BD_RST_FLG_SHIFT			2
#define	ETH_TX_PARSE_BD_PSH_FLG				(0x1 << 3)
#define	ETH_TX_PARSE_BD_PSH_FLG_SHIFT			3
#define	ETH_TX_PARSE_BD_ACK_FLG				(0x1 << 4)
#define	ETH_TX_PARSE_BD_ACK_FLG_SHIFT			4
#define	ETH_TX_PARSE_BD_URG_FLG				(0x1 << 5)
#define	ETH_TX_PARSE_BD_URG_FLG_SHIFT			5
#define	ETH_TX_PARSE_BD_ECE_FLG				(0x1 << 6)
#define	ETH_TX_PARSE_BD_ECE_FLG_SHIFT			6
#define	ETH_TX_PARSE_BD_CWR_FLG				(0x1 << 7)
#define	ETH_TX_PARSE_BD_CWR_FLG_SHIFT			7
	uint8_t		ip_hlen;
	uint8_t		reserved;
	uint16_t	total_hlen;
	uint16_t	tcp_pseudo_csum;
	uint16_t	lso_mss;
	uint16_t	ip_id;
	uint32_t	tcp_send_seq;
};

/*
 * The last BD in the BD memory will hold a pointer to the next BD memory.
 */
struct eth_tx_next_bd {
	uint32_t	addr_lo;
	uint32_t	addr_hi;
	uint8_t		reserved[8];
};

/*
 * union for 4 Bd types.
 */
union eth_tx_bd_types {
	struct eth_tx_start_bd	start_bd;
	struct eth_tx_bd	reg_bd;
	struct eth_tx_parse_bd	parse_bd;
	struct eth_tx_next_bd	next_bd;
};

/*
 * The eth storm context of Xstorm.
 */
struct xstorm_eth_st_context {
	uint32_t	tx_bd_page_base_lo;
	uint32_t	tx_bd_page_base_hi;
#if defined(__BIG_ENDIAN)
	uint16_t	tx_bd_cons;
	uint8_t		statistics_data;
#define	XSTORM_ETH_ST_CONTEXT_STATISTICS_COUNTER_ID		(0x7F << 0)
#define	XSTORM_ETH_ST_CONTEXT_STATISTICS_COUNTER_ID_SHIFT	0
#define	XSTORM_ETH_ST_CONTEXT_STATISTICS_ENABLE			(0x1 << 7)
#define	XSTORM_ETH_ST_CONTEXT_STATISTICS_ENABLE_SHIFT		7
	uint8_t		__local_tx_bd_prod;
#elif defined(__LITTLE_ENDIAN)
	uint8_t		__local_tx_bd_prod;
	uint8_t		statistics_data;
#define	XSTORM_ETH_ST_CONTEXT_STATISTICS_COUNTER_ID		(0x7F << 0)
#define	XSTORM_ETH_ST_CONTEXT_STATISTICS_COUNTER_ID_SHIFT	0
#define	XSTORM_ETH_ST_CONTEXT_STATISTICS_ENABLE			(0x1 << 7)
#define	XSTORM_ETH_ST_CONTEXT_STATISTICS_ENABLE_SHIFT		7
	uint16_t	tx_bd_cons;
#endif
	uint32_t	__reserved1;
	uint32_t	__reserved2;
#if defined(__BIG_ENDIAN)
	uint8_t		__ram_cache_index;
	uint8_t		__double_buffer_client;
	uint16_t	__pkt_cons;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__pkt_cons;
	uint8_t		__double_buffer_client;
	uint8_t		__ram_cache_index;
#endif
#if defined(__BIG_ENDIAN)
	uint16_t	__statistics_address;
	uint16_t	__gso_next;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	__gso_next;
	uint16_t	__statistics_address;
#endif
#if defined(__BIG_ENDIAN)
	uint8_t		__local_tx_bd_cons;
	uint8_t		safc_group_num;
	uint8_t		safc_group_en;
	uint8_t		__is_eth_conn;
#elif defined(__LITTLE_ENDIAN)
	uint8_t		__is_eth_conn;
	uint8_t		safc_group_en;
	uint8_t		safc_group_num;
	uint8_t		__local_tx_bd_cons;
#endif
	union eth_tx_bd_types __bds[13];
};

/*
 * The eth storm context of Cstorm.
 */
struct cstorm_eth_st_context {
#if defined(__BIG_ENDIAN)
	uint16_t	__reserved0;
	uint8_t		sb_index_number;
	uint8_t		status_block_id;
#elif defined(__LITTLE_ENDIAN)
	uint8_t		status_block_id;
	uint8_t		sb_index_number;
	uint16_t	__reserved0;
#endif
	uint32_t	__reserved1[3];
};

/*
 * Ethernet connection context.
 */
struct eth_context {
	struct ustorm_eth_st_context	ustorm_st_context;
	struct tstorm_eth_st_context	tstorm_st_context;
	struct xstorm_eth_ag_context	xstorm_ag_context;
	struct tstorm_eth_ag_context	tstorm_ag_context;
	struct cstorm_eth_ag_context	cstorm_ag_context;
	struct ustorm_eth_ag_context	ustorm_ag_context;
	struct timers_block_context	timers_context;
	struct xstorm_eth_st_context	xstorm_st_context;
	struct cstorm_eth_st_context	cstorm_st_context;
};

/*
 * Ethernet doorbell
 */
struct eth_tx_doorbell {
#if defined(__BIG_ENDIAN)
	uint16_t	npackets;
	uint8_t		params;
#define	ETH_TX_DOORBELL_NUM_BDS				(0x3F << 0)
#define	ETH_TX_DOORBELL_NUM_BDS_SHIFT			0
#define	ETH_TX_DOORBELL_RESERVED_TX_FIN_FLAG		(0x1 << 6)
#define	ETH_TX_DOORBELL_RESERVED_TX_FIN_FLAG_SHIFT	6
#define	ETH_TX_DOORBELL_SPARE				(0x1 << 7)
#define	ETH_TX_DOORBELL_SPARE_SHIFT			7
	struct doorbell_hdr hdr;
#elif defined(__LITTLE_ENDIAN)
	struct doorbell_hdr hdr;
	uint8_t		params;
#define	ETH_TX_DOORBELL_NUM_BDS				(0x3F << 0)
#define	ETH_TX_DOORBELL_NUM_BDS_SHIFT			0
#define	ETH_TX_DOORBELL_RESERVED_TX_FIN_FLAG		(0x1 << 6)
#define	ETH_TX_DOORBELL_RESERVED_TX_FIN_FLAG_SHIFT	6
#define	ETH_TX_DOORBELL_SPARE				(0x1 << 7)
#define	ETH_TX_DOORBELL_SPARE_SHIFT			7
	uint16_t	npackets;
#endif
};

/*
 * cstorm default status block, generated by ustorm.
 */
struct cstorm_def_status_block_u {
	uint16_t	index_values[HC_USTORM_DEF_SB_NUM_INDICES];
	uint16_t	status_block_index;
	uint8_t		func;
	uint8_t		status_block_id;
	uint32_t	__flags;
};

/*
 * cstorm default status block, generated by cstorm.
 */
struct cstorm_def_status_block_c {
	uint16_t	index_values[HC_CSTORM_DEF_SB_NUM_INDICES];
	uint16_t	status_block_index;
	uint8_t		func;
	uint8_t		status_block_id;
	uint32_t	__flags;
};

/*
 * xstorm status block
 */
struct xstorm_def_status_block {
	uint16_t	index_values[HC_XSTORM_DEF_SB_NUM_INDICES];
	uint16_t	status_block_index;
	uint8_t		func;
	uint8_t		status_block_id;
	uint32_t	__flags;
};

/*
 * tstorm status block
 */
struct tstorm_def_status_block {
	uint16_t	index_values[HC_TSTORM_DEF_SB_NUM_INDICES];
	uint16_t	status_block_index;
	uint8_t		func;
	uint8_t		status_block_id;
	uint32_t	__flags;
};

/*
 * host status block
 */
struct host_def_status_block {
	struct atten_def_status_block	atten_status_block;
	struct cstorm_def_status_block_u	u_def_status_block;
	struct cstorm_def_status_block_c	c_def_status_block;
	struct xstorm_def_status_block	x_def_status_block;
	struct tstorm_def_status_block	t_def_status_block;
};

/*
 * cstorm status block, generated by ustorm.
 */
struct cstorm_status_block_u {
	uint16_t	index_values[HC_USTORM_SB_NUM_INDICES];
	uint16_t	status_block_index;
	uint8_t		func;
	uint8_t		status_block_id;
	uint32_t	__flags;
};

/*
 * cstorm status block, generated by cstorm.
 */
struct cstorm_status_block_c {
	uint16_t	index_values[HC_CSTORM_SB_NUM_INDICES];
	uint16_t	status_block_index;
	uint8_t		func;
	uint8_t		status_block_id;
	uint32_t	__flags;
};

/*
 * host status block
 */
struct host_status_block {
	struct cstorm_status_block_u u_status_block;
	struct cstorm_status_block_c c_status_block;
};

/*
 * The data for RSS setup ramrod.
 */
struct eth_client_setup_ramrod_data {
	uint32_t	client_id;
	uint8_t		is_rdma;
	uint8_t		is_fcoe;
	uint16_t	reserved1;
};

/*
 * regular eth FP CQE parameters struct.
 */
struct eth_fast_path_rx_cqe {
	uint8_t		type_error_flags;
#define	ETH_FAST_PATH_RX_CQE_TYPE			(0x1 << 0)
#define	ETH_FAST_PATH_RX_CQE_TYPE_SHIFT			0
#define	ETH_FAST_PATH_RX_CQE_PHY_DECODE_ERR_FLG		(0x1 << 1)
#define	ETH_FAST_PATH_RX_CQE_PHY_DECODE_ERR_FLG_SHIFT	1
#define	ETH_FAST_PATH_RX_CQE_IP_BAD_XSUM_FLG		(0x1 << 2)
#define	ETH_FAST_PATH_RX_CQE_IP_BAD_XSUM_FLG_SHIFT	2
#define	ETH_FAST_PATH_RX_CQE_L4_BAD_XSUM_FLG		(0x1 << 3)
#define	ETH_FAST_PATH_RX_CQE_L4_BAD_XSUM_FLG_SHIFT	3
#define	ETH_FAST_PATH_RX_CQE_START_FLG			(0x1 << 4)
#define	ETH_FAST_PATH_RX_CQE_START_FLG_SHIFT		4
#define	ETH_FAST_PATH_RX_CQE_END_FLG			(0x1 << 5)
#define	ETH_FAST_PATH_RX_CQE_END_FLG_SHIFT		5
#define	ETH_FAST_PATH_RX_CQE_RESERVED0			(0x3 << 6)
#define	ETH_FAST_PATH_RX_CQE_RESERVED0_SHIFT		6
	uint8_t		status_flags;
#define	ETH_FAST_PATH_RX_CQE_RSS_HASH_TYPE		(0x7 << 0)
#define	ETH_FAST_PATH_RX_CQE_RSS_HASH_TYPE_SHIFT	0
#define	ETH_FAST_PATH_RX_CQE_RSS_HASH_FLG		(0x1 << 3)
#define	ETH_FAST_PATH_RX_CQE_RSS_HASH_FLG_SHIFT		3
#define	ETH_FAST_PATH_RX_CQE_BROADCAST_FLG		(0x1 << 4)
#define	ETH_FAST_PATH_RX_CQE_BROADCAST_FLG_SHIFT	4
#define	ETH_FAST_PATH_RX_CQE_MAC_MATCH_FLG		(0x1 << 5)
#define	ETH_FAST_PATH_RX_CQE_MAC_MATCH_FLG_SHIFT	5
#define	ETH_FAST_PATH_RX_CQE_IP_XSUM_NO_VALIDATION_FLG	(0x1 << 6)
#define	ETH_FAST_PATH_RX_CQE_IP_XSUM_NO_VALIDATION_FLG_SHIFT	6
#define	ETH_FAST_PATH_RX_CQE_L4_XSUM_NO_VALIDATION_FLG	(0x1 << 7)
#define	ETH_FAST_PATH_RX_CQE_L4_XSUM_NO_VALIDATION_FLG_SHIFT	7
	uint8_t		placement_offset;
	uint8_t		queue_index;
	uint32_t	rss_hash_result;
	uint16_t	vlan_tag;
	uint16_t	pkt_len;
	uint16_t	len_on_bd;
	struct parsing_flags	pars_flags;
	uint16_t	sgl[8];
};

/*
 * The data for RSS setup ramrod.
 */
struct eth_halt_ramrod_data {
	uint32_t	client_id;
	uint32_t	reserved0;
};


/*
 * The data for statistics query ramrod.
 */
struct eth_query_ramrod_data {
#if defined(__BIG_ENDIAN)
	uint8_t		reserved0;
	uint8_t		collect_port;
	uint16_t	drv_counter;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	drv_counter;
	uint8_t		collect_port;
	uint8_t		reserved0;
#endif
	uint32_t	ctr_id_vector;
};

/*
 * Place holder for ramrods protocol specific data.
 */
struct ramrod_data {
	uint32_t	data_lo;
	uint32_t	data_hi;
};

/*
 * union for ramrod data for Ethernet protocol (CQE) (force size of 16 bits).
 */
union eth_ramrod_data {
	struct ramrod_data general;
};


/*
 * Eth Rx Cqe structure- general structure for ramrods.
 */
struct common_ramrod_eth_rx_cqe {
	uint8_t		ramrod_type;
#define	COMMON_RAMROD_ETH_RX_CQE_TYPE			(0x1 << 0)
#define	COMMON_RAMROD_ETH_RX_CQE_TYPE_SHIFT		0
#define	COMMON_RAMROD_ETH_RX_CQE_ERROR			(0x1 << 1)
#define	COMMON_RAMROD_ETH_RX_CQE_ERROR_SHIFT		1
#define	COMMON_RAMROD_ETH_RX_CQE_RESERVED0		(0x3F << 2)
#define	COMMON_RAMROD_ETH_RX_CQE_RESERVED0_SHIFT	2
	uint8_t		conn_type;
	uint16_t	reserved1;
	uint32_t	conn_and_cmd_data;
#define	COMMON_RAMROD_ETH_RX_CQE_CID			(0xFFFFFF << 0)
#define	COMMON_RAMROD_ETH_RX_CQE_CID_SHIFT 0
#define	COMMON_RAMROD_ETH_RX_CQE_CMD_ID			(0xFF << 24)
#define	COMMON_RAMROD_ETH_RX_CQE_CMD_ID_SHIFT		24
	struct ramrod_data	protocol_data;
	uint32_t	reserved2[4];
};

/*
 * Rx Last CQE in page (in ETH).
 */
struct eth_rx_cqe_next_page {
	uint32_t	addr_lo;
	uint32_t	addr_hi;
	uint32_t	reserved[6];
};

/*
 * union for all eth rx cqe types (fix their sizes).
 */
union eth_rx_cqe {
	struct eth_fast_path_rx_cqe	fast_path_cqe;
	struct common_ramrod_eth_rx_cqe	ramrod_cqe;
	struct eth_rx_cqe_next_page	next_page_cqe;
};

/*
 * Common data for all protocols.
 */
struct spe_hdr {
	uint32_t	conn_and_cmd_data;
#define	SPE_HDR_CID				(0xFFFFFF << 0)
#define	SPE_HDR_CID_SHIFT			0
#define	SPE_HDR_CMD_ID				(0xFF << 24)
#define	SPE_HDR_CMD_ID_SHIFT			24
	uint16_t	type;
#define	SPE_HDR_CONN_TYPE			(0xFF << 0)
#define	SPE_HDR_CONN_TYPE_SHIFT			0
#define	SPE_HDR_COMMON_RAMROD			(0xFF << 8)
#define	SPE_HDR_COMMON_RAMROD_SHIFT		8
	uint16_t	reserved;
};

/*
 * Ethernet slow path element
 */
union eth_specific_data {
	uint8_t		protocol_data[8];
	struct regpair	mac_config_addr;
	struct eth_client_setup_ramrod_data	client_setup_ramrod_data;
	struct eth_halt_ramrod_data	halt_ramrod_data;
	struct regpair	leading_cqe_addr;
	struct regpair	update_data_addr;
	struct eth_query_ramrod_data	query_ramrod_data;
};

/*
 * Ethernet slow path element.
 */
struct eth_spe {
	struct spe_hdr hdr;
	union eth_specific_data data;
};

/*
 * Array of 13 bds as appears in the eth xstorm context.
 */
struct eth_tx_bds_array {
	union eth_tx_bd_types bds[13];
};

/*
 * Common configuration parameters per function in Tstorm.
 */
struct tstorm_eth_function_common_config {
#if defined(__BIG_ENDIAN)
	uint8_t		leading_client_id;
	uint8_t		rss_result_mask;
	uint16_t	config_flags;
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_RSS_IPV4_CAPABILITY	(0x1 << 0)
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_RSS_IPV4_CAPABILITY_SHIFT 0
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_RSS_IPV4_TCP_CAPABILITY (0x1 << 1)
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_RSS_IPV4_TCP_CAPABILITY_SHIFT 1
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_RSS_IPV6_CAPABILITY	(0x1 << 2)
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_RSS_IPV6_CAPABILITY_SHIFT 2
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_RSS_IPV6_TCP_CAPABILITY (0x1 << 3)
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_RSS_IPV6_TCP_CAPABILITY_SHIFT 3
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_RSS_MODE		(0x7 << 4)
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_RSS_MODE_SHIFT	4
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_DEFAULT_ENABLE	(0x1 << 7)
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_DEFAULT_ENABLE_SHIFT	7
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_VLAN_IN_CAM		(0x1 << 8)
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_VLAN_IN_CAM_SHIFT	8
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_E1HOV_IN_CAM		(0x1 << 9)
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_E1HOV_IN_CAM_SHIFT	9
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_ENABLE_TPA		(0x1 << 10)
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_ENABLE_TPA_SHIFT	10
#define	__TSTORM_ETH_FUNCTION_COMMON_CONFIG_RESERVED0		(0x1F << 11)
#define	__TSTORM_ETH_FUNCTION_COMMON_CONFIG_RESERVED0_SHIFT	11
#elif defined(__LITTLE_ENDIAN)
	uint16_t	config_flags;
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_RSS_IPV4_CAPABILITY	(0x1 << 0)
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_RSS_IPV4_CAPABILITY_SHIFT 0
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_RSS_IPV4_TCP_CAPABILITY (0x1 << 1)
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_RSS_IPV4_TCP_CAPABILITY_SHIFT 1
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_RSS_IPV6_CAPABILITY	(0x1 << 2)
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_RSS_IPV6_CAPABILITY_SHIFT 2
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_RSS_IPV6_TCP_CAPABILITY (0x1 << 3)
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_RSS_IPV6_TCP_CAPABILITY_SHIFT 3
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_RSS_MODE		(0x7 << 4)
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_RSS_MODE_SHIFT	4
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_DEFAULT_ENABLE	(0x1 << 7)
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_DEFAULT_ENABLE_SHIFT	7
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_VLAN_IN_CAM		(0x1 << 8)
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_VLAN_IN_CAM_SHIFT	8
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_E1HOV_IN_CAM		(0x1 << 9)
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_E1HOV_IN_CAM_SHIFT	9
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_ENABLE_TPA		(0x1 << 10)
#define	TSTORM_ETH_FUNCTION_COMMON_CONFIG_ENABLE_TPA_SHIFT	10
#define	__TSTORM_ETH_FUNCTION_COMMON_CONFIG_RESERVED0		(0x1F << 11)
#define	__TSTORM_ETH_FUNCTION_COMMON_CONFIG_RESERVED0_SHIFT	11
	uint8_t		rss_result_mask;
	uint8_t		leading_client_id;
#endif
	uint16_t	vlan_id[2];
};

/*
 * RSS idirection table update configuration.
 */
struct rss_update_config {
#if defined(__BIG_ENDIAN)
	uint16_t	toe_rss_bitmap;
	uint16_t	flags;
#define	RSS_UPDATE_CONFIG_ETH_UPDATE_ENABLE		(0x1 << 0)
#define	RSS_UPDATE_CONFIG_ETH_UPDATE_ENABLE_SHIFT	0
#define	RSS_UPDATE_CONFIG_TOE_UPDATE_ENABLE		(0x1 << 1)
#define	RSS_UPDATE_CONFIG_TOE_UPDATE_ENABLE_SHIFT	1
#define	__RSS_UPDATE_CONFIG_RESERVED0			(0x3FFF << 2)
#define	__RSS_UPDATE_CONFIG_RESERVED0_SHIFT		2
#elif defined(__LITTLE_ENDIAN)
	uint16_t	flags;
#define	RSS_UPDATE_CONFIG_ETH_UPDATE_ENABLE		(0x1 << 0)
#define	RSS_UPDATE_CONFIG_ETH_UPDATE_ENABLE_SHIFT	0
#define	RSS_UPDATE_CONFIG_TOE_UPDATE_ENABLE		(0x1 << 1)
#define	RSS_UPDATE_CONFIG_TOE_UPDATE_ENABLE_SHIFT	1
#define	__RSS_UPDATE_CONFIG_RESERVED0			(0x3FFF << 2)
#define	__RSS_UPDATE_CONFIG_RESERVED0_SHIFT		2
	uint16_t	toe_rss_bitmap;
#endif
	uint32_t	reserved1;
};

/*
 * Parameters for eth update ramrod.
 */
struct eth_update_ramrod_data {
	struct tstorm_eth_function_common_config	func_config;
	uint8_t				indirectionTable[128];
	struct rss_update_config	rss_config;
};

/*
 * MAC filtering configuration command header.
 */
struct mac_configuration_hdr {
	uint8_t		length;
	uint8_t		offset;
	uint16_t	client_id;
	uint32_t	reserved1;
};

/*
 * MAC address in list for ramrod.
 */
struct tstorm_cam_entry {
	uint16_t	lsb_mac_addr;
	uint16_t	middle_mac_addr;
	uint16_t	msb_mac_addr;
	uint16_t	flags;
#define	TSTORM_CAM_ENTRY_PORT_ID		(0x1 << 0)
#define	TSTORM_CAM_ENTRY_PORT_ID_SHIFT		0
#define	TSTORM_CAM_ENTRY_RSRVVAL0		(0x7 << 1)
#define	TSTORM_CAM_ENTRY_RSRVVAL0_SHIFT		1
#define	TSTORM_CAM_ENTRY_RESERVED0		(0xFFF << 4)
#define	TSTORM_CAM_ENTRY_RESERVED0_SHIFT	4
};

/*
 * MAC filtering: CAM target table entry
 */
struct tstorm_cam_target_table_entry {
	uint8_t		flags;
#define	TSTORM_CAM_TARGET_TABLE_ENTRY_BROADCAST			(0x1 << 0)
#define	TSTORM_CAM_TARGET_TABLE_ENTRY_BROADCAST_SHIFT		0
#define	TSTORM_CAM_TARGET_TABLE_ENTRY_OVERRIDE_VLAN_REMOVAL	(0x1 << 1)
#define	TSTORM_CAM_TARGET_TABLE_ENTRY_OVERRIDE_VLAN_REMOVAL_SHIFT 1
#define	TSTORM_CAM_TARGET_TABLE_ENTRY_ACTION_TYPE		(0x1 << 2)
#define	TSTORM_CAM_TARGET_TABLE_ENTRY_ACTION_TYPE_SHIFT		2
#define	TSTORM_CAM_TARGET_TABLE_ENTRY_RDMA_MAC			(0x1 << 3)
#define	TSTORM_CAM_TARGET_TABLE_ENTRY_RDMA_MAC_SHIFT		3
#define	TSTORM_CAM_TARGET_TABLE_ENTRY_RESERVED0			(0xF << 4)
#define	TSTORM_CAM_TARGET_TABLE_ENTRY_RESERVED0_SHIFT		4
	uint8_t		reserved1;
	uint16_t	vlan_id;
	uint32_t	clients_bit_vector;
};

/*
 * MAC address in list for ramrod.
 */
struct mac_configuration_entry {
	struct tstorm_cam_entry	cam_entry;
	struct tstorm_cam_target_table_entry	target_table_entry;
};

/*
 * MAC filtering configuration command.
 */
struct mac_configuration_cmd {
	struct mac_configuration_hdr	hdr;
	struct mac_configuration_entry	config_table[64];
};

/*
 * MAC address in list for ramrod.
 */
struct mac_configuration_entry_e1h {
	uint16_t	lsb_mac_addr;
	uint16_t	middle_mac_addr;
	uint16_t	msb_mac_addr;
	uint16_t	vlan_id;
	uint16_t	e1hov_id;
	uint8_t		reserved0;
	uint8_t		flags;
#define	MAC_CONFIGURATION_ENTRY_E1H_PORT			(0x1 << 0)
#define	MAC_CONFIGURATION_ENTRY_E1H_PORT_SHIFT			0
#define	MAC_CONFIGURATION_ENTRY_E1H_ACTION_TYPE			(0x1 << 1)
#define	MAC_CONFIGURATION_ENTRY_E1H_ACTION_TYPE_SHIFT		1
#define	MAC_CONFIGURATION_ENTRY_E1H_RDMA_MAC			(0x1 << 2)
#define	MAC_CONFIGURATION_ENTRY_E1H_RDMA_MAC_SHIFT		2
#define	MAC_CONFIGURATION_ENTRY_E1H_RESERVED1			(0x1F << 3)
#define	MAC_CONFIGURATION_ENTRY_E1H_RESERVED1_SHIFT		3
	uint32_t	clients_bit_vector;
};

/*
 * MAC filtering configuration command.
 */
struct mac_configuration_cmd_e1h {
	struct mac_configuration_hdr	hdr;
	struct mac_configuration_entry_e1h	config_table[32];
};

/*
 * Approximate-match multicast filtering for E1H per function in Tstorm.
 */
struct tstorm_eth_approximate_match_multicast_filtering {
	uint32_t	mcast_add_hash_bit_array[8];
};

/*
 * Configuration parameters per client in Tstorm.
 */
struct tstorm_eth_client_config {
#if defined(__BIG_ENDIAN)
	uint8_t		reserved0;
	uint8_t		statistics_counter_id;
	uint16_t	mtu;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	mtu;
	uint8_t		statistics_counter_id;
	uint8_t		reserved0;
#endif
#if defined(__BIG_ENDIAN)
	uint16_t	drop_flags;
#define	TSTORM_ETH_CLIENT_CONFIG_DROP_IP_CS_ERR			(0x1 << 0)
#define	TSTORM_ETH_CLIENT_CONFIG_DROP_IP_CS_ERR_SHIFT		0
#define	TSTORM_ETH_CLIENT_CONFIG_DROP_TCP_CS_ERR		(0x1 << 1)
#define	TSTORM_ETH_CLIENT_CONFIG_DROP_TCP_CS_ERR_SHIFT		1
#define	TSTORM_ETH_CLIENT_CONFIG_DROP_TTL0			(0x1 << 2)
#define	TSTORM_ETH_CLIENT_CONFIG_DROP_TTL0_SHIFT		2
#define	TSTORM_ETH_CLIENT_CONFIG_DROP_UDP_CS_ERR		(0x1 << 3)
#define	TSTORM_ETH_CLIENT_CONFIG_DROP_UDP_CS_ERR_SHIFT		3
#define	__TSTORM_ETH_CLIENT_CONFIG_RESERVED2			(0xFFF << 4)
#define	__TSTORM_ETH_CLIENT_CONFIG_RESERVED2_SHIFT		4
	uint16_t	config_flags;
#define	TSTORM_ETH_CLIENT_CONFIG_VLAN_REM_ENABLE		(0x1 << 0)
#define	TSTORM_ETH_CLIENT_CONFIG_VLAN_REM_ENABLE_SHIFT		0
#define	TSTORM_ETH_CLIENT_CONFIG_E1HOV_REM_ENABLE		(0x1 << 1)
#define	TSTORM_ETH_CLIENT_CONFIG_E1HOV_REM_ENABLE_SHIFT		1
#define	TSTORM_ETH_CLIENT_CONFIG_STATSITICS_ENABLE		(0x1 << 2)
#define	TSTORM_ETH_CLIENT_CONFIG_STATSITICS_ENABLE_SHIFT	2
#define	__TSTORM_ETH_CLIENT_CONFIG_RESERVED1			(0x1FFF << 3)
#define	__TSTORM_ETH_CLIENT_CONFIG_RESERVED1_SHIFT		3
#elif defined(__LITTLE_ENDIAN)
	uint16_t	config_flags;
#define	TSTORM_ETH_CLIENT_CONFIG_VLAN_REM_ENABLE		(0x1 << 0)
#define	TSTORM_ETH_CLIENT_CONFIG_VLAN_REM_ENABLE_SHIFT		0
#define	TSTORM_ETH_CLIENT_CONFIG_E1HOV_REM_ENABLE		(0x1 << 1)
#define	TSTORM_ETH_CLIENT_CONFIG_E1HOV_REM_ENABLE_SHIFT		1
#define	TSTORM_ETH_CLIENT_CONFIG_STATSITICS_ENABLE		(0x1 << 2)
#define	TSTORM_ETH_CLIENT_CONFIG_STATSITICS_ENABLE_SHIFT	2
#define	__TSTORM_ETH_CLIENT_CONFIG_RESERVED1			(0x1FFF << 3)
#define	__TSTORM_ETH_CLIENT_CONFIG_RESERVED1_SHIFT		3
	uint16_t	drop_flags;
#define	TSTORM_ETH_CLIENT_CONFIG_DROP_IP_CS_ERR			(0x1 << 0)
#define	TSTORM_ETH_CLIENT_CONFIG_DROP_IP_CS_ERR_SHIFT		0
#define	TSTORM_ETH_CLIENT_CONFIG_DROP_TCP_CS_ERR		(0x1 << 1)
#define	TSTORM_ETH_CLIENT_CONFIG_DROP_TCP_CS_ERR_SHIFT		1
#define	TSTORM_ETH_CLIENT_CONFIG_DROP_TTL0			(0x1 << 2)
#define	TSTORM_ETH_CLIENT_CONFIG_DROP_TTL0_SHIFT		2
#define	TSTORM_ETH_CLIENT_CONFIG_DROP_UDP_CS_ERR		(0x1 << 3)
#define	TSTORM_ETH_CLIENT_CONFIG_DROP_UDP_CS_ERR_SHIFT		3
#define	__TSTORM_ETH_CLIENT_CONFIG_RESERVED2			(0xFFF << 4)
#define	__TSTORM_ETH_CLIENT_CONFIG_RESERVED2_SHIFT		4
#endif
};

/*
 * MAC filtering configuration parameters per port in Tstorm.
 */
struct tstorm_eth_mac_filter_config {
	uint32_t	ucast_drop_all;
	uint32_t	ucast_accept_all;
	uint32_t	mcast_drop_all;
	uint32_t	mcast_accept_all;
	uint32_t	bcast_drop_all;
	uint32_t	bcast_accept_all;
	uint32_t	strict_vlan;
	uint32_t	vlan_filter[2];
	uint32_t	reserved;
};


/*
 * Common flag to indicate existance of TPA.
 */
struct tstorm_eth_tpa_exist {
#if defined(__BIG_ENDIAN)
	uint16_t	reserved1;
	uint8_t		reserved0;
	uint8_t		tpa_exist;
#elif defined(__LITTLE_ENDIAN)
	uint8_t		tpa_exist;
	uint8_t		reserved0;
	uint16_t	reserved1;
#endif
	uint32_t	reserved2;
};

/*
 * rx rings pause data for E1h only.
 */
struct ustorm_eth_rx_pause_data_e1h {
#if defined(__BIG_ENDIAN)
	uint16_t	bd_thr_low;
	uint16_t	cqe_thr_low;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	cqe_thr_low;
	uint16_t	bd_thr_low;
#endif
#if defined(__BIG_ENDIAN)
	uint16_t	cos;
	uint16_t	sge_thr_low;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	sge_thr_low;
	uint16_t	cos;
#endif
#if defined(__BIG_ENDIAN)
	uint16_t	bd_thr_high;
	uint16_t	cqe_thr_high;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	cqe_thr_high;
	uint16_t	bd_thr_high;
#endif
#if defined(__BIG_ENDIAN)
	uint16_t	reserved0;
	uint16_t	sge_thr_high;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	sge_thr_high;
	uint16_t	reserved0;
#endif
};

/*
 * Three RX producers for ETH.
 */
struct ustorm_eth_rx_producers {
#if defined(__BIG_ENDIAN)
	uint16_t	bd_prod;
	uint16_t	cqe_prod;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	cqe_prod;
	uint16_t	bd_prod;
#endif
#if defined(__BIG_ENDIAN)
	uint16_t	reserved;
	uint16_t	sge_prod;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	sge_prod;
	uint16_t	reserved;
#endif
};

/*
 * Per-port SAFC demo variables.
 */
struct cmng_flags_per_port {
	uint8_t		con_number[NUM_OF_PROTOCOLS];
	uint32_t	cmng_enables;
#define	CMNG_FLAGS_PER_PORT_FAIRNESS_VN			(0x1 << 0)
#define	CMNG_FLAGS_PER_PORT_FAIRNESS_VN_SHIFT		0
#define	CMNG_FLAGS_PER_PORT_RATE_SHAPING_VN		(0x1 << 1)
#define	CMNG_FLAGS_PER_PORT_RATE_SHAPING_VN_SHIFT	1
#define	CMNG_FLAGS_PER_PORT_FAIRNESS_PROTOCOL		(0x1 << 2)
#define	CMNG_FLAGS_PER_PORT_FAIRNESS_PROTOCOL_SHIFT	2
#define	CMNG_FLAGS_PER_PORT_RATE_SHAPING_PROTOCOL	(0x1 << 3)
#define	CMNG_FLAGS_PER_PORT_RATE_SHAPING_PROTOCOL_SHIFT	3
#define	CMNG_FLAGS_PER_PORT_FAIRNESS_COS		(0x1 << 4)
#define	CMNG_FLAGS_PER_PORT_FAIRNESS_COS_SHIFT		4
#define	__CMNG_FLAGS_PER_PORT_RESERVED0			(0x7FFFFFF << 5)
#define	__CMNG_FLAGS_PER_PORT_RESERVED0_SHIFT		5
};

/*
 * Per-port rate shaping variables.
 */
struct rate_shaping_vars_per_port {
	uint32_t	rs_periodic_timeout;
	uint32_t	rs_threshold;
};

/*
 * Per-port fairness variables.
 */
struct fairness_vars_per_port {
	uint32_t	upper_bound;
	uint32_t	fair_threshold;
	uint32_t	fairness_timeout;
};

/*
 * Per-port SAFC variables.
 */
struct safc_struct_per_port {
#if defined(__BIG_ENDIAN)
	uint16_t	__reserved1;
	uint8_t		__reserved0;
	uint8_t		safc_timeout_usec;
#elif defined(__LITTLE_ENDIAN)
	uint8_t		safc_timeout_usec;
	uint8_t		__reserved0;
	uint16_t	__reserved1;
#endif
	uint16_t	cos_to_pause_mask[NUM_OF_SAFC_BITS];
};

/*
 * Per-port congestion management variables.
 */
struct cmng_struct_per_port {
	struct rate_shaping_vars_per_port	rs_vars;
	struct fairness_vars_per_port	fair_vars;
	struct safc_struct_per_port	safc_vars;
	struct cmng_flags_per_port	flags;
};

/*
 * Dynamic host coalescing init parameters.
 */
struct dynamic_hc_config {
	uint32_t	threshold[3];
	uint8_t		shift_per_protocol[HC_USTORM_SB_NUM_INDICES];
	uint8_t		hc_timeout0[HC_USTORM_SB_NUM_INDICES];
	uint8_t		hc_timeout1[HC_USTORM_SB_NUM_INDICES];
	uint8_t		hc_timeout2[HC_USTORM_SB_NUM_INDICES];
	uint8_t		hc_timeout3[HC_USTORM_SB_NUM_INDICES];
};

/*
 * Protocol-common statistics collected by the Xstorm (per client).
 */
struct xstorm_per_client_stats {
	uint32_t	reserved0;
	uint32_t	unicast_pkts_sent;
	struct regpair	unicast_bytes_sent;
	struct regpair	multicast_bytes_sent;
	uint32_t	multicast_pkts_sent;
	uint32_t	broadcast_pkts_sent;
	struct regpair	broadcast_bytes_sent;
	uint16_t	stats_counter;
	uint16_t	reserved1;
	uint32_t	reserved2;
};

/*
 * Common statistics collected by the Xstorm (per port).
 */
struct xstorm_common_stats {
	struct xstorm_per_client_stats client_statistics[MAX_X_STAT_COUNTER_ID];
};

/*
 * Protocol-common statistics collected by the Tstorm (per port).
 */
struct tstorm_per_port_stats {
	uint32_t	mac_filter_discard;
	uint32_t	xxoverflow_discard;
	uint32_t	brb_truncate_discard;
	uint32_t	mac_discard;
};

/*
 * Protocol-common statistics collected by the Tstorm (per client).
 */
struct tstorm_per_client_stats {
	struct regpair	rcv_unicast_bytes;
	struct regpair	rcv_broadcast_bytes;
	struct regpair	rcv_multicast_bytes;
	struct regpair	rcv_error_bytes;
	uint32_t	checksum_discard;
	uint32_t	packets_too_big_discard;
	uint32_t	rcv_unicast_pkts;
	uint32_t	rcv_broadcast_pkts;
	uint32_t	rcv_multicast_pkts;
	uint32_t	no_buff_discard;
	uint32_t	ttl0_discard;
	uint16_t	stats_counter;
	uint16_t	reserved0;
};

/*
 * Protocol-common statistics collected by the Tstorm.
 */
struct tstorm_common_stats {
	struct tstorm_per_port_stats	port_statistics;
	struct tstorm_per_client_stats client_statistics[MAX_T_STAT_COUNTER_ID];
};

/*
 * Protocol-common statistics collected by the Ustorm (per client).
 */
struct ustorm_per_client_stats {
	struct regpair	ucast_no_buff_bytes;
	struct regpair	mcast_no_buff_bytes;
	struct regpair	bcast_no_buff_bytes;
	uint32_t	ucast_no_buff_pkts;
	uint32_t	mcast_no_buff_pkts;
	uint32_t	bcast_no_buff_pkts;
	uint16_t	stats_counter;
	uint16_t	reserved0;
};

/*
 * Protocol-common statistics collected by the Ustorm.
 */
struct ustorm_common_stats {
	struct ustorm_per_client_stats client_statistics[MAX_U_STAT_COUNTER_ID];
};

/*
 * Eth statistics query structure for the eth_stats_query ramrod.
 */
struct eth_stats_query {
	struct xstorm_common_stats	xstorm_common;
	struct tstorm_common_stats	tstorm_common;
	struct ustorm_common_stats	ustorm_common;
};

/*
 * Per-vnic fairness variables.
 */
struct fairness_vars_per_vn {
	uint32_t	cos_credit_delta[MAX_COS_NUMBER];
	uint32_t	protocol_credit_delta[NUM_OF_PROTOCOLS];
	uint32_t	vn_credit_delta;
	uint32_t	__reserved0;
};

/*
 * FW version stored in the Xstorm RAM.
 */
struct fw_version {
#if defined(__BIG_ENDIAN)
	uint8_t		engineering;
	uint8_t		revision;
	uint8_t		minor;
	uint8_t		major;
#elif defined(__LITTLE_ENDIAN)
	uint8_t		major;
	uint8_t		minor;
	uint8_t		revision;
	uint8_t		engineering;
#endif
	uint32_t	flags;
#define	FW_VERSION_OPTIMIZED			(0x1 << 0)
#define	FW_VERSION_OPTIMIZED_SHIFT		0
#define	FW_VERSION_BIG_ENDIEN			(0x1 << 1)
#define	FW_VERSION_BIG_ENDIEN_SHIFT		1
#define	FW_VERSION_CHIP_VERSION			(0x3 << 2)
#define	FW_VERSION_CHIP_VERSION_SHIFT		2
#define	__FW_VERSION_RESERVED			(0xFFFFFFF << 4)
#define	__FW_VERSION_RESERVED_SHIFT		4
};

/*
 * FW version stored in first line of pram.
 */
struct pram_fw_version {
	uint8_t		major;
	uint8_t		minor;
	uint8_t		revision;
	uint8_t		engineering;
	uint8_t		flags;
#define	PRAM_FW_VERSION_OPTIMIZED		(0x1 << 0)
#define	PRAM_FW_VERSION_OPTIMIZED_SHIFT		0
#define	PRAM_FW_VERSION_STORM_ID		(0x3 << 1)
#define	PRAM_FW_VERSION_STORM_ID_SHIFT		1
#define	PRAM_FW_VERSION_BIG_ENDIEN		(0x1 << 3)
#define	PRAM_FW_VERSION_BIG_ENDIEN_SHIFT	3
#define	PRAM_FW_VERSION_CHIP_VERSION		(0x3 << 4)
#define	PRAM_FW_VERSION_CHIP_VERSION_SHIFT	4
#define	__PRAM_FW_VERSION_RESERVED0		(0x3 << 6)
#define	__PRAM_FW_VERSION_RESERVED0_SHIFT	6
};

/*
 * The send queue element.
 */
struct protocol_common_spe {
	struct spe_hdr	hdr;
	struct regpair	phy_address;
};

/*
 * A single rate shaping counter. can be used as protocol or vnic counter.
 */
struct rate_shaping_counter {
	uint32_t	quota;
#if defined(__BIG_ENDIAN)
	uint16_t	__reserved0;
	uint16_t	rate;
#elif defined(__LITTLE_ENDIAN)
	uint16_t	rate;
	uint16_t	__reserved0;
#endif
};

/*
 * Per-vnic rate shaping variables.
 */
struct rate_shaping_vars_per_vn {
	struct rate_shaping_counter	protocol_counters[NUM_OF_PROTOCOLS];
	struct rate_shaping_counter	vn_counter;
};

/*
 * The send queue element.
 */
struct slow_path_element {
	struct spe_hdr	hdr;
	uint8_t		protocol_data[8];
};

/*
 * eth/toe flags that indicate if to query.
 */
struct stats_indication_flags {
	uint32_t	collect_eth;
	uint32_t	collect_toe;
};