[mirror_ubuntu-bionic-kernel.git] / include / net / 6lowpan.h

/*
 * Copyright 2011, Siemens AG
 * written by Alexander Smirnov <alex.bluesman.smirnov@gmail.com>
 */

/*
 * Based on patches from Jon Smirl <jonsmirl@gmail.com>
 * Copyright (c) 2011 Jon Smirl <jonsmirl@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

/* Jon's code is based on 6lowpan implementation for Contiki which is:
 * Copyright (c) 2008, Swedish Institute of Computer Science.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the Institute nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef __6LOWPAN_H__
#define __6LOWPAN_H__

#include <net/ipv6.h>
#include <net/net_namespace.h>

#define UIP_802154_SHORTADDR_LEN	2  /* compressed ipv6 address length */
#define UIP_IPH_LEN			40 /* ipv6 fixed header size */
#define UIP_PROTO_UDP			17 /* ipv6 next header value for UDP */
#define UIP_FRAGH_LEN			8  /* ipv6 fragment header size */

#define EUI64_ADDR_LEN		8

#define LOWPAN_NHC_MAX_ID_LEN	1
/* Maximum next header compression length which we currently support inclusive
 * possible inline data.
 */
#define LOWPAN_NHC_MAX_HDR_LEN	(sizeof(struct udphdr))
/* Max IPHC Header len without IPv6 hdr specific inline data.
 * Useful for getting the "extra" bytes we need at worst case compression.
 *
 * LOWPAN_IPHC + CID + LOWPAN_NHC_MAX_ID_LEN
 */
#define LOWPAN_IPHC_MAX_HEADER_LEN	(2 + 1 + LOWPAN_NHC_MAX_ID_LEN)
/* Maximum worst case IPHC header buffer size */
#define LOWPAN_IPHC_MAX_HC_BUF_LEN	(sizeof(struct ipv6hdr) +	\
					 LOWPAN_IPHC_MAX_HEADER_LEN +	\
					 LOWPAN_NHC_MAX_HDR_LEN)

/*
 * ipv6 address based on mac
 * second bit-flip (Universe/Local) is done according RFC2464
 */
#define is_addr_mac_addr_based(a, m) \
	((((a)->s6_addr[8])  == (((m)[0]) ^ 0x02)) &&	\
	 (((a)->s6_addr[9])  == (m)[1]) &&		\
	 (((a)->s6_addr[10]) == (m)[2]) &&		\
	 (((a)->s6_addr[11]) == (m)[3]) &&		\
	 (((a)->s6_addr[12]) == (m)[4]) &&		\
	 (((a)->s6_addr[13]) == (m)[5]) &&		\
	 (((a)->s6_addr[14]) == (m)[6]) &&		\
	 (((a)->s6_addr[15]) == (m)[7]))

/*
 * check whether we can compress the IID to 16 bits,
 * it's possible for unicast adresses with first 49 bits are zero only.
 */
#define lowpan_is_iid_16_bit_compressable(a)	\
	((((a)->s6_addr16[4]) == 0) &&		\
	 (((a)->s6_addr[10]) == 0) &&		\
	 (((a)->s6_addr[11]) == 0xff) &&	\
	 (((a)->s6_addr[12]) == 0xfe) &&	\
	 (((a)->s6_addr[13]) == 0))

/* check whether the 112-bit gid of the multicast address is mappable to: */

/* 48 bits, FFXX::00XX:XXXX:XXXX */
#define lowpan_is_mcast_addr_compressable48(a)	\
	((((a)->s6_addr16[1]) == 0) &&		\
	 (((a)->s6_addr16[2]) == 0) &&		\
	 (((a)->s6_addr16[3]) == 0) &&		\
	 (((a)->s6_addr16[4]) == 0) &&		\
	 (((a)->s6_addr[10]) == 0))

/* 32 bits, FFXX::00XX:XXXX */
#define lowpan_is_mcast_addr_compressable32(a)	\
	((((a)->s6_addr16[1]) == 0) &&		\
	 (((a)->s6_addr16[2]) == 0) &&		\
	 (((a)->s6_addr16[3]) == 0) &&		\
	 (((a)->s6_addr16[4]) == 0) &&		\
	 (((a)->s6_addr16[5]) == 0) &&		\
	 (((a)->s6_addr[12]) == 0))

