makphy.c revision 1.69 1 /* $NetBSD: makphy.c,v 1.69 2021/12/28 06:34:40 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 the Marvell 88E1000 ``Alaska'' 10/100/1000 PHY.
59 */
60
61 #include <sys/cdefs.h>
62 __KERNEL_RCSID(0, "$NetBSD: makphy.c,v 1.69 2021/12/28 06:34:40 msaitoh Exp $");
63
64 #include <sys/param.h>
65 #include <sys/systm.h>
66 #include <sys/kernel.h>
67 #include <sys/device.h>
68 #include <sys/socket.h>
69 #include <sys/errno.h>
70
71 #include <net/if.h>
72 #include <net/if_media.h>
73
74 #include <dev/mii/mii.h>
75 #include <dev/mii/miivar.h>
76 #include <dev/mii/miidevs.h>
77
78 #include <dev/mii/makphyreg.h>
79 #include <dev/mii/makphyvar.h>
80
81 static int makphymatch(device_t, cfdata_t, void *);
82 static void makphyattach(device_t, device_t, void *);
83
84 CFATTACH_DECL_NEW(makphy, sizeof(struct makphy_softc),
85 makphymatch, makphyattach, mii_phy_detach, mii_phy_activate);
86
87 static int makphy_service(struct mii_softc *, struct mii_data *, int);
88 static void makphy_status(struct mii_softc *);
89 static void makphy_reset(struct mii_softc *);
90
91 static const struct mii_phy_funcs makphy_funcs = {
92 makphy_service, makphy_status, makphy_reset,
93 };
94
95 static const struct mii_phydesc makphys[] = {
96 MII_PHY_DESC(MARVELL, E1000_0),
97 MII_PHY_DESC(MARVELL, E1000_3),
98 MII_PHY_DESC(MARVELL, E1000_5),
99 MII_PHY_DESC(MARVELL, E1000_6),
100 MII_PHY_DESC(xxMARVELL, E1000_3),
101 MII_PHY_DESC(xxMARVELL, E1000_5),
102 MII_PHY_DESC(xxMARVELL, E1000S),
103 MII_PHY_DESC(xxMARVELL, E1011),
104 MII_PHY_DESC(xxMARVELL, E1101),
105 MII_PHY_DESC(xxMARVELL, E1111),
106 MII_PHY_DESC(xxMARVELL, E1112),
107 MII_PHY_DESC(xxMARVELL, E1116),
108 MII_PHY_DESC(xxMARVELL, E1116R),
109 MII_PHY_DESC(xxMARVELL, E1118),
110 MII_PHY_DESC(xxMARVELL, E1145),
111 MII_PHY_DESC(xxMARVELL, E1149),
112 MII_PHY_DESC(xxMARVELL, E1149R),
113 MII_PHY_DESC(xxMARVELL, E1240),
114 MII_PHY_DESC(xxMARVELL, E1318S),
115 MII_PHY_DESC(xxMARVELL, E1512),
116 MII_PHY_DESC(xxMARVELL, E1543),
117 MII_PHY_DESC(xxMARVELL, E3016),
118 MII_PHY_DESC(xxMARVELL, E3082),
119 MII_PHY_DESC(xxMARVELL, PHYG65G),
120 MII_PHY_DESC(xxMARVELL, I347),
121 MII_PHY_END,
122 };
123
124 #define MAKARG_PDOWN true /* Power DOWN */
125 #define MAKARG_PUP false /* Power UP */
126
127 static bool
128 makphy_isi210(device_t parent, struct mii_attach_args *ma)
129 {
130
131 /* I21[01]'s model number is 0 */
132 if ((MII_OUI(ma->mii_id1, ma->mii_id2) == MII_OUI_xxMARVELL)
133 && (MII_MODEL(ma->mii_id2) == MII_MODEL_xxMARVELL_I210)
134 && (device_is_a(parent, "wm")))
135 return true;
136 return false;
137 }
138
139 static int
140 makphymatch(device_t parent, cfdata_t match, void *aux)
141 {
142 struct mii_attach_args *ma = aux;
143
144 if (mii_phy_match(ma, makphys) != NULL)
145 return 10;
146
147 if (makphy_isi210(parent, ma))
148 return 10;
149
150 return 0;
151 }
152
153 static void
154 makphyattach(device_t parent, device_t self, void *aux)
155 {
156 struct mii_softc *sc = device_private(self);
157 struct mii_attach_args *ma = aux;
158 struct mii_data *mii = ma->mii_data;
159 const struct mii_phydesc *mpd;
160 struct makphy_softc *maksc = (struct makphy_softc *)sc;
161 const char *name;
162 uint16_t reg, model;
163 int rv;
164
165 mpd = mii_phy_match(ma, makphys);
166 aprint_naive(": Media interface\n");
167 if (mpd)
168 name = mpd->mpd_name;
169 else if (makphy_isi210(parent, ma)) {
170 name = MII_STR_xxMARVELL_I210;
171 maksc->sc_flags |= MAKPHY_F_I210;
172 } else
173 panic("Unknown PHY");
174 aprint_normal(": %s, rev. %d\n", name, MII_REV(ma->mii_id2));
175
176 sc->mii_dev = self;
177 sc->mii_mpd_oui = MII_OUI(ma->mii_id1, ma->mii_id2);
178 sc->mii_mpd_model = model = MII_MODEL(ma->mii_id2);
179 sc->mii_mpd_rev = MII_REV(ma->mii_id2);
180 sc->mii_inst = mii->mii_instance;
181 sc->mii_phy = ma->mii_phyno;
182 sc->mii_funcs = &makphy_funcs;
183 sc->mii_pdata = mii;
184 sc->mii_flags = ma->mii_flags;
185
186 mii_lock(mii);
187
188 switch (model) {
189 case MII_MODEL_xxMARVELL_E1000:
190 if ((maksc->sc_flags & MAKPHY_F_I210) != 0)
191 goto page0;
192 /* FALLTHROUGH */
193 case MII_MODEL_xxMARVELL_E1000_3:
194 case MII_MODEL_xxMARVELL_E1000S:
195 case MII_MODEL_xxMARVELL_E1000_5:
196 /* 88E1000 series has no EADR */
197 break;
198 default:
199 page0:
200 /* Make sure page 0 is selected. */
201 if (PHY_WRITE(sc, MAKPHY_EADR, 0) != 0)
202 aprint_verbose_dev(self,
203 "Failed to access EADR. Are you an emulator?\n");
204 break;
205 }
206
207 PHY_RESET(sc);
208
209 PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
210 sc->mii_capabilities &= ma->mii_capmask;
211 if (sc->mii_capabilities & BMSR_EXTSTAT) {
212 rv = PHY_READ(sc, MII_EXTSR, &sc->mii_extcapabilities);
213 if (rv != 0) {
214 aprint_verbose_dev(self, "Failed to read EXTSR. "
215 "Are you an emulator?. "
216 "Regard as 1000BASE-T.\n");
217 sc->mii_extcapabilities
218 |= EXTSR_1000TFDX | EXTSR_1000THDX;
219 }
220 }
221
222 if (((sc->mii_extcapabilities & (EXTSR_1000TFDX | EXTSR_1000THDX))
223 != 0)
224 && ((sc->mii_extcapabilities & (EXTSR_1000XFDX | EXTSR_1000XHDX))
225 != 0)) {
226 bool fiberonly = false, copperonly = false;
227
228 /* Both copper and fiber are set. check MODE[] */
229 switch (sc->mii_mpd_model) {
230 case MII_MODEL_xxMARVELL_E1011:
231 case MII_MODEL_xxMARVELL_E1111:
232 /* These devices have ESSR register */
233 PHY_READ(sc, MAKPHY_ESSR, ®);
234 if ((reg & ESSR_AUTOSEL_DISABLE) != 0) {
235 switch (reg & ESSR_HWCFG_MODE) {
236 case ESSR_RTBI_FIBER:
237 case ESSR_RGMII_FIBER:
238 case ESSR_RGMII_SGMII: /* right? */
239 case ESSR_TBI_FIBER:
240 case ESSR_GMII_FIBER:
241 fiberonly = true;
242 break;
243 case ESSR_SGMII_WC_COPPER:
244 case ESSR_SGMII_WOC_COPPER:
245 case ESSR_RTBI_COPPER:
246 case ESSR_RGMII_COPPER:
247 case ESSR_GMII_COPPER:
248 copperonly = true;
249 default:
250 break;
251 }
252 }
253 break;
254 default:
255 break;
256 }
257 if (fiberonly || copperonly)
258 aprint_debug_dev(self, "both copper and fiber are set "
259 "but MODE[] is %s only.\n",
260 fiberonly ? "fiber" : "copper");
261 if (fiberonly)
262 sc->mii_extcapabilities
263 &= ~(EXTSR_1000TFDX | EXTSR_1000THDX);
264 else if (copperonly) {
265 sc->mii_extcapabilities
266 &= ~(EXTSR_1000XFDX | EXTSR_1000XHDX);
267 sc->mii_flags &= ~MIIF_IS_1000X;
268 }
269 }
270 mii_unlock(mii);
271 mii_phy_add_media(sc);
272 }
273
274 static void
275 makphy_reset(struct mii_softc *sc)
276 {
277 struct makphy_softc *maksc = (struct makphy_softc *)sc;
278 uint16_t reg;
279
280 KASSERT(mii_locked(sc->mii_pdata));
281
282 mii_phy_reset(sc);
283
284 /* Initialize PHY Specific Control Register. */
285 PHY_READ(sc, MAKPHY_PSCR, ®);
286
287 /* Assert CRS on transmit. */
288 switch (sc->mii_mpd_model) {
289 case MII_MODEL_MARVELL_E1000_0:
290 if ((maksc->sc_flags & MAKPHY_F_I210) != 0)
291 break;
292 /* FALLTHROUGH */
293 case MII_MODEL_MARVELL_E1000_3:
294 case MII_MODEL_MARVELL_E1000_5:
295 case MII_MODEL_MARVELL_E1000_6:
296 case MII_MODEL_xxMARVELL_E1000S:
297 case MII_MODEL_xxMARVELL_E1011:
298 case MII_MODEL_xxMARVELL_E1111:
299 reg |= PSCR_CRS_ON_TX;
300 break;
301 default: /* No PSCR_CRS_ON_TX bit */
302 break;
303 }
304
305 /* Enable scrambler if necessary. */
306 if (sc->mii_mpd_model == MII_MODEL_xxMARVELL_E3016)
307 reg &= ~E3016_PSCR_SCRAMBLE_DIS;
308
309 /*
310 * Store next page in the Link Partner Next Page register for
311 * compatibility with 802.3ab.
312 */
313 if (sc->mii_mpd_model == MII_MODEL_xxMARVELL_E3016)
314 reg |= E3016_PSCR_REG8NXTPG;
315
316 PHY_WRITE(sc, MAKPHY_PSCR, reg);
317
318 /* Configure LEDs if they were left unconfigured. */
319 if (sc->mii_mpd_model == MII_MODEL_xxMARVELL_E3016) {
320 PHY_READ(sc, 0x16, ®);
321 if (reg == 0) {
322 reg = (0x0b << 8) | (0x05 << 4) | 0x04; /* XXX */
323 PHY_WRITE(sc, 0x16, reg);
324 }
325 }
326
327 mii_phy_reset(sc);
328 }
329
330 static void
331 makphy_pdown(struct mii_softc *sc, bool pdown)
332 {
333 uint16_t bmcr, new;
334 bool need_reset = false;
335
336 /*
337 * XXX
338 * PSCR (register 16) should be modified on some chips.
339 */
340
341 PHY_READ(sc, MII_BMCR, &bmcr);
342 if (pdown)
343 new = bmcr | BMCR_PDOWN;
344 else
345 new = bmcr & ~BMCR_PDOWN;
346 if (bmcr != new)
347 need_reset = true;
348
349 if (need_reset)
350 new |= BMCR_RESET;
351 PHY_WRITE(sc, MII_BMCR, new);
352 }
353
354 static int
355 makphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
356 {
357 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
358 uint16_t bmcr;
359
360 if (!device_is_active(sc->mii_dev))
361 return ENXIO;
362
363 KASSERT(mii_locked(mii));
364
365 switch (cmd) {
366 case MII_POLLSTAT:
367 /* If we're not polling our PHY instance, just return. */
368 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
369 return 0;
370 break;
371
372 case MII_MEDIACHG:
373 /*
374 * If the media indicates a different PHY instance,
375 * isolate ourselves.
376 */
377 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
378 PHY_READ(sc, MII_BMCR, &bmcr);
379 PHY_WRITE(sc, MII_BMCR, bmcr | BMCR_ISO);
380 return 0;
381 }
382
383 /* If the interface is not up, don't do anything. */
384 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
385 break;
386
387 /* Try to power up the PHY in case it's down */
388 if (IFM_SUBTYPE(ife->ifm_media) != IFM_NONE)
389 makphy_pdown(sc, MAKARG_PUP);
390
391 mii_phy_setmedia(sc);
392
393 /*
394 * If autonegitation is not enabled, we need a
395 * software reset for the settings to take effect.
396 */
397 if (IFM_SUBTYPE(ife->ifm_media) == IFM_NONE)
398 makphy_pdown(sc, MAKARG_PDOWN);
399 else if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) {
400 PHY_READ(sc, MII_BMCR, &bmcr);
401 PHY_WRITE(sc, MII_BMCR, bmcr | BMCR_RESET);
402 }
403 break;
404
405 case MII_TICK:
406 /* If we're not currently selected, just return. */
407 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
408 return 0;
409
410 if (mii_phy_tick(sc) == EJUSTRETURN)
411 return 0;
412 break;
413
414 case MII_DOWN:
415 mii_phy_down(sc);
416 return 0;
417 }
418
419 /* Update the media status. */
420 mii_phy_status(sc);
421
422 /* Callback if something changed. */
423 mii_phy_update(sc, cmd);
424 return 0;
425 }
426
427 static void
428 makphy_status(struct mii_softc *sc)
429 {
430 struct mii_data *mii = sc->mii_pdata;
431 uint16_t bmcr, gsr, pssr, essr;
432
433 KASSERT(mii_locked(mii));
434
435 mii->mii_media_status = IFM_AVALID;
436 mii->mii_media_active = IFM_ETHER;
437
438 PHY_READ(sc, MII_BMCR, &bmcr);
439 /* XXX FIXME: Use different page for Fiber on newer chips */
440 PHY_READ(sc, MAKPHY_PSSR, &pssr);
441
442 if (pssr & MAKPHY_PSSR_LINK)
443 mii->mii_media_status |= IFM_ACTIVE;
444
445 if (bmcr & BMCR_LOOP)
446 mii->mii_media_active |= IFM_LOOP;
447
448 if (bmcr & (BMCR_ISO | BMCR_PDOWN)) {
449 mii->mii_media_active |= IFM_NONE;
450 return;
451 }
452
453 if ((bmcr & BMCR_AUTOEN) != 0) {
454 /*
455 * Check Speed and Duplex Resolved bit.
456 * Note that this bit is always 1 when autonego is not enabled.
457 */
458 if (!(pssr & MAKPHY_PSSR_RESOLVED)) {
459 /* Erg, still trying, I guess... */
460 mii->mii_media_active |= IFM_NONE;
461 return;
462 }
463 } else {
464 if ((pssr & MAKPHY_PSSR_LINK) == 0) {
465 mii->mii_media_active |= IFM_NONE;
466 return;
467 }
468 }
469
470 /*
471 * XXX The following code support Fiber/Copper auto select mode
472 * only for 88E1011, 88E1111 and 88E1112. For other chips, the document
473 * is required.
474 */
475 if (sc->mii_flags & MIIF_IS_1000X) {
476 /* Not in Fiber/Copper auto select mode */
477 mii->mii_media_active |= IFM_1000_SX;
478 } else if ((sc->mii_mpd_model == MII_MODEL_xxMARVELL_E1011) ||
479 (sc->mii_mpd_model == MII_MODEL_xxMARVELL_E1111)) {
480 /* Fiber/Copper auto select mode */
481
482 PHY_READ(sc, MAKPHY_ESSR, &essr);
483 if ((essr & ESSR_FIBER_LINK) == 0)
484 goto copper;
485
486 /* XXX Assume 1000BASE-SX only */
487 mii->mii_media_active |= IFM_1000_SX;
488 } else if (sc->mii_mpd_model == MII_MODEL_xxMARVELL_E1112) {
489 /* Fiber/Copper auto select mode */
490
491 PHY_READ(sc, MAKPHY_PSSR, &pssr);
492 if ((pssr & MAKPHY_PSSR_RESOLUTION_FIBER) == 0)
493 goto copper;
494
495 switch (MAKPHY_PSSR_SPEED_get(pssr)) {
496 case SPEED_1000:
497 mii->mii_media_active |= IFM_1000_SX;
498 break;
499 case SPEED_100:
500 mii->mii_media_active |= IFM_100_FX;
501 break;
502 default: /* Undefined (reserved) value */
503 mii->mii_media_active |= IFM_NONE;
504 mii->mii_media_status = 0;
505 return;
506 }
507 } else {
508 copper:
509 switch (MAKPHY_PSSR_SPEED_get(pssr)) {
510 case SPEED_1000:
511 mii->mii_media_active |= IFM_1000_T;
512 break;
513 case SPEED_100:
514 mii->mii_media_active |= IFM_100_TX;
515 break;
516 case SPEED_10:
517 mii->mii_media_active |= IFM_10_T;
518 break;
519 default: /* Undefined (reserved) value */
520 mii->mii_media_active |= IFM_NONE;
521 mii->mii_media_status = 0;
522 return;
523 }
524 }
525
526 if (pssr & MAKPHY_PSSR_DUPLEX)
527 mii->mii_media_active |= mii_phy_flowstatus(sc) | IFM_FDX;
528 else
529 mii->mii_media_active |= IFM_HDX;
530
531 if (IFM_SUBTYPE(mii->mii_media_active) == IFM_1000_T) {
532 PHY_READ(sc, MII_100T2SR, &gsr);
533 if (gsr & GTSR_MS_RES)
534 mii->mii_media_active |= IFM_ETH_MASTER;
535 }
536 }
537