xref: /freebsd/sys/dev/mii/nsphy.c (revision 7f3dea244c40159a41ab22da77a434d7c5b5e85a)
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  * 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/param.h>
75 #include <sys/systm.h>
76 #include <sys/kernel.h>
77 #include <sys/malloc.h>
78 #include <sys/socket.h>
79 #include <sys/errno.h>
80 #include <sys/module.h>
81 #include <sys/bus.h>
82 
83 #include <net/if.h>
84 #include <net/if_media.h>
85 
86 #include <dev/mii/mii.h>
87 #include <dev/mii/miivar.h>
88 #include <dev/mii/miidevs.h>
89 
90 #include <dev/mii/nsphyreg.h>
91 
92 #include "miibus_if.h"
93 
94 #if !defined(lint)
95 static const char rcsid[] =
96 	"$Id$";
97 #endif
98 
99 static int nsphy_probe		__P((device_t));
100 static int nsphy_attach		__P((device_t));
101 static int nsphy_detach		__P((device_t));
102 
103 static device_method_t nsphy_methods[] = {
104 	/* device interface */
105 	DEVMETHOD(device_probe,		nsphy_probe),
106 	DEVMETHOD(device_attach,	nsphy_attach),
107 	DEVMETHOD(device_detach,	nsphy_detach),
108 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
109 	{ 0, 0 }
110 };
111 
112 static devclass_t nsphy_devclass;
113 
114 static driver_t nsphy_driver = {
115 	"nsphy",
116 	nsphy_methods,
117 	sizeof(struct mii_softc)
118 };
119 
120 DRIVER_MODULE(nsphy, miibus, nsphy_driver, nsphy_devclass, 0, 0);
121 
122 int	nsphy_service __P((struct mii_softc *, struct mii_data *, int));
123 void	nsphy_status __P((struct mii_softc *));
124 
125 static int nsphy_probe(dev)
126 	device_t		dev;
127 {
128 	struct mii_attach_args *ma;
129 
130 	ma = device_get_ivars(dev);
131 
132 	if (MII_OUI(ma->mii_id1, ma->mii_id2) != MII_OUI_NATSEMI ||
133 	    MII_MODEL(ma->mii_id2) != MII_MODEL_NATSEMI_DP83840)
134 		return (ENXIO);
135 
136 	device_set_desc(dev, MII_STR_NATSEMI_DP83840);
137 
138 	return (0);
139 }
140 
141 static int nsphy_attach(dev)
142 	device_t		dev;
143 {
144 	struct mii_softc *sc;
145 	struct mii_attach_args *ma;
146 	struct mii_data *mii;
147 
148 	sc = device_get_softc(dev);
149 	ma = device_get_ivars(dev);
150 	sc->mii_dev = device_get_parent(dev);
151 	mii = device_get_softc(sc->mii_dev);
152 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
153 
154 	sc->mii_inst = mii->mii_instance;
155 	sc->mii_phy = ma->mii_phyno;
156 	sc->mii_service = nsphy_service;
157 	sc->mii_pdata = mii;
158 
159 #ifdef foo
160 	/*
161 	 * i82557 wedges if all of its PHYs are isolated!
162 	 */
163 	if (strcmp(device_get_name(device_get_parent(sc->mii_dev)),
164 	    "fxp") == 0 && mii->mii_instance == 0)
165 #endif
166 
167 	sc->mii_flags |= MIIF_NOISOLATE;
168 	mii->mii_instance++;
169 
170 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
171 
172 #if 0
173 	/* Can't do this on the i82557! */
174 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
175 	    BMCR_ISO);
176 #endif
177 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
178 	    BMCR_LOOP|BMCR_S100);
179 
180 	mii_phy_reset(sc);
181 
182 	sc->mii_capabilities =
183 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
184 	device_printf(dev, " ");
185 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
186 		printf("no media present");
187 	else
188 		mii_add_media(mii, sc->mii_capabilities,
189 		    sc->mii_inst);
190 	printf("\n");
191 #undef ADD
192 
193 	MIIBUS_MEDIAINIT(sc->mii_dev);
194 	return(0);
195 }
196 
197 static int nsphy_detach(dev)
198 	device_t		dev;
199 {
200 	struct mii_softc *sc;
201 	struct mii_data *mii;
202 
203 	sc = device_get_softc(dev);
204 	mii = device_get_softc(device_get_parent(dev));
205 	sc->mii_dev = NULL;
206 	LIST_REMOVE(sc, mii_list);
207 
208 	return(0);
209 }
210 
211 int
212 nsphy_service(sc, mii, cmd)
213 	struct mii_softc *sc;
214 	struct mii_data *mii;
215 	int cmd;
216 {
217 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
218 	int reg;
219 
220 	switch (cmd) {
221 	case MII_POLLSTAT:
222 		/*
223 		 * If we're not polling our PHY instance, just return.
224 		 */
225 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
226 			return (0);
227 		break;
228 
229 	case MII_MEDIACHG:
230 		/*
231 		 * If the media indicates a different PHY instance,
232 		 * isolate ourselves.
233 		 */
234 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
235 			reg = PHY_READ(sc, MII_BMCR);
236 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
237 			return (0);
238 		}
239 
240 		/*
241 		 * If the interface is not up, don't do anything.
242 		 */
243 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
244 			break;
245 
246 		reg = PHY_READ(sc, MII_NSPHY_PCR);
247 
248 		/*
249 		 * Set up the PCR to use LED4 to indicate full-duplex
250 		 * in both 10baseT and 100baseTX modes.
251 		 */
252 		reg |= PCR_LED4MODE;
253 
254 		/*
255 		 * Make sure Carrier Intgrity Monitor function is
256 		 * disabled (normal for Node operation, but sometimes
257 		 * it's not set?!)
258 		 */
259 		reg |= PCR_CIMDIS;
260 
261 		/*
262 		 * Make sure "force link good" is set to normal mode.
263 		 * It's only intended for debugging.
264 		 */
265 		reg |= PCR_FLINK100;
266 
267 #if 0
268 		/*
269 		 * Mystery bits which are supposedly `reserved',
270 		 * but we seem to need to set them when the PHY
271 		 * is connected to some interfaces!
272 		 */
273 		reg |= 0x0100 | 0x0400;
274 #endif
275 /*
276 		PHY_WRITE(sc, MII_NSPHY_PCR, reg);
277 */
278 		switch (IFM_SUBTYPE(ife->ifm_media)) {
279 		case IFM_AUTO:
280 			/*
281 			 * If we're already in auto mode, just return.
282 			 */
283 			if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
284 				return (0);
285 			(void) mii_phy_auto(sc, 1);
286 			break;
287 		case IFM_100_T4:
288 			/*
289 			 * XXX Not supported as a manual setting right now.
290 			 */
291 			return (EINVAL);
292 		default:
293 			/*
294 			 * BMCR data is stored in the ifmedia entry.
295 			 */
296 			PHY_WRITE(sc, MII_ANAR,
297 			    mii_anar(ife->ifm_media));
298 			PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
299 		}
300 		break;
301 
302 	case MII_TICK:
303 		/*
304 		 * If we're not currently selected, just return.
305 		 */
306 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
307 			return (0);
308 
309 		/*
310 		 * Only used for autonegotiation.
311 		 */
312 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
313 			return (0);
314 
315 		/*
316 		 * Is the interface even up?
317 		 */
318 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
319 			return (0);
320 
321 		/*
322 		 * Check to see if we have link.  If we do, we don't
323 		 * need to restart the autonegotiation process.  Read
324 		 * the BMSR twice in case it's latched.
325 		 */
326 		reg = PHY_READ(sc, MII_BMSR) |
327 		    PHY_READ(sc, MII_BMSR);
328 		if (reg & BMSR_LINK)
329 			return (0);
330 
331 		/*
332 		 * Only retry autonegotiation every 5 seconds.
333 		 */
334 		if (++sc->mii_ticks != 5)
335 			return (0);
336 
337 		sc->mii_ticks = 0;
338 		mii_phy_reset(sc);
339 		if (mii_phy_auto(sc, 0) == EJUSTRETURN)
340 			return (0);
341 		break;
342 	}
343 
344 	/* Update the media status. */
345 	nsphy_status(sc);
346 
347 	/* Callback if something changed. */
348 	if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
349 		MIIBUS_STATCHG(sc->mii_dev);
350 		sc->mii_active = mii->mii_media_active;
351 	}
352 	return (0);
353 }
354 
355 void
356 nsphy_status(sc)
357 	struct mii_softc *sc;
358 {
359 	struct mii_data *mii = sc->mii_pdata;
360 	int bmsr, bmcr, par, anlpar;
361 
362 	mii->mii_media_status = IFM_AVALID;
363 	mii->mii_media_active = IFM_ETHER;
364 
365 	bmsr = PHY_READ(sc, MII_BMSR) |
366 	    PHY_READ(sc, MII_BMSR);
367 	if (bmsr & BMSR_LINK)
368 		mii->mii_media_status |= IFM_ACTIVE;
369 
370 	bmcr = PHY_READ(sc, MII_BMCR);
371 	if (bmcr & BMCR_ISO) {
372 		mii->mii_media_active |= IFM_NONE;
373 		mii->mii_media_status = 0;
374 		return;
375 	}
376 
377 	if (bmcr & BMCR_LOOP)
378 		mii->mii_media_active |= IFM_LOOP;
379 
380 	if (bmcr & BMCR_AUTOEN) {
381 		/*
382 		 * The PAR status bits are only valid of autonegotiation
383 		 * has completed (or it's disabled).
384 		 */
385 		if ((bmsr & BMSR_ACOMP) == 0) {
386 			/* Erg, still trying, I guess... */
387 			mii->mii_media_active |= IFM_NONE;
388 			return;
389 		}
390 
391 		/*
392 		 * Argh.  The PAR doesn't seem to indicate duplex mode
393 		 * properly!  Determine media based on link partner's
394 		 * advertised capabilities.
395 		 */
396 		if (PHY_READ(sc, MII_ANER) & ANER_LPAN) {
397 			anlpar = PHY_READ(sc, MII_ANAR) &
398 			    PHY_READ(sc, MII_ANLPAR);
399 			if (anlpar & ANLPAR_T4)
400 				mii->mii_media_active |= IFM_100_T4;
401 			else if (anlpar & ANLPAR_TX_FD)
402 				mii->mii_media_active |= IFM_100_TX|IFM_FDX;
403 			else if (anlpar & ANLPAR_TX)
404 				mii->mii_media_active |= IFM_100_TX;
405 			else if (anlpar & ANLPAR_10_FD)
406 				mii->mii_media_active |= IFM_10_T|IFM_FDX;
407 			else if (anlpar & ANLPAR_10)
408 				mii->mii_media_active |= IFM_10_T;
409 			else
410 				mii->mii_media_active |= IFM_NONE;
411 			return;
412 		}
413 
414 		/*
415 		 * Link partner is not capable of autonegotiation.
416 		 * We will never be in full-duplex mode if this is
417 		 * the case, so reading the PAR is OK.
418 		 */
419 		par = PHY_READ(sc, MII_NSPHY_PAR);
420 		if (par & PAR_10)
421 			mii->mii_media_active |= IFM_10_T;
422 		else
423 			mii->mii_media_active |= IFM_100_TX;
424 #if 0
425 		if (par & PAR_FDX)
426 			mii->mii_media_active |= IFM_FDX;
427 #endif
428 	} else
429 		mii->mii_media_active = mii_media_from_bmcr(bmcr);
430 }
431