xref: /freebsd/sys/dev/mii/nsphyter.c (revision cc16dea626cf2fc80cde667ac4798065108e596c)
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$");
59 
60 /*
61  * Driver for the National Semiconductor's DP83843, DP83847 and DP83849
62  * `PHYTER' Ethernet 10/100 PHYs
63  * Data Sheets are available from http://www.national.com
64  *
65  * We also support the DP83815 `MacPHYTER' internal PHY since, for our
66  * purposes, they are compatible.
67  */
68 
69 #include <sys/param.h>
70 #include <sys/systm.h>
71 #include <sys/bus.h>
72 #include <sys/errno.h>
73 #include <sys/kernel.h>
74 #include <sys/module.h>
75 #include <sys/socket.h>
76 
77 #include <net/if.h>
78 #include <net/if_media.h>
79 
80 #include <dev/mii/mii.h>
81 #include <dev/mii/miivar.h>
82 #include "miidevs.h"
83 
84 #include <dev/mii/nsphyterreg.h>
85 
86 #include "miibus_if.h"
87 
88 static device_probe_t	nsphyter_probe;
89 static device_attach_t	nsphyter_attach;
90 
91 static device_method_t nsphyter_methods[] = {
92 	/* device interface */
93 	DEVMETHOD(device_probe,		nsphyter_probe),
94 	DEVMETHOD(device_attach,	nsphyter_attach),
95 	DEVMETHOD(device_detach,	mii_phy_detach),
96 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
97 	DEVMETHOD_END
98 };
99 
100 static devclass_t nsphyter_devclass;
101 
102 static driver_t nsphyter_driver = {
103 	"nsphyter",
104 	nsphyter_methods,
105 	sizeof(struct mii_softc)
106 };
107 
108 DRIVER_MODULE(nsphyter, miibus, nsphyter_driver, nsphyter_devclass, 0, 0);
109 
110 static int	nsphyter_service(struct mii_softc *, struct mii_data *, int);
111 static void	nsphyter_status(struct mii_softc *);
112 static void	nsphyter_reset(struct mii_softc *);
113 
114 static const struct mii_phydesc nsphyters[] = {
115 	MII_PHY_DESC(xxNATSEMI, DP83815),
116 	MII_PHY_DESC(xxNATSEMI, DP83843),
117 	MII_PHY_DESC(xxNATSEMI, DP83847),
118 	MII_PHY_DESC(xxNATSEMI, DP83849),
119 	MII_PHY_END
120 };
121 
122 static const struct mii_phy_funcs nsphyter_funcs = {
123 	nsphyter_service,
124 	nsphyter_status,
125 	nsphyter_reset
126 };
127 
128 static int
129 nsphyter_probe(device_t dev)
130 {
131 
132 	return (mii_phy_dev_probe(dev, nsphyters, BUS_PROBE_DEFAULT));
133 }
134 
135 static int
136 nsphyter_attach(device_t dev)
137 {
138 
139 	mii_phy_dev_attach(dev, MIIF_NOMANPAUSE, &nsphyter_funcs, 1);
140 	return (0);
141 }
142 
143 static int
144 nsphyter_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
145 {
146 
147 	switch (cmd) {
148 	case MII_POLLSTAT:
149 		break;
150 
151 	case MII_MEDIACHG:
152 		/*
153 		 * If the interface is not up, don't do anything.
154 		 */
155 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
156 			break;
157 
158 		mii_phy_setmedia(sc);
159 		break;
160 
161 	case MII_TICK:
162 		if (mii_phy_tick(sc) == EJUSTRETURN)
163 			return (0);
164 		break;
165 	}
166 
167 	/* Update the media status. */
168 	PHY_STATUS(sc);
169 
170 	/* Callback if something changed. */
171 	mii_phy_update(sc, cmd);
172 	return (0);
173 }
174 
175 static void
176 nsphyter_status(struct mii_softc *sc)
177 {
178 	struct mii_data *mii = sc->mii_pdata;
179 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
180 	int bmsr, bmcr, physts;
181 
182 	mii->mii_media_status = IFM_AVALID;
183 	mii->mii_media_active = IFM_ETHER;
184 
185 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
186 	physts = PHY_READ(sc, MII_NSPHYTER_PHYSTS);
187 
188 	if ((physts & PHYSTS_LINK) != 0)
189 		mii->mii_media_status |= IFM_ACTIVE;
190 
191 	bmcr = PHY_READ(sc, MII_BMCR);
192 	if ((bmcr & BMCR_ISO) != 0) {
193 		mii->mii_media_active |= IFM_NONE;
194 		mii->mii_media_status = 0;
195 		return;
196 	}
197 
198 	if ((bmcr & BMCR_LOOP) != 0)
199 		mii->mii_media_active |= IFM_LOOP;
200 
201 	if ((bmcr & BMCR_AUTOEN) != 0) {
202 		/*
203 		 * The media status bits are only valid if autonegotiation
204 		 * has completed (or it's disabled).
205 		 */
206 		if ((bmsr & BMSR_ACOMP) == 0) {
207 			/* Erg, still trying, I guess... */
208 			mii->mii_media_active |= IFM_NONE;
209 			return;
210 		}
211 
212 		if ((physts & PHYSTS_SPEED10) != 0)
213 			mii->mii_media_active |= IFM_10_T;
214 		else
215 			mii->mii_media_active |= IFM_100_TX;
216 		if ((physts & PHYSTS_DUPLEX) != 0)
217 			mii->mii_media_active |=
218 			    IFM_FDX | mii_phy_flowstatus(sc);
219 		else
220 			mii->mii_media_active |= IFM_HDX;
221 	} else
222 		mii->mii_media_active = ife->ifm_media;
223 }
224 
225 static void
226 nsphyter_reset(struct mii_softc *sc)
227 {
228 	struct ifmedia_entry *ife = sc->mii_pdata->mii_media.ifm_cur;
229 	int reg, i;
230 
231 	if ((sc->mii_flags & MIIF_NOISOLATE) != 0)
232 		reg = BMCR_RESET;
233 	else
234 		reg = BMCR_RESET | BMCR_ISO;
235 	PHY_WRITE(sc, MII_BMCR, reg);
236 
237 	/*
238 	 * It is best to allow a little time for the reset to settle
239 	 * in before we start polling the BMCR again.  Notably, the
240 	 * DP8384{3,7} manuals state that there should be a 500us delay
241 	 * between asserting software reset and attempting MII serial
242 	 * operations.  Be conservative.  Also, a DP83815 can get into
243 	 * a bad state on cable removal and reinsertion if we do not
244 	 * delay here.
245 	 */
246 	DELAY(1000);
247 
248 	/*
249 	 * Wait another 2s for it to complete.
250 	 * This is only a little overkill as under normal circumstances
251 	 * the PHY can take up to 1s to complete reset.
252 	 * This is also a bit odd because after a reset, the BMCR will
253 	 * clear the reset bit and simply reports 0 even though the reset
254 	 * is not yet complete.
255 	 */
256 	for (i = 0; i < 1000; i++) {
257 		reg = PHY_READ(sc, MII_BMCR);
258 		if (reg != 0 && (reg & BMCR_RESET) == 0)
259 			break;
260 		DELAY(2000);
261 	}
262 
263 	if ((sc->mii_flags & MIIF_NOISOLATE) == 0) {
264 		if ((ife == NULL && sc->mii_inst != 0) ||
265 		    (ife != NULL && IFM_INST(ife->ifm_media) != sc->mii_inst))
266 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
267 	}
268 }
269