Browse Source

Update README.md with suggestions from github community

Signed-off-by: Andy Hu <andy.hu@starfivetech.com>
Andy Hu 4 months ago
parent
commit
9acc7177d4
1 changed files with 18 additions and 17 deletions
  1. 18 17
      README.md

+ 18 - 17
README.md

@@ -1,6 +1,6 @@
 # StarFiveTech VisionFive2 SDK
 
-This builds a complete RISC-V cross-compile toolchain for the `StarFiveTech` `JH7110` SoC. It also builds U-boot SPL, U-boot and a flattened image tree (FIT) image with a Opensbi binary, linux kernel, device tree, ramdisk image and rootfs image for the `JH7110 VisionFive2` board.
+This builds a complete RISC-V cross-compile toolchain for the `StarFiveTech` `JH7110` SoC. It also builds U-boot SPL, U-boot and a flattened image tree (FIT) image with a Opensbi binary, linux kernel, device tree, ramdisk image and rootfs image for the `JH7110 VisionFive2` board. Note this SDK is built with the linux kernel version `5.15`.
 
 ## Prerequisites
 
@@ -32,7 +32,7 @@ Checkout this repository  (e.g.: branch `JH7110_VisionFive2_devel`). Then checko
 	$ cd VisionFive2
 	$ git checkout JH7110_VisionFive2_devel
 	$ git submodule update --init --recursive
-This will take some time and require around 5GB of disk space. Some modules may fail because certain dependencies don't have the best git hosting. The only solution is to wait and try again later (or ask someone for a copy of that source repository).
+This will take some time and require around 9GB of disk space. Some modules may fail because certain dependencies don't have the best git hosting. The only solution is to wait and try again later (or ask someone for a copy of that source repository).
 
 For user who build the release tag version, the above command is enough. For developer, need to switch the 5 submodules `buildroot`, `u-boot`, `linux`, `opensbi`, `soft_3rdpart` to correct branch manually, also could refer to `.gitmodule`
 
@@ -46,7 +46,7 @@ $ cd soft_3rdpart && git checkout JH7110_VisionFive2_devel && cd ..
 
 ## Quick Build Instructions
 
-Below are the quick building for the initramfs image `image.fit` which could be translated to board through tftp and run on board. The completed toolchain, `u-boot-spl.bin.normal.out`, `visionfive2_fw_payload.img`, `image.fit` will be generated under `work/` directory. The completed build tree will consume about 16G of disk space.
+Below are the quick building for the initramfs image `image.fit` which could be translated to board through tftp and run on board. The completed toolchain, `u-boot-spl.bin.normal.out`, `visionfive2_fw_payload.img`, `image.fit` will be generated under `work/` directory. The completed build tree will consume about 18G of disk space.
 
 	$ make -j$(nproc)
 
@@ -84,6 +84,7 @@ Additional command to build single package or module:
 
 ```
 $ make vmlinux   # build linux kernel
+$ make uboot     # build u-boot
 $ make -C ./work/buildroot_rootfs/ O=./work/buildroot_rootfs busybox-rebuild   # build busybox package
 $ make -C ./work/buildroot_rootfs/ O=./work/buildroot_rootfs ffmpeg-rebuild    # build ffmpeg package
 ```
@@ -186,10 +187,10 @@ Then press any key to stop and enter uboot terminal, there are two way to boot t
 
 transfer image.fit through TFTP:
 
-Step1: set enviroment parameter:
+Step1: set environment parameters:
 
 ```
-setenv 192.168.xxx.xxx; setenv serverip 192.168.xxx.xxx;
+setenv ipaddr 192.168.xxx.xxx; setenv serverip 192.168.xxx.xxx;
 ```
 
 Step2: upload image file to ddr:
@@ -198,7 +199,7 @@ Step2: upload image file to ddr:
 tftpboot ${loadaddr} image.fit;
 ```
 
-Step3: load and excute:
+Step3: load and execute:
 
 ```
 bootm start ${loadaddr};bootm loados ${loadaddr};run chipa_set_linux;run cpu_vol_set; booti ${kernel_addr_r} ${ramdisk_addr_r}:${filesize} ${fdt_addr_r};
