1 /* $NetBSD: jmphy.c,v 1.5 2023/02/22 08:09:09 msaitoh Exp $ */
2 /* $OpenBSD: jmphy.c,v 1.6 2015/03/14 03:38:48 jsg Exp $ */
3 /*-
4 * Copyright (c) 2008, Pyun YongHyeon <yongari@FreeBSD.org>
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice unmodified, this list of conditions, and the following
12 * disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * $FreeBSD: src/sys/dev/mii/jmphy.c,v 1.1 2008/05/27 01:16:40 yongari Exp $
30 * $DragonFly: src/sys/dev/netif/mii_layer/jmphy.c,v 1.1 2008/07/22 11:28:49 sephe Exp $
31 */
32
33 /*
34 * Driver for the JMicron JMP211 10/100/1000, JMP202 10/100 PHY.
35 */
36
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/device.h>
40 #include <sys/socket.h>
41
42 #include <net/if.h>
43 #include <net/if_media.h>
44
45 #include <dev/mii/mii.h>
46 #include <dev/mii/miivar.h>
47 #include <dev/mii/miidevs.h>
48 #include <dev/mii/jmphyreg.h>
49
50 static int jmphy_service(struct mii_softc *, struct mii_data *, int);
51 static void jmphy_status(struct mii_softc *);
52 static int jmphy_match(device_t, cfdata_t, void *);
53 static void jmphy_attach(device_t, device_t, void *);
54 static void jmphy_reset(struct mii_softc *);
55 static uint16_t jmphy_anar(struct ifmedia_entry *);
56 static int jmphy_auto(struct mii_softc *, struct ifmedia_entry *);
57
58 static const struct mii_phy_funcs jmphy_funcs = {
59 jmphy_service, jmphy_status, jmphy_reset,
60 };
61
62 CFATTACH_DECL_NEW(jmphy, sizeof (struct mii_softc),
63 jmphy_match, jmphy_attach, mii_phy_detach, mii_phy_activate);
64
65 static const struct mii_phydesc jmphys[] = {
66 MII_PHY_DESC(JMICRON, JMP202),
67 MII_PHY_DESC(JMICRON, JMP211),
68 MII_PHY_END,
69 };
70
71 static int
jmphy_match(device_t parent,cfdata_t match,void * aux)72 jmphy_match(device_t parent, cfdata_t match, void *aux)
73 {
74 struct mii_attach_args *ma = aux;
75
76 if (mii_phy_match(ma, jmphys) != NULL)
77 return 10;
78
79 return 0;
80 }
81
82 static void
jmphy_attach(device_t parent,device_t self,void * aux)83 jmphy_attach(device_t parent, device_t self, void *aux)
84 {
85 struct mii_softc *sc = device_private(self);
86 struct mii_attach_args *ma = aux;
87 struct mii_data *mii = ma->mii_data;
88 const struct mii_phydesc *mpd;
89
90 mpd = mii_phy_match(ma, jmphys);
91 aprint_naive(": Media interface\n");
92 aprint_normal(": %s, rev. %d\n", mpd->mpd_name, MII_REV(ma->mii_id2));
93
94 sc->mii_dev = self;
95 sc->mii_inst = mii->mii_instance;
96 sc->mii_phy = ma->mii_phyno;
97 sc->mii_funcs = &jmphy_funcs;
98 sc->mii_mpd_oui = MII_OUI(ma->mii_id1, ma->mii_id2);
99 sc->mii_mpd_model = MII_MODEL(ma->mii_id2);
100 sc->mii_mpd_rev = MII_REV(ma->mii_id2);
101 sc->mii_pdata = mii;
102 sc->mii_flags = ma->mii_flags;
103
104 sc->mii_flags |= MIIF_NOISOLATE | MIIF_NOLOOP;
105
106 mii_lock(mii);
107
108 PHY_RESET(sc);
109
110 PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
111 sc->mii_capabilities &= ma->mii_capmask;
112 if (sc->mii_capabilities & BMSR_EXTSTAT)
113 PHY_READ(sc, MII_EXTSR, &sc->mii_extcapabilities);
114
115 mii_unlock(mii);
116
117 mii_phy_add_media(sc);
118 }
119
120 static int
jmphy_service(struct mii_softc * sc,struct mii_data * mii,int cmd)121 jmphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
122 {
123 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
124 uint16_t bmcr, ssr;
125
126 KASSERT(mii_locked(mii));
127
128 switch (cmd) {
129 case MII_POLLSTAT:
130 /* If we're not polling our PHY instance, just return. */
131 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
132 return 0;
133 break;
134
135 case MII_MEDIACHG:
136 /*
137 * If the media indicates a different PHY instance,
138 * isolate ourselves.
139 */
140 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
141 PHY_READ(sc, MII_BMCR, &bmcr);
142 PHY_WRITE(sc, MII_BMCR, bmcr | BMCR_ISO);
143 return 0;
144 }
145
146 /* If the interface is not up, don't do anything. */
147 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
148 break;
149
150 if (jmphy_auto(sc, ife) != EJUSTRETURN)
151 return EINVAL;
152 break;
153
154 case MII_TICK:
155 /* If we're not currently selected, just return. */
156 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
157 return 0;
158
159 /* Is the interface even up? */
160 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
161 return 0;
162
163 /* Only used for autonegotiation. */
164 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO)
165 break;
166
167 /* Check for link. */
168 PHY_READ(sc, JMPHY_SSR, &ssr);
169 if (ssr & JMPHY_SSR_LINK_UP) {
170 sc->mii_ticks = 0;
171 break;
172 }
173
174 /* Announce link loss right after it happens. */
175 if (sc->mii_ticks++ == 0)
176 break;
177 if (sc->mii_ticks < sc->mii_anegticks)
178 return 0;
179
180 sc->mii_ticks = 0;
181 jmphy_auto(sc, ife);
182 break;
183 }
184
185 /* Update the media status. */
186 jmphy_status(sc);
187
188 /* Callback if something changed. */
189 mii_phy_update(sc, cmd);
190 return 0;
191 }
192
193 static void
jmphy_status(struct mii_softc * sc)194 jmphy_status(struct mii_softc *sc)
195 {
196 struct mii_data *mii = sc->mii_pdata;
197 uint16_t bmcr, ssr, gtsr;
198
199 KASSERT(mii_locked(mii));
200
201 mii->mii_media_status = IFM_AVALID;
202 mii->mii_media_active = IFM_ETHER;
203
204 PHY_READ(sc, JMPHY_SSR, &ssr);
205 if ((ssr & JMPHY_SSR_LINK_UP) != 0)
206 mii->mii_media_status |= IFM_ACTIVE;
207
208 PHY_READ(sc, MII_BMCR, &bmcr);
209 if ((bmcr & BMCR_ISO) != 0) {
210 mii->mii_media_active |= IFM_NONE;
211 mii->mii_media_status = 0;
212 return;
213 }
214
215 if ((bmcr & BMCR_LOOP) != 0)
216 mii->mii_media_active |= IFM_LOOP;
217
218 if ((ssr & JMPHY_SSR_SPD_DPLX_RESOLVED) == 0) {
219 /* Erg, still trying, I guess... */
220 mii->mii_media_active |= IFM_NONE;
221 return;
222 }
223
224 switch ((ssr & JMPHY_SSR_SPEED_MASK)) {
225 case JMPHY_SSR_SPEED_1000:
226 mii->mii_media_active |= IFM_1000_T;
227 /*
228 * jmphy(4) got a valid link so reset mii_ticks.
229 * Resetting mii_ticks is needed in order to
230 * detect link loss after auto-negotiation.
231 */
232 sc->mii_ticks = 0;
233 break;
234 case JMPHY_SSR_SPEED_100:
235 mii->mii_media_active |= IFM_100_TX;
236 sc->mii_ticks = 0;
237 break;
238 case JMPHY_SSR_SPEED_10:
239 mii->mii_media_active |= IFM_10_T;
240 sc->mii_ticks = 0;
241 break;
242 default:
243 mii->mii_media_active |= IFM_NONE;
244 return;
245 }
246
247 if ((ssr & JMPHY_SSR_DUPLEX) != 0)
248 mii->mii_media_active |= IFM_FDX | mii_phy_flowstatus(sc);
249 else
250 mii->mii_media_active |= IFM_HDX;
251
252 if (IFM_SUBTYPE(mii->mii_media_active) == IFM_1000_T) {
253 PHY_READ(sc, MII_GTSR, >sr);
254 if ((gtsr & GTSR_MS_RES) != 0)
255 mii->mii_media_active |= IFM_ETH_MASTER;
256 }
257 }
258
259 static void
jmphy_reset(struct mii_softc * sc)260 jmphy_reset(struct mii_softc *sc)
261 {
262 int i;
263 uint16_t val;
264
265 KASSERT(mii_locked(sc->mii_pdata));
266
267 /* Disable sleep mode. */
268 PHY_READ(sc, JMPHY_TMCTL, &val);
269 PHY_WRITE(sc, JMPHY_TMCTL, val & ~JMPHY_TMCTL_SLEEP_ENB);
270
271 PHY_READ(sc, MII_BMCR, &val);
272 PHY_WRITE(sc, MII_BMCR, val | BMCR_RESET);
273
274 for (i = 0; i < 1000; i++) {
275 DELAY(1);
276 PHY_READ(sc, MII_BMCR, &val);
277 if ((val & BMCR_RESET) == 0)
278 break;
279 }
280 }
281
282 static uint16_t
jmphy_anar(struct ifmedia_entry * ife)283 jmphy_anar(struct ifmedia_entry *ife)
284 {
285 uint16_t anar;
286
287 anar = 0;
288 switch (IFM_SUBTYPE(ife->ifm_media)) {
289 case IFM_AUTO:
290 anar |= ANAR_TX_FD | ANAR_TX | ANAR_10_FD | ANAR_10;
291 break;
292 case IFM_1000_T:
293 break;
294 case IFM_100_TX:
295 anar |= ANAR_TX | ANAR_TX_FD;
296 break;
297 case IFM_10_T:
298 anar |= ANAR_10 | ANAR_10_FD;
299 break;
300 default:
301 break;
302 }
303
304 return anar;
305 }
306
307 static int
jmphy_auto(struct mii_softc * sc,struct ifmedia_entry * ife)308 jmphy_auto(struct mii_softc *sc, struct ifmedia_entry *ife)
309 {
310 uint16_t anar, bmcr, gig;
311
312 KASSERT(mii_locked(sc->mii_pdata));
313
314 gig = 0;
315 PHY_READ(sc, MII_BMCR, &bmcr);
316 switch (IFM_SUBTYPE(ife->ifm_media)) {
317 case IFM_AUTO:
318 gig |= GTCR_ADV_1000TFDX | GTCR_ADV_1000THDX;
319 break;
320 case IFM_1000_T:
321 gig |= GTCR_ADV_1000TFDX | GTCR_ADV_1000THDX;
322 break;
323 case IFM_100_TX:
324 case IFM_10_T:
325 break;
326 case IFM_NONE:
327 PHY_WRITE(sc, MII_BMCR, bmcr | BMCR_ISO | BMCR_PDOWN);
328 return EJUSTRETURN;
329 default:
330 return EINVAL;
331 }
332
333 if ((ife->ifm_media & IFM_LOOP) != 0)
334 bmcr |= BMCR_LOOP;
335
336 anar = jmphy_anar(ife);
337 if (sc->mii_flags & MIIF_DOPAUSE)
338 anar |= ANAR_PAUSE_TOWARDS;
339
340 if ((sc->mii_flags & MIIF_HAVE_GTCR) != 0) {
341 #ifdef notyet
342 struct mii_data *mii;
343
344 mii = sc->mii_pdata;
345 if ((mii->mii_media.ifm_media & IFM_ETH_MASTER) != 0)
346 gig |= GTCR_MAN_MS | GTCR_MAN_ADV;
347 #endif
348 PHY_WRITE(sc, MII_100T2CR, gig);
349 }
350 PHY_WRITE(sc, MII_ANAR, anar | ANAR_CSMA);
351 PHY_WRITE(sc, MII_BMCR, bmcr | BMCR_AUTOEN | BMCR_STARTNEG);
352
353 return EJUSTRETURN;
354 }
355