1 /* $NetBSD: mii_physubr.c,v 1.5 1999/08/03 19:41:49 drochner Exp $ */
4 * Copyright (c) 1998, 1999, 2000, 2001 The NetBSD Foundation, Inc.
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.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
37 * Subroutines common to all PHYs.
40 #include <sys/param.h>
41 #include <sys/systm.h>
42 #include <sys/kernel.h>
43 #include <sys/socket.h>
44 #include <sys/errno.h>
45 #include <sys/module.h>
49 #include <net/if_media.h>
51 #include <dev/mii/mii.h>
52 #include <dev/mii/miivar.h>
54 #include "miibus_if.h"
57 * Media to register setting conversion table. Order matters.
59 const struct mii_media mii_media_table[MII_NMEDIA] = {
61 { BMCR_ISO, ANAR_CSMA,
65 { BMCR_S10, ANAR_CSMA|ANAR_10,
69 { BMCR_S10|BMCR_FDX, ANAR_CSMA|ANAR_10_FD,
73 { BMCR_S100, ANAR_CSMA|ANAR_T4,
77 { BMCR_S100, ANAR_CSMA|ANAR_TX,
81 { BMCR_S100|BMCR_FDX, ANAR_CSMA|ANAR_TX_FD,
85 { BMCR_S1000, ANAR_CSMA,
89 { BMCR_S1000|BMCR_FDX, ANAR_CSMA,
93 { BMCR_S1000, ANAR_CSMA,
97 { BMCR_S1000, ANAR_CSMA,
102 mii_phy_setmedia(struct mii_softc *sc)
104 struct mii_data *mii = sc->mii_pdata;
105 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
106 int bmcr, anar, gtcr;
108 if (IFM_SUBTYPE(ife->ifm_media) == IFM_AUTO) {
110 * Force renegotiation if MIIF_DOPAUSE or MIIF_FORCEANEG.
111 * The former is necessary as we might switch from flow-
112 * control advertisment being off to on or vice versa.
114 if ((PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN) == 0 ||
115 (sc->mii_flags & (MIIF_DOPAUSE | MIIF_FORCEANEG)) != 0)
116 (void)mii_phy_auto(sc);
121 * Table index is stored in the media entry.
124 KASSERT(ife->ifm_data >=0 && ife->ifm_data < MII_NMEDIA,
125 ("invalid ife->ifm_data (0x%x) in mii_phy_setmedia",
128 anar = mii_media_table[ife->ifm_data].mm_anar;
129 bmcr = mii_media_table[ife->ifm_data].mm_bmcr;
130 gtcr = mii_media_table[ife->ifm_data].mm_gtcr;
132 if (IFM_SUBTYPE(ife->ifm_media) == IFM_1000_T) {
134 if ((ife->ifm_media & IFM_ETH_MASTER) != 0)
138 if ((ife->ifm_media & IFM_GMASK) == (IFM_FDX | IFM_FLOW) ||
139 (sc->mii_flags & MIIF_FORCEPAUSE) != 0) {
140 if ((sc->mii_flags & MIIF_IS_1000X) != 0)
141 anar |= ANAR_X_PAUSE_TOWARDS;
144 /* XXX Only 1000BASE-T has PAUSE_ASYM? */
145 if ((sc->mii_flags & MIIF_HAVE_GTCR) != 0 &&
146 (sc->mii_extcapabilities &
147 (EXTSR_1000THDX | EXTSR_1000TFDX)) != 0)
148 anar |= ANAR_X_PAUSE_ASYM;
152 if ((ife->ifm_media & IFM_LOOP) != 0)
155 PHY_WRITE(sc, MII_ANAR, anar);
156 PHY_WRITE(sc, MII_BMCR, bmcr);
157 if ((sc->mii_flags & MIIF_HAVE_GTCR) != 0)
158 PHY_WRITE(sc, MII_100T2CR, gtcr);
162 mii_phy_auto(struct mii_softc *sc)
164 struct ifmedia_entry *ife = sc->mii_pdata->mii_media.ifm_cur;
168 * Check for 1000BASE-X. Autonegotiation is a bit
169 * different on such devices.
171 if ((sc->mii_flags & MIIF_IS_1000X) != 0) {
173 if ((sc->mii_extcapabilities & EXTSR_1000XFDX) != 0)
175 if ((sc->mii_extcapabilities & EXTSR_1000XHDX) != 0)
178 if ((ife->ifm_media & IFM_FLOW) != 0 ||
179 (sc->mii_flags & MIIF_FORCEPAUSE) != 0)
180 anar |= ANAR_X_PAUSE_TOWARDS;
181 PHY_WRITE(sc, MII_ANAR, anar);
183 anar = BMSR_MEDIA_TO_ANAR(sc->mii_capabilities) |
185 if ((ife->ifm_media & IFM_FLOW) != 0 ||
186 (sc->mii_flags & MIIF_FORCEPAUSE) != 0) {
187 if ((sc->mii_capabilities & BMSR_100TXFDX) != 0)
189 /* XXX Only 1000BASE-T has PAUSE_ASYM? */
190 if (((sc->mii_flags & MIIF_HAVE_GTCR) != 0) &&
191 (sc->mii_extcapabilities &
192 (EXTSR_1000THDX | EXTSR_1000TFDX)) != 0)
193 anar |= ANAR_X_PAUSE_ASYM;
195 PHY_WRITE(sc, MII_ANAR, anar);
196 if ((sc->mii_flags & MIIF_HAVE_GTCR) != 0) {
198 if ((sc->mii_extcapabilities & EXTSR_1000TFDX) != 0)
199 gtcr |= GTCR_ADV_1000TFDX;
200 if ((sc->mii_extcapabilities & EXTSR_1000THDX) != 0)
201 gtcr |= GTCR_ADV_1000THDX;
202 PHY_WRITE(sc, MII_100T2CR, gtcr);
205 PHY_WRITE(sc, MII_BMCR, BMCR_AUTOEN | BMCR_STARTNEG);
206 return (EJUSTRETURN);
210 mii_phy_tick(struct mii_softc *sc)
212 struct ifmedia_entry *ife = sc->mii_pdata->mii_media.ifm_cur;
213 struct ifnet *ifp = sc->mii_pdata->mii_ifp;
216 /* Just bail now if the interface is down. */
217 if ((ifp->if_flags & IFF_UP) == 0)
218 return (EJUSTRETURN);
221 * If we're not doing autonegotiation, we don't need to do
222 * any extra work here. However, we need to check the link
223 * status so we can generate an announcement if the status
226 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) {
227 sc->mii_ticks = 0; /* reset autonegotiation timer. */
231 /* Read the status register twice; BMSR_LINK is latch-low. */
232 reg = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
233 if ((reg & BMSR_LINK) != 0) {
234 sc->mii_ticks = 0; /* reset autonegotiation timer. */
239 /* Announce link loss right after it happens */
240 if (sc->mii_ticks++ == 0)
243 /* XXX: use default value if phy driver did not set mii_anegticks */
244 if (sc->mii_anegticks == 0)
245 sc->mii_anegticks = MII_ANEGTICKS_GIGE;
247 /* Only retry autonegotiation every mii_anegticks ticks. */
248 if (sc->mii_ticks <= sc->mii_anegticks)
249 return (EJUSTRETURN);
258 mii_phy_reset(struct mii_softc *sc)
260 struct ifmedia_entry *ife = sc->mii_pdata->mii_media.ifm_cur;
263 if ((sc->mii_flags & MIIF_NOISOLATE) != 0)
266 reg = BMCR_RESET | BMCR_ISO;
267 PHY_WRITE(sc, MII_BMCR, reg);
269 /* Wait 100ms for it to complete. */
270 for (i = 0; i < 100; i++) {
271 reg = PHY_READ(sc, MII_BMCR);
272 if ((reg & BMCR_RESET) == 0)
277 if ((sc->mii_flags & MIIF_NOISOLATE) == 0) {
278 if ((ife == NULL && sc->mii_inst != 0) ||
279 (ife != NULL && IFM_INST(ife->ifm_media) != sc->mii_inst))
280 PHY_WRITE(sc, MII_BMCR, reg | BMCR_ISO);
285 mii_phy_down(struct mii_softc *sc)
291 mii_phy_update(struct mii_softc *sc, int cmd)
293 struct mii_data *mii = sc->mii_pdata;
295 if (sc->mii_media_active != mii->mii_media_active ||
296 cmd == MII_MEDIACHG) {
297 MIIBUS_STATCHG(sc->mii_dev);
298 sc->mii_media_active = mii->mii_media_active;
300 if (sc->mii_media_status != mii->mii_media_status) {
301 MIIBUS_LINKCHG(sc->mii_dev);
302 sc->mii_media_status = mii->mii_media_status;
307 * Given an ifmedia word, return the corresponding ANAR value.
314 switch (media & (IFM_TMASK|IFM_NMASK|IFM_FDX)) {
315 case IFM_ETHER|IFM_10_T:
316 rv = ANAR_10|ANAR_CSMA;
318 case IFM_ETHER|IFM_10_T|IFM_FDX:
319 rv = ANAR_10_FD|ANAR_CSMA;
321 case IFM_ETHER|IFM_100_TX:
322 rv = ANAR_TX|ANAR_CSMA;
324 case IFM_ETHER|IFM_100_TX|IFM_FDX:
325 rv = ANAR_TX_FD|ANAR_CSMA;
327 case IFM_ETHER|IFM_100_T4:
328 rv = ANAR_T4|ANAR_CSMA;
339 * Initialize generic PHY media based on BMSR, called when a PHY is
340 * attached. We expect to be set up to print a comma-separated list
341 * of media names. Does not print a newline.
344 mii_add_media(struct mii_softc *sc)
346 struct mii_data *mii = sc->mii_pdata;
347 const char *sep = "";
349 if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0) {
350 printf("no media present");
354 #define ADD(m, c) ifmedia_add(&mii->mii_media, (m), (c), NULL)
355 #define PRINT(s) printf("%s%s", sep, s); sep = ", "
357 if (sc->mii_capabilities & BMSR_10THDX) {
358 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_T, 0, sc->mii_inst), 0);
361 if (sc->mii_capabilities & BMSR_10TFDX) {
362 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_T, IFM_FDX, sc->mii_inst),
364 PRINT("10baseT-FDX");
366 if (sc->mii_capabilities & BMSR_100TXHDX) {
367 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, 0, sc->mii_inst),
371 if (sc->mii_capabilities & BMSR_100TXFDX) {
372 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_FDX, sc->mii_inst),
374 PRINT("100baseTX-FDX");
376 if (sc->mii_capabilities & BMSR_100T4) {
378 * XXX How do you enable 100baseT4? I assume we set
379 * XXX BMCR_S100 and then assume the PHYs will take
380 * XXX watever action is necessary to switch themselves
383 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_T4, 0, sc->mii_inst),
387 if (sc->mii_capabilities & BMSR_ANEG) {
388 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, sc->mii_inst),
400 * Initialize generic PHY media based on BMSR, called when a PHY is
401 * attached. We expect to be set up to print a comma-separated list
402 * of media names. Does not print a newline.
405 mii_phy_add_media(struct mii_softc *sc)
407 struct mii_data *mii = sc->mii_pdata;
408 const char *sep = "";
411 if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 &&
412 (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0) {
413 printf("no media present");
418 * Set the autonegotiation timer for 10/100 media. Gigabit media is
421 sc->mii_anegticks = MII_ANEGTICKS;
423 #define ADD(m, c) ifmedia_add(&mii->mii_media, (m), (c), NULL)
424 #define PRINT(s) printf("%s%s", sep, s); sep = ", "
426 if ((sc->mii_flags & MIIF_NOISOLATE) == 0)
427 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst),
431 * There are different interpretations for the bits in
432 * HomePNA PHYs. And there is really only one media type
435 if ((sc->mii_flags & MIIF_IS_HPNA) != 0) {
436 if ((sc->mii_capabilities & BMSR_10THDX) != 0) {
437 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_HPNA_1, 0,
438 sc->mii_inst), MII_MEDIA_10_T);
444 if ((sc->mii_capabilities & BMSR_10THDX) != 0) {
445 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_T, 0, sc->mii_inst),
449 if ((sc->mii_capabilities & BMSR_10TFDX) != 0) {
450 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_T, IFM_FDX, sc->mii_inst),
452 PRINT("10baseT-FDX");
453 if ((sc->mii_flags & MIIF_DOPAUSE) != 0 &&
454 (sc->mii_flags & MIIF_NOMANPAUSE) == 0) {
455 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_T,
456 IFM_FDX | IFM_FLOW, sc->mii_inst),
458 PRINT("10baseT-FDX-flow");
462 if ((sc->mii_capabilities & BMSR_100TXHDX) != 0) {
463 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, 0, sc->mii_inst),
467 if ((sc->mii_capabilities & BMSR_100TXFDX) != 0) {
468 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_FDX, sc->mii_inst),
469 MII_MEDIA_100_TX_FDX);
470 PRINT("100baseTX-FDX");
471 if ((sc->mii_flags & MIIF_DOPAUSE) != 0 &&
472 (sc->mii_flags & MIIF_NOMANPAUSE) == 0) {
473 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX,
474 IFM_FDX | IFM_FLOW, sc->mii_inst),
475 MII_MEDIA_100_TX_FDX);
476 PRINT("100baseTX-FDX-flow");
480 if ((sc->mii_capabilities & BMSR_100T4) != 0) {
481 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_T4, 0, sc->mii_inst),
486 if ((sc->mii_extcapabilities & EXTSR_MEDIAMASK) != 0) {
488 * XXX Right now only handle 1000SX and 1000TX. Need
489 * XXX to handle 1000LX and 1000CX somehow.
491 if ((sc->mii_extcapabilities & EXTSR_1000XHDX) != 0) {
492 sc->mii_anegticks = MII_ANEGTICKS_GIGE;
493 sc->mii_flags |= MIIF_IS_1000X;
494 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, 0,
495 sc->mii_inst), MII_MEDIA_1000_X);
498 if ((sc->mii_extcapabilities & EXTSR_1000XFDX) != 0) {
499 sc->mii_anegticks = MII_ANEGTICKS_GIGE;
500 sc->mii_flags |= MIIF_IS_1000X;
501 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, IFM_FDX,
502 sc->mii_inst), MII_MEDIA_1000_X_FDX);
503 PRINT("1000baseSX-FDX");
504 if ((sc->mii_flags & MIIF_DOPAUSE) != 0 &&
505 (sc->mii_flags & MIIF_NOMANPAUSE) == 0) {
506 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX,
507 IFM_FDX | IFM_FLOW, sc->mii_inst),
508 MII_MEDIA_1000_X_FDX);
509 PRINT("1000baseSX-FDX-flow");
515 * 1000baseT media needs to be able to manipulate
518 * All 1000baseT PHYs have a 1000baseT control register.
520 if ((sc->mii_extcapabilities & EXTSR_1000THDX) != 0) {
521 sc->mii_anegticks = MII_ANEGTICKS_GIGE;
522 sc->mii_flags |= MIIF_HAVE_GTCR;
523 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_T, 0,
524 sc->mii_inst), MII_MEDIA_1000_T);
526 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_T,
527 IFM_ETH_MASTER, sc->mii_inst), MII_MEDIA_1000_T);
528 PRINT("1000baseT-master");
530 if ((sc->mii_extcapabilities & EXTSR_1000TFDX) != 0) {
531 sc->mii_anegticks = MII_ANEGTICKS_GIGE;
532 sc->mii_flags |= MIIF_HAVE_GTCR;
533 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_T, IFM_FDX,
534 sc->mii_inst), MII_MEDIA_1000_T_FDX);
535 PRINT("1000baseT-FDX");
536 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_T,
537 IFM_FDX | IFM_ETH_MASTER, sc->mii_inst),
538 MII_MEDIA_1000_T_FDX);
539 PRINT("1000baseT-FDX-master");
540 if ((sc->mii_flags & MIIF_DOPAUSE) != 0 &&
541 (sc->mii_flags & MIIF_NOMANPAUSE) == 0) {
542 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_T,
543 IFM_FDX | IFM_FLOW, sc->mii_inst),
544 MII_MEDIA_1000_T_FDX);
545 PRINT("1000baseT-FDX-flow");
546 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_T,
547 IFM_FDX | IFM_FLOW | IFM_ETH_MASTER,
548 sc->mii_inst), MII_MEDIA_1000_T_FDX);
549 PRINT("1000baseT-FDX-flow-master");
555 if ((sc->mii_capabilities & BMSR_ANEG) != 0) {
556 /* intentionally invalid index */
557 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, sc->mii_inst),
560 if (fdx != 0 && (sc->mii_flags & MIIF_DOPAUSE) != 0) {
561 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, IFM_FLOW,
562 sc->mii_inst), MII_NMEDIA);
571 mii_phy_detach(device_t dev)
573 struct mii_softc *sc;
575 sc = device_get_softc(dev);
578 LIST_REMOVE(sc, mii_list);
582 const struct mii_phydesc *
583 mii_phy_match_gen(const struct mii_attach_args *ma,
584 const struct mii_phydesc *mpd, size_t len)
587 for (; mpd->mpd_name != NULL;
588 mpd = (const struct mii_phydesc *)((const char *)mpd + len)) {
589 if (MII_OUI(ma->mii_id1, ma->mii_id2) == mpd->mpd_oui &&
590 MII_MODEL(ma->mii_id2) == mpd->mpd_model)
596 const struct mii_phydesc *
597 mii_phy_match(const struct mii_attach_args *ma, const struct mii_phydesc *mpd)
600 return (mii_phy_match_gen(ma, mpd, sizeof(struct mii_phydesc)));
604 mii_phy_dev_probe(device_t dev, const struct mii_phydesc *mpd, int mrv)
607 mpd = mii_phy_match(device_get_ivars(dev), mpd);
609 device_set_desc(dev, mpd->mpd_name);
616 * Return the flow control status flag from MII_ANAR & MII_ANLPAR.
619 mii_phy_flowstatus(struct mii_softc *sc)
623 if ((sc->mii_flags & MIIF_DOPAUSE) == 0)
626 anar = PHY_READ(sc, MII_ANAR);
627 anlpar = PHY_READ(sc, MII_ANLPAR);
630 * Check for 1000BASE-X. Autonegotiation is a bit
631 * different on such devices.
633 if ((sc->mii_flags & MIIF_IS_1000X) != 0) {
638 if ((anar & ANAR_PAUSE_SYM) != 0 && (anlpar & ANLPAR_PAUSE_SYM) != 0)
639 return (IFM_FLOW | IFM_ETH_TXPAUSE | IFM_ETH_RXPAUSE);
641 if ((anar & ANAR_PAUSE_SYM) == 0) {
642 if ((anar & ANAR_PAUSE_ASYM) != 0 &&
643 (anlpar & ANLPAR_PAUSE_TOWARDS) != 0)
644 return (IFM_FLOW | IFM_ETH_TXPAUSE);
649 if ((anar & ANAR_PAUSE_ASYM) == 0) {
650 if ((anlpar & ANLPAR_PAUSE_SYM) != 0)
651 return (IFM_FLOW | IFM_ETH_TXPAUSE | IFM_ETH_RXPAUSE);
656 switch ((anlpar & ANLPAR_PAUSE_TOWARDS)) {
657 case ANLPAR_PAUSE_NONE:
659 case ANLPAR_PAUSE_ASYM:
660 return (IFM_FLOW | IFM_ETH_RXPAUSE);
662 return (IFM_FLOW | IFM_ETH_RXPAUSE | IFM_ETH_TXPAUSE);