xref: /freebsd/sys/dev/mii/xmphy.c (revision 7660b554bc59a07be0431c17e0e33815818baa69)
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 
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
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/cdefs.h>
43 __FBSDID("$FreeBSD$");
44 
45 #include <sys/param.h>
46 #include <sys/systm.h>
47 #include <sys/kernel.h>
48 #include <sys/socket.h>
49 #include <sys/bus.h>
50 
51 #include <net/if.h>
52 #include <net/if_media.h>
53 
54 #include <dev/mii/mii.h>
55 #include <dev/mii/miivar.h>
56 #include "miidevs.h"
57 
58 #include <dev/mii/xmphyreg.h>
59 
60 #include "miibus_if.h"
61 
62 static int xmphy_probe(device_t);
63 static int xmphy_attach(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,	mii_phy_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 static int	xmphy_service(struct mii_softc *, struct mii_data *, int);
85 static void	xmphy_status(struct mii_softc *);
86 static int	xmphy_mii_phy_auto(struct mii_softc *);
87 
88 static int
89 xmphy_probe(dev)
90 	device_t		dev;
91 {
92 	struct mii_attach_args *ma;
93 
94 	ma = device_get_ivars(dev);
95 
96 	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxXAQTI &&
97 	    MII_MODEL(ma->mii_id2) == MII_MODEL_XAQTI_XMACII) {
98 		device_set_desc(dev, MII_STR_XAQTI_XMACII);
99 		return(0);
100 	}
101 
102 	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_JATO &&
103 	    MII_MODEL(ma->mii_id2) == MII_MODEL_JATO_BASEX) {
104 		device_set_desc(dev, MII_STR_JATO_BASEX);
105 		return(0);
106 	}
107 
108 	return(ENXIO);
109 }
110 
111 static int
112 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 	sc->mii_dev = device_get_parent(dev);
123 	mii = device_get_softc(sc->mii_dev);
124 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
125 
126 	sc->mii_inst = mii->mii_instance;
127 	sc->mii_phy = ma->mii_phyno;
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
164 xmphy_service(sc, mii, cmd)
165 	struct mii_softc *sc;
166 	struct mii_data *mii;
167 	int cmd;
168 {
169 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
170 	int reg;
171 
172 	switch (cmd) {
173 	case MII_POLLSTAT:
174 		/*
175 		 * If we're not polling our PHY instance, just return.
176 		 */
177 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
178 			return (0);
179 		break;
180 
181 	case MII_MEDIACHG:
182 		/*
183 		 * If the media indicates a different PHY instance,
184 		 * isolate ourselves.
185 		 */
186 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
187 			reg = PHY_READ(sc, MII_BMCR);
188 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
189 			return (0);
190 		}
191 
192 		/*
193 		 * If the interface is not up, don't do anything.
194 		 */
195 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
196 			break;
197 
198 		switch (IFM_SUBTYPE(ife->ifm_media)) {
199 		case IFM_AUTO:
200 #ifdef foo
201 			/*
202 			 * If we're already in auto mode, just return.
203 			 */
204 			if (PHY_READ(sc, XMPHY_MII_BMCR) & XMPHY_BMCR_AUTOEN)
205 				return (0);
206 #endif
207 			(void) xmphy_mii_phy_auto(sc);
208 			break;
209 		case IFM_1000_SX:
210 			mii_phy_reset(sc);
211 			if ((ife->ifm_media & IFM_GMASK) == IFM_FDX) {
212 				PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_FDX);
213 				PHY_WRITE(sc, XMPHY_MII_BMCR, XMPHY_BMCR_FDX);
214 			} else {
215 				PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_HDX);
216 				PHY_WRITE(sc, XMPHY_MII_BMCR, 0);
217 			}
218 			break;
219 		case IFM_100_T4:
220 		case IFM_100_TX:
221 		case IFM_10_T:
222 		default:
223 			return (EINVAL);
224 		}
225 		break;
226 
227 	case MII_TICK:
228 		/*
229 		 * If we're not currently selected, just return.
230 		 */
231 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
232 			return (0);
233 
234 		/*
235 		 * Is the interface even up?
236 		 */
237 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
238 			return (0);
239 
240 		/*
241 		 * Only used for autonegotiation.
242 		 */
243 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
244 			break;
245 
246 		/*
247 		 * Check to see if we have link.  If we do, we don't
248 		 * need to restart the autonegotiation process.  Read
249 		 * the BMSR twice in case it's latched.
250 		 */
251 		reg = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
252 		if (reg & BMSR_LINK)
253 			break;
254 
255 		/*
256 		 * Only retry autonegotiation every 5 seconds.
257 		 */
258 		if (++sc->mii_ticks != 5)
259 			return (0);
260 
261 		sc->mii_ticks = 0;
262 
263 		mii_phy_reset(sc);
264 		xmphy_mii_phy_auto(sc);
265 		return(0);
266 	}
267 
268 	/* Update the media status. */
269 	xmphy_status(sc);
270 
271 	/* Callback if something changed. */
272 	mii_phy_update(sc, cmd);
273 	return (0);
274 }
275 
276 static void
277 xmphy_status(sc)
278 	struct mii_softc *sc;
279 {
280 	struct mii_data *mii = sc->mii_pdata;
281 	int bmsr, bmcr, anlpar;
282 
283 	mii->mii_media_status = IFM_AVALID;
284 	mii->mii_media_active = IFM_ETHER;
285 
286 	bmsr = PHY_READ(sc, XMPHY_MII_BMSR) |
287 	    PHY_READ(sc, XMPHY_MII_BMSR);
288 	if (bmsr & XMPHY_BMSR_LINK)
289 		mii->mii_media_status |= IFM_ACTIVE;
290 
291 	/* Do dummy read of extended status register. */
292 	bmcr = PHY_READ(sc, XMPHY_MII_EXTSTS);
293 
294 	bmcr = PHY_READ(sc, XMPHY_MII_BMCR);
295 
296 	if (bmcr & XMPHY_BMCR_LOOP)
297 		mii->mii_media_active |= IFM_LOOP;
298 
299 
300 	if (bmcr & XMPHY_BMCR_AUTOEN) {
301 		if ((bmsr & XMPHY_BMSR_ACOMP) == 0) {
302 			if (bmsr & XMPHY_BMSR_LINK) {
303 				mii->mii_media_active |= IFM_1000_SX|IFM_HDX;
304 				return;
305 			}
306 			/* Erg, still trying, I guess... */
307 			mii->mii_media_active |= IFM_NONE;
308 			return;
309 		}
310 
311 		mii->mii_media_active |= IFM_1000_SX;
312 		anlpar = PHY_READ(sc, XMPHY_MII_ANAR) &
313 		    PHY_READ(sc, XMPHY_MII_ANLPAR);
314 		if (anlpar & XMPHY_ANLPAR_FDX)
315 			mii->mii_media_active |= IFM_FDX;
316 		else
317 			mii->mii_media_active |= IFM_HDX;
318 		return;
319 	}
320 
321 	mii->mii_media_active |= IFM_1000_SX;
322 	if (bmcr & XMPHY_BMCR_FDX)
323 		mii->mii_media_active |= IFM_FDX;
324 	else
325 		mii->mii_media_active |= IFM_HDX;
326 
327 	return;
328 }
329 
330 
331 static int
332 xmphy_mii_phy_auto(mii)
333 	struct mii_softc *mii;
334 {
335 	int anar = 0;
336 
337 	anar = PHY_READ(mii, XMPHY_MII_ANAR);
338 	anar |= XMPHY_ANAR_FDX|XMPHY_ANAR_HDX;
339 	PHY_WRITE(mii, XMPHY_MII_ANAR, anar);
340 	DELAY(1000);
341 	PHY_WRITE(mii, XMPHY_MII_BMCR,
342 	    XMPHY_BMCR_AUTOEN | XMPHY_BMCR_STARTNEG);
343 
344 	return (EJUSTRETURN);
345 }
346