Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

minor documentation improvements #75

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
12 changes: 7 additions & 5 deletions blobs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
3 changes: 2 additions & 1 deletion bootlogo/battery/README.md
Original file line number Diff line number Diff line change
@@ -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.
6 changes: 4 additions & 2 deletions kernel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.

Expand Down
5 changes: 4 additions & 1 deletion simpleimage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion simpleimage/make_simpleimage.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
7 changes: 5 additions & 2 deletions u-boot-postprocess/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion u-boot-postprocess/u-boot-postprocess.sh
Original file line number Diff line number Diff line change
@@ -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
Expand Down