/*-
 * Copyright 2021 Intel Corp
 * Copyright 2021 Rubicon Communications, LLC (Netgate)
 * SPDX-License-Identifier: BSD-3-Clause
 */

#ifndef _IGC_DEFINES_H_
#define _IGC_DEFINES_H_

/* Number of Transmit and Receive Descriptors must be a multiple of 8 */
#define REQ_TX_DESCRIPTOR_MULTIPLE  8
#define REQ_RX_DESCRIPTOR_MULTIPLE  8

/* Definitions for power management and wakeup registers */
/* Wake Up Control */
#define IGC_WUC_APME            0x00000001 /* APM Enable */
#define IGC_WUC_PME_EN  0x00000002 /* PME Enable */
#define IGC_WUC_PME_STATUS      0x00000004 /* PME Status */
#define IGC_WUC_APMPME  0x00000008 /* Assert PME on APM Wakeup */
#define IGC_WUC_PHY_WAKE        0x00000100 /* if PHY supports wakeup */

/* Wake Up Filter Control */
#define IGC_WUFC_LNKC   0x00000001 /* Link Status Change Wakeup Enable */
#define IGC_WUFC_MAG    0x00000002 /* Magic Packet Wakeup Enable */
#define IGC_WUFC_EX     0x00000004 /* Directed Exact Wakeup Enable */
#define IGC_WUFC_MC     0x00000008 /* Directed Multicast Wakeup Enable */
#define IGC_WUFC_BC     0x00000010 /* Broadcast Wakeup Enable */
#define IGC_WUFC_ARP    0x00000020 /* ARP Request Packet Wakeup Enable */
#define IGC_WUFC_IPV4   0x00000040 /* Directed IPv4 Packet Wakeup Enable */

/* Wake Up Status */
#define IGC_WUS_LNKC            IGC_WUFC_LNKC
#define IGC_WUS_MAG             IGC_WUFC_MAG
#define IGC_WUS_EX              IGC_WUFC_EX
#define IGC_WUS_MC              IGC_WUFC_MC
#define IGC_WUS_BC              IGC_WUFC_BC

/* Packet types that are enabled for wake packet delivery */
#define WAKE_PKT_WUS ( \
        IGC_WUS_EX   | \
        IGC_WUS_ARPD | \
        IGC_WUS_IPV4 | \
        IGC_WUS_IPV6 | \
        IGC_WUS_NSD)

/* Wake Up Packet Length */
#define IGC_WUPL_MASK           0x00000FFF

/* Wake Up Packet Memory stores the first 128 bytes of the wake up packet */
#define IGC_WUPM_BYTES  128

#define IGC_WUS_ARPD    0x00000020 /* Directed ARP Request */
#define IGC_WUS_IPV4    0x00000040 /* Directed IPv4 */
#define IGC_WUS_IPV6    0x00000080 /* Directed IPv6 */
#define IGC_WUS_NSD     0x00000400 /* Directed IPv6 Neighbor Solicitation */

/* Extended Device Control */
#define IGC_CTRL_EXT_LPCD               0x00000004 /* LCD Power Cycle Done */
#define IGC_CTRL_EXT_SDP4_DATA  0x00000010 /* SW Definable Pin 4 data */
#define IGC_CTRL_EXT_SDP6_DATA  0x00000040 /* SW Definable Pin 6 data */
#define IGC_CTRL_EXT_SDP3_DATA  0x00000080 /* SW Definable Pin 3 data */
#define IGC_CTRL_EXT_SDP6_DIR   0x00000400 /* Direction of SDP6 0=in 1=out */
#define IGC_CTRL_EXT_SDP3_DIR   0x00000800 /* Direction of SDP3 0=in 1=out */
#define IGC_CTRL_EXT_FORCE_SMBUS        0x00000800 /* Force SMBus mode */
#define IGC_CTRL_EXT_EE_RST     0x00002000 /* Reinitialize from EEPROM */
#define IGC_CTRL_EXT_SPD_BYPS   0x00008000 /* Speed Select Bypass */
#define IGC_CTRL_EXT_RO_DIS     0x00020000 /* Relaxed Ordering disable */
#define IGC_CTRL_EXT_DMA_DYN_CLK_EN     0x00080000 /* DMA Dynamic Clk Gating */
#define IGC_CTRL_EXT_LINK_MODE_PCIE_SERDES      0x00C00000
#define IGC_CTRL_EXT_EIAME              0x01000000
#define IGC_CTRL_EXT_DRV_LOAD           0x10000000 /* Drv loaded bit for FW */
#define IGC_CTRL_EXT_IAME               0x08000000 /* Int ACK Auto-mask */
#define IGC_CTRL_EXT_PBA_CLR            0x80000000 /* PBA Clear */
#define IGC_CTRL_EXT_PHYPDEN            0x00100000
#define IGC_IVAR_VALID  0x80
#define IGC_GPIE_NSICR  0x00000001
#define IGC_GPIE_MSIX_MODE      0x00000010
#define IGC_GPIE_EIAME  0x40000000
#define IGC_GPIE_PBA            0x80000000

/* Receive Descriptor bit definitions */
#define IGC_RXD_STAT_DD 0x01    /* Descriptor Done */
#define IGC_RXD_STAT_EOP        0x02    /* End of Packet */
#define IGC_RXD_STAT_IXSM       0x04    /* Ignore checksum */
#define IGC_RXD_STAT_VP 0x08    /* IEEE VLAN Packet */
#define IGC_RXD_STAT_UDPCS      0x10    /* UDP xsum calculated */
#define IGC_RXD_STAT_TCPCS      0x20    /* TCP xsum calculated */
#define IGC_RXD_STAT_IPCS       0x40    /* IP xsum calculated */
#define IGC_RXD_STAT_PIF        0x80    /* passed in-exact filter */
#define IGC_RXD_STAT_IPIDV      0x200   /* IP identification valid */
#define IGC_RXD_STAT_UDPV       0x400   /* Valid UDP checksum */
#define IGC_RXD_ERR_CE  0x01    /* CRC Error */
#define IGC_RXD_ERR_SE  0x02    /* Symbol Error */
#define IGC_RXD_ERR_SEQ 0x04    /* Sequence Error */
#define IGC_RXD_ERR_CXE 0x10    /* Carrier Extension Error */
#define IGC_RXD_ERR_TCPE        0x20    /* TCP/UDP Checksum Error */
#define IGC_RXD_ERR_IPE 0x40    /* IP Checksum Error */
#define IGC_RXD_ERR_RXE 0x80    /* Rx Data Error */

#define IGC_RXDEXT_STATERR_TST  0x00000100 /* Time Stamp taken */
#define IGC_RXDEXT_STATERR_LB           0x00040000
#define IGC_RXDEXT_STATERR_L4E  0x20000000
#define IGC_RXDEXT_STATERR_IPE  0x40000000
#define IGC_RXDEXT_STATERR_RXE  0x80000000

/* Same mask, but for extended and packet split descriptors */
#define IGC_RXDEXT_ERR_FRAME_ERR_MASK ( \
        IGC_RXDEXT_STATERR_CE  |        \
        IGC_RXDEXT_STATERR_SE  |        \
        IGC_RXDEXT_STATERR_SEQ |        \
        IGC_RXDEXT_STATERR_CXE |        \
        IGC_RXDEXT_STATERR_RXE)

#if !defined(EXTERNAL_RELEASE) || defined(IGCE_MQ)
#define IGC_MRQC_ENABLE_RSS_2Q          0x00000001
#endif /* !EXTERNAL_RELEASE || IGCE_MQ */
#define IGC_MRQC_RSS_FIELD_MASK         0xFFFF0000
#define IGC_MRQC_RSS_FIELD_IPV4_TCP             0x00010000
#define IGC_MRQC_RSS_FIELD_IPV4         0x00020000
#define IGC_MRQC_RSS_FIELD_IPV6_TCP_EX  0x00040000
#define IGC_MRQC_RSS_FIELD_IPV6         0x00100000
#define IGC_MRQC_RSS_FIELD_IPV6_TCP             0x00200000

#define IGC_RXDPS_HDRSTAT_HDRSP         0x00008000

/* Management Control */
#define IGC_MANC_SMBUS_EN       0x00000001 /* SMBus Enabled - RO */
#define IGC_MANC_ASF_EN 0x00000002 /* ASF Enabled - RO */
#define IGC_MANC_ARP_EN 0x00002000 /* Enable ARP Request Filtering */
#define IGC_MANC_RCV_TCO_EN     0x00020000 /* Receive TCO Packets Enabled */
#define IGC_MANC_BLK_PHY_RST_ON_IDE     0x00040000 /* Block phy resets */
/* Enable MAC address filtering */
#define IGC_MANC_EN_MAC_ADDR_FILTER     0x00100000
/* Enable MNG packets to host memory */
#define IGC_MANC_EN_MNG2HOST            0x00200000

#define IGC_MANC2H_PORT_623             0x00000020 /* Port 0x26f */
#define IGC_MANC2H_PORT_664             0x00000040 /* Port 0x298 */
#define IGC_MDEF_PORT_623               0x00000800 /* Port 0x26f */
#define IGC_MDEF_PORT_664               0x00000400 /* Port 0x298 */

/* Receive Control */
#define IGC_RCTL_RST            0x00000001 /* Software reset */
#define IGC_RCTL_EN             0x00000002 /* enable */
#define IGC_RCTL_SBP            0x00000004 /* store bad packet */
#define IGC_RCTL_UPE            0x00000008 /* unicast promisc enable */
#define IGC_RCTL_MPE            0x00000010 /* multicast promisc enable */
#define IGC_RCTL_LPE            0x00000020 /* long packet enable */
#define IGC_RCTL_LBM_NO 0x00000000 /* no loopback mode */
#define IGC_RCTL_LBM_MAC        0x00000040 /* MAC loopback mode */
#define IGC_RCTL_LBM_TCVR       0x000000C0 /* tcvr loopback mode */
#define IGC_RCTL_DTYP_PS        0x00000400 /* Packet Split descriptor */
#define IGC_RCTL_RDMTS_HALF     0x00000000 /* Rx desc min thresh size */
#define IGC_RCTL_RDMTS_HEX      0x00010000
#define IGC_RCTL_RDMTS1_HEX     IGC_RCTL_RDMTS_HEX
#define IGC_RCTL_MO_SHIFT       12 /* multicast offset shift */
#define IGC_RCTL_MO_3           0x00003000 /* multicast offset 15:4 */
#define IGC_RCTL_BAM            0x00008000 /* broadcast enable */
/* these buffer sizes are valid if IGC_RCTL_BSEX is 0 */
#define IGC_RCTL_SZ_2048        0x00000000 /* Rx buffer size 2048 */
#define IGC_RCTL_SZ_1024        0x00010000 /* Rx buffer size 1024 */
#define IGC_RCTL_SZ_512 0x00020000 /* Rx buffer size 512 */
#define IGC_RCTL_SZ_256 0x00030000 /* Rx buffer size 256 */
/* these buffer sizes are valid if IGC_RCTL_BSEX is 1 */
#define IGC_RCTL_SZ_16384       0x00010000 /* Rx buffer size 16384 */
#define IGC_RCTL_SZ_8192        0x00020000 /* Rx buffer size 8192 */
#define IGC_RCTL_SZ_4096        0x00030000 /* Rx buffer size 4096 */
#define IGC_RCTL_VFE            0x00040000 /* vlan filter enable */
#define IGC_RCTL_CFIEN  0x00080000 /* canonical form enable */
#define IGC_RCTL_CFI            0x00100000 /* canonical form indicator */
#define IGC_RCTL_DPF            0x00400000 /* discard pause frames */
#define IGC_RCTL_PMCF           0x00800000 /* pass MAC control frames */
#define IGC_RCTL_BSEX           0x02000000 /* Buffer size extension */
#define IGC_RCTL_SECRC  0x04000000 /* Strip Ethernet CRC */

