Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Infineon] Add a test trigger for CYW30739 to fill up event logging buffers. #33382

Merged
merged 3 commits into from
May 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions examples/platform/infineon/cyw30739/BUILD.gn
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,10 @@ import("${cyw30739_sdk_build_root}/cyw30739_sdk.gni")

static_library("platform") {
sources = [
"EventManagementTestEventTriggerHandler.h",
"LEDWidget.h",
"OTAConfig.h",
"SoftwareDiagnostics.h",
"main.cpp",
]

Expand Down
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/*
*
* 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/GenericEventManagementTestEventTriggerHandler.h>

namespace chip {
namespace DeviceLayer {
namespace Infineon {
namespace CYW30739 {

class EventManagementTestEventTriggerHandler : public app::GenericEventManagementTestEventTriggerHandler
{
public:
static constexpr uint64_t kFillUpEventLoggingBuffer = 0xffff'ffff'1388'0000;

CHIP_ERROR HandleEventTrigger(uint64_t eventTrigger) override;

private:
virtual void TriggerSoftwareFaultEvent(const char * faultRecordString) override;
};

} // namespace CYW30739
} // namespace Infineon
} // namespace DeviceLayer
} // namespace chip
62 changes: 62 additions & 0 deletions examples/platform/infineon/cyw30739/SoftwareDiagnostics.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
/*
*
* 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 "SoftwareDiagnostics.h"

#include <app/clusters/software-diagnostics-server/software-diagnostics-server.h>
#include <app/util/config.h>
#include <platform/CHIPDeviceLayer.h>

namespace chip {
namespace DeviceLayer {
namespace Infineon {
namespace CYW30739 {

using namespace chip::app::Clusters;

void OnSoftwareFaultEventHandler(const char * faultRecordString)
{
#ifdef MATTER_DM_PLUGIN_SOFTWARE_DIAGNOSTICS_SERVER
SoftwareDiagnostics::Events::SoftwareFault::Type softwareFault;

/* Unable to access thread ID in the application layer. */
softwareFault.id = 0;

if (DeviceLayer::PlatformMgrImpl().IsCurrentTask())
{
softwareFault.name.SetValue("Matter"_span);
}
else if (DeviceLayer::ThreadStackMgrImpl().IsCurrentTask())
{
softwareFault.name.SetValue("Thread"_span);
}
else
{
softwareFault.name.SetValue("App"_span);
}

softwareFault.faultRecording.SetValue(ByteSpan(Uint8::from_const_char(faultRecordString), strlen(faultRecordString)));

SoftwareDiagnosticsServer::Instance().OnSoftwareFaultDetect(softwareFault);
#endif // MATTER_DM_PLUGIN_SOFTWARE_DIAGNOSTICS_SERVER
}

} // namespace CYW30739
} // namespace Infineon
} // namespace DeviceLayer
} // namespace chip
29 changes: 29 additions & 0 deletions examples/platform/infineon/cyw30739/SoftwareDiagnostics.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/*
*
* 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.
*/

