1 /* $NetBSD: nsphy.c,v 1.18 1999/07/14 23:57:36 thorpej Exp $ */
2
3 /*-
4 * SPDX-License-Identifier: BSD-2-Clause-NetBSD AND BSD-2-Clause
5 *
6 * Copyright (c) 1998, 1999 The NetBSD Foundation, Inc.
7 * All rights reserved.
8 *
9 * This code is derived from software contributed to The NetBSD Foundation
10 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
11 * NASA Ames Research Center.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
24 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
25 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
26 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
33 */
34
35 /*-
36 * Copyright (c) 1997 Manuel Bouyer. All rights reserved.
37 *
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
40 * are met:
41 * 1. Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * 2. Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in the
45 * documentation and/or other materials provided with the distribution.
46 *
47 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
48 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
49 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
50 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
51 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
52 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
53 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
54 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
55 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
56 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
57 */
58
59 #include <sys/cdefs.h>
60 __FBSDID("$FreeBSD$");
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/param.h>
68 #include <sys/systm.h>
69 #include <sys/kernel.h>
70 #include <sys/socket.h>
71 #include <sys/errno.h>
72 #include <sys/module.h>
73 #include <sys/bus.h>
74
75 #include <net/if.h>
76 #include <net/if_var.h>
77 #include <net/if_media.h>
78
79 #include <dev/mii/mii.h>
80 #include <dev/mii/miivar.h>
81 #include "miidevs.h"
82
83 #include <dev/mii/nsphyreg.h>
84
85 #include "miibus_if.h"
86
87 static int nsphy_probe(device_t);
88 static int nsphy_attach(device_t);
89
90 static device_method_t nsphy_methods[] = {
91 /* device interface */
92 DEVMETHOD(device_probe, nsphy_probe),
93 DEVMETHOD(device_attach, nsphy_attach),
94 DEVMETHOD(device_detach, mii_phy_detach),
95 DEVMETHOD(device_shutdown, bus_generic_shutdown),
96 DEVMETHOD_END
97 };
98
99 static devclass_t nsphy_devclass;
100
101 static driver_t nsphy_driver = {
102 "nsphy",
103 nsphy_methods,
104 sizeof(struct mii_softc)
105 };
106
107 DRIVER_MODULE(nsphy, miibus, nsphy_driver, nsphy_devclass, 0, 0);
108
109 static int nsphy_service(struct mii_softc *, struct mii_data *, int);
110 static void nsphy_status(struct mii_softc *);
111 static void nsphy_reset(struct mii_softc *);
112
113 static const struct mii_phydesc nsphys[] = {
114 MII_PHY_DESC(xxNATSEMI, DP83840),
115 MII_PHY_END
116 };
117
118 static const struct mii_phy_funcs nsphy_funcs = {
119 nsphy_service,
120 nsphy_status,
121 nsphy_reset
122 };
123
124 static int
nsphy_probe(device_t dev)125 nsphy_probe(device_t dev)
126 {
127
128 return (mii_phy_dev_probe(dev, nsphys, BUS_PROBE_DEFAULT));
129 }
130
131 static int
nsphy_attach(device_t dev)132 nsphy_attach(device_t dev)
133 {
134
135 mii_phy_dev_attach(dev, MIIF_NOMANPAUSE, &nsphy_funcs, 1);
136 return (0);
137 }
138
139 static int
nsphy_service(struct mii_softc * sc,struct mii_data * mii,int cmd)140 nsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
141 {
142 int reg;
143
144 switch (cmd) {
145 case MII_POLLSTAT:
146 break;
147
148 case MII_MEDIACHG:
149 reg = PHY_READ(sc, MII_NSPHY_PCR);
150
151 /*
152 * Set up the PCR to use LED4 to indicate full-duplex
153 * in both 10baseT and 100baseTX modes.
154 */
155 reg |= PCR_LED4MODE;
156
157 /*
158 * Make sure Carrier Integrity Monitor function is
159 * disabled (normal for Node operation, but sometimes
160 * it's not set?!)
161 */
162 reg |= PCR_CIMDIS;
163
164 /*
165 * Make sure "force link good" is set to normal mode.
166 * It's only intended for debugging.
167 */
168 reg |= PCR_FLINK100;
169
170 /*
171 * Mystery bits which are supposedly `reserved',
172 * but we seem to need to set them when the PHY
173 * is connected to some interfaces:
174 *
175 * 0x0400 is needed for fxp
176 * (Intel EtherExpress Pro 10+/100B, 82557 chip)
177 * (nsphy with a DP83840 chip)
178 * 0x0100 may be needed for some other card
179 */
180 reg |= 0x0100 | 0x0400;
181
182 if (mii_phy_mac_match(sc, "fxp"))
183 PHY_WRITE(sc, MII_NSPHY_PCR, reg);
184
185 mii_phy_setmedia(sc);
186 break;
187
188 case MII_TICK:
189 if (mii_phy_tick(sc) == EJUSTRETURN)
190 return (0);
191 break;
192 }
193
194 /* Update the media status. */
195 PHY_STATUS(sc);
196
197 /* Callback if something changed. */
198 mii_phy_update(sc, cmd);
199 return (0);
200 }
201
202 static void
nsphy_status(struct mii_softc * sc)203 nsphy_status(struct mii_softc *sc)
204 {
205 struct mii_data *mii = sc->mii_pdata;
206 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
207 int bmsr, bmcr, par, anlpar;
208
209 mii->mii_media_status = IFM_AVALID;
210 mii->mii_media_active = IFM_ETHER;
211
212 bmsr = PHY_READ(sc, MII_BMSR) |
213 PHY_READ(sc, MII_BMSR);
214 if (bmsr & BMSR_LINK)
215 mii->mii_media_status |= IFM_ACTIVE;
216
217 bmcr = PHY_READ(sc, MII_BMCR);
218 if (bmcr & BMCR_ISO) {
219 mii->mii_media_active |= IFM_NONE;
220 mii->mii_media_status = 0;
221 return;
222 }
223
224 if (bmcr & BMCR_LOOP)
225 mii->mii_media_active |= IFM_LOOP;
226
227 if (bmcr & BMCR_AUTOEN) {
228 /*
229 * The PAR status bits are only valid if autonegotiation
230 * has completed (or it's disabled).
231 */
232 if ((bmsr & BMSR_ACOMP) == 0) {
233 /* Erg, still trying, I guess... */
234 mii->mii_media_active |= IFM_NONE;
235 return;
236 }
237
238 /*
239 * Argh. The PAR doesn't seem to indicate duplex mode
240 * properly! Determine media based on link partner's
241 * advertised capabilities.
242 */
243 if (PHY_READ(sc, MII_ANER) & ANER_LPAN) {
244 anlpar = PHY_READ(sc, MII_ANAR) &
245 PHY_READ(sc, MII_ANLPAR);
246 if (anlpar & ANLPAR_TX_FD)
247 mii->mii_media_active |= IFM_100_TX|IFM_FDX;
248 else if (anlpar & ANLPAR_T4)
249 mii->mii_media_active |= IFM_100_T4|IFM_HDX;
250 else if (anlpar & ANLPAR_TX)
251 mii->mii_media_active |= IFM_100_TX|IFM_HDX;
252 else if (anlpar & ANLPAR_10_FD)
253 mii->mii_media_active |= IFM_10_T|IFM_FDX;
254 else if (anlpar & ANLPAR_10)
255 mii->mii_media_active |= IFM_10_T|IFM_HDX;
256 else
257 mii->mii_media_active |= IFM_NONE;
258 if ((mii->mii_media_active & IFM_FDX) != 0)
259 mii->mii_media_active |=
260 mii_phy_flowstatus(sc);
261 return;
262 }
263
264 /*
265 * Link partner is not capable of autonegotiation.
266 * We will never be in full-duplex mode if this is
267 * the case, so reading the PAR is OK.
268 */
269 par = PHY_READ(sc, MII_NSPHY_PAR);
270 if (par & PAR_10)
271 mii->mii_media_active |= IFM_10_T;
272 else
273 mii->mii_media_active |= IFM_100_TX;
274 mii->mii_media_active |= IFM_HDX;
275 } else
276 mii->mii_media_active = ife->ifm_media;
277 }
278
279 static void
nsphy_reset(struct mii_softc * sc)280 nsphy_reset(struct mii_softc *sc)
281 {
282 struct ifmedia_entry *ife = sc->mii_pdata->mii_media.ifm_cur;
283 int reg, i;
284
285 if (sc->mii_flags & MIIF_NOISOLATE)
286 reg = BMCR_RESET;
287 else
288 reg = BMCR_RESET | BMCR_ISO;
289 PHY_WRITE(sc, MII_BMCR, reg);
290
291 /*
292 * It is best to allow a little time for the reset to settle
293 * in before we start polling the BMCR again. Notably, the
294 * DP83840A manuals state that there should be a 500us delay
295 * between asserting software reset and attempting MII serial
296 * operations. Be conservative.
297 */
298 DELAY(1000);
299
300 /*
301 * Wait another 2s for it to complete.
302 * This is only a little overkill as under normal circumstances
303 * the PHY can take up to 1s to complete reset.
304 * This is also a bit odd because after a reset, the BMCR will
305 * clear the reset bit and simply reports 0 even though the reset
306 * is not yet complete.
307 */
308 for (i = 0; i < 1000; i++) {
309 reg = PHY_READ(sc, MII_BMCR);
310 if (reg != 0 && (reg & BMCR_RESET) == 0)
311 break;
312 DELAY(2000);
313 }
314
315 if ((sc->mii_flags & MIIF_NOISOLATE) == 0) {
316 if ((ife == NULL && sc->mii_inst != 0) ||
317 (ife != NULL && IFM_INST(ife->ifm_media) != sc->mii_inst))
318 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
319 }
320 }
321