Ubuntu18.04 基于VSCode和STM32CubeMX搭建STM32开发环境

Step1:

  • 安装VSCode及其相应插件,其中VSCode的安装网上教程非常多,此处就不在赘述。插件选择C/C++(用于代码补全和智能提示等)和Cortex Debug(用于调试,如果对自己的编程能力有信心可以不装)。


    插件预览
  • 安装STM32CubeMX,同样网上教程比较多,在此不再赘述。值得注意的是,STM32CubeMX安装前需要有java环境,因此需要提前安装。
sudo apt-get install default-jre

Step2:

  • 安装编译工具链gcc-arm-embedded,其中包含了用于编译的arm-none-eabi-gcc和用于Debug的arm-none-eabi-gdb。
sudo add-apt-repository ppa:team-gcc-arm-embedded/ppa
sudo apt-get update
sudo apt-get install gcc-arm-embedded
  • 安装GDB Sever,该工具往下用于连接jlink或stlink,往上提供reset,halt,flash等常用功能,用于程序下载和调试。此处选用OpenOCD,使用方便且开源。
sudo apt-get install openocd

Step3:

  • 利用STM32CubeMX生成stm32工程,在Toolchain/IDE中记得选择Makefile。


    Makefile工程
  • 修改工程中Makefile文件,便于VSCode建立tasks调用程序下载和编译。在Makefile中最后可增加如下语句:
OPENOCD := openocd -f interface/jlink.cfg \
        -c 'transport select swd' \
        -f target/stm32f4x.cfg
# download your program
flash: all
    $(OPENOCD) -c init \
        -c 'reset halt' \
        -c 'flash write_image erase $(BUILD_DIR)/$(TARGET).elf' \
        -c 'reset run' \
        -c exit

注1:此时应该在Terminal中可以make flash直接一步编译并下载固件了。
注2:第一行-f表示的是选择jlink,如果不是jlink可以到OpenOCD的scripts目录下找(如stlink v2.1则可以改为openocd -f interface/stlink-v2-1.cfg),默认路径为/usr/share/openocd/scripts。第二行因为我的jlink仅支持swd模式,所以加上了,实际如果支持jtag模式是不需要的。第三行选择的是个人的芯片配置文件,同样可以在OpenOCD的scripts目录下找到,可根据自己选择的芯片进行修改。


target文件夹

Step4:

  • 用VSCode打开STM32CubeMX新建的工程文件夹,将C/C++插件配置一波(其实不配置也没关系,只不过会有很多红色波浪线让人看着非常不舒服),便于智能感知的使用,主要是编译器路径和宏定义的配置。如果gcc-arm-embedded安装正常,默认路径应该是/usr/bin/arm-none-eabi-gcc,也可以使用whereis查看:
smartfish@smartfish:~$ whereis arm-none-eabi-gcc
arm-none-eabi-gcc: /usr/bin/arm-none-eabi-gcc
  • VSCode快捷键Ctrl+Shift+p打开,搜索C/C++:Edit Configurations (UI),即可打开配置界面,在Compile path输入上一步的路径:


    Compile path的路径
  • 宏定义的配置,主要来源于Makefile文件中所使用的宏定义,将图中USE_HAL_DRIVER和STM32F405xx(记得去除-D,该处的宏定义实际与个人的工程有关,我使用的f405的芯片,所有会有STM32F405xx这一项)填入Defines中:


    Makefile中的宏定义

    Defines的配置
  • VSCode的tasks建立,同样使用Ctrl+Shift+p,输入Tasks:Configure Task,即可建立一套空的tasks模板,实际上建立tasks的目标就是为了一键build或者build&&download,如果愿意的话,直接在terminal中make和make flash也是可以的(反正Makefile也改好了)。下图是我个人所使用的task。
{
    // See https://go.microsoft.com/fwlink/?LinkId=733558 
    // for the documentation about the tasks.json format
    "version": "2.0.0",
    "tasks": [
        // 编译
        {
            "type": "shell",
            "label": "build all",
            "command": "make -j8",
            "problemMatcher": [
                "$gcc"
            ],
            "group": {
                "kind": "build",
                "isDefault": true
            }
        },
        // 清除编译
        {
            "type": "shell",
            "label": "clear all",
            "command": "make clean",
            "problemMatcher": []
        },
        // 全部重新编译
        {
            "type": "shell",
            "label": "rebuild all",
            "dependsOrder": "sequence",
            "dependsOn": [
                "clear all",
                "build all"
            ],
            "problemMatcher": [
                "$gcc"
            ]
        },
        // 仅下载
        {
            "type": "shell",
            "label": "flash it",
            "command": "make -j8 flash",
            "dependsOn":[
                "build all"
            ],
            "problemMatcher": []
        },
        // 编译并下载
        {
            "type": "shell",
            "label": "build and flash",
            "dependsOrder": "sequence",
            "dependsOn" :[
                "build all",
                "flash it"
            ],
            "problemMatcher": [
                "$gcc"
            ],
        }
    ]
}
  • task建立好后,Ctrl+Shift+b即可编译工程生成elf,bin和hex等文件。Ctrl+Shift+p后输入run task回车,选择flash it即可实现下载。


    成功编译

    成功下载

Step6:

  • Cortex Debug的配置相对较为简单。首先进入调试界面,选择Add Configuration,选择Cortex Debug,即可新建一套用于调试的launch模板。


    Debug配置的新建
选择Cortex Debug

launch模板
  • 修改上述模板,主要是"servertype"和"configFiles"。"servertype"选择“openocd”,"configFiles"根据个人的工程选择,Step3中的注2已经有过描述,此处不再赘述。由于我的jlink仅支持swd,因此此处会略有差异。


    支持jtag模式的配置
仅支持swd模式的配置

注1:此处添加了一个"preLaunchTask"和"runToMain"属性,前者是为了进入调试模式前先下载一波程序,后者则是跳过stm32启动代码,直接进入主函数开始调试。

  • 配置完成后,按下F5即可实现调试。如需在调试过程中查看相应寄存器配置,下载Cortex-Debug: Device Support Pack - ×××(如Cortex-Debug: Device Support Pack - STM32F1)插件即可。

Step7:

  • 完。

推荐阅读更多精彩内容