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
317 config CMD_ENV_CALLBACK
318 bool "env callbacks - print callbacks and their associated variables"
320 Some environment variable have callbacks defined by
321 U_BOOT_ENV_CALLBACK. These are called when the variable changes.
322 For example changing "baudrate" adjust the serial baud rate. This
323 command lists the currently defined callbacks.
326 bool "env flags -print variables that have non-default flags"
328 Some environment variables have special flags that control their
329 behaviour. For example, serial# can only be written once and cannot
330 be deleted. This command shows the variables that have special
335 menu "Memory commands"
338 bool "md, mm, nm, mw, cp, cmp, base, loop"
343 mm - memory modify (auto-incrementing address)
344 nm - memory modify (constant address)
345 mw - memory write (fill)
348 base - print or set address offset
349 loop - initialize loop on address range
359 bool "eeprom - EEPROM subsystem"
361 (deprecated, needs conversion to driver model)
362 Provides commands to read and write EEPROM (Electrically Erasable
363 Programmable Read Only Memory) chips that are connected over an
366 config CMD_EEPROM_LAYOUT
367 bool "Enable layout-aware eeprom commands"
368 depends on CMD_EEPROM
370 (deprecated, needs conversion to driver model)
371 When enabled, additional eeprom sub-commands become available.
373 eeprom print - prints the contents of the eeprom in a human-readable
374 way (eeprom layout fields, and data formatted to be fit for human
377 eeprom update - allows user to update eeprom fields by specifying
378 the field name, and providing the new data in a human readable format
379 (same format as displayed by the eeprom print command).
381 Both commands can either auto detect the layout, or be told which
385 __weak int parse_layout_version(char *str)
386 - override to provide your own layout name parsing
387 __weak void __eeprom_layout_assign(struct eeprom_layout *layout,
389 - override to setup the layout metadata based on the version
390 __weak int eeprom_layout_detect(unsigned char *data)
391 - override to provide your own algorithm for detecting layout
394 - contains various printing and updating functions for common
395 types of eeprom fields. Can be used for defining
398 config EEPROM_LAYOUT_HELP_STRING
399 string "Tells user what layout names are supported"
400 depends on CMD_EEPROM_LAYOUT
401 default "<not defined>"
403 Help printed with the LAYOUT VERSIONS part of the 'eeprom'
411 Compute MD5 checksum.
416 depends on CMD_MD5SUM
418 Add -v option to verify data against an MD5 checksum.
423 Infinite write loop on address range
428 Simple RAM read/write test.
433 mdc - memory display cyclic
434 mwc - memory write cyclic
439 Display memory information.
444 Uncompress a zip-compressed memory region.
449 Compress a memory region with zlib deflate method.
453 menu "Device access commands"
456 bool "clk - Show clock frequencies"
459 Shows clock frequences by calling a sock_clk_dump() hook function.
460 This is depreated in favour of using the CLK uclass and accessing
461 clock values from associated drivers. However currently no command
465 bool "dm - Access to driver model information"
469 Provides access to driver model data structures and information,
470 such as a list of devices, list of uclasses and the state of each
471 device (e.g. activated). This is not required for operation, but
472 can be useful to see the state of driver model for debugging or
476 bool "demo - Demonstration commands for driver model"
479 Provides a 'demo' command which can be used to play around with
480 driver model. To use this properly you will need to enable one or
481 both of the demo devices (DM_DEMO_SHAPE and DM_DEMO_SIMPLE).
482 Otherwise you will always get an empty list of devices. The demo
483 devices are defined in the sandbox device tree, so the easiest
484 option is to use sandbox and pass the -d point to sandbox's
488 bool "ide - Support for IDE drivers"
490 Provides an 'ide' command which allows accessing the IDE drive,
491 reseting the IDE interface, printing the partition table and
492 geting device info. It also enables the 'diskboot' command which
493 permits booting from an IDE drive.
499 Load a binary file over serial line.
505 Load an S-Record file over serial line
508 bool "flinfo, erase, protect"
512 flinfo - print FLASH memory information
514 protect - enable or disable FLASH write protection
517 bool "GPT (GUID Partition Table) command"
518 select PARTITION_UUIDS
521 Enable the 'gpt' command to ready and write GPT style partition
525 #depends on FLASH_CFI_DRIVER
528 ARM Ltd reference designs flash partition access
533 MMC memory mapped support.
537 default y if NAND_SUNXI
542 config CMD_NAND_TRIMFFS
543 bool "nand write.trimffs"
544 default y if ARCH_SUNXI
546 Allows one to skip empty pages when flashing something on a NAND.
548 config CMD_NAND_LOCK_UNLOCK
549 bool "nand lock/unlock"
551 NAND locking support.
553 config CMD_NAND_TORTURE
556 NAND torture support.
562 select PARTITION_UUIDS
564 Read and display information about the partition table on
589 select USB_FUNCTION_DFU
591 Enables the command "dfu" which is used to have U-Boot create a DFU
592 class device via USB.
594 config CMD_USB_MASS_STORAGE
595 bool "UMS usb mass storage"
597 USB mass storage support
605 config CMD_FPGA_LOADBP
606 bool "fpga loadbp - load partial bitstream (Xilinx only)"
609 Supports loading an FPGA device from a bitstream buffer containing
612 config CMD_FPGA_LOADFS
613 bool "fpga loadfs - load bitstream from FAT filesystem (Xilinx only)"
616 Supports loading an FPGA device from a FAT filesystem.
618 config CMD_FPGA_LOADMK
619 bool "fpga loadmk - load bitstream from image"
622 Supports loading an FPGA device from a image generated by mkimage.
624 config CMD_FPGA_LOADP
625 bool "fpga loadp - load partial bitstream"
628 Supports loading an FPGA device from a bitstream buffer containing
632 bool "fpgad - dump FPGA registers"
634 (legacy, needs conversion to driver model)
635 Provides a way to dump FPGA registers by calling the board-specific
636 fpga_get_reg() function. This functions similarly to the 'md'
640 bool "fuse - support for the fuse subssystem"
642 (deprecated - needs conversion to driver model)
643 This allows reading, sensing, programming or overriding fuses
644 which control the behaviour of the device. The command uses the
647 config CMD_REMOTEPROC
649 depends on REMOTEPROC
651 Support for Remote Processor control
659 bool "fdcboot - Boot from floppy device"
661 The 'fdtboot' command allows booting an image from a floppy disk.
666 menu "Shell scripting commands"
678 Return true/false on integer compare.
684 Run script from memory
690 Evaluate boolean and math expressions and store the result in an env
692 Also supports loading the value at a memory location into a variable.
693 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
697 menu "Network commands"
700 bool "bootp, tftpboot"
705 bootp - boot image via network using BOOTP/TFTP protocol
706 tftpboot - boot image via network using TFTP protocol
711 TFTP put command, for uploading files to a server
716 Act as a TFTP server and boot the first received file
721 Boot image via network using RARP/TFTP protocol
726 Boot image via network using DHCP/TFTP protocol
732 Boot image via network using PXE protocol
738 Boot image via network using NFS protocol.
743 Enable MII utility commands.
748 Send ICMP ECHO_REQUEST to network host
753 Perform CDP network configuration
758 Synchronize RTC via network
763 Lookup the IP of a hostname
765 config CMD_LINK_LOCAL
768 Acquire a network IP address using the link-local protocol
773 Allow control of L2 Ethernet switch commands. These are supported
774 by the vsc9953 Ethernet driver at present. Sub-commands allow
775 operations such as enabling / disabling a port and
776 viewing/maintaining the filtering database (FDB)
783 bool "Enable 'bmp' command"
784 depends on LCD || DM_VIDEO || VIDEO
786 This provides a way to obtain information about a BMP-format iamge
787 and to display it. BMP (which presumably stands for BitMaP) is a
788 file format defined by Microsoft which supports images of various
789 depths, formats and compression methods. Headers on the file
790 determine the formats used. This command can be used by first loading
791 the image into RAM, then using this command to look at it or display
795 bool "Enable board-specific commands"
797 (deprecated: instead, please define a Kconfig option for each command)
799 Some boards have board-specific commands which are only enabled
800 during developemnt and need to be turned off for production. This
801 option provides a way to control this. The commands that are enabled
802 vary depending on the board.
804 config CMD_BKOPS_ENABLE
805 bool "mmc bkops enable"
809 Enable command for setting manual background operations handshake
810 on a eMMC device. The feature is optionally available on eMMC devices
811 conforming to standard >= 4.41.
813 config CMD_BLOCK_CACHE
814 bool "blkcache - control and stats for block cache"
815 depends on BLOCK_CACHE
816 default y if BLOCK_CACHE
818 Enable the blkcache command, which can be used to control the
819 operation of the cache functions.
820 This is most useful when fine-tuning the operation of the cache
821 during development, but also allows the cache to be disabled when
822 it might hurt performance (e.g. when using the ums command).
825 bool "icache or dcache"
827 Enable the "icache" and "dcache" commands
830 bool "Enable the 'display' command, for character displays"
832 (this needs porting to driver model)
833 This enables the 'display' command which allows a string to be
834 displayed on a simple board-specific display. Implement
835 display_putc() to use it.
841 Enable the 'led' command which allows for control of LEDs supported
842 by the board. The LEDs can be listed with 'led list' and controlled
843 with led on/off/togle/blink. Any LED drivers can be controlled with
844 this command, e.g. led_gpio.
850 Enable the 'date' command for getting/setting the time/date in RTC
856 Run commands and summarize execution time.
859 bool "gettime - read elapsed time"
861 Enable the 'gettime' command which reads the elapsed time since
862 U-Boot started running. This shows the time in seconds and
863 milliseconds. See also the 'bootstage' command which provides more
864 flexibility for boot timing.
866 # TODO: rename to CMD_SLEEP
871 Delay execution for some time
876 Access the system timer.
879 bool "getdcr, setdcr, getidcr, setidcr"
883 getdcr - Get an AMCC PPC 4xx DCR's value
884 setdcr - Set an AMCC PPC 4xx DCR's value
885 getidcr - Get a register value via indirect DCR addressing
886 setidcr - Set a register value via indirect DCR addressing
892 This provides basic access to the U-Boot's sound support. The main
893 feature is to play a beep.
895 sound init - set up sound system
896 sound play - play a sound
902 This provides access to the QEMU firmware interface. The main
903 feature is to allow easy loading of files passed to qemu-system
904 via -kernel / -initrd
906 source "cmd/mvebu/Kconfig"
911 bool "Enable the 'bootstage' command"
914 Add a 'bootstage' command which supports printing a report
915 and un/stashing of bootstage data.
917 menu "Power commands"
919 bool "Enable Driver Model PMIC command"
922 This is the pmic command, based on a driver model pmic's API.
923 Command features are unchanged:
924 - list - list pmic devices
925 - pmic dev <id> - show or [set] operating pmic device (NEW)
926 - pmic dump - dump registers
927 - pmic read address - read byte of register at address
928 - pmic write address - write byte to register at address
929 The only one change for this command is 'dev' subcommand.
932 bool "Enable Driver Model REGULATOR command"
933 depends on DM_REGULATOR
935 This command is based on driver model regulator's API.
936 User interface features:
937 - list - list regulator devices
938 - regulator dev <id> - show or [set] operating regulator device
939 - regulator info - print constraints info
940 - regulator status - print operating status
941 - regulator value <val] <-f> - print/[set] voltage value [uV]
942 - regulator current <val> - print/[set] current value [uA]
943 - regulator mode <id> - print/[set] operating mode id
944 - regulator enable - enable the regulator output
945 - regulator disable - disable the regulator output
947 The '-f' (force) option can be used for set the value which exceeds
948 the limits, which are found in device-tree and are kept in regulator's
949 uclass platdata structure.
953 menu "Security commands"
955 bool "Enable the 'aes' command"
958 This provides a means to encrypt and decrypt data using the AES
959 (Advanced Encryption Standard). This algorithm uses a symetric key
960 and is widely used as a streaming cipher. Different key lengths are
961 supported by the algorithm but this command only supports 128 bits
965 bool "Enable the 'blob' command"
967 This is used with the Freescale secure boot mechanism.
969 Freescale's SEC block has built-in Blob Protocol which provides
970 a method for protecting user-defined data across system power
971 cycles. SEC block protects data in a data structure called a Blob,
972 which provides both confidentiality and integrity protection.
974 Encapsulating data as a blob
975 Each time that the Blob Protocol is used to protect data, a
976 different randomly generated key is used to encrypt the data.
977 This random key is itself encrypted using a key which is derived
978 from SoC's non-volatile secret key and a 16 bit Key identifier.
979 The resulting encrypted key along with encrypted data is called a
980 blob. The non-volatile secure key is available for use only during
983 During decapsulation, the reverse process is performed to get back
987 blob enc - encapsulating data as a cryptgraphic blob
988 blob dec - decapsulating cryptgraphic blob to get the data
992 blob enc src dst len km
994 Encapsulate and create blob of data $len bytes long
995 at address $src and store the result at address $dst.
996 $km is the 16 byte key modifier is also required for
997 generation/use as key for cryptographic operation. Key
998 modifier should be 16 byte long.
1000 blob dec src dst len km
1002 Decapsulate the blob of data at address $src and
1003 store result of $len byte at addr $dst.
1004 $km is the 16 byte key modifier is also required for
1005 generation/use as key for cryptographic operation. Key
1006 modifier should be 16 byte long.
1009 bool "Support 'hash' command"
1012 This provides a way to hash data in memory using various supported
1013 algorithms (such as SHA1, MD5, CRC32). The computed digest can be
1014 saved to memory or to an environment variable. It is also possible
1015 to verify a hash against data in memory.
1018 bool "Enable the 'tpm' command"
1021 This provides a means to talk to a TPM from the command line. A wide
1022 range of commands if provided - see 'tpm help' for details. The
1023 command requires a suitable TPM on your board and the correct driver
1027 bool "Enable the 'tpm test' command"
1030 This provides a a series of tests to confirm that the TPM is working
1031 correctly. The tests cover initialisation, non-volatile RAM, extend,
1032 global lock and checking that timing is within expectations. The
1033 tests pass correctly on Infineon TPMs but may need to be adjusted
1038 menu "Firmware commands"
1040 bool "Enable crosec command"
1044 Enable command-line access to the Chrome OS EC (Embedded
1045 Controller). This provides the 'crosec' command which has
1046 a number of sub-commands for performing EC tasks such as
1047 updating its flash, accessing a small saved context area
1048 and talking to the I2C bus behind the EC (if there is one).
1051 menu "Filesystem commands"
1053 bool "Enable the 'cbfs' command"
1056 Define this to enable support for reading from a Coreboot
1057 filesystem. This is a ROM-based filesystem used for accessing files
1058 on systems that use coreboot as the first boot-loader and then load
1059 U-Boot to actually boot the Operating System. Available commands are
1060 cbfsinit, cbfsinfo, cbfsls and cbfsload.
1063 bool "Enable the 'cramfs' command"
1064 depends on FS_CRAMFS
1066 This provides commands for dealing with CRAMFS (Compressed ROM
1067 filesystem). CRAMFS is useful when space is tight since files are
1068 compressed. Two commands are provided:
1070 cramfsls - lists files in a cramfs image
1071 cramfsload - loads a file from a cramfs image
1074 bool "ext2 command support"
1076 Enables EXT2 FS command
1079 bool "ext4 command support"
1081 Enables EXT4 FS command
1083 config CMD_EXT4_WRITE
1085 bool "ext4 write command support"
1087 Enables EXT4 FS write command
1090 bool "FAT command support"
1092 Support for the FAT fs
1094 config CMD_FS_GENERIC
1095 bool "filesystem commands"
1097 Enables filesystem commands (e.g. load, ls) that work for multiple
1101 bool "fsuuid command"
1103 Enables fsuuid command for filesystem UUID.
1106 depends on ARCH_SUNXI
1107 bool "MTD partition support"
1109 MTD partition support
1111 config MTDIDS_DEFAULT
1112 string "Default MTD IDs"
1113 depends on CMD_MTDPARTS
1115 Defines a default MTD ID
1117 config MTDPARTS_DEFAULT
1118 string "Default MTD partition scheme"
1119 depends on CMD_MTDPARTS
1121 Defines a default MTD partitioning scheme in the Linux MTD command
1122 line partitions format
1126 menu "Debug commands"
1131 The bedbug (emBEDded deBUGger) command provides debugging features
1132 for some PowerPC processors. For details please see the
1133 docuemntation in doc/README.beddbug
1136 bool "diag - Board diagnostics"
1138 This command provides access to board diagnostic tests. These are
1139 called Power-on Self Tests (POST). The command allows listing of
1140 available tests and running either all the tests, or specific tests
1146 tristate "Enable UBI - Unsorted block images commands"
1149 default y if NAND_SUNXI
1151 UBI is a software layer above MTD layer which admits use of LVM-like
1152 logical volumes on top of MTD devices, hides some complexities of
1153 flash chips like wear and bad blocks and provides some other useful
1154 capabilities. Please, consult the MTD web site for more details
1155 (www.linux-mtd.infradead.org). Activate this option if you want
1156 to use U-Boot UBI commands.
1159 tristate "Enable UBIFS - Unsorted block images filesystem commands"
1162 select RBTREE if ARCH_SUNXI
1163 select LZO if ARCH_SUNXI
1164 default y if NAND_SUNXI
1166 UBIFS is a file system for flash devices which works on top of UBI.