Standardize log messages across platform code

brosahay · brosahay · commit 3dd6aa39d442 · 2024-08-11T08:58:54.000+05:30
diff --git a/examples/platform/silabs/SiWx917/SiWx917/sl_wifi_if.cpp b/examples/platform/silabs/SiWx917/SiWx917/sl_wifi_if.cpp
@@ -388,7 +388,7 @@ int32_t wfx_rsi_power_save(rsi_power_save_profile_mode_t sl_si91x_ble_state, sl_
  *****************************************************************************************/
 int32_t wfx_wifi_rsi_init(void)
 {
-    ChipLogDetail(DeviceLayer, "wfx_wifi_rsi_init started");
+    ChipLogDetail(DeviceLayer, "wfx_wifi_rsi_init: started");
     sl_status_t status;
     status = sl_wifi_init(&config, NULL, sl_wifi_default_event_handler);
     VerifyOrReturnError(status == SL_STATUS_OK, status);
diff --git a/examples/platform/silabs/efr32/rs911x/rsi_if.c b/examples/platform/silabs/efr32/rs911x/rsi_if.c
@@ -813,7 +813,7 @@ void wfx_rsi_task(void * arg)
     wfx_lwip_start();
     wfx_started_notify();
 
-    SILABS_LOG("Starting event loop");
+    SILABS_LOG("wfx_rsi_task: starting event loop");
     for (;;)
     {
         osStatus_t status = osMessageQueueGet(sWifiEventQueue, &wfxEvent, NULL, osWaitForever);
@@ -823,7 +823,7 @@ void wfx_rsi_task(void * arg)
         }
         else
         {
-            SILABS_LOG("Failed to get event with status: %x", status);
+            SILABS_LOG("wfx_rsi_task: get event failed: %x", status);
         }
     }
 }
