1 /* $NetBSD: mii.c,v 1.12 1999/08/03 19:41:49 drochner Exp $ */
4 * SPDX-License-Identifier: BSD-2-Clause-NetBSD
6 * Copyright (c) 1998 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 * MII bus layer, glues MII-capable network interface drivers to sharable
40 * PHY drivers. This exports an interface compatible with BSD/OS 3.0's,
41 * plus some NetBSD extensions.
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/socket.h>
47 #include <sys/malloc.h>
48 #include <sys/module.h>
53 #include <net/if_var.h>
54 #include <net/if_media.h>
56 #include <dev/mii/mii.h>
57 #include <dev/mii/miivar.h>
59 MODULE_VERSION(miibus, 1);
61 #include "miibus_if.h"
63 static bus_child_detached_t miibus_child_detached;
64 static bus_child_location_t miibus_child_location;
65 static bus_child_pnpinfo_t miibus_child_pnpinfo;
66 static device_detach_t miibus_detach;
67 static bus_hinted_child_t miibus_hinted_child;
68 static bus_print_child_t miibus_print_child;
69 static device_probe_t miibus_probe;
70 static bus_read_ivar_t miibus_read_ivar;
71 static miibus_readreg_t miibus_readreg;
72 static miibus_statchg_t miibus_statchg;
73 static miibus_writereg_t miibus_writereg;
74 static miibus_linkchg_t miibus_linkchg;
75 static miibus_mediainit_t miibus_mediainit;
77 static unsigned char mii_bitreverse(unsigned char x);
79 static device_method_t miibus_methods[] = {
80 /* device interface */
81 DEVMETHOD(device_probe, miibus_probe),
82 DEVMETHOD(device_attach, miibus_attach),
83 DEVMETHOD(device_detach, miibus_detach),
84 DEVMETHOD(device_shutdown, bus_generic_shutdown),
87 DEVMETHOD(bus_print_child, miibus_print_child),
88 DEVMETHOD(bus_read_ivar, miibus_read_ivar),
89 DEVMETHOD(bus_child_detached, miibus_child_detached),
90 DEVMETHOD(bus_child_pnpinfo, miibus_child_pnpinfo),
91 DEVMETHOD(bus_child_location, miibus_child_location),
92 DEVMETHOD(bus_hinted_child, miibus_hinted_child),
95 DEVMETHOD(miibus_readreg, miibus_readreg),
96 DEVMETHOD(miibus_writereg, miibus_writereg),
97 DEVMETHOD(miibus_statchg, miibus_statchg),
98 DEVMETHOD(miibus_linkchg, miibus_linkchg),
99 DEVMETHOD(miibus_mediainit, miibus_mediainit),
104 devclass_t miibus_devclass;
105 DEFINE_CLASS_0(miibus, miibus_driver, miibus_methods, sizeof(struct mii_data));
107 struct miibus_ivars {
109 ifm_change_cb_t ifmedia_upd;
110 ifm_stat_cb_t ifmedia_sts;
116 miibus_probe(device_t dev)
119 device_set_desc(dev, "MII bus");
121 return (BUS_PROBE_SPECIFIC);
125 miibus_attach(device_t dev)
127 struct miibus_ivars *ivars;
128 struct mii_attach_args *ma;
129 struct mii_data *mii;
133 mii = device_get_softc(dev);
134 if (device_get_children(dev, &children, &nchildren) == 0) {
135 for (i = 0; i < nchildren; i++) {
136 ma = device_get_ivars(children[i]);
139 free(children, M_TEMP);
141 if (nchildren == 0) {
142 device_printf(dev, "cannot get children\n");
145 ivars = device_get_ivars(dev);
146 ifmedia_init(&mii->mii_media, IFM_IMASK, ivars->ifmedia_upd,
148 mii->mii_ifp = ivars->ifp;
149 if_setcapabilitiesbit(mii->mii_ifp, IFCAP_LINKSTATE, 0);
150 if_setcapenablebit(mii->mii_ifp, IFCAP_LINKSTATE, 0);
151 LIST_INIT(&mii->mii_phys);
153 return (bus_generic_attach(dev));
157 miibus_detach(device_t dev)
159 struct mii_data *mii;
160 struct miibus_ivars *ivars;
162 ivars = device_get_ivars(dev);
163 bus_generic_detach(dev);
164 mii = device_get_softc(dev);
165 ifmedia_removeall(&mii->mii_media);
166 free(ivars, M_DEVBUF);
173 miibus_child_detached(device_t dev, device_t child)
175 struct mii_attach_args *args;
177 args = device_get_ivars(child);
178 free(args, M_DEVBUF);
182 miibus_print_child(device_t dev, device_t child)
184 struct mii_attach_args *ma;
187 ma = device_get_ivars(child);
188 retval = bus_print_child_header(dev, child);
189 retval += printf(" PHY %d", ma->mii_phyno);
190 retval += bus_print_child_footer(dev, child);
196 miibus_read_ivar(device_t dev, device_t child __unused, int which,
199 struct miibus_ivars *ivars;
202 * NB: this uses the instance variables of the miibus rather than
205 ivars = device_get_ivars(dev);
207 case MIIBUS_IVAR_FLAGS:
208 *result = ivars->mii_flags;
217 miibus_child_pnpinfo(device_t dev __unused, device_t child, struct sbuf *sb)
219 struct mii_attach_args *ma;
221 ma = device_get_ivars(child);
222 sbuf_printf(sb, "oui=0x%x model=0x%x rev=0x%x",
223 MII_OUI(ma->mii_id1, ma->mii_id2),
224 MII_MODEL(ma->mii_id2), MII_REV(ma->mii_id2));
229 miibus_child_location(device_t dev __unused, device_t child, struct sbuf *sb)
231 struct mii_attach_args *ma;
233 ma = device_get_ivars(child);
234 sbuf_printf(sb, "phyno=%d", ma->mii_phyno);
239 miibus_hinted_child(device_t dev, const char *name, int unit)
241 struct miibus_ivars *ivars;
242 struct mii_attach_args *args, *ma;
243 device_t *children, phy;
247 if (resource_int_value(name, unit, "phyno", &val) != 0)
249 if (device_get_children(dev, &children, &nchildren) != 0)
252 for (i = 0; i < nchildren; i++) {
253 args = device_get_ivars(children[i]);
254 if (args->mii_phyno == val) {
259 free(children, M_TEMP);
262 * Don't add a PHY that was automatically identified by having media
263 * in its BMSR twice, only allow to alter its attach arguments.
266 ma = malloc(sizeof(struct mii_attach_args), M_DEVBUF,
270 phy = device_add_child(dev, name, unit);
275 ivars = device_get_ivars(dev);
277 ma->mii_offset = ivars->mii_offset++;
280 ma->mii_capmask = BMSR_DEFCAPMASK;
281 device_set_ivars(phy, ma);
284 if (resource_int_value(name, unit, "id1", &val) == 0)
286 if (resource_int_value(name, unit, "id2", &val) == 0)
288 if (resource_int_value(name, unit, "capmask", &val) == 0)
289 ma->mii_capmask = val;
293 miibus_readreg(device_t dev, int phy, int reg)
297 parent = device_get_parent(dev);
298 return (MIIBUS_READREG(parent, phy, reg));
302 miibus_writereg(device_t dev, int phy, int reg, int data)
306 parent = device_get_parent(dev);
307 return (MIIBUS_WRITEREG(parent, phy, reg, data));
311 miibus_statchg(device_t dev)
314 struct mii_data *mii;
316 parent = device_get_parent(dev);
317 MIIBUS_STATCHG(parent);
319 mii = device_get_softc(dev);
320 if_setbaudrate(mii->mii_ifp, ifmedia_baudrate(mii->mii_media_active));
324 miibus_linkchg(device_t dev)
326 struct mii_data *mii;
330 parent = device_get_parent(dev);
331 MIIBUS_LINKCHG(parent);
333 mii = device_get_softc(dev);
335 if (mii->mii_media_status & IFM_AVALID) {
336 if (mii->mii_media_status & IFM_ACTIVE)
337 link_state = LINK_STATE_UP;
339 link_state = LINK_STATE_DOWN;
341 link_state = LINK_STATE_UNKNOWN;
342 if_link_state_change(mii->mii_ifp, link_state);
346 miibus_mediainit(device_t dev)
348 struct mii_data *mii;
349 struct ifmedia_entry *m;
352 /* Poke the parent in case it has any media of its own to add. */
353 MIIBUS_MEDIAINIT(device_get_parent(dev));
355 mii = device_get_softc(dev);
356 LIST_FOREACH(m, &mii->mii_media.ifm_list, ifm_list) {
357 media = m->ifm_media;
358 if (media == (IFM_ETHER | IFM_AUTO))
362 ifmedia_set(&mii->mii_media, media);
366 * Helper function used by network interface drivers, attaches the miibus and
367 * the PHYs to the network interface driver parent.
370 mii_attach(device_t dev, device_t *miibus, if_t ifp,
371 ifm_change_cb_t ifmedia_upd, ifm_stat_cb_t ifmedia_sts, int capmask,
372 int phyloc, int offloc, int flags)
374 struct miibus_ivars *ivars;
375 struct mii_attach_args *args, ma;
376 device_t *children, phy;
377 int bmsr, first, i, nchildren, phymax, phymin, rv;
382 if (phyloc != MII_PHY_ANY && offloc != MII_OFFSET_ANY) {
383 printf("%s: phyloc and offloc specified\n", __func__);
387 if (offloc != MII_OFFSET_ANY && (offloc < 0 || offloc >= MII_NPHY)) {
388 printf("%s: invalid offloc %d\n", __func__, offloc);
392 if (phyloc == MII_PHY_ANY) {
394 phymax = MII_NPHY - 1;
396 if (phyloc < 0 || phyloc >= MII_NPHY) {
397 printf("%s: invalid phyloc %d\n", __func__, phyloc);
400 phymin = phymax = phyloc;
404 if (*miibus == NULL) {
406 ivars = malloc(sizeof(*ivars), M_DEVBUF, M_NOWAIT);
410 ivars->ifmedia_upd = ifmedia_upd;
411 ivars->ifmedia_sts = ifmedia_sts;
412 ivars->mii_flags = flags;
413 *miibus = device_add_child(dev, "miibus", -1);
414 if (*miibus == NULL) {
418 device_set_ivars(*miibus, ivars);
420 ivars = device_get_ivars(*miibus);
421 if (ivars->ifp != ifp || ivars->ifmedia_upd != ifmedia_upd ||
422 ivars->ifmedia_sts != ifmedia_sts ||
423 ivars->mii_flags != flags) {
424 printf("%s: non-matching invariant\n", __func__);
428 * Assignment of the attach arguments mii_data for the first
429 * pass is done in miibus_attach(), i.e. once the miibus softc
430 * has been allocated.
432 ma.mii_data = device_get_softc(*miibus);
435 ma.mii_capmask = capmask;
437 if (resource_int_value(device_get_name(*miibus),
438 device_get_unit(*miibus), "phymask", &phymask) != 0)
439 phymask = 0xffffffff;
441 if (device_get_children(*miibus, &children, &nchildren) != 0) {
445 ivars->mii_offset = 0;
446 for (ma.mii_phyno = phymin; ma.mii_phyno <= phymax; ma.mii_phyno++) {
448 * Make sure we haven't already configured a PHY at this
449 * address. This allows mii_attach() to be called
452 for (i = 0; i < nchildren; i++) {
453 args = device_get_ivars(children[i]);
454 if (args->mii_phyno == ma.mii_phyno) {
456 * Yes, there is already something
457 * configured at this address.
464 * Check to see if there is a PHY at this address. Note,
465 * many braindead PHYs report 0/0 in their ID registers,
466 * so we test for media in the BMSR.
468 bmsr = MIIBUS_READREG(dev, ma.mii_phyno, MII_BMSR);
469 if (bmsr == 0 || bmsr == 0xffff ||
470 (bmsr & (BMSR_EXTSTAT | BMSR_MEDIAMASK)) == 0) {
471 /* Assume no PHY at this address. */
476 * There is a PHY at this address. If we were given an
477 * `offset' locator, skip this PHY if it doesn't match.
479 if (offloc != MII_OFFSET_ANY && offloc != ivars->mii_offset)
483 * Skip this PHY if it's not included in the phymask hint.
485 if ((phymask & (1 << ma.mii_phyno)) == 0)
489 * Extract the IDs. Braindead PHYs will be handled by
490 * the `ukphy' driver, as we have no ID information to
493 ma.mii_id1 = MIIBUS_READREG(dev, ma.mii_phyno, MII_PHYIDR1);
494 ma.mii_id2 = MIIBUS_READREG(dev, ma.mii_phyno, MII_PHYIDR2);
496 ma.mii_offset = ivars->mii_offset;
497 args = malloc(sizeof(struct mii_attach_args), M_DEVBUF,
501 bcopy((char *)&ma, (char *)args, sizeof(ma));
502 phy = device_add_child(*miibus, NULL, -1);
504 free(args, M_DEVBUF);
507 device_set_ivars(phy, args);
511 free(children, M_TEMP);
514 rv = device_set_driver(*miibus, &miibus_driver);
517 bus_enumerate_hinted_children(*miibus);
518 rv = device_get_children(*miibus, &children, &nchildren);
521 free(children, M_TEMP);
522 if (nchildren == 0) {
526 rv = bus_generic_attach(dev);
530 /* Attaching of the PHY drivers is done in miibus_attach(). */
533 rv = bus_generic_attach(*miibus);
541 device_delete_child(dev, *miibus);
542 free(ivars, M_DEVBUF);
549 * Media changed; notify all PHYs.
552 mii_mediachg(struct mii_data *mii)
554 struct mii_softc *child;
555 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
558 mii->mii_media_status = 0;
559 mii->mii_media_active = IFM_NONE;
561 LIST_FOREACH(child, &mii->mii_phys, mii_list) {
563 * If the media indicates a different PHY instance,
566 if (IFM_INST(ife->ifm_media) != child->mii_inst) {
567 if ((child->mii_flags & MIIF_NOISOLATE) != 0) {
568 device_printf(child->mii_dev, "%s: "
569 "can't handle non-zero PHY instance %d\n",
570 __func__, child->mii_inst);
573 PHY_WRITE(child, MII_BMCR, PHY_READ(child, MII_BMCR) |
577 rv = PHY_SERVICE(child, mii, MII_MEDIACHG);
585 * Call the PHY tick routines, used during autonegotiation.
588 mii_tick(struct mii_data *mii)
590 struct mii_softc *child;
591 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
593 LIST_FOREACH(child, &mii->mii_phys, mii_list) {
595 * If this PHY instance isn't currently selected, just skip
598 if (IFM_INST(ife->ifm_media) != child->mii_inst)
600 (void)PHY_SERVICE(child, mii, MII_TICK);
605 * Get media status from PHYs.
608 mii_pollstat(struct mii_data *mii)
610 struct mii_softc *child;
611 struct ifmedia_entry *ife = mii->mii_media.ifm_cur;
613 mii->mii_media_status = 0;
614 mii->mii_media_active = IFM_NONE;
616 LIST_FOREACH(child, &mii->mii_phys, mii_list) {
618 * If we're not polling this PHY instance, just skip it.
620 if (IFM_INST(ife->ifm_media) != child->mii_inst)
622 (void)PHY_SERVICE(child, mii, MII_POLLSTAT);
627 mii_bitreverse(unsigned char x)
629 static unsigned const char nibbletab[16] = {
630 0, 8, 4, 12, 2, 10, 6, 14, 1, 9, 5, 13, 3, 11, 7, 15
633 return ((nibbletab[x & 15] << 4) | nibbletab[x >> 4]);
637 mii_oui(u_int id1, u_int id2)
641 h = (id1 << 6) | (id2 >> 10);
643 return ((mii_bitreverse(h >> 16) << 16) |
644 (mii_bitreverse((h >> 8) & 0xff) << 8) |
645 mii_bitreverse(h & 0xff));
649 mii_phy_mac_match(struct mii_softc *mii, const char *name)
652 return (strcmp(device_get_name(device_get_parent(mii->mii_dev)),
657 mii_dev_mac_match(device_t parent, const char *name)
660 return (strcmp(device_get_name(device_get_parent(
661 device_get_parent(parent))), name) == 0);
665 mii_phy_mac_softc(struct mii_softc *mii)
668 return (device_get_softc(device_get_parent(mii->mii_dev)));
672 mii_dev_mac_softc(device_t parent)
675 return (device_get_softc(device_get_parent(device_get_parent(parent))));