• Home
  • Annotate
  • current directory
Name Date Size #Lines LOC

..21-Aug-2025-

.settings/21-Aug-2025-

board/21-Aug-2025-

figures/21-Aug-2025-

rzn/21-Aug-2025-

rzn_cfg/21-Aug-2025-

rzn_gen/21-Aug-2025-

script/21-Aug-2025-

src/21-Aug-2025-

.api_xml A D21-Aug-202569 32

.config A D21-Aug-202545.8 KiB1,4071,297

.cproject A D21-Aug-202539.1 KiB222221

.gitignore A D21-Aug-2025177 1414

.project A D21-Aug-2025913 2928

.secure_azone A D21-Aug-2025119 54

.secure_xml A D21-Aug-20258.1 KiB111110

Kconfig A D21-Aug-2025348 1811

README.md A D21-Aug-20259 KiB171117

README_zh.md A D21-Aug-20257.8 KiB166116

SConscript A D21-Aug-2025738 2823

SConstruct A D21-Aug-20251.6 KiB5643

buildinfo.ipcf A D21-Aug-20257.8 KiB157156

configuration.xml A D21-Aug-202589.2 KiB1,0401,039

project.ewd A D21-Aug-2025115.2 KiB3,2773,276

project.ewp A D21-Aug-202582.2 KiB2,8992,898

project.ewt A D21-Aug-2025231.4 KiB3,4343,433

project.eww A D21-Aug-2025161 117

rtconfig.h A D21-Aug-20258.1 KiB41274

rtconfig.py A D21-Aug-20253.5 KiB12297

rzn_cfg.txt A D21-Aug-202596.9 KiB1,1591,143

template.ewd A D21-Aug-2025115.3 KiB3,2773,276

template.ewp A D21-Aug-202594.8 KiB2,6172,616

template.eww A D21-Aug-2025178 87

README.md