/* Use byte values for the following shift parameters
 * Usage:
 *     psrctl |= (((ROUNDUP(value0, 128) >> IGC_PSRCTL_BSIZE0_SHIFT) &
 *                IGC_PSRCTL_BSIZE0_MASK) |
 *              ((ROUNDUP(value1, 1024) >> IGC_PSRCTL_BSIZE1_SHIFT) &
 *                IGC_PSRCTL_BSIZE1_MASK) |
 *              ((ROUNDUP(value2, 1024) << IGC_PSRCTL_BSIZE2_SHIFT) &
 *                IGC_PSRCTL_BSIZE2_MASK) |
 *              ((ROUNDUP(value3, 1024) << IGC_PSRCTL_BSIZE3_SHIFT) |;
 *                IGC_PSRCTL_BSIZE3_MASK))
 * where value0 = [128..16256],  default=256
 *       value1 = [1024..64512], default=4096
 *       value2 = [0..64512],    default=4096
 *       value3 = [0..64512],    default=0
 */

#define IGC_PSRCTL_BSIZE0_MASK  0x0000007F
#define IGC_PSRCTL_BSIZE1_MASK  0x00003F00
#define IGC_PSRCTL_BSIZE2_MASK  0x003F0000
#define IGC_PSRCTL_BSIZE3_MASK  0x3F000000

#define IGC_PSRCTL_BSIZE0_SHIFT 7    /* Shift _right_ 7 */
#define IGC_PSRCTL_BSIZE1_SHIFT 2    /* Shift _right_ 2 */
#define IGC_PSRCTL_BSIZE2_SHIFT 6    /* Shift _left_ 6 */
#define IGC_PSRCTL_BSIZE3_SHIFT 14   /* Shift _left_ 14 */

/* SWFW_SYNC Definitions */
#define IGC_SWFW_EEP_SM 0x01
#define IGC_SWFW_PHY0_SM        0x02
#define IGC_SWFW_PHY1_SM        0x04
#define IGC_SWFW_CSR_SM 0x08
#define IGC_SWFW_SW_MNG_SM      0x400

/* Device Control */
#define IGC_CTRL_FD             0x00000001  /* Full duplex.0=half; 1=full */
#define IGC_CTRL_PRIOR  0x00000004  /* Priority on PCI. 0=rx,1=fair */
#define IGC_CTRL_GIO_MASTER_DISABLE 0x00000004 /*Blocks new Master reqs */
#define IGC_CTRL_LRST           0x00000008  /* Link reset. 0=normal,1=reset */
#define IGC_CTRL_ASDE           0x00000020  /* Auto-speed detect enable */
#define IGC_CTRL_SLU            0x00000040  /* Set link up (Force Link) */
#define IGC_CTRL_ILOS           0x00000080  /* Invert Loss-Of Signal */
#define IGC_CTRL_SPD_SEL        0x00000300  /* Speed Select Mask */
#define IGC_CTRL_SPD_10 0x00000000  /* Force 10Mb */
#define IGC_CTRL_SPD_100        0x00000100  /* Force 100Mb */
#define IGC_CTRL_SPD_1000       0x00000200  /* Force 1Gb */
#define IGC_CTRL_FRCSPD 0x00000800  /* Force Speed */
#define IGC_CTRL_FRCDPX 0x00001000  /* Force Duplex */
#define IGC_CTRL_SWDPIN0        0x00040000 /* SWDPIN 0 value */
#define IGC_CTRL_SWDPIN1        0x00080000 /* SWDPIN 1 value */
#define IGC_CTRL_SWDPIN2        0x00100000 /* SWDPIN 2 value */
#define IGC_CTRL_ADVD3WUC       0x00100000 /* D3 WUC */
#define IGC_CTRL_SWDPIN3        0x00200000 /* SWDPIN 3 value */
#define IGC_CTRL_SWDPIO0        0x00400000 /* SWDPIN 0 Input or output */
#define IGC_CTRL_DEV_RST        0x20000000 /* Device reset */
#define IGC_CTRL_RST            0x04000000 /* Global reset */
#define IGC_CTRL_RFCE           0x08000000 /* Receive Flow Control enable */
#define IGC_CTRL_TFCE           0x10000000 /* Transmit flow control enable */
#define IGC_CTRL_VME            0x40000000 /* IEEE VLAN mode enable */
#define IGC_CTRL_PHY_RST        0x80000000 /* PHY Reset */


#define IGC_CONNSW_AUTOSENSE_EN 0x1
#define IGC_PCS_LCTL_FORCE_FCTRL        0x80

#define IGC_PCS_LSTS_AN_COMPLETE        0x10000

/* Device Status */
#define IGC_STATUS_FD                   0x00000001 /* Duplex 0=half 1=full */
#define IGC_STATUS_LU                   0x00000002 /* Link up.0=no,1=link */
#define IGC_STATUS_FUNC_MASK            0x0000000C /* PCI Function Mask */
#define IGC_STATUS_FUNC_SHIFT           2
#define IGC_STATUS_FUNC_1               0x00000004 /* Function 1 */
#define IGC_STATUS_TXOFF                0x00000010 /* transmission paused */
#define IGC_STATUS_SPEED_MASK   0x000000C0
#define IGC_STATUS_SPEED_10             0x00000000 /* Speed 10Mb/s */
#define IGC_STATUS_SPEED_100            0x00000040 /* Speed 100Mb/s */
#define IGC_STATUS_SPEED_1000           0x00000080 /* Speed 1000Mb/s */
#define IGC_STATUS_SPEED_2500           0x00400000 /* Speed 2.5Gb/s indication for I225 */
#define IGC_STATUS_LAN_INIT_DONE        0x00000200 /* Lan Init Compltn by NVM */
#define IGC_STATUS_PHYRA                0x00000400 /* PHY Reset Asserted */
#define IGC_STATUS_GIO_MASTER_ENABLE    0x00080000 /* Master request status */
#define IGC_STATUS_2P5_SKU              0x00001000 /* Val of 2.5GBE SKU strap */
#define IGC_STATUS_2P5_SKU_OVER 0x00002000 /* Val of 2.5GBE SKU Over */
#define IGC_STATUS_PCIM_STATE           0x40000000 /* PCIm function state */

#define SPEED_10        10
#define SPEED_100       100
#define SPEED_1000      1000
#define SPEED_2500      2500
#define HALF_DUPLEX     1
#define FULL_DUPLEX     2


#define ADVERTISE_10_HALF               0x0001
#define ADVERTISE_10_FULL               0x0002
#define ADVERTISE_100_HALF              0x0004
#define ADVERTISE_100_FULL              0x0008
#define ADVERTISE_1000_HALF             0x0010 /* Not used, just FYI */
#define ADVERTISE_1000_FULL             0x0020
#define ADVERTISE_2500_HALF             0x0040 /* NOT used, just FYI */
#define ADVERTISE_2500_FULL             0x0080

/* 1000/H is not supported, nor spec-compliant. */
#define IGC_ALL_SPEED_DUPLEX    ( \
        ADVERTISE_10_HALF | ADVERTISE_10_FULL | ADVERTISE_100_HALF | \
        ADVERTISE_100_FULL | ADVERTISE_1000_FULL)
#define IGC_ALL_SPEED_DUPLEX_2500 ( \
        ADVERTISE_10_HALF | ADVERTISE_10_FULL | ADVERTISE_100_HALF | \
        ADVERTISE_100_FULL | ADVERTISE_1000_FULL | ADVERTISE_2500_FULL)
#define IGC_ALL_NOT_GIG ( \
        ADVERTISE_10_HALF | ADVERTISE_10_FULL | ADVERTISE_100_HALF | \
        ADVERTISE_100_FULL)
#define IGC_ALL_100_SPEED       (ADVERTISE_100_HALF | ADVERTISE_100_FULL)
#define IGC_ALL_10_SPEED        (ADVERTISE_10_HALF | ADVERTISE_10_FULL)
#define IGC_ALL_HALF_DUPLEX     (ADVERTISE_10_HALF | ADVERTISE_100_HALF)

#define AUTONEG_ADVERTISE_SPEED_DEFAULT         IGC_ALL_SPEED_DUPLEX
#define AUTONEG_ADVERTISE_SPEED_DEFAULT_2500    IGC_ALL_SPEED_DUPLEX_2500

/* LED Control */
#define IGC_LEDCTL_LED0_MODE_MASK       0x0000000F
#define IGC_LEDCTL_LED0_MODE_SHIFT      0
#define IGC_LEDCTL_LED0_IVRT            0x00000040
#define IGC_LEDCTL_LED0_BLINK           0x00000080

#define IGC_LEDCTL_MODE_LED_ON  0xE
#define IGC_LEDCTL_MODE_LED_OFF 0xF

/* Transmit Descriptor bit definitions */
#define IGC_TXD_DTYP_D  0x00100000 /* Data Descriptor */
#define IGC_TXD_DTYP_C  0x00000000 /* Context Descriptor */
#define IGC_TXD_POPTS_IXSM      0x01       /* Insert IP checksum */
#define IGC_TXD_POPTS_TXSM      0x02       /* Insert TCP/UDP checksum */
#define IGC_TXD_CMD_EOP 0x01000000 /* End of Packet */
#define IGC_TXD_CMD_IFCS        0x02000000 /* Insert FCS (Ethernet CRC) */
#define IGC_TXD_CMD_IC  0x04000000 /* Insert Checksum */
#define IGC_TXD_CMD_RS  0x08000000 /* Report Status */
#define IGC_TXD_CMD_RPS 0x10000000 /* Report Packet Sent */
#define IGC_TXD_CMD_DEXT        0x20000000 /* Desc extension (0 = legacy) */
#define IGC_TXD_CMD_VLE 0x40000000 /* Add VLAN tag */
#define IGC_TXD_CMD_IDE 0x80000000 /* Enable Tidv register */
#define IGC_TXD_STAT_DD 0x00000001 /* Descriptor Done */
#define IGC_TXD_CMD_TCP 0x01000000 /* TCP packet */
#define IGC_TXD_CMD_IP  0x02000000 /* IP packet */
#define IGC_TXD_CMD_TSE 0x04000000 /* TCP Seg enable */
#define IGC_TXD_EXTCMD_TSTAMP   0x00000010 /* IEEE1588 Timestamp packet */

/* Transmit Control */
#define IGC_TCTL_EN             0x00000002 /* enable Tx */
#define IGC_TCTL_PSP            0x00000008 /* pad short packets */
#define IGC_TCTL_CT             0x00000ff0 /* collision threshold */
#define IGC_TCTL_COLD           0x003ff000 /* collision distance */
#define IGC_TCTL_RTLC           0x01000000 /* Re-transmit on late collision */
#define IGC_TCTL_MULR           0x10000000 /* Multiple request support */

/* Transmit Arbitration Count */
#define IGC_TARC0_ENABLE        0x00000400 /* Enable Tx Queue 0 */

/* SerDes Control */
#define IGC_SCTL_DISABLE_SERDES_LOOPBACK        0x0400
#define IGC_SCTL_ENABLE_SERDES_LOOPBACK 0x0410

