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
34 * $FreeBSD: src/sys/dev/firewire/if_fwe.c,v 1.27 2004/01/08 14:58:09 simokawa Exp $
35 * $DragonFly: src/sys/dev/netif/fwe/if_fwe.c,v 1.11 2004/06/02 14:42:51 eirikn Exp $
40 #include <sys/param.h>
42 #include <sys/kernel.h>
43 #include <sys/malloc.h>
45 #include <sys/socket.h>
46 #include <sys/sockio.h>
47 #include <sys/sysctl.h>
48 #include <sys/systm.h>
49 #include <sys/module.h>
51 #include <machine/bus.h>
54 #include <net/ethernet.h>
56 #include <net/if_arp.h>
58 #include <net/vlan/if_vlan_var.h>
59 #include <bus/firewire/firewire.h>
60 #include <bus/firewire/firewirereg.h>
61 #include "if_fwevar.h"
63 #include <net/if_vlan_var.h>
65 #include <dev/firewire/firewire.h>
66 #include <dev/firewire/firewirereg.h>
67 #include <dev/firewire/if_fwevar.h>
70 #define FWEDEBUG if (fwedebug) if_printf
71 #define TX_MAX_QUEUE (FWMAXQUEUE - 1)
73 /* network interface */
74 static void fwe_start (struct ifnet *);
75 static int fwe_ioctl (struct ifnet *, u_long, caddr_t, struct ucred *);
76 static void fwe_init (void *);
78 static void fwe_output_callback (struct fw_xfer *);
79 static void fwe_as_output (struct fwe_softc *, struct ifnet *);
80 static void fwe_as_input (struct fw_xferq *);
82 static int fwedebug = 0;
83 static int stream_ch = 1;
84 static int tx_speed = 2;
85 static int rx_queue_len = FWMAXQUEUE;
87 MALLOC_DEFINE(M_FWE, "if_fwe", "Ethernet over FireWire interface");
88 SYSCTL_INT(_debug, OID_AUTO, if_fwe_debug, CTLFLAG_RW, &fwedebug, 0, "");
89 SYSCTL_DECL(_hw_firewire);
90 SYSCTL_NODE(_hw_firewire, OID_AUTO, fwe, CTLFLAG_RD, 0,
91 "Ethernet emulation subsystem");
92 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, stream_ch, CTLFLAG_RW, &stream_ch, 0,
93 "Stream channel to use");
94 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, tx_speed, CTLFLAG_RW, &tx_speed, 0,
95 "Transmission speed");
96 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, rx_queue_len, CTLFLAG_RW, &rx_queue_len,
97 0, "Length of the receive queue");
99 TUNABLE_INT("hw.firewire.fwe.stream_ch", &stream_ch);
100 TUNABLE_INT("hw.firewire.fwe.tx_speed", &tx_speed);
101 TUNABLE_INT("hw.firewire.fwe.rx_queue_len", &rx_queue_len);
103 #ifdef DEVICE_POLLING
104 #define FWE_POLL_REGISTER(func, fwe, ifp) \
105 if (ether_poll_register(func, ifp)) { \
106 struct firewire_comm *fc = (fwe)->fd.fc; \
107 fc->set_intr(fc, 0); \
110 #define FWE_POLL_DEREGISTER(fwe, ifp) \
112 struct firewire_comm *fc = (fwe)->fd.fc; \
113 ether_poll_deregister(ifp); \
114 fc->set_intr(fc, 1); \
117 static poll_handler_t fwe_poll;
120 fwe_poll(struct ifnet *ifp, enum poll_cmd cmd, int count)
122 struct fwe_softc *fwe;
123 struct firewire_comm *fc;
125 fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
127 if (cmd == POLL_DEREGISTER) {
128 /* enable interrupts */
132 fc->poll(fc, (cmd == POLL_AND_CHECK_STATUS)?0:1, count);
135 #define FWE_POLL_REGISTER(func, fwe, ifp)
136 #define FWE_POLL_DEREGISTER(fwe, ifp)
139 fwe_identify(driver_t *driver, device_t parent)
141 BUS_ADD_CHILD(parent, 0, "fwe", device_get_unit(parent));
145 fwe_probe(device_t dev)
149 pa = device_get_parent(dev);
150 if(device_get_unit(dev) != device_get_unit(pa)){
154 device_set_desc(dev, "Ethernet over FireWire");
159 fwe_attach(device_t dev)
161 struct fwe_softc *fwe;
165 struct fw_eui64 *eui;
167 fwe = ((struct fwe_softc *)device_get_softc(dev));
168 unit = device_get_unit(dev);
170 bzero(fwe, sizeof(struct fwe_softc));
172 fwe->stream_ch = stream_ch;
175 fwe->fd.fc = device_get_ivars(dev);
177 tx_speed = fwe->fd.fc->speed;
180 fwe->fd.post_explore = NULL;
181 fwe->eth_softc.fwe = fwe;
183 fwe->pkt_hdr.mode.stream.tcode = FWTCODE_STREAM;
184 fwe->pkt_hdr.mode.stream.sy = 0;
185 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch;
187 /* generate fake MAC address: first and last 3bytes from eui64 */
190 eaddr = &fwe->eth_softc.arpcom.ac_enaddr[0];
192 eui = &fwe->fd.fc->eui;
193 eaddr[0] = (FW_EUI64_BYTE(eui, 0) | LOCAL) & ~GROUP;
194 eaddr[1] = FW_EUI64_BYTE(eui, 1);
195 eaddr[2] = FW_EUI64_BYTE(eui, 2);
196 eaddr[3] = FW_EUI64_BYTE(eui, 5);
197 eaddr[4] = FW_EUI64_BYTE(eui, 6);
198 eaddr[5] = FW_EUI64_BYTE(eui, 7);
199 printf("if_fwe%d: Fake Ethernet address: "
200 "%02x:%02x:%02x:%02x:%02x:%02x\n", unit,
201 eaddr[0], eaddr[1], eaddr[2], eaddr[3], eaddr[4], eaddr[5]);
203 /* fill the rest and attach interface */
205 ifp->if_softc = &fwe->eth_softc;
207 #if __FreeBSD_version >= 501113 || defined(__DragonFly__)
208 if_initname(ifp, device_get_name(dev), unit);
211 ifp->if_name = "fwe";
213 ifp->if_init = fwe_init;
214 ifp->if_output = ether_output;
215 ifp->if_start = fwe_start;
216 ifp->if_ioctl = fwe_ioctl;
217 ifp->if_mtu = ETHERMTU;
218 ifp->if_flags = (IFF_BROADCAST|IFF_SIMPLEX|IFF_MULTICAST);
219 ifp->if_snd.ifq_maxlen = TX_MAX_QUEUE;
222 ether_ifattach(ifp, eaddr);
225 /* Tell the upper layer(s) we support long frames. */
226 ifp->if_data.ifi_hdrlen = sizeof(struct ether_vlan_header);
227 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
228 ifp->if_capabilities |= IFCAP_VLAN_MTU;
232 FWEDEBUG(ifp, "interface created\n");
237 fwe_stop(struct fwe_softc *fwe)
239 struct firewire_comm *fc;
240 struct fw_xferq *xferq;
241 struct ifnet *ifp = &fwe->fwe_if;
242 struct fw_xfer *xfer, *next;
247 FWE_POLL_DEREGISTER(fwe, ifp);
249 if (fwe->dma_ch >= 0) {
250 xferq = fc->ir[fwe->dma_ch];
252 if (xferq->flag & FWXFERQ_RUNNING)
253 fc->irx_disable(fc, fwe->dma_ch);
255 ~(FWXFERQ_MODEMASK | FWXFERQ_OPEN | FWXFERQ_STREAM |
256 FWXFERQ_EXTBUF | FWXFERQ_HANDLER | FWXFERQ_CHTAGMASK);
259 for (i = 0; i < xferq->bnchunk; i ++)
260 m_freem(xferq->bulkxfer[i].mbuf);
261 free(xferq->bulkxfer, M_FWE);
263 for (xfer = STAILQ_FIRST(&fwe->xferlist); xfer != NULL;
265 next = STAILQ_NEXT(xfer, link);
268 STAILQ_INIT(&fwe->xferlist);
270 xferq->bulkxfer = NULL;
274 ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
278 fwe_detach(device_t dev)
280 struct fwe_softc *fwe;
283 fwe = (struct fwe_softc *)device_get_softc(dev);
287 ether_ifdetach(&fwe->fwe_if);
296 struct fwe_softc *fwe = ((struct fwe_eth_softc *)arg)->fwe;
297 struct firewire_comm *fc;
298 struct ifnet *ifp = &fwe->fwe_if;
299 struct fw_xferq *xferq;
300 struct fw_xfer *xfer;
304 FWEDEBUG(ifp, "initializing\n");
306 /* XXX keep promiscoud mode */
307 ifp->if_flags |= IFF_PROMISC;
311 if (fwe->dma_ch < 0) {
312 for (i = START; i < fc->nisodma; i ++) {
314 if ((xferq->flag & FWXFERQ_OPEN) == 0)
317 printf("no free dma channel\n");
321 fwe->stream_ch = stream_ch;
322 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch;
323 /* allocate DMA channel and init packet mode */
324 xferq->flag |= FWXFERQ_OPEN | FWXFERQ_EXTBUF |
325 FWXFERQ_HANDLER | FWXFERQ_STREAM;
326 xferq->flag &= ~0xff;
327 xferq->flag |= fwe->stream_ch & 0xff;
328 /* register fwe_input handler */
329 xferq->sc = (caddr_t) fwe;
330 xferq->hand = fwe_as_input;
331 xferq->bnchunk = rx_queue_len;
333 xferq->psize = MCLBYTES;
336 xferq->bulkxfer = (struct fw_bulkxfer *) malloc(
337 sizeof(struct fw_bulkxfer) * xferq->bnchunk,
339 if (xferq->bulkxfer == NULL) {
340 printf("if_fwe: malloc failed\n");
343 STAILQ_INIT(&xferq->stvalid);
344 STAILQ_INIT(&xferq->stfree);
345 STAILQ_INIT(&xferq->stdma);
346 xferq->stproc = NULL;
347 for (i = 0; i < xferq->bnchunk; i ++) {
349 #if defined(__DragonFly__)
350 m_getcl(MB_WAIT, MT_DATA, M_PKTHDR);
351 #elif __FreeBSD_version < 500000
352 m_getcl(M_WAIT, MT_DATA, M_PKTHDR);
354 m_getcl(M_TRYWAIT, MT_DATA, M_PKTHDR);
356 xferq->bulkxfer[i].mbuf = m;
358 m->m_len = m->m_pkthdr.len = m->m_ext.ext_size;
359 STAILQ_INSERT_TAIL(&xferq->stfree,
360 &xferq->bulkxfer[i], link);
362 printf("fwe_as_input: m_getcl failed\n");
364 STAILQ_INIT(&fwe->xferlist);
365 for (i = 0; i < TX_MAX_QUEUE; i++) {
366 xfer = fw_xfer_alloc(M_FWE);
369 xfer->send.spd = tx_speed;
370 xfer->fc = fwe->fd.fc;
371 xfer->retry_req = fw_asybusy;
372 xfer->sc = (caddr_t)fwe;
373 xfer->act.hand = fwe_output_callback;
374 STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link);
377 xferq = fc->ir[fwe->dma_ch];
381 if ((xferq->flag & FWXFERQ_RUNNING) == 0)
382 fc->irx_enable(fc, fwe->dma_ch);
384 ifp->if_flags |= IFF_RUNNING;
385 ifp->if_flags &= ~IFF_OACTIVE;
387 FWE_POLL_REGISTER(fwe_poll, fwe, ifp);
389 /* attempt to start output */
396 fwe_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data, struct ucred *cr)
398 struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
399 struct ifstat *ifs = NULL;
405 if (ifp->if_flags & IFF_UP) {
406 if (!(ifp->if_flags & IFF_RUNNING))
407 fwe_init(&fwe->eth_softc);
409 if (ifp->if_flags & IFF_RUNNING)
412 /* XXX keep promiscoud mode */
413 ifp->if_flags |= IFF_PROMISC;
422 ifs = (struct ifstat *)data;
423 len = strlen(ifs->ascii);
424 if (len < sizeof(ifs->ascii))
425 snprintf(ifs->ascii + len,
426 sizeof(ifs->ascii) - len,
428 fwe->stream_ch, fwe->dma_ch);
431 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
439 error = ether_ioctl(ifp, cmd, data);
442 #if defined(__DragonFly__) || __FreeBSD_version < 500000
452 fwe_output_callback(struct fw_xfer *xfer)
454 struct fwe_softc *fwe;
458 fwe = (struct fwe_softc *)xfer->sc;
460 /* XXX error check */
461 FWEDEBUG(ifp, "resp = %d\n", xfer->resp);
466 fw_xfer_unload(xfer);
469 STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link);
473 if (ifp->if_snd.ifq_head != NULL)
478 fwe_start(struct ifnet *ifp)
480 struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
483 FWEDEBUG(ifp, "starting\n");
485 if (fwe->dma_ch < 0) {
486 struct mbuf *m = NULL;
488 FWEDEBUG(ifp, "not ready\n");
492 IF_DEQUEUE(&ifp->if_snd, m);
503 ifp->if_flags |= IFF_OACTIVE;
505 if (ifp->if_snd.ifq_len != 0)
506 fwe_as_output(fwe, ifp);
508 ifp->if_flags &= ~IFF_OACTIVE;
514 #define ETHER_ALIGN 2
516 /* Async. stream output */
518 fwe_as_output(struct fwe_softc *fwe, struct ifnet *ifp)
521 struct fw_xfer *xfer;
522 struct fw_xferq *xferq;
527 xferq = fwe->fd.fc->atq;
528 while (xferq->queued < xferq->maxq - 1) {
529 xfer = STAILQ_FIRST(&fwe->xferlist);
531 printf("if_fwe: lack of xfer\n");
534 IF_DEQUEUE(&ifp->if_snd, m);
537 STAILQ_REMOVE_HEAD(&fwe->xferlist, link);
538 #if defined(__DragonFly__) || __FreeBSD_version < 500000
539 if (ifp->if_bpf != NULL)
545 /* keep ip packet alignment for alpha */
546 M_PREPEND(m, ETHER_ALIGN, MB_DONTWAIT);
547 fp = &xfer->send.hdr;
548 *(u_int32_t *)&xfer->send.hdr = *(int32_t *)&fwe->pkt_hdr;
549 fp->mode.stream.len = m->m_pkthdr.len;
551 xfer->send.pay_len = m->m_pkthdr.len;
553 if (fw_asyreq(fwe->fd.fc, -1, xfer) != 0) {
556 /* XXX set error code */
557 fwe_output_callback(xfer);
565 printf("%d queued\n", i);
568 xferq->start(fwe->fd.fc);
571 /* Async. stream output */
573 fwe_as_input(struct fw_xferq *xferq)
577 struct fwe_softc *fwe;
578 struct fw_bulkxfer *sxfer;
581 #if defined(__DragonFly__) || __FreeBSD_version < 500000
582 struct ether_header *eh;
585 fwe = (struct fwe_softc *)xferq->sc;
588 FWE_POLL_REGISTER(fwe_poll, fwe, ifp);
590 while ((sxfer = STAILQ_FIRST(&xferq->stvalid)) != NULL) {
591 STAILQ_REMOVE_HEAD(&xferq->stvalid, link);
592 fp = mtod(sxfer->mbuf, struct fw_pkt *);
593 if (fwe->fd.fc->irx_post != NULL)
594 fwe->fd.fc->irx_post(fwe->fd.fc, fp->mode.ld);
597 /* insert new rbuf */
598 sxfer->mbuf = m0 = m_getcl(MB_DONTWAIT, MT_DATA, M_PKTHDR);
600 m0->m_len = m0->m_pkthdr.len = m0->m_ext.ext_size;
601 STAILQ_INSERT_TAIL(&xferq->stfree, sxfer, link);
603 printf("fwe_as_input: m_getcl failed\n");
605 if (sxfer->resp != 0 || fp->mode.stream.len <
606 ETHER_ALIGN + sizeof(struct ether_header)) {
612 m->m_data += HDR_LEN + ETHER_ALIGN;
614 #if defined(__DragonFly__) || __FreeBSD_version < 500000
615 eh = (struct ether_header *)c;
616 m->m_data += sizeof(struct ether_header);
618 m->m_len = m->m_pkthdr.len =
619 fp->mode.stream.len - ETHER_ALIGN;
620 m->m_pkthdr.rcvif = ifp;
622 FWEDEBUG(ifp, "%02x %02x %02x %02x %02x %02x\n"
623 "%02x %02x %02x %02x %02x %02x\n"
624 "%02x %02x %02x %02x\n"
625 "%02x %02x %02x %02x\n"
626 "%02x %02x %02x %02x\n"
627 "%02x %02x %02x %02x\n",
628 c[0], c[1], c[2], c[3], c[4], c[5],
629 c[6], c[7], c[8], c[9], c[10], c[11],
630 c[12], c[13], c[14], c[15],
631 c[16], c[17], c[18], c[19],
632 c[20], c[21], c[22], c[23],
633 c[20], c[21], c[22], c[23]
636 #if defined(__DragonFly__) || __FreeBSD_version < 500000
637 ether_input(ifp, eh, m);
639 (*ifp->if_input)(ifp, m);
643 if (STAILQ_FIRST(&xferq->stfree) != NULL)
644 fwe->fd.fc->irx_enable(fwe->fd.fc, fwe->dma_ch);
648 static devclass_t fwe_devclass;
650 static device_method_t fwe_methods[] = {
651 /* device interface */
652 DEVMETHOD(device_identify, fwe_identify),
653 DEVMETHOD(device_probe, fwe_probe),
654 DEVMETHOD(device_attach, fwe_attach),
655 DEVMETHOD(device_detach, fwe_detach),
659 static driver_t fwe_driver = {
662 sizeof(struct fwe_softc),
666 DECLARE_DUMMY_MODULE(fwe);
667 DRIVER_MODULE(fwe, firewire, fwe_driver, fwe_devclass, 0, 0);
668 MODULE_VERSION(fwe, 1);
669 MODULE_DEPEND(fwe, firewire, 1, 1, 1);