xref: /freebsd/sys/dev/mii/xmphy.c (revision c6ec7d31830ab1c80edae95ad5e4b9dba10c47ac)
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/param.h>
43 #include <sys/systm.h>
44 #include <sys/kernel.h>
45 #include <sys/module.h>
46 #include <sys/socket.h>
47 #include <sys/bus.h>
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 "miidevs.h"
55 
56 #include <dev/mii/xmphyreg.h>
57 
58 #include "miibus_if.h"
59 
60 static int xmphy_probe(device_t);
61 static int xmphy_attach(device_t);
62 
63 static device_method_t xmphy_methods[] = {
64 	/* device interface */
65 	DEVMETHOD(device_probe,		xmphy_probe),
66 	DEVMETHOD(device_attach,	xmphy_attach),
67 	DEVMETHOD(device_detach,	mii_phy_detach),
68 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
69 	DEVMETHOD_END
70 };
71 
72 static devclass_t xmphy_devclass;
73 
74 static driver_t xmphy_driver = {
75 	"xmphy",
76 	xmphy_methods,
77 	sizeof(struct mii_softc)
78 };
79 
80 DRIVER_MODULE(xmphy, miibus, xmphy_driver, xmphy_devclass, 0, 0);
81 
82 static int	xmphy_service(struct mii_softc *, struct mii_data *, int);
83 static void	xmphy_status(struct mii_softc *);
84 static int	xmphy_mii_phy_auto(struct mii_softc *);
85 
86 static const struct mii_phydesc xmphys[] = {
87 	MII_PHY_DESC(xxJATO, BASEX),
88 	MII_PHY_DESC(xxXAQTI, XMACII),
89 	MII_PHY_END
90 };
91 
92 static const struct mii_phy_funcs xmphy_funcs = {
93 	xmphy_service,
94 	xmphy_status,
95 	mii_phy_reset
96 };
97 
98 static int
99 xmphy_probe(device_t dev)
100 {
101 
102 	return (mii_phy_dev_probe(dev, xmphys, BUS_PROBE_DEFAULT));
103 }
104 
105 static int
106 xmphy_attach(device_t dev)
107 {
108 	struct mii_softc *sc;
109 	const char *sep = "";
110 
111 	sc = device_get_softc(dev);
112 
113 	mii_phy_dev_attach(dev, MIIF_NOISOLATE | MIIF_NOMANPAUSE,
114 	    &xmphy_funcs, 0);
115 	sc->mii_anegticks = MII_ANEGTICKS;
116 
117 	PHY_RESET(sc);
118 
119 #define	ADD(m, c)	ifmedia_add(&sc->mii_pdata->mii_media, (m), (c), NULL)
120 #define PRINT(s)	printf("%s%s", sep, s); sep = ", "
121 
122 	device_printf(dev, " ");
123 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, 0, sc->mii_inst),
124 	    XMPHY_BMCR_FDX);
125 	PRINT("1000baseSX");
126 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, IFM_FDX, sc->mii_inst), 0);
127 	PRINT("1000baseSX-FDX");
128 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, sc->mii_inst), 0);
129 	PRINT("auto");
130 
131 	printf("\n");
132 
133 #undef ADD
134 #undef PRINT
135 
136 	MIIBUS_MEDIAINIT(sc->mii_dev);
137 	return (0);
138 }
139 
140 static int
141 xmphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
142 {
143 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
144 	int reg;
145 
146 	switch (cmd) {
147 	case MII_POLLSTAT:
148 		break;
149 
150 	case MII_MEDIACHG:
151 		/*
152 		 * If the interface is not up, don't do anything.
153 		 */
154 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
155 			break;
156 
157 		switch (IFM_SUBTYPE(ife->ifm_media)) {
158 		case IFM_AUTO:
159 #ifdef foo
160 			/*
161 			 * If we're already in auto mode, just return.
162 			 */
163 			if (PHY_READ(sc, XMPHY_MII_BMCR) & XMPHY_BMCR_AUTOEN)
164 				return (0);
165 #endif
166 			(void)xmphy_mii_phy_auto(sc);
167 			break;
168 		case IFM_1000_SX:
169 			PHY_RESET(sc);
170 			if ((ife->ifm_media & IFM_FDX) != 0) {
171 				PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_FDX);
172 				PHY_WRITE(sc, XMPHY_MII_BMCR, XMPHY_BMCR_FDX);
173 			} else {
174 				PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_HDX);
175 				PHY_WRITE(sc, XMPHY_MII_BMCR, 0);
176 			}
177 			break;
178 		default:
179 			return (EINVAL);
180 		}
181 		break;
182 
183 	case MII_TICK:
184 		/*
185 		 * Is the interface even up?
186 		 */
187 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
188 			return (0);
189 
190 		/*
191 		 * Only used for autonegotiation.
192 		 */
193 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
194 			break;
195 
196 		/*
197 		 * Check to see if we have link.  If we do, we don't
198 		 * need to restart the autonegotiation process.  Read
199 		 * the BMSR twice in case it's latched.
200 		 */
201 		reg = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
202 		if (reg & BMSR_LINK)
203 			break;
204 
205 		/* Only retry autonegotiation every mii_anegticks seconds. */
206 		if (sc->mii_ticks <= sc->mii_anegticks)
207 			break;
208 
209 		sc->mii_ticks = 0;
210 
211 		PHY_RESET(sc);
212 		xmphy_mii_phy_auto(sc);
213 		return (0);
214 	}
215 
216 	/* Update the media status. */
217 	xmphy_status(sc);
218 
219 	/* Callback if something changed. */
220 	mii_phy_update(sc, cmd);
221 	return (0);
222 }
223 
224 static void
225 xmphy_status(struct mii_softc *sc)
226 {
227 	struct mii_data *mii = sc->mii_pdata;
228 	int bmsr, bmcr, anlpar;
229 
230 	mii->mii_media_status = IFM_AVALID;
231 	mii->mii_media_active = IFM_ETHER;
232 
233 	bmsr = PHY_READ(sc, XMPHY_MII_BMSR) |
234 	    PHY_READ(sc, XMPHY_MII_BMSR);
235 	if (bmsr & XMPHY_BMSR_LINK)
236 		mii->mii_media_status |= IFM_ACTIVE;
237 
238 	/* Do dummy read of extended status register. */
239 	bmcr = PHY_READ(sc, XMPHY_MII_EXTSTS);
240 
241 	bmcr = PHY_READ(sc, XMPHY_MII_BMCR);
242 
243 	if (bmcr & XMPHY_BMCR_LOOP)
244 		mii->mii_media_active |= IFM_LOOP;
245 
246 	if (bmcr & XMPHY_BMCR_AUTOEN) {
247 		if ((bmsr & XMPHY_BMSR_ACOMP) == 0) {
248 			if (bmsr & XMPHY_BMSR_LINK) {
249 				mii->mii_media_active |= IFM_1000_SX|IFM_HDX;
250 				return;
251 			}
252 			/* Erg, still trying, I guess... */
253 			mii->mii_media_active |= IFM_NONE;
254 			return;
255 		}
256 
257 		mii->mii_media_active |= IFM_1000_SX;
258 		anlpar = PHY_READ(sc, XMPHY_MII_ANAR) &
259 		    PHY_READ(sc, XMPHY_MII_ANLPAR);
260 		if (anlpar & XMPHY_ANLPAR_FDX)
261 			mii->mii_media_active |= IFM_FDX;
262 		else
263 			mii->mii_media_active |= IFM_HDX;
264 		return;
265 	}
266 
267 	mii->mii_media_active |= IFM_1000_SX;
268 	if (bmcr & XMPHY_BMCR_FDX)
269 		mii->mii_media_active |= IFM_FDX;
270 	else
271 		mii->mii_media_active |= IFM_HDX;
272 }
273 
274 static int
275 xmphy_mii_phy_auto(struct mii_softc *mii)
276 {
277 	int anar = 0;
278 
279 	anar = PHY_READ(mii, XMPHY_MII_ANAR);
280 	anar |= XMPHY_ANAR_FDX|XMPHY_ANAR_HDX;
281 	PHY_WRITE(mii, XMPHY_MII_ANAR, anar);
282 	DELAY(1000);
283 	PHY_WRITE(mii, XMPHY_MII_BMCR,
284 	    XMPHY_BMCR_AUTOEN | XMPHY_BMCR_STARTNEG);
285 
286 	return (EJUSTRETURN);
287 }
288