[events] Added generating BootReason event

Zephyr platform doesn't support generating all mandatory events from Basic and General Diagnostics clusters. Generic changes: * Added generating BootReason event * Added Server::FactoryReset method to dispatch necessary events and flush pending events before factory reset * Added dispatching shutdown event on factory reset * Added DeleteAllFabrics in FactoryReset to emit Leave event. * Added flushing events on factory reset * Added for all examples to call Server FactoryReset instead of platform InitiateFactoryReset Zephyr platform changes: * Fixed bug in persisted storage read implementation that returned wrong error code and it resulted in PersistedCounter initialization failure. * Added calling Shutdown after factory reset WIP
kkasperczyk-no · Feb 22, 2022 · 5dc2eb6 · 5dc2eb6
1 parent 9039ba0
commit 5dc2eb6
Show file tree

Hide file tree

Showing 33 changed files with 79 additions and 34 deletions.
diff --git a/examples/all-clusters-app/esp32/main/main.cpp b/examples/all-clusters-app/esp32/main/main.cpp
@@ -453,7 +453,7 @@ class SetupListModel : public TouchesMatterStackModel
         }
         else if (i == 1)
         {
-            ConfigurationMgr().InitiateFactoryReset();
+            chip::Server::GetInstance().FactoryReset();
         }
         else if (i == 2)
         {

diff --git a/examples/light-switch-app/efr32/src/AppTask.cpp b/examples/light-switch-app/efr32/src/AppTask.cpp
@@ -411,7 +411,7 @@ void AppTask::FunctionTimerEventHandler(AppEvent * aEvent)
     {
         // Actually trigger Factory Reset
         sAppTask.mFunction = kFunction_NoneSelected;
-        ConfigurationMgr().InitiateFactoryReset();
+        chip::Server::GetInstance().FactoryReset();
     }
 }
 

diff --git a/examples/lighting-app/efr32/src/AppTask.cpp b/examples/lighting-app/efr32/src/AppTask.cpp
@@ -494,7 +494,7 @@ void AppTask::FunctionTimerEventHandler(AppEvent * aEvent)
     {
         // Actually trigger Factory Reset
         sAppTask.mFunction = kFunction_NoneSelected;
-        ConfigurationMgr().InitiateFactoryReset();
+        chip::Server::GetInstance().FactoryReset();
     }
 }
 

diff --git a/examples/lighting-app/mbed/main/AppTask.cpp b/examples/lighting-app/mbed/main/AppTask.cpp
@@ -399,7 +399,7 @@ void AppTask::FunctionTimerEventHandler(AppEvent * aEvent)
         // Actually trigger Factory Reset
         ChipLogProgress(NotSpecified, "Factory Reset initiated");
         sAppTask.mFunction = kFunction_NoneSelected;
-        ConfigurationMgr().InitiateFactoryReset();
+        chip::Server::GetInstance().FactoryReset();
     }
 }
 

diff --git a/examples/lighting-app/nrfconnect/main/AppTask.cpp b/examples/lighting-app/nrfconnect/main/AppTask.cpp
@@ -318,7 +318,8 @@ void AppTask::FunctionTimerEventHandler(AppEvent * aEvent)
     {
         // Actually trigger Factory Reset
         sAppTask.mFunction = kFunction_NoneSelected;
-        ConfigurationMgr().InitiateFactoryReset();
+
+        chip::Server::GetInstance().FactoryReset();
     }
 }
 

diff --git a/examples/lighting-app/nxp/k32w/k32w0/main/AppTask.cpp b/examples/lighting-app/nxp/k32w/k32w0/main/AppTask.cpp
@@ -384,7 +384,7 @@ void AppTask::FunctionTimerEventHandler(AppEvent * aEvent)
     K32W_LOG("Device will factory reset...");
 
     // Actually trigger Factory Reset
-    ConfigurationMgr().InitiateFactoryReset();
+    chip::Server::GetInstance().FactoryReset();
 }
 
 void AppTask::ResetActionEventHandler(AppEvent * aEvent)

diff --git a/examples/lighting-app/p6/src/AppTask.cpp b/examples/lighting-app/p6/src/AppTask.cpp
@@ -335,7 +335,7 @@ void AppTask::FunctionTimerEventHandler(AppEvent * aEvent)
     {
         // Actually trigger Factory Reset
         sAppTask.mFunction = Function::kNoneSelected;
-        ConfigurationMgr().InitiateFactoryReset();
+        chip::Server::GetInstance().FactoryReset();
     }
 }
 

