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