Skip to content

Commit 81cc28e

Browse files
brianignacio5brianignacio5
authored
Peripheral register view (#755)
* implement some svd parser peripheral register * add register cluster initial definition * update cluster register add field * complete tree view implementation * add peripheral fields fix lint * fix cleanup description * fix address ranges * update vscode extension tester to latest * rm use of terminal view * add idf.svdFilePath setting download svd command * update debug adapter * add peripheral in debug docs * go back extension tester version * update dependencies * rm debug adapter py pkgs from ci * add constraints for pip pkgs * add extension constraints
1 parent 0330620 commit 81cc28e

26 files changed

+3537
-856
lines changed

‎.github/actions/idf/entrypoint.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ export OLD_PATH=$PATH
88
cd /github/workspace
99

1010
pip install --upgrade pip
11-
pip install -r requirements.txt
12-
pip install -r esp_debug_adapter/requirements.txt
11+
pip install --constraint espidf.constraints.txt -r requirements.txt
12+
pip install --constraint espidf.constraints.txt -r esp_debug_adapter/requirements.txt
1313

1414
export GIT_VERSION=$( echo "$a" | echo $(git --version) | sed -nre 's/^[^0-9]*(([0-9]+\.)*[0-9]+).*/\1/p')
1515
export IDF_VERSION=$( echo "$a" | echo $(idf.py --version) | sed -nre 's/^[^0-9]*(([0-9]+\.)*[0-9]+).*/\1/p')

‎.github/actions/idf/ui-entrypoint.sh

+3-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@ export OLD_PATH=$PATH
77

88
cd /github/workspace
99

10-
pip install -r requirements.txt
11-
pip install -r esp_debug_adapter/requirements.txt
10+
pip install --upgrade pip
11+
pip install --constraint espidf.constraints.txt -r requirements.txt
12+
pip install --constraint espidf.constraints.txt -r esp_debug_adapter/requirements.txt
1213

1314
export GIT_VERSION=$( echo "$a" | echo $(git --version) | sed -nre 's/^[^0-9]*(([0-9]+\.)*[0-9]+).*/\1/p')
1415
export IDF_VERSION=$( echo "$a" | echo $(idf.py --version) | sed -nre 's/^[^0-9]*(([0-9]+\.)*[0-9]+).*/\1/p')

‎docs/DEBUGGING.md

+2
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ The Visual Studio Code uses `.vscode/launch.json` to configure debug as specifie
99

1010
We recommend using our ESP-IDF Debug Adapter to debug your ESP-IDF projects, but you can also just configure launch.json for the [Microsoft C/C++ Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools).
1111

12+
Our extension implements a `ESP Peripheral View` tree view in the `Run and debug` view which will use the SVD file defined in the `IDF Svd File Path (idf.svdFilePath)` configuration setting to populate a set of peripherals registers values for the active debug session target. You could find Espressif SVD files from [Espressif SVD](https://github.com/espressif/svd).
13+
1214
## Use the ESP-IDF Debug Adapter
1315

1416
> **NOTE:** Currently the python package `pygdbmi` used by the debug adapter still depends on some Python 2.7 libraries (libpython2.7.so.1.0) so make sure that the Python executable you use in `idf.pythonBinPath` contains these libraries. This will be dropped in later versions of ESP-IDF.

‎docs/SETTINGS.md

+1
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ These settings are specific to the ESP32 Chip/ Board
5757
| `openocd.jtag.command.force_unix_path_separator` | Forced to use `/` as path sep. for Win32 based OS instead of `\\` | User, Remote or Workspace |
5858
| `idf.listDfuDevices` | List of DFU devices connected to USB | User, Remote or Workspace |
5959
| `idf.selectedDfuDevicePath` | Selected DFU device connected to USB | User, Remote or Workspace |
60+
| `idf.svdFilePath` | SVD file absolute path to resolve chip debug peripheral tree view | User, Remote or Workspace |
6061

6162
This is how the extension uses them:
6263

‎docs/tutorial/debugging.md

+2
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,8 @@ You can send any GDB commands in the Debug console with `--exec COMMAND`. You ne
151151

152152
More about [command line debugging](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/debugging-examples.html#command-line).
153153

154+
Our extension implements a `ESP Peripheral View` tree view in the `Run and debug` view which will use the SVD file defined in the `IDF Svd File Path (idf.svdFilePath)` configuration setting to populate a set of peripherals registers values for the active debug session target. You could find Espressif SVD files from [Espressif SVD](https://github.com/espressif/svd).
155+
154156
You can start a monitor session that can capture fatal error events with `ESP-IDF: Launch IDF Monitor for CoreDump / GDB-Stub Mode` command and, if configured in your project's sdkconfig, trigger the start of a debug session for GDB remote protocol server (GDBStub) or [ESP-IDF Core Dump](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/core_dump.html#core-dump) when an error is found. Read more in the [panic handler documentation](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/fatal-errors.html#panic-handler).
155157

156158
- **Core dump** is configured when `Core dump's Data destination` is set to either `UART` or `FLASH` using the `ESP-IDF: SDK Configuration Editor` extension command or `idf.py menuconfig` in a terminal.

‎esp_debug_adapter

‎espidf.constraints.txt

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# --------- CORE ----------
2+
3+
# setuptools: version 21 is required to handle PEP 508 environment markers
4+
setuptools>=21
5+
6+
# click: Min. version was set to support the API used in idf.py and auto-completion
7+
# click: Max. version was set to avoid potential breaking changes
8+
click>=7.0,<8.1
9+
10+
# pyserial: Min. version was set to support the used API
11+
# pyserial: Max. version was set to avoid potential breaking changes
12+
pyserial>=3.3,<3.6
13+
14+
# future: Min. version was set to support the used API
15+
# future: Max. version was set to avoid potential breaking changes
16+
future>=0.15.2,<0.18.3
17+
18+
# cryptography: Min. version was set to support all functionality of ESP-IDF
19+
# cryptography: Max. version was set to avoid breaking changes
20+
# Only binary for cryptography is here to make it work on ARMv7 architecture
21+
# We do have cryptography binary on https://dl.espressif.com/pypi for ARM
22+
# On https://pypi.org/ are no ARM binaries as standard now
23+
cryptography>=2.1.4,<36.1
24+
--only-binary cryptography
25+
26+
# pyparsing: Min version was set based on https://github.com/pyparsing/pyparsing/issues/319
27+
# pyparsing: Max version was set to avoid breaking changes
28+
pyparsing>=3.0.3,<3.1
29+
30+
# pyelftools: Max version was set to avoid breaking changes
31+
pyelftools<0.28
32+
33+
idf-component-manager~=1.1
34+
35+
esptool~=4.2
36+
37+
esp-coredump~=1.2
38+
39+
# kconfiglib: Min. version is set because some ESP-IDF patches were applied upstream
40+
# kconfiglib: Max. version is set just to avoid potential incompatibility (there is no known at this moment)
41+
kconfiglib>=13.7.1,<=14.2
42+
43+
freertos_gdb~=1.0
44+
45+
# --------- CORE ends ----------
46+
47+
# --------- GDBGUI -------------
48+
49+
gdbgui==0.13.2.0
50+
# Windows is not supported since 0.14.0.0. See https://github.com/cs01/gdbgui/issues/348
51+
# pygdmi dependency is shared between gdbgui, coredump and py_debug_backend
52+
# pygdbmi 0.10 have breaking changes
53+
# The pygdbmi required max version 0.9.0.2 since 0.9.0.3 is not compatible with latest gdbgui (>=0.13.2.0)
54+
pygdbmi<=0.9.0.2
55+
# A compatible Socket.IO should be used. See https://github.com/miguelgrinberg/python-socketio/issues/578
56+
python-socketio<5
57+
jinja2<3.1
58+
itsdangerous<2.1
59+
60+
# --------- GDBGUI ends ---------
61+
62+
# --------- PYTEST -------------
63+
64+
pytest-embedded-serial-esp~=0.7.3
65+
pytest-embedded-idf~=0.7.3
66+
pytest-embedded-qemu~=0.7.3
67+
68+
# --------- PYTEST ends ---------
69+
70+
# --------- DOCS -------------
71+
72+
esp-docs~=1.1.0
73+
74+
# --------- DOCS ends ---------

‎i18n/en/package.i18n.json

+1
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@
9191
"param.postFlashTask": "Post flash custom task",
9292
"param.customTask": "Custom task",
9393
"param.buildDirectoryName": "Name of CMake build directory",
94+
"param.svdFile": "SVD file to resolve ESP-IDF Peripheral view in Debug view",
9495
"view.components.name": "Project Components",
9596
"configuration.title": "ESP-IDF",
9697
"espIdf.apptrace.archive.refresh.title": "Refresh Trace Archive List",

‎i18n/es/package.i18n.json

+1
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@
9494
"param.postFlashTask": "Post build tarea personalizada",
9595
"param.customTask": "Tarea personalizada",
9696
"param.buildDirectoryName": "Nombre del directorio de construcción de CMake",
97+
"param.svdFile": "Archivo SVD para la vista de perifericos en ventana de depuracion",
9798
"view.components.name": "Componentes de proyecto",
9899
"configuration.title": "ESP-IDF",
99100
"espIdf.apptrace.archive.refresh.title": "Refresh Trace Archive List",

‎i18n/ru/package.i18n.json

+1
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@
9494
"param.postFlashTask": "Опубликовать настраиваемую задачу Flash",
9595
"param.customTask": "Специальная задача",
9696
"param.buildDirectoryName": "Имя каталога сборки CMake",
97+
"param.svdFile": "Файл SVD для разрешения периферийного представления ESP-IDF в представлении отладки",
9798
"view.components.name": "Компоненты проекта",
9899
"configuration.title": "ESP-IDF",
99100
"espIdf.apptrace.archive.refresh.title": "Обновить список архива трассировки",

‎i18n/zh-CN/package.i18n.json

+1
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@
9494
"param.postFlashTask": "flash后自定义任务",
9595
"param.customTask": "自定义任务",
9696
"param.buildDirectoryName": "CMake生成目录的名称",
97+
"param.svdFile": "用于在调试视图中解析ESP-IDF外围视图的奇异值分解文件",
9798
"view.components.name": "项目组件",
9899
"configuration.title": "ESP-IDF",
99100
"espIdf.apptrace.archive.refresh.title": "刷新跟踪归档列表",

‎package.json

+25-7
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"theme": "dark"
1212
},
1313
"engines": {
14-
"vscode": "^1.30.0"
14+
"vscode": "^1.32.0"
1515
},
1616
"repository": {
1717
"type": "git",
@@ -136,6 +136,12 @@
136136
]
137137
},
138138
"views": {
139+
"debug": [
140+
{
141+
"name": "ESP Peripheral View",
142+
"id": "espIdf.peripheralView"
143+
}
144+
],
139145
"idfViewController": [
140146
{
141147
"id": "idfSearchResults",
@@ -177,6 +183,10 @@
177183
{
178184
"view": "idfPartitionExplorer",
179185
"contents": "Show the partition list from your device with the option to flash binaries (.bin) to the selected partition.\n\nSelect your device serial port and click Refresh partition table."
186+
},
187+
{
188+
"view": "espIdf.peripheralView",
189+
"contents": "Show Peripherals registers from SVD file defined in IDF Svd File Path (idf.svdFilePath) configuration setting during active debug session"
180190
}
181191
],
182192
"menus": {
@@ -775,6 +785,12 @@
775785
"default": "",
776786
"scope": "resource",
777787
"description": "%param.customTask%"
788+
},
789+
"idf.svdFilePath": {
790+
"type": "string",
791+
"default": "${workspaceFolder}/esp32.svd",
792+
"scope": "resource",
793+
"description": "%param.svdFile%"
778794
}
779795
}
780796
}
@@ -1268,17 +1284,18 @@
12681284
"@types/marked": "^4.0.2",
12691285
"@types/mocha": "^9.1.0",
12701286
"@types/nock": "^9.3.1",
1271-
"@types/node": "^16.11.1",
1287+
"@types/node": "^16.11.7",
12721288
"@types/sanitize-html": "^2.6.2",
12731289
"@types/tar-fs": "^2.0.1",
12741290
"@types/tmp": "0.0.33",
1275-
"@types/vscode": "^1.30.0",
1291+
"@types/vscode": "^1.32.0",
12761292
"@types/ws": "^7.2.5",
1293+
"@types/xml2js": "^0.4.11",
12771294
"@types/yauzl": "^2.9.1",
12781295
"@vscode/debugadapter": "^1.53.0",
12791296
"@vscode/debugadapter-testsupport": "^1.51.0",
12801297
"@vscode/debugprotocol": "^1.53.0",
1281-
"@vscode/extension-telemetry": "^0.4.8",
1298+
"@vscode/extension-telemetry": "0.4.8",
12821299
"@vscode/test-electron": "^2.1.2",
12831300
"@vue/component-compiler-utils": "^3.0.0",
12841301
"bulma": "^0.9.3",
@@ -1302,15 +1319,15 @@
13021319
"sass": "^1.49.8",
13031320
"sass-loader": "^10",
13041321
"style-loader": "^3.3.1",
1305-
"ts-loader": "^7.0.5",
1322+
"ts-loader": "^8.0.2",
13061323
"tslint": "^5.18.0",
13071324
"tslint-config-prettier": "^1.18.0",
13081325
"tslint-plugin-prettier": "^2.3.0",
13091326
"tslint-webpack-plugin": "^2.1.0",
1310-
"typescript": "^4.5.5",
1327+
"typescript": "^4.7.4",
13111328
"typescript-tslint-plugin": "^1.0.1",
13121329
"vsce": "^2.6.7",
1313-
"vscode-extension-tester": "^4.2.4",
1330+
"vscode-extension-tester": "^4.3.0",
13141331
"vscode-nls-dev": "^3.3.1",
13151332
"vue-class-component": "^7.1.0",
13161333
"vue-hot-reload-api": "^2.3.2",
@@ -1349,6 +1366,7 @@
13491366
"vuex": "^3.1.1",
13501367
"winston": "^2.3.1",
13511368
"ws": "^7.4.6",
1369+
"xml2js": "^0.4.23",
13521370
"yauzl": "^2.10.0"
13531371
},
13541372
"alias": {

‎package.nls.json

+1
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@
9090
"param.postBuildTask": "Post build custom task",
9191
"param.preFlashTask": "Pre flash custom task",
9292
"param.postFlashTask": "Post flash custom task",
93+
"param.svdFile": "SVD file to resolve ESP-IDF Peripheral view in Debug view",
9394
"param.buildDirectoryName": "Name of CMake build directory",
9495
"view.components.name": "Project Components",
9596
"configuration.title": "ESP-IDF",

‎schema.i18n.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,7 @@
209209
"param.preBuildTask",
210210
"param.postBuildTask",
211211
"param.preFlashTask",
212-
"param.postFlashTask"
212+
"param.postFlashTask",
213+
"param.svdFile"
213214
]
214215
}

