ihphy.c revision 1.9 1 /* $NetBSD: ihphy.c,v 1.9 2016/07/07 06:55:41 msaitoh Exp $ */
2
3 /*-
4 * Copyright (c) 1998, 1999, 2000 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9 * NASA Ames Research Center, and by Frank van der Linden.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24 * BE 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 /*
34 * Copyright (c) 1997 Manuel Bouyer. All rights reserved.
35 *
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
38 * are met:
39 * 1. Redistributions of source code must retain the above copyright
40 * notice, this list of conditions and the following disclaimer.
41 * 2. Redistributions in binary form must reproduce the above copyright
42 * notice, this list of conditions and the following disclaimer in the
43 * documentation and/or other materials provided with the distribution.
44 *
45 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
46 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
47 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
48 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
49 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
50 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
51 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
52 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
53 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
54 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
55 */
56
57 /*
58 * Driver for Intel's 82577 (Hanksville) Ethernet 10/100/1000 PHY
59 * Data Sheet: http://download.intel.com/design/network/datashts/319439.pdf
60 */
61
62 #include <sys/cdefs.h>
63 __KERNEL_RCSID(0, "$NetBSD: ihphy.c,v 1.9 2016/07/07 06:55:41 msaitoh Exp $");
64
65 #include <sys/param.h>
66 #include <sys/systm.h>
67 #include <sys/kernel.h>
68 #include <sys/device.h>
69 #include <sys/socket.h>
70 #include <sys/errno.h>
71
72 #include <net/if.h>
73 #include <net/if_media.h>
74
75 #include <dev/mii/mii.h>
76 #include <dev/mii/miivar.h>
77 #include <dev/mii/miidevs.h>
78
79 #include <dev/mii/ihphyreg.h>
80
81 static int ihphymatch(device_t, cfdata_t, void *);
82 static void ihphyattach(device_t, device_t, void *);
83
84 CFATTACH_DECL3_NEW(ihphy, sizeof(struct mii_softc),
85 ihphymatch, ihphyattach, mii_phy_detach, mii_phy_activate, NULL, NULL,
86 DVF_DETACH_SHUTDOWN);
87
88 static int ihphy_service(struct mii_softc *, struct mii_data *, int);
89 static void ihphy_status(struct mii_softc *);
90 static void ihphy_reset(struct mii_softc *);
91
92 static const struct mii_phy_funcs ihphy_funcs = {
93 ihphy_service, ihphy_status, ihphy_reset,
94 };
95
96 static const struct mii_phydesc ihphys[] = {
97 { MII_OUI_INTEL, MII_MODEL_INTEL_I82577,
98 MII_STR_INTEL_I82577 },
99 { MII_OUI_INTEL, MII_MODEL_INTEL_I82579,
100 MII_STR_INTEL_I82579 },
101 { MII_OUI_INTEL, MII_MODEL_INTEL_I217,
102 MII_STR_INTEL_I217 },
103
104 { 0, 0,
105 NULL },
106 };
107
108 static int
109 ihphymatch(device_t parent, cfdata_t match, void *aux)
110 {
111 struct mii_attach_args *ma = aux;
112
113 if (mii_phy_match(ma, ihphys) != NULL)
114 return 10;
115
116 return 0;
117 }
118
119 static void
120 ihphyattach(device_t parent, device_t self, void *aux)
121 {
122 struct mii_softc *sc = device_private(self);
123 struct mii_attach_args *ma = aux;
124 struct mii_data *mii = ma->mii_data;
125 const struct mii_phydesc *mpd;
126 int reg;
127
128 mpd = mii_phy_match(ma, ihphys);
129 aprint_naive(": Media interface\n");
130 aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
131
132 sc->mii_dev = self;
133 sc->mii_inst = mii->mii_instance;
134 sc->mii_phy = ma->mii_phyno;
135 sc->mii_funcs = &ihphy_funcs;
136 sc->mii_pdata = mii;
137 sc->mii_flags = ma->mii_flags;
138 sc->mii_anegticks = MII_ANEGTICKS;
139
140 PHY_RESET(sc);
141
142 sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
143 if (sc->mii_capabilities & BMSR_EXTSTAT)
144 sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
145 aprint_normal_dev(self, "");
146 if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 &&
147 (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0)
148 aprint_error("no media present");
149 else
150 mii_phy_add_media(sc);
151 aprint_normal("\n");
152
153 /*
154 * Link setup (as done by Intel's Linux driver for the 82577).
155 */
156 reg = PHY_READ(sc, IHPHY_MII_CFG);
157 reg |= IHPHY_CFG_TX_CRS;
158 reg |= IHPHY_CFG_DOWN_SHIFT;
159 PHY_WRITE(sc, IHPHY_MII_CFG, reg);
160 }
161
162 static int
163 ihphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
164 {
165 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
166 int reg;
167
168 switch (cmd) {
169 case MII_POLLSTAT:
170 /*
171 * If we're not polling our PHY instance, just return.
172 */
173 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
174 return 0;
175 break;
176
177 case MII_MEDIACHG:
178 /*
179 * If the media indicates a different PHY instance,
180 * isolate ourselves.
181 */
182 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
183 reg = PHY_READ(sc, MII_BMCR);
184 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
185 return 0;
186 }
187
188 /*
189 * If the interface is not up, don't do anything.
190 */
191 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
192 break;
193
194 /*
195 * If media is deselected, disable link (standby).
196 */
197 reg = PHY_READ(sc, IHPHY_MII_ECR);
198 if (IFM_SUBTYPE(ife->ifm_media) == IFM_NONE)
199 reg &= ~IHPHY_ECR_LNK_EN;
200 else
201 reg |= IHPHY_ECR_LNK_EN;
202 PHY_WRITE(sc, IHPHY_MII_ECR, reg);
203
204 /*
205 * XXX Adjust MDI/MDIX configuration? Other settings?
206 */
207
208 mii_phy_setmedia(sc);
209 break;
210
211 case MII_TICK:
212 /*
213 * If we're not currently selected, just return.
214 */
215 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
216 return 0;
217
218 if (mii_phy_tick(sc) == EJUSTRETURN)
219 return 0;
220 break;
221
222 case MII_DOWN:
223 mii_phy_down(sc);
224 PHY_WRITE(sc, MII_BMCR, BMCR_PDOWN);
225 return 0;
226 }
227
228 /* Update the media status. */
229 mii_phy_status(sc);
230
231 /* Callback if something changed. */
232 mii_phy_update(sc, cmd);
233 return 0;
234 }
235
236 static void
237 ihphy_status(struct mii_softc *sc)
238 {
239 struct mii_data *mii = sc->mii_pdata;
240 int esr, bmcr, gtsr;
241
242 mii->mii_media_status = IFM_AVALID;
243 mii->mii_media_active = IFM_ETHER;
244
245 esr = PHY_READ(sc, IHPHY_MII_ESR);
246
247 if (esr & IHPHY_ESR_LINK)
248 mii->mii_media_status |= IFM_ACTIVE;
249
250 bmcr = PHY_READ(sc, MII_BMCR);
251 if (bmcr & (BMCR_ISO | BMCR_PDOWN)) {
252 mii->mii_media_active |= IFM_NONE;
253 mii->mii_media_status = 0;
254 return;
255 }
256
257 if (bmcr & BMCR_LOOP)
258 mii->mii_media_active |= IFM_LOOP;
259
260 if (bmcr & BMCR_AUTOEN) {
261 if ((esr & IHPHY_ESR_ANEG_STAT) == 0) {
262 /* Erg, still trying, I guess... */
263 mii->mii_media_active |= IFM_NONE;
264 return;
265 }
266 }
267
268 switch (esr & IHPHY_ESR_SPEED) {
269 case IHPHY_SPEED_1000:
270 mii->mii_media_active |= IFM_1000_T;
271 gtsr = PHY_READ(sc, MII_100T2SR);
272 if (gtsr & GTSR_MS_RES)
273 mii->mii_media_active |= IFM_ETH_MASTER;
274 break;
275
276 case IHPHY_SPEED_100:
277 /* 100BASE-T2 and 100BASE-T4 are not supported. */
278 mii->mii_media_active |= IFM_100_TX;
279 break;
280
281 case IHPHY_SPEED_10:
282 mii->mii_media_active |= IFM_10_T;
283 break;
284
285 default:
286 mii->mii_media_active |= IFM_NONE;
287 mii->mii_media_status = 0;
288 return;
289 }
290
291 if (esr & IHPHY_ESR_DUPLEX)
292 mii->mii_media_active |= IFM_FDX | mii_phy_flowstatus(sc);
293 else
294 mii->mii_media_active |= IFM_HDX;
295 }
296
297 static void
298 ihphy_reset(struct mii_softc *sc)
299 {
300 int reg, i;
301
302 PHY_WRITE(sc, MII_BMCR, BMCR_RESET | BMCR_ISO);
303
304 /*
305 * Regarding reset, the data sheet specifies (page 55):
306 *
307 * "After PHY reset, a delay of 10 ms is required before
308 * any register access using MDIO."
309 */
310 delay(10000);
311
312 /* Wait another 100ms for it to complete. */
313 for (i = 0; i < 100; i++) {
314 reg = PHY_READ(sc, MII_BMCR);
315 if ((reg & BMCR_RESET) == 0)
316 break;
317 delay(1000);
318 }
319
320 if (sc->mii_inst != 0)
321 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
322 }
323