/* Receive Checksum Control */
#define IGC_RXCSUM_IPOFL        0x00000100 /* IPv4 checksum offload */
#define IGC_RXCSUM_TUOFL        0x00000200 /* TCP / UDP checksum offload */
#define IGC_RXCSUM_CRCOFL       0x00000800 /* CRC32 offload enable */
#define IGC_RXCSUM_IPPCSE       0x00001000 /* IP payload checksum enable */
#define IGC_RXCSUM_PCSD         0x00002000 /* packet checksum disabled */

/* GPY211 - I225 defines */
#define GPY_MMD_MASK            0xFFFF0000
#define GPY_MMD_SHIFT           16
#define GPY_REG_MASK            0x0000FFFF
/* Header split receive */
#define IGC_RFCTL_NFSW_DIS              0x00000040
#define IGC_RFCTL_NFSR_DIS              0x00000080
#define IGC_RFCTL_ACK_DIS               0x00001000
#define IGC_RFCTL_EXTEN                 0x00008000
#define IGC_RFCTL_IPV6_EX_DIS           0x00010000
#define IGC_RFCTL_NEW_IPV6_EXT_DIS      0x00020000
#define IGC_RFCTL_LEF                   0x00040000

/* Collision related configuration parameters */
#define IGC_CT_SHIFT                    4
#define IGC_COLLISION_THRESHOLD         15
#define IGC_COLLISION_DISTANCE          63
#define IGC_COLD_SHIFT                  12

/* Default values for the transmit IPG register */
#define DEFAULT_82543_TIPG_IPGT_FIBER   9
#define DEFAULT_82543_TIPG_IPGT_COPPER  8

#define IGC_TIPG_IPGT_MASK              0x000003FF

#define DEFAULT_82543_TIPG_IPGR1        8
#define IGC_TIPG_IPGR1_SHIFT            10

#define DEFAULT_82543_TIPG_IPGR2        6
#define DEFAULT_80003ES2LAN_TIPG_IPGR2  7
#define IGC_TIPG_IPGR2_SHIFT            20

/* Ethertype field values */
#define ETHERNET_IEEE_VLAN_TYPE         0x8100  /* 802.3ac packet */

#define ETHERNET_FCS_SIZE               4
#define MAX_JUMBO_FRAME_SIZE            MJUM9BYTES
#define IGC_TX_PTR_GAP                  0x1F

/* Extended Configuration Control and Size */
#define IGC_EXTCNF_CTRL_MDIO_SW_OWNERSHIP       0x00000020
#define IGC_EXTCNF_CTRL_LCD_WRITE_ENABLE        0x00000001
#define IGC_EXTCNF_CTRL_OEM_WRITE_ENABLE        0x00000008
#define IGC_EXTCNF_CTRL_SWFLAG                  0x00000020
#define IGC_EXTCNF_CTRL_GATE_PHY_CFG            0x00000080
#define IGC_EXTCNF_SIZE_EXT_PCIE_LENGTH_MASK    0x00FF0000
#define IGC_EXTCNF_SIZE_EXT_PCIE_LENGTH_SHIFT   16
#define IGC_EXTCNF_CTRL_EXT_CNF_POINTER_MASK    0x0FFF0000
#define IGC_EXTCNF_CTRL_EXT_CNF_POINTER_SHIFT   16

#define IGC_PHY_CTRL_D0A_LPLU                   0x00000002
#define IGC_PHY_CTRL_NOND0A_LPLU                0x00000004
#define IGC_PHY_CTRL_NOND0A_GBE_DISABLE         0x00000008
#define IGC_PHY_CTRL_GBE_DISABLE                0x00000040

#define IGC_KABGTXD_BGSQLBIAS                   0x00050000

/* PBA constants */
#define IGC_PBA_8K              0x0008    /* 8KB */
#define IGC_PBA_10K             0x000A    /* 10KB */
#define IGC_PBA_12K             0x000C    /* 12KB */
#define IGC_PBA_14K             0x000E    /* 14KB */
#define IGC_PBA_16K             0x0010    /* 16KB */
#define IGC_PBA_18K             0x0012
#define IGC_PBA_20K             0x0014
#define IGC_PBA_22K             0x0016
#define IGC_PBA_24K             0x0018
#define IGC_PBA_26K             0x001A
#define IGC_PBA_30K             0x001E
#define IGC_PBA_32K             0x0020
#define IGC_PBA_34K             0x0022
#define IGC_PBA_35K             0x0023
#define IGC_PBA_38K             0x0026
#define IGC_PBA_40K             0x0028
#define IGC_PBA_48K             0x0030    /* 48KB */
#define IGC_PBA_64K             0x0040    /* 64KB */

#define IGC_PBA_RXA_MASK        0xFFFF

#define IGC_PBS_16K             IGC_PBA_16K

/* Uncorrectable/correctable ECC Error counts and enable bits */
#define IGC_PBECCSTS_CORR_ERR_CNT_MASK          0x000000FF
#define IGC_PBECCSTS_UNCORR_ERR_CNT_MASK        0x0000FF00
#define IGC_PBECCSTS_UNCORR_ERR_CNT_SHIFT       8
#define IGC_PBECCSTS_ECC_ENABLE                 0x00010000

#define IFS_MAX                 80
#define IFS_MIN                 40
#define IFS_RATIO               4
#define IFS_STEP                10
#define MIN_NUM_XMITS           1000

/* SW Semaphore Register */
#define IGC_SWSM_SMBI           0x00000001 /* Driver Semaphore bit */
#define IGC_SWSM_SWESMBI        0x00000002 /* FW Semaphore bit */
#define IGC_SWSM_DRV_LOAD       0x00000008 /* Driver Loaded Bit */

#define IGC_SWSM2_LOCK          0x00000002 /* Secondary driver semaphore bit */

/* Interrupt Cause Read */
#define IGC_ICR_TXDW            0x00000001 /* Transmit desc written back */
#define IGC_ICR_TXQE            0x00000002 /* Transmit Queue empty */
#define IGC_ICR_LSC             0x00000004 /* Link Status Change */
#define IGC_ICR_RXSEQ           0x00000008 /* Rx sequence error */
#define IGC_ICR_RXDMT0          0x00000010 /* Rx desc min. threshold (0) */
#define IGC_ICR_RXO             0x00000040 /* Rx overrun */
#define IGC_ICR_RXT0            0x00000080 /* Rx timer intr (ring 0) */
#define IGC_ICR_RXCFG           0x00000400 /* Rx /c/ ordered set */
#define IGC_ICR_GPI_EN0         0x00000800 /* GP Int 0 */
#define IGC_ICR_GPI_EN1         0x00001000 /* GP Int 1 */
#define IGC_ICR_GPI_EN2         0x00002000 /* GP Int 2 */
#define IGC_ICR_GPI_EN3         0x00004000 /* GP Int 3 */
#define IGC_ICR_TXD_LOW         0x00008000
#define IGC_ICR_ECCER           0x00400000 /* Uncorrectable ECC Error */
#define IGC_ICR_TS              0x00080000 /* Time Sync Interrupt */
#define IGC_ICR_DRSTA           0x40000000 /* Device Reset Asserted */
/* If this bit asserted, the driver should claim the interrupt */
#define IGC_ICR_INT_ASSERTED    0x80000000
#define IGC_ICR_DOUTSYNC        0x10000000 /* NIC DMA out of sync */
#define IGC_ICR_FER             0x00400000 /* Fatal Error */



/* Extended Interrupt Cause Read */
#define IGC_EICR_RX_QUEUE0      0x00000001 /* Rx Queue 0 Interrupt */
#define IGC_EICR_RX_QUEUE1      0x00000002 /* Rx Queue 1 Interrupt */
#define IGC_EICR_RX_QUEUE2      0x00000004 /* Rx Queue 2 Interrupt */
#define IGC_EICR_RX_QUEUE3      0x00000008 /* Rx Queue 3 Interrupt */
#define IGC_EICR_TX_QUEUE0      0x00000100 /* Tx Queue 0 Interrupt */
#define IGC_EICR_TX_QUEUE1      0x00000200 /* Tx Queue 1 Interrupt */
#define IGC_EICR_TX_QUEUE2      0x00000400 /* Tx Queue 2 Interrupt */
#define IGC_EICR_TX_QUEUE3      0x00000800 /* Tx Queue 3 Interrupt */
#define IGC_EICR_TCP_TIMER      0x40000000 /* TCP Timer */
#define IGC_EICR_OTHER          0x80000000 /* Interrupt Cause Active */
/* TCP Timer */
#define IGC_TCPTIMER_KS                 0x00000100 /* KickStart */
#define IGC_TCPTIMER_COUNT_ENABLE       0x00000200 /* Count Enable */
#define IGC_TCPTIMER_COUNT_FINISH       0x00000400 /* Count finish */
#define IGC_TCPTIMER_LOOP               0x00000800 /* Loop */

/* This defines the bits that are set in the Interrupt Mask
 * Set/Read Register.  Each bit is documented below:
 *   o RXT0   = Receiver Timer Interrupt (ring 0)
 *   o TXDW   = Transmit Descriptor Written Back
 *   o RXDMT0 = Receive Descriptor Minimum Threshold hit (ring 0)
 *   o RXSEQ  = Receive Sequence Error
 *   o LSC    = Link Status Change
 */
#define IMS_ENABLE_MASK ( \
        IGC_IMS_RXT0   |    \
        IGC_IMS_TXDW   |    \
        IGC_IMS_RXDMT0 |    \
        IGC_IMS_RXSEQ  |    \
        IGC_IMS_LSC)

/* Interrupt Mask Set */
#define IGC_IMS_TXDW            IGC_ICR_TXDW    /* Tx desc written back */
#define IGC_IMS_LSC             IGC_ICR_LSC     /* Link Status Change */
#define IGC_IMS_RXSEQ           IGC_ICR_RXSEQ   /* Rx sequence error */
#define IGC_IMS_RXDMT0          IGC_ICR_RXDMT0  /* Rx desc min. threshold */
#define IGC_QVECTOR_MASK        0x7FFC          /* Q-vector mask */
#define IGC_ITR_VAL_MASK        0x04            /* ITR value mask */
#define IGC_IMS_RXO             IGC_ICR_RXO     /* Rx overrun */
#define IGC_IMS_RXT0            IGC_ICR_RXT0    /* Rx timer intr */
#define IGC_IMS_TXD_LOW         IGC_ICR_TXD_LOW
#define IGC_IMS_ECCER           IGC_ICR_ECCER   /* Uncorrectable ECC Error */
#define IGC_IMS_TS              IGC_ICR_TS      /* Time Sync Interrupt */
#define IGC_IMS_DRSTA           IGC_ICR_DRSTA   /* Device Reset Asserted */
#define IGC_IMS_DOUTSYNC        IGC_ICR_DOUTSYNC /* NIC DMA out of sync */
#define IGC_IMS_FER             IGC_ICR_FER /* Fatal Error */

#define IGC_IMS_THS             IGC_ICR_THS /* ICR.TS: Thermal Sensor Event*/
#define IGC_IMS_MDDET           IGC_ICR_MDDET /* Malicious Driver Detect */
/* Extended Interrupt Mask Set */
#define IGC_EIMS_RX_QUEUE0      IGC_EICR_RX_QUEUE0 /* Rx Queue 0 Interrupt */
#define IGC_EIMS_RX_QUEUE1      IGC_EICR_RX_QUEUE1 /* Rx Queue 1 Interrupt */
#define IGC_EIMS_RX_QUEUE2      IGC_EICR_RX_QUEUE2 /* Rx Queue 2 Interrupt */
#define IGC_EIMS_RX_QUEUE3      IGC_EICR_RX_QUEUE3 /* Rx Queue 3 Interrupt */
#define IGC_EIMS_TX_QUEUE0      IGC_EICR_TX_QUEUE0 /* Tx Queue 0 Interrupt */
#define IGC_EIMS_TX_QUEUE1      IGC_EICR_TX_QUEUE1 /* Tx Queue 1 Interrupt */
#define IGC_EIMS_TX_QUEUE2      IGC_EICR_TX_QUEUE2 /* Tx Queue 2 Interrupt */
#define IGC_EIMS_TX_QUEUE3      IGC_EICR_TX_QUEUE3 /* Tx Queue 3 Interrupt */
#define IGC_EIMS_TCP_TIMER      IGC_EICR_TCP_TIMER /* TCP Timer */
#define IGC_EIMS_OTHER          IGC_EICR_OTHER   /* Interrupt Cause Active */

