From 13c570f2350f59a7994c26a51f749a50fa9b4726 Mon Sep 17 00:00:00 2001
From: Hal Feng <87058983+hal-feng@users.noreply.github.com>
Date: Tue, 20 Dec 2022 16:18:35 +0800
Subject: [PATCH 100/122] Add readme

---
 README.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)
 create mode 100644 README.md

--- /dev/null
+++ b/README.md
@@ -0,0 +1,62 @@
+## JH7110 Upstream Status ##
+
+To get the latest status of each upstreaming patch series, please visit
+our RVspace.
+
+https://rvspace.org/en/project/JH7110_Upstream_Plan
+
+## Build Instructions ##
+
+1. Configure Kconfig options
+
+```shell
+# Use default selections
+make ARCH=riscv CROSS_COMPILE=riscv64-linux-gnu- defconfig
+```
+
+or
+
+```shell
+# Select options manually
+make ARCH=riscv CROSS_COMPILE=riscv64-linux-gnu- nconfig
+```
+
+To boot up the VisionFive 2 board, please make sure **SOC_STARFIVE**, 
+**CLK_STARFIVE_JH7110_SYS**, **PINCTRL_STARFIVE_JH7110_SYS**, 
+**SERIAL_8250_DW** are selected.
+> If you need MMC and GMAC drivers, you should also select
+**MMC_DW_STARFIVE** and **DWMAC_STARFIVE**.
+
+2. Build
+```shell
+make ARCH=riscv CROSS_COMPILE=riscv64-linux-gnu-
+```
+
+## How to Run on VisionFive 2 Board via Network ##
+
+1. Power on, enter u-boot and set enviroment parameters
+```
+setenv fdt_high 0xffffffffffffffff; setenv initrd_high 0xffffffffffffffff;
+setenv scriptaddr 0x88100000; setenv script_offset_f 0x1fff000; setenv script_size_f 0x1000;
+setenv kernel_addr_r 0x84000000; setenv kernel_comp_addr_r 0x90000000; setenv kernel_comp_size 0x10000000;
+setenv fdt_addr_r 0x88000000; setenv ramdisk_addr_r 0x88300000;
+```
+2. Set IP addresses for the board and your tftp server
+```
+setenv serverip 192.168.w.x; setenv gatewayip 192.168.w.y; setenv ipaddr 192.168.w.z; setenv hostname starfive; setenv netdev eth0;
+```
+3. Upload dtb, image and file system to DDR from your tftp server
+```
+tftpboot ${fdt_addr_r} jh7110-starfive-visionfive-2-v1.3b.dtb; tftpboot ${kernel_addr_r} Image.gz; tftpboot ${ramdisk_addr_r} initramfs.cpio.gz;
+```
+> If your VisionFive 2 is v1.2A, you should upload jh7110-starfive-visionfive-2-v1.2a.dtb instead.
+4. Load and boot the kernel
+```
+booti ${kernel_addr_r} ${ramdisk_addr_r}:${filesize} ${fdt_addr_r};
+```
+When you see the message "buildroot login:", the launch was successful.
+You can just input the following accout and password, then continue.
+```
+buildroot login: root
+Password: starfive
+```