Device_Update: Add LoRa firmware update support

Author: LeeLeahy2

Firmware/RTK_Everywhere/Device_Update.h

@@ -270,6 +270,19 @@ const DFU_BUFFER_INFO dfuBufferInfo[] =
 };
 const int dfuBufferInfoCount = sizeof(dfuBufferInfo) / sizeof(dfuBufferInfo[0]);
 
+//----------------------------------------
+// Device specific context
+//----------------------------------------
+
+typedef struct _DFU_STM32_CONTEXT
+{
+    HardwareSerial * _stm32Serial;  // ESP32 serial port for STM32 communication
+} DFU_STM32_CONTEXT;
+#define DFU_STM32_CTX_LEN    sizeof(DFU_STM32_CONTEXT)
+
+// Context initialization routines
+bool dfuLoRaCtxInit(DEVICE_FIRMWARE_CTX * ctx);
+
 //----------------------------------------
 // Declare the device specific maximum write size
 //----------------------------------------
@@ -280,20 +293,27 @@ const int dfuBufferInfoCount = sizeof(dfuBufferInfo) / sizeof(dfuBufferInfo[0]);
 #define DFU_LG290P_BYTES                (1 + 1 + 1 + 2 + 4 + DFU_LG290P_MAX_PAYLOAD_SIZE + 4 + 1)
 #endif  // COMPILE_LG290P
 
+// STM32 declarations
+#define DFU_STM32_MAX_PAYLOAD_SIZE      256
+#define DFU_STM32_BYTES                 (1 + DFU_STM32_MAX_PAYLOAD_SIZE + 1)
+
 //----------------------------------------
 // Declare the forward device support routines
 //----------------------------------------
 
 // Get firmware version
 String dfuEsp32GetFirmwareVersion(DEVICE_FIRMWARE_CTX * ctx);
 String dfuGnssGetFirmwareVersion(DEVICE_FIRMWARE_CTX * ctx);
+String dfuLoRaGetFirmwareVersion(DEVICE_FIRMWARE_CTX * ctx);
 
 // Device reset
 bool dfuLg290pReset(DEVICE_FIRMWARE_CTX * ctx, uint32_t currentMsec);
+bool dfuLoRaReset(DEVICE_FIRMWARE_CTX * ctx, uint32_t currentMsec);
 
 // Device open, prepare for writing firmware
 bool dfuEsp32Open(DEVICE_FIRMWARE_CTX * ctx);
 bool dfuLg290pOpen(DEVICE_FIRMWARE_CTX * ctx);
