xref: /freebsd/sys/dev/mii/xmphy.c (revision c68159a6d8eede11766cf13896d0f7670dbd51aa)
1 /*
2  * Copyright (c) 2000
3  *	Bill Paul <wpaul@ee.columbia.edu>.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by Bill Paul.
16  * 4. Neither the name of the author nor the names of any co-contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
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
30  * THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * $FreeBSD$
33  */
34 
35 /*
36  * driver for the XaQti XMAC II's internal PHY. This is sort of
37  * like a 10/100 PHY, except the only thing we're really autoselecting
38  * here is full/half duplex. Speed is always 1000mbps.
39  */
40 
41 #include <sys/param.h>
42 #include <sys/systm.h>
43 #include <sys/kernel.h>
44 #include <sys/malloc.h>
45 #include <sys/socket.h>
46 #include <sys/bus.h>
47 
48 
49 #include <net/if.h>
50 #include <net/if_media.h>
51 
52 #include <dev/mii/mii.h>
53 #include <dev/mii/miivar.h>
54 #include <dev/mii/miidevs.h>
55 
56 #include <dev/mii/xmphyreg.h>
57 
58 #include "miibus_if.h"
59 
60 #if !defined(lint)
61 static const char rcsid[] =
62   "$FreeBSD$";
63 #endif
64 
65 static int xmphy_probe		__P((device_t));
66 static int xmphy_attach		__P((device_t));
67 static int xmphy_detach		__P((device_t));
68 
69 static device_method_t xmphy_methods[] = {
70 	/* device interface */
71 	DEVMETHOD(device_probe,		xmphy_probe),
72 	DEVMETHOD(device_attach,	xmphy_attach),
73 	DEVMETHOD(device_detach,	xmphy_detach),
74 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
75 	{ 0, 0 }
76 };
77 
78 static devclass_t xmphy_devclass;
79 
80 static driver_t xmphy_driver = {
81 	"xmphy",
82 	xmphy_methods,
83 	sizeof(struct mii_softc)
84 };
85 
86 DRIVER_MODULE(xmphy, miibus, xmphy_driver, xmphy_devclass, 0, 0);
87 
88 int	xmphy_service __P((struct mii_softc *, struct mii_data *, int));
89 void	xmphy_status __P((struct mii_softc *));
90 
91 static int	xmphy_mii_phy_auto __P((struct mii_softc *, int));
92 extern void	mii_phy_auto_timeout __P((void *));
93 
94 static int xmphy_probe(dev)
95 	device_t		dev;
96 {
97 	struct mii_attach_args *ma;
98 
99 	ma = device_get_ivars(dev);
100 
101 	if (MII_OUI(ma->mii_id1, ma->mii_id2) != MII_OUI_xxXAQTI ||
102 	    MII_MODEL(ma->mii_id2) != MII_MODEL_XAQTI_XMACII)
103 		return(ENXIO);
104 
105 	device_set_desc(dev, MII_STR_XAQTI_XMACII);
106 
107 	return(0);
108 }
109 
110 static int xmphy_attach(dev)
111 	device_t		dev;
112 {
113 	struct mii_softc *sc;
114 	struct mii_attach_args *ma;
115 	struct mii_data *mii;
116 	const char *sep = "";
117 
118 	sc = device_get_softc(dev);
119 	ma = device_get_ivars(dev);
120 	sc->mii_dev = device_get_parent(dev);
121 	mii = device_get_softc(sc->mii_dev);
122 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
123 
124 	sc->mii_inst = mii->mii_instance;
125 	sc->mii_phy = ma->mii_phyno;
126 	sc->mii_service = xmphy_service;
127 	sc->mii_pdata = mii;
128 
129 	sc->mii_flags |= MIIF_NOISOLATE;
130 	mii->mii_instance++;
131 
132 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
133 #define PRINT(s)	printf("%s%s", sep, s); sep = ", "
134 
135 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
136 	    BMCR_ISO);
137 #if 0
138 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
139 	    BMCR_LOOP|BMCR_S100);
140 #endif
141 
142 	mii_phy_reset(sc);
143 
144 	device_printf(dev, " ");
145 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, 0, sc->mii_inst),
146 	    XMPHY_BMCR_FDX);
147 	PRINT("1000baseSX");
148 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, IFM_FDX, sc->mii_inst), 0);
149 	PRINT("1000baseSX-FDX");
150 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, sc->mii_inst), 0);
151 	PRINT("auto");
152 
153 	printf("\n");
154 #undef ADD
155 #undef PRINT
156 
157 	MIIBUS_MEDIAINIT(sc->mii_dev);
158 	return(0);
159 }
160 
161 static int xmphy_detach(dev)
162 	device_t		dev;
163 {
164 	struct mii_softc *sc;
165 	struct mii_data *mii;
166 
167 	sc = device_get_softc(dev);
168 	mii = device_get_softc(device_get_parent(dev));
169 	if (sc->mii_flags & MIIF_DOINGAUTO)
170 		untimeout(mii_phy_auto_timeout, sc, sc->mii_auto_ch);
171 	sc->mii_dev = NULL;
172 	LIST_REMOVE(sc, mii_list);
173 
174 	return(0);
175 }
176 int
177 xmphy_service(sc, mii, cmd)
178 	struct mii_softc *sc;
179 	struct mii_data *mii;
180 	int cmd;
181 {
182 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
183 	int reg;
184 
185 	switch (cmd) {
186 	case MII_POLLSTAT:
187 		/*
188 		 * If we're not polling our PHY instance, just return.
189 		 */
190 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
191 			return (0);
192 		break;
193 
194 	case MII_MEDIACHG:
195 		/*
196 		 * If the media indicates a different PHY instance,
197 		 * isolate ourselves.
198 		 */
199 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
200 			reg = PHY_READ(sc, MII_BMCR);
201 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
202 			return (0);
203 		}
204 
205 		/*
206 		 * If the interface is not up, don't do anything.
207 		 */
208 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
209 			break;
210 
211 		switch (IFM_SUBTYPE(ife->ifm_media)) {
212 		case IFM_AUTO:
213 			/*
214 			 * If we're already in auto mode, just return.
215 			 */
216 			if (PHY_READ(sc, XMPHY_MII_BMCR) & XMPHY_BMCR_AUTOEN)
217 				return (0);
218 			(void) xmphy_mii_phy_auto(sc, 1);
219 			break;
220 		case IFM_1000_SX:
221 			mii_phy_reset(sc);
222 			if ((ife->ifm_media & IFM_GMASK) == IFM_FDX) {
223 				PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_FDX);
224 				PHY_WRITE(sc, XMPHY_MII_BMCR, XMPHY_BMCR_FDX);
225 			} else {
226 				PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_HDX);
227 				PHY_WRITE(sc, XMPHY_MII_BMCR, 0);
228 			}
229 			break;
230 		case IFM_100_T4:
231 		case IFM_100_TX:
232 		case IFM_10_T:
233 		default:
234 			return (EINVAL);
235 		}
236 		break;
237 
238 	case MII_TICK:
239 		/*
240 		 * If we're not currently selected, just return.
241 		 */
242 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
243 			return (0);
244 
245 		/*
246 		 * Only used for autonegotiation.
247 		 */
248 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
249 			return (0);
250 
251 		/*
252 		 * Is the interface even up?
253 		 */
254 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
255 			return (0);
256 
257 		/*
258 		 * Only retry autonegotiation every 5 seconds.
259 		 */
260 		if (++sc->mii_ticks != 5)
261 			return (0);
262 
263 		sc->mii_ticks = 0;
264 
265 		/*
266 		 * Check to see if we have link.  If we do, we don't
267 		 * need to restart the autonegotiation process.  Read
268 		 * the BMSR twice in case it's latched.
269 		 */
270 		reg = PHY_READ(sc, XMPHY_MII_BMSR) |
271 		    PHY_READ(sc, XMPHY_MII_BMSR);
272 		if (reg & XMPHY_BMSR_LINK)
273 			break;
274 
275 		mii_phy_reset(sc);
276 		if (xmphy_mii_phy_auto(sc, 0) == EJUSTRETURN)
277 			return(0);
278 		break;
279 	}
280 
281 	/* Update the media status. */
282 	xmphy_status(sc);
283 
284 	/* Callback if something changed. */
285 	if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
286 		MIIBUS_STATCHG(sc->mii_dev);
287 		sc->mii_active = mii->mii_media_active;
288 	}
289 	return (0);
290 }
291 
292 void
293 xmphy_status(sc)
294 	struct mii_softc *sc;
295 {
296 	struct mii_data *mii = sc->mii_pdata;
297 	int bmsr, bmcr, anlpar;
298 
299 	mii->mii_media_status = IFM_AVALID;
300 	mii->mii_media_active = IFM_ETHER;
301 
302 	bmsr = PHY_READ(sc, XMPHY_MII_BMSR) |
303 	    PHY_READ(sc, XMPHY_MII_BMSR);
304 	if (bmsr & XMPHY_BMSR_LINK)
305 		mii->mii_media_status |= IFM_ACTIVE;
306 
307 	/* Do dummy read of extended status register. */
308 	bmcr = PHY_READ(sc, XMPHY_MII_EXTSTS);
309 
310 	bmcr = PHY_READ(sc, XMPHY_MII_BMCR);
311 
312 	if (bmcr & XMPHY_BMCR_LOOP)
313 		mii->mii_media_active |= IFM_LOOP;
314 
315 
316 	if (bmcr & XMPHY_BMCR_AUTOEN) {
317 		if ((bmsr & XMPHY_BMSR_ACOMP) == 0) {
318 			if (bmsr & XMPHY_BMSR_LINK) {
319 				mii->mii_media_active |= IFM_1000_SX|IFM_HDX;
320 				return;
321 			}
322 			/* Erg, still trying, I guess... */
323 			mii->mii_media_active |= IFM_NONE;
324 			return;
325 		}
326 
327 		mii->mii_media_active |= IFM_1000_SX;
328 		anlpar = PHY_READ(sc, XMPHY_MII_ANAR) &
329 		    PHY_READ(sc, XMPHY_MII_ANLPAR);
330 		if (anlpar & XMPHY_ANLPAR_FDX)
331 			mii->mii_media_active |= IFM_FDX;
332 		else
333 			mii->mii_media_active |= IFM_HDX;
334 		return;
335 	}
336 
337 	mii->mii_media_active |= IFM_1000_SX;
338 	if (bmcr & XMPHY_BMCR_FDX)
339 		mii->mii_media_active |= IFM_FDX;
340 	else
341 		mii->mii_media_active |= IFM_HDX;
342 
343 	return;
344 }
345 
346 
347 static int
348 xmphy_mii_phy_auto(mii, waitfor)
349 	struct mii_softc *mii;
350 	int waitfor;
351 {
352 	int bmsr, i;
353 
354 	if ((mii->mii_flags & MIIF_DOINGAUTO) == 0) {
355 		PHY_WRITE(mii, XMPHY_MII_ANAR,
356 		    XMPHY_ANAR_FDX|XMPHY_ANAR_HDX);
357 		PHY_WRITE(mii, XMPHY_MII_BMCR,
358 		    XMPHY_BMCR_AUTOEN | XMPHY_BMCR_STARTNEG);
359 	}
360 
361 	if (waitfor) {
362 		/* Wait 500ms for it to complete. */
363 		for (i = 0; i < 500; i++) {
364 			if ((bmsr = PHY_READ(mii, XMPHY_MII_BMSR)) &
365 			    XMPHY_BMSR_ACOMP)
366 				return (0);
367 			DELAY(1000);
368 #if 0
369 		if ((bmsr & BMSR_ACOMP) == 0)
370 			printf("%s: autonegotiation failed to complete\n",
371 			    mii->mii_dev.dv_xname);
372 #endif
373 		}
374 
375 		/*
376 		 * Don't need to worry about clearing MIIF_DOINGAUTO.
377 		 * If that's set, a timeout is pending, and it will
378 		 * clear the flag.
379 		 */
380 		return (EIO);
381 	}
382 
383 	/*
384 	 * Just let it finish asynchronously.  This is for the benefit of
385 	 * the tick handler driving autonegotiation.  Don't want 500ms
386 	 * delays all the time while the system is running!
387 	 */
388 	if ((mii->mii_flags & MIIF_DOINGAUTO) == 0) {
389 		mii->mii_flags |= MIIF_DOINGAUTO;
390 		mii->mii_auto_ch = timeout(mii_phy_auto_timeout, mii, hz >> 1);
391 	}
392 	return (EJUSTRETURN);
393 }
394