在Nordic nRF52项目中使用CMake

转载自外网，原文链接：https://www.nrbtech.io/blog/2020/1/4/using-cmake-for-nordic-nrf52-projects

CMake 是一款流行的 C/C++ 构建系统（根据其官网描述，它是一个“开源的、跨平台的工具家族，旨在构建、测试和打包软件”），我们在 NRB Tech 将其用于固件项目和跨平台库。CMake 也可与优秀的 C/C++ 集成开发环境（IDE）CLion 配合使用。Nordic 官方推荐并支持 Segger Embedded Studio 作为其首选 IDE，然而 CMake 能使依赖管理和单元测试变得更为简便。

例如，NRB Tech 常用的一种开发架构是：在固件、实用工具和应用程序之间共享一个或多个 C 语言库，以减少代码重复和错误，并确保关键代码得到充分的单元测试。使用 CMake 可以轻松管理此类库，根据需要生成 Makefile 或 Xcode 项目，并将其作为依赖项集成到其他 CMake 项目中。

Nordic 在其 SDK 中并未直接提供对 CMake 的支持，但它们的 Mesh SDK 使用了 CMake，这就让基于 Nordic SDK 的非 Mesh 项目使用CMake成为可能。

nRF5 CMake 脚本#

Nordic的Mesh SDK并非为构建外部的、自定义的非Mesh项目而设计，但通过一些外部支持，它可以用于此目的——这正是我们的 nRF5-cmake-scripts 项目所实现的：尽可能复用Mesh SDK的脚本，同时为其他所有功能定义自己的函数，包括添加Nordic Mesh SDK不具备的特性（例如添加引导加载程序目标和创建DFU软件包）。该项目还定义了可轻松集成Nordic SDK中众多库的函数。现在让我们尝试从头开始创建一个新项目。

环境搭建#

下载并安装 J-Link Software and Documentation Pack
下载并安装 Nordic command line tools
下载并安装 ARM GNU Toolchain

如果你使用的是Mac系统，你可以使用homebrew：

1
brew tap ArmMbed/homebrew-formulae
2
brew install arm-none-eabi-gcc

下载并安装 nrfutil
安装 CMake 和 Git

创建基于CMake的Nordic固件项目#

最终的项目可在此处查看。

首先，在终端/命令窗口中克隆基础项目以设置项目结构：

1
git clone --recurse-submodules https://github.com/NRB-Tech/nRF5-cmake-scripts-example-base.git .

运行一个脚本来清理项目，以便您自己使用（在Windows上，通过右键单击目录 > “Git Bash here”来在Git Bash中运行）：

1
# 确保文件有可执行权限
2
chmod +x ./cleanup.sh
3
./cleanup.sh

执行下面命令，它会拷贝示例项目中的CMakeLists.txt到当前目录：

1
cmake -E copy nRF5-cmake-scripts/example/CMakeLists.txt .

请注意：您可能还需要根据您的平台编辑此文件中的某些变量，假如 NRFJPROG、MERGEHEX、NRFUTIL 和 PATCH_EXECUTABLE 这些工具未配置在系统的 PATH 环境变量中，则需要手动指定它们的完整路径。

然后我们可以用脚本来下载依赖：

1
cmake -B cmake-build-download -G "Unix Makefiles" .
2
# Windows上使用:
3
# cmake -B cmake-build-download -G "MinGW Makefiles" .
4
cmake --build cmake-build-download/ --target download

从 SDK 示例项目中复制一些文件（对于 nRF52840 DK 开发板，请将 pca10040/s132 替换为 pca10056/s140）：

1
cmake -E copy toolchains/nRF5/nRF5_SDK_16.0.0_98a08e2/examples/ble_peripheral/ble_app_template/pca10040/s132/armgcc/ble_app_template_gcc_nrf52.ld src/gcc_nrf52.ld
2
cmake -E copy toolchains/nRF5/nRF5_SDK_16.0.0_98a08e2/examples/ble_peripheral/ble_app_template/pca10040/s132/config/sdk_config.h src/

此时，您可以在 CLion 或您选择的任意编辑器中打开项目并进行文件编辑、添加文件并编写源代码。

这里我们在 src/main.c 中添加一段简单的日志输出代码：

1
#include "nrf_log_default_backends.h"
2
#include "nrf_log.h"
3
#include "nrf_log_ctrl.h"
4