/* 8 bits, FF02::00XX */
#define lowpan_is_mcast_addr_compressable8(a)	\
	((((a)->s6_addr[1])  == 2) &&		\
	 (((a)->s6_addr16[1]) == 0) &&		\
	 (((a)->s6_addr16[2]) == 0) &&		\
	 (((a)->s6_addr16[3]) == 0) &&		\
	 (((a)->s6_addr16[4]) == 0) &&		\
	 (((a)->s6_addr16[5]) == 0) &&		\
	 (((a)->s6_addr16[6]) == 0) &&		\
	 (((a)->s6_addr[14]) == 0))

#define lowpan_is_addr_broadcast(a)	\
	((((a)[0]) == 0xFF) &&	\
	 (((a)[1]) == 0xFF) &&	\
	 (((a)[2]) == 0xFF) &&	\
	 (((a)[3]) == 0xFF) &&	\
	 (((a)[4]) == 0xFF) &&	\
	 (((a)[5]) == 0xFF) &&	\
	 (((a)[6]) == 0xFF) &&	\
	 (((a)[7]) == 0xFF))

#define LOWPAN_DISPATCH_IPV6		0x41 /* 01000001 = 65 */
#define LOWPAN_DISPATCH_IPHC		0x60 /* 011xxxxx = ... */
#define LOWPAN_DISPATCH_IPHC_MASK	0xe0

static inline bool lowpan_is_ipv6(u8 dispatch)
{
	return dispatch == LOWPAN_DISPATCH_IPV6;
}

static inline bool lowpan_is_iphc(u8 dispatch)
{
	return (dispatch & LOWPAN_DISPATCH_IPHC_MASK) == LOWPAN_DISPATCH_IPHC;
}

#define LOWPAN_FRAG_TIMEOUT	(HZ * 60)	/* time-out 60 sec */

#define LOWPAN_FRAG1_HEAD_SIZE	0x4
#define LOWPAN_FRAGN_HEAD_SIZE	0x5

/*
 * Values of fields within the IPHC encoding first byte
 * (C stands for compressed and I for inline)
 */
#define LOWPAN_IPHC_TF		0x18

#define LOWPAN_IPHC_FL_C	0x10
#define LOWPAN_IPHC_TC_C	0x08
#define LOWPAN_IPHC_NH_C	0x04
#define LOWPAN_IPHC_TTL_1	0x01
#define LOWPAN_IPHC_TTL_64	0x02
#define LOWPAN_IPHC_TTL_255	0x03
#define LOWPAN_IPHC_TTL_I	0x00


/* Values of fields within the IPHC encoding second byte */
#define LOWPAN_IPHC_CID		0x80

#define LOWPAN_IPHC_ADDR_00	0x00
#define LOWPAN_IPHC_ADDR_01	0x01
#define LOWPAN_IPHC_ADDR_02	0x02
#define LOWPAN_IPHC_ADDR_03	0x03

#define LOWPAN_IPHC_SAC		0x40
#define LOWPAN_IPHC_SAM		0x30

#define LOWPAN_IPHC_SAM_BIT	4

#define LOWPAN_IPHC_M		0x08
#define LOWPAN_IPHC_DAC		0x04
#define LOWPAN_IPHC_DAM_00	0x00
#define LOWPAN_IPHC_DAM_01	0x01
#define LOWPAN_IPHC_DAM_10	0x02
#define LOWPAN_IPHC_DAM_11	0x03

#define LOWPAN_IPHC_DAM_BIT	0
/*
 * LOWPAN_UDP encoding (works together with IPHC)
 */
#define LOWPAN_NHC_UDP_MASK		0xF8
#define LOWPAN_NHC_UDP_ID		0xF0
#define LOWPAN_NHC_UDP_CHECKSUMC	0x04
#define LOWPAN_NHC_UDP_CHECKSUMI	0x00

#define LOWPAN_NHC_UDP_4BIT_PORT	0xF0B0
#define LOWPAN_NHC_UDP_4BIT_MASK	0xFFF0
#define LOWPAN_NHC_UDP_8BIT_PORT	0xF000
#define LOWPAN_NHC_UDP_8BIT_MASK	0xFF00

