xref: /netbsd-src/sys/dev/mii/gphyter.c (revision 37b34d511dea595d3ba03a661cf3b775038ea5f8)
1 /*	$NetBSD: gphyter.c,v 1.11 2002/10/02 16:34:17 thorpej 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.11 2002/10/02 16:34:17 thorpej 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 int	gphytermatch(struct device *, struct cfdata *, void *);
97 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 int	gphyter_service(struct mii_softc *, struct mii_data *, int);
103 void	gphyter_status(struct mii_softc *);
104 
105 const struct mii_phy_funcs gphyter_funcs = {
106 	gphyter_service, gphyter_status, mii_phy_reset,
107 };
108 
109 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 int
121 gphytermatch(struct device *parent, struct cfdata *match, void *aux)
122 {
123 	struct mii_attach_args *ma = aux;
124 
125 	if (mii_phy_match(ma, gphyters) != NULL)
126 		return (10);
127 
128 	return (0);
129 }
130 
131 void
132 gphyterattach(struct device *parent, struct device *self, void *aux)
133 {
134 	struct mii_softc *sc = (struct mii_softc *)self;
135 	struct mii_attach_args *ma = aux;
136 	struct mii_data *mii = ma->mii_data;
137 	const struct mii_phydesc *mpd;
138 	int anar, strap;
139 
140 	mpd = mii_phy_match(ma, gphyters);
141 	printf(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
142 
143 	sc->mii_inst = mii->mii_instance;
144 	sc->mii_phy = ma->mii_phyno;
145 	sc->mii_funcs = &gphyter_funcs;
146 	sc->mii_pdata = mii;
147 	sc->mii_flags = ma->mii_flags;
148 	sc->mii_anegticks = 5;
149 
150 	PHY_RESET(sc);
151 
152 	sc->mii_capabilities =
153 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask;
154 	if (sc->mii_capabilities & BMSR_EXTSTAT)
155 		sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
156 
157 	/*
158 	 * The Gig PHYTER seems to have the 10baseT BMSR bits
159 	 * hard-wired to 0, even though the device supports
160 	 * 10baseT.  What we do instead is read the post-reset
161 	 * ANAR, who's 10baseT-related bits are set by strapping
162 	 * pin 180, and fake the BMSR bits.
163 	 */
164 	anar = PHY_READ(sc, MII_ANAR);
165 	if (anar & ANAR_10)
166 		sc->mii_capabilities |= (BMSR_10THDX & ma->mii_capmask);
167 	if (anar & ANAR_10_FD)
168 		sc->mii_capabilities |= (BMSR_10TFDX & ma->mii_capmask);
169 
170 	printf("%s: ", sc->mii_dev.dv_xname);
171 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 &&
172 	    (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0)
173 		printf("no media present");
174 	else
175 		mii_phy_add_media(sc);
176 	printf("\n");
177 
178 	strap = PHY_READ(sc, MII_GPHYTER_STRAP);
179 	printf("%s: strapped to %s mode", sc->mii_dev.dv_xname,
180 	    (strap & STRAP_MS_VAL) ? "master" : "slave");
181 	if (strap & STRAP_NC_MODE)
182 		printf(", pre-C5 BCM5400 compat enabled");
183 	printf("\n");
184 }
185 
186 int
187 gphyter_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
188 {
189 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
190 	int reg;
191 
192 	switch (cmd) {
193 	case MII_POLLSTAT:
194 		/*
195 		 * If we're not polling our PHY instance, just return.
196 		 */
197 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
198 			return (0);
199 		break;
200 
201 	case MII_MEDIACHG:
202 		/*
203 		 * If the media indicates a different PHY instance,
204 		 * isolate ourselves.
205 		 */
206 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
207 			reg = PHY_READ(sc, MII_BMCR);
208 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
209 			return (0);
210 		}
211 
212 		/*
213 		 * If the interface is not up, don't do anything.
214 		 */
215 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
216 			break;
217 
218 		mii_phy_setmedia(sc);
219 		break;
220 
221 	case MII_TICK:
222 		/*
223 		 * If we're not currently selected, just return.
224 		 */
225 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
226 			return (0);
227 
228 		if (mii_phy_tick(sc) == EJUSTRETURN)
229 			return (0);
230 		break;
231 
232 	case MII_DOWN:
233 		mii_phy_down(sc);
234 		return (0);
235 	}
236 
237 	/* Update the media status. */
238 	mii_phy_status(sc);
239 
240 	/* Callback if something changed. */
241 	mii_phy_update(sc, cmd);
242 	return (0);
243 }
244 
245 void
246 gphyter_status(struct mii_softc *sc)
247 {
248 	struct mii_data *mii = sc->mii_pdata;
249 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
250 	int bmsr, bmcr, physup, gtsr;
251 
252 	mii->mii_media_status = IFM_AVALID;
253 	mii->mii_media_active = IFM_ETHER;
254 
255 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
256 
257 	physup = PHY_READ(sc, MII_GPHYTER_PHY_SUP);
258 
259 	if (physup & PHY_SUP_LINK)
260 		mii->mii_media_status |= IFM_ACTIVE;
261 
262 	bmcr = PHY_READ(sc, MII_BMCR);
263 	if (bmcr & BMCR_ISO) {
264 		mii->mii_media_active |= IFM_NONE;
265 		mii->mii_media_status = 0;
266 		return;
267 	}
268 
269 	if (bmcr & BMCR_LOOP)
270 		mii->mii_media_active |= IFM_LOOP;
271 
272 	if (bmcr & BMCR_AUTOEN) {
273 		/*
274 		 * The media status bits are only valid of autonegotiation
275 		 * has completed (or it's disabled).
276 		 */
277 		if ((bmsr & BMSR_ACOMP) == 0) {
278 			/* Erg, still trying, I guess... */
279 			mii->mii_media_active |= IFM_NONE;
280 			return;
281 		}
282 
283 		switch (physup & (PHY_SUP_SPEED1|PHY_SUP_SPEED0)) {
284 		case PHY_SUP_SPEED1:
285 			mii->mii_media_active |= IFM_1000_T;
286 			gtsr = PHY_READ(sc, MII_100T2SR);
287 			if (gtsr & GTSR_MS_RES)
288 				mii->mii_media_active |= IFM_ETH_MASTER;
289 			break;
290 
291 		case PHY_SUP_SPEED0:
292 			mii->mii_media_active |= IFM_100_TX;
293 			break;
294 
295 		case 0:
296 			mii->mii_media_active |= IFM_10_T;
297 			break;
298 
299 		default:
300 			mii->mii_media_active |= IFM_NONE;
301 			mii->mii_media_status = 0;
302 		}
303 		if (physup & PHY_SUP_DUPLEX)
304 			mii->mii_media_active |= IFM_FDX;
305 	} else
306 		mii->mii_media_active = ife->ifm_media;
307 }
308