[linux.git] / net / ieee802154 / 6lowpan.h

/*
 * Copyright 2011, Siemens AG
 * written by Alexander Smirnov <[email protected]>
 */

/*
 * Based on patches from Jon Smirl <[email protected]>
 * Copyright (c) 2011 Jon Smirl <[email protected]>
 *
 * 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__

#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 */

/*
 * 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]))

/* ipv6 address is unspecified */
#define is_addr_unspecified(a)		\
	((((a)->s6_addr32[0]) == 0) &&	\
	 (((a)->s6_addr32[1]) == 0) &&	\
	 (((a)->s6_addr32[2]) == 0) &&	\
	 (((a)->s6_addr32[3]) == 0))

/* compare ipv6 addresses prefixes */
#define ipaddr_prefixcmp(addr1, addr2, length) \
	(memcmp(addr1, addr2, length >> 3) == 0)

/* local link, i.e. FE80::/10 */
#define is_addr_link_local(a) (((a)->s6_addr16[0]) == htons(0xFE80))

/*
 * 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))

/* multicast address */
#define is_addr_mcast(a) (((a)->s6_addr[0]) == 0xFF)

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

/* 9 bits, for FF02::1 (all nodes) and FF02::2 (all routers) addresses only. */
#define lowpan_is_mcast_addr_compressable(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_addr16[6]) == 0) &&		\
	 (((a)->s6_addr[14])  == 0) &&		\
	 ((((a)->s6_addr[15]) == 1) || (((a)->s6_addr[15]) == 2)))

/* 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_HC1	0x42 /* 01000010 = 66 */
#define LOWPAN_DISPATCH_IPHC	0x60 /* 011xxxxx = ... */
#define LOWPAN_DISPATCH_FRAG1	0xc0 /* 11000xxx */
#define LOWPAN_DISPATCH_FRAGN	0xe0 /* 11100xxx */

#define LOWPAN_DISPATCH_MASK	0xf8 /* 11111000 */

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

#define LOWPAN_FRAG1_HEAD_SIZE	0x4
#define LOWPAN_FRAGN_HEAD_SIZE	0x5

/*
 * According IEEE802.15.4 standard:
 *   - MTU is 127 octets
 *   - maximum MHR size is 37 octets
 *   - MFR size is 2 octets
 *
 * so minimal payload size that we may guarantee is:
 *   MTU - MHR - MFR = 88 octets
 */
#define LOWPAN_FRAG_SIZE	88

/*
 * 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 */

#ifdef DEBUG
/* print data in line */
static inline void raw_dump_inline(const char *caller, char *msg,
				   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,
				  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,
				  unsigned char *buf, int len) { }
