xref: /netbsd-src/sys/dev/mii/nsphyter.c (revision b7b7574d3bf8eeb51a1fa3977b59142ec6434a55)
1 /*	$NetBSD: nsphyter.c,v 1.38 2014/06/16 16:48:16 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.38 2014/06/16 16:48:16 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
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
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 =
150 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
151 	aprint_normal_dev(self, "");
152 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
153 		aprint_error("no media present");
154 	else
155 		mii_phy_add_media(sc);
156 	aprint_normal("\n");
157 }
158 
159 static int
160 nsphyter_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
161 {
162 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
163 	int reg;
164 
165 	switch (cmd) {
166 	case MII_POLLSTAT:
167 		/*
168 		 * If we're not polling our PHY instance, just return.
169 		 */
170 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
171 			return (0);
172 		break;
173 
174 	case MII_MEDIACHG:
175 		/*
176 		 * If the media indicates a different PHY instance,
177 		 * isolate ourselves.
178 		 */
179 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
180 			reg = PHY_READ(sc, MII_BMCR);
181 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
182 			return (0);
183 		}
184 
185 		/*
186 		 * If the interface is not up, don't do anything.
187 		 */
188 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
189 			break;
190 
191 		mii_phy_setmedia(sc);
192 		break;
193 
194 	case MII_TICK:
195 		/*
196 		 * If we're not currently selected, just return.
197 		 */
198 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
199 			return (0);
200 
201 		if (mii_phy_tick(sc) == EJUSTRETURN)
202 			return (0);
203 		break;
204 
205 	case MII_DOWN:
206 		mii_phy_down(sc);
207 		return (0);
208 	}
209 
210 	/* Update the media status. */
211 	mii_phy_status(sc);
212 
213 	/* Callback if something changed. */
214 	mii_phy_update(sc, cmd);
215 	return (0);
216 }
217 
218 static void
219 nsphyter_status(struct mii_softc *sc)
220 {
221 	struct mii_data *mii = sc->mii_pdata;
222 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
223 	int bmsr, bmcr, physts;
224 
225 	mii->mii_media_status = IFM_AVALID;
226 	mii->mii_media_active = IFM_ETHER;
227 
228 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
229 	physts = PHY_READ(sc, MII_NSPHYTER_PHYSTS);
230 
231 	if (physts & PHYSTS_LINK)
232 		mii->mii_media_status |= IFM_ACTIVE;
233 
234 	bmcr = PHY_READ(sc, MII_BMCR);
235 	if (bmcr & BMCR_ISO) {
236 		mii->mii_media_active |= IFM_NONE;
237 		mii->mii_media_status = 0;
238 		return;
239 	}
240 
241 	if (bmcr & BMCR_LOOP)
242 		mii->mii_media_active |= IFM_LOOP;
243 
244 	if (bmcr & BMCR_AUTOEN) {
245 		/*
246 		 * The media status bits are only valid if autonegotiation
247 		 * has completed (or it's disabled).
248 		 */
249 		if ((bmsr & BMSR_ACOMP) == 0) {
250 			/* Erg, still trying, I guess... */
251 			mii->mii_media_active |= IFM_NONE;
252 			return;
253 		}
254 
255 		if (physts & PHYSTS_SPEED10)
256 			mii->mii_media_active |= IFM_10_T;
257 		else
258 			mii->mii_media_active |= IFM_100_TX;
259 
260 		if (physts & PHYSTS_DUPLEX)
261 			mii->mii_media_active |=
262 			    IFM_FDX | mii_phy_flowstatus(sc);
263 		else
264 			mii->mii_media_active |= IFM_HDX;
265 	} else
266 		mii->mii_media_active = ife->ifm_media;
267 }
268 
269 void
270 nsphyter_reset(struct mii_softc *sc)
271 {
272 	int reg, i;
273 
274 	if (sc->mii_flags & MIIF_NOISOLATE)
275 		reg = BMCR_RESET;
276 	else
277 		reg = BMCR_RESET | BMCR_ISO;
278 	PHY_WRITE(sc, MII_BMCR, reg);
279 
280 	/*
281 	 * It is best to allow a little time for the reset to settle
282 	 * in before we start polling the BMCR again.  Notably, the
283 	 * DP83840A manual states that there should be a 500us delay
284 	 * between asserting software reset and attempting MII serial
285 	 * operations.  Also, a DP83815 can get into a bad state on
286 	 * cable removal and reinsertion if we do not delay here.
287 	 */
288 	delay(500);
289 
290 	/* Wait another 100ms for it to complete. */
291 	for (i = 0; i < 100; i++) {
292 		reg = PHY_READ(sc, MII_BMCR);
293 		if ((reg & BMCR_RESET) == 0)
294 			break;
295 		delay(1000);
296 	}
297 
298 	if (sc->mii_inst != 0 && ((sc->mii_flags & MIIF_NOISOLATE) == 0))
299 		PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
300 }
301