namespace chip {
namespace DeviceLayer {
namespace Infineon {
namespace CYW30739 {

void OnSoftwareFaultEventHandler(const char * faultRecordString);

} // namespace CYW30739
} // namespace Infineon
} // namespace DeviceLayer
} // namespace chip
2 changes: 2 additions & 0 deletions examples/platform/infineon/cyw30739/cyw30739_example.gni
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@ template("cyw30739_example") {

static_library(target_name) {
sources = [
"${cyw30739_example_dir}/EventManagementTestEventTriggerHandler.cpp",
"${cyw30739_example_dir}/LEDWidget.cpp",
"${cyw30739_example_dir}/OTAConfig.cpp",
"${cyw30739_example_dir}/SoftwareDiagnostics.cpp",
"${cyw30739_example_dir}/matter_config.cpp",
]

Expand Down
3 changes: 3 additions & 0 deletions examples/platform/infineon/cyw30739/matter_config.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

#include "matter_config.h"
#include "AppTask.h"
#include "EventManagementTestEventTriggerHandler.h"
#ifdef BOARD_ENABLE_DISPLAY
#include "GUI.h"
#endif
Expand Down Expand Up @@ -191,8 +192,10 @@ void CYW30739MatterConfig::InitApp(void)
/* Start CHIP datamodel server */
static chip::SimpleTestEventTriggerDelegate sTestEventTriggerDelegate{};
static chip::OTATestEventTriggerHandler sOtaTestEventTriggerHandler{};
static Infineon::CYW30739::EventManagementTestEventTriggerHandler sEventManagementTestEventTriggerHandler{};
VerifyOrDie(sTestEventTriggerDelegate.Init(chip::ByteSpan(sTestEventTriggerEnableKey)) == CHIP_NO_ERROR);
andy31415 marked this conversation as resolved.
Show resolved Hide resolved
VerifyOrDie(sTestEventTriggerDelegate.AddHandler(&sOtaTestEventTriggerHandler) == CHIP_NO_ERROR);
VerifyOrDie(sTestEventTriggerDelegate.AddHandler(&sEventManagementTestEventTriggerHandler) == CHIP_NO_ERROR);
// Create initParams with SDK example defaults here
static chip::CommonCaseDeviceServerInitParams initParams;
(void) initParams.InitializeStaticResourcesBeforeServerInit();
Expand Down
2 changes: 2 additions & 0 deletions src/app/BUILD.gn
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,8 @@ static_library("app") {
"EventManagement.h",
"FailSafeContext.cpp",
"FailSafeContext.h",
"GenericEventManagementTestEventTriggerHandler.cpp",
"GenericEventManagementTestEventTriggerHandler.h",
"OTAUserConsentCommon.h",
"ReadHandler.cpp",
"SafeAttributePersistenceProvider.h",
Expand Down
72 changes: 72 additions & 0 deletions src/app/GenericEventManagementTestEventTriggerHandler.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
/*
*
* 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 "GenericEventManagementTestEventTriggerHandler.h"

#include <app/clusters/general-diagnostics-server/general-diagnostics-server.h>
#include <platform/GeneralFaults.h>

namespace chip {
namespace app {

using namespace chip::DeviceLayer;
using namespace chip::app::Clusters;

CHIP_ERROR GenericEventManagementTestEventTriggerHandler::HandleFillUpEventLoggingBufferEventTriger()
{
/* Create a fake hardware fault list. */
GeneralFaults<kMaxHardwareFaults> hardwareFaults;
for (uint8_t hardwareFault = to_underlying(GeneralDiagnostics::HardwareFaultEnum::kUnspecified);
hardwareFault < kMaxHardwareFaults; hardwareFault++)
{
hardwareFaults.add(hardwareFault);
}

/* Fill up the critical logging buffer by 10 hardware faults. */
constexpr uint8_t kHardwareFaultCountForCriticalBuffer = 10;
for (uint8_t i = 0; i < kHardwareFaultCountForCriticalBuffer; i++)
{
GeneralDiagnosticsServer::Instance().OnHardwareFaultsDetect(hardwareFaults, hardwareFaults);
}

/* Fill up the info logging buffer. */
FillUpEventLoggingBufferWithFakeSoftwareFault(CHIP_DEVICE_CONFIG_EVENT_LOGGING_INFO_BUFFER_SIZE);

/* Fill up the debug logging buffer. */
FillUpEventLoggingBufferWithFakeSoftwareFault(CHIP_DEVICE_CONFIG_EVENT_LOGGING_DEBUG_BUFFER_SIZE);

return CHIP_NO_ERROR;
}

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
37 changes: 37 additions & 0 deletions src/app/GenericEventManagementTestEventTriggerHandler.h
Original file line number Diff line number Diff line change
@@ -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
Loading