mirror of
https://github.com/FreeRTOS/FreeRTOS-Kernel.git
synced 2025-10-14 00:37:44 -04:00
3a2f6646f0
* Use new version of CI-CD Actions, checkout@v3 instead of checkout@v2 on all jobs * Use cSpell spell check, and use ubuntu-20.04 for formatting check * Add in bot formatting action * Update freertos_demo.yml and freertos_plus_demo.yml files to increase github log readability * Add in a Qemu demo onto the workflows.
149 lines
5.6 KiB
C
149 lines
5.6 KiB
C
/*
|
|
* Percepio Trace Recorder for Tracealyzer v4.6.0
|
|
* Copyright 2021 Percepio AB
|
|
* www.percepio.com
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
*
|
|
* @internal Public trace multicore event buffer APIs.
|
|
*/
|
|
|
|
#ifndef TRC_MULTI_CORE_EVENT_BUFFER_H
|
|
#define TRC_MULTI_CORE_EVENT_BUFFER_H
|
|
|
|
#if ( TRC_USE_TRACEALYZER_RECORDER == 1 )
|
|
|
|
#if ( TRC_CFG_RECORDER_MODE == TRC_RECORDER_MODE_STREAMING )
|
|
|
|
#include <trcTypes.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @defgroup trace_multi_core_event_buffer_apis Trace Multi-Core Event Buffer APIs
|
|
* @ingroup trace_recorder_apis
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief Trace Multi-Core Event Buffer Structure
|
|
*/
|
|
typedef struct TraceMultiCoreEventBuffer
|
|
{
|
|
TraceEventBuffer_t * xEventBuffer[ TRC_CFG_CORE_COUNT ]; /**< */
|
|
} TraceMultiCoreEventBuffer_t;
|
|
|
|
/**
|
|
* @internal Initialize multi-core event buffer.
|
|
*
|
|
* This routine initializes a multi-core trace event buffer and assigns it
|
|
* a memory area based on the supplied buffer.
|
|
*
|
|
* Trace event buffer options specifies the buffer behavior regarding
|
|
* old data, the alternatives are TRC_EVENT_BUFFER_OPTION_SKIP and
|
|
* TRC_EVENT_BUFFER_OPTION_OVERWRITE (mutual exclusive).
|
|
*
|
|
* @param[out] pxTraceMultiCoreEventBuffer Pointer to uninitialized multi-core trace event buffer.
|
|
* @param[in] uiOptions Trace event buffer options.
|
|
* @param[in] puiBuffer Pointer to buffer that will be used by the multi-core trace event buffer.
|
|
* @param[in] uiSize Size of buffer.
|
|
*
|
|
* @retval TRC_FAIL Failure
|
|
* @retval TRC_SUCCESS Success
|
|
*/
|
|
traceResult xTraceMultiCoreEventBufferInitialize( TraceMultiCoreEventBuffer_t * pxTraceMultiCoreEventBuffer,
|
|
uint32_t uiOptions,
|
|
uint8_t * puiBuffer,
|
|
uint32_t uiSize );
|
|
|
|
|
|
|
|
#if ( ( TRC_CFG_USE_TRACE_ASSERT ) == 1 )
|
|
|
|
/**
|
|
* @brief Pushes data into multi-core trace event buffer.
|
|
*
|
|
* This routine attempts to push data into the multi-core trace event buffer. Selection
|
|
* of which core the data is pushed for is managed automatically through the
|
|
* TRC_CFG_GET_CURRENT_CORE macro which is defined on an RTOS basis.
|
|
*
|
|
* @param[in] pxTraceMultiCoreEventBuffer Pointer to initialized multi-core event buffer.
|
|
* @param[in] pvData Pointer to data should be pushed into multi-core event buffer.
|
|
* @param[in] uiSize Size of data that should be pushed into multi-core trace event buffer.
|
|
* @param[out] piBytesWritten Pointer to variable which the routine will write the number
|
|
* of bytes that was pushed into the multi-core trace event buffer.
|
|
*
|
|
* @retval TRC_FAIL Failure
|
|
* @retval TRC_SUCCESS Success
|
|
*/
|
|
traceResult xTraceMultiCoreEventBufferPush( TraceMultiCoreEventBuffer_t * pxTraceMultiCoreEventBuffer,
|
|
void * pvData,
|
|
uint32_t uiSize,
|
|
int32_t * piBytesWritten );
|
|
|
|
#else
|
|
|
|
/**
|
|
* @brief Pushes data into multi-core trace event buffer.
|
|
*
|
|
* This routine attempts to push data into the multi-core trace event buffer. Selection
|
|
* of which core the data is pushed for is managed automatically through the
|
|
* TRC_CFG_GET_CURRENT_CORE macro which is defined on an RTOS basis.
|
|
*
|
|
* @param[in] pxTraceMultiCoreEventBuffer Pointer to initialized multi-core event buffer.
|
|
* @param[in] pvData Pointer to data should be pushed into multi-core event buffer.
|
|
* @param[in] uiSize Size of data that should be pushed into multi-core trace event buffer.
|
|
* @param[out] piBytesWritten Pointer to variable which the routine will write the number
|
|
* of bytes that was pushed into the multi-core trace event buffer.
|
|
*
|
|
* @retval TRC_FAIL Failure
|
|
* @retval TRC_SUCCESS Success
|
|
*/
|
|
#define xTraceMultiCoreEventBufferPush( pxTraceMultiCoreEventBuffer, pvData, uiSize, piBytesWritten ) xTraceEventBufferPush( ( pxTraceMultiCoreEventBuffer )->xEventBuffer[ TRC_CFG_GET_CURRENT_CORE() ], pvData, uiSize, piBytesWritten )
|
|
|
|
#endif /* if ( ( TRC_CFG_USE_TRACE_ASSERT ) == 1 ) */
|
|
|
|
/**
|
|
* @brief Transfer multi-core trace event buffer data through streamport.
|
|
*
|
|
* This routine will attempt to transfer all existing data in the multi-core trace event
|
|
* buffer through the streamport. New data pushed to the trace event buffer
|
|
* during the execution of this routine will not be transferred to
|
|
*
|
|
* @param[in] pxTraceMultiCoreEventBuffer Pointer to initialized multi-core event buffer.
|
|
* @param[out] piBytesWritten Pointer to variable which the routine will write the number
|
|
* of bytes that was pushed into the multi-core trace event buffer.
|
|
*
|
|
* @retval TRC_FAIL Failure
|
|
* @retval TRC_SUCCESS Success
|
|
*/
|
|
traceResult xTraceMultiCoreEventBufferTransfer( TraceMultiCoreEventBuffer_t * pxTraceMultiCoreEventBuffer,
|
|
int32_t * piBytesWritten );
|
|
|
|
/**
|
|
* @brief Clears all data from event buffer.
|
|
*
|
|
* @param[in] pxTraceMultiCoreEventBuffer Pointer to initialized multi-core trace event buffer.
|
|
*
|
|
* @retval TRC_FAIL Failure
|
|
* @retval TRC_SUCCESS Success
|
|
*/
|
|
traceResult xTraceMultiCoreEventBufferClear( TraceMultiCoreEventBuffer_t * pxTraceMultiCoreEventBuffer );
|
|
|
|
/** @} */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* (TRC_CFG_RECORDER_MODE == TRC_RECORDER_MODE_STREAMING) */
|
|
|
|
#endif /* (TRC_USE_TRACEALYZER_RECORDER == 1) */
|
|
|
|
#endif /* TRC_MULTI_CORE_EVENT_BUFFER_H */
|