xref: /openbsd/sys/dev/mii/xmphy.c (revision cecf84d4)
1 /*	$OpenBSD: xmphy.c,v 1.22 2015/03/14 03:38:48 jsg Exp $	*/
2 
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  * $FreeBSD: src/sys/dev/mii/xmphy.c,v 1.1 2000/04/22 01:58:18 wpaul Exp $
35  */
36 
37 /*
38  * driver for the XaQti XMAC II's internal PHY. This is sort of
39  * like a 10/100 PHY, except the only thing we're really autoselecting
40  * here is full/half duplex. Speed is always 1000mbps.
41  */
42 
43 #include <sys/param.h>
44 #include <sys/systm.h>
45 #include <sys/device.h>
46 #include <sys/socket.h>
47 #include <sys/errno.h>
48 
49 #include <net/if.h>
50 #include <net/if_var.h>
51 #include <net/if_media.h>
52 
53 #include <dev/mii/mii.h>
54 #include <dev/mii/miivar.h>
55 #include <dev/mii/miidevs.h>
56 
57 #include <dev/mii/xmphyreg.h>
58 
59 int xmphy_probe(struct device *, void *, void *);
60 void xmphy_attach(struct device *, struct device *, void *);
61 
62 struct cfattach xmphy_ca = {
63 	sizeof(struct mii_softc), xmphy_probe, xmphy_attach, mii_phy_detach
64 };
65 
66 struct cfdriver xmphy_cd = {
67 	NULL, "xmphy", DV_DULL
68 };
69 
70 int	xmphy_service(struct mii_softc *, struct mii_data *, int);
71 void	xmphy_status(struct mii_softc *);
72 
73 int	xmphy_mii_phy_auto(struct mii_softc *);
74 
75 const struct mii_phy_funcs xmphy_funcs = {
76 	xmphy_service, xmphy_status, mii_phy_reset,
77 };
78 
79 static const struct mii_phydesc xmphys[] = {
80 	{ MII_OUI_xxXAQTI,	MII_MODEL_XAQTI_XMACII,
81 	  MII_STR_XAQTI_XMACII },
82 
83 	{ MII_OUI_JATO,		MII_MODEL_JATO_BASEX,
84 	  MII_STR_JATO_BASEX },
85 
86 	{ 0,			0,
87 	  NULL },
88 };
89 
90 int xmphy_probe(struct device *parent, void *match, void *aux)
91 {
92 	struct mii_attach_args *ma = aux;
93 
94 	if (mii_phy_match(ma, xmphys) != NULL)
95 		return (10);
96 
97 	return (0);
98 }
99 
100 void
101 xmphy_attach(struct device *parent, struct device *self, void *aux)
102 {
103 	struct mii_softc *sc = (struct mii_softc *)self;
104 	struct mii_attach_args *ma = aux;
105 	struct mii_data *mii = ma->mii_data;
106 	const struct mii_phydesc *mpd;
107 
108 	mpd = mii_phy_match(ma, xmphys);
109 	printf(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
110 
111 	sc->mii_inst = mii->mii_instance;
112 	sc->mii_phy = ma->mii_phyno;
113 	sc->mii_funcs = &xmphy_funcs;
114 	sc->mii_pdata = mii;
115 	sc->mii_flags = ma->mii_flags;
116 	sc->mii_anegticks = MII_ANEGTICKS;
117 
118 	sc->mii_flags |= MIIF_NOISOLATE;
119 
120 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
121 
122 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
123 	    BMCR_ISO);
124 
125 	PHY_RESET(sc);
126 
127 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, 0, sc->mii_inst),
128 	    XMPHY_BMCR_FDX);
129 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, IFM_FDX, sc->mii_inst), 0);
130 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, sc->mii_inst), 0);
131 
132 #undef ADD
133 }
134 
135 int
136 xmphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
137 {
138 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
139 	int reg;
140 
141 	if ((sc->mii_dev.dv_flags & DVF_ACTIVE) == 0)
142 		return (ENXIO);
143 
144 	switch (cmd) {
145 	case MII_POLLSTAT:
146 		/*
147 		 * If we're not polling our PHY instance, just return.
148 		 */
149 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
150 			return (0);
151 		break;
152 
153 	case MII_MEDIACHG:
154 		/*
155 		 * If the media indicates a different PHY instance,
156 		 * isolate ourselves.
157 		 */
158 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
159 			reg = PHY_READ(sc, MII_BMCR);
160 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
161 			return (0);
162 		}
163 
164 		/*
165 		 * If the interface is not up, don't do anything.
166 		 */
167 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
168 			break;
169 
170 		switch (IFM_SUBTYPE(ife->ifm_media)) {
171 		case IFM_AUTO:
172 			(void) xmphy_mii_phy_auto(sc);
173 			break;
174 		case IFM_1000_SX:
175 			PHY_RESET(sc);
176 			if ((ife->ifm_media & IFM_GMASK) == IFM_FDX) {
177 				PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_FDX);
178 				PHY_WRITE(sc, XMPHY_MII_BMCR, XMPHY_BMCR_FDX);
179 			} else {
180 				PHY_WRITE(sc, XMPHY_MII_ANAR, XMPHY_ANAR_HDX);
181 				PHY_WRITE(sc, XMPHY_MII_BMCR, 0);
182 			}
183 			break;
184 		default:
185 			return (EINVAL);
186 		}
187 		break;
188 
189 	case MII_TICK:
190 		/*
191 		 * If we're not currently selected, just return.
192 		 */
193 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
194 			return (0);
195 
196 		/*
197 		 * Is the interface even up?
198 		 */
199 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
200 			return (0);
201 
202 		/*
203 		 * Only used for autonegotiation.
204 		 */
205 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
206 			break;
207 
208                 /*
209                  * Check to see if we have link.  If we do, we don't
210                  * need to restart the autonegotiation process.  Read
211                  * the BMSR twice in case it's latched.
212                  */
213 		reg = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
214 		if (reg & BMSR_LINK) {
215 			sc->mii_ticks = 0;
216 			break;
217 		}
218 
219 		/*
220 		 * Only retry autonegotiation every mii_anegticks seconds.
221 		 */
222 		if (++sc->mii_ticks <= sc->mii_anegticks)
223 			break;
224 
225 		sc->mii_ticks = 0;
226 		PHY_RESET(sc);
227 
228 		xmphy_mii_phy_auto(sc);
229 		break;
230 	}
231 
232 	/* Update the media status. */
233 	mii_phy_status(sc);
234 
235 	/* Callback if something changed. */
236 	mii_phy_update(sc, cmd);
237 	return (0);
238 }
239 
240 void
241 xmphy_status(struct mii_softc *sc)
242 {
243 	struct mii_data *mii = sc->mii_pdata;
244 	int bmsr, bmcr, anlpar;
245 
246 	mii->mii_media_status = IFM_AVALID;
247 	mii->mii_media_active = IFM_ETHER;
248 
249 	bmsr = PHY_READ(sc, XMPHY_MII_BMSR) |
250 	    PHY_READ(sc, XMPHY_MII_BMSR);
251 	if (bmsr & XMPHY_BMSR_LINK)
252 		mii->mii_media_status |= IFM_ACTIVE;
253 
254 	/* Do dummy read of extended status register. */
255 	bmcr = PHY_READ(sc, XMPHY_MII_EXTSTS);
256 
257 	bmcr = PHY_READ(sc, XMPHY_MII_BMCR);
258 
259 	if (bmcr & XMPHY_BMCR_LOOP)
260 		mii->mii_media_active |= IFM_LOOP;
261 
262 
263 	if (bmcr & XMPHY_BMCR_AUTOEN) {
264 		if ((bmsr & XMPHY_BMSR_ACOMP) == 0) {
265 			if (bmsr & XMPHY_BMSR_LINK) {
266 				mii->mii_media_active |= IFM_1000_SX|IFM_HDX;
267 				return;
268 			}
269 			/* Erg, still trying, I guess... */
270 			mii->mii_media_active |= IFM_NONE;
271 			return;
272 		}
273 
274 		mii->mii_media_active |= IFM_1000_SX;
275 		anlpar = PHY_READ(sc, XMPHY_MII_ANAR) &
276 		    PHY_READ(sc, XMPHY_MII_ANLPAR);
277 		if (anlpar & XMPHY_ANLPAR_FDX)
278 			mii->mii_media_active |= IFM_FDX;
279 		else
280 			mii->mii_media_active |= IFM_HDX;
281 		return;
282 	}
283 
284 	mii->mii_media_active |= IFM_1000_SX;
285 	if (bmcr & XMPHY_BMCR_FDX)
286 		mii->mii_media_active |= IFM_FDX;
287 	else
288 		mii->mii_media_active |= IFM_HDX;
289 
290 	return;
291 }
292 
293 
294 int
295 xmphy_mii_phy_auto(struct mii_softc *sc)
296 {
297 	int anar = 0;
298 
299 	anar = PHY_READ(sc, XMPHY_MII_ANAR);
300 	anar |= XMPHY_ANAR_FDX|XMPHY_ANAR_HDX;
301 	PHY_WRITE(sc, XMPHY_MII_ANAR, anar);
302 	DELAY(1000);
303 	PHY_WRITE(sc, XMPHY_MII_BMCR,
304 	    XMPHY_BMCR_AUTOEN | XMPHY_BMCR_STARTNEG);
305 
306 	return (EJUSTRETURN);
307 }
308