]> git.ipfire.org Git - people/ms/u-boot.git/blobdiff - README
cmd/bdinfo: extract print_std_bdinfo
[people/ms/u-boot.git] / README
diff --git a/README b/README
index 864c7cccc3b7a7182612680eba3316889460008b..30d7ee3970cd096d5e713084eb3b3bc4ef69b779 100644 (file)
--- a/README
+++ b/README
@@ -460,7 +460,7 @@ The following options need to be configured:
 
                CONFIG_SYS_CPC_REINIT_F
                This CONFIG is defined when the CPC is configured as SRAM at the
-               time of U-boot entry and is required to be re-initialized.
+               time of U-Boot entry and is required to be re-initialized.
 
                CONFIG_DEEP_SLEEP
                Indicates this SoC supports deep sleep feature. If deep sleep is
@@ -511,7 +511,7 @@ The following options need to be configured:
                implemetation.
 
                CONFIG_SYS_FSL_DDR2
-               Board config to use DDR2. It can be eanbeld for SoCs with
+               Board config to use DDR2. It can be enabled for SoCs with
                Freescale DDR2 or DDR3 controllers, depending on the board
                implementation.
 
@@ -840,6 +840,9 @@ The following options need to be configured:
                        CONFIG_CONSOLE_EXTRA_INFO
                                                additional board info beside
                                                the logo
+                       CONFIG_HIDE_LOGO_VERSION
+                                               do not display bootloader
+                                               version string
 
                When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
                a limited number of ANSI escape sequences (cursor control,
@@ -890,23 +893,6 @@ The following options need to be configured:
                'Sane' compilers will generate smaller code if
                CONFIG_PRE_CON_BUF_SZ is a power of 2
 
-- Boot Delay:  CONFIG_BOOTDELAY - in seconds
-               Delay before automatically booting the default image;
-               set to -1 to disable autoboot.
-               set to -2 to autoboot with no delay and not check for abort
-               (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
-
-               See doc/README.autoboot for these options that
-               work with CONFIG_BOOTDELAY. None are required.
-               CONFIG_BOOT_RETRY_TIME
-               CONFIG_BOOT_RETRY_MIN
-               CONFIG_AUTOBOOT_KEYED
-               CONFIG_AUTOBOOT_PROMPT
-               CONFIG_AUTOBOOT_DELAY_STR
-               CONFIG_AUTOBOOT_STOP_STR
-               CONFIG_ZERO_BOOTDELAY_CHECK
-               CONFIG_RESET_TO_RETRY
-
 - Autoboot Command:
                CONFIG_BOOTCOMMAND
                Only needed when CONFIG_BOOTDELAY is enabled;
@@ -1003,6 +989,7 @@ The following options need to be configured:
                CONFIG_CMD_ECHO           echo arguments
                CONFIG_CMD_EDITENV        edit env variable
                CONFIG_CMD_EEPROM       * EEPROM read/write support
+               CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands
                CONFIG_CMD_ELF          * bootelf, bootvx
                CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
                CONFIG_CMD_ENV_FLAGS    * display details about env flags
@@ -1023,7 +1010,6 @@ The following options need to be configured:
                CONFIG_CMD_GO           * the 'go' command (exec code)
                CONFIG_CMD_GREPENV      * search environment
                CONFIG_CMD_HASH         * calculate hash / digest
-               CONFIG_CMD_HWFLOW       * RTS/CTS hw flow control
                CONFIG_CMD_I2C          * I2C serial bus support
                CONFIG_CMD_IDE          * IDE harddisk support
                CONFIG_CMD_IMI            iminfo
@@ -1067,7 +1053,7 @@ The following options need to be configured:
                CONFIG_CMD_RUN            run command in env variable
                CONFIG_CMD_SANDBOX      * sb command to access sandbox features
                CONFIG_CMD_SAVES        * save S record dump
-               CONFIG_CMD_SCSI         * SCSI Support
+               CONFIG_SCSI             * SCSI Support
                CONFIG_CMD_SDRAM        * print SDRAM configuration information
                                          (requires CONFIG_CMD_I2C)
                CONFIG_CMD_SETGETDCR      Support for DCR Register access
@@ -1109,6 +1095,14 @@ The following options need to be configured:
 
                XXX - this list needs to get updated!
 
+- Removal of commands
+               If no commands are needed to boot, you can disable
+               CONFIG_CMDLINE to remove them. In this case, the command line
+               will not be available, and when U-Boot wants to execute the
+               boot command (on start-up) it will call board_run_command()
+               instead. This can reduce image size significantly for very
+               simple boot procedures.
+
 - Regular expression support:
                CONFIG_REGEX
                If this variable is defined, U-Boot is linked against
@@ -1247,7 +1241,7 @@ The following options need to be configured:
                CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
 
                If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
-               CONFIG_CMD_SCSI) you must configure support for at
+               CONFIG_SCSI) you must configure support for at
                least one non-MTD partition type as well.
 
 - IDE Reset method:
