1 menu "Command line interface"
4 bool "Support U-Boot commands"
7 Enable U-Boot's command-line functions. This provides a means
8 to enter commands into U-Boot for a wide variety of purposes. It
9 also allows scripts (containing commands) to be executed.
10 Various commands and command categorys can be indivdually enabled.
11 Depending on the number of commands enabled, this can add
12 substantially to the size of U-Boot.
18 This option enables the "hush" shell (from Busybox) as command line
19 interpreter, thus enabling powerful command line syntax like
20 if...then...else...fi conditionals or `&&' and '||'
21 constructs ("shell scripts").
23 If disabled, you get the old, much simpler behaviour with a somewhat
24 smaller memory footprint.
26 config CMDLINE_EDITING
27 bool "Enable command line editing"
31 Enable editing and History functions for interactive command line
35 bool "Enable auto complete using TAB"
39 Enable auto completion of commands using TAB.
42 bool "Enable long help messages"
46 Defined when you want long help messages included
47 Do not set this option when short of memory.
53 This string is displayed in the command line to the left of the
57 string "Command execution tracer"
61 This option enables the possiblity to print all commands before
62 executing them and after all variables are evaluated (similar
63 to Bash's xtrace/'set -x' feature).
64 To enable the tracer a variable "xtrace" needs to be defined in
67 menu "Autoboot options"
73 This enables the autoboot. See doc/README.autoboot for detail.
76 bool "Stop autobooting via specific input key / string"
79 This option enables stopping (aborting) of the automatic
80 boot feature only by issuing a specific input key or
81 string. If not enabled, any input key will abort the
82 U-Boot automatic booting process and bring the device
83 to the U-Boot prompt for user input.
85 config AUTOBOOT_PROMPT
86 string "Autoboot stop prompt"
87 depends on AUTOBOOT_KEYED
88 default "Autoboot in %d seconds\\n"
90 This string is displayed before the boot delay selected by
91 CONFIG_BOOTDELAY starts. If it is not defined there is no
92 output indicating that autoboot is in progress.
94 Note that this define is used as the (only) argument to a
95 printf() call, so it may contain '%' format specifications,
96 provided that it also includes, sepearated by commas exactly
97 like in a printf statement, the required arguments. It is
98 the responsibility of the user to select only such arguments
99 that are valid in the given context.
101 config AUTOBOOT_ENCRYPTION
102 bool "Enable encryption in autoboot stopping"
103 depends on AUTOBOOT_KEYED
106 config AUTOBOOT_DELAY_STR
107 string "Delay autobooting via specific input key / string"
108 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
110 This option delays the automatic boot feature by issuing
111 a specific input key or string. If CONFIG_AUTOBOOT_DELAY_STR
112 or the environment variable "bootdelaykey" is specified
113 and this string is received from console input before
114 autoboot starts booting, U-Boot gives a command prompt. The
115 U-Boot prompt will time out if CONFIG_BOOT_RETRY_TIME is
116 used, otherwise it never times out.
118 config AUTOBOOT_STOP_STR
119 string "Stop autobooting via specific input key / string"
120 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
122 This option enables stopping (aborting) of the automatic
123 boot feature only by issuing a specific input key or
124 string. If CONFIG_AUTOBOOT_STOP_STR or the environment
125 variable "bootstopkey" is specified and this string is
126 received from console input before autoboot starts booting,
127 U-Boot gives a command prompt. The U-Boot prompt never
128 times out, even if CONFIG_BOOT_RETRY_TIME is used.
130 config AUTOBOOT_KEYED_CTRLC
131 bool "Enable Ctrl-C autoboot interruption"
132 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
135 This option allows for the boot sequence to be interrupted
136 by ctrl-c, in addition to the "bootdelaykey" and "bootstopkey".
137 Setting this variable provides an escape sequence from the
138 limited "password" strings.
140 config AUTOBOOT_STOP_STR_SHA256
141 string "Stop autobooting via SHA256 encrypted password"
142 depends on AUTOBOOT_KEYED && AUTOBOOT_ENCRYPTION
144 This option adds the feature to only stop the autobooting,
145 and therefore boot into the U-Boot prompt, when the input
146 string / password matches a values that is encypted via
147 a SHA256 hash and saved in the environment.
169 Print ".config" contents.
171 If this option is enabled, the ".config" file contents are embedded
172 in the U-Boot image and can be printed on the console by the "config"
173 command. This provides information of which options are enabled on
180 Print console devices and information.
185 Print information about available CPUs. This normally shows the
186 number of CPUs, type (e.g. manufacturer, architecture, product or
187 internal name) and clock frequency. Other information may be
188 available depending on the CPU driver.
194 Print GPL license text
210 Run the command stored in the environment "bootcmd", i.e.
211 "bootd" does the same thing as "run bootcmd".
217 Boot an application image from the memory.
222 Boot the Linux zImage
226 depends on ARM64 || RISCV
229 Boot an AArch64 Linux Kernel image from memory.
233 depends on EFI_LOADER
236 Boot an EFI image from memory.
238 config CMD_BOOTEFI_HELLO_COMPILE
239 bool "Compile a standard EFI hello world binary for testing"
240 depends on CMD_BOOTEFI && !CPU_V7M && !SANDBOX
243 This compiles a standard EFI hello world application with U-Boot so
244 that it can be used with the test/py testing framework. This is useful
245 for testing that EFI is working at a basic level, and for bringing
246 up EFI support on a new architecture.
248 No additional space will be required in the resulting U-Boot binary
249 when this option is enabled.
251 config CMD_BOOTEFI_HELLO
252 bool "Allow booting a standard EFI hello world for testing"
253 depends on CMD_BOOTEFI_HELLO_COMPILE
255 This adds a standard EFI hello world application to U-Boot so that
256 it can be used with the 'bootefi hello' command. This is useful
257 for testing that EFI is working at a basic level, and for bringing
258 up EFI support on a new architecture.
260 source lib/efi_selftest/Kconfig
266 Add an ANSI terminal boot menu command.
271 Android DTB/DTBO image manipulation commands. Read dtb/dtbo files from
272 image into RAM, dump image structure information, etc. Those dtb/dtbo
273 files should be merged in one dtb further, which needs to be passed to
274 the kernel, as part of a boot process.
277 bool "bootelf, bootvx"
280 Boot an ELF/vxWorks image from the memory.
283 bool "Flattened Device Tree utility commands"
287 Do FDT related setup before booting into the Operating System.
293 Start an application at a given address.
299 Run the command in the given environment variable.
305 Print header information for application image.
310 List all images found in flash
316 Extract a part of a multi-image.
319 bool "spl export - Export boot information for Falcon boot"
322 Falcon mode allows booting directly from SPL into an Operating
323 System such as Linux, thus skipping U-Boot proper. See
324 doc/README.falcon for full information about how to use this
327 config CMD_SPL_NAND_OFS
328 hex "Offset of OS command line args for Falcon-mode NAND boot"
332 This provides the offset of the command line arguments for Linux
333 when booting from NAND in Falcon mode. See doc/README.falcon
334 for full information about how to use this option (and also see
335 board/gateworks/gw_ventana/README for an example).
337 config CMD_SPL_WRITE_SIZE
338 hex "Size of argument area"
342 This provides the size of the command-line argument area in NAND
343 flash used by Falcon-mode boot. See the documentation until CMD_SPL
347 bool "fitImage update command"
349 Implements the 'fitupd' command, which allows to automatically
350 store software updates present on a TFTP server in NOR Flash
352 config CMD_THOR_DOWNLOAD
353 bool "thor - TIZEN 'thor' download"
355 Implements the 'thor' download protocol. This is a way of
356 downloading a software update over USB from an attached host.
357 There is no documentation about this within the U-Boot source code
358 but you should be able to find something on the interwebs.
361 bool "zboot - x86 boot command"
363 With x86 machines it is common to boot a bzImage file which
364 contains both a kernel and a setup.bin file. The latter includes
365 configuration information from the dark ages which x86 boards still
366 need to pick things out of.
368 Consider using FIT in preference to this since it supports directly
369 booting both 32- and 64-bit kernels, as well as secure boot.
370 Documentation is available in doc/uImage.FIT/x86-fit-boot.txt
374 menu "Environment commands"
377 bool "ask for env variable"
379 Ask for environment variable
397 Edit environment variable.
402 Allow for searching environment variables
408 Save all environment variables into the compiled-in persistent
411 config CMD_ENV_EXISTS
415 Check if a variable is defined in the environment for use in
418 config CMD_ENV_CALLBACK
419 bool "env callbacks - print callbacks and their associated variables"
421 Some environment variable have callbacks defined by
422 U_BOOT_ENV_CALLBACK. These are called when the variable changes.
423 For example changing "baudrate" adjust the serial baud rate. This
424 command lists the currently defined callbacks.
427 bool "env flags -print variables that have non-default flags"
429 Some environment variables have special flags that control their
430 behaviour. For example, serial# can only be written once and cannot
431 be deleted. This command shows the variables that have special
434 config CMD_NVEDIT_EFI
435 bool "env [set|print] -e - set/print UEFI variables"
436 depends on EFI_LOADER
440 UEFI variables are encoded as some form of U-Boot variables.
441 If enabled, we are allowed to set/print UEFI variables using
442 "env" command with "-e" option without knowing details.
444 config CMD_NVEDIT_INFO
445 bool "env info - print or evaluate environment information"
447 Print environment information:
448 - env_valid : is environment valid
449 - env_ready : is environment imported into hash table
450 - env_use_default : is default environment used
452 This command can be optionally used for evaluation in scripts:
453 [-d] : evaluate whether default environment is used
454 [-p] : evaluate whether environment can be persisted
455 The result of multiple evaluations will be combined with AND.
459 menu "Memory commands"
464 Compute binary operations (xor, or, and) of byte arrays of arbitrary
465 size from memory and store the result in memory or the environment.
478 Add -v option to verify data against a crc32 checksum.
481 bool "eeprom - EEPROM subsystem"
483 (deprecated, needs conversion to driver model)
484 Provides commands to read and write EEPROM (Electrically Erasable
485 Programmable Read Only Memory) chips that are connected over an
488 config CMD_EEPROM_LAYOUT
489 bool "Enable layout-aware eeprom commands"
490 depends on CMD_EEPROM
492 (deprecated, needs conversion to driver model)
493 When enabled, additional eeprom sub-commands become available.
495 eeprom print - prints the contents of the eeprom in a human-readable
496 way (eeprom layout fields, and data formatted to be fit for human
499 eeprom update - allows user to update eeprom fields by specifying
500 the field name, and providing the new data in a human readable format
501 (same format as displayed by the eeprom print command).
503 Both commands can either auto detect the layout, or be told which
507 __weak int parse_layout_version(char *str)
508 - override to provide your own layout name parsing
509 __weak void __eeprom_layout_assign(struct eeprom_layout *layout,
511 - override to setup the layout metadata based on the version
512 __weak int eeprom_layout_detect(unsigned char *data)
513 - override to provide your own algorithm for detecting layout
516 - contains various printing and updating functions for common
517 types of eeprom fields. Can be used for defining
520 config EEPROM_LAYOUT_HELP_STRING
521 string "Tells user what layout names are supported"
522 depends on CMD_EEPROM_LAYOUT
523 default "<not defined>"
525 Help printed with the LAYOUT VERSIONS part of the 'eeprom'
531 Infinite write loop on address range
538 Compute MD5 checksum.
543 depends on CMD_MD5SUM
545 Add -v option to verify data against an MD5 checksum.
550 Display memory information.
553 bool "md, mm, nm, mw, cp, cmp, base, loop"
558 mm - memory modify (auto-incrementing address)
559 nm - memory modify (constant address)
560 mw - memory write (fill)
563 base - print or set address offset
564 loop - initialize loop on address range
569 Simple RAM read/write test.
573 config SYS_ALT_MEMTEST
574 bool "Alternative test"
576 Use a more complete alternative memory test.
583 mdc - memory display cyclic
584 mwc - memory write cyclic
590 Compute SHA1 checksum.
592 config SHA1SUM_VERIFY
594 depends on CMD_SHA1SUM
596 Add -v option to verify data against a SHA1 checksum.
599 bool "strings - display strings in memory"
601 This works similarly to the Unix 'strings' command except that it
602 works with a memory range. String of printable characters found
603 within the range are displayed. The minimum number of characters
604 for a sequence to be considered a string can be provided.
608 menu "Compression commands"
612 default y if CMD_BOOTI
615 Support decompressing an LZMA (Lempel-Ziv-Markov chain algorithm)
620 default y if CMD_BOOTI
622 Uncompress a zip-compressed memory region.
627 Compress a memory region with zlib deflate method.
631 menu "Device access commands"
634 #depends on FLASH_CFI_DRIVER
637 ARM Ltd reference designs flash partition access
640 bool "adc - Access Analog to Digital Converters info and data"
644 Shows ADC device info and permit printing one-shot analog converted
645 data from a named Analog to Digital Converter.
650 depends on PARTITIONS
652 Read/modify/write the fields of Bootloader Control Block, usually
653 stored on the flash "misc" partition with its structure defined in:
654 https://android.googlesource.com/platform/bootable/recovery/+/master/
655 bootloader_message/include/bootloader_message/bootloader_message.h
657 Some real-life use-cases include (but are not limited to):
658 - Determine the "boot reason" (and act accordingly):
659 https://source.android.com/devices/bootloader/boot-reason
660 - Get/pass a list of commands from/to recovery:
661 https://android.googlesource.com/platform/bootable/recovery
662 - Inspect/dump the contents of the BCB fields
665 bool "bind/unbind - Bind or unbind a device to/from a driver"
668 Bind or unbind a device to/from a driver from the command line.
669 This is useful in situations where a device may be handled by several
670 drivers. For example, this can be used to bind a UDC to the usb ether
671 gadget driver from the command line.
674 bool "clk - Show clock frequencies"
677 Shows clock frequences by calling a sock_clk_dump() hook function.
678 This is depreated in favour of using the CLK uclass and accessing
679 clock values from associated drivers. However currently no command
683 bool "demo - Demonstration commands for driver model"
686 Provides a 'demo' command which can be used to play around with
687 driver model. To use this properly you will need to enable one or
688 both of the demo devices (DM_DEMO_SHAPE and DM_DEMO_SIMPLE).
689 Otherwise you will always get an empty list of devices. The demo
690 devices are defined in the sandbox device tree, so the easiest
691 option is to use sandbox and pass the -d point to sandbox's
698 Enables the command "dfu" which is used to have U-Boot create a DFU
699 class device via USB. This command requires that the "dfu_alt_info"
700 environment variable be set and define the alt settings to expose to
704 bool "dm - Access to driver model information"
707 Provides access to driver model data structures and information,
708 such as a list of devices, list of uclasses and the state of each
709 device (e.g. activated). This is not required for operation, but
710 can be useful to see the state of driver model for debugging or
714 bool "fastboot - Android fastboot support"
717 This enables the command "fastboot" which enables the Android
718 fastboot mode for the platform. Fastboot is a protocol for
719 downloading images, flashing and device control used on
720 Android devices. Fastboot requires either the network stack
721 enabled or support for acting as a USB device.
723 See doc/README.android-fastboot for more information.
726 bool "fdcboot - Boot from floppy device"
728 The 'fdtboot' command allows booting an image from a floppy disk.
731 bool "flinfo, erase, protect"
735 flinfo - print FLASH memory information
737 protect - enable or disable FLASH write protection
746 config CMD_FPGA_LOADBP
747 bool "fpga loadbp - load partial bitstream (Xilinx only)"
750 Supports loading an FPGA device from a bitstream buffer containing
753 config CMD_FPGA_LOADFS
754 bool "fpga loadfs - load bitstream from FAT filesystem (Xilinx only)"
757 Supports loading an FPGA device from a FAT filesystem.
759 config CMD_FPGA_LOADMK
760 bool "fpga loadmk - load bitstream from image"
763 Supports loading an FPGA device from a image generated by mkimage.
765 config CMD_FPGA_LOADP
766 bool "fpga loadp - load partial bitstream"
769 Supports loading an FPGA device from a bitstream buffer containing
772 config CMD_FPGA_LOAD_SECURE
773 bool "fpga loads - loads secure bitstreams (Xilinx only)"
776 Enables the fpga loads command which is used to load secure
777 (authenticated or encrypted or both) bitstreams on to FPGA.
780 bool "fpgad - dump FPGA registers"
782 (legacy, needs conversion to driver model)
783 Provides a way to dump FPGA registers by calling the board-specific
784 fpga_get_reg() function. This functions similarly to the 'md'
788 bool "fuse - support for the fuse subssystem"
790 (deprecated - needs conversion to driver model)
791 This allows reading, sensing, programming or overriding fuses
792 which control the behaviour of the device. The command uses the
801 bool "GPT (GUID Partition Table) command"
803 select HAVE_BLOCK_DEVICE
804 select PARTITION_UUIDS
807 Enable the 'gpt' command to ready and write GPT style partition
811 bool "GPT Random UUID generation"
814 Enable the generation of partitions with random UUIDs if none
817 config CMD_GPT_RENAME
818 bool "GPT partition renaming commands"
821 Enables the 'gpt' command to interchange names on two GPT
822 partitions via the 'gpt swap' command or to rename single
823 partitions via the 'rename' command.
826 bool "ide - Support for IDE drivers"
829 Provides an 'ide' command which allows accessing the IDE drive,
830 reseting the IDE interface, printing the partition table and
831 geting device info. It also enables the 'diskboot' command which
832 permits booting from an IDE drive.
835 bool "io - Support for performing I/O accesses"
837 Provides an 'iod' command to display I/O space and an 'iow' command
838 to write values to the I/O space. This can be useful for manually
839 checking the state of devices during boot when debugging device
843 bool "iotrace - Support for tracing I/O activity"
845 Provides an 'iotrace' command which supports recording I/O reads and
846 writes in a trace buffer in memory . It also maintains a checksum
847 of the trace records (even if space is exhausted) so that the
848 sequence of I/O accesses can be verified.
850 When debugging drivers it is useful to see what I/O accesses were
851 done and in what order.
853 Even if the individual accesses are of little interest it can be
854 useful to verify that the access pattern is consistent each time
855 an operation is performed. In this case a checksum can be used to
856 characterise the operation of a driver. The checksum can be compared
857 across different runs of the operation to verify that the driver is
860 In particular, when performing major refactoring of the driver, where
861 the access pattern should not change, the checksum provides assurance
862 that the refactoring work has not broken the driver.
864 This works by sneaking into the io.h heder for an architecture and
865 redirecting I/O accesses through iotrace's tracing mechanism.
867 For now no commands are provided to examine the trace buffer. The
868 format is fairly simple, so 'md' is a reasonable substitute.
870 Note: The checksum feature is only useful for I/O regions where the
871 contents do not change outside of software control. Where this is not
872 suitable you can fall back to manually comparing the addresses. It
873 might be useful to enhance tracing to only checksum the accesses and
874 not the data read/written.
884 bool "w1 - Support for Dallas 1-Wire protocol"
886 Dallas 1-wire protocol support
892 Load a binary file over serial line.
898 Load an S-Record file over serial line
903 MMC memory mapped support.
906 bool "Enable support for RPMB in the mmc command"
909 Enable the commands for reading, writing and programming the
910 key for the Replay Protection Memory Block partition in eMMC.
912 config CMD_MMC_SWRITE
914 depends on CMD_MMC && MMC_WRITE
917 Enable support for the "mmc swrite" command to write Android sparse
922 select MTD_PARTITIONS
924 MTD commands support.
928 default y if NAND_SUNXI
933 config CMD_NAND_TRIMFFS
934 bool "nand write.trimffs"
935 default y if ARCH_SUNXI
937 Allows one to skip empty pages when flashing something on a NAND.
939 config CMD_NAND_LOCK_UNLOCK
940 bool "nand lock/unlock"
942 NAND locking support.
944 config CMD_NAND_TORTURE
947 NAND torture support.
956 NVM Express device support
959 bool "mmc_spi - Set up MMC SPI device"
961 Provides a way to set up an MMC (Multimedia Card) SPI (Serial
962 Peripheral Interface) device. The device provides a means of
963 accessing an MMC device via SPI using a single data line, limited
964 to 20MHz. It is useful since it reduces the amount of protocol code
968 bool "onenand - access to onenand device"
970 OneNAND is a brand of NAND ('Not AND' gate) flash which provides
971 various useful features. This command allows reading, writing,
972 and erasing blocks. It allso provides a way to show and change
973 bad blocks, and test the device.
978 Enable the 'osd' command which allows to query information from and
979 write text data to a on-screen display (OSD) device; a virtual device
980 associated with a display capable of displaying a text overlay on the
981 display it's associated with..
985 select HAVE_BLOCK_DEVICE
986 select PARTITION_UUIDS
988 Read and display information about the partition table on
992 bool "pci - Access PCI devices"
994 Provide access to PCI (Peripheral Interconnect Bus), a type of bus
995 used on some devices to allow the CPU to communicate with its
996 peripherals. Sub-commands allow bus enumeration, displaying and
997 changing configuration space and a few other features.
1000 bool "pinit - Set up PCMCIA device"
1002 Provides a means to initialise a PCMCIA (Personal Computer Memory
1003 Card International Association) device. This is an old standard from
1004 about 1990. These devices are typically removable memory or network
1005 cards using a standard 68-pin connector.
1008 bool "pinmux - show pins muxing"
1009 default y if PINCTRL
1011 Parse all available pin-controllers and show pins muxing. This
1012 is useful for debug purpoer to check the pin muxing and to know if
1013 a pin is configured as a GPIO or as an alternate function.
1018 Poweroff/Shutdown the system
1021 bool "read - Read binary data from a partition"
1023 Provides low-level access to the data in a partition.
1025 config CMD_REMOTEPROC
1027 depends on REMOTEPROC
1029 Support for Remote Processor control
1032 bool "sata - Access SATA subsystem"
1035 SATA (Serial Advanced Technology Attachment) is a serial bus
1036 standard for connecting to hard drives and other storage devices.
1037 This command provides information about attached devices and allows
1038 reading, writing and other operations.
1040 SATA replaces PATA (originally just ATA), which stands for Parallel AT
1041 Attachment, where AT refers to an IBM AT (Advanced Technology)
1042 computer released in 1984.
1045 bool "saves - Save a file over serial in S-Record format"
1047 Provides a way to save a binary file using the Motorola S-Record
1048 format over the serial line.
1051 bool "scsi - Access to SCSI devices"
1054 This provides a 'scsi' command which provides access to SCSI (Small
1055 Computer System Interface) devices. The command provides a way to
1056 scan the bus, reset the bus, read and write data and get information
1060 bool "sdram - Print SDRAM configuration information"
1062 Provides information about attached SDRAM. This assumed that the
1063 SDRAM has an EEPROM with information that can be read using the
1064 I2C bus. This is only available on some boards.
1068 depends on DM_SPI_FLASH || SPI_FLASH
1073 bool "sf test - Allow testing of SPI flash"
1076 Provides a way to test that SPI flash is working correctly. The
1077 test is destructive, in that an area of SPI flash must be provided
1078 for the test to use. Performance information is also provided,
1079 measuring the performance of reading, writing and erasing in
1080 Mbps (Million Bits Per Second). This value should approximately
1081 equal the SPI bus speed for a single-bit-wide SPI bus, assuming
1082 everything is working properly.
1085 bool "sspi - Command to access spi device"
1088 SPI utility command.
1090 config DEFAULT_SPI_BUS
1091 int "default spi bus used by sspi command"
1095 config DEFAULT_SPI_MODE
1096 hex "default spi mode used by sspi command (see include/spi.h)"
1101 bool "tsi148 - Command to access tsi148 device"
1103 This provides various sub-commands to initialise and configure the
1104 Turndra tsi148 device. See the command help for full details.
1107 bool "universe - Command to set up the Turndra Universe controller"
1109 This allows setting up the VMEbus provided by this controller.
1110 See the command help for full details.
1114 select HAVE_BLOCK_DEVICE
1120 select USB_FUNCTION_SDP
1122 Enables the command "sdp" which is used to have U-Boot emulating the
1123 Serial Download Protocol (SDP) via USB.
1127 depends on USB_FUNCTION_ROCKUSB
1129 Rockusb protocol is widely used by Rockchip SoC based devices. It can
1130 read/write info, image to/from devices. This enable rockusb command
1131 support to communication with rockusb device. for more detail about
1132 this command, please read doc/README.rockusb.
1134 config CMD_USB_MASS_STORAGE
1135 bool "UMS usb mass storage"
1136 select USB_FUNCTION_MASS_STORAGE
1138 USB mass storage support
1145 VirtIO block device support
1151 This provides commands to control the watchdog timer devices.
1157 Enable the command "axi" for accessing AXI (Advanced eXtensible
1158 Interface) busses, a on-chip interconnect specification for managing
1159 functional blocks in SoC designs, which is also often used in designs
1160 involving FPGAs (e.g. communication with IP cores in Xilinx FPGAs).
1164 menu "Shell scripting commands"
1170 Echo args to console
1176 Return true/false on integer compare.
1182 Run script from memory
1188 Evaluate boolean and math expressions and store the result in an env
1190 Also supports loading the value at a memory location into a variable.
1191 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
1198 bool "Network commands"
1208 bootp - boot image via network using BOOTP/TFTP protocol
1212 depends on CMD_BOOTP
1214 Boot image via network using DHCP/TFTP protocol
1216 config BOOTP_BOOTPATH
1217 bool "Request & store 'rootpath' from BOOTP/DHCP server"
1219 depends on CMD_BOOTP
1221 Even though the config is called BOOTP_BOOTPATH, it stores the
1222 path in the variable 'rootpath'.
1225 bool "Request & store 'dnsip' from BOOTP/DHCP server"
1227 depends on CMD_BOOTP
1229 The primary DNS server is stored as 'dnsip'. If two servers are
1230 returned, you must set BOOTP_DNS2 to store that second server IP
1234 bool "Store 'dnsip2' from BOOTP/DHCP server"
1235 depends on BOOTP_DNS
1237 If a DHCP client requests the DNS server IP from a DHCP server,
1238 it is possible that more than one DNS serverip is offered to the
1239 client. If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1240 server IP will be stored in the additional environment
1241 variable "dnsip2". The first DNS serverip is always
1242 stored in the variable "dnsip", when BOOTP_DNS is defined.
1244 config BOOTP_GATEWAY
1245 bool "Request & store 'gatewayip' from BOOTP/DHCP server"
1247 depends on CMD_BOOTP
1249 config BOOTP_HOSTNAME
1250 bool "Request & store 'hostname' from BOOTP/DHCP server"
1252 depends on CMD_BOOTP
1254 The name may or may not be qualified with the local domain name.
1256 config BOOTP_PREFER_SERVERIP
1257 bool "serverip variable takes precedent over DHCP server IP."
1258 depends on CMD_BOOTP
1260 By default a BOOTP/DHCP reply will overwrite the 'serverip' variable.
1262 With this option enabled, the 'serverip' variable in the environment
1263 takes precedence over DHCP server IP and will only be set by the DHCP
1264 server if not already set in the environment.
1266 config BOOTP_SUBNETMASK
1267 bool "Request & store 'netmask' from BOOTP/DHCP server"
1269 depends on CMD_BOOTP
1271 config BOOTP_NTPSERVER
1272 bool "Request & store 'ntpserverip' from BOOTP/DHCP server"
1273 depends on CMD_BOOTP
1276 bool "Send PXE client arch to BOOTP/DHCP server"
1278 depends on CMD_BOOTP && CMD_PXE
1280 Supported for ARM, ARM64, and x86 for now.
1282 config BOOTP_PXE_CLIENTARCH
1284 depends on BOOTP_PXE
1285 default 0x16 if ARM64
1289 config BOOTP_VCI_STRING
1291 depends on CMD_BOOTP
1292 default "U-Boot.armv7" if CPU_V7A || CPU_V7M || CPU_V7R
1293 default "U-Boot.armv8" if ARM64
1294 default "U-Boot.arm" if ARM
1301 tftpboot - boot image via network using TFTP protocol
1305 depends on CMD_TFTPBOOT
1307 TFTP put command, for uploading files to a server
1311 depends on CMD_TFTPBOOT
1313 Act as a TFTP server and boot the first received file
1315 config NET_TFTP_VARS
1316 bool "Control TFTP timeout and count through environment"
1317 depends on CMD_TFTPBOOT
1320 If set, allows controlling the TFTP timeout through the
1321 environment variable tftptimeout, and the TFTP maximum
1322 timeout count through the variable tftptimeoutcountmax.
1323 If unset, timeout and maximum are hard-defined as 1 second
1324 and 10 timouts per TFTP transfer.
1329 Boot image via network using RARP/TFTP protocol
1335 Boot image via network using NFS protocol.
1340 Enable MII utility commands.
1345 Send ICMP ECHO_REQUEST to network host
1350 Perform CDP network configuration
1355 Synchronize RTC via network
1360 Lookup the IP of a hostname
1362 config CMD_LINK_LOCAL
1366 Acquire a network IP address using the link-local protocol
1373 Allow control of L2 Ethernet switch commands. These are supported
1374 by the vsc9953 Ethernet driver at present. Sub-commands allow
1375 operations such as enabling / disabling a port and
1376 viewing/maintaining the filtering database (FDB)
1382 Boot image via network using PXE protocol
1387 Wait for wake-on-lan Magic Packet
1391 menu "Misc commands"
1394 bool "Enable 'bmp' command"
1395 depends on LCD || DM_VIDEO || VIDEO
1397 This provides a way to obtain information about a BMP-format iamge
1398 and to display it. BMP (which presumably stands for BitMaP) is a
1399 file format defined by Microsoft which supports images of various
1400 depths, formats and compression methods. Headers on the file
1401 determine the formats used. This command can be used by first loading
1402 the image into RAM, then using this command to look at it or display
1405 config CMD_BOOTCOUNT
1407 depends on BOOTCOUNT_LIMIT
1409 Enable the bootcount command, which allows interrogation and
1410 reset of the bootcounter.
1413 bool "Enable board-specific commands"
1415 (deprecated: instead, please define a Kconfig option for each command)
1417 Some boards have board-specific commands which are only enabled
1418 during developemnt and need to be turned off for production. This
1419 option provides a way to control this. The commands that are enabled
1420 vary depending on the board.
1422 config CMD_BKOPS_ENABLE
1423 bool "mmc bkops enable"
1427 Enable command for setting manual background operations handshake
1428 on a eMMC device. The feature is optionally available on eMMC devices
1429 conforming to standard >= 4.41.
1431 config CMD_BLOCK_CACHE
1432 bool "blkcache - control and stats for block cache"
1433 depends on BLOCK_CACHE
1434 default y if BLOCK_CACHE
1436 Enable the blkcache command, which can be used to control the
1437 operation of the cache functions.
1438 This is most useful when fine-tuning the operation of the cache
1439 during development, but also allows the cache to be disabled when
1440 it might hurt performance (e.g. when using the ums command).
1443 bool "icache or dcache"
1445 Enable the "icache" and "dcache" commands
1447 config CMD_CONITRACE
1448 bool "conitrace - trace console input codes"
1450 Enable the 'conitrace' command which displays the codes received
1451 from the console input as hexadecimal numbers.
1454 bool "Enable clear screen command 'cls'"
1455 depends on CFB_CONSOLE || DM_VIDEO || LCD || VIDEO
1458 Enable the 'cls' command which clears the screen contents
1459 on video frame buffer.
1462 bool "efidebug - display/configure UEFI environment"
1463 depends on EFI_LOADER
1464 select EFI_DEVICE_PATH_TO_TEXT
1467 Enable the 'efidebug' command which provides a subset of UEFI
1468 shell utility with simplified functionality. It will be useful
1469 particularly for managing boot parameters as well as examining
1470 various EFI status for debugging.
1472 config CMD_EXCEPTION
1473 bool "exception - raise exception"
1474 depends on ARM || RISCV || X86
1476 Enable the 'exception' command which allows to raise an exception.
1483 Enable the 'led' command which allows for control of LEDs supported
1484 by the board. The LEDs can be listed with 'led list' and controlled
1485 with led on/off/togle/blink. Any LED drivers can be controlled with
1486 this command, e.g. led_gpio.
1492 Enable the 'date' command for getting/setting the time/date in RTC
1498 Run commands and summarize execution time.
1501 bool "gettime - read elapsed time"
1503 Enable the 'gettime' command which reads the elapsed time since
1504 U-Boot started running. This shows the time in seconds and
1505 milliseconds. See also the 'bootstage' command which provides more
1506 flexibility for boot timing.
1508 # TODO: rename to CMD_SLEEP
1513 Delay execution for some time
1516 bool "support for multiprocessor"
1518 This provides an option to brinup
1519 different processors in multiprocessor
1525 Access the system timer.
1531 This provides basic access to the U-Boot's sound support. The main
1532 feature is to play a beep.
1534 sound init - set up sound system
1535 sound play - play a sound
1541 This provides access to the QEMU firmware interface. The main
1542 feature is to allow easy loading of files passed to qemu-system
1543 via -kernel / -initrd
1545 source "cmd/mvebu/Kconfig"
1548 bool "terminal - provides a way to attach a serial terminal"
1550 Provides a 'cu'-like serial terminal command. This can be used to
1551 access other serial ports from the system console. The terminal
1552 is very simple with no special processing of characters. As with
1553 cu, you can press ~. (tilde followed by period) to exit.
1556 bool "uuid, guid - generation of unique IDs"
1559 This enables two commands:
1561 uuid - generate random Universally Unique Identifier
1562 guid - generate Globally Unique Identifier based on random UUID
1564 The two commands are very similar except for the endianness of the
1569 source "cmd/ti/Kconfig"
1571 config CMD_BOOTSTAGE
1572 bool "Enable the 'bootstage' command"
1573 depends on BOOTSTAGE
1575 Add a 'bootstage' command which supports printing a report
1576 and un/stashing of bootstage data.
1578 menu "Power commands"
1580 bool "Enable Driver Model PMIC command"
1583 This is the pmic command, based on a driver model pmic's API.
1584 Command features are unchanged:
1585 - list - list pmic devices
1586 - pmic dev <id> - show or [set] operating pmic device (NEW)
1587 - pmic dump - dump registers
1588 - pmic read address - read byte of register at address
1589 - pmic write address - write byte to register at address
1590 The only one change for this command is 'dev' subcommand.
1592 config CMD_REGULATOR
1593 bool "Enable Driver Model REGULATOR command"
1594 depends on DM_REGULATOR
1596 This command is based on driver model regulator's API.
1597 User interface features:
1598 - list - list regulator devices
1599 - regulator dev <id> - show or [set] operating regulator device
1600 - regulator info - print constraints info
1601 - regulator status - print operating status
1602 - regulator value <val] <-f> - print/[set] voltage value [uV]
1603 - regulator current <val> - print/[set] current value [uA]
1604 - regulator mode <id> - print/[set] operating mode id
1605 - regulator enable - enable the regulator output
1606 - regulator disable - disable the regulator output
1608 The '-f' (force) option can be used for set the value which exceeds
1609 the limits, which are found in device-tree and are kept in regulator's
1610 uclass platdata structure.
1614 menu "Security commands"
1616 bool "Enable the 'aes' command"
1619 This provides a means to encrypt and decrypt data using the AES
1620 (Advanced Encryption Standard). This algorithm uses a symetric key
1621 and is widely used as a streaming cipher. Different key lengths are
1622 supported by the algorithm but this command only supports 128 bits
1626 bool "Enable the 'blob' command"
1628 This is used with the Freescale secure boot mechanism.
1630 Freescale's SEC block has built-in Blob Protocol which provides
1631 a method for protecting user-defined data across system power
1632 cycles. SEC block protects data in a data structure called a Blob,
1633 which provides both confidentiality and integrity protection.
1635 Encapsulating data as a blob
1636 Each time that the Blob Protocol is used to protect data, a
1637 different randomly generated key is used to encrypt the data.
1638 This random key is itself encrypted using a key which is derived
1639 from SoC's non-volatile secret key and a 16 bit Key identifier.
1640 The resulting encrypted key along with encrypted data is called a
1641 blob. The non-volatile secure key is available for use only during
1644 During decapsulation, the reverse process is performed to get back
1648 blob enc - encapsulating data as a cryptgraphic blob
1649 blob dec - decapsulating cryptgraphic blob to get the data
1653 blob enc src dst len km
1655 Encapsulate and create blob of data $len bytes long
1656 at address $src and store the result at address $dst.
1657 $km is the 16 byte key modifier is also required for
1658 generation/use as key for cryptographic operation. Key
1659 modifier should be 16 byte long.
1661 blob dec src dst len km
1663 Decapsulate the blob of data at address $src and
1664 store result of $len byte at addr $dst.
1665 $km is the 16 byte key modifier is also required for
1666 generation/use as key for cryptographic operation. Key
1667 modifier should be 16 byte long.
1670 bool "Support 'hash' command"
1673 This provides a way to hash data in memory using various supported
1674 algorithms (such as SHA1, MD5, CRC32). The computed digest can be
1675 saved to memory or to an environment variable. It is also possible
1676 to verify a hash against data in memory.
1679 bool "Support the 'hvc' command"
1680 depends on ARM_SMCCC
1682 Allows issuing Hypervisor Calls (HVCs). Mostly useful for
1683 development and testing.
1686 bool "Support the 'smc' command"
1687 depends on ARM_SMCCC
1689 Allows issuing Secure Monitor Calls (SMCs). Mostly useful for
1690 development and testing.
1696 Add -v option to verify data against a hash.
1706 bool "Enable the 'tpm' command"
1707 depends on TPM_V1 || TPM_V2
1708 select CMD_TPM_V1 if TPM_V1
1709 select CMD_TPM_V2 if TPM_V2
1711 This provides a means to talk to a TPM from the command line. A wide
1712 range of commands if provided - see 'tpm help' for details. The
1713 command requires a suitable TPM on your board and the correct driver
1719 bool "Enable the 'tpm test' command"
1722 This provides a a series of tests to confirm that the TPMv1.x is
1723 working correctly. The tests cover initialisation, non-volatile RAM,
1724 extend, global lock and checking that timing is within expectations.
1725 The tests pass correctly on Infineon TPMs but may need to be adjusted
1732 menu "Firmware commands"
1734 bool "Enable crosec command"
1738 Enable command-line access to the Chrome OS EC (Embedded
1739 Controller). This provides the 'crosec' command which has
1740 a number of sub-commands for performing EC tasks such as
1741 updating its flash, accessing a small saved context area
1742 and talking to the I2C bus behind the EC (if there is one).
1745 menu "Filesystem commands"
1747 bool "Enable the 'btrsubvol' command"
1750 This enables the 'btrsubvol' command to list subvolumes
1751 of a BTRFS filesystem. There are no special commands for
1752 listing BTRFS directories or loading BTRFS files - this
1753 can be done by the generic 'fs' commands (see CMD_FS_GENERIC)
1754 when BTRFS is enabled (see FS_BTRFS).
1757 bool "Enable the 'cbfs' command"
1760 Define this to enable support for reading from a Coreboot
1761 filesystem. This is a ROM-based filesystem used for accessing files
1762 on systems that use coreboot as the first boot-loader and then load
1763 U-Boot to actually boot the Operating System. Available commands are
1764 cbfsinit, cbfsinfo, cbfsls and cbfsload.
1767 bool "Enable the 'cramfs' command"
1768 depends on FS_CRAMFS
1770 This provides commands for dealing with CRAMFS (Compressed ROM
1771 filesystem). CRAMFS is useful when space is tight since files are
1772 compressed. Two commands are provided:
1774 cramfsls - lists files in a cramfs image
1775 cramfsload - loads a file from a cramfs image
1778 bool "ext2 command support"
1781 Enables EXT2 FS command
1784 bool "ext4 command support"
1787 Enables EXT4 FS command
1789 config CMD_EXT4_WRITE
1791 bool "ext4 write command support"
1794 Enables EXT4 FS write command
1797 bool "FAT command support"
1800 Support for the FAT fs
1802 config CMD_FS_GENERIC
1803 bool "filesystem commands"
1805 Enables filesystem commands (e.g. load, ls) that work for multiple
1809 bool "fsuuid command"
1811 Enables fsuuid command for filesystem UUID.
1814 bool "jffs2 command"
1817 Enables commands to support the JFFS2 (Journalling Flash File System
1818 version 2) filesystem. This enables fsload, ls and fsinfo which
1819 provide the ability to load files, list directories and obtain
1820 filesystem information.
1823 bool "MTD partition support"
1824 select MTD_DEVICE if (CMD_NAND || NAND)
1826 MTD partitioning tool support.
1827 It is strongly encouraged to avoid using this command
1828 anymore along with 'sf', 'nand', 'onenand'. One can still
1829 declare the partitions in the mtdparts environment variable
1830 but better use the MTD stack and the 'mtd' command instead.
1832 config MTDIDS_DEFAULT
1833 string "Default MTD IDs"
1834 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1836 Defines a default MTD IDs list for use with MTD partitions in the
1837 Linux MTD command line partitions format.
1839 config MTDPARTS_DEFAULT
1840 string "Default MTD partition scheme"
1841 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1843 Defines a default MTD partitioning scheme in the Linux MTD command
1844 line partitions format
1846 config CMD_MTDPARTS_SPREAD
1847 bool "Padd partition size to take account of bad blocks"
1848 depends on CMD_MTDPARTS
1850 This enables the 'spread' sub-command of the mtdparts command.
1851 This command will modify the existing mtdparts variable by increasing
1852 the size of the partitions such that 1) each partition's net size is
1853 at least as large as the size specified in the mtdparts variable and
1854 2) each partition starts on a good block.
1857 bool "reiser - Access to reiserfs filesystems"
1859 This provides two commands which operate on a resierfs filesystem,
1860 commonly used some years ago:
1862 reiserls - list files
1863 reiserload - load a file
1866 bool "yaffs2 - Access of YAFFS2 filesystem"
1870 This provides commands for accessing a YAFFS2 filesystem. Yet
1871 Another Flash Filesystem 2 is a filesystem designed specifically
1872 for NAND flash. It incorporates bad-block management and ensures
1873 that device writes are sequential regardless of filesystem
1877 bool "zfs - Access of ZFS filesystem"
1879 This provides commands to accessing a ZFS filesystem, commonly used
1880 on Solaris systems. Two sub-commands are provided:
1882 zfsls - list files in a directory
1883 zfsload - load a file
1885 See doc/README.zfs for more details.
1889 menu "Debug commands"
1894 The bedbug (emBEDded deBUGger) command provides debugging features
1895 for some PowerPC processors. For details please see the
1896 docuemntation in doc/README.beddbug
1899 bool "diag - Board diagnostics"
1901 This command provides access to board diagnostic tests. These are
1902 called Power-on Self Tests (POST). The command allows listing of
1903 available tests and running either all the tests, or specific tests
1907 bool "irq - Show information about interrupts"
1908 depends on !ARM && !MIPS && !SH
1910 This enables two commands:
1912 interrupts - enable or disable interrupts
1913 irqinfo - print device-specific interrupt information
1916 bool "kgdb - Allow debugging of U-Boot with gdb"
1919 This enables a 'kgdb' command which allows gdb to connect to U-Boot
1920 over a serial link for debugging purposes. This allows
1921 single-stepping, inspecting variables, etc. This is supported only
1922 on PowerPC at present.
1925 bool "log - Generation, control and access to logging"
1928 This provides access to logging features. It allows the output of
1929 log data to be controlled to a limited extent (setting up the default
1930 maximum log level for emitting of records). It also provides access
1931 to a command used for testing the log system.
1934 bool "trace - Support tracing of function calls and timing"
1936 Enables a command to control using of function tracing within
1937 U-Boot. This allows recording of call traces including timing
1938 information. The command can write data to memory for exporting
1939 for analysis (e.g. using bootchart). See doc/README.trace for full
1943 bool "avb - Android Verified Boot 2.0 operations"
1944 depends on AVB_VERIFY
1947 Enables a "avb" command to perform verification of partitions using
1948 Android Verified Boot 2.0 functionality. It includes such subcommands:
1949 avb init - initialize avb2 subsystem
1950 avb read_rb - read rollback index
1951 avb write_rb - write rollback index
1952 avb is_unlocked - check device lock state
1953 avb get_uuid - read and print uuid of a partition
1954 avb read_part - read data from partition
1955 avb read_part_hex - read data from partition and output to stdout
1956 avb write_part - write data to partition
1957 avb verify - run full verification chain
1961 tristate "Enable UBI - Unsorted block images commands"
1964 UBI is a software layer above MTD layer which admits use of LVM-like
1965 logical volumes on top of MTD devices, hides some complexities of
1966 flash chips like wear and bad blocks and provides some other useful
1967 capabilities. Please, consult the MTD web site for more details
1968 (www.linux-mtd.infradead.org). Activate this option if you want
1969 to use U-Boot UBI commands.
1970 It is also strongly encouraged to also enable CONFIG_MTD to get full
1974 tristate "Enable UBIFS - Unsorted block images filesystem commands"
1976 default y if CMD_UBI
1979 UBIFS is a file system for flash devices which works on top of UBI.
projects / oweals / u-boot.git / blob