‎src/espIdf/debugAdapter/common.ts

+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
/*
2+
* Project: ESP-IDF VSCode Extension
3+
* File Created: Wednesday, 6th July 2022 10:40:29 pm
4+
* Copyright 2022 Espressif Systems (Shanghai) CO LTD
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
import { PeripheralBaseNode, } from './nodes/base';
20+
import { MarkdownString, TreeItem, TreeItemCollapsibleState } from 'vscode';
21+
22+
export enum NumberFormat {
23+
Auto = 0,
24+
Hexadecimal,
25+
Decimal,
26+
Binary
27+
}
28+
29+
export interface NodeSetting {
30+
node: string;
31+
expanded?: boolean;
32+
format?: NumberFormat;
33+
pinned?: boolean;
34+
}
35+
36+
export interface EnumerationMap {
37+
[value: number]: EnumeratedValue;
38+
}
39+
40+
export class EnumeratedValue {
41+
constructor(public name: string, public description: string, public value: number) {}
42+
}
43+
44+
export class AddrRange {
45+
constructor(public base: number, public length: number) {
46+
}
47+
48+
/** return next address after this addr. range */
49+
public nxtAddr() {
50+
return this.base + this.length;
51+
}
52+
53+
/** return last address in this range */
54+
public endAddr() {
55+
return this.nxtAddr() - 1;
56+
}
57+
}
58+
59+
export class MessageNode extends PeripheralBaseNode {
60+
61+
constructor(public message: string, public tooltip?: string | MarkdownString) {
62+
super(null);
63+
}
64+
65+
public getChildren(): PeripheralBaseNode[] | Promise<PeripheralBaseNode[]> {
66+
return [];
67+
}
68+
69+
public getTreeItem(): TreeItem | Promise<TreeItem> {
70+
const ti = new TreeItem(this.message, TreeItemCollapsibleState.None);
71+
if (this.tooltip) { // A null crashes VSCode Tree renderer
72+
ti.tooltip = this.tooltip;
73+
}
74+
return ti;
75+
}
76+
77+
public getCopyValue(): string | undefined {
78+
return null;
79+
}
80+
81+
public performUpdate(): Thenable<any> {
82+
return Promise.resolve(false);
83+
}
84+
85+
public updateData(): Thenable<boolean> {
86+
return Promise.resolve(false);
87+
}
88+
89+
public getPeripheral(): PeripheralBaseNode {
90+
return null;
91+
}
92+
93+
public collectRanges(ary: AddrRange[]): void {
94+
}
95+
96+
public saveState(path?: string): NodeSetting[] {
97+
return [];
98+
}
99+
100+
public findByPath(path: string[]): PeripheralBaseNode {
101+
return null;
102+
}
103+
}

0 commit comments

Comments
 (0)