+bool dfuStm32Open(DEVICE_FIRMWARE_CTX * ctx);
 
 // Device write, perform the firmware update
 ssize_t dfuEsp32Write(DEVICE_FIRMWARE_CTX * ctx,
@@ -302,10 +322,14 @@ ssize_t dfuEsp32Write(DEVICE_FIRMWARE_CTX * ctx,
 ssize_t dfuLg290pWrite(DEVICE_FIRMWARE_CTX * ctx,
                        const uint8_t * buffer,
                        size_t bytesToWrite);
+ssize_t dfuStm32Write(DEVICE_FIRMWARE_CTX * ctx,
+                      const uint8_t * buffer,
+                      size_t bytesToWrite);
 
 // Device close, finalize the firmware update
 void dfuEsp32Close(DEVICE_FIRMWARE_CTX * ctx);
 void dfuLg290pClose(DEVICE_FIRMWARE_CTX * ctx);
+void dfuLoRaClose(DEVICE_FIRMWARE_CTX * ctx);
 
 // Declare the begin routine
 bool deviceFirmwareUpdateBegin(bool doAll,
@@ -327,6 +351,11 @@ const DEVICE_FIRMWARE_INFO deviceFirmwareInfo[] =
 #ifdef  COMPILE_LG290P
     {"LG290P",      &present.gnss_lg290p,   "/gnss/lg290p",             "LG290P",          ".pkg", dfuGnssGetFirmwareVersion,   dfuLg290pReset,     dfuLg290pOpen,      dfuLg290pWrite,     dfuLg290pClose, nullptr,            0,                      true,   false,  DFU_LG290P_BYTES,   DFU_LG290P_MAX_PAYLOAD_SIZE,    dfuGithub, dfuRawHead, dfuFileTree, dfuItems, dfuListEnd, dfuName, dfuNameEnd, dfuRawHead},
 #endif  // COMPILE_LG290P
+
+    // LoRa devices
+#ifdef  COMPILE_LORA
+    {"LoRa",        &present.radio_lora,    "/lora/stm32wl",            "LoRa_",           ".bin", dfuLoRaGetFirmwareVersion,   dfuLoRaReset,       dfuStm32Open,       dfuStm32Write,      dfuLoRaClose,   dfuLoRaCtxInit,     DFU_STM32_CTX_LEN,      false,  false,  DFU_STM32_BYTES,    DFU_STM32_MAX_PAYLOAD_SIZE,     dfuGithub, dfuRawHead, dfuFileTree, dfuItems, dfuListEnd, dfuName, dfuNameEnd, dfuRawHead},
+#endif  // COMPILE_LORA
 };
 const int deviceFirmwareInfoCount = sizeof(deviceFirmwareInfo) / sizeof(deviceFirmwareInfo[0]);
 

Firmware/RTK_Everywhere/Device_Update_LoRa.ino

@@ -0,0 +1,77 @@
+/*=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+Device_Update_LoRa.ino
+
+  Update LoRa (STM32) firmware
+  See https://www.st.com/resource/en/application_note/CD00264342.pdf
+
+  Example Linux command to covert Intel Hex files into binary files:
+
+  objcopy   --input-target=ihex   --output-target=binary   --gap-fill 0xff   SparkPNT_LoRa_3.0.1.hex   SparkPNT_LoRa_3.0.1.bin
+
+=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
+
+#ifdef  COMPILE_LORA
+
+//----------------------------------------
+// Perform the cleanup after the firmware download
+//----------------------------------------
+void dfuLoRaClose(DEVICE_FIRMWARE_CTX * ctx)
+{
+    systemPrintf("Update Complete. Resetting IC...");
+
+    gpioExpanderLoraBootDisable();  // Pull BOOT0 low to exit bootloader mode on reset
+    dfuLoRaReset();                 // Power cycle LoRa to reset into normal mode
+}
+
+//----------------------------------------
+// Initialize the device specific context structure
+//----------------------------------------
+bool dfuLoRaCtxInit(DEVICE_FIRMWARE_CTX * ctx)
+{
+    DFU_STM32_CONTEXT * stm32Ctx;
+
+    stm32Ctx = (DFU_STM32_CONTEXT *)(ctx->_devCtx);
+    stm32Ctx->_stm32Serial = SerialForLoRa;
+    return true;
+}
+
+//----------------------------------------
+// Get the firmware version
+//----------------------------------------
+String dfuLoRaGetFirmwareVersion(DEVICE_FIRMWARE_CTX * ctx)
+{
+    return String(loraFirmwareVersion);
+}
+
+//----------------------------------------
+// There is not a hardware reset pin exposed. Power cycle the device.
+//----------------------------------------
+void dfuLoRaReset()
+{
+    gpioExpanderLoraDisable(); // Power off
+    delay(100);
+    gpioExpanderLoraEnable(); // Power on
+    delay(100);
+}
+
+//----------------------------------------
+// Reset the LoRa (STM32) and start the boot loader
+//----------------------------------------
+bool dfuLoRaReset(DEVICE_FIRMWARE_CTX * ctx, uint32_t currentMsec)
+{
+    // Connect ESP32 UART2 to LoRa UART2 via SW3 for configuration and bootloading/firmware updates
+    gpioExpanderSelectLoraConfigure();
+    serialInputClear(SerialForLoRa);
+
+    // Pull BOOT0 high to enter bootloader mode on reset
+    gpioExpanderLoraBootEnable();
+
+    // Power cycle the LoRa device to perform the reset and enter
+    // bootloader mode
+    dfuLoRaReset();
+
+    // Send 0x7F for auto-baud detection
+    return dfuStm32Autobaud(ctx);
+}
+
+#endif  // COMPILE_LORA