xref: /freebsd/sys/dev/mii/xmphy.c (revision 93e779a26c651610ac6e7986d67ecc9ed2cadcbf)
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)		ifmedia_add(&sc->mii_pdata->mii_media, (m), 0, 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 	PRINT("1000baseSX");
125 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, IFM_FDX, sc->mii_inst));
126 	PRINT("1000baseSX-FDX");
127 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, sc->mii_inst));
128 	PRINT("auto");
129 
130 	printf("\n");
131 
132 #undef ADD
133 #undef PRINT
134 
135 	MIIBUS_MEDIAINIT(sc->mii_dev);
136 	return (0);
137 }
138 
139 static int
140 xmphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
141 {
142 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
143 	int reg;
144 
145 	switch (cmd) {
146 	case MII_POLLSTAT:
147 		break;
148 
149 	case MII_MEDIACHG:
150 		switch (IFM_SUBTYPE(ife->ifm_media)) {
151 		case IFM_AUTO:
152 #ifdef foo
153 			/*
154 			 * If we're already in auto mode, just return.
155 			 */
156 			if (PHY_READ(sc, XMPHY_MII_BMCR) & XMPHY_BMCR_AUTOEN)
157 				return (0);
158 #endif
159 			(void)xmphy_mii_phy_auto(sc);
160 			break;
161 		case IFM_1000_SX:
162 			PHY_RESET(sc);
163 			if ((ife->ifm_media & IFM_FDX) != 0) {
164 				PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_FDX);
165 				PHY_WRITE(sc, XMPHY_MII_BMCR, XMPHY_BMCR_FDX);
166 			} else {
167 				PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_HDX);
168 				PHY_WRITE(sc, XMPHY_MII_BMCR, 0);
169 			}
170 			break;
171 		default:
172 			return (EINVAL);
173 		}
174 		break;
175 
176 	case MII_TICK:
177 		/*
178 		 * Only used for autonegotiation.
179 		 */
180 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
181 			break;
182 
183 		/*
184 		 * Check to see if we have link.  If we do, we don't
185 		 * need to restart the autonegotiation process.  Read
186 		 * the BMSR twice in case it's latched.
187 		 */
188 		reg = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
189 		if (reg & BMSR_LINK)
190 			break;
191 
192 		/* Only retry autonegotiation every mii_anegticks seconds. */
193 		if (sc->mii_ticks <= sc->mii_anegticks)
194 			break;
195 
196 		sc->mii_ticks = 0;
197 
198 		PHY_RESET(sc);
199 		xmphy_mii_phy_auto(sc);
200 		return (0);
201 	}
202 
203 	/* Update the media status. */
204 	xmphy_status(sc);
205 
206 	/* Callback if something changed. */
207 	mii_phy_update(sc, cmd);
208 	return (0);
209 }
210 
211 static void
212 xmphy_status(struct mii_softc *sc)
213 {
214 	struct mii_data *mii = sc->mii_pdata;
215 	int bmsr, bmcr, anlpar;
216 
217 	mii->mii_media_status = IFM_AVALID;
218 	mii->mii_media_active = IFM_ETHER;
219 
220 	bmsr = PHY_READ(sc, XMPHY_MII_BMSR) |
221 	    PHY_READ(sc, XMPHY_MII_BMSR);
222 	if (bmsr & XMPHY_BMSR_LINK)
223 		mii->mii_media_status |= IFM_ACTIVE;
224 
225 	/* Do dummy read of extended status register. */
226 	bmcr = PHY_READ(sc, XMPHY_MII_EXTSTS);
227 
228 	bmcr = PHY_READ(sc, XMPHY_MII_BMCR);
229 
230 	if (bmcr & XMPHY_BMCR_LOOP)
231 		mii->mii_media_active |= IFM_LOOP;
232 
233 	if (bmcr & XMPHY_BMCR_AUTOEN) {
234 		if ((bmsr & XMPHY_BMSR_ACOMP) == 0) {
235 			if (bmsr & XMPHY_BMSR_LINK) {
236 				mii->mii_media_active |= IFM_1000_SX|IFM_HDX;
237 				return;
238 			}
239 			/* Erg, still trying, I guess... */
240 			mii->mii_media_active |= IFM_NONE;
241 			return;
242 		}
243 
244 		mii->mii_media_active |= IFM_1000_SX;
245 		anlpar = PHY_READ(sc, XMPHY_MII_ANAR) &
246 		    PHY_READ(sc, XMPHY_MII_ANLPAR);
247 		if (anlpar & XMPHY_ANLPAR_FDX)
248 			mii->mii_media_active |= IFM_FDX;
249 		else
250 			mii->mii_media_active |= IFM_HDX;
251 		return;
252 	}
253 
254 	mii->mii_media_active |= IFM_1000_SX;
255 	if (bmcr & XMPHY_BMCR_FDX)
256 		mii->mii_media_active |= IFM_FDX;
257 	else
258 		mii->mii_media_active |= IFM_HDX;
259 }
260 
261 static int
262 xmphy_mii_phy_auto(struct mii_softc *mii)
263 {
264 	int anar = 0;
265 
266 	anar = PHY_READ(mii, XMPHY_MII_ANAR);
267 	anar |= XMPHY_ANAR_FDX|XMPHY_ANAR_HDX;
268 	PHY_WRITE(mii, XMPHY_MII_ANAR, anar);
269 	DELAY(1000);
270 	PHY_WRITE(mii, XMPHY_MII_BMCR,
271 	    XMPHY_BMCR_AUTOEN | XMPHY_BMCR_STARTNEG);
272 
273 	return (EJUSTRETURN);
274 }
275