xref: /freebsd/sys/dev/mii/bmtphy.c (revision 884a2a699669ec61e2366e3e358342dbc94be24a)
1 /*-
2  * Copyright (c) 1998, 1999, 2000, 2001 The NetBSD Foundation, Inc.
3  * All rights reserved.
4  *
5  * This code is derived from software contributed to The NetBSD Foundation
6  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
7  * NASA Ames Research Center.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 /*
32  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
33  *
34  * Redistribution and use in source and binary forms, with or without
35  * modification, are permitted provided that the following conditions
36  * are met:
37  * 1. Redistributions of source code must retain the above copyright
38  *    notice, this list of conditions and the following disclaimer.
39  * 2. Redistributions in binary form must reproduce the above copyright
40  *    notice, this list of conditions and the following disclaimer in the
41  *    documentation and/or other materials provided with the distribution.
42  *
43  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
44  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
45  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
46  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
47  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
48  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
49  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
50  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
51  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
52  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
53  *
54  *	from: NetBSD: bmtphy.c,v 1.8 2002/07/03 06:25:50 simonb Exp
55  *
56  */
57 
58 #include <sys/cdefs.h>
59 __FBSDID("$FreeBSD$");
60 
61 /*
62  * Driver for the Broadcom BCM5201/BCM5202 "Mini-Theta" PHYs.  This also
63  * drives the PHY on the 3Com 3c905C.  The 3c905C's PHY is described in
64  * the 3c905C data sheet.
65  */
66 
67 #include <sys/param.h>
68 #include <sys/systm.h>
69 #include <sys/kernel.h>
70 #include <sys/module.h>
71 #include <sys/socket.h>
72 #include <sys/bus.h>
73 
74 #include <net/if.h>
75 #include <net/if_media.h>
76 
77 #include <dev/mii/mii.h>
78 #include <dev/mii/miivar.h>
79 #include "miidevs.h"
80 
81 #include <dev/mii/bmtphyreg.h>
82 
83 #include "miibus_if.h"
84 
85 static int	bmtphy_probe(device_t);
86 static int	bmtphy_attach(device_t);
87 
88 static device_method_t bmtphy_methods[] = {
89 	/* Device interface */
90 	DEVMETHOD(device_probe,		bmtphy_probe),
91 	DEVMETHOD(device_attach,	bmtphy_attach),
92 	DEVMETHOD(device_detach,	mii_phy_detach),
93 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
94 
95 	{ 0, 0 }
96 };
97 
98 static devclass_t	bmtphy_devclass;
99 
100 static driver_t	bmtphy_driver = {
101 	"bmtphy",
102 	bmtphy_methods,
103 	sizeof(struct mii_softc)
104 };
105 
106 DRIVER_MODULE(bmtphy, miibus, bmtphy_driver, bmtphy_devclass, 0, 0);
107 
108 static int	bmtphy_service(struct mii_softc *, struct mii_data *, int);
109 static void	bmtphy_status(struct mii_softc *);
110 static void	bmtphy_reset(struct mii_softc *);
111 
112 static const struct mii_phydesc bmtphys_dp[] = {
113 	MII_PHY_DESC(xxBROADCOM, BCM4401),
114 	MII_PHY_DESC(xxBROADCOM, BCM5201),
115 	MII_PHY_DESC(xxBROADCOM, BCM5214),
116 	MII_PHY_DESC(xxBROADCOM, BCM5221),
117 	MII_PHY_DESC(xxBROADCOM, BCM5222),
118 	MII_PHY_END
119 };
120 
121 static const struct mii_phydesc bmtphys_lp[] = {
122 	MII_PHY_DESC(xxBROADCOM, 3C905B),
123 	MII_PHY_DESC(xxBROADCOM, 3C905C),
124 	MII_PHY_END
125 };
126 
127 static const struct mii_phy_funcs bmtphy_funcs = {
128 	bmtphy_service,
129 	bmtphy_status,
130 	bmtphy_reset
131 };
132 
133 static int
134 bmtphy_probe(device_t dev)
135 {
136 	int	rval;
137 
138 	/* Let exphy(4) take precedence for these. */
139 	rval = mii_phy_dev_probe(dev, bmtphys_lp, BUS_PROBE_LOW_PRIORITY);
140 	if (rval <= 0)
141 		return (rval);
142 
143 	return (mii_phy_dev_probe(dev, bmtphys_dp, BUS_PROBE_DEFAULT));
144 }
145 
146 static int
147 bmtphy_attach(device_t dev)
148 {
149 
150 	mii_phy_dev_attach(dev, MIIF_NOMANPAUSE, &bmtphy_funcs, 1);
151 	return (0);
152 }
153 
154 static int
155 bmtphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
156 {
157 
158 	switch (cmd) {
159 	case MII_POLLSTAT:
160 		break;
161 
162 	case MII_MEDIACHG:
163 		/*
164 		 * If the interface is not up, don't do anything.
165 		 */
166 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
167 			break;
168 
169 		mii_phy_setmedia(sc);
170 		break;
171 
172 	case MII_TICK:
173 		if (mii_phy_tick(sc) == EJUSTRETURN)
174 			return (0);
175 		break;
176 	}
177 
178 	/* Update the media status. */
179 	PHY_STATUS(sc);
180 
181 	/* Callback if something changed. */
182 	mii_phy_update(sc, cmd);
183 	return (0);
184 }
185 
186 static void
187 bmtphy_status(struct mii_softc *sc)
188 {
189 	struct mii_data *mii;
190 	struct ifmedia_entry *ife;
191 	int bmsr, bmcr, aux_csr;
192 
193 	mii = sc->mii_pdata;
194 	ife = mii->mii_media.ifm_cur;
195 
196 	mii->mii_media_status = IFM_AVALID;
197 	mii->mii_media_active = IFM_ETHER;
198 
199 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
200 
201 	if (bmsr & BMSR_LINK)
202 		mii->mii_media_status |= IFM_ACTIVE;
203 
204 	bmcr = PHY_READ(sc, MII_BMCR);
205 	if (bmcr & BMCR_ISO) {
206 		mii->mii_media_active |= IFM_NONE;
207 		mii->mii_media_status = 0;
208 		return;
209 	}
210 
211 	if (bmcr & BMCR_LOOP)
212 		mii->mii_media_active |= IFM_LOOP;
213 
214 	if (bmcr & BMCR_AUTOEN) {
215 		/*
216 		 * The media status bits are only valid if autonegotiation
217 		 * has completed (or it's disabled).
218 		 */
219 		if ((bmsr & BMSR_ACOMP) == 0) {
220 			/* Erg, still trying, I guess... */
221 			mii->mii_media_active |= IFM_NONE;
222 			return;
223 		}
224 
225 		aux_csr = PHY_READ(sc, MII_BMTPHY_AUX_CSR);
226 		if (aux_csr & AUX_CSR_SPEED)
227 			mii->mii_media_active |= IFM_100_TX;
228 		else
229 			mii->mii_media_active |= IFM_10_T;
230 		if (aux_csr & AUX_CSR_FDX)
231 			mii->mii_media_active |=
232 			    IFM_FDX | mii_phy_flowstatus(sc);
233 		else
234 			mii->mii_media_active |= IFM_HDX;
235 	} else
236 		mii->mii_media_active = ife->ifm_media;
237 }
238 
239 static void
240 bmtphy_reset(struct mii_softc *sc)
241 {
242 	u_int16_t data;
243 
244 	mii_phy_reset(sc);
245 
246 	if (sc->mii_mpd_model == MII_MODEL_xxBROADCOM_BCM5221) {
247 		/* Enable shadow register mode. */
248 		data = PHY_READ(sc, 0x1f);
249 		PHY_WRITE(sc, 0x1f, data | 0x0080);
250 
251 		/* Enable APD (Auto PowerDetect). */
252 		data = PHY_READ(sc, MII_BMTPHY_AUX2);
253 		PHY_WRITE(sc, MII_BMTPHY_AUX2, data | 0x0020);
254 
255 		/* Enable clocks across APD for Auto-MDIX functionality. */
256 		data = PHY_READ(sc, MII_BMTPHY_INTR);
257 		PHY_WRITE(sc, MII_BMTPHY_INTR, data | 0x0004);
258 
259 		/* Disable shadow register mode. */
260 		data = PHY_READ(sc, 0x1f);
261 		PHY_WRITE(sc, 0x1f, data & ~0x0080);
262 	}
263 }
264