diff --git a/examples/lighting-app/qpg/src/AppTask.cpp b/examples/lighting-app/qpg/src/AppTask.cpp
@@ -305,7 +305,7 @@ void AppTask::FunctionTimerEventHandler(AppEvent * aEvent)
     {
         // Actually trigger Factory Reset
         sAppTask.mFunction = kFunction_NoneSelected;
-        ConfigurationMgr().InitiateFactoryReset();
+        chip::Server::GetInstance().FactoryReset();
     }
 }
 

diff --git a/examples/lighting-app/telink/src/AppTask.cpp b/examples/lighting-app/telink/src/AppTask.cpp
@@ -215,7 +215,7 @@ void AppTask::FactoryResetButtonEventHandler(void)
 void AppTask::FactoryResetHandler(AppEvent * aEvent)
 {
     LOG_INF("Factory Reset triggered.");
-    ConfigurationMgr().InitiateFactoryReset();
+    chip::Server::GetInstance().FactoryReset();
 }
 
 void AppTask::StartThreadButtonEventHandler(void)

diff --git a/examples/lock-app/efr32/src/AppTask.cpp b/examples/lock-app/efr32/src/AppTask.cpp
@@ -363,7 +363,7 @@ void AppTask::FunctionTimerEventHandler(AppEvent * aEvent)
     {
         // Actually trigger Factory Reset
         sAppTask.mFunction = kFunction_NoneSelected;
-        ConfigurationMgr().InitiateFactoryReset();
+        chip::Server::GetInstance().FactoryReset();
     }
 }
 

diff --git a/examples/lock-app/esp32/main/AppTask.cpp b/examples/lock-app/esp32/main/AppTask.cpp
@@ -298,7 +298,7 @@ void AppTask::FunctionTimerEventHandler(AppEvent * aEvent)
     {
         // Actually trigger Factory Reset
         sAppTask.mFunction = kFunction_NoneSelected;
-        ConfigurationMgr().InitiateFactoryReset();
+        chip::Server::GetInstance().FactoryReset();
     }
 }
 

diff --git a/examples/lock-app/mbed/main/AppTask.cpp b/examples/lock-app/mbed/main/AppTask.cpp
@@ -395,7 +395,7 @@ void AppTask::FunctionTimerEventHandler(AppEvent * aEvent)
         // Actually trigger Factory Reset
         ChipLogProgress(NotSpecified, "Factory Reset initiated");
         sAppTask.mFunction = kFunction_NoneSelected;
-        ConfigurationMgr().InitiateFactoryReset();
+        chip::Server::GetInstance().FactoryReset();
     }
 }
 

diff --git a/examples/lock-app/nrfconnect/main/AppTask.cpp b/examples/lock-app/nrfconnect/main/AppTask.cpp
@@ -268,7 +268,8 @@ void AppTask::FunctionTimerEventHandler(AppEvent * aEvent)
     {
         // Actually trigger Factory Reset
         sAppTask.mFunction = kFunction_NoneSelected;
-        ConfigurationMgr().InitiateFactoryReset();
+
+        chip::Server::GetInstance().FactoryReset();
     }
 }
 

diff --git a/examples/lock-app/nxp/k32w/k32w0/main/AppTask.cpp b/examples/lock-app/nxp/k32w/k32w0/main/AppTask.cpp
@@ -357,7 +357,7 @@ void AppTask::FunctionTimerEventHandler(void * aGenericEvent)
     K32W_LOG("Device will factory reset...");
 
     // Actually trigger Factory Reset
-    ConfigurationMgr().InitiateFactoryReset();
+    chip::Server::GetInstance().FactoryReset();
 }
 
 void AppTask::ResetActionEventHandler(void * aGenericEvent)

diff --git a/examples/lock-app/p6/src/AppTask.cpp b/examples/lock-app/p6/src/AppTask.cpp
@@ -331,7 +331,7 @@ void AppTask::FunctionTimerEventHandler(AppEvent * event)
     {
         // Actually trigger Factory Reset
         sAppTask.mFunction = Function::kNoneSelected;
-        ConfigurationMgr().InitiateFactoryReset();
+        chip::Server::GetInstance().FactoryReset();
     }
 }
 

