xref: /netbsd-src/sys/dev/mii/qsphy.c (revision ce2c90c7c172d95d2402a5b3d96d8f8e6d138a21)
1 /*	$NetBSD: qsphy.c,v 1.38 2006/10/12 01:31:25 christos Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998, 1999, 2000 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  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *	This product includes software developed by the NetBSD
22  *	Foundation, Inc. and its contributors.
23  * 4. Neither the name of The NetBSD Foundation nor the names of its
24  *    contributors may be used to endorse or promote products derived
25  *    from this software without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37  * POSSIBILITY OF SUCH DAMAGE.
38  */
39 
40 /*
41  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
42  *
43  * Redistribution and use in source and binary forms, with or without
44  * modification, are permitted provided that the following conditions
45  * are met:
46  * 1. Redistributions of source code must retain the above copyright
47  *    notice, this list of conditions and the following disclaimer.
48  * 2. Redistributions in binary form must reproduce the above copyright
49  *    notice, this list of conditions and the following disclaimer in the
50  *    documentation and/or other materials provided with the distribution.
51  * 3. All advertising materials mentioning features or use of this software
52  *    must display the following acknowledgement:
53  *	This product includes software developed by Manuel Bouyer.
54  * 4. The name of the author may not be used to endorse or promote products
55  *    derived from this software without specific prior written permission.
56  *
57  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
58  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
59  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
60  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
61  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
62  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
63  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
64  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
65  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
66  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
67  */
68 
69 /*
70  * driver for Quality Semiconductor's QS6612 ethernet 10/100 PHY
71  * datasheet from www.qualitysemi.com
72  */
73 
74 #include <sys/cdefs.h>
75 __KERNEL_RCSID(0, "$NetBSD: qsphy.c,v 1.38 2006/10/12 01:31:25 christos Exp $");
76 
77 #include <sys/param.h>
78 #include <sys/systm.h>
79 #include <sys/kernel.h>
80 #include <sys/device.h>
81 #include <sys/socket.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 static int	qsphymatch(struct device *, struct cfdata *, void *);
93 static void	qsphyattach(struct device *, struct device *, void *);
94 
95 CFATTACH_DECL(qsphy, sizeof(struct mii_softc),
96     qsphymatch, qsphyattach, mii_phy_detach, mii_phy_activate);
97 
98 static int	qsphy_service(struct mii_softc *, struct mii_data *, int);
99 static void	qsphy_status(struct mii_softc *);
100 static void	qsphy_reset(struct mii_softc *);
101 
102 static const struct mii_phy_funcs qsphy_funcs = {
103 	qsphy_service, qsphy_status, qsphy_reset,
104 };
105 
106 static const struct mii_phydesc qsphys[] = {
107 	{ MII_OUI_xxQUALSEMI,		MII_MODEL_xxQUALSEMI_QS6612,
108 	  MII_STR_xxQUALSEMI_QS6612 },
109 
110 	{ 0,				0,
111 	  NULL },
112 };
113 
114 static int
115 qsphymatch(struct device *parent __unused, struct cfdata *match __unused,
116     void *aux)
117 {
118 	struct mii_attach_args *ma = aux;
119 
120 	if (mii_phy_match(ma, qsphys) != NULL)
121 		return (10);
122 
123 	return (0);
124 }
125 
126 static void
127 qsphyattach(struct device *parent __unused, struct device *self, void *aux)
128 {
129 	struct mii_softc *sc = device_private(self);
130 	struct mii_attach_args *ma = aux;
131 	struct mii_data *mii = ma->mii_data;
132 	const struct mii_phydesc *mpd;
133 
134 	mpd = mii_phy_match(ma, qsphys);
135 	aprint_naive(": Media interface\n");
136 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
137 
138 	sc->mii_inst = mii->mii_instance;
139 	sc->mii_phy = ma->mii_phyno;
140 	sc->mii_funcs = &qsphy_funcs;
141 	sc->mii_pdata = mii;
142 	sc->mii_flags = ma->mii_flags;
143 	sc->mii_anegticks = 5;
144 
145 	PHY_RESET(sc);
146 
147 	sc->mii_capabilities =
148 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
149 	aprint_normal("%s: ", sc->mii_dev.dv_xname);
150 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
151 		aprint_error("no media present");
152 	else
153 		mii_phy_add_media(sc);
154 	aprint_normal("\n");
155 }
156 
157 static int
158 qsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
159 {
160 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
161 	int reg;
162 
163 	if (!device_is_active(&sc->mii_dev))
164 		return (ENXIO);
165 
166 	switch (cmd) {
167 	case MII_POLLSTAT:
168 		/*
169 		 * If we're not polling our PHY instance, just return.
170 		 */
171 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
172 			return (0);
173 		break;
174 
175 	case MII_MEDIACHG:
176 		/*
177 		 * If the media indicates a different PHY instance,
178 		 * isolate ourselves.
179 		 */
180 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
181 			reg = PHY_READ(sc, MII_BMCR);
182 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
183 			return (0);
184 		}
185 
186 		/*
187 		 * If the interface is not up, don't do anything.
188 		 */
189 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
190 			break;
191 
192 		mii_phy_setmedia(sc);
193 		break;
194 
195 	case MII_TICK:
196 		/*
197 		 * If we're not currently selected, just return.
198 		 */
199 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
200 			return (0);
201 
202 		if (mii_phy_tick(sc) == EJUSTRETURN)
203 			return (0);
204 		break;
205 
206 	case MII_DOWN:
207 		mii_phy_down(sc);
208 		return (0);
209 	}
210 
211 	/* Update the media status. */
212 	mii_phy_status(sc);
213 
214 	/* Callback if something changed. */
215 	mii_phy_update(sc, cmd);
216 	return (0);
217 }
218 
219 static void
220 qsphy_status(struct mii_softc *sc)
221 {
222 	struct mii_data *mii = sc->mii_pdata;
223 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
224 	int bmsr, bmcr, pctl;
225 
226 	mii->mii_media_status = IFM_AVALID;
227 	mii->mii_media_active = IFM_ETHER;
228 
229 	bmsr = PHY_READ(sc, MII_BMSR) |
230 	    PHY_READ(sc, MII_BMSR);
231 	if (bmsr & BMSR_LINK)
232 		mii->mii_media_status |= IFM_ACTIVE;
233 
234 	bmcr = PHY_READ(sc, MII_BMCR);
235 	if (bmcr & BMCR_ISO) {
236 		mii->mii_media_active |= IFM_NONE;
237 		mii->mii_media_status = 0;
238 		return;
239 	}
240 
241 	if (bmcr & BMCR_LOOP)
242 		mii->mii_media_active |= IFM_LOOP;
243 
244 	if (bmcr & BMCR_AUTOEN) {
245 		if ((bmsr & BMSR_ACOMP) == 0) {
246 			/* Erg, still trying, I guess... */
247 			mii->mii_media_active |= IFM_NONE;
248 			return;
249 		}
250 		pctl = PHY_READ(sc, MII_QSPHY_PCTL) |
251 		    PHY_READ(sc, MII_QSPHY_PCTL);
252 		switch (pctl & PCTL_OPMASK) {
253 		case PCTL_10_T:
254 			mii->mii_media_active |= IFM_10_T;
255 			break;
256 		case PCTL_10_T_FDX:
257 			mii->mii_media_active |= IFM_10_T|IFM_FDX;
258 			break;
259 		case PCTL_100_TX:
260 			mii->mii_media_active |= IFM_100_TX;
261 			break;
262 		case PCTL_100_TX_FDX:
263 			mii->mii_media_active |= IFM_100_TX|IFM_FDX;
264 			break;
265 		case PCTL_100_T4:
266 			mii->mii_media_active |= IFM_100_T4;
267 			break;
268 		default:
269 			/* Erg... this shouldn't happen. */
270 			mii->mii_media_active |= IFM_NONE;
271 			break;
272 		}
273 	} else
274 		mii->mii_media_active = ife->ifm_media;
275 }
276 
277 static void
278 qsphy_reset(struct mii_softc *sc)
279 {
280 
281 	mii_phy_reset(sc);
282 	PHY_WRITE(sc, MII_QSPHY_IMASK, 0);
283 }
284