/* Interrupt Cause Set */
#define IGC_ICS_LSC             IGC_ICR_LSC       /* Link Status Change */
#define IGC_ICS_RXSEQ           IGC_ICR_RXSEQ     /* Rx sequence error */
#define IGC_ICS_RXDMT0          IGC_ICR_RXDMT0    /* Rx desc min. threshold */

/* Extended Interrupt Cause Set */
#define IGC_EICS_RX_QUEUE0      IGC_EICR_RX_QUEUE0 /* Rx Queue 0 Interrupt */
#define IGC_EICS_RX_QUEUE1      IGC_EICR_RX_QUEUE1 /* Rx Queue 1 Interrupt */
#define IGC_EICS_RX_QUEUE2      IGC_EICR_RX_QUEUE2 /* Rx Queue 2 Interrupt */
#define IGC_EICS_RX_QUEUE3      IGC_EICR_RX_QUEUE3 /* Rx Queue 3 Interrupt */
#define IGC_EICS_TX_QUEUE0      IGC_EICR_TX_QUEUE0 /* Tx Queue 0 Interrupt */
#define IGC_EICS_TX_QUEUE1      IGC_EICR_TX_QUEUE1 /* Tx Queue 1 Interrupt */
#define IGC_EICS_TX_QUEUE2      IGC_EICR_TX_QUEUE2 /* Tx Queue 2 Interrupt */
#define IGC_EICS_TX_QUEUE3      IGC_EICR_TX_QUEUE3 /* Tx Queue 3 Interrupt */
#define IGC_EICS_TCP_TIMER      IGC_EICR_TCP_TIMER /* TCP Timer */
#define IGC_EICS_OTHER          IGC_EICR_OTHER   /* Interrupt Cause Active */

#define IGC_EITR_ITR_INT_MASK   0x0000FFFF
#define IGC_EITR_INTERVAL       0x00007FFC
/* IGC_EITR_CNT_IGNR is only for 82576 and newer */
#define IGC_EITR_CNT_IGNR       0x80000000 /* Don't reset counters on write */

/* Transmit Descriptor Control */
#define IGC_TXDCTL_PTHRESH      0x0000003F /* TXDCTL Prefetch Threshold */
#define IGC_TXDCTL_HTHRESH      0x00003F00 /* TXDCTL Host Threshold */
#define IGC_TXDCTL_WTHRESH      0x003F0000 /* TXDCTL Writeback Threshold */
#define IGC_TXDCTL_GRAN         0x01000000 /* TXDCTL Granularity */
#define IGC_TXDCTL_FULL_TX_DESC_WB      0x01010000 /* GRAN=1, WTHRESH=1 */
#define IGC_TXDCTL_MAX_TX_DESC_PREFETCH 0x0100001F /* GRAN=1, PTHRESH=31 */
/* Enable the counting of descriptors still to be processed. */
#define IGC_TXDCTL_COUNT_DESC   0x00400000

/* Flow Control Constants */
#define FLOW_CONTROL_ADDRESS_LOW        0x00C28001
#define FLOW_CONTROL_ADDRESS_HIGH       0x00000100
#define FLOW_CONTROL_TYPE               0x8808

/* 802.1q VLAN Packet Size */
#define VLAN_TAG_SIZE                   4    /* 802.3ac tag (not DMA'd) */
#define IGC_VLAN_FILTER_TBL_SIZE        128  /* VLAN Filter Table (4096 bits) */

/* Receive Address
 * Number of high/low register pairs in the RAR. The RAR (Receive Address
 * Registers) holds the directed and multicast addresses that we monitor.
 * Technically, we have 16 spots.  However, we reserve one of these spots
 * (RAR[15]) for our directed address used by controllers with
 * manageability enabled, allowing us room for 15 multicast addresses.
 */
#define IGC_RAR_ENTRIES         15
#define IGC_RAH_AV              0x80000000 /* Receive descriptor valid */
#define IGC_RAL_MAC_ADDR_LEN    4
#define IGC_RAH_MAC_ADDR_LEN    2

/* Error Codes */
#define IGC_SUCCESS                     0
#define IGC_ERR_NVM                     1
#define IGC_ERR_PHY                     2
#define IGC_ERR_CONFIG                  3
#define IGC_ERR_PARAM                   4
#define IGC_ERR_MAC_INIT                5
#define IGC_ERR_PHY_TYPE                6
#define IGC_ERR_RESET                   9
#define IGC_ERR_MASTER_REQUESTS_PENDING 10
#define IGC_ERR_HOST_INTERFACE_COMMAND  11
#define IGC_BLK_PHY_RESET               12
#define IGC_ERR_SWFW_SYNC               13
#define IGC_NOT_IMPLEMENTED             14
#define IGC_ERR_MBX                     15
#define IGC_ERR_INVALID_ARGUMENT        16
#define IGC_ERR_NO_SPACE                17
#define IGC_ERR_NVM_PBA_SECTION         18
#define IGC_ERR_INVM_VALUE_NOT_FOUND    20

/* Loop limit on how long we wait for auto-negotiation to complete */
#define COPPER_LINK_UP_LIMIT            10
#define PHY_AUTO_NEG_LIMIT              45
/* Number of 100 microseconds we wait for PCI Express master disable */
#define MASTER_DISABLE_TIMEOUT          800
/* Number of milliseconds we wait for PHY configuration done after MAC reset */
#define PHY_CFG_TIMEOUT                 100
/* Number of 2 milliseconds we wait for acquiring MDIO ownership. */
#define MDIO_OWNERSHIP_TIMEOUT          10
/* Number of milliseconds for NVM auto read done after MAC reset. */
#define AUTO_READ_DONE_TIMEOUT          10

/* Flow Control */
#define IGC_FCRTH_RTH           0x0000FFF8 /* Mask Bits[15:3] for RTH */
#define IGC_FCRTL_RTL           0x0000FFF8 /* Mask Bits[15:3] for RTL */
#define IGC_FCRTL_XONE          0x80000000 /* Enable XON frame transmission */

/* Transmit Configuration Word */
#define IGC_TXCW_FD             0x00000020 /* TXCW full duplex */
#define IGC_TXCW_PAUSE          0x00000080 /* TXCW sym pause request */
#define IGC_TXCW_ASM_DIR        0x00000100 /* TXCW astm pause direction */
#define IGC_TXCW_PAUSE_MASK     0x00000180 /* TXCW pause request mask */
#define IGC_TXCW_ANE            0x80000000 /* Auto-neg enable */

/* Receive Configuration Word */
#define IGC_RXCW_CW             0x0000ffff /* RxConfigWord mask */
#define IGC_RXCW_IV             0x08000000 /* Receive config invalid */
#define IGC_RXCW_C              0x20000000 /* Receive config */
#define IGC_RXCW_SYNCH          0x40000000 /* Receive config synch */

#define IGC_TSYNCTXCTL_TXTT_0   0x00000001 /* Tx timestamp reg 0 valid */
#define IGC_TSYNCTXCTL_ENABLED  0x00000010 /* enable Tx timestamping */

#define IGC_TSYNCRXCTL_VALID            0x00000001 /* Rx timestamp valid */
#define IGC_TSYNCRXCTL_TYPE_MASK        0x0000000E /* Rx type mask */
#define IGC_TSYNCRXCTL_TYPE_L2_V2       0x00
#define IGC_TSYNCRXCTL_TYPE_L4_V1       0x02
#define IGC_TSYNCRXCTL_TYPE_L2_L4_V2    0x04
#define IGC_TSYNCRXCTL_TYPE_ALL         0x08
#define IGC_TSYNCRXCTL_TYPE_EVENT_V2    0x0A
#define IGC_TSYNCRXCTL_ENABLED          0x00000010 /* enable Rx timestamping */
#define IGC_TSYNCRXCTL_SYSCFI           0x00000020 /* Sys clock frequency */

#define IGC_TSYNCRXCFG_PTP_V1_CTRLT_MASK                0x000000FF
#define IGC_TSYNCRXCFG_PTP_V1_SYNC_MESSAGE              0x00
#define IGC_TSYNCRXCFG_PTP_V1_DELAY_REQ_MESSAGE         0x01
#define IGC_TSYNCRXCFG_PTP_V1_FOLLOWUP_MESSAGE          0x02
#define IGC_TSYNCRXCFG_PTP_V1_DELAY_RESP_MESSAGE        0x03
#define IGC_TSYNCRXCFG_PTP_V1_MANAGEMENT_MESSAGE        0x04

#define IGC_TSYNCRXCFG_PTP_V2_MSGID_MASK                0x00000F00
#define IGC_TSYNCRXCFG_PTP_V2_SYNC_MESSAGE              0x0000
#define IGC_TSYNCRXCFG_PTP_V2_DELAY_REQ_MESSAGE         0x0100
#define IGC_TSYNCRXCFG_PTP_V2_PATH_DELAY_REQ_MESSAGE    0x0200
#define IGC_TSYNCRXCFG_PTP_V2_PATH_DELAY_RESP_MESSAGE   0x0300
#define IGC_TSYNCRXCFG_PTP_V2_FOLLOWUP_MESSAGE          0x0800
#define IGC_TSYNCRXCFG_PTP_V2_DELAY_RESP_MESSAGE        0x0900
#define IGC_TSYNCRXCFG_PTP_V2_PATH_DELAY_FOLLOWUP_MESSAGE 0x0A00
#define IGC_TSYNCRXCFG_PTP_V2_ANNOUNCE_MESSAGE          0x0B00
#define IGC_TSYNCRXCFG_PTP_V2_SIGNALLING_MESSAGE        0x0C00
#define IGC_TSYNCRXCFG_PTP_V2_MANAGEMENT_MESSAGE        0x0D00

#define IGC_TIMINCA_16NS_SHIFT          24
#define IGC_TIMINCA_INCPERIOD_SHIFT     24
#define IGC_TIMINCA_INCVALUE_MASK       0x00FFFFFF

/* Time Sync Interrupt Cause/Mask Register Bits */
#define TSINTR_SYS_WRAP (1 << 0) /* SYSTIM Wrap around. */
#define TSINTR_TXTS     (1 << 1) /* Transmit Timestamp. */
#define TSINTR_TT0      (1 << 3) /* Target Time 0 Trigger. */
#define TSINTR_TT1      (1 << 4) /* Target Time 1 Trigger. */
#define TSINTR_AUTT0    (1 << 5) /* Auxiliary Timestamp 0 Taken. */
#define TSINTR_AUTT1    (1 << 6) /* Auxiliary Timestamp 1 Taken. */

#define TSYNC_INTERRUPTS        TSINTR_TXTS

