xref: /freebsd/sys/dev/mii/brgphy.c (revision 41466b50c1d5bfd1cf6adaae547a579a75d7c04e)
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		__P((device_t));
66 static int brgphy_attach		__P((device_t));
67 static int brgphy_detach		__P((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 __P((struct mii_softc *, int));
91 extern void	mii_phy_auto_timeout __P((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 	return(ENXIO);
119 }
120 
121 static int brgphy_attach(dev)
122 	device_t		dev;
123 {
124 	struct mii_softc *sc;
125 	struct mii_attach_args *ma;
126 	struct mii_data *mii;
127 	const char *sep = "";
128 
129 	sc = device_get_softc(dev);
130 	ma = device_get_ivars(dev);
131 	sc->mii_dev = device_get_parent(dev);
132 	mii = device_get_softc(sc->mii_dev);
133 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
134 
135 	sc->mii_inst = mii->mii_instance;
136 	sc->mii_phy = ma->mii_phyno;
137 	sc->mii_service = brgphy_service;
138 	sc->mii_pdata = mii;
139 
140 	sc->mii_flags |= MIIF_NOISOLATE;
141 	mii->mii_instance++;
142 
143 #define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
144 #define PRINT(s)	printf("%s%s", sep, s); sep = ", "
145 
146 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
147 	    BMCR_ISO);
148 #if 0
149 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
150 	    BMCR_LOOP|BMCR_S100);
151 #endif
152 
153 	mii_phy_reset(sc);
154 
155 
156 	sc->mii_capabilities =
157 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
158 	device_printf(dev, " ");
159 	if (sc->mii_capabilities & BMSR_MEDIAMASK)
160 		mii_add_media(mii, (sc->mii_capabilities & ~BMSR_ANEG),
161 		    sc->mii_inst);
162 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_TX, 0, sc->mii_inst),
163 	    BRGPHY_BMCR_FDX);
164 	PRINT(", 1000baseTX");
165 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_TX, IFM_FDX, sc->mii_inst), 0);
166 	PRINT("1000baseTX-FDX");
167 	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, sc->mii_inst), 0);
168 	PRINT("auto");
169 
170 	printf("\n");
171 #undef ADD
172 #undef PRINT
173 
174 	MIIBUS_MEDIAINIT(sc->mii_dev);
175 	return(0);
176 }
177 
178 static int brgphy_detach(dev)
179 	device_t		dev;
180 {
181 	struct mii_softc *sc;
182 	struct mii_data *mii;
183 
184 	sc = device_get_softc(dev);
185 	mii = device_get_softc(device_get_parent(dev));
186 	if (sc->mii_flags & MIIF_DOINGAUTO)
187 		untimeout(mii_phy_auto_timeout, sc, sc->mii_auto_ch);
188 
189 	sc->mii_dev = NULL;
190 	LIST_REMOVE(sc, mii_list);
191 
192 	return(0);
193 }
194 
195 static int
196 brgphy_service(sc, mii, cmd)
197 	struct mii_softc *sc;
198 	struct mii_data *mii;
199 	int cmd;
200 {
201 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
202 	int reg, speed;
203 
204 	switch (cmd) {
205 	case MII_POLLSTAT:
206 		/*
207 		 * If we're not polling our PHY instance, just return.
208 		 */
209 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
210 			return (0);
211 		break;
212 
213 	case MII_MEDIACHG:
214 		/*
215 		 * If the media indicates a different PHY instance,
216 		 * isolate ourselves.
217 		 */
218 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
219 			reg = PHY_READ(sc, MII_BMCR);
220 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
221 			return (0);
222 		}
223 
224 		/*
225 		 * If the interface is not up, don't do anything.
226 		 */
227 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
228 			break;
229 
230 		PHY_WRITE(sc, BRGPHY_MII_PHY_EXTCTL,
231 		    BRGPHY_PHY_EXTCTL_HIGH_LA|BRGPHY_PHY_EXTCTL_EN_LTR);
232 		PHY_WRITE(sc, BRGPHY_MII_AUXCTL,
233 		    BRGPHY_AUXCTL_LONG_PKT|BRGPHY_AUXCTL_TX_TST);
234 		PHY_WRITE(sc, BRGPHY_MII_IMR, 0xFF00);
235 
236 		switch (IFM_SUBTYPE(ife->ifm_media)) {
237 		case IFM_AUTO:
238 #ifdef foo
239 			/*
240 			 * If we're already in auto mode, just return.
241 			 */
242 			if (PHY_READ(sc, BRGPHY_MII_BMCR) & BRGPHY_BMCR_AUTOEN)
243 				return (0);
244 #endif
245 			(void) brgphy_mii_phy_auto(sc, 1);
246 			break;
247 		case IFM_1000_TX:
248 			speed = BRGPHY_S1000;
249 			goto setit;
250 		case IFM_100_TX:
251 			speed = BRGPHY_S100;
252 			goto setit;
253 		case IFM_10_T:
254 			speed = BRGPHY_S10;
255 setit:
256 			if ((ife->ifm_media & IFM_GMASK) == IFM_FDX) {
257 				PHY_WRITE(sc, BRGPHY_MII_BMCR,
258 				    BRGPHY_BMCR_FDX|speed);
259 			} else {
260 				PHY_WRITE(sc, BRGPHY_MII_BMCR, speed);
261 			}
262 			PHY_WRITE(sc, BRGPHY_MII_ANAR, BRGPHY_SEL_TYPE);
263 
264 			if (IFM_SUBTYPE(ife->ifm_media) != IFM_1000_TX)
265 				break;
266 
267 			/*
268 			 * When settning the link manually, one side must
269 			 * be the master and the other the slave. However
270 			 * ifmedia doesn't give us a good way to specify
271 			 * this, so we fake it by using one of the LINK
272 			 * flags. If LINK0 is set, we program the PHY to
273 			 * be a master, otherwise it's a slave.
274 			 */
275 			if ((mii->mii_ifp->if_flags & IFF_LINK0)) {
276 				PHY_WRITE(sc, BRGPHY_MII_1000CTL,
277 				    BRGPHY_1000CTL_MSE|BRGPHY_1000CTL_MSC);
278 			} else {
279 				PHY_WRITE(sc, BRGPHY_MII_1000CTL,
280 				    BRGPHY_1000CTL_MSE);
281 			}
282 			break;
283 #ifdef foo
284 		case IFM_NONE:
285 			PHY_WRITE(sc, MII_BMCR, BMCR_ISO|BMCR_PDOWN);
286 			break;
287 #endif
288 		case IFM_100_T4:
289 		default:
290 			return (EINVAL);
291 		}
292 		break;
293 
294 	case MII_TICK:
295 		/*
296 		 * If we're not currently selected, just return.
297 		 */
298 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
299 			return (0);
300 
301 		/*
302 		 * Is the interface even up?
303 		 */
304 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
305 			return (0);
306 
307 		/*
308 		 * Only used for autonegotiation.
309 		 */
310 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
311 			break;
312 
313 		/*
314 		 * Check to see if we have link.  If we do, we don't
315 		 * need to restart the autonegotiation process.  Read
316 		 * the BMSR twice in case it's latched.
317 		 */
318 		reg = PHY_READ(sc, BRGPHY_MII_AUXSTS);
319 		if (reg & BRGPHY_AUXSTS_LINK)
320 			break;
321 
322 		/*
323 		 * Only retry autonegotiation every 5 seconds.
324 		 */
325 		if (++sc->mii_ticks != 5)
326 			return (0);
327 
328 		sc->mii_ticks = 0;
329 		mii_phy_reset(sc);
330 		if (brgphy_mii_phy_auto(sc, 0) == EJUSTRETURN)
331 			return (0);
332 		break;
333 	}
334 
335 	/* Update the media status. */
336 	brgphy_status(sc);
337 
338 	/* Callback if something changed. */
339 	mii_phy_update(sc, cmd);
340 	return (0);
341 }
342 
343 static void
344 brgphy_status(sc)
345 	struct mii_softc *sc;
346 {
347 	struct mii_data *mii = sc->mii_pdata;
348 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
349 	int bmsr, bmcr;
350 
351 	mii->mii_media_status = IFM_AVALID;
352 	mii->mii_media_active = IFM_ETHER;
353 
354 	bmsr = PHY_READ(sc, BRGPHY_MII_BMSR);
355 	if (PHY_READ(sc, BRGPHY_MII_AUXSTS) & BRGPHY_AUXSTS_LINK)
356 		mii->mii_media_status |= IFM_ACTIVE;
357 
358 	bmcr = PHY_READ(sc, BRGPHY_MII_BMCR);
359 
360 	if (bmcr & BRGPHY_BMCR_LOOP)
361 		mii->mii_media_active |= IFM_LOOP;
362 
363 	if (bmcr & BRGPHY_BMCR_AUTOEN) {
364 		if ((bmsr & BRGPHY_BMSR_ACOMP) == 0) {
365 			/* Erg, still trying, I guess... */
366 			mii->mii_media_active |= IFM_NONE;
367 			return;
368 		}
369 
370 		switch (PHY_READ(sc, BRGPHY_MII_AUXSTS) &
371 		    BRGPHY_AUXSTS_AN_RES) {
372 		case BRGPHY_RES_1000FD:
373 			mii->mii_media_active |= IFM_1000_TX | IFM_FDX;
374 			break;
375 		case BRGPHY_RES_1000HD:
376 			mii->mii_media_active |= IFM_1000_TX | IFM_HDX;
377 			break;
378 		case BRGPHY_RES_100FD:
379 			mii->mii_media_active |= IFM_100_TX | IFM_FDX;
380 			break;
381 		case BRGPHY_RES_100T4:
382 			mii->mii_media_active |= IFM_100_T4;
383 			break;
384 		case BRGPHY_RES_100HD:
385 			mii->mii_media_active |= IFM_100_TX | IFM_HDX;
386 			break;
387 		case BRGPHY_RES_10FD:
388 			mii->mii_media_active |= IFM_10_T | IFM_FDX;
389 			break;
390 		case BRGPHY_RES_10HD:
391 			mii->mii_media_active |= IFM_10_T | IFM_HDX;
392 			break;
393 		default:
394 			mii->mii_media_active |= IFM_NONE;
395 			break;
396 		}
397 		return;
398 	}
399 
400 	mii->mii_media_active = ife->ifm_media;
401 
402 	return;
403 }
404 
405 
406 static int
407 brgphy_mii_phy_auto(mii, waitfor)
408 	struct mii_softc *mii;
409 	int waitfor;
410 {
411 	int bmsr, ktcr = 0, i;
412 
413 	if ((mii->mii_flags & MIIF_DOINGAUTO) == 0) {
414 		mii_phy_reset(mii);
415 		PHY_WRITE(mii, BRGPHY_MII_BMCR, 0);
416 		DELAY(1000);
417 		ktcr = PHY_READ(mii, BRGPHY_MII_1000CTL);
418 		PHY_WRITE(mii, BRGPHY_MII_1000CTL, ktcr |
419 		    BRGPHY_1000CTL_AFD|BRGPHY_1000CTL_AHD);
420 		ktcr = PHY_READ(mii, BRGPHY_MII_1000CTL);
421 		DELAY(1000);
422 		PHY_WRITE(mii, BRGPHY_MII_ANAR,
423 		    BMSR_MEDIA_TO_ANAR(mii->mii_capabilities) | ANAR_CSMA);
424 		DELAY(1000);
425 		PHY_WRITE(mii, BRGPHY_MII_BMCR,
426 		    BRGPHY_BMCR_AUTOEN | BRGPHY_BMCR_STARTNEG);
427 		PHY_WRITE(mii, BRGPHY_MII_IMR, 0xFF00);
428 	}
429 
430 	if (waitfor) {
431 		/* Wait 500ms for it to complete. */
432 		for (i = 0; i < 500; i++) {
433 			if ((bmsr = PHY_READ(mii, BRGPHY_MII_BMSR)) &
434 			    BRGPHY_BMSR_ACOMP)
435 				return (0);
436 			DELAY(1000);
437 #if 0
438 		if ((bmsr & BMSR_ACOMP) == 0)
439 			printf("%s: autonegotiation failed to complete\n",
440 			    mii->mii_dev.dv_xname);
441 #endif
442 		}
443 
444 		/*
445 		 * Don't need to worry about clearing MIIF_DOINGAUTO.
446 		 * If that's set, a timeout is pending, and it will
447 		 * clear the flag.
448 		 */
449 		return (EIO);
450 	}
451 
452 	/*
453 	 * Just let it finish asynchronously.  This is for the benefit of
454 	 * the tick handler driving autonegotiation.  Don't want 500ms
455 	 * delays all the time while the system is running!
456 	 */
457 	if ((mii->mii_flags & MIIF_DOINGAUTO) == 0) {
458 		mii->mii_flags |= MIIF_DOINGAUTO;
459 		mii->mii_auto_ch = timeout(mii_phy_auto_timeout, mii, hz >> 1);
460 	}
461 	return (EJUSTRETURN);
462 }
463