1 /* $NetBSD: gentbi.c,v 1.32 2021/06/29 21:03:36 pgoyette 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.32 2021/06/29 21:03:36 pgoyette 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
gentbimatch(device_t parent,cfdata_t match,void * aux)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 rv;
100 uint16_t bmsr, extsr;
101
102 /*
103 * We match as a generic TBI if:
104 *
105 * - There is no media in the BMSR.
106 * - EXTSR has only 1000X.
107 */
108 mii_lock(mii);
109 rv = (*mii->mii_readreg)(parent, ma->mii_phyno, MII_BMSR, &bmsr);
110 if ((rv != 0)
111 || (bmsr & BMSR_EXTSTAT) == 0 || (bmsr & BMSR_MEDIAMASK) != 0) {
112 mii_unlock(mii);
113 return 0;
114 }
115
116 rv = (*mii->mii_readreg)(parent, ma->mii_phyno, MII_EXTSR, &extsr);
117 if ((rv != 0) || ((extsr & (EXTSR_1000TFDX | EXTSR_1000THDX)) != 0)) {
118 mii_unlock(mii);
119 return 0;
120 }
121 mii_unlock(mii);
122
123 if (extsr & (EXTSR_1000XFDX | EXTSR_1000XHDX)) {
124 /*
125 * We think this is a generic TBI. Return a match
126 * priority higher than ukphy, but lower than what
127 * specific drivers will return.
128 */
129 return 2;
130 }
131
132 return 0;
133 }
134
135 static void
gentbiattach(device_t parent,device_t self,void * aux)136 gentbiattach(device_t parent, device_t self, void *aux)
137 {
138 struct mii_softc *sc = device_private(self);
139 struct mii_attach_args *ma = aux;
140 struct mii_data *mii = ma->mii_data;
141 int oui = MII_OUI(ma->mii_id1, ma->mii_id2);
142 int model = MII_MODEL(ma->mii_id2);
143 int rev = MII_REV(ma->mii_id2);
144 char descr[MII_MAX_DESCR_LEN];
145
146 mii_get_descr(descr, sizeof(descr), oui, model);
147 if (descr[0])
148 aprint_normal(": %s (OUI 0x%06x, model 0x%04x), rev. %d\n",
149 descr, oui, model, rev);
150 else
151 aprint_normal(": OUI 0x%06x, model 0x%04x, rev. %d\n",
152 oui, model, rev);
153
154 aprint_naive(": Generic ten-bit interface\n");
155
156 sc->mii_dev = self;
157 sc->mii_inst = mii->mii_instance;
158 sc->mii_phy = ma->mii_phyno;
159 sc->mii_mpd_oui = oui;
160 sc->mii_mpd_model = model;
161 sc->mii_mpd_rev = rev;
162 sc->mii_funcs = &gentbi_funcs;
163 sc->mii_pdata = mii;
164 sc->mii_flags = ma->mii_flags;
165
166 mii_lock(mii);
167
168 PHY_RESET(sc);
169
170 /*
171 * Mask out all media in the BMSR. We only are really interested
172 * in "auto".
173 */
174 PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
175 sc->mii_capabilities =
176 sc->mii_capabilities & ma->mii_capmask & ~BMSR_MEDIAMASK;
177 if (sc->mii_capabilities & BMSR_EXTSTAT)
178 PHY_READ(sc, MII_EXTSR, &sc->mii_extcapabilities);
179
180 mii_unlock(mii);
181
182 mii_phy_add_media(sc);
183 }
184
185 static int
gentbi_service(struct mii_softc * sc,struct mii_data * mii,int cmd)186 gentbi_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
187 {
188 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
189 uint16_t reg;
190
191 KASSERT(mii_locked(mii));
192
193 switch (cmd) {
194 case MII_POLLSTAT:
195 /* If we're not polling our PHY instance, just return. */
196 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
197 return 0;
198 break;
199
200 case MII_MEDIACHG:
201 /*
202 * If the media indicates a different PHY instance,
203 * isolate ourselves.
204 */
205 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
206 PHY_READ(sc, MII_BMCR, ®);
207 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
208 return 0;
209 }
210
211 /* If the interface is not up, don't do anything. */
212 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
213 break;
214
215 mii_phy_setmedia(sc);
216 break;
217
218 case MII_TICK:
219 /* If we're not currently selected, just return. */
220 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
221 return 0;
222
223 if (mii_phy_tick(sc) == EJUSTRETURN)
224 return 0;
225 break;
226
227 case MII_DOWN:
228 mii_phy_down(sc);
229 return 0;
230 }
231
232 /* Update the media status. */
233 mii_phy_status(sc);
234
235 /* Callback if something changed. */
236 mii_phy_update(sc, cmd);
237 return 0;
238 }
239
240 static void
gentbi_status(struct mii_softc * sc)241 gentbi_status(struct mii_softc *sc)
242 {
243 struct mii_data *mii = sc->mii_pdata;
244 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
245 uint16_t bmsr, bmcr, anlpar;
246
247 KASSERT(mii_locked(mii));
248
249 mii->mii_media_status = IFM_AVALID;
250 mii->mii_media_active = IFM_ETHER;
251
252 PHY_READ(sc, MII_BMSR, &bmsr);
253 PHY_READ(sc, MII_BMSR, &bmsr);
254
255 if (bmsr & BMSR_LINK)
256 mii->mii_media_status |= IFM_ACTIVE;
257
258 PHY_READ(sc, MII_BMCR, &bmcr);
259 if (bmcr & BMCR_ISO) {
260 mii->mii_media_active |= IFM_NONE;
261 mii->mii_media_status = 0;
262 return;
263 }
264
265 if (bmcr & BMCR_LOOP)
266 mii->mii_media_active |= IFM_LOOP;
267
268 if (bmcr & BMCR_AUTOEN) {
269 /*
270 * The media status bits are only valid if autonegotiation
271 * has completed (or it's disabled).
272 */
273 if ((bmsr & BMSR_ACOMP) == 0) {
274 /* Erg, still trying, I guess... */
275 mii->mii_media_active |= IFM_NONE;
276 return;
277 }
278
279 /*
280 * The media is always 1000baseSX. Check the ANLPAR to
281 * see if we're doing full-duplex.
282 */
283 mii->mii_media_active |= IFM_1000_SX;
284
285 PHY_READ(sc, MII_ANLPAR, &anlpar);
286 if ((sc->mii_extcapabilities & EXTSR_1000XFDX) != 0 &&
287 (anlpar & ANLPAR_X_FD) != 0)
288 mii->mii_media_active |=
289 IFM_FDX | mii_phy_flowstatus(sc);
290 else
291 mii->mii_media_active |= IFM_HDX;
292 } else
293 mii->mii_media_active = ife->ifm_media;
294 }
295