xref: /freebsd/sys/dev/mii/nsphy.c (revision 7431dfd4580e850375fe5478d92ec770344db098)
1 /*	$NetBSD: nsphy.c,v 1.18 1999/07/14 23:57:36 thorpej Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998, 1999 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  *
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 #include <sys/cdefs.h>
58 __FBSDID("$FreeBSD$");
59 
60 /*
61  * driver for National Semiconductor's DP83840A ethernet 10/100 PHY
62  * Data Sheet available from www.national.com
63  */
64 
65 #include <sys/param.h>
66 #include <sys/systm.h>
67 #include <sys/kernel.h>
68 #include <sys/socket.h>
69 #include <sys/errno.h>
70 #include <sys/module.h>
71 #include <sys/bus.h>
72 
73 #include <net/if.h>
74 #include <net/if_var.h>
75 #include <net/if_media.h>
76 
77 #include <dev/mii/mii.h>
78 #include <dev/mii/miivar.h>
79 #include "miidevs.h"
80 
81 #include <dev/mii/nsphyreg.h>
82 
83 #include "miibus_if.h"
84 
85 static int nsphy_probe(device_t);
86 static int nsphy_attach(device_t);
87 
88 static device_method_t nsphy_methods[] = {
89 	/* device interface */
90 	DEVMETHOD(device_probe,		nsphy_probe),
91 	DEVMETHOD(device_attach,	nsphy_attach),
92 	DEVMETHOD(device_detach,	mii_phy_detach),
93 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
94 	DEVMETHOD_END
95 };
96 
97 static devclass_t nsphy_devclass;
98 
99 static driver_t nsphy_driver = {
100 	"nsphy",
101 	nsphy_methods,
102 	sizeof(struct mii_softc)
103 };
104 
105 DRIVER_MODULE(nsphy, miibus, nsphy_driver, nsphy_devclass, 0, 0);
106 
107 static int	nsphy_service(struct mii_softc *, struct mii_data *, int);
108 static void	nsphy_status(struct mii_softc *);
109 static void	nsphy_reset(struct mii_softc *);
110 
111 static const struct mii_phydesc nsphys[] = {
112 	MII_PHY_DESC(xxNATSEMI, DP83840),
113 	MII_PHY_END
114 };
115 
116 static const struct mii_phy_funcs nsphy_funcs = {
117 	nsphy_service,
118 	nsphy_status,
119 	nsphy_reset
120 };
121 
122 static int
123 nsphy_probe(device_t dev)
124 {
125 
126 	return (mii_phy_dev_probe(dev, nsphys, BUS_PROBE_DEFAULT));
127 }
128 
129 static int
130 nsphy_attach(device_t dev)
131 {
132 	const char *nic;
133 	u_int flags;
134 
135 	nic = device_get_name(device_get_parent(device_get_parent(dev)));
136 	flags = MIIF_NOMANPAUSE;
137 	/*
138 	 * Am79C971 wedge when isolating all of their external PHYs.
139 	 */
140 	if (strcmp(nic, "pcn") == 0)
141 		flags |= MIIF_NOISOLATE;
142 	mii_phy_dev_attach(dev, flags, &nsphy_funcs, 1);
143 	return (0);
144 }
145 
146 static int
147 nsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
148 {
149 	int reg;
150 
151 	switch (cmd) {
152 	case MII_POLLSTAT:
153 		break;
154 
155 	case MII_MEDIACHG:
156 		reg = PHY_READ(sc, MII_NSPHY_PCR);
157 
158 		/*
159 		 * Set up the PCR to use LED4 to indicate full-duplex
160 		 * in both 10baseT and 100baseTX modes.
161 		 */
162 		reg |= PCR_LED4MODE;
163 
164 		/*
165 		 * Make sure Carrier Integrity Monitor function is
166 		 * disabled (normal for Node operation, but sometimes
167 		 * it's not set?!)
168 		 */
169 		reg |= PCR_CIMDIS;
170 
171 		/*
172 		 * Make sure "force link good" is set to normal mode.
173 		 * It's only intended for debugging.
174 		 */
175 		reg |= PCR_FLINK100;
176 
177 		/*
178 		 * Mystery bits which are supposedly `reserved',
179 		 * but we seem to need to set them when the PHY
180 		 * is connected to some interfaces:
181 		 *
182 		 * 0x0400 is needed for fxp
183 		 *        (Intel EtherExpress Pro 10+/100B, 82557 chip)
184 		 *        (nsphy with a DP83840 chip)
185 		 * 0x0100 may be needed for some other card
186 		 */
187 		reg |= 0x0100 | 0x0400;
188 
189 		if (strcmp(if_getdname(mii->mii_ifp), "fxp") == 0)
190 			PHY_WRITE(sc, MII_NSPHY_PCR, reg);
191 
192 		mii_phy_setmedia(sc);
193 		break;
194 
195 	case MII_TICK:
196 		if (mii_phy_tick(sc) == EJUSTRETURN)
197 			return (0);
198 		break;
199 	}
200 
201 	/* Update the media status. */
202 	PHY_STATUS(sc);
203 
204 	/* Callback if something changed. */
205 	mii_phy_update(sc, cmd);
206 	return (0);
207 }
208 
209 static void
210 nsphy_status(struct mii_softc *sc)
211 {
212 	struct mii_data *mii = sc->mii_pdata;
213 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
214 	int bmsr, bmcr, par, anlpar;
215 
216 	mii->mii_media_status = IFM_AVALID;
217 	mii->mii_media_active = IFM_ETHER;
218 
219 	bmsr = PHY_READ(sc, MII_BMSR) |
220 	    PHY_READ(sc, MII_BMSR);
221 	if (bmsr & BMSR_LINK)
222 		mii->mii_media_status |= IFM_ACTIVE;
223 
224 	bmcr = PHY_READ(sc, MII_BMCR);
225 	if (bmcr & BMCR_ISO) {
226 		mii->mii_media_active |= IFM_NONE;
227 		mii->mii_media_status = 0;
228 		return;
229 	}
230 
231 	if (bmcr & BMCR_LOOP)
232 		mii->mii_media_active |= IFM_LOOP;
233 
234 	if (bmcr & BMCR_AUTOEN) {
235 		/*
236 		 * The PAR status bits are only valid if autonegotiation
237 		 * has completed (or it's disabled).
238 		 */
239 		if ((bmsr & BMSR_ACOMP) == 0) {
240 			/* Erg, still trying, I guess... */
241 			mii->mii_media_active |= IFM_NONE;
242 			return;
243 		}
244 
245 		/*
246 		 * Argh.  The PAR doesn't seem to indicate duplex mode
247 		 * properly!  Determine media based on link partner's
248 		 * advertised capabilities.
249 		 */
250 		if (PHY_READ(sc, MII_ANER) & ANER_LPAN) {
251 			anlpar = PHY_READ(sc, MII_ANAR) &
252 			    PHY_READ(sc, MII_ANLPAR);
253 			if (anlpar & ANLPAR_TX_FD)
254 				mii->mii_media_active |= IFM_100_TX|IFM_FDX;
255 			else if (anlpar & ANLPAR_T4)
256 				mii->mii_media_active |= IFM_100_T4|IFM_HDX;
257 			else if (anlpar & ANLPAR_TX)
258 				mii->mii_media_active |= IFM_100_TX|IFM_HDX;
259 			else if (anlpar & ANLPAR_10_FD)
260 				mii->mii_media_active |= IFM_10_T|IFM_FDX;
261 			else if (anlpar & ANLPAR_10)
262 				mii->mii_media_active |= IFM_10_T|IFM_HDX;
263 			else
264 				mii->mii_media_active |= IFM_NONE;
265 			if ((mii->mii_media_active & IFM_FDX) != 0)
266 				mii->mii_media_active |=
267 				    mii_phy_flowstatus(sc);
268 			return;
269 		}
270 
271 		/*
272 		 * Link partner is not capable of autonegotiation.
273 		 * We will never be in full-duplex mode if this is
274 		 * the case, so reading the PAR is OK.
275 		 */
276 		par = PHY_READ(sc, MII_NSPHY_PAR);
277 		if (par & PAR_10)
278 			mii->mii_media_active |= IFM_10_T;
279 		else
280 			mii->mii_media_active |= IFM_100_TX;
281 		mii->mii_media_active |= IFM_HDX;
282 	} else
283 		mii->mii_media_active = ife->ifm_media;
284 }
285 
286 static void
287 nsphy_reset(struct mii_softc *sc)
288 {
289 	struct ifmedia_entry *ife = sc->mii_pdata->mii_media.ifm_cur;
290 	int reg, i;
291 
292 	if (sc->mii_flags & MIIF_NOISOLATE)
293 		reg = BMCR_RESET;
294 	else
295 		reg = BMCR_RESET | BMCR_ISO;
296 	PHY_WRITE(sc, MII_BMCR, reg);
297 
298 	/*
299 	 * It is best to allow a little time for the reset to settle
300 	 * in before we start polling the BMCR again.  Notably, the
301 	 * DP83840A manuals state that there should be a 500us delay
302 	 * between asserting software reset and attempting MII serial
303 	 * operations.  Be conservative.
304 	 */
305 	DELAY(1000);
306 
307 	/*
308 	 * Wait another 2s for it to complete.
309 	 * This is only a little overkill as under normal circumstances
310 	 * the PHY can take up to 1s to complete reset.
311 	 * This is also a bit odd because after a reset, the BMCR will
312 	 * clear the reset bit and simply reports 0 even though the reset
313 	 * is not yet complete.
314 	 */
315 	for (i = 0; i < 1000; i++) {
316 		reg = PHY_READ(sc, MII_BMCR);
317 		if (reg != 0 && (reg & BMCR_RESET) == 0)
318 			break;
319 		DELAY(2000);
320 	}
321 
322 	if ((sc->mii_flags & MIIF_NOISOLATE) == 0) {
323 		if ((ife == NULL && sc->mii_inst != 0) ||
324 		    (ife != NULL && IFM_INST(ife->ifm_media) != sc->mii_inst))
325 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
326 	}
327 }
328