xref: /dflybsd-src/sys/dev/netif/mii_layer/xmphy.c (revision 39b5d600dedf02a61b8b1213f9fdaaee4b8292e0)
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: src/sys/dev/mii/xmphy.c,v 1.1.2.5 2002/11/08 21:53:49 semenu Exp $
33  * $DragonFly: src/sys/dev/netif/mii_layer/xmphy.c,v 1.7 2005/10/24 16:55:40 dillon Exp $
34  */
35 
36 /*
37  * driver for the XaQti XMAC II's internal PHY. This is sort of
38  * like a 10/100 PHY, except the only thing we're really autoselecting
39  * here is full/half duplex. Speed is always 1000mbps.
40  */
41 
42 #include <sys/param.h>
43 #include <sys/systm.h>
44 #include <sys/kernel.h>
45 #include <sys/socket.h>
46 #include <sys/bus.h>
47 
48 #include <machine/clock.h>
49 
50 #include <net/if.h>
51 #include <net/if_media.h>
52 
53 #include "mii.h"
54 #include "miivar.h"
55 #include "miidevs.h"
56 
57 #include "xmphyreg.h"
58 
59 #include "miibus_if.h"
60 
61 static int xmphy_probe		(device_t);
62 static int xmphy_attach		(device_t);
63 static int xmphy_detach		(device_t);
64 
65 static device_method_t xmphy_methods[] = {
66 	/* device interface */
67 	DEVMETHOD(device_probe,		xmphy_probe),
68 	DEVMETHOD(device_attach,	xmphy_attach),
69 	DEVMETHOD(device_detach,	xmphy_detach),
70 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
71 	{ 0, 0 }
72 };
73 
74 static devclass_t xmphy_devclass;
75 
76 static driver_t xmphy_driver = {
77 	"xmphy",
78 	xmphy_methods,
79 	sizeof(struct mii_softc)
80 };
81 
82 DRIVER_MODULE(xmphy, miibus, xmphy_driver, xmphy_devclass, 0, 0);
83 
84 int	xmphy_service (struct mii_softc *, struct mii_data *, int);
85 void	xmphy_status (struct mii_softc *);
86 
87 static int	xmphy_mii_phy_auto (struct mii_softc *, int);
88 extern void	mii_phy_auto_timeout (void *);
89 
90 static int xmphy_probe(dev)
91 	device_t		dev;
92 {
93 	struct mii_attach_args *ma;
94 
95 	ma = device_get_ivars(dev);
96 
97 	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxXAQTI &&
98 	    MII_MODEL(ma->mii_id2) == MII_MODEL_XAQTI_XMACII) {
99 		device_set_desc(dev, MII_STR_XAQTI_XMACII);
100 		return(0);
101 	}
102 
103 	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_JATO &&
104 	    MII_MODEL(ma->mii_id2) == MII_MODEL_JATO_BASEX) {
105 		device_set_desc(dev, MII_STR_JATO_BASEX);
106 		return(0);
107 	}
108 
109 	return(ENXIO);
110 }
111 
112 static int xmphy_attach(dev)
113 	device_t		dev;
114 {
115 	struct mii_softc *sc;
116 	struct mii_attach_args *ma;
117 	struct mii_data *mii;
118 	const char *sep = "";
119 
120 	sc = device_get_softc(dev);
121 	ma = device_get_ivars(dev);
122 	mii_softc_init(sc, ma);
123 	sc->mii_dev = device_get_parent(dev);
124 	mii = device_get_softc(sc->mii_dev);
125 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
126 
127 	sc->mii_inst = mii->mii_instance;
128 	sc->mii_service = xmphy_service;
129 	sc->mii_pdata = mii;
130 
131 	sc->mii_flags |= MIIF_NOISOLATE;
132 	mii->mii_instance++;
133 
134 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
135 #define PRINT(s)	printf("%s%s", sep, s); sep = ", "
136 
137 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
138 	    BMCR_ISO);
139 #if 0
140 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
141 	    BMCR_LOOP|BMCR_S100);
142 #endif
143 
144 	mii_phy_reset(sc);
145 
146 	device_printf(dev, " ");
147 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, 0, sc->mii_inst),
148 	    XMPHY_BMCR_FDX);
149 	PRINT("1000baseSX");
150 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, IFM_FDX, sc->mii_inst), 0);
151 	PRINT("1000baseSX-FDX");
152 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, sc->mii_inst), 0);
153 	PRINT("auto");
154 
155 	printf("\n");
156 #undef ADD
157 #undef PRINT
158 
159 	MIIBUS_MEDIAINIT(sc->mii_dev);
160 	return(0);
161 }
162 
163 static int xmphy_detach(dev)
164 	device_t		dev;
165 {
166 	struct mii_softc *sc;
167 	struct mii_data *mii;
168 
169 	sc = device_get_softc(dev);
170 	mii = device_get_softc(device_get_parent(dev));
171 	if (sc->mii_flags & MIIF_DOINGAUTO)
172 		callout_stop(&sc->mii_auto_ch);
173 	sc->mii_dev = NULL;
174 	LIST_REMOVE(sc, mii_list);
175 
176 	return(0);
177 }
178 int
179 xmphy_service(sc, mii, cmd)
180 	struct mii_softc *sc;
181 	struct mii_data *mii;
182 	int cmd;
183 {
184 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
185 	int reg;
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 		switch (IFM_SUBTYPE(ife->ifm_media)) {
214 		case IFM_AUTO:
215 #ifdef foo
216 			/*
217 			 * If we're already in auto mode, just return.
218 			 */
219 			if (PHY_READ(sc, XMPHY_MII_BMCR) & XMPHY_BMCR_AUTOEN)
220 				return (0);
221 #endif
222 			(void) xmphy_mii_phy_auto(sc, 1);
223 			break;
224 		case IFM_1000_SX:
225 			mii_phy_reset(sc);
226 			if ((ife->ifm_media & IFM_GMASK) == IFM_FDX) {
227 				PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_FDX);
228 				PHY_WRITE(sc, XMPHY_MII_BMCR, XMPHY_BMCR_FDX);
229 			} else {
230 				PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_HDX);
231 				PHY_WRITE(sc, XMPHY_MII_BMCR, 0);
232 			}
233 			break;
234 		case IFM_100_T4:
235 		case IFM_100_TX:
236 		case IFM_10_T:
237 		default:
238 			return (EINVAL);
239 		}
240 		break;
241 
242 	case MII_TICK:
243 		/*
244 		 * If we're not currently selected, just return.
245 		 */
246 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
247 			return (0);
248 
249 		/*
250 		 * Only used for autonegotiation.
251 		 */
252 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
253 			return (0);
254 
255 		/*
256 		 * Is the interface even up?
257 		 */
258 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
259 			return (0);
260 
261 		/*
262 		 * Only retry autonegotiation every 5 seconds.
263 		 */
264 		if (++sc->mii_ticks != 5)
265 			return (0);
266 
267 		sc->mii_ticks = 0;
268 
269 		/*
270 		 * Check to see if we have link.  If we do, we don't
271 		 * need to restart the autonegotiation process.  Read
272 		 * the BMSR twice in case it's latched.
273 		 */
274 		reg = PHY_READ(sc, XMPHY_MII_BMSR) |
275 		    PHY_READ(sc, XMPHY_MII_BMSR);
276 		if (reg & XMPHY_BMSR_LINK)
277 			break;
278 
279 		mii_phy_reset(sc);
280 		if (xmphy_mii_phy_auto(sc, 0) == EJUSTRETURN)
281 			return(0);
282 		break;
283 	}
284 
285 	/* Update the media status. */
286 	xmphy_status(sc);
287 
288 	/* Callback if something changed. */
289 	if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
290 		MIIBUS_STATCHG(sc->mii_dev);
291 		sc->mii_active = mii->mii_media_active;
292 	}
293 	return (0);
294 }
295 
296 void
297 xmphy_status(sc)
298 	struct mii_softc *sc;
299 {
300 	struct mii_data *mii = sc->mii_pdata;
301 	int bmsr, bmcr, anlpar;
302 
303 	mii->mii_media_status = IFM_AVALID;
304 	mii->mii_media_active = IFM_ETHER;
305 
306 	bmsr = PHY_READ(sc, XMPHY_MII_BMSR) |
307 	    PHY_READ(sc, XMPHY_MII_BMSR);
308 	if (bmsr & XMPHY_BMSR_LINK)
309 		mii->mii_media_status |= IFM_ACTIVE;
310 
311 	/* Do dummy read of extended status register. */
312 	bmcr = PHY_READ(sc, XMPHY_MII_EXTSTS);
313 
314 	bmcr = PHY_READ(sc, XMPHY_MII_BMCR);
315 
316 	if (bmcr & XMPHY_BMCR_LOOP)
317 		mii->mii_media_active |= IFM_LOOP;
318 
319 
320 	if (bmcr & XMPHY_BMCR_AUTOEN) {
321 		if ((bmsr & XMPHY_BMSR_ACOMP) == 0) {
322 			if (bmsr & XMPHY_BMSR_LINK) {
323 				mii->mii_media_active |= IFM_1000_SX|IFM_HDX;
324 				return;
325 			}
326 			/* Erg, still trying, I guess... */
327 			mii->mii_media_active |= IFM_NONE;
328 			return;
329 		}
330 
331 		mii->mii_media_active |= IFM_1000_SX;
332 		anlpar = PHY_READ(sc, XMPHY_MII_ANAR) &
333 		    PHY_READ(sc, XMPHY_MII_ANLPAR);
334 		if (anlpar & XMPHY_ANLPAR_FDX)
335 			mii->mii_media_active |= IFM_FDX;
336 		else
337 			mii->mii_media_active |= IFM_HDX;
338 		return;
339 	}
340 
341 	mii->mii_media_active |= IFM_1000_SX;
342 	if (bmcr & XMPHY_BMCR_FDX)
343 		mii->mii_media_active |= IFM_FDX;
344 	else
345 		mii->mii_media_active |= IFM_HDX;
346 
347 	return;
348 }
349 
350 
351 static int
352 xmphy_mii_phy_auto(mii, waitfor)
353 	struct mii_softc *mii;
354 	int waitfor;
355 {
356 	int bmsr, anar = 0, i;
357 
358 	if ((mii->mii_flags & MIIF_DOINGAUTO) == 0) {
359 		anar = PHY_READ(mii, XMPHY_MII_ANAR);
360 		anar |= XMPHY_ANAR_FDX|XMPHY_ANAR_HDX;
361 		PHY_WRITE(mii, XMPHY_MII_ANAR, anar);
362 		DELAY(1000);
363 		PHY_WRITE(mii, XMPHY_MII_BMCR,
364 		    XMPHY_BMCR_AUTOEN | XMPHY_BMCR_STARTNEG);
365 	}
366 
367 	if (waitfor) {
368 		/* Wait 500ms for it to complete. */
369 		for (i = 0; i < 500; i++) {
370 			if ((bmsr = PHY_READ(mii, XMPHY_MII_BMSR)) &
371 			    XMPHY_BMSR_ACOMP)
372 				return (0);
373 			DELAY(1000);
374 #if 0
375 		if ((bmsr & BMSR_ACOMP) == 0)
376 			printf("%s: autonegotiation failed to complete\n",
377 			    mii->mii_dev.dv_xname);
378 #endif
379 		}
380 
381 		/*
382 		 * Don't need to worry about clearing MIIF_DOINGAUTO.
383 		 * If that's set, a timeout is pending, and it will
384 		 * clear the flag.
385 		 */
386 		return (EIO);
387 	}
388 
389 	/*
390 	 * Just let it finish asynchronously.  This is for the benefit of
391 	 * the tick handler driving autonegotiation.  Don't want 500ms
392 	 * delays all the time while the system is running!
393 	 */
394 	if ((mii->mii_flags & MIIF_DOINGAUTO) == 0) {
395 		mii->mii_flags |= MIIF_DOINGAUTO;
396 		callout_reset(&mii->mii_auto_ch, hz >> 1,
397 				mii_phy_auto_timeout, mii);
398 	}
399 	return (EJUSTRETURN);
400 }
401