summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTom Rini <[email protected]>2026-07-16 08:10:11 -0600
committerTom Rini <[email protected]>2026-07-16 08:10:11 -0600
commit246631bdc559fc39e9f434feb18565da3a8a05db (patch)
tree45bde1642e579953620825118acebefcc54ed909 /doc
parent8163dab2e555ff93343d8aaa6f13d37d63c0bec2 (diff)
parentcb4c530f7f229659d2d62a0f52fb1789a9c54ad6 (diff)
Merge tag 'efi-2026-10-rc1' of https://git.u-boot-project.org/u-boot/custodians/u-boot-efi
Pull request efi-2026-10-rc1 CI: https://git.u-boot-project.org/u-boot/custodians/u-boot-efi/-/pipelines/648 Documentation: * board: renesas: Document SH/Aarch32/Aarch64 toolchain setup * board: renesas: Document Aarch32 toolchain setup in RZ/N1 * board: renesas: Document Renesas R-Car Gen3 H3/M3-W/M3-N Salvator-X(S) board * board: renesas: Document Renesas R-Car Gen3 H3/M3-W/M3-N ULCB board * board: renesas: Document Renesas R-Car Gen3 M3Le Geist board * board: renesas: Document Renesas R-Car Gen3 E3 Ebisu board * board: renesas: Document Renesas R-Car Gen3 D3 Draak board * board: renesas: Document Retronix R-Car Gen4 V4H Sparrow Hawk board * board: renesas: Document Renesas R-Car Gen5 X5H Ironhide board * board: renesas: Update Renesas generic build section * board: renesas: Convert Renesas board support table to grid table * boards: amlogic: update documentation for Beelink GT1 Ultimate * CONTRIBUTE: use internal link instead of hardcoded external URL * CONTRIBUTE: tell people reviewing *is* contributing * CONTRIBUTE: explicitly list tests and documentation as welcome contributions UEFI: * fix building with CONFIG_EFI_VARIABLES_PRESEED=y * fix buffer overrun in efi_sigstore_parse_siglist * Correctly count the size on DTB measurements * Change the return values if a TPM is missing during GetEventLog * Measure secure boot variables in the correct PCR if DeployedMode is set * fix missing EFI_EXIT in efi_disconnect_controller * efi_selftest: free handles on teardown() * efi_selftest: test block io revision and pointers Others: * qfw: fix RSDP ACPI table ext_checksum computation
Diffstat (limited to 'doc')
-rw-r--r--doc/CONTRIBUTE.rst19
-rw-r--r--doc/board/amlogic/beelink-gt1-ultimate.rst96
-rw-r--r--doc/board/renesas/build-env-aarch32.rst25
-rw-r--r--doc/board/renesas/build-env-aarch64.rst25
-rw-r--r--doc/board/renesas/build-env-sh.rst25
-rw-r--r--doc/board/renesas/index.rst13
-rw-r--r--doc/board/renesas/rcar-gen3-draak.rst47
-rw-r--r--doc/board/renesas/rcar-gen3-ebisu.rst47
-rw-r--r--doc/board/renesas/rcar-gen3-geist.rst45
-rw-r--r--doc/board/renesas/rcar-gen3-install-hf.rst76
-rw-r--r--doc/board/renesas/rcar-gen3-install-sf.rst29
-rw-r--r--doc/board/renesas/rcar-gen3-install.rst34
-rw-r--r--doc/board/renesas/rcar-gen3-salvator-x.rst48
-rw-r--r--doc/board/renesas/rcar-gen3-ulcb.rst49
-rw-r--r--doc/board/renesas/rcar-gen4-sparrow-hawk.rst91
-rw-r--r--doc/board/renesas/rcar-gen5-ironhide.rst204
-rw-r--r--doc/board/renesas/renesas.rst343
-rw-r--r--doc/board/renesas/rzn1.rst2
18 files changed, 918 insertions, 300 deletions
diff --git a/doc/CONTRIBUTE.rst b/doc/CONTRIBUTE.rst
index a6e1cd1fb68..e8fa595ed4a 100644
--- a/doc/CONTRIBUTE.rst
+++ b/doc/CONTRIBUTE.rst
@@ -21,8 +21,7 @@ Repository
The official U-Boot repository is located at https://source.denx.de/u-boot/u-boot
-Further more detailed documentation can be found at the following link:
-https://docs.u-boot-project.org/en/latest/index.html
+Further more detailed documentation can be found at the following link: :doc:`/index`.
Contributions
-------------
@@ -39,6 +38,22 @@ script. Please don't send patches as attachments, and ensure corporate mail
systems don't reformat patches, append disclaimers or other unnecessary notes.
The b4 tool automates a number of components mentioned above.
+Code is not the only thing you can contribute to the project. As most
+open-source projects, the U-Boot project suffers from a lack of reviewers.
+Consider spending some time reading patches on `the mailing list archive
+<https://lists.denx.de/pipermail/u-boot/>`_ and providing feedback to
+contributors when something could be improved or if you have questions. Contrary
+to what's most often believed, you do not need to be an expert to review patches
+and the project will benefit from people with different skillsets and experience
+looking at the same patches and each catch different bugs.
+
+The project would also benefit from more :ref:`develop/index:testing`.
+
+New sections or updates to the documentation are most welcome, e.g.
+:ref:`usage/index:shell commands`. See :doc:`/develop/docstyle`.
+
+Thank you for your help!
+
Patch Series
------------
diff --git a/doc/board/amlogic/beelink-gt1-ultimate.rst b/doc/board/amlogic/beelink-gt1-ultimate.rst
index a78a1a2ff25..22afae0ed40 100644
--- a/doc/board/amlogic/beelink-gt1-ultimate.rst
+++ b/doc/board/amlogic/beelink-gt1-ultimate.rst
@@ -30,19 +30,19 @@ U-Boot Compilation
.. code-block:: bash
-    $ export CROSS_COMPILE=aarch64-none-elf-
-    $ make beelink-gt1-ultimate_defconfig
-    $ make
+ $ export CROSS_COMPILE=aarch64-none-elf-
+ $ make beelink-gt1-ultimate_defconfig
+ $ make
U-Boot Signing with Pre-Built FIP repo
--------------------------------------
.. code-block:: bash
-    $ git clone https://github.com/LibreELEC/amlogic-boot-fip --depth=1
-    $ cd amlogic-boot-fip
-    $ mkdir my-output-dir
-    $ ./build-fip.sh beelink-gt1 /path/to/u-boot/u-boot.bin my-output-dir
+ $ git clone https://github.com/LibreELEC/amlogic-boot-fip --depth=1
+ $ cd amlogic-boot-fip
+ $ mkdir my-output-dir
+ $ ./build-fip.sh beelink-gt1 /path/to/u-boot/u-boot.bin my-output-dir
U-Boot Manual Signing
---------------------
@@ -53,58 +53,58 @@ for signing. However you can download them from the amlogic-fip-repo.
.. code-block:: bash
-    $ git clone https://github.com/LibreELEC/amlogic-boot-fip --depth=1
-    $ cd amlogic-boot-fip/beelink-gt1
-    $ export FIPDIR=$PWD
+ $ git clone https://github.com/LibreELEC/amlogic-boot-fip --depth=1
+ $ cd amlogic-boot-fip/beelink-gt1
+ $ export FIPDIR=$PWD
Go back to the mainline U-Boot source tree then:
.. code-block:: bash
-    $ mkdir fip
-    $ cp $FIPDIR/bl2.bin fip/
-    $ cp $FIPDIR/acs.bin fip/
-    $ cp $FIPDIR/bl21.bin fip/
-    $ cp $FIPDIR/bl30.bin fip/
-    $ cp $FIPDIR/bl301.bin fip/
-    $ cp $FIPDIR/bl31.img fip/
-    $ cp u-boot.bin fip/bl33.bin
+ $ mkdir fip
+ $ cp $FIPDIR/bl2.bin fip/
+ $ cp $FIPDIR/acs.bin fip/
+ $ cp $FIPDIR/bl21.bin fip/
+ $ cp $FIPDIR/bl30.bin fip/
+ $ cp $FIPDIR/bl301.bin fip/
+ $ cp $FIPDIR/bl31.img fip/
+ $ cp u-boot.bin fip/bl33.bin
-    $ $FIPDIR/blx_fix.sh \
-              fip/bl30.bin \
-              fip/zero_tmp \
-              fip/bl30_zero.bin \
-              fip/bl301.bin \
-              fip/bl301_zero.bin \
-              fip/bl30_new.bin \
-              bl30
+ $ $FIPDIR/blx_fix.sh \
+           fip/bl30.bin \
+           fip/zero_tmp \
+           fip/bl30_zero.bin \
+           fip/bl301.bin \
+           fip/bl301_zero.bin \
+           fip/bl30_new.bin \
+           bl30
-    $ python $FIPDIR/acs_tool.pyc fip/bl2.bin fip/bl2_acs.bin fip/acs.bin 0
+ $ python $FIPDIR/acs_tool.pyc fip/bl2.bin fip/bl2_acs.bin fip/acs.bin 0
-    $ $FIPDIR/blx_fix.sh \
-              fip/bl2_acs.bin \
-              fip/zero_tmp \
-              fip/bl2_zero.bin \
-              fip/bl21.bin \
-              fip/bl21_zero.bin \
-              fip/bl2_new.bin \
-              bl2
+ $ $FIPDIR/blx_fix.sh \
+           fip/bl2_acs.bin \
+           fip/zero_tmp \
+           fip/bl2_zero.bin \
+           fip/bl21.bin \
+           fip/bl21_zero.bin \
+           fip/bl2_new.bin \
+           bl2
-    $ $FIPDIR/aml_encrypt_gxl --bl3enc --input fip/bl30_new.bin
-    $ $FIPDIR/aml_encrypt_gxl --bl3enc --input fip/bl31.img
-    $ $FIPDIR/aml_encrypt_gxl --bl3enc --input fip/bl33.bin
-    $ $FIPDIR/aml_encrypt_gxl --bl2sig --input fip/bl2_new.bin --output fip/bl2.n.bin.sig
-    $ $FIPDIR/aml_encrypt_gxl --bootmk \
-                              --output fip/u-boot.bin \
-                              --bl2 fip/bl2.n.bin.sig \
-                              --bl30 fip/bl30_new.bin.enc \
-                              --bl31 fip/bl31.img.enc \
-                              --bl33 fip/bl33.bin.enc
+ $ $FIPDIR/aml_encrypt_gxl --bl3enc --input fip/bl30_new.bin
+ $ $FIPDIR/aml_encrypt_gxl --bl3enc --input fip/bl31.img
+ $ $FIPDIR/aml_encrypt_gxl --bl3enc --input fip/bl33.bin
+ $ $FIPDIR/aml_encrypt_gxl --bl2sig --input fip/bl2_new.bin --output fip/bl2.n.bin.sig
+ $ $FIPDIR/aml_encrypt_gxl --bootmk \
+                           --output fip/u-boot.bin \
+                           --bl2 fip/bl2.n.bin.sig \
+                           --bl30 fip/bl30_new.bin.enc \
+                           --bl31 fip/bl31.img.enc \
+                           --bl33 fip/bl33.bin.enc
Then write U-Boot to SD or eMMC with:
.. code-block:: bash
-    $ DEV=/dev/boot_device
-    $ dd if=fip/u-boot.bin.sd.bin of=$DEV conv=fsync,notrunc bs=512 skip=1 seek=1
-    $ dd if=fip/u-boot.bin.sd.bin of=$DEV conv=fsync,notrunc bs=1 count=440
+ $ DEV=/dev/boot_device
+ $ dd if=fip/u-boot.bin.sd.bin of=$DEV conv=fsync,notrunc bs=512 skip=1 seek=1
+ $ dd if=fip/u-boot.bin.sd.bin of=$DEV conv=fsync,notrunc bs=1 count=440
diff --git a/doc/board/renesas/build-env-aarch32.rst b/doc/board/renesas/build-env-aarch32.rst
new file mode 100644
index 00000000000..5120a042ccb
--- /dev/null
+++ b/doc/board/renesas/build-env-aarch32.rst
@@ -0,0 +1,25 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Renesas 32-bit ARM SoC build environment setup
+==============================================
+
+In order to cross-compile U-Boot for the ARM 32-bit target, it is necessary
+to install a suitable toolchain. The toolchain is available in various
+distribution repositories as ``arm-linux-gnueabi-*`` or similar package.
+
+Debian example:
+
+.. code-block:: console
+
+ $ apt install binutils-arm-linux-gnueabi cpp-arm-linux-gnueabi gcc-arm-linux-gnueabi
+
+Alternatively, it is possible to download prebuilt toolchain from
+kernel.org cross-development toolchains page
+https://www.kernel.org/pub/tools/crosstool/ .
+
+Once the toolchain is installed, add toolchain into ``PATH`` variable:
+
+.. code-block:: console
+
+ $ export PATH=$PATH:<path/to/arm32/toolchain/bin/>
+ $ export CROSS_COMPILE=arm-linux-gnueabi-
diff --git a/doc/board/renesas/build-env-aarch64.rst b/doc/board/renesas/build-env-aarch64.rst
new file mode 100644
index 00000000000..979b599e951
--- /dev/null
+++ b/doc/board/renesas/build-env-aarch64.rst
@@ -0,0 +1,25 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Renesas 64-bit ARM SoC build environment setup
+==============================================
+
+In order to cross-compile U-Boot for the aarch64 target, it is necessary
+to install a suitable toolchain. The toolchain is available in various
+distribution repositories as ``aarch64-linux-gnu-*`` or similar package.
+
+Debian example:
+
+.. code-block:: console
+
+ $ apt install binutils-aarch64-linux-gnu cpp-aarch64-linux-gnu gcc-aarch64-linux-gnu
+
+Alternatively, it is possible to download prebuilt toolchain from
+kernel.org cross-development toolchains page
+https://www.kernel.org/pub/tools/crosstool/ .
+
+Once the toolchain is installed, add toolchain into ``PATH`` variable:
+
+.. code-block:: console
+
+ $ export PATH=$PATH:<path/to/arm64/toolchain/bin/>
+ $ export CROSS_COMPILE=aarch64-linux-gnu-
diff --git a/doc/board/renesas/build-env-sh.rst b/doc/board/renesas/build-env-sh.rst
new file mode 100644
index 00000000000..52f5cff8198
--- /dev/null
+++ b/doc/board/renesas/build-env-sh.rst
@@ -0,0 +1,25 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Renesas 32-bit SH4 SoC build environment setup
+==============================================
+
+In order to cross-compile U-Boot for the SH4 32-bit target, it is necessary
+to install a suitable toolchain. The toolchain is available in various
+distribution repositories as ``sh4-linux-gnu-*`` or similar package.
+
+Debian example:
+
+.. code-block:: console
+
+ $ apt install binutils-sh4-linux-gnu cpp-sh4-linux-gnu gcc-sh4-linux-gnu
+
+Alternatively, it is possible to download prebuilt toolchain from
+kernel.org cross-development toolchains page
+https://www.kernel.org/pub/tools/crosstool/ .
+
+Once the toolchain is installed, add toolchain into ``PATH`` variable:
+
+.. code-block:: console
+
+ $ export PATH=$PATH:<path/to/sh4/toolchain/bin/>
+ $ export CROSS_COMPILE=sh4-linux-gnu-
diff --git a/doc/board/renesas/index.rst b/doc/board/renesas/index.rst
index fb6558ec11b..be932aa01fb 100644
--- a/doc/board/renesas/index.rst
+++ b/doc/board/renesas/index.rst
@@ -7,4 +7,17 @@ Renesas
:maxdepth: 2
renesas
+ build-env-sh
+ build-env-aarch32
+ build-env-aarch64
+ rcar-gen3-salvator-x
+ rcar-gen3-ulcb
+ rcar-gen3-geist
+ rcar-gen3-ebisu
+ rcar-gen3-draak
+ rcar-gen3-install
+ rcar-gen3-install-hf
+ rcar-gen3-install-sf
+ rcar-gen4-sparrow-hawk
+ rcar-gen5-ironhide
rzn1
diff --git a/doc/board/renesas/rcar-gen3-draak.rst b/doc/board/renesas/rcar-gen3-draak.rst
new file mode 100644
index 00000000000..7b94eaa4b23
--- /dev/null
+++ b/doc/board/renesas/rcar-gen3-draak.rst
@@ -0,0 +1,47 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Renesas R-Car Gen3 D3 Draak board
+=================================
+
+- Renesas R-Car D3 Draak board: https://elinux.org/R-Car/Boards/Draak
+
+Build U-Boot
+------------
+
+Please follow :doc:`Renesas 64-bit ARM SoC build environment setup <build-env-aarch64>`
+to correctly set up the build environment before attempting to build U-Boot.
+
+Clone up to date U-Boot source code and change directory into the
+newly cloned source directory:
+
+.. code-block:: console
+
+ $ git clone https://source.denx.de/u-boot/u-boot.git/
+ $ cd u-boot
+
+Configure U-Boot:
+
+.. code-block:: console
+
+ $ make r8a77995_draak_defconfig
+
+Compile U-Boot:
+
+.. code-block:: console
+
+ $ make
+
+To speed up build process, -jN option can be passed to make to start
+multiple jobs at the same time, this is beneficial especially on SMP
+systems. The following example starts up to number of CPUs in the
+system jobs, which is the recommended amount:
+
+.. code-block:: console
+
+ $ make -j$(nproc)
+
+Install U-Boot
+--------------
+
+Please follow :doc:`Renesas R-Car Gen3 U-Boot installation <rcar-gen3-install>`
+to install U-Boot into HyperFlash.
diff --git a/doc/board/renesas/rcar-gen3-ebisu.rst b/doc/board/renesas/rcar-gen3-ebisu.rst
new file mode 100644
index 00000000000..f9632705abc
--- /dev/null
+++ b/doc/board/renesas/rcar-gen3-ebisu.rst
@@ -0,0 +1,47 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Renesas R-Car Gen3 E3 Ebisu board
+=================================
+
+- Renesas R-Car E3 Ebisu board: https://elinux.org/R-Car/Boards/Ebisu
+
+Build U-Boot
+------------
+
+Please follow :doc:`Renesas 64-bit ARM SoC build environment setup <build-env-aarch64>`
+to correctly set up the build environment before attempting to build U-Boot.
+
+Clone up to date U-Boot source code and change directory into the
+newly cloned source directory:
+
+.. code-block:: console
+
+ $ git clone https://source.denx.de/u-boot/u-boot.git/
+ $ cd u-boot
+
+Configure U-Boot:
+
+.. code-block:: console
+
+ $ make r8a77990_ebisu_defconfig
+
+Compile U-Boot:
+
+.. code-block:: console
+
+ $ make
+
+To speed up build process, -jN option can be passed to make to start
+multiple jobs at the same time, this is beneficial especially on SMP
+systems. The following example starts up to number of CPUs in the
+system jobs, which is the recommended amount:
+
+.. code-block:: console
+
+ $ make -j$(nproc)
+
+Install U-Boot
+--------------
+
+Please follow :doc:`Renesas R-Car Gen3 U-Boot installation <rcar-gen3-install>`
+to install U-Boot into HyperFlash.
diff --git a/doc/board/renesas/rcar-gen3-geist.rst b/doc/board/renesas/rcar-gen3-geist.rst
new file mode 100644
index 00000000000..7bedb3a79cb
--- /dev/null
+++ b/doc/board/renesas/rcar-gen3-geist.rst
@@ -0,0 +1,45 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Renesas R-Car Gen3 M3Le Geist board
+===================================
+
+Build U-Boot
+------------
+
+Please follow :doc:`Renesas 64-bit ARM SoC build environment setup <build-env-aarch64>`
+to correctly set up the build environment before attempting to build U-Boot.
+
+Clone up to date U-Boot source code and change directory into the
+newly cloned source directory:
+
+.. code-block:: console
+
+ $ git clone https://source.denx.de/u-boot/u-boot.git/
+ $ cd u-boot
+
+Configure U-Boot:
+
+.. code-block:: console
+
+ $ make r8a779md_geist_defconfig
+
+Compile U-Boot:
+
+.. code-block:: console
+
+ $ make
+
+To speed up build process, -jN option can be passed to make to start
+multiple jobs at the same time, this is beneficial especially on SMP
+systems. The following example starts up to number of CPUs in the
+system jobs, which is the recommended amount:
+
+.. code-block:: console
+
+ $ make -j$(nproc)
+
+Install U-Boot
+--------------
+
+Please follow :doc:`Renesas R-Car Gen3 U-Boot installation <rcar-gen3-install>`
+to install U-Boot into SPI NOR.
diff --git a/doc/board/renesas/rcar-gen3-install-hf.rst b/doc/board/renesas/rcar-gen3-install-hf.rst
new file mode 100644
index 00000000000..d3a753eb2eb
--- /dev/null
+++ b/doc/board/renesas/rcar-gen3-install-hf.rst
@@ -0,0 +1,76 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Renesas R-Car Gen3 U-Boot HyperFlash installation
+=================================================
+
+U-Boot can be installed on R-Car Gen3 systems into HyperFlash from U-Boot.
+
+.. note::
+
+ This update mechanism is only available in case the TFA has been built
+ with `RCAR_RPC_HYPERFLASH_LOCKED=0`.
+
+Install U-Boot into HyperFlash using NOR write from U-Boot
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In order to install U-Boot using write into HyperFlash, first build U-Boot
+for this target and collect ``u-boot.bin`` build artifact. Then start the
+target, drop into U-Boot shell, and load the build artifact into DRAM at
+well known address:
+
+.. code-block:: console
+
+ => tftp 0x50000000 u-boot.bin
+
+Finally, write U-Boot into HyperFlash:
+
+.. code-block:: console
+
+ => erase 0x8640000 +${filesize} && cp.w 0x50000000 0x8640000 0x80000
+
+.. note::
+
+ The `cp.w` size parameter is in 16-bit short word units, not in Bytes.
+ The `cp.w` size parameter size in Bytes would be 0x100000 .
+
+Install U-Boot into HyperFlash using dfu_tftp update from U-Boot
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In order to install U-Boot using dfu_tftp update, first build U-Boot for
+this target and collect ``u-boot.bin`` build artifact. Then bundle this
+``u-boot.bin`` into an update fitImage using the following fitImage source
+file. The update fitImage source file is named ``update.its`` in this example:
+
+.. code-block:: dts
+
+ // update.its
+ /dts-v1/;
+
+ / {
+ description = "Update fitImage for U-Boot";
+
+ images {
+ bootparam {
+ description = "U-Boot";
+ data = /incbin/("u-boot.bin");
+ type = "standalone";
+ os = "U-Boot";
+ arch = "arm64";
+ compression = "none";
+ load = <0x8640000>;
+ };
+ };
+ };
+
+Generate the update fitImage using the following command:
+
+.. code-block:: console
+
+ $ mkimage -f update.its update.itb
+
+Then start the target, drop into U-Boot shell, and load the ``update.itb``
+artifact into DRAM at well known address:
+
+.. code-block:: console
+
+ => tftp 0x50000000 update.itb && dfu tftp 0x50000000
diff --git a/doc/board/renesas/rcar-gen3-install-sf.rst b/doc/board/renesas/rcar-gen3-install-sf.rst
new file mode 100644
index 00000000000..4e8667e1b48
--- /dev/null
+++ b/doc/board/renesas/rcar-gen3-install-sf.rst
@@ -0,0 +1,29 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Renesas R-Car Gen3 U-Boot SPI NOR installation
+==============================================
+
+U-Boot can be installed on R-Car Gen3 systems into SPI NOR from U-Boot.
+
+.. note::
+
+ This update mechanism is only available in case the TFA has been built
+ with `RCAR_RPC_HYPERFLASH_LOCKED=0 SPD=none`.
+
+Install U-Boot into SPI NOR using write from U-Boot
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In order to install U-Boot using write into SPI NOR, first build U-Boot
+for this target and collect ``u-boot.bin`` build artifact. Then start the
+target, drop into U-Boot shell, and load the build artifact into DRAM at
+well known address:
+
+.. code-block:: console
+
+ => tftp 0x50000000 u-boot.bin
+
+Finally, write U-Boot into SPI NOR:
+
+.. code-block:: console
+
+ => sf probe && sf update 0x50000000 0x640000 $filesize
diff --git a/doc/board/renesas/rcar-gen3-install.rst b/doc/board/renesas/rcar-gen3-install.rst
new file mode 100644
index 00000000000..33189d9227b
--- /dev/null
+++ b/doc/board/renesas/rcar-gen3-install.rst
@@ -0,0 +1,34 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Renesas R-Car Gen3 U-Boot installation
+======================================
+
+U-Boot can be installed on R-Car Gen3 systems in multiple ways.
+
+The generic installation method, which also requires physical hardware
+access, is to install U-Boot using the `flash_writer`_ tool. This
+procedure is documented below.
+
+Installation into the HyperFlash can be performed from U-Boot, please
+refer to :doc:`Renesas R-Car Gen3 U-Boot HyperFlash installation <rcar-gen3-install-hf>`
+for details.
+
+Installation into the SPI NOR can be performed from U-Boot, please
+refer to :doc:`Renesas R-Car Gen3 U-Boot SPI NOR installation <rcar-gen3-install-sf>`
+for details.
+
+.. note::
+
+ The maximum u-boot.bin size for this target is 1 MiB or 0x100000 Bytes
+
+Install U-Boot using flash_writer tool
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In order to install U-Boot using flash_writer tool, first build U-Boot
+for this target and collect ``u-boot-elf.srec`` build artifact. Then
+follow the `application note`_ shipped together with the flash_writer
+tool to install the ``u-boot-elf.srec`` artifact using `XLS2 command`_.
+
+.. _`flash_writer`: https://github.com/renesas-rcar/flash_writer
+.. _`application note`: https://github.com/renesas-rcar/flash_writer/blob/rcar_gen3/docs/application-note.md
+.. _`XLS2 command`: https://github.com/renesas-rcar/flash_writer/blob/rcar_gen3/docs/application-note.md#341-write-to-the-s-record-format-images-to-the-serial-flash
diff --git a/doc/board/renesas/rcar-gen3-salvator-x.rst b/doc/board/renesas/rcar-gen3-salvator-x.rst
new file mode 100644
index 00000000000..37f009452e5
--- /dev/null
+++ b/doc/board/renesas/rcar-gen3-salvator-x.rst
@@ -0,0 +1,48 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Renesas R-Car Gen3 H3/M3-W/M3-N Salvator-X(S) board
+===================================================
+
+- Renesas R-Car Gen3 Salvator-X board: https://elinux.org/R-Car/Boards/Salvator-X
+- Renesas R-Car Gen3 Salvator-XS board: https://elinux.org/R-Car/Boards/Salvator-XS
+
+Build U-Boot
+------------
+
+Please follow :doc:`Renesas 64-bit ARM SoC build environment setup <build-env-aarch64>`
+to correctly set up the build environment before attempting to build U-Boot.
+
+Clone up to date U-Boot source code and change directory into the
+newly cloned source directory:
+
+.. code-block:: console
+
+ $ git clone https://source.denx.de/u-boot/u-boot.git/
+ $ cd u-boot
+
+Configure U-Boot:
+
+.. code-block:: console
+
+ $ make rcar3_salvator-x_defconfig
+
+Compile U-Boot:
+
+.. code-block:: console
+
+ $ make
+
+To speed up build process, -jN option can be passed to make to start
+multiple jobs at the same time, this is beneficial especially on SMP
+systems. The following example starts up to number of CPUs in the
+system jobs, which is the recommended amount:
+
+.. code-block:: console
+
+ $ make -j$(nproc)
+
+Install U-Boot
+--------------
+
+Please follow :doc:`Renesas R-Car Gen3 U-Boot installation <rcar-gen3-install>`
+to install U-Boot into HyperFlash.
diff --git a/doc/board/renesas/rcar-gen3-ulcb.rst b/doc/board/renesas/rcar-gen3-ulcb.rst
new file mode 100644
index 00000000000..88ec2276a36
--- /dev/null
+++ b/doc/board/renesas/rcar-gen3-ulcb.rst
@@ -0,0 +1,49 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Renesas R-Car Gen3 H3/M3-W/M3-N ULCB board
+==========================================
+
+- Renesas R-Car H3 ULCB board: https://elinux.org/R-Car/Boards/H3SK
+- Renesas R-Car M3-W ULCB board: https://elinux.org/R-Car/Boards/M3SK
+- Renesas R-Car M3-N ULCB board: https://elinux.org/R-Car/Boards/M3NSK
+
+Build U-Boot
+------------
+
+Please follow :doc:`Renesas 64-bit ARM SoC build environment setup <build-env-aarch64>`
+to correctly set up the build environment before attempting to build U-Boot.
+
+Clone up to date U-Boot source code and change directory into the
+newly cloned source directory:
+
+.. code-block:: console
+
+ $ git clone https://source.denx.de/u-boot/u-boot.git/
+ $ cd u-boot
+
+Configure U-Boot:
+
+.. code-block:: console
+
+ $ make rcar3_ulcb_defconfig
+
+Compile U-Boot:
+
+.. code-block:: console
+
+ $ make
+
+To speed up build process, -jN option can be passed to make to start
+multiple jobs at the same time, this is beneficial especially on SMP
+systems. The following example starts up to number of CPUs in the
+system jobs, which is the recommended amount:
+
+.. code-block:: console
+
+ $ make -j$(nproc)
+
+Install U-Boot
+--------------
+
+Please follow :doc:`Renesas R-Car Gen3 U-Boot installation <rcar-gen3-install>`
+to install U-Boot into HyperFlash.
diff --git a/doc/board/renesas/rcar-gen4-sparrow-hawk.rst b/doc/board/renesas/rcar-gen4-sparrow-hawk.rst
new file mode 100644
index 00000000000..a1b92ecab57
--- /dev/null
+++ b/doc/board/renesas/rcar-gen4-sparrow-hawk.rst
@@ -0,0 +1,91 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Retronix R-Car Gen4 V4H Sparrow Hawk board
+==========================================
+
+- Retronix R-Car V4H Sparrow Hawk board: https://www.retronix.com.tw/en/product_sbc.html
+- Retronix R-Car V4H Sparrow Hawk documenation: https://rcar-community.github.io/Sparrow-Hawk/index.html
+
+Build U-Boot
+------------
+
+Please follow :doc:`Renesas 64-bit ARM SoC build environment setup <build-env-aarch64>`
+to correctly set up the build environment before attempting to build U-Boot.
+
+Clone up to date U-Boot source code and change directory into the
+newly cloned source directory:
+
+.. code-block:: console
+
+ $ git clone https://source.denx.de/u-boot/u-boot.git/
+ $ cd u-boot
+
+Configure U-Boot:
+
+.. code-block:: console
+
+ $ make r8a779g3_sparrowhawk_defconfig
+
+Compile U-Boot:
+
+.. code-block:: console
+
+ $ make
+
+To speed up build process, -jN option can be passed to make to start
+multiple jobs at the same time, this is beneficial especially on SMP
+systems. The following example starts up to number of CPUs in the
+system jobs, which is the recommended amount:
+
+.. code-block:: console
+
+ $ make -j$(nproc)
+
+Install U-Boot
+--------------
+
+In order to install U-Boot using write into SPI NOR, first build U-Boot
+for this target and collect ``flash.bin`` build artifact. Then start the
+target, drop into U-Boot shell, and load the build artifact into DRAM at
+well known address:
+
+.. code-block:: console
+
+ => tftp 0x50000000 flash.bin
+
+Finally, write U-Boot into SPI NOR:
+
+.. code-block:: console
+
+ => sf probe && sf update 0x50000000 0 ${filesize}
+
+Bundle TFA BL31 into Linux kernel fitImage
+------------------------------------------
+
+The Retronix R-Car V4H Sparrow Hawk board starts both TFA BL31 and Linux
+kernel from U-Boot. Both TFA BL31, Linux kernel and DT blob have to be
+bundled into the fitImage.
+
+Perform the following steps to build TFA at least v2.14.y:
+
+.. code-block:: console
+
+ $ git clone https://github.com/ARM-software/arm-trusted-firmware.git
+ $ cd arm-trusted-firmware
+ $ make -j$(nproc) bl31 \
+ PLAT=rcar_gen4 ARCH=aarch64 LSI=V4H SPD=none \
+ CTX_INCLUDE_AARCH32_REGS=0 MBEDTLS_COMMON_MK=1 \
+ PTP_NONSECURE_ACCESS=1 LOG_LEVEL=20 DEBUG=0 \
+ ENABLE_ASSERTIONS=0
+
+The bundling is done using U-Boot ``mkimage`` tool:
+
+.. code-block:: console
+
+ mkimage \
+ -f auto -E -A arm64 -C none -e 0x50200000 -a 0x50200000 \
+ -d /path/to/linux/arch/arm64/boot/Image \
+ -b /path/to/linux/arch/arm64/boot/dts/renesas/r8a779g3-sparrow-hawk.dtb \
+ -y /path/to/arm-trusted-firmware/build/rcar_gen4/*/bl31.bin \
+ -Y 0x46400000 \
+ /path/to/output/fitImage
diff --git a/doc/board/renesas/rcar-gen5-ironhide.rst b/doc/board/renesas/rcar-gen5-ironhide.rst
new file mode 100644
index 00000000000..39fbfdbfe00
--- /dev/null
+++ b/doc/board/renesas/rcar-gen5-ironhide.rst
@@ -0,0 +1,204 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Renesas R-Car Gen5 X5H Ironhide board
+=====================================
+
+Renesas R-Car Gen5 X5H Ironhide board U-Boot can be built for two separate cores:
+
+- Cortex-M33 RSIP core, which is the boot core
+- Cortex-A720AE core, which is the application core
+
+Cortex-A720AE target
+^^^^^^^^^^^^^^^^^^^^
+
+Build U-Boot
+------------
+
+Please follow :doc:`Renesas 64-bit ARM SoC build environment setup <build-env-aarch64>`
+to correctly set up the build environment before attempting to build U-Boot.
+
+Clone up to date U-Boot source code and change directory into the
+newly cloned source directory:
+
+.. code-block:: console
+
+ $ git clone https://source.denx.de/u-boot/u-boot.git/
+ $ cd u-boot
+
+Configure U-Boot:
+
+.. code-block:: console
+
+ $ make r8a78000_ironhide_defconfig
+
+Compile U-Boot:
+
+.. code-block:: console
+
+ $ make
+
+To speed up build process, -jN option can be passed to make to start
+multiple jobs at the same time, this is beneficial especially on SMP
+systems. The following example starts up to number of CPUs in the
+system jobs, which is the recommended amount:
+
+.. code-block:: console
+
+ $ make -j$(nproc)
+
+Install U-Boot
+--------------
+
+In order to install U-Boot for Cortex-A720AE into UFS, first build U-Boot
+for this target and collect ``u-boot-elf.srec`` build artifact.
+
+Next, configure the board for SCIF loader boot. Upload IPL flash_writer
+mot binary. Use the tool to write ``u-boot-elf.srec`` into HyperFlash
+at offset 0x8e300000 . Finally, power off the board and configure the
+board back to HyperFlash boot mode.
+
+Cortex-M33 RSIP target
+^^^^^^^^^^^^^^^^^^^^^^
+
+Build U-Boot
+------------
+
+Please follow :doc:`Renesas 32-bit ARM SoC build environment setup <build-env-aarch32>`
+to correctly set up the build environment before attempting to build U-Boot.
+
+Clone up to date U-Boot source code and change directory into the
+newly cloned source directory:
+
+.. code-block:: console
+
+ $ git clone https://source.denx.de/u-boot/u-boot.git/
+ $ cd u-boot
+
+Configure U-Boot:
+
+.. code-block:: console
+
+ $ make r8a78000_ironhide_cm33_defconfig
+
+Compile U-Boot:
+
+.. code-block:: console
+
+ $ make
+
+To speed up build process, -jN option can be passed to make to start
+multiple jobs at the same time, this is beneficial especially on SMP
+systems. The following example starts up to number of CPUs in the
+system jobs, which is the recommended amount:
+
+.. code-block:: console
+
+ $ make -j$(nproc)
+
+Install U-Boot
+--------------
+
+In order to install U-Boot for RSIP into HyperFlash, first build U-Boot
+for this target and collect ``u-boot-elf.shdr`` and ``u-boot-elf.srec``
+build artifacts.
+
+Next, configure the board for SCIF loader boot. Upload IPL flash_writer
+mot binary. Use the tool to write ``u-boot-elf.shdr`` into HyperFlash
+at offset 0, and ``u-boot-elf.srec`` into HyperFlash at offset 0x40000 .
+Finally, power off the board and configure the board back to HyperFlash
+boot mode.
+
+Power on the board, U-Boot on RSIP will start. Interaction with U-Boot
+on RSIP is possible via HSCIF1, which is the second serial console that
+is available on the USB-to-Serial adapter port. HSCIF1 is used in order
+to avoid interference with software running on the Cortex-A720AE cores,
+which uses HSCIF0.
+
+Ethernet boot of bootloader components
+--------------------------------------
+
+The U-Boot for RSIP is capable of ethernet access, which allows download
+of bootloader components via TFTP. This is useful during development and
+can be used for fast iterative testing of either SCP firmware, TFA BL31,
+OPTEE-OS, U-Boot or Linux on the SCP core and Cortex-A720AE cores
+respectively.
+
+An example U-Boot environment applicable to ``include/configs/rcar-gen5-common.h``
+or executable manually is listed below. The environment script ``rsip_ipl_boot_ca0``
+implements download of SCP firmware ``scp.bin``, TFA BL31 ``bl31.bin``,
+U-Boot ``u-boot.bin`` and Linux ``fitImage`` from TFTP server at address
+``192.168.1.1/24`` and starts those components on the SCP and Cortex-A720AE
+cores respectively. OPTEE-OS is loaded from UFS to retain at least this
+example of UFS loading, however, it perfectly fine to download OPTEE-OS
+via TFTP in the same manner as the other components are downloaded:
+
+.. code-block:: console
+
+ rsip_ipl_params_base=0x8c100000
+ rsip_ipl_params_optee=0x8c100088
+ rsip_ipl_params_uboot=0x8c100030
+ rsip_ipl_scp_ep=0x8c180000
+ rsip_ipl_optee_ep=0x8c400000
+ rsip_ipl_tfa_ep=0x8c200000
+ rsip_ipl_uboot_ep=0x8e300000
+ rsip_ipl_linux_ep=0x91000000
+
+ rsip_ipl_params_write= /* Build handoff structure */ \
+ base ${rsip_ipl_params_base} ; \
+ mw 0x00 0 0x9e ; /* Clear the area */ \
+ mw 0x00 0x00300103 ; /* type, version, size */ \
+ mw 0x20 0x${rsip_ipl_params_uboot} ; /* U-Boot descriptor */ \
+ \
+ base ${rsip_ipl_params_uboot} ; \
+ mw 0x00 0x00580101 ; /* type, version, size */ \
+ mw 0x04 0x00000001 ; /* attr */ \
+ mw 0x08 ${rsip_ipl_uboot_ep} ; /* U-Boot entry point */ \
+ mw 0x10 0x000003c5 ; /* SPSR */ \
+ \
+ base ${rsip_ipl_params_optee} ; \
+ mw 0x00 0x00580201 ; /* type, version, size */ \
+ mw 0x04 0x00000008 ; /* attr */ \
+ mw 0x08 ${rsip_ipl_optee_ep} ; /* OPTEE-OS entry point */ \
+ mw 0x10 0x000003c5 ; /* SPSR */ \
+ \
+ base 0
+
+ rsip_ipl_boot_ca0= /* Start TFA BL31, OPTEE-OS, U-Boot, Linux on Cortex-A720AE core 0 */ \
+ setenv ipaddr 192.168.1.10 && \
+ setenv serverip 192.168.1.1 && \
+ setenv netmask 255.255.255.0 && \
+ \
+ tftp ${rsip_ipl_scp_ep} scp.bin && \
+ tftp ${rsip_ipl_tfa_ep} bl31.bin && \
+ tftp ${rsip_ipl_uboot_ep} u-boot.bin && \
+ tftp ${rsip_ipl_linux_ep} fitImage && \
+ \
+ scsi scan && /* Scan for UFS devices */ \
+ rproc init && /* Start remoteproc */ \
+ rproc load 0 ${rsip_ipl_scp_ep} 0x60000 && /* Load SCP STCM */ \
+ rproc start 0 && /* Start SCP */ \
+ scsi read ${rsip_ipl_optee_ep} 0x5200 0x200 && /* Load OPTEE-OS from UFS */ \
+ run rsip_ipl_params_write && /* Write entry point descriptors */ \
+ \
+ rproc load 13 ${rsip_ipl_tfa_ep} 4 && /* Set up Cortex-A720AE Core 0 */ \
+ rproc start 13 /* Start Cortex-A720AE Core 0 */
+
+
+.. note::
+
+ U-Boot on RSIP environment is not persistent across reboots,
+ but this will likely change in the upcoming U-Boot release.
+
+.. note::
+
+ U-Boot on RSIP can start the SCP core via rproc command, but
+ it can not stop SCP after it was started. This was intended
+ as a safety mechanism, since SCP is central component of the
+ system, however, this will likely change in the upcoming U-Boot
+ release.
+
+.. note::
+
+ U-Boot on RSIP can start non-SCP cores via ``rproc`` command only
+ after the SCP got started, because those cores are started via
+ SCMI calls to the SCP.
diff --git a/doc/board/renesas/renesas.rst b/doc/board/renesas/renesas.rst
index fcfd51aa19c..c0cefc15dd8 100644
--- a/doc/board/renesas/renesas.rst
+++ b/doc/board/renesas/renesas.rst
@@ -14,261 +14,104 @@ Renesas SoC based boards
Renesas is a SoC solutions provider for automotive and industrial applications.
-.. list-table:: Supported Renesas SoC based boards
- :widths: 10, 25, 15, 10, 25
- :header-rows: 1
+.. table:: Supported Renesas SoC based boards
- * - Family
- - Board
- - SoC
- - Arch
- - defconfig
+ +--------+------------------+----------------------------------+--------------------+--------------------+----------------------------------------------+----------------------------------+
+ | Family | Generation | Architecture | SoC | Core | Board | defconfig |
+ +========+==================+==================================+====================+====================+==============================================+==================================+
+ | R2D | | :doc:`SH <build-env-sh>` | SH7751 | SH4 | R2D-PLUS | r2dplus_defconfig |
+ +--------+------------------+----------------------------------+--------------------+--------------------+----------------------------------------------+----------------------------------+
+ | R-Car | | | | | Lager | lager_defconfig |
+ | | | | R8A7790 (H2) | Cortex A7 or A15 +----------------------------------------------+----------------------------------+
+ | | | | | | Stout | stout_defconfig |
+ | | | +--------------------+--------------------+----------------------------------------------+----------------------------------+
+ | | | | | | Koelsch | koelsch_defconfig |
+ | | | | R8A7791 (M2-W) | +----------------------------------------------+----------------------------------+
+ | | | | | Cortex A15 | Porter | porter_defconfig |
+ | | Gen2 | :doc:`arm <build-env-aarch32>` +--------------------+ +----------------------------------------------+----------------------------------+
+ | | | | R8A7792 (V2H) | | Blanche | blanche_defconfig |
+ | | | +--------------------+--------------------+----------------------------------------------+----------------------------------+
+ | | | | R8A7793 (M2-N) | Cortex A7 or A15 | Gose | gose_defconfig |
+ | | | +--------------------+--------------------+----------------------------------------------+----------------------------------+
+ | | | | | | Alt | alt_defconfig |
+ | | | | R8A7794 (E2) | Cortex A7 +----------------------------------------------+----------------------------------+
+ | | | | | | Silk | silk_defconfig |
+ | +------------------+----------------------------------+--------------------+--------------------+----------------------------------------------+----------------------------------+
+ | | | | | | :doc:`Salvator-X(S) <rcar-gen3-salvator-x>` | rcar3_salvator-x_defconfig |
+ | | | | R8A77951 (H3) | +----------------------------------------------+----------------------------------+
+ | | | | | | :doc:`ULCB <rcar-gen3-ulcb>` | rcar3_ulcb_defconfig |
+ | | | +--------------------+ +----------------------------------------------+----------------------------------+
+ | | | | | | :doc:`Salvator-X(S) <rcar-gen3-salvator-x>` | rcar3_salvator-x_defconfig |
+ | | | | R8A77960 (M3-W) | Cortex A53 or A57 +----------------------------------------------+----------------------------------+
+ | | | | | | :doc:`ULCB <rcar-gen3-ulcb>` | rcar3_ulcb_defconfig |
+ | | | +--------------------+ +----------------------------------------------+----------------------------------+
+ | | | | | | :doc:`Salvator-X(S) <rcar-gen3-salvator-x>` | rcar3_salvator-x_defconfig |
+ | | | | R8A77965 (M3-N) | +----------------------------------------------+----------------------------------+
+ | | | | | | :doc:`ULCB <rcar-gen3-ulcb>` | rcar3_ulcb_defconfig |
+ | | | +--------------------+--------------------+----------------------------------------------+----------------------------------+
+ | | Gen3 | :doc:`arm64 <build-env-aarch64>` | R8A779MD (M3Le) | Cortex A57 | :doc:`Geist <rcar-gen3-geist>` | r8a779md_geist_defconfig |
+ | | | +--------------------+--------------------+----------------------------------------------+----------------------------------+
+ | | | | | | Eagle | r8a77970_eagle_defconfig |
+ | | | | R8A77970 (V3M) | +----------------------------------------------+----------------------------------+
+ | | | | | | V3MSK | r8a77970_v3msk_defconfig |
+ | | | +--------------------+ +----------------------------------------------+----------------------------------+
+ | | | | | | Condor | r8a77980_condor_defconfig |
+ | | | | R8A77980 (V3H) | Cortex A53 +----------------------------------------------+----------------------------------+
+ | | | | | | V3HSK | r8a77980_v3hsk_defconfig |
+ | | | +--------------------+ +----------------------------------------------+----------------------------------+
+ | | | | R8A77990 (E3) | | :doc:`Ebisu <rcar-gen3-ebisu>` | r8a77990_ebisu_defconfig |
+ | | | +--------------------+ +----------------------------------------------+----------------------------------+
+ | | | | R8A77995 (D3) | | :doc:`Draak <rcar-gen3-draak>` | r8a77995_draak_defconfig |
+ | +------------------+----------------------------------+--------------------+--------------------+----------------------------------------------+----------------------------------+
+ | | | | R8A779A0 (V3U) | Cortex A76 | Falcon | r8a779a0_falcon_defconfig |
+ | | | +--------------------+--------------------+----------------------------------------------+----------------------------------+
+ | | | | | | Spider | r8a779f0_spider_defconfig |
+ | | | | R8A779F0 (S4) | Cortex A55 +----------------------------------------------+----------------------------------+
+ | | | | | | S4SK | r8a779f4_s4sk_defconfig |
+ | | Gen4 | :doc:`arm64 <build-env-aarch64>` +--------------------+--------------------+----------------------------------------------+----------------------------------+
+ | | | | | | White Hawk | r8a779g0_whitehawk_defconfig |
+ | | | | R8A779G3 (V4H) | +----------------------------------------------+----------------------------------+
+ | | | | | Cortex A76 | :doc:`Sparrow Hawk <rcar-gen4-sparrow-hawk>` | r8a779g3_sparrowhawk_defconfig |
+ | | | +--------------------+ +----------------------------------------------+----------------------------------+
+ | | | | R8A779H0 (V4M) | | Gray Hawk | r8a779h0_grayhawk_defconfig |
+ | +------------------+----------------------------------+--------------------+--------------------+----------------------------------------------+----------------------------------+
+ | | | :doc:`arm <build-env-aarch32>` | | Cortex M33 RSIP | | r8a78000_ironhide_cm33_defconfig |
+ | | Gen5 +----------------------------------+ R8A78000 (X5H) +--------------------+ :doc:`Ironhide <rcar-gen5-ironhide>` +----------------------------------+
+ | | | :doc:`arm64 <build-env-aarch64>` | | Cortex A720AE | | r8a78000_ironhide_defconfig |
+ +--------+------------------+----------------------------------+--------------------+--------------------+----------------------------------------------+----------------------------------+
+ | RZ | A1 | :doc:`arm <build-env-aarch32>` | R7S72100 (RZ/A1H) | Cortex A9 | GR-PEACH | grpeach_defconfig |
+ | +------------------+----------------------------------+--------------------+--------------------+----------------------------------------------+----------------------------------+
+ | | | | | | Beacon EmbeddedWorks RZ/G2M SoM | rzg2_beacon_defconfig |
+ | | | | R8A774A1 (RZ/G2M) | Cortex A53 or A57 +----------------------------------------------+----------------------------------+
+ | | | | | | HopeRun HiHope RZ/G2M | hihope_rzg2_defconfig |
+ | | | +--------------------+--------------------+----------------------------------------------+----------------------------------+
+ | | | | | | Beacon EmbeddedWorks RZ/G2N SoM | rzg2_beacon_defconfig |
+ | | G2 | :doc:`arm64 <build-env-aarch64>` | R8A774B1 (RZ/G2N) | Cortex A57 +----------------------------------------------+----------------------------------+
+ | | | | | | HopeRun HiHope RZ/G2N | hihope_rzg2_defconfig |
+ | | | +--------------------+--------------------+----------------------------------------------+----------------------------------+
+ | | | | R8A774C0 (RZ/G2E) | Cortex A53 | Silicon Linux RZ/G2E evaluation kit (EK874) | silinux_ek874_defconfig |
+ | | | +--------------------+--------------------+----------------------------------------------+----------------------------------+
+ | | | | | | Beacon EmbeddedWorks RZ/G2H SoM | rzg2_beacon_defconfig |
+ | | | | R8A774E1 (RZ/G2H) | Cortex A53 or A57 +----------------------------------------------+----------------------------------+
+ | | | | | | HopeRun HiHope RZ/G2H | hihope_rzg2_defconfig |
+ +--------+------------------+----------------------------------+--------------------+--------------------+----------------------------------------------+----------------------------------+
+ | | | | R9A06G032 (RZ/N1D) | | Schneider RZ/N1D board | rzn1_snarc_defconfig |
+ | | :doc:`N1 <rzn1>` | :doc:`arm <build-env-aarch32>` +--------------------+ Cortex A7 +----------------------------------------------+----------------------------------+
+ | | | | R9A06G033 (RZ/N1S) | | Schneider RZ/N1S board | rzn1_snarc_defconfig |
+ +--------+------------------+----------------------------------+--------------------+--------------------+----------------------------------------------+----------------------------------+
- * - R2D
- - R2D-PLUS
- - SH7751
- - sh
- - r2dplus_defconfig
+Generic build procedure
+-----------------------
- * - RZ/A1
- - GR-PEACH
- - R7S72100 (RZ/A1H)
- - arm
- - grpeach_defconfig
+This procedure applies only unless the ``Board`` column in
+the table above does not contain a link to board specific
+details.
- * - R-Car Gen2
- - Lager
- - R8A7790 (H2)
- - arm
- - lager_defconfig
+Locate the appropriate defconfig in the table above.
+Follow toolchain setup procedure in ``Architecture`` column.
+Finally, apply standard build procedure:
- * -
- - Stout
- - R8A7790 (H2)
- - arm
- - stout_defconfig
-
- * -
- - Koelsch
- - R8A7791 (M2-W)
- - arm
- - koelsch_defconfig
-
- * -
- - Porter
- - R8A7791 (M2-W)
- - arm
- - porter_defconfig
-
- * -
- - Blanche
- - R8A7792 (V2H)
- - arm
- - blanche_defconfig
-
- * -
- - Gose
- - R8A7793 (M2-N)
- - arm
- - gose_defconfig
-
- * -
- - Alt
- - R8A7794 (E2)
- - arm
- - alt_defconfig
-
- * -
- - Silk
- - R8A7794 (E2)
- - arm
- - silk_defconfig
-
- * - R-Car Gen3
- - Salvator-X(S)
- - R8A77951 (H3)
- - arm64
- - rcar3_salvator-x_defconfig
-
- * -
- - ULCB
- - R8A77951 (H3)
- - arm64
- - rcar3_ulcb_defconfig
-
- * -
- - Salvator-X(S)
- - R8A77960 (M3-W)
- - arm64
- - rcar3_salvator-x_defconfig
-
- * -
- - ULCB
- - R8A77960 (M3-W)
- - arm64
- - rcar3_ulcb_defconfig
-
- * -
- - Salvator-X(S)
- - R8A77965 (M3-N)
- - arm64
- - rcar3_salvator-x_defconfig
-
- * -
- - ULCB
- - R8A77965 (M3-N)
- - arm64
- - rcar3_ulcb_defconfig
-
- * -
- - Geist
- - R8A779MD (M3Le)
- - arm64
- - r8a779md_geist_defconfig
-
- * -
- - Eagle
- - R8A77970 (V3M)
- - arm64
- - r8a77970_eagle_defconfig
-
- * -
- - V3MSK
- - R8A77970 (V3M)
- - arm64
- - r8a77970_v3msk_defconfig
-
- * -
- - Condor
- - R8A77980 (V3H)
- - arm64
- - r8a77980_condor_defconfig
-
- * -
- - V3HSK
- - R8A77980 (V3H)
- - arm64
- - r8a77980_v3hsk_defconfig
-
- * -
- - Ebisu
- - R8A77990 (E3)
- - arm64
- - r8a77990_ebisu_defconfig
-
- * -
- - Draak
- - R8A77995 (D3)
- - arm64
- - r8a77995_draak_defconfig
-
- * - R-Car Gen4
- - Falcon
- - R8A779A0 (V3U)
- - arm64
- - r8a779a0_falcon_defconfig
-
- * -
- - Spider
- - R8A779F0 (S4)
- - arm64
- - r8a779f0_spider_defconfig
-
- * -
- - S4SK
- - R8A779F4 (S4)
- - arm64
- - r8a779f4_s4sk_defconfig
-
- * -
- - White Hawk
- - R8A779G0 (V4H)
- - arm64
- - r8a779g0_whitehawk_defconfig
-
- * -
- - Sparrow Hawk
- - R8A779G3 (V4H)
- - arm64
- - r8a779g3_sparrowhawk_defconfig
-
- * -
- - Gray Hawk
- - R8A779H0 (V4M)
- - arm64
- - r8a779h0_grayhawk_defconfig
-
- * - R-Car Gen5
- - Ironhide (Cortex-A720AE application core)
- - R8A78000 (X5H)
- - arm64
- - r8a78000_ironhide_defconfig
-
- * -
- - Ironhide (Cortex-M33 RSIP boot core)
- - R8A78000 (X5H)
- - arm64
- - r8a78000_ironhide_cm33_defconfig
-
- * - RZ/G2 Family
- - Beacon EmbeddedWorks RZ/G2M SoM
- - R8A774A1 (RZ/G2M)
- - arm64
- - rzg2_beacon_defconfig
-
- * -
- - HopeRun HiHope RZ/G2M
- - R8A774A1 (RZ/G2M)
- - arm64
- - hihope_rzg2_defconfig
-
- * -
- - Beacon EmbeddedWorks RZ/G2N SoM
- - R8A774B1 (RZ/G2N)
- - arm64
- - rzg2_beacon_defconfig
-
- * -
- - HopeRun HiHope RZ/G2N
- - R8A774B1 (RZ/G2N)
- - arm64
- - hihope_rzg2_defconfig
-
- * -
- - Silicon Linux RZ/G2E evaluation kit (EK874)
- - R8A774C0 (RZ/G2E)
- - arm64
- - silinux_ek874_defconfig
-
- * -
- - Beacon EmbeddedWorks RZ/G2H SoM
- - R8A774E1 (RZ/G2H)
- - arm64
- - rzg2_beacon_defconfig
-
- * -
- - HopeRun HiHope RZ/G2H
- - R8A774E1 (RZ/G2H)
- - arm64
- - hihope_rzg2_defconfig
-
- * - :doc:`RZ/N1 Family <rzn1>`
- - Schneider RZ/N1D board
- - R9A06G032 (RZ/N1D)
- - arm
- - rzn1_snarc_defconfig
-
- * -
- - Schneider RZ/N1S board
- - R9A06G033 (RZ/N1S)
- - arm
- - rzn1_snarc_defconfig
-
-Build
------
-
-Locate the appropriate defconfig in the table above. Then apply standard build
-procedure::
+.. code-block:: console
make <board_defconfig>
make
diff --git a/doc/board/renesas/rzn1.rst b/doc/board/renesas/rzn1.rst
index e6d636b89e8..5f054e8c674 100644
--- a/doc/board/renesas/rzn1.rst
+++ b/doc/board/renesas/rzn1.rst
@@ -10,6 +10,8 @@ This document describes how to build and flash U-Boot for the RZ/N1.
U-Boot
^^^^^^
+Please follow :doc:`Renesas 32-bit ARM SoC build environment setup <build-env-aarch32>`
+to correctly set up the build environment before attempting to build U-Boot.
Clone the U-Boot repository and build it as follows: