[LoRaWAN] Change and upgrade persistence handling (#1017)

* [LoRaWAN] Change and upgrade persistence handling * [BuildOpt] Patch to upstream * [LoRaWAN] Fix #1018 * [LoRaWAN] Remove outdated parts * [LoRaWAN] Resolve feedback Warning: untested - am not at my desk * [LoRaWAN] Small bugfixes
jgromes · Mar 18, 2024 · ca2a307 · ca2a307
1 parent 3d5f05b
commit ca2a307
Show file tree

Hide file tree

Showing 10 changed files with 542 additions and 884 deletions.
diff --git a/keywords.txt b/keywords.txt
@@ -293,6 +293,10 @@ setModem	KEYWORD2
 
 # LoRaWAN
 wipe	KEYWORD2
+getBufferNonces	KEYWORD2
+setBufferNonces	KEYWORD2
+getBufferSession	KEYWORD2
+setBufferSession	KEYWORD2
 restore	KEYWORD2
 beginOTAA	KEYWORD2
 beginABP	KEYWORD2

diff --git a/src/ArduinoHal.cpp b/src/ArduinoHal.cpp
@@ -2,10 +2,6 @@
 
 #if defined(RADIOLIB_BUILD_ARDUINO)
 
-#if !defined(RADIOLIB_EEPROM_UNSUPPORTED)
-#include <EEPROM.h>
-#endif
-
 ArduinoHal::ArduinoHal(): RadioLibHal(INPUT, OUTPUT, LOW, HIGH, RISING, FALLING), spi(&RADIOLIB_DEFAULT_SPI), initInterface(true) {}
 
 ArduinoHal::ArduinoHal(SPIClass& spi, SPISettings spiSettings): RadioLibHal(INPUT, OUTPUT, LOW, HIGH, RISING, FALLING), spi(&spi), spiSettings(spiSettings) {}
@@ -118,49 +114,6 @@ void inline ArduinoHal::spiEnd() {
   spi->end();
 }
 
-void ArduinoHal::readPersistentStorage(uint32_t addr, uint8_t* buff, size_t len) {
-  #if !defined(RADIOLIB_EEPROM_UNSUPPORTED)
-    #if defined(RADIOLIB_ESP32) || defined(ARDUINO_ARCH_RP2040)
-      EEPROM.begin(RADIOLIB_HAL_PERSISTENT_STORAGE_SIZE);
-    #elif defined(ARDUINO_ARCH_APOLLO3)
-      EEPROM.init();
-    #endif
-    for(size_t i = 0; i < len; i++) {
-      buff[i] = EEPROM.read(addr + i);
-    }
-    #if defined(RADIOLIB_ESP32) || defined(ARDUINO_ARCH_RP2040)
-      EEPROM.end();
-    #endif
-  #else
-    (void)addr;
-    (void)buff;
-    (void)len;
-  #endif
-}
-
-void ArduinoHal::writePersistentStorage(uint32_t addr, uint8_t* buff, size_t len) {
-  #if !defined(RADIOLIB_EEPROM_UNSUPPORTED)
-    #if defined(RADIOLIB_ESP32) || defined(ARDUINO_ARCH_RP2040)
-      EEPROM.begin(RADIOLIB_HAL_PERSISTENT_STORAGE_SIZE);
-    #elif defined(ARDUINO_ARCH_APOLLO3)
-      EEPROM.init();
-    #endif
-    for(size_t i = 0; i < len; i++) {
-      if(EEPROM.read(addr + i) != buff[i]) {  // only write if value is new
-        EEPROM.write(addr + i, buff[i]);
-      }
-    }
-    #if defined(RADIOLIB_ESP32) || defined(ARDUINO_ARCH_RP2040)
-      EEPROM.commit();
-      EEPROM.end();
-    #endif
-  #else
-    (void)addr;
-    (void)buff;
-    (void)len;
-  #endif
-}
-
 void inline ArduinoHal::tone(uint32_t pin, unsigned int frequency, unsigned long duration) {
   #if !defined(RADIOLIB_TONE_UNSUPPORTED)
     if(pin == RADIOLIB_NC) {

diff --git a/src/ArduinoHal.h b/src/ArduinoHal.h
@@ -51,9 +51,6 @@ class ArduinoHal : public RadioLibHal {
     void spiEndTransaction() override;
     void spiEnd() override;
 
-    void readPersistentStorage(uint32_t addr, uint8_t* buff, size_t len) override;
-    void writePersistentStorage(uint32_t addr, uint8_t* buff, size_t len) override;
-
     // implementations of virtual RadioLibHal methods
     void init() override;
     void term() override;

diff --git a/src/BuildOpt.h b/src/BuildOpt.h
@@ -104,21 +104,6 @@
   #define RADIOLIB_STATIC_ARRAY_SIZE   (256)
 #endif
 
-// the base address for persistent storage
-// some protocols (e.g. LoRaWAN) require a method
-// to store some data persistently
-// on Arduino, this will use EEPROM, on non-Arduino platform,
-// it will use anything provided by the hardware abstraction layer
-// RadioLib will place these starting at this address
-#if !defined(RADIOLIB_HAL_PERSISTENT_STORAGE_BASE)
-  #define RADIOLIB_HAL_PERSISTENT_STORAGE_BASE            (0)
-#endif
-
-// the amount of space allocated to the persistent storage
-#if !defined(RADIOLIB_HAL_PERSISTENT_STORAGE_SIZE)
-  #define RADIOLIB_HAL_PERSISTENT_STORAGE_SIZE            (0x01C0)
-#endif
-
 /*
  * Uncomment on boards whose clock runs too slow or too fast
  * Set the value according to the following scheme:
@@ -238,26 +223,22 @@
 #elif defined(SAMD_SERIES)
   // Adafruit SAMD boards (M0 and M4)
   #define RADIOLIB_PLATFORM                           "Adafruit SAMD"
-  #define RADIOLIB_EEPROM_UNSUPPORTED
 
 #elif defined(ARDUINO_ARCH_SAMD)
   // Arduino SAMD (Zero, MKR, etc.)
   #define RADIOLIB_PLATFORM                           "Arduino SAMD"
   #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST           (PinMode)
   #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST         (PinStatus)
   #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST     (PinStatus)  
-  #define RADIOLIB_EEPROM_UNSUPPORTED
 
 #elif defined(__SAM3X8E__)
   // Arduino Due
   #define RADIOLIB_PLATFORM                           "Arduino Due"
   #define RADIOLIB_TONE_UNSUPPORTED
-  #define RADIOLIB_EEPROM_UNSUPPORTED
 
 #elif (defined(NRF52832_XXAA) || defined(NRF52840_XXAA)) && !defined(ARDUINO_ARDUINO_NANO33BLE)
   // Adafruit nRF52 boards
   #define RADIOLIB_PLATFORM                           "Adafruit nRF52"
-  #define RADIOLIB_EEPROM_UNSUPPORTED
 
 #elif defined(ARDUINO_ARC32_TOOLS)
   // Intel Curie
@@ -280,7 +261,6 @@
   #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST           (PinMode)
   #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST         (PinStatus)
   #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST     (PinStatus)
-  #define RADIOLIB_EEPROM_UNSUPPORTED
 
   // Arduino mbed OS boards have a really bad tone implementation which will crash after a couple seconds
   #define RADIOLIB_TONE_UNSUPPORTED
@@ -292,7 +272,6 @@
   #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST           (PinMode)
   #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST         (PinStatus)
   #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST     (PinStatus)
-  #define RADIOLIB_EEPROM_UNSUPPORTED
 
   // Arduino mbed OS boards have a really bad tone implementation which will crash after a couple seconds
   #define RADIOLIB_TONE_UNSUPPORTED
@@ -314,7 +293,6 @@
   #define RADIOLIB_ARDUINOHAL_PIN_MODE_CAST           (PinMode)
   #define RADIOLIB_ARDUINOHAL_PIN_STATUS_CAST         (PinStatus)
   #define RADIOLIB_ARDUINOHAL_INTERRUPT_MODE_CAST     (PinStatus)
-  #define RADIOLIB_EEPROM_UNSUPPORTED
 
   // Arduino mbed OS boards have a really bad tone implementation which will crash after a couple seconds
   #define RADIOLIB_TONE_UNSUPPORTED
@@ -585,4 +563,4 @@
 
 #define RADIOLIB_VERSION (((RADIOLIB_VERSION_MAJOR) << 24) | ((RADIOLIB_VERSION_MINOR) << 16) | ((RADIOLIB_VERSION_PATCH) << 8) | (RADIOLIB_VERSION_EXTRA))
 
-#endif
+#endif
diff --git a/src/Hal.cpp b/src/Hal.cpp
@@ -33,50 +33,3 @@ void RadioLibHal::yield() {
 uint32_t RadioLibHal::pinToInterrupt(uint32_t pin) {
   return(pin);
 }
-
-void RadioLibHal::readPersistentStorage(uint32_t addr, uint8_t* buff, size_t len) {
-  // these are only needed for some protocols, so it's not needed to have them by default
-  (void)addr;
-  (void)buff;
-  (void)len;
-}
-
-void RadioLibHal::writePersistentStorage(uint32_t addr, uint8_t* buff, size_t len) {
-  // these are only needed for some protocols, so it's not needed to have them by default
-  (void)addr;
-  (void)buff;
-  (void)len;
-}
-
-void RadioLibHal::wipePersistentStorage() {
-  uint8_t dummy = 0;
-  for(size_t i = 0; i < RADIOLIB_HAL_PERSISTENT_STORAGE_SIZE; i++) {
-    this->writePersistentStorage(RADIOLIB_HAL_PERSISTENT_STORAGE_BASE + i, &dummy, sizeof(uint8_t));
-  }
-}
-
-uint32_t RadioLibHal::getPersistentAddr(uint32_t id) {
-  return(RadioLibPersistentParamTable[id]);
-}
-
-template<typename T>
-void RadioLibHal::setPersistentParameter(uint32_t id, T val, uint32_t offset) {
-  uint8_t *ptr = (uint8_t*)&val;
-  this->writePersistentStorage(RADIOLIB_HAL_PERSISTENT_STORAGE_BASE + RadioLibPersistentParamTable[id] + offset, ptr, sizeof(T));
-}
-
-template void RadioLibHal::setPersistentParameter(uint32_t id, uint8_t val, uint32_t offset);
-template void RadioLibHal::setPersistentParameter(uint32_t id, uint16_t val, uint32_t offset);
-template void RadioLibHal::setPersistentParameter(uint32_t id, uint32_t val, uint32_t offset);
-
-template<typename T>
-T RadioLibHal::getPersistentParameter(uint32_t id) {
-  T val = 0;
-  uint8_t *ptr = (uint8_t*)&val;
-  this->readPersistentStorage(RADIOLIB_HAL_PERSISTENT_STORAGE_BASE + RadioLibPersistentParamTable[id], ptr, sizeof(T));
-  return(val);
-}
-
-template uint8_t RadioLibHal::getPersistentParameter(uint32_t id);
-template uint16_t RadioLibHal::getPersistentParameter(uint32_t id);
-template uint32_t RadioLibHal::getPersistentParameter(uint32_t id);
diff --git a/src/Hal.h b/src/Hal.h
@@ -6,88 +6,6 @@
 
 #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
   \brief Hardware abstraction library base interface.
@@ -289,56 +207,6 @@ class RadioLibHal {
       \returns The interrupt number of a given pin.
     */
     virtual uint32_t pinToInterrupt(uint32_t pin);
-
-    /*!
-      \brief Method to read from persistent storage (e.g. EEPROM).
-      \param addr Address to start reading at.
-      \param buff Buffer to read into.
-      \param len Number of bytes to read.
-    */
-    virtual void readPersistentStorage(uint32_t addr, uint8_t* buff, size_t len);
-
-    /*!
-      \brief Method to write to persistent storage (e.g. EEPROM).
-      \param addr Address to start writing to.
-      \param buff Buffer to write.
-      \param len Number of bytes to write.
-    */
-    virtual void writePersistentStorage(uint32_t addr, uint8_t* buff, size_t len);
-
-    /*!
-      \brief Method to wipe the persistent storage by writing to 0.
-      Will write at most RADIOLIB_HAL_PERSISTENT_STORAGE_SIZE bytes.
-    */
-    void wipePersistentStorage();
-
-    /*!
-      \brief Method to convert from persistent parameter ID to its physical address.
-      \param id Parameter ID.
-      \returns Parameter physical address.
-    */
-    uint32_t getPersistentAddr(uint32_t id);
-
-    /*!
-      \brief Method to set arbitrary parameter to persistent storage.
-      This method DOES NOT perform any endianness conversion, so the value
-      will be stored in the system endian!
-      \param id Parameter ID to save at.
-      \param val Value to set.
-      \param offset An additional offset added to the address.
-    */
-    template<typename T>
-    void setPersistentParameter(uint32_t id, T val, uint32_t offset = 0);
-
-    /*!
-      \brief Method to get arbitrary parameter from persistent storage.
-      This method DOES NOT perform any endianness conversion, so the value
-      will be retrieved in the system endian!
-      \param id Parameter ID to load from.
-      \returns The loaded value.
-    */
-    template<typename T>
-    T getPersistentParameter(uint32_t id);
 };
 
 #endif
diff --git a/src/TypeDef.h b/src/TypeDef.h
@@ -558,6 +558,11 @@
 */
 #define RADIOLIB_ERR_DWELL_TIME_EXCEEDED                        (-1115)
 
+/*!
+  \brief The buffer integrity check did not match the supplied checksum value.
+*/
+#define RADIOLIB_ERR_CHECKSUM_MISMATCH                          (-1116)
+
 /*!
   \}
 */
-Original file line number
+Diff line change
@@ Expand Up / @@ -558,6 +558,11 @@ @@
     */
     #define RADIOLIB_ERR_DWELL_TIME_EXCEEDED                        (-1115)
+    /*!
+      \brief The buffer integrity check did not match the supplied checksum value.
+    */
+    #define RADIOLIB_ERR_CHECKSUM_MISMATCH                          (-1116)
     /*!
       \}
     */
@@ Expand Down @@