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：STM32H743，主频 400MHz，2MB FLASH ，1MB RAM
26- 外部 SDRAM：W9825G6KH，32MB
27- 外部 NAND FLASH：H27U4G8F2，512MB
28- 外部 FLASH：W25Q256，32MB
29- 常用外设
30 - LED：2个，DS0（红色，PB1），DS1（绿色，PB0）
31 - 按键：4个，KEY_UP（兼具唤醒功能，PA0），K0（PH3），K1（PH2），K2（PC13）
32- 常用接口：USB 转串口、SD 卡接口、以太网接口、LCD 接口等
33- 调试接口，标准 JTAG/SWD
34
35开发板更多详细信息请参考正点原子 [STM32阿波罗开发板介绍](https://eboard.taobao.com/index.htm)。
36
37## 外设支持
38
39本 BSP 目前对外设的支持情况如下：
40
41| **板载外设** | **支持情况** | **备注** |
42| :----------------- | :----------: | :------------------------------------- |
43| USB 转串口 | 支持 | |
44| QSPI Flash | 暂不支持 | |
45| 以太网 | 暂不支持 | |
46| SD卡 | 暂不支持 | |
47| CAN | 暂不支持 | |
48| SDRAM | 暂不支持 | |
49| MPU9250六轴传感器 | 暂不支持 | |
50| **片上外设** | **支持情况** | **备注** |
51| GPIO | 支持 | PA0, PA1... PK15 ---> PIN: 0, 1...176 |
52| UART | 支持 | |
53| SPI | 暂不支持 | |
54| I2C | 暂不支持 | |
55| SDIO | 暂不支持 | 即将支持 |
56| RTC | 暂不支持 | 即将支持 |
57| PWM | 暂不支持 | 即将支持 |
58| USB Device | 暂不支持 | 即将支持 |
59| USB Host | 暂不支持 | 即将支持 |
60| IWG | 暂不支持 | 即将支持 |
61
62## 使用说明
63
64使用说明分为如下两个章节：
65
66- 快速上手
67
68 本章节是为刚接触 RT-Thread 的新手准备的使用说明，遵循简单的步骤即可将 RT-Thread 操作系统运行在该开发板上，看到实验效果 。
69
70- 进阶使用
71
72 本章节是为需要在 RT-Thread 操作系统上使用更多开发板资源的开发者准备的。通过使用 ENV 工具对 BSP 进行配置，可以开启更多板载资源，实现更多高级功能。
73
74
75### 快速上手
76
77本 BSP 为开发者提供 MDK4、MDK5 和 IAR 工程，并且支持 GCC 开发环境。下面以 MDK5 开发环境为例，介绍如何将系统运行起来。
78
79#### 硬件连接
80
81使用数据线连接开发板到 PC，打开电源开关。
82
83#### 编译下载
84
85双击 project.uvprojx 文件，打开 MDK5 工程，编译并下载程序到开发板。
86
87> 工程默认配置使用 ST_LINK 仿真器下载程序，在通过 ST_LINK 连接开发板的基础上，点击下载按钮即可下载程序到开发板
88
89#### 运行结果
90
91下载程序成功之后，系统会自动运行，LED闪烁。
92
93连接开发板对应串口到 PC , 在终端工具里打开相应的串口（115200-8-1-N），复位设备后，可以看到 RT-Thread 的输出信息:
94
95```bash
96 \ | /
97- RT - Thread Operating System
98 / | \ 4.0.1 build Mar 5 2019
99 2006 - 2019 Copyright by rt-thread team
100msh >
101```
102### 进阶使用
103
104此 BSP 默认只开启了 GPIO 和 串口1 的功能，如果需使用 SD 卡、Flash 等更多高级功能，需要利用 ENV 工具对BSP 进行配置，步骤如下：
105
1061. 在 bsp 下打开 env 工具。
107
1082. 输入`menuconfig`命令配置工程，配置好之后保存退出。
109
1103. 输入`pkgs --update`命令更新软件包。
111
1124. 输入`scons --target=mdk4/mdk5/iar` 命令重新生成工程。
113
114本章节更多详细的介绍请参考 [STM32 系列 BSP 外设驱动使用教程](../docs/STM32系列BSP外设驱动使用教程.md)。
115
116## 注意事项
117
118- xxx
119
120## 联系人信息
121
122维护人:
123
124- [xxx](https://个人主页), 邮箱：<xxx@xxx.com>
