[bsp][STM32] optimize stm32 BSP docs

bsp/stm32/README.md

@@ -3,7 +3,7 @@
 STM32 系列 BSP 目前支持情况如下表所示：
 
 | 文件夹名称                | 开发板名称                 |
-| ------------------------- | -------------------------- |
+|:------------------------- |:-------------------------- |
 | stm32f103-atk-nano        | 正点原子 F103 NANO 开发板  |
 | stm32f103-fire-arbitrary  | 野火 F103  霸道开发板      |
 | stm32f407-atk-explorer    | 正点原子 F407 探索者开发板 |
@@ -12,9 +12,9 @@ STM32 系列 BSP 目前支持情况如下表所示：
 
 了解每个 BSP 的详细情况可以阅读该 BSP 下的 readme 文件，如需使用 BSP 更多功能可参考 docs 文件夹下提供的说明文档：
 
-| 文档名称             | 简介                                              |
-| -------------------- | ------------------------------------------------- |
-| BSP 进阶使用指南     | 介绍如何使用 BSP 提供的高级功能以及添加更多新功能 |
-| STM32系列BSP添加教程 | 介绍如何添加一个新的 STM32 系列的 BSP             |
-| STM32系列BSP制作规范 | 介绍一个新 STM32 系列 BSP 的制作规范              |
+| 文档名称            | 简介                                              |
+|:-------------------- |:------------------------------------------------- |
+| [BSP 进阶使用指南](docs/BSP进阶使用指南.md)     | 介绍如何使用 BSP 提供的高级功能以及添加更多新功能 |
+| [STM32系列BSP添加教程](docs/STM32系列BSP添加教程.md) | 介绍如何添加一个新的 STM32 系列的 BSP             |
+| [STM32系列BSP制作规范](docs/STM32系列BSP制作规范.md) | 介绍一个新 STM32 系列 BSP 的制作规范              |
 

bsp/stm32/libraries/templates/stm32f10x/README.md

@@ -38,13 +38,12 @@
 本 BSP 目前对外设的支持情况如下：
 
 | **板载外设**      | **支持情况** | **备注**                              |
-| ----------------- | :----------: | ------------------------------------- |
+| :----------------- | :----------: | :------------------------------------- |
 | USB 转串口        |     支持     |                                       |
 | SPI Flash         |     支持     |                                       |
 | 以太网            |     支持     |                                       |
 | SD卡              |   暂不支持   |                                       |
 | CAN               |   暂不支持   |                                       |
-| ...               |             |                                       |
 | **片上外设**      | **支持情况** | **备注**                              |
 | GPIO              |     支持     | PA0, PA1... PK15 ---> PIN: 0, 1...176 |
 | UART              |     支持     | UART1/x/x                             |
@@ -56,8 +55,7 @@
 | USB Device        |   暂不支持   | 即将支持                              |
 | USB Host          |   暂不支持   | 即将支持                              |
 | IWG               |   暂不支持   | 即将支持                              |
-| xxx               |   暂不支持   | 即将支持                              |
-| **板外外设**      | **支持情况** | **备注**                              |
+| **扩展模块**      | **支持情况** | **备注**                              |
 |     xxx 模块      |   支持   |                                      |
 
 ## 使用说明
@@ -112,7 +110,7 @@ msh >
 
 4. 输入`scons --target=mdk4/mdk5/iar` 命令重新生成工程。
 
-本章节更多详细的介绍请参考 [BSP 进阶使用指南]()。
+本章节更多详细的介绍请参考 [BSP 进阶使用指南](../docs/BSP进阶使用指南.md)。
 
 ## 注意事项
 

bsp/stm32/libraries/templates/stm32f10x/applications/main.c

@@ -9,8 +9,16 @@
  */
 
 #include <rtthread.h>
+#include <rtdevice.h>
+#include <board.h>
 
 int main(void)
 {
-    return 0;
+    int count = 1;
+    while (count++)
+    {
+        // rt_pin_write(LED0_PIN, !rt_pin_read(LED0_PIN));
+        rt_thread_mdelay(500);
+    }
+    return RT_EOK;
 }

bsp/stm32/libraries/templates/stm32f10x/board/board.c

@@ -51,3 +51,12 @@ void MX_GPIO_Init(void)
   __HAL_RCC_GPIOA_CLK_ENABLE();
 
 }
