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 "dm - Access to driver model information"
395 Provides access to driver model data structures and information,
396 such as a list of devices, list of uclasses and the state of each
397 device (e.g. activated). This is not required for operation, but
398 can be useful to see the state of driver model for debugging or
402 bool "demo - Demonstration commands for driver model"
405 Provides a 'demo' command which can be used to play around with
406 driver model. To use this properly you will need to enable one or
407 both of the demo devices (DM_DEMO_SHAPE and DM_DEMO_SIMPLE).
408 Otherwise you will always get an empty list of devices. The demo
409 devices are defined in the sandbox device tree, so the easiest
410 option is to use sandbox and pass the -d point to sandbox's
417 Load a binary file over serial line.
423 Load an S-Record file over serial line
426 bool "flinfo, erase, protect"
430 flinfo - print FLASH memory information
432 protect - enable or disable FLASH write protection
435 bool "GPT (GUID Partition Table) command"
436 select PARTITION_UUIDS
439 Enable the 'gpt' command to ready and write GPT style partition
443 #depends on FLASH_CFI_DRIVER
446 ARM Ltd reference designs flash partition access
451 MMC memory mapped support.
455 default y if NAND_SUNXI
460 config CMD_NAND_TRIMFFS
461 bool "nand write.trimffs"
462 default y if ARCH_SUNXI
464 Allows one to skip empty pages when flashing something on a NAND.
466 config CMD_NAND_LOCK_UNLOCK
467 bool "nand lock/unlock"
469 NAND locking support.
471 config CMD_NAND_TORTURE
474 NAND torture support.
480 select PARTITION_UUIDS
482 Read and display information about the partition table on
507 select USB_FUNCTION_DFU
509 Enables the command "dfu" which is used to have U-Boot create a DFU
510 class device via USB.
512 config CMD_USB_MASS_STORAGE
513 bool "UMS usb mass storage"
515 USB mass storage support
523 config CMD_REMOTEPROC
525 depends on REMOTEPROC
527 Support for Remote Processor control
537 menu "Shell scripting commands"
549 Return true/false on integer compare.
555 Run script from memory
561 Evaluate boolean and math expressions and store the result in an env
563 Also supports loading the value at a memory location into a variable.
564 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
568 menu "Network commands"
571 bool "bootp, tftpboot"
576 bootp - boot image via network using BOOTP/TFTP protocol
577 tftpboot - boot image via network using TFTP protocol
582 TFTP put command, for uploading files to a server
587 Act as a TFTP server and boot the first received file
592 Boot image via network using RARP/TFTP protocol
597 Boot image via network using DHCP/TFTP protocol
603 Boot image via network using PXE protocol
609 Boot image via network using NFS protocol.
614 Enable MII utility commands.
619 Send ICMP ECHO_REQUEST to network host
624 Perform CDP network configuration
629 Synchronize RTC via network
634 Lookup the IP of a hostname
636 config CMD_LINK_LOCAL
639 Acquire a network IP address using the link-local protocol
646 bool "Enable 'bmp' command"
647 depends on LCD || DM_VIDEO || VIDEO
649 This provides a way to obtain information about a BMP-format iamge
650 and to display it. BMP (which presumably stands for BitMaP) is a
651 file format defined by Microsoft which supports images of various
652 depths, formats and compression methods. Headers on the file
653 determine the formats used. This command can be used by first loading
654 the image into RAM, then using this command to look at it or display
657 config CMD_BKOPS_ENABLE
658 bool "mmc bkops enable"
662 Enable command for setting manual background operations handshake
663 on a eMMC device. The feature is optionally available on eMMC devices
664 conforming to standard >= 4.41.
666 config CMD_BLOCK_CACHE
667 bool "blkcache - control and stats for block cache"
668 depends on BLOCK_CACHE
669 default y if BLOCK_CACHE
671 Enable the blkcache command, which can be used to control the
672 operation of the cache functions.
673 This is most useful when fine-tuning the operation of the cache
674 during development, but also allows the cache to be disabled when
675 it might hurt performance (e.g. when using the ums command).
678 bool "icache or dcache"
680 Enable the "icache" and "dcache" commands
686 Enable the 'led' command which allows for control of LEDs supported
687 by the board. The LEDs can be listed with 'led list' and controlled
688 with led on/off/togle/blink. Any LED drivers can be controlled with
689 this command, e.g. led_gpio.
694 Run commands and summarize execution time.
696 # TODO: rename to CMD_SLEEP
701 Delay execution for some time
706 Access the system timer.
709 bool "getdcr, setdcr, getidcr, setidcr"
713 getdcr - Get an AMCC PPC 4xx DCR's value
714 setdcr - Set an AMCC PPC 4xx DCR's value
715 getidcr - Get a register value via indirect DCR addressing
716 setidcr - Set a register value via indirect DCR addressing
722 This provides basic access to the U-Boot's sound support. The main
723 feature is to play a beep.
725 sound init - set up sound system
726 sound play - play a sound
732 This provides access to the QEMU firmware interface. The main
733 feature is to allow easy loading of files passed to qemu-system
734 via -kernel / -initrd
736 source "cmd/mvebu/Kconfig"
741 bool "Enable the 'bootstage' command"
744 Add a 'bootstage' command which supports printing a report
745 and un/stashing of bootstage data.
747 menu "Power commands"
749 bool "Enable Driver Model PMIC command"
752 This is the pmic command, based on a driver model pmic's API.
753 Command features are unchanged:
754 - list - list pmic devices
755 - pmic dev <id> - show or [set] operating pmic device (NEW)
756 - pmic dump - dump registers
757 - pmic read address - read byte of register at address
758 - pmic write address - write byte to register at address
759 The only one change for this command is 'dev' subcommand.
762 bool "Enable Driver Model REGULATOR command"
763 depends on DM_REGULATOR
765 This command is based on driver model regulator's API.
766 User interface features:
767 - list - list regulator devices
768 - regulator dev <id> - show or [set] operating regulator device
769 - regulator info - print constraints info
770 - regulator status - print operating status
771 - regulator value <val] <-f> - print/[set] voltage value [uV]
772 - regulator current <val> - print/[set] current value [uA]
773 - regulator mode <id> - print/[set] operating mode id
774 - regulator enable - enable the regulator output
775 - regulator disable - disable the regulator output
777 The '-f' (force) option can be used for set the value which exceeds
778 the limits, which are found in device-tree and are kept in regulator's
779 uclass platdata structure.
783 menu "Security commands"
785 bool "Enable the 'aes' command"
788 This provides a means to encrypt and decrypt data using the AES
789 (Advanced Encryption Standard). This algorithm uses a symetric key
790 and is widely used as a streaming cipher. Different key lengths are
791 supported by the algorithm but this command only supports 128 bits
795 bool "Enable the 'blob' command"
797 This is used with the Freescale secure boot mechanism.
799 Freescale's SEC block has built-in Blob Protocol which provides
800 a method for protecting user-defined data across system power
801 cycles. SEC block protects data in a data structure called a Blob,
802 which provides both confidentiality and integrity protection.
804 Encapsulating data as a blob
805 Each time that the Blob Protocol is used to protect data, a
806 different randomly generated key is used to encrypt the data.
807 This random key is itself encrypted using a key which is derived
808 from SoC's non-volatile secret key and a 16 bit Key identifier.
809 The resulting encrypted key along with encrypted data is called a
810 blob. The non-volatile secure key is available for use only during
813 During decapsulation, the reverse process is performed to get back
817 blob enc - encapsulating data as a cryptgraphic blob
818 blob dec - decapsulating cryptgraphic blob to get the data
822 blob enc src dst len km
824 Encapsulate and create blob of data $len bytes long
825 at address $src and store the result at address $dst.
826 $km is the 16 byte key modifier is also required for
827 generation/use as key for cryptographic operation. Key
828 modifier should be 16 byte long.
830 blob dec src dst len km
832 Decapsulate the blob of data at address $src and
833 store result of $len byte at addr $dst.
834 $km is the 16 byte key modifier is also required for
835 generation/use as key for cryptographic operation. Key
836 modifier should be 16 byte long.
839 bool "Enable the 'tpm' command"
842 This provides a means to talk to a TPM from the command line. A wide
843 range of commands if provided - see 'tpm help' for details. The
844 command requires a suitable TPM on your board and the correct driver
848 bool "Enable the 'tpm test' command"
851 This provides a a series of tests to confirm that the TPM is working
852 correctly. The tests cover initialisation, non-volatile RAM, extend,
853 global lock and checking that timing is within expectations. The
854 tests pass correctly on Infineon TPMs but may need to be adjusted
859 menu "Firmware commands"
861 bool "Enable crosec command"
865 Enable command-line access to the Chrome OS EC (Embedded
866 Controller). This provides the 'crosec' command which has
867 a number of sub-commands for performing EC tasks such as
868 updating its flash, accessing a small saved context area
869 and talking to the I2C bus behind the EC (if there is one).
872 menu "Filesystem commands"
874 bool "ext2 command support"
876 Enables EXT2 FS command
879 bool "ext4 command support"
881 Enables EXT4 FS command
883 config CMD_EXT4_WRITE
885 bool "ext4 write command support"
887 Enables EXT4 FS write command
890 bool "FAT command support"
892 Support for the FAT fs
894 config CMD_FS_GENERIC
895 bool "filesystem commands"
897 Enables filesystem commands (e.g. load, ls) that work for multiple
901 bool "fsuuid command"
903 Enables fsuuid command for filesystem UUID.
906 depends on ARCH_SUNXI
907 bool "MTD partition support"
909 MTD partition support
911 config MTDIDS_DEFAULT
912 string "Default MTD IDs"
913 depends on CMD_MTDPARTS
915 Defines a default MTD ID
917 config MTDPARTS_DEFAULT
918 string "Default MTD partition scheme"
919 depends on CMD_MTDPARTS
921 Defines a default MTD partitioning scheme in the Linux MTD command
922 line partitions format
926 menu "Debug commands"
931 The bedbug (emBEDded deBUGger) command provides debugging features
932 for some PowerPC processors. For details please see the
933 docuemntation in doc/README.beddbug
938 tristate "Enable UBI - Unsorted block images commands"
941 default y if NAND_SUNXI
943 UBI is a software layer above MTD layer which admits use of LVM-like
944 logical volumes on top of MTD devices, hides some complexities of
945 flash chips like wear and bad blocks and provides some other useful
946 capabilities. Please, consult the MTD web site for more details
947 (www.linux-mtd.infradead.org). Activate this option if you want
948 to use U-Boot UBI commands.
951 tristate "Enable UBIFS - Unsorted block images filesystem commands"
954 select RBTREE if ARCH_SUNXI
955 select LZO if ARCH_SUNXI
956 default y if NAND_SUNXI
958 UBIFS is a file system for flash devices which works on top of UBI.