fit: Support compat string property in configuration node
[oweals/u-boot.git] / doc / uImage.FIT / command_syntax_extensions.txt
index b8b50ffae992c5e7a8d83497204050d59dffef0e..6a99089ab5575d08284257f08830cb753377463d 100644 (file)
@@ -23,25 +23,25 @@ kernel is passed a pointer to the FDT. The boot method is indicated for each
 scenario.
 
 
-1.  bootm               boot image at the current address, equivalent to 2,3,8
+1.  bootm              boot image at the current address, equivalent to 2,3,8
 
 Old uImage:
-2.  bootm <addr1>                   /* single image at <addr1> */
-3.  bootm <addr1>                   /* multi-image at <addr1>  */
-4.  bootm <addr1> -                 /* multi-image at <addr1>  */
-5.  bootm <addr1> <addr2>           /* single image at <addr1> */
+2.  bootm <addr1>                  /* single image at <addr1> */
+3.  bootm <addr1>                  /* multi-image at <addr1>  */
+4.  bootm <addr1> -                /* multi-image at <addr1>  */
+5.  bootm <addr1> <addr2>          /* single image at <addr1> */
 6.  bootm <addr1> <addr2> <addr3>   /* single image at <addr1> */
-7.  bootm <addr1> -       <addr3>   /* single image at <addr1> */
+7.  bootm <addr1> -      <addr3>   /* single image at <addr1> */
 
 New uImage:
 8.  bootm <addr1>
 9.  bootm [<addr1>]:<subimg1>
-10. bootm [<addr1>]#<conf>
+10. bootm [<addr1>]#<conf>[#<extra-conf[#...]]
 11. bootm [<addr1>]:<subimg1> [<addr2>]:<subimg2>
 12. bootm [<addr1>]:<subimg1> [<addr2>]:<subimg2> [<addr3>]:<subimg3>
 13. bootm [<addr1>]:<subimg1> [<addr2>]:<subimg2> <addr3>
-14. bootm [<addr1>]:<subimg1> -                   [<addr3>]:<subimg3>
-15. bootm [<addr1>]:<subimg1> -                   <addr3>
+14. bootm [<addr1>]:<subimg1> -                          [<addr3>]:<subimg3>
+15. bootm [<addr1>]:<subimg1> -                          <addr3>
 
 
 Ad. 1. This is equivalent to cases 2,3,8, depending on the type of image at
@@ -57,11 +57,11 @@ with the ramdisk from the image.
 - boot method: depends on the number of components at <addr1>, and on whether
   U-Boot is compiled with OF support:
 
-                    |          2 components |          3 components |
-                    |      (kernel, initrd) | (kernel, initrd, fdt) |
+                   |          2 components |          3 components |
+                   |      (kernel, initrd) | (kernel, initrd, fdt) |
 ---------------------------------------------------------------------
-#ifdef CONFIG_OF_*  |               non-FDT |                   FDT |
-#ifndef CONFIG_OF_* |               non-FDT |               non-FDT |
+#ifdef CONFIG_OF_*  |              non-FDT |                   FDT |
+#ifndef CONFIG_OF_* |              non-FDT |               non-FDT |
 
 Ad. 4. Similar to case 3, but the kernel is booted without initrd.  Second
 component of the multi-image is irrelevant (it can be a dummy, 1-byte file).
@@ -129,30 +129,40 @@ following syntax:
 - new uImage configuration specification
 <addr>#<configuration unit_name>
 
+- new uImage configuration specification with extra configuration components
+<addr>#<configuration unit_name>[#<extra configuration unit_name>[#..]]
+
+The extra configuration currently is supported only for additional device tree
+overlays to apply on the base device tree supplied by the first configuration
+unit.
 
 Examples:
 
-- boot kernel "kernel@1" stored in a new uImage located at 200000:
-bootm 200000:kernel@1
+- boot kernel "kernel-1" stored in a new uImage located at 200000:
+bootm 200000:kernel-1
+
+- boot configuration "cfg-1" from a new uImage located at 200000:
+bootm 200000#cfg-1
 
