Skip to content

Commit 9acc717

Browse files
committed
Update README.md with suggestions from github community
Signed-off-by: Andy Hu <[email protected]>
1 parent 345e6ac commit 9acc717

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

README.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# StarFiveTech VisionFive2 SDK
22

3-
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.
3+
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`.
44

55
## Prerequisites
66

@@ -32,7 +32,7 @@ Checkout this repository (e.g.: branch `JH7110_VisionFive2_devel`). Then checko
3232
$ cd VisionFive2
3333
$ git checkout JH7110_VisionFive2_devel
3434
$ git submodule update --init --recursive
35-
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).
35+
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).
3636

3737
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`
3838

@@ -46,7 +46,7 @@ $ cd soft_3rdpart && git checkout JH7110_VisionFive2_devel && cd ..
4646

4747
## Quick Build Instructions
4848

49-
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.
49+
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.
5050

5151
$ make -j$(nproc)
5252

@@ -84,6 +84,7 @@ Additional command to build single package or module:
8484

8585
```
8686
$ make vmlinux # build linux kernel
87+
$ make uboot # build u-boot
8788
$ make -C ./work/buildroot_rootfs/ O=./work/buildroot_rootfs busybox-rebuild # build busybox package
8889
$ make -C ./work/buildroot_rootfs/ O=./work/buildroot_rootfs ffmpeg-rebuild # build ffmpeg package
8990
```
@@ -186,10 +187,10 @@ Then press any key to stop and enter uboot terminal, there are two way to boot t
186187

187188
transfer image.fit through TFTP:
188189

189-
Step1: set enviroment parameter:
190+
Step1: set environment parameters:
190191

191192
```
192-
setenv 192.168.xxx.xxx; setenv serverip 192.168.xxx.xxx;
193+
setenv ipaddr 192.168.xxx.xxx; setenv serverip 192.168.xxx.xxx;
193194
```
194195

195196
Step2: upload image file to ddr:
@@ -198,7 +199,7 @@ Step2: upload image file to ddr:
198199
tftpboot ${loadaddr} image.fit;
199200
```
200201

201-
Step3: load and excute:
202+
Step3: load and execute:
202203

203204
```
204205
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
213214

214215
#### 2. Running the other dtb with the Image.gz and initramfs.cpio.gz
215216

216-
If we want to loading the other dtb, e.g. `jh7110-visionfive-v2-wm8960.dtb`, follow the below
217+
If we want to load the other dtb, e.g. `jh7110-visionfive-v2-wm8960.dtb`, follow the below
217218

218-
Step1: set enviroment parameter:
219+
Step1: set environment parameters:
219220

220221
```
221222
setenv ipaddr 192.168.xxx.xxx; setenv serverip 192.168.xxx.xxx;
@@ -230,7 +231,7 @@ tftpboot ${ramdisk_addr_r} initramfs.cpio.gz;
230231
run chipa_set_linux;run cpu_vol_set;
231232
```
232233

233-
Step3: load and excute:
234+
Step3: load and execute:
234235

235236
```
236237
booti ${kernel_addr_r} ${ramdisk_addr_r}:${filesize} ${fdt_addr_r}
@@ -245,11 +246,11 @@ Password: starfive
245246

246247
## APPENDIX I: Generate Booting SD Card
247248

248-
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.
249+
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.
249250

250251
#### Generate SD Card Image File
251252

252-
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
253+
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
253254

254255
```
255256
$ make -j$(nproc)
@@ -259,21 +260,21 @@ $ make img
259260

260261
The output file `work/sdcard.img` will be generated.
261262

262-
#### Burn Image File to SD Card
263+
#### Copy Image File to SD Card
263264

264-
The `sdcard.img` can be burn into a tf card. e.g. through `dd` command as below
265+
The `sdcard.img` can be copied to a tf card. e.g. through `dd` command as below
265266

266267
```
267268
$ sudo dd if=work/sdcard.img of=/dev/sdX bs=4096
268269
$ sync
269270
```
270271

271-
Then extend the tf card rootfs partition if needed. There are two ways to implement it.
272+
Then extend the tf card rootfs partition if needed. There are two ways to implement it.
272273

273274
The first way could be done on Ubuntu host, need to install the below package:
274275

275276
```
276-
$ sudo apt install cloud-guest-utils e2fsprogs
277+
$ sudo apt install cloud-guest-utils e2fsprogs
277278
```
278279

279280
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.
403404
StarFive # sf update ${loadaddr} 0x100000 $filesize
404405
```
405406

406-
## APPENDIX IV: Recovering Bootloader
407+
## APPENDIX IV: Recovering Bootloader
407408

408-
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.
409+
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.
409410

410411
Please jump to https://github.com/starfive-tech/Tools for more details

0 commit comments

Comments
 (0)