Move common trigger logics to GenericEventManagementTestEventTriggerHandler class.

Author: hsusid

examples/platform/infineon/cyw30739/EventManagementTestEventTriggerHandler.cpp

@@ -0,0 +1,47 @@
+/*
+ *
+ *    Copyright (c) 2024 Project CHIP Authors
+ *    All rights reserved.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+#include "EventManagementTestEventTriggerHandler.h"
+
+#include "SoftwareDiagnostics.h"
+
+namespace chip {
+namespace DeviceLayer {
+namespace Infineon {
+namespace CYW30739 {
+
+CHIP_ERROR EventManagementTestEventTriggerHandler::HandleEventTrigger(uint64_t eventTrigger)
+{
+    switch (eventTrigger)
+    {
+    case kFillUpEventLoggingBuffer:
+        return HandleFillUpEventLoggingBufferEventTriger();
+    default:
+        return CHIP_ERROR_INVALID_ARGUMENT;
+    }
+}
+
+void EventManagementTestEventTriggerHandler::TriggerSoftwareFaultEvent(const char * faultRecordString)
+{
+    OnSoftwareFaultEventHandler(faultRecordString);
+}
+
+} // namespace CYW30739
+} // namespace Infineon
+} // namespace DeviceLayer
+} // namespace chip

examples/platform/infineon/cyw30739/TestEventTriggerHandler.h renamed to examples/platform/infineon/cyw30739/EventManagementTestEventTriggerHandler.h

@@ -18,22 +18,22 @@
 
 #pragma once
 
-#include <app/TestEventTriggerDelegate.h>
+#include <app/GenericEventManagementTestEventTriggerHandler.h>
 
 namespace chip {
 namespace DeviceLayer {
 namespace Infineon {
 namespace CYW30739 {
 
-class TestEventTriggerHandler : public chip::TestEventTriggerHandler
+class EventManagementTestEventTriggerHandler : public app::GenericEventManagementTestEventTriggerHandler
 {
 public:
     static constexpr uint64_t kFillUpEventLoggingBuffer = 0xffff'ffff'1388'0000;
 
     CHIP_ERROR HandleEventTrigger(uint64_t eventTrigger) override;
 
 private:
-    CHIP_ERROR HandleFillUpEventLoggingBufferEventTriger();
+    virtual void TriggerSoftwareFaultEvent(const char * faultRecordString) override;
 };
 
 } // namespace CYW30739

examples/platform/infineon/cyw30739/matter_config.cpp

@@ -19,7 +19,7 @@
 
 #include "matter_config.h"
 #include "AppTask.h"
-#include "TestEventTriggerHandler.h"
+#include "EventManagementTestEventTriggerHandler.h"
 #ifdef BOARD_ENABLE_DISPLAY
 #include "GUI.h"
 #endif
@@ -192,10 +192,10 @@ void CYW30739MatterConfig::InitApp(void)
     /* Start CHIP datamodel server */
     static chip::SimpleTestEventTriggerDelegate sTestEventTriggerDelegate{};
     static chip::OTATestEventTriggerHandler sOtaTestEventTriggerHandler{};
-    static Infineon::CYW30739::TestEventTriggerHandler sCYW30739TestEventTriggerHandler{};
+    static Infineon::CYW30739::EventManagementTestEventTriggerHandler sEventManagementTestEventTriggerHandler{};
     VerifyOrDie(sTestEventTriggerDelegate.Init(chip::ByteSpan(sTestEventTriggerEnableKey)) == CHIP_NO_ERROR);
     VerifyOrDie(sTestEventTriggerDelegate.AddHandler(&sOtaTestEventTriggerHandler) == CHIP_NO_ERROR);
-    VerifyOrDie(sTestEventTriggerDelegate.AddHandler(&sCYW30739TestEventTriggerHandler) == CHIP_NO_ERROR);
+    VerifyOrDie(sTestEventTriggerDelegate.AddHandler(&sEventManagementTestEventTriggerHandler) == CHIP_NO_ERROR);
     // Create initParams with SDK example defaults here
     static chip::CommonCaseDeviceServerInitParams initParams;
     (void) initParams.InitializeStaticResourcesBeforeServerInit();

src/app/BUILD.gn

