xref: /openbsd/sys/dev/mii/nsphy.c (revision cca36db2)
1 /*	$OpenBSD: nsphy.c,v 1.25 2010/07/23 07:47:13 jsg 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  *
21  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
23  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
25  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 /*
35  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
36  *
37  * Redistribution and use in source and binary forms, with or without
38  * modification, are permitted provided that the following conditions
39  * are met:
40  * 1. Redistributions of source code must retain the above copyright
41  *    notice, this list of conditions and the following disclaimer.
42  * 2. Redistributions in binary form must reproduce the above copyright
43  *    notice, this list of conditions and the following disclaimer in the
44  *    documentation and/or other materials provided with the distribution.
45  *
46  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
47  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
48  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
49  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
50  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
51  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
52  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
53  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
54  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
55  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
56  */
57 
58 /*
59  * driver for National Semiconductor's DP83840A ethernet 10/100 PHY
60  * Data Sheet available from www.national.com
61  */
62 
63 #include <sys/param.h>
64 #include <sys/systm.h>
65 #include <sys/kernel.h>
66 #include <sys/device.h>
67 #include <sys/socket.h>
68 #include <sys/errno.h>
69 
70 #include <net/if.h>
71 #include <net/if_media.h>
72 
73 #include <dev/mii/mii.h>
74 #include <dev/mii/miivar.h>
75 #include <dev/mii/miidevs.h>
76 
77 #include <dev/mii/nsphyreg.h>
78 
79 int	nsphymatch(struct device *, void *, void *);
80 void	nsphyattach(struct device *, struct device *, void *);
81 
82 struct cfattach nsphy_ca = {
83 	sizeof(struct mii_softc), nsphymatch, nsphyattach, mii_phy_detach,
84 	    mii_phy_activate
85 };
86 
87 struct cfdriver nsphy_cd = {
88 	NULL, "nsphy", DV_DULL
89 };
90 
91 int	nsphy_service(struct mii_softc *, struct mii_data *, int);
92 void	nsphy_status(struct mii_softc *);
93 void	nsphy_reset(struct mii_softc *);
94 
95 const struct mii_phy_funcs nsphy_funcs = {
96 	nsphy_service, nsphy_status, nsphy_reset,
97 };
98 
99 static const struct mii_phydesc nsphys[] = {
100 	{ MII_OUI_NATSEMI,		MII_MODEL_NATSEMI_DP83840,
101 	  MII_STR_NATSEMI_DP83840 },
102 
103 	{ 0,			0,
104 	  NULL },
105 };
106 
107 int
108 nsphymatch(struct device *parent, void *match, void *aux)
109 {
110 	struct mii_attach_args *ma = aux;
111 
112 	if (mii_phy_match(ma, nsphys) != NULL)
113 		return (10);
114 
115 	return (0);
116 }
117 
118 void
119 nsphyattach(struct device *parent, struct device *self, 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 	const struct mii_phydesc *mpd;
125 
126 	mpd = mii_phy_match(ma, nsphys);
127 	printf(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
128 
129 	sc->mii_inst = mii->mii_instance;
130 	sc->mii_phy = ma->mii_phyno;
131 	sc->mii_funcs = &nsphy_funcs;
132 	sc->mii_pdata = mii;
133 	sc->mii_flags = ma->mii_flags;
134 	sc->mii_anegticks = MII_ANEGTICKS;
135 
136 	PHY_RESET(sc);
137 
138 	sc->mii_capabilities =
139 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
140 	if (sc->mii_capabilities & BMSR_MEDIAMASK)
141 		mii_phy_add_media(sc);
142 }
143 
144 int
145 nsphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
146 {
147 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
148 	int reg;
149 
150 	if ((sc->mii_dev.dv_flags & DVF_ACTIVE) == 0)
151 		return (ENXIO);
152 
153 	switch (cmd) {
154 	case MII_POLLSTAT:
155 		/*
156 		 * If we're not polling our PHY instance, just return.
157 		 */
158 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
159 			return (0);
160 		break;
161 
162 	case MII_MEDIACHG:
163 		/*
164 		 * If the media indicates a different PHY instance,
165 		 * isolate ourselves.
166 		 */
167 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
168 			reg = PHY_READ(sc, MII_BMCR);
169 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
170 			return (0);
171 		}
172 
173 		/*
174 		 * If the interface is not up, don't do anything.
175 		 */
176 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
177 			break;
178 
179 		reg = PHY_READ(sc, MII_NSPHY_PCR);
180 
181 		/*
182 		 * Set up the PCR to use LED4 to indicate full-duplex
183 		 * in both 10baseT and 100baseTX modes.
184 		 */
185 		reg |= PCR_LED4MODE;
186 
187 		/*
188 		 * Make sure Carrier Integrity Monitor function is
189 		 * disabled (normal for Node operation, but sometimes
190 		 * it's not set?!)
191 		 */
192 		reg |= PCR_CIMDIS;
193 
194 		/*
195 		 * Make sure "force link good" is set to normal mode.
196 		 * It's only intended for debugging.
197 		 */
198 		reg |= PCR_FLINK100;
199 
200 		/*
201 		 * Mystery bits which are supposedly `reserved',
202 		 * but we seem to need to set them when the PHY
203 		 * is connected to some interfaces!
204 		 */
205 		reg |= PCR_CONGCTRL | PCR_TXREADYSEL;
206 
207 		PHY_WRITE(sc, MII_NSPHY_PCR, reg);
208 
209 		mii_phy_setmedia(sc);
210 		break;
211 
212 	case MII_TICK:
213 		/*
214 		 * If we're not currently selected, just return.
215 		 */
216 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
217 			return (0);
218 
219 		if (mii_phy_tick(sc) == EJUSTRETURN)
220 			return (0);
221 		break;
222 
223 	case MII_DOWN:
224 		mii_phy_down(sc);
225 		return (0);
226 	}
227 
228 	/* Update the media status. */
229 	mii_phy_status(sc);
230 
231 	/* Callback if something changed. */
232 	mii_phy_update(sc, cmd);
233 	return (0);
234 }
235 
236 void
237 nsphy_status(struct mii_softc *sc)
238 {
239 	struct mii_data *mii = sc->mii_pdata;
240 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
241 	int bmsr, bmcr, par, anlpar;
242 
243 	mii->mii_media_status = IFM_AVALID;
244 	mii->mii_media_active = IFM_ETHER;
245 
246 	bmsr = PHY_READ(sc, MII_BMSR) |
247 	    PHY_READ(sc, MII_BMSR);
248 	if (bmsr & BMSR_LINK)
249 		mii->mii_media_status |= IFM_ACTIVE;
250 
251 	bmcr = PHY_READ(sc, MII_BMCR);
252 	if (bmcr & BMCR_ISO) {
253 		mii->mii_media_active |= IFM_NONE;
254 		mii->mii_media_status = 0;
255 		return;
256 	}
257 
258 	if (bmcr & BMCR_LOOP)
259 		mii->mii_media_active |= IFM_LOOP;
260 
261 	if (bmcr & BMCR_AUTOEN) {
262 		/*
263 		 * The PAR status bits are only valid if autonegotiation
264 		 * has completed (or it's disabled).
265 		 */
266 		if ((bmsr & BMSR_ACOMP) == 0) {
267 			/* Erg, still trying, I guess... */
268 			mii->mii_media_active |= IFM_NONE;
269 			return;
270 		}
271 
272 		/*
273 		 * Argh.  The PAR doesn't seem to indicate duplex mode
274 		 * properly!  Determine media based on link partner's
275 		 * advertised capabilities.
276 		 */
277 		if (PHY_READ(sc, MII_ANER) & ANER_LPAN) {
278 			anlpar = PHY_READ(sc, MII_ANAR) &
279 			    PHY_READ(sc, MII_ANLPAR);
280 			if (anlpar & ANLPAR_TX_FD)
281 				mii->mii_media_active |= IFM_100_TX|IFM_FDX;
282 			else if (anlpar & ANLPAR_T4)
283 				mii->mii_media_active |= IFM_100_T4|IFM_HDX;
284 			else if (anlpar & ANLPAR_TX)
285 				mii->mii_media_active |= IFM_100_TX|IFM_HDX;
286 			else if (anlpar & ANLPAR_10_FD)
287 				mii->mii_media_active |= IFM_10_T|IFM_FDX;
288 			else if (anlpar & ANLPAR_10)
289 				mii->mii_media_active |= IFM_10_T|IFM_HDX;
290 			else
291 				mii->mii_media_active |= IFM_NONE;
292 			return;
293 		}
294 
295 		/*
296 		 * Link partner is not capable of autonegotiation.
297 		 * We will never be in full-duplex mode if this is
298 		 * the case, so reading the PAR is OK.
299 		 */
300 		par = PHY_READ(sc, MII_NSPHY_PAR);
301 		if (par & PAR_10)
302 			mii->mii_media_active |= IFM_10_T;
303 		else
304 			mii->mii_media_active |= IFM_100_TX;
305 		mii->mii_media_active |= IFM_HDX;
306 	} else
307 		mii->mii_media_active = ife->ifm_media;
308 }
309 
310 void
311 nsphy_reset(struct mii_softc *sc)
312 {
313 	int anar;
314 
315 	mii_phy_reset(sc);
316 	anar = PHY_READ(sc, MII_ANAR);
317 	anar |= BMSR_MEDIA_TO_ANAR(PHY_READ(sc, MII_BMSR));
318 	PHY_WRITE(sc, MII_ANAR, anar);
319 }
320