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 $
38 #include "opt_ifpoll.h"
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 <sys/thread2.h>
54 #include <net/ethernet.h>
56 #include <net/if_arp.h>
58 #include <net/ifq_var.h>
59 #include <net/if_poll.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 *, struct ifaltq_subque *);
77 static int fwe_ioctl (struct ifnet *, u_long, caddr_t, struct ucred *);
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 MALLOC_DEFINE(M_FWE, "if_fwe", "Ethernet over FireWire interface");
90 SYSCTL_INT(_debug, OID_AUTO, if_fwe_debug, CTLFLAG_RW, &fwedebug, 0,
91 "Enable debug output");
92 SYSCTL_DECL(_hw_firewire);
93 SYSCTL_NODE(_hw_firewire, OID_AUTO, fwe, CTLFLAG_RD, 0,
94 "Ethernet emulation subsystem");
95 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, stream_ch, CTLFLAG_RW, &stream_ch, 0,
96 "Stream channel to use");
97 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, tx_speed, CTLFLAG_RW, &tx_speed, 0,
98 "Transmission speed");
99 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, rx_queue_len, CTLFLAG_RW, &rx_queue_len,
100 0, "Length of the receive queue");
102 TUNABLE_INT("hw.firewire.fwe.stream_ch", &stream_ch);
103 TUNABLE_INT("hw.firewire.fwe.tx_speed", &tx_speed);
104 TUNABLE_INT("hw.firewire.fwe.rx_queue_len", &rx_queue_len);
109 fwe_npoll_compat(struct ifnet *ifp, void *arg __unused, int count)
111 struct fwe_softc *fwe;
112 struct firewire_comm *fc;
113 int check_status = 0;
115 ASSERT_SERIALIZED(ifp->if_serializer);
117 fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
120 if (fwe->npoll.ifpc_stcount-- == 0) {
121 fwe->npoll.ifpc_stcount = fwe->npoll.ifpc_stfrac;
124 fc->poll(fc, check_status?0:1, count);
128 fwe_npoll(struct ifnet *ifp, struct ifpoll_info *info)
130 struct fwe_softc *fwe;
131 struct firewire_comm *fc;
133 ASSERT_SERIALIZED(ifp->if_serializer);
135 fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
139 int cpuid = fwe->npoll.ifpc_cpuid;
141 info->ifpi_rx[cpuid].poll_func = fwe_npoll_compat;
142 info->ifpi_rx[cpuid].arg = NULL;
143 info->ifpi_rx[cpuid].serializer = ifp->if_serializer;
145 if (ifp->if_flags & IFF_RUNNING) {
146 /* disable interrupts */
148 fwe->npoll.ifpc_stcount = 0;
150 ifq_set_cpuid(&ifp->if_snd, cpuid);
152 if (ifp->if_flags & IFF_RUNNING) {
153 /* enable interrupts */
156 ifq_set_cpuid(&ifp->if_snd, 0 /* XXX */);
160 #endif /* IFPOLL_ENABLE */
163 fwe_probe(device_t dev)
167 pa = device_get_parent(dev);
168 if(device_get_unit(dev) != device_get_unit(pa)){
172 device_set_desc(dev, "Ethernet over FireWire");
177 fwe_attach(device_t dev)
179 struct fwe_softc *fwe;
181 uint8_t eaddr[ETHER_ADDR_LEN];
182 struct fw_eui64 *eui;
184 fwe = ((struct fwe_softc *)device_get_softc(dev));
187 fwe->stream_ch = stream_ch;
190 fwe->fd.fc = device_get_ivars(dev);
192 tx_speed = fwe->fd.fc->speed;
195 fwe->fd.post_explore = NULL;
196 fwe->eth_softc.fwe = fwe;
198 fwe->pkt_hdr.mode.stream.tcode = FWTCODE_STREAM;
199 fwe->pkt_hdr.mode.stream.sy = 0;
200 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch;
202 /* generate fake MAC address: first and last 3bytes from eui64 */
206 eui = &fwe->fd.fc->eui;
207 eaddr[0] = (FW_EUI64_BYTE(eui, 0) | LOCAL) & ~GROUP;
208 eaddr[1] = FW_EUI64_BYTE(eui, 1);
209 eaddr[2] = FW_EUI64_BYTE(eui, 2);
210 eaddr[3] = FW_EUI64_BYTE(eui, 5);
211 eaddr[4] = FW_EUI64_BYTE(eui, 6);
212 eaddr[5] = FW_EUI64_BYTE(eui, 7);
214 /* fill the rest and attach interface */
216 ifp->if_softc = &fwe->eth_softc;
218 if_initname(ifp, device_get_name(dev), device_get_unit(dev));
219 ifp->if_init = fwe_init;
220 ifp->if_start = fwe_start;
221 ifp->if_ioctl = fwe_ioctl;
222 ifp->if_capabilities = IFCAP_VLAN_MTU;
224 ifp->if_npoll = fwe_npoll;
226 ifp->if_mtu = ETHERMTU;
227 ifp->if_flags = (IFF_BROADCAST|IFF_SIMPLEX|IFF_MULTICAST);
228 ifq_set_maxlen(&ifp->if_snd, TX_MAX_QUEUE);
229 ifq_set_ready(&ifp->if_snd);
231 ether_ifattach(ifp, eaddr, NULL);
233 /* Tell the upper layer(s) we support long frames. */
234 ifp->if_data.ifi_hdrlen = sizeof(struct ether_vlan_header);
237 ifpoll_compat_setup(&fwe->npoll, NULL, NULL, device_get_unit(dev),
241 FWEDEBUG(ifp, "interface created\n");
246 fwe_stop(struct fwe_softc *fwe)
248 struct firewire_comm *fc;
249 struct fw_xferq *xferq;
250 struct ifnet *ifp = &fwe->fwe_if;
251 struct fw_xfer *xfer, *next;
256 ifp->if_flags &= ~IFF_RUNNING;
257 ifq_clr_oactive(&ifp->if_snd);
259 if (fwe->dma_ch >= 0) {
260 xferq = fc->ir[fwe->dma_ch];
262 if (xferq->flag & FWXFERQ_RUNNING)
263 fc->irx_disable(fc, fwe->dma_ch);
265 ~(FWXFERQ_MODEMASK | FWXFERQ_OPEN | FWXFERQ_STREAM |
266 FWXFERQ_EXTBUF | FWXFERQ_HANDLER | FWXFERQ_CHTAGMASK);
269 for (i = 0; i < xferq->bnchunk; i ++)
270 m_freem(xferq->bulkxfer[i].mbuf);
271 kfree(xferq->bulkxfer, M_FWE);
273 for (xfer = STAILQ_FIRST(&fwe->xferlist); xfer != NULL;
275 next = STAILQ_NEXT(xfer, link);
278 STAILQ_INIT(&fwe->xferlist);
280 xferq->bulkxfer = NULL;
286 fwe_detach(device_t dev)
288 struct fwe_softc *fwe = device_get_softc(dev);
290 lwkt_serialize_enter(fwe->fwe_if.if_serializer);
292 lwkt_serialize_exit(fwe->fwe_if.if_serializer);
294 ether_ifdetach(&fwe->fwe_if);
301 struct fwe_softc *fwe = ((struct fwe_eth_softc *)arg)->fwe;
302 struct firewire_comm *fc;
303 struct ifnet *ifp = &fwe->fwe_if;
304 struct fw_xferq *xferq;
305 struct fw_xfer *xfer;
309 FWEDEBUG(ifp, "initializing\n");
311 /* XXX keep promiscoud mode */
312 ifp->if_flags |= IFF_PROMISC;
316 if (fwe->dma_ch < 0) {
317 for (i = START; i < fc->nisodma; i ++) {
319 if ((xferq->flag & FWXFERQ_OPEN) == 0)
322 if_printf(ifp, "no free dma channel\n");
326 fwe->stream_ch = stream_ch;
327 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch;
328 /* allocate DMA channel and init packet mode */
329 xferq->flag |= FWXFERQ_OPEN | FWXFERQ_EXTBUF |
330 FWXFERQ_HANDLER | FWXFERQ_STREAM;
331 xferq->flag &= ~0xff;
332 xferq->flag |= fwe->stream_ch & 0xff;
333 /* register fwe_input handler */
334 xferq->sc = (caddr_t) fwe;
335 xferq->hand = fwe_as_input;
336 xferq->bnchunk = rx_queue_len;
338 xferq->psize = MCLBYTES;
341 xferq->bulkxfer = (struct fw_bulkxfer *) kmalloc(
342 sizeof(struct fw_bulkxfer) * xferq->bnchunk,
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 ++) {
349 m = m_getcl(MB_WAIT, 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 if_printf(ifp, "fwe_init: m_getcl failed\n");
359 STAILQ_INIT(&fwe->xferlist);
360 for (i = 0; i < TX_MAX_QUEUE; i++) {
361 xfer = fw_xfer_alloc(M_FWE);
364 xfer->send.spd = tx_speed;
365 xfer->fc = fwe->fd.fc;
366 xfer->retry_req = fw_asybusy;
367 xfer->sc = (caddr_t)fwe;
368 xfer->act.hand = fwe_output_callback;
369 STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link);
372 xferq = fc->ir[fwe->dma_ch];
375 /* Disable interrupt, if polling(4) is enabled */
376 if (ifp->if_flags & IFF_NPOLLING) {
378 fwe->npoll.ifpc_stcount = 0;
384 if ((xferq->flag & FWXFERQ_RUNNING) == 0)
385 fc->irx_enable(fc, fwe->dma_ch);
387 ifp->if_flags |= IFF_RUNNING;
388 ifq_clr_oactive(&ifp->if_snd);
393 fwe_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data, struct ucred *cr)
395 struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
396 struct ifstat *ifs = NULL;
401 if (ifp->if_flags & IFF_UP) {
402 if (!(ifp->if_flags & IFF_RUNNING))
403 fwe_init(&fwe->eth_softc);
405 if (ifp->if_flags & IFF_RUNNING)
408 /* XXX keep promiscoud mode */
409 ifp->if_flags |= IFF_PROMISC;
416 ifs = (struct ifstat *)data;
417 len = strlen(ifs->ascii);
418 if (len < sizeof(ifs->ascii))
419 ksnprintf(ifs->ascii + len,
420 sizeof(ifs->ascii) - len,
422 fwe->stream_ch, fwe->dma_ch);
425 error = ether_ioctl(ifp, cmd, data);
432 fwe_output_callback(struct fw_xfer *xfer)
434 struct fwe_softc *fwe;
437 fwe = (struct fwe_softc *)xfer->sc;
439 lwkt_serialize_enter(ifp->if_serializer);
440 /* XXX error check */
441 FWEDEBUG(ifp, "resp = %d\n", xfer->resp);
443 IFNET_STAT_INC(ifp, oerrors, 1);
446 fw_xfer_unload(xfer);
448 STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link);
451 if (!ifq_is_empty(&ifp->if_snd))
453 lwkt_serialize_exit(ifp->if_serializer);
457 fwe_start(struct ifnet *ifp, struct ifaltq_subque *ifsq)
459 struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
461 ASSERT_ALTQ_SQ_DEFAULT(ifp, ifsq);
462 FWEDEBUG(ifp, "starting\n");
464 if (fwe->dma_ch < 0) {
465 FWEDEBUG(ifp, "not ready\n");
467 ifq_purge(&ifp->if_snd);
469 ifq_set_oactive(&ifp->if_snd);
471 if (!ifq_is_empty(&ifp->if_snd))
472 fwe_as_output(fwe, ifp);
474 ifq_clr_oactive(&ifp->if_snd);
480 #define ETHER_ALIGN 2
482 /* Async. stream output */
484 fwe_as_output(struct fwe_softc *fwe, struct ifnet *ifp)
487 struct fw_xfer *xfer;
488 struct fw_xferq *xferq;
493 xferq = fwe->fd.fc->atq;
494 while (xferq->queued < xferq->maxq - 1) {
495 xfer = STAILQ_FIRST(&fwe->xferlist);
497 if_printf(ifp, "lack of xfer\n");
500 m = ifq_dequeue(&ifp->if_snd, NULL);
503 STAILQ_REMOVE_HEAD(&fwe->xferlist, link);
506 /* keep ip packet alignment for alpha */
507 M_PREPEND(m, ETHER_ALIGN, MB_DONTWAIT);
508 fp = &xfer->send.hdr;
509 *(u_int32_t *)&xfer->send.hdr = *(int32_t *)&fwe->pkt_hdr;
510 fp->mode.stream.len = m->m_pkthdr.len;
512 xfer->send.pay_len = m->m_pkthdr.len;
514 if (fw_asyreq(fwe->fd.fc, -1, xfer) != 0) {
516 IFNET_STAT_INC(ifp, oerrors, 1);
517 /* XXX set error code */
518 fwe_output_callback(xfer);
520 IFNET_STAT_INC(ifp, opackets, 1);
526 if_printf(ifp, "%d queued\n", i);
529 xferq->start(fwe->fd.fc);
532 /* Async. stream output */
534 fwe_as_input(struct fw_xferq *xferq)
538 struct fwe_softc *fwe;
539 struct fw_bulkxfer *sxfer;
542 fwe = (struct fwe_softc *)xferq->sc;
544 lwkt_serialize_enter(ifp->if_serializer);
545 while ((sxfer = STAILQ_FIRST(&xferq->stvalid)) != NULL) {
546 STAILQ_REMOVE_HEAD(&xferq->stvalid, link);
547 fp = mtod(sxfer->mbuf, struct fw_pkt *);
548 if (fwe->fd.fc->irx_post != NULL)
549 fwe->fd.fc->irx_post(fwe->fd.fc, fp->mode.ld);
552 /* insert new rbuf */
553 sxfer->mbuf = m0 = m_getcl(MB_DONTWAIT, MT_DATA, M_PKTHDR);
555 m0->m_len = m0->m_pkthdr.len = m0->m_ext.ext_size;
556 STAILQ_INSERT_TAIL(&xferq->stfree, sxfer, link);
558 if_printf(ifp, "fwe_as_input: m_getcl failed\n");
561 if (sxfer->resp != 0 || fp->mode.stream.len <
562 ETHER_ALIGN + sizeof(struct ether_header)) {
564 IFNET_STAT_INC(ifp, ierrors, 1);
568 m->m_data += HDR_LEN + ETHER_ALIGN;
569 m->m_len = m->m_pkthdr.len =
570 fp->mode.stream.len - ETHER_ALIGN;
571 m->m_pkthdr.rcvif = ifp;
573 FWEDEBUG(ifp, "%02x %02x %02x %02x %02x %02x\n"
574 "%02x %02x %02x %02x %02x %02x\n"
575 "%02x %02x %02x %02x\n"
576 "%02x %02x %02x %02x\n"
577 "%02x %02x %02x %02x\n"
578 "%02x %02x %02x %02x\n",
579 c[0], c[1], c[2], c[3], c[4], c[5],
580 c[6], c[7], c[8], c[9], c[10], c[11],
581 c[12], c[13], c[14], c[15],
582 c[16], c[17], c[18], c[19],
583 c[20], c[21], c[22], c[23],
584 c[20], c[21], c[22], c[23]
587 ifp->if_input(ifp, m);
588 IFNET_STAT_INC(ifp, ipackets, 1);
590 if (STAILQ_FIRST(&xferq->stfree) != NULL)
591 fwe->fd.fc->irx_enable(fwe->fd.fc, fwe->dma_ch);
592 lwkt_serialize_exit(ifp->if_serializer);
596 static devclass_t fwe_devclass;
599 * Because fwe is a static device that always exists under any attached
600 * firewire device, and not scanned by the firewire device, we need an
601 * identify function to install the device.
603 static device_method_t fwe_methods[] = {
604 /* device interface */
605 DEVMETHOD(device_identify, bus_generic_identify_sameunit),
606 DEVMETHOD(device_probe, fwe_probe),
607 DEVMETHOD(device_attach, fwe_attach),
608 DEVMETHOD(device_detach, fwe_detach),
612 static driver_t fwe_driver = {
615 sizeof(struct fwe_softc),
619 DECLARE_DUMMY_MODULE(fwe);
620 DRIVER_MODULE(fwe, firewire, fwe_driver, fwe_devclass, NULL, NULL);
621 MODULE_VERSION(fwe, 1);
622 MODULE_DEPEND(fwe, firewire, 1, 1, 1);