Преглед изворни кода

[bsp][stm32] optimize docs

SummerGift пре 6 година
родитељ
комит
62efbf86de

+ 8 - 8
bsp/stm32/docs/STM32系列BSP制作教程.md

@@ -204,9 +204,9 @@ BSP 的制作过程分为如下五个步骤:
 
 重新生成工程需要使用 env 工具。
 
-#### 3.5.1 重新生成 rt_config.h 文件
+#### 3.5.1 重新生成 rtconfig.h 文件
 
-在 env 界面输入命令 menuconfig 对工程进行配置,并生成新的 rt_config.h 文件。如下图所示:
+在 env 界面输入命令 menuconfig 对工程进行配置,并生成新的 rtconfig.h 文件。如下图所示:
 
 ![输入menuconfig进入配置界面](./figures/menuconfig_1.png)
 
@@ -243,8 +243,7 @@ STM32 BSP 的制作规范主要分为 3 个方面:工程配置,ENV 配置和
 
 - 遵从RT-Thread 编码规范,代码注释风格统一
 - main 函数功能保持一致
-  - 如果有 LED 的话,main 函数里只放一个 LED 1HZ 闪烁的程序
-  - LED_PIN 定义在 board.h,初始化在 board.c 完成
+  - 如果有 LED 的话,main 函数里**只放一个**  LED 1HZ 闪烁的程序
 - 在 `rt_hw_board_init` 中需要完成堆的初始化:调用 `rt_system_heap_init`
 - 默认只初始化 GPIO 驱动和 FinSH 对应的串口驱动,不使用 DMA
 - 当使能板载外设驱动时,应做到不需要修改代码就能编译下载使用
@@ -271,10 +270,11 @@ STM32 BSP 的制作规范主要分为 3 个方面:工程配置,ENV 配置和
 
 ### 2. BSP 提交规范
 
-- 基础 BSP 和驱动应该分开提交
-- 基础 BSP 包括串口驱动和 GPIO 驱动,能运行 FinSH 控制台
-- 不同的驱动也要分开提交,方便 review 和合并
-- 只提交 BSP 必要的文件,删除无关的中间文件
+- 提交前请认真修改 BSP 的 README.md 文件,README.md 文件的外设支持表单只填写 BSP 支持的外设,可参考其他 BSP 填写。查看文档[《STM32系列驱动介绍》](./STM32系列驱动介绍.md)了解驱动分类。
+- 提交 BSP 分为 2 个阶段提交:
+  - 第一阶段:基础 BSP 包括串口驱动和 GPIO 驱动,能运行 FinSH 控制台。完成 MDK4、MDK5 、IAR 和 GCC 编译器支持,如果芯片不支持某款编译器(比如MDK4)可以不用做。 BSP 的 README.md 文件需要填写第二阶段要完成的驱动。
+  - 第二阶段:完成板载外设驱动支持,所有板载外设使用 menuconfig 配置后就能直接使用。若开发板没有板载外设,则此阶段可以不用完成。不同的驱动也要分开提交,方便 review 和合并。
+- 只提交 BSP 必要的文件,删除无关的中间文件,能够提交的文件请对照其他 BSP。
 - 提交 stm32 不同系列的 Library 库时,请参考 f1/f4 系列的 HAL 库,删除多余库文件
 - 提交前要对 BSP 进行编译测试,确保在不同编译器下编译正常
 - 提交前要对 BSP 进行功能测试,确保 BSP 的在提交前符合工程配置章节中的要求

+ 1 - 1
bsp/stm32/docs/STM32系列BSP外设驱动使用教程.md

@@ -1,4 +1,4 @@
-# BSP 进阶使用指南
+# BSP 外设驱动使用教程
 
 ## 简介
 

+ 1 - 1
bsp/stm32/docs/STM32系列外设驱动添加指南.md

@@ -37,7 +37,7 @@
 
 > 为 BSP 添加驱动时,STM32CubeMX 工具可以快速的完成**使能外设**和**配置管脚**的工作。而外设初始化,中断配置,DMA配置等等则由 RT-Thread 提供的驱动文件来完成。也就是说,虽然 STM32CubeMX 生成了多个文件用来初始化外设,但 RT-Thread 只使用了 STM32CubeMX  生成的 `stm32fxx_hal_msp.c` 文件和 `stm32fxx_hal_conf.h` 文件。
 >
-> 对于不同的外设驱动,通过 STM32CubeMX 工具配置的内容也不一样。开发者可以参考本文档的附录 [CubeMX配置说明]() 章节来了解不同外设的配置方法。
+> 对于不同的外设驱动,通过 STM32CubeMX 工具配置的内容也不一样。开发者可以参考本文档的附录 CubeMX 配置说明章节来了解不同外设的配置方法。
 
 ### 3)修改 Kconfig 文件
 

BIN
bsp/stm32/docs/figures/board_h.png