Merge branch 'u-boot-samsung/master' into 'u-boot-arm/master'

[people/ms/u-boot.git] / doc / README.falcon

diff --git a/doc/README.falcon b/doc/README.falcon
index 6357b1e593377112deba187f6a0936498bb19f7d..82a254b2e2565357a97a3479246023bbc02e3dbb 100644 (file)
--- a/doc/README.falcon
+++ b/doc/README.falcon
@@ -80,6 +80,19 @@ spl_start_uboot() : required
                Returns "0" if SPL should start the kernel, "1" if U-Boot
                must be started.
 
+Environment variables
+---------------------
+
+A board may chose to look at the environment for decisions about falcon
+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
 -----------------