brgphy.c revision 83597 
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: head/sys/dev/mii/brgphy.c 83597 2001-09-18 00:31:19Z wpaul $
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)
61static const char rcsid[] =
62  "$FreeBSD: head/sys/dev/mii/brgphy.c 83597 2001-09-18 00:31:19Z wpaul $";
63#endif
64
65static int brgphy_probe		__P((device_t));
66static int brgphy_attach		__P((device_t));
67static int brgphy_detach		__P((device_t));
68
69static 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
78static devclass_t brgphy_devclass;
79
80static driver_t brgphy_driver = {
81	"brgphy",
82	brgphy_methods,
83	sizeof(struct mii_softc)
84};
85
86DRIVER_MODULE(brgphy, miibus, brgphy_driver, brgphy_devclass, 0, 0);
87
88int	brgphy_service __P((struct mii_softc *, struct mii_data *, int));
89void	brgphy_status __P((struct mii_softc *));
90
91static int	brgphy_mii_phy_auto __P((struct mii_softc *, int));
92extern void	mii_phy_auto_timeout __P((void *));
93
94static int brgphy_probe(dev)
95	device_t		dev;
96{
97	struct mii_attach_args *ma;
98
99	ma = device_get_ivars(dev);
100
101	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxBROADCOM &&
102	    MII_MODEL(ma->mii_id2) == MII_MODEL_xxBROADCOM_BCM5400) {
103		device_set_desc(dev, MII_STR_xxBROADCOM_BCM5400);
104		return(0);
105	}
106
107	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxBROADCOM &&
108	    MII_MODEL(ma->mii_id2) == MII_MODEL_xxBROADCOM_BCM5401) {
109		device_set_desc(dev, MII_STR_xxBROADCOM_BCM5401);
110		return(0);
111	}
112
113	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxBROADCOM &&
114	    MII_MODEL(ma->mii_id2) == MII_MODEL_xxBROADCOM_BCM5411) {
115		device_set_desc(dev, MII_STR_xxBROADCOM_BCM5411);
116		return(0);
117	}
118
119	return(ENXIO);
120}
121
122static int brgphy_attach(dev)
123	device_t		dev;
124{
125	struct mii_softc *sc;
126	struct mii_attach_args *ma;
127	struct mii_data *mii;
128	const char *sep = "";
129
130	sc = device_get_softc(dev);
131	ma = device_get_ivars(dev);
132	sc->mii_dev = device_get_parent(dev);
133	mii = device_get_softc(sc->mii_dev);
134	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
135
136	sc->mii_inst = mii->mii_instance;
137	sc->mii_phy = ma->mii_phyno;
138	sc->mii_service = brgphy_service;
139	sc->mii_pdata = mii;
140
141	sc->mii_flags |= MIIF_NOISOLATE;
142	mii->mii_instance++;
143
144#define	ADD(m, c)	ifmedia_add(&mii->mii_media, (m), (c), NULL)
145#define PRINT(s)	printf("%s%s", sep, s); sep = ", "
146
147	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
148	    BMCR_ISO);
149#if 0
150	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_LOOP, sc->mii_inst),
151	    BMCR_LOOP|BMCR_S100);
152#endif
153
154	mii_phy_reset(sc);
155
156
157	sc->mii_capabilities =
158	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
159	device_printf(dev, " ");
160	if (sc->mii_capabilities & BMSR_MEDIAMASK)
161		mii_add_media(mii, (sc->mii_capabilities & ~BMSR_ANEG),
162		    sc->mii_inst);
163	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_TX, 0, sc->mii_inst),
164	    BRGPHY_BMCR_FDX);
165	PRINT(", 1000baseTX");
166	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_TX, IFM_FDX, sc->mii_inst), 0);
167	PRINT("1000baseTX-FDX");
168	ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, sc->mii_inst), 0);
169	PRINT("auto");
170
171	printf("\n");
172#undef ADD
173#undef PRINT
174
175	MIIBUS_MEDIAINIT(sc->mii_dev);
176	return(0);
177}
178
179static int brgphy_detach(dev)
180	device_t		dev;
181{
182	struct mii_softc *sc;
183	struct mii_data *mii;
184
185	sc = device_get_softc(dev);
186	mii = device_get_softc(device_get_parent(dev));
187	if (sc->mii_flags & MIIF_DOINGAUTO)
188		untimeout(mii_phy_auto_timeout, sc, sc->mii_auto_ch);
189
190	sc->mii_dev = NULL;
191	LIST_REMOVE(sc, mii_list);
192
193	return(0);
194}
195int
196brgphy_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;
255setit:
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		 * Only used for autonegotiation.
303		 */
304		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
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 retry autonegotiation every 5 seconds.
315		 */
316		if (++sc->mii_ticks != 5)
317			return (0);
318
319		sc->mii_ticks = 0;
320
321		/*
322		 * Check to see if we have link.  If we do, we don't
323		 * need to restart the autonegotiation process.  Read
324		 * the BMSR twice in case it's latched.
325		 */
326		reg = PHY_READ(sc, BRGPHY_MII_AUXSTS);
327		if (reg & BRGPHY_AUXSTS_LINK)
328			break;
329
330		mii_phy_reset(sc);
331		if (brgphy_mii_phy_auto(sc, 0) == EJUSTRETURN)
332			return(0);
333		break;
334	}
335
336	/* Update the media status. */
337	brgphy_status(sc);
338
339	/* Callback if something changed. */
340	if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
341		MIIBUS_STATCHG(sc->mii_dev);
342		sc->mii_active = mii->mii_media_active;
343	}
344	return (0);
345}
346
347void
348brgphy_status(sc)
349	struct mii_softc *sc;
350{
351	struct mii_data *mii = sc->mii_pdata;
352	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
353	int bmsr, bmcr;
354
355	mii->mii_media_status = IFM_AVALID;
356	mii->mii_media_active = IFM_ETHER;
357
358	bmsr = PHY_READ(sc, BRGPHY_MII_BMSR);
359	if (PHY_READ(sc, BRGPHY_MII_AUXSTS) & BRGPHY_AUXSTS_LINK)
360		mii->mii_media_status |= IFM_ACTIVE;
361
362	bmcr = PHY_READ(sc, BRGPHY_MII_BMCR);
363
364	if (bmcr & BRGPHY_BMCR_LOOP)
365		mii->mii_media_active |= IFM_LOOP;
366
367	if (bmcr & BRGPHY_BMCR_AUTOEN) {
368		if ((bmsr & BRGPHY_BMSR_ACOMP) == 0) {
369			/* Erg, still trying, I guess... */
370			mii->mii_media_active |= IFM_NONE;
371			return;
372		}
373
374		switch (PHY_READ(sc, BRGPHY_MII_AUXSTS) &
375		    BRGPHY_AUXSTS_AN_RES) {
376		case BRGPHY_RES_1000FD:
377			mii->mii_media_active |= IFM_1000_TX | IFM_FDX;
378			break;
379		case BRGPHY_RES_1000HD:
380			mii->mii_media_active |= IFM_1000_TX | IFM_HDX;
381			break;
382		case BRGPHY_RES_100FD:
383			mii->mii_media_active |= IFM_100_TX | IFM_FDX;
384			break;
385		case BRGPHY_RES_100T4:
386			mii->mii_media_active |= IFM_100_T4;
387			break;
388		case BRGPHY_RES_100HD:
389			mii->mii_media_active |= IFM_100_TX | IFM_HDX;
390			break;
391		case BRGPHY_RES_10FD:
392			mii->mii_media_active |= IFM_10_T | IFM_FDX;
393			break;
394		case BRGPHY_RES_10HD:
395			mii->mii_media_active |= IFM_10_T | IFM_HDX;
396			break;
397		default:
398			mii->mii_media_active |= IFM_NONE;
399			break;
400		}
401		return;
402	}
403
404	mii->mii_media_active = ife->ifm_media;
405
406	return;
407}
408
409
410static int
411brgphy_mii_phy_auto(mii, waitfor)
412	struct mii_softc *mii;
413	int waitfor;
414{
415	int bmsr, ktcr = 0, i;
416
417	if ((mii->mii_flags & MIIF_DOINGAUTO) == 0) {
418		mii_phy_reset(mii);
419		PHY_WRITE(mii, BRGPHY_MII_BMCR, 0);
420		DELAY(1000);
421		ktcr = PHY_READ(mii, BRGPHY_MII_1000CTL);
422		PHY_WRITE(mii, BRGPHY_MII_1000CTL, ktcr |
423		    BRGPHY_1000CTL_AFD|BRGPHY_1000CTL_AHD);
424		ktcr = PHY_READ(mii, BRGPHY_MII_1000CTL);
425		DELAY(1000);
426		PHY_WRITE(mii, BRGPHY_MII_ANAR,
427		    BMSR_MEDIA_TO_ANAR(mii->mii_capabilities) | ANAR_CSMA);
428		DELAY(1000);
429		PHY_WRITE(mii, BRGPHY_MII_BMCR,
430		    BRGPHY_BMCR_AUTOEN | BRGPHY_BMCR_STARTNEG);
431		PHY_WRITE(mii, BRGPHY_MII_IMR, 0xFF00);
432	}
433
434	if (waitfor) {
435		/* Wait 500ms for it to complete. */
436		for (i = 0; i < 500; i++) {
437			if ((bmsr = PHY_READ(mii, BRGPHY_MII_BMSR)) &
438			    BRGPHY_BMSR_ACOMP)
439				return (0);
440			DELAY(1000);
441#if 0
442		if ((bmsr & BMSR_ACOMP) == 0)
443			printf("%s: autonegotiation failed to complete\n",
444			    mii->mii_dev.dv_xname);
445#endif
446		}
447
448		/*
449		 * Don't need to worry about clearing MIIF_DOINGAUTO.
450		 * If that's set, a timeout is pending, and it will
451		 * clear the flag.
452		 */
453		return (EIO);
454	}
455
456	/*
457	 * Just let it finish asynchronously.  This is for the benefit of
458	 * the tick handler driving autonegotiation.  Don't want 500ms
459	 * delays all the time while the system is running!
460	 */
461	if ((mii->mii_flags & MIIF_DOINGAUTO) == 0) {
462		mii->mii_flags |= MIIF_DOINGAUTO;
463		mii->mii_auto_ch = timeout(mii_phy_auto_timeout, mii, hz >> 1);
464	}
465	return (EJUSTRETURN);
466}
467