include/net/6lowpan.h

   1 /*
   2  * Copyright 2011, Siemens AG
   3  * written by Alexander Smirnov <alex.bluesman.smirnov@gmail.com>
   4  */
   5
   6 /*
   7  * Based on patches from Jon Smirl <jonsmirl@gmail.com>
   8  * Copyright (c) 2011 Jon Smirl <jonsmirl@gmail.com>
   9  *
  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.
  13  *
  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.
  18  *
  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.
  22  */
  23
  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.
  27  *
  28  * Redistribution and use in source and binary forms, with or without
  29  * modification, are permitted provided that the following conditions
  30  * are met:
  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.
  39  *
  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
  50  * SUCH DAMAGE.
  51  */
  52
  53 #ifndef __6LOWPAN_H__
  54 #define __6LOWPAN_H__
  55
  56 #include <net/ipv6.h>
  57 #include <net/net_namespace.h>
  58
  59 #define EUI64_ADDR_LEN          8
  60
  61 #define LOWPAN_NHC_MAX_ID_LEN   1
  62 /* Maximum next header compression length which we currently support inclusive
  63  * possible inline data.
  64  */
  65 #define LOWPAN_NHC_MAX_HDR_LEN  (sizeof(struct udphdr))
  66 /* Max IPHC Header len without IPv6 hdr specific inline data.
  67  * Useful for getting the "extra" bytes we need at worst case compression.
  68  *
  69  * LOWPAN_IPHC + CID + LOWPAN_NHC_MAX_ID_LEN
  70  */
  71 #define LOWPAN_IPHC_MAX_HEADER_LEN      (2 + 1 + LOWPAN_NHC_MAX_ID_LEN)
  72 /* Maximum worst case IPHC header buffer size */
  73 #define LOWPAN_IPHC_MAX_HC_BUF_LEN      (sizeof(struct ipv6hdr) +       \
  74                                          LOWPAN_IPHC_MAX_HEADER_LEN +   \
  75                                          LOWPAN_NHC_MAX_HDR_LEN)
  76
  77 #define lowpan_is_addr_broadcast(a)     \
  78         ((((a)[0]) == 0xFF) &&  \
  79          (((a)[1]) == 0xFF) &&  \
  80          (((a)[2]) == 0xFF) &&  \
  81          (((a)[3]) == 0xFF) &&  \
  82          (((a)[4]) == 0xFF) &&  \
  83          (((a)[5]) == 0xFF) &&  \
  84          (((a)[6]) == 0xFF) &&  \
  85          (((a)[7]) == 0xFF))
  86
  87 #define LOWPAN_DISPATCH_IPV6            0x41 /* 01000001 = 65 */
  88 #define LOWPAN_DISPATCH_IPHC            0x60 /* 011xxxxx = ... */
  89 #define LOWPAN_DISPATCH_IPHC_MASK       0xe0
  90
  91 static inline bool lowpan_is_ipv6(u8 dispatch)
  92 {
  93         return dispatch == LOWPAN_DISPATCH_IPV6;
  94 }
  95
  96 static inline bool lowpan_is_iphc(u8 dispatch)
  97 {
  98         return (dispatch & LOWPAN_DISPATCH_IPHC_MASK) == LOWPAN_DISPATCH_IPHC;
  99 }
 100
 101 #define LOWPAN_PRIV_SIZE(llpriv_size)   \
 102         (sizeof(struct lowpan_priv) + llpriv_size)
 103
 104 enum lowpan_lltypes {
 105         LOWPAN_LLTYPE_BTLE,
 106         LOWPAN_LLTYPE_IEEE802154,
 107 };
 108
 109 struct lowpan_priv {
 110         enum lowpan_lltypes lltype;
 111
 112         /* must be last */
 113         u8 priv[0] __aligned(sizeof(void *));
 114 };
 115
 116 static inline
 117 struct lowpan_priv *lowpan_priv(const struct net_device *dev)
 118 {
 119         return netdev_priv(dev);
 120 }
 121
 122 struct lowpan_802154_cb {
 123         u16 d_tag;
 124         unsigned int d_size;
 125         u8 d_offset;
 126 };
 127
 128 static inline
 129 struct lowpan_802154_cb *lowpan_802154_cb(const struct sk_buff *skb)
 130 {
 131         BUILD_BUG_ON(sizeof(struct lowpan_802154_cb) > sizeof(skb->cb));
 132         return (struct lowpan_802154_cb *)skb->cb;
 133 }
 134
 135 #ifdef DEBUG
 136 /* print data in line */
 137 static inline void raw_dump_inline(const char *caller, char *msg,
 138                                    const unsigned char *buf, int len)
 139 {
 140         if (msg)
 141                 pr_debug("%s():%s: ", caller, msg);
 142
 143         print_hex_dump_debug("", DUMP_PREFIX_NONE, 16, 1, buf, len, false);
 144 }
 145
 146 /* print data in a table format:
 147  *
 148  * addr: xx xx xx xx xx xx
 149  * addr: xx xx xx xx xx xx
 150  * ...
 151  */
 152 static inline void raw_dump_table(const char *caller, char *msg,
 153                                   const unsigned char *buf, int len)
 154 {
 155         if (msg)
 156                 pr_debug("%s():%s:\n", caller, msg);
 157
 158         print_hex_dump_debug("\t", DUMP_PREFIX_OFFSET, 16, 1, buf, len, false);
 159 }
 160 #else
 161 static inline void raw_dump_table(const char *caller, char *msg,
 162                                   const unsigned char *buf, int len) { }
 163 static inline void raw_dump_inline(const char *caller, char *msg,
 164                                    const unsigned char *buf, int len) { }
 165 #endif
 166
 167 /**
 168  * lowpan_fetch_skb - getting inline data from 6LoWPAN header
 169  *
 170  * This function will pull data from sk buffer and put it into data to
 171  * remove the 6LoWPAN inline data. This function returns true if the
 172  * sk buffer is too small to pull the amount of data which is specified
 173  * by len.
 174  *
 175  * @skb: the buffer where the inline data should be pulled from.
 176  * @data: destination buffer for the inline data.
 177  * @len: amount of data which should be pulled in bytes.
 178  */
 179 static inline bool lowpan_fetch_skb(struct sk_buff *skb, void *data,
 180                                     unsigned int len)
 181 {
 182         if (unlikely(!pskb_may_pull(skb, len)))
 183                 return true;
 184
 185         skb_copy_from_linear_data(skb, data, len);
 186         skb_pull(skb, len);
 187
 188         return false;
 189 }
 190
 191 static inline void lowpan_push_hc_data(u8 **hc_ptr, const void *data,
 192                                        const size_t len)
 193 {
 194         memcpy(*hc_ptr, data, len);
 195         *hc_ptr += len;
 196 }
 197
 198 void lowpan_netdev_setup(struct net_device *dev, enum lowpan_lltypes lltype);
 199
 200 /**
 201  * lowpan_header_decompress - replace 6LoWPAN header with IPv6 header
 202  *
 203  * This function replaces the IPHC 6LoWPAN header which should be pointed at
 204  * skb->data and skb_network_header, with the IPv6 header.
 205  * It would be nice that the caller have the necessary headroom of IPv6 header
 206  * and greatest Transport layer header, this would reduce the overhead for
 207  * reallocate headroom.
 208  *
 209  * @skb: the buffer which should be manipulate.
 210  * @dev: the lowpan net device pointer.
 211  * @daddr: destination lladdr of mac header which is used for compression
 212  *      methods.
 213  * @saddr: source lladdr of mac header which is used for compression
 214  *      methods.
 215  */
 216 int lowpan_header_decompress(struct sk_buff *skb, const struct net_device *dev,
 217                              const void *daddr, const void *saddr);
 218
 219 /**
 220  * lowpan_header_compress - replace IPv6 header with 6LoWPAN header
 221  *
 222  * This function replaces the IPv6 header which should be pointed at
 223  * skb->data and skb_network_header, with the IPHC 6LoWPAN header.
 224  * The caller need to be sure that the sk buffer is not shared and at have
 225  * at least a headroom which is smaller or equal LOWPAN_IPHC_MAX_HEADER_LEN,
 226  * which is the IPHC "more bytes than IPv6 header" at worst case.
 227  *
 228  * @skb: the buffer which should be manipulate.
 229  * @dev: the lowpan net device pointer.
 230  * @daddr: destination lladdr of mac header which is used for compression
 231  *      methods.
 232  * @saddr: source lladdr of mac header which is used for compression
 233  *      methods.
 234  */
 235 int lowpan_header_compress(struct sk_buff *skb, const struct net_device *dev,
 236                            const void *daddr, const void *saddr);
 237
 238 #endif /* __6LOWPAN_H__ */