xref: /freebsd/sys/dev/mii/bmtphy.c (revision 10b9d77bf1ccf2f3affafa6261692cb92cf7e992)
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 struct bmtphy_softc {
89 	struct mii_softc mii_sc;
90 	int mii_model;
91 };
92 
93 static device_method_t bmtphy_methods[] = {
94 	/* Device interface */
95 	DEVMETHOD(device_probe,		bmtphy_probe),
96 	DEVMETHOD(device_attach,	bmtphy_attach),
97 	DEVMETHOD(device_detach,	mii_phy_detach),
98 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
99 
100 	{ 0, 0 }
101 };
102 
103 static devclass_t	bmtphy_devclass;
104 
105 static driver_t	bmtphy_driver = {
106 	"bmtphy",
107 	bmtphy_methods,
108 	sizeof(struct bmtphy_softc)
109 };
110 
111 DRIVER_MODULE(bmtphy, miibus, bmtphy_driver, bmtphy_devclass, 0, 0);
112 
113 static int	bmtphy_service(struct mii_softc *, struct mii_data *, int);
114 static void	bmtphy_status(struct mii_softc *);
115 static void	bmtphy_reset(struct mii_softc *);
116 
117 static const struct mii_phydesc bmtphys_dp[] = {
118 	MII_PHY_DESC(BROADCOM, BCM4401),
119 	MII_PHY_DESC(BROADCOM, BCM5201),
120 	MII_PHY_DESC(BROADCOM, BCM5214),
121 	MII_PHY_DESC(BROADCOM, BCM5221),
122 	MII_PHY_DESC(BROADCOM, BCM5222),
123 	MII_PHY_END
124 };
125 
126 static const struct mii_phydesc bmtphys_lp[] = {
127 	MII_PHY_DESC(BROADCOM, 3C905B),
128 	MII_PHY_DESC(BROADCOM, 3C905C),
129 	MII_PHY_END
130 };
131 
132 static int
133 bmtphy_probe(device_t dev)
134 {
135 	int	rval;
136 
137 	/* Let exphy(4) take precedence for these. */
138 	rval = mii_phy_dev_probe(dev, bmtphys_lp, BUS_PROBE_LOW_PRIORITY);
139 	if (rval <= 0)
140 		return (rval);
141 
142 	return (mii_phy_dev_probe(dev, bmtphys_dp, BUS_PROBE_DEFAULT));
143 }
144 
145 static int
146 bmtphy_attach(device_t dev)
147 {
148 	struct bmtphy_softc *bsc;
149 	struct mii_softc *sc;
150 	struct mii_attach_args *ma;
151 	struct mii_data *mii;
152 
153 	bsc = device_get_softc(dev);
154 	sc = &bsc->mii_sc;
155 	ma = device_get_ivars(dev);
156 	sc->mii_dev = device_get_parent(dev);
157 	mii = ma->mii_data;
158 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
159 
160 	sc->mii_flags = miibus_get_flags(dev);
161 	sc->mii_inst = mii->mii_instance++;
162 	sc->mii_phy = ma->mii_phyno;
163 	sc->mii_service = bmtphy_service;
164 	sc->mii_pdata = mii;
165 
166 	sc->mii_flags |= MIIF_NOMANPAUSE;
167 
168 	bsc->mii_model = MII_MODEL(ma->mii_id2);
169 
170 	bmtphy_reset(sc);
171 
172 	sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
173 	device_printf(dev, " ");
174 	mii_phy_add_media(sc);
175 	printf("\n");
176 
177 	MIIBUS_MEDIAINIT(sc->mii_dev);
178 
179 	return (0);
180 }
181 
182 static int
183 bmtphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
184 {
185 
186 	switch (cmd) {
187 	case MII_POLLSTAT:
188 		break;
189 
190 	case MII_MEDIACHG:
191 		/*
192 		 * If the interface is not up, don't do anything.
193 		 */
194 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
195 			break;
196 
197 		mii_phy_setmedia(sc);
198 		break;
199 
200 	case MII_TICK:
201 		if (mii_phy_tick(sc) == EJUSTRETURN)
202 			return (0);
203 		break;
204 	}
205 
206 	/* Update the media status. */
207 	bmtphy_status(sc);
208 
209 	/* Callback if something changed. */
210 	mii_phy_update(sc, cmd);
211 	return (0);
212 }
213 
214 static void
215 bmtphy_status(struct mii_softc *sc)
216 {
217 	struct mii_data *mii;
218 	struct ifmedia_entry *ife;
219 	int bmsr, bmcr, aux_csr;
220 
221 	mii = sc->mii_pdata;
222 	ife = mii->mii_media.ifm_cur;
223 
224 	mii->mii_media_status = IFM_AVALID;
225 	mii->mii_media_active = IFM_ETHER;
226 
227 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
228 
229 	if (bmsr & BMSR_LINK)
230 		mii->mii_media_status |= IFM_ACTIVE;
231 
232 	bmcr = PHY_READ(sc, MII_BMCR);
233 	if (bmcr & BMCR_ISO) {
234 		mii->mii_media_active |= IFM_NONE;
235 		mii->mii_media_status = 0;
236 		return;
237 	}
238 
239 	if (bmcr & BMCR_LOOP)
240 		mii->mii_media_active |= IFM_LOOP;
241 
242 	if (bmcr & BMCR_AUTOEN) {
243 		/*
244 		 * The media status bits are only valid if autonegotiation
245 		 * has completed (or it's disabled).
246 		 */
247 		if ((bmsr & BMSR_ACOMP) == 0) {
248 			/* Erg, still trying, I guess... */
249 			mii->mii_media_active |= IFM_NONE;
250 			return;
251 		}
252 
253 		aux_csr = PHY_READ(sc, MII_BMTPHY_AUX_CSR);
254 		if (aux_csr & AUX_CSR_SPEED)
255 			mii->mii_media_active |= IFM_100_TX;
256 		else
257 			mii->mii_media_active |= IFM_10_T;
258 		if (aux_csr & AUX_CSR_FDX)
259 			mii->mii_media_active |=
260 			    IFM_FDX | mii_phy_flowstatus(sc);
261 		else
262 			mii->mii_media_active |= IFM_HDX;
263 	} else
264 		mii->mii_media_active = ife->ifm_media;
265 }
266 
267 static void
268 bmtphy_reset(struct mii_softc *sc)
269 {
270 	struct bmtphy_softc *bsc;
271 	u_int16_t data;
272 
273 	bsc = (struct bmtphy_softc *)sc;
274 
275 	mii_phy_reset(sc);
276 
277 	if (bsc->mii_model == MII_MODEL_BROADCOM_BCM5221) {
278 		/* Enable shadow register mode. */
279 		data = PHY_READ(sc, 0x1f);
280 		PHY_WRITE(sc, 0x1f, data | 0x0080);
281 
282 		/* Enable APD (Auto PowerDetect). */
283 		data = PHY_READ(sc, MII_BMTPHY_AUX2);
284 		PHY_WRITE(sc, MII_BMTPHY_AUX2, data | 0x0020);
285 
286 		/* Enable clocks across APD for Auto-MDIX functionality. */
287 		data = PHY_READ(sc, MII_BMTPHY_INTR);
288 		PHY_WRITE(sc, MII_BMTPHY_INTR, data | 0x0004);
289 
290 		/* Disable shadow register mode. */
291 		data = PHY_READ(sc, 0x1f);
292 		PHY_WRITE(sc, 0x1f, data & ~0x0080);
293 	}
294 }
295