Skip to content

Commit 188ca7d

Browse files
pi-anldpgeorge
authored andcommitted
renesas-ra/README: Add basic details about board autogen files.
The renesas-ra port board definitions contain auto-generated files which are not easy to understand for someone unfamiliar with the port. This commit adds some notes to the README to assist other developers who want to work on these. The configuration.xml file for the `ARDUINO_PORTENTA_C33` was provided by @iabdalkader. Signed-off-by: Andrew Leech <[email protected]>
1 parent 51974f2 commit 188ca7d

File tree

2 files changed

+673
-0
lines changed

2 files changed

+673
-0
lines changed

ports/renesas-ra/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,26 @@ passed as the argument to `BOARD=`; for example `RA4M1_CLICKER`, `EK_RA4M1`,
6363
The above command should produce binary images `firmware.hex` in the
6464
build-EK_RA6M2/` subdirectory (or the equivalent directory for the board specified).
6565

66+
## Board definition auto-generated code
67+
68+
The supported board definitions contain auto-generated configuration files in
69+
the `boards/<BOARD_NAME>/ra_cfg` and `boards/<BOARD_NAME>/ra_gen` folders.
70+
71+
These are generated with the [RA Smart Configurator](https://www.renesas.com/us/en/software-tool/ra-smart-configurator)
72+
tool which is used to define peripheral configuration, pinouts, interrupts etc. for each board.
73+
74+
This tool can be installed either as part of the "Renesas e² studio", or separately with
75+
the fsp driver package from https://github.com/renesas/fsp/releases eg.
76+
* [setup_fsp_v4_4_0_rasc_v2023-04.exe](https://github.com/renesas/fsp/releases/download/v4.4.0/setup_fsp_v4_4_0_rasc_v2023-04.exe)
77+
* [setup_fsp_v4_4_0_rasc_v2023-04.exe](https://github.com/renesas/fsp/releases/download/v4.4.0/setup_fsp_v4_4_0_rasc_v2023-04.AppImage)
78+
79+
This tool can be used to create new board definitions or modify existing ones
80+
by opening one of the `configuration.xml` files in the board folders.
81+
82+
Once the `configuration.xml` file is opened in RA Smart Configurator and modified as
83+
needed, the "Generate Project Content" button can be pressed to export new copies
84+
of the `ra_cfg` and `ra_gen` folders.
85+
6686
## Supported/Unsupported functions
6787
Please refer to the `renesas-ra` quick reference.
6888

0 commit comments

Comments
 (0)