1 menu "Command line interface"
4 bool "Support U-Boot commands"
7 Enable U-Boot's command-line functions. This provides a means
8 to enter commands into U-Boot for a wide variety of purposes. It
9 also allows scripts (containing commands) to be executed.
10 Various commands and command categorys can be indivdually enabled.
11 Depending on the number of commands enabled, this can add
12 substantially to the size of U-Boot.
18 This option enables the "hush" shell (from Busybox) as command line
19 interpreter, thus enabling powerful command line syntax like
20 if...then...else...fi conditionals or `&&' and '||'
21 constructs ("shell scripts").
23 If disabled, you get the old, much simpler behaviour with a somewhat
24 smaller memory footprint.
30 This string is displayed in the command line to the left of the
33 menu "Autoboot options"
39 This enables the autoboot. See doc/README.autoboot for detail.
42 bool "Stop autobooting via specific input key / string"
45 This option enables stopping (aborting) of the automatic
46 boot feature only by issuing a specific input key or
47 string. If not enabled, any input key will abort the
48 U-Boot automatic booting process and bring the device
49 to the U-Boot prompt for user input.
51 config AUTOBOOT_PROMPT
52 string "Autoboot stop prompt"
53 depends on AUTOBOOT_KEYED
54 default "Autoboot in %d seconds\\n"
56 This string is displayed before the boot delay selected by
57 CONFIG_BOOTDELAY starts. If it is not defined there is no
58 output indicating that autoboot is in progress.
60 Note that this define is used as the (only) argument to a
61 printf() call, so it may contain '%' format specifications,
62 provided that it also includes, sepearated by commas exactly
63 like in a printf statement, the required arguments. It is
64 the responsibility of the user to select only such arguments
65 that are valid in the given context.
67 config AUTOBOOT_ENCRYPTION
68 bool "Enable encryption in autoboot stopping"
69 depends on AUTOBOOT_KEYED
72 config AUTOBOOT_DELAY_STR
73 string "Delay autobooting via specific input key / string"
74 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
76 This option delays the automatic boot feature by issuing
77 a specific input key or string. If CONFIG_AUTOBOOT_DELAY_STR
78 or the environment variable "bootdelaykey" is specified
79 and this string is received from console input before
80 autoboot starts booting, U-Boot gives a command prompt. The
81 U-Boot prompt will time out if CONFIG_BOOT_RETRY_TIME is
82 used, otherwise it never times out.
84 config AUTOBOOT_STOP_STR
85 string "Stop autobooting via specific input key / string"
86 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
88 This option enables stopping (aborting) of the automatic
89 boot feature only by issuing a specific input key or
90 string. If CONFIG_AUTOBOOT_STOP_STR or the environment
91 variable "bootstopkey" is specified and this string is
92 received from console input before autoboot starts booting,
93 U-Boot gives a command prompt. The U-Boot prompt never
94 times out, even if CONFIG_BOOT_RETRY_TIME is used.
96 config AUTOBOOT_KEYED_CTRLC
97 bool "Enable Ctrl-C autoboot interruption"
98 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
101 This option allows for the boot sequence to be interrupted
102 by ctrl-c, in addition to the "bootdelaykey" and "bootstopkey".
103 Setting this variable provides an escape sequence from the
104 limited "password" strings.
106 config AUTOBOOT_STOP_STR_SHA256
107 string "Stop autobooting via SHA256 encrypted password"
108 depends on AUTOBOOT_KEYED && AUTOBOOT_ENCRYPTION
110 This option adds the feature to only stop the autobooting,
111 and therefore boot into the U-Boot prompt, when the input
112 string / password matches a values that is encypted via
113 a SHA256 hash and saved in the environment.
117 source "cmd/fastboot/Kconfig"
134 Print ".config" contents.
136 If this option is enabled, the ".config" file contents are embedded
137 in the U-Boot image and can be printed on the console by the "config"
138 command. This provides information of which options are enabled on
145 Print console devices and information.
150 Print information about available CPUs. This normally shows the
151 number of CPUs, type (e.g. manufacturer, architecture, product or
152 internal name) and clock frequency. Other information may be
153 available depending on the CPU driver.
159 Print GPL license text
169 Run the command stored in the environment "bootcmd", i.e.
170 "bootd" does the same thing as "run bootcmd".
176 Boot an application image from the memory.
181 Boot the Linux zImage
188 Boot an AArch64 Linux Kernel image from memory.
192 depends on EFI_LOADER
195 Boot an EFI image from memory.
197 config CMD_BOOTEFI_HELLO_COMPILE
198 bool "Compile a standard EFI hello world binary for testing"
199 depends on CMD_BOOTEFI && (ARM || X86)
202 This compiles a standard EFI hello world application with U-Boot so
203 that it can be used with the test/py testing framework. This is useful
204 for testing that EFI is working at a basic level, and for bringing
205 up EFI support on a new architecture.
207 No additional space will be required in the resulting U-Boot binary
208 when this option is enabled.
210 config CMD_BOOTEFI_HELLO
211 bool "Allow booting a standard EFI hello world for testing"
212 depends on CMD_BOOTEFI_HELLO_COMPILE
214 This adds a standard EFI hello world application to U-Boot so that
215 it can be used with the 'bootefi hello' command. This is useful
216 for testing that EFI is working at a basic level, and for bringing
217 up EFI support on a new architecture.
223 Add an ANSI terminal boot menu command.
226 bool "bootelf, bootvx"
229 Boot an ELF/vxWorks image from the memory.
232 bool "Flattened Device Tree utility commands"
236 Do FDT related setup before booting into the Operating System.
242 Start an application at a given address.
248 Run the command in the given environment variable.
254 Print header information for application image.
260 List all images found in flash
266 Extract a part of a multi-image.
273 menu "Environment commands"
276 bool "ask for env variable"
278 Ask for environment variable
296 Edit environment variable.
301 Allow for searching environment variables
307 Save all environment variables into the compiled-in persistent
310 config CMD_ENV_EXISTS
314 Check if a variable is defined in the environment for use in
319 menu "Memory commands"
322 bool "md, mm, nm, mw, cp, cmp, base, loop"
327 mm - memory modify (auto-incrementing address)
328 nm - memory modify (constant address)
329 mw - memory write (fill)
332 base - print or set address offset
333 loop - initialize loop on address range
346 Compute MD5 checksum.
351 depends on CMD_MD5SUM
353 Add -v option to verify data against an MD5 checksum.
358 Infinite write loop on address range
363 Simple RAM read/write test.
368 mdc - memory display cyclic
369 mwc - memory write cyclic
374 Display memory information.
379 Uncompress a zip-compressed memory region.
384 Compress a memory region with zlib deflate method.
388 menu "Device access commands"
391 bool "clk - Show clock frequencies"
394 Shows clock frequences by calling a sock_clk_dump() hook function.
395 This is depreated in favour of using the CLK uclass and accessing
396 clock values from associated drivers. However currently no command
400 bool "dm - Access to driver model information"
404 Provides access to driver model data structures and information,
405 such as a list of devices, list of uclasses and the state of each
406 device (e.g. activated). This is not required for operation, but
407 can be useful to see the state of driver model for debugging or
411 bool "demo - Demonstration commands for driver model"
414 Provides a 'demo' command which can be used to play around with
415 driver model. To use this properly you will need to enable one or
416 both of the demo devices (DM_DEMO_SHAPE and DM_DEMO_SIMPLE).
417 Otherwise you will always get an empty list of devices. The demo
418 devices are defined in the sandbox device tree, so the easiest
419 option is to use sandbox and pass the -d point to sandbox's
426 Load a binary file over serial line.
432 Load an S-Record file over serial line
435 bool "flinfo, erase, protect"
439 flinfo - print FLASH memory information
441 protect - enable or disable FLASH write protection
444 bool "GPT (GUID Partition Table) command"
445 select PARTITION_UUIDS
448 Enable the 'gpt' command to ready and write GPT style partition
452 #depends on FLASH_CFI_DRIVER
455 ARM Ltd reference designs flash partition access
460 MMC memory mapped support.
464 default y if NAND_SUNXI
469 config CMD_NAND_TRIMFFS
470 bool "nand write.trimffs"
471 default y if ARCH_SUNXI
473 Allows one to skip empty pages when flashing something on a NAND.
475 config CMD_NAND_LOCK_UNLOCK
476 bool "nand lock/unlock"
478 NAND locking support.
480 config CMD_NAND_TORTURE
483 NAND torture support.
489 select PARTITION_UUIDS
491 Read and display information about the partition table on
516 select USB_FUNCTION_DFU
518 Enables the command "dfu" which is used to have U-Boot create a DFU
519 class device via USB.
521 config CMD_USB_MASS_STORAGE
522 bool "UMS usb mass storage"
524 USB mass storage support
532 config CMD_REMOTEPROC
534 depends on REMOTEPROC
536 Support for Remote Processor control
546 menu "Shell scripting commands"
558 Return true/false on integer compare.
564 Run script from memory
570 Evaluate boolean and math expressions and store the result in an env
572 Also supports loading the value at a memory location into a variable.
573 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
577 menu "Network commands"
580 bool "bootp, tftpboot"
585 bootp - boot image via network using BOOTP/TFTP protocol
586 tftpboot - boot image via network using TFTP protocol
591 TFTP put command, for uploading files to a server
596 Act as a TFTP server and boot the first received file
601 Boot image via network using RARP/TFTP protocol
606 Boot image via network using DHCP/TFTP protocol
612 Boot image via network using PXE protocol
618 Boot image via network using NFS protocol.
623 Enable MII utility commands.
628 Send ICMP ECHO_REQUEST to network host
633 Perform CDP network configuration
638 Synchronize RTC via network
643 Lookup the IP of a hostname
645 config CMD_LINK_LOCAL
648 Acquire a network IP address using the link-local protocol
655 bool "Enable 'bmp' command"
656 depends on LCD || DM_VIDEO || VIDEO
658 This provides a way to obtain information about a BMP-format iamge
659 and to display it. BMP (which presumably stands for BitMaP) is a
660 file format defined by Microsoft which supports images of various
661 depths, formats and compression methods. Headers on the file
662 determine the formats used. This command can be used by first loading
663 the image into RAM, then using this command to look at it or display
667 bool "Enable board-specific commands"
669 (deprecated: instead, please define a Kconfig option for each command)
671 Some boards have board-specific commands which are only enabled
672 during developemnt and need to be turned off for production. This
673 option provides a way to control this. The commands that are enabled
674 vary depending on the board.
676 config CMD_BKOPS_ENABLE
677 bool "mmc bkops enable"
681 Enable command for setting manual background operations handshake
682 on a eMMC device. The feature is optionally available on eMMC devices
683 conforming to standard >= 4.41.
685 config CMD_BLOCK_CACHE
686 bool "blkcache - control and stats for block cache"
687 depends on BLOCK_CACHE
688 default y if BLOCK_CACHE
690 Enable the blkcache command, which can be used to control the
691 operation of the cache functions.
692 This is most useful when fine-tuning the operation of the cache
693 during development, but also allows the cache to be disabled when
694 it might hurt performance (e.g. when using the ums command).
697 bool "icache or dcache"
699 Enable the "icache" and "dcache" commands
702 bool "Enable the 'display' command, for character displays"
704 (this needs porting to driver model)
705 This enables the 'display' command which allows a string to be
706 displayed on a simple board-specific display. Implement
707 display_putc() to use it.
713 Enable the 'led' command which allows for control of LEDs supported
714 by the board. The LEDs can be listed with 'led list' and controlled
715 with led on/off/togle/blink. Any LED drivers can be controlled with
716 this command, e.g. led_gpio.
722 Enable the 'date' command for getting/setting the time/date in RTC
728 Run commands and summarize execution time.
730 # TODO: rename to CMD_SLEEP
735 Delay execution for some time
740 Access the system timer.
743 bool "getdcr, setdcr, getidcr, setidcr"
747 getdcr - Get an AMCC PPC 4xx DCR's value
748 setdcr - Set an AMCC PPC 4xx DCR's value
749 getidcr - Get a register value via indirect DCR addressing
750 setidcr - Set a register value via indirect DCR addressing
756 This provides basic access to the U-Boot's sound support. The main
757 feature is to play a beep.
759 sound init - set up sound system
760 sound play - play a sound
766 This provides access to the QEMU firmware interface. The main
767 feature is to allow easy loading of files passed to qemu-system
768 via -kernel / -initrd
770 source "cmd/mvebu/Kconfig"
775 bool "Enable the 'bootstage' command"
778 Add a 'bootstage' command which supports printing a report
779 and un/stashing of bootstage data.
781 menu "Power commands"
783 bool "Enable Driver Model PMIC command"
786 This is the pmic command, based on a driver model pmic's API.
787 Command features are unchanged:
788 - list - list pmic devices
789 - pmic dev <id> - show or [set] operating pmic device (NEW)
790 - pmic dump - dump registers
791 - pmic read address - read byte of register at address
792 - pmic write address - write byte to register at address
793 The only one change for this command is 'dev' subcommand.
796 bool "Enable Driver Model REGULATOR command"
797 depends on DM_REGULATOR
799 This command is based on driver model regulator's API.
800 User interface features:
801 - list - list regulator devices
802 - regulator dev <id> - show or [set] operating regulator device
803 - regulator info - print constraints info
804 - regulator status - print operating status
805 - regulator value <val] <-f> - print/[set] voltage value [uV]
806 - regulator current <val> - print/[set] current value [uA]
807 - regulator mode <id> - print/[set] operating mode id
808 - regulator enable - enable the regulator output
809 - regulator disable - disable the regulator output
811 The '-f' (force) option can be used for set the value which exceeds
812 the limits, which are found in device-tree and are kept in regulator's
813 uclass platdata structure.
817 menu "Security commands"
819 bool "Enable the 'aes' command"
822 This provides a means to encrypt and decrypt data using the AES
823 (Advanced Encryption Standard). This algorithm uses a symetric key
824 and is widely used as a streaming cipher. Different key lengths are
825 supported by the algorithm but this command only supports 128 bits
829 bool "Enable the 'blob' command"
831 This is used with the Freescale secure boot mechanism.
833 Freescale's SEC block has built-in Blob Protocol which provides
834 a method for protecting user-defined data across system power
835 cycles. SEC block protects data in a data structure called a Blob,
836 which provides both confidentiality and integrity protection.
838 Encapsulating data as a blob
839 Each time that the Blob Protocol is used to protect data, a
840 different randomly generated key is used to encrypt the data.
841 This random key is itself encrypted using a key which is derived
842 from SoC's non-volatile secret key and a 16 bit Key identifier.
843 The resulting encrypted key along with encrypted data is called a
844 blob. The non-volatile secure key is available for use only during
847 During decapsulation, the reverse process is performed to get back
851 blob enc - encapsulating data as a cryptgraphic blob
852 blob dec - decapsulating cryptgraphic blob to get the data
856 blob enc src dst len km
858 Encapsulate and create blob of data $len bytes long
859 at address $src and store the result at address $dst.
860 $km is the 16 byte key modifier is also required for
861 generation/use as key for cryptographic operation. Key
862 modifier should be 16 byte long.
864 blob dec src dst len km
866 Decapsulate the blob of data at address $src and
867 store result of $len byte at addr $dst.
868 $km is the 16 byte key modifier is also required for
869 generation/use as key for cryptographic operation. Key
870 modifier should be 16 byte long.
873 bool "Enable the 'tpm' command"
876 This provides a means to talk to a TPM from the command line. A wide
877 range of commands if provided - see 'tpm help' for details. The
878 command requires a suitable TPM on your board and the correct driver
882 bool "Enable the 'tpm test' command"
885 This provides a a series of tests to confirm that the TPM is working
886 correctly. The tests cover initialisation, non-volatile RAM, extend,
887 global lock and checking that timing is within expectations. The
888 tests pass correctly on Infineon TPMs but may need to be adjusted
893 menu "Firmware commands"
895 bool "Enable crosec command"
899 Enable command-line access to the Chrome OS EC (Embedded
900 Controller). This provides the 'crosec' command which has
901 a number of sub-commands for performing EC tasks such as
902 updating its flash, accessing a small saved context area
903 and talking to the I2C bus behind the EC (if there is one).
906 menu "Filesystem commands"
908 bool "Enable the 'cbfs' command"
911 Define this to enable support for reading from a Coreboot
912 filesystem. This is a ROM-based filesystem used for accessing files
913 on systems that use coreboot as the first boot-loader and then load
914 U-Boot to actually boot the Operating System. Available commands are
915 cbfsinit, cbfsinfo, cbfsls and cbfsload.
918 bool "Enable the 'cramfs' command"
921 This provides commands for dealing with CRAMFS (Compressed ROM
922 filesystem). CRAMFS is useful when space is tight since files are
923 compressed. Two commands are provided:
925 cramfsls - lists files in a cramfs image
926 cramfsload - loads a file from a cramfs image
929 bool "ext2 command support"
931 Enables EXT2 FS command
934 bool "ext4 command support"
936 Enables EXT4 FS command
938 config CMD_EXT4_WRITE
940 bool "ext4 write command support"
942 Enables EXT4 FS write command
945 bool "FAT command support"
947 Support for the FAT fs
949 config CMD_FS_GENERIC
950 bool "filesystem commands"
952 Enables filesystem commands (e.g. load, ls) that work for multiple
956 bool "fsuuid command"
958 Enables fsuuid command for filesystem UUID.
961 depends on ARCH_SUNXI
962 bool "MTD partition support"
964 MTD partition support
966 config MTDIDS_DEFAULT
967 string "Default MTD IDs"
968 depends on CMD_MTDPARTS
970 Defines a default MTD ID
972 config MTDPARTS_DEFAULT
973 string "Default MTD partition scheme"
974 depends on CMD_MTDPARTS
976 Defines a default MTD partitioning scheme in the Linux MTD command
977 line partitions format
981 menu "Debug commands"
986 The bedbug (emBEDded deBUGger) command provides debugging features
987 for some PowerPC processors. For details please see the
988 docuemntation in doc/README.beddbug
991 bool "diag - Board diagnostics"
993 This command provides access to board diagnostic tests. These are
994 called Power-on Self Tests (POST). The command allows listing of
995 available tests and running either all the tests, or specific tests
1001 tristate "Enable UBI - Unsorted block images commands"
1004 default y if NAND_SUNXI
1006 UBI is a software layer above MTD layer which admits use of LVM-like
1007 logical volumes on top of MTD devices, hides some complexities of
1008 flash chips like wear and bad blocks and provides some other useful
1009 capabilities. Please, consult the MTD web site for more details
1010 (www.linux-mtd.infradead.org). Activate this option if you want
1011 to use U-Boot UBI commands.
1014 tristate "Enable UBIFS - Unsorted block images filesystem commands"
1017 select RBTREE if ARCH_SUNXI
1018 select LZO if ARCH_SUNXI
1019 default y if NAND_SUNXI
1021 UBIFS is a file system for flash devices which works on top of UBI.