vscode搭建STM32開發環境的詳細過程

Posted on by

需要安裝的軟件

 vscode

必裝插件：

  • C/C++：用於提供高亮顯示和代碼補全
  • Cortex-Debug：用於提供調試配置

make

make工具可以直接下載xPack項目提供的windows-build-tools工具裡面帶瞭make工具。

Release xPack Windows Build Tools v4.2.1-2 · xpack-dev-tools/windows-build-tools-xpack (github.com)

openocd

arm-none-eabi

stm32CubeMX

上述軟件具體的安裝教程網上有很多詳細的介紹資料，這裡就不詳細介紹瞭。需要註意的是記得將make,openocd,arm-none-eabi等可執行程序的路徑添加到環境變量中

以下章節的內容都是根據stm32CubeMX生成的vscode_stm32f411 Makefile工程為例子來進行講解的。

配置開發環境

實際上就是打造代碼的編輯環境，實現類似於keil中編輯代碼和代碼補全等功能。在通過vscode打開vscode_stm32f411文件夾後，其實已經具備瞭編輯和代碼補全功能（前提是必裝的插件已經安裝好），隻是會有很多報錯的波浪線，這時候便需配置c_cpp_properties.json文件來解決源文件的各種報錯提示：

如果提示**uint32_t是未定義的類型**在defines下添加__GNUC__

c_cpp_properties.json文件：

{
    "configurations": [
        {
            "name": "Win32",
            "includePath": [
                "${workspaceFolder}/**"
            ],
            "defines": [
                "_DEBUG",
                "UNICODE",
                "_UNICODE",
                "USE_HAL_DRIVER", //
                "STM32F411xE", //
                "__GNUC__" //
            ],
            // "compilerPath": "C:\\Program Files\\LLVM\\bin\\clang.exe",
            "compilerPath": "C:/Program Files (x86)/GNU Tools Arm Embedded/7 2018-q2-update/bin/arm-none-eabi-gcc.exe",
            "cStandard": "c17",
            "cppStandard": "c++14",
            // "intelliSenseMode": "windows-clang-x64"
            "intelliSenseMode": "gcc-arm"
        }
    ],
    "version": 4
}

配置編譯下載功能

新建task.json文件

{
    // See https://go.microsoft.com/fwlink/?LinkId=733558
    // for the documentation about the tasks.json format
    "version": "2.0.0",
    "tasks": [
        {
            "label": "build",
            "type": "shell",
            "command": "make",
            "args": [
              "-j4"
            ],
            "group": { //group用於將當前任務設置為默認的build任務，可以直接通過Ctrl+Shift+B直接執行
              "kind": "build",
              "isDefault": true
            },
            "problemMatcher":[
              "$gcc"
            ]
        },
        {
          "label": "clean",
          "type": "shell",
          "command": "make",
          "args": [
            "clean"
          ]
        },
        {
            "label": "flash - ST-Link", //用於執行makefile文件中實現的下載指令
            "type": "shell",
            "command": "make flash",
            "problemMatcher": []
        },
        {
          "label": "download", //下載並運行
          "type": "shell",
          "command": "openocd",
          "args": [
            "-f",
            "interface/stlink-v2.cfg",
            "-f",
            "target/stm32f4x.cfg",
            "-c",
            "program build/vscode_stm32f411.elf verify reset exit" //TODO：這裡的下載文件的路徑不能夠用${workspaceFolder}來指定
          ],
          "dependsOn":"build", //download任務的依賴任務，即download任務執行前會先執行build任務
        },
        {
          "label": "reset", //復位程序
          "type": "shell",
          "command":"openocd",
          "args": [
            "-f",
            "interface/stlink-v2.cfg",
            "-f",
            "target/stm32f4x.cfg",
            "-c init",
            "-c reset",
            "-c exit",
          ],
          "problemMatcher": []
        },
        {
          "label": "halt", //掛起程序
          "type": "shell",
          "command":"openocd",
          "args": [
            "-f",
            "interface/stlink-v2.cfg",
            "-f",
            "target/stm32f4x.cfg",
            "-c init",
            "-c halt",
            "-c exit",
          ],
          "problemMatcher": []
        },
        {
          "label": "run", //運行程序
          "type": "shell",
          "command":"openocd",
          "args": [
            "-f",
            "interface/stlink-v2.cfg",
            "-f",
            "target/stm32f4x.cfg",
            "-c init",
            "-c resume",
            "-c exit",
          ],
          "problemMatcher": []
        },
    ]
}

