ieee802154.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2015-2019 Freie Universität Berlin
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdint.h>
#include <stdlib.h>
 
#include "byteorder.h"
#include "modules.h"
#include "net/eui64.h"
#include "time_units.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define IEEE802154_SFD                      (0xa7)

#define IEEE802154_SHORT_ADDRESS_LEN        (2U)    
#define IEEE802154_LONG_ADDRESS_LEN         (8U)    

#define IEEE802154_MAX_HDR_LEN              (23U)
#define IEEE802154_MIN_FRAME_LEN            (IEEE802154_FCF_LEN + sizeof(uint8_t))
 
#define IEEE802154_FCF_LEN                  (2U)
#define IEEE802154_FCS_LEN                  (2U)
 
#define IEEE802154_FCF_TYPE_MASK            (0x07)
#define IEEE802154_FCF_TYPE_BEACON          (0x00)
#define IEEE802154_FCF_TYPE_DATA            (0x01)
#define IEEE802154_FCF_TYPE_ACK             (0x02)
#define IEEE802154_FCF_TYPE_MACCMD          (0x03)
 
#define IEEE802154_FCF_SECURITY_EN          (0x08)  
#define IEEE802154_FCF_FRAME_PEND           (0x10)  
#define IEEE802154_FCF_ACK_REQ              (0x20)  
#define IEEE802154_FCF_PAN_COMP             (0x40)  
 
#define IEEE802154_FCF_DST_ADDR_MASK        (0x0c)
#define IEEE802154_FCF_DST_ADDR_VOID        (0x00)  
#define IEEE802154_FCF_DST_ADDR_RESV        (0x04)  
#define IEEE802154_FCF_DST_ADDR_SHORT       (0x08)  
#define IEEE802154_FCF_DST_ADDR_LONG        (0x0c)  
 
#define IEEE802154_FCF_VERS_MASK            (0x30)
#define IEEE802154_FCF_VERS_V0              (0x00)
#define IEEE802154_FCF_VERS_V1              (0x10)
 
#define IEEE802154_FCF_SRC_ADDR_MASK        (0xc0)
#define IEEE802154_FCF_SRC_ADDR_VOID        (0x00)  
#define IEEE802154_FCF_SRC_ADDR_RESV        (0x40)  
#define IEEE802154_FCF_SRC_ADDR_SHORT       (0x80)  
#define IEEE802154_FCF_SRC_ADDR_LONG        (0xc0)  

#define IEEE802154_CHANNEL_MIN_SUBGHZ   (0U)    
#define IEEE802154_CHANNEL_MAX_SUBGHZ   (10U)   
#define IEEE802154_CHANNEL_MIN          (11U)   
#define IEEE802154_CHANNEL_MAX          (26U)   
 
#define IEEE802154_FRAME_LEN_MAX        (127U)  
#define IEEE802154G_FRAME_LEN_MAX      (2047U)  
#define IEEE802154_ACK_FRAME_LEN          (5U)  

#define IEEE802154_LIFS_SYMS            (40U)

#define IEEE802154_SIFS_SYMS            (12U)

#define IEEE802154_SIFS_MAX_FRAME_SIZE  (18U)

#define IEEE802154_ACK_TIMEOUT_SYMS     (54)

#define IEEE802154_MR_OFDM_SYMBOL_TIME_US   (120)

#define IEEE802154_MR_FSK_SYMBOL_TIME_US    (20)

#define IEEE802154_RADIO_RSSI_OFFSET        (-174)
 
#define IEEE802154_PHY_MR_FSK_PHR_LEN      (2)  
#define IEEE802154_PHY_MR_FSK_2FSK_SFD_LEN (2)  

#define IEEE802154_PHY_MR_FSK_2FSK_CODED_SFD_0      (0x6F4E)
#define IEEE802154_PHY_MR_FSK_2FSK_CODED_SFD_1      (0x632D)
#define IEEE802154_PHY_MR_FSK_2FSK_UNCODED_SFD_0    (0x90E4)
#define IEEE802154_PHY_MR_FSK_2FSK_UNCODED_SFD_1    (0x7A0E)

#define IEEE802154G_ATURNAROUNDTIME_US          (1 * US_PER_MS)

#define IEEE802154_ATURNAROUNDTIME_IN_SYMBOLS   (12)

