[bsp/stm32/rmc] update readme.

This commit is contained in:
crazt 2021-06-30 19:16:06 +08:00
parent 489c2f9f8d
commit 892ddb247d
3 changed files with 46 additions and 52 deletions

View File

@ -1,8 +1,8 @@
# BSP README 模板 # STM32F407 Robomaster 开发板C型 BSP 说明
## 简介 ## 简介
本文档为 xxx 开发板的 BSP (板级支持包) 说明。 本文档为 STM32F407 Robomaster 开发板C型 的 BSP (板级支持包) 说明。
主要内容如下: 主要内容如下:
@ -14,50 +14,43 @@
## 开发板介绍 ## 开发板介绍
【此处简单介绍一下开发板】 Robomaster 开发板C型 是大疆创新科技有限公司推出的一款基于 ARM Cortex-M4 内核的开发板。开发板主控芯片为 STM32F407IGH6TR最高主频为 168Mhz拥有丰富的扩展接口和通信接口。板载IMU传感器可配合RoboMaster出品的M3508、 M2006直流无刷减速电机、UWB模块以及妙算等产品使用亦可配合DJI飞控SDK使用。
开发板外观如下图所示: 开发板外观如下图所示:
![board](figures/board.png) <img src="figures/board.png" alt="image-20210630111114846" style="zoom:50%;" />
> 开发板 C 型具有如下外设:
该开发板常用 **板载资源** 如下: 该开发板常用 **板载资源** 如下:
- MCUSTM32xxx主频 xxxMHzxxxKB FLASH xxxKB RAM - MCU: STM32F407IGH6TR, 168MHz Freq, 1024KB FLASH, 192KB RAM(含64KB CCM RAM)。
- 外部 RAM型号xMB - 调试接口SWD
- 外部 FLASH型号xMB - 常用外设:用户自定义 LED、按键、蜂鸣器、六轴惯性测量单元和磁力计、电压检测 ADC。
- 常用外设 - 常用接口5V 接口、BOOT 配置接口、micro USB 接口、可配置 I/O 接口、UART 接口、CAN 总线接口、PWM 接口、DBUS接口、数字摄像头 FPC 接口。
- LEDx个DS0红色PB1DS1绿色PB0
- 按键x个K0兼具唤醒功能PA0K1PC13
- 常用接口USB 转串口、SD 卡接口、以太网接口、LCD 接口等
- 调试接口,标准 JTAG/SWD
开发板更多详细信息请参考【厂商名】 [xxx开发板介绍](https://xxx)。 开发板的用户手册:[RoboMaster 开发板 C 型用户手册.pdf](https://rm-static.djicdn.com/tem/35228/RoboMaster%20%20%E5%BC%80%E5%8F%91%E6%9D%BF%20C%20%E5%9E%8B%E7%94%A8%E6%88%B7%E6%89%8B%E5%86%8C.pdf)
开发板更多详细信息请参考 RoboMaster官网[RoboMaster开发板 C 型](https://www.robomaster.com/zh-CN/products/components/general/development-board-type-c/info)
## 外设支持 ## 外设支持
本 BSP 目前对外设的支持情况如下: 本 BSP 目前对外设的支持情况如下:
| **板载外设** | **支持情况** | **备注** | | **板载外设** | **支持情况** | **备注** |
| :----------------- | :----------: | :------------------------------------- | | :----------- | :----------: | :----------------------------------- |
| USB 转串口 | 支持 | | | CAN | 暂不支持 | CAN1, CAN2 |
| SPI Flash | 支持 | | | BMI088 | 暂不支持 | 六轴惯性测量单元 |
| 以太网 | 支持 | | | IST8310 | 暂不支持 | 三轴磁力计 |
| SD卡 | 暂不支持 | | | **片上外设** | **支持情况** | **备注** |
| CAN | 暂不支持 | | | GPIO | 支持 | PA0, PA1... PH1 ---> PIN: 0, 1...144 |
| **片上外设** | **支持情况** | **备注** | | UART | 支持 | UART1, UART3(DBUS), UART6 |
| GPIO | 支持 | PA0, PA1... PK15 ---> PIN: 0, 1...176 | | PWM | 暂不支持 | |
| UART | 支持 | UART1/x/x | | SPI | 暂不支持 | |
| SPI | 支持 | SPI1/x/x | | I2C | 暂不支持 | |
| I2C | 支持 | 软件 I2C | | USB | 暂不支持 | |
| SDIO | 暂不支持 | 即将支持 | | **扩展模块** | **支持情况** | **备注** |
| RTC | 暂不支持 | 即将支持 | | 无 | | |
| PWM | 暂不支持 | 即将支持 |
| USB Device | 暂不支持 | 即将支持 |
| USB Host | 暂不支持 | 即将支持 |
| IWG | 暂不支持 | 即将支持 |
| xxx | 暂不支持 | 即将支持 |
| **扩展模块** | **支持情况** | **备注** |
| xxx 模块 | 支持 | |
## 使用说明 ## 使用说明
@ -74,51 +67,54 @@
### 快速上手 ### 快速上手
本 BSP 为开发者提供 MDK4、MDK5 和 IAR 工程,并且支持 GCC 开发环境。下面以 MDK5 开发环境为例,介绍如何将系统运行起来。 本 BSP 为开发者提供 MDK5 和 IAR 工程,并且支持 GCC 开发环境。下面以 MDK5 开发环境为例,介绍如何将系统运行起来。
#### 硬件连接 #### 硬件连接
使用数据线连接开发板到 PC打开电源开关。 将准备好的 ST-Link/JLink/DapLink 与开发板连接,开发板上的调试接口为 MX1.25 4Pin。C板上没有电源指示灯供电可以选用调试接口的 3.3V 输入micro USB 接口供电XT30 电源输入。
#### 编译下载 #### 编译下载
双击 project.uvprojx 文件,打开 MDK5 工程,编译并下载程序到开发板。 双击 project.uvprojx 文件,打开 MDK5 工程,编译并下载程序到开发板。
> 工程默认配置使用 xxx 仿真器下载程序,在通过 xxx 连接开发板的基础上,点击下载按钮即可下载程序到开发板 > 工程默认配置使用 ST-LINK 下载程序,点击下载按钮即可下载程序到开发板。
#### 运行结果 #### 运行结果
下载程序成功之后,系统会自动运行,【这里写开发板运行起来之后的现象LED 闪烁等】 下载程序成功之后,系统会自动运行,观察开发板上 LED 的运行效果LED 会以蓝光进行周期性闪烁
连接开发板对应串口到 PC , 在终端工具里打开相应的串口115200-8-1-N复位设备后可以看到 RT-Thread 的输出信息: 此 BSP 的 FinSH 默认使用串口 1 (C板外壳上标有UART2的4Pin接口)在终端工具里打开相应的串口115200-8-1-N复位设备后可以看到 RT-Thread 的输出信息:
```bash ```bash
\ | / \ | /
- RT - Thread Operating System - RT - Thread Operating System
/ | \ 3.1.1 build Nov 19 2018 / | \ 4.0.4 build Jun 30 2021
2006 - 2018 Copyright by rt-thread team 2006 - 2021 Copyright by rt-thread team
msh > msh >
``` ```
> 终端工具推荐使用 [MobaXterm](https://mobaxterm.mobatek.net/) 或 [Xshell](https://www.netsarang.com/en/free-for-home-school/),均有免费的个人版本
### 进阶使用 ### 进阶使用
此 BSP 默认只开启了 GPIO 和 串口1 的功能,如果需使用 SD 卡、Flash 等更多高级功能,需要利用 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)。 本章节更多详细的介绍请参考 [STM32 系列 BSP 外设驱动使用教程](../docs/STM32 系列 BSP 外设驱动使用教程. md)。
## 注意事项 ## 注意事项
- xxx - 部分外设需通过 XT30 或 USB 接口供电才能使用,包括 CAN、舵机5V供电、IMU恒温电路
- 目前 scons 支持生成 cmake 配置文件,可以使用 CLion 进行 C板 的程序开发,推荐同学们尝试。详细步骤可参见:[在 Clion 中调试 rt-thread 工程](https://club.rt-thread.org/ask/article/2840.html)C板的 openOCD 配置文件推荐选用 `stm32f4discovery.cfg` ,并将该配置文件的最后一行改为 `reset_config none`
## 联系人信息 ## 联系人信息
维护人: 维护人:
- [xxx](https://个人主页), 邮箱:<xxx@xxx.com> - [crazt](https://github.com/CraztTnspt) ,邮箱:<crazt@foxmail.com>

View File

@ -3,9 +3,7 @@ from building import *
cwd = GetCurrentDir() cwd = GetCurrentDir()
CPPPATH = [cwd, str(Dir('#'))] CPPPATH = [cwd, str(Dir('#'))]
src = Split(""" src = Glob('*.c')
main.c
""")
group = DefineGroup('Applications', src, depend = [''], CPPPATH = CPPPATH) group = DefineGroup('Applications', src, depend = [''], CPPPATH = CPPPATH)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 173 KiB

After

Width:  |  Height:  |  Size: 146 KiB