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