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