Add switching between fast and slow polling interval for SED (#11314)

The spec says about sleepy end devices (SED) that they should switch between active and idle modes and use fast or slow polling intervals depending on the commissioning window opening and existing active exchanges. Currently the slow polling interval is used all the time. Moreover setting CRA/CRI values is not compatible with the spec (as both values use the same polling interval, not the other ones). * Exposed existing Thread SED polling configuration API to the ConnectivityManager that will allow using also for SEDs of different technologies. * Added few CHIP_DEVICE_CONFIG SED defines that enables SED support in Matter and configure the slow and fast polling intervals. * Added setting SED ACTIVE mode if commissioning window is opened and SED IDLE if it's closed * Added setting SED ACTIVE mode if during a message exchange device expects getting response (and further communication). In other case mode is set to IDLE, as device doesn't need to wait for response. * Added generating kSEDPollingIntervalChange event on polling configuration change and handling it to refresh CRA/CRI values advertised in operational discovery service. * Modified calculating CRA and CRI values to use respectively fast and slow polling intervals instead the same one in both cases. * Aligned examples configuring SED poll interval to follow the new convention (removed setting poll configs, as it is done automatically by the ThreadStackMgr).
project-chip · Mar 7, 2022 · 1699906 · 1699906
1 parent ce31ddb
commit 1699906
Show file tree

Hide file tree

Showing 38 changed files with 364 additions and 230 deletions.
diff --git a/config/zephyr/Kconfig b/config/zephyr/Kconfig
@@ -93,6 +93,14 @@ config CHIP_ENABLE_DNS_CLIENT
 	help
 	  Enables DNS client support used for resolving and browsing services.
 
+config CHIP_ENABLE_SLEEPY_END_DEVICE_SUPPORT
+	bool "Enable sleepy end device support"
+	default n
+	depends on OPENTHREAD_MTD
+	imply OPENTHREAD_MTD_SED
+	help
+	  Enables Thread Sleepy End Device support in Matter.
+
 config APP_LINK_WITH_CHIP
 	bool "Link 'app' with Connected Home over IP"
 	default y

diff --git a/examples/lighting-app/efr32/include/AppConfig.h b/examples/lighting-app/efr32/include/AppConfig.h
@@ -27,10 +27,6 @@
 // state to another.
 #define ACTUATOR_MOVEMENT_PERIOS_MS 10
 
-// ---- Thread Polling Config ----
-#define THREAD_ACTIVE_POLLING_INTERVAL_MS 100
-#define THREAD_INACTIVE_POLLING_INTERVAL_MS 1000
-
 // EFR Logging
 #ifdef __cplusplus
 extern "C" {

diff --git a/examples/lighting-app/nxp/k32w/k32w0/main/include/app_config.h b/examples/lighting-app/nxp/k32w/k32w0/main/include/app_config.h
@@ -44,10 +44,6 @@
 #define SWU_INTERVAl_WINDOW_MIN_MS (23 * 60 * 60 * 1000) // 23 hours
 #define SWU_INTERVAl_WINDOW_MAX_MS (24 * 60 * 60 * 1000) // 24 hours
 
-// ---- Thread Polling Config ----
-#define THREAD_ACTIVE_POLLING_INTERVAL_MS 100
-#define THREAD_INACTIVE_POLLING_INTERVAL_MS 1000
-
 #if K32W_LOG_ENABLED
 #define K32W_LOG(...) otPlatLog(OT_LOG_LEVEL_NONE, OT_LOG_REGION_API, ##__VA_ARGS__);
 #else

diff --git a/examples/lighting-app/qpg/include/AppConfig.h b/examples/lighting-app/qpg/include/AppConfig.h
@@ -27,8 +27,4 @@
 
 #define SYSTEM_STATE_LED LED_GREEN
 
-// ---- Thread Polling Config ----
-#define THREAD_ACTIVE_POLLING_INTERVAL_MS 100
-#define THREAD_INACTIVE_POLLING_INTERVAL_MS 1000
-
 #endif // APP_CONFIG_H
diff --git a/examples/lock-app/cc13x2x7_26x2x7/main/AppTask.cpp b/examples/lock-app/cc13x2x7_26x2x7/main/AppTask.cpp
@@ -83,7 +83,6 @@ int AppTask::Init()
 {
     LED_Params ledParams;
     Button_Params buttionParams;
-    ConnectivityManager::ThreadPollingConfig pollingConfig;
 
     cc13x2_26x2LogInit();
 
@@ -114,18 +113,6 @@ int AppTask::Init()
             ;
     }
 
-    pollingConfig.Clear();
-    pollingConfig.ActivePollingIntervalMS   = 5000; // ms
-    pollingConfig.InactivePollingIntervalMS = 5000; // ms
-
-    ret = ConnectivityMgr().SetThreadPollingConfig(pollingConfig);
-    if (ret != CHIP_NO_ERROR)
-    {
-        PLAT_LOG("ConnectivityMgr().SetThreadPollingConfig() failed");
-        while (1)
-            ;
-    }
-
     ret = PlatformMgr().StartEventLoopTask();
     if (ret != CHIP_NO_ERROR)
     {

diff --git a/examples/lock-app/cc13x2x7_26x2x7/main/include/CHIPProjectConfig.h b/examples/lock-app/cc13x2x7_26x2x7/main/include/CHIPProjectConfig.h
@@ -148,6 +148,10 @@
  */
 #define CHIP_DEVICE_CONFIG_ENABLE_THREAD_SRP_CLIENT 1
 
+#define CHIP_DEVICE_CONFIG_ENABLE_SED 1
+#define CHIP_DEVICE_CONFIG_SED_SLOW_POLLING_INTERVAL 5000
+#define CHIP_DEVICE_CONFIG_SED_FAST_POLLING_INTERVAL 5000
+
 /**
  * CHIP_CONFIG_EVENT_LOGGING_DEFAULT_IMPORTANCE
  *

diff --git a/examples/lock-app/efr32/include/AppConfig.h b/examples/lock-app/efr32/include/AppConfig.h
@@ -27,10 +27,6 @@
 // state to another.
 #define ACTUATOR_MOVEMENT_PERIOS_MS 2000
 
-// ---- Thread Polling Config ----
-#define THREAD_ACTIVE_POLLING_INTERVAL_MS 100
-#define THREAD_INACTIVE_POLLING_INTERVAL_MS 1000
-
 // EFR Logging
 #ifdef __cplusplus
 extern "C" {

diff --git a/examples/lock-app/nrfconnect/main/include/CHIPProjectConfig.h b/examples/lock-app/nrfconnect/main/include/CHIPProjectConfig.h
@@ -37,3 +37,5 @@
 // Use a default pairing code if one hasn't been provisioned in flash.
 #define CHIP_DEVICE_CONFIG_USE_TEST_SETUP_PIN_CODE 20202021
 #define CHIP_DEVICE_CONFIG_USE_TEST_SETUP_DISCRIMINATOR 0xF00
+
+#define CHIP_DEVICE_CONFIG_SED_SLOW_POLLING_INTERVAL 2000
diff --git a/examples/lock-app/nrfconnect/main/main.cpp b/examples/lock-app/nrfconnect/main/main.cpp
@@ -68,31 +68,14 @@ int main()
 
 #ifdef CONFIG_OPENTHREAD_MTD_SED
     err = ConnectivityMgr().SetThreadDeviceType(ConnectivityManager::kThreadDeviceType_SleepyEndDevice);
-    if (err != CHIP_NO_ERROR)
-    {
-        LOG_ERR("ConnectivityMgr().SetThreadDeviceType() failed");
-        goto exit;
-    }
-
-    ConnectivityManager::ThreadPollingConfig pollingConfig;
-    pollingConfig.Clear();
-    pollingConfig.ActivePollingIntervalMS   = CONFIG_OPENTHREAD_POLL_PERIOD;
-    pollingConfig.InactivePollingIntervalMS = CONFIG_OPENTHREAD_POLL_PERIOD;
-
-    err = ConnectivityMgr().SetThreadPollingConfig(pollingConfig);
-    if (err != CHIP_NO_ERROR)
-    {
-        LOG_ERR("ConnectivityMgr().SetThreadPollingConfig() failed");
-        goto exit;
-    }
 #else
     err = ConnectivityMgr().SetThreadDeviceType(ConnectivityManager::kThreadDeviceType_MinimalEndDevice);
+#endif
     if (err != CHIP_NO_ERROR)
     {
         LOG_ERR("ConnectivityMgr().SetThreadDeviceType() failed");
         goto exit;
     }
-#endif
 
     ret = GetAppTask().StartApp();
     if (ret != 0)

diff --git a/examples/lock-app/nrfconnect/overlay-low_power.conf b/examples/lock-app/nrfconnect/overlay-low_power.conf
@@ -15,8 +15,7 @@
 #
 
 # Enable MTD Sleepy End Device
-CONFIG_OPENTHREAD_MTD_SED=y
-CONFIG_OPENTHREAD_POLL_PERIOD=2000
+CONFIG_CHIP_ENABLE_SLEEPY_END_DEVICE_SUPPORT=y
 
 # Disable UART console
 CONFIG_SHELL=n

diff --git a/examples/lock-app/nxp/k32w/k32w0/include/CHIPProjectConfig.h b/examples/lock-app/nxp/k32w/k32w0/include/CHIPProjectConfig.h
@@ -201,6 +201,10 @@
  */
 #define CHIP_CONFIG_MAX_DEVICE_ADMINS 4 // 3 fabrics + 1 for rotation slack
 
+#define CHIP_DEVICE_CONFIG_ENABLE_SED 1
+#define CHIP_DEVICE_CONFIG_SED_SLOW_POLLING_INTERVAL 1000
+#define CHIP_DEVICE_CONFIG_SED_FAST_POLLING_INTERVAL 100
+
 /**
  * CHIP_CONFIG_EVENT_LOGGING_DEFAULT_IMPORTANCE
  *

diff --git a/examples/lock-app/nxp/k32w/k32w0/main/main.cpp b/examples/lock-app/nxp/k32w/k32w0/main/main.cpp
@@ -145,21 +145,6 @@ extern "C" void main_task(void const * argument)
         goto exit;
     }
 
-    // Configure the Thread polling behavior for the device.
-    {
-        ConnectivityManager::ThreadPollingConfig pollingConfig;
-        pollingConfig.Clear();
-        pollingConfig.ActivePollingIntervalMS   = THREAD_ACTIVE_POLLING_INTERVAL_MS;
-        pollingConfig.InactivePollingIntervalMS = THREAD_INACTIVE_POLLING_INTERVAL_MS;
-
-        ret = ConnectivityMgr().SetThreadPollingConfig(pollingConfig);
-        if (ret != CHIP_NO_ERROR)
-        {
-            K32W_LOG("Error during ConnectivityMgr().SetThreadPollingConfig(pollingConfig)");
-            goto exit;
-        }
-    }
-
     ret = PlatformMgr().StartEventLoopTask();
     if (ret != CHIP_NO_ERROR)
     {

diff --git a/examples/lock-app/qpg/include/AppConfig.h b/examples/lock-app/qpg/include/AppConfig.h
@@ -35,8 +35,4 @@
 #define SWU_INTERVAl_WINDOW_MIN_MS (23 * 60 * 60 * 1000) // 23 hours
 #define SWU_INTERVAl_WINDOW_MAX_MS (24 * 60 * 60 * 1000) // 24 hours
 
-// ---- Thread Polling Config ----
-#define THREAD_ACTIVE_POLLING_INTERVAL_MS 100
-#define THREAD_INACTIVE_POLLING_INTERVAL_MS 1000
-
 #endif // APP_CONFIG_H
diff --git a/examples/pump-app/cc13x2x7_26x2x7/main/AppTask.cpp b/examples/pump-app/cc13x2x7_26x2x7/main/AppTask.cpp
@@ -94,7 +94,6 @@ int AppTask::Init()
 {
     LED_Params ledParams;
     Button_Params buttonParams;
-    ConnectivityManager::ThreadPollingConfig pollingConfig;
 
     cc13x2_26x2LogInit();
 
@@ -125,18 +124,6 @@ int AppTask::Init()
             ;
     }
 
-    pollingConfig.Clear();
-    pollingConfig.ActivePollingIntervalMS   = 5000; // ms
-    pollingConfig.InactivePollingIntervalMS = 5000; // ms
-
-    ret = ConnectivityMgr().SetThreadPollingConfig(pollingConfig);
-    if (ret != CHIP_NO_ERROR)
-    {
-        PLAT_LOG("ConnectivityMgr().SetThreadPollingConfig() failed");
-        while (1)
-            ;
-    }
-
     ret = PlatformMgr().StartEventLoopTask();
     if (ret != CHIP_NO_ERROR)
     {

diff --git a/examples/pump-app/cc13x2x7_26x2x7/main/include/CHIPProjectConfig.h b/examples/pump-app/cc13x2x7_26x2x7/main/include/CHIPProjectConfig.h
@@ -140,6 +140,10 @@
  */
 #define CHIP_DEVICE_CONFIG_ENABLE_THREAD_SRP_CLIENT 1
 
+#define CHIP_DEVICE_CONFIG_ENABLE_SED 1
+#define CHIP_DEVICE_CONFIG_SED_SLOW_POLLING_INTERVAL 5000
+#define CHIP_DEVICE_CONFIG_SED_FAST_POLLING_INTERVAL 5000
+
 /**
  * CHIP_CONFIG_EVENT_LOGGING_DEFAULT_IMPORTANCE
  *

diff --git a/examples/pump-controller-app/cc13x2x7_26x2x7/main/AppTask.cpp b/examples/pump-controller-app/cc13x2x7_26x2x7/main/AppTask.cpp
@@ -89,7 +89,6 @@ int AppTask::Init()
 {
     LED_Params ledParams;
     Button_Params buttonParams;
-    ConnectivityManager::ThreadPollingConfig pollingConfig;
 
     cc13x2_26x2LogInit();
 
@@ -120,18 +119,6 @@ int AppTask::Init()
             ;
     }
 
-    pollingConfig.Clear();
-    pollingConfig.ActivePollingIntervalMS   = 5000; // ms
-    pollingConfig.InactivePollingIntervalMS = 5000; // ms
-
-    ret = ConnectivityMgr().SetThreadPollingConfig(pollingConfig);
-    if (ret != CHIP_NO_ERROR)
-    {
-        PLAT_LOG("ConnectivityMgr().SetThreadPollingConfig() failed");
-        while (1)
-            ;
-    }
-
     ret = PlatformMgr().StartEventLoopTask();
     if (ret != CHIP_NO_ERROR)
     {

diff --git a/examples/pump-controller-app/cc13x2x7_26x2x7/main/include/CHIPProjectConfig.h b/examples/pump-controller-app/cc13x2x7_26x2x7/main/include/CHIPProjectConfig.h
@@ -140,6 +140,10 @@
  */
 #define CHIP_DEVICE_CONFIG_ENABLE_THREAD_SRP_CLIENT 1
 
+#define CHIP_DEVICE_CONFIG_ENABLE_SED 1
+#define CHIP_DEVICE_CONFIG_SED_SLOW_POLLING_INTERVAL 5000
+#define CHIP_DEVICE_CONFIG_SED_FAST_POLLING_INTERVAL 5000
+
 /**
  * CHIP_CONFIG_EVENT_LOGGING_DEFAULT_IMPORTANCE
  *

diff --git a/examples/shell/efr32/include/AppConfig.h b/examples/shell/efr32/include/AppConfig.h
@@ -49,10 +49,6 @@
 #define SWU_INTERVAl_WINDOW_MIN_MS (23 * 60 * 60 * 1000) // 23 hours
 #define SWU_INTERVAl_WINDOW_MAX_MS (24 * 60 * 60 * 1000) // 24 hours
 
-// ---- Thread Polling Config ----
-#define THREAD_ACTIVE_POLLING_INTERVAL_MS 100
-#define THREAD_INACTIVE_POLLING_INTERVAL_MS 1000
-
 // EFR Logging
 #ifdef __cplusplus
 extern "C" {

diff --git a/examples/shell/nxp/k32w/k32w0/main/include/app_config.h b/examples/shell/nxp/k32w/k32w0/main/include/app_config.h
@@ -45,10 +45,6 @@
 #define SWU_INTERVAl_WINDOW_MIN_MS (23 * 60 * 60 * 1000) // 23 hours
 #define SWU_INTERVAl_WINDOW_MAX_MS (24 * 60 * 60 * 1000) // 24 hours
 
-// ---- Thread Polling Config ----
-#define THREAD_ACTIVE_POLLING_INTERVAL_MS 100
-#define THREAD_INACTIVE_POLLING_INTERVAL_MS 1000
-
 #if K32W_LOG_ENABLED
 #define K32W_LOG(...) otPlatLog(OT_LOG_LEVEL_NONE, OT_LOG_REGION_API, ##__VA_ARGS__);
 #else

diff --git a/src/app/server/CommissioningWindowManager.cpp b/src/app/server/CommissioningWindowManager.cpp
@@ -275,6 +275,11 @@ CHIP_ERROR CommissioningWindowManager::StartAdvertisement()
         mAppDelegate->OnPairingWindowOpened();
     }
     mCommissioningWindowOpen = true;
+
+#if CHIP_DEVICE_CONFIG_ENABLE_SED
+    DeviceLayer::ConnectivityMgr().RequestSEDFastPollingMode(true);
+#endif
+
     return CHIP_NO_ERROR;
 }
 
@@ -287,6 +292,10 @@ CHIP_ERROR CommissioningWindowManager::StopAdvertisement()
 
     mCommissioningWindowOpen = false;
 
+#if CHIP_DEVICE_CONFIG_ENABLE_SED
+    DeviceLayer::ConnectivityMgr().RequestSEDFastPollingMode(false);
+#endif
+
     if (mIsBLE)
     {
         ReturnErrorOnFailure(chip::DeviceLayer::ConnectivityMgr().SetBLEAdvertisingEnabled(false));

diff --git a/src/app/server/Dnssd.cpp b/src/app/server/Dnssd.cpp
@@ -58,7 +58,11 @@ bool HaveOperationalCredentials()
 
 void OnPlatformEvent(const DeviceLayer::ChipDeviceEvent * event)
 {
-    if (event->Type == DeviceLayer::DeviceEventType::kDnssdPlatformInitialized)
+    if (event->Type == DeviceLayer::DeviceEventType::kDnssdPlatformInitialized
+#if CHIP_DEVICE_CONFIG_ENABLE_SED
+        || event->Type == DeviceLayer::DeviceEventType::kSEDPollingIntervalChange
+#endif
+    )
     {
         app::DnssdServer::Instance().StartServer();
     }

diff --git a/src/include/platform/CHIPDeviceConfig.h b/src/include/platform/CHIPDeviceConfig.h
@@ -116,6 +116,35 @@
 #define CHIP_DEVICE_CONFIG_LOG_PROVISIONING_HASH 1
 #endif
 
+/**
+ * CHIP_DEVICE_CONFIG_ENABLE_SED
+ *
+ * Enable support for sleepy end device behavior.
+ */
+#ifndef CHIP_DEVICE_CONFIG_ENABLE_SED
+#define CHIP_DEVICE_CONFIG_ENABLE_SED 0
+#endif
+
+/**
+ * CHIP_DEVICE_CONFIG_SED_SLOW_POLLING_INTERVAL
+ *
+ * The default amount of time in milliseconds that the sleepy end device will use as a slow-polling interval.
+ * This interval is used by the device to periodically wake up and poll the data in the idle mode.
+ */
+#ifndef CHIP_DEVICE_CONFIG_SED_SLOW_POLLING_INTERVAL
+#define CHIP_DEVICE_CONFIG_SED_SLOW_POLLING_INTERVAL 5000
+#endif
+
+/**
+ * CHIP_DEVICE_CONFIG_SED_FAST_POLLING_INTERVAL
+ *
+ * The default amount of time in milliseconds that the sleepy end device will use as a fast-polling interval.
+ * This interval is used by the device to periodically wake up and poll the data in the active mode.
+ */
+#ifndef CHIP_DEVICE_CONFIG_SED_FAST_POLLING_INTERVAL
+#define CHIP_DEVICE_CONFIG_SED_FAST_POLLING_INTERVAL 200
+#endif
+
 // -------------------- Device Identification Configuration --------------------
 
 /**

diff --git a/src/include/platform/CHIPDeviceEvent.h b/src/include/platform/CHIPDeviceEvent.h
@@ -158,6 +158,13 @@ enum PublicEventTypes
      */
     kTimeSyncChange,
 
+    /**
+     * SED Polling Interval Change
+     *
+     * Signals a change to the sleepy end device polling interval.
+     */
+    kSEDPollingIntervalChange,
+
     /**
      * Security Session Established
      *