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.26 2006/09/05 03:48:10 dillon Exp $
39 #include "opt_polling.h"
41 #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 <sys/thread2.h>
53 #include <machine/bus.h>
56 #include <net/ethernet.h>
58 #include <net/if_arp.h>
60 #include <net/ifq_var.h>
61 #include <net/vlan/if_vlan_var.h>
62 #include <bus/firewire/firewire.h>
63 #include <bus/firewire/firewirereg.h>
64 #include "if_fwevar.h"
66 #include <net/if_vlan_var.h>
68 #include <dev/firewire/firewire.h>
69 #include <dev/firewire/firewirereg.h>
70 #include <dev/firewire/if_fwevar.h>
73 #define FWEDEBUG if (fwedebug) if_printf
74 #define TX_MAX_QUEUE (FWMAXQUEUE - 1)
76 /* network interface */
77 static void fwe_start (struct ifnet *);
78 static int fwe_ioctl (struct ifnet *, u_long, caddr_t, struct ucred *);
79 static void fwe_init (void *);
81 static void fwe_output_callback (struct fw_xfer *);
82 static void fwe_as_output (struct fwe_softc *, struct ifnet *);
83 static void fwe_as_input (struct fw_xferq *);
85 static int fwedebug = 0;
86 static int stream_ch = 1;
87 static int tx_speed = 2;
88 static int rx_queue_len = FWMAXQUEUE;
90 MALLOC_DEFINE(M_FWE, "if_fwe", "Ethernet over FireWire interface");
91 SYSCTL_INT(_debug, OID_AUTO, if_fwe_debug, CTLFLAG_RW, &fwedebug, 0, "");
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);
106 #ifdef DEVICE_POLLING
109 fwe_poll(struct ifnet *ifp, enum poll_cmd cmd, int count)
111 struct fwe_softc *fwe;
112 struct firewire_comm *fc;
114 fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
118 /* disable interrupts */
121 case POLL_DEREGISTER:
122 /* enable interrupts */
126 fc->poll(fc, (cmd == POLL_AND_CHECK_STATUS)?0:1, count);
134 fwe_probe(device_t dev)
138 pa = device_get_parent(dev);
139 if(device_get_unit(dev) != device_get_unit(pa)){
143 device_set_desc(dev, "Ethernet over FireWire");
148 fwe_attach(device_t dev)
150 struct fwe_softc *fwe;
152 uint8_t eaddr[ETHER_ADDR_LEN];
153 struct fw_eui64 *eui;
155 fwe = ((struct fwe_softc *)device_get_softc(dev));
158 fwe->stream_ch = stream_ch;
161 fwe->fd.fc = device_get_ivars(dev);
163 tx_speed = fwe->fd.fc->speed;
166 fwe->fd.post_explore = NULL;
167 fwe->eth_softc.fwe = fwe;
169 fwe->pkt_hdr.mode.stream.tcode = FWTCODE_STREAM;
170 fwe->pkt_hdr.mode.stream.sy = 0;
171 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch;
173 /* generate fake MAC address: first and last 3bytes from eui64 */
177 eui = &fwe->fd.fc->eui;
178 eaddr[0] = (FW_EUI64_BYTE(eui, 0) | LOCAL) & ~GROUP;
179 eaddr[1] = FW_EUI64_BYTE(eui, 1);
180 eaddr[2] = FW_EUI64_BYTE(eui, 2);
181 eaddr[3] = FW_EUI64_BYTE(eui, 5);
182 eaddr[4] = FW_EUI64_BYTE(eui, 6);
183 eaddr[5] = FW_EUI64_BYTE(eui, 7);
185 /* fill the rest and attach interface */
187 ifp->if_softc = &fwe->eth_softc;
189 if_initname(ifp, device_get_name(dev), device_get_unit(dev));
190 ifp->if_init = fwe_init;
191 ifp->if_start = fwe_start;
192 ifp->if_ioctl = fwe_ioctl;
193 ifp->if_capabilities = IFCAP_VLAN_MTU;
194 #ifdef DEVICE_POLLING
195 ifp->if_poll = fwe_poll;
197 ifp->if_mtu = ETHERMTU;
198 ifp->if_flags = (IFF_BROADCAST|IFF_SIMPLEX|IFF_MULTICAST);
199 ifq_set_maxlen(&ifp->if_snd, TX_MAX_QUEUE);
200 ifq_set_ready(&ifp->if_snd);
202 ether_ifattach(ifp, eaddr, NULL);
204 /* Tell the upper layer(s) we support long frames. */
205 ifp->if_data.ifi_hdrlen = sizeof(struct ether_vlan_header);
208 FWEDEBUG(ifp, "interface created\n");
213 fwe_stop(struct fwe_softc *fwe)
215 struct firewire_comm *fc;
216 struct fw_xferq *xferq;
217 struct ifnet *ifp = &fwe->fwe_if;
218 struct fw_xfer *xfer, *next;
223 ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
225 if (fwe->dma_ch >= 0) {
226 xferq = fc->ir[fwe->dma_ch];
228 if (xferq->flag & FWXFERQ_RUNNING)
229 fc->irx_disable(fc, fwe->dma_ch);
231 ~(FWXFERQ_MODEMASK | FWXFERQ_OPEN | FWXFERQ_STREAM |
232 FWXFERQ_EXTBUF | FWXFERQ_HANDLER | FWXFERQ_CHTAGMASK);
235 for (i = 0; i < xferq->bnchunk; i ++)
236 m_freem(xferq->bulkxfer[i].mbuf);
237 kfree(xferq->bulkxfer, M_FWE);
239 for (xfer = STAILQ_FIRST(&fwe->xferlist); xfer != NULL;
241 next = STAILQ_NEXT(xfer, link);
244 STAILQ_INIT(&fwe->xferlist);
246 xferq->bulkxfer = NULL;
252 fwe_detach(device_t dev)
254 struct fwe_softc *fwe = device_get_softc(dev);
256 lwkt_serialize_enter(fwe->fwe_if.if_serializer);
258 lwkt_serialize_exit(fwe->fwe_if.if_serializer);
260 ether_ifdetach(&fwe->fwe_if);
267 struct fwe_softc *fwe = ((struct fwe_eth_softc *)arg)->fwe;
268 struct firewire_comm *fc;
269 struct ifnet *ifp = &fwe->fwe_if;
270 struct fw_xferq *xferq;
271 struct fw_xfer *xfer;
275 FWEDEBUG(ifp, "initializing\n");
277 /* XXX keep promiscoud mode */
278 ifp->if_flags |= IFF_PROMISC;
282 if (fwe->dma_ch < 0) {
283 for (i = START; i < fc->nisodma; i ++) {
285 if ((xferq->flag & FWXFERQ_OPEN) == 0)
288 if_printf(ifp, "no free dma channel\n");
292 fwe->stream_ch = stream_ch;
293 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch;
294 /* allocate DMA channel and init packet mode */
295 xferq->flag |= FWXFERQ_OPEN | FWXFERQ_EXTBUF |
296 FWXFERQ_HANDLER | FWXFERQ_STREAM;
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 *) kmalloc(
308 sizeof(struct fw_bulkxfer) * xferq->bnchunk,
310 if (xferq->bulkxfer == NULL) {
311 if_printf(ifp, "malloc failed\n");
314 STAILQ_INIT(&xferq->stvalid);
315 STAILQ_INIT(&xferq->stfree);
316 STAILQ_INIT(&xferq->stdma);
317 xferq->stproc = NULL;
318 for (i = 0; i < xferq->bnchunk; i ++) {
319 m = m_getcl(MB_WAIT, MT_DATA, M_PKTHDR);
320 xferq->bulkxfer[i].mbuf = m;
322 m->m_len = m->m_pkthdr.len = m->m_ext.ext_size;
323 STAILQ_INSERT_TAIL(&xferq->stfree,
324 &xferq->bulkxfer[i], link);
326 if_printf(ifp, "fwe_init: m_getcl failed\n");
329 STAILQ_INIT(&fwe->xferlist);
330 for (i = 0; i < TX_MAX_QUEUE; i++) {
331 xfer = fw_xfer_alloc(M_FWE);
334 xfer->send.spd = tx_speed;
335 xfer->fc = fwe->fd.fc;
336 xfer->retry_req = fw_asybusy;
337 xfer->sc = (caddr_t)fwe;
338 xfer->act.hand = fwe_output_callback;
339 STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link);
342 xferq = fc->ir[fwe->dma_ch];
346 if ((xferq->flag & FWXFERQ_RUNNING) == 0)
347 fc->irx_enable(fc, fwe->dma_ch);
349 ifp->if_flags |= IFF_RUNNING;
350 ifp->if_flags &= ~IFF_OACTIVE;
355 fwe_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data, struct ucred *cr)
357 struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
358 struct ifstat *ifs = NULL;
363 if (ifp->if_flags & IFF_UP) {
364 if (!(ifp->if_flags & IFF_RUNNING))
365 fwe_init(&fwe->eth_softc);
367 if (ifp->if_flags & IFF_RUNNING)
370 /* XXX keep promiscoud mode */
371 ifp->if_flags |= IFF_PROMISC;
378 ifs = (struct ifstat *)data;
379 len = strlen(ifs->ascii);
380 if (len < sizeof(ifs->ascii))
381 snprintf(ifs->ascii + len,
382 sizeof(ifs->ascii) - len,
384 fwe->stream_ch, fwe->dma_ch);
387 error = ether_ioctl(ifp, cmd, data);
394 fwe_output_callback(struct fw_xfer *xfer)
396 struct fwe_softc *fwe;
399 fwe = (struct fwe_softc *)xfer->sc;
401 lwkt_serialize_enter(ifp->if_serializer);
402 /* XXX error check */
403 FWEDEBUG(ifp, "resp = %d\n", xfer->resp);
408 fw_xfer_unload(xfer);
410 STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link);
413 if (!ifq_is_empty(&ifp->if_snd))
415 lwkt_serialize_exit(ifp->if_serializer);
419 fwe_start(struct ifnet *ifp)
421 struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
423 FWEDEBUG(ifp, "starting\n");
425 if (fwe->dma_ch < 0) {
426 FWEDEBUG(ifp, "not ready\n");
428 ifq_purge(&ifp->if_snd);
430 ifp->if_flags |= IFF_OACTIVE;
432 if (!ifq_is_empty(&ifp->if_snd))
433 fwe_as_output(fwe, ifp);
435 ifp->if_flags &= ~IFF_OACTIVE;
441 #define ETHER_ALIGN 2
443 /* Async. stream output */
445 fwe_as_output(struct fwe_softc *fwe, struct ifnet *ifp)
448 struct fw_xfer *xfer;
449 struct fw_xferq *xferq;
454 xferq = fwe->fd.fc->atq;
455 while (xferq->queued < xferq->maxq - 1) {
456 xfer = STAILQ_FIRST(&fwe->xferlist);
458 if_printf(ifp, "lack of xfer\n");
461 m = ifq_dequeue(&ifp->if_snd, NULL);
464 STAILQ_REMOVE_HEAD(&fwe->xferlist, link);
467 /* keep ip packet alignment for alpha */
468 M_PREPEND(m, ETHER_ALIGN, MB_DONTWAIT);
469 fp = &xfer->send.hdr;
470 *(u_int32_t *)&xfer->send.hdr = *(int32_t *)&fwe->pkt_hdr;
471 fp->mode.stream.len = m->m_pkthdr.len;
473 xfer->send.pay_len = m->m_pkthdr.len;
475 if (fw_asyreq(fwe->fd.fc, -1, xfer) != 0) {
478 /* XXX set error code */
479 fwe_output_callback(xfer);
487 if_printf(ifp, "%d queued\n", i);
490 xferq->start(fwe->fd.fc);
493 /* Async. stream output */
495 fwe_as_input(struct fw_xferq *xferq)
499 struct fwe_softc *fwe;
500 struct fw_bulkxfer *sxfer;
504 fwe = (struct fwe_softc *)xferq->sc;
506 lwkt_serialize_enter(ifp->if_serializer);
507 while ((sxfer = STAILQ_FIRST(&xferq->stvalid)) != NULL) {
508 STAILQ_REMOVE_HEAD(&xferq->stvalid, link);
509 fp = mtod(sxfer->mbuf, struct fw_pkt *);
510 if (fwe->fd.fc->irx_post != NULL)
511 fwe->fd.fc->irx_post(fwe->fd.fc, fp->mode.ld);
514 /* insert new rbuf */
515 sxfer->mbuf = m0 = m_getcl(MB_DONTWAIT, MT_DATA, M_PKTHDR);
517 m0->m_len = m0->m_pkthdr.len = m0->m_ext.ext_size;
518 STAILQ_INSERT_TAIL(&xferq->stfree, sxfer, link);
520 if_printf(ifp, "fwe_as_input: m_getcl failed\n");
523 if (sxfer->resp != 0 || fp->mode.stream.len <
524 ETHER_ALIGN + sizeof(struct ether_header)) {
530 m->m_data += HDR_LEN + ETHER_ALIGN;
532 m->m_len = m->m_pkthdr.len =
533 fp->mode.stream.len - ETHER_ALIGN;
534 m->m_pkthdr.rcvif = ifp;
536 FWEDEBUG(ifp, "%02x %02x %02x %02x %02x %02x\n"
537 "%02x %02x %02x %02x %02x %02x\n"
538 "%02x %02x %02x %02x\n"
539 "%02x %02x %02x %02x\n"
540 "%02x %02x %02x %02x\n"
541 "%02x %02x %02x %02x\n",
542 c[0], c[1], c[2], c[3], c[4], c[5],
543 c[6], c[7], c[8], c[9], c[10], c[11],
544 c[12], c[13], c[14], c[15],
545 c[16], c[17], c[18], c[19],
546 c[20], c[21], c[22], c[23],
547 c[20], c[21], c[22], c[23]
550 ifp->if_input(ifp, m);
553 if (STAILQ_FIRST(&xferq->stfree) != NULL)
554 fwe->fd.fc->irx_enable(fwe->fd.fc, fwe->dma_ch);
555 lwkt_serialize_exit(ifp->if_serializer);
559 static devclass_t fwe_devclass;
562 * Because fwe is a static device that always exists under any attached
563 * firewire device, and not scanned by the firewire device, we need an
564 * identify function to install the device.
566 static device_method_t fwe_methods[] = {
567 /* device interface */
568 DEVMETHOD(device_identify, bus_generic_identify_sameunit),
569 DEVMETHOD(device_probe, fwe_probe),
570 DEVMETHOD(device_attach, fwe_attach),
571 DEVMETHOD(device_detach, fwe_detach),
575 static driver_t fwe_driver = {
578 sizeof(struct fwe_softc),
582 DECLARE_DUMMY_MODULE(fwe);
583 DRIVER_MODULE(fwe, firewire, fwe_driver, fwe_devclass, 0, 0);
584 MODULE_VERSION(fwe, 1);
585 MODULE_DEPEND(fwe, firewire, 1, 1, 1);