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