diff --git a/examples/lock-app/qpg/src/AppTask.cpp b/examples/lock-app/qpg/src/AppTask.cpp
@@ -315,7 +315,7 @@ void AppTask::FunctionTimerEventHandler(AppEvent * aEvent)
     {
         // Actually trigger Factory Reset
         sAppTask.mFunction = kFunction_NoneSelected;
-        ConfigurationMgr().InitiateFactoryReset();
+        chip::Server::GetInstance().FactoryReset();
     }
 }
 

diff --git a/examples/ota-requestor-app/efr32/src/AppTask.cpp b/examples/ota-requestor-app/efr32/src/AppTask.cpp
@@ -350,7 +350,7 @@ void AppTask::FunctionTimerEventHandler(AppEvent * aEvent)
     {
         // Actually trigger Factory Reset
         sAppTask.mFunction = kFunction_NoneSelected;
-        ConfigurationMgr().InitiateFactoryReset();
+        chip::Server::GetInstance().FactoryReset();
     }
 }
 

diff --git a/examples/ota-requestor-app/mbed/main/AppTask.cpp b/examples/ota-requestor-app/mbed/main/AppTask.cpp
@@ -416,7 +416,7 @@ void AppTask::FunctionTimerEventHandler(AppEvent * aEvent)
             sAppTask.CancelTimer(kFunction_Button_1);
             sAppTask.mFunction[kFunction_Button_1] = kFunction_NoneSelected;
 
-            ConfigurationMgr().InitiateFactoryReset();
+            chip::Server::GetInstance().FactoryReset();
         }
         break;
     case kFunction_Button_2:

diff --git a/examples/pump-app/cc13x2x7_26x2x7/main/AppTask.cpp b/examples/pump-app/cc13x2x7_26x2x7/main/AppTask.cpp
@@ -352,7 +352,7 @@ void AppTask::DispatchEvent(AppEvent * aEvent)
         }
         else if (AppEvent::kAppEventButtonType_LongPressed == aEvent->ButtonEvent.Type)
         {
-            ConfigurationMgr().InitiateFactoryReset();
+            chip::Server::GetInstance().FactoryReset();
         }
         break;
 

diff --git a/examples/pump-app/nrfconnect/main/AppTask.cpp b/examples/pump-app/nrfconnect/main/AppTask.cpp
@@ -267,7 +267,8 @@ void AppTask::FunctionTimerEventHandler(AppEvent * aEvent)
     {
         // Actually trigger Factory Reset
         sAppTask.mFunction = kFunction_NoneSelected;
-        ConfigurationMgr().InitiateFactoryReset();
+
+        chip::Server::GetInstance().FactoryReset();
     }
 }
 

diff --git a/examples/pump-controller-app/cc13x2x7_26x2x7/main/AppTask.cpp b/examples/pump-controller-app/cc13x2x7_26x2x7/main/AppTask.cpp
@@ -335,7 +335,7 @@ void AppTask::DispatchEvent(AppEvent * aEvent)
         }
         else if (AppEvent::kAppEventButtonType_LongPressed == aEvent->ButtonEvent.Type)
         {
-            ConfigurationMgr().InitiateFactoryReset();
+            chip::Server::GetInstance().FactoryReset();
         }
         break;
 

diff --git a/examples/pump-controller-app/nrfconnect/main/AppTask.cpp b/examples/pump-controller-app/nrfconnect/main/AppTask.cpp
@@ -263,7 +263,8 @@ void AppTask::FunctionTimerEventHandler(AppEvent * aEvent)
     {
         // Actually trigger Factory Reset
         sAppTask.mFunction = kFunction_NoneSelected;
-        ConfigurationMgr().InitiateFactoryReset();
+
+        chip::Server::GetInstance().FactoryReset();
     }
 }
 

diff --git a/examples/shell/nxp/k32w/k32w0/main/AppTask.cpp b/examples/shell/nxp/k32w/k32w0/main/AppTask.cpp
@@ -286,7 +286,7 @@ void AppTask::FunctionTimerEventHandler(AppEvent * aEvent)
     K32W_LOG("Device will factory reset...");
 
     // Actually trigger Factory Reset
-    ConfigurationMgr().InitiateFactoryReset();
+    chip::Server::GetInstance().FactoryReset();
 }
 
 void AppTask::ResetActionEventHandler(AppEvent * aEvent)

