nsphyter.c revision 221407
1/*	$NetBSD: nsphyter.c,v 1.28 2008/01/20 07:58:19 msaitoh Exp $	*/
2
3/*-
4 * Copyright (c) 1998, 1999, 2000, 2001 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 *
20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
32
33/*-
34 * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
35 *
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
38 * are met:
39 * 1. Redistributions of source code must retain the above copyright
40 *    notice, this list of conditions and the following disclaimer.
41 * 2. Redistributions in binary form must reproduce the above copyright
42 *    notice, this list of conditions and the following disclaimer in the
43 *    documentation and/or other materials provided with the distribution.
44 *
45 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
46 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
47 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
48 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
49 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
50 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
51 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
52 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
53 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
54 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
55 */
56
57#include <sys/cdefs.h>
58__FBSDID("$FreeBSD: head/sys/dev/mii/nsphyter.c 221407 2011-05-03 19:51:29Z marius $");
59
60/*
61 * driver for National Semiconductor's DP83843 `PHYTER' ethernet 10/100 PHY
62 * Data Sheet available from www.national.com
63 *
64 * We also support the DP83815 `MacPHYTER' internal PHY since, for our
65 * purposes, they are compatible.
66 */
67
68#include <sys/param.h>
69#include <sys/systm.h>
70#include <sys/bus.h>
71#include <sys/errno.h>
72#include <sys/kernel.h>
73#include <sys/module.h>
74#include <sys/socket.h>
75
76#include <net/if.h>
77#include <net/if_media.h>
78
79#include <dev/mii/mii.h>
80#include <dev/mii/miivar.h>
81#include "miidevs.h"
82
83#include <dev/mii/nsphyterreg.h>
84
85#include "miibus_if.h"
86
87static device_probe_t	nsphyter_probe;
88static device_attach_t	nsphyter_attach;
89
90static device_method_t nsphyter_methods[] = {
91	/* device interface */
92	DEVMETHOD(device_probe,		nsphyter_probe),
93	DEVMETHOD(device_attach,	nsphyter_attach),
94	DEVMETHOD(device_detach,	mii_phy_detach),
95	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
96	{ 0, 0 }
97};
98
99static devclass_t nsphyter_devclass;
100
101static driver_t nsphyter_driver = {
102	"nsphyter",
103	nsphyter_methods,
104	sizeof(struct mii_softc)
105};
106
107DRIVER_MODULE(nsphyter, miibus, nsphyter_driver, nsphyter_devclass, 0, 0);
108
109static int	nsphyter_service(struct mii_softc *, struct mii_data *, int);
110static void	nsphyter_status(struct mii_softc *);
111static void	nsphyter_reset(struct mii_softc *);
112
113static const struct mii_phydesc nsphyters[] = {
114	MII_PHY_DESC(xxNATSEMI, DP83815),
115	MII_PHY_DESC(xxNATSEMI, DP83843),
116	MII_PHY_DESC(xxNATSEMI, DP83847),
117	MII_PHY_END
118};
119
120static const struct mii_phy_funcs nsphyter_funcs = {
121	nsphyter_service,
122	nsphyter_status,
123	nsphyter_reset
124};
125
126static int
127nsphyter_probe(device_t dev)
128{
129
130	return (mii_phy_dev_probe(dev, nsphyters, BUS_PROBE_DEFAULT));
131}
132
133static int
134nsphyter_attach(device_t dev)
135{
136
137	mii_phy_dev_attach(dev, MIIF_NOMANPAUSE, &nsphyter_funcs, 1);
138	return (0);
139}
140
141static int
142nsphyter_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
143{
144
145	switch (cmd) {
146	case MII_POLLSTAT:
147		break;
148
149	case MII_MEDIACHG:
150		/*
151		 * If the interface is not up, don't do anything.
152		 */
153		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
154			break;
155
156		mii_phy_setmedia(sc);
157		break;
158
159	case MII_TICK:
160		if (mii_phy_tick(sc) == EJUSTRETURN)
161			return (0);
162		break;
163	}
164
165	/* Update the media status. */
166	PHY_STATUS(sc);
167
168	/* Callback if something changed. */
169	mii_phy_update(sc, cmd);
170	return (0);
171}
172
173static void
174nsphyter_status(struct mii_softc *sc)
175{
176	struct mii_data *mii = sc->mii_pdata;
177	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
178	int bmsr, bmcr, physts;
179
180	mii->mii_media_status = IFM_AVALID;
181	mii->mii_media_active = IFM_ETHER;
182
183	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
184	physts = PHY_READ(sc, MII_NSPHYTER_PHYSTS);
185
186	if ((physts & PHYSTS_LINK) != 0)
187		mii->mii_media_status |= IFM_ACTIVE;
188
189	bmcr = PHY_READ(sc, MII_BMCR);
190	if ((bmcr & BMCR_ISO) != 0) {
191		mii->mii_media_active |= IFM_NONE;
192		mii->mii_media_status = 0;
193		return;
194	}
195
196	if ((bmcr & BMCR_LOOP) != 0)
197		mii->mii_media_active |= IFM_LOOP;
198
199	if ((bmcr & BMCR_AUTOEN) != 0) {
200		/*
201		 * The media status bits are only valid if autonegotiation
202		 * has completed (or it's disabled).
203		 */
204		if ((bmsr & BMSR_ACOMP) == 0) {
205			/* Erg, still trying, I guess... */
206			mii->mii_media_active |= IFM_NONE;
207			return;
208		}
209
210		if ((physts & PHYSTS_SPEED10) != 0)
211			mii->mii_media_active |= IFM_10_T;
212		else
213			mii->mii_media_active |= IFM_100_TX;
214		if ((physts & PHYSTS_DUPLEX) != 0)
215			mii->mii_media_active |=
216			    IFM_FDX | mii_phy_flowstatus(sc);
217		else
218			mii->mii_media_active |= IFM_HDX;
219	} else
220		mii->mii_media_active = ife->ifm_media;
221}
222
223static void
224nsphyter_reset(struct mii_softc *sc)
225{
226	struct ifmedia_entry *ife = sc->mii_pdata->mii_media.ifm_cur;
227	int reg, i;
228
229	if ((sc->mii_flags & MIIF_NOISOLATE) != 0)
230		reg = BMCR_RESET;
231	else
232		reg = BMCR_RESET | BMCR_ISO;
233	PHY_WRITE(sc, MII_BMCR, reg);
234
235	/*
236	 * It is best to allow a little time for the reset to settle
237	 * in before we start polling the BMCR again.  Notably, the
238	 * DP8384{3,7} manuals state that there should be a 500us delay
239	 * between asserting software reset and attempting MII serial
240	 * operations.  Be conservative.  Also, a DP83815 can get into
241	 * a bad state on cable removal and reinsertion if we do not
242	 * delay here.
243	 */
244	DELAY(1000);
245
246	/*
247	 * Wait another 2s for it to complete.
248	 * This is only a little overkill as under normal circumstances
249	 * the PHY can take up to 1s to complete reset.
250	 * This is also a bit odd because after a reset, the BMCR will
251	 * clear the reset bit and simply reports 0 even though the reset
252	 * is not yet complete.
253	 */
254	for (i = 0; i < 1000; i++) {
255		reg = PHY_READ(sc, MII_BMCR);
256		if (reg != 0 && (reg & BMCR_RESET) == 0)
257			break;
258		DELAY(2000);
259	}
260
261	if ((sc->mii_flags & MIIF_NOISOLATE) == 0) {
262		if ((ife == NULL && sc->mii_inst != 0) ||
263		    (ife != NULL && IFM_INST(ife->ifm_media) != sc->mii_inst))
264			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
265	}
266}
267