1 /* $NetBSD: nsphyter.c,v 1.28 2008/01/20 07:58:19 msaitoh Exp $ */
2
3 /*-
4 * SPDX-License-Identifier: BSD-2-Clause
5 *
6 * Copyright (c) 1998, 1999, 2000, 2001 The NetBSD Foundation, Inc.
7 * All rights reserved.
8 *
9 * This code is derived from software contributed to The NetBSD Foundation
10 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
11 * NASA Ames Research Center.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
24 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
25 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
26 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
33 */
34
35 /*-
36 * Copyright (c) 1997 Manuel Bouyer. All rights reserved.
37 *
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
40 * are met:
41 * 1. Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * 2. Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in the
45 * documentation and/or other materials provided with the distribution.
46 *
47 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
48 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
49 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
50 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
51 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
52 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
53 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
54 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
55 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
56 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
57 */
58
59 #include <sys/cdefs.h>
60 /*
61 * Driver for the National Semiconductor's DP83843, DP83847 and DP83849
62 * `PHYTER' Ethernet 10/100 PHYs
63 * Data Sheets are available from http://www.national.com
64 *
65 * We also support the DP83815 `MacPHYTER' internal PHY since, for our
66 * purposes, they are compatible.
67 */
68
69 #include <sys/param.h>
70 #include <sys/systm.h>
71 #include <sys/bus.h>
72 #include <sys/errno.h>
73 #include <sys/kernel.h>
74 #include <sys/module.h>
75 #include <sys/socket.h>
76
77 #include <net/if.h>
78 #include <net/if_media.h>
79
80 #include <dev/mii/mii.h>
81 #include <dev/mii/miivar.h>
82 #include "miidevs.h"
83
84 #include <dev/mii/nsphyterreg.h>
85
86 #include "miibus_if.h"
87
88 static device_probe_t nsphyter_probe;
89 static device_attach_t nsphyter_attach;
90
91 static device_method_t nsphyter_methods[] = {
92 /* device interface */
93 DEVMETHOD(device_probe, nsphyter_probe),
94 DEVMETHOD(device_attach, nsphyter_attach),
95 DEVMETHOD(device_detach, mii_phy_detach),
96 DEVMETHOD(device_shutdown, bus_generic_shutdown),
97 DEVMETHOD_END
98 };
99
100 static driver_t nsphyter_driver = {
101 "nsphyter",
102 nsphyter_methods,
103 sizeof(struct mii_softc)
104 };
105
106 DRIVER_MODULE(nsphyter, miibus, nsphyter_driver, 0, 0);
107
108 static int nsphyter_service(struct mii_softc *, struct mii_data *, int);
109 static void nsphyter_status(struct mii_softc *);
110 static void nsphyter_reset(struct mii_softc *);
111
112 static const struct mii_phydesc nsphyters[] = {
113 MII_PHY_DESC(xxNATSEMI, DP83815),
114 MII_PHY_DESC(xxNATSEMI, DP83843),
115 MII_PHY_DESC(xxNATSEMI, DP83847),
116 MII_PHY_DESC(xxNATSEMI, DP83849),
117 MII_PHY_END
118 };
119
120 static const struct mii_phy_funcs nsphyter_funcs = {
121 nsphyter_service,
122 nsphyter_status,
123 nsphyter_reset
124 };
125
126 static int
nsphyter_probe(device_t dev)127 nsphyter_probe(device_t dev)
128 {
129
130 return (mii_phy_dev_probe(dev, nsphyters, BUS_PROBE_DEFAULT));
131 }
132
133 static int
nsphyter_attach(device_t dev)134 nsphyter_attach(device_t dev)
135 {
136
137 mii_phy_dev_attach(dev, MIIF_NOMANPAUSE, &nsphyter_funcs, 1);
138 return (0);
139 }
140
141 static int
nsphyter_service(struct mii_softc * sc,struct mii_data * mii,int cmd)142 nsphyter_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
143 {
144
145 switch (cmd) {
146 case MII_POLLSTAT:
147 break;
148
149 case MII_MEDIACHG:
150 mii_phy_setmedia(sc);
151 break;
152
153 case MII_TICK:
154 if (mii_phy_tick(sc) == EJUSTRETURN)
155 return (0);
156 break;
157 }
158
159 /* Update the media status. */
160 PHY_STATUS(sc);
161
162 /* Callback if something changed. */
163 mii_phy_update(sc, cmd);
164 return (0);
165 }
166
167 static void
nsphyter_status(struct mii_softc * sc)168 nsphyter_status(struct mii_softc *sc)
169 {
170 struct mii_data *mii = sc->mii_pdata;
171 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
172 int bmsr, bmcr, physts;
173
174 mii->mii_media_status = IFM_AVALID;
175 mii->mii_media_active = IFM_ETHER;
176
177 bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
178 physts = PHY_READ(sc, MII_NSPHYTER_PHYSTS);
179
180 if ((physts & PHYSTS_LINK) != 0)
181 mii->mii_media_status |= IFM_ACTIVE;
182
183 bmcr = PHY_READ(sc, MII_BMCR);
184 if ((bmcr & BMCR_ISO) != 0) {
185 mii->mii_media_active |= IFM_NONE;
186 mii->mii_media_status = 0;
187 return;
188 }
189
190 if ((bmcr & BMCR_LOOP) != 0)
191 mii->mii_media_active |= IFM_LOOP;
192
193 if ((bmcr & BMCR_AUTOEN) != 0) {
194 /*
195 * The media status bits are only valid if autonegotiation
196 * has completed (or it's disabled).
197 */
198 if ((bmsr & BMSR_ACOMP) == 0) {
199 /* Erg, still trying, I guess... */
200 mii->mii_media_active |= IFM_NONE;
201 return;
202 }
203
204 if ((physts & PHYSTS_SPEED10) != 0)
205 mii->mii_media_active |= IFM_10_T;
206 else
207 mii->mii_media_active |= IFM_100_TX;
208 if ((physts & PHYSTS_DUPLEX) != 0)
209 mii->mii_media_active |=
210 IFM_FDX | mii_phy_flowstatus(sc);
211 else
212 mii->mii_media_active |= IFM_HDX;
213 } else
214 mii->mii_media_active = ife->ifm_media;
215 }
216
217 static void
nsphyter_reset(struct mii_softc * sc)218 nsphyter_reset(struct mii_softc *sc)
219 {
220 struct ifmedia_entry *ife = sc->mii_pdata->mii_media.ifm_cur;
221 int reg, i;
222
223 if ((sc->mii_flags & MIIF_NOISOLATE) != 0)
224 reg = BMCR_RESET;
225 else
226 reg = BMCR_RESET | BMCR_ISO;
227 PHY_WRITE(sc, MII_BMCR, reg);
228
229 /*
230 * It is best to allow a little time for the reset to settle
231 * in before we start polling the BMCR again. Notably, the
232 * DP8384{3,7} manuals state that there should be a 500us delay
233 * between asserting software reset and attempting MII serial
234 * operations. Be conservative. Also, a DP83815 can get into
235 * a bad state on cable removal and reinsertion if we do not
236 * delay here.
237 */
238 DELAY(1000);
239
240 /*
241 * Wait another 2s for it to complete.
242 * This is only a little overkill as under normal circumstances
243 * the PHY can take up to 1s to complete reset.
244 * This is also a bit odd because after a reset, the BMCR will
245 * clear the reset bit and simply reports 0 even though the reset
246 * is not yet complete.
247 */
248 for (i = 0; i < 1000; i++) {
249 reg = PHY_READ(sc, MII_BMCR);
250 if (reg != 0 && (reg & BMCR_RESET) == 0)
251 break;
252 DELAY(2000);
253 }
254
255 if ((sc->mii_flags & MIIF_NOISOLATE) == 0) {
256 if ((ife == NULL && sc->mii_inst != 0) ||
257 (ife != NULL && IFM_INST(ife->ifm_media) != sc->mii_inst))
258 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
259 }
260 }
261