2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2004 Doug Rabson
5 * Copyright (c) 1982, 1989, 1993
6 * The Regents of the University of California. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of the University nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * 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)
95 int af = RO_GET_FAMILY(ro, dst);
98 error = mac_ifnet_check_transmit(ifp, m);
103 if (!((ifp->if_flags & IFF_UP) &&
104 (ifp->if_drv_flags & IFF_DRV_RUNNING))) {
109 #if defined(INET) || defined(INET6)
111 is_gw = (ro->ro_flags & RT_HAS_GW) != 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);
145 type = ETHERTYPE_ARP;
150 type = ETHERTYPE_IPV6;
154 if_printf(ifp, "can't handle af%d\n", af);
155 error = EAFNOSUPPORT;
159 switch (dst->sa_family) {
163 * Only bother with arp for unicast. Allocation of
164 * channels etc. for firewire is quite different and
165 * doesn't fit into the arp model.
168 error = arpresolve(ifp, is_gw, m, dst,
169 (u_char *) destfw, NULL, NULL);
171 return (error == EWOULDBLOCK ? 0 : error);
178 ah = mtod(m, struct arphdr *);
179 ah->ar_hrd = htons(ARPHRD_IEEE1394);
181 *destfw = *(struct fw_hwaddr *) ar_tha(ah);
184 * The standard arp code leaves a hole for the target
185 * hardware address which we need to close up.
187 bcopy(ar_tpa(ah), ar_tha(ah), ah->ar_pln);
188 m_adj(m, -ah->ar_hln);
196 error = nd6_resolve(fc->fc_ifp, LLE_SF(af, is_gw), m,
197 dst, (u_char *) destfw, NULL, NULL);
199 return (error == EWOULDBLOCK ? 0 : error);
205 if_printf(ifp, "can't handle af%d\n", dst->sa_family);
206 error = EAFNOSUPPORT;
211 * Let BPF tap off a copy before we encapsulate.
213 if (bpf_peers_present(ifp->if_bpf)) {
216 bcopy(destfw, h.firewire_dhost, 8);
218 bcopy(&firewire_broadcastaddr, h.firewire_dhost, 8);
219 bcopy(&fc->fc_hwaddr, h.firewire_shost, 8);
220 h.firewire_type = htons(type);
221 bpf_mtap2(ifp->if_bpf, &h, sizeof(h), m);
225 * Punt on MCAP for now and send all multicast packets on the
228 if (m->m_flags & M_MCAST)
229 m->m_flags |= M_BCAST;
232 * Figure out what speed to use and what the largest supported
233 * packet size is. For unicast, this is the minimum of what we
234 * can speak and what they can hear. For broadcast, lets be
235 * conservative and use S100. We could possibly improve that
236 * by examining the bus manager's speed map or similar. We
237 * also reduce the packet size for broadcast to account for
241 speed = min(fc->fc_speed, destfw->sspd);
242 psize = min(512 << speed, 2 << destfw->sender_max_rec);
245 psize = 512 - 2*sizeof(uint32_t);
249 * Next, we encapsulate, possibly fragmenting the original
250 * datagram if it won't fit into a single packet.
252 if (m->m_pkthdr.len <= psize - sizeof(uint32_t)) {
254 * No fragmentation is necessary.
256 M_PREPEND(m, sizeof(uint32_t), M_NOWAIT);
261 enc = mtod(m, union fw_encap *);
262 enc->unfrag.ether_type = type;
263 enc->unfrag.lf = FW_ENCAP_UNFRAG;
264 enc->unfrag.reserved = 0;
267 * Byte swap the encapsulation header manually.
269 enc->ul[0] = htonl(enc->ul[0]);
271 error = (ifp->if_transmit)(ifp, m);
275 * Fragment the datagram, making sure to leave enough
276 * space for the encapsulation header in each packet.
278 fsize = psize - 2*sizeof(uint32_t);
280 dsize = m->m_pkthdr.len;
283 if (m->m_pkthdr.len > fsize) {
285 * Split off the tail segment from the
286 * datagram, copying our tags over.
288 mtail = m_split(m, fsize, M_NOWAIT);
289 m_tag_copy_chain(mtail, m, M_NOWAIT);
295 * Add our encapsulation header to this
296 * fragment and hand it off to the link.
298 M_PREPEND(m, 2*sizeof(uint32_t), M_NOWAIT);
303 enc = mtod(m, union fw_encap *);
305 enc->firstfrag.lf = FW_ENCAP_FIRST;
306 enc->firstfrag.reserved1 = 0;
307 enc->firstfrag.reserved2 = 0;
308 enc->firstfrag.datagram_size = dsize - 1;
309 enc->firstfrag.ether_type = type;
310 enc->firstfrag.dgl = dgl;
313 enc->nextfrag.lf = FW_ENCAP_NEXT;
315 enc->nextfrag.lf = FW_ENCAP_LAST;
316 enc->nextfrag.reserved1 = 0;
317 enc->nextfrag.reserved2 = 0;
318 enc->nextfrag.reserved3 = 0;
319 enc->nextfrag.datagram_size = dsize - 1;
320 enc->nextfrag.fragment_offset = foff;
321 enc->nextfrag.dgl = dgl;
323 foff += m->m_pkthdr.len - 2*sizeof(uint32_t);
326 * Byte swap the encapsulation header manually.
328 enc->ul[0] = htonl(enc->ul[0]);
329 enc->ul[1] = htonl(enc->ul[1]);
331 error = (ifp->if_transmit)(ifp, m);
351 firewire_input_fragment(struct fw_com *fc, struct mbuf *m, int src)
355 struct mbuf *mf, *mprev;
357 int fstart, fend, start, end, islast;
361 * Find an existing reassembly buffer or create a new one.
363 enc = mtod(m, union fw_encap *);
364 id = enc->firstfrag.dgl | (src << 16);
365 STAILQ_FOREACH(r, &fc->fc_frags, fr_link)
369 r = malloc(sizeof(struct fw_reass), M_TEMP, M_NOWAIT);
376 STAILQ_INSERT_HEAD(&fc->fc_frags, r, fr_link);
380 * If this fragment overlaps any other fragment, we must discard
381 * the partial reassembly and start again.
383 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
386 fstart = enc->nextfrag.fragment_offset;
387 fend = fstart + m->m_pkthdr.len - 2*sizeof(uint32_t);
388 dsize = enc->nextfrag.datagram_size;
389 islast = (enc->nextfrag.lf == FW_ENCAP_LAST);
391 for (mf = r->fr_frags; mf; mf = mf->m_nextpkt) {
392 enc = mtod(mf, union fw_encap *);
393 if (enc->nextfrag.datagram_size != dsize) {
395 * This fragment must be from a different
400 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
403 start = enc->nextfrag.fragment_offset;
404 end = start + mf->m_pkthdr.len - 2*sizeof(uint32_t);
405 if ((fstart < end && fend > start) ||
406 (islast && enc->nextfrag.lf == FW_ENCAP_LAST)) {
408 * Overlap - discard reassembly buffer and start
409 * again with this fragment.
416 * Find where to put this fragment in the list.
418 for (mf = r->fr_frags, mprev = NULL; mf;
419 mprev = mf, mf = mf->m_nextpkt) {
420 enc = mtod(mf, union fw_encap *);
421 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
424 start = enc->nextfrag.fragment_offset;
430 * If this is a last fragment and we are not adding at the end
431 * of the list, discard the buffer.
433 if (islast && mprev && mprev->m_nextpkt)
437 m->m_nextpkt = mprev->m_nextpkt;
438 mprev->m_nextpkt = m;
441 * Coalesce forwards and see if we can make a whole
444 enc = mtod(mprev, union fw_encap *);
445 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
448 start = enc->nextfrag.fragment_offset;
449 end = start + mprev->m_pkthdr.len - 2*sizeof(uint32_t);
450 while (end == fstart) {
452 * Strip off the encap header from m and
453 * append it to mprev, freeing m.
455 m_adj(m, 2*sizeof(uint32_t));
456 mprev->m_nextpkt = m->m_nextpkt;
457 mprev->m_pkthdr.len += m->m_pkthdr.len;
460 if (mprev->m_pkthdr.len == dsize + 1 + 2*sizeof(uint32_t)) {
462 * We have assembled a complete packet
463 * we must be finished. Make sure we have
464 * merged the whole chain.
466 STAILQ_REMOVE(&fc->fc_frags, r, fw_reass, fr_link);
468 m = mprev->m_nextpkt;
474 mprev->m_nextpkt = NULL;
480 * See if we can continue merging forwards.
483 m = mprev->m_nextpkt;
485 enc = mtod(m, union fw_encap *);
486 if (enc->firstfrag.lf == FW_ENCAP_FIRST)
489 fstart = enc->nextfrag.fragment_offset;
490 fend = fstart + m->m_pkthdr.len
491 - 2*sizeof(uint32_t);
504 while (r->fr_frags) {
506 r->fr_frags = mf->m_nextpkt;
516 firewire_input(struct ifnet *ifp, struct mbuf *m, uint16_t src)
518 struct fw_com *fc = IFP2FWC(ifp);
523 * The caller has already stripped off the packet header
524 * (stream or wreqb) and marked the mbuf's M_BCAST flag
525 * appropriately. We de-encapsulate the IP packet and pass it
526 * up the line after handling link-level fragmentation.
528 if (m->m_pkthdr.len < sizeof(uint32_t)) {
529 if_printf(ifp, "discarding frame without "
530 "encapsulation header (len %u pkt len %u)\n",
531 m->m_len, m->m_pkthdr.len);
534 m = m_pullup(m, sizeof(uint32_t));
537 enc = mtod(m, union fw_encap *);
540 * Byte swap the encapsulation header manually.
542 enc->ul[0] = ntohl(enc->ul[0]);
544 if (enc->unfrag.lf != 0) {
545 m = m_pullup(m, 2*sizeof(uint32_t));
548 enc = mtod(m, union fw_encap *);
549 enc->ul[1] = ntohl(enc->ul[1]);
550 m = firewire_input_fragment(fc, m, src);
553 enc = mtod(m, union fw_encap *);
554 type = enc->firstfrag.ether_type;
555 m_adj(m, 2*sizeof(uint32_t));
557 type = enc->unfrag.ether_type;
558 m_adj(m, sizeof(uint32_t));
561 if (m->m_pkthdr.rcvif == NULL) {
562 if_printf(ifp, "discard frame w/o interface pointer\n");
563 if_inc_counter(ifp, IFCOUNTER_IERRORS, 1);
568 if (m->m_pkthdr.rcvif != ifp) {
569 if_printf(ifp, "Warning, frame marked as received on %s\n",
570 m->m_pkthdr.rcvif->if_xname);
576 * Tag the mbuf with an appropriate MAC label before any other
577 * consumers can get to it.
579 mac_ifnet_create_mbuf(ifp, m);
583 * Give bpf a chance at the packet. The link-level driver
584 * should have left us a tag with the EUID of the sender.
586 if (bpf_peers_present(ifp->if_bpf)) {
590 mtag = m_tag_locate(m, MTAG_FIREWIRE, MTAG_FIREWIRE_SENDER_EUID, 0);
592 bcopy(mtag + 1, h.firewire_shost, 8);
594 bcopy(&firewire_broadcastaddr, h.firewire_dhost, 8);
595 bcopy(&fc->fc_hwaddr, h.firewire_dhost, 8);
596 h.firewire_type = htons(type);
597 bpf_mtap2(ifp->if_bpf, &h, sizeof(h), m);
600 if (ifp->if_flags & IFF_MONITOR) {
602 * Interface marked for monitoring; discard packet.
608 if_inc_counter(ifp, IFCOUNTER_IBYTES, m->m_pkthdr.len);
610 /* Discard packet if interface is not up */
611 if ((ifp->if_flags & IFF_UP) == 0) {
616 if (m->m_flags & (M_BCAST|M_MCAST))
617 if_inc_counter(ifp, IFCOUNTER_IMCASTS, 1);
628 ah = mtod(m, struct arphdr *);
631 * Adjust the arp packet to insert an empty tha slot.
633 m->m_len += ah->ar_hln;
634 m->m_pkthdr.len += ah->ar_hln;
635 bcopy(ar_tha(ah), ar_tpa(ah), ah->ar_pln);
652 M_SETFIB(m, ifp->if_fib);
653 CURVNET_SET_QUIET(ifp->if_vnet);
654 netisr_dispatch(isr, m);
659 firewire_ioctl(struct ifnet *ifp, u_long command, caddr_t data)
661 struct ifaddr *ifa = (struct ifaddr *) data;
662 struct ifreq *ifr = (struct ifreq *) data;
667 ifp->if_flags |= IFF_UP;
669 switch (ifa->ifa_addr->sa_family) {
672 ifp->if_init(ifp->if_softc); /* before arpwhohas */
673 arp_ifinit(ifp, ifa);
677 ifp->if_init(ifp->if_softc);
683 bcopy(&IFP2FWC(ifp)->fc_hwaddr, &ifr->ifr_addr.sa_data[0],
684 sizeof(struct fw_hwaddr));
689 * Set the interface MTU.
691 if (ifr->ifr_mtu > 1500) {
694 ifp->if_mtu = ifr->ifr_mtu;
698 error = EINVAL; /* XXX netbsd has ENOTTY??? */
705 firewire_resolvemulti(struct ifnet *ifp, struct sockaddr **llsa,
709 struct sockaddr_in *sin;
712 struct sockaddr_in6 *sin6;
715 switch(sa->sa_family) {
725 sin = (struct sockaddr_in *)sa;
726 if (!IN_MULTICAST(ntohl(sin->sin_addr.s_addr)))
727 return EADDRNOTAVAIL;
733 sin6 = (struct sockaddr_in6 *)sa;
734 if (IN6_IS_ADDR_UNSPECIFIED(&sin6->sin6_addr)) {
736 * An IP6 address of 0 means listen to all
737 * of the Ethernet multicast address used for IP6.
738 * (This is used for multicast routers.)
740 ifp->if_flags |= IFF_ALLMULTI;
744 if (!IN6_IS_ADDR_MULTICAST(&sin6->sin6_addr))
745 return EADDRNOTAVAIL;
752 * Well, the text isn't quite right, but it's the name
760 firewire_ifattach(struct ifnet *ifp, struct fw_hwaddr *llc)
762 struct fw_com *fc = IFP2FWC(ifp);
764 struct sockaddr_dl *sdl;
765 static const char* speeds[] = {
766 "S100", "S200", "S400", "S800",
770 fc->fc_speed = llc->sspd;
771 STAILQ_INIT(&fc->fc_frags);
773 ifp->if_addrlen = sizeof(struct fw_hwaddr);
776 ifp->if_mtu = 1500; /* XXX */
777 ifp->if_output = firewire_output;
778 ifp->if_resolvemulti = firewire_resolvemulti;
779 ifp->if_broadcastaddr = (u_char *) &firewire_broadcastaddr;
782 KASSERT(ifa != NULL, ("%s: no lladdr!\n", __func__));
783 sdl = (struct sockaddr_dl *)ifa->ifa_addr;
784 sdl->sdl_type = IFT_IEEE1394;
785 sdl->sdl_alen = ifp->if_addrlen;
786 bcopy(llc, LLADDR(sdl), ifp->if_addrlen);
788 bpfattach(ifp, DLT_APPLE_IP_OVER_IEEE1394,
789 sizeof(struct fw_hwaddr));
791 if_printf(ifp, "Firewire address: %8D @ 0x%04x%08x, %s, maxrec %d\n",
792 (uint8_t *) &llc->sender_unique_ID_hi, ":",
793 ntohs(llc->sender_unicast_FIFO_hi),
794 ntohl(llc->sender_unicast_FIFO_lo),
796 (2 << llc->sender_max_rec));
800 firewire_ifdetach(struct ifnet *ifp)
807 firewire_busreset(struct ifnet *ifp)
809 struct fw_com *fc = IFP2FWC(ifp);
814 * Discard any partial datagrams since the host ids may have changed.
816 while ((r = STAILQ_FIRST(&fc->fc_frags))) {
817 STAILQ_REMOVE_HEAD(&fc->fc_frags, fr_link);
818 while (r->fr_frags) {
820 r->fr_frags = m->m_nextpkt;
828 firewire_alloc(u_char type, struct ifnet *ifp)
832 fc = malloc(sizeof(struct fw_com), M_FWCOM, M_WAITOK | M_ZERO);
839 firewire_free(void *com, u_char type)
846 firewire_modevent(module_t mod, int type, void *data)
851 if_register_com_alloc(IFT_IEEE1394,
852 firewire_alloc, firewire_free);
855 if_deregister_com_alloc(IFT_IEEE1394);
864 static moduledata_t firewire_mod = {
870 DECLARE_MODULE(if_firewire, firewire_mod, SI_SUB_INIT_IF, SI_ORDER_ANY);
871 MODULE_VERSION(if_firewire, 1);