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
342 bool "eeprom - EEPROM subsystem"
344 (deprecated, needs conversion to driver model)
345 Provides commands to read and write EEPROM (Electrically Erasable
346 Programmable Read Only Memory) chips that are connected over an
349 config CMD_EEPROM_LAYOUT
350 bool "Enable layout-aware eeprom commands"
351 depends on CMD_EEPROM
353 (deprecated, needs conversion to driver model)
354 When enabled, additional eeprom sub-commands become available.
356 eeprom print - prints the contents of the eeprom in a human-readable
357 way (eeprom layout fields, and data formatted to be fit for human
360 eeprom update - allows user to update eeprom fields by specifying
361 the field name, and providing the new data in a human readable format
362 (same format as displayed by the eeprom print command).
364 Both commands can either auto detect the layout, or be told which
368 __weak int parse_layout_version(char *str)
369 - override to provide your own layout name parsing
370 __weak void __eeprom_layout_assign(struct eeprom_layout *layout,
372 - override to setup the layout metadata based on the version
373 __weak int eeprom_layout_detect(unsigned char *data)
374 - override to provide your own algorithm for detecting layout
377 - contains various printing and updating functions for common
378 types of eeprom fields. Can be used for defining
381 config EEPROM_LAYOUT_HELP_STRING
382 string "Tells user what layout names are supported"
383 depends on CMD_EEPROM_LAYOUT
384 default "<not defined>"
386 Help printed with the LAYOUT VERSIONS part of the 'eeprom'
394 Compute MD5 checksum.
399 depends on CMD_MD5SUM
401 Add -v option to verify data against an MD5 checksum.
406 Infinite write loop on address range
411 Simple RAM read/write test.
416 mdc - memory display cyclic
417 mwc - memory write cyclic
422 Display memory information.
427 Uncompress a zip-compressed memory region.
432 Compress a memory region with zlib deflate method.
436 menu "Device access commands"
439 bool "clk - Show clock frequencies"
442 Shows clock frequences by calling a sock_clk_dump() hook function.
443 This is depreated in favour of using the CLK uclass and accessing
444 clock values from associated drivers. However currently no command
448 bool "dm - Access to driver model information"
452 Provides access to driver model data structures and information,
453 such as a list of devices, list of uclasses and the state of each
454 device (e.g. activated). This is not required for operation, but
455 can be useful to see the state of driver model for debugging or
459 bool "demo - Demonstration commands for driver model"
462 Provides a 'demo' command which can be used to play around with
463 driver model. To use this properly you will need to enable one or
464 both of the demo devices (DM_DEMO_SHAPE and DM_DEMO_SIMPLE).
465 Otherwise you will always get an empty list of devices. The demo
466 devices are defined in the sandbox device tree, so the easiest
467 option is to use sandbox and pass the -d point to sandbox's
474 Load a binary file over serial line.
480 Load an S-Record file over serial line
483 bool "flinfo, erase, protect"
487 flinfo - print FLASH memory information
489 protect - enable or disable FLASH write protection
492 bool "GPT (GUID Partition Table) command"
493 select PARTITION_UUIDS
496 Enable the 'gpt' command to ready and write GPT style partition
500 #depends on FLASH_CFI_DRIVER
503 ARM Ltd reference designs flash partition access
508 MMC memory mapped support.
512 default y if NAND_SUNXI
517 config CMD_NAND_TRIMFFS
518 bool "nand write.trimffs"
519 default y if ARCH_SUNXI
521 Allows one to skip empty pages when flashing something on a NAND.
523 config CMD_NAND_LOCK_UNLOCK
524 bool "nand lock/unlock"
526 NAND locking support.
528 config CMD_NAND_TORTURE
531 NAND torture support.
537 select PARTITION_UUIDS
539 Read and display information about the partition table on
564 select USB_FUNCTION_DFU
566 Enables the command "dfu" which is used to have U-Boot create a DFU
567 class device via USB.
569 config CMD_USB_MASS_STORAGE
570 bool "UMS usb mass storage"
572 USB mass storage support
580 config CMD_REMOTEPROC
582 depends on REMOTEPROC
584 Support for Remote Processor control
594 menu "Shell scripting commands"
606 Return true/false on integer compare.
612 Run script from memory
618 Evaluate boolean and math expressions and store the result in an env
620 Also supports loading the value at a memory location into a variable.
621 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
625 menu "Network commands"
628 bool "bootp, tftpboot"
633 bootp - boot image via network using BOOTP/TFTP protocol
634 tftpboot - boot image via network using TFTP protocol
639 TFTP put command, for uploading files to a server
644 Act as a TFTP server and boot the first received file
649 Boot image via network using RARP/TFTP protocol
654 Boot image via network using DHCP/TFTP protocol
660 Boot image via network using PXE protocol
666 Boot image via network using NFS protocol.
671 Enable MII utility commands.
676 Send ICMP ECHO_REQUEST to network host
681 Perform CDP network configuration
686 Synchronize RTC via network
691 Lookup the IP of a hostname
693 config CMD_LINK_LOCAL
696 Acquire a network IP address using the link-local protocol
703 bool "Enable 'bmp' command"
704 depends on LCD || DM_VIDEO || VIDEO
706 This provides a way to obtain information about a BMP-format iamge
707 and to display it. BMP (which presumably stands for BitMaP) is a
708 file format defined by Microsoft which supports images of various
709 depths, formats and compression methods. Headers on the file
710 determine the formats used. This command can be used by first loading
711 the image into RAM, then using this command to look at it or display
715 bool "Enable board-specific commands"
717 (deprecated: instead, please define a Kconfig option for each command)
719 Some boards have board-specific commands which are only enabled
720 during developemnt and need to be turned off for production. This
721 option provides a way to control this. The commands that are enabled
722 vary depending on the board.
724 config CMD_BKOPS_ENABLE
725 bool "mmc bkops enable"
729 Enable command for setting manual background operations handshake
730 on a eMMC device. The feature is optionally available on eMMC devices
731 conforming to standard >= 4.41.
733 config CMD_BLOCK_CACHE
734 bool "blkcache - control and stats for block cache"
735 depends on BLOCK_CACHE
736 default y if BLOCK_CACHE
738 Enable the blkcache command, which can be used to control the
739 operation of the cache functions.
740 This is most useful when fine-tuning the operation of the cache
741 during development, but also allows the cache to be disabled when
742 it might hurt performance (e.g. when using the ums command).
745 bool "icache or dcache"
747 Enable the "icache" and "dcache" commands
750 bool "Enable the 'display' command, for character displays"
752 (this needs porting to driver model)
753 This enables the 'display' command which allows a string to be
754 displayed on a simple board-specific display. Implement
755 display_putc() to use it.
761 Enable the 'led' command which allows for control of LEDs supported
762 by the board. The LEDs can be listed with 'led list' and controlled
763 with led on/off/togle/blink. Any LED drivers can be controlled with
764 this command, e.g. led_gpio.
770 Enable the 'date' command for getting/setting the time/date in RTC
776 Run commands and summarize execution time.
778 # TODO: rename to CMD_SLEEP
783 Delay execution for some time
788 Access the system timer.
791 bool "getdcr, setdcr, getidcr, setidcr"
795 getdcr - Get an AMCC PPC 4xx DCR's value
796 setdcr - Set an AMCC PPC 4xx DCR's value
797 getidcr - Get a register value via indirect DCR addressing
798 setidcr - Set a register value via indirect DCR addressing
804 This provides basic access to the U-Boot's sound support. The main
805 feature is to play a beep.
807 sound init - set up sound system
808 sound play - play a sound
814 This provides access to the QEMU firmware interface. The main
815 feature is to allow easy loading of files passed to qemu-system
816 via -kernel / -initrd
818 source "cmd/mvebu/Kconfig"
823 bool "Enable the 'bootstage' command"
826 Add a 'bootstage' command which supports printing a report
827 and un/stashing of bootstage data.
829 menu "Power commands"
831 bool "Enable Driver Model PMIC command"
834 This is the pmic command, based on a driver model pmic's API.
835 Command features are unchanged:
836 - list - list pmic devices
837 - pmic dev <id> - show or [set] operating pmic device (NEW)
838 - pmic dump - dump registers
839 - pmic read address - read byte of register at address
840 - pmic write address - write byte to register at address
841 The only one change for this command is 'dev' subcommand.
844 bool "Enable Driver Model REGULATOR command"
845 depends on DM_REGULATOR
847 This command is based on driver model regulator's API.
848 User interface features:
849 - list - list regulator devices
850 - regulator dev <id> - show or [set] operating regulator device
851 - regulator info - print constraints info
852 - regulator status - print operating status
853 - regulator value <val] <-f> - print/[set] voltage value [uV]
854 - regulator current <val> - print/[set] current value [uA]
855 - regulator mode <id> - print/[set] operating mode id
856 - regulator enable - enable the regulator output
857 - regulator disable - disable the regulator output
859 The '-f' (force) option can be used for set the value which exceeds
860 the limits, which are found in device-tree and are kept in regulator's
861 uclass platdata structure.
865 menu "Security commands"
867 bool "Enable the 'aes' command"
870 This provides a means to encrypt and decrypt data using the AES
871 (Advanced Encryption Standard). This algorithm uses a symetric key
872 and is widely used as a streaming cipher. Different key lengths are
873 supported by the algorithm but this command only supports 128 bits
877 bool "Enable the 'blob' command"
879 This is used with the Freescale secure boot mechanism.
881 Freescale's SEC block has built-in Blob Protocol which provides
882 a method for protecting user-defined data across system power
883 cycles. SEC block protects data in a data structure called a Blob,
884 which provides both confidentiality and integrity protection.
886 Encapsulating data as a blob
887 Each time that the Blob Protocol is used to protect data, a
888 different randomly generated key is used to encrypt the data.
889 This random key is itself encrypted using a key which is derived
890 from SoC's non-volatile secret key and a 16 bit Key identifier.
891 The resulting encrypted key along with encrypted data is called a
892 blob. The non-volatile secure key is available for use only during
895 During decapsulation, the reverse process is performed to get back
899 blob enc - encapsulating data as a cryptgraphic blob
900 blob dec - decapsulating cryptgraphic blob to get the data
904 blob enc src dst len km
906 Encapsulate and create blob of data $len bytes long
907 at address $src and store the result at address $dst.
908 $km is the 16 byte key modifier is also required for
909 generation/use as key for cryptographic operation. Key
910 modifier should be 16 byte long.
912 blob dec src dst len km
914 Decapsulate the blob of data at address $src and
915 store result of $len byte at addr $dst.
916 $km is the 16 byte key modifier is also required for
917 generation/use as key for cryptographic operation. Key
918 modifier should be 16 byte long.
921 bool "Enable the 'tpm' command"
924 This provides a means to talk to a TPM from the command line. A wide
925 range of commands if provided - see 'tpm help' for details. The
926 command requires a suitable TPM on your board and the correct driver
930 bool "Enable the 'tpm test' command"
933 This provides a a series of tests to confirm that the TPM is working
934 correctly. The tests cover initialisation, non-volatile RAM, extend,
935 global lock and checking that timing is within expectations. The
936 tests pass correctly on Infineon TPMs but may need to be adjusted
941 menu "Firmware commands"
943 bool "Enable crosec command"
947 Enable command-line access to the Chrome OS EC (Embedded
948 Controller). This provides the 'crosec' command which has
949 a number of sub-commands for performing EC tasks such as
950 updating its flash, accessing a small saved context area
951 and talking to the I2C bus behind the EC (if there is one).
954 menu "Filesystem commands"
956 bool "Enable the 'cbfs' command"
959 Define this to enable support for reading from a Coreboot
960 filesystem. This is a ROM-based filesystem used for accessing files
961 on systems that use coreboot as the first boot-loader and then load
962 U-Boot to actually boot the Operating System. Available commands are
963 cbfsinit, cbfsinfo, cbfsls and cbfsload.
966 bool "Enable the 'cramfs' command"
969 This provides commands for dealing with CRAMFS (Compressed ROM
970 filesystem). CRAMFS is useful when space is tight since files are
971 compressed. Two commands are provided:
973 cramfsls - lists files in a cramfs image
974 cramfsload - loads a file from a cramfs image
977 bool "ext2 command support"
979 Enables EXT2 FS command
982 bool "ext4 command support"
984 Enables EXT4 FS command
986 config CMD_EXT4_WRITE
988 bool "ext4 write command support"
990 Enables EXT4 FS write command
993 bool "FAT command support"
995 Support for the FAT fs
997 config CMD_FS_GENERIC
998 bool "filesystem commands"
1000 Enables filesystem commands (e.g. load, ls) that work for multiple
1004 bool "fsuuid command"
1006 Enables fsuuid command for filesystem UUID.
1009 depends on ARCH_SUNXI
1010 bool "MTD partition support"
1012 MTD partition support
1014 config MTDIDS_DEFAULT
1015 string "Default MTD IDs"
1016 depends on CMD_MTDPARTS
1018 Defines a default MTD ID
1020 config MTDPARTS_DEFAULT
1021 string "Default MTD partition scheme"
1022 depends on CMD_MTDPARTS
1024 Defines a default MTD partitioning scheme in the Linux MTD command
1025 line partitions format
1029 menu "Debug commands"
1034 The bedbug (emBEDded deBUGger) command provides debugging features
1035 for some PowerPC processors. For details please see the
1036 docuemntation in doc/README.beddbug
1039 bool "diag - Board diagnostics"
1041 This command provides access to board diagnostic tests. These are
1042 called Power-on Self Tests (POST). The command allows listing of
1043 available tests and running either all the tests, or specific tests
1049 tristate "Enable UBI - Unsorted block images commands"
1052 default y if NAND_SUNXI
1054 UBI is a software layer above MTD layer which admits use of LVM-like
1055 logical volumes on top of MTD devices, hides some complexities of
1056 flash chips like wear and bad blocks and provides some other useful
1057 capabilities. Please, consult the MTD web site for more details
1058 (www.linux-mtd.infradead.org). Activate this option if you want
1059 to use U-Boot UBI commands.
1062 tristate "Enable UBIFS - Unsorted block images filesystem commands"
1065 select RBTREE if ARCH_SUNXI
1066 select LZO if ARCH_SUNXI
1067 default y if NAND_SUNXI
1069 UBIFS is a file system for flash devices which works on top of UBI.