azure: Update for python3 and current pytest

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

diff --git a/doc/README.falcon b/doc/README.falcon
index bccf6c95c869388ae6824a50ccb25e378d925104..713d7063a1d8cb0e8642f5540ac0e52d87ec1e58 100644 (file)
--- a/doc/README.falcon
+++ b/doc/README.falcon
@@ -31,9 +31,10 @@ informed to load it before running the kernel.
 To boot the kernel, these steps under a Falcon-aware U-Boot are required:
 
 1. Boot the board into U-Boot.
-Use the "spl export" command to generate the kernel parameters area or the DT.
-U-Boot runs as when it boots the kernel, but stops before passing the control
-to the kernel.
+After loading the desired legacy-format kernel image into memory (and DT as
+well, if used), use the "spl export" command to generate the kernel parameters
+area or the DT.  U-Boot runs as when it boots the kernel, but stops before
+passing the control to the kernel.
 
 2. Save the prepared snapshot into persistent media.
 The address where to save it must be configured into board configuration
@@ -66,6 +67,8 @@ CONFIG_SYS_NAND_SPL_KERNEL_OFFS       Offset in NAND where the kernel is stored
 
 CONFIG_CMD_SPL_NAND_OFS        Offset in NAND where the parameters area was saved.
 
+CONFIG_CMD_SPL_NOR_OFS Offset in NOR where the parameters area was saved.
+
 CONFIG_CMD_SPL_WRITE_SIZE      Size of the parameters area to be copied
 
 CONFIG_SPL_OS_BOOT     Activate Falcon Mode.
@@ -89,6 +92,10 @@ mode.  In this case the following variables may be supported:
 boot_os :              Set to yes/Yes/true/True/1 to enable booting to OS,
                        any other value to fall back to U-Boot (including
                        unset)
+falcon_args_file :     Filename to load as the 'args' portion of falcon mode
+                       rather than the hard-coded value.
+falcon_image_file :    Filename to load as the OS image portion of falcon
+                       mode rather than the hard-coded value.
 
 Using spl command
 -----------------
@@ -113,7 +120,12 @@ after each run of 'spl export'. Unfortunately the position of temporary
 storage can not be predicted nor provided at commandline, it depends
 highly on your system setup and your provided data (ATAGS or FDT).
 However at the end of an succesful 'spl export' run it will print the
-RAM address of temporary storage.
+RAM address of temporary storage. The RAM address of FDT will also be
+set in the environment variable 'fdtargsaddr', the new length of the
+prepared FDT will be set in the environment variable 'fdtargslen'.
+These environment variables can be used in scripts for writing updated
+FDT to persistent storage.
+
 Now the user have to save the generated BLOB from that printed address
 to the pre-defined address in persistent storage
 (CONFIG_CMD_SPL_NAND_OFS in case of NAND).