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 /* need to know address length to manipulate with it */ 57 #define IEEE802154_ALEN 8 58 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 64 /* 65 * ipv6 address based on mac 66 * second bit-flip (Universe/Local) is done according RFC2464 67 */ 68 #define is_addr_mac_addr_based(a, m) \ 69 ((((a)->s6_addr[8]) == (((m)[0]) ^ 0x02)) && \ 70 (((a)->s6_addr[9]) == (m)[1]) && \ 71 (((a)->s6_addr[10]) == (m)[2]) && \ 72 (((a)->s6_addr[11]) == (m)[3]) && \ 73 (((a)->s6_addr[12]) == (m)[4]) && \ 74 (((a)->s6_addr[13]) == (m)[5]) && \ 75 (((a)->s6_addr[14]) == (m)[6]) && \ 76 (((a)->s6_addr[15]) == (m)[7])) 77 78 /* ipv6 address is unspecified */ 79 #define is_addr_unspecified(a) \ 80 ((((a)->s6_addr32[0]) == 0) && \ 81 (((a)->s6_addr32[1]) == 0) && \ 82 (((a)->s6_addr32[2]) == 0) && \ 83 (((a)->s6_addr32[3]) == 0)) 84 85 /* compare ipv6 addresses prefixes */ 86 #define ipaddr_prefixcmp(addr1, addr2, length) \ 87 (memcmp(addr1, addr2, length >> 3) == 0) 88 89 /* local link, i.e. FE80::/10 */ 90 #define is_addr_link_local(a) (((a)->s6_addr16[0]) == 0x80FE) 91 92 /* 93 * check whether we can compress the IID to 16 bits, 94 * it's possible for unicast adresses with first 49 bits are zero only. 95 */ 96 #define lowpan_is_iid_16_bit_compressable(a) \ 97 ((((a)->s6_addr16[4]) == 0) && \ 98 (((a)->s6_addr16[5]) == 0) && \ 99 (((a)->s6_addr16[6]) == 0) && \ 100 ((((a)->s6_addr[14]) & 0x80) == 0)) 101 102 /* multicast address */ 103 #define is_addr_mcast(a) (((a)->s6_addr[0]) == 0xFF) 104 105 /* check whether the 112-bit gid of the multicast address is mappable to: */ 106 107 /* 9 bits, for FF02::1 (all nodes) and FF02::2 (all routers) addresses only. */ 108 #define lowpan_is_mcast_addr_compressable(a) \ 109 ((((a)->s6_addr16[1]) == 0) && \ 110 (((a)->s6_addr16[2]) == 0) && \ 111 (((a)->s6_addr16[3]) == 0) && \ 112 (((a)->s6_addr16[4]) == 0) && \ 113 (((a)->s6_addr16[5]) == 0) && \ 114 (((a)->s6_addr16[6]) == 0) && \ 115 (((a)->s6_addr[14]) == 0) && \ 116 ((((a)->s6_addr[15]) == 1) || (((a)->s6_addr[15]) == 2))) 117 118 /* 48 bits, FFXX::00XX:XXXX:XXXX */ 119 #define lowpan_is_mcast_addr_compressable48(a) \ 120 ((((a)->s6_addr16[1]) == 0) && \ 121 (((a)->s6_addr16[2]) == 0) && \ 122 (((a)->s6_addr16[3]) == 0) && \ 123 (((a)->s6_addr16[4]) == 0) && \ 124 (((a)->s6_addr[10]) == 0)) 125 126 /* 32 bits, FFXX::00XX:XXXX */ 127 #define lowpan_is_mcast_addr_compressable32(a) \ 128 ((((a)->s6_addr16[1]) == 0) && \ 129 (((a)->s6_addr16[2]) == 0) && \ 130 (((a)->s6_addr16[3]) == 0) && \ 131 (((a)->s6_addr16[4]) == 0) && \ 132 (((a)->s6_addr16[5]) == 0) && \ 133 (((a)->s6_addr[12]) == 0)) 134 135 /* 8 bits, FF02::00XX */ 136 #define lowpan_is_mcast_addr_compressable8(a) \ 137 ((((a)->s6_addr[1]) == 2) && \ 138 (((a)->s6_addr16[1]) == 0) && \ 139 (((a)->s6_addr16[2]) == 0) && \ 140 (((a)->s6_addr16[3]) == 0) && \ 141 (((a)->s6_addr16[4]) == 0) && \ 142 (((a)->s6_addr16[5]) == 0) && \ 143 (((a)->s6_addr16[6]) == 0) && \ 144 (((a)->s6_addr[14]) == 0)) 145 146 #define lowpan_is_addr_broadcast(a) \ 147 ((((a)[0]) == 0xFF) && \ 148 (((a)[1]) == 0xFF) && \ 149 (((a)[2]) == 0xFF) && \ 150 (((a)[3]) == 0xFF) && \ 151 (((a)[4]) == 0xFF) && \ 152 (((a)[5]) == 0xFF) && \ 153 (((a)[6]) == 0xFF) && \ 154 (((a)[7]) == 0xFF)) 155 156 #define LOWPAN_DISPATCH_IPV6 0x41 /* 01000001 = 65 */ 157 #define LOWPAN_DISPATCH_HC1 0x42 /* 01000010 = 66 */ 158 #define LOWPAN_DISPATCH_IPHC 0x60 /* 011xxxxx = ... */ 159 #define LOWPAN_DISPATCH_FRAG1 0xc0 /* 11000xxx */ 160 #define LOWPAN_DISPATCH_FRAGN 0xe0 /* 11100xxx */ 161 162 #define LOWPAN_DISPATCH_MASK 0xf8 /* 11111000 */ 163 164 #define LOWPAN_FRAG_TIMEOUT (HZ * 60) /* time-out 60 sec */ 165 166 #define LOWPAN_FRAG1_HEAD_SIZE 0x4 167 #define LOWPAN_FRAGN_HEAD_SIZE 0x5 168 169 /* 170 * According IEEE802.15.4 standard: 171 * - MTU is 127 octets 172 * - maximum MHR size is 37 octets 173 * - MFR size is 2 octets 174 * 175 * so minimal payload size that we may guarantee is: 176 * MTU - MHR - MFR = 88 octets 177 */ 178 #define LOWPAN_FRAG_SIZE 88 179 180 /* 181 * Values of fields within the IPHC encoding first byte 182 * (C stands for compressed and I for inline) 183 */ 184 #define LOWPAN_IPHC_TF 0x18 185 186 #define LOWPAN_IPHC_FL_C 0x10 187 #define LOWPAN_IPHC_TC_C 0x08 188 #define LOWPAN_IPHC_NH_C 0x04 189 #define LOWPAN_IPHC_TTL_1 0x01 190 #define LOWPAN_IPHC_TTL_64 0x02 191 #define LOWPAN_IPHC_TTL_255 0x03 192 #define LOWPAN_IPHC_TTL_I 0x00 193 194 195 /* Values of fields within the IPHC encoding second byte */ 196 #define LOWPAN_IPHC_CID 0x80 197 198 #define LOWPAN_IPHC_SAC 0x40 199 #define LOWPAN_IPHC_SAM_00 0x00 200 #define LOWPAN_IPHC_SAM_01 0x10 201 #define LOWPAN_IPHC_SAM_10 0x20 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 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 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 */ 234 235 #endif /* __6LOWPAN_H__ */ 236