xref: /netbsd-src/sys/dev/mii/lxtphy.c (revision cac8e449158efc7261bebc8657cbb0125a2cfdde)
1 /*	$NetBSD: lxtphy.c,v 1.46 2008/05/04 17:06:09 xtraeme 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  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*
34  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  * 1. Redistributions of source code must retain the above copyright
40  *    notice, this list of conditions and the following disclaimer.
41  * 2. Redistributions in binary form must reproduce the above copyright
42  *    notice, this list of conditions and the following disclaimer in the
43  *    documentation and/or other materials provided with the distribution.
44  * 3. All advertising materials mentioning features or use of this software
45  *    must display the following acknowledgement:
46  *	This product includes software developed by Manuel Bouyer.
47  * 4. The name of the author may not be used to endorse or promote products
48  *    derived from this software without specific prior written permission.
49  *
50  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
51  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
52  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
53  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
54  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
55  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
56  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
57  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
58  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
59  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
60  */
61 
62 /*
63  * driver for Level One's LXT-970 ethernet 10/100 PHY
64  * datasheet from www.level1.com
65  */
66 
67 #include <sys/cdefs.h>
68 __KERNEL_RCSID(0, "$NetBSD: lxtphy.c,v 1.46 2008/05/04 17:06:09 xtraeme Exp $");
69 
70 #include <sys/param.h>
71 #include <sys/systm.h>
72 #include <sys/kernel.h>
73 #include <sys/device.h>
74 #include <sys/socket.h>
75 #include <sys/errno.h>
76 
77 #include <net/if.h>
78 #include <net/if_media.h>
79 
80 #include <dev/mii/mii.h>
81 #include <dev/mii/miivar.h>
82 #include <dev/mii/miidevs.h>
83 
84 #include <dev/mii/lxtphyreg.h>
85 
86 static int	lxtphymatch(device_t, cfdata_t, void *);
87 static void	lxtphyattach(device_t, device_t, void *);
88 
89 CFATTACH_DECL_NEW(lxtphy, sizeof(struct mii_softc),
90     lxtphymatch, lxtphyattach, mii_phy_detach, mii_phy_activate);
91 
92 static int	lxtphy_service(struct mii_softc *, struct mii_data *, int);
93 static void	lxtphy_status(struct mii_softc *);
94 static void	lxtphy_reset(struct mii_softc *);
95 
96 static void lxtphy_set_tp(struct mii_softc *);
97 static void lxtphy_set_fx(struct mii_softc *);
98 
99 static const struct mii_phy_funcs lxtphy_funcs = {
100 	lxtphy_service, lxtphy_status, lxtphy_reset,
101 };
102 
103 static const struct mii_phy_funcs lxtphy971_funcs = {
104 	lxtphy_service, ukphy_status, lxtphy_reset,
105 };
106 
107 static const struct mii_phydesc lxtphys[] = {
108 	{ MII_OUI_xxLEVEL1,		MII_MODEL_xxLEVEL1_LXT970,
109 	  MII_STR_xxLEVEL1_LXT970 },
110 
111 	{ MII_OUI_LEVEL1,		MII_MODEL_LEVEL1_LXT971,
112 	  MII_STR_LEVEL1_LXT971 },
113 
114 	{ 0,				0,
115 	  NULL },
116 };
117 
118 static int
119 lxtphymatch(device_t parent, cfdata_t match, void *aux)
120 {
121 	struct mii_attach_args *ma = aux;
122 
123 	if (mii_phy_match(ma, lxtphys) != NULL)
124 		return (10);
125 
126 	return (0);
127 }
128 
129 static void
130 lxtphyattach(device_t parent, device_t self, void *aux)
131 {
132 	struct mii_softc *sc = device_private(self);
133 	struct mii_attach_args *ma = aux;
134 	struct mii_data *mii = ma->mii_data;
135 	const struct mii_phydesc *mpd;
136 
137 	mpd = mii_phy_match(ma, lxtphys);
138 	aprint_naive(": Media interface\n");
139 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
140 
141 	sc->mii_dev = self;
142 	sc->mii_inst = mii->mii_instance;
143 	sc->mii_phy = ma->mii_phyno;
144 	if (mpd->mpd_model == MII_MODEL_LEVEL1_LXT971)
145 		sc->mii_funcs = &lxtphy971_funcs;
146 	else
147 		sc->mii_funcs = &lxtphy_funcs;
148 	sc->mii_pdata = mii;
149 	sc->mii_flags = ma->mii_flags;
150 	sc->mii_anegticks = MII_ANEGTICKS;
151 
152 	PHY_RESET(sc);
153 
154 	sc->mii_capabilities =
155 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
156 	aprint_normal_dev(self, "");
157 
158 	if (sc->mii_flags & MIIF_HAVEFIBER) {
159 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
160 		ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_FX, 0, sc->mii_inst),
161 		    MII_MEDIA_100_TX);
162 		aprint_normal("100baseFX, ");
163 		ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_FX, IFM_FDX, sc->mii_inst),
164 		    MII_MEDIA_100_TX_FDX);
165 		aprint_normal("100baseFX-FDX, ");
166 #undef ADD
167 	}
168 
169 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
170 		aprint_error("no media present");
171 	else
172 		mii_phy_add_media(sc);
173 	aprint_normal("\n");
174 
175 	if (!pmf_device_register(self, NULL, mii_phy_resume))
176 		aprint_error_dev(self, "couldn't establish power handler\n");
177 }
178 
179 static int
180 lxtphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
181 {
182 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
183 	int reg;
184 
185 	switch (cmd) {
186 	case MII_POLLSTAT:
187 		/*
188 		 * If we're not polling our PHY instance, just return.
189 		 */
190 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
191 			return (0);
192 		break;
193 
194 	case MII_MEDIACHG:
195 		/*
196 		 * If the media indicates a different PHY instance,
197 		 * isolate ourselves.
198 		 */
199 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
200 			reg = PHY_READ(sc, MII_BMCR);
201 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
202 			return (0);
203 		}
204 
205 		/*
206 		 * If the interface is not up, don't do anything.
207 		 */
208 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
209 			break;
210 
211 		if (IFM_SUBTYPE(ife->ifm_media) == IFM_100_FX)
212 			lxtphy_set_fx(sc);
213 		else
214 			lxtphy_set_tp(sc);
215 
216 		mii_phy_setmedia(sc);
217 		break;
218 
219 	case MII_TICK:
220 		/*
221 		 * If we're not currently selected, just return.
222 		 */
223 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
224 			return (0);
225 
226 		if (mii_phy_tick(sc) == EJUSTRETURN)
227 			return (0);
228 		break;
229 
230 	case MII_DOWN:
231 		mii_phy_down(sc);
232 		return (0);
233 	}
234 
235 	/* Update the media status. */
236 	mii_phy_status(sc);
237 
238 	/* Callback if something changed. */
239 	mii_phy_update(sc, cmd);
240 	return (0);
241 }
242 
243 static void
244 lxtphy_status(struct mii_softc *sc)
245 {
246 	struct mii_data *mii = sc->mii_pdata;
247 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
248 	int bmcr, bmsr, csr;
249 
250 	mii->mii_media_status = IFM_AVALID;
251 	mii->mii_media_active = IFM_ETHER;
252 
253 	/*
254 	 * Get link status from the CSR; we need to read the CSR
255 	 * for media type anyhow, and the link status in the CSR
256 	 * doens't latch, so fewer register reads are required.
257 	 */
258 	csr = PHY_READ(sc, MII_LXTPHY_CSR);
259 	if (csr & CSR_LINK)
260 		mii->mii_media_status |= IFM_ACTIVE;
261 
262 	bmcr = PHY_READ(sc, MII_BMCR);
263 	if (bmcr & BMCR_ISO) {
264 		mii->mii_media_active |= IFM_NONE;
265 		mii->mii_media_status = 0;
266 		return;
267 	}
268 
269 	if (bmcr & BMCR_LOOP)
270 		mii->mii_media_active |= IFM_LOOP;
271 
272 	if (bmcr & BMCR_AUTOEN) {
273 		bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
274 		if ((bmsr & BMSR_ACOMP) == 0) {
275 			/* Erg, still trying, I guess... */
276 			mii->mii_media_active |= IFM_NONE;
277 			return;
278 		}
279 		if (csr & CSR_SPEED)
280 			mii->mii_media_active |= IFM_100_TX;
281 		else
282 			mii->mii_media_active |= IFM_10_T;
283 		if (csr & CSR_DUPLEX)
284 			mii->mii_media_active |= IFM_FDX;
285 	} else
286 		mii->mii_media_active = ife->ifm_media;
287 }
288 
289 static void
290 lxtphy_reset(struct mii_softc *sc)
291 {
292 
293 	mii_phy_reset(sc);
294 	PHY_WRITE(sc, MII_LXTPHY_IER,
295 	    PHY_READ(sc, MII_LXTPHY_IER) & ~IER_INTEN);
296 }
297 
298 static void
299 lxtphy_set_tp(struct mii_softc *sc)
300 {
301 	int cfg;
302 
303 	cfg = PHY_READ(sc, MII_LXTPHY_CONFIG);
304 	cfg &= ~CONFIG_100BASEFX;
305 	PHY_WRITE(sc, MII_LXTPHY_CONFIG, cfg);
306 }
307 
308 static void
309 lxtphy_set_fx(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