2 * Copyright (c) 2013 Luiz Otavio O Souza.
3 * Copyright (c) 2011-2012 Stefan Bethke.
4 * Copyright (c) 2012 Adrian Chadd.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #include <sys/param.h>
33 #include <sys/errno.h>
34 #include <sys/kernel.h>
36 #include <sys/malloc.h>
37 #include <sys/module.h>
38 #include <sys/mutex.h>
39 #include <sys/socket.h>
40 #include <sys/sockio.h>
41 #include <sys/sysctl.h>
42 #include <sys/systm.h>
43 #include <sys/types.h>
46 #include <net/ethernet.h>
47 #include <net/if_media.h>
48 #include <net/if_types.h>
49 #include <net/if_var.h>
51 #include <machine/bus.h>
52 #include <dev/mii/mii.h>
53 #include <dev/mii/miivar.h>
54 #include <dev/etherswitch/mdio.h>
56 #include <dev/etherswitch/etherswitch.h>
57 #include <dev/etherswitch/ip17x/ip17x_phy.h>
58 #include <dev/etherswitch/ip17x/ip17x_reg.h>
59 #include <dev/etherswitch/ip17x/ip17x_var.h>
60 #include <dev/etherswitch/ip17x/ip17x_vlans.h>
61 #include <dev/etherswitch/ip17x/ip175c.h>
62 #include <dev/etherswitch/ip17x/ip175d.h>
65 #include "miibus_if.h"
66 #include "etherswitch_if.h"
68 MALLOC_DECLARE(M_IP17X);
69 MALLOC_DEFINE(M_IP17X, "ip17x", "ip17x data structures");
71 static void ip17x_tick(void *);
72 static int ip17x_ifmedia_upd(struct ifnet *);
73 static void ip17x_ifmedia_sts(struct ifnet *, struct ifmediareq *);
76 ip17x_probe(device_t dev)
78 struct ip17x_softc *sc;
79 uint32_t oui, model, phy_id1, phy_id2;
81 sc = device_get_softc(dev);
83 /* Read ID from PHY 0. */
84 phy_id1 = MDIO_READREG(device_get_parent(dev), 0, MII_PHYIDR1);
85 phy_id2 = MDIO_READREG(device_get_parent(dev), 0, MII_PHYIDR2);
87 oui = MII_OUI(phy_id1, phy_id2),
88 model = MII_MODEL(phy_id2);
89 /* We only care about IC+ devices. */
90 if (oui != IP17X_OUI) {
92 "Unsupported IC+ switch. Unknown OUI: %#x\n", oui);
98 sc->sc_switchtype = IP17X_SWITCH_IP175A;
101 sc->sc_switchtype = IP17X_SWITCH_IP175C;
104 device_printf(dev, "Unsupported IC+ switch model: %#x\n",
109 /* IP175D has a specific ID register. */
110 model = MDIO_READREG(device_get_parent(dev), IP175D_ID_PHY,
113 sc->sc_switchtype = IP17X_SWITCH_IP175D;
115 /* IP178 has more PHYs. Try it. */
116 model = MDIO_READREG(device_get_parent(dev), 5, MII_PHYIDR1);
117 if (phy_id1 == model)
118 sc->sc_switchtype = IP17X_SWITCH_IP178C;
121 device_set_desc_copy(dev, "IC+ IP17x switch driver");
122 return (BUS_PROBE_DEFAULT);
126 ip17x_attach_phys(struct ip17x_softc *sc)
133 /* PHYs need an interface, so we generate a dummy one */
134 snprintf(name, IFNAMSIZ, "%sport", device_get_nameunit(sc->sc_dev));
135 for (phy = 0; phy < MII_NPHY; phy++) {
136 if (((1 << phy) & sc->phymask) == 0)
138 sc->phyport[phy] = port;
139 sc->portphy[port] = phy;
140 sc->ifp[port] = if_alloc(IFT_ETHER);
141 sc->ifp[port]->if_softc = sc;
142 sc->ifp[port]->if_flags |= IFF_UP | IFF_BROADCAST |
143 IFF_DRV_RUNNING | IFF_SIMPLEX;
144 sc->ifname[port] = malloc(strlen(name)+1, M_IP17X, M_WAITOK);
145 bcopy(name, sc->ifname[port], strlen(name)+1);
146 if_initname(sc->ifp[port], sc->ifname[port], port);
147 sc->miibus[port] = malloc(sizeof(device_t), M_IP17X,
149 err = mii_attach(sc->sc_dev, sc->miibus[port], sc->ifp[port],
150 ip17x_ifmedia_upd, ip17x_ifmedia_sts, \
151 BMSR_DEFCAPMASK, phy, MII_OFFSET_ANY, 0);
152 DPRINTF(sc->sc_dev, "%s attached to pseudo interface %s\n",
153 device_get_nameunit(*sc->miibus[port]),
154 sc->ifp[port]->if_xname);
156 device_printf(sc->sc_dev,
157 "attaching PHY %d failed\n",
161 sc->info.es_nports = port + 1;
162 if (++port >= sc->numports)
169 ip17x_attach(device_t dev)
171 struct ip17x_softc *sc;
174 sc = device_get_softc(dev);
177 mtx_init(&sc->sc_mtx, "ip17x", NULL, MTX_DEF);
178 strlcpy(sc->info.es_name, device_get_desc(dev),
179 sizeof(sc->info.es_name));
185 (void) resource_int_value(device_get_name(dev), device_get_unit(dev),
186 "phymask", &sc->phymask);
188 /* Number of vlans supported by the switch. */
189 sc->info.es_nvlangroups = IP17X_MAX_VLANS;
191 /* Attach the switch related functions. */
192 if (IP17X_IS_SWITCH(sc, IP175C))
194 else if (IP17X_IS_SWITCH(sc, IP175D))
197 /* We don't have support to all the models yet :-/ */
200 /* Always attach the cpu port. */
201 sc->phymask |= (1 << sc->cpuport);
203 sc->ifp = malloc(sizeof(struct ifnet *) * sc->numports, M_IP17X,
205 sc->pvid = malloc(sizeof(uint32_t) * sc->numports, M_IP17X,
207 sc->ifname = malloc(sizeof(char *) * sc->numports, M_IP17X,
209 sc->miibus = malloc(sizeof(device_t *) * sc->numports, M_IP17X,
211 sc->portphy = malloc(sizeof(int) * sc->numports, M_IP17X,
214 /* Initialize the switch. */
215 sc->hal.ip17x_reset(sc);
218 * Attach the PHYs and complete the bus enumeration.
220 err = ip17x_attach_phys(sc);
225 * Set the switch to port based vlans or disabled (if not supported
228 sc->hal.ip17x_set_vlan_mode(sc, ETHERSWITCH_VLAN_PORT);
230 bus_generic_probe(dev);
231 bus_enumerate_hinted_children(dev);
232 err = bus_generic_attach(dev);
236 callout_init(&sc->callout_tick, 0);
244 ip17x_detach(device_t dev)
246 struct ip17x_softc *sc;
249 sc = device_get_softc(dev);
250 callout_drain(&sc->callout_tick);
252 for (i=0; i < MII_NPHY; i++) {
253 if (((1 << i) & sc->phymask) == 0)
255 port = sc->phyport[i];
256 if (sc->miibus[port] != NULL)
257 device_delete_child(dev, (*sc->miibus[port]));
258 if (sc->ifp[port] != NULL)
259 if_free(sc->ifp[port]);
260 free(sc->ifname[port], M_IP17X);
261 free(sc->miibus[port], M_IP17X);
264 free(sc->portphy, M_IP17X);
265 free(sc->miibus, M_IP17X);
266 free(sc->ifname, M_IP17X);
267 free(sc->pvid, M_IP17X);
268 free(sc->ifp, M_IP17X);
270 /* Reset the switch. */
271 sc->hal.ip17x_reset(sc);
273 bus_generic_detach(dev);
274 mtx_destroy(&sc->sc_mtx);
279 static inline struct mii_data *
280 ip17x_miiforport(struct ip17x_softc *sc, int port)
283 if (port < 0 || port > sc->numports)
285 return (device_get_softc(*sc->miibus[port]));
288 static inline struct ifnet *
289 ip17x_ifpforport(struct ip17x_softc *sc, int port)
292 if (port < 0 || port > sc->numports)
294 return (sc->ifp[port]);
298 * Poll the status for all PHYs.
301 ip17x_miipollstat(struct ip17x_softc *sc)
303 struct mii_softc *miisc;
304 struct mii_data *mii;
307 IP17X_LOCK_ASSERT(sc, MA_NOTOWNED);
309 for (i = 0; i < MII_NPHY; i++) {
310 if (((1 << i) & sc->phymask) == 0)
312 port = sc->phyport[i];
313 if ((*sc->miibus[port]) == NULL)
315 mii = device_get_softc(*sc->miibus[port]);
316 LIST_FOREACH(miisc, &mii->mii_phys, mii_list) {
317 if (IFM_INST(mii->mii_media.ifm_cur->ifm_media) !=
321 mii_phy_update(miisc, MII_POLLSTAT);
327 ip17x_tick(void *arg)
329 struct ip17x_softc *sc;
332 ip17x_miipollstat(sc);
333 callout_reset(&sc->callout_tick, hz, ip17x_tick, sc);
337 ip17x_lock(device_t dev)
339 struct ip17x_softc *sc;
341 sc = device_get_softc(dev);
342 IP17X_LOCK_ASSERT(sc, MA_NOTOWNED);
347 ip17x_unlock(device_t dev)
349 struct ip17x_softc *sc;
351 sc = device_get_softc(dev);
352 IP17X_LOCK_ASSERT(sc, MA_OWNED);
356 static etherswitch_info_t *
357 ip17x_getinfo(device_t dev)
359 struct ip17x_softc *sc;
361 sc = device_get_softc(dev);
366 ip17x_getport(device_t dev, etherswitch_port_t *p)
368 struct ip17x_softc *sc;
369 struct ifmediareq *ifmr;
370 struct mii_data *mii;
373 sc = device_get_softc(dev);
374 if (p->es_port < 0 || p->es_port >= sc->numports)
377 phy = sc->portphy[p->es_port];
379 /* Retrieve the PVID. */
380 p->es_pvid = sc->pvid[phy];
383 if (sc->addtag & (1 << phy))
384 p->es_flags |= ETHERSWITCH_PORT_ADDTAG;
385 if (sc->striptag & (1 << phy))
386 p->es_flags |= ETHERSWITCH_PORT_STRIPTAG;
390 /* No media settings ? */
391 if (p->es_ifmr.ifm_count == 0)
394 mii = ip17x_miiforport(sc, p->es_port);
397 if (phy == sc->cpuport) {
398 /* fill in fixed values for CPU port */
399 p->es_flags |= ETHERSWITCH_PORT_CPU;
401 if (sc->media == 100)
402 ifmr->ifm_current = ifmr->ifm_active =
403 IFM_ETHER | IFM_100_TX | IFM_FDX;
405 ifmr->ifm_current = ifmr->ifm_active =
406 IFM_ETHER | IFM_1000_T | IFM_FDX;
408 ifmr->ifm_status = IFM_ACTIVE | IFM_AVALID;
410 err = ifmedia_ioctl(mii->mii_ifp, &p->es_ifr,
411 &mii->mii_media, SIOCGIFMEDIA);
419 ip17x_setport(device_t dev, etherswitch_port_t *p)
421 struct ip17x_softc *sc;
424 struct mii_data *mii;
427 sc = device_get_softc(dev);
428 if (p->es_port < 0 || p->es_port >= sc->numports)
431 phy = sc->portphy[p->es_port];
432 ifp = ip17x_ifpforport(sc, p->es_port);
433 mii = ip17x_miiforport(sc, p->es_port);
434 if (ifp == NULL || mii == NULL)
438 if (sc->vlan_mode == ETHERSWITCH_VLAN_DOT1Q) {
441 if (p->es_pvid != 0) {
442 if (IP17X_IS_SWITCH(sc, IP175C) &&
443 p->es_pvid > IP175C_LAST_VLAN)
445 sc->pvid[phy] = p->es_pvid;
448 /* Mutually exclusive. */
449 if (p->es_flags & ETHERSWITCH_PORT_ADDTAG &&
450 p->es_flags & ETHERSWITCH_PORT_STRIPTAG)
453 /* Reset the settings for this port. */
454 sc->addtag &= ~(1 << phy);
455 sc->striptag &= ~(1 << phy);
457 /* And then set it to the new value. */
458 if (p->es_flags & ETHERSWITCH_PORT_ADDTAG)
459 sc->addtag |= (1 << phy);
460 if (p->es_flags & ETHERSWITCH_PORT_STRIPTAG)
461 sc->striptag |= (1 << phy);
464 /* Update the switch configuration. */
465 if (sc->hal.ip17x_hw_setup(sc))
468 /* Do not allow media changes on CPU port. */
469 if (phy == sc->cpuport)
472 /* No media settings ? */
473 if (p->es_ifmr.ifm_count == 0)
476 ifm = &mii->mii_media;
477 return (ifmedia_ioctl(ifp, &p->es_ifr, ifm, SIOCSIFMEDIA));
481 ip17x_statchg(device_t dev)
484 DPRINTF(dev, "%s\n", __func__);
488 ip17x_ifmedia_upd(struct ifnet *ifp)
490 struct ip17x_softc *sc;
491 struct mii_data *mii;
493 DPRINTF(sc->sc_dev, "%s\n", __func__);
495 mii = ip17x_miiforport(sc, ifp->if_dunit);
503 ip17x_ifmedia_sts(struct ifnet *ifp, struct ifmediareq *ifmr)
505 struct ip17x_softc *sc;
506 struct mii_data *mii;
508 DPRINTF(sc->sc_dev, "%s\n", __func__);
511 mii = ip17x_miiforport(sc, ifp->if_dunit);
515 ifmr->ifm_active = mii->mii_media_active;
516 ifmr->ifm_status = mii->mii_media_status;
520 ip17x_readreg(device_t dev, int addr)
522 struct ip17x_softc *sc;
524 sc = device_get_softc(dev);
525 IP17X_LOCK_ASSERT(sc, MA_OWNED);
532 ip17x_writereg(device_t dev, int addr, int value)
534 struct ip17x_softc *sc;
536 sc = device_get_softc(dev);
537 IP17X_LOCK_ASSERT(sc, MA_OWNED);
544 ip17x_getconf(device_t dev, etherswitch_conf_t *conf)
546 struct ip17x_softc *sc;
548 sc = device_get_softc(dev);
550 /* Return the VLAN mode. */
551 conf->cmd = ETHERSWITCH_CONF_VLAN_MODE;
552 conf->vlan_mode = sc->hal.ip17x_get_vlan_mode(sc);
558 ip17x_setconf(device_t dev, etherswitch_conf_t *conf)
560 struct ip17x_softc *sc;
562 sc = device_get_softc(dev);
564 /* Set the VLAN mode. */
565 if (conf->cmd & ETHERSWITCH_CONF_VLAN_MODE)
566 sc->hal.ip17x_set_vlan_mode(sc, conf->vlan_mode);
571 static device_method_t ip17x_methods[] = {
572 /* Device interface */
573 DEVMETHOD(device_probe, ip17x_probe),
574 DEVMETHOD(device_attach, ip17x_attach),
575 DEVMETHOD(device_detach, ip17x_detach),
578 DEVMETHOD(bus_add_child, device_add_child_ordered),
581 DEVMETHOD(miibus_readreg, ip17x_readphy),
582 DEVMETHOD(miibus_writereg, ip17x_writephy),
583 DEVMETHOD(miibus_statchg, ip17x_statchg),
586 DEVMETHOD(mdio_readreg, ip17x_readphy),
587 DEVMETHOD(mdio_writereg, ip17x_writephy),
589 /* etherswitch interface */
590 DEVMETHOD(etherswitch_lock, ip17x_lock),
591 DEVMETHOD(etherswitch_unlock, ip17x_unlock),
592 DEVMETHOD(etherswitch_getinfo, ip17x_getinfo),
593 DEVMETHOD(etherswitch_readreg, ip17x_readreg),
594 DEVMETHOD(etherswitch_writereg, ip17x_writereg),
595 DEVMETHOD(etherswitch_readphyreg, ip17x_readphy),
596 DEVMETHOD(etherswitch_writephyreg, ip17x_writephy),
597 DEVMETHOD(etherswitch_getport, ip17x_getport),
598 DEVMETHOD(etherswitch_setport, ip17x_setport),
599 DEVMETHOD(etherswitch_getvgroup, ip17x_getvgroup),
600 DEVMETHOD(etherswitch_setvgroup, ip17x_setvgroup),
601 DEVMETHOD(etherswitch_getconf, ip17x_getconf),
602 DEVMETHOD(etherswitch_setconf, ip17x_setconf),
607 DEFINE_CLASS_0(ip17x, ip17x_driver, ip17x_methods,
608 sizeof(struct ip17x_softc));
609 static devclass_t ip17x_devclass;
611 DRIVER_MODULE(ip17x, mdio, ip17x_driver, ip17x_devclass, 0, 0);
612 DRIVER_MODULE(miibus, ip17x, miibus_driver, miibus_devclass, 0, 0);
613 DRIVER_MODULE(mdio, ip17x, mdio_driver, mdio_devclass, 0, 0);
614 DRIVER_MODULE(etherswitch, ip17x, etherswitch_driver, etherswitch_devclass, 0, 0);
615 MODULE_VERSION(ip17x, 1);
616 MODULE_DEPEND(ip17x, miibus, 1, 1, 1); /* XXX which versions? */
617 MODULE_DEPEND(ip17x, etherswitch, 1, 1, 1); /* XXX which versions? */