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