Skip to content

Commit

Permalink
Merge branch 'release_2.5-1.4' into bugfix/refrigerator-app-on-off-cl…
Browse files Browse the repository at this point in the history 
…uster
  • Loading branch information
@shgutte
shgutte authored Dec 9, 2024
2 parents 47a68bc + a272743 commit 17d30fb
Show file tree
Hide file tree
Showing 12 changed files with 262 additions and 47 deletions.
7 changes: 6 additions & 1 deletion examples/lighting-app/silabs/src/AppTask.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@

#include <lib/support/CodeUtils.h>

#include <lib/support/Span.h>
#include <platform/CHIPDeviceLayer.h>
#include <platform/silabs/tracing/SilabsTracingMacros.h>

#ifdef SL_CATALOG_SIMPLE_LED_LED1_PRESENT
#define LIGHT_LED 1
Expand Down Expand Up @@ -66,7 +68,9 @@ CHIP_ERROR AppTask::Init()
{
CHIP_ERROR err = CHIP_NO_ERROR;
chip::DeviceLayer::Silabs::GetPlatform().SetButtonsCb(AppTask::ButtonEventHandler);

char rebootLightOnKey[] = "Reboot->LightOn";
CharSpan rebootLighOnSpan(rebootLightOnKey);
SILABS_TRACE_REGISTER(rebootLighOnSpan);
#ifdef DISPLAY_ENABLED
GetLCD().Init((uint8_t *) "Lighting-App");
#endif
Expand All @@ -89,6 +93,7 @@ CHIP_ERROR AppTask::Init()

sLightLED.Init(LIGHT_LED);
sLightLED.Set(LightMgr().IsLightOn());
SILABS_TRACE_INSTANT(rebootLighOnSpan);

// Update the LCD with the Stored value. Show QR Code if not provisioned
#ifdef DISPLAY_ENABLED
Expand Down
6 changes: 4 additions & 2 deletions examples/lock-app/silabs/build_for_wifi_args.gni
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,7 @@ sl_use_subscription_syncing = true

# ICD Matter Configuration flags
sl_idle_mode_duration_s = 600 # 10min Idle Mode Duration
sl_active_mode_duration_ms = 10000 # 10s Active Mode Duration
sl_active_mode_threshold_ms = 1000 # 1s Active Mode Threshold
sl_active_mode_duration_ms = 0 # 0ms Active Mode Duration
sl_active_mode_threshold_ms = 0 # 1s Active Mode Threshold

sl_transport_idle_interval_ms = 3000 # 3s Transport Idle Interval
28 changes: 22 additions & 6 deletions examples/platform/silabs/shell/tracing/TracingShellCommands.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
#include <lib/shell/Command.h>
#include <lib/shell/Engine.h>
#include <lib/shell/commands/Help.h>
#include <lib/support/Span.h>
#include <platform/silabs/tracing/SilabsTracing.h>

using namespace chip;
Expand All @@ -29,6 +30,7 @@ using Shell::streamer_printf;
namespace {

using TimeTraceOperation = Tracing::Silabs::TimeTraceOperation;
using SilabsTracer = Tracing::Silabs::SilabsTracer;

TimeTraceOperation StringToTimeTraceOperation(const char * str)
{
Expand Down Expand Up @@ -144,9 +146,12 @@ CHIP_ERROR TracingHelpHandler(int argc, char ** argv)

CHIP_ERROR TracingListTimeOperations(int argc, char ** argv)
{
for (size_t i = 0; i < static_cast<size_t>(TimeTraceOperation::kNumTraces); ++i)

size_t TotalTraceNumber =
to_underlying(TimeTraceOperation::kNumTraces) + SilabsTracer::Instance().GetRegisteredAppOperationsCount();
for (size_t i = 0; i < TotalTraceNumber; ++i)
{
streamer_printf(streamer_get(), "Operation: %s\r\n", TimeTraceOperationToString(static_cast<TimeTraceOperation>(i)));
streamer_printf(streamer_get(), "Operation: %s\r\n", Tracing::Silabs::TimeTraceOperationToString(i));
}
return CHIP_NO_ERROR;
}
Expand All @@ -166,27 +171,38 @@ CHIP_ERROR WatermarksCommandHandler(int argc, char ** argv)
CHIP_ERROR error = CHIP_NO_ERROR;
if (strcmp(argv[0], "all") == 0)
{
error = Tracing::Silabs::SilabsTracer::Instance().OutputAllWaterMarks();
error = SilabsTracer::Instance().OutputAllWaterMarks();
}
else
{
TimeTraceOperation operation = StringToTimeTraceOperation(argv[0]);
error = Tracing::Silabs::SilabsTracer::Instance().OutputWaterMark(operation);
error = SilabsTracer::Instance().OutputWaterMark(operation);
}
return error;
}

CHIP_ERROR FlushCommandHandler(int argc, char ** argv)
{
CHIP_ERROR error = CHIP_NO_ERROR;
size_t index;
CharSpan opKey(argv[0], sizeof(argv[0]));
if (strcmp(argv[0], "all") == 0)
{
error = Tracing::Silabs::SilabsTracer::Instance().TraceBufferFlushAll();
error = SilabsTracer::Instance().TraceBufferFlushAll();
}
else if (CHIP_NO_ERROR == SilabsTracer::Instance().FindAppOperationIndex(opKey, index))
{
SilabsTracer::Instance().TraceBufferFlushByOperation(opKey);
}
else
{
TimeTraceOperation operation = StringToTimeTraceOperation(argv[0]);
error = Tracing::Silabs::SilabsTracer::Instance().TraceBufferFlushByOperation(operation);
if (operation == TimeTraceOperation::kNumTraces)
{
streamer_printf(streamer_get(), "Unknown Operation Key\r\n");
return CHIP_ERROR_INVALID_ARGUMENT;
}
error = SilabsTracer::Instance().TraceBufferFlushByOperation(to_underlying(operation));
}
return error;
}
Expand Down
4 changes: 4 additions & 0 deletions examples/platform/silabs/wifi/icd/ApplicationSleepManager.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,17 @@ CHIP_ERROR ApplicationSleepManager::Init()
void ApplicationSleepManager::OnCommissioningWindowOpened()
{
mIsCommissionningWindowOpen = true;
#if ( ( defined(SLI_SI91X_MCU_INTERFACE) && SLI_SI91X_MCU_INTERFACE == 1 ) )
mWifiSleepManager->VerifyAndTransitionToLowPowerMode();
#endif // ( ( defined(SLI_SI91X_MCU_INTERFACE) && SLI_SI91X_MCU_INTERFACE == 1 ) )
}

void ApplicationSleepManager::OnCommissioningWindowClosed()
{
mIsCommissionningWindowOpen = false;
#if ( ( defined(SLI_SI91X_MCU_INTERFACE) && SLI_SI91X_MCU_INTERFACE == 1 ) )
mWifiSleepManager->VerifyAndTransitionToLowPowerMode();
#endif // ( ( defined(SLI_SI91X_MCU_INTERFACE) && SLI_SI91X_MCU_INTERFACE == 1 ) )
}

void ApplicationSleepManager::OnSubscriptionEstablished(chip::app::ReadHandler & aReadHandler)
Expand Down
2 changes: 1 addition & 1 deletion scripts/examples/gn_silabs_example.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ else
exit 1
fi
USE_WIFI=true
optArgs+="chip_device_platform =\"efr32\" "
optArgs+="chip_device_platform =\"efr32\" chip_crypto_keystore=\"psa\""
shift
shift
;;
Expand Down
2 changes: 2 additions & 0 deletions src/platform/silabs/tracing/BUILD.gn
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ static_library("SilabsTracing") {
"BackendImpl.h",
"SilabsTracing.cpp",
"SilabsTracing.h",
"SilabsTracingMacros.h",
"SilabsTracingTypes.h",
]

deps = [
Expand Down
88 changes: 81 additions & 7 deletions src/platform/silabs/tracing/SilabsTracing.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,20 @@ const char * TimeTraceOperationToString(TimeTraceOperation operation)
}
}

const char * TimeTraceOperationToString(size_t operation)
{
if (operation >= to_underlying(TimeTraceOperation::kNumTraces))
{
size_t index = operation - to_underlying(TimeTraceOperation::kNumTraces);
VerifyOrReturnValue(index < SilabsTracer::kMaxAppOperationKeys, "Unknown");
return SilabsTracer::Instance().GetAppOperationKey(index);
}
else
{
return TimeTraceOperationToString(static_cast<TimeTraceOperation>(operation));
}
}

const char * OperationTypeToString(OperationType type)
{
switch (type)
Expand Down Expand Up @@ -181,7 +195,7 @@ CHIP_ERROR SilabsTracer::TimeTraceBegin(TimeTraceOperation aOperation)
// Log the start time of the operation
auto & tracker = mLatestTimeTrackers[to_underlying(aOperation)];
tracker.mStartTime = System::SystemClock().GetMonotonicTimestamp();
tracker.mOperation = aOperation;
tracker.mOperation = to_underlying(aOperation);
tracker.mType = OperationType::kBegin;
tracker.mError = CHIP_NO_ERROR;

Expand Down Expand Up @@ -233,15 +247,31 @@ CHIP_ERROR SilabsTracer::TimeTraceInstant(TimeTraceOperation aOperation, CHIP_ER
TimeTracker tracker;
tracker.mStartTime = System::SystemClock().GetMonotonicTimestamp();
tracker.mEndTime = tracker.mStartTime;
tracker.mOperation = aOperation;
tracker.mOperation = to_underlying(aOperation);
tracker.mType = OperationType::kInstant;
tracker.mError = error;
return OutputTrace(tracker);
}

CHIP_ERROR SilabsTracer::TimeTraceInstant(CharSpan & aOperationKey, CHIP_ERROR error)
{

VerifyOrReturnError(aOperationKey.size() <= kMaxAppOperationKeyLength, CHIP_ERROR_BUFFER_TOO_SMALL);
size_t index = 0;
ReturnErrorOnFailure(FindAppOperationIndex(aOperationKey, index));

TimeTracker tracker;
tracker.mStartTime = System::SystemClock().GetMonotonicTimestamp();
tracker.mEndTime = tracker.mStartTime;
tracker.mOperation = to_underlying(TimeTraceOperation::kNumTraces) + index;
tracker.mType = OperationType::kInstant;
tracker.mError = error;
return OutputTrace(tracker);
}

CHIP_ERROR SilabsTracer::OutputTimeTracker(const TimeTracker & tracker)
{
VerifyOrReturnError(to_underlying(tracker.mOperation) < kNumTraces, CHIP_ERROR_INVALID_ARGUMENT,
VerifyOrReturnError(tracker.mOperation < kNumTraces + kMaxAppOperationKeys, CHIP_ERROR_INVALID_ARGUMENT,
ChipLogError(DeviceLayer, "Invalid tracker"));
VerifyOrReturnError(isLogInitialized(), CHIP_ERROR_UNINITIALIZED);
// Allocate a buffer to store the trace
Expand All @@ -268,7 +298,7 @@ CHIP_ERROR SilabsTracer::OutputTrace(const TimeTracker & tracker)
TimeTracker resourceExhaustedTracker = tracker;
resourceExhaustedTracker.mStartTime = System::SystemClock().GetMonotonicTimestamp();
resourceExhaustedTracker.mEndTime = resourceExhaustedTracker.mStartTime;
resourceExhaustedTracker.mOperation = TimeTraceOperation::kBufferFull;
resourceExhaustedTracker.mOperation = to_underlying(TimeTraceOperation::kBufferFull);
resourceExhaustedTracker.mType = OperationType::kInstant;
resourceExhaustedTracker.mError = CHIP_ERROR_BUFFER_TOO_SMALL;
mTimeTrackerList.Insert(resourceExhaustedTracker);
Expand Down Expand Up @@ -328,9 +358,9 @@ CHIP_ERROR SilabsTracer::TraceBufferFlushAll()
return CHIP_NO_ERROR;
}

CHIP_ERROR SilabsTracer::TraceBufferFlushByOperation(TimeTraceOperation aOperation)
CHIP_ERROR SilabsTracer::TraceBufferFlushByOperation(size_t aOperation)
{
VerifyOrReturnError(to_underlying(aOperation) < kNumTraces, CHIP_ERROR_INVALID_ARGUMENT,
VerifyOrReturnError(aOperation < kNumTraces + kMaxAppOperationKeys, CHIP_ERROR_INVALID_ARGUMENT,
ChipLogError(DeviceLayer, "Invalid TimeTraceOperation"));
auto * current = mTimeTrackerList.head;
auto * prev = static_cast<chip::SingleLinkedListNode<TimeTracker> *>(nullptr);
Expand Down Expand Up @@ -362,6 +392,13 @@ CHIP_ERROR SilabsTracer::TraceBufferFlushByOperation(TimeTraceOperation aOperati
return CHIP_NO_ERROR;
}

CHIP_ERROR SilabsTracer::TraceBufferFlushByOperation(CharSpan & appOperationKey)
{
size_t index = 0;
ReturnErrorOnFailure(FindAppOperationIndex(appOperationKey, index));
return SilabsTracer::Instance().TraceBufferFlushByOperation(index + to_underlying(TimeTraceOperation::kNumTraces));
}

// Save the traces in the NVM
CHIP_ERROR SilabsTracer::SaveWatermarks()
{
Expand All @@ -377,7 +414,7 @@ CHIP_ERROR SilabsTracer::LoadWatermarks()
return CHIP_NO_ERROR;
}

CHIP_ERROR SilabsTracer::GetTraceByOperation(TimeTraceOperation aOperation, MutableByteSpan & buffer) const
CHIP_ERROR SilabsTracer::GetTraceByOperation(size_t aOperation, MutableByteSpan & buffer) const
{
auto * current = mTimeTrackerList.head;
while (current != nullptr)
Expand Down Expand Up @@ -405,6 +442,43 @@ CHIP_ERROR SilabsTracer::GetTraceByOperation(TimeTraceOperation aOperation, Muta
return CHIP_ERROR_NOT_FOUND;
}

CHIP_ERROR SilabsTracer::GetTraceByOperation(CharSpan & appOperationKey, MutableByteSpan & buffer) const
{
size_t index = 0;
ReturnErrorOnFailure(FindAppOperationIndex(appOperationKey, index));
return GetTraceByOperation(index + to_underlying(TimeTraceOperation::kNumTraces), buffer);
}

CHIP_ERROR SilabsTracer::RegisterAppTimeTraceOperation(CharSpan & appOperationKey)
{
VerifyOrReturnError(appOperationKey.size() <= kMaxAppOperationKeyLength, CHIP_ERROR_BUFFER_TOO_SMALL);
VerifyOrReturnError(mAppOperationKeyCount < kMaxAppOperationKeys, CHIP_ERROR_NO_MEMORY);
VerifyOrReturnError(appOperationKey.data() != nullptr, CHIP_ERROR_INVALID_ARGUMENT);
// Verify the key is not already in the array
size_t index = 0;
VerifyOrReturnError(CHIP_ERROR_NOT_FOUND == FindAppOperationIndex(appOperationKey, index), CHIP_ERROR_INVALID_ARGUMENT);

MutableCharSpan newAppKey(mAppOperationKeys[mAppOperationKeyCount]);
CopyCharSpanToMutableCharSpan(appOperationKey, newAppKey);
mAppOperationKeyCount++;
return CHIP_NO_ERROR;
}

CHIP_ERROR SilabsTracer::FindAppOperationIndex(CharSpan & appOperationKey, size_t & index) const
{
for (size_t i = 0; i < mAppOperationKeyCount; ++i)
{
CharSpan appKey(mAppOperationKeys[i], appOperationKey.size());
if (appKey.data_equal(appOperationKey))
{
index = i;
return CHIP_NO_ERROR;
}
}
index = SilabsTracer::kMaxAppOperationKeys;
return CHIP_ERROR_NOT_FOUND;
}

} // namespace Silabs
} // namespace Tracing
} // namespace chip
48 changes: 42 additions & 6 deletions src/platform/silabs/tracing/SilabsTracing.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ struct TimeTracker
// Temporary values
System::Clock::Milliseconds32 mStartTime;
System::Clock::Milliseconds32 mEndTime;
TimeTraceOperation mOperation;
size_t mOperation;
OperationType mType;
CHIP_ERROR mError;

Expand Down Expand Up @@ -80,9 +80,11 @@ struct Watermark
class SilabsTracer
{
public:
static constexpr size_t kNumTraces = to_underlying(TimeTraceOperation::kNumTraces);
static constexpr size_t kMaxBufferedTraces = 64;
static constexpr size_t kMaxTraceSize = 128;
static constexpr size_t kNumTraces = to_underlying(TimeTraceOperation::kNumTraces);
static constexpr size_t kMaxAppOperationKeys = 5;
static constexpr size_t kMaxAppOperationKeyLength = 16;
static constexpr size_t kMaxBufferedTraces = 64;
static constexpr size_t kMaxTraceSize = 128;

/** @brief Get the singleton instance of SilabsTracer */
static SilabsTracer & Instance() { return sInstance; }
Expand Down Expand Up @@ -130,6 +132,12 @@ class SilabsTracer
{
return TimeTraceInstant(aOperation, ChipError((error)));
}
/** @brief TimeTraceInstant
* We currently allow to register App specific operations to be tracked by the time tracer, but only for instant traces, and
* not for watermarks.
* @param appOperation The name of the app operation key to generate a trace for
*/
CHIP_ERROR TimeTraceInstant(CharSpan & appOperationKey, CHIP_ERROR error = CHIP_NO_ERROR);

/** @brief Output a time tracker
* This will output the latest time tracker for a specific operation, without affecting the buffer.
Expand Down Expand Up @@ -162,7 +170,8 @@ class SilabsTracer
* @param aOperation The operation to flush traces for
* @return CHIP_ERROR, returns CHIP_ERROR_UNINITIALIZED if the logs are not initialized
*/
CHIP_ERROR TraceBufferFlushByOperation(TimeTraceOperation aOperation);
CHIP_ERROR TraceBufferFlushByOperation(size_t aOperation);
CHIP_ERROR TraceBufferFlushByOperation(CharSpan & appOperationKey);

// prevent copy constructor and assignment operator
SilabsTracer(SilabsTracer const &) = delete;
Expand Down Expand Up @@ -192,7 +201,29 @@ class SilabsTracer
*/
Watermark GetWatermark(TimeTraceOperation aOperation) { return mWatermarks[to_underlying(aOperation)]; }
size_t GetTimeTracesCount() { return mBufferedTrackerCount; }
CHIP_ERROR GetTraceByOperation(TimeTraceOperation aOperation, MutableByteSpan & buffer) const;

CHIP_ERROR GetTraceByOperation(size_t aOperation, MutableByteSpan & buffer) const;
CHIP_ERROR GetTraceByOperation(CharSpan & appOperationKey, MutableByteSpan & buffer) const;

/** @brief Register an App specific time trace operation
* This will register an App specific operation to be tracked by the time tracer. The string will be mapped to a
* TimeTraceOperation higher than the kNumTraces value.
* @param appOperationKey The key of the custom operation, can only be in the array once
* @return CHIP_ERROR, returns CHIP_ERROR_BUFFER_TOO_SMALL if the key is too long, CHIP_ERROR_NO_MEMORY if the buffer is full,
* and CHIP_ERROR_INVALID_ARGUMENT if the key is null or already in the array.
*/
CHIP_ERROR RegisterAppTimeTraceOperation(CharSpan & appOperationKey);

/** @brief Find the index of a custom operation
* @param appOperation The key of the custom operation to find
* @param index The index of the custom operation
* @return CHIP_ERROR, returns CHIP_ERROR_NOT_FOUND if the buffer is full, the index will be set to the maximum number of
* custom operations if the operationis not found
*/
CHIP_ERROR FindAppOperationIndex(CharSpan & appOperationKey, size_t & index) const;

inline size_t GetRegisteredAppOperationsCount() { return mAppOperationKeyCount; }
inline char * GetAppOperationKey(size_t index) { return mAppOperationKeys[index]; }

private:
struct TimeTrackerList
Expand Down Expand Up @@ -254,6 +285,10 @@ class SilabsTracer

size_t mBufferedTrackerCount = 0;

// App specific Operation keys buffer
char mAppOperationKeys[SilabsTracer::kMaxAppOperationKeys][SilabsTracer::kMaxAppOperationKeyLength];
size_t mAppOperationKeyCount = 0;

/** @brief Clear the trace buffer */
void TraceBufferClear();

Expand All @@ -268,6 +303,7 @@ class SilabsTracer
};

const char * TimeTraceOperationToString(TimeTraceOperation operation);
const char * TimeTraceOperationToString(size_t operation);

} // namespace Silabs
} // namespace Tracing
Expand Down
Loading

0 comments on commit 17d30fb

Please sign in to comment.