/* TSAUXC Configuration Bits */
#define TSAUXC_EN_TT0   (1 << 0)  /* Enable target time 0. */
#define TSAUXC_EN_TT1   (1 << 1)  /* Enable target time 1. */
#define TSAUXC_EN_CLK0  (1 << 2)  /* Enable Configurable Frequency Clock 0. */
#define TSAUXC_ST0      (1 << 4)  /* Start Clock 0 Toggle on Target Time 0. */
#define TSAUXC_EN_CLK1  (1 << 5)  /* Enable Configurable Frequency Clock 1. */
#define TSAUXC_ST1      (1 << 7)  /* Start Clock 1 Toggle on Target Time 1. */
#define TSAUXC_EN_TS0   (1 << 8)  /* Enable hardware timestamp 0. */
#define TSAUXC_EN_TS1   (1 << 10) /* Enable hardware timestamp 0. */

/* SDP Configuration Bits */
#define AUX0_SEL_SDP0   (0u << 0)  /* Assign SDP0 to auxiliary time stamp 0. */
#define AUX0_SEL_SDP1   (1u << 0)  /* Assign SDP1 to auxiliary time stamp 0. */
#define AUX0_SEL_SDP2   (2u << 0)  /* Assign SDP2 to auxiliary time stamp 0. */
#define AUX0_SEL_SDP3   (3u << 0)  /* Assign SDP3 to auxiliary time stamp 0. */
#define AUX0_TS_SDP_EN  (1u << 2)  /* Enable auxiliary time stamp trigger 0. */
#define AUX1_SEL_SDP0   (0u << 3)  /* Assign SDP0 to auxiliary time stamp 1. */
#define AUX1_SEL_SDP1   (1u << 3)  /* Assign SDP1 to auxiliary time stamp 1. */
#define AUX1_SEL_SDP2   (2u << 3)  /* Assign SDP2 to auxiliary time stamp 1. */
#define AUX1_SEL_SDP3   (3u << 3)  /* Assign SDP3 to auxiliary time stamp 1. */
#define AUX1_TS_SDP_EN  (1u << 5)  /* Enable auxiliary time stamp trigger 1. */
#define TS_SDP0_EN      (1u << 8)  /* SDP0 is assigned to Tsync. */
#define TS_SDP1_EN      (1u << 11) /* SDP1 is assigned to Tsync. */
#define TS_SDP2_EN      (1u << 14) /* SDP2 is assigned to Tsync. */
#define TS_SDP3_EN      (1u << 17) /* SDP3 is assigned to Tsync. */
#define TS_SDP0_SEL_TT0 (0u << 6)  /* Target time 0 is output on SDP0. */
#define TS_SDP0_SEL_TT1 (1u << 6)  /* Target time 1 is output on SDP0. */
#define TS_SDP1_SEL_TT0 (0u << 9)  /* Target time 0 is output on SDP1. */
#define TS_SDP1_SEL_TT1 (1u << 9)  /* Target time 1 is output on SDP1. */
#define TS_SDP0_SEL_FC0 (2u << 6)  /* Freq clock  0 is output on SDP0. */
#define TS_SDP0_SEL_FC1 (3u << 6)  /* Freq clock  1 is output on SDP0. */
#define TS_SDP1_SEL_FC0 (2u << 9)  /* Freq clock  0 is output on SDP1. */
#define TS_SDP1_SEL_FC1 (3u << 9)  /* Freq clock  1 is output on SDP1. */
#define TS_SDP2_SEL_TT0 (0u << 12) /* Target time 0 is output on SDP2. */
#define TS_SDP2_SEL_TT1 (1u << 12) /* Target time 1 is output on SDP2. */
#define TS_SDP2_SEL_FC0 (2u << 12) /* Freq clock  0 is output on SDP2. */
#define TS_SDP2_SEL_FC1 (3u << 12) /* Freq clock  1 is output on SDP2. */
#define TS_SDP3_SEL_TT0 (0u << 15) /* Target time 0 is output on SDP3. */
#define TS_SDP3_SEL_TT1 (1u << 15) /* Target time 1 is output on SDP3. */
#define TS_SDP3_SEL_FC0 (2u << 15) /* Freq clock  0 is output on SDP3. */
#define TS_SDP3_SEL_FC1 (3u << 15) /* Freq clock  1 is output on SDP3. */

#define IGC_CTRL_SDP0_DIR       0x00400000  /* SDP0 Data direction */
#define IGC_CTRL_SDP1_DIR       0x00800000  /* SDP1 Data direction */

/* Extended Device Control */
#define IGC_CTRL_EXT_SDP2_DIR   0x00000400 /* SDP2 Data direction */

/* ETQF register bit definitions */
#define IGC_ETQF_1588                   (1 << 30)
#define IGC_FTQF_VF_BP                  0x00008000
#define IGC_FTQF_1588_TIME_STAMP        0x08000000
#define IGC_FTQF_MASK                   0xF0000000
#define IGC_FTQF_MASK_PROTO_BP          0x10000000
/* Immediate Interrupt Rx (A.K.A. Low Latency Interrupt) */
#define IGC_IMIREXT_CTRL_BP     0x00080000  /* Bypass check of ctrl bits */
#define IGC_IMIREXT_SIZE_BP     0x00001000  /* Packet size bypass */

#define IGC_RXDADV_STAT_TSIP            0x08000 /* timestamp in packet */
#define IGC_TSICR_TXTS                  0x00000002
#define IGC_TSIM_TXTS                   0x00000002
/* TUPLE Filtering Configuration */
#define IGC_TTQF_DISABLE_MASK           0xF0008000 /* TTQF Disable Mask */
#define IGC_TTQF_QUEUE_ENABLE           0x100   /* TTQF Queue Enable Bit */
#define IGC_TTQF_PROTOCOL_MASK          0xFF    /* TTQF Protocol Mask */
/* TTQF TCP Bit, shift with IGC_TTQF_PROTOCOL SHIFT */
#define IGC_TTQF_PROTOCOL_TCP           0x0
/* TTQF UDP Bit, shift with IGC_TTQF_PROTOCOL_SHIFT */
#define IGC_TTQF_PROTOCOL_UDP           0x1
/* TTQF SCTP Bit, shift with IGC_TTQF_PROTOCOL_SHIFT */
#define IGC_TTQF_PROTOCOL_SCTP          0x2
#define IGC_TTQF_PROTOCOL_SHIFT         5       /* TTQF Protocol Shift */
#define IGC_TTQF_QUEUE_SHIFT            16      /* TTQF Queue Shfit */
#define IGC_TTQF_RX_QUEUE_MASK          0x70000 /* TTQF Queue Mask */
#define IGC_TTQF_MASK_ENABLE            0x10000000 /* TTQF Mask Enable Bit */
#define IGC_IMIR_CLEAR_MASK             0xF001FFFF /* IMIR Reg Clear Mask */
#define IGC_IMIR_PORT_BYPASS            0x20000 /* IMIR Port Bypass Bit */
#define IGC_IMIR_PRIORITY_SHIFT         29 /* IMIR Priority Shift */
#define IGC_IMIREXT_CLEAR_MASK          0x7FFFF /* IMIREXT Reg Clear Mask */

#define IGC_MDICNFG_EXT_MDIO            0x80000000 /* MDI ext/int destination */
#define IGC_MDICNFG_COM_MDIO            0x40000000 /* MDI shared w/ lan 0 */
#define IGC_MDICNFG_PHY_MASK            0x03E00000
#define IGC_MDICNFG_PHY_SHIFT           21

#define IGC_MEDIA_PORT_COPPER                   1
#define IGC_MEDIA_PORT_OTHER                    2
#define IGC_M88E1112_AUTO_COPPER_SGMII          0x2
#define IGC_M88E1112_AUTO_COPPER_BASEX          0x3
#define IGC_M88E1112_STATUS_LINK                0x0004 /* Interface Link Bit */
#define IGC_M88E1112_MAC_CTRL_1                 0x10
#define IGC_M88E1112_MAC_CTRL_1_MODE_MASK       0x0380 /* Mode Select */
#define IGC_M88E1112_MAC_CTRL_1_MODE_SHIFT      7
#define IGC_M88E1112_PAGE_ADDR                  0x16
#define IGC_M88E1112_STATUS                     0x01

#define IGC_THSTAT_LOW_EVENT            0x20000000 /* Low thermal threshold */
#define IGC_THSTAT_MID_EVENT            0x00200000 /* Mid thermal threshold */
#define IGC_THSTAT_HIGH_EVENT           0x00002000 /* High thermal threshold */
#define IGC_THSTAT_PWR_DOWN             0x00000001 /* Power Down Event */
#define IGC_THSTAT_LINK_THROTTLE        0x00000002 /* Link Spd Throttle Event */

/* EEE defines */
#define IGC_IPCNFG_EEE_2_5G_AN          0x00000010 /* IPCNFG EEE Ena 2.5G AN */
#define IGC_IPCNFG_EEE_1G_AN            0x00000008 /* IPCNFG EEE Ena 1G AN */
#define IGC_IPCNFG_EEE_100M_AN          0x00000004 /* IPCNFG EEE Ena 100M AN */
#define IGC_EEER_TX_LPI_EN              0x00010000 /* EEER Tx LPI Enable */
#define IGC_EEER_RX_LPI_EN              0x00020000 /* EEER Rx LPI Enable */
#define IGC_EEER_LPI_FC                 0x00040000 /* EEER Ena on Flow Cntrl */
/* EEE status */
#define IGC_EEER_EEE_NEG                0x20000000 /* EEE capability nego */
#define IGC_EEER_RX_LPI_STATUS          0x40000000 /* Rx in LPI state */
#define IGC_EEER_TX_LPI_STATUS          0x80000000 /* Tx in LPI state */
#define IGC_EEE_LP_ADV_ADDR_I350        0x040F     /* EEE LP Advertisement */
#define IGC_M88E1543_PAGE_ADDR          0x16       /* Page Offset Register */
#define IGC_M88E1543_EEE_CTRL_1         0x0
#define IGC_M88E1543_EEE_CTRL_1_MS      0x0001     /* EEE Master/Slave */
#define IGC_M88E1543_FIBER_CTRL         0x0        /* Fiber Control Register */
#define IGC_EEE_ADV_DEV_I354            7
#define IGC_EEE_ADV_ADDR_I354           60
#define IGC_EEE_ADV_100_SUPPORTED       (1 << 1)   /* 100BaseTx EEE Supported */
#define IGC_EEE_ADV_1000_SUPPORTED      (1 << 2)   /* 1000BaseT EEE Supported */
#define IGC_PCS_STATUS_DEV_I354         3
#define IGC_PCS_STATUS_ADDR_I354        1
#define IGC_PCS_STATUS_RX_LPI_RCVD      0x0400
#define IGC_PCS_STATUS_TX_LPI_RCVD      0x0800
#define IGC_M88E1512_CFG_REG_1          0x0010
#define IGC_M88E1512_CFG_REG_2          0x0011
#define IGC_M88E1512_CFG_REG_3          0x0007
#define IGC_M88E1512_MODE               0x0014
#define IGC_EEE_SU_LPI_CLK_STP          0x00800000 /* EEE LPI Clock Stop */
#define IGC_EEE_LP_ADV_DEV_I225         7          /* EEE LP Adv Device */
#define IGC_EEE_LP_ADV_ADDR_I225        61         /* EEE LP Adv Register */

#define IGC_MMDAC_FUNC_DATA             0x4000 /* Data, no post increment */