/* values for port compression, _with checksum_ ie bit 5 set to 0 */
#define LOWPAN_NHC_UDP_CS_P_00	0xF0 /* all inline */
#define LOWPAN_NHC_UDP_CS_P_01	0xF1 /* source 16bit inline,
					dest = 0xF0 + 8 bit inline */
#define LOWPAN_NHC_UDP_CS_P_10	0xF2 /* source = 0xF0 + 8bit inline,
					dest = 16 bit inline */
#define LOWPAN_NHC_UDP_CS_P_11	0xF3 /* source & dest = 0xF0B + 4bit inline */
#define LOWPAN_NHC_UDP_CS_C	0x04 /* checksum elided */

#define LOWPAN_PRIV_SIZE(llpriv_size)	\
	(sizeof(struct lowpan_priv) + llpriv_size)

enum lowpan_lltypes {
	LOWPAN_LLTYPE_BTLE,
	LOWPAN_LLTYPE_IEEE802154,
};

struct lowpan_priv {
	enum lowpan_lltypes lltype;

	/* must be last */
	u8 priv[0] __aligned(sizeof(void *));
};

static inline
struct lowpan_priv *lowpan_priv(const struct net_device *dev)
{
	return netdev_priv(dev);
}

struct lowpan_802154_cb {
	u16 d_tag;
	unsigned int d_size;
	u8 d_offset;
};

static inline
struct lowpan_802154_cb *lowpan_802154_cb(const struct sk_buff *skb)
{
	BUILD_BUG_ON(sizeof(struct lowpan_802154_cb) > sizeof(skb->cb));
	return (struct lowpan_802154_cb *)skb->cb;
}

#ifdef DEBUG
/* print data in line */
static inline void raw_dump_inline(const char *caller, char *msg,
				   const unsigned char *buf, int len)
{
	if (msg)
		pr_debug("%s():%s: ", caller, msg);

	print_hex_dump_debug("", DUMP_PREFIX_NONE, 16, 1, buf, len, false);
}

/* print data in a table format:
 *
 * addr: xx xx xx xx xx xx
 * addr: xx xx xx xx xx xx
 * ...
 */
static inline void raw_dump_table(const char *caller, char *msg,
				  const unsigned char *buf, int len)
{
	if (msg)
		pr_debug("%s():%s:\n", caller, msg);

	print_hex_dump_debug("\t", DUMP_PREFIX_OFFSET, 16, 1, buf, len, false);
}
#else
static inline void raw_dump_table(const char *caller, char *msg,
				  const unsigned char *buf, int len) { }
static inline void raw_dump_inline(const char *caller, char *msg,
				   const unsigned char *buf, int len) { }
#endif

static inline int lowpan_fetch_skb_u8(struct sk_buff *skb, u8 *val)
{
	if (unlikely(!pskb_may_pull(skb, 1)))
		return -EINVAL;

	*val = skb->data[0];
	skb_pull(skb, 1);

	return 0;
}

static inline bool lowpan_fetch_skb(struct sk_buff *skb,
		void *data, const unsigned int len)
{
	if (unlikely(!pskb_may_pull(skb, len)))
		return true;

	skb_copy_from_linear_data(skb, data, len);
	skb_pull(skb, len);

	return false;
}

static inline void lowpan_push_hc_data(u8 **hc_ptr, const void *data,
				       const size_t len)
{
	memcpy(*hc_ptr, data, len);
	*hc_ptr += len;
}

void lowpan_netdev_setup(struct net_device *dev, enum lowpan_lltypes lltype);

/**
 * lowpan_header_decompress - replace 6LoWPAN header with IPv6 header
 *
 * This function replaces the IPHC 6LoWPAN header which should be pointed at
 * skb->data and skb_network_header, with the IPv6 header.
 * It would be nice that the caller have the necessary headroom of IPv6 header
 * and greatest Transport layer header, this would reduce the overhead for
 * reallocate headroom.
 *
 * @skb: the buffer which should be manipulate.
 * @dev: the lowpan net device pointer.
 * @daddr: destination lladdr of mac header which is used for compression
 *	methods.
 * @saddr: source lladdr of mac header which is used for compression
 *	methods.
 */
