radio.h

/*
 * Copyright (C) 2020 HAW Hamburg
 *
 * 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.
 */
 
#ifndef NET_IEEE802154_RADIO_H
#define NET_IEEE802154_RADIO_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdbool.h>
#include "iolist.h"
#include "sys/uio.h"
#include "byteorder.h"
#include "net/eui64.h"
 
typedef struct ieee802154_radio_ops ieee802154_radio_ops_t;
 
typedef enum {
    IEEE802154_CAP_FRAME_RETRANS,
    IEEE802154_CAP_AUTO_CSMA,
    IEEE802154_CAP_IRQ_ACK_TIMEOUT,
    IEEE802154_CAP_24_GHZ,
    IEEE802154_CAP_SUB_GHZ,
    IEEE802154_CAP_IRQ_TX_DONE,
    IEEE802154_CAP_IRQ_RX_START,
    IEEE802154_CAP_IRQ_TX_START,
    IEEE802154_CAP_IRQ_CCA_DONE,
    IEEE802154_CAP_FRAME_RETRANS_INFO,
    IEEE802154_CAP_REG_RETENTION,
} ieee802154_rf_caps_t;
 
typedef enum {
    TX_STATUS_SUCCESS,
    TX_STATUS_FRAME_PENDING,
    TX_STATUS_NO_ACK,
    TX_STATUS_MEDIUM_BUSY,
} ieee802154_tx_status_t;
 
typedef enum {
    IEEE802154_TRX_STATE_TRX_OFF,
    IEEE802154_TRX_STATE_RX_ON,
    IEEE802154_TRX_STATE_TX_ON,
} ieee802154_trx_state_t;
 
typedef enum {
    IEEE802154_RADIO_INDICATION_RX_START,
 
    IEEE802154_RADIO_INDICATION_TX_START,
 
    IEEE802154_RADIO_INDICATION_RX_DONE,
 
    IEEE802154_RADIO_CONFIRM_TX_DONE,
    IEEE802154_RADIO_CONFIRM_CCA,
} ieee802154_trx_ev_t;
 
typedef struct {
    uint8_t min;    
    uint8_t max;    
} ieee802154_csma_be_t;
 
typedef struct {
    uint8_t rssi;
    uint8_t lqi;    
} ieee802154_rx_info_t;
 
typedef struct {
    ieee802154_tx_status_t status;      
    int8_t retrans;                     
} ieee802154_tx_info_t;
 
typedef struct ieee802154_dev ieee802154_dev_t;
 
typedef void (*ieee802154_cb_t)(ieee802154_dev_t *dev,
                                ieee802154_trx_ev_t status);
 
struct ieee802154_dev {
    const ieee802154_radio_ops_t *driver;
    void *ctx;
    ieee802154_cb_t cb;
};
 
typedef enum {
    IEEE802154_CCA_MODE_ED_THRESHOLD,
    IEEE802154_CCA_MODE_CARRIER_SENSING,
    IEEE802154_CCA_MODE_ED_THRESH_AND_CS,
    IEEE802154_CCA_MODE_ED_THRESH_OR_CS,
} ieee802154_cca_mode_t;
 
typedef enum {
    IEEE802154_RX_AACK_DISABLED,
    IEEE802154_RX_AACK_ENABLED,
    IEEE802154_RX_AACK_FRAME_PENDING,
    IEEE802154_RX_PROMISC,
    IEEE802154_RX_WAIT_FOR_ACK,
} ieee802154_rx_mode_t;
 
typedef struct {
    uint16_t channel;   
    uint8_t page;       
    int8_t pow;         
} ieee802154_phy_conf_t;
 
struct ieee802154_radio_ops {
    int (*write)(ieee802154_dev_t *dev, const iolist_t *psdu);
 
    int (*request_transmit)(ieee802154_dev_t *dev);
 
    int (*confirm_transmit)(ieee802154_dev_t *dev, ieee802154_tx_info_t *info);
 
    int (*len)(ieee802154_dev_t *dev);
 
    int (*read)(ieee802154_dev_t *dev, void *buf, size_t size, ieee802154_rx_info_t *info);
    int (*off)(ieee802154_dev_t *dev);
 
    int (*request_on)(ieee802154_dev_t *dev);
 
    int (*confirm_on)(ieee802154_dev_t *dev);
 
    int (*request_set_trx_state)(ieee802154_dev_t *dev,
                                 ieee802154_trx_state_t state);
 
    int (*confirm_set_trx_state)(ieee802154_dev_t *dev);
 
    int (*request_cca)(ieee802154_dev_t *dev);
 
    int (*confirm_cca)(ieee802154_dev_t *dev);
 
    bool (*get_cap)(ieee802154_dev_t *dev, ieee802154_rf_caps_t cap);
 
    int (*set_cca_threshold)(ieee802154_dev_t *dev, int8_t threshold);
 
    int (*set_cca_mode)(ieee802154_dev_t *dev, ieee802154_cca_mode_t mode);
 
    int (*config_phy)(ieee802154_dev_t *dev, const ieee802154_phy_conf_t *conf);
 
    int (*set_hw_addr_filter)(ieee802154_dev_t *dev,
                              const network_uint16_t *short_addr,
                              const eui64_t *ext_addr,
                              const uint16_t *pan_id);
 
    int (*set_frame_retrans)(ieee802154_dev_t *dev, uint8_t retrans);
 
    int (*set_csma_params)(ieee802154_dev_t *dev, const ieee802154_csma_be_t *bd,
                           int8_t retries);
 
    int (*set_rx_mode)(ieee802154_dev_t *dev, ieee802154_rx_mode_t mode);
};
 
