lib/librte_pmd_e1000/e1000/e1000_ich8lan.h

   1 /*******************************************************************************
   2
   3 Copyright (c) 2001-2012, Intel Corporation
   4 All rights reserved.
   5
   6 Redistribution and use in source and binary forms, with or without
   7 modification, are permitted provided that the following conditions are met:
   8
   9  1. Redistributions of source code must retain the above copyright notice,
  10     this list of conditions and the following disclaimer.
  11
  12  2. Redistributions in binary form must reproduce the above copyright
  13     notice, this list of conditions and the following disclaimer in the
  14     documentation and/or other materials provided with the distribution.
  15
  16  3. Neither the name of the Intel Corporation nor the names of its
  17     contributors may be used to endorse or promote products derived from
  18     this software without specific prior written permission.
  19
  20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  24 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30 POSSIBILITY OF SUCH DAMAGE.
  31
  32 ***************************************************************************/
  33
  34 #ifndef _E1000_ICH8LAN_H_
  35 #define _E1000_ICH8LAN_H_
  36
  37 #define ICH_FLASH_GFPREG                0x0000
  38 #define ICH_FLASH_HSFSTS                0x0004
  39 #define ICH_FLASH_HSFCTL                0x0006
  40 #define ICH_FLASH_FADDR                 0x0008
  41 #define ICH_FLASH_FDATA0                0x0010
  42
  43 /* Requires up to 10 seconds when MNG might be accessing part. */
  44 #define ICH_FLASH_READ_COMMAND_TIMEOUT  10000000
  45 #define ICH_FLASH_WRITE_COMMAND_TIMEOUT 10000000
  46 #define ICH_FLASH_ERASE_COMMAND_TIMEOUT 10000000
  47 #define ICH_FLASH_LINEAR_ADDR_MASK      0x00FFFFFF
  48 #define ICH_FLASH_CYCLE_REPEAT_COUNT    10
  49
  50 #define ICH_CYCLE_READ                  0
  51 #define ICH_CYCLE_WRITE                 2
  52 #define ICH_CYCLE_ERASE                 3
  53
  54 #define FLASH_GFPREG_BASE_MASK          0x1FFF
  55 #define FLASH_SECTOR_ADDR_SHIFT         12
  56
  57 #define ICH_FLASH_SEG_SIZE_256          256
  58 #define ICH_FLASH_SEG_SIZE_4K           4096
  59 #define ICH_FLASH_SEG_SIZE_8K           8192
  60 #define ICH_FLASH_SEG_SIZE_64K          65536
  61 #define ICH_FLASH_SECTOR_SIZE           4096
  62
  63 #define ICH_FLASH_REG_MAPSIZE           0x00A0
  64
  65 #define E1000_ICH_FWSM_RSPCIPHY         0x00000040 /* Reset PHY on PCI Reset */
  66 #define E1000_ICH_FWSM_DISSW            0x10000000 /* FW Disables SW Writes */
  67 /* FW established a valid mode */
  68 #define E1000_ICH_FWSM_FW_VALID         0x00008000
  69 #define E1000_ICH_FWSM_PCIM2PCI         0x01000000 /* ME PCIm-to-PCI active */
  70 #define E1000_ICH_FWSM_PCIM2PCI_COUNT   2000
  71
  72 #define E1000_ICH_MNG_IAMT_MODE         0x2
  73
  74 #define E1000_FWSM_PROXY_MODE           0x00000008 /* FW is in proxy mode */
  75 #define E1000_FWSM_MEMC                 0x00000010 /* ME Messaging capable */
  76
  77 /* Shared Receive Address Registers */
  78 #define E1000_SHRAH_AV          0x80000000 /* Addr Valid bit */
  79 #define E1000_SHRAH_MAV         0x40000000 /* Multicast Addr Valid bit */
  80
  81 #define E1000_H2ME              0x05B50    /* Host to ME */
  82 #define E1000_H2ME_LSECREQ      0x00000001 /* Linksec Request */
  83 #define E1000_H2ME_LSECA        0x00000002 /* Linksec Active */
  84 #define E1000_H2ME_LSECSF       0x00000004 /* Linksec Failed */
  85 #define E1000_H2ME_LSECD        0x00000008 /* Linksec Disabled */
  86 #define E1000_H2ME_SLCAPD       0x00000010 /* Start LCAPD */
  87 #define E1000_H2ME_IPV4_ARP_EN  0x00000020 /* Arp Offload enable bit */
  88 #define E1000_H2ME_IPV6_NS_EN   0x00000040 /* NS Offload enable bit */
  89 #define E1000_H2ME_ULP          0x00000800 /* ULP Indication Bit */
  90
  91 #define ID_LED_DEFAULT_ICH8LAN  ((ID_LED_DEF1_DEF2 << 12) | \
  92                                  (ID_LED_OFF1_OFF2 <<  8) | \
  93                                  (ID_LED_OFF1_ON2  <<  4) | \
  94                                  (ID_LED_DEF1_DEF2))
  95
  96 #define E1000_ICH_NVM_SIG_WORD          0x13
  97 #define E1000_ICH_NVM_SIG_MASK          0xC000
  98 #define E1000_ICH_NVM_VALID_SIG_MASK    0xC0
  99 #define E1000_ICH_NVM_SIG_VALUE         0x80
 100
 101 #define E1000_ICH8_LAN_INIT_TIMEOUT     1500
 102
 103 /* FEXT register bit definition */
 104 #define E1000_FEXT_PHY_CABLE_DISCONNECTED       0x00000004
 105
 106 #define E1000_FEXTNVM_SW_CONFIG         1
 107 #define E1000_FEXTNVM_SW_CONFIG_ICH8M   (1 << 27) /* Bit redefined for ICH8M */
 108
 109 #define E1000_FEXTNVM3  0x0003C  /* Future Extended NVM 3 - RW */
 110 #define E1000_FEXTNVM3_PHY_CFG_COUNTER_MASK     0x0C000000
 111 #define E1000_FEXTNVM3_PHY_CFG_COUNTER_50MSEC   0x08000000
 112
 113 #define E1000_FEXTNVM4_BEACON_DURATION_MASK     0x7
 114 #define E1000_FEXTNVM4_BEACON_DURATION_8USEC    0x7
 115 #define E1000_FEXTNVM4_BEACON_DURATION_16USEC   0x3
 116
 117 #define PCIE_ICH8_SNOOP_ALL     PCIE_NO_SNOOP_ALL
 118
 119 #define E1000_ICH_RAR_ENTRIES   7
 120 #define E1000_PCH2_RAR_ENTRIES  5 /* RAR[0], SHRA[0-3] */
 121
 122 #define PHY_PAGE_SHIFT          5
 123 #define PHY_REG(page, reg)      (((page) << PHY_PAGE_SHIFT) | \
 124                                  ((reg) & MAX_PHY_REG_ADDRESS))
 125 #define IGP3_KMRN_DIAG          PHY_REG(770, 19) /* KMRN Diagnostic */
 126 #define IGP3_VR_CTRL            PHY_REG(776, 18) /* Voltage Regulator Control */
 127 #define IGP3_CAPABILITY         PHY_REG(776, 19) /* Capability */
 128 #define IGP3_PM_CTRL            PHY_REG(769, 20) /* Power Management Control */
 129
 130 #define IGP3_KMRN_DIAG_PCS_LOCK_LOSS            0x0002
 131 #define IGP3_VR_CTRL_DEV_POWERDOWN_MODE_MASK    0x0300
 132 #define IGP3_VR_CTRL_MODE_SHUTDOWN              0x0200
 133 #define IGP3_PM_CTRL_FORCE_PWR_DOWN             0x0020
 134
 135 /* PHY Wakeup Registers and defines */
 136 #define BM_PORT_GEN_CFG         PHY_REG(BM_PORT_CTRL_PAGE, 17)
 137 #define BM_RCTL                 PHY_REG(BM_WUC_PAGE, 0)
 138 #define BM_WUC                  PHY_REG(BM_WUC_PAGE, 1)
 139 #define BM_WUFC                 PHY_REG(BM_WUC_PAGE, 2)
 140 #define BM_WUS                  PHY_REG(BM_WUC_PAGE, 3)
 141 #define BM_RAR_L(_i)            (BM_PHY_REG(BM_WUC_PAGE, 16 + ((_i) << 2)))
 142 #define BM_RAR_M(_i)            (BM_PHY_REG(BM_WUC_PAGE, 17 + ((_i) << 2)))
 143 #define BM_RAR_H(_i)            (BM_PHY_REG(BM_WUC_PAGE, 18 + ((_i) << 2)))
 144 #define BM_RAR_CTRL(_i)         (BM_PHY_REG(BM_WUC_PAGE, 19 + ((_i) << 2)))
 145 #define BM_MTA(_i)              (BM_PHY_REG(BM_WUC_PAGE, 128 + ((_i) << 1)))
 146 #define BM_IPAV                 (BM_PHY_REG(BM_WUC_PAGE, 64))
 147 #define BM_IP4AT_L(_i)          (BM_PHY_REG(BM_WUC_PAGE, 82 + ((_i) * 2)))
 148 #define BM_IP4AT_H(_i)          (BM_PHY_REG(BM_WUC_PAGE, 83 + ((_i) * 2)))
 149
 150 #define BM_SHRAL_LOWER(_i)      (BM_PHY_REG(BM_WUC_PAGE, 44 + ((_i) * 4)))
 151 #define BM_SHRAL_UPPER(_i)      (BM_PHY_REG(BM_WUC_PAGE, 45 + ((_i) * 4)))
 152 #define BM_SHRAH_LOWER(_i)      (BM_PHY_REG(BM_WUC_PAGE, 46 + ((_i) * 4)))
 153 #define BM_SHRAH_UPPER(_i)      (BM_PHY_REG(BM_WUC_PAGE, 47 + ((_i) * 4)))
 154
 155 #define I217_SHRAL_LOWER(_i)    (BM_PHY_REG(BM_WUC_PAGE, 20 + ((_i) * 4)))
 156 #define I217_SHRAL_UPPER(_i)    (BM_PHY_REG(BM_WUC_PAGE, 21 + ((_i) * 4)))
 157 #define I217_SHRAH_LOWER(_i)    (BM_PHY_REG(BM_WUC_PAGE, 22 + ((_i) * 4)))
 158 #define I217_SHRAH_UPPER(_i)    (BM_PHY_REG(BM_WUC_PAGE, 23 + ((_i) * 4)))
 159
 160 #define BM_RCTL_UPE             0x0001 /* Unicast Promiscuous Mode */
 161 #define BM_RCTL_MPE             0x0002 /* Multicast Promiscuous Mode */
 162 #define BM_RCTL_MO_SHIFT        3      /* Multicast Offset Shift */
 163 #define BM_RCTL_MO_MASK         (3 << 3) /* Multicast Offset Mask */
 164 #define BM_RCTL_BAM             0x0020 /* Broadcast Accept Mode */
 165 #define BM_RCTL_PMCF            0x0040 /* Pass MAC Control Frames */
 166 #define BM_RCTL_RFCE            0x0080 /* Rx Flow Control Enable */
 167
 168 #define HV_LED_CONFIG           PHY_REG(768, 30) /* LED Configuration */
 169 #define HV_MUX_DATA_CTRL        PHY_REG(776, 16)
 170 #define HV_MUX_DATA_CTRL_GEN_TO_MAC     0x0400
 171 #define HV_MUX_DATA_CTRL_FORCE_SPEED    0x0004
 172 #define HV_STATS_PAGE   778
 173 #define HV_SCC_UPPER    PHY_REG(HV_STATS_PAGE, 16) /* Single Collision Count */
 174 #define HV_SCC_LOWER    PHY_REG(HV_STATS_PAGE, 17)
 175 #define HV_ECOL_UPPER   PHY_REG(HV_STATS_PAGE, 18) /* Excessive Coll. Count */
 176 #define HV_ECOL_LOWER   PHY_REG(HV_STATS_PAGE, 19)
 177 #define HV_MCC_UPPER    PHY_REG(HV_STATS_PAGE, 20) /* Multiple Coll. Count */
 178 #define HV_MCC_LOWER    PHY_REG(HV_STATS_PAGE, 21)
 179 #define HV_LATECOL_UPPER PHY_REG(HV_STATS_PAGE, 23) /* Late Collision Count */
 180 #define HV_LATECOL_LOWER PHY_REG(HV_STATS_PAGE, 24)
 181 #define HV_COLC_UPPER   PHY_REG(HV_STATS_PAGE, 25) /* Collision Count */
 182 #define HV_COLC_LOWER   PHY_REG(HV_STATS_PAGE, 26)
 183 #define HV_DC_UPPER     PHY_REG(HV_STATS_PAGE, 27) /* Defer Count */
 184 #define HV_DC_LOWER     PHY_REG(HV_STATS_PAGE, 28)
 185 #define HV_TNCRS_UPPER  PHY_REG(HV_STATS_PAGE, 29) /* Transmit with no CRS */
 186 #define HV_TNCRS_LOWER  PHY_REG(HV_STATS_PAGE, 30)
 187
 188 #define E1000_FCRTV_PCH 0x05F40 /* PCH Flow Control Refresh Timer Value */
 189
 190 /*
 191  * For ICH, the name used for NVM word 17h is LED1 Config.
 192  * For PCH, the word was re-named to OEM Config.
 193  */
 194 #define E1000_NVM_LED1_CONFIG           0x17   /* NVM LED1/LPLU Config Word */
 195 #define E1000_NVM_LED1_CONFIG_LPLU_NONDOA 0x0400 /* NVM LPLU in non-D0a Bit */
 196 #define E1000_NVM_OEM_CONFIG            E1000_NVM_LED1_CONFIG
 197 #define E1000_NVM_OEM_CONFIG_LPLU_NONDOA E1000_NVM_LED1_CONFIG_LPLU_NONDOA
 198
 199 #define E1000_NVM_K1_CONFIG     0x1B /* NVM K1 Config Word */
 200 #define E1000_NVM_K1_ENABLE     0x1  /* NVM Enable K1 bit */
 201
 202 /* SMBus Control Phy Register */
 203 #define CV_SMB_CTRL             PHY_REG(769, 23)
 204 #define CV_SMB_CTRL_FORCE_SMBUS 0x0001
 205
 206 /* SMBus Address Phy Register */
 207 #define HV_SMB_ADDR             PHY_REG(768, 26)
 208 #define HV_SMB_ADDR_MASK        0x007F
 209 #define HV_SMB_ADDR_PEC_EN      0x0200
 210 #define HV_SMB_ADDR_VALID       0x0080
 211 #define HV_SMB_ADDR_FREQ_MASK           0x1100
 212 #define HV_SMB_ADDR_FREQ_LOW_SHIFT      8
 213 #define HV_SMB_ADDR_FREQ_HIGH_SHIFT     12
 214
 215 /* Strapping Option Register - RO */
 216 #define E1000_STRAP                     0x0000C
 217 #define E1000_STRAP_SMBUS_ADDRESS_MASK  0x00FE0000
 218 #define E1000_STRAP_SMBUS_ADDRESS_SHIFT 17
 219 #define E1000_STRAP_SMT_FREQ_MASK       0x00003000
 220 #define E1000_STRAP_SMT_FREQ_SHIFT      12
 221
 222 /* OEM Bits Phy Register */
 223 #define HV_OEM_BITS             PHY_REG(768, 25)
 224 #define HV_OEM_BITS_LPLU        0x0004 /* Low Power Link Up */
 225 #define HV_OEM_BITS_GBE_DIS     0x0040 /* Gigabit Disable */
 226 #define HV_OEM_BITS_RESTART_AN  0x0400 /* Restart Auto-negotiation */
 227
 228 #define LCD_CFG_PHY_ADDR_BIT    0x0020 /* Phy addr bit from LCD Config word */
 229
 230 /* KMRN Mode Control */
 231 #define HV_KMRN_MODE_CTRL       PHY_REG(769, 16)
 232 #define HV_KMRN_MDIO_SLOW       0x0400
 233
 234 /* KMRN FIFO Control and Status */
 235 #define HV_KMRN_FIFO_CTRLSTA                    PHY_REG(770, 16)
 236 #define HV_KMRN_FIFO_CTRLSTA_PREAMBLE_MASK      0x7000
 237 #define HV_KMRN_FIFO_CTRLSTA_PREAMBLE_SHIFT     12
 238
 239 /* PHY Power Management Control */
 240 #define HV_PM_CTRL              PHY_REG(770, 17)
 241 #define HV_PM_CTRL_PLL_STOP_IN_K1_GIGA  0x100
 242 #define I217_MEM_PM_CFG         PHY_REG(772, 27) /* I217 PHY Mem PM Cfg Reg */
 243 #define I217_MEM_PM_CFG_TXF_SD  0x0020 /* Tx FIFO Memories Shutdown*/
 244
 245 #define SW_FLAG_TIMEOUT         1000 /* SW Semaphore flag timeout in ms */
 246
 247 /* PHY Low Power Idle Control */
 248 #define I82579_LPI_CTRL                         PHY_REG(772, 20)
 249 #define I82579_LPI_CTRL_100_ENABLE              0x2000
 250 #define I82579_LPI_CTRL_1000_ENABLE             0x4000
 251 #define I82579_LPI_CTRL_ENABLE_MASK             0x6000
 252 #define I82579_LPI_CTRL_FORCE_PLL_LOCK_COUNT    0x80
 253
 254 /* Extended Management Interface (EMI) Registers */
 255 #define I82579_EMI_ADDR         0x10
 256 #define I82579_EMI_DATA         0x11
 257 #define I82579_LPI_UPDATE_TIMER 0x4805 /* in 40ns units + 40 ns base value */
 258 #define I82579_MSE_THRESHOLD    0x084F /* 82579 Mean Square Error Threshold */
 259 #define I82577_MSE_THRESHOLD    0x0887 /* 82577 Mean Square Error Threshold */
 260 #define I82579_MSE_LINK_DOWN    0x2411 /* MSE count before dropping link */
 261 #define I82579_EEE_PCS_STATUS           0x182D  /* IEEE MMD Register 3.1 >> 8 */
 262 #define I82579_EEE_CAPABILITY           0x0410 /* IEEE MMD Register 3.20 */
 263 #define I82579_EEE_ADVERTISEMENT        0x040E /* IEEE MMD Register 7.60 */
 264 #define I82579_EEE_LP_ABILITY           0x040F /* IEEE MMD Register 7.61 */
 265 #define I82579_EEE_100_SUPPORTED        (1 << 1) /* 100BaseTx EEE supported */
 266 #define I82579_EEE_1000_SUPPORTED       (1 << 2) /* 1000BaseTx EEE supported */
 267 #define I217_EEE_PCS_STATUS     0x9401   /* IEEE MMD Register 3.1 */
 268 #define I217_EEE_CAPABILITY     0x8000   /* IEEE MMD Register 3.20 */
 269 #define I217_EEE_ADVERTISEMENT  0x8001   /* IEEE MMD Register 7.60 */
 270 #define I217_EEE_LP_ABILITY     0x8002   /* IEEE MMD Register 7.61 */
 271
 272 #define E1000_EEE_RX_LPI_RCVD   0x0400  /* Tx LP idle received */
 273 #define E1000_EEE_TX_LPI_RCVD   0x0800  /* Rx LP idle received */
 274
 275 /* Intel Rapid Start Technology Support */
 276 #define I217_PROXY_CTRL         BM_PHY_REG(BM_WUC_PAGE, 70)
 277 #define I217_PROXY_CTRL_AUTO_DISABLE    0x0080
 278 #define I217_SxCTRL                     PHY_REG(BM_PORT_CTRL_PAGE, 28)
 279 #define I217_SxCTRL_ENABLE_LPI_RESET    0x1000
 280 #define I217_SxCTRL_ENABLE_SERDES       0x0020
 281 #define I217_CGFREG                     PHY_REG(772, 29)
 282 #define I217_CGFREG_ENABLE_MTA_RESET    0x0002
 283 #define I217_MEMPWR                     PHY_REG(772, 26)
 284 #define I217_MEMPWR_DISABLE_SMB_RELEASE 0x0010
 285
 286 /*
 287  * Additional interrupts need to be handled for ICH family:
 288  *  DSW = The FW changed the status of the DISSW bit in FWSM
 289  *  PHYINT = The LAN connected device generates an interrupt
 290  *  EPRST = Manageability reset event
 291  */
 292 #define IMS_ICH_ENABLE_MASK (\
 293         E1000_IMS_DSW   | \
 294         E1000_IMS_PHYINT | \
 295         E1000_IMS_EPRST)
 296
 297 /* Additional interrupt register bit definitions */
 298 #define E1000_ICR_LSECPNC       0x00004000  /* PN threshold - client */
 299 #define E1000_IMS_LSECPNC       E1000_ICR_LSECPNC   /* PN threshold - client */
 300 #define E1000_ICS_LSECPNC       E1000_ICR_LSECPNC   /* PN threshold - client */
 301
 302 /* Security Processing bit Indication */
 303 #define E1000_RXDEXT_LINKSEC_STATUS_LSECH       0x01000000
 304 #define E1000_RXDEXT_LINKSEC_ERROR_BIT_MASK     0x60000000
 305 #define E1000_RXDEXT_LINKSEC_ERROR_NO_SA_MATCH  0x20000000
 306 #define E1000_RXDEXT_LINKSEC_ERROR_REPLAY_ERROR 0x40000000
 307 #define E1000_RXDEXT_LINKSEC_ERROR_BAD_SIG      0x60000000
 308
 309 /* Receive Address Initial CRC Calculation */
 310 #define E1000_PCH_RAICC(_n)     (0x05F50 + ((_n) * 4))
 311
 312 void e1000_set_kmrn_lock_loss_workaround_ich8lan(struct e1000_hw *hw,
 313                                                  bool state);
 314 void e1000_igp3_phy_powerdown_workaround_ich8lan(struct e1000_hw *hw);
 315 void e1000_gig_downshift_workaround_ich8lan(struct e1000_hw *hw);
 316 void e1000_suspend_workarounds_ich8lan(struct e1000_hw *hw);
 317 void e1000_resume_workarounds_pchlan(struct e1000_hw *hw);
 318 s32 e1000_configure_k1_ich8lan(struct e1000_hw *hw, bool k1_enable);
 319 void e1000_copy_rx_addrs_to_phy_ich8lan(struct e1000_hw *hw);
 320 s32 e1000_lv_jumbo_workaround_ich8lan(struct e1000_hw *hw, bool enable);
 321 s32 e1000_read_emi_reg_locked(struct e1000_hw *hw, u16 addr, u16 *data);
 322 #endif /* _E1000_ICH8LAN_H_ */