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.15 2005/05/25 01:44:23 dillon 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/ifq_var.h>
59 #include <net/vlan/if_vlan_var.h>
60 #include <bus/firewire/firewire.h>
61 #include <bus/firewire/firewirereg.h>
62 #include "if_fwevar.h"
64 #include <net/if_vlan_var.h>
66 #include <dev/firewire/firewire.h>
67 #include <dev/firewire/firewirereg.h>
68 #include <dev/firewire/if_fwevar.h>
71 #define FWEDEBUG if (fwedebug) if_printf
72 #define TX_MAX_QUEUE (FWMAXQUEUE - 1)
74 /* network interface */
75 static void fwe_start (struct ifnet *);
76 static int fwe_ioctl (struct ifnet *, u_long, caddr_t, struct ucred *);
77 static void fwe_init (void *);
79 static void fwe_output_callback (struct fw_xfer *);
80 static void fwe_as_output (struct fwe_softc *, struct ifnet *);
81 static void fwe_as_input (struct fw_xferq *);
83 static int fwedebug = 0;
84 static int stream_ch = 1;
85 static int tx_speed = 2;
86 static int rx_queue_len = FWMAXQUEUE;
88 MALLOC_DEFINE(M_FWE, "if_fwe", "Ethernet over FireWire interface");
89 SYSCTL_INT(_debug, OID_AUTO, if_fwe_debug, CTLFLAG_RW, &fwedebug, 0, "");
90 SYSCTL_DECL(_hw_firewire);
91 SYSCTL_NODE(_hw_firewire, OID_AUTO, fwe, CTLFLAG_RD, 0,
92 "Ethernet emulation subsystem");
93 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, stream_ch, CTLFLAG_RW, &stream_ch, 0,
94 "Stream channel to use");
95 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, tx_speed, CTLFLAG_RW, &tx_speed, 0,
96 "Transmission speed");
97 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, rx_queue_len, CTLFLAG_RW, &rx_queue_len,
98 0, "Length of the receive queue");
100 TUNABLE_INT("hw.firewire.fwe.stream_ch", &stream_ch);
101 TUNABLE_INT("hw.firewire.fwe.tx_speed", &tx_speed);
102 TUNABLE_INT("hw.firewire.fwe.rx_queue_len", &rx_queue_len);
104 #ifdef DEVICE_POLLING
107 fwe_poll(struct ifnet *ifp, enum poll_cmd cmd, int count)
109 struct fwe_softc *fwe;
110 struct firewire_comm *fc;
112 fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
116 /* disable interrupts */
119 case POLL_DEREGISTER:
120 /* enable interrupts */
124 fc->poll(fc, (cmd == POLL_AND_CHECK_STATUS)?0:1, count);
132 fwe_identify(driver_t *driver, device_t parent)
134 BUS_ADD_CHILD(parent, 0, "fwe", device_get_unit(parent));
138 fwe_probe(device_t dev)
142 pa = device_get_parent(dev);
143 if(device_get_unit(dev) != device_get_unit(pa)){
147 device_set_desc(dev, "Ethernet over FireWire");
152 fwe_attach(device_t dev)
154 struct fwe_softc *fwe;
158 struct fw_eui64 *eui;
160 fwe = ((struct fwe_softc *)device_get_softc(dev));
161 unit = device_get_unit(dev);
163 bzero(fwe, sizeof(struct fwe_softc));
165 fwe->stream_ch = stream_ch;
168 fwe->fd.fc = device_get_ivars(dev);
170 tx_speed = fwe->fd.fc->speed;
173 fwe->fd.post_explore = NULL;
174 fwe->eth_softc.fwe = fwe;
176 fwe->pkt_hdr.mode.stream.tcode = FWTCODE_STREAM;
177 fwe->pkt_hdr.mode.stream.sy = 0;
178 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch;
180 /* generate fake MAC address: first and last 3bytes from eui64 */
183 eaddr = &fwe->eth_softc.arpcom.ac_enaddr[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 */
198 ifp->if_softc = &fwe->eth_softc;
200 #if __FreeBSD_version >= 501113 || defined(__DragonFly__)
201 if_initname(ifp, device_get_name(dev), unit);
204 ifp->if_name = "fwe";
206 ifp->if_init = fwe_init;
207 ifp->if_start = fwe_start;
208 ifp->if_ioctl = fwe_ioctl;
209 #ifdef DEVICE_POLLING
210 ifp->if_poll = fwe_poll;
212 ifp->if_mtu = ETHERMTU;
213 ifp->if_flags = (IFF_BROADCAST|IFF_SIMPLEX|IFF_MULTICAST);
214 ifq_set_maxlen(&ifp->if_snd, TX_MAX_QUEUE);
215 ifq_set_ready(&ifp->if_snd);
218 ether_ifattach(ifp, eaddr);
221 /* Tell the upper layer(s) we support long frames. */
222 ifp->if_data.ifi_hdrlen = sizeof(struct ether_vlan_header);
223 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
224 ifp->if_capabilities |= IFCAP_VLAN_MTU;
228 FWEDEBUG(ifp, "interface created\n");
233 fwe_stop(struct fwe_softc *fwe)
235 struct firewire_comm *fc;
236 struct fw_xferq *xferq;
237 struct ifnet *ifp = &fwe->fwe_if;
238 struct fw_xfer *xfer, *next;
243 ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
245 if (fwe->dma_ch >= 0) {
246 xferq = fc->ir[fwe->dma_ch];
248 if (xferq->flag & FWXFERQ_RUNNING)
249 fc->irx_disable(fc, fwe->dma_ch);
251 ~(FWXFERQ_MODEMASK | FWXFERQ_OPEN | FWXFERQ_STREAM |
252 FWXFERQ_EXTBUF | FWXFERQ_HANDLER | FWXFERQ_CHTAGMASK);
255 for (i = 0; i < xferq->bnchunk; i ++)
256 m_freem(xferq->bulkxfer[i].mbuf);
257 free(xferq->bulkxfer, M_FWE);
259 for (xfer = STAILQ_FIRST(&fwe->xferlist); xfer != NULL;
261 next = STAILQ_NEXT(xfer, link);
264 STAILQ_INIT(&fwe->xferlist);
266 xferq->bulkxfer = NULL;
272 fwe_detach(device_t dev)
274 struct fwe_softc *fwe;
277 fwe = (struct fwe_softc *)device_get_softc(dev);
281 ether_ifdetach(&fwe->fwe_if);
290 struct fwe_softc *fwe = ((struct fwe_eth_softc *)arg)->fwe;
291 struct firewire_comm *fc;
292 struct ifnet *ifp = &fwe->fwe_if;
293 struct fw_xferq *xferq;
294 struct fw_xfer *xfer;
298 FWEDEBUG(ifp, "initializing\n");
300 /* XXX keep promiscoud mode */
301 ifp->if_flags |= IFF_PROMISC;
305 if (fwe->dma_ch < 0) {
306 for (i = START; i < fc->nisodma; i ++) {
308 if ((xferq->flag & FWXFERQ_OPEN) == 0)
311 printf("no free dma channel\n");
315 fwe->stream_ch = stream_ch;
316 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch;
317 /* allocate DMA channel and init packet mode */
318 xferq->flag |= FWXFERQ_OPEN | FWXFERQ_EXTBUF |
319 FWXFERQ_HANDLER | FWXFERQ_STREAM;
320 xferq->flag &= ~0xff;
321 xferq->flag |= fwe->stream_ch & 0xff;
322 /* register fwe_input handler */
323 xferq->sc = (caddr_t) fwe;
324 xferq->hand = fwe_as_input;
325 xferq->bnchunk = rx_queue_len;
327 xferq->psize = MCLBYTES;
330 xferq->bulkxfer = (struct fw_bulkxfer *) malloc(
331 sizeof(struct fw_bulkxfer) * xferq->bnchunk,
333 if (xferq->bulkxfer == NULL) {
334 printf("if_fwe: malloc failed\n");
337 STAILQ_INIT(&xferq->stvalid);
338 STAILQ_INIT(&xferq->stfree);
339 STAILQ_INIT(&xferq->stdma);
340 xferq->stproc = NULL;
341 for (i = 0; i < xferq->bnchunk; i ++) {
343 #if defined(__DragonFly__)
344 m_getcl(MB_WAIT, MT_DATA, M_PKTHDR);
345 #elif __FreeBSD_version < 500000
346 m_getcl(M_WAIT, MT_DATA, M_PKTHDR);
348 m_getcl(M_TRYWAIT, MT_DATA, M_PKTHDR);
350 xferq->bulkxfer[i].mbuf = m;
352 m->m_len = m->m_pkthdr.len = m->m_ext.ext_size;
353 STAILQ_INSERT_TAIL(&xferq->stfree,
354 &xferq->bulkxfer[i], link);
356 printf("fwe_as_input: m_getcl failed\n");
358 STAILQ_INIT(&fwe->xferlist);
359 for (i = 0; i < TX_MAX_QUEUE; i++) {
360 xfer = fw_xfer_alloc(M_FWE);
363 xfer->send.spd = tx_speed;
364 xfer->fc = fwe->fd.fc;
365 xfer->retry_req = fw_asybusy;
366 xfer->sc = (caddr_t)fwe;
367 xfer->act.hand = fwe_output_callback;
368 STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link);
371 xferq = fc->ir[fwe->dma_ch];
375 if ((xferq->flag & FWXFERQ_RUNNING) == 0)
376 fc->irx_enable(fc, fwe->dma_ch);
378 ifp->if_flags |= IFF_RUNNING;
379 ifp->if_flags &= ~IFF_OACTIVE;
384 fwe_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data, struct ucred *cr)
386 struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
387 struct ifstat *ifs = NULL;
393 if (ifp->if_flags & IFF_UP) {
394 if (!(ifp->if_flags & IFF_RUNNING))
395 fwe_init(&fwe->eth_softc);
397 if (ifp->if_flags & IFF_RUNNING)
400 /* XXX keep promiscoud mode */
401 ifp->if_flags |= IFF_PROMISC;
410 ifs = (struct ifstat *)data;
411 len = strlen(ifs->ascii);
412 if (len < sizeof(ifs->ascii))
413 snprintf(ifs->ascii + len,
414 sizeof(ifs->ascii) - len,
416 fwe->stream_ch, fwe->dma_ch);
419 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
427 error = ether_ioctl(ifp, cmd, data);
430 #if defined(__DragonFly__) || __FreeBSD_version < 500000
440 fwe_output_callback(struct fw_xfer *xfer)
442 struct fwe_softc *fwe;
446 fwe = (struct fwe_softc *)xfer->sc;
448 /* XXX error check */
449 FWEDEBUG(ifp, "resp = %d\n", xfer->resp);
454 fw_xfer_unload(xfer);
457 STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link);
461 if (!ifq_is_empty(&ifp->if_snd))
466 fwe_start(struct ifnet *ifp)
468 struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
471 FWEDEBUG(ifp, "starting\n");
473 if (fwe->dma_ch < 0) {
474 FWEDEBUG(ifp, "not ready\n");
477 ifq_purge(&ifp->if_snd);
484 ifp->if_flags |= IFF_OACTIVE;
486 if (!ifq_is_empty(&ifp->if_snd))
487 fwe_as_output(fwe, ifp);
489 ifp->if_flags &= ~IFF_OACTIVE;
495 #define ETHER_ALIGN 2
497 /* Async. stream output */
499 fwe_as_output(struct fwe_softc *fwe, struct ifnet *ifp)
502 struct fw_xfer *xfer;
503 struct fw_xferq *xferq;
508 xferq = fwe->fd.fc->atq;
509 while (xferq->queued < xferq->maxq - 1) {
510 xfer = STAILQ_FIRST(&fwe->xferlist);
512 printf("if_fwe: lack of xfer\n");
515 m = ifq_dequeue(&ifp->if_snd);
518 STAILQ_REMOVE_HEAD(&fwe->xferlist, link);
521 /* keep ip packet alignment for alpha */
522 M_PREPEND(m, ETHER_ALIGN, MB_DONTWAIT);
523 fp = &xfer->send.hdr;
524 *(u_int32_t *)&xfer->send.hdr = *(int32_t *)&fwe->pkt_hdr;
525 fp->mode.stream.len = m->m_pkthdr.len;
527 xfer->send.pay_len = m->m_pkthdr.len;
529 if (fw_asyreq(fwe->fd.fc, -1, xfer) != 0) {
532 /* XXX set error code */
533 fwe_output_callback(xfer);
541 printf("%d queued\n", i);
544 xferq->start(fwe->fd.fc);
547 /* Async. stream output */
549 fwe_as_input(struct fw_xferq *xferq)
553 struct fwe_softc *fwe;
554 struct fw_bulkxfer *sxfer;
558 fwe = (struct fwe_softc *)xferq->sc;
560 while ((sxfer = STAILQ_FIRST(&xferq->stvalid)) != NULL) {
561 STAILQ_REMOVE_HEAD(&xferq->stvalid, link);
562 fp = mtod(sxfer->mbuf, struct fw_pkt *);
563 if (fwe->fd.fc->irx_post != NULL)
564 fwe->fd.fc->irx_post(fwe->fd.fc, fp->mode.ld);
567 /* insert new rbuf */
568 sxfer->mbuf = m0 = m_getcl(MB_DONTWAIT, MT_DATA, M_PKTHDR);
570 m0->m_len = m0->m_pkthdr.len = m0->m_ext.ext_size;
571 STAILQ_INSERT_TAIL(&xferq->stfree, sxfer, link);
573 printf("fwe_as_input: m_getcl failed\n");
575 if (sxfer->resp != 0 || fp->mode.stream.len <
576 ETHER_ALIGN + sizeof(struct ether_header)) {
582 m->m_data += HDR_LEN + ETHER_ALIGN;
584 m->m_len = m->m_pkthdr.len =
585 fp->mode.stream.len - ETHER_ALIGN;
586 m->m_pkthdr.rcvif = ifp;
588 FWEDEBUG(ifp, "%02x %02x %02x %02x %02x %02x\n"
589 "%02x %02x %02x %02x %02x %02x\n"
590 "%02x %02x %02x %02x\n"
591 "%02x %02x %02x %02x\n"
592 "%02x %02x %02x %02x\n"
593 "%02x %02x %02x %02x\n",
594 c[0], c[1], c[2], c[3], c[4], c[5],
595 c[6], c[7], c[8], c[9], c[10], c[11],
596 c[12], c[13], c[14], c[15],
597 c[16], c[17], c[18], c[19],
598 c[20], c[21], c[22], c[23],
599 c[20], c[21], c[22], c[23]
602 (*ifp->if_input)(ifp, m);
605 if (STAILQ_FIRST(&xferq->stfree) != NULL)
606 fwe->fd.fc->irx_enable(fwe->fd.fc, fwe->dma_ch);
610 static devclass_t fwe_devclass;
612 static device_method_t fwe_methods[] = {
613 /* device interface */
614 DEVMETHOD(device_identify, fwe_identify),
615 DEVMETHOD(device_probe, fwe_probe),
616 DEVMETHOD(device_attach, fwe_attach),
617 DEVMETHOD(device_detach, fwe_detach),
621 static driver_t fwe_driver = {
624 sizeof(struct fwe_softc),
628 DECLARE_DUMMY_MODULE(fwe);
629 DRIVER_MODULE(fwe, firewire, fwe_driver, fwe_devclass, 0, 0);
630 MODULE_VERSION(fwe, 1);
631 MODULE_DEPEND(fwe, firewire, 1, 1, 1);