[1/1] configs/beaglev_fire: add support for BeagleV Fire

diff --git a/DEVELOPERS b/DEVELOPERS
index 77971e03db..a99420c0bd 100644
--- a/DEVELOPERS
+++ b/DEVELOPERS
@@ -1484,7 +1484,9 @@  F:	package/swaybg/
 F:	package/yad/
 
 N:	Jamie Gibbons <jamie.gibbons@microchip.com>
+F:	board/beaglev_fire/
 F:	board/microchip/mpfs_icicle/
+F:	configs/beaglev_fire_defconfig
 F:	configs/microchip_mpfs_icicle_defconfig
 F:	package/microchip-hss-payload-generator/
 
diff --git a/board/beaglev_fire/README.txt b/board/beaglev_fire/README.txt
new file mode 100644
index 0000000000..ae6660f7ab
--- /dev/null
+++ b/board/beaglev_fire/README.txt
@@ -0,0 +1,90 @@ 
+Beagle-V Fire
+==============
+
+BeagleV Fire is a low-cost RISC-V 64-bit based platform, powered by
+Microchip's PolarFire SoC. This file describes how to use the
+pre-defined Buildroot configuration for the Beagle-V Fire board.
+
+Further information about the Beagle-V Fire can be found at
+https://docs.beagleboard.org/latest/boards/beaglev/fire/index.html.
+
+
+Building
+========
+
+Configure Buildroot using the default board configuration:
+
+  '$ make beaglev_fire_defconfig'
+
+Customise the build as necessary:
+
+  '$ make menuconfig'
+
+Start the build:
+
+  '$ make'
+
+
+Result of the build
+===================
+
+Once the build has finished you will have the following files:
+
+    output/images/
+    +-- boot.scr
+    +-- boot.vfat
+    +-- Image
+    +-- beaglev_fire.itb
+    +-- beaglev_fire.its
+    +-- mpfs-beaglev-fire.dtb
+    +-- payload.bin
+    +-- rootfs.cpio
+    +-- rootfs.cpio.gz
+    +-- sdcard.img
+    +-- u-boot.bin
+
+
+Flashing the image to your eMMC
+===============================
+
+By default Buildroot builds a compatible image for you. The first partition
+of this image contains a U-Boot binary, embedded in a Hart Software
+Services (HSS) payload. The second partition contains a FAT filesystem
+with a U-Boot env and an ITB file containing the kernel and the device
+tree. The third partition contains the file system. This image can be
+written directly to the eMMC. All you need to do is dd the image to the eMMC,
+which can be done with the following command on your development host:
+
+  '$ sudo dd if=output/images/sdcard.img of=/dev/sdb bs=1M'
+
+
+Customize BeagleV-Fire Cape Gateware Using Verilog
+==================================================
+
+To customize your Beagle-V Fire gateware please follow the guide below to
+create your custom bitstream (steps 1 - 6):
+https://docs.beagleboard.org/latest/boards/beaglev/fire/demos-and-tutorials/gateware/customize-cape-gateware-verilog.html
+
+
+Program BeagleV-Fire With Your Custom Bitstream with Buildroot
+==============================================================
+
+Unzip the downloaded artifacts.zip file. 
+
+Go to the custom FPGA design directory:
+  'cd artifacts/bitstreams/my_custom_fpga_design'
+
+On your Linux host development computer, copy the bitstream to BeagleV-Fire
+board, replacing </path/to/your/> with the path to your BeagleV-Fire root file
+system.
+  'cp -r ./LinuxProgramming /path/to/your/buildroot/board/beaglev_fire/rootfs-overlay/etc/'
+
+On BeagleV-Fire,
+  1. Make your change gateware script executable
+    'chmod +x /usr/share/beagleboard/gateware/change-gateware.sh'
+  2. Create a firmware directory
+    'mkdir /lib/firmware'
+  3. initiate the reprogramming of the FPGA with your gateware bitstream:
+    '/usr/share/beagleboard/gateware/change-gateware.sh /etc/LinuxProgramming/'
+
+Wait for a couple of minutes for the BeagleV-Fire to reprogram itself.
\ No newline at end of file
diff --git a/board/beaglev_fire/beaglev_fire.its b/board/beaglev_fire/beaglev_fire.its
new file mode 100644
index 0000000000..b1591c5342
--- /dev/null
+++ b/board/beaglev_fire/beaglev_fire.its
@@ -0,0 +1,56 @@ 
+// SPDX-License-Identifier: (GPL-2.0+ OR MIT)
+/*
+ * Flattened Image Tree file for BVF
+ *
+ * Copyright (C) 2022 Microchip Technology Inc. and its subsidiaries.
+ * Author: Conor Dooley <conor.dooley@microchip.com>
+ *
+ */
+
+/dts-v1/;
+
+/ {
+	description = "U-Boot fitImage for the BeagleV-Fire";
+	#address-cells = <2>;
+
+		images {
+			kernel {
+				description = "Linux kernel";
+				data = /incbin/("./Image.gz");
+				type = "kernel";
+				arch = "riscv";
+				os = "linux";
+				compression = "gzip";
+				load = <0x80200000>;
+				entry = <0x80200000>;
+				hash-1 {
+					algo = "sha256";
+				};
+			};
+			base_fdt {
+				description = "Flattened Device Tree blob";
+				data = /incbin/("./mpfs-beaglev-fire.dtb");
+				type = "flat_dt";
+				arch = "riscv";
+				compression = "none";
+				load = <0x8a000000>;
+				hash-1 {
+					algo = "sha256";
+				};
+			};
+		};
+
+		configurations {
+			default = "kernel_dtb";
+			kernel_dtb {
+				description = "1 Linux kernel, FDT blob";
+				kernel = "kernel";
+				fdt = "base_fdt";
+			};
+
+			base_dtb {
+				description = "Base FDT blob for BeagleV-Fire board";
+				fdt = "base_fdt";
+			};
+		};
+};
diff --git a/board/beaglev_fire/config.yaml b/board/beaglev_fire/config.yaml
new file mode 100644
index 0000000000..5fccdfd34f
--- /dev/null
+++ b/board/beaglev_fire/config.yaml
@@ -0,0 +1,28 @@ 
+#
+# HSS Payload Generator - buildroot configuration file
+#
+
+# First, we can optionally set a name for our image, otherwise one will be created dynamically
+set-name: 'PolarFire-SoC-HSS::U-Boot'
+
+#
+# Next, we'll define the entry point addresses for each hart, as follows:
+#
+hart-entry-points: {u54_1: '0x80200000', u54_2: '0x80200000', u54_3: '0x80200000', u54_4: '0x80200000'}
+#
+# Finally, we'll define a payloads (source binary file) that will be placed at certain regions in memory
+# The payload section is defined with the keyword payloads, and then a number of individual
+# payload descriptors.
+#
+# Each payload has a name (path to its ELF/bin file), an owner-hart, and optionally 1-3 secondary-harts.
+#
+# Additionally, it has a privilege mode in which it will start execution.
+#  * Valid privilege modes are PRV_M, PRV_S and PRV_U.
+#
+#
+# In this case, the only payload is the u-boot s-mode binary.
+#
+# Case only matters for the ELF path names, not the keywords.
+#
+payloads:
+  u-boot.bin: {exec-addr: '0x80200000', owner-hart: u54_1, secondary-hart: u54_2, secondary-hart: u54_3, secondary-hart: u54_4, priv-mode: prv_s}
diff --git a/board/beaglev_fire/genimage.cfg b/board/beaglev_fire/genimage.cfg
new file mode 100644
index 0000000000..1ff2da68ff
--- /dev/null
+++ b/board/beaglev_fire/genimage.cfg
@@ -0,0 +1,36 @@ 
+# Image for eMMC boot on the Microchip PolarFire SOC BeagleV-Fire Board
+#
+image boot.vfat {
+	vfat {
+		files = {
+			 "beaglev_fire.itb",
+		}
+
+		file boot.scr {
+			image = "boot.scr"
+		}
+	}
+	size = 60M
+}
+
+image sdcard.img {
+	hdimage {
+		gpt = true
+	}
+
+	partition uboot {
+		partition-type-uuid = 21686148-6449-6E6F-744E-656564454649
+		image = "payload.bin"
+	}
+
+	partition kernel {
+		partition-type-uuid = 0FC63DAF-8483-4772-8E79-3D69D8477DE4
+		bootable = "true"
+		image = "boot.vfat"
+	}
+
+	partition root {
+		partition-type-uuid = 0FC63DAF-8483-4772-8E79-3D69D8477DE4
+		image = "rootfs.cpio"
+	}
+}
diff --git a/board/beaglev_fire/post-image.sh b/board/beaglev_fire/post-image.sh
new file mode 100755
index 0000000000..43be1356cf
--- /dev/null
+++ b/board/beaglev_fire/post-image.sh
@@ -0,0 +1,14 @@ 
+#!/bin/bash
+set -e
+
+HSS_PAYLOAD_GENERATOR="${HOST_DIR}"/bin/hss-payload-generator
+MKIMAGE="${HOST_DIR}"/bin/mkimage
+BOARD_DIR="$(pwd)"/"${0%/*}"
+
+pushd "${BINARIES_DIR}"
+"${HSS_PAYLOAD_GENERATOR}" -c "${BOARD_DIR}"/config.yaml payload.bin
+cp "${BOARD_DIR}"/beaglev_fire.its "${BINARIES_DIR}"/beaglev_fire.its
+gzip -9 Image -c > Image.gz
+"${MKIMAGE}" -f beaglev_fire.its beaglev_fire.itb
+popd
+support/scripts/genimage.sh -c "${BOARD_DIR}"/genimage.cfg
diff --git a/board/beaglev_fire/rootfs-overlay/etc/motd b/board/beaglev_fire/rootfs-overlay/etc/motd
new file mode 100644
index 0000000000..6c01ba7f96
--- /dev/null
+++ b/board/beaglev_fire/rootfs-overlay/etc/motd
@@ -0,0 +1,5 @@ 
+
+This is version v2024.02 of PolarFire SoC Buildroot External.
+ 
+Updated images and documentation are available at:
+https://github.com/polarfire-soc/
diff --git a/board/beaglev_fire/rootfs-overlay/usr/share/beagleboard/gateware/change-gateware.sh b/board/beaglev_fire/rootfs-overlay/usr/share/beagleboard/gateware/change-gateware.sh
new file mode 100644
index 0000000000..0a35b6178b
--- /dev/null
+++ b/board/beaglev_fire/rootfs-overlay/usr/share/beagleboard/gateware/change-gateware.sh
@@ -0,0 +1,25 @@ 
+#!/bin/bash
+
+if [ -d "$1" ]
+then
+    echo "Changing gateware."
+    if [ -e "$1"/mpfs_bitstream.spi ]
+    then
+        if [ -e "$1"/mpfs_dtbo.spi ]
+        then
+            if ! [ -d /lib/firmware ]
+            then
+                mkdir /lib/firmware
+            fi
+            cp "$1"/mpfs_dtbo.spi /lib/firmware/mpfs_dtbo.spi
+            cp "$1"/mpfs_bitstream.spi /lib/firmware/mpfs_bitstream.spi
+            . /usr/share/microchip/update-gateware.sh
+        else
+            echo "No device tree overlay file found."
+        fi
+    else
+        echo "No gateware file found."
+    fi
+else
+    echo "No directory found for this requested gateware."
+fi
diff --git a/board/beaglev_fire/rootfs-overlay/usr/share/microchip/update-gateware.sh b/board/beaglev_fire/rootfs-overlay/usr/share/microchip/update-gateware.sh
new file mode 100644
index 0000000000..2e91c0f4f9
--- /dev/null
+++ b/board/beaglev_fire/rootfs-overlay/usr/share/microchip/update-gateware.sh
@@ -0,0 +1,36 @@ 
+#!/bin/bash
+echo "================================================================================"
+echo "|                            FPGA Gateware Update                              |"
+echo "|                                                                              |"
+echo "|   Please ensure that the mpfs_bitstream.spi file containing the gateware     |"
+echo "|   update has been copied to directory /lib/firmware.                         |"
+echo "|                                                                              |"
+echo "|                 !!! This will take a couple of minutes. !!!                  |"
+echo "|                                                                              |"
+echo "|               Give the system a few minutes to reboot itself                 |"
+echo "|                        after Linux has shutdown.                             |"
+echo "|                                                                              |"
+echo "================================================================================"
+
+read -rsp $'Press any key to continue...\n' -n1 key
+
+mount -t debugfs none /sys/kernel/debug
+
+# Trash exisitng device tree overlay in case the rest of the process fails:
+mtd_debug erase /dev/mtd0 0x0 0x10000
+
+# Write device tree overlay
+dtbo_ls=$(ls -l /lib/firmware/mpfs_dtbo.spi)
+dtbo_size=$(echo "$dtbo_ls" | cut -d " "  -f 5)
+
+mtd_debug write /dev/mtd0 0x400 "$dtbo_size" /lib/firmware/mpfs_dtbo.spi > /dev/zero
+
+# Fake the presence of a golden image for now.
+mtd_debug write /dev/mtd0 0 4 /dev/zero > /dev/zero
+
+# Initiate FPGA update.
+echo 1 > /sys/kernel/debug/fpga/microchip_exec_update
+
+# Reboot Linux for the gateware update to take effect.
+# FPGA reprogramming takes places between Linux shut-down and HSS restarting the board.
+reboot
diff --git a/board/beaglev_fire/uboot-env.txt b/board/beaglev_fire/uboot-env.txt
new file mode 100644
index 0000000000..1b996ed76b
--- /dev/null
+++ b/board/beaglev_fire/uboot-env.txt
@@ -0,0 +1,16 @@ 
+# this assumes ${scriptaddr} is already set!!
+
+# Try to boot a fitImage from eMMC/SD
+
+setenv fdt_high 0xffffffffffffffff
+setenv initrd_high 0xffffffffffffffff
+
+load mmc 0:${distro_bootpart} ${scriptaddr} beaglev_fire.itb;
+bootm start ${scriptaddr}#kernel_dtb;
+bootm loados ${scriptaddr};
+# Try to load a ramdisk if available inside fitImage
+bootm ramdisk;
+bootm prep;
+fdt set /soc/ethernet@20112000 mac-address ${beaglevfire_mac_addr0};
+fdt set /soc/ethernet@20110000 mac-address ${beaglevfire_mac_addr1};
+bootm go;
diff --git a/board/beaglev_fire/uboot-fragment.config b/board/beaglev_fire/uboot-fragment.config
new file mode 100644
index 0000000000..861593bd7e
--- /dev/null
+++ b/board/beaglev_fire/uboot-fragment.config
@@ -0,0 +1 @@ 
+CONFIG_MPFS_PRIORITISE_QSPI_BOOT=n
diff --git a/configs/beaglev_fire_defconfig b/configs/beaglev_fire_defconfig
new file mode 100644
index 0000000000..3779658509
--- /dev/null
+++ b/configs/beaglev_fire_defconfig
@@ -0,0 +1,40 @@ 
+BR2_riscv=y
+BR2_RISCV_ISA_RVC=y
+BR2_KERNEL_HEADERS_VERSION=y
+BR2_DEFAULT_KERNEL_VERSION="6.1.30"
+BR2_PACKAGE_HOST_LINUX_HEADERS_CUSTOM_6_1=y
+BR2_SYSTEM_DHCP="eth0"
+BR2_ROOTFS_OVERLAY="board/beaglev_fire/rootfs-overlay/"
+BR2_ROOTFS_POST_IMAGE_SCRIPT="board/beaglev_fire/post-image.sh"
+BR2_LINUX_KERNEL=y
+BR2_LINUX_KERNEL_CUSTOM_TARBALL=y
+BR2_LINUX_KERNEL_CUSTOM_TARBALL_LOCATION="$(call github,linux4microchip,linux,linux-6.1-mchp+fpga)/linux4microchip+fpga-2024.02.tar.gz"
+BR2_LINUX_KERNEL_DEFCONFIG="mpfs"
+BR2_LINUX_KERNEL_DTS_SUPPORT=y
+BR2_LINUX_KERNEL_INTREE_DTS_NAME="microchip/mpfs-beaglev-fire"
+BR2_PACKAGE_BUSYBOX_SHOW_OTHERS=y
+BR2_PACKAGE_MTD=y
+BR2_PACKAGE_DTC=y
+BR2_PACKAGE_DTC_PROGRAMS=y
+BR2_PACKAGE_BASH=y
+BR2_TARGET_ROOTFS_CPIO_GZIP=y
+BR2_TARGET_ROOTFS_INITRAMFS=y
+# BR2_TARGET_ROOTFS_TAR is not set
+BR2_TARGET_UBOOT=y
+BR2_TARGET_UBOOT_BUILD_SYSTEM_KCONFIG=y
+BR2_TARGET_UBOOT_CUSTOM_TARBALL=y
+BR2_TARGET_UBOOT_CUSTOM_TARBALL_LOCATION="$(call github,polarfire-soc,u-boot)linux4microchip+fpga-2024.02.tar.gz"
+BR2_TARGET_UBOOT_BOARD_DEFCONFIG="beaglev_fire"
+BR2_TARGET_UBOOT_CONFIG_FRAGMENT_FILES="board/beaglev_fire/uboot-fragment.config"
+BR2_TARGET_UBOOT_NEEDS_DTC=y
+BR2_TARGET_UBOOT_NEEDS_OPENSSL=y
+BR2_PACKAGE_HOST_GENEXT2FS=y
+BR2_PACKAGE_HOST_GENIMAGE=y
+BR2_PACKAGE_HOST_GPTFDISK=y
+BR2_PACKAGE_HOST_MICROCHIP_HSS_PAYLOAD_GENERATOR=y
+BR2_PACKAGE_HOST_MTOOLS=y
+BR2_PACKAGE_HOST_SQUASHFS=y
+BR2_PACKAGE_HOST_UBOOT_TOOLS=y
+BR2_PACKAGE_HOST_UBOOT_TOOLS_FIT_SUPPORT=y
+BR2_PACKAGE_HOST_UBOOT_TOOLS_BOOT_SCRIPT=y
+BR2_PACKAGE_HOST_UBOOT_TOOLS_BOOT_SCRIPT_SOURCE="board/beaglev_fire/uboot-env.txt"