Clean up

Author: mkardous-silabs

src/platform/silabs/wifi/SiWx/WifiInterfaceImpl.cpp

@@ -246,7 +246,7 @@ sl_status_t BackgroundScanCallback(sl_wifi_event_t event, sl_wifi_scan_result_t
     return SL_STATUS_OK;
 }
 
-sl_status_t sl_wifi_siwx917_init(void)
+sl_status_t SiWxPlatformInit(void)
 {
     sl_status_t status = SL_STATUS_OK;
 
@@ -451,9 +451,9 @@ void WiseconnectWifiInterface::MatterWifiTask(void * arg)
     WiseconnectWifiInterface::WifiPlatformEvent event;
     sl_status_t status = SL_STATUS_OK;
 
-    status = sl_wifi_siwx917_init();
+    status = SiWxPlatformInit();
     VerifyOrReturn(status == SL_STATUS_OK,
-                   ChipLogError(DeviceLayer, "MatterWifiTask: sl_wifi_siwx917_init failed: 0x%lx", static_cast<uint32_t>(status)));
+                   ChipLogError(DeviceLayer, "MatterWifiTask: SiWxPlatformInit failed: 0x%lx", static_cast<uint32_t>(status)));
 
     WifiInterfaceImpl::GetInstance().NotifyWifiTaskInitialized();
 

src/platform/silabs/wifi/SiWx/WifiInterfaceImpl.h

@@ -48,7 +48,7 @@ class WifiInterfaceImpl final : public WiseconnectWifiInterface
 #endif // CHIP_CONFIG_ENABLE_ICD_SERVER
 
     /**
-     * @brief
+     * @brief Processes the wifi platform events for the SiWx platform
      *
      * TODO: Current inheritance structure with the task creation in the parent forces this function to be public when it shouldn't
      *       be. This isn't the best practice and we should try to move this to protected.
@@ -97,7 +97,7 @@ class WifiInterfaceImpl final : public WiseconnectWifiInterface
     sl_status_t JoinWifiNetwork();
 
     /**
-     * @brief TODO
+     * @brief Processing function responsible of executing the DHCP polling operation until we have an IPv6 or IPv4 address
      *
      */
     void HandleDHCPPolling();

src/platform/silabs/wifi/WifiInterface.cpp

@@ -72,6 +72,7 @@ void WifiInterface::NotifyIPv6Change(bool gotIPv6Addr)
 
     HandleWFXSystemEvent(&eventData);
 }
+
 #if (CHIP_DEVICE_CONFIG_ENABLE_IPV4)
 void WifiInterface::NotifyIPv4Change(bool gotIPv4Addr)
 {
@@ -119,12 +120,12 @@ void WifiInterface::ResetIPNotificationStates()
 
 void WifiInterface::NotifyWifiTaskInitialized(void)
 {
-    sl_wfx_startup_ind_t evt = {};
+    sl_wfx_startup_ind_t evt = { 0 };
 
     // TODO: We should move this to the init function and not the notification function
     // Creating a timer which will be used to retry connection with AP
-    sRetryTimer = osTimerNew(RetryConnectionTimerHandler, osTimerOnce, NULL, NULL);
-    VerifyOrReturn(sRetryTimer != NULL);
+    mRetryTimer = osTimerNew(RetryConnectionTimerHandler, osTimerOnce, NULL, NULL);
+    VerifyOrReturn(mRetryTimer != NULL);
 
     evt.header.id     = to_underlying(WifiEvent::kStartUp);
     evt.header.length = sizeof evt;
@@ -151,7 +152,7 @@ void WifiInterface::ScheduleConnectionAttempt()
         retryInterval = kWlanMaxRetryIntervalsInSec;
     }
 
-    if (osTimerStart(sRetryTimer, pdMS_TO_TICKS(retryInterval * 1000)) != osOK)
+    if (osTimerStart(mRetryTimer, pdMS_TO_TICKS(retryInterval * 1000)) != osOK)
     {
         ChipLogProgress(DeviceLayer, "Failed to start retry timer");
         // Sending the join command if retry timer failed to start

src/platform/silabs/wifi/WifiInterface.h

@@ -464,8 +464,9 @@ class WifiInterface
 #if CHIP_DEVICE_CONFIG_ENABLE_IPV4
     bool mHasNotifiedIPv4 = false;
 #endif // CHIP_DEVICE_CONFIG_ENABLE_IPV4
+
 private:
-    osTimerId_t sRetryTimer;
+    osTimerId_t mRetryTimer;
 };
 
 } // namespace Silabs

