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.
327 menu "Memory commands"
330 bool "md, mm, nm, mw, cp, cmp, base, loop"
335 mm - memory modify (auto-incrementing address)
336 nm - memory modify (constant address)
337 mw - memory write (fill)
340 base - print or set address offset
341 loop - initialize loop on address range
350 bool "eeprom - EEPROM subsystem"
352 (deprecated, needs conversion to driver model)
353 Provides commands to read and write EEPROM (Electrically Erasable
354 Programmable Read Only Memory) chips that are connected over an
357 config CMD_EEPROM_LAYOUT
358 bool "Enable layout-aware eeprom commands"
359 depends on CMD_EEPROM
361 (deprecated, needs conversion to driver model)
362 When enabled, additional eeprom sub-commands become available.
364 eeprom print - prints the contents of the eeprom in a human-readable
365 way (eeprom layout fields, and data formatted to be fit for human
368 eeprom update - allows user to update eeprom fields by specifying
369 the field name, and providing the new data in a human readable format
370 (same format as displayed by the eeprom print command).
372 Both commands can either auto detect the layout, or be told which
376 __weak int parse_layout_version(char *str)
377 - override to provide your own layout name parsing
378 __weak void __eeprom_layout_assign(struct eeprom_layout *layout,
380 - override to setup the layout metadata based on the version
381 __weak int eeprom_layout_detect(unsigned char *data)
382 - override to provide your own algorithm for detecting layout
385 - contains various printing and updating functions for common
386 types of eeprom fields. Can be used for defining
389 config EEPROM_LAYOUT_HELP_STRING
390 string "Tells user what layout names are supported"
391 depends on CMD_EEPROM_LAYOUT
392 default "<not defined>"
394 Help printed with the LAYOUT VERSIONS part of the 'eeprom'
402 Compute MD5 checksum.
407 depends on CMD_MD5SUM
409 Add -v option to verify data against an MD5 checksum.
414 Infinite write loop on address range
419 Simple RAM read/write test.
424 mdc - memory display cyclic
425 mwc - memory write cyclic
430 Display memory information.
435 Uncompress a zip-compressed memory region.
440 Compress a memory region with zlib deflate method.
444 menu "Device access commands"
447 bool "clk - Show clock frequencies"
450 Shows clock frequences by calling a sock_clk_dump() hook function.
451 This is depreated in favour of using the CLK uclass and accessing
452 clock values from associated drivers. However currently no command
456 bool "dm - Access to driver model information"
460 Provides access to driver model data structures and information,
461 such as a list of devices, list of uclasses and the state of each
462 device (e.g. activated). This is not required for operation, but
463 can be useful to see the state of driver model for debugging or
467 bool "demo - Demonstration commands for driver model"
470 Provides a 'demo' command which can be used to play around with
471 driver model. To use this properly you will need to enable one or
472 both of the demo devices (DM_DEMO_SHAPE and DM_DEMO_SIMPLE).
473 Otherwise you will always get an empty list of devices. The demo
474 devices are defined in the sandbox device tree, so the easiest
475 option is to use sandbox and pass the -d point to sandbox's
482 Load a binary file over serial line.
488 Load an S-Record file over serial line
491 bool "flinfo, erase, protect"
495 flinfo - print FLASH memory information
497 protect - enable or disable FLASH write protection
500 bool "GPT (GUID Partition Table) command"
501 select PARTITION_UUIDS
504 Enable the 'gpt' command to ready and write GPT style partition
508 #depends on FLASH_CFI_DRIVER
511 ARM Ltd reference designs flash partition access
516 MMC memory mapped support.
520 default y if NAND_SUNXI
525 config CMD_NAND_TRIMFFS
526 bool "nand write.trimffs"
527 default y if ARCH_SUNXI
529 Allows one to skip empty pages when flashing something on a NAND.
531 config CMD_NAND_LOCK_UNLOCK
532 bool "nand lock/unlock"
534 NAND locking support.
536 config CMD_NAND_TORTURE
539 NAND torture support.
545 select PARTITION_UUIDS
547 Read and display information about the partition table on
572 select USB_FUNCTION_DFU
574 Enables the command "dfu" which is used to have U-Boot create a DFU
575 class device via USB.
577 config CMD_USB_MASS_STORAGE
578 bool "UMS usb mass storage"
580 USB mass storage support
588 config CMD_REMOTEPROC
590 depends on REMOTEPROC
592 Support for Remote Processor control
602 menu "Shell scripting commands"
614 Return true/false on integer compare.
620 Run script from memory
626 Evaluate boolean and math expressions and store the result in an env
628 Also supports loading the value at a memory location into a variable.
629 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
633 menu "Network commands"
636 bool "bootp, tftpboot"
641 bootp - boot image via network using BOOTP/TFTP protocol
642 tftpboot - boot image via network using TFTP protocol
647 TFTP put command, for uploading files to a server
652 Act as a TFTP server and boot the first received file
657 Boot image via network using RARP/TFTP protocol
662 Boot image via network using DHCP/TFTP protocol
668 Boot image via network using PXE protocol
674 Boot image via network using NFS protocol.
679 Enable MII utility commands.
684 Send ICMP ECHO_REQUEST to network host
689 Perform CDP network configuration
694 Synchronize RTC via network
699 Lookup the IP of a hostname
701 config CMD_LINK_LOCAL
704 Acquire a network IP address using the link-local protocol
711 bool "Enable 'bmp' command"
712 depends on LCD || DM_VIDEO || VIDEO
714 This provides a way to obtain information about a BMP-format iamge
715 and to display it. BMP (which presumably stands for BitMaP) is a
716 file format defined by Microsoft which supports images of various
717 depths, formats and compression methods. Headers on the file
718 determine the formats used. This command can be used by first loading
719 the image into RAM, then using this command to look at it or display
723 bool "Enable board-specific commands"
725 (deprecated: instead, please define a Kconfig option for each command)
727 Some boards have board-specific commands which are only enabled
728 during developemnt and need to be turned off for production. This
729 option provides a way to control this. The commands that are enabled
730 vary depending on the board.
732 config CMD_BKOPS_ENABLE
733 bool "mmc bkops enable"
737 Enable command for setting manual background operations handshake
738 on a eMMC device. The feature is optionally available on eMMC devices
739 conforming to standard >= 4.41.
741 config CMD_BLOCK_CACHE
742 bool "blkcache - control and stats for block cache"
743 depends on BLOCK_CACHE
744 default y if BLOCK_CACHE
746 Enable the blkcache command, which can be used to control the
747 operation of the cache functions.
748 This is most useful when fine-tuning the operation of the cache
749 during development, but also allows the cache to be disabled when
750 it might hurt performance (e.g. when using the ums command).
753 bool "icache or dcache"
755 Enable the "icache" and "dcache" commands
758 bool "Enable the 'display' command, for character displays"
760 (this needs porting to driver model)
761 This enables the 'display' command which allows a string to be
762 displayed on a simple board-specific display. Implement
763 display_putc() to use it.
769 Enable the 'led' command which allows for control of LEDs supported
770 by the board. The LEDs can be listed with 'led list' and controlled
771 with led on/off/togle/blink. Any LED drivers can be controlled with
772 this command, e.g. led_gpio.
778 Enable the 'date' command for getting/setting the time/date in RTC
784 Run commands and summarize execution time.
786 # TODO: rename to CMD_SLEEP
791 Delay execution for some time
796 Access the system timer.
799 bool "getdcr, setdcr, getidcr, setidcr"
803 getdcr - Get an AMCC PPC 4xx DCR's value
804 setdcr - Set an AMCC PPC 4xx DCR's value
805 getidcr - Get a register value via indirect DCR addressing
806 setidcr - Set a register value via indirect DCR addressing
812 This provides basic access to the U-Boot's sound support. The main
813 feature is to play a beep.
815 sound init - set up sound system
816 sound play - play a sound
822 This provides access to the QEMU firmware interface. The main
823 feature is to allow easy loading of files passed to qemu-system
824 via -kernel / -initrd
826 source "cmd/mvebu/Kconfig"
831 bool "Enable the 'bootstage' command"
834 Add a 'bootstage' command which supports printing a report
835 and un/stashing of bootstage data.
837 menu "Power commands"
839 bool "Enable Driver Model PMIC command"
842 This is the pmic command, based on a driver model pmic's API.
843 Command features are unchanged:
844 - list - list pmic devices
845 - pmic dev <id> - show or [set] operating pmic device (NEW)
846 - pmic dump - dump registers
847 - pmic read address - read byte of register at address
848 - pmic write address - write byte to register at address
849 The only one change for this command is 'dev' subcommand.
852 bool "Enable Driver Model REGULATOR command"
853 depends on DM_REGULATOR
855 This command is based on driver model regulator's API.
856 User interface features:
857 - list - list regulator devices
858 - regulator dev <id> - show or [set] operating regulator device
859 - regulator info - print constraints info
860 - regulator status - print operating status
861 - regulator value <val] <-f> - print/[set] voltage value [uV]
862 - regulator current <val> - print/[set] current value [uA]
863 - regulator mode <id> - print/[set] operating mode id
864 - regulator enable - enable the regulator output
865 - regulator disable - disable the regulator output
867 The '-f' (force) option can be used for set the value which exceeds
868 the limits, which are found in device-tree and are kept in regulator's
869 uclass platdata structure.
873 menu "Security commands"
875 bool "Enable the 'aes' command"
878 This provides a means to encrypt and decrypt data using the AES
879 (Advanced Encryption Standard). This algorithm uses a symetric key
880 and is widely used as a streaming cipher. Different key lengths are
881 supported by the algorithm but this command only supports 128 bits
885 bool "Enable the 'blob' command"
887 This is used with the Freescale secure boot mechanism.
889 Freescale's SEC block has built-in Blob Protocol which provides
890 a method for protecting user-defined data across system power
891 cycles. SEC block protects data in a data structure called a Blob,
892 which provides both confidentiality and integrity protection.
894 Encapsulating data as a blob
895 Each time that the Blob Protocol is used to protect data, a
896 different randomly generated key is used to encrypt the data.
897 This random key is itself encrypted using a key which is derived
898 from SoC's non-volatile secret key and a 16 bit Key identifier.
899 The resulting encrypted key along with encrypted data is called a
900 blob. The non-volatile secure key is available for use only during
903 During decapsulation, the reverse process is performed to get back
907 blob enc - encapsulating data as a cryptgraphic blob
908 blob dec - decapsulating cryptgraphic blob to get the data
912 blob enc src dst len km
914 Encapsulate and create blob of data $len bytes long
915 at address $src and store the result at address $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.
920 blob dec src dst len km
922 Decapsulate the blob of data at address $src and
923 store result of $len byte at addr $dst.
924 $km is the 16 byte key modifier is also required for
925 generation/use as key for cryptographic operation. Key
926 modifier should be 16 byte long.
929 bool "Enable the 'tpm' command"
932 This provides a means to talk to a TPM from the command line. A wide
933 range of commands if provided - see 'tpm help' for details. The
934 command requires a suitable TPM on your board and the correct driver
938 bool "Enable the 'tpm test' command"
941 This provides a a series of tests to confirm that the TPM is working
942 correctly. The tests cover initialisation, non-volatile RAM, extend,
943 global lock and checking that timing is within expectations. The
944 tests pass correctly on Infineon TPMs but may need to be adjusted
949 menu "Firmware commands"
951 bool "Enable crosec command"
955 Enable command-line access to the Chrome OS EC (Embedded
956 Controller). This provides the 'crosec' command which has
957 a number of sub-commands for performing EC tasks such as
958 updating its flash, accessing a small saved context area
959 and talking to the I2C bus behind the EC (if there is one).
962 menu "Filesystem commands"
964 bool "Enable the 'cbfs' command"
967 Define this to enable support for reading from a Coreboot
968 filesystem. This is a ROM-based filesystem used for accessing files
969 on systems that use coreboot as the first boot-loader and then load
970 U-Boot to actually boot the Operating System. Available commands are
971 cbfsinit, cbfsinfo, cbfsls and cbfsload.
974 bool "Enable the 'cramfs' command"
977 This provides commands for dealing with CRAMFS (Compressed ROM
978 filesystem). CRAMFS is useful when space is tight since files are
979 compressed. Two commands are provided:
981 cramfsls - lists files in a cramfs image
982 cramfsload - loads a file from a cramfs image
985 bool "ext2 command support"
987 Enables EXT2 FS command
990 bool "ext4 command support"
992 Enables EXT4 FS command
994 config CMD_EXT4_WRITE
996 bool "ext4 write command support"
998 Enables EXT4 FS write command
1001 bool "FAT command support"
1003 Support for the FAT fs
1005 config CMD_FS_GENERIC
1006 bool "filesystem commands"
1008 Enables filesystem commands (e.g. load, ls) that work for multiple
1012 bool "fsuuid command"
1014 Enables fsuuid command for filesystem UUID.
1017 depends on ARCH_SUNXI
1018 bool "MTD partition support"
1020 MTD partition support
1022 config MTDIDS_DEFAULT
1023 string "Default MTD IDs"
1024 depends on CMD_MTDPARTS
1026 Defines a default MTD ID
1028 config MTDPARTS_DEFAULT
1029 string "Default MTD partition scheme"
1030 depends on CMD_MTDPARTS
1032 Defines a default MTD partitioning scheme in the Linux MTD command
1033 line partitions format
1037 menu "Debug commands"
1042 The bedbug (emBEDded deBUGger) command provides debugging features
1043 for some PowerPC processors. For details please see the
1044 docuemntation in doc/README.beddbug
1047 bool "diag - Board diagnostics"
1049 This command provides access to board diagnostic tests. These are
1050 called Power-on Self Tests (POST). The command allows listing of
1051 available tests and running either all the tests, or specific tests
1057 tristate "Enable UBI - Unsorted block images commands"
1060 default y if NAND_SUNXI
1062 UBI is a software layer above MTD layer which admits use of LVM-like
1063 logical volumes on top of MTD devices, hides some complexities of
1064 flash chips like wear and bad blocks and provides some other useful
1065 capabilities. Please, consult the MTD web site for more details
1066 (www.linux-mtd.infradead.org). Activate this option if you want
1067 to use U-Boot UBI commands.
1070 tristate "Enable UBIFS - Unsorted block images filesystem commands"
1073 select RBTREE if ARCH_SUNXI
1074 select LZO if ARCH_SUNXI
1075 default y if NAND_SUNXI
1077 UBIFS is a file system for flash devices which works on top of UBI.
projects / u-boot / blob