/* PHY Control Register */
#define MII_CR_SPEED_SELECT_MSB 0x0040  /* bits 6,13: 10=1000, 01=100, 00=10 */
#define MII_CR_COLL_TEST_ENABLE 0x0080  /* Collision test enable */
#define MII_CR_FULL_DUPLEX      0x0100  /* FDX =1, half duplex =0 */
#define MII_CR_RESTART_AUTO_NEG 0x0200  /* Restart auto negotiation */
#define MII_CR_ISOLATE          0x0400  /* Isolate PHY from MII */
#define MII_CR_POWER_DOWN       0x0800  /* Power down */
#define MII_CR_AUTO_NEG_EN      0x1000  /* Auto Neg Enable */
#define MII_CR_SPEED_SELECT_LSB 0x2000  /* bits 6,13: 10=1000, 01=100, 00=10 */
#define MII_CR_LOOPBACK         0x4000  /* 0 = normal, 1 = loopback */
#define MII_CR_RESET            0x8000  /* 0 = normal, 1 = PHY reset */
#define MII_CR_SPEED_1000       0x0040
#define MII_CR_SPEED_100        0x2000
#define MII_CR_SPEED_10         0x0000

/* PHY Status Register */
#define MII_SR_EXTENDED_CAPS    0x0001 /* Extended register capabilities */
#define MII_SR_JABBER_DETECT    0x0002 /* Jabber Detected */
#define MII_SR_LINK_STATUS      0x0004 /* Link Status 1 = link */
#define MII_SR_AUTONEG_CAPS     0x0008 /* Auto Neg Capable */
#define MII_SR_REMOTE_FAULT     0x0010 /* Remote Fault Detect */
#define MII_SR_AUTONEG_COMPLETE 0x0020 /* Auto Neg Complete */
#define MII_SR_PREAMBLE_SUPPRESS 0x0040 /* Preamble may be suppressed */
#define MII_SR_EXTENDED_STATUS  0x0100 /* Ext. status info in Reg 0x0F */
#define MII_SR_100T2_HD_CAPS    0x0200 /* 100T2 Half Duplex Capable */
#define MII_SR_100T2_FD_CAPS    0x0400 /* 100T2 Full Duplex Capable */
#define MII_SR_10T_HD_CAPS      0x0800 /* 10T   Half Duplex Capable */
#define MII_SR_10T_FD_CAPS      0x1000 /* 10T   Full Duplex Capable */
#define MII_SR_100X_HD_CAPS     0x2000 /* 100X  Half Duplex Capable */
#define MII_SR_100X_FD_CAPS     0x4000 /* 100X  Full Duplex Capable */
#define MII_SR_100T4_CAPS       0x8000 /* 100T4 Capable */

/* Autoneg Advertisement Register */
#define NWAY_AR_SELECTOR_FIELD  0x0001   /* indicates IEEE 802.3 CSMA/CD */
#define NWAY_AR_10T_HD_CAPS     0x0020   /* 10T   Half Duplex Capable */
#define NWAY_AR_10T_FD_CAPS     0x0040   /* 10T   Full Duplex Capable */
#define NWAY_AR_100TX_HD_CAPS   0x0080   /* 100TX Half Duplex Capable */
#define NWAY_AR_100TX_FD_CAPS   0x0100   /* 100TX Full Duplex Capable */
#define NWAY_AR_100T4_CAPS      0x0200   /* 100T4 Capable */
#define NWAY_AR_PAUSE           0x0400   /* Pause operation desired */
#define NWAY_AR_ASM_DIR         0x0800   /* Asymmetric Pause Direction bit */
#define NWAY_AR_REMOTE_FAULT    0x2000   /* Remote Fault detected */
#define NWAY_AR_NEXT_PAGE       0x8000   /* Next Page ability supported */

/* Link Partner Ability Register (Base Page) */
#define NWAY_LPAR_SELECTOR_FIELD        0x0000 /* LP protocol selector field */
#define NWAY_LPAR_10T_HD_CAPS           0x0020 /* LP 10T Half Dplx Capable */
#define NWAY_LPAR_10T_FD_CAPS           0x0040 /* LP 10T Full Dplx Capable */
#define NWAY_LPAR_100TX_HD_CAPS         0x0080 /* LP 100TX Half Dplx Capable */
#define NWAY_LPAR_100TX_FD_CAPS         0x0100 /* LP 100TX Full Dplx Capable */
#define NWAY_LPAR_100T4_CAPS            0x0200 /* LP is 100T4 Capable */
#define NWAY_LPAR_PAUSE                 0x0400 /* LP Pause operation desired */
#define NWAY_LPAR_ASM_DIR               0x0800 /* LP Asym Pause Direction bit */
#define NWAY_LPAR_REMOTE_FAULT          0x2000 /* LP detected Remote Fault */
#define NWAY_LPAR_ACKNOWLEDGE           0x4000 /* LP rx'd link code word */
#define NWAY_LPAR_NEXT_PAGE             0x8000 /* Next Page ability supported */

/* Autoneg Expansion Register */
#define NWAY_ER_LP_NWAY_CAPS            0x0001 /* LP has Auto Neg Capability */
#define NWAY_ER_PAGE_RXD                0x0002 /* LP 10T Half Dplx Capable */
#define NWAY_ER_NEXT_PAGE_CAPS          0x0004 /* LP 10T Full Dplx Capable */
#define NWAY_ER_LP_NEXT_PAGE_CAPS       0x0008 /* LP 100TX Half Dplx Capable */
#define NWAY_ER_PAR_DETECT_FAULT        0x0010 /* LP 100TX Full Dplx Capable */

/* 1000BASE-T Control Register */
#define CR_1000T_ASYM_PAUSE     0x0080 /* Advertise asymmetric pause bit */
#define CR_1000T_HD_CAPS        0x0100 /* Advertise 1000T HD capability */
#define CR_1000T_FD_CAPS        0x0200 /* Advertise 1000T FD capability  */
/* 1=Repeater/switch device port 0=DTE device */
#define CR_1000T_REPEATER_DTE   0x0400
/* 1=Configure PHY as Master 0=Configure PHY as Slave */
#define CR_1000T_MS_VALUE       0x0800
/* 1=Master/Slave manual config value 0=Automatic Master/Slave config */
#define CR_1000T_MS_ENABLE      0x1000
#define CR_1000T_TEST_MODE_NORMAL 0x0000 /* Normal Operation */
#define CR_1000T_TEST_MODE_1    0x2000 /* Transmit Waveform test */
#define CR_1000T_TEST_MODE_2    0x4000 /* Master Transmit Jitter test */
#define CR_1000T_TEST_MODE_3    0x6000 /* Slave Transmit Jitter test */
#define CR_1000T_TEST_MODE_4    0x8000 /* Transmitter Distortion test */

/* 1000BASE-T Status Register */
#define SR_1000T_IDLE_ERROR_CNT         0x00FF /* Num idle err since last rd */
#define SR_1000T_ASYM_PAUSE_DIR         0x0100 /* LP asym pause direction bit */
#define SR_1000T_LP_HD_CAPS             0x0400 /* LP is 1000T HD capable */
#define SR_1000T_LP_FD_CAPS             0x0800 /* LP is 1000T FD capable */
#define SR_1000T_REMOTE_RX_STATUS       0x1000 /* Remote receiver OK */
#define SR_1000T_LOCAL_RX_STATUS        0x2000 /* Local receiver OK */
#define SR_1000T_MS_CONFIG_RES          0x4000 /* 1=Local Tx Master, 0=Slave */
#define SR_1000T_MS_CONFIG_FAULT        0x8000 /* Master/Slave config fault */

#define SR_1000T_PHY_EXCESSIVE_IDLE_ERR_COUNT   5

/* PHY 1000 MII Register/Bit Definitions */
/* PHY Registers defined by IEEE */
#define PHY_CONTROL             0x00 /* Control Register */
#define PHY_STATUS              0x01 /* Status Register */
#define PHY_ID1                 0x02 /* Phy Id Reg (word 1) */
#define PHY_ID2                 0x03 /* Phy Id Reg (word 2) */
#define PHY_AUTONEG_ADV         0x04 /* Autoneg Advertisement */
#define PHY_LP_ABILITY          0x05 /* Link Partner Ability (Base Page) */
#define PHY_AUTONEG_EXP         0x06 /* Autoneg Expansion Reg */
#define PHY_NEXT_PAGE_TX        0x07 /* Next Page Tx */
#define PHY_LP_NEXT_PAGE        0x08 /* Link Partner Next Page */
#define PHY_1000T_CTRL          0x09 /* 1000Base-T Control Reg */
#define PHY_1000T_STATUS        0x0A /* 1000Base-T Status Reg */
#define PHY_EXT_STATUS          0x0F /* Extended Status Reg */

/* PHY GPY 211 registers */
#define STANDARD_AN_REG_MASK    0x0007 /* MMD */
#define ANEG_MULTIGBT_AN_CTRL   0x0020 /* MULTI GBT AN Control Register */
#define MMD_DEVADDR_SHIFT       16     /* Shift MMD to higher bits */
#define CR_2500T_FD_CAPS        0x0080 /* Advertise 2500T FD capability */

#define PHY_CONTROL_LB          0x4000 /* PHY Loopback bit */

/* NVM Control */
#define IGC_EECD_SK             0x00000001 /* NVM Clock */
#define IGC_EECD_CS             0x00000002 /* NVM Chip Select */
#define IGC_EECD_DI             0x00000004 /* NVM Data In */
#define IGC_EECD_DO             0x00000008 /* NVM Data Out */
#define IGC_EECD_REQ            0x00000040 /* NVM Access Request */
#define IGC_EECD_GNT            0x00000080 /* NVM Access Grant */
#define IGC_EECD_PRES           0x00000100 /* NVM Present */
#define IGC_EECD_SIZE           0x00000200 /* NVM Size (0=64 word 1=256 word) */
/* NVM Addressing bits based on type 0=small, 1=large */
#define IGC_EECD_ADDR_BITS      0x00000400
#define IGC_NVM_GRANT_ATTEMPTS  1000 /* NVM # attempts to gain grant */
#define IGC_EECD_AUTO_RD        0x00000200  /* NVM Auto Read done */
#define IGC_EECD_SIZE_EX_MASK   0x00007800  /* NVM Size */
#define IGC_EECD_SIZE_EX_SHIFT  11
#define IGC_EECD_FLUPD          0x00080000 /* Update FLASH */
#define IGC_EECD_AUPDEN         0x00100000 /* Ena Auto FLASH update */
#define IGC_EECD_SEC1VAL        0x00400000 /* Sector One Valid */
#define IGC_EECD_SEC1VAL_VALID_MASK     (IGC_EECD_AUTO_RD | IGC_EECD_PRES)

#define IGC_EECD_FLUPD_I225             0x00800000 /* Update FLASH */
#define IGC_EECD_FLUDONE_I225           0x04000000 /* Update FLASH done */
#define IGC_EECD_FLASH_DETECTED_I225    0x00080000 /* FLASH detected */
#define IGC_FLUDONE_ATTEMPTS            20000
#define IGC_EERD_EEWR_MAX_COUNT         512 /* buffered EEPROM words rw */
#define IGC_EECD_SEC1VAL_I225           0x02000000 /* Sector One Valid */
#define IGC_FLSECU_BLK_SW_ACCESS_I225   0x00000004 /* Block SW access */
#define IGC_FWSM_FW_VALID_I225          0x8000 /* FW valid bit */

#define IGC_NVM_RW_REG_DATA     16  /* Offset to data in NVM read/write regs */
#define IGC_NVM_RW_REG_DONE     2   /* Offset to READ/WRITE done bit */
#define IGC_NVM_RW_REG_START    1   /* Start operation */
#define IGC_NVM_RW_ADDR_SHIFT   2   /* Shift to the address bits */
#define IGC_NVM_POLL_WRITE      1   /* Flag for polling for write complete */
#define IGC_NVM_POLL_READ       0   /* Flag for polling for read complete */
#define IGC_FLASH_UPDATES       2000

