1 menu "Command line interface"
4 bool "Support U-Boot commands"
7 Enable U-Boot's command-line functions. This provides a means
8 to enter commands into U-Boot for a wide variety of purposes. It
9 also allows scripts (containing commands) to be executed.
10 Various commands and command categorys can be indivdually enabled.
11 Depending on the number of commands enabled, this can add
12 substantially to the size of U-Boot.
18 This option enables the "hush" shell (from Busybox) as command line
19 interpreter, thus enabling powerful command line syntax like
20 if...then...else...fi conditionals or `&&' and '||'
21 constructs ("shell scripts").
23 If disabled, you get the old, much simpler behaviour with a somewhat
24 smaller memory footprint.
26 config CMDLINE_EDITING
27 bool "Enable command line editing"
31 Enable editing and History functions for interactive command line
35 bool "Enable auto complete using TAB"
39 Enable auto completion of commands using TAB.
42 bool "Enable long help messages"
46 Defined when you want long help messages included
47 Do not set this option when short of memory.
51 default "Zynq> " if ARCH_ZYNQ
52 default "ZynqMP> " if ARCH_ZYNQMP
55 This string is displayed in the command line to the left of the
59 string "Command execution tracer"
63 This option enables the possiblity to print all commands before
64 executing them and after all variables are evaluated (similar
65 to Bash's xtrace/'set -x' feature).
66 To enable the tracer a variable "xtrace" needs to be defined in
80 List and dump ACPI tables. ACPI (Advanced Configuration and Power
81 Interface) is used mostly on x86 for providing information to the
82 Operating System about devices in the system. The tables are set up
83 by the firmware, typically U-Boot but possibly an earlier firmware
84 module, if U-Boot is chain-loaded from something else. ACPI tables
85 can also include code, to perform hardware-specific tasks required
86 by the Operating Systems. This allows some amount of separation
87 between the firmware and OS, and is particularly useful when you
88 want to make hardware changes without the OS needing to be adjusted.
101 Print ".config" contents.
103 If this option is enabled, the ".config" file contents are embedded
104 in the U-Boot image and can be printed on the console by the "config"
105 command. This provides information of which options are enabled on
112 Print console devices and information.
117 Print information about available CPUs. This normally shows the
118 number of CPUs, type (e.g. manufacturer, architecture, product or
119 internal name) and clock frequency. Other information may be
120 available depending on the CPU driver.
126 Print GPL license text
131 Provides access to the Intel Power-Management Controller (PMC) so
132 that its state can be examined. This does not currently support
133 changing the state but it is still useful for debugging and seeing
142 config CMD_TLV_EEPROM
144 depends on I2C_EEPROM
146 Display and program the system EEPROM data block in ONIE Tlvinfo
147 format. TLV stands for Type-Length-Value.
149 config SPL_CMD_TLV_EEPROM
150 bool "tlv_eeprom for SPL"
151 depends on SPL_I2C_EEPROM
152 select SPL_DRIVERS_MISC_SUPPORT
154 Read system EEPROM data block in ONIE Tlvinfo format from SPL.
158 depends on RISCV_SMODE && SBI_V02
160 Display information about the SBI implementation.
170 Run the command stored in the environment "bootcmd", i.e.
171 "bootd" does the same thing as "run bootcmd".
177 Boot an application image from the memory.
180 bool "Support booting UEFI FIT images"
181 depends on CMD_BOOTEFI && CMD_BOOTM && FIT
184 Support booting UEFI FIT images via the bootm command.
189 Boot the Linux zImage
193 depends on ARM64 || RISCV
196 Boot an AArch64 Linux Kernel image from memory.
199 bool "Support booting Linux OS images"
200 depends on CMD_BOOTM || CMD_BOOTZ || CMD_BOOTI
203 Support booting the Linux kernel directly via a command such as bootm
207 bool "Support booting NetBSD (non-EFI) loader images"
211 Support booting NetBSD via the bootm command.
213 config BOOTM_OPENRTOS
214 bool "Support booting OPENRTOS / FreeRTOS images"
217 Support booting OPENRTOS / FreeRTOS via the bootm command.
220 bool "Support booting Enea OSE images"
221 depends on (ARM && (ARM64 || CPU_V7A || CPU_V7R) || SANDBOX || PPC || X86)
224 Support booting Enea OSE images via the bootm command.
227 bool "Support booting Plan9 OS images"
231 Support booting Plan9 images via the bootm command.
234 bool "Support booting RTEMS OS images"
238 Support booting RTEMS images via the bootm command.
241 bool "Support booting VxWorks OS images"
245 Support booting VxWorks images via the bootm command.
249 depends on EFI_LOADER
252 Boot an EFI image from memory.
254 config CMD_BOOTEFI_HELLO_COMPILE
255 bool "Compile a standard EFI hello world binary for testing"
256 depends on CMD_BOOTEFI && !CPU_V7M
259 This compiles a standard EFI hello world application with U-Boot so
260 that it can be used with the test/py testing framework. This is useful
261 for testing that EFI is working at a basic level, and for bringing
262 up EFI support on a new architecture.
264 No additional space will be required in the resulting U-Boot binary
265 when this option is enabled.
267 config CMD_BOOTEFI_HELLO
268 bool "Allow booting a standard EFI hello world for testing"
269 depends on CMD_BOOTEFI_HELLO_COMPILE
270 default y if CMD_BOOTEFI_SELFTEST
272 This adds a standard EFI hello world application to U-Boot so that
273 it can be used with the 'bootefi hello' command. This is useful
274 for testing that EFI is working at a basic level, and for bringing
275 up EFI support on a new architecture.
277 source lib/efi_selftest/Kconfig
283 Add an ANSI terminal boot menu command.
288 Android DTB/DTBO image manipulation commands. Read dtb/dtbo files from
289 image into RAM, dump image structure information, etc. Those dtb/dtbo
290 files should be merged in one dtb further, which needs to be passed to
291 the kernel, as part of a boot process.
295 depends on ANDROID_BOOT_IMAGE
297 Android Boot Image manipulation commands. Allows one to extract
298 images contained in boot.img, like kernel, ramdisk, dtb, etc, and
299 obtain corresponding meta-information from boot.img.
301 See doc/android/boot-image.rst for details.
304 bool "bootelf, bootvx"
308 Boot an ELF/vxWorks image from the memory.
311 bool "Flattened Device Tree utility commands"
315 Do FDT related setup before booting into the Operating System.
321 Start an application at a given address.
327 Run the command in the given environment variable.
333 Print header information for application image.
338 List all images found in flash
344 Extract a part of a multi-image.
347 bool "spl export - Export boot information for Falcon boot"
350 Falcon mode allows booting directly from SPL into an Operating
351 System such as Linux, thus skipping U-Boot proper. See
352 doc/README.falcon for full information about how to use this
355 config CMD_SPL_NAND_OFS
356 hex "Offset of OS args or dtb for Falcon-mode NAND boot"
357 depends on CMD_SPL && (TPL_NAND_SUPPORT || SPL_NAND_SUPPORT)
360 This provides the offset of the command line arguments for Linux
361 when booting from NAND in Falcon mode. See doc/README.falcon
362 for full information about how to use this option (and also see
363 board/gateworks/gw_ventana/README for an example).
365 config CMD_SPL_NOR_OFS
366 hex "Offset of OS args or dtb for Falcon-mode NOR boot"
367 depends on CMD_SPL && SPL_NOR_SUPPORT
370 This provides the offset of the command line arguments or dtb for
371 Linux when booting from NOR in Falcon mode.
373 config CMD_SPL_WRITE_SIZE
374 hex "Size of argument area"
378 This provides the size of the command-line argument area in NAND
379 flash used by Falcon-mode boot. See the documentation until CMD_SPL
382 config CMD_THOR_DOWNLOAD
383 bool "thor - TIZEN 'thor' download"
386 Implements the 'thor' download protocol. This is a way of
387 downloading a software update over USB from an attached host.
388 There is no documentation about this within the U-Boot source code
389 but you should be able to find something on the interwebs.
392 bool "zboot - x86 boot command"
394 With x86 machines it is common to boot a bzImage file which
395 contains both a kernel and a setup.bin file. The latter includes
396 configuration information from the dark ages which x86 boards still
397 need to pick things out of.
399 Consider using FIT in preference to this since it supports directly
400 booting both 32- and 64-bit kernels, as well as secure boot.
401 Documentation is available in doc/uImage.FIT/x86-fit-boot.txt
405 menu "Environment commands"
408 bool "ask for env variable"
410 Ask for environment variable
428 Edit environment variable.
433 Allow for searching environment variables
439 Save all environment variables into the compiled-in persistent
445 depends on CMD_SAVEENV
447 Erase environment variables from the compiled-in persistent
450 config CMD_ENV_EXISTS
454 Check if a variable is defined in the environment for use in
457 config CMD_ENV_CALLBACK
458 bool "env callbacks - print callbacks and their associated variables"
460 Some environment variable have callbacks defined by
461 U_BOOT_ENV_CALLBACK. These are called when the variable changes.
462 For example changing "baudrate" adjust the serial baud rate. This
463 command lists the currently defined callbacks.
466 bool "env flags -print variables that have non-default flags"
468 Some environment variables have special flags that control their
469 behaviour. For example, serial# can only be written once and cannot
470 be deleted. This command shows the variables that have special
473 config CMD_NVEDIT_EFI
474 bool "env [set|print] -e - set/print UEFI variables"
475 depends on EFI_LOADER
478 UEFI variables are encoded as some form of U-Boot variables.
479 If enabled, we are allowed to set/print UEFI variables using
480 "env" command with "-e" option without knowing details.
482 config CMD_NVEDIT_INFO
483 bool "env info - print or evaluate environment information"
485 Print environment information:
486 - env_valid : is environment valid
487 - env_ready : is environment imported into hash table
488 - env_use_default : is default environment used
490 This command can be optionally used for evaluation in scripts:
491 [-d] : evaluate whether default environment is used
492 [-p] : evaluate whether environment can be persisted
494 The result of multiple evaluations will be combined with AND.
496 config CMD_NVEDIT_LOAD
499 Load all environment variables from the compiled-in persistent
502 config CMD_NVEDIT_SELECT
505 Select the compiled-in persistent storage of environment variables.
509 menu "Memory commands"
514 Compute binary operations (xor, or, and) of byte arrays of arbitrary
515 size from memory and store the result in memory or the environment.
519 default y if BLOBLIST
521 Show information about the bloblist, a collection of binary blobs
522 held in memory that persist between SPL and U-Boot. In the case of
523 x86 devices the bloblist can be used to hold ACPI tables so that they
524 remain available in memory.
537 Add -v option to verify data against a crc32 checksum.
540 bool "eeprom - EEPROM subsystem"
542 (deprecated, needs conversion to driver model)
543 Provides commands to read and write EEPROM (Electrically Erasable
544 Programmable Read Only Memory) chips that are connected over an
547 config CMD_EEPROM_LAYOUT
548 bool "Enable layout-aware eeprom commands"
549 depends on CMD_EEPROM
551 (deprecated, needs conversion to driver model)
552 When enabled, additional eeprom sub-commands become available.
554 eeprom print - prints the contents of the eeprom in a human-readable
555 way (eeprom layout fields, and data formatted to be fit for human
558 eeprom update - allows user to update eeprom fields by specifying
559 the field name, and providing the new data in a human readable format
560 (same format as displayed by the eeprom print command).
562 Both commands can either auto detect the layout, or be told which
566 __weak int parse_layout_version(char *str)
567 - override to provide your own layout name parsing
568 __weak void __eeprom_layout_assign(struct eeprom_layout *layout,
570 - override to setup the layout metadata based on the version
571 __weak int eeprom_layout_detect(unsigned char *data)
572 - override to provide your own algorithm for detecting layout
575 - contains various printing and updating functions for common
576 types of eeprom fields. Can be used for defining
579 config EEPROM_LAYOUT_HELP_STRING
580 string "Tells user what layout names are supported"
581 depends on CMD_EEPROM_LAYOUT
582 default "<not defined>"
584 Help printed with the LAYOUT VERSIONS part of the 'eeprom'
590 Infinite write loop on address range
597 Compute MD5 checksum.
602 depends on CMD_MD5SUM
604 Add -v option to verify data against an MD5 checksum.
609 Display memory information.
612 bool "md, mm, nm, mw, cp, cmp, base, loop"
617 mm - memory modify (auto-incrementing address)
618 nm - memory modify (constant address)
619 mw - memory write (fill)
622 base - print or set address offset
623 loop - initialize loop on address range
625 config CMD_MEM_SEARCH
626 bool "ms - Memory search"
628 Memory-search command
630 This allows searching through a region of memory looking for hex
631 data (byte, 16-bit word, 32-bit long, also 64-bit on machines that
632 support it). It is also possible to search for a string. The
633 command accepts a memory range and a list of values to search for.
634 The values need to appear in memory in the same order they are given
635 in the command. At most 10 matches can be returned at a time, but
636 pressing return will show the next 10 matches. Environment variables
637 are set for use with scripting (memmatches, memaddr, mempos).
640 bool "Enable cyclic md/mw commands"
641 depends on CMD_MEMORY
643 Add the "mdc" and "mwc" memory commands. These are cyclic
648 This command will print 4 bytes (10,11,12,13) each 500 ms.
650 => mwc.l 100 12345678 10
651 This command will write 12345678 to address 100 all 10 ms.
656 depends on CMD_MEMORY && (LIB_RAND || LIB_HW_RAND)
658 random - fill memory with random data
663 Simple RAM read/write test.
667 config SYS_ALT_MEMTEST
668 bool "Alternative test"
670 Use a more complete alternative memory test.
674 config SYS_ALT_MEMTEST_BITFLIP
678 The alternative memory test includes bitflip test since 2020.07.
679 The bitflip test significantly increases the overall test time.
680 Bitflip test can optionally be disabled here.
684 config SYS_MEMTEST_START
685 hex "default start address for mtest"
688 This is the default start address for mtest for simple read/write
689 test. If no arguments are given to mtest, default address is used
692 config SYS_MEMTEST_END
693 hex "default end address for mtest"
696 This is the default end address for mtest for simple read/write
697 test. If no arguments are given to mtest, default address is used
706 Compute SHA1 checksum.
708 config SHA1SUM_VERIFY
710 depends on CMD_SHA1SUM
712 Add -v option to verify data against a SHA1 checksum.
715 bool "strings - display strings in memory"
717 This works similarly to the Unix 'strings' command except that it
718 works with a memory range. String of printable characters found
719 within the range are displayed. The minimum number of characters
720 for a sequence to be considered a string can be provided.
724 menu "Compression commands"
728 default y if CMD_BOOTI
731 Support decompressing an LZMA (Lempel-Ziv-Markov chain algorithm)
736 default y if CMD_BOOTI
739 Support decompressing an LZ4 image from memory region.
743 default y if CMD_BOOTI
746 Uncompress a zip-compressed memory region.
750 select GZIP_COMPRESSED
752 Compress a memory region with zlib deflate method.
756 menu "Device access commands"
759 #depends on FLASH_CFI_DRIVER
762 ARM Ltd reference designs flash partition access
765 bool "adc - Access Analog to Digital Converters info and data"
767 depends on DM_REGULATOR
769 Shows ADC device info and permit printing one-shot analog converted
770 data from a named Analog to Digital Converter.
775 depends on PARTITIONS
777 Read/modify/write the fields of Bootloader Control Block, usually
778 stored on the flash "misc" partition with its structure defined in:
779 https://android.googlesource.com/platform/bootable/recovery/+/master/
780 bootloader_message/include/bootloader_message/bootloader_message.h
782 Some real-life use-cases include (but are not limited to):
783 - Determine the "boot reason" (and act accordingly):
784 https://source.android.com/devices/bootloader/boot-reason
785 - Get/pass a list of commands from/to recovery:
786 https://android.googlesource.com/platform/bootable/recovery
787 - Inspect/dump the contents of the BCB fields
790 bool "bind/unbind - Bind or unbind a device to/from a driver"
793 Bind or unbind a device to/from a driver from the command line.
794 This is useful in situations where a device may be handled by several
795 drivers. For example, this can be used to bind a UDC to the usb ether
796 gadget driver from the command line.
799 bool "clk - Show clock frequencies"
802 Shows clock frequences by calling a sock_clk_dump() hook function.
803 This is depreated in favour of using the CLK uclass and accessing
804 clock values from associated drivers. However currently no command
808 bool "demo - Demonstration commands for driver model"
811 Provides a 'demo' command which can be used to play around with
812 driver model. To use this properly you will need to enable one or
813 both of the demo devices (DM_DEMO_SHAPE and DM_DEMO_SIMPLE).
814 Otherwise you will always get an empty list of devices. The demo
815 devices are defined in the sandbox device tree, so the easiest
816 option is to use sandbox and pass the -d point to sandbox's
823 Enables the command "dfu" which is used to have U-Boot create a DFU
824 class device via USB. This command requires that the "dfu_alt_info"
825 environment variable be set and define the alt settings to expose to
829 bool "dm - Access to driver model information"
832 Provides access to driver model data structures and information,
833 such as a list of devices, list of uclasses and the state of each
834 device (e.g. activated). This is not required for operation, but
835 can be useful to see the state of driver model for debugging or
839 bool "fastboot - Android fastboot support"
842 This enables the command "fastboot" which enables the Android
843 fastboot mode for the platform. Fastboot is a protocol for
844 downloading images, flashing and device control used on
845 Android devices. Fastboot requires either the network stack
846 enabled or support for acting as a USB device.
848 See doc/android/fastboot.rst for more information.
851 bool "flinfo, erase, protect"
853 depends on MTD || FLASH_CFI_DRIVER || MTD_NOR_FLASH
856 flinfo - print FLASH memory information
858 protect - enable or disable FLASH write protection
867 config CMD_FPGA_LOADBP
868 bool "fpga loadbp - load partial bitstream (Xilinx only)"
871 Supports loading an FPGA device from a bitstream buffer containing
874 config CMD_FPGA_LOADFS
875 bool "fpga loadfs - load bitstream from FAT filesystem (Xilinx only)"
878 Supports loading an FPGA device from a FAT filesystem.
880 config CMD_FPGA_LOADMK
881 bool "fpga loadmk - load bitstream from image"
884 Supports loading an FPGA device from a image generated by mkimage.
886 config CMD_FPGA_LOADP
887 bool "fpga loadp - load partial bitstream"
890 Supports loading an FPGA device from a bitstream buffer containing
893 config CMD_FPGA_LOAD_SECURE
894 bool "fpga loads - loads secure bitstreams (Xilinx only)"
897 Enables the fpga loads command which is used to load secure
898 (authenticated or encrypted or both) bitstreams on to FPGA.
901 bool "fpgad - dump FPGA registers"
903 (legacy, needs conversion to driver model)
904 Provides a way to dump FPGA registers by calling the board-specific
905 fpga_get_reg() function. This functions similarly to the 'md'
909 bool "fuse - support for the fuse subssystem"
911 (deprecated - needs conversion to driver model)
912 This allows reading, sensing, programming or overriding fuses
913 which control the behaviour of the device. The command uses the
922 bool "GPT (GUID Partition Table) command"
924 select HAVE_BLOCK_DEVICE
925 select PARTITION_UUIDS
928 Enable the 'gpt' command to ready and write GPT style partition
932 bool "GPT Random UUID generation"
935 Enable the generation of partitions with random UUIDs if none
938 config CMD_GPT_RENAME
939 bool "GPT partition renaming commands"
942 Enables the 'gpt' command to interchange names on two GPT
943 partitions via the 'gpt swap' command or to rename single
944 partitions via the 'rename' command.
947 bool "ide - Support for IDE drivers"
950 Provides an 'ide' command which allows accessing the IDE drive,
951 reseting the IDE interface, printing the partition table and
952 geting device info. It also enables the 'diskboot' command which
953 permits booting from an IDE drive.
956 bool "io - Support for performing I/O accesses"
958 Provides an 'iod' command to display I/O space and an 'iow' command
959 to write values to the I/O space. This can be useful for manually
960 checking the state of devices during boot when debugging device
964 bool "iotrace - Support for tracing I/O activity"
966 Provides an 'iotrace' command which supports recording I/O reads and
967 writes in a trace buffer in memory . It also maintains a checksum
968 of the trace records (even if space is exhausted) so that the
969 sequence of I/O accesses can be verified.
971 When debugging drivers it is useful to see what I/O accesses were
972 done and in what order.
974 Even if the individual accesses are of little interest it can be
975 useful to verify that the access pattern is consistent each time
976 an operation is performed. In this case a checksum can be used to
977 characterise the operation of a driver. The checksum can be compared
978 across different runs of the operation to verify that the driver is
981 In particular, when performing major refactoring of the driver, where
982 the access pattern should not change, the checksum provides assurance
983 that the refactoring work has not broken the driver.
985 This works by sneaking into the io.h heder for an architecture and
986 redirecting I/O accesses through iotrace's tracing mechanism.
988 For now no commands are provided to examine the trace buffer. The
989 format is fairly simple, so 'md' is a reasonable substitute.
991 Note: The checksum feature is only useful for I/O regions where the
992 contents do not change outside of software control. Where this is not
993 suitable you can fall back to manually comparing the addresses. It
994 might be useful to enhance tracing to only checksum the accesses and
995 not the data read/written.
1005 bool "w1 - Support for Dallas 1-Wire protocol"
1007 Dallas 1-wire protocol support
1013 Load a binary file over serial line.
1019 Load an S-Record file over serial line
1023 bool "lsblk - list block drivers and devices"
1025 Print list of available block device drivers, and for each, the list
1026 of known block devices.
1031 MMC memory mapped support.
1035 config CMD_BKOPS_ENABLE
1036 bool "mmc bkops enable"
1040 Enable command for setting manual background operations handshake
1041 on a eMMC device. The feature is optionally available on eMMC devices
1042 conforming to standard >= 4.41.
1045 bool "Enable support for RPMB in the mmc command"
1046 depends on SUPPORT_EMMC_RPMB
1048 Enable the commands for reading, writing and programming the
1049 key for the Replay Protection Memory Block partition in eMMC.
1051 config CMD_MMC_SWRITE
1053 depends on MMC_WRITE
1056 Enable support for the "mmc swrite" command to write Android sparse
1065 Enable storage cloning over block devices, useful for
1066 initial flashing by external block device without network
1072 select MTD_PARTITIONS
1074 MTD commands support.
1078 default y if NAND_SUNXI
1079 depends on MTD_RAW_NAND
1084 config CMD_NAND_TRIMFFS
1085 bool "nand write.trimffs"
1086 default y if ARCH_SUNXI
1088 Allows one to skip empty pages when flashing something on a NAND.
1090 config CMD_NAND_LOCK_UNLOCK
1091 bool "nand lock/unlock"
1093 NAND locking support.
1095 config CMD_NAND_TORTURE
1098 NAND torture support.
1107 NVM Express device support
1110 bool "onenand - access to onenand device"
1113 OneNAND is a brand of NAND ('Not AND' gate) flash which provides
1114 various useful features. This command allows reading, writing,
1115 and erasing blocks. It allso provides a way to show and change
1116 bad blocks, and test the device.
1121 Enable the 'osd' command which allows to query information from and
1122 write text data to a on-screen display (OSD) device; a virtual device
1123 associated with a display capable of displaying a text overlay on the
1124 display it's associated with..
1128 select HAVE_BLOCK_DEVICE
1129 select PARTITION_UUIDS
1131 Read and display information about the partition table on
1135 bool "pci - Access PCI devices"
1137 Provide access to PCI (Peripheral Interconnect Bus), a type of bus
1138 used on some devices to allow the CPU to communicate with its
1139 peripherals. Sub-commands allow bus enumeration, displaying and
1140 changing configuration space and a few other features.
1143 bool "pinmux - show pins muxing"
1144 default y if PINCTRL
1146 Parse all available pin-controllers and show pins muxing. This
1147 is useful for debug purpoer to check the pin muxing and to know if
1148 a pin is configured as a GPIO or as an alternate function.
1153 Poweroff/Shutdown the system
1156 bool "read - Read binary data from a partition"
1158 Provides low-level access to the data in a partition.
1160 config CMD_REMOTEPROC
1162 depends on REMOTEPROC
1164 Support for Remote Processor control
1167 bool "sata - Access SATA subsystem"
1170 SATA (Serial Advanced Technology Attachment) is a serial bus
1171 standard for connecting to hard drives and other storage devices.
1172 This command provides information about attached devices and allows
1173 reading, writing and other operations.
1175 SATA replaces PATA (originally just ATA), which stands for Parallel AT
1176 Attachment, where AT refers to an IBM AT (Advanced Technology)
1177 computer released in 1984.
1180 bool "saves - Save a file over serial in S-Record format"
1182 Provides a way to save a binary file using the Motorola S-Record
1183 format over the serial line.
1186 bool "scsi - Access to SCSI devices"
1189 This provides a 'scsi' command which provides access to SCSI (Small
1190 Computer System Interface) devices. The command provides a way to
1191 scan the bus, reset the bus, read and write data and get information
1195 bool "sdram - Print SDRAM configuration information"
1197 Provides information about attached SDRAM. This assumed that the
1198 SDRAM has an EEPROM with information that can be read using the
1199 I2C bus. This is only available on some boards.
1203 depends on DM_SPI_FLASH || SPI_FLASH
1204 default y if DM_SPI_FLASH
1209 bool "sf test - Allow testing of SPI flash"
1212 Provides a way to test that SPI flash is working correctly. The
1213 test is destructive, in that an area of SPI flash must be provided
1214 for the test to use. Performance information is also provided,
1215 measuring the performance of reading, writing and erasing in
1216 Mbps (Million Bits Per Second). This value should approximately
1217 equal the SPI bus speed for a single-bit-wide SPI bus, assuming
1218 everything is working properly.
1221 bool "sspi - Command to access spi device"
1224 SPI utility command.
1226 config DEFAULT_SPI_BUS
1227 int "default spi bus used by sspi command"
1231 config DEFAULT_SPI_MODE
1232 hex "default spi mode used by sspi command (see include/spi.h)"
1237 bool "tsi148 - Command to access tsi148 device"
1239 This provides various sub-commands to initialise and configure the
1240 Turndra tsi148 device. See the command help for full details.
1243 bool "Enable UFS - Universal Flash Subsystem commands"
1246 "This provides commands to initialise and configure universal flash
1250 bool "universe - Command to set up the Turndra Universe controller"
1252 This allows setting up the VMEbus provided by this controller.
1253 See the command help for full details.
1257 select HAVE_BLOCK_DEVICE
1263 select USB_FUNCTION_SDP
1265 Enables the command "sdp" which is used to have U-Boot emulating the
1266 Serial Download Protocol (SDP) via USB.
1270 depends on USB_FUNCTION_ROCKUSB
1272 Rockusb protocol is widely used by Rockchip SoC based devices. It can
1273 read/write info, image to/from devices. This enable rockusb command
1274 support to communication with rockusb device. for more detail about
1275 this command, please read doc/README.rockusb.
1277 config CMD_USB_MASS_STORAGE
1278 bool "UMS usb mass storage"
1279 select USB_FUNCTION_MASS_STORAGE
1281 USB mass storage support
1284 bool "Xen para-virtualized block device"
1288 Xen para-virtualized block device support
1295 VirtIO block device support
1301 This provides commands to control the watchdog timer devices.
1307 Enable the command "axi" for accessing AXI (Advanced eXtensible
1308 Interface) busses, a on-chip interconnect specification for managing
1309 functional blocks in SoC designs, which is also often used in designs
1310 involving FPGAs (e.g. communication with IP cores in Xilinx FPGAs).
1314 menu "Shell scripting commands"
1320 Echo args to console
1326 Return true/false on integer compare.
1332 Run script from memory
1338 Evaluate boolean and math expressions and store the result in an env
1340 Also supports loading the value at a memory location into a variable.
1341 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
1345 menu "Android support commands"
1347 config CMD_AB_SELECT
1350 depends on ANDROID_AB
1352 On Android devices with more than one boot slot (multiple copies of
1353 the kernel and system images) this provides a command to select which
1354 slot should be used to boot from and register the boot attempt. This
1355 is used by the new A/B update model where one slot is updated in the
1356 background while running from the other slot.
1363 bool "Network commands"
1373 bootp - boot image via network using BOOTP/TFTP protocol
1377 depends on CMD_BOOTP
1379 Boot image via network using DHCP/TFTP protocol
1381 config BOOTP_BOOTPATH
1382 bool "Request & store 'rootpath' from BOOTP/DHCP server"
1384 depends on CMD_BOOTP
1386 Even though the config is called BOOTP_BOOTPATH, it stores the
1387 path in the variable 'rootpath'.
1390 bool "Request & store 'dnsip' from BOOTP/DHCP server"
1392 depends on CMD_BOOTP
1394 The primary DNS server is stored as 'dnsip'. If two servers are
1395 returned, you must set BOOTP_DNS2 to store that second server IP
1399 bool "Store 'dnsip2' from BOOTP/DHCP server"
1400 depends on BOOTP_DNS
1402 If a DHCP client requests the DNS server IP from a DHCP server,
1403 it is possible that more than one DNS serverip is offered to the
1404 client. If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1405 server IP will be stored in the additional environment
1406 variable "dnsip2". The first DNS serverip is always
1407 stored in the variable "dnsip", when BOOTP_DNS is defined.
1409 config BOOTP_GATEWAY
1410 bool "Request & store 'gatewayip' from BOOTP/DHCP server"
1412 depends on CMD_BOOTP
1414 config BOOTP_HOSTNAME
1415 bool "Request & store 'hostname' from BOOTP/DHCP server"
1417 depends on CMD_BOOTP
1419 The name may or may not be qualified with the local domain name.
1421 config BOOTP_PREFER_SERVERIP
1422 bool "serverip variable takes precedent over DHCP server IP."
1423 depends on CMD_BOOTP
1425 By default a BOOTP/DHCP reply will overwrite the 'serverip' variable.
1427 With this option enabled, the 'serverip' variable in the environment
1428 takes precedence over DHCP server IP and will only be set by the DHCP
1429 server if not already set in the environment.
1431 config BOOTP_SUBNETMASK
1432 bool "Request & store 'netmask' from BOOTP/DHCP server"
1434 depends on CMD_BOOTP
1436 config BOOTP_NTPSERVER
1437 bool "Request & store 'ntpserverip' from BOOTP/DHCP server"
1438 depends on CMD_BOOTP
1443 Selecting this will allow capturing all Ethernet packets and store
1444 them in physical memory in a PCAP formated file,
1445 later to be analyzed by PCAP reader application (IE. WireShark).
1448 bool "Send PXE client arch to BOOTP/DHCP server"
1450 depends on CMD_BOOTP && CMD_PXE
1452 Supported for ARM, ARM64, and x86 for now.
1454 config BOOTP_PXE_CLIENTARCH
1456 depends on BOOTP_PXE
1457 default 0x16 if ARM64
1461 config BOOTP_VCI_STRING
1463 depends on CMD_BOOTP
1464 default "U-Boot.armv7" if CPU_V7A || CPU_V7M || CPU_V7R
1465 default "U-Boot.armv8" if ARM64
1466 default "U-Boot.arm" if ARM
1473 tftpboot - boot image via network using TFTP protocol
1477 depends on CMD_TFTPBOOT
1479 TFTP put command, for uploading files to a server
1483 depends on CMD_TFTPBOOT
1485 Act as a TFTP server and boot the first received file
1487 config NET_TFTP_VARS
1488 bool "Control TFTP timeout and count through environment"
1489 depends on CMD_TFTPBOOT
1492 If set, allows controlling the TFTP timeout through the
1493 environment variable tftptimeout, and the TFTP maximum
1494 timeout count through the variable tftptimeoutcountmax.
1495 If unset, timeout and maximum are hard-defined as 1 second
1496 and 10 timouts per TFTP transfer.
1501 Boot image via network using RARP/TFTP protocol
1507 Boot image via network using NFS protocol.
1513 If set, allows 802.3(clause 22) MII Management functions interface access
1514 The management interface specified in Clause 22 provides
1515 a simple, two signal, serial interface to connect a
1516 Station Management entity and a managed PHY for providing access
1517 to management parameters and services.
1518 The interface is referred to as the MII management interface.
1524 If set, allows Enable 802.3(clause 45) MDIO interface registers access
1525 The MDIO interface is orthogonal to the MII interface and extends
1526 it by adding access to more registers through indirect addressing.
1531 Send ICMP ECHO_REQUEST to network host
1536 Perform CDP network configuration
1542 Synchronize RTC via network
1547 Lookup the IP of a hostname
1549 config CMD_LINK_LOCAL
1553 Acquire a network IP address using the link-local protocol
1560 Allow control of L2 Ethernet switch commands. These are supported
1561 by the vsc9953 Ethernet driver at present. Sub-commands allow
1562 operations such as enabling / disabling a port and
1563 viewing/maintaining the filtering database (FDB)
1569 Boot image via network using PXE protocol
1574 Wait for wake-on-lan Magic Packet
1578 menu "Misc commands"
1581 bool "Enable 'bmp' command"
1582 depends on LCD || DM_VIDEO || VIDEO
1584 This provides a way to obtain information about a BMP-format image
1585 and to display it. BMP (which presumably stands for BitMaP) is a
1586 file format defined by Microsoft which supports images of various
1587 depths, formats and compression methods. Headers on the file
1588 determine the formats used. This command can be used by first loading
1589 the image into RAM, then using this command to look at it or display
1592 config CMD_BOOTCOUNT
1594 depends on BOOTCOUNT_LIMIT
1596 Enable the bootcount command, which allows interrogation and
1597 reset of the bootcounter.
1600 bool "Enable board-specific commands"
1602 (deprecated: instead, please define a Kconfig option for each command)
1604 Some boards have board-specific commands which are only enabled
1605 during developemnt and need to be turned off for production. This
1606 option provides a way to control this. The commands that are enabled
1607 vary depending on the board.
1609 config CMD_BLOCK_CACHE
1610 bool "blkcache - control and stats for block cache"
1611 depends on BLOCK_CACHE
1612 default y if BLOCK_CACHE
1614 Enable the blkcache command, which can be used to control the
1615 operation of the cache functions.
1616 This is most useful when fine-tuning the operation of the cache
1617 during development, but also allows the cache to be disabled when
1618 it might hurt performance (e.g. when using the ums command).
1625 Enable the 'button' command which allows to get the status of
1626 buttons supported by the board. The buttonss can be listed with
1627 'button list' and state can be known with 'button <label>'.
1628 Any button drivers can be controlled with this command, e.g.
1632 bool "icache or dcache"
1634 Enable the "icache" and "dcache" commands
1636 config CMD_CONITRACE
1637 bool "conitrace - trace console input codes"
1639 Enable the 'conitrace' command which displays the codes received
1640 from the console input as hexadecimal numbers.
1643 bool "Enable clear screen command 'cls'"
1644 depends on CFB_CONSOLE || DM_VIDEO || LCD || VIDEO
1647 Enable the 'cls' command which clears the screen contents
1648 on video frame buffer.
1651 bool "efidebug - display/configure UEFI environment"
1652 depends on EFI_LOADER
1653 select EFI_DEVICE_PATH_TO_TEXT
1656 Enable the 'efidebug' command which provides a subset of UEFI
1657 shell utility with simplified functionality. It will be useful
1658 particularly for managing boot parameters as well as examining
1659 various EFI status for debugging.
1661 config CMD_EXCEPTION
1662 bool "exception - raise exception"
1663 depends on ARM || RISCV || X86
1665 Enable the 'exception' command which allows to raise an exception.
1672 Enable the 'led' command which allows for control of LEDs supported
1673 by the board. The LEDs can be listed with 'led list' and controlled
1674 with led on/off/togle/blink. Any LED drivers can be controlled with
1675 this command, e.g. led_gpio.
1682 Enable the 'date' command for getting/setting the time/date in RTC
1689 Enable the 'rtc' command for low-level access to RTC devices.
1694 Run commands and summarize execution time.
1697 bool "gettime - read elapsed time"
1699 Enable the 'gettime' command which reads the elapsed time since
1700 U-Boot started running. This shows the time in seconds and
1701 milliseconds. See also the 'bootstage' command which provides more
1702 flexibility for boot timing.
1709 Print bytes from the hardware random number generator.
1711 # TODO: rename to CMD_SLEEP
1716 Delay execution for some time
1719 bool "support for multiprocessor"
1721 This provides an option to brinup
1722 different processors in multiprocessor
1728 Access the system timer.
1734 This provides basic access to the U-Boot's sound support. The main
1735 feature is to play a beep.
1737 sound init - set up sound system
1738 sound play - play a sound
1744 Boot image via local extlinux.conf file
1750 This provides access to the QEMU firmware interface. The main
1751 feature is to allow easy loading of files passed to qemu-system
1752 via -kernel / -initrd
1754 source "cmd/mvebu/Kconfig"
1757 bool "terminal - provides a way to attach a serial terminal"
1759 Provides a 'cu'-like serial terminal command. This can be used to
1760 access other serial ports from the system console. The terminal
1761 is very simple with no special processing of characters. As with
1762 cu, you can press ~. (tilde followed by period) to exit.
1765 bool "uuid, guid - generation of unique IDs"
1768 This enables two commands:
1770 uuid - generate random Universally Unique Identifier
1771 guid - generate Globally Unique Identifier based on random UUID
1773 The two commands are very similar except for the endianness of the
1778 source "cmd/ti/Kconfig"
1780 config CMD_BOOTSTAGE
1781 bool "Enable the 'bootstage' command"
1782 depends on BOOTSTAGE
1784 Add a 'bootstage' command which supports printing a report
1785 and un/stashing of bootstage data.
1787 menu "Power commands"
1789 bool "Enable Driver Model PMIC command"
1792 This is the pmic command, based on a driver model pmic's API.
1793 Command features are unchanged:
1794 - list - list pmic devices
1795 - pmic dev <id> - show or [set] operating pmic device (NEW)
1796 - pmic dump - dump registers
1797 - pmic read address - read byte of register at address
1798 - pmic write address - write byte to register at address
1799 The only one change for this command is 'dev' subcommand.
1801 config CMD_REGULATOR
1802 bool "Enable Driver Model REGULATOR command"
1803 depends on DM_REGULATOR
1805 This command is based on driver model regulator's API.
1806 User interface features:
1807 - list - list regulator devices
1808 - regulator dev <id> - show or [set] operating regulator device
1809 - regulator info - print constraints info
1810 - regulator status - print operating status
1811 - regulator value <val] <-f> - print/[set] voltage value [uV]
1812 - regulator current <val> - print/[set] current value [uA]
1813 - regulator mode <id> - print/[set] operating mode id
1814 - regulator enable - enable the regulator output
1815 - regulator disable - disable the regulator output
1817 The '-f' (force) option can be used for set the value which exceeds
1818 the limits, which are found in device-tree and are kept in regulator's
1819 uclass platdata structure.
1823 menu "Security commands"
1825 bool "Enable the 'aes' command"
1828 This provides a means to encrypt and decrypt data using the AES
1829 (Advanced Encryption Standard). This algorithm uses a symetric key
1830 and is widely used as a streaming cipher. Different key lengths are
1831 supported by the algorithm but this command only supports 128 bits
1835 bool "Enable the 'blob' command"
1837 This is used with the Freescale secure boot mechanism.
1839 Freescale's SEC block has built-in Blob Protocol which provides
1840 a method for protecting user-defined data across system power
1841 cycles. SEC block protects data in a data structure called a Blob,
1842 which provides both confidentiality and integrity protection.
1844 Encapsulating data as a blob
1845 Each time that the Blob Protocol is used to protect data, a
1846 different randomly generated key is used to encrypt the data.
1847 This random key is itself encrypted using a key which is derived
1848 from SoC's non-volatile secret key and a 16 bit Key identifier.
1849 The resulting encrypted key along with encrypted data is called a
1850 blob. The non-volatile secure key is available for use only during
1853 During decapsulation, the reverse process is performed to get back
1857 blob enc - encapsulating data as a cryptgraphic blob
1858 blob dec - decapsulating cryptgraphic blob to get the data
1862 blob enc src dst len km
1864 Encapsulate and create blob of data $len bytes long
1865 at address $src and store the result at address $dst.
1866 $km is the 16 byte key modifier is also required for
1867 generation/use as key for cryptographic operation. Key
1868 modifier should be 16 byte long.
1870 blob dec src dst len km
1872 Decapsulate the blob of data at address $src and
1873 store result of $len byte at addr $dst.
1874 $km is the 16 byte key modifier is also required for
1875 generation/use as key for cryptographic operation. Key
1876 modifier should be 16 byte long.
1879 bool "Support 'hash' command"
1882 This provides a way to hash data in memory using various supported
1883 algorithms (such as SHA1, MD5, CRC32). The computed digest can be
1884 saved to memory or to an environment variable. It is also possible
1885 to verify a hash against data in memory.
1888 bool "Support the 'hvc' command"
1889 depends on ARM_SMCCC
1891 Allows issuing Hypervisor Calls (HVCs). Mostly useful for
1892 development and testing.
1895 bool "Support the 'smc' command"
1896 depends on ARM_SMCCC
1898 Allows issuing Secure Monitor Calls (SMCs). Mostly useful for
1899 development and testing.
1905 Add -v option to verify data against a hash.
1915 bool "Enable the 'tpm' command"
1916 depends on TPM_V1 || TPM_V2
1917 select CMD_TPM_V1 if TPM_V1
1918 select CMD_TPM_V2 if TPM_V2
1920 This provides a means to talk to a TPM from the command line. A wide
1921 range of commands if provided - see 'tpm help' for details. The
1922 command requires a suitable TPM on your board and the correct driver
1928 bool "Enable the 'tpm test' command"
1931 This provides a a series of tests to confirm that the TPMv1.x is
1932 working correctly. The tests cover initialisation, non-volatile RAM,
1933 extend, global lock and checking that timing is within expectations.
1934 The tests pass correctly on Infineon TPMs but may need to be adjusted
1941 menu "Firmware commands"
1943 bool "Enable crosec command"
1947 Enable command-line access to the Chrome OS EC (Embedded
1948 Controller). This provides the 'crosec' command which has
1949 a number of sub-commands for performing EC tasks such as
1950 updating its flash, accessing a small saved context area
1951 and talking to the I2C bus behind the EC (if there is one).
1954 menu "Filesystem commands"
1956 bool "Enable the 'btrsubvol' command"
1959 This enables the 'btrsubvol' command to list subvolumes
1960 of a BTRFS filesystem. There are no special commands for
1961 listing BTRFS directories or loading BTRFS files - this
1962 can be done by the generic 'fs' commands (see CMD_FS_GENERIC)
1963 when BTRFS is enabled (see FS_BTRFS).
1966 bool "Enable the 'cbfs' command"
1969 Define this to enable support for reading from a Coreboot
1970 filesystem. This is a ROM-based filesystem used for accessing files
1971 on systems that use coreboot as the first boot-loader and then load
1972 U-Boot to actually boot the Operating System. Available commands are
1973 cbfsinit, cbfsinfo, cbfsls and cbfsload.
1976 bool "Enable the 'cramfs' command"
1977 depends on FS_CRAMFS
1979 This provides commands for dealing with CRAMFS (Compressed ROM
1980 filesystem). CRAMFS is useful when space is tight since files are
1981 compressed. Two commands are provided:
1983 cramfsls - lists files in a cramfs image
1984 cramfsload - loads a file from a cramfs image
1987 bool "ext2 command support"
1990 Enables EXT2 FS command
1993 bool "ext4 command support"
1996 Enables EXT4 FS command
1998 config CMD_EXT4_WRITE
2000 bool "ext4 write command support"
2003 Enables EXT4 FS write command
2006 bool "FAT command support"
2009 Support for the FAT fs
2012 bool "SquashFS command support"
2015 Enables SquashFS filesystem commands (e.g. load, ls).
2017 config CMD_FS_GENERIC
2018 bool "filesystem commands"
2020 Enables filesystem commands (e.g. load, ls) that work for multiple
2024 bool "fsuuid command"
2026 Enables fsuuid command for filesystem UUID.
2029 bool "jffs2 command"
2032 Enables commands to support the JFFS2 (Journalling Flash File System
2033 version 2) filesystem. This enables fsload, ls and fsinfo which
2034 provide the ability to load files, list directories and obtain
2035 filesystem information.
2038 bool "MTD partition support"
2041 MTD partitioning tool support.
2042 It is strongly encouraged to avoid using this command
2043 anymore along with 'sf', 'nand', 'onenand'. One can still
2044 declare the partitions in the mtdparts environment variable
2045 but better use the MTD stack and the 'mtd' command instead.
2047 config CMD_MTDPARTS_SPREAD
2048 bool "Padd partition size to take account of bad blocks"
2049 depends on CMD_MTDPARTS
2051 This enables the 'spread' sub-command of the mtdparts command.
2052 This command will modify the existing mtdparts variable by increasing
2053 the size of the partitions such that 1) each partition's net size is
2054 at least as large as the size specified in the mtdparts variable and
2055 2) each partition starts on a good block.
2057 config CMD_MTDPARTS_SHOW_NET_SIZES
2058 bool "Show net size (w/o bad blocks) of partitions"
2059 depends on CMD_MTDPARTS
2061 Adds two columns to the printed partition table showing the
2062 effective usable size of a partition, if bad blocks are taken
2065 config MTDIDS_DEFAULT
2066 string "Default MTD IDs"
2067 depends on MTD || SPI_FLASH
2069 Defines a default MTD IDs list for use with MTD partitions in the
2070 Linux MTD command line partitions format.
2072 config MTDPARTS_DEFAULT
2073 string "Default MTD partition scheme"
2074 depends on MTD || SPI_FLASH
2076 Defines a default MTD partitioning scheme in the Linux MTD command
2077 line partitions format
2080 bool "reiser - Access to reiserfs filesystems"
2082 This provides two commands which operate on a resierfs filesystem,
2083 commonly used some years ago:
2085 reiserls - list files
2086 reiserload - load a file
2089 bool "yaffs2 - Access of YAFFS2 filesystem"
2093 This provides commands for accessing a YAFFS2 filesystem. Yet
2094 Another Flash Filesystem 2 is a filesystem designed specifically
2095 for NAND flash. It incorporates bad-block management and ensures
2096 that device writes are sequential regardless of filesystem
2100 bool "zfs - Access of ZFS filesystem"
2102 This provides commands to accessing a ZFS filesystem, commonly used
2103 on Solaris systems. Two sub-commands are provided:
2105 zfsls - list files in a directory
2106 zfsload - load a file
2108 See doc/README.zfs for more details.
2112 menu "Debug commands"
2117 The bedbug (emBEDded deBUGger) command provides debugging features
2118 for some PowerPC processors. For details please see the
2119 documentation in doc/README.bedbug.
2122 bool "diag - Board diagnostics"
2124 This command provides access to board diagnostic tests. These are
2125 called Power-on Self Tests (POST). The command allows listing of
2126 available tests and running either all the tests, or specific tests
2130 bool "irq - Show information about interrupts"
2131 depends on !ARM && !MIPS && !RISCV && !SH
2133 This enables two commands:
2135 interrupts - enable or disable interrupts
2136 irqinfo - print device-specific interrupt information
2139 bool "kgdb - Allow debugging of U-Boot with gdb"
2142 This enables a 'kgdb' command which allows gdb to connect to U-Boot
2143 over a serial link for debugging purposes. This allows
2144 single-stepping, inspecting variables, etc. This is supported only
2145 on PowerPC at present.
2148 bool "log - Generation, control and access to logging"
2151 This provides access to logging features. It allows the output of
2152 log data to be controlled to a limited extent (setting up the default
2153 maximum log level for emitting of records). It also provides access
2154 to a command used for testing the log system.
2157 bool "trace - Support tracing of function calls and timing"
2159 Enables a command to control using of function tracing within
2160 U-Boot. This allows recording of call traces including timing
2161 information. The command can write data to memory for exporting
2162 for analysis (e.g. using bootchart). See doc/README.trace for full
2166 bool "avb - Android Verified Boot 2.0 operations"
2167 depends on AVB_VERIFY
2170 Enables a "avb" command to perform verification of partitions using
2171 Android Verified Boot 2.0 functionality. It includes such subcommands:
2172 avb init - initialize avb2 subsystem
2173 avb read_rb - read rollback index
2174 avb write_rb - write rollback index
2175 avb is_unlocked - check device lock state
2176 avb get_uuid - read and print uuid of a partition
2177 avb read_part - read data from partition
2178 avb read_part_hex - read data from partition and output to stdout
2179 avb write_part - write data to partition
2180 avb verify - run full verification chain
2184 tristate "Enable UBI - Unsorted block images commands"
2187 UBI is a software layer above MTD layer which admits use of LVM-like
2188 logical volumes on top of MTD devices, hides some complexities of
2189 flash chips like wear and bad blocks and provides some other useful
2190 capabilities. Please, consult the MTD web site for more details
2191 (www.linux-mtd.infradead.org). Activate this option if you want
2192 to use U-Boot UBI commands.
2193 It is also strongly encouraged to also enable CONFIG_MTD to get full
2196 config CMD_UBI_RENAME
2197 bool "Enable rename"
2201 Enable a "ubi" command to rename ubi volume:
2202 ubi rename <oldname> <newname>
2205 tristate "Enable UBIFS - Unsorted block images filesystem commands"
2207 default y if CMD_UBI
2210 UBIFS is a file system for flash devices which works on top of UBI.
projects / platform / kernel / u-boot.git / blob