adjusting OTA.h

Author: andreagilardoni

src/ota/OTA.h

@@ -0,0 +1,60 @@
+/*
+  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 "AIoTC_Config.h"
+#if OTA_ENABLED
+
+#include "OTAConfig.h"
+#ifdef ARDUINO_ARCH_SAMD
+
+#include "implementation/OTASamd.h"
+using ArduinoCloudOTA = SAMDOTACloudProcess;
+
+// TODO Check if a macro already exist
+// constexpr uint32_t OtaMagicNumber = 0x23418054; // MKR_WIFI_1010
+constexpr uint32_t OtaMagicNumber = 0x23418057; // NANO_33_IOT
+
+#elif defined(ARDUINO_NANO_RP2040_CONNECT)
+#include "implementation/OTANanoRP2040.h"
+using ArduinoCloudOTA = NANO_RP2040OTACloudProcess;
+
+// TODO Check if a macro already exist
+constexpr uint32_t OtaMagicNumber = 0x2341005E; // TODO check this value is correct
+
+#elif defined(BOARD_STM32H7)
+#include "implementation/OTASTM32H7.h"
+using ArduinoCloudOTA = STM32H7OTACloudProcess;
+
+constexpr uint32_t OtaMagicNumber = ARDUINO_PORTENTA_OTA_MAGIC;
+
+#elif defined(ARDUINO_ARCH_ESP32)
+#include "implementation/OTAEsp32.h"
+using ArduinoCloudOTA = ESP32OTACloudProcess;
+
+#if defined (ARDUINO_NANO_ESP32)
+  constexpr uint32_t OtaMagicNumber = 0x23410070;
+#else
+  constexpr uint32_t OtaMagicNumber = 0x45535033;
+#endif
+
+#elif defined(ARDUINO_UNOR4_WIFI)
+
+#include "implementation/OTAUnoR4.h"
+using ArduinoCloudOTA = UNOR4OTACloudProcess;
+
+// TODO Check if a macro already exist
+constexpr uint32_t OtaMagicNumber = 0x234110020; // TODO check this value is correct
+
+#else
+#error "This Board doesn't support OTA"
+#endif
+
+#endif // OTA_ENABLED

src/ota/OTAConfig.h

@@ -0,0 +1,47 @@
+/*
+  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
+
+#ifdef ARDUINO_ARCH_SAMD
+#define OFFLOADED_DOWNLOAD
+
+#elif defined(ARDUINO_NANO_RP2040_CONNECT)
+
+#elif defined(BOARD_STM32H7)
+
+#if defined(ARDUINO_PORTENTA_H7_M7)
+  #define ARDUINO_PORTENTA_OTA_MAGIC 0x2341025b
+  #define ARDUINO_PORTENTA_OTA_SDMMC_SUPPORT
+  #define ARDUINO_PORTENTA_OTA_QSPI_SUPPORT
+#endif
+
+#if defined(ARDUINO_NICLA_VISION)
+  #define ARDUINO_PORTENTA_OTA_MAGIC 0x2341025f
+  #define ARDUINO_PORTENTA_OTA_QSPI_SUPPORT
+#endif
+
+#if defined(ARDUINO_OPTA)
+  #define ARDUINO_PORTENTA_OTA_MAGIC 0x23410064
+  #define ARDUINO_PORTENTA_OTA_QSPI_SUPPORT
+#endif
+
+#if defined(ARDUINO_GIGA)
+  #define ARDUINO_PORTENTA_OTA_MAGIC 0x23410266
+  #define ARDUINO_PORTENTA_OTA_QSPI_SUPPORT
+#endif
+
+
+#elif defined(ARDUINO_ARCH_ESP32)
+#define OTA_BASIC_AUTH
+
+#elif defined(ARDUINO_UNOR4_WIFI)
+#define OFFLOADED_DOWNLOAD
+#endif

src/ota/OTATypes.h

@@ -0,0 +1,78 @@
+/*
+  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 "AIoTC_Config.h"
+
+#if OTA_ENABLED
+#include <stdint.h>
+
+namespace ota {
+  enum class OTAError : int16_t {
+    None                  = 0,
+    NoCapableBootloader   = -1,
+    NoOtaStorage          = -2,
+    OtaStorageInit        = -3,
+    OtaStorageOpen        = -4,
+    OtaHeaderLength       = -5,
+    OtaHeaderCrc          = -6,
+    OtaHeaterMagicNumber  = -7,
+    ParseHttpHeader       = -8,
+    UrlParseError         = -9,
+    ServerConnectError    = -10,
+    HttpHeaderError       = -11,
+    OtaDownload           = -12,
+    OtaHeaderTimeout      = -13,
+    HttpResponse          = -14,
+    OtaStorageEnd         = -15,
+    StorageConfig         = -16,
+    Library               = -17,
+    Modem                 = -18,
+    ErrorOpenUpdateFile   = -19,
+    ErrorWriteUpdateFile  = -20,
+    ErrorReformat         = -21,
+    ErrorUnmount          = -22,
+    ErrorRename           = -23,
+    CaStorageInit         = -24,
+    CaStorageOpen         = -25,
+  };
+
+#ifndef OFFLOADED_DOWNLOAD
+  union HeaderVersion {
+    struct __attribute__((packed)) {
+      uint32_t header_version    :  6;
+      uint32_t compression       :  1;
+      uint32_t signature         :  1;
+      uint32_t spare             :  4;
+      uint32_t payload_target    :  4;
+      uint32_t payload_major     :  8;
+      uint32_t payload_minor     :  8;
+      uint32_t payload_patch     :  8;
+      uint32_t payload_build_num : 24;
+    } field;
+    uint8_t buf[sizeof(field)];
+    static_assert(sizeof(buf) == 8, "Error: sizeof(HEADER.VERSION) != 8");
+  };
+
+  union OTAHeader {
+    struct __attribute__((packed)) {
+      uint32_t len;
+      uint32_t crc32;
+      uint32_t magic_number;
+      HeaderVersion hdr_version;
+    } header;
+    uint8_t buf[sizeof(header)];
+    static_assert(sizeof(buf) == 20, "Error: sizeof(HEADER) != 20");
+  };
+#endif // OFFLOADED_DOWNLOAD
+}
+
+#endif // OTA_ENABLED