ThreadX with SystemView

This article describes how to use SystemView with Eclipse ThreadX RTOS.

Supported Software

SystemView has been tested with ThreadX V6.4.2.

Create a ThreadX project with Embedded Studio

1. Start Embedded Studio.
2. (optional) install CPU support Package for your device family via Tools->Package Manager.
3. Set up a project for your hardware.
   1. Create new project via File -> New Project..., select Create the project in a new solution.
   2. Select the project template for your device. For example "A C/C++ executable for NXP LPC4300." and enter a project Name.
   3. Click Next and follow through the dialog.
4. Test the created project.
   1. Connect your J-Link and the target hardware.
   2. Build the project with F7.
   3. Start a debug session with F5 and let it run.
   4. You should see the Hello World output in the Terminal window.
5. Get ThreadX.
   1. Open the project in file explorer with File -> Open Studio Folder... -> Project Folder.
   2. Create a new folder 'threadx' and add the ThreadX sources to it.
      • Use git to clone the threadx repository from https://github.com/SEGGERMicro/threadx
      • Or download the latest release and extract it. For example https://github.com/SEGGERMicro/threadx/releases/tag/v6.4.2_rel-segger
6. Add ThreadX to the Embedded Studio project.
   1. Create a new folder 'ThreadX' via right-click on the project -> New Folder....
   2. Create a new folder 'common' inside 'ThreadX' and set its Dynamic Folder Options.
      1. Set Source folder to '$(ProjectDir)/threadx/common'.
      2. Set Filter specification to '*.c;*.h'.
      3. Check 'Recurse into subdirectories'.
   3. Create a new folder 'ports' insode 'ThreadX' and set its Dynamic folder Options
      1. Set Source folder to the port of your target device. For example '$(ProjectDir)/threadx/ports/cortex_m4/gnu'.
      2. Set Filter specification to '*.s;*.S;*.c;*.h'.
      3. Set Exclude specification to '*example*'.
      4. Check 'Recurse into subdirectories'.
   4. Add include paths via righ-click on the project -> Options.
      1. Select 'Common' configuration (instead of 'Debug').
      2. Edit Code -> Preprocessor -> User Include Directories.
         1. Add '$(ProjectDir)/threadx/common/inc'.
         2. Add the include for your port. For example '$(ProjectDir)/threadx/ports/cortex_m4/gnu/inc'.
7. (optional) Add third-party libraries, HALs, drivers, etc. to your project.
8. Add your application code.
   1. Edit main.c to #include "tx_api.h" and replace main() with your code.
9. Build, develop, and debug your project with Embedded Studio.

Add SystemView to your Project

The SystemView instrumentation needs to be added to the ThreadX sources. It is recommended to use the prepared ThreadX sources from https://github.com/SEGGERMicro/threadx, either the segger/master branch, or a release tagged with "*-segger".

If you are using ThreadX from another source, make sure to apply the modifications for instrumentation.

1. Add the SystemView and RTT sources to the project
   1. Open the project in file explorer.
   2. Create a new folder 'SystemView' and add the SystemView sources to it.
      1. Use git to clone the latest version from https://github.com/SEGGERMicro/SystemView.
      2. or download the latest target sources from https://www.segger.com/downloads/systemview.
   3. Create a new folder 'RTT' and add the SEGGER_RTT sources to it.
      1. Use git to clone the latest version from https://github.com/SEGGERMicro/RTT.
      2. or use the sources from the latest SystemView target sources.
   4. Add the sources to your project.
      • SystemView/SYSVIEW/*.c
      • SystemView/SYSVIEW/Sample/ThreadX/SEGGER_SYSVIEW_ThreadX.c
      • RTT/RTT/*.c
      • RTT/RTT/*.s
      • The SystemView Target Configuration. For example SystemView/SYSVIEW/Sample/ThreadX/Cortex_M4/SEGGER_SYSVIEW_Config_ThreadX.c.
   5. Add the include directories to your project.
      • SystemView/Config
      • SystemView/SEGGER
      • SystemView/SYSVIEW
      • RTT/Config
      • RTT/RTT
2. Configure SystemView and RTT for your target if necessary.
   1. Adjust SEGGER_SYSVIEW_Config_ThreadX.c to match your system.
   2. Set configuration in SEGGER_SYSVIEW_Conf.h.
   3. Set configuration in SEGGER_RTT_Conf.h.
3. Enable ThreadX tracing with SystemView.
   1. Add preprocessor define ENABLE_TRACE_API=1.
   2. Add #include "SEGGER_SYSVIEW_ThreadX.h" at the end of tx_api.h.
   3. Call SEGGER_SYSVIEW_Conf(); in your main().