Skip to content

Commit e179044

Browse files
committed
boards: renesas: Update documentation for Renesas RA boards
- Update boards documetation with new format - Correct typo for documentation of RA boards Signed-off-by: Quy Tran <[email protected]>
1 parent caa284e commit e179044

File tree

16 files changed

+143
-225
lines changed

16 files changed

+143
-225
lines changed

boards/renesas/ek_ra2a1/doc/index.rst

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _ek_ra2a1:
1+
.. zephyr:board:: ek_ra2a1
22
33
RA2A1 Evaluation Kit
44
####################
@@ -31,12 +31,6 @@ Renesas RA2A1 Microcontroller Group has following features
3131
- Watchdog Timer
3232
- 49 Input/Output pins
3333

34-
.. figure:: ek_ra2a1.webp
35-
:align: center
36-
:alt: RA2A1 Evaluation Kit
37-
38-
EK-RA2A1 Board Functional Area Definitions (Credit: Renesas Electronics Corporation)
39-
4034
Hardware
4135
********
4236

boards/renesas/ek_ra4e2/doc/index.rst

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _ek_ra4e2:
1+
.. zephyr:board:: ek_ra4e2
22
33
RA4E2 Evaluation Kit
44
####################
@@ -16,17 +16,19 @@ The MCU in this series incorporates a high-performance Arm Cortex®-M33 core run
1616
100 MHz with the following features:
1717

1818
**MCU Native Pin Access**
19+
1920
- R7FA4E2B93CFM MCU (referred to as RA MCU)
2021
- 100 MHz, Arm® Cortex®-M33 core
2122
- 128 kB Code Flash, 40 kB SRAM
2223
- 64 pins, LQFP package
2324
- Native pin access through 2 x 14-pin and 1 x 40-pin male headers
2425
- MCU current measurement points for precision current consumption measurement
2526
- Multiple clock sources - RA MCU oscillator and sub-clock oscillator crystals, providing precision
26-
20.000 MHz and 32,768 Hz reference clock. Additional low-precision clocks are available internal to the
27-
RA MCU
27+
20.000 MHz and 32,768 Hz reference clock. Additional low-precision clocks are available internal to the
28+
RA MCU
2829

2930
**System Control and Ecosystem Access**
31+
3032
- USB Full Speed Device (micro-AB connector)
3133
- Three 5 V input sources
3234

@@ -61,15 +63,9 @@ RA MCU
6163

6264
- CAN FD (3-pin header)
6365

64-
.. figure:: ek_ra4e2.webp
65-
:align: center
66-
:alt: RA4E2 Evaluation Kit
67-
68-
EK-RA4E2 Board Functional Area Definitions (Credit: Renesas Electronics Corporation)
69-
7066
Hardware
7167
********
72-
Detail Hardware feature for the RA4E2 MCU group can be found at `RA4E2 Group User's Manual Hardware`_
68+
Detailed hardware features for the RA4E2 MCU group can be found at `RA4E2 Group User's Manual Hardware`_
7369

7470
.. figure:: ra4e2_block_diagram.webp
7571
:width: 442px
@@ -78,12 +74,12 @@ Detail Hardware feature for the RA4E2 MCU group can be found at `RA4E2 Group Use
7874

7975
RA4E2 Block diagram (Credit: Renesas Electronics Corporation)
8076

81-
Detail Hardware feature for the EK-RA4E2 MCU can be found at `EK-RA4E2 - User's Manual`_
77+
Detailed hardware features for the EK-RA4E2 MCU can be found at `EK-RA4E2 - User's Manual`_
8278

8379
Supported Features
8480
==================
8581

86-
The below features are currently supported on Zephyr OS for EK-RA4E2 board:
82+
The below features are currently supported on Zephyr for EK-RA4E2 board:
8783

8884
+-----------+------------+----------------------+
8985
| Interface | Controller | Driver/Component |
@@ -127,11 +123,11 @@ SEGGER J-link's drivers are avaialbe at https://www.segger.com/downloads/jlink/
127123

128124
To flash the program to board
129125

