New modular OTA structure

.github/.cSpellWords.txt

@@ -39,6 +39,7 @@ coef
 compatibil
 coremqtt
 COSE
+coverity
 CLRF
 Cqqpk
 CSRS
@@ -147,6 +148,7 @@ Merkle
 Mfcc
 MFCC
 MFLN
+MISRA
 mlek
 mqtt
 mqttconfig

.gitmodules

@@ -43,9 +43,6 @@
 [submodule "open_iot_sdk_toolchain"]
 	path = components/tools/open_iot_sdk_toolchain/library
 	url = https://git.gitlab.arm.com/iot/open-iot-sdk/toolchain.git
-[submodule "ota_for_aws_iot_embedded_sdk"]
-	path = components/aws_iot/ota_for_aws_iot_embedded_sdk/library
-	url = https://github.com/aws/ota-for-aws-iot-embedded-sdk.git
 [submodule "tinycbor"]
 	path = components/aws_iot/tinycbor/library
 	url = https://github.com/intel/tinycbor.git
@@ -76,3 +73,9 @@
 [submodule "googletest"]
 	path = components/tools/googletest/library
 	url = https://github.com/google/googletest.git
+[submodule "components/aws_iot/jobs_for_aws_iot_embedded_sdk/library"]
+	path = components/aws_iot/jobs_for_aws_iot_embedded_sdk/library
+	url = https://github.com/aws/Jobs-for-AWS-IoT-embedded-sdk.git
+[submodule "components/aws_iot/aws_iot_core_mqtt_file_streams_embedded_c/library"]
+	path = components/aws_iot/aws_iot_core_mqtt_file_streams_embedded_c/library
+	url = https://github.com/aws/aws-iot-core-mqtt-file-streams-embedded-c/

applications/freertos_iot_libraries_tests/CMakeLists.txt

