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