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
491 Load a binary file over serial line.
497 Load an S-Record file over serial line
500 bool "flinfo, erase, protect"
504 flinfo - print FLASH memory information
506 protect - enable or disable FLASH write protection
509 bool "GPT (GUID Partition Table) command"
510 select PARTITION_UUIDS
513 Enable the 'gpt' command to ready and write GPT style partition
517 #depends on FLASH_CFI_DRIVER
520 ARM Ltd reference designs flash partition access
525 MMC memory mapped support.
529 default y if NAND_SUNXI
534 config CMD_NAND_TRIMFFS
535 bool "nand write.trimffs"
536 default y if ARCH_SUNXI
538 Allows one to skip empty pages when flashing something on a NAND.
540 config CMD_NAND_LOCK_UNLOCK
541 bool "nand lock/unlock"
543 NAND locking support.
545 config CMD_NAND_TORTURE
548 NAND torture support.
554 select PARTITION_UUIDS
556 Read and display information about the partition table on
581 select USB_FUNCTION_DFU
583 Enables the command "dfu" which is used to have U-Boot create a DFU
584 class device via USB.
586 config CMD_USB_MASS_STORAGE
587 bool "UMS usb mass storage"
589 USB mass storage support
597 config CMD_FPGA_LOADBP
598 bool "fpga loadbp - load partial bitstream (Xilinx only)"
601 Supports loading an FPGA device from a bitstream buffer containing
604 config CMD_FPGA_LOADFS
605 bool "fpga loadfs - load bitstream from FAT filesystem (Xilinx only)"
608 Supports loading an FPGA device from a FAT filesystem.
610 config CMD_FPGA_LOADMK
611 bool "fpga loadmk - load bitstream from image"
614 Supports loading an FPGA device from a image generated by mkimage.
616 config CMD_FPGA_LOADP
617 bool "fpga loadp - load partial bitstream"
620 Supports loading an FPGA device from a bitstream buffer containing
624 bool "fpgad - dump FPGA registers"
626 (legacy, needs conversion to driver model)
627 Provides a way to dump FPGA registers by calling the board-specific
628 fpga_get_reg() function. This functions similarly to the 'md'
632 bool "fuse - support for the fuse subssystem"
634 (deprecated - needs conversion to driver model)
635 This allows reading, sensing, programming or overriding fuses
636 which control the behaviour of the device. The command uses the
639 config CMD_REMOTEPROC
641 depends on REMOTEPROC
643 Support for Remote Processor control
651 bool "fdcboot - Boot from floppy device"
653 The 'fdtboot' command allows booting an image from a floppy disk.
658 menu "Shell scripting commands"
670 Return true/false on integer compare.
676 Run script from memory
682 Evaluate boolean and math expressions and store the result in an env
684 Also supports loading the value at a memory location into a variable.
685 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
689 menu "Network commands"
692 bool "bootp, tftpboot"
697 bootp - boot image via network using BOOTP/TFTP protocol
698 tftpboot - boot image via network using TFTP protocol
703 TFTP put command, for uploading files to a server
708 Act as a TFTP server and boot the first received file
713 Boot image via network using RARP/TFTP protocol
718 Boot image via network using DHCP/TFTP protocol
724 Boot image via network using PXE protocol
730 Boot image via network using NFS protocol.
735 Enable MII utility commands.
740 Send ICMP ECHO_REQUEST to network host
745 Perform CDP network configuration
750 Synchronize RTC via network
755 Lookup the IP of a hostname
757 config CMD_LINK_LOCAL
760 Acquire a network IP address using the link-local protocol
765 Allow control of L2 Ethernet switch commands. These are supported
766 by the vsc9953 Ethernet driver at present. Sub-commands allow
767 operations such as enabling / disabling a port and
768 viewing/maintaining the filtering database (FDB)
775 bool "Enable 'bmp' command"
776 depends on LCD || DM_VIDEO || VIDEO
778 This provides a way to obtain information about a BMP-format iamge
779 and to display it. BMP (which presumably stands for BitMaP) is a
780 file format defined by Microsoft which supports images of various
781 depths, formats and compression methods. Headers on the file
782 determine the formats used. This command can be used by first loading
783 the image into RAM, then using this command to look at it or display
787 bool "Enable board-specific commands"
789 (deprecated: instead, please define a Kconfig option for each command)
791 Some boards have board-specific commands which are only enabled
792 during developemnt and need to be turned off for production. This
793 option provides a way to control this. The commands that are enabled
794 vary depending on the board.
796 config CMD_BKOPS_ENABLE
797 bool "mmc bkops enable"
801 Enable command for setting manual background operations handshake
802 on a eMMC device. The feature is optionally available on eMMC devices
803 conforming to standard >= 4.41.
805 config CMD_BLOCK_CACHE
806 bool "blkcache - control and stats for block cache"
807 depends on BLOCK_CACHE
808 default y if BLOCK_CACHE
810 Enable the blkcache command, which can be used to control the
811 operation of the cache functions.
812 This is most useful when fine-tuning the operation of the cache
813 during development, but also allows the cache to be disabled when
814 it might hurt performance (e.g. when using the ums command).
817 bool "icache or dcache"
819 Enable the "icache" and "dcache" commands
822 bool "Enable the 'display' command, for character displays"
824 (this needs porting to driver model)
825 This enables the 'display' command which allows a string to be
826 displayed on a simple board-specific display. Implement
827 display_putc() to use it.
833 Enable the 'led' command which allows for control of LEDs supported
834 by the board. The LEDs can be listed with 'led list' and controlled
835 with led on/off/togle/blink. Any LED drivers can be controlled with
836 this command, e.g. led_gpio.
842 Enable the 'date' command for getting/setting the time/date in RTC
848 Run commands and summarize execution time.
851 bool "gettime - read elapsed time"
853 Enable the 'gettime' command which reads the elapsed time since
854 U-Boot started running. This shows the time in seconds and
855 milliseconds. See also the 'bootstage' command which provides more
856 flexibility for boot timing.
858 # TODO: rename to CMD_SLEEP
863 Delay execution for some time
868 Access the system timer.
871 bool "getdcr, setdcr, getidcr, setidcr"
875 getdcr - Get an AMCC PPC 4xx DCR's value
876 setdcr - Set an AMCC PPC 4xx DCR's value
877 getidcr - Get a register value via indirect DCR addressing
878 setidcr - Set a register value via indirect DCR addressing
884 This provides basic access to the U-Boot's sound support. The main
885 feature is to play a beep.
887 sound init - set up sound system
888 sound play - play a sound
894 This provides access to the QEMU firmware interface. The main
895 feature is to allow easy loading of files passed to qemu-system
896 via -kernel / -initrd
898 source "cmd/mvebu/Kconfig"
903 bool "Enable the 'bootstage' command"
906 Add a 'bootstage' command which supports printing a report
907 and un/stashing of bootstage data.
909 menu "Power commands"
911 bool "Enable Driver Model PMIC command"
914 This is the pmic command, based on a driver model pmic's API.
915 Command features are unchanged:
916 - list - list pmic devices
917 - pmic dev <id> - show or [set] operating pmic device (NEW)
918 - pmic dump - dump registers
919 - pmic read address - read byte of register at address
920 - pmic write address - write byte to register at address
921 The only one change for this command is 'dev' subcommand.
924 bool "Enable Driver Model REGULATOR command"
925 depends on DM_REGULATOR
927 This command is based on driver model regulator's API.
928 User interface features:
929 - list - list regulator devices
930 - regulator dev <id> - show or [set] operating regulator device
931 - regulator info - print constraints info
932 - regulator status - print operating status
933 - regulator value <val] <-f> - print/[set] voltage value [uV]
934 - regulator current <val> - print/[set] current value [uA]
935 - regulator mode <id> - print/[set] operating mode id
936 - regulator enable - enable the regulator output
937 - regulator disable - disable the regulator output
939 The '-f' (force) option can be used for set the value which exceeds
940 the limits, which are found in device-tree and are kept in regulator's
941 uclass platdata structure.
945 menu "Security commands"
947 bool "Enable the 'aes' command"
950 This provides a means to encrypt and decrypt data using the AES
951 (Advanced Encryption Standard). This algorithm uses a symetric key
952 and is widely used as a streaming cipher. Different key lengths are
953 supported by the algorithm but this command only supports 128 bits
957 bool "Enable the 'blob' command"
959 This is used with the Freescale secure boot mechanism.
961 Freescale's SEC block has built-in Blob Protocol which provides
962 a method for protecting user-defined data across system power
963 cycles. SEC block protects data in a data structure called a Blob,
964 which provides both confidentiality and integrity protection.
966 Encapsulating data as a blob
967 Each time that the Blob Protocol is used to protect data, a
968 different randomly generated key is used to encrypt the data.
969 This random key is itself encrypted using a key which is derived
970 from SoC's non-volatile secret key and a 16 bit Key identifier.
971 The resulting encrypted key along with encrypted data is called a
972 blob. The non-volatile secure key is available for use only during
975 During decapsulation, the reverse process is performed to get back
979 blob enc - encapsulating data as a cryptgraphic blob
980 blob dec - decapsulating cryptgraphic blob to get the data
984 blob enc src dst len km
986 Encapsulate and create blob of data $len bytes long
987 at address $src and store the result at address $dst.
988 $km is the 16 byte key modifier is also required for
989 generation/use as key for cryptographic operation. Key
990 modifier should be 16 byte long.
992 blob dec src dst len km
994 Decapsulate the blob of data at address $src and
995 store result of $len byte at addr $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.
1001 bool "Support 'hash' command"
1004 This provides a way to hash data in memory using various supported
1005 algorithms (such as SHA1, MD5, CRC32). The computed digest can be
1006 saved to memory or to an environment variable. It is also possible
1007 to verify a hash against data in memory.
1010 bool "Enable the 'tpm' command"
1013 This provides a means to talk to a TPM from the command line. A wide
1014 range of commands if provided - see 'tpm help' for details. The
1015 command requires a suitable TPM on your board and the correct driver
1019 bool "Enable the 'tpm test' command"
1022 This provides a a series of tests to confirm that the TPM is working
1023 correctly. The tests cover initialisation, non-volatile RAM, extend,
1024 global lock and checking that timing is within expectations. The
1025 tests pass correctly on Infineon TPMs but may need to be adjusted
1030 menu "Firmware commands"
1032 bool "Enable crosec command"
1036 Enable command-line access to the Chrome OS EC (Embedded
1037 Controller). This provides the 'crosec' command which has
1038 a number of sub-commands for performing EC tasks such as
1039 updating its flash, accessing a small saved context area
1040 and talking to the I2C bus behind the EC (if there is one).
1043 menu "Filesystem commands"
1045 bool "Enable the 'cbfs' command"
1048 Define this to enable support for reading from a Coreboot
1049 filesystem. This is a ROM-based filesystem used for accessing files
1050 on systems that use coreboot as the first boot-loader and then load
1051 U-Boot to actually boot the Operating System. Available commands are
1052 cbfsinit, cbfsinfo, cbfsls and cbfsload.
1055 bool "Enable the 'cramfs' command"
1056 depends on FS_CRAMFS
1058 This provides commands for dealing with CRAMFS (Compressed ROM
1059 filesystem). CRAMFS is useful when space is tight since files are
1060 compressed. Two commands are provided:
1062 cramfsls - lists files in a cramfs image
1063 cramfsload - loads a file from a cramfs image
1066 bool "ext2 command support"
1068 Enables EXT2 FS command
1071 bool "ext4 command support"
1073 Enables EXT4 FS command
1075 config CMD_EXT4_WRITE
1077 bool "ext4 write command support"
1079 Enables EXT4 FS write command
1082 bool "FAT command support"
1084 Support for the FAT fs
1086 config CMD_FS_GENERIC
1087 bool "filesystem commands"
1089 Enables filesystem commands (e.g. load, ls) that work for multiple
1093 bool "fsuuid command"
1095 Enables fsuuid command for filesystem UUID.
1098 depends on ARCH_SUNXI
1099 bool "MTD partition support"
1101 MTD partition support
1103 config MTDIDS_DEFAULT
1104 string "Default MTD IDs"
1105 depends on CMD_MTDPARTS
1107 Defines a default MTD ID
1109 config MTDPARTS_DEFAULT
1110 string "Default MTD partition scheme"
1111 depends on CMD_MTDPARTS
1113 Defines a default MTD partitioning scheme in the Linux MTD command
1114 line partitions format
1118 menu "Debug commands"
1123 The bedbug (emBEDded deBUGger) command provides debugging features
1124 for some PowerPC processors. For details please see the
1125 docuemntation in doc/README.beddbug
1128 bool "diag - Board diagnostics"
1130 This command provides access to board diagnostic tests. These are
1131 called Power-on Self Tests (POST). The command allows listing of
1132 available tests and running either all the tests, or specific tests
1138 tristate "Enable UBI - Unsorted block images commands"
1141 default y if NAND_SUNXI
1143 UBI is a software layer above MTD layer which admits use of LVM-like
1144 logical volumes on top of MTD devices, hides some complexities of
1145 flash chips like wear and bad blocks and provides some other useful
1146 capabilities. Please, consult the MTD web site for more details
1147 (www.linux-mtd.infradead.org). Activate this option if you want
1148 to use U-Boot UBI commands.
1151 tristate "Enable UBIFS - Unsorted block images filesystem commands"
1154 select RBTREE if ARCH_SUNXI
1155 select LZO if ARCH_SUNXI
1156 default y if NAND_SUNXI
1158 UBIFS is a file system for flash devices which works on top of UBI.