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.
176 Print ".config" contents.
178 If this option is enabled, the ".config" file contents are embedded
179 in the U-Boot image and can be printed on the console by the "config"
180 command. This provides information of which options are enabled on
187 Print console devices and information.
192 Print information about available CPUs. This normally shows the
193 number of CPUs, type (e.g. manufacturer, architecture, product or
194 internal name) and clock frequency. Other information may be
195 available depending on the CPU driver.
201 Print GPL license text
217 Run the command stored in the environment "bootcmd", i.e.
218 "bootd" does the same thing as "run bootcmd".
224 Boot an application image from the memory.
229 Boot the Linux zImage
233 depends on ARM64 || RISCV
236 Boot an AArch64 Linux Kernel image from memory.
240 depends on EFI_LOADER
243 Boot an EFI image from memory.
245 config CMD_BOOTEFI_HELLO_COMPILE
246 bool "Compile a standard EFI hello world binary for testing"
247 depends on CMD_BOOTEFI && !CPU_V7M && !SANDBOX
250 This compiles a standard EFI hello world application with U-Boot so
251 that it can be used with the test/py testing framework. This is useful
252 for testing that EFI is working at a basic level, and for bringing
253 up EFI support on a new architecture.
255 No additional space will be required in the resulting U-Boot binary
256 when this option is enabled.
258 config CMD_BOOTEFI_HELLO
259 bool "Allow booting a standard EFI hello world for testing"
260 depends on CMD_BOOTEFI_HELLO_COMPILE
262 This adds a standard EFI hello world application to U-Boot so that
263 it can be used with the 'bootefi hello' command. This is useful
264 for testing that EFI is working at a basic level, and for bringing
265 up EFI support on a new architecture.
267 source lib/efi_selftest/Kconfig
273 Add an ANSI terminal boot menu command.
278 Android DTB/DTBO image manipulation commands. Read dtb/dtbo files from
279 image into RAM, dump image structure information, etc. Those dtb/dtbo
280 files should be merged in one dtb further, which needs to be passed to
281 the kernel, as part of a boot process.
284 bool "bootelf, bootvx"
287 Boot an ELF/vxWorks image from the memory.
290 bool "Flattened Device Tree utility commands"
294 Do FDT related setup before booting into the Operating System.
300 Start an application at a given address.
306 Run the command in the given environment variable.
312 Print header information for application image.
317 List all images found in flash
323 Extract a part of a multi-image.
326 bool "spl export - Export boot information for Falcon boot"
329 Falcon mode allows booting directly from SPL into an Operating
330 System such as Linux, thus skipping U-Boot proper. See
331 doc/README.falcon for full information about how to use this
334 config CMD_SPL_NAND_OFS
335 hex "Offset of OS args or dtb for Falcon-mode NAND boot"
336 depends on CMD_SPL && (TPL_NAND_SUPPORT || SPL_NAND_SUPPORT)
339 This provides the offset of the command line arguments for Linux
340 when booting from NAND in Falcon mode. See doc/README.falcon
341 for full information about how to use this option (and also see
342 board/gateworks/gw_ventana/README for an example).
344 config CMD_SPL_NOR_OFS
345 hex "Offset of OS args or dtb for Falcon-mode NOR boot"
346 depends on CMD_SPL && SPL_NOR_SUPPORT
349 This provides the offset of the command line arguments or dtb for
350 Linux when booting from NOR in Falcon mode.
352 config CMD_SPL_WRITE_SIZE
353 hex "Size of argument area"
357 This provides the size of the command-line argument area in NAND
358 flash used by Falcon-mode boot. See the documentation until CMD_SPL
362 bool "fitImage update command"
364 Implements the 'fitupd' command, which allows to automatically
365 store software updates present on a TFTP server in NOR Flash
367 config CMD_THOR_DOWNLOAD
368 bool "thor - TIZEN 'thor' download"
370 Implements the 'thor' download protocol. This is a way of
371 downloading a software update over USB from an attached host.
372 There is no documentation about this within the U-Boot source code
373 but you should be able to find something on the interwebs.
376 bool "zboot - x86 boot command"
378 With x86 machines it is common to boot a bzImage file which
379 contains both a kernel and a setup.bin file. The latter includes
380 configuration information from the dark ages which x86 boards still
381 need to pick things out of.
383 Consider using FIT in preference to this since it supports directly
384 booting both 32- and 64-bit kernels, as well as secure boot.
385 Documentation is available in doc/uImage.FIT/x86-fit-boot.txt
389 menu "Environment commands"
392 bool "ask for env variable"
394 Ask for environment variable
412 Edit environment variable.
417 Allow for searching environment variables
423 Save all environment variables into the compiled-in persistent
429 depends on CMD_SAVEENV
431 Erase environment variables from the compiled-in persistent
434 config CMD_ENV_EXISTS
438 Check if a variable is defined in the environment for use in
441 config CMD_ENV_CALLBACK
442 bool "env callbacks - print callbacks and their associated variables"
444 Some environment variable have callbacks defined by
445 U_BOOT_ENV_CALLBACK. These are called when the variable changes.
446 For example changing "baudrate" adjust the serial baud rate. This
447 command lists the currently defined callbacks.
450 bool "env flags -print variables that have non-default flags"
452 Some environment variables have special flags that control their
453 behaviour. For example, serial# can only be written once and cannot
454 be deleted. This command shows the variables that have special
457 config CMD_NVEDIT_EFI
458 bool "env [set|print] -e - set/print UEFI variables"
459 depends on EFI_LOADER
463 UEFI variables are encoded as some form of U-Boot variables.
464 If enabled, we are allowed to set/print UEFI variables using
465 "env" command with "-e" option without knowing details.
467 config CMD_NVEDIT_INFO
468 bool "env info - print or evaluate environment information"
470 Print environment information:
471 - env_valid : is environment valid
472 - env_ready : is environment imported into hash table
473 - env_use_default : is default environment used
475 This command can be optionally used for evaluation in scripts:
476 [-d] : evaluate whether default environment is used
477 [-p] : evaluate whether environment can be persisted
478 The result of multiple evaluations will be combined with AND.
482 menu "Memory commands"
487 Compute binary operations (xor, or, and) of byte arrays of arbitrary
488 size from memory and store the result in memory or the environment.
501 Add -v option to verify data against a crc32 checksum.
504 bool "eeprom - EEPROM subsystem"
506 (deprecated, needs conversion to driver model)
507 Provides commands to read and write EEPROM (Electrically Erasable
508 Programmable Read Only Memory) chips that are connected over an
511 config CMD_EEPROM_LAYOUT
512 bool "Enable layout-aware eeprom commands"
513 depends on CMD_EEPROM
515 (deprecated, needs conversion to driver model)
516 When enabled, additional eeprom sub-commands become available.
518 eeprom print - prints the contents of the eeprom in a human-readable
519 way (eeprom layout fields, and data formatted to be fit for human
522 eeprom update - allows user to update eeprom fields by specifying
523 the field name, and providing the new data in a human readable format
524 (same format as displayed by the eeprom print command).
526 Both commands can either auto detect the layout, or be told which
530 __weak int parse_layout_version(char *str)
531 - override to provide your own layout name parsing
532 __weak void __eeprom_layout_assign(struct eeprom_layout *layout,
534 - override to setup the layout metadata based on the version
535 __weak int eeprom_layout_detect(unsigned char *data)
536 - override to provide your own algorithm for detecting layout
539 - contains various printing and updating functions for common
540 types of eeprom fields. Can be used for defining
543 config EEPROM_LAYOUT_HELP_STRING
544 string "Tells user what layout names are supported"
545 depends on CMD_EEPROM_LAYOUT
546 default "<not defined>"
548 Help printed with the LAYOUT VERSIONS part of the 'eeprom'
554 Infinite write loop on address range
561 Compute MD5 checksum.
566 depends on CMD_MD5SUM
568 Add -v option to verify data against an MD5 checksum.
573 Display memory information.
576 bool "md, mm, nm, mw, cp, cmp, base, loop"
581 mm - memory modify (auto-incrementing address)
582 nm - memory modify (constant address)
583 mw - memory write (fill)
586 base - print or set address offset
587 loop - initialize loop on address range
592 depends on CMD_MEMORY && (LIB_RAND || LIB_HW_RAND)
594 random - fill memory with random data
599 Simple RAM read/write test.
603 config SYS_ALT_MEMTEST
604 bool "Alternative test"
606 Use a more complete alternative memory test.
613 mdc - memory display cyclic
614 mwc - memory write cyclic
620 Compute SHA1 checksum.
622 config SHA1SUM_VERIFY
624 depends on CMD_SHA1SUM
626 Add -v option to verify data against a SHA1 checksum.
629 bool "strings - display strings in memory"
631 This works similarly to the Unix 'strings' command except that it
632 works with a memory range. String of printable characters found
633 within the range are displayed. The minimum number of characters
634 for a sequence to be considered a string can be provided.
638 menu "Compression commands"
642 default y if CMD_BOOTI
645 Support decompressing an LZMA (Lempel-Ziv-Markov chain algorithm)
650 default y if CMD_BOOTI
652 Uncompress a zip-compressed memory region.
657 Compress a memory region with zlib deflate method.
661 menu "Device access commands"
664 #depends on FLASH_CFI_DRIVER
667 ARM Ltd reference designs flash partition access
670 bool "adc - Access Analog to Digital Converters info and data"
674 Shows ADC device info and permit printing one-shot analog converted
675 data from a named Analog to Digital Converter.
680 depends on PARTITIONS
682 Read/modify/write the fields of Bootloader Control Block, usually
683 stored on the flash "misc" partition with its structure defined in:
684 https://android.googlesource.com/platform/bootable/recovery/+/master/
685 bootloader_message/include/bootloader_message/bootloader_message.h
687 Some real-life use-cases include (but are not limited to):
688 - Determine the "boot reason" (and act accordingly):
689 https://source.android.com/devices/bootloader/boot-reason
690 - Get/pass a list of commands from/to recovery:
691 https://android.googlesource.com/platform/bootable/recovery
692 - Inspect/dump the contents of the BCB fields
695 bool "bind/unbind - Bind or unbind a device to/from a driver"
698 Bind or unbind a device to/from a driver from the command line.
699 This is useful in situations where a device may be handled by several
700 drivers. For example, this can be used to bind a UDC to the usb ether
701 gadget driver from the command line.
704 bool "clk - Show clock frequencies"
707 Shows clock frequences by calling a sock_clk_dump() hook function.
708 This is depreated in favour of using the CLK uclass and accessing
709 clock values from associated drivers. However currently no command
713 bool "demo - Demonstration commands for driver model"
716 Provides a 'demo' command which can be used to play around with
717 driver model. To use this properly you will need to enable one or
718 both of the demo devices (DM_DEMO_SHAPE and DM_DEMO_SIMPLE).
719 Otherwise you will always get an empty list of devices. The demo
720 devices are defined in the sandbox device tree, so the easiest
721 option is to use sandbox and pass the -d point to sandbox's
728 Enables the command "dfu" which is used to have U-Boot create a DFU
729 class device via USB. This command requires that the "dfu_alt_info"
730 environment variable be set and define the alt settings to expose to
734 bool "dm - Access to driver model information"
737 Provides access to driver model data structures and information,
738 such as a list of devices, list of uclasses and the state of each
739 device (e.g. activated). This is not required for operation, but
740 can be useful to see the state of driver model for debugging or
744 bool "fastboot - Android fastboot support"
747 This enables the command "fastboot" which enables the Android
748 fastboot mode for the platform. Fastboot is a protocol for
749 downloading images, flashing and device control used on
750 Android devices. Fastboot requires either the network stack
751 enabled or support for acting as a USB device.
753 See doc/android/fastboot.txt for more information.
756 bool "fdcboot - Boot from floppy device"
758 The 'fdtboot' command allows booting an image from a floppy disk.
761 bool "flinfo, erase, protect"
765 flinfo - print FLASH memory information
767 protect - enable or disable FLASH write protection
776 config CMD_FPGA_LOADBP
777 bool "fpga loadbp - load partial bitstream (Xilinx only)"
780 Supports loading an FPGA device from a bitstream buffer containing
783 config CMD_FPGA_LOADFS
784 bool "fpga loadfs - load bitstream from FAT filesystem (Xilinx only)"
787 Supports loading an FPGA device from a FAT filesystem.
789 config CMD_FPGA_LOADMK
790 bool "fpga loadmk - load bitstream from image"
793 Supports loading an FPGA device from a image generated by mkimage.
795 config CMD_FPGA_LOADP
796 bool "fpga loadp - load partial bitstream"
799 Supports loading an FPGA device from a bitstream buffer containing
802 config CMD_FPGA_LOAD_SECURE
803 bool "fpga loads - loads secure bitstreams (Xilinx only)"
806 Enables the fpga loads command which is used to load secure
807 (authenticated or encrypted or both) bitstreams on to FPGA.
810 bool "fpgad - dump FPGA registers"
812 (legacy, needs conversion to driver model)
813 Provides a way to dump FPGA registers by calling the board-specific
814 fpga_get_reg() function. This functions similarly to the 'md'
818 bool "fuse - support for the fuse subssystem"
820 (deprecated - needs conversion to driver model)
821 This allows reading, sensing, programming or overriding fuses
822 which control the behaviour of the device. The command uses the
831 bool "GPT (GUID Partition Table) command"
833 select HAVE_BLOCK_DEVICE
834 select PARTITION_UUIDS
837 Enable the 'gpt' command to ready and write GPT style partition
841 bool "GPT Random UUID generation"
844 Enable the generation of partitions with random UUIDs if none
847 config CMD_GPT_RENAME
848 bool "GPT partition renaming commands"
851 Enables the 'gpt' command to interchange names on two GPT
852 partitions via the 'gpt swap' command or to rename single
853 partitions via the 'rename' command.
856 bool "ide - Support for IDE drivers"
859 Provides an 'ide' command which allows accessing the IDE drive,
860 reseting the IDE interface, printing the partition table and
861 geting device info. It also enables the 'diskboot' command which
862 permits booting from an IDE drive.
865 bool "io - Support for performing I/O accesses"
867 Provides an 'iod' command to display I/O space and an 'iow' command
868 to write values to the I/O space. This can be useful for manually
869 checking the state of devices during boot when debugging device
873 bool "iotrace - Support for tracing I/O activity"
875 Provides an 'iotrace' command which supports recording I/O reads and
876 writes in a trace buffer in memory . It also maintains a checksum
877 of the trace records (even if space is exhausted) so that the
878 sequence of I/O accesses can be verified.
880 When debugging drivers it is useful to see what I/O accesses were
881 done and in what order.
883 Even if the individual accesses are of little interest it can be
884 useful to verify that the access pattern is consistent each time
885 an operation is performed. In this case a checksum can be used to
886 characterise the operation of a driver. The checksum can be compared
887 across different runs of the operation to verify that the driver is
890 In particular, when performing major refactoring of the driver, where
891 the access pattern should not change, the checksum provides assurance
892 that the refactoring work has not broken the driver.
894 This works by sneaking into the io.h heder for an architecture and
895 redirecting I/O accesses through iotrace's tracing mechanism.
897 For now no commands are provided to examine the trace buffer. The
898 format is fairly simple, so 'md' is a reasonable substitute.
900 Note: The checksum feature is only useful for I/O regions where the
901 contents do not change outside of software control. Where this is not
902 suitable you can fall back to manually comparing the addresses. It
903 might be useful to enhance tracing to only checksum the accesses and
904 not the data read/written.
914 bool "w1 - Support for Dallas 1-Wire protocol"
916 Dallas 1-wire protocol support
922 Load a binary file over serial line.
928 Load an S-Record file over serial line
933 MMC memory mapped support.
936 bool "Enable support for RPMB in the mmc command"
939 Enable the commands for reading, writing and programming the
940 key for the Replay Protection Memory Block partition in eMMC.
942 config CMD_MMC_SWRITE
944 depends on CMD_MMC && MMC_WRITE
947 Enable support for the "mmc swrite" command to write Android sparse
952 select MTD_PARTITIONS
954 MTD commands support.
958 default y if NAND_SUNXI
963 config CMD_NAND_TRIMFFS
964 bool "nand write.trimffs"
965 default y if ARCH_SUNXI
967 Allows one to skip empty pages when flashing something on a NAND.
969 config CMD_NAND_LOCK_UNLOCK
970 bool "nand lock/unlock"
972 NAND locking support.
974 config CMD_NAND_TORTURE
977 NAND torture support.
986 NVM Express device support
989 bool "onenand - access to onenand device"
991 OneNAND is a brand of NAND ('Not AND' gate) flash which provides
992 various useful features. This command allows reading, writing,
993 and erasing blocks. It allso provides a way to show and change
994 bad blocks, and test the device.
999 Enable the 'osd' command which allows to query information from and
1000 write text data to a on-screen display (OSD) device; a virtual device
1001 associated with a display capable of displaying a text overlay on the
1002 display it's associated with..
1006 select HAVE_BLOCK_DEVICE
1007 select PARTITION_UUIDS
1009 Read and display information about the partition table on
1013 bool "pci - Access PCI devices"
1015 Provide access to PCI (Peripheral Interconnect Bus), a type of bus
1016 used on some devices to allow the CPU to communicate with its
1017 peripherals. Sub-commands allow bus enumeration, displaying and
1018 changing configuration space and a few other features.
1021 bool "pinit - Set up PCMCIA device"
1023 Provides a means to initialise a PCMCIA (Personal Computer Memory
1024 Card International Association) device. This is an old standard from
1025 about 1990. These devices are typically removable memory or network
1026 cards using a standard 68-pin connector.
1029 bool "pinmux - show pins muxing"
1030 default y if PINCTRL
1032 Parse all available pin-controllers and show pins muxing. This
1033 is useful for debug purpoer to check the pin muxing and to know if
1034 a pin is configured as a GPIO or as an alternate function.
1039 Poweroff/Shutdown the system
1042 bool "read - Read binary data from a partition"
1044 Provides low-level access to the data in a partition.
1046 config CMD_REMOTEPROC
1048 depends on REMOTEPROC
1050 Support for Remote Processor control
1053 bool "sata - Access SATA subsystem"
1056 SATA (Serial Advanced Technology Attachment) is a serial bus
1057 standard for connecting to hard drives and other storage devices.
1058 This command provides information about attached devices and allows
1059 reading, writing and other operations.
1061 SATA replaces PATA (originally just ATA), which stands for Parallel AT
1062 Attachment, where AT refers to an IBM AT (Advanced Technology)
1063 computer released in 1984.
1066 bool "saves - Save a file over serial in S-Record format"
1068 Provides a way to save a binary file using the Motorola S-Record
1069 format over the serial line.
1072 bool "scsi - Access to SCSI devices"
1075 This provides a 'scsi' command which provides access to SCSI (Small
1076 Computer System Interface) devices. The command provides a way to
1077 scan the bus, reset the bus, read and write data and get information
1081 bool "sdram - Print SDRAM configuration information"
1083 Provides information about attached SDRAM. This assumed that the
1084 SDRAM has an EEPROM with information that can be read using the
1085 I2C bus. This is only available on some boards.
1089 depends on DM_SPI_FLASH || SPI_FLASH
1094 bool "sf test - Allow testing of SPI flash"
1097 Provides a way to test that SPI flash is working correctly. The
1098 test is destructive, in that an area of SPI flash must be provided
1099 for the test to use. Performance information is also provided,
1100 measuring the performance of reading, writing and erasing in
1101 Mbps (Million Bits Per Second). This value should approximately
1102 equal the SPI bus speed for a single-bit-wide SPI bus, assuming
1103 everything is working properly.
1106 bool "sspi - Command to access spi device"
1109 SPI utility command.
1111 config DEFAULT_SPI_BUS
1112 int "default spi bus used by sspi command"
1116 config DEFAULT_SPI_MODE
1117 hex "default spi mode used by sspi command (see include/spi.h)"
1122 bool "tsi148 - Command to access tsi148 device"
1124 This provides various sub-commands to initialise and configure the
1125 Turndra tsi148 device. See the command help for full details.
1128 bool "universe - Command to set up the Turndra Universe controller"
1130 This allows setting up the VMEbus provided by this controller.
1131 See the command help for full details.
1135 select HAVE_BLOCK_DEVICE
1141 select USB_FUNCTION_SDP
1143 Enables the command "sdp" which is used to have U-Boot emulating the
1144 Serial Download Protocol (SDP) via USB.
1148 depends on USB_FUNCTION_ROCKUSB
1150 Rockusb protocol is widely used by Rockchip SoC based devices. It can
1151 read/write info, image to/from devices. This enable rockusb command
1152 support to communication with rockusb device. for more detail about
1153 this command, please read doc/README.rockusb.
1155 config CMD_USB_MASS_STORAGE
1156 bool "UMS usb mass storage"
1157 select USB_FUNCTION_MASS_STORAGE
1159 USB mass storage support
1166 VirtIO block device support
1172 This provides commands to control the watchdog timer devices.
1178 Enable the command "axi" for accessing AXI (Advanced eXtensible
1179 Interface) busses, a on-chip interconnect specification for managing
1180 functional blocks in SoC designs, which is also often used in designs
1181 involving FPGAs (e.g. communication with IP cores in Xilinx FPGAs).
1185 menu "Shell scripting commands"
1191 Echo args to console
1197 Return true/false on integer compare.
1203 Run script from memory
1209 Evaluate boolean and math expressions and store the result in an env
1211 Also supports loading the value at a memory location into a variable.
1212 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
1216 menu "Android support commands"
1218 config CMD_AB_SELECT
1221 depends on ANDROID_AB
1223 On Android devices with more than one boot slot (multiple copies of
1224 the kernel and system images) this provides a command to select which
1225 slot should be used to boot from and register the boot attempt. This
1226 is used by the new A/B update model where one slot is updated in the
1227 background while running from the other slot.
1234 bool "Network commands"
1244 bootp - boot image via network using BOOTP/TFTP protocol
1248 depends on CMD_BOOTP
1250 Boot image via network using DHCP/TFTP protocol
1252 config BOOTP_BOOTPATH
1253 bool "Request & store 'rootpath' from BOOTP/DHCP server"
1255 depends on CMD_BOOTP
1257 Even though the config is called BOOTP_BOOTPATH, it stores the
1258 path in the variable 'rootpath'.
1261 bool "Request & store 'dnsip' from BOOTP/DHCP server"
1263 depends on CMD_BOOTP
1265 The primary DNS server is stored as 'dnsip'. If two servers are
1266 returned, you must set BOOTP_DNS2 to store that second server IP
1270 bool "Store 'dnsip2' from BOOTP/DHCP server"
1271 depends on BOOTP_DNS
1273 If a DHCP client requests the DNS server IP from a DHCP server,
1274 it is possible that more than one DNS serverip is offered to the
1275 client. If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1276 server IP will be stored in the additional environment
1277 variable "dnsip2". The first DNS serverip is always
1278 stored in the variable "dnsip", when BOOTP_DNS is defined.
1280 config BOOTP_GATEWAY
1281 bool "Request & store 'gatewayip' from BOOTP/DHCP server"
1283 depends on CMD_BOOTP
1285 config BOOTP_HOSTNAME
1286 bool "Request & store 'hostname' from BOOTP/DHCP server"
1288 depends on CMD_BOOTP
1290 The name may or may not be qualified with the local domain name.
1292 config BOOTP_PREFER_SERVERIP
1293 bool "serverip variable takes precedent over DHCP server IP."
1294 depends on CMD_BOOTP
1296 By default a BOOTP/DHCP reply will overwrite the 'serverip' variable.
1298 With this option enabled, the 'serverip' variable in the environment
1299 takes precedence over DHCP server IP and will only be set by the DHCP
1300 server if not already set in the environment.
1302 config BOOTP_SUBNETMASK
1303 bool "Request & store 'netmask' from BOOTP/DHCP server"
1305 depends on CMD_BOOTP
1307 config BOOTP_NTPSERVER
1308 bool "Request & store 'ntpserverip' from BOOTP/DHCP server"
1309 depends on CMD_BOOTP
1312 bool "Send PXE client arch to BOOTP/DHCP server"
1314 depends on CMD_BOOTP && CMD_PXE
1316 Supported for ARM, ARM64, and x86 for now.
1318 config BOOTP_PXE_CLIENTARCH
1320 depends on BOOTP_PXE
1321 default 0x16 if ARM64
1325 config BOOTP_VCI_STRING
1327 depends on CMD_BOOTP
1328 default "U-Boot.armv7" if CPU_V7A || CPU_V7M || CPU_V7R
1329 default "U-Boot.armv8" if ARM64
1330 default "U-Boot.arm" if ARM
1337 tftpboot - boot image via network using TFTP protocol
1341 depends on CMD_TFTPBOOT
1343 TFTP put command, for uploading files to a server
1347 depends on CMD_TFTPBOOT
1349 Act as a TFTP server and boot the first received file
1351 config NET_TFTP_VARS
1352 bool "Control TFTP timeout and count through environment"
1353 depends on CMD_TFTPBOOT
1356 If set, allows controlling the TFTP timeout through the
1357 environment variable tftptimeout, and the TFTP maximum
1358 timeout count through the variable tftptimeoutcountmax.
1359 If unset, timeout and maximum are hard-defined as 1 second
1360 and 10 timouts per TFTP transfer.
1365 Boot image via network using RARP/TFTP protocol
1371 Boot image via network using NFS protocol.
1376 Enable MII utility commands.
1381 Send ICMP ECHO_REQUEST to network host
1386 Perform CDP network configuration
1391 Synchronize RTC via network
1396 Lookup the IP of a hostname
1398 config CMD_LINK_LOCAL
1402 Acquire a network IP address using the link-local protocol
1409 Allow control of L2 Ethernet switch commands. These are supported
1410 by the vsc9953 Ethernet driver at present. Sub-commands allow
1411 operations such as enabling / disabling a port and
1412 viewing/maintaining the filtering database (FDB)
1418 Boot image via network using PXE protocol
1423 Wait for wake-on-lan Magic Packet
1427 menu "Misc commands"
1430 bool "Enable 'bmp' command"
1431 depends on LCD || DM_VIDEO || VIDEO
1433 This provides a way to obtain information about a BMP-format iamge
1434 and to display it. BMP (which presumably stands for BitMaP) is a
1435 file format defined by Microsoft which supports images of various
1436 depths, formats and compression methods. Headers on the file
1437 determine the formats used. This command can be used by first loading
1438 the image into RAM, then using this command to look at it or display
1441 config CMD_BOOTCOUNT
1443 depends on BOOTCOUNT_LIMIT
1445 Enable the bootcount command, which allows interrogation and
1446 reset of the bootcounter.
1449 bool "Enable board-specific commands"
1451 (deprecated: instead, please define a Kconfig option for each command)
1453 Some boards have board-specific commands which are only enabled
1454 during developemnt and need to be turned off for production. This
1455 option provides a way to control this. The commands that are enabled
1456 vary depending on the board.
1458 config CMD_BKOPS_ENABLE
1459 bool "mmc bkops enable"
1463 Enable command for setting manual background operations handshake
1464 on a eMMC device. The feature is optionally available on eMMC devices
1465 conforming to standard >= 4.41.
1467 config CMD_BLOCK_CACHE
1468 bool "blkcache - control and stats for block cache"
1469 depends on BLOCK_CACHE
1470 default y if BLOCK_CACHE
1472 Enable the blkcache command, which can be used to control the
1473 operation of the cache functions.
1474 This is most useful when fine-tuning the operation of the cache
1475 during development, but also allows the cache to be disabled when
1476 it might hurt performance (e.g. when using the ums command).
1479 bool "icache or dcache"
1481 Enable the "icache" and "dcache" commands
1483 config CMD_CONITRACE
1484 bool "conitrace - trace console input codes"
1486 Enable the 'conitrace' command which displays the codes received
1487 from the console input as hexadecimal numbers.
1490 bool "Enable clear screen command 'cls'"
1491 depends on CFB_CONSOLE || DM_VIDEO || LCD || VIDEO
1494 Enable the 'cls' command which clears the screen contents
1495 on video frame buffer.
1498 bool "efidebug - display/configure UEFI environment"
1499 depends on EFI_LOADER
1500 select EFI_DEVICE_PATH_TO_TEXT
1503 Enable the 'efidebug' command which provides a subset of UEFI
1504 shell utility with simplified functionality. It will be useful
1505 particularly for managing boot parameters as well as examining
1506 various EFI status for debugging.
1508 config CMD_EXCEPTION
1509 bool "exception - raise exception"
1510 depends on ARM || RISCV || X86
1512 Enable the 'exception' command which allows to raise an exception.
1519 Enable the 'led' command which allows for control of LEDs supported
1520 by the board. The LEDs can be listed with 'led list' and controlled
1521 with led on/off/togle/blink. Any LED drivers can be controlled with
1522 this command, e.g. led_gpio.
1528 Enable the 'date' command for getting/setting the time/date in RTC
1534 Run commands and summarize execution time.
1537 bool "gettime - read elapsed time"
1539 Enable the 'gettime' command which reads the elapsed time since
1540 U-Boot started running. This shows the time in seconds and
1541 milliseconds. See also the 'bootstage' command which provides more
1542 flexibility for boot timing.
1544 # TODO: rename to CMD_SLEEP
1549 Delay execution for some time
1552 bool "support for multiprocessor"
1554 This provides an option to brinup
1555 different processors in multiprocessor
1561 Access the system timer.
1567 This provides basic access to the U-Boot's sound support. The main
1568 feature is to play a beep.
1570 sound init - set up sound system
1571 sound play - play a sound
1577 This provides access to the QEMU firmware interface. The main
1578 feature is to allow easy loading of files passed to qemu-system
1579 via -kernel / -initrd
1581 source "cmd/mvebu/Kconfig"
1584 bool "terminal - provides a way to attach a serial terminal"
1586 Provides a 'cu'-like serial terminal command. This can be used to
1587 access other serial ports from the system console. The terminal
1588 is very simple with no special processing of characters. As with
1589 cu, you can press ~. (tilde followed by period) to exit.
1592 bool "uuid, guid - generation of unique IDs"
1595 This enables two commands:
1597 uuid - generate random Universally Unique Identifier
1598 guid - generate Globally Unique Identifier based on random UUID
1600 The two commands are very similar except for the endianness of the
1605 source "cmd/ti/Kconfig"
1607 config CMD_BOOTSTAGE
1608 bool "Enable the 'bootstage' command"
1609 depends on BOOTSTAGE
1611 Add a 'bootstage' command which supports printing a report
1612 and un/stashing of bootstage data.
1614 menu "Power commands"
1616 bool "Enable Driver Model PMIC command"
1619 This is the pmic command, based on a driver model pmic's API.
1620 Command features are unchanged:
1621 - list - list pmic devices
1622 - pmic dev <id> - show or [set] operating pmic device (NEW)
1623 - pmic dump - dump registers
1624 - pmic read address - read byte of register at address
1625 - pmic write address - write byte to register at address
1626 The only one change for this command is 'dev' subcommand.
1628 config CMD_REGULATOR
1629 bool "Enable Driver Model REGULATOR command"
1630 depends on DM_REGULATOR
1632 This command is based on driver model regulator's API.
1633 User interface features:
1634 - list - list regulator devices
1635 - regulator dev <id> - show or [set] operating regulator device
1636 - regulator info - print constraints info
1637 - regulator status - print operating status
1638 - regulator value <val] <-f> - print/[set] voltage value [uV]
1639 - regulator current <val> - print/[set] current value [uA]
1640 - regulator mode <id> - print/[set] operating mode id
1641 - regulator enable - enable the regulator output
1642 - regulator disable - disable the regulator output
1644 The '-f' (force) option can be used for set the value which exceeds
1645 the limits, which are found in device-tree and are kept in regulator's
1646 uclass platdata structure.
1650 menu "Security commands"
1652 bool "Enable the 'aes' command"
1655 This provides a means to encrypt and decrypt data using the AES
1656 (Advanced Encryption Standard). This algorithm uses a symetric key
1657 and is widely used as a streaming cipher. Different key lengths are
1658 supported by the algorithm but this command only supports 128 bits
1662 bool "Enable the 'blob' command"
1664 This is used with the Freescale secure boot mechanism.
1666 Freescale's SEC block has built-in Blob Protocol which provides
1667 a method for protecting user-defined data across system power
1668 cycles. SEC block protects data in a data structure called a Blob,
1669 which provides both confidentiality and integrity protection.
1671 Encapsulating data as a blob
1672 Each time that the Blob Protocol is used to protect data, a
1673 different randomly generated key is used to encrypt the data.
1674 This random key is itself encrypted using a key which is derived
1675 from SoC's non-volatile secret key and a 16 bit Key identifier.
1676 The resulting encrypted key along with encrypted data is called a
1677 blob. The non-volatile secure key is available for use only during
1680 During decapsulation, the reverse process is performed to get back
1684 blob enc - encapsulating data as a cryptgraphic blob
1685 blob dec - decapsulating cryptgraphic blob to get the data
1689 blob enc src dst len km
1691 Encapsulate and create blob of data $len bytes long
1692 at address $src and store the result at address $dst.
1693 $km is the 16 byte key modifier is also required for
1694 generation/use as key for cryptographic operation. Key
1695 modifier should be 16 byte long.
1697 blob dec src dst len km
1699 Decapsulate the blob of data at address $src and
1700 store result of $len byte at addr $dst.
1701 $km is the 16 byte key modifier is also required for
1702 generation/use as key for cryptographic operation. Key
1703 modifier should be 16 byte long.
1706 bool "Support 'hash' command"
1709 This provides a way to hash data in memory using various supported
1710 algorithms (such as SHA1, MD5, CRC32). The computed digest can be
1711 saved to memory or to an environment variable. It is also possible
1712 to verify a hash against data in memory.
1715 bool "Support the 'hvc' command"
1716 depends on ARM_SMCCC
1718 Allows issuing Hypervisor Calls (HVCs). Mostly useful for
1719 development and testing.
1722 bool "Support the 'smc' command"
1723 depends on ARM_SMCCC
1725 Allows issuing Secure Monitor Calls (SMCs). Mostly useful for
1726 development and testing.
1732 Add -v option to verify data against a hash.
1742 bool "Enable the 'tpm' command"
1743 depends on TPM_V1 || TPM_V2
1744 select CMD_TPM_V1 if TPM_V1
1745 select CMD_TPM_V2 if TPM_V2
1747 This provides a means to talk to a TPM from the command line. A wide
1748 range of commands if provided - see 'tpm help' for details. The
1749 command requires a suitable TPM on your board and the correct driver
1755 bool "Enable the 'tpm test' command"
1758 This provides a a series of tests to confirm that the TPMv1.x is
1759 working correctly. The tests cover initialisation, non-volatile RAM,
1760 extend, global lock and checking that timing is within expectations.
1761 The tests pass correctly on Infineon TPMs but may need to be adjusted
1768 menu "Firmware commands"
1770 bool "Enable crosec command"
1774 Enable command-line access to the Chrome OS EC (Embedded
1775 Controller). This provides the 'crosec' command which has
1776 a number of sub-commands for performing EC tasks such as
1777 updating its flash, accessing a small saved context area
1778 and talking to the I2C bus behind the EC (if there is one).
1781 menu "Filesystem commands"
1783 bool "Enable the 'btrsubvol' command"
1786 This enables the 'btrsubvol' command to list subvolumes
1787 of a BTRFS filesystem. There are no special commands for
1788 listing BTRFS directories or loading BTRFS files - this
1789 can be done by the generic 'fs' commands (see CMD_FS_GENERIC)
1790 when BTRFS is enabled (see FS_BTRFS).
1793 bool "Enable the 'cbfs' command"
1796 Define this to enable support for reading from a Coreboot
1797 filesystem. This is a ROM-based filesystem used for accessing files
1798 on systems that use coreboot as the first boot-loader and then load
1799 U-Boot to actually boot the Operating System. Available commands are
1800 cbfsinit, cbfsinfo, cbfsls and cbfsload.
1803 bool "Enable the 'cramfs' command"
1804 depends on FS_CRAMFS
1806 This provides commands for dealing with CRAMFS (Compressed ROM
1807 filesystem). CRAMFS is useful when space is tight since files are
1808 compressed. Two commands are provided:
1810 cramfsls - lists files in a cramfs image
1811 cramfsload - loads a file from a cramfs image
1814 bool "ext2 command support"
1817 Enables EXT2 FS command
1820 bool "ext4 command support"
1823 Enables EXT4 FS command
1825 config CMD_EXT4_WRITE
1827 bool "ext4 write command support"
1830 Enables EXT4 FS write command
1833 bool "FAT command support"
1836 Support for the FAT fs
1838 config CMD_FS_GENERIC
1839 bool "filesystem commands"
1841 Enables filesystem commands (e.g. load, ls) that work for multiple
1845 bool "fsuuid command"
1847 Enables fsuuid command for filesystem UUID.
1850 bool "jffs2 command"
1853 Enables commands to support the JFFS2 (Journalling Flash File System
1854 version 2) filesystem. This enables fsload, ls and fsinfo which
1855 provide the ability to load files, list directories and obtain
1856 filesystem information.
1859 bool "MTD partition support"
1860 select MTD_DEVICE if (CMD_NAND || NAND)
1862 MTD partitioning tool support.
1863 It is strongly encouraged to avoid using this command
1864 anymore along with 'sf', 'nand', 'onenand'. One can still
1865 declare the partitions in the mtdparts environment variable
1866 but better use the MTD stack and the 'mtd' command instead.
1868 config MTDIDS_DEFAULT
1869 string "Default MTD IDs"
1870 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1872 Defines a default MTD IDs list for use with MTD partitions in the
1873 Linux MTD command line partitions format.
1875 config MTDPARTS_DEFAULT
1876 string "Default MTD partition scheme"
1877 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1879 Defines a default MTD partitioning scheme in the Linux MTD command
1880 line partitions format
1882 config CMD_MTDPARTS_SPREAD
1883 bool "Padd partition size to take account of bad blocks"
1884 depends on CMD_MTDPARTS
1886 This enables the 'spread' sub-command of the mtdparts command.
1887 This command will modify the existing mtdparts variable by increasing
1888 the size of the partitions such that 1) each partition's net size is
1889 at least as large as the size specified in the mtdparts variable and
1890 2) each partition starts on a good block.
1893 bool "reiser - Access to reiserfs filesystems"
1895 This provides two commands which operate on a resierfs filesystem,
1896 commonly used some years ago:
1898 reiserls - list files
1899 reiserload - load a file
1902 bool "yaffs2 - Access of YAFFS2 filesystem"
1906 This provides commands for accessing a YAFFS2 filesystem. Yet
1907 Another Flash Filesystem 2 is a filesystem designed specifically
1908 for NAND flash. It incorporates bad-block management and ensures
1909 that device writes are sequential regardless of filesystem
1913 bool "zfs - Access of ZFS filesystem"
1915 This provides commands to accessing a ZFS filesystem, commonly used
1916 on Solaris systems. Two sub-commands are provided:
1918 zfsls - list files in a directory
1919 zfsload - load a file
1921 See doc/README.zfs for more details.
1925 menu "Debug commands"
1930 The bedbug (emBEDded deBUGger) command provides debugging features
1931 for some PowerPC processors. For details please see the
1932 docuemntation in doc/README.beddbug
1935 bool "diag - Board diagnostics"
1937 This command provides access to board diagnostic tests. These are
1938 called Power-on Self Tests (POST). The command allows listing of
1939 available tests and running either all the tests, or specific tests
1943 bool "irq - Show information about interrupts"
1944 depends on !ARM && !MIPS && !SH
1946 This enables two commands:
1948 interrupts - enable or disable interrupts
1949 irqinfo - print device-specific interrupt information
1952 bool "kgdb - Allow debugging of U-Boot with gdb"
1955 This enables a 'kgdb' command which allows gdb to connect to U-Boot
1956 over a serial link for debugging purposes. This allows
1957 single-stepping, inspecting variables, etc. This is supported only
1958 on PowerPC at present.
1961 bool "log - Generation, control and access to logging"
1964 This provides access to logging features. It allows the output of
1965 log data to be controlled to a limited extent (setting up the default
1966 maximum log level for emitting of records). It also provides access
1967 to a command used for testing the log system.
1970 bool "trace - Support tracing of function calls and timing"
1972 Enables a command to control using of function tracing within
1973 U-Boot. This allows recording of call traces including timing
1974 information. The command can write data to memory for exporting
1975 for analysis (e.g. using bootchart). See doc/README.trace for full
1979 bool "avb - Android Verified Boot 2.0 operations"
1980 depends on AVB_VERIFY
1983 Enables a "avb" command to perform verification of partitions using
1984 Android Verified Boot 2.0 functionality. It includes such subcommands:
1985 avb init - initialize avb2 subsystem
1986 avb read_rb - read rollback index
1987 avb write_rb - write rollback index
1988 avb is_unlocked - check device lock state
1989 avb get_uuid - read and print uuid of a partition
1990 avb read_part - read data from partition
1991 avb read_part_hex - read data from partition and output to stdout
1992 avb write_part - write data to partition
1993 avb verify - run full verification chain
1997 tristate "Enable UBI - Unsorted block images commands"
2000 UBI is a software layer above MTD layer which admits use of LVM-like
2001 logical volumes on top of MTD devices, hides some complexities of
2002 flash chips like wear and bad blocks and provides some other useful
2003 capabilities. Please, consult the MTD web site for more details
2004 (www.linux-mtd.infradead.org). Activate this option if you want
2005 to use U-Boot UBI commands.
2006 It is also strongly encouraged to also enable CONFIG_MTD to get full
2010 tristate "Enable UBIFS - Unsorted block images filesystem commands"
2012 default y if CMD_UBI
2015 UBIFS is a file system for flash devices which works on top of UBI.
projects / oweals / u-boot.git / blob