@@ -213,9 +214,9 @@ Password: starfive
 
 #### 2. Running the other dtb with the Image.gz and initramfs.cpio.gz
 
-If we want to loading the other dtb, e.g. `jh7110-visionfive-v2-wm8960.dtb`, follow the below
+If we want to load the other dtb, e.g. `jh7110-visionfive-v2-wm8960.dtb`, follow the below
 
-Step1: set enviroment parameter:
+Step1: set environment parameters:
 
 ```
 setenv ipaddr 192.168.xxx.xxx; setenv serverip 192.168.xxx.xxx;
@@ -230,7 +231,7 @@ tftpboot ${ramdisk_addr_r} initramfs.cpio.gz;
 run chipa_set_linux;run cpu_vol_set;
 ```
 
-Step3: load and excute:
+Step3: load and execute:
 
 ```
 booti ${kernel_addr_r} ${ramdisk_addr_r}:${filesize} ${fdt_addr_r}
@@ -245,11 +246,11 @@ Password: starfive
 
 ## APPENDIX I: Generate Booting SD Card
 
-If you don't already use a local tftp server, then you probably want to make the TF card target; the default size is 16 GBs. **NOTE THIS WILL DESTROY ALL EXISTING DATA** on the target TF card; The `GPT` Partition Table for the TF card is recommended. 
+If you don't already use a local tftp server, then you probably want to make the TF card target; the default size is 16 GBs. **NOTE THIS WILL DESTROY ALL EXISTING DATA** on the target TF card; The `GPT` Partition Table for the TF card is recommended.
 
 #### Generate SD Card Image File
 
-We could generate a sdcard image file by the below command. The sdcard image file could be burned into sd card or tf card through `dd` command, or `rpi-imager` or `balenaEtcher` tool
+We could generate a sdcard image file by the below command. The sdcard image file could be copied to sd card or tf card through `dd` command, or `rpi-imager` or `balenaEtcher` tool
 
 ```
 $ make -j$(nproc)
@@ -259,21 +260,21 @@ $ make img
 
 The output file `work/sdcard.img`  will be generated.
 
-#### Burn Image File to SD Card
+#### Copy Image File to SD Card
 
-The `sdcard.img` can be burn into a tf card. e.g. through `dd` command as below
+The `sdcard.img` can be copied to a tf card. e.g. through `dd` command as below
 
 ```
 $ sudo dd if=work/sdcard.img of=/dev/sdX bs=4096
 $ sync
 ```
 
-Then extend the tf card rootfs partition if needed. There are two ways to implement it. 
+Then extend the tf card rootfs partition if needed. There are two ways to implement it.
 
 The first way could be done on Ubuntu host, need to install the below package:
 
 ```
-$ sudo apt install cloud-guest-utils e2fsprogs 
+$ sudo apt install cloud-guest-utils e2fsprogs
 ```
 
 Then insert the tf card to Ubuntu host, run the below, note `/dev/sdX` is the tf card device.
@@ -403,8 +404,8 @@ Prepare the tftp sever. e.g. `sudo apt install tftpd-hpa` for Ubuntu host.
    StarFive # sf update ${loadaddr} 0x100000 $filesize
    ```
 
-## APPENDIX IV: Recovering Bootloader 
+## APPENDIX IV: Recovering Bootloader
 
-The SPL and U-Boot are stored inside the SPI flash on board. There may be situations where you accidentally emptied the flash or if the flash is damaged on your board. In these situations, it's better to recover the bootloader. 
+The SPL and U-Boot are stored inside the SPI flash on board. There may be situations where you accidentally emptied the flash or if the flash is damaged on your board. In these situations, it's better to recover the bootloader.
 
 Please jump to https://github.com/starfive-tech/Tools for more details