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