static inline void raw_dump_inline(const char *caller, char *msg,
				   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 int lowpan_fetch_skb_u16(struct sk_buff *skb, u16 *val)
{
	if (unlikely(!pskb_may_pull(skb, 2)))
		return -EINVAL;

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

	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;
}

static inline u8 lowpan_addr_mode_size(const u8 addr_mode)
{
	static const u8 addr_sizes[] = {
		[LOWPAN_IPHC_ADDR_00] = 16,
		[LOWPAN_IPHC_ADDR_01] = 8,
		[LOWPAN_IPHC_ADDR_02] = 2,
		[LOWPAN_IPHC_ADDR_03] = 0,
	};
	return addr_sizes[addr_mode];
}

static inline u8 lowpan_next_hdr_size(const u8 h_enc, u16 *uncomp_header)
{
	u8 ret = 1;

	if ((h_enc & LOWPAN_NHC_UDP_MASK) == LOWPAN_NHC_UDP_ID) {
		*uncomp_header += sizeof(struct udphdr);

		switch (h_enc & LOWPAN_NHC_UDP_CS_P_11) {
		case LOWPAN_NHC_UDP_CS_P_00:
			ret += 4;
			break;
		case LOWPAN_NHC_UDP_CS_P_01:
		case LOWPAN_NHC_UDP_CS_P_10:
			ret += 3;
			break;
		case LOWPAN_NHC_UDP_CS_P_11:
			ret++;
			break;
		default:
			break;
		}

		if (!(h_enc & LOWPAN_NHC_UDP_CS_C))
			ret += 2;
	}

	return ret;
}

/**
 *	lowpan_uncompress_size - returns skb->len size with uncompressed header
 *	@skb: sk_buff with 6lowpan header inside
 *	@datagram_offset: optional to get the datagram_offset value
 *
 *	Returns the skb->len with uncompressed header
 */
static inline u16
lowpan_uncompress_size(const struct sk_buff *skb, u16 *dgram_offset)
{
	u16 ret = 2, uncomp_header = sizeof(struct ipv6hdr);
	u8 iphc0, iphc1, h_enc;

	iphc0 = skb_network_header(skb)[0];
	iphc1 = skb_network_header(skb)[1];

	switch ((iphc0 & LOWPAN_IPHC_TF) >> 3) {
	case 0:
		ret += 4;
		break;
	case 1:
		ret += 3;
		break;
	case 2:
		ret++;
		break;
	default:
		break;
	}

	if (!(iphc0 & LOWPAN_IPHC_NH_C))
		ret++;

	if (!(iphc0 & 0x03))
		ret++;

	ret += lowpan_addr_mode_size((iphc1 & LOWPAN_IPHC_SAM) >>
				     LOWPAN_IPHC_SAM_BIT);

	if (iphc1 & LOWPAN_IPHC_M) {
		switch ((iphc1 & LOWPAN_IPHC_DAM_11) >>
			LOWPAN_IPHC_DAM_BIT) {
		case LOWPAN_IPHC_DAM_00:
			ret += 16;
			break;
		case LOWPAN_IPHC_DAM_01:
			ret += 6;
			break;
		case LOWPAN_IPHC_DAM_10:
			ret += 4;
			break;
		case LOWPAN_IPHC_DAM_11:
			ret++;
			break;
		default:
			break;
		}
	} else {
		ret += lowpan_addr_mode_size((iphc1 & LOWPAN_IPHC_DAM_11) >>
					     LOWPAN_IPHC_DAM_BIT);
	}

	if (iphc0 & LOWPAN_IPHC_NH_C) {
		h_enc = skb_network_header(skb)[ret];
		ret += lowpan_next_hdr_size(h_enc, &uncomp_header);
	}

	if (dgram_offset)
		*dgram_offset = uncomp_header;

	return skb->len + uncomp_header - ret;
}

typedef int (*skb_delivery_cb)(struct sk_buff *skb, struct net_device *dev);

int lowpan_process_data(struct sk_buff *skb, struct net_device *dev,
		const u8 *saddr, const u8 saddr_type, const u8 saddr_len,
		const u8 *daddr, const u8 daddr_type, const u8 daddr_len,
		u8 iphc0, u8 iphc1, skb_delivery_cb skb_deliver);
int lowpan_header_compress(struct sk_buff *skb, struct net_device *dev,
			unsigned short type, const void *_daddr,
			const void *_saddr, unsigned int len);

#endif /* __6LOWPAN_H__ */
Commit	Line	Data
44331fe2 AS	1	/*
	2	* Copyright 2011, Siemens AG
	3	* written by Alexander Smirnov <[email protected]>
	4	*/
	5
	6	/*
	7	* Based on patches from Jon Smirl <[email protected]>
	8	* Copyright (c) 2011 Jon Smirl <[email protected]>
	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
44331fe2 AS	56	#define UIP_802154_SHORTADDR_LEN 2 /* compressed ipv6 address length */
	57	#define UIP_IPH_LEN 40 /* ipv6 fixed header size */
	58	#define UIP_PROTO_UDP 17 /* ipv6 next header value for UDP */
	59	#define UIP_FRAGH_LEN 8 /* ipv6 fragment header size */
	60
	61	/*
	62	* ipv6 address based on mac
	63	* second bit-flip (Universe/Local) is done according RFC2464
	64	*/
	65	#define is_addr_mac_addr_based(a, m) \
	66	((((a)->s6_addr[8]) == (((m)[0]) ^ 0x02)) && \
	67	(((a)->s6_addr[9]) == (m)[1]) && \
	68	(((a)->s6_addr[10]) == (m)[2]) && \
	69	(((a)->s6_addr[11]) == (m)[3]) && \
	70	(((a)->s6_addr[12]) == (m)[4]) && \
	71	(((a)->s6_addr[13]) == (m)[5]) && \
	72	(((a)->s6_addr[14]) == (m)[6]) && \
	73	(((a)->s6_addr[15]) == (m)[7]))
	74
	75	/* ipv6 address is unspecified */
	76	#define is_addr_unspecified(a) \
	77	((((a)->s6_addr32[0]) == 0) && \
	78	(((a)->s6_addr32[1]) == 0) && \
	79	(((a)->s6_addr32[2]) == 0) && \
	80	(((a)->s6_addr32[3]) == 0))
	81
	82	/* compare ipv6 addresses prefixes */
	83	#define ipaddr_prefixcmp(addr1, addr2, length) \
	84	(memcmp(addr1, addr2, length >> 3) == 0)
	85
	86	/* local link, i.e. FE80::/10 */
9026c492	87	#define is_addr_link_local(a) (((a)->s6_addr16[0]) == htons(0xFE80))
44331fe2 AS	88
	89	/*
	90	* check whether we can compress the IID to 16 bits,
	91	* it's possible for unicast adresses with first 49 bits are zero only.
	92	*/
	93	#define lowpan_is_iid_16_bit_compressable(a) \
	94	((((a)->s6_addr16[4]) == 0) && \
8d879a3f TC	95	(((a)->s6_addr[10]) == 0) && \
	96	(((a)->s6_addr[11]) == 0xff) && \
	97	(((a)->s6_addr[12]) == 0xfe) && \
	98	(((a)->s6_addr[13]) == 0))
44331fe2 AS	99
	100	/* multicast address */
	101	#define is_addr_mcast(a) (((a)->s6_addr[0]) == 0xFF)
	102
	103	/* check whether the 112-bit gid of the multicast address is mappable to: */
	104
	105	/* 9 bits, for FF02::1 (all nodes) and FF02::2 (all routers) addresses only. */
	106	#define lowpan_is_mcast_addr_compressable(a) \
	107	((((a)->s6_addr16[1]) == 0) && \
	108	(((a)->s6_addr16[2]) == 0) && \
	109	(((a)->s6_addr16[3]) == 0) && \
	110	(((a)->s6_addr16[4]) == 0) && \
	111	(((a)->s6_addr16[5]) == 0) && \
	112	(((a)->s6_addr16[6]) == 0) && \
	113	(((a)->s6_addr[14]) == 0) && \
	114	((((a)->s6_addr[15]) == 1) \|\| (((a)->s6_addr[15]) == 2)))
	115
	116	/* 48 bits, FFXX::00XX:XXXX:XXXX */
	117	#define lowpan_is_mcast_addr_compressable48(a) \
	118	((((a)->s6_addr16[1]) == 0) && \
	119	(((a)->s6_addr16[2]) == 0) && \
	120	(((a)->s6_addr16[3]) == 0) && \
	121	(((a)->s6_addr16[4]) == 0) && \
	122	(((a)->s6_addr[10]) == 0))
	123
	124	/* 32 bits, FFXX::00XX:XXXX */
	125	#define lowpan_is_mcast_addr_compressable32(a) \
	126	((((a)->s6_addr16[1]) == 0) && \
	127	(((a)->s6_addr16[2]) == 0) && \
	128	(((a)->s6_addr16[3]) == 0) && \
	129	(((a)->s6_addr16[4]) == 0) && \
	130	(((a)->s6_addr16[5]) == 0) && \
	131	(((a)->s6_addr[12]) == 0))
	132
	133	/* 8 bits, FF02::00XX */
	134	#define lowpan_is_mcast_addr_compressable8(a) \
	135	((((a)->s6_addr[1]) == 2) && \
	136	(((a)->s6_addr16[1]) == 0) && \
	137	(((a)->s6_addr16[2]) == 0) && \
	138	(((a)->s6_addr16[3]) == 0) && \
	139	(((a)->s6_addr16[4]) == 0) && \
	140	(((a)->s6_addr16[5]) == 0) && \
	141	(((a)->s6_addr16[6]) == 0) && \
	142	(((a)->s6_addr[14]) == 0))
	143
	144	#define lowpan_is_addr_broadcast(a) \
	145	((((a)[0]) == 0xFF) && \
	146	(((a)[1]) == 0xFF) && \
	147	(((a)[2]) == 0xFF) && \
	148	(((a)[3]) == 0xFF) && \
	149	(((a)[4]) == 0xFF) && \
	150	(((a)[5]) == 0xFF) && \
	151	(((a)[6]) == 0xFF) && \
	152	(((a)[7]) == 0xFF))
	153
	154	#define LOWPAN_DISPATCH_IPV6 0x41 /* 01000001 = 65 */
	155	#define LOWPAN_DISPATCH_HC1 0x42 /* 01000010 = 66 */
	156	#define LOWPAN_DISPATCH_IPHC 0x60 /* 011xxxxx = ... */
	157	#define LOWPAN_DISPATCH_FRAG1 0xc0 /* 11000xxx */
	158	#define LOWPAN_DISPATCH_FRAGN 0xe0 /* 11100xxx */
	159
719269af	160	#define LOWPAN_DISPATCH_MASK 0xf8 /* 11111000 */
	161
	162	#define LOWPAN_FRAG_TIMEOUT (HZ * 60) /* time-out 60 sec */
	163
	164	#define LOWPAN_FRAG1_HEAD_SIZE 0x4
	165	#define LOWPAN_FRAGN_HEAD_SIZE 0x5
	166
	167	/*
	168	* According IEEE802.15.4 standard:
	169	* - MTU is 127 octets
	170	* - maximum MHR size is 37 octets
	171	* - MFR size is 2 octets
	172	*
	173	* so minimal payload size that we may guarantee is:
	174	* MTU - MHR - MFR = 88 octets
	175	*/
	176	#define LOWPAN_FRAG_SIZE 88
	177
44331fe2 AS	178	/*
	179	* Values of fields within the IPHC encoding first byte
	180	* (C stands for compressed and I for inline)
	181	*/
	182	#define LOWPAN_IPHC_TF 0x18
	183
	184	#define LOWPAN_IPHC_FL_C 0x10
	185	#define LOWPAN_IPHC_TC_C 0x08
	186	#define LOWPAN_IPHC_NH_C 0x04
	187	#define LOWPAN_IPHC_TTL_1 0x01
	188	#define LOWPAN_IPHC_TTL_64 0x02
	189	#define LOWPAN_IPHC_TTL_255 0x03
	190	#define LOWPAN_IPHC_TTL_I 0x00
	191
	192
	193	/* Values of fields within the IPHC encoding second byte */
	194	#define LOWPAN_IPHC_CID 0x80
	195
ce2463b2 AA	196	#define LOWPAN_IPHC_ADDR_00 0x00
	197	#define LOWPAN_IPHC_ADDR_01 0x01
	198	#define LOWPAN_IPHC_ADDR_02 0x02
	199	#define LOWPAN_IPHC_ADDR_03 0x03
	200
44331fe2	201	#define LOWPAN_IPHC_SAC 0x40
44331fe2 AS	202	#define LOWPAN_IPHC_SAM 0x30
	203
	204	#define LOWPAN_IPHC_SAM_BIT 4
	205
	206	#define LOWPAN_IPHC_M 0x08
	207	#define LOWPAN_IPHC_DAC 0x04
	208	#define LOWPAN_IPHC_DAM_00 0x00
	209	#define LOWPAN_IPHC_DAM_01 0x01
	210	#define LOWPAN_IPHC_DAM_10 0x02
	211	#define LOWPAN_IPHC_DAM_11 0x03
	212
	213	#define LOWPAN_IPHC_DAM_BIT 0
	214	/*
	215	* LOWPAN_UDP encoding (works together with IPHC)
	216	*/
	217	#define LOWPAN_NHC_UDP_MASK 0xF8
	218	#define LOWPAN_NHC_UDP_ID 0xF0
	219	#define LOWPAN_NHC_UDP_CHECKSUMC 0x04
	220	#define LOWPAN_NHC_UDP_CHECKSUMI 0x00
	221
3bd5b958	222	#define LOWPAN_NHC_UDP_4BIT_PORT 0xF0B0
	223	#define LOWPAN_NHC_UDP_4BIT_MASK 0xFFF0
	224	#define LOWPAN_NHC_UDP_8BIT_PORT 0xF000
	225	#define LOWPAN_NHC_UDP_8BIT_MASK 0xFF00
	226
44331fe2 AS	227	/* values for port compression, _with checksum_ ie bit 5 set to 0 */
	228	#define LOWPAN_NHC_UDP_CS_P_00 0xF0 /* all inline */
	229	#define LOWPAN_NHC_UDP_CS_P_01 0xF1 /* source 16bit inline,
	230	dest = 0xF0 + 8 bit inline */
	231	#define LOWPAN_NHC_UDP_CS_P_10 0xF2 /* source = 0xF0 + 8bit inline,
	232	dest = 16 bit inline */
	233	#define LOWPAN_NHC_UDP_CS_P_11 0xF3 /* source & dest = 0xF0B + 4bit inline */
573701ce	234	#define LOWPAN_NHC_UDP_CS_C 0x04 /* checksum elided */
44331fe2	235
841a5ec7 AA	236	#ifdef DEBUG
	237	/* print data in line */
	238	static inline void raw_dump_inline(const char caller, char msg,
	239	unsigned char *buf, int len)
	240	{
	241	if (msg)
	242	pr_debug("%s():%s: ", caller, msg);
	243
	244	print_hex_dump_debug("", DUMP_PREFIX_NONE, 16, 1, buf, len, false);
	245	}
	246
	247	/* print data in a table format:
	248	*
	249	* addr: xx xx xx xx xx xx
	250	* addr: xx xx xx xx xx xx
	251	* ...
	252	*/
	253	static inline void raw_dump_table(const char caller, char msg,
	254	unsigned char *buf, int len)
	255	{
	256	if (msg)
	257	pr_debug("%s():%s:\n", caller, msg);
	258
	259	print_hex_dump_debug("\t", DUMP_PREFIX_OFFSET, 16, 1, buf, len, false);
	260	}
	261	#else
	262	static inline void raw_dump_table(const char caller, char msg,
	263	unsigned char *buf, int len) { }
	264	static inline void raw_dump_inline(const char caller, char msg,
	265	unsigned char *buf, int len) { }
	266	#endif
	267
8df8c56a JR	268	static inline int lowpan_fetch_skb_u8(struct sk_buff skb, u8 val)
	269	{
	270	if (unlikely(!pskb_may_pull(skb, 1)))
	271	return -EINVAL;
	272
	273	*val = skb->data[0];
	274	skb_pull(skb, 1);
	275
	276	return 0;
	277	}
	278
	279	static inline int lowpan_fetch_skb_u16(struct sk_buff skb, u16 val)
	280	{
	281	if (unlikely(!pskb_may_pull(skb, 2)))
	282	return -EINVAL;
	283
	284	*val = (skb->data[0] << 8) \| skb->data[1];
	285	skb_pull(skb, 2);
	286
	287	return 0;
	288	}
	289
4666669f AA	290	static inline bool lowpan_fetch_skb(struct sk_buff *skb,
	291	void *data, const unsigned int len)
	292	{
	293	if (unlikely(!pskb_may_pull(skb, len)))
	294	return true;
	295
	296	skb_copy_from_linear_data(skb, data, len);
	297	skb_pull(skb, len);
	298
	299	return false;
	300	}
	301
3109f2e2 AA	302	static inline void lowpan_push_hc_data(u8 *hc_ptr, const void data,
	303	const size_t len)
	304	{
	305	memcpy(*hc_ptr, data, len);
	306	*hc_ptr += len;
	307	}
	308
349aa7bc AA	309	static inline u8 lowpan_addr_mode_size(const u8 addr_mode)
	310	{
	311	static const u8 addr_sizes[] = {
	312	[LOWPAN_IPHC_ADDR_00] = 16,
	313	[LOWPAN_IPHC_ADDR_01] = 8,
	314	[LOWPAN_IPHC_ADDR_02] = 2,
	315	[LOWPAN_IPHC_ADDR_03] = 0,
	316	};
	317	return addr_sizes[addr_mode];
	318	}
	319
	320	static inline u8 lowpan_next_hdr_size(const u8 h_enc, u16 *uncomp_header)
	321	{
	322	u8 ret = 1;
	323
	324	if ((h_enc & LOWPAN_NHC_UDP_MASK) == LOWPAN_NHC_UDP_ID) {
	325	*uncomp_header += sizeof(struct udphdr);
	326
	327	switch (h_enc & LOWPAN_NHC_UDP_CS_P_11) {
	328	case LOWPAN_NHC_UDP_CS_P_00:
	329	ret += 4;
	330	break;
	331	case LOWPAN_NHC_UDP_CS_P_01:
	332	case LOWPAN_NHC_UDP_CS_P_10:
	333	ret += 3;
	334	break;
	335	case LOWPAN_NHC_UDP_CS_P_11:
	336	ret++;
	337	break;
	338	default:
	339	break;
	340	}
	341
	342	if (!(h_enc & LOWPAN_NHC_UDP_CS_C))
	343	ret += 2;
	344	}
	345
	346	return ret;
	347	}
	348
	349	/**
	350	* lowpan_uncompress_size - returns skb->len size with uncompressed header
	351	* @skb: sk_buff with 6lowpan header inside
	352	* @datagram_offset: optional to get the datagram_offset value
	353	*
	354	* Returns the skb->len with uncompressed header
	355	*/
	356	static inline u16
	357	lowpan_uncompress_size(const struct sk_buff skb, u16 dgram_offset)
	358	{
	359	u16 ret = 2, uncomp_header = sizeof(struct ipv6hdr);
	360	u8 iphc0, iphc1, h_enc;
	361
	362	iphc0 = skb_network_header(skb)[0];
	363	iphc1 = skb_network_header(skb)[1];
	364
	365	switch ((iphc0 & LOWPAN_IPHC_TF) >> 3) {
	366	case 0:
	367	ret += 4;
	368	break;
	369	case 1:
	370	ret += 3;
	371	break;
	372	case 2:
373	ret++;
374	break;
375	default:
376	break;
377	}
378
379	if (!(iphc0 & LOWPAN_IPHC_NH_C))
380	ret++;
381
382	if (!(iphc0 & 0x03))
383	ret++;
384
385	ret += lowpan_addr_mode_size((iphc1 & LOWPAN_IPHC_SAM) >>
386	LOWPAN_IPHC_SAM_BIT);
387
388	if (iphc1 & LOWPAN_IPHC_M) {
389	switch ((iphc1 & LOWPAN_IPHC_DAM_11) >>
390	LOWPAN_IPHC_DAM_BIT) {
391	case LOWPAN_IPHC_DAM_00:
392	ret += 16;
393	break;
394	case LOWPAN_IPHC_DAM_01:
395	ret += 6;
396	break;
397	case LOWPAN_IPHC_DAM_10:
398	ret += 4;
399	break;
400	case LOWPAN_IPHC_DAM_11:
401	ret++;
402	break;
403	default:
404	break;
405	}
406	} else {
407	ret += lowpan_addr_mode_size((iphc1 & LOWPAN_IPHC_DAM_11) >>
408	LOWPAN_IPHC_DAM_BIT);
409	}
410
411	if (iphc0 & LOWPAN_IPHC_NH_C) {
412	h_enc = skb_network_header(skb)[ret];
413	ret += lowpan_next_hdr_size(h_enc, &uncomp_header);
414	}
415
416	if (dgram_offset)
417	*dgram_offset = uncomp_header;
418
419	return skb->len + uncomp_header - ret;
420	}
421
8df8c56a JR	422	typedef int (skb_delivery_cb)(struct sk_buff skb, struct net_device *dev);
	423
	424	int lowpan_process_data(struct sk_buff skb, struct net_device dev,
	425	const u8 *saddr, const u8 saddr_type, const u8 saddr_len,
	426	const u8 *daddr, const u8 daddr_type, const u8 daddr_len,
	427	u8 iphc0, u8 iphc1, skb_delivery_cb skb_deliver);
	428	int lowpan_header_compress(struct sk_buff skb, struct net_device dev,
	429	unsigned short type, const void *_daddr,
	430	const void *_saddr, unsigned int len);
	431
44331fe2	432	#endif /* __6LOWPAN_H__ */