Convert to critical sections.
[dragonfly.git] / sys / dev / netif / fwe / if_fwe.c
1 /*
2  * Copyright (c) 2002-2003
3  *      Hidetoshi Shimokawa. All rights reserved.
4  * 
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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:
15  *
16  *      This product includes software developed by Hidetoshi Shimokawa.
17  *
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.
21  * 
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
32  * SUCH DAMAGE.
33  * 
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 $
36  */
37
38 #include "opt_inet.h"
39
40 #include <sys/param.h>
41 #include <sys/conf.h>
42 #include <sys/kernel.h>
43 #include <sys/malloc.h>
44 #include <sys/mbuf.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>
50 #include <sys/bus.h>
51 #include <sys/thread2.h>
52 #include <machine/bus.h>
53
54 #include <net/bpf.h>
55 #include <net/ethernet.h>
56 #include <net/if.h>
57 #include <net/if_arp.h>
58 #ifdef __DragonFly__
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"
64 #else
65 #include <net/if_vlan_var.h>
66
67 #include <dev/firewire/firewire.h>
68 #include <dev/firewire/firewirereg.h>
69 #include <dev/firewire/if_fwevar.h>
70 #endif
71
72 #define FWEDEBUG        if (fwedebug) if_printf
73 #define TX_MAX_QUEUE    (FWMAXQUEUE - 1)
74
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 *);
79
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 *);
83
84 static int fwedebug = 0;
85 static int stream_ch = 1;
86 static int tx_speed = 2;
87 static int rx_queue_len = FWMAXQUEUE;
88
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");
100
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);
104
105 #ifdef DEVICE_POLLING
106
107 static void
108 fwe_poll(struct ifnet *ifp, enum poll_cmd cmd, int count)
109 {
110         struct fwe_softc *fwe;
111         struct firewire_comm *fc;
112
113         fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
114         fc = fwe->fd.fc;
115         switch(cmd) {
116         case POLL_REGISTER:
117                 /* disable interrupts */
118                 fc->set_intr(fc, 0);
119                 break;
120         case POLL_DEREGISTER:
121                 /* enable interrupts */
122                 fc->set_intr(fc, 1);
123                 break;
124         default:
125                 fc->poll(fc, (cmd == POLL_AND_CHECK_STATUS)?0:1, count);
126                 break;
127         }
128 }
129
130 #endif
131
132 static void
133 fwe_identify(driver_t *driver, device_t parent)
134 {
135         BUS_ADD_CHILD(parent, 0, "fwe", device_get_unit(parent));
136 }
137
138 static int
139 fwe_probe(device_t dev)
140 {
141         device_t pa;
142
143         pa = device_get_parent(dev);
144         if(device_get_unit(dev) != device_get_unit(pa)){
145                 return(ENXIO);
146         }
147
148         device_set_desc(dev, "Ethernet over FireWire");
149         return (0);
150 }
151
152 static int
153 fwe_attach(device_t dev)
154 {
155         struct fwe_softc *fwe;
156         struct ifnet *ifp;
157         uint8_t eaddr[ETHER_ADDR_LEN];
158         struct fw_eui64 *eui;
159
160         fwe = ((struct fwe_softc *)device_get_softc(dev));
161
162         bzero(fwe, sizeof(struct fwe_softc));
163         /* XXX */
164         fwe->stream_ch = stream_ch;
165         fwe->dma_ch = -1;
166
167         fwe->fd.fc = device_get_ivars(dev);
168         if (tx_speed < 0)
169                 tx_speed = fwe->fd.fc->speed;
170
171         fwe->fd.dev = dev;
172         fwe->fd.post_explore = NULL;
173         fwe->eth_softc.fwe = fwe;
174
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;
178
179         /* generate fake MAC address: first and last 3bytes from eui64 */
180 #define LOCAL (0x02)
181 #define GROUP (0x01)
182
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);
190
191         /* fill the rest and attach interface */        
192         ifp = &fwe->fwe_if;
193         ifp->if_softc = &fwe->eth_softc;
194
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;
202 #endif
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);
207
208         ether_ifattach(ifp, eaddr);
209
210         /* Tell the upper layer(s) we support long frames. */
211         ifp->if_data.ifi_hdrlen = sizeof(struct ether_vlan_header);
212
213
214         FWEDEBUG(ifp, "interface created\n");
215         return 0;
216 }
217
218 static void
219 fwe_stop(struct fwe_softc *fwe)
220 {
221         struct firewire_comm *fc;
222         struct fw_xferq *xferq;
223         struct ifnet *ifp = &fwe->fwe_if;
224         struct fw_xfer *xfer, *next;
225         int i;
226
227         fc = fwe->fd.fc;
228
229         ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
230
231         if (fwe->dma_ch >= 0) {
232                 xferq = fc->ir[fwe->dma_ch];
233
234                 if (xferq->flag & FWXFERQ_RUNNING)
235                         fc->irx_disable(fc, fwe->dma_ch);
236                 xferq->flag &= 
237                         ~(FWXFERQ_MODEMASK | FWXFERQ_OPEN | FWXFERQ_STREAM |
238                         FWXFERQ_EXTBUF | FWXFERQ_HANDLER | FWXFERQ_CHTAGMASK);
239                 xferq->hand =  NULL;
240
241                 for (i = 0; i < xferq->bnchunk; i ++)
242                         m_freem(xferq->bulkxfer[i].mbuf);
243                 free(xferq->bulkxfer, M_FWE);
244
245                 for (xfer = STAILQ_FIRST(&fwe->xferlist); xfer != NULL;
246                                         xfer = next) {
247                         next = STAILQ_NEXT(xfer, link);
248                         fw_xfer_free(xfer);
249                 }
250                 STAILQ_INIT(&fwe->xferlist);
251
252                 xferq->bulkxfer =  NULL;
253                 fwe->dma_ch = -1;
254         }
255 }
256
257 static int
258 fwe_detach(device_t dev)
259 {
260         struct fwe_softc *fwe = device_get_softc(dev);
261
262         crit_enter();
263
264         fwe_stop(fwe);
265         ether_ifdetach(&fwe->fwe_if);
266
267         crit_exit();
268         return 0;
269 }
270
271 static void
272 fwe_init(void *arg)
273 {
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;
279         struct mbuf *m;
280         int i;
281
282         FWEDEBUG(ifp, "initializing\n");
283
284         /* XXX keep promiscoud mode */
285         ifp->if_flags |= IFF_PROMISC;
286
287         fc = fwe->fd.fc;
288 #define START 0
289         if (fwe->dma_ch < 0) {
290                 for (i = START; i < fc->nisodma; i ++) {
291                         xferq = fc->ir[i];
292                         if ((xferq->flag & FWXFERQ_OPEN) == 0)
293                                 goto found;
294                 }
295                 if_printf(ifp, "no free dma channel\n");
296                 return;
297 found:
298                 fwe->dma_ch = i;
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;
310                 xferq->bnpacket = 1;
311                 xferq->psize = MCLBYTES;
312                 xferq->queued = 0;
313                 xferq->buf = NULL;
314                 xferq->bulkxfer = (struct fw_bulkxfer *) malloc(
315                         sizeof(struct fw_bulkxfer) * xferq->bnchunk,
316                                                         M_FWE, M_WAITOK);
317                 if (xferq->bulkxfer == NULL) {
318                         if_printf(ifp, "malloc failed\n");
319                         return;
320                 }
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;
328                         if (m != NULL) {
329                                 m->m_len = m->m_pkthdr.len = m->m_ext.ext_size;
330                                 STAILQ_INSERT_TAIL(&xferq->stfree,
331                                                 &xferq->bulkxfer[i], link);
332                         } else {
333                                 if_printf(ifp, "fwe_init: m_getcl failed\n");
334                         }
335                 }
336                 STAILQ_INIT(&fwe->xferlist);
337                 for (i = 0; i < TX_MAX_QUEUE; i++) {
338                         xfer = fw_xfer_alloc(M_FWE);
339                         if (xfer == NULL)
340                                 break;
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);
347                 }
348         } else
349                 xferq = fc->ir[fwe->dma_ch];
350
351
352         /* start dma */
353         if ((xferq->flag & FWXFERQ_RUNNING) == 0)
354                 fc->irx_enable(fc, fwe->dma_ch);
355
356         ifp->if_flags |= IFF_RUNNING;
357         ifp->if_flags &= ~IFF_OACTIVE;
358 }
359
360
361 static int
362 fwe_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data, struct ucred *cr)
363 {
364         struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
365         struct ifstat *ifs = NULL;
366         int error = 0, len;
367
368         crit_enter();
369
370         switch (cmd) {
371         case SIOCSIFFLAGS:
372                 if (ifp->if_flags & IFF_UP) {
373                         if (!(ifp->if_flags & IFF_RUNNING))
374                                 fwe_init(&fwe->eth_softc);
375                 } else {
376                         if (ifp->if_flags & IFF_RUNNING)
377                                 fwe_stop(fwe);
378                 }
379                 /* XXX keep promiscoud mode */
380                 ifp->if_flags |= IFF_PROMISC;
381                 break;
382         case SIOCADDMULTI:
383         case SIOCDELMULTI:
384                 break;
385
386         case SIOCGIFSTATUS:
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,
392                                 "\tch %d dma %d\n",
393                                         fwe->stream_ch, fwe->dma_ch);
394                 break;
395         default:
396                 error = ether_ioctl(ifp, cmd, data);
397                 break;
398         }
399
400         crit_exit();
401
402         return (error);
403 }
404
405 static void
406 fwe_output_callback(struct fw_xfer *xfer)
407 {
408         struct fwe_softc *fwe;
409         struct ifnet *ifp;
410
411         fwe = (struct fwe_softc *)xfer->sc;
412         ifp = &fwe->fwe_if;
413         /* XXX error check */
414         FWEDEBUG(ifp, "resp = %d\n", xfer->resp);
415         if (xfer->resp != 0)
416                 ifp->if_oerrors ++;
417                 
418         m_freem(xfer->mbuf);
419         fw_xfer_unload(xfer);
420
421         crit_enter();
422
423         STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link);
424
425         crit_exit();
426
427         /* for queue full */
428         if (!ifq_is_empty(&ifp->if_snd))
429                 fwe_start(ifp);
430 }
431
432 static void
433 fwe_start(struct ifnet *ifp)
434 {
435         struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
436
437         FWEDEBUG(ifp, "starting\n");
438
439         crit_enter();
440
441         if (fwe->dma_ch < 0) {
442                 FWEDEBUG(ifp, "not ready\n");
443
444                 ifq_purge(&ifp->if_snd);
445         } else {
446                 ifp->if_flags |= IFF_OACTIVE;
447
448                 if (!ifq_is_empty(&ifp->if_snd))
449                         fwe_as_output(fwe, ifp);
450
451                 ifp->if_flags &= ~IFF_OACTIVE;
452         }
453
454         crit_exit();
455 }
456
457 #define HDR_LEN 4
458 #ifndef ETHER_ALIGN
459 #define ETHER_ALIGN 2
460 #endif
461 /* Async. stream output */
462 static void
463 fwe_as_output(struct fwe_softc *fwe, struct ifnet *ifp)
464 {
465         struct mbuf *m;
466         struct fw_xfer *xfer;
467         struct fw_xferq *xferq;
468         struct fw_pkt *fp;
469         int i = 0;
470
471         xfer = NULL;
472         xferq = fwe->fd.fc->atq;
473         while (xferq->queued < xferq->maxq - 1) {
474                 xfer = STAILQ_FIRST(&fwe->xferlist);
475                 if (xfer == NULL) {
476                         if_printf(ifp, "lack of xfer\n");
477                         return;
478                 }
479                 m = ifq_dequeue(&ifp->if_snd);
480                 if (m == NULL)
481                         break;
482                 STAILQ_REMOVE_HEAD(&fwe->xferlist, link);
483                 BPF_MTAP(ifp, m);
484
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;
490                 xfer->mbuf = m;
491                 xfer->send.pay_len = m->m_pkthdr.len;
492
493                 if (fw_asyreq(fwe->fd.fc, -1, xfer) != 0) {
494                         /* error */
495                         ifp->if_oerrors ++;
496                         /* XXX set error code */
497                         fwe_output_callback(xfer);
498                 } else {
499                         ifp->if_opackets ++;
500                         i++;
501                 }
502         }
503 #if 0
504         if (i > 1)
505                 if_printf(ifp, "%d queued\n", i);
506 #endif
507         if (i > 0)
508                 xferq->start(fwe->fd.fc);
509 }
510
511 /* Async. stream output */
512 static void
513 fwe_as_input(struct fw_xferq *xferq)
514 {
515         struct mbuf *m, *m0;
516         struct ifnet *ifp;
517         struct fwe_softc *fwe;
518         struct fw_bulkxfer *sxfer;
519         struct fw_pkt *fp;
520         u_char *c;
521
522         fwe = (struct fwe_softc *)xferq->sc;
523         ifp = &fwe->fwe_if;
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);
529                 m = sxfer->mbuf;
530
531                 /* insert new rbuf */
532                 sxfer->mbuf = m0 = m_getcl(MB_DONTWAIT, MT_DATA, M_PKTHDR);
533                 if (m0 != NULL) {
534                         m0->m_len = m0->m_pkthdr.len = m0->m_ext.ext_size;
535                         STAILQ_INSERT_TAIL(&xferq->stfree, sxfer, link);
536                 } else {
537                         if_printf(ifp, "fwe_as_input: m_getcl failed\n");
538                 }
539
540                 if (sxfer->resp != 0 || fp->mode.stream.len <
541                     ETHER_ALIGN + sizeof(struct ether_header)) {
542                         m_freem(m);
543                         ifp->if_ierrors ++;
544                         continue;
545                 }
546
547                 m->m_data += HDR_LEN + ETHER_ALIGN;
548                 c = mtod(m, char *);
549                 m->m_len = m->m_pkthdr.len =
550                                 fp->mode.stream.len - ETHER_ALIGN;
551                 m->m_pkthdr.rcvif = ifp;
552 #if 0
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]
565                  );
566 #endif
567                 (*ifp->if_input)(ifp, m);
568                 ifp->if_ipackets ++;
569         }
570         if (STAILQ_FIRST(&xferq->stfree) != NULL)
571                 fwe->fd.fc->irx_enable(fwe->fd.fc, fwe->dma_ch);
572 }
573
574
575 static devclass_t fwe_devclass;
576
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),
583         { 0, 0 }
584 };
585
586 static driver_t fwe_driver = {
587         "fwe",
588         fwe_methods,
589         sizeof(struct fwe_softc),
590 };
591
592
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);