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