@@ -324,6 +324,8 @@ static_library("app") {
     "EventManagement.h",
     "FailSafeContext.cpp",
     "FailSafeContext.h",
+    "GenericEventManagementTestEventTriggerHandler.cpp",
+    "GenericEventManagementTestEventTriggerHandler.h",
     "OTAUserConsentCommon.h",
     "ReadHandler.cpp",
     "SafeAttributePersistenceProvider.h",

examples/platform/infineon/cyw30739/TestEventTriggerHandler.cpp renamed to src/app/GenericEventManagementTestEventTriggerHandler.cpp

@@ -16,32 +16,18 @@
  *    limitations under the License.
  */
 
-#include "TestEventTriggerHandler.h"
-
-#include "SoftwareDiagnostics.h"
+#include "GenericEventManagementTestEventTriggerHandler.h"
 
 #include <app/clusters/general-diagnostics-server/general-diagnostics-server.h>
-#include <platform/CHIPDeviceLayer.h>
+#include <platform/GeneralFaults.h>
 
 namespace chip {
-namespace DeviceLayer {
-namespace Infineon {
-namespace CYW30739 {
+namespace app {
 
+using namespace chip::DeviceLayer;
 using namespace chip::app::Clusters;
 
-CHIP_ERROR TestEventTriggerHandler::HandleEventTrigger(uint64_t eventTrigger)
-{
-    switch (eventTrigger)
-    {
-    case kFillUpEventLoggingBuffer:
-        return HandleFillUpEventLoggingBufferEventTriger();
-    default:
-        return CHIP_ERROR_INVALID_ARGUMENT;
-    }
-}
-
-CHIP_ERROR TestEventTriggerHandler::HandleFillUpEventLoggingBufferEventTriger()
+CHIP_ERROR GenericEventManagementTestEventTriggerHandler::HandleFillUpEventLoggingBufferEventTriger()
 {
     /* Create a fake hardware fault list. */
     GeneralFaults<kMaxHardwareFaults> hardwareFaults;
@@ -58,23 +44,29 @@ CHIP_ERROR TestEventTriggerHandler::HandleFillUpEventLoggingBufferEventTriger()
         GeneralDiagnosticsServer::Instance().OnHardwareFaultsDetect(hardwareFaults, hardwareFaults);
     }
 
-    /* Create a fake fault message. */
-    constexpr uint64_t kEncodingOverhead        = 0x40;
-    constexpr uint64_t kMaxEventLoggingInfoSize = CHIP_DEVICE_CONFIG_EVENT_LOGGING_INFO_BUFFER_SIZE - kEncodingOverhead;
-    static char recordString[kMaxEventLoggingInfoSize + 1];
-    memset(recordString, 0x55, kMaxEventLoggingInfoSize);
-    recordString[kMaxEventLoggingInfoSize] = '\0';
+    /* Fill up the info logging buffer. */
+    FillUpEventLoggingBufferWithFakeSoftwareFault(CHIP_DEVICE_CONFIG_EVENT_LOGGING_INFO_BUFFER_SIZE);
 
-    /* Fill up the info logging buffer by a software fault. */
-    OnSoftwareFaultEventHandler(recordString);
-
-    /* Fill up the debug logging buffer by a software fault. */
-    OnSoftwareFaultEventHandler(recordString);
+    /* Fill up the debug logging buffer. */
+    FillUpEventLoggingBufferWithFakeSoftwareFault(CHIP_DEVICE_CONFIG_EVENT_LOGGING_DEBUG_BUFFER_SIZE);
 
     return CHIP_NO_ERROR;
 }
 
-} // namespace CYW30739
-} // namespace Infineon
-} // namespace DeviceLayer
+void GenericEventManagementTestEventTriggerHandler::FillUpEventLoggingBufferWithFakeSoftwareFault(size_t bufferSize)
+{
+    /* Create a fake fault message. */
+    constexpr size_t kEncodingOverhead = 0x40;
+    const size_t recordSize            = bufferSize - kEncodingOverhead;
+    char * recordBuffer                = static_cast<char *>(Platform::MemoryAlloc(recordSize));
+    VerifyOrReturn(recordBuffer != nullptr);
+    std::unique_ptr<char, decltype(&Platform::MemoryFree)> recordString(recordBuffer, &Platform::MemoryFree);
+    memset(recordString.get(), 0x55, recordSize);
+    recordString.get()[recordSize - 1] = '\0';
+
+    /* Fill up the logging buffer by a software fault. */
+    TriggerSoftwareFaultEvent(recordString.get());
+}
+
+} // namespace app
 } // namespace chip

src/app/GenericEventManagementTestEventTriggerHandler.h

@@ -0,0 +1,37 @@
+/*
+ *
+ *    Copyright (c) 2024 Project CHIP Authors
+ *    All rights reserved.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+#pragma once
+
+#include <app/TestEventTriggerDelegate.h>
+
+namespace chip {
+namespace app {
+
+class GenericEventManagementTestEventTriggerHandler : public TestEventTriggerHandler
+{
+protected:
+    CHIP_ERROR HandleFillUpEventLoggingBufferEventTriger();
+
+private:
+    void FillUpEventLoggingBufferWithFakeSoftwareFault(size_t bufferSize);
+    virtual void TriggerSoftwareFaultEvent(const char * faultRecordString) = 0;
+};
+
+} // namespace app
+} // namespace chip