diff --git a/examples/platform/silabs/efr32/rs911x/wfx_rsi_host.cpp b/examples/platform/silabs/efr32/rs911x/wfx_rsi_host.cpp
@@ -165,8 +165,8 @@ void wfx_clear_wifi_provision(void)
 sl_status_t wfx_connect_to_ap(void)
 {
     VerifyOrReturnError(wfx_rsi.dev_state & WFX_RSI_ST_STA_PROVISIONED, SL_STATUS_INVALID_CONFIGURATION);
-    // TODO: check for '\0' in SSID before printing
-    ChipLogProgress(DeviceLayer, "Connect to access point: %s", wfx_rsi.sec.ssid);
+    VerifyOrReturnError(strlen(wfx_rsi.sec.ssid) <= WFX_MAX_SSID_LENGTH, SL_STATUS_WOULD_OVERFLOW);
+    ChipLogProgress(DeviceLayer, "connect to access point: %s", wfx_rsi.sec.ssid);
     WfxEvent_t event;
     event.eventType = WFX_EVT_STA_START_JOIN;
     WfxPostEvent(&event);
diff --git a/src/platform/silabs/ConnectivityManagerImpl_WIFI.cpp b/src/platform/silabs/ConnectivityManagerImpl_WIFI.cpp
@@ -327,7 +327,7 @@ void ConnectivityManagerImpl::DriveStationState()
                     ChipLogProgress(DeviceLayer, "Attempting to connect WiFi");
                     if ((serr = wfx_connect_to_ap()) != SL_STATUS_OK)
                     {
-                        ChipLogError(DeviceLayer, "wfx_connect_to_ap() failed.");
+                        ChipLogError(DeviceLayer, "wfx_connect_to_ap() failed: %" PRId32, serr);
                     }
                     SuccessOrExit(serr);
 
diff --git a/src/platform/silabs/SiWx917/wifi/wfx_notify.cpp b/src/platform/silabs/SiWx917/wifi/wfx_notify.cpp
@@ -92,12 +92,10 @@ void wfx_connected_notify(int32_t status, sl_wfx_mac_address_t * ap)
 
     if (status != SUCCESS_STATUS)
     {
-        ChipLogProgress(DeviceLayer, "%s: error: failed status: %ld.", __func__, status);
+        ChipLogProgress(DeviceLayer, "wfx_connected_notify: error: failed status: %ld", status);
         return;
     }
 
-    ChipLogProgress(DeviceLayer, "%s: connected.", __func__);
-
     memset(&evt, 0, sizeof(evt));
     evt.header.id     = SL_WFX_CONNECT_IND_ID;
     evt.header.length = sizeof evt;
diff --git a/src/platform/silabs/efr32/wifi/ethernetif.cpp b/src/platform/silabs/efr32/wifi/ethernetif.cpp
@@ -148,8 +148,8 @@ static void low_level_input(struct netif * netif, uint8_t * b, uint16_t len)
         (memcmp(netif->hwaddr, dst_mac, netif->hwaddr_len) != 0))
     {
 #ifdef WIFI_DEBUG_ENABLED
-        ChipLogProgress(DeviceLayer, "%s: DROP, [%02x:%02x:%02x:%02x:%02x:%02x]<-[%02x:%02x:%02x:%02x:%02x:%02x] type=%02x%02x",
-                        __func__,
+        ChipLogProgress(DeviceLayer,
+                        "lwip_input: DROP, [%02x:%02x:%02x:%02x:%02x:%02x]<-[%02x:%02x:%02x:%02x:%02x:%02x] type=%02x%02x",
 
                         dst_mac[0], dst_mac[1], dst_mac[2], dst_mac[3], dst_mac[4], dst_mac[5],
 
@@ -172,7 +172,7 @@ static void low_level_input(struct netif * netif, uint8_t * b, uint16_t len)
         }
 #ifdef WIFI_DEBUG_ENABLED
         ChipLogProgress(DeviceLayer,
-                        "%s: ACCEPT %ld, [%02x:%02x:%02x:%02x:%02x:%02x]<-[%02x:%02x:%02x:%02x:%02x:%02x] type=%02x%02x", __func__,
+                        "lwip_input: ACCEPT %ld, [%02x:%02x:%02x:%02x:%02x:%02x]<-[%02x:%02x:%02x:%02x:%02x:%02x] type=%02x%02x",
                         bufferoffset,
 
                         dst_mac[0], dst_mac[1], dst_mac[2], dst_mac[3], dst_mac[4], dst_mac[5],
diff --git a/src/platform/silabs/efr32/wifi/wfx_notify.cpp b/src/platform/silabs/efr32/wifi/wfx_notify.cpp
@@ -88,11 +88,11 @@ void wfx_connected_notify(int32_t status, sl_wfx_mac_address_t * ap)
 
     if (status != SUCCESS_STATUS)
     {
-        ChipLogProgress(DeviceLayer, "%s: error: failed status: %ld.", __func__, status);
+        ChipLogProgress(DeviceLayer, "wfx_connected_notify: error: failed status: %ld", status);
         return;
     }
 
-    ChipLogProgress(DeviceLayer, "%s: connected.", __func__);
+    ChipLogProgress(DeviceLayer, "wfx_connected_notify: connected");
 
     memset(&evt, 0, sizeof(evt));
     evt.header.id     = SL_WFX_CONNECT_IND_ID;
@@ -194,12 +194,12 @@ void wfx_retry_interval_handler(bool is_wifi_disconnection_event, uint16_t retry
          */
         if (retryJoin < MAX_JOIN_RETRIES_COUNT)
         {
-            ChipLogProgress(DeviceLayer, "%s: Next attempt after %d Seconds", __func__, CONVERT_MS_TO_SEC(WLAN_RETRY_TIMER_MS));
+            ChipLogProgress(DeviceLayer, "next retry attempt after %d seconds", CONVERT_MS_TO_SEC(WLAN_RETRY_TIMER_MS));
             vTaskDelay(pdMS_TO_TICKS(WLAN_RETRY_TIMER_MS));
         }
         else
         {
-            ChipLogProgress(DeviceLayer, "Connect failed after max %d tries", retryJoin);
+            ChipLogProgress(DeviceLayer, "connect failed after max %d tries", retryJoin);
         }
     }
     else
@@ -213,7 +213,7 @@ void wfx_retry_interval_handler(bool is_wifi_disconnection_event, uint16_t retry
         {
             retryInterval = WLAN_MAX_RETRY_TIMER_MS;
         }
-        ChipLogProgress(DeviceLayer, "%s: Next attempt after %ld Seconds", __func__, CONVERT_MS_TO_SEC(retryInterval));
+        ChipLogProgress(DeviceLayer, "next retry attempt after %ld seconds", CONVERT_MS_TO_SEC(retryInterval));
         vTaskDelay(pdMS_TO_TICKS(retryInterval));
         retryInterval += retryInterval;
     }
diff --git a/src/platform/silabs/rs911x/BLEManagerImpl.cpp b/src/platform/silabs/rs911x/BLEManagerImpl.cpp
@@ -258,7 +258,7 @@ CHIP_ERROR BLEManagerImpl::_Init()
 
     if (wfx_rsi.ble_task == NULL)
     {
-        ChipLogError(DeviceLayer, "%s: error: failed to create ble task.", __func__);
+        ChipLogError(DeviceLayer, "error: failed to create BLE task");
     }
 
     // Initialize the CHIP BleLayer.

Original file line number	Diff line number	Diff line change
`@@ -388,7 +388,7 @@ int32_t wfx_rsi_power_save(rsi_power_save_profile_mode_t sl_si91x_ble_state, sl_`
`388`	`388`	`*****************************************************************************************/`
`389`	`389`	`int32_t wfx_wifi_rsi_init(void)`
`390`	`390`	`{`
`391`		`- ChipLogDetail(DeviceLayer, "wfx_wifi_rsi_init started");`
	`391`	`+ ChipLogDetail(DeviceLayer, "wfx_wifi_rsi_init: started");`
`392`	`392`	`sl_status_t status;`
`393`	`393`	`status = sl_wifi_init(&config, NULL, sl_wifi_default_event_handler);`
`394`	`394`	`VerifyOrReturnError(status == SL_STATUS_OK, status);`
Original file line number	Diff line number	Diff line change
`@@ -813,7 +813,7 @@ void wfx_rsi_task(void * arg)`
`813`	`813`	`wfx_lwip_start();`
`814`	`814`	`wfx_started_notify();`
`815`	`815`
`816`		`- SILABS_LOG("Starting event loop");`
	`816`	`+ SILABS_LOG("wfx_rsi_task: starting event loop");`
`817`	`817`	`for (;;)`
`818`	`818`	`{`
`819`	`819`	`osStatus_t status = osMessageQueueGet(sWifiEventQueue, &wfxEvent, NULL, osWaitForever);`
`@@ -823,7 +823,7 @@ void wfx_rsi_task(void * arg)`
`823`	`823`	`}`
`824`	`824`	`else`
`825`	`825`	`{`
`826`		`- SILABS_LOG("Failed to get event with status: %x", status);`
	`826`	`+ SILABS_LOG("wfx_rsi_task: get event failed: %x", status);`
`827`	`827`	`}`
`828`	`828`	`}`
`829`	`829`	`}`
Original file line number	Diff line number	Diff line change
`@@ -327,7 +327,7 @@ void ConnectivityManagerImpl::DriveStationState()`
`327`	`327`	`ChipLogProgress(DeviceLayer, "Attempting to connect WiFi");`
`328`	`328`	`if ((serr = wfx_connect_to_ap()) != SL_STATUS_OK)`
`329`	`329`	`{`
`330`		`- ChipLogError(DeviceLayer, "wfx_connect_to_ap() failed.");`
	`330`	`+ ChipLogError(DeviceLayer, "wfx_connect_to_ap() failed: %" PRId32, serr);`
`331`	`331`	`}`
`332`	`332`	`SuccessOrExit(serr);`
`333`	`333`
Original file line number	Diff line number	Diff line change
`@@ -92,12 +92,10 @@ void wfx_connected_notify(int32_t status, sl_wfx_mac_address_t * ap)`
`92`	`92`
`93`	`93`	`if (status != SUCCESS_STATUS)`
`94`	`94`	`{`
`95`		`- ChipLogProgress(DeviceLayer, "%s: error: failed status: %ld.", __func__, status);`
	`95`	`+ ChipLogProgress(DeviceLayer, "wfx_connected_notify: error: failed status: %ld", status);`
`96`	`96`	`return;`
`97`	`97`	`}`
`98`	`98`
`99`		`- ChipLogProgress(DeviceLayer, "%s: connected.", __func__);`
`100`		`-`
`101`	`99`	`memset(&evt, 0, sizeof(evt));`
`102`	`100`	`evt.header.id = SL_WFX_CONNECT_IND_ID;`
`103`	`101`	`evt.header.length = sizeof evt;`
Original file line number	Diff line number	Diff line change
`@@ -88,11 +88,11 @@ void wfx_connected_notify(int32_t status, sl_wfx_mac_address_t * ap)`
`88`	`88`
`89`	`89`	`if (status != SUCCESS_STATUS)`
`90`	`90`	`{`
`91`		`- ChipLogProgress(DeviceLayer, "%s: error: failed status: %ld.", __func__, status);`
	`91`	`+ ChipLogProgress(DeviceLayer, "wfx_connected_notify: error: failed status: %ld", status);`
`92`	`92`	`return;`
`93`	`93`	`}`
`94`	`94`
`95`		`- ChipLogProgress(DeviceLayer, "%s: connected.", __func__);`
	`95`	`+ ChipLogProgress(DeviceLayer, "wfx_connected_notify: connected");`
`96`	`96`
`97`	`97`	`memset(&evt, 0, sizeof(evt));`
`98`	`98`	`evt.header.id = SL_WFX_CONNECT_IND_ID;`
`@@ -194,12 +194,12 @@ void wfx_retry_interval_handler(bool is_wifi_disconnection_event, uint16_t retry`
`194`	`194`	`*/`
`195`	`195`	`if (retryJoin < MAX_JOIN_RETRIES_COUNT)`
`196`	`196`	`{`
`197`		`- ChipLogProgress(DeviceLayer, "%s: Next attempt after %d Seconds", __func__, CONVERT_MS_TO_SEC(WLAN_RETRY_TIMER_MS));`
	`197`	`+ ChipLogProgress(DeviceLayer, "next retry attempt after %d seconds", CONVERT_MS_TO_SEC(WLAN_RETRY_TIMER_MS));`
`198`	`198`	`vTaskDelay(pdMS_TO_TICKS(WLAN_RETRY_TIMER_MS));`
`199`	`199`	`}`
`200`	`200`	`else`
`201`	`201`	`{`
`202`		`- ChipLogProgress(DeviceLayer, "Connect failed after max %d tries", retryJoin);`
	`202`	`+ ChipLogProgress(DeviceLayer, "connect failed after max %d tries", retryJoin);`
`203`	`203`	`}`
`204`	`204`	`}`
`205`	`205`	`else`
`@@ -213,7 +213,7 @@ void wfx_retry_interval_handler(bool is_wifi_disconnection_event, uint16_t retry`
`213`	`213`	`{`
`214`	`214`	`retryInterval = WLAN_MAX_RETRY_TIMER_MS;`
`215`	`215`	`}`
`216`		`- ChipLogProgress(DeviceLayer, "%s: Next attempt after %ld Seconds", __func__, CONVERT_MS_TO_SEC(retryInterval));`
	`216`	`+ ChipLogProgress(DeviceLayer, "next retry attempt after %ld seconds", CONVERT_MS_TO_SEC(retryInterval));`
`217`	`217`	`vTaskDelay(pdMS_TO_TICKS(retryInterval));`
`218`	`218`	`retryInterval += retryInterval;`
`219`	`219`	`}`
Original file line number	Diff line number	Diff line change
`@@ -258,7 +258,7 @@ CHIP_ERROR BLEManagerImpl::_Init()`
`258`	`258`
`259`	`259`	`if (wfx_rsi.ble_task == NULL)`
`260`	`260`	`{`
`261`		`- ChipLogError(DeviceLayer, "%s: error: failed to create ble task.", __func__);`
	`261`	`+ ChipLogError(DeviceLayer, "error: failed to create BLE task");`
`262`	`262`	`}`
`263`	`263`
`264`	`264`	`// Initialize the CHIP BleLayer.`