Arm CMSIS Debugger

The Arm® CMSIS Debugger extension pack is a comprehensive debug platform for Arm Cortex-M processor-based devices that uses the GDB/MI protocol.

• Supports single and multi-core processor systems.
• Built-in RTOS kernel support for FreeRTOS, RTX, ThreadX, and Zephyr.
• Wide debug adapter support for CMSIS-DAP (ULink, MCULink, NuLink, etc.), JLink, and ST-Link.
• Can be combined with other VS Code debug extensions, such as those for Linux application debugging.

The Arm CMSIS Debugger includes pyOCD for target connection and Flash download, GNU GDB for core debug features, and adds these VS Code extensions:

• CDT™ GDB Debug Adapter Extension for starting applications (launch) or connecting to running systems (attach).
• Memory Inspector provides a powerful and configurable memory viewer.
• Peripheral Inspector provides a structured view to device peripheral registers during debugging.
• Serial Monitor to view output from and send messages to serial (UART) or TCP ports.

This extension is free to use and you can install it individually or as part of the Arm Keil® Studio pack. For optimum debugger experience use it with these extensions (included in Arm Keil Studio pack):

• Arm CMSIS Solution a user interface for csolution projects that simplifies the Run and Debug configuration.
• Arm Tools Environment Manager installs tools (compiler, simulation models, and utilities) for software development.

Debugger Configuration

VS Code uses the file .vscode/launch.json to configure target-specific debug parameters such as project files, device, and debug adapter. The Arm CMSIS Solution automatically generates this file based on the csolution project with all required settings, streamlining this setup. It provides both launch and attach configurations; for multi-processor system each core gets an attach configuration, while the start core also gets a launch configuration.

To start debugging, the CMSIS Solution offers action buttons and menu commands.

• Load & Debug application starts the CMSIS Debugger with launch configuration.
• Load & Run application starts program execution and the GDB server; use then attach configurations to connect to the running system.

Debugger User Interface

Many features of the CMSIS Debugger extension are exposed in the Run and Debug view of VS Code.

1. Start debugging selects a configuration: launch to start download/debug, attach to connect with a running system.
2. Debug Toolbar has buttons for the most common debugging actions that control execution.
3. Debug Statusbar shows the configuration along with the workspace name. A color change indicates an active debug session.

Most editor features are available during debugging. For example, developers can use Find and edit source code to correct program errors.

The Run and Debug view provides:

• VARIABLES section which include local function variables and CPU register values.
• WATCH section which allows to view user-defined expressions, for example variable values.
• CALL STACK section that shows active RTOS threads along with the call stack.
• BREAKPOINTS section for managing stop points in application execution to inspect the state.

TIP
Click on a line number badge to navigate to the source code line.

Other debugger specific views:

• Disassembly shows assembly instructions and supports run control, for example with stepping and breakpoints.
• Debug Console lists debug output messages and allows to enter an expressions or GDB commands.
• Peripherals show the device peripheral registers and allows to change their values.
• Serial Monitor uses serial or TCP communication to interact with application I/O functions (printf, getc, etc.).

Debug toolbar

During debugging, the Debug toolbar contains actions to control the flow of the debug session, such as stepping through code, pausing execution, and stopping the debug session.

Action	Description
Continue/Pause	Continue: Resume normal program execution (up to the next breakpoint). Pause: Inspect code executing at the current location.
Step Over	Execute the next statement as a single command without inspecting or following its component steps.
Step Into	Enter the next statement to follow its execution line-by-line.
Step Out	When inside a function, return to the earlier execution context by completing remaining lines of the current method as though it were a single command.
Restart	Terminate the current program execution and start debugging again using the current run configuration.
Stop/Disconnect	Stop: Terminate the current debug session. Disconnect: Detach debugger from a core without changing the execution status (running/pause).
Debug Session	For multi-core devices, the list of active debug sessions and switch between them.
Reset Target	Reset the target device.

VARIABLES

During a debugging, you can inspect variables, expressions, and registers in the VARIABLES section of the Run and Debug view or by hovering over a variable or expression in the source code editor. Variable values and expression are evaluated in context of the selected stack frame in the CALL STACK section. In case of multi-core, the content is relative to active debug session.

To change the value of a variable during the debugging session, right-click on the variable in the VARIABLES section and select Set Value.

You can use the Copy Value action to copy the variable's value, or the Copy as Expression action to copy an expression to access the variable. You can then use this expression in the WATCH section.

To filter variables by their name or value, use the Alt/Opt + Ctrl/Cmd + F keyboard shortcut while the focus is on the VARIABLES section, and type a search term.