+
+#ifdef RT_USING_PIN
+// int board_pin_init(void)
+// {
+//     rt_pin_mode(LED0_PIN, PIN_MODE_OUTPUT);
+//     return 0;
+// }
+// INIT_BOARD_EXPORT(board_pin_init);
+#endif /* RT_USING_PIN */

bsp/stm32/libraries/templates/stm32f10x/board/board.h

@@ -17,6 +17,8 @@
 
 #ifdef BSP_USING_GPIO
 #include "drv_gpio.h"
+/* Board Pin definitions */
+// #define LED0_PIN                       GET_PIN(C,  0)
 #endif
 
 /* Internal SRAM memory size[Kbytes] <8-64>, Default: 64*/

bsp/stm32/libraries/templates/stm32f4xx/README.md

@@ -38,13 +38,12 @@
 本 BSP 目前对外设的支持情况如下：
 
 | **板载外设**      | **支持情况** | **备注**                              |
-| ----------------- | :----------: | ------------------------------------- |
+| :----------------- | :----------: | :------------------------------------- |
 | USB 转串口        |     支持     |                                       |
 | SPI Flash         |     支持     |                                       |
 | 以太网            |     支持     |                                       |
 | SD卡              |   暂不支持   |                                       |
 | CAN               |   暂不支持   |                                       |
-| ...               |             |                                       |
 | **片上外设**      | **支持情况** | **备注**                              |
 | GPIO              |     支持     | PA0, PA1... PK15 ---> PIN: 0, 1...176 |
 | UART              |     支持     | UART1/x/x                             |
@@ -57,7 +56,7 @@
 | USB Host          |   暂不支持   | 即将支持                              |
 | IWG               |   暂不支持   | 即将支持                              |
 | xxx               |   暂不支持   | 即将支持                              |
-| **板外外设**      | **支持情况** | **备注**                              |
+| **扩展模块**      | **支持情况** | **备注**                              |
 |     xxx 模块      |   支持   |                                      |
 
 ## 使用说明
@@ -112,7 +111,7 @@ msh >
 
 4. 输入`scons --target=mdk4/mdk5/iar` 命令重新生成工程。
 
-本章节更多详细的介绍请参考 [BSP 进阶使用指南]()。
+本章节更多详细的介绍请参考 [BSP 进阶使用指南](../docs/BSP进阶使用指南.md)。
 
 ## 注意事项
 

bsp/stm32/libraries/templates/stm32f4xx/applications/main.c

@@ -9,8 +9,16 @@
  */
 
 #include <rtthread.h>
+#include <rtdevice.h>
+#include <board.h>
 
 int main(void)
 {
-    return 0;
+    int count = 1;
+    while (count++)
+    {
+        // rt_pin_write(LED0_PIN, !rt_pin_read(LED0_PIN));
+        rt_thread_mdelay(500);
+    }
+    return RT_EOK;
 }

bsp/stm32/libraries/templates/stm32f4xx/board/board.c

@@ -56,3 +56,12 @@ void MX_GPIO_Init(void)
   __HAL_RCC_GPIOA_CLK_ENABLE();
 
 }
+
+#ifdef RT_USING_PIN
+// int board_pin_init(void)
+// {
+//     rt_pin_mode(LED0_PIN, PIN_MODE_OUTPUT);
+//     return 0;
+// }
+// INIT_BOARD_EXPORT(board_pin_init);
+#endif /* RT_USING_PIN */

bsp/stm32/libraries/templates/stm32f4xx/board/board.h

@@ -17,6 +17,8 @@
 
 #ifdef BSP_USING_GPIO
 #include "drv_gpio.h"
+/* Board Pin definitions */
+// #define LED0_PIN                       GET_PIN(C,  0)
 #endif
 
 #define STM32_SRAM_SIZE           128

bsp/stm32/libraries/templates/stm32l4xx/README.md

@@ -38,13 +38,12 @@
 本 BSP 目前对外设的支持情况如下：
 
 | **板载外设**      | **支持情况** | **备注**                              |
-| ----------------- | :----------: | ------------------------------------- |
+| :----------------- | :----------: | :------------------------------------- |
 | USB 转串口        |     支持     |                                       |
 | SPI Flash         |     支持     |                                       |
 | 以太网            |     支持     |                                       |
 | SD卡              |   暂不支持   |                                       |
 | CAN               |   暂不支持   |                                       |
