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