Add OTA Orchestrator fixes (#107)

AhmedIsmail02 · urutva · web-flow · commit 2c16a189e9b5 · 2025-02-02T16:22:40.000+05:30
* ota-orchestrator: Add multiple enhancements and fixes

* Do not suspend OTA agent after successful update.

* vOtaNotActiveHook() should be called whenever there
are no OTA jobs available.

* Use LogDebug and LogError instead of LogInfo to
follow the previous ota-for-embedded-iot-sdk library
implementation (avoiding new issues).

Signed-off-by: Devaraj Ranganna &lt;devaraj.ranganna@arm.com&gt;
Signed-off-by: Ahmed Ismail &lt;Ahmed.Ismail@arm.com&gt;

* mqtt-agent: Increase MQTT Agent keep alive interval

The `MQTT_AGENT_KEEP_ALIVE_INTERVAL_SECONDS` is increased
to 100 as in case of using SOFTWARE inference with speech
recognition application the connection is dropped before
the ML Inference is done as the software inference is generally
much slower compared to the Ethos NPU. This connection drop
cause the ML inference to have wrong results as the task
is interrupted. Hence, increasing the keep alive interval
to avoid the connection drop.

Signed-off-by: Ahmed Ismail &lt;Ahmed.Ismail@arm.com&gt;

* github-upload-artifact: Upgrade the deprecated version

actions/upload-artifact v3 is now deprecated and cannot
be used anymore. Hence, updating to v4.

`strategy.job-index` is post-fixed to the artifact
name to overcome the known issue of upload-artifact v4
not allowing multiple artifacts with the same name on
the workflow run.

Signed-off-by: Ahmed Ismail &lt;Ahmed.Ismail@arm.com&gt;

---------

Signed-off-by: Devaraj Ranganna &lt;devaraj.ranganna@arm.com&gt;
Signed-off-by: Ahmed Ismail &lt;Ahmed.Ismail@arm.com&gt;
Co-authored-by: Devaraj Ranganna &lt;devaraj.ranganna@arm.com&gt;
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -1,4 +1,4 @@
-# Copyright (c) 2023-2024 Arm Limited and/or its affiliates
+# Copyright (c) 2023-2025 Arm Limited and/or its affiliates
 # <open-source-office@arm.com>
 # SPDX-License-Identifier: MIT
 
@@ -85,9 +85,9 @@ jobs:
           build/${{ matrix.application }}-update_signed.bin \
           build/update-signature.txt
       - name: Upload Build Artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: FRI-build-logs
+          name: FRI-build-logs-${{ strategy.job-index }}
           path: |
             ${{ github.workspace }}/${{ matrix.application }}_gnu_build.tar.gz
           retention-days: 5
diff --git a/applications/helpers/ota_orchestrator/src/ota_orchestrator.c b/applications/helpers/ota_orchestrator/src/ota_orchestrator.c
@@ -1075,6 +1075,7 @@ STATIC void processOTAEvents()
                 case OtaPalNewImageBootFailed:
                 case OtaPalJobDocProcessingStateInvalid:
                     LogInfo( ( "No OTA job available. \n" ) );
+                    vOtaNotActiveHook();
                     break;
             }
 
@@ -1171,11 +1172,11 @@ STATIC void processOTAEvents()
             if( activateImage() == true )
             {
                 LogInfo( ( "Activated image.\n" ) );
-                nextEvent.eventId = OtaAgentEventActivateImage;
+
+                nextEvent.eventId = OtaAgentEventRequestJobDocument;
                 OtaSendEvent_FreeRTOS( &nextEvent );
             }
 
-            otaAgentState = OtaAgentStateStopped;
             break;
 
 
