[nrf5-example] Use ConfigurationMgr().InitiateFactoryReset() (project-chip#1317)

erjiaqing · bukepo · web-flow · commit 5f0b9205ae71 · 2020-06-29T09:06:17.000-07:00
* Add factory reset to NRF5 platform

* Make name consistent with ot

* Update src/platform/nRF5/ConfigurationManagerImpl.cpp

Co-authored-by: Yakun Xu &lt;xyk@google.com&gt;

Co-authored-by: Yakun Xu &lt;xyk@google.com&gt;
diff --git a/examples/lock-app/nrf5/main/AppTask.cpp b/examples/lock-app/nrf5/main/AppTask.cpp
@@ -338,7 +338,7 @@ void AppTask::FunctionTimerEventHandler(AppEvent * aEvent)
     {
         // Actually trigger Factory Reset
         sAppTask.mFunction = kFunction_NoneSelected;
-        ThreadStackMgr().FactoryReset();
+        ConfigurationMgr().InitiateFactoryReset();
     }
 }
 
diff --git a/src/include/platform/ConnectivityManager.h b/src/include/platform/ConnectivityManager.h
@@ -136,7 +136,7 @@ class ConnectivityManager
     CHIP_ERROR SetThreadPollingConfig(const ThreadPollingConfig & pollingConfig);
     bool IsThreadAttached(void);
     bool IsThreadProvisioned(void);
-    void ClearThreadProvision(void);
+    void ErasePersistentInfo(void);
     bool HaveServiceConnectivityViaThread(void);
 
     // Internet connectivity methods
@@ -441,9 +441,9 @@ inline bool ConnectivityManager::IsThreadProvisioned(void)
     return static_cast<ImplClass *>(this)->_IsThreadProvisioned();
 }
 
-inline void ConnectivityManager::ClearThreadProvision(void)
+inline void ConnectivityManager::ErasePersistentInfo(void)
 {
-    static_cast<ImplClass *>(this)->_ClearThreadProvision();
+    static_cast<ImplClass *>(this)->_ErasePersistentInfo();
 }
 
 inline bool ConnectivityManager::HaveServiceConnectivityViaThread(void)
diff --git a/src/include/platform/ThreadStackManager.h b/src/include/platform/ThreadStackManager.h
@@ -106,7 +106,7 @@ class ThreadStackManager
     bool IsThreadAttached(void);
     CHIP_ERROR GetThreadProvision(Internal::DeviceNetworkInfo & netInfo, bool includeCredentials);
     CHIP_ERROR SetThreadProvision(const Internal::DeviceNetworkInfo & netInfo);
-    void ClearThreadProvision(void);
+    void ErasePersistentInfo(void);
     ConnectivityManager::ThreadDeviceType GetThreadDeviceType(void);
     CHIP_ERROR SetThreadDeviceType(ConnectivityManager::ThreadDeviceType threadRole);
     void GetThreadPollingConfig(ConnectivityManager::ThreadPollingConfig & pollingConfig);
@@ -232,9 +232,9 @@ inline CHIP_ERROR ThreadStackManager::SetThreadProvision(const Internal::DeviceN
     return static_cast<ImplClass *>(this)->_SetThreadProvision(netInfo);
 }
 
-inline void ThreadStackManager::ClearThreadProvision(void)
+inline void ThreadStackManager::ErasePersistentInfo(void)
 {
-    static_cast<ImplClass *>(this)->_ClearThreadProvision();
+    static_cast<ImplClass *>(this)->_ErasePersistentInfo();
 }
 
 inline ConnectivityManager::ThreadDeviceType ThreadStackManager::GetThreadDeviceType(void)
@@ -297,11 +297,6 @@ inline CHIP_ERROR ThreadStackManager::GetPrimary802154MACAddress(uint8_t * buf)
     return static_cast<ImplClass *>(this)->_GetPrimary802154MACAddress(buf);
 }
 
-inline void ThreadStackManager::FactoryReset()
-{
-    return static_cast<ImplClass *>(this)->_FactoryReset();
-}
-
 } // namespace DeviceLayer
 } // namespace chip
 
