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
105 This option allows a string to be entered into U-Boot to stop the
106 autoboot. The string itself is hashed and compared against the hash
107 in the environment variable 'bootstopkeysha256'. If it matches then
108 boot stops and a command-line prompt is presented.
110 This provides a way to ship a secure production device which can also
111 be accessed at the U-Boot command line.
113 config AUTOBOOT_DELAY_STR
114 string "Delay autobooting via specific input key / string"
115 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
117 This option delays the automatic boot feature by issuing
118 a specific input key or string. If CONFIG_AUTOBOOT_DELAY_STR
119 or the environment variable "bootdelaykey" is specified
120 and this string is received from console input before
121 autoboot starts booting, U-Boot gives a command prompt. The
122 U-Boot prompt will time out if CONFIG_BOOT_RETRY_TIME is
123 used, otherwise it never times out.
125 config AUTOBOOT_STOP_STR
126 string "Stop autobooting via specific input key / string"
127 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
129 This option enables stopping (aborting) of the automatic
130 boot feature only by issuing a specific input key or
131 string. If CONFIG_AUTOBOOT_STOP_STR or the environment
132 variable "bootstopkey" is specified and this string is
133 received from console input before autoboot starts booting,
134 U-Boot gives a command prompt. The U-Boot prompt never
135 times out, even if CONFIG_BOOT_RETRY_TIME is used.
137 config AUTOBOOT_KEYED_CTRLC
138 bool "Enable Ctrl-C autoboot interruption"
139 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
142 This option allows for the boot sequence to be interrupted
143 by ctrl-c, in addition to the "bootdelaykey" and "bootstopkey".
144 Setting this variable provides an escape sequence from the
145 limited "password" strings.
147 config AUTOBOOT_STOP_STR_SHA256
148 string "Stop autobooting via SHA256 encrypted password"
149 depends on AUTOBOOT_KEYED && AUTOBOOT_ENCRYPTION
151 This option adds the feature to only stop the autobooting,
152 and therefore boot into the U-Boot prompt, when the input
153 string / password matches a values that is encypted via
154 a SHA256 hash and saved in the environment.
156 config AUTOBOOT_USE_MENUKEY
157 bool "Allow a specify key to run a menu from the environment"
158 depends on !AUTOBOOT_KEYED
160 If a specific key is pressed to stop autoboot, then the commands in
161 the environment variable 'menucmd' are executed before boot starts.
163 config AUTOBOOT_MENUKEY
164 int "ASCII value of boot key to show a menu"
166 depends on AUTOBOOT_USE_MENUKEY
168 If this key is pressed to stop autoboot, then the commands in the
169 environment variable 'menucmd' will be executed before boot starts.
170 For example, 33 means "!" in ASCII, so pressing ! at boot would take
173 config AUTOBOOT_MENU_SHOW
174 bool "Show a menu on boot"
176 This enables the boot menu, controlled by environment variables
177 defined by the board. The menu starts after running the 'preboot'
178 environmnent variable (if enabled) and before handling the boot delay.
179 See README.bootmenu for more details.
201 Print ".config" contents.
203 If this option is enabled, the ".config" file contents are embedded
204 in the U-Boot image and can be printed on the console by the "config"
205 command. This provides information of which options are enabled on
212 Print console devices and information.
217 Print information about available CPUs. This normally shows the
218 number of CPUs, type (e.g. manufacturer, architecture, product or
219 internal name) and clock frequency. Other information may be
220 available depending on the CPU driver.
226 Print GPL license text
242 Run the command stored in the environment "bootcmd", i.e.
243 "bootd" does the same thing as "run bootcmd".
249 Boot an application image from the memory.
254 Boot the Linux zImage
258 depends on ARM64 || RISCV
261 Boot an AArch64 Linux Kernel image from memory.
265 depends on EFI_LOADER
268 Boot an EFI image from memory.
270 config CMD_BOOTEFI_HELLO_COMPILE
271 bool "Compile a standard EFI hello world binary for testing"
272 depends on CMD_BOOTEFI && !CPU_V7M && !SANDBOX
275 This compiles a standard EFI hello world application with U-Boot so
276 that it can be used with the test/py testing framework. This is useful
277 for testing that EFI is working at a basic level, and for bringing
278 up EFI support on a new architecture.
280 No additional space will be required in the resulting U-Boot binary
281 when this option is enabled.
283 config CMD_BOOTEFI_HELLO
284 bool "Allow booting a standard EFI hello world for testing"
285 depends on CMD_BOOTEFI_HELLO_COMPILE
287 This adds a standard EFI hello world application to U-Boot so that
288 it can be used with the 'bootefi hello' command. This is useful
289 for testing that EFI is working at a basic level, and for bringing
290 up EFI support on a new architecture.
292 source lib/efi_selftest/Kconfig
298 Add an ANSI terminal boot menu command.
303 Android DTB/DTBO image manipulation commands. Read dtb/dtbo files from
304 image into RAM, dump image structure information, etc. Those dtb/dtbo
305 files should be merged in one dtb further, which needs to be passed to
306 the kernel, as part of a boot process.
309 bool "bootelf, bootvx"
312 Boot an ELF/vxWorks image from the memory.
315 bool "Flattened Device Tree utility commands"
319 Do FDT related setup before booting into the Operating System.
325 Start an application at a given address.
331 Run the command in the given environment variable.
337 Print header information for application image.
342 List all images found in flash
348 Extract a part of a multi-image.
351 bool "spl export - Export boot information for Falcon boot"
354 Falcon mode allows booting directly from SPL into an Operating
355 System such as Linux, thus skipping U-Boot proper. See
356 doc/README.falcon for full information about how to use this
359 config CMD_SPL_NAND_OFS
360 hex "Offset of OS args or dtb for Falcon-mode NAND boot"
361 depends on CMD_SPL && (TPL_NAND_SUPPORT || SPL_NAND_SUPPORT)
364 This provides the offset of the command line arguments for Linux
365 when booting from NAND in Falcon mode. See doc/README.falcon
366 for full information about how to use this option (and also see
367 board/gateworks/gw_ventana/README for an example).
369 config CMD_SPL_NOR_OFS
370 hex "Offset of OS args or dtb for Falcon-mode NOR boot"
371 depends on CMD_SPL && SPL_NOR_SUPPORT
374 This provides the offset of the command line arguments or dtb for
375 Linux when booting from NOR in Falcon mode.
377 config CMD_SPL_WRITE_SIZE
378 hex "Size of argument area"
382 This provides the size of the command-line argument area in NAND
383 flash used by Falcon-mode boot. See the documentation until CMD_SPL
387 bool "fitImage update command"
389 Implements the 'fitupd' command, which allows to automatically
390 store software updates present on a TFTP server in NOR Flash
392 config CMD_THOR_DOWNLOAD
393 bool "thor - TIZEN 'thor' download"
395 Implements the 'thor' download protocol. This is a way of
396 downloading a software update over USB from an attached host.
397 There is no documentation about this within the U-Boot source code
398 but you should be able to find something on the interwebs.
401 bool "zboot - x86 boot command"
403 With x86 machines it is common to boot a bzImage file which
404 contains both a kernel and a setup.bin file. The latter includes
405 configuration information from the dark ages which x86 boards still
406 need to pick things out of.
408 Consider using FIT in preference to this since it supports directly
409 booting both 32- and 64-bit kernels, as well as secure boot.
410 Documentation is available in doc/uImage.FIT/x86-fit-boot.txt
414 menu "Environment commands"
417 bool "ask for env variable"
419 Ask for environment variable
437 Edit environment variable.
442 Allow for searching environment variables
448 Save all environment variables into the compiled-in persistent
454 depends on CMD_SAVEENV
456 Erase environment variables from the compiled-in persistent
459 config CMD_ENV_EXISTS
463 Check if a variable is defined in the environment for use in
466 config CMD_ENV_CALLBACK
467 bool "env callbacks - print callbacks and their associated variables"
469 Some environment variable have callbacks defined by
470 U_BOOT_ENV_CALLBACK. These are called when the variable changes.
471 For example changing "baudrate" adjust the serial baud rate. This
472 command lists the currently defined callbacks.
475 bool "env flags -print variables that have non-default flags"
477 Some environment variables have special flags that control their
478 behaviour. For example, serial# can only be written once and cannot
479 be deleted. This command shows the variables that have special
482 config CMD_NVEDIT_EFI
483 bool "env [set|print] -e - set/print UEFI variables"
484 depends on EFI_LOADER
488 UEFI variables are encoded as some form of U-Boot variables.
489 If enabled, we are allowed to set/print UEFI variables using
490 "env" command with "-e" option without knowing details.
492 config CMD_NVEDIT_INFO
493 bool "env info - print or evaluate environment information"
495 Print environment information:
496 - env_valid : is environment valid
497 - env_ready : is environment imported into hash table
498 - env_use_default : is default environment used
500 This command can be optionally used for evaluation in scripts:
501 [-d] : evaluate whether default environment is used
502 [-p] : evaluate whether environment can be persisted
503 The result of multiple evaluations will be combined with AND.
507 menu "Memory commands"
512 Compute binary operations (xor, or, and) of byte arrays of arbitrary
513 size from memory and store the result in memory or the environment.
526 Add -v option to verify data against a crc32 checksum.
529 bool "eeprom - EEPROM subsystem"
531 (deprecated, needs conversion to driver model)
532 Provides commands to read and write EEPROM (Electrically Erasable
533 Programmable Read Only Memory) chips that are connected over an
536 config CMD_EEPROM_LAYOUT
537 bool "Enable layout-aware eeprom commands"
538 depends on CMD_EEPROM
540 (deprecated, needs conversion to driver model)
541 When enabled, additional eeprom sub-commands become available.
543 eeprom print - prints the contents of the eeprom in a human-readable
544 way (eeprom layout fields, and data formatted to be fit for human
547 eeprom update - allows user to update eeprom fields by specifying
548 the field name, and providing the new data in a human readable format
549 (same format as displayed by the eeprom print command).
551 Both commands can either auto detect the layout, or be told which
555 __weak int parse_layout_version(char *str)
556 - override to provide your own layout name parsing
557 __weak void __eeprom_layout_assign(struct eeprom_layout *layout,
559 - override to setup the layout metadata based on the version
560 __weak int eeprom_layout_detect(unsigned char *data)
561 - override to provide your own algorithm for detecting layout
564 - contains various printing and updating functions for common
565 types of eeprom fields. Can be used for defining
568 config EEPROM_LAYOUT_HELP_STRING
569 string "Tells user what layout names are supported"
570 depends on CMD_EEPROM_LAYOUT
571 default "<not defined>"
573 Help printed with the LAYOUT VERSIONS part of the 'eeprom'
579 Infinite write loop on address range
586 Compute MD5 checksum.
591 depends on CMD_MD5SUM
593 Add -v option to verify data against an MD5 checksum.
598 Display memory information.
601 bool "md, mm, nm, mw, cp, cmp, base, loop"
606 mm - memory modify (auto-incrementing address)
607 nm - memory modify (constant address)
608 mw - memory write (fill)
611 base - print or set address offset
612 loop - initialize loop on address range
615 bool "Enable cyclic md/mw commands"
616 depends on CMD_MEMORY
618 Add the "mdc" and "mwc" memory commands. These are cyclic
623 This command will print 4 bytes (10,11,12,13) each 500 ms.
625 => mwc.l 100 12345678 10
626 This command will write 12345678 to address 100 all 10 ms.
631 depends on CMD_MEMORY && (LIB_RAND || LIB_HW_RAND)
633 random - fill memory with random data
638 Simple RAM read/write test.
642 config SYS_ALT_MEMTEST
643 bool "Alternative test"
645 Use a more complete alternative memory test.
652 mdc - memory display cyclic
653 mwc - memory write cyclic
659 Compute SHA1 checksum.
661 config SHA1SUM_VERIFY
663 depends on CMD_SHA1SUM
665 Add -v option to verify data against a SHA1 checksum.
668 bool "strings - display strings in memory"
670 This works similarly to the Unix 'strings' command except that it
671 works with a memory range. String of printable characters found
672 within the range are displayed. The minimum number of characters
673 for a sequence to be considered a string can be provided.
677 menu "Compression commands"
681 default y if CMD_BOOTI
684 Support decompressing an LZMA (Lempel-Ziv-Markov chain algorithm)
689 default y if CMD_BOOTI
691 Uncompress a zip-compressed memory region.
696 Compress a memory region with zlib deflate method.
700 menu "Device access commands"
703 #depends on FLASH_CFI_DRIVER
706 ARM Ltd reference designs flash partition access
709 bool "adc - Access Analog to Digital Converters info and data"
713 Shows ADC device info and permit printing one-shot analog converted
714 data from a named Analog to Digital Converter.
719 depends on PARTITIONS
721 Read/modify/write the fields of Bootloader Control Block, usually
722 stored on the flash "misc" partition with its structure defined in:
723 https://android.googlesource.com/platform/bootable/recovery/+/master/
724 bootloader_message/include/bootloader_message/bootloader_message.h
726 Some real-life use-cases include (but are not limited to):
727 - Determine the "boot reason" (and act accordingly):
728 https://source.android.com/devices/bootloader/boot-reason
729 - Get/pass a list of commands from/to recovery:
730 https://android.googlesource.com/platform/bootable/recovery
731 - Inspect/dump the contents of the BCB fields
734 bool "bind/unbind - Bind or unbind a device to/from a driver"
737 Bind or unbind a device to/from a driver from the command line.
738 This is useful in situations where a device may be handled by several
739 drivers. For example, this can be used to bind a UDC to the usb ether
740 gadget driver from the command line.
743 bool "clk - Show clock frequencies"
746 Shows clock frequences by calling a sock_clk_dump() hook function.
747 This is depreated in favour of using the CLK uclass and accessing
748 clock values from associated drivers. However currently no command
752 bool "demo - Demonstration commands for driver model"
755 Provides a 'demo' command which can be used to play around with
756 driver model. To use this properly you will need to enable one or
757 both of the demo devices (DM_DEMO_SHAPE and DM_DEMO_SIMPLE).
758 Otherwise you will always get an empty list of devices. The demo
759 devices are defined in the sandbox device tree, so the easiest
760 option is to use sandbox and pass the -d point to sandbox's
767 Enables the command "dfu" which is used to have U-Boot create a DFU
768 class device via USB. This command requires that the "dfu_alt_info"
769 environment variable be set and define the alt settings to expose to
773 bool "dm - Access to driver model information"
776 Provides access to driver model data structures and information,
777 such as a list of devices, list of uclasses and the state of each
778 device (e.g. activated). This is not required for operation, but
779 can be useful to see the state of driver model for debugging or
783 bool "fastboot - Android fastboot support"
786 This enables the command "fastboot" which enables the Android
787 fastboot mode for the platform. Fastboot is a protocol for
788 downloading images, flashing and device control used on
789 Android devices. Fastboot requires either the network stack
790 enabled or support for acting as a USB device.
792 See doc/android/fastboot.txt for more information.
795 bool "fdcboot - Boot from floppy device"
797 The 'fdtboot' command allows booting an image from a floppy disk.
800 bool "flinfo, erase, protect"
804 flinfo - print FLASH memory information
806 protect - enable or disable FLASH write protection
815 config CMD_FPGA_LOADBP
816 bool "fpga loadbp - load partial bitstream (Xilinx only)"
819 Supports loading an FPGA device from a bitstream buffer containing
822 config CMD_FPGA_LOADFS
823 bool "fpga loadfs - load bitstream from FAT filesystem (Xilinx only)"
826 Supports loading an FPGA device from a FAT filesystem.
828 config CMD_FPGA_LOADMK
829 bool "fpga loadmk - load bitstream from image"
832 Supports loading an FPGA device from a image generated by mkimage.
834 config CMD_FPGA_LOADP
835 bool "fpga loadp - load partial bitstream"
838 Supports loading an FPGA device from a bitstream buffer containing
841 config CMD_FPGA_LOAD_SECURE
842 bool "fpga loads - loads secure bitstreams (Xilinx only)"
845 Enables the fpga loads command which is used to load secure
846 (authenticated or encrypted or both) bitstreams on to FPGA.
849 bool "fpgad - dump FPGA registers"
851 (legacy, needs conversion to driver model)
852 Provides a way to dump FPGA registers by calling the board-specific
853 fpga_get_reg() function. This functions similarly to the 'md'
857 bool "fuse - support for the fuse subssystem"
859 (deprecated - needs conversion to driver model)
860 This allows reading, sensing, programming or overriding fuses
861 which control the behaviour of the device. The command uses the
870 bool "GPT (GUID Partition Table) command"
872 select HAVE_BLOCK_DEVICE
873 select PARTITION_UUIDS
876 Enable the 'gpt' command to ready and write GPT style partition
880 bool "GPT Random UUID generation"
883 Enable the generation of partitions with random UUIDs if none
886 config CMD_GPT_RENAME
887 bool "GPT partition renaming commands"
890 Enables the 'gpt' command to interchange names on two GPT
891 partitions via the 'gpt swap' command or to rename single
892 partitions via the 'rename' command.
895 bool "ide - Support for IDE drivers"
898 Provides an 'ide' command which allows accessing the IDE drive,
899 reseting the IDE interface, printing the partition table and
900 geting device info. It also enables the 'diskboot' command which
901 permits booting from an IDE drive.
904 bool "io - Support for performing I/O accesses"
906 Provides an 'iod' command to display I/O space and an 'iow' command
907 to write values to the I/O space. This can be useful for manually
908 checking the state of devices during boot when debugging device
912 bool "iotrace - Support for tracing I/O activity"
914 Provides an 'iotrace' command which supports recording I/O reads and
915 writes in a trace buffer in memory . It also maintains a checksum
916 of the trace records (even if space is exhausted) so that the
917 sequence of I/O accesses can be verified.
919 When debugging drivers it is useful to see what I/O accesses were
920 done and in what order.
922 Even if the individual accesses are of little interest it can be
923 useful to verify that the access pattern is consistent each time
924 an operation is performed. In this case a checksum can be used to
925 characterise the operation of a driver. The checksum can be compared
926 across different runs of the operation to verify that the driver is
929 In particular, when performing major refactoring of the driver, where
930 the access pattern should not change, the checksum provides assurance
931 that the refactoring work has not broken the driver.
933 This works by sneaking into the io.h heder for an architecture and
934 redirecting I/O accesses through iotrace's tracing mechanism.
936 For now no commands are provided to examine the trace buffer. The
937 format is fairly simple, so 'md' is a reasonable substitute.
939 Note: The checksum feature is only useful for I/O regions where the
940 contents do not change outside of software control. Where this is not
941 suitable you can fall back to manually comparing the addresses. It
942 might be useful to enhance tracing to only checksum the accesses and
943 not the data read/written.
953 bool "w1 - Support for Dallas 1-Wire protocol"
955 Dallas 1-wire protocol support
961 Load a binary file over serial line.
967 Load an S-Record file over serial line
972 MMC memory mapped support.
975 bool "Enable support for RPMB in the mmc command"
978 Enable the commands for reading, writing and programming the
979 key for the Replay Protection Memory Block partition in eMMC.
981 config CMD_MMC_SWRITE
983 depends on CMD_MMC && MMC_WRITE
986 Enable support for the "mmc swrite" command to write Android sparse
991 select MTD_PARTITIONS
993 MTD commands support.
997 default y if NAND_SUNXI
1002 config CMD_NAND_TRIMFFS
1003 bool "nand write.trimffs"
1004 default y if ARCH_SUNXI
1006 Allows one to skip empty pages when flashing something on a NAND.
1008 config CMD_NAND_LOCK_UNLOCK
1009 bool "nand lock/unlock"
1011 NAND locking support.
1013 config CMD_NAND_TORTURE
1016 NAND torture support.
1025 NVM Express device support
1028 bool "onenand - access to onenand device"
1030 OneNAND is a brand of NAND ('Not AND' gate) flash which provides
1031 various useful features. This command allows reading, writing,
1032 and erasing blocks. It allso provides a way to show and change
1033 bad blocks, and test the device.
1038 Enable the 'osd' command which allows to query information from and
1039 write text data to a on-screen display (OSD) device; a virtual device
1040 associated with a display capable of displaying a text overlay on the
1041 display it's associated with..
1045 select HAVE_BLOCK_DEVICE
1046 select PARTITION_UUIDS
1048 Read and display information about the partition table on
1052 bool "pci - Access PCI devices"
1054 Provide access to PCI (Peripheral Interconnect Bus), a type of bus
1055 used on some devices to allow the CPU to communicate with its
1056 peripherals. Sub-commands allow bus enumeration, displaying and
1057 changing configuration space and a few other features.
1060 bool "pinmux - show pins muxing"
1061 default y if PINCTRL
1063 Parse all available pin-controllers and show pins muxing. This
1064 is useful for debug purpoer to check the pin muxing and to know if
1065 a pin is configured as a GPIO or as an alternate function.
1070 Poweroff/Shutdown the system
1073 bool "read - Read binary data from a partition"
1075 Provides low-level access to the data in a partition.
1077 config CMD_REMOTEPROC
1079 depends on REMOTEPROC
1081 Support for Remote Processor control
1084 bool "sata - Access SATA subsystem"
1087 SATA (Serial Advanced Technology Attachment) is a serial bus
1088 standard for connecting to hard drives and other storage devices.
1089 This command provides information about attached devices and allows
1090 reading, writing and other operations.
1092 SATA replaces PATA (originally just ATA), which stands for Parallel AT
1093 Attachment, where AT refers to an IBM AT (Advanced Technology)
1094 computer released in 1984.
1097 bool "saves - Save a file over serial in S-Record format"
1099 Provides a way to save a binary file using the Motorola S-Record
1100 format over the serial line.
1103 bool "scsi - Access to SCSI devices"
1106 This provides a 'scsi' command which provides access to SCSI (Small
1107 Computer System Interface) devices. The command provides a way to
1108 scan the bus, reset the bus, read and write data and get information
1112 bool "sdram - Print SDRAM configuration information"
1114 Provides information about attached SDRAM. This assumed that the
1115 SDRAM has an EEPROM with information that can be read using the
1116 I2C bus. This is only available on some boards.
1120 depends on DM_SPI_FLASH || SPI_FLASH
1125 bool "sf test - Allow testing of SPI flash"
1128 Provides a way to test that SPI flash is working correctly. The
1129 test is destructive, in that an area of SPI flash must be provided
1130 for the test to use. Performance information is also provided,
1131 measuring the performance of reading, writing and erasing in
1132 Mbps (Million Bits Per Second). This value should approximately
1133 equal the SPI bus speed for a single-bit-wide SPI bus, assuming
1134 everything is working properly.
1137 bool "sspi - Command to access spi device"
1140 SPI utility command.
1142 config DEFAULT_SPI_BUS
1143 int "default spi bus used by sspi command"
1147 config DEFAULT_SPI_MODE
1148 hex "default spi mode used by sspi command (see include/spi.h)"
1153 bool "tsi148 - Command to access tsi148 device"
1155 This provides various sub-commands to initialise and configure the
1156 Turndra tsi148 device. See the command help for full details.
1159 bool "universe - Command to set up the Turndra Universe controller"
1161 This allows setting up the VMEbus provided by this controller.
1162 See the command help for full details.
1166 select HAVE_BLOCK_DEVICE
1172 select USB_FUNCTION_SDP
1174 Enables the command "sdp" which is used to have U-Boot emulating the
1175 Serial Download Protocol (SDP) via USB.
1179 depends on USB_FUNCTION_ROCKUSB
1181 Rockusb protocol is widely used by Rockchip SoC based devices. It can
1182 read/write info, image to/from devices. This enable rockusb command
1183 support to communication with rockusb device. for more detail about
1184 this command, please read doc/README.rockusb.
1186 config CMD_USB_MASS_STORAGE
1187 bool "UMS usb mass storage"
1188 select USB_FUNCTION_MASS_STORAGE
1190 USB mass storage support
1197 VirtIO block device support
1203 This provides commands to control the watchdog timer devices.
1209 Enable the command "axi" for accessing AXI (Advanced eXtensible
1210 Interface) busses, a on-chip interconnect specification for managing
1211 functional blocks in SoC designs, which is also often used in designs
1212 involving FPGAs (e.g. communication with IP cores in Xilinx FPGAs).
1216 menu "Shell scripting commands"
1222 Echo args to console
1228 Return true/false on integer compare.
1234 Run script from memory
1240 Evaluate boolean and math expressions and store the result in an env
1242 Also supports loading the value at a memory location into a variable.
1243 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
1247 menu "Android support commands"
1249 config CMD_AB_SELECT
1252 depends on ANDROID_AB
1254 On Android devices with more than one boot slot (multiple copies of
1255 the kernel and system images) this provides a command to select which
1256 slot should be used to boot from and register the boot attempt. This
1257 is used by the new A/B update model where one slot is updated in the
1258 background while running from the other slot.
1265 bool "Network commands"
1275 bootp - boot image via network using BOOTP/TFTP protocol
1279 depends on CMD_BOOTP
1281 Boot image via network using DHCP/TFTP protocol
1283 config BOOTP_BOOTPATH
1284 bool "Request & store 'rootpath' from BOOTP/DHCP server"
1286 depends on CMD_BOOTP
1288 Even though the config is called BOOTP_BOOTPATH, it stores the
1289 path in the variable 'rootpath'.
1292 bool "Request & store 'dnsip' from BOOTP/DHCP server"
1294 depends on CMD_BOOTP
1296 The primary DNS server is stored as 'dnsip'. If two servers are
1297 returned, you must set BOOTP_DNS2 to store that second server IP
1301 bool "Store 'dnsip2' from BOOTP/DHCP server"
1302 depends on BOOTP_DNS
1304 If a DHCP client requests the DNS server IP from a DHCP server,
1305 it is possible that more than one DNS serverip is offered to the
1306 client. If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1307 server IP will be stored in the additional environment
1308 variable "dnsip2". The first DNS serverip is always
1309 stored in the variable "dnsip", when BOOTP_DNS is defined.
1311 config BOOTP_GATEWAY
1312 bool "Request & store 'gatewayip' from BOOTP/DHCP server"
1314 depends on CMD_BOOTP
1316 config BOOTP_HOSTNAME
1317 bool "Request & store 'hostname' from BOOTP/DHCP server"
1319 depends on CMD_BOOTP
1321 The name may or may not be qualified with the local domain name.
1323 config BOOTP_PREFER_SERVERIP
1324 bool "serverip variable takes precedent over DHCP server IP."
1325 depends on CMD_BOOTP
1327 By default a BOOTP/DHCP reply will overwrite the 'serverip' variable.
1329 With this option enabled, the 'serverip' variable in the environment
1330 takes precedence over DHCP server IP and will only be set by the DHCP
1331 server if not already set in the environment.
1333 config BOOTP_SUBNETMASK
1334 bool "Request & store 'netmask' from BOOTP/DHCP server"
1336 depends on CMD_BOOTP
1338 config BOOTP_NTPSERVER
1339 bool "Request & store 'ntpserverip' from BOOTP/DHCP server"
1340 depends on CMD_BOOTP
1343 bool "Send PXE client arch to BOOTP/DHCP server"
1345 depends on CMD_BOOTP && CMD_PXE
1347 Supported for ARM, ARM64, and x86 for now.
1349 config BOOTP_PXE_CLIENTARCH
1351 depends on BOOTP_PXE
1352 default 0x16 if ARM64
1356 config BOOTP_VCI_STRING
1358 depends on CMD_BOOTP
1359 default "U-Boot.armv7" if CPU_V7A || CPU_V7M || CPU_V7R
1360 default "U-Boot.armv8" if ARM64
1361 default "U-Boot.arm" if ARM
1368 tftpboot - boot image via network using TFTP protocol
1372 depends on CMD_TFTPBOOT
1374 TFTP put command, for uploading files to a server
1378 depends on CMD_TFTPBOOT
1380 Act as a TFTP server and boot the first received file
1382 config NET_TFTP_VARS
1383 bool "Control TFTP timeout and count through environment"
1384 depends on CMD_TFTPBOOT
1387 If set, allows controlling the TFTP timeout through the
1388 environment variable tftptimeout, and the TFTP maximum
1389 timeout count through the variable tftptimeoutcountmax.
1390 If unset, timeout and maximum are hard-defined as 1 second
1391 and 10 timouts per TFTP transfer.
1396 Boot image via network using RARP/TFTP protocol
1402 Boot image via network using NFS protocol.
1407 Enable MII utility commands.
1412 Send ICMP ECHO_REQUEST to network host
1417 Perform CDP network configuration
1422 Synchronize RTC via network
1427 Lookup the IP of a hostname
1429 config CMD_LINK_LOCAL
1433 Acquire a network IP address using the link-local protocol
1440 Allow control of L2 Ethernet switch commands. These are supported
1441 by the vsc9953 Ethernet driver at present. Sub-commands allow
1442 operations such as enabling / disabling a port and
1443 viewing/maintaining the filtering database (FDB)
1449 Boot image via network using PXE protocol
1454 Wait for wake-on-lan Magic Packet
1458 menu "Misc commands"
1461 bool "Enable 'bmp' command"
1462 depends on LCD || DM_VIDEO || VIDEO
1464 This provides a way to obtain information about a BMP-format iamge
1465 and to display it. BMP (which presumably stands for BitMaP) is a
1466 file format defined by Microsoft which supports images of various
1467 depths, formats and compression methods. Headers on the file
1468 determine the formats used. This command can be used by first loading
1469 the image into RAM, then using this command to look at it or display
1472 config CMD_BOOTCOUNT
1474 depends on BOOTCOUNT_LIMIT
1476 Enable the bootcount command, which allows interrogation and
1477 reset of the bootcounter.
1480 bool "Enable board-specific commands"
1482 (deprecated: instead, please define a Kconfig option for each command)
1484 Some boards have board-specific commands which are only enabled
1485 during developemnt and need to be turned off for production. This
1486 option provides a way to control this. The commands that are enabled
1487 vary depending on the board.
1489 config CMD_BKOPS_ENABLE
1490 bool "mmc bkops enable"
1494 Enable command for setting manual background operations handshake
1495 on a eMMC device. The feature is optionally available on eMMC devices
1496 conforming to standard >= 4.41.
1498 config CMD_BLOCK_CACHE
1499 bool "blkcache - control and stats for block cache"
1500 depends on BLOCK_CACHE
1501 default y if BLOCK_CACHE
1503 Enable the blkcache command, which can be used to control the
1504 operation of the cache functions.
1505 This is most useful when fine-tuning the operation of the cache
1506 during development, but also allows the cache to be disabled when
1507 it might hurt performance (e.g. when using the ums command).
1510 bool "icache or dcache"
1512 Enable the "icache" and "dcache" commands
1514 config CMD_CONITRACE
1515 bool "conitrace - trace console input codes"
1517 Enable the 'conitrace' command which displays the codes received
1518 from the console input as hexadecimal numbers.
1521 bool "Enable clear screen command 'cls'"
1522 depends on CFB_CONSOLE || DM_VIDEO || LCD || VIDEO
1525 Enable the 'cls' command which clears the screen contents
1526 on video frame buffer.
1529 bool "efidebug - display/configure UEFI environment"
1530 depends on EFI_LOADER
1531 select EFI_DEVICE_PATH_TO_TEXT
1534 Enable the 'efidebug' command which provides a subset of UEFI
1535 shell utility with simplified functionality. It will be useful
1536 particularly for managing boot parameters as well as examining
1537 various EFI status for debugging.
1539 config CMD_EXCEPTION
1540 bool "exception - raise exception"
1541 depends on ARM || RISCV || X86
1543 Enable the 'exception' command which allows to raise an exception.
1550 Enable the 'led' command which allows for control of LEDs supported
1551 by the board. The LEDs can be listed with 'led list' and controlled
1552 with led on/off/togle/blink. Any LED drivers can be controlled with
1553 this command, e.g. led_gpio.
1559 Enable the 'date' command for getting/setting the time/date in RTC
1565 Run commands and summarize execution time.
1568 bool "gettime - read elapsed time"
1570 Enable the 'gettime' command which reads the elapsed time since
1571 U-Boot started running. This shows the time in seconds and
1572 milliseconds. See also the 'bootstage' command which provides more
1573 flexibility for boot timing.
1575 # TODO: rename to CMD_SLEEP
1580 Delay execution for some time
1583 bool "support for multiprocessor"
1585 This provides an option to brinup
1586 different processors in multiprocessor
1592 Access the system timer.
1598 This provides basic access to the U-Boot's sound support. The main
1599 feature is to play a beep.
1601 sound init - set up sound system
1602 sound play - play a sound
1608 This provides access to the QEMU firmware interface. The main
1609 feature is to allow easy loading of files passed to qemu-system
1610 via -kernel / -initrd
1612 source "cmd/mvebu/Kconfig"
1615 bool "terminal - provides a way to attach a serial terminal"
1617 Provides a 'cu'-like serial terminal command. This can be used to
1618 access other serial ports from the system console. The terminal
1619 is very simple with no special processing of characters. As with
1620 cu, you can press ~. (tilde followed by period) to exit.
1623 bool "uuid, guid - generation of unique IDs"
1626 This enables two commands:
1628 uuid - generate random Universally Unique Identifier
1629 guid - generate Globally Unique Identifier based on random UUID
1631 The two commands are very similar except for the endianness of the
1636 source "cmd/ti/Kconfig"
1638 config CMD_BOOTSTAGE
1639 bool "Enable the 'bootstage' command"
1640 depends on BOOTSTAGE
1642 Add a 'bootstage' command which supports printing a report
1643 and un/stashing of bootstage data.
1645 menu "Power commands"
1647 bool "Enable Driver Model PMIC command"
1650 This is the pmic command, based on a driver model pmic's API.
1651 Command features are unchanged:
1652 - list - list pmic devices
1653 - pmic dev <id> - show or [set] operating pmic device (NEW)
1654 - pmic dump - dump registers
1655 - pmic read address - read byte of register at address
1656 - pmic write address - write byte to register at address
1657 The only one change for this command is 'dev' subcommand.
1659 config CMD_REGULATOR
1660 bool "Enable Driver Model REGULATOR command"
1661 depends on DM_REGULATOR
1663 This command is based on driver model regulator's API.
1664 User interface features:
1665 - list - list regulator devices
1666 - regulator dev <id> - show or [set] operating regulator device
1667 - regulator info - print constraints info
1668 - regulator status - print operating status
1669 - regulator value <val] <-f> - print/[set] voltage value [uV]
1670 - regulator current <val> - print/[set] current value [uA]
1671 - regulator mode <id> - print/[set] operating mode id
1672 - regulator enable - enable the regulator output
1673 - regulator disable - disable the regulator output
1675 The '-f' (force) option can be used for set the value which exceeds
1676 the limits, which are found in device-tree and are kept in regulator's
1677 uclass platdata structure.
1681 menu "Security commands"
1683 bool "Enable the 'aes' command"
1686 This provides a means to encrypt and decrypt data using the AES
1687 (Advanced Encryption Standard). This algorithm uses a symetric key
1688 and is widely used as a streaming cipher. Different key lengths are
1689 supported by the algorithm but this command only supports 128 bits
1693 bool "Enable the 'blob' command"
1695 This is used with the Freescale secure boot mechanism.
1697 Freescale's SEC block has built-in Blob Protocol which provides
1698 a method for protecting user-defined data across system power
1699 cycles. SEC block protects data in a data structure called a Blob,
1700 which provides both confidentiality and integrity protection.
1702 Encapsulating data as a blob
1703 Each time that the Blob Protocol is used to protect data, a
1704 different randomly generated key is used to encrypt the data.
1705 This random key is itself encrypted using a key which is derived
1706 from SoC's non-volatile secret key and a 16 bit Key identifier.
1707 The resulting encrypted key along with encrypted data is called a
1708 blob. The non-volatile secure key is available for use only during
1711 During decapsulation, the reverse process is performed to get back
1715 blob enc - encapsulating data as a cryptgraphic blob
1716 blob dec - decapsulating cryptgraphic blob to get the data
1720 blob enc src dst len km
1722 Encapsulate and create blob of data $len bytes long
1723 at address $src and store the result at address $dst.
1724 $km is the 16 byte key modifier is also required for
1725 generation/use as key for cryptographic operation. Key
1726 modifier should be 16 byte long.
1728 blob dec src dst len km
1730 Decapsulate the blob of data at address $src and
1731 store result of $len byte at addr $dst.
1732 $km is the 16 byte key modifier is also required for
1733 generation/use as key for cryptographic operation. Key
1734 modifier should be 16 byte long.
1737 bool "Support 'hash' command"
1740 This provides a way to hash data in memory using various supported
1741 algorithms (such as SHA1, MD5, CRC32). The computed digest can be
1742 saved to memory or to an environment variable. It is also possible
1743 to verify a hash against data in memory.
1746 bool "Support the 'hvc' command"
1747 depends on ARM_SMCCC
1749 Allows issuing Hypervisor Calls (HVCs). Mostly useful for
1750 development and testing.
1753 bool "Support the 'smc' command"
1754 depends on ARM_SMCCC
1756 Allows issuing Secure Monitor Calls (SMCs). Mostly useful for
1757 development and testing.
1763 Add -v option to verify data against a hash.
1773 bool "Enable the 'tpm' command"
1774 depends on TPM_V1 || TPM_V2
1775 select CMD_TPM_V1 if TPM_V1
1776 select CMD_TPM_V2 if TPM_V2
1778 This provides a means to talk to a TPM from the command line. A wide
1779 range of commands if provided - see 'tpm help' for details. The
1780 command requires a suitable TPM on your board and the correct driver
1786 bool "Enable the 'tpm test' command"
1789 This provides a a series of tests to confirm that the TPMv1.x is
1790 working correctly. The tests cover initialisation, non-volatile RAM,
1791 extend, global lock and checking that timing is within expectations.
1792 The tests pass correctly on Infineon TPMs but may need to be adjusted
1799 menu "Firmware commands"
1801 bool "Enable crosec command"
1805 Enable command-line access to the Chrome OS EC (Embedded
1806 Controller). This provides the 'crosec' command which has
1807 a number of sub-commands for performing EC tasks such as
1808 updating its flash, accessing a small saved context area
1809 and talking to the I2C bus behind the EC (if there is one).
1812 menu "Filesystem commands"
1814 bool "Enable the 'btrsubvol' command"
1817 This enables the 'btrsubvol' command to list subvolumes
1818 of a BTRFS filesystem. There are no special commands for
1819 listing BTRFS directories or loading BTRFS files - this
1820 can be done by the generic 'fs' commands (see CMD_FS_GENERIC)
1821 when BTRFS is enabled (see FS_BTRFS).
1824 bool "Enable the 'cbfs' command"
1827 Define this to enable support for reading from a Coreboot
1828 filesystem. This is a ROM-based filesystem used for accessing files
1829 on systems that use coreboot as the first boot-loader and then load
1830 U-Boot to actually boot the Operating System. Available commands are
1831 cbfsinit, cbfsinfo, cbfsls and cbfsload.
1834 bool "Enable the 'cramfs' command"
1835 depends on FS_CRAMFS
1837 This provides commands for dealing with CRAMFS (Compressed ROM
1838 filesystem). CRAMFS is useful when space is tight since files are
1839 compressed. Two commands are provided:
1841 cramfsls - lists files in a cramfs image
1842 cramfsload - loads a file from a cramfs image
1845 bool "ext2 command support"
1848 Enables EXT2 FS command
1851 bool "ext4 command support"
1854 Enables EXT4 FS command
1856 config CMD_EXT4_WRITE
1858 bool "ext4 write command support"
1861 Enables EXT4 FS write command
1864 bool "FAT command support"
1867 Support for the FAT fs
1869 config CMD_FS_GENERIC
1870 bool "filesystem commands"
1872 Enables filesystem commands (e.g. load, ls) that work for multiple
1876 bool "fsuuid command"
1878 Enables fsuuid command for filesystem UUID.
1881 bool "jffs2 command"
1884 Enables commands to support the JFFS2 (Journalling Flash File System
1885 version 2) filesystem. This enables fsload, ls and fsinfo which
1886 provide the ability to load files, list directories and obtain
1887 filesystem information.
1890 bool "MTD partition support"
1891 select MTD_DEVICE if (CMD_NAND || NAND)
1893 MTD partitioning tool support.
1894 It is strongly encouraged to avoid using this command
1895 anymore along with 'sf', 'nand', 'onenand'. One can still
1896 declare the partitions in the mtdparts environment variable
1897 but better use the MTD stack and the 'mtd' command instead.
1899 config MTDIDS_DEFAULT
1900 string "Default MTD IDs"
1901 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1903 Defines a default MTD IDs list for use with MTD partitions in the
1904 Linux MTD command line partitions format.
1906 config MTDPARTS_DEFAULT
1907 string "Default MTD partition scheme"
1908 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1910 Defines a default MTD partitioning scheme in the Linux MTD command
1911 line partitions format
1913 config CMD_MTDPARTS_SPREAD
1914 bool "Padd partition size to take account of bad blocks"
1915 depends on CMD_MTDPARTS
1917 This enables the 'spread' sub-command of the mtdparts command.
1918 This command will modify the existing mtdparts variable by increasing
1919 the size of the partitions such that 1) each partition's net size is
1920 at least as large as the size specified in the mtdparts variable and
1921 2) each partition starts on a good block.
1924 bool "reiser - Access to reiserfs filesystems"
1926 This provides two commands which operate on a resierfs filesystem,
1927 commonly used some years ago:
1929 reiserls - list files
1930 reiserload - load a file
1933 bool "yaffs2 - Access of YAFFS2 filesystem"
1937 This provides commands for accessing a YAFFS2 filesystem. Yet
1938 Another Flash Filesystem 2 is a filesystem designed specifically
1939 for NAND flash. It incorporates bad-block management and ensures
1940 that device writes are sequential regardless of filesystem
1944 bool "zfs - Access of ZFS filesystem"
1946 This provides commands to accessing a ZFS filesystem, commonly used
1947 on Solaris systems. Two sub-commands are provided:
1949 zfsls - list files in a directory
1950 zfsload - load a file
1952 See doc/README.zfs for more details.
1956 menu "Debug commands"
1961 The bedbug (emBEDded deBUGger) command provides debugging features
1962 for some PowerPC processors. For details please see the
1963 docuemntation in doc/README.beddbug
1966 bool "diag - Board diagnostics"
1968 This command provides access to board diagnostic tests. These are
1969 called Power-on Self Tests (POST). The command allows listing of
1970 available tests and running either all the tests, or specific tests
1974 bool "irq - Show information about interrupts"
1975 depends on !ARM && !MIPS && !SH
1977 This enables two commands:
1979 interrupts - enable or disable interrupts
1980 irqinfo - print device-specific interrupt information
1983 bool "kgdb - Allow debugging of U-Boot with gdb"
1986 This enables a 'kgdb' command which allows gdb to connect to U-Boot
1987 over a serial link for debugging purposes. This allows
1988 single-stepping, inspecting variables, etc. This is supported only
1989 on PowerPC at present.
1992 bool "log - Generation, control and access to logging"
1995 This provides access to logging features. It allows the output of
1996 log data to be controlled to a limited extent (setting up the default
1997 maximum log level for emitting of records). It also provides access
1998 to a command used for testing the log system.
2001 bool "trace - Support tracing of function calls and timing"
2003 Enables a command to control using of function tracing within
2004 U-Boot. This allows recording of call traces including timing
2005 information. The command can write data to memory for exporting
2006 for analysis (e.g. using bootchart). See doc/README.trace for full
2010 bool "avb - Android Verified Boot 2.0 operations"
2011 depends on AVB_VERIFY
2014 Enables a "avb" command to perform verification of partitions using
2015 Android Verified Boot 2.0 functionality. It includes such subcommands:
2016 avb init - initialize avb2 subsystem
2017 avb read_rb - read rollback index
2018 avb write_rb - write rollback index
2019 avb is_unlocked - check device lock state
2020 avb get_uuid - read and print uuid of a partition
2021 avb read_part - read data from partition
2022 avb read_part_hex - read data from partition and output to stdout
2023 avb write_part - write data to partition
2024 avb verify - run full verification chain
2028 tristate "Enable UBI - Unsorted block images commands"
2031 UBI is a software layer above MTD layer which admits use of LVM-like
2032 logical volumes on top of MTD devices, hides some complexities of
2033 flash chips like wear and bad blocks and provides some other useful
2034 capabilities. Please, consult the MTD web site for more details
2035 (www.linux-mtd.infradead.org). Activate this option if you want
2036 to use U-Boot UBI commands.
2037 It is also strongly encouraged to also enable CONFIG_MTD to get full
2041 tristate "Enable UBIFS - Unsorted block images filesystem commands"
2043 default y if CMD_UBI
2046 UBIFS is a file system for flash devices which works on top of UBI.
projects / oweals / u-boot.git / blob