ieee802154.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015-2019 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 NET_IEEE802154_H
22 #define NET_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 
37 #define IEEE802154_SFD (0xa7)
38 
43 #define IEEE802154_SHORT_ADDRESS_LEN (2U)
44 #define IEEE802154_LONG_ADDRESS_LEN (8U)
53 #define IEEE802154_MAX_HDR_LEN (23U)
54 #define IEEE802154_MIN_FRAME_LEN (IEEE802154_FCF_LEN + sizeof(uint8_t))
55 
56 #define IEEE802154_FCF_LEN (2U)
57 #define IEEE802154_FCS_LEN (2U)
58 
59 #define IEEE802154_FCF_TYPE_MASK (0x07)
60 #define IEEE802154_FCF_TYPE_BEACON (0x00)
61 #define IEEE802154_FCF_TYPE_DATA (0x01)
62 #define IEEE802154_FCF_TYPE_ACK (0x02)
63 #define IEEE802154_FCF_TYPE_MACCMD (0x03)
64 
65 #define IEEE802154_FCF_SECURITY_EN (0x08)
66 #define IEEE802154_FCF_FRAME_PEND (0x10)
67 #define IEEE802154_FCF_ACK_REQ (0x20)
68 #define IEEE802154_FCF_PAN_COMP (0x40)
70 #define IEEE802154_FCF_DST_ADDR_MASK (0x0c)
71 #define IEEE802154_FCF_DST_ADDR_VOID (0x00)
72 #define IEEE802154_FCF_DST_ADDR_RESV (0x04)
73 #define IEEE802154_FCF_DST_ADDR_SHORT (0x08)
74 #define IEEE802154_FCF_DST_ADDR_LONG (0x0c)
76 #define IEEE802154_FCF_VERS_MASK (0x30)
77 #define IEEE802154_FCF_VERS_V0 (0x00)
78 #define IEEE802154_FCF_VERS_V1 (0x10)
79 
80 #define IEEE802154_FCF_SRC_ADDR_MASK (0xc0)
81 #define IEEE802154_FCF_SRC_ADDR_VOID (0x00)
82 #define IEEE802154_FCF_SRC_ADDR_RESV (0x40)
83 #define IEEE802154_FCF_SRC_ADDR_SHORT (0x80)
84 #define IEEE802154_FCF_SRC_ADDR_LONG (0xc0)
91 #define IEEE802154_CHANNEL_MIN_SUBGHZ (0U)
92 #define IEEE802154_CHANNEL_MAX_SUBGHZ (10U)
93 #define IEEE802154_CHANNEL_MIN (11U)
94 #define IEEE802154_CHANNEL_MAX (26U)
97 #define IEEE802154_FRAME_LEN_MAX (127U)
106 #define IEEE802154_ADDR_BCAST { 0xff, 0xff }
107 
111 #define IEEE802154_ADDR_BCAST_LEN (IEEE802154_SHORT_ADDRESS_LEN)
112 
127 #ifndef IEEE802154_DEFAULT_SUBGHZ_CHANNEL
128 #define IEEE802154_DEFAULT_SUBGHZ_CHANNEL (5U)
129 #endif
130 
134 #ifndef IEEE802154_DEFAULT_CHANNEL
135 #define IEEE802154_DEFAULT_CHANNEL (26U)
136 #endif
137 
141 #ifndef IEEE802154_DEFAULT_SUBGHZ_PAGE
142 #define IEEE802154_DEFAULT_SUBGHZ_PAGE (2U)
143 #endif
144 
148 #ifndef IEEE802154_DEFAULT_PANID
149 #define IEEE802154_DEFAULT_PANID (0x0023U)
150 #endif
151 
155 #ifndef IEEE802154_PANID_BCAST
156 #define IEEE802154_PANID_BCAST { 0xff, 0xff }
157 #endif
158 
162 #ifndef IEEE802154_DEFAULT_TXPOWER
163 #define IEEE802154_DEFAULT_TXPOWER (0)
164 #endif
165 
210 size_t ieee802154_set_frame_hdr(uint8_t *buf, const uint8_t *src, size_t src_len,
211  const uint8_t *dst, size_t dst_len,
212  le_uint16_t src_pan, le_uint16_t dst_pan,
213  uint8_t flags, uint8_t seq);
214 
225 size_t ieee802154_get_frame_hdr_len(const uint8_t *mhr);
226 
239 int ieee802154_get_src(const uint8_t *mhr, uint8_t *src, le_uint16_t *src_pan);
240 
253 int ieee802154_get_dst(const uint8_t *mhr, uint8_t *dst, le_uint16_t *dst_pan);
254 
264 static inline uint8_t ieee802154_get_seq(const uint8_t *mhr)
265 {
266  return mhr[2];
267 }
268 
288 static inline eui64_t *ieee802154_get_iid(eui64_t *eui64, const uint8_t *addr,
289  size_t addr_len)
290 {
291  int i = 0;
292 
293  eui64->uint8[0] = eui64->uint8[1] = 0;
294 
295  switch (addr_len) {
296  case 8:
297  eui64->uint8[0] = addr[i++] ^ 0x02;
298  eui64->uint8[1] = addr[i++];
299  eui64->uint8[2] = addr[i++];
300  eui64->uint8[3] = addr[i++];
301  eui64->uint8[4] = addr[i++];
302  eui64->uint8[5] = addr[i++];
303  eui64->uint8[6] = addr[i++];
304  eui64->uint8[7] = addr[i++];
305  break;
306 
307  case 4:
308  eui64->uint8[0] = addr[i++] ^ 0x02;
309  eui64->uint8[1] = addr[i++];
310 
311  /* Falls through. */
312  case 2:
313  eui64->uint8[2] = 0;
314  eui64->uint8[3] = 0xff;
315  eui64->uint8[4] = 0xfe;
316  eui64->uint8[5] = 0;
317  eui64->uint8[6] = addr[i++];
318  eui64->uint8[7] = addr[i++];
319  break;
320 
321  default:
322  return NULL;
323  }
324 
325  return eui64;
326 }
327 
328 #ifdef __cplusplus
329 }
330 #endif
331 
332 #endif /* NET_IEEE802154_H */
333 
EUI-64 data type definition.
static uint8_t ieee802154_get_seq(const uint8_t *mhr)
Gets sequence number from MAC header.
Definition: ieee802154.h:264
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.
Definition: ieee802154.h:288
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.
Definition: ieee802154.h:111