Hal.h

#if !defined(_RADIOLIB_HAL_H)
#define _RADIOLIB_HAL_H
 
#include <stdint.h>
#include <stddef.h>
 
#include "BuildOpt.h"
 
#define RADIOLIB_EEPROM_TABLE_VERSION (0x0002)
 
// list of persistent parameters
enum RADIOLIB_EEPROM_PARAMS {
  RADIOLIB_EEPROM_TABLE_VERSION_ID,           // table layout version
  RADIOLIB_EEPROM_LORAWAN_CLASS_ID,           // class A, B or C
  RADIOLIB_EEPROM_LORAWAN_MODE_ID,            // none, OTAA or ABP
  RADIOLIB_EEPROM_LORAWAN_CHECKSUM_ID,        // checksum of keys used for device activation
  RADIOLIB_EEPROM_LORAWAN_VERSION_ID,         // LoRaWAN version
  RADIOLIB_EEPROM_LORAWAN_LAST_TIME_ID,       // last heard time through DeviceTimeReq or Beacon
  RADIOLIB_EEPROM_LORAWAN_DEV_ADDR_ID,
  RADIOLIB_EEPROM_LORAWAN_APP_S_KEY_ID,
  RADIOLIB_EEPROM_LORAWAN_FNWK_SINT_KEY_ID,
  RADIOLIB_EEPROM_LORAWAN_SNWK_SINT_KEY_ID,
  RADIOLIB_EEPROM_LORAWAN_NWK_SENC_KEY_ID,
  RADIOLIB_EEPROM_LORAWAN_DEV_NONCE_ID,
  RADIOLIB_EEPROM_LORAWAN_JOIN_NONCE_ID,
  RADIOLIB_EEPROM_LORAWAN_HOME_NET_ID,
  RADIOLIB_EEPROM_LORAWAN_A_FCNT_DOWN_ID,
  RADIOLIB_EEPROM_LORAWAN_N_FCNT_DOWN_ID,
  RADIOLIB_EEPROM_LORAWAN_CONF_FCNT_UP_ID,
  RADIOLIB_EEPROM_LORAWAN_CONF_FCNT_DOWN_ID, 
  RADIOLIB_EEPROM_LORAWAN_ADR_FCNT_ID,
  RADIOLIB_EEPROM_LORAWAN_RJ_COUNT0_ID,
  RADIOLIB_EEPROM_LORAWAN_RJ_COUNT1_ID,
  RADIOLIB_EEPROM_LORAWAN_FCNT_UP_ID,
  RADIOLIB_EEPROM_LORAWAN_LINK_ADR_ID,
  RADIOLIB_EEPROM_LORAWAN_DUTY_CYCLE_ID,
  RADIOLIB_EEPROM_LORAWAN_RX_PARAM_SETUP_ID,
  RADIOLIB_EEPROM_LORAWAN_RX_TIMING_SETUP_ID,
  RADIOLIB_EEPROM_LORAWAN_TX_PARAM_SETUP_ID,
  RADIOLIB_EEPROM_LORAWAN_ADR_PARAM_SETUP_ID,
  RADIOLIB_EEPROM_LORAWAN_REJOIN_PARAM_SETUP_ID,
  RADIOLIB_EEPROM_LORAWAN_BEACON_FREQ_ID,
  RADIOLIB_EEPROM_LORAWAN_PING_SLOT_CHANNEL_ID,
  RADIOLIB_EEPROM_LORAWAN_PERIODICITY_ID,
  RADIOLIB_EEPROM_LORAWAN_NUM_ADR_MASKS_ID,
  RADIOLIB_EEPROM_LORAWAN_MAC_QUEUE_UL_ID,
  RADIOLIB_EEPROM_LORAWAN_UL_CHANNELS_ID,
  RADIOLIB_EEPROM_LORAWAN_DL_CHANNELS_ID
};
 