#define IEEE802154_SYMBOL_TIME_US               (16)

#define IEEE802154_CCA_DURATION_IN_SYMBOLS      (8)

typedef enum {
    IEEE802154_PHY_DISABLED,        
    IEEE802154_PHY_BPSK,            
    IEEE802154_PHY_ASK,             
    IEEE802154_PHY_OQPSK,           
    IEEE802154_PHY_MR_OQPSK,        
    IEEE802154_PHY_MR_OFDM,         
    IEEE802154_PHY_MR_FSK,          
 
    IEEE802154_PHY_NO_OP,           
} ieee802154_phy_mode_t;

typedef enum {
    IEEE802154_FEC_NONE,            
    IEEE802154_FEC_NRNSC,           
    IEEE802154_FEC_RSC              
} ieee802154_mr_fsk_fec_t;

typedef enum {
    IEEE802154_MR_FSK_SRATE_50K,    
    IEEE802154_MR_FSK_SRATE_100K,   
    IEEE802154_MR_FSK_SRATE_150K,   
    IEEE802154_MR_FSK_SRATE_200K,   
    IEEE802154_MR_FSK_SRATE_300K,   
    IEEE802154_MR_FSK_SRATE_400K,   
} ieee802154_mr_fsk_srate_t;

typedef enum {
    IEEE802154_MR_OQPSK_CHIPS_100,  
    IEEE802154_MR_OQPSK_CHIPS_200,  
    IEEE802154_MR_OQPSK_CHIPS_1000, 
    IEEE802154_MR_OQPSK_CHIPS_2000, 
} ieee802154_mr_oqpsk_chips_t;

static inline uint8_t ieee802154_mr_fsk_plen(ieee802154_mr_fsk_srate_t srate)
{
    switch (srate) {
    case IEEE802154_MR_FSK_SRATE_50K:
        return 2;
    case IEEE802154_MR_FSK_SRATE_100K:
        return 3;
    case IEEE802154_MR_FSK_SRATE_150K:
    case IEEE802154_MR_FSK_SRATE_200K:
    case IEEE802154_MR_FSK_SRATE_300K:
        return 8;
    case IEEE802154_MR_FSK_SRATE_400K:
        return 10;
    }
 
    return 0;
}

#define IEEE802154_ADDR_BCAST               { 0xff, 0xff }

#define IEEE802154_ADDR_BCAST_LEN           (IEEE802154_SHORT_ADDRESS_LEN)

extern const uint8_t ieee802154_addr_bcast[IEEE802154_ADDR_BCAST_LEN];

#if IS_ACTIVE(CONFIG_IEEE802154_DEFAULT_PHY_BPSK)
#define CONFIG_IEEE802154_DEFAULT_PHY_MODE          IEEE802154_PHY_BPSK
#elif IS_ACTIVE(CONFIG_IEEE802154_DEFAULT_PHY_ASK)
#define CONFIG_IEEE802154_DEFAULT_PHY_MODE          IEEE802154_PHY_ASK
#elif IS_ACTIVE(CONFIG_IEEE802154_DEFAULT_PHY_OQPSK)
#define CONFIG_IEEE802154_DEFAULT_PHY_MODE          IEEE802154_PHY_OQPSK
#elif IS_ACTIVE(CONFIG_IEEE802154_DEFAULT_PHY_MR_OQPSK)
#define CONFIG_IEEE802154_DEFAULT_PHY_MODE          IEEE802154_PHY_MR_OQPSK
#elif IS_ACTIVE(CONFIG_IEEE802154_DEFAULT_PHY_MR_OFDM)
#define CONFIG_IEEE802154_DEFAULT_PHY_MODE          IEEE802154_PHY_MR_OFDM
#elif IS_ACTIVE(CONFIG_IEEE802154_DEFAULT_PHY_MR_FSK)
#define CONFIG_IEEE802154_DEFAULT_PHY_MODE          IEEE802154_PHY_MR_FSK
#endif
 
#ifndef CONFIG_IEEE802154_DEFAULT_PHY_MODE
#define CONFIG_IEEE802154_DEFAULT_PHY_MODE          IEEE802154_PHY_OQPSK
#endif
#ifndef CONFIG_IEEE802154_DEFAULT_SUBGHZ_CHANNEL
#define CONFIG_IEEE802154_DEFAULT_SUBGHZ_CHANNEL   (5U)
#endif

