Fix common misspellings

[mirror_ubuntu-zesty-kernel.git] / drivers / net / bnx2x / bnx2x_hsi.h

/* bnx2x_hsi.h: Broadcom Everest network driver.
 *
 * Copyright (c) 2007-2010 Broadcom Corporation
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation.
 */
#ifndef BNX2X_HSI_H
#define BNX2X_HSI_H

#include "bnx2x_fw_defs.h"

#define FW_ENCODE_32BIT_PATTERN         0x1e1e1e1e

struct license_key {
        u32 reserved[6];

        u32 max_iscsi_conn;
#define BNX2X_MAX_ISCSI_TRGT_CONN_MASK  0xFFFF
#define BNX2X_MAX_ISCSI_TRGT_CONN_SHIFT 0
#define BNX2X_MAX_ISCSI_INIT_CONN_MASK  0xFFFF0000
#define BNX2X_MAX_ISCSI_INIT_CONN_SHIFT 16

        u32 reserved_a;

        u32 max_fcoe_conn;
#define BNX2X_MAX_FCOE_TRGT_CONN_MASK   0xFFFF
#define BNX2X_MAX_FCOE_TRGT_CONN_SHIFT  0
#define BNX2X_MAX_FCOE_INIT_CONN_MASK   0xFFFF0000
#define BNX2X_MAX_FCOE_INIT_CONN_SHIFT  16

        u32 reserved_b[4];
};

#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 */
        u8  part_num[16];                                       /* 0x104 */

        u32 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_LED_EXTPHY1                   0x000e0000


#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

        u32 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

        /*  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

        /* Set the MDC/MDIO access for the first external phy */
#define SHARED_HW_CFG_MDC_MDIO_ACCESS1_MASK         0x1C000000
#define SHARED_HW_CFG_MDC_MDIO_ACCESS1_SHIFT        26
#define SHARED_HW_CFG_MDC_MDIO_ACCESS1_PHY_TYPE     0x00000000
#define SHARED_HW_CFG_MDC_MDIO_ACCESS1_EMAC0        0x04000000
#define SHARED_HW_CFG_MDC_MDIO_ACCESS1_EMAC1        0x08000000
#define SHARED_HW_CFG_MDC_MDIO_ACCESS1_BOTH         0x0c000000
#define SHARED_HW_CFG_MDC_MDIO_ACCESS1_SWAPPED      0x10000000

        /* Set the MDC/MDIO access for the second external phy */
#define SHARED_HW_CFG_MDC_MDIO_ACCESS2_MASK         0xE0000000
#define SHARED_HW_CFG_MDC_MDIO_ACCESS2_SHIFT        29
#define SHARED_HW_CFG_MDC_MDIO_ACCESS2_PHY_TYPE     0x00000000
#define SHARED_HW_CFG_MDC_MDIO_ACCESS2_EMAC0        0x20000000
#define SHARED_HW_CFG_MDC_MDIO_ACCESS2_EMAC1        0x40000000
#define SHARED_HW_CFG_MDC_MDIO_ACCESS2_BOTH         0x60000000
#define SHARED_HW_CFG_MDC_MDIO_ACCESS2_SWAPPED      0x80000000
        u32 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

        u32 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

        u32 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

        u32 reserved;                                           /* 0x128 */

};


/****************************************************************************
 * Port HW configuration                                                    *
 ****************************************************************************/
struct port_hw_cfg {                        /* port 0: 0x12c  port 1: 0x2bc */

        u32 pci_id;
#define PORT_HW_CFG_PCI_VENDOR_ID_MASK              0xffff0000
#define PORT_HW_CFG_PCI_DEVICE_ID_MASK              0x0000ffff

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

        u32 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

        u32 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

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

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

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

        u32 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


        u32 Reserved0[3];                                   /* 0x158 */
        /*      Controls the TX laser of the SFP+ module */
        u32 sfp_ctrl;                                   /* 0x164 */
#define PORT_HW_CFG_TX_LASER_MASK                             0x000000FF
#define PORT_HW_CFG_TX_LASER_SHIFT                            0
#define PORT_HW_CFG_TX_LASER_MDIO                             0x00000000
#define PORT_HW_CFG_TX_LASER_GPIO0                            0x00000001
#define PORT_HW_CFG_TX_LASER_GPIO1                            0x00000002
#define PORT_HW_CFG_TX_LASER_GPIO2                            0x00000003
#define PORT_HW_CFG_TX_LASER_GPIO3                            0x00000004

    /*  Controls the fault module LED of the SFP+ */
#define PORT_HW_CFG_FAULT_MODULE_LED_MASK                     0x0000FF00
#define PORT_HW_CFG_FAULT_MODULE_LED_SHIFT                    8
#define PORT_HW_CFG_FAULT_MODULE_LED_GPIO0                    0x00000000
#define PORT_HW_CFG_FAULT_MODULE_LED_GPIO1                    0x00000100
#define PORT_HW_CFG_FAULT_MODULE_LED_GPIO2                    0x00000200
#define PORT_HW_CFG_FAULT_MODULE_LED_GPIO3                    0x00000300
#define PORT_HW_CFG_FAULT_MODULE_LED_DISABLED                 0x00000400
        u32 Reserved01[12];                                 /* 0x158 */
        /*  for external PHY, or forced mode or during AN */
        u16 xgxs_config_rx[4];                              /* 0x198 */

        u16 xgxs_config_tx[4];                              /* 0x1A0 */

        u32 Reserved1[56];                                  /* 0x1A8 */
        u32 default_cfg;                                    /* 0x288 */
#define PORT_HW_CFG_GPIO0_CONFIG_MASK                         0x00000003
#define PORT_HW_CFG_GPIO0_CONFIG_SHIFT                        0
#define PORT_HW_CFG_GPIO0_CONFIG_NA                           0x00000000
#define PORT_HW_CFG_GPIO0_CONFIG_LOW                          0x00000001
#define PORT_HW_CFG_GPIO0_CONFIG_HIGH                         0x00000002
#define PORT_HW_CFG_GPIO0_CONFIG_INPUT                        0x00000003

#define PORT_HW_CFG_GPIO1_CONFIG_MASK                         0x0000000C
#define PORT_HW_CFG_GPIO1_CONFIG_SHIFT                        2
#define PORT_HW_CFG_GPIO1_CONFIG_NA                           0x00000000
#define PORT_HW_CFG_GPIO1_CONFIG_LOW                          0x00000004
#define PORT_HW_CFG_GPIO1_CONFIG_HIGH                         0x00000008
#define PORT_HW_CFG_GPIO1_CONFIG_INPUT                        0x0000000c

#define PORT_HW_CFG_GPIO2_CONFIG_MASK                         0x00000030
#define PORT_HW_CFG_GPIO2_CONFIG_SHIFT                        4
#define PORT_HW_CFG_GPIO2_CONFIG_NA                           0x00000000
#define PORT_HW_CFG_GPIO2_CONFIG_LOW                          0x00000010
#define PORT_HW_CFG_GPIO2_CONFIG_HIGH                         0x00000020
#define PORT_HW_CFG_GPIO2_CONFIG_INPUT                        0x00000030

#define PORT_HW_CFG_GPIO3_CONFIG_MASK                         0x000000C0
#define PORT_HW_CFG_GPIO3_CONFIG_SHIFT                        6
#define PORT_HW_CFG_GPIO3_CONFIG_NA                           0x00000000
#define PORT_HW_CFG_GPIO3_CONFIG_LOW                          0x00000040
#define PORT_HW_CFG_GPIO3_CONFIG_HIGH                         0x00000080
#define PORT_HW_CFG_GPIO3_CONFIG_INPUT                        0x000000c0

        /*
         * When KR link is required to be set to force which is not
         * KR-compliant, this parameter determine what is the trigger for it.
         * When GPIO is selected, low input will force the speed. Currently
         * default speed is 1G. In the future, it may be widen to select the
         * forced speed in with another parameter. Note when force-1G is
         * enabled, it override option 56: Link Speed option.
         */
#define PORT_HW_CFG_FORCE_KR_ENABLER_MASK                     0x00000F00
#define PORT_HW_CFG_FORCE_KR_ENABLER_SHIFT                    8
#define PORT_HW_CFG_FORCE_KR_ENABLER_NOT_FORCED               0x00000000
#define PORT_HW_CFG_FORCE_KR_ENABLER_GPIO0_P0                 0x00000100
#define PORT_HW_CFG_FORCE_KR_ENABLER_GPIO1_P0                 0x00000200
#define PORT_HW_CFG_FORCE_KR_ENABLER_GPIO2_P0                 0x00000300
#define PORT_HW_CFG_FORCE_KR_ENABLER_GPIO3_P0                 0x00000400
#define PORT_HW_CFG_FORCE_KR_ENABLER_GPIO0_P1                 0x00000500
#define PORT_HW_CFG_FORCE_KR_ENABLER_GPIO1_P1                 0x00000600
#define PORT_HW_CFG_FORCE_KR_ENABLER_GPIO2_P1                 0x00000700
#define PORT_HW_CFG_FORCE_KR_ENABLER_GPIO3_P1                 0x00000800
#define PORT_HW_CFG_FORCE_KR_ENABLER_FORCED                   0x00000900
    /*  Enable to determine with which GPIO to reset the external phy */
#define PORT_HW_CFG_EXT_PHY_GPIO_RST_MASK                     0x000F0000
#define PORT_HW_CFG_EXT_PHY_GPIO_RST_SHIFT                    16
#define PORT_HW_CFG_EXT_PHY_GPIO_RST_PHY_TYPE                 0x00000000
#define PORT_HW_CFG_EXT_PHY_GPIO_RST_GPIO0_P0                 0x00010000
#define PORT_HW_CFG_EXT_PHY_GPIO_RST_GPIO1_P0                 0x00020000
#define PORT_HW_CFG_EXT_PHY_GPIO_RST_GPIO2_P0                 0x00030000
#define PORT_HW_CFG_EXT_PHY_GPIO_RST_GPIO3_P0                 0x00040000
#define PORT_HW_CFG_EXT_PHY_GPIO_RST_GPIO0_P1                 0x00050000
#define PORT_HW_CFG_EXT_PHY_GPIO_RST_GPIO1_P1                 0x00060000
#define PORT_HW_CFG_EXT_PHY_GPIO_RST_GPIO2_P1                 0x00070000
#define PORT_HW_CFG_EXT_PHY_GPIO_RST_GPIO3_P1                 0x00080000
        /*  Enable BAM on KR */
#define PORT_HW_CFG_ENABLE_BAM_ON_KR_MASK                     0x00100000
#define PORT_HW_CFG_ENABLE_BAM_ON_KR_SHIFT                    20
#define PORT_HW_CFG_ENABLE_BAM_ON_KR_DISABLED                 0x00000000
#define PORT_HW_CFG_ENABLE_BAM_ON_KR_ENABLED                  0x00100000