int lowpan_header_decompress(struct sk_buff *skb, const struct net_device *dev,
			     const void *daddr, const void *saddr);

/**
 * lowpan_header_compress - replace IPv6 header with 6LoWPAN header
 *
 * This function replaces the IPv6 header which should be pointed at
 * skb->data and skb_network_header, with the IPHC 6LoWPAN header.
 * The caller need to be sure that the sk buffer is not shared and at have
 * at least a headroom which is smaller or equal LOWPAN_IPHC_MAX_HEADER_LEN,
 * which is the IPHC "more bytes than IPv6 header" at worst case.
 *
 * @skb: the buffer which should be manipulate.
 * @dev: the lowpan net device pointer.
 * @daddr: destination lladdr of mac header which is used for compression
 *	methods.
 * @saddr: source lladdr of mac header which is used for compression
 *	methods.
 */
int lowpan_header_compress(struct sk_buff *skb, const struct net_device *dev,
			   const void *daddr, const void *saddr);

#endif /* __6LOWPAN_H__ */
Commit	Line	Data
44331fe2 AS	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
91c69227	56	#include <net/ipv6.h>
17d8ecb8	57	#include <net/net_namespace.h>
91c69227	58
44331fe2 AS	59	#define UIP_802154_SHORTADDR_LEN 2 /* compressed ipv6 address length */
	60	#define UIP_IPH_LEN 40 /* ipv6 fixed header size */
	61	#define UIP_PROTO_UDP 17 /* ipv6 next header value for UDP */
	62	#define UIP_FRAGH_LEN 8 /* ipv6 fragment header size */
	63
4d6a6aed AA	64	#define EUI64_ADDR_LEN 8
4d6a6aed AA	65
87a93e4e	66	#define LOWPAN_NHC_MAX_ID_LEN 1
bf513fd6 AA	67	/* Maximum next header compression length which we currently support inclusive
	68	* possible inline data.
	69	*/
	70	#define LOWPAN_NHC_MAX_HDR_LEN (sizeof(struct udphdr))
87a93e4e AA	71	/* Max IPHC Header len without IPv6 hdr specific inline data.
	72	* Useful for getting the "extra" bytes we need at worst case compression.
	73	*
	74	* LOWPAN_IPHC + CID + LOWPAN_NHC_MAX_ID_LEN
	75	*/
	76	#define LOWPAN_IPHC_MAX_HEADER_LEN (2 + 1 + LOWPAN_NHC_MAX_ID_LEN)
bf513fd6 AA	77	/* Maximum worst case IPHC header buffer size */
	78	#define LOWPAN_IPHC_MAX_HC_BUF_LEN (sizeof(struct ipv6hdr) + \
	79	LOWPAN_IPHC_MAX_HEADER_LEN + \
	80	LOWPAN_NHC_MAX_HDR_LEN)
87a93e4e	81
44331fe2 AS	82	/*
	83	* ipv6 address based on mac
	84	* second bit-flip (Universe/Local) is done according RFC2464
	85	*/
	86	#define is_addr_mac_addr_based(a, m) \
	87	((((a)->s6_addr[8]) == (((m)[0]) ^ 0x02)) && \
	88	(((a)->s6_addr[9]) == (m)[1]) && \
	89	(((a)->s6_addr[10]) == (m)[2]) && \
	90	(((a)->s6_addr[11]) == (m)[3]) && \
	91	(((a)->s6_addr[12]) == (m)[4]) && \
	92	(((a)->s6_addr[13]) == (m)[5]) && \
	93	(((a)->s6_addr[14]) == (m)[6]) && \
	94	(((a)->s6_addr[15]) == (m)[7]))
	95
44331fe2 AS	96	/*
	97	* check whether we can compress the IID to 16 bits,
	98	* it's possible for unicast adresses with first 49 bits are zero only.
	99	*/
	100	#define lowpan_is_iid_16_bit_compressable(a) \
	101	((((a)->s6_addr16[4]) == 0) && \
8d879a3f TC	102	(((a)->s6_addr[10]) == 0) && \
	103	(((a)->s6_addr[11]) == 0xff) && \
	104	(((a)->s6_addr[12]) == 0xfe) && \
	105	(((a)->s6_addr[13]) == 0))
