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.
179 config CMD_FWU_METADATA
180 bool "fwu metadata read"
181 depends on FWU_MULTI_BANK_UPDATE
183 Command to read the metadata and dump it's contents
187 depends on CMDLINE_EDITING
189 Show the command-line history, i.e. a list of commands that are in
192 config CMD_HISTORY_USE_CALLOC
193 bool "dynamically allocate memory"
195 depends on CMD_HISTORY
197 Saying Y to this will use calloc to get the space for history
198 storing. Otherwise the history buffer will be an uninitialized
199 static array directly, without the memory allocation, and it is
200 writable after relocation to RAM. If u-boot is running from ROM
201 all the time or unsure, say Y to this.
208 Print GPL license text
213 Provides access to the Intel Power-Management Controller (PMC) so
214 that its state can be examined. This does not currently support
215 changing the state but it is still useful for debugging and seeing
226 depends on TYPEC_TCPM
228 Show voltage and current negotiated via USB PD as well as the
229 current state of the Type C Port Manager (TCPM) state machine.
231 config CMD_TLV_EEPROM
233 depends on I2C_EEPROM
236 Display and program the system EEPROM data block in ONIE Tlvinfo
237 format. TLV stands for Type-Length-Value.
239 config SPL_CMD_TLV_EEPROM
240 bool "tlv_eeprom for SPL"
241 depends on SPL_I2C_EEPROM
242 select SPL_DRIVERS_MISC
245 Read system EEPROM data block in ONIE Tlvinfo format from SPL.
249 depends on RISCV_SMODE && SBI_V02
251 Display information about the SBI implementation.
257 Display the SMBIOS information.
267 Run the command stored in the environment "bootcmd", i.e.
268 "bootd" does the same thing as "run bootcmd".
274 Boot an application image from the memory.
276 config CMD_BOOTM_PRE_LOAD
277 bool "enable pre-load on bootm"
279 depends on IMAGE_PRE_LOAD
281 Enable support of stage pre-load for the bootm command.
282 This stage allow to check or modify the image provided
283 to the bootm command.
288 default y if BOOTSTD_FULL
290 Support listing available bootdevs (boot devices) which can provide an
291 OS to boot, as well as showing information about a particular one.
293 This command is not necessary for bootstd to work.
300 Support scanning for bootflows available with the bootdevs. The
301 bootflows can optionally be booted.
303 config CMD_BOOTFLOW_FULL
304 bool "bootflow - extract subcommands"
305 depends on BOOTSTD_FULL
308 Add the ability to list the available bootflows, select one and obtain
309 information about it.
311 This command is not necessary for bootstd to work.
316 default y if BOOTSTD_FULL
318 Support listing available bootmeths (methods used to boot an
319 Operating System), as well as selecting the order that the bootmeths
322 This command is not necessary for bootstd to work.
325 bool "Support booting UEFI FIT images"
326 depends on EFI_BINARY_EXEC && CMD_BOOTM && FIT
329 Support booting UEFI FIT images via the bootm command.
332 bool "Support booting ELF images"
333 depends on CMD_BOOTM && LIB_ELF
336 Support booting ELF images via the bootm command.
341 Boot the Linux zImage
345 depends on ARM64 || RISCV || SANDBOX
348 Boot an AArch64 Linux Kernel image from memory.
351 bool "Support booting Linux OS images"
352 depends on CMD_BOOTM || CMD_BOOTZ || CMD_BOOTI
355 Support booting the Linux kernel directly via a command such as bootm
359 bool "Support booting NetBSD (non-EFI) loader images"
363 Support booting NetBSD via the bootm command.
365 config BOOTM_OPENRTOS
366 bool "Support booting OPENRTOS / FreeRTOS images"
369 Support booting OPENRTOS / FreeRTOS via the bootm command.
372 bool "Support booting Enea OSE images"
373 depends on (ARM && (ARM64 || CPU_V7A || CPU_V7R) || SANDBOX || PPC || X86)
376 Support booting Enea OSE images via the bootm command.
379 bool "Support booting Plan9 OS images"
383 Support booting Plan9 images via the bootm command.
386 bool "Support booting RTEMS OS images"
390 Support booting RTEMS images via the bootm command.
393 bool "Support read SEAMA NAND images"
394 depends on MTD_RAW_NAND
396 Support reading NAND Seattle Image (SEAMA) images.
399 bool "upl - Universal Payload Specification"
401 Provides commands to deal with UPL payloads and handoff information.
402 U-Boot supports generating and accepting handoff information. The
403 mkimage tool will eventually support creating payloads.
406 bool "vbe - Verified Boot for Embedded"
407 depends on BOOTMETH_VBE
408 default y if BOOTSTD_FULL
410 Provides various subcommands related to VBE, such as listing the
411 available methods, looking at the state and changing which method
412 is used to boot. Updating the parameters is not currently
416 bool "Support booting VxWorks OS images"
420 Support booting VxWorks images via the bootm command.
424 depends on EFI_LOADER
427 Boot an EFI image from memory.
430 config CMD_BOOTEFI_BINARY
431 bool "Allow booting an EFI binary directly"
432 depends on EFI_BINARY_EXEC
435 Select this option to enable direct execution of binary at 'bootefi'.
436 This subcommand will allow you to load the UEFI binary using
437 other U-Boot commands or external methods and then run it.
439 config CMD_BOOTEFI_BOOTMGR
440 bool "UEFI Boot Manager command"
441 depends on EFI_BOOTMGR
444 Select this option to enable the 'bootmgr' subcommand of 'bootefi'.
445 This subcommand will allow you to select the UEFI binary to be booted
446 via UEFI variables Boot####, BootOrder, and BootNext.
448 config CMD_BOOTEFI_HELLO
449 bool "Allow booting a standard EFI hello world for testing"
450 depends on CMD_BOOTEFI_BINARY && BOOTEFI_HELLO_COMPILE
451 default y if CMD_BOOTEFI_SELFTEST
453 This adds a standard EFI hello world application to U-Boot so that
454 it can be used with the 'bootefi hello' command. This is useful
455 for testing that EFI is working at a basic level, and for bringing
456 up EFI support on a new architecture.
458 source "lib/efi_selftest/Kconfig"
466 Add an ANSI terminal boot menu command.
471 Android DTB/DTBO image manipulation commands. Read dtb/dtbo files from
472 image into RAM, dump image structure information, etc. Those dtb/dtbo
473 files should be merged in one dtb further, which needs to be passed to
474 the kernel, as part of a boot process.
478 depends on ANDROID_BOOT_IMAGE
480 Android Boot Image manipulation commands. Allows one to extract
481 images contained in boot.img, like kernel, ramdisk, dtb, etc, and
482 obtain corresponding meta-information from boot.img.
484 See doc/android/boot-image.rst for details.
487 bool "cedit - Configuration editor"
491 Provides a command to allow editing of board configuration and
492 providing a UI for the user to adjust settings. Subcommands allow
493 loading and saving of configuration as well as showing an editor.
500 Boot an ELF image from memory.
502 config CMD_ELF_BOOTVX
507 Boot a vxWorks image from memory
509 config CMD_ELF_FDT_SETUP
510 bool "Flattened Device Tree setup in bootelf cmd"
514 Do FDT setup in bootelf command optionally by param -d, which
515 allows to bring additional system info (e.g. /memory node) to
516 the Operating System or application.
519 bool "Flattened Device Tree utility commands"
523 Do FDT related setup before booting into the Operating System.
525 config SUPPORT_EXTENSION_SCAN
529 bool "Extension board management command"
531 depends on SUPPORT_EXTENSION_SCAN
533 Enables the "extension" command, which allows to detect
534 extension boards connected to the system, and apply
535 corresponding Device Tree overlays.
541 Start an application at a given address.
547 Run the command in the given environment variable.
553 Print header information for application image.
557 depends on MTD_NOR_FLASH || FLASH_CFI_DRIVER
559 List all images found in flash
565 Extract a part of a multi-image.
568 hex "imxtract max gunzip size"
570 depends on CMD_XIMG && GZIP
572 This provides the size of the commad-line argument area
573 used by imxtract for extracting pieces of FIT image.
574 It should be large enough to fit uncompressed size of
575 FIT piece we are extracting.
578 bool "spl export - Export boot information for Falcon boot"
581 Falcon mode allows booting directly from SPL into an Operating
582 System such as Linux, thus skipping U-Boot proper. See
583 doc/README.falcon for full information about how to use this
586 config CMD_SPL_NAND_OFS
587 hex "Offset of OS args or dtb for Falcon-mode NAND boot"
588 depends on CMD_SPL && (TPL_NAND_SUPPORT || SPL_NAND_SUPPORT)
591 This provides the offset of the command line arguments for Linux
592 when booting from NAND in Falcon mode. See doc/README.falcon
593 for full information about how to use this option (and also see
594 board/gateworks/gw_ventana/README for an example).
596 config CMD_SPL_NOR_OFS
597 hex "Offset of OS args or dtb for Falcon-mode NOR boot"
598 depends on CMD_SPL && SPL_NOR_SUPPORT
601 This provides the offset of the command line arguments or dtb for
602 Linux when booting from NOR in Falcon mode.
604 config CMD_SPL_WRITE_SIZE
605 hex "Size of argument area"
609 This provides the size of the command-line argument area in NAND
610 flash used by Falcon-mode boot. See the documentation until CMD_SPL
613 config CMD_THOR_DOWNLOAD
614 bool "thor - TIZEN 'thor' download"
616 select USB_FUNCTION_THOR
617 depends on USB_GADGET_DOWNLOAD
619 Implements the 'thor' download protocol. This is a way of
620 downloading a software update over USB from an attached host.
621 There is no documentation about this within the U-Boot source code
622 but you should be able to find something on the interwebs.
624 config THOR_RESET_OFF
625 bool "thor: Disable reset on completion"
626 depends on CMD_THOR_DOWNLOAD
629 bool "zboot - x86 boot command"
633 With x86 machines it is common to boot a bzImage file which
634 contains both a kernel and a setup.bin file. The latter includes
635 configuration information from the dark ages which x86 boards still
636 need to pick things out of.
638 Consider using FIT in preference to this since it supports directly
639 booting both 32- and 64-bit kernels, as well as secure boot.
640 Documentation is available in doc/usage/fit/x86-fit-boot.rst.
644 menu "Environment commands"
647 bool "ask for env variable"
649 Ask for environment variable
667 Edit environment variable.
672 Allow for searching environment variables
678 Save all environment variables into the compiled-in persistent
683 depends on CMD_SAVEENV
685 Erase environment variables from the compiled-in persistent
688 config CMD_ENV_EXISTS
692 Check if a variable is defined in the environment for use in
695 config CMD_ENV_CALLBACK
696 bool "env callbacks - print callbacks and their associated variables"
698 Some environment variable have callbacks defined by
699 U_BOOT_ENV_CALLBACK. These are called when the variable changes.
700 For example changing "baudrate" adjust the serial baud rate. This
701 command lists the currently defined callbacks.
704 bool "env flags -print variables that have non-default flags"
706 Some environment variables have special flags that control their
707 behaviour. For example, serial# can only be written once and cannot
708 be deleted. This command shows the variables that have special
711 config CMD_NVEDIT_EFI
712 bool "env [set|print] -e - set/print UEFI variables"
713 depends on EFI_LOADER
716 UEFI variables are encoded as some form of U-Boot variables.
717 If enabled, we are allowed to set/print UEFI variables using
718 "env" command with "-e" option without knowing details.
720 config CMD_NVEDIT_INDIRECT
721 bool "env indirect - Sets environment value from another"
723 config CMD_NVEDIT_INFO
724 bool "env info - print or evaluate environment information"
726 Print environment information:
727 - env_valid : is environment valid
728 - env_ready : is environment imported into hash table
729 - env_use_default : is default environment used
731 This command can be optionally used for evaluation in scripts:
732 [-d] : evaluate whether default environment is used
733 [-p] : evaluate whether environment can be persisted
735 The result of multiple evaluations will be combined with AND.
737 config CMD_NVEDIT_LOAD
740 Load all environment variables from the compiled-in persistent
743 config CMD_NVEDIT_SELECT
746 Select the compiled-in persistent storage of environment variables.
750 menu "Memory commands"
755 Compute binary operations (xor, or, and) of byte arrays of arbitrary
756 size from memory and store the result in memory or the environment.
763 Show information about the bloblist, a collection of binary blobs
764 held in memory that persist between SPL and U-Boot. In the case of
765 x86 devices the bloblist can be used to hold ACPI tables so that they
766 remain available in memory.
779 Add -v option to verify data against a crc32 checksum.
782 bool "eeprom - EEPROM subsystem"
783 depends on DM_I2C || SYS_I2C_LEGACY
785 (deprecated, needs conversion to driver model)
786 Provides commands to read and write EEPROM (Electrically Erasable
787 Programmable Read Only Memory) chips that are connected over an
790 config CMD_EEPROM_LAYOUT
791 bool "Enable layout-aware eeprom commands"
792 depends on CMD_EEPROM
794 (deprecated, needs conversion to driver model)
795 When enabled, additional eeprom sub-commands become available.
797 eeprom print - prints the contents of the eeprom in a human-readable
798 way (eeprom layout fields, and data formatted to be fit for human
801 eeprom update - allows user to update eeprom fields by specifying
802 the field name, and providing the new data in a human readable format
803 (same format as displayed by the eeprom print command).
805 Both commands can either auto detect the layout, or be told which
809 __weak int parse_layout_version(char *str)
810 - override to provide your own layout name parsing
811 __weak void __eeprom_layout_assign(struct eeprom_layout *layout,
813 - override to setup the layout metadata based on the version
814 __weak int eeprom_layout_detect(unsigned char *data)
815 - override to provide your own algorithm for detecting layout
818 - contains various printing and updating functions for common
819 types of eeprom fields. Can be used for defining
822 config EEPROM_LAYOUT_VERSIONS
823 bool "Support specifying eeprom layout version"
824 depends on CMD_EEPROM_LAYOUT
826 Support specifying eeprom layout version in the 'eeprom' command
829 config EEPROM_LAYOUT_HELP_STRING
830 string "Tells user what layout names are supported"
831 depends on EEPROM_LAYOUT_VERSIONS
832 default "<not defined>"
834 Help printed with the LAYOUT VERSIONS part of the 'eeprom'
837 config SYS_I2C_EEPROM_BUS
838 int "I2C bus of the EEPROM device."
839 depends on CMD_EEPROM
842 config SYS_I2C_EEPROM_ADDR_LEN
843 int "Length in bytes of the EEPROM memory array address"
844 depends on CMD_EEPROM || ID_EEPROM
848 Note: This is NOT the chip address length!
850 config SYS_EEPROM_SIZE
851 depends on CMD_EEPROM
852 int "Size in bytes of the EEPROM device"
855 config SYS_EEPROM_PAGE_WRITE_BITS
856 int "Number of bits used to address bytes in a single page"
857 depends on CMD_EEPROM || ENV_IS_IN_EEPROM
860 The EEPROM page size is 2^SYS_EEPROM_PAGE_WRITE_BITS.
861 A 64 byte page, for example would require six bits.
863 config SYS_EEPROM_PAGE_WRITE_DELAY_MS
864 int "Number of milliseconds to delay between page writes"
865 depends on CMD_EEPROM || CMD_I2C
871 Infinite write loop on address range
878 Compute MD5 checksum.
882 depends on CMD_MD5SUM
884 Add -v option to verify data against an MD5 checksum.
890 Display memory information.
892 config CMD_MEMINFO_MAP
893 bool "- with memory map"
894 depends on CMD_MEMINFO
897 Shows a memory map, in addition to just the DRAM size. This allows
898 seeing where U-Boot's memory area is, at the top of DRAM, as well as
899 detail about each piece of it.
901 See doc/usage/cmd/meminfo.rst for more information.
904 bool "md, mm, nm, mw, cp, cmp, base, loop"
909 mm - memory modify (auto-incrementing address)
910 nm - memory modify (constant address)
911 mw - memory write (fill)
914 base - print or set address offset
915 loop - initialize loop on address range
917 config CMD_MEM_SEARCH
918 bool "ms - Memory search"
920 Memory-search command
922 This allows searching through a region of memory looking for hex
923 data (byte, 16-bit word, 32-bit long, also 64-bit on machines that
924 support it). It is also possible to search for a string. The
925 command accepts a memory range and a list of values to search for.
926 The values need to appear in memory in the same order they are given
927 in the command. At most 10 matches can be returned at a time, but
928 pressing return will show the next 10 matches. Environment variables
929 are set for use with scripting (memmatches, memaddr, mempos).
932 bool "Enable cyclic md/mw commands"
933 depends on CMD_MEMORY
935 Add the "mdc" and "mwc" memory commands. These are cyclic
940 This command will print 4 bytes (10,11,12,13) each 500 ms.
942 => mwc.l 100 12345678 10
943 This command will write 12345678 to address 100 all 10 ms.
948 depends on CMD_MEMORY && (LIB_RAND || LIB_HW_RAND)
950 random - fill memory with random data
955 Simple RAM read/write test.
959 config SYS_ALT_MEMTEST
960 bool "Alternative test"
962 Use a more complete alternative memory test.
966 config SYS_ALT_MEMTEST_BITFLIP
970 The alternative memory test includes bitflip test since 2020.07.
971 The bitflip test significantly increases the overall test time.
972 Bitflip test can optionally be disabled here.
976 config SYS_MEMTEST_START
977 hex "default start address for mtest"
980 This is the default start address for mtest for simple read/write
981 test. If no arguments are given to mtest, default address is used
984 config SYS_MEMTEST_END
985 hex "default end address for mtest"
988 This is the default end address for mtest for simple read/write
989 test. If no arguments are given to mtest, default address is used
998 Compute SHA1 checksum.
1000 config SHA1SUM_VERIFY
1002 depends on CMD_SHA1SUM
1004 Add -v option to verify data against a SHA1 checksum.
1007 bool "strings - display strings in memory"
1009 This works similarly to the Unix 'strings' command except that it
1010 works with a memory range. String of printable characters found
1011 within the range are displayed. The minimum number of characters
1012 for a sequence to be considered a string can be provided.
1016 menu "Compression commands"
1020 default y if CMD_BOOTI
1023 Support decompressing an LZMA (Lempel-Ziv-Markov chain algorithm)
1028 default y if CMD_BOOTI
1031 Support decompressing an LZ4 image from memory region.
1035 default y if CMD_BOOTI
1038 Uncompress a zip-compressed memory region.
1042 select GZIP_COMPRESSED
1044 Compress a memory region with zlib deflate method.
1048 menu "Device access commands"
1051 bool "Arm FF-A test command"
1052 depends on ARM_FFA_TRANSPORT
1054 Provides a test command for the FF-A support
1056 - Listing the partition(s) info
1057 - Sending a data pattern to the specified partition
1058 - Displaying the arm_ffa device info
1062 depends on FLASH_CFI_DRIVER
1064 ARM Ltd reference designs flash partition access
1067 bool "adc - Access Analog to Digital Converters info and data"
1069 depends on DM_REGULATOR
1071 Shows ADC device info and permit printing one-shot analog converted
1072 data from a named Analog to Digital Converter.
1076 depends on PARTITIONS
1078 Read/modify/write the fields of Bootloader Control Block, usually
1079 stored on the flash "misc" partition with its structure defined in:
1080 https://android.googlesource.com/platform/bootable/recovery/+/master/
1081 bootloader_message/include/bootloader_message/bootloader_message.h
1083 Some real-life use-cases include (but are not limited to):
1084 - Determine the "boot reason" (and act accordingly):
1085 https://source.android.com/devices/bootloader/boot-reason
1086 - Get/pass a list of commands from/to recovery:
1087 https://android.googlesource.com/platform/bootable/recovery
1088 - Inspect/dump the contents of the BCB fields
1091 bool "bind/unbind - Bind or unbind a device to/from a driver"
1095 Bind or unbind a device to/from a driver from the command line.
1096 This is useful in situations where a device may be handled by several
1097 drivers. For example, this can be used to bind a UDC to the usb ether
1098 gadget driver from the command line.
1101 bool "clk - Show and set clock frequencies"
1104 Show and set clock frequencies managed by CLK uclass drivers.
1107 bool "demo - Demonstration commands for driver model"
1110 Provides a 'demo' command which can be used to play around with
1111 driver model. To use this properly you will need to enable one or
1112 both of the demo devices (DM_DEMO_SHAPE and DM_DEMO_SIMPLE).
1113 Otherwise you will always get an empty list of devices. The demo
1114 devices are defined in the sandbox device tree, so the easiest
1115 option is to use sandbox and pass the -d point to sandbox's
1122 Enables the command "dfu" which is used to have U-Boot create a DFU
1123 class device via USB. This command requires that the "dfu_alt_info"
1124 environment variable be set and define the alt settings to expose to
1128 bool "dm - Access to driver model information"
1131 Provides access to driver model data structures and information,
1132 such as a list of devices, list of uclasses and the state of each
1133 device (e.g. activated). This is not required for operation, but
1134 can be useful to see the state of driver model for debugging or
1138 bool "fastboot - Android fastboot support"
1141 This enables the command "fastboot" which enables the Android
1142 fastboot mode for the platform. Fastboot is a protocol for
1143 downloading images, flashing and device control used on
1144 Android devices. Fastboot requires either the network stack
1145 enabled or support for acting as a USB device.
1147 See doc/android/fastboot.rst for more information.
1150 bool "flinfo, erase, protect"
1152 depends on FLASH_CFI_DRIVER || MTD_NOR_FLASH
1155 flinfo - print FLASH memory information
1156 erase - FLASH memory
1157 protect - enable or disable FLASH write protection
1166 config CMD_FPGA_LOADBP
1167 bool "fpga loadbp - load partial bitstream (Xilinx only)"
1170 Supports loading an FPGA device from a bitstream buffer containing
1171 a partial bitstream.
1173 config CMD_FPGA_LOADFS
1174 bool "fpga loadfs - load bitstream from FAT filesystem (Xilinx only)"
1177 Supports loading an FPGA device from a FAT filesystem.
1179 config CMD_FPGA_LOADMK
1180 bool "fpga loadmk - load bitstream from image"
1183 Supports loading an FPGA device from a image generated by mkimage.
1185 config CMD_FPGA_LOADP
1186 bool "fpga loadp - load partial bitstream"
1189 Supports loading an FPGA device from a bitstream buffer containing
1190 a partial bitstream.
1192 config CMD_FPGA_LOAD_SECURE
1193 bool "fpga loads - loads secure bitstreams"
1195 select FPGA_LOAD_SECURE
1197 Enables the fpga loads command which is used to load secure
1198 (authenticated or encrypted or both) bitstreams on to FPGA.
1201 bool "fpgad - dump FPGA registers"
1202 depends on GDSYS_LEGACY_DRIVERS
1204 (legacy, needs conversion to driver model)
1205 Provides a way to dump FPGA registers by calling the board-specific
1206 fpga_get_reg() function. This functions similarly to the 'md'
1210 bool "fuse - support for the fuse subssystem"
1212 (deprecated - needs conversion to driver model)
1213 This allows reading, sensing, programming or overriding fuses
1214 which control the behaviour of the device. The command uses the
1222 config CMD_GPIO_READ
1223 bool "gpio read - save GPIO value to variable"
1226 Enables the 'gpio read' command that saves the value
1227 of a GPIO pin to a variable.
1233 Control PWM channels, this allows invert/config/enable/disable PWM channels.
1236 bool "GPT (GUID Partition Table) command"
1237 select EFI_PARTITION
1238 select PARTITION_UUIDS
1241 Enable the 'gpt' command to ready and write GPT style partition
1244 config CMD_GPT_RENAME
1245 bool "GPT partition renaming commands"
1248 Enables the 'gpt' command to interchange names on two GPT
1249 partitions via the 'gpt swap' command or to rename single
1250 partitions via the 'rename' command.
1253 bool "ide - Support for IDE drivers"
1256 Provides an 'ide' command which allows accessing the IDE drive,
1257 resetting the IDE interface, printing the partition table and
1258 geting device info. It also enables the 'diskboot' command which
1259 permits booting from an IDE drive.
1262 bool "io - Support for performing I/O accesses"
1264 Provides an 'iod' command to display I/O space and an 'iow' command
1265 to write values to the I/O space. This can be useful for manually
1266 checking the state of devices during boot when debugging device
1270 bool "iotrace - Support for tracing I/O activity"
1272 Provides an 'iotrace' command which supports recording I/O reads and
1273 writes in a trace buffer in memory . It also maintains a checksum
1274 of the trace records (even if space is exhausted) so that the
1275 sequence of I/O accesses can be verified.
1277 When debugging drivers it is useful to see what I/O accesses were
1278 done and in what order.
1280 Even if the individual accesses are of little interest it can be
1281 useful to verify that the access pattern is consistent each time
1282 an operation is performed. In this case a checksum can be used to
1283 characterise the operation of a driver. The checksum can be compared
1284 across different runs of the operation to verify that the driver is
1287 In particular, when performing major refactoring of the driver, where
1288 the access pattern should not change, the checksum provides assurance
1289 that the refactoring work has not broken the driver.
1291 This works by sneaking into the io.h heder for an architecture and
1292 redirecting I/O accesses through iotrace's tracing mechanism.
1294 For now no commands are provided to examine the trace buffer. The
1295 format is fairly simple, so 'md' is a reasonable substitute.
1297 Note: The checksum feature is only useful for I/O regions where the
1298 contents do not change outside of software control. Where this is not
1299 suitable you can fall back to manually comparing the addresses. It
1300 might be useful to enhance tracing to only checksum the accesses and
1301 not the data read/written.
1311 bool "w1 - Support for Dallas 1-Wire protocol"
1313 Dallas 1-wire protocol support
1319 Load a binary file over serial line.
1324 Load a binary over memory mapped.
1327 bool "loads - Load a file over serial in S-Record format"
1330 Load an S-Record file over serial line
1333 bool "Echo all characters received during a loads back to console"
1334 depends on CMD_LOADS
1336 If enabled, all characters received during a serial download (using
1337 the "loads" command) are echoed back. This might be needed by some
1338 terminal emulations (like "cu"), but may as well just take time on
1339 others. This sets the initial value of the "loads_echo" environment
1343 bool "saves - Save a file over serial in S-Record format"
1344 depends on CMD_LOADS
1346 Provides a way to save a binary file using the Motorola S-Record
1347 format over the serial line.
1349 config SYS_LOADS_BAUD_CHANGE
1350 bool "Enable a temporary baudrate change during loads/saves command"
1351 depends on CMD_LOADS || CMD_SAVES
1353 config CMD_LOADXY_TIMEOUT
1354 int "loadxy_timeout"
1358 Initial timeout for loadx and loady commands. Zero means infinity.
1362 bool "lsblk - list block drivers and devices"
1364 Print list of available block device drivers, and for each, the list
1365 of known block devices.
1368 bool "MBR (Master Boot Record) command"
1369 select DOS_PARTITION
1371 Enable the 'mbr' command to ready and write MBR (Master Boot Record)
1372 style partition tables.
1378 Enable the command "misc" for accessing miscellaneous devices with
1379 a MISC uclass driver. The command provides listing all MISC devices
1380 as well as read and write functionalities via their drivers.
1386 MMC memory mapped support.
1390 config CMD_BKOPS_ENABLE
1391 bool "mmc bkops enable"
1394 Enable command for setting manual background operations handshake
1395 on a eMMC device. The feature is optionally available on eMMC devices
1396 conforming to standard >= 4.41.
1399 bool "Enable support for reading card registers in the mmc command"
1402 Enable the commands for reading card registers. This is useful
1403 mostly for debugging or extracting details from the card.
1406 bool "Enable support for RPMB in the mmc command"
1407 depends on SUPPORT_EMMC_RPMB
1409 Enable the commands for reading, writing and programming the
1410 key for the Replay Protection Memory Block partition in eMMC.
1412 config CMD_MMC_SWRITE
1414 depends on MMC_WRITE
1417 Enable support for the "mmc swrite" command to write Android sparse
1420 config MMC_SPEED_MODE_SET
1421 bool "set speed mode using mmc command"
1423 Enable setting speed mode using mmc rescan and mmc dev commands.
1424 The speed mode is provided as the last argument in these commands
1425 and is indicated using the index from enum bus_mode in
1426 include/mmc.h. A speed mode can be set only if it has already
1427 been enabled in the device tree.
1435 Enable storage cloning over block devices, useful for
1436 initial flashing by external block device without network
1439 config CMD_OPTEE_RPMB
1440 bool "Enable read/write support on RPMB via OPTEE"
1441 depends on (SUPPORT_EMMC_RPMB && OPTEE) || SANDBOX_TEE
1442 default y if SANDBOX_TEE
1443 select OPTEE_TA_AVB if SANDBOX_TEE
1445 Enable the commands for reading, writing persistent named values
1446 in the Replay Protection Memory Block partition in eMMC by
1447 using Persistent Objects in OPTEE
1452 select MTD_PARTITIONS
1454 MTD commands support.
1461 MTD commands for OTP access.
1465 depends on MULTIPLEXER
1467 List, select, and deselect mux controllers on the fly.
1471 default y if NAND_SUNXI
1472 depends on MTD_RAW_NAND
1477 config CMD_NAND_TRIMFFS
1478 bool "nand write.trimffs"
1479 default y if ARCH_SUNXI
1481 Allows one to skip empty pages when flashing something on a NAND.
1483 config CMD_NAND_LOCK_UNLOCK
1484 bool "nand lock/unlock"
1486 NAND locking support.
1488 config CMD_NAND_TORTURE
1491 NAND torture support.
1500 NVM Express device support
1503 bool "onenand - access to onenand device"
1506 OneNAND is a brand of NAND ('Not AND' gate) flash which provides
1507 various useful features. This command allows reading, writing,
1508 and erasing blocks. It allso provides a way to show and change
1509 bad blocks, and test the device.
1511 config USE_ONENAND_BOARD_INIT
1512 bool "Call onenand_board_init() in the onenand command"
1513 depends on CMD_ONENAND
1519 Enable the 'osd' command which allows to query information from and
1520 write text data to a on-screen display (OSD) device; a virtual device
1521 associated with a display capable of displaying a text overlay on the
1522 display it's associated with..
1526 depends on PARTITIONS
1527 select PARTITION_UUIDS
1529 Read and display information about the partition table on
1533 bool "pci - Access PCI devices"
1535 Provide access to PCI (Peripheral Interconnect Bus), a type of bus
1536 used on some devices to allow the CPU to communicate with its
1537 peripherals. Sub-commands allow bus enumeration, displaying and
1538 changing configuration space and a few other features.
1541 bool "pci_mps - Configure PCI device MPS"
1544 Enables PCI Express Maximum Packet Size (MPS) tuning. This
1545 command configures the PCI Express MPS of each endpoint to the
1546 largest value supported by all devices below the root complex.
1547 The Maximum Read Request Size will not be altered. This method is
1548 the same algorithm as used by Linux pci=pcie_bus_safe.
1551 bool "pinmux - show pins muxing"
1553 default y if PINCTRL
1555 Parse all available pin-controllers and show pins muxing. This
1556 is useful for debug purpoer to check the pin muxing and to know if
1557 a pin is configured as a GPIO or as an alternate function.
1562 Poweroff/Shutdown the system
1565 bool "read - Read binary data from a partition"
1567 Provides low-level access to the data in a partition.
1569 config CMD_REMOTEPROC
1571 depends on REMOTEPROC
1573 Support for Remote Processor control
1576 bool "sata - Access SATA subsystem"
1579 SATA (Serial Advanced Technology Attachment) is a serial bus
1580 standard for connecting to hard drives and other storage devices.
1581 This command provides information about attached devices and allows
1582 reading, writing and other operations.
1584 SATA replaces PATA (originally just ATA), which stands for Parallel AT
1585 Attachment, where AT refers to an IBM AT (Advanced Technology)
1586 computer released in 1984.
1589 bool "scsi - Access to SCSI devices"
1593 This provides a 'scsi' command which provides access to SCSI (Small
1594 Computer System Interface) devices. The command provides a way to
1595 scan the bus, reset the bus, read and write data and get information
1599 bool "sdram - Print SDRAM configuration information"
1601 Provides information about attached SDRAM. This assumed that the
1602 SDRAM has an EEPROM with information that can be read using the
1603 I2C bus. This is only available on some boards.
1607 depends on DM_SPI_FLASH || SPI_FLASH
1608 default y if DM_SPI_FLASH
1613 bool "sf test - Allow testing of SPI flash"
1616 Provides a way to test that SPI flash is working correctly. The
1617 test is destructive, in that an area of SPI flash must be provided
1618 for the test to use. Performance information is also provided,
1619 measuring the performance of reading, writing and erasing in
1620 Mbps (Million Bits Per Second). This value should approximately
1621 equal the SPI bus speed for a single-bit-wide SPI bus, assuming
1622 everything is working properly.
1625 bool "sspi - Command to access spi device"
1628 SPI utility command.
1630 config DEFAULT_SPI_BUS
1631 int "default spi bus used by sspi command"
1635 config DEFAULT_SPI_MODE
1636 hex "default spi mode used by sspi command (see include/spi.h)"
1640 config CMD_TEMPERATURE
1641 bool "temperature - display the temperature from thermal sensors"
1642 depends on DM_THERMAL
1644 Provides a way to list thermal sensors and to get their readings.
1647 bool "tsi148 - Command to access tsi148 device"
1648 depends on DM_PCI_COMPAT
1650 This provides various sub-commands to initialise and configure the
1651 Turndra tsi148 device. See the command help for full details.
1654 bool "ufs - Universal Flash Storage commands"
1657 "This provides commands to initialise and configure universal flash
1661 bool "universe - Command to set up the Turndra Universe controller"
1662 depends on DM_PCI_COMPAT
1664 This allows setting up the VMEbus provided by this controller.
1665 See the command help for full details.
1675 depends on USB_GADGET_DOWNLOAD
1676 select USB_FUNCTION_SDP
1678 Enables the command "sdp" which is used to have U-Boot emulating the
1679 Serial Download Protocol (SDP) via USB.
1685 Enable the command "rkmtd" to create a virtual block device to transfer
1686 Rockchip boot block data to and from NAND with block orientated tools
1687 like "ums" and "rockusb".
1691 depends on USB_FUNCTION_ROCKUSB
1693 Rockusb protocol is widely used by Rockchip SoC based devices. It can
1694 read/write info, image to/from devices. This enable rockusb command
1695 support to communication with rockusb device. for more detail about
1696 this command, please read doc/README.rockusb.
1698 config CMD_USB_MASS_STORAGE
1699 bool "UMS usb mass storage"
1700 depends on BLK && USB_GADGET_DOWNLOAD
1701 select USB_FUNCTION_MASS_STORAGE
1703 Enables the command "ums" and the USB mass storage support to the
1704 export a block device: U-Boot, the USB device, acts as a simple
1705 external hard drive plugged on the host USB port.
1707 config CMD_UMS_ABORT_KEYED
1708 bool "UMS abort with any key"
1709 depends on CMD_USB_MASS_STORAGE
1711 Allow interruption of usb mass storage run with any key pressed.
1714 bool "Xen para-virtualized block device"
1718 Xen para-virtualized block device support
1725 VirtIO block device support
1731 This provides commands to control the watchdog timer devices.
1734 bool "write - Write binary data to a partition"
1736 Provides low-level write access to a partition.
1742 Enable the command "axi" for accessing AXI (Advanced eXtensible
1743 Interface) busses, a on-chip interconnect specification for managing
1744 functional blocks in SoC designs, which is also often used in designs
1745 involving FPGAs (e.g. communication with IP cores in Xilinx FPGAs).
1749 menu "Shell scripting commands"
1754 Print file to standard output
1760 Echo args to console
1766 Return true/false on integer compare.
1772 Run script from memory
1778 Evaluate boolean and math expressions and store the result in an env
1780 Also supports loading the value at a memory location into a variable.
1781 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
1783 config CMD_SETEXPR_FMT
1785 depends on CMD_SETEXPR
1787 Evaluate format string expression and store result in an environment
1793 Print file as hexdump to standard output
1800 bool "Network commands"
1813 bootp - boot image via network using BOOTP/TFTP protocol
1819 Boot image via network using DHCPv6/TFTP protocol using IPv6.
1821 Will perform 4-message exchange with DHCPv6 server, requesting
1822 the minimum required options to TFTP boot. Complies with RFC 8415.
1826 config DHCP6_PXE_CLIENTARCH
1828 default 0x16 if ARM64
1832 config DHCP6_PXE_DHCP_OPTION
1833 bool "Request & store 'pxe_configfile' from DHCP6 server"
1835 config DHCP6_ENTERPRISE_ID
1836 int "Enterprise ID to send in DHCPv6 Vendor Class Option"
1841 config BOOTP_MAY_FAIL
1842 bool "Allow for the BOOTP/DHCP server to not be found"
1843 depends on CMD_BOOTP
1845 If the DHCP server is not found after the configured retry count, the
1846 call will fail instead of starting over. This can be used to fail
1847 over to Link-local IP address configuration if the DHCP server is not
1850 config BOOTP_BOOTPATH
1851 bool "Request & store 'rootpath' from BOOTP/DHCP server"
1853 depends on CMD_BOOTP
1855 Even though the config is called BOOTP_BOOTPATH, it stores the
1856 path in the variable 'rootpath'.
1858 config BOOTP_VENDOREX
1859 bool "Support vendor extensions from BOOTP/DHCP server"
1860 depends on CMD_BOOTP
1862 config BOOTP_BOOTFILESIZE
1863 bool "Request & store 'bootfilesize' from BOOTP/DHCP server"
1864 depends on CMD_BOOTP
1867 bool "Request & store 'dnsip' from BOOTP/DHCP server"
1869 depends on CMD_BOOTP
1871 The primary DNS server is stored as 'dnsip'. If two servers are
1872 returned, you must set BOOTP_DNS2 to store that second server IP
1876 bool "Store 'dnsip2' from BOOTP/DHCP server"
1877 depends on BOOTP_DNS
1879 If a DHCP client requests the DNS server IP from a DHCP server,
1880 it is possible that more than one DNS serverip is offered to the
1881 client. If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1882 server IP will be stored in the additional environment
1883 variable "dnsip2". The first DNS serverip is always
1884 stored in the variable "dnsip", when BOOTP_DNS is defined.
1886 config BOOTP_GATEWAY
1887 bool "Request & store 'gatewayip' from BOOTP/DHCP server"
1889 depends on CMD_BOOTP
1891 config BOOTP_HOSTNAME
1892 bool "Request & store 'hostname' from BOOTP/DHCP server"
1894 depends on CMD_BOOTP
1896 The name may or may not be qualified with the local domain name.
1898 config BOOTP_PREFER_SERVERIP
1899 bool "serverip variable takes precedent over DHCP server IP."
1900 depends on CMD_BOOTP
1902 By default a BOOTP/DHCP reply will overwrite the 'serverip' variable.
1904 With this option enabled, the 'serverip' variable in the environment
1905 takes precedence over DHCP server IP and will only be set by the DHCP
1906 server if not already set in the environment.
1908 config BOOTP_SUBNETMASK
1909 bool "Request & store 'netmask' from BOOTP/DHCP server"
1911 depends on CMD_BOOTP
1913 config BOOTP_NISDOMAIN
1914 bool "Request & store 'nisdomain' from BOOTP/DHCP server"
1915 depends on CMD_BOOTP
1917 config BOOTP_NTPSERVER
1918 bool "Request & store 'ntpserverip' from BOOTP/DHCP server"
1919 depends on CMD_BOOTP
1921 config BOOTP_TIMEOFFSET
1922 bool "Request & store 'timeoffset' from BOOTP/DHCP server"
1923 depends on CMD_BOOTP && CMD_SNTP
1928 Selecting this will allow capturing all Ethernet packets and store
1929 them in physical memory in a PCAP formated file,
1930 later to be analyzed by PCAP reader application (IE. WireShark).
1933 bool "Send PXE client arch to BOOTP/DHCP server"
1935 depends on CMD_BOOTP && CMD_PXE
1937 Supported for ARM, ARM64, and x86 for now.
1939 config BOOTP_PXE_CLIENTARCH
1941 depends on BOOTP_PXE
1942 default 0x16 if ARM64
1946 config BOOTP_PXE_DHCP_OPTION
1947 bool "Request & store 'pxe_configfile' from BOOTP/DHCP server"
1948 depends on BOOTP_PXE
1950 config BOOTP_VCI_STRING
1952 depends on CMD_BOOTP
1953 default "U-Boot.armv7" if CPU_V7A || CPU_V7M || CPU_V7R
1954 default "U-Boot.armv8" if ARM64
1955 default "U-Boot.arm" if ARM
1960 depends on CMD_TFTPBOOT
1962 TFTP put command, for uploading files to a server
1966 depends on CMD_TFTPBOOT
1968 Act as a TFTP server and boot the first received file
1970 config NET_TFTP_VARS
1971 bool "Control TFTP timeout and count through environment"
1972 depends on CMD_TFTPBOOT
1975 If set, allows controlling the TFTP timeout through the
1976 environment variable tftptimeout, and the TFTP maximum
1977 timeout count through the variable tftptimeoutcountmax.
1978 If unset, timeout and maximum are hard-defined as 1 second
1979 and 10 timouts per TFTP transfer.
1984 Boot image via network using RARP/TFTP protocol
1989 Boot image via network using NFS protocol.
1992 int "Timeout in milliseconds for NFS mounts"
1996 Timeout in milliseconds used in NFS protocol. If you encounter
1997 "ERROR: Cannot umount" in nfs command, try longer timeout such as
2000 config SYS_DISABLE_AUTOLOAD
2001 bool "Disable automatically loading files over the network"
2002 depends on CMD_BOOTP || CMD_DHCP || CMD_NFS || CMD_RARP
2004 Typically, commands such as "dhcp" will attempt to automatically
2005 load a file from the network, once the initial network configuration
2006 is complete. Enable this option to disable this behavior and instead
2007 require files to be loaded over the network by subsequent commands.
2012 default y if (CMD_PING && IPV6)
2014 Send ICMPv6 ECHO_REQUEST to network host
2019 Perform CDP network configuration
2025 Synchronize RTC via network
2027 config CMD_LINK_LOCAL
2031 Acquire a network IP address using the link-local protocol
2037 Manually configure the attached NIC via NC-SI.
2038 Normally this happens automatically before other network
2041 config IPV6_ROUTER_DISCOVERY
2042 bool "Do IPv6 router discovery"
2045 Will automatically perform router solicitation on first IPv6
2052 Allow control of L2 Ethernet switch commands. These are supported
2053 by the vsc9953 Ethernet driver at present. Sub-commands allow
2054 operations such as enabling / disabling a port and
2055 viewing/maintaining the filtering database (FDB)
2060 Wait for wake-on-lan Magic Packet
2070 select PROT_DHCP_LWIP if NET_LWIP
2072 Boot image via network using DHCP/TFTP protocol
2076 select PROT_DNS_LWIP if NET_LWIP
2078 Lookup the IP of a hostname
2084 If set, allows 802.3(clause 22) MII Management functions interface access
2085 The management interface specified in Clause 22 provides
2086 a simple, two signal, serial interface to connect a
2087 Station Management entity and a managed PHY for providing access
2088 to management parameters and services.
2089 The interface is referred to as the MII management interface.
2092 bool "Call mii_init() in the mii command"
2093 depends on CMD_MII && (MPC8XX_FEC || FSLDMAFE || MCFFEC)
2099 If set, allows Enable 802.3(clause 45) MDIO interface registers access
2100 The MDIO interface is orthogonal to the MII interface and extends
2101 it by adding access to more registers through indirect addressing.
2105 select PROT_RAW_LWIP if NET_LWIP
2107 Send ICMP ECHO_REQUEST to network host
2111 select PROT_UDP_LWIP if NET_LWIP
2114 tftpboot - load file via network using TFTP protocol
2119 default y if SANDBOX
2120 select PROT_TCP if NET
2121 select PROT_TCP_LWIP if NET_LWIP
2122 select PROT_DNS_LWIP if NET_LWIP
2124 wget is a simple command to download kernel, or other files,
2125 from a http server over TCP.
2134 Boot image via network using PXE protocol
2136 endif # if NET || NET_LWIP
2138 menu "Misc commands"
2143 This is a simple sliding block puzzle game designed by Italian web
2144 developer Gabriele Cirulli. The game's objective is to slide numbered
2145 tiles on a grid to combine them to create a tile with the number
2148 This needs ANSI support on your terminal to work. It is not fully
2149 functional on a video device.
2152 bool "Enable 'bmp' command"
2156 This provides a way to obtain information about a BMP-format image
2157 and to display it. BMP (which presumably stands for BitMaP) is a
2158 file format defined by Microsoft which supports images of various
2159 depths, formats and compression methods. Headers on the file
2160 determine the formats used. This command can be used by first loading
2161 the image into RAM, then using this command to look at it or display
2164 config CMD_BOOTCOUNT
2166 depends on BOOTCOUNT_LIMIT
2168 Enable the bootcount command, which allows interrogation and
2169 reset of the bootcounter.
2172 bool "Enable board-specific commands"
2174 (deprecated: instead, please define a Kconfig option for each command)
2176 Some boards have board-specific commands which are only enabled
2177 during developemnt and need to be turned off for production. This
2178 option provides a way to control this. The commands that are enabled
2179 vary depending on the board.
2181 config CMD_BLOCK_CACHE
2182 bool "blkcache - control and stats for block cache"
2183 depends on BLOCK_CACHE
2184 default y if BLOCK_CACHE
2186 Enable the blkcache command, which can be used to control the
2187 operation of the cache functions.
2188 This is most useful when fine-tuning the operation of the cache
2189 during development, but also allows the cache to be disabled when
2190 it might hurt performance (e.g. when using the ums command).
2193 bool "blkmap - Composable virtual block devices"
2197 Create virtual block devices that are backed by various sources,
2198 e.g. RAM, or parts of an existing block device. Though much more
2199 rudimentary, it borrows a lot of ideas from Linux's device mapper
2203 - Treat a region of RAM as a block device, i.e. a RAM disk. This let's
2204 you extract files from filesystem images stored in RAM (perhaps as a
2205 result of a TFTP transfer).
2206 - Create a virtual partition on an existing device. This let's you
2207 access filesystems that aren't stored at an exact partition
2208 boundary. A common example is a filesystem image embedded in an FIT
2216 Enable the 'button' command which allows to get the status of
2217 buttons supported by the board. The buttonss can be listed with
2218 'button list' and state can be known with 'button <label>'.
2219 Any button drivers can be controlled with this command, e.g.
2223 bool "icache or dcache"
2225 Enable the "icache" and "dcache" commands
2227 config CMD_CONITRACE
2228 bool "conitrace - trace console input codes"
2230 Enable the 'conitrace' command which displays the codes received
2231 from the console input as hexadecimal numbers.
2234 bool "Enable clear screen command 'cls'"
2235 default y if LCD || VIDEO
2237 Enable the 'cls' command which clears the screen contents
2238 on video frame buffer.
2241 bool "efidebug - display/configure UEFI environment"
2242 depends on EFI_LOADER
2243 select EFI_DEVICE_PATH_TO_TEXT
2245 Enable the 'efidebug' command which provides a subset of UEFI
2246 shell utility with simplified functionality. It will be useful
2247 particularly for managing boot parameters as well as examining
2248 various EFI status for debugging.
2250 config CMD_EFICONFIG
2251 bool "eficonfig - provide menu-driven uefi variables maintenance interface"
2252 default y if !HAS_BOARD_SIZE_LIMIT
2253 depends on EFI_BOOTMGR
2256 Enable the 'eficonfig' command which provides the menu-driven UEFI
2257 variable maintenance interface.
2259 config CMD_EXCEPTION
2260 bool "exception - raise exception"
2261 depends on ARM || RISCV || SANDBOX || X86
2263 Enable the 'exception' command which allows to raise an exception.
2270 Enable the 'led' command which allows for control of LEDs supported
2271 by the board. The LEDs can be listed with 'led list' and controlled
2272 with led on/off/togle/blink. Any LED drivers can be controlled with
2273 this command, e.g. led_gpio.
2278 Enable the 'ini' command which allows a .ini file to be parsed and
2279 placed into environment variables. Please check the source code for
2280 this as there is no documentation.
2287 Enable the 'date' command for getting/setting the time/date in RTC
2295 Enable the 'rtc' command for low-level access to RTC devices.
2300 Run commands and summarize execution time.
2303 bool "gettime - read elapsed time"
2305 Enable the 'gettime' command which reads the elapsed time since
2306 U-Boot started running. This shows the time in seconds and
2307 milliseconds. See also the 'bootstage' command which provides more
2308 flexibility for boot timing.
2311 bool "pause command"
2313 Delay execution waiting for any user input.
2314 Useful to allow the user to read a failure log.
2319 default y if SANDBOX
2322 Print bytes from the hardware random number generator.
2324 config CMD_KASLRSEED
2328 Set the kaslr-seed in the chosen node with entropy provided by a
2329 hardware random number generator.
2335 Delay execution for some time
2338 bool "support for multiprocessor commands"
2342 This enables commands to bringup different processors
2343 in multiprocessor cases.
2348 Access the system timer.
2354 This provides basic access to the U-Boot's sound support. The main
2355 feature is to play a beep.
2357 sound init - set up sound system
2358 sound play - play a sound
2364 Boot image via local extlinux.conf file
2369 default y if TARGET_QEMU_ARM_32BIT || TARGET_QEMU_ARM_64BIT || \
2370 TARGET_QEMU_X86 || TARGET_QEMU_X86_64
2372 This provides access to the QEMU firmware interface. The main
2373 feature is to allow easy loading of files passed to qemu-system
2374 via -kernel / -initrd
2379 This provides access to Linux PStore with Rammoops backend. The main
2380 feature is to allow to display or save PStore records.
2382 See doc/pstore.rst for more information.
2386 config CMD_PSTORE_MEM_ADDR
2387 hex "Memory Address"
2388 depends on CMD_PSTORE
2390 Base addr used for PStore ramoops memory, should be identical to
2391 ramoops.mem_address parameter used by kernel
2393 config CMD_PSTORE_MEM_SIZE
2395 depends on CMD_PSTORE
2398 Size of PStore ramoops memory, should be identical to ramoops.mem_size
2399 parameter used by kernel, a power of 2 and larger than the sum of the
2402 config CMD_PSTORE_RECORD_SIZE
2403 hex "Dump record size"
2404 depends on CMD_PSTORE
2407 Size of each dump done on oops/panic, should be identical to
2408 ramoops.record_size parameter used by kernel and a power of 2
2411 config CMD_PSTORE_CONSOLE_SIZE
2412 hex "Kernel console log size"
2413 depends on CMD_PSTORE
2416 Size of kernel console log, should be identical to
2417 ramoops.console_size parameter used by kernel and a power of 2
2420 config CMD_PSTORE_FTRACE_SIZE
2421 hex "FTrace log size"
2422 depends on CMD_PSTORE
2425 Size of ftrace log, should be identical to ramoops.ftrace_size
2426 parameter used by kernel and a power of 2
2428 config CMD_PSTORE_PMSG_SIZE
2429 hex "User space message log size"
2430 depends on CMD_PSTORE
2433 Size of user space message log, should be identical to
2434 ramoops.pmsg_size parameter used by kernel and a power of 2
2436 config CMD_PSTORE_ECC_SIZE
2438 depends on CMD_PSTORE
2441 if non-zero, the option enables ECC support and specifies ECC buffer
2442 size in bytes (1 is a special value, means 16 bytes ECC), should be
2443 identical to ramoops.ramoops_ecc parameter used by kernel
2447 source "cmd/mvebu/Kconfig"
2450 bool "terminal - provides a way to attach a serial terminal"
2452 Provides a 'cu'-like serial terminal command. This can be used to
2453 access other serial ports from the system console. The terminal
2454 is very simple with no special processing of characters. As with
2455 cu, you can press ~. (tilde followed by period) to exit.
2458 bool "uuid, guid - generation of unique IDs"
2461 This enables two commands:
2463 uuid - generate random Universally Unique Identifier
2464 guid - generate Globally Unique Identifier based on random UUID
2466 The two commands are very similar except for the endianness of the
2469 config CMD_VIDCONSOLE
2470 bool "lcdputs and setcurs"
2474 Enabling this will provide 'setcurs' and 'lcdputs' commands which
2475 support cursor positioning and drawing strings on the video
2476 console (framebuffer).
2478 The name 'lcdputs' is a bit of a misnomer, but so named because the
2479 video device is often an LCD.
2481 config CMD_SELECT_FONT
2482 bool "select font size"
2484 default y if CONSOLE_TRUETYPE
2486 Enabling this will provide 'font' command.
2487 Allows font selection at runtime.
2491 source "cmd/ti/Kconfig"
2493 config CMD_BOOTSTAGE
2494 bool "Enable the 'bootstage' command"
2495 depends on BOOTSTAGE
2497 Add a 'bootstage' command which supports printing a report
2498 and un/stashing of bootstage data.
2500 menu "Power commands"
2502 bool "Enable Driver Model PMIC command"
2505 This is the pmic command, based on a driver model pmic's API.
2506 Command features are unchanged:
2507 - list - list pmic devices
2508 - pmic dev <id> - show or [set] operating pmic device (NEW)
2509 - pmic dump - dump registers
2510 - pmic read address - read byte of register at address
2511 - pmic write address - write byte to register at address
2512 The only one change for this command is 'dev' subcommand.
2514 config CMD_REGULATOR
2515 bool "Enable Driver Model REGULATOR command"
2516 depends on DM_REGULATOR
2518 This command is based on driver model regulator's API.
2519 User interface features:
2520 - list - list regulator devices
2521 - regulator dev <id> - show or [set] operating regulator device
2522 - regulator info - print constraints info
2523 - regulator status - print operating status
2524 - regulator value <val] <-f> - print/[set] voltage value [uV]
2525 - regulator current <val> - print/[set] current value [uA]
2526 - regulator mode <id> - print/[set] operating mode id
2527 - regulator enable - enable the regulator output
2528 - regulator disable - disable the regulator output
2530 The '-f' (force) option can be used for set the value which exceeds
2531 the limits, which are found in device-tree and are kept in regulator's
2532 uclass plat structure.
2536 menu "Security commands"
2538 bool "Enable the 'aes' command"
2541 This provides a means to encrypt and decrypt data using the AES
2542 (Advanced Encryption Standard). This algorithm uses a symetric key
2543 and is widely used as a streaming cipher. Different key lengths are
2544 supported by the algorithm but this command only supports 128 bits
2548 bool "Enable the 'blob' command"
2549 depends on !MX6ULL && !MX6SLL && !MX6SL
2550 select IMX_HAB if ARCH_MX6 || ARCH_MX7 || ARCH_MX7ULP || ARCH_IMX8M
2552 This is used with the Freescale secure boot mechanism.
2554 Freescale's SEC block has built-in Blob Protocol which provides
2555 a method for protecting user-defined data across system power
2556 cycles. SEC block protects data in a data structure called a Blob,
2557 which provides both confidentiality and integrity protection.
2559 Encapsulating data as a blob
2560 Each time that the Blob Protocol is used to protect data, a
2561 different randomly generated key is used to encrypt the data.
2562 This random key is itself encrypted using a key which is derived
2563 from SoC's non-volatile secret key and a 16 bit Key identifier.
2564 The resulting encrypted key along with encrypted data is called a
2565 blob. The non-volatile secure key is available for use only during
2568 During decapsulation, the reverse process is performed to get back
2572 blob enc - encapsulating data as a cryptgraphic blob
2573 blob dec - decapsulating cryptgraphic blob to get the data
2577 blob enc src dst len km
2579 Encapsulate and create blob of data $len bytes long
2580 at address $src and store the result at address $dst.
2581 $km is the 16 byte key modifier is also required for
2582 generation/use as key for cryptographic operation. Key
2583 modifier should be 16 byte long.
2585 blob dec src dst len km
2587 Decapsulate the blob of data at address $src and
2588 store result of $len byte at addr $dst.
2589 $km is the 16 byte key modifier is also required for
2590 generation/use as key for cryptographic operation. Key
2591 modifier should be 16 byte long.
2594 bool "Support 'hash' command"
2597 This provides a way to hash data in memory using various supported
2598 algorithms (such as SHA1, MD5, CRC32). The computed digest can be
2599 saved to memory or to an environment variable. It is also possible
2600 to verify a hash against data in memory.
2603 bool "Support the 'hvc' command"
2604 depends on ARM_SMCCC
2606 Allows issuing Hypervisor Calls (HVCs). Mostly useful for
2607 development and testing.
2610 bool "Support the 'smc' command"
2611 depends on ARM_SMCCC
2613 Allows issuing Secure Monitor Calls (SMCs). Mostly useful for
2614 development and testing.
2620 Add -v option to verify data against a hash.
2623 bool "scp03 - SCP03 enable and rotate/provision operations"
2626 This command provides access to a Trusted Application
2627 running in a TEE to request Secure Channel Protocol 03
2628 (SCP03) enablement and/or rotation of its SCP03 keys.
2637 bool "Enable the 'tpm' command"
2638 depends on TPM_V1 || TPM_V2
2639 select CMD_TPM_V1 if TPM_V1
2640 select CMD_TPM_V2 if TPM_V2
2642 This provides a means to talk to a TPM from the command line. A wide
2643 range of commands if provided - see 'tpm help' for details. The
2644 command requires a suitable TPM on your board and the correct driver
2650 bool "Enable the 'tpm test' command"
2653 This provides a a series of tests to confirm that the TPMv1.x is
2654 working correctly. The tests cover initialisation, non-volatile RAM,
2655 extend, global lock and checking that timing is within expectations.
2656 The tests pass correctly on Infineon TPMs but may need to be adjusted
2663 menu "Firmware commands"
2665 bool "Enable crosec command"
2669 Enable command-line access to the Chrome OS EC (Embedded
2670 Controller). This provides the 'crosec' command which has
2671 a number of sub-commands for performing EC tasks such as
2672 updating its flash, accessing a small saved context area
2673 and talking to the I2C bus behind the EC (if there is one).
2676 bool "Enable scmi command"
2677 depends on SCMI_FIRMWARE
2679 This command provides user interfaces to several SCMI (System
2680 Control and Management Interface) protocols available on Arm
2681 platforms to manage system resources.
2684 menu "Filesystem commands"
2686 bool "Enable the 'btrsubvol' command"
2689 This enables the 'btrsubvol' command to list subvolumes
2690 of a BTRFS filesystem. There are no special commands for
2691 listing BTRFS directories or loading BTRFS files - this
2692 can be done by the generic 'fs' commands (see CMD_FS_GENERIC)
2693 when BTRFS is enabled (see FS_BTRFS).
2696 bool "Enable the 'cbfs' command"
2699 Define this to enable support for reading from a Coreboot
2700 filesystem. This is a ROM-based filesystem used for accessing files
2701 on systems that use coreboot as the first boot-loader and then load
2702 U-Boot to actually boot the Operating System. Available commands are
2703 cbfsinit, cbfsinfo, cbfsls and cbfsload.
2706 bool "Enable the 'cramfs' command"
2707 depends on FS_CRAMFS
2709 This provides commands for dealing with CRAMFS (Compressed ROM
2710 filesystem). CRAMFS is useful when space is tight since files are
2711 compressed. Two commands are provided:
2713 cramfsls - lists files in a cramfs image
2714 cramfsload - loads a file from a cramfs image
2717 bool "EROFS command support"
2720 Support for the EROFS fs
2723 bool "ext2 command support"
2726 Enables EXT2 FS command
2729 bool "ext4 command support"
2732 Enables EXT4 FS command
2734 config CMD_EXT4_WRITE
2736 bool "ext4 write command support"
2739 Enables EXT4 FS write command
2742 bool "FAT command support"
2745 Support for the FAT fs
2748 bool "SquashFS command support"
2751 Enables SquashFS filesystem commands (e.g. load, ls).
2753 config CMD_FS_GENERIC
2754 bool "filesystem commands"
2756 Enables filesystem commands (e.g. load, ls) that work for multiple
2760 bool "fsuuid command"
2762 Enables fsuuid command for filesystem UUID.
2765 bool "jffs2 command"
2768 Enables commands to support the JFFS2 (Journalling Flash File System
2769 version 2) filesystem. This enables fsload, ls and fsinfo which
2770 provide the ability to load files, list directories and obtain
2771 filesystem information.
2774 string "Default device for JFFS2"
2775 depends on CMD_JFFS2
2778 The default device to use with the jffs2 command.
2780 config JFFS2_PART_OFFSET
2781 hex "Default offset within flash to locate the JFFS2 image"
2782 depends on CMD_JFFS2
2785 The default offset within flash to locate the JFFS2 image.
2787 config JFFS2_PART_SIZE
2788 hex "Default size of JFFS2 partition"
2789 depends on CMD_JFFS2
2792 The default size of the JFFS2 partition
2795 bool "MTD partition support"
2797 select MTD_PARTITIONS
2799 MTD partitioning tool support.
2800 It is strongly encouraged to avoid using this command
2801 anymore along with 'sf', 'nand', 'onenand'. One can still
2802 declare the partitions in the mtdparts environment variable
2803 but better use the MTD stack and the 'mtd' command instead.
2805 config CMD_MTDPARTS_SPREAD
2806 bool "Padd partition size to take account of bad blocks"
2807 depends on CMD_MTDPARTS
2809 This enables the 'spread' sub-command of the mtdparts command.
2810 This command will modify the existing mtdparts variable by increasing
2811 the size of the partitions such that 1) each partition's net size is
2812 at least as large as the size specified in the mtdparts variable and
2813 2) each partition starts on a good block.
2815 config CMD_MTDPARTS_SHOW_NET_SIZES
2816 bool "Show net size (w/o bad blocks) of partitions"
2817 depends on CMD_MTDPARTS
2819 Adds two columns to the printed partition table showing the
2820 effective usable size of a partition, if bad blocks are taken
2823 config MTDIDS_DEFAULT
2824 string "Default MTD IDs"
2825 depends on MTD || SPI_FLASH
2826 depends on !SYS_MTDPARTS_RUNTIME
2828 Defines a default MTD IDs list for use with MTD partitions in the
2829 Linux MTD command line partitions format.
2831 config MTDPARTS_DEFAULT
2832 string "Default MTD partition scheme"
2833 depends on MTD || SPI_FLASH
2834 depends on !SYS_MTDPARTS_RUNTIME
2836 Defines a default MTD partitioning scheme in the Linux MTD command
2837 line partitions format
2840 bool "yaffs2 - Access of YAFFS2 filesystem"
2844 This provides commands for accessing a YAFFS2 filesystem. Yet
2845 Another Flash Filesystem 2 is a filesystem designed specifically
2846 for NAND flash. It incorporates bad-block management and ensures
2847 that device writes are sequential regardless of filesystem
2851 bool "zfs - Access of ZFS filesystem"
2853 This provides commands to accessing a ZFS filesystem, commonly used
2854 on Solaris systems. Two sub-commands are provided:
2856 zfsls - list files in a directory
2857 zfsload - load a file
2859 See doc/README.zfs for more details.
2863 menu "Debug commands"
2865 config CMD_CBSYSINFO
2868 default y if SYS_COREBOOT
2870 This provides information about the coreboot sysinfo table stored in
2871 memory by coreboot before jumping to U-Boot. It can be useful for
2872 debugging the beaaviour of coreboot or U-Boot.
2877 default y if SYS_COREBOOT
2879 This provides information options to check the CMOS RAM checksum,
2880 if present, as well as to update it.
2882 It is useful when coreboot CMOS-RAM settings must be examined or
2886 bool "cyclic - Show information about cyclic functions"
2890 This enables the 'cyclic' command which provides information about
2891 cyclic execution functions. This infrastructure allows registering
2892 functions to be executed cyclically, e.g. every 100ms. These commands
2895 cyclic list - list cyclic functions
2896 cyclic cyclic demo <cycletime_ms> <delay_us> - register cyclic
2899 See doc/develop/cyclic.rst for more details.
2902 bool "diag - Board diagnostics"
2904 This command provides access to board diagnostic tests. These are
2905 called Power-on Self Tests (POST). The command allows listing of
2906 available tests and running either all the tests, or specific tests
2910 bool "event - Show information about events"
2912 default y if EVENT_DEBUG
2914 This enables the 'event' command which provides information about
2915 events and event-handler routines. This can help to device event
2919 bool "irq - Show information about interrupts"
2920 depends on !ARM && !MIPS && !RISCV && !SH
2922 This enables two commands:
2924 interrupts - enable or disable interrupts
2925 irqinfo - print device-specific interrupt information
2928 bool "kgdb - Allow debugging of U-Boot with gdb"
2931 This enables a 'kgdb' command which allows gdb to connect to U-Boot
2932 over a serial link for debugging purposes. This allows
2933 single-stepping, inspecting variables, etc. This is supported only
2934 on PowerPC at present.
2937 bool "log - Generation, control and access to logging"
2941 This provides access to logging features. It allows the output of
2942 log data to be controlled to a limited extent (setting up the default
2943 maximum log level for emitting of records). It also provides access
2944 to a command used for testing the log system.
2947 bool "trace - Support tracing of function calls and timing"
2951 Enables a command to control using of function tracing within
2952 U-Boot. This allows recording of call traces including timing
2953 information. The command can write data to memory for exporting
2954 for analysis (e.g. using bootchart). See doc/develop/trace.rst
2958 bool "avb - Android Verified Boot 2.0 operations"
2959 depends on AVB_VERIFY
2961 Enables a "avb" command to perform verification of partitions using
2962 Android Verified Boot 2.0 functionality. It includes such subcommands:
2963 avb init - initialize avb2 subsystem
2964 avb read_rb - read rollback index
2965 avb write_rb - write rollback index
2966 avb is_unlocked - check device lock state
2967 avb get_uuid - read and print uuid of a partition
2968 avb read_part - read data from partition
2969 avb read_part_hex - read data from partition and output to stdout
2970 avb write_part - write data to partition
2971 avb verify - run full verification chain
2973 config CMD_STACKPROTECTOR_TEST
2974 bool "Test command for stack protector"
2975 depends on STACKPROTECTOR
2977 Enable stackprot_test command
2978 The stackprot_test command will force a stack overrun to test
2979 the stack smashing detection mechanisms.
2984 tristate "Enable UBI - Unsorted block images commands"
2987 UBI is a software layer above MTD layer which admits use of LVM-like
2988 logical volumes on top of MTD devices, hides some complexities of
2989 flash chips like wear and bad blocks and provides some other useful
2990 capabilities. Please, consult the MTD web site for more details
2991 (www.linux-mtd.infradead.org). Activate this option if you want
2992 to use U-Boot UBI commands.
2993 It is also strongly encouraged to also enable CONFIG_MTD to get full
2996 config CMD_UBI_RENAME
2997 bool "Enable rename"
3000 Enable a "ubi" command to rename ubi volume:
3001 ubi rename <oldname> <newname>
3004 tristate "Enable UBIFS - Unsorted block images filesystem commands"
3006 default y if CMD_UBI
3010 UBIFS is a file system for flash devices which works on top of UBI.
3013 bool "Amlogic Meson commands"
3014 depends on ARCH_MESON
3017 Enable useful commands for the Meson Soc family developed by Amlogic Inc.
projects / u-boot.git / blob