diff --git a/src/include/platform/internal/GenericConnectivityManagerImpl_NoThread.h b/src/include/platform/internal/GenericConnectivityManagerImpl_NoThread.h
@@ -53,7 +53,7 @@ class GenericConnectivityManagerImpl_NoThread
     CHIP_ERROR _SetThreadPollingConfig(const ConnectivityManager::ThreadPollingConfig & pollingConfig);
     bool _IsThreadAttached(void);
     bool _IsThreadProvisioned(void);
-    void _ClearThreadProvision(void);
+    void _ErasePersistentInfo(void);
     bool _HaveServiceConnectivityViaThread(void);
 
     ImplClass * Impl() { return static_cast<ImplClass *>(this); }
@@ -96,7 +96,7 @@ inline bool GenericConnectivityManagerImpl_NoThread<ImplClass>::_IsThreadProvisi
 }
 
 template <class ImplClass>
-inline void GenericConnectivityManagerImpl_NoThread<ImplClass>::_ClearThreadProvision(void)
+inline void GenericConnectivityManagerImpl_NoThread<ImplClass>::_ErasePersistentInfo(void)
 {}
 
 template <class ImplClass>
diff --git a/src/include/platform/internal/GenericConnectivityManagerImpl_Thread.h b/src/include/platform/internal/GenericConnectivityManagerImpl_Thread.h
@@ -64,7 +64,7 @@ class GenericConnectivityManagerImpl_Thread
     CHIP_ERROR _SetThreadPollingConfig(const ConnectivityManager::ThreadPollingConfig & pollingConfig);
     bool _IsThreadAttached(void);
     bool _IsThreadProvisioned(void);
-    void _ClearThreadProvision(void);
+    void _ErasePersistentInfo(void);
     bool _HaveServiceConnectivityViaThread(void);
 
     // ===== Members for use by the implementation subclass.
@@ -119,9 +119,9 @@ inline bool GenericConnectivityManagerImpl_Thread<ImplClass>::_IsThreadProvision
 }
 
 template <class ImplClass>
-inline void GenericConnectivityManagerImpl_Thread<ImplClass>::_ClearThreadProvision(void)
+inline void GenericConnectivityManagerImpl_Thread<ImplClass>::_ErasePersistentInfo(void)
 {
-    ThreadStackMgrImpl().ClearThreadProvision();
+    ThreadStackMgrImpl().ErasePersistentInfo();
 }
 
 template <class ImplClass>
diff --git a/src/include/platform/internal/GenericNetworkProvisioningServerImpl.ipp b/src/include/platform/internal/GenericNetworkProvisioningServerImpl.ipp
@@ -27,8 +27,8 @@
 #define GENERIC_NETWORK_PROVISIONING_SERVER_IMPL_IPP
 
 #include <platform/internal/CHIPDeviceLayerInternal.h>
-#include <platform/internal/NetworkProvisioningServer.h>
 #include <platform/internal/GenericNetworkProvisioningServerImpl.h>
+#include <platform/internal/NetworkProvisioningServer.h>
 #if CHIP_DEVICE_CONFIG_ENABLE_THREAD
 #include <platform/ThreadStackManager.h>
 #endif // CHIP_DEVICE_CONFIG_ENABLE_THREAD
@@ -431,7 +431,7 @@ CHIP_ERROR GenericNetworkProvisioningServerImpl<ImplClass>::HandleRemoveNetwork(
         }
 
         // Clear the Thread provision.
-        ThreadStackMgr().ClearThreadProvision();
+        ThreadStackMgr().ErasePersistentInfo();
 
         break;
 
diff --git a/src/platform/EFR32/ConfigurationManagerImpl.cpp b/src/platform/EFR32/ConfigurationManagerImpl.cpp
@@ -141,7 +141,7 @@ void ConfigurationManagerImpl::DoFactoryReset(intptr_t arg)
 #if CHIP_DEVICE_CONFIG_ENABLE_THREAD
 
     ChipLogProgress(DeviceLayer, "Clearing Thread provision");
-    ThreadStackMgr().ClearThreadProvision();
+    ThreadStackMgr().ErasePersistentInfo();
 
 #endif // CHIP_DEVICE_CONFIG_ENABLE_THREAD
 