        /*  Enable Common Mode Sense */
#define PORT_HW_CFG_ENABLE_CMS_MASK                           0x00200000
#define PORT_HW_CFG_ENABLE_CMS_SHIFT                          21
#define PORT_HW_CFG_ENABLE_CMS_DISABLED                       0x00000000
#define PORT_HW_CFG_ENABLE_CMS_ENABLED                        0x00200000

        u32 speed_capability_mask2;                         /* 0x28C */
#define PORT_HW_CFG_SPEED_CAPABILITY2_D3_MASK                 0x0000FFFF
#define PORT_HW_CFG_SPEED_CAPABILITY2_D3_SHIFT                0
#define PORT_HW_CFG_SPEED_CAPABILITY2_D3_10M_FULL             0x00000001
#define PORT_HW_CFG_SPEED_CAPABILITY2_D3__                    0x00000002
#define PORT_HW_CFG_SPEED_CAPABILITY2_D3___                   0x00000004
#define PORT_HW_CFG_SPEED_CAPABILITY2_D3_100M_FULL            0x00000008
#define PORT_HW_CFG_SPEED_CAPABILITY2_D3_1G                   0x00000010
#define PORT_HW_CFG_SPEED_CAPABILITY2_D3_2_DOT_5G             0x00000020
#define PORT_HW_CFG_SPEED_CAPABILITY2_D3_10G                  0x00000040
#define PORT_HW_CFG_SPEED_CAPABILITY2_D3_12G                  0x00000080
#define PORT_HW_CFG_SPEED_CAPABILITY2_D3_12_DOT_5G            0x00000100
#define PORT_HW_CFG_SPEED_CAPABILITY2_D3_13G                  0x00000200
#define PORT_HW_CFG_SPEED_CAPABILITY2_D3_15G                  0x00000400
#define PORT_HW_CFG_SPEED_CAPABILITY2_D3_16G                  0x00000800

#define PORT_HW_CFG_SPEED_CAPABILITY2_D0_MASK                 0xFFFF0000
#define PORT_HW_CFG_SPEED_CAPABILITY2_D0_SHIFT                16
#define PORT_HW_CFG_SPEED_CAPABILITY2_D0_10M_FULL             0x00010000
#define PORT_HW_CFG_SPEED_CAPABILITY2_D0__                    0x00020000
#define PORT_HW_CFG_SPEED_CAPABILITY2_D0___                   0x00040000
#define PORT_HW_CFG_SPEED_CAPABILITY2_D0_100M_FULL            0x00080000
#define PORT_HW_CFG_SPEED_CAPABILITY2_D0_1G                   0x00100000
#define PORT_HW_CFG_SPEED_CAPABILITY2_D0_2_DOT_5G             0x00200000
#define PORT_HW_CFG_SPEED_CAPABILITY2_D0_10G                  0x00400000
#define PORT_HW_CFG_SPEED_CAPABILITY2_D0_12G                  0x00800000
#define PORT_HW_CFG_SPEED_CAPABILITY2_D0_12_DOT_5G            0x01000000
#define PORT_HW_CFG_SPEED_CAPABILITY2_D0_13G                  0x02000000
#define PORT_HW_CFG_SPEED_CAPABILITY2_D0_15G                  0x04000000
#define PORT_HW_CFG_SPEED_CAPABILITY2_D0_16G                  0x08000000

        /* In the case where two media types (e.g. copper and fiber) are
          present and electrically active at the same time, PHY Selection
          will determine which of the two PHYs will be designated as the
          Active PHY and used for a connection to the network.  */
        u32 multi_phy_config;                           /* 0x290 */
#define PORT_HW_CFG_PHY_SELECTION_MASK               0x00000007
#define PORT_HW_CFG_PHY_SELECTION_SHIFT              0
#define PORT_HW_CFG_PHY_SELECTION_HARDWARE_DEFAULT   0x00000000
#define PORT_HW_CFG_PHY_SELECTION_FIRST_PHY          0x00000001
#define PORT_HW_CFG_PHY_SELECTION_SECOND_PHY         0x00000002
#define PORT_HW_CFG_PHY_SELECTION_FIRST_PHY_PRIORITY 0x00000003
#define PORT_HW_CFG_PHY_SELECTION_SECOND_PHY_PRIORITY 0x00000004

        /* When enabled, all second phy nvram parameters will be swapped
          with the first phy parameters */
#define PORT_HW_CFG_PHY_SWAPPED_MASK                 0x00000008
#define PORT_HW_CFG_PHY_SWAPPED_SHIFT                3
#define PORT_HW_CFG_PHY_SWAPPED_DISABLED             0x00000000
#define PORT_HW_CFG_PHY_SWAPPED_ENABLED              0x00000008


        /* Address of the second external phy */
        u32 external_phy_config2;                               /* 0x294 */
#define PORT_HW_CFG_XGXS_EXT_PHY2_ADDR_MASK         0x000000FF
#define PORT_HW_CFG_XGXS_EXT_PHY2_ADDR_SHIFT        0

        /* The second XGXS external PHY type */
#define PORT_HW_CFG_XGXS_EXT_PHY2_TYPE_MASK         0x0000FF00
#define PORT_HW_CFG_XGXS_EXT_PHY2_TYPE_SHIFT        8
#define PORT_HW_CFG_XGXS_EXT_PHY2_TYPE_DIRECT       0x00000000
#define PORT_HW_CFG_XGXS_EXT_PHY2_TYPE_BCM8071      0x00000100
#define PORT_HW_CFG_XGXS_EXT_PHY2_TYPE_BCM8072      0x00000200
#define PORT_HW_CFG_XGXS_EXT_PHY2_TYPE_BCM8073      0x00000300
#define PORT_HW_CFG_XGXS_EXT_PHY2_TYPE_BCM8705      0x00000400
#define PORT_HW_CFG_XGXS_EXT_PHY2_TYPE_BCM8706      0x00000500
#define PORT_HW_CFG_XGXS_EXT_PHY2_TYPE_BCM8726      0x00000600
#define PORT_HW_CFG_XGXS_EXT_PHY2_TYPE_BCM8481      0x00000700
#define PORT_HW_CFG_XGXS_EXT_PHY2_TYPE_SFX7101      0x00000800
#define PORT_HW_CFG_XGXS_EXT_PHY2_TYPE_BCM8727      0x00000900
#define PORT_HW_CFG_XGXS_EXT_PHY2_TYPE_BCM8727_NOC  0x00000a00
#define PORT_HW_CFG_XGXS_EXT_PHY2_TYPE_BCM84823     0x00000b00
#define PORT_HW_CFG_XGXS_EXT_PHY2_TYPE_BCM54640     0x00000c00
#define PORT_HW_CFG_XGXS_EXT_PHY2_TYPE_BCM84833     0x00000d00
#define PORT_HW_CFG_XGXS_EXT_PHY2_TYPE_FAILURE      0x0000fd00
#define PORT_HW_CFG_XGXS_EXT_PHY2_TYPE_NOT_CONN     0x0000ff00

        /* 4 times 16 bits for all 4 lanes. For some external PHYs (such as
          8706, 8726 and 8727) not all 4 values are needed. */
        u16 xgxs_config2_rx[4];                         /* 0x296 */
        u16 xgxs_config2_tx[4];                         /* 0x2A0 */

        u32 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
    /*  Indicate whether to swap the external phy polarity */
#define PORT_HW_CFG_SWAP_PHY_POLARITY_MASK             0x00010000
#define PORT_HW_CFG_SWAP_PHY_POLARITY_DISABLED      0x00000000
#define PORT_HW_CFG_SWAP_PHY_POLARITY_ENABLED       0x00010000

        u32 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_BCM84833      0x00000d00
#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

        u32 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

        u32 reserved[2];

};


/****************************************************************************
 * Shared Feature configuration                                             *
 ****************************************************************************/
struct shared_feat_cfg {                                 /* NVRAM Offset */

        u32 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_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
#define SHARED_FEAT_CFG_FORCE_SF_MODE_SWITCH_INDEPT           0x00000300

};


/****************************************************************************
 * Port Feature configuration                                               *
 ****************************************************************************/
struct port_feat_cfg {                      /* port 0: 0x454  port 1: 0x4c8 */

        u32 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

        /* 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


        u32 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

        u32 mba_config;
#define PORT_FEATURE_MBA_BOOT_AGENT_TYPE_MASK       0x00000003
#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_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

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

        u32 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

        u32 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

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

        u32 reserved1;

        u32 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 */
        u32 mfw_wol_link_cfg;
        /* The default for the driver of the second external phy,
        uses the same defines as link_config */
        u32 link_config2;                                       /* 0x47C */

        /* The default for MCP of the second external phy,
        uses the same defines as link_config */
        u32 mfw_wol_link_cfg2;                          /* 0x480 */

        u32 Reserved2[17];                                      /* 0x484 */

};


