Skip to content

Commit 2318fe6

Browse files
authored
Delete pseudo adapters (#339)
* remove pseudo debugger types --------- Signed-off-by: Jens Reinecke <jens.reinecke@arm.com>
1 parent 1f7ec82 commit 2318fe6

3 files changed

Lines changed: 19 additions & 160 deletions

File tree

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Change Log
22

3+
## Unreleased
4+
5+
- Removes pseudo debugger types `cmsis-debug-pyocd` and `cmsis-debug-jlink`.
6+
CMSIS debug launch configurations and tasks are managed by
7+
[Arm CMSIS Solution extension](https://marketplace.visualstudio.com/items?itemName=Arm.cmsis-csolution)
8+
since v1.54.0.
9+
If you need to manually set up a `gdbtarget` connection, then refer to
10+
[CDT GDB Adapter extension](https://marketplace.visualstudio.com/items?itemName=eclipse-cdt.cdt-gdb-vscode).
11+
312
## 0.3.1
413

514
- Fixed image links in [README](https://marketplace.visualstudio.com/items?itemName=Arm.vscode-cmsis-debugger).

README.md

Lines changed: 10 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -397,32 +397,24 @@ application is run with the `> continue` command.
397397

398398
This extension contributes additional functionality to work seamlessly with other extensions.
399399

400-
- The pseudo debugger types `cmsis-debug-pyocd` and `cmsis-debug-jlink`. These types allow a more seamless
401-
integration into your IDE. However, these are not full debug adapters but generate debug configurations of
402-
type `gdbtarget` which comes with the [CDT GDB Debug Adapter Extension](https://marketplace.visualstudio.com/items?itemName=eclipse-cdt.cdt-gdb-vscode).
403400
- A [debug configuration provider](https://code.visualstudio.com/api/references/vscode-api#DebugConfigurationProvider)
404401
for the type `gdbtarget` which comes with the [CDT GDB Debug Adapter Extension](https://marketplace.visualstudio.com/items?itemName=eclipse-cdt.cdt-gdb-vscode).
405402
This provider automatically fills in default values for known remote GDB servers when launching a debug session.
406403
- CMSIS specific launch configuration items for the `*` debugger type, i.e. visible for all debugger types.
407404
It depends on the actually used debug adapter type if this information is known and utilized.
408405

409-
### Pseudo Debugger Types
406+
### Debug Configuration Provider
410407

411-
This section describes the contributed pseudo debugger types and their support through the contributed debug
412-
configuration provider for type `gdbtarget`.
408+
The extension contributes a debug configuration provider which automatically fills gaps in a `gdbtarget`
409+
debug launch configuration on debug launch. The exact functionality depends on the used `target`>`server`
410+
value.
413411

414-
#### CMSIS Debugger (pyOCD) - `cmsis-debug-pyocd`
415-
416-
The `cmsis-debug-pyocd` debugger type is used to add a debug configuration in the
417-
`launch.json` file for debugging with GDB and pyOCD.
418-
This configuration uses the `gdbtarget` debugger type registered by the CDT GDB Debug Adapter Extension.
419-
420-
Additionally, the extension contributes a debug configuration resolver which automatically fills
421-
the following gaps during debug launch:
412+
#### pyOCD
422413

423414
- If option `target`>`server` is set to `pyocd`, then it expands to the absolute path of
424415
the built-in pyOCD distribution.
425-
- Extends the `target`>`serverParameters` list of `pyocd` command line arguments:
416+
- If option `target`>`server` contains `pyocd`, then it extends the `target`>`serverParameters` list
417+
of `pyocd` command line arguments:
426418
- Prepends `gdbserver` if not present.
427419
- Appends `--port <gdbserver_port>` if the `target`>`port` setting is set, where `<gdbserver_port>` gets
428420
that port setting's value.
@@ -432,24 +424,10 @@ the following gaps during debug launch:
432424
> The built-in version of pyOCD supports the command line option `--cbuild-run` which isn't available
433425
> in releases outside this extension.
434426
435-
#### CMSIS Debugger (J-LINK) - `cmsis-debug-jlink`
436-
437-
The `cmsis-debug-jlink` debugger type is used to add a debug configuration in the launch.json file for debug
438-
with GDB and the SEGGER J-LINK GDB server.
439-
This configuration uses the `gdbtarget` debugger type registered by the CDT GDB Debug Adapter Extension.
440-
441-
> 📝 **Note:**
442-
> The generated default debug configuration uses the value `JLinkGDBServer` as `target`>`server` setting.
443-
> This executable has differing behavior on supported host platform:
444-
445-
- Linux and macOS: A GUI-less version of the GDB server is launched.
446-
- Windows®: A GDB server with GUI is launched. Update `target`>`server` to `JLinkGDBServerCL` to launch a
447-
GUI-less version on Windows, too.
448-
449-
Additionally, the extension contributes a debug configuration resolver which automatically fills the following
450-
gaps during debug launch:
427+
#### J-LINK
451428

452-
- Extends the `target`>`serverParameters` list of `JLinkGDBServer`/`JLinkGDBServerCL` command line arguments:
429+
- If option `target`>`server` contains `JLinkGDBServer` or `JLinkGDBServerCL`, then it extends the
430+
`target`>`serverParameters` list of `JLinkGDBServer`/`JLinkGDBServerCL` command line arguments:
453431
- Appends `--port <gdbserver_port>` if the `target`>`port` setting is set, where `<gdbserver_port>` gets that
454432
port setting's value.
455433

package.json

Lines changed: 0 additions & 128 deletions
Original file line numberDiff line numberDiff line change
@@ -47,134 +47,6 @@
4747
],
4848
"contributes": {
4949
"debuggers": [
50-
{
51-
"type": "cmsis-debug-pyocd",
52-
"label": "CMSIS Debugger (pyOCD)",
53-
"initialConfigurations": [
54-
{
55-
"name": "CMSIS Debugger: pyOCD",
56-
"type": "gdbtarget",
57-
"request": "launch",
58-
"cwd": "${workspaceFolder}",
59-
"program": "${command:cmsis-csolution.getBinaryFile}",
60-
"gdb": "arm-none-eabi-gdb",
61-
"initCommands": [
62-
"load",
63-
"tbreak main"
64-
],
65-
"target": {
66-
"server": "pyocd",
67-
"port": "3333"
68-
},
69-
"cmsis": {
70-
"cbuildRunFile": "${command:cmsis-csolution.getCbuildRunFile}"
71-
}
72-
}
73-
],
74-
"configurationSnippets": [
75-
{
76-
"label": "CMSIS Debugger: pyOCD",
77-
"description": "CMSIS Debugger via pyOCD GDB adapter.",
78-
"body": {
79-
"name": "CMSIS Debugger: pyOCD",
80-
"type": "gdbtarget",
81-
"request": "launch",
82-
"cwd": "^\"\\${workspaceFolder}\"",
83-
"program": "^\"\\${command:cmsis-csolution.getBinaryFile}\"",
84-
"gdb": "arm-none-eabi-gdb",
85-
"initCommands": [
86-
"load",
87-
"tbreak main"
88-
],
89-
"target": {
90-
"server": "pyocd",
91-
"port": "3333"
92-
},
93-
"cmsis": {
94-
"cbuildRunFile": "^\"\\${command:cmsis-csolution.getCbuildRunFile}\""
95-
}
96-
}
97-
}
98-
]
99-
},
100-
{
101-
"type": "cmsis-debug-jlink",
102-
"label": "CMSIS Debugger (J-LINK)",
103-
"initialConfigurations": [
104-
{
105-
"name": "CMSIS Debugger: J-LINK",
106-
"type": "gdbtarget",
107-
"request": "launch",
108-
"cwd": "${workspaceFolder}",
109-
"program": "${command:cmsis-csolution.getBinaryFile}",
110-
"gdb": "arm-none-eabi-gdb",
111-
"initCommands": [
112-
"load",
113-
"tbreak main"
114-
],
115-
"target": {
116-
"server": "JLinkGDBServer",
117-
"serverParameters": [
118-
"-device",
119-
"${command:cmsis-csolution.getDeviceName}",
120-
"-endian",
121-
"little",
122-
"-if",
123-
"SWD",
124-
"-speed",
125-
"auto",
126-
"-noir",
127-
"-vd",
128-
"-nogui",
129-
"-localhostonly"
130-
],
131-
"port": "3333"
132-
},
133-
"cmsis": {
134-
"cbuildRunFile": "${command:cmsis-csolution.getCbuildRunFile}"
135-
}
136-
}
137-
],
138-
"configurationSnippets": [
139-
{
140-
"label": "CMSIS Debugger: J-LINK",
141-
"description": "CMSIS Debugger via J-LINK GDB adapter.",
142-
"body": {
143-
"name": "CMSIS Debugger: J-LINK",
144-
"type": "gdbtarget",
145-
"request": "launch",
146-
"cwd": "^\"\\${workspaceFolder}\"",
147-
"program": "^\"\\${command:cmsis-csolution.getBinaryFile}\"",
148-
"gdb": "arm-none-eabi-gdb",
149-
"initCommands": [
150-
"load",
151-
"tbreak main"
152-
],
153-
"target": {
154-
"server": "JLinkGDBServer",
155-
"serverParameters": [
156-
"-device",
157-
"^\"\\${command:cmsis-csolution.getDeviceName}\"",
158-
"-endian",
159-
"little",
160-
"-if",
161-
"SWD",
162-
"-speed",
163-
"auto",
164-
"-noir",
165-
"-vd",
166-
"-nogui",
167-
"-localhostonly"
168-
],
169-
"port": "3333"
170-
},
171-
"cmsis": {
172-
"cbuildRunFile": "^\"\\${command:cmsis-csolution.getCbuildRunFile}\""
173-
}
174-
}
175-
}
176-
]
177-
},
17850
{
17951
"type": "*",
18052
"configurationAttributes": {

0 commit comments

Comments
 (0)