如何在嵌入式（RP2040）项目结构中正确使用CMake？

Question

TL;DR

如何以优雅的方式将 CMakeLists.txt 与包含的项目级库一起使用？

简介

亲爱的堆栈用户，

在开始使用手动创建的构建系统（之前使用预配置的 STM32CubeIDE、SW4STM32 和 MSP430 CCS）的旅程后不久，我在使用 Raspberry RP2040 时遇到了这个问题，我偶然发现了一项艰巨的（主观）任务：以更明智的方式使用 CMake。通过查看大量教程、提示和问题（以及 Pico 项目生成器），我已经成功构建了我的简单项目。但我觉得这是以相当临时的方式完成的。

环境

情况如何： 我有一个使用 RP2040 picoSDK 的项目 - 外围配置函数的集合，存储在项目目录之外的某种 HAL。将 picoSDK 视为外部库函数。使用此 picoSDK，我创建了一个使用多个外围设备的简单应用程序。我将我的项目分为以下结构： 项目结构

我的文件之间的连接如下： 文件关系，其中我的 main.c 文件使用其中一个模块，而模块使用两个外围设备。所有这些文件都需要访问全局定义，并包含来自 common.h 文件的 picoSDK。

为了清楚起见，我在 Windows 10 上使用 VS code，我使用 arm-gcc 10.3.1 进行编译，我的 CMake 版本是 3.20.6

问题和当前解决方案

现在，我一直在尝试使用该方法（在此线程中建议：CMake with subdirectories）在每个目录中使用多个 CMakeLists.txt 创建基于目录的库，然后使用顶级 CMakeLists.txt 内的 add_subdirectory() 添加它们，但没有成功。我已经按照以下方式完成了工作的 CMakeLists.txt：

cmake_minimum_required(VERSION 3.13)

# [Platfrom specific command] Pull in Raspberry Pi Pico SDK (must be before project)
include(pico_sdk_import.cmake)

project(ProjectName C CXX ASM)

# [Platfrom specific command] Initialize the Raspberry Pi Pico SDK
pico_sdk_init()

set(sources main.c
            Common.h
            Peripherals/PeripheralA.c
            Peripherals/PeripheralA.h
            Peripherals/PeripheralB.c
            Peripherals/PeripheralB.h
            Modules/ModuleSource.c
            Modules/ModuleSource.h
            Modules/ModuleConfig.h)
            
# Create executable with specified sources
add_executable(ProjectName ${sources})

# Add the standard library to the build (picoSDK inclusion)
target_link_libraries(ProjectName pico_stdlib)

# Add any user requested libraries (a part of picoSDK)
target_link_libraries( ProjectName
        hardware_timer
        )

免责声明：针对特定情况留下了平台特定行的添加，在这种情况下，这个问题落入了精通 RP2040 的人手中

现在的问题

，我'我觉得嵌入式领域有点不同，因为我的项目的每个部分（外设、模块甚至主文件）都需要访问基础：用于驱动微控制器的库（此处为 picoSDK），因此我想问：建议的方法是什么，CMakeLists.txt内容的概要是什么？我确信该项目将会增长，并且根据其他回复，不建议将所有内容保留在一个 CMakeLists.txt 文件中。

我正在寻找提示、好的建议和批评。我非常感谢花时间阅读这篇文章，或者——当然——回复它。如果这个问题涉及一些琐碎的、已经回答的或从熟练的用户角度来看毫无意义的问题 - 请接受我的歉意。

Answer 1

我能给你的最好建议是将代码组织到库中。它将解耦代码并为单元测试、模拟、代码重用等提供机会。

您绝对应该避免依赖外设和模块中的 common.h。

下面是如何创建库并将库相互链接以及与主项目链接的示例。

顶级 CMakeLists.txt

cmake_minimum_required(VERSION 3.13)

# [Platfrom specific command] Pull in Raspberry Pi Pico SDK (must be before project)
include(pico_sdk_import.cmake)

project(ProjectName C CXX ASM)

# [Platfrom specific command] Initialize the Raspberry Pi Pico SDK
pico_sdk_init()

# Create executable with specified sources
add_executable(ProjectName main.c)

add_subdirectory(Modules)
add_subdirectory(Peripherals)

# Peripherals depend on pico_stdlib only.
target_link_libraries(Peripherals PUBLIC pico_stdlib)

# Modules depend on peripherals only.
target_link_libraries(Modules PUBLIC Peripherals)

# Link direct dependencies of the project.
target_link_libraries(ProjectName
    PRIVATE
        Modules
        hardware_timer
)

外围设备/CMakeLists.txt

project(Peripherals)

add_library(${PROJECT_NAME})

target_include_directories(${PROJECT_NAME} ${PROJECT_SOURCE_DIR})

target_sources(${PROJECT_NAME}
    PRIVATE
        Peripherals/PeripheralA.c
        Peripherals/PeripheralA.h
        Peripherals/PeripheralB.c
        Peripherals/PeripheralB.h
)

模块/CMakeLists.txt

project(Modules)

add_library(${PROJECT_NAME})

target_include_directories(${PROJECT_NAME} ${PROJECT_SOURCE_DIR})

target_sources(${PROJECT_NAME}
    PRIVATE
        Modules/ModuleSource.c
        Modules/ModuleSource.h
        Modules/ModuleConfig.h
)