TraceRecorder demo added in CORTEX_MPS2_QEMU_IAR_GCC (FreeRTOS#1320)

* * Added TraceRecorder demo for Percepio View in CORTEX_MPS2_QEMU_IAR_GCC (only gcc supported at the moment)

* * Added TraceRecorder demo instructions in readme.md.

* * Updated FreeRTOS-Plus-Trace pointer

* * Using FreeRTOS-Plus-Trace submodule (TraceRecorder) instead of a static TraceRecorder copy.

Author: johankraft

.github/workflows/freertos_demos.yml

@@ -459,7 +459,7 @@ jobs:
           # ${{ env.stepName }}
           echo -e "::group::${{ env.stepName }}"
           set +e
-          git submodule update --checkout --init --depth 1 FreeRTOS/Source FreeRTOS/Demo/ThirdParty/Community-Supported-Demos
+          git submodule update --checkout --init --depth 1 FreeRTOS/Source FreeRTOS/Demo/ThirdParty/Community-Supported-Demos FreeRTOS-Plus/Source/FreeRTOS-Plus-Trace
           exitStatus=$?
           set -e
           echo -e "::endgroup::"

FreeRTOS-Plus/Source/FreeRTOS-Plus-Trace

@@ -39,7 +39,6 @@
 * See http://www.freertos.org/a00110.html
 *----------------------------------------------------------*/
 
-#define configUSE_TRACE_FACILITY                 0
 #define configGENERATE_RUN_TIME_STATS            0
 
 #define configUSE_PREEMPTION                     1
@@ -50,7 +49,10 @@
 #define configMINIMAL_STACK_SIZE                 ( ( unsigned short ) 80 )
 #define configTOTAL_HEAP_SIZE                    ( ( size_t ) ( 60 * 1024 ) )
 #define configMAX_TASK_NAME_LEN                  ( 12 )
-#define configUSE_TRACE_FACILITY                 0
+
+/* TODO TraceRecorder (Step 4): Enable configUSE_TRACE_FACILITY in FreeRTOSConfig.h. */
+#define configUSE_TRACE_FACILITY                 1
+
 #define configUSE_16_BIT_TICKS                   0
 #define configIDLE_SHOULD_YIELD                  0
 #define configUSE_CO_ROUTINES                    0
@@ -133,4 +135,7 @@
 
 #define configENABLE_BACKWARD_COMPATIBILITY 0
 
+/* TODO TraceRecorder (Step 5): Include trcRecorder.h at the end of FreeRTOSConfig.h. */
+#include "trcRecorder.h"
+
 #endif /* FREERTOS_CONFIG_H */

FreeRTOS/Demo/CORTEX_MPS2_QEMU_IAR_GCC/FreeRTOSConfig.h

@@ -11,3 +11,31 @@
 2. Open ```.vscode/launch.json```, and ensure the ```miDebuggerPath``` variable is set to the path where arm-none-eabi-gdb is on your machine.
 3. Open ```main.c```, and set ```mainCREATE_SIMPLE_BLINKY_DEMO_ONLY``` to ```1``` to generate just the [simply blinky demo](https://www.freertos.org/a00102.html#simple_blinky_demo).
 4. On the VSCode left side panel, select the “Run and Debug” button. Then select “Launch QEMU RTOSDemo” from the dropdown on the top right and press the play button. This will build, run, and attach a debugger to the demo program.
+
+## Tracing with Percepio View
+This demo project includes Percepio TraceRecorder, configured for snapshot tracing with Percepio View or Tracealyzer.
+Percepio View is a free tracing tool from Percepio, providing the core features of Percepio Tracealyzer but limited to snapshot tracing.
+No license or registration is required. More information and download is found at [Percepio's product page for Percepio View](https://traceviewer.io/freertos-view).
+
+### TraceRecorder Integration
+If you like to study how TraceRecorder is integrated, the steps for adding TraceRecorder are tagged with "TODO TraceRecorder" comments in the demo source code.
+This way, if using an Eclipse-based IDE, you can find a summary in the Tasks window by selecting Window -> Show View -> Tasks (or Other, if not listed).
+See also [the official getting-started guide](https://traceviewer.io/getting-started-freertos-view).
+
+### Usage with GCC
+To save the TraceRecorder trace, start a debug session with GDB, for example using the provided Eclipse launch profile (should work in most Eclipse-based IDEs).
+Halt the execution and the run the command below. 
+This saves the trace as trace.bin in the build/gcc folder.
+Open the trace file in Percepio View or Tracealyzer.
+
+```
+dump binary value trace.bin *RecorderDataPtr
+```
+Note that you can copy/paste this command into the Eclipse Debugger Console by using Ctrl-C, Ctrl-V.
+
+### Usage with IAR Embedded Workbench for Arm
+The IAR project is not yet updated for TraceRecorder (work in progress). However, you can easily extend the existing IAR project with TraceRecorder.
+Simply add the source files and include paths for TraceRecorder listed in build/gcc/Makefile. Build and run.
+To save the trace, please refer to the guides at [https://percepio.com/iar](https://percepio.com/iar).
+
+