xref: /netbsd-src/sys/dev/mii/nsphy.c (revision 3b01aba77a7a698587faaae455bbfe740923c1f5)
1 /*	$NetBSD: nsphy.c,v 1.31 2001/06/02 21:39:40 thorpej Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998, 1999, 2000 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, mii_phy_detach,
96 	    mii_phy_activate
97 };
98 
99 int	nsphy_service __P((struct mii_softc *, struct mii_data *, int));
100 void	nsphy_status __P((struct mii_softc *));
101 
102 const struct mii_phy_funcs nsphy_funcs = {
103 	nsphy_service, nsphy_status, mii_phy_reset,
104 };
105 
106 const struct mii_phydesc nsphys[] = {
107 	{ MII_OUI_xxNATSEMI,		MII_MODEL_xxNATSEMI_DP83840,
108 	  MII_STR_xxNATSEMI_DP83840 },
109 
110 	{ 0,				0,
111 	  NULL },
112 };
113 
114 int
115 nsphymatch(parent, match, aux)
116 	struct device *parent;
117 	struct cfdata *match;
118 	void *aux;
119 {
120 	struct mii_attach_args *ma = aux;
121 
122 	if (mii_phy_match(ma, nsphys) != NULL)
123 		return (10);
124 
125 	return (0);
126 }
127 
128 void
129 nsphyattach(parent, self, aux)
130 	struct device *parent, *self;
131 	void *aux;
132 {
133 	struct mii_softc *sc = (struct mii_softc *)self;
134 	struct mii_attach_args *ma = aux;
135 	struct mii_data *mii = ma->mii_data;
136 	const struct mii_phydesc *mpd;
137 
138 	mpd = mii_phy_match(ma, nsphys);
139 	printf(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
140 
141 	sc->mii_inst = mii->mii_instance;
142 	sc->mii_phy = ma->mii_phyno;
143 	sc->mii_funcs = &nsphy_funcs;
144 	sc->mii_pdata = mii;
145 	sc->mii_flags = mii->mii_flags;
146 	sc->mii_anegticks = 5;
147 
148 	PHY_RESET(sc);
149 
150 	sc->mii_capabilities =
151 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
152 	printf("%s: ", sc->mii_dev.dv_xname);
153 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0)
154 		printf("no media present");
155 	else
156 		mii_phy_add_media(sc);
157 	printf("\n");
158 }
159 
160 int
161 nsphy_service(sc, mii, cmd)
162 	struct mii_softc *sc;
163 	struct mii_data *mii;
164 	int cmd;
165 {
166 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
167 	int reg;
168 
169 	if ((sc->mii_dev.dv_flags & DVF_ACTIVE) == 0)
170 		return (ENXIO);
171 
172 	switch (cmd) {
173 	case MII_POLLSTAT:
174 		/*
175 		 * If we're not polling our PHY instance, just return.
176 		 */
177 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
178 			return (0);
179 		break;
180 
181 	case MII_MEDIACHG:
182 		/*
183 		 * If the media indicates a different PHY instance,
184 		 * isolate ourselves.
185 		 */
186 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
187 			reg = PHY_READ(sc, MII_BMCR);
188 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
189 			return (0);
190 		}
191 
192 		/*
193 		 * If the interface is not up, don't do anything.
194 		 */
195 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
196 			break;
197 
198 		reg = PHY_READ(sc, MII_NSPHY_PCR);
199 
200 		/*
201 		 * Set up the PCR to use LED4 to indicate full-duplex
202 		 * in both 10baseT and 100baseTX modes.
203 		 */
204 		reg |= PCR_LED4MODE;
205 
206 		/*
207 		 * Make sure Carrier Intgrity Monitor function is
208 		 * disabled (normal for Node operation, but sometimes
209 		 * it's not set?!)
210 		 */
211 		reg |= PCR_CIMDIS;
212 
213 		/*
214 		 * Make sure "force link good" is set to normal mode.
215 		 * It's only intended for debugging.
216 		 */
217 		reg |= PCR_FLINK100;
218 
219 		/*
220 		 * Mystery bits which are supposedly `reserved',
221 		 * but we seem to need to set them when the PHY
222 		 * is connected to some interfaces:
223 		 *
224 		 * 0x0400 is needed for fxp
225 		 *        (Intel EtherExpress Pro 10+/100B, 82557 chip)
226 		 *        (nsphy with a DP83840 chip)
227 		 * 0x0100 may be needed for some other card
228 		 */
229 		reg |= 0x0100 | 0x0400;
230 
231 		PHY_WRITE(sc, MII_NSPHY_PCR, reg);
232 
233 		mii_phy_setmedia(sc);
234 		break;
235 
236 	case MII_TICK:
237 		/*
238 		 * If we're not currently selected, just return.
239 		 */
240 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
241 			return (0);
242 
243 		if (mii_phy_tick(sc) == EJUSTRETURN)
244 			return (0);
245 		break;
246 
247 	case MII_DOWN:
248 		mii_phy_down(sc);
249 		return (0);
250 	}
251 
252 	/* Update the media status. */
253 	mii_phy_status(sc);
254 
255 	/* Callback if something changed. */
256 	mii_phy_update(sc, cmd);
257 	return (0);
258 }
259 
260 void
261 nsphy_status(sc)
262 	struct mii_softc *sc;
263 {
264 	struct mii_data *mii = sc->mii_pdata;
265 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
266 	int bmsr, bmcr, par, anlpar;
267 
268 	mii->mii_media_status = IFM_AVALID;
269 	mii->mii_media_active = IFM_ETHER;
270 
271 	bmsr = PHY_READ(sc, MII_BMSR) |
272 	    PHY_READ(sc, MII_BMSR);
273 	if (bmsr & BMSR_LINK)
274 		mii->mii_media_status |= IFM_ACTIVE;
275 
276 	bmcr = PHY_READ(sc, MII_BMCR);
277 	if (bmcr & BMCR_ISO) {
278 		mii->mii_media_active |= IFM_NONE;
279 		mii->mii_media_status = 0;
280 		return;
281 	}
282 
283 	if (bmcr & BMCR_LOOP)
284 		mii->mii_media_active |= IFM_LOOP;
285 
286 	if (bmcr & BMCR_AUTOEN) {
287 		/*
288 		 * The PAR status bits are only valid of autonegotiation
289 		 * has completed (or it's disabled).
290 		 */
291 		if ((bmsr & BMSR_ACOMP) == 0) {
292 			/* Erg, still trying, I guess... */
293 			mii->mii_media_active |= IFM_NONE;
294 			return;
295 		}
296 
297 		/*
298 		 * Argh.  The PAR doesn't seem to indicate duplex mode
299 		 * properly!  Determine media based on link partner's
300 		 * advertised capabilities.
301 		 */
302 		if (PHY_READ(sc, MII_ANER) & ANER_LPAN) {
303 			anlpar = PHY_READ(sc, MII_ANAR) &
304 			    PHY_READ(sc, MII_ANLPAR);
305 			if (anlpar & ANLPAR_T4)
306 				mii->mii_media_active |= IFM_100_T4;
307 			else if (anlpar & ANLPAR_TX_FD)
308 				mii->mii_media_active |= IFM_100_TX|IFM_FDX;
309 			else if (anlpar & ANLPAR_TX)
310 				mii->mii_media_active |= IFM_100_TX;
311 			else if (anlpar & ANLPAR_10_FD)
312 				mii->mii_media_active |= IFM_10_T|IFM_FDX;
313 			else if (anlpar & ANLPAR_10)
314 				mii->mii_media_active |= IFM_10_T;
315 			else
316 				mii->mii_media_active |= IFM_NONE;
317 			return;
318 		}
319 
320 		/*
321 		 * Link partner is not capable of autonegotiation.
322 		 * We will never be in full-duplex mode if this is
323 		 * the case, so reading the PAR is OK.
324 		 */
325 		par = PHY_READ(sc, MII_NSPHY_PAR);
326 		if (par & PAR_10)
327 			mii->mii_media_active |= IFM_10_T;
328 		else
329 			mii->mii_media_active |= IFM_100_TX;
330 #if 0
331 		if (par & PAR_FDX)
332 			mii->mii_media_active |= IFM_FDX;
333 #endif
334 	} else
335 		mii->mii_media_active = ife->ifm_media;
336 }
337