xref: /netbsd-src/sys/dev/mii/nsphyter.c (revision 404fbe5fb94ca1e054339640cabb2801ce52dd30)
1 /*	$NetBSD: nsphyter.c,v 1.33 2008/11/17 03:04:27 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.33 2008/11/17 03:04:27 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_DECL_NEW(nsphyter, sizeof(struct mii_softc),
93     nsphytermatch, nsphyterattach, mii_phy_detach, mii_phy_activate);
94 
95 static int	nsphyter_service(struct mii_softc *, struct mii_data *, int);
96 static void	nsphyter_status(struct mii_softc *);
97 static void	nsphyter_reset(struct mii_softc *);
98 
99 static const struct mii_phy_funcs nsphyter_funcs = {
100 	nsphyter_service, nsphyter_status, nsphyter_reset,
101 };
102 
103 static const struct mii_phydesc nsphyters[] = {
104 	{ MII_OUI_xxNATSEMI,		MII_MODEL_xxNATSEMI_DP83843,
105 	  MII_STR_xxNATSEMI_DP83843 },
106 
107 	{ MII_OUI_xxNATSEMI,		MII_MODEL_xxNATSEMI_DP83847,
108 	  MII_STR_xxNATSEMI_DP83847 },
109 
110 	{ MII_OUI_xxNATSEMI,		MII_MODEL_xxNATSEMI_DP83815,
111 	  MII_STR_xxNATSEMI_DP83815 },
112 
113 	{ 0,				0,
114 	  NULL },
115 };
116 
117 static int
118 nsphytermatch(device_t parent, cfdata_t match, void *aux)
119 {
120 	struct mii_attach_args *ma = aux;
121 
122 	if (mii_phy_match(ma, nsphyters) != NULL)
123 		return (10);
124 
125 	return (0);
126 }
127 
128 static void
129 nsphyterattach(device_t parent, device_t self, void *aux)
130 {
131 	struct mii_softc *sc = device_private(self);
132 	struct mii_attach_args *ma = aux;
133 	struct mii_data *mii = ma->mii_data;
134 	const struct mii_phydesc *mpd;
135 
136 	mpd = mii_phy_match(ma, nsphyters);
137 	aprint_naive(": Media interface\n");
138 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
139 
140 	sc->mii_dev = self;
141 	sc->mii_inst = mii->mii_instance;
142 	sc->mii_phy = ma->mii_phyno;
143 	sc->mii_funcs = &nsphyter_funcs;
144 	sc->mii_pdata = mii;
145 	sc->mii_flags = ma->mii_flags;
146 	sc->mii_anegticks = MII_ANEGTICKS;
147 
148 	PHY_RESET(sc);
149 
150 	sc->mii_capabilities =
151 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
152 	aprint_normal_dev(self, "");
153 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
154 		aprint_error("no media present");
155 	else
156 		mii_phy_add_media(sc);
157 	aprint_normal("\n");
158 }
159 
160 static int
161 nsphyter_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
162 {
163 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
164 	int reg;
165 
166 	switch (cmd) {
167 	case MII_POLLSTAT:
168 		/*
169 		 * If we're not polling our PHY instance, just return.
170 		 */
171 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
172 			return (0);
173 		break;
174 
175 	case MII_MEDIACHG:
176 		/*
177 		 * If the media indicates a different PHY instance,
178 		 * isolate ourselves.
179 		 */
180 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
181 			reg = PHY_READ(sc, MII_BMCR);
182 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
183 			return (0);
184 		}
185 
186 		/*
187 		 * If the interface is not up, don't do anything.
188 		 */
189 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
190 			break;
191 
192 		mii_phy_setmedia(sc);
193 		break;
194 
195 	case MII_TICK:
196 		/*
197 		 * If we're not currently selected, just return.
198 		 */
199 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
200 			return (0);
201 
202 		if (mii_phy_tick(sc) == EJUSTRETURN)
203 			return (0);
204 		break;
205 
206 	case MII_DOWN:
207 		mii_phy_down(sc);
208 		return (0);
209 	}
210 
211 	/* Update the media status. */
212 	mii_phy_status(sc);
213 
214 	/* Callback if something changed. */
215 	mii_phy_update(sc, cmd);
216 	return (0);
217 }
218 
219 static void
220 nsphyter_status(struct mii_softc *sc)
221 {
222 	struct mii_data *mii = sc->mii_pdata;
223 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
224 	int bmsr, bmcr, physts;
225 
226 	mii->mii_media_status = IFM_AVALID;
227 	mii->mii_media_active = IFM_ETHER;
228 
229 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
230 	physts = PHY_READ(sc, MII_NSPHYTER_PHYSTS);
231 
232 	if (physts & PHYSTS_LINK)
233 		mii->mii_media_status |= IFM_ACTIVE;
234 
235 	bmcr = PHY_READ(sc, MII_BMCR);
236 	if (bmcr & BMCR_ISO) {
237 		mii->mii_media_active |= IFM_NONE;
238 		mii->mii_media_status = 0;
239 		return;
240 	}
241 
242 	if (bmcr & BMCR_LOOP)
243 		mii->mii_media_active |= IFM_LOOP;
244 
245 	if (bmcr & BMCR_AUTOEN) {
246 		/*
247 		 * The media status bits are only valid of autonegotiation
248 		 * has completed (or it's disabled).
249 		 */
250 		if ((bmsr & BMSR_ACOMP) == 0) {
251 			/* Erg, still trying, I guess... */
252 			mii->mii_media_active |= IFM_NONE;
253 			return;
254 		}
255 
256 		if (physts & PHYSTS_SPEED10)
257 			mii->mii_media_active |= IFM_10_T;
258 		else
259 			mii->mii_media_active |= IFM_100_TX;
260 		if (physts & PHYSTS_DUPLEX)
261 			mii->mii_media_active |=
262 			    IFM_FDX | mii_phy_flowstatus(sc);
263 	} else
264 		mii->mii_media_active = ife->ifm_media;
265 }
266 
267 void
268 nsphyter_reset(struct mii_softc *sc)
269 {
270 	int reg, i;
271 
272 	if (sc->mii_flags & MIIF_NOISOLATE)
273 		reg = BMCR_RESET;
274 	else
275 		reg = BMCR_RESET | BMCR_ISO;
276 	PHY_WRITE(sc, MII_BMCR, reg);
277 
278 	/*
279 	 * It is best to allow a little time for the reset to settle
280 	 * in before we start polling the BMCR again.  Notably, the
281 	 * DP83840A manual states that there should be a 500us delay
282 	 * between asserting software reset and attempting MII serial
283 	 * operations.  Also, a DP83815 can get into a bad state on
284 	 * cable removal and reinsertion if we do not delay here.
285 	 */
286 	delay(500);
287 
288 	/* Wait another 100ms for it to complete. */
289 	for (i = 0; i < 100; i++) {
290 		reg = PHY_READ(sc, MII_BMCR);
291 		if ((reg & BMCR_RESET) == 0)
292 			break;
293 		delay(1000);
294 	}
295 
296 	if (sc->mii_inst != 0 && ((sc->mii_flags & MIIF_NOISOLATE) == 0))
297 		PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
298 }
299