diff --git a/examples/window-app/common/src/WindowApp.cpp b/examples/window-app/common/src/WindowApp.cpp
@@ -215,7 +215,7 @@ void WindowApp::DispatchEvent(const WindowApp::Event & event)
         break;
 
     case EventId::Reset:
-        ConfigurationMgr().InitiateFactoryReset();
+        chip::Server::GetInstance().FactoryReset();
         break;
 
     case EventId::UpPressed:

diff --git a/src/app/clusters/general-diagnostics-server/general-diagnostics-server.cpp b/src/app/clusters/general-diagnostics-server/general-diagnostics-server.cpp
@@ -195,11 +195,23 @@ class GeneralDiagnosticsDelegate : public DeviceLayer::ConnectivityManagerDelega
     }
 
     // Gets called when the device has been rebooted.
-    void OnDeviceRebooted() override
+    void OnDeviceRebooted(uint8_t bootReason) override
     {
         ChipLogProgress(Zcl, "GeneralDiagnosticsDelegate: OnDeviceRebooted");
 
         ReportAttributeOnAllEndpoints(GeneralDiagnostics::Attributes::BootReasons::Id);
+
+        for (auto endpoint : EnabledEndpointsWithServerCluster(GeneralDiagnostics::Id))
+        {
+            // If GeneralDiagnostics cluster is implemented on this endpoint
+            Events::BootReason::Type event{ static_cast<BootReasonType>(bootReason) };
+            EventNumber eventNumber;
+
+            if (CHIP_NO_ERROR != LogEvent(event, endpoint, eventNumber, EventOptions::Type::kUrgent))
+            {
+                ChipLogError(Zcl, "GeneralDiagnosticsDelegate: Failed to record BootReason event");
+            }
+        }
     }
 
     // Get called when the Node detects a hardware fault has been raised.

diff --git a/src/app/reporting/Engine.h b/src/app/reporting/Engine.h
@@ -120,6 +120,8 @@ class Engine
 
     uint32_t GetNumReportsInFlight() { return mNumReportsInFlight; }
 
+    void ScheduleUrgentEventDeliverySync();
+
 private:
     friend class TestReportingEngine;
     /**
@@ -165,7 +167,6 @@ class Engine
     CHIP_ERROR ScheduleUrgentEventDelivery(ConcreteEventPath & aPath);
     CHIP_ERROR ScheduleBufferPressureEventDelivery(uint32_t aBytesWritten);
     void GetMinEventLogPosition(uint32_t & aMinLogPosition);
-    void ScheduleUrgentEventDeliverySync();
 
     /**
      * If the provided path is a superset of our of our existing paths, update that existing path to match the

diff --git a/src/app/server/Server.cpp b/src/app/server/Server.cpp
@@ -298,6 +298,20 @@ void Server::DispatchShutDownAndStopEventLoop()
     chip::DeviceLayer::PlatformMgr().ScheduleWork(StopEventLoop);
 }
 
+void Server::FactoryReset()
+{
+    // Delete all fabrics and emit Leave event.
+    GetFabricTable().DeleteAllFabrics();
+
+    // Emit Shutdown event, as shutdown will come after factory reset.
+    DispatchShutDownEvent(0);
+
+    // Flush all dispatched events.
+    chip::app::InteractionModelEngine::GetInstance()->GetReportingEngine().ScheduleUrgentEventDeliverySync();
+
+    chip::DeviceLayer::ConfigurationMgr().InitiateFactoryReset();
+}
+
 void Server::Shutdown()
 {
     chip::Dnssd::ServiceAdvertiser::Instance().Shutdown();

diff --git a/src/app/server/Server.h b/src/app/server/Server.h
@@ -93,6 +93,8 @@ class Server
      */
     void DispatchShutDownAndStopEventLoop();
 
+    void FactoryReset();
+
     void Shutdown();
 
     static Server & GetInstance() { return sServer; }

diff --git a/src/include/platform/DiagnosticDataProvider.h b/src/include/platform/DiagnosticDataProvider.h
@@ -70,7 +70,7 @@ class GeneralDiagnosticsDelegate
      * @brief
      *   Called after the current device is rebooted.
      */
