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