@@ -108,7 +108,7 @@ target_link_libraries(${CMAKE_PROJECT_NAME}
         freertos-ota-pal-psa
         fri-bsp
         helpers-events
-        ota-for-aws-iot-embedded-sdk
+        ota-update
         provisioning-lib
         mbedtls
         tfm-ns-interface

applications/freertos_iot_libraries_tests/configs/aws_configs/CMakeLists.txt

@@ -31,8 +31,3 @@ target_include_directories(freertos-pkcs11-psa-config
     INTERFACE
         .
 )
-
-target_include_directories(ota-for-aws-iot-embedded-sdk-config
-    INTERFACE
-        .
-)

applications/freertos_iot_libraries_tests/configs/aws_configs/MQTTFileDownloader_config.h

@@ -0,0 +1,31 @@
+/*
+ * Copyright Amazon.com, Inc. and its affiliates. All Rights Reserved.
+ * Copyright 2024 Arm Limited and/or its affiliates
+ * <[email protected]>
+ *
+ * SPDX-License-Identifier: MIT
+ * Licensed under the MIT License. See the LICENSE accompanying this file
+ * for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+/**
+ * @file MQTTFileDownloader_config.h
+ * @brief MQTT File Streams options.
+ */
+
+#ifndef MQTT_FILE_DOWNLOADER_CONFIG_H
+#define MQTT_FILE_DOWNLOADER_CONFIG_H
+
+/* Standard includes */
+#include <stdint.h>
+
+/**
+ * @ingroup mqtt_file_downloader_const_types
+ * @brief Configure the Maximum size of the data payload. The
+ * smallest value is 256 bytes, maximum is 128KB. For more see
+ * https://docs.aws.amazon.com/general/latest/gr/iot-core.html
+ */
+#define mqttFileDownloader_CONFIG_BLOCK_SIZE    4096U
+
+#endif /* MQTT_FILE_DOWNLOADER_CONFIG_H */

applications/helpers/CMakeLists.txt

@@ -2,10 +2,12 @@
 # <[email protected]>
 # SPDX-License-Identifier: MIT
 
+add_subdirectory(crt_helpers)
 add_subdirectory(device_advisor)
 add_subdirectory(events)
 add_subdirectory(hdlcd)
 add_subdirectory(logging)
+add_subdirectory(ota_orchestrator)
 add_subdirectory(provisioning)
 # sntp helper library depends on FreeRTOS-Plus-TCP connectivity stack as it
 # includes `FreeRTOS_IP.h` header file in one of its source files (sntp_client_task.c),

applications/helpers/crt_helpers/CMakeLists.txt

@@ -0,0 +1,18 @@
+# Copyright 2024 Arm Limited and/or its affiliates
+# <[email protected]>
+# SPDX-License-Identifier: MIT
+
+if(BUILD_TESTING AND NOT CMAKE_CROSSCOMPILING)
+    # Left empty for future mocks.
+else()
+    add_library(crt-helpers)
+
+    target_include_directories(crt-helpers
+        PUBLIC
+            inc/)
+
+    target_sources(crt-helpers
+        PUBLIC
+            src/app_strnlen.c
+    )
+endif()

applications/helpers/crt_helpers/inc/app_strnlen.h

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2021-2024, Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ */
+
+#ifndef APP_STRNLEN_H
+
+#include <stddef.h>
+
+/**
+ * @brief Determine the length of a fixed-size string, excluding the terminating
+ * null byte ('\0'), and at most `maxlen`.
+ *
+ * @param[in] s The string to determine the length of.
+ * @param[in] maxlen The maximum number of characters of the string `s` that
+ * should be checked.
+ *
+ * @return The length of the string, up to `maxlen`.
+ */
+size_t app_strnlen( const char * s,
+                    size_t maxlen );
+
+#endif

applications/helpers/crt_helpers/src/app_strnlen.c

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2021-2024, Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ */
+
+/*
+ * This file is based on
+ * https://git.trustedfirmware.org/plugins/gitiles/TF-M/trusted-firmware-m.git/+/c9352b59f2a501b5af3f648b3fc91065993c002f/secure_fw/partitions/lib/runtime/crt_strnlen.c
+ */
+
+#include <stddef.h>
+
+size_t app_strnlen( const char * s,
+                    size_t maxlen )
+{
+    size_t idx;
+
+    if( s == NULL )
+    {
+        return 0;
+    }
+
+    for( idx = 0; idx < maxlen; idx++ )
+    {
+        if( s[ idx ] == '\0' )
+        {
+            return idx;
+        }
+    }
+
+    return idx;
+}

applications/helpers/ota_orchestrator/CMakeLists.txt

@@ -0,0 +1,33 @@
+# Copyright 2024 Arm Limited and/or its affiliates
+# <[email protected]>
+# SPDX-License-Identifier: MIT
+
+if(BUILD_TESTING AND NOT CMAKE_CROSSCOMPILING)
+    # Left empty for future mocks.
+else()
+    add_library(ota-update
+        src/mqtt_helpers.c
+        src/ota_orchestrator_helpers.c
+        src/ota_os_freertos.c
+        src/ota_orchestrator.c
+    )
+
+    target_include_directories(ota-update
+        PUBLIC
+            inc/
+    )
+
+    target_link_libraries(ota-update
+        jobs-for-aws-iot-embedded-sdk
+        aws-iot-core-mqtt-file-streams-embedded-c
+        freertos_kernel
+        corejson
+        coremqtt
+        coremqtt-agent
+        tinycbor
+        freertos-ota-pal-psa
+        helpers-events
+        backoff-algorithm
+        crt-helpers
+    )
+endif()

applications/helpers/ota_orchestrator/inc/mqtt_helpers.h

@@ -0,0 +1,78 @@
+/* Copyright 2023-2024 Arm Limited and/or its affiliates
+ * <[email protected]>
+ * SPDX-License-Identifier: MIT
+ */
+
+#ifndef MQTT_HELPERS_H
+#define MQTT_HELPERS_H
+
+/* Standard includes. */
+#include <stdlib.h>
+#include <stdint.h>
+
+/**
+ * @ingroup ota_enum_types
+ * @brief The OTA MQTT interface return status.
+ */
+typedef enum OtaMqttStatus
+{
+    OtaMqttSuccess = 0,          /*!< @brief OTA MQTT interface success. */
+    OtaMqttPublishFailed = 0xa0, /*!< @brief Attempt to publish a MQTT message failed. */
+    OtaMqttSubscribeFailed,      /*!< @brief Failed to subscribe to a topic. */
+    OtaMqttUnsubscribeFailed     /*!< @brief Failed to unsubscribe from a topic. */
+} OtaMqttStatus_t;
+
+/**
+ * @brief Subscribe to a specified topic.
+ *
+ * Precondition: pTopicFilter is not null.
+ *
+ * @param[in] pTopicFilter The topic filter to subscribe to.
+ * @param[in] topicFilterLength Length of the topic filter.
+ * @param[in] ucQoS Quality of Service (QoS), the level of reliability for
+ * message delivery. Can be 0, 1 or 2.
+ *
+ * @return OtaMqttSuccess if the subscribe completed successfully, otherwise
+ * OtaMqttSubscribeFailed.
+ */
+OtaMqttStatus_t prvMQTTSubscribe( const char * pTopicFilter,
+                                  uint16_t topicFilterLength,
+                                  uint8_t ucQoS );
+
+/**
+ * @brief Publish a message to a specified topic.
+ * *
+ * @param[in] pacTopic The topic that the message should be published to.
+ * @param[in] topicLen Length of the topic.
+ * @param[in] pMsg The message to be published.
+ * @param[in] msgSize Size of the message.
+ * @param[in] ucQoS Quality of Service (QoS), the level of reliability for
+ * message delivery. Can be 0, 1 or 2.
+ *
+ * @return OtaMqttSuccess if the subscribe completed successfully, otherwise
+ * OtaMqttSubscribeFailed.
+ */
+OtaMqttStatus_t prvMQTTPublish( const char * const pacTopic,
+                                uint16_t topicLen,
+                                const char * pMsg,
+                                uint32_t msgSize,
+                                uint8_t ucQoS );
+
+/**
+ * @brief Unsubscribe from a specified topic.
+ *
+ * Precondition: pTopicFilter is not null.
+ *
+ * @param[in] pTopicFilter The topic filter to unsubscribe from.
+ * @param[in] topicFilterLength Length of the topic filter.
+ * @param[in] ucQoS Quality of Service (QoS), the level of reliability for
+ * message delivery. Can be 0, 1 or 2.
+ *
+ * @return OtaMqttSuccess if the unsubscribe completed successfully, otherwise
+ * OtaMqttSubscribeFailed.
+ */
+OtaMqttStatus_t prvMQTTUnsubscribe( const char * pTopicFilter,
+                                    uint16_t topicFilterLength,
+                                    uint8_t ucQoS );
+
+#endif /* MQTT_HELPERS_H */

applications/helpers/ota_orchestrator/inc/ota_appversion32.h

@@ -0,0 +1,88 @@
+/*
+ * AWS IoT Over-the-air Update v3.4.0
+ * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
+ * Copyright 2024 Arm Limited and/or its affiliates
+ * <[email protected]>
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+/**
+ * @file ota_appversion32.h
+ * @brief Structure to represent the application build version.
+ */
+
+#ifndef IOT_APPVERSION32_H
+#define IOT_APPVERSION32_H
+
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+    extern "C" {
+#endif
+/* *INDENT-ON* */
+
+/* Standard includes. */
+#include <stdint.h>
+
+/**
+ * @ingroup ota_struct_types
+ * @brief Application version structure.
+ *
+ */
+typedef struct
+{
+    /* MISRA Ref 19.2.1 [Unions] */
+    /* More details at: https://github.com/aws/ota-for-aws-iot-embedded-sdk/blob/main/MISRA.md#rule-192 */
+    /* coverity[misra_c_2012_rule_19_2_violation] */
+    union
+    {
+        #if ( defined( __BYTE_ORDER__ ) && defined( __ORDER_LITTLE_ENDIAN__ ) && ( __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ ) ) || ( __little_endian__ == 1 ) || WIN32 || ( __BYTE_ORDER == __LITTLE_ENDIAN )
+            struct version
+            {
+                uint16_t build; /*!< @brief Build of the firmware (Z in firmware version Z.Y.X). */
+                uint8_t minor;  /*!< @brief Minor version number of the firmware (Y in firmware version Z.Y.X). */
+
+                uint8_t major;  /*!< @brief Major version number of the firmware (X in firmware version Z.Y.X). */
+            } x;                /*!< @brief Version number of the firmware. */
+        #elif ( defined( __BYTE_ORDER__ ) && defined( __ORDER_BIG_ENDIAN__ ) && __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__ ) || ( __big_endian__ == 1 ) || ( __BYTE_ORDER == __BIG_ENDIAN )
+            struct version
+            {
+                uint8_t major;  /*!< @brief Major version number of the firmware (X in firmware version X.Y.Z). */
+                uint8_t minor;  /*!< @brief Minor version number of the firmware (Y in firmware version X.Y.Z). */
+
+                uint16_t build; /*!< @brief Build of the firmware (Z in firmware version X.Y.Z). */
+            } x;                /*!< @brief Version number of the firmware. */
+        #else /* if ( defined( __BYTE_ORDER__ ) && defined( __ORDER_LITTLE_ENDIAN__ ) && __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ ) || ( __little_endian__ == 1 ) || WIN32 || ( __BYTE_ORDER == __LITTLE_ENDIAN ) */
+        #error "Unable to determine byte order!"
+        #endif /* if ( defined( __BYTE_ORDER__ ) && defined( __ORDER_LITTLE_ENDIAN__ ) && __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ ) || ( __little_endian__ == 1 ) || WIN32 || ( __BYTE_ORDER == __LITTLE_ENDIAN ) */
+        uint32_t unsignedVersion32;
+        int32_t signedVersion32;
+    } u; /*!< @brief Version based on configuration in big endian or little endian. */
+} AppVersion32_t;
+
+extern AppVersion32_t appFirmwareVersion; /*!< @brief Making the version number available globally through external linkage. */
+
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+    }
+#endif
+/* *INDENT-ON* */
+
+#endif /* ifndef IOT_APPVERSION32_H */