doc: Add top-level description about U-Boot documentation

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

diff --git a/doc/README.uniphier b/doc/README.uniphier
index 0fa3248fae782ee5c303e538c78a8cfd25858678..badfacd66aa5cfbe786a175d35ed1ff03d2edf36 100644 (file)
--- a/doc/README.uniphier
+++ b/doc/README.uniphier
@@ -142,7 +142,7 @@ The following is an example for a simple usecase:
        #address-cells = <1>;
 
        images {
-               kernel@0 {
+               kernel {
                        description = "linux";
                        data = /incbin/("PATH/TO/YOUR/LINUX/DIR/arch/arm64/boot/Image.gz");
                        type = "kernel";
@@ -151,44 +151,44 @@ The following is an example for a simple usecase:
                        compression = "gzip";
                        load = <0x82080000>;
                        entry = <0x82080000>;
-                       hash@0 {
+                       hash-1 {
                                algo = "sha256";
                        };
                };
 
-               fdt@0 {
+               fdt-1 {
                        description = "fdt";
                        data = /incbin/("PATH/TO/YOUR/LINUX/DIR/arch/arm64/boot/dts/socionext/uniphier-ld20-ref.dtb");
                        type = "flat_dt";
                        arch = "arm64";
                        compression = "none";
-                       hash@0 {
+                       hash-1 {
                                algo = "sha256";
                        };
                };
 
-               ramdisk@0 {
+               ramdisk {
                        description = "ramdisk";
                        data = /incbin/("PATH/TO/YOUR/ROOTFS/DIR/rootfs.cpio");
                        type = "ramdisk";
                        arch = "arm64";
                        os = "linux";
                        compression = "none";
-                       hash@0 {
+                       hash-1 {
                                algo = "sha256";
                        };
                };
        };
 
        configurations {
-               default = "config@0";
+               default = "config-1";
 
-               config@0 {
+               config-1 {
                        description = "Configuration0";
-                       kernel = "kernel@0";
-                       fdt = "fdt@0";
-                       ramdisk = "ramdisk@0";
-                       signature@0 {
+                       kernel = "kernel";
+                       fdt = "fdt-1";
+                       ramdisk = "ramdisk";
+                       signature-1 {
                                algo = "sha256,rsa2048";
                                key-name-hint = "dev";
                                sign-images = "kernel", "fdt", "ramdisk";
@@ -268,9 +268,9 @@ If it is successful, you will see messages like follows:
 
 ---------------------------------------->8----------------------------------------
 ## Loading kernel from FIT Image at 84100000 ...
-   Using 'config@0' configuration
+   Using 'config-1' configuration
    Verifying Hash Integrity ... sha256,rsa2048:dev+ OK
-   Trying 'kernel@0' kernel subimage
+   Trying 'kernel' kernel subimage
      Description:  linux
      Created:      2017-10-20  14:32:29 UTC
      Type:         Kernel Image
@@ -285,8 +285,8 @@ If it is successful, you will see messages like follows:
      Hash value:   82a37b7f11ae55f4e07aa25bf77e4067cb9dc1014d52d6cd4d588f92eee3aaad
    Verifying Hash Integrity ... sha256+ OK
 ## Loading ramdisk from FIT Image at 84100000 ...
-   Using 'config@0' configuration
-   Trying 'ramdisk@0' ramdisk subimage
+   Using 'config-1' configuration
+   Trying 'ramdisk' ramdisk subimage
      Description:  ramdisk
      Created:      2017-10-20  14:32:29 UTC
      Type:         RAMDisk Image
@@ -301,8 +301,8 @@ If it is successful, you will see messages like follows:
      Hash value:   44980a2874154a2e31ed59222c9f8ea968867637f35c81e4107a984de7014deb
    Verifying Hash Integrity ... sha256+ OK
 ## Loading fdt from FIT Image at 84100000 ...
-   Using 'config@0' configuration
-   Trying 'fdt@0' fdt subimage
+   Using 'config-1' configuration
+   Trying 'fdt-1' fdt subimage
      Description:  fdt
      Created:      2017-10-20  14:32:29 UTC
      Type:         Flat Device Tree
@@ -332,6 +332,61 @@ for kernel, DTB, and Init ramdisk.
 If they are not displayed, the Verified Boot is not working.
 
 
+Deployment for Distro Boot
+--------------------------
+
+UniPhier SoC family boot the kernel in a generic manner as described in
+doc/README.distro .
+
+To boot the kernel, you need to deploy necesssary components to a file
+system on one of your block devices (eMMC, NAND, USB drive, etc.).
+
+The components depend on the kernel image format.
+
+[1] Bare images
+
+  - kernel
+  - init ramdisk
+  - device tree blob
+  - boot configuration file (extlinux.conf)
+
+Here is an exmple of the configuration file.
+
+-------------------->8--------------------
+menu title UniPhier Boot Options.
+
+timeout 50
+default UniPhier
+
+label UniPhier
+      kernel ../Image
+      initrd ../rootfs.cpio.gz
+      fdtdir ..
+-------------------->8--------------------
+
+Then, write 'Image', 'rootfs.cpio.gz', 'uniphier-ld20-ref.dtb' (DTB depends on
+your board), and 'extlinux/extlinux.conf' to the file system.
+
+[2] FIT
+
+  - FIT blob
+  - boot configuration file (extlinux.conf)
+
+-------------------->8--------------------
+menu title UniPhier Boot Options.
+
+timeout 50
+default UniPhier
+
+label UniPhier
+      kernel ../fitImage
+-------------------->8--------------------
+
+Since the init ramdisk and DTB are contained in the FIT blob,
+you do not need to describe them in the configuration file.
+Write 'fitImage' and 'extlinux/extlinux.conf' to the file system.
+
+
 UniPhier specific commands
 --------------------------