#ifndef CONFIG_IEEE802154_DEFAULT_CHANNEL
#define CONFIG_IEEE802154_DEFAULT_CHANNEL          (26U)
#endif

#ifndef CONFIG_IEEE802154_MR_OQPSK_DEFAULT_CHIPS
#define CONFIG_IEEE802154_MR_OQPSK_DEFAULT_CHIPS    IEEE802154_MR_OQPSK_CHIPS_1000
#endif

#ifndef CONFIG_IEEE802154_MR_OQPSK_DEFAULT_RATE
#define CONFIG_IEEE802154_MR_OQPSK_DEFAULT_RATE     (2U)
#endif

#ifndef CONFIG_IEEE802154_MR_OFDM_DEFAULT_OPTION
#define CONFIG_IEEE802154_MR_OFDM_DEFAULT_OPTION    (2U)
#endif

#ifndef CONFIG_IEEE802154_MR_OFDM_DEFAULT_SCHEME
#define CONFIG_IEEE802154_MR_OFDM_DEFAULT_SCHEME    (2U)
#endif

#ifndef CONFIG_IEEE802154_MR_FSK_DEFAULT_SRATE
#define CONFIG_IEEE802154_MR_FSK_DEFAULT_SRATE      IEEE802154_MR_FSK_SRATE_200K
#endif

#ifndef CONFIG_IEEE802154_MR_FSK_DEFAULT_MOD_IDX
#define CONFIG_IEEE802154_MR_FSK_DEFAULT_MOD_IDX    (64U)
#endif

#ifndef CONFIG_IEEE802154_MR_FSK_DEFAULT_MOD_ORD
#define CONFIG_IEEE802154_MR_FSK_DEFAULT_MOD_ORD    (2U)
#endif

#ifndef CONFIG_IEEE802154_MR_FSK_DEFAULT_FEC
#define CONFIG_IEEE802154_MR_FSK_DEFAULT_FEC        IEEE802154_FEC_NONE
#endif

#ifndef CONFIG_IEEE802154_DEFAULT_PANID
#define CONFIG_IEEE802154_DEFAULT_PANID            (0x0023U)
#endif

#ifndef IEEE802154_PANID_BCAST
#define IEEE802154_PANID_BCAST              { 0xff, 0xff }
#endif

#ifndef CONFIG_IEEE802154_DEFAULT_TXPOWER
#define CONFIG_IEEE802154_DEFAULT_TXPOWER          (0)
#endif

#ifndef CONFIG_IEEE802154_DEFAULT_CSMA_CA_MIN_BE
#define CONFIG_IEEE802154_DEFAULT_CSMA_CA_MIN_BE   (3U)
#endif

#ifndef CONFIG_IEEE802154_DEFAULT_CSMA_CA_RETRIES
#define CONFIG_IEEE802154_DEFAULT_CSMA_CA_RETRIES  (4U)
#endif

#ifndef CONFIG_IEEE802154_DEFAULT_CSMA_CA_MAX_BE
#define CONFIG_IEEE802154_DEFAULT_CSMA_CA_MAX_BE   (5U)
#endif

#ifndef CONFIG_IEEE802154_CCA_THRESH_DEFAULT
#define CONFIG_IEEE802154_CCA_THRESH_DEFAULT       (-70)
#endif

#ifndef CONFIG_IEEE802154_DEFAULT_MAX_FRAME_RETRANS
#define CONFIG_IEEE802154_DEFAULT_MAX_FRAME_RETRANS     (4U)
#endif

#ifdef DOXYGEN
#define CONFIG_IEEE802154_AUTO_ACK_DISABLE 0
#endif

#ifndef CONFIG_IEEE802154_DEFAULT_ACK_REQ
#define CONFIG_IEEE802154_DEFAULT_ACK_REQ          1
#endif

#ifndef CONFIG_IEEE802154_DSME_CAP_REDUCTION
#define CONFIG_IEEE802154_DSME_CAP_REDUCTION             0
#endif

#ifndef CONFIG_IEEE802154_DSME_MAC_RESPONSE_WAIT_TIME
#define CONFIG_IEEE802154_DSME_MAC_RESPONSE_WAIT_TIME    (244U)
#endif

