xref: /openbsd/sys/dev/mii/nsphy.c (revision d485f761)
1 /*	$OpenBSD: nsphy.c,v 1.10 2001/10/05 18:26:48 nate Exp $	*/
2 /*	$NetBSD: nsphy.c,v 1.25 2000/02/02 23:34:57 thorpej Exp $	*/
3 
4 /*-
5  * Copyright (c) 1998, 1999 The NetBSD Foundation, Inc.
6  * All rights reserved.
7  *
8  * This code is derived from software contributed to The NetBSD Foundation
9  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
10  * NASA Ames Research Center.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. All advertising materials mentioning features or use of this software
21  *    must display the following acknowledgement:
22  *	This product includes software developed by the NetBSD
23  *	Foundation, Inc. and its contributors.
24  * 4. Neither the name of The NetBSD Foundation nor the names of its
25  *    contributors may be used to endorse or promote products derived
26  *    from this software without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
29  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
32  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38  * POSSIBILITY OF SUCH DAMAGE.
39  */
40 
41 /*
42  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
43  *
44  * Redistribution and use in source and binary forms, with or without
45  * modification, are permitted provided that the following conditions
46  * are met:
47  * 1. Redistributions of source code must retain the above copyright
48  *    notice, this list of conditions and the following disclaimer.
49  * 2. Redistributions in binary form must reproduce the above copyright
50  *    notice, this list of conditions and the following disclaimer in the
51  *    documentation and/or other materials provided with the distribution.
52  * 3. All advertising materials mentioning features or use of this software
53  *    must display the following acknowledgement:
54  *	This product includes software developed by Manuel Bouyer.
55  * 4. The name of the author may not be used to endorse or promote products
56  *    derived from this software without specific prior written permission.
57  *
58  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
59  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
60  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
61  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
62  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
63  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
64  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
65  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
66  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
67  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
68  */
69 
70 /*
71  * driver for National Semiconductor's DP83840A ethernet 10/100 PHY
72  * Data Sheet available from www.national.com
73  */
74 
75 #include <sys/param.h>
76 #include <sys/systm.h>
77 #include <sys/kernel.h>
78 #include <sys/device.h>
79 #include <sys/malloc.h>
80 #include <sys/socket.h>
81 #include <sys/errno.h>
82 
83 #include <net/if.h>
84 #include <net/if_media.h>
85 
86 #include <dev/mii/mii.h>
87 #include <dev/mii/miivar.h>
88 #include <dev/mii/miidevs.h>
89 
90 #include <dev/mii/nsphyreg.h>
91 
92 int	nsphymatch __P((struct device *, void *, void *));
93 void	nsphyattach __P((struct device *, struct device *, void *));
94 
95 struct cfattach nsphy_ca = {
96 	sizeof(struct mii_softc), nsphymatch, nsphyattach, mii_phy_detach,
97 	    mii_phy_activate
98 };
99 
100 struct cfdriver nsphy_cd = {
101 	NULL, "nsphy", DV_DULL
102 };
103 
104 int	nsphy_service __P((struct mii_softc *, struct mii_data *, int));
105 void	nsphy_status __P((struct mii_softc *));
106 void	nsphy_reset __P((struct mii_softc *));
107 
108 int
109 nsphymatch(parent, match, aux)
110 	struct device *parent;
111 	void *match;
112 	void *aux;
113 {
114 	struct mii_attach_args *ma = aux;
115 
116 	if (MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_NATSEMI &&
117 	    MII_MODEL(ma->mii_id2) == MII_MODEL_NATSEMI_DP83840)
118 		return (10);
119 
120 	return (0);
121 }
122 
123 void
124 nsphyattach(parent, self, aux)
125 	struct device *parent;
126 	struct device *self;
127 	void *aux;
128 {
129 	struct mii_softc *sc = (struct mii_softc *)self;
130 	struct mii_attach_args *ma = aux;
131 	struct mii_data *mii = ma->mii_data;
132 
133 	printf(": %s, rev. %d\n", MII_STR_NATSEMI_DP83840,
134 	    MII_REV(ma->mii_id2));
135 
136 	sc->mii_inst = mii->mii_instance;
137 	sc->mii_phy = ma->mii_phyno;
138 	sc->mii_service = nsphy_service;
139 	sc->mii_status = nsphy_status;
140 	sc->mii_pdata = mii;
141 	sc->mii_flags = mii->mii_flags;
142 	sc->mii_anegticks = 5;
143 
144 	nsphy_reset(sc);
145 
146 	sc->mii_capabilities =
147 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
148 	if (sc->mii_capabilities & BMSR_MEDIAMASK)
149 		mii_phy_add_media(sc);
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 	if ((sc->mii_dev.dv_flags & DVF_ACTIVE) == 0)
162 		return (ENXIO);
163 
164 	switch (cmd) {
165 	case MII_POLLSTAT:
166 		/*
167 		 * If we're not polling our PHY instance, just return.
168 		 */
169 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
170 			return (0);
171 		break;
172 
173 	case MII_MEDIACHG:
174 		/*
175 		 * If the media indicates a different PHY instance,
176 		 * isolate ourselves.
177 		 */
178 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
179 			reg = PHY_READ(sc, MII_BMCR);
180 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
181 			return (0);
182 		}
183 
184 		/*
185 		 * If the interface is not up, don't do anything.
186 		 */
187 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
188 			break;
189 
190 		reg = PHY_READ(sc, MII_NSPHY_PCR);
191 
192 		/*
193 		 * Set up the PCR to use LED4 to indicate full-duplex
194 		 * in both 10baseT and 100baseTX modes.
195 		 */
196 		reg |= PCR_LED4MODE;
197 
198 		/*
199 		 * Make sure Carrier Intgrity Monitor function is
200 		 * disabled (normal for Node operation, but sometimes
201 		 * it's not set?!)
202 		 */
203 		reg |= PCR_CIMDIS;
204 
205 		/*
206 		 * Make sure "force link good" is set to normal mode.
207 		 * It's only intended for debugging.
208 		 */
209 		reg |= PCR_FLINK100;
210 
211 		/*
212 		 * Mystery bits which are supposedly `reserved',
213 		 * but we seem to need to set them when the PHY
214 		 * is connected to some interfaces!
215 		 */
216 		reg |= PCR_CONGCTRL | PCR_TXREADYSEL;
217 
218 		PHY_WRITE(sc, MII_NSPHY_PCR, reg);
219 
220 		mii_phy_setmedia(sc);
221 		break;
222 
223 	case MII_TICK:
224 		/*
225 		 * If we're not currently selected, just return.
226 		 */
227 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
228 			return (0);
229 
230 		/*
231 		 * Only used for autonegotiation.
232 		 */
233 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
234 			return (0);
235 
236 		/*
237 		 * Is the interface even up?
238 		 */
239 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
240 			return (0);
241 
242 		/*
243 		 * Check to see if we have link.  If we do, we don't
244 		 * need to restart the autonegotiation process.  Read
245 		 * the BMSR twice in case it's latched.
246 		 */
247 		reg = PHY_READ(sc, MII_BMSR) |
248 		    PHY_READ(sc, MII_BMSR);
249 		if (reg & BMSR_LINK)
250 			return (0);
251 
252 		/*
253 		 * Only retry autonegotiation every 5 seconds.
254 		 */
255 		if (++sc->mii_ticks != sc->mii_anegticks)
256 			return (0);
257 
258 		sc->mii_ticks = 0;
259 		nsphy_reset(sc);
260 		if (mii_phy_auto(sc, 0) == EJUSTRETURN)
261 			return (0);
262 		break;
263 
264 	case MII_DOWN:
265 		mii_phy_down(sc);
266 		return (0);
267 	}
268 
269 	/* Update the media status. */
270 	mii_phy_status(sc);
271 
272 	/* Callback if something changed. */
273 	mii_phy_update(sc, cmd);
274 	return (0);
275 }
276 
277 void
278 nsphy_status(sc)
279 	struct mii_softc *sc;
280 {
281 	struct mii_data *mii = sc->mii_pdata;
282 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
283 	int bmsr, bmcr, par, anlpar;
284 
285 	mii->mii_media_status = IFM_AVALID;
286 	mii->mii_media_active = IFM_ETHER;
287 
288 	bmsr = PHY_READ(sc, MII_BMSR) |
289 	    PHY_READ(sc, MII_BMSR);
290 	if (bmsr & BMSR_LINK)
291 		mii->mii_media_status |= IFM_ACTIVE;
292 
293 	bmcr = PHY_READ(sc, MII_BMCR);
294 	if (bmcr & BMCR_ISO) {
295 		mii->mii_media_active |= IFM_NONE;
296 		mii->mii_media_status = 0;
297 		return;
298 	}
299 
300 	if (bmcr & BMCR_LOOP)
301 		mii->mii_media_active |= IFM_LOOP;
302 
303 	if (bmcr & BMCR_AUTOEN) {
304 		/*
305 		 * The PAR status bits are only valid of autonegotiation
306 		 * has completed (or it's disabled).
307 		 */
308 		if ((bmsr & BMSR_ACOMP) == 0) {
309 			/* Erg, still trying, I guess... */
310 			mii->mii_media_active |= IFM_NONE;
311 			return;
312 		}
313 
314 		/*
315 		 * Argh.  The PAR doesn't seem to indicate duplex mode
316 		 * properly!  Determine media based on link partner's
317 		 * advertised capabilities.
318 		 */
319 		if (PHY_READ(sc, MII_ANER) & ANER_LPAN) {
320 			anlpar = PHY_READ(sc, MII_ANAR) &
321 			    PHY_READ(sc, MII_ANLPAR);
322 			if (anlpar & ANLPAR_T4)
323 				mii->mii_media_active |= IFM_100_T4;
324 			else if (anlpar & ANLPAR_TX_FD)
325 				mii->mii_media_active |= IFM_100_TX|IFM_FDX;
326 			else if (anlpar & ANLPAR_TX)
327 				mii->mii_media_active |= IFM_100_TX;
328 			else if (anlpar & ANLPAR_10_FD)
329 				mii->mii_media_active |= IFM_10_T|IFM_FDX;
330 			else if (anlpar & ANLPAR_10)
331 				mii->mii_media_active |= IFM_10_T;
332 			else
333 				mii->mii_media_active |= IFM_NONE;
334 			return;
335 		}
336 
337 		/*
338 		 * Link partner is not capable of autonegotiation.
339 		 * We will never be in full-duplex mode if this is
340 		 * the case, so reading the PAR is OK.
341 		 */
342 		par = PHY_READ(sc, MII_NSPHY_PAR);
343 		if (par & PAR_10)
344 			mii->mii_media_active |= IFM_10_T;
345 		else
346 			mii->mii_media_active |= IFM_100_TX;
347 #if 0
348 		if (par & PAR_FDX)
349 			mii->mii_media_active |= IFM_FDX;
350 #endif
351 	} else
352 		mii->mii_media_active = ife->ifm_media;
353 }
354 
355 void
356 nsphy_reset(sc)
357 	struct mii_softc *sc;
358 {
359 	int anar;
360 
361 	mii_phy_reset(sc);
362 	anar = PHY_READ(sc, MII_ANAR);
363 	anar |= BMSR_MEDIA_TO_ANAR(PHY_READ(sc, MII_BMSR));
364 	PHY_WRITE(sc, MII_ANAR, anar);
365 }
366