x86: apl: Use devicetree for FSP-M configuration

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

diff --git a/doc/README.autoboot b/doc/README.autoboot
index 2042fe5c4063b95e791cbbd29744f85665782e10..5e9a5e1cf7fe09367c19517e36988a66a88df868 100644 (file)
--- a/doc/README.autoboot
+++ b/doc/README.autoboot
@@ -1,24 +1,8 @@
+SPDX-License-Identifier: GPL-2.0+
 /*
  * (C) Copyright 2001
  * Dave Ellis, SIXNET, dge@sixnetio.com
  *
- * See file CREDITS for list of people who contributed to this
- * project.
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License as
- * published by the Free Software Foundation; either version 2 of
- * the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.         See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
- * MA 02111-1307 USA
  */
 
 Using autoboot configuration options
@@ -90,16 +74,13 @@ What they do
        "bootretry" is >= 0.
 
   CONFIG_AUTOBOOT_KEYED
+  CONFIG_AUTOBOOT_KEYED_CTRLC
   CONFIG_AUTOBOOT_PROMPT
   CONFIG_AUTOBOOT_DELAY_STR
   CONFIG_AUTOBOOT_STOP_STR
-  CONFIG_AUTOBOOT_DELAY_STR2
-  CONFIG_AUTOBOOT_STOP_STR2
 
   "bootdelaykey"  environment variable
   "bootstopkey"          environment variable
-  "bootdelaykey2" environment variable
-  "bootstopkey2"  environment variable
 
        These options give more control over stopping autoboot. When
        they are used a specific character or string is required to
@@ -145,21 +126,37 @@ What they do
        character of a key string does not appear in the rest of the
        string.
 
-       Using the CONFIG_AUTOBOOT_DELAY_STR2 #define or the
-       "bootdelaykey2" environment variable and/or the
-       CONFIG_AUTOBOOT_STOP_STR2 #define or the "bootstopkey"
-       environment variable you can specify a second, alternate
-       string (which allows you to have two "password" strings).
+       The CONFIG_AUTOBOOT_KEYED_CTRLC #define allows for the boot
+       sequence to be interrupted by ctrl-c, in addition to the
+       "bootdelaykey" and "bootstopkey". Setting this variable
+       provides an escape sequence from the limited "password"
+       strings.
+
+  CONFIG_AUTOBOOT_ENCRYPTION
 
-  CONFIG_ZERO_BOOTDELAY_CHECK
+  "bootstopkeysha256"  environment variable
 
-       If this option is defined, you can stop the autoboot process
-       by hitting a key even in that case when "bootdelay" has been
-       set to 0. You can set "bootdelay" to a negative value to
-       prevent the check for console input.
+       - Hash value of the input which unlocks the device and
+         stops autoboot.
+
+       This option allows a string to be entered into U-Boot to stop the
+       autoboot. The string itself is hashed and compared against the hash
+       in the environment variable 'bootstopkeysha256'. If it matches then
+       boot stops and a command-line prompt is presented.
+
+       This provides a way to ship a secure production device which can also
+       be accessed at the U-Boot command line.
 
   CONFIG_RESET_TO_RETRY
 
        (Only effective when CONFIG_BOOT_RETRY_TIME is also set)
        After the countdown timed out, the board will be reset to restart
        again.
+
+  CONFIG_AUTOBOOT_USE_MENUKEY
+  CONFIG_AUTOBOOT_MENUKEY
+
+       If this key is pressed to stop autoboot, then the commands in the
+       environment variable 'menucmd' will be executed before boot starts.
+       For example, 33 means "!" in ASCII, so pressing ! at boot would take
+       this action.