nsphy.c revision 1.46.10.1 1 /* $NetBSD: nsphy.c,v 1.46.10.1 2006/10/22 06:06:12 yamt 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.
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 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the NetBSD
22 * Foundation, Inc. and its contributors.
23 * 4. Neither the name of The NetBSD Foundation nor the names of its
24 * contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
26 *
27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 * POSSIBILITY OF SUCH DAMAGE.
38 */
39
40 /*
41 * Copyright (c) 1997 Manuel Bouyer. All rights reserved.
42 *
43 * Redistribution and use in source and binary forms, with or without
44 * modification, are permitted provided that the following conditions
45 * are met:
46 * 1. Redistributions of source code must retain the above copyright
47 * notice, this list of conditions and the following disclaimer.
48 * 2. Redistributions in binary form must reproduce the above copyright
49 * notice, this list of conditions and the following disclaimer in the
50 * documentation and/or other materials provided with the distribution.
51 * 3. All advertising materials mentioning features or use of this software
52 * must display the following acknowledgement:
53 * This product includes software developed by Manuel Bouyer.
54 * 4. The name of the author may not be used to endorse or promote products
55 * derived from this software without specific prior written permission.
56 *
57 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
58 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
59 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
60 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
61 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
62 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
63 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
64 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
65 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
66 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
67 */
68
69 /*
70 * driver for National Semiconductor's DP83840A ethernet 10/100 PHY
71 * Data Sheet available from www.national.com
72 */
73
74 #include <sys/cdefs.h>
75 __KERNEL_RCSID(0, "$NetBSD: nsphy.c,v 1.46.10.1 2006/10/22 06:06:12 yamt Exp $");
76
77 #include <sys/param.h>
78 #include <sys/systm.h>
79 #include <sys/kernel.h>
80 #include <sys/device.h>
81 #include <sys/socket.h>
82 #include <sys/errno.h>
83
84 #include <net/if.h>
85 #include <net/if_media.h>
86
87 #include <dev/mii/mii.h>
88 #include <dev/mii/miivar.h>
89 #include <dev/mii/miidevs.h>
90
91 #include <dev/mii/nsphyreg.h>
92
93 static int nsphymatch(struct device *, struct cfdata *, void *);
94 static void nsphyattach(struct device *, struct device *, void *);
95
96 CFATTACH_DECL(nsphy, sizeof(struct mii_softc),
97 nsphymatch, nsphyattach, mii_phy_detach, mii_phy_activate);
98
99 static int nsphy_service(struct mii_softc *, struct mii_data *, int);
100 static void nsphy_status(struct mii_softc *);
101 static void nsphy_reset(struct mii_softc *sc);
102
103 static const struct mii_phy_funcs nsphy_funcs = {
104 nsphy_service, nsphy_status, nsphy_reset,
105 };
106
107 static const struct mii_phydesc nsphys[] = {
108 { MII_OUI_xxNATSEMI, MII_MODEL_xxNATSEMI_DP83840,
109 MII_STR_xxNATSEMI_DP83840 },
110
111 { 0, 0,
112 NULL },
113 };
114
115 static int
116 nsphymatch(struct device *parent __unused, struct cfdata *match __unused,
117 void *aux)
118 {
119 struct mii_attach_args *ma = aux;
120
121 if (mii_phy_match(ma, nsphys) != NULL)
122 return (10);
123
124 return (0);
125 }
126
127 static void
128 nsphyattach(struct device *parent __unused, struct device *self, void *aux)
129 {
130 struct mii_softc *sc = device_private(self);
131 struct mii_attach_args *ma = aux;
132 struct mii_data *mii = ma->mii_data;
133 const struct mii_phydesc *mpd;
134
135 mpd = mii_phy_match(ma, nsphys);
136 aprint_naive(": Media interface\n");
137 aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
138
139 sc->mii_inst = mii->mii_instance;
140 sc->mii_phy = ma->mii_phyno;
141 sc->mii_funcs = &nsphy_funcs;
142 sc->mii_pdata = mii;
143 sc->mii_flags = ma->mii_flags;
144 sc->mii_anegticks = 5;
145
146 PHY_RESET(sc);
147
148 sc->mii_capabilities =
149 PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
150 aprint_normal("%s: ", sc->mii_dev.dv_xname);
151 if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
152 aprint_error("no media present");
153 else
154 mii_phy_add_media(sc);
155 aprint_normal("\n");
156 }
157
158 static int
159 nsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
160 {
161 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
162 int reg;
163
164 if (!device_is_active(&sc->mii_dev))
165 return (ENXIO);
166
167 switch (cmd) {
168 case MII_POLLSTAT:
169 /*
170 * If we're not polling our PHY instance, just return.
171 */
172 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
173 return (0);
174 break;
175
176 case MII_MEDIACHG:
177 /*
178 * If the media indicates a different PHY instance,
179 * isolate ourselves.
180 */
181 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
182 reg = PHY_READ(sc, MII_BMCR);
183 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
184 return (0);
185 }
186
187 /*
188 * If the interface is not up, don't do anything.
189 */
190 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
191 break;
192
193 reg = PHY_READ(sc, MII_NSPHY_PCR);
194
195 /*
196 * Set up the PCR to use LED4 to indicate full-duplex
197 * in both 10baseT and 100baseTX modes.
198 */
199 reg |= PCR_LED4MODE;
200
201 /*
202 * Make sure Carrier Integrity Monitor function is
203 * disabled (normal for Node operation, but sometimes
204 * it's not set?!)
205 */
206 reg |= PCR_CIMDIS;
207
208 /*
209 * Make sure "force link good" is set to normal mode.
210 * It's only intended for debugging.
211 */
212 reg |= PCR_FLINK100;
213
214 /*
215 * Mystery bits which are supposedly `reserved',
216 * but we seem to need to set them when the PHY
217 * is connected to some interfaces:
218 *
219 * 0x0400 is needed for fxp
220 * (Intel EtherExpress Pro 10+/100B, 82557 chip)
221 * (nsphy with a DP83840 chip)
222 * 0x0100 may be needed for some other card
223 */
224 reg |= 0x0100 | 0x0400;
225
226 PHY_WRITE(sc, MII_NSPHY_PCR, reg);
227
228 mii_phy_setmedia(sc);
229 break;
230
231 case MII_TICK:
232 /*
233 * If we're not currently selected, just return.
234 */
235 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
236 return (0);
237
238 if (mii_phy_tick(sc) == EJUSTRETURN)
239 return (0);
240 break;
241
242 case MII_DOWN:
243 mii_phy_down(sc);
244 return (0);
245 }
246
247 /* Update the media status. */
248 mii_phy_status(sc);
249
250 /* Callback if something changed. */
251 mii_phy_update(sc, cmd);
252 return (0);
253 }
254
255 static void
256 nsphy_status(struct mii_softc *sc)
257 {
258 struct mii_data *mii = sc->mii_pdata;
259 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
260 int bmsr, bmcr, par, anlpar;
261
262 mii->mii_media_status = IFM_AVALID;
263 mii->mii_media_active = IFM_ETHER;
264
265 bmsr = PHY_READ(sc, MII_BMSR) |
266 PHY_READ(sc, MII_BMSR);
267 if (bmsr & BMSR_LINK)
268 mii->mii_media_status |= IFM_ACTIVE;
269
270 bmcr = PHY_READ(sc, MII_BMCR);
271 if (bmcr & BMCR_ISO) {
272 mii->mii_media_active |= IFM_NONE;
273 mii->mii_media_status = 0;
274 return;
275 }
276
277 if (bmcr & BMCR_LOOP)
278 mii->mii_media_active |= IFM_LOOP;
279
280 if (bmcr & BMCR_AUTOEN) {
281 /*
282 * The PAR status bits are only valid of autonegotiation
283 * has completed (or it's disabled).
284 */
285 if ((bmsr & BMSR_ACOMP) == 0) {
286 /* Erg, still trying, I guess... */
287 mii->mii_media_active |= IFM_NONE;
288 return;
289 }
290
291 /*
292 * Argh. The PAR doesn't seem to indicate duplex mode
293 * properly! Determine media based on link partner's
294 * advertised capabilities.
295 */
296 if (PHY_READ(sc, MII_ANER) & ANER_LPAN) {
297 anlpar = PHY_READ(sc, MII_ANAR) &
298 PHY_READ(sc, MII_ANLPAR);
299 if (anlpar & ANLPAR_T4)
300 mii->mii_media_active |= IFM_100_T4;
301 else if (anlpar & ANLPAR_TX_FD)
302 mii->mii_media_active |= IFM_100_TX|IFM_FDX;
303 else if (anlpar & ANLPAR_TX)
304 mii->mii_media_active |= IFM_100_TX;
305 else if (anlpar & ANLPAR_10_FD)
306 mii->mii_media_active |= IFM_10_T|IFM_FDX;
307 else if (anlpar & ANLPAR_10)
308 mii->mii_media_active |= IFM_10_T;
309 else
310 mii->mii_media_active |= IFM_NONE;
311 return;
312 }
313
314 /*
315 * Link partner is not capable of autonegotiation.
316 * We will never be in full-duplex mode if this is
317 * the case, so reading the PAR is OK.
318 */
319 par = PHY_READ(sc, MII_NSPHY_PAR);
320 if (par & PAR_10)
321 mii->mii_media_active |= IFM_10_T;
322 else
323 mii->mii_media_active |= IFM_100_TX;
324 #if 0
325 if (par & PAR_FDX)
326 mii->mii_media_active |= IFM_FDX;
327 #endif
328 } else
329 mii->mii_media_active = ife->ifm_media;
330 }
331
332 static void
333 nsphy_reset(struct mii_softc *sc)
334 {
335 int reg, i;
336
337 if (sc->mii_flags & MIIF_NOISOLATE)
338 reg = BMCR_RESET;
339 else
340 reg = BMCR_RESET | BMCR_ISO;
341 PHY_WRITE(sc, MII_BMCR, reg);
342
343 /*
344 * Give it a little time to settle in case we just got power.
345 * The DP83840A data sheet suggests that a soft reset not happen
346 * within 500us of power being applied. Be conservative.
347 */
348 delay(1000);
349
350 /*
351 * Wait another 2s for it to complete.
352 * This is only a little overkill as under normal circumstances
353 * the PHY can take up to 1s to complete reset.
354 * This is also a bit odd because after a reset, the BMCR will
355 * clear the reset bit and simply reports 0 even though the reset
356 * is not yet complete.
357 */
358 for (i = 0; i < 1000; i++) {
359 reg = PHY_READ(sc, MII_BMCR);
360 if (reg && ((reg & BMCR_RESET) == 0))
361 break;
362 delay(2000);
363 }
364
365 if (sc->mii_inst != 0 && ((sc->mii_flags & MIIF_NOISOLATE) == 0)) {
366 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
367 }
368 }
369