1/****************************************************************************** 2 SPDX-License-Identifier: BSD-3-Clause 3 4 Copyright (c) 2001-2020, Intel Corporation 5 All rights reserved. 6 7 Redistribution and use in source and binary forms, with or without 8 modification, are permitted provided that the following conditions are met: 9 10 1. Redistributions of source code must retain the above copyright notice, 11 this list of conditions and the following disclaimer. 12 13 2. Redistributions in binary form must reproduce the above copyright 14 notice, this list of conditions and the following disclaimer in the 15 documentation and/or other materials provided with the distribution. 16 17 3. Neither the name of the Intel Corporation nor the names of its 18 contributors may be used to endorse or promote products derived from 19 this software without specific prior written permission. 20 21 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 22 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 25 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 26 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 27 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 29 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 30 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 31 POSSIBILITY OF SUCH DAMAGE. 32 33******************************************************************************/ 34/*$FreeBSD$*/ 35 36#ifndef _E1000_ICH8LAN_H_ 37#define _E1000_ICH8LAN_H_ 38 39#define ICH_FLASH_GFPREG 0x0000 40#define ICH_FLASH_HSFSTS 0x0004 41#define ICH_FLASH_HSFCTL 0x0006 42#define ICH_FLASH_FADDR 0x0008 43#define ICH_FLASH_FDATA0 0x0010 44 45/* Requires up to 10 seconds when MNG might be accessing part. */ 46#define ICH_FLASH_READ_COMMAND_TIMEOUT 10000000 47#define ICH_FLASH_WRITE_COMMAND_TIMEOUT 10000000 48#define ICH_FLASH_ERASE_COMMAND_TIMEOUT 10000000 49#define ICH_FLASH_LINEAR_ADDR_MASK 0x00FFFFFF 50#define ICH_FLASH_CYCLE_REPEAT_COUNT 10 51 52#define ICH_CYCLE_READ 0 53#define ICH_CYCLE_WRITE 2 54#define ICH_CYCLE_ERASE 3 55 56#define FLASH_GFPREG_BASE_MASK 0x1FFF 57#define FLASH_SECTOR_ADDR_SHIFT 12 58 59#define ICH_FLASH_SEG_SIZE_256 256 60#define ICH_FLASH_SEG_SIZE_4K 4096 61#define ICH_FLASH_SEG_SIZE_8K 8192 62#define ICH_FLASH_SEG_SIZE_64K 65536 63 64#define E1000_ICH_FWSM_RSPCIPHY 0x00000040 /* Reset PHY on PCI Reset */ 65/* FW established a valid mode */ 66#define E1000_ICH_FWSM_FW_VALID 0x00008000 67#define E1000_ICH_FWSM_PCIM2PCI 0x01000000 /* ME PCIm-to-PCI active */ 68#define E1000_ICH_FWSM_PCIM2PCI_COUNT 2000 69 70#define E1000_ICH_MNG_IAMT_MODE 0x2 71 72#define E1000_FWSM_WLOCK_MAC_MASK 0x0380 73#define E1000_FWSM_WLOCK_MAC_SHIFT 7 74#define E1000_FWSM_ULP_CFG_DONE 0x00000400 /* Low power cfg done */ 75 76/* Shared Receive Address Registers */ 77#define E1000_SHRAL_PCH_LPT(_i) (0x05408 + ((_i) * 8)) 78#define E1000_SHRAH_PCH_LPT(_i) (0x0540C + ((_i) * 8)) 79 80#define E1000_H2ME 0x05B50 /* Host to ME */ 81#define E1000_H2ME_ULP 0x00000800 /* ULP Indication Bit */ 82#define E1000_H2ME_ENFORCE_SETTINGS 0x00001000 /* Enforce Settings */ 83 84#define ID_LED_DEFAULT_ICH8LAN ((ID_LED_DEF1_DEF2 << 12) | \ 85 (ID_LED_OFF1_OFF2 << 8) | \ 86 (ID_LED_OFF1_ON2 << 4) | \ 87 (ID_LED_DEF1_DEF2)) 88 89#define E1000_ICH_NVM_SIG_WORD 0x13 90#define E1000_ICH_NVM_SIG_MASK 0xC000 91#define E1000_ICH_NVM_VALID_SIG_MASK 0xC0 92#define E1000_ICH_NVM_SIG_VALUE 0x80 93 94#define E1000_ICH8_LAN_INIT_TIMEOUT 1500 95 96/* FEXT register bit definition */ 97#define E1000_FEXT_PHY_CABLE_DISCONNECTED 0x00000004 98 99#define E1000_FEXTNVM_SW_CONFIG 1 100#define E1000_FEXTNVM_SW_CONFIG_ICH8M (1 << 27) /* different on ICH8M */ 101 102#define E1000_FEXTNVM3_PHY_CFG_COUNTER_MASK 0x0C000000 103#define E1000_FEXTNVM3_PHY_CFG_COUNTER_50MSEC 0x08000000 104 105#define E1000_FEXTNVM4_BEACON_DURATION_MASK 0x7 106#define E1000_FEXTNVM4_BEACON_DURATION_8USEC 0x7 107#define E1000_FEXTNVM4_BEACON_DURATION_16USEC 0x3 108 109#define E1000_FEXTNVM6_REQ_PLL_CLK 0x00000100 110#define E1000_FEXTNVM6_ENABLE_K1_ENTRY_CONDITION 0x00000200 111#define E1000_FEXTNVM6_K1_OFF_ENABLE 0x80000000 112/* bit for disabling packet buffer read */ 113#define E1000_FEXTNVM7_DISABLE_PB_READ 0x00040000 114#define E1000_FEXTNVM7_SIDE_CLK_UNGATE 0x00000004 115#define E1000_FEXTNVM7_DISABLE_SMB_PERST 0x00000020 116#define E1000_FEXTNVM8_UNBIND_DPG_FROM_MPHY 0x00000400 117#define E1000_FEXTNVM9_IOSFSB_CLKGATE_DIS 0x00000800 118#define E1000_FEXTNVM9_IOSFSB_CLKREQ_DIS 0x00001000 119#define E1000_FEXTNVM11_DISABLE_PB_READ 0x00000200 120#define E1000_FEXTNVM11_DISABLE_MULR_FIX 0x00002000 121#define E1000_FEXTNVM12_DONT_WAK_DPG_CLKREQ 0x00001000 122/* bit24: RXDCTL thresholds granularity: 0 - cache lines, 1 - descriptors */ 123#define E1000_RXDCTL_THRESH_UNIT_DESC 0x01000000 124 125#define NVM_SIZE_MULTIPLIER 4096 /*multiplier for NVMS field*/ 126#define E1000_FLASH_BASE_ADDR 0xE000 /*offset of NVM access regs*/ 127#define E1000_CTRL_EXT_NVMVS 0x3 /*NVM valid sector */ 128#define E1000_TARC0_CB_MULTIQ_3_REQ 0x30000000 129#define E1000_TARC0_CB_MULTIQ_2_REQ 0x20000000 130#define PCIE_ICH8_SNOOP_ALL PCIE_NO_SNOOP_ALL 131 132#define E1000_ICH_RAR_ENTRIES 7 133#define E1000_PCH2_RAR_ENTRIES 5 /* RAR[0], SHRA[0-3] */ 134#define E1000_PCH_LPT_RAR_ENTRIES 12 /* RAR[0], SHRA[0-10] */ 135 136#define PHY_PAGE_SHIFT 5 137#define PHY_REG(page, reg) (((page) << PHY_PAGE_SHIFT) | \ 138 ((reg) & MAX_PHY_REG_ADDRESS)) 139#define IGP3_KMRN_DIAG PHY_REG(770, 19) /* KMRN Diagnostic */ 140#define IGP3_VR_CTRL PHY_REG(776, 18) /* Voltage Regulator Control */ 141 142#define IGP3_KMRN_DIAG_PCS_LOCK_LOSS 0x0002 143#define IGP3_VR_CTRL_DEV_POWERDOWN_MODE_MASK 0x0300 144#define IGP3_VR_CTRL_MODE_SHUTDOWN 0x0200 145 146/* PHY Wakeup Registers and defines */ 147#define BM_PORT_GEN_CFG PHY_REG(BM_PORT_CTRL_PAGE, 17) 148#define BM_RCTL PHY_REG(BM_WUC_PAGE, 0) 149#define BM_WUC PHY_REG(BM_WUC_PAGE, 1) 150#define BM_WUFC PHY_REG(BM_WUC_PAGE, 2) 151#define BM_WUS PHY_REG(BM_WUC_PAGE, 3) 152#define BM_RAR_L(_i) (BM_PHY_REG(BM_WUC_PAGE, 16 + ((_i) << 2))) 153#define BM_RAR_M(_i) (BM_PHY_REG(BM_WUC_PAGE, 17 + ((_i) << 2))) 154#define BM_RAR_H(_i) (BM_PHY_REG(BM_WUC_PAGE, 18 + ((_i) << 2))) 155#define BM_RAR_CTRL(_i) (BM_PHY_REG(BM_WUC_PAGE, 19 + ((_i) << 2))) 156#define BM_MTA(_i) (BM_PHY_REG(BM_WUC_PAGE, 128 + ((_i) << 1))) 157 158#define BM_RCTL_UPE 0x0001 /* Unicast Promiscuous Mode */ 159#define BM_RCTL_MPE 0x0002 /* Multicast Promiscuous Mode */ 160#define BM_RCTL_MO_SHIFT 3 /* Multicast Offset Shift */ 161#define BM_RCTL_MO_MASK (3 << 3) /* Multicast Offset Mask */ 162#define BM_RCTL_BAM 0x0020 /* Broadcast Accept Mode */ 163#define BM_RCTL_PMCF 0x0040 /* Pass MAC Control Frames */ 164#define BM_RCTL_RFCE 0x0080 /* Rx Flow Control Enable */ 165 166#define HV_LED_CONFIG PHY_REG(768, 30) /* LED Configuration */ 167#define HV_MUX_DATA_CTRL PHY_REG(776, 16) 168#define HV_MUX_DATA_CTRL_GEN_TO_MAC 0x0400 169#define HV_MUX_DATA_CTRL_FORCE_SPEED 0x0004 170#define HV_STATS_PAGE 778 171/* Half-duplex collision counts */ 172#define HV_SCC_UPPER PHY_REG(HV_STATS_PAGE, 16) /* Single Collision */ 173#define HV_SCC_LOWER PHY_REG(HV_STATS_PAGE, 17) 174#define HV_ECOL_UPPER PHY_REG(HV_STATS_PAGE, 18) /* Excessive Coll. */ 175#define HV_ECOL_LOWER PHY_REG(HV_STATS_PAGE, 19) 176#define HV_MCC_UPPER PHY_REG(HV_STATS_PAGE, 20) /* Multiple Collision */ 177#define HV_MCC_LOWER PHY_REG(HV_STATS_PAGE, 21) 178#define HV_LATECOL_UPPER PHY_REG(HV_STATS_PAGE, 23) /* Late Collision */ 179#define HV_LATECOL_LOWER PHY_REG(HV_STATS_PAGE, 24) 180#define HV_COLC_UPPER PHY_REG(HV_STATS_PAGE, 25) /* Collision */ 181#define HV_COLC_LOWER PHY_REG(HV_STATS_PAGE, 26) 182#define HV_DC_UPPER PHY_REG(HV_STATS_PAGE, 27) /* Defer Count */ 183#define HV_DC_LOWER PHY_REG(HV_STATS_PAGE, 28) 184#define HV_TNCRS_UPPER PHY_REG(HV_STATS_PAGE, 29) /* Tx with no CRS */ 185#define HV_TNCRS_LOWER PHY_REG(HV_STATS_PAGE, 30) 186 187#define E1000_FCRTV_PCH 0x05F40 /* PCH Flow Control Refresh Timer Value */ 188 189#define E1000_NVM_K1_CONFIG 0x1B /* NVM K1 Config Word */ 190#define E1000_NVM_K1_ENABLE 0x1 /* NVM Enable K1 bit */ 191#define K1_ENTRY_LATENCY 0 192#define K1_MIN_TIME 1 193 194/* SMBus Control Phy Register */ 195#define CV_SMB_CTRL PHY_REG(769, 23) 196#define CV_SMB_CTRL_FORCE_SMBUS 0x0001 197 198/* I218 Ultra Low Power Configuration 1 Register */ 199#define I218_ULP_CONFIG1 PHY_REG(779, 16) 200#define I218_ULP_CONFIG1_START 0x0001 /* Start auto ULP config */ 201#define I218_ULP_CONFIG1_IND 0x0004 /* Pwr up from ULP indication */ 202#define I218_ULP_CONFIG1_STICKY_ULP 0x0010 /* Set sticky ULP mode */ 203#define I218_ULP_CONFIG1_INBAND_EXIT 0x0020 /* Inband on ULP exit */ 204#define I218_ULP_CONFIG1_WOL_HOST 0x0040 /* WoL Host on ULP exit */ 205#define I218_ULP_CONFIG1_RESET_TO_SMBUS 0x0100 /* Reset to SMBus mode */ 206/* enable ULP even if when phy powered down via lanphypc */ 207#define I218_ULP_CONFIG1_EN_ULP_LANPHYPC 0x0400 208/* disable clear of sticky ULP on PERST */ 209#define I218_ULP_CONFIG1_DIS_CLR_STICKY_ON_PERST 0x0800 210#define I218_ULP_CONFIG1_DISABLE_SMB_PERST 0x1000 /* Disable on PERST# */ 211 212/* SMBus Address Phy Register */ 213#define HV_SMB_ADDR PHY_REG(768, 26) 214#define HV_SMB_ADDR_MASK 0x007F 215#define HV_SMB_ADDR_PEC_EN 0x0200 216#define HV_SMB_ADDR_VALID 0x0080 217#define HV_SMB_ADDR_FREQ_MASK 0x1100 218#define HV_SMB_ADDR_FREQ_LOW_SHIFT 8 219#define HV_SMB_ADDR_FREQ_HIGH_SHIFT 12 220 221/* Strapping Option Register - RO */ 222#define E1000_STRAP 0x0000C 223#define E1000_STRAP_SMBUS_ADDRESS_MASK 0x00FE0000 224#define E1000_STRAP_SMBUS_ADDRESS_SHIFT 17 225#define E1000_STRAP_SMT_FREQ_MASK 0x00003000 226#define E1000_STRAP_SMT_FREQ_SHIFT 12 227 228/* OEM Bits Phy Register */ 229#define HV_OEM_BITS PHY_REG(768, 25) 230#define HV_OEM_BITS_LPLU 0x0004 /* Low Power Link Up */ 231#define HV_OEM_BITS_GBE_DIS 0x0040 /* Gigabit Disable */ 232#define HV_OEM_BITS_RESTART_AN 0x0400 /* Restart Auto-negotiation */ 233 234/* KMRN Mode Control */ 235#define HV_KMRN_MODE_CTRL PHY_REG(769, 16) 236#define HV_KMRN_MDIO_SLOW 0x0400 237 238/* KMRN FIFO Control and Status */ 239#define HV_KMRN_FIFO_CTRLSTA PHY_REG(770, 16) 240#define HV_KMRN_FIFO_CTRLSTA_PREAMBLE_MASK 0x7000 241#define HV_KMRN_FIFO_CTRLSTA_PREAMBLE_SHIFT 12 242 243/* PHY Power Management Control */ 244#define HV_PM_CTRL PHY_REG(770, 17) 245#define HV_PM_CTRL_K1_CLK_REQ 0x200 246#define HV_PM_CTRL_K1_ENABLE 0x4000 247 248#define I217_PLL_CLOCK_GATE_REG PHY_REG(772, 28) 249#define I217_PLL_CLOCK_GATE_MASK 0x07FF 250 251#define SW_FLAG_TIMEOUT 1000 /* SW Semaphore flag timeout in ms */ 252 253/* Inband Control */ 254#define I217_INBAND_CTRL PHY_REG(770, 18) 255#define I217_INBAND_CTRL_LINK_STAT_TX_TIMEOUT_MASK 0x3F00 256#define I217_INBAND_CTRL_LINK_STAT_TX_TIMEOUT_SHIFT 8 257 258/* Low Power Idle GPIO Control */ 259#define I217_LPI_GPIO_CTRL PHY_REG(772, 18) 260#define I217_LPI_GPIO_CTRL_AUTO_EN_LPI 0x0800 261 262/* PHY Low Power Idle Control */ 263#define I82579_LPI_CTRL PHY_REG(772, 20) 264#define I82579_LPI_CTRL_100_ENABLE 0x2000 265#define I82579_LPI_CTRL_1000_ENABLE 0x4000 266#define I82579_LPI_CTRL_ENABLE_MASK 0x6000 267 268/* 82579 DFT Control */ 269#define I82579_DFT_CTRL PHY_REG(769, 20) 270#define I82579_DFT_CTRL_GATE_PHY_RESET 0x0040 /* Gate PHY Reset on MAC Reset */ 271 272/* Extended Management Interface (EMI) Registers */ 273#define I82579_EMI_ADDR 0x10 274#define I82579_EMI_DATA 0x11 275#define I82579_LPI_UPDATE_TIMER 0x4805 /* in 40ns units + 40 ns base value */ 276#define I82579_MSE_THRESHOLD 0x084F /* 82579 Mean Square Error Threshold */ 277#define I82577_MSE_THRESHOLD 0x0887 /* 82577 Mean Square Error Threshold */ 278#define I82579_MSE_LINK_DOWN 0x2411 /* MSE count before dropping link */ 279#define I82579_RX_CONFIG 0x3412 /* Receive configuration */ 280#define I82579_LPI_PLL_SHUT 0x4412 /* LPI PLL Shut Enable */ 281#define I82579_EEE_PCS_STATUS 0x182E /* IEEE MMD Register 3.1 >> 8 */ 282#define I82579_EEE_CAPABILITY 0x0410 /* IEEE MMD Register 3.20 */ 283#define I82579_EEE_ADVERTISEMENT 0x040E /* IEEE MMD Register 7.60 */ 284#define I82579_EEE_LP_ABILITY 0x040F /* IEEE MMD Register 7.61 */ 285#define I82579_EEE_100_SUPPORTED (1 << 1) /* 100BaseTx EEE */ 286#define I82579_EEE_1000_SUPPORTED (1 << 2) /* 1000BaseTx EEE */ 287#define I82579_LPI_100_PLL_SHUT (1 << 2) /* 100M LPI PLL Shut Enabled */ 288#define I217_EEE_PCS_STATUS 0x9401 /* IEEE MMD Register 3.1 */ 289#define I217_EEE_CAPABILITY 0x8000 /* IEEE MMD Register 3.20 */ 290#define I217_EEE_ADVERTISEMENT 0x8001 /* IEEE MMD Register 7.60 */ 291#define I217_EEE_LP_ABILITY 0x8002 /* IEEE MMD Register 7.61 */ 292#define I217_RX_CONFIG 0xB20C /* Receive configuration */ 293 294#define E1000_EEE_RX_LPI_RCVD 0x0400 /* Tx LP idle received */ 295#define E1000_EEE_TX_LPI_RCVD 0x0800 /* Rx LP idle received */ 296 297/* Intel Rapid Start Technology Support */ 298#define I217_PROXY_CTRL BM_PHY_REG(BM_WUC_PAGE, 70) 299#define I217_PROXY_CTRL_AUTO_DISABLE 0x0080 300#define I217_SxCTRL PHY_REG(BM_PORT_CTRL_PAGE, 28) 301#define I217_SxCTRL_ENABLE_LPI_RESET 0x1000 302#define I217_CGFREG PHY_REG(772, 29) 303#define I217_CGFREG_ENABLE_MTA_RESET 0x0002 304#define I217_MEMPWR PHY_REG(772, 26) 305#define I217_MEMPWR_DISABLE_SMB_RELEASE 0x0010 306 307/* Receive Address Initial CRC Calculation */ 308#define E1000_PCH_RAICC(_n) (0x05F50 + ((_n) * 4)) 309 310/* Latency Tolerance Reporting */ 311#define E1000_LTRV 0x000F8 312#define E1000_LTRV_VALUE_MASK 0x000003FF 313#define E1000_LTRV_SCALE_MAX 5 314#define E1000_LTRV_SCALE_FACTOR 5 315#define E1000_LTRV_SCALE_SHIFT 10 316#define E1000_LTRV_SCALE_MASK 0x00001C00 317#define E1000_LTRV_REQ_SHIFT 15 318#define E1000_LTRV_NOSNOOP_SHIFT 16 319#define E1000_LTRV_SEND (1 << 30) 320 321/* Proprietary Latency Tolerance Reporting PCI Capability */ 322#define E1000_PCI_LTR_CAP_LPT 0xA8 323 324/* OBFF Control & Threshold Defines */ 325#define E1000_SVCR_OFF_EN 0x00000001 326#define E1000_SVCR_OFF_MASKINT 0x00001000 327#define E1000_SVCR_OFF_TIMER_MASK 0xFFFF0000 328#define E1000_SVCR_OFF_TIMER_SHIFT 16 329#define E1000_SVT_OFF_HWM_MASK 0x0000001F 330 331#define E1000_PCI_VENDOR_ID_REGISTER 0x00 332 333void e1000_set_kmrn_lock_loss_workaround_ich8lan(struct e1000_hw *hw, 334 bool state); 335void e1000_igp3_phy_powerdown_workaround_ich8lan(struct e1000_hw *hw); 336void e1000_gig_downshift_workaround_ich8lan(struct e1000_hw *hw); 337void e1000_suspend_workarounds_ich8lan(struct e1000_hw *hw); 338u32 e1000_resume_workarounds_pchlan(struct e1000_hw *hw); 339s32 e1000_configure_k1_ich8lan(struct e1000_hw *hw, bool k1_enable); 340s32 e1000_configure_k0s_lpt(struct e1000_hw *hw, u8 entry_latency, u8 min_time); 341void e1000_copy_rx_addrs_to_phy_ich8lan(struct e1000_hw *hw); 342s32 e1000_lv_jumbo_workaround_ich8lan(struct e1000_hw *hw, bool enable); 343s32 e1000_read_emi_reg_locked(struct e1000_hw *hw, u16 addr, u16 *data); 344s32 e1000_write_emi_reg_locked(struct e1000_hw *hw, u16 addr, u16 data); 345s32 e1000_set_eee_pchlan(struct e1000_hw *hw); 346s32 e1000_enable_ulp_lpt_lp(struct e1000_hw *hw, bool to_sx); 347s32 e1000_disable_ulp_lpt_lp(struct e1000_hw *hw, bool force); 348#endif /* _E1000_ICH8LAN_H_ */ 349