xref: /freebsd/sys/dev/mii/bmtphy.c (revision 4f29da19bd44f0e99f021510460a81bf754c21d2)
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  * 3. All advertising materials mentioning features or use of this software
18  *    must display the following acknowledgement:
19  *      This product includes software developed by the NetBSD
20  *      Foundation, Inc. and its contributors.
21  * 4. Neither the name of The NetBSD Foundation nor the names of its
22  *    contributors may be used to endorse or promote products derived
23  *    from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35  * POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 /*
39  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
40  *
41  * Redistribution and use in source and binary forms, with or without
42  * modification, are permitted provided that the following conditions
43  * are met:
44  * 1. Redistributions of source code must retain the above copyright
45  *    notice, this list of conditions and the following disclaimer.
46  * 2. Redistributions in binary form must reproduce the above copyright
47  *    notice, this list of conditions and the following disclaimer in the
48  *    documentation and/or other materials provided with the distribution.
49  * 3. All advertising materials mentioning features or use of this software
50  *    must display the following acknowledgement:
51  *      This product includes software developed by Manuel Bouyer.
52  * 4. The name of the author may not be used to endorse or promote products
53  *    derived from this software without specific prior written permission.
54  *
55  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
56  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
57  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
58  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
59  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
60  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
61  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
62  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
63  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
64  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
65  *
66  *	from: NetBSD: bmtphy.c,v 1.8 2002/07/03 06:25:50 simonb Exp
67  *
68  */
69 
70 #include <sys/cdefs.h>
71 __FBSDID("$FreeBSD$");
72 
73 /*
74  * Driver for the Broadcom BCM5201/BCM5202 "Mini-Theta" PHYs.  This also
75  * drives the PHY on the 3Com 3c905C.  The 3c905C's PHY is described in
76  * the 3c905C data sheet.
77  */
78 
79 #include <sys/param.h>
80 #include <sys/systm.h>
81 #include <sys/kernel.h>
82 #include <sys/module.h>
83 #include <sys/socket.h>
84 #include <sys/bus.h>
85 
86 #include <net/if.h>
87 #include <net/if_media.h>
88 
89 #include <dev/mii/mii.h>
90 #include <dev/mii/miivar.h>
91 #include "miidevs.h"
92 
93 #include <dev/mii/bmtphyreg.h>
94 
95 #include "miibus_if.h"
96 
97 static int	bmtphy_probe(device_t);
98 static int	bmtphy_attach(device_t);
99 
100 static device_method_t bmtphy_methods[] = {
101 	/* Device interface */
102 	DEVMETHOD(device_probe,		bmtphy_probe),
103 	DEVMETHOD(device_attach,	bmtphy_attach),
104 	DEVMETHOD(device_detach,	mii_phy_detach),
105 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
106 
107 	{ 0, 0 }
108 };
109 
110 static devclass_t	bmtphy_devclass;
111 
112 static driver_t	bmtphy_driver = {
113 	"bmtphy",
114 	bmtphy_methods,
115 	sizeof(struct mii_softc)
116 };
117 
118 DRIVER_MODULE(bmtphy, miibus, bmtphy_driver, bmtphy_devclass, 0, 0);
119 
120 static int	bmtphy_service(struct mii_softc *, struct mii_data *, int);
121 static void	bmtphy_status(struct mii_softc *);
122 
123 static int
124 bmtphy_probe(device_t dev)
125 {
126 	struct	mii_attach_args *ma;
127 	int	rval;
128 
129 	ma = device_get_ivars(dev);
130 	rval = 0;
131 
132 	if (MII_OUI(ma->mii_id1, ma->mii_id2) != MII_OUI_BROADCOM)
133 		return (ENXIO);
134 
135 	switch (MII_MODEL(ma->mii_id2)) {
136 	case MII_MODEL_BROADCOM_3C905B:
137 		device_set_desc(dev, MII_STR_BROADCOM_3C905B);
138 		rval = -10;	/* Let exphy take precedence. */
139 		break;
140 	case MII_MODEL_BROADCOM_3C905C:
141 		device_set_desc(dev, MII_STR_BROADCOM_3C905C);
142 		rval = -10;	/* Let exphy take precedence. */
143 		break;
144 	case MII_MODEL_BROADCOM_BCM5201:
145 		device_set_desc(dev, MII_STR_BROADCOM_BCM5201);
146 		break;
147 	case MII_MODEL_BROADCOM_BCM5221:
148 		device_set_desc(dev, MII_STR_BROADCOM_BCM5221);
149 		break;
150 	case MII_MODEL_BROADCOM_BCM4401:
151 		device_set_desc(dev, MII_STR_BROADCOM_BCM4401);
152 		break;
153 	default:
154 		return (ENXIO);
155 	}
156 
157 	return (rval);
158 }
159 
160 static int
161 bmtphy_attach(device_t dev)
162 {
163 	struct	mii_softc *sc;
164 	struct	mii_attach_args *ma;
165 	struct	mii_data *mii;
166 
167 	sc = device_get_softc(dev);
168 	ma = device_get_ivars(dev);
169 	sc->mii_dev = device_get_parent(dev);
170 	mii = device_get_softc(sc->mii_dev);
171 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
172 
173 	sc->mii_inst = mii->mii_instance;
174 	sc->mii_phy = ma->mii_phyno;
175 	sc->mii_service = bmtphy_service;
176 	sc->mii_pdata = mii;
177 
178 	mii_phy_reset(sc);
179 
180 	mii->mii_instance++;
181 
182 	sc->mii_capabilities =
183 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
184 	device_printf(dev, " ");
185 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
186 		printf("no media present");
187 	else
188 		mii_phy_add_media(sc);
189 
190 	printf("\n");
191 
192 	MIIBUS_MEDIAINIT(sc->mii_dev);
193 
194 	return (0);
195 }
196 
197 static int
198 bmtphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
199 {
200 	struct	ifmedia_entry *ife;
201 	int	reg;
202 
203 	ife = mii->mii_media.ifm_cur;
204 
205 	switch (cmd) {
206 	case MII_POLLSTAT:
207 		/*
208 		 * If we're not polling our PHY instance, just return.
209 		 */
210 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
211 			return (0);
212 		break;
213 
214 	case MII_MEDIACHG:
215 		/*
216 		 * If the media indicates a different PHY instance,
217 		 * isolate ourselves.
218 		 */
219 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
220 			reg = PHY_READ(sc, MII_BMCR);
221 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
222 			return (0);
223 		}
224 
225 		/*
226 		 * If the interface is not up, don't do anything.
227 		 */
228 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
229 			break;
230 
231 		mii_phy_setmedia(sc);
232 		break;
233 
234 	case MII_TICK:
235 		/*
236 		 * If we're not currently selected, just return.
237 		 */
238 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
239 			return (0);
240 		if (mii_phy_tick(sc) == EJUSTRETURN)
241 			return (0);
242 		break;
243 	}
244 
245 	/* Update the media status. */
246 	bmtphy_status(sc);
247 
248 	/* Callback if something changed. */
249 	mii_phy_update(sc, cmd);
250 
251 	return (0);
252 }
253 
254 static void
255 bmtphy_status(struct mii_softc *sc)
256 {
257 	struct	mii_data *mii;
258 	struct	ifmedia_entry *ife;
259 	int	bmsr, bmcr, aux_csr;
260 
261 	mii = sc->mii_pdata;
262 	ife = mii->mii_media.ifm_cur;
263 
264 	mii->mii_media_status = IFM_AVALID;
265 	mii->mii_media_active = IFM_ETHER;
266 
267 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
268 	aux_csr = PHY_READ(sc, MII_BMTPHY_AUX_CSR);
269 
270 	if (bmsr & BMSR_LINK)
271 		mii->mii_media_status |= IFM_ACTIVE;
272 
273 	bmcr = PHY_READ(sc, MII_BMCR);
274 	if (bmcr & BMCR_ISO) {
275 		mii->mii_media_active |= IFM_NONE;
276 		mii->mii_media_status = 0;
277 		return;
278 	}
279 
280 	if (bmcr & BMCR_LOOP)
281 		mii->mii_media_active |= IFM_LOOP;
282 
283 	if (bmcr & BMCR_AUTOEN) {
284 		/*
285 		 * The media status bits are only valid if autonegotiation
286 		 * has completed (or it's disabled).
287 		 */
288 		if ((bmsr & BMSR_ACOMP) == 0) {
289 			/* Erg, still trying, I guess... */
290 			mii->mii_media_active |= IFM_NONE;
291 			return;
292 		}
293 
294 		if (aux_csr & AUX_CSR_SPEED)
295 			mii->mii_media_active |= IFM_100_TX;
296 		else
297 			mii->mii_media_active |= IFM_10_T;
298 		if (aux_csr & AUX_CSR_FDX)
299 			mii->mii_media_active |= IFM_FDX;
300 	} else
301 		mii->mii_media_active = ife->ifm_media;
302 }
303