1 /* $NetBSD: bmtphy.c,v 1.37 2020/03/15 23:04:50 thorpej 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 *
20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 /*
34 * Copyright (c) 1997 Manuel Bouyer. All rights reserved.
35 *
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
38 * are met:
39 * 1. Redistributions of source code must retain the above copyright
40 * notice, this list of conditions and the following disclaimer.
41 * 2. Redistributions in binary form must reproduce the above copyright
42 * notice, this list of conditions and the following disclaimer in the
43 * documentation and/or other materials provided with the distribution.
44 *
45 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
46 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
47 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
48 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
49 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
50 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
51 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
52 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
53 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
54 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
55 */
56
57 /*
58 * Driver for the Broadcom BCM5201/BCM5202 "Mini-Theta" PHYs. This also
59 * drives the PHY on the 3Com 3c905C. The 3c905C's PHY is described in
60 * the 3c905C data sheet.
61 */
62
63 #include <sys/cdefs.h>
64 __KERNEL_RCSID(0, "$NetBSD: bmtphy.c,v 1.37 2020/03/15 23:04:50 thorpej Exp $");
65
66 #include <sys/param.h>
67 #include <sys/systm.h>
68 #include <sys/kernel.h>
69 #include <sys/device.h>
70 #include <sys/socket.h>
71 #include <sys/errno.h>
72
73 #include <net/if.h>
74 #include <net/if_media.h>
75
76 #include <dev/mii/mii.h>
77 #include <dev/mii/miivar.h>
78 #include <dev/mii/miidevs.h>
79
80 #include <dev/mii/bmtphyreg.h>
81
82 static int bmtphymatch(device_t, cfdata_t, void *);
83 static void bmtphyattach(device_t, device_t, void *);
84
85 CFATTACH_DECL_NEW(bmtphy, sizeof(struct mii_softc),
86 bmtphymatch, bmtphyattach, mii_phy_detach, mii_phy_activate);
87
88 static int bmtphy_service(struct mii_softc *, struct mii_data *, int);
89 static void bmtphy_status(struct mii_softc *);
90 static void bmtphy_reset(struct mii_softc *);
91
92 static const struct mii_phy_funcs bmtphy_funcs = {
93 bmtphy_service, bmtphy_status, bmtphy_reset,
94 };
95
96 static const struct mii_phydesc bmtphys[] = {
97 MII_PHY_DESC(xxBROADCOM, 3C905B),
98 MII_PHY_DESC(xxBROADCOM, 3C905C),
99 MII_PHY_DESC(xxBROADCOM, BCM5201),
100 MII_PHY_DESC(xxBROADCOM, BCM5214),
101 MII_PHY_DESC(xxBROADCOM, BCM5221),
102 MII_PHY_DESC(xxBROADCOM, BCM5222),
103 MII_PHY_DESC(xxBROADCOM, BCM4401),
104 MII_PHY_END,
105 };
106
107 static int
bmtphymatch(device_t parent,cfdata_t match,void * aux)108 bmtphymatch(device_t parent, cfdata_t match, void *aux)
109 {
110 struct mii_attach_args *ma = aux;
111
112 if (mii_phy_match(ma, bmtphys) != NULL)
113 return 10;
114
115 return 0;
116 }
117
118 static void
bmtphyattach(device_t parent,device_t self,void * aux)119 bmtphyattach(device_t parent, device_t self, void *aux)
120 {
121 struct mii_softc *sc = device_private(self);
122 struct mii_attach_args *ma = aux;
123 struct mii_data *mii = ma->mii_data;
124 const struct mii_phydesc *mpd;
125
126 mpd = mii_phy_match(ma, bmtphys);
127 aprint_naive(": Media interface\n");
128 aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
129
130 sc->mii_dev = self;
131 sc->mii_mpd_model = MII_MODEL(ma->mii_id2);
132 sc->mii_inst = mii->mii_instance;
133 sc->mii_phy = ma->mii_phyno;
134 sc->mii_funcs = &bmtphy_funcs;
135 sc->mii_pdata = mii;
136 sc->mii_flags = ma->mii_flags;
137
138 mii_lock(mii);
139
140 PHY_RESET(sc);
141
142 /* XXX Check AUX_STS_FX_MODE to set MIIF_HAVE_FIBER? */
143
144 PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
145 sc->mii_capabilities &= ma->mii_capmask;
146
147 mii_unlock(mii);
148
149 mii_phy_add_media(sc);
150 }
151
152 static int
bmtphy_service(struct mii_softc * sc,struct mii_data * mii,int cmd)153 bmtphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
154 {
155 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
156 uint16_t reg;
157
158 KASSERT(mii_locked(mii));
159
160 switch (cmd) {
161 case MII_POLLSTAT:
162 /* If we're not polling our PHY instance, just return. */
163 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
164 return 0;
165 break;
166
167 case MII_MEDIACHG:
168 /*
169 * If the media indicates a different PHY instance,
170 * isolate ourselves.
171 */
172 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
173 PHY_READ(sc, MII_BMCR, ®);
174 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
175 return 0;
176 }
177
178 /* If the interface is not up, don't do anything. */
179 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
180 break;
181
182 mii_phy_setmedia(sc);
183 break;
184
185 case MII_TICK:
186 /* If we're not currently selected, just return. */
187 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
188 return 0;
189
190 if (mii_phy_tick(sc) == EJUSTRETURN)
191 return 0;
192 break;
193
194 case MII_DOWN:
195 mii_phy_down(sc);
196 return 0;
197 }
198
199 /* Update the media status. */
200 mii_phy_status(sc);
201
202 /* Callback if something changed. */
203 mii_phy_update(sc, cmd);
204 return 0;
205 }
206
207 static void
bmtphy_status(struct mii_softc * sc)208 bmtphy_status(struct mii_softc *sc)
209 {
210 struct mii_data *mii = sc->mii_pdata;
211 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
212 uint16_t bmsr, bmcr, aux_csr;
213
214 KASSERT(mii_locked(mii));
215
216 mii->mii_media_status = IFM_AVALID;
217 mii->mii_media_active = IFM_ETHER;
218
219 PHY_READ(sc, MII_BMSR, &bmsr);
220 PHY_READ(sc, MII_BMSR, &bmsr);
221
222 if (bmsr & BMSR_LINK)
223 mii->mii_media_status |= IFM_ACTIVE;
224
225 PHY_READ(sc, MII_BMCR, &bmcr);
226 if (bmcr & BMCR_ISO) {
227 mii->mii_media_active |= IFM_NONE;
228 mii->mii_media_status = 0;
229 return;
230 }
231
232 if (bmcr & BMCR_LOOP)
233 mii->mii_media_active |= IFM_LOOP;
234
235 if (bmcr & BMCR_AUTOEN) {
236 /*
237 * The media status bits are only valid if autonegotiation
238 * has completed (or it's disabled).
239 */
240 if ((bmsr & BMSR_ACOMP) == 0) {
241 /* Erg, still trying, I guess... */
242 mii->mii_media_active |= IFM_NONE;
243 return;
244 }
245
246 PHY_READ(sc, MII_BMTPHY_AUX_CSR, &aux_csr);
247 if (aux_csr & AUX_CSR_SPEED)
248 mii->mii_media_active |= IFM_100_TX;
249 else
250 mii->mii_media_active |= IFM_10_T;
251 if (aux_csr & AUX_CSR_FDX)
252 mii->mii_media_active |= IFM_FDX;
253 else
254 mii->mii_media_active |= IFM_HDX;
255
256 if (mii->mii_media_active & IFM_FDX)
257 mii->mii_media_active |= mii_phy_flowstatus(sc);
258 } else
259 mii->mii_media_active = ife->ifm_media;
260 }
261
262 static void
bmtphy_reset(struct mii_softc * sc)263 bmtphy_reset(struct mii_softc *sc)
264 {
265 uint16_t data;
266
267 KASSERT(mii_locked(sc->mii_pdata));
268
269 mii_phy_reset(sc);
270
271 if (sc->mii_mpd_model == MII_MODEL_xxBROADCOM_BCM5221) {
272 /* Enable shadow register mode */
273 PHY_READ(sc, 0x1f, &data);
274 PHY_WRITE(sc, 0x1f, data | 0x0080);
275
276 /* Enable APD (Auto PowerDetect) */
277 PHY_READ(sc, MII_BMTPHY_AUX2, &data);
278 PHY_WRITE(sc, MII_BMTPHY_AUX2, data | 0x0020);
279
280 /* Enable clocks across APD for Auto-MDIX functionality */
281 PHY_READ(sc, MII_BMTPHY_INTR, &data);
282 PHY_WRITE(sc, MII_BMTPHY_INTR, data | 0x0004);
283
284 /* Disable shadow register mode */
285 PHY_READ(sc, 0x1f, &data);
286 PHY_WRITE(sc, 0x1f, data & ~0x0080);
287 }
288 }
289