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_var.h>
58 #include <net/if_arp.h>
59 #include <net/if_types.h>
61 #include <net/vlan/if_vlan_var.h>
62 #include <bus/firewire/firewire.h>
63 #include <bus/firewire/firewirereg.h>
64 #include "if_fwevar.h"
66 #include <net/if_vlan_var.h>
68 #include <dev/firewire/firewire.h>
69 #include <dev/firewire/firewirereg.h>
70 #include <dev/firewire/if_fwevar.h>
73 #define FWEDEBUG if (fwedebug) if_printf
74 #define TX_MAX_QUEUE (FWMAXQUEUE - 1)
76 /* network interface */
77 static void fwe_start (struct ifnet *);
78 static int fwe_ioctl (struct ifnet *, u_long, caddr_t);
79 static void fwe_init (void *);
81 static void fwe_output_callback (struct fw_xfer *);
82 static void fwe_as_output (struct fwe_softc *, struct ifnet *);
83 static void fwe_as_input (struct fw_xferq *);
85 static int fwedebug = 0;
86 static int stream_ch = 1;
87 static int tx_speed = 2;
88 static int rx_queue_len = FWMAXQUEUE;
90 static MALLOC_DEFINE(M_FWE, "if_fwe", "Ethernet over FireWire interface");
91 SYSCTL_INT(_debug, OID_AUTO, if_fwe_debug, CTLFLAG_RW, &fwedebug, 0, "");
92 SYSCTL_DECL(_hw_firewire);
93 static SYSCTL_NODE(_hw_firewire, OID_AUTO, fwe, CTLFLAG_RD, 0,
94 "Ethernet emulation subsystem");
95 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, stream_ch, CTLFLAG_RW, &stream_ch, 0,
96 "Stream channel to use");
97 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, tx_speed, CTLFLAG_RW, &tx_speed, 0,
98 "Transmission speed");
99 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, rx_queue_len, CTLFLAG_RW, &rx_queue_len,
100 0, "Length of the receive queue");
102 TUNABLE_INT("hw.firewire.fwe.stream_ch", &stream_ch);
103 TUNABLE_INT("hw.firewire.fwe.tx_speed", &tx_speed);
104 TUNABLE_INT("hw.firewire.fwe.rx_queue_len", &rx_queue_len);
106 #ifdef DEVICE_POLLING
107 static poll_handler_t fwe_poll;
110 fwe_poll(struct ifnet *ifp, enum poll_cmd cmd, int count)
112 struct fwe_softc *fwe;
113 struct firewire_comm *fc;
115 if (!(ifp->if_drv_flags & IFF_DRV_RUNNING))
118 fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
120 fc->poll(fc, (cmd == POLL_AND_CHECK_STATUS)?0:1, count);
123 #endif /* DEVICE_POLLING */
126 fwe_identify(driver_t *driver, device_t parent)
128 BUS_ADD_CHILD(parent, 0, "fwe", device_get_unit(parent));
132 fwe_probe(device_t dev)
136 pa = device_get_parent(dev);
137 if(device_get_unit(dev) != device_get_unit(pa)){
141 device_set_desc(dev, "Ethernet over FireWire");
146 fwe_attach(device_t dev)
148 struct fwe_softc *fwe;
151 #if defined(__DragonFly__) || __FreeBSD_version < 500000
156 struct fw_eui64 *eui;
158 fwe = ((struct fwe_softc *)device_get_softc(dev));
159 unit = device_get_unit(dev);
161 bzero(fwe, sizeof(struct fwe_softc));
162 mtx_init(&fwe->mtx, "fwe", NULL, MTX_DEF);
164 fwe->stream_ch = stream_ch;
167 fwe->fd.fc = device_get_ivars(dev);
169 tx_speed = fwe->fd.fc->speed;
172 fwe->fd.post_explore = NULL;
173 fwe->eth_softc.fwe = fwe;
175 fwe->pkt_hdr.mode.stream.tcode = FWTCODE_STREAM;
176 fwe->pkt_hdr.mode.stream.sy = 0;
177 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch;
179 /* generate fake MAC address: first and last 3bytes from eui64 */
182 #if defined(__DragonFly__) || __FreeBSD_version < 500000
183 eaddr = &IFP2ENADDR(fwe->eth_softc.ifp)[0];
187 eui = &fwe->fd.fc->eui;
188 eaddr[0] = (FW_EUI64_BYTE(eui, 0) | LOCAL) & ~GROUP;
189 eaddr[1] = FW_EUI64_BYTE(eui, 1);
190 eaddr[2] = FW_EUI64_BYTE(eui, 2);
191 eaddr[3] = FW_EUI64_BYTE(eui, 5);
192 eaddr[4] = FW_EUI64_BYTE(eui, 6);
193 eaddr[5] = FW_EUI64_BYTE(eui, 7);
194 printf("if_fwe%d: Fake Ethernet address: "
195 "%02x:%02x:%02x:%02x:%02x:%02x\n", unit,
196 eaddr[0], eaddr[1], eaddr[2], eaddr[3], eaddr[4], eaddr[5]);
198 /* fill the rest and attach interface */
199 ifp = fwe->eth_softc.ifp = if_alloc(IFT_ETHER);
201 device_printf(dev, "can not if_alloc()\n");
204 ifp->if_softc = &fwe->eth_softc;
206 #if __FreeBSD_version >= 501113 || defined(__DragonFly__)
207 if_initname(ifp, device_get_name(dev), unit);
210 ifp->if_name = "fwe";
212 ifp->if_init = fwe_init;
213 #if defined(__DragonFly__) || __FreeBSD_version < 500000
214 ifp->if_output = ether_output;
216 ifp->if_start = fwe_start;
217 ifp->if_ioctl = fwe_ioctl;
218 ifp->if_flags = (IFF_BROADCAST|IFF_SIMPLEX|IFF_MULTICAST);
219 ifp->if_snd.ifq_maxlen = TX_MAX_QUEUE;
222 #if defined(__DragonFly__) || __FreeBSD_version < 500000
223 ether_ifattach(ifp, 1);
225 ether_ifattach(ifp, eaddr);
229 /* Tell the upper layer(s) we support long frames. */
230 ifp->if_data.ifi_hdrlen = sizeof(struct ether_vlan_header);
231 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
232 ifp->if_capabilities |= IFCAP_VLAN_MTU | IFCAP_POLLING;
233 ifp->if_capenable |= IFCAP_VLAN_MTU;
237 FWEDEBUG(ifp, "interface created\n");
242 fwe_stop(struct fwe_softc *fwe)
244 struct firewire_comm *fc;
245 struct fw_xferq *xferq;
246 struct ifnet *ifp = fwe->eth_softc.ifp;
247 struct fw_xfer *xfer, *next;
252 if (fwe->dma_ch >= 0) {
253 xferq = fc->ir[fwe->dma_ch];
255 if (xferq->flag & FWXFERQ_RUNNING)
256 fc->irx_disable(fc, fwe->dma_ch);
258 ~(FWXFERQ_MODEMASK | FWXFERQ_OPEN | FWXFERQ_STREAM |
259 FWXFERQ_EXTBUF | FWXFERQ_HANDLER | FWXFERQ_CHTAGMASK);
262 for (i = 0; i < xferq->bnchunk; i ++)
263 m_freem(xferq->bulkxfer[i].mbuf);
264 free(xferq->bulkxfer, M_FWE);
266 for (xfer = STAILQ_FIRST(&fwe->xferlist); xfer != NULL;
268 next = STAILQ_NEXT(xfer, link);
271 STAILQ_INIT(&fwe->xferlist);
273 xferq->bulkxfer = NULL;
277 #if defined(__FreeBSD__)
278 ifp->if_drv_flags &= ~(IFF_DRV_RUNNING | IFF_DRV_OACTIVE);
280 ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
285 fwe_detach(device_t dev)
287 struct fwe_softc *fwe;
291 fwe = device_get_softc(dev);
292 ifp = fwe->eth_softc.ifp;
294 #ifdef DEVICE_POLLING
295 if (ifp->if_capenable & IFCAP_POLLING)
296 ether_poll_deregister(ifp);
301 #if defined(__DragonFly__) || __FreeBSD_version < 500000
302 ether_ifdetach(ifp, 1);
309 mtx_destroy(&fwe->mtx);
316 struct fwe_softc *fwe = ((struct fwe_eth_softc *)arg)->fwe;
317 struct firewire_comm *fc;
318 struct ifnet *ifp = fwe->eth_softc.ifp;
319 struct fw_xferq *xferq;
320 struct fw_xfer *xfer;
324 FWEDEBUG(ifp, "initializing\n");
326 /* XXX keep promiscoud mode */
327 ifp->if_flags |= IFF_PROMISC;
330 if (fwe->dma_ch < 0) {
331 fwe->dma_ch = fw_open_isodma(fc, /* tx */0);
334 xferq = fc->ir[fwe->dma_ch];
335 xferq->flag |= FWXFERQ_EXTBUF |
336 FWXFERQ_HANDLER | FWXFERQ_STREAM;
337 fwe->stream_ch = stream_ch;
338 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch;
339 xferq->flag &= ~0xff;
340 xferq->flag |= fwe->stream_ch & 0xff;
341 /* register fwe_input handler */
342 xferq->sc = (caddr_t) fwe;
343 xferq->hand = fwe_as_input;
344 xferq->bnchunk = rx_queue_len;
346 xferq->psize = MCLBYTES;
349 xferq->bulkxfer = (struct fw_bulkxfer *) malloc(
350 sizeof(struct fw_bulkxfer) * xferq->bnchunk,
352 if (xferq->bulkxfer == NULL) {
353 printf("if_fwe: malloc failed\n");
356 STAILQ_INIT(&xferq->stvalid);
357 STAILQ_INIT(&xferq->stfree);
358 STAILQ_INIT(&xferq->stdma);
359 xferq->stproc = NULL;
360 for (i = 0; i < xferq->bnchunk; i ++) {
361 m = m_getcl(M_WAITOK, MT_DATA, M_PKTHDR);
362 xferq->bulkxfer[i].mbuf = m;
363 m->m_len = m->m_pkthdr.len = m->m_ext.ext_size;
364 STAILQ_INSERT_TAIL(&xferq->stfree,
365 &xferq->bulkxfer[i], link);
367 STAILQ_INIT(&fwe->xferlist);
368 for (i = 0; i < TX_MAX_QUEUE; i++) {
369 xfer = fw_xfer_alloc(M_FWE);
372 xfer->send.spd = tx_speed;
373 xfer->fc = fwe->fd.fc;
374 xfer->sc = (caddr_t)fwe;
375 xfer->hand = fwe_output_callback;
376 STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link);
379 xferq = fc->ir[fwe->dma_ch];
383 if ((xferq->flag & FWXFERQ_RUNNING) == 0)
384 fc->irx_enable(fc, fwe->dma_ch);
386 #if defined(__FreeBSD__)
387 ifp->if_drv_flags |= IFF_DRV_RUNNING;
388 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
390 ifp->if_flags |= IFF_RUNNING;
391 ifp->if_flags &= ~IFF_OACTIVE;
395 /* attempt to start output */
402 fwe_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
404 struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
405 struct ifstat *ifs = NULL;
411 if (ifp->if_flags & IFF_UP) {
412 #if defined(__FreeBSD__)
413 if (!(ifp->if_drv_flags & IFF_DRV_RUNNING))
415 if (!(ifp->if_flags & IFF_RUNNING))
417 fwe_init(&fwe->eth_softc);
419 #if defined(__FreeBSD__)
420 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
422 if (ifp->if_flags & IFF_RUNNING)
426 /* XXX keep promiscoud mode */
427 ifp->if_flags |= IFF_PROMISC;
436 ifs = (struct ifstat *)data;
437 snprintf(ifs->ascii, sizeof(ifs->ascii),
438 "\tch %d dma %d\n", fwe->stream_ch, fwe->dma_ch);
442 #ifdef DEVICE_POLLING
444 struct ifreq *ifr = (struct ifreq *) data;
445 struct firewire_comm *fc = fwe->fd.fc;
447 if (ifr->ifr_reqcap & IFCAP_POLLING &&
448 !(ifp->if_capenable & IFCAP_POLLING)) {
449 error = ether_poll_register(fwe_poll, ifp);
452 /* Disable interrupts */
454 ifp->if_capenable |= IFCAP_POLLING;
455 ifp->if_capenable |= IFCAP_POLLING_NOCOUNT;
458 if (!(ifr->ifr_reqcap & IFCAP_POLLING) &&
459 ifp->if_capenable & IFCAP_POLLING) {
460 error = ether_poll_deregister(ifp);
461 /* Enable interrupts. */
463 ifp->if_capenable &= ~IFCAP_POLLING;
464 ifp->if_capenable &= ~IFCAP_POLLING_NOCOUNT;
468 #endif /* DEVICE_POLLING */
470 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
478 error = ether_ioctl(ifp, cmd, data);
481 #if defined(__DragonFly__) || __FreeBSD_version < 500000
491 fwe_output_callback(struct fw_xfer *xfer)
493 struct fwe_softc *fwe;
497 fwe = (struct fwe_softc *)xfer->sc;
498 ifp = fwe->eth_softc.ifp;
499 /* XXX error check */
500 FWEDEBUG(ifp, "resp = %d\n", xfer->resp);
505 fw_xfer_unload(xfer);
509 STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link);
514 if (ifp->if_snd.ifq_head != NULL)
519 fwe_start(struct ifnet *ifp)
521 struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
524 FWEDEBUG(ifp, "starting\n");
526 if (fwe->dma_ch < 0) {
527 struct mbuf *m = NULL;
529 FWEDEBUG(ifp, "not ready\n");
533 IF_DEQUEUE(&ifp->if_snd, m);
544 #if defined(__FreeBSD__)
545 ifp->if_drv_flags |= IFF_DRV_OACTIVE;
547 ifp->if_flags |= IFF_OACTIVE;
550 if (ifp->if_snd.ifq_len != 0)
551 fwe_as_output(fwe, ifp);
553 #if defined(__FreeBSD__)
554 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
556 ifp->if_flags &= ~IFF_OACTIVE;
563 #define ETHER_ALIGN 2
565 /* Async. stream output */
567 fwe_as_output(struct fwe_softc *fwe, struct ifnet *ifp)
570 struct fw_xfer *xfer;
571 struct fw_xferq *xferq;
576 xferq = fwe->fd.fc->atq;
577 while ((xferq->queued < xferq->maxq - 1) &&
578 (ifp->if_snd.ifq_head != NULL)) {
580 xfer = STAILQ_FIRST(&fwe->xferlist);
583 printf("if_fwe: lack of xfer\n");
588 STAILQ_REMOVE_HEAD(&fwe->xferlist, link);
591 IF_DEQUEUE(&ifp->if_snd, m);
594 STAILQ_INSERT_HEAD(&fwe->xferlist, xfer, link);
598 #if defined(__DragonFly__) || __FreeBSD_version < 500000
599 if (ifp->if_bpf != NULL)
605 /* keep ip packet alignment for alpha */
606 M_PREPEND(m, ETHER_ALIGN, M_NOWAIT);
607 fp = &xfer->send.hdr;
608 *(uint32_t *)&xfer->send.hdr = *(int32_t *)&fwe->pkt_hdr;
609 fp->mode.stream.len = m->m_pkthdr.len;
611 xfer->send.pay_len = m->m_pkthdr.len;
613 if (fw_asyreq(fwe->fd.fc, -1, xfer) != 0) {
616 /* XXX set error code */
617 fwe_output_callback(xfer);
625 printf("%d queued\n", i);
628 xferq->start(fwe->fd.fc);
631 /* Async. stream output */
633 fwe_as_input(struct fw_xferq *xferq)
637 struct fwe_softc *fwe;
638 struct fw_bulkxfer *sxfer;
641 #if defined(__DragonFly__) || __FreeBSD_version < 500000
642 struct ether_header *eh;
645 fwe = (struct fwe_softc *)xferq->sc;
646 ifp = fwe->eth_softc.ifp;
648 /* We do not need a lock here because the bottom half is serialized */
649 while ((sxfer = STAILQ_FIRST(&xferq->stvalid)) != NULL) {
650 STAILQ_REMOVE_HEAD(&xferq->stvalid, link);
651 fp = mtod(sxfer->mbuf, struct fw_pkt *);
652 if (fwe->fd.fc->irx_post != NULL)
653 fwe->fd.fc->irx_post(fwe->fd.fc, fp->mode.ld);
656 /* insert new rbuf */
657 sxfer->mbuf = m0 = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
659 m0->m_len = m0->m_pkthdr.len = m0->m_ext.ext_size;
660 STAILQ_INSERT_TAIL(&xferq->stfree, sxfer, link);
662 printf("%s: m_getcl failed\n", __FUNCTION__);
664 if (sxfer->resp != 0 || fp->mode.stream.len <
665 ETHER_ALIGN + sizeof(struct ether_header)) {
671 m->m_data += HDR_LEN + ETHER_ALIGN;
672 c = mtod(m, u_char *);
673 #if defined(__DragonFly__) || __FreeBSD_version < 500000
674 eh = (struct ether_header *)c;
675 m->m_data += sizeof(struct ether_header);
676 m->m_len = m->m_pkthdr.len = fp->mode.stream.len - ETHER_ALIGN
677 - sizeof(struct ether_header);
679 m->m_len = m->m_pkthdr.len = fp->mode.stream.len - ETHER_ALIGN;
681 m->m_pkthdr.rcvif = ifp;
683 FWEDEBUG(ifp, "%02x %02x %02x %02x %02x %02x\n"
684 "%02x %02x %02x %02x %02x %02x\n"
685 "%02x %02x %02x %02x\n"
686 "%02x %02x %02x %02x\n"
687 "%02x %02x %02x %02x\n"
688 "%02x %02x %02x %02x\n",
689 c[0], c[1], c[2], c[3], c[4], c[5],
690 c[6], c[7], c[8], c[9], c[10], c[11],
691 c[12], c[13], c[14], c[15],
692 c[16], c[17], c[18], c[19],
693 c[20], c[21], c[22], c[23],
694 c[20], c[21], c[22], c[23]
697 #if defined(__DragonFly__) || __FreeBSD_version < 500000
698 ether_input(ifp, eh, m);
700 (*ifp->if_input)(ifp, m);
704 if (STAILQ_FIRST(&xferq->stfree) != NULL)
705 fwe->fd.fc->irx_enable(fwe->fd.fc, fwe->dma_ch);
709 static devclass_t fwe_devclass;
711 static device_method_t fwe_methods[] = {
712 /* device interface */
713 DEVMETHOD(device_identify, fwe_identify),
714 DEVMETHOD(device_probe, fwe_probe),
715 DEVMETHOD(device_attach, fwe_attach),
716 DEVMETHOD(device_detach, fwe_detach),
720 static driver_t fwe_driver = {
723 sizeof(struct fwe_softc),
728 DECLARE_DUMMY_MODULE(fwe);
730 DRIVER_MODULE(fwe, firewire, fwe_driver, fwe_devclass, 0, 0);
731 MODULE_VERSION(fwe, 1);
732 MODULE_DEPEND(fwe, firewire, 1, 1, 1);