STM32-CMake 项目技术文档

1. 安装指南

环境要求

• cmake 版本 >= 3.16
• GCC 工具链（可选 newlib）
• 适用于相应 STM32 系列的 STM32Cube 包

安装步骤

1. 克隆项目仓库到本地：

   git clone https://github.com/ObKo/stm32-cmake.git
   

2. 配置 CMake 工具链和库路径。可以通过以下三种方式之一进行配置：

   • 在运行 cmake 命令时通过命令行传递变量，例如：

     cmake -DSTM32_TOOLCHAIN_PATH=/path/to/toolchain ..
     

   • 在 CMakeLists.txt 文件中设置变量。

   • 通过环境变量设置变量。

3. 设置必要的配置选项，例如：

   export STM32_CUBE_F4_PATH=/path/to/STM32CubeF4
   

4. 使用 cmake 构建：

   cmake --build .
   

2. 项目的使用说明

本项目提供了用于开发 STM32 应用程序的 CMake 支持。项目包含了以下内容：

• CMake 工具链文件，用于配置 CMake 使用 arm 工具链。
• CMake 模块，包含有用的函数。
• 每个系列的 CMake 模块，包含关于 RAM/Flash 大小、CPU 类型、设备类型和设备命名的信息。
• CMake 工具链文件，用于生成可调整的链接脚本。
• 查找和配置 CMSIS 库的 CMake 模块。
• 查找和配置 STM32 HAL 库的 CMake 模块。
• 用于各种库和 RTOS 的 CMake 模块。
• CMake 项目模板和示例。
• 用于检查 cmake 脚本是否正常工作的测试项目。

3. 项目 API 使用文档

项目的核心功能是通过 CMake 模块和工具链文件实现的。以下是关键 API 的使用方法：

• find_package(CMSIS REQUIRED)：查找 CMSIS 库，可以指定 STM32 系列或具体设备。

• target_link_libraries(<target> CMSIS::STM32::<device>)：将 CMSIS 库链接到目标。

• stm32_add_linker_script(<path>)：添加自定义链接脚本。

4. 项目安装方式

项目的安装方式主要是通过 CMake 进行。以下是安装步骤：

1. 确保已安装所需的环境依赖（cmake、GCC、STM32Cube 包）。

2. 克隆项目仓库。

3. 配置 CMake 变量。

4. 运行 cmake 命令来生成构建系统。

5. 使用 cmake 构建项目。

通过以上步骤，用户可以快速地搭建起 STM32 的开发环境，并利用项目提供的模板和示例来开始开发。