A bit further.
[akaros.git] / kern / drivers / net / e1000 / e1000_phy.h
1 /*******************************************************************************
2
3   Intel PRO/1000 Linux driver
4   Copyright(c) 1999 - 2008 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
30 #ifndef _E1000_PHY_H_
31 #define _E1000_PHY_H_
32
33 void e1000_init_phy_ops_generic(struct e1000_hw *hw);
34 int32_t  e1000_null_read_reg(struct e1000_hw *hw, uint32_t offset, uint16_t *data);
35 void e1000_null_phy_generic(struct e1000_hw *hw);
36 int32_t  e1000_null_lplu_state(struct e1000_hw *hw, bool active);
37 int32_t  e1000_null_write_reg(struct e1000_hw *hw, uint32_t offset, uint16_t data);
38 int32_t  e1000_check_downshift_generic(struct e1000_hw *hw);
39 int32_t  e1000_check_polarity_m88(struct e1000_hw *hw);
40 int32_t  e1000_check_polarity_igp(struct e1000_hw *hw);
41 int32_t  e1000_check_polarity_ife(struct e1000_hw *hw);
42 int32_t  e1000_check_reset_block_generic(struct e1000_hw *hw);
43 int32_t  e1000_copper_link_autoneg(struct e1000_hw *hw);
44 int32_t  e1000_copper_link_setup_igp(struct e1000_hw *hw);
45 int32_t  e1000_copper_link_setup_m88(struct e1000_hw *hw);
46 #if 0
47 s32  e1000_phy_force_speed_duplex_igp(struct e1000_hw *hw);
48 s32  e1000_phy_force_speed_duplex_m88(struct e1000_hw *hw);
49 s32  e1000_phy_force_speed_duplex_ife(struct e1000_hw *hw);
50 #endif
51 #if 0
52 s32  e1000_get_cable_length_m88(struct e1000_hw *hw);
53 s32  e1000_get_cable_length_igp_2(struct e1000_hw *hw);
54 #endif
55 int32_t  e1000_get_cfg_done_generic(struct e1000_hw *hw);
56 int32_t  e1000_get_phy_id(struct e1000_hw *hw);
57 int32_t  e1000_get_phy_info_igp(struct e1000_hw *hw);
58 int32_t  e1000_get_phy_info_m88(struct e1000_hw *hw);
59 int32_t  e1000_phy_sw_reset_generic(struct e1000_hw *hw);
60 #if 0
61 void e1000_phy_force_speed_duplex_setup(struct e1000_hw *hw, u16 *phy_ctrl);
62 #endif
63 int32_t  e1000_phy_hw_reset_generic(struct e1000_hw *hw);
64 int32_t  e1000_phy_reset_dsp_generic(struct e1000_hw *hw);
65 int32_t  e1000_phy_setup_autoneg(struct e1000_hw *hw);
66 int32_t  e1000_read_kmrn_reg_generic(struct e1000_hw *hw, uint32_t offset,
67                                  uint16_t *data);
68 int32_t  e1000_read_phy_reg_igp(struct e1000_hw *hw,
69                             uint32_t offset, uint16_t *data);
70 int32_t  e1000_read_phy_reg_m88(struct e1000_hw *hw,
71                             uint32_t offset, uint16_t *data);
72 int32_t  e1000_set_d3_lplu_state_generic(struct e1000_hw *hw, bool active);
73 int32_t  e1000_setup_copper_link_generic(struct e1000_hw *hw);
74 int32_t  e1000_wait_autoneg_generic(struct e1000_hw *hw);
75 int32_t  e1000_write_kmrn_reg_generic(struct e1000_hw *hw, uint32_t offset,
76                                   uint16_t data);
77 int32_t  e1000_write_phy_reg_igp(struct e1000_hw *hw,
78                              uint32_t offset, uint16_t data);
79 int32_t  e1000_write_phy_reg_m88(struct e1000_hw *hw,
80                              uint32_t offset, uint16_t data);
81 int32_t  e1000_phy_reset_dsp(struct e1000_hw *hw);
82 int32_t  e1000_phy_has_link_generic(struct e1000_hw *hw, uint32_t iterations,
83                                 uint32_t usec_interval, bool *success);
84 int32_t  e1000_phy_init_script_igp3(struct e1000_hw *hw);
85 enum e1000_phy_type e1000_get_phy_type_from_id(uint32_t phy_id);
86 int32_t  e1000_determine_phy_address(struct e1000_hw *hw);
87 void e1000_power_up_phy_copper(struct e1000_hw *hw);
88 void e1000_power_down_phy_copper(struct e1000_hw *hw);
89 int32_t  e1000_read_phy_reg_mdic(struct e1000_hw *hw,
90                              uint32_t offset, uint16_t *data);
91 int32_t  e1000_write_phy_reg_mdic(struct e1000_hw *hw,
92                               uint32_t offset, uint16_t data);
93
94 #define E1000_MAX_PHY_ADDR                4
95
96 /* IGP01E1000 Specific Registers */
97 #define IGP01E1000_PHY_PORT_CONFIG        0x10 /* Port Config */
98 #define IGP01E1000_PHY_PORT_STATUS        0x11 /* Status */
99 #define IGP01E1000_PHY_PORT_CTRL          0x12 /* Control */
100 #define IGP01E1000_PHY_LINK_HEALTH        0x13 /* PHY Link Health */
101 #define IGP01E1000_GMII_FIFO              0x14 /* GMII FIFO */
102 #define IGP01E1000_PHY_CHANNEL_QUALITY    0x15 /* PHY Channel Quality */
103 #define IGP02E1000_PHY_POWER_MGMT         0x19 /* Power Management */
104 #define IGP01E1000_PHY_PAGE_SELECT        0x1F /* Page Select */
105 #define BM_PHY_PAGE_SELECT                22   /* Page Select for BM */
106 #define IGP_PAGE_SHIFT                    5
107 #define PHY_REG_MASK                      0x1F
108
109 #define IGP01E1000_PHY_PCS_INIT_REG       0x00B4
110 #define IGP01E1000_PHY_POLARITY_MASK      0x0078
111
112 #define IGP01E1000_PSCR_AUTO_MDIX         0x1000
113 #define IGP01E1000_PSCR_FORCE_MDI_MDIX    0x2000 /* 0=MDI, 1=MDIX */
114
115 #define IGP01E1000_PSCFR_SMART_SPEED      0x0080
116
117 /* Enable flexible speed on link-up */
118 #define IGP01E1000_GMII_FLEX_SPD          0x0010
119 #define IGP01E1000_GMII_SPD               0x0020 /* Enable SPD */
120
121 #define IGP02E1000_PM_SPD                 0x0001 /* Smart Power Down */
122 #define IGP02E1000_PM_D0_LPLU             0x0002 /* For D0a states */
123 #define IGP02E1000_PM_D3_LPLU             0x0004 /* For all other states */
124
125 #define IGP01E1000_PLHR_SS_DOWNGRADE      0x8000
126
127 #define IGP01E1000_PSSR_POLARITY_REVERSED 0x0002
128 #define IGP01E1000_PSSR_MDIX              0x0800
129 #define IGP01E1000_PSSR_SPEED_MASK        0xC000
130 #define IGP01E1000_PSSR_SPEED_1000MBPS    0xC000
131
132 #define IGP02E1000_PHY_CHANNEL_NUM        4
133 #define IGP02E1000_PHY_AGC_A              0x11B1
134 #define IGP02E1000_PHY_AGC_B              0x12B1
135 #define IGP02E1000_PHY_AGC_C              0x14B1
136 #define IGP02E1000_PHY_AGC_D              0x18B1
137
138 #define IGP02E1000_AGC_LENGTH_SHIFT       9   /* Course - 15:13, Fine - 12:9 */
139 #define IGP02E1000_AGC_LENGTH_MASK        0x7F
140 #define IGP02E1000_AGC_RANGE              15
141
142 #define IGP03E1000_PHY_MISC_CTRL          0x1B
143 #define IGP03E1000_PHY_MISC_DUPLEX_MANUAL_SET  0x1000 /* Manually Set Duplex */
144
145 #define E1000_CABLE_LENGTH_UNDEFINED      0xFF
146
147 #define E1000_KMRNCTRLSTA_OFFSET          0x001F0000
148 #define E1000_KMRNCTRLSTA_OFFSET_SHIFT    16
149 #define E1000_KMRNCTRLSTA_REN             0x00200000
150 #define E1000_KMRNCTRLSTA_DIAG_OFFSET     0x3    /* Kumeran Diagnostic */
151 #define E1000_KMRNCTRLSTA_TIMEOUTS        0x4    /* Kumeran Timeouts */
152 #define E1000_KMRNCTRLSTA_INBAND_PARAM    0x9    /* Kumeran InBand Parameters */
153 #define E1000_KMRNCTRLSTA_DIAG_NELPBK     0x1000 /* Nearend Loopback mode */
154
155 #define IFE_PHY_EXTENDED_STATUS_CONTROL 0x10
156 #define IFE_PHY_SPECIAL_CONTROL     0x11 /* 100BaseTx PHY Special Control */
157 #define IFE_PHY_SPECIAL_CONTROL_LED 0x1B /* PHY Special and LED Control */
158 #define IFE_PHY_MDIX_CONTROL        0x1C /* MDI/MDI-X Control */
159
160 /* IFE PHY Extended Status Control */
161 #define IFE_PESC_POLARITY_REVERSED    0x0100
162
163 /* IFE PHY Special Control */
164 #define IFE_PSC_AUTO_POLARITY_DISABLE      0x0010
165 #define IFE_PSC_FORCE_POLARITY             0x0020
166 #define IFE_PSC_DISABLE_DYNAMIC_POWER_DOWN 0x0100
167
168 /* IFE PHY Special Control and LED Control */
169 #define IFE_PSCL_PROBE_MODE            0x0020
170 #define IFE_PSCL_PROBE_LEDS_OFF        0x0006 /* Force LEDs 0 and 2 off */
171 #define IFE_PSCL_PROBE_LEDS_ON         0x0007 /* Force LEDs 0 and 2 on */
172
173 /* IFE PHY MDIX Control */
174 #define IFE_PMC_MDIX_STATUS      0x0020 /* 1=MDI-X, 0=MDI */
175 #define IFE_PMC_FORCE_MDIX       0x0040 /* 1=force MDI-X, 0=force MDI */
176 #define IFE_PMC_AUTO_MDIX        0x0080 /* 1=enable auto MDI/MDI-X, 0=disable */
177
178 #endif