gphyter.c revision 1.35 1 /* $NetBSD: gphyter.c,v 1.35 2019/11/26 08:21:03 msaitoh 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 National Semiconductor's DP83891, DP83861 and DP83865
59 * `Gig PHYTER' ethernet 10/100/1000 PHYs. The DP83891 is an older,
60 * non-firmware-driven version of the DP83861. The DP83865 is a low
61 * power version of the DP83861.
62 *
63 * Data Sheets available from www.national.com:
64 * http://www.national.com/ds/DP/DP83861.pdf
65 * http://www.national.com/ds/DP/DP83865.pdf
66 */
67
68 #include <sys/cdefs.h>
69 __KERNEL_RCSID(0, "$NetBSD: gphyter.c,v 1.35 2019/11/26 08:21:03 msaitoh Exp $");
70
71 #include <sys/param.h>
72 #include <sys/systm.h>
73 #include <sys/kernel.h>
74 #include <sys/device.h>
75 #include <sys/socket.h>
76 #include <sys/errno.h>
77
78 #include <net/if.h>
79 #include <net/if_media.h>
80
81 #include <dev/mii/mii.h>
82 #include <dev/mii/miivar.h>
83 #include <dev/mii/miidevs.h>
84
85 #include <dev/mii/gphyterreg.h>
86
87 static int gphytermatch(device_t, cfdata_t, void *);
88 static void gphyterattach(device_t, device_t, void *);
89
90 CFATTACH_DECL_NEW(gphyter, sizeof(struct mii_softc),
91 gphytermatch, gphyterattach, mii_phy_detach, mii_phy_activate);
92
93 static int gphyter_service(struct mii_softc *, struct mii_data *, int);
94 static void gphyter_status(struct mii_softc *);
95 static void gphyter_reset(struct mii_softc *);
96
97 static const struct mii_phy_funcs gphyter_funcs = {
98 gphyter_service, gphyter_status, gphyter_reset,
99 };
100
101 static const struct mii_phydesc gphyters[] = {
102 MII_PHY_DESC(xxNATSEMI, DP83861),
103 MII_PHY_DESC(xxNATSEMI, DP83865),
104 MII_PHY_DESC(xxNATSEMI, DP83891),
105 MII_PHY_END,
106 };
107
108 static int
109 gphytermatch(device_t parent, cfdata_t match, void *aux)
110 {
111 struct mii_attach_args *ma = aux;
112
113 if (mii_phy_match(ma, gphyters) != NULL)
114 return 10;
115
116 return 0;
117 }
118
119 static void
120 gphyterattach(device_t parent, device_t self, void *aux)
121 {
122 struct mii_softc *sc = device_private(self);
123 struct mii_attach_args *ma = aux;
124 struct mii_data *mii = ma->mii_data;
125 const struct mii_phydesc *mpd;
126 uint16_t anar, strap;
127
128 mpd = mii_phy_match(ma, gphyters);
129 aprint_naive(": Media interface\n");
130 aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
131
132 sc->mii_dev = self;
133 sc->mii_inst = mii->mii_instance;
134 sc->mii_phy = ma->mii_phyno;
135 sc->mii_funcs = &gphyter_funcs;
136 sc->mii_pdata = mii;
137 sc->mii_flags = ma->mii_flags;
138 sc->mii_anegticks = MII_ANEGTICKS;
139
140 PHY_RESET(sc);
141
142 PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
143 sc->mii_capabilities &= ma->mii_capmask;
144 if (sc->mii_capabilities & BMSR_EXTSTAT)
145 PHY_READ(sc, MII_EXTSR, &sc->mii_extcapabilities);
146
147 /*
148 * The Gig PHYTER seems to have the 10baseT BMSR bits hard-wired to 0,
149 * even though the device supports 10baseT. What we do instead is read
150 * the post-reset ANAR, who's 10baseT-related bits are set by strapping
151 * pin 180, and fake the BMSR bits.
152 */
153 PHY_READ(sc, MII_ANAR, &anar);
154 if (anar & ANAR_10)
155 sc->mii_capabilities |= (BMSR_10THDX & ma->mii_capmask);
156 if (anar & ANAR_10_FD)
157 sc->mii_capabilities |= (BMSR_10TFDX & ma->mii_capmask);
158
159 aprint_normal_dev(self, "");
160 if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 &&
161 (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0)
162 aprint_error("no media present");
163 else
164 mii_phy_add_media(sc);
165 aprint_normal("\n");
166
167 PHY_READ(sc, MII_GPHYTER_STRAP, &strap);
168 aprint_normal_dev(self, "strapped to %s mode",
169 (strap & STRAP_MS_VAL) ? "master" : "slave");
170 if (strap & STRAP_NC_MODE)
171 aprint_normal(", pre-C5 BCM5400 compat enabled");
172 aprint_normal("\n");
173 }
174
175 static int
176 gphyter_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
177 {
178 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
179 uint16_t reg;
180
181 switch (cmd) {
182 case MII_POLLSTAT:
183 /* If we're not polling our PHY instance, just return. */
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 PHY_READ(sc, MII_BMCR, ®);
195 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
196 return 0;
197 }
198
199 /* If the interface is not up, don't do anything. */
200 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
201 break;
202
203 mii_phy_setmedia(sc);
204 break;
205
206 case MII_TICK:
207 /* If we're not currently selected, just return. */
208 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
209 return 0;
210
211 if (mii_phy_tick(sc) == EJUSTRETURN)
212 return 0;
213 break;
214
215 case MII_DOWN:
216 mii_phy_down(sc);
217 return 0;
218 }
219
220 /* Update the media status. */
221 mii_phy_status(sc);
222
223 /* Callback if something changed. */
224 mii_phy_update(sc, cmd);
225 return 0;
226 }
227
228 static void
229 gphyter_status(struct mii_softc *sc)
230 {
231 struct mii_data *mii = sc->mii_pdata;
232 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
233 uint16_t bmsr, bmcr, physup, gtsr;
234
235 mii->mii_media_status = IFM_AVALID;
236 mii->mii_media_active = IFM_ETHER;
237
238 PHY_READ(sc, MII_BMSR, &bmsr);
239 PHY_READ(sc, MII_BMSR, &bmsr);
240
241 PHY_READ(sc, MII_GPHYTER_PHY_SUP, &physup);
242
243 if (physup & PHY_SUP_LINK)
244 mii->mii_media_status |= IFM_ACTIVE;
245
246 PHY_READ(sc, MII_BMCR, &bmcr);
247 if (bmcr & BMCR_ISO) {
248 mii->mii_media_active |= IFM_NONE;
249 mii->mii_media_status = 0;
250 return;
251 }
252
253 if (bmcr & BMCR_LOOP)
254 mii->mii_media_active |= IFM_LOOP;
255
256 if (bmcr & BMCR_AUTOEN) {
257 /*
258 * The media status bits are only valid if autonegotiation
259 * has completed (or it's disabled).
260 */
261 if ((bmsr & BMSR_ACOMP) == 0) {
262 /* Erg, still trying, I guess... */
263 mii->mii_media_active |= IFM_NONE;
264 return;
265 }
266
267 switch (physup & (PHY_SUP_SPEED1 | PHY_SUP_SPEED0)) {
268 case PHY_SUP_SPEED1:
269 mii->mii_media_active |= IFM_1000_T;
270 PHY_READ(sc, MII_100T2SR, >sr);
271 if (gtsr & GTSR_MS_RES)
272 mii->mii_media_active |= IFM_ETH_MASTER;
273 break;
274
275 case PHY_SUP_SPEED0:
276 mii->mii_media_active |= IFM_100_TX;
277 break;
278
279 case 0:
280 mii->mii_media_active |= IFM_10_T;
281 break;
282
283 default:
284 mii->mii_media_active |= IFM_NONE;
285 mii->mii_media_status = 0;
286 }
287 if (physup & PHY_SUP_DUPLEX)
288 mii->mii_media_active |=
289 IFM_FDX | mii_phy_flowstatus(sc);
290 else
291 mii->mii_media_active |= IFM_HDX;
292 } else
293 mii->mii_media_active = ife->ifm_media;
294 }
295
296 void
297 gphyter_reset(struct mii_softc *sc)
298 {
299 int i;
300 uint16_t reg;
301
302 if (sc->mii_flags & MIIF_NOISOLATE)
303 reg = BMCR_RESET;
304 else
305 reg = BMCR_RESET | BMCR_ISO;
306 PHY_WRITE(sc, MII_BMCR, reg);
307
308 /*
309 * It is best to allow a little time for the reset to settle in before
310 * we start polling the BMCR again. Notably, the DP83840A manual
311 * states that there should be a 500us delay between asserting software
312 * reset and attempting MII serial operations. Also, a DP83815 can get
313 * into a bad state on cable removal and reinsertion if we do not
314 * delay here.
315 */
316 delay(500);
317
318 /* Wait another 100ms for it to complete. */
319 for (i = 0; i < 100; i++) {
320 PHY_READ(sc, MII_BMCR, ®);
321 if ((reg & BMCR_RESET) == 0)
322 break;
323 delay(1000);
324 }
325
326 if (sc->mii_inst != 0 && ((sc->mii_flags & MIIF_NOISOLATE) == 0))
327 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
328 }
329