Skip to content

Commit 54f5743

Browse files
aailletkartben
authored andcommitted
boards: renesas: Create spider_s4 all-in-one doc
Merge both dedicated r52 and a55 spider_s4 boards doc into an all-in-one documentation and take advantage of these new boards documentation features: - zephyr:board - zephyr:board-supported-hw - zephyr:board-supported-runners Signed-off-by: Aymeric Aillet <aymeric.aillet@iot.bzh>
1 parent 5935998 commit 54f5743

File tree

4 files changed

+117
-135
lines changed

4 files changed

+117
-135
lines changed
Binary file not shown.

boards/renesas/rcar_spider_s4/doc/rcar_spider_r52.rst renamed to boards/renesas/rcar_spider_s4/doc/index.rst

Lines changed: 117 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,118 @@
1-
.. _rcar_spider_boards:
2-
3-
Renesas R-Car Spider
4-
####################
1+
.. zephyr:board:: rcar_spider_s4
52
63
Overview
74
********
85

9-
| R-Car S4 enables the launch of Car Server/CoGW with high performance, high-speed networking,
10-
| high security and high functional safety levels that are required as E/E architectures
11-
| evolve into domains and zones.
6+
R-Car S4 Spider board is based on the R-Car S4 SoC made for Car
7+
Server/Communication Gateway and that is composed of a octo Cortex |reg|-A55, a
8+
dual lockstep Cortex |reg|-R52 and a double dual lockstep G4MH.
9+
10+
The R-Car S4 SoC enables the launch of Car Server/CoGW with high performance,
11+
high-speed networking, high security and high functional safety levels that are
12+
required as E/E architectures evolve into domains and zones.
1213

13-
| The R-Car S4 solution allows designers to re-use up to 88 percent of software code developed
14-
| for 3rd generation R-Car SoCs and RH850 MCU applications.\
15-
| The software package supports the real-time cores with various drivers and basic software
16-
| such as Linux BSP and hypervisors.
14+
The R-Car S4 solution allows designers to re-use up to 88 percent of software
15+
code developed for 3rd generation R-Car SoCs and RH850 MCU applications.
16+
The software package supports the real-time cores with various drivers and
17+
basic software such as Linux BSP and hypervisors.
1718

1819
The Renesas R-Car Spider board is the Renesas R-Car S4 reference board and is designed for
1920
evaluating features and performance of this SoC.
2021

21-
.. figure:: img/rcar_s4_spider_full.jpg
22-
:align: center
23-
:alt: R-Car S4 Spider
22+
Zephyr OS support is available for both Cortex |reg|-A cores & Cortex |reg|-R52 core.
2423

25-
More information about the board can be found at `Renesas R-Car S4 Spider`_ website.
24+
More information about the S4 SoC can be fount at `Renesas R-Car S4 chip`_.
2625

2726
Hardware
2827
********
2928

