xref: /freebsd/sys/dev/mii/nsphyter.c (revision af23369a6deaaeb612ab266eb88b8bb8d560c322)
1 /*	$NetBSD: nsphyter.c,v 1.28 2008/01/20 07:58:19 msaitoh Exp $	*/
2 
3 /*-
4  * SPDX-License-Identifier: BSD-2-Clause-NetBSD AND 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 __FBSDID("$FreeBSD$");
61 
62 /*
63  * Driver for the National Semiconductor's DP83843, DP83847 and DP83849
64  * `PHYTER' Ethernet 10/100 PHYs
65  * Data Sheets are available from http://www.national.com
66  *
67  * We also support the DP83815 `MacPHYTER' internal PHY since, for our
68  * purposes, they are compatible.
69  */
70 
71 #include <sys/param.h>
72 #include <sys/systm.h>
73 #include <sys/bus.h>
74 #include <sys/errno.h>
75 #include <sys/kernel.h>
76 #include <sys/module.h>
77 #include <sys/socket.h>
78 
79 #include <net/if.h>
80 #include <net/if_media.h>
81 
82 #include <dev/mii/mii.h>
83 #include <dev/mii/miivar.h>
84 #include "miidevs.h"
85 
86 #include <dev/mii/nsphyterreg.h>
87 
88 #include "miibus_if.h"
89 
90 static device_probe_t	nsphyter_probe;
91 static device_attach_t	nsphyter_attach;
92 
93 static device_method_t nsphyter_methods[] = {
94 	/* device interface */
95 	DEVMETHOD(device_probe,		nsphyter_probe),
96 	DEVMETHOD(device_attach,	nsphyter_attach),
97 	DEVMETHOD(device_detach,	mii_phy_detach),
98 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
99 	DEVMETHOD_END
100 };
101 
102 static driver_t nsphyter_driver = {
103 	"nsphyter",
104 	nsphyter_methods,
105 	sizeof(struct mii_softc)
106 };
107 
108 DRIVER_MODULE(nsphyter, miibus, nsphyter_driver, 0, 0);
109 
110 static int	nsphyter_service(struct mii_softc *, struct mii_data *, int);
111 static void	nsphyter_status(struct mii_softc *);
112 static void	nsphyter_reset(struct mii_softc *);
113 
114 static const struct mii_phydesc nsphyters[] = {
115 	MII_PHY_DESC(xxNATSEMI, DP83815),
116 	MII_PHY_DESC(xxNATSEMI, DP83843),
117 	MII_PHY_DESC(xxNATSEMI, DP83847),
118 	MII_PHY_DESC(xxNATSEMI, DP83849),
119 	MII_PHY_END
120 };
121 
122 static const struct mii_phy_funcs nsphyter_funcs = {
123 	nsphyter_service,
124 	nsphyter_status,
125 	nsphyter_reset
126 };
127 
128 static int
129 nsphyter_probe(device_t dev)
130 {
131 
132 	return (mii_phy_dev_probe(dev, nsphyters, BUS_PROBE_DEFAULT));
133 }
134 
135 static int
136 nsphyter_attach(device_t dev)
137 {
138 
139 	mii_phy_dev_attach(dev, MIIF_NOMANPAUSE, &nsphyter_funcs, 1);
140 	return (0);
141 }
142 
143 static int
144 nsphyter_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
145 {
146 
147 	switch (cmd) {
148 	case MII_POLLSTAT:
149 		break;
150 
151 	case MII_MEDIACHG:
152 		mii_phy_setmedia(sc);
153 		break;
154 
155 	case MII_TICK:
156 		if (mii_phy_tick(sc) == EJUSTRETURN)
157 			return (0);
158 		break;
159 	}
160 
161 	/* Update the media status. */
162 	PHY_STATUS(sc);
163 
164 	/* Callback if something changed. */
165 	mii_phy_update(sc, cmd);
166 	return (0);
167 }
168 
169 static void
170 nsphyter_status(struct mii_softc *sc)
171 {
172 	struct mii_data *mii = sc->mii_pdata;
173 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
174 	int bmsr, bmcr, physts;
175 
176 	mii->mii_media_status = IFM_AVALID;
177 	mii->mii_media_active = IFM_ETHER;
178 
179 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
180 	physts = PHY_READ(sc, MII_NSPHYTER_PHYSTS);
181 
182 	if ((physts & PHYSTS_LINK) != 0)
183 		mii->mii_media_status |= IFM_ACTIVE;
184 
185 	bmcr = PHY_READ(sc, MII_BMCR);
186 	if ((bmcr & BMCR_ISO) != 0) {
187 		mii->mii_media_active |= IFM_NONE;
188 		mii->mii_media_status = 0;
189 		return;
190 	}
191 
192 	if ((bmcr & BMCR_LOOP) != 0)
193 		mii->mii_media_active |= IFM_LOOP;
194 
195 	if ((bmcr & BMCR_AUTOEN) != 0) {
196 		/*
197 		 * The media status bits are only valid if autonegotiation
198 		 * has completed (or it's disabled).
199 		 */
200 		if ((bmsr & BMSR_ACOMP) == 0) {
201 			/* Erg, still trying, I guess... */
202 			mii->mii_media_active |= IFM_NONE;
203 			return;
204 		}
205 
206 		if ((physts & PHYSTS_SPEED10) != 0)
207 			mii->mii_media_active |= IFM_10_T;
208 		else
209 			mii->mii_media_active |= IFM_100_TX;
210 		if ((physts & PHYSTS_DUPLEX) != 0)
211 			mii->mii_media_active |=
212 			    IFM_FDX | mii_phy_flowstatus(sc);
213 		else
214 			mii->mii_media_active |= IFM_HDX;
215 	} else
216 		mii->mii_media_active = ife->ifm_media;
217 }
218 
219 static void
220 nsphyter_reset(struct mii_softc *sc)
221 {
222 	struct ifmedia_entry *ife = sc->mii_pdata->mii_media.ifm_cur;
223 	int reg, i;
224 
225 	if ((sc->mii_flags & MIIF_NOISOLATE) != 0)
226 		reg = BMCR_RESET;
227 	else
228 		reg = BMCR_RESET | BMCR_ISO;
229 	PHY_WRITE(sc, MII_BMCR, reg);
230 
231 	/*
232 	 * It is best to allow a little time for the reset to settle
233 	 * in before we start polling the BMCR again.  Notably, the
234 	 * DP8384{3,7} manuals state that there should be a 500us delay
235 	 * between asserting software reset and attempting MII serial
236 	 * operations.  Be conservative.  Also, a DP83815 can get into
237 	 * a bad state on cable removal and reinsertion if we do not
238 	 * delay here.
239 	 */
240 	DELAY(1000);
241 
242 	/*
243 	 * Wait another 2s for it to complete.
244 	 * This is only a little overkill as under normal circumstances
245 	 * the PHY can take up to 1s to complete reset.
246 	 * This is also a bit odd because after a reset, the BMCR will
247 	 * clear the reset bit and simply reports 0 even though the reset
248 	 * is not yet complete.
249 	 */
250 	for (i = 0; i < 1000; i++) {
251 		reg = PHY_READ(sc, MII_BMCR);
252 		if (reg != 0 && (reg & BMCR_RESET) == 0)
253 			break;
254 		DELAY(2000);
255 	}
256 
257 	if ((sc->mii_flags & MIIF_NOISOLATE) == 0) {
258 		if ((ife == NULL && sc->mii_inst != 0) ||
259 		    (ife != NULL && IFM_INST(ife->ifm_media) != sc->mii_inst))
260 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
261 	}
262 }
263