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
56 #include <linux/debugfs.h>
59 #include <net/net_namespace.h>
61 #define EUI64_ADDR_LEN 8
63 #define LOWPAN_NHC_MAX_ID_LEN 1
64 /* Maximum next header compression length which we currently support inclusive
65 * possible inline data.
67 #define LOWPAN_NHC_MAX_HDR_LEN (sizeof(struct udphdr))
68 /* Max IPHC Header len without IPv6 hdr specific inline data.
69 * Useful for getting the "extra" bytes we need at worst case compression.
71 * LOWPAN_IPHC + CID + LOWPAN_NHC_MAX_ID_LEN
73 #define LOWPAN_IPHC_MAX_HEADER_LEN (2 + 1 + LOWPAN_NHC_MAX_ID_LEN)
74 /* Maximum worst case IPHC header buffer size */
75 #define LOWPAN_IPHC_MAX_HC_BUF_LEN (sizeof(struct ipv6hdr) + \
76 LOWPAN_IPHC_MAX_HEADER_LEN + \
77 LOWPAN_NHC_MAX_HDR_LEN)
78 /* SCI/DCI is 4 bit width, so we have maximum 16 entries */
79 #define LOWPAN_IPHC_CTX_TABLE_SIZE (1 << 4)
81 #define LOWPAN_DISPATCH_IPV6 0x41 /* 01000001 = 65 */
82 #define LOWPAN_DISPATCH_IPHC 0x60 /* 011xxxxx = ... */
83 #define LOWPAN_DISPATCH_IPHC_MASK 0xe0
85 static inline bool lowpan_is_ipv6(u8 dispatch
)
87 return dispatch
== LOWPAN_DISPATCH_IPV6
;
90 static inline bool lowpan_is_iphc(u8 dispatch
)
92 return (dispatch
& LOWPAN_DISPATCH_IPHC_MASK
) == LOWPAN_DISPATCH_IPHC
;
95 #define LOWPAN_PRIV_SIZE(llpriv_size) \
96 (sizeof(struct lowpan_dev) + llpriv_size)
100 LOWPAN_LLTYPE_IEEE802154
,
103 enum lowpan_iphc_ctx_flags
{
104 LOWPAN_IPHC_CTX_FLAG_ACTIVE
,
105 LOWPAN_IPHC_CTX_FLAG_COMPRESSION
,
108 struct lowpan_iphc_ctx
{
115 struct lowpan_iphc_ctx_table
{
117 const struct lowpan_iphc_ctx_ops
*ops
;
118 struct lowpan_iphc_ctx table
[LOWPAN_IPHC_CTX_TABLE_SIZE
];
121 static inline bool lowpan_iphc_ctx_is_active(const struct lowpan_iphc_ctx
*ctx
)
123 return test_bit(LOWPAN_IPHC_CTX_FLAG_ACTIVE
, &ctx
->flags
);
127 lowpan_iphc_ctx_is_compression(const struct lowpan_iphc_ctx
*ctx
)
129 return test_bit(LOWPAN_IPHC_CTX_FLAG_COMPRESSION
, &ctx
->flags
);
133 enum lowpan_lltypes lltype
;
134 struct dentry
*iface_debugfs
;
135 struct lowpan_iphc_ctx_table ctx
;
138 u8 priv
[0] __aligned(sizeof(void *));
142 struct lowpan_dev
*lowpan_dev(const struct net_device
*dev
)
144 return netdev_priv(dev
);
147 /* private device info */
148 struct lowpan_802154_dev
{
149 struct net_device
*wdev
; /* wpan device ptr */
154 lowpan_802154_dev
*lowpan_802154_dev(const struct net_device
*dev
)
156 return (struct lowpan_802154_dev
*)lowpan_dev(dev
)->priv
;
159 struct lowpan_802154_cb
{
166 struct lowpan_802154_cb
*lowpan_802154_cb(const struct sk_buff
*skb
)
168 BUILD_BUG_ON(sizeof(struct lowpan_802154_cb
) > sizeof(skb
->cb
));
169 return (struct lowpan_802154_cb
*)skb
->cb
;
173 /* print data in line */
174 static inline void raw_dump_inline(const char *caller
, char *msg
,
175 const unsigned char *buf
, int len
)
178 pr_debug("%s():%s: ", caller
, msg
);
180 print_hex_dump_debug("", DUMP_PREFIX_NONE
, 16, 1, buf
, len
, false);
183 /* print data in a table format:
185 * addr: xx xx xx xx xx xx
186 * addr: xx xx xx xx xx xx
189 static inline void raw_dump_table(const char *caller
, char *msg
,
190 const unsigned char *buf
, int len
)
193 pr_debug("%s():%s:\n", caller
, msg
);
195 print_hex_dump_debug("\t", DUMP_PREFIX_OFFSET
, 16, 1, buf
, len
, false);
198 static inline void raw_dump_table(const char *caller
, char *msg
,
199 const unsigned char *buf
, int len
) { }
200 static inline void raw_dump_inline(const char *caller
, char *msg
,
201 const unsigned char *buf
, int len
) { }
205 * lowpan_fetch_skb - getting inline data from 6LoWPAN header
207 * This function will pull data from sk buffer and put it into data to
208 * remove the 6LoWPAN inline data. This function returns true if the
209 * sk buffer is too small to pull the amount of data which is specified
212 * @skb: the buffer where the inline data should be pulled from.
213 * @data: destination buffer for the inline data.
214 * @len: amount of data which should be pulled in bytes.
216 static inline bool lowpan_fetch_skb(struct sk_buff
*skb
, void *data
,
219 if (unlikely(!pskb_may_pull(skb
, len
)))
222 skb_copy_from_linear_data(skb
, data
, len
);
228 static inline void lowpan_push_hc_data(u8
**hc_ptr
, const void *data
,
231 memcpy(*hc_ptr
, data
, len
);
235 int lowpan_register_netdevice(struct net_device
*dev
,
236 enum lowpan_lltypes lltype
);
237 int lowpan_register_netdev(struct net_device
*dev
,
238 enum lowpan_lltypes lltype
);
239 void lowpan_unregister_netdevice(struct net_device
*dev
);
240 void lowpan_unregister_netdev(struct net_device
*dev
);
243 * lowpan_header_decompress - replace 6LoWPAN header with IPv6 header
245 * This function replaces the IPHC 6LoWPAN header which should be pointed at
246 * skb->data and skb_network_header, with the IPv6 header.
247 * It would be nice that the caller have the necessary headroom of IPv6 header
248 * and greatest Transport layer header, this would reduce the overhead for
249 * reallocate headroom.
251 * @skb: the buffer which should be manipulate.
252 * @dev: the lowpan net device pointer.
253 * @daddr: destination lladdr of mac header which is used for compression
255 * @saddr: source lladdr of mac header which is used for compression
258 int lowpan_header_decompress(struct sk_buff
*skb
, const struct net_device
*dev
,
259 const void *daddr
, const void *saddr
);
262 * lowpan_header_compress - replace IPv6 header with 6LoWPAN header
264 * This function replaces the IPv6 header which should be pointed at
265 * skb->data and skb_network_header, with the IPHC 6LoWPAN header.
266 * The caller need to be sure that the sk buffer is not shared and at have
267 * at least a headroom which is smaller or equal LOWPAN_IPHC_MAX_HEADER_LEN,
268 * which is the IPHC "more bytes than IPv6 header" at worst case.
270 * @skb: the buffer which should be manipulate.
271 * @dev: the lowpan net device pointer.
272 * @daddr: destination lladdr of mac header which is used for compression
274 * @saddr: source lladdr of mac header which is used for compression
277 int lowpan_header_compress(struct sk_buff
*skb
, const struct net_device
*dev
,
278 const void *daddr
, const void *saddr
);
280 #endif /* __6LOWPAN_H__ */