xref: /netbsd-src/sys/dev/mii/sqphy.c (revision ce2c90c7c172d95d2402a5b3d96d8f8e6d138a21)
1 /*	$NetBSD: sqphy.c,v 1.40 2006/10/12 01:31:25 christos 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  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *	This product includes software developed by the NetBSD
22  *	Foundation, Inc. and its contributors.
23  * 4. Neither the name of The NetBSD Foundation nor the names of its
24  *    contributors may be used to endorse or promote products derived
25  *    from this software without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37  * POSSIBILITY OF SUCH DAMAGE.
38  */
39 
40 /*
41  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
42  *
43  * Redistribution and use in source and binary forms, with or without
44  * modification, are permitted provided that the following conditions
45  * are met:
46  * 1. Redistributions of source code must retain the above copyright
47  *    notice, this list of conditions and the following disclaimer.
48  * 2. Redistributions in binary form must reproduce the above copyright
49  *    notice, this list of conditions and the following disclaimer in the
50  *    documentation and/or other materials provided with the distribution.
51  * 3. All advertising materials mentioning features or use of this software
52  *    must display the following acknowledgement:
53  *	This product includes software developed by Manuel Bouyer.
54  * 4. The name of the author may not be used to endorse or promote products
55  *    derived from this software without specific prior written permission.
56  *
57  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
58  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
59  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
60  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
61  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
62  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
63  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
64  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
65  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
66  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
67  */
68 
69 /*
70  * driver for Seeq 80220/80221, 80223, and 80225 10/100 ethernet PHYs
71  * datasheet from www.seeq.com
72  */
73 
74 #include <sys/cdefs.h>
75 __KERNEL_RCSID(0, "$NetBSD: sqphy.c,v 1.40 2006/10/12 01:31:25 christos Exp $");
76 
77 #include <sys/param.h>
78 #include <sys/systm.h>
79 #include <sys/kernel.h>
80 #include <sys/device.h>
81 #include <sys/socket.h>
82 #include <sys/errno.h>
83 
84 #include <net/if.h>
85 #include <net/if_media.h>
86 
87 #include <dev/mii/mii.h>
88 #include <dev/mii/miivar.h>
89 #include <dev/mii/miidevs.h>
90 
91 #include <dev/mii/sqphyreg.h>
92 
93 static int	sqphymatch(struct device *, struct cfdata *, void *);
94 static void	sqphyattach(struct device *, struct device *, void *);
95 
96 CFATTACH_DECL(sqphy, sizeof(struct mii_softc),
97     sqphymatch, sqphyattach, mii_phy_detach, mii_phy_activate);
98 
99 static int	sqphy_service(struct mii_softc *, struct mii_data *, int);
100 static void	sqphy_status(struct mii_softc *);
101 static void	sqphy_84220_reset(struct mii_softc *);
102 
103 static const struct mii_phy_funcs sqphy_funcs = {
104 	sqphy_service, sqphy_status, mii_phy_reset,
105 };
106 
107 static const struct mii_phy_funcs sqphy_84220_funcs = {
108 	sqphy_service, sqphy_status, sqphy_84220_reset,
109 };
110 
111 static const struct mii_phydesc sqphys[] = {
112 	{ MII_OUI_SEEQ,			MII_MODEL_SEEQ_80220,
113 	  MII_STR_SEEQ_80220 },
114 
115 	{ MII_OUI_SEEQ,			MII_MODEL_SEEQ_80225,
116 	  MII_STR_SEEQ_80225 },
117 
118 	{ MII_OUI_SEEQ,			MII_MODEL_SEEQ_84220,
119 	  MII_STR_SEEQ_84220 },
120 
121 	{ 0,				0,
122 	  NULL },
123 };
124 
125 static int
126 sqphymatch(struct device *parent __unused, struct cfdata *match __unused,
127     void *aux)
128 {
129 	struct mii_attach_args *ma = aux;
130 
131 	if (mii_phy_match(ma, sqphys) != NULL)
132 		return (10);
133 
134 	return (0);
135 }
136 
137 static void
138 sqphyattach(struct device *parent __unused, struct device *self, void *aux)
139 {
140 	struct mii_softc *sc = device_private(self);
141 	struct mii_attach_args *ma = aux;
142 	struct mii_data *mii = ma->mii_data;
143 	const struct mii_phydesc *mpd;
144 
145 	mpd = mii_phy_match(ma, sqphys);
146 	aprint_naive(": Media interface\n");
147 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
148 
149 	sc->mii_inst = mii->mii_instance;
150 	sc->mii_phy = ma->mii_phyno;
151 	sc->mii_pdata = mii;
152 	sc->mii_flags = ma->mii_flags;
153 	sc->mii_anegticks = 5;
154 
155 	switch (MII_MODEL(ma->mii_id2)) {
156 	case MII_MODEL_SEEQ_84220:
157 		sc->mii_funcs = &sqphy_84220_funcs;
158 		aprint_normal("%s: using Seeq 84220 isolate/reset hack\n",
159 		    sc->mii_dev.dv_xname);
160 		break;
161 
162 	default:
163 		sc->mii_funcs = &sqphy_funcs;
164 	}
165 
166 	PHY_RESET(sc);
167 
168 	sc->mii_capabilities =
169 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
170 	aprint_normal("%s: ", sc->mii_dev.dv_xname);
171 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
172 		aprint_error("no media present");
173 	else
174 		mii_phy_add_media(sc);
175 	aprint_normal("\n");
176 }
177 
178 static int
179 sqphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
180 {
181 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
182 	int reg;
183 
184 	if (!device_is_active(&sc->mii_dev))
185 		return (ENXIO);
186 
187 	switch (cmd) {
188 	case MII_POLLSTAT:
189 		/*
190 		 * If we're not polling our PHY instance, just return.
191 		 */
192 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
193 			return (0);
194 		break;
195 
196 	case MII_MEDIACHG:
197 		/*
198 		 * If the media indicates a different PHY instance,
199 		 * isolate ourselves.
200 		 */
201 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
202 			reg = PHY_READ(sc, MII_BMCR);
203 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
204 			return (0);
205 		}
206 
207 		/*
208 		 * If the interface is not up, don't do anything.
209 		 */
210 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
211 			break;
212 
213 		mii_phy_setmedia(sc);
214 		break;
215 
216 	case MII_TICK:
217 		/*
218 		 * If we're not currently selected, just return.
219 		 */
220 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
221 			return (0);
222 
223 		if (mii_phy_tick(sc) == EJUSTRETURN)
224 			return (0);
225 		break;
226 
227 	case MII_DOWN:
228 		mii_phy_down(sc);
229 		return (0);
230 	}
231 
232 	/* Update the media status. */
233 	mii_phy_status(sc);
234 
235 	/* Callback if something changed. */
236 	mii_phy_update(sc, cmd);
237 	return (0);
238 }
239 
240 static void
241 sqphy_status(struct mii_softc *sc)
242 {
243 	struct mii_data *mii = sc->mii_pdata;
244 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
245 	int bmsr, bmcr, status;
246 
247 	mii->mii_media_status = IFM_AVALID;
248 	mii->mii_media_active = IFM_ETHER;
249 
250 	bmsr = PHY_READ(sc, MII_BMSR) |
251 	    PHY_READ(sc, MII_BMSR);
252 	if (bmsr & BMSR_LINK)
253 		mii->mii_media_status |= IFM_ACTIVE;
254 
255 	bmcr = PHY_READ(sc, MII_BMCR);
256 	if (bmcr & BMCR_ISO) {
257 		mii->mii_media_active |= IFM_NONE;
258 		mii->mii_media_status = 0;
259 		return;
260 	}
261 
262 	if (bmcr & BMCR_LOOP)
263 		mii->mii_media_active |= IFM_LOOP;
264 
265 	if (bmcr & BMCR_AUTOEN) {
266 		if ((bmsr & BMSR_ACOMP) == 0) {
267 			/* Erg, still trying, I guess... */
268 			mii->mii_media_active |= IFM_NONE;
269 			return;
270 		}
271 		/*
272 		 * Note: don't get fancy here -- the 80225 only
273 		 * supports the SPD_DET and DPLX_DET bits in
274 		 * the STATUS register.
275 		 */
276 		status = PHY_READ(sc, MII_SQPHY_STATUS);
277 		if (status & STATUS_SPD_DET)
278 			mii->mii_media_active |= IFM_100_TX;
279 		else
280 			mii->mii_media_active |= IFM_10_T;
281 		if (status & STATUS_DPLX_DET)
282 			mii->mii_media_active |= IFM_FDX;
283 	} else
284 		mii->mii_media_active = ife->ifm_media;
285 }
286 
287 static void
288 sqphy_84220_reset(struct mii_softc *sc)
289 {
290 	int reg;
291 
292 	mii_phy_reset(sc);
293 
294 	/*
295 	 * This PHY sometimes insists on coming out of reset isolated,
296 	 * even when the MDA[0-3] pins are pulled high (to indicate
297 	 * PHY address 0), contrary to the device's datasheet.
298 	 *
299 	 * Morever, simply clearing BMCR_ISO here isn't enough; the
300 	 * change won't stick until about 30mS *after* the PHY has
301 	 * been reset.
302 	 *
303 	 * This sucks.
304 	 */
305 	while ((sc->mii_inst == 0 || (sc->mii_flags & MIIF_NOISOLATE)) &&
306 	    ((reg = PHY_READ(sc, MII_BMCR)) & BMCR_ISO) != 0) {
307 
308 		delay(35000);
309 		PHY_WRITE(sc, MII_BMCR, reg & ~BMCR_ISO);
310 		delay(35000);
311 	}
312 }
313