@@ -1423,6 +1417,17 @@ The following options need to be configured:
                        CONFIG_TPM_TIS_I2C_BURST_LIMITATION
                        Define the burst count bytes upper limit
 
+               CONFIG_TPM_ST33ZP24
+               Support for STMicroelectronics TPM devices. Requires DM_TPM support.
+
+                       CONFIG_TPM_ST33ZP24_I2C
+                       Support for STMicroelectronics ST33ZP24 I2C devices.
+                       Requires TPM_ST33ZP24 and I2C.
+
+                       CONFIG_TPM_ST33ZP24_SPI
+                       Support for STMicroelectronics ST33ZP24 SPI devices.
+                       Requires TPM_ST33ZP24 and SPI.
+
                CONFIG_TPM_ATMEL_TWI
                Support for Atmel TWI TPM device. Requires I2C support.
 
@@ -1784,7 +1789,7 @@ CBFS (Coreboot Filesystem) support
 
                The DIU driver will look for the 'video-mode' environment
                variable, and if defined, enable the DIU as a console during
-               boot.  See the documentation file README.video for a
+               boot.  See the documentation file doc/README.video for a
                description of this variable.
 
 - LCD Support: CONFIG_LCD
@@ -1898,7 +1903,7 @@ CBFS (Coreboot Filesystem) support
 
                If this option is set, then U-Boot will prevent the environment
                variable "splashimage" from being set to a problematic address
-               (see README.displaying-bmps).
+               (see doc/README.displaying-bmps).
                This option is useful for targets where, due to alignment
                restrictions, an improperly aligned BMP image will cause a data
                abort. If you think you will not have problems with unaligned
@@ -2751,7 +2756,7 @@ CBFS (Coreboot Filesystem) support
                with a special header) as build targets. By defining
                CONFIG_BUILD_TARGET in the SoC / board header, this
                special image will be automatically built upon calling
-               make / MAKEALL.
+               make / buildman.
 
                CONFIG_IDENT_STRING
 
@@ -2894,6 +2899,14 @@ CBFS (Coreboot Filesystem) support
                Enable editing and History functions for interactive
                command line input operations
 
+- Command Line PS1/PS2 support:
+               CONFIG_CMDLINE_PS_SUPPORT
+
+               Enable support for changing the command prompt string
+               at run-time. Only static string is supported so far.
+               The string is obtained from environment variables PS1
+               and PS2.
+
 - Default Environment:
                CONFIG_EXTRA_ENV_SETTINGS
 
@@ -2952,7 +2965,7 @@ CBFS (Coreboot Filesystem) support
 - Parallel Flash support:
                CONFIG_SYS_NO_FLASH
 
-               Traditionally U-boot was run on systems with parallel NOR
+               Traditionally U-Boot was run on systems with parallel NOR
                flash. This option is used to disable support for parallel NOR
                flash. This option should be defined if the board does not have
                parallel flash.
@@ -3075,20 +3088,6 @@ CBFS (Coreboot Filesystem) support
                will set it back to normal.  This command currently
                supports i.MX53 and i.MX6.
 
-- Signing support:
-               CONFIG_RSA
-
-               This enables the RSA algorithm used for FIT image verification
-               in U-Boot. See doc/uImage.FIT/signature.txt for more information.
-
-               The Modular Exponentiation algorithm in RSA is implemented using
-               driver model. So CONFIG_DM needs to be enabled by default for this
-               library to function.
-
-               The signing part is build into mkimage regardless of this
-               option. The software based modular exponentiation is built into
-               mkimage irrespective of this option.
-
 - bootcount support:
                CONFIG_BOOTCOUNT_LIMIT
 
