Software Update continuation

-- Allow application to handle install if the platform has not provided
   an implementation. Platform/Application must call
   ImageInstallComplete public API to signal completion of image
   installation.
-- Define a default value (1024) for WEAVE_DEVICE_CONFIG_SWU_BDX_BLOCK_SIZE in
   WeaveDeviceConfig.

Author: suryanshup

src/adaptations/device-layer/include/Weave/DeviceLayer/SoftwareUpdateManager.h

@@ -222,7 +222,7 @@ class SoftwareUpdateManager
 
     WEAVE_ERROR Abort(void);
     WEAVE_ERROR CheckNow(void);
-    WEAVE_ERROR ImageInstallComplete(void);
+    WEAVE_ERROR ImageInstallComplete(WEAVE_ERROR aError);
     WEAVE_ERROR SetEventCallback(void * const aAppState, const EventCallback aEventCallback);
     WEAVE_ERROR SetQueryIntervalWindow(uint32_t aMinWaitTimeMs, uint32_t aMaxWaitTimeMs);
 
@@ -394,9 +394,9 @@ inline WEAVE_ERROR SoftwareUpdateManager::CheckNow(void)
     return static_cast<ImplClass*>(this)->_CheckNow();
 }
 
-inline WEAVE_ERROR SoftwareUpdateManager::ImageInstallComplete(void)
+inline WEAVE_ERROR SoftwareUpdateManager::ImageInstallComplete(WEAVE_ERROR aError)
 {
-    return static_cast<ImplClass*>(this)->_ImageInstallComplete();
+    return static_cast<ImplClass*>(this)->_ImageInstallComplete(aError);
 }
 
 inline void SoftwareUpdateManager::OnPlatformEvent(const WeaveDeviceEvent * event)

src/adaptations/device-layer/include/Weave/DeviceLayer/WeaveDeviceConfig.h

@@ -892,4 +892,11 @@
 #define WEAVE_DEVICE_CONFIG_SWU_WAIT_TIME_MULTIPLIER_MS 1*60*1000	// 1 minute
 #endif
 
+/**
+ * WEAVE_DEVICE_CONFIG_SWU_BDX_BLOCK_SIZE
+ *
+ * Specifies the block size to be used during software download over BDX.
+ */
+#define WEAVE_DEVICE_CONFIG_SWU_BDX_BLOCK_SIZE		1024
+
 #endif // WEAVE_DEVICE_CONFIG_H

src/adaptations/device-layer/include/Weave/DeviceLayer/internal/GenericSoftwareUpdateManagerImpl.h

@@ -62,7 +62,7 @@ class GenericSoftwareUpdateManagerImpl
 
     WEAVE_ERROR _Abort(void);
     WEAVE_ERROR _CheckNow(void);
-    WEAVE_ERROR _ImageInstallComplete(void);
+    WEAVE_ERROR _ImageInstallComplete(WEAVE_ERROR aError);
     WEAVE_ERROR _SetQueryIntervalWindow(uint32_t aMinWaitTimeMs, uint32_t aMaxWaitTimeMs);
     WEAVE_ERROR _SetEventCallback(void * const aAppState, const SoftwareUpdateManager::EventCallback aEventCallback);
 

src/adaptations/device-layer/include/Weave/DeviceLayer/internal/GenericSoftwareUpdateManagerImpl.ipp

