xref: /netbsd-src/sys/dev/mii/lxtphy.c (revision 8b0f9554ff8762542c4defc4f70e1eb76fb508fa)
1 /*	$NetBSD: lxtphy.c,v 1.42 2007/12/09 20:28:03 jmcneill 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 Level One's LXT-970 ethernet 10/100 PHY
71  * datasheet from www.level1.com
72  */
73 
74 #include <sys/cdefs.h>
75 __KERNEL_RCSID(0, "$NetBSD: lxtphy.c,v 1.42 2007/12/09 20:28:03 jmcneill 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 #include <sys/errno.h>
83 
84 #include <net/if.h>
85 #include <net/if_media.h>
86 
87 #include <dev/mii/mii.h>
88 #include <dev/mii/miivar.h>
89 #include <dev/mii/miidevs.h>
90 
91 #include <dev/mii/lxtphyreg.h>
92 
93 static int	lxtphymatch(struct device *, struct cfdata *, void *);
94 static void	lxtphyattach(struct device *, struct device *, void *);
95 
96 CFATTACH_DECL(lxtphy, sizeof(struct mii_softc),
97     lxtphymatch, lxtphyattach, mii_phy_detach, mii_phy_activate);
98 
99 static int	lxtphy_service(struct mii_softc *, struct mii_data *, int);
100 static void	lxtphy_status(struct mii_softc *);
101 static void	lxtphy_reset(struct mii_softc *);
102 
103 static void lxtphy_set_tp(struct mii_softc *);
104 static void lxtphy_set_fx(struct mii_softc *);
105 
106 static const struct mii_phy_funcs lxtphy_funcs = {
107 	lxtphy_service, lxtphy_status, lxtphy_reset,
108 };
109 
110 static const struct mii_phy_funcs lxtphy971_funcs = {
111 	lxtphy_service, ukphy_status, lxtphy_reset,
112 };
113 
114 static const struct mii_phydesc lxtphys[] = {
115 	{ MII_OUI_xxLEVEL1,		MII_MODEL_xxLEVEL1_LXT970,
116 	  MII_STR_xxLEVEL1_LXT970 },
117 
118 	{ MII_OUI_LEVEL1,		MII_MODEL_LEVEL1_LXT971,
119 	  MII_STR_LEVEL1_LXT971 },
120 
121 	{ 0,				0,
122 	  NULL },
123 };
124 
125 static int
126 lxtphymatch(struct device *parent, struct cfdata *match,
127     void *aux)
128 {
129 	struct mii_attach_args *ma = aux;
130 
131 	if (mii_phy_match(ma, lxtphys) != NULL)
132 		return (10);
133 
134 	return (0);
135 }
136 
137 static void
138 lxtphyattach(struct device *parent, struct device *self, void *aux)
139 {
140 	struct mii_softc *sc = device_private(self);
141 	struct mii_attach_args *ma = aux;
142 	struct mii_data *mii = ma->mii_data;
143 	const struct mii_phydesc *mpd;
144 
145 	mpd = mii_phy_match(ma, lxtphys);
146 	aprint_naive(": Media interface\n");
147 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
148 
149 	sc->mii_inst = mii->mii_instance;
150 	sc->mii_phy = ma->mii_phyno;
151 	if (mpd->mpd_model == MII_MODEL_LEVEL1_LXT971)
152 		sc->mii_funcs = &lxtphy971_funcs;
153 	else
154 		sc->mii_funcs = &lxtphy_funcs;
155 	sc->mii_pdata = mii;
156 	sc->mii_flags = ma->mii_flags;
157 	sc->mii_anegticks = MII_ANEGTICKS;
158 
159 	PHY_RESET(sc);
160 
161 	sc->mii_capabilities =
162 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
163 	aprint_normal("%s: ", sc->mii_dev.dv_xname);
164 
165 	if (sc->mii_flags & MIIF_HAVEFIBER) {
166 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
167 		ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_FX, 0, sc->mii_inst),
168 		    MII_MEDIA_100_TX);
169 		aprint_normal("100baseFX, ");
170 		ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_FX, IFM_FDX, sc->mii_inst),
171 		    MII_MEDIA_100_TX_FDX);
172 		aprint_normal("100baseFX-FDX, ");
173 #undef ADD
174 	}
175 
176 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
177 		aprint_error("no media present");
178 	else
179 		mii_phy_add_media(sc);
180 	aprint_normal("\n");
181 
182 	if (!pmf_device_register(self, NULL, mii_phy_resume))
183 		aprint_error_dev(self, "couldn't establish power handler\n");
184 }
185 
186 static int
187 lxtphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
188 {
189 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
190 	int reg;
191 
192 	if (!device_is_active(&sc->mii_dev))
193 		return (ENXIO);
194 
195 	switch (cmd) {
196 	case MII_POLLSTAT:
197 		/*
198 		 * If we're not polling our PHY instance, just return.
199 		 */
200 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
201 			return (0);
202 		break;
203 
204 	case MII_MEDIACHG:
205 		/*
206 		 * If the media indicates a different PHY instance,
207 		 * isolate ourselves.
208 		 */
209 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
210 			reg = PHY_READ(sc, MII_BMCR);
211 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
212 			return (0);
213 		}
214 
215 		/*
216 		 * If the interface is not up, don't do anything.
217 		 */
218 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
219 			break;
220 
221 		if (IFM_SUBTYPE(ife->ifm_media) == IFM_100_FX)
222 			lxtphy_set_fx(sc);
223 		else
224 			lxtphy_set_tp(sc);
225 
226 		mii_phy_setmedia(sc);
227 		break;
228 
229 	case MII_TICK:
230 		/*
231 		 * If we're not currently selected, just return.
232 		 */
233 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
234 			return (0);
235 
236 		if (mii_phy_tick(sc) == EJUSTRETURN)
237 			return (0);
238 		break;
239 
240 	case MII_DOWN:
241 		mii_phy_down(sc);
242 		return (0);
243 	}
244 
245 	/* Update the media status. */
246 	mii_phy_status(sc);
247 
248 	/* Callback if something changed. */
249 	mii_phy_update(sc, cmd);
250 	return (0);
251 }
252 
253 static void
254 lxtphy_status(struct mii_softc *sc)
255 {
256 	struct mii_data *mii = sc->mii_pdata;
257 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
258 	int bmcr, bmsr, csr;
259 
260 	mii->mii_media_status = IFM_AVALID;
261 	mii->mii_media_active = IFM_ETHER;
262 
263 	/*
264 	 * Get link status from the CSR; we need to read the CSR
265 	 * for media type anyhow, and the link status in the CSR
266 	 * doens't latch, so fewer register reads are required.
267 	 */
268 	csr = PHY_READ(sc, MII_LXTPHY_CSR);
269 	if (csr & CSR_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 	if (bmcr & BMCR_AUTOEN) {
283 		bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
284 		if ((bmsr & BMSR_ACOMP) == 0) {
285 			/* Erg, still trying, I guess... */
286 			mii->mii_media_active |= IFM_NONE;
287 			return;
288 		}
289 		if (csr & CSR_SPEED)
290 			mii->mii_media_active |= IFM_100_TX;
291 		else
292 			mii->mii_media_active |= IFM_10_T;
293 		if (csr & CSR_DUPLEX)
294 			mii->mii_media_active |= IFM_FDX;
295 	} else
296 		mii->mii_media_active = ife->ifm_media;
297 }
298 
299 static void
300 lxtphy_reset(struct mii_softc *sc)
301 {
302 
303 	mii_phy_reset(sc);
304 	PHY_WRITE(sc, MII_LXTPHY_IER,
305 	    PHY_READ(sc, MII_LXTPHY_IER) & ~IER_INTEN);
306 }
307 
308 static void
309 lxtphy_set_tp(struct mii_softc *sc)
310 {
311 	int cfg;
312 
313 	cfg = PHY_READ(sc, MII_LXTPHY_CONFIG);
314 	cfg &= ~CONFIG_100BASEFX;
315 	PHY_WRITE(sc, MII_LXTPHY_CONFIG, cfg);
316 }
317 
318 static void
319 lxtphy_set_fx(struct mii_softc *sc)
320 {
321 	int cfg;
322 
323 	cfg = PHY_READ(sc, MII_LXTPHY_CONFIG);
324 	cfg |= CONFIG_100BASEFX;
325 	PHY_WRITE(sc, MII_LXTPHY_CONFIG, cfg);
326 }
327