1 /****************************************************************************** 2 3 Copyright (c) 2001-2009, 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 /*$FreeBSD$*/ 34 35 #ifndef _E1000_PHY_H_ 36 #define _E1000_PHY_H_ 37 38 void e1000_init_phy_ops_generic(struct e1000_hw *hw); 39 s32 e1000_null_read_reg(struct e1000_hw *hw, u32 offset, u16 *data); 40 void e1000_null_phy_generic(struct e1000_hw *hw); 41 s32 e1000_null_lplu_state(struct e1000_hw *hw, bool active); 42 s32 e1000_null_write_reg(struct e1000_hw *hw, u32 offset, u16 data); 43 s32 e1000_check_downshift_generic(struct e1000_hw *hw); 44 s32 e1000_check_polarity_m88(struct e1000_hw *hw); 45 s32 e1000_check_polarity_igp(struct e1000_hw *hw); 46 s32 e1000_check_reset_block_generic(struct e1000_hw *hw); 47 s32 e1000_copper_link_autoneg(struct e1000_hw *hw); 48 s32 e1000_copper_link_setup_igp(struct e1000_hw *hw); 49 s32 e1000_copper_link_setup_m88(struct e1000_hw *hw); 50 s32 e1000_phy_force_speed_duplex_igp(struct e1000_hw *hw); 51 s32 e1000_phy_force_speed_duplex_m88(struct e1000_hw *hw); 52 s32 e1000_get_cable_length_m88(struct e1000_hw *hw); 53 s32 e1000_get_cable_length_igp_2(struct e1000_hw *hw); 54 s32 e1000_get_cfg_done_generic(struct e1000_hw *hw); 55 s32 e1000_get_phy_id(struct e1000_hw *hw); 56 s32 e1000_get_phy_info_igp(struct e1000_hw *hw); 57 s32 e1000_get_phy_info_m88(struct e1000_hw *hw); 58 s32 e1000_phy_sw_reset_generic(struct e1000_hw *hw); 59 void e1000_phy_force_speed_duplex_setup(struct e1000_hw *hw, u16 *phy_ctrl); 60 s32 e1000_phy_hw_reset_generic(struct e1000_hw *hw); 61 s32 e1000_phy_reset_dsp_generic(struct e1000_hw *hw); 62 s32 e1000_phy_setup_autoneg(struct e1000_hw *hw); 63 s32 e1000_read_kmrn_reg_generic(struct e1000_hw *hw, u32 offset, u16 *data); 64 s32 e1000_read_phy_reg_igp(struct e1000_hw *hw, u32 offset, u16 *data); 65 s32 e1000_read_phy_reg_m88(struct e1000_hw *hw, u32 offset, u16 *data); 66 s32 e1000_set_d3_lplu_state_generic(struct e1000_hw *hw, bool active); 67 s32 e1000_setup_copper_link_generic(struct e1000_hw *hw); 68 s32 e1000_wait_autoneg_generic(struct e1000_hw *hw); 69 s32 e1000_write_kmrn_reg_generic(struct e1000_hw *hw, u32 offset, u16 data); 70 s32 e1000_write_phy_reg_igp(struct e1000_hw *hw, u32 offset, u16 data); 71 s32 e1000_write_phy_reg_m88(struct e1000_hw *hw, u32 offset, u16 data); 72 s32 e1000_phy_reset_dsp(struct e1000_hw *hw); 73 s32 e1000_phy_has_link_generic(struct e1000_hw *hw, u32 iterations, 74 u32 usec_interval, bool *success); 75 s32 e1000_phy_init_script_igp3(struct e1000_hw *hw); 76 enum e1000_phy_type e1000_get_phy_type_from_id(u32 phy_id); 77 s32 e1000_determine_phy_address(struct e1000_hw *hw); 78 s32 e1000_write_phy_reg_bm(struct e1000_hw *hw, u32 offset, u16 data); 79 s32 e1000_read_phy_reg_bm(struct e1000_hw *hw, u32 offset, u16 *data); 80 s32 e1000_read_phy_reg_bm2(struct e1000_hw *hw, u32 offset, u16 *data); 81 s32 e1000_write_phy_reg_bm2(struct e1000_hw *hw, u32 offset, u16 data); 82 void e1000_power_up_phy_copper(struct e1000_hw *hw); 83 void e1000_power_down_phy_copper(struct e1000_hw *hw); 84 s32 e1000_read_phy_reg_mdic(struct e1000_hw *hw, u32 offset, u16 *data); 85 s32 e1000_write_phy_reg_mdic(struct e1000_hw *hw, u32 offset, u16 data); 86 87 #define E1000_MAX_PHY_ADDR 4 88 89 /* IGP01E1000 Specific Registers */ 90 #define IGP01E1000_PHY_PORT_CONFIG 0x10 /* Port Config */ 91 #define IGP01E1000_PHY_PORT_STATUS 0x11 /* Status */ 92 #define IGP01E1000_PHY_PORT_CTRL 0x12 /* Control */ 93 #define IGP01E1000_PHY_LINK_HEALTH 0x13 /* PHY Link Health */ 94 #define IGP01E1000_GMII_FIFO 0x14 /* GMII FIFO */ 95 #define IGP01E1000_PHY_CHANNEL_QUALITY 0x15 /* PHY Channel Quality */ 96 #define IGP02E1000_PHY_POWER_MGMT 0x19 /* Power Management */ 97 #define IGP01E1000_PHY_PAGE_SELECT 0x1F /* Page Select */ 98 #define BM_PHY_PAGE_SELECT 22 /* Page Select for BM */ 99 #define IGP_PAGE_SHIFT 5 100 #define PHY_REG_MASK 0x1F 101 102 /* BM/HV Specific Registers */ 103 #define BM_PORT_CTRL_PAGE 769 104 #define BM_PCIE_PAGE 770 105 #define BM_WUC_PAGE 800 106 #define BM_WUC_ADDRESS_OPCODE 0x11 107 #define BM_WUC_DATA_OPCODE 0x12 108 #define BM_WUC_ENABLE_PAGE BM_PORT_CTRL_PAGE 109 #define BM_WUC_ENABLE_REG 17 110 #define BM_WUC_ENABLE_BIT (1 << 2) 111 #define BM_WUC_HOST_WU_BIT (1 << 4) 112 113 #define PHY_UPPER_SHIFT 21 114 #define BM_PHY_REG(page, reg) \ 115 (((reg) & MAX_PHY_REG_ADDRESS) |\ 116 (((page) & 0xFFFF) << PHY_PAGE_SHIFT) |\ 117 (((reg) & ~MAX_PHY_REG_ADDRESS) << (PHY_UPPER_SHIFT - PHY_PAGE_SHIFT))) 118 #define BM_PHY_REG_PAGE(offset) \ 119 ((u16)(((offset) >> PHY_PAGE_SHIFT) & 0xFFFF)) 120 #define BM_PHY_REG_NUM(offset) \ 121 ((u16)(((offset) & MAX_PHY_REG_ADDRESS) |\ 122 (((offset) >> (PHY_UPPER_SHIFT - PHY_PAGE_SHIFT)) &\ 123 ~MAX_PHY_REG_ADDRESS))) 124 125 /* BM PHY Copper Specific Control 1 */ 126 #define BM_CS_CTRL1 16 127 #define BM_CS_CTRL1_ENERGY_DETECT 0x0300 /* Enable Energy Detect */ 128 129 /* BM PHY Copper Specific States */ 130 #define BM_CS_STATUS 17 131 #define BM_CS_STATUS_ENERGY_DETECT 0x0010 /* Energy Detect Status */ 132 133 #define IGP01E1000_PHY_PCS_INIT_REG 0x00B4 134 #define IGP01E1000_PHY_POLARITY_MASK 0x0078 135 136 #define IGP01E1000_PSCR_AUTO_MDIX 0x1000 137 #define IGP01E1000_PSCR_FORCE_MDI_MDIX 0x2000 /* 0=MDI, 1=MDIX */ 138 139 #define IGP01E1000_PSCFR_SMART_SPEED 0x0080 140 141 /* Enable flexible speed on link-up */ 142 #define IGP01E1000_GMII_FLEX_SPD 0x0010 143 #define IGP01E1000_GMII_SPD 0x0020 /* Enable SPD */ 144 145 #define IGP02E1000_PM_SPD 0x0001 /* Smart Power Down */ 146 #define IGP02E1000_PM_D0_LPLU 0x0002 /* For D0a states */ 147 #define IGP02E1000_PM_D3_LPLU 0x0004 /* For all other states */ 148 149 #define IGP01E1000_PLHR_SS_DOWNGRADE 0x8000 150 151 #define IGP01E1000_PSSR_POLARITY_REVERSED 0x0002 152 #define IGP01E1000_PSSR_MDIX 0x0008 153 #define IGP01E1000_PSSR_SPEED_MASK 0xC000 154 #define IGP01E1000_PSSR_SPEED_1000MBPS 0xC000 155 156 #define IGP02E1000_PHY_CHANNEL_NUM 4 157 #define IGP02E1000_PHY_AGC_A 0x11B1 158 #define IGP02E1000_PHY_AGC_B 0x12B1 159 #define IGP02E1000_PHY_AGC_C 0x14B1 160 #define IGP02E1000_PHY_AGC_D 0x18B1 161 162 #define IGP02E1000_AGC_LENGTH_SHIFT 9 /* Course - 15:13, Fine - 12:9 */ 163 #define IGP02E1000_AGC_LENGTH_MASK 0x7F 164 #define IGP02E1000_AGC_RANGE 15 165 166 #define IGP03E1000_PHY_MISC_CTRL 0x1B 167 #define IGP03E1000_PHY_MISC_DUPLEX_MANUAL_SET 0x1000 /* Manually Set Duplex */ 168 169 #define E1000_CABLE_LENGTH_UNDEFINED 0xFF 170 171 #define E1000_KMRNCTRLSTA_OFFSET 0x001F0000 172 #define E1000_KMRNCTRLSTA_OFFSET_SHIFT 16 173 #define E1000_KMRNCTRLSTA_REN 0x00200000 174 #define E1000_KMRNCTRLSTA_DIAG_OFFSET 0x3 /* Kumeran Diagnostic */ 175 #define E1000_KMRNCTRLSTA_DIAG_NELPBK 0x1000 /* Nearend Loopback mode */ 176 177 #define IFE_PHY_EXTENDED_STATUS_CONTROL 0x10 178 #define IFE_PHY_SPECIAL_CONTROL 0x11 /* 100BaseTx PHY Special Control */ 179 #define IFE_PHY_SPECIAL_CONTROL_LED 0x1B /* PHY Special and LED Control */ 180 #define IFE_PHY_MDIX_CONTROL 0x1C /* MDI/MDI-X Control */ 181 182 /* IFE PHY Extended Status Control */ 183 #define IFE_PESC_POLARITY_REVERSED 0x0100 184 185 /* IFE PHY Special Control */ 186 #define IFE_PSC_AUTO_POLARITY_DISABLE 0x0010 187 #define IFE_PSC_FORCE_POLARITY 0x0020 188 #define IFE_PSC_DISABLE_DYNAMIC_POWER_DOWN 0x0100 189 190 /* IFE PHY Special Control and LED Control */ 191 #define IFE_PSCL_PROBE_MODE 0x0020 192 #define IFE_PSCL_PROBE_LEDS_OFF 0x0006 /* Force LEDs 0 and 2 off */ 193 #define IFE_PSCL_PROBE_LEDS_ON 0x0007 /* Force LEDs 0 and 2 on */ 194 195 /* IFE PHY MDIX Control */ 196 #define IFE_PMC_MDIX_STATUS 0x0020 /* 1=MDI-X, 0=MDI */ 197 #define IFE_PMC_FORCE_MDIX 0x0040 /* 1=force MDI-X, 0=force MDI */ 198 #define IFE_PMC_AUTO_MDIX 0x0080 /* 1=enable auto MDI/MDI-X, 0=disable */ 199 200 #endif 201