130-
1. Connect to J-Link OB via USB port to host PC
126+
1. Connect to J-Link OB via USB port to host PC
131127

132-
2. Make sure J-Link OB jumper is in default configuration as describe in `EK-RA4E2 - User's Manual`_
128+
2. Make sure J-Link OB jumper is in default configuration as describe in `EK-RA4E2 - User's Manual`_
133129

134-
3. Execute west command
130+
3. Execute west command
135131

136132
.. code-block:: console
137133

boards/renesas/ek_ra4m2/doc/index.rst

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _ek_ra4m2:
1+
.. zephyr:board:: ek_ra4m2
22
33
RA4M2 Evaluation Kit
44
####################
@@ -17,17 +17,19 @@ The MCU in this series incorporates a high-performance Arm Cortex®-M33 core run
1717
100 MHz with the following features:
1818

1919
**Renesas RA4M2 Microcontroller Group**
20+
2021
- R7FA4M2AD3CFP
2122
- 100-pin LQFP package
2223
- 100 MHz Arm® Cortex®-M33 core
2324
- 512 kB Code Flash, 128 KB SRAM
2425
- Native pin access through 4 x 28-pin male headers
2526
- MCU current measurement points for precision current consumption measurement
26-
- Multiple clock sources - RA MCU oscillator and sub-clock oscillator crystals, providing
27-
precision 24.000 MHz and 32,768 Hz reference clock. Additional low-precision clocks are
28-
available internal to the RA MCU
27+
- Multiple clock sources - RA MCU oscillator and sub-clock oscillator crystals, providing
28+
precision 24.000 MHz and 32,768 Hz reference clock. Additional low-precision clocks are
29+
available internal to the RA MCU
2930

3031
**System Control and Ecosystem Access**
32+
3133
- USB Full Speed Host and Device (micro AB connector)
3234
- Three 5 V input sources
3335

@@ -59,17 +61,12 @@ available internal to the RA MCU
5961
- MCU boot configuration jumper
6062

6163
**Special Feature Access**
62-
- 32 MB (256 Mb) External Quad-SPI Flash
6364

64-
.. figure:: ek_ra4m2.webp
65-
:align: center
66-
:alt: RA4M2 Evaluation Kit
67-
68-
EK-RA4M2 Board Functional Area Definitions (Credit: Renesas Electronics Corporation)
65+
- 32 MB (256 Mb) External Quad-SPI Flash
6966

7067
Hardware
7168
********
72-
Detail Hardware feature for the RA4M2 MCU group can be found at `RA4M2 Group User's Manual Hardware`_
69+
Detailed hardware features for the RA4M2 MCU group can be found at `RA4M2 Group User's Manual Hardware`_
7370

7471
.. figure:: ra4m2_block_diagram.webp
7572
:width: 442px
@@ -78,12 +75,12 @@ Detail Hardware feature for the RA4M2 MCU group can be found at `RA4M2 Group Use
7875

7976
RA4M2 Block diagram (Credit: Renesas Electronics Corporation)
8077

81-
Detail Hardware feature for the EK-RA4M2 MCU can be found at `EK-RA4M2 - User's Manual`_
78+
Detailed hardware features for the EK-RA4M2 MCU can be found at `EK-RA4M2 - User's Manual`_
8279

8380
Supported Features
8481
==================
8582

86-
The below features are currently supported on Zephyr OS for EK-RA4M2 board:
83+
The below features are currently supported on Zephyr for EK-RA4M2 board:
8784

8885
+-----------+------------+----------------------+
8986
| Interface | Controller | Driver/Component |
@@ -131,11 +128,11 @@ SEGGER J-link's drivers are avaialbe at https://www.segger.com/downloads/jlink/
131128

132129
To flash the program to board
133130

134-
1. Connect to J-Link OB via USB port to host PC
131+
1. Connect to J-Link OB via USB port to host PC
135132

136-
2. Make sure J-Link OB jumper is in default configuration as describe in `EK-RA4M2 - User's Manual`_
133+
2. Make sure J-Link OB jumper is in default configuration as describe in `EK-RA4M2 - User's Manual`_
137134

