xref: /freebsd/sys/dev/mii/xmphy.c (revision 734e82fe33aa764367791a7d603b383996c6b40b)
1 /*-
2  * SPDX-License-Identifier: BSD-4-Clause
3  *
4  * Copyright (c) 2000
5  *	Bill Paul <wpaul@ee.columbia.edu>.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by Bill Paul.
18  * 4. Neither the name of the author nor the names of any co-contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
26  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32  * THE POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #include <sys/cdefs.h>
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 driver_t xmphy_driver = {
73 	"xmphy",
74 	xmphy_methods,
75 	sizeof(struct mii_softc)
76 };
77 
78 DRIVER_MODULE(xmphy, miibus, xmphy_driver, 0, 0);
79 
80 static int	xmphy_service(struct mii_softc *, struct mii_data *, int);
81 static void	xmphy_status(struct mii_softc *);
82 static int	xmphy_mii_phy_auto(struct mii_softc *);
83 
84 static const struct mii_phydesc xmphys[] = {
85 	MII_PHY_DESC(xxJATO, BASEX),
86 	MII_PHY_DESC(xxXAQTI, XMACII),
87 	MII_PHY_END
88 };
89 
90 static const struct mii_phy_funcs xmphy_funcs = {
91 	xmphy_service,
92 	xmphy_status,
93 	mii_phy_reset
94 };
95 
96 static int
97 xmphy_probe(device_t dev)
98 {
99 
100 	return (mii_phy_dev_probe(dev, xmphys, BUS_PROBE_DEFAULT));
101 }
102 
103 static int
104 xmphy_attach(device_t dev)
105 {
106 	struct mii_softc *sc;
107 	const char *sep = "";
108 
109 	sc = device_get_softc(dev);
110 
111 	mii_phy_dev_attach(dev, MIIF_NOISOLATE | MIIF_NOMANPAUSE,
112 	    &xmphy_funcs, 0);
113 	sc->mii_anegticks = MII_ANEGTICKS;
114 
115 	PHY_RESET(sc);
116 
117 #define	ADD(m)		ifmedia_add(&sc->mii_pdata->mii_media, (m), 0, NULL)
118 #define PRINT(s)	printf("%s%s", sep, s); sep = ", "
119 
120 	device_printf(dev, " ");
121 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, 0, sc->mii_inst));
122 	PRINT("1000baseSX");
123 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, IFM_FDX, sc->mii_inst));
124 	PRINT("1000baseSX-FDX");
125 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, sc->mii_inst));
126 	PRINT("auto");
127 
128 	printf("\n");
129 
130 #undef ADD
131 #undef PRINT
132 
133 	MIIBUS_MEDIAINIT(sc->mii_dev);
134 	return (0);
135 }
136 
137 static int
138 xmphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
139 {
140 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
141 	int reg;
142 
143 	switch (cmd) {
144 	case MII_POLLSTAT:
145 		break;
146 
147 	case MII_MEDIACHG:
148 		switch (IFM_SUBTYPE(ife->ifm_media)) {
149 		case IFM_AUTO:
150 #ifdef foo
151 			/*
152 			 * If we're already in auto mode, just return.
153 			 */
154 			if (PHY_READ(sc, XMPHY_MII_BMCR) & XMPHY_BMCR_AUTOEN)
155 				return (0);
156 #endif
157 			(void)xmphy_mii_phy_auto(sc);
158 			break;
159 		case IFM_1000_SX:
160 			PHY_RESET(sc);
161 			if ((ife->ifm_media & IFM_FDX) != 0) {
162 				PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_FDX);
163 				PHY_WRITE(sc, XMPHY_MII_BMCR, XMPHY_BMCR_FDX);
164 			} else {
165 				PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_HDX);
166 				PHY_WRITE(sc, XMPHY_MII_BMCR, 0);
167 			}
168 			break;
169 		default:
170 			return (EINVAL);
171 		}
172 		break;
173 
174 	case MII_TICK:
175 		/*
176 		 * Only used for autonegotiation.
177 		 */
178 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
179 			break;
180 
181 		/*
182 		 * Check to see if we have link.  If we do, we don't
183 		 * need to restart the autonegotiation process.  Read
184 		 * the BMSR twice in case it's latched.
185 		 */
186 		reg = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
187 		if (reg & BMSR_LINK)
188 			break;
189 
190 		/* Only retry autonegotiation every mii_anegticks seconds. */
191 		if (sc->mii_ticks <= sc->mii_anegticks)
192 			break;
193 
194 		sc->mii_ticks = 0;
195 
196 		PHY_RESET(sc);
197 		xmphy_mii_phy_auto(sc);
198 		return (0);
199 	}
200 
201 	/* Update the media status. */
202 	xmphy_status(sc);
203 
204 	/* Callback if something changed. */
205 	mii_phy_update(sc, cmd);
206 	return (0);
207 }
208 
209 static void
210 xmphy_status(struct mii_softc *sc)
211 {
212 	struct mii_data *mii = sc->mii_pdata;
213 	int bmsr, bmcr, anlpar;
214 
215 	mii->mii_media_status = IFM_AVALID;
216 	mii->mii_media_active = IFM_ETHER;
217 
218 	bmsr = PHY_READ(sc, XMPHY_MII_BMSR) |
219 	    PHY_READ(sc, XMPHY_MII_BMSR);
220 	if (bmsr & XMPHY_BMSR_LINK)
221 		mii->mii_media_status |= IFM_ACTIVE;
222 
223 	/* Do dummy read of extended status register. */
224 	bmcr = PHY_READ(sc, XMPHY_MII_EXTSTS);
225 
226 	bmcr = PHY_READ(sc, XMPHY_MII_BMCR);
227 
228 	if (bmcr & XMPHY_BMCR_LOOP)
229 		mii->mii_media_active |= IFM_LOOP;
230 
231 	if (bmcr & XMPHY_BMCR_AUTOEN) {
232 		if ((bmsr & XMPHY_BMSR_ACOMP) == 0) {
233 			if (bmsr & XMPHY_BMSR_LINK) {
234 				mii->mii_media_active |= IFM_1000_SX|IFM_HDX;
235 				return;
236 			}
237 			/* Erg, still trying, I guess... */
238 			mii->mii_media_active |= IFM_NONE;
239 			return;
240 		}
241 
242 		mii->mii_media_active |= IFM_1000_SX;
243 		anlpar = PHY_READ(sc, XMPHY_MII_ANAR) &
244 		    PHY_READ(sc, XMPHY_MII_ANLPAR);
245 		if (anlpar & XMPHY_ANLPAR_FDX)
246 			mii->mii_media_active |= IFM_FDX;
247 		else
248 			mii->mii_media_active |= IFM_HDX;
249 		return;
250 	}
251 
252 	mii->mii_media_active |= IFM_1000_SX;
253 	if (bmcr & XMPHY_BMCR_FDX)
254 		mii->mii_media_active |= IFM_FDX;
255 	else
256 		mii->mii_media_active |= IFM_HDX;
257 }
258 
259 static int
260 xmphy_mii_phy_auto(struct mii_softc *mii)
261 {
262 	int anar = 0;
263 
264 	anar = PHY_READ(mii, XMPHY_MII_ANAR);
265 	anar |= XMPHY_ANAR_FDX|XMPHY_ANAR_HDX;
266 	PHY_WRITE(mii, XMPHY_MII_ANAR, anar);
267 	DELAY(1000);
268 	PHY_WRITE(mii, XMPHY_MII_BMCR,
269 	    XMPHY_BMCR_AUTOEN | XMPHY_BMCR_STARTNEG);
270 
271 	return (EJUSTRETURN);
272 }
273