/* NVM Word Offsets */
#define NVM_COMPAT                              0x0003
#define NVM_ID_LED_SETTINGS                     0x0004
#define NVM_VERSION                             0x0005
#define NVM_FUTURE_INIT_WORD1                   0x0019
#define NVM_COMPAT_VALID_CSUM                   0x0001
#define NVM_FUTURE_INIT_WORD1_VALID_CSUM        0x0040
#define NVM_ETRACK_WORD                         0x0042
#define NVM_ETRACK_HIWORD                       0x0043
#define NVM_COMB_VER_OFF                        0x0083
#define NVM_COMB_VER_PTR                        0x003d

/* NVM version defines */
#define NVM_MAJOR_MASK                  0xF000
#define NVM_MINOR_MASK                  0x0FF0
#define NVM_IMAGE_ID_MASK               0x000F
#define NVM_COMB_VER_MASK               0x00FF
#define NVM_MAJOR_SHIFT                 12
#define NVM_MINOR_SHIFT                 4
#define NVM_COMB_VER_SHFT               8
#define NVM_VER_INVALID                 0xFFFF
#define NVM_ETRACK_SHIFT                16
#define NVM_ETRACK_VALID                0x8000
#define NVM_NEW_DEC_MASK                0x0F00
#define NVM_HEX_CONV                    16
#define NVM_HEX_TENS                    10

#define NVM_INIT_CONTROL2_REG           0x000F
#define NVM_INIT_CONTROL3_PORT_B        0x0014
#define NVM_INIT_3GIO_3                 0x001A
#define NVM_SWDEF_PINS_CTRL_PORT_0      0x0020
#define NVM_INIT_CONTROL3_PORT_A        0x0024
#define NVM_CFG                         0x0012
#define NVM_ALT_MAC_ADDR_PTR            0x0037
#define NVM_CHECKSUM_REG                0x003F

#define IGC_NVM_CFG_DONE_PORT_0 0x040000 /* MNG config cycle done */
#define IGC_NVM_CFG_DONE_PORT_1 0x080000 /* ...for second port */

/* Mask bits for fields in Word 0x0f of the NVM */
#define NVM_WORD0F_PAUSE_MASK           0x3000
#define NVM_WORD0F_PAUSE                0x1000
#define NVM_WORD0F_ASM_DIR              0x2000

/* Mask bits for fields in Word 0x1a of the NVM */
#define NVM_WORD1A_ASPM_MASK            0x000C

/* Mask bits for fields in Word 0x03 of the EEPROM */
#define NVM_COMPAT_LOM                  0x0800

/* length of string needed to store PBA number */
#define IGC_PBANUM_LENGTH               11

/* For checksumming, the sum of all words in the NVM should equal 0xBABA. */
#define NVM_SUM                         0xBABA

/* PBA (printed board assembly) number words */
#define NVM_PBA_OFFSET_0                8
#define NVM_PBA_OFFSET_1                9
#define NVM_PBA_PTR_GUARD               0xFAFA
#define NVM_WORD_SIZE_BASE_SHIFT        6

/* NVM Commands - Microwire */
#define NVM_READ_OPCODE_MICROWIRE       0x6  /* NVM read opcode */
#define NVM_WRITE_OPCODE_MICROWIRE      0x5  /* NVM write opcode */
#define NVM_ERASE_OPCODE_MICROWIRE      0x7  /* NVM erase opcode */
#define NVM_EWEN_OPCODE_MICROWIRE       0x13 /* NVM erase/write enable */
#define NVM_EWDS_OPCODE_MICROWIRE       0x10 /* NVM erase/write disable */

/* NVM Commands - SPI */
#define NVM_MAX_RETRY_SPI       5000 /* Max wait of 5ms, for RDY signal */
#define NVM_READ_OPCODE_SPI     0x03 /* NVM read opcode */
#define NVM_WRITE_OPCODE_SPI    0x02 /* NVM write opcode */
#define NVM_A8_OPCODE_SPI       0x08 /* opcode bit-3 = address bit-8 */
#define NVM_WREN_OPCODE_SPI     0x06 /* NVM set Write Enable latch */
#define NVM_RDSR_OPCODE_SPI     0x05 /* NVM read Status register */

/* SPI NVM Status Register */
#define NVM_STATUS_RDY_SPI      0x01

/* Word definitions for ID LED Settings */
#define ID_LED_RESERVED_0000    0x0000
#define ID_LED_RESERVED_FFFF    0xFFFF
#define ID_LED_DEFAULT          ((ID_LED_OFF1_ON2  << 12) | \
                                 (ID_LED_OFF1_OFF2 <<  8) | \
                                 (ID_LED_DEF1_DEF2 <<  4) | \
                                 (ID_LED_DEF1_DEF2))
#define ID_LED_DEF1_DEF2        0x1
#define ID_LED_DEF1_ON2         0x2
#define ID_LED_DEF1_OFF2        0x3
#define ID_LED_ON1_DEF2         0x4
#define ID_LED_ON1_ON2          0x5
#define ID_LED_ON1_OFF2         0x6
#define ID_LED_OFF1_DEF2        0x7
#define ID_LED_OFF1_ON2         0x8
#define ID_LED_OFF1_OFF2        0x9

#define IGP_ACTIVITY_LED_MASK   0xFFFFF0FF
#define IGP_ACTIVITY_LED_ENABLE 0x0300
#define IGP_LED3_MODE           0x07000000

/* PCI/PCI-X/PCI-EX Config space */
#define PCIX_COMMAND_REGISTER           0xE6
#define PCIX_STATUS_REGISTER_LO         0xE8
#define PCIX_STATUS_REGISTER_HI         0xEA
#define PCI_HEADER_TYPE_REGISTER        0x0E
#define PCIE_LINK_STATUS                0x12

#define PCIX_COMMAND_MMRBC_MASK         0x000C
#define PCIX_COMMAND_MMRBC_SHIFT        0x2
#define PCIX_STATUS_HI_MMRBC_MASK       0x0060
#define PCIX_STATUS_HI_MMRBC_SHIFT      0x5
#define PCIX_STATUS_HI_MMRBC_4K         0x3
#define PCIX_STATUS_HI_MMRBC_2K         0x2
#define PCIX_STATUS_LO_FUNC_MASK        0x7
#define PCI_HEADER_TYPE_MULTIFUNC       0x80
#define PCIE_LINK_WIDTH_MASK            0x3F0
#define PCIE_LINK_WIDTH_SHIFT           4
#define PCIE_LINK_SPEED_MASK            0x0F
#define PCIE_LINK_SPEED_2500            0x01
#define PCIE_LINK_SPEED_5000            0x02

#ifndef ETH_ADDR_LEN
#define ETH_ADDR_LEN                    6
#endif

#define PHY_REVISION_MASK               0xFFFFFFF0
#define MAX_PHY_REG_ADDRESS             0x1F  /* 5 bit address bus (0-0x1F) */
#define MAX_PHY_MULTI_PAGE_REG          0xF

/* Bit definitions for valid PHY IDs.
 * I = Integrated
 * E = External
 */
#define M88IGC_E_PHY_ID         0x01410C50
#define M88IGC_I_PHY_ID         0x01410C30
#define M88E1011_I_PHY_ID       0x01410C20
#define IGP01IGC_I_PHY_ID       0x02A80380
#define M88E1111_I_PHY_ID       0x01410CC0
#define GG82563_E_PHY_ID        0x01410CA0
#define IGP03IGC_E_PHY_ID       0x02A80390
#define IFE_E_PHY_ID            0x02A80330
#define IFE_PLUS_E_PHY_ID       0x02A80320
#define IFE_C_E_PHY_ID          0x02A80310
#define I225_I_PHY_ID           0x67C9DC00

/* M88IGC Specific Registers */
#define M88IGC_PHY_SPEC_CTRL            0x10  /* PHY Specific Control Reg */
#define M88IGC_PHY_SPEC_STATUS          0x11  /* PHY Specific Status Reg */
#define M88IGC_EXT_PHY_SPEC_CTRL        0x14  /* Extended PHY Specific Cntrl */
#define M88IGC_RX_ERR_CNTR              0x15  /* Receive Error Counter */

#define M88IGC_PHY_PAGE_SELECT  0x1D  /* Reg 29 for pg number setting */
#define M88IGC_PHY_GEN_CONTROL  0x1E  /* meaning depends on reg 29 */

/* M88IGC PHY Specific Control Register */
#define M88IGC_PSCR_POLARITY_REVERSAL   0x0002 /* 1=Polarity Reverse enabled */
/* MDI Crossover Mode bits 6:5 Manual MDI configuration */
#define M88IGC_PSCR_MDI_MANUAL_MODE     0x0000
#define M88IGC_PSCR_MDIX_MANUAL_MODE    0x0020  /* Manual MDIX configuration */
/* 1000BASE-T: Auto crossover, 100BASE-TX/10BASE-T: MDI Mode */
#define M88IGC_PSCR_AUTO_X_1000T        0x0040
/* Auto crossover enabled all speeds */
#define M88IGC_PSCR_AUTO_X_MODE         0x0060
#define M88IGC_PSCR_ASSERT_CRS_ON_TX    0x0800 /* 1=Assert CRS on Tx */

/* M88IGC PHY Specific Status Register */
#define M88IGC_PSSR_REV_POLARITY        0x0002 /* 1=Polarity reversed */
#define M88IGC_PSSR_DOWNSHIFT           0x0020 /* 1=Downshifted */
#define M88IGC_PSSR_MDIX                0x0040 /* 1=MDIX; 0=MDI */
/* 0 = <50M
 * 1 = 50-80M
 * 2 = 80-110M
 * 3 = 110-140M
 * 4 = >140M
 */
#define M88IGC_PSSR_CABLE_LENGTH        0x0380
#define M88IGC_PSSR_LINK                0x0400 /* 1=Link up, 0=Link down */
#define M88IGC_PSSR_SPD_DPLX_RESOLVED   0x0800 /* 1=Speed & Duplex resolved */
#define M88IGC_PSSR_SPEED               0xC000 /* Speed, bits 14:15 */
#define M88IGC_PSSR_1000MBS             0x8000 /* 10=1000Mbs */

#define M88IGC_PSSR_CABLE_LENGTH_SHIFT  7

/* Number of times we will attempt to autonegotiate before downshifting if we
 * are the master
 */
#define M88IGC_EPSCR_MASTER_DOWNSHIFT_MASK      0x0C00
#define M88IGC_EPSCR_MASTER_DOWNSHIFT_1X        0x0000
/* Number of times we will attempt to autonegotiate before downshifting if we
 * are the slave
 */
#define M88IGC_EPSCR_SLAVE_DOWNSHIFT_MASK       0x0300
#define M88IGC_EPSCR_SLAVE_DOWNSHIFT_1X         0x0100
#define M88IGC_EPSCR_TX_CLK_25                  0x0070 /* 25  MHz TX_CLK */


/* M88EC018 Rev 2 specific DownShift settings */
#define M88EC018_EPSCR_DOWNSHIFT_COUNTER_MASK   0x0E00
#define M88EC018_EPSCR_DOWNSHIFT_COUNTER_5X     0x0800

/* Bits...
 * 15-5: page
 * 4-0: register offset
 */
#define GG82563_PAGE_SHIFT      5
#define GG82563_REG(page, reg)  \
        (((page) << GG82563_PAGE_SHIFT) | ((reg) & MAX_PHY_REG_ADDRESS))
#define GG82563_MIN_ALT_REG     30