138-
3. Execute west command
135+
3. Execute west command
139136

140137
.. code-block:: console
141138

boards/renesas/ek_ra4m3/doc/index.rst

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _ek_ra4m3:
1+
.. zephyr:board:: ek_ra4m3
22
33
RA4M3 Evaluation Kit
44
####################
@@ -18,6 +18,7 @@ The MCU in this series incorporates a high-performance Arm Cortex®-M33 core run
1818
100 MHz with the following features:
1919

2020
**MCU Native Pin Access**
21+
2122
- R7FA4M3AF3CFB
2223
- 100-pin LQFP package
2324
- 100 MHz Arm® Cortex®-M33 core
@@ -26,32 +27,30 @@ The MCU in this series incorporates a high-performance Arm Cortex®-M33 core run
2627
- Native pin access through 4 x 40-pin male headers
2728
- MCU and USB current measurement points for precision current consumption measurement
2829
- Multiple clock sources - RA MCU oscillator and sub-clock oscillator crystals, providing precision
29-
24.000 MHz and 32,768 Hz reference clock. Additional low-precision clocks are available internal to the
30-
RA MCU
30+
24.000 MHz and 32,768 Hz reference clock. Additional low-precision clocks are available internal to the
31+
RA MCU
3132

3233
**System Control and Ecosystem Access**
34+
3335
- USB Full Speed Host and Device (micro AB connector)
34-
- Three 5 V input sources
3536

37+
- Three 5 V input sources
3638
- USB (Debug, Full Speed)
3739
- External power supply (using surface mount clamp test points and power input vias)
3840

39-
Three Debug modes
40-
41+
- Three Debug modes
4142
- Debug on-board (SWD)
4243
- Debug in (ETM, SWD, and JTAG)
4344
- Debug out (SWD)
4445

45-
User LEDs and buttons
46-
46+
- User LEDs and buttons
4747
- Three User LEDs (red, blue, green)
4848
- Power LED (white) indicating availability of regulated power
4949
- Debug LED (yellow) indicating the debug connection
5050
- Two User buttons
5151
- One Reset button
5252

5353
- Five most popular ecosystems expansions
54-
5554
- 2 Seeed Grove® system (I2C/Analog) connectors
5655
- SparkFun® Qwiic® connector
5756
- 2 Digilent PmodTM (SPI and UART) connectors
@@ -63,15 +62,9 @@ RA MCU
6362
**Special Feature Access**
6463
- 32 MB (256 Mb) External Quad-SPI Flash
6564

66-
.. figure:: ek_ra4m3.webp
67-
:align: center
68-
:alt: RA4M3 Evaluation Kit
69-
70-
EK-RA4M3 Board Functional Area Definitions (Credit: Renesas Electronics Corporation)
71-
7265
Hardware
7366
********
74-
Detail Hardware feature for the RA4M3 MCU group can be found at `RA4M3 Group User's Manual Hardware`_
67+
Detailed hardware features for the RA4M3 MCU group can be found at `RA4M3 Group User's Manual Hardware`_
7568

7669
.. figure:: ra4m3_block_diagram.webp
7770
:width: 442px
@@ -80,12 +73,12 @@ Detail Hardware feature for the RA4M3 MCU group can be found at `RA4M3 Group Use
8073

8174
RA4M3 Block diagram (Credit: Renesas Electronics Corporation)
8275

83-
Detail Hardware feature for the EK-RA4M3 MCU can be found at `EK-RA4M3 - User's Manual`_
76+
Detailed hardware features for the EK-RA4M3 MCU can be found at `EK-RA4M3 - User's Manual`_
8477

8578
Supported Features
8679
==================
8780

88-
The below features are currently supported on Zephyr OS for EK-RA4M3 board:
81+
The below features are currently supported on Zephyr for EK-RA4M3 board:
8982

9083
+-----------+------------+----------------------+
9184
| Interface | Controller | Driver/Component |

