2 * Copyright (c) 2002-2003
3 * Hidetoshi Shimokawa. All rights reserved.
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.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
16 * This product includes software developed by Hidetoshi Shimokawa.
18 * 4. Neither the name of the author nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 #ifdef HAVE_KERNEL_OPTION_HEADERS
38 #include "opt_device_polling.h"
42 #include <sys/param.h>
43 #include <sys/kernel.h>
44 #include <sys/malloc.h>
46 #include <sys/socket.h>
47 #include <sys/sockio.h>
48 #include <sys/sysctl.h>
49 #include <sys/systm.h>
50 #include <sys/module.h>
52 #include <machine/bus.h>
55 #include <net/ethernet.h>
57 #include <net/if_arp.h>
58 #include <net/if_types.h>
60 #include <net/vlan/if_vlan_var.h>
61 #include <bus/firewire/firewire.h>
62 #include <bus/firewire/firewirereg.h>
63 #include "if_fwevar.h"
65 #include <net/if_vlan_var.h>
67 #include <dev/firewire/firewire.h>
68 #include <dev/firewire/firewirereg.h>
69 #include <dev/firewire/if_fwevar.h>
72 #define FWEDEBUG if (fwedebug) if_printf
73 #define TX_MAX_QUEUE (FWMAXQUEUE - 1)
75 /* network interface */
76 static void fwe_start (struct ifnet *);
77 static int fwe_ioctl (struct ifnet *, u_long, caddr_t);
78 static void fwe_init (void *);
80 static void fwe_output_callback (struct fw_xfer *);
81 static void fwe_as_output (struct fwe_softc *, struct ifnet *);
82 static void fwe_as_input (struct fw_xferq *);
84 static int fwedebug = 0;
85 static int stream_ch = 1;
86 static int tx_speed = 2;
87 static int rx_queue_len = FWMAXQUEUE;
89 MALLOC_DEFINE(M_FWE, "if_fwe", "Ethernet over FireWire interface");
90 SYSCTL_INT(_debug, OID_AUTO, if_fwe_debug, CTLFLAG_RW, &fwedebug, 0, "");
91 SYSCTL_DECL(_hw_firewire);
92 SYSCTL_NODE(_hw_firewire, OID_AUTO, fwe, CTLFLAG_RD, 0,
93 "Ethernet emulation subsystem");
94 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, stream_ch, CTLFLAG_RW, &stream_ch, 0,
95 "Stream channel to use");
96 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, tx_speed, CTLFLAG_RW, &tx_speed, 0,
97 "Transmission speed");
98 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, rx_queue_len, CTLFLAG_RW, &rx_queue_len,
99 0, "Length of the receive queue");
101 TUNABLE_INT("hw.firewire.fwe.stream_ch", &stream_ch);
102 TUNABLE_INT("hw.firewire.fwe.tx_speed", &tx_speed);
103 TUNABLE_INT("hw.firewire.fwe.rx_queue_len", &rx_queue_len);
105 #ifdef DEVICE_POLLING
106 static poll_handler_t fwe_poll;
109 fwe_poll(struct ifnet *ifp, enum poll_cmd cmd, int count)
111 struct fwe_softc *fwe;
112 struct firewire_comm *fc;
114 if (!(ifp->if_drv_flags & IFF_DRV_RUNNING))
117 fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
119 fc->poll(fc, (cmd == POLL_AND_CHECK_STATUS)?0:1, count);
121 #endif /* DEVICE_POLLING */
124 fwe_identify(driver_t *driver, device_t parent)
126 BUS_ADD_CHILD(parent, 0, "fwe", device_get_unit(parent));
130 fwe_probe(device_t dev)
134 pa = device_get_parent(dev);
135 if(device_get_unit(dev) != device_get_unit(pa)){
139 device_set_desc(dev, "Ethernet over FireWire");
144 fwe_attach(device_t dev)
146 struct fwe_softc *fwe;
149 #if defined(__DragonFly__) || __FreeBSD_version < 500000
154 struct fw_eui64 *eui;
156 fwe = ((struct fwe_softc *)device_get_softc(dev));
157 unit = device_get_unit(dev);
159 bzero(fwe, sizeof(struct fwe_softc));
160 mtx_init(&fwe->mtx, "fwe", NULL, MTX_DEF);
162 fwe->stream_ch = stream_ch;
165 fwe->fd.fc = device_get_ivars(dev);
167 tx_speed = fwe->fd.fc->speed;
170 fwe->fd.post_explore = NULL;
171 fwe->eth_softc.fwe = fwe;
173 fwe->pkt_hdr.mode.stream.tcode = FWTCODE_STREAM;
174 fwe->pkt_hdr.mode.stream.sy = 0;
175 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch;
177 /* generate fake MAC address: first and last 3bytes from eui64 */
180 #if defined(__DragonFly__) || __FreeBSD_version < 500000
181 eaddr = &IFP2ENADDR(fwe->eth_softc.ifp)[0];
185 eui = &fwe->fd.fc->eui;
186 eaddr[0] = (FW_EUI64_BYTE(eui, 0) | LOCAL) & ~GROUP;
187 eaddr[1] = FW_EUI64_BYTE(eui, 1);
188 eaddr[2] = FW_EUI64_BYTE(eui, 2);
189 eaddr[3] = FW_EUI64_BYTE(eui, 5);
190 eaddr[4] = FW_EUI64_BYTE(eui, 6);
191 eaddr[5] = FW_EUI64_BYTE(eui, 7);
192 printf("if_fwe%d: Fake Ethernet address: "
193 "%02x:%02x:%02x:%02x:%02x:%02x\n", unit,
194 eaddr[0], eaddr[1], eaddr[2], eaddr[3], eaddr[4], eaddr[5]);
196 /* fill the rest and attach interface */
197 ifp = fwe->eth_softc.ifp = if_alloc(IFT_ETHER);
199 device_printf(dev, "can not if_alloc()\n");
202 ifp->if_softc = &fwe->eth_softc;
204 #if __FreeBSD_version >= 501113 || defined(__DragonFly__)
205 if_initname(ifp, device_get_name(dev), unit);
208 ifp->if_name = "fwe";
210 ifp->if_init = fwe_init;
211 #if defined(__DragonFly__) || __FreeBSD_version < 500000
212 ifp->if_output = ether_output;
214 ifp->if_start = fwe_start;
215 ifp->if_ioctl = fwe_ioctl;
216 ifp->if_mtu = ETHERMTU;
217 ifp->if_flags = (IFF_BROADCAST|IFF_SIMPLEX|IFF_MULTICAST);
218 ifp->if_snd.ifq_maxlen = TX_MAX_QUEUE;
221 #if defined(__DragonFly__) || __FreeBSD_version < 500000
222 ether_ifattach(ifp, 1);
224 ether_ifattach(ifp, eaddr);
228 /* Tell the upper layer(s) we support long frames. */
229 ifp->if_data.ifi_hdrlen = sizeof(struct ether_vlan_header);
230 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
231 ifp->if_capabilities |= IFCAP_VLAN_MTU | IFCAP_POLLING;
232 ifp->if_capenable |= IFCAP_VLAN_MTU;
236 FWEDEBUG(ifp, "interface created\n");
241 fwe_stop(struct fwe_softc *fwe)
243 struct firewire_comm *fc;
244 struct fw_xferq *xferq;
245 struct ifnet *ifp = fwe->eth_softc.ifp;
246 struct fw_xfer *xfer, *next;
251 if (fwe->dma_ch >= 0) {
252 xferq = fc->ir[fwe->dma_ch];
254 if (xferq->flag & FWXFERQ_RUNNING)
255 fc->irx_disable(fc, fwe->dma_ch);
257 ~(FWXFERQ_MODEMASK | FWXFERQ_OPEN | FWXFERQ_STREAM |
258 FWXFERQ_EXTBUF | FWXFERQ_HANDLER | FWXFERQ_CHTAGMASK);
261 for (i = 0; i < xferq->bnchunk; i ++)
262 m_freem(xferq->bulkxfer[i].mbuf);
263 free(xferq->bulkxfer, M_FWE);
265 for (xfer = STAILQ_FIRST(&fwe->xferlist); xfer != NULL;
267 next = STAILQ_NEXT(xfer, link);
270 STAILQ_INIT(&fwe->xferlist);
272 xferq->bulkxfer = NULL;
276 #if defined(__FreeBSD__)
277 ifp->if_drv_flags &= ~(IFF_DRV_RUNNING | IFF_DRV_OACTIVE);
279 ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
284 fwe_detach(device_t dev)
286 struct fwe_softc *fwe;
290 fwe = device_get_softc(dev);
291 ifp = fwe->eth_softc.ifp;
293 #ifdef DEVICE_POLLING
294 if (ifp->if_capenable & IFCAP_POLLING)
295 ether_poll_deregister(ifp);
300 #if defined(__DragonFly__) || __FreeBSD_version < 500000
301 ether_ifdetach(ifp, 1);
308 mtx_destroy(&fwe->mtx);
315 struct fwe_softc *fwe = ((struct fwe_eth_softc *)arg)->fwe;
316 struct firewire_comm *fc;
317 struct ifnet *ifp = fwe->eth_softc.ifp;
318 struct fw_xferq *xferq;
319 struct fw_xfer *xfer;
323 FWEDEBUG(ifp, "initializing\n");
325 /* XXX keep promiscoud mode */
326 ifp->if_flags |= IFF_PROMISC;
329 if (fwe->dma_ch < 0) {
330 fwe->dma_ch = fw_open_isodma(fc, /* tx */0);
333 xferq = fc->ir[fwe->dma_ch];
334 xferq->flag |= FWXFERQ_EXTBUF |
335 FWXFERQ_HANDLER | FWXFERQ_STREAM;
336 fwe->stream_ch = stream_ch;
337 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch;
338 xferq->flag &= ~0xff;
339 xferq->flag |= fwe->stream_ch & 0xff;
340 /* register fwe_input handler */
341 xferq->sc = (caddr_t) fwe;
342 xferq->hand = fwe_as_input;
343 xferq->bnchunk = rx_queue_len;
345 xferq->psize = MCLBYTES;
348 xferq->bulkxfer = (struct fw_bulkxfer *) malloc(
349 sizeof(struct fw_bulkxfer) * xferq->bnchunk,
351 if (xferq->bulkxfer == NULL) {
352 printf("if_fwe: malloc failed\n");
355 STAILQ_INIT(&xferq->stvalid);
356 STAILQ_INIT(&xferq->stfree);
357 STAILQ_INIT(&xferq->stdma);
358 xferq->stproc = NULL;
359 for (i = 0; i < xferq->bnchunk; i ++) {
361 #if defined(__DragonFly__) || __FreeBSD_version < 500000
362 m_getcl(M_WAIT, MT_DATA, M_PKTHDR);
364 m_getcl(M_TRYWAIT, MT_DATA, M_PKTHDR);
366 xferq->bulkxfer[i].mbuf = m;
368 m->m_len = m->m_pkthdr.len = m->m_ext.ext_size;
369 STAILQ_INSERT_TAIL(&xferq->stfree,
370 &xferq->bulkxfer[i], link);
372 printf("%s: m_getcl failed\n", __FUNCTION__);
374 STAILQ_INIT(&fwe->xferlist);
375 for (i = 0; i < TX_MAX_QUEUE; i++) {
376 xfer = fw_xfer_alloc(M_FWE);
379 xfer->send.spd = tx_speed;
380 xfer->fc = fwe->fd.fc;
381 xfer->sc = (caddr_t)fwe;
382 xfer->hand = fwe_output_callback;
383 STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link);
386 xferq = fc->ir[fwe->dma_ch];
390 if ((xferq->flag & FWXFERQ_RUNNING) == 0)
391 fc->irx_enable(fc, fwe->dma_ch);
393 #if defined(__FreeBSD__)
394 ifp->if_drv_flags |= IFF_DRV_RUNNING;
395 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
397 ifp->if_flags |= IFF_RUNNING;
398 ifp->if_flags &= ~IFF_OACTIVE;
402 /* attempt to start output */
409 fwe_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
411 struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
412 struct ifstat *ifs = NULL;
418 if (ifp->if_flags & IFF_UP) {
419 #if defined(__FreeBSD__)
420 if (!(ifp->if_drv_flags & IFF_DRV_RUNNING))
422 if (!(ifp->if_flags & IFF_RUNNING))
424 fwe_init(&fwe->eth_softc);
426 #if defined(__FreeBSD__)
427 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
429 if (ifp->if_flags & IFF_RUNNING)
433 /* XXX keep promiscoud mode */
434 ifp->if_flags |= IFF_PROMISC;
443 ifs = (struct ifstat *)data;
444 len = strlen(ifs->ascii);
445 if (len < sizeof(ifs->ascii))
446 snprintf(ifs->ascii + len,
447 sizeof(ifs->ascii) - len,
449 fwe->stream_ch, fwe->dma_ch);
453 #ifdef DEVICE_POLLING
455 struct ifreq *ifr = (struct ifreq *) data;
456 struct firewire_comm *fc = fc = fwe->fd.fc;
458 if (ifr->ifr_reqcap & IFCAP_POLLING &&
459 !(ifp->if_capenable & IFCAP_POLLING)) {
460 error = ether_poll_register(fwe_poll, ifp);
463 /* Disable interrupts */
465 ifp->if_capenable |= IFCAP_POLLING;
468 if (!(ifr->ifr_reqcap & IFCAP_POLLING) &&
469 ifp->if_capenable & IFCAP_POLLING) {
470 error = ether_poll_deregister(ifp);
471 /* Enable interrupts. */
473 ifp->if_capenable &= ~IFCAP_POLLING;
477 #endif /* DEVICE_POLLING */
479 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
487 error = ether_ioctl(ifp, cmd, data);
490 #if defined(__DragonFly__) || __FreeBSD_version < 500000
500 fwe_output_callback(struct fw_xfer *xfer)
502 struct fwe_softc *fwe;
506 fwe = (struct fwe_softc *)xfer->sc;
507 ifp = fwe->eth_softc.ifp;
508 /* XXX error check */
509 FWEDEBUG(ifp, "resp = %d\n", xfer->resp);
514 fw_xfer_unload(xfer);
518 STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link);
523 if (ifp->if_snd.ifq_head != NULL)
528 fwe_start(struct ifnet *ifp)
530 struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
533 FWEDEBUG(ifp, "starting\n");
535 if (fwe->dma_ch < 0) {
536 struct mbuf *m = NULL;
538 FWEDEBUG(ifp, "not ready\n");
542 IF_DEQUEUE(&ifp->if_snd, m);
553 #if defined(__FreeBSD__)
554 ifp->if_drv_flags |= IFF_DRV_OACTIVE;
556 ifp->if_flags |= IFF_OACTIVE;
559 if (ifp->if_snd.ifq_len != 0)
560 fwe_as_output(fwe, ifp);
562 #if defined(__FreeBSD__)
563 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
565 ifp->if_flags &= ~IFF_OACTIVE;
572 #define ETHER_ALIGN 2
574 /* Async. stream output */
576 fwe_as_output(struct fwe_softc *fwe, struct ifnet *ifp)
579 struct fw_xfer *xfer;
580 struct fw_xferq *xferq;
585 xferq = fwe->fd.fc->atq;
586 while ((xferq->queued < xferq->maxq - 1) &&
587 (ifp->if_snd.ifq_head != NULL)) {
589 xfer = STAILQ_FIRST(&fwe->xferlist);
592 printf("if_fwe: lack of xfer\n");
597 STAILQ_REMOVE_HEAD(&fwe->xferlist, link);
600 IF_DEQUEUE(&ifp->if_snd, m);
603 STAILQ_INSERT_HEAD(&fwe->xferlist, xfer, link);
607 #if defined(__DragonFly__) || __FreeBSD_version < 500000
608 if (ifp->if_bpf != NULL)
614 /* keep ip packet alignment for alpha */
615 M_PREPEND(m, ETHER_ALIGN, M_DONTWAIT);
616 fp = &xfer->send.hdr;
617 *(uint32_t *)&xfer->send.hdr = *(int32_t *)&fwe->pkt_hdr;
618 fp->mode.stream.len = m->m_pkthdr.len;
620 xfer->send.pay_len = m->m_pkthdr.len;
622 if (fw_asyreq(fwe->fd.fc, -1, xfer) != 0) {
625 /* XXX set error code */
626 fwe_output_callback(xfer);
634 printf("%d queued\n", i);
637 xferq->start(fwe->fd.fc);
640 /* Async. stream output */
642 fwe_as_input(struct fw_xferq *xferq)
646 struct fwe_softc *fwe;
647 struct fw_bulkxfer *sxfer;
650 #if defined(__DragonFly__) || __FreeBSD_version < 500000
651 struct ether_header *eh;
654 fwe = (struct fwe_softc *)xferq->sc;
655 ifp = fwe->eth_softc.ifp;
657 /* We do not need a lock here because the bottom half is serialized */
658 while ((sxfer = STAILQ_FIRST(&xferq->stvalid)) != NULL) {
659 STAILQ_REMOVE_HEAD(&xferq->stvalid, link);
660 fp = mtod(sxfer->mbuf, struct fw_pkt *);
661 if (fwe->fd.fc->irx_post != NULL)
662 fwe->fd.fc->irx_post(fwe->fd.fc, fp->mode.ld);
665 /* insert new rbuf */
666 sxfer->mbuf = m0 = m_getcl(M_DONTWAIT, MT_DATA, M_PKTHDR);
668 m0->m_len = m0->m_pkthdr.len = m0->m_ext.ext_size;
669 STAILQ_INSERT_TAIL(&xferq->stfree, sxfer, link);
671 printf("%s: m_getcl failed\n", __FUNCTION__);
673 if (sxfer->resp != 0 || fp->mode.stream.len <
674 ETHER_ALIGN + sizeof(struct ether_header)) {
680 m->m_data += HDR_LEN + ETHER_ALIGN;
681 c = mtod(m, u_char *);
682 #if defined(__DragonFly__) || __FreeBSD_version < 500000
683 eh = (struct ether_header *)c;
684 m->m_data += sizeof(struct ether_header);
685 m->m_len = m->m_pkthdr.len = fp->mode.stream.len - ETHER_ALIGN
686 - sizeof(struct ether_header);
688 m->m_len = m->m_pkthdr.len = fp->mode.stream.len - ETHER_ALIGN;
690 m->m_pkthdr.rcvif = ifp;
692 FWEDEBUG(ifp, "%02x %02x %02x %02x %02x %02x\n"
693 "%02x %02x %02x %02x %02x %02x\n"
694 "%02x %02x %02x %02x\n"
695 "%02x %02x %02x %02x\n"
696 "%02x %02x %02x %02x\n"
697 "%02x %02x %02x %02x\n",
698 c[0], c[1], c[2], c[3], c[4], c[5],
699 c[6], c[7], c[8], c[9], c[10], c[11],
700 c[12], c[13], c[14], c[15],
701 c[16], c[17], c[18], c[19],
702 c[20], c[21], c[22], c[23],
703 c[20], c[21], c[22], c[23]
706 #if defined(__DragonFly__) || __FreeBSD_version < 500000
707 ether_input(ifp, eh, m);
709 (*ifp->if_input)(ifp, m);
713 if (STAILQ_FIRST(&xferq->stfree) != NULL)
714 fwe->fd.fc->irx_enable(fwe->fd.fc, fwe->dma_ch);
718 static devclass_t fwe_devclass;
720 static device_method_t fwe_methods[] = {
721 /* device interface */
722 DEVMETHOD(device_identify, fwe_identify),
723 DEVMETHOD(device_probe, fwe_probe),
724 DEVMETHOD(device_attach, fwe_attach),
725 DEVMETHOD(device_detach, fwe_detach),
729 static driver_t fwe_driver = {
732 sizeof(struct fwe_softc),
737 DECLARE_DUMMY_MODULE(fwe);
739 DRIVER_MODULE(fwe, firewire, fwe_driver, fwe_devclass, 0, 0);
740 MODULE_VERSION(fwe, 1);
741 MODULE_DEPEND(fwe, firewire, 1, 1, 1);