xref: /netbsd-src/sys/dev/mii/gentbi.c (revision f3b496ec9be495acbb17756f05d342b6b7b495e9)
1 /*	$NetBSD: gentbi.c,v 1.15 2006/03/29 07:05:24 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 generic ten-bit (1000BASE-SX) interfaces, built in to
71  * many Gigabit Ethernet chips.
72  *
73  * All we have to do here is correctly report speed and duplex.
74  */
75 
76 #include <sys/cdefs.h>
77 __KERNEL_RCSID(0, "$NetBSD: gentbi.c,v 1.15 2006/03/29 07:05:24 thorpej Exp $");
78 
79 #include <sys/param.h>
80 #include <sys/systm.h>
81 #include <sys/kernel.h>
82 #include <sys/device.h>
83 #include <sys/socket.h>
84 #include <sys/errno.h>
85 
86 #include <net/if.h>
87 #include <net/if_media.h>
88 
89 #include <dev/mii/mii.h>
90 #include <dev/mii/miivar.h>
91 #include <dev/mii/miidevs.h>
92 
93 static int	gentbimatch(struct device *, struct cfdata *, void *);
94 static void	gentbiattach(struct device *, struct device *, void *);
95 
96 CFATTACH_DECL(gentbi, sizeof(struct mii_softc),
97     gentbimatch, gentbiattach, mii_phy_detach, mii_phy_activate);
98 
99 static int	gentbi_service(struct mii_softc *, struct mii_data *, int);
100 static void	gentbi_status(struct mii_softc *);
101 
102 static const struct mii_phy_funcs gentbi_funcs = {
103 	gentbi_service, gentbi_status, mii_phy_reset,
104 };
105 
106 static int
107 gentbimatch(struct device *parent, struct cfdata *match, void *aux)
108 {
109 	struct mii_attach_args *ma = aux;
110 	struct mii_data *mii = ma->mii_data;
111 	int bmsr, extsr;
112 
113 	/*
114 	 * We match as a generic TBI if:
115 	 *
116 	 *	- There is no media in the BMSR.
117 	 *	- EXTSR has only 1000X.
118 	 */
119 	bmsr = (*mii->mii_readreg)(parent, ma->mii_phyno, MII_BMSR);
120 	if ((bmsr & BMSR_EXTSTAT) == 0 || (bmsr & BMSR_MEDIAMASK) != 0)
121 		return (0);
122 
123 	extsr = (*mii->mii_readreg)(parent, ma->mii_phyno, MII_EXTSR);
124 	if (extsr & (EXTSR_1000TFDX|EXTSR_1000THDX))
125 		return (0);
126 
127 	if (extsr & (EXTSR_1000XFDX|EXTSR_1000XHDX)) {
128 		/*
129 		 * We think this is a generic TBI.  Return a match
130 		 * priority higher than ukphy, but lower than what
131 		 * specific drivers will return.
132 		 */
133 		return (2);
134 	}
135 
136 	return (0);
137 }
138 
139 static void
140 gentbiattach(struct device *parent, struct device *self, void *aux)
141 {
142 	struct mii_softc *sc = device_private(self);
143 	struct mii_attach_args *ma = aux;
144 	struct mii_data *mii = ma->mii_data;
145 
146 	aprint_naive(": Media interface\n");
147 	aprint_normal(": Generic ten-bit interface, rev. %d\n",
148 	    MII_REV(ma->mii_id2));
149 
150 	sc->mii_inst = mii->mii_instance;
151 	sc->mii_phy = ma->mii_phyno;
152 	sc->mii_funcs = &gentbi_funcs;
153 	sc->mii_pdata = mii;
154 	sc->mii_flags = ma->mii_flags;
155 	sc->mii_anegticks = 5;
156 
157 	PHY_RESET(sc);
158 
159 	/*
160 	 * Mask out all media in the BMSR.  We only are really interested
161 	 * in "auto".
162 	 */
163 	sc->mii_capabilities =
164 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask & ~BMSR_MEDIAMASK;
165 	if (sc->mii_capabilities & BMSR_EXTSTAT)
166 		sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
167 
168 	aprint_normal("%s: ", sc->mii_dev.dv_xname);
169 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 &&
170 	    (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0)
171 		aprint_error("no media present");
172 	else
173 		mii_phy_add_media(sc);
174 	aprint_normal("\n");
175 }
176 
177 static int
178 gentbi_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
179 {
180 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
181 	int reg;
182 
183 	switch (cmd) {
184 	case MII_POLLSTAT:
185 		/*
186 		 * If we're not polling our PHY instance, just return.
187 		 */
188 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
189 			return (0);
190 		break;
191 
192 	case MII_MEDIACHG:
193 		/*
194 		 * If the media indicates a different PHY instance,
195 		 * isolate ourselves.
196 		 */
197 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
198 			reg = PHY_READ(sc, MII_BMCR);
199 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
200 			return (0);
201 		}
202 
203 		/*
204 		 * If the interface is not up, don't do anything.
205 		 */
206 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
207 			break;
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 static void
237 gentbi_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, anlpar;
242 
243 	mii->mii_media_status = IFM_AVALID;
244 	mii->mii_media_active = IFM_ETHER;
245 
246 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
247 
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 media status bits are only valid of 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 		 * The media is always 1000baseSX.  Check the ANLPAR to
274 		 * see if we're doing full-duplex.
275 		 */
276 		mii->mii_media_active |= IFM_1000_SX;
277 
278 		anlpar = PHY_READ(sc, MII_ANLPAR);
279 		if ((sc->mii_extcapabilities & EXTSR_1000XFDX) != 0 &&
280 		    (anlpar & ANLPAR_X_FD) != 0)
281 			mii->mii_media_active |=
282 			    IFM_FDX | mii_phy_flowstatus(sc);
283 	} else
284 		mii->mii_media_active = ife->ifm_media;
285 }
286