Starting 2.3.0 debugger with J-Link fails: "unable to find CMSIS-DAP device"

HarrySatt · February 11, 2024, 10:43am

After update to ARDUINO 2.3 the problem is here again. I can not debug the MKR 1310 anymore.
I set up the SEGGER JLink so it is able to connect to the target but it seems that some of the settings are not correct. ARDUINO is not able to connect the OPENocd anymore.
I am not sure what the message in the gbd-server window is telling me.
Licensed under GNU GPL v2
For bug reports, read
OpenOCD: Bug Reporting
CDRTOSConfigure
Info : auto-selecting first available session transport "swd". To override use 'transport select '.
none separate
adapter speed: 400 kHz
cortex_m reset_config sysresetreq
Info : Listening on port 50003 for tcl connections
Info : Listening on port 50004 for telnet connections
Error: unable to find CMSIS-DAP device

[2024-02-11T10:33:54.563Z] SERVER CONSOLE DEBUG: onBackendConnect: gdb-server session closed
GDB server session ended. This terminal will be reused, waiting for next session to start...
The .LOG of the SEGGER JLINK is not telling me anything because if I clear the information I got from manually starting the SEGGER JLINK GDB server log and start the ARDUINO debug session nothing is writen to the .LOG of JLINK.
Thanks for help

HarrySatt · February 17, 2024, 12:15pm

If I click the arrow in the debug tab a internal debug preset is shown. There I see different entries which do not correspond to the JLink settings I would need to use but changing is not possible because starting the debug session removes the changes because this file seems to be reloaded from .AppData.
Is there a way to change this presets?
Regards, Harald

HarrySatt · February 17, 2024, 3:24pm

Hi there. After updating the IDE to 2.3.1 I am not able to debug the MKR 1310 anymore. I have an EDU JLink probe connected and installed the sever software. If I start the JLink server UI I am able to connect to the MKR and the UI tells me it is waiting for a connection.
If I stop the sever UI and try to connect as described in the Debugging MKR I get the message that OPENOCD is not able to start. Sure. JLink server CL should be started which is described in custom_debug.JSON but it does not.
So I tried using the arrow left of the conf in the debug tab. A new .JSON is opened and there I see what I would need to change but my changes are not accepted. Might be some default config.
Anyone out there with a solution, hint or workaround?
Thanks, Harald

HarrySatt · September 10, 2023, 7:58am

Hi there.
Is there any information about the port the IDE 2 client is communicating with the GBD server. it seems wheter the GBD server is launched nor the client is communicating with the server.
Any help to get MKR1310 to debug with JLINK EDU probe with IDE 2
As I figured out the tutorial is not correct in this case. Or am I wrong.
There is an launch.json automatically generated but this one is for openocd. I can not change the entries because this one is read only.
How can I point to JLinkGDBServerCL?
This would make it also possible to set the parameters for this one correct.
I can start JLinkGDBServer GUI so that it is waiting for connection and also the command line tool with the correct parameters so it connect to MKR and listen for connection to the debugger client.
Thanks for help.
regards, Harald

HarrySatt · February 24, 2024, 4:14pm

Same behaviour with IDE 2.3.1 Previous Version also was problematic but Support tells me a workaround
Now this again is not working.
I did the setup according to Debugging help file. But the Server is not started if I start Debugging with the BugButton. If I start the JLINK GUI I can setup correct. The Server is started and waiting for connection.
If I click the arrow close to the Configuration an extra .JSON pops up with settings. But this file is not allowed to be altered.
Can I change the position where IDE fetches the files used

ptillisch · March 3, 2024, 7:12am

Hi @HarrySatt. A significant rework of the debugger configuration system was released in Arduino IDE 2.3.0. This was necessary because as more and more Arduino boards platforms started taking advantage of the debugger feature, some advanced requirements emerged that were not properly accommodated by the original the initial experimental system.

