Hal.h

#if !defined(_RADIOLIB_HAL_H)
#define _RADIOLIB_HAL_H
 
#include <stdint.h>
#include <stddef.h>
 
#include "BuildOpt.h"
 
// list of persistent parameters
#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_VERSION_ID       (0)  // this is NOT the LoRaWAN version, but version of this table
#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_MAGIC_ID         (1)
#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_DEV_ADDR_ID      (2)
#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_APP_S_KEY_ID     (3)
#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_FNWK_SINT_KEY_ID (4)
#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_SNWK_SINT_KEY_ID (5)
#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_NWK_SENC_KEY_ID  (6)
#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_DEV_NONCE_ID     (7)
#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_JOIN_NONCE_ID    (8)
#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_HOME_NET_ID      (9)
#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_DL_SETTINGS_ID  (10)
#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_CF_LIST_ID      (11)
#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_RX_DELAY_ID     (12)
#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_FCNT_UP_ID      (13)
#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_A_FCNT_DOWN_ID  (14)
#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_N_FCNT_DOWN_ID  (15)
#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_CONF_FCNT_ID    (16)
#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_ADR_ID          (17)
#define RADIOLIB_PERSISTENT_PARAM_LORAWAN_FOPTS_ID        (18)
 
static const uint32_t RadioLibPersistentParamTable[] = {
  0x00,   // RADIOLIB_PERSISTENT_PARAM_LORAWAN_VERSION
  0x08,   // RADIOLIB_PERSISTENT_PARAM_LORAWAN_MAGIC_ID
  0x0C,   // RADIOLIB_PERSISTENT_PARAM_LORAWAN_DEV_ADDR_ID
  0x10,   // RADIOLIB_PERSISTENT_PARAM_LORAWAN_APP_S_KEY_ID
  0x20,   // RADIOLIB_PERSISTENT_PARAM_LORAWAN_FNWK_SINT_KEY_ID
  0x30,   // RADIOLIB_PERSISTENT_PARAM_LORAWAN_SNWK_SINT_KEY_ID
  0x40,   // RADIOLIB_PERSISTENT_PARAM_LORAWAN_NWK_SENC_KEY_ID
  0x50,   // RADIOLIB_PERSISTENT_PARAM_LORAWAN_DEV_NONCE_ID
  0x54,   // RADIOLIB_PERSISTENT_PARAM_LORAWAN_JOIN_NONCE_ID
  0x58,   // RADIOLIB_PERSISTENT_PARAM_LORAWAN_HOME_NET_ID
  0x5C,   // RADIOLIB_PERSISTENT_PARAM_LORAWAN_DL_SETTINGS_ID
  0x60,   // RADIOLIB_PERSISTENT_PARAM_LORAWAN_CF_LIST
  0x70,   // RADIOLIB_PERSISTENT_PARAM_LORAWAN_RX_DELAY_ID
  0x74,   // RADIOLIB_PERSISTENT_PARAM_LORAWAN_FCNT_UP_ID
  0x78,   // RADIOLIB_PERSISTENT_PARAM_LORAWAN_AFCNT_DOWN_ID
  0x7C,   // RADIOLIB_PERSISTENT_PARAM_LORAWAN_NFCNT_DOWN_ID
  0x80,   // RADIOLIB_PERSISTENT_PARAM_LORAWAN_CONF_FCNT_ID
  0x84,   // RADIOLIB_PERSISTENT_PARAM_LORAWAN_ADR_ID
  0x88,   // RADIOLIB_PERSISTENT_PARAM_LORAWAN_FOPTS_ID
  0xD0,   // 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);
 
    template<typename T>
    T getPersistentParameter(uint32_t id);
};
 
#endif