Refactor SiWxPlatformInterface to enhance button event handling and power management. Removed unused UART power requirement handler and added keep awake functionality on button press using a sleeptimer. (#71458)

Author: rosahay-silabs

examples/platform/silabs/MatterConfig.cpp

@@ -42,12 +42,8 @@
 
 #if CHIP_CONFIG_ENABLE_ICD_SERVER
 #include <platform/silabs/wifi/icd/WifiSleepManager.h> // nogncheck
-#endif                                                 // CHIP_CONFIG_ENABLE_ICD_SERVER
 
-// TODO: We shouldn't need any platform specific includes in this file
-#if (defined(SLI_SI91X_MCU_INTERFACE) && SLI_SI91X_MCU_INTERFACE == 1)
-#include <platform/silabs/SiWx/SiWxPlatformInterface.h>
-#endif // (defined(SLI_SI91X_MCU_INTERFACE) && SLI_SI91X_MCU_INTERFACE == 1)
+#endif // CHIP_CONFIG_ENABLE_ICD_SERVER
 #endif // SL_WIFI
 
 #if defined(PW_RPC_ENABLED) && PW_RPC_ENABLED
@@ -423,10 +419,9 @@ extern "C" void vApplicationIdleHook(void)
 {
 #if ((defined(SLI_SI91X_MCU_INTERFACE) && SLI_SI91X_MCU_INTERFACE) && CHIP_CONFIG_ENABLE_ICD_SERVER)
 #ifdef SL_CATALOG_SIMPLE_BUTTON_PRESENT
-    SiWxPlatformInterface::sl_si91x_btn_event_handler();
+    GetPlatform().SleepButtonActionHandler();
 #endif // SL_CATALOG_SIMPLE_BUTTON_PRESENT
-    SiWxPlatformInterface::sl_si91x_uart_power_requirement_handler();
-#endif
+#endif // ((defined(SLI_SI91X_MCU_INTERFACE) && SLI_SI91X_MCU_INTERFACE) && CHIP_CONFIG_ENABLE_ICD_SERVER)
 #if SL_MATTER_DEBUG_WATCHDOG_ENABLE
     GetPlatform().WatchdogFeed();
 #endif // SL_MATTER_DEBUG_WATCHDOG_ENABLE

src/platform/silabs/SiWx/BUILD.gn

@@ -72,7 +72,6 @@ static_library("SiWx") {
     "${silabs_platform_dir}/platformAbstraction/WiseMcuSpam.cpp",
     "../../FreeRTOS/SystemTimeSupport.cpp",
     "../../SingletonConfigurationManager.cpp",
-    "SiWxPlatformInterface.h",
     "ble/BLEManagerImpl.cpp",
     "ble/sl_si91x_ble_init.cpp",
     "ble/sl_si91x_ble_init.h",

src/platform/silabs/SiWx/SiWxPlatformInterface.h

@@ -303,7 +303,9 @@ uint8_t SilabsPlatform::GetButtonState(uint8_t button)
     const sl_button_t * handle = SL_SIMPLE_BUTTON_INSTANCE(button);
     return nullptr == handle ? 0 : sl_button_get_state(handle);
 }
-
+#ifdef SL_ICD_ENABLED
+void SilabsPlatform::SleepButtonActionHandler() {}
+#endif // SL_ICD_ENABLED
 #else
 uint8_t SilabsPlatform::GetButtonState(uint8_t button)
 {

src/platform/silabs/platformAbstraction/GsdkSpam.cpp

@@ -52,6 +52,9 @@ class SilabsPlatform : virtual public SilabsPlatformAbstractionBase
     inline void SetButtonsCb(SilabsButtonCb callback) override { mButtonCallback = callback; }
     static SilabsButtonCb mButtonCallback;
     uint8_t GetButtonState(uint8_t button) override;
+#ifdef SL_ICD_ENABLED
+    void SleepButtonActionHandler(void) override;
+#endif // SL_ICD_ENABLED
 
 #if defined(SL_CATALOG_CUSTOM_MAIN_PRESENT)
     void StartScheduler(void) override;

src/platform/silabs/platformAbstraction/SilabsPlatform.h

@@ -47,6 +47,7 @@ class SilabsPlatformAbstractionBase
     typedef void (*SilabsButtonCb)(uint8_t, uint8_t);
     virtual void SetButtonsCb(SilabsButtonCb callback) {}
     virtual uint8_t GetButtonState(uint8_t button) { return 0; }
+    virtual void SleepButtonActionHandler(void){};
 
     // LEDS
     virtual void InitLed(void) {}

src/platform/silabs/platformAbstraction/SilabsPlatformBase.h

@@ -18,11 +18,8 @@
 #include <platform/silabs/platformAbstraction/SilabsPlatform.h>
 #include <sl_si91x_common_flash_intf.h>
 
-#include "sl_si91x_driver_gpio.h"
-#include "sl_si91x_gpio.h"
-
-#include <FreeRTOS.h>
-#include <task.h>
+#include <cmsis_os2.h>
+#include <sl_cmsis_os2_common.h>
 
 #include <app/icd/server/ICDServerConfig.h>
 
@@ -72,6 +69,11 @@ const sl_rgb_led_t * ledPinArray[SL_LED_COUNT] = { &led_led0 };
 uint8_t ledPinArray[SL_LED_COUNT] = { SL_LED_LED0_PIN, SL_LED_LED1_PIN };
 #endif // (defined(SL_MATTER_RGB_LED_ENABLED) && SL_MATTER_RGB_LED_ENABLED)
 #endif // ENABLE_WSTK_LEDS
+
+#if SL_ICD_ENABLED
+#include "sl_si91x_driver_gpio.h"
+#include "sl_si91x_power_manager.h"
+#endif // SL_ICD_ENABLED
 }
 
 #ifdef SL_CATALOG_SYSTEMVIEW_TRACE_PRESENT
@@ -91,9 +93,16 @@ namespace {
 uint8_t sButtonStates[SL_SI91x_BUTTON_COUNT] = { 0 };
 #endif // SL_CATALOG_SIMPLE_BUTTON_PRESENT
 
-#if CHIP_CONFIG_ENABLE_ICD_SERVER && defined(SL_CATALOG_SIMPLE_BUTTON_PRESENT)
-bool btn0_pressed = false;
-#endif // CHIP_CONFIG_ENABLE_ICD_SERVER && defined(SL_CATALOG_SIMPLE_BUTTON_PRESENT)
+#if CHIP_CONFIG_ENABLE_ICD_SERVER && (SL_MATTER_GN_BUILD == 0)
+
+// Keep awake duration in milliseconds
+static constexpr uint32_t kSiWxKeepAwakeDurationMs = 10000;
+
+// CMSIS-RTOS2 one-shot timer: each BTN0 press (re)starts the full kSiWxKeepAwakeDurationMs window.
+static osTimerId_t sSiWxKeepAwakeOsTimer = nullptr;
+static bool sSiWxKeepAwakePs4Active      = false;
+
+#endif // CHIP_CONFIG_ENABLE_ICD_SERVER && (SL_MATTER_GN_BUILD == 0)
 
 #if CHIP_CONFIG_ENABLE_ICD_SERVER == 0
 int soc_pll_config(void)
@@ -234,22 +243,10 @@ extern "C" void sl_button_on_change(uint8_t btn, uint8_t btnAction)
         // if the btn was not pressed and only a release event came, ignore it
         // if the btn was already pressed and another press event came, ignore it
         // essentially, if both of them are in the same state then ignore it.
-        VerifyOrReturn(btnAction != btn0_pressed);
-
-        if ((btnAction == BUTTON_PRESSED) && (btn0_pressed == false))
-        {
-            btn0_pressed = true;
-        }
-        else if ((btnAction == BUTTON_RELEASED) && (btn0_pressed == true))
-        {
-            btn0_pressed = false;
-        }
+        VerifyOrReturn(btnAction != GetPlatform().GetButtonState(SL_BUTTON_BTN0_NUMBER));
     }
 #endif // SL_ICD_ENABLED
-    if (Silabs::GetPlatform().mButtonCallback == nullptr)
-    {
-        return;
-    }
+    VerifyOrReturn(GetPlatform().mButtonCallback != nullptr);
 
     if (btn < SL_SI91x_BUTTON_COUNT)
     {
@@ -268,6 +265,76 @@ uint8_t SilabsPlatform::GetButtonState(uint8_t button)
 {
     return (button < SL_SI91x_BUTTON_COUNT) ? sButtonStates[button] : 0;
 }
+
+#if SL_ICD_ENABLED
+/**
+ * @brief      invoked when button press event is received when in sleep
+ * @param[in]  pin_intr GPIO pin interrupt number.
+ * @return     none.
+ * @note       this is a callback from the Wiseconnect SDK
+ */
+extern "C" void gpio_uulp_pin_interrupt_callback(uint32_t pin_intr)
+{
+    // UULP_GPIO_2 is used to detect the button 0 press
+    VerifyOrReturn(pin_intr == RTE_UULP_GPIO_2_PIN, ChipLogError(DeviceLayer, "invalid pin interrupt: %ld", pin_intr));
+    sl_status_t status      = SL_STATUS_OK;
+    uint8_t pin_intr_status = sl_si91x_gpio_get_uulp_npss_pin(pin_intr);
+    if (pin_intr_status == LOW)
+    {
+        // BTN_0 is pressed
+        // NOTE: the GPIO is masked since the interrupt is invoked before scheduler is started, thus this is required to hand over
+        // control to scheduler, the PIN is unmasked in the power manager flow before going to sleep
+        status = sl_si91x_gpio_driver_mask_set_uulp_npss_interrupt(pin_intr);
+        VerifyOrReturn(status == SL_STATUS_OK, ChipLogError(DeviceLayer, "failed to mask interrupt: %ld", status));
+    }
+}
+#if SL_MATTER_GN_BUILD == 0
+static void SiWxKeepAwakeOsTimerCallback(void * arg)
+{
+    (void) arg;
+    VerifyOrReturn(sSiWxKeepAwakePs4Active == true);
+    sl_status_t status = sl_si91x_power_manager_remove_ps_requirement(SL_SI91X_POWER_MANAGER_PS4);
+    VerifyOrReturn(status == SL_STATUS_OK, ChipLogError(DeviceLayer, "remove_ps failed: %lx", status));
+    sSiWxKeepAwakePs4Active = false;
+}
+
+static void SiWxArmKeepAwakeOnBtn0Press()
+{
+    if (!sSiWxKeepAwakePs4Active)
+    {
+        sl_status_t status = sl_si91x_power_manager_add_ps_requirement(SL_SI91X_POWER_MANAGER_PS4);
+        VerifyOrReturn(status == SL_STATUS_OK, ChipLogError(DeviceLayer, "add_ps failed: %lx", status));
+        button_init_instances();
+        sSiWxKeepAwakePs4Active = true;
+    }
+
+    if (sSiWxKeepAwakeOsTimer == nullptr)
+    {
+        sSiWxKeepAwakeOsTimer = osTimerNew(SiWxKeepAwakeOsTimerCallback, osTimerOnce, nullptr, nullptr);
+        VerifyOrReturn(sSiWxKeepAwakeOsTimer != nullptr, ChipLogError(DeviceLayer, "keep awake osTimerNew failed"));
+    }
+
+    if (osTimerStart(sSiWxKeepAwakeOsTimer, pdMS_TO_TICKS(kSiWxKeepAwakeDurationMs)) != osOK)
+    {
+        ChipLogError(DeviceLayer, "keep awake osTimerStart failed");
+    }
+}
+#endif // SL_MATTER_GN_BUILD == 0
+
+void SilabsPlatform::SleepButtonActionHandler()
+{
+    const uint8_t btnAction = (sl_si91x_gpio_get_uulp_npss_pin(SL_BUTTON_BTN0_PIN) == LOW) ? BUTTON_PRESSED : BUTTON_RELEASED;
+    // If the button state is the same as the last state, return
+    VerifyOrReturn(btnAction != GetButtonState(SL_BUTTON_BTN0_NUMBER));
+    if (btnAction == BUTTON_PRESSED)
+    {
+#if SL_MATTER_GN_BUILD == 0
+        SiWxArmKeepAwakeOnBtn0Press();
+#endif // SL_MATTER_GN_BUILD == 0
+    }
+    sl_button_on_change(SL_BUTTON_BTN0_NUMBER, btnAction);
+}
+#endif // SL_ICD_ENABLED
 #else
 uint8_t SilabsPlatform::GetButtonState(uint8_t button)
 {

src/platform/silabs/platformAbstraction/WiseMcuSpam.cpp

@@ -342,24 +342,6 @@ sl_status_t SiWxPlatformInit(void)
     status              = sl_si91x_m4_ta_secure_handshake(SL_SI91X_ENABLE_XTAL, 1, &xtal_enable, 0, nullptr);
     VerifyOrReturnError(status == SL_STATUS_OK, status,
                         ChipLogError(DeviceLayer, "sl_si91x_m4_ta_secure_handshake failed: 0x%lx", static_cast<uint32_t>(status)));
-
-#if CHIP_CONFIG_ENABLE_ICD_SERVER
-#ifdef ENABLE_CHIP_SHELL
-#ifdef RTE_UULP_GPIO_1_PIN
-    // While using the matter shell with a Low Power Build, GPIO 1 is used to check the UULP PIN 1 status
-    // since UART doesn't act as a wakeup source in the UULP mode.
-
-    // Configuring the NPS GPIO 1
-    RSI_NPSSGPIO_SetPinMux(RTE_UULP_GPIO_1_PIN, 0);
-
-    // Configure the NPSS GPIO direction to input
-    RSI_NPSSGPIO_SetDir(RTE_UULP_GPIO_1_PIN, 1);
-
-    // Enable the REN
-    RSI_NPSSGPIO_InputBufferEn(RTE_UULP_GPIO_1_PIN, 1);
-#endif // RTE_UULP_GPIO_1_PIN
-#endif // ENABLE_CHIP_SHELL
-#endif // CHIP_CONFIG_ENABLE_ICD_SERVER
 #endif // SLI_SI91X_MCU_INTERFACE
 
     sl_wifi_firmware_version_t version = { 0 };