[PATCH v2 6/8] doc: starfive: use consistent formatting
Heinrich Schuchardt
heinrich.schuchardt at canonical.com
Mon Mar 31 09:24:08 CEST 2025
Always use ---- for the H2 level.
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt at canonical.com>
---
v2:
new patch
---
doc/board/starfive/milk-v_mars.rst | 10 +++++-----
doc/board/starfive/milk-v_mars_cm.rst | 12 ++++++------
doc/board/starfive/pine64_star64.rst | 12 ++++++------
doc/board/starfive/visionfive2.rst | 10 +++++-----
4 files changed, 22 insertions(+), 22 deletions(-)
diff --git a/doc/board/starfive/milk-v_mars.rst b/doc/board/starfive/milk-v_mars.rst
index 554932ecfd4..aba9c9c53d4 100644
--- a/doc/board/starfive/milk-v_mars.rst
+++ b/doc/board/starfive/milk-v_mars.rst
@@ -8,7 +8,7 @@ board. In U-Boot SPL the actual board is detected and the device-tree patched
accordingly.
Building
-~~~~~~~~
+--------
1. Add the RISC-V toolchain to your PATH.
2. Setup ARCH & cross compilation environment variable:
@@ -40,7 +40,7 @@ This will generate the U-Boot SPL image (spl/u-boot-spl.bin.normal.out) as well
as the FIT image (u-boot.itb) with OpenSBI and U-Boot.
Device-tree selection
-~~~~~~~~~~~~~~~~~~~~~
+---------------------
Depending on the board version U-Boot set variable $fdtfile to either
starfive/jh7110-starfive-visionfive-2-v1.2a.dtb or
@@ -58,14 +58,14 @@ or the configuration variable CONFIG_DEFAULT_FDT_FILE can be used to set to
provide a default value.
Boot source selection
-~~~~~~~~~~~~~~~~~~~~~
+---------------------
The board provides the DIP switches MSEL[1:0] to select the boot device out of
SPI flash, eMMC, SD-card, UART. To select booting from SD-card set the DIP
switches MSEL[1:0] to 10.
Preparing the SD-Card
-~~~~~~~~~~~~~~~~~~~~~
+---------------------
The device firmware loads U-Boot SPL (u-boot-spl.bin.normal.out) from the
partition with type GUID 2E54B353-1271-4842-806F-E436D6AF6985. You are free
@@ -106,6 +106,6 @@ Copy U-Boot to the SD card
sudo umount /mnt
Booting
-~~~~~~~
+-------
Once you plugin the sdcard and power up, you should see the U-Boot prompt.
diff --git a/doc/board/starfive/milk-v_mars_cm.rst b/doc/board/starfive/milk-v_mars_cm.rst
index 52d4e5e9098..b56abf2a94e 100644
--- a/doc/board/starfive/milk-v_mars_cm.rst
+++ b/doc/board/starfive/milk-v_mars_cm.rst
@@ -35,7 +35,7 @@ By default the EEPROM is write protected. The write protection may be overcome
by connecting the "GND" and "EN" test pads on top of the module.
Building
-~~~~~~~~
+--------
1. Add the RISC-V toolchain to your PATH.
2. Setup ARCH & cross compilation environment variable:
@@ -70,7 +70,7 @@ This will generate the U-Boot SPL image (spl/u-boot-spl.bin.normal.out) as well
as the FIT image (u-boot.itb) with OpenSBI and U-Boot.
Device-tree selection
-~~~~~~~~~~~~~~~~~~~~~
+---------------------
Depending on the board version U-Boot sets variable $fdtfile to either
starfive/jh7110-milkv-mars-cm.dtb (with eMMC storage) or
@@ -93,7 +93,7 @@ process refer to the :doc:`/develop/bootstd/index`
description.
Boot source selection
-~~~~~~~~~~~~~~~~~~~~~
+---------------------
The low speed connector nRPIBOOT line is used to switch the boot source.
@@ -103,7 +103,7 @@ The low speed connector nRPIBOOT line is used to switch the boot source.
Compute module boards typically have a switch or jumper for this line.
Flashing a new U-Boot version
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-----------------------------
U-Boot SPL is provided as file spl/u-boot-spl.bin.normal.out. Main U-Boot is
in file u-boot.itb.
@@ -131,7 +131,7 @@ default.
env save
Booting from UART
-~~~~~~~~~~~~~~~~~
+-----------------
For booting via UART U-Boot must be built with CONFIG_SPL_YMODEM_SUPPORT=y.
@@ -187,7 +187,7 @@ Press *ctrl-t y* to initiate YMODEM transfer.
U-Boot 2024.07-rc1-00075-gd6a4ab20097 (Apr 25 2024 - 16:32:10 +0200)
Booting from SPI flash
-~~~~~~~~~~~~~~~~~~~~~~
+----------------------
With nRPIBOOT disconnected from ground for SPI boot, power up the board. You
should see the U-Boot prompt on the serial console.
diff --git a/doc/board/starfive/pine64_star64.rst b/doc/board/starfive/pine64_star64.rst
index 52e9a907917..1df4b68e4a0 100644
--- a/doc/board/starfive/pine64_star64.rst
+++ b/doc/board/starfive/pine64_star64.rst
@@ -8,7 +8,7 @@ In U-Boot SPL the actual board is detected and the device-tree patched
accordingly.
Building
-~~~~~~~~
+--------
1. Add the RISC-V toolchain to your PATH.
2. Setup ARCH & cross compilation environment variable:
@@ -40,7 +40,7 @@ This will generate the U-Boot SPL image (spl/u-boot-spl.bin.normal.out) as well
as the FIT image (u-boot.itb) with OpenSBI and U-Boot.
Device-tree selection
-~~~~~~~~~~~~~~~~~~~~~
+---------------------
U-Boot will set variable $fdtfile to starfive/jh7110-pine64-star64.dtb.
@@ -56,7 +56,7 @@ or the configuration variable CONFIG_DEFAULT_FDT_FILE can be used to set to
provide a default value.
Boot source selection
-~~~~~~~~~~~~~~~~~~~~~
+---------------------
Boot mode is selected by an MSEL-DIP marked S1804 and GPIO_0 position adjacent
to the 40pin GPIO header. ON/ONKE and number markings of the MSEL-DIP are
@@ -69,7 +69,7 @@ accurate selection.
+ UART: 11
Preparing the SD-Card
-~~~~~~~~~~~~~~~~~~~~~
+---------------------
The device firmware loads U-Boot SPL (u-boot-spl.bin.normal.out) from the
partition with type GUID 2E54B353-1271-4842-806F-E436D6AF6985. You are free
@@ -110,12 +110,12 @@ Copy U-Boot to the SD card
sudo umount /mnt
Booting
-~~~~~~~
+-------
Once you plugin the sdcard and power up, you should see the U-Boot prompt.
Serial Number and MAC address issues
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+------------------------------------
U-Boot requires valid EEPROM data to determine which board-specific fix-up to
apply at runtime. This affects the size of memory initialized, network mac
diff --git a/doc/board/starfive/visionfive2.rst b/doc/board/starfive/visionfive2.rst
index 2c68df3ce4d..44e7fcb3a48 100644
--- a/doc/board/starfive/visionfive2.rst
+++ b/doc/board/starfive/visionfive2.rst
@@ -36,7 +36,7 @@ Currently, the u-boot.itb is used as a dynamic of the OpenSBI FW_DYNAMIC
firmware with the latest.
Building
-~~~~~~~~
+--------
1. Add the RISC-V toolchain to your PATH.
2. Setup ARCH & cross compilation environment variable:
@@ -72,7 +72,7 @@ This will generate the U-Boot SPL image (spl/u-boot-spl.bin.normal.out) as well
as the FIT image (u-boot.itb) with OpenSBI and U-Boot.
Device-tree selection
-~~~~~~~~~~~~~~~~~~~~~
+---------------------
Depending on the board version U-Boot set variable $fdtfile to either
starfive/jh7110-starfive-visionfive-2-v1.2a.dtb or
@@ -90,7 +90,7 @@ or the configuration variable CONFIG_DEFAULT_FDT_FILE can be used to provide
a default value.
Flashing
-~~~~~~~~
+--------
The device firmware loads U-Boot SPL (u-boot-spl.bin.normal.out) from the
partition with type GUID 2E54B353-1271-4842-806F-E436D6AF6985. You are free
@@ -133,7 +133,7 @@ Program the SD card
sudo umount /mnt
Booting
-~~~~~~~
+-------
The board provides the DIP switches MSEL[1:0] to select the boot device.
To select booting from SD-card set the DIP switches MSEL[1:0] to 10.
@@ -141,7 +141,7 @@ To select booting from SD-card set the DIP switches MSEL[1:0] to 10.
Once you plugin the sdcard and power up, you should see the U-Boot prompt.
Sample boot log from StarFive VisionFive2 board
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-----------------------------------------------
.. code-block:: none
--
2.48.1
More information about the U-Boot
mailing list