makphy.c revision 1.61 1 /* $NetBSD: makphy.c,v 1.61 2019/11/26 08:19:51 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.61 2019/11/26 08:19:51 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_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 switch (model) {
205 case MII_MODEL_xxMARVELL_E1011:
206 case MII_MODEL_xxMARVELL_E1112:
207 if (PHY_READ(sc, MAKPHY_ESSR, ®) != 0) {
208 aprint_verbose_dev(self,
209 "Failed to read MAKPHY_ESSR\n");
210 break;
211 }
212 if (reg & ESSR_FIBER_LINK)
213 sc->mii_flags |= MIIF_HAVEFIBER;
214 break;
215 default:
216 break;
217 }
218
219 PHY_RESET(sc);
220
221 PHY_READ(sc, MII_BMSR, &sc->mii_capabilities);
222 sc->mii_capabilities &= ma->mii_capmask;
223 if (sc->mii_capabilities & BMSR_EXTSTAT)
224 PHY_READ(sc, MII_EXTSR, &sc->mii_extcapabilities);
225
226 aprint_normal_dev(self, "");
227 if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 &&
228 (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0)
229 aprint_error("no media present");
230 else
231 mii_phy_add_media(sc);
232 aprint_normal("\n");
233 }
234
235 static void
236 makphy_reset(struct mii_softc *sc)
237 {
238 struct makphy_softc *maksc = (struct makphy_softc *)sc;
239 uint16_t reg;
240
241 mii_phy_reset(sc);
242
243 /* Initialize PHY Specific Control Register. */
244 PHY_READ(sc, MAKPHY_PSCR, ®);
245
246 /* Assert CRS on transmit. */
247 switch (sc->mii_mpd_model) {
248 case MII_MODEL_MARVELL_E1000_0:
249 if ((maksc->sc_flags & MAKPHY_F_I210) != 0)
250 break;
251 /* FALLTHROUGH */
252 case MII_MODEL_MARVELL_E1000_3:
253 case MII_MODEL_MARVELL_E1000_5:
254 case MII_MODEL_MARVELL_E1000_6:
255 case MII_MODEL_xxMARVELL_E1000S:
256 case MII_MODEL_xxMARVELL_E1011:
257 case MII_MODEL_xxMARVELL_E1111:
258 reg |= PSCR_CRS_ON_TX;
259 break;
260 default: /* No PSCR_CRS_ON_TX bit */
261 break;
262 }
263
264 /* Enable scrambler if necessary. */
265 if (sc->mii_mpd_model == MII_MODEL_xxMARVELL_E3016)
266 reg &= ~E3016_PSCR_SCRAMBLE_DIS;
267
268 /*
269 * Store next page in the Link Partner Next Page register for
270 * compatibility with 802.3ab.
271 */
272 if (sc->mii_mpd_model == MII_MODEL_xxMARVELL_E3016)
273 reg |= E3016_PSCR_REG8NXTPG;
274
275 PHY_WRITE(sc, MAKPHY_PSCR, reg);
276
277 /* Configure LEDs if they were left unconfigured. */
278 if (sc->mii_mpd_model == MII_MODEL_xxMARVELL_E3016) {
279 PHY_READ(sc, 0x16, ®);
280 if (reg == 0) {
281 reg = (0x0b << 8) | (0x05 << 4) | 0x04; /* XXX */
282 PHY_WRITE(sc, 0x16, reg);
283 }
284 }
285
286 mii_phy_reset(sc);
287 }
288
289 static void
290 makphy_pdown(struct mii_softc *sc, bool pdown)
291 {
292 uint16_t bmcr, new;
293 bool need_reset = false;
294
295 /*
296 * XXX
297 * PSCR (register 16) should be modified on some chips.
298 */
299
300 PHY_READ(sc, MII_BMCR, &bmcr);
301 if (pdown)
302 new = bmcr | BMCR_PDOWN;
303 else
304 new = bmcr & ~BMCR_PDOWN;
305 if (bmcr != new)
306 need_reset = true;
307
308 if (need_reset)
309 new |= BMCR_RESET;
310 PHY_WRITE(sc, MII_BMCR, new);
311 }
312
313 static int
314 makphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
315 {
316 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
317 uint16_t bmcr;
318
319 if (!device_is_active(sc->mii_dev))
320 return ENXIO;
321
322 switch (cmd) {
323 case MII_POLLSTAT:
324 /* If we're not polling our PHY instance, just return. */
325 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
326 return 0;
327 break;
328
329 case MII_MEDIACHG:
330 /*
331 * If the media indicates a different PHY instance,
332 * isolate ourselves.
333 */
334 if (IFM_INST(ife->ifm_media) != sc->mii_inst) {
335 PHY_READ(sc, MII_BMCR, &bmcr);
336 PHY_WRITE(sc, MII_BMCR, bmcr | BMCR_ISO);
337 return 0;
338 }
339
340 /* If the interface is not up, don't do anything. */
341 if ((mii->mii_ifp->if_flags & IFF_UP) == 0)
342 break;
343
344 /* Try to power up the PHY in case it's down */
345 if (IFM_SUBTYPE(ife->ifm_media) != IFM_NONE)
346 makphy_pdown(sc, MAKARG_PUP);
347
348 mii_phy_setmedia(sc);
349
350 /*
351 * If autonegitation is not enabled, we need a
352 * software reset for the settings to take effect.
353 */
354 if (IFM_SUBTYPE(ife->ifm_media) == IFM_NONE)
355 makphy_pdown(sc, MAKARG_PDOWN);
356 else if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) {
357 PHY_READ(sc, MII_BMCR, &bmcr);
358 PHY_WRITE(sc, MII_BMCR, bmcr | BMCR_RESET);
359 }
360 break;
361
362 case MII_TICK:
363 /* If we're not currently selected, just return. */
364 if (IFM_INST(ife->ifm_media) != sc->mii_inst)
365 return 0;
366
367 if (mii_phy_tick(sc) == EJUSTRETURN)
368 return 0;
369 break;
370
371 case MII_DOWN:
372 mii_phy_down(sc);
373 return 0;
374 }
375
376 /* Update the media status. */
377 mii_phy_status(sc);
378
379 /* Callback if something changed. */
380 mii_phy_update(sc, cmd);
381 return 0;
382 }
383
384 static void
385 makphy_status(struct mii_softc *sc)
386 {
387 struct mii_data *mii = sc->mii_pdata;
388 uint16_t bmcr, gsr, pssr;
389
390 mii->mii_media_status = IFM_AVALID;
391 mii->mii_media_active = IFM_ETHER;
392
393 PHY_READ(sc, MII_BMCR, &bmcr);
394 /* XXX FIXME: Use different page for Fiber on newer chips */
395 PHY_READ(sc, MAKPHY_PSSR, &pssr);
396
397 if (pssr & PSSR_LINK)
398 mii->mii_media_status |= IFM_ACTIVE;
399
400 if (bmcr & BMCR_LOOP)
401 mii->mii_media_active |= IFM_LOOP;
402
403 if (bmcr & BMCR_ISO) {
404 mii->mii_media_active |= IFM_NONE;
405 mii->mii_media_status = 0;
406 return;
407 }
408
409 if ((bmcr & BMCR_AUTOEN) != 0) {
410 /*
411 * Check Speed and Duplex Resolved bit.
412 * Note that this bit is always 1 when autonego is not enabled.
413 */
414 if (!(pssr & PSSR_RESOLVED)) {
415 /* Erg, still trying, I guess... */
416 mii->mii_media_active |= IFM_NONE;
417 return;
418 }
419 } else {
420 if ((pssr & PSSR_LINK) == 0) {
421 mii->mii_media_active |= IFM_NONE;
422 return;
423 }
424 }
425
426 /* XXX FIXME: Use different page for Fiber on newer chips */
427 if (sc->mii_flags & MIIF_IS_1000X) {
428 mii->mii_media_active |= IFM_1000_SX;
429 } else {
430 switch (PSSR_SPEED_get(pssr)) {
431 case SPEED_1000:
432 mii->mii_media_active |= IFM_1000_T;
433 break;
434 case SPEED_100:
435 mii->mii_media_active |= IFM_100_TX;
436 break;
437 case SPEED_10:
438 mii->mii_media_active |= IFM_10_T;
439 break;
440 default: /* Undefined (reserved) value */
441 mii->mii_media_active |= IFM_NONE;
442 mii->mii_media_status = 0;
443 return;
444 }
445 }
446
447 if (pssr & PSSR_DUPLEX)
448 mii->mii_media_active |= mii_phy_flowstatus(sc) | IFM_FDX;
449 else
450 mii->mii_media_active |= IFM_HDX;
451
452 if (IFM_SUBTYPE(mii->mii_media_active) == IFM_1000_T) {
453 PHY_READ(sc, MII_100T2SR, &gsr);
454 if (gsr & GTSR_MS_RES)
455 mii->mii_media_active |= IFM_ETH_MASTER;
456 }
457 }
458