/****************************************************************************
 * Device Information                                                       *
 ****************************************************************************/
struct shm_dev_info {                                               /* size */

        u32    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 E2_FUNC_MAX         4   /* per path */

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

#define E2_VF_MAX                       64
/* 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 {

        u32 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

        u32 port_stx;

        u32 stat_nig_timer;

        /* MCP firmware does not use this field */
        u32 ext_phy_fw_version;

};


struct drv_func_mb {

        u32 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 require bootcode
         * v5.0.6 or later
         */
#define DRV_MSG_CODE_VRFY_FIRST_PHY_OPT_MDL     0xa0000000
#define REQ_BC_VER_4_VRFY_FIRST_PHY_OPT_MDL     0x00050006
        /*
         * The specific optic module verification command requires bootcode
         * v5.2.12 or later
         */
#define DRV_MSG_CODE_VRFY_SPECIFIC_PHY_OPT_MDL      0xa1000000
#define REQ_BC_VER_4_VRFY_SPECIFIC_PHY_OPT_MDL      0x00050234

#define DRV_MSG_CODE_DCBX_ADMIN_PMF_MSG                 0xb0000000
#define DRV_MSG_CODE_DCBX_PMF_DRV_OK                    0xb2000000
#define DRV_MSG_CODE_SET_MF_BW                          0xe0000000
#define REQ_BC_VER_4_SET_MF_BW                          0x00060202
#define DRV_MSG_CODE_SET_MF_BW_ACK                      0xe1000000
#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

        u32 drv_mb_param;

        u32 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
        /* Load common chip is supported from bc 6.0.0  */
#define REQ_BC_VER_4_DRV_LOAD_COMMON_CHIP       0x00060000
#define FW_MSG_CODE_DRV_LOAD_COMMON_CHIP        0x10130000
#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

        u32 fw_mb_param;

        u32 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). */

        u32 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

        u32 iscsi_boot_signature;
        u32 iscsi_boot_block_offset;

        u32 drv_status;
#define DRV_STATUS_PMF                                  0x00000001
#define DRV_STATUS_SET_MF_BW                            0x00000004

#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
#define DRV_STATUS_DCBX_EVENT_MASK                      0x000f0000
#define DRV_STATUS_DCBX_NEGOTIATION_RESULTS             0x00010000

        u32 virt_mac_upper;
#define VIRT_MAC_SIGN_MASK                              0xffff0000
#define VIRT_MAC_SIGNATURE                              0x564d0000
        u32 virt_mac_lower;

};


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

struct mgmtfw_state {
        u32 opaque[MGMTFW_STATE_WORD_SIZE];
};


/****************************************************************************
 * Multi-Function configuration                                             *
 ****************************************************************************/
struct shared_mf_cfg {

        u32 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 {

        u32 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

        u32 reserved[3];

};

struct func_mf_cfg {

        u32 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

        u32 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
        u32 mac_lower;
#define FUNC_MF_CFG_LOWERMAC_DEFAULT                0xffffffff

        u32 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

        u32 reserved[2];

};

/* This structure is not applicable and should not be accessed on 57711 */
struct func_ext_cfg {
        u32 func_cfg;
#define MACP_FUNC_CFG_FLAGS_MASK                              0x000000FF
#define MACP_FUNC_CFG_FLAGS_SHIFT                             0
#define MACP_FUNC_CFG_FLAGS_ENABLED                           0x00000001
#define MACP_FUNC_CFG_FLAGS_ETHERNET                          0x00000002
#define MACP_FUNC_CFG_FLAGS_ISCSI_OFFLOAD                     0x00000004
#define MACP_FUNC_CFG_FLAGS_FCOE_OFFLOAD                      0x00000008

        u32 iscsi_mac_addr_upper;
        u32 iscsi_mac_addr_lower;

        u32 fcoe_mac_addr_upper;
        u32 fcoe_mac_addr_lower;

        u32 fcoe_wwn_port_name_upper;
        u32 fcoe_wwn_port_name_lower;

        u32 fcoe_wwn_node_name_upper;
        u32 fcoe_wwn_node_name_lower;

        u32 preserve_data;
#define MF_FUNC_CFG_PRESERVE_L2_MAC                          (1<<0)
#define MF_FUNC_CFG_PRESERVE_ISCSI_MAC                       (1<<1)
#define MF_FUNC_CFG_PRESERVE_FCOE_MAC                        (1<<2)
#define MF_FUNC_CFG_PRESERVE_FCOE_WWN_P                      (1<<3)
#define MF_FUNC_CFG_PRESERVE_FCOE_WWN_N                      (1<<4)
};

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];

        struct func_ext_cfg func_ext_config[E1H_FUNC_MAX];
};


/****************************************************************************
 * Shared Memory Region                                                     *
 ****************************************************************************/
struct shmem_region {                          /*   SharedMem Offset (size) */

        u32                     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) */
        u32                     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) */
        struct drv_func_mb      func_mb[];             /* 0x684
                                             (44*2/4/8=0x58/0xb0/0x160) */

}; /* 57710 = 0x6dc | 57711 = 0x7E4 | 57712 = 0x734 */

struct fw_flr_ack {
        u32     pf_ack;
        u32     vf_ack[1];
        u32     iov_dis_ack;
};

struct fw_flr_mb {
        u32     aggint;
        u32     opgen_addr;
        struct  fw_flr_ack ack;
};

/**** SUPPORT FOR SHMEM ARRRAYS ***
 * The SHMEM HSI is aligned on 32 bit boundaries which makes it difficult to
 * define arrays with storage types smaller then unsigned dwords.
 * The macros below add generic support for SHMEM arrays with numeric elements
 * that can span 2,4,8 or 16 bits. The array underlying type is a 32 bit dword
 * array with individual bit-filed elements accessed using shifts and masks.
 *
 */

/* eb is the bitwidth of a single element */
#define SHMEM_ARRAY_MASK(eb)            ((1<<(eb))-1)
#define SHMEM_ARRAY_ENTRY(i, eb)        ((i)/(32/(eb)))

/* the bit-position macro allows the used to flip the order of the arrays
 * elements on a per byte or word boundary.
 *
 * example: an array with 8 entries each 4 bit wide. This array will fit into
 * a single dword. The diagrmas below show the array order of the nibbles.
 *
 * SHMEM_ARRAY_BITPOS(i, 4, 4) defines the stadard ordering:
 *
 *              |               |               |               |
 *   0  |   1   |   2   |   3   |   4   |   5   |   6   |   7   |
 *              |               |               |               |
 *
 * SHMEM_ARRAY_BITPOS(i, 4, 8) defines a flip ordering per byte:
 *
 *              |               |               |               |
 *   1  |   0   |   3   |   2   |   5   |   4   |   7   |   6   |
 *              |               |               |               |
 *
 * SHMEM_ARRAY_BITPOS(i, 4, 16) defines a flip ordering per word:
 *
 *              |               |               |               |
 *   3  |   2   |   1   |   0   |   7   |   6   |   5   |   4   |
 *              |               |               |               |
 */
#define SHMEM_ARRAY_BITPOS(i, eb, fb)   \
        ((((32/(fb)) - 1 - ((i)/((fb)/(eb))) % (32/(fb))) * (fb)) + \
        (((i)%((fb)/(eb))) * (eb)))

#define SHMEM_ARRAY_GET(a, i, eb, fb)                                      \
        ((a[SHMEM_ARRAY_ENTRY(i, eb)] >> SHMEM_ARRAY_BITPOS(i, eb, fb)) &  \
        SHMEM_ARRAY_MASK(eb))

#define SHMEM_ARRAY_SET(a, i, eb, fb, val)                                 \
do {                                                                       \
        a[SHMEM_ARRAY_ENTRY(i, eb)] &= ~(SHMEM_ARRAY_MASK(eb) <<           \
        SHMEM_ARRAY_BITPOS(i, eb, fb));                            \
        a[SHMEM_ARRAY_ENTRY(i, eb)] |= (((val) & SHMEM_ARRAY_MASK(eb)) <<  \
        SHMEM_ARRAY_BITPOS(i, eb, fb));                            \
} while (0)


/****START OF DCBX STRUCTURES DECLARATIONS****/
#define DCBX_MAX_NUM_PRI_PG_ENTRIES     8
#define DCBX_PRI_PG_BITWIDTH            4
#define DCBX_PRI_PG_FBITS               8
#define DCBX_PRI_PG_GET(a, i)           \
        SHMEM_ARRAY_GET(a, i, DCBX_PRI_PG_BITWIDTH, DCBX_PRI_PG_FBITS)
#define DCBX_PRI_PG_SET(a, i, val)      \
        SHMEM_ARRAY_SET(a, i, DCBX_PRI_PG_BITWIDTH, DCBX_PRI_PG_FBITS, val)
#define DCBX_MAX_NUM_PG_BW_ENTRIES      8
#define DCBX_BW_PG_BITWIDTH             8
#define DCBX_PG_BW_GET(a, i)            \
        SHMEM_ARRAY_GET(a, i, DCBX_BW_PG_BITWIDTH, DCBX_BW_PG_BITWIDTH)
#define DCBX_PG_BW_SET(a, i, val)       \
        SHMEM_ARRAY_SET(a, i, DCBX_BW_PG_BITWIDTH, DCBX_BW_PG_BITWIDTH, val)
#define DCBX_STRICT_PRI_PG              15
#define DCBX_MAX_APP_PROTOCOL           16
#define FCOE_APP_IDX                    0
#define ISCSI_APP_IDX                   1
#define PREDEFINED_APP_IDX_MAX          2

struct dcbx_ets_feature {
        u32 enabled;
        u32  pg_bw_tbl[2];
        u32  pri_pg_tbl[1];
};

