This guide is for v4.6 and later for the recorder and for use with Azure RTOS ThreadX version 6.0 or later. The instructions assumes that GCC and make are used, but the setup can be replicated with other tools. Contact firstname.lastname@example.org if you need help with this.
Copy the files into your project. The folder structure is a bit different depending on if the code is copied from the Tracealyzer installation directory or from the official git repository.
If the code is copied from the installation directory of Tracealyzer all files should be copied from the selected RTOS folder and the include and config subfolders.
If the code is copied from the git repository all c and h files should be copied into your project from the folders described below.
/ /config /include /kernelports/selected RTOS /kernelports/selected RTOS/config /kernelports/selected RTOS/include
Make sure to add the path to the h files to the compilers “include paths” so the compiler can find them. This step is different depending on your development environment.
In trcConfig.h set
TRC_CFG_HARDWARE_PORTto the architecture used. For some hardware ports an
#includeof the processors header file needs to be done by replacing the row
#error "Trace Recorder: Please include your processor's header file here and remove this line.". If the error line is removed and your project compiles the header file isn’t needed. All available hardware ports can be found at the bottom of trcDefines.h.
In trcKernelPortConfig.h set
TRC_CFG_CPU_CLOCK_HZto the frequency used by the timer used for time stamping in the hardware port.
Include trcRecorder.h at the end of tx_api.h and enable
TX_ENABLE_EVENT_TRACEeither in tx_user.h (make sure
TX_INCLUDE_USER_DEFINE_FILEis defined) or by a compiler flag.
xTraceEnable()with the selected option at the top of the
tx_application_definefunction. The arguments that can be used with
TRC_STARTthis starts the tracing directly this should be used in snapshot mode or streaming when no input from a host computer is needed, the next option is
TRC_START_AWAIT_HOSTthis is used for streaming and will block until a start command are received from the host. The last option is
TRC_START_FROM_HOST, this is used from streaming and will wait for a start command from the host computer to start tracing but this option is none blocking.
Step 4 and 5 looks a bit different depending on the IDE used. The below example is from STM32CubeIDE. For now only GCC is supported with this method.
In the project settings, add the following preprocessor definition:
__inside_$(notdir $(basename $(@))). This creates a preprocessor definition like
__inside_myfilebased on the currently compiled .c file.
-include trcCTI.hin the GCC build flags. This will implicitly include trcCTI.h in every .c file. The purpose of trcCTI.h is to reroute the ThreadX API calls to the corresponding functions in trcCTI.c, that contain the event instrumentation.
Configure the project for snapshot or streaming as described below.
In snapshot tracing, the trace data is stored in a local RAM buffer on the target device, that later can be read from the host. The recorder can be configured to stop when the buffer is full or overwrite the start when the buffer is full.
Copy the files from the RingBuffer folder, located in the streamports folder, into your project. Make sure to include all .c files and the header files from the Config and Include folders.
For FreeRTOS make sure
TRC_CFG_RECORDER_MODEis set to
TRC_RECORDER_MODE_STREAMINGin trcKernelPortConfig.h. As of v4.6 this is the default mode, and (despite the name) it supports both streaming and snapshots.
For streamport-specific settings see trcStreamPortConfig.h
TRC_CFG_STREAM_PORT_BUFFER_SIZEdecides the size of the trace buffer that is stored in RAM.
TRC_CFG_STREAM_PORT_RINGBUFFER_MODEcan be set to
TRC_CFG_STREAM_PORT_RINGBUFFER_MODE_OVERWRITE_WHEN_FULLfor continuously recording or
TRC_CFG_STREAM_PORT_RINGBUFFER_MODE_STOP_WHEN_FULLfor stopping when the buffer is full.
Now the project should compile and write the data to the ring buffer, from which snapshots can be made when the target is halted.
Note that the “Snapshot Mode” mentioned in trcKernelPortConfig.h (
TRC_RECORDER_MODE_SNAPSHOT) refers to a legacy solution that limited to snapshot tracing only. This mode is deprecated and is no longer recommended for new projects.
The default and recommended setting is “Streaming Mode” which allows for both streaming and snapshot trace by selecting different stream ports. The RingBuffer stream port provides snapshot tracing support.
Reading a snapshot¶
There are a few ways to read a snapshot. More information is found in the Tracealyzer User Manual, but for convenience we provide two examples below - the Percepio plugins for Eclipse and MLAB X IDE. But basically you can use any method to save the contents of the RAM buffer to a .hex file or .bin file, and simply open the dump in Tracealyzer.
The Eclipse plugin can be found on Eclipse Marketplace. This plugin will work for most versions of Eclipse. After the plugin has been installed the Percepio option can be found in the toolbar. To save a snapshot, start a debugging session, halt the application and then select Percepio -> Save Snapshot.
The MPLAB x plugin can be downloaded here then it can be installed following these instructions. To save a snapshot first open the Tracealyzer plugin by going to Tools -> Embedded -> Tracealyzer Export Plugin. Then start a debugging session, halt it, and press the “Save Trace” button.
Streaming is a method where the trace data are offloaded from the target continuously, this means that a streaming trace can run for hours or even days depending on the setup. The different streaming methods included can be found in the stream ports folder. If there are no stream ports available that works with the target and/or application a custom stream port can be made, as long as an interface with high enough bandwidth is used.
Follow the below steps to integrate a stream port:
Copy the files from the selected stream port into the project.
For FreeRTOS make sure
TRC_CFG_RECORDER_MODEis set to
For stream port specific settings see trcStreamPortConfig.h
Now the project should compile and streaming can be started using the selected interface.