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