-- boot configuration "cfg@1" from a new uImage located at 200000:
-bootm 200000#cfg@1
+- boot configuration "cfg-1" with extra "cfg-2" from a new uImage located
+  at 200000:
+bootm 200000#cfg-1#cfg-2
 
-- boot "kernel@1" from a new uImage at 200000 with initrd "ramdisk@2" found in
+- boot "kernel-1" from a new uImage at 200000 with initrd "ramdisk-2" found in
   some other new uImage stored at address 800000:
-bootm 200000:kernel@1 800000:ramdisk@2
+bootm 200000:kernel-1 800000:ramdisk-2
 
-- boot "kernel@2" from a new uImage at 200000, with initrd "ramdisk@1" and FDT
-  "fdt@1", both stored in some other new uImage located at 800000:
-bootm 200000:kernel@1 800000:ramdisk@1 800000:fdt@1
+- boot "kernel-2" from a new uImage at 200000, with initrd "ramdisk-1" and FDT
+  "fdt-1", both stored in some other new uImage located at 800000:
+bootm 200000:kernel-1 800000:ramdisk-1 800000:fdt-1
 
-- boot kernel "kernel@2" with initrd "ramdisk@2", both stored in a new uImage
+- boot kernel "kernel-2" with initrd "ramdisk-2", both stored in a new uImage
   at address 200000, with a raw FDT blob stored at address 600000:
-bootm 200000:kernel@2 200000:ramdisk@2 600000
+bootm 200000:kernel-2 200000:ramdisk-2 600000
 
-- boot kernel "kernel@2" from new uImage at 200000 with FDT "fdt@1" from the
+- boot kernel "kernel-2" from new uImage at 200000 with FDT "fdt-1" from the
   same new uImage:
-bootm 200000:kernel@2 - 200000:fdt@1
+bootm 200000:kernel-2 - 200000:fdt-1
 
 
 Note on current image address
@@ -160,7 +170,7 @@ Note on current image address
 
 When bootm is called without arguments, the image at current image address is
 booted. The current image address is the address set most recently by a load
-command, etc, and is by default equal to CFG_LOAD_ADDR. For example, consider
+command, etc, and is by default equal to CONFIG_SYS_LOAD_ADDR. For example, consider
 the following commands:
 
 tftp 200000 /tftpboot/kernel
@@ -170,22 +180,22 @@ bootm 200000
 
 In case of the new uImage argument syntax, the address portion of any argument
 can be omitted. If <addr3> is omitted, then it is assumed that image at
-<addr2> should be used. Similarly, when <addr2> is omitted, is is assumed that
+<addr2> should be used. Similarly, when <addr2> is omitted, it is assumed that
 image at <addr1> should be used. If <addr1> is omitted, it is assumed that the
 current image address is to be used. For example, consider the following
 commands:
 
 tftp 200000 /tftpboot/uImage
-bootm :kernel@1
+bootm :kernel-1
 Last command is equivalent to:
-bootm 200000:kernel@1
+bootm 200000:kernel-1
 
 tftp 200000 /tftpboot/uImage
-bootm 400000:kernel@1 :ramdisk@1
+bootm 400000:kernel-1 :ramdisk-1
 Last command is equivalent to:
-bootm 400000:kernel@1 400000:ramdisk@1
+bootm 400000:kernel-1 400000:ramdisk-1
 
 tftp 200000 /tftpboot/uImage
-bootm :kernel@1 400000:ramdisk@1 :fdt@1
+bootm :kernel-1 400000:ramdisk-1 :fdt-1
 Last command is equivalent to:
-bootm 200000:kernel@1 400000:ramdisk@1 400000:fdt@1
+bootm 200000:kernel-1 400000:ramdisk-1 400000:fdt-1