The friendly Operating System for the Internet of Things
sys/include/net/ieee802154.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015-16 Freie Universit├Ąt Berlin
3  *
4  * This file is subject to the terms and conditions of the GNU Lesser
5  * General Public License v2.1. See the file LICENSE in the top level
6  * directory for more details.
7  */
8 
21 #ifndef IEEE802154_H
22 #define IEEE802154_H
23 
24 #include <stdint.h>
25 #include <stdlib.h>
26 
27 #include "byteorder.h"
28 #include "net/eui64.h"
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
38 #define IEEE802154_SHORT_ADDRESS_LEN (2U)
39 #define IEEE802154_LONG_ADDRESS_LEN (8U)
48 #define IEEE802154_MAX_HDR_LEN (23U)
49 #define IEEE802154_FCF_LEN (2U)
50 #define IEEE802154_FCS_LEN (2U)
51 
52 #define IEEE802154_FCF_TYPE_MASK (0x07)
53 #define IEEE802154_FCF_TYPE_BEACON (0x00)
54 #define IEEE802154_FCF_TYPE_DATA (0x01)
55 #define IEEE802154_FCF_TYPE_ACK (0x02)
56 #define IEEE802154_FCF_TYPE_MACCMD (0x03)
57 
58 #define IEEE802154_FCF_SECURITY_EN (0x08)
59 #define IEEE802154_FCF_FRAME_PEND (0x10)
60 #define IEEE802154_FCF_ACK_REQ (0x20)
61 #define IEEE802154_FCF_PAN_COMP (0x40)
63 #define IEEE802154_FCF_DST_ADDR_MASK (0x0c)
64 #define IEEE802154_FCF_DST_ADDR_VOID (0x00)
65 #define IEEE802154_FCF_DST_ADDR_RESV (0x04)
66 #define IEEE802154_FCF_DST_ADDR_SHORT (0x08)
67 #define IEEE802154_FCF_DST_ADDR_LONG (0x0c)
69 #define IEEE802154_FCF_VERS_MASK (0x30)
70 #define IEEE802154_FCF_VERS_V0 (0x00)
71 #define IEEE802154_FCF_VERS_V1 (0x10)
72 
73 #define IEEE802154_FCF_SRC_ADDR_MASK (0xc0)
74 #define IEEE802154_FCF_SRC_ADDR_VOID (0x00)
75 #define IEEE802154_FCF_SRC_ADDR_RESV (0x40)
76 #define IEEE802154_FCF_SRC_ADDR_SHORT (0x80)
77 #define IEEE802154_FCF_SRC_ADDR_LONG (0xc0)
84 #define IEEE802154_CHANNEL_MIN_SUBGHZ (0U)
85 #define IEEE802154_CHANNEL_MAX_SUBGHZ (10U)
86 #define IEEE802154_CHANNEL_MIN (11U)
87 #define IEEE802154_CHANNEL_MAX (26U)
90 #define IEEE802154_FRAME_LEN_MAX (127U)
99 #define IEEE802154_ADDR_BCAST { 0xff, 0xff }
100 
104 #define IEEE802154_ADDR_BCAST_LEN (IEEE802154_SHORT_ADDRESS_LEN)
105 
117 #ifndef IEEE802154_DEFAULT_SUBGHZ_CHANNEL
118 #define IEEE802154_DEFAULT_SUBGHZ_CHANNEL (5U)
119 #endif
120 
121 #ifndef IEEE802154_DEFAULT_CHANNEL
122 #define IEEE802154_DEFAULT_CHANNEL (26U)
123 #endif
124 
125 #ifndef IEEE802154_DEFAULT_PANID
126 #define IEEE802154_DEFAULT_PANID (0x0023U)
127 #endif
128 
129 #ifndef IEEE802154_DEFAULT_TXPOWER
130 #define IEEE802154_DEFAULT_TXPOWER (0) /* in dBm */
131 #endif
132 
177 size_t ieee802154_set_frame_hdr(uint8_t *buf, const uint8_t *src, size_t src_len,
178  const uint8_t *dst, size_t dst_len,
179  le_uint16_t src_pan, le_uint16_t dst_pan,
180  uint8_t flags, uint8_t seq);
181 
192 size_t ieee802154_get_frame_hdr_len(const uint8_t *mhr);
193 
206 int ieee802154_get_src(const uint8_t *mhr, uint8_t *src, le_uint16_t *src_pan);
207 
220 int ieee802154_get_dst(const uint8_t *mhr, uint8_t *dst, le_uint16_t *dst_pan);
221 
231 static inline uint8_t ieee802154_get_seq(const uint8_t *mhr)
232 {
233  return mhr[2];
234 }
235 
255 static inline eui64_t *ieee802154_get_iid(eui64_t *eui64, const uint8_t *addr,
256  size_t addr_len)
257 {
258  int i = 0;
259 
260  eui64->uint8[0] = eui64->uint8[1] = 0;
261 
262  switch (addr_len) {
263  case 8:
264  eui64->uint8[0] = addr[i++] ^ 0x02;
265  eui64->uint8[1] = addr[i++];
266  eui64->uint8[2] = addr[i++];
267  eui64->uint8[3] = addr[i++];
268  eui64->uint8[4] = addr[i++];
269  eui64->uint8[5] = addr[i++];
270  eui64->uint8[6] = addr[i++];
271  eui64->uint8[7] = addr[i++];
272  break;
273 
274  case 4:
275  eui64->uint8[0] = addr[i++] ^ 0x02;
276  eui64->uint8[1] = addr[i++];
277 
278  case 2:
279  eui64->uint8[2] = 0;
280  eui64->uint8[3] = 0xff;
281  eui64->uint8[4] = 0xfe;
282  eui64->uint8[5] = 0;
283  eui64->uint8[6] = addr[i++];
284  eui64->uint8[7] = addr[i++];
285  break;
286 
287  default:
288  return NULL;
289  }
290 
291  return eui64;
292 }
293 
294 #ifdef __cplusplus
295 }
296 #endif
297 
298 #endif /* IEEE802154_H */
299 
EUI-64 data type definition.
static uint8_t ieee802154_get_seq(const uint8_t *mhr)
Gets sequence number from MAC header.
int ieee802154_get_dst(const uint8_t *mhr, uint8_t *dst, le_uint16_t *dst_pan)
Gets destination address from MAC header.
uint8_t uint8[8]
split into 8 8-bit words.
Definition: eui64.h:39
static eui64_t * ieee802154_get_iid(eui64_t *eui64, const uint8_t *addr, size_t addr_len)
Generates an IPv6 interface identifier from an IEEE 802.15.4 address.
int ieee802154_get_src(const uint8_t *mhr, uint8_t *src, le_uint16_t *src_pan)
Gets source address from MAC header.
A 16 bit integer in little endian.
Definition: byteorder.h:40
const uint8_t ieee802154_addr_bcast[IEEE802154_ADDR_BCAST_LEN]
Broadcast address.
Functions to work with different byte orders.
Data type to represent an EUI-64.
Definition: eui64.h:37
stdlib.h wrapper for MSP430
size_t ieee802154_set_frame_hdr(uint8_t *buf, const uint8_t *src, size_t src_len, const uint8_t *dst, size_t dst_len, le_uint16_t src_pan, le_uint16_t dst_pan, uint8_t flags, uint8_t seq)
Initializes an IEEE 802.15.4 MAC frame header in buf.
size_t ieee802154_get_frame_hdr_len(const uint8_t *mhr)
Get length of MAC header.
#define IEEE802154_ADDR_BCAST_LEN
Length in byte of IEEE802154_ADDR_BCAST.