diff --git a/src/platform/Linux/ConfigurationManagerImpl.cpp b/src/platform/Linux/ConfigurationManagerImpl.cpp
@@ -162,7 +162,7 @@ void ConfigurationManagerImpl::DoFactoryReset(intptr_t arg)
 #if CHIP_DEVICE_CONFIG_ENABLE_THREAD
 
     ChipLogProgress(DeviceLayer, "Clearing Thread provision");
-    ThreadStackMgr().ClearThreadProvision();
+    ThreadStackMgr().ErasePersistentInfo();
 
 #endif // CHIP_DEVICE_CONFIG_ENABLE_THREAD
 
diff --git a/src/platform/OpenThread/GenericThreadStackManagerImpl_OpenThread.h b/src/platform/OpenThread/GenericThreadStackManagerImpl_OpenThread.h
@@ -70,7 +70,7 @@ class GenericThreadStackManagerImpl_OpenThread
     bool _IsThreadAttached(void);
     CHIP_ERROR _GetThreadProvision(DeviceNetworkInfo & netInfo, bool includeCredentials);
     CHIP_ERROR _SetThreadProvision(const DeviceNetworkInfo & netInfo);
-    void _ClearThreadProvision(void);
+    void _ErasePersistentInfo(void);
     ConnectivityManager::ThreadDeviceType _GetThreadDeviceType(void);
     CHIP_ERROR _SetThreadDeviceType(ConnectivityManager::ThreadDeviceType deviceType);
     void _GetThreadPollingConfig(ConnectivityManager::ThreadPollingConfig & pollingConfig);
@@ -89,7 +89,6 @@ class GenericThreadStackManagerImpl_OpenThread
     CHIP_ERROR DoInit(otInstance * otInst);
     bool IsThreadAttachedNoLock(void);
     CHIP_ERROR AdjustPollingInterval(void);
-    void _FactoryReset(void);
 
 private:
     // ===== Private members for use by this class only.
diff --git a/src/platform/OpenThread/GenericThreadStackManagerImpl_OpenThread.ipp b/src/platform/OpenThread/GenericThreadStackManagerImpl_OpenThread.ipp
@@ -810,11 +810,12 @@ CHIP_ERROR GenericThreadStackManagerImpl_OpenThread<ImplClass>::AdjustPollingInt
 }
 
 template <class ImplClass>
-void GenericThreadStackManagerImpl_OpenThread<ImplClass>::_FactoryReset(void)
+void GenericThreadStackManagerImpl_OpenThread<ImplClass>::_ErasePersistentInfo(void)
 {
-    ChipLogProgress(DeviceLayer, "About to factory reset ...");
+    ChipLogProgress(DeviceLayer, "Erasing Thread persistent info...");
     Impl()->LockThreadStack();
-    otInstanceFactoryReset(mOTInst);
+    otThreadSetEnabled(mOTInst, false);
+    otInstanceErasePersistentInfo(mOTInst);
     Impl()->UnlockThreadStack();
 }
 
diff --git a/src/platform/nRF5/ConfigurationManagerImpl.cpp b/src/platform/nRF5/ConfigurationManagerImpl.cpp
@@ -144,8 +144,7 @@ void ConfigurationManagerImpl::DoFactoryReset(intptr_t arg)
 
 #if CHIP_DEVICE_CONFIG_ENABLE_THREAD
 
-    ChipLogProgress(DeviceLayer, "Clearing Thread provision");
-    ThreadStackMgr().ClearThreadProvision();
+    ThreadStackMgr().ErasePersistentInfo();
 
 #endif // CHIP_DEVICE_CONFIG_ENABLE_THREAD
 

Original file line number	Diff line number	Diff line change
`@@ -338,7 +338,7 @@ void AppTask::FunctionTimerEventHandler(AppEvent * aEvent)`
`338`	`338`	`{`
`339`	`339`	`// Actually trigger Factory Reset`
`340`	`340`	`sAppTask.mFunction = kFunction_NoneSelected;`
`341`		`- ThreadStackMgr().FactoryReset();`
	`341`	`+ ConfigurationMgr().InitiateFactoryReset();`
