xref: /netbsd-src/sys/dev/mii/sqphy.c (revision 7a9a30c5e763bb556f73924ae04973e33cc385da)
1 /*	$NetBSD: sqphy.c,v 1.56 2020/03/15 23:04:50 thorpej Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998, 1999, 2000, 2001 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9  * NASA Ames Research Center.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
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 THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*
34  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  * 1. Redistributions of source code must retain the above copyright
40  *    notice, this list of conditions and the following disclaimer.
41  * 2. Redistributions in binary form must reproduce the above copyright
42  *    notice, this list of conditions and the following disclaimer in the
43  *    documentation and/or other materials provided with the distribution.
44  *
45  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
46  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
47  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
48  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
49  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
50  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
51  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
52  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
53  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
54  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
55  */
56 
57 /*
58  * driver for Seeq 80220/80221, 80223, and 80225 10/100 ethernet PHYs
59  * datasheet from www.seeq.com
60  */
61 
62 #include <sys/cdefs.h>
63 __KERNEL_RCSID(0, "$NetBSD: sqphy.c,v 1.56 2020/03/15 23:04:50 thorpej Exp $");
64 
65 #include <sys/param.h>
66 #include <sys/systm.h>
67 #include <sys/kernel.h>
68 #include <sys/device.h>
69 #include <sys/socket.h>
70 #include <sys/errno.h>
71 
72 #include <net/if.h>
73 #include <net/if_media.h>
74 
75 #include <dev/mii/mii.h>
76 #include <dev/mii/miivar.h>
77 #include <dev/mii/miidevs.h>
78 
79 #include <dev/mii/sqphyreg.h>
80 
81 static int	sqphymatch(device_t, cfdata_t, void *);
82 static void	sqphyattach(device_t, device_t, void *);
83 
84 CFATTACH_DECL_NEW(sqphy, sizeof(struct mii_softc),
85     sqphymatch, sqphyattach, mii_phy_detach, mii_phy_activate);
86 
87 static int	sqphy_service(struct mii_softc *, struct mii_data *, int);
88 static void	sqphy_status(struct mii_softc *);
89 static void	sqphy_84220_reset(struct mii_softc *);
90 
91 static const struct mii_phy_funcs sqphy_funcs = {
92 	sqphy_service, sqphy_status, mii_phy_reset,
93 };
94 
95 static const struct mii_phy_funcs sqphy_84220_funcs = {
96 	sqphy_service, sqphy_status, sqphy_84220_reset,
97 };
98 
99 static const struct mii_phydesc sqphys[] = {
100 	MII_PHY_DESC(SEEQ, 80220),
101 	MII_PHY_DESC(SEEQ, 80225),
102 	MII_PHY_DESC(SEEQ, 84220),
103 	MII_PHY_END,
104 };
105 
106 static int
sqphymatch(device_t parent,cfdata_t match,void * aux)107 sqphymatch(device_t parent, cfdata_t match, void *aux)
108 {
109 	struct mii_attach_args *ma = aux;
110 
111 	if (mii_phy_match(ma, sqphys) != NULL)
112 		return 10;
113 
114 	return 0;
115 }
116 
117 static void
sqphyattach(device_t parent,device_t self,void * aux)118 sqphyattach(device_t parent, device_t self, void *aux)
119 {
120 	struct mii_softc *sc = device_private(self);
121 	struct mii_attach_args *ma = aux;
122 	struct mii_data *mii = ma->mii_data;
123 	const struct mii_phydesc *mpd;
124 
125 	mpd = mii_phy_match(ma, sqphys);
126 	aprint_naive(": Media interface\n");
127 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
128 
129 	sc->mii_dev = self;
130 	sc->mii_inst = mii->mii_instance;
131 	sc->mii_phy = ma->mii_phyno;
132 	sc->mii_pdata = mii;
133 	sc->mii_flags = ma->mii_flags;
134 
135 	switch (MII_MODEL(ma->mii_id2)) {
136 	case MII_MODEL_SEEQ_84220:
137 		sc->mii_funcs = &sqphy_84220_funcs;
138 		aprint_normal_dev(self,
139 		    "using Seeq 84220 isolate/reset hack\n");
140 		break;
141 
142 	default:
143 		sc->mii_funcs = &sqphy_funcs;
144 	}
145 
146 	mii_lock(mii);
147 
148 	PHY_RESET(sc);
149 
150 	PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
151 	sc->mii_capabilities &= ma->mii_capmask;
152 
153 	mii_unlock(mii);
154 
155 	mii_phy_add_media(sc);
156 }
157 
158 static int
sqphy_service(struct mii_softc * sc,struct mii_data * mii,int cmd)159 sqphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
160 {
161 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
162 	uint16_t reg;
163 
164 	KASSERT(mii_locked(mii));
165 
166 	switch (cmd) {
167 	case MII_POLLSTAT:
168 		/* If we're not polling our PHY instance, just return. */
169 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
170 			return 0;
171 		break;
172 
173 	case MII_MEDIACHG:
174 		/*
175 		 * If the media indicates a different PHY instance,
176 		 * isolate ourselves.
177 		 */
178 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
179 			PHY_READ(sc, MII_BMCR, &reg);
180 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
181 			return 0;
182 		}
183 
184 		/* If the interface is not up, don't do anything. */
185 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
186 			break;
187 
188 		mii_phy_setmedia(sc);
189 		break;
190 
191 	case MII_TICK:
192 		/* If we're not currently selected, just return. */
193 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
194 			return 0;
195 
196 		if (mii_phy_tick(sc) == EJUSTRETURN)
197 			return 0;
198 		break;
199 
200 	case MII_DOWN:
201 		mii_phy_down(sc);
202 		return 0;
203 	}
204 
205 	/* Update the media status. */
206 	mii_phy_status(sc);
207 
208 	/* Callback if something changed. */
209 	mii_phy_update(sc, cmd);
210 	return 0;
211 }
212 
213 static void
sqphy_status(struct mii_softc * sc)214 sqphy_status(struct mii_softc *sc)
215 {
216 	struct mii_data *mii = sc->mii_pdata;
217 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
218 	uint16_t bmsr, bmcr, status;
219 
220 	KASSERT(mii_locked(mii));
221 
222 	mii->mii_media_status = IFM_AVALID;
223 	mii->mii_media_active = IFM_ETHER;
224 
225 	PHY_READ(sc, MII_BMSR, &bmsr);
226 	PHY_READ(sc, MII_BMSR, &bmsr);
227 	if (bmsr & BMSR_LINK)
228 		mii->mii_media_status |= IFM_ACTIVE;
229 
230 	PHY_READ(sc, MII_BMCR, &bmcr);
231 	if (bmcr & BMCR_ISO) {
232 		mii->mii_media_active |= IFM_NONE;
233 		mii->mii_media_status = 0;
234 		return;
235 	}
236 
237 	if (bmcr & BMCR_LOOP)
238 		mii->mii_media_active |= IFM_LOOP;
239 
240 	if (bmcr & BMCR_AUTOEN) {
241 		if ((bmsr & BMSR_ACOMP) == 0) {
242 			/* Erg, still trying, I guess... */
243 			mii->mii_media_active |= IFM_NONE;
244 			return;
245 		}
246 		/*
247 		 * Note: don't get fancy here -- the 80225 only supports the
248 		 * SPD_DET and DPLX_DET bits in the STATUS register.
249 		 */
250 		PHY_READ(sc, MII_SQPHY_STATUS, &status);
251 		if (status & STATUS_SPD_DET)
252 			mii->mii_media_active |= IFM_100_TX;
253 		else
254 			mii->mii_media_active |= IFM_10_T;
255 		if (status & STATUS_DPLX_DET)
256 			mii->mii_media_active |= IFM_FDX;
257 		else
258 			mii->mii_media_active |= IFM_HDX;
259 	} else
260 		mii->mii_media_active = ife->ifm_media;
261 }
262 
263 static void
sqphy_84220_reset(struct mii_softc * sc)264 sqphy_84220_reset(struct mii_softc *sc)
265 {
266 	uint16_t reg;
267 
268 	KASSERT(mii_locked(sc->mii_pdata));
269 
270 	mii_phy_reset(sc);
271 
272 	/*
273 	 * This PHY sometimes insists on coming out of reset isolated,
274 	 * even when the MDA[0-3] pins are pulled high (to indicate
275 	 * PHY address 0), contrary to the device's datasheet.
276 	 *
277 	 * Morever, simply clearing BMCR_ISO here isn't enough; the
278 	 * change won't stick until about 30mS *after* the PHY has
279 	 * been reset.
280 	 *
281 	 * This sucks.
282 	 */
283 	if ((sc->mii_inst != 0) && ((sc->mii_flags & MIIF_NOISOLATE) == 0))
284 		return;
285 
286 	PHY_READ(sc, MII_BMCR, &reg);
287 	while ((reg & BMCR_ISO) != 0) {
288 		delay(35000);
289 		PHY_WRITE(sc, MII_BMCR, reg & ~BMCR_ISO);
290 		delay(35000);
291 		PHY_READ(sc, MII_BMCR, &reg);
292 	}
293 }
294