nsphyter.c revision 1.45 1 /* $NetBSD: nsphyter.c,v 1.45 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 National Semiconductor's DP83843 `PHYTER' ethernet 10/100 PHY
59 * Data Sheet available from www.national.com
60 *
61 * We also support the DP83815 MacPHYER internal PHY since, for our
62 * purposes, they are compatible.
63 */
64
65 #include <sys/cdefs.h>
66 __KERNEL_RCSID(0, "$NetBSD: nsphyter.c,v 1.45 2020/03/15 23:04:50 thorpej Exp $");
67
68 #include <sys/param.h>
69 #include <sys/systm.h>
70 #include <sys/kernel.h>
71 #include <sys/device.h>
72 #include <sys/socket.h>
73 #include <sys/errno.h>
74
75 #include <net/if.h>
76 #include <net/if_media.h>
77
78 #include <dev/mii/mii.h>
79 #include <dev/mii/miivar.h>
80 #include <dev/mii/miidevs.h>
81
82 #include <dev/mii/nsphyterreg.h>
83
84 static int nsphytermatch(device_t, cfdata_t, void *);
85 static void nsphyterattach(device_t, device_t, void *);
86
87 CFATTACH_DECL3_NEW(nsphyter, sizeof(struct mii_softc),
88 nsphytermatch, nsphyterattach, mii_phy_detach, mii_phy_activate, NULL,
89 NULL, DVF_DETACH_SHUTDOWN);
90
91 static int nsphyter_service(struct mii_softc *, struct mii_data *, int);
92 static void nsphyter_status(struct mii_softc *);
93 static void nsphyter_reset(struct mii_softc *);
94
95 static const struct mii_phy_funcs nsphyter_funcs = {
96 nsphyter_service, nsphyter_status, nsphyter_reset,
97 };
98
99 static const struct mii_phydesc nsphyters[] = {
100 MII_PHY_DESC(xxNATSEMI, DP83843),
101 MII_PHY_DESC(xxNATSEMI, DP83847),
102 MII_PHY_DESC(xxNATSEMI, DP83849),
103 MII_PHY_DESC(xxNATSEMI, DP83815),
104 MII_PHY_END,
105 };
106
107 static int
108 nsphytermatch(device_t parent, cfdata_t match, void *aux)
109 {
110 struct mii_attach_args *ma = aux;
111
112 if (mii_phy_match(ma, nsphyters) != NULL)
113 return 10;
114
115 return 0;
116 }
117
118 static void
119 nsphyterattach(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, nsphyters);
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_inst = mii->mii_instance;
132 sc->mii_phy = ma->mii_phyno;
133 sc->mii_funcs = &nsphyter_funcs;
134 sc->mii_pdata = mii;
135 sc->mii_flags = ma->mii_flags;
136
137 mii_lock(mii);
138
139 PHY_RESET(sc);
140
141 PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
142 sc->mii_capabilities &= ma->mii_capmask;
143
144 mii_unlock(mii);
145
146 mii_phy_add_media(sc);
147 }
148
149 static int
150 nsphyter_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
151 {
152 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
153 uint16_t reg;
154
155 KASSERT(mii_locked(mii));
156
157 switch (cmd) {
158 case MII_POLLSTAT:
159 /* If we're not polling our PHY instance, just return. */
160 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
161 return 0;
162 break;
163
164 case MII_MEDIACHG:
165 /*
166 * If the media indicates a different PHY instance,
167 * isolate ourselves.
168 */
169 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
170 PHY_READ(sc, MII_BMCR, ®);
171 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
172 return 0;
173 }
174
175 /* If the interface is not up, don't do anything. */
176 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
177 break;
178
179 mii_phy_setmedia(sc);
180 break;
181
182 case MII_TICK:
183 /* If we're not currently selected, just return. */
184 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
185 return 0;
186
187 if (mii_phy_tick(sc) == EJUSTRETURN)
188 return 0;
189 break;
190
191 case MII_DOWN:
192 mii_phy_down(sc);
193 return 0;
194 }
195
196 /* Update the media status. */
197 mii_phy_status(sc);
198
199 /* Callback if something changed. */
200 mii_phy_update(sc, cmd);
201 return 0;
202 }
203
204 static void
205 nsphyter_status(struct mii_softc *sc)
206 {
207 struct mii_data *mii = sc->mii_pdata;
208 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
209 uint16_t bmsr, bmcr, physts;
210
211 KASSERT(mii_locked(mii));
212
213 mii->mii_media_status = IFM_AVALID;
214 mii->mii_media_active = IFM_ETHER;
215
216 PHY_READ(sc, MII_BMSR, &bmsr);
217 PHY_READ(sc, MII_BMSR, &bmsr);
218 PHY_READ(sc, MII_NSPHYTER_PHYSTS, &physts);
219
220 if (physts & PHYSTS_LINK)
221 mii->mii_media_status |= IFM_ACTIVE;
222
223 PHY_READ(sc, MII_BMCR, &bmcr);
224 if (bmcr & BMCR_ISO) {
225 mii->mii_media_active |= IFM_NONE;
226 mii->mii_media_status = 0;
227 return;
228 }
229
230 if (bmcr & BMCR_LOOP)
231 mii->mii_media_active |= IFM_LOOP;
232
233 if (bmcr & BMCR_AUTOEN) {
234 /*
235 * The media status bits are only valid if autonegotiation
236 * has completed (or it's disabled).
237 */
238 if ((bmsr & BMSR_ACOMP) == 0) {
239 /* Erg, still trying, I guess... */
240 mii->mii_media_active |= IFM_NONE;
241 return;
242 }
243
244 if (physts & PHYSTS_SPEED10)
245 mii->mii_media_active |= IFM_10_T;
246 else
247 mii->mii_media_active |= IFM_100_TX;
248
249 if (physts & PHYSTS_DUPLEX)
250 mii->mii_media_active |=
251 IFM_FDX | mii_phy_flowstatus(sc);
252 else
253 mii->mii_media_active |= IFM_HDX;
254 } else
255 mii->mii_media_active = ife->ifm_media;
256 }
257
258 static void
259 nsphyter_reset(struct mii_softc *sc)
260 {
261 int i;
262 uint16_t reg;
263
264 KASSERT(mii_locked(sc->mii_pdata));
265
266 if (sc->mii_flags & MIIF_NOISOLATE)
267 reg = BMCR_RESET;
268 else
269 reg = BMCR_RESET | BMCR_ISO;
270 PHY_WRITE(sc, MII_BMCR, reg);
271
272 /*
273 * It is best to allow a little time for the reset to settle
274 * in before we start polling the BMCR again. Notably, the
275 * DP83840A manual states that there should be a 500us delay
276 * between asserting software reset and attempting MII serial
277 * operations. Also, a DP83815 can get into a bad state on
278 * cable removal and reinsertion if we do not delay here.
279 */
280 delay(500);
281
282 /* Wait another 100ms for it to complete. */
283 for (i = 0; i < 100; i++) {
284 PHY_READ(sc, MII_BMCR, ®);
285 if ((reg & BMCR_RESET) == 0)
286 break;
287 delay(1000);
288 }
289
290 if (sc->mii_inst != 0 && ((sc->mii_flags & MIIF_NOISOLATE) == 0))
291 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
292 }
293