WATCH

Variables and expressions can also be evaluated and watched in the WATCH section. You can use the Copy Value action to copy the variable's value, or the Copy as Expression action to copy an expression to access the variable. You can then use this expression in the WATCH section.

CALL STACK

The CALL STACK sections shows function call tree that is currently on stack. Threads are shown for applications that use an RTOS. Each function call is associated to its location and when source code is available a line number badge is shown. A click on this badge navigates to source file location.

The window content is updated whenever program execution stops.

BREAKPOINTS

A breakpoint pauses the code execution at a specific point, so you can inspect the state of your application at that point. There are several breakpoint types.

Setting breakpoints

To set or unset a breakpoint, click on the editor margin or use F9 on the current line.

• Breakpoints in the editor margin are normally shown as red filled circles.
• Disabled breakpoints have a filled gray circle.
• When a debugging session starts, breakpoints that can't be registered with the debugger change to a gray hollow circle. The same might happen if the source is edited while a debug session without live-edit support is running.

For more control of breakpoints, use the BREAKPOINTS section that lists and manages all breakpoints.

Breakpoint types

Conditional breakpoints

Set breakpoint conditions based on expressions, hit counts, or a combination of both.

• Expression condition: The breakpoint is hit whenever the expression evaluates to true.
• Hit count: The hit count controls how many times a breakpoint needs to be hit before it interrupts execution.
• Wait for breakpoint: The breakpoint is activated when another breakpoint is hit (triggered breakpoint).

To add a conditional breakpoint:

• Create a conditional breakpoint

  • Right-click in the editor margin and select Add Conditional Breakpoint.
  • Use the Add Conditional Breakpoint command in the Command Palette (⇧⌘P).

• Choose the type of condition you want to set (expression, hit count, or wait for breakpoint).

To add a condition to an existing breakpoint:

• Edit an existing breakpoint

  • Right-click on the breakpoint in the editor margin and select Edit Breakpoint.
  • Select the pencil icon next for an existing breakpoint in the BREAKPOINTS section of the Run and Debug view.

• Edit the condition (expression, hit count, or wait for breakpoint).

Triggered breakpoints

A triggered breakpoint is type of conditional breakpoint that is enabled once another breakpoint is hit. They can be useful when diagnosing failure cases in code that happen only after a certain precondition.

Triggered breakpoints can be set by right-clicking on the glyph margin, selecting Add Triggered Breakpoint, and then choosing which other breakpoint enables the breakpoint.

Inline breakpoints

Inline breakpoints are only hit when the execution reaches the column associated with the inline breakpoint. This is useful when debugging minified code, which contains multiple statements in a single line.

An inline breakpoint can be set using Shift + F9 or through the context menu during a debug session. Inline breakpoints are shown inline in the editor.

Inline breakpoints can also have conditions. Editing multiple breakpoints on a line is possible through the context menu in the editor's left margin.

Function breakpoints

Instead of placing breakpoints directly in source code, a debugger can support creating breakpoints by specifying a function name. This is useful in situations where source is not available but a function name is known.

To create a function breakpoint, select the + button in the BREAKPOINTS section header and enter the function name. Function breakpoints are shown with a red triangle in the BREAKPOINTS section.

Data breakpoints

If a debugger supports data breakpoints, they can be set from the context menu in the VARIABLES section. The Break on Value Change/Read/Access commands add a data breakpoint that is hit when the value of the underlying variable changes/is read/is accessed. Data breakpoints are shown with a red hexagon in the BREAKPOINTS section.

Logpoints

A logpoint is a variant of a breakpoint that does not interrupt into the debugger, but instead logs a message to the debug console. Logpoints can help you save time by not having to add or remove logging statements in your code.

A logpoint is represented by a diamond-shaped icon. Log messages are plain text but can also include expressions to be evaluated within curly braces ('{}').

To add a logpoint, right-click in the editor left margin and select Add Logpoint, or use the Debug: Add Logpoint... command in the Command Palette (Ctrl/Cmd + Shift + p).

Just like regular breakpoints, logpoints can be enabled or disabled and can also be controlled by a condition and/or hit count.

Peripherals

The Peripherals view shows the device peripheral registers and allows to change their values. It uses the CMSIS-SVD files that are provided by silicon vendors and distributed as part of the CMSIS Device Family Packs (DFP).

For more information, refer to the Peripheral Inspector GitHub repository.

Memory Inspector

The Memory Inspector provides a powerful and configurable memory viewer that features:

