Tips and tricks

This chapter contains useful information to help you solve specific issues.

Create vcpkg configuration file

If your solution does not contain the vcpkg-configuration.json, right-click anywhere in the workspace and select Configure Arm Tools Environment. The Arm Tools Environment Manager extension then generates this file.

Set current solution in workspace

To activate a solution in the Solution outline view, use the Select Active Solution from workspace option in Views and More Actions Views and More Actions icon.

Documentation does not open

If you are using a Linux machine that uses the Snap package manager, your web browser will not be able to open documentation that is shipped in CMSIS-Packs as the CMSIS_PACK_ROOT directory is in ${HOME}/.cache/arm/packs which is not accessible to Snaps. Likewise, the Keil Studio help is located in ${HOME}/.vscode/extensions which is also not available.

To get this working, use a browser that is not installed as a Snap package:

  • Uninstall the Snap package. For example, run sudo snap remove firefox in a Terminal.

  • Download the installer from the browser's web site.

  • Install it on your machine.

Installing debug adapters

If you are using a third-party debug adapter, make sure that the latest drivers are installed on your machine

Make sure the debug adapters are running the latest firmware and that the PATH variable is set correctly.

Infineon KitProg3

Make sure that the latest firmware is installed.

Microchip PICKit Basic

Use the Python utility pycmsisdapswitcher to switch the firmware to a CMSIS-DAP v2 implementation.

Make sure that the latest firmware is installed.

For J-Link support, visit J-Link/J-Trace Downloads.

Set the PATH variable to the bin directory of the installation.

Verify the correct operation by entering the command jlink (Windows) or jlinkexe (Linux, macOS) in a Terminal. The output should similar to this:

SEGGER J-Link Commander V8.24 (Compiled Mar 26 2025 15:34:18)
DLL version V8.24, compiled Mar 26 2025 15:33:37

Connecting to J-Link via USB...FAILED: Cannot connect to J-Link.
J-Link>

For ST-LINK/V2 and ST-LINK/V2-1 support on Windows, download the USB driver here: STSW-LINK009.

Memory and Peripheral Inspector are missing

If your Debug view does not contain "PERIPHERALS" and you cannot open the Memory Inspector, check if the extensions are installed correctly. If you had previously uninstalled the Arm Debugger extension, these two extensions might have been removed with it. Just reinstall them via the Extensions view.

Create a library file

With Keil Studio, it is possible to create a library file. All you need to do is to change the output type in the *.cproject.yml file to lib:

# Control output files (elf is generated by default)
  output:
    type:
      - lib

In the CMSIS view CMSIS view, click Build icon. The Terminal output will look like this:

Execute: cbuild /Users/user/project/Arm/ArmCM3/Library/Library.csolution.yml --build --context-set --packs
+----------------------------------------------
(1/1) Cleaning context: "Library.Debug+Library"
+----------------------------------------------
(1/1) Building context: "Library.Debug+Library"
Using AC6 V6.24.0 compiler, from: '/Users/user/.vcpkg/artifacts/2139c4c6/compilers.arm.armclang/6.24.0/bin/'
Building CMake target 'Library.Debug+Library'
[1/2] Building C object CMakeFiles/Group_Source_Files.dir/Users/user/project/Arm/ArmCM3/Library/main.o
[2/2] Linking C static library /Users/user/project/Arm/ArmCM3/Library/out/Library/Library/Debug/Library.lib
+------------------------------------------------------------
Build summary: 1 succeeded, 0 failed - Time Elapsed: 00:00:02
+============================================================
Completed: cbuild succeed with exit code 0

The corresponding library file will be present in the /out-directory.

Note

This only works with CMSIS-Toolbox starting v2.11.0.

Downgrading tool versions

When you downgrade a tool version in the vcpkg-configuration,json file, this will only be taken into account if you toggle the tools activation.

Do the following:

  • Click on the Arm Tools entry in the status bar.
  • In the Manage Arm Tools dialog, select Deactivate Environment. The status bar will show that tools are deactivated: Arm Tools deactivated
  • Again, click on the Arm Tools entry in the status bar.
  • In the Manage Arm Tools dialog, select Reactivate Environment.

The new settings will now the taken into account and you can start working with the downgraded tool version.