Update the corMQTT Submodule Pointer (#64)

* Include core_mqtt_config_defaults.h in subscrption_manager.h for logging

* Add versioning control in demo_config.h

* Define macro for not using custom config for mqtt-agent

* Set the writev transport interface as it was added in the later versions of coreMQTT

* [TEMP] Update the coreMQTT-Agent submodule pointer which has the updated coreMQTT submodule pointer

* [TEMP] Update coreMQTT-Agent submodule pointer to the one with coverity updates

* Add a compiler flag to define the __int64_t_defined macro to solve the bug in the latest ARM GCC toolchain

* Fix Formating Issues

* Add spell check files

* Fix Spellings

* Fix Spellings

* Remove the AppVersion numbers form source files and add in demo_config.h

* Update coreMQTT-Agent Submodule pointer to the upstream mainline

Author: DakshitBabbar

source/lexicon.txt renamed to .github/.cSpellWords.txt

@@ -253,3 +253,8 @@ xtaskcreate
 xtaskgettickcount
 xtasknotify
 xtasktonotify
+optim
+drbg
+ecdh
+mqttexample
+otaexample

build/Cortex-M3_MPS2_QEMU_GCC/Makefile

@@ -20,8 +20,11 @@ MAKE = make
 #mbedTLS is built to an archive to speed up the application build.
 MBED_TLS_LIB = $(OUTPUT_DIR)/mbedTLS/mbedTLS.a
 
+# -D__int64_t_defined=1 hack is needed to address the following
+# bug - https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=953844.
 CFLAGS += $(INCLUDE_DIRS) -nostartfiles -ffreestanding -mthumb -mcpu=cortex-m3 \
 		  -Wall -Wextra -g3 -O0 -ffunction-sections -fdata-sections \
+		  -D__int64_t_defined=1 \
 		  -DMBEDTLS_CONFIG_FILE='<mbedtls_config.h>' -MMD -MP -MF"$(@:%.o=%.d)" -MT $@
 
 #must be the first include paths to ensure the correct FreeRTOSConfig.h is used.

lib/FreeRTOS/coreMQTT-Agent

@@ -71,4 +71,9 @@
  */
 #define MQTT_AGENT_NETWORK_BUFFER_SIZE               ( 5000 )
 
+/**
+ * @brief No custom config is used for the coreMQTT-Agent
+ */
+#define MQTT_AGENT_DO_NOT_USE_CUSTOM_CONFIG
+
 #endif /* ifndef CORE_MQTT_CONFIG_H */

source/configuration-files/core_mqtt_config.h

@@ -338,8 +338,8 @@
  * @brief The MQTT metrics string expected by AWS IoT.
  */
 #define AWS_IOT_METRICS_STRING                                 \
-    "?SDK=" democonfigOS_NAME "&Version=" democonfigOS_VERSION \
-    "&Platform=" democonfigHARDWARE_PLATFORM_NAME "&MQTTLib=" democonfigMQTT_LIB
+        "?SDK=" democonfigOS_NAME "&Version=" democonfigOS_VERSION \
+        "&Platform=" democonfigHARDWARE_PLATFORM_NAME "&MQTTLib=" democonfigMQTT_LIB
 
 /**
  * @brief The length of the MQTT metrics string expected by AWS IoT.
@@ -367,5 +367,14 @@
  */
 #define democonfigBROKER_ENDPOINT_LENGTH      ( ( uint16_t ) ( sizeof( democonfigMQTT_BROKER_ENDPOINT ) - 1 ) )
 
+/**
+ * @brief The version for the firmware which is running. OTA agent uses this
+ * version number to perform anti-rollback validation. The firmware version for the
+ * download image should be higher than the current version, otherwise the new image is
+ * rejected in self test phase.
+ */
+#define APP_VERSION_MAJOR                     0
+#define APP_VERSION_MINOR                     9
+#define APP_VERSION_BUILD                     2
 
 #endif /* DEMO_CONFIG_H */

source/configuration-files/demo_config.h

@@ -0,0 +1,28 @@
+---
+$schema: https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json
+version: '0.2'
+# Allows things like stringLength
+allowCompoundWords: true
+
+# Read files not to spell check from the git ignore
+useGitignore: true
+
+#  Language settings for C
+languageSettings:
+  - caseSensitive: false
+    enabled: true
+    languageId: c
+    locale: "*"
+
+# Add a dictionary, and the path to the word list
+dictionaryDefinitions:
+  - name: core-mqtt-agent-demos-words
+    path: '.github/.cSpellWords.txt'
+    addWords: true
+
+dictionaries:
+  - core-mqtt-agent-demos-words
+
+# Paths and files to ignore
+ignorePaths:
+  - 'directories.txt'

source/cspell.config.yaml

@@ -52,68 +52,68 @@
 
 /* Formats used to generate the JSON report. */
 #define reportbuilderJSON_PORT_OBJECT_FORMAT \
-    "{"                                      \
-    "\"%s\": %u"                             \
-    "},"
+        "{"                                      \
+        "\"%s\": %u"                             \
+        "},"
 
 #define reportbuilderJSON_CONNECTION_OBJECT_FORMAT \
-    "{"                                            \
-    "\"%s\": %hu,"                                 \
-    "\"%s\": \"%lu.%lu.%lu.%lu:%hu\""              \
-    "},"
+        "{"                                            \
+        "\"%s\": %hu,"                                 \
+        "\"%s\": \"%lu.%lu.%lu.%lu:%hu\""              \
+        "},"
 
 #define reportbuilderJSON_REPORT_FORMAT_PART1 \
-    "{"                                       \
-    "\"%s\": {"                               \
-    "\"%s\": %lu,"                            \
-    "\"%s\": \"%lu.%lu\""                     \
-    "},"                                      \
-    "\"%s\": {"                               \
-    "\"%s\": {"                               \
-    "\"%s\": "
+        "{"                                       \
+        "\"%s\": {"                               \
+        "\"%s\": %lu,"                            \
+        "\"%s\": \"%lu.%lu\""                     \
+        "},"                                      \
+        "\"%s\": {"                               \
+        "\"%s\": {"                               \
+        "\"%s\": "
 
 #define reportbuilderJSON_REPORT_FORMAT_PART2 \
-    ","                                       \
-    "\"%s\": %lu"                             \
-    "},"                                      \
-    "\"%s\": {"                               \
-    "\"%s\": "
+        ","                                       \
+        "\"%s\": %lu"                             \
+        "},"                                      \
+        "\"%s\": {"                               \
+        "\"%s\": "
 
 #define reportbuilderJSON_REPORT_FORMAT_PART3 \
-    ","                                       \
-    "\"%s\": %lu"                             \
-    "},"                                      \
-    "\"%s\": {"                               \
-    "\"%s\": %lu,"                            \
-    "\"%s\": %lu,"                            \
-    "\"%s\": %lu,"                            \
-    "\"%s\": %lu"                             \
-    "},"                                      \
-    "\"%s\": {"                               \
-    "\"%s\": {"                               \
-    "\"%s\": "
+        ","                                       \
+        "\"%s\": %lu"                             \
+        "},"                                      \
+        "\"%s\": {"                               \
+        "\"%s\": %lu,"                            \
+        "\"%s\": %lu,"                            \
+        "\"%s\": %lu,"                            \
+        "\"%s\": %lu"                             \
+        "},"                                      \
+        "\"%s\": {"                               \
+        "\"%s\": {"                               \
+        "\"%s\": "
 
 #define reportbuilderJSON_REPORT_FORMAT_PART4 \
-    ","                                       \
-    "\"%s\": %lu"                             \
-    "}"                                       \
-    "}"                                       \
-    "},"                                      \
-    "\"%s\": {"                               \
-    "\"stack_high_water_mark\": ["            \
-    "{"                                       \
-    "\"%s\": %lu"                             \
-    "}"                                       \
-    "],"                                      \
-    "\"task_numbers\": ["                     \
-    "{"                                       \
-    "\"%s\": "
+        ","                                       \
+        "\"%s\": %lu"                             \
+        "}"                                       \
+        "}"                                       \
+        "},"                                      \
+        "\"%s\": {"                               \
+        "\"stack_high_water_mark\": ["            \
+        "{"                                       \
+        "\"%s\": %lu"                             \
+        "}"                                       \
+        "],"                                      \
+        "\"task_numbers\": ["                     \
+        "{"                                       \
+        "\"%s\": "
 
 #define reportbuilderJSON_REPORT_FORMAT_PART5 \
-    "}"                                       \
-    "]"                                       \
-    "}"                                       \
-    "}"
+        "}"                                       \
+        "]"                                       \
+        "}"                                       \
+        "}"
 
 /*-----------------------------------------------------------*/
 

source/defender-tools/report_builder.c

@@ -179,16 +179,6 @@
  */
 #define otaexampleAGENT_TASK_STACK_SIZE          ( 4096 )
 
-/**
- * @brief The version for the firmware which is running. OTA agent uses this
- * version number to perform anti-rollback validation. The firmware version for the
- * download image should be higher than the current version, otherwise the new image is
- * rejected in self test phase.
- */
-#define APP_VERSION_MAJOR                        0
-#define APP_VERSION_MINOR                        9
-#define APP_VERSION_BUILD                        2
-
 /**
  * @brief Defines the structure to use as the command callback context in this
  * demo.

source/demo-tasks/ota_over_mqtt_demo.c

@@ -34,7 +34,7 @@
  * following operations:
  * 1. Assemble strings for the MQTT topics of device shadow, by using macros defined by the Device Shadow library.
  * 2. Subscribe to those MQTT topics using the MQTT Agent.
- * 3. Register callbacks for incoming shadow topic publishes with the subsciption_manager.
+ * 3. Register callbacks for incoming shadow topic publishes with the subscription_manager.
  * 3. Publish to report the current state of powerOn.
  * 5. Check if powerOn has been changed and send an update if so.
  * 6. If a publish to update reported state was sent, wait until either prvIncomingPublishUpdateAcceptedCallback
@@ -95,14 +95,14 @@
  * is used for a client token.
  */
 #define shadowexampleSHADOW_REPORTED_JSON \
-    "{"                                   \
-    "\"state\":{"                         \
-    "\"reported\":{"                      \
-    "\"powerOn\":%1u"                     \
-    "}"                                   \
-    "},"                                  \
-    "\"clientToken\":\"%06lu\""           \
-    "}"
+        "{"                                   \
+        "\"state\":{"                         \
+        "\"reported\":{"                      \
+        "\"powerOn\":%1u"                     \
+        "}"                                   \
+        "},"                                  \
+        "\"clientToken\":\"%06lu\""           \
+        "}"
 
 /**
  * @brief The expected size of #SHADOW_REPORTED_JSON.
@@ -441,7 +441,7 @@ static void prvIncomingPublishUpdateDeltaCallback( void * pxSubscriptionContext,
 
     if( result != JSONSuccess )
     {
-        LogError( ( "Invalid JSON document recieved!" ) );
+        LogError( ( "Invalid JSON document received!" ) );
     }
     else
     {
@@ -470,13 +470,13 @@ static void prvIncomingPublishUpdateDeltaCallback( void * pxSubscriptionContext,
                  * that we've received before. Your application may use a
                  * different approach.
                  */
-                LogWarn( ( "Recieved unexpected delta update with version %u. Current version is %u",
+                LogWarn( ( "Received unexpected delta update with version %u. Current version is %u",
                            ( unsigned int ) ulVersion,
                            ( unsigned int ) ulCurrentVersion ) );
             }
             else
             {
-                LogInfo( ( "Recieved delta update with version %.*s.",
+                LogInfo( ( "Received delta update with version %.*s.",
                            ulOutValueLength,
                            pcOutValue ) );
 
@@ -559,7 +559,7 @@ static void prvIncomingPublishUpdateAcceptedCallback( void * pxSubscriptionConte
 
     if( result != JSONSuccess )
     {
-        LogError( ( "Invalid JSON document recieved!" ) );
+        LogError( ( "Invalid JSON document received!" ) );
     }
     else
     {
@@ -582,7 +582,7 @@ static void prvIncomingPublishUpdateAcceptedCallback( void * pxSubscriptionConte
         ulReceivedToken = ( uint32_t ) strtoul( pcOutValue, NULL, 10 );
 
         /* If we are waiting for a response, ulClientToken will be the token for the response
-         * we are waiting for, else it will be 0. ulRecievedToken may not match if the response is
+         * we are waiting for, else it will be 0. ulReceivedToken may not match if the response is
          * not for us or if it is is a response that arrived after we timed out
          * waiting for it.
          */
@@ -654,7 +654,7 @@ static void prvIncomingPublishUpdateRejectedCallback( void * pxSubscriptionConte
 
     if( result != JSONSuccess )
     {
-        LogError( ( "Invalid JSON document recieved!" ) );
+        LogError( ( "Invalid JSON document received!" ) );
     }
     else
     {
@@ -677,7 +677,7 @@ static void prvIncomingPublishUpdateRejectedCallback( void * pxSubscriptionConte
         ulReceivedToken = ( uint32_t ) strtoul( pcOutValue, NULL, 10 );
 
         /* If we are waiting for a response, ulClientToken will be the token for the response
-         * we are waiting for, else it will be 0. ulRecievedToken may not match if the response is
+         * we are waiting for, else it will be 0. ulReceivedToken may not match if the response is
          * not for us or if it is is a response that arrived after we timed out
          * waiting for it.
          */

source/demo-tasks/shadow_device_task.c

@@ -32,7 +32,7 @@
  * following operations:
  * 1. Assemble strings for the MQTT topics of device shadow, by using macros defined by the Device Shadow library.
  * 2. Subscribe to those MQTT topics using the MQTT Agent.
- * 3. Register callbacks for incoming shadow topic publishes with the subsciption_manager.
+ * 3. Register callbacks for incoming shadow topic publishes with the subscription_manager.
  * 4. Wait until it is time to publish a requested change.
  * 5. Publish a desired state of powerOn. That will cause a delta message to be sent to device.
  * 6. Wait until either prvIncomingPublishUpdateAcceptedCallback or prvIncomingPublishUpdateRejectedCallback handle
@@ -90,14 +90,14 @@
  * is used for a client token.
  */
 #define shadowexampleSHADOW_DESIRED_JSON \
-    "{"                                  \
-    "\"state\":{"                        \
-    "\"desired\":{"                      \
-    "\"powerOn\":%1u"                    \
-    "}"                                  \
-    "},"                                 \
-    "\"clientToken\":\"%06lu\""          \
-    "}"
+        "{"                                  \
+        "\"state\":{"                        \
+        "\"desired\":{"                      \
+        "\"powerOn\":%1u"                    \
+        "}"                                  \
+        "},"                                 \
+        "\"clientToken\":\"%06lu\""          \
+        "}"
 
 /**
  * @brief The expected size of #SHADOW_DESIRED_JSON.
@@ -394,7 +394,7 @@ static void prvIncomingPublishUpdateAcceptedCallback( void * pxSubscriptionConte
 
     if( result != JSONSuccess )
     {
-        LogError( ( "Invalid JSON document recieved!" ) );
+        LogError( ( "Invalid JSON document received!" ) );
     }
     else
     {
@@ -417,7 +417,7 @@ static void prvIncomingPublishUpdateAcceptedCallback( void * pxSubscriptionConte
         ulReceivedToken = ( uint32_t ) strtoul( pcOutValue, NULL, 10 );
 
         /* If we are waiting for a response, ulClientToken will be the token for the response
-         * we are waiting for, else it will be 0. ulRecievedToken may not match if the response is
+         * we are waiting for, else it will be 0. ulReceivedToken may not match if the response is
          * not for us or if it is is a response that arrived after we timed out
          * waiting for it.
          */
@@ -470,7 +470,7 @@ static void prvIncomingPublishUpdateRejectedCallback( void * pxSubscriptionConte
 
     if( result != JSONSuccess )
     {
-        LogError( ( "Invalid JSON document recieved!" ) );
+        LogError( ( "Invalid JSON document received!" ) );
     }
     else
     {
@@ -493,7 +493,7 @@ static void prvIncomingPublishUpdateRejectedCallback( void * pxSubscriptionConte
         ulReceivedToken = ( uint32_t ) strtoul( pcOutValue, NULL, 10 );
 
         /* If we are waiting for a response, ulClientToken will be the token for the response
-         * we are waiting for, else it will be 0. ulRecievedToken may not match if the response is
+         * we are waiting for, else it will be 0. ulReceivedToken may not match if the response is
          * not for us or if it is is a response that arrived after we timed out
          * waiting for it.
          */