Merge pull request #256 from arduino-libraries/rp2040_ota

INITIAL: support OTA on Nano RP2040 Connect

Author: aentinger

extras/tools/bin2ota.py

@@ -24,6 +24,8 @@
     magic_number = 0x23418057.to_bytes(4,byteorder='little')
 elif board == "PORTENTA_H7_M7":
     magic_number = 0x2341025B.to_bytes(4,byteorder='little')
+elif board == "NANO_RP2040_CONNECT":
+    magic_number = 0x2341005E.to_bytes(4,byteorder='little')
 else:
     print ("Error,", board, "is not a supported board type")
     sys.exit()

src/AIoTC_Config.h

@@ -22,10 +22,6 @@
  * USER CONFIGURABLE DEFINES
  ******************************************************************************/
 
-#ifndef OTA_STORAGE_SFU
-  #define OTA_STORAGE_SFU         (0)
-#endif
-
 #ifndef NTP_USE_RANDOM_PORT
   #define NTP_USE_RANDOM_PORT     (1)
 #endif
@@ -94,6 +90,12 @@
   #define OTA_STORAGE_SNU         (0)
 #endif
 
+#if defined(ARDUINO_NANO_RP2040_CONNECT)
+  #define OTA_STORAGE_SFU         (1)
+#else
+  #define OTA_STORAGE_SFU         (0)
+#endif
+
 #ifdef ARDUINO_SAMD_MKRGSM1400
   #define OTA_STORAGE_SSU         (1)
 #else
@@ -143,4 +145,7 @@
 #define AIOT_CONFIG_TIMEOUT_FOR_LASTVALUES_SYNC_ms  (30000UL)
 #define AIOT_CONFIG_LASTVALUES_SYNC_MAX_RETRY_CNT      (10UL)
 
+#define AIOT_CONFIG_RP2040_OTA_HTTP_HEADER_RECEIVE_TIMEOUT_ms (10*1000UL)
+#define AIOT_CONFIG_RP2040_OTA_HTTP_DATA_RECEIVE_TIMEOUT_ms   (4*60*1000UL)
+
 #endif /* ARDUINO_AIOTC_CONFIG_H_ */

src/ArduinoIoTCloudTCP.cpp

@@ -160,7 +160,7 @@ int ArduinoIoTCloudTCP::begin(bool const enable_watchdog, String brokerAddress,
                   sha256_str += buf;
                 });
   DEBUG_VERBOSE("SHA256: %d bytes (of %d) read", bytes_read, app_size);
-#else
+#elif defined(ARDUINO_ARCH_SAMD)
   /* Calculate the SHA256 checksum over the firmware stored in the flash of the
    * MCU. Note: As we don't know the length per-se we read chunks of the flash
    * until we detect one containing only 0xFF (= flash erased). This only works
@@ -172,6 +172,13 @@ int ArduinoIoTCloudTCP::begin(bool const enable_watchdog, String brokerAddress,
    * range 0 to 0x2000, total flash size of 0x40000 bytes (256 kByte).
    */
   String const sha256_str = FlashSHA256::calc(0x2000, 0x40000 - 0x2000);
+#elif defined(ARDUINO_NANO_RP2040_CONNECT)
+  /* The maximum size of a RP2040 OTA update image is 1 MByte (that is 1024 *
+   * 1024 bytes or 0x100'000 bytes).
+   */
+  String const sha256_str = FlashSHA256::calc(XIP_BASE, 0x100000);
+#else
+# error "No method for SHA256 checksum calculation over application image defined for this architecture."
 #endif
   DEBUG_VERBOSE("SHA256: HASH(%d) = %s", strlen(sha256_str.c_str()), sha256_str.c_str());
   _ota_img_sha256 = sha256_str;
@@ -259,6 +266,10 @@ int ArduinoIoTCloudTCP::begin(bool const enable_watchdog, String brokerAddress,
   }
 #endif /* OTA_STORAGE_SNU */
 
+#if defined(ARDUINO_NANO_RP2040_CONNECT)
+  _ota_cap = true;
+#endif
+
 #ifdef BOARD_HAS_OFFLOADED_ECCX08
   if (String(WiFi.firmwareVersion()) < String("1.4.4")) {
     DEBUG_ERROR("ArduinoIoTCloudTCP::%s In order to connect to Arduino IoT Cloud, NINA firmware needs to be >= 1.4.4, current %s", __FUNCTION__, WiFi.firmwareVersion());
@@ -309,6 +320,16 @@ void ArduinoIoTCloudTCP::update()
   }
   _state = next_state;
 
