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"
175 depends on CMD_BOOTMENU
177 This enables the boot menu, controlled by environment variables
178 defined by the board. The menu starts after running the 'preboot'
179 environmnent variable (if enabled) and before handling the boot delay.
180 See README.bootmenu for more details.
202 Print ".config" contents.
204 If this option is enabled, the ".config" file contents are embedded
205 in the U-Boot image and can be printed on the console by the "config"
206 command. This provides information of which options are enabled on
213 Print console devices and information.
218 Print information about available CPUs. This normally shows the
219 number of CPUs, type (e.g. manufacturer, architecture, product or
220 internal name) and clock frequency. Other information may be
221 available depending on the CPU driver.
227 Print GPL license text
243 Run the command stored in the environment "bootcmd", i.e.
244 "bootd" does the same thing as "run bootcmd".
250 Boot an application image from the memory.
255 Boot the Linux zImage
259 depends on ARM64 || RISCV
262 Boot an AArch64 Linux Kernel image from memory.
266 depends on EFI_LOADER
269 Boot an EFI image from memory.
271 config CMD_BOOTEFI_HELLO_COMPILE
272 bool "Compile a standard EFI hello world binary for testing"
273 depends on CMD_BOOTEFI && !CPU_V7M && !SANDBOX
276 This compiles a standard EFI hello world application with U-Boot so
277 that it can be used with the test/py testing framework. This is useful
278 for testing that EFI is working at a basic level, and for bringing
279 up EFI support on a new architecture.
281 No additional space will be required in the resulting U-Boot binary
282 when this option is enabled.
284 config CMD_BOOTEFI_HELLO
285 bool "Allow booting a standard EFI hello world for testing"
286 depends on CMD_BOOTEFI_HELLO_COMPILE
288 This adds a standard EFI hello world application to U-Boot so that
289 it can be used with the 'bootefi hello' command. This is useful
290 for testing that EFI is working at a basic level, and for bringing
291 up EFI support on a new architecture.
293 source lib/efi_selftest/Kconfig
299 Add an ANSI terminal boot menu command.
304 Android DTB/DTBO image manipulation commands. Read dtb/dtbo files from
305 image into RAM, dump image structure information, etc. Those dtb/dtbo
306 files should be merged in one dtb further, which needs to be passed to
307 the kernel, as part of a boot process.
310 bool "bootelf, bootvx"
313 Boot an ELF/vxWorks image from the memory.
316 bool "Flattened Device Tree utility commands"
320 Do FDT related setup before booting into the Operating System.
326 Start an application at a given address.
332 Run the command in the given environment variable.
338 Print header information for application image.
343 List all images found in flash
349 Extract a part of a multi-image.
352 bool "spl export - Export boot information for Falcon boot"
355 Falcon mode allows booting directly from SPL into an Operating
356 System such as Linux, thus skipping U-Boot proper. See
357 doc/README.falcon for full information about how to use this
360 config CMD_SPL_NAND_OFS
361 hex "Offset of OS args or dtb for Falcon-mode NAND boot"
362 depends on CMD_SPL && (TPL_NAND_SUPPORT || SPL_NAND_SUPPORT)
365 This provides the offset of the command line arguments for Linux
366 when booting from NAND in Falcon mode. See doc/README.falcon
367 for full information about how to use this option (and also see
368 board/gateworks/gw_ventana/README for an example).
370 config CMD_SPL_NOR_OFS
371 hex "Offset of OS args or dtb for Falcon-mode NOR boot"
372 depends on CMD_SPL && SPL_NOR_SUPPORT
375 This provides the offset of the command line arguments or dtb for
376 Linux when booting from NOR in Falcon mode.
378 config CMD_SPL_WRITE_SIZE
379 hex "Size of argument area"
383 This provides the size of the command-line argument area in NAND
384 flash used by Falcon-mode boot. See the documentation until CMD_SPL
388 bool "fitImage update command"
390 Implements the 'fitupd' command, which allows to automatically
391 store software updates present on a TFTP server in NOR Flash
393 config CMD_THOR_DOWNLOAD
394 bool "thor - TIZEN 'thor' download"
396 Implements the 'thor' download protocol. This is a way of
397 downloading a software update over USB from an attached host.
398 There is no documentation about this within the U-Boot source code
399 but you should be able to find something on the interwebs.
402 bool "zboot - x86 boot command"
404 With x86 machines it is common to boot a bzImage file which
405 contains both a kernel and a setup.bin file. The latter includes
406 configuration information from the dark ages which x86 boards still
407 need to pick things out of.
409 Consider using FIT in preference to this since it supports directly
410 booting both 32- and 64-bit kernels, as well as secure boot.
411 Documentation is available in doc/uImage.FIT/x86-fit-boot.txt
415 menu "Environment commands"
418 bool "ask for env variable"
420 Ask for environment variable
438 Edit environment variable.
443 Allow for searching environment variables
449 Save all environment variables into the compiled-in persistent
455 depends on CMD_SAVEENV
457 Erase environment variables from the compiled-in persistent
460 config CMD_ENV_EXISTS
464 Check if a variable is defined in the environment for use in
467 config CMD_ENV_CALLBACK
468 bool "env callbacks - print callbacks and their associated variables"
470 Some environment variable have callbacks defined by
471 U_BOOT_ENV_CALLBACK. These are called when the variable changes.
472 For example changing "baudrate" adjust the serial baud rate. This
473 command lists the currently defined callbacks.
476 bool "env flags -print variables that have non-default flags"
478 Some environment variables have special flags that control their
479 behaviour. For example, serial# can only be written once and cannot
480 be deleted. This command shows the variables that have special
483 config CMD_NVEDIT_EFI
484 bool "env [set|print] -e - set/print UEFI variables"
485 depends on EFI_LOADER
489 UEFI variables are encoded as some form of U-Boot variables.
490 If enabled, we are allowed to set/print UEFI variables using
491 "env" command with "-e" option without knowing details.
493 config CMD_NVEDIT_INFO
494 bool "env info - print or evaluate environment information"
496 Print environment information:
497 - env_valid : is environment valid
498 - env_ready : is environment imported into hash table
499 - env_use_default : is default environment used
501 This command can be optionally used for evaluation in scripts:
502 [-d] : evaluate whether default environment is used
503 [-p] : evaluate whether environment can be persisted
504 The result of multiple evaluations will be combined with AND.
508 menu "Memory commands"
513 Compute binary operations (xor, or, and) of byte arrays of arbitrary
514 size from memory and store the result in memory or the environment.
527 Add -v option to verify data against a crc32 checksum.
530 bool "eeprom - EEPROM subsystem"
532 (deprecated, needs conversion to driver model)
533 Provides commands to read and write EEPROM (Electrically Erasable
534 Programmable Read Only Memory) chips that are connected over an
537 config CMD_EEPROM_LAYOUT
538 bool "Enable layout-aware eeprom commands"
539 depends on CMD_EEPROM
541 (deprecated, needs conversion to driver model)
542 When enabled, additional eeprom sub-commands become available.
544 eeprom print - prints the contents of the eeprom in a human-readable
545 way (eeprom layout fields, and data formatted to be fit for human
548 eeprom update - allows user to update eeprom fields by specifying
549 the field name, and providing the new data in a human readable format
550 (same format as displayed by the eeprom print command).
552 Both commands can either auto detect the layout, or be told which
556 __weak int parse_layout_version(char *str)
557 - override to provide your own layout name parsing
558 __weak void __eeprom_layout_assign(struct eeprom_layout *layout,
560 - override to setup the layout metadata based on the version
561 __weak int eeprom_layout_detect(unsigned char *data)
562 - override to provide your own algorithm for detecting layout
565 - contains various printing and updating functions for common
566 types of eeprom fields. Can be used for defining
569 config EEPROM_LAYOUT_HELP_STRING
570 string "Tells user what layout names are supported"
571 depends on CMD_EEPROM_LAYOUT
572 default "<not defined>"
574 Help printed with the LAYOUT VERSIONS part of the 'eeprom'
580 Infinite write loop on address range
587 Compute MD5 checksum.
592 depends on CMD_MD5SUM
594 Add -v option to verify data against an MD5 checksum.
599 Display memory information.
602 bool "md, mm, nm, mw, cp, cmp, base, loop"
607 mm - memory modify (auto-incrementing address)
608 nm - memory modify (constant address)
609 mw - memory write (fill)
612 base - print or set address offset
613 loop - initialize loop on address range
616 bool "Enable cyclic md/mw commands"
617 depends on CMD_MEMORY
619 Add the "mdc" and "mwc" memory commands. These are cyclic
624 This command will print 4 bytes (10,11,12,13) each 500 ms.
626 => mwc.l 100 12345678 10
627 This command will write 12345678 to address 100 all 10 ms.
632 depends on CMD_MEMORY && (LIB_RAND || LIB_HW_RAND)
634 random - fill memory with random data
639 Simple RAM read/write test.
643 config SYS_ALT_MEMTEST
644 bool "Alternative test"
646 Use a more complete alternative memory test.
653 mdc - memory display cyclic
654 mwc - memory write cyclic
660 Compute SHA1 checksum.
662 config SHA1SUM_VERIFY
664 depends on CMD_SHA1SUM
666 Add -v option to verify data against a SHA1 checksum.
669 bool "strings - display strings in memory"
671 This works similarly to the Unix 'strings' command except that it
672 works with a memory range. String of printable characters found
673 within the range are displayed. The minimum number of characters
674 for a sequence to be considered a string can be provided.
678 menu "Compression commands"
682 default y if CMD_BOOTI
685 Support decompressing an LZMA (Lempel-Ziv-Markov chain algorithm)
690 default y if CMD_BOOTI
692 Uncompress a zip-compressed memory region.
697 Compress a memory region with zlib deflate method.
701 menu "Device access commands"
704 #depends on FLASH_CFI_DRIVER
707 ARM Ltd reference designs flash partition access
710 bool "adc - Access Analog to Digital Converters info and data"
714 Shows ADC device info and permit printing one-shot analog converted
715 data from a named Analog to Digital Converter.
720 depends on PARTITIONS
722 Read/modify/write the fields of Bootloader Control Block, usually
723 stored on the flash "misc" partition with its structure defined in:
724 https://android.googlesource.com/platform/bootable/recovery/+/master/
725 bootloader_message/include/bootloader_message/bootloader_message.h
727 Some real-life use-cases include (but are not limited to):
728 - Determine the "boot reason" (and act accordingly):
729 https://source.android.com/devices/bootloader/boot-reason
730 - Get/pass a list of commands from/to recovery:
731 https://android.googlesource.com/platform/bootable/recovery
732 - Inspect/dump the contents of the BCB fields
735 bool "bind/unbind - Bind or unbind a device to/from a driver"
738 Bind or unbind a device to/from a driver from the command line.
739 This is useful in situations where a device may be handled by several
740 drivers. For example, this can be used to bind a UDC to the usb ether
741 gadget driver from the command line.
744 bool "clk - Show clock frequencies"
747 Shows clock frequences by calling a sock_clk_dump() hook function.
748 This is depreated in favour of using the CLK uclass and accessing
749 clock values from associated drivers. However currently no command
753 bool "demo - Demonstration commands for driver model"
756 Provides a 'demo' command which can be used to play around with
757 driver model. To use this properly you will need to enable one or
758 both of the demo devices (DM_DEMO_SHAPE and DM_DEMO_SIMPLE).
759 Otherwise you will always get an empty list of devices. The demo
760 devices are defined in the sandbox device tree, so the easiest
761 option is to use sandbox and pass the -d point to sandbox's
768 Enables the command "dfu" which is used to have U-Boot create a DFU
769 class device via USB. This command requires that the "dfu_alt_info"
770 environment variable be set and define the alt settings to expose to
774 bool "dm - Access to driver model information"
777 Provides access to driver model data structures and information,
778 such as a list of devices, list of uclasses and the state of each
779 device (e.g. activated). This is not required for operation, but
780 can be useful to see the state of driver model for debugging or
784 bool "fastboot - Android fastboot support"
787 This enables the command "fastboot" which enables the Android
788 fastboot mode for the platform. Fastboot is a protocol for
789 downloading images, flashing and device control used on
790 Android devices. Fastboot requires either the network stack
791 enabled or support for acting as a USB device.
793 See doc/android/fastboot.txt for more information.
796 bool "fdcboot - Boot from floppy device"
798 The 'fdtboot' command allows booting an image from a floppy disk.
801 bool "flinfo, erase, protect"
805 flinfo - print FLASH memory information
807 protect - enable or disable FLASH write protection
816 config CMD_FPGA_LOADBP
817 bool "fpga loadbp - load partial bitstream (Xilinx only)"
820 Supports loading an FPGA device from a bitstream buffer containing
823 config CMD_FPGA_LOADFS
824 bool "fpga loadfs - load bitstream from FAT filesystem (Xilinx only)"
827 Supports loading an FPGA device from a FAT filesystem.
829 config CMD_FPGA_LOADMK
830 bool "fpga loadmk - load bitstream from image"
833 Supports loading an FPGA device from a image generated by mkimage.
835 config CMD_FPGA_LOADP
836 bool "fpga loadp - load partial bitstream"
839 Supports loading an FPGA device from a bitstream buffer containing
842 config CMD_FPGA_LOAD_SECURE
843 bool "fpga loads - loads secure bitstreams (Xilinx only)"
846 Enables the fpga loads command which is used to load secure
847 (authenticated or encrypted or both) bitstreams on to FPGA.
850 bool "fpgad - dump FPGA registers"
852 (legacy, needs conversion to driver model)
853 Provides a way to dump FPGA registers by calling the board-specific
854 fpga_get_reg() function. This functions similarly to the 'md'
858 bool "fuse - support for the fuse subssystem"
860 (deprecated - needs conversion to driver model)
861 This allows reading, sensing, programming or overriding fuses
862 which control the behaviour of the device. The command uses the
871 bool "GPT (GUID Partition Table) command"
873 select HAVE_BLOCK_DEVICE
874 select PARTITION_UUIDS
877 Enable the 'gpt' command to ready and write GPT style partition
881 bool "GPT Random UUID generation"
884 Enable the generation of partitions with random UUIDs if none
887 config CMD_GPT_RENAME
888 bool "GPT partition renaming commands"
891 Enables the 'gpt' command to interchange names on two GPT
892 partitions via the 'gpt swap' command or to rename single
893 partitions via the 'rename' command.
896 bool "ide - Support for IDE drivers"
899 Provides an 'ide' command which allows accessing the IDE drive,
900 reseting the IDE interface, printing the partition table and
901 geting device info. It also enables the 'diskboot' command which
902 permits booting from an IDE drive.
905 bool "io - Support for performing I/O accesses"
907 Provides an 'iod' command to display I/O space and an 'iow' command
908 to write values to the I/O space. This can be useful for manually
909 checking the state of devices during boot when debugging device
913 bool "iotrace - Support for tracing I/O activity"
915 Provides an 'iotrace' command which supports recording I/O reads and
916 writes in a trace buffer in memory . It also maintains a checksum
917 of the trace records (even if space is exhausted) so that the
918 sequence of I/O accesses can be verified.
920 When debugging drivers it is useful to see what I/O accesses were
921 done and in what order.
923 Even if the individual accesses are of little interest it can be
924 useful to verify that the access pattern is consistent each time
925 an operation is performed. In this case a checksum can be used to
926 characterise the operation of a driver. The checksum can be compared
927 across different runs of the operation to verify that the driver is
930 In particular, when performing major refactoring of the driver, where
931 the access pattern should not change, the checksum provides assurance
932 that the refactoring work has not broken the driver.
934 This works by sneaking into the io.h heder for an architecture and
935 redirecting I/O accesses through iotrace's tracing mechanism.
937 For now no commands are provided to examine the trace buffer. The
938 format is fairly simple, so 'md' is a reasonable substitute.
940 Note: The checksum feature is only useful for I/O regions where the
941 contents do not change outside of software control. Where this is not
942 suitable you can fall back to manually comparing the addresses. It
943 might be useful to enhance tracing to only checksum the accesses and
944 not the data read/written.
954 bool "w1 - Support for Dallas 1-Wire protocol"
956 Dallas 1-wire protocol support
962 Load a binary file over serial line.
968 Load an S-Record file over serial line
973 MMC memory mapped support.
976 bool "Enable support for RPMB in the mmc command"
979 Enable the commands for reading, writing and programming the
980 key for the Replay Protection Memory Block partition in eMMC.
982 config CMD_MMC_SWRITE
984 depends on CMD_MMC && MMC_WRITE
987 Enable support for the "mmc swrite" command to write Android sparse
992 select MTD_PARTITIONS
994 MTD commands support.
998 default y if NAND_SUNXI
1003 config CMD_NAND_TRIMFFS
1004 bool "nand write.trimffs"
1005 default y if ARCH_SUNXI
1007 Allows one to skip empty pages when flashing something on a NAND.
1009 config CMD_NAND_LOCK_UNLOCK
1010 bool "nand lock/unlock"
1012 NAND locking support.
1014 config CMD_NAND_TORTURE
1017 NAND torture support.
1026 NVM Express device support
1029 bool "onenand - access to onenand device"
1031 OneNAND is a brand of NAND ('Not AND' gate) flash which provides
1032 various useful features. This command allows reading, writing,
1033 and erasing blocks. It allso provides a way to show and change
1034 bad blocks, and test the device.
1039 Enable the 'osd' command which allows to query information from and
1040 write text data to a on-screen display (OSD) device; a virtual device
1041 associated with a display capable of displaying a text overlay on the
1042 display it's associated with..
1046 select HAVE_BLOCK_DEVICE
1047 select PARTITION_UUIDS
1049 Read and display information about the partition table on
1053 bool "pci - Access PCI devices"
1055 Provide access to PCI (Peripheral Interconnect Bus), a type of bus
1056 used on some devices to allow the CPU to communicate with its
1057 peripherals. Sub-commands allow bus enumeration, displaying and
1058 changing configuration space and a few other features.
1061 bool "pinmux - show pins muxing"
1062 default y if PINCTRL
1064 Parse all available pin-controllers and show pins muxing. This
1065 is useful for debug purpoer to check the pin muxing and to know if
1066 a pin is configured as a GPIO or as an alternate function.
1071 Poweroff/Shutdown the system
1074 bool "read - Read binary data from a partition"
1076 Provides low-level access to the data in a partition.
1078 config CMD_REMOTEPROC
1080 depends on REMOTEPROC
1082 Support for Remote Processor control
1085 bool "sata - Access SATA subsystem"
1088 SATA (Serial Advanced Technology Attachment) is a serial bus
1089 standard for connecting to hard drives and other storage devices.
1090 This command provides information about attached devices and allows
1091 reading, writing and other operations.
1093 SATA replaces PATA (originally just ATA), which stands for Parallel AT
1094 Attachment, where AT refers to an IBM AT (Advanced Technology)
1095 computer released in 1984.
1098 bool "saves - Save a file over serial in S-Record format"
1100 Provides a way to save a binary file using the Motorola S-Record
1101 format over the serial line.
1104 bool "scsi - Access to SCSI devices"
1107 This provides a 'scsi' command which provides access to SCSI (Small
1108 Computer System Interface) devices. The command provides a way to
1109 scan the bus, reset the bus, read and write data and get information
1113 bool "sdram - Print SDRAM configuration information"
1115 Provides information about attached SDRAM. This assumed that the
1116 SDRAM has an EEPROM with information that can be read using the
1117 I2C bus. This is only available on some boards.
1121 depends on DM_SPI_FLASH || SPI_FLASH
1126 bool "sf test - Allow testing of SPI flash"
1129 Provides a way to test that SPI flash is working correctly. The
1130 test is destructive, in that an area of SPI flash must be provided
1131 for the test to use. Performance information is also provided,
1132 measuring the performance of reading, writing and erasing in
1133 Mbps (Million Bits Per Second). This value should approximately
1134 equal the SPI bus speed for a single-bit-wide SPI bus, assuming
1135 everything is working properly.
1138 bool "sspi - Command to access spi device"
1141 SPI utility command.
1143 config DEFAULT_SPI_BUS
1144 int "default spi bus used by sspi command"
1148 config DEFAULT_SPI_MODE
1149 hex "default spi mode used by sspi command (see include/spi.h)"
1154 bool "tsi148 - Command to access tsi148 device"
1156 This provides various sub-commands to initialise and configure the
1157 Turndra tsi148 device. See the command help for full details.
1160 bool "universe - Command to set up the Turndra Universe controller"
1162 This allows setting up the VMEbus provided by this controller.
1163 See the command help for full details.
1167 select HAVE_BLOCK_DEVICE
1173 select USB_FUNCTION_SDP
1175 Enables the command "sdp" which is used to have U-Boot emulating the
1176 Serial Download Protocol (SDP) via USB.
1180 depends on USB_FUNCTION_ROCKUSB
1182 Rockusb protocol is widely used by Rockchip SoC based devices. It can
1183 read/write info, image to/from devices. This enable rockusb command
1184 support to communication with rockusb device. for more detail about
1185 this command, please read doc/README.rockusb.
1187 config CMD_USB_MASS_STORAGE
1188 bool "UMS usb mass storage"
1189 select USB_FUNCTION_MASS_STORAGE
1191 USB mass storage support
1198 VirtIO block device support
1204 This provides commands to control the watchdog timer devices.
1210 Enable the command "axi" for accessing AXI (Advanced eXtensible
1211 Interface) busses, a on-chip interconnect specification for managing
1212 functional blocks in SoC designs, which is also often used in designs
1213 involving FPGAs (e.g. communication with IP cores in Xilinx FPGAs).
1217 menu "Shell scripting commands"
1223 Echo args to console
1229 Return true/false on integer compare.
1235 Run script from memory
1241 Evaluate boolean and math expressions and store the result in an env
1243 Also supports loading the value at a memory location into a variable.
1244 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
1248 menu "Android support commands"
1250 config CMD_AB_SELECT
1253 depends on ANDROID_AB
1255 On Android devices with more than one boot slot (multiple copies of
1256 the kernel and system images) this provides a command to select which
1257 slot should be used to boot from and register the boot attempt. This
1258 is used by the new A/B update model where one slot is updated in the
1259 background while running from the other slot.
1266 bool "Network commands"
1276 bootp - boot image via network using BOOTP/TFTP protocol
1280 depends on CMD_BOOTP
1282 Boot image via network using DHCP/TFTP protocol
1284 config BOOTP_BOOTPATH
1285 bool "Request & store 'rootpath' from BOOTP/DHCP server"
1287 depends on CMD_BOOTP
1289 Even though the config is called BOOTP_BOOTPATH, it stores the
1290 path in the variable 'rootpath'.
1293 bool "Request & store 'dnsip' from BOOTP/DHCP server"
1295 depends on CMD_BOOTP
1297 The primary DNS server is stored as 'dnsip'. If two servers are
1298 returned, you must set BOOTP_DNS2 to store that second server IP
1302 bool "Store 'dnsip2' from BOOTP/DHCP server"
1303 depends on BOOTP_DNS
1305 If a DHCP client requests the DNS server IP from a DHCP server,
1306 it is possible that more than one DNS serverip is offered to the
1307 client. If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1308 server IP will be stored in the additional environment
1309 variable "dnsip2". The first DNS serverip is always
1310 stored in the variable "dnsip", when BOOTP_DNS is defined.
1312 config BOOTP_GATEWAY
1313 bool "Request & store 'gatewayip' from BOOTP/DHCP server"
1315 depends on CMD_BOOTP
1317 config BOOTP_HOSTNAME
1318 bool "Request & store 'hostname' from BOOTP/DHCP server"
1320 depends on CMD_BOOTP
1322 The name may or may not be qualified with the local domain name.
1324 config BOOTP_PREFER_SERVERIP
1325 bool "serverip variable takes precedent over DHCP server IP."
1326 depends on CMD_BOOTP
1328 By default a BOOTP/DHCP reply will overwrite the 'serverip' variable.
1330 With this option enabled, the 'serverip' variable in the environment
1331 takes precedence over DHCP server IP and will only be set by the DHCP
1332 server if not already set in the environment.
1334 config BOOTP_SUBNETMASK
1335 bool "Request & store 'netmask' from BOOTP/DHCP server"
1337 depends on CMD_BOOTP
1339 config BOOTP_NTPSERVER
1340 bool "Request & store 'ntpserverip' from BOOTP/DHCP server"
1341 depends on CMD_BOOTP
1346 Selecting this will allow capturing all Ethernet packets and store
1347 them in physical memory in a PCAP formated file,
1348 later to be analyzed by PCAP reader application (IE. WireShark).
1351 bool "Send PXE client arch to BOOTP/DHCP server"
1353 depends on CMD_BOOTP && CMD_PXE
1355 Supported for ARM, ARM64, and x86 for now.
1357 config BOOTP_PXE_CLIENTARCH
1359 depends on BOOTP_PXE
1360 default 0x16 if ARM64
1364 config BOOTP_VCI_STRING
1366 depends on CMD_BOOTP
1367 default "U-Boot.armv7" if CPU_V7A || CPU_V7M || CPU_V7R
1368 default "U-Boot.armv8" if ARM64
1369 default "U-Boot.arm" if ARM
1376 tftpboot - boot image via network using TFTP protocol
1380 depends on CMD_TFTPBOOT
1382 TFTP put command, for uploading files to a server
1386 depends on CMD_TFTPBOOT
1388 Act as a TFTP server and boot the first received file
1390 config NET_TFTP_VARS
1391 bool "Control TFTP timeout and count through environment"
1392 depends on CMD_TFTPBOOT
1395 If set, allows controlling the TFTP timeout through the
1396 environment variable tftptimeout, and the TFTP maximum
1397 timeout count through the variable tftptimeoutcountmax.
1398 If unset, timeout and maximum are hard-defined as 1 second
1399 and 10 timouts per TFTP transfer.
1404 Boot image via network using RARP/TFTP protocol
1410 Boot image via network using NFS protocol.
1415 Enable MII utility commands.
1420 Send ICMP ECHO_REQUEST to network host
1425 Perform CDP network configuration
1430 Synchronize RTC via network
1435 Lookup the IP of a hostname
1437 config CMD_LINK_LOCAL
1441 Acquire a network IP address using the link-local protocol
1448 Allow control of L2 Ethernet switch commands. These are supported
1449 by the vsc9953 Ethernet driver at present. Sub-commands allow
1450 operations such as enabling / disabling a port and
1451 viewing/maintaining the filtering database (FDB)
1457 Boot image via network using PXE protocol
1462 Wait for wake-on-lan Magic Packet
1466 menu "Misc commands"
1469 bool "Enable 'bmp' command"
1470 depends on LCD || DM_VIDEO || VIDEO
1472 This provides a way to obtain information about a BMP-format iamge
1473 and to display it. BMP (which presumably stands for BitMaP) is a
1474 file format defined by Microsoft which supports images of various
1475 depths, formats and compression methods. Headers on the file
1476 determine the formats used. This command can be used by first loading
1477 the image into RAM, then using this command to look at it or display
1480 config CMD_BOOTCOUNT
1482 depends on BOOTCOUNT_LIMIT
1484 Enable the bootcount command, which allows interrogation and
1485 reset of the bootcounter.
1488 bool "Enable board-specific commands"
1490 (deprecated: instead, please define a Kconfig option for each command)
1492 Some boards have board-specific commands which are only enabled
1493 during developemnt and need to be turned off for production. This
1494 option provides a way to control this. The commands that are enabled
1495 vary depending on the board.
1497 config CMD_BKOPS_ENABLE
1498 bool "mmc bkops enable"
1502 Enable command for setting manual background operations handshake
1503 on a eMMC device. The feature is optionally available on eMMC devices
1504 conforming to standard >= 4.41.
1506 config CMD_BLOCK_CACHE
1507 bool "blkcache - control and stats for block cache"
1508 depends on BLOCK_CACHE
1509 default y if BLOCK_CACHE
1511 Enable the blkcache command, which can be used to control the
1512 operation of the cache functions.
1513 This is most useful when fine-tuning the operation of the cache
1514 during development, but also allows the cache to be disabled when
1515 it might hurt performance (e.g. when using the ums command).
1518 bool "icache or dcache"
1520 Enable the "icache" and "dcache" commands
1522 config CMD_CONITRACE
1523 bool "conitrace - trace console input codes"
1525 Enable the 'conitrace' command which displays the codes received
1526 from the console input as hexadecimal numbers.
1529 bool "Enable clear screen command 'cls'"
1530 depends on CFB_CONSOLE || DM_VIDEO || LCD || VIDEO
1533 Enable the 'cls' command which clears the screen contents
1534 on video frame buffer.
1537 bool "efidebug - display/configure UEFI environment"
1538 depends on EFI_LOADER
1539 select EFI_DEVICE_PATH_TO_TEXT
1542 Enable the 'efidebug' command which provides a subset of UEFI
1543 shell utility with simplified functionality. It will be useful
1544 particularly for managing boot parameters as well as examining
1545 various EFI status for debugging.
1547 config CMD_EXCEPTION
1548 bool "exception - raise exception"
1549 depends on ARM || RISCV || X86
1551 Enable the 'exception' command which allows to raise an exception.
1558 Enable the 'led' command which allows for control of LEDs supported
1559 by the board. The LEDs can be listed with 'led list' and controlled
1560 with led on/off/togle/blink. Any LED drivers can be controlled with
1561 this command, e.g. led_gpio.
1567 Enable the 'date' command for getting/setting the time/date in RTC
1573 Run commands and summarize execution time.
1576 bool "gettime - read elapsed time"
1578 Enable the 'gettime' command which reads the elapsed time since
1579 U-Boot started running. This shows the time in seconds and
1580 milliseconds. See also the 'bootstage' command which provides more
1581 flexibility for boot timing.
1583 # TODO: rename to CMD_SLEEP
1588 Delay execution for some time
1591 bool "support for multiprocessor"
1593 This provides an option to brinup
1594 different processors in multiprocessor
1600 Access the system timer.
1606 This provides basic access to the U-Boot's sound support. The main
1607 feature is to play a beep.
1609 sound init - set up sound system
1610 sound play - play a sound
1616 This provides access to the QEMU firmware interface. The main
1617 feature is to allow easy loading of files passed to qemu-system
1618 via -kernel / -initrd
1620 source "cmd/mvebu/Kconfig"
1623 bool "terminal - provides a way to attach a serial terminal"
1625 Provides a 'cu'-like serial terminal command. This can be used to
1626 access other serial ports from the system console. The terminal
1627 is very simple with no special processing of characters. As with
1628 cu, you can press ~. (tilde followed by period) to exit.
1631 bool "uuid, guid - generation of unique IDs"
1634 This enables two commands:
1636 uuid - generate random Universally Unique Identifier
1637 guid - generate Globally Unique Identifier based on random UUID
1639 The two commands are very similar except for the endianness of the
1644 source "cmd/ti/Kconfig"
1646 config CMD_BOOTSTAGE
1647 bool "Enable the 'bootstage' command"
1648 depends on BOOTSTAGE
1650 Add a 'bootstage' command which supports printing a report
1651 and un/stashing of bootstage data.
1653 menu "Power commands"
1655 bool "Enable Driver Model PMIC command"
1658 This is the pmic command, based on a driver model pmic's API.
1659 Command features are unchanged:
1660 - list - list pmic devices
1661 - pmic dev <id> - show or [set] operating pmic device (NEW)
1662 - pmic dump - dump registers
1663 - pmic read address - read byte of register at address
1664 - pmic write address - write byte to register at address
1665 The only one change for this command is 'dev' subcommand.
1667 config CMD_REGULATOR
1668 bool "Enable Driver Model REGULATOR command"
1669 depends on DM_REGULATOR
1671 This command is based on driver model regulator's API.
1672 User interface features:
1673 - list - list regulator devices
1674 - regulator dev <id> - show or [set] operating regulator device
1675 - regulator info - print constraints info
1676 - regulator status - print operating status
1677 - regulator value <val] <-f> - print/[set] voltage value [uV]
1678 - regulator current <val> - print/[set] current value [uA]
1679 - regulator mode <id> - print/[set] operating mode id
1680 - regulator enable - enable the regulator output
1681 - regulator disable - disable the regulator output
1683 The '-f' (force) option can be used for set the value which exceeds
1684 the limits, which are found in device-tree and are kept in regulator's
1685 uclass platdata structure.
1689 menu "Security commands"
1691 bool "Enable the 'aes' command"
1694 This provides a means to encrypt and decrypt data using the AES
1695 (Advanced Encryption Standard). This algorithm uses a symetric key
1696 and is widely used as a streaming cipher. Different key lengths are
1697 supported by the algorithm but this command only supports 128 bits
1701 bool "Enable the 'blob' command"
1703 This is used with the Freescale secure boot mechanism.
1705 Freescale's SEC block has built-in Blob Protocol which provides
1706 a method for protecting user-defined data across system power
1707 cycles. SEC block protects data in a data structure called a Blob,
1708 which provides both confidentiality and integrity protection.
1710 Encapsulating data as a blob
1711 Each time that the Blob Protocol is used to protect data, a
1712 different randomly generated key is used to encrypt the data.
1713 This random key is itself encrypted using a key which is derived
1714 from SoC's non-volatile secret key and a 16 bit Key identifier.
1715 The resulting encrypted key along with encrypted data is called a
1716 blob. The non-volatile secure key is available for use only during
1719 During decapsulation, the reverse process is performed to get back
1723 blob enc - encapsulating data as a cryptgraphic blob
1724 blob dec - decapsulating cryptgraphic blob to get the data
1728 blob enc src dst len km
1730 Encapsulate and create blob of data $len bytes long
1731 at address $src and store the result at address $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.
1736 blob dec src dst len km
1738 Decapsulate the blob of data at address $src and
1739 store result of $len byte at addr $dst.
1740 $km is the 16 byte key modifier is also required for
1741 generation/use as key for cryptographic operation. Key
1742 modifier should be 16 byte long.
1745 bool "Support 'hash' command"
1748 This provides a way to hash data in memory using various supported
1749 algorithms (such as SHA1, MD5, CRC32). The computed digest can be
1750 saved to memory or to an environment variable. It is also possible
1751 to verify a hash against data in memory.
1754 bool "Support the 'hvc' command"
1755 depends on ARM_SMCCC
1757 Allows issuing Hypervisor Calls (HVCs). Mostly useful for
1758 development and testing.
1761 bool "Support the 'smc' command"
1762 depends on ARM_SMCCC
1764 Allows issuing Secure Monitor Calls (SMCs). Mostly useful for
1765 development and testing.
1771 Add -v option to verify data against a hash.
1781 bool "Enable the 'tpm' command"
1782 depends on TPM_V1 || TPM_V2
1783 select CMD_TPM_V1 if TPM_V1
1784 select CMD_TPM_V2 if TPM_V2
1786 This provides a means to talk to a TPM from the command line. A wide
1787 range of commands if provided - see 'tpm help' for details. The
1788 command requires a suitable TPM on your board and the correct driver
1794 bool "Enable the 'tpm test' command"
1797 This provides a a series of tests to confirm that the TPMv1.x is
1798 working correctly. The tests cover initialisation, non-volatile RAM,
1799 extend, global lock and checking that timing is within expectations.
1800 The tests pass correctly on Infineon TPMs but may need to be adjusted
1807 menu "Firmware commands"
1809 bool "Enable crosec command"
1813 Enable command-line access to the Chrome OS EC (Embedded
1814 Controller). This provides the 'crosec' command which has
1815 a number of sub-commands for performing EC tasks such as
1816 updating its flash, accessing a small saved context area
1817 and talking to the I2C bus behind the EC (if there is one).
1820 menu "Filesystem commands"
1822 bool "Enable the 'btrsubvol' command"
1825 This enables the 'btrsubvol' command to list subvolumes
1826 of a BTRFS filesystem. There are no special commands for
1827 listing BTRFS directories or loading BTRFS files - this
1828 can be done by the generic 'fs' commands (see CMD_FS_GENERIC)
1829 when BTRFS is enabled (see FS_BTRFS).
1832 bool "Enable the 'cbfs' command"
1835 Define this to enable support for reading from a Coreboot
1836 filesystem. This is a ROM-based filesystem used for accessing files
1837 on systems that use coreboot as the first boot-loader and then load
1838 U-Boot to actually boot the Operating System. Available commands are
1839 cbfsinit, cbfsinfo, cbfsls and cbfsload.
1842 bool "Enable the 'cramfs' command"
1843 depends on FS_CRAMFS
1845 This provides commands for dealing with CRAMFS (Compressed ROM
1846 filesystem). CRAMFS is useful when space is tight since files are
1847 compressed. Two commands are provided:
1849 cramfsls - lists files in a cramfs image
1850 cramfsload - loads a file from a cramfs image
1853 bool "ext2 command support"
1856 Enables EXT2 FS command
1859 bool "ext4 command support"
1862 Enables EXT4 FS command
1864 config CMD_EXT4_WRITE
1866 bool "ext4 write command support"
1869 Enables EXT4 FS write command
1872 bool "FAT command support"
1875 Support for the FAT fs
1877 config CMD_FS_GENERIC
1878 bool "filesystem commands"
1880 Enables filesystem commands (e.g. load, ls) that work for multiple
1884 bool "fsuuid command"
1886 Enables fsuuid command for filesystem UUID.
1889 bool "jffs2 command"
1892 Enables commands to support the JFFS2 (Journalling Flash File System
1893 version 2) filesystem. This enables fsload, ls and fsinfo which
1894 provide the ability to load files, list directories and obtain
1895 filesystem information.
1898 bool "MTD partition support"
1899 select MTD_DEVICE if (CMD_NAND || NAND)
1901 MTD partitioning tool support.
1902 It is strongly encouraged to avoid using this command
1903 anymore along with 'sf', 'nand', 'onenand'. One can still
1904 declare the partitions in the mtdparts environment variable
1905 but better use the MTD stack and the 'mtd' command instead.
1907 config MTDIDS_DEFAULT
1908 string "Default MTD IDs"
1909 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1911 Defines a default MTD IDs list for use with MTD partitions in the
1912 Linux MTD command line partitions format.
1914 config MTDPARTS_DEFAULT
1915 string "Default MTD partition scheme"
1916 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1918 Defines a default MTD partitioning scheme in the Linux MTD command
1919 line partitions format
1921 config CMD_MTDPARTS_SPREAD
1922 bool "Padd partition size to take account of bad blocks"
1923 depends on CMD_MTDPARTS
1925 This enables the 'spread' sub-command of the mtdparts command.
1926 This command will modify the existing mtdparts variable by increasing
1927 the size of the partitions such that 1) each partition's net size is
1928 at least as large as the size specified in the mtdparts variable and
1929 2) each partition starts on a good block.
1932 bool "reiser - Access to reiserfs filesystems"
1934 This provides two commands which operate on a resierfs filesystem,
1935 commonly used some years ago:
1937 reiserls - list files
1938 reiserload - load a file
1941 bool "yaffs2 - Access of YAFFS2 filesystem"
1945 This provides commands for accessing a YAFFS2 filesystem. Yet
1946 Another Flash Filesystem 2 is a filesystem designed specifically
1947 for NAND flash. It incorporates bad-block management and ensures
1948 that device writes are sequential regardless of filesystem
1952 bool "zfs - Access of ZFS filesystem"
1954 This provides commands to accessing a ZFS filesystem, commonly used
1955 on Solaris systems. Two sub-commands are provided:
1957 zfsls - list files in a directory
1958 zfsload - load a file
1960 See doc/README.zfs for more details.
1964 menu "Debug commands"
1969 The bedbug (emBEDded deBUGger) command provides debugging features
1970 for some PowerPC processors. For details please see the
1971 docuemntation in doc/README.beddbug
1974 bool "diag - Board diagnostics"
1976 This command provides access to board diagnostic tests. These are
1977 called Power-on Self Tests (POST). The command allows listing of
1978 available tests and running either all the tests, or specific tests
1982 bool "irq - Show information about interrupts"
1983 depends on !ARM && !MIPS && !SH
1985 This enables two commands:
1987 interrupts - enable or disable interrupts
1988 irqinfo - print device-specific interrupt information
1991 bool "kgdb - Allow debugging of U-Boot with gdb"
1994 This enables a 'kgdb' command which allows gdb to connect to U-Boot
1995 over a serial link for debugging purposes. This allows
1996 single-stepping, inspecting variables, etc. This is supported only
1997 on PowerPC at present.
2000 bool "log - Generation, control and access to logging"
2003 This provides access to logging features. It allows the output of
2004 log data to be controlled to a limited extent (setting up the default
2005 maximum log level for emitting of records). It also provides access
2006 to a command used for testing the log system.
2009 bool "trace - Support tracing of function calls and timing"
2011 Enables a command to control using of function tracing within
2012 U-Boot. This allows recording of call traces including timing
2013 information. The command can write data to memory for exporting
2014 for analysis (e.g. using bootchart). See doc/README.trace for full
2018 bool "avb - Android Verified Boot 2.0 operations"
2019 depends on AVB_VERIFY
2022 Enables a "avb" command to perform verification of partitions using
2023 Android Verified Boot 2.0 functionality. It includes such subcommands:
2024 avb init - initialize avb2 subsystem
2025 avb read_rb - read rollback index
2026 avb write_rb - write rollback index
2027 avb is_unlocked - check device lock state
2028 avb get_uuid - read and print uuid of a partition
2029 avb read_part - read data from partition
2030 avb read_part_hex - read data from partition and output to stdout
2031 avb write_part - write data to partition
2032 avb verify - run full verification chain
2036 tristate "Enable UBI - Unsorted block images commands"
2039 UBI is a software layer above MTD layer which admits use of LVM-like
2040 logical volumes on top of MTD devices, hides some complexities of
2041 flash chips like wear and bad blocks and provides some other useful
2042 capabilities. Please, consult the MTD web site for more details
2043 (www.linux-mtd.infradead.org). Activate this option if you want
2044 to use U-Boot UBI commands.
2045 It is also strongly encouraged to also enable CONFIG_MTD to get full
2049 tristate "Enable UBIFS - Unsorted block images filesystem commands"
2051 default y if CMD_UBI
2054 UBIFS is a file system for flash devices which works on top of UBI.
projects / oweals / u-boot.git / blob