Skip to content

Add configuration files for VS Code #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
sw wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add configuration files for VS Code #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
.vscode/
/Build*
/Temp*
/Build/
181 changes: 181 additions & 0 deletions .vscode/launch.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
{
"version": "0.2.0",
"configurations": [
{
"executable": "Build/app.elf",
"name": "J-Link PY32F002Ax5",
"preLaunchTask": "build",
"request": "launch",
"runToEntryPoint": "main",
"servertype": "jlink",
"svdPath": "${workspaceFolder}/Misc/SVD/py32f002axx.svd",
"device": "PY32F002Ax5",
"type": "cortex-debug",
},
{
"executable": "Build/app.elf",
"name": "J-Link PY32F002Bx5",
"preLaunchTask": "build",
"request": "launch",
"runToEntryPoint": "main",
"servertype": "jlink",
"svdPath": "${workspaceFolder}/Misc/SVD/py32f002xx.svd",
"device": "PY32F002Bx5",
"type": "cortex-debug",
},
{
"executable": "Build/app.elf",
"name": "J-Link PY32F003x4",
"preLaunchTask": "build",
"request": "launch",
"runToEntryPoint": "main",
"servertype": "jlink",
"svdPath": "${workspaceFolder}/Misc/SVD/py32f003xx.svd",
"device": "PY32F003x4",
"type": "cortex-debug",
},
{
"executable": "Build/app.elf",
"name": "J-Link PY32F003x6",
"preLaunchTask": "build",
"request": "launch",
"runToEntryPoint": "main",
"servertype": "jlink",
"svdPath": "${workspaceFolder}/Misc/SVD/py32f003xx.svd",
"device": "PY32F003x6",
"type": "cortex-debug",
},
{
"executable": "Build/app.elf",
"name": "J-Link PY32F003x8",
"preLaunchTask": "build",
"request": "launch",
"runToEntryPoint": "main",
"servertype": "jlink",
"svdPath": "${workspaceFolder}/Misc/SVD/py32f003xx.svd",
"device": "PY32F003x8",
"type": "cortex-debug",
},
{
"executable": "Build/app.elf",
"name": "J-Link PY32F030x6",
"preLaunchTask": "build",
"request": "launch",
"runToEntryPoint": "main",
"servertype": "jlink",
"svdPath": "${workspaceFolder}/Misc/SVD/py32f030xx.svd",
"device": "PY32F030x6",
"type": "cortex-debug",
},
{
"executable": "Build/app.elf",
"name": "J-Link PY32F030x8",
"preLaunchTask": "build",
"request": "launch",
"runToEntryPoint": "main",
"servertype": "jlink",
"svdPath": "${workspaceFolder}/Misc/SVD/py32f030xx.svd",
"device": "PY32F030x8",
"type": "cortex-debug",
},
{
"executable": "Build/app.elf",
"name": "J-Link PY32F072xB",
"preLaunchTask": "build",
"request": "launch",
"runToEntryPoint": "main",
"servertype": "jlink",
"svdPath": "${workspaceFolder}/Misc/SVD/py32f072xx.svd",
"device": "PY32F072xB",
"type": "cortex-debug",
},
{
"executable": "Build/app.elf",
"name": "pyOCD PY32F002Ax5",
"preLaunchTask": "build",
"request": "launch",
"runToEntryPoint": "main",
"servertype": "pyocd",
"svdPath": "${workspaceFolder}/Misc/SVD/py32f002axx.svd",
"targetId": "py32f002ax5",
"type": "cortex-debug",
},
{
"executable": "Build/app.elf",
"name": "pyOCD PY32F002Bx5",
"preLaunchTask": "build",
"request": "launch",
"runToEntryPoint": "main",
"servertype": "pyocd",
"svdPath": "${workspaceFolder}/Misc/SVD/py32f002xx.svd",
"targetId": "py32f002bx5",
"type": "cortex-debug",
},
{
"executable": "Build/app.elf",
"name": "pyOCD PY32F003x4",
"preLaunchTask": "build",
"request": "launch",
"runToEntryPoint": "main",
"servertype": "pyocd",
"svdPath": "${workspaceFolder}/Misc/SVD/py32f003xx.svd",
"targetId": "py32f003x4",
"type": "cortex-debug",
},
{
"executable": "Build/app.elf",
"name": "pyOCD PY32F003x6",
"preLaunchTask": "build",
"request": "launch",
"runToEntryPoint": "main",
"servertype": "pyocd",
"svdPath": "${workspaceFolder}/Misc/SVD/py32f003xx.svd",
"targetId": "py32f003x6",
"type": "cortex-debug",
},
{
"executable": "Build/app.elf",
"name": "pyOCD PY32F003x8",
"preLaunchTask": "build",
"request": "launch",
"runToEntryPoint": "main",
"servertype": "pyocd",
"svdPath": "${workspaceFolder}/Misc/SVD/py32f003xx.svd",
"targetId": "py32f003x8",
"type": "cortex-debug",
},
{
"executable": "Build/app.elf",
"name": "pyOCD PY32F030x6",
"preLaunchTask": "build",
"request": "launch",
"runToEntryPoint": "main",
"servertype": "pyocd",
"svdPath": "${workspaceFolder}/Misc/SVD/py32f030xx.svd",
"targetId": "py32f030x6",
"type": "cortex-debug",
},
{
"executable": "Build/app.elf",
"name": "pyOCD PY32F030x8",
"preLaunchTask": "build",
"request": "launch",
"runToEntryPoint": "main",
"servertype": "pyocd",
"svdPath": "${workspaceFolder}/Misc/SVD/py32f030xx.svd",
"targetId": "py32f030x8",
"type": "cortex-debug",
},
{
"executable": "Build/app.elf",
"name": "pyOCD PY32F072xB",
"preLaunchTask": "build",
"request": "launch",
"runToEntryPoint": "main",
"servertype": "pyocd",
"svdPath": "${workspaceFolder}/Misc/SVD/py32f072xx.svd",
"targetId": "py32f072xb",
"type": "cortex-debug",
},
]
}
14 changes: 14 additions & 0 deletions .vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"C_Cpp.default.compileCommands": "${workspaceFolder}/Build/compile_commands.json",
"clangd.arguments": [
"--compile-commands-dir=Build",
"--query-driver=/usr/bin/arm-none-eabi-*",
],
"cmake.ignoreCMakeListsMissing": true,
"cortex-debug.gdbPath": "gdb-multiarch",
"cortex-debug.objdumpPath": "arm-none-eabi-objdump",
"debug.onTaskErrors": "abort",
"files.associations": {
"*.h": "c"
},
}
21 changes: 21 additions & 0 deletions .vscode/tasks.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"version": "2.0.0",
"tasks": [
{
"command": "bear --append --output Build/compile_commands.json -- make",
"detail": "Build default Makefile target",
"label": "build",
"problemMatcher": "$gcc",
"type": "shell",
},
{
"command": "mkdir -p Build && test -f Build/compile_commands.json || echo [] > Build/compile_commands.json",
"detail": "Create Build directory and empty compilation database",
"label": "init",
"runOptions": {
"runOn": "folderOpen"
},
"type": "shell",
},
]
}
52 changes: 11 additions & 41 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ Frequency up to 72 MHz, 128 Kbytes of Flash memory, 16 Kbytes of SRAM, with more
# File Structure

