[U-Boot] [PATCH 2/5] sunxi: docs: Unify the formatting style and add some paragraph breaks

Tue Oct 23 17:20:29 UTC 2018

Signed-off-by: Priit Laes <plaes at plaes.org>
---
 board/sunxi/README.nand    | 18 +++++++++---------
 board/sunxi/README.sunxi64 | 23 ++++++++++++++++-------
 2 files changed, 25 insertions(+), 16 deletions(-)

diff --git a/board/sunxi/README.nand b/board/sunxi/README.nand
index a5d4ff0..77a8c7d 100644
--- a/board/sunxi/README.nand
+++ b/board/sunxi/README.nand
@@ -29,26 +29,26 @@ board is in FEL mode, you'll need the sunxi-tools that you can find at
 this repository: https://github.com/linux-sunxi/sunxi-tools
 
 Then, you'll need to first load an SPL to initialise the RAM:
-sunxi-fel spl spl/sunxi-spl.bin
+$ sunxi-fel spl spl/sunxi-spl.bin
 
 Load the binaries we'll flash into RAM:
-sunxi-fel write 0x4a000000 u-boot-dtb.bin
-sunxi-fel write 0x43000000 spl/sunxi-spl-with-ecc.bin
+$ sunxi-fel write 0x4a000000 u-boot-dtb.bin
+$ sunxi-fel write 0x43000000 spl/sunxi-spl-with-ecc.bin
 
 And execute U-Boot
-sunxi-fel exe 0x4a000000
+$ sunxi-fel exe 0x4a000000
 
 On your board, you'll now have all the needed binaries into RAM, so
 you only need to erase the NAND...
 
-nand erase.chip
+$ nand erase.chip
 
 Then write the SPL and its backup:
 
-nand write.raw.noverify 0x43000000 0 40
-nand write.raw.noverify 0x43000000 0x400000 40
+$ nand write.raw.noverify 0x43000000 0 40
+$ nand write.raw.noverify 0x43000000 0x400000 40
 
 And finally write the U-Boot binary:
-nand write 0x4a000000 0x800000 0xc0000
+$ nand write 0x4a000000 0x800000 0xc0000
 
-You can now reboot and enjoy your NAND.
\ No newline at end of file
+You can now reboot and enjoy your NAND.
diff --git a/board/sunxi/README.sunxi64 b/board/sunxi/README.sunxi64
index bba2e01..63cd8bb 100644
--- a/board/sunxi/README.sunxi64
+++ b/board/sunxi/README.sunxi64
@@ -32,9 +32,10 @@ to build it first.
 Checkout the "allwinner" branch from the github repository [1] and build it:
 $ export CROSS_COMPILE=aarch64-linux-gnu-
 $ make PLAT=sun50iw1p1 DEBUG=1 bl31
+
 The resulting binary is build/sun50iw1p1/debug/bl31.bin. Either put the
 location of this file into the BL31 environment variable or copy this to
-the root of your U-Boot build directory (or create a symbolic link).
+the root of your U-Boot build directory (or create a symbolic link):
 $ export BL31=/src/arm-trusted-firmware/build/sun50iw1p1/debug/bl31.bin
   (adjust the actual path accordingly)
 
@@ -48,7 +49,8 @@ binaries in the firmware repository[3], purely for convenience reasons.
 ------------
 Both U-Boot proper and the SPL are using the 64-bit mode. As the boot ROM
 enters the SPL still in AArch32 secure SVC mode, there is some shim code to
-enter AArch64 very early. The rest of the SPL runs in AArch64 EL3.
+enter AArch64 very early. The rest of the SPL runs in AArch64 EL3 mode.
+
 U-Boot proper runs in EL2 and can load any AArch64 code (using the "go"
 command), EFI applications (with "bootefi") or arm64 Linux kernel images
 (often named "Image"), using the "booti" command.
@@ -95,15 +97,15 @@ feature is disabled in the configuration at the moment.
 microSD card
 ------------
 Transfer the SPL and the U-Boot FIT image directly to an uSD card:
-# dd if=spl/sunxi-spl.bin of=/dev/sdx bs=8k seek=1
-# dd if=u-boot.itb of=/dev/sdx bs=8k seek=5
-# sync
+$ dd if=spl/sunxi-spl.bin of=/dev/sdx bs=8k seek=1
+$ dd if=u-boot.itb of=/dev/sdx bs=8k seek=5
+$ sync
 (replace /dev/sdx with you SD card device file name, which could be
 /dev/mmcblk[x] as well).
 
 Alternatively you can use the SPL and the U-Boot FIT image combined into a
 single file and transfer that instead:
-# dd if=u-boot-sunxi-with-spl.bin of=/dev/sdx bs=8k seek=1
+$ dd if=u-boot-sunxi-with-spl.bin of=/dev/sdx bs=8k seek=1
 
 You can partition the microSD card, but leave the first MB unallocated (most
 partitioning tools will do this anyway).
@@ -118,13 +120,17 @@ Now connect either an "A to A" USB cable to the upper USB port on the Pine64
 or get an adaptor and use a regular A-microB cable connected to it. Other
 boards often have a proper micro-B USB socket connected to the USB OTB port.
 Remove a microSD card from the slot and power on the board.
+
 On your host computer download and build the sunxi-tools package[2], then
 use "sunxi-fel" to access the board:
 $ ./sunxi-fel ver -v -p
+
 This should give you an output starting with: AWUSBFEX soc=00001689(A64) ...
+
 Now use the sunxi-fel tool to write to the NOR flash:
 $ ./sunxi-fel spiflash-write 0 spl/sunxi-spl.bin
 $ ./sunxi-fel spiflash-write 32768 u-boot.itb
+
 Now boot the board without an SD card inserted and you should see the
 U-Boot prompt on the serial console.
 
@@ -142,10 +148,11 @@ by this method.
 The boot0 binary is a 32 KByte blob and contained in the official Pine64 images
 distributed by Pine64 or Allwinner. It can be easily extracted from a micro
 SD card or an image file:
-# dd if=/dev/sd<x> of=boot0.bin bs=8k skip=1 count=4
+$ dd if=/dev/sd<x> of=boot0.bin bs=8k skip=1 count=4
 where /dev/sd<x> is the device name of the uSD card or the name of the image
 file. Apparently Allwinner allows re-distribution of this proprietary code
 "as-is".
+
 This boot0 blob takes care of DRAM initialisation and loads the remaining
 firmware parts, then switches the core into AArch64 mode.
 The original boot0 code looks for U-Boot at a certain place on an uSD card
@@ -159,8 +166,10 @@ places on the uSD card and works around unused, but mandatory parts by using
 trampoline code. See the output of "boot0img -h" for more information.
 boot0img can also patch boot0 to avoid loading U-Boot from 19MB, instead
 fetching it from just behind the boot0 binary (-B option).
+
 $ ./boot0img -o firmware.img -B boot0.img -u u-boot-dtb.bin -e -s bl31.bin \
 -a 0x44008 -d trampoline64:0x44000
+
 Then write this image to a microSD card, replacing /dev/sdx with the right
 device file (see above):
 $ dd if=firmware.img of=/dev/sdx bs=8k seek=1
-- 
git-series 0.9.1
