Make CHIP_ERROR a class type on k32w, mbed, telink (#8745)

#### Problem Having CHIP_ERROR be a class type would provide (a) type safety, and (b) the ability to trace the source of errors (issue #8340). #### Change overview - Enable `CHIP_CONFIG_ERROR_CLASS` on k32w, mbed, and telink. #### Testing Existing tests should confirm no change to functionality.
project-chip · Aug 3, 2021 · 9ca9d47 · 9ca9d47
1 parent 7ddc953
commit 9ca9d47
Show file tree

Hide file tree

Showing 18 changed files with 93 additions and 75 deletions.
diff --git a/examples/lighting-app/k32w/main/AppTask.cpp b/examples/lighting-app/k32w/main/AppTask.cpp
@@ -65,9 +65,9 @@ using namespace ::chip::DeviceLayer;
 
 AppTask AppTask::sAppTask;
 
-int AppTask::StartAppTask()
+CHIP_ERROR AppTask::StartAppTask()
 {
-    int err = CHIP_NO_ERROR;
+    CHIP_ERROR err = CHIP_NO_ERROR;
 
     sAppEventQueue = xQueueCreate(APP_EVENT_QUEUE_SIZE, sizeof(AppEvent));
     if (sAppEventQueue == NULL)
@@ -80,7 +80,7 @@ int AppTask::StartAppTask()
     return err;
 }
 
-int AppTask::Init()
+CHIP_ERROR AppTask::Init()
 {
     CHIP_ERROR err = CHIP_NO_ERROR;
 
@@ -118,11 +118,11 @@ int AppTask::Init()
         assert(err == CHIP_NO_ERROR);
     }
 
-    err = LightingMgr().Init();
-    if (err != CHIP_NO_ERROR)
+    int status = LightingMgr().Init();
+    if (status != 0)
     {
         K32W_LOG("LightingMgr().Init() failed");
-        assert(err == CHIP_NO_ERROR);
+        assert(status == 0);
     }
 
     LightingMgr().SetCallbacks(ActionInitiated, ActionCompleted);
@@ -147,10 +147,9 @@ int AppTask::Init()
 
 void AppTask::AppTaskMain(void * pvParameter)
 {
-    int err;
     AppEvent event;
 
-    err = sAppTask.Init();
+    CHIP_ERROR err = sAppTask.Init();
     if (err != CHIP_NO_ERROR)
     {
         K32W_LOG("AppTask.Init() failed");
@@ -381,7 +380,7 @@ void AppTask::ResetActionEventHandler(AppEvent * aEvent)
 void AppTask::LightActionEventHandler(AppEvent * aEvent)
 {
     LightingManager::Action_t action;
-    int err        = CHIP_NO_ERROR;
+    CHIP_ERROR err = CHIP_NO_ERROR;
     int32_t actor  = 0;
     bool initiated = false;
 
@@ -409,7 +408,8 @@ void AppTask::LightActionEventHandler(AppEvent * aEvent)
     }
     else
     {
-        err = APP_ERROR_UNHANDLED_EVENT;
+        err    = APP_ERROR_UNHANDLED_EVENT;
+        action = LightingManager::INVALID_ACTION;
     }
 
     if (err == CHIP_NO_ERROR)

diff --git a/examples/lighting-app/k32w/main/LightingManager.cpp b/examples/lighting-app/k32w/main/LightingManager.cpp
@@ -30,8 +30,6 @@ TimerHandle_t sLightTimer; // FreeRTOS app sw timer.
 
 int LightingManager::Init()
 {
-    int err = CHIP_NO_ERROR;
-
     // Create FreeRTOS sw timer for light timer.
 
     sLightTimer = xTimerCreate("LightTmr",       // Just a text name, not used by the RTOS kernel
@@ -52,7 +50,7 @@ int LightingManager::Init()
     mAutoTurnOn           = false;
     mAutoTurnOnDuration   = 0;
 
-    return err;
+    return 0;
 }
 
 void LightingManager::SetCallbacks(Callback_fn_initiated aActionInitiated_CB, Callback_fn_completed aActionCompleted_CB)

diff --git a/examples/lighting-app/k32w/main/include/AppTask.h b/examples/lighting-app/k32w/main/include/AppTask.h
@@ -40,7 +40,7 @@
 class AppTask
 {
 public:
-    int StartAppTask();
+    CHIP_ERROR StartAppTask();
     static void AppTaskMain(void * pvParameter);
 
     void PostTurnOnActionRequest(int32_t aActor, LightingManager::Action_t aAction);
@@ -51,7 +51,7 @@ class AppTask
 private:
     friend AppTask & GetAppTask(void);
 
-    int Init();
+    CHIP_ERROR Init();
 
     static void ActionInitiated(LightingManager::Action_t aAction, int32_t aActor);
     static void ActionCompleted(LightingManager::Action_t aAction);

diff --git a/examples/lighting-app/mbed/main/main.cpp b/examples/lighting-app/mbed/main/main.cpp
@@ -34,7 +34,8 @@ using namespace ::chip::DeviceLayer;
 
 int main()
 {
-    int ret = 0;
+    int ret        = 0;
+    CHIP_ERROR err = CHIP_NO_ERROR;
 
 #ifdef MBED_CONF_MBED_TRACE_ENABLE
     mbed_trace_init();
@@ -52,25 +53,29 @@ int main()
         goto exit;
     }
 
-    ret = chip::Platform::MemoryInit();
-    if (ret != CHIP_NO_ERROR)
+    err = chip::Platform::MemoryInit();
+    if (err != CHIP_NO_ERROR)
     {
         ChipLogError(NotSpecified, "Platform::MemoryInit() failed");
+        ret = EXIT_FAILURE;
         goto exit;
     }
 
     ChipLogProgress(NotSpecified, "Init CHIP Stack\r\n");
-    ret = PlatformMgr().InitChipStack();
-    if (ret != CHIP_NO_ERROR)
+    err = PlatformMgr().InitChipStack();
+    if (err != CHIP_NO_ERROR)
     {
         ChipLogError(NotSpecified, "PlatformMgr().InitChipStack() failed");
+        ret = EXIT_FAILURE;
+        goto exit;
     }
 
     ChipLogProgress(NotSpecified, "Starting CHIP task");
-    ret = PlatformMgr().StartEventLoopTask();
-    if (ret != CHIP_NO_ERROR)
+    err = PlatformMgr().StartEventLoopTask();
+    if (err != CHIP_NO_ERROR)
     {
         ChipLogError(NotSpecified, "PlatformMgr().StartEventLoopTask() failed");
+        ret = EXIT_FAILURE;
         goto exit;
     }
 

diff --git a/examples/lighting-app/telink/include/AppTask.h b/examples/lighting-app/telink/include/AppTask.h
@@ -30,7 +30,7 @@ struct k_timer;
 class AppTask
 {
 public:
-    int StartApp();
+    CHIP_ERROR StartApp();
 
     void PostLightingActionRequest(LightingManager::Action_t aAction);
     void PostEvent(AppEvent * event);
@@ -39,7 +39,7 @@ class AppTask
 private:
     friend AppTask & GetAppTask(void);
 
-    int Init();
+    CHIP_ERROR Init();
 
     static void ActionInitiated(LightingManager::Action_t aAction, int32_t aActor);
     static void ActionCompleted(LightingManager::Action_t aAction, int32_t aActor);

diff --git a/examples/lighting-app/telink/include/LightingManager.h b/examples/lighting-app/telink/include/LightingManager.h
@@ -20,6 +20,8 @@
 
 #include "AppEvent.h"
 
+#include <system/SystemError.h>
+
 #include <cstdint>
 #include <drivers/gpio.h>
 
@@ -43,7 +45,7 @@ class LightingManager
 
     using LightingCallback_fn = void (*)(Action_t, int32_t);
 
-    int Init(const char * pwmDeviceName, uint32_t pwmChannel);
+    CHIP_ERROR Init(const char * pwmDeviceName, uint32_t pwmChannel);
     bool IsTurnedOn() const { return mState == kState_On; }
     uint8_t GetLevel() const { return mLevel; }
     bool InitiateAction(Action_t aAction, int32_t aActor, uint8_t size, uint8_t * value);

diff --git a/examples/lighting-app/telink/src/AppTask.cpp b/examples/lighting-app/telink/src/AppTask.cpp
@@ -73,9 +73,9 @@ using namespace ::chip::DeviceLayer;
 
 AppTask AppTask::sAppTask;
 
-int AppTask::Init()
+CHIP_ERROR AppTask::Init()
 {
-    int ret;
+    CHIP_ERROR ret;
 
     // Initialize LEDs
     LEDWidget::InitGpio();
@@ -86,7 +86,7 @@ int AppTask::Init()
 
     // Init lighting manager
     ret = LightingMgr().Init(LIGHTING_PWM_DEVICE, LIGHTING_PWM_CHANNEL);
-    if (ret != 0)
+    if (ret != CHIP_NO_ERROR)
     {
         LOG_ERR("Failed to int lighting manager");
         return ret;
@@ -107,24 +107,24 @@ int AppTask::Init()
         return ret;
     }
 
-    return 0;
+    return CHIP_NO_ERROR;
 }
 
-int AppTask::StartApp()
+CHIP_ERROR AppTask::StartApp()
 {
-    int ret = Init();
+    CHIP_ERROR err = Init();
 
-    if (ret)
+    if (err != CHIP_NO_ERROR)
     {
         LOG_ERR("AppTask.Init() failed");
-        return ret;
+        return err;
     }
 
     AppEvent event = {};
 
     while (true)
     {
-        ret = k_msgq_get(&sAppEventQueue, &event, K_MSEC(10));
+        int ret = k_msgq_get(&sAppEventQueue, &event, K_MSEC(10));
 
         while (!ret)
         {

diff --git a/examples/lighting-app/telink/src/LightingManager.cpp b/examples/lighting-app/telink/src/LightingManager.cpp
@@ -28,7 +28,7 @@ LOG_MODULE_DECLARE(app);
 
 LightingManager LightingManager::sLight;
 
-int LightingManager::Init(const char * pwmDeviceName, uint32_t pwmChannel)
+CHIP_ERROR LightingManager::Init(const char * pwmDeviceName, uint32_t pwmChannel)
 {
     // We use a gpioPin instead of a LEDWidget here because we want to use PWM
     // and other features instead of just on/off.
@@ -41,11 +41,11 @@ int LightingManager::Init(const char * pwmDeviceName, uint32_t pwmChannel)
     if (!mPwmDevice)
     {
         LOG_ERR("Cannot find PWM device %s", log_strdup(pwmDeviceName));
-        return -ENODEV;
+        return ::chip::System::MapErrorZephyr(-ENODEV);
     }
 
     Set(false);
-    return 0;
+    return CHIP_NO_ERROR;
 }
 
 void LightingManager::SetCallbacks(LightingCallback_fn aActionInitiated_CB, LightingCallback_fn aActionCompleted_CB)

diff --git a/examples/lighting-app/telink/src/main.cpp b/examples/lighting-app/telink/src/main.cpp
@@ -31,49 +31,49 @@ using namespace ::chip::DeviceLayer;
 
 int main(void)
 {
-    int ret = 0;
+    CHIP_ERROR err = CHIP_NO_ERROR;
 
-    ret = chip::Platform::MemoryInit();
-    if (ret != CHIP_NO_ERROR)
+    err = chip::Platform::MemoryInit();
+    if (err != CHIP_NO_ERROR)
     {
         LOG_ERR("Platform::MemoryInit() failed");
         goto exit;
     }
 
     LOG_INF("Init CHIP stack");
-    ret = PlatformMgr().InitChipStack();
-    if (ret != CHIP_NO_ERROR)
+    err = PlatformMgr().InitChipStack();
+    if (err != CHIP_NO_ERROR)
     {
         LOG_ERR("PlatformMgr().InitChipStack() failed");
         goto exit;
     }
 
     LOG_INF("Starting CHIP task");
-    ret = PlatformMgr().StartEventLoopTask();
-    if (ret != CHIP_NO_ERROR)
+    err = PlatformMgr().StartEventLoopTask();
+    if (err != CHIP_NO_ERROR)
     {
         LOG_ERR("PlatformMgr().StartEventLoopTask() failed");
         goto exit;
     }
 
     LOG_INF("Init Thread stack");
-    ret = ThreadStackMgr().InitThreadStack();
-    if (ret != CHIP_NO_ERROR)
+    err = ThreadStackMgr().InitThreadStack();
+    if (err != CHIP_NO_ERROR)
     {
         LOG_ERR("ThreadStackMgr().InitThreadStack() failed");
         goto exit;
     }
 
-    ret = ConnectivityMgr().SetThreadDeviceType(ConnectivityManager::kThreadDeviceType_MinimalEndDevice);
-    if (ret != CHIP_NO_ERROR)
+    err = ConnectivityMgr().SetThreadDeviceType(ConnectivityManager::kThreadDeviceType_MinimalEndDevice);
+    if (err != CHIP_NO_ERROR)
     {
         LOG_ERR("ConnectivityMgr().SetThreadDeviceType() failed");
         goto exit;
     }
 
-    ret = GetAppTask().StartApp();
+    err = GetAppTask().StartApp();
 
 exit:
-    LOG_ERR("Exited with code %d", ret);
-    return ret;
+    LOG_ERR("Exited with code %" CHIP_ERROR_FORMAT, ChipError::FormatError(err));
+    return (err == CHIP_NO_ERROR) ? EXIT_SUCCESS : EXIT_FAILURE;
 }
diff --git a/examples/lock-app/k32w/main/AppTask.cpp b/examples/lock-app/k32w/main/AppTask.cpp
@@ -63,9 +63,9 @@ using namespace ::chip::DeviceLayer;
 
 AppTask AppTask::sAppTask;
 
-int AppTask::StartAppTask()
+CHIP_ERROR AppTask::StartAppTask()
 {
-    int err = CHIP_NO_ERROR;
+    CHIP_ERROR err = CHIP_NO_ERROR;
 
     sAppEventQueue = xQueueCreate(kAppEventQueueSize, sizeof(AppEvent));
     if (sAppEventQueue == NULL)
@@ -77,7 +77,7 @@ int AppTask::StartAppTask()
     return err;
 }
 
-int AppTask::Init()
+CHIP_ERROR AppTask::Init()
 {
     CHIP_ERROR err = CHIP_NO_ERROR;
 
@@ -114,11 +114,11 @@ int AppTask::Init()
         assert(err == CHIP_NO_ERROR);
     }
 
-    err = BoltLockMgr().Init();
-    if (err != CHIP_NO_ERROR)
+    int status = BoltLockMgr().Init();
+    if (status != 0)
     {
         K32W_LOG("BoltLockMgr().Init() failed");
-        assert(err == CHIP_NO_ERROR);
+        assert(status == 0);
     }
 
     BoltLockMgr().SetCallbacks(ActionInitiated, ActionCompleted);
@@ -150,10 +150,9 @@ int AppTask::Init()
 
 void AppTask::AppTaskMain(void * pvParameter)
 {
-    int err;
     AppEvent event;
 
-    err = sAppTask.Init();
+    CHIP_ERROR err = sAppTask.Init();
     if (err != CHIP_NO_ERROR)
     {
         K32W_LOG("AppTask.Init() failed");
@@ -385,7 +384,7 @@ void AppTask::ResetActionEventHandler(AppEvent * aEvent)
 void AppTask::LockActionEventHandler(AppEvent * aEvent)
 {
     BoltLockManager::Action_t action;
-    int err        = CHIP_NO_ERROR;
+    CHIP_ERROR err = CHIP_NO_ERROR;
     int32_t actor  = 0;
     bool initiated = false;
 
@@ -413,7 +412,8 @@ void AppTask::LockActionEventHandler(AppEvent * aEvent)
     }
     else
     {
-        err = CHIP_ERROR_INTERNAL;
+        err    = CHIP_ERROR_INTERNAL;
+        action = BoltLockManager::INVALID_ACTION;
     }
 
     if (err == CHIP_NO_ERROR)

diff --git a/examples/lock-app/k32w/main/BoltLockManager.cpp b/examples/lock-app/k32w/main/BoltLockManager.cpp
@@ -30,7 +30,7 @@ TimerHandle_t sLockTimer; // FreeRTOS app sw timer.
 
 int BoltLockManager::Init()
 {
-    int err = CHIP_NO_ERROR;
+    int err = 0;
 
     // Create FreeRTOS sw timer for Lock timer.