2 * SPDX-License-Identifier: BSD-4-Clause
4 * Copyright (c) 2002-2003
5 * Hidetoshi Shimokawa. All rights reserved.
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.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
18 * This product includes software developed by Hidetoshi Shimokawa.
20 * 4. Neither the name of the author nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 #ifdef HAVE_KERNEL_OPTION_HEADERS
40 #include "opt_device_polling.h"
44 #include <sys/param.h>
45 #include <sys/kernel.h>
46 #include <sys/malloc.h>
48 #include <sys/socket.h>
49 #include <sys/sockio.h>
50 #include <sys/sysctl.h>
51 #include <sys/systm.h>
52 #include <sys/module.h>
54 #include <machine/bus.h>
57 #include <net/ethernet.h>
59 #include <net/if_var.h>
60 #include <net/if_arp.h>
61 #include <net/if_types.h>
62 #include <net/if_vlan_var.h>
64 #include <dev/firewire/firewire.h>
65 #include <dev/firewire/firewirereg.h>
66 #include <dev/firewire/if_fwevar.h>
68 #define FWEDEBUG if (fwedebug) if_printf
69 #define TX_MAX_QUEUE (FWMAXQUEUE - 1)
71 /* network interface */
72 static void fwe_start (struct ifnet *);
73 static int fwe_ioctl (struct ifnet *, u_long, caddr_t);
74 static void fwe_init (void *);
76 static void fwe_output_callback (struct fw_xfer *);
77 static void fwe_as_output (struct fwe_softc *, struct ifnet *);
78 static void fwe_as_input (struct fw_xferq *);
80 static int fwedebug = 0;
81 static int stream_ch = 1;
82 static int tx_speed = 2;
83 static int rx_queue_len = FWMAXQUEUE;
85 static MALLOC_DEFINE(M_FWE, "if_fwe", "Ethernet over FireWire interface");
86 SYSCTL_INT(_debug, OID_AUTO, if_fwe_debug, CTLFLAG_RWTUN, &fwedebug, 0, "");
87 SYSCTL_DECL(_hw_firewire);
88 static SYSCTL_NODE(_hw_firewire, OID_AUTO, fwe, CTLFLAG_RD, 0,
89 "Ethernet emulation subsystem");
90 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, stream_ch, CTLFLAG_RWTUN, &stream_ch, 0,
91 "Stream channel to use");
92 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, tx_speed, CTLFLAG_RWTUN, &tx_speed, 0,
93 "Transmission speed");
94 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, rx_queue_len, CTLFLAG_RWTUN, &rx_queue_len,
95 0, "Length of the receive queue");
98 static poll_handler_t fwe_poll;
101 fwe_poll(struct ifnet *ifp, enum poll_cmd cmd, int count)
103 struct fwe_softc *fwe;
104 struct firewire_comm *fc;
106 if (!(ifp->if_drv_flags & IFF_DRV_RUNNING))
109 fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
111 fc->poll(fc, (cmd == POLL_AND_CHECK_STATUS)?0:1, count);
114 #endif /* DEVICE_POLLING */
117 fwe_identify(driver_t *driver, device_t parent)
119 BUS_ADD_CHILD(parent, 0, "fwe", device_get_unit(parent));
123 fwe_probe(device_t dev)
127 pa = device_get_parent(dev);
128 if (device_get_unit(dev) != device_get_unit(pa)) {
132 device_set_desc(dev, "Ethernet over FireWire");
137 fwe_attach(device_t dev)
139 struct fwe_softc *fwe;
143 struct fw_eui64 *eui;
145 fwe = ((struct fwe_softc *)device_get_softc(dev));
146 unit = device_get_unit(dev);
148 bzero(fwe, sizeof(struct fwe_softc));
149 mtx_init(&fwe->mtx, "fwe", NULL, MTX_DEF);
151 fwe->stream_ch = stream_ch;
154 fwe->fd.fc = device_get_ivars(dev);
156 tx_speed = fwe->fd.fc->speed;
159 fwe->fd.post_explore = NULL;
160 fwe->eth_softc.fwe = fwe;
162 fwe->pkt_hdr.mode.stream.tcode = FWTCODE_STREAM;
163 fwe->pkt_hdr.mode.stream.sy = 0;
164 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch;
166 /* generate fake MAC address: first and last 3bytes from eui64 */
170 eui = &fwe->fd.fc->eui;
171 eaddr[0] = (FW_EUI64_BYTE(eui, 0) | LOCAL) & ~GROUP;
172 eaddr[1] = FW_EUI64_BYTE(eui, 1);
173 eaddr[2] = FW_EUI64_BYTE(eui, 2);
174 eaddr[3] = FW_EUI64_BYTE(eui, 5);
175 eaddr[4] = FW_EUI64_BYTE(eui, 6);
176 eaddr[5] = FW_EUI64_BYTE(eui, 7);
177 printf("if_fwe%d: Fake Ethernet address: "
178 "%02x:%02x:%02x:%02x:%02x:%02x\n", unit,
179 eaddr[0], eaddr[1], eaddr[2], eaddr[3], eaddr[4], eaddr[5]);
181 /* fill the rest and attach interface */
182 ifp = fwe->eth_softc.ifp = if_alloc(IFT_ETHER);
184 device_printf(dev, "can not if_alloc()\n");
187 ifp->if_softc = &fwe->eth_softc;
189 if_initname(ifp, device_get_name(dev), unit);
190 ifp->if_init = fwe_init;
191 ifp->if_start = fwe_start;
192 ifp->if_ioctl = fwe_ioctl;
193 ifp->if_flags = (IFF_BROADCAST|IFF_SIMPLEX|IFF_MULTICAST);
194 ifp->if_snd.ifq_maxlen = TX_MAX_QUEUE;
197 ether_ifattach(ifp, eaddr);
200 /* Tell the upper layer(s) we support long frames. */
201 ifp->if_hdrlen = sizeof(struct ether_vlan_header);
202 ifp->if_capabilities |= IFCAP_VLAN_MTU | IFCAP_POLLING;
203 ifp->if_capenable |= IFCAP_VLAN_MTU;
205 FWEDEBUG(ifp, "interface created\n");
210 fwe_stop(struct fwe_softc *fwe)
212 struct firewire_comm *fc;
213 struct fw_xferq *xferq;
214 struct ifnet *ifp = fwe->eth_softc.ifp;
215 struct fw_xfer *xfer, *next;
220 if (fwe->dma_ch >= 0) {
221 xferq = fc->ir[fwe->dma_ch];
223 if (xferq->flag & FWXFERQ_RUNNING)
224 fc->irx_disable(fc, fwe->dma_ch);
226 ~(FWXFERQ_MODEMASK | FWXFERQ_OPEN | FWXFERQ_STREAM |
227 FWXFERQ_EXTBUF | FWXFERQ_HANDLER | FWXFERQ_CHTAGMASK);
230 for (i = 0; i < xferq->bnchunk; i++)
231 m_freem(xferq->bulkxfer[i].mbuf);
232 free(xferq->bulkxfer, M_FWE);
234 for (xfer = STAILQ_FIRST(&fwe->xferlist); xfer != NULL;
236 next = STAILQ_NEXT(xfer, link);
239 STAILQ_INIT(&fwe->xferlist);
241 xferq->bulkxfer = NULL;
245 ifp->if_drv_flags &= ~(IFF_DRV_RUNNING | IFF_DRV_OACTIVE);
249 fwe_detach(device_t dev)
251 struct fwe_softc *fwe;
255 fwe = device_get_softc(dev);
256 ifp = fwe->eth_softc.ifp;
258 #ifdef DEVICE_POLLING
259 if (ifp->if_capenable & IFCAP_POLLING)
260 ether_poll_deregister(ifp);
269 mtx_destroy(&fwe->mtx);
276 struct fwe_softc *fwe = ((struct fwe_eth_softc *)arg)->fwe;
277 struct firewire_comm *fc;
278 struct ifnet *ifp = fwe->eth_softc.ifp;
279 struct fw_xferq *xferq;
280 struct fw_xfer *xfer;
284 FWEDEBUG(ifp, "initializing\n");
286 /* XXX keep promiscoud mode */
287 ifp->if_flags |= IFF_PROMISC;
290 if (fwe->dma_ch < 0) {
291 fwe->dma_ch = fw_open_isodma(fc, /* tx */0);
294 xferq = fc->ir[fwe->dma_ch];
295 xferq->flag |= FWXFERQ_EXTBUF |
296 FWXFERQ_HANDLER | FWXFERQ_STREAM;
297 fwe->stream_ch = stream_ch;
298 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch;
299 xferq->flag &= ~0xff;
300 xferq->flag |= fwe->stream_ch & 0xff;
301 /* register fwe_input handler */
302 xferq->sc = (caddr_t) fwe;
303 xferq->hand = fwe_as_input;
304 xferq->bnchunk = rx_queue_len;
306 xferq->psize = MCLBYTES;
309 xferq->bulkxfer = (struct fw_bulkxfer *) malloc(
310 sizeof(struct fw_bulkxfer) * xferq->bnchunk,
312 STAILQ_INIT(&xferq->stvalid);
313 STAILQ_INIT(&xferq->stfree);
314 STAILQ_INIT(&xferq->stdma);
315 xferq->stproc = NULL;
316 for (i = 0; i < xferq->bnchunk; i++) {
317 m = m_getcl(M_WAITOK, MT_DATA, M_PKTHDR);
318 xferq->bulkxfer[i].mbuf = m;
319 m->m_len = m->m_pkthdr.len = m->m_ext.ext_size;
320 STAILQ_INSERT_TAIL(&xferq->stfree,
321 &xferq->bulkxfer[i], link);
323 STAILQ_INIT(&fwe->xferlist);
324 for (i = 0; i < TX_MAX_QUEUE; i++) {
325 xfer = fw_xfer_alloc(M_FWE);
328 xfer->send.spd = tx_speed;
329 xfer->fc = fwe->fd.fc;
330 xfer->sc = (caddr_t)fwe;
331 xfer->hand = fwe_output_callback;
332 STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link);
335 xferq = fc->ir[fwe->dma_ch];
339 if ((xferq->flag & FWXFERQ_RUNNING) == 0)
340 fc->irx_enable(fc, fwe->dma_ch);
342 ifp->if_drv_flags |= IFF_DRV_RUNNING;
343 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
346 /* attempt to start output */
353 fwe_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
355 struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
356 struct ifstat *ifs = NULL;
362 if (ifp->if_flags & IFF_UP) {
363 if (!(ifp->if_drv_flags & IFF_DRV_RUNNING))
364 fwe_init(&fwe->eth_softc);
366 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
369 /* XXX keep promiscoud mode */
370 ifp->if_flags |= IFF_PROMISC;
379 ifs = (struct ifstat *)data;
380 snprintf(ifs->ascii, sizeof(ifs->ascii),
381 "\tch %d dma %d\n", fwe->stream_ch, fwe->dma_ch);
385 #ifdef DEVICE_POLLING
387 struct ifreq *ifr = (struct ifreq *) data;
388 struct firewire_comm *fc = fwe->fd.fc;
390 if (ifr->ifr_reqcap & IFCAP_POLLING &&
391 !(ifp->if_capenable & IFCAP_POLLING)) {
392 error = ether_poll_register(fwe_poll, ifp);
395 /* Disable interrupts */
397 ifp->if_capenable |= IFCAP_POLLING;
400 if (!(ifr->ifr_reqcap & IFCAP_POLLING) &&
401 ifp->if_capenable & IFCAP_POLLING) {
402 error = ether_poll_deregister(ifp);
403 /* Enable interrupts. */
405 ifp->if_capenable &= ~IFCAP_POLLING;
409 #endif /* DEVICE_POLLING */
413 error = ether_ioctl(ifp, cmd, data);
422 fwe_output_callback(struct fw_xfer *xfer)
424 struct fwe_softc *fwe;
428 fwe = (struct fwe_softc *)xfer->sc;
429 ifp = fwe->eth_softc.ifp;
430 /* XXX error check */
431 FWEDEBUG(ifp, "resp = %d\n", xfer->resp);
433 if_inc_counter(ifp, IFCOUNTER_OERRORS, 1);
435 fw_xfer_unload(xfer);
439 STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link);
444 if (ifp->if_snd.ifq_head != NULL)
449 fwe_start(struct ifnet *ifp)
451 struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
454 FWEDEBUG(ifp, "starting\n");
456 if (fwe->dma_ch < 0) {
457 struct mbuf *m = NULL;
459 FWEDEBUG(ifp, "not ready\n");
463 IF_DEQUEUE(&ifp->if_snd, m);
466 if_inc_counter(ifp, IFCOUNTER_OERRORS, 1);
474 ifp->if_drv_flags |= IFF_DRV_OACTIVE;
476 if (ifp->if_snd.ifq_len != 0)
477 fwe_as_output(fwe, ifp);
479 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
485 #define ETHER_ALIGN 2
487 /* Async. stream output */
489 fwe_as_output(struct fwe_softc *fwe, struct ifnet *ifp)
492 struct fw_xfer *xfer;
493 struct fw_xferq *xferq;
498 xferq = fwe->fd.fc->atq;
499 while ((xferq->queued < xferq->maxq - 1) &&
500 (ifp->if_snd.ifq_head != NULL)) {
502 xfer = STAILQ_FIRST(&fwe->xferlist);
505 printf("if_fwe: lack of xfer\n");
510 STAILQ_REMOVE_HEAD(&fwe->xferlist, link);
513 IF_DEQUEUE(&ifp->if_snd, m);
516 STAILQ_INSERT_HEAD(&fwe->xferlist, xfer, link);
522 /* keep ip packet alignment for alpha */
523 M_PREPEND(m, ETHER_ALIGN, M_NOWAIT);
524 fp = &xfer->send.hdr;
525 *(uint32_t *)&xfer->send.hdr = *(int32_t *)&fwe->pkt_hdr;
526 fp->mode.stream.len = m->m_pkthdr.len;
528 xfer->send.pay_len = m->m_pkthdr.len;
530 if (fw_asyreq(fwe->fd.fc, -1, xfer) != 0) {
532 if_inc_counter(ifp, IFCOUNTER_OERRORS, 1);
533 /* XXX set error code */
534 fwe_output_callback(xfer);
536 if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1);
542 printf("%d queued\n", i);
545 xferq->start(fwe->fd.fc);
548 /* Async. stream output */
550 fwe_as_input(struct fw_xferq *xferq)
554 struct fwe_softc *fwe;
555 struct fw_bulkxfer *sxfer;
559 fwe = (struct fwe_softc *)xferq->sc;
560 ifp = fwe->eth_softc.ifp;
562 /* We do not need a lock here because the bottom half is serialized */
563 while ((sxfer = STAILQ_FIRST(&xferq->stvalid)) != NULL) {
564 STAILQ_REMOVE_HEAD(&xferq->stvalid, link);
565 fp = mtod(sxfer->mbuf, struct fw_pkt *);
566 if (fwe->fd.fc->irx_post != NULL)
567 fwe->fd.fc->irx_post(fwe->fd.fc, fp->mode.ld);
570 /* insert new rbuf */
571 sxfer->mbuf = m0 = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
573 m0->m_len = m0->m_pkthdr.len = m0->m_ext.ext_size;
574 STAILQ_INSERT_TAIL(&xferq->stfree, sxfer, link);
576 printf("%s: m_getcl failed\n", __FUNCTION__);
578 if (sxfer->resp != 0 || fp->mode.stream.len <
579 ETHER_ALIGN + sizeof(struct ether_header)) {
581 if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
585 m->m_data += HDR_LEN + ETHER_ALIGN;
586 c = mtod(m, u_char *);
587 m->m_len = m->m_pkthdr.len = fp->mode.stream.len - ETHER_ALIGN;
588 m->m_pkthdr.rcvif = ifp;
590 FWEDEBUG(ifp, "%02x %02x %02x %02x %02x %02x\n"
591 "%02x %02x %02x %02x %02x %02x\n"
592 "%02x %02x %02x %02x\n"
593 "%02x %02x %02x %02x\n"
594 "%02x %02x %02x %02x\n"
595 "%02x %02x %02x %02x\n",
596 c[0], c[1], c[2], c[3], c[4], c[5],
597 c[6], c[7], c[8], c[9], c[10], c[11],
598 c[12], c[13], c[14], c[15],
599 c[16], c[17], c[18], c[19],
600 c[20], c[21], c[22], c[23],
601 c[20], c[21], c[22], c[23]
604 (*ifp->if_input)(ifp, m);
605 if_inc_counter(ifp, IFCOUNTER_IPACKETS, 1);
607 if (STAILQ_FIRST(&xferq->stfree) != NULL)
608 fwe->fd.fc->irx_enable(fwe->fd.fc, fwe->dma_ch);
612 static devclass_t fwe_devclass;
614 static device_method_t fwe_methods[] = {
615 /* device interface */
616 DEVMETHOD(device_identify, fwe_identify),
617 DEVMETHOD(device_probe, fwe_probe),
618 DEVMETHOD(device_attach, fwe_attach),
619 DEVMETHOD(device_detach, fwe_detach),
623 static driver_t fwe_driver = {
626 sizeof(struct fwe_softc),
630 DRIVER_MODULE(fwe, firewire, fwe_driver, fwe_devclass, 0, 0);
631 MODULE_VERSION(fwe, 1);
632 MODULE_DEPEND(fwe, firewire, 1, 1, 1);