bb1084556f
* [console] 解决在没有定义RT_USING_DEVICE的情况下使用device报错的问题 * format codes * [libc] 整理格式 * refresh projects |
||
|---|---|---|
| .. | ||
| applications | ||
| board | ||
| figures | ||
| .config | ||
| .cproject | ||
| .gitignore | ||
| .project | ||
| Kconfig | ||
| README.md | ||
| SConscript | ||
| SConstruct | ||
| makefile.targets | ||
| project.ewd | ||
| project.ewp | ||
| project.eww | ||
| project.uvoptx | ||
| rtconfig.h | ||
| rtconfig.py | ||
| template.ewp | ||
| template.eww | ||
| template.uvoptx | ||
| template.uvprojx | ||
README.md
BSP README 模板
简介
本文档为 xxx 开发板的 BSP (板级支持包) 说明。
主要内容如下：
- 开发板资源介绍
- BSP 快速上手
- 进阶使用方法
通过阅读快速上手章节开发者可以快速地上手该 BSP，将 RT-Thread 运行在开发板上。在进阶使用指南章节，将会介绍更多高级功能，帮助开发者利用 RT-Thread 驱动更多板载资源。
开发板介绍
【此处简单介绍一下开发板】
开发板外观如下图所示：
该开发板常用 板载资源 如下：
- MCU：STM32xxx，主频 xxxMHz，xxxKB FLASH ，xxxKB RAM
- 外部 RAM：型号，xMB
- 外部 FLASH：型号，xMB
- 常用外设
- LED：x个，LD2（绿色，PB13）
- 按键：x个，B1，B2
- 调试接口，标准 JTAG/SWD
开发板更多详细信息请参考【厂商名】 xxx开发板介绍。
外设支持
本 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 模块 | 支持 |
使用说明
使用说明分为如下两个章节：
-
快速上手
本章节是为刚接触 RT-Thread 的新手准备的使用说明，遵循简单的步骤即可将 RT-Thread 操作系统运行在该开发板上，看到实验效果 。
-
进阶使用
本章节是为需要在 RT-Thread 操作系统上使用更多开发板资源的开发者准备的。通过使用 ENV 工具对 BSP 进行配置，可以开启更多板载资源，实现更多高级功能。
快速上手
本 BSP 为开发者提供 MDK4、MDK5 和 IAR 工程，并且支持 GCC 开发环境。下面以 MDK5 开发环境为例，介绍如何将系统运行起来。
硬件连接
使用数据线连接开发板到 PC，打开电源开关。
编译下载
双击 project.uvprojx 文件，打开 MDK5 工程，编译并下载程序到开发板。
工程默认配置使用 xxx 仿真器下载程序，在通过 xxx 连接开发板的基础上，点击下载按钮即可下载程序到开发板
运行结果
下载程序成功之后，系统会自动运行，【这里写开发板运行起来之后的现象，如：LED 闪烁等】。
连接开发板对应串口到 PC , 在终端工具里打开相应的串口（115200-8-1-N），复位设备后，可以看到 RT-Thread 的输出信息:
\ | /
- RT - Thread Operating System
/ | \ 4.0.4 build Jul 28 2021
2006 - 2021 Copyright by rt-thread team
msh >
进阶使用
此 BSP 默认只开启了 GPIO 和 串口2 的功能，若需要利用 ENV 工具对BSP 进行配置，步骤如下：
-
在 bsp 下打开 env 工具。
-
输入
menuconfig命令配置工程，配置好之后保存退出。 -
输入
pkgs --update命令更新软件包。 -
输入
scons --target=mdk4/mdk5/iar命令重新生成工程。
本章节更多详细的介绍请参考 STM32 系列 BSP 外设驱动使用教程。
注意事项
- xxx
联系人信息
维护人:
- xxx, 邮箱：xxx@xxx.com