doc: rockchip: Document eMMC program steps

[oweals/u-boot.git] / doc / README.odroid

diff --git a/doc/README.odroid b/doc/README.odroid
index 25b962b9f1373bf6947116c6b9a3566cf496702b..bc77ae317554abb4f01b05c866b711d61ec794a7 100644 (file)
--- a/doc/README.odroid
+++ b/doc/README.odroid
@@ -1,31 +1,44 @@
- U-boot for Odroid X2/U3
+ U-Boot for Odroid X2/U3/XU3/XU4/HC1

 ========================
 
 1. Summary
 ==========
 ========================
 
 1. Summary
 ==========

-This is a quick instruction for setup Odroid boards based on Exynos4412.
-Board config: odroid_config
+This is a quick instruction for setup Odroid boards.
+Board config: odroid_config for X2/U3
+Board config: odroid-xu3_config for XU3/XU4/HC1

 
 2. Supported devices
 ====================
 
 2. Supported devices
 ====================

-This U-BOOT config can be used on two boards:
+This U-BOOT config can be used on three boards:

 - Odroid U3
 - Odroid X2
 with CPU Exynos 4412 rev 2.0 and 2GB of RAM
 - Odroid U3
 - Odroid X2
 with CPU Exynos 4412 rev 2.0 and 2GB of RAM

+- Odroid XU3
+- Odroid XU4
+- Odroid HC1
+with CPU Exynos5422 and 2GB of RAM

 
 3. Boot sequence
 ================
 iROM->BL1->(BL2 + TrustZone)->U-BOOT
 
 
 3. Boot sequence
 ================
 iROM->BL1->(BL2 + TrustZone)->U-BOOT
 

-This version of U-BOOT doesn't implement SPL but it is required(BL2)
-and can be found in "boot.tar.gz" from here:
+This version of U-BOOT doesn't implement SPL. So, BL1, BL2, and TrustZone
+binaries are needed to boot up.
+
+<< X2/U3 >>
+It can be found in "boot.tar.gz" from here:

 http://dev.odroid.com/projects/4412boot/wiki/FrontPage?action=download&value=boot.tar.gz
 or here:
 http://odroid.in/guides/ubuntu-lfs/boot.tar.gz
 
 http://dev.odroid.com/projects/4412boot/wiki/FrontPage?action=download&value=boot.tar.gz
 or here:
 http://odroid.in/guides/ubuntu-lfs/boot.tar.gz
 

+<< XU3/XU4 >>
+It can be downloaded from:
+https://github.com/hardkernel/u-boot/tree/odroidxu3-v2012.07/sd_fuse/hardkernel_1mb_uboot
+
+

 4. Boot media layout
 ====================
 4. Boot media layout
 ====================

-The table below shows SD/eMMC cards layout for U-boot.
+The table below shows SD/eMMC cards layout for U-Boot.

 The block offset is starting from 0 and the block size is 512B.
  -------------------------------------
 |  Binary   | Block offset| part type |
 The block offset is starting from 0 and the block size is 512B.
  -------------------------------------
 |  Binary   | Block offset| part type |


@@ -33,40 +46,42 @@ The block offset is starting from 0 and the block size is 512B.
  -------------------------------------
 | Bl1       | 1    | 0    |  1 (boot) |
 | Bl2       | 31   | 30   |  1 (boot) |
  -------------------------------------
 | Bl1       | 1    | 0    |  1 (boot) |
 | Bl2       | 31   | 30   |  1 (boot) |

-| U-boot    | 63   | 62   |  1 (boot) |
+| U-Boot    | 63   | 62   |  1 (boot) |

 | Tzsw      | 2111 | 2110 |  1 (boot) |
 | Tzsw      | 2111 | 2110 |  1 (boot) |

-| Uboot Env | 2500 | 2500 |  0 (user) |
+| Uboot Env | 2560 | 2560 |  0 (user) |

  -------------------------------------
 
 5. Prepare the SD boot card - with SD card reader
 =================================================
 To prepare bootable media you need boot binaries provided by hardkernel.
  -------------------------------------
 
 5. Prepare the SD boot card - with SD card reader
 =================================================
 To prepare bootable media you need boot binaries provided by hardkernel.

-File "boot.tar.gz" (link in point 3.) contains:
-- E4412_S.bl1.HardKernel.bin
-- E4412_S.tzsw.signed.bin
-- bl2.signed.bin
+From the downloaded files, You can find:
+- bl1.bin
+- tzsw.bin
+- bl2.bin

 - sd_fusing.sh
 - u-boot.bin
 - sd_fusing.sh
 - u-boot.bin

+(The file names can be slightly different, but you can distinguish what they are
+without problem)

 
 This is all you need to boot this board. But if you want to use your custom
 
 This is all you need to boot this board. But if you want to use your custom

