xref: /netbsd-src/sys/dev/mii/nsphy.c (revision 95d875fb90b1458e4f1de6950286ddcd6644bc61)
1 /*	$NetBSD: nsphy.c,v 1.20 1999/11/12 18:13:01 thorpej Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998, 1999 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 DP83840A ethernet 10/100 PHY
71  * Data Sheet available from www.national.com
72  */
73 
74 #include <sys/param.h>
75 #include <sys/systm.h>
76 #include <sys/kernel.h>
77 #include <sys/device.h>
78 #include <sys/malloc.h>
79 #include <sys/socket.h>
80 #include <sys/errno.h>
81 
82 #include <net/if.h>
83 #include <net/if_media.h>
84 
85 #include <dev/mii/mii.h>
86 #include <dev/mii/miivar.h>
87 #include <dev/mii/miidevs.h>
88 
89 #include <dev/mii/nsphyreg.h>
90 
91 int	nsphymatch __P((struct device *, struct cfdata *, void *));
92 void	nsphyattach __P((struct device *, struct device *, void *));
93 
94 struct cfattach nsphy_ca = {
95 	sizeof(struct mii_softc), nsphymatch, nsphyattach
96 };
97 
98 int	nsphy_service __P((struct mii_softc *, struct mii_data *, int));
99 void	nsphy_status __P((struct mii_softc *));
100 
101 int
102 nsphymatch(parent, match, aux)
103 	struct device *parent;
104 	struct cfdata *match;
105 	void *aux;
106 {
107 	struct mii_attach_args *ma = aux;
108 
109 	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_NATSEMI &&
110 	    MII_MODEL(ma->mii_id2) == MII_MODEL_NATSEMI_DP83840)
111 		return (10);
112 
113 	return (0);
114 }
115 
116 void
117 nsphyattach(parent, self, aux)
118 	struct device *parent, *self;
119 	void *aux;
120 {
121 	struct mii_softc *sc = (struct mii_softc *)self;
122 	struct mii_attach_args *ma = aux;
123 	struct mii_data *mii = ma->mii_data;
124 
125 	printf(": %s, rev. %d\n", MII_STR_NATSEMI_DP83840,
126 	    MII_REV(ma->mii_id2));
127 
128 	sc->mii_inst = mii->mii_instance;
129 	sc->mii_phy = ma->mii_phyno;
130 	sc->mii_service = nsphy_service;
131 	sc->mii_pdata = mii;
132 
133 	/*
134 	 * i82557 wedges if all of its PHYs are isolated!
135 	 */
136 	if (strcmp(parent->dv_cfdata->cf_driver->cd_name, "fxp") == 0 &&
137 	    mii->mii_instance == 0)
138 		sc->mii_flags |= MIIF_NOISOLATE;
139 
140 	mii_phy_reset(sc);
141 
142 	sc->mii_capabilities =
143 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
144 	printf("%s: ", sc->mii_dev.dv_xname);
145 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
146 		printf("no media present");
147 	else
148 		mii_add_media(sc);
149 	printf("\n");
150 }
151 
152 int
153 nsphy_service(sc, mii, cmd)
154 	struct mii_softc *sc;
155 	struct mii_data *mii;
156 	int cmd;
157 {
158 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
159 	int reg;
160 
161 	switch (cmd) {
162 	case MII_POLLSTAT:
163 		/*
164 		 * If we're not polling our PHY instance, just return.
165 		 */
166 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
167 			return (0);
168 		break;
169 
170 	case MII_MEDIACHG:
171 		/*
172 		 * If the media indicates a different PHY instance,
173 		 * isolate ourselves.
174 		 */
175 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
176 			reg = PHY_READ(sc, MII_BMCR);
177 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
178 			return (0);
179 		}
180 
181 		/*
182 		 * If the interface is not up, don't do anything.
183 		 */
184 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
185 			break;
186 
187 		reg = PHY_READ(sc, MII_NSPHY_PCR);
188 
189 		/*
190 		 * Set up the PCR to use LED4 to indicate full-duplex
191 		 * in both 10baseT and 100baseTX modes.
192 		 */
193 		reg |= PCR_LED4MODE;
194 
195 		/*
196 		 * Make sure Carrier Intgrity Monitor function is
197 		 * disabled (normal for Node operation, but sometimes
198 		 * it's not set?!)
199 		 */
200 		reg |= PCR_CIMDIS;
201 
202 		/*
203 		 * Make sure "force link good" is set to normal mode.
204 		 * It's only intended for debugging.
205 		 */
206 		reg |= PCR_FLINK100;
207 
208 #if 0
209 		/*
210 		 * Mystery bits which are supposedly `reserved',
211 		 * but we seem to need to set them when the PHY
212 		 * is connected to some interfaces!
213 		 */
214 		reg |= 0x0100 | 0x0400;
215 #endif
216 
217 		PHY_WRITE(sc, MII_NSPHY_PCR, reg);
218 
219 		switch (IFM_SUBTYPE(ife->ifm_media)) {
220 		case IFM_AUTO:
221 			/*
222 			 * If we're already in auto mode, just return.
223 			 */
224 			if (PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN)
225 				return (0);
226 			(void) mii_phy_auto(sc, 1);
227 			break;
228 		default:
229 			mii_phy_setmedia(sc);
230 		}
231 		break;
232 
233 	case MII_TICK:
234 		/*
235 		 * If we're not currently selected, just return.
236 		 */
237 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
238 			return (0);
239 
240 		/*
241 		 * Only used for autonegotiation.
242 		 */
243 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
244 			return (0);
245 
246 		/*
247 		 * Is the interface even up?
248 		 */
249 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
250 			return (0);
251 
252 		/*
253 		 * Check to see if we have link.  If we do, we don't
254 		 * need to restart the autonegotiation process.  Read
255 		 * the BMSR twice in case it's latched.
256 		 */
257 		reg = PHY_READ(sc, MII_BMSR) |
258 		    PHY_READ(sc, MII_BMSR);
259 		if (reg & BMSR_LINK)
260 			return (0);
261 
262 		/*
263 		 * Only retry autonegotiation every 5 seconds.
264 		 */
265 		if (++sc->mii_ticks != 5)
266 			return (0);
267 
268 		sc->mii_ticks = 0;
269 		mii_phy_reset(sc);
270 		if (mii_phy_auto(sc, 0) == EJUSTRETURN)
271 			return (0);
272 		break;
273 
274 	case MII_DOWN:
275 		mii_phy_down(sc);
276 		return (0);
277 	}
278 
279 	/* Update the media status. */
280 	nsphy_status(sc);
281 
282 	/* Callback if something changed. */
283 	if (sc->mii_active != mii->mii_media_active || cmd == MII_MEDIACHG) {
284 		(*mii->mii_statchg)(sc->mii_dev.dv_parent);
285 		sc->mii_active = mii->mii_media_active;
286 	}
287 	return (0);
288 }
289 
290 void
291 nsphy_status(sc)
292 	struct mii_softc *sc;
293 {
294 	struct mii_data *mii = sc->mii_pdata;
295 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
296 	int bmsr, bmcr, par, anlpar;
297 
298 	mii->mii_media_status = IFM_AVALID;
299 	mii->mii_media_active = IFM_ETHER;
300 
301 	bmsr = PHY_READ(sc, MII_BMSR) |
302 	    PHY_READ(sc, MII_BMSR);
303 	if (bmsr & BMSR_LINK)
304 		mii->mii_media_status |= IFM_ACTIVE;
305 
306 	bmcr = PHY_READ(sc, MII_BMCR);
307 	if (bmcr & BMCR_ISO) {
308 		mii->mii_media_active |= IFM_NONE;
309 		mii->mii_media_status = 0;
310 		return;
311 	}
312 
313 	if (bmcr & BMCR_LOOP)
314 		mii->mii_media_active |= IFM_LOOP;
315 
316 	if (bmcr & BMCR_AUTOEN) {
317 		/*
318 		 * The PAR status bits are only valid of autonegotiation
319 		 * has completed (or it's disabled).
320 		 */
321 		if ((bmsr & BMSR_ACOMP) == 0) {
322 			/* Erg, still trying, I guess... */
323 			mii->mii_media_active |= IFM_NONE;
324 			return;
325 		}
326 
327 		/*
328 		 * Argh.  The PAR doesn't seem to indicate duplex mode
329 		 * properly!  Determine media based on link partner's
330 		 * advertised capabilities.
331 		 */
332 		if (PHY_READ(sc, MII_ANER) & ANER_LPAN) {
333 			anlpar = PHY_READ(sc, MII_ANAR) &
334 			    PHY_READ(sc, MII_ANLPAR);
335 			if (anlpar & ANLPAR_T4)
336 				mii->mii_media_active |= IFM_100_T4;
337 			else if (anlpar & ANLPAR_TX_FD)
338 				mii->mii_media_active |= IFM_100_TX|IFM_FDX;
339 			else if (anlpar & ANLPAR_TX)
340 				mii->mii_media_active |= IFM_100_TX;
341 			else if (anlpar & ANLPAR_10_FD)
342 				mii->mii_media_active |= IFM_10_T|IFM_FDX;
343 			else if (anlpar & ANLPAR_10)
344 				mii->mii_media_active |= IFM_10_T;
345 			else
346 				mii->mii_media_active |= IFM_NONE;
347 			return;
348 		}
349 
350 		/*
351 		 * Link partner is not capable of autonegotiation.
352 		 * We will never be in full-duplex mode if this is
353 		 * the case, so reading the PAR is OK.
354 		 */
355 		par = PHY_READ(sc, MII_NSPHY_PAR);
356 		if (par & PAR_10)
357 			mii->mii_media_active |= IFM_10_T;
358 		else
359 			mii->mii_media_active |= IFM_100_TX;
360 #if 0
361 		if (par & PAR_FDX)
362 			mii->mii_media_active |= IFM_FDX;
363 #endif
364 	} else
365 		mii->mii_media_active = ife->ifm_media;
366 }
367