/* GG82563 Specific Registers */
#define GG82563_PHY_SPEC_CTRL           GG82563_REG(0, 16) /* PHY Spec Cntrl */
#define GG82563_PHY_PAGE_SELECT         GG82563_REG(0, 22) /* Page Select */
#define GG82563_PHY_SPEC_CTRL_2         GG82563_REG(0, 26) /* PHY Spec Cntrl2 */
#define GG82563_PHY_PAGE_SELECT_ALT     GG82563_REG(0, 29) /* Alt Page Select */

/* MAC Specific Control Register */
#define GG82563_PHY_MAC_SPEC_CTRL       GG82563_REG(2, 21)

#define GG82563_PHY_DSP_DISTANCE        GG82563_REG(5, 26) /* DSP Distance */

/* Page 193 - Port Control Registers */
/* Kumeran Mode Control */
#define GG82563_PHY_KMRN_MODE_CTRL      GG82563_REG(193, 16)
#define GG82563_PHY_PWR_MGMT_CTRL       GG82563_REG(193, 20) /* Pwr Mgt Ctrl */

/* Page 194 - KMRN Registers */
#define GG82563_PHY_INBAND_CTRL         GG82563_REG(194, 18) /* Inband Ctrl */

/* MDI Control */
#define IGC_MDIC_DATA_MASK      0x0000FFFF
#define IGC_MDIC_INT_EN         0x20000000
#define IGC_MDIC_REG_MASK       0x001F0000
#define IGC_MDIC_REG_SHIFT      16
#define IGC_MDIC_PHY_SHIFT      21
#define IGC_MDIC_OP_WRITE       0x04000000
#define IGC_MDIC_OP_READ        0x08000000
#define IGC_MDIC_READY          0x10000000
#define IGC_MDIC_ERROR          0x40000000

#define IGC_N0_QUEUE            -1

#define IGC_MAX_MAC_HDR_LEN     127
#define IGC_MAX_NETWORK_HDR_LEN 511

#define IGC_VLANPQF_QUEUE_SEL(_n, q_idx) ((q_idx) << ((_n) * 4))
#define IGC_VLANPQF_P_VALID(_n) (0x1 << (3 + (_n) * 4))
#define IGC_VLANPQF_QUEUE_MASK  0x03
#define IGC_VFTA_BLOCK_SIZE     8
/* SerDes Control */
#define IGC_GEN_POLL_TIMEOUT    640

/* DMA Coalescing register fields */
/* DMA Coalescing Watchdog Timer */
#define IGC_DMACR_DMACWT_MASK   0x00003FFF
/* DMA Coalescing Rx Threshold */
#define IGC_DMACR_DMACTHR_MASK  0x00FF0000
#define IGC_DMACR_DMACTHR_SHIFT 16
/* Lx when no PCIe transactions */
#define IGC_DMACR_DMAC_LX_MASK  0x30000000
#define IGC_DMACR_DMAC_LX_SHIFT 28
#define IGC_DMACR_DMAC_EN       0x80000000 /* Enable DMA Coalescing */
/* DMA Coalescing BMC-to-OS Watchdog Enable */
#define IGC_DMACR_DC_BMC2OSW_EN 0x00008000

/* DMA Coalescing Transmit Threshold */
#define IGC_DMCTXTH_DMCTTHR_MASK        0x00000FFF

#define IGC_DMCTLX_TTLX_MASK    0x00000FFF /* Time to LX request */

/* Rx Traffic Rate Threshold */
#define IGC_DMCRTRH_UTRESH_MASK         0x0007FFFF
/* Rx packet rate in current window */
#define IGC_DMCRTRH_LRPRCW              0x80000000

/* DMA Coal Rx Traffic Current Count */
#define IGC_DMCCNT_CCOUNT_MASK          0x01FFFFFF

/* Flow ctrl Rx Threshold High val */
#define IGC_FCRTC_RTH_COAL_MASK         0x0003FFF0
#define IGC_FCRTC_RTH_COAL_SHIFT        4
/* Lx power decision based on DMA coal */
#define IGC_PCIEMISC_LX_DECISION        0x00000080

#define IGC_RXPBS_CFG_TS_EN             0x80000000 /* Timestamp in Rx buffer */
#define IGC_RXPBS_SIZE_I210_MASK        0x0000003F /* Rx packet buffer size */
#define IGC_TXPB0S_SIZE_I210_MASK       0x0000003F /* Tx packet buffer 0 size */
#define I210_RXPBSIZE_DEFAULT           0x000000A2 /* RXPBSIZE default */
#define I210_TXPBSIZE_DEFAULT           0x04000014 /* TXPBSIZE default */

#define IGC_LTRC_EEEMS_EN               0x00000020 /* Enable EEE LTR max send */
/* Minimum time for 1000BASE-T where no data will be transmit following move out
 * of EEE LPI Tx state
 */
#define IGC_TW_SYSTEM_1000_MASK         0x000000FF
/* Minimum time for 100BASE-T where no data will be transmit following move out
 * of EEE LPI Tx state
 */
#define IGC_TW_SYSTEM_100_MASK          0x0000FF00
#define IGC_TW_SYSTEM_100_SHIFT         8
#define IGC_LTRMINV_LTRV_MASK           0x000003FF /* LTR minimum value */
#define IGC_LTRMAXV_LTRV_MASK           0x000003FF /* LTR maximum value */
#define IGC_LTRMINV_SCALE_MASK          0x00001C00 /* LTR minimum scale */
#define IGC_LTRMINV_SCALE_SHIFT         10
/* Reg val to set scale to 1024 nsec */
#define IGC_LTRMINV_SCALE_1024          2
/* Reg val to set scale to 32768 nsec */
#define IGC_LTRMINV_SCALE_32768         3
#define IGC_LTRMINV_LSNP_REQ            0x00008000 /* LTR Snoop Requirement */
#define IGC_LTRMAXV_SCALE_MASK          0x00001C00 /* LTR maximum scale */
#define IGC_LTRMAXV_SCALE_SHIFT         10
/* Reg val to set scale to 1024 nsec */
#define IGC_LTRMAXV_SCALE_1024          2
/* Reg val to set scale to 32768 nsec */
#define IGC_LTRMAXV_SCALE_32768         3
#define IGC_LTRMAXV_LSNP_REQ            0x00008000 /* LTR Snoop Requirement */

#define I225_RXPBSIZE_DEFAULT           0x000000A2 /* RXPBSIZE default */
#define I225_TXPBSIZE_DEFAULT           0x04000014 /* TXPBSIZE default */
#define IGC_RXPBS_SIZE_I225_MASK        0x0000003F /* Rx packet buffer size */
#define IGC_TXPB0S_SIZE_I225_MASK       0x0000003F /* Tx packet buffer 0 size */
#define IGC_STM_OPCODE                  0xDB00
#define IGC_EEPROM_FLASH_SIZE_WORD      0x11
#define INVM_DWORD_TO_RECORD_TYPE(invm_dword) \
        (u8)((invm_dword) & 0x7)
#define INVM_DWORD_TO_WORD_ADDRESS(invm_dword) \
        (u8)(((invm_dword) & 0x0000FE00) >> 9)
#define INVM_DWORD_TO_WORD_DATA(invm_dword) \
        (u16)(((invm_dword) & 0xFFFF0000) >> 16)
#define IGC_INVM_RSA_KEY_SHA256_DATA_SIZE_IN_DWORDS     8
#define IGC_INVM_CSR_AUTOLOAD_DATA_SIZE_IN_DWORDS       1
#define IGC_INVM_ULT_BYTES_SIZE         8
#define IGC_INVM_RECORD_SIZE_IN_BYTES   4
#define IGC_INVM_VER_FIELD_ONE          0x1FF8
#define IGC_INVM_VER_FIELD_TWO          0x7FE000
#define IGC_INVM_IMGTYPE_FIELD          0x1F800000

#define IGC_INVM_MAJOR_MASK             0x3F0
#define IGC_INVM_MINOR_MASK             0xF
#define IGC_INVM_MAJOR_SHIFT            4

/* PLL Defines */
#define IGC_PCI_PMCSR                   0x44
#define IGC_PCI_PMCSR_D3                0x03
#define IGC_MAX_PLL_TRIES               5
#define IGC_PHY_PLL_UNCONF              0xFF
#define IGC_PHY_PLL_FREQ_PAGE           0xFC0000
#define IGC_PHY_PLL_FREQ_REG            0x000E
#define IGC_INVM_DEFAULT_AL             0x202F
#define IGC_INVM_AUTOLOAD               0x0A
#define IGC_INVM_PLL_WO_VAL             0x0010

/* Proxy Filter Control Extended */
#define IGC_PROXYFCEX_MDNS              0x00000001 /* mDNS */
#define IGC_PROXYFCEX_MDNS_M            0x00000002 /* mDNS Multicast */
#define IGC_PROXYFCEX_MDNS_U            0x00000004 /* mDNS Unicast */
#define IGC_PROXYFCEX_IPV4_M            0x00000008 /* IPv4 Multicast */
#define IGC_PROXYFCEX_IPV6_M            0x00000010 /* IPv6 Multicast */
#define IGC_PROXYFCEX_IGMP              0x00000020 /* IGMP */
#define IGC_PROXYFCEX_IGMP_M            0x00000040 /* IGMP Multicast */
#define IGC_PROXYFCEX_ARPRES            0x00000080 /* ARP Response */
#define IGC_PROXYFCEX_ARPRES_D          0x00000100 /* ARP Response Directed */
#define IGC_PROXYFCEX_ICMPV4            0x00000200 /* ICMPv4 */
#define IGC_PROXYFCEX_ICMPV4_D          0x00000400 /* ICMPv4 Directed */
#define IGC_PROXYFCEX_ICMPV6            0x00000800 /* ICMPv6 */
#define IGC_PROXYFCEX_ICMPV6_D          0x00001000 /* ICMPv6 Directed */
#define IGC_PROXYFCEX_DNS               0x00002000 /* DNS */

/* Proxy Filter Control */
#define IGC_PROXYFC_D0                  0x00000001 /* Enable offload in D0 */
#define IGC_PROXYFC_EX                  0x00000004 /* Directed exact proxy */
#define IGC_PROXYFC_MC                  0x00000008 /* Directed MC Proxy */
#define IGC_PROXYFC_BC                  0x00000010 /* Broadcast Proxy Enable */
#define IGC_PROXYFC_ARP_DIRECTED        0x00000020 /* Directed ARP Proxy Ena */
#define IGC_PROXYFC_IPV4                0x00000040 /* Directed IPv4 Enable */
#define IGC_PROXYFC_IPV6                0x00000080 /* Directed IPv6 Enable */
#define IGC_PROXYFC_NS                  0x00000200 /* IPv6 Neighbor Solicitation */
#define IGC_PROXYFC_NS_DIRECTED         0x00000400 /* Directed NS Proxy Ena */
#define IGC_PROXYFC_ARP                 0x00000800 /* ARP Request Proxy Ena */
/* Proxy Status */
#define IGC_PROXYS_CLEAR                0xFFFFFFFF /* Clear */

/* Firmware Status */
#define IGC_FWSTS_FWRI          0x80000000 /* FW Reset Indication */
/* VF Control */
#define IGC_VTCTRL_RST          0x04000000 /* Reset VF */

#define IGC_STATUS_LAN_ID_MASK  0x00000000C /* Mask for Lan ID field */
/* Lan ID bit field offset in status register */
#define IGC_STATUS_LAN_ID_OFFSET        2
#define IGC_VFTA_ENTRIES                128

#define IGC_UNUSEDARG
#ifndef ERROR_REPORT
#define ERROR_REPORT(fmt)       do { } while (0)
#endif /* ERROR_REPORT */
#endif /* _IGC_DEFINES_H_ */