README.md
1# BSP README 模板
2
3## 简介
4
5本文档为 xxx 开发板的 BSP (板级支持包) 说明。
6
7主要内容如下：
8
9- 开发板资源介绍
10- BSP 快速上手
11- 进阶使用方法
12
13通过阅读快速上手章节开发者可以快速地上手该 BSP，将 RT-Thread 运行在开发板上。在进阶使用指南章节，将会介绍更多高级功能，帮助开发者利用 RT-Thread 驱动更多板载资源。
14
15## 开发板介绍
16
17【此处简单介绍一下开发板】
18
19开发板外观如下图所示：
20
21
22
23该开发板常用 **板载资源** 如下：
24
25- MCU：STM32MP157AACx
26- 常用外设
27 - LED：4个 ，LD4 (PA14)， LD6 (PA13)，LD7 (PH7)，LD8 (PD11)
28 - 按键，4个，WAKE_UP，RESET (NRST)，USER1(PA14)，USER2 (PA13)
29- 常用接口：USB 转串口、SD 卡接口、以太网接口、MIPI接口、USB HOST、Audio、HDMI、Arduino
30- 调试接口，标准 JTAG/SWD
31
32开发板更多详细信息请参考【厂商名】 [xxx开发板介绍](https://xxx)。
33
34## 外设支持
35
36本 BSP 目前对外设的支持情况如下：
37
38| **板载外设** | **支持情况** | **备注** |
39| :----------- | :----------: | :--------------: |
40| USB 转串口 | 支持 | |
41| SD卡 | 暂不支持 | |
42| 以太网 | 暂不支持 | |
43| 音频接口 | 暂不支持 | |
44| **片上外设** | **支持情况** | **备注** |
45| GPIO | 支持 | |
46| UART | 支持 | UART4 (ST-Link) |
47| EXTI | 支持 | |
48| SPI | 支持 | |
49| TIM | 支持 | |
50| LPTIM | 支持 | |
51| I2C | 支持 | 软件、硬件都支持 |
52| ADC | 支持 | |
53| DAC | 支持 | |
54| WWDG | 支持 | |
55| USB Device | 暂不支持 | |
56| USB Host | 暂不支持 | |
57
58
59## 使用说明
60
61使用说明分为如下两个章节：
62
63- 快速上手
64
65 本章节是为刚接触 RT-Thread 的新手准备的使用说明，遵循简单的步骤即可将 RT-Thread 操作系统运行在该开发板上，看到实验效果 。
66
67- 进阶使用
68
69 本章节是为需要在 RT-Thread 操作系统上使用更多开发板资源的开发者准备的。通过使用 ENV 工具对 BSP 进行配置，可以开启更多板载资源，实现更多高级功能。
70
71
72### 快速上手
73
74本 BSP 为开发者提供 MDK4、MDK5 和 IAR 工程，并且支持 GCC 开发环境。下面以 MDK5 开发环境为例，介绍如何将系统运行起来。
75
76#### 硬件连接
77
78使用数据线连接开发板到 PC，打开电源开关。
79
80#### 编译下载
81
82双击 project.eww 文件，打开 IAR 工程，编译并下载程序到开发板。
83
84> 工程默认配置使用 xxx 仿真器下载程序，在通过 xxx 连接开发板的基础上，点击下载按钮即可下载程序到开发板
85
86#### 运行结果
87
88下载程序成功之后，系统会自动运行，【这里写开发板运行起来之后的现象，如：LED 闪烁等】。
89
90 连接开发板对应串口到 PC , 在终端工具里打开相应的串口（115200-8-1-N），复位设备后，可以看到 RT-Thread 的输出信息:
91
92```bash
93 \ | /
94- RT - Thread Operating System
95 / | \ 3.1.1 build Nov 19 2018
96 2006 - 2018 Copyright by rt-thread team
97msh >
98```
99
100### 进阶使用
101
102此 BSP 默认只开启了 GPIO 和 串口4 的功能，如果需更多高级功能，需要利用 ENV 工具对BSP 进行配置，步骤如下：
103
1041. 在 bsp 下打开 env 工具。
105
1062. 输入`menuconfig`命令配置工程，配置好之后保存退出。
107
1083. 输入`pkgs --update`命令更新软件包。
109
1104. 输入`scons --target=iar` 命令重新生成工程。
111
112本章节更多详细的介绍请参考 [STM32 系列 BSP 外设驱动使用教程](../docs/STM32系列BSP外设驱动使用教程.md)。
113
114## 注意事项
115
116- xxx
117
118## 联系人信息
119
120维护人:
121
122- [xxx](https://个人主页), 邮箱：<xxx@xxx.com>
123
124
