2 * Copyright (c) 2004 Doug Rabson
3 * Copyright (c) 1982, 1989, 1993
4 * The Regents of the University of California. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 4. Neither the name of the University nor the names of its contributors
15 * may be used to endorse or promote products derived from this software
16 * without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 #include "opt_inet6.h"
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/kernel.h>
41 #include <sys/malloc.h>
43 #include <sys/module.h>
44 #include <sys/socket.h>
45 #include <sys/sockio.h>
48 #include <net/netisr.h>
49 #include <net/route.h>
50 #include <net/if_llc.h>
51 #include <net/if_dl.h>
52 #include <net/if_types.h>
54 #include <net/firewire.h>
56 #if defined(INET) || defined(INET6)
57 #include <netinet/in.h>
58 #include <netinet/in_var.h>
59 #include <netinet/if_ether.h>
62 #include <netinet6/nd6.h>
65 #define IFP2FC(IFP) ((struct fw_com *)IFP)
67 MALLOC_DEFINE(M_FWCOM, "fw_com", "firewire interface internals");
69 struct fw_hwaddr firewire_broadcastaddr = {
79 firewire_output(struct ifnet *ifp, struct mbuf *m, struct sockaddr *dst,
82 struct fw_com *fc = IFP2FC(ifp);
84 struct rtentry *rt = NULL;
87 struct fw_hwaddr *destfw;
89 uint16_t psize, fsize, dsize;
91 int unicast, dgl, foff;
95 error = mac_check_ifnet_transmit(ifp, m);
100 if (!((ifp->if_flags & IFF_UP) &&
101 (ifp->if_drv_flags & IFF_DRV_RUNNING))) {
107 error = rt_check(&rt, &rt0, dst);
114 * For unicast, we make a tag to store the lladdr of the
115 * destination. This might not be the first time we have seen
116 * the packet (for instance, the arp code might be trying to
117 * re-send it after receiving an arp reply) so we only
118 * allocate a tag if there isn't one there already. For
119 * multicast, we will eventually use a different tag to store
120 * the channel number.
122 unicast = !(m->m_flags & (M_BCAST | M_MCAST));
124 mtag = m_tag_locate(m, MTAG_FIREWIRE, MTAG_FIREWIRE_HWADDR, NULL);
126 mtag = m_tag_alloc(MTAG_FIREWIRE, MTAG_FIREWIRE_HWADDR,
127 sizeof (struct fw_hwaddr), M_NOWAIT);
132 m_tag_prepend(m, mtag);
134 destfw = (struct fw_hwaddr *)(mtag + 1);
139 switch (dst->sa_family) {
143 * Only bother with arp for unicast. Allocation of
144 * channels etc. for firewire is quite different and
145 * doesn't fit into the arp model.
148 error = arpresolve(ifp, rt, m, dst, (u_char *) destfw);
150 return (error == EWOULDBLOCK ? 0 : error);
158 ah = mtod(m, struct arphdr *);
159 ah->ar_hrd = htons(ARPHRD_IEEE1394);
160 type = ETHERTYPE_ARP;
162 *destfw = *(struct fw_hwaddr *) ar_tha(ah);
165 * The standard arp code leaves a hole for the target
166 * hardware address which we need to close up.
168 bcopy(ar_tpa(ah), ar_tha(ah), ah->ar_pln);
169 m_adj(m, -ah->ar_hln);
177 error = nd6_storelladdr(fc->fc_ifp, rt, m, dst,
182 type = ETHERTYPE_IPV6;
187 if_printf(ifp, "can't handle af%d\n", dst->sa_family);
188 error = EAFNOSUPPORT;
193 * Let BPF tap off a copy before we encapsulate.
198 bcopy(destfw, h.firewire_dhost, 8);
200 bcopy(&firewire_broadcastaddr, h.firewire_dhost, 8);
201 bcopy(&fc->fc_hwaddr, h.firewire_shost, 8);
202 h.firewire_type = htons(type);
203 bpf_mtap2(ifp->if_bpf, &h, sizeof(h), m);
207 * Punt on MCAP for now and send all multicast packets on the
210 if (m->m_flags & M_MCAST)
211 m->m_flags |= M_BCAST;
214 * Figure out what speed to use and what the largest supported
215 * packet size is. For unicast, this is the minimum of what we
216 * can speak and what they can hear. For broadcast, lets be
217 * conservative and use S100. We could possibly improve that
218 * by examining the bus manager's speed map or similar. We
219 * also reduce the packet size for broadcast to account for
223 speed = min(fc->fc_speed, destfw->sspd);
224 psize = min(512 << speed, 2 << destfw->sender_max_rec);
227 psize = 512 - 2*sizeof(uint32_t);
231 * Next, we encapsulate, possibly fragmenting the original
232 * datagram if it won't fit into a single packet.
234 if (m->m_pkthdr.len <= psize - sizeof(uint32_t)) {
236 * No fragmentation is necessary.
238 M_PREPEND(m, sizeof(uint32_t), M_DONTWAIT);
243 enc = mtod(m, union fw_encap *);
244 enc->unfrag.ether_type = type;
245 enc->unfrag.lf = FW_ENCAP_UNFRAG;
246 enc->unfrag.reserved = 0;
249 * Byte swap the encapsulation header manually.
251 enc->ul[0] = htonl(enc->ul[0]);
253 IFQ_HANDOFF(ifp, m, error);
257 * Fragment the datagram, making sure to leave enough
258 * space for the encapsulation header in each packet.
260 fsize = psize - 2*sizeof(uint32_t);
262 dsize = m->m_pkthdr.len;
265 if (m->m_pkthdr.len > fsize) {
267 * Split off the tail segment from the
268 * datagram, copying our tags over.
270 mtail = m_split(m, fsize, M_DONTWAIT);
271 m_tag_copy_chain(mtail, m, M_NOWAIT);
277 * Add our encapsulation header to this
278 * fragment and hand it off to the link.
280 M_PREPEND(m, 2*sizeof(uint32_t), M_DONTWAIT);
285 enc = mtod(m, union fw_encap *);
287 enc->firstfrag.lf = FW_ENCAP_FIRST;
288 enc->firstfrag.reserved1 = 0;
289 enc->firstfrag.reserved2 = 0;
290 enc->firstfrag.datagram_size = dsize - 1;
291 enc->firstfrag.ether_type = type;
292 enc->firstfrag.dgl = dgl;
295 enc->nextfrag.lf = FW_ENCAP_NEXT;
297 enc->nextfrag.lf = FW_ENCAP_LAST;
298 enc->nextfrag.reserved1 = 0;
299 enc->nextfrag.reserved2 = 0;
300 enc->nextfrag.reserved3 = 0;
301 enc->nextfrag.datagram_size = dsize - 1;
302 enc->nextfrag.fragment_offset = foff;
303 enc->nextfrag.dgl = dgl;
305 foff += m->m_pkthdr.len - 2*sizeof(uint32_t);
308 * Byte swap the encapsulation header manually.
310 enc->ul[0] = htonl(enc->ul[0]);
311 enc->ul[1] = htonl(enc->ul[1]);
313 IFQ_HANDOFF(ifp, m, error);
333 firewire_input_fragment(struct fw_com *fc, struct mbuf *m, int src)
337 struct mbuf *mf, *mprev;
339 int fstart, fend, start, end, islast;
345 * Find an existing reassembly buffer or create a new one.
347 enc = mtod(m, union fw_encap *);
348 id = enc->firstfrag.dgl | (src << 16);
349 STAILQ_FOREACH(r, &fc->fc_frags, fr_link)
353 r = malloc(sizeof(struct fw_reass), M_TEMP, M_NOWAIT);
360 STAILQ_INSERT_HEAD(&fc->fc_frags, r, fr_link);
364 * If this fragment overlaps any other fragment, we must discard
365 * the partial reassembly and start again.
367 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
370 fstart = enc->nextfrag.fragment_offset;
371 fend = fstart + m->m_pkthdr.len - 2*sizeof(uint32_t);
372 dsize = enc->nextfrag.datagram_size;
373 islast = (enc->nextfrag.lf == FW_ENCAP_LAST);
375 for (mf = r->fr_frags; mf; mf = mf->m_nextpkt) {
376 enc = mtod(mf, union fw_encap *);
377 if (enc->nextfrag.datagram_size != dsize) {
379 * This fragment must be from a different
384 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
387 start = enc->nextfrag.fragment_offset;
388 end = start + mf->m_pkthdr.len - 2*sizeof(uint32_t);
389 if ((fstart < end && fend > start) ||
390 (islast && enc->nextfrag.lf == FW_ENCAP_LAST)) {
392 * Overlap - discard reassembly buffer and start
393 * again with this fragment.
400 * Find where to put this fragment in the list.
402 for (mf = r->fr_frags, mprev = NULL; mf;
403 mprev = mf, mf = mf->m_nextpkt) {
404 enc = mtod(mf, union fw_encap *);
405 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
408 start = enc->nextfrag.fragment_offset;
414 * If this is a last fragment and we are not adding at the end
415 * of the list, discard the buffer.
417 if (islast && mprev && mprev->m_nextpkt)
421 m->m_nextpkt = mprev->m_nextpkt;
422 mprev->m_nextpkt = m;
425 * Coalesce forwards and see if we can make a whole
428 enc = mtod(mprev, union fw_encap *);
429 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
432 start = enc->nextfrag.fragment_offset;
433 end = start + mprev->m_pkthdr.len - 2*sizeof(uint32_t);
434 while (end == fstart) {
436 * Strip off the encap header from m and
437 * append it to mprev, freeing m.
439 m_adj(m, 2*sizeof(uint32_t));
440 mprev->m_nextpkt = m->m_nextpkt;
441 mprev->m_pkthdr.len += m->m_pkthdr.len;
444 if (mprev->m_pkthdr.len == dsize + 1 + 2*sizeof(uint32_t)) {
446 * We have assembled a complete packet
447 * we must be finished. Make sure we have
448 * merged the whole chain.
450 STAILQ_REMOVE(&fc->fc_frags, r, fw_reass, fr_link);
452 m = mprev->m_nextpkt;
458 mprev->m_nextpkt = NULL;
464 * See if we can continue merging forwards.
467 m = mprev->m_nextpkt;
469 enc = mtod(m, union fw_encap *);
470 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
473 fstart = enc->nextfrag.fragment_offset;
474 fend = fstart + m->m_pkthdr.len
475 - 2*sizeof(uint32_t);
488 while (r->fr_frags) {
490 r->fr_frags = mf->m_nextpkt;
500 firewire_input(struct ifnet *ifp, struct mbuf *m, uint16_t src)
502 struct fw_com *fc = IFP2FC(ifp);
509 * The caller has already stripped off the packet header
510 * (stream or wreqb) and marked the mbuf's M_BCAST flag
511 * appropriately. We de-encapsulate the IP packet and pass it
512 * up the line after handling link-level fragmentation.
514 if (m->m_pkthdr.len < sizeof(uint32_t)) {
515 if_printf(ifp, "discarding frame without "
516 "encapsulation header (len %u pkt len %u)\n",
517 m->m_len, m->m_pkthdr.len);
520 m = m_pullup(m, sizeof(uint32_t));
521 enc = mtod(m, union fw_encap *);
524 * Byte swap the encapsulation header manually.
526 enc->ul[0] = ntohl(enc->ul[0]);
528 if (enc->unfrag.lf != 0) {
529 m = m_pullup(m, 2*sizeof(uint32_t));
532 enc = mtod(m, union fw_encap *);
533 enc->ul[1] = ntohl(enc->ul[1]);
534 m = firewire_input_fragment(fc, m, src);
537 enc = mtod(m, union fw_encap *);
538 type = enc->firstfrag.ether_type;
539 m_adj(m, 2*sizeof(uint32_t));
541 type = enc->unfrag.ether_type;
542 m_adj(m, sizeof(uint32_t));
545 if (m->m_pkthdr.rcvif == NULL) {
546 if_printf(ifp, "discard frame w/o interface pointer\n");
552 if (m->m_pkthdr.rcvif != ifp) {
553 if_printf(ifp, "Warning, frame marked as received on %s\n",
554 m->m_pkthdr.rcvif->if_xname);
560 * Tag the mbuf with an appropriate MAC label before any other
561 * consumers can get to it.
563 mac_create_mbuf_from_ifnet(ifp, m);
567 * Give bpf a chance at the packet. The link-level driver
568 * should have left us a tag with the EUID of the sender.
574 mtag = m_tag_locate(m, MTAG_FIREWIRE, MTAG_FIREWIRE_SENDER_EUID, 0);
576 bcopy(mtag + 1, h.firewire_shost, 8);
578 bcopy(&firewire_broadcastaddr, h.firewire_dhost, 8);
579 bcopy(&fc->fc_hwaddr, h.firewire_dhost, 8);
580 h.firewire_type = htons(type);
581 bpf_mtap2(ifp->if_bpf, &h, sizeof(h), m);
584 if (ifp->if_flags & IFF_MONITOR) {
586 * Interface marked for monitoring; discard packet.
592 ifp->if_ibytes += m->m_pkthdr.len;
594 /* Discard packet if interface is not up */
595 if ((ifp->if_flags & IFF_UP) == 0) {
600 if (m->m_flags & (M_BCAST|M_MCAST))
606 if (ip_fastforward(m))
614 ah = mtod(m, struct arphdr *);
617 * Adjust the arp packet to insert an empty tha slot.
619 m->m_len += ah->ar_hln;
620 m->m_pkthdr.len += ah->ar_hln;
621 bcopy(ar_tha(ah), ar_tpa(ah), ah->ar_pln);
638 netisr_dispatch(isr, m);
642 firewire_ioctl(struct ifnet *ifp, int command, caddr_t data)
644 struct ifaddr *ifa = (struct ifaddr *) data;
645 struct ifreq *ifr = (struct ifreq *) data;
650 ifp->if_flags |= IFF_UP;
652 switch (ifa->ifa_addr->sa_family) {
655 ifp->if_init(ifp->if_softc); /* before arpwhohas */
656 arp_ifinit(ifp, ifa);
660 ifp->if_init(ifp->if_softc);
669 sa = (struct sockaddr *) & ifr->ifr_data;
670 bcopy(&IFP2FC(ifp)->fc_hwaddr,
671 (caddr_t) sa->sa_data, sizeof(struct fw_hwaddr));
677 * Set the interface MTU.
679 if (ifr->ifr_mtu > 1500) {
682 ifp->if_mtu = ifr->ifr_mtu;
686 error = EINVAL; /* XXX netbsd has ENOTTY??? */
693 firewire_resolvemulti(struct ifnet *ifp, struct sockaddr **llsa,
697 struct sockaddr_in *sin;
700 struct sockaddr_in6 *sin6;
703 switch(sa->sa_family) {
713 sin = (struct sockaddr_in *)sa;
714 if (!IN_MULTICAST(ntohl(sin->sin_addr.s_addr)))
715 return EADDRNOTAVAIL;
721 sin6 = (struct sockaddr_in6 *)sa;
722 if (IN6_IS_ADDR_UNSPECIFIED(&sin6->sin6_addr)) {
724 * An IP6 address of 0 means listen to all
725 * of the Ethernet multicast address used for IP6.
726 * (This is used for multicast routers.)
728 ifp->if_flags |= IFF_ALLMULTI;
732 if (!IN6_IS_ADDR_MULTICAST(&sin6->sin6_addr))
733 return EADDRNOTAVAIL;
740 * Well, the text isn't quite right, but it's the name
748 firewire_ifattach(struct ifnet *ifp, struct fw_hwaddr *llc)
750 struct fw_com *fc = IFP2FC(ifp);
752 struct sockaddr_dl *sdl;
753 static const char* speeds[] = {
754 "S100", "S200", "S400", "S800",
758 fc->fc_speed = llc->sspd;
759 STAILQ_INIT(&fc->fc_frags);
761 ifp->if_addrlen = sizeof(struct fw_hwaddr);
764 ifp->if_mtu = 1500; /* XXX */
765 ifp->if_output = firewire_output;
766 ifp->if_resolvemulti = firewire_resolvemulti;
767 ifp->if_broadcastaddr = (u_char *) &firewire_broadcastaddr;
769 ifa = ifaddr_byindex(ifp->if_index);
770 KASSERT(ifa != NULL, ("%s: no lladdr!\n", __func__));
771 sdl = (struct sockaddr_dl *)ifa->ifa_addr;
772 sdl->sdl_type = IFT_IEEE1394;
773 sdl->sdl_alen = ifp->if_addrlen;
774 bcopy(llc, LLADDR(sdl), ifp->if_addrlen);
776 bpfattach(ifp, DLT_APPLE_IP_OVER_IEEE1394,
777 sizeof(struct fw_hwaddr));
779 if_printf(ifp, "Firewire address: %8D @ 0x%04x%08x, %s, maxrec %d\n",
780 (uint8_t *) &llc->sender_unique_ID_hi, ":",
781 ntohs(llc->sender_unicast_FIFO_hi),
782 ntohl(llc->sender_unicast_FIFO_lo),
784 (2 << llc->sender_max_rec));
788 firewire_ifdetach(struct ifnet *ifp)
795 firewire_busreset(struct ifnet *ifp)
797 struct fw_com *fc = IFP2FC(ifp);
802 * Discard any partial datagrams since the host ids may have changed.
804 while ((r = STAILQ_FIRST(&fc->fc_frags))) {
805 STAILQ_REMOVE_HEAD(&fc->fc_frags, fr_link);
806 while (r->fr_frags) {
808 r->fr_frags = m->m_nextpkt;
816 firewire_alloc(u_char type, struct ifnet *ifp)
820 fc = malloc(sizeof(struct fw_com), M_FWCOM, M_WAITOK | M_ZERO);
827 firewire_free(void *com, u_char type)
834 firewire_modevent(module_t mod, int type, void *data)
839 if_register_com_alloc(IFT_IEEE1394,
840 firewire_alloc, firewire_free);
843 if_deregister_com_alloc(IFT_IEEE1394);
852 static moduledata_t firewire_mod = {
858 DECLARE_MODULE(if_firewire, firewire_mod, SI_SUB_INIT_IF, SI_ORDER_ANY);
859 MODULE_VERSION(if_firewire, 1);