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"
36 #include <sys/param.h>
37 #include <sys/systm.h>
38 #include <sys/kernel.h>
39 #include <sys/malloc.h>
41 #include <sys/module.h>
42 #include <sys/socket.h>
43 #include <sys/sockio.h>
46 #include <net/if_var.h>
47 #include <net/netisr.h>
48 #include <net/route.h>
49 #include <net/if_llc.h>
50 #include <net/if_dl.h>
51 #include <net/if_types.h>
53 #include <net/firewire.h>
54 #include <net/if_llatbl.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 #include <security/mac/mac_framework.h>
67 static MALLOC_DEFINE(M_FWCOM, "fw_com", "firewire interface internals");
69 struct fw_hwaddr firewire_broadcastaddr = {
79 firewire_output(struct ifnet *ifp, struct mbuf *m, const struct sockaddr *dst,
82 struct fw_com *fc = IFP2FWC(ifp);
86 struct fw_hwaddr *destfw;
88 uint16_t psize, fsize, dsize;
90 int unicast, dgl, foff;
92 #if defined(INET) || defined(INET6)
97 error = mac_ifnet_check_transmit(ifp, m);
102 if (!((ifp->if_flags & IFF_UP) &&
103 (ifp->if_drv_flags & IFF_DRV_RUNNING))) {
108 #if defined(INET) || defined(INET6)
109 if (ro != NULL && ro->ro_rt != NULL &&
110 (ro->ro_rt->rt_flags & RTF_GATEWAY) != 0)
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.
149 if (ro != NULL && ro->ro_rt != NULL &&
150 (ro->ro_rt->rt_flags & RTF_GATEWAY) != 0)
152 error = arpresolve(ifp, is_gw, m, dst, (u_char *) destfw, NULL);
154 return (error == EWOULDBLOCK ? 0 : error);
162 ah = mtod(m, struct arphdr *);
163 ah->ar_hrd = htons(ARPHRD_IEEE1394);
164 type = ETHERTYPE_ARP;
166 *destfw = *(struct fw_hwaddr *) ar_tha(ah);
169 * The standard arp code leaves a hole for the target
170 * hardware address which we need to close up.
172 bcopy(ar_tpa(ah), ar_tha(ah), ah->ar_pln);
173 m_adj(m, -ah->ar_hln);
181 error = nd6_resolve(fc->fc_ifp, is_gw, m, dst,
182 (u_char *) destfw, NULL);
184 return (error == EWOULDBLOCK ? 0 : error);
186 type = ETHERTYPE_IPV6;
191 if_printf(ifp, "can't handle af%d\n", dst->sa_family);
192 error = EAFNOSUPPORT;
197 * Let BPF tap off a copy before we encapsulate.
199 if (bpf_peers_present(ifp->if_bpf)) {
202 bcopy(destfw, h.firewire_dhost, 8);
204 bcopy(&firewire_broadcastaddr, h.firewire_dhost, 8);
205 bcopy(&fc->fc_hwaddr, h.firewire_shost, 8);
206 h.firewire_type = htons(type);
207 bpf_mtap2(ifp->if_bpf, &h, sizeof(h), m);
211 * Punt on MCAP for now and send all multicast packets on the
214 if (m->m_flags & M_MCAST)
215 m->m_flags |= M_BCAST;
218 * Figure out what speed to use and what the largest supported
219 * packet size is. For unicast, this is the minimum of what we
220 * can speak and what they can hear. For broadcast, lets be
221 * conservative and use S100. We could possibly improve that
222 * by examining the bus manager's speed map or similar. We
223 * also reduce the packet size for broadcast to account for
227 speed = min(fc->fc_speed, destfw->sspd);
228 psize = min(512 << speed, 2 << destfw->sender_max_rec);
231 psize = 512 - 2*sizeof(uint32_t);
235 * Next, we encapsulate, possibly fragmenting the original
236 * datagram if it won't fit into a single packet.
238 if (m->m_pkthdr.len <= psize - sizeof(uint32_t)) {
240 * No fragmentation is necessary.
242 M_PREPEND(m, sizeof(uint32_t), M_NOWAIT);
247 enc = mtod(m, union fw_encap *);
248 enc->unfrag.ether_type = type;
249 enc->unfrag.lf = FW_ENCAP_UNFRAG;
250 enc->unfrag.reserved = 0;
253 * Byte swap the encapsulation header manually.
255 enc->ul[0] = htonl(enc->ul[0]);
257 error = (ifp->if_transmit)(ifp, m);
261 * Fragment the datagram, making sure to leave enough
262 * space for the encapsulation header in each packet.
264 fsize = psize - 2*sizeof(uint32_t);
266 dsize = m->m_pkthdr.len;
269 if (m->m_pkthdr.len > fsize) {
271 * Split off the tail segment from the
272 * datagram, copying our tags over.
274 mtail = m_split(m, fsize, M_NOWAIT);
275 m_tag_copy_chain(mtail, m, M_NOWAIT);
281 * Add our encapsulation header to this
282 * fragment and hand it off to the link.
284 M_PREPEND(m, 2*sizeof(uint32_t), M_NOWAIT);
289 enc = mtod(m, union fw_encap *);
291 enc->firstfrag.lf = FW_ENCAP_FIRST;
292 enc->firstfrag.reserved1 = 0;
293 enc->firstfrag.reserved2 = 0;
294 enc->firstfrag.datagram_size = dsize - 1;
295 enc->firstfrag.ether_type = type;
296 enc->firstfrag.dgl = dgl;
299 enc->nextfrag.lf = FW_ENCAP_NEXT;
301 enc->nextfrag.lf = FW_ENCAP_LAST;
302 enc->nextfrag.reserved1 = 0;
303 enc->nextfrag.reserved2 = 0;
304 enc->nextfrag.reserved3 = 0;
305 enc->nextfrag.datagram_size = dsize - 1;
306 enc->nextfrag.fragment_offset = foff;
307 enc->nextfrag.dgl = dgl;
309 foff += m->m_pkthdr.len - 2*sizeof(uint32_t);
312 * Byte swap the encapsulation header manually.
314 enc->ul[0] = htonl(enc->ul[0]);
315 enc->ul[1] = htonl(enc->ul[1]);
317 error = (ifp->if_transmit)(ifp, m);
337 firewire_input_fragment(struct fw_com *fc, struct mbuf *m, int src)
341 struct mbuf *mf, *mprev;
343 int fstart, fend, start, end, islast;
347 * Find an existing reassembly buffer or create a new one.
349 enc = mtod(m, union fw_encap *);
350 id = enc->firstfrag.dgl | (src << 16);
351 STAILQ_FOREACH(r, &fc->fc_frags, fr_link)
355 r = malloc(sizeof(struct fw_reass), M_TEMP, M_NOWAIT);
362 STAILQ_INSERT_HEAD(&fc->fc_frags, r, fr_link);
366 * If this fragment overlaps any other fragment, we must discard
367 * the partial reassembly and start again.
369 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
372 fstart = enc->nextfrag.fragment_offset;
373 fend = fstart + m->m_pkthdr.len - 2*sizeof(uint32_t);
374 dsize = enc->nextfrag.datagram_size;
375 islast = (enc->nextfrag.lf == FW_ENCAP_LAST);
377 for (mf = r->fr_frags; mf; mf = mf->m_nextpkt) {
378 enc = mtod(mf, union fw_encap *);
379 if (enc->nextfrag.datagram_size != dsize) {
381 * This fragment must be from a different
386 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
389 start = enc->nextfrag.fragment_offset;
390 end = start + mf->m_pkthdr.len - 2*sizeof(uint32_t);
391 if ((fstart < end && fend > start) ||
392 (islast && enc->nextfrag.lf == FW_ENCAP_LAST)) {
394 * Overlap - discard reassembly buffer and start
395 * again with this fragment.
402 * Find where to put this fragment in the list.
404 for (mf = r->fr_frags, mprev = NULL; mf;
405 mprev = mf, mf = mf->m_nextpkt) {
406 enc = mtod(mf, union fw_encap *);
407 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
410 start = enc->nextfrag.fragment_offset;
416 * If this is a last fragment and we are not adding at the end
417 * of the list, discard the buffer.
419 if (islast && mprev && mprev->m_nextpkt)
423 m->m_nextpkt = mprev->m_nextpkt;
424 mprev->m_nextpkt = m;
427 * Coalesce forwards and see if we can make a whole
430 enc = mtod(mprev, union fw_encap *);
431 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
434 start = enc->nextfrag.fragment_offset;
435 end = start + mprev->m_pkthdr.len - 2*sizeof(uint32_t);
436 while (end == fstart) {
438 * Strip off the encap header from m and
439 * append it to mprev, freeing m.
441 m_adj(m, 2*sizeof(uint32_t));
442 mprev->m_nextpkt = m->m_nextpkt;
443 mprev->m_pkthdr.len += m->m_pkthdr.len;
446 if (mprev->m_pkthdr.len == dsize + 1 + 2*sizeof(uint32_t)) {
448 * We have assembled a complete packet
449 * we must be finished. Make sure we have
450 * merged the whole chain.
452 STAILQ_REMOVE(&fc->fc_frags, r, fw_reass, fr_link);
454 m = mprev->m_nextpkt;
460 mprev->m_nextpkt = NULL;
466 * See if we can continue merging forwards.
469 m = mprev->m_nextpkt;
471 enc = mtod(m, union fw_encap *);
472 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
475 fstart = enc->nextfrag.fragment_offset;
476 fend = fstart + m->m_pkthdr.len
477 - 2*sizeof(uint32_t);
490 while (r->fr_frags) {
492 r->fr_frags = mf->m_nextpkt;
502 firewire_input(struct ifnet *ifp, struct mbuf *m, uint16_t src)
504 struct fw_com *fc = IFP2FWC(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));
523 enc = mtod(m, union fw_encap *);
526 * Byte swap the encapsulation header manually.
528 enc->ul[0] = ntohl(enc->ul[0]);
530 if (enc->unfrag.lf != 0) {
531 m = m_pullup(m, 2*sizeof(uint32_t));
534 enc = mtod(m, union fw_encap *);
535 enc->ul[1] = ntohl(enc->ul[1]);
536 m = firewire_input_fragment(fc, m, src);
539 enc = mtod(m, union fw_encap *);
540 type = enc->firstfrag.ether_type;
541 m_adj(m, 2*sizeof(uint32_t));
543 type = enc->unfrag.ether_type;
544 m_adj(m, sizeof(uint32_t));
547 if (m->m_pkthdr.rcvif == NULL) {
548 if_printf(ifp, "discard frame w/o interface pointer\n");
549 if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
554 if (m->m_pkthdr.rcvif != ifp) {
555 if_printf(ifp, "Warning, frame marked as received on %s\n",
556 m->m_pkthdr.rcvif->if_xname);
562 * Tag the mbuf with an appropriate MAC label before any other
563 * consumers can get to it.
565 mac_ifnet_create_mbuf(ifp, m);
569 * Give bpf a chance at the packet. The link-level driver
570 * should have left us a tag with the EUID of the sender.
572 if (bpf_peers_present(ifp->if_bpf)) {
576 mtag = m_tag_locate(m, MTAG_FIREWIRE, MTAG_FIREWIRE_SENDER_EUID, 0);
578 bcopy(mtag + 1, h.firewire_shost, 8);
580 bcopy(&firewire_broadcastaddr, h.firewire_dhost, 8);
581 bcopy(&fc->fc_hwaddr, h.firewire_dhost, 8);
582 h.firewire_type = htons(type);
583 bpf_mtap2(ifp->if_bpf, &h, sizeof(h), m);
586 if (ifp->if_flags & IFF_MONITOR) {
588 * Interface marked for monitoring; discard packet.
594 if_inc_counter(ifp, IFCOUNTER_IBYTES, m->m_pkthdr.len);
596 /* Discard packet if interface is not up */
597 if ((ifp->if_flags & IFF_UP) == 0) {
602 if (m->m_flags & (M_BCAST|M_MCAST))
603 if_inc_counter(ifp, IFCOUNTER_IMCASTS, 1);
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 M_SETFIB(m, ifp->if_fib);
639 netisr_dispatch(isr, m);
643 firewire_ioctl(struct ifnet *ifp, u_long command, caddr_t data)
645 struct ifaddr *ifa = (struct ifaddr *) data;
646 struct ifreq *ifr = (struct ifreq *) data;
651 ifp->if_flags |= IFF_UP;
653 switch (ifa->ifa_addr->sa_family) {
656 ifp->if_init(ifp->if_softc); /* before arpwhohas */
657 arp_ifinit(ifp, ifa);
661 ifp->if_init(ifp->if_softc);
670 sa = (struct sockaddr *) & ifr->ifr_data;
671 bcopy(&IFP2FWC(ifp)->fc_hwaddr,
672 (caddr_t) sa->sa_data, sizeof(struct fw_hwaddr));
678 * Set the interface MTU.
680 if (ifr->ifr_mtu > 1500) {
683 ifp->if_mtu = ifr->ifr_mtu;
687 error = EINVAL; /* XXX netbsd has ENOTTY??? */
694 firewire_resolvemulti(struct ifnet *ifp, struct sockaddr **llsa,
698 struct sockaddr_in *sin;
701 struct sockaddr_in6 *sin6;
704 switch(sa->sa_family) {
714 sin = (struct sockaddr_in *)sa;
715 if (!IN_MULTICAST(ntohl(sin->sin_addr.s_addr)))
716 return EADDRNOTAVAIL;
722 sin6 = (struct sockaddr_in6 *)sa;
723 if (IN6_IS_ADDR_UNSPECIFIED(&sin6->sin6_addr)) {
725 * An IP6 address of 0 means listen to all
726 * of the Ethernet multicast address used for IP6.
727 * (This is used for multicast routers.)
729 ifp->if_flags |= IFF_ALLMULTI;
733 if (!IN6_IS_ADDR_MULTICAST(&sin6->sin6_addr))
734 return EADDRNOTAVAIL;
741 * Well, the text isn't quite right, but it's the name
749 firewire_ifattach(struct ifnet *ifp, struct fw_hwaddr *llc)
751 struct fw_com *fc = IFP2FWC(ifp);
753 struct sockaddr_dl *sdl;
754 static const char* speeds[] = {
755 "S100", "S200", "S400", "S800",
759 fc->fc_speed = llc->sspd;
760 STAILQ_INIT(&fc->fc_frags);
762 ifp->if_addrlen = sizeof(struct fw_hwaddr);
765 ifp->if_mtu = 1500; /* XXX */
766 ifp->if_output = firewire_output;
767 ifp->if_resolvemulti = firewire_resolvemulti;
768 ifp->if_broadcastaddr = (u_char *) &firewire_broadcastaddr;
771 KASSERT(ifa != NULL, ("%s: no lladdr!\n", __func__));
772 sdl = (struct sockaddr_dl *)ifa->ifa_addr;
773 sdl->sdl_type = IFT_IEEE1394;
774 sdl->sdl_alen = ifp->if_addrlen;
775 bcopy(llc, LLADDR(sdl), ifp->if_addrlen);
777 bpfattach(ifp, DLT_APPLE_IP_OVER_IEEE1394,
778 sizeof(struct fw_hwaddr));
780 if_printf(ifp, "Firewire address: %8D @ 0x%04x%08x, %s, maxrec %d\n",
781 (uint8_t *) &llc->sender_unique_ID_hi, ":",
782 ntohs(llc->sender_unicast_FIFO_hi),
783 ntohl(llc->sender_unicast_FIFO_lo),
785 (2 << llc->sender_max_rec));
789 firewire_ifdetach(struct ifnet *ifp)
796 firewire_busreset(struct ifnet *ifp)
798 struct fw_com *fc = IFP2FWC(ifp);
803 * Discard any partial datagrams since the host ids may have changed.
805 while ((r = STAILQ_FIRST(&fc->fc_frags))) {
806 STAILQ_REMOVE_HEAD(&fc->fc_frags, fr_link);
807 while (r->fr_frags) {
809 r->fr_frags = m->m_nextpkt;
817 firewire_alloc(u_char type, struct ifnet *ifp)
821 fc = malloc(sizeof(struct fw_com), M_FWCOM, M_WAITOK | M_ZERO);
828 firewire_free(void *com, u_char type)
835 firewire_modevent(module_t mod, int type, void *data)
840 if_register_com_alloc(IFT_IEEE1394,
841 firewire_alloc, firewire_free);
844 if_deregister_com_alloc(IFT_IEEE1394);
853 static moduledata_t firewire_mod = {
859 DECLARE_MODULE(if_firewire, firewire_mod, SI_SUB_INIT_IF, SI_ORDER_ANY);
860 MODULE_VERSION(if_firewire, 1);