• Configurable Memory Display: Shows memory data with various display options.
• Address Navigation: Easily jump to and scroll through memory addresses.
• Variable Highlights: Colors memory ranges for variables.
• Multiple Memory Formats: Shows memory data on hover in multiple formats.
• Edit Memory: Allows in-place memory editing, if the debug adapter supports the WriteMemoryRequest.
• Memory Management: Enables saving and restoring memory data for specific address ranges (Intel Hex format).
• Customized Views: Create and customize as many memory views as you need.
• Lock Views: Keep views static, unaffected by updates from the debug session.
• Periodic Refresh: Automatically refresh the memory data.
• Multiple Debug Sessions: Switch between multiple debug sessions using a dropdown in the memory view.

For more information, refer to the Memory Inspector GitHub repository.

Disassembly

The command Open Disassembly View (available from command palette or context menus) shows the assembler instructions of the program intermixed with the source code. Using this view allows single stepping or managing breakpoints at the CPU instruction level.

Debug Console

The Debug Console enables viewing and interacting with the output of your code running in the debugger. Expressions can be evaluated with the Debug Console REPL (Read-Eval-Print Loop) feature.

With the CMSIS Debug extension, you can use the Debug Console REPL to enter GDB commands while debugging. Before entering a GDB command, you have to explicitly enter a "greater-than"-character > so that the following strings can be evaluated as a GDB command.

Debug Console input uses the mode of the active editor, which means that it supports syntax coloring, indentation, auto closing of quotes, and other language features.

Example

The following example shows how to check the currently set breakpoints with the > info break command. Afterwards, the application is run with the > continue command.

Serial Monitor

The Serial Monitor allows users to configure, monitor, and communicate with serial or TCP ports.

Extension Functionality

This extension adds functionality to work seamlessly with other extensions.

• A debug configuration provider for the type gdbtarget which comes with the CDT GDB Debug Adapter Extension. This provider manages the use of tools shipped with the extension:
  • If option target>server is set to pyocd, then it expands to the absolute path of the built-in pyOCD distribution.
• CMSIS specific launch configuration items for the * debugger type, i.e. visible for all debugger types. It depends on the actually used debug adapter type if this information is known and utilized.

📝 Note:
The built-in version of pyOCD supports the command line option --cbuild-run which isn't available in releases outside this extension.

Known Limitations and Workarounds

pyOCD fails to load *.cbuild-run.yml in the default configuration

When I use the default debug configuration for pyOCD, I get errors that pyOCD cannot find the solutions *.cbuild-run.yml file.

Possible Reasons:

1. The application's CMSIS solution was initially built with a CMSIS-Toolbox version prior to v2.8.0 which is the first version to generate *.cbuild-run.yml files.
2. You are using an Arm CMSIS Solution extension prior to v1.52.0 which is the first version to fully support the ${command:cmsis-csolution.getCbuildRunFile} command.

Workarounds/Solutions:

1. Update the CMSIS-Toolbox to the latest version. Additionally, you may have to run cbuild setup --update-rte in a terminal for a first-time generation of *.cbuild-run.yml file in an existing workspace.
2. Update to Arm CMSIS Solution extension v1.52.0. Alternatively, replace ${command:cmsis-csolution.getCbuildRunFile} with the path to the *.cbuild-run.yml in your workspace (cmsis>cbuildRunFile debug configuration setting).

AXF files built with Arm Compiler 6 toolchain

When I download an AXF file built with Arm Compiler 6, I see the following warning and my application does not execute correctly. This happens regardless of the selected GDB server.

warning: Loadable section "RW_RAM0" outside of ELF segments
  in /path/to/my/application.axf

Possible Reason: arm-none-eabi-gdb does not correctly load ELF program segments due to the way that Arm Compiler 6 generates section and program header information when scatterloading is used.

Workaround: You can generate a HEX file for the program download, and the ELF file for debug purposes only. The following steps are required if you build a CSolution-based application with the CMSIS-Toolbox:

1. Edit the *.cproject.yml file(s) of your application.
2. Modify the output:type: node to generate both an elf and a hex file:

  output:
    type:
      - elf
      - hex  

1. Build the solution.
2. Keep the default configuration's program setting as is.

"program": "${command:cmsis-csolution.getBinaryFile}",

1. Modify the default debug configuration's initCommands list, so that the load command gets the relative path to the generated HEX file.

"initCommands": [
    "load ./relative/path/to/my/application.hex",
    "break main"
],

This instructs the debugger to load the debug information from the ELF file and to use the HEX file for program download.

arm-none-eabi-gdb requires DWARF5 debug information

arm-none-eabi-gdb generates the following warnings when I debug ELF files with DWARF debug information of standard version 4 and earlier. And the debug illusion seems to be broken in many places.

