《APM32芯得》系列內(nèi)容為用戶使用APM32系列產(chǎn)品的經(jīng)驗(yàn)總結(jié)，均轉(zhuǎn)載自21ic論壇極海半導(dǎo)體專區(qū)，全文未作任何修改，未經(jīng)原文作者授權(quán)禁止轉(zhuǎn)載。

概述

目前極海官方提供的 IDE 開(kāi)發(fā)環(huán)境有 Keil/IAR/Eclipse。都能很好的完成開(kāi)發(fā)，但是 VS Code 配合 CMake 工具是更加“現(xiàn)代”的C/C++開(kāi)發(fā)環(huán)境，本文提供了在 VS Code 環(huán)境下的開(kāi)發(fā)經(jīng)驗(yàn)，以供參考。

準(zhǔn)備工作

必需的軟件有：

cmake: 官網(wǎng) https://cmake.org

ninja: 官網(wǎng) https://ninja-build.org

VS Code：官網(wǎng) https://code.visualstudio.com

arm-clang 編譯套件，keil 自帶~

請(qǐng)從上述網(wǎng)站下載所需軟件，版本采用最新版即可。此外，為了更好的使用 VS Code，還需要安裝兩個(gè)擴(kuò)展：

C/C++ Extension Pack

CMake Tools

這里不再贅述擴(kuò)展的安裝方法。

Note:

ninja 的功能，也可以由 make 提供。

文件組織

為便于敘述，本文約定了如下的文件組織形式：

下面一一描述各項(xiàng)內(nèi)容：

.vscode 文件夾

VS Code 的配置文件夾。

cmake 文件夾

針對(duì)編譯器的必需文件。

G32R501_SDK 文件夾

G32R501 SDK 庫(kù)，直接使用極海官網(wǎng)提供的 SDK 庫(kù)。解壓縮文件時(shí)請(qǐng)確保文件層級(jí)與上文所列一致。

projects 文件夾

用戶項(xiàng)目文件夾。

子目錄需要滿足以下的目錄結(jié)構(gòu)：

├─INC --- 頭文件目錄

└─SRC --- C 文件 目錄

如果實(shí)際目錄結(jié)構(gòu)與上面的不一致，則需要修改 CMakeLists.txt 文件。

CMakeLists.txt 文件

CMake 構(gòu)建所必需的文件，下一節(jié)會(huì)詳細(xì)說(shuō)明。

詳細(xì)說(shuō)明

CMakeLists.txt 文件

CMake 構(gòu)建 C/C++ 工程，是從工程根目錄（或者指定的某個(gè)目錄）下的 CMakeLists.txt 文件開(kāi)始。CMakeLists.txt 描述了構(gòu)建工程的源代碼，編譯選項(xiàng)。CMake 工具根據(jù)這個(gè)文件生成 Makefile 或者 ninja.build 文件。最后由 make 工具或者 ninja 工具執(zhí)行編譯工作。

CMakeLists.txt 遵循 CMake 相關(guān)語(yǔ)法，具體可以參考官方說(shuō)明或者相應(yīng)教程。這里貼出了 CMakeLists.txt 的內(nèi)容。文中以“#”開(kāi)始的行為注釋行，可以參考注釋行理解相關(guān)內(nèi)容。

# Geehy, G32R5xx

cmake_minimum_required(VERSION 3.20)

cmake_policy(SET CMP0123 NEW)

project(g32r5xx_fw)

set(TARGET_NAME g32r5xx_fw)

# 檢查 SDK 目錄

set(SDK_ROOT G32R5xx_SDK)

get_filename_component(SDK_ROOT_ABS ${SDK_ROOT} ABSOLUTE)

if(NOT EXISTS ${SDK_ROOT_ABS})

message(FATAL_ERROR "SDK_ROOT: "${SDK_ROOT}" is not exists")

endif()

# 檢查 APP 目錄

get_filename_component(APP_ROOT_ABS ${APP_ROOT} ABSOLUTE)

