submac.h

/*
 * SPDX-FileCopyrightText: 2020 HAW Hamburg
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include "mutex.h"
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include "assert.h"
 
#include "net/ieee802154.h"
#include "net/ieee802154/radio.h"

typedef struct ieee802154_submac ieee802154_submac_t;

typedef struct {
    void (*rx_done)(ieee802154_submac_t *submac);
    void (*tx_done)(ieee802154_submac_t *submac, int status,
                    ieee802154_tx_info_t *info);
} ieee802154_submac_cb_t;

typedef enum {
    IEEE802154_FSM_EV_ENTRY,                
    IEEE802154_FSM_EV_EXIT,                 
    IEEE802154_FSM_EV_TX_DONE,              
    IEEE802154_FSM_EV_RX_DONE,              
    IEEE802154_FSM_EV_CRC_ERROR,            
    IEEE802154_FSM_EV_ACK_TIMEOUT,          
    IEEE802154_FSM_EV_REQUEST_TX,           
    IEEE802154_FSM_EV_REQUEST_SET_RX_ON,    
    IEEE802154_FSM_EV_REQUEST_SET_IDLE,     
    IEEE802154_FSM_EV_NUMOF,                
} ieee802154_fsm_ev_t;

typedef enum {
    IEEE802154_SUBMAC_FSM_RETURN_HANDLED,       
    IEEE802154_SUBMAC_FSM_RETURN_TRANSITION,    
    IEEE802154_SUBMAC_FSM_RETURN_IGNORED,       
} ieee802154_submac_fsm_return_t;

typedef ieee802154_submac_fsm_return_t (*ieee802154_fsm_state_cb_t)(ieee802154_submac_t *submac,
                                                                      ieee802154_fsm_ev_t ev);

typedef struct {
    ieee802154_fsm_state_cb_t fsm_state_cb;     
    mutex_t lock;                               
} ieee802154_fsm_t;

struct ieee802154_submac {
    ieee802154_dev_t dev;               
    eui64_t ext_addr;                   
    network_uint16_t short_addr;        
    const ieee802154_submac_cb_t *cb;   
#if IS_USED(MODULE_IEEE802154_SUBMAC_SOFT_CSMA_CA)
    ieee802154_csma_be_t be;            
    uint16_t csma_backoff_us;           
    uint8_t csma_retries;               
    uint8_t backoff_mask;               
    uint8_t csma_retries_nb;            
#endif
#if IS_USED(MODULE_IEEE802154_SUBMAC_SOFT_FRAME_RETRANS)
    uint8_t retrans;                    
    bool wait_for_ack;                  
#endif
    uint16_t ack_timeout_us;            
    uint16_t panid;                     
    uint16_t channel_num;               
    int8_t tx_pow;                      
    ieee802154_fsm_t fsm;               
    int32_t fsm_context_res;            
    ieee802154_phy_mode_t phy_mode;     
    const iolist_t *psdu;               
    uint8_t tx_ftype;                   
};

int ieee802154_send(ieee802154_submac_t *submac, const iolist_t *iolist);

static inline int ieee802154_set_short_addr(ieee802154_submac_t *submac,
                                            const network_uint16_t *short_addr)
{
    int res = ieee802154_radio_config_addr_filter(&submac->dev,
                                                  IEEE802154_AF_SHORT_ADDR,
                                                  short_addr);
 
    if (res >= 0) {
        memcpy(&submac->short_addr, short_addr, IEEE802154_SHORT_ADDRESS_LEN);
    }
 
    return res;
}

static inline int ieee802154_set_ext_addr(ieee802154_submac_t *submac,
                                          const eui64_t *ext_addr)
{
    int res = ieee802154_radio_config_addr_filter(&submac->dev,
                                                  IEEE802154_AF_EXT_ADDR,
                                                  ext_addr);
 
    if (res >= 0) {
        memcpy(&submac->ext_addr, ext_addr, IEEE802154_LONG_ADDRESS_LEN);
    }
    return res;
}

static inline int ieee802154_set_panid(ieee802154_submac_t *submac,
                                       const uint16_t *panid)
{
    int res = ieee802154_radio_config_addr_filter(&submac->dev,
                                                  IEEE802154_AF_PANID,
                                                  panid);
 
    if (res >= 0) {
        submac->panid = *panid;
    }
 
    return res;
}

static inline ieee802154_phy_mode_t ieee802154_get_phy_mode(
    ieee802154_submac_t *submac)
{
    return submac->phy_mode;
}

int ieee802154_set_phy_conf(ieee802154_submac_t *submac, const ieee802154_phy_conf_t *conf);

static inline int ieee802154_set_channel_number(ieee802154_submac_t *submac,
                                                uint16_t channel_num)
{
    const ieee802154_phy_conf_t conf = {
        .phy_mode = IEEE802154_PHY_NO_OP,
        .channel = channel_num,
        .pow = submac->tx_pow,
    };
 
    return ieee802154_set_phy_conf(submac, &conf);
}

static inline int ieee802154_set_tx_power(ieee802154_submac_t *submac,
                                          int8_t tx_pow)
{
    const ieee802154_phy_conf_t conf = {
        .phy_mode = IEEE802154_PHY_NO_OP,
        .channel = submac->channel_num,
        .pow = tx_pow,
    };
 
    return ieee802154_set_phy_conf(submac, &conf);
}

static inline int ieee802154_get_frame_length(ieee802154_submac_t *submac)
{
    return ieee802154_radio_len(&submac->dev);
}

static inline int ieee802154_read_frame(ieee802154_submac_t *submac, void *buf,
                                        size_t len, ieee802154_rx_info_t *info)
{
    return ieee802154_radio_read(&submac->dev, buf, len, info);
}

bool ieee802154_submac_state_is_rx(ieee802154_submac_t *submac);

bool ieee802154_submac_state_is_idle(ieee802154_submac_t *submac);

int ieee802154_submac_init(ieee802154_submac_t *submac, const network_uint16_t *short_addr,
                           const eui64_t *ext_addr);

extern void ieee802154_submac_ack_timer_set(ieee802154_submac_t *submac);

extern void ieee802154_submac_ack_timer_cancel(ieee802154_submac_t *submac);

int ieee802154_submac_process_ev(ieee802154_submac_t *submac,
                                 ieee802154_fsm_ev_t ev);

static inline void ieee802154_submac_ack_timeout_fired(ieee802154_submac_t *submac)
{
    ieee802154_submac_process_ev(submac, IEEE802154_FSM_EV_ACK_TIMEOUT);
}

static inline void ieee802154_submac_rx_done_cb(ieee802154_submac_t *submac)
{
    ieee802154_submac_process_ev(submac, IEEE802154_FSM_EV_RX_DONE);
}

static inline void ieee802154_submac_crc_error_cb(ieee802154_submac_t *submac)
{
    ieee802154_submac_process_ev(submac, IEEE802154_FSM_EV_CRC_ERROR);
}

static inline void ieee802154_submac_tx_done_cb(ieee802154_submac_t *submac)
{
    ieee802154_submac_process_ev(submac, IEEE802154_FSM_EV_TX_DONE);
}

static inline int ieee802154_set_idle(ieee802154_submac_t *submac)
{
    return ieee802154_submac_process_ev(submac, IEEE802154_FSM_EV_REQUEST_SET_IDLE);
}

static inline int ieee802154_set_rx(ieee802154_submac_t *submac)
{
    return ieee802154_submac_process_ev(submac, IEEE802154_FSM_EV_REQUEST_SET_RX_ON);
}
 
#ifdef __cplusplus
}
#endif