Merge pull request #302 from openweave/feature/softwareupdatemanager

Software Update Manager Implementation

Author: Jay Logue

src/adaptations/device-layer/ESP32/SoftwareUpdateManagerImpl.cpp

@@ -0,0 +1,48 @@
+/*
+ *
+ *    Copyright (c) 2019 Google LLC.
+ *    All rights reserved.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+
+#include <Weave/DeviceLayer/internal/WeaveDeviceLayerInternal.h>
+
+#if WEAVE_DEVICE_CONFIG_ENABLE_SOFTWARE_UPDATE_MANAGER
+
+#include <Weave/Profiles/WeaveProfiles.h>
+#include <Weave/Profiles/common/CommonProfile.h>
+
+#include <Weave/DeviceLayer/internal/GenericSoftwareUpdateManagerImpl_BDX.ipp>
+#include <Weave/DeviceLayer/internal/GenericSoftwareUpdateManagerImpl.ipp>
+
+namespace nl {
+namespace Weave {
+namespace DeviceLayer {
+
+SoftwareUpdateManagerImpl SoftwareUpdateManagerImpl::sInstance;
+
+WEAVE_ERROR SoftwareUpdateManagerImpl::_Init(void)
+{
+    Internal::GenericSoftwareUpdateManagerImpl_BDX<SoftwareUpdateManagerImpl>::DoInit();
+    Internal::GenericSoftwareUpdateManagerImpl<SoftwareUpdateManagerImpl>::DoInit();
+
+    return WEAVE_NO_ERROR;
+}
+
+} // namespace DeviceLayer
+} // namespace Weave
+} // namespace nl
+
+#endif // WEAVE_DEVICE_CONFIG_ENABLE_SOFTWARE_UPDATE_MANAGER

src/adaptations/device-layer/Makefile.am

@@ -44,18 +44,21 @@ noinst_HEADERS                          = \
     include/Weave/DeviceLayer/ESP32/BLEManagerImpl.h \
     include/Weave/DeviceLayer/ESP32/ConfigurationManagerImpl.h \
     include/Weave/DeviceLayer/ESP32/PlatformManagerImpl.h \
+    include/Weave/DeviceLayer/ESP32/SoftwareUpdateManagerImpl.h \
     include/Weave/DeviceLayer/ESP32/WeaveDevicePlatformEvent.h \
     include/Weave/DeviceLayer/ESP32/NetworkProvisioningServerImpl.h \
     include/Weave/DeviceLayer/nRF5/ConfigurationManagerImpl.h \
     include/Weave/DeviceLayer/nRF5/PlatformManagerImpl.h \
     include/Weave/DeviceLayer/nRF5/nRF5Config.h \
+    include/Weave/DeviceLayer/nRF5/SoftwareUpdateManagerImpl.h \
     include/Weave/DeviceLayer/nRF5/WeaveDevicePlatformConfig.h \
     include/Weave/DeviceLayer/nRF5/WeaveDevicePlatformEvent.h \
     include/Weave/DeviceLayer/FreeRTOS/GenericPlatformManagerImpl_FreeRTOS.h \
     include/Weave/DeviceLayer/FreeRTOS/GenericPlatformManagerImpl_FreeRTOS.ipp \
     include/Weave/DeviceLayer/GeneralUtils.h \
     include/Weave/DeviceLayer/NetworkTelemetryManager.h \
     include/Weave/DeviceLayer/PlatformManager.h \
+    include/Weave/DeviceLayer/SoftwareUpdateManager.h \
     include/Weave/DeviceLayer/TimeSyncManager.h \
     include/Weave/DeviceLayer/TraitManager.h \
     include/Weave/DeviceLayer/WeaveDeviceConfig.h \
@@ -76,6 +79,10 @@ noinst_HEADERS                          = \
     include/Weave/DeviceLayer/internal/GenericNetworkProvisioningServerImpl.ipp \
     include/Weave/DeviceLayer/internal/GenericPlatformManagerImpl.h \
     include/Weave/DeviceLayer/internal/GenericPlatformManagerImpl.ipp \
+    include/Weave/DeviceLayer/internal/GenericSoftwareUpdateManagerImpl.h \
+    include/Weave/DeviceLayer/internal/GenericSoftwareUpdateManagerImpl.ipp \
+    include/Weave/DeviceLayer/internal/GenericSoftwareUpdateManagerImpl_BDX.h \
+    include/Weave/DeviceLayer/internal/GenericSoftwareUpdateManagerImpl_BDX.ipp \
     include/Weave/DeviceLayer/internal/NetworkProvisioningServer.h \
     include/Weave/DeviceLayer/internal/ServiceDirectoryManager.h \
     include/Weave/DeviceLayer/internal/ServiceProvisioningServer.h \
@@ -141,6 +148,7 @@ libDeviceLayer_a_SOURCES               +=       \
     ESP32/LwIPCoreLock.cpp                      \
     ESP32/NetworkProvisioningServerImpl.cpp     \
     ESP32/PlatformManagerImpl.cpp               \
+    ESP32/SoftwareUpdateManagerImpl.cpp         \
     ESP32/SystemTimeSupport.cpp                 \
     LwIP/WarmSupport.cpp                        \
     $(NULL)
@@ -161,6 +169,7 @@ libDeviceLayer_a_SOURCES               +=       \
     nRF5/nRF5Utils.cpp                          \
     nRF5/Entropy.cpp                            \
     nRF5/Logging.cpp                            \
+    nRF5/SoftwareUpdateManagerImpl.cpp          \
     FreeRTOS/SystemTimeSupport.cpp              \
     OpenThread/OpenThreadUtils.cpp              \
     LwIP/WarmSupport.cpp                        \

src/adaptations/device-layer/Makefile.in

@@ -0,0 +1,95 @@
+/*
+ *
+ *    Copyright (c) 2019 Google LLC.
+ *    All rights reserved.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+#ifndef SOFTWARE_UPDATE_MANAGER_IMPL_H
+#define SOFTWARE_UPDATE_MANAGER_IMPL_H
+
+#if WEAVE_DEVICE_CONFIG_ENABLE_SOFTWARE_UPDATE_MANAGER
+
+#include <Weave/DeviceLayer/internal/GenericSoftwareUpdateManagerImpl.h>
+#include <Weave/DeviceLayer/internal/GenericSoftwareUpdateManagerImpl_BDX.h>
+
+namespace nl {
+namespace Weave {
+namespace DeviceLayer {
+
+/**
+ * Concrete implementation of the SoftwareUpdateManager singleton object for the
+ * ESP32 platforms.
+ */
+class SoftwareUpdateManagerImpl final
+    : public SoftwareUpdateManager,
+      public Internal::GenericSoftwareUpdateManagerImpl<SoftwareUpdateManagerImpl>,
+      public Internal::GenericSoftwareUpdateManagerImpl_BDX<SoftwareUpdateManagerImpl>
+{
+    // Allow the SoftwareUpdateManager interface class to delegate method calls to
+    // the implementation methods provided by this class.
+    friend class SoftwareUpdateManager;
+
+    // Allow the GenericSoftwareUpdateManagerImpl base class to access helper methods
+    // and types defined on this class.
+    friend class Internal::GenericSoftwareUpdateManagerImpl<SoftwareUpdateManagerImpl>;
+
+    // Allow the GenericSoftwareUpdateManagerImpl_BDX base class to access helper methods
+    // and types defined on this class.
+    friend class Internal::GenericSoftwareUpdateManagerImpl_BDX<SoftwareUpdateManagerImpl>;
+
+public:
+
+    // ===== Members for internal use by the following friends.
+
+    friend ::nl::Weave::DeviceLayer::SoftwareUpdateManager & SoftwareUpdateMgr(void);
+    friend SoftwareUpdateManagerImpl & SoftwareUpdateMgrImpl(void);
+
+    static SoftwareUpdateManagerImpl sInstance;
+
+private:
+    // ===== Members that implement the SoftwareUpdateManager abstract interface.
+
+    WEAVE_ERROR _Init(void);
+
+};
+
+/**
+ * Returns a reference to the public interface of the SoftwareUpdateManager singleton object.
+ *
+ * Internal components should use this to access features of the SoftwareUpdateManager object
+ * that are common to all platforms.
+ */
+inline SoftwareUpdateManager & SoftwareUpdateMgr(void)
+{
+    return SoftwareUpdateManagerImpl::sInstance;
+}
+
+/**
+ * Returns the platform-specific implementation of the SoftwareUpdateManager singleton object.
+ *
+ * Internal components can use this to gain access to features of the SoftwareUpdateManager
+ * that are specific to the ESP32 platform.
+ */
+inline SoftwareUpdateManagerImpl & SoftwareUpdateMgrImpl(void)
+{
+    return SoftwareUpdateManagerImpl::sInstance;
+}
+
+} // namespace DeviceLayer
+} // namespace Weave
+} // namespace nl
+
+#endif // WEAVE_DEVICE_CONFIG_ENABLE_SOFTWARE_UPDATE_MANAGER
+#endif // SOFTWARE_UPDATE_MANAGER_IMPL_H