if(NOT EXISTS ${APP_ROOT_ABS})

message(FATAL_ERROR "APP_ROOT: "${APP_ROOT}" is not exists")

endif()

# 檢查分散加載文件

set(SCATTER_FILE_ABS ${SDK_ROOT_ABS}/device_support/g32r501/common/sct/${SCATTER_FILE})

if(NOT EXISTS ${SCATTER_FILE_ABS})

message(FATAL_ERROR "SCATTER_FILE: "${SCATTER_FILE_ABS}" is not exists")

endif()

# 打印項(xiàng)目信息

message(STATUS "LIBRARY_TYPE: ${LIBRARY_TYPE}")

message(STATUS " SDK_ROOT: ${SDK_ROOT_ABS}")

message(STATUS " APP_ROOT: ${APP_ROOT_ABS}")

message(STATUS "SCATTER_FILE: ${SCATTER_FILE_ABS}")

# 編譯選項(xiàng)

set(MCPU_FLAGS "-mcpu=cortex-m52+cdecp0+pacbti -mfloat-abi=hard -fno-rtti -funsigned-char -fshort-enums -fshort-wchar -mlittle-endian -ffunction-sections")

set(CMAKE_C_FLAGS "${CMAKE_CXX_FLAGS} ${MCPU_FLAGS}")

set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${MCPU_FLAGS}")

set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} --strict --scatter ${SCATTER_FILE_ABS} --info summarysizes --map --load_addr_map_info --xref --callgraph --symbols --info sizes --info totals --info unused --info veneers --list project.map")

# 源碼

