1/* SPDX-License-Identifier: GPL-2.0 */
2/* Copyright(c) 1999 - 2018 Intel Corporation. */
3
4#ifndef _E1000E_PHY_H_
5#define _E1000E_PHY_H_
6
7s32 e1000e_check_downshift(struct e1000_hw *hw);
8s32 e1000_check_polarity_m88(struct e1000_hw *hw);
9s32 e1000_check_polarity_igp(struct e1000_hw *hw);
10s32 e1000_check_polarity_ife(struct e1000_hw *hw);
11s32 e1000e_check_reset_block_generic(struct e1000_hw *hw);
12s32 e1000e_copper_link_setup_igp(struct e1000_hw *hw);
13s32 e1000e_copper_link_setup_m88(struct e1000_hw *hw);
14s32 e1000e_phy_force_speed_duplex_igp(struct e1000_hw *hw);
15s32 e1000e_phy_force_speed_duplex_m88(struct e1000_hw *hw);
16s32 e1000_phy_force_speed_duplex_ife(struct e1000_hw *hw);
17s32 e1000e_get_cable_length_m88(struct e1000_hw *hw);
18s32 e1000e_get_cable_length_igp_2(struct e1000_hw *hw);
19s32 e1000e_get_cfg_done_generic(struct e1000_hw *hw);
20s32 e1000e_get_phy_id(struct e1000_hw *hw);
21s32 e1000e_get_phy_info_igp(struct e1000_hw *hw);
22s32 e1000e_get_phy_info_m88(struct e1000_hw *hw);
23s32 e1000_get_phy_info_ife(struct e1000_hw *hw);
24s32 e1000e_phy_sw_reset(struct e1000_hw *hw);
25void e1000e_phy_force_speed_duplex_setup(struct e1000_hw *hw, u16 *phy_ctrl);
26s32 e1000e_phy_hw_reset_generic(struct e1000_hw *hw);
27s32 e1000e_phy_reset_dsp(struct e1000_hw *hw);
28s32 e1000e_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data);
29s32 e1000e_read_kmrn_reg_locked(struct e1000_hw *hw, u32 offset, u16 *data);
30s32 e1000_set_page_igp(struct e1000_hw *hw, u16 page);
31s32 e1000e_read_phy_reg_igp(struct e1000_hw *hw, u32 offset, u16 *data);
32s32 e1000e_read_phy_reg_igp_locked(struct e1000_hw *hw, u32 offset, u16 *data);
33s32 e1000e_read_phy_reg_m88(struct e1000_hw *hw, u32 offset, u16 *data);
34s32 e1000e_set_d3_lplu_state(struct e1000_hw *hw, bool active);
35s32 e1000e_setup_copper_link(struct e1000_hw *hw);
36s32 e1000e_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data);
37s32 e1000e_write_kmrn_reg_locked(struct e1000_hw *hw, u32 offset, u16 data);
38s32 e1000e_write_phy_reg_igp(struct e1000_hw *hw, u32 offset, u16 data);
39s32 e1000e_write_phy_reg_igp_locked(struct e1000_hw *hw, u32 offset, u16 data);
40s32 e1000e_write_phy_reg_m88(struct e1000_hw *hw, u32 offset, u16 data);
41s32 e1000e_phy_has_link_generic(struct e1000_hw *hw, u32 iterations,
42 u32 usec_interval, bool *success);
43s32 e1000e_phy_init_script_igp3(struct e1000_hw *hw);
44enum e1000_phy_type e1000e_get_phy_type_from_id(u32 phy_id);
45s32 e1000e_determine_phy_address(struct e1000_hw *hw);
46s32 e1000e_write_phy_reg_bm(struct e1000_hw *hw, u32 offset, u16 data);
47s32 e1000e_read_phy_reg_bm(struct e1000_hw *hw, u32 offset, u16 *data);
48s32 e1000_enable_phy_wakeup_reg_access_bm(struct e1000_hw *hw, u16 *phy_reg);
49s32 e1000_disable_phy_wakeup_reg_access_bm(struct e1000_hw *hw, u16 *phy_reg);
50s32 e1000e_read_phy_reg_bm2(struct e1000_hw *hw, u32 offset, u16 *data);
51s32 e1000e_write_phy_reg_bm2(struct e1000_hw *hw, u32 offset, u16 data);
52void e1000_power_up_phy_copper(struct e1000_hw *hw);
53void e1000_power_down_phy_copper(struct e1000_hw *hw);
54void e1000e_disable_phy_retry(struct e1000_hw *hw);
55void e1000e_enable_phy_retry(struct e1000_hw *hw);
56s32 e1000e_read_phy_reg_mdic(struct e1000_hw *hw, u32 offset, u16 *data);
57s32 e1000e_write_phy_reg_mdic(struct e1000_hw *hw, u32 offset, u16 data);
58s32 e1000_read_phy_reg_hv(struct e1000_hw *hw, u32 offset, u16 *data);
59s32 e1000_read_phy_reg_hv_locked(struct e1000_hw *hw, u32 offset, u16 *data);
60s32 e1000_read_phy_reg_page_hv(struct e1000_hw *hw, u32 offset, u16 *data);
61s32 e1000_write_phy_reg_hv(struct e1000_hw *hw, u32 offset, u16 data);
62s32 e1000_write_phy_reg_hv_locked(struct e1000_hw *hw, u32 offset, u16 data);
63s32 e1000_write_phy_reg_page_hv(struct e1000_hw *hw, u32 offset, u16 data);
64s32 e1000_link_stall_workaround_hv(struct e1000_hw *hw);
65s32 e1000_copper_link_setup_82577(struct e1000_hw *hw);
66s32 e1000_check_polarity_82577(struct e1000_hw *hw);
67s32 e1000_get_phy_info_82577(struct e1000_hw *hw);
68s32 e1000_phy_force_speed_duplex_82577(struct e1000_hw *hw);
69s32 e1000_get_cable_length_82577(struct e1000_hw *hw);
70
71#define E1000_MAX_PHY_ADDR 8
72
73/* IGP01E1000 Specific Registers */
74#define IGP01E1000_PHY_PORT_CONFIG 0x10 /* Port Config */
75#define IGP01E1000_PHY_PORT_STATUS 0x11 /* Status */
76#define IGP01E1000_PHY_PORT_CTRL 0x12 /* Control */
77#define IGP01E1000_PHY_LINK_HEALTH 0x13 /* PHY Link Health */
78#define IGP02E1000_PHY_POWER_MGMT 0x19 /* Power Management */
79#define IGP01E1000_PHY_PAGE_SELECT 0x1F /* Page Select */
80#define BM_PHY_PAGE_SELECT 22 /* Page Select for BM */
81#define IGP_PAGE_SHIFT 5
82#define PHY_REG_MASK 0x1F
83
84/* BM/HV Specific Registers */
85#define BM_PORT_CTRL_PAGE 769
86#define BM_WUC_PAGE 800
87#define BM_WUC_ADDRESS_OPCODE 0x11
88#define BM_WUC_DATA_OPCODE 0x12
89#define BM_WUC_ENABLE_PAGE BM_PORT_CTRL_PAGE
90#define BM_WUC_ENABLE_REG 17
91#define BM_WUC_ENABLE_BIT BIT(2)
92#define BM_WUC_HOST_WU_BIT BIT(4)
93#define BM_WUC_ME_WU_BIT BIT(5)
94
95#define PHY_UPPER_SHIFT 21
96#define BM_PHY_REG(page, reg) \
97 (((reg) & MAX_PHY_REG_ADDRESS) |\
98 (((page) & 0xFFFF) << PHY_PAGE_SHIFT) |\
99 (((reg) & ~MAX_PHY_REG_ADDRESS) << (PHY_UPPER_SHIFT - PHY_PAGE_SHIFT)))
100#define BM_PHY_REG_PAGE(offset) \
101 ((u16)(((offset) >> PHY_PAGE_SHIFT) & 0xFFFF))
102#define BM_PHY_REG_NUM(offset) \
103 ((u16)(((offset) & MAX_PHY_REG_ADDRESS) |\
104 (((offset) >> (PHY_UPPER_SHIFT - PHY_PAGE_SHIFT)) &\
105 ~MAX_PHY_REG_ADDRESS)))
106
107#define HV_INTC_FC_PAGE_START 768
108#define I82578_ADDR_REG 29
109#define I82577_ADDR_REG 16
110#define I82577_CFG_REG 22
111#define I82577_CFG_ASSERT_CRS_ON_TX BIT(15)
112#define I82577_CFG_ENABLE_DOWNSHIFT (3u << 10) /* auto downshift */
113#define I82577_CTRL_REG 23
114
115/* 82577 specific PHY registers */
116#define I82577_PHY_CTRL_2 18
117#define I82577_PHY_LBK_CTRL 19
118#define I82577_PHY_STATUS_2 26
119#define I82577_PHY_DIAG_STATUS 31
120
121/* I82577 PHY Status 2 */
122#define I82577_PHY_STATUS2_REV_POLARITY 0x0400
123#define I82577_PHY_STATUS2_MDIX 0x0800
124#define I82577_PHY_STATUS2_SPEED_MASK 0x0300
125#define I82577_PHY_STATUS2_SPEED_1000MBPS 0x0200
126
127/* I82577 PHY Control 2 */
128#define I82577_PHY_CTRL2_MANUAL_MDIX 0x0200
129#define I82577_PHY_CTRL2_AUTO_MDI_MDIX 0x0400
130#define I82577_PHY_CTRL2_MDIX_CFG_MASK 0x0600
131
132/* I82577 PHY Diagnostics Status */
133#define I82577_DSTATUS_CABLE_LENGTH 0x03FC
134#define I82577_DSTATUS_CABLE_LENGTH_SHIFT 2
135
136/* BM PHY Copper Specific Control 1 */
137#define BM_CS_CTRL1 16
138
139/* BM PHY Copper Specific Status */
140#define BM_CS_STATUS 17
141#define BM_CS_STATUS_LINK_UP 0x0400
142#define BM_CS_STATUS_RESOLVED 0x0800
143#define BM_CS_STATUS_SPEED_MASK 0xC000
144#define BM_CS_STATUS_SPEED_1000 0x8000
145
146/* 82577 Mobile Phy Status Register */
147#define HV_M_STATUS 26
148#define HV_M_STATUS_AUTONEG_COMPLETE 0x1000
149#define HV_M_STATUS_SPEED_MASK 0x0300
150#define HV_M_STATUS_SPEED_1000 0x0200
151#define HV_M_STATUS_SPEED_100 0x0100
152#define HV_M_STATUS_LINK_UP 0x0040
153
154#define IGP01E1000_PHY_PCS_INIT_REG 0x00B4
155#define IGP01E1000_PHY_POLARITY_MASK 0x0078
156
157#define IGP01E1000_PSCR_AUTO_MDIX 0x1000
158#define IGP01E1000_PSCR_FORCE_MDI_MDIX 0x2000 /* 0=MDI, 1=MDIX */
159
160#define IGP01E1000_PSCFR_SMART_SPEED 0x0080
161
162#define IGP02E1000_PM_SPD 0x0001 /* Smart Power Down */
163#define IGP02E1000_PM_D0_LPLU 0x0002 /* For D0a states */
164#define IGP02E1000_PM_D3_LPLU 0x0004 /* For all other states */
165
166#define IGP01E1000_PLHR_SS_DOWNGRADE 0x8000
167
168#define IGP01E1000_PSSR_POLARITY_REVERSED 0x0002
169#define IGP01E1000_PSSR_MDIX 0x0800
170#define IGP01E1000_PSSR_SPEED_MASK 0xC000
171#define IGP01E1000_PSSR_SPEED_1000MBPS 0xC000
172
173#define IGP02E1000_PHY_CHANNEL_NUM 4
174#define IGP02E1000_PHY_AGC_A 0x11B1
175#define IGP02E1000_PHY_AGC_B 0x12B1
176#define IGP02E1000_PHY_AGC_C 0x14B1
177#define IGP02E1000_PHY_AGC_D 0x18B1
178
179#define IGP02E1000_AGC_LENGTH_SHIFT 9 /* Course=15:13, Fine=12:9 */
180#define IGP02E1000_AGC_LENGTH_MASK 0x7F
181#define IGP02E1000_AGC_RANGE 15
182
183#define E1000_CABLE_LENGTH_UNDEFINED 0xFF
184
185#define E1000_KMRNCTRLSTA_OFFSET 0x001F0000
186#define E1000_KMRNCTRLSTA_OFFSET_SHIFT 16
187#define E1000_KMRNCTRLSTA_REN 0x00200000
188#define E1000_KMRNCTRLSTA_CTRL_OFFSET 0x1 /* Kumeran Control */
189#define E1000_KMRNCTRLSTA_DIAG_OFFSET 0x3 /* Kumeran Diagnostic */
190#define E1000_KMRNCTRLSTA_TIMEOUTS 0x4 /* Kumeran Timeouts */
191#define E1000_KMRNCTRLSTA_INBAND_PARAM 0x9 /* Kumeran InBand Parameters */
192#define E1000_KMRNCTRLSTA_IBIST_DISABLE 0x0200 /* Kumeran IBIST Disable */
193#define E1000_KMRNCTRLSTA_DIAG_NELPBK 0x1000 /* Nearend Loopback mode */
194#define E1000_KMRNCTRLSTA_K1_CONFIG 0x7
195#define E1000_KMRNCTRLSTA_K1_ENABLE 0x0002 /* enable K1 */
196#define E1000_KMRNCTRLSTA_HD_CTRL 0x10 /* Kumeran HD Control */
197
198#define IFE_PHY_EXTENDED_STATUS_CONTROL 0x10
199#define IFE_PHY_SPECIAL_CONTROL 0x11 /* 100BaseTx PHY Special Ctrl */
200#define IFE_PHY_SPECIAL_CONTROL_LED 0x1B /* PHY Special and LED Ctrl */
201#define IFE_PHY_MDIX_CONTROL 0x1C /* MDI/MDI-X Control */
202
203/* IFE PHY Extended Status Control */
204#define IFE_PESC_POLARITY_REVERSED 0x0100
205
206/* IFE PHY Special Control */
207#define IFE_PSC_AUTO_POLARITY_DISABLE 0x0010
208#define IFE_PSC_FORCE_POLARITY 0x0020
209
210/* IFE PHY Special Control and LED Control */
211#define IFE_PSCL_PROBE_MODE 0x0020
212#define IFE_PSCL_PROBE_LEDS_OFF 0x0006 /* Force LEDs 0 and 2 off */
213#define IFE_PSCL_PROBE_LEDS_ON 0x0007 /* Force LEDs 0 and 2 on */
214
215/* IFE PHY MDIX Control */
216#define IFE_PMC_MDIX_STATUS 0x0020 /* 1=MDI-X, 0=MDI */
217#define IFE_PMC_FORCE_MDIX 0x0040 /* 1=force MDI-X, 0=force MDI */
218#define IFE_PMC_AUTO_MDIX 0x0080 /* 1=enable auto, 0=disable */
219
220#endif
221