struct dcbx_pfc_feature {
#ifdef __BIG_ENDIAN
        u8 pri_en_bitmap;
#define DCBX_PFC_PRI_0 0x01
#define DCBX_PFC_PRI_1 0x02
#define DCBX_PFC_PRI_2 0x04
#define DCBX_PFC_PRI_3 0x08
#define DCBX_PFC_PRI_4 0x10
#define DCBX_PFC_PRI_5 0x20
#define DCBX_PFC_PRI_6 0x40
#define DCBX_PFC_PRI_7 0x80
        u8 pfc_caps;
        u8 reserved;
        u8 enabled;
#elif defined(__LITTLE_ENDIAN)
        u8 enabled;
        u8 reserved;
        u8 pfc_caps;
        u8 pri_en_bitmap;
#define DCBX_PFC_PRI_0 0x01
#define DCBX_PFC_PRI_1 0x02
#define DCBX_PFC_PRI_2 0x04
#define DCBX_PFC_PRI_3 0x08
#define DCBX_PFC_PRI_4 0x10
#define DCBX_PFC_PRI_5 0x20
#define DCBX_PFC_PRI_6 0x40
#define DCBX_PFC_PRI_7 0x80
#endif
};

struct dcbx_app_priority_entry {
#ifdef __BIG_ENDIAN
        u16     app_id;
        u8      pri_bitmap;
        u8      appBitfield;
#define DCBX_APP_ENTRY_VALID         0x01
#define DCBX_APP_ENTRY_SF_MASK       0x30
#define DCBX_APP_ENTRY_SF_SHIFT      4
#define DCBX_APP_SF_ETH_TYPE         0x10
#define DCBX_APP_SF_PORT             0x20
#elif defined(__LITTLE_ENDIAN)
        u8 appBitfield;
#define DCBX_APP_ENTRY_VALID         0x01
#define DCBX_APP_ENTRY_SF_MASK       0x30
#define DCBX_APP_ENTRY_SF_SHIFT      4
#define DCBX_APP_SF_ETH_TYPE         0x10
#define DCBX_APP_SF_PORT             0x20
        u8      pri_bitmap;
        u16     app_id;
#endif
};

struct dcbx_app_priority_feature {
#ifdef __BIG_ENDIAN
        u8 reserved;
        u8 default_pri;
        u8 tc_supported;
        u8 enabled;
#elif defined(__LITTLE_ENDIAN)
        u8 enabled;
        u8 tc_supported;
        u8 default_pri;
        u8 reserved;
#endif
        struct dcbx_app_priority_entry  app_pri_tbl[DCBX_MAX_APP_PROTOCOL];
};

struct dcbx_features {
        struct dcbx_ets_feature ets;
        struct dcbx_pfc_feature pfc;
        struct dcbx_app_priority_feature app;
};

struct lldp_params {
#ifdef __BIG_ENDIAN
        u8      msg_fast_tx_interval;
        u8      msg_tx_hold;
        u8      msg_tx_interval;
        u8      admin_status;
#define LLDP_TX_ONLY  0x01
#define LLDP_RX_ONLY  0x02
#define LLDP_TX_RX    0x03
#define LLDP_DISABLED 0x04
        u8      reserved1;
        u8      tx_fast;
        u8      tx_crd_max;
        u8      tx_crd;
#elif defined(__LITTLE_ENDIAN)
        u8      admin_status;
#define LLDP_TX_ONLY  0x01
#define LLDP_RX_ONLY  0x02
#define LLDP_TX_RX    0x03
#define LLDP_DISABLED 0x04
        u8      msg_tx_interval;
        u8      msg_tx_hold;
        u8      msg_fast_tx_interval;
        u8      tx_crd;
        u8      tx_crd_max;
        u8      tx_fast;
        u8      reserved1;
#endif
#define REM_CHASSIS_ID_STAT_LEN 4
#define REM_PORT_ID_STAT_LEN 4
        u32 peer_chassis_id[REM_CHASSIS_ID_STAT_LEN];
        u32 peer_port_id[REM_PORT_ID_STAT_LEN];
};

struct lldp_dcbx_stat {
#define LOCAL_CHASSIS_ID_STAT_LEN 2
#define LOCAL_PORT_ID_STAT_LEN 2
        u32 local_chassis_id[LOCAL_CHASSIS_ID_STAT_LEN];
        u32 local_port_id[LOCAL_PORT_ID_STAT_LEN];
        u32 num_tx_dcbx_pkts;
        u32 num_rx_dcbx_pkts;
};

struct lldp_admin_mib {
        u32     ver_cfg_flags;
#define DCBX_ETS_CONFIG_TX_ENABLED      0x00000001
#define DCBX_PFC_CONFIG_TX_ENABLED      0x00000002
#define DCBX_APP_CONFIG_TX_ENABLED      0x00000004
#define DCBX_ETS_RECO_TX_ENABLED        0x00000008
#define DCBX_ETS_RECO_VALID             0x00000010
#define DCBX_ETS_WILLING                0x00000020
#define DCBX_PFC_WILLING                0x00000040
#define DCBX_APP_WILLING                0x00000080
#define DCBX_VERSION_CEE                0x00000100
#define DCBX_VERSION_IEEE               0x00000200
#define DCBX_DCBX_ENABLED               0x00000400
#define DCBX_CEE_VERSION_MASK           0x0000f000
#define DCBX_CEE_VERSION_SHIFT          12
#define DCBX_CEE_MAX_VERSION_MASK       0x000f0000
#define DCBX_CEE_MAX_VERSION_SHIFT      16
        struct dcbx_features    features;
};

struct lldp_remote_mib {
        u32 prefix_seq_num;
        u32 flags;
#define DCBX_ETS_TLV_RX     0x00000001
#define DCBX_PFC_TLV_RX     0x00000002
#define DCBX_APP_TLV_RX     0x00000004
#define DCBX_ETS_RX_ERROR   0x00000010
#define DCBX_PFC_RX_ERROR   0x00000020
#define DCBX_APP_RX_ERROR   0x00000040
#define DCBX_ETS_REM_WILLING    0x00000100
#define DCBX_PFC_REM_WILLING    0x00000200
#define DCBX_APP_REM_WILLING    0x00000400
#define DCBX_REMOTE_ETS_RECO_VALID  0x00001000
        struct dcbx_features features;
        u32 suffix_seq_num;
};

struct lldp_local_mib {
        u32 prefix_seq_num;
        u32 error;
#define DCBX_LOCAL_ETS_ERROR     0x00000001
#define DCBX_LOCAL_PFC_ERROR     0x00000002
#define DCBX_LOCAL_APP_ERROR     0x00000004
#define DCBX_LOCAL_PFC_MISMATCH  0x00000010
#define DCBX_LOCAL_APP_MISMATCH  0x00000020
        struct dcbx_features   features;
        u32 suffix_seq_num;
};
/***END OF DCBX STRUCTURES DECLARATIONS***/

struct shmem2_region {

        u32                     size;

        u32                     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
        u32 ext_phy_fw_version2[PORT_MAX];
        /*
         * For backwards compatibility, if the mf_cfg_addr does not exist
         * (the size filed is smaller than 0xc) the mf_cfg resides at the
         * end of struct shmem_region
     */
        u32     mf_cfg_addr;
#define SHMEM_MF_CFG_ADDR_NONE                      0x00000000

        struct fw_flr_mb flr_mb;
        u32     dcbx_lldp_params_offset;
#define SHMEM_LLDP_DCBX_PARAMS_NONE                 0x00000000
        u32     dcbx_neg_res_offset;
#define SHMEM_DCBX_NEG_RES_NONE                     0x00000000
        u32     dcbx_remote_mib_offset;
#define SHMEM_DCBX_REMOTE_MIB_NONE                  0x00000000
        /*
         * The other shmemX_base_addr holds the other path's shmem address
         * required for example in case of common phy init, or for path1 to know
         * the address of mcp debug trace which is located in offset from shmem
         * of path0
         */
        u32 other_shmem_base_addr;
        u32 other_shmem2_base_addr;
        u32     reserved1[E2_VF_MAX / 32];
        u32     reserved2[E2_FUNC_MAX][E2_VF_MAX / 32];
        u32     dcbx_lldp_dcbx_stat_offset;
#define SHMEM_LLDP_DCBX_STAT_NONE                  0x00000000
};


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

    u32     rx_stat_falsecarriererrors;

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


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

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

struct bmac2_stats {
        u32     tx_stat_gtpk_lo; /* gtpok */
        u32     tx_stat_gtpk_hi; /* gtpok */
        u32     tx_stat_gtxpf_lo; /* gtpf */
        u32     tx_stat_gtxpf_hi; /* gtpf */
        u32     tx_stat_gtpp_lo; /* NEW BMAC2 */
        u32     tx_stat_gtpp_hi; /* NEW BMAC2 */
        u32     tx_stat_gtfcs_lo;
        u32     tx_stat_gtfcs_hi;
        u32     tx_stat_gtuca_lo; /* NEW BMAC2 */
        u32     tx_stat_gtuca_hi; /* NEW BMAC2 */
        u32     tx_stat_gtmca_lo;
        u32     tx_stat_gtmca_hi;
        u32     tx_stat_gtbca_lo;
        u32     tx_stat_gtbca_hi;
        u32     tx_stat_gtovr_lo;
        u32     tx_stat_gtovr_hi;
        u32     tx_stat_gtfrg_lo;
        u32     tx_stat_gtfrg_hi;
        u32     tx_stat_gtpkt1_lo; /* gtpkt */
        u32     tx_stat_gtpkt1_hi; /* gtpkt */
        u32     tx_stat_gt64_lo;
        u32     tx_stat_gt64_hi;
        u32     tx_stat_gt127_lo;
        u32     tx_stat_gt127_hi;
        u32     tx_stat_gt255_lo;
        u32     tx_stat_gt255_hi;
        u32     tx_stat_gt511_lo;
        u32     tx_stat_gt511_hi;
        u32     tx_stat_gt1023_lo;
        u32     tx_stat_gt1023_hi;
        u32     tx_stat_gt1518_lo;
        u32     tx_stat_gt1518_hi;
        u32     tx_stat_gt2047_lo;
        u32     tx_stat_gt2047_hi;
        u32     tx_stat_gt4095_lo;
        u32     tx_stat_gt4095_hi;
        u32     tx_stat_gt9216_lo;
        u32     tx_stat_gt9216_hi;
        u32     tx_stat_gt16383_lo;
        u32     tx_stat_gt16383_hi;
        u32     tx_stat_gtmax_lo;
        u32     tx_stat_gtmax_hi;
        u32     tx_stat_gtufl_lo;
        u32     tx_stat_gtufl_hi;
        u32     tx_stat_gterr_lo;
        u32     tx_stat_gterr_hi;
        u32     tx_stat_gtbyt_lo;
        u32     tx_stat_gtbyt_hi;

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

union mac_stats {
        struct emac_stats        emac_stats;
        struct bmac1_stats       bmac1_stats;
        struct bmac2_stats       bmac2_stats;
};


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

