xref: /netbsd-src/sys/dev/mii/nsphyter.c (revision 274254cdae52594c1aa480a736aef78313d15c9c)
1 /*	$NetBSD: nsphyter.c,v 1.34 2009/04/02 00:09:33 dyoung 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  * 3. All advertising materials mentioning features or use of this software
45  *    must display the following acknowledgement:
46  *	This product includes software developed by Manuel Bouyer.
47  * 4. The name of the author may not be used to endorse or promote products
48  *    derived from this software without specific prior written permission.
49  *
50  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
51  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
52  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
53  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
54  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
55  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
56  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
57  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
58  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
59  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
60  */
61 
62 /*
63  * driver for National Semiconductor's DP83843 `PHYTER' ethernet 10/100 PHY
64  * Data Sheet available from www.national.com
65  *
66  * We also support the DP83815 MacPHYER internal PHY since, for our
67  * purposes, they are compatible.
68  */
69 
70 #include <sys/cdefs.h>
71 __KERNEL_RCSID(0, "$NetBSD: nsphyter.c,v 1.34 2009/04/02 00:09:33 dyoung Exp $");
72 
73 #include <sys/param.h>
74 #include <sys/systm.h>
75 #include <sys/kernel.h>
76 #include <sys/device.h>
77 #include <sys/socket.h>
78 #include <sys/errno.h>
79 
80 #include <net/if.h>
81 #include <net/if_media.h>
82 
83 #include <dev/mii/mii.h>
84 #include <dev/mii/miivar.h>
85 #include <dev/mii/miidevs.h>
86 
87 #include <dev/mii/nsphyterreg.h>
88 
89 static int	nsphytermatch(device_t, cfdata_t, void *);
90 static void	nsphyterattach(device_t, device_t, void *);
91 
92 CFATTACH_DECL3_NEW(nsphyter, sizeof(struct mii_softc),
93     nsphytermatch, nsphyterattach, mii_phy_detach, mii_phy_activate, NULL,
94     NULL, DVF_DETACH_SHUTDOWN);
95 
96 static int	nsphyter_service(struct mii_softc *, struct mii_data *, int);
97 static void	nsphyter_status(struct mii_softc *);
98 static void	nsphyter_reset(struct mii_softc *);
99 
100 static const struct mii_phy_funcs nsphyter_funcs = {
101 	nsphyter_service, nsphyter_status, nsphyter_reset,
102 };
103 
104 static const struct mii_phydesc nsphyters[] = {
105 	{ MII_OUI_xxNATSEMI,		MII_MODEL_xxNATSEMI_DP83843,
106 	  MII_STR_xxNATSEMI_DP83843 },
107 
108 	{ MII_OUI_xxNATSEMI,		MII_MODEL_xxNATSEMI_DP83847,
109 	  MII_STR_xxNATSEMI_DP83847 },
110 
111 	{ MII_OUI_xxNATSEMI,		MII_MODEL_xxNATSEMI_DP83815,
112 	  MII_STR_xxNATSEMI_DP83815 },
113 
114 	{ 0,				0,
115 	  NULL },
116 };
117 
118 static int
119 nsphytermatch(device_t parent, cfdata_t match, void *aux)
120 {
121 	struct mii_attach_args *ma = aux;
122 
123 	if (mii_phy_match(ma, nsphyters) != NULL)
124 		return (10);
125 
126 	return (0);
127 }
128 
129 static void
130 nsphyterattach(device_t parent, device_t self, void *aux)
131 {
132 	struct mii_softc *sc = device_private(self);
133 	struct mii_attach_args *ma = aux;
134 	struct mii_data *mii = ma->mii_data;
135 	const struct mii_phydesc *mpd;
136 
137 	mpd = mii_phy_match(ma, nsphyters);
138 	aprint_naive(": Media interface\n");
139 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
140 
141 	sc->mii_dev = self;
142 	sc->mii_inst = mii->mii_instance;
143 	sc->mii_phy = ma->mii_phyno;
144 	sc->mii_funcs = &nsphyter_funcs;
145 	sc->mii_pdata = mii;
146 	sc->mii_flags = ma->mii_flags;
147 	sc->mii_anegticks = MII_ANEGTICKS;
148 
149 	PHY_RESET(sc);
150 
151 	sc->mii_capabilities =
152 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
153 	aprint_normal_dev(self, "");
154 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
155 		aprint_error("no media present");
156 	else
157 		mii_phy_add_media(sc);
158 	aprint_normal("\n");
159 }
160 
161 static int
162 nsphyter_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
163 {
164 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
165 	int reg;
166 
167 	switch (cmd) {
168 	case MII_POLLSTAT:
169 		/*
170 		 * If we're not polling our PHY instance, just return.
171 		 */
172 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
173 			return (0);
174 		break;
175 
176 	case MII_MEDIACHG:
177 		/*
178 		 * If the media indicates a different PHY instance,
179 		 * isolate ourselves.
180 		 */
181 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
182 			reg = PHY_READ(sc, MII_BMCR);
183 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
184 			return (0);
185 		}
186 
187 		/*
188 		 * If the interface is not up, don't do anything.
189 		 */
190 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
191 			break;
192 
193 		mii_phy_setmedia(sc);
194 		break;
195 
196 	case MII_TICK:
197 		/*
198 		 * If we're not currently selected, just return.
199 		 */
200 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
201 			return (0);
202 
203 		if (mii_phy_tick(sc) == EJUSTRETURN)
204 			return (0);
205 		break;
206 
207 	case MII_DOWN:
208 		mii_phy_down(sc);
209 		return (0);
210 	}
211 
212 	/* Update the media status. */
213 	mii_phy_status(sc);
214 
215 	/* Callback if something changed. */
216 	mii_phy_update(sc, cmd);
217 	return (0);
218 }
219 
220 static void
221 nsphyter_status(struct mii_softc *sc)
222 {
223 	struct mii_data *mii = sc->mii_pdata;
224 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
225 	int bmsr, bmcr, physts;
226 
227 	mii->mii_media_status = IFM_AVALID;
228 	mii->mii_media_active = IFM_ETHER;
229 
230 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
231 	physts = PHY_READ(sc, MII_NSPHYTER_PHYSTS);
232 
233 	if (physts & PHYSTS_LINK)
234 		mii->mii_media_status |= IFM_ACTIVE;
235 
236 	bmcr = PHY_READ(sc, MII_BMCR);
237 	if (bmcr & BMCR_ISO) {
238 		mii->mii_media_active |= IFM_NONE;
239 		mii->mii_media_status = 0;
240 		return;
241 	}
242 
243 	if (bmcr & BMCR_LOOP)
244 		mii->mii_media_active |= IFM_LOOP;
245 
246 	if (bmcr & BMCR_AUTOEN) {
247 		/*
248 		 * The media status bits are only valid of autonegotiation
249 		 * has completed (or it's disabled).
250 		 */
251 		if ((bmsr & BMSR_ACOMP) == 0) {
252 			/* Erg, still trying, I guess... */
253 			mii->mii_media_active |= IFM_NONE;
254 			return;
255 		}
256 
257 		if (physts & PHYSTS_SPEED10)
258 			mii->mii_media_active |= IFM_10_T;
259 		else
260 			mii->mii_media_active |= IFM_100_TX;
261 		if (physts & PHYSTS_DUPLEX)
262 			mii->mii_media_active |=
263 			    IFM_FDX | mii_phy_flowstatus(sc);
264 	} else
265 		mii->mii_media_active = ife->ifm_media;
266 }
267 
268 void
269 nsphyter_reset(struct mii_softc *sc)
270 {
271 	int reg, i;
272 
273 	if (sc->mii_flags & MIIF_NOISOLATE)
274 		reg = BMCR_RESET;
275 	else
276 		reg = BMCR_RESET | BMCR_ISO;
277 	PHY_WRITE(sc, MII_BMCR, reg);
278 
279 	/*
280 	 * It is best to allow a little time for the reset to settle
281 	 * in before we start polling the BMCR again.  Notably, the
282 	 * DP83840A manual states that there should be a 500us delay
283 	 * between asserting software reset and attempting MII serial
284 	 * operations.  Also, a DP83815 can get into a bad state on
285 	 * cable removal and reinsertion if we do not delay here.
286 	 */
287 	delay(500);
288 
289 	/* Wait another 100ms for it to complete. */
290 	for (i = 0; i < 100; i++) {
291 		reg = PHY_READ(sc, MII_BMCR);
292 		if ((reg & BMCR_RESET) == 0)
293 			break;
294 		delay(1000);
295 	}
296 
297 	if (sc->mii_inst != 0 && ((sc->mii_flags & MIIF_NOISOLATE) == 0))
298 		PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
299 }
300