@@ -77,12 +77,12 @@ WEAVE_ERROR GenericSoftwareUpdateManagerImpl<ImplClass>::_SetEventCallback(void
     mEventHandlerCallback = aEventCallback;
 
 #if DEBUG
-    // Verify that the application's event callback function correctly calls the default handler.
-    //
-    // NOTE: If your code receives WEAVE_ERROR_DEFAULT_EVENT_HANDLER_NOT_CALLED it means that the event handler
-    // function you supplied for the software update manager does not properly call SoftwareUpdateManager::DefaultEventHandler
-    // for unrecognized/unhandled events.
-    //
+    /* Verify that the application's event callback function correctly calls the default handler.
+     *
+     * NOTE: If your code receives WEAVE_ERROR_DEFAULT_EVENT_HANDLER_NOT_CALLED it means that the event handler
+     * function you supplied for the software update manager does not properly call SoftwareUpdateManager::DefaultEventHandler
+     * for unrecognized/unhandled events.
+     */
     {
         SoftwareUpdateManager::InEventParam inParam;
         SoftwareUpdateManager::OutEventParam outParam;
@@ -268,7 +268,7 @@ void GenericSoftwareUpdateManagerImpl<ImplClass>::SoftwareUpdateFailed(WEAVE_ERR
 
     if (aError == WEAVE_DEVICE_ERROR_SOFTWARE_UPDATE_ABORTED)
     {
-        /**
+        /*
          *  No need to do anything since an abort by the application would have already
          *  called SoftwareUpdateFinished with WEAVE_DEVICE_ERROR_SOFTWARE_UPDATE_ABORTED error
          *  and moved to Idle state.
@@ -400,10 +400,11 @@ void GenericSoftwareUpdateManagerImpl<ImplClass>::HandleResponse(ExchangeContext
 {
     GenericSoftwareUpdateManagerImpl<ImplClass> * self = &SoftwareUpdateMgrImpl();
 
-    // We expect to receive one of two possible responses:
-    // 1. An Image Query Response message under the weave software update profile indicating
-    //    an update might be available or
-    // 2. A status report indicating no software update available or a problem with the query.
+    /* We expect to receive one of two possible responses:
+     * 1. An Image Query Response message under the weave software update profile indicating
+     *    an update might be available or
+     * 2. A status report indicating no software update available or a problem with the query.
+     */
     if (profileId == kWeaveProfile_SWU && msgType == kMsgType_ImageQueryResponse)
     {
         self->HandleImageQueryResponse(payload);
@@ -541,10 +542,12 @@ void GenericSoftwareUpdateManagerImpl<ImplClass>::DriveState(SoftwareUpdateManag
     {
     case SoftwareUpdateManager::kState_Idle:
         {
-            // If scheduled software update check is enabled and service connectivity is present,
-            // compute the next wait time interval and start the timer. Software Update Check
-            // will trigger on expiration of the timer unless service connectivity was lost or
-            // the application request a manual software update check.
+            /* Compute the next wait time interval only if scheduled software update checks are
+             * enabled or when the previous attempt failed provided service connectivity is
+             * present. Start the timer once we have a valid interval. A Software Update Check
+             * will trigger on expiration of the timer unless service connectivity was lost or
+             * the application requested a manual software update check.
+             */
             if ((mScheduledCheckEnabled || mShouldRetry) && mHaveServiceConnectivity)
             {
                 uint32_t timeToNextQueryMS = GetNextWaitTimeInterval();
@@ -827,18 +830,29 @@ void GenericSoftwareUpdateManagerImpl<ImplClass>::CheckImageIntegrity(void)
 {
     WEAVE_ERROR err = WEAVE_NO_ERROR;
     int result = 0;
+    uint8_t typeLength = 0;
 
     SoftwareUpdateManager::InEventParam inParam;
     SoftwareUpdateManager::OutEventParam outParam;
 
     inParam.Clear();
     outParam.Clear();
 
-
-    const uint8_t typeLength = (mIntegritySpec.type == kIntegrityType_SHA160) ? kLength_SHA160 :
-                               (mIntegritySpec.type == kIntegrityType_SHA256) ? kLength_SHA256 :
-                               (mIntegritySpec.type == kIntegrityType_SHA512) ? kLength_SHA512 :
-                                0;
+    switch(mIntegritySpec.type)
+    {
+        case kIntegrityType_SHA160:
+            typeLength = kLength_SHA160;
+            break;
+        case kIntegrityType_SHA256:
+            typeLength = kLength_SHA256;
+            break;
+        case kIntegrityType_SHA512:
+            typeLength = kLength_SHA512;
+            break;
+        default:
+            typeLength = 0;
+            break;
+    }
 
     uint8_t computedIntegrityValue[typeLength];
 
@@ -865,9 +879,10 @@ void GenericSoftwareUpdateManagerImpl<ImplClass>::CheckImageIntegrity(void)
 exit:
     if (err != WEAVE_NO_ERROR && err != WEAVE_DEVICE_ERROR_SOFTWARE_UPDATE_ABORTED)
     {
-        // Since Image Integrity Validation failed, notify the application using an API event
-        // to clear/invalidate the image from storage. This will make sure the image is downloaded from
-        // scratch on the next attempt.
+        /* Since Image Integrity Validation failed, notify the application using an API event
+         * to clear/invalidate the image from storage. This will make sure the image is downloaded from
+         * scratch on the next attempt.
+         */
         inParam.Clear();
         outParam.Clear();
 
@@ -897,17 +912,22 @@ void GenericSoftwareUpdateManagerImpl<ImplClass>::StartImageInstall(void)
     VerifyOrExit(!mWasAborted, err = WEAVE_DEVICE_ERROR_SOFTWARE_UPDATE_ABORTED);
 
     err = Impl()->InstallImage();
+    if (err == WEAVE_ERROR_NOT_IMPLEMENTED)
+    {
+        /*
+         * Since the platform does not provide a way to install the image, it is uptp
+         * the application to do the install and call ImageInstallComplete API
+         * to mark completion of image installation.
+         */
+        err = WEAVE_NO_ERROR;
+    }
     SuccessOrExit(err);
 
 exit:
     if (err != WEAVE_NO_ERROR)
     {
         Impl()->SoftwareUpdateFailed(err, NULL);
     }
-    else
-    {
-        Impl()->SoftwareUpdateFinished(WEAVE_NO_ERROR);
-    }
 }
 
 template<class ImplClass>
@@ -1009,16 +1029,19 @@ void GenericSoftwareUpdateManagerImpl<ImplClass>::DefaultRetryPolicyCallback(voi
 }
 
 template<class ImplClass>
-WEAVE_ERROR GenericSoftwareUpdateManagerImpl<ImplClass>::_ImageInstallComplete(void)
+WEAVE_ERROR GenericSoftwareUpdateManagerImpl<ImplClass>::_ImageInstallComplete(WEAVE_ERROR aError)
 {
     WEAVE_ERROR err = WEAVE_NO_ERROR;
 
-    VerifyOrExit(mState == SoftwareUpdateManager::kState_ApplicationManaged, err = WEAVE_ERROR_INCORRECT_STATE);
-
-    Impl()->SoftwareUpdateFinished(WEAVE_NO_ERROR);
+    if (mState == SoftwareUpdateManager::kState_ApplicationManaged || mState == SoftwareUpdateManager::kState_Install)
+    {
+        Impl()->SoftwareUpdateFinished(aError);
+    }
+    else
+    {
+        err = WEAVE_ERROR_INCORRECT_STATE;
+    }
 
-    DriveState(SoftwareUpdateManager::kState_Idle);
-exit:
     return err;
 }
 

src/adaptations/device-layer/include/Weave/DeviceLayer/internal/GenericSoftwareUpdateManagerImpl_BDX.ipp

@@ -110,16 +110,15 @@ WEAVE_ERROR GenericSoftwareUpdateManagerImpl_BDX<ImplClass>::StartDownload(void)
     mBinding->Release();
     mBinding = NULL;
 
-    mBDXTransfer->mMaxBlockSize = WEAVE_DEVICE_CONFIG_SWU_BDX_BLOCK_SIZE;
-    mBDXTransfer->mStartOffset  = mStartOffset;
-
-    /**
+    /*
      * This implementation only supports downloading a software image from an offset
-     * provided by the application till the end of file. The 0 value below indicates
-     * that expected length of the transfer is unknown by the initiator at this point
-     * and hence the remainder of the file starting from the offset mentioned
-     * above is expected to be downloaded in the transfer.
+     * provided by the application till the end of file. The 0 value in mLength field
+     * below indicates that expected length of the transfer is unknown by the initiator
+     * at this point and hence the remainder of the file starting from the offset
+     * mentioned above is expected to be downloaded in the transfer.
      */
+    mBDXTransfer->mMaxBlockSize = WEAVE_DEVICE_CONFIG_SWU_BDX_BLOCK_SIZE;
+    mBDXTransfer->mStartOffset  = mStartOffset;
     mBDXTransfer->mLength       = 0;
 
     err = mBDXClient.InitBdxReceive(*mBDXTransfer, true, false, false, NULL);

src/adaptations/device-layer/include/Weave/DeviceLayer/nRF5/SoftwareUpdateManagerImpl.h

@@ -62,7 +62,6 @@ class SoftwareUpdateManagerImpl final
     // ===== Members that implement the SoftwareUpdateManager abstract interface.
 
     WEAVE_ERROR _Init(void);
-
 };
 
 /**