2 * Copyright 2011, Siemens AG
3 * written by Alexander Smirnov <alex.bluesman.smirnov@gmail.com>
7 * Based on patches from Jon Smirl <jonsmirl@gmail.com>
8 * Copyright (c) 2011 Jon Smirl <jonsmirl@gmail.com>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2
12 * as published by the Free Software Foundation.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 /* Jon's code is based on 6lowpan implementation for Contiki which is:
25 * Copyright (c) 2008, Swedish Institute of Computer Science.
26 * All rights reserved.
28 * Redistribution and use in source and binary forms, with or without
29 * modification, are permitted provided that the following conditions
31 * 1. Redistributions of source code must retain the above copyright
32 * notice, this list of conditions and the following disclaimer.
33 * 2. Redistributions in binary form must reproduce the above copyright
34 * notice, this list of conditions and the following disclaimer in the
35 * documentation and/or other materials provided with the distribution.
36 * 3. Neither the name of the Institute nor the names of its contributors
37 * may be used to endorse or promote products derived from this software
38 * without specific prior written permission.
40 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 #include <linux/bitops.h>
54 #include <linux/if_arp.h>
55 #include <linux/module.h>
56 #include <linux/moduleparam.h>
57 #include <linux/netdevice.h>
58 #include <net/af_ieee802154.h>
59 #include <net/ieee802154.h>
60 #include <net/ieee802154_netdev.h>
65 /* TTL uncompression values */
66 static const u8 lowpan_ttl_values[] = {0, 1, 64, 255};
68 static LIST_HEAD(lowpan_devices);
70 /* private device info */
71 struct lowpan_dev_info {
72 struct net_device *real_dev; /* real WPAN device ptr */
73 struct mutex dev_list_mtx; /* mutex for list ops */
74 unsigned short fragment_tag;
77 struct lowpan_dev_record {
78 struct net_device *ldev;
79 struct list_head list;
82 struct lowpan_fragment {
83 struct sk_buff *skb; /* skb to be assembled */
84 u16 length; /* length to be assemled */
85 u32 bytes_rcv; /* bytes received */
86 u16 tag; /* current fragment tag */
87 struct timer_list timer; /* assembling timer */
88 struct list_head list; /* fragments list */
91 static LIST_HEAD(lowpan_fragments);
92 static DEFINE_SPINLOCK(flist_lock);
95 lowpan_dev_info *lowpan_dev_info(const struct net_device *dev)
97 return netdev_priv(dev);
100 static inline void lowpan_address_flip(u8 *src, u8 *dest)
103 for (i = 0; i < IEEE802154_ADDR_LEN; i++)
104 (dest)[IEEE802154_ADDR_LEN - i - 1] = (src)[i];
107 /* list of all 6lowpan devices, uses for package delivering */
108 /* print data in line */
109 static inline void lowpan_raw_dump_inline(const char *caller, char *msg,
110 unsigned char *buf, int len)
114 pr_debug("(%s) %s: ", caller, msg);
115 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_NONE,
116 16, 1, buf, len, false);
121 * print data in a table format:
123 * addr: xx xx xx xx xx xx
124 * addr: xx xx xx xx xx xx
127 static inline void lowpan_raw_dump_table(const char *caller, char *msg,
128 unsigned char *buf, int len)
132 pr_debug("(%s) %s:\n", caller, msg);
133 print_hex_dump(KERN_DEBUG, "\t", DUMP_PREFIX_OFFSET,
134 16, 1, buf, len, false);
139 lowpan_compress_addr_64(u8 **hc06_ptr, u8 shift, const struct in6_addr *ipaddr,
140 const unsigned char *lladdr)
144 if (is_addr_mac_addr_based(ipaddr, lladdr))
145 val = 3; /* 0-bits */
146 else if (lowpan_is_iid_16_bit_compressable(ipaddr)) {
147 /* compress IID to 16 bits xxxx::XXXX */
148 memcpy(*hc06_ptr, &ipaddr->s6_addr16[7], 2);
150 val = 2; /* 16-bits */
152 /* do not compress IID => xxxx::IID */
153 memcpy(*hc06_ptr, &ipaddr->s6_addr16[4], 8);
155 val = 1; /* 64-bits */
158 return rol8(val, shift);
162 * Uncompress address function for source and
163 * destination address(non-multicast).
165 * address_mode is sam value or dam value.
168 lowpan_uncompress_addr(struct sk_buff *skb,
169 struct in6_addr *ipaddr,
170 const u8 address_mode,
171 const struct ieee802154_addr *lladdr)
175 switch (address_mode) {
176 case LOWPAN_IPHC_ADDR_00:
177 /* for global link addresses */
178 fail = lowpan_fetch_skb(skb, ipaddr->s6_addr, 16);
180 case LOWPAN_IPHC_ADDR_01:
181 /* fe:80::XXXX:XXXX:XXXX:XXXX */
182 ipaddr->s6_addr[0] = 0xFE;
183 ipaddr->s6_addr[1] = 0x80;
184 fail = lowpan_fetch_skb(skb, &ipaddr->s6_addr[8], 8);
186 case LOWPAN_IPHC_ADDR_02:
187 /* fe:80::ff:fe00:XXXX */
188 ipaddr->s6_addr[0] = 0xFE;
189 ipaddr->s6_addr[1] = 0x80;
190 ipaddr->s6_addr[11] = 0xFF;
191 ipaddr->s6_addr[12] = 0xFE;
192 fail = lowpan_fetch_skb(skb, &ipaddr->s6_addr[14], 2);
194 case LOWPAN_IPHC_ADDR_03:
196 switch (lladdr->addr_type) {
197 case IEEE802154_ADDR_LONG:
198 /* fe:80::XXXX:XXXX:XXXX:XXXX
199 * \_________________/
202 ipaddr->s6_addr[0] = 0xFE;
203 ipaddr->s6_addr[1] = 0x80;
204 memcpy(&ipaddr->s6_addr[8], lladdr->hwaddr,
205 IEEE802154_ADDR_LEN);
206 /* second bit-flip (Universe/Local)
207 * is done according RFC2464
209 ipaddr->s6_addr[8] ^= 0x02;
211 case IEEE802154_ADDR_SHORT:
212 /* fe:80::ff:fe00:XXXX
216 * Universe/Local bit is zero.
218 ipaddr->s6_addr[0] = 0xFE;
219 ipaddr->s6_addr[1] = 0x80;
220 ipaddr->s6_addr[11] = 0xFF;
221 ipaddr->s6_addr[12] = 0xFE;
222 ipaddr->s6_addr16[7] = htons(lladdr->short_addr);
225 pr_debug("Invalid addr_type set\n");
230 pr_debug("Invalid address mode value: 0x%x\n", address_mode);
235 pr_debug("Failed to fetch skb data\n");
239 lowpan_raw_dump_inline(NULL, "Reconstructed ipv6 addr is:\n",
240 ipaddr->s6_addr, 16);
245 /* Uncompress address function for source context
246 * based address(non-multicast).
249 lowpan_uncompress_context_based_src_addr(struct sk_buff *skb,
250 struct in6_addr *ipaddr,
254 case LOWPAN_IPHC_ADDR_00:
256 * Do nothing, address is already ::
259 case LOWPAN_IPHC_ADDR_01:
261 case LOWPAN_IPHC_ADDR_02:
263 case LOWPAN_IPHC_ADDR_03:
265 netdev_warn(skb->dev, "SAM value 0x%x not supported\n", sam);
268 pr_debug("Invalid sam value: 0x%x\n", sam);
272 lowpan_raw_dump_inline(NULL,
273 "Reconstructed context based ipv6 src addr is:\n",
274 ipaddr->s6_addr, 16);
279 /* Uncompress function for multicast destination address,
283 lowpan_uncompress_multicast_daddr(struct sk_buff *skb,
284 struct in6_addr *ipaddr,
290 case LOWPAN_IPHC_DAM_00:
291 /* 00: 128 bits. The full address
292 * is carried in-line.
294 fail = lowpan_fetch_skb(skb, ipaddr->s6_addr, 16);
296 case LOWPAN_IPHC_DAM_01:
297 /* 01: 48 bits. The address takes
298 * the form ffXX::00XX:XXXX:XXXX.
300 ipaddr->s6_addr[0] = 0xFF;
301 fail = lowpan_fetch_skb(skb, &ipaddr->s6_addr[1], 1);
302 fail |= lowpan_fetch_skb(skb, &ipaddr->s6_addr[11], 5);
304 case LOWPAN_IPHC_DAM_10:
305 /* 10: 32 bits. The address takes
306 * the form ffXX::00XX:XXXX.
308 ipaddr->s6_addr[0] = 0xFF;
309 fail = lowpan_fetch_skb(skb, &ipaddr->s6_addr[1], 1);
310 fail |= lowpan_fetch_skb(skb, &ipaddr->s6_addr[13], 3);
312 case LOWPAN_IPHC_DAM_11:
313 /* 11: 8 bits. The address takes
314 * the form ff02::00XX.
316 ipaddr->s6_addr[0] = 0xFF;
317 ipaddr->s6_addr[1] = 0x02;
318 fail = lowpan_fetch_skb(skb, &ipaddr->s6_addr[15], 1);
321 pr_debug("DAM value has a wrong value: 0x%x\n", dam);
326 pr_debug("Failed to fetch skb data\n");
330 lowpan_raw_dump_inline(NULL, "Reconstructed ipv6 multicast addr is:\n",
331 ipaddr->s6_addr, 16);
337 lowpan_compress_udp_header(u8 **hc06_ptr, struct sk_buff *skb)
339 struct udphdr *uh = udp_hdr(skb);
341 if (((uh->source & LOWPAN_NHC_UDP_4BIT_MASK) ==
342 LOWPAN_NHC_UDP_4BIT_PORT) &&
343 ((uh->dest & LOWPAN_NHC_UDP_4BIT_MASK) ==
344 LOWPAN_NHC_UDP_4BIT_PORT)) {
345 pr_debug("UDP header: both ports compression to 4 bits\n");
346 **hc06_ptr = LOWPAN_NHC_UDP_CS_P_11;
347 **(hc06_ptr + 1) = /* subtraction is faster */
348 (u8)((uh->dest - LOWPAN_NHC_UDP_4BIT_PORT) +
349 ((uh->source & LOWPAN_NHC_UDP_4BIT_PORT) << 4));
351 } else if ((uh->dest & LOWPAN_NHC_UDP_8BIT_MASK) ==
352 LOWPAN_NHC_UDP_8BIT_PORT) {
353 pr_debug("UDP header: remove 8 bits of dest\n");
354 **hc06_ptr = LOWPAN_NHC_UDP_CS_P_01;
355 memcpy(*hc06_ptr + 1, &uh->source, 2);
356 **(hc06_ptr + 3) = (u8)(uh->dest - LOWPAN_NHC_UDP_8BIT_PORT);
358 } else if ((uh->source & LOWPAN_NHC_UDP_8BIT_MASK) ==
359 LOWPAN_NHC_UDP_8BIT_PORT) {
360 pr_debug("UDP header: remove 8 bits of source\n");
361 **hc06_ptr = LOWPAN_NHC_UDP_CS_P_10;
362 memcpy(*hc06_ptr + 1, &uh->dest, 2);
363 **(hc06_ptr + 3) = (u8)(uh->source - LOWPAN_NHC_UDP_8BIT_PORT);
366 pr_debug("UDP header: can't compress\n");
367 **hc06_ptr = LOWPAN_NHC_UDP_CS_P_00;
368 memcpy(*hc06_ptr + 1, &uh->source, 2);
369 memcpy(*hc06_ptr + 3, &uh->dest, 2);
373 /* checksum is always inline */
374 memcpy(*hc06_ptr, &uh->check, 2);
377 /* skip the UDP header */
378 skb_pull(skb, sizeof(struct udphdr));
381 static inline int lowpan_fetch_skb_u8(struct sk_buff *skb, u8 *val)
383 if (unlikely(!pskb_may_pull(skb, 1)))
392 static inline int lowpan_fetch_skb_u16(struct sk_buff *skb, u16 *val)
394 if (unlikely(!pskb_may_pull(skb, 2)))
397 *val = (skb->data[0] << 8) | skb->data[1];
404 lowpan_uncompress_udp_header(struct sk_buff *skb, struct udphdr *uh)
411 if (lowpan_fetch_skb_u8(skb, &tmp))
414 if ((tmp & LOWPAN_NHC_UDP_MASK) == LOWPAN_NHC_UDP_ID) {
415 pr_debug("UDP header uncompression\n");
416 switch (tmp & LOWPAN_NHC_UDP_CS_P_11) {
417 case LOWPAN_NHC_UDP_CS_P_00:
418 memcpy(&uh->source, &skb->data[0], 2);
419 memcpy(&uh->dest, &skb->data[2], 2);
422 case LOWPAN_NHC_UDP_CS_P_01:
423 memcpy(&uh->source, &skb->data[0], 2);
425 skb->data[2] + LOWPAN_NHC_UDP_8BIT_PORT;
428 case LOWPAN_NHC_UDP_CS_P_10:
429 uh->source = skb->data[0] + LOWPAN_NHC_UDP_8BIT_PORT;
430 memcpy(&uh->dest, &skb->data[1], 2);
433 case LOWPAN_NHC_UDP_CS_P_11:
435 LOWPAN_NHC_UDP_4BIT_PORT + (skb->data[0] >> 4);
437 LOWPAN_NHC_UDP_4BIT_PORT + (skb->data[0] & 0x0f);
441 pr_debug("ERROR: unknown UDP format\n");
446 pr_debug("uncompressed UDP ports: src = %d, dst = %d\n",
447 uh->source, uh->dest);
450 memcpy(&uh->check, &skb->data[0], 2);
454 * UDP lenght needs to be infered from the lower layers
455 * here, we obtain the hint from the remaining size of the
458 uh->len = htons(skb->len + sizeof(struct udphdr));
459 pr_debug("uncompressed UDP length: src = %d", uh->len);
461 pr_debug("ERROR: unsupported NH format\n");
470 static int lowpan_header_create(struct sk_buff *skb,
471 struct net_device *dev,
472 unsigned short type, const void *_daddr,
473 const void *_saddr, unsigned int len)
475 u8 tmp, iphc0, iphc1, *hc06_ptr;
477 const u8 *saddr = _saddr;
478 const u8 *daddr = _daddr;
480 struct ieee802154_addr sa, da;
483 * if this package isn't ipv6 one, where should it be routed?
485 if (type != ETH_P_IPV6)
491 pr_debug("IPv6 header dump:\n\tversion = %d\n\tlength = %d\n"
492 "\tnexthdr = 0x%02x\n\thop_lim = %d\n", hdr->version,
493 ntohs(hdr->payload_len), hdr->nexthdr, hdr->hop_limit);
495 lowpan_raw_dump_table(__func__, "raw skb network header dump",
496 skb_network_header(skb), sizeof(struct ipv6hdr));
499 saddr = dev->dev_addr;
501 lowpan_raw_dump_inline(__func__, "saddr", (unsigned char *)saddr, 8);
504 * As we copy some bit-length fields, in the IPHC encoding bytes,
505 * we sometimes use |=
506 * If the field is 0, and the current bit value in memory is 1,
507 * this does not work. We therefore reset the IPHC encoding here
509 iphc0 = LOWPAN_DISPATCH_IPHC;
512 /* TODO: context lookup */
514 lowpan_raw_dump_inline(__func__, "daddr", (unsigned char *)daddr, 8);
517 * Traffic class, flow label
518 * If flow label is 0, compress it. If traffic class is 0, compress it
519 * We have to process both in the same time as the offset of traffic
520 * class depends on the presence of version and flow label
523 /* hc06 format of TC is ECN | DSCP , original one is DSCP | ECN */
524 tmp = (hdr->priority << 4) | (hdr->flow_lbl[0] >> 4);
525 tmp = ((tmp & 0x03) << 6) | (tmp >> 2);
527 if (((hdr->flow_lbl[0] & 0x0F) == 0) &&
528 (hdr->flow_lbl[1] == 0) && (hdr->flow_lbl[2] == 0)) {
529 /* flow label can be compressed */
530 iphc0 |= LOWPAN_IPHC_FL_C;
531 if ((hdr->priority == 0) &&
532 ((hdr->flow_lbl[0] & 0xF0) == 0)) {
533 /* compress (elide) all */
534 iphc0 |= LOWPAN_IPHC_TC_C;
536 /* compress only the flow label */
541 /* Flow label cannot be compressed */
542 if ((hdr->priority == 0) &&
543 ((hdr->flow_lbl[0] & 0xF0) == 0)) {
544 /* compress only traffic class */
545 iphc0 |= LOWPAN_IPHC_TC_C;
546 *hc06_ptr = (tmp & 0xc0) | (hdr->flow_lbl[0] & 0x0F);
547 memcpy(hc06_ptr + 1, &hdr->flow_lbl[1], 2);
550 /* compress nothing */
551 memcpy(hc06_ptr, &hdr, 4);
552 /* replace the top byte with new ECN | DSCP format */
558 /* NOTE: payload length is always compressed */
560 /* Next Header is compress if UDP */
561 if (hdr->nexthdr == UIP_PROTO_UDP)
562 iphc0 |= LOWPAN_IPHC_NH_C;
564 if ((iphc0 & LOWPAN_IPHC_NH_C) == 0) {
565 *hc06_ptr = hdr->nexthdr;
571 * if 1: compress, encoding is 01
572 * if 64: compress, encoding is 10
573 * if 255: compress, encoding is 11
574 * else do not compress
576 switch (hdr->hop_limit) {
578 iphc0 |= LOWPAN_IPHC_TTL_1;
581 iphc0 |= LOWPAN_IPHC_TTL_64;
584 iphc0 |= LOWPAN_IPHC_TTL_255;
587 *hc06_ptr = hdr->hop_limit;
592 /* source address compression */
593 if (is_addr_unspecified(&hdr->saddr)) {
594 pr_debug("source address is unspecified, setting SAC\n");
595 iphc1 |= LOWPAN_IPHC_SAC;
596 /* TODO: context lookup */
597 } else if (is_addr_link_local(&hdr->saddr)) {
598 pr_debug("source address is link-local\n");
599 iphc1 |= lowpan_compress_addr_64(&hc06_ptr,
600 LOWPAN_IPHC_SAM_BIT, &hdr->saddr, saddr);
602 pr_debug("send the full source address\n");
603 memcpy(hc06_ptr, &hdr->saddr.s6_addr16[0], 16);
607 /* destination address compression */
608 if (is_addr_mcast(&hdr->daddr)) {
609 pr_debug("destination address is multicast: ");
610 iphc1 |= LOWPAN_IPHC_M;
611 if (lowpan_is_mcast_addr_compressable8(&hdr->daddr)) {
612 pr_debug("compressed to 1 octet\n");
613 iphc1 |= LOWPAN_IPHC_DAM_11;
615 *hc06_ptr = hdr->daddr.s6_addr[15];
617 } else if (lowpan_is_mcast_addr_compressable32(&hdr->daddr)) {
618 pr_debug("compressed to 4 octets\n");
619 iphc1 |= LOWPAN_IPHC_DAM_10;
620 /* second byte + the last three */
621 *hc06_ptr = hdr->daddr.s6_addr[1];
622 memcpy(hc06_ptr + 1, &hdr->daddr.s6_addr[13], 3);
624 } else if (lowpan_is_mcast_addr_compressable48(&hdr->daddr)) {
625 pr_debug("compressed to 6 octets\n");
626 iphc1 |= LOWPAN_IPHC_DAM_01;
627 /* second byte + the last five */
628 *hc06_ptr = hdr->daddr.s6_addr[1];
629 memcpy(hc06_ptr + 1, &hdr->daddr.s6_addr[11], 5);
632 pr_debug("using full address\n");
633 iphc1 |= LOWPAN_IPHC_DAM_00;
634 memcpy(hc06_ptr, &hdr->daddr.s6_addr[0], 16);
638 /* TODO: context lookup */
639 if (is_addr_link_local(&hdr->daddr)) {
640 pr_debug("dest address is unicast and link-local\n");
641 iphc1 |= lowpan_compress_addr_64(&hc06_ptr,
642 LOWPAN_IPHC_DAM_BIT, &hdr->daddr, daddr);
644 pr_debug("dest address is unicast: using full one\n");
645 memcpy(hc06_ptr, &hdr->daddr.s6_addr16[0], 16);
650 /* UDP header compression */
651 if (hdr->nexthdr == UIP_PROTO_UDP)
652 lowpan_compress_udp_header(&hc06_ptr, skb);
657 skb_pull(skb, sizeof(struct ipv6hdr));
658 memcpy(skb_push(skb, hc06_ptr - head), head, hc06_ptr - head);
660 lowpan_raw_dump_table(__func__, "raw skb data dump", skb->data,
664 * NOTE1: I'm still unsure about the fact that compression and WPAN
665 * header are created here and not later in the xmit. So wait for
666 * an opinion of net maintainers.
669 * NOTE2: to be absolutely correct, we must derive PANid information
670 * from MAC subif of the 'dev' and 'real_dev' network devices, but
671 * this isn't implemented in mainline yet, so currently we assign 0xff
674 mac_cb(skb)->flags = IEEE802154_FC_TYPE_DATA;
675 mac_cb(skb)->seq = ieee802154_mlme_ops(dev)->get_dsn(dev);
677 /* prepare wpan address data */
678 sa.addr_type = IEEE802154_ADDR_LONG;
679 sa.pan_id = ieee802154_mlme_ops(dev)->get_pan_id(dev);
681 memcpy(&(sa.hwaddr), saddr, 8);
682 /* intra-PAN communications */
683 da.pan_id = ieee802154_mlme_ops(dev)->get_pan_id(dev);
686 * if the destination address is the broadcast address, use the
687 * corresponding short address
689 if (lowpan_is_addr_broadcast(daddr)) {
690 da.addr_type = IEEE802154_ADDR_SHORT;
691 da.short_addr = IEEE802154_ADDR_BROADCAST;
693 da.addr_type = IEEE802154_ADDR_LONG;
694 memcpy(&(da.hwaddr), daddr, IEEE802154_ADDR_LEN);
696 /* request acknowledgment */
697 mac_cb(skb)->flags |= MAC_CB_FLAG_ACKREQ;
700 return dev_hard_header(skb, lowpan_dev_info(dev)->real_dev,
701 type, (void *)&da, (void *)&sa, skb->len);
705 static int lowpan_give_skb_to_devices(struct sk_buff *skb)
707 struct lowpan_dev_record *entry;
708 struct sk_buff *skb_cp;
709 int stat = NET_RX_SUCCESS;
712 list_for_each_entry_rcu(entry, &lowpan_devices, list)
713 if (lowpan_dev_info(entry->ldev)->real_dev == skb->dev) {
714 skb_cp = skb_copy(skb, GFP_ATOMIC);
720 skb_cp->dev = entry->ldev;
721 stat = netif_rx(skb_cp);
728 static int lowpan_skb_deliver(struct sk_buff *skb, struct ipv6hdr *hdr)
731 int stat = NET_RX_SUCCESS;
733 new = skb_copy_expand(skb, sizeof(struct ipv6hdr), skb_tailroom(skb),
740 skb_push(new, sizeof(struct ipv6hdr));
741 skb_reset_network_header(new);
742 skb_copy_to_linear_data(new, hdr, sizeof(struct ipv6hdr));
744 new->protocol = htons(ETH_P_IPV6);
745 new->pkt_type = PACKET_HOST;
747 stat = lowpan_give_skb_to_devices(new);
754 static void lowpan_fragment_timer_expired(unsigned long entry_addr)
756 struct lowpan_fragment *entry = (struct lowpan_fragment *)entry_addr;
758 pr_debug("timer expired for frame with tag %d\n", entry->tag);
760 list_del(&entry->list);
761 dev_kfree_skb(entry->skb);
765 static struct lowpan_fragment *
766 lowpan_alloc_new_frame(struct sk_buff *skb, u16 len, u16 tag)
768 struct lowpan_fragment *frame;
770 frame = kzalloc(sizeof(struct lowpan_fragment),
775 INIT_LIST_HEAD(&frame->list);
780 /* allocate buffer for frame assembling */
781 frame->skb = netdev_alloc_skb_ip_align(skb->dev, frame->length +
782 sizeof(struct ipv6hdr));
787 frame->skb->priority = skb->priority;
788 frame->skb->dev = skb->dev;
790 /* reserve headroom for uncompressed ipv6 header */
791 skb_reserve(frame->skb, sizeof(struct ipv6hdr));
792 skb_put(frame->skb, frame->length);
794 /* copy the first control block to keep a
795 * trace of the link-layer addresses in case
796 * of a link-local compressed address
798 memcpy(frame->skb->cb, skb->cb, sizeof(skb->cb));
800 init_timer(&frame->timer);
801 /* time out is the same as for ipv6 - 60 sec */
802 frame->timer.expires = jiffies + LOWPAN_FRAG_TIMEOUT;
803 frame->timer.data = (unsigned long)frame;
804 frame->timer.function = lowpan_fragment_timer_expired;
806 add_timer(&frame->timer);
808 list_add_tail(&frame->list, &lowpan_fragments);
819 lowpan_process_data(struct sk_buff *skb)
821 struct ipv6hdr hdr = {};
822 u8 tmp, iphc0, iphc1, num_context = 0;
823 const struct ieee802154_addr *_saddr, *_daddr;
826 lowpan_raw_dump_table(__func__, "raw skb data dump", skb->data,
828 /* at least two bytes will be used for the encoding */
832 if (lowpan_fetch_skb_u8(skb, &iphc0))
835 /* fragments assembling */
836 switch (iphc0 & LOWPAN_DISPATCH_MASK) {
837 case LOWPAN_DISPATCH_FRAG1:
838 case LOWPAN_DISPATCH_FRAGN:
840 struct lowpan_fragment *frame;
841 /* slen stores the rightmost 8 bits of the 11 bits length */
846 if (lowpan_fetch_skb_u8(skb, &slen) || /* frame length */
847 lowpan_fetch_skb_u16(skb, &tag)) /* fragment tag */
850 /* adds the 3 MSB to the 8 LSB to retrieve the 11 bits length */
851 len = ((iphc0 & 7) << 8) | slen;
853 if ((iphc0 & LOWPAN_DISPATCH_MASK) == LOWPAN_DISPATCH_FRAG1) {
854 pr_debug("%s received a FRAG1 packet (tag: %d, "
855 "size of the entire IP packet: %d)",
858 if (lowpan_fetch_skb_u8(skb, &offset))
859 goto unlock_and_drop;
860 pr_debug("%s received a FRAGN packet (tag: %d, "
861 "size of the entire IP packet: %d, "
862 "offset: %d)", __func__, tag, len, offset * 8);
866 * check if frame assembling with the same tag is
867 * already in progress
869 spin_lock_bh(&flist_lock);
871 list_for_each_entry(frame, &lowpan_fragments, list)
872 if (frame->tag == tag) {
877 /* alloc new frame structure */
879 pr_debug("%s first fragment received for tag %d, "
880 "begin packet reassembly", __func__, tag);
881 frame = lowpan_alloc_new_frame(skb, len, tag);
883 goto unlock_and_drop;
886 /* if payload fits buffer, copy it */
887 if (likely((offset * 8 + skb->len) <= frame->length))
888 skb_copy_to_linear_data_offset(frame->skb, offset * 8,
889 skb->data, skb->len);
891 goto unlock_and_drop;
893 frame->bytes_rcv += skb->len;
895 /* frame assembling complete */
896 if ((frame->bytes_rcv == frame->length) &&
897 frame->timer.expires > jiffies) {
898 /* if timer haven't expired - first of all delete it */
899 del_timer_sync(&frame->timer);
900 list_del(&frame->list);
901 spin_unlock_bh(&flist_lock);
903 pr_debug("%s successfully reassembled fragment "
904 "(tag %d)", __func__, tag);
910 if (lowpan_fetch_skb_u8(skb, &iphc0))
915 spin_unlock_bh(&flist_lock);
917 return kfree_skb(skb), 0;
923 if (lowpan_fetch_skb_u8(skb, &iphc1))
926 _saddr = &mac_cb(skb)->sa;
927 _daddr = &mac_cb(skb)->da;
929 pr_debug("iphc0 = %02x, iphc1 = %02x\n", iphc0, iphc1);
931 /* another if the CID flag is set */
932 if (iphc1 & LOWPAN_IPHC_CID) {
933 pr_debug("CID flag is set, increase header with one\n");
934 if (lowpan_fetch_skb_u8(skb, &num_context))
940 /* Traffic Class and Flow Label */
941 switch ((iphc0 & LOWPAN_IPHC_TF) >> 3) {
943 * Traffic Class and FLow Label carried in-line
944 * ECN + DSCP + 4-bit Pad + Flow Label (4 bytes)
947 if (lowpan_fetch_skb_u8(skb, &tmp))
950 memcpy(&hdr.flow_lbl, &skb->data[0], 3);
952 hdr.priority = ((tmp >> 2) & 0x0f);
953 hdr.flow_lbl[0] = ((tmp >> 2) & 0x30) | (tmp << 6) |
954 (hdr.flow_lbl[0] & 0x0f);
957 * Traffic class carried in-line
958 * ECN + DSCP (1 byte), Flow Label is elided
961 if (lowpan_fetch_skb_u8(skb, &tmp))
964 hdr.priority = ((tmp >> 2) & 0x0f);
965 hdr.flow_lbl[0] = ((tmp << 6) & 0xC0) | ((tmp >> 2) & 0x30);
968 * Flow Label carried in-line
969 * ECN + 2-bit Pad + Flow Label (3 bytes), DSCP is elided
972 if (lowpan_fetch_skb_u8(skb, &tmp))
975 hdr.flow_lbl[0] = (skb->data[0] & 0x0F) | ((tmp >> 2) & 0x30);
976 memcpy(&hdr.flow_lbl[1], &skb->data[0], 2);
979 /* Traffic Class and Flow Label are elided */
987 if ((iphc0 & LOWPAN_IPHC_NH_C) == 0) {
988 /* Next header is carried inline */
989 if (lowpan_fetch_skb_u8(skb, &(hdr.nexthdr)))
992 pr_debug("NH flag is set, next header carried inline: %02x\n",
997 if ((iphc0 & 0x03) != LOWPAN_IPHC_TTL_I)
998 hdr.hop_limit = lowpan_ttl_values[iphc0 & 0x03];
1000 if (lowpan_fetch_skb_u8(skb, &(hdr.hop_limit)))
1004 /* Extract SAM to the tmp variable */
1005 tmp = ((iphc1 & LOWPAN_IPHC_SAM) >> LOWPAN_IPHC_SAM_BIT) & 0x03;
1007 if (iphc1 & LOWPAN_IPHC_SAC) {
1008 /* Source address context based uncompression */
1009 pr_debug("SAC bit is set. Handle context based source address.\n");
1010 err = lowpan_uncompress_context_based_src_addr(
1011 skb, &hdr.saddr, tmp);
1013 /* Source address uncompression */
1014 pr_debug("source address stateless compression\n");
1015 err = lowpan_uncompress_addr(skb, &hdr.saddr, tmp, _saddr);
1018 /* Check on error of previous branch */
1022 /* Extract DAM to the tmp variable */
1023 tmp = ((iphc1 & LOWPAN_IPHC_DAM_11) >> LOWPAN_IPHC_DAM_BIT) & 0x03;
1025 /* check for Multicast Compression */
1026 if (iphc1 & LOWPAN_IPHC_M) {
1027 if (iphc1 & LOWPAN_IPHC_DAC) {
1028 pr_debug("dest: context-based mcast compression\n");
1029 /* TODO: implement this */
1031 err = lowpan_uncompress_multicast_daddr(
1032 skb, &hdr.daddr, tmp);
1037 pr_debug("dest: stateless compression\n");
1038 err = lowpan_uncompress_addr(skb, &hdr.daddr, tmp, _daddr);
1043 /* UDP data uncompression */
1044 if (iphc0 & LOWPAN_IPHC_NH_C) {
1046 struct sk_buff *new;
1047 if (lowpan_uncompress_udp_header(skb, &uh))
1051 * replace the compressed UDP head by the uncompressed UDP
1054 new = skb_copy_expand(skb, sizeof(struct udphdr),
1055 skb_tailroom(skb), GFP_ATOMIC);
1063 skb_push(skb, sizeof(struct udphdr));
1064 skb_reset_transport_header(skb);
1065 skb_copy_to_linear_data(skb, &uh, sizeof(struct udphdr));
1067 lowpan_raw_dump_table(__func__, "raw UDP header dump",
1068 (u8 *)&uh, sizeof(uh));
1070 hdr.nexthdr = UIP_PROTO_UDP;
1073 /* Not fragmented package */
1074 hdr.payload_len = htons(skb->len);
1076 pr_debug("skb headroom size = %d, data length = %d\n",
1077 skb_headroom(skb), skb->len);
1079 pr_debug("IPv6 header dump:\n\tversion = %d\n\tlength = %d\n\t"
1080 "nexthdr = 0x%02x\n\thop_lim = %d\n", hdr.version,
1081 ntohs(hdr.payload_len), hdr.nexthdr, hdr.hop_limit);
1083 lowpan_raw_dump_table(__func__, "raw header dump", (u8 *)&hdr,
1085 return lowpan_skb_deliver(skb, &hdr);
1088 spin_unlock_bh(&flist_lock);
1094 static int lowpan_set_address(struct net_device *dev, void *p)
1096 struct sockaddr *sa = p;
1098 if (netif_running(dev))
1101 /* TODO: validate addr */
1102 memcpy(dev->dev_addr, sa->sa_data, dev->addr_len);
1107 static int lowpan_get_mac_header_length(struct sk_buff *skb)
1110 * Currently long addressing mode is supported only, so the overall
1111 * header size is 21:
1112 * FC SeqNum DPAN DA SA Sec
1113 * 2 + 1 + 2 + 8 + 8 + 0 = 21
1119 lowpan_fragment_xmit(struct sk_buff *skb, u8 *head,
1120 int mlen, int plen, int offset, int type)
1122 struct sk_buff *frag;
1125 hlen = (type == LOWPAN_DISPATCH_FRAG1) ?
1126 LOWPAN_FRAG1_HEAD_SIZE : LOWPAN_FRAGN_HEAD_SIZE;
1128 lowpan_raw_dump_inline(__func__, "6lowpan fragment header", head, hlen);
1130 frag = dev_alloc_skb(hlen + mlen + plen + IEEE802154_MFR_SIZE);
1134 frag->priority = skb->priority;
1135 frag->dev = skb->dev;
1137 /* copy header, MFR and payload */
1138 memcpy(skb_put(frag, mlen), skb->data, mlen);
1139 memcpy(skb_put(frag, hlen), head, hlen);
1142 skb_copy_from_linear_data_offset(skb, offset + mlen,
1143 skb_put(frag, plen), plen);
1145 lowpan_raw_dump_table(__func__, " raw fragment dump", frag->data,
1148 ret = dev_queue_xmit(frag);
1154 lowpan_skb_fragmentation(struct sk_buff *skb, struct net_device *dev)
1156 int err, header_length, payload_length, tag, offset = 0;
1159 header_length = lowpan_get_mac_header_length(skb);
1160 payload_length = skb->len - header_length;
1161 tag = lowpan_dev_info(dev)->fragment_tag++;
1163 /* first fragment header */
1164 head[0] = LOWPAN_DISPATCH_FRAG1 | ((payload_length >> 8) & 0x7);
1165 head[1] = payload_length & 0xff;
1167 head[3] = tag & 0xff;
1169 err = lowpan_fragment_xmit(skb, head, header_length, LOWPAN_FRAG_SIZE,
1170 0, LOWPAN_DISPATCH_FRAG1);
1173 pr_debug("%s unable to send FRAG1 packet (tag: %d)",
1178 offset = LOWPAN_FRAG_SIZE;
1180 /* next fragment header */
1181 head[0] &= ~LOWPAN_DISPATCH_FRAG1;
1182 head[0] |= LOWPAN_DISPATCH_FRAGN;
1184 while ((payload_length - offset > 0) && (err >= 0)) {
1185 int len = LOWPAN_FRAG_SIZE;
1187 head[4] = offset / 8;
1189 if (payload_length - offset < len)
1190 len = payload_length - offset;
1192 err = lowpan_fragment_xmit(skb, head, header_length,
1193 len, offset, LOWPAN_DISPATCH_FRAGN);
1195 pr_debug("%s unable to send a subsequent FRAGN packet "
1196 "(tag: %d, offset: %d", __func__, tag, offset);
1207 static netdev_tx_t lowpan_xmit(struct sk_buff *skb, struct net_device *dev)
1211 pr_debug("package xmit\n");
1213 skb->dev = lowpan_dev_info(dev)->real_dev;
1214 if (skb->dev == NULL) {
1215 pr_debug("ERROR: no real wpan device found\n");
1219 /* Send directly if less than the MTU minus the 2 checksum bytes. */
1220 if (skb->len <= IEEE802154_MTU - IEEE802154_MFR_SIZE) {
1221 err = dev_queue_xmit(skb);
1225 pr_debug("frame is too big, fragmentation is needed\n");
1226 err = lowpan_skb_fragmentation(skb, dev);
1231 pr_debug("ERROR: xmit failed\n");
1233 return (err < 0) ? NET_XMIT_DROP : err;
1236 static struct wpan_phy *lowpan_get_phy(const struct net_device *dev)
1238 struct net_device *real_dev = lowpan_dev_info(dev)->real_dev;
1239 return ieee802154_mlme_ops(real_dev)->get_phy(real_dev);
1242 static u16 lowpan_get_pan_id(const struct net_device *dev)
1244 struct net_device *real_dev = lowpan_dev_info(dev)->real_dev;
1245 return ieee802154_mlme_ops(real_dev)->get_pan_id(real_dev);
1248 static u16 lowpan_get_short_addr(const struct net_device *dev)
1250 struct net_device *real_dev = lowpan_dev_info(dev)->real_dev;
1251 return ieee802154_mlme_ops(real_dev)->get_short_addr(real_dev);
1254 static u8 lowpan_get_dsn(const struct net_device *dev)
1256 struct net_device *real_dev = lowpan_dev_info(dev)->real_dev;
1257 return ieee802154_mlme_ops(real_dev)->get_dsn(real_dev);
1260 static struct header_ops lowpan_header_ops = {
1261 .create = lowpan_header_create,
1264 static const struct net_device_ops lowpan_netdev_ops = {
1265 .ndo_start_xmit = lowpan_xmit,
1266 .ndo_set_mac_address = lowpan_set_address,
1269 static struct ieee802154_mlme_ops lowpan_mlme = {
1270 .get_pan_id = lowpan_get_pan_id,
1271 .get_phy = lowpan_get_phy,
1272 .get_short_addr = lowpan_get_short_addr,
1273 .get_dsn = lowpan_get_dsn,
1276 static void lowpan_setup(struct net_device *dev)
1278 dev->addr_len = IEEE802154_ADDR_LEN;
1279 memset(dev->broadcast, 0xff, IEEE802154_ADDR_LEN);
1280 dev->type = ARPHRD_IEEE802154;
1281 /* Frame Control + Sequence Number + Address fields + Security Header */
1282 dev->hard_header_len = 2 + 1 + 20 + 14;
1283 dev->needed_tailroom = 2; /* FCS */
1285 dev->tx_queue_len = 0;
1286 dev->flags = IFF_BROADCAST | IFF_MULTICAST;
1287 dev->watchdog_timeo = 0;
1289 dev->netdev_ops = &lowpan_netdev_ops;
1290 dev->header_ops = &lowpan_header_ops;
1291 dev->ml_priv = &lowpan_mlme;
1292 dev->destructor = free_netdev;
1295 static int lowpan_validate(struct nlattr *tb[], struct nlattr *data[])
1297 if (tb[IFLA_ADDRESS]) {
1298 if (nla_len(tb[IFLA_ADDRESS]) != IEEE802154_ADDR_LEN)
1304 static int lowpan_rcv(struct sk_buff *skb, struct net_device *dev,
1305 struct packet_type *pt, struct net_device *orig_dev)
1307 struct sk_buff *local_skb;
1309 if (!netif_running(dev))
1312 if (dev->type != ARPHRD_IEEE802154)
1315 /* check that it's our buffer */
1316 if (skb->data[0] == LOWPAN_DISPATCH_IPV6) {
1317 /* Copy the packet so that the IPv6 header is
1320 local_skb = skb_copy_expand(skb, NET_SKB_PAD - 1,
1321 skb_tailroom(skb), GFP_ATOMIC);
1325 local_skb->protocol = htons(ETH_P_IPV6);
1326 local_skb->pkt_type = PACKET_HOST;
1328 /* Pull off the 1-byte of 6lowpan header. */
1329 skb_pull(local_skb, 1);
1330 skb_reset_network_header(local_skb);
1331 skb_set_transport_header(local_skb, sizeof(struct ipv6hdr));
1333 lowpan_give_skb_to_devices(local_skb);
1335 kfree_skb(local_skb);
1338 switch (skb->data[0] & 0xe0) {
1339 case LOWPAN_DISPATCH_IPHC: /* ipv6 datagram */
1340 case LOWPAN_DISPATCH_FRAG1: /* first fragment header */
1341 case LOWPAN_DISPATCH_FRAGN: /* next fragments headers */
1342 local_skb = skb_clone(skb, GFP_ATOMIC);
1345 lowpan_process_data(local_skb);
1354 return NET_RX_SUCCESS;
1361 static int lowpan_newlink(struct net *src_net, struct net_device *dev,
1362 struct nlattr *tb[], struct nlattr *data[])
1364 struct net_device *real_dev;
1365 struct lowpan_dev_record *entry;
1367 pr_debug("adding new link\n");
1371 /* find and hold real wpan device */
1372 real_dev = dev_get_by_index(src_net, nla_get_u32(tb[IFLA_LINK]));
1375 if (real_dev->type != ARPHRD_IEEE802154)
1378 lowpan_dev_info(dev)->real_dev = real_dev;
1379 lowpan_dev_info(dev)->fragment_tag = 0;
1380 mutex_init(&lowpan_dev_info(dev)->dev_list_mtx);
1382 entry = kzalloc(sizeof(struct lowpan_dev_record), GFP_KERNEL);
1385 lowpan_dev_info(dev)->real_dev = NULL;
1391 /* Set the lowpan harware address to the wpan hardware address. */
1392 memcpy(dev->dev_addr, real_dev->dev_addr, IEEE802154_ADDR_LEN);
1394 mutex_lock(&lowpan_dev_info(dev)->dev_list_mtx);
1395 INIT_LIST_HEAD(&entry->list);
1396 list_add_tail(&entry->list, &lowpan_devices);
1397 mutex_unlock(&lowpan_dev_info(dev)->dev_list_mtx);
1399 register_netdevice(dev);
1404 static void lowpan_dellink(struct net_device *dev, struct list_head *head)
1406 struct lowpan_dev_info *lowpan_dev = lowpan_dev_info(dev);
1407 struct net_device *real_dev = lowpan_dev->real_dev;
1408 struct lowpan_dev_record *entry, *tmp;
1412 mutex_lock(&lowpan_dev_info(dev)->dev_list_mtx);
1413 list_for_each_entry_safe(entry, tmp, &lowpan_devices, list) {
1414 if (entry->ldev == dev) {
1415 list_del(&entry->list);
1419 mutex_unlock(&lowpan_dev_info(dev)->dev_list_mtx);
1421 mutex_destroy(&lowpan_dev_info(dev)->dev_list_mtx);
1423 unregister_netdevice_queue(dev, head);
1428 static struct rtnl_link_ops lowpan_link_ops __read_mostly = {
1430 .priv_size = sizeof(struct lowpan_dev_info),
1431 .setup = lowpan_setup,
1432 .newlink = lowpan_newlink,
1433 .dellink = lowpan_dellink,
1434 .validate = lowpan_validate,
1437 static inline int __init lowpan_netlink_init(void)
1439 return rtnl_link_register(&lowpan_link_ops);
1442 static inline void lowpan_netlink_fini(void)
1444 rtnl_link_unregister(&lowpan_link_ops);
1447 static int lowpan_device_event(struct notifier_block *unused,
1448 unsigned long event, void *ptr)
1450 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
1451 LIST_HEAD(del_list);
1452 struct lowpan_dev_record *entry, *tmp;
1454 if (dev->type != ARPHRD_IEEE802154)
1457 if (event == NETDEV_UNREGISTER) {
1458 list_for_each_entry_safe(entry, tmp, &lowpan_devices, list) {
1459 if (lowpan_dev_info(entry->ldev)->real_dev == dev)
1460 lowpan_dellink(entry->ldev, &del_list);
1463 unregister_netdevice_many(&del_list);
1470 static struct notifier_block lowpan_dev_notifier = {
1471 .notifier_call = lowpan_device_event,
1474 static struct packet_type lowpan_packet_type = {
1475 .type = __constant_htons(ETH_P_IEEE802154),
1479 static int __init lowpan_init_module(void)
1483 err = lowpan_netlink_init();
1487 dev_add_pack(&lowpan_packet_type);
1489 err = register_netdevice_notifier(&lowpan_dev_notifier);
1491 dev_remove_pack(&lowpan_packet_type);
1492 lowpan_netlink_fini();
1498 static void __exit lowpan_cleanup_module(void)
1500 struct lowpan_fragment *frame, *tframe;
1502 lowpan_netlink_fini();
1504 dev_remove_pack(&lowpan_packet_type);
1506 unregister_netdevice_notifier(&lowpan_dev_notifier);
1508 /* Now 6lowpan packet_type is removed, so no new fragments are
1509 * expected on RX, therefore that's the time to clean incomplete
1512 spin_lock_bh(&flist_lock);
1513 list_for_each_entry_safe(frame, tframe, &lowpan_fragments, list) {
1514 del_timer_sync(&frame->timer);
1515 list_del(&frame->list);
1516 dev_kfree_skb(frame->skb);
1519 spin_unlock_bh(&flist_lock);
1522 module_init(lowpan_init_module);
1523 module_exit(lowpan_cleanup_module);
1524 MODULE_LICENSE("GPL");
1525 MODULE_ALIAS_RTNL_LINK("lowpan");