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)
110 is_gw = (ro->ro_flags & RT_HAS_GW) != 0;
113 * For unicast, we make a tag to store the lladdr of the
114 * destination. This might not be the first time we have seen
115 * the packet (for instance, the arp code might be trying to
116 * re-send it after receiving an arp reply) so we only
117 * allocate a tag if there isn't one there already. For
118 * multicast, we will eventually use a different tag to store
119 * the channel number.
121 unicast = !(m->m_flags & (M_BCAST | M_MCAST));
123 mtag = m_tag_locate(m, MTAG_FIREWIRE, MTAG_FIREWIRE_HWADDR, NULL);
125 mtag = m_tag_alloc(MTAG_FIREWIRE, MTAG_FIREWIRE_HWADDR,
126 sizeof (struct fw_hwaddr), M_NOWAIT);
131 m_tag_prepend(m, mtag);
133 destfw = (struct fw_hwaddr *)(mtag + 1);
138 switch (dst->sa_family) {
142 * Only bother with arp for unicast. Allocation of
143 * channels etc. for firewire is quite different and
144 * doesn't fit into the arp model.
147 error = arpresolve(ifp, is_gw, m, dst, (u_char *) destfw, NULL);
149 return (error == EWOULDBLOCK ? 0 : error);
157 ah = mtod(m, struct arphdr *);
158 ah->ar_hrd = htons(ARPHRD_IEEE1394);
159 type = ETHERTYPE_ARP;
161 *destfw = *(struct fw_hwaddr *) ar_tha(ah);
164 * The standard arp code leaves a hole for the target
165 * hardware address which we need to close up.
167 bcopy(ar_tpa(ah), ar_tha(ah), ah->ar_pln);
168 m_adj(m, -ah->ar_hln);
176 error = nd6_resolve(fc->fc_ifp, is_gw, m, dst,
177 (u_char *) destfw, NULL);
179 return (error == EWOULDBLOCK ? 0 : error);
181 type = ETHERTYPE_IPV6;
186 if_printf(ifp, "can't handle af%d\n", dst->sa_family);
187 error = EAFNOSUPPORT;
192 * Let BPF tap off a copy before we encapsulate.
194 if (bpf_peers_present(ifp->if_bpf)) {
197 bcopy(destfw, h.firewire_dhost, 8);
199 bcopy(&firewire_broadcastaddr, h.firewire_dhost, 8);
200 bcopy(&fc->fc_hwaddr, h.firewire_shost, 8);
201 h.firewire_type = htons(type);
202 bpf_mtap2(ifp->if_bpf, &h, sizeof(h), m);
206 * Punt on MCAP for now and send all multicast packets on the
209 if (m->m_flags & M_MCAST)
210 m->m_flags |= M_BCAST;
213 * Figure out what speed to use and what the largest supported
214 * packet size is. For unicast, this is the minimum of what we
215 * can speak and what they can hear. For broadcast, lets be
216 * conservative and use S100. We could possibly improve that
217 * by examining the bus manager's speed map or similar. We
218 * also reduce the packet size for broadcast to account for
222 speed = min(fc->fc_speed, destfw->sspd);
223 psize = min(512 << speed, 2 << destfw->sender_max_rec);
226 psize = 512 - 2*sizeof(uint32_t);
230 * Next, we encapsulate, possibly fragmenting the original
231 * datagram if it won't fit into a single packet.
233 if (m->m_pkthdr.len <= psize - sizeof(uint32_t)) {
235 * No fragmentation is necessary.
237 M_PREPEND(m, sizeof(uint32_t), M_NOWAIT);
242 enc = mtod(m, union fw_encap *);
243 enc->unfrag.ether_type = type;
244 enc->unfrag.lf = FW_ENCAP_UNFRAG;
245 enc->unfrag.reserved = 0;
248 * Byte swap the encapsulation header manually.
250 enc->ul[0] = htonl(enc->ul[0]);
252 error = (ifp->if_transmit)(ifp, m);
256 * Fragment the datagram, making sure to leave enough
257 * space for the encapsulation header in each packet.
259 fsize = psize - 2*sizeof(uint32_t);
261 dsize = m->m_pkthdr.len;
264 if (m->m_pkthdr.len > fsize) {
266 * Split off the tail segment from the
267 * datagram, copying our tags over.
269 mtail = m_split(m, fsize, M_NOWAIT);
270 m_tag_copy_chain(mtail, m, M_NOWAIT);
276 * Add our encapsulation header to this
277 * fragment and hand it off to the link.
279 M_PREPEND(m, 2*sizeof(uint32_t), M_NOWAIT);
284 enc = mtod(m, union fw_encap *);
286 enc->firstfrag.lf = FW_ENCAP_FIRST;
287 enc->firstfrag.reserved1 = 0;
288 enc->firstfrag.reserved2 = 0;
289 enc->firstfrag.datagram_size = dsize - 1;
290 enc->firstfrag.ether_type = type;
291 enc->firstfrag.dgl = dgl;
294 enc->nextfrag.lf = FW_ENCAP_NEXT;
296 enc->nextfrag.lf = FW_ENCAP_LAST;
297 enc->nextfrag.reserved1 = 0;
298 enc->nextfrag.reserved2 = 0;
299 enc->nextfrag.reserved3 = 0;
300 enc->nextfrag.datagram_size = dsize - 1;
301 enc->nextfrag.fragment_offset = foff;
302 enc->nextfrag.dgl = dgl;
304 foff += m->m_pkthdr.len - 2*sizeof(uint32_t);
307 * Byte swap the encapsulation header manually.
309 enc->ul[0] = htonl(enc->ul[0]);
310 enc->ul[1] = htonl(enc->ul[1]);
312 error = (ifp->if_transmit)(ifp, m);
332 firewire_input_fragment(struct fw_com *fc, struct mbuf *m, int src)
336 struct mbuf *mf, *mprev;
338 int fstart, fend, start, end, islast;
342 * Find an existing reassembly buffer or create a new one.
344 enc = mtod(m, union fw_encap *);
345 id = enc->firstfrag.dgl | (src << 16);
346 STAILQ_FOREACH(r, &fc->fc_frags, fr_link)
350 r = malloc(sizeof(struct fw_reass), M_TEMP, M_NOWAIT);
357 STAILQ_INSERT_HEAD(&fc->fc_frags, r, fr_link);
361 * If this fragment overlaps any other fragment, we must discard
362 * the partial reassembly and start again.
364 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
367 fstart = enc->nextfrag.fragment_offset;
368 fend = fstart + m->m_pkthdr.len - 2*sizeof(uint32_t);
369 dsize = enc->nextfrag.datagram_size;
370 islast = (enc->nextfrag.lf == FW_ENCAP_LAST);
372 for (mf = r->fr_frags; mf; mf = mf->m_nextpkt) {
373 enc = mtod(mf, union fw_encap *);
374 if (enc->nextfrag.datagram_size != dsize) {
376 * This fragment must be from a different
381 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
384 start = enc->nextfrag.fragment_offset;
385 end = start + mf->m_pkthdr.len - 2*sizeof(uint32_t);
386 if ((fstart < end && fend > start) ||
387 (islast && enc->nextfrag.lf == FW_ENCAP_LAST)) {
389 * Overlap - discard reassembly buffer and start
390 * again with this fragment.
397 * Find where to put this fragment in the list.
399 for (mf = r->fr_frags, mprev = NULL; mf;
400 mprev = mf, mf = mf->m_nextpkt) {
401 enc = mtod(mf, union fw_encap *);
402 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
405 start = enc->nextfrag.fragment_offset;
411 * If this is a last fragment and we are not adding at the end
412 * of the list, discard the buffer.
414 if (islast && mprev && mprev->m_nextpkt)
418 m->m_nextpkt = mprev->m_nextpkt;
419 mprev->m_nextpkt = m;
422 * Coalesce forwards and see if we can make a whole
425 enc = mtod(mprev, union fw_encap *);
426 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
429 start = enc->nextfrag.fragment_offset;
430 end = start + mprev->m_pkthdr.len - 2*sizeof(uint32_t);
431 while (end == fstart) {
433 * Strip off the encap header from m and
434 * append it to mprev, freeing m.
436 m_adj(m, 2*sizeof(uint32_t));
437 mprev->m_nextpkt = m->m_nextpkt;
438 mprev->m_pkthdr.len += m->m_pkthdr.len;
441 if (mprev->m_pkthdr.len == dsize + 1 + 2*sizeof(uint32_t)) {
443 * We have assembled a complete packet
444 * we must be finished. Make sure we have
445 * merged the whole chain.
447 STAILQ_REMOVE(&fc->fc_frags, r, fw_reass, fr_link);
449 m = mprev->m_nextpkt;
455 mprev->m_nextpkt = NULL;
461 * See if we can continue merging forwards.
464 m = mprev->m_nextpkt;
466 enc = mtod(m, union fw_encap *);
467 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
470 fstart = enc->nextfrag.fragment_offset;
471 fend = fstart + m->m_pkthdr.len
472 - 2*sizeof(uint32_t);
485 while (r->fr_frags) {
487 r->fr_frags = mf->m_nextpkt;
497 firewire_input(struct ifnet *ifp, struct mbuf *m, uint16_t src)
499 struct fw_com *fc = IFP2FWC(ifp);
504 * The caller has already stripped off the packet header
505 * (stream or wreqb) and marked the mbuf's M_BCAST flag
506 * appropriately. We de-encapsulate the IP packet and pass it
507 * up the line after handling link-level fragmentation.
509 if (m->m_pkthdr.len < sizeof(uint32_t)) {
510 if_printf(ifp, "discarding frame without "
511 "encapsulation header (len %u pkt len %u)\n",
512 m->m_len, m->m_pkthdr.len);
515 m = m_pullup(m, sizeof(uint32_t));
518 enc = mtod(m, union fw_encap *);
521 * Byte swap the encapsulation header manually.
523 enc->ul[0] = ntohl(enc->ul[0]);
525 if (enc->unfrag.lf != 0) {
526 m = m_pullup(m, 2*sizeof(uint32_t));
529 enc = mtod(m, union fw_encap *);
530 enc->ul[1] = ntohl(enc->ul[1]);
531 m = firewire_input_fragment(fc, m, src);
534 enc = mtod(m, union fw_encap *);
535 type = enc->firstfrag.ether_type;
536 m_adj(m, 2*sizeof(uint32_t));
538 type = enc->unfrag.ether_type;
539 m_adj(m, sizeof(uint32_t));
542 if (m->m_pkthdr.rcvif == NULL) {
543 if_printf(ifp, "discard frame w/o interface pointer\n");
544 if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
549 if (m->m_pkthdr.rcvif != ifp) {
550 if_printf(ifp, "Warning, frame marked as received on %s\n",
551 m->m_pkthdr.rcvif->if_xname);
557 * Tag the mbuf with an appropriate MAC label before any other
558 * consumers can get to it.
560 mac_ifnet_create_mbuf(ifp, m);
564 * Give bpf a chance at the packet. The link-level driver
565 * should have left us a tag with the EUID of the sender.
567 if (bpf_peers_present(ifp->if_bpf)) {
571 mtag = m_tag_locate(m, MTAG_FIREWIRE, MTAG_FIREWIRE_SENDER_EUID, 0);
573 bcopy(mtag + 1, h.firewire_shost, 8);
575 bcopy(&firewire_broadcastaddr, h.firewire_dhost, 8);
576 bcopy(&fc->fc_hwaddr, h.firewire_dhost, 8);
577 h.firewire_type = htons(type);
578 bpf_mtap2(ifp->if_bpf, &h, sizeof(h), m);
581 if (ifp->if_flags & IFF_MONITOR) {
583 * Interface marked for monitoring; discard packet.
589 if_inc_counter(ifp, IFCOUNTER_IBYTES, m->m_pkthdr.len);
591 /* Discard packet if interface is not up */
592 if ((ifp->if_flags & IFF_UP) == 0) {
597 if (m->m_flags & (M_BCAST|M_MCAST))
598 if_inc_counter(ifp, IFCOUNTER_IMCASTS, 1);
609 ah = mtod(m, struct arphdr *);
612 * Adjust the arp packet to insert an empty tha slot.
614 m->m_len += ah->ar_hln;
615 m->m_pkthdr.len += ah->ar_hln;
616 bcopy(ar_tha(ah), ar_tpa(ah), ah->ar_pln);
633 M_SETFIB(m, ifp->if_fib);
634 netisr_dispatch(isr, m);
638 firewire_ioctl(struct ifnet *ifp, u_long command, caddr_t data)
640 struct ifaddr *ifa = (struct ifaddr *) data;
641 struct ifreq *ifr = (struct ifreq *) data;
646 ifp->if_flags |= IFF_UP;
648 switch (ifa->ifa_addr->sa_family) {
651 ifp->if_init(ifp->if_softc); /* before arpwhohas */
652 arp_ifinit(ifp, ifa);
656 ifp->if_init(ifp->if_softc);
665 sa = (struct sockaddr *) & ifr->ifr_data;
666 bcopy(&IFP2FWC(ifp)->fc_hwaddr,
667 (caddr_t) sa->sa_data, sizeof(struct fw_hwaddr));
673 * Set the interface MTU.
675 if (ifr->ifr_mtu > 1500) {
678 ifp->if_mtu = ifr->ifr_mtu;
682 error = EINVAL; /* XXX netbsd has ENOTTY??? */
689 firewire_resolvemulti(struct ifnet *ifp, struct sockaddr **llsa,
693 struct sockaddr_in *sin;
696 struct sockaddr_in6 *sin6;
699 switch(sa->sa_family) {
709 sin = (struct sockaddr_in *)sa;
710 if (!IN_MULTICAST(ntohl(sin->sin_addr.s_addr)))
711 return EADDRNOTAVAIL;
717 sin6 = (struct sockaddr_in6 *)sa;
718 if (IN6_IS_ADDR_UNSPECIFIED(&sin6->sin6_addr)) {
720 * An IP6 address of 0 means listen to all
721 * of the Ethernet multicast address used for IP6.
722 * (This is used for multicast routers.)
724 ifp->if_flags |= IFF_ALLMULTI;
728 if (!IN6_IS_ADDR_MULTICAST(&sin6->sin6_addr))
729 return EADDRNOTAVAIL;
736 * Well, the text isn't quite right, but it's the name
744 firewire_ifattach(struct ifnet *ifp, struct fw_hwaddr *llc)
746 struct fw_com *fc = IFP2FWC(ifp);
748 struct sockaddr_dl *sdl;
749 static const char* speeds[] = {
750 "S100", "S200", "S400", "S800",
754 fc->fc_speed = llc->sspd;
755 STAILQ_INIT(&fc->fc_frags);
757 ifp->if_addrlen = sizeof(struct fw_hwaddr);
760 ifp->if_mtu = 1500; /* XXX */
761 ifp->if_output = firewire_output;
762 ifp->if_resolvemulti = firewire_resolvemulti;
763 ifp->if_broadcastaddr = (u_char *) &firewire_broadcastaddr;
766 KASSERT(ifa != NULL, ("%s: no lladdr!\n", __func__));
767 sdl = (struct sockaddr_dl *)ifa->ifa_addr;
768 sdl->sdl_type = IFT_IEEE1394;
769 sdl->sdl_alen = ifp->if_addrlen;
770 bcopy(llc, LLADDR(sdl), ifp->if_addrlen);
772 bpfattach(ifp, DLT_APPLE_IP_OVER_IEEE1394,
773 sizeof(struct fw_hwaddr));
775 if_printf(ifp, "Firewire address: %8D @ 0x%04x%08x, %s, maxrec %d\n",
776 (uint8_t *) &llc->sender_unique_ID_hi, ":",
777 ntohs(llc->sender_unicast_FIFO_hi),
778 ntohl(llc->sender_unicast_FIFO_lo),
780 (2 << llc->sender_max_rec));
784 firewire_ifdetach(struct ifnet *ifp)
791 firewire_busreset(struct ifnet *ifp)
793 struct fw_com *fc = IFP2FWC(ifp);
798 * Discard any partial datagrams since the host ids may have changed.
800 while ((r = STAILQ_FIRST(&fc->fc_frags))) {
801 STAILQ_REMOVE_HEAD(&fc->fc_frags, fr_link);
802 while (r->fr_frags) {
804 r->fr_frags = m->m_nextpkt;
812 firewire_alloc(u_char type, struct ifnet *ifp)
816 fc = malloc(sizeof(struct fw_com), M_FWCOM, M_WAITOK | M_ZERO);
823 firewire_free(void *com, u_char type)
830 firewire_modevent(module_t mod, int type, void *data)
835 if_register_com_alloc(IFT_IEEE1394,
836 firewire_alloc, firewire_free);
839 if_deregister_com_alloc(IFT_IEEE1394);
848 static moduledata_t firewire_mod = {
854 DECLARE_MODULE(if_firewire, firewire_mod, SI_SUB_INIT_IF, SI_ORDER_ANY);
855 MODULE_VERSION(if_firewire, 1);