file(GLOB APP_SRC ${APP_ROOT_ABS}/source/*c)

add_executable(${TARGET_NAME}

${APP_SRC}

)

set_target_properties(${TARGET_NAME} PROPERTIES SUFFIX ".axf")

# 宏定義

target_compile_definitions(${TARGET_NAME} PRIVATE "-DG32R501_EVAL -D__CORE_CPU0__ -D__G32R501XX__ -D__G32R501__ -D__ARM_ARCH_8_1M_MAIN___ -D__ARM_TARGET_COPROC")

# include 目錄

target_include_directories(${TARGET_NAME} PRIVATE ${APP_ROOT}/INC)

target_include_directories(${TARGET_NAME} PRIVATE ${APP_ROOT}/include)

target_include_directories(${TARGET_NAME} PRIVATE ${SDK_ROOT_ABS}/device_support/g32r501/common/device/Geehy)

target_include_directories(${TARGET_NAME} PRIVATE ${SDK_ROOT_ABS}/device_support/g32r501/common/device/CMSIS/Core/Include)

target_include_directories(${TARGET_NAME} PRIVATE ${SDK_ROOT_ABS}/device_support/g32r501/common/device/Geehy/system_eval/include)

target_include_directories(${TARGET_NAME} PRIVATE ${SDK_ROOT_ABS}/device_support/g32r501/common/include)

target_include_directories(${TARGET_NAME} PRIVATE ${SDK_ROOT_ABS}/driverlib/g32r501/driverlib)

target_include_directories(${TARGET_NAME} PRIVATE ${SDK_ROOT_ABS}/driverlib/g32r501/driverlib/inc)

# SDK 源碼

file(GLOB_RECURSE CMSIS_SRC ${SDK_ROOT_ABS}/device_support/g32r501/common/device/Geehy/*.c)

target_sources(${TARGET_NAME} PRIVATE ${CMSIS_SRC})

file(GLOB DRIVERLIB_SRC ${SDK_ROOT_ABS}/driverlib/g32r501/driverlib/*.c)

target_sources(${TARGET_NAME} PRIVATE ${DRIVERLIB_SRC})

target_sources(${TARGET_NAME} PRIVATE ${SDK_ROOT_ABS}/device_support/g32r501/common/source/device.c)

# devicelib 類型項(xiàng)目必須添加的源碼

if(${LIBRARY_TYPE} STREQUAL "device_lib")

file(GLOB DEVICE_SUPPORT_SRC ${SDK_ROOT_ABS}/device_support/g32r501/common/source/*.c)

list(APPEND DEVICE_SUPPORT_SRC ${SDK_ROOT_ABS}/device_support/g32r501/common/g32r501_globalvariabledefs.c)

target_include_directories(${TARGET_NAME} PRIVATE ${SDK_ROOT_ABS}/device_support/g32r501/headers/include)

target_sources(${TARGET_NAME} PRIVATE ${DEVICE_SUPPORT_SRC})

endif()

# 生成 HEX 文件

add_custom_command(TARGET ${TARGET_NAME} POST_BUILD

COMMAND ${FROMELF_EXECUTABLE} --i32 --output ${TARGET_NAME}.hex [ DISCUZ_CODE_50 ]lt;TARGET_FILE:${TARGET_NAME}>

COMMENT "Creating HEX file")

# 生成 BIN 文件

add_custom_command(TARGET ${TARGET_NAME} POST_BUILD

COMMAND ${FROMELF_EXECUTABLE} --bin --output ${TARGET_NAME}.bin [ DISCUZ_CODE_50 ]lt;TARGET_FILE:${TARGET_NAME}>

COMMENT "Creating HEX file")

工程構(gòu)建

使用 CMake 搭建的開(kāi)發(fā)C/C++工程，編譯前需要先進(jìn)行配置（configure）再進(jìn)行編譯。

配置

執(zhí)行類似下面的命令行可以配置一個(gè)工程：

cmake -DCMAKE_BUILD_TYPE:STRING=Debug -DCMAKE_EXPORT_COMPILE_COMMANDS:BOOL=TRUE -DCMAKE_TOOLCHAIN_FILE:STRING=cmake/g32r501.cmake -DLIBRARY_TYPE:STRING=device_lib -DSCATTER_FILE:STRING=g32r501xe_cbus_flash.sct -DAPP_ROOT:STRING=projects/app1 -B_build -G Ninja

參數(shù)說(shuō)明：

CMAKE_EXPORT_COMPILE_COMMANDS:BOOL=TRUE 可選參數(shù)，用于生成 compile_commands.json 文件，便于 VS Code 開(kāi)發(fā)使用。

CMAKE_TOOLCHAIN_FILE:STRING=cmake/g32r501.cmake 必選參數(shù)，指定 MCU 是 g32r501。

CMAKE_BUILD_TYPE:STRING=Debug 構(gòu)建類型，可選的值有：Debug，Release，RelWithDebInfo 和 MinSizeRel，具體參考 cmake 文檔。

LIBRARY_TYPE:STRING=device_lib SDK 庫(kù)類型，可選值有：device_lib，driver_lib。

SCATTER_FILE:STRING=g32r501xe_cbus_flash.sct 分散加載文件的文件名，參考 G32R501_SDK*device_supportg32r501commonsct 目錄。

APP_ROOT:STRING=projects/app1 用戶項(xiàng)目目錄

打開(kāi)命令行窗口，切換到工程根目錄。執(zhí)行上述命令前，請(qǐng)先定義一個(gè)環(huán)境變量 ARMCLANG_PATH，值是 armclang.exe 所在目錄：

set ARMCLANG_PATH=C:UsersAppDataLocalKeil_v5ARMARMCLANGin

其中 C:UsersAppDataLocalKeil_v5ARMARMCLANGin 就是我的電腦上 ARM-CLANG 編譯器的目錄，請(qǐng)?zhí)鎿Q成實(shí)際值。

編譯

在命令行里執(zhí)行如下命令，就可以編譯整個(gè)工程：

ninja -C _build

編譯的固件會(huì)在 _build 文件夾下：g32r5xx_fw.hex 和 g32r5xx_fw.bin。

在 VS Code 里編輯和編譯

“一個(gè)小手術(shù)”

為了能讓 VS Code 更好地工作，我們?cè)诖蜷_(kāi) VS Code 前，先弄好 VS Code 的配置。在 .vsode 下，用文本編輯器創(chuàng)建 settings.json 文件，并寫(xiě)入如下內(nèi)容：

文件中cmake.configureArgs部分內(nèi)容與前文所述的“配置”部分大致相同，作用也就很明顯了。這些參數(shù)控制著 VS Code 更好的為我們工作。

經(jīng)過(guò)前面的步驟，就可以啟動(dòng) VS Code 打開(kāi)工程所在根目錄，就可以在 VS Code 里愉快地編碼了。

更便捷地使用 VS Code

VS Code 提供了“任務(wù)”機(jī)制能讓我們更好地進(jìn)行開(kāi)發(fā)。這里列舉作者認(rèn)為非常有助于提高效率的一個(gè)功能：實(shí)現(xiàn)“一鍵下載”。

點(diǎn)擊 VS Code 菜單【終端】→ 【配置任務(wù)...】，在彈出的下拉列表里，選擇【使用模板創(chuàng)建 tasks.json 文件】→ 【Others 運(yùn)行任意外部命令的示例】。操作完成后會(huì)在 .vscode 目錄下生成一個(gè) tasks.json 文件，并打開(kāi)。編輯這個(gè)文件：

tasks.json 文件里 tasks列表定義了若干可執(zhí)行的命令及響應(yīng)的命令參數(shù)。上述示例中名為 “Flash(MDK)” 的任務(wù)實(shí)際調(diào)用 keil 進(jìn)行燒錄；“Flash(JLINK)”任務(wù)是調(diào)用 JLink 進(jìn)行燒錄。

開(kāi)發(fā)人員可以照例編排其他任務(wù)以提高開(kāi)發(fā)效率。

附錄

CMakeLists.txt 一些語(yǔ)法

變量

set(TARGET_NAME g32r5xx_fw)

上面的 set 語(yǔ)句定義了一個(gè)名為 TARGET_NAME 的變量，賦值：g32r5xx_fw。需要使用變量的值，需要用 ${} 包含變量名，如：${TARGET_NAME}。

顯示/打印信息

message(FATAL_ERROR "SCATTER_FILE "${SCATTER_FILE}" is not exists")message(STATUS "TOP_DIR: ${TOP_DIR}")

message 可以在配置過(guò)程中顯示/打印一些信息。如果是 FATAL_ERROR 類型的信息，表明發(fā)生嚴(yán)重錯(cuò)誤，配置構(gòu)建過(guò)程立即結(jié)束，配置失敗。

獲取文件夾下的源文件列表

file(GLOB APP_SRC ${APP_ROOT}/SRC/*.c)file(GLOB_RECURSE APP_SRC ${APP_ROOT}/SRC/*.c)

第一句獲取 ${APP_ROOT}/SRC 目錄下全部的 C 代碼文件。第二句獲取 ${APP_ROOT}/SRC 目錄及其子目錄下全部的 C 代碼文件（遞歸）。

如果只是個(gè)別文件，可以這樣寫(xiě)：

set(APP_SRC ${APP_ROOT}/SRC/a.c ${APP_ROOT}/SRC/b.c ${APP_ROOT}/SRC/c.c)

一些內(nèi)置的變量

cmake 有一些有用的內(nèi)置變量：

CMAKE_SOURCE_DIR：指向頂級(jí) CMakeLists.txt 文件所在的目錄，也稱為源目錄。

CMAKE_BINARY_DIR：指向構(gòu)建目錄，即 CMake 構(gòu)建的輸出目錄。

CMAKE_CURRENT_LIST_DIR: 當(dāng)前 CMakeLists.txt 所在目錄。

CMAKE_BUILD_TYPE：指定構(gòu)建類型，如 Debug、Release、RelWithDebInfo 和 MinSizeRel。

/// 全文完

注：文章作者在原帖中提供了代碼文件，有需要請(qǐng)至原文21ic論壇