2 * Copyright (c) 2010-2011 Juli Mallett <jmallett@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * Cavium Octeon management port Ethernet devices.
35 #include <sys/param.h>
36 #include <sys/systm.h>
38 #include <sys/endian.h>
39 #include <sys/kernel.h>
42 #include <sys/module.h>
43 #include <sys/mutex.h>
45 #include <sys/socket.h>
46 #include <sys/sockio.h>
47 #include <sys/sysctl.h>
50 #include <net/ethernet.h>
52 #include <net/if_dl.h>
53 #include <net/if_media.h>
54 #include <net/if_types.h>
55 #include <net/if_var.h>
56 #include <net/if_vlan_var.h>
59 #include <netinet/in.h>
60 #include <netinet/if_ether.h>
63 #include <contrib/octeon-sdk/cvmx.h>
64 #include <mips/cavium/octeon_irq.h>
65 #include <contrib/octeon-sdk/cvmx-mgmt-port.h>
72 struct ifmedia sc_ifmedia;
73 struct resource *sc_intr;
77 static void octm_identify(driver_t *, device_t);
78 static int octm_probe(device_t);
79 static int octm_attach(device_t);
80 static int octm_detach(device_t);
81 static int octm_shutdown(device_t);
83 static void octm_init(void *);
84 static int octm_transmit(struct ifnet *, struct mbuf *);
86 static int octm_medchange(struct ifnet *);
87 static void octm_medstat(struct ifnet *, struct ifmediareq *);
89 static int octm_ioctl(struct ifnet *, u_long, caddr_t);
91 static void octm_rx_intr(void *);
93 static device_method_t octm_methods[] = {
94 /* Device interface */
95 DEVMETHOD(device_identify, octm_identify),
96 DEVMETHOD(device_probe, octm_probe),
97 DEVMETHOD(device_attach, octm_attach),
98 DEVMETHOD(device_detach, octm_detach),
99 DEVMETHOD(device_shutdown, octm_shutdown),
104 static driver_t octm_driver = {
107 sizeof (struct octm_softc),
110 static devclass_t octm_devclass;
112 DRIVER_MODULE(octm, ciu, octm_driver, octm_devclass, 0, 0);
115 octm_identify(driver_t *drv, device_t parent)
119 if (!octeon_has_feature(OCTEON_FEATURE_MGMT_PORT))
122 for (i = 0; i < CVMX_MGMT_PORT_NUM_PORTS; i++)
123 BUS_ADD_CHILD(parent, 0, "octm", i);
127 octm_probe(device_t dev)
129 cvmx_mgmt_port_result_t result;
131 result = cvmx_mgmt_port_initialize(device_get_unit(dev));
133 case CVMX_MGMT_PORT_SUCCESS:
135 case CVMX_MGMT_PORT_NO_MEMORY:
137 case CVMX_MGMT_PORT_INVALID_PARAM:
139 case CVMX_MGMT_PORT_INIT_ERROR:
143 device_set_desc(dev, "Cavium Octeon Management Ethernet");
149 octm_attach(device_t dev)
152 struct octm_softc *sc;
153 cvmx_mixx_irhwm_t mixx_irhwm;
154 cvmx_mixx_intena_t mixx_intena;
160 sc = device_get_softc(dev);
162 sc->sc_port = device_get_unit(dev);
164 switch (sc->sc_port) {
166 irq = OCTEON_IRQ_MII;
169 irq = OCTEON_IRQ_MII1;
172 device_printf(dev, "unsupported management port %u.\n", sc->sc_port);
177 * Set MAC address for this management port.
180 memcpy((u_int8_t *)&mac + 2, cvmx_sysinfo_get()->mac_addr_base, 6);
183 cvmx_mgmt_port_set_mac(sc->sc_port, mac);
185 /* No watermark for input ring. */
187 cvmx_write_csr(CVMX_MIXX_IRHWM(sc->sc_port), mixx_irhwm.u64);
189 /* Enable input ring interrupts. */
191 mixx_intena.s.ithena = 1;
192 cvmx_write_csr(CVMX_MIXX_INTENA(sc->sc_port), mixx_intena.u64);
194 /* Allocate and establish interrupt. */
196 sc->sc_intr = bus_alloc_resource(sc->sc_dev, SYS_RES_IRQ, &rid,
197 irq, irq, 1, RF_ACTIVE);
198 if (sc->sc_intr == NULL) {
199 device_printf(dev, "unable to allocate IRQ.\n");
203 error = bus_setup_intr(sc->sc_dev, sc->sc_intr, INTR_TYPE_NET, NULL,
204 octm_rx_intr, sc, &sc->sc_intr_cookie);
206 device_printf(dev, "unable to setup interrupt.\n");
207 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->sc_intr);
211 bus_describe_intr(sc->sc_dev, sc->sc_intr, sc->sc_intr_cookie, "rx");
213 /* XXX Possibly should enable TX interrupts. */
215 ifp = if_alloc(IFT_ETHER);
217 device_printf(dev, "cannot allocate ifnet.\n");
218 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->sc_intr);
222 if_initname(ifp, device_get_name(dev), device_get_unit(dev));
223 ifp->if_mtu = ETHERMTU;
224 ifp->if_init = octm_init;
226 ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST | IFF_ALLMULTI;
227 ifp->if_ioctl = octm_ioctl;
230 sc->sc_flags = ifp->if_flags;
232 ifmedia_init(&sc->sc_ifmedia, 0, octm_medchange, octm_medstat);
234 ifmedia_add(&sc->sc_ifmedia, IFM_ETHER | IFM_AUTO, 0, NULL);
235 ifmedia_set(&sc->sc_ifmedia, IFM_ETHER | IFM_AUTO);
237 ether_ifattach(ifp, (const u_int8_t *)&mac + 2);
239 ifp->if_transmit = octm_transmit;
241 ifp->if_hdrlen = sizeof(struct ether_vlan_header);
242 ifp->if_capabilities = IFCAP_VLAN_MTU;
243 ifp->if_capenable = ifp->if_capabilities;
245 IFQ_SET_MAXLEN(&ifp->if_snd, CVMX_MGMT_PORT_NUM_TX_BUFFERS);
246 ifp->if_snd.ifq_drv_maxlen = CVMX_MGMT_PORT_NUM_TX_BUFFERS;
247 IFQ_SET_READY(&ifp->if_snd);
249 return (bus_generic_attach(dev));
253 octm_detach(device_t dev)
255 struct octm_softc *sc;
256 cvmx_mgmt_port_result_t result;
258 sc = device_get_softc(dev);
260 result = cvmx_mgmt_port_initialize(sc->sc_port);
262 case CVMX_MGMT_PORT_SUCCESS:
264 case CVMX_MGMT_PORT_NO_MEMORY:
266 case CVMX_MGMT_PORT_INVALID_PARAM:
268 case CVMX_MGMT_PORT_INIT_ERROR:
272 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->sc_intr);
273 /* XXX Incomplete. */
279 octm_shutdown(device_t dev)
281 return (octm_detach(dev));
288 struct octm_softc *sc;
289 cvmx_mgmt_port_netdevice_flags_t flags;
295 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) != 0) {
296 cvmx_mgmt_port_disable(sc->sc_port);
298 ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
303 * MAC must be set before allmulti and promisc below, as
304 * cvmx_mgmt_port_set_mac will always enable the CAM, and turning on
305 * promiscuous mode only works with the CAM disabled.
308 memcpy((u_int8_t *)&mac + 2, IF_LLADDR(ifp), 6);
309 cvmx_mgmt_port_set_mac(sc->sc_port, mac);
312 * This is done unconditionally, rather than only if sc_flags have
313 * changed because of set_mac's effect on the CAM noted above.
316 if ((ifp->if_flags & IFF_ALLMULTI) != 0)
317 flags |= CVMX_IFF_ALLMULTI;
318 if ((ifp->if_flags & IFF_PROMISC) != 0)
319 flags |= CVMX_IFF_PROMISC;
320 cvmx_mgmt_port_set_multicast_list(sc->sc_port, flags);
322 /* XXX link state? */
324 if ((ifp->if_flags & IFF_UP) != 0)
325 cvmx_mgmt_port_enable(sc->sc_port);
327 ifp->if_drv_flags |= IFF_DRV_RUNNING;
328 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
332 octm_transmit(struct ifnet *ifp, struct mbuf *m)
334 struct octm_softc *sc;
335 cvmx_mgmt_port_result_t result;
339 if ((ifp->if_drv_flags & (IFF_DRV_RUNNING | IFF_DRV_OACTIVE)) !=
345 result = cvmx_mgmt_port_sendm(sc->sc_port, m);
347 if (result == CVMX_MGMT_PORT_SUCCESS) {
348 ETHER_BPF_MTAP(ifp, m);
350 if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1);
351 if_inc_counter(ifp, IFCOUNTER_OBYTES, m->m_pkthdr.len);
353 if_inc_counter(ifp, IFCOUNTER_OERRORS, 1);
358 case CVMX_MGMT_PORT_SUCCESS:
360 case CVMX_MGMT_PORT_NO_MEMORY:
362 case CVMX_MGMT_PORT_INVALID_PARAM:
364 case CVMX_MGMT_PORT_INIT_ERROR:
372 octm_medchange(struct ifnet *ifp)
378 octm_medstat(struct ifnet *ifp, struct ifmediareq *ifm)
380 struct octm_softc *sc;
381 cvmx_helper_link_info_t link_info;
385 ifm->ifm_status = IFM_AVALID;
386 ifm->ifm_active = IFT_ETHER;
388 link_info = cvmx_mgmt_port_link_get(sc->sc_port);
389 if (!link_info.s.link_up)
392 ifm->ifm_status |= IFM_ACTIVE;
394 switch (link_info.s.speed) {
396 ifm->ifm_active |= IFM_10_T;
399 ifm->ifm_active |= IFM_100_TX;
402 ifm->ifm_active |= IFM_1000_T;
405 ifm->ifm_active |= IFM_10G_T;
409 if (link_info.s.full_duplex)
410 ifm->ifm_active |= IFM_FDX;
412 ifm->ifm_active |= IFM_HDX;
416 octm_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
418 struct octm_softc *sc;
426 ifr = (struct ifreq *)data;
428 ifa = (struct ifaddr *)data;
435 * Avoid reinitialization unless it's necessary.
437 if (ifa->ifa_addr->sa_family == AF_INET) {
438 ifp->if_flags |= IFF_UP;
439 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
441 arp_ifinit(ifp, ifa);
446 error = ether_ioctl(ifp, cmd, data);
452 if (ifp->if_flags == sc->sc_flags)
454 if ((ifp->if_flags & IFF_UP) != 0) {
457 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) != 0) {
458 cvmx_mgmt_port_disable(sc->sc_port);
460 ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
463 sc->sc_flags = ifp->if_flags;
468 * Just change the capabilities in software, currently none
469 * require reprogramming hardware, they just toggle whether we
470 * make use of already-present facilities in software.
472 ifp->if_capenable = ifr->ifr_reqcap;
476 cvmx_mgmt_port_set_max_packet_size(sc->sc_port, ifr->ifr_mtu + ifp->if_hdrlen);
481 error = ifmedia_ioctl(ifp, ifr, &sc->sc_ifmedia, cmd);
487 error = ether_ioctl(ifp, cmd, data);
495 octm_rx_intr(void *arg)
497 struct octm_softc *sc = arg;
498 cvmx_mixx_isr_t mixx_isr;
501 mixx_isr.u64 = cvmx_read_csr(CVMX_MIXX_ISR(sc->sc_port));
502 if (!mixx_isr.s.irthresh) {
503 device_printf(sc->sc_dev, "stray interrupt.\n");
508 struct mbuf *m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
510 device_printf(sc->sc_dev, "no memory for receive mbuf.\n");
515 len = cvmx_mgmt_port_receive(sc->sc_port, MCLBYTES, m->m_data);
517 m->m_pkthdr.rcvif = sc->sc_ifp;
518 m->m_pkthdr.len = m->m_len = len;
520 if_inc_counter(sc->sc_ifp, IFCOUNTER_IPACKETS, 1);
522 (*sc->sc_ifp->if_input)(sc->sc_ifp, m);
532 if_inc_counter(sc->sc_ifp, IFCOUNTER_IERRORS, 1);
535 /* Acknowledge interrupts. */
536 cvmx_write_csr(CVMX_MIXX_ISR(sc->sc_port), mixx_isr.u64);
537 cvmx_read_csr(CVMX_MIXX_ISR(sc->sc_port));