implemented samd ota class

Author: andreagilardoni

src/ota/implementation/OTASamd.cpp

@@ -1,4 +1,97 @@
+/*
+  This file is part of the ArduinoIoTCloud library.
+
+  Copyright (c) 2024 Arduino SA
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+*/
+
+#include <AIoTC_Config.h>
+
 #if defined(ARDUINO_ARCH_SAMD) && OTA_ENABLED
 #include "OTASamd.h"
 
+#include <Arduino_DebugUtils.h>
+#if OTA_STORAGE_SNU
+#  include <SNU.h>
+#  include <WiFiNINA.h> /* WiFiStorage */
+#endif
+
+SAMDOTACloudProcess::SAMDOTACloudProcess(MessageStream *ms)
+: OTACloudProcessInterface(ms){
+
+}
+
+OTACloudProcessInterface::State SAMDOTACloudProcess::resume(Message* msg) {
+  return OtaBegin;
+}
+
+OTACloudProcessInterface::State SAMDOTACloudProcess::startOTA() {
+  reset();
+  return Fetch;
+}
+
+OTACloudProcessInterface::State SAMDOTACloudProcess::fetch() {
+#if OTA_STORAGE_SNU
+  uint8_t nina_ota_err_code = 0;
+  if (!WiFiStorage.downloadOTA(this->context->url, &nina_ota_err_code)) {
+    DEBUG_VERBOSE("ArduinoIoTCloudTCP::%s error download to nina: %d", __FUNCTION__, nina_ota_err_code);
+    switch(static_cast<ninaOTAError>(nina_ota_err_code)) {
+    case ninaOTAError::Open:
+      return ErrorOpenUpdateFileFail;
+    case ninaOTAError::Length:
+      return OtaDownloadFail;
+    case ninaOTAError::CRC:
+      return OtaHeaderCrcFail;
+    case ninaOTAError::Rename:
+      return ErrorRenameFail;
+    default:
+      return OtaDownloadFail;
+    }
+  }
+#endif // OTA_STORAGE_SNU
+
+  return FlashOTA;
+}
+
+OTACloudProcessInterface::State SAMDOTACloudProcess::flashOTA() {
+  return Reboot;
+}
+
+OTACloudProcessInterface::State SAMDOTACloudProcess::reboot() {
+  NVIC_SystemReset();
+}
+
+void SAMDOTACloudProcess::reset() {
+#if OTA_STORAGE_SNU
+  WiFiStorage.remove("/fs/UPDATE.BIN.LZSS");
+  WiFiStorage.remove("/fs/UPDATE.BIN.LZSS.TMP");
+#endif // OTA_STORAGE_SNU
+}
+
+bool SAMDOTACloudProcess::isOtaCapable() {
+#if OTA_STORAGE_SNU
+  if (strcmp(WiFi.firmwareVersion(), "1.4.1") < 0) {
+    DEBUG_VERBOSE("ArduinoIoTCloudTCP::%s In order to be ready for cloud OTA, NINA firmware needs to be >= 1.4.1, current %s", __FUNCTION__, WiFi.firmwareVersion());
+    return false;
+  } else {
+    return true;
+  }
+#endif
+  return false;
+}
+
+extern void* __text_start__;
+extern void* __etext;
+extern void* __data_end__;
+extern void* __data_start__;
+
+void* SAMDOTACloudProcess::appStartAddress() { return &__text_start__; }
+
+uint32_t SAMDOTACloudProcess::appSize() {
+  return ((&__etext - &__text_start__) + (&__data_end__ - &__data_start__))*sizeof(void*);
+}
+
 #endif // defined(ARDUINO_ARCH_SAMD) && OTA_ENABLED

src/ota/implementation/OTASamd.h

@@ -1,21 +1,52 @@
+/*
+  This file is part of the ArduinoIoTCloud library.
+
+  Copyright (c) 2024 Arduino SA
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+*/
+
 #pragma once
 
-#include "src/ota/interface/OTAInterface.h"
+#include "ota/interface/OTAInterface.h"
 #include <Arduino_DebugUtils.h>
 
 class SAMDOTACloudProcess: public OTACloudProcessInterface {
 public:
-  STM32H7OTACloudProcess();
+  SAMDOTACloudProcess(MessageStream *ms);
+
+  virtual bool isOtaCapable() override;
 protected:
-  // we start the download and decompress process
-  virtual State fetch(Message* msg=nullptr);
+  virtual OTACloudProcessInterface::State resume(Message* msg=nullptr) override;
 
-  // when the download is completed we verify for integrity and correctness of the downloaded binary
-  // virtual State verifyOTA(Message* msg=nullptr); // TODO this may be performed inside download
+  // we are overriding the method of startOTA in order to download ota file on ESP32
+  virtual OTACloudProcessInterface::State startOTA() override;
+
+  // we start the download and decompress process
+  virtual OTACloudProcessInterface::State fetch() override;
 
   // whene the download is correctly finished we set the mcu to use the newly downloaded binary
-  virtual State flashOTA(Message* msg=nullptr);
+  virtual OTACloudProcessInterface::State flashOTA();
 
   // we reboot the device
-  virtual State reboot(Message* msg=nullptr);
+  virtual OTACloudProcessInterface::State reboot();
+
+  virtual void reset() override;
+
+  void* appStartAddress();
+  uint32_t appSize();
+
+  bool appFlashOpen()  { return true; }
+  bool appFlashClose() { return true; }
+
+private:
+  enum class ninaOTAError : int {
+    None            = 0,
+    Open            = 1,
+    Length          = 2,
+    CRC             = 3,
+    Rename          = 4,
+  };
 };