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