    /* out_bad_octets */
    u32     tx_stat_ifhcoutbadoctets_hi;
    u32     tx_stat_ifhcoutbadoctets_lo;

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

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

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

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

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

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

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

    /* internal_mac_transmit_errors */
    u32     tx_stat_dot3statsinternalmactransmiterrors_hi;
    u32     tx_stat_dot3statsinternalmactransmiterrors_lo;

    /* if_out_discards */
    u32     tx_stat_bmac_ufl_hi;
    u32     tx_stat_bmac_ufl_lo;
};


#define MAC_STX_IDX_MAX                     2

struct host_port_stats {
    u32            host_port_stats_start;

    struct mac_stx mac_stx[MAC_STX_IDX_MAX];

    u32            brb_drop_hi;
    u32            brb_drop_lo;

    u32            host_port_stats_end;
};


struct host_func_stats {
    u32     host_func_stats_start;

    u32     total_bytes_received_hi;
    u32     total_bytes_received_lo;

    u32     total_bytes_transmitted_hi;
    u32     total_bytes_transmitted_lo;

    u32     total_unicast_packets_received_hi;
    u32     total_unicast_packets_received_lo;

    u32     total_multicast_packets_received_hi;
    u32     total_multicast_packets_received_lo;

    u32     total_broadcast_packets_received_hi;
    u32     total_broadcast_packets_received_lo;

    u32     total_unicast_packets_transmitted_hi;
    u32     total_unicast_packets_transmitted_lo;

    u32     total_multicast_packets_transmitted_hi;
    u32     total_multicast_packets_transmitted_lo;

    u32     total_broadcast_packets_transmitted_hi;
    u32     total_broadcast_packets_transmitted_lo;

    u32     valid_bytes_received_hi;
    u32     valid_bytes_received_lo;

    u32     host_func_stats_end;
};


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


/*
 * attention bits
 */
struct atten_sp_status_block {
        __le32 attn_bits;
        __le32 attn_bits_ack;
        u8 status_block_id;
        u8 reserved0;
        __le16 attn_bits_index;
        __le32 reserved1;
};


/*
 * common data for all protocols
 */
struct doorbell_hdr {
        u8 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)
        u16 zero_fill2;
        u8 zero_fill1;
        struct doorbell_hdr header;
#elif defined(__LITTLE_ENDIAN)
        struct doorbell_hdr header;
        u8 zero_fill1;
        u16 zero_fill2;
#endif
};


/*
 * doorbell message sent to the chip
 */
struct doorbell_set_prod {
#if defined(__BIG_ENDIAN)
        u16 prod;
        u8 zero_fill1;
        struct doorbell_hdr header;
#elif defined(__LITTLE_ENDIAN)
        struct doorbell_hdr header;
        u8 zero_fill1;
        u16 prod;
#endif
};


/*
 * 3 lines. status block
 */
struct hc_status_block_e1x {
        __le16 index_values[HC_SB_MAX_INDICES_E1X];
        __le16 running_index[HC_SB_MAX_SM];
        u32 rsrv;
};

/*
 * host status block
 */
struct host_hc_status_block_e1x {
        struct hc_status_block_e1x sb;
};


/*
 * 3 lines. status block
 */
struct hc_status_block_e2 {
        __le16 index_values[HC_SB_MAX_INDICES_E2];
        __le16 running_index[HC_SB_MAX_SM];
        u32 reserved;
};

/*
 * host status block
 */
struct host_hc_status_block_e2 {
        struct hc_status_block_e2 sb;
};


/*
 * 5 lines. slow-path status block
 */
struct hc_sp_status_block {
        __le16 index_values[HC_SP_SB_MAX_INDICES];
        __le16 running_index;
        __le16 rsrv;
        u32 rsrv1;
};

/*
 * host status block
 */
struct host_sp_status_block {
        struct atten_sp_status_block atten_status_block;
        struct hc_sp_status_block sp_sb;
};


/*
 * IGU driver acknowledgment register
 */
