xref: /freebsd/sys/dev/mii/nsphy.c (revision a3e8fd0b7f663db7eafff527d5c3ca3bcfa8a537)
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(device_t);
99 static int nsphy_attach(device_t);
100 
101 static device_method_t nsphy_methods[] = {
102 	/* device interface */
103 	DEVMETHOD(device_probe,		nsphy_probe),
104 	DEVMETHOD(device_attach,	nsphy_attach),
105 	DEVMETHOD(device_detach,	mii_phy_detach),
106 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
107 	{ 0, 0 }
108 };
109 
110 static devclass_t nsphy_devclass;
111 
112 static driver_t nsphy_driver = {
113 	"nsphy",
114 	nsphy_methods,
115 	sizeof(struct mii_softc)
116 };
117 
118 DRIVER_MODULE(nsphy, miibus, nsphy_driver, nsphy_devclass, 0, 0);
119 
120 static int	nsphy_service(struct mii_softc *, struct mii_data *, int);
121 static void	nsphy_status(struct mii_softc *);
122 
123 static int
124 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
135 		return (ENXIO);
136 
137 	return (0);
138 }
139 
140 static int
141 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 	mii_add_media(sc);
186 	printf("\n");
187 #undef ADD
188 
189 	MIIBUS_MEDIAINIT(sc->mii_dev);
190 	return(0);
191 }
192 
193 static int
194 nsphy_service(sc, mii, cmd)
195 	struct mii_softc *sc;
196 	struct mii_data *mii;
197 	int cmd;
198 {
199 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
200 	int reg;
201 
202 	switch (cmd) {
203 	case MII_POLLSTAT:
204 		/*
205 		 * If we're not polling our PHY instance, just return.
206 		 */
207 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
208 			return (0);
209 		break;
210 
211 	case MII_MEDIACHG:
212 		/*
213 		 * If the media indicates a different PHY instance,
214 		 * isolate ourselves.
215 		 */
216 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
217 			reg = PHY_READ(sc, MII_BMCR);
218 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
219 			return (0);
220 		}
221 
222 		/*
223 		 * If the interface is not up, don't do anything.
224 		 */
225 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
226 			break;
227 
228 		reg = PHY_READ(sc, MII_NSPHY_PCR);
229 
230 		/*
231 		 * Set up the PCR to use LED4 to indicate full-duplex
232 		 * in both 10baseT and 100baseTX modes.
233 		 */
234 		reg |= PCR_LED4MODE;
235 
236 		/*
237 		 * Make sure Carrier Intgrity Monitor function is
238 		 * disabled (normal for Node operation, but sometimes
239 		 * it's not set?!)
240 		 */
241 		reg |= PCR_CIMDIS;
242 
243 		/*
244 		 * Make sure "force link good" is set to normal mode.
245 		 * It's only intended for debugging.
246 		 */
247 		reg |= PCR_FLINK100;
248 
249 		/*
250 		 * Mystery bits which are supposedly `reserved',
251 		 * but we seem to need to set them when the PHY
252 		 * is connected to some interfaces:
253 		 *
254 		 * 0x0400 is needed for fxp
255 		 *        (Intel EtherExpress Pro 10+/100B, 82557 chip)
256 		 *        (nsphy with a DP83840 chip)
257 		 * 0x0100 may be needed for some other card
258 		 */
259 		reg |= 0x0100 | 0x0400;
260 
261 		if (strcmp(device_get_name(device_get_parent(sc->mii_dev)),
262 		    "fxp") == 0)
263 			PHY_WRITE(sc, MII_NSPHY_PCR, reg);
264 
265 		switch (IFM_SUBTYPE(ife->ifm_media)) {
266 		case IFM_AUTO:
267 			/*
268 			 * If we're already in auto mode, just return.
269 			 */
270 			if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
271 				return (0);
272 			(void) mii_phy_auto(sc);
273 			break;
274 		case IFM_100_T4:
275 			/*
276 			 * XXX Not supported as a manual setting right now.
277 			 */
278 			return (EINVAL);
279 		default:
280 			/*
281 			 * BMCR data is stored in the ifmedia entry.
282 			 */
283 			PHY_WRITE(sc, MII_ANAR,
284 			    mii_anar(ife->ifm_media));
285 			PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
286 		}
287 		break;
288 
289 	case MII_TICK:
290 		/*
291 		 * If we're not currently selected, just return.
292 		 */
293 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
294 			return (0);
295 		if (mii_phy_tick(sc) == EJUSTRETURN)
296 			return (0);
297 		break;
298 	}
299 
300 	/* Update the media status. */
301 	nsphy_status(sc);
302 
303 	/* Callback if something changed. */
304 	mii_phy_update(sc, cmd);
305 	return (0);
306 }
307 
308 static void
309 nsphy_status(sc)
310 	struct mii_softc *sc;
311 {
312 	struct mii_data *mii = sc->mii_pdata;
313 	int bmsr, bmcr, par, anlpar;
314 
315 	mii->mii_media_status = IFM_AVALID;
316 	mii->mii_media_active = IFM_ETHER;
317 
318 	bmsr = PHY_READ(sc, MII_BMSR) |
319 	    PHY_READ(sc, MII_BMSR);
320 	if (bmsr & BMSR_LINK)
321 		mii->mii_media_status |= IFM_ACTIVE;
322 
323 	bmcr = PHY_READ(sc, MII_BMCR);
324 	if (bmcr & BMCR_ISO) {
325 		mii->mii_media_active |= IFM_NONE;
326 		mii->mii_media_status = 0;
327 		return;
328 	}
329 
330 	if (bmcr & BMCR_LOOP)
331 		mii->mii_media_active |= IFM_LOOP;
332 
333 	if (bmcr & BMCR_AUTOEN) {
334 		/*
335 		 * The PAR status bits are only valid of autonegotiation
336 		 * has completed (or it's disabled).
337 		 */
338 		if ((bmsr & BMSR_ACOMP) == 0) {
339 			/* Erg, still trying, I guess... */
340 			mii->mii_media_active |= IFM_NONE;
341 			return;
342 		}
343 
344 		/*
345 		 * Argh.  The PAR doesn't seem to indicate duplex mode
346 		 * properly!  Determine media based on link partner's
347 		 * advertised capabilities.
348 		 */
349 		if (PHY_READ(sc, MII_ANER) & ANER_LPAN) {
350 			anlpar = PHY_READ(sc, MII_ANAR) &
351 			    PHY_READ(sc, MII_ANLPAR);
352 			if (anlpar & ANLPAR_T4)
353 				mii->mii_media_active |= IFM_100_T4;
354 			else if (anlpar & ANLPAR_TX_FD)
355 				mii->mii_media_active |= IFM_100_TX|IFM_FDX;
356 			else if (anlpar & ANLPAR_TX)
357 				mii->mii_media_active |= IFM_100_TX;
358 			else if (anlpar & ANLPAR_10_FD)
359 				mii->mii_media_active |= IFM_10_T|IFM_FDX;
360 			else if (anlpar & ANLPAR_10)
361 				mii->mii_media_active |= IFM_10_T;
362 			else
363 				mii->mii_media_active |= IFM_NONE;
364 			return;
365 		}
366 
367 		/*
368 		 * Link partner is not capable of autonegotiation.
369 		 * We will never be in full-duplex mode if this is
370 		 * the case, so reading the PAR is OK.
371 		 */
372 		par = PHY_READ(sc, MII_NSPHY_PAR);
373 		if (par & PAR_10)
374 			mii->mii_media_active |= IFM_10_T;
375 		else
376 			mii->mii_media_active |= IFM_100_TX;
377 #if 0
378 		if (par & PAR_FDX)
379 			mii->mii_media_active |= IFM_FDX;
380 #endif
381 	} else
382 		mii->mii_media_active |= mii_media_from_bmcr(bmcr);
383 }
384