The new system is more powerful and flexible, so this change will greatly benefit the platform developers and users in the years to come, but unfortunately it does require that those who are using a J-Link debug probe (or any other configuration that requires the use of the IDE's debug_custom.json feature) must make some adjustments to their workflow.

Instructions

Open the sketch you want to debug in Arduino IDE.
Select the "debug_custom.json" editor tab.
Add this line at the top of the file:
```
[
```
Add this line at the top of the file:
```
]
```

Add the following lines in the middle of the file

"configId": "arduino:samd:mkrwan1310:programmer=jlink",
"server": "jlink",
"serverPath": "<JLinkGDBServer path>",

Replace <JLinkGDBServer path> with the path to the J-Link GDB server tool, which you will find in the value of the existing serverpath key (note the lowercase p in path).
You should now have something like this:

[
  {
    "servertype": "jlink",
    "device": "ATSAMD21G18",
    "configId": "arduino:samd:mkrwan1310:programmer=jlink",
    "server": "jlink",
    "serverPath": "C:/Program Files/JLink/JLinkGDBServerCL",
    "interface": "swd",
    "serverpath": "C:/Program Files/JLink/JLinkGDBServerCL"
  }
]

Select File > Save from the Arduino IDE menus.
Select Tools > Board > Arduino SAMD Boards (32-bits ARM Cortex-M0+) > Arduino MKR WAN 1310 from the Arduino IDE menus.
Select Tools > Programmer > Segger J-Link from the Arduino IDE menus.
Select Sketch > Optimize for Debugging from the Arduino IDE menus (if it is not already enabled).
Select Sketch > Verify/Compile from the Arduino IDE menus.
Wait for the compilation to finish successfully.
Connect your J-Link and MKR WAN 1310 to your computer as usual.
Click the "Start Debugging" button on the Arduino IDE toolbar.

The debugger should now start up and work as expected.

Please let me know if you have any questions or problems while following those instructions.

Explanation

The instructions above will allow you to get back to using the debugger in this specific application of a J-Link debug probe and a MKR WAN 1310 board, but you (or others who have similar questions and find this thread during their researches) might be interested in understanding why these changes were necessary and how you might make equivalent migrations for other configurations. I'll provide relevant information below. If you aren't interested in "the boring details", you can feel free to skip the rest of this reply.

There are two separate factors you should be aware of:

Breaking change to `debug_custom.json` format

Previously, the data structure of the file was an object. For example:

{
  "servertype": "jlink",
  "device": "ATSAMD21G18",
  "interface": "SWD",
  "serverpath": "C:/Program Files/SEGGER/JLink/JLinkGDBServerCL"
}

It is now an array of objects. For example:

[
  {
    "servertype": "jlink",
    "device": "ATSAMD21G18",
    "interface": "SWD",
    "serverpath": "C:/Program Files/SEGGER/JLink/JLinkGDBServerCL"
  }
]

The benefit of this new structure is that it allows you to define multiple custom debugger configurations. For this reason, it is necessary to provide an identifier for each configuration so that Arduino IDE will know which one is appropriate to apply. This is done via the configId key. The value has the following format:

<board FQBN>:programmer=<programmer ID>

For example:

[
  {
    "configId": "arduino:samd:mkrwan1310:programmer=jlink",
    "servertype": "jlink",
    "device": "ATSAMD21G18",
    "interface": "SWD",
    "serverpath": "C:/Program Files/SEGGER/JLink/JLinkGDBServerCL"
  }
]

It might seem too confusing to figure out the FQBN and programmer ID, but you can get Arduino IDE to generate it for you:

Select the board you are using from the Arduino IDE menus.
Select the debug probe you are using from the Tools > Programmer menu in Arduino IDE.
ⓘ If there is no Tools > Programmer menu, you can skip this step.
Select Sketch > Verify/Compile from the Arduino IDE menus.
Wait for the compilation to finish successfully.
Click the "Start Debugging" button on the Arduino IDE toolbar.
Wait for the process to fail, as indicated by the appearance of an error notification at the bottom right corner of the Arduino IDE menu.
ⓘ The failure is expected since we haven't yet added the configId key to the debug_custom.json file. The purpose of clicking the "Start Debugging" button is only to cause Arduino IDE to generate the configId value, which is accomplished even when the debugger doesn't successfully start.
Click the debugger icon on the activity bar on the left side of the Arduino IDE window.
The "DEBUG" view will open in the left side panel.
Click the gear icon ('Open "launch.json"') on the debugger toolbar.
A "launch.json" tab will open in the editor.
Find the appropriate configurations[*].configId key in launch.json and copy the value.
For example, if the file contains this content:
```
{
  "version": "0.2.0",
  "configurations": [
    {
      "configId": "arduino:samd:mkrwan1310:programmer=jlink",
```
Then copy the "configId": "arduino:samd:mkrwan1310:programmer=jlink",.
Select the "debug_custom.json" editor tab.
Paste the copied configId key into the file.
Select File > Save from the Arduino IDE menus.

Bug when overriding certain configuration keys

In addition to the intentionally introduced breaking change I described above, unfortunately a bug was also accidentally introduced that impacts users of the debug_custom.json feature:

github.com/arduino/vscode-arduino-tools

Not possible to override debug configuration keys that are remapped from Arduino CLI

opened 05:59AM - 03 Mar 24 UTC

per1234

topic: code type: imperfection

### Describe the problem This extension automatically generates a `launch.jso…n` file to configure the [**Cortex-Debug** VS Code extension](https://github.com/Marus/cortex-debug) for use with the selected board and "programmer" (debug probe). The base configuration data comes from the [`arduino-cli debug --info`](https://arduino.github.io/arduino-cli/dev/commands/arduino-cli_debug/) output. Some of that data does not match exactly with the `launch.json` format so the extension remaps it. In some cases ([example](https://docs.arduino.cc/tutorials/mkr-wifi-1010/mkr-jlink-setup/#debugging-in-arduino-ide-2)), the user might need/want to make some adjustments to the generated configuration. This is done by adding the custom configuration data to a file named `debug_custom.json` in the sketch root folder. The configuration from that file is merged into the base data when generating `launch.json`, overriding the base data where there is overlap. 🐛 Overrides no longer work for the configuration keys that are remapped from the Arduino CLI data: - `armToolchainPath` - `configFiles` - `serverpath` - `servertype` ### To reproduce --- **ⓘ** Hardware is not required to perform this demo. --- 1. If you don't already have it installed, use the Arduino IDE Boards Manager to install the "**Arduino SAMD Boards (32-bits ARM Cortex-M0+)**" platform. **ⓘ** This platform was selected arbitrarily as one that has debugger support. The fault is not platform-specific. 1. Select **File > New** from the Arduino IDE menus. 1. Select **Tools > Board > Arduino SAMD Boards (32-bits ARM Cortex-M0+) > Arduino Zero (Programming Port)** from the Arduino IDE menus. 1. Select **Tools > Programmer > Atmel EDBG** from the Arduino IDE menus. 1. Click the **●●●** icon on the right side of the editor toolbar. A menu will open. 1. Select "**New Tab**" from the menu. The "**Name for new file**" dialog will open. 1. Type `debug_custom.json` in the field in the dialog. 1. Click the "**OK**" button. The dialog will close and a "**debug_custom.json**" tab will be added to the editor view. 1. Use the editor to add the following content to the "**debug_custom.json**" tab: ```json [ { "configId": "arduino:samd:arduino_zero_edbg:programmer=edbg", "toolchainPrefix": "custom-toolchain-prefix", "armToolchainPath": "/path/to/custom-arm-toolchain", "configFiles": ["/path/to/custom-custom-config-file"], "serverpath": "/path/to/custom-server", "servertype": "jlink" } ] ``` 1. Select **Sketch > Verify/Compile** from the Arduino IDE menus. 1. Wait for the compilation to finish successfully. 1. Click the "**Start Debugging**" button on the Arduino IDE toolbar. 1. Wait for the process to fail. **ⓘ** The failure is expected unless you happen to have the necessary hardware connected to your computer. It is not relevant to the demo. 1. Click the "Toggle Debug View" icon on the activity bar. The debug view will open in the left side panel. 1. Click the gear icon ('Open "launch.json"') on the debugger toolbar. A "**launch.json**" tab will open in the editor. 🙂 The `configurations[0].toolchainPrefix` value was set according to `debug_custom.json` as expected: ```json "toolchainPrefix": "custom-toolchain-prefix" ``` 🐛 The `configurations[0].armToolchainPath`, `configurations[0].configFiles`, `configurations[0].serverpath`, and `configurations[0].servertype` values were not set according to `debug_custom.json`: ```json "armToolchainPath": "C:\\Users\\per\\AppData\\Local\\Arduino15\\packages\\arduino\\tools\\arm-none-eabi-gcc\\7-2017q4/bin/", "configFiles": [ "C:\\Users\\per\\AppData\\Local\\Arduino15\\packages\\arduino\\hardware\\samd\\1.8.14/variants/arduino_zero/openocd_scripts/arduino_zero.cfg" ], "serverpath": "C:\\Users\\per\\AppData\\Local\\Arduino15\\packages\\arduino\\tools\\openocd\\0.10.0-arduino7/bin/openocd", "servertype": "openocd" ``` ### Expected behavior Any debug configuration key can be overridden via `debug_custom.json`. ### vscode-arduino-tools version 0.1.3 ### Additional context The regression was introduced at https://github.com/arduino/vscode-arduino-tools/commit/9508d0a8500ae578f581768ecde40804d286ea62 / https://github.com/arduino/vscode-arduino-tools/pull/41 <a name="workaround"></a> #### Workaround Use the pre-remapping key names in `debug_custom.json`: - `armToolchainPath` -> `toolchainPath` - `configFiles` -> `serverConfiguration.scripts` - `serverpath` -> `serverPath` - `servertype` -> `server`

I have already submitted a fix for the bug, but it will be some time before that is available as part of an Arduino IDE build. Fortunately it is possible to workaround the bug by using different key names in your debug_custom.json file:

Original key	Workaround key
`armToolchainPath`	`toolchainPath`
`configFiles`	`serverConfiguration.scripts`
`serverpath`	`serverPath`
`servertype`	`server`

The workaround will stop working once the bug is fixed, so you should also leave the correct keys in your debug_custom.json file so that it will continue working even after you update Arduino IDE to a new version that has the fix.

HarrySatt · March 3, 2024, 3:27pm

Hi @ptillisch

Thank for fast response

I now changed the debug_custom.json to

[
  {
    "servertype": "jlink",
    "device": "ATSAMD21G18",
    "configId": "arduino:samd:mkrwan1310:programmer=jlink",
    "server": "jlink",
    "serverpath": "C:/Program Files/SEGGER/JLink_V794g/JLinkGDBServerCL.exe",
    "interface": "swd",
    "serverpath": "C:/Program Files/SEGGER/JLink_V794g/JLinkGDBServerCL.exe"
  }
]

The server path is pointing to the last update of JLink GBDB server and if I use it I see the CL server statement is working. Without parameters it fails. OK, that like it is.
The configId I checked as described. It is correct.
But if I start the debugging session I get the following result in "gbd-server" tab:

[2024-03-03T15:07:26.266Z] SERVER CONSOLE DEBUG: onBackendConnect: gdb-server session connected. You can switch to "DEBUG CONSOLE" to see GDB interactions. "C:\\Users\\haral\\AppData\\Local\\Arduino15\\packages\\arduino\\tools\\openocd\\0.10.0-arduino7/bin/openocd" -singlerun -nogui -if swd -port 50000 -swoport 50001 -telnetport 50002 -device ATSAMD21G18 Open On-Chip Debugger 0.10.0+dev-gf0767a31 (2018-06-11-13:36) Licensed under GNU GPL v2 For bug reports, read [http://openocd.org/doc/doxygen/bugs.html](http://openocd.org/doc/doxygen/bugs.html) C:\Users\haral\AppData\Local\Arduino15\packages\arduino\tools\openocd\0.10.0-arduino7/bin/openocd: unknown option -- n [2024-03-03T15:07:26.333Z] SERVER CONSOLE DEBUG: onBackendConnect: gdb-server session closed GDB server session ended. This terminal will be reused, waiting for next session to start...

and in the "Debug Console" tab I receive:

Cortex-Debug: VSCode debugger extension version 1.5.1 git(be7d3c8+dirty). Usaage info: [https://github.com/Marus/cortex-debug#usage](https://github.com/Marus/cortex-debug#usage)

Reading symbols from C:\Users\haral\AppData\Local\Arduino15\packages\arduino\tools\arm-none-eabi-gcc\7-2017q4\bin\arm-none-eabi-objdump.exe --syms -C -h -w C:/Users\haral\AppData\Local\Temp\arduino\sketches\4121EFF1B69A8E40675BE333D4C5723A\Blink.ino.elf

Reading symbols from c:/users\haral\appdata\local\arduino15\packages\arduino\tools\arm-none-eabi-gcc\7-2017q4\bin\arm-none-eabi-nm.exe --defined-only -S -l -C -p C:/Users\haral\AppData\Local\Temp\arduino\sketches\4121EFF1B69A8E40675BE333D4C5723A\Blink.ino.elf

Launching GDB: "C:\\Users\\haral\\AppData\\Local\\Arduino15\\packages\\arduino\\tools\\arm-none-eabi-gcc\\7-2017q4\\bin\\arm-none-eabi-gdb.exe" -q --interpreter=mi2 "C:/Users\\haral\\AppData\\Local\\Temp\\arduino\\sketches\\4121EFF1B69A8E40675BE333D4C5723A\\Blink.ino.elf"

IMPORTANT: Set "showDevDebugOutput": "raw" in "launch.json" to see verbose GDB transactions here. Very helpful to debug issues or report problems

Launching gdb-server: "C:\\Users\\haral\\AppData\\Local\\Arduino15\\packages\\arduino\\tools\\openocd\\0.10.0-arduino7/bin/openocd" -singlerun -nogui -if swd -port 50000 -swoport 50001 -telnetport 50002 -device ATSAMD21G18

Please check TERMINAL tab (gdb-server) for output from C:\Users\haral\AppData\Local\Arduino15\packages\arduino\tools\openocd\0.10.0-arduino7/bin/openocd

Finished reading symbols from objdump: Time: 74 ms

Finished reading symbols from nm: Time: 76 ms

WARNING: Cortex-Debug will deprecate use of GDB version 8 after July 2022. Please upgrade to version 9+

Reading symbols from C:/Users\haral\AppData\Local\Temp\arduino\sketches\4121EFF1B69A8E40675BE333D4C5723A\Blink.ino.elf...done.

undefined: GDB Server Quit Unexpectedly. See gdb-server output for more details.

GDB never responded to an interrupt request. Trying to end session anyways

There seems something missing. do I have to add the parameters in the serverpath entry? How to get JLinkCL started instead of OpenGBD? That seems to be significant. As far to my understanding I eventually should see also the GUI if I use the server GUI edition.

Is it possible to edit the launch.json file to get these entries and parameters right?
The launch.json is:

{
  "version": "0.2.0",
  "configurations": [
    {
      "cwd": "${workspaceRoot}",
      "name": "Arduino",
      "request": "launch",
      "type": "cortex-debug",
      "executable": "C:\\Users\\haral\\AppData\\Local\\Temp\\arduino\\sketches\\4121EFF1B69A8E40675BE333D4C5723A/Blink.ino.elf",
      "servertype": "jlink",
      "serverpath": "C:\\Program Files\\SEGGER\\JLink-V94g\\JLinkGDBServerCL.exe",
      "armToolchainPath": "C:\\Users\\haral\\AppData\\Local\\Arduino15\\packages\\arduino\\tools\\arm-none-eabi-gcc\\7-2017q4/bin/",
      "configFiles": [
        "C:\\Users\\haral\\AppData\\Local\\Arduino15\\packages\\arduino\\hardware\\samd\\1.8.13/variants/mkrwan1300/openocd_scripts/arduino_zero.cfg"
      ],
      "device": "ATSAMD21G18",
      "interface": "SWD"
    },
    {
      "configId": "arduino:samd:mkrwan1310:programmer=jlink",
      "cwd": "${workspaceRoot}",
      "request": "launch",
      "type": "cortex-debug",
      "executable": "C:\\Users\\haral\\AppData\\Local\\Temp\\arduino\\sketches\\4121EFF1B69A8E40675BE333D4C5723A/Blink.ino.elf",
      "toolchainPrefix": "arm-none-eabi",
      "servertype": "jlink",
      "device": "ATSAMD21G18",
      "serverpath": "C:\\Users\\haral\\AppData\\Local\\Arduino15\\packages\\arduino\\tools\\openocd\\0.10.0-arduino7/bin/openocd",
      "interface": "swd",
      "name": "Arduino MKR WAN 1310 (jlink)",
      "armToolchainPath": "C:\\Users\\haral\\AppData\\Local\\Arduino15\\packages\\arduino\\tools\\arm-none-eabi-gcc\\7-2017q4/bin/",
      "configFiles": [
        "C:\\Users\\haral\\AppData\\Local\\Arduino15\\packages\\arduino\\hardware\\samd\\1.8.14/variants/mkrwan1300/openocd_scripts/arduino_zero.cfg"
      ]
    },
    {
      "configId": "arduino:samd:arduino_zero_edbg:programmer=sam_ice",
      "cwd": "${workspaceRoot}",
      "request": "launch",
      "type": "cortex-debug",
      "executable": "C:\\Users\\haral\\AppData\\Local\\Temp\\arduino\\sketches\\4121EFF1B69A8E40675BE333D4C5723A/Blink.ino.elf",
      "toolchainPrefix": "arm-none-eabi",
      "name": "Arduino Zero (Programming Port) (sam_ice)",
      "serverpath": "C:\\Users\\haral\\AppData\\Local\\Arduino15\\packages\\arduino\\tools\\openocd\\0.10.0-arduino7/bin/openocd",
      "servertype": "openocd",
      "armToolchainPath": "C:\\Users\\haral\\AppData\\Local\\Arduino15\\packages\\arduino\\tools\\arm-none-eabi-gcc\\7-2017q4/bin/",
      "configFiles": [
        "C:\\Users\\haral\\AppData\\Local\\Arduino15\\packages\\arduino\\hardware\\samd\\1.8.14/variants/arduino_zero/openocd_scripts/arduino_zero.cfg"
      ]
    }
  ]
}

Where I see some tags I do not understand. Is it possible for me to change the contents? It seems it is not.

Thank you so far.

Have a nice day
@HarrySatt

ptillisch · March 3, 2024, 3:43pm

The problem is here:

Due to the bug in Arduino IDE, this line doesn't have any effect. The result is that the default server path is used instead in `launch.json:

Please try this:

Change line 7 of debug_custom.json from:

"serverpath": "C:/Program Files/SEGGER/JLink_V794g/JLinkGDBServerCL.exe",

to:

"serverPath": "C:/Program Files/SEGGER/JLink_V794g/JLinkGDBServerCL.exe",

Note that the "P' in path is uppercase. This is essential.

Select File > Save from the Arduino IDE menus.
Click the "Start Debugging" button on the Arduino IDE toolbar.

Hopefully this time the debugger will start up and work as expected.

That is correct. However, the file is regenerated whenever you click the "Start Debugging" button on the Arduino IDE toolbar, and is also stored in a temporary folder that could be deleted at any time and is no longer associated with the sketch if you save it to another location. So editing launch.json is only really useful for making temporary adjustments during a debugging session. The way to make persistent configuration modifications is through the debug_custom.json file.

HarrySatt · March 3, 2024, 4:41pm

Hi. Thanks a lot.
Now the JLink debugger is working as expected. Really fine.
It is like always. Only one uppercase letter instead of lower case.
have a nice day and lot of fun.
Harald

ptillisch · March 3, 2024, 5:24pm

You are welcome. I'm glad it is working now.

Regards,
Per

HarrySatt · March 3, 2024, 6:58pm

Really fine. Minor Problems with uploading an altered sketch. Seems there is no active breakpoint allowed. If there is one upload wait infinite and stops with error.
So I set all breakpoinss inactive and upload is ok
Thanks for your help.
Have a nice day.
Harald

dankeboy36 · March 4, 2024, 7:56pm

Hello, if this is a new defect and you can open a GH issue, I will find time to fix it. Thanks

update:

OK. I found the problem. It's here: vscode-arduino-tools/src/debug.ts at 4938c4185bb39cdc0b709402d9bc8555d8274588 · arduino/vscode-arduino-tools · GitHub.

ptillisch · March 4, 2024, 10:32pm

@dankeboy36 the issue is here:

github.com/arduino/vscode-arduino-tools

Not possible to override debug configuration keys that are remapped from Arduino CLI

opened 05:59AM - 03 Mar 24 UTC

per1234

topic: code type: imperfection

### Describe the problem This extension automatically generates a `launch.jso…n` file to configure the [**Cortex-Debug** VS Code extension](https://github.com/Marus/cortex-debug) for use with the selected board and "programmer" (debug probe). The base configuration data comes from the [`arduino-cli debug --info`](https://arduino.github.io/arduino-cli/dev/commands/arduino-cli_debug/) output. Some of that data does not match exactly with the `launch.json` format so the extension remaps it. In some cases ([example](https://docs.arduino.cc/tutorials/mkr-wifi-1010/mkr-jlink-setup/#debugging-in-arduino-ide-2)), the user might need/want to make some adjustments to the generated configuration. This is done by adding the custom configuration data to a file named `debug_custom.json` in the sketch root folder. The configuration from that file is merged into the base data when generating `launch.json`, overriding the base data where there is overlap. 🐛 Overrides no longer work for the configuration keys that are remapped from the Arduino CLI data: - `armToolchainPath` - `configFiles` - `serverpath` - `servertype` ### To reproduce --- **ⓘ** Hardware is not required to perform this demo. --- 1. If you don't already have it installed, use the Arduino IDE Boards Manager to install the "**Arduino SAMD Boards (32-bits ARM Cortex-M0+)**" platform. **ⓘ** This platform was selected arbitrarily as one that has debugger support. The fault is not platform-specific. 1. Select **File > New** from the Arduino IDE menus. 1. Select **Tools > Board > Arduino SAMD Boards (32-bits ARM Cortex-M0+) > Arduino Zero (Programming Port)** from the Arduino IDE menus. 1. Select **Tools > Programmer > Atmel EDBG** from the Arduino IDE menus. 1. Click the **●●●** icon on the right side of the editor toolbar. A menu will open. 1. Select "**New Tab**" from the menu. The "**Name for new file**" dialog will open. 1. Type `debug_custom.json` in the field in the dialog. 1. Click the "**OK**" button. The dialog will close and a "**debug_custom.json**" tab will be added to the editor view. 1. Use the editor to add the following content to the "**debug_custom.json**" tab: ```json [ { "configId": "arduino:samd:arduino_zero_edbg:programmer=edbg", "toolchainPrefix": "custom-toolchain-prefix", "armToolchainPath": "/path/to/custom-arm-toolchain", "configFiles": ["/path/to/custom-custom-config-file"], "serverpath": "/path/to/custom-server", "servertype": "jlink" } ] ``` 1. Select **Sketch > Verify/Compile** from the Arduino IDE menus. 1. Wait for the compilation to finish successfully. 1. Click the "**Start Debugging**" button on the Arduino IDE toolbar. 1. Wait for the process to fail. **ⓘ** The failure is expected unless you happen to have the necessary hardware connected to your computer. It is not relevant to the demo. 1. Click the "Toggle Debug View" icon on the activity bar. The debug view will open in the left side panel. 1. Click the gear icon ('Open "launch.json"') on the debugger toolbar. A "**launch.json**" tab will open in the editor. 🙂 The `configurations[0].toolchainPrefix` value was set according to `debug_custom.json` as expected: ```json "toolchainPrefix": "custom-toolchain-prefix" ``` 🐛 The `configurations[0].armToolchainPath`, `configurations[0].configFiles`, `configurations[0].serverpath`, and `configurations[0].servertype` values were not set according to `debug_custom.json`: ```json "armToolchainPath": "C:\\Users\\per\\AppData\\Local\\Arduino15\\packages\\arduino\\tools\\arm-none-eabi-gcc\\7-2017q4/bin/", "configFiles": [ "C:\\Users\\per\\AppData\\Local\\Arduino15\\packages\\arduino\\hardware\\samd\\1.8.14/variants/arduino_zero/openocd_scripts/arduino_zero.cfg" ], "serverpath": "C:\\Users\\per\\AppData\\Local\\Arduino15\\packages\\arduino\\tools\\openocd\\0.10.0-arduino7/bin/openocd", "servertype": "openocd" ``` ### Expected behavior Any debug configuration key can be overridden via `debug_custom.json`. ### vscode-arduino-tools version 0.1.3 ### Additional context The regression was introduced at https://github.com/arduino/vscode-arduino-tools/commit/9508d0a8500ae578f581768ecde40804d286ea62 / https://github.com/arduino/vscode-arduino-tools/pull/41 #### Additional Reports - https://forum.arduino.cc/t/starting-2-3-0-debugger-with-j-link-fails-unable-to-find-cmsis-dap-device/1230756/7 <a name="workaround"></a> #### Workaround Use the pre-remapping key names in `debug_custom.json`: - `armToolchainPath` -> `toolchainPath` - `configFiles` -> `serverConfiguration.scripts` - `serverpath` -> `serverPath` - `servertype` -> `server`

and pull request here:

github.com/arduino/vscode-arduino-tools

Fix regression in overriding remapped debug configuration data via `debug_custom.json`

arduino:main ← per1234:fix-custom-override

opened 05:59AM - 03 Mar 24 UTC

per1234

+43 -6

Some of the data from the [`arduino-cli debug --info`](https://arduino.github.io…/arduino-cli/dev/commands/arduino-cli_debug/) output does not match exactly with the `launch.json` format required by the [**Cortex-Debug**](https://github.com/Marus/cortex-debug) VS Code extension used at the Arduino IDE integrated sketch debugger. For this reason, some remapping of the **Arduino CLI** data is required. The user can adjust the debugger configuration via a debug_custom.json file in the sketch project. The data from this file is merged into the base data provided by `arduino-cli debug --info`. The data from debug_custom.json should override the base data where there is overlap. During the recent reworking of the debugger configuration generation code (https://github.com/arduino/vscode-arduino-tools/pull/41), a regression was introduced that caused the override to no longer work for the remapped Arduino CLI data. The cause was applying the remapping after merging the `debug_custom.json` data, which resulted in the `debug_custom.json` data being overridden by that subset of the Arduino CLI data. This was not caught by the project's tests because there was no coverage for overrides. I have added coverage and you can see the test fails when ran on the codebase prior to the patch: https://github.com/arduino/vscode-arduino-tools/actions/runs/8128174502/job/22213780846?pr=49#step:6:159 The bug is fixed by performing the remapping before merging the `debug_custom.json` data. Fixes https://github.com/arduino/vscode-arduino-tools/issues/48

Review would be very much welcome.

system · September 4, 2024, 7:14pm

This topic was automatically closed 180 days after the last reply. New replies are no longer allowed.

Topic		Replies	Views
OpenOCD Error: unable to find CMSIS-DAP device (MKR Zero) IDE 2.x	6	1504	November 24, 2023
Odd error message IDE 2.x	4	2615	October 19, 2023
CMSIS-DAP command CMD_DAP_SWJ_CLOCK failed IDE 1.x	2	1985	June 28, 2023
Debug Arduino Due, via JTAG Arduino Due	9	13950	May 6, 2021
Arduino IDE 2.0 with Atmel ICE Failed to launch OpenOCD GDB Server Avrdude, stk500, Bootloader issues	6	1084	October 3, 2022

Starting 2.3.0 debugger with J-Link fails: "unable to find CMSIS-DAP device"

Instructions

Explanation

Breaking change to debug_custom.json format

Bug when overriding certain configuration keys

Related Topics

Breaking change to `debug_custom.json` format