44331fe2	106
44331fe2 AS	107	/* check whether the 112-bit gid of the multicast address is mappable to: */
44331fe2 AS	108
44331fe2 AS	109	/* 48 bits, FFXX::00XX:XXXX:XXXX */
	110	#define lowpan_is_mcast_addr_compressable48(a) \
	111	((((a)->s6_addr16[1]) == 0) && \
	112	(((a)->s6_addr16[2]) == 0) && \
	113	(((a)->s6_addr16[3]) == 0) && \
	114	(((a)->s6_addr16[4]) == 0) && \
	115	(((a)->s6_addr[10]) == 0))
	116
	117	/* 32 bits, FFXX::00XX:XXXX */
	118	#define lowpan_is_mcast_addr_compressable32(a) \
	119	((((a)->s6_addr16[1]) == 0) && \
	120	(((a)->s6_addr16[2]) == 0) && \
	121	(((a)->s6_addr16[3]) == 0) && \
	122	(((a)->s6_addr16[4]) == 0) && \
	123	(((a)->s6_addr16[5]) == 0) && \
	124	(((a)->s6_addr[12]) == 0))
	125
	126	/* 8 bits, FF02::00XX */
	127	#define lowpan_is_mcast_addr_compressable8(a) \
	128	((((a)->s6_addr[1]) == 2) && \
	129	(((a)->s6_addr16[1]) == 0) && \
	130	(((a)->s6_addr16[2]) == 0) && \
	131	(((a)->s6_addr16[3]) == 0) && \
	132	(((a)->s6_addr16[4]) == 0) && \
	133	(((a)->s6_addr16[5]) == 0) && \
	134	(((a)->s6_addr16[6]) == 0) && \
	135	(((a)->s6_addr[14]) == 0))
	136
	137	#define lowpan_is_addr_broadcast(a) \
	138	((((a)[0]) == 0xFF) && \
	139	(((a)[1]) == 0xFF) && \
	140	(((a)[2]) == 0xFF) && \
	141	(((a)[3]) == 0xFF) && \
	142	(((a)[4]) == 0xFF) && \
	143	(((a)[5]) == 0xFF) && \
	144	(((a)[6]) == 0xFF) && \
	145	(((a)[7]) == 0xFF))
	146
72a5e6bb AA	147	#define LOWPAN_DISPATCH_IPV6 0x41 /* 01000001 = 65 */
	148	#define LOWPAN_DISPATCH_IPHC 0x60 /* 011xxxxx = ... */
	149	#define LOWPAN_DISPATCH_IPHC_MASK 0xe0
44331fe2	150
72a5e6bb AA	151	static inline bool lowpan_is_ipv6(u8 dispatch)
	152	{
	153	return dispatch == LOWPAN_DISPATCH_IPV6;
	154	}
	155
	156	static inline bool lowpan_is_iphc(u8 dispatch)
	157	{
	158	return (dispatch & LOWPAN_DISPATCH_IPHC_MASK) == LOWPAN_DISPATCH_IPHC;
	159	}
719269af	160
	161	#define LOWPAN_FRAG_TIMEOUT (HZ * 60) /* time-out 60 sec */
	162
	163	#define LOWPAN_FRAG1_HEAD_SIZE 0x4
	164	#define LOWPAN_FRAGN_HEAD_SIZE 0x5
	165
44331fe2 AS	166	/*
	167	* Values of fields within the IPHC encoding first byte
	168	* (C stands for compressed and I for inline)
	169	*/
	170	#define LOWPAN_IPHC_TF 0x18
	171
	172	#define LOWPAN_IPHC_FL_C 0x10
	173	#define LOWPAN_IPHC_TC_C 0x08
	174	#define LOWPAN_IPHC_NH_C 0x04
	175	#define LOWPAN_IPHC_TTL_1 0x01
	176	#define LOWPAN_IPHC_TTL_64 0x02
	177	#define LOWPAN_IPHC_TTL_255 0x03
	178	#define LOWPAN_IPHC_TTL_I 0x00
	179
	180
	181	/* Values of fields within the IPHC encoding second byte */
	182	#define LOWPAN_IPHC_CID 0x80
	183
