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.14 2005/02/18 23:10:27 joerg 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
105 #define FWE_POLL_REGISTER(func, fwe, ifp) \
106 if (ether_poll_register(func, ifp)) { \
107 struct firewire_comm *fc = (fwe)->fd.fc; \
108 fc->set_intr(fc, 0); \
111 #define FWE_POLL_DEREGISTER(fwe, ifp) \
113 struct firewire_comm *fc = (fwe)->fd.fc; \
114 ether_poll_deregister(ifp); \
115 fc->set_intr(fc, 1); \
118 static poll_handler_t fwe_poll;
121 fwe_poll(struct ifnet *ifp, enum poll_cmd cmd, int count)
123 struct fwe_softc *fwe;
124 struct firewire_comm *fc;
126 fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
128 if (cmd == POLL_DEREGISTER) {
129 /* enable interrupts */
133 fc->poll(fc, (cmd == POLL_AND_CHECK_STATUS)?0:1, count);
136 #define FWE_POLL_REGISTER(func, fwe, ifp)
137 #define FWE_POLL_DEREGISTER(fwe, ifp)
140 fwe_identify(driver_t *driver, device_t parent)
142 BUS_ADD_CHILD(parent, 0, "fwe", device_get_unit(parent));
146 fwe_probe(device_t dev)
150 pa = device_get_parent(dev);
151 if(device_get_unit(dev) != device_get_unit(pa)){
155 device_set_desc(dev, "Ethernet over FireWire");
160 fwe_attach(device_t dev)
162 struct fwe_softc *fwe;
166 struct fw_eui64 *eui;
168 fwe = ((struct fwe_softc *)device_get_softc(dev));
169 unit = device_get_unit(dev);
171 bzero(fwe, sizeof(struct fwe_softc));
173 fwe->stream_ch = stream_ch;
176 fwe->fd.fc = device_get_ivars(dev);
178 tx_speed = fwe->fd.fc->speed;
181 fwe->fd.post_explore = NULL;
182 fwe->eth_softc.fwe = fwe;
184 fwe->pkt_hdr.mode.stream.tcode = FWTCODE_STREAM;
185 fwe->pkt_hdr.mode.stream.sy = 0;
186 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch;
188 /* generate fake MAC address: first and last 3bytes from eui64 */
191 eaddr = &fwe->eth_softc.arpcom.ac_enaddr[0];
193 eui = &fwe->fd.fc->eui;
194 eaddr[0] = (FW_EUI64_BYTE(eui, 0) | LOCAL) & ~GROUP;
195 eaddr[1] = FW_EUI64_BYTE(eui, 1);
196 eaddr[2] = FW_EUI64_BYTE(eui, 2);
197 eaddr[3] = FW_EUI64_BYTE(eui, 5);
198 eaddr[4] = FW_EUI64_BYTE(eui, 6);
199 eaddr[5] = FW_EUI64_BYTE(eui, 7);
200 printf("if_fwe%d: Fake Ethernet address: "
201 "%02x:%02x:%02x:%02x:%02x:%02x\n", unit,
202 eaddr[0], eaddr[1], eaddr[2], eaddr[3], eaddr[4], eaddr[5]);
204 /* fill the rest and attach interface */
206 ifp->if_softc = &fwe->eth_softc;
208 #if __FreeBSD_version >= 501113 || defined(__DragonFly__)
209 if_initname(ifp, device_get_name(dev), unit);
212 ifp->if_name = "fwe";
214 ifp->if_init = fwe_init;
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 ifq_set_maxlen(&ifp->if_snd, TX_MAX_QUEUE);
220 ifq_set_ready(&ifp->if_snd);
223 ether_ifattach(ifp, eaddr);
226 /* Tell the upper layer(s) we support long frames. */
227 ifp->if_data.ifi_hdrlen = sizeof(struct ether_vlan_header);
228 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
229 ifp->if_capabilities |= IFCAP_VLAN_MTU;
233 FWEDEBUG(ifp, "interface created\n");
238 fwe_stop(struct fwe_softc *fwe)
240 struct firewire_comm *fc;
241 struct fw_xferq *xferq;
242 struct ifnet *ifp = &fwe->fwe_if;
243 struct fw_xfer *xfer, *next;
248 FWE_POLL_DEREGISTER(fwe, ifp);
250 if (fwe->dma_ch >= 0) {
251 xferq = fc->ir[fwe->dma_ch];
253 if (xferq->flag & FWXFERQ_RUNNING)
254 fc->irx_disable(fc, fwe->dma_ch);
256 ~(FWXFERQ_MODEMASK | FWXFERQ_OPEN | FWXFERQ_STREAM |
257 FWXFERQ_EXTBUF | FWXFERQ_HANDLER | FWXFERQ_CHTAGMASK);
260 for (i = 0; i < xferq->bnchunk; i ++)
261 m_freem(xferq->bulkxfer[i].mbuf);
262 free(xferq->bulkxfer, M_FWE);
264 for (xfer = STAILQ_FIRST(&fwe->xferlist); xfer != NULL;
266 next = STAILQ_NEXT(xfer, link);
269 STAILQ_INIT(&fwe->xferlist);
271 xferq->bulkxfer = NULL;
275 ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
279 fwe_detach(device_t dev)
281 struct fwe_softc *fwe;
284 fwe = (struct fwe_softc *)device_get_softc(dev);
288 ether_ifdetach(&fwe->fwe_if);
297 struct fwe_softc *fwe = ((struct fwe_eth_softc *)arg)->fwe;
298 struct firewire_comm *fc;
299 struct ifnet *ifp = &fwe->fwe_if;
300 struct fw_xferq *xferq;
301 struct fw_xfer *xfer;
305 FWEDEBUG(ifp, "initializing\n");
307 /* XXX keep promiscoud mode */
308 ifp->if_flags |= IFF_PROMISC;
312 if (fwe->dma_ch < 0) {
313 for (i = START; i < fc->nisodma; i ++) {
315 if ((xferq->flag & FWXFERQ_OPEN) == 0)
318 printf("no free dma channel\n");
322 fwe->stream_ch = stream_ch;
323 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch;
324 /* allocate DMA channel and init packet mode */
325 xferq->flag |= FWXFERQ_OPEN | FWXFERQ_EXTBUF |
326 FWXFERQ_HANDLER | FWXFERQ_STREAM;
327 xferq->flag &= ~0xff;
328 xferq->flag |= fwe->stream_ch & 0xff;
329 /* register fwe_input handler */
330 xferq->sc = (caddr_t) fwe;
331 xferq->hand = fwe_as_input;
332 xferq->bnchunk = rx_queue_len;
334 xferq->psize = MCLBYTES;
337 xferq->bulkxfer = (struct fw_bulkxfer *) malloc(
338 sizeof(struct fw_bulkxfer) * xferq->bnchunk,
340 if (xferq->bulkxfer == NULL) {
341 printf("if_fwe: malloc failed\n");
344 STAILQ_INIT(&xferq->stvalid);
345 STAILQ_INIT(&xferq->stfree);
346 STAILQ_INIT(&xferq->stdma);
347 xferq->stproc = NULL;
348 for (i = 0; i < xferq->bnchunk; i ++) {
350 #if defined(__DragonFly__)
351 m_getcl(MB_WAIT, MT_DATA, M_PKTHDR);
352 #elif __FreeBSD_version < 500000
353 m_getcl(M_WAIT, MT_DATA, M_PKTHDR);
355 m_getcl(M_TRYWAIT, MT_DATA, M_PKTHDR);
357 xferq->bulkxfer[i].mbuf = m;
359 m->m_len = m->m_pkthdr.len = m->m_ext.ext_size;
360 STAILQ_INSERT_TAIL(&xferq->stfree,
361 &xferq->bulkxfer[i], link);
363 printf("fwe_as_input: m_getcl failed\n");
365 STAILQ_INIT(&fwe->xferlist);
366 for (i = 0; i < TX_MAX_QUEUE; i++) {
367 xfer = fw_xfer_alloc(M_FWE);
370 xfer->send.spd = tx_speed;
371 xfer->fc = fwe->fd.fc;
372 xfer->retry_req = fw_asybusy;
373 xfer->sc = (caddr_t)fwe;
374 xfer->act.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 ifp->if_flags |= IFF_RUNNING;
386 ifp->if_flags &= ~IFF_OACTIVE;
388 FWE_POLL_REGISTER(fwe_poll, fwe, ifp);
390 /* attempt to start output */
397 fwe_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data, struct ucred *cr)
399 struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
400 struct ifstat *ifs = NULL;
406 if (ifp->if_flags & IFF_UP) {
407 if (!(ifp->if_flags & IFF_RUNNING))
408 fwe_init(&fwe->eth_softc);
410 if (ifp->if_flags & IFF_RUNNING)
413 /* XXX keep promiscoud mode */
414 ifp->if_flags |= IFF_PROMISC;
423 ifs = (struct ifstat *)data;
424 len = strlen(ifs->ascii);
425 if (len < sizeof(ifs->ascii))
426 snprintf(ifs->ascii + len,
427 sizeof(ifs->ascii) - len,
429 fwe->stream_ch, fwe->dma_ch);
432 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
440 error = ether_ioctl(ifp, cmd, data);
443 #if defined(__DragonFly__) || __FreeBSD_version < 500000
453 fwe_output_callback(struct fw_xfer *xfer)
455 struct fwe_softc *fwe;
459 fwe = (struct fwe_softc *)xfer->sc;
461 /* XXX error check */
462 FWEDEBUG(ifp, "resp = %d\n", xfer->resp);
467 fw_xfer_unload(xfer);
470 STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link);
474 if (!ifq_is_empty(&ifp->if_snd))
479 fwe_start(struct ifnet *ifp)
481 struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
484 FWEDEBUG(ifp, "starting\n");
486 if (fwe->dma_ch < 0) {
487 FWEDEBUG(ifp, "not ready\n");
490 ifq_purge(&ifp->if_snd);
497 ifp->if_flags |= IFF_OACTIVE;
499 if (!ifq_is_empty(&ifp->if_snd))
500 fwe_as_output(fwe, ifp);
502 ifp->if_flags &= ~IFF_OACTIVE;
508 #define ETHER_ALIGN 2
510 /* Async. stream output */
512 fwe_as_output(struct fwe_softc *fwe, struct ifnet *ifp)
515 struct fw_xfer *xfer;
516 struct fw_xferq *xferq;
521 xferq = fwe->fd.fc->atq;
522 while (xferq->queued < xferq->maxq - 1) {
523 xfer = STAILQ_FIRST(&fwe->xferlist);
525 printf("if_fwe: lack of xfer\n");
528 m = ifq_dequeue(&ifp->if_snd);
531 STAILQ_REMOVE_HEAD(&fwe->xferlist, link);
534 /* keep ip packet alignment for alpha */
535 M_PREPEND(m, ETHER_ALIGN, MB_DONTWAIT);
536 fp = &xfer->send.hdr;
537 *(u_int32_t *)&xfer->send.hdr = *(int32_t *)&fwe->pkt_hdr;
538 fp->mode.stream.len = m->m_pkthdr.len;
540 xfer->send.pay_len = m->m_pkthdr.len;
542 if (fw_asyreq(fwe->fd.fc, -1, xfer) != 0) {
545 /* XXX set error code */
546 fwe_output_callback(xfer);
554 printf("%d queued\n", i);
557 xferq->start(fwe->fd.fc);
560 /* Async. stream output */
562 fwe_as_input(struct fw_xferq *xferq)
566 struct fwe_softc *fwe;
567 struct fw_bulkxfer *sxfer;
571 fwe = (struct fwe_softc *)xferq->sc;
574 FWE_POLL_REGISTER(fwe_poll, fwe, ifp);
576 while ((sxfer = STAILQ_FIRST(&xferq->stvalid)) != NULL) {
577 STAILQ_REMOVE_HEAD(&xferq->stvalid, link);
578 fp = mtod(sxfer->mbuf, struct fw_pkt *);
579 if (fwe->fd.fc->irx_post != NULL)
580 fwe->fd.fc->irx_post(fwe->fd.fc, fp->mode.ld);
583 /* insert new rbuf */
584 sxfer->mbuf = m0 = m_getcl(MB_DONTWAIT, MT_DATA, M_PKTHDR);
586 m0->m_len = m0->m_pkthdr.len = m0->m_ext.ext_size;
587 STAILQ_INSERT_TAIL(&xferq->stfree, sxfer, link);
589 printf("fwe_as_input: m_getcl failed\n");
591 if (sxfer->resp != 0 || fp->mode.stream.len <
592 ETHER_ALIGN + sizeof(struct ether_header)) {
598 m->m_data += HDR_LEN + ETHER_ALIGN;
600 m->m_len = m->m_pkthdr.len =
601 fp->mode.stream.len - ETHER_ALIGN;
602 m->m_pkthdr.rcvif = ifp;
604 FWEDEBUG(ifp, "%02x %02x %02x %02x %02x %02x\n"
605 "%02x %02x %02x %02x %02x %02x\n"
606 "%02x %02x %02x %02x\n"
607 "%02x %02x %02x %02x\n"
608 "%02x %02x %02x %02x\n"
609 "%02x %02x %02x %02x\n",
610 c[0], c[1], c[2], c[3], c[4], c[5],
611 c[6], c[7], c[8], c[9], c[10], c[11],
612 c[12], c[13], c[14], c[15],
613 c[16], c[17], c[18], c[19],
614 c[20], c[21], c[22], c[23],
615 c[20], c[21], c[22], c[23]
618 (*ifp->if_input)(ifp, m);
621 if (STAILQ_FIRST(&xferq->stfree) != NULL)
622 fwe->fd.fc->irx_enable(fwe->fd.fc, fwe->dma_ch);
626 static devclass_t fwe_devclass;
628 static device_method_t fwe_methods[] = {
629 /* device interface */
630 DEVMETHOD(device_identify, fwe_identify),
631 DEVMETHOD(device_probe, fwe_probe),
632 DEVMETHOD(device_attach, fwe_attach),
633 DEVMETHOD(device_detach, fwe_detach),
637 static driver_t fwe_driver = {
640 sizeof(struct fwe_softc),
644 DECLARE_DUMMY_MODULE(fwe);
645 DRIVER_MODULE(fwe, firewire, fwe_driver, fwe_devclass, 0, 0);
646 MODULE_VERSION(fwe, 1);
647 MODULE_DEPEND(fwe, firewire, 1, 1, 1);