-| ...               |             |                                       |
 | **片上外设**      | **支持情况** | **备注**                              |
 | GPIO              |     支持     | PA0, PA1... PK15 ---> PIN: 0, 1...176 |
 | UART              |     支持     | UART1/x/x                             |
@@ -56,8 +55,7 @@
 | USB Device        |   暂不支持   | 即将支持                              |
 | USB Host          |   暂不支持   | 即将支持                              |
 | IWG               |   暂不支持   | 即将支持                              |
-| xxx               |   暂不支持   | 即将支持                              |
-| **板外外设**      | **支持情况** | **备注**                              |
+| **扩展模块**      | **支持情况** | **备注**                              |
 |     xxx 模块      |   支持   |                                      |
 
 ## 使用说明
@@ -112,7 +110,7 @@ msh >
 
 4. 输入`scons --target=mdk4/mdk5/iar` 命令重新生成工程。
 
-本章节更多详细的介绍请参考 [BSP 进阶使用指南]()。
+本章节更多详细的介绍请参考 [BSP 进阶使用指南](../docs/BSP进阶使用指南.md)。
 
 ## 注意事项
 

bsp/stm32/libraries/templates/stm32l4xx/applications/main.c

@@ -9,8 +9,16 @@
  */
 
 #include <rtthread.h>
+#include <rtdevice.h>
+#include <board.h>
 
 int main(void)
 {
-    return 0;
+    int count = 1;
+    while (count++)
+    {
+        // rt_pin_write(LED0_PIN, !rt_pin_read(LED0_PIN));
+        rt_thread_mdelay(500);
+    }
+    return RT_EOK;
 }

bsp/stm32/libraries/templates/stm32l4xx/board/board.c

@@ -67,3 +67,11 @@ void MX_GPIO_Init(void)
 
 }
 
+#ifdef RT_USING_PIN
+// int board_pin_init(void)
+// {
+//     rt_pin_mode(LED0_PIN, PIN_MODE_OUTPUT);
+//     return 0;
+// }
+// INIT_BOARD_EXPORT(board_pin_init);
+#endif /* RT_USING_PIN */

bsp/stm32/libraries/templates/stm32l4xx/board/board.h

@@ -17,6 +17,8 @@
 
 #ifdef BSP_USING_GPIO
 #include "drv_gpio.h"
+/* Board Pin definitions */
+// #define LED0_PIN                       GET_PIN(C,  0)
 #endif
 
 #define STM32_SRAM_SIZE         96

bsp/stm32/stm32f103-atk-nano/README.md

@@ -37,7 +37,7 @@ ATK-NANO STM32F103 是正点原子推出的一款基于 ARM Cortex-M3 内核的
 本 BSP 目前对外设的支持情况如下：
 
 | **板载外设**      | **支持情况** | **备注**                              |
-| ----------------- | :----------: | ------------------------------------- |
+| :----------------- | :----------: | :------------------------------------- |
 | USB 转串口        |     支持     |  使用 UART1                              |
 | SPI Flash         |     支持     |     使用 SPI1                            |
 | **片上外设**      | **支持情况** | **备注**                              |
@@ -45,7 +45,7 @@ ATK-NANO STM32F103 是正点原子推出的一款基于 ARM Cortex-M3 内核的
 | UART              |     支持     | UART1/2/3                             |
 | SPI               |     支持     | SPI1/2                              |
 | I2C               |     支持     | 软件 I2C                              |
-| **板外外设**      | **支持情况** | **备注**                              |
+| **扩展模块**      | **支持情况** | **备注**                              |
 | DS18B20/DHT11  |   暂不支持   |                               |
 
 
@@ -103,7 +103,7 @@ msh >
 
 4. 输入`scons --target=mdk4/mdk5/iar` 命令重新生成工程。
 
-本章节更多详细的介绍请参考 [BSP 进阶使用指南]()。
+本章节更多详细的介绍请参考 [BSP 进阶使用指南](../docs/BSP进阶使用指南.md)。
 
 ## 注意事项
 

bsp/stm32/stm32f103-atk-nano/applications/main.c

@@ -14,9 +14,11 @@
 
 int main(void)
 {
-    while (1)
+    int count = 1;
+    while (count++)
     {
         rt_pin_write(LED0_PIN, !rt_pin_read(LED0_PIN));
         rt_thread_mdelay(500);
     }
+    return RT_EOK;
 }

bsp/stm32/stm32f103-fire-arbitrary/README.md

