Skip to content

Commit c0112f8

Browse files
committed
doc: Add Renesas Spider board documentation
Adding Spider board documentation based on Renesas official documentation and following Zephyr guideline. The documentation is describing the board and its current Zephyr support. Signed-off-by: Aymeric Aillet <[email protected]>
1 parent a88ed59 commit c0112f8

File tree

3 files changed

+187
-0
lines changed

3 files changed

+187
-0
lines changed
215 KB
Loading
276 KB
Loading
Lines changed: 187 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,187 @@
1+
.. _rcar_spider_boards:
2+
3+
Renesas R-Car Spider
4+
####################
5+
6+
Overview
7+
********
8+
9+
R-Car S4 enables the launch of Car Server/CoGW with high performance, high-speed networking, high security and high functional safety levels that are required as E/E architectures evolve into domains and zones.
10+
The R-Car S4 solution allows designers to re-use up to 88 percent of software code developed for 3rd generation R-Car SoCs and RH850 MCU applications.
11+
The software package supports the real-time cores with various drivers and basic software such as Linux BSP and hypervisors.
12+
13+
The Renesas R-Car Spider board is the Renesas R-Car S4 reference board and is designed for evaluating features and performance of this SoC.
14+
15+
.. figure:: img/rcar_s4_spider_full.jpg
16+
:align: center
17+
:alt: R-Car S4 Spider
18+
19+
More information about the board can be found at `Renesas R-Car S4 Spider`_ website.
20+
21+
Hardware
22+
********
23+
24+
Hardware capabilities for the S4 Spider board can be found on the `eLinux S4 Spider`_ page.
25+
26+
.. figure:: img/rcar_s4_block_diagram.jpg
27+
:align: center
28+
:alt: R-Car S4 Spider block diagram
29+
30+
.. note:: We support Zephyr running on the CR52 processor that is provided for RTOS purpose.
31+
32+
More information about the SoC that equips the board can be found here:
33+
34+
- `Renesas R-Car S4 chip`_
35+
36+
Supported Features
37+
==================
38+
39+
Here are the current supported features when running Zephyr Project on the R-Car S4 Spider CR52:
40+
41+
+-----------+------------------------------+--------------------------------+
42+
| Interface | Driver/components | Support level |
43+
+===========+==============================+================================+
44+
| PINMUX | pinmux | |
45+
+-----------+------------------------------+--------------------------------+
46+
| CLOCK | clock_control | |
47+
+-----------+------------------------------+--------------------------------+
48+
| GPIO | gpio | |
49+
+-----------+------------------------------+--------------------------------+
50+
| UART | uart | serial port-polling |
51+
+ + + +
52+
| | FT232RQ | serial port-interrupt |
53+
+-----------+------------------------------+--------------------------------+
54+
| I2C | i2c | interrupt driven |
55+
+-----------+------------------------------+--------------------------------+
56+
| PWM | pwm | All channels |
57+
+-----------+------------------------------+--------------------------------+
58+
59+
It is also currently possible to write on the ram console.
60+
61+
More features will be supported soon.
62+
63+
Connections and IOs
64+
===================
65+
66+
The "Spider board" consists of a CPU board and a Breakout board. The CPU board is stuck on top of the Breakout board.
67+
68+
Here are the official IOs figures from eLinux for S4 board:
69+
70+
`S4 Spider CPU board IOs`_
71+
72+
`S4 Spider breakout board IOs`_
73+
74+
GPIO
75+
----
76+
77+
By running Zephyr on S4 Spider, the software controllable LED 'LED8' can be used as output.
78+
79+
UART
80+
----
81+
82+
Here is information about both serial ports provided on the S4 Spider board :
83+
84+
+--------------------+-------------------+--------------------+-------------+------------------------+
85+
| Physical Interface | Physical Location | Software Interface | Converter | Further Information |
86+
+====================+===================+====================+=============+========================+
87+
| CN20 USB Port | CPU Board | SCIF0 | FT232HQ | Default Zephyr serial |
88+
+--------------------+-------------------+--------------------+-------------+------------------------+
89+
| CN21 USB Port | CPU Board | SCIF3 | FT2232H-56Q | Used by U-BOOT & Linux |
90+
+--------------------+-------------------+--------------------+-------------+------------------------+
91+
92+
.. note:: The Zephyr console output is assigned to SCIF0 (CN20 USB Port) with settings 115200 8N1 without hardware flow control by default.
93+
94+
I2C
95+
---
96+
97+
I2C is mainly used to manage and power-on some onboard chips on the S4 Spider board.
98+
99+
Embedded I2C devices and I/O expanders are not yet supported. The current I2C support therefore does not make any devices available to the user at this time.
100+
101+
Programming and Debugging
102+
*************************
103+
104+
Build and flash applications as usual (see :ref:`build_an_application` and
105+
:ref:`application_run` for more details).
106+
107+
Supported Debug Probe
108+
=====================
109+
110+
The "Olimex ARM-USB-OCD-H" probe is the only officially supported probe. This probe is supported by OpenOCD that is shipped with the Zephyr SDK.
111+
112+
The "Olimex ARM-USB-OCD-H" probe needs to be connected with a "Coresight 20 pins" adapter to CN1 connector on Spider board.
113+
114+
Configuring a Console
115+
=====================
116+
117+
Connect a USB cable from your PC to CN20 USB port of your Spider board.
118+
119+
Use the following settings with your serial terminal of choice (minicom, putty,
120+
etc.):
121+
122+
- Speed: 115200
123+
- Data: 8 bits
124+
- Parity: None
125+
- Stop bits: 1
126+
127+
Flashing
128+
========
129+
130+
First of all, open your serial terminal.
131+
132+
Applications for the ``rcar_spider_cr52`` board configuration can be built in the usual way (see :ref:`build_an_application` for more details).
133+
134+
.. zephyr-app-commands::
135+
:zephyr-app: samples/hello_world
136+
:board: rcar_spider_cr52
137+
:goals: flash
138+
139+
You should see the following message in the terminal:
140+
141+
.. code-block:: console
142+
143+
*** Booting Zephyr OS build v3.3.0-rc2 ***
144+
Hello World! rcar_spider_cr52
145+
146+
Debugging
147+
=========
148+
149+
First of all, open your serial terminal.
150+
151+
Here is an example for the :ref:`hello_world` application.
152+
153+
.. zephyr-app-commands::
154+
:zephyr-app: samples/hello_world
155+
:board: rcar_spider_cr52
156+
:goals: debug
157+
158+
You will then get access to a GDB session for debugging.
159+
160+
By continuing the app, you should see the following message in the terminal:
161+
162+
.. code-block:: console
163+
164+
*** Booting Zephyr OS build v3.3.0-rc2 ***
165+
Hello World! rcar_spider_cr52
166+
167+
References
168+
**********
169+
170+
- `Renesas R-Car S4 Spider`_
171+
- `Renesas R-Car S4 chip`_
172+
- `eLinux S4 Spider`_
173+
174+
.. _Renesas R-Car S4 Spider:
175+
https://www.renesas.com/us/en/products/automotive-products/automotive-system-chips-socs/rtp8a779f0askb0sp2s-r-car-s4-reference-boardspider
176+
177+
.. _Renesas R-Car S4 chip:
178+
https://www.renesas.com/us/en/products/automotive-products/automotive-system-chips-socs/r-car-s4-automotive-system-chip-soc-car-servercommunication-gateway
179+
180+
.. _eLinux S4 Spider:
181+
https://elinux.org/R-Car/Boards/Spider
182+
183+
.. _S4 Spider CPU board IOs:
184+
https://elinux.org/images/6/6d/Rcar_s4_spider_cpu_board.jpg
185+
186+
.. _S4 Spider breakout board IOs:
187+
https://elinux.org/images/2/29/Rcar_s4_spider_breakout_board.jpg

0 commit comments

Comments
 (0)