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