xref: /freebsd/sys/dev/mii/xmphy.c (revision a3e8fd0b7f663db7eafff527d5c3ca3bcfa8a537)
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(device_t);
66 static int xmphy_attach(device_t);
67 
68 static device_method_t xmphy_methods[] = {
69 	/* device interface */
70 	DEVMETHOD(device_probe,		xmphy_probe),
71 	DEVMETHOD(device_attach,	xmphy_attach),
72 	DEVMETHOD(device_detach,	mii_phy_detach),
73 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
74 	{ 0, 0 }
75 };
76 
77 static devclass_t xmphy_devclass;
78 
79 static driver_t xmphy_driver = {
80 	"xmphy",
81 	xmphy_methods,
82 	sizeof(struct mii_softc)
83 };
84 
85 DRIVER_MODULE(xmphy, miibus, xmphy_driver, xmphy_devclass, 0, 0);
86 
87 static int	xmphy_service(struct mii_softc *, struct mii_data *, int);
88 static void	xmphy_status(struct mii_softc *);
89 static int	xmphy_mii_phy_auto(struct mii_softc *);
90 
91 static int
92 xmphy_probe(dev)
93 	device_t		dev;
94 {
95 	struct mii_attach_args *ma;
96 
97 	ma = device_get_ivars(dev);
98 
99 	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxXAQTI &&
100 	    MII_MODEL(ma->mii_id2) == MII_MODEL_XAQTI_XMACII) {
101 		device_set_desc(dev, MII_STR_XAQTI_XMACII);
102 		return(0);
103 	}
104 
105 	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_JATO &&
106 	    MII_MODEL(ma->mii_id2) == MII_MODEL_JATO_BASEX) {
107 		device_set_desc(dev, MII_STR_JATO_BASEX);
108 		return(0);
109 	}
110 
111 	return(ENXIO);
112 }
113 
114 static int
115 xmphy_attach(dev)
116 	device_t		dev;
117 {
118 	struct mii_softc *sc;
119 	struct mii_attach_args *ma;
120 	struct mii_data *mii;
121 	const char *sep = "";
122 
123 	sc = device_get_softc(dev);
124 	ma = device_get_ivars(dev);
125 	sc->mii_dev = device_get_parent(dev);
126 	mii = device_get_softc(sc->mii_dev);
127 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
128 
129 	sc->mii_inst = mii->mii_instance;
130 	sc->mii_phy = ma->mii_phyno;
131 	sc->mii_service = xmphy_service;
132 	sc->mii_pdata = mii;
133 
134 	sc->mii_flags |= MIIF_NOISOLATE;
135 	mii->mii_instance++;
136 
137 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
138 #define PRINT(s)	printf("%s%s", sep, s); sep = ", "
139 
140 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
141 	    BMCR_ISO);
142 #if 0
143 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
144 	    BMCR_LOOP|BMCR_S100);
145 #endif
146 
147 	mii_phy_reset(sc);
148 
149 	device_printf(dev, " ");
150 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, 0, sc->mii_inst),
151 	    XMPHY_BMCR_FDX);
152 	PRINT("1000baseSX");
153 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, IFM_FDX, sc->mii_inst), 0);
154 	PRINT("1000baseSX-FDX");
155 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, sc->mii_inst), 0);
156 	PRINT("auto");
157 
158 	printf("\n");
159 #undef ADD
160 #undef PRINT
161 
162 	MIIBUS_MEDIAINIT(sc->mii_dev);
163 	return(0);
164 }
165 
166 static int
167 xmphy_service(sc, mii, cmd)
168 	struct mii_softc *sc;
169 	struct mii_data *mii;
170 	int cmd;
171 {
172 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
173 	int reg;
174 
175 	switch (cmd) {
176 	case MII_POLLSTAT:
177 		/*
178 		 * If we're not polling our PHY instance, just return.
179 		 */
180 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
181 			return (0);
182 		break;
183 
184 	case MII_MEDIACHG:
185 		/*
186 		 * If the media indicates a different PHY instance,
187 		 * isolate ourselves.
188 		 */
189 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
190 			reg = PHY_READ(sc, MII_BMCR);
191 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
192 			return (0);
193 		}
194 
195 		/*
196 		 * If the interface is not up, don't do anything.
197 		 */
198 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
199 			break;
200 
201 		switch (IFM_SUBTYPE(ife->ifm_media)) {
202 		case IFM_AUTO:
203 #ifdef foo
204 			/*
205 			 * If we're already in auto mode, just return.
206 			 */
207 			if (PHY_READ(sc, XMPHY_MII_BMCR) & XMPHY_BMCR_AUTOEN)
208 				return (0);
209 #endif
210 			(void) xmphy_mii_phy_auto(sc);
211 			break;
212 		case IFM_1000_SX:
213 			mii_phy_reset(sc);
214 			if ((ife->ifm_media & IFM_GMASK) == IFM_FDX) {
215 				PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_FDX);
216 				PHY_WRITE(sc, XMPHY_MII_BMCR, XMPHY_BMCR_FDX);
217 			} else {
218 				PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_HDX);
219 				PHY_WRITE(sc, XMPHY_MII_BMCR, 0);
220 			}
221 			break;
222 		case IFM_100_T4:
223 		case IFM_100_TX:
224 		case IFM_10_T:
225 		default:
226 			return (EINVAL);
227 		}
228 		break;
229 
230 	case MII_TICK:
231 		/*
232 		 * If we're not currently selected, just return.
233 		 */
234 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
235 			return (0);
236 
237 		/*
238 		 * Is the interface even up?
239 		 */
240 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
241 			return (0);
242 
243 		/*
244 		 * Only used for autonegotiation.
245 		 */
246 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
247 			break;
248 
249 		/*
250 		 * Check to see if we have link.  If we do, we don't
251 		 * need to restart the autonegotiation process.  Read
252 		 * the BMSR twice in case it's latched.
253 		 */
254 		reg = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
255 		if (reg & BMSR_LINK)
256 			break;
257 
258 		/*
259 		 * Only retry autonegotiation every 5 seconds.
260 		 */
261 		if (++sc->mii_ticks != 5)
262 			return (0);
263 
264 		sc->mii_ticks = 0;
265 
266 		mii_phy_reset(sc);
267 		xmphy_mii_phy_auto(sc);
268 		return(0);
269 	}
270 
271 	/* Update the media status. */
272 	xmphy_status(sc);
273 
274 	/* Callback if something changed. */
275 	mii_phy_update(sc, cmd);
276 	return (0);
277 }
278 
279 static void
280 xmphy_status(sc)
281 	struct mii_softc *sc;
282 {
283 	struct mii_data *mii = sc->mii_pdata;
284 	int bmsr, bmcr, anlpar;
285 
286 	mii->mii_media_status = IFM_AVALID;
287 	mii->mii_media_active = IFM_ETHER;
288 
289 	bmsr = PHY_READ(sc, XMPHY_MII_BMSR) |
290 	    PHY_READ(sc, XMPHY_MII_BMSR);
291 	if (bmsr & XMPHY_BMSR_LINK)
292 		mii->mii_media_status |= IFM_ACTIVE;
293 
294 	/* Do dummy read of extended status register. */
295 	bmcr = PHY_READ(sc, XMPHY_MII_EXTSTS);
296 
297 	bmcr = PHY_READ(sc, XMPHY_MII_BMCR);
298 
299 	if (bmcr & XMPHY_BMCR_LOOP)
300 		mii->mii_media_active |= IFM_LOOP;
301 
302 
303 	if (bmcr & XMPHY_BMCR_AUTOEN) {
304 		if ((bmsr & XMPHY_BMSR_ACOMP) == 0) {
305 			if (bmsr & XMPHY_BMSR_LINK) {
306 				mii->mii_media_active |= IFM_1000_SX|IFM_HDX;
307 				return;
308 			}
309 			/* Erg, still trying, I guess... */
310 			mii->mii_media_active |= IFM_NONE;
311 			return;
312 		}
313 
314 		mii->mii_media_active |= IFM_1000_SX;
315 		anlpar = PHY_READ(sc, XMPHY_MII_ANAR) &
316 		    PHY_READ(sc, XMPHY_MII_ANLPAR);
317 		if (anlpar & XMPHY_ANLPAR_FDX)
318 			mii->mii_media_active |= IFM_FDX;
319 		else
320 			mii->mii_media_active |= IFM_HDX;
321 		return;
322 	}
323 
324 	mii->mii_media_active |= IFM_1000_SX;
325 	if (bmcr & XMPHY_BMCR_FDX)
326 		mii->mii_media_active |= IFM_FDX;
327 	else
328 		mii->mii_media_active |= IFM_HDX;
329 
330 	return;
331 }
332 
333 
334 static int
335 xmphy_mii_phy_auto(mii)
336 	struct mii_softc *mii;
337 {
338 	int anar = 0;
339 
340 	anar = PHY_READ(mii, XMPHY_MII_ANAR);
341 	anar |= XMPHY_ANAR_FDX|XMPHY_ANAR_HDX;
342 	PHY_WRITE(mii, XMPHY_MII_ANAR, anar);
343 	DELAY(1000);
344 	PHY_WRITE(mii, XMPHY_MII_BMCR,
345 	    XMPHY_BMCR_AUTOEN | XMPHY_BMCR_STARTNEG);
346 
347 	return (EJUSTRETURN);
348 }
349