-u-boot then you need to change u-boot.bin with your own u-boot binary*
+U-Boot then you need to change u-boot.bin with your own U-Boot binary*

 and run the script "sd_fusing.sh" - this script is valid only for SD card.
 
 *note:
 and run the script "sd_fusing.sh" - this script is valid only for SD card.
 
 *note:

-The proper binary file of current U-boot is u-boot-dtb.bin.
+The proper binary file of current U-Boot is u-boot-dtb.bin.

 
 quick steps for Linux:
 
 quick steps for Linux:

-- extract boot.tar.gz
+- Download all files from the link at point 3 and extract it if needed.

 - put any SD card into the SD reader
 - check the device with "dmesg"
 - run ./sd_fusing.sh /dev/sdX - where X is SD card device (but not a partition)
 - put any SD card into the SD reader
 - check the device with "dmesg"
 - run ./sd_fusing.sh /dev/sdX - where X is SD card device (but not a partition)

-Check if Hardkernel U-boot is booting, and next do the same with your U-boot.
+Check if Hardkernel U-Boot is booting, and next do the same with your U-Boot.

 
 6. Prepare the eMMC boot card
    with a eMMC card reader (boot from eMMC card slot)
 =====================================================
 To boot the device from the eMMC slot you should use a special card reader
 
 6. Prepare the eMMC boot card
    with a eMMC card reader (boot from eMMC card slot)
 =====================================================
 To boot the device from the eMMC slot you should use a special card reader

-which supports eMMC partiion switch. All of the boot binaries are stored
+which supports eMMC partition switch. All of the boot binaries are stored

 on the eMMC boot partition which is normally hidden.
 
 The "sd_fusing.sh" script can be used after updating offsets of binaries
 on the eMMC boot partition which is normally hidden.
 
 The "sd_fusing.sh" script can be used after updating offsets of binaries


@@ -79,19 +94,19 @@ eMMC partition - its size is usually very small, about 1-4 MiB.
 If you have an eMMC->microSD adapter you can prepare the card as in point 5.
 But then the device can boot only from the SD card slot.
 
 If you have an eMMC->microSD adapter you can prepare the card as in point 5.
 But then the device can boot only from the SD card slot.
 

-8. Prepare the boot media using Hardkernel U-boot
+8. Prepare the boot media using Hardkernel U-Boot

 =================================================
 =================================================

-You can update the U-boot to the custom one if you have an working bootloader
-delivered with the board on a eMMC/SD card. Then follow the steps:
+You can update the U-Boot to the custom one if you have a working bootloader
+delivered with the board on the eMMC/SD card. Then follow the steps:

 - install the android fastboot tool
 - connect a micro usb cable to the board
 - install the android fastboot tool
 - connect a micro usb cable to the board

-- on the U-boot prompt, run command: fastboot (as a root)
+- on the U-Boot prompt, run command: fastboot (as a root)

 - on the host, run command: "fastboot flash bootloader u-boot-dtb.bin"
 - on the host, run command: "fastboot flash bootloader u-boot-dtb.bin"

-- the custom U-boot should start after the board resets.
+- the custom U-Boot should start after the board resets.

 
 9. Partition layout
 ====================
 
 9. Partition layout
 ====================

-Default U-boot environment is setup for fixed partiion layout.
+Default U-Boot environment is setup for fixed partition layout.

 
 Partition table: MSDOS. Disk layout and files as listed in the table below.
  ----- ------ ------ ------ -------- ---------------------------------
 
 Partition table: MSDOS. Disk layout and files as listed in the table below.
  ----- ------ ------ ------ -------- ---------------------------------


@@ -106,6 +121,10 @@ Partition table: MSDOS. Disk layout and files as listed in the table below.
 Supported fdt files are:
 - exynos4412-odroidx2.dtb
 - exynos4412-odroidu3.dtb
 Supported fdt files are:
 - exynos4412-odroidx2.dtb
 - exynos4412-odroidu3.dtb

+- exynos5422-odroidxu3.dtb
+- exynos5422-odroidxu3-lite.dtb
+- exynos5422-odroidxu4.dtb
+- exynos5422-odroidhc1.dtb

 
 Supported kernel files are:
 - Image.itb
 
 Supported kernel files are:
 - Image.itb


@@ -144,6 +163,7 @@ And the boot sequence is:
 
 11. USB host support
 ====================
 
 11. USB host support
 ====================

+NOTE: This section is only for Odroid X2/U3.

 
 The ethernet can be accessed after starting the USB subsystem in U-Boot.
 The adapter does not come with a preconfigured MAC address, and hence it needs
 
 The ethernet can be accessed after starting the USB subsystem in U-Boot.
 The adapter does not come with a preconfigured MAC address, and hence it needs