ieee802154.h

Go to the documentation of this file.

/*
 * Copyright (C) 2016-2019 Freie Universität Berlin
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#pragma once

 
#include "net/eui_provider.h"
#include "net/ieee802154.h"
#if IS_USED(MODULE_IEEE802154_SECURITY)
#include "net/ieee802154_security.h"
#endif
#include "net/gnrc/nettype.h"
#include "net/netopt.h"
#include "net/netdev.h"
 
#ifdef __cplusplus
extern "C" {
#endif

 
#define NETDEV_IEEE802154_SEND_MASK         (0x0028)    
#define NETDEV_IEEE802154_RAW               (0x0002)    
#define NETDEV_IEEE802154_SRC_MODE_LONG     (0x0004)
#define NETDEV_IEEE802154_SECURITY_EN       (IEEE802154_FCF_SECURITY_EN)

#define NETDEV_IEEE802154_ACK_REQ           (IEEE802154_FCF_ACK_REQ)

#define NETDEV_IEEE802154_FRAME_PEND        (IEEE802154_FCF_FRAME_PEND)

#define NETDEV_RX_IEEE802154_INFO_FLAG_TIMESTAMP       (0x01)  

typedef enum {
    NETDEV_IEEE802154_CCA_MODE_1 = 1,   
    NETDEV_IEEE802154_CCA_MODE_2,       
    NETDEV_IEEE802154_CCA_MODE_3,       
    NETDEV_IEEE802154_CCA_MODE_4,       
    NETDEV_IEEE802154_CCA_MODE_5,       
    NETDEV_IEEE802154_CCA_MODE_6,       
} netdev_ieee802154_cca_mode_t;

typedef struct {
    netdev_t netdev;                        
#ifdef MODULE_GNRC
    gnrc_nettype_t proto;                   
#endif

    uint16_t pan;

    uint8_t short_addr[IEEE802154_SHORT_ADDRESS_LEN];

    uint8_t long_addr[IEEE802154_LONG_ADDRESS_LEN];
    uint8_t seq;                            
    uint8_t chan;                           
    uint8_t page;                           
    uint16_t flags;                         
    int16_t txpower;                        
#if IS_USED(MODULE_IEEE802154_SECURITY) || defined(DOXYGEN)
    ieee802154_sec_context_t sec_ctx;       
#endif
} netdev_ieee802154_t;

typedef struct netdev_ieee802154_rx_info {
    int16_t rssi;           
    uint8_t lqi;            
    uint8_t flags;          
#if IS_USED(MODULE_NETDEV_IEEE802154_RX_TIMESTAMP)
    uint64_t timestamp;     
#endif
} netdev_ieee802154_rx_info_t;

static inline void netdev_ieee802154_rx_info_set_timestamp(
        netdev_ieee802154_rx_info_t *dest,
        uint64_t timestamp)
{
    (void)dest;
    (void)timestamp;
#if IS_USED(MODULE_NETDEV_IEEE802154_RX_TIMESTAMP)
    dest->timestamp = timestamp;
    dest->flags |= NETDEV_RX_IEEE802154_INFO_FLAG_TIMESTAMP;
#endif
}

static inline int netdev_ieee802154_rx_info_get_timestamp(
        const netdev_ieee802154_rx_info_t *info,
        uint64_t *dest)
{
    (void)info;
    (void)dest;
#if IS_USED(MODULE_NETDEV_IEEE802154_RX_TIMESTAMP)
    if (info->flags & NETDEV_RX_IEEE802154_INFO_FLAG_TIMESTAMP) {
        *dest = info->timestamp;
        return 0;
    }
#endif
 
    return -1;
}

void netdev_ieee802154_reset(netdev_ieee802154_t *dev);

int netdev_ieee802154_get(netdev_ieee802154_t *dev, netopt_t opt, void *value,
                          size_t max_len);

int netdev_ieee802154_set(netdev_ieee802154_t *dev, netopt_t opt, const void *value,
                          size_t value_len);

int netdev_ieee802154_dst_filter(netdev_ieee802154_t *dev, const uint8_t *mhr);

static inline void netdev_ieee802154_setup(netdev_ieee802154_t *dev)
{
    /* generate EUI-64 and short address */
    netdev_eui64_get(&dev->netdev, (eui64_t *)&dev->long_addr);
    eui_short_from_eui64((eui64_t *)&dev->long_addr,
                         (network_uint16_t *)&dev->short_addr);
}
 
#ifdef __cplusplus
}
#endif