OpenOCD support

Last modified: 31 January 2025

OS: Windows (MinGW or MinGW-w64) / Linux / macOS

Required tools: OpenOCD, cross-compiler toolchain

Build targets: CMake / Makefile / custom build target

If your embedded target supports on-chip debug with OpenOCD (Open On-Chip Debugger), use the OpenOCD Download & Run configuration. It works for CMake-based projects, including the case of STM32CubeMX, as well as Makefile projects, and custom build targets.

note

You can also set up an OpenOCD server using an alternative approach to the one described in this article. The Debug Servers configuration option offers a more convenient way to configure various gdbservers and combine them with build targets.

Required tools

  1. OpenOCD

    OpenOCD will be used as a flash probe and remote gdbserver.

    In Settings | Build, Execution, Deployment | Embedded Development, you can check whether the OpenOCD location was detected correctly and set the path manually if needed.

  2. Toolchain

    Your cross-compiler toolchain should be configured in advance.

    • For ARM Cortex-M and Cortex-R MCUs, install GNU ARM toolchain. After the installation, make sure the toolchain is presented in the system PATH: run arm-none-eabi-gcc from the command line, and your system should recognize this command.

    • For all other platforms, install the platform-specific toolchain and set up the tools in Settings | Build, Execution, Deployment | Toolchain or in your CMake script (take a look at the template CMakeLists.txt).

    If you are working with an STM32CubeMX project, then installing the GNU ARM toolchain is a part of the project set up, and CubeMX generates the linker file automatically. Otherwise, obtain the linker script from your chip vendor or create it manually, and specify in CMake settings.

    Create an OpenOCD configuration

    1. Go to Run | Edit Configurations, click and select OpenOCD Download & Run from the list of templates.

      tip

      For STM32CubeMX projects, CLion adds a configuration of this type automatically during project creation.

    2. In the settings, you can select the client GDB debugger and board config file, adjust the GDB and Telnet ports, and set up Download/Reset options.

      OpenOCD run/debug configuration

    3. When setting up the board config file, you can provide the path manually or click Assist and choose from the standard options:

      board configs selection dialog

      To adjust the board config file to your needs (for example, when you are working with a non-standard device or need to keep several config files), click Copy to Project & Use: the selected file will be copied into your project tree, and you'll be able to open it in the editor and modify as required.

    Run/debug an OpenOCD configuration

    • When you Run this configuration, the compiled firmware is downloaded to the target board, and then the chip is reset.

    • When you Debug, the firmware is downloaded, the chip is reset, and then the remote debugger is attached to the MCU.

      Now your firmware running on-chip can be debugged using the entire set of CLion debug features, including Memory view and the Peripherals tab showing peripheral registers and bits.

      Also, notice the MCU reset button on the left-hand bar of the Debugger tool window. When pressed, it sends the chip reset command selected in the Reset option of the configuration settings.

      https://resources.jetbrains.com/help/img/idea/2024.3/cl_embed_debug_example.png
      Gif

    See also

    External Links