xref: /netbsd-src/sys/dev/mii/gphyter.c (revision 8b0f9554ff8762542c4defc4f70e1eb76fb508fa)
1 /*	$NetBSD: gphyter.c,v 1.20 2007/12/09 20:28:03 jmcneill Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998, 1999, 2000, 2001 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 DP83891 and DP83861 `Gig PHYTER'
71  * ethernet 10/100/1000 PHYs.  The DP83891 is an older, non-firmware-
72  * driven version of the DP83861.
73  *
74  * Data Sheet available from www.national.com
75  */
76 
77 #include <sys/cdefs.h>
78 __KERNEL_RCSID(0, "$NetBSD: gphyter.c,v 1.20 2007/12/09 20:28:03 jmcneill Exp $");
79 
80 #include <sys/param.h>
81 #include <sys/systm.h>
82 #include <sys/kernel.h>
83 #include <sys/device.h>
84 #include <sys/socket.h>
85 #include <sys/errno.h>
86 
87 #include <net/if.h>
88 #include <net/if_media.h>
89 
90 #include <dev/mii/mii.h>
91 #include <dev/mii/miivar.h>
92 #include <dev/mii/miidevs.h>
93 
94 #include <dev/mii/gphyterreg.h>
95 
96 static int	gphytermatch(struct device *, struct cfdata *, void *);
97 static void	gphyterattach(struct device *, struct device *, void *);
98 
99 CFATTACH_DECL(gphyter, sizeof(struct mii_softc),
100     gphytermatch, gphyterattach, mii_phy_detach, mii_phy_activate);
101 
102 static int	gphyter_service(struct mii_softc *, struct mii_data *, int);
103 static void	gphyter_status(struct mii_softc *);
104 
105 static const struct mii_phy_funcs gphyter_funcs = {
106 	gphyter_service, gphyter_status, mii_phy_reset,
107 };
108 
109 static const struct mii_phydesc gphyters[] = {
110 	{ MII_OUI_xxNATSEMI,		MII_MODEL_xxNATSEMI_DP83861,
111 	  MII_STR_xxNATSEMI_DP83861 },
112 
113 	{ MII_OUI_xxNATSEMI,		MII_MODEL_xxNATSEMI_DP83891,
114 	  MII_STR_xxNATSEMI_DP83891 },
115 
116 	{ 0,				0,
117 	  NULL },
118 };
119 
120 static int
121 gphytermatch(struct device *parent, struct cfdata *match,
122     void *aux)
123 {
124 	struct mii_attach_args *ma = aux;
125 
126 	if (mii_phy_match(ma, gphyters) != NULL)
127 		return (10);
128 
129 	return (0);
130 }
131 
132 static void
133 gphyterattach(struct device *parent, struct device *self, void *aux)
134 {
135 	struct mii_softc *sc = (struct mii_softc *)self;
136 	struct mii_attach_args *ma = aux;
137 	struct mii_data *mii = ma->mii_data;
138 	const struct mii_phydesc *mpd;
139 	int anar, strap;
140 
141 	mpd = mii_phy_match(ma, gphyters);
142 	aprint_naive(": Media interface\n");
143 	aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
144 
145 	sc->mii_inst = mii->mii_instance;
146 	sc->mii_phy = ma->mii_phyno;
147 	sc->mii_funcs = &gphyter_funcs;
148 	sc->mii_pdata = mii;
149 	sc->mii_flags = ma->mii_flags;
150 	sc->mii_anegticks = MII_ANEGTICKS;
151 
152 	PHY_RESET(sc);
153 
154 	sc->mii_capabilities =
155 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
156 	if (sc->mii_capabilities & BMSR_EXTSTAT)
157 		sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
158 
159 	/*
160 	 * The Gig PHYTER seems to have the 10baseT BMSR bits
161 	 * hard-wired to 0, even though the device supports
162 	 * 10baseT.  What we do instead is read the post-reset
163 	 * ANAR, who's 10baseT-related bits are set by strapping
164 	 * pin 180, and fake the BMSR bits.
165 	 */
166 	anar = PHY_READ(sc, MII_ANAR);
167 	if (anar & ANAR_10)
168 		sc->mii_capabilities |= (BMSR_10THDX & ma->mii_capmask);
169 	if (anar & ANAR_10_FD)
170 		sc->mii_capabilities |= (BMSR_10TFDX & ma->mii_capmask);
171 
172 	aprint_normal("%s: ", sc->mii_dev.dv_xname);
173 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 &&
174 	    (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0)
175 		aprint_error("no media present");
176 	else
177 		mii_phy_add_media(sc);
178 	aprint_normal("\n");
179 
180 	strap = PHY_READ(sc, MII_GPHYTER_STRAP);
181 	aprint_normal("%s: strapped to %s mode", sc->mii_dev.dv_xname,
182 	    (strap & STRAP_MS_VAL) ? "master" : "slave");
183 	if (strap & STRAP_NC_MODE)
184 		aprint_normal(", pre-C5 BCM5400 compat enabled");
185 	aprint_normal("\n");
186 
187 	if (!pmf_device_register(self, NULL, mii_phy_resume))
188 		aprint_error_dev(self, "couldn't establish power handler\n");
189 }
190 
191 static int
192 gphyter_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
193 {
194 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
195 	int reg;
196 
197 	switch (cmd) {
198 	case MII_POLLSTAT:
199 		/*
200 		 * If we're not polling our PHY instance, just return.
201 		 */
202 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
203 			return (0);
204 		break;
205 
206 	case MII_MEDIACHG:
207 		/*
208 		 * If the media indicates a different PHY instance,
209 		 * isolate ourselves.
210 		 */
211 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
212 			reg = PHY_READ(sc, MII_BMCR);
213 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
214 			return (0);
215 		}
216 
217 		/*
218 		 * If the interface is not up, don't do anything.
219 		 */
220 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
221 			break;
222 
223 		mii_phy_setmedia(sc);
224 		break;
225 
226 	case MII_TICK:
227 		/*
228 		 * If we're not currently selected, just return.
229 		 */
230 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
231 			return (0);
232 
233 		if (mii_phy_tick(sc) == EJUSTRETURN)
234 			return (0);
235 		break;
236 
237 	case MII_DOWN:
238 		mii_phy_down(sc);
239 		return (0);
240 	}
241 
242 	/* Update the media status. */
243 	mii_phy_status(sc);
244 
245 	/* Callback if something changed. */
246 	mii_phy_update(sc, cmd);
247 	return (0);
248 }
249 
250 static void
251 gphyter_status(struct mii_softc *sc)
252 {
253 	struct mii_data *mii = sc->mii_pdata;
254 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
255 	int bmsr, bmcr, physup, gtsr;
256 
257 	mii->mii_media_status = IFM_AVALID;
258 	mii->mii_media_active = IFM_ETHER;
259 
260 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
261 
262 	physup = PHY_READ(sc, MII_GPHYTER_PHY_SUP);
263 
264 	if (physup & PHY_SUP_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 media 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 		switch (physup & (PHY_SUP_SPEED1|PHY_SUP_SPEED0)) {
289 		case PHY_SUP_SPEED1:
290 			mii->mii_media_active |= IFM_1000_T;
291 			gtsr = PHY_READ(sc, MII_100T2SR);
292 			if (gtsr & GTSR_MS_RES)
293 				mii->mii_media_active |= IFM_ETH_MASTER;
294 			break;
295 
296 		case PHY_SUP_SPEED0:
297 			mii->mii_media_active |= IFM_100_TX;
298 			break;
299 
300 		case 0:
301 			mii->mii_media_active |= IFM_10_T;
302 			break;
303 
304 		default:
305 			mii->mii_media_active |= IFM_NONE;
306 			mii->mii_media_status = 0;
307 		}
308 		if (physup & PHY_SUP_DUPLEX)
309 			mii->mii_media_active |=
310 			    IFM_FDX | mii_phy_flowstatus(sc);
311 	} else
312 		mii->mii_media_active = ife->ifm_media;
313 }
314