@@ -38,15 +38,15 @@
 本 BSP 目前对外设的支持情况如下：
 
 | **板载外设** | **支持情况** | **备注**                              |
-| ------------ | :----------: | ------------------------------------- |
+| :------------ | :----------: | :------------------------------------- |
 | USB 转串口   |     支持     | 使用 UART1                            |
 | RS232        |     支持     | 使用 UART2                            |
 | SPI Flash    |     支持     | W25Q64                                |
 | 以太网       |     支持     | W5500                                 |
-| SD卡         |   暂不支持   |                                       |
-| CAN          |   暂不支持   |                                       |
-| SDRAM        |   暂不支持   |                                       |
-| WIFI ESP8266 |   暂不支持   |                                       |
+| SD卡         |   即将支持   |                                       |
+| CAN          |   即将支持   |                                       |
+| SDRAM        |   即将支持   |                                       |
+| WIFI ESP8266 |   即将支持   |                                       |
 | **片上外设** | **支持情况** | **备注**                              |
 | GPIO         |     支持     | PA0, PA1... PK15 ---> PIN: 0, 1...176 |
 | UART         |     支持     | UART1/2/3                             |
@@ -58,8 +58,8 @@
 | USB Device   |   暂不支持   | 即将支持                              |
 | USB Host     |   暂不支持   | 即将支持                              |
 | IWG          |   暂不支持   | 即将支持                              |
-| **板外外设** | **支持情况** | **备注**                              |
-| ESP8266 模块 |   暂不支持   | 即将支持                              |
+| **扩展模块** | **支持情况** | **备注**                              |
+| 暂无         |   暂不支持   | 暂不支持                              |
 
 ## 使用说明
 
@@ -113,7 +113,7 @@ msh >
 
 4. 输入`scons --target=mdk4/mdk5/iar` 命令重新生成工程。
 
-本章节更多详细的介绍请参考 [BSP 进阶使用指南]()。
+本章节更多详细的介绍请参考 [BSP 进阶使用指南](../docs/BSP进阶使用指南.md)。
 
 ## 注意事项
 

bsp/stm32/stm32f103-fire-arbitrary/applications/main.c

@@ -14,9 +14,11 @@
 
 int main(void)
 {
-    while (1)
+    int count = 1;
+    while (count++)
     {
         rt_pin_write(LED0_PIN, !rt_pin_read(LED0_PIN));
         rt_thread_mdelay(500);
     }
+    return RT_EOK;
 }

bsp/stm32/stm32f407-atk-explorer/README.md

@@ -38,13 +38,12 @@
 本 BSP 目前对外设的支持情况如下：
 
 | **板载外设** | **支持情况** |               **备注**                |
-| ------------ | :----------: | :-----------------------------------: |
+| :------------ | :----------: | :-----------------------------------: |
 | MPU6050      |     支持     |                                       |
 | Flash        |   支持   |                               |
 | SD卡         |   支持   |                               |
 | 以太网       |   支持   |                               |
 | WM8978       |   暂不支持   |                                       |
-| ...          |              |                                       |
 | **片上外设** | **支持情况** |               **备注**                |
 | GPIO         |     支持     | PA0, PA1... PH1 ---> PIN: 0, 1...144 |
 | UART         |     支持     |              UART1/2/3/6              |
@@ -55,9 +54,8 @@
 | USB Device   |   暂不支持   |               即将支持                |
 | USB Host     |   暂不支持   |               即将支持                |
 | IWG          |   暂不支持   |               即将支持                |
-| ...          |              |                                       |
-| **板外外设** | **支持情况** |               **备注**                |
-| ...          |              |                                       |
+| **扩展模块** | **支持情况** |               **备注**                |
+| ATK-ESP8266 模块 | 暂不支持 | 即将支持 |
 
 
 ## 使用说明
@@ -114,7 +112,7 @@ msh >
 
 4. 输入`scons --target=mdk4/mdk5/iar` 命令重新生成工程。
 
-本章节更多详细的介绍请参考 [BSP 进阶使用指南]()。
+本章节更多详细的介绍请参考 [BSP 进阶使用指南](../docs/BSP进阶使用指南.md)。
 
 ## 注意事项
 

bsp/stm32/stm32f407-atk-explorer/applications/main.c

