xref: /dflybsd-src/sys/dev/netif/mii_layer/lxtphy.c (revision 39b5d600dedf02a61b8b1213f9fdaaee4b8292e0)
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.7 2005/10/24 16:55:40 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, ma);
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_service = lxtphy_service;
157 	sc->mii_pdata = mii;
158 	sc->mii_flags |= MIIF_NOISOLATE;
159 
160 	mii_phy_reset(sc);
161 
162 	mii->mii_instance++;
163 
164 	sc->mii_capabilities =
165 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
166 	device_printf(dev, " ");
167 
168 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
169 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
170 	    BMCR_ISO);
171 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_FX, 0, sc->mii_inst),
172 	    BMCR_S100);
173 	printf("100baseFX, ");
174 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_FX, IFM_FDX, sc->mii_inst),
175 	    BMCR_S100|BMCR_FDX);
176 	printf("100baseFX-FDX, ");
177 #undef ADD
178 
179 	if (sc->mii_capabilities & BMSR_MEDIAMASK)
180 		mii_add_media(sc, sc->mii_capabilities);
181 	printf("\n");
182 
183 	MIIBUS_MEDIAINIT(sc->mii_dev);
184 	return(0);
185 }
186 
187 
188 static int lxtphy_detach(dev)
189 	device_t		dev;
190 {
191 	struct mii_softc *sc;
192 	struct mii_data *mii;
193 
194 	sc = device_get_softc(dev);
195 	mii = device_get_softc(device_get_parent(dev));
196 	sc->mii_dev = NULL;
197 	LIST_REMOVE(sc, mii_list);
198 
199 	return(0);
200 }
201 
202 static int
203 lxtphy_service(sc, mii, cmd)
204 	struct mii_softc *sc;
205 	struct mii_data *mii;
206 	int cmd;
207 {
208 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
209 	int reg;
210 
211 	switch (cmd) {
212 	case MII_POLLSTAT:
213 		/*
214 		 * If we're not polling our PHY instance, just return.
215 		 */
216 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
217 			return (0);
218 		break;
219 
220 	case MII_MEDIACHG:
221 		/*
222 		 * If the media indicates a different PHY instance,
223 		 * isolate ourselves.
224 		 */
225 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
226 			reg = PHY_READ(sc, MII_BMCR);
227 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
228 			return (0);
229 		}
230 
231 		/*
232 		 * If the interface is not up, don't do anything.
233 		 */
234 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
235 			break;
236 
237 		switch (IFM_SUBTYPE(ife->ifm_media)) {
238 		case IFM_AUTO:
239 			/*
240 			 * If we're already in auto mode, just return.
241 			 */
242 			if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
243 				return (0);
244 
245 			lxtphy_set_tp(sc);
246 
247 			(void) mii_phy_auto(sc, 1);
248 			break;
249 		case IFM_100_T4:
250 			/*
251 			 * XXX Not supported as a manual setting right now.
252 			 */
253 			return (EINVAL);
254 
255 		case IFM_100_FX:
256 			lxtphy_set_fx(sc);
257 
258 		default:
259 			/*
260 			 * BMCR data is stored in the ifmedia entry.
261 			 */
262 			PHY_WRITE(sc, MII_ANAR,
263 			    mii_anar(ife->ifm_media));
264 			PHY_WRITE(sc, MII_BMCR, ife->ifm_data);
265 		}
266 		break;
267 
268 	case MII_TICK:
269 		/*
270 		 * If we're not currently selected, just return.
271 		 */
272 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
273 			return (0);
274 
275 		/*
276 		 * Only used for autonegotiation.
277 		 */
278 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
279 			return (0);
280 
281 		/*
282 		 * Is the interface even up?
283 		 */
284 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
285 			return (0);
286 
287 		/*
288 		 * Check to see if we have link.  If we do, we don't
289 		 * need to restart the autonegotiation process.  Read
290 		 * the BMSR twice in case it's latched.
291 		 */
292 		reg = PHY_READ(sc, MII_BMSR) |
293 		    PHY_READ(sc, MII_BMSR);
294 		if (reg & BMSR_LINK)
295 			return (0);
296 
297 		/*
298 		 * Only retry autonegotiation every 5 seconds.
299 		 */
300 		if (++sc->mii_ticks != 5)
301 			return (0);
302 
303 		sc->mii_ticks = 0;
304 		mii_phy_reset(sc);
305 		if (mii_phy_auto(sc, 0) == EJUSTRETURN)
306 			return (0);
307 		break;
308 	}
309 
310 	/* Update the media status. */
311 	lxtphy_status(sc);
312 
313 	/* Callback if something changed. */
314 	if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
315 		MIIBUS_STATCHG(sc->mii_dev);
316 		sc->mii_active = mii->mii_media_active;
317 	}
318 	return (0);
319 }
320 
321 static void
322 lxtphy_status(sc)
323 	struct mii_softc *sc;
324 {
325 	struct mii_data *mii = sc->mii_pdata;
326 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
327 	int bmcr, bmsr, csr;
328 
329 	mii->mii_media_status = IFM_AVALID;
330 	mii->mii_media_active = IFM_ETHER;
331 
332 	/*
333 	 * Get link status from the CSR; we need to read the CSR
334 	 * for media type anyhow, and the link status in the CSR
335 	 * doens't latch, so fewer register reads are required.
336 	 */
337 	csr = PHY_READ(sc, MII_LXTPHY_CSR);
338 	if (csr & CSR_LINK)
339 		mii->mii_media_status |= IFM_ACTIVE;
340 
341 	bmcr = PHY_READ(sc, MII_BMCR);
342 	if (bmcr & BMCR_ISO) {
343 		mii->mii_media_active |= IFM_NONE;
344 		mii->mii_media_status = 0;
345 		return;
346 	}
347 
348 	if (bmcr & BMCR_LOOP)
349 		mii->mii_media_active |= IFM_LOOP;
350 
351 	if (bmcr & BMCR_AUTOEN) {
352 		bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
353 		if ((bmsr & BMSR_ACOMP) == 0) {
354 			/* Erg, still trying, I guess... */
355 			mii->mii_media_active |= IFM_NONE;
356 			return;
357 		}
358 		if (csr & CSR_SPEED)
359 			mii->mii_media_active |= IFM_100_TX;
360 		else
361 			mii->mii_media_active |= IFM_10_T;
362 		if (csr & CSR_DUPLEX)
363 			mii->mii_media_active |= IFM_FDX;
364 	} else
365 		mii->mii_media_active = ife->ifm_media;
366 }
367 
368 static void
369 lxtphy_set_tp(sc)
370 	struct mii_softc *sc;
371 {
372 	int cfg;
373 
374 	cfg = PHY_READ(sc, MII_LXTPHY_CONFIG);
375 	cfg &= ~CONFIG_100BASEFX;
376 	PHY_WRITE(sc, MII_LXTPHY_CONFIG, cfg);
377 }
378 
379 static void
380 lxtphy_set_fx(sc)
381 	struct mii_softc *sc;
382 {
383 	int cfg;
384 
385 	cfg = PHY_READ(sc, MII_LXTPHY_CONFIG);
386 	cfg |= CONFIG_100BASEFX;
387 	PHY_WRITE(sc, MII_LXTPHY_CONFIG, cfg);
388 }
389 
390