```
├── .vscode # Visual Studio Code tasks and launch settings
├── Build # Build results
├── Docs # Datesheets and User Manuals
├── Examples
│   ├── PY32F002B # PY32F002B examples
│   │   ├── HAL # HAL library examples
Expand All @@ -68,7 +68,6 @@ Frequency up to 72 MHz, 128 Kbytes of Flash memory, 16 Kbytes of SRAM, with more
│   ├── PY32F0xx_HAL_Driver # PY32F002A/003/030 HAL library
│   ├── PY32F0xx_LL_BSP # PY32F002A/003/030 LL BSP
│   └── PY32F0xx_LL_Driver # PY32F002A/003/030 LL library
|
├── Makefile # Make config
├── Misc
│   ├── Flash
Expand All @@ -95,7 +94,11 @@ Frequency up to 72 MHz, 128 Kbytes of Flash memory, 16 Kbytes of SRAM, with more

## 1. Install GNU Arm Embedded Toolchain

Download the toolchain from [Arm GNU Toolchain Downloads](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads) according to your pc architecture, extract the files
If possible, use your distribution's package manager to install the toolchain.
The `Makefile` and VS Code settings expect the compiler to be located in `/usr/bin`.

If your distribution does not provide the toolchain, download it from [Arm GNU Toolchain Downloads](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads) according to your architecture, then extract the files.
You will then need to adjust the path in the `Makefile` (and possibly the VS Code settings).

```bash
sudo mkdir -p /opt/gcc-arm/
Expand Down Expand Up @@ -218,44 +221,11 @@ make flash

# Debugging In VSCode

Install Cortex Debug extension, add a new configuration in launch.json, e.g.
```
{
"armToolchainPath": "/opt/gcc-arm/arm-gnu-toolchain-12.2.rel1-x86_64-arm-none-eabi/bin/",
"toolchainPrefix": "arm-none-eabi",
"name": "Cortex Debug",
"cwd": "${workspaceFolder}",
"executable": "${workspaceFolder}/Build/app.elf",
"request": "launch", // can be launch or attach
"type": "cortex-debug",
"runToEntryPoint": "Reset_Handler", // "main" or other function name. runToMain is deprecated
"servertype": "jlink", // jlink, openocd, pyocd, pe and stutil
"device": "PY32F030X8",
"interface": "swd",
"preLaunchTask": "build", // Set this to run a task from tasks.json before starting a debug session
// "preLaunchCommands": ["Build all"], // Uncomment this if not using preLaunchTask
"svdFile": "${workspaceFolder}/Misc/SVD/py32f030xx.svd", // svd for this part number
"showDevDebugOutput": "vscode", // parsed, raw, vscode:vscode log and raw
"swoConfig":
{
"enabled": true,
"cpuFrequency": 8000000, // Target CPU frequency in Hz
"swoFrequency": 4000000,
"source": "probe", // either be “probe” to get directly from the debug probe,
// or a serial port device to use a serial port external to the debug probe.
"decoders":
[
{
"label": "ITM port 0 output",
"type": "console",
"port": 0,
"showOnStartup": true,
"encoding": "ascii"
}
]
}
}
```
Install the Cortex-Debug extension (`marus25.cortex-debug`).

In "Run and Debug", select the appropriate launch configuration for your debugger and device.
Note that the `Makefile` determines the target chip for building.

If Cortex Debug cannot find JLinkGDBServerCLExe, add the following line to settings.json
```
"cortex-debug.JLinkGDBServerPath": "/opt/SEGGER/JLink/JLinkGDBServerCLExe",
Expand Down