#ifndef CONFIG_IEEE802154_DSME_SCAN_DURATION
#define CONFIG_IEEE802154_DSME_SCAN_DURATION    (4U)
#endif

#ifndef CONFIG_IEEE802154_DSME_SUPERFRAME_ORDER
#define CONFIG_IEEE802154_DSME_SUPERFRAME_ORDER      (3U)
#endif

#ifndef CONFIG_IEEE802154_DSME_MULTISUPERFRAME_ORDER
#define CONFIG_IEEE802154_DSME_MULTISUPERFRAME_ORDER (3U)
#endif

#ifndef CONFIG_IEEE802154_DSME_BEACON_ORDER
#define CONFIG_IEEE802154_DSME_BEACON_ORDER          (3U)
#endif

#ifdef DOXYGEN
#define CONFIG_IEEE802154_DSME_STATIC_GTS            0
#endif

#ifndef CONFIG_IEEE802154_DSME_GTS_EXPIRATION
#define CONFIG_IEEE802154_DSME_GTS_EXPIRATION         (16U)
#endif

#ifndef CONFIG_IEEE802154_DSME_MIN_COORD_LQI
#define CONFIG_IEEE802154_DSME_MIN_COORD_LQI         (100U)
#endif

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

size_t ieee802154_get_frame_hdr_len(const uint8_t *mhr);

uint8_t ieee802154_get_src_len(const uint8_t *mhr);

const uint8_t *ieee802154_get_src_ptr(const uint8_t *mhr);

const uint8_t *ieee802154_get_src_pan_ptr(const uint8_t *mhr);

int ieee802154_get_src(const uint8_t *mhr, uint8_t *src, le_uint16_t *src_pan);

uint8_t ieee802154_get_dst_len(const uint8_t *mhr);

const uint8_t *ieee802154_get_dst_ptr(const uint8_t *mhr);

const uint8_t *ieee802154_get_dst_pan_ptr(const uint8_t *mhr);

int ieee802154_get_dst(const uint8_t *mhr, uint8_t *dst, le_uint16_t *dst_pan);

int ieee802154_dst_filter(const uint8_t *mhr, uint16_t pan,
                          network_uint16_t short_addr, const eui64_t *ext_addr);

static inline uint8_t ieee802154_get_seq(const uint8_t *mhr)
{
    return mhr[2];
}

static inline eui64_t *ieee802154_get_iid(eui64_t *eui64, const uint8_t *addr,
                                          size_t addr_len)
{
    int i = 0;
 
    eui64->uint8[0] = eui64->uint8[1] = 0;
 
    switch (addr_len) {
        case 8:
            eui64->uint8[0] = addr[i++] ^ 0x02;
            eui64->uint8[1] = addr[i++];
            eui64->uint8[2] = addr[i++];
            eui64->uint8[3] = addr[i++];
            eui64->uint8[4] = addr[i++];
            eui64->uint8[5] = addr[i++];
            eui64->uint8[6] = addr[i++];
            eui64->uint8[7] = addr[i++];
            break;
 
        case 4:
            eui64->uint8[0] = addr[i++] ^ 0x02;
            eui64->uint8[1] = addr[i++];
 
            /* Falls through. */
        case 2:
            eui64->uint8[2] = 0;
            eui64->uint8[3] = 0xff;
            eui64->uint8[4] = 0xfe;
            eui64->uint8[5] = 0;
            eui64->uint8[6] = addr[i++];
            eui64->uint8[7] = addr[i++];
            break;
 
        default:
            return NULL;
    }
 
    return eui64;
}

static inline int16_t ieee802154_rssi_to_dbm(uint8_t rssi)
{
    return rssi + IEEE802154_RADIO_RSSI_OFFSET;
}

static inline uint8_t ieee802154_dbm_to_rssi(int16_t dbm)
{
    const int min = IEEE802154_RADIO_RSSI_OFFSET;
    const int max = min + (UINT8_MAX - 1);
 
    int val = dbm <= min ? min : (dbm >= max ? max : dbm);
    return val - IEEE802154_RADIO_RSSI_OFFSET;
}
 
#ifdef __cplusplus
}
#endif