[bsp][renesas] add ra8 en docs

This commit is contained in:
kurisaW 2024-03-12 11:01:48 +08:00 committed by Rbb666
parent 55a5c20661
commit 15125bdba0
2 changed files with 287 additions and 89 deletions

View File

@ -1,57 +1,63 @@
# Vision Board 开发板 BSP 说明
# Vision Board BSP Introduction
## 简介
**English** | [**中文**](./README_zh.md)
Vision-Board 开发板是 RT-Thread 推出基于瑞萨 Cortex-M85 架构 RA8D1 芯片,为工程师们提供了一个灵活、全面的开发平台,助力开发者在机器视觉领域获得更深层次的体验。
## Overview
![](docs/picture/logo.png)
The Vision-Board is introduced by RT-Thread, in collaboration with Renesas Electronics, the vision board is based on the Renesas Cortex-M85 architecture RA8D1 chip, to provide engineers with a flexible and comprehensive development platform, empowering developers to gain deeper experiences in the field of machine vision.
## 开发板介绍
[![img](https://github.com/RT-Thread/rt-thread/raw/master/bsp/renesas/ra8d1-vision-board/docs/picture/logo.png)](https://github.com/RT-Thread/rt-thread/blob/master/bsp/renesas/ra8d1-vision-board/docs/picture/logo.png)
该开发板常用 **板载资源** 如下:
## Hardware Introduction
![](docs/picture/hw.png)
The Vision-Board comes equipped with various onboard resources, including:
## 外设支持
![img](https://cdn-images-1.medium.com/max/1250/1*yuc1gyHjYpg7yd7x_8ICAg.png)
本 BSP 目前对外设的支持情况如下:
| **片上外设** | **支持情况** | **备注** |
| :----------: | :----------: | :-----------------------: |
| UART | 支持 | UART9 为默认日志输出端口 |
| GPIO | 支持 | |
| USB | 支持 | TinyUSB |
| Camera | 支持 | ov2640、ov7725、ov7670... |
| SDHC | 支持 | 1bit、4bit |
| ADC | 支持 | |
| DAC | 支持 | |
| SPI | 支持 | |
| PWM | 支持 | |
| RTC | 支持 | |
| FLASH | 支持 | |
| WDT | 支持 | |
| IIC | 支持 | |
| Wi-Fi | 支持 | RW007 |
* 注意:仓库刚拉下来是最小系统,若需添加/使能其他外设需参考:[外设驱动使用教程 (rt-thread.org)](https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/tutorial/make-bsp/renesas-ra/RA系列BSP外设驱动使用教程)
## Peripheral Support
## 模板工程说明
The BSP currently supports several peripherals as listed below:
![](docs/picture/1.png)
| On-Chip Peripheral | Support Status | Remarks |
| ------------------ | -------------- | ------------------------------------ |
| UART | Supported | UART9 is the default log output port |
| GPIO | Supported | |
| USB | Supported | TinyUSB |
| Camera | Supported | ov2640, ov7725, ov7670... |
| SDHC | Supported | 1-bit, 4-bit |
| ADC | Supported | |
| DAC | Supported | |
| SPI | Supported | |
| PWM | Supported | |
| RTC | Supported | |
| FLASH | Supported | |
| WDT | Supported | |
| I2C | Supported | |
| Wi-Fi | Supported | RW007 |
![](docs/picture/2.png)
- Note: The repository initially contains the minimal system. Additional peripherals can be added/enabled by referring to the [Peripheral Driver Usage Tutorial](https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/tutorial/make-bsp/renesas-ra/RA系列BSP外设驱动使用教程).
如上图所示RGB-LED 属于共阳 LED **阴极** 分别与单片机的引脚相连,其中蓝色 LED 对应 P102 引脚。单片机引脚输出低电平即可点亮 LED输出高电平则会熄灭 LED。
## Template Project Description
## 软件说明
闪灯的源代码位于 `ra8d1-vision-board/src/hal_entry.c` 中。首先定义了一个宏 `LED_PIN` ,代表闪灯的 LED 引脚编号,然后与 `BSP_IO_PORT_01_PIN_02`**P102 **)对应:
[![img](https://github.com/RT-Thread/rt-thread/raw/master/bsp/renesas/ra8d1-vision-board/docs/picture/1.png)](https://github.com/RT-Thread/rt-thread/blob/master/bsp/renesas/ra8d1-vision-board/docs/picture/1.png)
[![img](https://github.com/RT-Thread/rt-thread/raw/master/bsp/renesas/ra8d1-vision-board/docs/picture/2.png)](https://github.com/RT-Thread/rt-thread/blob/master/bsp/renesas/ra8d1-vision-board/docs/picture/2.png)
The RGB-LED, as shown above, is a common anode LED. The cathodes are connected to the microcontroller pins. For instance, the blue LED corresponds to pin P102. The LED can be lit by setting the microcontroller pin to a low level and turned off by setting it to a high level.
## Software Introduction
The source code for flashing the LED is located in `ra8d1-vision-board/src/hal_entry.c`. It defines a macro `LED_PIN` representing the LED pin number, corresponding to `BSP_IO_PORT_01_PIN_02` (P102).
```
#define LED_PIN BSP_IO_PORT_01_PIN_02 /* Onboard LED pins */
```
在 main 函数中,将该引脚配置为输出模式,并在下面的 while 循环中周期性500毫秒开关 LED。
In the `hal_entry` function, this pin is configured as an output. The LED is toggled periodically (every 500 milliseconds) in the while loop.
```
void hal_entry(void)
@ -68,64 +74,63 @@ void hal_entry(void)
}
```
## 使用说明
使用说明分为如下两个章节:
- 快速上手
## Usage Instructions
本章节是为刚接触 RT-Thread 的新手准备的使用说明,遵循简单的步骤即可将 RT-Thread 操作系统运行在该开发板上,看到实验效果 。
Usage instructions are divided into two sections:
- 进阶使用
- Quick Start
- This section provides instructions for newcomers to RT-Thread to run the RT-Thread operating system on this development board and observe experimental results.
- Advanced Usage
- This section is for developers who need to utilize more development board resources on the RT-Thread operating system. It guides users on enabling more onboard resources using the ENV tool to achieve more advanced functionality.
本章节是为需要在 RT-Thread 操作系统上使用更多开发板资源的开发者准备的。通过使用 ENV 工具对 BSP 进行配置,可以开启更多板载资源,实现更多高级功能。
### Supported Compilation Platforms
### 支持的编译平台
- armclang (AC6 V6.19)
- LLVM (V16/17) [ARM-software/LLVM-embedded-toolchain-for-Arm (github.com)](https://github.com/ARM-software/LLVM-embedded-toolchain-for-Arm/releases/tag/release-17.0.1)
* armclangAC6 V6.19
* LLVMV16/17[ARM-software/LLVM-embedded-toolchain-for-Arm (github.com)](https://github.com/ARM-software/LLVM-embedded-toolchain-for-Arm/releases/tag/release-17.0.1)
## FSP Version Introduction
## FSP版本说明
This BSP uses FSP 5.1.0 version for peripheral-related development. Users need to download and install it. Additionally, instructions for enabling additional peripherals are provided in the [Peripheral Driver Usage Tutorial](https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/tutorial/make-bsp/renesas-ra/RA系列BSP外设驱动使用教程).
本BSP使用的是FSP5.1.0版本,进行外设相关开发需要下载并安装。
* 下载链接:[rasc-5.1.0](https://github.com/renesas/fsp/releases/download/v5.1.0/setup_fsp_v5_1_0_rasc_v2023-10.exe)
* 注意BSP默认是最小系统若需添加/使能其他外设需参考:[外设驱动使用教程 (rt-thread.org)](https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/tutorial/make-bsp/renesas-ra/RA系列BSP外设驱动使用教程)
### Quick Start
### 快速上手
#### 1. Compiling with MDK:
#### 1、使用 MDK 编译:
This BSP provides an MDK5 project. Compile and download the program using the MDK5 development environment.
本 BSP 目前提供 MDK5 工程。下面以 MDK5 开发环境为例,介绍如何将系统运行起来。
**Compile and Download**
**编译下载**
- Compile: Double-click the project.uvprojx file to open the MDK5 project and compile the program.
- Download: Click the Debug button in MDK to download and debug."
- 编译:双击 project.uvprojx 文件,打开 MDK5 工程,编译程序。
- 下载:点击 MDK 的 Debug 按钮进行下载调试
#### 2、使用 LLVM 编译
使用 env 工具打开当前 bsp设定要使用的工具链和对应的路径。
#### 2. Compiling with LLVM
```shell
Open the current BSP using the ENV tool to set the toolchain and its corresponding path. Then, execute the `scons` command to compile.
```
set RTT_CC=llvm-arm
set RTT_EXEC_PATH=D:\Progrem\LLVMEmbeddedToolchainForArm-17.0.1-Windows-x86_64\bin
```
然后运行 scons 命令,执行编译
execute the `scons` command to compile.
```shell
```
scons
```
**查看运行结果**
**Observing the Program Execution**
下载程序成功之后,系统会自动运行并打印系统信息。
Once the program is downloaded successfully, the system will initiate automatically, displaying system information.
连接开发板对应串口到 PC , 在终端工具里打开相应的串口115200-8-1-N复位设备后可以看到 RT-Thread 的输出信息。输入 help 命令可查看系统中支持的命令。
Connect the development board's respective serial port to the PC. Launch the terminal tool and configure the serial port settings accordingly (115200-8-1-N). Upon resetting the device, you'll observe output information from RT-Thread. To explore the system's supported commands, enter the "help" command.
```bash
```
[D/main] sdram init success, mapped at 0x68000000, size is 33554432 bytes, data width is 16
\ | /
@ -138,48 +143,54 @@ msh >
msh >
```
### 进阶使用
**资料及文档**
- [开发板官网主页](https://www.renesas.cn/cn/zh/products/microcontrollers-microprocessors/ra-cortex-m-mcus/ek-ra8d1-evaluation-kit-ra8d1-mcu-group#overview)
- [开发板用户手册](https://www.renesas.cn/cn/zh/document/mat/ek-ra8d1-v1-users-manual?r=25452351)
- [瑞萨RA MCU 基础知识](https://www2.renesas.cn/cn/zh/document/gde/1520091)
### Advanced Usage
**ENV 配置**
**Resources and Documentation**
- 如何使用 ENV 工具:[RT-Thread env 工具用户手册](https://www.rt-thread.org/document/site/#/development-tools/env/env)
- [Official Development Board Website](https://www.renesas.com/us/en/products/microcontrollers-microprocessors/ra-cortex-m-mcus/ek-ra8d1-evaluation-kit-ra8d1-mcu-group)
- [Development Board User Manual](https://www.renesas.cn/cn/zh/document/mat/ek-ra8d1-v1-users-manual?r=25452351)
此 BSP 默认只开启了 UART9 的功能,如果需使用更多高级功能例如组件、软件包等,需要利用 ENV 工具进行配置。
**ENV Configuration**
步骤如下:
- How to use the ENV tool: [RT-Thread ENV Tool User Manual](https://www.rt-thread.io/document/site/programming-manual/env/env/)
1. 在 bsp 下打开 env 工具。
2. 输入`menuconfig`命令配置工程,配置好之后保存退出。
3. 输入`pkgs --update`命令更新软件包。
4. 输入`scons --target=mdk5` 命令重新生成工程。
By default, this BSP only enables UART9 functionality. If you require more advanced features such as components, software packages, etc., you'll need to configure them using the ENV tool.
**FSP配置**
The steps are as follows:
* 如何使用 FSP[RA系列使用 FSP 配置外设驱动](https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/tutorial/make-bsp/renesas-ra/RA系列使用FSP配置外设驱动?id=ra系列使用-fsp-配置外设驱动)
1. Open the ENV tool in the bsp directory.
2. Enter the "menuconfig" command to configure the project. Once configured, save and exit.
3. Use the "pkgs --update" command to update software packages.
4. Use the "scons --target=mdk5" command to regenerate the project.
目前仓库 bsp 默认使能最小体量配置,用户可通过如下步骤使能 env 外设配置:
***FSP Configuration**
1. 在 bsp 目录下打开 env 工具,使用 `scons --target=mdk5`命令生成 MDK 工程。
2. 打开 bsp 目录下的`project.uvprojx`文件,选择上方导航栏的 `Software Components`配置,打开后找到`Flex Software`下的`RA Configuration`旁的配置按钮,该操作会自动查找当前电脑环境下安装的 fsp 版本,选择指定版本后进入 fsp。
![](../docs/figures/mdk_rasc.png)
3. 在进入 fsp 后我们可以发现,已经存在了一些已经配置完成的外设,此时我们点击`Generate Project Content`按钮即可生成所需驱动文件。
![](../docs/figures/fsp_configure.png)
4. 接下来回到 env使能所需的外设配置后保存退出即可。
- How to use FSP: [Configuring Peripheral Drivers Using FSP for RA Series](https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/tutorial/make-bsp/renesas-ra/RA系列使用FSP配置外设驱动?id=ra系列使用-fsp-配置外设驱动)
## 联系人信息
The BSP repository currently enables the minimum configuration by default. Users can enable ENV peripheral configurations through the following steps:
在使用过程中若您有任何的想法和建议,建议您通过以下方式来联系到我们 [RT-Thread 社区论坛](https://club.rt-thread.org/)
1. Open the ENV tool in the bsp directory and generate an MDK project using the `scons --target=mdk5'`Command.
2. Open the `project.uvprojx` file in the bsp directory. Navigate to the `Software Components"`configuration in the top navigation bar. Open the configuration button next to `RA Configuration` under `Flex Software`. This action will automatically detect the installed FSP version on your computer. After selecting the specified version, enter FSP.
## SDK 仓库
[![img](https://github.com/RT-Thread/rt-thread/raw/master/bsp/renesas/docs/figures/mdk_rasc.png)](https://github.com/RT-Thread/rt-thread/blob/master/bsp/renesas/docs/figures/mdk_rasc.png)
这是 Vision Board 的 SDK 仓库地址:[sdk-bsp-ra8d1-vision-board](https://github.com/RT-Thread-Studio/sdk-bsp-ra8d1-vision-board),该仓库包括了外设驱动以及丰富的示例工程,如果像体验官网/社区提供的开源示例请转移到该仓库进行开发。RT-Thread 主仓库只维护最新的驱动相关代码。
3. Inside FSP, you'll find some pre-configured peripherals. Click the `Generate Project Content` button to generate the required driver files.
## 贡献代码
1. [![img](https://github.com/RT-Thread/rt-thread/raw/master/bsp/renesas/docs/figures/fsp_configure.png)](https://github.com/RT-Thread/rt-thread/blob/master/bsp/renesas/docs/figures/fsp_configure.png)
4. Return to ENV, save and exit after enabling the required peripheral configurations.
如果您对 Vision Board 感兴趣,并且有一些好玩的项目愿意与大家分享的话欢迎给我们贡献代码,您可以参考 [如何向 RT-Thread 代码贡献](https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/development-guide/github/github)。
## Contact Information
If you have any ideas or suggestions during usage, we encourage you to contact us via the [RT-Thread Community Forum](https://club.rt-thread.io/).
## SDK Repository
This is the SDK repository for Vision Board: [sdk-bsp-ra8d1-vision-board](https://github.com/RT-Thread-Studio/sdk-bsp-ra8d1-vision-board). This repository includes peripheral drivers and a variety of sample projects. If you'd like to experience open-source examples provided by the official website/community, please visit this repository for development. The RT-Thread main repository only maintains the latest driver-related code.
## Code Contributions
If you're interested in Vision Board and have some exciting projects to share with the community, wlecome any contributions. Please refer to [How to Contribute to RT-Thread Code](https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/development-guide/github/github).

View File

@ -0,0 +1,187 @@
# Vision Board 开发板 BSP 说明
**中文** | [**English**](./README.md)
## 简介
Vision-Board 开发板是 RT-Thread 推出基于瑞萨 Cortex-M85 架构 RA8D1 芯片,为工程师们提供了一个灵活、全面的开发平台,助力开发者在机器视觉领域获得更深层次的体验。
![](docs/picture/logo.png)
## 开发板介绍
该开发板常用 **板载资源** 如下:
![](docs/picture/hw.png)
## 外设支持
本 BSP 目前对外设的支持情况如下:
| **片上外设** | **支持情况** | **备注** |
| :----------: | :----------: | :-----------------------: |
| UART | 支持 | UART9 为默认日志输出端口 |
| GPIO | 支持 | |
| USB | 支持 | TinyUSB |
| Camera | 支持 | ov2640、ov7725、ov7670... |
| SDHC | 支持 | 1bit、4bit |
| ADC | 支持 | |
| DAC | 支持 | |
| SPI | 支持 | |
| PWM | 支持 | |
| RTC | 支持 | |
| FLASH | 支持 | |
| WDT | 支持 | |
| IIC | 支持 | |
| Wi-Fi | 支持 | RW007 |
* 注意:仓库刚拉下来是最小系统,若需添加/使能其他外设需参考:[外设驱动使用教程 (rt-thread.org)](https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/tutorial/make-bsp/renesas-ra/RA系列BSP外设驱动使用教程)
## 模板工程说明
![](docs/picture/1.png)
![](docs/picture/2.png)
如上图所示RGB-LED 属于共阳 LED **阴极** 分别与单片机的引脚相连,其中蓝色 LED 对应 P102 引脚。单片机引脚输出低电平即可点亮 LED输出高电平则会熄灭 LED。
## 软件说明
闪灯的源代码位于 `ra8d1-vision-board/src/hal_entry.c` 中。首先定义了一个宏 `LED_PIN` ,代表闪灯的 LED 引脚编号,然后与 `BSP_IO_PORT_01_PIN_02`**P102 **)对应:
```
#define LED_PIN BSP_IO_PORT_01_PIN_02 /* Onboard LED pins */
```
在 main 函数中,将该引脚配置为输出模式,并在下面的 while 循环中周期性500毫秒开关 LED。
```
void hal_entry(void)
{
rt_kprintf("\nHello RT-Thread!\n");
while (1)
{
rt_pin_write(LED_PIN, PIN_HIGH);
rt_thread_mdelay(500);
rt_pin_write(LED_PIN, PIN_LOW);
rt_thread_mdelay(500);
}
}
```
## 使用说明
使用说明分为如下两个章节:
- 快速上手
本章节是为刚接触 RT-Thread 的新手准备的使用说明,遵循简单的步骤即可将 RT-Thread 操作系统运行在该开发板上,看到实验效果 。
- 进阶使用
本章节是为需要在 RT-Thread 操作系统上使用更多开发板资源的开发者准备的。通过使用 ENV 工具对 BSP 进行配置,可以开启更多板载资源,实现更多高级功能。
### 支持的编译平台
* armclangAC6 V6.19
* LLVMV16/17[ARM-software/LLVM-embedded-toolchain-for-Arm (github.com)](https://github.com/ARM-software/LLVM-embedded-toolchain-for-Arm/releases/tag/release-17.0.1)
## FSP版本说明
本BSP使用的是FSP5.1.0版本,进行外设相关开发需要下载并安装。
* 下载链接:[rasc-5.1.0](https://github.com/renesas/fsp/releases/download/v5.1.0/setup_fsp_v5_1_0_rasc_v2023-10.exe)
* 注意BSP默认是最小系统若需添加/使能其他外设需参考:[外设驱动使用教程 (rt-thread.org)](https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/tutorial/make-bsp/renesas-ra/RA系列BSP外设驱动使用教程)
### 快速上手
#### 1、使用 MDK 编译:
本 BSP 目前提供 MDK5 工程。下面以 MDK5 开发环境为例,介绍如何将系统运行起来。
**编译下载**
- 编译:双击 project.uvprojx 文件,打开 MDK5 工程,编译程序。
- 下载:点击 MDK 的 Debug 按钮进行下载调试
#### 2、使用 LLVM 编译
使用 env 工具打开当前 bsp设定要使用的工具链和对应的路径。
```shell
set RTT_CC=llvm-arm
set RTT_EXEC_PATH=D:\Progrem\LLVMEmbeddedToolchainForArm-17.0.1-Windows-x86_64\bin
```
然后运行 scons 命令,执行编译
```shell
scons
```
**查看运行结果**
下载程序成功之后,系统会自动运行并打印系统信息。
连接开发板对应串口到 PC , 在终端工具里打开相应的串口115200-8-1-N复位设备后可以看到 RT-Thread 的输出信息。输入 help 命令可查看系统中支持的命令。
```bash
[D/main] sdram init success, mapped at 0x68000000, size is 33554432 bytes, data width is 16
\ | /
- RT - Thread Operating System
/ | \ 5.1.0 build Mar 5 2024 13:57:23
2006 - 2024 Copyright by RT-Thread team
Hello RT-Thread!
msh >
msh >
```
### 进阶使用
**资料及文档**
- [开发板官网主页](https://www.renesas.cn/cn/zh/products/microcontrollers-microprocessors/ra-cortex-m-mcus/ek-ra8d1-evaluation-kit-ra8d1-mcu-group#overview)
- [开发板用户手册](https://www.renesas.cn/cn/zh/document/mat/ek-ra8d1-v1-users-manual?r=25452351)
- [瑞萨RA MCU 基础知识](https://www2.renesas.cn/cn/zh/document/gde/1520091)
**ENV 配置**
- 如何使用 ENV 工具:[RT-Thread env 工具用户手册](https://www.rt-thread.org/document/site/#/development-tools/env/env)
此 BSP 默认只开启了 UART9 的功能,如果需使用更多高级功能例如组件、软件包等,需要利用 ENV 工具进行配置。
步骤如下:
1. 在 bsp 下打开 env 工具。
2. 输入`menuconfig`命令配置工程,配置好之后保存退出。
3. 输入`pkgs --update`命令更新软件包。
4. 输入`scons --target=mdk5` 命令重新生成工程。
**FSP配置**
* 如何使用 FSP[RA系列使用 FSP 配置外设驱动](https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/tutorial/make-bsp/renesas-ra/RA系列使用FSP配置外设驱动?id=ra系列使用-fsp-配置外设驱动)
目前仓库 bsp 默认使能最小体量配置,用户可通过如下步骤使能 env 外设配置:
1. 在 bsp 目录下打开 env 工具,使用 `scons --target=mdk5`命令生成 MDK 工程。
2. 打开 bsp 目录下的`project.uvprojx`文件,选择上方导航栏的 `Software Components`配置,打开后找到`Flex Software`下的`RA Configuration`旁的配置按钮,该操作会自动查找当前电脑环境下安装的 fsp 版本,选择指定版本后进入 fsp。
![](../docs/figures/mdk_rasc.png)
3. 在进入 fsp 后我们可以发现,已经存在了一些已经配置完成的外设,此时我们点击`Generate Project Content`按钮即可生成所需驱动文件。
![](../docs/figures/fsp_configure.png)
4. 接下来回到 env使能所需的外设配置后保存退出即可。
## 联系人信息
在使用过程中若您有任何的想法和建议,建议您通过以下方式来联系到我们 [RT-Thread 社区论坛](https://club.rt-thread.org/)
## SDK 仓库
这是 Vision Board 的 SDK 仓库地址:[sdk-bsp-ra8d1-vision-board](https://github.com/RT-Thread-Studio/sdk-bsp-ra8d1-vision-board),该仓库包括了外设驱动以及丰富的示例工程,如果像体验官网/社区提供的开源示例请转移到该仓库进行开发。RT-Thread 主仓库只维护最新的驱动相关代码。
## 贡献代码
如果您对 Vision Board 感兴趣,并且有一些好玩的项目愿意与大家分享的话欢迎给我们贡献代码,您可以参考 [如何向 RT-Thread 代码贡献](https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/development-guide/github/github)。