[e1000e] Add e1000e driver
[people/pcmattman/gpxe.git] / src / drivers / net / e1000e / e1000e_phy.h
1 /*******************************************************************************
2
3   Intel PRO/1000 Linux driver
4   Copyright(c) 1999 - 2009 Intel Corporation.
5
6   This program is free software; you can redistribute it and/or modify it
7   under the terms and conditions of the GNU General Public License,
8   version 2, as published by the Free Software Foundation.
9
10   This program is distributed in the hope it will be useful, but WITHOUT
11   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
13   more details.
14
15   You should have received a copy of the GNU General Public License along with
16   this program; if not, write to the Free Software Foundation, Inc.,
17   51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
18
19   The full GNU General Public License is included in this distribution in
20   the file called "COPYING".
21
22   Contact Information:
23   Linux NICS <linux.nics@intel.com>
24   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
25   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
26
27 *******************************************************************************/
28
29 FILE_LICENCE ( GPL2_OR_LATER );
30
31 #ifndef _E1000E_PHY_H_
32 #define _E1000E_PHY_H_
33
34 void e1000e_init_phy_ops_generic(struct e1000_hw *hw);
35 s32  e1000e_check_downshift(struct e1000_hw *hw);
36 s32  e1000e_check_polarity_m88(struct e1000_hw *hw);
37 s32  e1000e_check_polarity_igp(struct e1000_hw *hw);
38 s32  e1000e_check_polarity_ife(struct e1000_hw *hw);
39 s32  e1000e_check_reset_block_generic(struct e1000_hw *hw);
40 s32  e1000e_copper_link_setup_igp(struct e1000_hw *hw);
41 s32  e1000e_copper_link_setup_m88(struct e1000_hw *hw);
42 #if 0
43 s32  e1000e_phy_force_speed_duplex_igp(struct e1000_hw *hw);
44 s32  e1000e_phy_force_speed_duplex_m88(struct e1000_hw *hw);
45 s32  e1000e_phy_force_speed_duplex_ife(struct e1000_hw *hw);
46 #endif
47 #if 0
48 s32  e1000e_get_cable_length_m88(struct e1000_hw *hw);
49 s32  e1000e_get_cable_length_igp_2(struct e1000_hw *hw);
50 #endif
51 s32  e1000e_get_cfg_done(struct e1000_hw *hw);
52 s32  e1000e_get_phy_id(struct e1000_hw *hw);
53 s32  e1000e_get_phy_info_igp(struct e1000_hw *hw);
54 s32  e1000e_get_phy_info_m88(struct e1000_hw *hw);
55 s32  e1000e_phy_sw_reset(struct e1000_hw *hw);
56 #if 0
57 void e1000e_phy_force_speed_duplex_setup(struct e1000_hw *hw, u16 *phy_ctrl);
58 #endif
59 s32  e1000e_phy_hw_reset_generic(struct e1000_hw *hw);
60 s32  e1000e_phy_reset_dsp(struct e1000_hw *hw);
61 s32  e1000e_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data);
62 s32  e1000e_read_kmrn_reg_locked(struct e1000_hw *hw, u32 offset, u16 *data);
63 s32  e1000e_read_phy_reg_igp(struct e1000_hw *hw, u32 offset, u16 *data);
64 s32  e1000e_read_phy_reg_igp_locked(struct e1000_hw *hw, u32 offset, u16 *data);
65 s32  e1000e_read_phy_reg_m88(struct e1000_hw *hw, u32 offset, u16 *data);
66 s32  e1000e_set_d3_lplu_state(struct e1000_hw *hw, bool active);
67 s32  e1000e_setup_copper_link(struct e1000_hw *hw);
68 s32  e1000e_wait_autoneg(struct e1000_hw *hw);
69 s32  e1000e_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data);
70 s32  e1000e_write_kmrn_reg_locked(struct e1000_hw *hw, u32 offset, u16 data);
71 s32  e1000e_write_phy_reg_igp(struct e1000_hw *hw, u32 offset, u16 data);
72 s32  e1000e_write_phy_reg_igp_locked(struct e1000_hw *hw, u32 offset, u16 data);
73 s32  e1000e_write_phy_reg_m88(struct e1000_hw *hw, u32 offset, u16 data);
74 s32  e1000e_phy_reset_dsp(struct e1000_hw *hw);
75 s32  e1000e_phy_has_link_generic(struct e1000_hw *hw, u32 iterations,
76                                 u32 usec_interval, bool *success);
77 s32  e1000e_phy_init_script_igp3(struct e1000_hw *hw);
78 enum e1000_phy_type e1000e_get_phy_type_from_id(u32 phy_id);
79 s32  e1000e_determine_phy_address(struct e1000_hw *hw);
80 s32  e1000e_write_phy_reg_bm(struct e1000_hw *hw, u32 offset, u16 data);
81 s32  e1000e_read_phy_reg_bm(struct e1000_hw *hw, u32 offset, u16 *data);
82 s32  e1000e_read_phy_reg_bm2(struct e1000_hw *hw, u32 offset, u16 *data);
83 s32  e1000e_write_phy_reg_bm2(struct e1000_hw *hw, u32 offset, u16 data);
84 void e1000e_power_up_phy_copper(struct e1000_hw *hw);
85 void e1000e_power_down_phy_copper(struct e1000_hw *hw);
86 s32  e1000e_read_phy_reg_mdic(struct e1000_hw *hw, u32 offset, u16 *data);
87 s32  e1000e_write_phy_reg_mdic(struct e1000_hw *hw, u32 offset, u16 data);
88 s32  e1000e_read_phy_reg_hv(struct e1000_hw *hw, u32 offset, u16 *data);
89 s32  e1000e_read_phy_reg_hv_locked(struct e1000_hw *hw, u32 offset, u16 *data);
90 s32  e1000e_write_phy_reg_hv(struct e1000_hw *hw, u32 offset, u16 data);
91 s32  e1000e_write_phy_reg_hv_locked(struct e1000_hw *hw, u32 offset, u16 data);
92 s32  e1000e_set_mdio_slow_mode_hv(struct e1000_hw *hw, bool slow);
93 s32  e1000e_link_stall_workaround_hv(struct e1000_hw *hw);
94 s32  e1000e_copper_link_setup_82577(struct e1000_hw *hw);
95 s32  e1000e_check_polarity_82577(struct e1000_hw *hw);
96 s32  e1000e_get_phy_info_82577(struct e1000_hw *hw);
97 #if 0
98 s32  e1000e_phy_force_speed_duplex_82577(struct e1000_hw *hw);
99 #endif
100 #if 0
101 s32  e1000e_get_cable_length_82577(struct e1000_hw *hw);
102 #endif
103
104 #define E1000_MAX_PHY_ADDR                4
105
106 /* IGP01E1000 Specific Registers */
107 #define IGP01E1000_PHY_PORT_CONFIG        0x10 /* Port Config */
108 #define IGP01E1000_PHY_PORT_STATUS        0x11 /* Status */
109 #define IGP01E1000_PHY_PORT_CTRL          0x12 /* Control */
110 #define IGP01E1000_PHY_LINK_HEALTH        0x13 /* PHY Link Health */
111 #define IGP01E1000_GMII_FIFO              0x14 /* GMII FIFO */
112 #define IGP01E1000_PHY_CHANNEL_QUALITY    0x15 /* PHY Channel Quality */
113 #define IGP02E1000_PHY_POWER_MGMT         0x19 /* Power Management */
114 #define IGP01E1000_PHY_PAGE_SELECT        0x1F /* Page Select */
115 #define BM_PHY_PAGE_SELECT                22   /* Page Select for BM */
116 #define IGP_PAGE_SHIFT                    5
117 #define PHY_REG_MASK                      0x1F
118
119 /* BM/HV Specific Registers */
120 #define BM_PORT_CTRL_PAGE                 769
121 #define BM_PCIE_PAGE                      770
122 #define BM_WUC_PAGE                       800
123 #define BM_WUC_ADDRESS_OPCODE             0x11
124 #define BM_WUC_DATA_OPCODE                0x12
125 #define BM_WUC_ENABLE_PAGE                BM_PORT_CTRL_PAGE
126 #define BM_WUC_ENABLE_REG                 17
127 #define BM_WUC_ENABLE_BIT                 (1 << 2)
128 #define BM_WUC_HOST_WU_BIT                (1 << 4)
129
130 #define PHY_UPPER_SHIFT                   21
131 #define BM_PHY_REG(page, reg) \
132         (((reg) & MAX_PHY_REG_ADDRESS) |\
133          (((page) & 0xFFFF) << PHY_PAGE_SHIFT) |\
134          (((reg) & ~MAX_PHY_REG_ADDRESS) << (PHY_UPPER_SHIFT - PHY_PAGE_SHIFT)))
135 #define BM_PHY_REG_PAGE(offset) \
136         ((u16)(((offset) >> PHY_PAGE_SHIFT) & 0xFFFF))
137 #define BM_PHY_REG_NUM(offset) \
138         ((u16)(((offset) & MAX_PHY_REG_ADDRESS) |\
139          (((offset) >> (PHY_UPPER_SHIFT - PHY_PAGE_SHIFT)) &\
140                 ~MAX_PHY_REG_ADDRESS)))
141
142 #define HV_INTC_FC_PAGE_START             768
143 #define I82578_ADDR_REG                   29
144 #define I82577_ADDR_REG                   16
145 #define I82577_CFG_REG                    22
146 #define I82577_CFG_ASSERT_CRS_ON_TX       (1 << 15)
147 #define I82577_CFG_ENABLE_DOWNSHIFT       (3 << 10) /* auto downshift 100/10 */
148 #define I82577_CTRL_REG                   23
149
150 /* 82577 specific PHY registers */
151 #define I82577_PHY_CTRL_2            18
152 #define I82577_PHY_LBK_CTRL          19
153 #define I82577_PHY_STATUS_2          26
154 #define I82577_PHY_DIAG_STATUS       31
155
156 /* I82577 PHY Status 2 */
157 #define I82577_PHY_STATUS2_REV_POLARITY   0x0400
158 #define I82577_PHY_STATUS2_MDIX           0x0800
159 #define I82577_PHY_STATUS2_SPEED_MASK     0x0300
160 #define I82577_PHY_STATUS2_SPEED_1000MBPS 0x0200
161 #define I82577_PHY_STATUS2_SPEED_100MBPS  0x0100
162
163 /* I82577 PHY Control 2 */
164 #define I82577_PHY_CTRL2_AUTO_MDIX        0x0400
165 #define I82577_PHY_CTRL2_FORCE_MDI_MDIX   0x0200
166
167 /* I82577 PHY Diagnostics Status */
168 #define I82577_DSTATUS_CABLE_LENGTH       0x03FC
169 #define I82577_DSTATUS_CABLE_LENGTH_SHIFT 2
170
171 /* BM PHY Copper Specific Control 1 */
172 #define BM_CS_CTRL1                       16
173 #define BM_CS_CTRL1_ENERGY_DETECT         0x0300 /* Enable Energy Detect */
174
175 /* BM PHY Copper Specific Status */
176 #define BM_CS_STATUS                      17
177 #define BM_CS_STATUS_ENERGY_DETECT        0x0010 /* Energy Detect Status */
178 #define BM_CS_STATUS_LINK_UP              0x0400
179 #define BM_CS_STATUS_RESOLVED             0x0800
180 #define BM_CS_STATUS_SPEED_MASK           0xC000
181 #define BM_CS_STATUS_SPEED_1000           0x8000
182
183 /* 82577 Mobile Phy Status Register */
184 #define HV_M_STATUS                       26
185 #define HV_M_STATUS_AUTONEG_COMPLETE      0x1000
186 #define HV_M_STATUS_SPEED_MASK            0x0300
187 #define HV_M_STATUS_SPEED_1000            0x0200
188 #define HV_M_STATUS_LINK_UP               0x0040
189
190 #define IGP01E1000_PHY_PCS_INIT_REG       0x00B4
191 #define IGP01E1000_PHY_POLARITY_MASK      0x0078
192
193 #define IGP01E1000_PSCR_AUTO_MDIX         0x1000
194 #define IGP01E1000_PSCR_FORCE_MDI_MDIX    0x2000 /* 0=MDI, 1=MDIX */
195
196 #define IGP01E1000_PSCFR_SMART_SPEED      0x0080
197
198 /* Enable flexible speed on link-up */
199 #define IGP01E1000_GMII_FLEX_SPD          0x0010
200 #define IGP01E1000_GMII_SPD               0x0020 /* Enable SPD */
201
202 #define IGP02E1000_PM_SPD                 0x0001 /* Smart Power Down */
203 #define IGP02E1000_PM_D0_LPLU             0x0002 /* For D0a states */
204 #define IGP02E1000_PM_D3_LPLU             0x0004 /* For all other states */
205
206 #define IGP01E1000_PLHR_SS_DOWNGRADE      0x8000
207
208 #define IGP01E1000_PSSR_POLARITY_REVERSED 0x0002
209 #define IGP01E1000_PSSR_MDIX              0x0800
210 #define IGP01E1000_PSSR_SPEED_MASK        0xC000
211 #define IGP01E1000_PSSR_SPEED_1000MBPS    0xC000
212
213 #define IGP02E1000_PHY_CHANNEL_NUM        4
214 #define IGP02E1000_PHY_AGC_A              0x11B1
215 #define IGP02E1000_PHY_AGC_B              0x12B1
216 #define IGP02E1000_PHY_AGC_C              0x14B1
217 #define IGP02E1000_PHY_AGC_D              0x18B1
218
219 #define IGP02E1000_AGC_LENGTH_SHIFT       9   /* Course - 15:13, Fine - 12:9 */
220 #define IGP02E1000_AGC_LENGTH_MASK        0x7F
221 #define IGP02E1000_AGC_RANGE              15
222
223 #define IGP03E1000_PHY_MISC_CTRL          0x1B
224 #define IGP03E1000_PHY_MISC_DUPLEX_MANUAL_SET  0x1000 /* Manually Set Duplex */
225
226 #define E1000_CABLE_LENGTH_UNDEFINED      0xFF
227
228 #define E1000_KMRNCTRLSTA_OFFSET          0x001F0000
229 #define E1000_KMRNCTRLSTA_OFFSET_SHIFT    16
230 #define E1000_KMRNCTRLSTA_REN             0x00200000
231 #define E1000_KMRNCTRLSTA_DIAG_OFFSET     0x3    /* Kumeran Diagnostic */
232 #define E1000_KMRNCTRLSTA_TIMEOUTS        0x4    /* Kumeran Timeouts */
233 #define E1000_KMRNCTRLSTA_INBAND_PARAM    0x9    /* Kumeran InBand Parameters */
234 #define E1000_KMRNCTRLSTA_DIAG_NELPBK     0x1000 /* Nearend Loopback mode */
235 #define E1000_KMRNCTRLSTA_K1_CONFIG        0x7
236 #define E1000_KMRNCTRLSTA_K1_ENABLE        0x0002
237
238 #define IFE_PHY_EXTENDED_STATUS_CONTROL 0x10
239 #define IFE_PHY_SPECIAL_CONTROL     0x11 /* 100BaseTx PHY Special Control */
240 #define IFE_PHY_SPECIAL_CONTROL_LED 0x1B /* PHY Special and LED Control */
241 #define IFE_PHY_MDIX_CONTROL        0x1C /* MDI/MDI-X Control */
242
243 /* IFE PHY Extended Status Control */
244 #define IFE_PESC_POLARITY_REVERSED    0x0100
245
246 /* IFE PHY Special Control */
247 #define IFE_PSC_AUTO_POLARITY_DISABLE      0x0010
248 #define IFE_PSC_FORCE_POLARITY             0x0020
249 #define IFE_PSC_DISABLE_DYNAMIC_POWER_DOWN 0x0100
250
251 /* IFE PHY Special Control and LED Control */
252 #define IFE_PSCL_PROBE_MODE            0x0020
253 #define IFE_PSCL_PROBE_LEDS_OFF        0x0006 /* Force LEDs 0 and 2 off */
254 #define IFE_PSCL_PROBE_LEDS_ON         0x0007 /* Force LEDs 0 and 2 on */
255
256 /* IFE PHY MDIX Control */
257 #define IFE_PMC_MDIX_STATUS      0x0020 /* 1=MDI-X, 0=MDI */
258 #define IFE_PMC_FORCE_MDIX       0x0040 /* 1=force MDI-X, 0=force MDI */
259 #define IFE_PMC_AUTO_MDIX        0x0080 /* 1=enable auto MDI/MDI-X, 0=disable */
260
261 #endif