@@ -3288,33 +3287,14 @@ FIT uImage format:
                enabled per default for backward compatibility.
 
 - FIT image support:
-               CONFIG_FIT
-               Enable support for the FIT uImage format.
-
-               CONFIG_FIT_BEST_MATCH
-               When no configuration is explicitly selected, default to the
-               one whose fdt's compatibility field best matches that of
-               U-Boot itself. A match is considered "best" if it matches the
-               most specific compatibility entry of U-Boot's fdt's root node.
-               The order of entries in the configuration's fdt is ignored.
-
-               CONFIG_FIT_SIGNATURE
-               This option enables signature verification of FIT uImages,
-               using a hash signed and verified using RSA. If
-               CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive
-               hashing is available using hardware, RSA library will use it.
-               See doc/uImage.FIT/signature.txt for more details.
-
-               WARNING: When relying on signed FIT images with required
-               signature check the legacy image format is default
-               disabled. If a board need legacy image format support
-               enable this through CONFIG_IMAGE_FORMAT_LEGACY
-
                CONFIG_FIT_DISABLE_SHA256
                Supporting SHA256 hashes has quite an impact on binary size.
                For constrained systems sha256 hash support can be disabled
                with this option.
 
+               TODO(sjg@chromium.org): Adjust this option to be positive,
+               and move it to Kconfig
+
 - Standalone program support:
                CONFIG_STANDALONE_LOAD_ADDR
 
@@ -3494,6 +3474,10 @@ FIT uImage format:
                consider that a completely unreadable NAND block is bad,
                and thus should be skipped silently.
 
+               CONFIG_SPL_ABORT_ON_RAW_IMAGE
+               When defined, SPL will proceed to another boot method
+               if the image it has loaded does not have a signature.
+
                CONFIG_SPL_RELOC_STACK
                Adress of the start of the stack SPL will use after
                relocation.  If unspecified, this is equal to
@@ -3602,6 +3586,10 @@ FIT uImage format:
                Support for NAND boot using simple NAND drivers that
                expose the cmd_ctrl() interface.
 
+               CONFIG_SPL_UBI
+               Support for a lightweight UBI (fastmap) scanner and
+               loader
+
                CONFIG_SPL_MTD_SUPPORT
                Support for the MTD subsystem within SPL.  Useful for
                environment on NAND support within SPL.
@@ -3701,17 +3689,6 @@ FIT uImage format:
                CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
                payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
 
-Modem Support:
---------------
-
-[so far only for SMDK2400 boards]
-
-- Modem support enable:
-               CONFIG_MODEM_SUPPORT
-
-- RTS/CTS Flow control enable:
-               CONFIG_HWFLOW
-
 - Interrupt support (PPC):
 
                There are common interrupt_init() and timer_interrupt()
@@ -3725,22 +3702,6 @@ Modem Support:
                / other_activity_monitor it works automatically from
                general timer_interrupt().
 
-- General:
-
-               In the target system modem support is enabled when a
-               specific key (key combination) is pressed during
-               power-on. Otherwise U-Boot will boot normally
-               (autoboot). The key_pressed() function is called from
-               board_init(). Currently key_pressed() is a dummy
-               function, returning 1 and thus enabling modem
-               initialization.
-
-               If there are no modem init strings in the
-               environment, U-Boot proceed to autoboot; the
-               previous output (banner, info printfs) will be
-               suppressed, though.
-
-               See also: doc/README.Modem
 
 Board initialization settings:
 ------------------------------
@@ -3812,10 +3773,11 @@ Configuration Settings:
                You only need to set this if address zero isn't writeable
 
 - CONFIG_SYS_MEM_RESERVE_SECURE
+               Only implemented for ARMv8 for now.
                If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
                is substracted from total RAM and won't be reported to OS.
                This memory can be used as secure memory. A variable
-               gd->secure_ram is used to track the location. In systems
+               gd->arch.secure_ram is used to track the location. In systems
                the RAM base is not zero, or RAM is divided into banks,
                this variable needs to be recalcuated to get the address.
 
