From c80294c1a1ef61054378b52aae603af65c963eec Mon Sep 17 00:00:00 2001 From: PanderMusubi Date: Mon, 16 Nov 2020 23:51:39 +0100 Subject: [PATCH] minor documentation improvements --- README.md | 3 ++- blobs/README.md | 12 +++++++----- bootlogo/battery/README.md | 3 ++- kernel/README.md | 6 ++++-- simpleimage/README.md | 5 ++++- simpleimage/make_simpleimage.sh | 2 +- u-boot-postprocess/README.md | 7 +++++-- u-boot-postprocess/u-boot-postprocess.sh | 2 +- 8 files changed, 26 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 0076ac4a..4e862a43 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,5 @@ Various scripts i created while looking into Pine64 U-Boot and booting. ## License -These scripts are made available under the MIT license in the hope they might be useful to others. See LICENSE.txt for details. +These scripts are made available under the MIT license in the hope they might be +useful to others. See LICENSE.txt for details. diff --git a/blobs/README.md b/blobs/README.md index 6ccede0a..67902e0f 100644 --- a/blobs/README.md +++ b/blobs/README.md @@ -27,12 +27,14 @@ Binary blob scp.bin taken from the BSP `tools/pack/chips/sun50iw1p1/bin/scp.bin` ## Device tree for U-Boot and BSP Kernel -The U-Boot uses its own FDT. A binary dtb has been extraced from the BSP `out/sun50iw1p1/android/common/sunxi.dtb` and dumped as source to `pine64.dts` with the `fdtdump` -utility from git://git.kernel.org/pub/scm/utils/dtc/dtc.git. This device tree -also works for booting the BSP Kernel. Some values in the device tree have -been changed to match the values which are found in the Android image. +The U-Boot uses its own FDT. A binary dtb has been extracted from the BSP +`out/sun50iw1p1/android/common/sunxi.dtb` and dumped as source to `pine64.dts` +with the `fdtdump` utility from git://git.kernel.org/pub/scm/utils/dtc/dtc.git. +This device tree also works for booting the BSP Kernel. Some values in the +device tree have been changed to match the values which are found in the Android +image. ## FEX description for U-Boot The FEX file is minimal and does not contain any settings. It is just required -to get the corret boot loader format to make the U-Boot acceptable to boot0. +to get the correct boot loader format to make the U-Boot acceptable to boot0. diff --git a/bootlogo/battery/README.md b/bootlogo/battery/README.md index 0c4393dd..0b35a7bc 100644 --- a/bootlogo/battery/README.md +++ b/bootlogo/battery/README.md @@ -1,4 +1,5 @@ ## Battery icons This battery icons are loaded by u-boot in certain bootup stages. See -https://github.com/longsleep/u-boot-pine64/blob/55c9c8c8ac005b1c00ac948386c60c4a741ebaa9/board/sunxi/common/power_check.c#L58-L81 for details. +https://github.com/longsleep/u-boot-pine64/blob/55c9c8c8ac005b1c00ac948386c60c4a741ebaa9/board/sunxi/common/power_check.c#L58-L81 +for details. diff --git a/kernel/README.md b/kernel/README.md index 106025a5..6f3d493b 100644 --- a/kernel/README.md +++ b/kernel/README.md @@ -55,7 +55,9 @@ LICHEE_KDIR=$(pwd)/../.. ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- LICHEE_PLAT ``` This will compile the mali.ko Kernel module with the Kernel .config found in -LICHEE_KDIR. To use that module with Linux, copy it to `/lib/modules/${version}/kernel/extramodules` or some other directory which can contain Kernel modules. +LICHEE_KDIR. To use that module with Linux, copy it to +`/lib/modules/${version}/kernel/extramodules` or some other directory which can +contain Kernel modules. ## Ramdisk @@ -87,7 +89,7 @@ the busybox binary compiled earlier. Now that you have a Kernel and initrd copy them together with the compiled device tree to a target location. You can use the `install_kernel.sh` script -to do that for you. So put them on a partiion which is readable by U-Boot. If +to do that for you. So put them on a partition which is readable by U-Boot. If you do not have that location yet, just use "-" to put the files into `../build` folder to be picked up later. diff --git a/simpleimage/README.md b/simpleimage/README.md index d35fa24e..05cccdb5 100644 --- a/simpleimage/README.md +++ b/simpleimage/README.md @@ -4,7 +4,10 @@ This script builds a bootable disk image usable to boot a Pine64 to Linux in aarch64 mode. ## Dependencies -`qemu-user-static` is needed for creating and configuring the rootfs image. Failure to have this package installed will most likely result in a `cp: cannot stat '/usr/bin/qemu-aarch64-static': No such file or directory` type error. +`qemu-user-static` is needed for creating and configuring the rootfs image. +Failure to have this package installed will most likely result in a +`cp: cannot stat '/usr/bin/qemu-aarch64-static': No such file or directory` +type error. ## Minimal base image diff --git a/simpleimage/make_simpleimage.sh b/simpleimage/make_simpleimage.sh index baba047d..e0ab1881 100755 --- a/simpleimage/make_simpleimage.sh +++ b/simpleimage/make_simpleimage.sh @@ -4,7 +4,7 @@ # # This script uses boot0 binary blob (as extracted from the Pine64 Android # image) together with a correctly prefixed U-Boot and A DOS partition table -# to create a bootable SDcard image for the Pine64. If a Kernel and DTB is +# to create a bootable SD card image for the Pine64. If a Kernel and DTB is # found in ../kernel, it is added as well. # # U-Boot tree: diff --git a/u-boot-postprocess/README.md b/u-boot-postprocess/README.md index c707360c..2b57969c 100644 --- a/u-boot-postprocess/README.md +++ b/u-boot-postprocess/README.md @@ -69,13 +69,16 @@ and extended with the ATF. In addition some blobs, and the device tree are required to create this U-Boot bootloader format whre provided in the `build-pine64-image/blobs` -directory). So have the ATF ready and compiled in `build-pine64-image/arm-trusted-firmware-pine64` and the Suxi pack tools compiled in `build-pine64-image/sunxi-pack-tools`. +directory). So have the ATF ready and compiled in +`build-pine64-image/arm-trusted-firmware-pine64` and the Suxi pack tools +compiled in `build-pine64-image/sunxi-pack-tools`. ```bash ./u-boot-postprocess.sh ``` -This creates `out/u-boot-with-dtb.bin` which is correctly prefixed, combined with ATF and FTD wich makes it acceptable for Allwinner's boot0. +This creates `out/u-boot-with-dtb.bin` which is correctly prefixed, combined +with ATF and FTD wich makes it acceptable for Allwinner's boot0. ## Next steps diff --git a/u-boot-postprocess/u-boot-postprocess.sh b/u-boot-postprocess/u-boot-postprocess.sh index 897610c4..9a81e55d 100755 --- a/u-boot-postprocess/u-boot-postprocess.sh +++ b/u-boot-postprocess/u-boot-postprocess.sh @@ -1,7 +1,7 @@ #!/bin/sh # # Simple script to create a U-Boot with all the additional parts which are -# required to be accepted by th A64 boot0. +# required to be accepted by the A64 boot0. # # This script requires build variants and tools from several other sources. # See the variable definitions below. When all files can be found, a U-Boot