xref: /netbsd-src/sys/dev/mii/bmtphy.c (revision aaf4ece63a859a04e37cf3a7229b5fab0157cc06)
1 /*	$NetBSD: bmtphy.c,v 1.18 2005/12/11 12:22:42 christos Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998, 1999, 2000, 2001 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9  * NASA Ames Research Center.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *	This product includes software developed by the NetBSD
22  *	Foundation, Inc. and its contributors.
23  * 4. Neither the name of The NetBSD Foundation nor the names of its
24  *    contributors may be used to endorse or promote products derived
25  *    from this software without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37  * POSSIBILITY OF SUCH DAMAGE.
38  */
39 
40 /*
41  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
42  *
43  * Redistribution and use in source and binary forms, with or without
44  * modification, are permitted provided that the following conditions
45  * are met:
46  * 1. Redistributions of source code must retain the above copyright
47  *    notice, this list of conditions and the following disclaimer.
48  * 2. Redistributions in binary form must reproduce the above copyright
49  *    notice, this list of conditions and the following disclaimer in the
50  *    documentation and/or other materials provided with the distribution.
51  * 3. All advertising materials mentioning features or use of this software
52  *    must display the following acknowledgement:
53  *	This product includes software developed by Manuel Bouyer.
54  * 4. The name of the author may not be used to endorse or promote products
55  *    derived from this software without specific prior written permission.
56  *
57  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
58  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
59  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
60  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
61  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
62  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
63  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
64  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
65  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
66  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
67  */
68 
69 /*
70  * Driver for the Broadcom BCM5201/BCM5202 "Mini-Theta" PHYs.  This also
71  * drives the PHY on the 3Com 3c905C.  The 3c905C's PHY is described in
72  * the 3c905C data sheet.
73  */
74 
75 #include <sys/cdefs.h>
76 __KERNEL_RCSID(0, "$NetBSD: bmtphy.c,v 1.18 2005/12/11 12:22:42 christos Exp $");
77 
78 #include <sys/param.h>
79 #include <sys/systm.h>
80 #include <sys/kernel.h>
81 #include <sys/device.h>
82 #include <sys/socket.h>
83 #include <sys/errno.h>
84 
85 #include <net/if.h>
86 #include <net/if_media.h>
87 
88 #include <dev/mii/mii.h>
89 #include <dev/mii/miivar.h>
90 #include <dev/mii/miidevs.h>
91 
92 #include <dev/mii/bmtphyreg.h>
93 
94 static int	bmtphymatch(struct device *, struct cfdata *, void *);
95 static void	bmtphyattach(struct device *, struct device *, void *);
96 
97 CFATTACH_DECL(bmtphy, sizeof(struct mii_softc),
98     bmtphymatch, bmtphyattach, mii_phy_detach, mii_phy_activate);
99 
100 static int	bmtphy_service(struct mii_softc *, struct mii_data *, int);
101 static void	bmtphy_status(struct mii_softc *);
102 
103 static const struct mii_phy_funcs bmtphy_funcs = {
104 	bmtphy_service, bmtphy_status, mii_phy_reset,
105 };
106 
107 static const struct mii_phydesc bmtphys[] = {
108 	{ MII_OUI_xxBROADCOM,		MII_MODEL_xxBROADCOM_3C905B,
109 	  MII_STR_xxBROADCOM_3C905B },
110 	{ MII_OUI_xxBROADCOM,		MII_MODEL_xxBROADCOM_3C905C,
111 	  MII_STR_xxBROADCOM_3C905C },
112 	{ MII_OUI_xxBROADCOM,		MII_MODEL_xxBROADCOM_BCM5201,
113 	  MII_STR_xxBROADCOM_BCM5201 },
114 	{ MII_OUI_xxBROADCOM,		MII_MODEL_xxBROADCOM_BCM5214,
115 	  MII_STR_xxBROADCOM_BCM5214 },
116 	{ MII_OUI_xxBROADCOM,		MII_MODEL_xxBROADCOM_BCM5221,
117 	  MII_STR_xxBROADCOM_BCM5221 },
118 	{ MII_OUI_xxBROADCOM,		MII_MODEL_xxBROADCOM_BCM5222,
119 	  MII_STR_xxBROADCOM_BCM5222 },
120 	{ MII_OUI_xxBROADCOM,		MII_MODEL_xxBROADCOM_BCM4401,
121 	  MII_STR_xxBROADCOM_BCM4401 },
122 
123 	{ 0,				0,
124 	  NULL },
125 };
126 
127 static int
128 bmtphymatch(struct device *parent, struct cfdata *match, void *aux)
129 {
130 	struct mii_attach_args *ma = aux;
131 
132 	if (mii_phy_match(ma, bmtphys) != NULL)
133 		return (10);
134 
135 	return (0);
136 }
137 
138 static void
139 bmtphyattach(struct device *parent, struct device *self, void *aux)
140 {
141 	struct mii_softc *sc = (struct mii_softc *)self;
142 	struct mii_attach_args *ma = aux;
143 	struct mii_data *mii = ma->mii_data;
144 	const struct mii_phydesc *mpd;
145 
146 	mpd = mii_phy_match(ma, bmtphys);
147 	aprint_naive(": Media interface\n");
148 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
149 
150 	sc->mii_inst = mii->mii_instance;
151 	sc->mii_phy = ma->mii_phyno;
152 	sc->mii_funcs = &bmtphy_funcs;
153 	sc->mii_pdata = mii;
154 	sc->mii_flags = ma->mii_flags;
155 	sc->mii_anegticks = 5;
156 
157 	PHY_RESET(sc);
158 
159 	/*
160 	 * XXX Check AUX_STS_FX_MODE to set MIIF_HAVE_FIBER?
161 	 */
162 
163 	sc->mii_capabilities =
164 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
165 	aprint_normal("%s: ", sc->mii_dev.dv_xname);
166 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
167 		aprint_error("no media present");
168 	else
169 		mii_phy_add_media(sc);
170 	aprint_normal("\n");
171 }
172 
173 static int
174 bmtphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
175 {
176 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
177 	int reg;
178 
179 	switch (cmd) {
180 	case MII_POLLSTAT:
181 		/*
182 		 * If we're not polling our PHY instance, just return.
183 		 */
184 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
185 			return (0);
186 		break;
187 
188 	case MII_MEDIACHG:
189 		/*
190 		 * If the media indicates a different PHY instance,
191 		 * isolate ourselves.
192 		 */
193 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
194 			reg = PHY_READ(sc, MII_BMCR);
195 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
196 			return (0);
197 		}
198 
199 		/*
200 		 * If the interface is not up, don't do anything.
201 		 */
202 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
203 			break;
204 
205 		mii_phy_setmedia(sc);
206 		break;
207 
208 	case MII_TICK:
209 		/*
210 		 * If we're not currently selected, just return.
211 		 */
212 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
213 			return (0);
214 
215 		if (mii_phy_tick(sc) == EJUSTRETURN)
216 			return (0);
217 		break;
218 
219 	case MII_DOWN:
220 		mii_phy_down(sc);
221 		return (0);
222 	}
223 
224 	/* Update the media status. */
225 	mii_phy_status(sc);
226 
227 	/* Callback if something changed. */
228 	mii_phy_update(sc, cmd);
229 	return (0);
230 }
231 
232 static void
233 bmtphy_status(struct mii_softc *sc)
234 {
235 	struct mii_data *mii = sc->mii_pdata;
236 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
237 	int bmsr, bmcr, aux_csr;
238 
239 	mii->mii_media_status = IFM_AVALID;
240 	mii->mii_media_active = IFM_ETHER;
241 
242 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
243 
244 	if (bmsr & BMSR_LINK)
245 		mii->mii_media_status |= IFM_ACTIVE;
246 
247 	bmcr = PHY_READ(sc, MII_BMCR);
248 	if (bmcr & BMCR_ISO) {
249 		mii->mii_media_active |= IFM_NONE;
250 		mii->mii_media_status = 0;
251 		return;
252 	}
253 
254 	if (bmcr & BMCR_LOOP)
255 		mii->mii_media_active |= IFM_LOOP;
256 
257 	if (bmcr & BMCR_AUTOEN) {
258 		/*
259 		 * The media status bits are only valid of autonegotiation
260 		 * has completed (or it's disabled).
261 		 */
262 		if ((bmsr & BMSR_ACOMP) == 0) {
263 			/* Erg, still trying, I guess... */
264 			mii->mii_media_active |= IFM_NONE;
265 			return;
266 		}
267 
268 		aux_csr = PHY_READ(sc, MII_BMTPHY_AUX_CSR);
269 		if (aux_csr & AUX_CSR_SPEED)
270 			mii->mii_media_active |= IFM_100_TX;
271 		else
272 			mii->mii_media_active |= IFM_10_T;
273 		if (aux_csr & AUX_CSR_FDX)
274 			mii->mii_media_active |= IFM_FDX;
275 	} else
276 		mii->mii_media_active = ife->ifm_media;
277 }
278