-    virtual void OnDeviceRebooted() {}
+    virtual void OnDeviceRebooted(uint8_t bootReason) {}
 
     /**
      * @brief

diff --git a/src/include/platform/internal/GenericPlatformManagerImpl.cpp b/src/include/platform/internal/GenericPlatformManagerImpl.cpp
@@ -298,7 +298,10 @@ void GenericPlatformManagerImpl<ImplClass>::HandleDeviceRebooted(intptr_t arg)
 
     if (generalDiagnosticsDelegate != nullptr)
     {
-        generalDiagnosticsDelegate->OnDeviceRebooted();
+        uint8_t bootReason;
+
+        ReturnOnFailure(GetDiagnosticDataProvider().GetBootReason(bootReason));
+        generalDiagnosticsDelegate->OnDeviceRebooted(bootReason);
     }
 
     // The StartUp event SHALL be emitted by a Node after completing a boot or reboot process

diff --git a/src/include/platform/internal/GenericPlatformManagerImpl_Zephyr.cpp b/src/include/platform/internal/GenericPlatformManagerImpl_Zephyr.cpp
@@ -35,6 +35,8 @@
 #include <system/SystemError.h>
 #include <system/SystemLayer.h>
 
+#include <power/reboot.h>
+
 #define DEFAULT_MIN_SLEEP_PERIOD (60 * 60 * 24 * 30) // Month [sec]
 
 namespace chip {
@@ -46,6 +48,7 @@ System::LayerSocketsLoop & SystemLayerSocketsLoop()
 {
     return static_cast<System::LayerSocketsLoop &>(DeviceLayer::SystemLayer());
 }
+
 } // anonymous namespace
 
 // Fully instantiate the generic implementation class in whatever compilation unit includes this file.
@@ -106,7 +109,12 @@ CHIP_ERROR GenericPlatformManagerImpl_Zephyr<ImplClass>::_StopEventLoopTask(void
 template <class ImplClass>
 CHIP_ERROR GenericPlatformManagerImpl_Zephyr<ImplClass>::_Shutdown(void)
 {
+#if CONFIG_REBOOT
+    sys_reboot(SYS_REBOOT_WARM);
+    return CHIP_NO_ERROR;
+#else
     return CHIP_ERROR_NOT_IMPLEMENTED;
+#endif
 }
 
 template <class ImplClass>

diff --git a/src/platform/Zephyr/ConfigurationManagerImpl.cpp b/src/platform/Zephyr/ConfigurationManagerImpl.cpp
@@ -36,8 +36,6 @@
 #include <lib/support/CodeUtils.h>
 #include <lib/support/logging/CHIPLogging.h>
 
-#include <power/reboot.h>
-
 namespace chip {
 namespace DeviceLayer {
 
@@ -204,9 +202,7 @@ void ConfigurationManagerImpl::DoFactoryReset(intptr_t arg)
     ThreadStackMgr().ErasePersistentInfo();
 #endif // CHIP_DEVICE_CONFIG_ENABLE_THREAD
 
-#if CONFIG_REBOOT
-    sys_reboot(SYS_REBOOT_WARM);
-#endif
+    PlatformMgr().Shutdown();
 }
 
 } // namespace DeviceLayer

diff --git a/src/platform/Zephyr/ConfigurationManagerImpl.h b/src/platform/Zephyr/ConfigurationManagerImpl.h
@@ -81,7 +81,12 @@ inline bool ConfigurationManagerImpl::CanFactoryReset()
 
 inline CHIP_ERROR ConfigurationManagerImpl::ReadPersistedStorageValue(::chip::Platform::PersistedStorage::Key key, uint32_t & value)
 {
-    return Internal::ZephyrConfig::ReadConfigValueCounter(key, value);
+    CHIP_ERROR err = Internal::ZephyrConfig::ReadConfigValueCounter(key, value);
+    if (err == CHIP_DEVICE_ERROR_CONFIG_NOT_FOUND)
+    {
+        err = CHIP_ERROR_PERSISTED_STORAGE_VALUE_NOT_FOUND;
+    }
+    return err;
 }
 
 inline CHIP_ERROR ConfigurationManagerImpl::WritePersistedStorageValue(::chip::Platform::PersistedStorage::Key key, uint32_t value)
-Original file line number
+Diff line change
@@ Expand Up / @@ -352,7 +352,7 @@ void AppTask::DispatchEvent(AppEvent * aEvent) @@
             }
             else if (AppEvent::kAppEventButtonType_LongPressed == aEvent->ButtonEvent.Type)
             {
-                ConfigurationMgr().InitiateFactoryReset();
+                chip::Server::GetInstance().FactoryReset();
             }
             break;
@@ Expand Down @@