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