5
int main(void) {
6
    ret_code_t err_code = NRF_LOG_INIT(NULL);
7
    APP_ERROR_CHECK(err_code);
8

9
    NRF_LOG_DEFAULT_BACKENDS_INIT();
10

11
    NRF_LOG_INFO("Hello world");
12
    while(true) {
13
        // do nothing
14
    }
15
}

创建一个 src/app_config.h 文件，用于覆盖 sdk_config.h 中的部分默认配置：

1
#define NRF_LOG_BACKEND_RTT_ENABLED 1 // 开启RTT
2
#define NRF_LOG_BACKEND_UART_ENABLED 0 // 关闭UART
3
#define NRF_LOG_DEFERRED 0 // 立即刷新日志
4
#define NRF_LOG_ALLOW_OVERFLOW 0 // 不打印溢出日志
5
#define SEGGER_RTT_CONFIG_DEFAULT_MODE 2 // 阻塞直到处理完成

我们还需要集成 DFU 引导加载程序，因此需要生成密钥。请在终端/命令提示符中执行以下操作：

1
nrfutil keys generate keys/dfu_private.key
2
nrfutil keys display --key pk --format code keys/dfu_private.key --out_file keys/dfu_public_key.c

现在我们需要创建 src/CMakeLists.txt 文件来构建我们的目标项目。

1
set(NRF5_LINKER_SCRIPT ${CMAKE_CURRENT_SOURCE_DIR}/gcc_${NRF_FAMILY})
2

3
# DFU 配置
4
# 列出之前使用过的softdevice版本，若没有，则使用“FALSE”
5
set(PREVIOUS_SOFTDEVICES FALSE)
6
# 设置DFU密钥位置
7
set(PRIVATE_KEY ${CMAKE_CURRENT_SOURCE_DIR}/../keys/dfu_private.key)
8
set(PUBLIC_KEY ${CMAKE_CURRENT_SOURCE_DIR}/../keys/dfu_public_key.c)
9
# 设置应用验证类型 [NO_VALIDATION|VALIDATE_GENERATED_CRC|VALIDATE_GENERATED_SHA256|VALIDATE_ECDSA_P256_SHA256]
10
set(APP_VALIDATION_TYPE NO_VALIDATION)
11
# 设置SoftDevice验证类型. [NO_VALIDATION|VALIDATE_GENERATED_CRC|VALIDATE_GENERATED_SHA256|VALIDATE_ECDSA_P256_SHA256]
12
set(SD_VALIDATION_TYPE NO_VALIDATION)
13
# 引导加载程序版本（用户定义）
14
set(BOOTLOADER_VERSION 1)
15
# DFU 版本 (固件版本) 字符串
16
set(DFU_VERSION_STRING "${VERSION_STRING}")
17

18
# 设置Target名称
19
set(target example)
20

21
# 添加此示例所需的库
22
nRF5_addLog()
23
nRF5_addSeggerRTT()
24
nRF5_addAppError()
25

26
# include files
27
list(APPEND SOURCE_FILES
28
        main.c
29
        )
30
list(APPEND INCLUDE_DIRS
31
        "${CMAKE_CURRENT_SOURCE_DIR}"
32
        )
33

34
nRF5_addExecutable(${target} "${SOURCE_FILES}" "${INCLUDE_DIRS}" "${NRF5_LINKER_SCRIPT}")
35

36
# sdk_config.h 导入 app_config.h
37
target_compile_definitions(${target} PRIVATE USE_APP_CONFIG)
38

39
# 处理BootLoader中的用户预定义变量
40
set(bootloader_vars "")
41

42
# add the secure bootloader build target
43
nRF5_addSecureBootloader(${target} "${PUBLIC_KEY}" "${bootloader_vars}")
44
# add the bootloader merge target
45
nRF5_addBootloaderMergeTarget(${target} ${DFU_VERSION_STRING} ${PRIVATE_KEY} ${PREVIOUS_SOFTDEVICES} ${APP_VALIDATION_TYPE} ${SD_VALIDATION_TYPE} ${BOOTLOADER_VERSION})
46
# add the bootloader merged flash target
47
nRF5_addFlashTarget(bl_merge_${target} "${CMAKE_CURRENT_BINARY_DIR}/${target}_bl_merged.hex")
48
# Add the Bootloader + SoftDevice + App package target
49
nRF5_addDFU_BL_SD_APP_PkgTarget(${target} ${DFU_VERSION_STRING} ${PRIVATE_KEY} ${PREVIOUS_SOFTDEVICES} ${APP_VALIDATION_TYPE} ${SD_VALIDATION_TYPE} ${BOOTLOADER_VERSION})
50
# Add the App package target
51
nRF5_addDFU_APP_PkgTarget(${target} ${DFU_VERSION_STRING} ${PRIVATE_KEY} ${PREVIOUS_SOFTDEVICES} ${APP_VALIDATION_TYPE})
52

