xref: /netbsd-src/sys/dev/mii/qsphy.c (revision aaf4ece63a859a04e37cf3a7229b5fab0157cc06)
1 /*	$NetBSD: qsphy.c,v 1.35 2005/12/11 12:22:42 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.35 2005/12/11 12:22:42 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, struct cfdata *match, void *aux)
116 {
117 	struct mii_attach_args *ma = aux;
118 
119 	if (mii_phy_match(ma, qsphys) != NULL)
120 		return (10);
121 
122 	return (0);
123 }
124 
125 static void
126 qsphyattach(struct device *parent, struct device *self, void *aux)
127 {
128 	struct mii_softc *sc = (struct mii_softc *)self;
129 	struct mii_attach_args *ma = aux;
130 	struct mii_data *mii = ma->mii_data;
131 	const struct mii_phydesc *mpd;
132 
133 	mpd = mii_phy_match(ma, qsphys);
134 	aprint_naive(": Media interface\n");
135 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
136 
137 	sc->mii_inst = mii->mii_instance;
138 	sc->mii_phy = ma->mii_phyno;
139 	sc->mii_funcs = &qsphy_funcs;
140 	sc->mii_pdata = mii;
141 	sc->mii_flags = ma->mii_flags;
142 	sc->mii_anegticks = 5;
143 
144 	PHY_RESET(sc);
145 
146 	sc->mii_capabilities =
147 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
148 	aprint_normal("%s: ", sc->mii_dev.dv_xname);
149 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
150 		aprint_error("no media present");
151 	else
152 		mii_phy_add_media(sc);
153 	aprint_normal("\n");
154 }
155 
156 static int
157 qsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
158 {
159 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
160 	int reg;
161 
162 	if ((sc->mii_dev.dv_flags & DVF_ACTIVE) == 0)
163 		return (ENXIO);
164 
165 	switch (cmd) {
166 	case MII_POLLSTAT:
167 		/*
168 		 * If we're not polling our PHY instance, just return.
169 		 */
170 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
171 			return (0);
172 		break;
173 
174 	case MII_MEDIACHG:
175 		/*
176 		 * If the media indicates a different PHY instance,
177 		 * isolate ourselves.
178 		 */
179 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
180 			reg = PHY_READ(sc, MII_BMCR);
181 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
182 			return (0);
183 		}
184 
185 		/*
186 		 * If the interface is not up, don't do anything.
187 		 */
188 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
189 			break;
190 
191 		mii_phy_setmedia(sc);
192 		break;
193 
194 	case MII_TICK:
195 		/*
196 		 * If we're not currently selected, just return.
197 		 */
198 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
199 			return (0);
200 
201 		if (mii_phy_tick(sc) == EJUSTRETURN)
202 			return (0);
203 		break;
204 
205 	case MII_DOWN:
206 		mii_phy_down(sc);
207 		return (0);
208 	}
209 
210 	/* Update the media status. */
211 	mii_phy_status(sc);
212 
213 	/* Callback if something changed. */
214 	mii_phy_update(sc, cmd);
215 	return (0);
216 }
217 
218 static void
219 qsphy_status(struct mii_softc *sc)
220 {
221 	struct mii_data *mii = sc->mii_pdata;
222 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
223 	int bmsr, bmcr, pctl;
224 
225 	mii->mii_media_status = IFM_AVALID;
226 	mii->mii_media_active = IFM_ETHER;
227 
228 	bmsr = PHY_READ(sc, MII_BMSR) |
229 	    PHY_READ(sc, MII_BMSR);
230 	if (bmsr & BMSR_LINK)
231 		mii->mii_media_status |= IFM_ACTIVE;
232 
233 	bmcr = PHY_READ(sc, MII_BMCR);
234 	if (bmcr & BMCR_ISO) {
235 		mii->mii_media_active |= IFM_NONE;
236 		mii->mii_media_status = 0;
237 		return;
238 	}
239 
240 	if (bmcr & BMCR_LOOP)
241 		mii->mii_media_active |= IFM_LOOP;
242 
243 	if (bmcr & BMCR_AUTOEN) {
244 		if ((bmsr & BMSR_ACOMP) == 0) {
245 			/* Erg, still trying, I guess... */
246 			mii->mii_media_active |= IFM_NONE;
247 			return;
248 		}
249 		pctl = PHY_READ(sc, MII_QSPHY_PCTL) |
250 		    PHY_READ(sc, MII_QSPHY_PCTL);
251 		switch (pctl & PCTL_OPMASK) {
252 		case PCTL_10_T:
253 			mii->mii_media_active |= IFM_10_T;
254 			break;
255 		case PCTL_10_T_FDX:
256 			mii->mii_media_active |= IFM_10_T|IFM_FDX;
257 			break;
258 		case PCTL_100_TX:
259 			mii->mii_media_active |= IFM_100_TX;
260 			break;
261 		case PCTL_100_TX_FDX:
262 			mii->mii_media_active |= IFM_100_TX|IFM_FDX;
263 			break;
264 		case PCTL_100_T4:
265 			mii->mii_media_active |= IFM_100_T4;
266 			break;
267 		default:
268 			/* Erg... this shouldn't happen. */
269 			mii->mii_media_active |= IFM_NONE;
270 			break;
271 		}
272 	} else
273 		mii->mii_media_active = ife->ifm_media;
274 }
275 
276 static void
277 qsphy_reset(struct mii_softc *sc)
278 {
279 
280 	mii_phy_reset(sc);
281 	PHY_WRITE(sc, MII_QSPHY_IMASK, 0);
282 }
283