src/platform/silabs/wifi/rs911x/WifiInterfaceImpl.h

@@ -70,27 +70,26 @@ class WifiInterfaceImpl final : public WiseconnectWifiInterface
     ~WifiInterfaceImpl() = default;
 
     /**
-     * @brief
+     * @brief Callback function on a succesfull join operation
      *
-     * @param status
-     * @param buf
-     * @param len
+     *        See the third_party/silabs/wiseconnect-wifi-bt-sdk/sapi/wlan/rsi_wlan_apis.c
+     *        rsi_wlan_connect_async documentation for the argument definitions
      */
     static void JoinCallback(uint16_t status, const uint8_t * buf, const uint16_t len);
 
     /**
-     * @brief
+     * @brief Callback function for a failed join operation
      *
-     * @param status
-     * @param buf
-     * @param len
+     *        See the third_party/silabs/wiseconnect-wifi-bt-sdk/sapi/wlan/rsi_wlan_apis.c
+     *        rsi_wlan_register_callbacks documentation for the argument definitions
      */
     static void JoinFailCallback(uint16_t status, uint8_t * buf, uint32_t len);
 
     /**
-     * @brief
+     * @brief Platform Init for the RS911x platform
      *
-     * @return int32_t
+     * @return int32_t RSI_SUCCESS, on succesfull init
+     *                 RSI_FAILURE, otherwise
      */
     int32_t Rs911xPlatformInit();
 
@@ -100,8 +99,8 @@ class WifiInterfaceImpl final : public WiseconnectWifiInterface
     void JoinWifiNetwork();
 
     /**
-     * @brief
-     *
+     * @brief Processing function responsible of executing the DHCP polling operation
+     *        until we have an IPv6 or IPv4 address
      */
     void HandleDHCPPolling();
 

src/platform/silabs/wifi/wf200/WifiInterfaceImpl.h

@@ -30,6 +30,13 @@ class WifiInterfaceImpl final : public WifiInterface
 public:
     static WifiInterfaceImpl & GetInstance() { return mInstance; }
 
+    WifiInterfaceImpl(const WifiInterfaceImpl &)             = delete;
+    WifiInterfaceImpl & operator=(const WifiInterfaceImpl &) = delete;
+
+    /*
+     * WifiInterface Impl
+     */
+
     CHIP_ERROR InitWiFiStack(void) override;
     CHIP_ERROR GetMacAddress(sl_wfx_interface_t interface, chip::MutableByteSpan & addr) override;
     CHIP_ERROR StartNetworkScan(chip::ByteSpan ssid, ScanCallback callback) override;
@@ -59,16 +66,17 @@ class WifiInterfaceImpl final : public WifiInterface
 
     /**
      * @brief Callback function passed to the Wi-Fi stack to notify the application of a connection event.
-     *
-     * @note Function is public to allow the Wi-Fi stack to call it. In practice, it should be private but the callback structure
-     *       needs to be reworked
+     *        Function is public to allow the Wi-Fi stack to call it. In practice, it should be private but the callback structure
+     *        needs to be reworked first.
      *
      * @param connect_indication_body Connection callback data
      */
     void ConnectionEventCallback(sl_wfx_connect_ind_body_t connect_indication_body);
 
     /**
      * @brief Callback function to the Wi-Fi stack to notify the application of a disconnection event.
+     *        Function is public to allow the Wi-Fi stack to call it. In practice, it should be private but the callback
+     *        structure needs to be reworked first.
      *
      * @note See the sl_wfx_disconnect_ind_body_t structure for the reason values.
      *
@@ -78,6 +86,9 @@ class WifiInterfaceImpl final : public WifiInterface
     void DisconnectionEventCallback(uint8_t * mac, uint16_t reason);
 
 private:
+    WifiInterfaceImpl()  = default;
+    ~WifiInterfaceImpl() = default;
+
     /**
      * @brief Initialize the WF200 platform
      *        Function triggers the platform int and the LwIP init.
@@ -96,14 +107,13 @@ class WifiInterfaceImpl final : public WifiInterface
 
     /**
      * @brief Creates a new task to process Wi-Fi events
-     *
      */
     void StartWifiProcessTask(void);
 
     /**
      * @brief Wf200 Wifi Init
      *
-     * TODO: We have multiple init function when we could have only one
+     * TODO: We have multiple init function when we could have only one.
      *
      * @return sl_status_t SL_STATUS_OK if the platform is initialized successfully,
      *                     SL_STATUS_WIFI_INVALID_KEY, If the firmware keyset is invalid