build任務用於編譯工程（實質上是執行makefile文件 make）

clean任務用於清除編譯生成的中間文件（實質是執行makefile文件中的 make clean）

flash - ST-Link任務用於下載代碼到STM32芯片中，這裡需要在makefile中添加flash偽目標,偽目標flash實現如下：

#flash the stm32
OPENOCD := openocd -f interface/stlink-v2.cfg -f target/stm32f4x_stlink.cfg
FIRMWARE = $(BUILD_DIR)/vscode_stm32f411.elf

flash:
	$(OPENOCD) -c init \
		-c 'reset halt' \
		-c 'flash write_image erase $(FIRMWARE)' \
		-c 'reset run' \
		-c exit

download任務用於下載代碼到STM32芯片中，這裡是完全在tasks.json文件中實現的（通過openocd實現下載目標文件）

reset任務用於復位目標板程序

halt任務用於掛起目標板程序

run任務用於運行掛起的目標程序

配置調試功能

添加launch.json文件配置調試環境

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [  
        {
            "name": "Cortex Debug",
            "cwd": "${workspaceRoot}",
            "executable": "${workspaceRoot}/build/vscode_stm32f411.elf",
            "request": "launch",
            "type": "cortex-debug",
            "servertype": "openocd",
            "device": "STM32F411xx",
            "interface": "swd",
            "configFiles": [
                "${workspaceRoot}/openocd.cfg"
            ],
            "runToMain": true,
            "showDevDebugTimestamps": true,
            "svdFile": "${workspaceRoot}/STM32F411xx.svd", //需要查看外設寄存器的值必須指定該svd文件
        }
    ]
}

工作空間目錄下添加openocd.cfg文件，文件內容如下：

source [find interface/stlink-v2.cfg]

source [find target/stm32f4x_stlink.cfg]

到此出已經可以執行F5經行調試瞭。

註意：這裡必須執行make指令後才能進行調試，否則不能夠正常調試

​ 為瞭確保每次執行調試時工程都是最新編譯過的，可以在launch.json文件中添加"preLaunchTask": "build"的配置。preLaunchTask表示調試前執行的任務，build是指task.json文件中標簽為build的任務（註意launch.json文件中的任務名字必須和task.json文件中的標簽名一致）。

​ 為瞭確保每次調試結束後目標板上的程序還能繼續運行，可以在launch.json文件中添加"postDebugTask": "run"的配置，這樣可以在調試結束後執行task.json文件中的run任務以確保目標板上的程序還能繼續運行。

完整的launch.json文件如下：

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [  
        {
            "name": "Cortex Debug",
            "cwd": "${workspaceRoot}",
            "executable": "${workspaceRoot}/build/vscode_stm32f411.elf",
            "request": "launch",
            "type": "cortex-debug",
            "servertype": "openocd", //要選擇的GDB server
            // "device": "STM32F411xx", //
            "interface": "swd",
            "configFiles": [
                // "${workspaceRoot}/openocd.cfg"
                "interface/stlink-v2.cfg",
                "target/stm32f4x.cfg"
            ],
            "runToMain": true,
            "showDevDebugTimestamps": true,
            "svdFile": "${workspaceRoot}/STM32F411xx.svd",
            "preLaunchTask": "build", //調試之前運行的任務（調試之前一定要確保工程被編譯過）
            "postDebugTask": "run", //調試結束後運行程序，沒有的化會導致程序調試結束後處於掛起狀態
        }
    ]
}

細心的同學可能會註意到，這裡的launch.json文件和上面的該文件在configFiles位置處也有一些區別：

采用這裡的這種寫法可以不用在工作文件夾目錄下新建openocd.cfg文件，不過這種方式在命令行中直接輸入openocd便會報錯。

小知識點：在終端中啟動openocd時，會自動在當前目錄下尋找openocd.cfg的文件作為配置文件

到此這篇關於vscode搭建STM32開發環境的詳細過程的文章就介紹到這瞭,更多相關vscode搭建STM32開發環境內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：