xref: /netbsd-src/sys/dev/mii/gentbi.c (revision b7b7574d3bf8eeb51a1fa3977b59142ec6434a55)
1 /*	$NetBSD: gentbi.c,v 1.27 2014/06/16 16:48:16 msaitoh 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  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*
34  * Copyright (c) 1997 Manuel Bouyer.  All rights reserved.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  * 1. Redistributions of source code must retain the above copyright
40  *    notice, this list of conditions and the following disclaimer.
41  * 2. Redistributions in binary form must reproduce the above copyright
42  *    notice, this list of conditions and the following disclaimer in the
43  *    documentation and/or other materials provided with the distribution.
44  *
45  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
46  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
47  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
48  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
49  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
50  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
51  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
52  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
53  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
54  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
55  */
56 
57 /*
58  * Driver for generic ten-bit (1000BASE-SX) interfaces, built into
59  * many Gigabit Ethernet chips.
60  *
61  * All we have to do here is correctly report speed and duplex.
62  */
63 
64 #include <sys/cdefs.h>
65 __KERNEL_RCSID(0, "$NetBSD: gentbi.c,v 1.27 2014/06/16 16:48:16 msaitoh Exp $");
66 
67 #include <sys/param.h>
68 #include <sys/systm.h>
69 #include <sys/kernel.h>
70 #include <sys/device.h>
71 #include <sys/socket.h>
72 #include <sys/errno.h>
73 
74 #include <net/if.h>
75 #include <net/if_media.h>
76 
77 #include <dev/mii/mii.h>
78 #include <dev/mii/miivar.h>
79 #include <dev/mii/miidevs.h>
80 
81 static int	gentbimatch(device_t, cfdata_t, void *);
82 static void	gentbiattach(device_t, device_t, void *);
83 
84 CFATTACH_DECL_NEW(gentbi, sizeof(struct mii_softc),
85     gentbimatch, gentbiattach, mii_phy_detach, mii_phy_activate);
86 
87 static int	gentbi_service(struct mii_softc *, struct mii_data *, int);
88 static void	gentbi_status(struct mii_softc *);
89 
90 static const struct mii_phy_funcs gentbi_funcs = {
91 	gentbi_service, gentbi_status, mii_phy_reset,
92 };
93 
94 static int
95 gentbimatch(device_t parent, cfdata_t match, void *aux)
96 {
97 	struct mii_attach_args *ma = aux;
98 	struct mii_data *mii = ma->mii_data;
99 	int bmsr, extsr;
100 
101 	/*
102 	 * We match as a generic TBI if:
103 	 *
104 	 *	- There is no media in the BMSR.
105 	 *	- EXTSR has only 1000X.
106 	 */
107 	bmsr = (*mii->mii_readreg)(parent, ma->mii_phyno, MII_BMSR);
108 	if ((bmsr & BMSR_EXTSTAT) == 0 || (bmsr & BMSR_MEDIAMASK) != 0)
109 		return (0);
110 
111 	extsr = (*mii->mii_readreg)(parent, ma->mii_phyno, MII_EXTSR);
112 	if (extsr & (EXTSR_1000TFDX|EXTSR_1000THDX))
113 		return (0);
114 
115 	if (extsr & (EXTSR_1000XFDX|EXTSR_1000XHDX)) {
116 		/*
117 		 * We think this is a generic TBI.  Return a match
118 		 * priority higher than ukphy, but lower than what
119 		 * specific drivers will return.
120 		 */
121 		return (2);
122 	}
123 
124 	return (0);
125 }
126 
127 static void
128 gentbiattach(device_t parent, device_t self, void *aux)
129 {
130 	struct mii_softc *sc = device_private(self);
131 	struct mii_attach_args *ma = aux;
132 	struct mii_data *mii = ma->mii_data;
133 	int oui = MII_OUI(ma->mii_id1, ma->mii_id2);
134 	int model = MII_MODEL(ma->mii_id2);
135 	int rev = MII_REV(ma->mii_id2);
136 	const char *descr;
137 
138 	if ((descr = mii_get_descr(oui, model)) != NULL)
139 		aprint_normal(": %s (OUI 0x%06x, model 0x%04x), rev. %d\n",
140 		    descr, oui, model, rev);
141 	else
142 		aprint_normal(": OUI 0x%06x, model 0x%04x, rev. %d\n",
143 		    oui, model, rev);
144 
145 	aprint_naive(": Generic ten-bit interface\n");
146 
147 	sc->mii_dev = self;
148 	sc->mii_inst = mii->mii_instance;
149 	sc->mii_phy = ma->mii_phyno;
150 	sc->mii_mpd_oui = oui;
151 	sc->mii_mpd_model = model;
152 	sc->mii_mpd_rev = rev;
153 	sc->mii_funcs = &gentbi_funcs;
154 	sc->mii_pdata = mii;
155 	sc->mii_flags = ma->mii_flags;
156 	sc->mii_anegticks = MII_ANEGTICKS;
157 
158 	PHY_RESET(sc);
159 
160 	/*
161 	 * Mask out all media in the BMSR.  We only are really interested
162 	 * in "auto".
163 	 */
164 	sc->mii_capabilities =
165 	    PHY_READ(sc, MII_BMSR) & ma->mii_capmask & ~BMSR_MEDIAMASK;
166 	if (sc->mii_capabilities & BMSR_EXTSTAT)
167 		sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
168 
169 	aprint_normal_dev(self, "");
170 	if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 &&
171 	    (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0)
172 		aprint_error("no media present");
173 	else
174 		mii_phy_add_media(sc);
175 	aprint_normal("\n");
176 }
177 
178 static int
179 gentbi_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
180 {
181 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
182 	int reg;
183 
184 	switch (cmd) {
185 	case MII_POLLSTAT:
186 		/*
187 		 * If we're not polling our PHY instance, just return.
188 		 */
189 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
190 			return (0);
191 		break;
192 
193 	case MII_MEDIACHG:
194 		/*
195 		 * If the media indicates a different PHY instance,
196 		 * isolate ourselves.
197 		 */
198 		if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
199 			reg = PHY_READ(sc, MII_BMCR);
200 			PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
201 			return (0);
202 		}
203 
204 		/*
205 		 * If the interface is not up, don't do anything.
206 		 */
207 		if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
208 			break;
209 
210 		mii_phy_setmedia(sc);
211 		break;
212 
213 	case MII_TICK:
214 		/*
215 		 * If we're not currently selected, just return.
216 		 */
217 		if (IFM_INST(ife->ifm_media) != sc->mii_inst)
218 			return (0);
219 
220 		if (mii_phy_tick(sc) == EJUSTRETURN)
221 			return (0);
222 		break;
223 
224 	case MII_DOWN:
225 		mii_phy_down(sc);
226 		return (0);
227 	}
228 
229 	/* Update the media status. */
230 	mii_phy_status(sc);
231 
232 	/* Callback if something changed. */
233 	mii_phy_update(sc, cmd);
234 	return (0);
235 }
236 
237 static void
238 gentbi_status(struct mii_softc *sc)
239 {
240 	struct mii_data *mii = sc->mii_pdata;
241 	struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
242 	int bmsr, bmcr, anlpar;
243 
244 	mii->mii_media_status = IFM_AVALID;
245 	mii->mii_media_active = IFM_ETHER;
246 
247 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
248 
249 	if (bmsr & BMSR_LINK)
250 		mii->mii_media_status |= IFM_ACTIVE;
251 
252 	bmcr = PHY_READ(sc, MII_BMCR);
253 	if (bmcr & BMCR_ISO) {
254 		mii->mii_media_active |= IFM_NONE;
255 		mii->mii_media_status = 0;
256 		return;
257 	}
258 
259 	if (bmcr & BMCR_LOOP)
260 		mii->mii_media_active |= IFM_LOOP;
261 
262 	if (bmcr & BMCR_AUTOEN) {
263 		/*
264 		 * The media status bits are only valid if autonegotiation
265 		 * has completed (or it's disabled).
266 		 */
267 		if ((bmsr & BMSR_ACOMP) == 0) {
268 			/* Erg, still trying, I guess... */
269 			mii->mii_media_active |= IFM_NONE;
270 			return;
271 		}
272 
273 		/*
274 		 * The media is always 1000baseSX.  Check the ANLPAR to
275 		 * see if we're doing full-duplex.
276 		 */
277 		mii->mii_media_active |= IFM_1000_SX;
278 
279 		anlpar = PHY_READ(sc, MII_ANLPAR);
280 		if ((sc->mii_extcapabilities & EXTSR_1000XFDX) != 0 &&
281 		    (anlpar & ANLPAR_X_FD) != 0)
282 			mii->mii_media_active |=
283 			    IFM_FDX | mii_phy_flowstatus(sc);
284 		else
285 			mii->mii_media_active |= IFM_HDX;
286 	} else
287 		mii->mii_media_active = ife->ifm_media;
288 }
289