@@ -15,9 +15,11 @@
 
 int main(void)
 {
-    while (1)
+    int count = 1;
+    while (count++)
     {
         rt_pin_write(LED1_PIN, !rt_pin_read(LED1_PIN));
         rt_thread_mdelay(500);
     }
+    return RT_EOK;
 }

bsp/stm32/stm32f429-atk-apollo/README.md

@@ -38,7 +38,7 @@
 本 BSP 目前对外设的支持情况如下：
 
 | **板载外设**      | **支持情况** | **备注**                              |
-| ----------------- | :----------: | ------------------------------------- |
+| :----------------- | :----------: | :------------------------------------- |
 | USB 转串口        |     支持     |                                       |
 | COM2              |     支持     | 与以太网有引脚冲突                    |
 | COM3              |     支持     |                                       |
@@ -59,7 +59,7 @@
 | USB Device        |   暂不支持   | 即将支持                              |
 | USB Host          |   暂不支持   | 即将支持                              |
 | IWG               |   暂不支持   | 即将支持                              |
-| **板外外设**      | **支持情况** | **备注**                              |
+| **扩展模块**      | **支持情况** | **备注**                              |
 | ATK-ESP8266 模块  |   暂不支持   | 即将支持                              |
 
 ## 使用说明
@@ -116,7 +116,7 @@ msh >
 
 4. 输入`scons --target=mdk4/mdk5/iar` 命令重新生成工程。
 
-本章节更多详细的介绍请参考 [BSP 进阶使用指南]()。
+本章节更多详细的介绍请参考 [BSP 进阶使用指南](../docs/BSP进阶使用指南.md)。
 
 ## 注意事项
 

bsp/stm32/stm32f429-atk-apollo/applications/main.c

@@ -14,9 +14,11 @@
 
 int main(void)
 {
-    while (1)
+    int count = 1;
+    while (count++)
     {
         rt_pin_write(LED1_PIN, !rt_pin_read(LED1_PIN));
         rt_thread_mdelay(500);
     }
+    return RT_EOK;
 }

bsp/stm32/stm32f429-fire-challenger/README.md

@@ -38,15 +38,16 @@
 本 BSP 目前对外设的支持情况如下：
 
 | **板载外设**      | **支持情况** | **备注**                              |
-| ----------------- | :----------: | ------------------------------------- |
+| :----------------- | :----------: | :------------------------------------- |
 | USB 转串口        |     支持     |                                       |
 | RS232         |     支持     | 与以太网有引脚冲突                    |
 | SPI Flash         |     支持     |                                       |
 | 以太网            |     支持     |                                       |
 | MPU6050六轴传感器 |     支持     |                   |
-| SD卡              |   暂不支持   |                                       |
-| CAN               |   暂不支持   |                                       |
-| SDRAM             |   暂不支持   |                                       |
+| SD卡              |   即将支持   |                                       |
+| CAN               |   即将支持   |                                       |
+| SDRAM             |   即将支持   |                                       |
+| ESP8266 模块      |   即将支持   |                               |
 | EMW1062 | 暂不支持 | |
 | **片上外设**      | **支持情况** | **备注**                              |
 | GPIO              |     支持     | PA0, PA1... PK15 ---> PIN: 0, 1...176 |
@@ -59,8 +60,8 @@
 | USB Device        |   暂不支持   | 即将支持                              |
 | USB Host          |   暂不支持   | 即将支持                              |
 | IWG               |   暂不支持   | 即将支持                              |
-| **板外外设**      | **支持情况** | **备注**                              |
-| ESP8266 模块      |   暂不支持   | 即将支持                              |
+| **扩展模块**      | **支持情况** | **备注**                              |
+| 暂无         |   暂不支持   | 暂不支持                              |
 
 ## 使用说明
 
@@ -114,7 +115,7 @@ msh >
 
 4. 输入`scons --target=mdk4/mdk5/iar` 命令重新生成工程。
 
-本章节更多详细的介绍请参考 [BSP 进阶使用指南]()。
+本章节更多详细的介绍请参考 [BSP 进阶使用指南](../docs/BSP进阶使用指南.md)。
 
 ## 注意事项
 

bsp/stm32/stm32f429-fire-challenger/applications/main.c

@@ -15,9 +15,11 @@
 
 int main(void)
 {
-    while (1)
+    int count = 1;
+    while (count++)
     {
         rt_pin_write(LED1_PIN, !rt_pin_read(LED1_PIN));
         rt_thread_mdelay(500);
     }
+    return RT_EOK;
 }