static inline int ieee802154_radio_write(ieee802154_dev_t *dev, const iolist_t *psdu)
{
    return dev->driver->write(dev, psdu);
}
 
static inline int ieee802154_radio_request_transmit(ieee802154_dev_t *dev)
{
    return dev->driver->request_transmit(dev);
}
 
static inline int ieee802154_radio_confirm_transmit(ieee802154_dev_t *dev,
                                                    ieee802154_tx_info_t *info)
{
    return dev->driver->confirm_transmit(dev, info);
}
 
static inline int ieee802154_radio_len(ieee802154_dev_t *dev)
{
    return dev->driver->len(dev);
}
 
static inline int ieee802154_radio_read(ieee802154_dev_t *dev,
                                                 void *buf,
                                                 size_t size,
                                                 ieee802154_rx_info_t *info)
{
    return dev->driver->read(dev, buf, size, info);
}
 
static inline int ieee802154_radio_set_cca_threshold(ieee802154_dev_t *dev,
                                                     int8_t threshold)
{
    return dev->driver->set_cca_threshold(dev, threshold);
}
 
static inline int ieee802154_radio_set_cca_mode(ieee802154_dev_t *dev,
                                                ieee802154_cca_mode_t mode)
{
    return dev->driver->set_cca_mode(dev, mode);
}
 
static inline int ieee802154_radio_config_phy(ieee802154_dev_t *dev,
                                              const ieee802154_phy_conf_t *conf)
{
    return dev->driver->config_phy(dev, conf);
}
 
static inline int ieee802154_radio_off(ieee802154_dev_t *dev)
{
    return dev->driver->off(dev);
}
 
static inline int ieee802154_radio_set_hw_addr_filter(ieee802154_dev_t *dev,
                                                      const network_uint16_t *short_addr,
                                                      const eui64_t *ext_addr,
                                                      const uint16_t *pan_id)
{
    return dev->driver->set_hw_addr_filter(dev, short_addr, ext_addr, pan_id);
}
 
static inline int ieee802154_radio_set_frame_retrans(ieee802154_dev_t *dev,
                                                     uint8_t retrans)
{
    return dev->driver->set_frame_retrans(dev, retrans);
}
 
static inline int ieee802154_radio_set_csma_params(ieee802154_dev_t *dev,
                                                   const ieee802154_csma_be_t *bd,
                                                   int8_t retries)
{
    return dev->driver->set_csma_params(dev, bd, retries);
}
 
static inline int ieee802154_radio_request_on(ieee802154_dev_t *dev)
{
    return dev->driver->request_on(dev);
}
 
static inline int ieee802154_radio_confirm_on(ieee802154_dev_t *dev)
{
    return dev->driver->confirm_on(dev);
}
 
static inline int ieee802154_radio_request_set_trx_state(ieee802154_dev_t *dev,
                                                         ieee802154_trx_state_t state)
{
    return dev->driver->request_set_trx_state(dev, state);
}
 
static inline int ieee802154_radio_confirm_set_trx_state(ieee802154_dev_t *dev)
{
    return dev->driver->confirm_set_trx_state(dev);
}
 
static inline int ieee802154_radio_request_cca(ieee802154_dev_t *dev)
{
    return dev->driver->request_cca(dev);
}
 
static inline int ieee802154_radio_confirm_cca(ieee802154_dev_t *dev)
{
    return dev->driver->confirm_cca(dev);
}
 
static inline bool ieee802154_radio_has_irq_ack_timeout(ieee802154_dev_t *dev)
{
    return dev->driver->get_cap(dev, IEEE802154_CAP_IRQ_ACK_TIMEOUT);
}
 
static inline bool ieee802154_radio_has_frame_retrans(ieee802154_dev_t *dev)
{
    return dev->driver->get_cap(dev, IEEE802154_CAP_FRAME_RETRANS);
}
 
static inline bool ieee802154_radio_has_auto_csma(ieee802154_dev_t *dev)
{
    return dev->driver->get_cap(dev, IEEE802154_CAP_AUTO_CSMA);
}
 
static inline bool ieee802154_radio_has_sub_ghz(ieee802154_dev_t *dev)
{
    return dev->driver->get_cap(dev, IEEE802154_CAP_SUB_GHZ);
}
 
static inline bool ieee802154_radio_has_24_ghz(ieee802154_dev_t *dev)
{
    return dev->driver->get_cap(dev, IEEE802154_CAP_24_GHZ);
}
 
static inline bool ieee802154_radio_has_irq_tx_done(ieee802154_dev_t *dev)
{
    return dev->driver->get_cap(dev, IEEE802154_CAP_IRQ_TX_DONE);
}
 
static inline bool ieee802154_radio_has_irq_rx_start(ieee802154_dev_t *dev)
{
    return dev->driver->get_cap(dev, IEEE802154_CAP_IRQ_RX_START);
}
 
static inline bool ieee802154_radio_has_irq_tx_start(ieee802154_dev_t *dev)
{
    return dev->driver->get_cap(dev, IEEE802154_CAP_IRQ_TX_START);
}
 
static inline bool ieee802154_radio_has_irq_cca_done(ieee802154_dev_t *dev)
{
    return dev->driver->get_cap(dev, IEEE802154_CAP_IRQ_CCA_DONE);
}
 
static inline bool ieee802154_radio_has_frame_retrans_info(
    ieee802154_dev_t *dev)
{
    return dev->driver->get_cap(dev, IEEE802154_CAP_FRAME_RETRANS_INFO);
}
 
static inline int ieee802154_radio_set_rx_mode(ieee802154_dev_t *dev,
                                               ieee802154_rx_mode_t mode)
{
    return dev->driver->set_rx_mode(dev, mode);
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* NET_IEEE802154_RADIO_H */