xref: /netbsd-src/sys/dev/mii/sqphy.c (revision cac8e449158efc7261bebc8657cbb0125a2cfdde)
1 /*	$NetBSD: sqphy.c,v 1.47 2008/05/04 17:06:10 xtraeme 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 Seeq 80220/80221, 80223, and 80225 10/100 ethernet PHYs
64  * datasheet from www.seeq.com
65  */
66 
67 #include <sys/cdefs.h>
68 __KERNEL_RCSID(0, "$NetBSD: sqphy.c,v 1.47 2008/05/04 17:06:10 xtraeme Exp $");
69 
70 #include <sys/param.h>
71 #include <sys/systm.h>
72 #include <sys/kernel.h>
73 #include <sys/device.h>
74 #include <sys/socket.h>
75 #include <sys/errno.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 <dev/mii/miidevs.h>
83 
84 #include <dev/mii/sqphyreg.h>
85 
86 static int	sqphymatch(device_t, cfdata_t, void *);
87 static void	sqphyattach(device_t, device_t, void *);
88 
89 CFATTACH_DECL_NEW(sqphy, sizeof(struct mii_softc),
90     sqphymatch, sqphyattach, mii_phy_detach, mii_phy_activate);
91 
92 static int	sqphy_service(struct mii_softc *, struct mii_data *, int);
93 static void	sqphy_status(struct mii_softc *);
94 static void	sqphy_84220_reset(struct mii_softc *);
95 
96 static const struct mii_phy_funcs sqphy_funcs = {
97 	sqphy_service, sqphy_status, mii_phy_reset,
98 };
99 
100 static const struct mii_phy_funcs sqphy_84220_funcs = {
101 	sqphy_service, sqphy_status, sqphy_84220_reset,
102 };
103 
104 static const struct mii_phydesc sqphys[] = {
105 	{ MII_OUI_SEEQ,			MII_MODEL_SEEQ_80220,
106 	  MII_STR_SEEQ_80220 },
107 
108 	{ MII_OUI_SEEQ,			MII_MODEL_SEEQ_80225,
109 	  MII_STR_SEEQ_80225 },
110 
111 	{ MII_OUI_SEEQ,			MII_MODEL_SEEQ_84220,
112 	  MII_STR_SEEQ_84220 },
113 
114 	{ 0,				0,
115 	  NULL },
116 };
117 
118 static int
119 sqphymatch(device_t parent, cfdata_t match, void *aux)
120 {
121 	struct mii_attach_args *ma = aux;
122 
123 	if (mii_phy_match(ma, sqphys) != NULL)
124 		return (10);
125 
126 	return (0);
127 }
128 
129 static void
130 sqphyattach(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, sqphys);
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_pdata = mii;
145 	sc->mii_flags = ma->mii_flags;
146 	sc->mii_anegticks = MII_ANEGTICKS;
147 
148 	switch (MII_MODEL(ma->mii_id2)) {
149 	case MII_MODEL_SEEQ_84220:
150 		sc->mii_funcs = &sqphy_84220_funcs;
151 		aprint_normal_dev(self, "using Seeq 84220 isolate/reset hack\n");
152 		break;
153 
154 	default:
155 		sc->mii_funcs = &sqphy_funcs;
156 	}
157 
158 	PHY_RESET(sc);
159 
160 	sc->mii_capabilities =
161 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
162 	aprint_normal_dev(self, "");
163 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
164 		aprint_error("no media present");
165 	else
166 		mii_phy_add_media(sc);
167 	aprint_normal("\n");
168 
169 	if (!pmf_device_register(self, NULL, mii_phy_resume))
170 		aprint_error_dev(self, "couldn't establish power handler\n");
171 }
172 
173 static int
174 sqphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
175 {
176 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
177 	int reg;
178 
179 	switch (cmd) {
180 	case MII_POLLSTAT:
181 		/*
182 		 * If we're not polling our PHY instance, just return.
183 		 */
184 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
185 			return (0);
186 		break;
187 
188 	case MII_MEDIACHG:
189 		/*
190 		 * If the media indicates a different PHY instance,
191 		 * isolate ourselves.
192 		 */
193 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
194 			reg = PHY_READ(sc, MII_BMCR);
195 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
196 			return (0);
197 		}
198 
199 		/*
200 		 * If the interface is not up, don't do anything.
201 		 */
202 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
203 			break;
204 
205 		mii_phy_setmedia(sc);
206 		break;
207 
208 	case MII_TICK:
209 		/*
210 		 * If we're not currently selected, just return.
211 		 */
212 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
213 			return (0);
214 
215 		if (mii_phy_tick(sc) == EJUSTRETURN)
216 			return (0);
217 		break;
218 
219 	case MII_DOWN:
220 		mii_phy_down(sc);
221 		return (0);
222 	}
223 
224 	/* Update the media status. */
225 	mii_phy_status(sc);
226 
227 	/* Callback if something changed. */
228 	mii_phy_update(sc, cmd);
229 	return (0);
230 }
231 
232 static void
233 sqphy_status(struct mii_softc *sc)
234 {
235 	struct mii_data *mii = sc->mii_pdata;
236 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
237 	int bmsr, bmcr, status;
238 
239 	mii->mii_media_status = IFM_AVALID;
240 	mii->mii_media_active = IFM_ETHER;
241 
242 	bmsr = PHY_READ(sc, MII_BMSR) |
243 	    PHY_READ(sc, MII_BMSR);
244 	if (bmsr & BMSR_LINK)
245 		mii->mii_media_status |= IFM_ACTIVE;
246 
247 	bmcr = PHY_READ(sc, MII_BMCR);
248 	if (bmcr & BMCR_ISO) {
249 		mii->mii_media_active |= IFM_NONE;
250 		mii->mii_media_status = 0;
251 		return;
252 	}
253 
254 	if (bmcr & BMCR_LOOP)
255 		mii->mii_media_active |= IFM_LOOP;
256 
257 	if (bmcr & BMCR_AUTOEN) {
258 		if ((bmsr & BMSR_ACOMP) == 0) {
259 			/* Erg, still trying, I guess... */
260 			mii->mii_media_active |= IFM_NONE;
261 			return;
262 		}
263 		/*
264 		 * Note: don't get fancy here -- the 80225 only
265 		 * supports the SPD_DET and DPLX_DET bits in
266 		 * the STATUS register.
267 		 */
268 		status = PHY_READ(sc, MII_SQPHY_STATUS);
269 		if (status & STATUS_SPD_DET)
270 			mii->mii_media_active |= IFM_100_TX;
271 		else
272 			mii->mii_media_active |= IFM_10_T;
273 		if (status & STATUS_DPLX_DET)
274 			mii->mii_media_active |= IFM_FDX;
275 	} else
276 		mii->mii_media_active = ife->ifm_media;
277 }
278 
279 static void
280 sqphy_84220_reset(struct mii_softc *sc)
281 {
282 	int reg;
283 
284 	mii_phy_reset(sc);
285 
286 	/*
287 	 * This PHY sometimes insists on coming out of reset isolated,
288 	 * even when the MDA[0-3] pins are pulled high (to indicate
289 	 * PHY address 0), contrary to the device's datasheet.
290 	 *
291 	 * Morever, simply clearing BMCR_ISO here isn't enough; the
292 	 * change won't stick until about 30mS *after* the PHY has
293 	 * been reset.
294 	 *
295 	 * This sucks.
296 	 */
297 	while ((sc->mii_inst == 0 || (sc->mii_flags & MIIF_NOISOLATE)) &&
298 	    ((reg = PHY_READ(sc, MII_BMCR)) & BMCR_ISO) != 0) {
299 
300 		delay(35000);
301 		PHY_WRITE(sc, MII_BMCR, reg & ~BMCR_ISO);
302 		delay(35000);
303 	}
304 }
305