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 static 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 static 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);
122 #endif /* DEVICE_POLLING */
125 fwe_identify(driver_t *driver, device_t parent)
127 BUS_ADD_CHILD(parent, 0, "fwe", device_get_unit(parent));
131 fwe_probe(device_t dev)
135 pa = device_get_parent(dev);
136 if(device_get_unit(dev) != device_get_unit(pa)){
140 device_set_desc(dev, "Ethernet over FireWire");
145 fwe_attach(device_t dev)
147 struct fwe_softc *fwe;
150 #if defined(__DragonFly__) || __FreeBSD_version < 500000
155 struct fw_eui64 *eui;
157 fwe = ((struct fwe_softc *)device_get_softc(dev));
158 unit = device_get_unit(dev);
160 bzero(fwe, sizeof(struct fwe_softc));
161 mtx_init(&fwe->mtx, "fwe", NULL, MTX_DEF);
163 fwe->stream_ch = stream_ch;
166 fwe->fd.fc = device_get_ivars(dev);
168 tx_speed = fwe->fd.fc->speed;
171 fwe->fd.post_explore = NULL;
172 fwe->eth_softc.fwe = fwe;
174 fwe->pkt_hdr.mode.stream.tcode = FWTCODE_STREAM;
175 fwe->pkt_hdr.mode.stream.sy = 0;
176 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch;
178 /* generate fake MAC address: first and last 3bytes from eui64 */
181 #if defined(__DragonFly__) || __FreeBSD_version < 500000
182 eaddr = &IFP2ENADDR(fwe->eth_softc.ifp)[0];
186 eui = &fwe->fd.fc->eui;
187 eaddr[0] = (FW_EUI64_BYTE(eui, 0) | LOCAL) & ~GROUP;
188 eaddr[1] = FW_EUI64_BYTE(eui, 1);
189 eaddr[2] = FW_EUI64_BYTE(eui, 2);
190 eaddr[3] = FW_EUI64_BYTE(eui, 5);
191 eaddr[4] = FW_EUI64_BYTE(eui, 6);
192 eaddr[5] = FW_EUI64_BYTE(eui, 7);
193 printf("if_fwe%d: Fake Ethernet address: "
194 "%02x:%02x:%02x:%02x:%02x:%02x\n", unit,
195 eaddr[0], eaddr[1], eaddr[2], eaddr[3], eaddr[4], eaddr[5]);
197 /* fill the rest and attach interface */
198 ifp = fwe->eth_softc.ifp = if_alloc(IFT_ETHER);
200 device_printf(dev, "can not if_alloc()\n");
203 ifp->if_softc = &fwe->eth_softc;
205 #if __FreeBSD_version >= 501113 || defined(__DragonFly__)
206 if_initname(ifp, device_get_name(dev), unit);
209 ifp->if_name = "fwe";
211 ifp->if_init = fwe_init;
212 #if defined(__DragonFly__) || __FreeBSD_version < 500000
213 ifp->if_output = ether_output;
215 ifp->if_start = fwe_start;
216 ifp->if_ioctl = fwe_ioctl;
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 ++) {
360 m = m_getcl(M_WAITOK, MT_DATA, M_PKTHDR);
361 xferq->bulkxfer[i].mbuf = m;
362 m->m_len = m->m_pkthdr.len = m->m_ext.ext_size;
363 STAILQ_INSERT_TAIL(&xferq->stfree,
364 &xferq->bulkxfer[i], link);
366 STAILQ_INIT(&fwe->xferlist);
367 for (i = 0; i < TX_MAX_QUEUE; i++) {
368 xfer = fw_xfer_alloc(M_FWE);
371 xfer->send.spd = tx_speed;
372 xfer->fc = fwe->fd.fc;
373 xfer->sc = (caddr_t)fwe;
374 xfer->hand = fwe_output_callback;
375 STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link);
378 xferq = fc->ir[fwe->dma_ch];
382 if ((xferq->flag & FWXFERQ_RUNNING) == 0)
383 fc->irx_enable(fc, fwe->dma_ch);
385 #if defined(__FreeBSD__)
386 ifp->if_drv_flags |= IFF_DRV_RUNNING;
387 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
389 ifp->if_flags |= IFF_RUNNING;
390 ifp->if_flags &= ~IFF_OACTIVE;
394 /* attempt to start output */
401 fwe_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
403 struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
404 struct ifstat *ifs = NULL;
410 if (ifp->if_flags & IFF_UP) {
411 #if defined(__FreeBSD__)
412 if (!(ifp->if_drv_flags & IFF_DRV_RUNNING))
414 if (!(ifp->if_flags & IFF_RUNNING))
416 fwe_init(&fwe->eth_softc);
418 #if defined(__FreeBSD__)
419 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
421 if (ifp->if_flags & IFF_RUNNING)
425 /* XXX keep promiscoud mode */
426 ifp->if_flags |= IFF_PROMISC;
435 ifs = (struct ifstat *)data;
436 len = strlen(ifs->ascii);
437 if (len < sizeof(ifs->ascii))
438 snprintf(ifs->ascii + len,
439 sizeof(ifs->ascii) - len,
441 fwe->stream_ch, fwe->dma_ch);
445 #ifdef DEVICE_POLLING
447 struct ifreq *ifr = (struct ifreq *) data;
448 struct firewire_comm *fc = fwe->fd.fc;
450 if (ifr->ifr_reqcap & IFCAP_POLLING &&
451 !(ifp->if_capenable & IFCAP_POLLING)) {
452 error = ether_poll_register(fwe_poll, ifp);
455 /* Disable interrupts */
457 ifp->if_capenable |= IFCAP_POLLING;
458 ifp->if_capenable |= IFCAP_POLLING_NOCOUNT;
461 if (!(ifr->ifr_reqcap & IFCAP_POLLING) &&
462 ifp->if_capenable & IFCAP_POLLING) {
463 error = ether_poll_deregister(ifp);
464 /* Enable interrupts. */
466 ifp->if_capenable &= ~IFCAP_POLLING;
467 ifp->if_capenable &= ~IFCAP_POLLING_NOCOUNT;
471 #endif /* DEVICE_POLLING */
473 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
481 error = ether_ioctl(ifp, cmd, data);
484 #if defined(__DragonFly__) || __FreeBSD_version < 500000
494 fwe_output_callback(struct fw_xfer *xfer)
496 struct fwe_softc *fwe;
500 fwe = (struct fwe_softc *)xfer->sc;
501 ifp = fwe->eth_softc.ifp;
502 /* XXX error check */
503 FWEDEBUG(ifp, "resp = %d\n", xfer->resp);
508 fw_xfer_unload(xfer);
512 STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link);
517 if (ifp->if_snd.ifq_head != NULL)
522 fwe_start(struct ifnet *ifp)
524 struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
527 FWEDEBUG(ifp, "starting\n");
529 if (fwe->dma_ch < 0) {
530 struct mbuf *m = NULL;
532 FWEDEBUG(ifp, "not ready\n");
536 IF_DEQUEUE(&ifp->if_snd, m);
547 #if defined(__FreeBSD__)
548 ifp->if_drv_flags |= IFF_DRV_OACTIVE;
550 ifp->if_flags |= IFF_OACTIVE;
553 if (ifp->if_snd.ifq_len != 0)
554 fwe_as_output(fwe, ifp);
556 #if defined(__FreeBSD__)
557 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
559 ifp->if_flags &= ~IFF_OACTIVE;
566 #define ETHER_ALIGN 2
568 /* Async. stream output */
570 fwe_as_output(struct fwe_softc *fwe, struct ifnet *ifp)
573 struct fw_xfer *xfer;
574 struct fw_xferq *xferq;
579 xferq = fwe->fd.fc->atq;
580 while ((xferq->queued < xferq->maxq - 1) &&
581 (ifp->if_snd.ifq_head != NULL)) {
583 xfer = STAILQ_FIRST(&fwe->xferlist);
586 printf("if_fwe: lack of xfer\n");
591 STAILQ_REMOVE_HEAD(&fwe->xferlist, link);
594 IF_DEQUEUE(&ifp->if_snd, m);
597 STAILQ_INSERT_HEAD(&fwe->xferlist, xfer, link);
601 #if defined(__DragonFly__) || __FreeBSD_version < 500000
602 if (ifp->if_bpf != NULL)
608 /* keep ip packet alignment for alpha */
609 M_PREPEND(m, ETHER_ALIGN, M_NOWAIT);
610 fp = &xfer->send.hdr;
611 *(uint32_t *)&xfer->send.hdr = *(int32_t *)&fwe->pkt_hdr;
612 fp->mode.stream.len = m->m_pkthdr.len;
614 xfer->send.pay_len = m->m_pkthdr.len;
616 if (fw_asyreq(fwe->fd.fc, -1, xfer) != 0) {
619 /* XXX set error code */
620 fwe_output_callback(xfer);
628 printf("%d queued\n", i);
631 xferq->start(fwe->fd.fc);
634 /* Async. stream output */
636 fwe_as_input(struct fw_xferq *xferq)
640 struct fwe_softc *fwe;
641 struct fw_bulkxfer *sxfer;
644 #if defined(__DragonFly__) || __FreeBSD_version < 500000
645 struct ether_header *eh;
648 fwe = (struct fwe_softc *)xferq->sc;
649 ifp = fwe->eth_softc.ifp;
651 /* We do not need a lock here because the bottom half is serialized */
652 while ((sxfer = STAILQ_FIRST(&xferq->stvalid)) != NULL) {
653 STAILQ_REMOVE_HEAD(&xferq->stvalid, link);
654 fp = mtod(sxfer->mbuf, struct fw_pkt *);
655 if (fwe->fd.fc->irx_post != NULL)
656 fwe->fd.fc->irx_post(fwe->fd.fc, fp->mode.ld);
659 /* insert new rbuf */
660 sxfer->mbuf = m0 = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
662 m0->m_len = m0->m_pkthdr.len = m0->m_ext.ext_size;
663 STAILQ_INSERT_TAIL(&xferq->stfree, sxfer, link);
665 printf("%s: m_getcl failed\n", __FUNCTION__);
667 if (sxfer->resp != 0 || fp->mode.stream.len <
668 ETHER_ALIGN + sizeof(struct ether_header)) {
674 m->m_data += HDR_LEN + ETHER_ALIGN;
675 c = mtod(m, u_char *);
676 #if defined(__DragonFly__) || __FreeBSD_version < 500000
677 eh = (struct ether_header *)c;
678 m->m_data += sizeof(struct ether_header);
679 m->m_len = m->m_pkthdr.len = fp->mode.stream.len - ETHER_ALIGN
680 - sizeof(struct ether_header);
682 m->m_len = m->m_pkthdr.len = fp->mode.stream.len - ETHER_ALIGN;
684 m->m_pkthdr.rcvif = ifp;
686 FWEDEBUG(ifp, "%02x %02x %02x %02x %02x %02x\n"
687 "%02x %02x %02x %02x %02x %02x\n"
688 "%02x %02x %02x %02x\n"
689 "%02x %02x %02x %02x\n"
690 "%02x %02x %02x %02x\n"
691 "%02x %02x %02x %02x\n",
692 c[0], c[1], c[2], c[3], c[4], c[5],
693 c[6], c[7], c[8], c[9], c[10], c[11],
694 c[12], c[13], c[14], c[15],
695 c[16], c[17], c[18], c[19],
696 c[20], c[21], c[22], c[23],
697 c[20], c[21], c[22], c[23]
700 #if defined(__DragonFly__) || __FreeBSD_version < 500000
701 ether_input(ifp, eh, m);
703 (*ifp->if_input)(ifp, m);
707 if (STAILQ_FIRST(&xferq->stfree) != NULL)
708 fwe->fd.fc->irx_enable(fwe->fd.fc, fwe->dma_ch);
712 static devclass_t fwe_devclass;
714 static device_method_t fwe_methods[] = {
715 /* device interface */
716 DEVMETHOD(device_identify, fwe_identify),
717 DEVMETHOD(device_probe, fwe_probe),
718 DEVMETHOD(device_attach, fwe_attach),
719 DEVMETHOD(device_detach, fwe_detach),
723 static driver_t fwe_driver = {
726 sizeof(struct fwe_softc),
731 DECLARE_DUMMY_MODULE(fwe);
733 DRIVER_MODULE(fwe, firewire, fwe_driver, fwe_devclass, 0, 0);
734 MODULE_VERSION(fwe, 1);
735 MODULE_DEPEND(fwe, firewire, 1, 1, 1);