ce2463b2 AA	184	#define LOWPAN_IPHC_ADDR_00 0x00
	185	#define LOWPAN_IPHC_ADDR_01 0x01
	186	#define LOWPAN_IPHC_ADDR_02 0x02
	187	#define LOWPAN_IPHC_ADDR_03 0x03
	188
44331fe2	189	#define LOWPAN_IPHC_SAC 0x40
44331fe2 AS	190	#define LOWPAN_IPHC_SAM 0x30
	191
	192	#define LOWPAN_IPHC_SAM_BIT 4
	193
	194	#define LOWPAN_IPHC_M 0x08
	195	#define LOWPAN_IPHC_DAC 0x04
	196	#define LOWPAN_IPHC_DAM_00 0x00
	197	#define LOWPAN_IPHC_DAM_01 0x01
	198	#define LOWPAN_IPHC_DAM_10 0x02
	199	#define LOWPAN_IPHC_DAM_11 0x03
	200
	201	#define LOWPAN_IPHC_DAM_BIT 0
	202	/*
	203	* LOWPAN_UDP encoding (works together with IPHC)
	204	*/
	205	#define LOWPAN_NHC_UDP_MASK 0xF8
	206	#define LOWPAN_NHC_UDP_ID 0xF0
	207	#define LOWPAN_NHC_UDP_CHECKSUMC 0x04
	208	#define LOWPAN_NHC_UDP_CHECKSUMI 0x00
	209
3bd5b958	210	#define LOWPAN_NHC_UDP_4BIT_PORT 0xF0B0
	211	#define LOWPAN_NHC_UDP_4BIT_MASK 0xFFF0
	212	#define LOWPAN_NHC_UDP_8BIT_PORT 0xF000
	213	#define LOWPAN_NHC_UDP_8BIT_MASK 0xFF00
	214
44331fe2 AS	215	/* values for port compression, _with checksum_ ie bit 5 set to 0 */
	216	#define LOWPAN_NHC_UDP_CS_P_00 0xF0 /* all inline */
	217	#define LOWPAN_NHC_UDP_CS_P_01 0xF1 /* source 16bit inline,
	218	dest = 0xF0 + 8 bit inline */
	219	#define LOWPAN_NHC_UDP_CS_P_10 0xF2 /* source = 0xF0 + 8bit inline,
	220	dest = 16 bit inline */
	221	#define LOWPAN_NHC_UDP_CS_P_11 0xF3 /* source & dest = 0xF0B + 4bit inline */
573701ce	222	#define LOWPAN_NHC_UDP_CS_C 0x04 /* checksum elided */
44331fe2	223
b72f6f51 AA	224	#define LOWPAN_PRIV_SIZE(llpriv_size) \
	225	(sizeof(struct lowpan_priv) + llpriv_size)
	226
	227	enum lowpan_lltypes {
	228	LOWPAN_LLTYPE_BTLE,
	229	LOWPAN_LLTYPE_IEEE802154,
	230	};
	231
	232	struct lowpan_priv {
	233	enum lowpan_lltypes lltype;
	234
	235	/* must be last */
	236	u8 priv[0] __aligned(sizeof(void *));
	237	};
	238
	239	static inline
	240	struct lowpan_priv lowpan_priv(const struct net_device dev)
	241	{
	242	return netdev_priv(dev);
	243	}
	244
72a5e6bb AA	245	struct lowpan_802154_cb {
	246	u16 d_tag;
	247	unsigned int d_size;
	248	u8 d_offset;
	249	};
	250
	251	static inline
	252	struct lowpan_802154_cb lowpan_802154_cb(const struct sk_buff skb)
	253	{
	254	BUILD_BUG_ON(sizeof(struct lowpan_802154_cb) > sizeof(skb->cb));
	255	return (struct lowpan_802154_cb *)skb->cb;
	256	}
	257
