1 /* $NetBSD: mii_physubr.c,v 1.5 1999/08/03 19:41:49 drochner Exp $ */
4 * SPDX-License-Identifier: BSD-2-Clause-NetBSD
6 * Copyright (c) 1998, 1999, 2000, 2001 The NetBSD Foundation, Inc.
9 * This code is derived from software contributed to The NetBSD Foundation
10 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
11 * NASA Ames Research Center.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
22 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
24 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
25 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
26 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
39 * Subroutines common to all PHYs.
42 #include <sys/param.h>
43 #include <sys/systm.h>
44 #include <sys/kernel.h>
45 #include <sys/socket.h>
46 #include <sys/errno.h>
47 #include <sys/module.h>
51 #include <net/if_media.h>
53 #include <dev/mii/mii.h>
54 #include <dev/mii/miivar.h>
56 #include "miibus_if.h"
60 * An array of structures to map MII media types to BMCR/ANAR settings.
76 static const struct mii_media {
77 u_int mm_bmcr; /* BMCR settings for this media */
78 u_int mm_anar; /* ANAR settings for this media */
79 u_int mm_gtcr; /* 100base-T2 or 1000base-T CR */
80 } mii_media_table[MII_NMEDIA] = {
82 { BMCR_ISO, ANAR_CSMA,
86 { BMCR_S10, ANAR_CSMA|ANAR_10,
90 { BMCR_S10|BMCR_FDX, ANAR_CSMA|ANAR_10_FD,
94 { BMCR_S100, ANAR_CSMA|ANAR_T4,
98 { BMCR_S100, ANAR_CSMA|ANAR_TX,
102 { BMCR_S100|BMCR_FDX, ANAR_CSMA|ANAR_TX_FD,
106 { BMCR_S1000, ANAR_CSMA,
110 { BMCR_S1000|BMCR_FDX, ANAR_CSMA,
114 { BMCR_S1000, ANAR_CSMA,
118 { BMCR_S1000, ANAR_CSMA,
123 mii_phy_setmedia(struct mii_softc *sc)
125 struct mii_data *mii = sc->mii_pdata;
126 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
127 int bmcr, anar, gtcr;
130 switch (IFM_SUBTYPE(ife->ifm_media)) {
133 * Force renegotiation if MIIF_DOPAUSE or MIIF_FORCEANEG.
134 * The former is necessary as we might switch from flow-
135 * control advertisement being off to on or vice versa.
137 if ((PHY_READ(sc, MII_BMCR) & BMCR_AUTOEN) == 0 ||
138 (sc->mii_flags & (MIIF_DOPAUSE | MIIF_FORCEANEG)) != 0)
139 (void)mii_phy_auto(sc);
143 index = MII_MEDIA_NONE;
147 index = MII_MEDIA_10_T;
151 switch (IFM_OPTIONS(ife->ifm_media)) {
153 index = MII_MEDIA_10_T;
156 case (IFM_FDX | IFM_FLOW):
157 index = MII_MEDIA_10_T_FDX;
164 switch (IFM_OPTIONS(ife->ifm_media)) {
166 index = MII_MEDIA_100_TX;
169 case (IFM_FDX | IFM_FLOW):
170 index = MII_MEDIA_100_TX_FDX;
176 index = MII_MEDIA_100_T4;
180 switch (IFM_OPTIONS(ife->ifm_media)) {
182 index = MII_MEDIA_1000_X;
185 case (IFM_FDX | IFM_FLOW):
186 index = MII_MEDIA_1000_X_FDX;
192 switch (IFM_OPTIONS(ife->ifm_media)) {
195 index = MII_MEDIA_1000_T;
198 case (IFM_FDX | IFM_ETH_MASTER):
199 case (IFM_FDX | IFM_FLOW):
200 case (IFM_FDX | IFM_FLOW | IFM_ETH_MASTER):
201 index = MII_MEDIA_1000_T_FDX;
207 KASSERT(index != -1, ("%s: failed to map media word %d",
208 __func__, ife->ifm_media));
210 anar = mii_media_table[index].mm_anar;
211 bmcr = mii_media_table[index].mm_bmcr;
212 gtcr = mii_media_table[index].mm_gtcr;
214 if (IFM_SUBTYPE(ife->ifm_media) == IFM_1000_T) {
216 if ((ife->ifm_media & IFM_ETH_MASTER) != 0)
220 if ((ife->ifm_media & IFM_FDX) != 0 &&
221 ((ife->ifm_media & IFM_FLOW) != 0 ||
222 (sc->mii_flags & MIIF_FORCEPAUSE) != 0)) {
223 if ((sc->mii_flags & MIIF_IS_1000X) != 0)
224 anar |= ANAR_X_PAUSE_TOWARDS;
227 /* XXX Only 1000BASE-T has PAUSE_ASYM? */
228 if ((sc->mii_flags & MIIF_HAVE_GTCR) != 0 &&
229 (sc->mii_extcapabilities &
230 (EXTSR_1000THDX | EXTSR_1000TFDX)) != 0)
231 anar |= ANAR_X_PAUSE_ASYM;
235 PHY_WRITE(sc, MII_ANAR, anar);
236 PHY_WRITE(sc, MII_BMCR, bmcr);
237 if ((sc->mii_flags & MIIF_HAVE_GTCR) != 0)
238 PHY_WRITE(sc, MII_100T2CR, gtcr);
242 mii_phy_auto(struct mii_softc *sc)
244 struct ifmedia_entry *ife = sc->mii_pdata->mii_media.ifm_cur;
248 * Check for 1000BASE-X. Autonegotiation is a bit
249 * different on such devices.
251 if ((sc->mii_flags & MIIF_IS_1000X) != 0) {
253 if ((sc->mii_extcapabilities & EXTSR_1000XFDX) != 0)
255 if ((sc->mii_extcapabilities & EXTSR_1000XHDX) != 0)
258 if ((ife->ifm_media & IFM_FLOW) != 0 ||
259 (sc->mii_flags & MIIF_FORCEPAUSE) != 0)
260 anar |= ANAR_X_PAUSE_TOWARDS;
261 PHY_WRITE(sc, MII_ANAR, anar);
263 anar = BMSR_MEDIA_TO_ANAR(sc->mii_capabilities) |
265 if ((ife->ifm_media & IFM_FLOW) != 0 ||
266 (sc->mii_flags & MIIF_FORCEPAUSE) != 0) {
267 if ((sc->mii_capabilities &
268 (BMSR_10TFDX | BMSR_100TXFDX)) != 0)
270 /* XXX Only 1000BASE-T has PAUSE_ASYM? */
271 if (((sc->mii_flags & MIIF_HAVE_GTCR) != 0) &&
272 (sc->mii_extcapabilities &
273 (EXTSR_1000THDX | EXTSR_1000TFDX)) != 0)
274 anar |= ANAR_X_PAUSE_ASYM;
276 PHY_WRITE(sc, MII_ANAR, anar);
277 if ((sc->mii_flags & MIIF_HAVE_GTCR) != 0) {
279 if ((sc->mii_extcapabilities & EXTSR_1000TFDX) != 0)
280 gtcr |= GTCR_ADV_1000TFDX;
281 if ((sc->mii_extcapabilities & EXTSR_1000THDX) != 0)
282 gtcr |= GTCR_ADV_1000THDX;
283 PHY_WRITE(sc, MII_100T2CR, gtcr);
286 PHY_WRITE(sc, MII_BMCR, BMCR_AUTOEN | BMCR_STARTNEG);
287 return (EJUSTRETURN);
291 mii_phy_tick(struct mii_softc *sc)
293 struct ifmedia_entry *ife = sc->mii_pdata->mii_media.ifm_cur;
297 * If we're not doing autonegotiation, we don't need to do
298 * any extra work here. However, we need to check the link
299 * status so we can generate an announcement if the status
302 if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) {
303 sc->mii_ticks = 0; /* reset autonegotiation timer. */
307 /* Read the status register twice; BMSR_LINK is latch-low. */
308 reg = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
309 if ((reg & BMSR_LINK) != 0) {
310 sc->mii_ticks = 0; /* reset autonegotiation timer. */
315 /* Announce link loss right after it happens */
316 if (sc->mii_ticks++ == 0)
319 /* XXX: use default value if phy driver did not set mii_anegticks */
320 if (sc->mii_anegticks == 0)
321 sc->mii_anegticks = MII_ANEGTICKS_GIGE;
323 /* Only retry autonegotiation every mii_anegticks ticks. */
324 if (sc->mii_ticks <= sc->mii_anegticks)
325 return (EJUSTRETURN);
334 mii_phy_reset(struct mii_softc *sc)
336 struct ifmedia_entry *ife = sc->mii_pdata->mii_media.ifm_cur;
339 if ((sc->mii_flags & MIIF_NOISOLATE) != 0)
342 reg = BMCR_RESET | BMCR_ISO;
343 PHY_WRITE(sc, MII_BMCR, reg);
345 /* Wait 100ms for it to complete. */
346 for (i = 0; i < 100; i++) {
347 reg = PHY_READ(sc, MII_BMCR);
348 if ((reg & BMCR_RESET) == 0)
353 /* NB: a PHY may default to being powered down and/or isolated. */
354 reg &= ~(BMCR_PDOWN | BMCR_ISO);
355 if ((sc->mii_flags & MIIF_NOISOLATE) == 0 &&
356 ((ife == NULL && sc->mii_inst != 0) ||
357 (ife != NULL && IFM_INST(ife->ifm_media) != sc->mii_inst)))
359 if (PHY_READ(sc, MII_BMCR) != reg)
360 PHY_WRITE(sc, MII_BMCR, reg);
364 mii_phy_update(struct mii_softc *sc, int cmd)
366 struct mii_data *mii = sc->mii_pdata;
368 if (sc->mii_media_active != mii->mii_media_active ||
369 cmd == MII_MEDIACHG) {
370 MIIBUS_STATCHG(sc->mii_dev);
371 sc->mii_media_active = mii->mii_media_active;
373 if (sc->mii_media_status != mii->mii_media_status) {
374 MIIBUS_LINKCHG(sc->mii_dev);
375 sc->mii_media_status = mii->mii_media_status;
380 * Initialize generic PHY media based on BMSR, called when a PHY is
381 * attached. We expect to be set up to print a comma-separated list
382 * of media names. Does not print a newline.
385 mii_phy_add_media(struct mii_softc *sc)
387 struct mii_data *mii = sc->mii_pdata;
388 const char *sep = "";
391 if ((sc->mii_capabilities & BMSR_MEDIAMASK) == 0 &&
392 (sc->mii_extcapabilities & EXTSR_MEDIAMASK) == 0) {
393 printf("no media present");
398 * Set the autonegotiation timer for 10/100 media. Gigabit media is
401 sc->mii_anegticks = MII_ANEGTICKS;
403 #define ADD(m) ifmedia_add(&mii->mii_media, (m), 0, NULL)
404 #define PRINT(s) printf("%s%s", sep, s); sep = ", "
406 if ((sc->mii_flags & MIIF_NOISOLATE) == 0) {
407 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_NONE, 0, sc->mii_inst));
412 * There are different interpretations for the bits in
413 * HomePNA PHYs. And there is really only one media type
416 if ((sc->mii_flags & MIIF_IS_HPNA) != 0) {
417 if ((sc->mii_capabilities & BMSR_10THDX) != 0) {
418 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_HPNA_1, 0,
425 if ((sc->mii_capabilities & BMSR_10THDX) != 0) {
426 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_T, 0, sc->mii_inst));
429 if ((sc->mii_capabilities & BMSR_10TFDX) != 0) {
430 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_T, IFM_FDX, sc->mii_inst));
431 PRINT("10baseT-FDX");
432 if ((sc->mii_flags & MIIF_DOPAUSE) != 0 &&
433 (sc->mii_flags & MIIF_NOMANPAUSE) == 0) {
434 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_10_T,
435 IFM_FDX | IFM_FLOW, sc->mii_inst));
436 PRINT("10baseT-FDX-flow");
440 if ((sc->mii_capabilities & BMSR_100TXHDX) != 0) {
441 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, 0, sc->mii_inst));
444 if ((sc->mii_capabilities & BMSR_100TXFDX) != 0) {
445 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX, IFM_FDX, sc->mii_inst));
446 PRINT("100baseTX-FDX");
447 if ((sc->mii_flags & MIIF_DOPAUSE) != 0 &&
448 (sc->mii_flags & MIIF_NOMANPAUSE) == 0) {
449 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_TX,
450 IFM_FDX | IFM_FLOW, sc->mii_inst));
451 PRINT("100baseTX-FDX-flow");
455 if ((sc->mii_capabilities & BMSR_100T4) != 0) {
456 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_100_T4, 0, sc->mii_inst));
460 if ((sc->mii_extcapabilities & EXTSR_MEDIAMASK) != 0) {
462 * XXX Right now only handle 1000SX and 1000TX. Need
463 * XXX to handle 1000LX and 1000CX somehow.
465 if ((sc->mii_extcapabilities & EXTSR_1000XHDX) != 0) {
466 sc->mii_anegticks = MII_ANEGTICKS_GIGE;
467 sc->mii_flags |= MIIF_IS_1000X;
468 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, 0,
472 if ((sc->mii_extcapabilities & EXTSR_1000XFDX) != 0) {
473 sc->mii_anegticks = MII_ANEGTICKS_GIGE;
474 sc->mii_flags |= MIIF_IS_1000X;
475 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX, IFM_FDX,
477 PRINT("1000baseSX-FDX");
478 if ((sc->mii_flags & MIIF_DOPAUSE) != 0 &&
479 (sc->mii_flags & MIIF_NOMANPAUSE) == 0) {
480 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_SX,
481 IFM_FDX | IFM_FLOW, sc->mii_inst));
482 PRINT("1000baseSX-FDX-flow");
488 * 1000baseT media needs to be able to manipulate
491 * All 1000baseT PHYs have a 1000baseT control register.
493 if ((sc->mii_extcapabilities & EXTSR_1000THDX) != 0) {
494 sc->mii_anegticks = MII_ANEGTICKS_GIGE;
495 sc->mii_flags |= MIIF_HAVE_GTCR;
496 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_T, 0,
499 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_T,
500 IFM_ETH_MASTER, sc->mii_inst));
501 PRINT("1000baseT-master");
503 if ((sc->mii_extcapabilities & EXTSR_1000TFDX) != 0) {
504 sc->mii_anegticks = MII_ANEGTICKS_GIGE;
505 sc->mii_flags |= MIIF_HAVE_GTCR;
506 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_T, IFM_FDX,
508 PRINT("1000baseT-FDX");
509 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_T,
510 IFM_FDX | IFM_ETH_MASTER, sc->mii_inst));
511 PRINT("1000baseT-FDX-master");
512 if ((sc->mii_flags & MIIF_DOPAUSE) != 0 &&
513 (sc->mii_flags & MIIF_NOMANPAUSE) == 0) {
514 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_T,
515 IFM_FDX | IFM_FLOW, sc->mii_inst));
516 PRINT("1000baseT-FDX-flow");
517 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_1000_T,
518 IFM_FDX | IFM_FLOW | IFM_ETH_MASTER,
520 PRINT("1000baseT-FDX-flow-master");
526 if ((sc->mii_capabilities & BMSR_ANEG) != 0) {
527 /* intentionally invalid index */
528 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, 0, sc->mii_inst));
530 if (fdx != 0 && (sc->mii_flags & MIIF_DOPAUSE) != 0) {
531 ADD(IFM_MAKEWORD(IFM_ETHER, IFM_AUTO, IFM_FLOW,
541 mii_phy_detach(device_t dev)
543 struct mii_softc *sc;
545 sc = device_get_softc(dev);
547 LIST_REMOVE(sc, mii_list);
551 const struct mii_phydesc *
552 mii_phy_match_gen(const struct mii_attach_args *ma,
553 const struct mii_phydesc *mpd, size_t len)
556 for (; mpd->mpd_name != NULL;
557 mpd = (const struct mii_phydesc *)((const char *)mpd + len)) {
558 if (MII_OUI(ma->mii_id1, ma->mii_id2) == mpd->mpd_oui &&
559 MII_MODEL(ma->mii_id2) == mpd->mpd_model)
565 const struct mii_phydesc *
566 mii_phy_match(const struct mii_attach_args *ma, const struct mii_phydesc *mpd)
569 return (mii_phy_match_gen(ma, mpd, sizeof(struct mii_phydesc)));
573 mii_phy_dev_probe(device_t dev, const struct mii_phydesc *mpd, int mrv)
576 mpd = mii_phy_match(device_get_ivars(dev), mpd);
578 device_set_desc(dev, mpd->mpd_name);
585 mii_phy_dev_attach(device_t dev, u_int flags, const struct mii_phy_funcs *mpf,
588 struct mii_softc *sc;
589 struct mii_attach_args *ma;
590 struct mii_data *mii;
592 sc = device_get_softc(dev);
593 ma = device_get_ivars(dev);
594 sc->mii_dev = device_get_parent(dev);
596 LIST_INSERT_HEAD(&mii->mii_phys, sc, mii_list);
598 sc->mii_flags = flags | miibus_get_flags(dev);
599 sc->mii_mpd_oui = MII_OUI(ma->mii_id1, ma->mii_id2);
600 sc->mii_mpd_model = MII_MODEL(ma->mii_id2);
601 sc->mii_mpd_rev = MII_REV(ma->mii_id2);
602 sc->mii_capmask = ma->mii_capmask;
603 sc->mii_inst = mii->mii_instance++;
604 sc->mii_phy = ma->mii_phyno;
605 sc->mii_offset = ma->mii_offset;
610 device_printf(dev, "OUI 0x%06x, model 0x%04x, rev. %d\n",
611 sc->mii_mpd_oui, sc->mii_mpd_model, sc->mii_mpd_rev);
618 sc->mii_capabilities = PHY_READ(sc, MII_BMSR) & sc->mii_capmask;
619 if (sc->mii_capabilities & BMSR_EXTSTAT)
620 sc->mii_extcapabilities = PHY_READ(sc, MII_EXTSR);
621 device_printf(dev, " ");
622 mii_phy_add_media(sc);
625 MIIBUS_MEDIAINIT(sc->mii_dev);
629 * Return the flow control status flag from MII_ANAR & MII_ANLPAR.
632 mii_phy_flowstatus(struct mii_softc *sc)
636 if ((sc->mii_flags & MIIF_DOPAUSE) == 0)
639 anar = PHY_READ(sc, MII_ANAR);
640 anlpar = PHY_READ(sc, MII_ANLPAR);
643 * Check for 1000BASE-X. Autonegotiation is a bit
644 * different on such devices.
646 if ((sc->mii_flags & MIIF_IS_1000X) != 0) {
651 if ((anar & ANAR_PAUSE_SYM) != 0 && (anlpar & ANLPAR_PAUSE_SYM) != 0)
652 return (IFM_FLOW | IFM_ETH_TXPAUSE | IFM_ETH_RXPAUSE);
654 if ((anar & ANAR_PAUSE_SYM) == 0) {
655 if ((anar & ANAR_PAUSE_ASYM) != 0 &&
656 (anlpar & ANLPAR_PAUSE_TOWARDS) != 0)
657 return (IFM_FLOW | IFM_ETH_TXPAUSE);
662 if ((anar & ANAR_PAUSE_ASYM) == 0) {
663 if ((anlpar & ANLPAR_PAUSE_SYM) != 0)
664 return (IFM_FLOW | IFM_ETH_TXPAUSE | IFM_ETH_RXPAUSE);
669 switch ((anlpar & ANLPAR_PAUSE_TOWARDS)) {
670 case ANLPAR_PAUSE_NONE:
672 case ANLPAR_PAUSE_ASYM:
673 return (IFM_FLOW | IFM_ETH_RXPAUSE);
675 return (IFM_FLOW | IFM_ETH_RXPAUSE | IFM_ETH_TXPAUSE);