53
# print the size of consumed RAM and flash - does not yet work on Windows
54
if(NOT ${CMAKE_HOST_SYSTEM_NAME} STREQUAL "Windows")
55
    nRF5_print_size(${target} ${NRF5_LINKER_SCRIPT} TRUE)
56
endif()

至此，我们已经准备好构建并运行示例项目。首先，请运行 JLink 工具以获取 RTT 输出：

1
cmake -Bcmake-build-debug -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Debug .
2
# Windows，使用：
3
# cmake -B cmake-build-debug -G "MinGW Makefiles" -D CMAKE_BUILD_TYPE=Debug .
4
# 如果报编译器未找到的错误，请确保环境变量配置正确 (运行 `arm-none-eabi-gcc` 来检查是否已配置正确)
5
cmake --build cmake-build-debug/ --target START_JLINK_RTT

接下来，构建并烧录目标固件：

1
cmake --build cmake-build-debug/ --target flash_bl_merge_example

您现在应该能在 RTT 控制台中看到 “Hello world” 日志输出了！至此，您可以通过 nRF5-cmake-scripts/includes/libraries.cmake 文件中提供的宏来添加源代码并集成 SDK 库。

NRB Tech 运用 CMake 构建经过充分测试的产品，并充分利用跨平台代码的优势。如果您正在规划新产品开发，或希望参与多样化的跨平台产品研发，欢迎与我们联系。

一些关联的项目#

nrf5-sdk-clion

你可以将以下代码另存为nrf5-sdk-to-clion.sh，然后放在nRF5 SDK根目录执行。

它会为所有SDK中的实例项目创建好CMakeList.txt文件：

1
#!/usr/bin/env bash
2

3
#Copyright 2017 Jumper Labs Ltd.
4

5
#Licensed under the Apache License, Version 2.0 (the "License");
6
#you may not use this file except in compliance with the License.
7
#You may obtain a copy of the License at
8
#
9
#    http://www.apache.org/licenses/LICENSE-2.0
10
#
11
#Unless required by applicable law or agreed to in writing, software
12
#distributed under the License is distributed on an "AS IS" BASIS,
13
#WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
#See the License for the specific language governing permissions and
15
#limitations under the License.
16

17
set -e
18

19
tmp_makefile="/tmp/CMakeLists-generator.mk"
20

21
\cat << 'EOF' > ${tmp_makefile}
22
include Makefile
23

24
generate:
25
  $(foreach var, PROJECT_NAME SDK_ROOT PROJ_DIR SRC_FILES INC_FOLDERS CFLAGS CXXFLAGS, \
26
    echo "set($(var) $($(var)))" ; \
27
    echo ; \
28
  )
29

30
  @echo 'cmake_minimum_required(VERSION 2.4.0)'
31
  @echo 'project($$$ {PROJECT_NAME})'
32

33
  @echo 'list(APPEND CFLAGS "-undef" "-D__GNUC__")'
34
  @echo 'list(FILTER CFLAGS EXCLUDE REGEX mcpu)'
35
  @echo 'string(REPLACE ";" " " CFLAGS "$$$ {CFLAGS}")'
36
  @echo 'set(CMAKE_C_FLAGS $$$ {CFLAGS})'
37

38
  @echo 'include_directories($$$ {INC_FOLDERS})'
39
  @echo 'add_executable($$$ {PROJECT_NAME} $$$ {SRC_FILES})'
40
EOF
41

42
\echo "cmake_minimum_required(VERSION 2.8.9)" > CMakeLists.txt
43

44
for makefile in `\find ./examples -name Makefile` ; do
45
    dir=`\dirname ${makefile}`
46
    \echo "Creating CMakeLists.txt for ${makefile}"
47
    \pushd ${dir} > /dev/null
48
    \make -s -f ${tmp_makefile} generate > CMakeLists.txt
49
    \popd > /dev/null
50
    \echo "#add_subdirectory(${dir})" >> CMakeLists.txt
51
done
52
\rm ${tmp_makefile}
53

54
echo '************************************'
55
echo 'Enjoy using CLION with the NRF5-SDK!'
56
echo '************************************'