【修改】README

This commit is contained in:
Mr.Tiger 2021-08-28 15:48:47 +08:00
parent 4f110a6d05
commit f97454ba0c
1 changed files with 26 additions and 44 deletions

View File

@ -1,8 +1,8 @@
# BSP README 模板
# STM32F302-Nucleo-64 开发板 BSP 说明
## 简介
本文档为 xxx 开发板的 BSP (板级支持包) 说明。
本文档为 RT-Thread 开发团队为 STM32F302-Nucleo-64 开发板提供的 BSP (板级支持包) 说明。
主要内容如下:
@ -14,7 +14,7 @@
## 开发板介绍
【此处简单介绍一下开发板】
探索者 STM32F302-Nucleo-64 是意法半导体推出的一款基于 ARM Cortex-M4 内核的开发板,最高主频为 72 Mhz该开发板具有丰富的板载资源可以充分发挥 STM32F302R8 的芯片性能。
开发板外观如下图所示:
@ -22,41 +22,22 @@
该开发板常用 **板载资源** 如下:
- MCUSTM32xxx主频 xxxMHzxxxKB FLASH xxxKB RAM
- 外部 RAM型号xMB
- 外部 FLASH型号xMB
- MCUSTM32F302R8T6主频 72 MHz64KB FLASH 16KB SRAM。
- 常用外设
- LEDx个LD2绿色PB13
- 按键x个B1B2
- 调试接口,标准 JTAG/SWD
- LED3 个LD1, LD2, LD3。
- 按键2 个B1(USER),B2(RESET)。
- 调试接口,板载 ST-LINK/V2-1 调试器。
开发板更多详细信息请参考【厂商名】 [xxx开发板介绍](https://xxx)。
开发板更多详细信息请参考意法半导体 [STM32F302-Nucleo-64 开发板介绍](https://www.st.com/en/evaluation-tools/nucleo-f302r8.html)。
## 外设支持
本 BSP 目前对外设的支持情况如下:
| **板载外设** | **支持情况** | **备注** |
| :----------------- | :----------: | :------------------------------------- |
| USB 转串口 | 暂不支持 | |
| SPI Flash | 暂不支持 | |
| 以太网 | 暂不支持 | |
| SD卡 | 暂不支持 | |
| CAN | 暂不支持 | |
| **片上外设** | **支持情况** | **备注** |
| GPIO | 支持 | PA0, PA1... PK15 ---> PIN: 0, 1...176 |
| UART | 支持 | UART2/x/x |
| SPI | 暂不支持 | 即将支持 |
| I2C | 暂不支持 | 即将支持 |
| SDIO | 暂不支持 | 即将支持 |
| RTC | 暂不支持 | 即将支持 |
| PWM | 暂不支持 | 即将支持 |
| USB Device | 暂不支持 | 即将支持 |
| USB Host | 暂不支持 | 即将支持 |
| IWG | 暂不支持 | 即将支持 |
| xxx | 暂不支持 | 即将支持 |
| **扩展模块** | **支持情况** | **备注** |
| xxx 模块 | 支持 | |
| **片上外设** | **支持情况** | **备注** |
| :------------ | :----------: | :-----------------------------------: |
| GPIO | 支持 | PA0, PA1... ---> PIN: 0, 1...63 |
| UART | 支持 | UART2 |
## 使用说明
@ -73,51 +54,52 @@
### 快速上手
本 BSP 为开发者提供 MDK4、MDK5 和 IAR 工程,并且支持 GCC 开发环境。下面以 MDK5 开发环境为例,介绍如何将系统运行起来。
本 BSP 为开发者提供 MDK5 和 IAR 工程,并且支持 GCC 开发环境。下面以 MDK5 开发环境为例,介绍如何将系统运行起来。
#### 硬件连接
使用数据线连接开发板到 PC打开电源开关
使用 Type-A to Mini-B 线连接开发板和 PC 供电
#### 编译下载
双击 project.uvprojx 文件,打开 MDK5 工程,编译并下载程序到开发板。
> 工程默认配置使用 xxx 仿真器下载程序,在通过 xxx 连接开发板的基础上,点击下载按钮即可下载程序到开发板
> 工程默认配置使用 ST-LINK 下载程序,点击下载按钮即可下载程序到开发板。
#### 运行结果
下载程序成功之后,系统会自动运行【这里写开发板运行起来之后的现象LED 闪烁等】
下载程序成功之后,系统会自动运行。
连接开发板对应串口到 PC , 在终端工具里打开相应的串口115200-8-1-N,复位设备后,可以看到 RT-Thread 的输出信息:
USB 虚拟 COM 端口默认连接串口 2在终端工具里打开相应的串口,复位设备后,可以看到 RT-Thread 的输出信息:
```bash
\ | /
- RT - Thread Operating System
/ | \ 4.0.4 build Jul 28 2021
/ | \ 4.0.3 build Mar 7 2021
2006 - 2021 Copyright by rt-thread team
msh >
```
### 进阶使用
此 BSP 默认只开启了 GPIO 和 串口2 的功能,若需要利用 ENV 工具对BSP 进行配置,步骤如下:
此 BSP 默认只开启了 GPIO 和 串口 2 的功能,更多高级功能需要利用 ENV 工具对 BSP 进行配置,步骤如下:
1. 在 bsp 下打开 env 工具。
1. 在 BSP 下打开 env 工具。
2. 输入`menuconfig`命令配置工程,配置好之后保存退出。
2. 输入 `menuconfig` 命令配置工程,配置好之后保存退出。
3. 输入`pkgs --update`命令更新软件包。
3. 输入 `pkgs --update` 命令更新软件包。
4. 输入`scons --target=mdk4/mdk5/iar` 命令重新生成工程。
4. 输入 `scons --target=mdk4/mdk5/iar` 命令重新生成工程。
本章节更多详细的介绍请参考 [STM32 系列 BSP 外设驱动使用教程](../docs/STM32系列BSP外设驱动使用教程.md)。
## 注意事项
- xxx
暂无
## 联系人信息
维护人:
- [xxx](https://个人主页), 邮箱:<xxx@xxx.com>
- [Mr.Tiger](https://github.com/MrYangMouren/rt-thread),邮箱:<1039241323@qq.com>