+  /* This watchdog feed is actually needed only by the RP2040 CONNECT cause its
+   * maximum watchdog window is 8388ms; despite this we feed it for all 
+   * supported ARCH to keep code aligned.
+   */
+#ifdef ARDUINO_ARCH_SAMD
+  samd_watchdog_reset();
+#elif defined(ARDUINO_ARCH_MBED)
+  mbed_watchdog_reset();
+#endif
+
   /* Check for new data from the MQTT client. */
   if (_mqttClient.connected())
     _mqttClient.poll();
@@ -491,6 +512,7 @@ ArduinoIoTCloudTCP::State ArduinoIoTCloudTCP::handle_Connected()
     /* Request a OTA download if the hidden property
      * OTA request has been set.
      */
+
     if (_ota_req)
     {
       /* Clear the error flag. */
@@ -581,12 +603,16 @@ int ArduinoIoTCloudTCP::write(String const topic, byte const data[], int const l
 #if OTA_ENABLED
 void ArduinoIoTCloudTCP::onOTARequest()
 {
-  DEBUG_VERBOSE("ArduinoIoTCloudTCP::%s _ota_url = %s", __FUNCTION__, _ota_url.c_str());
+  DEBUG_INFO("ArduinoIoTCloudTCP::%s _ota_url = %s", __FUNCTION__, _ota_url.c_str());
 
 #ifdef ARDUINO_ARCH_SAMD
   _ota_error = samd_onOTARequest(_ota_url.c_str());
 #endif
 
+#ifdef ARDUINO_NANO_RP2040_CONNECT
+  _ota_error = rp2040_connect_onOTARequest(_ota_url.c_str());
+#endif
+
 #if defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_PORTENTA_H7_M4)
   _ota_error = portenta_h7_onOTARequest(_ota_url.c_str());
 #endif

src/utility/ota/FlashSHA256.cpp

@@ -45,11 +45,12 @@ String FlashSHA256::calc(uint32_t const start_addr, uint32_t const max_flash_siz
   sha256.begin();
 
   /* Read the first two chunks of flash. */
-  uint32_t flash_addr = start_addr;  
+  uint32_t flash_addr = start_addr;
+  uint32_t bytes_read = 0;
   memcpy(chunk, reinterpret_cast<const void *>(flash_addr), FLASH_READ_CHUNK_SIZE);
   flash_addr += FLASH_READ_CHUNK_SIZE;
 
-  for(; flash_addr < max_flash_size; flash_addr += FLASH_READ_CHUNK_SIZE)
+  for(; bytes_read < max_flash_size; flash_addr += FLASH_READ_CHUNK_SIZE)
   {
     /* Read the next chunk of memory. */
     memcpy(next_chunk, reinterpret_cast<const void *>(flash_addr), FLASH_READ_CHUNK_SIZE);
@@ -75,13 +76,15 @@ String FlashSHA256::calc(uint32_t const start_addr, uint32_t const max_flash_siz
       }
       /* Update with the remaining bytes. */
       sha256.update(chunk, valid_bytes_in_chunk);
+      bytes_read += valid_bytes_in_chunk;
       break;
     }
 
     /* We've read a normal segment with the next segment not containing
      * any erased elements, just update the SHA256 hash calcultion.
      */
     sha256.update(chunk, FLASH_READ_CHUNK_SIZE);
+    bytes_read += FLASH_READ_CHUNK_SIZE;
 
     /* Copy next_chunk to chunk. */
     memcpy(chunk, next_chunk, FLASH_READ_CHUNK_SIZE);
@@ -100,7 +103,7 @@ String FlashSHA256::calc(uint32_t const start_addr, uint32_t const max_flash_siz
                   sha256_str += buf;
                 });
   /* Do some debug printout. */
-  DEBUG_VERBOSE("SHA256: %d bytes read", flash_addr);
+  DEBUG_VERBOSE("SHA256: %d bytes read", bytes_read);
   return sha256_str;
 }