[PATCH 2/2 v4] board: starfive: support Pine64 Star64 board

[Heinrich Schuchardt]

On 5/20/24 06:42, H Bell wrote:
> Add documentation files
>
> Signed-off-by: Henry Bell <dmoo_dv at protonmail.com>
> Cc: ycliang at andestech.com
> Cc: heinrich.schuchardt at canonical.com
> ---
>
> Changes since v1
>
> - New patch
>
> Changes since v2
>
> - Remove extra params to
> - Clarification on boot section
> - Add entry on MAC adresses and how to correct them
>
> Changes	since v3
>
> - Rebase against d678a59d2d
> ---
>   doc/board/starfive/index.rst         |   1 +
>   doc/board/starfive/pine64_star64.rst | 136 +++++++++++++++++++++++++++
>   2 files changed, 137 insertions(+)
>   create mode 100644 doc/board/starfive/pine64_star64.rst
>
> diff --git a/doc/board/starfive/index.rst b/doc/board/starfive/index.rst
> index d369b986cc..72ab6ddfbf 100644
> --- a/doc/board/starfive/index.rst
> +++ b/doc/board/starfive/index.rst
> @@ -8,4 +8,5 @@ StarFive
>
>      milk-v_mars
>      milk-v_mars_cm
> +   pine64_star64
>      visionfive2
> diff --git a/doc/board/starfive/pine64_star64.rst b/doc/board/starfive/pine64_star64.rst
> new file mode 100644
> index 0000000000..567d1207ba
> --- /dev/null
> +++ b/doc/board/starfive/pine64_star64.rst
> @@ -0,0 +1,136 @@
> +.. SPDX-License-Identifier: GPL-2.0+
> +
> +Pine64 Star64
> +===========

This fails to build in our CI. The length of the underline does not
match the title.

Please, ensure that 'make htmldocs' throws no warnings.

Best regards

Heinrich

> +
> +U-Boot for the Star64 uses the same U-Boot binaries as the VisionFive 2 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:
> +
> +.. code-block:: none
> +
> +   export CROSS_COMPILE=<riscv64 toolchain prefix>
> +
> +The M-mode software OpenSBI provides the supervisor binary interface (SBI) and
> +is responsible for the switch to S-Mode. It is a prerequisite to build U-Boot.
> +Support for the JH7110 was introduced in OpenSBI 1.2. It is recommended to use
> +a current release.
> +
> +.. code-block:: console
> +
> +	git clone https://github.com/riscv/opensbi.git
> +	cd opensbi
> +	make PLATFORM=generic FW_TEXT_START=0x40000000
> +
> +Now build the U-Boot SPL and U-Boot proper.
> +
> +.. code-block:: console
> +
> +	cd <U-Boot-dir>
> +	make starfive_visionfive2_defconfig
> +	make OPENSBI=$(opensbi_dir)/build/platform/generic/firmware/fw_dynamic.bin
> +
> +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.
> +
> +To overrule this selection the variable can be set manually and saved in the
> +environment
> +
> +::
> +
> +    setenv fdtfile my_device-tree.dtb
> +    env save
> +
> +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 (marked S1804) adjacent to the 40pin GPIO
> +Bus for boot selection. The ``L`` (0) and ``H`` (1) silk screening to the side
> +of the should be used to determine state (not the ``ON/ONKE`` markings
> +physically on the component). ``GPIO_0`` is channel 2 on the switch, while
> +``GPIO_1`` is channel 1.
> +
> ++ (QSPI) Flash: 00 ``??``
> ++ SD: 01 ``??``
> ++ EMMC: 10 ``??``
> ++ 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
> +to choose any partition number.
> +
> +With the default configuration U-Boot SPL loads the U-Boot FIT image
> +(u-boot.itb) from partition 2 (CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION=0x2).
> +When formatting it is recommended to use GUID
> +BC13C2FF-59E6-4262-A352-B275FD6F7172 for this partition.
> +
> +The FIT image (u-boot.itb) is a combination of OpenSBI's fw_dynamic.bin,
> +u-boot-nodtb.bin and the device tree blob.
> +
> +Format the SD card (make sure the disk has GPT, otherwise use gdisk to switch)
> +
> +.. code-block:: bash
> +
> +	sudo sgdisk --clear \
> +	  --set-alignment=2 \
> +	  --new=1:4096:8191 --change-name=1:spl --typecode=1:2E54B353-1271-4842-806F-E436D6AF6985\
> +	  --new=2:8192:16383 --change-name=2:uboot --typecode=2:BC13C2FF-59E6-4262-A352-B275FD6F7172  \
> +	  --new=3:16384:1654784 --change-name=3:system --typecode=3:EBD0A0A2-B9E5-4433-87C0-68B6B72699C7 \
> +	  /dev/sdb
> +
> +Copy U-Boot to the SD card
> +
> +.. code-block:: bash
> +
> +	sudo dd if=u-boot-spl.bin.normal.out of=/dev/sdb1
> +	sudo dd if=u-boot.itb of=/dev/sdb2
> +
> +	sudo mount /dev/sdb3 /mnt/
> +	sudo cp u-boot-spl.bin.normal.out /mnt/
> +	sudo cp u-boot.itb /mnt/
> +	sudo cp Image.gz /mnt/
> +	sudo cp initramfs.cpio.gz /mnt/
> +	sudo cp jh7110-starfive-visionfive-2.dtb /mnt/
> +	sudo umount /mnt
> +
> +Booting
> +~~~~~~~
> +
> +Once you plugin the sdcard and power up, you should see the U-Boot prompt.
> +
> +MAC address issues
> +~~~~~~~~~~~~~~~~~~
> +
> +The Star64 does not currently ship with unique serial numbers per-device.
> +Devices tested (all 4GiB RAM) have the same serial number of
> +``STAR64V1-2310-D004E000-00000005`` and the mac addresses of
> +``6c:cf:39:00:75:61`` (lower) and ``6c:cf:39:00:75:62`` (upper) port will be
> +assigned. Shipped models also have the EEPROM set as write protected, so it
> +cannot be changed using ``mac`` commands.
> +
> +The MAC addresses may be "set" as follows by writing as a custom config to SPI
> +(Change the last 3 bytes of MAC addreses as appropriate):
> +
> +::
> +
> +	env set ethaddr 6c:cf:39:00:75:63
> +	env set eth1addr 6c:cf:39:00:75:64
> +	env save
> +	reset