struct igu_ack_register {
#if defined(__BIG_ENDIAN)
        u16 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
        u16 status_block_index;
#elif defined(__LITTLE_ENDIAN)
        u16 status_block_index;
        u16 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 {
        u32 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
        u32 reserved_2;
};


/*
 * IGU driver acknowledgement register
 */
struct igu_regular {
        u32 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
        u32 reserved_2;
};

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


/*
 * Control register for the IGU command register
 */
struct igu_ctrl_reg {
        u32 ctrl_data;
#define IGU_CTRL_REG_ADDRESS (0xFFF<<0)
#define IGU_CTRL_REG_ADDRESS_SHIFT 0
#define IGU_CTRL_REG_FID (0x7F<<12)
#define IGU_CTRL_REG_FID_SHIFT 12
#define IGU_CTRL_REG_RESERVED (0x1<<19)
#define IGU_CTRL_REG_RESERVED_SHIFT 19
#define IGU_CTRL_REG_TYPE (0x1<<20)
#define IGU_CTRL_REG_TYPE_SHIFT 20
#define IGU_CTRL_REG_UNUSED (0x7FF<<21)
#define IGU_CTRL_REG_UNUSED_SHIFT 21
};


/*
 * Parser parsing flags field
 */
struct parsing_flags {
        __le16 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 {
        __le32 lo;
        __le32 hi;
};


/*
 * dmae command structure
 */
struct dmae_command {
        u32 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_DST_VN (0x3<<17)
#define DMAE_COMMAND_DST_VN_SHIFT 17
#define DMAE_COMMAND_C_FUNC (0x1<<19)
#define DMAE_COMMAND_C_FUNC_SHIFT 19
#define DMAE_COMMAND_ERR_POLICY (0x3<<20)
#define DMAE_COMMAND_ERR_POLICY_SHIFT 20
#define DMAE_COMMAND_RESERVED0 (0x3FF<<22)
#define DMAE_COMMAND_RESERVED0_SHIFT 22
        u32 src_addr_lo;
        u32 src_addr_hi;
        u32 dst_addr_lo;
        u32 dst_addr_hi;
#if defined(__BIG_ENDIAN)
        u16 reserved1;
        u16 len;
#elif defined(__LITTLE_ENDIAN)
        u16 len;
        u16 reserved1;
#endif
        u32 comp_addr_lo;
        u32 comp_addr_hi;
        u32 comp_val;
        u32 crc32;
        u32 crc32_c;
#if defined(__BIG_ENDIAN)
        u16 crc16_c;
        u16 crc16;
#elif defined(__LITTLE_ENDIAN)
        u16 crc16;
        u16 crc16_c;
#endif
#if defined(__BIG_ENDIAN)
        u16 reserved3;
        u16 crc_t10;
#elif defined(__LITTLE_ENDIAN)
        u16 crc_t10;
        u16 reserved3;
#endif
#if defined(__BIG_ENDIAN)
        u16 xsum8;
        u16 xsum16;
#elif defined(__LITTLE_ENDIAN)
        u16 xsum16;
        u16 xsum8;
#endif
};


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


/*
 * SDM operation gen command (generate aggregative interrupt)
 */
struct sdm_op_gen {
        __le32 command;
#define SDM_OP_GEN_COMP_PARAM (0x1F<<0)
#define SDM_OP_GEN_COMP_PARAM_SHIFT 0
#define SDM_OP_GEN_COMP_TYPE (0x7<<5)
#define SDM_OP_GEN_COMP_TYPE_SHIFT 5
#define SDM_OP_GEN_AGG_VECT_IDX (0xFF<<8)
#define SDM_OP_GEN_AGG_VECT_IDX_SHIFT 8
#define SDM_OP_GEN_AGG_VECT_IDX_VALID (0x1<<16)
#define SDM_OP_GEN_AGG_VECT_IDX_VALID_SHIFT 16
#define SDM_OP_GEN_RESERVED (0x7FFF<<17)
#define SDM_OP_GEN_RESERVED_SHIFT 17
};

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

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



/*
 * The eth storm context of Ustorm
 */
struct ustorm_eth_st_context {
        u32 reserved0[48];
};

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

/*
 * The eth aggregative context of Xstorm
 */
struct xstorm_eth_ag_context {
        u32 reserved0;
#if defined(__BIG_ENDIAN)
        u8 cdu_reserved;
        u8 reserved2;
        u16 reserved1;
#elif defined(__LITTLE_ENDIAN)
        u16 reserved1;
        u8 reserved2;
        u8 cdu_reserved;
#endif
        u32 reserved3[30];
};

/*
 * The eth aggregative context of Tstorm
 */
struct tstorm_eth_ag_context {
        u32 __reserved0[14];
};


/*
 * The eth aggregative context of Cstorm
 */
struct cstorm_eth_ag_context {
        u32 __reserved0[10];
};


/*
 * The eth aggregative context of Ustorm
 */
struct ustorm_eth_ag_context {
        u32 __reserved0;
#if defined(__BIG_ENDIAN)
        u8 cdu_usage;
        u8 __reserved2;
        u16 __reserved1;
#elif defined(__LITTLE_ENDIAN)
        u16 __reserved1;
        u8 __reserved2;
        u8 cdu_usage;
#endif
        u32 __reserved3[6];
};

/*
 * Timers connection context
 */
struct timers_block_context {
        u32 __reserved_0;
        u32 __reserved_1;
        u32 __reserved_2;
        u32 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 {
        u8 as_bitfield;
#define ETH_TX_BD_FLAGS_IP_CSUM (0x1<<0)
#define ETH_TX_BD_FLAGS_IP_CSUM_SHIFT 0
#define ETH_TX_BD_FLAGS_L4_CSUM (0x1<<1)
#define ETH_TX_BD_FLAGS_L4_CSUM_SHIFT 1
#define ETH_TX_BD_FLAGS_VLAN_MODE (0x3<<2)
#define ETH_TX_BD_FLAGS_VLAN_MODE_SHIFT 2
#define ETH_TX_BD_FLAGS_START_BD (0x1<<4)
#define ETH_TX_BD_FLAGS_START_BD_SHIFT 4
#define ETH_TX_BD_FLAGS_IS_UDP (0x1<<5)
#define ETH_TX_BD_FLAGS_IS_UDP_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 {
        __le32 addr_lo;
        __le32 addr_hi;
        __le16 nbd;
        __le16 nbytes;
        __le16 vlan_or_ethertype;
        struct eth_tx_bd_flags bd_flags;
        u8 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 {
        __le32 addr_lo;
        __le32 addr_hi;
        __le16 total_pkt_bytes;
        __le16 nbytes;
        u8 reserved[4];
};

/*
 * Tx parsing BD structure for ETH E1/E1h
 */
struct eth_tx_parse_bd_e1x {
        u8 global_data;
#define ETH_TX_PARSE_BD_E1X_IP_HDR_START_OFFSET_W (0xF<<0)
#define ETH_TX_PARSE_BD_E1X_IP_HDR_START_OFFSET_W_SHIFT 0
#define ETH_TX_PARSE_BD_E1X_RESERVED0 (0x1<<4)
#define ETH_TX_PARSE_BD_E1X_RESERVED0_SHIFT 4
#define ETH_TX_PARSE_BD_E1X_PSEUDO_CS_WITHOUT_LEN (0x1<<5)
#define ETH_TX_PARSE_BD_E1X_PSEUDO_CS_WITHOUT_LEN_SHIFT 5
#define ETH_TX_PARSE_BD_E1X_LLC_SNAP_EN (0x1<<6)
#define ETH_TX_PARSE_BD_E1X_LLC_SNAP_EN_SHIFT 6
#define ETH_TX_PARSE_BD_E1X_NS_FLG (0x1<<7)
#define ETH_TX_PARSE_BD_E1X_NS_FLG_SHIFT 7
        u8 tcp_flags;
#define ETH_TX_PARSE_BD_E1X_FIN_FLG (0x1<<0)
#define ETH_TX_PARSE_BD_E1X_FIN_FLG_SHIFT 0
#define ETH_TX_PARSE_BD_E1X_SYN_FLG (0x1<<1)
#define ETH_TX_PARSE_BD_E1X_SYN_FLG_SHIFT 1
#define ETH_TX_PARSE_BD_E1X_RST_FLG (0x1<<2)
#define ETH_TX_PARSE_BD_E1X_RST_FLG_SHIFT 2
#define ETH_TX_PARSE_BD_E1X_PSH_FLG (0x1<<3)
#define ETH_TX_PARSE_BD_E1X_PSH_FLG_SHIFT 3
#define ETH_TX_PARSE_BD_E1X_ACK_FLG (0x1<<4)
#define ETH_TX_PARSE_BD_E1X_ACK_FLG_SHIFT 4
#define ETH_TX_PARSE_BD_E1X_URG_FLG (0x1<<5)
#define ETH_TX_PARSE_BD_E1X_URG_FLG_SHIFT 5
#define ETH_TX_PARSE_BD_E1X_ECE_FLG (0x1<<6)
#define ETH_TX_PARSE_BD_E1X_ECE_FLG_SHIFT 6
#define ETH_TX_PARSE_BD_E1X_CWR_FLG (0x1<<7)
#define ETH_TX_PARSE_BD_E1X_CWR_FLG_SHIFT 7
        u8 ip_hlen_w;
        s8 reserved;
        __le16 total_hlen_w;
        __le16 tcp_pseudo_csum;
        __le16 lso_mss;
        __le16 ip_id;
        __le32 tcp_send_seq;
};

/*
 * Tx parsing BD structure for ETH E2
 */
struct eth_tx_parse_bd_e2 {
        __le16 dst_mac_addr_lo;
        __le16 dst_mac_addr_mid;
        __le16 dst_mac_addr_hi;
        __le16 src_mac_addr_lo;
        __le16 src_mac_addr_mid;
        __le16 src_mac_addr_hi;
        __le32 parsing_data;
#define ETH_TX_PARSE_BD_E2_TCP_HDR_START_OFFSET_W (0x1FFF<<0)
#define ETH_TX_PARSE_BD_E2_TCP_HDR_START_OFFSET_W_SHIFT 0
#define ETH_TX_PARSE_BD_E2_TCP_HDR_LENGTH_DW (0xF<<13)
#define ETH_TX_PARSE_BD_E2_TCP_HDR_LENGTH_DW_SHIFT 13
#define ETH_TX_PARSE_BD_E2_LSO_MSS (0x3FFF<<17)
#define ETH_TX_PARSE_BD_E2_LSO_MSS_SHIFT 17
#define ETH_TX_PARSE_BD_E2_IPV6_WITH_EXT_HDR (0x1<<31)
#define ETH_TX_PARSE_BD_E2_IPV6_WITH_EXT_HDR_SHIFT 31
};

/*
 * The last BD in the BD memory will hold a pointer to the next BD memory
 */
struct eth_tx_next_bd {
        __le32 addr_lo;
        __le32 addr_hi;
        u8 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_e1x parse_bd_e1x;
        struct eth_tx_parse_bd_e2 parse_bd_e2;
        struct eth_tx_next_bd next_bd;
};


/*
 * The eth storm context of Xstorm
 */
struct xstorm_eth_st_context {
        u32 reserved0[60];
};

/*
 * The eth storm context of Cstorm
 */
struct cstorm_eth_st_context {
        u32 __reserved0[4];
};

/*
 * 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)
        u16 npackets;
        u8 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;
        u8 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
        u16 npackets;
#endif
};


/*
 * client init fc data
 */
struct client_init_fc_data {
        __le16 cqe_pause_thr_low;
        __le16 cqe_pause_thr_high;
        __le16 bd_pause_thr_low;
        __le16 bd_pause_thr_high;
        __le16 sge_pause_thr_low;
        __le16 sge_pause_thr_high;
        __le16 rx_cos_mask;
        u8 safc_group_num;
        u8 safc_group_en_flg;
        u8 traffic_type;
        u8 reserved0;
        __le16 reserved1;
        __le32 reserved2;
};


/*
 * client init ramrod data
 */
struct client_init_general_data {
        u8 client_id;
        u8 statistics_counter_id;
        u8 statistics_en_flg;
        u8 is_fcoe_flg;
        u8 activate_flg;
        u8 sp_client_id;
        __le16 reserved0;
        __le32 reserved1[2];
};


/*
 * client init rx data
 */
struct client_init_rx_data {
        u8 tpa_en_flg;
        u8 vmqueue_mode_en_flg;
        u8 extra_data_over_sgl_en_flg;
        u8 cache_line_alignment_log_size;
        u8 enable_dynamic_hc;
        u8 max_sges_for_packet;
        u8 client_qzone_id;
        u8 drop_ip_cs_err_flg;
        u8 drop_tcp_cs_err_flg;
        u8 drop_ttl0_flg;
        u8 drop_udp_cs_err_flg;
        u8 inner_vlan_removal_enable_flg;
        u8 outer_vlan_removal_enable_flg;
        u8 status_block_id;
        u8 rx_sb_index_number;
        u8 reserved0[3];
        __le16 bd_buff_size;
        __le16 sge_buff_size;
        __le16 mtu;
        struct regpair bd_page_base;
        struct regpair sge_page_base;
        struct regpair cqe_page_base;
        u8 is_leading_rss;
        u8 is_approx_mcast;
        __le16 max_agg_size;
        __le32 reserved2[3];
};

/*
 * client init tx data
 */
struct client_init_tx_data {
        u8 enforce_security_flg;
        u8 tx_status_block_id;
        u8 tx_sb_index_number;
        u8 reserved0;
        __le16 mtu;
        __le16 reserved1;
        struct regpair tx_bd_page_base;
        __le32 reserved2[2];
};

/*
 * client init ramrod data
 */
struct client_init_ramrod_data {
        struct client_init_general_data general;
        struct client_init_rx_data rx;
        struct client_init_tx_data tx;
        struct client_init_fc_data fc;
};


/*
 * The data contain client ID need to the ramrod
 */
struct eth_common_ramrod_data {
        u32 client_id;
        u32 reserved1;
};


/*
 * union for sgl and raw data.
 */
union eth_sgl_or_raw_data {
        __le16 sgl[8];
        u32 raw_data[4];
};

/*
 * regular eth FP CQE parameters struct
 */
struct eth_fast_path_rx_cqe {
        u8 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_SGL_RAW_SEL (0x3<<6)
#define ETH_FAST_PATH_RX_CQE_SGL_RAW_SEL_SHIFT 6
        u8 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
        u8 placement_offset;
        u8 queue_index;
        __le32 rss_hash_result;
        __le16 vlan_tag;
        __le16 pkt_len;
        __le16 len_on_bd;
        struct parsing_flags pars_flags;
        union eth_sgl_or_raw_data sgl_or_raw_data;
};


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

/*
 * The data for statistics query ramrod
 */
struct common_query_ramrod_data {
#if defined(__BIG_ENDIAN)
        u8 reserved0;
        u8 collect_port;
        u16 drv_counter;
#elif defined(__LITTLE_ENDIAN)
        u16 drv_counter;
        u8 collect_port;
        u8 reserved0;
#endif
        u32 ctr_id_vector;
};


/*
 * Place holder for ramrods protocol specific data
 */
struct ramrod_data {
        __le32 data_lo;
        __le32 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 {
        u8 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
        u8 conn_type;
        __le16 reserved1;
        __le32 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;
        __le32 reserved2[4];
};

/*
 * Rx Last CQE in page (in ETH)
 */
struct eth_rx_cqe_next_page {
        __le32 addr_lo;
        __le32 addr_hi;
        __le32 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 {
        __le32 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
        __le16 type;
#define SPE_HDR_CONN_TYPE (0xFF<<0)
#define SPE_HDR_CONN_TYPE_SHIFT 0
#define SPE_HDR_FUNCTION_ID (0xFF<<8)
#define SPE_HDR_FUNCTION_ID_SHIFT 8
        __le16 reserved1;
};

/*
 * Ethernet slow path element
 */
union eth_specific_data {
        u8 protocol_data[8];
        struct regpair client_init_ramrod_init_data;
        struct eth_halt_ramrod_data halt_ramrod_data;
        struct regpair update_data_addr;
        struct eth_common_ramrod_data common_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)
        u8 reserved1;
        u8 rss_result_mask;
        u16 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_ENABLE_TPA (0x1<<7)
#define TSTORM_ETH_FUNCTION_COMMON_CONFIG_ENABLE_TPA_SHIFT 7
#define TSTORM_ETH_FUNCTION_COMMON_CONFIG_VLAN_FILTERING_ENABLE (0x1<<8)
#define TSTORM_ETH_FUNCTION_COMMON_CONFIG_VLAN_FILTERING_ENABLE_SHIFT 8
#define __TSTORM_ETH_FUNCTION_COMMON_CONFIG_RESERVED0 (0x7F<<9)
#define __TSTORM_ETH_FUNCTION_COMMON_CONFIG_RESERVED0_SHIFT 9
#elif defined(__LITTLE_ENDIAN)
        u16 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_ENABLE_TPA (0x1<<7)
#define TSTORM_ETH_FUNCTION_COMMON_CONFIG_ENABLE_TPA_SHIFT 7
#define TSTORM_ETH_FUNCTION_COMMON_CONFIG_VLAN_FILTERING_ENABLE (0x1<<8)
#define TSTORM_ETH_FUNCTION_COMMON_CONFIG_VLAN_FILTERING_ENABLE_SHIFT 8
#define __TSTORM_ETH_FUNCTION_COMMON_CONFIG_RESERVED0 (0x7F<<9)
#define __TSTORM_ETH_FUNCTION_COMMON_CONFIG_RESERVED0_SHIFT 9
        u8 rss_result_mask;
        u8 reserved1;
#endif
        u16 vlan_id[2];
};

/*
 * RSS idirection table update configuration
 */
struct rss_update_config {
#if defined(__BIG_ENDIAN)
        u16 toe_rss_bitmap;
        u16 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)
        u16 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
        u16 toe_rss_bitmap;
#endif
        u32 reserved1;
};

/*
 * parameters for eth update ramrod
 */
struct eth_update_ramrod_data {
        struct tstorm_eth_function_common_config func_config;
        u8 indirectionTable[128];
        struct rss_update_config rss_config;
};


/*
 * MAC filtering configuration command header
 */
struct mac_configuration_hdr {
        u8 length;
        u8 offset;
        u16 client_id;
        u16 echo;
        u16 reserved1;
};

/*
 * MAC address in list for ramrod
 */
struct mac_configuration_entry {
        __le16 lsb_mac_addr;
        __le16 middle_mac_addr;
        __le16 msb_mac_addr;
        __le16 vlan_id;
        u8 pf_id;
        u8 flags;
#define MAC_CONFIGURATION_ENTRY_ACTION_TYPE (0x1<<0)
#define MAC_CONFIGURATION_ENTRY_ACTION_TYPE_SHIFT 0
#define MAC_CONFIGURATION_ENTRY_RDMA_MAC (0x1<<1)
#define MAC_CONFIGURATION_ENTRY_RDMA_MAC_SHIFT 1
#define MAC_CONFIGURATION_ENTRY_VLAN_FILTERING_MODE (0x3<<2)
#define MAC_CONFIGURATION_ENTRY_VLAN_FILTERING_MODE_SHIFT 2
#define MAC_CONFIGURATION_ENTRY_OVERRIDE_VLAN_REMOVAL (0x1<<4)
#define MAC_CONFIGURATION_ENTRY_OVERRIDE_VLAN_REMOVAL_SHIFT 4
#define MAC_CONFIGURATION_ENTRY_BROADCAST (0x1<<5)
#define MAC_CONFIGURATION_ENTRY_BROADCAST_SHIFT 5
#define MAC_CONFIGURATION_ENTRY_RESERVED1 (0x3<<6)
#define MAC_CONFIGURATION_ENTRY_RESERVED1_SHIFT 6
        u16 reserved0;
        u32 clients_bit_vector;
};

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


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


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


/*
 * common flag to indicate existence of TPA.
 */
struct tstorm_eth_tpa_exist {
#if defined(__BIG_ENDIAN)
        u16 reserved1;
        u8 reserved0;
        u8 tpa_exist;
#elif defined(__LITTLE_ENDIAN)
        u8 tpa_exist;
        u8 reserved0;
        u16 reserved1;
#endif
        u32 reserved2;
};


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


/*
 * cfc delete event data
 */
struct cfc_del_event_data {
        u32 cid;
        u8 error;
        u8 reserved0;
        u16 reserved1;
        u32 reserved2;
};


/*
 * per-port SAFC demo variables
 */
struct cmng_flags_per_port {
        u8 con_number[NUM_OF_PROTOCOLS];
        u32 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_FAIRNESS_COS_MODE (0x1<<5)
#define CMNG_FLAGS_PER_PORT_FAIRNESS_COS_MODE_SHIFT 5
#define __CMNG_FLAGS_PER_PORT_RESERVED0 (0x3FFFFFF<<6)
#define __CMNG_FLAGS_PER_PORT_RESERVED0_SHIFT 6
};


/*
 * per-port rate shaping variables
 */
struct rate_shaping_vars_per_port {
        u32 rs_periodic_timeout;
        u32 rs_threshold;
};

/*
 * per-port fairness variables
 */
struct fairness_vars_per_port {
        u32 upper_bound;
        u32 fair_threshold;
        u32 fairness_timeout;
};

/*
 * per-port SAFC variables
 */
struct safc_struct_per_port {
#if defined(__BIG_ENDIAN)
        u16 __reserved1;
        u8 __reserved0;
        u8 safc_timeout_usec;
#elif defined(__LITTLE_ENDIAN)
        u8 safc_timeout_usec;
        u8 __reserved0;
        u16 __reserved1;
#endif
        u8 cos_to_traffic_types[MAX_COS_NUMBER];
        u32 __reserved2;
        u16 cos_to_pause_mask[NUM_OF_SAFC_BITS];
};

/*
 * per-port PFC variables
 */
struct pfc_struct_per_port {
        u8 priority_to_traffic_types[MAX_PFC_PRIORITIES];
#if defined(__BIG_ENDIAN)
        u16 pfc_pause_quanta_in_nanosec;
        u8 __reserved0;
        u8 priority_non_pausable_mask;
#elif defined(__LITTLE_ENDIAN)
        u8 priority_non_pausable_mask;
        u8 __reserved0;
        u16 pfc_pause_quanta_in_nanosec;
#endif
};

/*
 * Priority and cos
 */
struct priority_cos {
#if defined(__BIG_ENDIAN)
        u16 reserved1;
        u8 cos;
        u8 priority;
#elif defined(__LITTLE_ENDIAN)
        u8 priority;
        u8 cos;
        u16 reserved1;
#endif
        u32 reserved2;
};

/*
 * 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 pfc_struct_per_port pfc_vars;
#if defined(__BIG_ENDIAN)
        u16 __reserved1;
        u8 dcb_enabled;
        u8 llfc_mode;
#elif defined(__LITTLE_ENDIAN)
        u8 llfc_mode;
        u8 dcb_enabled;
        u16 __reserved1;
#endif
        struct priority_cos
                traffic_type_to_priority_cos[MAX_PFC_TRAFFIC_TYPES];
        struct cmng_flags_per_port flags;
};



/*
 * Dynamic HC counters set by the driver
 */
struct hc_dynamic_drv_counter {
        u32 val[HC_SB_MAX_DYNAMIC_INDICES];
};

/*
 * zone A per-queue data
 */
struct cstorm_queue_zone_data {
        struct hc_dynamic_drv_counter hc_dyn_drv_cnt;
        struct regpair reserved[2];
};

/*
 * Dynamic host coalescing init parameters
 */
struct dynamic_hc_config {
        u32 threshold[3];
        u8 shift_per_protocol[HC_SB_MAX_DYNAMIC_INDICES];
        u8 hc_timeout0[HC_SB_MAX_DYNAMIC_INDICES];
        u8 hc_timeout1[HC_SB_MAX_DYNAMIC_INDICES];
        u8 hc_timeout2[HC_SB_MAX_DYNAMIC_INDICES];
        u8 hc_timeout3[HC_SB_MAX_DYNAMIC_INDICES];
};


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

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

/*
 * Protocol-common statistics collected by the Tstorm (per port)
 */
struct tstorm_per_port_stats {
        __le32 mac_filter_discard;
        __le32 xxoverflow_discard;
        __le32 brb_truncate_discard;
        __le32 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;
        __le32 checksum_discard;
        __le32 packets_too_big_discard;
        __le32 rcv_unicast_pkts;
        __le32 rcv_broadcast_pkts;
        __le32 rcv_multicast_pkts;
        __le32 no_buff_discard;
        __le32 ttl0_discard;
        __le16 stats_counter;
        __le16 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_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;
        __le32 ucast_no_buff_pkts;
        __le32 mcast_no_buff_pkts;
        __le32 bcast_no_buff_pkts;
        __le16 stats_counter;
        __le16 reserved0;
};

/*
 * Protocol-common statistics collected by the Ustorm
 */
struct ustorm_common_stats {
        struct ustorm_per_client_stats client_statistics[MAX_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;
};


/*
 * set mac event data
 */
struct set_mac_event_data {
        u16 echo;
        u16 reserved0;
        u32 reserved1;
        u32 reserved2;
};

/*
 * union for all event ring message types
 */
union event_data {
        struct set_mac_event_data set_mac_event;
        struct cfc_del_event_data cfc_del_event;
};


/*
 * per PF event ring data
 */
struct event_ring_data {
        struct regpair base_addr;
#if defined(__BIG_ENDIAN)
        u8 index_id;
        u8 sb_id;
        u16 producer;
#elif defined(__LITTLE_ENDIAN)
        u16 producer;
        u8 sb_id;
        u8 index_id;
#endif
        u32 reserved0;
};


/*
 * event ring message element (each element is 128 bits)
 */
struct event_ring_msg {
        u8 opcode;
        u8 reserved0;
        u16 reserved1;
        union event_data data;
};

/*
 * event ring next page element (128 bits)
 */
struct event_ring_next {
        struct regpair addr;
        u32 reserved[2];
};

/*
 * union for event ring element types (each element is 128 bits)
 */
union event_ring_elem {
        struct event_ring_msg message;
        struct event_ring_next next_page;
};


/*
 * per-vnic fairness variables
 */
struct fairness_vars_per_vn {
        u32 cos_credit_delta[MAX_COS_NUMBER];
        u32 protocol_credit_delta[NUM_OF_PROTOCOLS];
        u32 vn_credit_delta;
        u32 __reserved0;
};


/*
 * The data for flow control configuration
 */
struct flow_control_configuration {
        struct priority_cos
                traffic_type_to_priority_cos[MAX_PFC_TRAFFIC_TYPES];
#if defined(__BIG_ENDIAN)
        u16 reserved1;
        u8 dcb_version;
        u8 dcb_enabled;
#elif defined(__LITTLE_ENDIAN)
        u8 dcb_enabled;
        u8 dcb_version;
        u16 reserved1;
#endif
        u32 reserved2;
};


/*
 * FW version stored in the Xstorm RAM
 */
struct fw_version {
#if defined(__BIG_ENDIAN)
        u8 engineering;
        u8 revision;
        u8 minor;
        u8 major;
#elif defined(__LITTLE_ENDIAN)
        u8 major;
        u8 minor;
        u8 revision;
        u8 engineering;
#endif
        u32 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
};


/*
 * Dynamic Host-Coalescing - Driver(host) counters
 */
struct hc_dynamic_sb_drv_counters {
        u32 dynamic_hc_drv_counter[HC_SB_MAX_DYNAMIC_INDICES];
};


/*
 * 2 bytes. configuration/state parameters for a single protocol index
 */
struct hc_index_data {
#if defined(__BIG_ENDIAN)
        u8 flags;
#define HC_INDEX_DATA_SM_ID (0x1<<0)
#define HC_INDEX_DATA_SM_ID_SHIFT 0
#define HC_INDEX_DATA_HC_ENABLED (0x1<<1)
#define HC_INDEX_DATA_HC_ENABLED_SHIFT 1
#define HC_INDEX_DATA_DYNAMIC_HC_ENABLED (0x1<<2)
#define HC_INDEX_DATA_DYNAMIC_HC_ENABLED_SHIFT 2
#define HC_INDEX_DATA_RESERVE (0x1F<<3)
#define HC_INDEX_DATA_RESERVE_SHIFT 3
        u8 timeout;
#elif defined(__LITTLE_ENDIAN)
        u8 timeout;
        u8 flags;
#define HC_INDEX_DATA_SM_ID (0x1<<0)
#define HC_INDEX_DATA_SM_ID_SHIFT 0
#define HC_INDEX_DATA_HC_ENABLED (0x1<<1)
#define HC_INDEX_DATA_HC_ENABLED_SHIFT 1
#define HC_INDEX_DATA_DYNAMIC_HC_ENABLED (0x1<<2)
#define HC_INDEX_DATA_DYNAMIC_HC_ENABLED_SHIFT 2
#define HC_INDEX_DATA_RESERVE (0x1F<<3)
#define HC_INDEX_DATA_RESERVE_SHIFT 3
#endif
};


/*
 * HC state-machine
 */
struct hc_status_block_sm {
#if defined(__BIG_ENDIAN)
        u8 igu_seg_id;
        u8 igu_sb_id;
        u8 timer_value;
        u8 __flags;
#elif defined(__LITTLE_ENDIAN)
        u8 __flags;
        u8 timer_value;
        u8 igu_sb_id;
        u8 igu_seg_id;
#endif
        u32 time_to_expire;
};

/*
 * hold PCI identification variables- used in various places in firmware
 */
struct pci_entity {
#if defined(__BIG_ENDIAN)
        u8 vf_valid;
        u8 vf_id;
        u8 vnic_id;
        u8 pf_id;
#elif defined(__LITTLE_ENDIAN)
        u8 pf_id;
        u8 vnic_id;
        u8 vf_id;
        u8 vf_valid;
#endif
};

/*
 * The fast-path status block meta-data, common to all chips
 */
struct hc_sb_data {
        struct regpair host_sb_addr;
        struct hc_status_block_sm state_machine[HC_SB_MAX_SM];
        struct pci_entity p_func;
#if defined(__BIG_ENDIAN)
        u8 rsrv0;
        u8 dhc_qzone_id;
        u8 __dynamic_hc_level;
        u8 same_igu_sb_1b;
#elif defined(__LITTLE_ENDIAN)
        u8 same_igu_sb_1b;
        u8 __dynamic_hc_level;
        u8 dhc_qzone_id;
        u8 rsrv0;
#endif
        struct regpair rsrv1[2];
};


/*
 * The fast-path status block meta-data
 */
struct hc_sp_status_block_data {
        struct regpair host_sb_addr;
#if defined(__BIG_ENDIAN)
        u16 rsrv;
        u8 igu_seg_id;
        u8 igu_sb_id;
#elif defined(__LITTLE_ENDIAN)
        u8 igu_sb_id;
        u8 igu_seg_id;
        u16 rsrv;
#endif
        struct pci_entity p_func;
};


/*
 * The fast-path status block meta-data
 */
struct hc_status_block_data_e1x {
        struct hc_index_data index_data[HC_SB_MAX_INDICES_E1X];
        struct hc_sb_data common;
};


/*
 * The fast-path status block meta-data
 */
struct hc_status_block_data_e2 {
        struct hc_index_data index_data[HC_SB_MAX_INDICES_E2];
        struct hc_sb_data common;
};


/*
 * FW version stored in first line of pram
 */
struct pram_fw_version {
        u8 major;
        u8 minor;
        u8 revision;
        u8 engineering;
        u8 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
};


/*
 * Ethernet slow path element
 */
union protocol_common_specific_data {
        u8 protocol_data[8];
        struct regpair phy_address;
        struct regpair mac_config_addr;
        struct common_query_ramrod_data query_ramrod_data;
};

/*
 * The send queue element
 */
struct protocol_common_spe {
        struct spe_hdr hdr;
        union protocol_common_specific_data data;
};


/*
 * a single rate shaping counter. can be used as protocol or vnic counter
 */
struct rate_shaping_counter {
        u32 quota;
#if defined(__BIG_ENDIAN)
        u16 __reserved0;
        u16 rate;
#elif defined(__LITTLE_ENDIAN)
        u16 rate;
        u16 __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;
        struct regpair protocol_data;
};


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


/*
 * per-port PFC variables
 */
struct storm_pfc_struct_per_port {
#if defined(__BIG_ENDIAN)
        u16 mid_mac_addr;
        u16 msb_mac_addr;
#elif defined(__LITTLE_ENDIAN)
        u16 msb_mac_addr;
        u16 mid_mac_addr;
#endif
#if defined(__BIG_ENDIAN)
        u16 pfc_pause_quanta_in_nanosec;
        u16 lsb_mac_addr;
#elif defined(__LITTLE_ENDIAN)
        u16 lsb_mac_addr;
        u16 pfc_pause_quanta_in_nanosec;
#endif
};

/*
 * Per-port congestion management variables
 */
struct storm_cmng_struct_per_port {
        struct storm_pfc_struct_per_port pfc_vars;
};


/*
 * zone A per-queue data
 */
struct tstorm_queue_zone_data {
        struct regpair reserved[4];
};


/*
 * zone B per-VF data
 */
struct tstorm_vf_zone_data {
        struct regpair reserved;
};


/*
 * zone A per-queue data
 */
struct ustorm_queue_zone_data {
        struct ustorm_eth_rx_producers eth_rx_producers;
        struct regpair reserved[3];
};


/*
 * zone B per-VF data
 */
struct ustorm_vf_zone_data {
        struct regpair reserved;
};


/*
 * data per VF-PF channel
 */
struct vf_pf_channel_data {
#if defined(__BIG_ENDIAN)
        u16 reserved0;
        u8 valid;
        u8 state;
#elif defined(__LITTLE_ENDIAN)
        u8 state;
        u8 valid;
        u16 reserved0;
#endif
        u32 reserved1;
};


/*
 * zone A per-queue data
 */
struct xstorm_queue_zone_data {
        struct regpair reserved[4];
};


/*
 * zone B per-VF data
 */
struct xstorm_vf_zone_data {
        struct regpair reserved;
};

#endif /* BNX2X_HSI_H */