841a5ec7 AA	258	#ifdef DEBUG
	259	/* print data in line */
	260	static inline void raw_dump_inline(const char caller, char msg,
a6f77389	261	const unsigned char *buf, int len)
841a5ec7 AA	262	{
	263	if (msg)
	264	pr_debug("%s():%s: ", caller, msg);
	265
	266	print_hex_dump_debug("", DUMP_PREFIX_NONE, 16, 1, buf, len, false);
	267	}
	268
	269	/* print data in a table format:
	270	*
	271	* addr: xx xx xx xx xx xx
	272	* addr: xx xx xx xx xx xx
	273	* ...
	274	*/
	275	static inline void raw_dump_table(const char caller, char msg,
a6f77389	276	const unsigned char *buf, int len)
841a5ec7 AA	277	{
	278	if (msg)
	279	pr_debug("%s():%s:\n", caller, msg);
	280
	281	print_hex_dump_debug("\t", DUMP_PREFIX_OFFSET, 16, 1, buf, len, false);
	282	}
	283	#else
	284	static inline void raw_dump_table(const char caller, char msg,
a6f77389	285	const unsigned char *buf, int len) { }
841a5ec7	286	static inline void raw_dump_inline(const char caller, char msg,
a6f77389	287	const unsigned char *buf, int len) { }
841a5ec7 AA	288	#endif
841a5ec7 AA	289
8df8c56a JR	290	static inline int lowpan_fetch_skb_u8(struct sk_buff skb, u8 val)
	291	{
	292	if (unlikely(!pskb_may_pull(skb, 1)))
	293	return -EINVAL;
	294
	295	*val = skb->data[0];
	296	skb_pull(skb, 1);
	297
	298	return 0;
	299	}
	300
4666669f AA	301	static inline bool lowpan_fetch_skb(struct sk_buff *skb,
	302	void *data, const unsigned int len)
	303	{
	304	if (unlikely(!pskb_may_pull(skb, len)))
	305	return true;
	306
	307	skb_copy_from_linear_data(skb, data, len);
	308	skb_pull(skb, len);
	309
	310	return false;
	311	}
	312
3109f2e2 AA	313	static inline void lowpan_push_hc_data(u8 *hc_ptr, const void data,
	314	const size_t len)
	315	{
	316	memcpy(*hc_ptr, data, len);
	317	*hc_ptr += len;
	318	}
	319
b72f6f51 AA	320	void lowpan_netdev_setup(struct net_device *dev, enum lowpan_lltypes lltype);
b72f6f51 AA	321
8911d774 AA	322	/**
	323	* lowpan_header_decompress - replace 6LoWPAN header with IPv6 header
	324	*
	325	* This function replaces the IPHC 6LoWPAN header which should be pointed at
	326	* skb->data and skb_network_header, with the IPv6 header.
	327	* It would be nice that the caller have the necessary headroom of IPv6 header
	328	* and greatest Transport layer header, this would reduce the overhead for
	329	* reallocate headroom.
	330	*
	331	* @skb: the buffer which should be manipulate.
	332	* @dev: the lowpan net device pointer.
	333	* @daddr: destination lladdr of mac header which is used for compression
	334	* methods.
	335	* @saddr: source lladdr of mac header which is used for compression
	336	* methods.
	337	*/
	338	int lowpan_header_decompress(struct sk_buff skb, const struct net_device dev,
	339	const void daddr, const void saddr);
a6f77389 AA	340
	341	/**
	342	* lowpan_header_compress - replace IPv6 header with 6LoWPAN header
	343	*
	344	* This function replaces the IPv6 header which should be pointed at
	345	* skb->data and skb_network_header, with the IPHC 6LoWPAN header.
	346	* The caller need to be sure that the sk buffer is not shared and at have
	347	* at least a headroom which is smaller or equal LOWPAN_IPHC_MAX_HEADER_LEN,
	348	* which is the IPHC "more bytes than IPv6 header" at worst case.
	349	*
	350	* @skb: the buffer which should be manipulate.
	351	* @dev: the lowpan net device pointer.
	352	* @daddr: destination lladdr of mac header which is used for compression
	353	* methods.
	354	* @saddr: source lladdr of mac header which is used for compression
	355	* methods.
	356	*/
	357	int lowpan_header_compress(struct sk_buff skb, const struct net_device dev,
	358	const void daddr, const void saddr);
8df8c56a	359
44331fe2	360	#endif /* __6LOWPAN_H__ */