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>
60 #include <net/if_vlan_var.h>
62 #include <dev/firewire/firewire.h>
63 #include <dev/firewire/firewirereg.h>
64 #include <dev/firewire/if_fwevar.h>
66 #define FWEDEBUG if (fwedebug) if_printf
67 #define TX_MAX_QUEUE (FWMAXQUEUE - 1)
69 /* network interface */
70 static void fwe_start (struct ifnet *);
71 static int fwe_ioctl (struct ifnet *, u_long, caddr_t);
72 static void fwe_init (void *);
74 static void fwe_output_callback (struct fw_xfer *);
75 static void fwe_as_output (struct fwe_softc *, struct ifnet *);
76 static void fwe_as_input (struct fw_xferq *);
78 static int fwedebug = 0;
79 static int stream_ch = 1;
80 static int tx_speed = 2;
81 static int rx_queue_len = FWMAXQUEUE;
83 static MALLOC_DEFINE(M_FWE, "if_fwe", "Ethernet over FireWire interface");
84 SYSCTL_INT(_debug, OID_AUTO, if_fwe_debug, CTLFLAG_RWTUN, &fwedebug, 0, "");
85 SYSCTL_DECL(_hw_firewire);
86 static SYSCTL_NODE(_hw_firewire, OID_AUTO, fwe, CTLFLAG_RD, 0,
87 "Ethernet emulation subsystem");
88 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, stream_ch, CTLFLAG_RWTUN, &stream_ch, 0,
89 "Stream channel to use");
90 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, tx_speed, CTLFLAG_RWTUN, &tx_speed, 0,
91 "Transmission speed");
92 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, rx_queue_len, CTLFLAG_RWTUN, &rx_queue_len,
93 0, "Length of the receive queue");
96 static poll_handler_t fwe_poll;
99 fwe_poll(struct ifnet *ifp, enum poll_cmd cmd, int count)
101 struct fwe_softc *fwe;
102 struct firewire_comm *fc;
104 if (!(ifp->if_drv_flags & IFF_DRV_RUNNING))
107 fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
109 fc->poll(fc, (cmd == POLL_AND_CHECK_STATUS)?0:1, count);
112 #endif /* DEVICE_POLLING */
115 fwe_identify(driver_t *driver, device_t parent)
117 BUS_ADD_CHILD(parent, 0, "fwe", device_get_unit(parent));
121 fwe_probe(device_t dev)
125 pa = device_get_parent(dev);
126 if (device_get_unit(dev) != device_get_unit(pa)) {
130 device_set_desc(dev, "Ethernet over FireWire");
135 fwe_attach(device_t dev)
137 struct fwe_softc *fwe;
141 struct fw_eui64 *eui;
143 fwe = ((struct fwe_softc *)device_get_softc(dev));
144 unit = device_get_unit(dev);
146 bzero(fwe, sizeof(struct fwe_softc));
147 mtx_init(&fwe->mtx, "fwe", NULL, MTX_DEF);
149 fwe->stream_ch = stream_ch;
152 fwe->fd.fc = device_get_ivars(dev);
154 tx_speed = fwe->fd.fc->speed;
157 fwe->fd.post_explore = NULL;
158 fwe->eth_softc.fwe = fwe;
160 fwe->pkt_hdr.mode.stream.tcode = FWTCODE_STREAM;
161 fwe->pkt_hdr.mode.stream.sy = 0;
162 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch;
164 /* generate fake MAC address: first and last 3bytes from eui64 */
168 eui = &fwe->fd.fc->eui;
169 eaddr[0] = (FW_EUI64_BYTE(eui, 0) | LOCAL) & ~GROUP;
170 eaddr[1] = FW_EUI64_BYTE(eui, 1);
171 eaddr[2] = FW_EUI64_BYTE(eui, 2);
172 eaddr[3] = FW_EUI64_BYTE(eui, 5);
173 eaddr[4] = FW_EUI64_BYTE(eui, 6);
174 eaddr[5] = FW_EUI64_BYTE(eui, 7);
175 printf("if_fwe%d: Fake Ethernet address: "
176 "%02x:%02x:%02x:%02x:%02x:%02x\n", unit,
177 eaddr[0], eaddr[1], eaddr[2], eaddr[3], eaddr[4], eaddr[5]);
179 /* fill the rest and attach interface */
180 ifp = fwe->eth_softc.ifp = if_alloc(IFT_ETHER);
182 device_printf(dev, "can not if_alloc()\n");
185 ifp->if_softc = &fwe->eth_softc;
187 if_initname(ifp, device_get_name(dev), unit);
188 ifp->if_init = fwe_init;
189 ifp->if_start = fwe_start;
190 ifp->if_ioctl = fwe_ioctl;
191 ifp->if_flags = (IFF_BROADCAST|IFF_SIMPLEX|IFF_MULTICAST);
192 ifp->if_snd.ifq_maxlen = TX_MAX_QUEUE;
195 ether_ifattach(ifp, eaddr);
198 /* Tell the upper layer(s) we support long frames. */
199 ifp->if_hdrlen = sizeof(struct ether_vlan_header);
200 ifp->if_capabilities |= IFCAP_VLAN_MTU | IFCAP_POLLING;
201 ifp->if_capenable |= IFCAP_VLAN_MTU;
203 FWEDEBUG(ifp, "interface created\n");
208 fwe_stop(struct fwe_softc *fwe)
210 struct firewire_comm *fc;
211 struct fw_xferq *xferq;
212 struct ifnet *ifp = fwe->eth_softc.ifp;
213 struct fw_xfer *xfer, *next;
218 if (fwe->dma_ch >= 0) {
219 xferq = fc->ir[fwe->dma_ch];
221 if (xferq->flag & FWXFERQ_RUNNING)
222 fc->irx_disable(fc, fwe->dma_ch);
224 ~(FWXFERQ_MODEMASK | FWXFERQ_OPEN | FWXFERQ_STREAM |
225 FWXFERQ_EXTBUF | FWXFERQ_HANDLER | FWXFERQ_CHTAGMASK);
228 for (i = 0; i < xferq->bnchunk; i++)
229 m_freem(xferq->bulkxfer[i].mbuf);
230 free(xferq->bulkxfer, M_FWE);
232 for (xfer = STAILQ_FIRST(&fwe->xferlist); xfer != NULL;
234 next = STAILQ_NEXT(xfer, link);
237 STAILQ_INIT(&fwe->xferlist);
239 xferq->bulkxfer = NULL;
243 ifp->if_drv_flags &= ~(IFF_DRV_RUNNING | IFF_DRV_OACTIVE);
247 fwe_detach(device_t dev)
249 struct fwe_softc *fwe;
253 fwe = device_get_softc(dev);
254 ifp = fwe->eth_softc.ifp;
256 #ifdef DEVICE_POLLING
257 if (ifp->if_capenable & IFCAP_POLLING)
258 ether_poll_deregister(ifp);
267 mtx_destroy(&fwe->mtx);
274 struct fwe_softc *fwe = ((struct fwe_eth_softc *)arg)->fwe;
275 struct firewire_comm *fc;
276 struct ifnet *ifp = fwe->eth_softc.ifp;
277 struct fw_xferq *xferq;
278 struct fw_xfer *xfer;
282 FWEDEBUG(ifp, "initializing\n");
284 /* XXX keep promiscoud mode */
285 ifp->if_flags |= IFF_PROMISC;
288 if (fwe->dma_ch < 0) {
289 fwe->dma_ch = fw_open_isodma(fc, /* tx */0);
292 xferq = fc->ir[fwe->dma_ch];
293 xferq->flag |= FWXFERQ_EXTBUF |
294 FWXFERQ_HANDLER | FWXFERQ_STREAM;
295 fwe->stream_ch = stream_ch;
296 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch;
297 xferq->flag &= ~0xff;
298 xferq->flag |= fwe->stream_ch & 0xff;
299 /* register fwe_input handler */
300 xferq->sc = (caddr_t) fwe;
301 xferq->hand = fwe_as_input;
302 xferq->bnchunk = rx_queue_len;
304 xferq->psize = MCLBYTES;
307 xferq->bulkxfer = (struct fw_bulkxfer *) malloc(
308 sizeof(struct fw_bulkxfer) * xferq->bnchunk,
310 STAILQ_INIT(&xferq->stvalid);
311 STAILQ_INIT(&xferq->stfree);
312 STAILQ_INIT(&xferq->stdma);
313 xferq->stproc = NULL;
314 for (i = 0; i < xferq->bnchunk; i++) {
315 m = m_getcl(M_WAITOK, MT_DATA, M_PKTHDR);
316 xferq->bulkxfer[i].mbuf = m;
317 m->m_len = m->m_pkthdr.len = m->m_ext.ext_size;
318 STAILQ_INSERT_TAIL(&xferq->stfree,
319 &xferq->bulkxfer[i], link);
321 STAILQ_INIT(&fwe->xferlist);
322 for (i = 0; i < TX_MAX_QUEUE; i++) {
323 xfer = fw_xfer_alloc(M_FWE);
326 xfer->send.spd = tx_speed;
327 xfer->fc = fwe->fd.fc;
328 xfer->sc = (caddr_t)fwe;
329 xfer->hand = fwe_output_callback;
330 STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link);
333 xferq = fc->ir[fwe->dma_ch];
337 if ((xferq->flag & FWXFERQ_RUNNING) == 0)
338 fc->irx_enable(fc, fwe->dma_ch);
340 ifp->if_drv_flags |= IFF_DRV_RUNNING;
341 ifp->if_drv_flags &= ~IFF_DRV_OACTIVE;
344 /* attempt to start output */
351 fwe_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
353 struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
354 struct ifstat *ifs = NULL;
360 if (ifp->if_flags & IFF_UP) {
361 if (!(ifp->if_drv_flags & IFF_DRV_RUNNING))
362 fwe_init(&fwe->eth_softc);
364 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
367 /* XXX keep promiscoud mode */
368 ifp->if_flags |= IFF_PROMISC;
377 ifs = (struct ifstat *)data;
378 snprintf(ifs->ascii, sizeof(ifs->ascii),
379 "\tch %d dma %d\n", fwe->stream_ch, fwe->dma_ch);
383 #ifdef DEVICE_POLLING
385 struct ifreq *ifr = (struct ifreq *) data;
386 struct firewire_comm *fc = fwe->fd.fc;
388 if (ifr->ifr_reqcap & IFCAP_POLLING &&
389 !(ifp->if_capenable & IFCAP_POLLING)) {
390 error = ether_poll_register(fwe_poll, ifp);
393 /* Disable interrupts */
395 ifp->if_capenable |= IFCAP_POLLING;
396 ifp->if_capenable |= IFCAP_POLLING_NOCOUNT;
399 if (!(ifr->ifr_reqcap & IFCAP_POLLING) &&
400 ifp->if_capenable & IFCAP_POLLING) {
401 error = ether_poll_deregister(ifp);
402 /* Enable interrupts. */
404 ifp->if_capenable &= ~IFCAP_POLLING;
405 ifp->if_capenable &= ~IFCAP_POLLING_NOCOUNT;
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);