@@ -3881,9 +3843,6 @@ Configuration Settings:
                The memory will be freed (or in fact just forgotten) when
                U-Boot relocates itself.
 
-               Pre-relocation malloc() is only supported on ARM and sandbox
-               at present but is fairly easy to enable for other archs.
-
 - CONFIG_SYS_MALLOC_SIMPLE
                Provides a simple and small malloc() and calloc() for those
                boards which do not use the full malloc in SPL (which is
@@ -4077,16 +4036,6 @@ Configuration Settings:
        If defined, don't allow the -f switch to env set override variable
        access flags.
 
-- CONFIG_SYS_GENERIC_BOARD
-       This selects the architecture-generic board system instead of the
-       architecture-specific board files. It is intended to move boards
-       to this new framework over time. Defining this will disable the
-       arch/foo/lib/board.c file and use common/board_f.c and
-       common/board_r.c instead. To use this option your architecture
-       must support it (i.e. must select HAVE_GENERIC_BOARD in arch/Kconfig).
-       If you find problems enabling this option on your board please report
-       the problem and send patches!
-
 - CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
        This is set by OMAP boards for the max time that reset should
        be asserted. See doc/README.omap-reset-time for details on how
@@ -4863,6 +4812,11 @@ Low Level (hardware related) configuration options:
                other boot loader or by a debugger which performs
                these initializations itself.
 
+- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
+               [ARM926EJ-S only] This allows just the call to lowlevel_init()
+               to be skipped. The normal CP15 init (such as enabling the
+               instruction cache) is still performed.
+
 - CONFIG_SPL_BUILD
                Modifies the behaviour of start.S when compiling a loader
                that is executed before the actual U-Boot. E.g. when
@@ -5129,33 +5083,10 @@ official or latest in the git repository) version of U-Boot sources.
 But before you submit such a patch, please verify that your modifi-
 cation did not break existing code. At least make sure that *ALL* of
 the supported boards compile WITHOUT ANY compiler warnings. To do so,
-just run the "MAKEALL" script, which will configure and build U-Boot
-for ALL supported system. Be warned, this will take a while. You can
-select which (cross) compiler to use by passing a `CROSS_COMPILE'
-environment variable to the script, i. e. to use the ELDK cross tools
-you can type
-
-       CROSS_COMPILE=ppc_8xx- MAKEALL
-
-or to build on a native PowerPC system you can type
-
-       CROSS_COMPILE=' ' MAKEALL
-
-When using the MAKEALL script, the default behaviour is to build
-U-Boot in the source directory. This location can be changed by
-setting the BUILD_DIR environment variable. Also, for each target
-built, the MAKEALL script saves two log files (<target>.ERR and
-<target>.MAKEALL) in the <source dir>/LOG directory. This default
-location can be changed by setting the MAKEALL_LOGDIR environment
-variable. For example:
-
-       export BUILD_DIR=/tmp/build
-       export MAKEALL_LOGDIR=/tmp/log
-       CROSS_COMPILE=ppc_8xx- MAKEALL
-
-With the above settings build objects are saved in the /tmp/build,
-log files are saved in the /tmp/log and the source tree remains clean
-during the whole build process.
+just run the buildman script (tools/buildman/buildman), which will
+configure and build U-Boot for ALL supported system. Be warned, this
+will take a while. Please see the buildman README, or run 'buildman -H'
+for documentation.
 
 
 See also "U-Boot Porting Guide" below.
@@ -5418,6 +5349,12 @@ List of environment variables (most likely not complete):
                  Ethernet is encapsulated/received over 802.1q
                  VLAN tagged frames.
 
+  bootpretryperiod     - Period during which BOOTP/DHCP sends retries.
+                 Unsigned value, in milliseconds. If not set, the period will
+                 be either the default (28000), or a value based on
+                 CONFIG_NET_RETRY_COUNT, if defined. This value has
+                 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
+
 The following image location variables contain the location of images
 used in booting. The "Image" column gives the role of the image and is
 not an environment variable name. The other columns are environment
@@ -6605,7 +6542,7 @@ it:
 
 Notes:
 
-* Before sending the patch, run the MAKEALL script on your patched
+* Before sending the patch, run the buildman script on your patched
   source tree and make sure that no errors or warnings are reported
   for any of the boards.