Add selective listening framework

Author: mkardous-silabs

src/platform/silabs/wifi/icd/WifiSleepManager.cpp

@@ -25,6 +25,26 @@ namespace {
 // TODO: Once the platform sleep calls are unified, we can removed this ifdef
 #if SLI_SI917 // 917 SoC & NCP
 
+/**
+ * @brief Configures the Wi-Fi Chip to go to LI based sleep.
+ *        Function sets the listen interval the ICD Transort Slow Poll configuration and enables the broadcast filter.
+ *
+ * @return CHIP_ERROR CHIP_NO_ERROR if the configuration of the Wi-Fi chip was successful; otherwise CHIP_ERROR_INTERNAL
+ */
+CHIP_ERROR ConfigureLIBasedSleep()
+{
+    VerifyOrReturnError(ConfigureBroadcastFilter(true) == SL_STATUS_OK, CHIP_ERROR_INTERNAL,
+                        ChipLogError(DeviceLayer, "Failed to configure broadcasts filter."));
+
+    // Allowing the device to go to sleep must be the last actions to avoid configuration failures.
+    VerifyOrReturnError(ConfigurePowerSave(RSI_SLEEP_MODE_2, ASSOCIATED_POWER_SAVE,
+                                           chip::ICDConfigurationData::GetInstance().GetSlowPollingInterval().count()) ==
+                            SL_STATUS_OK,
+                        CHIP_ERROR_INTERNAL, ChipLogError(DeviceLayer, "Failed to enable LI based sleep."));
+
+    return CHIP_NO_ERROR;
+}
+
 /**
  * @brief Configures the Wi-Fi Chip to go to DTIM based sleep.
  *        Function sets the listen interval to be synced with the DTIM beacon and disables the broadcast filter.
@@ -157,6 +177,11 @@ CHIP_ERROR WifiSleepManager::VerifyAndTransitionToLowPowerMode(PowerEvent event)
         return ConfigureDeepSleep();
     }
 
+    if (mCallback && mCallback->CanGoToLIBasedSleep())
+    {
+        return ConfigureLIBasedSleep();
+    }
+
     return ConfigureDTIMBasedSleep();
 
 #else

src/platform/silabs/wifi/icd/WifiSleepManager.h

@@ -43,6 +43,36 @@ class WifiSleepManager
         kConnectivityChange    = 2,
     };
 
+    /**
+     * @brief Class implements the callbacks that the application can implement
+     *        to alter the WifiSleepManager behaviors.
+     */
+    class ApplicationCallback
+    {
+    public:
+        virtual ~ApplicationCallback() = default;
+
+        /**
+         * @brief Function informs the WifiSleepManager in which Low Power mode the device can go to.
+         *        The two supported sleep modes are DTIM based sleep and LI based sleep.
+         *
+         *        When the function is called, the WifiSleepManager is about to go to sleep and using this function to make decision
+         *        as too wether it can go LI based sleep, lowest power mode, or DTIM based sleep.
+         *
+         *        DTIM based sleep requires the Wi-Fi devices to be synced with the DTIM beacon.
+         *        In this mode, the broadcast filter is disabled and the device will process multicast and
+         *        broadcast messages.
+         *
+         *        LI based sleep allows the Wi-Fi devices to sleep for configurable amounts of time without needing to be synced
+         *        with the DTIM beacon. The sleep time is configurable trough the ICD Manager feature-set.
+         *        In the LI based sleep, the broadcast filter is enabled.
+         *
+         * @return true The Wi-Fi Sleep Manager can go to LI based sleep
+         * @return false The Wi-Fi Sleep Manager cannot go to LI based sleep or an error occured in the processing.
+         */
+        virtual bool CanGoToLIBasedSleep() = 0;
+    };
+
     /**
      * @brief Init function that configure the SleepManager APIs based on the type of ICD.
      *        Function validates that the SleepManager configuration were correctly set as well.
@@ -70,6 +100,14 @@ class WifiSleepManager
         WifiSleepManager::GetInstance().RemoveHighPerformanceRequest();
     }
 
+    /**
+     * @brief Set the Application Callback
+     *
+     * @param callbacks pointer to the application callbacks.
+     *                  The callback can be set to nullptr if the application wants to remove its callback
+     */
+    void SetApplicationCallback(ApplicationCallback * callback) { mCallback = callback; }
+
     /**
      * @brief Public API to request the Wi-Fi chip to transition to High Performance.
      *        Function increases the HighPerformance request counter to prevent the chip from going to sleep
@@ -105,6 +143,7 @@ class WifiSleepManager
      *        1. If there are high performance requests, configure high performance mode.
      *        2. If commissioning is in progress, configure DTIM based sleep.
      *        3. If no commissioning is in progress and the device is unprovisioned, configure deep sleep.
+     *        4. If the application callback allows, configure LI based sleep; otherwise, configure DTIM based sleep.
      *
      * @param event PowerEvent triggering the Verify and transition to low power mode processing
      *
@@ -130,6 +169,8 @@ class WifiSleepManager
 
     bool mIsCommissioningInProgress        = false;
     uint8_t mHighPerformanceRequestCounter = 0;
+
+    ApplicationCallback * mCallback = nullptr;
 };
 
 } // namespace Silabs