2 bool "Command line interface"
5 Enable U-Boot's command-line functions. This provides a means
6 to enter commands into U-Boot for a wide variety of purposes. It
7 also allows scripts (containing commands) to be executed.
8 Various commands and command categorys can be indivdually enabled.
9 Depending on the number of commands enabled, this can add
10 substantially to the size of U-Boot.
17 This option enables the "hush" shell (from Busybox) as command line
18 interpreter, thus enabling powerful command line syntax like
19 if...then...else...fi conditionals or `&&' and '||'
20 constructs ("shell scripts").
22 If disabled, you get the old, much simpler behaviour with a somewhat
23 smaller memory footprint.
25 menu "Hush flavor to use"
26 depends on HUSH_PARSER
28 config HUSH_OLD_PARSER
29 bool "Use hush old parser"
32 This option enables the old flavor of hush based on hush Busybox from
35 It is actually the default U-Boot shell when decided to use hush as shell.
37 config HUSH_MODERN_PARSER
38 bool "Use hush modern parser"
40 This option enables the new flavor of hush based on hush upstream
43 This parser is experimental and not well tested.
45 config HUSH_SELECTABLE
47 default y if HUSH_OLD_PARSER && HUSH_MODERN_PARSER
50 config CMDLINE_EDITING
51 bool "Enable command line editing"
54 Enable editing and History functions for interactive command line
57 config CMDLINE_PS_SUPPORT
58 bool "Enable support for changing the command prompt string at run-time"
59 depends on HUSH_PARSER
61 Only static string in the prompt is supported so far. The string is
62 obtained from environment variables PS1 and PS2.
65 bool "Enable auto complete using TAB"
68 Enable auto completion of commands using TAB.
71 bool "Enable long help messages"
74 Defined when you want long help messages included
75 Do not set this option when short of memory.
79 default "Zynq> " if ARCH_ZYNQ
80 default "ZynqMP> " if ARCH_ZYNQMP
83 This string is displayed in the command line to the left of the
86 config SYS_PROMPT_HUSH_PS2
87 string "Hush shell secondary prompt"
88 depends on HUSH_PARSER
91 This defines the secondary prompt string, which is
92 printed when the command interpreter needs more input
93 to complete a command. Usually "> ".
96 int "Maximum number arguments accepted by commands"
100 bool "Command execution tracer"
103 This option enables the possiblity to print all commands before
104 executing them and after all variables are evaluated (similar
105 to Bash's xtrace/'set -x' feature).
106 To enable the tracer a variable "xtrace" needs to be defined in
121 List and dump ACPI tables. ACPI (Advanced Configuration and Power
122 Interface) is used mostly on x86 for providing information to the
123 Operating System about devices in the system. The tables are set up
124 by the firmware, typically U-Boot but possibly an earlier firmware
125 module, if U-Boot is chain-loaded from something else. ACPI tables
126 can also include code, to perform hardware-specific tasks required
127 by the Operating Systems. This allows some amount of separation
128 between the firmware and OS, and is particularly useful when you
129 want to make hardware changes without the OS needing to be adjusted.
136 List non-identity virtual-physical memory mappings for 32-bit CPUs.
144 config CMD_BDINFO_EXTRA
145 bool "bdinfo extra features"
146 default y if SANDBOX || X86
148 Show additional information about the board. This uses a little more
149 code space but provides more options, particularly those useful for
150 bringup, development and debugging.
157 Print ".config" contents.
159 If this option is enabled, the ".config" file contents are embedded
160 in the U-Boot image and can be printed on the console by the "config"
161 command. This provides information of which options are enabled on
168 Print console devices and information.
174 Print information about available CPUs. This normally shows the
175 number of CPUs, type (e.g. manufacturer, architecture, product or
176 internal name) and clock frequency. Other information may be
177 available depending on the CPU driver.
182 Fetch utility for U-Boot (akin to neofetch). Prints information
183 about U-Boot and the board it is running on in a pleasing format.
185 config CMD_FWU_METADATA
186 bool "fwu metadata read"
187 depends on FWU_MULTI_BANK_UPDATE
189 Command to read the metadata and dump it's contents
193 depends on CMDLINE_EDITING
195 Show the command-line history, i.e. a list of commands that are in
198 config CMD_HISTORY_USE_CALLOC
199 bool "dynamically allocate memory"
201 depends on CMD_HISTORY
203 Saying Y to this will use calloc to get the space for history
204 storing. Otherwise the history buffer will be an uninitialized
205 static array directly, without the memory allocation, and it is
206 writable after relocation to RAM. If u-boot is running from ROM
207 all the time or unsure, say Y to this.
214 Print GPL license text
219 Provides access to the Intel Power-Management Controller (PMC) so
220 that its state can be examined. This does not currently support
221 changing the state but it is still useful for debugging and seeing
232 depends on TYPEC_TCPM
234 Show voltage and current negotiated via USB PD as well as the
235 current state of the Type C Port Manager (TCPM) state machine.
237 config CMD_TLV_EEPROM
239 depends on I2C_EEPROM
242 Display and program the system EEPROM data block in ONIE Tlvinfo
243 format. TLV stands for Type-Length-Value.
245 config SPL_CMD_TLV_EEPROM
246 bool "tlv_eeprom for SPL"
247 depends on SPL_I2C_EEPROM
248 select SPL_DRIVERS_MISC
251 Read system EEPROM data block in ONIE Tlvinfo format from SPL.
255 depends on RISCV_SMODE && SBI_V02
257 Display information about the SBI implementation.
263 Display the SMBIOS information.
273 Run the command stored in the environment "bootcmd", i.e.
274 "bootd" does the same thing as "run bootcmd".
280 Boot an application image from the memory.
282 config CMD_BOOTM_PRE_LOAD
283 bool "enable pre-load on bootm"
285 depends on IMAGE_PRE_LOAD
287 Enable support of stage pre-load for the bootm command.
288 This stage allow to check or modify the image provided
289 to the bootm command.
294 default y if BOOTSTD_FULL
296 Support listing available bootdevs (boot devices) which can provide an
297 OS to boot, as well as showing information about a particular one.
299 This command is not necessary for bootstd to work.
306 Support scanning for bootflows available with the bootdevs. The
307 bootflows can optionally be booted.
309 config CMD_BOOTFLOW_FULL
310 bool "bootflow - extract subcommands"
311 depends on BOOTSTD_FULL
314 Add the ability to list the available bootflows, select one and obtain
315 information about it.
317 This command is not necessary for bootstd to work.
322 default y if BOOTSTD_FULL
324 Support listing available bootmeths (methods used to boot an
325 Operating System), as well as selecting the order that the bootmeths
328 This command is not necessary for bootstd to work.
333 default y if BOOTSTD_FULL
335 Provide general information and control for bootstd.
337 This command is not necessary for bootstd to work.
340 bool "Support booting UEFI FIT images"
341 depends on EFI_BINARY_EXEC && CMD_BOOTM && FIT
344 Support booting UEFI FIT images via the bootm command.
347 bool "Support booting ELF images"
348 depends on CMD_BOOTM && LIB_ELF
351 Support booting ELF images via the bootm command.
356 Boot the Linux zImage
360 depends on ARM64 || RISCV || SANDBOX
363 Boot an AArch64 Linux Kernel image from memory.
366 bool "Support booting Linux OS images"
367 depends on CMD_BOOTM || CMD_BOOTZ || CMD_BOOTI
370 Support booting the Linux kernel directly via a command such as bootm
374 bool "Support booting NetBSD (non-EFI) loader images"
378 Support booting NetBSD via the bootm command.
380 config BOOTM_OPENRTOS
381 bool "Support booting OPENRTOS / FreeRTOS images"
384 Support booting OPENRTOS / FreeRTOS via the bootm command.
387 bool "Support booting Enea OSE images"
388 depends on (ARM && (ARM64 || CPU_V7A || CPU_V7R) || SANDBOX || PPC || X86)
391 Support booting Enea OSE images via the bootm command.
394 bool "Support booting Plan9 OS images"
398 Support booting Plan9 images via the bootm command.
401 bool "Support booting RTEMS OS images"
405 Support booting RTEMS images via the bootm command.
408 bool "Support read SEAMA NAND images"
409 depends on MTD_RAW_NAND
411 Support reading NAND Seattle Image (SEAMA) images.
414 bool "upl - Universal Payload Specification"
416 Provides commands to deal with UPL payloads and handoff information.
417 U-Boot supports generating and accepting handoff information. The
418 mkimage tool will eventually support creating payloads.
421 bool "vbe - Verified Boot for Embedded"
422 depends on BOOTMETH_VBE
423 default y if BOOTSTD_FULL
425 Provides various subcommands related to VBE, such as listing the
426 available methods, looking at the state and changing which method
427 is used to boot. Updating the parameters is not currently
431 bool "Support booting VxWorks OS images"
435 Support booting VxWorks images via the bootm command.
439 depends on EFI_LOADER
442 Boot an EFI image from memory.
445 config CMD_BOOTEFI_BINARY
446 bool "Allow booting an EFI binary directly"
447 depends on EFI_BINARY_EXEC
450 Select this option to enable direct execution of binary at 'bootefi'.
451 This subcommand will allow you to load the UEFI binary using
452 other U-Boot commands or external methods and then run it.
454 config CMD_BOOTEFI_BOOTMGR
455 bool "UEFI Boot Manager command"
456 depends on EFI_BOOTMGR
459 Select this option to enable the 'bootmgr' subcommand of 'bootefi'.
460 This subcommand will allow you to select the UEFI binary to be booted
461 via UEFI variables Boot####, BootOrder, and BootNext.
463 config CMD_BOOTEFI_HELLO
464 bool "Allow booting a standard EFI hello world for testing"
465 depends on CMD_BOOTEFI_BINARY && BOOTEFI_HELLO_COMPILE
466 default y if CMD_BOOTEFI_SELFTEST
468 This adds a standard EFI hello world application to U-Boot so that
469 it can be used with the 'bootefi hello' command. This is useful
470 for testing that EFI is working at a basic level, and for bringing
471 up EFI support on a new architecture.
473 source "lib/efi_selftest/Kconfig"
481 Add an ANSI terminal boot menu command.
486 Android DTB/DTBO image manipulation commands. Read dtb/dtbo files from
487 image into RAM, dump image structure information, etc. Those dtb/dtbo
488 files should be merged in one dtb further, which needs to be passed to
489 the kernel, as part of a boot process.
493 depends on ANDROID_BOOT_IMAGE
495 Android Boot Image manipulation commands. Allows one to extract
496 images contained in boot.img, like kernel, ramdisk, dtb, etc, and
497 obtain corresponding meta-information from boot.img.
499 See doc/android/boot-image.rst for details.
502 bool "cedit - Configuration editor"
506 Provides a command to allow editing of board configuration and
507 providing a UI for the user to adjust settings. Subcommands allow
508 loading and saving of configuration as well as showing an editor.
515 Boot an ELF image from memory.
517 config CMD_ELF_BOOTVX
522 Boot a vxWorks image from memory
524 config CMD_ELF_FDT_SETUP
525 bool "Flattened Device Tree setup in bootelf cmd"
529 Do FDT setup in bootelf command optionally by param -d, which
530 allows to bring additional system info (e.g. /memory node) to
531 the Operating System or application.
534 bool "Flattened Device Tree utility commands"
538 Do FDT related setup before booting into the Operating System.
540 config SUPPORT_EXTENSION_SCAN
544 bool "Extension board management command"
546 depends on SUPPORT_EXTENSION_SCAN
548 Enables the "extension" command, which allows to detect
549 extension boards connected to the system, and apply
550 corresponding Device Tree overlays.
556 Start an application at a given address.
562 Run the command in the given environment variable.
568 Print header information for application image.
572 depends on MTD_NOR_FLASH || FLASH_CFI_DRIVER
574 List all images found in flash
580 Extract a part of a multi-image.
583 hex "imxtract max gunzip size"
585 depends on CMD_XIMG && GZIP
587 This provides the size of the commad-line argument area
588 used by imxtract for extracting pieces of FIT image.
589 It should be large enough to fit uncompressed size of
590 FIT piece we are extracting.
593 bool "spl export - Export boot information for Falcon boot"
596 Falcon mode allows booting directly from SPL into an Operating
597 System such as Linux, thus skipping U-Boot proper. See
598 doc/README.falcon for full information about how to use this
601 config CMD_SPL_NAND_OFS
602 hex "Offset of OS args or dtb for Falcon-mode NAND boot"
603 depends on CMD_SPL && (TPL_NAND_SUPPORT || SPL_NAND_SUPPORT)
606 This provides the offset of the command line arguments for Linux
607 when booting from NAND in Falcon mode. See doc/README.falcon
608 for full information about how to use this option (and also see
609 board/gateworks/gw_ventana/README for an example).
611 config CMD_SPL_NOR_OFS
612 hex "Offset of OS args or dtb for Falcon-mode NOR boot"
613 depends on CMD_SPL && SPL_NOR_SUPPORT
616 This provides the offset of the command line arguments or dtb for
617 Linux when booting from NOR in Falcon mode.
619 config CMD_SPL_WRITE_SIZE
620 hex "Size of argument area"
624 This provides the size of the command-line argument area in NAND
625 flash used by Falcon-mode boot. See the documentation until CMD_SPL
628 config CMD_THOR_DOWNLOAD
629 bool "thor - TIZEN 'thor' download"
631 select USB_FUNCTION_THOR
632 depends on USB_GADGET_DOWNLOAD
634 Implements the 'thor' download protocol. This is a way of
635 downloading a software update over USB from an attached host.
636 There is no documentation about this within the U-Boot source code
637 but you should be able to find something on the interwebs.
639 config THOR_RESET_OFF
640 bool "thor: Disable reset on completion"
641 depends on CMD_THOR_DOWNLOAD
644 bool "zboot - x86 boot command"
648 With x86 machines it is common to boot a bzImage file which
649 contains both a kernel and a setup.bin file. The latter includes
650 configuration information from the dark ages which x86 boards still
651 need to pick things out of.
653 Consider using FIT in preference to this since it supports directly
654 booting both 32- and 64-bit kernels, as well as secure boot.
655 Documentation is available in doc/usage/fit/x86-fit-boot.rst.
659 menu "Environment commands"
662 bool "ask for env variable"
664 Ask for environment variable
682 Edit environment variable.
687 Allow for searching environment variables
693 Save all environment variables into the compiled-in persistent
698 depends on CMD_SAVEENV
700 Erase environment variables from the compiled-in persistent
703 config CMD_ENV_EXISTS
707 Check if a variable is defined in the environment for use in
710 config CMD_ENV_CALLBACK
711 bool "env callbacks - print callbacks and their associated variables"
713 Some environment variable have callbacks defined by
714 U_BOOT_ENV_CALLBACK. These are called when the variable changes.
715 For example changing "baudrate" adjust the serial baud rate. This
716 command lists the currently defined callbacks.
719 bool "env flags -print variables that have non-default flags"
721 Some environment variables have special flags that control their
722 behaviour. For example, serial# can only be written once and cannot
723 be deleted. This command shows the variables that have special
726 config CMD_NVEDIT_EFI
727 bool "env [set|print] -e - set/print UEFI variables"
728 depends on EFI_LOADER
731 UEFI variables are encoded as some form of U-Boot variables.
732 If enabled, we are allowed to set/print UEFI variables using
733 "env" command with "-e" option without knowing details.
735 config CMD_NVEDIT_INDIRECT
736 bool "env indirect - Sets environment value from another"
738 config CMD_NVEDIT_INFO
739 bool "env info - print or evaluate environment information"
741 Print environment information:
742 - env_valid : is environment valid
743 - env_ready : is environment imported into hash table
744 - env_use_default : is default environment used
746 This command can be optionally used for evaluation in scripts:
747 [-d] : evaluate whether default environment is used
748 [-p] : evaluate whether environment can be persisted
750 The result of multiple evaluations will be combined with AND.
752 config CMD_NVEDIT_LOAD
755 Load all environment variables from the compiled-in persistent
758 config CMD_NVEDIT_SELECT
761 Select the compiled-in persistent storage of environment variables.
765 menu "Memory commands"
770 Compute binary operations (xor, or, and) of byte arrays of arbitrary
771 size from memory and store the result in memory or the environment.
778 Show information about the bloblist, a collection of binary blobs
779 held in memory that persist between SPL and U-Boot. In the case of
780 x86 devices the bloblist can be used to hold ACPI tables so that they
781 remain available in memory.
794 Add -v option to verify data against a crc32 checksum.
797 bool "eeprom - EEPROM subsystem"
798 depends on DM_I2C || SYS_I2C_LEGACY
800 (deprecated, needs conversion to driver model)
801 Provides commands to read and write EEPROM (Electrically Erasable
802 Programmable Read Only Memory) chips that are connected over an
805 config CMD_EEPROM_LAYOUT
806 bool "Enable layout-aware eeprom commands"
807 depends on CMD_EEPROM
809 (deprecated, needs conversion to driver model)
810 When enabled, additional eeprom sub-commands become available.
812 eeprom print - prints the contents of the eeprom in a human-readable
813 way (eeprom layout fields, and data formatted to be fit for human
816 eeprom update - allows user to update eeprom fields by specifying
817 the field name, and providing the new data in a human readable format
818 (same format as displayed by the eeprom print command).
820 Both commands can either auto detect the layout, or be told which
824 __weak int parse_layout_version(char *str)
825 - override to provide your own layout name parsing
826 __weak void __eeprom_layout_assign(struct eeprom_layout *layout,
828 - override to setup the layout metadata based on the version
829 __weak int eeprom_layout_detect(unsigned char *data)
830 - override to provide your own algorithm for detecting layout
833 - contains various printing and updating functions for common
834 types of eeprom fields. Can be used for defining
837 config EEPROM_LAYOUT_VERSIONS
838 bool "Support specifying eeprom layout version"
839 depends on CMD_EEPROM_LAYOUT
841 Support specifying eeprom layout version in the 'eeprom' command
844 config EEPROM_LAYOUT_HELP_STRING
845 string "Tells user what layout names are supported"
846 depends on EEPROM_LAYOUT_VERSIONS
847 default "<not defined>"
849 Help printed with the LAYOUT VERSIONS part of the 'eeprom'
852 config SYS_I2C_EEPROM_BUS
853 int "I2C bus of the EEPROM device."
854 depends on CMD_EEPROM
857 config SYS_I2C_EEPROM_ADDR_LEN
858 int "Length in bytes of the EEPROM memory array address"
859 depends on CMD_EEPROM || ID_EEPROM
863 Note: This is NOT the chip address length!
865 config SYS_EEPROM_SIZE
866 depends on CMD_EEPROM
867 int "Size in bytes of the EEPROM device"
870 config SYS_EEPROM_PAGE_WRITE_BITS
871 int "Number of bits used to address bytes in a single page"
872 depends on CMD_EEPROM || ENV_IS_IN_EEPROM
875 The EEPROM page size is 2^SYS_EEPROM_PAGE_WRITE_BITS.
876 A 64 byte page, for example would require six bits.
878 config SYS_EEPROM_PAGE_WRITE_DELAY_MS
879 int "Number of milliseconds to delay between page writes"
880 depends on CMD_EEPROM || CMD_I2C
886 Infinite write loop on address range
893 Compute MD5 checksum.
897 depends on CMD_MD5SUM
899 Add -v option to verify data against an MD5 checksum.
903 default y if SANDBOX || X86
905 Display memory information.
907 config CMD_MEMINFO_MAP
908 bool "- with memory map"
909 depends on CMD_MEMINFO
910 default y if SANDBOX || X86
912 Shows a memory map, in addition to just the DRAM size. This allows
913 seeing where U-Boot's memory area is, at the top of DRAM, as well as
914 detail about each piece of it.
916 See doc/usage/cmd/meminfo.rst for more information.
919 bool "md, mm, nm, mw, cp, cmp, base, loop"
924 mm - memory modify (auto-incrementing address)
925 nm - memory modify (constant address)
926 mw - memory write (fill)
929 base - print or set address offset
930 loop - initialize loop on address range
932 config CMD_MEM_SEARCH
933 bool "ms - Memory search"
935 Memory-search command
937 This allows searching through a region of memory looking for hex
938 data (byte, 16-bit word, 32-bit long, also 64-bit on machines that
939 support it). It is also possible to search for a string. The
940 command accepts a memory range and a list of values to search for.
941 The values need to appear in memory in the same order they are given
942 in the command. At most 10 matches can be returned at a time, but
943 pressing return will show the next 10 matches. Environment variables
944 are set for use with scripting (memmatches, memaddr, mempos).
947 bool "Enable cyclic md/mw commands"
948 depends on CMD_MEMORY
950 Add the "mdc" and "mwc" memory commands. These are cyclic
955 This command will print 4 bytes (10,11,12,13) each 500 ms.
957 => mwc.l 100 12345678 10
958 This command will write 12345678 to address 100 all 10 ms.
963 depends on CMD_MEMORY && (LIB_RAND || LIB_HW_RAND)
965 random - fill memory with random data
970 Simple RAM read/write test.
974 config SYS_ALT_MEMTEST
975 bool "Alternative test"
977 Use a more complete alternative memory test.
981 config SYS_ALT_MEMTEST_BITFLIP
985 The alternative memory test includes bitflip test since 2020.07.
986 The bitflip test significantly increases the overall test time.
987 Bitflip test can optionally be disabled here.
991 config SYS_MEMTEST_START
992 hex "default start address for mtest"
995 This is the default start address for mtest for simple read/write
996 test. If no arguments are given to mtest, default address is used
999 config SYS_MEMTEST_END
1000 hex "default end address for mtest"
1003 This is the default end address for mtest for simple read/write
1004 test. If no arguments are given to mtest, default address is used
1013 Compute SHA1 checksum.
1015 config SHA1SUM_VERIFY
1017 depends on CMD_SHA1SUM
1019 Add -v option to verify data against a SHA1 checksum.
1022 bool "strings - display strings in memory"
1024 This works similarly to the Unix 'strings' command except that it
1025 works with a memory range. String of printable characters found
1026 within the range are displayed. The minimum number of characters
1027 for a sequence to be considered a string can be provided.
1031 menu "Compression commands"
1035 default y if CMD_BOOTI
1038 Support decompressing an LZMA (Lempel-Ziv-Markov chain algorithm)
1043 default y if CMD_BOOTI
1046 Support decompressing an LZ4 image from memory region.
1050 default y if CMD_BOOTI
1053 Uncompress a zip-compressed memory region.
1057 select GZIP_COMPRESSED
1059 Compress a memory region with zlib deflate method.
1063 menu "Device access commands"
1066 bool "Arm FF-A test command"
1067 depends on ARM_FFA_TRANSPORT
1069 Provides a test command for the FF-A support
1071 - Listing the partition(s) info
1072 - Sending a data pattern to the specified partition
1073 - Displaying the arm_ffa device info
1077 depends on FLASH_CFI_DRIVER
1079 ARM Ltd reference designs flash partition access
1082 bool "adc - Access Analog to Digital Converters info and data"
1084 depends on DM_REGULATOR
1086 Shows ADC device info and permit printing one-shot analog converted
1087 data from a named Analog to Digital Converter.
1091 depends on PARTITIONS
1093 Read/modify/write the fields of Bootloader Control Block, usually
1094 stored on the flash "misc" partition with its structure defined in:
1095 https://android.googlesource.com/platform/bootable/recovery/+/master/
1096 bootloader_message/include/bootloader_message/bootloader_message.h
1098 Some real-life use-cases include (but are not limited to):
1099 - Determine the "boot reason" (and act accordingly):
1100 https://source.android.com/devices/bootloader/boot-reason
1101 - Get/pass a list of commands from/to recovery:
1102 https://android.googlesource.com/platform/bootable/recovery
1103 - Inspect/dump the contents of the BCB fields
1106 bool "bind/unbind - Bind or unbind a device to/from a driver"
1110 Bind or unbind a device to/from a driver from the command line.
1111 This is useful in situations where a device may be handled by several
1112 drivers. For example, this can be used to bind a UDC to the usb ether
1113 gadget driver from the command line.
1116 bool "clk - Show and set clock frequencies"
1119 Show and set clock frequencies managed by CLK uclass drivers.
1122 bool "demo - Demonstration commands for driver model"
1125 Provides a 'demo' command which can be used to play around with
1126 driver model. To use this properly you will need to enable one or
1127 both of the demo devices (DM_DEMO_SHAPE and DM_DEMO_SIMPLE).
1128 Otherwise you will always get an empty list of devices. The demo
1129 devices are defined in the sandbox device tree, so the easiest
1130 option is to use sandbox and pass the -d point to sandbox's
1137 Enables the command "dfu" which is used to have U-Boot create a DFU
1138 class device via USB. This command requires that the "dfu_alt_info"
1139 environment variable be set and define the alt settings to expose to
1143 bool "dm - Access to driver model information"
1146 Provides access to driver model data structures and information,
1147 such as a list of devices, list of uclasses and the state of each
1148 device (e.g. activated). This is not required for operation, but
1149 can be useful to see the state of driver model for debugging or
1153 bool "fastboot - Android fastboot support"
1156 This enables the command "fastboot" which enables the Android
1157 fastboot mode for the platform. Fastboot is a protocol for
1158 downloading images, flashing and device control used on
1159 Android devices. Fastboot requires either the network stack
1160 enabled or support for acting as a USB device.
1162 See doc/android/fastboot.rst for more information.
1165 bool "flinfo, erase, protect"
1167 depends on FLASH_CFI_DRIVER || MTD_NOR_FLASH
1170 flinfo - print FLASH memory information
1171 erase - FLASH memory
1172 protect - enable or disable FLASH write protection
1181 config CMD_FPGA_LOADBP
1182 bool "fpga loadbp - load partial bitstream (Xilinx only)"
1185 Supports loading an FPGA device from a bitstream buffer containing
1186 a partial bitstream.
1188 config CMD_FPGA_LOADFS
1189 bool "fpga loadfs - load bitstream from FAT filesystem (Xilinx only)"
1192 Supports loading an FPGA device from a FAT filesystem.
1194 config CMD_FPGA_LOADMK
1195 bool "fpga loadmk - load bitstream from image"
1198 Supports loading an FPGA device from a image generated by mkimage.
1200 config CMD_FPGA_LOADP
1201 bool "fpga loadp - load partial bitstream"
1204 Supports loading an FPGA device from a bitstream buffer containing
1205 a partial bitstream.
1207 config CMD_FPGA_LOAD_SECURE
1208 bool "fpga loads - loads secure bitstreams"
1210 select FPGA_LOAD_SECURE
1212 Enables the fpga loads command which is used to load secure
1213 (authenticated or encrypted or both) bitstreams on to FPGA.
1216 bool "fpgad - dump FPGA registers"
1217 depends on GDSYS_LEGACY_DRIVERS
1219 (legacy, needs conversion to driver model)
1220 Provides a way to dump FPGA registers by calling the board-specific
1221 fpga_get_reg() function. This functions similarly to the 'md'
1225 bool "fuse - support for the fuse subssystem"
1227 (deprecated - needs conversion to driver model)
1228 This allows reading, sensing, programming or overriding fuses
1229 which control the behaviour of the device. The command uses the
1237 config CMD_GPIO_READ
1238 bool "gpio read - save GPIO value to variable"
1241 Enables the 'gpio read' command that saves the value
1242 of a GPIO pin to a variable.
1248 Control PWM channels, this allows invert/config/enable/disable PWM channels.
1251 bool "GPT (GUID Partition Table) command"
1252 select EFI_PARTITION
1253 select PARTITION_UUIDS
1256 Enable the 'gpt' command to ready and write GPT style partition
1259 config CMD_GPT_RENAME
1260 bool "GPT partition renaming commands"
1263 Enables the 'gpt' command to interchange names on two GPT
1264 partitions via the 'gpt swap' command or to rename single
1265 partitions via the 'rename' command.
1268 bool "ide - Support for IDE drivers"
1271 Provides an 'ide' command which allows accessing the IDE drive,
1272 resetting the IDE interface, printing the partition table and
1273 geting device info. It also enables the 'diskboot' command which
1274 permits booting from an IDE drive.
1277 bool "io - Support for performing I/O accesses"
1279 Provides an 'iod' command to display I/O space and an 'iow' command
1280 to write values to the I/O space. This can be useful for manually
1281 checking the state of devices during boot when debugging device
1285 bool "iotrace - Support for tracing I/O activity"
1287 Provides an 'iotrace' command which supports recording I/O reads and
1288 writes in a trace buffer in memory . It also maintains a checksum
1289 of the trace records (even if space is exhausted) so that the
1290 sequence of I/O accesses can be verified.
1292 When debugging drivers it is useful to see what I/O accesses were
1293 done and in what order.
1295 Even if the individual accesses are of little interest it can be
1296 useful to verify that the access pattern is consistent each time
1297 an operation is performed. In this case a checksum can be used to
1298 characterise the operation of a driver. The checksum can be compared
1299 across different runs of the operation to verify that the driver is
1302 In particular, when performing major refactoring of the driver, where
1303 the access pattern should not change, the checksum provides assurance
1304 that the refactoring work has not broken the driver.
1306 This works by sneaking into the io.h heder for an architecture and
1307 redirecting I/O accesses through iotrace's tracing mechanism.
1309 For now no commands are provided to examine the trace buffer. The
1310 format is fairly simple, so 'md' is a reasonable substitute.
1312 Note: The checksum feature is only useful for I/O regions where the
1313 contents do not change outside of software control. Where this is not
1314 suitable you can fall back to manually comparing the addresses. It
1315 might be useful to enhance tracing to only checksum the accesses and
1316 not the data read/written.
1326 bool "w1 - Support for Dallas 1-Wire protocol"
1328 Dallas 1-wire protocol support
1334 Load a binary file over serial line.
1339 Load a binary over memory mapped.
1342 bool "loads - Load a file over serial in S-Record format"
1345 Load an S-Record file over serial line
1348 bool "Echo all characters received during a loads back to console"
1349 depends on CMD_LOADS
1351 If enabled, all characters received during a serial download (using
1352 the "loads" command) are echoed back. This might be needed by some
1353 terminal emulations (like "cu"), but may as well just take time on
1354 others. This sets the initial value of the "loads_echo" environment
1358 bool "saves - Save a file over serial in S-Record format"
1359 depends on CMD_LOADS
1361 Provides a way to save a binary file using the Motorola S-Record
1362 format over the serial line.
1364 config SYS_LOADS_BAUD_CHANGE
1365 bool "Enable a temporary baudrate change during loads/saves command"
1366 depends on CMD_LOADS || CMD_SAVES
1368 config CMD_LOADXY_TIMEOUT
1369 int "loadxy_timeout"
1373 Initial timeout for loadx and loady commands. Zero means infinity.
1377 bool "lsblk - list block drivers and devices"
1379 Print list of available block device drivers, and for each, the list
1380 of known block devices.
1383 bool "MBR (Master Boot Record) command"
1384 select DOS_PARTITION
1386 Enable the 'mbr' command to ready and write MBR (Master Boot Record)
1387 style partition tables.
1393 Enable the command "misc" for accessing miscellaneous devices with
1394 a MISC uclass driver. The command provides listing all MISC devices
1395 as well as read and write functionalities via their drivers.
1401 MMC memory mapped support.
1405 config CMD_BKOPS_ENABLE
1406 bool "mmc bkops enable"
1409 Enable command for setting manual background operations handshake
1410 on a eMMC device. The feature is optionally available on eMMC devices
1411 conforming to standard >= 4.41.
1414 bool "Enable support for reading card registers in the mmc command"
1417 Enable the commands for reading card registers. This is useful
1418 mostly for debugging or extracting details from the card.
1421 bool "Enable support for RPMB in the mmc command"
1422 depends on SUPPORT_EMMC_RPMB
1424 Enable the commands for reading, writing and programming the
1425 key for the Replay Protection Memory Block partition in eMMC.
1427 config CMD_MMC_SWRITE
1429 depends on MMC_WRITE
1432 Enable support for the "mmc swrite" command to write Android sparse
1435 config MMC_SPEED_MODE_SET
1436 bool "set speed mode using mmc command"
1438 Enable setting speed mode using mmc rescan and mmc dev commands.
1439 The speed mode is provided as the last argument in these commands
1440 and is indicated using the index from enum bus_mode in
1441 include/mmc.h. A speed mode can be set only if it has already
1442 been enabled in the device tree.
1450 Enable storage cloning over block devices, useful for
1451 initial flashing by external block device without network
1454 config CMD_OPTEE_RPMB
1455 bool "Enable read/write support on RPMB via OPTEE"
1456 depends on (SUPPORT_EMMC_RPMB && OPTEE) || SANDBOX_TEE
1457 default y if SANDBOX_TEE
1458 select OPTEE_TA_AVB if SANDBOX_TEE
1460 Enable the commands for reading, writing persistent named values
1461 in the Replay Protection Memory Block partition in eMMC by
1462 using Persistent Objects in OPTEE
1465 bool "Enable OP-TEE commands"
1468 OP-TEE commands support.
1473 select MTD_PARTITIONS
1475 MTD commands support.
1482 MTD commands for OTP access.
1486 depends on MULTIPLEXER
1488 List, select, and deselect mux controllers on the fly.
1492 default y if NAND_SUNXI
1493 depends on MTD_RAW_NAND
1498 config CMD_NAND_TRIMFFS
1499 bool "nand write.trimffs"
1500 default y if ARCH_SUNXI
1502 Allows one to skip empty pages when flashing something on a NAND.
1504 config CMD_NAND_LOCK_UNLOCK
1505 bool "nand lock/unlock"
1507 NAND locking support.
1509 config CMD_NAND_TORTURE
1512 NAND torture support.
1514 config CMD_NAND_WATCH
1517 NAND watch bitflip support.
1526 NVM Express device support
1529 bool "onenand - access to onenand device"
1532 OneNAND is a brand of NAND ('Not AND' gate) flash which provides
1533 various useful features. This command allows reading, writing,
1534 and erasing blocks. It allso provides a way to show and change
1535 bad blocks, and test the device.
1537 config USE_ONENAND_BOARD_INIT
1538 bool "Call onenand_board_init() in the onenand command"
1539 depends on CMD_ONENAND
1545 Enable the 'osd' command which allows to query information from and
1546 write text data to a on-screen display (OSD) device; a virtual device
1547 associated with a display capable of displaying a text overlay on the
1548 display it's associated with..
1552 depends on PARTITIONS
1553 select PARTITION_UUIDS
1555 Read and display information about the partition table on
1559 bool "pci - Access PCI devices"
1561 Provide access to PCI (Peripheral Interconnect Bus), a type of bus
1562 used on some devices to allow the CPU to communicate with its
1563 peripherals. Sub-commands allow bus enumeration, displaying and
1564 changing configuration space and a few other features.
1567 bool "pci_mps - Configure PCI device MPS"
1570 Enables PCI Express Maximum Packet Size (MPS) tuning. This
1571 command configures the PCI Express MPS of each endpoint to the
1572 largest value supported by all devices below the root complex.
1573 The Maximum Read Request Size will not be altered. This method is
1574 the same algorithm as used by Linux pci=pcie_bus_safe.
1577 bool "pinmux - show pins muxing"
1579 default y if PINCTRL
1581 Parse all available pin-controllers and show pins muxing. This
1582 is useful for debug purpoer to check the pin muxing and to know if
1583 a pin is configured as a GPIO or as an alternate function.
1588 Poweroff/Shutdown the system
1591 bool "read - Read binary data from a partition"
1593 Provides low-level access to the data in a partition.
1595 config CMD_REMOTEPROC
1597 depends on REMOTEPROC
1599 Support for Remote Processor control
1602 bool "sata - Access SATA subsystem"
1605 SATA (Serial Advanced Technology Attachment) is a serial bus
1606 standard for connecting to hard drives and other storage devices.
1607 This command provides information about attached devices and allows
1608 reading, writing and other operations.
1610 SATA replaces PATA (originally just ATA), which stands for Parallel AT
1611 Attachment, where AT refers to an IBM AT (Advanced Technology)
1612 computer released in 1984.
1615 bool "scsi - Access to SCSI devices"
1619 This provides a 'scsi' command which provides access to SCSI (Small
1620 Computer System Interface) devices. The command provides a way to
1621 scan the bus, reset the bus, read and write data and get information
1625 bool "sdram - Print SDRAM configuration information"
1627 Provides information about attached SDRAM. This assumed that the
1628 SDRAM has an EEPROM with information that can be read using the
1629 I2C bus. This is only available on some boards.
1633 depends on DM_SPI_FLASH || SPI_FLASH
1634 default y if DM_SPI_FLASH
1639 bool "sf test - Allow testing of SPI flash"
1642 Provides a way to test that SPI flash is working correctly. The
1643 test is destructive, in that an area of SPI flash must be provided
1644 for the test to use. Performance information is also provided,
1645 measuring the performance of reading, writing and erasing in
1646 Mbps (Million Bits Per Second). This value should approximately
1647 equal the SPI bus speed for a single-bit-wide SPI bus, assuming
1648 everything is working properly.
1651 bool "sspi - Command to access spi device"
1654 SPI utility command.
1656 config DEFAULT_SPI_BUS
1657 int "default spi bus used by sspi command"
1661 config DEFAULT_SPI_MODE
1662 hex "default spi mode used by sspi command (see include/spi.h)"
1666 config CMD_TEMPERATURE
1667 bool "temperature - display the temperature from thermal sensors"
1668 depends on DM_THERMAL
1670 Provides a way to list thermal sensors and to get their readings.
1673 bool "tsi148 - Command to access tsi148 device"
1674 depends on DM_PCI_COMPAT
1676 This provides various sub-commands to initialise and configure the
1677 Turndra tsi148 device. See the command help for full details.
1680 bool "ufs - Universal Flash Storage commands"
1683 "This provides commands to initialise and configure universal flash
1687 bool "universe - Command to set up the Turndra Universe controller"
1688 depends on DM_PCI_COMPAT
1690 This allows setting up the VMEbus provided by this controller.
1691 See the command help for full details.
1701 depends on USB_GADGET_DOWNLOAD
1702 select USB_FUNCTION_SDP
1704 Enables the command "sdp" which is used to have U-Boot emulating the
1705 Serial Download Protocol (SDP) via USB.
1711 Enable the command "rkmtd" to create a virtual block device to transfer
1712 Rockchip boot block data to and from NAND with block orientated tools
1713 like "ums" and "rockusb".
1717 depends on USB_FUNCTION_ROCKUSB
1719 Rockusb protocol is widely used by Rockchip SoC based devices. It can
1720 read/write info, image to/from devices. This enable rockusb command
1721 support to communication with rockusb device. for more detail about
1722 this command, please read doc/README.rockusb.
1724 config CMD_USB_MASS_STORAGE
1725 bool "UMS usb mass storage"
1726 depends on BLK && USB_GADGET_DOWNLOAD
1727 select USB_FUNCTION_MASS_STORAGE
1729 Enables the command "ums" and the USB mass storage support to the
1730 export a block device: U-Boot, the USB device, acts as a simple
1731 external hard drive plugged on the host USB port.
1733 config CMD_UMS_ABORT_KEYED
1734 bool "UMS abort with any key"
1735 depends on CMD_USB_MASS_STORAGE
1737 Allow interruption of usb mass storage run with any key pressed.
1740 bool "Xen para-virtualized block device"
1744 Xen para-virtualized block device support
1751 VirtIO block device support
1757 This provides commands to control the watchdog timer devices.
1760 bool "write - Write binary data to a partition"
1762 Provides low-level write access to a partition.
1768 Enable the command "axi" for accessing AXI (Advanced eXtensible
1769 Interface) busses, a on-chip interconnect specification for managing
1770 functional blocks in SoC designs, which is also often used in designs
1771 involving FPGAs (e.g. communication with IP cores in Xilinx FPGAs).
1775 menu "Shell scripting commands"
1780 Print file to standard output
1786 Echo args to console
1792 Return true/false on integer compare.
1798 Run script from memory
1804 Evaluate boolean and math expressions and store the result in an env
1806 Also supports loading the value at a memory location into a variable.
1807 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
1809 config CMD_SETEXPR_FMT
1811 depends on CMD_SETEXPR
1813 Evaluate format string expression and store result in an environment
1819 Print file as hexdump to standard output
1826 bool "Network commands"
1839 bootp - boot image via network using BOOTP/TFTP protocol
1845 Boot image via network using DHCPv6/TFTP protocol using IPv6.
1847 Will perform 4-message exchange with DHCPv6 server, requesting
1848 the minimum required options to TFTP boot. Complies with RFC 8415.
1852 config DHCP6_PXE_CLIENTARCH
1854 default 0x16 if ARM64
1858 config DHCP6_PXE_DHCP_OPTION
1859 bool "Request & store 'pxe_configfile' from DHCP6 server"
1861 config DHCP6_ENTERPRISE_ID
1862 int "Enterprise ID to send in DHCPv6 Vendor Class Option"
1867 config BOOTP_MAY_FAIL
1868 bool "Allow for the BOOTP/DHCP server to not be found"
1869 depends on CMD_BOOTP
1871 If the DHCP server is not found after the configured retry count, the
1872 call will fail instead of starting over. This can be used to fail
1873 over to Link-local IP address configuration if the DHCP server is not
1876 config BOOTP_BOOTPATH
1877 bool "Request & store 'rootpath' from BOOTP/DHCP server"
1879 depends on CMD_BOOTP
1881 Even though the config is called BOOTP_BOOTPATH, it stores the
1882 path in the variable 'rootpath'.
1884 config BOOTP_VENDOREX
1885 bool "Support vendor extensions from BOOTP/DHCP server"
1886 depends on CMD_BOOTP
1888 config BOOTP_BOOTFILESIZE
1889 bool "Request & store 'bootfilesize' from BOOTP/DHCP server"
1890 depends on CMD_BOOTP
1893 bool "Request & store 'dnsip' from BOOTP/DHCP server"
1895 depends on CMD_BOOTP
1897 The primary DNS server is stored as 'dnsip'. If two servers are
1898 returned, you must set BOOTP_DNS2 to store that second server IP
1902 bool "Store 'dnsip2' from BOOTP/DHCP server"
1903 depends on BOOTP_DNS
1905 If a DHCP client requests the DNS server IP from a DHCP server,
1906 it is possible that more than one DNS serverip is offered to the
1907 client. If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1908 server IP will be stored in the additional environment
1909 variable "dnsip2". The first DNS serverip is always
1910 stored in the variable "dnsip", when BOOTP_DNS is defined.
1912 config BOOTP_GATEWAY
1913 bool "Request & store 'gatewayip' from BOOTP/DHCP server"
1915 depends on CMD_BOOTP
1917 config BOOTP_HOSTNAME
1918 bool "Request & store 'hostname' from BOOTP/DHCP server"
1920 depends on CMD_BOOTP
1922 The name may or may not be qualified with the local domain name.
1924 config BOOTP_PREFER_SERVERIP
1925 bool "serverip variable takes precedent over DHCP server IP."
1926 depends on CMD_BOOTP
1928 By default a BOOTP/DHCP reply will overwrite the 'serverip' variable.
1930 With this option enabled, the 'serverip' variable in the environment
1931 takes precedence over DHCP server IP and will only be set by the DHCP
1932 server if not already set in the environment.
1934 config BOOTP_SUBNETMASK
1935 bool "Request & store 'netmask' from BOOTP/DHCP server"
1937 depends on CMD_BOOTP
1939 config BOOTP_NISDOMAIN
1940 bool "Request & store 'nisdomain' from BOOTP/DHCP server"
1941 depends on CMD_BOOTP
1943 config BOOTP_NTPSERVER
1944 bool "Request & store 'ntpserverip' from BOOTP/DHCP server"
1945 depends on CMD_BOOTP
1947 config BOOTP_TIMEOFFSET
1948 bool "Request & store 'timeoffset' from BOOTP/DHCP server"
1949 depends on CMD_BOOTP && CMD_SNTP
1954 Selecting this will allow capturing all Ethernet packets and store
1955 them in physical memory in a PCAP formated file,
1956 later to be analyzed by PCAP reader application (IE. WireShark).
1959 bool "Send PXE client arch to BOOTP/DHCP server"
1961 depends on CMD_BOOTP && CMD_PXE
1963 Supported for ARM, ARM64, and x86 for now.
1965 config BOOTP_PXE_CLIENTARCH
1967 depends on BOOTP_PXE
1968 default 0x16 if ARM64
1972 config BOOTP_PXE_DHCP_OPTION
1973 bool "Request & store 'pxe_configfile' from BOOTP/DHCP server"
1974 depends on BOOTP_PXE
1976 config BOOTP_VCI_STRING
1978 depends on CMD_BOOTP
1979 default "U-Boot.armv7" if CPU_V7A || CPU_V7M || CPU_V7R
1980 default "U-Boot.armv8" if ARM64
1981 default "U-Boot.arm" if ARM
1986 depends on CMD_TFTPBOOT
1988 TFTP put command, for uploading files to a server
1992 depends on CMD_TFTPBOOT
1994 Act as a TFTP server and boot the first received file
1996 config NET_TFTP_VARS
1997 bool "Control TFTP timeout and count through environment"
1998 depends on CMD_TFTPBOOT
2001 If set, allows controlling the TFTP timeout through the
2002 environment variable tftptimeout, and the TFTP maximum
2003 timeout count through the variable tftptimeoutcountmax.
2004 If unset, timeout and maximum are hard-defined as 1 second
2005 and 10 timouts per TFTP transfer.
2010 Boot image via network using RARP/TFTP protocol
2015 Boot image via network using NFS protocol.
2018 int "Timeout in milliseconds for NFS mounts"
2022 Timeout in milliseconds used in NFS protocol. If you encounter
2023 "ERROR: Cannot umount" in nfs command, try longer timeout such as
2026 config SYS_DISABLE_AUTOLOAD
2027 bool "Disable automatically loading files over the network"
2028 depends on CMD_BOOTP || CMD_DHCP || CMD_NFS || CMD_RARP
2030 Typically, commands such as "dhcp" will attempt to automatically
2031 load a file from the network, once the initial network configuration
2032 is complete. Enable this option to disable this behavior and instead
2033 require files to be loaded over the network by subsequent commands.
2038 default y if (CMD_PING && IPV6)
2040 Send ICMPv6 ECHO_REQUEST to network host
2045 The cdp command is used to announce the U-Boot device in the network
2046 and to retrieve configuration data including the VLAN id using the
2047 proprietary Cisco Discovery Protocol (CDP).
2053 Synchronize RTC via network
2055 config CMD_LINK_LOCAL
2059 Acquire a network IP address using the link-local protocol
2065 Manually configure the attached NIC via NC-SI.
2066 Normally this happens automatically before other network
2069 config IPV6_ROUTER_DISCOVERY
2070 bool "Do IPv6 router discovery"
2073 Will automatically perform router solicitation on first IPv6
2080 Allow control of L2 Ethernet switch commands. These are supported
2081 by the vsc9953 Ethernet driver at present. Sub-commands allow
2082 operations such as enabling / disabling a port and
2083 viewing/maintaining the filtering database (FDB)
2088 Wait for wake-on-lan Magic Packet
2098 select PROT_DHCP_LWIP if NET_LWIP
2100 Boot image via network using DHCP/TFTP protocol
2104 select PROT_DNS_LWIP if NET_LWIP
2106 Lookup the IP of a hostname
2112 If set, allows 802.3(clause 22) MII Management functions interface access
2113 The management interface specified in Clause 22 provides
2114 a simple, two signal, serial interface to connect a
2115 Station Management entity and a managed PHY for providing access
2116 to management parameters and services.
2117 The interface is referred to as the MII management interface.
2120 bool "Call mii_init() in the mii command"
2121 depends on CMD_MII && (MPC8XX_FEC || FSLDMAFE || MCFFEC)
2127 If set, allows Enable 802.3(clause 45) MDIO interface registers access
2128 The MDIO interface is orthogonal to the MII interface and extends
2129 it by adding access to more registers through indirect addressing.
2133 select PROT_RAW_LWIP if NET_LWIP
2135 Send ICMP ECHO_REQUEST to network host
2139 select PROT_UDP_LWIP if NET_LWIP
2142 tftpboot - load file via network using TFTP protocol
2146 default y if SANDBOX
2149 wget is a simple command to download kernel, or other files,
2150 from a http server over TCP.
2155 depends on PROT_TCP_LWIP
2156 depends on MBEDTLS_LIB
2159 select ASYMMETRIC_KEY_TYPE
2160 select ASYMMETRIC_PUBLIC_KEY_SUBTYPE
2161 select X509_CERTIFICATE_PARSER
2162 select PKCS7_MESSAGE_PARSER
2163 select MBEDTLS_LIB_CRYPTO
2164 select MBEDTLS_LIB_TLS
2165 select RSA_VERIFY_WITH_PKEY
2166 select X509_CERTIFICATE_PARSER
2167 select PKCS7_MESSAGE_PARSER
2169 Enable TLS over http for wget.
2178 Boot image via network using PXE protocol
2180 endif # if NET || NET_LWIP
2182 menu "Misc commands"
2187 This is a simple sliding block puzzle game designed by Italian web
2188 developer Gabriele Cirulli. The game's objective is to slide numbered
2189 tiles on a grid to combine them to create a tile with the number
2192 This needs ANSI support on your terminal to work. It is not fully
2193 functional on a video device.
2196 bool "Enable 'bmp' command"
2200 This provides a way to obtain information about a BMP-format image
2201 and to display it. BMP (which presumably stands for BitMaP) is a
2202 file format defined by Microsoft which supports images of various
2203 depths, formats and compression methods. Headers on the file
2204 determine the formats used. This command can be used by first loading
2205 the image into RAM, then using this command to look at it or display
2208 config CMD_BOOTCOUNT
2210 depends on BOOTCOUNT_LIMIT
2212 Enable the bootcount command, which allows interrogation and
2213 reset of the bootcounter.
2216 bool "Enable board-specific commands"
2218 (deprecated: instead, please define a Kconfig option for each command)
2220 Some boards have board-specific commands which are only enabled
2221 during developemnt and need to be turned off for production. This
2222 option provides a way to control this. The commands that are enabled
2223 vary depending on the board.
2225 config CMD_BLOCK_CACHE
2226 bool "blkcache - control and stats for block cache"
2227 depends on BLOCK_CACHE
2228 default y if BLOCK_CACHE
2230 Enable the blkcache command, which can be used to control the
2231 operation of the cache functions.
2232 This is most useful when fine-tuning the operation of the cache
2233 during development, but also allows the cache to be disabled when
2234 it might hurt performance (e.g. when using the ums command).
2237 bool "blkmap - Composable virtual block devices"
2241 Create virtual block devices that are backed by various sources,
2242 e.g. RAM, or parts of an existing block device. Though much more
2243 rudimentary, it borrows a lot of ideas from Linux's device mapper
2247 - Treat a region of RAM as a block device, i.e. a RAM disk. This let's
2248 you extract files from filesystem images stored in RAM (perhaps as a
2249 result of a TFTP transfer).
2250 - Create a virtual partition on an existing device. This let's you
2251 access filesystems that aren't stored at an exact partition
2252 boundary. A common example is a filesystem image embedded in an FIT
2260 Enable the 'button' command which allows to get the status of
2261 buttons supported by the board. The buttonss can be listed with
2262 'button list' and state can be known with 'button <label>'.
2263 Any button drivers can be controlled with this command, e.g.
2267 bool "icache or dcache"
2269 Enable the "icache" and "dcache" commands
2271 config CMD_CONITRACE
2272 bool "conitrace - trace console input codes"
2274 Enable the 'conitrace' command which displays the codes received
2275 from the console input as hexadecimal numbers.
2278 bool "Enable clear screen command 'cls'"
2279 default y if LCD || VIDEO
2281 Enable the 'cls' command which clears the screen contents
2282 on video frame buffer.
2285 bool "efidebug - display/configure UEFI environment"
2286 depends on EFI_LOADER
2287 select EFI_DEVICE_PATH_TO_TEXT
2289 Enable the 'efidebug' command which provides a subset of UEFI
2290 shell utility with simplified functionality. It will be useful
2291 particularly for managing boot parameters as well as examining
2292 various EFI status for debugging.
2294 config CMD_EFICONFIG
2295 bool "eficonfig - provide menu-driven uefi variables maintenance interface"
2296 default y if !HAS_BOARD_SIZE_LIMIT
2297 depends on EFI_BOOTMGR
2300 Enable the 'eficonfig' command which provides the menu-driven UEFI
2301 variable maintenance interface.
2303 config CMD_EXCEPTION
2304 bool "exception - raise exception"
2305 depends on ARM || RISCV || SANDBOX || X86
2307 Enable the 'exception' command which allows to raise an exception.
2314 Enable the 'led' command which allows for control of LEDs supported
2315 by the board. The LEDs can be listed with 'led list' and controlled
2316 with led on/off/togle/blink. Any LED drivers can be controlled with
2317 this command, e.g. led_gpio.
2322 Enable the 'ini' command which allows a .ini file to be parsed and
2323 placed into environment variables. Please check the source code for
2324 this as there is no documentation.
2331 Enable the 'date' command for getting/setting the time/date in RTC
2339 Enable the 'rtc' command for low-level access to RTC devices.
2344 Run commands and summarize execution time.
2347 bool "gettime - read elapsed time"
2349 Enable the 'gettime' command which reads the elapsed time since
2350 U-Boot started running. This shows the time in seconds and
2351 milliseconds. See also the 'bootstage' command which provides more
2352 flexibility for boot timing.
2355 bool "pause command"
2357 Delay execution waiting for any user input.
2358 Useful to allow the user to read a failure log.
2363 default y if SANDBOX
2366 Print bytes from the hardware random number generator.
2368 config CMD_KASLRSEED
2372 Set the kaslr-seed in the chosen node with entropy provided by a
2373 hardware random number generator.
2379 Delay execution for some time
2382 bool "support for multiprocessor commands"
2386 This enables commands to bringup different processors
2387 in multiprocessor cases.
2392 Access the system timer.
2398 This provides basic access to the U-Boot's sound support. The main
2399 feature is to play a beep.
2401 sound init - set up sound system
2402 sound play - play a sound
2408 Boot image via local extlinux.conf file
2413 default y if TARGET_QEMU_ARM_32BIT || TARGET_QEMU_ARM_64BIT || \
2414 TARGET_QEMU_X86 || TARGET_QEMU_X86_64
2416 This provides access to the QEMU firmware interface. The main
2417 feature is to allow easy loading of files passed to qemu-system
2418 via -kernel / -initrd
2423 This provides access to Linux PStore with Rammoops backend. The main
2424 feature is to allow to display or save PStore records.
2426 See doc/pstore.rst for more information.
2430 config CMD_PSTORE_MEM_ADDR
2431 hex "Memory Address"
2432 depends on CMD_PSTORE
2434 Base addr used for PStore ramoops memory, should be identical to
2435 ramoops.mem_address parameter used by kernel
2437 config CMD_PSTORE_MEM_SIZE
2439 depends on CMD_PSTORE
2442 Size of PStore ramoops memory, should be identical to ramoops.mem_size
2443 parameter used by kernel, a power of 2 and larger than the sum of the
2446 config CMD_PSTORE_RECORD_SIZE
2447 hex "Dump record size"
2448 depends on CMD_PSTORE
2451 Size of each dump done on oops/panic, should be identical to
2452 ramoops.record_size parameter used by kernel and a power of 2
2455 config CMD_PSTORE_CONSOLE_SIZE
2456 hex "Kernel console log size"
2457 depends on CMD_PSTORE
2460 Size of kernel console log, should be identical to
2461 ramoops.console_size parameter used by kernel and a power of 2
2464 config CMD_PSTORE_FTRACE_SIZE
2465 hex "FTrace log size"
2466 depends on CMD_PSTORE
2469 Size of ftrace log, should be identical to ramoops.ftrace_size
2470 parameter used by kernel and a power of 2
2472 config CMD_PSTORE_PMSG_SIZE
2473 hex "User space message log size"
2474 depends on CMD_PSTORE
2477 Size of user space message log, should be identical to
2478 ramoops.pmsg_size parameter used by kernel and a power of 2
2480 config CMD_PSTORE_ECC_SIZE
2482 depends on CMD_PSTORE
2485 if non-zero, the option enables ECC support and specifies ECC buffer
2486 size in bytes (1 is a special value, means 16 bytes ECC), should be
2487 identical to ramoops.ramoops_ecc parameter used by kernel
2491 source "cmd/mvebu/Kconfig"
2494 bool "terminal - provides a way to attach a serial terminal"
2496 Provides a 'cu'-like serial terminal command. This can be used to
2497 access other serial ports from the system console. The terminal
2498 is very simple with no special processing of characters. As with
2499 cu, you can press ~. (tilde followed by period) to exit.
2502 bool "uuid, guid - generation of unique IDs"
2505 This enables two commands:
2507 uuid - generate random Universally Unique Identifier
2508 guid - generate Globally Unique Identifier based on random UUID
2510 The two commands are very similar except for the endianness of the
2513 config CMD_VIDCONSOLE
2514 bool "lcdputs and setcurs"
2518 Enabling this will provide 'setcurs' and 'lcdputs' commands which
2519 support cursor positioning and drawing strings on the video
2520 console (framebuffer).
2522 The name 'lcdputs' is a bit of a misnomer, but so named because the
2523 video device is often an LCD.
2525 config CMD_SELECT_FONT
2526 bool "select font size"
2528 default y if CONSOLE_TRUETYPE
2530 Enabling this will provide 'font' command.
2531 Allows font selection at runtime.
2535 source "cmd/ti/Kconfig"
2537 config CMD_BOOTSTAGE
2538 bool "Enable the 'bootstage' command"
2539 depends on BOOTSTAGE
2541 Add a 'bootstage' command which supports printing a report
2542 and un/stashing of bootstage data.
2544 menu "Power commands"
2546 bool "Enable Driver Model PMIC command"
2549 This is the pmic command, based on a driver model pmic's API.
2550 Command features are unchanged:
2551 - list - list pmic devices
2552 - pmic dev <id> - show or [set] operating pmic device (NEW)
2553 - pmic dump - dump registers
2554 - pmic read address - read byte of register at address
2555 - pmic write address - write byte to register at address
2556 The only one change for this command is 'dev' subcommand.
2558 config CMD_REGULATOR
2559 bool "Enable Driver Model REGULATOR command"
2560 depends on DM_REGULATOR
2562 This command is based on driver model regulator's API.
2563 User interface features:
2564 - list - list regulator devices
2565 - regulator dev <id> - show or [set] operating regulator device
2566 - regulator info - print constraints info
2567 - regulator status - print operating status
2568 - regulator value <val] <-f> - print/[set] voltage value [uV]
2569 - regulator current <val> - print/[set] current value [uA]
2570 - regulator mode <id> - print/[set] operating mode id
2571 - regulator enable - enable the regulator output
2572 - regulator disable - disable the regulator output
2574 The '-f' (force) option can be used for set the value which exceeds
2575 the limits, which are found in device-tree and are kept in regulator's
2576 uclass plat structure.
2580 menu "Security commands"
2582 bool "Enable the 'aes' command"
2585 This provides a means to encrypt and decrypt data using the AES
2586 (Advanced Encryption Standard). This algorithm uses a symetric key
2587 and is widely used as a streaming cipher. Different key lengths are
2588 supported by the algorithm but this command only supports 128 bits
2592 bool "Enable the 'blob' command"
2593 depends on !MX6ULL && !MX6SLL && !MX6SL
2594 select IMX_HAB if ARCH_MX6 || ARCH_MX7 || ARCH_MX7ULP || ARCH_IMX8M
2596 This is used with the Freescale secure boot mechanism.
2598 Freescale's SEC block has built-in Blob Protocol which provides
2599 a method for protecting user-defined data across system power
2600 cycles. SEC block protects data in a data structure called a Blob,
2601 which provides both confidentiality and integrity protection.
2603 Encapsulating data as a blob
2604 Each time that the Blob Protocol is used to protect data, a
2605 different randomly generated key is used to encrypt the data.
2606 This random key is itself encrypted using a key which is derived
2607 from SoC's non-volatile secret key and a 16 bit Key identifier.
2608 The resulting encrypted key along with encrypted data is called a
2609 blob. The non-volatile secure key is available for use only during
2612 During decapsulation, the reverse process is performed to get back
2616 blob enc - encapsulating data as a cryptgraphic blob
2617 blob dec - decapsulating cryptgraphic blob to get the data
2621 blob enc src dst len km
2623 Encapsulate and create blob of data $len bytes long
2624 at address $src and store the result at address $dst.
2625 $km is the 16 byte key modifier is also required for
2626 generation/use as key for cryptographic operation. Key
2627 modifier should be 16 byte long.
2629 blob dec src dst len km
2631 Decapsulate the blob of data at address $src and
2632 store result of $len byte at addr $dst.
2633 $km is the 16 byte key modifier is also required for
2634 generation/use as key for cryptographic operation. Key
2635 modifier should be 16 byte long.
2638 bool "Support 'hash' command"
2641 This provides a way to hash data in memory using various supported
2642 algorithms (such as SHA1, MD5, CRC32). The computed digest can be
2643 saved to memory or to an environment variable. It is also possible
2644 to verify a hash against data in memory.
2647 bool "Support the 'hvc' command"
2648 depends on ARM_SMCCC
2650 Allows issuing Hypervisor Calls (HVCs). Mostly useful for
2651 development and testing.
2654 bool "Support the 'smc' command"
2655 depends on ARM_SMCCC
2657 Allows issuing Secure Monitor Calls (SMCs). Mostly useful for
2658 development and testing.
2664 Add -v option to verify data against a hash.
2667 bool "scp03 - SCP03 enable and rotate/provision operations"
2670 This command provides access to a Trusted Application
2671 running in a TEE to request Secure Channel Protocol 03
2672 (SCP03) enablement and/or rotation of its SCP03 keys.
2681 bool "Enable the 'tpm' command"
2682 depends on TPM_V1 || TPM_V2
2683 select CMD_TPM_V1 if TPM_V1
2684 select CMD_TPM_V2 if TPM_V2
2686 This provides a means to talk to a TPM from the command line. A wide
2687 range of commands if provided - see 'tpm help' for details. The
2688 command requires a suitable TPM on your board and the correct driver
2694 bool "Enable the 'tpm test' command"
2697 This provides a a series of tests to confirm that the TPMv1.x is
2698 working correctly. The tests cover initialisation, non-volatile RAM,
2699 extend, global lock and checking that timing is within expectations.
2700 The tests pass correctly on Infineon TPMs but may need to be adjusted
2707 menu "Firmware commands"
2709 bool "Enable crosec command"
2713 Enable command-line access to the Chrome OS EC (Embedded
2714 Controller). This provides the 'crosec' command which has
2715 a number of sub-commands for performing EC tasks such as
2716 updating its flash, accessing a small saved context area
2717 and talking to the I2C bus behind the EC (if there is one).
2720 bool "Enable scmi command"
2721 depends on SCMI_FIRMWARE
2723 This command provides user interfaces to several SCMI (System
2724 Control and Management Interface) protocols available on Arm
2725 platforms to manage system resources.
2728 menu "Filesystem commands"
2730 bool "Enable the 'btrsubvol' command"
2733 This enables the 'btrsubvol' command to list subvolumes
2734 of a BTRFS filesystem. There are no special commands for
2735 listing BTRFS directories or loading BTRFS files - this
2736 can be done by the generic 'fs' commands (see CMD_FS_GENERIC)
2737 when BTRFS is enabled (see FS_BTRFS).
2740 bool "Enable the 'cbfs' command"
2743 Define this to enable support for reading from a Coreboot
2744 filesystem. This is a ROM-based filesystem used for accessing files
2745 on systems that use coreboot as the first boot-loader and then load
2746 U-Boot to actually boot the Operating System. Available commands are
2747 cbfsinit, cbfsinfo, cbfsls and cbfsload.
2750 bool "Enable the 'cramfs' command"
2751 depends on FS_CRAMFS
2753 This provides commands for dealing with CRAMFS (Compressed ROM
2754 filesystem). CRAMFS is useful when space is tight since files are
2755 compressed. Two commands are provided:
2757 cramfsls - lists files in a cramfs image
2758 cramfsload - loads a file from a cramfs image
2761 bool "EROFS command support"
2764 Support for the EROFS fs
2767 bool "ext2 command support"
2770 Enables EXT2 FS command
2773 bool "ext4 command support"
2776 Enables EXT4 FS command
2778 config CMD_EXT4_WRITE
2780 bool "ext4 write command support"
2783 Enables EXT4 FS write command
2786 bool "FAT command support"
2789 Support for the FAT fs
2792 bool "SquashFS command support"
2795 Enables SquashFS filesystem commands (e.g. load, ls).
2797 config CMD_FS_GENERIC
2798 bool "filesystem commands"
2800 Enables filesystem commands (e.g. load, ls) that work for multiple
2804 bool "fsuuid command"
2806 Enables fsuuid command for filesystem UUID.
2809 bool "jffs2 command"
2812 Enables commands to support the JFFS2 (Journalling Flash File System
2813 version 2) filesystem. This enables fsload, ls and fsinfo which
2814 provide the ability to load files, list directories and obtain
2815 filesystem information.
2818 string "Default device for JFFS2"
2819 depends on CMD_JFFS2
2822 The default device to use with the jffs2 command.
2824 config JFFS2_PART_OFFSET
2825 hex "Default offset within flash to locate the JFFS2 image"
2826 depends on CMD_JFFS2
2829 The default offset within flash to locate the JFFS2 image.
2831 config JFFS2_PART_SIZE
2832 hex "Default size of JFFS2 partition"
2833 depends on CMD_JFFS2
2836 The default size of the JFFS2 partition
2839 bool "MTD partition support"
2841 select MTD_PARTITIONS
2843 MTD partitioning tool support.
2844 It is strongly encouraged to avoid using this command
2845 anymore along with 'sf', 'nand', 'onenand'. One can still
2846 declare the partitions in the mtdparts environment variable
2847 but better use the MTD stack and the 'mtd' command instead.
2849 config CMD_MTDPARTS_SPREAD
2850 bool "Padd partition size to take account of bad blocks"
2851 depends on CMD_MTDPARTS
2853 This enables the 'spread' sub-command of the mtdparts command.
2854 This command will modify the existing mtdparts variable by increasing
2855 the size of the partitions such that 1) each partition's net size is
2856 at least as large as the size specified in the mtdparts variable and
2857 2) each partition starts on a good block.
2859 config CMD_MTDPARTS_SHOW_NET_SIZES
2860 bool "Show net size (w/o bad blocks) of partitions"
2861 depends on CMD_MTDPARTS
2863 Adds two columns to the printed partition table showing the
2864 effective usable size of a partition, if bad blocks are taken
2867 config MTDIDS_DEFAULT
2868 string "Default MTD IDs"
2869 depends on MTD || SPI_FLASH
2870 depends on !SYS_MTDPARTS_RUNTIME
2872 Defines a default MTD IDs list for use with MTD partitions in the
2873 Linux MTD command line partitions format.
2875 config MTDPARTS_DEFAULT
2876 string "Default MTD partition scheme"
2877 depends on MTD || SPI_FLASH
2878 depends on !SYS_MTDPARTS_RUNTIME
2880 Defines a default MTD partitioning scheme in the Linux MTD command
2881 line partitions format
2884 bool "zfs - Access of ZFS filesystem"
2886 This provides commands to accessing a ZFS filesystem, commonly used
2887 on Solaris systems. Two sub-commands are provided:
2889 zfsls - list files in a directory
2890 zfsload - load a file
2892 See doc/README.zfs for more details.
2896 menu "Debug commands"
2898 config CMD_CBSYSINFO
2901 default y if SYS_COREBOOT
2903 This provides information about the coreboot sysinfo table stored in
2904 memory by coreboot before jumping to U-Boot. It can be useful for
2905 debugging the beaaviour of coreboot or U-Boot.
2910 default y if SYS_COREBOOT
2912 This provides information options to check the CMOS RAM checksum,
2913 if present, as well as to update it.
2915 It is useful when coreboot CMOS-RAM settings must be examined or
2919 bool "cyclic - Show information about cyclic functions"
2923 This enables the 'cyclic' command which provides information about
2924 cyclic execution functions. This infrastructure allows registering
2925 functions to be executed cyclically, e.g. every 100ms. These commands
2928 cyclic list - list cyclic functions
2929 cyclic cyclic demo <cycletime_ms> <delay_us> - register cyclic
2932 See doc/develop/cyclic.rst for more details.
2935 bool "diag - Board diagnostics"
2937 This command provides access to board diagnostic tests. These are
2938 called Power-on Self Tests (POST). The command allows listing of
2939 available tests and running either all the tests, or specific tests
2943 bool "event - Show information about events"
2945 default y if EVENT_DEBUG
2947 This enables the 'event' command which provides information about
2948 events and event-handler routines. This can help to device event
2952 bool "irq - Show information about interrupts"
2953 depends on !ARM && !MIPS && !RISCV && !SH
2955 This enables two commands:
2957 interrupts - enable or disable interrupts
2958 irqinfo - print device-specific interrupt information
2961 bool "kgdb - Allow debugging of U-Boot with gdb"
2964 This enables a 'kgdb' command which allows gdb to connect to U-Boot
2965 over a serial link for debugging purposes. This allows
2966 single-stepping, inspecting variables, etc. This is supported only
2967 on PowerPC at present.
2970 bool "log - Generation, control and access to logging"
2974 This provides access to logging features. It allows the output of
2975 log data to be controlled to a limited extent (setting up the default
2976 maximum log level for emitting of records). It also provides access
2977 to a command used for testing the log system.
2980 bool "trace - Support tracing of function calls and timing"
2984 Enables a command to control using of function tracing within
2985 U-Boot. This allows recording of call traces including timing
2986 information. The command can write data to memory for exporting
2987 for analysis (e.g. using bootchart). See doc/develop/trace.rst
2991 bool "avb - Android Verified Boot 2.0 operations"
2992 depends on AVB_VERIFY
2994 Enables a "avb" command to perform verification of partitions using
2995 Android Verified Boot 2.0 functionality. It includes such subcommands:
2996 avb init - initialize avb2 subsystem
2997 avb read_rb - read rollback index
2998 avb write_rb - write rollback index
2999 avb is_unlocked - check device lock state
3000 avb get_uuid - read and print uuid of a partition
3001 avb read_part - read data from partition
3002 avb read_part_hex - read data from partition and output to stdout
3003 avb write_part - write data to partition
3004 avb verify - run full verification chain
3006 config CMD_STACKPROTECTOR_TEST
3007 bool "Test command for stack protector"
3008 depends on STACKPROTECTOR
3010 Enable stackprot_test command
3011 The stackprot_test command will force a stack overrun to test
3012 the stack smashing detection mechanisms.
3017 tristate "Enable UBI - Unsorted block images commands"
3020 UBI is a software layer above MTD layer which admits use of LVM-like
3021 logical volumes on top of MTD devices, hides some complexities of
3022 flash chips like wear and bad blocks and provides some other useful
3023 capabilities. Please, consult the MTD web site for more details
3024 (www.linux-mtd.infradead.org). Activate this option if you want
3025 to use U-Boot UBI commands.
3026 It is also strongly encouraged to also enable CONFIG_MTD to get full
3029 config CMD_UBI_RENAME
3030 bool "Enable rename"
3033 Enable a "ubi" command to rename ubi volume:
3034 ubi rename <oldname> <newname>
3037 tristate "Enable UBIFS - Unsorted block images filesystem commands"
3039 default y if CMD_UBI
3043 UBIFS is a file system for flash devices which works on top of UBI.
3046 bool "Amlogic Meson commands"
3047 depends on ARCH_MESON
3050 Enable useful commands for the Meson Soc family developed by Amlogic Inc.