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))) {
109 * For unicast, we make a tag to store the lladdr of the
110 * destination. This might not be the first time we have seen
111 * the packet (for instance, the arp code might be trying to
112 * re-send it after receiving an arp reply) so we only
113 * allocate a tag if there isn't one there already. For
114 * multicast, we will eventually use a different tag to store
115 * the channel number.
117 unicast = !(m->m_flags & (M_BCAST | M_MCAST));
119 mtag = m_tag_locate(m, MTAG_FIREWIRE, MTAG_FIREWIRE_HWADDR, NULL);
121 mtag = m_tag_alloc(MTAG_FIREWIRE, MTAG_FIREWIRE_HWADDR,
122 sizeof (struct fw_hwaddr), M_NOWAIT);
127 m_tag_prepend(m, mtag);
129 destfw = (struct fw_hwaddr *)(mtag + 1);
134 switch (dst->sa_family) {
138 * Only bother with arp for unicast. Allocation of
139 * channels etc. for firewire is quite different and
140 * doesn't fit into the arp model.
143 error = arpresolve(ifp, ro ? ro->ro_rt : NULL, m, dst, (u_char *) destfw, &lle);
145 return (error == EWOULDBLOCK ? 0 : error);
153 ah = mtod(m, struct arphdr *);
154 ah->ar_hrd = htons(ARPHRD_IEEE1394);
155 type = ETHERTYPE_ARP;
157 *destfw = *(struct fw_hwaddr *) ar_tha(ah);
160 * The standard arp code leaves a hole for the target
161 * hardware address which we need to close up.
163 bcopy(ar_tpa(ah), ar_tha(ah), ah->ar_pln);
164 m_adj(m, -ah->ar_hln);
172 error = nd6_storelladdr(fc->fc_ifp, m, dst,
173 (u_char *) destfw, &lle);
177 type = ETHERTYPE_IPV6;
182 if_printf(ifp, "can't handle af%d\n", dst->sa_family);
183 error = EAFNOSUPPORT;
188 * Let BPF tap off a copy before we encapsulate.
190 if (bpf_peers_present(ifp->if_bpf)) {
193 bcopy(destfw, h.firewire_dhost, 8);
195 bcopy(&firewire_broadcastaddr, h.firewire_dhost, 8);
196 bcopy(&fc->fc_hwaddr, h.firewire_shost, 8);
197 h.firewire_type = htons(type);
198 bpf_mtap2(ifp->if_bpf, &h, sizeof(h), m);
202 * Punt on MCAP for now and send all multicast packets on the
205 if (m->m_flags & M_MCAST)
206 m->m_flags |= M_BCAST;
209 * Figure out what speed to use and what the largest supported
210 * packet size is. For unicast, this is the minimum of what we
211 * can speak and what they can hear. For broadcast, lets be
212 * conservative and use S100. We could possibly improve that
213 * by examining the bus manager's speed map or similar. We
214 * also reduce the packet size for broadcast to account for
218 speed = min(fc->fc_speed, destfw->sspd);
219 psize = min(512 << speed, 2 << destfw->sender_max_rec);
222 psize = 512 - 2*sizeof(uint32_t);
226 * Next, we encapsulate, possibly fragmenting the original
227 * datagram if it won't fit into a single packet.
229 if (m->m_pkthdr.len <= psize - sizeof(uint32_t)) {
231 * No fragmentation is necessary.
233 M_PREPEND(m, sizeof(uint32_t), M_NOWAIT);
238 enc = mtod(m, union fw_encap *);
239 enc->unfrag.ether_type = type;
240 enc->unfrag.lf = FW_ENCAP_UNFRAG;
241 enc->unfrag.reserved = 0;
244 * Byte swap the encapsulation header manually.
246 enc->ul[0] = htonl(enc->ul[0]);
248 error = (ifp->if_transmit)(ifp, m);
252 * Fragment the datagram, making sure to leave enough
253 * space for the encapsulation header in each packet.
255 fsize = psize - 2*sizeof(uint32_t);
257 dsize = m->m_pkthdr.len;
260 if (m->m_pkthdr.len > fsize) {
262 * Split off the tail segment from the
263 * datagram, copying our tags over.
265 mtail = m_split(m, fsize, M_NOWAIT);
266 m_tag_copy_chain(mtail, m, M_NOWAIT);
272 * Add our encapsulation header to this
273 * fragment and hand it off to the link.
275 M_PREPEND(m, 2*sizeof(uint32_t), M_NOWAIT);
280 enc = mtod(m, union fw_encap *);
282 enc->firstfrag.lf = FW_ENCAP_FIRST;
283 enc->firstfrag.reserved1 = 0;
284 enc->firstfrag.reserved2 = 0;
285 enc->firstfrag.datagram_size = dsize - 1;
286 enc->firstfrag.ether_type = type;
287 enc->firstfrag.dgl = dgl;
290 enc->nextfrag.lf = FW_ENCAP_NEXT;
292 enc->nextfrag.lf = FW_ENCAP_LAST;
293 enc->nextfrag.reserved1 = 0;
294 enc->nextfrag.reserved2 = 0;
295 enc->nextfrag.reserved3 = 0;
296 enc->nextfrag.datagram_size = dsize - 1;
297 enc->nextfrag.fragment_offset = foff;
298 enc->nextfrag.dgl = dgl;
300 foff += m->m_pkthdr.len - 2*sizeof(uint32_t);
303 * Byte swap the encapsulation header manually.
305 enc->ul[0] = htonl(enc->ul[0]);
306 enc->ul[1] = htonl(enc->ul[1]);
308 error = (ifp->if_transmit)(ifp, m);
328 firewire_input_fragment(struct fw_com *fc, struct mbuf *m, int src)
332 struct mbuf *mf, *mprev;
334 int fstart, fend, start, end, islast;
338 * Find an existing reassembly buffer or create a new one.
340 enc = mtod(m, union fw_encap *);
341 id = enc->firstfrag.dgl | (src << 16);
342 STAILQ_FOREACH(r, &fc->fc_frags, fr_link)
346 r = malloc(sizeof(struct fw_reass), M_TEMP, M_NOWAIT);
353 STAILQ_INSERT_HEAD(&fc->fc_frags, r, fr_link);
357 * If this fragment overlaps any other fragment, we must discard
358 * the partial reassembly and start again.
360 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
363 fstart = enc->nextfrag.fragment_offset;
364 fend = fstart + m->m_pkthdr.len - 2*sizeof(uint32_t);
365 dsize = enc->nextfrag.datagram_size;
366 islast = (enc->nextfrag.lf == FW_ENCAP_LAST);
368 for (mf = r->fr_frags; mf; mf = mf->m_nextpkt) {
369 enc = mtod(mf, union fw_encap *);
370 if (enc->nextfrag.datagram_size != dsize) {
372 * This fragment must be from a different
377 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
380 start = enc->nextfrag.fragment_offset;
381 end = start + mf->m_pkthdr.len - 2*sizeof(uint32_t);
382 if ((fstart < end && fend > start) ||
383 (islast && enc->nextfrag.lf == FW_ENCAP_LAST)) {
385 * Overlap - discard reassembly buffer and start
386 * again with this fragment.
393 * Find where to put this fragment in the list.
395 for (mf = r->fr_frags, mprev = NULL; mf;
396 mprev = mf, mf = mf->m_nextpkt) {
397 enc = mtod(mf, union fw_encap *);
398 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
401 start = enc->nextfrag.fragment_offset;
407 * If this is a last fragment and we are not adding at the end
408 * of the list, discard the buffer.
410 if (islast && mprev && mprev->m_nextpkt)
414 m->m_nextpkt = mprev->m_nextpkt;
415 mprev->m_nextpkt = m;
418 * Coalesce forwards and see if we can make a whole
421 enc = mtod(mprev, union fw_encap *);
422 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
425 start = enc->nextfrag.fragment_offset;
426 end = start + mprev->m_pkthdr.len - 2*sizeof(uint32_t);
427 while (end == fstart) {
429 * Strip off the encap header from m and
430 * append it to mprev, freeing m.
432 m_adj(m, 2*sizeof(uint32_t));
433 mprev->m_nextpkt = m->m_nextpkt;
434 mprev->m_pkthdr.len += m->m_pkthdr.len;
437 if (mprev->m_pkthdr.len == dsize + 1 + 2*sizeof(uint32_t)) {
439 * We have assembled a complete packet
440 * we must be finished. Make sure we have
441 * merged the whole chain.
443 STAILQ_REMOVE(&fc->fc_frags, r, fw_reass, fr_link);
445 m = mprev->m_nextpkt;
451 mprev->m_nextpkt = NULL;
457 * See if we can continue merging forwards.
460 m = mprev->m_nextpkt;
462 enc = mtod(m, union fw_encap *);
463 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
466 fstart = enc->nextfrag.fragment_offset;
467 fend = fstart + m->m_pkthdr.len
468 - 2*sizeof(uint32_t);
481 while (r->fr_frags) {
483 r->fr_frags = mf->m_nextpkt;
493 firewire_input(struct ifnet *ifp, struct mbuf *m, uint16_t src)
495 struct fw_com *fc = IFP2FWC(ifp);
500 * The caller has already stripped off the packet header
501 * (stream or wreqb) and marked the mbuf's M_BCAST flag
502 * appropriately. We de-encapsulate the IP packet and pass it
503 * up the line after handling link-level fragmentation.
505 if (m->m_pkthdr.len < sizeof(uint32_t)) {
506 if_printf(ifp, "discarding frame without "
507 "encapsulation header (len %u pkt len %u)\n",
508 m->m_len, m->m_pkthdr.len);
511 m = m_pullup(m, sizeof(uint32_t));
514 enc = mtod(m, union fw_encap *);
517 * Byte swap the encapsulation header manually.
519 enc->ul[0] = ntohl(enc->ul[0]);
521 if (enc->unfrag.lf != 0) {
522 m = m_pullup(m, 2*sizeof(uint32_t));
525 enc = mtod(m, union fw_encap *);
526 enc->ul[1] = ntohl(enc->ul[1]);
527 m = firewire_input_fragment(fc, m, src);
530 enc = mtod(m, union fw_encap *);
531 type = enc->firstfrag.ether_type;
532 m_adj(m, 2*sizeof(uint32_t));
534 type = enc->unfrag.ether_type;
535 m_adj(m, sizeof(uint32_t));
538 if (m->m_pkthdr.rcvif == NULL) {
539 if_printf(ifp, "discard frame w/o interface pointer\n");
545 if (m->m_pkthdr.rcvif != ifp) {
546 if_printf(ifp, "Warning, frame marked as received on %s\n",
547 m->m_pkthdr.rcvif->if_xname);
553 * Tag the mbuf with an appropriate MAC label before any other
554 * consumers can get to it.
556 mac_ifnet_create_mbuf(ifp, m);
560 * Give bpf a chance at the packet. The link-level driver
561 * should have left us a tag with the EUID of the sender.
563 if (bpf_peers_present(ifp->if_bpf)) {
567 mtag = m_tag_locate(m, MTAG_FIREWIRE, MTAG_FIREWIRE_SENDER_EUID, 0);
569 bcopy(mtag + 1, h.firewire_shost, 8);
571 bcopy(&firewire_broadcastaddr, h.firewire_dhost, 8);
572 bcopy(&fc->fc_hwaddr, h.firewire_dhost, 8);
573 h.firewire_type = htons(type);
574 bpf_mtap2(ifp->if_bpf, &h, sizeof(h), m);
577 if (ifp->if_flags & IFF_MONITOR) {
579 * Interface marked for monitoring; discard packet.
585 ifp->if_ibytes += m->m_pkthdr.len;
587 /* Discard packet if interface is not up */
588 if ((ifp->if_flags & IFF_UP) == 0) {
593 if (m->m_flags & (M_BCAST|M_MCAST))
599 if ((m = ip_fastforward(m)) == NULL)
607 ah = mtod(m, struct arphdr *);
610 * Adjust the arp packet to insert an empty tha slot.
612 m->m_len += ah->ar_hln;
613 m->m_pkthdr.len += ah->ar_hln;
614 bcopy(ar_tha(ah), ar_tpa(ah), ah->ar_pln);
631 M_SETFIB(m, ifp->if_fib);
632 netisr_dispatch(isr, m);
636 firewire_ioctl(struct ifnet *ifp, u_long command, caddr_t data)
638 struct ifaddr *ifa = (struct ifaddr *) data;
639 struct ifreq *ifr = (struct ifreq *) data;
644 ifp->if_flags |= IFF_UP;
646 switch (ifa->ifa_addr->sa_family) {
649 ifp->if_init(ifp->if_softc); /* before arpwhohas */
650 arp_ifinit(ifp, ifa);
654 ifp->if_init(ifp->if_softc);
663 sa = (struct sockaddr *) & ifr->ifr_data;
664 bcopy(&IFP2FWC(ifp)->fc_hwaddr,
665 (caddr_t) sa->sa_data, sizeof(struct fw_hwaddr));
671 * Set the interface MTU.
673 if (ifr->ifr_mtu > 1500) {
676 ifp->if_mtu = ifr->ifr_mtu;
680 error = EINVAL; /* XXX netbsd has ENOTTY??? */
687 firewire_resolvemulti(struct ifnet *ifp, struct sockaddr **llsa,
691 struct sockaddr_in *sin;
694 struct sockaddr_in6 *sin6;
697 switch(sa->sa_family) {
707 sin = (struct sockaddr_in *)sa;
708 if (!IN_MULTICAST(ntohl(sin->sin_addr.s_addr)))
709 return EADDRNOTAVAIL;
715 sin6 = (struct sockaddr_in6 *)sa;
716 if (IN6_IS_ADDR_UNSPECIFIED(&sin6->sin6_addr)) {
718 * An IP6 address of 0 means listen to all
719 * of the Ethernet multicast address used for IP6.
720 * (This is used for multicast routers.)
722 ifp->if_flags |= IFF_ALLMULTI;
726 if (!IN6_IS_ADDR_MULTICAST(&sin6->sin6_addr))
727 return EADDRNOTAVAIL;
734 * Well, the text isn't quite right, but it's the name
742 firewire_ifattach(struct ifnet *ifp, struct fw_hwaddr *llc)
744 struct fw_com *fc = IFP2FWC(ifp);
746 struct sockaddr_dl *sdl;
747 static const char* speeds[] = {
748 "S100", "S200", "S400", "S800",
752 fc->fc_speed = llc->sspd;
753 STAILQ_INIT(&fc->fc_frags);
755 ifp->if_addrlen = sizeof(struct fw_hwaddr);
758 ifp->if_mtu = 1500; /* XXX */
759 ifp->if_output = firewire_output;
760 ifp->if_resolvemulti = firewire_resolvemulti;
761 ifp->if_broadcastaddr = (u_char *) &firewire_broadcastaddr;
764 KASSERT(ifa != NULL, ("%s: no lladdr!\n", __func__));
765 sdl = (struct sockaddr_dl *)ifa->ifa_addr;
766 sdl->sdl_type = IFT_IEEE1394;
767 sdl->sdl_alen = ifp->if_addrlen;
768 bcopy(llc, LLADDR(sdl), ifp->if_addrlen);
770 bpfattach(ifp, DLT_APPLE_IP_OVER_IEEE1394,
771 sizeof(struct fw_hwaddr));
773 if_printf(ifp, "Firewire address: %8D @ 0x%04x%08x, %s, maxrec %d\n",
774 (uint8_t *) &llc->sender_unique_ID_hi, ":",
775 ntohs(llc->sender_unicast_FIFO_hi),
776 ntohl(llc->sender_unicast_FIFO_lo),
778 (2 << llc->sender_max_rec));
782 firewire_ifdetach(struct ifnet *ifp)
789 firewire_busreset(struct ifnet *ifp)
791 struct fw_com *fc = IFP2FWC(ifp);
796 * Discard any partial datagrams since the host ids may have changed.
798 while ((r = STAILQ_FIRST(&fc->fc_frags))) {
799 STAILQ_REMOVE_HEAD(&fc->fc_frags, fr_link);
800 while (r->fr_frags) {
802 r->fr_frags = m->m_nextpkt;
810 firewire_alloc(u_char type, struct ifnet *ifp)
814 fc = malloc(sizeof(struct fw_com), M_FWCOM, M_WAITOK | M_ZERO);
821 firewire_free(void *com, u_char type)
828 firewire_modevent(module_t mod, int type, void *data)
833 if_register_com_alloc(IFT_IEEE1394,
834 firewire_alloc, firewire_free);
837 if_deregister_com_alloc(IFT_IEEE1394);
846 static moduledata_t firewire_mod = {
852 DECLARE_MODULE(if_firewire, firewire_mod, SI_SUB_INIT_IF, SI_ORDER_ANY);
853 MODULE_VERSION(if_firewire, 1);