30-
Hardware capabilities for the S4 Spider board can be found on the `eLinux S4 Spider`_ page.
31-
32-
.. figure:: img/rcar_s4_block_diagram.jpg
33-
:align: center
34-
:alt: R-Car S4 Spider block diagram
29+
- Spider features:
30+
31+
- Connectors
32+
33+
- CPU Board:
34+
35+
- CN1 JTAG1
36+
- CN2 JTAG2
37+
- CN3 EX-SPI (QSPI0)
38+
- CN4 MicroSD Slot (back side)
39+
- CN11 EXIO Connector A (back side)
40+
- CN12 EXIO Connector B (back side)
41+
- CN14 EVT
42+
- CN16 OcuLink (PCIe0,PCIe1)
43+
- CN24 CAN 4pin
44+
- CN20 USB microAB (SCIF0)
45+
- CN21 USB microAB (HSCIF0)
46+
- CN22 SW Board
47+
- CN23 CPLD JTAG
48+
- CN27 FAN
49+
- CN30 Buck3
50+
- CN31 Buck1
51+
- CN32 CAN 8pin (back side)
52+
- Breakout Board:
53+
54+
- CN11 EXIO Connector A
55+
- CN12 EXIO Connector B
56+
- CN13 CAN 0/1
57+
- CN15 CAN 3/4/5
58+
- CN18 CAN 6/7/8
59+
- CN21 CAN 2/9/10/11
60+
- CN24 CAN 12/13/14/15
61+
- CN28 LIN0
62+
- CN29 LIN1
63+
- CN30 LIN2
64+
- CN31 LIN3
65+
- CN32 LIN4
66+
- CN33 LIN5
67+
- CN34 LIN6
68+
- CN35 LIN7
69+
- CN36 EtherTS
70+
- CN37 MSIOF0
71+
- CN38 CAN/LIN BOARD
72+
- CN39 GPIO CN_A
73+
- CN40 GPIO
74+
- CN41 I2C
75+
- CN42 HSCIF0
76+
- CN43 SCIF0
77+
- CN44 TSN_CN
78+
- CN45 Legacy 12V-in
79+
- CN46 AC Adapter
80+
- CN48 POWER CONTROL
81+
- CN50 Debug Serial
82+
- CN51 FAN
83+
- Input
84+
85+
- SW1 (SPI Flash Memory / EX-SPI connector)
86+
- SW2 (Hyper Flash Memory / SPI Flash Memory)
87+
- SW3 (MicroSD Card Slot / eMMC Memory)
88+
- SW4 (PRESETn)
89+
- SW6 (Interface Voltage Setting for MMC/JTAG2)
90+
- SW8 Mode Setting
91+
- SW10 (Software Switch)
92+
- SW11 (Board Power-Supply Circuit Control)
93+
- SW12 (AURORES#)
94+
- SW13 (CANFD0 RX)
95+
- SW14 (CANFD0 TX)
96+
- SW15 (System Reset Switch)
97+
- Output
98+
99+
- LED7 Software Controllable LED
100+
- LED8 Software Controllable LED
35101

36-
.. note:: We support Zephyr running on the CR52 processor that is provided for RTOS purpose.
37-
38-
More information about the SoC that equips the board can be found here:
39-
40-
- `Renesas R-Car S4 chip`_
41102

42103
Supported Features
43104
==================
44105

45-
Here are the current supported features when running Zephyr Project on the R-Car S4 Spider CR52:
46-
47-
+-----------+------------------------------+--------------------------------+
48-
| Interface | Driver/components | Support level |
49-
+===========+==============================+================================+
50-
| PINMUX | pinmux | |
51-
+-----------+------------------------------+--------------------------------+
52-
| CLOCK | clock_control | |
53-
+-----------+------------------------------+--------------------------------+
54-
| GPIO | gpio | |
55-
+-----------+------------------------------+--------------------------------+
56-
| UART | uart | serial port-polling |
57-
+ + + +
58-
| | FT232RQ | serial port-interrupt |
59-
+-----------+------------------------------+--------------------------------+
60-
| I2C | i2c | interrupt driven |
61-
+-----------+------------------------------+--------------------------------+
62-
| PWM | pwm | All channels |
63-
+-----------+------------------------------+--------------------------------+
64-
65-
It is also currently possible to write on the ram console.
66-
67-
More features will be supported soon.
106+
.. zephyr:board-supported-hw::
107+
108+
.. note::
109+
110+
It is recommended to disable peripherals used by the R52 core on the Linux host.
68111

69112
Connections and IOs
70113
===================
71114

72-
| The "Spider board" consists of a CPU board and a Breakout board.
73-
| The CPU board is stuck on top of the Breakout board.
115+
The Spider board consists of a CPU board plugged on top of a Breakout board.
74116

75117
Here are the official IOs figures from eLinux for S4 board:
76118

@@ -108,8 +150,30 @@ I2C is mainly used to manage and power-on some onboard chips on the S4 Spider bo
108150
Embedded I2C devices and I/O expanders are not yet supported.
109151
The current I2C support therefore does not make any devices available to the user at this time.
110152

111-
Programming and Debugging
112-
*************************
153+
Programming and Debugging (A55)
154+
*******************************
155+
156+
At that time, no direct flashing method is officially supported by this Zephyr port.
157+
However, it is possible to load the Zephyr binary using U-Boot commands.
158+
159+
One of the ways to load Zephyr is shown below.
160+
161+
.. code-block:: console
162+
163+
tftp 0x48000000 <tftp_server_path/zephyr.bin>
164+
booti 0x48000000
165+
166+
Here is an example for the :zephyr:code-sample:`hello_world` application.
167+
168+
.. zephyr-app-commands::
169+
:zephyr-app: samples/hello_world
170+
:board: rcar_spider_s4/r8a779f0/a55
171+
:goals: build
172+
173+
Programming and Debugging (R52)
174+
*******************************
175+
176+
.. zephyr:board-supported-runners::
113177
114178
Build and flash applications as usual (see :ref:`build_an_application` and
115179
:ref:`application_run` for more details).
@@ -177,6 +241,7 @@ By continuing the app, you should see the following message in the terminal:
177241
*** Booting Zephyr OS build v3.3.0-rc2 ***
178242
Hello World! rcar_spider_s4
179243
244+
180245
References
181246
**********
182247

boards/renesas/rcar_spider_s4/doc/rcar_spider_a55.rst

Lines changed: 0 additions & 83 deletions
This file was deleted.

0 commit comments

Comments
 (0)