Merge from vendor branch CVS:
[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.17 2005/05/31 08:06:47 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 <machine/bus.h>
52
53 #include <net/bpf.h>
54 #include <net/ethernet.h>
55 #include <net/if.h>
56 #include <net/if_arp.h>
57 #ifdef __DragonFly__
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"
63 #else
64 #include <net/if_vlan_var.h>
65
66 #include <dev/firewire/firewire.h>
67 #include <dev/firewire/firewirereg.h>
68 #include <dev/firewire/if_fwevar.h>
69 #endif
70
71 #define FWEDEBUG        if (fwedebug) if_printf
72 #define TX_MAX_QUEUE    (FWMAXQUEUE - 1)
73
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 *);
78
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 *);
82
83 static int fwedebug = 0;
84 static int stream_ch = 1;
85 static int tx_speed = 2;
86 static int rx_queue_len = FWMAXQUEUE;
87
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");
99
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);
103
104 #ifdef DEVICE_POLLING
105
106 static void
107 fwe_poll(struct ifnet *ifp, enum poll_cmd cmd, int count)
108 {
109         struct fwe_softc *fwe;
110         struct firewire_comm *fc;
111
112         fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
113         fc = fwe->fd.fc;
114         switch(cmd) {
115         case POLL_REGISTER:
116                 /* disable interrupts */
117                 fc->set_intr(fc, 0);
118                 break;
119         case POLL_DEREGISTER:
120                 /* enable interrupts */
121                 fc->set_intr(fc, 1);
122                 break;
123         default:
124                 fc->poll(fc, (cmd == POLL_AND_CHECK_STATUS)?0:1, count);
125                 break;
126         }
127 }
128
129 #endif
130
131 static void
132 fwe_identify(driver_t *driver, device_t parent)
133 {
134         BUS_ADD_CHILD(parent, 0, "fwe", device_get_unit(parent));
135 }
136
137 static int
138 fwe_probe(device_t dev)
139 {
140         device_t pa;
141
142         pa = device_get_parent(dev);
143         if(device_get_unit(dev) != device_get_unit(pa)){
144                 return(ENXIO);
145         }
146
147         device_set_desc(dev, "Ethernet over FireWire");
148         return (0);
149 }
150
151 static int
152 fwe_attach(device_t dev)
153 {
154         struct fwe_softc *fwe;
155         struct ifnet *ifp;
156         int s;
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         s = splimp();
209         ether_ifattach(ifp, eaddr);
210         splx(s);
211
212         /* Tell the upper layer(s) we support long frames. */
213         ifp->if_data.ifi_hdrlen = sizeof(struct ether_vlan_header);
214
215
216         FWEDEBUG(ifp, "interface created\n");
217         return 0;
218 }
219
220 static void
221 fwe_stop(struct fwe_softc *fwe)
222 {
223         struct firewire_comm *fc;
224         struct fw_xferq *xferq;
225         struct ifnet *ifp = &fwe->fwe_if;
226         struct fw_xfer *xfer, *next;
227         int i;
228
229         fc = fwe->fd.fc;
230
231         ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
232
233         if (fwe->dma_ch >= 0) {
234                 xferq = fc->ir[fwe->dma_ch];
235
236                 if (xferq->flag & FWXFERQ_RUNNING)
237                         fc->irx_disable(fc, fwe->dma_ch);
238                 xferq->flag &= 
239                         ~(FWXFERQ_MODEMASK | FWXFERQ_OPEN | FWXFERQ_STREAM |
240                         FWXFERQ_EXTBUF | FWXFERQ_HANDLER | FWXFERQ_CHTAGMASK);
241                 xferq->hand =  NULL;
242
243                 for (i = 0; i < xferq->bnchunk; i ++)
244                         m_freem(xferq->bulkxfer[i].mbuf);
245                 free(xferq->bulkxfer, M_FWE);
246
247                 for (xfer = STAILQ_FIRST(&fwe->xferlist); xfer != NULL;
248                                         xfer = next) {
249                         next = STAILQ_NEXT(xfer, link);
250                         fw_xfer_free(xfer);
251                 }
252                 STAILQ_INIT(&fwe->xferlist);
253
254                 xferq->bulkxfer =  NULL;
255                 fwe->dma_ch = -1;
256         }
257 }
258
259 static int
260 fwe_detach(device_t dev)
261 {
262         struct fwe_softc *fwe;
263         int s;
264
265         fwe = (struct fwe_softc *)device_get_softc(dev);
266         s = splimp();
267
268         fwe_stop(fwe);
269         ether_ifdetach(&fwe->fwe_if);
270
271         splx(s);
272         return 0;
273 }
274
275 static void
276 fwe_init(void *arg)
277 {
278         struct fwe_softc *fwe = ((struct fwe_eth_softc *)arg)->fwe;
279         struct firewire_comm *fc;
280         struct ifnet *ifp = &fwe->fwe_if;
281         struct fw_xferq *xferq;
282         struct fw_xfer *xfer;
283         struct mbuf *m;
284         int i;
285
286         FWEDEBUG(ifp, "initializing\n");
287
288         /* XXX keep promiscoud mode */
289         ifp->if_flags |= IFF_PROMISC;
290
291         fc = fwe->fd.fc;
292 #define START 0
293         if (fwe->dma_ch < 0) {
294                 for (i = START; i < fc->nisodma; i ++) {
295                         xferq = fc->ir[i];
296                         if ((xferq->flag & FWXFERQ_OPEN) == 0)
297                                 goto found;
298                 }
299                 if_printf(ifp, "no free dma channel\n");
300                 return;
301 found:
302                 fwe->dma_ch = i;
303                 fwe->stream_ch = stream_ch;
304                 fwe->pkt_hdr.mode.stream.chtag = fwe->stream_ch;
305                 /* allocate DMA channel and init packet mode */
306                 xferq->flag |= FWXFERQ_OPEN | FWXFERQ_EXTBUF |
307                                 FWXFERQ_HANDLER | FWXFERQ_STREAM;
308                 xferq->flag &= ~0xff;
309                 xferq->flag |= fwe->stream_ch & 0xff;
310                 /* register fwe_input handler */
311                 xferq->sc = (caddr_t) fwe;
312                 xferq->hand = fwe_as_input;
313                 xferq->bnchunk = rx_queue_len;
314                 xferq->bnpacket = 1;
315                 xferq->psize = MCLBYTES;
316                 xferq->queued = 0;
317                 xferq->buf = NULL;
318                 xferq->bulkxfer = (struct fw_bulkxfer *) malloc(
319                         sizeof(struct fw_bulkxfer) * xferq->bnchunk,
320                                                         M_FWE, M_WAITOK);
321                 if (xferq->bulkxfer == NULL) {
322                         if_printf(ifp, "malloc failed\n");
323                         return;
324                 }
325                 STAILQ_INIT(&xferq->stvalid);
326                 STAILQ_INIT(&xferq->stfree);
327                 STAILQ_INIT(&xferq->stdma);
328                 xferq->stproc = NULL;
329                 for (i = 0; i < xferq->bnchunk; i ++) {
330                         m = m_getcl(MB_WAIT, MT_DATA, M_PKTHDR);
331                         xferq->bulkxfer[i].mbuf = m;
332                         if (m != NULL) {
333                                 m->m_len = m->m_pkthdr.len = m->m_ext.ext_size;
334                                 STAILQ_INSERT_TAIL(&xferq->stfree,
335                                                 &xferq->bulkxfer[i], link);
336                         } else {
337                                 if_printf(ifp, "fwe_init: m_getcl failed\n");
338                         }
339                 }
340                 STAILQ_INIT(&fwe->xferlist);
341                 for (i = 0; i < TX_MAX_QUEUE; i++) {
342                         xfer = fw_xfer_alloc(M_FWE);
343                         if (xfer == NULL)
344                                 break;
345                         xfer->send.spd = tx_speed;
346                         xfer->fc = fwe->fd.fc;
347                         xfer->retry_req = fw_asybusy;
348                         xfer->sc = (caddr_t)fwe;
349                         xfer->act.hand = fwe_output_callback;
350                         STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link);
351                 }
352         } else
353                 xferq = fc->ir[fwe->dma_ch];
354
355
356         /* start dma */
357         if ((xferq->flag & FWXFERQ_RUNNING) == 0)
358                 fc->irx_enable(fc, fwe->dma_ch);
359
360         ifp->if_flags |= IFF_RUNNING;
361         ifp->if_flags &= ~IFF_OACTIVE;
362 }
363
364
365 static int
366 fwe_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data, struct ucred *cr)
367 {
368         struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
369         struct ifstat *ifs = NULL;
370         int s, error, len;
371
372         switch (cmd) {
373         case SIOCSIFFLAGS:
374                 s = splimp();
375                 if (ifp->if_flags & IFF_UP) {
376                         if (!(ifp->if_flags & IFF_RUNNING))
377                                 fwe_init(&fwe->eth_softc);
378                 } else {
379                         if (ifp->if_flags & IFF_RUNNING)
380                                 fwe_stop(fwe);
381                 }
382                 /* XXX keep promiscoud mode */
383                 ifp->if_flags |= IFF_PROMISC;
384                 splx(s);
385                 break;
386         case SIOCADDMULTI:
387         case SIOCDELMULTI:
388                 break;
389
390         case SIOCGIFSTATUS:
391                 s = splimp();
392                 ifs = (struct ifstat *)data;
393                 len = strlen(ifs->ascii);
394                 if (len < sizeof(ifs->ascii))
395                         snprintf(ifs->ascii + len,
396                                 sizeof(ifs->ascii) - len,
397                                 "\tch %d dma %d\n",
398                                         fwe->stream_ch, fwe->dma_ch);
399                 splx(s);
400                 break;
401         default:
402                 s = splimp();
403                 error = ether_ioctl(ifp, cmd, data);
404                 splx(s);
405                 return (error);
406         }
407
408         return (0);
409 }
410
411 static void
412 fwe_output_callback(struct fw_xfer *xfer)
413 {
414         struct fwe_softc *fwe;
415         struct ifnet *ifp;
416         int s;
417
418         fwe = (struct fwe_softc *)xfer->sc;
419         ifp = &fwe->fwe_if;
420         /* XXX error check */
421         FWEDEBUG(ifp, "resp = %d\n", xfer->resp);
422         if (xfer->resp != 0)
423                 ifp->if_oerrors ++;
424                 
425         m_freem(xfer->mbuf);
426         fw_xfer_unload(xfer);
427
428         s = splimp();
429         STAILQ_INSERT_TAIL(&fwe->xferlist, xfer, link);
430         splx(s);
431
432         /* for queue full */
433         if (!ifq_is_empty(&ifp->if_snd))
434                 fwe_start(ifp);
435 }
436
437 static void
438 fwe_start(struct ifnet *ifp)
439 {
440         struct fwe_softc *fwe = ((struct fwe_eth_softc *)ifp->if_softc)->fwe;
441         int s;
442
443         FWEDEBUG(ifp, "starting\n");
444
445         if (fwe->dma_ch < 0) {
446                 FWEDEBUG(ifp, "not ready\n");
447
448                 s = splimp();
449                 ifq_purge(&ifp->if_snd);
450                 splx(s);
451
452                 return;
453         }
454
455         s = splimp();
456         ifp->if_flags |= IFF_OACTIVE;
457
458         if (!ifq_is_empty(&ifp->if_snd))
459                 fwe_as_output(fwe, ifp);
460
461         ifp->if_flags &= ~IFF_OACTIVE;
462         splx(s);
463 }
464
465 #define HDR_LEN 4
466 #ifndef ETHER_ALIGN
467 #define ETHER_ALIGN 2
468 #endif
469 /* Async. stream output */
470 static void
471 fwe_as_output(struct fwe_softc *fwe, struct ifnet *ifp)
472 {
473         struct mbuf *m;
474         struct fw_xfer *xfer;
475         struct fw_xferq *xferq;
476         struct fw_pkt *fp;
477         int i = 0;
478
479         xfer = NULL;
480         xferq = fwe->fd.fc->atq;
481         while (xferq->queued < xferq->maxq - 1) {
482                 xfer = STAILQ_FIRST(&fwe->xferlist);
483                 if (xfer == NULL) {
484                         if_printf(ifp, "lack of xfer\n");
485                         return;
486                 }
487                 m = ifq_dequeue(&ifp->if_snd);
488                 if (m == NULL)
489                         break;
490                 STAILQ_REMOVE_HEAD(&fwe->xferlist, link);
491                 BPF_MTAP(ifp, m);
492
493                 /* keep ip packet alignment for alpha */
494                 M_PREPEND(m, ETHER_ALIGN, MB_DONTWAIT);
495                 fp = &xfer->send.hdr;
496                 *(u_int32_t *)&xfer->send.hdr = *(int32_t *)&fwe->pkt_hdr;
497                 fp->mode.stream.len = m->m_pkthdr.len;
498                 xfer->mbuf = m;
499                 xfer->send.pay_len = m->m_pkthdr.len;
500
501                 if (fw_asyreq(fwe->fd.fc, -1, xfer) != 0) {
502                         /* error */
503                         ifp->if_oerrors ++;
504                         /* XXX set error code */
505                         fwe_output_callback(xfer);
506                 } else {
507                         ifp->if_opackets ++;
508                         i++;
509                 }
510         }
511 #if 0
512         if (i > 1)
513                 if_printf(ifp, "%d queued\n", i);
514 #endif
515         if (i > 0)
516                 xferq->start(fwe->fd.fc);
517 }
518
519 /* Async. stream output */
520 static void
521 fwe_as_input(struct fw_xferq *xferq)
522 {
523         struct mbuf *m, *m0;
524         struct ifnet *ifp;
525         struct fwe_softc *fwe;
526         struct fw_bulkxfer *sxfer;
527         struct fw_pkt *fp;
528         u_char *c;
529
530         fwe = (struct fwe_softc *)xferq->sc;
531         ifp = &fwe->fwe_if;
532         while ((sxfer = STAILQ_FIRST(&xferq->stvalid)) != NULL) {
533                 STAILQ_REMOVE_HEAD(&xferq->stvalid, link);
534                 fp = mtod(sxfer->mbuf, struct fw_pkt *);
535                 if (fwe->fd.fc->irx_post != NULL)
536                         fwe->fd.fc->irx_post(fwe->fd.fc, fp->mode.ld);
537                 m = sxfer->mbuf;
538
539                 /* insert new rbuf */
540                 sxfer->mbuf = m0 = m_getcl(MB_DONTWAIT, MT_DATA, M_PKTHDR);
541                 if (m0 != NULL) {
542                         m0->m_len = m0->m_pkthdr.len = m0->m_ext.ext_size;
543                         STAILQ_INSERT_TAIL(&xferq->stfree, sxfer, link);
544                 } else {
545                         if_printf(ifp, "fwe_as_input: m_getcl failed\n");
546                 }
547
548                 if (sxfer->resp != 0 || fp->mode.stream.len <
549                     ETHER_ALIGN + sizeof(struct ether_header)) {
550                         m_freem(m);
551                         ifp->if_ierrors ++;
552                         continue;
553                 }
554
555                 m->m_data += HDR_LEN + ETHER_ALIGN;
556                 c = mtod(m, char *);
557                 m->m_len = m->m_pkthdr.len =
558                                 fp->mode.stream.len - ETHER_ALIGN;
559                 m->m_pkthdr.rcvif = ifp;
560 #if 0
561                 FWEDEBUG(ifp, "%02x %02x %02x %02x %02x %02x\n"
562                          "%02x %02x %02x %02x %02x %02x\n"
563                          "%02x %02x %02x %02x\n"
564                          "%02x %02x %02x %02x\n"
565                          "%02x %02x %02x %02x\n"
566                          "%02x %02x %02x %02x\n",
567                          c[0], c[1], c[2], c[3], c[4], c[5],
568                          c[6], c[7], c[8], c[9], c[10], c[11],
569                          c[12], c[13], c[14], c[15],
570                          c[16], c[17], c[18], c[19],
571                          c[20], c[21], c[22], c[23],
572                          c[20], c[21], c[22], c[23]
573                  );
574 #endif
575                 (*ifp->if_input)(ifp, m);
576                 ifp->if_ipackets ++;
577         }
578         if (STAILQ_FIRST(&xferq->stfree) != NULL)
579                 fwe->fd.fc->irx_enable(fwe->fd.fc, fwe->dma_ch);
580 }
581
582
583 static devclass_t fwe_devclass;
584
585 static device_method_t fwe_methods[] = {
586         /* device interface */
587         DEVMETHOD(device_identify,      fwe_identify),
588         DEVMETHOD(device_probe,         fwe_probe),
589         DEVMETHOD(device_attach,        fwe_attach),
590         DEVMETHOD(device_detach,        fwe_detach),
591         { 0, 0 }
592 };
593
594 static driver_t fwe_driver = {
595         "fwe",
596         fwe_methods,
597         sizeof(struct fwe_softc),
598 };
599
600
601 DECLARE_DUMMY_MODULE(fwe);
602 DRIVER_MODULE(fwe, firewire, fwe_driver, fwe_devclass, 0, 0);
603 MODULE_VERSION(fwe, 1);
604 MODULE_DEPEND(fwe, firewire, 1, 1, 1);