boards/renesas/ek_ra4w1/doc/index.rst

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _ek_ra4w1:
1+
.. zephyr:board:: ek_ra4w1
22
33
RA4W1 Evaluation Kit
44
####################
@@ -14,54 +14,56 @@ excellent reception performance. RA4W1 is geared towards IoT application requiri
1414
embedded RAM and low power consumption.
1515

1616
**MCU Native Pin Access**
17+
1718
- R7FA4W1AD2CNG
1819
- QFN-56 package
1920
- On-chip memory: 512-KB ROM, 96-KB RAM, 8-KB data flash memory
2021

2122
**Power-supply voltage**
23+
2224
- USB connector: 5-V input
2325
- Power-supply IC: 5-V input, 3.3-V output
2426
- External power-supply header*1: 3.3-V input, 2 pins x 1
2527

2628
**Main clock**
29+
2730
- Crystal oscillator (surface-mount technology (SMT)) for the main system clock
2831
- Crystal oscillator or ceramic resonator (lead type) for the main system clock
2932

3033
**Sub-clock**
34+
3135
- Crystal oscillator (SMT) for the sub-clock
3236

3337
**Bluetooth Low Energy**
38+
3439
- Bluetooth Low Energy (BLE) circuit x1
3540
- Range of frequency: 2402 to 2480 MHz
3641
- Maximum transmission output power: 4 dBm (in 4-dBm output mode)
3742
- Output variation: +2 dB
3843

3944
**Push switches**
45+
4046
- Reset switch x 1
4147
- User switch x 1
4248

4349
**LED**
50+
4451
- Power indicator: green x 1
4552
- User: green x 2
4653
- ACT LED: green x 1
4754

48-
**Conetivity**
55+
**Connectivity**
56+
4957
- Connector for an on-board emulator: USB Micro-B
5058
- Connector for a USB serial-conversion interface: USB Micro-B
5159
- Pmod™ connector: Angle type, 12 pins
5260
- Arduino™ UNO connectors
5361

54-
- Emulator reset switch
55-
56-
.. figure:: ek_ra4w1.webp
57-
:align: center
58-
:alt: RA4W1 Evaluation Kit
59-
60-
EK-RA4W1 Board Functional Area Definitions (Credit: Renesas Electronics Corporation)
62+
- Emulator reset switch: DIP switch x 1
6163

6264
Hardware
6365
********
64-
Detail Hardware feature for the RA4W1 MCU group can be found at `RA4W1 Group User's Manual Hardware`_
66+
Detailed Hardware features for the RA4W1 MCU group can be found at `RA4W1 Group User's Manual Hardware`_
6567

6668
.. figure:: ra4w1_block_diagram.webp
6769
:width: 442px
@@ -70,12 +72,12 @@ Detail Hardware feature for the RA4W1 MCU group can be found at `RA4W1 Group Use
7072

7173
RA4W1 Block diagram (Credit: Renesas Electronics Corporation)
7274

73-
Detail Hardware feature for the EK-RA4W1 MCU can be found at `EK-RA4W1 - User's Manual`_
75+
Detailed Hardware features for the EK-RA4W1 MCU can be found at `EK-RA4W1 - User's Manual`_
7476

7577
Supported Features
7678
==================
7779

78-
The below features are currently supported on Zephyr OS for EK-RA4W1 board:
80+
The below features are currently supported on Zephyr for EK-RA4W1 board:
7981

8082
+-----------+------------+----------------------+
8183
| Interface | Controller | Driver/Component |
@@ -121,11 +123,11 @@ SEGGER J-link's drivers are avaialbe at https://www.segger.com/downloads/jlink/
121123

122124
To flash the program to board
123125

124-
1. Connect to J-Link OB via USB port to host PC
126+
1. Connect to J-Link OB via USB port to host PC
125127

126-
2. Make sure J-Link OB jumper is in default configuration as describe in `EK-RA4W1 - User's Manual`_
128+
2. Make sure J-Link OB jumper is in default configuration as describe in `EK-RA4W1 - User's Manual`_
127129

128-
3. Execute west command
130+
3. Execute west command
129131

130132
.. code-block:: console
131133

0 commit comments

Comments
 (0)