131 lines
3.7 KiB
C
Executable File
131 lines
3.7 KiB
C
Executable File
/*
|
|
* Percepio Trace Recorder for Tracealyzer v4.6.4
|
|
* Copyright 2021 Percepio AB
|
|
* www.percepio.com
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
*
|
|
* @brief Public trace interval APIs.
|
|
*/
|
|
|
|
#ifndef TRC_INTERVAL_H
|
|
#define TRC_INTERVAL_H
|
|
|
|
#if (TRC_USE_TRACEALYZER_RECORDER == 1)
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#if (TRC_CFG_RECORDER_MODE == TRC_RECORDER_MODE_STREAMING)
|
|
|
|
#include <trcTypes.h>
|
|
|
|
#define TRC_INTERVAL_CHANNEL_SET_INDEX 0
|
|
|
|
/**
|
|
* @defgroup trace_interval_apis Trace Interval APIs
|
|
* @ingroup trace_recorder_apis
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief Creates trace interval channel set.
|
|
*
|
|
* @param[in] szName Name.
|
|
* @param[out] pxIntervalChannelSetHandle Pointer to uninitialized trace interval channel set.
|
|
*
|
|
* @retval TRC_FAIL Failure
|
|
* @retval TRC_SUCCESS Success
|
|
*/
|
|
traceResult xTraceIntervalChannelSetCreate(const char* szName, TraceIntervalChannelSetHandle_t* pxIntervalChannelSetHandle);
|
|
|
|
/**
|
|
* @brief Creates trace interval channel.
|
|
*
|
|
* @param[in] szName Name.
|
|
* @param[in] xIntervalChannelSetHandle Interval set that this channel belongs to.
|
|
* @param[out] pxIntervalChannelHandle Pointer to uninitialized trace interval channel.
|
|
*
|
|
* @retval TRC_FAIL Failure
|
|
* @retval TRC_SUCCESS Success
|
|
*/
|
|
traceResult xTraceIntervalChannelCreate(const char *szName, TraceIntervalChannelSetHandle_t xIntervalChannelSetHandle, TraceIntervalChannelHandle_t *pxIntervalChannelHandle);
|
|
|
|
/**
|
|
* @brief Starts trace interval instance.
|
|
*
|
|
* @param[in] xIntervalChannelHandle Interval handle.
|
|
* @param[in] uxValue Value that can be used to tell instances apart.
|
|
* @param[out] pxIntervalInstanceHandle Pointer to interval instance variable.
|
|
*
|
|
* @retval TRC_FAIL Failure
|
|
* @retval TRC_SUCCESS Success
|
|
*/
|
|
traceResult xTraceIntervalStart(TraceIntervalChannelHandle_t xIntervalChannelHandle, TraceUnsignedBaseType_t uxValue, TraceIntervalInstanceHandle_t* pxIntervalInstanceHandle);
|
|
|
|
/**
|
|
* @brief Stops trace interval instance.
|
|
*
|
|
* @param[in] xIntervalChannelHandle Interval handle.
|
|
* @param[in] xIntervalInstanceHandle Interval instance.
|
|
*
|
|
* @retval TRC_FAIL Failure
|
|
* @retval TRC_SUCCESS Success
|
|
*/
|
|
traceResult xTraceIntervalStop(TraceIntervalChannelHandle_t xIntervalChannelHandle, TraceIntervalInstanceHandle_t xIntervalInstanceHandle);
|
|
|
|
/**
|
|
* @brief Gets trace interval channel state.
|
|
*
|
|
* @param[in] xIntervalChannelHandle Pointer to initialized trace interval.
|
|
* @param[out] puxState State.
|
|
*
|
|
* @retval TRC_FAIL Failure
|
|
* @retval TRC_SUCCESS Success
|
|
*/
|
|
#define xTraceIntervalGetState(xIntervalChannelHandle, puxState) xTraceEntryGetState((TraceEntryHandle_t)(xIntervalChannelHandle), TRC_INTERVAL_CHANNEL_SET_INDEX, puxState)
|
|
|
|
/** @} */
|
|
|
|
#else
|
|
|
|
/**
|
|
* @brief Disabled by TRC_CFG_RECORDER_MODE
|
|
*/
|
|
#define xTraceIntervalChannelSetCreate(__szName, __pxIntervalChannelSetHandle) ((void)(__szName), *(__pxIntervalChannelSetHandle) = 0, TRC_SUCCESS)
|
|
|
|
/**
|
|
* @brief Disabled by TRC_CFG_RECORDER_MODE
|
|
*/
|
|
#define xTraceIntervalChannelCreate(__szName, __xIntervalChannelSetHandle, __pxIntervalChannelHandle) ((void)(__szName), (void)(__xIntervalChannelSetHandle), *(__pxIntervalChannelHandle) = 0, TRC_SUCCESS)
|
|
|
|
/**
|
|
* @brief Disabled by TRC_CFG_RECORDER_MODE
|
|
*/
|
|
#define xTraceIntervalStart(__xIntervalHandle, __uxValue, __pxIntervalInstanceHandle) ((void)(__xIntervalHandle), (void)(__uxValue), *(__pxIntervalInstanceHandle) = 0, TRC_SUCCESS)
|
|
|
|
/**
|
|
* @brief Disabled by TRC_CFG_RECORDER_MODE
|
|
*/
|
|
#define xTraceIntervalStop(__xIntervalHandle, __xIntervalInstanceHandle) ((void)(__xIntervalHandle), (void)(__xIntervalInstanceHandle), TRC_SUCCESS)
|
|
|
|
/**
|
|
* @brief Disabled by TRC_CFG_RECORDER_MODE
|
|
*/
|
|
#define xTraceIntervalGetState(__xIntervalHandle, __puxState) ((void)(__xIntervalHandle), *(__puxState) = 0, TRC_SUCCESS)
|
|
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|
|
|
|
#endif
|