diff --git a/applications/helpers/ota_orchestrator/src/ota_os_freertos.c b/applications/helpers/ota_orchestrator/src/ota_os_freertos.c
@@ -1,6 +1,6 @@
 /*
  * Copyright Amazon.com, Inc. and its affiliates. All Rights Reserved.
- * Copyright 2024 Arm Limited and/or its affiliates
+ * Copyright 2024-2025 Arm Limited and/or its affiliates
  * <open-source-office@arm.com>
  *
  * SPDX-License-Identifier: MIT
@@ -67,14 +67,14 @@ OtaOsStatus_t OtaInitEvent_FreeRTOS()
     {
         otaOsStatus = OtaOsEventQueueCreateFailed;
 
-        LogInfo( ( "Failed to create OTA Event queue: "
-                   "xQueueCreateStatic returned error: "
-                   "OtaOsStatus_t=%d \n",
-                   ( int ) otaOsStatus ) );
+        LogError( ( "Failed to create OTA Event queue: "
+                    "xQueueCreateStatic returned error: "
+                    "OtaOsStatus_t=%d \n",
+                    ( int ) otaOsStatus ) );
     }
     else
     {
-        LogInfo( ( "OTA Event Queue created.\n" ) );
+        LogDebug( ( "OTA Event Queue created.\n" ) );
     }
 
     return otaOsStatus;
@@ -90,16 +90,16 @@ OtaOsStatus_t OtaSendEvent_FreeRTOS( const void * pEventMsg )
 
     if( retVal == pdTRUE )
     {
-        LogInfo( ( "OTA Event sent.\n" ) );
+        LogDebug( ( "OTA Event sent.\n" ) );
     }
     else
     {
         otaOsStatus = OtaOsEventQueueSendFailed;
 
-        LogInfo( ( "Failed to send event to OTA Event Queue: "
-                   "xQueueSendToBack returned error: "
-                   "OtaOsStatus_t=%d \n",
-                   ( int ) otaOsStatus ) );
+        LogError( ( "Failed to send event to OTA Event Queue: "
+                    "xQueueSendToBack returned error: "
+                    "OtaOsStatus_t=%d \n",
+                    ( int ) otaOsStatus ) );
     }
 
     return otaOsStatus;
@@ -114,16 +114,16 @@ OtaOsStatus_t OtaReceiveEvent_FreeRTOS( void * pEventMsg )
 
     if( retVal == pdTRUE )
     {
-        LogInfo( ( "OTA Event received \n" ) );
+        LogDebug( ( "OTA Event received \n" ) );
     }
     else
     {
         otaOsStatus = OtaOsEventQueueReceiveFailed;
 
-        LogInfo( ( "Failed to receive event or timeout from OTA Event Queue: "
-                   "xQueueReceive returned error: "
-                   "OtaOsStatus_t=%d \n",
-                   ( int ) otaOsStatus ) );
+        LogDebug( ( "Failed to receive event or timeout from OTA Event Queue: "
+                    "xQueueReceive returned error: "
+                    "OtaOsStatus_t=%d \n",
+                    ( int ) otaOsStatus ) );
     }
 
     return otaOsStatus;
@@ -133,5 +133,5 @@ void OtaDeinitEvent_FreeRTOS()
 {
     vQueueDelete( otaEventQueue );
 
-    LogInfo( ( "OTA Event Queue Deleted. \n" ) );
+    LogDebug( ( "OTA Event Queue Deleted. \n" ) );
 }
diff --git a/components/aws_iot/coremqtt_agent/integration/src/mqtt_agent_task.c b/components/aws_iot/coremqtt_agent/integration/src/mqtt_agent_task.c
@@ -1,7 +1,7 @@
 /*
  * FreeRTOS V202012.00
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
- * Copyright 2023-2024 Arm Limited and/or its affiliates
+ * Copyright 2023-2025 Arm Limited and/or its affiliates
  * <open-source-office@arm.com>
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -141,7 +141,7 @@
  *  absence of sending any other Control Packets, the Client MUST send a
  *  PINGREQ Packet.
  */
