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.
53 This string is displayed in the command line to the left of the
57 string "Command execution tracer"
61 This option enables the possiblity to print all commands before
62 executing them and after all variables are evaluated (similar
63 to Bash's xtrace/'set -x' feature).
64 To enable the tracer a variable "xtrace" needs to be defined in
67 menu "Autoboot options"
73 This enables the autoboot. See doc/README.autoboot for detail.
76 bool "Stop autobooting via specific input key / string"
79 This option enables stopping (aborting) of the automatic
80 boot feature only by issuing a specific input key or
81 string. If not enabled, any input key will abort the
82 U-Boot automatic booting process and bring the device
83 to the U-Boot prompt for user input.
85 config AUTOBOOT_PROMPT
86 string "Autoboot stop prompt"
87 depends on AUTOBOOT_KEYED
88 default "Autoboot in %d seconds\\n"
90 This string is displayed before the boot delay selected by
91 CONFIG_BOOTDELAY starts. If it is not defined there is no
92 output indicating that autoboot is in progress.
94 Note that this define is used as the (only) argument to a
95 printf() call, so it may contain '%' format specifications,
96 provided that it also includes, sepearated by commas exactly
97 like in a printf statement, the required arguments. It is
98 the responsibility of the user to select only such arguments
99 that are valid in the given context.
101 config AUTOBOOT_ENCRYPTION
102 bool "Enable encryption in autoboot stopping"
103 depends on AUTOBOOT_KEYED
106 config AUTOBOOT_DELAY_STR
107 string "Delay autobooting via specific input key / string"
108 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
110 This option delays the automatic boot feature by issuing
111 a specific input key or string. If CONFIG_AUTOBOOT_DELAY_STR
112 or the environment variable "bootdelaykey" is specified
113 and this string is received from console input before
114 autoboot starts booting, U-Boot gives a command prompt. The
115 U-Boot prompt will time out if CONFIG_BOOT_RETRY_TIME is
116 used, otherwise it never times out.
118 config AUTOBOOT_STOP_STR
119 string "Stop autobooting via specific input key / string"
120 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
122 This option enables stopping (aborting) of the automatic
123 boot feature only by issuing a specific input key or
124 string. If CONFIG_AUTOBOOT_STOP_STR or the environment
125 variable "bootstopkey" is specified and this string is
126 received from console input before autoboot starts booting,
127 U-Boot gives a command prompt. The U-Boot prompt never
128 times out, even if CONFIG_BOOT_RETRY_TIME is used.
130 config AUTOBOOT_KEYED_CTRLC
131 bool "Enable Ctrl-C autoboot interruption"
132 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
135 This option allows for the boot sequence to be interrupted
136 by ctrl-c, in addition to the "bootdelaykey" and "bootstopkey".
137 Setting this variable provides an escape sequence from the
138 limited "password" strings.
140 config AUTOBOOT_STOP_STR_SHA256
141 string "Stop autobooting via SHA256 encrypted password"
142 depends on AUTOBOOT_KEYED && AUTOBOOT_ENCRYPTION
144 This option adds the feature to only stop the autobooting,
145 and therefore boot into the U-Boot prompt, when the input
146 string / password matches a values that is encypted via
147 a SHA256 hash and saved in the environment.
169 Print ".config" contents.
171 If this option is enabled, the ".config" file contents are embedded
172 in the U-Boot image and can be printed on the console by the "config"
173 command. This provides information of which options are enabled on
180 Print console devices and information.
185 Print information about available CPUs. This normally shows the
186 number of CPUs, type (e.g. manufacturer, architecture, product or
187 internal name) and clock frequency. Other information may be
188 available depending on the CPU driver.
194 Print GPL license text
210 Run the command stored in the environment "bootcmd", i.e.
211 "bootd" does the same thing as "run bootcmd".
217 Boot an application image from the memory.
222 Boot the Linux zImage
226 depends on ARM64 || RISCV
229 Boot an AArch64 Linux Kernel image from memory.
233 depends on EFI_LOADER
236 Boot an EFI image from memory.
238 config CMD_BOOTEFI_HELLO_COMPILE
239 bool "Compile a standard EFI hello world binary for testing"
240 depends on CMD_BOOTEFI && !CPU_V7M && !SANDBOX
243 This compiles a standard EFI hello world application with U-Boot so
244 that it can be used with the test/py testing framework. This is useful
245 for testing that EFI is working at a basic level, and for bringing
246 up EFI support on a new architecture.
248 No additional space will be required in the resulting U-Boot binary
249 when this option is enabled.
251 config CMD_BOOTEFI_HELLO
252 bool "Allow booting a standard EFI hello world for testing"
253 depends on CMD_BOOTEFI_HELLO_COMPILE
255 This adds a standard EFI hello world application to U-Boot so that
256 it can be used with the 'bootefi hello' command. This is useful
257 for testing that EFI is working at a basic level, and for bringing
258 up EFI support on a new architecture.
260 source lib/efi_selftest/Kconfig
266 Add an ANSI terminal boot menu command.
271 Android DTB/DTBO image manipulation commands. Read dtb/dtbo files from
272 image into RAM, dump image structure information, etc. Those dtb/dtbo
273 files should be merged in one dtb further, which needs to be passed to
274 the kernel, as part of a boot process.
277 bool "bootelf, bootvx"
280 Boot an ELF/vxWorks image from the memory.
283 bool "Flattened Device Tree utility commands"
287 Do FDT related setup before booting into the Operating System.
293 Start an application at a given address.
299 Run the command in the given environment variable.
305 Print header information for application image.
310 List all images found in flash
316 Extract a part of a multi-image.
319 bool "spl export - Export boot information for Falcon boot"
322 Falcon mode allows booting directly from SPL into an Operating
323 System such as Linux, thus skipping U-Boot proper. See
324 doc/README.falcon for full information about how to use this
327 config CMD_SPL_NAND_OFS
328 hex "Offset of OS command line args for Falcon-mode NAND boot"
330 depends on CMD_SPL && (TPL_NAND_SUPPORT || SPL_NAND_SUPPORT)
333 This provides the offset of the command line arguments for Linux
334 when booting from NAND in Falcon mode. See doc/README.falcon
335 for full information about how to use this option (and also see
336 board/gateworks/gw_ventana/README for an example).
338 config CMD_SPL_WRITE_SIZE
339 hex "Size of argument area"
343 This provides the size of the command-line argument area in NAND
344 flash used by Falcon-mode boot. See the documentation until CMD_SPL
348 bool "fitImage update command"
350 Implements the 'fitupd' command, which allows to automatically
351 store software updates present on a TFTP server in NOR Flash
353 config CMD_THOR_DOWNLOAD
354 bool "thor - TIZEN 'thor' download"
356 Implements the 'thor' download protocol. This is a way of
357 downloading a software update over USB from an attached host.
358 There is no documentation about this within the U-Boot source code
359 but you should be able to find something on the interwebs.
362 bool "zboot - x86 boot command"
364 With x86 machines it is common to boot a bzImage file which
365 contains both a kernel and a setup.bin file. The latter includes
366 configuration information from the dark ages which x86 boards still
367 need to pick things out of.
369 Consider using FIT in preference to this since it supports directly
370 booting both 32- and 64-bit kernels, as well as secure boot.
371 Documentation is available in doc/uImage.FIT/x86-fit-boot.txt
375 menu "Environment commands"
378 bool "ask for env variable"
380 Ask for environment variable
398 Edit environment variable.
403 Allow for searching environment variables
409 Save all environment variables into the compiled-in persistent
415 depends on CMD_SAVEENV
417 Erase environment variables from the compiled-in persistent
420 config CMD_ENV_EXISTS
424 Check if a variable is defined in the environment for use in
427 config CMD_ENV_CALLBACK
428 bool "env callbacks - print callbacks and their associated variables"
430 Some environment variable have callbacks defined by
431 U_BOOT_ENV_CALLBACK. These are called when the variable changes.
432 For example changing "baudrate" adjust the serial baud rate. This
433 command lists the currently defined callbacks.
436 bool "env flags -print variables that have non-default flags"
438 Some environment variables have special flags that control their
439 behaviour. For example, serial# can only be written once and cannot
440 be deleted. This command shows the variables that have special
443 config CMD_NVEDIT_EFI
444 bool "env [set|print] -e - set/print UEFI variables"
445 depends on EFI_LOADER
449 UEFI variables are encoded as some form of U-Boot variables.
450 If enabled, we are allowed to set/print UEFI variables using
451 "env" command with "-e" option without knowing details.
453 config CMD_NVEDIT_INFO
454 bool "env info - print or evaluate environment information"
456 Print environment information:
457 - env_valid : is environment valid
458 - env_ready : is environment imported into hash table
459 - env_use_default : is default environment used
461 This command can be optionally used for evaluation in scripts:
462 [-d] : evaluate whether default environment is used
463 [-p] : evaluate whether environment can be persisted
464 The result of multiple evaluations will be combined with AND.
468 menu "Memory commands"
473 Compute binary operations (xor, or, and) of byte arrays of arbitrary
474 size from memory and store the result in memory or the environment.
487 Add -v option to verify data against a crc32 checksum.
490 bool "eeprom - EEPROM subsystem"
492 (deprecated, needs conversion to driver model)
493 Provides commands to read and write EEPROM (Electrically Erasable
494 Programmable Read Only Memory) chips that are connected over an
497 config CMD_EEPROM_LAYOUT
498 bool "Enable layout-aware eeprom commands"
499 depends on CMD_EEPROM
501 (deprecated, needs conversion to driver model)
502 When enabled, additional eeprom sub-commands become available.
504 eeprom print - prints the contents of the eeprom in a human-readable
505 way (eeprom layout fields, and data formatted to be fit for human
508 eeprom update - allows user to update eeprom fields by specifying
509 the field name, and providing the new data in a human readable format
510 (same format as displayed by the eeprom print command).
512 Both commands can either auto detect the layout, or be told which
516 __weak int parse_layout_version(char *str)
517 - override to provide your own layout name parsing
518 __weak void __eeprom_layout_assign(struct eeprom_layout *layout,
520 - override to setup the layout metadata based on the version
521 __weak int eeprom_layout_detect(unsigned char *data)
522 - override to provide your own algorithm for detecting layout
525 - contains various printing and updating functions for common
526 types of eeprom fields. Can be used for defining
529 config EEPROM_LAYOUT_HELP_STRING
530 string "Tells user what layout names are supported"
531 depends on CMD_EEPROM_LAYOUT
532 default "<not defined>"
534 Help printed with the LAYOUT VERSIONS part of the 'eeprom'
540 Infinite write loop on address range
547 Compute MD5 checksum.
552 depends on CMD_MD5SUM
554 Add -v option to verify data against an MD5 checksum.
559 Display memory information.
562 bool "md, mm, nm, mw, cp, cmp, base, loop"
567 mm - memory modify (auto-incrementing address)
568 nm - memory modify (constant address)
569 mw - memory write (fill)
572 base - print or set address offset
573 loop - initialize loop on address range
578 depends on CMD_MEMORY && (LIB_RAND || LIB_HW_RAND)
580 random - fill memory with random data
585 Simple RAM read/write test.
589 config SYS_ALT_MEMTEST
590 bool "Alternative test"
592 Use a more complete alternative memory test.
599 mdc - memory display cyclic
600 mwc - memory write cyclic
606 Compute SHA1 checksum.
608 config SHA1SUM_VERIFY
610 depends on CMD_SHA1SUM
612 Add -v option to verify data against a SHA1 checksum.
615 bool "strings - display strings in memory"
617 This works similarly to the Unix 'strings' command except that it
618 works with a memory range. String of printable characters found
619 within the range are displayed. The minimum number of characters
620 for a sequence to be considered a string can be provided.
624 menu "Compression commands"
628 default y if CMD_BOOTI
631 Support decompressing an LZMA (Lempel-Ziv-Markov chain algorithm)
636 default y if CMD_BOOTI
638 Uncompress a zip-compressed memory region.
643 Compress a memory region with zlib deflate method.
647 menu "Device access commands"
650 #depends on FLASH_CFI_DRIVER
653 ARM Ltd reference designs flash partition access
656 bool "adc - Access Analog to Digital Converters info and data"
660 Shows ADC device info and permit printing one-shot analog converted
661 data from a named Analog to Digital Converter.
666 depends on PARTITIONS
668 Read/modify/write the fields of Bootloader Control Block, usually
669 stored on the flash "misc" partition with its structure defined in:
670 https://android.googlesource.com/platform/bootable/recovery/+/master/
671 bootloader_message/include/bootloader_message/bootloader_message.h
673 Some real-life use-cases include (but are not limited to):
674 - Determine the "boot reason" (and act accordingly):
675 https://source.android.com/devices/bootloader/boot-reason
676 - Get/pass a list of commands from/to recovery:
677 https://android.googlesource.com/platform/bootable/recovery
678 - Inspect/dump the contents of the BCB fields
681 bool "bind/unbind - Bind or unbind a device to/from a driver"
684 Bind or unbind a device to/from a driver from the command line.
685 This is useful in situations where a device may be handled by several
686 drivers. For example, this can be used to bind a UDC to the usb ether
687 gadget driver from the command line.
690 bool "clk - Show clock frequencies"
693 Shows clock frequences by calling a sock_clk_dump() hook function.
694 This is depreated in favour of using the CLK uclass and accessing
695 clock values from associated drivers. However currently no command
699 bool "demo - Demonstration commands for driver model"
702 Provides a 'demo' command which can be used to play around with
703 driver model. To use this properly you will need to enable one or
704 both of the demo devices (DM_DEMO_SHAPE and DM_DEMO_SIMPLE).
705 Otherwise you will always get an empty list of devices. The demo
706 devices are defined in the sandbox device tree, so the easiest
707 option is to use sandbox and pass the -d point to sandbox's
714 Enables the command "dfu" which is used to have U-Boot create a DFU
715 class device via USB. This command requires that the "dfu_alt_info"
716 environment variable be set and define the alt settings to expose to
720 bool "dm - Access to driver model information"
723 Provides access to driver model data structures and information,
724 such as a list of devices, list of uclasses and the state of each
725 device (e.g. activated). This is not required for operation, but
726 can be useful to see the state of driver model for debugging or
730 bool "fastboot - Android fastboot support"
733 This enables the command "fastboot" which enables the Android
734 fastboot mode for the platform. Fastboot is a protocol for
735 downloading images, flashing and device control used on
736 Android devices. Fastboot requires either the network stack
737 enabled or support for acting as a USB device.
739 See doc/README.android-fastboot for more information.
742 bool "fdcboot - Boot from floppy device"
744 The 'fdtboot' command allows booting an image from a floppy disk.
747 bool "flinfo, erase, protect"
751 flinfo - print FLASH memory information
753 protect - enable or disable FLASH write protection
762 config CMD_FPGA_LOADBP
763 bool "fpga loadbp - load partial bitstream (Xilinx only)"
766 Supports loading an FPGA device from a bitstream buffer containing
769 config CMD_FPGA_LOADFS
770 bool "fpga loadfs - load bitstream from FAT filesystem (Xilinx only)"
773 Supports loading an FPGA device from a FAT filesystem.
775 config CMD_FPGA_LOADMK
776 bool "fpga loadmk - load bitstream from image"
779 Supports loading an FPGA device from a image generated by mkimage.
781 config CMD_FPGA_LOADP
782 bool "fpga loadp - load partial bitstream"
785 Supports loading an FPGA device from a bitstream buffer containing
788 config CMD_FPGA_LOAD_SECURE
789 bool "fpga loads - loads secure bitstreams (Xilinx only)"
792 Enables the fpga loads command which is used to load secure
793 (authenticated or encrypted or both) bitstreams on to FPGA.
796 bool "fpgad - dump FPGA registers"
798 (legacy, needs conversion to driver model)
799 Provides a way to dump FPGA registers by calling the board-specific
800 fpga_get_reg() function. This functions similarly to the 'md'
804 bool "fuse - support for the fuse subssystem"
806 (deprecated - needs conversion to driver model)
807 This allows reading, sensing, programming or overriding fuses
808 which control the behaviour of the device. The command uses the
817 bool "GPT (GUID Partition Table) command"
819 select HAVE_BLOCK_DEVICE
820 select PARTITION_UUIDS
823 Enable the 'gpt' command to ready and write GPT style partition
827 bool "GPT Random UUID generation"
830 Enable the generation of partitions with random UUIDs if none
833 config CMD_GPT_RENAME
834 bool "GPT partition renaming commands"
837 Enables the 'gpt' command to interchange names on two GPT
838 partitions via the 'gpt swap' command or to rename single
839 partitions via the 'rename' command.
842 bool "ide - Support for IDE drivers"
845 Provides an 'ide' command which allows accessing the IDE drive,
846 reseting the IDE interface, printing the partition table and
847 geting device info. It also enables the 'diskboot' command which
848 permits booting from an IDE drive.
851 bool "io - Support for performing I/O accesses"
853 Provides an 'iod' command to display I/O space and an 'iow' command
854 to write values to the I/O space. This can be useful for manually
855 checking the state of devices during boot when debugging device
859 bool "iotrace - Support for tracing I/O activity"
861 Provides an 'iotrace' command which supports recording I/O reads and
862 writes in a trace buffer in memory . It also maintains a checksum
863 of the trace records (even if space is exhausted) so that the
864 sequence of I/O accesses can be verified.
866 When debugging drivers it is useful to see what I/O accesses were
867 done and in what order.
869 Even if the individual accesses are of little interest it can be
870 useful to verify that the access pattern is consistent each time
871 an operation is performed. In this case a checksum can be used to
872 characterise the operation of a driver. The checksum can be compared
873 across different runs of the operation to verify that the driver is
876 In particular, when performing major refactoring of the driver, where
877 the access pattern should not change, the checksum provides assurance
878 that the refactoring work has not broken the driver.
880 This works by sneaking into the io.h heder for an architecture and
881 redirecting I/O accesses through iotrace's tracing mechanism.
883 For now no commands are provided to examine the trace buffer. The
884 format is fairly simple, so 'md' is a reasonable substitute.
886 Note: The checksum feature is only useful for I/O regions where the
887 contents do not change outside of software control. Where this is not
888 suitable you can fall back to manually comparing the addresses. It
889 might be useful to enhance tracing to only checksum the accesses and
890 not the data read/written.
900 bool "w1 - Support for Dallas 1-Wire protocol"
902 Dallas 1-wire protocol support
908 Load a binary file over serial line.
914 Load an S-Record file over serial line
919 MMC memory mapped support.
922 bool "Enable support for RPMB in the mmc command"
925 Enable the commands for reading, writing and programming the
926 key for the Replay Protection Memory Block partition in eMMC.
928 config CMD_MMC_SWRITE
930 depends on CMD_MMC && MMC_WRITE
933 Enable support for the "mmc swrite" command to write Android sparse
938 select MTD_PARTITIONS
940 MTD commands support.
944 default y if NAND_SUNXI
949 config CMD_NAND_TRIMFFS
950 bool "nand write.trimffs"
951 default y if ARCH_SUNXI
953 Allows one to skip empty pages when flashing something on a NAND.
955 config CMD_NAND_LOCK_UNLOCK
956 bool "nand lock/unlock"
958 NAND locking support.
960 config CMD_NAND_TORTURE
963 NAND torture support.
972 NVM Express device support
975 bool "onenand - access to onenand device"
977 OneNAND is a brand of NAND ('Not AND' gate) flash which provides
978 various useful features. This command allows reading, writing,
979 and erasing blocks. It allso provides a way to show and change
980 bad blocks, and test the device.
985 Enable the 'osd' command which allows to query information from and
986 write text data to a on-screen display (OSD) device; a virtual device
987 associated with a display capable of displaying a text overlay on the
988 display it's associated with..
992 select HAVE_BLOCK_DEVICE
993 select PARTITION_UUIDS
995 Read and display information about the partition table on
999 bool "pci - Access PCI devices"
1001 Provide access to PCI (Peripheral Interconnect Bus), a type of bus
1002 used on some devices to allow the CPU to communicate with its
1003 peripherals. Sub-commands allow bus enumeration, displaying and
1004 changing configuration space and a few other features.
1007 bool "pinit - Set up PCMCIA device"
1009 Provides a means to initialise a PCMCIA (Personal Computer Memory
1010 Card International Association) device. This is an old standard from
1011 about 1990. These devices are typically removable memory or network
1012 cards using a standard 68-pin connector.
1015 bool "pinmux - show pins muxing"
1016 default y if PINCTRL
1018 Parse all available pin-controllers and show pins muxing. This
1019 is useful for debug purpoer to check the pin muxing and to know if
1020 a pin is configured as a GPIO or as an alternate function.
1025 Poweroff/Shutdown the system
1028 bool "read - Read binary data from a partition"
1030 Provides low-level access to the data in a partition.
1032 config CMD_REMOTEPROC
1034 depends on REMOTEPROC
1036 Support for Remote Processor control
1039 bool "sata - Access SATA subsystem"
1042 SATA (Serial Advanced Technology Attachment) is a serial bus
1043 standard for connecting to hard drives and other storage devices.
1044 This command provides information about attached devices and allows
1045 reading, writing and other operations.
1047 SATA replaces PATA (originally just ATA), which stands for Parallel AT
1048 Attachment, where AT refers to an IBM AT (Advanced Technology)
1049 computer released in 1984.
1052 bool "saves - Save a file over serial in S-Record format"
1054 Provides a way to save a binary file using the Motorola S-Record
1055 format over the serial line.
1058 bool "scsi - Access to SCSI devices"
1061 This provides a 'scsi' command which provides access to SCSI (Small
1062 Computer System Interface) devices. The command provides a way to
1063 scan the bus, reset the bus, read and write data and get information
1067 bool "sdram - Print SDRAM configuration information"
1069 Provides information about attached SDRAM. This assumed that the
1070 SDRAM has an EEPROM with information that can be read using the
1071 I2C bus. This is only available on some boards.
1075 depends on DM_SPI_FLASH || SPI_FLASH
1080 bool "sf test - Allow testing of SPI flash"
1083 Provides a way to test that SPI flash is working correctly. The
1084 test is destructive, in that an area of SPI flash must be provided
1085 for the test to use. Performance information is also provided,
1086 measuring the performance of reading, writing and erasing in
1087 Mbps (Million Bits Per Second). This value should approximately
1088 equal the SPI bus speed for a single-bit-wide SPI bus, assuming
1089 everything is working properly.
1092 bool "sspi - Command to access spi device"
1095 SPI utility command.
1097 config DEFAULT_SPI_BUS
1098 int "default spi bus used by sspi command"
1102 config DEFAULT_SPI_MODE
1103 hex "default spi mode used by sspi command (see include/spi.h)"
1108 bool "tsi148 - Command to access tsi148 device"
1110 This provides various sub-commands to initialise and configure the
1111 Turndra tsi148 device. See the command help for full details.
1114 bool "universe - Command to set up the Turndra Universe controller"
1116 This allows setting up the VMEbus provided by this controller.
1117 See the command help for full details.
1121 select HAVE_BLOCK_DEVICE
1127 select USB_FUNCTION_SDP
1129 Enables the command "sdp" which is used to have U-Boot emulating the
1130 Serial Download Protocol (SDP) via USB.
1134 depends on USB_FUNCTION_ROCKUSB
1136 Rockusb protocol is widely used by Rockchip SoC based devices. It can
1137 read/write info, image to/from devices. This enable rockusb command
1138 support to communication with rockusb device. for more detail about
1139 this command, please read doc/README.rockusb.
1141 config CMD_USB_MASS_STORAGE
1142 bool "UMS usb mass storage"
1143 select USB_FUNCTION_MASS_STORAGE
1145 USB mass storage support
1152 VirtIO block device support
1158 This provides commands to control the watchdog timer devices.
1164 Enable the command "axi" for accessing AXI (Advanced eXtensible
1165 Interface) busses, a on-chip interconnect specification for managing
1166 functional blocks in SoC designs, which is also often used in designs
1167 involving FPGAs (e.g. communication with IP cores in Xilinx FPGAs).
1171 menu "Shell scripting commands"
1177 Echo args to console
1183 Return true/false on integer compare.
1189 Run script from memory
1195 Evaluate boolean and math expressions and store the result in an env
1197 Also supports loading the value at a memory location into a variable.
1198 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
1205 bool "Network commands"
1215 bootp - boot image via network using BOOTP/TFTP protocol
1219 depends on CMD_BOOTP
1221 Boot image via network using DHCP/TFTP protocol
1223 config BOOTP_BOOTPATH
1224 bool "Request & store 'rootpath' from BOOTP/DHCP server"
1226 depends on CMD_BOOTP
1228 Even though the config is called BOOTP_BOOTPATH, it stores the
1229 path in the variable 'rootpath'.
1232 bool "Request & store 'dnsip' from BOOTP/DHCP server"
1234 depends on CMD_BOOTP
1236 The primary DNS server is stored as 'dnsip'. If two servers are
1237 returned, you must set BOOTP_DNS2 to store that second server IP
1241 bool "Store 'dnsip2' from BOOTP/DHCP server"
1242 depends on BOOTP_DNS
1244 If a DHCP client requests the DNS server IP from a DHCP server,
1245 it is possible that more than one DNS serverip is offered to the
1246 client. If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1247 server IP will be stored in the additional environment
1248 variable "dnsip2". The first DNS serverip is always
1249 stored in the variable "dnsip", when BOOTP_DNS is defined.
1251 config BOOTP_GATEWAY
1252 bool "Request & store 'gatewayip' from BOOTP/DHCP server"
1254 depends on CMD_BOOTP
1256 config BOOTP_HOSTNAME
1257 bool "Request & store 'hostname' from BOOTP/DHCP server"
1259 depends on CMD_BOOTP
1261 The name may or may not be qualified with the local domain name.
1263 config BOOTP_PREFER_SERVERIP
1264 bool "serverip variable takes precedent over DHCP server IP."
1265 depends on CMD_BOOTP
1267 By default a BOOTP/DHCP reply will overwrite the 'serverip' variable.
1269 With this option enabled, the 'serverip' variable in the environment
1270 takes precedence over DHCP server IP and will only be set by the DHCP
1271 server if not already set in the environment.
1273 config BOOTP_SUBNETMASK
1274 bool "Request & store 'netmask' from BOOTP/DHCP server"
1276 depends on CMD_BOOTP
1278 config BOOTP_NTPSERVER
1279 bool "Request & store 'ntpserverip' from BOOTP/DHCP server"
1280 depends on CMD_BOOTP
1283 bool "Send PXE client arch to BOOTP/DHCP server"
1285 depends on CMD_BOOTP && CMD_PXE
1287 Supported for ARM, ARM64, and x86 for now.
1289 config BOOTP_PXE_CLIENTARCH
1291 depends on BOOTP_PXE
1292 default 0x16 if ARM64
1296 config BOOTP_VCI_STRING
1298 depends on CMD_BOOTP
1299 default "U-Boot.armv7" if CPU_V7A || CPU_V7M || CPU_V7R
1300 default "U-Boot.armv8" if ARM64
1301 default "U-Boot.arm" if ARM
1308 tftpboot - boot image via network using TFTP protocol
1312 depends on CMD_TFTPBOOT
1314 TFTP put command, for uploading files to a server
1318 depends on CMD_TFTPBOOT
1320 Act as a TFTP server and boot the first received file
1322 config NET_TFTP_VARS
1323 bool "Control TFTP timeout and count through environment"
1324 depends on CMD_TFTPBOOT
1327 If set, allows controlling the TFTP timeout through the
1328 environment variable tftptimeout, and the TFTP maximum
1329 timeout count through the variable tftptimeoutcountmax.
1330 If unset, timeout and maximum are hard-defined as 1 second
1331 and 10 timouts per TFTP transfer.
1336 Boot image via network using RARP/TFTP protocol
1342 Boot image via network using NFS protocol.
1347 Enable MII utility commands.
1352 Send ICMP ECHO_REQUEST to network host
1357 Perform CDP network configuration
1362 Synchronize RTC via network
1367 Lookup the IP of a hostname
1369 config CMD_LINK_LOCAL
1373 Acquire a network IP address using the link-local protocol
1380 Allow control of L2 Ethernet switch commands. These are supported
1381 by the vsc9953 Ethernet driver at present. Sub-commands allow
1382 operations such as enabling / disabling a port and
1383 viewing/maintaining the filtering database (FDB)
1389 Boot image via network using PXE protocol
1394 Wait for wake-on-lan Magic Packet
1398 menu "Misc commands"
1401 bool "Enable 'bmp' command"
1402 depends on LCD || DM_VIDEO || VIDEO
1404 This provides a way to obtain information about a BMP-format iamge
1405 and to display it. BMP (which presumably stands for BitMaP) is a
1406 file format defined by Microsoft which supports images of various
1407 depths, formats and compression methods. Headers on the file
1408 determine the formats used. This command can be used by first loading
1409 the image into RAM, then using this command to look at it or display
1412 config CMD_BOOTCOUNT
1414 depends on BOOTCOUNT_LIMIT
1416 Enable the bootcount command, which allows interrogation and
1417 reset of the bootcounter.
1420 bool "Enable board-specific commands"
1422 (deprecated: instead, please define a Kconfig option for each command)
1424 Some boards have board-specific commands which are only enabled
1425 during developemnt and need to be turned off for production. This
1426 option provides a way to control this. The commands that are enabled
1427 vary depending on the board.
1429 config CMD_BKOPS_ENABLE
1430 bool "mmc bkops enable"
1434 Enable command for setting manual background operations handshake
1435 on a eMMC device. The feature is optionally available on eMMC devices
1436 conforming to standard >= 4.41.
1438 config CMD_BLOCK_CACHE
1439 bool "blkcache - control and stats for block cache"
1440 depends on BLOCK_CACHE
1441 default y if BLOCK_CACHE
1443 Enable the blkcache command, which can be used to control the
1444 operation of the cache functions.
1445 This is most useful when fine-tuning the operation of the cache
1446 during development, but also allows the cache to be disabled when
1447 it might hurt performance (e.g. when using the ums command).
1450 bool "icache or dcache"
1452 Enable the "icache" and "dcache" commands
1454 config CMD_CONITRACE
1455 bool "conitrace - trace console input codes"
1457 Enable the 'conitrace' command which displays the codes received
1458 from the console input as hexadecimal numbers.
1461 bool "Enable clear screen command 'cls'"
1462 depends on CFB_CONSOLE || DM_VIDEO || LCD || VIDEO
1465 Enable the 'cls' command which clears the screen contents
1466 on video frame buffer.
1469 bool "efidebug - display/configure UEFI environment"
1470 depends on EFI_LOADER
1471 select EFI_DEVICE_PATH_TO_TEXT
1474 Enable the 'efidebug' command which provides a subset of UEFI
1475 shell utility with simplified functionality. It will be useful
1476 particularly for managing boot parameters as well as examining
1477 various EFI status for debugging.
1479 config CMD_EXCEPTION
1480 bool "exception - raise exception"
1481 depends on ARM || RISCV || X86
1483 Enable the 'exception' command which allows to raise an exception.
1490 Enable the 'led' command which allows for control of LEDs supported
1491 by the board. The LEDs can be listed with 'led list' and controlled
1492 with led on/off/togle/blink. Any LED drivers can be controlled with
1493 this command, e.g. led_gpio.
1499 Enable the 'date' command for getting/setting the time/date in RTC
1505 Run commands and summarize execution time.
1508 bool "gettime - read elapsed time"
1510 Enable the 'gettime' command which reads the elapsed time since
1511 U-Boot started running. This shows the time in seconds and
1512 milliseconds. See also the 'bootstage' command which provides more
1513 flexibility for boot timing.
1515 # TODO: rename to CMD_SLEEP
1520 Delay execution for some time
1523 bool "support for multiprocessor"
1525 This provides an option to brinup
1526 different processors in multiprocessor
1532 Access the system timer.
1538 This provides basic access to the U-Boot's sound support. The main
1539 feature is to play a beep.
1541 sound init - set up sound system
1542 sound play - play a sound
1548 This provides access to the QEMU firmware interface. The main
1549 feature is to allow easy loading of files passed to qemu-system
1550 via -kernel / -initrd
1552 source "cmd/mvebu/Kconfig"
1555 bool "terminal - provides a way to attach a serial terminal"
1557 Provides a 'cu'-like serial terminal command. This can be used to
1558 access other serial ports from the system console. The terminal
1559 is very simple with no special processing of characters. As with
1560 cu, you can press ~. (tilde followed by period) to exit.
1563 bool "uuid, guid - generation of unique IDs"
1566 This enables two commands:
1568 uuid - generate random Universally Unique Identifier
1569 guid - generate Globally Unique Identifier based on random UUID
1571 The two commands are very similar except for the endianness of the
1576 source "cmd/ti/Kconfig"
1578 config CMD_BOOTSTAGE
1579 bool "Enable the 'bootstage' command"
1580 depends on BOOTSTAGE
1582 Add a 'bootstage' command which supports printing a report
1583 and un/stashing of bootstage data.
1585 menu "Power commands"
1587 bool "Enable Driver Model PMIC command"
1590 This is the pmic command, based on a driver model pmic's API.
1591 Command features are unchanged:
1592 - list - list pmic devices
1593 - pmic dev <id> - show or [set] operating pmic device (NEW)
1594 - pmic dump - dump registers
1595 - pmic read address - read byte of register at address
1596 - pmic write address - write byte to register at address
1597 The only one change for this command is 'dev' subcommand.
1599 config CMD_REGULATOR
1600 bool "Enable Driver Model REGULATOR command"
1601 depends on DM_REGULATOR
1603 This command is based on driver model regulator's API.
1604 User interface features:
1605 - list - list regulator devices
1606 - regulator dev <id> - show or [set] operating regulator device
1607 - regulator info - print constraints info
1608 - regulator status - print operating status
1609 - regulator value <val] <-f> - print/[set] voltage value [uV]
1610 - regulator current <val> - print/[set] current value [uA]
1611 - regulator mode <id> - print/[set] operating mode id
1612 - regulator enable - enable the regulator output
1613 - regulator disable - disable the regulator output
1615 The '-f' (force) option can be used for set the value which exceeds
1616 the limits, which are found in device-tree and are kept in regulator's
1617 uclass platdata structure.
1621 menu "Security commands"
1623 bool "Enable the 'aes' command"
1626 This provides a means to encrypt and decrypt data using the AES
1627 (Advanced Encryption Standard). This algorithm uses a symetric key
1628 and is widely used as a streaming cipher. Different key lengths are
1629 supported by the algorithm but this command only supports 128 bits
1633 bool "Enable the 'blob' command"
1635 This is used with the Freescale secure boot mechanism.
1637 Freescale's SEC block has built-in Blob Protocol which provides
1638 a method for protecting user-defined data across system power
1639 cycles. SEC block protects data in a data structure called a Blob,
1640 which provides both confidentiality and integrity protection.
1642 Encapsulating data as a blob
1643 Each time that the Blob Protocol is used to protect data, a
1644 different randomly generated key is used to encrypt the data.
1645 This random key is itself encrypted using a key which is derived
1646 from SoC's non-volatile secret key and a 16 bit Key identifier.
1647 The resulting encrypted key along with encrypted data is called a
1648 blob. The non-volatile secure key is available for use only during
1651 During decapsulation, the reverse process is performed to get back
1655 blob enc - encapsulating data as a cryptgraphic blob
1656 blob dec - decapsulating cryptgraphic blob to get the data
1660 blob enc src dst len km
1662 Encapsulate and create blob of data $len bytes long
1663 at address $src and store the result at address $dst.
1664 $km is the 16 byte key modifier is also required for
1665 generation/use as key for cryptographic operation. Key
1666 modifier should be 16 byte long.
1668 blob dec src dst len km
1670 Decapsulate the blob of data at address $src and
1671 store result of $len byte at addr $dst.
1672 $km is the 16 byte key modifier is also required for
1673 generation/use as key for cryptographic operation. Key
1674 modifier should be 16 byte long.
1677 bool "Support 'hash' command"
1680 This provides a way to hash data in memory using various supported
1681 algorithms (such as SHA1, MD5, CRC32). The computed digest can be
1682 saved to memory or to an environment variable. It is also possible
1683 to verify a hash against data in memory.
1686 bool "Support the 'hvc' command"
1687 depends on ARM_SMCCC
1689 Allows issuing Hypervisor Calls (HVCs). Mostly useful for
1690 development and testing.
1693 bool "Support the 'smc' command"
1694 depends on ARM_SMCCC
1696 Allows issuing Secure Monitor Calls (SMCs). Mostly useful for
1697 development and testing.
1703 Add -v option to verify data against a hash.
1713 bool "Enable the 'tpm' command"
1714 depends on TPM_V1 || TPM_V2
1715 select CMD_TPM_V1 if TPM_V1
1716 select CMD_TPM_V2 if TPM_V2
1718 This provides a means to talk to a TPM from the command line. A wide
1719 range of commands if provided - see 'tpm help' for details. The
1720 command requires a suitable TPM on your board and the correct driver
1726 bool "Enable the 'tpm test' command"
1729 This provides a a series of tests to confirm that the TPMv1.x is
1730 working correctly. The tests cover initialisation, non-volatile RAM,
1731 extend, global lock and checking that timing is within expectations.
1732 The tests pass correctly on Infineon TPMs but may need to be adjusted
1739 menu "Firmware commands"
1741 bool "Enable crosec command"
1745 Enable command-line access to the Chrome OS EC (Embedded
1746 Controller). This provides the 'crosec' command which has
1747 a number of sub-commands for performing EC tasks such as
1748 updating its flash, accessing a small saved context area
1749 and talking to the I2C bus behind the EC (if there is one).
1752 menu "Filesystem commands"
1754 bool "Enable the 'btrsubvol' command"
1757 This enables the 'btrsubvol' command to list subvolumes
1758 of a BTRFS filesystem. There are no special commands for
1759 listing BTRFS directories or loading BTRFS files - this
1760 can be done by the generic 'fs' commands (see CMD_FS_GENERIC)
1761 when BTRFS is enabled (see FS_BTRFS).
1764 bool "Enable the 'cbfs' command"
1767 Define this to enable support for reading from a Coreboot
1768 filesystem. This is a ROM-based filesystem used for accessing files
1769 on systems that use coreboot as the first boot-loader and then load
1770 U-Boot to actually boot the Operating System. Available commands are
1771 cbfsinit, cbfsinfo, cbfsls and cbfsload.
1774 bool "Enable the 'cramfs' command"
1775 depends on FS_CRAMFS
1777 This provides commands for dealing with CRAMFS (Compressed ROM
1778 filesystem). CRAMFS is useful when space is tight since files are
1779 compressed. Two commands are provided:
1781 cramfsls - lists files in a cramfs image
1782 cramfsload - loads a file from a cramfs image
1785 bool "ext2 command support"
1788 Enables EXT2 FS command
1791 bool "ext4 command support"
1794 Enables EXT4 FS command
1796 config CMD_EXT4_WRITE
1798 bool "ext4 write command support"
1801 Enables EXT4 FS write command
1804 bool "FAT command support"
1807 Support for the FAT fs
1809 config CMD_FS_GENERIC
1810 bool "filesystem commands"
1812 Enables filesystem commands (e.g. load, ls) that work for multiple
1816 bool "fsuuid command"
1818 Enables fsuuid command for filesystem UUID.
1821 bool "jffs2 command"
1824 Enables commands to support the JFFS2 (Journalling Flash File System
1825 version 2) filesystem. This enables fsload, ls and fsinfo which
1826 provide the ability to load files, list directories and obtain
1827 filesystem information.
1830 bool "MTD partition support"
1831 select MTD_DEVICE if (CMD_NAND || NAND)
1833 MTD partitioning tool support.
1834 It is strongly encouraged to avoid using this command
1835 anymore along with 'sf', 'nand', 'onenand'. One can still
1836 declare the partitions in the mtdparts environment variable
1837 but better use the MTD stack and the 'mtd' command instead.
1839 config MTDIDS_DEFAULT
1840 string "Default MTD IDs"
1841 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1843 Defines a default MTD IDs list for use with MTD partitions in the
1844 Linux MTD command line partitions format.
1846 config MTDPARTS_DEFAULT
1847 string "Default MTD partition scheme"
1848 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1850 Defines a default MTD partitioning scheme in the Linux MTD command
1851 line partitions format
1853 config CMD_MTDPARTS_SPREAD
1854 bool "Padd partition size to take account of bad blocks"
1855 depends on CMD_MTDPARTS
1857 This enables the 'spread' sub-command of the mtdparts command.
1858 This command will modify the existing mtdparts variable by increasing
1859 the size of the partitions such that 1) each partition's net size is
1860 at least as large as the size specified in the mtdparts variable and
1861 2) each partition starts on a good block.
1864 bool "reiser - Access to reiserfs filesystems"
1866 This provides two commands which operate on a resierfs filesystem,
1867 commonly used some years ago:
1869 reiserls - list files
1870 reiserload - load a file
1873 bool "yaffs2 - Access of YAFFS2 filesystem"
1877 This provides commands for accessing a YAFFS2 filesystem. Yet
1878 Another Flash Filesystem 2 is a filesystem designed specifically
1879 for NAND flash. It incorporates bad-block management and ensures
1880 that device writes are sequential regardless of filesystem
1884 bool "zfs - Access of ZFS filesystem"
1886 This provides commands to accessing a ZFS filesystem, commonly used
1887 on Solaris systems. Two sub-commands are provided:
1889 zfsls - list files in a directory
1890 zfsload - load a file
1892 See doc/README.zfs for more details.
1896 menu "Debug commands"
1901 The bedbug (emBEDded deBUGger) command provides debugging features
1902 for some PowerPC processors. For details please see the
1903 docuemntation in doc/README.beddbug
1906 bool "diag - Board diagnostics"
1908 This command provides access to board diagnostic tests. These are
1909 called Power-on Self Tests (POST). The command allows listing of
1910 available tests and running either all the tests, or specific tests
1914 bool "irq - Show information about interrupts"
1915 depends on !ARM && !MIPS && !SH
1917 This enables two commands:
1919 interrupts - enable or disable interrupts
1920 irqinfo - print device-specific interrupt information
1923 bool "kgdb - Allow debugging of U-Boot with gdb"
1926 This enables a 'kgdb' command which allows gdb to connect to U-Boot
1927 over a serial link for debugging purposes. This allows
1928 single-stepping, inspecting variables, etc. This is supported only
1929 on PowerPC at present.
1932 bool "log - Generation, control and access to logging"
1935 This provides access to logging features. It allows the output of
1936 log data to be controlled to a limited extent (setting up the default
1937 maximum log level for emitting of records). It also provides access
1938 to a command used for testing the log system.
1941 bool "trace - Support tracing of function calls and timing"
1943 Enables a command to control using of function tracing within
1944 U-Boot. This allows recording of call traces including timing
1945 information. The command can write data to memory for exporting
1946 for analysis (e.g. using bootchart). See doc/README.trace for full
1950 bool "avb - Android Verified Boot 2.0 operations"
1951 depends on AVB_VERIFY
1954 Enables a "avb" command to perform verification of partitions using
1955 Android Verified Boot 2.0 functionality. It includes such subcommands:
1956 avb init - initialize avb2 subsystem
1957 avb read_rb - read rollback index
1958 avb write_rb - write rollback index
1959 avb is_unlocked - check device lock state
1960 avb get_uuid - read and print uuid of a partition
1961 avb read_part - read data from partition
1962 avb read_part_hex - read data from partition and output to stdout
1963 avb write_part - write data to partition
1964 avb verify - run full verification chain
1968 tristate "Enable UBI - Unsorted block images commands"
1971 UBI is a software layer above MTD layer which admits use of LVM-like
1972 logical volumes on top of MTD devices, hides some complexities of
1973 flash chips like wear and bad blocks and provides some other useful
1974 capabilities. Please, consult the MTD web site for more details
1975 (www.linux-mtd.infradead.org). Activate this option if you want
1976 to use U-Boot UBI commands.
1977 It is also strongly encouraged to also enable CONFIG_MTD to get full
1981 tristate "Enable UBIFS - Unsorted block images filesystem commands"
1983 default y if CMD_UBI
1986 UBIFS is a file system for flash devices which works on top of UBI.
projects / oweals / u-boot.git / blob