1# EtherKit Development Board BSP Documentation
2
3**English** | **[Chinese](./README_zh.md)**
4
5## Introduction
6
7This document provides the BSP (Board Support Package) documentation for the RT-Thread EtherKit development board. By following the Quick Start section, developers can quickly get started with this BSP and run RT-Thread on the development board.
8
9The main contents are as follows:
10
11- Introduction to the Development Board
12- BSP Quick Start Guide
13
14## Introduction to the Development Board
15
16The EtherKit development board is based on the Renesas RZ/N2L and is designed to facilitate embedded system application development by offering flexible software package and IDE configurations.
17
18The front view of the development board is shown below:
19
20![image-20240314165241884](figures/big.png)
21
22Key **onboard resources** include:
23
24- MPU: R9A07G084M04GBG, maximum operating frequency of 400MHz, Arm Cortex®-R52 core, 128KB tightly coupled memory (with ECC), 1.5MB internal RAM (with ECC)
25- Debug Interface: Onboard J-Link interface
26- Expansion Interface: One PMOD connector
27
28**More detailed information and tools**
29
30## Peripheral Support
31
32This BSP currently supports the following peripherals:
33
34Here is the translated text in English, keeping the markdown format:
35
36| **EtherCAT Solution** | **Support Status** | **EtherCAT Solution** | **Support Status** |
37| --------------------- | ------------------ | --------------------- | ------------------ |
38| EtherCAT_IO           | Supported          | EtherCAT_FOE          | Supported          |
39| EtherCAT_EOE          | Supported          | EtherCAT_COE          | Supported          |
40| **PROFINET Solution** | **Support Status** | **Ethernet/IP Solution** | **Support Status** |
41| P-Net (Open source evaluation package supporting ProfiNET slave protocol stack) | Supported | EIP | Supported |
42| **On-chip Peripherals** | **Support Status** | **Components**        | **Support Status** |
43| UART                  | Supported          | LWIP                  | Supported          |
44| GPIO                  | Supported          | TCP/UDP               | Supported          |
45| HWIMER                | Supported          | MQTT                  | Supported          |
46| IIC                   | Supported          | TFTP                  | Supported          |
47| WDT                   | Supported          | Modbus Master/Slave Protocol | Supported |
48| RTC                   | Supported          |                       |                    |
49| ADC                   | Supported          |                       |                    |
50| DAC                   | Supported          |                       |                    |
51| SPI                   | Supported          |                       |                    |
52
53
54## Usage Instructions
55
56Usage instructions are divided into two sections:
57
58- **Quick Start**
59
60  This section is designed for beginners who are new to RT-Thread. By following simple steps, users can run the RT-Thread OS on the development board and observe the experimental results.
61
62- **Advanced Usage**
63
64  This section is for developers who need to use more of the development board's resources within the RT-Thread OS. By configuring the BSP using the ENV tool, additional onboard resources and advanced features can be enabled.
65
66### Quick Start
67
68This BSP currently provides GCC/IAR project support. Below is a guide using the [IAR Embedded Workbench for Arm](https://www.iar.com/products/architectures/arm/iar-embedded-workbench-for-arm/) development environment to run the system.
69
70**Hardware Connection**
71
72Connect the development board to the PC via a USB cable. Use the J-Link interface to download and debug the program.
73
74**Compilation and Download**
75
76- Navigate to the `bsp` directory and use the command `scons --target=iar` to generate the IAR project.
77- Compile: Double-click the `project.eww` file to open the IAR project and compile the program.
78- Debug: In the IAR navigation bar, click `Project -> Download and Debug` to download and start debugging.
79
80**Viewing the Run Results**
81
82After successfully downloading the program, the system will automatically run and print system information.
83
84Connect the corresponding serial port of the development board to the PC. Open the relevant serial port (115200-8-1-N) in the terminal tool. After resetting the device, you can view the RT-Thread output. Enter the `help` command to see the list of supported system commands.
85
86```bash
87 \ | /
88- RT -     Thread Operating System
89 / | \     5.1.0 build Mar 14 2024 18:26:01
90 2006 - 2024 Copyright by RT-Thread team
91
92Hello RT-Thread!
93==================================================
94This is an IAR project in RAM execution mode!
95==================================================
96msh > help
97RT-Thread shell commands:
98clear            - clear the terminal screen
99version          - show RT-Thread version information
100list             - list objects
101backtrace        - print backtrace of a thread
102help             - RT-Thread shell help
103ps               - List threads in the system
104free             - Show the memory usage in the system
105pin              - pin [option]
106
107msh >
108```
109
110**Application Entry Function**
111
112The entry function for the application layer is located in **src\hal_entry.c** within `void hal_entry(void)`. User source files can be placed directly in the `src` directory.
113
114```c
115void hal_entry(void)
116{
117    rt_kprintf("\nHello RT-Thread!\n");
118    rt_kprintf("==================================================\n");
119    rt_kprintf("This is an IAR project in RAM execution mode!\n");
120    rt_kprintf("==================================================\n");
121
122    while (1)
123    {
124        rt_pin_write(LED_PIN, PIN_HIGH);
125        rt_thread_mdelay(500);
126        rt_pin_write(LED_PIN, PIN_LOW);
127        rt_thread_mdelay(500);
128    }
129}
130```
131
132### Advanced Usage
133
134**Resources and Documentation**
135
136- [Development Board Official Homepage](https://www.renesas.cn/zh/products/microcontrollers-microprocessors/rz-mpus/rzn2l-integrated-tsn-compliant-3-port-gigabit-ethernet-switch-enables-various-industrial-applications)
137- [Development Board Datasheet](https://www.renesas.cn/zh/document/dst/rzn2l-group-datasheet?r=1622651)
138- [Development Board Hardware Manual](https://www.renesas.cn/zh/document/mah/rzn2l-group-users-manual-hardware?r=1622651)
139- [EtherKit_User_Manual](https://github.com/RT-Thread-Studio/sdk-bsp-rzn2l-etherkit/blob/master/docs/EtherKit_User_Manual.pdf)
140- [RZ/N2L MCU Quick Start Guide](https://www.renesas.cn/zh/document/apn/rzt2-rzn2-device-setup-guide-flash-boot-application-note?r=1622651)
141- [RZ/N2L Easy Download Guide](https://www.renesas.cn/zh/document/gde/rzn2l-easy-download-guide?r=1622651)
142- [Renesas RZ/N2L Group](https://www.renesas.cn/zh/document/fly/renesas-rzn2l-group?r=1622651)
143
144**FSP Configuration**
145
146To modify Renesas BSP peripheral configurations or add new peripheral ports, the Renesas [FSP](https://www2.renesas.cn/jp/zh/software-tool/flexible-software-package-fsp#document) configuration tool is required. Please follow the steps outlined below for configuration. For any questions regarding the configuration, please visit the [RT-Thread Community Forum](https://club.rt-thread.org/).
147
1481. [Download the Flexible Software Package (FSP) | Renesas](https://github.com/renesas/rzn-fsp/releases/download/v2.0.0/setup_rznfsp_v2_0_0_rzsc_v2024-01.1.exe), use FSP version 2.0.0.
1492. To add the **"EtherKit Board Support Package"** to FSP, refer to the document [How to Import a BSP](https://www2.renesas.cn/document/ppt/1527171?language=zh&r=1527191).
1503. For guidance on configuring peripheral drivers using FSP, refer to the document: [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-series-using-FSP-configure-peripheral-drivers?id=ra-series-using-fsp-configure-peripheral-drivers).
151
152**ENV Configuration**
153
154- To learn how to use the ENV tool, refer to the [RT-Thread ENV Tool User Manual](https://www.rt-thread.org/document/site/#/development-tools/env/env).
155
156By default, this BSP only enables the UART0 functionality. To use more advanced features such as components, software packages, and more, the ENV tool must be used for configuration.
157
158The steps are as follows:
1591. Open the ENV tool in the `bsp` directory.
1602. Use the `menuconfig` command to configure the project. Save and exit once the configuration is complete.
1613. Run the `pkgs --update` command to update the software packages.
1624. Run the `scons --target=iar` command to regenerate the project.
163
164## Contact Information
165
166If you have any thoughts or suggestions during usage, please feel free to contact us via the [RT-Thread Community Forum](https://club.rt-thread.org/).
167
168## Contribute Code
169
170If you're interested in EtherKit and have some exciting projects you'd like to share, we welcome code 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).
171

README_zh.md

1# EtherKit 开发板 BSP 说明
2
3**中文** | [**English**](./README.md)
4
5## 简介
6
7本文档为 RT-Thread EtherKit 开发板提供的 BSP (板级支持包) 说明。通过阅读快速上手章节开发者可以快速地上手该 BSP，将 RT-Thread 运行在开发板上。
8
9主要内容如下：
10
11- 开发板介绍
12- BSP 快速上手指南
13
14## 开发板介绍
15
16基于瑞萨 RZ/N2L 开发的 EtherKit 开发板，通过灵活配置软件包和 IDE，对嵌入系统应用程序进行开发。
17
18开发板正面外观如下图：
19
20![image-20240314165241884](figures\big.png)
21
22该开发板常用 **板载资源** 如下：
23
24- MPU：R9A07G084M04GBG，最大工作频率 400MHz，Arm Cortex®-R52 内核，紧密耦合内存 128KB（带 ECC），内部 RAM 1.5 MB（带 ECC）
25- 调试接口：板载 J-Link 接口
26- 扩展接口：一个 PMOD 连接器
27
28**更多详细资料及工具**
29
30## 外设支持
31
32本 BSP 目前对外设的支持情况如下：
33
34| **EtherCAT方案** | **支持情况** | **EtherCAT方案** | **支持情况** |
35| ---------------- | ------------ | ---------------- | ------------ |
36| EtherCAT_IO      | 支持         | EtherCAT_FOE      | 支持   		|
37| EtherCAT_EOE     | 支持         | EtherCAT_COE | 支持 |
38| **PROFINET方案** | **支持情况** | **Ethernet/IP方案** | **支持情况** |
39| P-Net（支持ProfiNET从站协议栈的开源评估软件包） | 支持         | EIP   | 支持 |
40| **片上外设**     | **支持情况** | **组件**         | **支持情况** |
41| UART             | 支持         | LWIP             | 支持         |
42| GPIO             | 支持         | TCP/UDP          | 支持         |
43| HWIMER           | 支持         | MQTT             | 支持         |
44| IIC              | 支持         | TFTP             | 支持         |
45| WDT              | 支持         | Modbus主从站协议 | 支持         |
46| RTC              | 支持         |                  |              |
47| ADC              | 支持         |                  |              |
48| DAC              | 支持         |                  |              |
49| SPI              | 支持         |                  |              |
50
51## 使用说明
52
53使用说明分为如下两个章节：
54
55- 快速上手
56
57  本章节是为刚接触 RT-Thread 的新手准备的使用说明，遵循简单的步骤即可将 RT-Thread 操作系统运行在该开发板上，看到实验效果 。
58- 进阶使用
59
60  本章节是为需要在 RT-Thread 操作系统上使用更多开发板资源的开发者准备的。通过使用 ENV 工具对 BSP 进行配置，可以开启更多板载资源，实现更多高级功能。
61
62### 快速上手
63
64本 BSP 目前提供 GCC/IAR 工程。下面以 [IAR Embedded Workbench for Arm](https://www.iar.com/products/architectures/arm/iar-embedded-workbench-for-arm/) 开发环境为例，介绍如何将系统运行起来。
65
66**硬件连接**
67
68使用 USB 数据线连接开发板到 PC，使用 J-link 接口下载和 DEBUG 程序。
69
70**编译下载**
71
72- 进入 bsp 目录下，打开 ENV 使用命令 `scons --target=iar` 生成 IAR工程。
73- 编译：双击 project.eww 文件，打开 IAR 工程，编译程序。
74- 调试：IAR 左上方导航栏点击 `Project->Download and Debug`下载并启动调试。
75
76**查看运行结果**
77
78下载程序成功之后，系统会自动运行并打印系统信息。
79
80连接开发板对应串口到 PC , 在终端工具里打开相应的串口（115200-8-1-N），复位设备后，可以看到 RT-Thread 的输出信息。输入 help 命令可查看系统中支持的命令。
81
82```bash
83 \ | /
84- RT -     Thread Operating System
85 / | \     5.1.0 build Mar 14 2024 18:26:01
86 2006 - 2024 Copyright by RT-Thread team
87
88Hello RT-Thread!
89==================================================
90This is a iar project which mode is ram execution!
91==================================================
92msh >help
93RT-Thread shell commands:
94clear            - clear the terminal screen
95version          - show RT-Thread version information
96list             - list objects
97backtrace        - print backtrace of a thread
98help             - RT-Thread shell help
99ps               - List threads in the system
100free             - Show the memory usage in the system
101pin              - pin [option]
102
103msh >
104```
105
106**应用入口函数**
107
108应用层的入口函数在 **src\hal_entry.c** 中 的 `void hal_entry(void)` 。用户编写的源文件可直接放在 src 目录下。
109
110```c
111void hal_entry(void)
112{
113    rt_kprintf("\nHello RT-Thread!\n");
114    rt_kprintf("==================================================\n");
115    rt_kprintf("This is a iar project which mode is ram execution!\n");
116    rt_kprintf("==================================================\n");
117
118    while (1)
119    {
120        rt_pin_write(LED_PIN, PIN_HIGH);
121        rt_thread_mdelay(500);
122        rt_pin_write(LED_PIN, PIN_LOW);
123        rt_thread_mdelay(500);
124    }
125}
126```
127
128### 进阶使用
129
130**资料及文档**
131
132- [开发板官网主页](https://www.renesas.cn/zh/products/microcontrollers-microprocessors/rz-mpus/rzn2l-integrated-tsn-compliant-3-port-gigabit-ethernet-switch-enables-various-industrial-applications)
133- [开发板数据手册](https://www.renesas.cn/zh/document/dst/rzn2l-group-datasheet?r=1622651)
134- [开发板硬件手册](https://www.renesas.cn/zh/document/mah/rzn2l-group-users-manual-hardware?r=1622651)
135- [EtherKit用户手册](https://github.com/RT-Thread-Studio/sdk-bsp-rzn2l-etherkit/blob/master/docs/EtherKit_User_Manual.pdf)
136- [RZ/N2L MCU 快速入门指南](https://www.renesas.cn/zh/document/apn/rzt2-rzn2-device-setup-guide-flash-boot-application-note?r=1622651)
137- [RZ/N2L Easy Download Guide](https://www.renesas.cn/zh/document/gde/rzn2l-easy-download-guide?r=1622651)
138- [Renesas RZ/N2L Group](https://www.renesas.cn/zh/document/fly/renesas-rzn2l-group?r=1622651)
139
140**FSP 配置**
141
142需要修改瑞萨的 BSP 外设配置或添加新的外设端口，需要用到瑞萨的 [FSP](https://www2.renesas.cn/jp/zh/software-tool/flexible-software-package-fsp#document) 配置工具。请务必按照如下步骤完成配置。配置中有任何问题可到[RT-Thread 社区论坛](https://club.rt-thread.org/)中提问。
143
1441. [下载灵活配置软件包 (FSP) | Renesas](https://github.com/renesas/rzn-fsp/releases/download/v2.0.0/setup_rznfsp_v2_0_0_rzsc_v2024-01.1.exe)，请使用 FSP 2.0.0 版本
1452. 如何将 **”EtherKit板级支持包“**添加到 FSP 中，请参考文档[如何导入板级支持包](https://www2.renesas.cn/document/ppt/1527171?language=zh&r=1527191)
1463. 请参考文档：[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-配置外设驱动)。
147
148**ENV 配置**
149
150- 如何使用 ENV 工具：[RT-Thread env 工具用户手册](https://www.rt-thread.org/document/site/#/development-tools/env/env)
151
152此 BSP 默认只开启了 UART0 的功能，如果需使用更多高级功能例如组件、软件包等，需要利用 ENV 工具进行配置。
153
154步骤如下：
1551. 在 bsp 下打开 env 工具。
1562. 输入`menuconfig`命令配置工程，配置好之后保存退出。
1573. 输入`pkgs --update`命令更新软件包。
1584. 输入`scons --target=iar` 命令重新生成工程。
159
160## 联系人信息
161
162在使用过程中若您有任何的想法和建议，建议您通过以下方式来联系到我们  [RT-Thread 社区论坛](https://club.rt-thread.org/)
163
164## 贡献代码
165
166如果您对 EtherKit 感兴趣，并且有一些好玩的项目愿意与大家分享的话欢迎给我们贡献代码，您可以参考 [如何向 RT-Thread 代码贡献](https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/development-guide/github/github)。