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
197 Print GPL license text
202 Provides access to the Intel Power-Management Controller (PMC) so
203 that its state can be examined. This does not currently support
204 changing the state but it is still useful for debugging and seeing
213 config CMD_TLV_EEPROM
215 depends on I2C_EEPROM
218 Display and program the system EEPROM data block in ONIE Tlvinfo
219 format. TLV stands for Type-Length-Value.
221 config SPL_CMD_TLV_EEPROM
222 bool "tlv_eeprom for SPL"
223 depends on SPL_I2C_EEPROM
224 select SPL_DRIVERS_MISC
227 Read system EEPROM data block in ONIE Tlvinfo format from SPL.
231 depends on RISCV_SMODE && SBI_V02
233 Display information about the SBI implementation.
239 Display the SMBIOS information.
249 Run the command stored in the environment "bootcmd", i.e.
250 "bootd" does the same thing as "run bootcmd".
256 Boot an application image from the memory.
258 config CMD_BOOTM_PRE_LOAD
259 bool "enable pre-load on bootm"
261 depends on IMAGE_PRE_LOAD
263 Enable support of stage pre-load for the bootm command.
264 This stage allow to check or modify the image provided
265 to the bootm command.
270 default y if BOOTSTD_FULL
272 Support listing available bootdevs (boot devices) which can provide an
273 OS to boot, as well as showing information about a particular one.
275 This command is not necessary for bootstd to work.
282 Support scanning for bootflows available with the bootdevs. The
283 bootflows can optionally be booted.
285 config CMD_BOOTFLOW_FULL
286 bool "bootflow - extract subcommands"
287 depends on BOOTSTD_FULL
290 Add the ability to list the available bootflows, select one and obtain
291 information about it.
293 This command is not necessary for bootstd to work.
298 default y if BOOTSTD_FULL
300 Support listing available bootmethds (methods used to boot an
301 Operating System), as well as selecting the order that the bootmeths
304 This command is not necessary for bootstd to work.
307 bool "Support booting UEFI FIT images"
308 depends on EFI_BINARY_EXEC && CMD_BOOTM && FIT
311 Support booting UEFI FIT images via the bootm command.
316 Boot the Linux zImage
320 depends on ARM64 || RISCV || SANDBOX
323 Boot an AArch64 Linux Kernel image from memory.
326 bool "Support booting Linux OS images"
327 depends on CMD_BOOTM || CMD_BOOTZ || CMD_BOOTI
330 Support booting the Linux kernel directly via a command such as bootm
334 bool "Support booting NetBSD (non-EFI) loader images"
338 Support booting NetBSD via the bootm command.
340 config BOOTM_OPENRTOS
341 bool "Support booting OPENRTOS / FreeRTOS images"
344 Support booting OPENRTOS / FreeRTOS via the bootm command.
347 bool "Support booting Enea OSE images"
348 depends on (ARM && (ARM64 || CPU_V7A || CPU_V7R) || SANDBOX || PPC || X86)
351 Support booting Enea OSE images via the bootm command.
354 bool "Support booting Plan9 OS images"
358 Support booting Plan9 images via the bootm command.
361 bool "Support booting RTEMS OS images"
365 Support booting RTEMS images via the bootm command.
368 bool "Support read SEAMA NAND images"
369 depends on MTD_RAW_NAND
371 Support reading NAND Seattle Image (SEAMA) images.
374 bool "vbe - Verified Boot for Embedded"
375 depends on BOOTMETH_VBE
376 default y if BOOTSTD_FULL
378 Provides various subcommands related to VBE, such as listing the
379 available methods, looking at the state and changing which method
380 is used to boot. Updating the parameters is not currently
384 bool "Support booting VxWorks OS images"
388 Support booting VxWorks images via the bootm command.
392 depends on EFI_LOADER
395 Boot an EFI image from memory.
398 config CMD_BOOTEFI_BINARY
399 bool "Allow booting an EFI binary directly"
400 depends on EFI_BINARY_EXEC
403 Select this option to enable direct execution of binary at 'bootefi'.
404 This subcommand will allow you to load the UEFI binary using
405 other U-Boot commands or external methods and then run it.
407 config CMD_BOOTEFI_BOOTMGR
408 bool "UEFI Boot Manager command"
409 depends on EFI_BOOTMGR
412 Select this option to enable the 'bootmgr' subcommand of 'bootefi'.
413 This subcommand will allow you to select the UEFI binary to be booted
414 via UEFI variables Boot####, BootOrder, and BootNext.
416 config CMD_BOOTEFI_HELLO_COMPILE
417 bool "Compile a standard EFI hello world binary for testing"
420 This compiles a standard EFI hello world application with U-Boot so
421 that it can be used with the test/py testing framework. This is useful
422 for testing that EFI is working at a basic level, and for bringing
423 up EFI support on a new architecture.
425 No additional space will be required in the resulting U-Boot binary
426 when this option is enabled.
428 config CMD_BOOTEFI_HELLO
429 bool "Allow booting a standard EFI hello world for testing"
430 depends on CMD_BOOTEFI_BINARY && CMD_BOOTEFI_HELLO_COMPILE
431 default y if CMD_BOOTEFI_SELFTEST
433 This adds a standard EFI hello world application to U-Boot so that
434 it can be used with the 'bootefi hello' command. This is useful
435 for testing that EFI is working at a basic level, and for bringing
436 up EFI support on a new architecture.
438 source lib/efi_selftest/Kconfig
446 Add an ANSI terminal boot menu command.
451 Android DTB/DTBO image manipulation commands. Read dtb/dtbo files from
452 image into RAM, dump image structure information, etc. Those dtb/dtbo
453 files should be merged in one dtb further, which needs to be passed to
454 the kernel, as part of a boot process.
458 depends on ANDROID_BOOT_IMAGE
460 Android Boot Image manipulation commands. Allows one to extract
461 images contained in boot.img, like kernel, ramdisk, dtb, etc, and
462 obtain corresponding meta-information from boot.img.
464 See doc/android/boot-image.rst for details.
467 bool "cedit - Configuration editor"
471 Provides a command to allow editing of board configuration and
472 providing a UI for the user to adjust settings. Subcommands allow
473 loading and saving of configuration as well as showing an editor.
476 bool "bootelf, bootvx"
480 Boot an ELF/vxWorks image from the memory.
483 bool "Flattened Device Tree utility commands"
487 Do FDT related setup before booting into the Operating System.
489 config SUPPORT_EXTENSION_SCAN
493 bool "Extension board management command"
495 depends on SUPPORT_EXTENSION_SCAN
497 Enables the "extension" command, which allows to detect
498 extension boards connected to the system, and apply
499 corresponding Device Tree overlays.
505 Start an application at a given address.
511 Run the command in the given environment variable.
517 Print header information for application image.
522 List all images found in flash
528 Extract a part of a multi-image.
531 hex "imxtract max gunzip size"
533 depends on CMD_XIMG && GZIP
535 This provides the size of the commad-line argument area
536 used by imxtract for extracting pieces of FIT image.
537 It should be large enough to fit uncompressed size of
538 FIT piece we are extracting.
541 bool "spl export - Export boot information for Falcon boot"
544 Falcon mode allows booting directly from SPL into an Operating
545 System such as Linux, thus skipping U-Boot proper. See
546 doc/README.falcon for full information about how to use this
549 config CMD_SPL_NAND_OFS
550 hex "Offset of OS args or dtb for Falcon-mode NAND boot"
551 depends on CMD_SPL && (TPL_NAND_SUPPORT || SPL_NAND_SUPPORT)
554 This provides the offset of the command line arguments for Linux
555 when booting from NAND in Falcon mode. See doc/README.falcon
556 for full information about how to use this option (and also see
557 board/gateworks/gw_ventana/README for an example).
559 config CMD_SPL_NOR_OFS
560 hex "Offset of OS args or dtb for Falcon-mode NOR boot"
561 depends on CMD_SPL && SPL_NOR_SUPPORT
564 This provides the offset of the command line arguments or dtb for
565 Linux when booting from NOR in Falcon mode.
567 config CMD_SPL_WRITE_SIZE
568 hex "Size of argument area"
572 This provides the size of the command-line argument area in NAND
573 flash used by Falcon-mode boot. See the documentation until CMD_SPL
576 config CMD_THOR_DOWNLOAD
577 bool "thor - TIZEN 'thor' download"
579 select USB_FUNCTION_THOR
580 depends on USB_GADGET_DOWNLOAD
582 Implements the 'thor' download protocol. This is a way of
583 downloading a software update over USB from an attached host.
584 There is no documentation about this within the U-Boot source code
585 but you should be able to find something on the interwebs.
587 config THOR_RESET_OFF
588 bool "thor: Disable reset on completion"
589 depends on CMD_THOR_DOWNLOAD
592 bool "zboot - x86 boot command"
594 With x86 machines it is common to boot a bzImage file which
595 contains both a kernel and a setup.bin file. The latter includes
596 configuration information from the dark ages which x86 boards still
597 need to pick things out of.
599 Consider using FIT in preference to this since it supports directly
600 booting both 32- and 64-bit kernels, as well as secure boot.
601 Documentation is available in doc/uImage.FIT/x86-fit-boot.txt
605 menu "Environment commands"
608 bool "ask for env variable"
610 Ask for environment variable
628 Edit environment variable.
633 Allow for searching environment variables
639 Save all environment variables into the compiled-in persistent
644 depends on CMD_SAVEENV
646 Erase environment variables from the compiled-in persistent
649 config CMD_ENV_EXISTS
653 Check if a variable is defined in the environment for use in
656 config CMD_ENV_CALLBACK
657 bool "env callbacks - print callbacks and their associated variables"
659 Some environment variable have callbacks defined by
660 U_BOOT_ENV_CALLBACK. These are called when the variable changes.
661 For example changing "baudrate" adjust the serial baud rate. This
662 command lists the currently defined callbacks.
665 bool "env flags -print variables that have non-default flags"
667 Some environment variables have special flags that control their
668 behaviour. For example, serial# can only be written once and cannot
669 be deleted. This command shows the variables that have special
672 config CMD_NVEDIT_EFI
673 bool "env [set|print] -e - set/print UEFI variables"
674 depends on EFI_LOADER
677 UEFI variables are encoded as some form of U-Boot variables.
678 If enabled, we are allowed to set/print UEFI variables using
679 "env" command with "-e" option without knowing details.
681 config CMD_NVEDIT_INDIRECT
682 bool "env indirect - Sets environment value from another"
684 config CMD_NVEDIT_INFO
685 bool "env info - print or evaluate environment information"
687 Print environment information:
688 - env_valid : is environment valid
689 - env_ready : is environment imported into hash table
690 - env_use_default : is default environment used
692 This command can be optionally used for evaluation in scripts:
693 [-d] : evaluate whether default environment is used
694 [-p] : evaluate whether environment can be persisted
696 The result of multiple evaluations will be combined with AND.
698 config CMD_NVEDIT_LOAD
701 Load all environment variables from the compiled-in persistent
704 config CMD_NVEDIT_SELECT
707 Select the compiled-in persistent storage of environment variables.
711 menu "Memory commands"
716 Compute binary operations (xor, or, and) of byte arrays of arbitrary
717 size from memory and store the result in memory or the environment.
721 default y if BLOBLIST
723 Show information about the bloblist, a collection of binary blobs
724 held in memory that persist between SPL and U-Boot. In the case of
725 x86 devices the bloblist can be used to hold ACPI tables so that they
726 remain available in memory.
739 Add -v option to verify data against a crc32 checksum.
742 bool "eeprom - EEPROM subsystem"
744 (deprecated, needs conversion to driver model)
745 Provides commands to read and write EEPROM (Electrically Erasable
746 Programmable Read Only Memory) chips that are connected over an
749 config CMD_EEPROM_LAYOUT
750 bool "Enable layout-aware eeprom commands"
751 depends on CMD_EEPROM
753 (deprecated, needs conversion to driver model)
754 When enabled, additional eeprom sub-commands become available.
756 eeprom print - prints the contents of the eeprom in a human-readable
757 way (eeprom layout fields, and data formatted to be fit for human
760 eeprom update - allows user to update eeprom fields by specifying
761 the field name, and providing the new data in a human readable format
762 (same format as displayed by the eeprom print command).
764 Both commands can either auto detect the layout, or be told which
768 __weak int parse_layout_version(char *str)
769 - override to provide your own layout name parsing
770 __weak void __eeprom_layout_assign(struct eeprom_layout *layout,
772 - override to setup the layout metadata based on the version
773 __weak int eeprom_layout_detect(unsigned char *data)
774 - override to provide your own algorithm for detecting layout
777 - contains various printing and updating functions for common
778 types of eeprom fields. Can be used for defining
781 config EEPROM_LAYOUT_HELP_STRING
782 string "Tells user what layout names are supported"
783 depends on CMD_EEPROM_LAYOUT
784 default "<not defined>"
786 Help printed with the LAYOUT VERSIONS part of the 'eeprom'
789 config SYS_I2C_EEPROM_BUS
790 int "I2C bus of the EEPROM device."
791 depends on CMD_EEPROM
794 config SYS_I2C_EEPROM_ADDR_LEN
795 int "Length in bytes of the EEPROM memory array address"
796 depends on CMD_EEPROM || ID_EEPROM
800 Note: This is NOT the chip address length!
802 config SYS_EEPROM_SIZE
803 depends on CMD_EEPROM
804 int "Size in bytes of the EEPROM device"
807 config SYS_EEPROM_PAGE_WRITE_BITS
808 int "Number of bits used to address bytes in a single page"
809 depends on CMD_EEPROM
812 The EEPROM page size is 2^SYS_EEPROM_PAGE_WRITE_BITS.
813 A 64 byte page, for example would require six bits.
815 config SYS_EEPROM_PAGE_WRITE_DELAY_MS
816 int "Number of milliseconds to delay between page writes"
817 depends on CMD_EEPROM || CMD_I2C
823 Infinite write loop on address range
829 Compute MD5 checksum.
833 depends on CMD_MD5SUM
835 Add -v option to verify data against an MD5 checksum.
840 Display memory information.
843 bool "md, mm, nm, mw, cp, cmp, base, loop"
848 mm - memory modify (auto-incrementing address)
849 nm - memory modify (constant address)
850 mw - memory write (fill)
853 base - print or set address offset
854 loop - initialize loop on address range
856 config CMD_MEM_SEARCH
857 bool "ms - Memory search"
859 Memory-search command
861 This allows searching through a region of memory looking for hex
862 data (byte, 16-bit word, 32-bit long, also 64-bit on machines that
863 support it). It is also possible to search for a string. The
864 command accepts a memory range and a list of values to search for.
865 The values need to appear in memory in the same order they are given
866 in the command. At most 10 matches can be returned at a time, but
867 pressing return will show the next 10 matches. Environment variables
868 are set for use with scripting (memmatches, memaddr, mempos).
871 bool "Enable cyclic md/mw commands"
872 depends on CMD_MEMORY
874 Add the "mdc" and "mwc" memory commands. These are cyclic
879 This command will print 4 bytes (10,11,12,13) each 500 ms.
881 => mwc.l 100 12345678 10
882 This command will write 12345678 to address 100 all 10 ms.
887 depends on CMD_MEMORY && (LIB_RAND || LIB_HW_RAND)
889 random - fill memory with random data
894 Simple RAM read/write test.
898 config SYS_ALT_MEMTEST
899 bool "Alternative test"
901 Use a more complete alternative memory test.
905 config SYS_ALT_MEMTEST_BITFLIP
909 The alternative memory test includes bitflip test since 2020.07.
910 The bitflip test significantly increases the overall test time.
911 Bitflip test can optionally be disabled here.
915 config SYS_MEMTEST_START
916 hex "default start address for mtest"
919 This is the default start address for mtest for simple read/write
920 test. If no arguments are given to mtest, default address is used
923 config SYS_MEMTEST_END
924 hex "default end address for mtest"
927 This is the default end address for mtest for simple read/write
928 test. If no arguments are given to mtest, default address is used
937 Compute SHA1 checksum.
939 config SHA1SUM_VERIFY
941 depends on CMD_SHA1SUM
943 Add -v option to verify data against a SHA1 checksum.
946 bool "strings - display strings in memory"
948 This works similarly to the Unix 'strings' command except that it
949 works with a memory range. String of printable characters found
950 within the range are displayed. The minimum number of characters
951 for a sequence to be considered a string can be provided.
955 menu "Compression commands"
959 default y if CMD_BOOTI
962 Support decompressing an LZMA (Lempel-Ziv-Markov chain algorithm)
967 default y if CMD_BOOTI
970 Support decompressing an LZ4 image from memory region.
974 default y if CMD_BOOTI
977 Uncompress a zip-compressed memory region.
981 select GZIP_COMPRESSED
983 Compress a memory region with zlib deflate method.
987 menu "Device access commands"
990 bool "Arm FF-A test command"
991 depends on ARM_FFA_TRANSPORT
993 Provides a test command for the FF-A support
995 - Listing the partition(s) info
996 - Sending a data pattern to the specified partition
997 - Displaying the arm_ffa device info
1000 #depends on FLASH_CFI_DRIVER
1003 ARM Ltd reference designs flash partition access
1006 bool "adc - Access Analog to Digital Converters info and data"
1008 depends on DM_REGULATOR
1010 Shows ADC device info and permit printing one-shot analog converted
1011 data from a named Analog to Digital Converter.
1015 depends on PARTITIONS
1017 Read/modify/write the fields of Bootloader Control Block, usually
1018 stored on the flash "misc" partition with its structure defined in:
1019 https://android.googlesource.com/platform/bootable/recovery/+/master/
1020 bootloader_message/include/bootloader_message/bootloader_message.h
1022 Some real-life use-cases include (but are not limited to):
1023 - Determine the "boot reason" (and act accordingly):
1024 https://source.android.com/devices/bootloader/boot-reason
1025 - Get/pass a list of commands from/to recovery:
1026 https://android.googlesource.com/platform/bootable/recovery
1027 - Inspect/dump the contents of the BCB fields
1030 bool "bind/unbind - Bind or unbind a device to/from a driver"
1034 Bind or unbind a device to/from a driver from the command line.
1035 This is useful in situations where a device may be handled by several
1036 drivers. For example, this can be used to bind a UDC to the usb ether
1037 gadget driver from the command line.
1040 bool "clk - Show clock frequencies"
1043 Shows clock frequences by calling a sock_clk_dump() hook function.
1044 This is depreated in favour of using the CLK uclass and accessing
1045 clock values from associated drivers. However currently no command
1049 bool "demo - Demonstration commands for driver model"
1052 Provides a 'demo' command which can be used to play around with
1053 driver model. To use this properly you will need to enable one or
1054 both of the demo devices (DM_DEMO_SHAPE and DM_DEMO_SIMPLE).
1055 Otherwise you will always get an empty list of devices. The demo
1056 devices are defined in the sandbox device tree, so the easiest
1057 option is to use sandbox and pass the -d point to sandbox's
1064 Enables the command "dfu" which is used to have U-Boot create a DFU
1065 class device via USB. This command requires that the "dfu_alt_info"
1066 environment variable be set and define the alt settings to expose to
1070 bool "dm - Access to driver model information"
1073 Provides access to driver model data structures and information,
1074 such as a list of devices, list of uclasses and the state of each
1075 device (e.g. activated). This is not required for operation, but
1076 can be useful to see the state of driver model for debugging or
1080 bool "fastboot - Android fastboot support"
1083 This enables the command "fastboot" which enables the Android
1084 fastboot mode for the platform. Fastboot is a protocol for
1085 downloading images, flashing and device control used on
1086 Android devices. Fastboot requires either the network stack
1087 enabled or support for acting as a USB device.
1089 See doc/android/fastboot.rst for more information.
1092 bool "flinfo, erase, protect"
1094 depends on FLASH_CFI_DRIVER || MTD_NOR_FLASH
1097 flinfo - print FLASH memory information
1098 erase - FLASH memory
1099 protect - enable or disable FLASH write protection
1108 config CMD_FPGA_LOADBP
1109 bool "fpga loadbp - load partial bitstream (Xilinx only)"
1112 Supports loading an FPGA device from a bitstream buffer containing
1113 a partial bitstream.
1115 config CMD_FPGA_LOADFS
1116 bool "fpga loadfs - load bitstream from FAT filesystem (Xilinx only)"
1119 Supports loading an FPGA device from a FAT filesystem.
1121 config CMD_FPGA_LOADMK
1122 bool "fpga loadmk - load bitstream from image"
1125 Supports loading an FPGA device from a image generated by mkimage.
1127 config CMD_FPGA_LOADP
1128 bool "fpga loadp - load partial bitstream"
1131 Supports loading an FPGA device from a bitstream buffer containing
1132 a partial bitstream.
1134 config CMD_FPGA_LOAD_SECURE
1135 bool "fpga loads - loads secure bitstreams"
1137 select FPGA_LOAD_SECURE
1139 Enables the fpga loads command which is used to load secure
1140 (authenticated or encrypted or both) bitstreams on to FPGA.
1143 bool "fpgad - dump FPGA registers"
1145 (legacy, needs conversion to driver model)
1146 Provides a way to dump FPGA registers by calling the board-specific
1147 fpga_get_reg() function. This functions similarly to the 'md'
1151 bool "fuse - support for the fuse subssystem"
1153 (deprecated - needs conversion to driver model)
1154 This allows reading, sensing, programming or overriding fuses
1155 which control the behaviour of the device. The command uses the
1163 config CMD_GPIO_READ
1164 bool "gpio read - save GPIO value to variable"
1167 Enables the 'gpio read' command that saves the value
1168 of a GPIO pin to a variable.
1174 Control PWM channels, this allows invert/config/enable/disable PWM channels.
1177 bool "GPT (GUID Partition Table) command"
1178 select EFI_PARTITION
1179 select PARTITION_UUIDS
1182 Enable the 'gpt' command to ready and write GPT style partition
1185 config CMD_GPT_RENAME
1186 bool "GPT partition renaming commands"
1189 Enables the 'gpt' command to interchange names on two GPT
1190 partitions via the 'gpt swap' command or to rename single
1191 partitions via the 'rename' command.
1194 bool "ide - Support for IDE drivers"
1197 Provides an 'ide' command which allows accessing the IDE drive,
1198 resetting the IDE interface, printing the partition table and
1199 geting device info. It also enables the 'diskboot' command which
1200 permits booting from an IDE drive.
1203 bool "io - Support for performing I/O accesses"
1205 Provides an 'iod' command to display I/O space and an 'iow' command
1206 to write values to the I/O space. This can be useful for manually
1207 checking the state of devices during boot when debugging device
1211 bool "iotrace - Support for tracing I/O activity"
1213 Provides an 'iotrace' command which supports recording I/O reads and
1214 writes in a trace buffer in memory . It also maintains a checksum
1215 of the trace records (even if space is exhausted) so that the
1216 sequence of I/O accesses can be verified.
1218 When debugging drivers it is useful to see what I/O accesses were
1219 done and in what order.
1221 Even if the individual accesses are of little interest it can be
1222 useful to verify that the access pattern is consistent each time
1223 an operation is performed. In this case a checksum can be used to
1224 characterise the operation of a driver. The checksum can be compared
1225 across different runs of the operation to verify that the driver is
1228 In particular, when performing major refactoring of the driver, where
1229 the access pattern should not change, the checksum provides assurance
1230 that the refactoring work has not broken the driver.
1232 This works by sneaking into the io.h heder for an architecture and
1233 redirecting I/O accesses through iotrace's tracing mechanism.
1235 For now no commands are provided to examine the trace buffer. The
1236 format is fairly simple, so 'md' is a reasonable substitute.
1238 Note: The checksum feature is only useful for I/O regions where the
1239 contents do not change outside of software control. Where this is not
1240 suitable you can fall back to manually comparing the addresses. It
1241 might be useful to enhance tracing to only checksum the accesses and
1242 not the data read/written.
1252 bool "w1 - Support for Dallas 1-Wire protocol"
1254 Dallas 1-wire protocol support
1260 Load a binary file over serial line.
1265 Load a binary over memory mapped.
1268 bool "loads - Load a file over serial in S-Record format"
1271 Load an S-Record file over serial line
1274 bool "Echo all characters received during a loads back to console"
1275 depends on CMD_LOADS
1277 If enabled, all characters received during a serial download (using
1278 the "loads" command) are echoed back. This might be needed by some
1279 terminal emulations (like "cu"), but may as well just take time on
1280 others. This sets the initial value of the "loads_echo" environment
1284 bool "saves - Save a file over serial in S-Record format"
1285 depends on CMD_LOADS
1287 Provides a way to save a binary file using the Motorola S-Record
1288 format over the serial line.
1290 config SYS_LOADS_BAUD_CHANGE
1291 bool "Enable a temporary baudrate change during loads/saves command"
1292 depends on CMD_LOADS || CMD_SAVES
1294 config CMD_LOADXY_TIMEOUT
1295 int "loadxy_timeout"
1299 Initial timeout for loadx and loady commands. Zero means infinity.
1303 bool "lsblk - list block drivers and devices"
1305 Print list of available block device drivers, and for each, the list
1306 of known block devices.
1309 bool "MBR (Master Boot Record) command"
1310 select DOS_PARTITION
1312 Enable the 'mbr' command to ready and write MBR (Master Boot Record)
1313 style partition tables.
1319 Enable the command "misc" for accessing miscellaneous devices with
1320 a MISC uclass driver. The command provides listing all MISC devices
1321 as well as read and write functionalities via their drivers.
1327 MMC memory mapped support.
1331 config CMD_BKOPS_ENABLE
1332 bool "mmc bkops enable"
1335 Enable command for setting manual background operations handshake
1336 on a eMMC device. The feature is optionally available on eMMC devices
1337 conforming to standard >= 4.41.
1340 bool "Enable support for reading card registers in the mmc command"
1343 Enable the commands for reading card registers. This is useful
1344 mostly for debugging or extracting details from the card.
1347 bool "Enable support for RPMB in the mmc command"
1348 depends on SUPPORT_EMMC_RPMB
1350 Enable the commands for reading, writing and programming the
1351 key for the Replay Protection Memory Block partition in eMMC.
1353 config CMD_MMC_SWRITE
1355 depends on MMC_WRITE
1358 Enable support for the "mmc swrite" command to write Android sparse
1367 Enable storage cloning over block devices, useful for
1368 initial flashing by external block device without network
1371 config CMD_OPTEE_RPMB
1372 bool "Enable read/write support on RPMB via OPTEE"
1373 depends on SUPPORT_EMMC_RPMB && OPTEE
1375 Enable the commands for reading, writing persistent named values
1376 in the Replay Protection Memory Block partition in eMMC by
1377 using Persistent Objects in OPTEE
1382 select MTD_PARTITIONS
1384 MTD commands support.
1388 depends on MULTIPLEXER
1390 List, select, and deselect mux controllers on the fly.
1394 default y if NAND_SUNXI
1395 depends on MTD_RAW_NAND
1400 config CMD_NAND_TRIMFFS
1401 bool "nand write.trimffs"
1402 default y if ARCH_SUNXI
1404 Allows one to skip empty pages when flashing something on a NAND.
1406 config CMD_NAND_LOCK_UNLOCK
1407 bool "nand lock/unlock"
1409 NAND locking support.
1411 config CMD_NAND_TORTURE
1414 NAND torture support.
1423 NVM Express device support
1426 bool "onenand - access to onenand device"
1429 OneNAND is a brand of NAND ('Not AND' gate) flash which provides
1430 various useful features. This command allows reading, writing,
1431 and erasing blocks. It allso provides a way to show and change
1432 bad blocks, and test the device.
1434 config USE_ONENAND_BOARD_INIT
1435 bool "Call onenand_board_init() in the onenand command"
1436 depends on CMD_ONENAND
1441 Enable the 'osd' command which allows to query information from and
1442 write text data to a on-screen display (OSD) device; a virtual device
1443 associated with a display capable of displaying a text overlay on the
1444 display it's associated with..
1448 depends on PARTITIONS
1449 select PARTITION_UUIDS
1451 Read and display information about the partition table on
1455 bool "pci - Access PCI devices"
1457 Provide access to PCI (Peripheral Interconnect Bus), a type of bus
1458 used on some devices to allow the CPU to communicate with its
1459 peripherals. Sub-commands allow bus enumeration, displaying and
1460 changing configuration space and a few other features.
1463 bool "pci_mps - Configure PCI device MPS"
1466 Enables PCI Express Maximum Packet Size (MPS) tuning. This
1467 command configures the PCI Express MPS of each endpoint to the
1468 largest value supported by all devices below the root complex.
1469 The Maximum Read Request Size will not be altered. This method is
1470 the same algorithm as used by Linux pci=pcie_bus_safe.
1473 bool "pinmux - show pins muxing"
1475 default y if PINCTRL
1477 Parse all available pin-controllers and show pins muxing. This
1478 is useful for debug purpoer to check the pin muxing and to know if
1479 a pin is configured as a GPIO or as an alternate function.
1484 Poweroff/Shutdown the system
1487 bool "read - Read binary data from a partition"
1489 Provides low-level access to the data in a partition.
1491 config CMD_REMOTEPROC
1493 depends on REMOTEPROC
1495 Support for Remote Processor control
1498 bool "sata - Access SATA subsystem"
1501 SATA (Serial Advanced Technology Attachment) is a serial bus
1502 standard for connecting to hard drives and other storage devices.
1503 This command provides information about attached devices and allows
1504 reading, writing and other operations.
1506 SATA replaces PATA (originally just ATA), which stands for Parallel AT
1507 Attachment, where AT refers to an IBM AT (Advanced Technology)
1508 computer released in 1984.
1511 bool "scsi - Access to SCSI devices"
1515 This provides a 'scsi' command which provides access to SCSI (Small
1516 Computer System Interface) devices. The command provides a way to
1517 scan the bus, reset the bus, read and write data and get information
1521 bool "sdram - Print SDRAM configuration information"
1523 Provides information about attached SDRAM. This assumed that the
1524 SDRAM has an EEPROM with information that can be read using the
1525 I2C bus. This is only available on some boards.
1529 depends on DM_SPI_FLASH || SPI_FLASH
1530 default y if DM_SPI_FLASH
1535 bool "sf test - Allow testing of SPI flash"
1538 Provides a way to test that SPI flash is working correctly. The
1539 test is destructive, in that an area of SPI flash must be provided
1540 for the test to use. Performance information is also provided,
1541 measuring the performance of reading, writing and erasing in
1542 Mbps (Million Bits Per Second). This value should approximately
1543 equal the SPI bus speed for a single-bit-wide SPI bus, assuming
1544 everything is working properly.
1547 bool "sspi - Command to access spi device"
1550 SPI utility command.
1552 config DEFAULT_SPI_BUS
1553 int "default spi bus used by sspi command"
1557 config DEFAULT_SPI_MODE
1558 hex "default spi mode used by sspi command (see include/spi.h)"
1562 config CMD_TEMPERATURE
1563 bool "temperature - display the temperature from thermal sensors"
1564 depends on DM_THERMAL
1566 Provides a way to list thermal sensors and to get their readings.
1569 bool "tsi148 - Command to access tsi148 device"
1571 This provides various sub-commands to initialise and configure the
1572 Turndra tsi148 device. See the command help for full details.
1575 bool "ufs - Universal Flash Storage commands"
1578 "This provides commands to initialise and configure universal flash
1582 bool "universe - Command to set up the Turndra Universe controller"
1584 This allows setting up the VMEbus provided by this controller.
1585 See the command help for full details.
1595 select USB_FUNCTION_SDP
1597 Enables the command "sdp" which is used to have U-Boot emulating the
1598 Serial Download Protocol (SDP) via USB.
1604 Enable the command "rkmtd" to create a virtual block device to transfer
1605 Rockchip boot block data to and from NAND with block orientated tools
1606 like "ums" and "rockusb".
1610 depends on USB_FUNCTION_ROCKUSB
1612 Rockusb protocol is widely used by Rockchip SoC based devices. It can
1613 read/write info, image to/from devices. This enable rockusb command
1614 support to communication with rockusb device. for more detail about
1615 this command, please read doc/README.rockusb.
1617 config CMD_USB_MASS_STORAGE
1618 bool "UMS usb mass storage"
1619 depends on USB_GADGET_DOWNLOAD
1620 select USB_FUNCTION_MASS_STORAGE
1621 depends on BLK && USB_GADGET
1623 Enables the command "ums" and the USB mass storage support to the
1624 export a block device: U-Boot, the USB device, acts as a simple
1625 external hard drive plugged on the host USB port.
1627 config CMD_UMS_ABORT_KEYED
1628 bool "UMS abort with any key"
1629 depends on CMD_USB_MASS_STORAGE
1631 Allow interruption of usb mass storage run with any key pressed.
1634 bool "Xen para-virtualized block device"
1638 Xen para-virtualized block device support
1645 VirtIO block device support
1651 This provides commands to control the watchdog timer devices.
1654 bool "write - Write binary data to a partition"
1656 Provides low-level write access to a partition.
1662 Enable the command "axi" for accessing AXI (Advanced eXtensible
1663 Interface) busses, a on-chip interconnect specification for managing
1664 functional blocks in SoC designs, which is also often used in designs
1665 involving FPGAs (e.g. communication with IP cores in Xilinx FPGAs).
1669 menu "Shell scripting commands"
1674 Print file to standard output
1680 Echo args to console
1686 Return true/false on integer compare.
1692 Run script from memory
1698 Evaluate boolean and math expressions and store the result in an env
1700 Also supports loading the value at a memory location into a variable.
1701 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
1703 config CMD_SETEXPR_FMT
1705 depends on CMD_SETEXPR
1707 Evaluate format string expression and store result in an environment
1713 Print file as hexdump to standard output
1717 menu "Android support commands"
1719 config CMD_AB_SELECT
1721 depends on ANDROID_AB
1723 On Android devices with more than one boot slot (multiple copies of
1724 the kernel and system images) this provides a command to select which
1725 slot should be used to boot from and register the boot attempt. This
1726 is used by the new A/B update model where one slot is updated in the
1727 background while running from the other slot.
1734 bool "Network commands"
1743 bootp - boot image via network using BOOTP/TFTP protocol
1747 depends on CMD_BOOTP
1749 Boot image via network using DHCP/TFTP protocol
1755 Boot image via network using DHCPv6/TFTP protocol using IPv6.
1757 Will perform 4-message exchange with DHCPv6 server, requesting
1758 the minimum required options to TFTP boot. Complies with RFC 8415.
1760 config BOOTP_MAY_FAIL
1761 bool "Allow for the BOOTP/DHCP server to not be found"
1762 depends on CMD_BOOTP
1764 If the DHCP server is not found after the configured retry count, the
1765 call will fail instead of starting over. This can be used to fail
1766 over to Link-local IP address configuration if the DHCP server is not
1769 config BOOTP_BOOTPATH
1770 bool "Request & store 'rootpath' from BOOTP/DHCP server"
1772 depends on CMD_BOOTP
1774 Even though the config is called BOOTP_BOOTPATH, it stores the
1775 path in the variable 'rootpath'.
1777 config BOOTP_VENDOREX
1778 bool "Support vendor extensions from BOOTP/DHCP server"
1779 depends on CMD_BOOTP
1781 config BOOTP_BOOTFILESIZE
1782 bool "Request & store 'bootfilesize' from BOOTP/DHCP server"
1783 depends on CMD_BOOTP
1786 bool "Request & store 'dnsip' from BOOTP/DHCP server"
1788 depends on CMD_BOOTP
1790 The primary DNS server is stored as 'dnsip'. If two servers are
1791 returned, you must set BOOTP_DNS2 to store that second server IP
1795 bool "Store 'dnsip2' from BOOTP/DHCP server"
1796 depends on BOOTP_DNS
1798 If a DHCP client requests the DNS server IP from a DHCP server,
1799 it is possible that more than one DNS serverip is offered to the
1800 client. If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1801 server IP will be stored in the additional environment
1802 variable "dnsip2". The first DNS serverip is always
1803 stored in the variable "dnsip", when BOOTP_DNS is defined.
1805 config BOOTP_GATEWAY
1806 bool "Request & store 'gatewayip' from BOOTP/DHCP server"
1808 depends on CMD_BOOTP
1810 config BOOTP_HOSTNAME
1811 bool "Request & store 'hostname' from BOOTP/DHCP server"
1813 depends on CMD_BOOTP
1815 The name may or may not be qualified with the local domain name.
1817 config BOOTP_PREFER_SERVERIP
1818 bool "serverip variable takes precedent over DHCP server IP."
1819 depends on CMD_BOOTP
1821 By default a BOOTP/DHCP reply will overwrite the 'serverip' variable.
1823 With this option enabled, the 'serverip' variable in the environment
1824 takes precedence over DHCP server IP and will only be set by the DHCP
1825 server if not already set in the environment.
1827 config BOOTP_SUBNETMASK
1828 bool "Request & store 'netmask' from BOOTP/DHCP server"
1830 depends on CMD_BOOTP
1832 config BOOTP_NISDOMAIN
1833 bool "Request & store 'nisdomain' from BOOTP/DHCP server"
1834 depends on CMD_BOOTP
1836 config BOOTP_NTPSERVER
1837 bool "Request & store 'ntpserverip' from BOOTP/DHCP server"
1838 depends on CMD_BOOTP
1840 config BOOTP_TIMEOFFSET
1841 bool "Request & store 'timeoffset' from BOOTP/DHCP server"
1842 depends on CMD_BOOTP && CMD_SNTP
1847 Selecting this will allow capturing all Ethernet packets and store
1848 them in physical memory in a PCAP formated file,
1849 later to be analyzed by PCAP reader application (IE. WireShark).
1852 bool "Send PXE client arch to BOOTP/DHCP server"
1854 depends on CMD_BOOTP && CMD_PXE
1856 Supported for ARM, ARM64, and x86 for now.
1858 config BOOTP_PXE_CLIENTARCH
1860 depends on BOOTP_PXE
1861 default 0x16 if ARM64
1865 config BOOTP_PXE_DHCP_OPTION
1866 bool "Request & store 'pxe_configfile' from BOOTP/DHCP server"
1867 depends on BOOTP_PXE
1869 config BOOTP_VCI_STRING
1871 depends on CMD_BOOTP
1872 default "U-Boot.armv7" if CPU_V7A || CPU_V7M || CPU_V7R
1873 default "U-Boot.armv8" if ARM64
1874 default "U-Boot.arm" if ARM
1879 config DHCP6_PXE_CLIENTARCH
1881 default 0x16 if ARM64
1885 config DHCP6_PXE_DHCP_OPTION
1886 bool "Request & store 'pxe_configfile' from DHCP6 server"
1888 config DHCP6_ENTERPRISE_ID
1889 int "Enterprise ID to send in DHCPv6 Vendor Class Option"
1898 tftpboot - load file via network using TFTP protocol
1902 depends on CMD_TFTPBOOT
1904 TFTP put command, for uploading files to a server
1908 depends on CMD_TFTPBOOT
1910 Act as a TFTP server and boot the first received file
1912 config NET_TFTP_VARS
1913 bool "Control TFTP timeout and count through environment"
1914 depends on CMD_TFTPBOOT
1917 If set, allows controlling the TFTP timeout through the
1918 environment variable tftptimeout, and the TFTP maximum
1919 timeout count through the variable tftptimeoutcountmax.
1920 If unset, timeout and maximum are hard-defined as 1 second
1921 and 10 timouts per TFTP transfer.
1926 Boot image via network using RARP/TFTP protocol
1931 Boot image via network using NFS protocol.
1934 int "Timeout in milliseconds for NFS mounts"
1938 Timeout in milliseconds used in NFS protocol. If you encounter
1939 "ERROR: Cannot umount" in nfs command, try longer timeout such as
1942 config SYS_DISABLE_AUTOLOAD
1943 bool "Disable automatically loading files over the network"
1944 depends on CMD_BOOTP || CMD_DHCP || CMD_NFS || CMD_RARP
1946 Typically, commands such as "dhcp" will attempt to automatically
1947 load a file from the network, once the initial network configuration
1948 is complete. Enable this option to disable this behavior and instead
1949 require files to be loaded over the network by subsequent commands.
1955 wget is a simple command to download kernel, or other files,
1956 from a http server over TCP.
1962 If set, allows 802.3(clause 22) MII Management functions interface access
1963 The management interface specified in Clause 22 provides
1964 a simple, two signal, serial interface to connect a
1965 Station Management entity and a managed PHY for providing access
1966 to management parameters and services.
1967 The interface is referred to as the MII management interface.
1970 bool "Call mii_init() in the mii command"
1971 depends on CMD_MII && (MPC8XX_FEC || FSLDMAFE || MCFFEC)
1977 If set, allows Enable 802.3(clause 45) MDIO interface registers access
1978 The MDIO interface is orthogonal to the MII interface and extends
1979 it by adding access to more registers through indirect addressing.
1984 Send ICMP ECHO_REQUEST to network host
1989 default y if (CMD_PING && IPV6)
1991 Send ICMPv6 ECHO_REQUEST to network host
1996 Perform CDP network configuration
2002 Synchronize RTC via network
2007 Lookup the IP of a hostname
2009 config CMD_LINK_LOCAL
2013 Acquire a network IP address using the link-local protocol
2019 Manually configure the attached NIC via NC-SI.
2020 Normally this happens automatically before other network
2023 config IPV6_ROUTER_DISCOVERY
2024 bool "Do IPv6 router discovery"
2027 Will automatically perform router solicitation on first IPv6
2034 Allow control of L2 Ethernet switch commands. These are supported
2035 by the vsc9953 Ethernet driver at present. Sub-commands allow
2036 operations such as enabling / disabling a port and
2037 viewing/maintaining the filtering database (FDB)
2043 Boot image via network using PXE protocol
2048 Wait for wake-on-lan Magic Packet
2052 menu "Misc commands"
2057 This is a simple sliding block puzzle game designed by Italian web
2058 developer Gabriele Cirulli. The game's objective is to slide numbered
2059 tiles on a grid to combine them to create a tile with the number
2062 This needs ANSI support on your terminal to work. It is not fully
2063 functional on a video device.
2066 bool "Enable 'bmp' command"
2070 This provides a way to obtain information about a BMP-format image
2071 and to display it. BMP (which presumably stands for BitMaP) is a
2072 file format defined by Microsoft which supports images of various
2073 depths, formats and compression methods. Headers on the file
2074 determine the formats used. This command can be used by first loading
2075 the image into RAM, then using this command to look at it or display
2078 config CMD_BOOTCOUNT
2080 depends on BOOTCOUNT_LIMIT
2082 Enable the bootcount command, which allows interrogation and
2083 reset of the bootcounter.
2086 bool "Enable board-specific commands"
2088 (deprecated: instead, please define a Kconfig option for each command)
2090 Some boards have board-specific commands which are only enabled
2091 during developemnt and need to be turned off for production. This
2092 option provides a way to control this. The commands that are enabled
2093 vary depending on the board.
2095 config CMD_BLOCK_CACHE
2096 bool "blkcache - control and stats for block cache"
2097 depends on BLOCK_CACHE
2098 default y if BLOCK_CACHE
2100 Enable the blkcache command, which can be used to control the
2101 operation of the cache functions.
2102 This is most useful when fine-tuning the operation of the cache
2103 during development, but also allows the cache to be disabled when
2104 it might hurt performance (e.g. when using the ums command).
2107 bool "blkmap - Composable virtual block devices"
2111 Create virtual block devices that are backed by various sources,
2112 e.g. RAM, or parts of an existing block device. Though much more
2113 rudimentary, it borrows a lot of ideas from Linux's device mapper
2117 - Treat a region of RAM as a block device, i.e. a RAM disk. This let's
2118 you extract files from filesystem images stored in RAM (perhaps as a
2119 result of a TFTP transfer).
2120 - Create a virtual partition on an existing device. This let's you
2121 access filesystems that aren't stored at an exact partition
2122 boundary. A common example is a filesystem image embedded in an FIT
2130 Enable the 'button' command which allows to get the status of
2131 buttons supported by the board. The buttonss can be listed with
2132 'button list' and state can be known with 'button <label>'.
2133 Any button drivers can be controlled with this command, e.g.
2137 bool "icache or dcache"
2139 Enable the "icache" and "dcache" commands
2141 config CMD_CONITRACE
2142 bool "conitrace - trace console input codes"
2144 Enable the 'conitrace' command which displays the codes received
2145 from the console input as hexadecimal numbers.
2148 bool "Enable clear screen command 'cls'"
2149 default y if LCD || VIDEO
2151 Enable the 'cls' command which clears the screen contents
2152 on video frame buffer.
2155 bool "efidebug - display/configure UEFI environment"
2156 depends on EFI_LOADER
2157 select EFI_DEVICE_PATH_TO_TEXT
2159 Enable the 'efidebug' command which provides a subset of UEFI
2160 shell utility with simplified functionality. It will be useful
2161 particularly for managing boot parameters as well as examining
2162 various EFI status for debugging.
2164 config CMD_EFICONFIG
2165 bool "eficonfig - provide menu-driven uefi variables maintenance interface"
2166 default y if !HAS_BOARD_SIZE_LIMIT
2167 depends on EFI_BOOTMGR
2170 Enable the 'eficonfig' command which provides the menu-driven UEFI
2171 variable maintenance interface.
2173 config CMD_EXCEPTION
2174 bool "exception - raise exception"
2175 depends on ARM || RISCV || SANDBOX || X86
2177 Enable the 'exception' command which allows to raise an exception.
2184 Enable the 'led' command which allows for control of LEDs supported
2185 by the board. The LEDs can be listed with 'led list' and controlled
2186 with led on/off/togle/blink. Any LED drivers can be controlled with
2187 this command, e.g. led_gpio.
2192 Enable the 'ini' command which allows a .ini file to be parsed and
2193 placed into environment variables. Please check the source code for
2194 this as there is no documentation.
2201 Enable the 'date' command for getting/setting the time/date in RTC
2208 Enable the 'rtc' command for low-level access to RTC devices.
2213 Run commands and summarize execution time.
2216 bool "gettime - read elapsed time"
2218 Enable the 'gettime' command which reads the elapsed time since
2219 U-Boot started running. This shows the time in seconds and
2220 milliseconds. See also the 'bootstage' command which provides more
2221 flexibility for boot timing.
2224 bool "pause command"
2226 Delay execution waiting for any user input.
2227 Useful to allow the user to read a failure log.
2232 default y if SANDBOX
2235 Print bytes from the hardware random number generator.
2237 config CMD_KASLRSEED
2241 Set the kaslr-seed in the chosen node with entropy provided by a
2242 hardware random number generator.
2248 Delay execution for some time
2251 bool "support for multiprocessor commands"
2255 This enables commands to bringup different processors
2256 in multiprocessor cases.
2261 Access the system timer.
2267 This provides basic access to the U-Boot's sound support. The main
2268 feature is to play a beep.
2270 sound init - set up sound system
2271 sound play - play a sound
2277 Boot image via local extlinux.conf file
2282 default y if TARGET_QEMU_ARM_32BIT || TARGET_QEMU_ARM_64BIT || \
2283 TARGET_QEMU_X86 || TARGET_QEMU_X86_64
2285 This provides access to the QEMU firmware interface. The main
2286 feature is to allow easy loading of files passed to qemu-system
2287 via -kernel / -initrd
2292 This provides access to Linux PStore with Rammoops backend. The main
2293 feature is to allow to display or save PStore records.
2295 See doc/pstore.rst for more information.
2299 config CMD_PSTORE_MEM_ADDR
2300 hex "Memory Address"
2301 depends on CMD_PSTORE
2303 Base addr used for PStore ramoops memory, should be identical to
2304 ramoops.mem_address parameter used by kernel
2306 config CMD_PSTORE_MEM_SIZE
2308 depends on CMD_PSTORE
2311 Size of PStore ramoops memory, should be identical to ramoops.mem_size
2312 parameter used by kernel, a power of 2 and larger than the sum of the
2315 config CMD_PSTORE_RECORD_SIZE
2316 hex "Dump record size"
2317 depends on CMD_PSTORE
2320 Size of each dump done on oops/panic, should be identical to
2321 ramoops.record_size parameter used by kernel and a power of 2
2324 config CMD_PSTORE_CONSOLE_SIZE
2325 hex "Kernel console log size"
2326 depends on CMD_PSTORE
2329 Size of kernel console log, should be identical to
2330 ramoops.console_size parameter used by kernel and a power of 2
2333 config CMD_PSTORE_FTRACE_SIZE
2334 hex "FTrace log size"
2335 depends on CMD_PSTORE
2338 Size of ftrace log, should be identical to ramoops.ftrace_size
2339 parameter used by kernel and a power of 2
2341 config CMD_PSTORE_PMSG_SIZE
2342 hex "User space message log size"
2343 depends on CMD_PSTORE
2346 Size of user space message log, should be identical to
2347 ramoops.pmsg_size parameter used by kernel and a power of 2
2349 config CMD_PSTORE_ECC_SIZE
2351 depends on CMD_PSTORE
2354 if non-zero, the option enables ECC support and specifies ECC buffer
2355 size in bytes (1 is a special value, means 16 bytes ECC), should be
2356 identical to ramoops.ramoops_ecc parameter used by kernel
2360 source "cmd/mvebu/Kconfig"
2363 bool "terminal - provides a way to attach a serial terminal"
2365 Provides a 'cu'-like serial terminal command. This can be used to
2366 access other serial ports from the system console. The terminal
2367 is very simple with no special processing of characters. As with
2368 cu, you can press ~. (tilde followed by period) to exit.
2371 bool "uuid, guid - generation of unique IDs"
2374 This enables two commands:
2376 uuid - generate random Universally Unique Identifier
2377 guid - generate Globally Unique Identifier based on random UUID
2379 The two commands are very similar except for the endianness of the
2382 config CMD_VIDCONSOLE
2383 bool "lcdputs and setcurs"
2387 Enabling this will provide 'setcurs' and 'lcdputs' commands which
2388 support cursor positioning and drawing strings on the video
2389 console (framebuffer).
2391 The name 'lcdputs' is a bit of a misnomer, but so named because the
2392 video device is often an LCD.
2394 config CMD_SELECT_FONT
2395 bool "select font size"
2397 default y if CONSOLE_TRUETYPE
2399 Enabling this will provide 'font' command.
2400 Allows font selection at runtime.
2404 source "cmd/ti/Kconfig"
2406 config CMD_BOOTSTAGE
2407 bool "Enable the 'bootstage' command"
2408 depends on BOOTSTAGE
2410 Add a 'bootstage' command which supports printing a report
2411 and un/stashing of bootstage data.
2413 menu "Power commands"
2415 bool "Enable Driver Model PMIC command"
2418 This is the pmic command, based on a driver model pmic's API.
2419 Command features are unchanged:
2420 - list - list pmic devices
2421 - pmic dev <id> - show or [set] operating pmic device (NEW)
2422 - pmic dump - dump registers
2423 - pmic read address - read byte of register at address
2424 - pmic write address - write byte to register at address
2425 The only one change for this command is 'dev' subcommand.
2427 config CMD_REGULATOR
2428 bool "Enable Driver Model REGULATOR command"
2429 depends on DM_REGULATOR
2431 This command is based on driver model regulator's API.
2432 User interface features:
2433 - list - list regulator devices
2434 - regulator dev <id> - show or [set] operating regulator device
2435 - regulator info - print constraints info
2436 - regulator status - print operating status
2437 - regulator value <val] <-f> - print/[set] voltage value [uV]
2438 - regulator current <val> - print/[set] current value [uA]
2439 - regulator mode <id> - print/[set] operating mode id
2440 - regulator enable - enable the regulator output
2441 - regulator disable - disable the regulator output
2443 The '-f' (force) option can be used for set the value which exceeds
2444 the limits, which are found in device-tree and are kept in regulator's
2445 uclass plat structure.
2449 menu "Security commands"
2451 bool "Enable the 'aes' command"
2454 This provides a means to encrypt and decrypt data using the AES
2455 (Advanced Encryption Standard). This algorithm uses a symetric key
2456 and is widely used as a streaming cipher. Different key lengths are
2457 supported by the algorithm but this command only supports 128 bits
2461 bool "Enable the 'blob' command"
2462 depends on !MX6ULL && !MX6SLL && !MX6SL
2463 select IMX_HAB if ARCH_MX6 || ARCH_MX7 || ARCH_MX7ULP || ARCH_IMX8M
2465 This is used with the Freescale secure boot mechanism.
2467 Freescale's SEC block has built-in Blob Protocol which provides
2468 a method for protecting user-defined data across system power
2469 cycles. SEC block protects data in a data structure called a Blob,
2470 which provides both confidentiality and integrity protection.
2472 Encapsulating data as a blob
2473 Each time that the Blob Protocol is used to protect data, a
2474 different randomly generated key is used to encrypt the data.
2475 This random key is itself encrypted using a key which is derived
2476 from SoC's non-volatile secret key and a 16 bit Key identifier.
2477 The resulting encrypted key along with encrypted data is called a
2478 blob. The non-volatile secure key is available for use only during
2481 During decapsulation, the reverse process is performed to get back
2485 blob enc - encapsulating data as a cryptgraphic blob
2486 blob dec - decapsulating cryptgraphic blob to get the data
2490 blob enc src dst len km
2492 Encapsulate and create blob of data $len bytes long
2493 at address $src and store the result at address $dst.
2494 $km is the 16 byte key modifier is also required for
2495 generation/use as key for cryptographic operation. Key
2496 modifier should be 16 byte long.
2498 blob dec src dst len km
2500 Decapsulate the blob of data at address $src and
2501 store result of $len byte at addr $dst.
2502 $km is the 16 byte key modifier is also required for
2503 generation/use as key for cryptographic operation. Key
2504 modifier should be 16 byte long.
2507 bool "Support 'hash' command"
2510 This provides a way to hash data in memory using various supported
2511 algorithms (such as SHA1, MD5, CRC32). The computed digest can be
2512 saved to memory or to an environment variable. It is also possible
2513 to verify a hash against data in memory.
2516 bool "Support the 'hvc' command"
2517 depends on ARM_SMCCC
2519 Allows issuing Hypervisor Calls (HVCs). Mostly useful for
2520 development and testing.
2523 bool "Support the 'smc' command"
2524 depends on ARM_SMCCC
2526 Allows issuing Secure Monitor Calls (SMCs). Mostly useful for
2527 development and testing.
2533 Add -v option to verify data against a hash.
2536 bool "scp03 - SCP03 enable and rotate/provision operations"
2539 This command provides access to a Trusted Application
2540 running in a TEE to request Secure Channel Protocol 03
2541 (SCP03) enablement and/or rotation of its SCP03 keys.
2550 bool "Enable the 'tpm' command"
2551 depends on TPM_V1 || TPM_V2
2552 select CMD_TPM_V1 if TPM_V1
2553 select CMD_TPM_V2 if TPM_V2
2555 This provides a means to talk to a TPM from the command line. A wide
2556 range of commands if provided - see 'tpm help' for details. The
2557 command requires a suitable TPM on your board and the correct driver
2563 bool "Enable the 'tpm test' command"
2566 This provides a a series of tests to confirm that the TPMv1.x is
2567 working correctly. The tests cover initialisation, non-volatile RAM,
2568 extend, global lock and checking that timing is within expectations.
2569 The tests pass correctly on Infineon TPMs but may need to be adjusted
2576 menu "Firmware commands"
2578 bool "Enable crosec command"
2582 Enable command-line access to the Chrome OS EC (Embedded
2583 Controller). This provides the 'crosec' command which has
2584 a number of sub-commands for performing EC tasks such as
2585 updating its flash, accessing a small saved context area
2586 and talking to the I2C bus behind the EC (if there is one).
2589 bool "Enable scmi command"
2590 depends on SCMI_FIRMWARE
2593 This command provides user interfaces to several SCMI (System
2594 Control and Management Interface) protocols available on Arm
2595 platforms to manage system resources.
2598 menu "Filesystem commands"
2600 bool "Enable the 'btrsubvol' command"
2603 This enables the 'btrsubvol' command to list subvolumes
2604 of a BTRFS filesystem. There are no special commands for
2605 listing BTRFS directories or loading BTRFS files - this
2606 can be done by the generic 'fs' commands (see CMD_FS_GENERIC)
2607 when BTRFS is enabled (see FS_BTRFS).
2610 bool "Enable the 'cbfs' command"
2613 Define this to enable support for reading from a Coreboot
2614 filesystem. This is a ROM-based filesystem used for accessing files
2615 on systems that use coreboot as the first boot-loader and then load
2616 U-Boot to actually boot the Operating System. Available commands are
2617 cbfsinit, cbfsinfo, cbfsls and cbfsload.
2620 bool "Enable the 'cramfs' command"
2621 depends on FS_CRAMFS
2623 This provides commands for dealing with CRAMFS (Compressed ROM
2624 filesystem). CRAMFS is useful when space is tight since files are
2625 compressed. Two commands are provided:
2627 cramfsls - lists files in a cramfs image
2628 cramfsload - loads a file from a cramfs image
2631 bool "EROFS command support"
2634 Support for the EROFS fs
2637 bool "ext2 command support"
2640 Enables EXT2 FS command
2643 bool "ext4 command support"
2646 Enables EXT4 FS command
2648 config CMD_EXT4_WRITE
2650 bool "ext4 write command support"
2653 Enables EXT4 FS write command
2656 bool "FAT command support"
2659 Support for the FAT fs
2662 bool "SquashFS command support"
2665 Enables SquashFS filesystem commands (e.g. load, ls).
2667 config CMD_FS_GENERIC
2668 bool "filesystem commands"
2670 Enables filesystem commands (e.g. load, ls) that work for multiple
2674 bool "fsuuid command"
2676 Enables fsuuid command for filesystem UUID.
2679 bool "jffs2 command"
2682 Enables commands to support the JFFS2 (Journalling Flash File System
2683 version 2) filesystem. This enables fsload, ls and fsinfo which
2684 provide the ability to load files, list directories and obtain
2685 filesystem information.
2688 string "Default device for JFFS2"
2689 depends on CMD_JFFS2
2692 The default device to use with the jffs2 command.
2694 config JFFS2_PART_OFFSET
2695 hex "Default offset within flash to locate the JFFS2 image"
2696 depends on CMD_JFFS2
2699 The default offset within flash to locate the JFFS2 image.
2701 config JFFS2_PART_SIZE
2702 hex "Default size of JFFS2 partition"
2703 depends on CMD_JFFS2
2706 The default size of the JFFS2 partition
2709 bool "MTD partition support"
2711 select MTD_PARTITIONS
2713 MTD partitioning tool support.
2714 It is strongly encouraged to avoid using this command
2715 anymore along with 'sf', 'nand', 'onenand'. One can still
2716 declare the partitions in the mtdparts environment variable
2717 but better use the MTD stack and the 'mtd' command instead.
2719 config CMD_MTDPARTS_SPREAD
2720 bool "Padd partition size to take account of bad blocks"
2721 depends on CMD_MTDPARTS
2723 This enables the 'spread' sub-command of the mtdparts command.
2724 This command will modify the existing mtdparts variable by increasing
2725 the size of the partitions such that 1) each partition's net size is
2726 at least as large as the size specified in the mtdparts variable and
2727 2) each partition starts on a good block.
2729 config CMD_MTDPARTS_SHOW_NET_SIZES
2730 bool "Show net size (w/o bad blocks) of partitions"
2731 depends on CMD_MTDPARTS
2733 Adds two columns to the printed partition table showing the
2734 effective usable size of a partition, if bad blocks are taken
2737 config MTDIDS_DEFAULT
2738 string "Default MTD IDs"
2739 depends on MTD || SPI_FLASH
2740 depends on !SYS_MTDPARTS_RUNTIME
2742 Defines a default MTD IDs list for use with MTD partitions in the
2743 Linux MTD command line partitions format.
2745 config MTDPARTS_DEFAULT
2746 string "Default MTD partition scheme"
2747 depends on MTD || SPI_FLASH
2748 depends on !SYS_MTDPARTS_RUNTIME
2750 Defines a default MTD partitioning scheme in the Linux MTD command
2751 line partitions format
2754 bool "reiser - Access to reiserfs filesystems"
2756 This provides two commands which operate on a resierfs filesystem,
2757 commonly used some years ago:
2759 reiserls - list files
2760 reiserload - load a file
2763 bool "yaffs2 - Access of YAFFS2 filesystem"
2767 This provides commands for accessing a YAFFS2 filesystem. Yet
2768 Another Flash Filesystem 2 is a filesystem designed specifically
2769 for NAND flash. It incorporates bad-block management and ensures
2770 that device writes are sequential regardless of filesystem
2774 bool "zfs - Access of ZFS filesystem"
2776 This provides commands to accessing a ZFS filesystem, commonly used
2777 on Solaris systems. Two sub-commands are provided:
2779 zfsls - list files in a directory
2780 zfsload - load a file
2782 See doc/README.zfs for more details.
2786 menu "Debug commands"
2788 config CMD_CBSYSINFO
2791 default y if SYS_COREBOOT
2793 This provides information about the coreboot sysinfo table stored in
2794 memory by coreboot before jumping to U-Boot. It can be useful for
2795 debugging the beaaviour of coreboot or U-Boot.
2798 bool "cyclic - Show information about cyclic functions"
2802 This enables the 'cyclic' command which provides information about
2803 cyclic execution functions. This infrastructure allows registering
2804 functions to be executed cyclically, e.g. every 100ms. These commands
2807 cyclic list - list cyclic functions
2808 cyclic cyclic demo <cycletime_ms> <delay_us> - register cyclic
2811 See doc/develop/cyclic.rst for more details.
2814 bool "diag - Board diagnostics"
2816 This command provides access to board diagnostic tests. These are
2817 called Power-on Self Tests (POST). The command allows listing of
2818 available tests and running either all the tests, or specific tests
2822 bool "event - Show information about events"
2824 default y if EVENT_DEBUG
2826 This enables the 'event' command which provides information about
2827 events and event-handler routines. This can help to device event
2831 bool "irq - Show information about interrupts"
2832 depends on !ARM && !MIPS && !RISCV && !SH
2834 This enables two commands:
2836 interrupts - enable or disable interrupts
2837 irqinfo - print device-specific interrupt information
2840 bool "kgdb - Allow debugging of U-Boot with gdb"
2843 This enables a 'kgdb' command which allows gdb to connect to U-Boot
2844 over a serial link for debugging purposes. This allows
2845 single-stepping, inspecting variables, etc. This is supported only
2846 on PowerPC at present.
2849 bool "log - Generation, control and access to logging"
2853 This provides access to logging features. It allows the output of
2854 log data to be controlled to a limited extent (setting up the default
2855 maximum log level for emitting of records). It also provides access
2856 to a command used for testing the log system.
2859 bool "trace - Support tracing of function calls and timing"
2863 Enables a command to control using of function tracing within
2864 U-Boot. This allows recording of call traces including timing
2865 information. The command can write data to memory for exporting
2866 for analysis (e.g. using bootchart). See doc/README.trace for full
2870 bool "avb - Android Verified Boot 2.0 operations"
2871 depends on AVB_VERIFY
2873 Enables a "avb" command to perform verification of partitions using
2874 Android Verified Boot 2.0 functionality. It includes such subcommands:
2875 avb init - initialize avb2 subsystem
2876 avb read_rb - read rollback index
2877 avb write_rb - write rollback index
2878 avb is_unlocked - check device lock state
2879 avb get_uuid - read and print uuid of a partition
2880 avb read_part - read data from partition
2881 avb read_part_hex - read data from partition and output to stdout
2882 avb write_part - write data to partition
2883 avb verify - run full verification chain
2885 config CMD_STACKPROTECTOR_TEST
2886 bool "Test command for stack protector"
2887 depends on STACKPROTECTOR
2889 Enable stackprot_test command
2890 The stackprot_test command will force a stack overrun to test
2891 the stack smashing detection mechanisms.
2896 tristate "Enable UBI - Unsorted block images commands"
2899 UBI is a software layer above MTD layer which admits use of LVM-like
2900 logical volumes on top of MTD devices, hides some complexities of
2901 flash chips like wear and bad blocks and provides some other useful
2902 capabilities. Please, consult the MTD web site for more details
2903 (www.linux-mtd.infradead.org). Activate this option if you want
2904 to use U-Boot UBI commands.
2905 It is also strongly encouraged to also enable CONFIG_MTD to get full
2908 config CMD_UBI_RENAME
2909 bool "Enable rename"
2912 Enable a "ubi" command to rename ubi volume:
2913 ubi rename <oldname> <newname>
2916 tristate "Enable UBIFS - Unsorted block images filesystem commands"
2918 default y if CMD_UBI
2922 UBIFS is a file system for flash devices which works on top of UBI.
2924 config MMC_SPEED_MODE_SET
2925 bool "set speed mode using mmc command"
2928 Enable setting speed mode using mmc rescan and mmc dev commands.
2929 The speed mode is provided as the last argument in these commands
2930 and is indicated using the index from enum bus_mode in
2931 include/mmc.h. A speed mode can be set only if it has already
2932 been enabled in the device tree.
2935 bool "Amlogic Meson commands"
2936 depends on ARCH_MESON
2939 Enable useful commands for the Meson Soc family developed by Amlogic Inc.
projects / J-u-boot.git / blob