xref: /netbsd-src/sys/dev/mii/nsphyter.c (revision cd22f25e6f6d1cc1f197fe8c5468a80f51d1c4e1)
1 /*	$NetBSD: nsphyter.c,v 1.30 2008/04/28 20:23:53 martin 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.30 2008/04/28 20:23:53 martin 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(struct device *, struct cfdata *, void *);
90 static void	nsphyterattach(struct device *, struct device *, void *);
91 
92 CFATTACH_DECL(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(struct device *parent, struct cfdata *match,
119     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(struct device *parent, struct device *self, void *aux)
131 {
132 	struct mii_softc *sc = (struct mii_softc *)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_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(&sc->mii_dev, "");
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 	if (!pmf_device_register(self, NULL, mii_phy_resume))
160 		aprint_error_dev(self, "couldn't establish power handler\n");
161 }
162 
163 static int
164 nsphyter_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
165 {
166 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
167 	int reg;
168 
169 	switch (cmd) {
170 	case MII_POLLSTAT:
171 		/*
172 		 * If we're not polling our PHY instance, just return.
173 		 */
174 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
175 			return (0);
176 		break;
177 
178 	case MII_MEDIACHG:
179 		/*
180 		 * If the media indicates a different PHY instance,
181 		 * isolate ourselves.
182 		 */
183 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
184 			reg = PHY_READ(sc, MII_BMCR);
185 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
186 			return (0);
187 		}
188 
189 		/*
190 		 * If the interface is not up, don't do anything.
191 		 */
192 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
193 			break;
194 
195 		mii_phy_setmedia(sc);
196 		break;
197 
198 	case MII_TICK:
199 		/*
200 		 * If we're not currently selected, just return.
201 		 */
202 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
203 			return (0);
204 
205 		if (mii_phy_tick(sc) == EJUSTRETURN)
206 			return (0);
207 		break;
208 
209 	case MII_DOWN:
210 		mii_phy_down(sc);
211 		return (0);
212 	}
213 
214 	/* Update the media status. */
215 	mii_phy_status(sc);
216 
217 	/* Callback if something changed. */
218 	mii_phy_update(sc, cmd);
219 	return (0);
220 }
221 
222 static void
223 nsphyter_status(struct mii_softc *sc)
224 {
225 	struct mii_data *mii = sc->mii_pdata;
226 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
227 	int bmsr, bmcr, physts;
228 
229 	mii->mii_media_status = IFM_AVALID;
230 	mii->mii_media_active = IFM_ETHER;
231 
232 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
233 	physts = PHY_READ(sc, MII_NSPHYTER_PHYSTS);
234 
235 	if (physts & PHYSTS_LINK)
236 		mii->mii_media_status |= IFM_ACTIVE;
237 
238 	bmcr = PHY_READ(sc, MII_BMCR);
239 	if (bmcr & BMCR_ISO) {
240 		mii->mii_media_active |= IFM_NONE;
241 		mii->mii_media_status = 0;
242 		return;
243 	}
244 
245 	if (bmcr & BMCR_LOOP)
246 		mii->mii_media_active |= IFM_LOOP;
247 
248 	if (bmcr & BMCR_AUTOEN) {
249 		/*
250 		 * The media status bits are only valid of autonegotiation
251 		 * has completed (or it's disabled).
252 		 */
253 		if ((bmsr & BMSR_ACOMP) == 0) {
254 			/* Erg, still trying, I guess... */
255 			mii->mii_media_active |= IFM_NONE;
256 			return;
257 		}
258 
259 		if (physts & PHYSTS_SPEED10)
260 			mii->mii_media_active |= IFM_10_T;
261 		else
262 			mii->mii_media_active |= IFM_100_TX;
263 		if (physts & PHYSTS_DUPLEX)
264 			mii->mii_media_active |=
265 			    IFM_FDX | mii_phy_flowstatus(sc);
266 	} else
267 		mii->mii_media_active = ife->ifm_media;
268 }
269 
270 void
271 nsphyter_reset(struct mii_softc *sc)
272 {
273 	int reg, i;
274 
275 	if (sc->mii_flags & MIIF_NOISOLATE)
276 		reg = BMCR_RESET;
277 	else
278 		reg = BMCR_RESET | BMCR_ISO;
279 	PHY_WRITE(sc, MII_BMCR, reg);
280 
281 	/*
282 	 * It is best to allow a little time for the reset to settle
283 	 * in before we start polling the BMCR again.  Notably, the
284 	 * DP83840A manual states that there should be a 500us delay
285 	 * between asserting software reset and attempting MII serial
286 	 * operations.  Also, a DP83815 can get into a bad state on
287 	 * cable removal and reinsertion if we do not delay here.
288 	 */
289 	delay(500);
290 
291 	/* Wait another 100ms for it to complete. */
292 	for (i = 0; i < 100; i++) {
293 		reg = PHY_READ(sc, MII_BMCR);
294 		if ((reg & BMCR_RESET) == 0)
295 			break;
296 		delay(1000);
297 	}
298 
299 	if (sc->mii_inst != 0 && ((sc->mii_flags & MIIF_NOISOLATE) == 0))
300 		PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
301 }
302