`342`	`342`	`}`
`343`	`343`	`}`
`344`	`344`
Original file line number	Diff line number	Diff line change
`@@ -136,7 +136,7 @@ class ConnectivityManager`
`136`	`136`	`CHIP_ERROR SetThreadPollingConfig(const ThreadPollingConfig & pollingConfig);`
`137`	`137`	`bool IsThreadAttached(void);`
`138`	`138`	`bool IsThreadProvisioned(void);`
`139`		`- void ClearThreadProvision(void);`
	`139`	`+ void ErasePersistentInfo(void);`
`140`	`140`	`bool HaveServiceConnectivityViaThread(void);`
`141`	`141`
`142`	`142`	`// Internet connectivity methods`
`@@ -441,9 +441,9 @@ inline bool ConnectivityManager::IsThreadProvisioned(void)`
`441`	`441`	`return static_cast<ImplClass *>(this)->_IsThreadProvisioned();`
`442`	`442`	`}`
`443`	`443`
`444`		`-inline void ConnectivityManager::ClearThreadProvision(void)`
	`444`	`+inline void ConnectivityManager::ErasePersistentInfo(void)`
`445`	`445`	`{`
`446`		`- static_cast<ImplClass *>(this)->_ClearThreadProvision();`
	`446`	`+ static_cast<ImplClass *>(this)->_ErasePersistentInfo();`
`447`	`447`	`}`
`448`	`448`
`449`	`449`	`inline bool ConnectivityManager::HaveServiceConnectivityViaThread(void)`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ class GenericConnectivityManagerImpl_Thread`
`64`	`64`	`CHIP_ERROR _SetThreadPollingConfig(const ConnectivityManager::ThreadPollingConfig & pollingConfig);`
`65`	`65`	`bool _IsThreadAttached(void);`
`66`	`66`	`bool _IsThreadProvisioned(void);`
`67`		`- void _ClearThreadProvision(void);`
	`67`	`+ void _ErasePersistentInfo(void);`
`68`	`68`	`bool _HaveServiceConnectivityViaThread(void);`
`69`	`69`
`70`	`70`	`// ===== Members for use by the implementation subclass.`
`@@ -119,9 +119,9 @@ inline bool GenericConnectivityManagerImpl_Thread<ImplClass>::_IsThreadProvision`
`119`	`119`	`}`
`120`	`120`
`121`	`121`	`template <class ImplClass>`
`122`		`-inline void GenericConnectivityManagerImpl_Thread<ImplClass>::_ClearThreadProvision(void)`
	`122`	`+inline void GenericConnectivityManagerImpl_Thread<ImplClass>::_ErasePersistentInfo(void)`
`123`	`123`	`{`
`124`		`- ThreadStackMgrImpl().ClearThreadProvision();`
	`124`	`+ ThreadStackMgrImpl().ErasePersistentInfo();`
`125`	`125`	`}`
`126`	`126`
`127`	`127`	`template <class ImplClass>`
Original file line number	Diff line number	Diff line change
`@@ -810,11 +810,12 @@ CHIP_ERROR GenericThreadStackManagerImpl_OpenThread<ImplClass>::AdjustPollingInt`
`810`	`810`	`}`
`811`	`811`
`812`	`812`	`template <class ImplClass>`
`813`		`-void GenericThreadStackManagerImpl_OpenThread<ImplClass>::_FactoryReset(void)`
	`813`	`+void GenericThreadStackManagerImpl_OpenThread<ImplClass>::_ErasePersistentInfo(void)`
`814`	`814`	`{`
`815`		`- ChipLogProgress(DeviceLayer, "About to factory reset ...");`
	`815`	`+ ChipLogProgress(DeviceLayer, "Erasing Thread persistent info...");`
`816`	`816`	`Impl()->LockThreadStack();`
`817`		`- otInstanceFactoryReset(mOTInst);`
	`817`	`+ otThreadSetEnabled(mOTInst, false);`
	`818`	`+ otInstanceErasePersistentInfo(mOTInst);`
`818`	`819`	`Impl()->UnlockThreadStack();`
`819`	`820`	`}`
`820`	`821`