xref: /freebsd/sys/dev/mii/brgphy.c (revision 42c159fe388a3765f69860c84183700af37aca8a)
1 /*
2  * Copyright (c) 2000
3  *	Bill Paul <wpaul@ee.columbia.edu>.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by Bill Paul.
16  * 4. Neither the name of the author nor the names of any co-contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
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
30  * THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * $FreeBSD$
33  */
34 
35 /*
36  * Driver for the Broadcom BCR5400 1000baseTX PHY. Speed is always
37  * 1000mbps; all we need to negotiate here is full or half duplex.
38  */
39 
40 #include <sys/param.h>
41 #include <sys/systm.h>
42 #include <sys/kernel.h>
43 #include <sys/malloc.h>
44 #include <sys/socket.h>
45 #include <sys/bus.h>
46 
47 #include <machine/clock.h>
48 
49 #include <net/if.h>
50 #include <net/if_media.h>
51 
52 #include <dev/mii/mii.h>
53 #include <dev/mii/miivar.h>
54 #include <dev/mii/miidevs.h>
55 
56 #include <dev/mii/brgphyreg.h>
57 
58 #include "miibus_if.h"
59 
60 #if !defined(lint)
61 static const char rcsid[] =
62   "$FreeBSD$";
63 #endif
64 
65 static int brgphy_probe		(device_t);
66 static int brgphy_attach		(device_t);
67 static int brgphy_detach		(device_t);
68 
69 static device_method_t brgphy_methods[] = {
70 	/* device interface */
71 	DEVMETHOD(device_probe,		brgphy_probe),
72 	DEVMETHOD(device_attach,	brgphy_attach),
73 	DEVMETHOD(device_detach,	brgphy_detach),
74 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
75 	{ 0, 0 }
76 };
77 
78 static devclass_t brgphy_devclass;
79 
80 static driver_t brgphy_driver = {
81 	"brgphy",
82 	brgphy_methods,
83 	sizeof(struct mii_softc)
84 };
85 
86 DRIVER_MODULE(brgphy, miibus, brgphy_driver, brgphy_devclass, 0, 0);
87 
88 static int	brgphy_service(struct mii_softc *, struct mii_data *, int);
89 static void	brgphy_status(struct mii_softc *);
90 static int	brgphy_mii_phy_auto(struct mii_softc *, int);
91 extern void	mii_phy_auto_timeout(void *);
92 
93 static int brgphy_probe(dev)
94 	device_t		dev;
95 {
96 	struct mii_attach_args *ma;
97 
98 	ma = device_get_ivars(dev);
99 
100 	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxBROADCOM &&
101 	    MII_MODEL(ma->mii_id2) == MII_MODEL_xxBROADCOM_BCM5400) {
102 		device_set_desc(dev, MII_STR_xxBROADCOM_BCM5400);
103 		return(0);
104 	}
105 
106 	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxBROADCOM &&
107 	    MII_MODEL(ma->mii_id2) == MII_MODEL_xxBROADCOM_BCM5401) {
108 		device_set_desc(dev, MII_STR_xxBROADCOM_BCM5401);
109 		return(0);
110 	}
111 
112 	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxBROADCOM &&
113 	    MII_MODEL(ma->mii_id2) == MII_MODEL_xxBROADCOM_BCM5411) {
114 		device_set_desc(dev, MII_STR_xxBROADCOM_BCM5411);
115 		return(0);
116 	}
117 
118 	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxBROADCOM &&
119 	    MII_MODEL(ma->mii_id2) == MII_MODEL_xxBROADCOM_BCM5701) {
120 		device_set_desc(dev, MII_STR_xxBROADCOM_BCM5701);
121 		return(0);
122 	}
123 
124 	return(ENXIO);
125 }
126 
127 static int brgphy_attach(dev)
128 	device_t		dev;
129 {
130 	struct mii_softc *sc;
131 	struct mii_attach_args *ma;
132 	struct mii_data *mii;
133 	const char *sep = "";
134 
135 	sc = device_get_softc(dev);
136 	ma = device_get_ivars(dev);
137 	sc->mii_dev = device_get_parent(dev);
138 	mii = device_get_softc(sc->mii_dev);
139 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
140 
141 	sc->mii_inst = mii->mii_instance;
142 	sc->mii_phy = ma->mii_phyno;
143 	sc->mii_service = brgphy_service;
144 	sc->mii_pdata = mii;
145 
146 	sc->mii_flags |= MIIF_NOISOLATE;
147 	mii->mii_instance++;
148 
149 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
150 #define PRINT(s)	printf("%s%s", sep, s); sep = ", "
151 
152 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
153 	    BMCR_ISO);
154 #if 0
155 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
156 	    BMCR_LOOP|BMCR_S100);
157 #endif
158 
159 	mii_phy_reset(sc);
160 
161 
162 	sc->mii_capabilities =
163 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
164 	device_printf(dev, " ");
165 	if (sc->mii_capabilities & BMSR_MEDIAMASK)
166 		mii_add_media(mii, (sc->mii_capabilities & ~BMSR_ANEG),
167 		    sc->mii_inst);
168 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_TX, 0, sc->mii_inst),
169 	    BRGPHY_BMCR_FDX);
170 	PRINT(", 1000baseTX");
171 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_TX, IFM_FDX, sc->mii_inst), 0);
172 	PRINT("1000baseTX-FDX");
173 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, sc->mii_inst), 0);
174 	PRINT("auto");
175 
176 	printf("\n");
177 #undef ADD
178 #undef PRINT
179 
180 	MIIBUS_MEDIAINIT(sc->mii_dev);
181 	return(0);
182 }
183 
184 static int brgphy_detach(dev)
185 	device_t		dev;
186 {
187 	struct mii_softc *sc;
188 	struct mii_data *mii;
189 
190 	sc = device_get_softc(dev);
191 	mii = device_get_softc(device_get_parent(dev));
192 	if (sc->mii_flags & MIIF_DOINGAUTO)
193 		untimeout(mii_phy_auto_timeout, sc, sc->mii_auto_ch);
194 
195 	sc->mii_dev = NULL;
196 	LIST_REMOVE(sc, mii_list);
197 
198 	return(0);
199 }
200 
201 static int
202 brgphy_service(sc, mii, cmd)
203 	struct mii_softc *sc;
204 	struct mii_data *mii;
205 	int cmd;
206 {
207 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
208 	int reg, speed;
209 
210 	switch (cmd) {
211 	case MII_POLLSTAT:
212 		/*
213 		 * If we're not polling our PHY instance, just return.
214 		 */
215 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
216 			return (0);
217 		break;
218 
219 	case MII_MEDIACHG:
220 		/*
221 		 * If the media indicates a different PHY instance,
222 		 * isolate ourselves.
223 		 */
224 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
225 			reg = PHY_READ(sc, MII_BMCR);
226 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
227 			return (0);
228 		}
229 
230 		/*
231 		 * If the interface is not up, don't do anything.
232 		 */
233 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
234 			break;
235 
236 		PHY_WRITE(sc, BRGPHY_MII_PHY_EXTCTL,
237 		    BRGPHY_PHY_EXTCTL_HIGH_LA|BRGPHY_PHY_EXTCTL_EN_LTR);
238 		PHY_WRITE(sc, BRGPHY_MII_AUXCTL,
239 		    BRGPHY_AUXCTL_LONG_PKT|BRGPHY_AUXCTL_TX_TST);
240 		PHY_WRITE(sc, BRGPHY_MII_IMR, 0xFF00);
241 
242 		switch (IFM_SUBTYPE(ife->ifm_media)) {
243 		case IFM_AUTO:
244 #ifdef foo
245 			/*
246 			 * If we're already in auto mode, just return.
247 			 */
248 			if (PHY_READ(sc, BRGPHY_MII_BMCR) & BRGPHY_BMCR_AUTOEN)
249 				return (0);
250 #endif
251 			(void) brgphy_mii_phy_auto(sc, 1);
252 			break;
253 		case IFM_1000_TX:
254 			speed = BRGPHY_S1000;
255 			goto setit;
256 		case IFM_100_TX:
257 			speed = BRGPHY_S100;
258 			goto setit;
259 		case IFM_10_T:
260 			speed = BRGPHY_S10;
261 setit:
262 			if ((ife->ifm_media & IFM_GMASK) == IFM_FDX) {
263 				PHY_WRITE(sc, BRGPHY_MII_BMCR,
264 				    BRGPHY_BMCR_FDX|speed);
265 			} else {
266 				PHY_WRITE(sc, BRGPHY_MII_BMCR, speed);
267 			}
268 			PHY_WRITE(sc, BRGPHY_MII_ANAR, BRGPHY_SEL_TYPE);
269 
270 			if (IFM_SUBTYPE(ife->ifm_media) != IFM_1000_TX)
271 				break;
272 
273 			/*
274 			 * When settning the link manually, one side must
275 			 * be the master and the other the slave. However
276 			 * ifmedia doesn't give us a good way to specify
277 			 * this, so we fake it by using one of the LINK
278 			 * flags. If LINK0 is set, we program the PHY to
279 			 * be a master, otherwise it's a slave.
280 			 */
281 			if ((mii->mii_ifp->if_flags & IFF_LINK0)) {
282 				PHY_WRITE(sc, BRGPHY_MII_1000CTL,
283 				    BRGPHY_1000CTL_MSE|BRGPHY_1000CTL_MSC);
284 			} else {
285 				PHY_WRITE(sc, BRGPHY_MII_1000CTL,
286 				    BRGPHY_1000CTL_MSE);
287 			}
288 			break;
289 #ifdef foo
290 		case IFM_NONE:
291 			PHY_WRITE(sc, MII_BMCR, BMCR_ISO|BMCR_PDOWN);
292 			break;
293 #endif
294 		case IFM_100_T4:
295 		default:
296 			return (EINVAL);
297 		}
298 		break;
299 
300 	case MII_TICK:
301 		/*
302 		 * If we're not currently selected, just return.
303 		 */
304 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
305 			return (0);
306 
307 		/*
308 		 * Is the interface even up?
309 		 */
310 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
311 			return (0);
312 
313 		/*
314 		 * Only used for autonegotiation.
315 		 */
316 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
317 			break;
318 
319 		/*
320 		 * Check to see if we have link.  If we do, we don't
321 		 * need to restart the autonegotiation process.  Read
322 		 * the BMSR twice in case it's latched.
323 		 */
324 		reg = PHY_READ(sc, BRGPHY_MII_AUXSTS);
325 		if (reg & BRGPHY_AUXSTS_LINK)
326 			break;
327 
328 		/*
329 		 * Only retry autonegotiation every 5 seconds.
330 		 */
331 		if (++sc->mii_ticks != 5)
332 			return (0);
333 
334 		sc->mii_ticks = 0;
335 		mii_phy_reset(sc);
336 		if (brgphy_mii_phy_auto(sc, 0) == EJUSTRETURN)
337 			return (0);
338 		break;
339 	}
340 
341 	/* Update the media status. */
342 	brgphy_status(sc);
343 
344 	/* Callback if something changed. */
345 	mii_phy_update(sc, cmd);
346 	return (0);
347 }
348 
349 static void
350 brgphy_status(sc)
351 	struct mii_softc *sc;
352 {
353 	struct mii_data *mii = sc->mii_pdata;
354 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
355 	int bmsr, bmcr;
356 
357 	mii->mii_media_status = IFM_AVALID;
358 	mii->mii_media_active = IFM_ETHER;
359 
360 	bmsr = PHY_READ(sc, BRGPHY_MII_BMSR);
361 	if (PHY_READ(sc, BRGPHY_MII_AUXSTS) & BRGPHY_AUXSTS_LINK)
362 		mii->mii_media_status |= IFM_ACTIVE;
363 
364 	bmcr = PHY_READ(sc, BRGPHY_MII_BMCR);
365 
366 	if (bmcr & BRGPHY_BMCR_LOOP)
367 		mii->mii_media_active |= IFM_LOOP;
368 
369 	if (bmcr & BRGPHY_BMCR_AUTOEN) {
370 		if ((bmsr & BRGPHY_BMSR_ACOMP) == 0) {
371 			/* Erg, still trying, I guess... */
372 			mii->mii_media_active |= IFM_NONE;
373 			return;
374 		}
375 
376 		switch (PHY_READ(sc, BRGPHY_MII_AUXSTS) &
377 		    BRGPHY_AUXSTS_AN_RES) {
378 		case BRGPHY_RES_1000FD:
379 			mii->mii_media_active |= IFM_1000_TX | IFM_FDX;
380 			break;
381 		case BRGPHY_RES_1000HD:
382 			mii->mii_media_active |= IFM_1000_TX | IFM_HDX;
383 			break;
384 		case BRGPHY_RES_100FD:
385 			mii->mii_media_active |= IFM_100_TX | IFM_FDX;
386 			break;
387 		case BRGPHY_RES_100T4:
388 			mii->mii_media_active |= IFM_100_T4;
389 			break;
390 		case BRGPHY_RES_100HD:
391 			mii->mii_media_active |= IFM_100_TX | IFM_HDX;
392 			break;
393 		case BRGPHY_RES_10FD:
394 			mii->mii_media_active |= IFM_10_T | IFM_FDX;
395 			break;
396 		case BRGPHY_RES_10HD:
397 			mii->mii_media_active |= IFM_10_T | IFM_HDX;
398 			break;
399 		default:
400 			mii->mii_media_active |= IFM_NONE;
401 			break;
402 		}
403 		return;
404 	}
405 
406 	mii->mii_media_active = ife->ifm_media;
407 
408 	return;
409 }
410 
411 
412 static int
413 brgphy_mii_phy_auto(mii, waitfor)
414 	struct mii_softc *mii;
415 	int waitfor;
416 {
417 	int bmsr, ktcr = 0, i;
418 
419 	if ((mii->mii_flags & MIIF_DOINGAUTO) == 0) {
420 		mii_phy_reset(mii);
421 		PHY_WRITE(mii, BRGPHY_MII_BMCR, 0);
422 		DELAY(1000);
423 		ktcr = PHY_READ(mii, BRGPHY_MII_1000CTL);
424 		PHY_WRITE(mii, BRGPHY_MII_1000CTL, ktcr |
425 		    BRGPHY_1000CTL_AFD|BRGPHY_1000CTL_AHD);
426 		ktcr = PHY_READ(mii, BRGPHY_MII_1000CTL);
427 		DELAY(1000);
428 		PHY_WRITE(mii, BRGPHY_MII_ANAR,
429 		    BMSR_MEDIA_TO_ANAR(mii->mii_capabilities) | ANAR_CSMA);
430 		DELAY(1000);
431 		PHY_WRITE(mii, BRGPHY_MII_BMCR,
432 		    BRGPHY_BMCR_AUTOEN | BRGPHY_BMCR_STARTNEG);
433 		PHY_WRITE(mii, BRGPHY_MII_IMR, 0xFF00);
434 	}
435 
436 	if (waitfor) {
437 		/* Wait 500ms for it to complete. */
438 		for (i = 0; i < 500; i++) {
439 			if ((bmsr = PHY_READ(mii, BRGPHY_MII_BMSR)) &
440 			    BRGPHY_BMSR_ACOMP)
441 				return (0);
442 			DELAY(1000);
443 #if 0
444 		if ((bmsr & BMSR_ACOMP) == 0)
445 			printf("%s: autonegotiation failed to complete\n",
446 			    mii->mii_dev.dv_xname);
447 #endif
448 		}
449 
450 		/*
451 		 * Don't need to worry about clearing MIIF_DOINGAUTO.
452 		 * If that's set, a timeout is pending, and it will
453 		 * clear the flag.
454 		 */
455 		return (EIO);
456 	}
457 
458 	/*
459 	 * Just let it finish asynchronously.  This is for the benefit of
460 	 * the tick handler driving autonegotiation.  Don't want 500ms
461 	 * delays all the time while the system is running!
462 	 */
463 	if ((mii->mii_flags & MIIF_DOINGAUTO) == 0) {
464 		mii->mii_flags |= MIIF_DOINGAUTO;
465 		mii->mii_auto_ch = timeout(mii_phy_auto_timeout, mii, hz >> 1);
466 	}
467 	return (EJUSTRETURN);
468 }
469