warning: (Internal error: pc 0x8006a18 in read in CU, but not in symtab.)

Possible Reason: arm-none-eabi-gdb works best with DWARF debug information of standard version 5.

Solution: Make sure to build your application ELF file with DWARF version 5 debug information. Please refer to your toolchain's user reference manual. This may require updates to all build tools like compiler and assembler. For example use -gdwarf-5 for armclang.

Broken debug illusion

When debugging ELF files with DWARF debug information of standard version 4 and earlier, arm-none-eabi-gdb generates the following warnings:

warning: (Internal error: pc 0x8006a18 in read in CU, but not in symtab.)

The debug illusion will be broken in many places.

Possible Reason: Missing DWARF5 debug information

arm-none-eabi-gdb works best with DWARF debug information of standard version 5.

Solution: Build the ELF file using DWARF5

Make sure to build your application ELF file with DWARF version 5 debug information.

pyOCD port not available

When starting a debug session, you might see this error:

Possible reason: A running instance of pyOCD

This error might occur if a previous debug session has ended prematuerly and pyOCD has not exited. The orphaned instance will still keep the port open (usually 3333) and thus you won't be able to open the port again in the new session.

Solution: Check open files and kill pyOCD

On Linux and macOS you can check the running open files using the lsof command:

sudo lsof -i -n -P | grep 3333

Python    41836       user01    3u  IPv4 0xa6ef66ad5be49a4f      0t0    TCP *:3333 (LISTEN)
pyocd     41842       user01    8u  IPv4 0x9d09900145f3ca41

To kill the running pyOCD process, use:

sudo killall pyocd

On Windows systems, use the Windows Task Manager or the Process Explorer to find orphaned processes.

Related projects

Related open source projects are:

• Open-CMSIS-Pack of which this extension is part of.
• Eclipse® CDT.cloud™, an open-source project that hosts a number of components and best practices for building customizable web-based C/C++ tools.
• pyOCD, a Python based tool and API for debugging, programming, and exploring Arm Cortex® microcontrollers.
• GDB, the debugger of the GNU Project.

Trademarks

• Arm and Cortex are registered trademarks of Arm Limited (or its subsidiaries or affiliates) in the US and/or elsewhere.
• Windows, Visual Studio Code, VS Code, and the Visual Studio Code icon are trademarks of Microsoft Corporation.
• Mac and macOS are trademarks of Apple Inc., registered in the U.S. and other countries and regions.
• Eclipse, CDT, and CDT.cloud are trademarks of Eclipse Foundation, Inc.
• SEGGER and J-LINK are registered trademarks of SEGGER Microcontroller GmbH.
• Node.js is a registered trademark of the OpenJS Foundation.
• GDB and GCC are part of the GNU Project and are maintained by the Free Software Foundation.

---

Debug Setup

The debug setup requires a GDB installation supporting the GDB remote protocol and that can connect to a GDB server like pyOCD.

We recommend to install the Arm GNU Toolchain using the Arm Tools Environment Manager extension. It comes with arm-none-eabi-gdb which is used in the Arm CMSIS Debugger default debug configurations.

pyOCD Debug Setup

This extension includes a pyOCD distribution which is used by default.

If you wish to use a different pyOCD installation, enter the full path to the executable (including the file name) in the target>server setting.

SEGGER® J-LINK® Debug Setup

Install the latest J-LINK Software and Documentation Pack from SEGGER. Ensure all required drivers and host platform specific settings are done.

The extension expects the installation folder to be on your system PATH environment variable. Alternatively, update your debug configuration's target>server setting to contain the full path to the J-LINK GDB server executable (including the file name).

Start Debugging

There are two ways to start a debug session:

1. If you have installed the CMSIS Solution extension, in the CMSIS view , click on the Debug icon . The configuration for the debugger configured in the active target-set is written to the launch.json file and will be used to start the debug session.

2. In the Run and debug view , click the Play icon next to the selected debug connection . The debug starts with the selected configuration.

The debugger loads the application program and executes the startup code. When program execution stops (by default at main), the source code opens at the next executable statement which is marked with a yellow arrow in the editor:

Most editor features are available in debug mode. For example, developers can use the Find command and can correct program errors.

Flash and Run

If you do not wish to enter a debug session, you can issue a flash download only, followed by a reset of the device.

In the CMSIS view , click on the Run icon .

Run and Debug view

📝 Note:
The following is using information from Debug code with Visual Studio Code, Eclipse CDT Cloud - Memory Inspector, Eclipse CDT Cloud - Peripherals Inspector.