xref: /dragonfly/sys/dev/netif/mii_layer/lxtphy.c (revision 606a6e92)
1 /*	OpenBSD: lxtphy.c,v 1.5 2000/08/26 20:04:17 nate Exp 	*/
2 /*	NetBSD: lxtphy.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  * $FreeBSD: src/sys/dev/mii/lxtphy.c,v 1.1.2.1 2001/06/08 19:58:33 semenu Exp $
41  * $DragonFly: src/sys/dev/netif/mii_layer/lxtphy.c,v 1.5 2004/09/18 19:32:59 dillon Exp $
42  */
43 
44 /*
45  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
46  *
47  * Redistribution and use in source and binary forms, with or without
48  * modification, are permitted provided that the following conditions
49  * are met:
50  * 1. Redistributions of source code must retain the above copyright
51  *    notice, this list of conditions and the following disclaimer.
52  * 2. Redistributions in binary form must reproduce the above copyright
53  *    notice, this list of conditions and the following disclaimer in the
54  *    documentation and/or other materials provided with the distribution.
55  * 3. All advertising materials mentioning features or use of this software
56  *    must display the following acknowledgement:
57  *	This product includes software developed by Manuel Bouyer.
58  * 4. The name of the author may not be used to endorse or promote products
59  *    derived from this software without specific prior written permission.
60  *
61  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
62  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
63  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
64  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
65  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
66  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
67  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
68  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
69  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
70  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
71  */
72 
73 /*
74  * driver for Level One's LXT-970 ethernet 10/100 PHY
75  * datasheet from www.level1.com
76  */
77 
78 #include <sys/param.h>
79 #include <sys/systm.h>
80 #include <sys/kernel.h>
81 #include <sys/socket.h>
82 #include <sys/errno.h>
83 #include <sys/module.h>
84 #include <sys/bus.h>
85 
86 #include <net/if.h>
87 #include <net/if_media.h>
88 
89 #include "mii.h"
90 #include "miivar.h"
91 #include "miidevs.h"
92 
93 #include "lxtphyreg.h"
94 
95 #include "miibus_if.h"
96 
97 static int lxtphy_probe		(device_t);
98 static int lxtphy_attach	(device_t);
99 static int lxtphy_detach	(device_t);
100 
101 static device_method_t lxtphy_methods[] = {
102 	/* device interface */
103 	DEVMETHOD(device_probe,		lxtphy_probe),
104 	DEVMETHOD(device_attach,	lxtphy_attach),
105 	DEVMETHOD(device_detach,	lxtphy_detach),
106 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
107 	{ 0, 0 }
108 };
109 
110 static devclass_t lxtphy_devclass;
111 
112 static driver_t lxtphy_driver = {
113 	"lxtphy",
114 	lxtphy_methods,
115 	sizeof(struct mii_softc)
116 };
117 
118 DRIVER_MODULE(lxtphy, miibus, lxtphy_driver, lxtphy_devclass, 0, 0);
119 
120 static int	lxtphy_service (struct mii_softc *, struct mii_data *, int);
121 static void	lxtphy_status (struct mii_softc *);
122 static void	lxtphy_set_tp (struct mii_softc *);
123 static void	lxtphy_set_fx (struct mii_softc *);
124 
125 static int lxtphy_probe(dev)
126 	device_t		dev;
127 {
128 	struct mii_attach_args *ma;
129 
130 	ma = device_get_ivars(dev);
131 
132 	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxLEVEL1 &&
133 	    MII_MODEL(ma->mii_id2) == MII_MODEL_xxLEVEL1_LXT970) {
134 		device_set_desc(dev, MII_STR_xxLEVEL1_LXT970);
135 	} else
136 		return (ENXIO);
137 
138 	return (0);
139 }
140 
141 static int lxtphy_attach(dev)
142 	device_t		dev;
143 {
144 	struct mii_softc *sc;
145 	struct mii_attach_args *ma;
146 	struct mii_data *mii;
147 
148 	sc = device_get_softc(dev);
149 	ma = device_get_ivars(dev);
150 	mii_softc_init(sc);
151 	sc->mii_dev = device_get_parent(dev);
152 	mii = device_get_softc(sc->mii_dev);
153 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
154 
155 	sc->mii_inst = mii->mii_instance;
156 	sc->mii_phy = ma->mii_phyno;
157 	sc->mii_service = lxtphy_service;
158 	sc->mii_pdata = mii;
159 	sc->mii_flags |= MIIF_NOISOLATE;
160 
161 	mii_phy_reset(sc);
162 
163 	mii->mii_instance++;
164 
165 	sc->mii_capabilities =
166 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
167 	device_printf(dev, " ");
168 
169 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
170 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
171 	    BMCR_ISO);
172 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_FX, 0, sc->mii_inst),
173 	    BMCR_S100);
174 	printf("100baseFX, ");
175 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_FX, IFM_FDX, sc->mii_inst),
176 	    BMCR_S100|BMCR_FDX);
177 	printf("100baseFX-FDX, ");
178 #undef ADD
179 
180 	if (sc->mii_capabilities & BMSR_MEDIAMASK)
181 		mii_add_media(mii, sc->mii_capabilities,
182 		    sc->mii_inst);
183 	printf("\n");
184 
185 	MIIBUS_MEDIAINIT(sc->mii_dev);
186 	return(0);
187 }
188 
189 
190 static int lxtphy_detach(dev)
191 	device_t		dev;
192 {
193 	struct mii_softc *sc;
194 	struct mii_data *mii;
195 
196 	sc = device_get_softc(dev);
197 	mii = device_get_softc(device_get_parent(dev));
198 	sc->mii_dev = NULL;
199 	LIST_REMOVE(sc, mii_list);
200 
201 	return(0);
202 }
203 
204 static int
205 lxtphy_service(sc, mii, cmd)
206 	struct mii_softc *sc;
207 	struct mii_data *mii;
208 	int cmd;
209 {
210 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
211 	int reg;
212 
213 	switch (cmd) {
214 	case MII_POLLSTAT:
215 		/*
216 		 * If we're not polling our PHY instance, just return.
217 		 */
218 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
219 			return (0);
220 		break;
221 
222 	case MII_MEDIACHG:
223 		/*
224 		 * If the media indicates a different PHY instance,
225 		 * isolate ourselves.
226 		 */
227 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
228 			reg = PHY_READ(sc, MII_BMCR);
229 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
230 			return (0);
231 		}
232 
233 		/*
234 		 * If the interface is not up, don't do anything.
235 		 */
236 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
237 			break;
238 
239 		switch (IFM_SUBTYPE(ife->ifm_media)) {
240 		case IFM_AUTO:
241 			/*
242 			 * If we're already in auto mode, just return.
243 			 */
244 			if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
245 				return (0);
246 
247 			lxtphy_set_tp(sc);
248 
249 			(void) mii_phy_auto(sc, 1);
250 			break;
251 		case IFM_100_T4:
252 			/*
253 			 * XXX Not supported as a manual setting right now.
254 			 */
255 			return (EINVAL);
256 
257 		case IFM_100_FX:
258 			lxtphy_set_fx(sc);
259 
260 		default:
261 			/*
262 			 * BMCR data is stored in the ifmedia entry.
263 			 */
264 			PHY_WRITE(sc, MII_ANAR,
265 			    mii_anar(ife->ifm_media));
266 			PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
267 		}
268 		break;
269 
270 	case MII_TICK:
271 		/*
272 		 * If we're not currently selected, just return.
273 		 */
274 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
275 			return (0);
276 
277 		/*
278 		 * Only used for autonegotiation.
279 		 */
280 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
281 			return (0);
282 
283 		/*
284 		 * Is the interface even up?
285 		 */
286 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
287 			return (0);
288 
289 		/*
290 		 * Check to see if we have link.  If we do, we don't
291 		 * need to restart the autonegotiation process.  Read
292 		 * the BMSR twice in case it's latched.
293 		 */
294 		reg = PHY_READ(sc, MII_BMSR) |
295 		    PHY_READ(sc, MII_BMSR);
296 		if (reg & BMSR_LINK)
297 			return (0);
298 
299 		/*
300 		 * Only retry autonegotiation every 5 seconds.
301 		 */
302 		if (++sc->mii_ticks != 5)
303 			return (0);
304 
305 		sc->mii_ticks = 0;
306 		mii_phy_reset(sc);
307 		if (mii_phy_auto(sc, 0) == EJUSTRETURN)
308 			return (0);
309 		break;
310 	}
311 
312 	/* Update the media status. */
313 	lxtphy_status(sc);
314 
315 	/* Callback if something changed. */
316 	if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
317 		MIIBUS_STATCHG(sc->mii_dev);
318 		sc->mii_active = mii->mii_media_active;
319 	}
320 	return (0);
321 }
322 
323 static void
324 lxtphy_status(sc)
325 	struct mii_softc *sc;
326 {
327 	struct mii_data *mii = sc->mii_pdata;
328 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
329 	int bmcr, bmsr, csr;
330 
331 	mii->mii_media_status = IFM_AVALID;
332 	mii->mii_media_active = IFM_ETHER;
333 
334 	/*
335 	 * Get link status from the CSR; we need to read the CSR
336 	 * for media type anyhow, and the link status in the CSR
337 	 * doens't latch, so fewer register reads are required.
338 	 */
339 	csr = PHY_READ(sc, MII_LXTPHY_CSR);
340 	if (csr & CSR_LINK)
341 		mii->mii_media_status |= IFM_ACTIVE;
342 
343 	bmcr = PHY_READ(sc, MII_BMCR);
344 	if (bmcr & BMCR_ISO) {
345 		mii->mii_media_active |= IFM_NONE;
346 		mii->mii_media_status = 0;
347 		return;
348 	}
349 
350 	if (bmcr & BMCR_LOOP)
351 		mii->mii_media_active |= IFM_LOOP;
352 
353 	if (bmcr & BMCR_AUTOEN) {
354 		bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
355 		if ((bmsr & BMSR_ACOMP) == 0) {
356 			/* Erg, still trying, I guess... */
357 			mii->mii_media_active |= IFM_NONE;
358 			return;
359 		}
360 		if (csr & CSR_SPEED)
361 			mii->mii_media_active |= IFM_100_TX;
362 		else
363 			mii->mii_media_active |= IFM_10_T;
364 		if (csr & CSR_DUPLEX)
365 			mii->mii_media_active |= IFM_FDX;
366 	} else
367 		mii->mii_media_active = ife->ifm_media;
368 }
369 
370 static void
371 lxtphy_set_tp(sc)
372 	struct mii_softc *sc;
373 {
374 	int cfg;
375 
376 	cfg = PHY_READ(sc, MII_LXTPHY_CONFIG);
377 	cfg &= ~CONFIG_100BASEFX;
378 	PHY_WRITE(sc, MII_LXTPHY_CONFIG, cfg);
379 }
380 
381 static void
382 lxtphy_set_fx(sc)
383 	struct mii_softc *sc;
384 {
385 	int cfg;
386 
387 	cfg = PHY_READ(sc, MII_LXTPHY_CONFIG);
388 	cfg |= CONFIG_100BASEFX;
389 	PHY_WRITE(sc, MII_LXTPHY_CONFIG, cfg);
390 }
391 
392