1 /* $NetBSD: nsphyter.c,v 1.39 2016/07/07 06:55:41 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 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.39 2016/07/07 06:55:41 msaitoh 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_OUI_xxNATSEMI, MII_MODEL_xxNATSEMI_DP83843,
101 MII_STR_xxNATSEMI_DP83843 },
102
103 { MII_OUI_xxNATSEMI, MII_MODEL_xxNATSEMI_DP83847,
104 MII_STR_xxNATSEMI_DP83847 },
105
106 { MII_OUI_xxNATSEMI, MII_MODEL_xxNATSEMI_DP83849,
107 MII_STR_xxNATSEMI_DP83849 },
108
109 { MII_OUI_xxNATSEMI, MII_MODEL_xxNATSEMI_DP83815,
110 MII_STR_xxNATSEMI_DP83815 },
111
112 { 0, 0,
113 NULL },
114 };
115
116 static int
nsphytermatch(device_t parent,cfdata_t match,void * aux)117 nsphytermatch(device_t parent, cfdata_t match, void *aux)
118 {
119 struct mii_attach_args *ma = aux;
120
121 if (mii_phy_match(ma, nsphyters) != NULL)
122 return (10);
123
124 return (0);
125 }
126
127 static void
nsphyterattach(device_t parent,device_t self,void * aux)128 nsphyterattach(device_t parent, device_t self, void *aux)
129 {
130 struct mii_softc *sc = device_private(self);
131 struct mii_attach_args *ma = aux;
132 struct mii_data *mii = ma->mii_data;
133 const struct mii_phydesc *mpd;
134
135 mpd = mii_phy_match(ma, nsphyters);
136 aprint_naive(": Media interface\n");
137 aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
138
139 sc->mii_dev = self;
140 sc->mii_inst = mii->mii_instance;
141 sc->mii_phy = ma->mii_phyno;
142 sc->mii_funcs = &nsphyter_funcs;
143 sc->mii_pdata = mii;
144 sc->mii_flags = ma->mii_flags;
145 sc->mii_anegticks = MII_ANEGTICKS;
146
147 PHY_RESET(sc);
148
149 sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
150 aprint_normal_dev(self, "");
151 if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
152 aprint_error("no media present");
153 else
154 mii_phy_add_media(sc);
155 aprint_normal("\n");
156 }
157
158 static int
nsphyter_service(struct mii_softc * sc,struct mii_data * mii,int cmd)159 nsphyter_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
160 {
161 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
162 int reg;
163
164 switch (cmd) {
165 case MII_POLLSTAT:
166 /*
167 * If we're not polling our PHY instance, just return.
168 */
169 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
170 return (0);
171 break;
172
173 case MII_MEDIACHG:
174 /*
175 * If the media indicates a different PHY instance,
176 * isolate ourselves.
177 */
178 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
179 reg = PHY_READ(sc, MII_BMCR);
180 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
181 return (0);
182 }
183
184 /*
185 * If the interface is not up, don't do anything.
186 */
187 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
188 break;
189
190 mii_phy_setmedia(sc);
191 break;
192
193 case MII_TICK:
194 /*
195 * If we're not currently selected, just return.
196 */
197 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
198 return (0);
199
200 if (mii_phy_tick(sc) == EJUSTRETURN)
201 return (0);
202 break;
203
204 case MII_DOWN:
205 mii_phy_down(sc);
206 return (0);
207 }
208
209 /* Update the media status. */
210 mii_phy_status(sc);
211
212 /* Callback if something changed. */
213 mii_phy_update(sc, cmd);
214 return (0);
215 }
216
217 static void
nsphyter_status(struct mii_softc * sc)218 nsphyter_status(struct mii_softc *sc)
219 {
220 struct mii_data *mii = sc->mii_pdata;
221 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
222 int bmsr, bmcr, physts;
223
224 mii->mii_media_status = IFM_AVALID;
225 mii->mii_media_active = IFM_ETHER;
226
227 bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
228 physts = PHY_READ(sc, MII_NSPHYTER_PHYSTS);
229
230 if (physts & PHYSTS_LINK)
231 mii->mii_media_status |= IFM_ACTIVE;
232
233 bmcr = PHY_READ(sc, MII_BMCR);
234 if (bmcr & BMCR_ISO) {
235 mii->mii_media_active |= IFM_NONE;
236 mii->mii_media_status = 0;
237 return;
238 }
239
240 if (bmcr & BMCR_LOOP)
241 mii->mii_media_active |= IFM_LOOP;
242
243 if (bmcr & BMCR_AUTOEN) {
244 /*
245 * The media status bits are only valid if autonegotiation
246 * has completed (or it's disabled).
247 */
248 if ((bmsr & BMSR_ACOMP) == 0) {
249 /* Erg, still trying, I guess... */
250 mii->mii_media_active |= IFM_NONE;
251 return;
252 }
253
254 if (physts & PHYSTS_SPEED10)
255 mii->mii_media_active |= IFM_10_T;
256 else
257 mii->mii_media_active |= IFM_100_TX;
258
259 if (physts & PHYSTS_DUPLEX)
260 mii->mii_media_active |=
261 IFM_FDX | mii_phy_flowstatus(sc);
262 else
263 mii->mii_media_active |= IFM_HDX;
264 } else
265 mii->mii_media_active = ife->ifm_media;
266 }
267
268 void
nsphyter_reset(struct mii_softc * sc)269 nsphyter_reset(struct mii_softc *sc)
270 {
271 int reg, i;
272
273 if (sc->mii_flags & MIIF_NOISOLATE)
274 reg = BMCR_RESET;
275 else
276 reg = BMCR_RESET | BMCR_ISO;
277 PHY_WRITE(sc, MII_BMCR, reg);
278
279 /*
280 * It is best to allow a little time for the reset to settle
281 * in before we start polling the BMCR again. Notably, the
282 * DP83840A manual states that there should be a 500us delay
283 * between asserting software reset and attempting MII serial
284 * operations. Also, a DP83815 can get into a bad state on
285 * cable removal and reinsertion if we do not delay here.
286 */
287 delay(500);
288
289 /* Wait another 100ms for it to complete. */
290 for (i = 0; i < 100; i++) {
291 reg = PHY_READ(sc, MII_BMCR);
292 if ((reg & BMCR_RESET) == 0)
293 break;
294 delay(1000);
295 }
296
297 if (sc->mii_inst != 0 && ((sc->mii_flags & MIIF_NOISOLATE) == 0))
298 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
299 }
300