xref: /freebsd/sys/dev/mii/qsphy.c (revision a220d00e74dd245b4fca59c5eca0c53963686325)
1 /*	OpenBSD: qsphy.c,v 1.6 2000/08/26 20:04:18 nate Exp */
2 /*	NetBSD: qsphy.c,v 1.19 2000/02/02 23:34:57 thorpej Exp 	*/
3 
4 /*-
5  * Copyright (c) 1998, 1999 The NetBSD Foundation, Inc.
6  * All rights reserved.
7  *
8  * This code is derived from software contributed to The NetBSD Foundation
9  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
10  * NASA Ames Research Center.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. All advertising materials mentioning features or use of this software
21  *    must display the following acknowledgement:
22  *	This product includes software developed by the NetBSD
23  *	Foundation, Inc. and its contributors.
24  * 4. Neither the name of The NetBSD Foundation nor the names of its
25  *    contributors may be used to endorse or promote products derived
26  *    from this software without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
29  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
32  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38  * POSSIBILITY OF SUCH DAMAGE.
39  */
40 
41 /*
42  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
43  *
44  * Redistribution and use in source and binary forms, with or without
45  * modification, are permitted provided that the following conditions
46  * are met:
47  * 1. Redistributions of source code must retain the above copyright
48  *    notice, this list of conditions and the following disclaimer.
49  * 2. Redistributions in binary form must reproduce the above copyright
50  *    notice, this list of conditions and the following disclaimer in the
51  *    documentation and/or other materials provided with the distribution.
52  * 3. All advertising materials mentioning features or use of this software
53  *    must display the following acknowledgement:
54  *	This product includes software developed by Manuel Bouyer.
55  * 4. The name of the author may not be used to endorse or promote products
56  *    derived from this software without specific prior written permission.
57  *
58  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
59  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
60  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
61  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
62  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
63  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
64  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
65  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
66  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
67  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
68  */
69 
70 /*
71  * driver for Quality Semiconductor's QS6612 ethernet 10/100 PHY
72  * datasheet from www.qualitysemi.com
73  */
74 
75 #include <sys/param.h>
76 #include <sys/systm.h>
77 #include <sys/kernel.h>
78 #include <sys/socket.h>
79 #include <sys/errno.h>
80 #include <sys/module.h>
81 #include <sys/bus.h>
82 
83 #include <net/if.h>
84 #include <net/if_media.h>
85 
86 #include <dev/mii/mii.h>
87 #include <dev/mii/miivar.h>
88 #include <dev/mii/miidevs.h>
89 
90 #include <dev/mii/qsphyreg.h>
91 
92 #include "miibus_if.h"
93 
94 #if !defined(lint)
95 static const char rcsid[] =
96   "$FreeBSD$";
97 #endif
98 
99 static int qsphy_probe		__P((device_t));
100 static int qsphy_attach		__P((device_t));
101 static int qsphy_detach		__P((device_t));
102 
103 static device_method_t qsphy_methods[] = {
104 	/* device interface */
105 	DEVMETHOD(device_probe,		qsphy_probe),
106 	DEVMETHOD(device_attach,	qsphy_attach),
107 	DEVMETHOD(device_detach,	qsphy_detach),
108 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
109 	{ 0, 0 }
110 };
111 
112 static devclass_t qsphy_devclass;
113 
114 static driver_t qsphy_driver = {
115 	"qsphy",
116 	qsphy_methods,
117 	sizeof(struct mii_softc)
118 };
119 
120 DRIVER_MODULE(qsphy, miibus, qsphy_driver, qsphy_devclass, 0, 0);
121 
122 static int	qsphy_service __P((struct mii_softc *, struct mii_data *, int));
123 static void	qsphy_reset __P((struct mii_softc *));
124 static void	qsphy_status __P((struct mii_softc *));
125 
126 static int qsphy_probe(dev)
127 	device_t		dev;
128 {
129 	struct mii_attach_args *ma;
130 
131 	ma = device_get_ivars(dev);
132 
133 	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_QUALSEMI &&
134 	    MII_MODEL(ma->mii_id2) == MII_MODEL_QUALSEMI_QS6612) {
135 		device_set_desc(dev, MII_STR_QUALSEMI_QS6612);
136 	} else
137 		return (ENXIO);
138 
139 	return (0);
140 }
141 
142 static int qsphy_attach(dev)
143 	device_t		dev;
144 {
145 	struct mii_softc *sc;
146 	struct mii_attach_args *ma;
147 	struct mii_data *mii;
148 
149 	sc = device_get_softc(dev);
150 	ma = device_get_ivars(dev);
151 	sc->mii_dev = device_get_parent(dev);
152 	mii = device_get_softc(sc->mii_dev);
153 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
154 
155 	sc->mii_inst = mii->mii_instance;
156 	sc->mii_phy = ma->mii_phyno;
157 	sc->mii_service = qsphy_service;
158 	sc->mii_pdata = mii;
159 	sc->mii_flags |= MIIF_NOISOLATE;
160 
161 	qsphy_reset(sc);
162 
163 	mii->mii_instance++;
164 
165 	sc->mii_capabilities =
166 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
167 	device_printf(dev, " ");
168 	if (sc->mii_capabilities & BMSR_MEDIAMASK)
169 		mii_add_media(mii, sc->mii_capabilities,
170 		    sc->mii_inst);
171 	printf("\n");
172 
173 	MIIBUS_MEDIAINIT(sc->mii_dev);
174 	return (0);
175 }
176 
177 static int qsphy_detach(dev)
178 	device_t		dev;
179 {
180 	struct mii_softc *sc;
181 	struct mii_data *mii;
182 
183 	sc = device_get_softc(dev);
184 	mii = device_get_softc(device_get_parent(dev));
185 	sc->mii_dev = NULL;
186 	LIST_REMOVE(sc, mii_list);
187 
188 	return(0);
189 }
190 
191 static int
192 qsphy_service(sc, mii, cmd)
193 	struct mii_softc *sc;
194 	struct mii_data *mii;
195 	int cmd;
196 {
197 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
198 	int reg;
199 
200 	switch (cmd) {
201 	case MII_POLLSTAT:
202 		/*
203 		 * If we're not polling our PHY instance, just return.
204 		 */
205 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
206 			return (0);
207 		break;
208 
209 	case MII_MEDIACHG:
210 		/*
211 		 * If the media indicates a different PHY instance,
212 		 * isolate ourselves.
213 		 */
214 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
215 			reg = PHY_READ(sc, MII_BMCR);
216 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
217 			return (0);
218 		}
219 
220 		/*
221 		 * If the interface is not up, don't do anything.
222 		 */
223 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
224 			break;
225 
226 		switch (IFM_SUBTYPE(ife->ifm_media)) {
227 		case IFM_AUTO:
228 			/*
229 			 * If we're already in auto mode, just return.
230 			 */
231 			if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
232 				return (0);
233 
234 			(void) mii_phy_auto(sc, 1);
235 			break;
236 
237 		default:
238 			/*
239 			 * BMCR data is stored in the ifmedia entry.
240 			 */
241 			PHY_WRITE(sc, MII_ANAR,
242 			    mii_anar(ife->ifm_media));
243 			PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
244 		}
245 		break;
246 
247 	case MII_TICK:
248 		/*
249 		 * If we're not currently selected, just return.
250 		 */
251 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
252 			return (0);
253 
254 		/*
255 		 * Is the interface even up?
256 		 */
257 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
258 			return (0);
259 
260 		/*
261 		 * Only used for autonegotiation.
262 		 */
263 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
264 			break;
265 
266 		/*
267 		 * check for link.
268 		 * Read the status register twice; BMSR_LINK is latch-low.
269 		 */
270 		reg = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
271 		if (reg & BMSR_LINK)
272 			break;
273 
274 		/*
275 		 * Only retry autonegotiation every 5 seconds.
276 		 */
277 		if (++sc->mii_ticks != 5)
278 			return (0);
279 
280 		sc->mii_ticks = 0;
281 		qsphy_reset(sc);
282 		if (mii_phy_auto(sc, 0) == EJUSTRETURN)
283 			return (0);
284 		break;
285 	}
286 
287 	/* Update the media status. */
288 	qsphy_status(sc);
289 
290 	/* Callback if something changed. */
291 	mii_phy_update(sc, cmd);
292 	return (0);
293 }
294 
295 static void
296 qsphy_status(sc)
297 	struct mii_softc *sc;
298 {
299 	struct mii_data *mii = sc->mii_pdata;
300 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
301 	int bmsr, bmcr, pctl;
302 
303 	mii->mii_media_status = IFM_AVALID;
304 	mii->mii_media_active = IFM_ETHER;
305 
306 	bmsr = PHY_READ(sc, MII_BMSR) |
307 	    PHY_READ(sc, MII_BMSR);
308 	if (bmsr & BMSR_LINK)
309 		mii->mii_media_status |= IFM_ACTIVE;
310 
311 	bmcr = PHY_READ(sc, MII_BMCR);
312 	if (bmcr & BMCR_ISO) {
313 		mii->mii_media_active |= IFM_NONE;
314 		mii->mii_media_status = 0;
315 		return;
316 	}
317 
318 	if (bmcr & BMCR_LOOP)
319 		mii->mii_media_active |= IFM_LOOP;
320 
321 	if (bmcr & BMCR_AUTOEN) {
322 		if ((bmsr & BMSR_ACOMP) == 0) {
323 			/* Erg, still trying, I guess... */
324 			mii->mii_media_active |= IFM_NONE;
325 			return;
326 		}
327 		pctl = PHY_READ(sc, MII_QSPHY_PCTL) |
328 		    PHY_READ(sc, MII_QSPHY_PCTL);
329 		switch (pctl & PCTL_OPMASK) {
330 		case PCTL_10_T:
331 			mii->mii_media_active |= IFM_10_T;
332 			break;
333 		case PCTL_10_T_FDX:
334 			mii->mii_media_active |= IFM_10_T|IFM_FDX;
335 			break;
336 		case PCTL_100_TX:
337 			mii->mii_media_active |= IFM_100_TX;
338 			break;
339 		case PCTL_100_TX_FDX:
340 			mii->mii_media_active |= IFM_100_TX|IFM_FDX;
341 			break;
342 		case PCTL_100_T4:
343 			mii->mii_media_active |= IFM_100_T4;
344 			break;
345 		default:
346 			/* Erg... this shouldn't happen. */
347 			mii->mii_media_active |= IFM_NONE;
348 			break;
349 		}
350 	} else
351 		mii->mii_media_active = ife->ifm_media;
352 }
353 
354 static void
355 qsphy_reset(sc)
356 	struct mii_softc *sc;
357 {
358 
359 	mii_phy_reset(sc);
360 	PHY_WRITE(sc, MII_QSPHY_IMASK, 0);
361 }
362