xref: /freebsd/sys/dev/mii/bmtphy.c (revision dce6e6518b85561495cff38a3074a69d29d58a55)
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  * $FreeBSD$
69  */
70 
71 /*
72  * Driver for the Broadcom BCM5201/BCM5202 "Mini-Theta" PHYs.  This also
73  * drives the PHY on the 3Com 3c905C.  The 3c905C's PHY is described in
74  * the 3c905C data sheet.
75  */
76 
77 #include <sys/param.h>
78 #include <sys/systm.h>
79 #include <sys/kernel.h>
80 #include <sys/socket.h>
81 #include <sys/bus.h>
82 
83 #include <net/if.h>
84 #include <net/if_media.h>
85 
86 #include <dev/mii/mii.h>
87 #include <dev/mii/miivar.h>
88 #include "miidevs.h"
89 
90 #include <dev/mii/bmtphyreg.h>
91 
92 #include "miibus_if.h"
93 
94 static int	bmtphy_probe(device_t);
95 static int	bmtphy_attach(device_t);
96 
97 static device_method_t bmtphy_methods[] = {
98 	/* Device interface */
99 	DEVMETHOD(device_probe,		bmtphy_probe),
100 	DEVMETHOD(device_attach,	bmtphy_attach),
101 	DEVMETHOD(device_detach,	mii_phy_detach),
102 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
103 
104 	{ 0, 0 }
105 };
106 
107 static devclass_t	bmtphy_devclass;
108 
109 static driver_t	bmtphy_driver = {
110 	"bmtphy",
111 	bmtphy_methods,
112 	sizeof(struct mii_softc)
113 };
114 
115 DRIVER_MODULE(bmtphy, miibus, bmtphy_driver, bmtphy_devclass, 0, 0);
116 
117 static int	bmtphy_service(struct mii_softc *, struct mii_data *, int);
118 static void	bmtphy_status(struct mii_softc *);
119 
120 static int
121 bmtphy_probe(device_t dev)
122 {
123 	struct	mii_attach_args *ma;
124 	int	rval;
125 
126 	ma = device_get_ivars(dev);
127 	rval = 0;
128 
129 	if (MII_OUI(ma->mii_id1, ma->mii_id2) != MII_OUI_BROADCOM)
130 		return (ENXIO);
131 
132 	switch (MII_MODEL(ma->mii_id2)) {
133 	case MII_MODEL_BROADCOM_3C905B:
134 		device_set_desc(dev, MII_STR_BROADCOM_3C905B);
135 		rval = -10;	/* Let exphy take precedence. */
136 		break;
137 	case MII_MODEL_BROADCOM_3C905C:
138 		device_set_desc(dev, MII_STR_BROADCOM_3C905C);
139 		rval = -10;	/* Let exphy take precedence. */
140 		break;
141 	case MII_MODEL_BROADCOM_BCM5201:
142 		device_set_desc(dev, MII_STR_BROADCOM_BCM5201);
143 		break;
144 	case MII_MODEL_BROADCOM_BCM5221:
145 		device_set_desc(dev, MII_STR_BROADCOM_BCM5221);
146 		break;
147 	default:
148 		return (ENXIO);
149 	}
150 
151 	return (rval);
152 }
153 
154 static int
155 bmtphy_attach(device_t dev)
156 {
157 	struct	mii_softc *sc;
158 	struct	mii_attach_args *ma;
159 	struct	mii_data *mii;
160 
161 	sc = device_get_softc(dev);
162 	ma = device_get_ivars(dev);
163 	sc->mii_dev = device_get_parent(dev);
164 	mii = device_get_softc(sc->mii_dev);
165 	LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
166 
167 	sc->mii_inst = mii->mii_instance;
168 	sc->mii_phy = ma->mii_phyno;
169 	sc->mii_service = bmtphy_service;
170 	sc->mii_pdata = mii;
171 
172 	mii_phy_reset(sc);
173 
174 	mii->mii_instance++;
175 
176 	sc->mii_capabilities =
177 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
178 	device_printf(dev, " ");
179 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
180 		printf("no media present");
181 	else
182 		mii_phy_add_media(sc);
183 
184 	printf("\n");
185 
186 	MIIBUS_MEDIAINIT(sc->mii_dev);
187 
188 	return (0);
189 }
190 
191 static int
192 bmtphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
193 {
194 	struct	ifmedia_entry *ife;
195 	int	reg;
196 
197 	ife = mii->mii_media.ifm_cur;
198 
199 	switch (cmd) {
200 	case MII_POLLSTAT:
201 		/*
202 		 * If we're not polling our PHY instance, just return.
203 		 */
204 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
205 			return (0);
206 		break;
207 
208 	case MII_MEDIACHG:
209 		/*
210 		 * If the media indicates a different PHY instance,
211 		 * isolate ourselves.
212 		 */
213 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
214 			reg = PHY_READ(sc, MII_BMCR);
215 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
216 			return (0);
217 		}
218 
219 		/*
220 		 * If the interface is not up, don't do anything.
221 		 */
222 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
223 			break;
224 
225 		mii_phy_setmedia(sc);
226 		break;
227 
228 	case MII_TICK:
229 		/*
230 		 * If we're not currently selected, just return.
231 		 */
232 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
233 			return (0);
234 		if (mii_phy_tick(sc) == EJUSTRETURN)
235 			return (0);
236 		break;
237 	}
238 
239 	/* Update the media status. */
240 	bmtphy_status(sc);
241 
242 	/* Callback if something changed. */
243 	mii_phy_update(sc, cmd);
244 
245 	return (0);
246 }
247 
248 static void
249 bmtphy_status(struct mii_softc *sc)
250 {
251 	struct	mii_data *mii;
252 	struct	ifmedia_entry *ife;
253 	int	bmsr, bmcr, aux_csr;
254 
255 	mii = sc->mii_pdata;
256 	ife = mii->mii_media.ifm_cur;
257 
258 	mii->mii_media_status = IFM_AVALID;
259 	mii->mii_media_active = IFM_ETHER;
260 
261 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
262 	aux_csr = PHY_READ(sc, MII_BMTPHY_AUX_CSR);
263 
264 	if (bmsr & BMSR_LINK)
265 		mii->mii_media_status |= IFM_ACTIVE;
266 
267 	bmcr = PHY_READ(sc, MII_BMCR);
268 	if (bmcr & BMCR_ISO) {
269 		mii->mii_media_active |= IFM_NONE;
270 		mii->mii_media_status = 0;
271 		return;
272 	}
273 
274 	if (bmcr & BMCR_LOOP)
275 		mii->mii_media_active |= IFM_LOOP;
276 
277 	if (bmcr & BMCR_AUTOEN) {
278 		/*
279 		 * The media status bits are only valid if autonegotiation
280 		 * has completed (or it's disabled).
281 		 */
282 		if ((bmsr & BMSR_ACOMP) == 0) {
283 			/* Erg, still trying, I guess... */
284 			mii->mii_media_active |= IFM_NONE;
285 			return;
286 		}
287 
288 		if (aux_csr & AUX_CSR_SPEED)
289 			mii->mii_media_active |= IFM_100_TX;
290 		else
291 			mii->mii_media_active |= IFM_10_T;
292 		if (aux_csr & AUX_CSR_FDX)
293 			mii->mii_media_active |= IFM_FDX;
294 	} else
295 		mii->mii_media_active = ife->ifm_media;
296 }
297