xref: /freebsd/sys/dev/mii/qsphy.c (revision 3642298923e528d795e3a30ec165d2b469e28b40)
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 #include <sys/cdefs.h>
71 __FBSDID("$FreeBSD$");
72 
73 /*
74  * driver for Quality Semiconductor's QS6612 ethernet 10/100 PHY
75  * datasheet from www.qualitysemi.com
76  */
77 
78 #include <sys/param.h>
79 #include <sys/systm.h>
80 #include <sys/kernel.h>
81 #include <sys/socket.h>
82 #include <sys/errno.h>
83 #include <sys/module.h>
84 #include <sys/bus.h>
85 
86 #include <net/if.h>
87 #include <net/if_media.h>
88 
89 #include <dev/mii/mii.h>
90 #include <dev/mii/miivar.h>
91 #include "miidevs.h"
92 
93 #include <dev/mii/qsphyreg.h>
94 
95 #include "miibus_if.h"
96 
97 static int qsphy_probe(device_t);
98 static int qsphy_attach(device_t);
99 
100 static device_method_t qsphy_methods[] = {
101 	/* device interface */
102 	DEVMETHOD(device_probe,		qsphy_probe),
103 	DEVMETHOD(device_attach,	qsphy_attach),
104 	DEVMETHOD(device_detach,	mii_phy_detach),
105 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
106 	{ 0, 0 }
107 };
108 
109 static devclass_t qsphy_devclass;
110 
111 static driver_t qsphy_driver = {
112 	"qsphy",
113 	qsphy_methods,
114 	sizeof(struct mii_softc)
115 };
116 
117 DRIVER_MODULE(qsphy, miibus, qsphy_driver, qsphy_devclass, 0, 0);
118 
119 static int	qsphy_service(struct mii_softc *, struct mii_data *, int);
120 static void	qsphy_reset(struct mii_softc *);
121 static void	qsphy_status(struct mii_softc *);
122 
123 static int
124 qsphy_probe(dev)
125 	device_t		dev;
126 {
127 	struct mii_attach_args *ma;
128 
129 	ma = device_get_ivars(dev);
130 
131 	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_QUALSEMI &&
132 	    MII_MODEL(ma->mii_id2) == MII_MODEL_QUALSEMI_QS6612) {
133 		device_set_desc(dev, MII_STR_QUALSEMI_QS6612);
134 	} else
135 		return (ENXIO);
136 
137 	return (0);
138 }
139 
140 static int
141 qsphy_attach(dev)
142 	device_t		dev;
143 {
144 	struct mii_softc *sc;
145 	struct mii_attach_args *ma;
146 	struct mii_data *mii;
147 
148 	sc = device_get_softc(dev);
149 	ma = device_get_ivars(dev);
150 	sc->mii_dev = device_get_parent(dev);
151 	mii = device_get_softc(sc->mii_dev);
152 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
153 
154 	sc->mii_inst = mii->mii_instance;
155 	sc->mii_phy = ma->mii_phyno;
156 	sc->mii_service = qsphy_service;
157 	sc->mii_pdata = mii;
158 	sc->mii_flags |= MIIF_NOISOLATE;
159 
160 	qsphy_reset(sc);
161 
162 	mii->mii_instance++;
163 
164 	sc->mii_capabilities =
165 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
166 	device_printf(dev, " ");
167 	mii_add_media(sc);
168 	printf("\n");
169 
170 	MIIBUS_MEDIAINIT(sc->mii_dev);
171 	return (0);
172 }
173 
174 static int
175 qsphy_service(sc, mii, cmd)
176 	struct mii_softc *sc;
177 	struct mii_data *mii;
178 	int cmd;
179 {
180 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
181 	int reg;
182 
183 	/*
184 	 * If we're not selected, then do nothing, just isolate, if
185 	 * changing media.
186 	 */
187 	if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
188 		if (cmd == MII_MEDIACHG) {
189 			reg = PHY_READ(sc, MII_BMCR);
190 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
191 		}
192 
193 		return (0);
194 	}
195 
196 	switch (cmd) {
197 	case MII_POLLSTAT:
198 		break;
199 
200 	case MII_MEDIACHG:
201 		/*
202 		 * If the interface is not up, don't do anything.
203 		 */
204 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
205 			break;
206 
207 		switch (IFM_SUBTYPE(ife->ifm_media)) {
208 		case IFM_AUTO:
209 			/*
210 			 * If we're already in auto mode, just return.
211 			 */
212 			if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
213 				return (0);
214 
215 			(void) mii_phy_auto(sc);
216 			break;
217 
218 		default:
219 			/*
220 			 * BMCR data is stored in the ifmedia entry.
221 			 */
222 			PHY_WRITE(sc, MII_ANAR,
223 			    mii_anar(ife->ifm_media));
224 			PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
225 		}
226 		break;
227 
228 	case MII_TICK:
229 		/*
230 		 * Is the interface even up?
231 		 */
232 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
233 			return (0);
234 
235 		/*
236 		 * Only used for autonegotiation.
237 		 */
238 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
239 			break;
240 
241 		/*
242 		 * This PHY's autonegotiation doesn't need to be kicked.
243 		 */
244 		break;
245 	}
246 
247 	/* Update the media status. */
248 	qsphy_status(sc);
249 
250 	/* Callback if something changed. */
251 	mii_phy_update(sc, cmd);
252 	return (0);
253 }
254 
255 static void
256 qsphy_status(sc)
257 	struct mii_softc *sc;
258 {
259 	struct mii_data *mii = sc->mii_pdata;
260 	int bmsr, bmcr, pctl;
261 
262 	mii->mii_media_status = IFM_AVALID;
263 	mii->mii_media_active = IFM_ETHER;
264 
265 	bmsr = PHY_READ(sc, MII_BMSR) |
266 	    PHY_READ(sc, MII_BMSR);
267 	if (bmsr & BMSR_LINK)
268 		mii->mii_media_status |= IFM_ACTIVE;
269 
270 	bmcr = PHY_READ(sc, MII_BMCR);
271 	if (bmcr & BMCR_ISO) {
272 		mii->mii_media_active |= IFM_NONE;
273 		mii->mii_media_status = 0;
274 		return;
275 	}
276 
277 	if (bmcr & BMCR_LOOP)
278 		mii->mii_media_active |= IFM_LOOP;
279 
280 	pctl = PHY_READ(sc, MII_QSPHY_PCTL);
281 	switch (pctl & PCTL_OPMASK) {
282 	case PCTL_10_T:
283 		mii->mii_media_active |= IFM_10_T;
284 		break;
285 	case PCTL_10_T_FDX:
286 		mii->mii_media_active |= IFM_10_T|IFM_FDX;
287 		break;
288 	case PCTL_100_TX:
289 		mii->mii_media_active |= IFM_100_TX;
290 		break;
291 	case PCTL_100_TX_FDX:
292 		mii->mii_media_active |= IFM_100_TX|IFM_FDX;
293 		break;
294 	case PCTL_100_T4:
295 		mii->mii_media_active |= IFM_100_T4;
296 		break;
297 	case PCTL_AN:
298 		mii->mii_media_active |= IFM_NONE;
299 		break;
300 	default:
301 		/* Erg... this shouldn't happen. */
302 		mii->mii_media_active |= IFM_NONE;
303 		break;
304 	}
305 }
306 
307 static void
308 qsphy_reset(sc)
309 	struct mii_softc *sc;
310 {
311 
312 	mii_phy_reset(sc);
313 	PHY_WRITE(sc, MII_QSPHY_IMASK, 0);
314 }
315