xref: /dragonfly/sys/dev/netif/mii_layer/nsphy.c (revision 2d8a3be7)
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  * $FreeBSD: src/sys/dev/mii/nsphy.c,v 1.2.2.5 2001/06/08 19:58:33 semenu Exp $
40  * $DragonFly: src/sys/dev/netif/mii_layer/nsphy.c,v 1.4 2003/08/27 09:38:31 rob Exp $
41  */
42 
43 /*
44  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
45  *
46  * Redistribution and use in source and binary forms, with or without
47  * modification, are permitted provided that the following conditions
48  * are met:
49  * 1. Redistributions of source code must retain the above copyright
50  *    notice, this list of conditions and the following disclaimer.
51  * 2. Redistributions in binary form must reproduce the above copyright
52  *    notice, this list of conditions and the following disclaimer in the
53  *    documentation and/or other materials provided with the distribution.
54  * 3. All advertising materials mentioning features or use of this software
55  *    must display the following acknowledgement:
56  *	This product includes software developed by Manuel Bouyer.
57  * 4. The name of the author may not be used to endorse or promote products
58  *    derived from this software without specific prior written permission.
59  *
60  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
61  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
62  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
63  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
64  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
65  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
66  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
67  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
68  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
69  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
70  */
71 
72 /*
73  * driver for National Semiconductor's DP83840A ethernet 10/100 PHY
74  * Data Sheet available from www.national.com
75  */
76 
77 #include <sys/param.h>
78 #include <sys/systm.h>
79 #include <sys/kernel.h>
80 #include <sys/socket.h>
81 #include <sys/errno.h>
82 #include <sys/module.h>
83 #include <sys/bus.h>
84 
85 #include <net/if.h>
86 #include <net/if_media.h>
87 
88 #include "mii.h"
89 #include "miivar.h"
90 #include "miidevs.h"
91 
92 #include "nsphyreg.h"
93 
94 #include "miibus_if.h"
95 
96 static int nsphy_probe		(device_t);
97 static int nsphy_attach		(device_t);
98 static int nsphy_detach		(device_t);
99 
100 static device_method_t nsphy_methods[] = {
101 	/* device interface */
102 	DEVMETHOD(device_probe,		nsphy_probe),
103 	DEVMETHOD(device_attach,	nsphy_attach),
104 	DEVMETHOD(device_detach,	nsphy_detach),
105 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
106 	{ 0, 0 }
107 };
108 
109 static devclass_t nsphy_devclass;
110 
111 static driver_t nsphy_driver = {
112 	"nsphy",
113 	nsphy_methods,
114 	sizeof(struct mii_softc)
115 };
116 
117 DRIVER_MODULE(nsphy, miibus, nsphy_driver, nsphy_devclass, 0, 0);
118 
119 int	nsphy_service (struct mii_softc *, struct mii_data *, int);
120 void	nsphy_status (struct mii_softc *);
121 
122 static int nsphy_probe(dev)
123 	device_t		dev;
124 {
125 	struct mii_attach_args *ma;
126 
127 	ma = device_get_ivars(dev);
128 
129 	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_NATSEMI &&
130 	    MII_MODEL(ma->mii_id2) == MII_MODEL_NATSEMI_DP83840) {
131 		device_set_desc(dev, MII_STR_NATSEMI_DP83840);
132 	} else
133 		return (ENXIO);
134 
135 	return (0);
136 }
137 
138 static int nsphy_attach(dev)
139 	device_t		dev;
140 {
141 	struct mii_softc *sc;
142 	struct mii_attach_args *ma;
143 	struct mii_data *mii;
144 
145 	sc = device_get_softc(dev);
146 	ma = device_get_ivars(dev);
147 	sc->mii_dev = device_get_parent(dev);
148 	mii = device_get_softc(sc->mii_dev);
149 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
150 
151 	sc->mii_inst = mii->mii_instance;
152 	sc->mii_phy = ma->mii_phyno;
153 	sc->mii_service = nsphy_service;
154 	sc->mii_pdata = mii;
155 
156 #ifdef foo
157 	/*
158 	 * i82557 wedges if all of its PHYs are isolated!
159 	 */
160 	if (strcmp(device_get_name(device_get_parent(sc->mii_dev)),
161 	    "fxp") == 0 && mii->mii_instance == 0)
162 #endif
163 
164 	sc->mii_flags |= MIIF_NOISOLATE;
165 	mii->mii_instance++;
166 
167 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
168 
169 #if 0
170 	/* Can't do this on the i82557! */
171 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
172 	    BMCR_ISO);
173 #endif
174 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
175 	    BMCR_LOOP|BMCR_S100);
176 
177 	mii_phy_reset(sc);
178 
179 	sc->mii_capabilities =
180 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
181 	device_printf(dev, " ");
182 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
183 		printf("no media present");
184 	else
185 		mii_add_media(mii, sc->mii_capabilities,
186 		    sc->mii_inst);
187 	printf("\n");
188 #undef ADD
189 
190 	MIIBUS_MEDIAINIT(sc->mii_dev);
191 	return(0);
192 }
193 
194 static int nsphy_detach(dev)
195 	device_t		dev;
196 {
197 	struct mii_softc *sc;
198 	struct mii_data *mii;
199 
200 	sc = device_get_softc(dev);
201 	mii = device_get_softc(device_get_parent(dev));
202 	mii_phy_auto_stop(sc);
203 	sc->mii_dev = NULL;
204 	LIST_REMOVE(sc, mii_list);
205 
206 	return(0);
207 }
208 
209 int
210 nsphy_service(sc, mii, cmd)
211 	struct mii_softc *sc;
212 	struct mii_data *mii;
213 	int cmd;
214 {
215 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
216 	int reg;
217 
218 	switch (cmd) {
219 	case MII_POLLSTAT:
220 		/*
221 		 * If we're not polling our PHY instance, just return.
222 		 */
223 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
224 			return (0);
225 		break;
226 
227 	case MII_MEDIACHG:
228 		/*
229 		 * If the media indicates a different PHY instance,
230 		 * isolate ourselves.
231 		 */
232 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
233 			reg = PHY_READ(sc, MII_BMCR);
234 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
235 			return (0);
236 		}
237 
238 		/*
239 		 * If the interface is not up, don't do anything.
240 		 */
241 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
242 			break;
243 
244 		reg = PHY_READ(sc, MII_NSPHY_PCR);
245 
246 		/*
247 		 * Set up the PCR to use LED4 to indicate full-duplex
248 		 * in both 10baseT and 100baseTX modes.
249 		 */
250 		reg |= PCR_LED4MODE;
251 
252 		/*
253 		 * Make sure Carrier Intgrity Monitor function is
254 		 * disabled (normal for Node operation, but sometimes
255 		 * it's not set?!)
256 		 */
257 		reg |= PCR_CIMDIS;
258 
259 		/*
260 		 * Make sure "force link good" is set to normal mode.
261 		 * It's only intended for debugging.
262 		 */
263 		reg |= PCR_FLINK100;
264 
265 		/*
266 		 * Mystery bits which are supposedly `reserved',
267 		 * but we seem to need to set them when the PHY
268 		 * is connected to some interfaces:
269 		 *
270 		 * 0x0400 is needed for fxp
271 		 *        (Intel EtherExpress Pro 10+/100B, 82557 chip)
272 		 *        (nsphy with a DP83840 chip)
273 		 * 0x0100 may be needed for some other card
274 		 */
275 		reg |= 0x0100 | 0x0400;
276 
277 		if (strcmp(device_get_name(device_get_parent(sc->mii_dev)),
278 		    "fxp") == 0)
279 			PHY_WRITE(sc, MII_NSPHY_PCR, reg);
280 
281 		switch (IFM_SUBTYPE(ife->ifm_media)) {
282 		case IFM_AUTO:
283 			/*
284 			 * If we're already in auto mode, just return.
285 			 */
286 			if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
287 				return (0);
288 			(void) mii_phy_auto(sc, 1);
289 			break;
290 		case IFM_100_T4:
291 			/*
292 			 * XXX Not supported as a manual setting right now.
293 			 */
294 			return (EINVAL);
295 		default:
296 			/*
297 			 * BMCR data is stored in the ifmedia entry.
298 			 */
299 			PHY_WRITE(sc, MII_ANAR,
300 			    mii_anar(ife->ifm_media));
301 			PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
302 		}
303 		break;
304 
305 	case MII_TICK:
306 		/*
307 		 * If we're not currently selected, just return.
308 		 */
309 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
310 			return (0);
311 
312 		/*
313 		 * Only used for autonegotiation.
314 		 */
315 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
316 			return (0);
317 
318 		/*
319 		 * Is the interface even up?
320 		 */
321 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
322 			return (0);
323 
324 		/*
325 		 * Check to see if we have link.  If we do, we don't
326 		 * need to restart the autonegotiation process.  Read
327 		 * the BMSR twice in case it's latched.
328 		 */
329 		reg = PHY_READ(sc, MII_BMSR) |
330 		    PHY_READ(sc, MII_BMSR);
331 		if (reg & BMSR_LINK)
332 			return (0);
333 
334 		/*
335 		 * Only retry autonegotiation every 5 seconds.
336 		 */
337 		if (++sc->mii_ticks != 5)
338 			return (0);
339 
340 		sc->mii_ticks = 0;
341 		mii_phy_reset(sc);
342 		if (mii_phy_auto(sc, 0) == EJUSTRETURN)
343 			return (0);
344 		break;
345 	}
346 
347 	/* Update the media status. */
348 	nsphy_status(sc);
349 
350 	/* Callback if something changed. */
351 	if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
352 		MIIBUS_STATCHG(sc->mii_dev);
353 		sc->mii_active = mii->mii_media_active;
354 	}
355 	return (0);
356 }
357 
358 void
359 nsphy_status(sc)
360 	struct mii_softc *sc;
361 {
362 	struct mii_data *mii = sc->mii_pdata;
363 	int bmsr, bmcr, par, anlpar;
364 
365 	mii->mii_media_status = IFM_AVALID;
366 	mii->mii_media_active = IFM_ETHER;
367 
368 	bmsr = PHY_READ(sc, MII_BMSR) |
369 	    PHY_READ(sc, MII_BMSR);
370 	if (bmsr & BMSR_LINK)
371 		mii->mii_media_status |= IFM_ACTIVE;
372 
373 	bmcr = PHY_READ(sc, MII_BMCR);
374 	if (bmcr & BMCR_ISO) {
375 		mii->mii_media_active |= IFM_NONE;
376 		mii->mii_media_status = 0;
377 		return;
378 	}
379 
380 	if (bmcr & BMCR_LOOP)
381 		mii->mii_media_active |= IFM_LOOP;
382 
383 	if (bmcr & BMCR_AUTOEN) {
384 		/*
385 		 * The PAR status bits are only valid of autonegotiation
386 		 * has completed (or it's disabled).
387 		 */
388 		if ((bmsr & BMSR_ACOMP) == 0) {
389 			/* Erg, still trying, I guess... */
390 			mii->mii_media_active |= IFM_NONE;
391 			return;
392 		}
393 
394 		/*
395 		 * Argh.  The PAR doesn't seem to indicate duplex mode
396 		 * properly!  Determine media based on link partner's
397 		 * advertised capabilities.
398 		 */
399 		if (PHY_READ(sc, MII_ANER) & ANER_LPAN) {
400 			anlpar = PHY_READ(sc, MII_ANAR) &
401 			    PHY_READ(sc, MII_ANLPAR);
402 			if (anlpar & ANLPAR_T4)
403 				mii->mii_media_active |= IFM_100_T4;
404 			else if (anlpar & ANLPAR_TX_FD)
405 				mii->mii_media_active |= IFM_100_TX|IFM_FDX;
406 			else if (anlpar & ANLPAR_TX)
407 				mii->mii_media_active |= IFM_100_TX;
408 			else if (anlpar & ANLPAR_10_FD)
409 				mii->mii_media_active |= IFM_10_T|IFM_FDX;
410 			else if (anlpar & ANLPAR_10)
411 				mii->mii_media_active |= IFM_10_T;
412 			else
413 				mii->mii_media_active |= IFM_NONE;
414 			return;
415 		}
416 
417 		/*
418 		 * Link partner is not capable of autonegotiation.
419 		 * We will never be in full-duplex mode if this is
420 		 * the case, so reading the PAR is OK.
421 		 */
422 		par = PHY_READ(sc, MII_NSPHY_PAR);
423 		if (par & PAR_10)
424 			mii->mii_media_active |= IFM_10_T;
425 		else
426 			mii->mii_media_active |= IFM_100_TX;
427 #if 0
428 		if (par & PAR_FDX)
429 			mii->mii_media_active |= IFM_FDX;
430 #endif
431 	} else
432 		mii->mii_media_active |= mii_media_from_bmcr(bmcr);
433 }
434