Skip to content

Commit

Permalink
Reorder Arduino Nano RP2040 OTA error codes
Browse files Browse the repository at this point in the history
  • Loading branch information
pennam committed Oct 23, 2023
1 parent 6a9acc2 commit 2753050
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 27 deletions.
47 changes: 36 additions & 11 deletions src/utility/ota/OTA-nano-rp2040.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,31 @@
#include "FlashIAPBlockDevice.h"
#include "utility/ota/FlashSHA256.h"

/******************************************************************************
* DEFINES
******************************************************************************/

#define RP2040_OTA_ERROR_BASE (-100)

/******************************************************************************
* TYPEDEF
******************************************************************************/

enum class rp2040OTAError : int
{
None = 0,
ErrorFlashInit = RP2040_OTA_ERROR_BASE - 3,
ErrorParseHttpHeader = RP2040_OTA_ERROR_BASE - 8,
UrlParseError = RP2040_OTA_ERROR_BASE - 9,
ServerConnectError = RP2040_OTA_ERROR_BASE - 10,
HttpHeaderError = RP2040_OTA_ERROR_BASE - 11,
HttpDataError = RP2040_OTA_ERROR_BASE - 12,
ErrorOpenUpdateFile = RP2040_OTA_ERROR_BASE - 19,
ErrorWriteUpdateFile = RP2040_OTA_ERROR_BASE - 20,
ErrorReformat = RP2040_OTA_ERROR_BASE - 21,
ErrorUnmount = RP2040_OTA_ERROR_BASE - 22,
};

/******************************************************************************
* FUNCTION DEFINITION
******************************************************************************/
Expand Down Expand Up @@ -92,7 +117,7 @@ int rp2040_connect_onOTARequest(char const * ota_url)
if ((err = flash.init()) < 0)
{
DEBUG_ERROR("%s: flash.init() failed with %d", __FUNCTION__, err);
return static_cast<int>(OTAError::RP2040_ErrorFlashInit);
return static_cast<int>(rp2040OTAError::RP2040_ErrorFlashInit);
}

watchdog_reset();
Expand All @@ -105,7 +130,7 @@ int rp2040_connect_onOTARequest(char const * ota_url)
if ((err = fs.reformat(&flash)) != 0)
{
DEBUG_ERROR("%s: fs.reformat() failed with %d", __FUNCTION__, err);
return static_cast<int>(OTAError::RP2040_ErrorReformat);
return static_cast<int>(rp2040OTAError::RP2040_ErrorReformat);
}

watchdog_reset();
Expand All @@ -115,7 +140,7 @@ int rp2040_connect_onOTARequest(char const * ota_url)
{
DEBUG_ERROR("%s: fopen() failed", __FUNCTION__);
fclose(file);
return static_cast<int>(OTAError::RP2040_ErrorOpenUpdateFile);
return static_cast<int>(rp2040OTAError::RP2040_ErrorOpenUpdateFile);
}

watchdog_reset();
Expand All @@ -133,7 +158,7 @@ int rp2040_connect_onOTARequest(char const * ota_url)
} else {
DEBUG_ERROR("%s: Failed to parse OTA URL %s", __FUNCTION__, ota_url);
fclose(file);
return static_cast<int>(OTAError::RP2040_UrlParseError);
return static_cast<int>(rp2040OTAError::RP2040_UrlParseError);
}

watchdog_reset();
Expand All @@ -142,7 +167,7 @@ int rp2040_connect_onOTARequest(char const * ota_url)
{
DEBUG_ERROR("%s: Connection failure with OTA storage server %s", __FUNCTION__, url.host_.c_str());
fclose(file);
return static_cast<int>(OTAError::RP2040_ServerConnectError);
return static_cast<int>(rp2040OTAError::RP2040_ServerConnectError);
}

watchdog_reset();
Expand Down Expand Up @@ -179,7 +204,7 @@ int rp2040_connect_onOTARequest(char const * ota_url)
{
DEBUG_ERROR("%s: Error receiving HTTP header %s", __FUNCTION__, is_http_header_timeout ? "(timeout)":"");
fclose(file);
return static_cast<int>(OTAError::RP2040_HttpHeaderError);
return static_cast<int>(rp2040OTAError::RP2040_HttpHeaderError);
}