static const uint32_t RadioLibPersistentParamTable[] = {
  0x00,   // RADIOLIB_EEPROM_TABLE_VERSION_ID
  0x02,   // RADIOLIB_EEPROM_LORAWAN_CLASS_ID
  0x03,   // RADIOLIB_EEPROM_LORAWAN_MODE_ID
  0x05,   // RADIOLIB_EEPROM_LORAWAN_CHECKSUM_ID
  0x07,   // RADIOLIB_EEPROM_LORAWAN_VERSION_ID
  0x08,   // RADIOLIB_EEPROM_LORAWAN_LAST_TIME_ID
  0x0C,   // RADIOLIB_EEPROM_LORAWAN_DEV_ADDR_ID
  0x10,   // RADIOLIB_EEPROM_LORAWAN_APP_S_KEY_ID
  0x20,   // RADIOLIB_EEPROM_LORAWAN_FNWK_SINT_KEY_ID
  0x30,   // RADIOLIB_EEPROM_LORAWAN_SNWK_SINT_KEY_ID
  0x40,   // RADIOLIB_EEPROM_LORAWAN_NWK_SENC_KEY_ID
  0x50,   // RADIOLIB_EEPROM_LORAWAN_DEV_NONCE_ID
  0x54,   // RADIOLIB_EEPROM_LORAWAN_JOIN_NONCE_ID
  0x58,   // RADIOLIB_EEPROM_LORAWAN_HOME_NET_ID
  0x5C,   // RADIOLIB_EEPROM_LORAWAN_A_FCNT_DOWN_ID
  0x60,   // RADIOLIB_EEPROM_LORAWAN_N_FCNT_DOWN_ID
  0x64,   // RADIOLIB_EEPROM_LORAWAN_CONF_FCNT_UP_ID
  0x68,   // RADIOLIB_EEPROM_LORAWAN_CONF_FCNT_DOWN_ID
  0x6C,   // RADIOLIB_EEPROM_LORAWAN_ADR_FCNT_ID
  0x70,   // RADIOLIB_EEPROM_LORAWAN_RJ_COUNT0_ID
  0x72,   // RADIOLIB_EEPROM_LORAWAN_RJ_COUNT1_ID
  0x74,   // RADIOLIB_EEPROM_LORAWAN_FCNT_UP_ID
  0xA0,   // RADIOLIB_EEPROM_LORAWAN_LINK_ADR_ID
  0xA4,   // RADIOLIB_EEPROM_LORAWAN_DUTY_CYCLE_ID
  0xA5,   // RADIOLIB_EEPROM_LORAWAN_RX_PARAM_SETUP_ID
  0xA9,   // RADIOLIB_EEPROM_LORAWAN_RX_TIMING_SETUP_ID
  0xAA,   // RADIOLIB_EEPROM_LORAWAN_TX_PARAM_SETUP_ID
  0xAB,   // RADIOLIB_EEPROM_LORAWAN_ADR_PARAM_SETUP_ID
  0xAC,   // RADIOLIB_EEPROM_LORAWAN_REJOIN_PARAM_SETUP_ID
  0xAD,   // RADIOLIB_EEPROM_LORAWAN_BEACON_FREQ_ID
  0xB0,   // RADIOLIB_EEPROM_LORAWAN_PING_SLOT_CHANNEL_ID
  0xB4,   // RADIOLIB_EEPROM_LORAWAN_PERIODICITY_ID
  0xB5,   // RADIOLIB_EEPROM_LORAWAN_NUM_ADR_MASKS_ID
  0xB6,   // RADIOLIB_EEPROM_LORAWAN_MAC_QUEUE_UL_ID
  0x0100, // RADIOLIB_EEPROM_LORAWAN_UL_CHANNELS_ID
  0x0180, // RADIOLIB_EEPROM_LORAWAN_DL_CHANNELS_ID
  0x01C0, // end
};
 
class RadioLibHal {
  public:
 
    // values for pin modes, levels and change directions
    // these tell RadioLib how are different logic states represented on a given platform
 
    const uint32_t GpioModeInput;
 
    const uint32_t GpioModeOutput;
    
    const uint32_t GpioLevelLow;
    
    const uint32_t GpioLevelHigh;
    
    const uint32_t GpioInterruptRising;
    
    const uint32_t GpioInterruptFalling;
 
    RadioLibHal(const uint32_t input, const uint32_t output, const uint32_t low, const uint32_t high, const uint32_t rising, const uint32_t falling);
 
    // pure virtual methods - these must be implemented by the hardware abstraction for RadioLib to function
 
    virtual void pinMode(uint32_t pin, uint32_t mode) = 0;
 
    virtual void digitalWrite(uint32_t pin, uint32_t value) = 0;
 
    virtual uint32_t digitalRead(uint32_t pin) = 0;
    
    virtual void attachInterrupt(uint32_t interruptNum, void (*interruptCb)(void), uint32_t mode) = 0;
 
    virtual void detachInterrupt(uint32_t interruptNum) = 0;
 
    virtual void delay(unsigned long ms) = 0;
    
    virtual void delayMicroseconds(unsigned long us) = 0;
    
    virtual unsigned long millis() = 0;
    
    virtual unsigned long micros() = 0;
    
    virtual long pulseIn(uint32_t pin, uint32_t state, unsigned long timeout) = 0;
 
    virtual void spiBegin() = 0;
 
    virtual void spiBeginTransaction() = 0;
 
    virtual void spiTransfer(uint8_t* out, size_t len, uint8_t* in) = 0;
 
    virtual void spiEndTransaction() = 0;
 
    virtual void spiEnd() = 0;
 
    // virtual methods - these may or may not exists on a given platform
    // they exist in this implementation, but do nothing
 
    virtual void init();
 
    virtual void term();
 
    virtual void tone(uint32_t pin, unsigned int frequency, unsigned long duration = 0);
 
    virtual void noTone(uint32_t pin);
    
    virtual void yield();
    
    virtual uint32_t pinToInterrupt(uint32_t pin);
 
    virtual void readPersistentStorage(uint32_t addr, uint8_t* buff, size_t len);
 
    virtual void writePersistentStorage(uint32_t addr, uint8_t* buff, size_t len);
 
    void wipePersistentStorage();
    
    uint32_t getPersistentAddr(uint32_t id);
 
    template<typename T>
    void setPersistentParameter(uint32_t id, T val, uint32_t offset = 0);
 
    template<typename T>
    T getPersistentParameter(uint32_t id);
};
 
#endif