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.18 2005/06/14 17:05:58 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 <sys/thread2.h>
52 #include <machine/bus.h>
55 #include <net/ethernet.h>
57 #include <net/if_arp.h>
59 #include <net/ifq_var.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 *);
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 SYSCTL_DECL(_hw_firewire);
92 SYSCTL_NODE(_hw_firewire, OID_AUTO, fwe, CTLFLAG_RD, 0,
93 "Ethernet emulation subsystem");
94 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, stream_ch, CTLFLAG_RW, &stream_ch, 0,
95 "Stream channel to use");
96 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, tx_speed, CTLFLAG_RW, &tx_speed, 0,
97 "Transmission speed");
98 SYSCTL_INT(_hw_firewire_fwe, OID_AUTO, rx_queue_len, CTLFLAG_RW, &rx_queue_len,
99 0, "Length of the receive queue");
101 TUNABLE_INT("hw.firewire.fwe.stream_ch", &stream_ch);
102 TUNABLE_INT("hw.firewire.fwe.tx_speed", &tx_speed);
103 TUNABLE_INT("hw.firewire.fwe.rx_queue_len", &rx_queue_len);
105 #ifdef DEVICE_POLLING
108 fwe_poll(struct ifnet *ifp, enum poll_cmd cmd, int count)
110 struct fwe_softc *fwe;
111 struct firewire_comm *fc;
113 fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
117 /* disable interrupts */
120 case POLL_DEREGISTER:
121 /* enable interrupts */
125 fc->poll(fc, (cmd == POLL_AND_CHECK_STATUS)?0:1, count);
133 fwe_identify(driver_t *driver, device_t parent)
135 BUS_ADD_CHILD(parent, 0, "fwe", device_get_unit(parent));
139 fwe_probe(device_t dev)
143 pa = device_get_parent(dev);
144 if(device_get_unit(dev) != device_get_unit(pa)){
148 device_set_desc(dev, "Ethernet over FireWire");
153 fwe_attach(device_t dev)
155 struct fwe_softc *fwe;
157 uint8_t eaddr[ETHER_ADDR_LEN];
158 struct fw_eui64 *eui;
160 fwe = ((struct fwe_softc *)device_get_softc(dev));
162 bzero(fwe, sizeof(struct fwe_softc));
164 fwe->stream_ch = stream_ch;
167 fwe->fd.fc = device_get_ivars(dev);
169 tx_speed = fwe->fd.fc->speed;
172 fwe->fd.post_explore = NULL;
173 fwe->eth_softc.fwe = fwe;
175 fwe->pkt_hdr.mode.stream.tcode = FWTCODE_STREAM;
176 fwe->pkt_hdr.mode.stream.sy = 0;
177 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch;
179 /* generate fake MAC address: first and last 3bytes from eui64 */
183 eui = &fwe->fd.fc->eui;
184 eaddr[0] = (FW_EUI64_BYTE(eui, 0) | LOCAL) & ~GROUP;
185 eaddr[1] = FW_EUI64_BYTE(eui, 1);
186 eaddr[2] = FW_EUI64_BYTE(eui, 2);
187 eaddr[3] = FW_EUI64_BYTE(eui, 5);
188 eaddr[4] = FW_EUI64_BYTE(eui, 6);
189 eaddr[5] = FW_EUI64_BYTE(eui, 7);
191 /* fill the rest and attach interface */
193 ifp->if_softc = &fwe->eth_softc;
195 if_initname(ifp, device_get_name(dev), device_get_unit(dev));
196 ifp->if_init = fwe_init;
197 ifp->if_start = fwe_start;
198 ifp->if_ioctl = fwe_ioctl;
199 ifp->if_capabilities = IFCAP_VLAN_MTU;
200 #ifdef DEVICE_POLLING
201 ifp->if_poll = fwe_poll;
203 ifp->if_mtu = ETHERMTU;
204 ifp->if_flags = (IFF_BROADCAST|IFF_SIMPLEX|IFF_MULTICAST);
205 ifq_set_maxlen(&ifp->if_snd, TX_MAX_QUEUE);
206 ifq_set_ready(&ifp->if_snd);
208 ether_ifattach(ifp, eaddr);
210 /* Tell the upper layer(s) we support long frames. */
211 ifp->if_data.ifi_hdrlen = sizeof(struct ether_vlan_header);
214 FWEDEBUG(ifp, "interface created\n");
219 fwe_stop(struct fwe_softc *fwe)
221 struct firewire_comm *fc;
222 struct fw_xferq *xferq;
223 struct ifnet *ifp = &fwe->fwe_if;
224 struct fw_xfer *xfer, *next;
229 ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
231 if (fwe->dma_ch >= 0) {
232 xferq = fc->ir[fwe->dma_ch];
234 if (xferq->flag & FWXFERQ_RUNNING)
235 fc->irx_disable(fc, fwe->dma_ch);
237 ~(FWXFERQ_MODEMASK | FWXFERQ_OPEN | FWXFERQ_STREAM |
238 FWXFERQ_EXTBUF | FWXFERQ_HANDLER | FWXFERQ_CHTAGMASK);
241 for (i = 0; i < xferq->bnchunk; i ++)
242 m_freem(xferq->bulkxfer[i].mbuf);
243 free(xferq->bulkxfer, M_FWE);
245 for (xfer = STAILQ_FIRST(&fwe->xferlist); xfer != NULL;
247 next = STAILQ_NEXT(xfer, link);
250 STAILQ_INIT(&fwe->xferlist);
252 xferq->bulkxfer = NULL;
258 fwe_detach(device_t dev)
260 struct fwe_softc *fwe = device_get_softc(dev);
265 ether_ifdetach(&fwe->fwe_if);
274 struct fwe_softc *fwe = ((struct fwe_eth_softc *)arg)->fwe;
275 struct firewire_comm *fc;
276 struct ifnet *ifp = &fwe->fwe_if;
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;
289 if (fwe->dma_ch < 0) {
290 for (i = START; i < fc->nisodma; i ++) {
292 if ((xferq->flag & FWXFERQ_OPEN) == 0)
295 if_printf(ifp, "no free dma channel\n");
299 fwe->stream_ch = stream_ch;
300 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch;
301 /* allocate DMA channel and init packet mode */
302 xferq->flag |= FWXFERQ_OPEN | FWXFERQ_EXTBUF |
303 FWXFERQ_HANDLER | FWXFERQ_STREAM;
304 xferq->flag &= ~0xff;
305 xferq->flag |= fwe->stream_ch & 0xff;
306 /* register fwe_input handler */
307 xferq->sc = (caddr_t) fwe;
308 xferq->hand = fwe_as_input;
309 xferq->bnchunk = rx_queue_len;
311 xferq->psize = MCLBYTES;
314 xferq->bulkxfer = (struct fw_bulkxfer *) malloc(
315 sizeof(struct fw_bulkxfer) * xferq->bnchunk,
317 if (xferq->bulkxfer == NULL) {
318 if_printf(ifp, "malloc failed\n");
321 STAILQ_INIT(&xferq->stvalid);
322 STAILQ_INIT(&xferq->stfree);
323 STAILQ_INIT(&xferq->stdma);
324 xferq->stproc = NULL;
325 for (i = 0; i < xferq->bnchunk; i ++) {
326 m = m_getcl(MB_WAIT, MT_DATA, M_PKTHDR);
327 xferq->bulkxfer[i].mbuf = m;
329 m->m_len = m->m_pkthdr.len = m->m_ext.ext_size;
330 STAILQ_INSERT_TAIL(&xferq->stfree,
331 &xferq->bulkxfer[i], link);
333 if_printf(ifp, "fwe_init: m_getcl failed\n");
336 STAILQ_INIT(&fwe->xferlist);
337 for (i = 0; i < TX_MAX_QUEUE; i++) {
338 xfer = fw_xfer_alloc(M_FWE);
341 xfer->send.spd = tx_speed;
342 xfer->fc = fwe->fd.fc;
343 xfer->retry_req = fw_asybusy;
344 xfer->sc = (caddr_t)fwe;
345 xfer->act.hand = fwe_output_callback;
346 STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link);
349 xferq = fc->ir[fwe->dma_ch];
353 if ((xferq->flag & FWXFERQ_RUNNING) == 0)
354 fc->irx_enable(fc, fwe->dma_ch);
356 ifp->if_flags |= IFF_RUNNING;
357 ifp->if_flags &= ~IFF_OACTIVE;
362 fwe_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data, struct ucred *cr)
364 struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
365 struct ifstat *ifs = NULL;
372 if (ifp->if_flags & IFF_UP) {
373 if (!(ifp->if_flags & IFF_RUNNING))
374 fwe_init(&fwe->eth_softc);
376 if (ifp->if_flags & IFF_RUNNING)
379 /* XXX keep promiscoud mode */
380 ifp->if_flags |= IFF_PROMISC;
387 ifs = (struct ifstat *)data;
388 len = strlen(ifs->ascii);
389 if (len < sizeof(ifs->ascii))
390 snprintf(ifs->ascii + len,
391 sizeof(ifs->ascii) - len,
393 fwe->stream_ch, fwe->dma_ch);
396 error = ether_ioctl(ifp, cmd, data);
406 fwe_output_callback(struct fw_xfer *xfer)
408 struct fwe_softc *fwe;
411 fwe = (struct fwe_softc *)xfer->sc;
413 /* XXX error check */
414 FWEDEBUG(ifp, "resp = %d\n", xfer->resp);
419 fw_xfer_unload(xfer);
423 STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link);
428 if (!ifq_is_empty(&ifp->if_snd))
433 fwe_start(struct ifnet *ifp)
435 struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
437 FWEDEBUG(ifp, "starting\n");
441 if (fwe->dma_ch < 0) {
442 FWEDEBUG(ifp, "not ready\n");
444 ifq_purge(&ifp->if_snd);
446 ifp->if_flags |= IFF_OACTIVE;
448 if (!ifq_is_empty(&ifp->if_snd))
449 fwe_as_output(fwe, ifp);
451 ifp->if_flags &= ~IFF_OACTIVE;
459 #define ETHER_ALIGN 2
461 /* Async. stream output */
463 fwe_as_output(struct fwe_softc *fwe, struct ifnet *ifp)
466 struct fw_xfer *xfer;
467 struct fw_xferq *xferq;
472 xferq = fwe->fd.fc->atq;
473 while (xferq->queued < xferq->maxq - 1) {
474 xfer = STAILQ_FIRST(&fwe->xferlist);
476 if_printf(ifp, "lack of xfer\n");
479 m = ifq_dequeue(&ifp->if_snd);
482 STAILQ_REMOVE_HEAD(&fwe->xferlist, link);
485 /* keep ip packet alignment for alpha */
486 M_PREPEND(m, ETHER_ALIGN, MB_DONTWAIT);
487 fp = &xfer->send.hdr;
488 *(u_int32_t *)&xfer->send.hdr = *(int32_t *)&fwe->pkt_hdr;
489 fp->mode.stream.len = m->m_pkthdr.len;
491 xfer->send.pay_len = m->m_pkthdr.len;
493 if (fw_asyreq(fwe->fd.fc, -1, xfer) != 0) {
496 /* XXX set error code */
497 fwe_output_callback(xfer);
505 if_printf(ifp, "%d queued\n", i);
508 xferq->start(fwe->fd.fc);
511 /* Async. stream output */
513 fwe_as_input(struct fw_xferq *xferq)
517 struct fwe_softc *fwe;
518 struct fw_bulkxfer *sxfer;
522 fwe = (struct fwe_softc *)xferq->sc;
524 while ((sxfer = STAILQ_FIRST(&xferq->stvalid)) != NULL) {
525 STAILQ_REMOVE_HEAD(&xferq->stvalid, link);
526 fp = mtod(sxfer->mbuf, struct fw_pkt *);
527 if (fwe->fd.fc->irx_post != NULL)
528 fwe->fd.fc->irx_post(fwe->fd.fc, fp->mode.ld);
531 /* insert new rbuf */
532 sxfer->mbuf = m0 = m_getcl(MB_DONTWAIT, MT_DATA, M_PKTHDR);
534 m0->m_len = m0->m_pkthdr.len = m0->m_ext.ext_size;
535 STAILQ_INSERT_TAIL(&xferq->stfree, sxfer, link);
537 if_printf(ifp, "fwe_as_input: m_getcl failed\n");
540 if (sxfer->resp != 0 || fp->mode.stream.len <
541 ETHER_ALIGN + sizeof(struct ether_header)) {
547 m->m_data += HDR_LEN + ETHER_ALIGN;
549 m->m_len = m->m_pkthdr.len =
550 fp->mode.stream.len - ETHER_ALIGN;
551 m->m_pkthdr.rcvif = ifp;
553 FWEDEBUG(ifp, "%02x %02x %02x %02x %02x %02x\n"
554 "%02x %02x %02x %02x %02x %02x\n"
555 "%02x %02x %02x %02x\n"
556 "%02x %02x %02x %02x\n"
557 "%02x %02x %02x %02x\n"
558 "%02x %02x %02x %02x\n",
559 c[0], c[1], c[2], c[3], c[4], c[5],
560 c[6], c[7], c[8], c[9], c[10], c[11],
561 c[12], c[13], c[14], c[15],
562 c[16], c[17], c[18], c[19],
563 c[20], c[21], c[22], c[23],
564 c[20], c[21], c[22], c[23]
567 (*ifp->if_input)(ifp, m);
570 if (STAILQ_FIRST(&xferq->stfree) != NULL)
571 fwe->fd.fc->irx_enable(fwe->fd.fc, fwe->dma_ch);
575 static devclass_t fwe_devclass;
577 static device_method_t fwe_methods[] = {
578 /* device interface */
579 DEVMETHOD(device_identify, fwe_identify),
580 DEVMETHOD(device_probe, fwe_probe),
581 DEVMETHOD(device_attach, fwe_attach),
582 DEVMETHOD(device_detach, fwe_detach),
586 static driver_t fwe_driver = {
589 sizeof(struct fwe_softc),
593 DECLARE_DUMMY_MODULE(fwe);
594 DRIVER_MODULE(fwe, firewire, fwe_driver, fwe_devclass, 0, 0);
595 MODULE_VERSION(fwe, 1);
596 MODULE_DEPEND(fwe, firewire, 1, 1, 1);