-#define MQTT_AGENT_KEEP_ALIVE_INTERVAL_SECONDS       ( 60U )
+#define MQTT_AGENT_KEEP_ALIVE_INTERVAL_SECONDS       ( 100U )
 
 /**
  * @brief Socket send and receive timeouts to use.  Specified in milliseconds.
diff --git a/release_changes/202501301446.change.md b/release_changes/202501301446.change.md
@@ -0,0 +1,2 @@
+ota-orchestrator: Add multiple enhancements and fixes.
+mqtt-agent: Increase MQTT Agent keep alive interval.

Original file line number	Diff line number	Diff line change
`@@ -1075,6 +1075,7 @@ STATIC void processOTAEvents()`
`1075`	`1075`	`case OtaPalNewImageBootFailed:`
`1076`	`1076`	`case OtaPalJobDocProcessingStateInvalid:`
`1077`	`1077`	`LogInfo( ( "No OTA job available. \n" ) );`
	`1078`	`+ vOtaNotActiveHook();`
`1078`	`1079`	`break;`
`1079`	`1080`	`}`
`1080`	`1081`
`@@ -1171,11 +1172,11 @@ STATIC void processOTAEvents()`
`1171`	`1172`	`if( activateImage() == true )`
`1172`	`1173`	`{`
`1173`	`1174`	`LogInfo( ( "Activated image.\n" ) );`
`1174`		`- nextEvent.eventId = OtaAgentEventActivateImage;`
	`1175`	`+`
	`1176`	`+ nextEvent.eventId = OtaAgentEventRequestJobDocument;`
`1175`	`1177`	`OtaSendEvent_FreeRTOS( &nextEvent );`
`1176`	`1178`	`}`
`1177`	`1179`
`1178`		`- otaAgentState = OtaAgentStateStopped;`
`1179`	`1180`	`break;`
`1180`	`1181`
`1181`	`1182`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`/*`
`2`	`2`	`* Copyright Amazon.com, Inc. and its affiliates. All Rights Reserved.`
`3`		`- * Copyright 2024 Arm Limited and/or its affiliates`
	`3`	`+ * Copyright 2024-2025 Arm Limited and/or its affiliates`
`4`	`4`	`* <[email protected]>`
`5`	`5`	`*`
`6`	`6`	`* SPDX-License-Identifier: MIT`
`@@ -67,14 +67,14 @@ OtaOsStatus_t OtaInitEvent_FreeRTOS()`
`67`	`67`	`{`
`68`	`68`	`otaOsStatus = OtaOsEventQueueCreateFailed;`
`69`	`69`
`70`		`- LogInfo( ( "Failed to create OTA Event queue: "`
`71`		`- "xQueueCreateStatic returned error: "`
`72`		`- "OtaOsStatus_t=%d \n",`
`73`		`- ( int ) otaOsStatus ) );`
	`70`	`+ LogError( ( "Failed to create OTA Event queue: "`
	`71`	`+ "xQueueCreateStatic returned error: "`
	`72`	`+ "OtaOsStatus_t=%d \n",`
	`73`	`+ ( int ) otaOsStatus ) );`
`74`	`74`	`}`
`75`	`75`	`else`
`76`	`76`	`{`
`77`		`- LogInfo( ( "OTA Event Queue created.\n" ) );`
	`77`	`+ LogDebug( ( "OTA Event Queue created.\n" ) );`
`78`	`78`	`}`
`79`	`79`
`80`	`80`	`return otaOsStatus;`
`@@ -90,16 +90,16 @@ OtaOsStatus_t OtaSendEvent_FreeRTOS( const void * pEventMsg )`
`90`	`90`
`91`	`91`	`if( retVal == pdTRUE )`
`92`	`92`	`{`
`93`		`- LogInfo( ( "OTA Event sent.\n" ) );`
	`93`	`+ LogDebug( ( "OTA Event sent.\n" ) );`
`94`	`94`	`}`
`95`	`95`	`else`
`96`	`96`	`{`
`97`	`97`	`otaOsStatus = OtaOsEventQueueSendFailed;`
`98`	`98`
`99`		`- LogInfo( ( "Failed to send event to OTA Event Queue: "`
`100`		`- "xQueueSendToBack returned error: "`
`101`		`- "OtaOsStatus_t=%d \n",`
`102`		`- ( int ) otaOsStatus ) );`
	`99`	`+ LogError( ( "Failed to send event to OTA Event Queue: "`
	`100`	`+ "xQueueSendToBack returned error: "`
	`101`	`+ "OtaOsStatus_t=%d \n",`
	`102`	`+ ( int ) otaOsStatus ) );`
`103`	`103`	`}`
`104`	`104`
`105`	`105`	`return otaOsStatus;`
`@@ -114,16 +114,16 @@ OtaOsStatus_t OtaReceiveEvent_FreeRTOS( void * pEventMsg )`
`114`	`114`
`115`	`115`	`if( retVal == pdTRUE )`
`116`	`116`	`{`
`117`		`- LogInfo( ( "OTA Event received \n" ) );`
	`117`	`+ LogDebug( ( "OTA Event received \n" ) );`
`118`	`118`	`}`
`119`	`119`	`else`
`120`	`120`	`{`
`121`	`121`	`otaOsStatus = OtaOsEventQueueReceiveFailed;`
`122`	`122`
`123`		`- LogInfo( ( "Failed to receive event or timeout from OTA Event Queue: "`
`124`		`- "xQueueReceive returned error: "`
`125`		`- "OtaOsStatus_t=%d \n",`
`126`		`- ( int ) otaOsStatus ) );`
	`123`	`+ LogDebug( ( "Failed to receive event or timeout from OTA Event Queue: "`
	`124`	`+ "xQueueReceive returned error: "`
	`125`	`+ "OtaOsStatus_t=%d \n",`
	`126`	`+ ( int ) otaOsStatus ) );`
`127`	`127`	`}`
`128`	`128`
`129`	`129`	`return otaOsStatus;`
`@@ -133,5 +133,5 @@ void OtaDeinitEvent_FreeRTOS()`
`133`	`133`	`{`
`134`	`134`	`vQueueDelete( otaEventQueue );`
`135`	`135`
`136`		`- LogInfo( ( "OTA Event Queue Deleted. \n" ) );`
	`136`	`+ LogDebug( ( "OTA Event Queue Deleted. \n" ) );`
`137`	`137`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+ota-orchestrator: Add multiple enhancements and fixes.`
	`2`	`+mqtt-agent: Increase MQTT Agent keep alive interval.`