FreeRTOS-Kernel/FreeRTOS-Plus/Source/FreeRTOS-Plus-Trace/streamports/TCPIP/include/trcStreamPort.h
Soren Ptak 3a2f6646f0
Use CI-CD-Github-Actions for spelling and formatting, add in the bot formatting action, update the CI-CD workflow files. Fix incorrect spelling and formatting on files. (#1083)
* 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.
2023-09-06 12:35:37 -07:00

78 lines
2.7 KiB
C

/*
* Trace Recorder for Tracealyzer v4.6.0
* Copyright 2021 Percepio AB
* www.percepio.com
*
* SPDX-License-Identifier: Apache-2.0
*
* The interface definitions for trace streaming ("stream ports").
* This "stream port" sets up the recorder to use TCP/IP as streaming channel.
* The example is for lwIP.
*/
#ifndef TRC_STREAM_PORT_H
#define TRC_STREAM_PORT_H
#include <stdint.h>
#include <trcTypes.h>
#include <trcStreamPortConfig.h>
#ifdef __cplusplus
extern "C" {
#endif
#define TRC_USE_INTERNAL_BUFFER ( TRC_CFG_STREAM_PORT_USE_INTERNAL_BUFFER )
/**
* @def TRC_STREAM_PORT_BUFFER_SIZE
*
* @brief The buffer size, aligned to base type.
*/
#define TRC_STREAM_PORT_BUFFER_SIZE ( ( ( ( TRC_CFG_STREAM_PORT_BUFFER_SIZE ) + sizeof( TraceUnsignedBaseType_t ) - 1 ) / sizeof( TraceUnsignedBaseType_t ) ) * sizeof( TraceUnsignedBaseType_t ) )
typedef struct TraceStreamPortBuffer
{
#if ( TRC_USE_INTERNAL_BUFFER )
uint8_t buffer[ ( TRC_STREAM_PORT_BUFFER_SIZE ) ];
#else
TraceUnsignedBaseType_t buffer[ 1 ];
#endif
} TraceStreamPortBuffer_t;
int32_t prvTraceTcpWrite( void * pvData,
uint32_t uiSize,
int32_t * piBytesWritten );
int32_t prvTraceTcpRead( void * pvData,
uint32_t uiSize,
int32_t * piBytesRead );
traceResult xTraceStreamPortInitialize( TraceStreamPortBuffer_t * pxBuffer );
#define xTraceStreamPortAllocate( uiSize, ppvData ) ( ( void ) ( uiSize ), xTraceStaticBufferGet( ppvData ) )
#if ( TRC_USE_INTERNAL_BUFFER == 1 )
/* Push to internal buffer. It will call on xTraceStreamPortWriteData() periodically. */
#define xTraceStreamPortCommit xTraceInternalEventBufferPush
#else
/* Write directly */
#define xTraceStreamPortCommit xTraceStreamPortWriteData
#endif
#define xTraceStreamPortWriteData( pvData, uiSize, piBytesWritten ) ( prvTraceTcpWrite( pvData, uiSize, piBytesWritten ) == 0 ? TRC_SUCCESS : TRC_FAIL )
#define xTraceStreamPortReadData( pvData, uiSize, piBytesRead ) ( prvTraceTcpRead( pvData, uiSize, piBytesRead ) == 0 ? TRC_SUCCESS : TRC_FAIL )
#define xTraceStreamPortOnEnable( uiStartOption ) ( ( void ) ( uiStartOption ), TRC_SUCCESS )
#define xTraceStreamPortOnDisable() ( TRC_SUCCESS )
#define xTraceStreamPortOnTraceBegin() ( TRC_SUCCESS )
traceResult xTraceStreamPortOnTraceEnd( void );
#ifdef __cplusplus
}
#endif
#endif /* TRC_STREAM_PORT_H */