/* Extract concent length from HTTP header. A typical entry looks like
Expand All @@ -190,7 +215,7 @@ int rp2040_connect_onOTARequest(char const * ota_url)
{
DEBUG_ERROR("%s: Failure to extract content length from http header", __FUNCTION__);
fclose(file);
return static_cast<int>(OTAError::RP2040_ErrorParseHttpHeader);
return static_cast<int>(rp2040OTAError::RP2040_ErrorParseHttpHeader);
}
/* Find start of numerical value. */
char * ptr = const_cast<char *>(content_length_ptr);
Expand Down Expand Up @@ -219,7 +244,7 @@ int rp2040_connect_onOTARequest(char const * ota_url)
{
DEBUG_ERROR("%s: Writing of firmware image to flash failed", __FUNCTION__);
fclose(file);
return static_cast<int>(OTAError::RP2040_ErrorWriteUpdateFile);
return static_cast<int>(rp2040OTAError::RP2040_ErrorWriteUpdateFile);
}

bytes_received++;
Expand All @@ -229,7 +254,7 @@ int rp2040_connect_onOTARequest(char const * ota_url)
if (bytes_received != content_length_val) {
DEBUG_ERROR("%s: Error receiving HTTP data %s (%d bytes received, %d expected)", __FUNCTION__, is_http_data_timeout ? "(timeout)":"", bytes_received, content_length_val);
fclose(file);
return static_cast<int>(OTAError::RP2040_HttpDataError);
return static_cast<int>(rp2040OTAError::RP2040_HttpDataError);
}

DEBUG_INFO("%s: %d bytes received", __FUNCTION__, ftell(file));
Expand All @@ -239,15 +264,15 @@ int rp2040_connect_onOTARequest(char const * ota_url)
if ((err = fs.unmount()) != 0)
{
DEBUG_ERROR("%s: fs.unmount() failed with %d", __FUNCTION__, err);
return static_cast<int>(OTAError::RP2040_ErrorUnmount);
return static_cast<int>(rp2040OTAError::RP2040_ErrorUnmount);
}

/* Perform the reset to reboot to SFU. */
mbed_watchdog_trigger_reset();
/* If watchdog is enabled we should not reach this point */
NVIC_SystemReset();

return static_cast<int>(OTAError::None);
return static_cast<int>(rp2040OTAError::None);
}

String rp2040_connect_getOTAImageSHA256()
Expand Down
16 changes: 0 additions & 16 deletions src/utility/ota/OTA.h
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,6 @@
#include <Arduino.h>
#include <Arduino_ConnectionHandler.h>

/******************************************************************************
* DEFINES
******************************************************************************/

#define RP2040_OTA_ERROR_BASE (-100)

/******************************************************************************
* TYPEDEF
******************************************************************************/
Expand All @@ -42,16 +36,6 @@ enum class OTAError : int
{
None = 0,
DownloadFailed = 1,
RP2040_UrlParseError = RP2040_OTA_ERROR_BASE - 0,
RP2040_ServerConnectError = RP2040_OTA_ERROR_BASE - 1,
RP2040_HttpHeaderError = RP2040_OTA_ERROR_BASE - 2,
RP2040_HttpDataError = RP2040_OTA_ERROR_BASE - 3,
RP2040_ErrorOpenUpdateFile = RP2040_OTA_ERROR_BASE - 4,
RP2040_ErrorWriteUpdateFile = RP2040_OTA_ERROR_BASE - 5,
RP2040_ErrorParseHttpHeader = RP2040_OTA_ERROR_BASE - 6,
RP2040_ErrorFlashInit = RP2040_OTA_ERROR_BASE - 7,
RP2040_ErrorReformat = RP2040_OTA_ERROR_BASE - 8,
RP2040_ErrorUnmount = RP2040_OTA_ERROR_BASE - 9,
};

/******************************************************************************
Expand Down

0 comments on commit 2753050

Please sign in to comment.